libc_private.h revision 213153 
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#include <sys/_pthreadtypes.h>
38
39/*
40 * This global flag is non-zero when a process has created one
41 * or more threads. It is used to avoid calling locking functions
42 * when they are not required.
43 */
44extern int	__isthreaded;
45
46/*
47 * File lock contention is difficult to diagnose without knowing
48 * where locks were set. Allow a debug library to be built which
49 * records the source file and line number of each lock call.
50 */
51#ifdef	_FLOCK_DEBUG
52#define _FLOCKFILE(x)	_flockfile_debug(x, __FILE__, __LINE__)
53#else
54#define _FLOCKFILE(x)	_flockfile(x)
55#endif
56
57/*
58 * Macros for locking and unlocking FILEs. These test if the
59 * process is threaded to avoid locking when not required.
60 */
61#define	FLOCKFILE(fp)		if (__isthreaded) _FLOCKFILE(fp)
62#define	FUNLOCKFILE(fp)		if (__isthreaded) _funlockfile(fp)
63
64/*
65 * Indexes into the pthread jump table.
66 *
67 * Warning! If you change this type, you must also change the threads
68 * libraries that reference it (libc_r, libpthread).
69 */
70typedef enum {
71	PJT_ATFORK,
72	PJT_ATTR_DESTROY,
73	PJT_ATTR_GETDETACHSTATE,
74	PJT_ATTR_GETGUARDSIZE,
75	PJT_ATTR_GETINHERITSCHED,
76	PJT_ATTR_GETSCHEDPARAM,
77	PJT_ATTR_GETSCHEDPOLICY,
78	PJT_ATTR_GETSCOPE,
79	PJT_ATTR_GETSTACKADDR,
80	PJT_ATTR_GETSTACKSIZE,
81	PJT_ATTR_INIT,
82	PJT_ATTR_SETDETACHSTATE,
83	PJT_ATTR_SETGUARDSIZE,
84	PJT_ATTR_SETINHERITSCHED,
85	PJT_ATTR_SETSCHEDPARAM,
86	PJT_ATTR_SETSCHEDPOLICY,
87	PJT_ATTR_SETSCOPE,
88	PJT_ATTR_SETSTACKADDR,
89	PJT_ATTR_SETSTACKSIZE,
90	PJT_CANCEL,
91	PJT_CLEANUP_POP,
92	PJT_CLEANUP_PUSH,
93	PJT_COND_BROADCAST,
94	PJT_COND_DESTROY,
95	PJT_COND_INIT,
96	PJT_COND_SIGNAL,
97	PJT_COND_TIMEDWAIT,
98	PJT_COND_WAIT,
99	PJT_DETACH,
100	PJT_EQUAL,
101	PJT_EXIT,
102	PJT_GETSPECIFIC,
103	PJT_JOIN,
104	PJT_KEY_CREATE,
105	PJT_KEY_DELETE,
106	PJT_KILL,
107	PJT_MAIN_NP,
108	PJT_MUTEXATTR_DESTROY,
109	PJT_MUTEXATTR_INIT,
110	PJT_MUTEXATTR_SETTYPE,
111	PJT_MUTEX_DESTROY,
112	PJT_MUTEX_INIT,
113	PJT_MUTEX_LOCK,
114	PJT_MUTEX_TRYLOCK,
115	PJT_MUTEX_UNLOCK,
116	PJT_ONCE,
117	PJT_RWLOCK_DESTROY,
118	PJT_RWLOCK_INIT,
119	PJT_RWLOCK_RDLOCK,
120	PJT_RWLOCK_TRYRDLOCK,
121	PJT_RWLOCK_TRYWRLOCK,
122	PJT_RWLOCK_UNLOCK,
123	PJT_RWLOCK_WRLOCK,
124	PJT_SELF,
125	PJT_SETCANCELSTATE,
126	PJT_SETCANCELTYPE,
127	PJT_SETSPECIFIC,
128	PJT_SIGMASK,
129	PJT_TESTCANCEL,
130	PJT_CLEANUP_POP_IMP,
131	PJT_CLEANUP_PUSH_IMP,
132	PJT_CANCEL_ENTER,
133	PJT_CANCEL_LEAVE,
134	PJT_MAX
135} pjt_index_t;
136
137typedef int (*pthread_func_t)(void);
138typedef pthread_func_t pthread_func_entry_t[2];
139
140extern pthread_func_entry_t __thr_jtable[];
141
142/*
143 * yplib internal interfaces
144 */
145#ifdef YP
146int _yp_check(char **);
147#endif
148
149/*
150 * Initialise TLS for static programs
151 */
152void _init_tls(void);
153
154/*
155 * Provides pthread_once()-like functionality for both single-threaded
156 * and multi-threaded applications.
157 */
158int _once(pthread_once_t *, void (*)(void));
159
160/*
161 * Set the TLS thread pointer
162 */
163void _set_tp(void *tp);
164
165/*
166 * This is a pointer in the C run-time startup code. It is used
167 * by getprogname() and setprogname().
168 */
169extern const char *__progname;
170
171/*
172 * This function is used by the threading libraries to notify malloc that a
173 * thread is exiting.
174 */
175void _malloc_thread_cleanup(void);
176
177/*
178 * These functions are used by the threading libraries in order to protect
179 * malloc across fork().
180 */
181void _malloc_prefork(void);
182void _malloc_postfork(void);
183
184/*
185 * Function to clean up streams, called from abort() and exit().
186 */
187extern void (*__cleanup)(void);
188
189/*
190 * Get kern.osreldate to detect ABI revisions.  Explicitly
191 * ignores value of $OSVERSION and caches result.  Prototypes
192 * for the wrapped "new" pad-less syscalls are here for now.
193 */
194extern int __getosreldate(void);
195#include <sys/_types.h>
196/* Without pad */
197extern __off_t	__sys_lseek(int, __off_t, int);
198extern int	__sys_ftruncate(int, __off_t);
199extern int	__sys_truncate(const char *, __off_t);
200extern __ssize_t __sys_pread(int, void *, __size_t, __off_t);
201extern __ssize_t __sys_pwrite(int, const void *, __size_t, __off_t);
202extern void *	__sys_mmap(void *, __size_t, int, int, int, __off_t);
203
204/* With pad */
205extern __off_t	__sys_freebsd6_lseek(int, int, __off_t, int);
206extern int	__sys_freebsd6_ftruncate(int, int, __off_t);
207extern int	__sys_freebsd6_truncate(const char *, int, __off_t);
208extern __ssize_t __sys_freebsd6_pread(int, void *, __size_t, int, __off_t);
209extern __ssize_t __sys_freebsd6_pwrite(int, const void *, __size_t, int, __off_t);
210extern void *	__sys_freebsd6_mmap(void *, __size_t, int, int, int, int, __off_t);
211
212/* Without back-compat translation */
213extern int	__sys_fcntl(int, int, ...);
214
215/* execve() with PATH processing to implement posix_spawnp() */
216int _execvpe(const char *, char * const *, char * const *);
217
218int _elf_aux_info(int aux, void *buf, int buflen);
219struct dl_phdr_info;
220int __elf_phdr_match_addr(struct dl_phdr_info *, void *);
221
222void	_pthread_cancel_enter(int);
223void	_pthread_cancel_leave(int);
224
225#endif /* _LIBC_PRIVATE_H_ */
226