xref: /dragonfly/lib/libc/include/libc_private.h (revision 3c7e5806)
1 /*
2  * Copyright (c) 1998 John Birrell <jb@cimlogic.com.au>.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the author nor the names of any co-contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  * $FreeBSD: head/lib/libc/include/libc_private.h 213153 2010-09-25 01:57:47Z davidxu $
30  *
31  * Private definitions for libc, libc_r and libpthread.
32  *
33  */
34 
35 #ifndef _LIBC_PRIVATE_H_
36 #define _LIBC_PRIVATE_H_
37 
38 #include <sys/_pthreadtypes.h>
39 
40 /*
41  * This global flag is non-zero when a process has created one
42  * or more threads. It is used to avoid calling locking functions
43  * when they are not required.
44  */
45 #ifndef __LIBC_ISTHREADED_DECLARED
46 #define __LIBC_ISTHREADED_DECLARED
47 extern int	__isthreaded;
48 #endif
49 
50 /*
51  * File lock contention is difficult to diagnose without knowing
52  * where locks were set. Allow a debug library to be built which
53  * records the source file and line number of each lock call.
54  */
55 #ifdef	_FLOCK_DEBUG
56 #define _FLOCKFILE(x)	_flockfile_debug(x, __FILE__, __LINE__)
57 #else
58 #define _FLOCKFILE(x)	_flockfile(x)
59 #endif
60 
61 /*
62  * Macros for locking and unlocking FILEs. These test if the
63  * process is threaded to avoid locking when not required.
64  */
65 #define	FLOCKFILE(fp)		if (__isthreaded) _FLOCKFILE(fp)
66 #define	FUNLOCKFILE(fp)		if (__isthreaded) _funlockfile(fp)
67 
68 /*
69  * Initialise TLS static programs
70  */
71 int __get_errno_GS_offset(void);
72 void *__get_errno_GOT_ptr(void);
73 
74 struct statfs;
75 struct statvfs;
76 
77 /*
78  * yplib internal interfaces
79  */
80 #ifdef YP
81 int _yp_check(char **);
82 #endif
83 
84 /*
85  * This is a pointer in the C run-time startup code. It is used
86  * by getprogname() and setprogname().
87  */
88 extern const char *__progname;
89 
90 /*
91  * Notify libc that thread is exiting and its TLS destructors can be called.
92  */
93 void _thread_finalize(void);
94 
95 /*
96  * Function to clean up streams, called from abort() and exit().
97  */
98 extern void (*__cleanup)(void);
99 
100 /* execve() with PATH processing to implement posix_spawnp() */
101 int _execvpe(const char *, char * const *, char * const *);
102 void _nmalloc_thr_init(void);
103 void _nmalloc_thr_prepfork(void);
104 void _nmalloc_thr_parentfork(void);
105 void _nmalloc_thr_childfork(void);
106 
107 struct dl_phdr_info;
108 int __elf_phdr_match_addr(struct dl_phdr_info *, void *);
109 
110 /*
111  * libc should use libc_dlopen internally, which respects a global
112  * flag where loading of new shared objects can be restricted.
113  */
114 void *libc_dlopen(const char *, int);
115 
116 /*
117  * For dynamic linker
118  */
119 void _rtld_error(const char *fmt, ...);
120 
121 /*
122  * Provides pthread_once()-like functionality for both single-threaded
123  * and multi-threaded applications
124  */
125 int _once(pthread_once_t *, void (*)(void));
126 
127 #endif /* _LIBC_PRIVATE_H_ */
128