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