libc_private.h revision 211706
1121407Speter/*
2121407Speter * Copyright (c) 1998 John Birrell <jb@cimlogic.com.au>.
3323538Skib * All rights reserved.
4121407Speter *
5121407Speter * Redistribution and use in source and binary forms, with or without
6323538Skib * modification, are permitted provided that the following conditions
7323538Skib * are met:
8323538Skib * 1. Redistributions of source code must retain the above copyright
9121407Speter *    notice, this list of conditions and the following disclaimer.
10121407Speter * 2. Redistributions in binary form must reproduce the above copyright
11121407Speter *    notice, this list of conditions and the following disclaimer in the
12121407Speter *    documentation and/or other materials provided with the distribution.
13121407Speter * 3. Neither the name of the author nor the names of any co-contributors
14121407Speter *    may be used to endorse or promote products derived from this software
15121407Speter *    without specific prior written permission.
16121407Speter *
17121407Speter * THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
18121407Speter * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19121407Speter * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20121407Speter * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21121407Speter * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22121407Speter * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23121407Speter * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24121407Speter * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25121407Speter * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26121407Speter * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27121407Speter * SUCH DAMAGE.
28121407Speter *
29121407Speter * $FreeBSD: head/lib/libc/include/libc_private.h 211706 2010-08-23 15:38:02Z kib $
30121407Speter *
31121407Speter * Private definitions for libc, libc_r and libpthread.
32121407Speter *
33121407Speter */
34323538Skib
35323538Skib#ifndef _LIBC_PRIVATE_H_
36121407Speter#define _LIBC_PRIVATE_H_
37323538Skib#include <sys/_pthreadtypes.h>
38121407Speter
39121407Speter/*
40121407Speter * This global flag is non-zero when a process has created one
41121407Speter * or more threads. It is used to avoid calling locking functions
42121407Speter * when they are not required.
43323538Skib */
44323538Skibextern int	__isthreaded;
45323538Skib
46323538Skib/*
47124296Snectar * File lock contention is difficult to diagnose without knowing
48121407Speter * 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_MAX
133} pjt_index_t;
134
135typedef int (*pthread_func_t)(void);
136typedef pthread_func_t pthread_func_entry_t[2];
137
138extern pthread_func_entry_t __thr_jtable[];
139
140/*
141 * yplib internal interfaces
142 */
143#ifdef YP
144int _yp_check(char **);
145#endif
146
147/*
148 * Initialise TLS for static programs
149 */
150void _init_tls(void);
151
152/*
153 * Provides pthread_once()-like functionality for both single-threaded
154 * and multi-threaded applications.
155 */
156int _once(pthread_once_t *, void (*)(void));
157
158/*
159 * Set the TLS thread pointer
160 */
161void _set_tp(void *tp);
162
163/*
164 * This is a pointer in the C run-time startup code. It is used
165 * by getprogname() and setprogname().
166 */
167extern const char *__progname;
168
169/*
170 * This function is used by the threading libraries to notify malloc that a
171 * thread is exiting.
172 */
173void _malloc_thread_cleanup(void);
174
175/*
176 * These functions are used by the threading libraries in order to protect
177 * malloc across fork().
178 */
179void _malloc_prefork(void);
180void _malloc_postfork(void);
181
182/*
183 * Function to clean up streams, called from abort() and exit().
184 */
185extern void (*__cleanup)(void);
186
187/*
188 * Get kern.osreldate to detect ABI revisions.  Explicitly
189 * ignores value of $OSVERSION and caches result.  Prototypes
190 * for the wrapped "new" pad-less syscalls are here for now.
191 */
192extern int __getosreldate(void);
193#include <sys/_types.h>
194/* Without pad */
195extern __off_t	__sys_lseek(int, __off_t, int);
196extern int	__sys_ftruncate(int, __off_t);
197extern int	__sys_truncate(const char *, __off_t);
198extern __ssize_t __sys_pread(int, void *, __size_t, __off_t);
199extern __ssize_t __sys_pwrite(int, const void *, __size_t, __off_t);
200extern void *	__sys_mmap(void *, __size_t, int, int, int, __off_t);
201
202/* With pad */
203extern __off_t	__sys_freebsd6_lseek(int, int, __off_t, int);
204extern int	__sys_freebsd6_ftruncate(int, int, __off_t);
205extern int	__sys_freebsd6_truncate(const char *, int, __off_t);
206extern __ssize_t __sys_freebsd6_pread(int, void *, __size_t, int, __off_t);
207extern __ssize_t __sys_freebsd6_pwrite(int, const void *, __size_t, int, __off_t);
208extern void *	__sys_freebsd6_mmap(void *, __size_t, int, int, int, int, __off_t);
209
210/* Without back-compat translation */
211extern int	__sys_fcntl(int, int, ...);
212
213/* execve() with PATH processing to implement posix_spawnp() */
214int _execvpe(const char *, char * const *, char * const *);
215
216int _elf_aux_info(int aux, void *buf, int buflen);
217struct dl_phdr_info;
218int __elf_phdr_match_addr(struct dl_phdr_info *, void *);
219
220#endif /* _LIBC_PRIVATE_H_ */
221