libc_private.h revision 346156
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: stable/11/lib/libc/include/libc_private.h 346156 2019-04-12 15:15:27Z kib $ 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/_types.h> 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 47extern int __isthreaded; 48#endif 49 50/* 51 * Elf_Auxinfo *__elf_aux_vector, the pointer to the ELF aux vector 52 * provided by kernel. Either set for us by rtld, or found at runtime 53 * on stack for static binaries. 54 * 55 * Type is void to avoid polluting whole libc with ELF types. 56 */ 57extern void *__elf_aux_vector; 58 59/* 60 * libc should use libc_dlopen internally, which respects a global 61 * flag where loading of new shared objects can be restricted. 62 */ 63void *libc_dlopen(const char *, int); 64 65/* 66 * For dynamic linker. 67 */ 68void _rtld_error(const char *fmt, ...); 69 70/* 71 * File lock contention is difficult to diagnose without knowing 72 * where locks were set. Allow a debug library to be built which 73 * records the source file and line number of each lock call. 74 */ 75#ifdef _FLOCK_DEBUG 76#define _FLOCKFILE(x) _flockfile_debug(x, __FILE__, __LINE__) 77#else 78#define _FLOCKFILE(x) _flockfile(x) 79#endif 80 81/* 82 * Macros for locking and unlocking FILEs. These test if the 83 * process is threaded to avoid locking when not required. 84 */ 85#define FLOCKFILE(fp) if (__isthreaded) _FLOCKFILE(fp) 86#define FUNLOCKFILE(fp) if (__isthreaded) _funlockfile(fp) 87 88struct _spinlock; 89extern struct _spinlock __stdio_thread_lock __hidden; 90#define STDIO_THREAD_LOCK() \ 91do { \ 92 if (__isthreaded) \ 93 _SPINLOCK(&__stdio_thread_lock); \ 94} while (0) 95#define STDIO_THREAD_UNLOCK() \ 96do { \ 97 if (__isthreaded) \ 98 _SPINUNLOCK(&__stdio_thread_lock); \ 99} while (0) 100 101void __libc_spinlock_stub(struct _spinlock *); 102void __libc_spinunlock_stub(struct _spinlock *); 103 104/* 105 * Indexes into the pthread jump table. 106 * 107 * Warning! If you change this type, you must also change the threads 108 * libraries that reference it (libc_r, libpthread). 109 */ 110typedef enum { 111 PJT_ATFORK, 112 PJT_ATTR_DESTROY, 113 PJT_ATTR_GETDETACHSTATE, 114 PJT_ATTR_GETGUARDSIZE, 115 PJT_ATTR_GETINHERITSCHED, 116 PJT_ATTR_GETSCHEDPARAM, 117 PJT_ATTR_GETSCHEDPOLICY, 118 PJT_ATTR_GETSCOPE, 119 PJT_ATTR_GETSTACKADDR, 120 PJT_ATTR_GETSTACKSIZE, 121 PJT_ATTR_INIT, 122 PJT_ATTR_SETDETACHSTATE, 123 PJT_ATTR_SETGUARDSIZE, 124 PJT_ATTR_SETINHERITSCHED, 125 PJT_ATTR_SETSCHEDPARAM, 126 PJT_ATTR_SETSCHEDPOLICY, 127 PJT_ATTR_SETSCOPE, 128 PJT_ATTR_SETSTACKADDR, 129 PJT_ATTR_SETSTACKSIZE, 130 PJT_CANCEL, 131 PJT_CLEANUP_POP, 132 PJT_CLEANUP_PUSH, 133 PJT_COND_BROADCAST, 134 PJT_COND_DESTROY, 135 PJT_COND_INIT, 136 PJT_COND_SIGNAL, 137 PJT_COND_TIMEDWAIT, 138 PJT_COND_WAIT, 139 PJT_DETACH, 140 PJT_EQUAL, 141 PJT_EXIT, 142 PJT_GETSPECIFIC, 143 PJT_JOIN, 144 PJT_KEY_CREATE, 145 PJT_KEY_DELETE, 146 PJT_KILL, 147 PJT_MAIN_NP, 148 PJT_MUTEXATTR_DESTROY, 149 PJT_MUTEXATTR_INIT, 150 PJT_MUTEXATTR_SETTYPE, 151 PJT_MUTEX_DESTROY, 152 PJT_MUTEX_INIT, 153 PJT_MUTEX_LOCK, 154 PJT_MUTEX_TRYLOCK, 155 PJT_MUTEX_UNLOCK, 156 PJT_ONCE, 157 PJT_RWLOCK_DESTROY, 158 PJT_RWLOCK_INIT, 159 PJT_RWLOCK_RDLOCK, 160 PJT_RWLOCK_TRYRDLOCK, 161 PJT_RWLOCK_TRYWRLOCK, 162 PJT_RWLOCK_UNLOCK, 163 PJT_RWLOCK_WRLOCK, 164 PJT_SELF, 165 PJT_SETCANCELSTATE, 166 PJT_SETCANCELTYPE, 167 PJT_SETSPECIFIC, 168 PJT_SIGMASK, 169 PJT_TESTCANCEL, 170 PJT_CLEANUP_POP_IMP, 171 PJT_CLEANUP_PUSH_IMP, 172 PJT_CANCEL_ENTER, 173 PJT_CANCEL_LEAVE, 174 PJT_MUTEX_CONSISTENT, 175 PJT_MUTEXATTR_GETROBUST, 176 PJT_MUTEXATTR_SETROBUST, 177 PJT_MAX 178} pjt_index_t; 179 180typedef int (*pthread_func_t)(void); 181typedef pthread_func_t pthread_func_entry_t[2]; 182 183extern pthread_func_entry_t __thr_jtable[]; 184 185void __set_error_selector(int *(*arg)(void)); 186int _pthread_mutex_init_calloc_cb_stub(pthread_mutex_t *mutex, 187 void *(calloc_cb)(__size_t, __size_t)); 188 189typedef int (*interpos_func_t)(void); 190interpos_func_t *__libc_interposing_slot(int interposno); 191extern interpos_func_t __libc_interposing[] __hidden; 192 193enum { 194 INTERPOS_accept, 195 INTERPOS_accept4, 196 INTERPOS_aio_suspend, 197 INTERPOS_close, 198 INTERPOS_connect, 199 INTERPOS_fcntl, 200 INTERPOS_fsync, 201 INTERPOS_fork, 202 INTERPOS_msync, 203 INTERPOS_nanosleep, 204 INTERPOS_openat, 205 INTERPOS_poll, 206 INTERPOS_pselect, 207 INTERPOS_recvfrom, 208 INTERPOS_recvmsg, 209 INTERPOS_select, 210 INTERPOS_sendmsg, 211 INTERPOS_sendto, 212 INTERPOS_setcontext, 213 INTERPOS_sigaction, 214 INTERPOS_sigprocmask, 215 INTERPOS_sigsuspend, 216 INTERPOS_sigwait, 217 INTERPOS_sigtimedwait, 218 INTERPOS_sigwaitinfo, 219 INTERPOS_swapcontext, 220 INTERPOS_system, 221 INTERPOS_tcdrain, 222 INTERPOS_read, 223 INTERPOS_readv, 224 INTERPOS_wait4, 225 INTERPOS_write, 226 INTERPOS_writev, 227 INTERPOS__pthread_mutex_init_calloc_cb, 228 INTERPOS_spinlock, 229 INTERPOS_spinunlock, 230 INTERPOS_kevent, 231 INTERPOS_wait6, 232 INTERPOS_ppoll, 233 INTERPOS_map_stacks_exec, 234 INTERPOS_fdatasync, 235 INTERPOS_clock_nanosleep, 236 INTERPOS_distribute_static_tls, 237 INTERPOS_MAX 238}; 239 240/* 241 * yplib internal interfaces 242 */ 243#ifdef YP 244int _yp_check(char **); 245#endif 246 247/* 248 * Initialise TLS for static programs 249 */ 250void _init_tls(void); 251 252/* 253 * Provides pthread_once()-like functionality for both single-threaded 254 * and multi-threaded applications. 255 */ 256int _once(pthread_once_t *, void (*)(void)); 257 258/* 259 * Set the TLS thread pointer 260 */ 261void _set_tp(void *tp); 262 263/* 264 * This is a pointer in the C run-time startup code. It is used 265 * by getprogname() and setprogname(). 266 */ 267extern const char *__progname; 268 269/* 270 * This function is used by the threading libraries to notify malloc that a 271 * thread is exiting. 272 */ 273void _malloc_thread_cleanup(void); 274 275/* 276 * This function is used by the threading libraries to notify libc that a 277 * thread is exiting, so its thread-local dtors should be called. 278 */ 279void __cxa_thread_call_dtors(void); 280int __cxa_thread_atexit_hidden(void (*dtor_func)(void *), void *obj, 281 void *dso_symbol) __hidden; 282 283/* 284 * These functions are used by the threading libraries in order to protect 285 * malloc across fork(). 286 */ 287void _malloc_prefork(void); 288void _malloc_postfork(void); 289 290void _malloc_first_thread(void); 291 292/* 293 * Function to clean up streams, called from abort() and exit(). 294 */ 295extern void (*__cleanup)(void) __hidden; 296 297/* 298 * Get kern.osreldate to detect ABI revisions. Explicitly 299 * ignores value of $OSVERSION and caches result. 300 */ 301int __getosreldate(void); 302#include <sys/_types.h> 303#include <sys/_sigset.h> 304 305struct aiocb; 306struct fd_set; 307struct iovec; 308struct kevent; 309struct msghdr; 310struct pollfd; 311struct rusage; 312struct sigaction; 313struct sockaddr; 314struct timespec; 315struct timeval; 316struct timezone; 317struct __siginfo; 318struct __ucontext; 319struct __wrusage; 320enum idtype; 321int __sys_aio_suspend(const struct aiocb * const[], int, 322 const struct timespec *); 323int __sys_accept(int, struct sockaddr *, __socklen_t *); 324int __sys_accept4(int, struct sockaddr *, __socklen_t *, int); 325int __sys_clock_gettime(__clockid_t, struct timespec *ts); 326int __sys_clock_nanosleep(__clockid_t, int, 327 const struct timespec *, struct timespec *); 328int __sys_close(int); 329int __sys_connect(int, const struct sockaddr *, __socklen_t); 330int __sys_fcntl(int, int, ...); 331int __sys_fdatasync(int); 332int __sys_fsync(int); 333__pid_t __sys_fork(void); 334int __sys_ftruncate(int, __off_t); 335int __sys_gettimeofday(struct timeval *, struct timezone *); 336int __sys_kevent(int, const struct kevent *, int, struct kevent *, 337 int, const struct timespec *); 338__off_t __sys_lseek(int, __off_t, int); 339void *__sys_mmap(void *, __size_t, int, int, int, __off_t); 340int __sys_msync(void *, __size_t, int); 341int __sys_nanosleep(const struct timespec *, struct timespec *); 342int __sys_open(const char *, int, ...); 343int __sys_openat(int, const char *, int, ...); 344int __sys_pselect(int, struct fd_set *, struct fd_set *, 345 struct fd_set *, const struct timespec *, 346 const __sigset_t *); 347int __sys_ptrace(int, __pid_t, char *, int); 348int __sys_poll(struct pollfd *, unsigned, int); 349int __sys_ppoll(struct pollfd *, unsigned, const struct timespec *, 350 const __sigset_t *); 351__ssize_t __sys_pread(int, void *, __size_t, __off_t); 352__ssize_t __sys_pwrite(int, const void *, __size_t, __off_t); 353__ssize_t __sys_read(int, void *, __size_t); 354__ssize_t __sys_readv(int, const struct iovec *, int); 355__ssize_t __sys_recv(int, void *, __size_t, int); 356__ssize_t __sys_recvfrom(int, void *, __size_t, int, struct sockaddr *, 357 __socklen_t *); 358__ssize_t __sys_recvmsg(int, struct msghdr *, int); 359int __sys_select(int, struct fd_set *, struct fd_set *, 360 struct fd_set *, struct timeval *); 361__ssize_t __sys_sendmsg(int, const struct msghdr *, int); 362__ssize_t __sys_sendto(int, const void *, __size_t, int, 363 const struct sockaddr *, __socklen_t); 364int __sys_setcontext(const struct __ucontext *); 365int __sys_sigaction(int, const struct sigaction *, 366 struct sigaction *); 367int __sys_sigprocmask(int, const __sigset_t *, __sigset_t *); 368int __sys_sigsuspend(const __sigset_t *); 369int __sys_sigtimedwait(const __sigset_t *, struct __siginfo *, 370 const struct timespec *); 371int __sys_sigwait(const __sigset_t *, int *); 372int __sys_sigwaitinfo(const __sigset_t *, struct __siginfo *); 373int __sys_swapcontext(struct __ucontext *, 374 const struct __ucontext *); 375int __sys_thr_kill(long, int); 376int __sys_thr_self(long *); 377int __sys_truncate(const char *, __off_t); 378__pid_t __sys_wait4(__pid_t, int *, int, struct rusage *); 379__pid_t __sys_wait6(enum idtype, __id_t, int *, int, 380 struct __wrusage *, struct __siginfo *); 381__ssize_t __sys_write(int, const void *, __size_t); 382__ssize_t __sys_writev(int, const struct iovec *, int); 383 384int __libc_sigaction(int, const struct sigaction *, 385 struct sigaction *) __hidden; 386int __libc_sigprocmask(int, const __sigset_t *, __sigset_t *) 387 __hidden; 388int __libc_sigsuspend(const __sigset_t *) __hidden; 389int __libc_sigwait(const __sigset_t * __restrict, 390 int * restrict sig); 391int __libc_system(const char *); 392int __libc_tcdrain(int); 393int __fcntl_compat(int fd, int cmd, ...); 394 395int __sys_futimens(int fd, const struct timespec *times) __hidden; 396int __sys_utimensat(int fd, const char *path, 397 const struct timespec *times, int flag) __hidden; 398 399/* execve() with PATH processing to implement posix_spawnp() */ 400int _execvpe(const char *, char * const *, char * const *); 401 402int _elf_aux_info(int aux, void *buf, int buflen); 403struct dl_phdr_info; 404int __elf_phdr_match_addr(struct dl_phdr_info *, void *); 405void __init_elf_aux_vector(void); 406void __libc_map_stacks_exec(void); 407void __libc_distribute_static_tls(__size_t, void *, __size_t, __size_t); 408__uintptr_t __libc_static_tls_base(__size_t); 409 410void _pthread_cancel_enter(int); 411void _pthread_cancel_leave(int); 412 413struct _pthread_cleanup_info; 414void ___pthread_cleanup_push_imp(void (*)(void *), void *, 415 struct _pthread_cleanup_info *); 416void ___pthread_cleanup_pop_imp(int); 417 418void __throw_constraint_handler_s(const char * restrict msg, int error); 419 420#endif /* _LIBC_PRIVATE_H_ */ 421