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