xref: /freebsd/lib/libc/include/libc_private.h (revision 13ea0450a9c8742119d36f3bf8f47accdce46e54)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1998 John Birrell <jb@cimlogic.com.au>.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of the author nor the names of any co-contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  *
31  * $FreeBSD$
32  *
33  * Private definitions for libc, libc_r and libpthread.
34  *
35  */
36 
37 #ifndef _LIBC_PRIVATE_H_
38 #define _LIBC_PRIVATE_H_
39 #include <sys/_types.h>
40 #include <sys/_pthreadtypes.h>
41 
42 /*
43  * This global flag is non-zero when a process has created one
44  * or more threads. It is used to avoid calling locking functions
45  * when they are not required.
46  */
47 #ifndef __LIBC_ISTHREADED_DECLARED
48 #define __LIBC_ISTHREADED_DECLARED
49 extern int	__isthreaded;
50 #endif
51 
52 /*
53  * Elf_Auxinfo *__elf_aux_vector, the pointer to the ELF aux vector
54  * provided by kernel. Either set for us by rtld, or found at runtime
55  * on stack for static binaries.
56  *
57  * Type is void to avoid polluting whole libc with ELF types.
58  */
59 extern void	*__elf_aux_vector;
60 
61 /*
62  * libc should use libc_dlopen internally, which respects a global
63  * flag where loading of new shared objects can be restricted.
64  */
65 void *libc_dlopen(const char *, int);
66 
67 /*
68  * For dynamic linker.
69  */
70 void _rtld_error(const char *fmt, ...);
71 
72 /*
73  * File lock contention is difficult to diagnose without knowing
74  * where locks were set. Allow a debug library to be built which
75  * records the source file and line number of each lock call.
76  */
77 #ifdef	_FLOCK_DEBUG
78 #define _FLOCKFILE(x)	_flockfile_debug(x, __FILE__, __LINE__)
79 #else
80 #define _FLOCKFILE(x)	_flockfile(x)
81 #endif
82 
83 /*
84  * Macros for locking and unlocking FILEs. These test if the
85  * process is threaded to avoid locking when not required.
86  */
87 #define	FLOCKFILE(fp)		if (__isthreaded) _FLOCKFILE(fp)
88 #define	FUNLOCKFILE(fp)		if (__isthreaded) _funlockfile(fp)
89 
90 struct _spinlock;
91 extern struct _spinlock __stdio_thread_lock __hidden;
92 #define STDIO_THREAD_LOCK()				\
93 do {							\
94 	if (__isthreaded)				\
95 		_SPINLOCK(&__stdio_thread_lock);	\
96 } while (0)
97 #define STDIO_THREAD_UNLOCK()				\
98 do {							\
99 	if (__isthreaded)				\
100 		_SPINUNLOCK(&__stdio_thread_lock);	\
101 } while (0)
102 
103 void		__libc_spinlock_stub(struct _spinlock *);
104 void		__libc_spinunlock_stub(struct _spinlock *);
105 
106 /*
107  * Indexes into the pthread jump table.
108  *
109  * Warning! If you change this type, you must also change the threads
110  * libraries that reference it (libc_r, libpthread).
111  */
112 typedef enum {
113 	PJT_ATFORK,
114 	PJT_ATTR_DESTROY,
115 	PJT_ATTR_GETDETACHSTATE,
116 	PJT_ATTR_GETGUARDSIZE,
117 	PJT_ATTR_GETINHERITSCHED,
118 	PJT_ATTR_GETSCHEDPARAM,
119 	PJT_ATTR_GETSCHEDPOLICY,
120 	PJT_ATTR_GETSCOPE,
121 	PJT_ATTR_GETSTACKADDR,
122 	PJT_ATTR_GETSTACKSIZE,
123 	PJT_ATTR_INIT,
124 	PJT_ATTR_SETDETACHSTATE,
125 	PJT_ATTR_SETGUARDSIZE,
126 	PJT_ATTR_SETINHERITSCHED,
127 	PJT_ATTR_SETSCHEDPARAM,
128 	PJT_ATTR_SETSCHEDPOLICY,
129 	PJT_ATTR_SETSCOPE,
130 	PJT_ATTR_SETSTACKADDR,
131 	PJT_ATTR_SETSTACKSIZE,
132 	PJT_CANCEL,
133 	PJT_CLEANUP_POP,
134 	PJT_CLEANUP_PUSH,
135 	PJT_COND_BROADCAST,
136 	PJT_COND_DESTROY,
137 	PJT_COND_INIT,
138 	PJT_COND_SIGNAL,
139 	PJT_COND_TIMEDWAIT,
140 	PJT_COND_WAIT,
141 	PJT_DETACH,
142 	PJT_EQUAL,
143 	PJT_EXIT,
144 	PJT_GETSPECIFIC,
145 	PJT_JOIN,
146 	PJT_KEY_CREATE,
147 	PJT_KEY_DELETE,
148 	PJT_KILL,
149 	PJT_MAIN_NP,
150 	PJT_MUTEXATTR_DESTROY,
151 	PJT_MUTEXATTR_INIT,
152 	PJT_MUTEXATTR_SETTYPE,
153 	PJT_MUTEX_DESTROY,
154 	PJT_MUTEX_INIT,
155 	PJT_MUTEX_LOCK,
156 	PJT_MUTEX_TRYLOCK,
157 	PJT_MUTEX_UNLOCK,
158 	PJT_ONCE,
159 	PJT_RWLOCK_DESTROY,
160 	PJT_RWLOCK_INIT,
161 	PJT_RWLOCK_RDLOCK,
162 	PJT_RWLOCK_TRYRDLOCK,
163 	PJT_RWLOCK_TRYWRLOCK,
164 	PJT_RWLOCK_UNLOCK,
165 	PJT_RWLOCK_WRLOCK,
166 	PJT_SELF,
167 	PJT_SETCANCELSTATE,
168 	PJT_SETCANCELTYPE,
169 	PJT_SETSPECIFIC,
170 	PJT_SIGMASK,
171 	PJT_TESTCANCEL,
172 	PJT_CLEANUP_POP_IMP,
173 	PJT_CLEANUP_PUSH_IMP,
174 	PJT_CANCEL_ENTER,
175 	PJT_CANCEL_LEAVE,
176 	PJT_MUTEX_CONSISTENT,
177 	PJT_MUTEXATTR_GETROBUST,
178 	PJT_MUTEXATTR_SETROBUST,
179 	PJT_MAX
180 } pjt_index_t;
181 
182 typedef int (*pthread_func_t)(void);
183 typedef pthread_func_t pthread_func_entry_t[2];
184 
185 extern pthread_func_entry_t __thr_jtable[];
186 
187 void	__set_error_selector(int *(*arg)(void));
188 int	_pthread_mutex_init_calloc_cb_stub(pthread_mutex_t *mutex,
189 	    void *(calloc_cb)(__size_t, __size_t));
190 
191 typedef int (*interpos_func_t)(void);
192 interpos_func_t *__libc_interposing_slot(int interposno);
193 extern interpos_func_t __libc_interposing[] __hidden;
194 
195 enum {
196 	INTERPOS_accept,
197 	INTERPOS_accept4,
198 	INTERPOS_aio_suspend,
199 	INTERPOS_close,
200 	INTERPOS_connect,
201 	INTERPOS_fcntl,
202 	INTERPOS_fsync,
203 	INTERPOS_fork,
204 	INTERPOS_msync,
205 	INTERPOS_nanosleep,
206 	INTERPOS_openat,
207 	INTERPOS_poll,
208 	INTERPOS_pselect,
209 	INTERPOS_recvfrom,
210 	INTERPOS_recvmsg,
211 	INTERPOS_select,
212 	INTERPOS_sendmsg,
213 	INTERPOS_sendto,
214 	INTERPOS_setcontext,
215 	INTERPOS_sigaction,
216 	INTERPOS_sigprocmask,
217 	INTERPOS_sigsuspend,
218 	INTERPOS_sigwait,
219 	INTERPOS_sigtimedwait,
220 	INTERPOS_sigwaitinfo,
221 	INTERPOS_swapcontext,
222 	INTERPOS_system,
223 	INTERPOS_tcdrain,
224 	INTERPOS_read,
225 	INTERPOS_readv,
226 	INTERPOS_wait4,
227 	INTERPOS_write,
228 	INTERPOS_writev,
229 	INTERPOS__pthread_mutex_init_calloc_cb,
230 	INTERPOS_spinlock,
231 	INTERPOS_spinunlock,
232 	INTERPOS_kevent,
233 	INTERPOS_wait6,
234 	INTERPOS_ppoll,
235 	INTERPOS_map_stacks_exec,
236 	INTERPOS_fdatasync,
237 	INTERPOS_clock_nanosleep,
238 	INTERPOS_MAX
239 };
240 
241 /*
242  * yplib internal interfaces
243  */
244 #ifdef YP
245 int _yp_check(char **);
246 #endif
247 
248 /*
249  * Initialise TLS for static programs
250  */
251 void _init_tls(void);
252 
253 /*
254  * Provides pthread_once()-like functionality for both single-threaded
255  * and multi-threaded applications.
256  */
257 int _once(pthread_once_t *, void (*)(void));
258 
259 /*
260  * Set the TLS thread pointer
261  */
262 void _set_tp(void *tp);
263 
264 /*
265  * This is a pointer in the C run-time startup code. It is used
266  * by getprogname() and setprogname().
267  */
268 extern const char *__progname;
269 
270 /*
271  * This function is used by the threading libraries to notify malloc that a
272  * thread is exiting.
273  */
274 void _malloc_thread_cleanup(void);
275 
276 /*
277  * This function is used by the threading libraries to notify libc that a
278  * thread is exiting, so its thread-local dtors should be called.
279  */
280 void __cxa_thread_call_dtors(void);
281 int __cxa_thread_atexit_hidden(void (*dtor_func)(void *), void *obj,
282     void *dso_symbol) __hidden;
283 
284 /*
285  * These functions are used by the threading libraries in order to protect
286  * malloc across fork().
287  */
288 void _malloc_prefork(void);
289 void _malloc_postfork(void);
290 
291 void _malloc_first_thread(void);
292 
293 /*
294  * Function to clean up streams, called from abort() and exit().
295  */
296 extern void (*__cleanup)(void) __hidden;
297 
298 /*
299  * Get kern.osreldate to detect ABI revisions.  Explicitly
300  * ignores value of $OSVERSION and caches result.
301  */
302 int __getosreldate(void);
303 #include <sys/_types.h>
304 #include <sys/_sigset.h>
305 
306 struct aiocb;
307 struct fd_set;
308 struct iovec;
309 struct kevent;
310 struct msghdr;
311 struct pollfd;
312 struct rusage;
313 struct sigaction;
314 struct sockaddr;
315 struct stat;
316 struct statfs;
317 struct timespec;
318 struct timeval;
319 struct timezone;
320 struct __siginfo;
321 struct __ucontext;
322 struct __wrusage;
323 enum idtype;
324 int		__sys_aio_suspend(const struct aiocb * const[], int,
325 		    const struct timespec *);
326 int		__sys_accept(int, struct sockaddr *, __socklen_t *);
327 int		__sys_accept4(int, struct sockaddr *, __socklen_t *, int);
328 int		__sys_clock_gettime(__clockid_t, struct timespec *ts);
329 int		__sys_clock_nanosleep(__clockid_t, int,
330 		    const struct timespec *, struct timespec *);
331 int		__sys_close(int);
332 int		__sys_connect(int, const struct sockaddr *, __socklen_t);
333 int		__sys_fcntl(int, int, ...);
334 int		__sys_fdatasync(int);
335 int		__sys_fstat(int fd, struct stat *);
336 int		__sys_fstatfs(int fd, struct statfs *);
337 int		__sys_fstatat(int, const char *, struct stat *, int);
338 int		__sys_fsync(int);
339 __pid_t		__sys_fork(void);
340 int		__sys_ftruncate(int, __off_t);
341 __ssize_t	__sys_getdirentries(int, char *, __size_t, __off_t *);
342 int		__sys_getfsstat(struct statfs *, long, int);
343 int		__sys_gettimeofday(struct timeval *, struct timezone *);
344 int		__sys_kevent(int, const struct kevent *, int, struct kevent *,
345 		    int, const struct timespec *);
346 __off_t		__sys_lseek(int, __off_t, int);
347 void	       *__sys_mmap(void *, __size_t, int, int, int, __off_t);
348 int		__sys_msync(void *, __size_t, int);
349 int		__sys_nanosleep(const struct timespec *, struct timespec *);
350 int		__sys_open(const char *, int, ...);
351 int		__sys_openat(int, const char *, int, ...);
352 int		__sys_pselect(int, struct fd_set *, struct fd_set *,
353 		    struct fd_set *, const struct timespec *,
354 		    const __sigset_t *);
355 int		__sys_ptrace(int, __pid_t, char *, int);
356 int		__sys_poll(struct pollfd *, unsigned, int);
357 int		__sys_ppoll(struct pollfd *, unsigned, const struct timespec *,
358 		    const __sigset_t *);
359 __ssize_t	__sys_pread(int, void *, __size_t, __off_t);
360 __ssize_t	__sys_pwrite(int, const void *, __size_t, __off_t);
361 __ssize_t	__sys_read(int, void *, __size_t);
362 __ssize_t	__sys_readv(int, const struct iovec *, int);
363 __ssize_t	__sys_recv(int, void *, __size_t, int);
364 __ssize_t	__sys_recvfrom(int, void *, __size_t, int, struct sockaddr *,
365 		    __socklen_t *);
366 __ssize_t	__sys_recvmsg(int, struct msghdr *, int);
367 int		__sys_select(int, struct fd_set *, struct fd_set *,
368 		    struct fd_set *, struct timeval *);
369 __ssize_t	__sys_sendmsg(int, const struct msghdr *, int);
370 __ssize_t	__sys_sendto(int, const void *, __size_t, int,
371 		    const struct sockaddr *, __socklen_t);
372 int		__sys_setcontext(const struct __ucontext *);
373 int		__sys_sigaction(int, const struct sigaction *,
374 		    struct sigaction *);
375 int		__sys_sigprocmask(int, const __sigset_t *, __sigset_t *);
376 int		__sys_sigsuspend(const __sigset_t *);
377 int		__sys_sigtimedwait(const __sigset_t *, struct __siginfo *,
378 		    const struct timespec *);
379 int		__sys_sigwait(const __sigset_t *, int *);
380 int		__sys_sigwaitinfo(const __sigset_t *, struct __siginfo *);
381 int		__sys_statfs(const char *, struct statfs *);
382 int		__sys_swapcontext(struct __ucontext *,
383 		    const struct __ucontext *);
384 int		__sys_thr_kill(long, int);
385 int		__sys_thr_self(long *);
386 int		__sys_truncate(const char *, __off_t);
387 __pid_t		__sys_wait4(__pid_t, int *, int, struct rusage *);
388 __pid_t		__sys_wait6(enum idtype, __id_t, int *, int,
389 		    struct __wrusage *, struct __siginfo *);
390 __ssize_t	__sys_write(int, const void *, __size_t);
391 __ssize_t	__sys_writev(int, const struct iovec *, int);
392 
393 int		__libc_sigaction(int, const struct sigaction *,
394 		    struct sigaction *) __hidden;
395 int		__libc_sigprocmask(int, const __sigset_t *, __sigset_t *)
396 		    __hidden;
397 int		__libc_sigsuspend(const __sigset_t *) __hidden;
398 int		__libc_sigwait(const __sigset_t * __restrict,
399 		    int * restrict sig);
400 int		__libc_system(const char *);
401 int		__libc_tcdrain(int);
402 int		__fcntl_compat(int fd, int cmd, ...);
403 
404 int		__sys_futimens(int fd, const struct timespec *times) __hidden;
405 int		__sys_utimensat(int fd, const char *path,
406 		    const struct timespec *times, int flag) __hidden;
407 
408 /* execve() with PATH processing to implement posix_spawnp() */
409 int _execvpe(const char *, char * const *, char * const *);
410 
411 int _elf_aux_info(int aux, void *buf, int buflen);
412 struct dl_phdr_info;
413 int __elf_phdr_match_addr(struct dl_phdr_info *, void *);
414 void __init_elf_aux_vector(void);
415 void __libc_map_stacks_exec(void);
416 
417 void	_pthread_cancel_enter(int);
418 void	_pthread_cancel_leave(int);
419 
420 struct _pthread_cleanup_info;
421 void	___pthread_cleanup_push_imp(void (*)(void *), void *,
422 	    struct _pthread_cleanup_info *);
423 void	___pthread_cleanup_pop_imp(int);
424 
425 void __throw_constraint_handler_s(const char * restrict msg, int error);
426 
427 #endif /* _LIBC_PRIVATE_H_ */
428