libc_private.h revision 279049
135124Sjb/* 235124Sjb * Copyright (c) 1998 John Birrell <jb@cimlogic.com.au>. 335124Sjb * All rights reserved. 435124Sjb * 535124Sjb * Redistribution and use in source and binary forms, with or without 635124Sjb * modification, are permitted provided that the following conditions 735124Sjb * are met: 835124Sjb * 1. Redistributions of source code must retain the above copyright 935124Sjb * notice, this list of conditions and the following disclaimer. 1035124Sjb * 2. Redistributions in binary form must reproduce the above copyright 1135124Sjb * notice, this list of conditions and the following disclaimer in the 1235124Sjb * documentation and/or other materials provided with the distribution. 13165968Simp * 3. Neither the name of the author nor the names of any co-contributors 1435124Sjb * may be used to endorse or promote products derived from this software 1535124Sjb * without specific prior written permission. 1635124Sjb * 1735124Sjb * THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND 1835124Sjb * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 1935124Sjb * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 2035124Sjb * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 2135124Sjb * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 2235124Sjb * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2335124Sjb * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2435124Sjb * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2535124Sjb * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2635124Sjb * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2735124Sjb * SUCH DAMAGE. 2835124Sjb * 2950476Speter * $FreeBSD: stable/10/lib/libc/include/libc_private.h 279049 2015-02-20 09:25:13Z kib $ 3035124Sjb * 3135124Sjb * Private definitions for libc, libc_r and libpthread. 3235124Sjb * 3335124Sjb */ 3435124Sjb 3535124Sjb#ifndef _LIBC_PRIVATE_H_ 3635124Sjb#define _LIBC_PRIVATE_H_ 37237434Skib#include <sys/_types.h> 38199606Sjhb#include <sys/_pthreadtypes.h> 3935124Sjb 4035124Sjb/* 4135124Sjb * This global flag is non-zero when a process has created one 4235124Sjb * or more threads. It is used to avoid calling locking functions 4335124Sjb * when they are not required. 4435124Sjb */ 4535124Sjbextern int __isthreaded; 4635124Sjb 4735124Sjb/* 48231868Skib * Elf_Auxinfo *__elf_aux_vector, the pointer to the ELF aux vector 49231868Skib * provided by kernel. Either set for us by rtld, or found at runtime 50231868Skib * on stack for static binaries. 51231868Skib * 52231868Skib * Type is void to avoid polluting whole libc with ELF types. 53231868Skib */ 54231868Skibextern void *__elf_aux_vector; 55231868Skib 56231868Skib/* 57228843Scperciva * libc should use libc_dlopen internally, which respects a global 58228843Scperciva * flag where loading of new shared objects can be restricted. 59228843Scperciva */ 60228843Scpercivavoid *libc_dlopen(const char *, int); 61228843Scperciva 62228843Scperciva/* 63228843Scperciva * For dynamic linker. 64228843Scperciva */ 65228843Scpercivavoid _rtld_error(const char *fmt, ...); 66228843Scperciva 67228843Scperciva/* 6835124Sjb * File lock contention is difficult to diagnose without knowing 6935124Sjb * where locks were set. Allow a debug library to be built which 7035124Sjb * records the source file and line number of each lock call. 7135124Sjb */ 7235124Sjb#ifdef _FLOCK_DEBUG 7335124Sjb#define _FLOCKFILE(x) _flockfile_debug(x, __FILE__, __LINE__) 7435124Sjb#else 7571579Sdeischen#define _FLOCKFILE(x) _flockfile(x) 7635124Sjb#endif 7735124Sjb 7835124Sjb/* 7935124Sjb * Macros for locking and unlocking FILEs. These test if the 8035124Sjb * process is threaded to avoid locking when not required. 8135124Sjb */ 8235124Sjb#define FLOCKFILE(fp) if (__isthreaded) _FLOCKFILE(fp) 8371579Sdeischen#define FUNLOCKFILE(fp) if (__isthreaded) _funlockfile(fp) 8435124Sjb 85234657Skibstruct _spinlock; 86254706Sjillesextern struct _spinlock __stdio_thread_lock __hidden; 87234657Skib#define STDIO_THREAD_LOCK() \ 88234657Skibdo { \ 89234657Skib if (__isthreaded) \ 90234657Skib _SPINLOCK(&__stdio_thread_lock); \ 91234657Skib} while (0) 92234657Skib#define STDIO_THREAD_UNLOCK() \ 93234657Skibdo { \ 94234657Skib if (__isthreaded) \ 95234657Skib _SPINUNLOCK(&__stdio_thread_lock); \ 96234657Skib} while (0) 97234657Skib 98278875Skibvoid __libc_spinlock_stub(struct _spinlock *); 99278875Skibvoid __libc_spinunlock_stub(struct _spinlock *); 100278875Skib 10193399Smarkm/* 102106866Sdeischen * Indexes into the pthread jump table. 103106866Sdeischen * 104106866Sdeischen * Warning! If you change this type, you must also change the threads 105106866Sdeischen * libraries that reference it (libc_r, libpthread). 106106866Sdeischen */ 107106866Sdeischentypedef enum { 108156319Sdeischen PJT_ATFORK, 109156319Sdeischen PJT_ATTR_DESTROY, 110156319Sdeischen PJT_ATTR_GETDETACHSTATE, 111156319Sdeischen PJT_ATTR_GETGUARDSIZE, 112156319Sdeischen PJT_ATTR_GETINHERITSCHED, 113156319Sdeischen PJT_ATTR_GETSCHEDPARAM, 114156319Sdeischen PJT_ATTR_GETSCHEDPOLICY, 115156319Sdeischen PJT_ATTR_GETSCOPE, 116156319Sdeischen PJT_ATTR_GETSTACKADDR, 117156319Sdeischen PJT_ATTR_GETSTACKSIZE, 118156319Sdeischen PJT_ATTR_INIT, 119156319Sdeischen PJT_ATTR_SETDETACHSTATE, 120156319Sdeischen PJT_ATTR_SETGUARDSIZE, 121156319Sdeischen PJT_ATTR_SETINHERITSCHED, 122156319Sdeischen PJT_ATTR_SETSCHEDPARAM, 123156319Sdeischen PJT_ATTR_SETSCHEDPOLICY, 124156319Sdeischen PJT_ATTR_SETSCOPE, 125156319Sdeischen PJT_ATTR_SETSTACKADDR, 126156319Sdeischen PJT_ATTR_SETSTACKSIZE, 127156319Sdeischen PJT_CANCEL, 128156319Sdeischen PJT_CLEANUP_POP, 129156319Sdeischen PJT_CLEANUP_PUSH, 130106866Sdeischen PJT_COND_BROADCAST, 131106866Sdeischen PJT_COND_DESTROY, 132106866Sdeischen PJT_COND_INIT, 133106866Sdeischen PJT_COND_SIGNAL, 134156319Sdeischen PJT_COND_TIMEDWAIT, 135106866Sdeischen PJT_COND_WAIT, 136156319Sdeischen PJT_DETACH, 137156319Sdeischen PJT_EQUAL, 138156319Sdeischen PJT_EXIT, 139106866Sdeischen PJT_GETSPECIFIC, 140156319Sdeischen PJT_JOIN, 141106866Sdeischen PJT_KEY_CREATE, 142106866Sdeischen PJT_KEY_DELETE, 143156319Sdeischen PJT_KILL, 144106866Sdeischen PJT_MAIN_NP, 145156319Sdeischen PJT_MUTEXATTR_DESTROY, 146156319Sdeischen PJT_MUTEXATTR_INIT, 147156319Sdeischen PJT_MUTEXATTR_SETTYPE, 148106866Sdeischen PJT_MUTEX_DESTROY, 149106866Sdeischen PJT_MUTEX_INIT, 150106866Sdeischen PJT_MUTEX_LOCK, 151106866Sdeischen PJT_MUTEX_TRYLOCK, 152106866Sdeischen PJT_MUTEX_UNLOCK, 153106866Sdeischen PJT_ONCE, 154106866Sdeischen PJT_RWLOCK_DESTROY, 155106866Sdeischen PJT_RWLOCK_INIT, 156106866Sdeischen PJT_RWLOCK_RDLOCK, 157106866Sdeischen PJT_RWLOCK_TRYRDLOCK, 158106866Sdeischen PJT_RWLOCK_TRYWRLOCK, 159106866Sdeischen PJT_RWLOCK_UNLOCK, 160106866Sdeischen PJT_RWLOCK_WRLOCK, 161106866Sdeischen PJT_SELF, 162156319Sdeischen PJT_SETCANCELSTATE, 163156319Sdeischen PJT_SETCANCELTYPE, 164106866Sdeischen PJT_SETSPECIFIC, 165106866Sdeischen PJT_SIGMASK, 166156319Sdeischen PJT_TESTCANCEL, 167201546Sdavidxu PJT_CLEANUP_POP_IMP, 168201546Sdavidxu PJT_CLEANUP_PUSH_IMP, 169213153Sdavidxu PJT_CANCEL_ENTER, 170213153Sdavidxu PJT_CANCEL_LEAVE, 171106866Sdeischen PJT_MAX 172106866Sdeischen} pjt_index_t; 173106866Sdeischen 174106870Sdeischentypedef int (*pthread_func_t)(void); 175106880Sdeischentypedef pthread_func_t pthread_func_entry_t[2]; 176106866Sdeischen 177106880Sdeischenextern pthread_func_entry_t __thr_jtable[]; 178106866Sdeischen 179277317Skibvoid __set_error_selector(int *(*arg)(void)); 180277317Skibint _pthread_mutex_init_calloc_cb_stub(pthread_mutex_t *mutex, 181277317Skib void *(calloc_cb)(__size_t, __size_t)); 182277317Skib 183277317Skibtypedef int (*interpos_func_t)(void); 184277317Skibinterpos_func_t *__libc_interposing_slot(int interposno); 185277317Skibextern interpos_func_t __libc_interposing[] __hidden; 186277317Skib 187277317Skibenum { 188277317Skib INTERPOS_accept, 189277317Skib INTERPOS_accept4, 190277317Skib INTERPOS_aio_suspend, 191277317Skib INTERPOS_close, 192277317Skib INTERPOS_connect, 193277317Skib INTERPOS_fcntl, 194277317Skib INTERPOS_fsync, 195277317Skib INTERPOS_fork, 196277317Skib INTERPOS_msync, 197277317Skib INTERPOS_nanosleep, 198277317Skib INTERPOS_openat, 199277317Skib INTERPOS_poll, 200277317Skib INTERPOS_pselect, 201277317Skib INTERPOS_recvfrom, 202277317Skib INTERPOS_recvmsg, 203277317Skib INTERPOS_select, 204277317Skib INTERPOS_sendmsg, 205277317Skib INTERPOS_sendto, 206277317Skib INTERPOS_setcontext, 207277317Skib INTERPOS_sigaction, 208277317Skib INTERPOS_sigprocmask, 209277317Skib INTERPOS_sigsuspend, 210277317Skib INTERPOS_sigwait, 211277317Skib INTERPOS_sigtimedwait, 212277317Skib INTERPOS_sigwaitinfo, 213277317Skib INTERPOS_swapcontext, 214277317Skib INTERPOS_system, 215277317Skib INTERPOS_tcdrain, 216277317Skib INTERPOS_read, 217277317Skib INTERPOS_readv, 218277317Skib INTERPOS_wait4, 219277317Skib INTERPOS_write, 220277317Skib INTERPOS_writev, 221277317Skib INTERPOS__pthread_mutex_init_calloc_cb, 222278875Skib INTERPOS_spinlock, 223278875Skib INTERPOS_spinunlock, 224277317Skib INTERPOS_MAX 225277317Skib}; 226277317Skib 227106866Sdeischen/* 228111618Snectar * yplib internal interfaces 229111618Snectar */ 230111618Snectar#ifdef YP 231111618Snectarint _yp_check(char **); 232111618Snectar#endif 233111618Snectar 234133754Sdfr/* 235133754Sdfr * Initialise TLS for static programs 236133754Sdfr */ 237133754Sdfrvoid _init_tls(void); 238111618Snectar 239111618Snectar/* 240199606Sjhb * Provides pthread_once()-like functionality for both single-threaded 241199606Sjhb * and multi-threaded applications. 242199606Sjhb */ 243199606Sjhbint _once(pthread_once_t *, void (*)(void)); 244199606Sjhb 245199606Sjhb/* 246133754Sdfr * Set the TLS thread pointer 247133754Sdfr */ 248133754Sdfrvoid _set_tp(void *tp); 249133754Sdfr 250133754Sdfr/* 25193399Smarkm * This is a pointer in the C run-time startup code. It is used 25293399Smarkm * by getprogname() and setprogname(). 25393399Smarkm */ 25493399Smarkmextern const char *__progname; 25593399Smarkm 256122069Sdeischen/* 257182225Sjasone * This function is used by the threading libraries to notify malloc that a 258182225Sjasone * thread is exiting. 259182225Sjasone */ 260182225Sjasonevoid _malloc_thread_cleanup(void); 261182225Sjasone 262182225Sjasone/* 263154248Sjasone * These functions are used by the threading libraries in order to protect 264154248Sjasone * malloc across fork(). 265122069Sdeischen */ 266154248Sjasonevoid _malloc_prefork(void); 267154248Sjasonevoid _malloc_postfork(void); 268122069Sdeischen 269277317Skibvoid _malloc_first_thread(void); 270277317Skib 271150040Sstefanf/* 272150040Sstefanf * Function to clean up streams, called from abort() and exit(). 273150040Sstefanf */ 274279049Skibextern void (*__cleanup)(void) __hidden; 275150040Sstefanf 276171219Speter/* 277171219Speter * Get kern.osreldate to detect ABI revisions. Explicitly 278171219Speter * ignores value of $OSVERSION and caches result. Prototypes 279171219Speter * for the wrapped "new" pad-less syscalls are here for now. 280171219Speter */ 281277317Skibint __getosreldate(void); 282171219Speter#include <sys/_types.h> 283277317Skib#include <sys/_sigset.h> 284171219Speter 285171219Speter/* With pad */ 286277317Skib__off_t __sys_freebsd6_lseek(int, int, __off_t, int); 287277317Skibint __sys_freebsd6_ftruncate(int, int, __off_t); 288277317Skibint __sys_freebsd6_truncate(const char *, int, __off_t); 289277317Skib__ssize_t __sys_freebsd6_pread(int, void *, __size_t, int, __off_t); 290277317Skib__ssize_t __sys_freebsd6_pwrite(int, const void *, __size_t, int, __off_t); 291277317Skibvoid * __sys_freebsd6_mmap(void *, __size_t, int, int, int, int, __off_t); 292171219Speter 293277317Skibstruct aiocb; 294277317Skibstruct fd_set; 295277317Skibstruct iovec; 296277317Skibstruct msghdr; 297277317Skibstruct pollfd; 298277317Skibstruct rusage; 299277317Skibstruct sigaction; 300277317Skibstruct sockaddr; 301237434Skibstruct timespec; 302237434Skibstruct timeval; 303237434Skibstruct timezone; 304277317Skibstruct __siginfo; 305277317Skibstruct __ucontext; 306277317Skibint __sys_aio_suspend(const struct aiocb * const[], int, 307277317Skib const struct timespec *); 308277317Skibint __sys_accept(int, struct sockaddr *, __socklen_t *); 309277317Skibint __sys_accept4(int, struct sockaddr *, __socklen_t *, int); 310277317Skibint __sys_clock_gettime(__clockid_t, struct timespec *ts); 311277317Skibint __sys_close(int); 312277317Skibint __sys_connect(int, const struct sockaddr *, __socklen_t); 313277317Skibint __sys_fcntl(int, int, ...); 314277317Skibint __sys_fsync(int); 315277317Skib__pid_t __sys_fork(void); 316277317Skibint __sys_ftruncate(int, __off_t); 317277317Skibint __sys_gettimeofday(struct timeval *, struct timezone *); 318277317Skib__off_t __sys_lseek(int, __off_t, int); 319277317Skibvoid *__sys_mmap(void *, __size_t, int, int, int, __off_t); 320277317Skibint __sys_msync(void *, __size_t, int); 321277317Skibint __sys_nanosleep(const struct timespec *, struct timespec *); 322277317Skibint __sys_open(const char *, int, ...); 323277317Skibint __sys_openat(int, const char *, int, ...); 324277317Skibint __sys_pselect(int, struct fd_set *, struct fd_set *, 325277317Skib struct fd_set *, const struct timespec *, 326277317Skib const __sigset_t *); 327277317Skibint __sys_poll(struct pollfd *, unsigned, int); 328277317Skib__ssize_t __sys_pread(int, void *, __size_t, __off_t); 329277317Skib__ssize_t __sys_pwrite(int, const void *, __size_t, __off_t); 330277317Skib__ssize_t __sys_read(int, void *, __size_t); 331277317Skib__ssize_t __sys_readv(int, const struct iovec *, int); 332277317Skib__ssize_t __sys_recv(int, void *, __size_t, int); 333277317Skib__ssize_t __sys_recvfrom(int, void *, __size_t, int, struct sockaddr *, 334277317Skib __socklen_t *); 335277317Skib__ssize_t __sys_recvmsg(int, struct msghdr *, int); 336277317Skibint __sys_select(int, struct fd_set *, struct fd_set *, 337277317Skib struct fd_set *, struct timeval *); 338277317Skib__ssize_t __sys_sendmsg(int, const struct msghdr *, int); 339277317Skib__ssize_t __sys_sendto(int, const void *, __size_t, int, 340277317Skib const struct sockaddr *, __socklen_t); 341277317Skibint __sys_setcontext(const struct __ucontext *); 342277317Skibint __sys_sigaction(int, const struct sigaction *, 343277317Skib struct sigaction *); 344277317Skibint __sys_sigprocmask(int, const __sigset_t *, __sigset_t *); 345277317Skibint __sys_sigsuspend(const __sigset_t *); 346277317Skibint __sys_sigtimedwait(const __sigset_t *, struct __siginfo *, 347277317Skib const struct timespec *); 348277317Skibint __sys_sigwait(const __sigset_t *, int *); 349277317Skibint __sys_sigwaitinfo(const __sigset_t *, struct __siginfo *); 350277317Skibint __sys_swapcontext(struct __ucontext *, 351277317Skib const struct __ucontext *); 352277317Skibint __sys_thr_kill(long, int); 353277317Skibint __sys_thr_self(long *); 354277317Skibint __sys_truncate(const char *, __off_t); 355277317Skib__pid_t __sys_wait4(__pid_t, int *, int, struct rusage *); 356277317Skib__ssize_t __sys_write(int, const void *, __size_t); 357277317Skib__ssize_t __sys_writev(int, const struct iovec *, int); 358237434Skib 359277317Skibint __libc_sigwait(const __sigset_t * __restrict, 360277317Skib int * restrict sig); 361277317Skibint __libc_system(const char *); 362277317Skibint __libc_tcdrain(int); 363277317Skibint __fcntl_compat(int fd, int cmd, ...); 364277317Skib 365179947Sed/* execve() with PATH processing to implement posix_spawnp() */ 366179947Sedint _execvpe(const char *, char * const *, char * const *); 367179947Sed 368211416Skibint _elf_aux_info(int aux, void *buf, int buflen); 369211706Skibstruct dl_phdr_info; 370211706Skibint __elf_phdr_match_addr(struct dl_phdr_info *, void *); 371231868Skibvoid __init_elf_aux_vector(void); 372211416Skib 373213153Sdavidxuvoid _pthread_cancel_enter(int); 374213153Sdavidxuvoid _pthread_cancel_leave(int); 375213153Sdavidxu 37635124Sjb#endif /* _LIBC_PRIVATE_H_ */ 377