libc_private.h revision 277317
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 277317 2015-01-18 11:54:20Z 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 98/* 99 * Indexes into the pthread jump table. 100 * 101 * Warning! If you change this type, you must also change the threads 102 * libraries that reference it (libc_r, libpthread). 103 */ 104typedef enum { 105 PJT_ATFORK, 106 PJT_ATTR_DESTROY, 107 PJT_ATTR_GETDETACHSTATE, 108 PJT_ATTR_GETGUARDSIZE, 109 PJT_ATTR_GETINHERITSCHED, 110 PJT_ATTR_GETSCHEDPARAM, 111 PJT_ATTR_GETSCHEDPOLICY, 112 PJT_ATTR_GETSCOPE, 113 PJT_ATTR_GETSTACKADDR, 114 PJT_ATTR_GETSTACKSIZE, 115 PJT_ATTR_INIT, 116 PJT_ATTR_SETDETACHSTATE, 117 PJT_ATTR_SETGUARDSIZE, 118 PJT_ATTR_SETINHERITSCHED, 119 PJT_ATTR_SETSCHEDPARAM, 120 PJT_ATTR_SETSCHEDPOLICY, 121 PJT_ATTR_SETSCOPE, 122 PJT_ATTR_SETSTACKADDR, 123 PJT_ATTR_SETSTACKSIZE, 124 PJT_CANCEL, 125 PJT_CLEANUP_POP, 126 PJT_CLEANUP_PUSH, 127 PJT_COND_BROADCAST, 128 PJT_COND_DESTROY, 129 PJT_COND_INIT, 130 PJT_COND_SIGNAL, 131 PJT_COND_TIMEDWAIT, 132 PJT_COND_WAIT, 133 PJT_DETACH, 134 PJT_EQUAL, 135 PJT_EXIT, 136 PJT_GETSPECIFIC, 137 PJT_JOIN, 138 PJT_KEY_CREATE, 139 PJT_KEY_DELETE, 140 PJT_KILL, 141 PJT_MAIN_NP, 142 PJT_MUTEXATTR_DESTROY, 143 PJT_MUTEXATTR_INIT, 144 PJT_MUTEXATTR_SETTYPE, 145 PJT_MUTEX_DESTROY, 146 PJT_MUTEX_INIT, 147 PJT_MUTEX_LOCK, 148 PJT_MUTEX_TRYLOCK, 149 PJT_MUTEX_UNLOCK, 150 PJT_ONCE, 151 PJT_RWLOCK_DESTROY, 152 PJT_RWLOCK_INIT, 153 PJT_RWLOCK_RDLOCK, 154 PJT_RWLOCK_TRYRDLOCK, 155 PJT_RWLOCK_TRYWRLOCK, 156 PJT_RWLOCK_UNLOCK, 157 PJT_RWLOCK_WRLOCK, 158 PJT_SELF, 159 PJT_SETCANCELSTATE, 160 PJT_SETCANCELTYPE, 161 PJT_SETSPECIFIC, 162 PJT_SIGMASK, 163 PJT_TESTCANCEL, 164 PJT_CLEANUP_POP_IMP, 165 PJT_CLEANUP_PUSH_IMP, 166 PJT_CANCEL_ENTER, 167 PJT_CANCEL_LEAVE, 168 PJT_MAX 169} pjt_index_t; 170 171typedef int (*pthread_func_t)(void); 172typedef pthread_func_t pthread_func_entry_t[2]; 173 174extern pthread_func_entry_t __thr_jtable[]; 175 176void __set_error_selector(int *(*arg)(void)); 177int _pthread_mutex_init_calloc_cb_stub(pthread_mutex_t *mutex, 178 void *(calloc_cb)(__size_t, __size_t)); 179 180typedef int (*interpos_func_t)(void); 181interpos_func_t *__libc_interposing_slot(int interposno); 182extern interpos_func_t __libc_interposing[] __hidden; 183 184enum { 185 INTERPOS_accept, 186 INTERPOS_accept4, 187 INTERPOS_aio_suspend, 188 INTERPOS_close, 189 INTERPOS_connect, 190 INTERPOS_fcntl, 191 INTERPOS_fsync, 192 INTERPOS_fork, 193 INTERPOS_msync, 194 INTERPOS_nanosleep, 195 INTERPOS_openat, 196 INTERPOS_poll, 197 INTERPOS_pselect, 198 INTERPOS_recvfrom, 199 INTERPOS_recvmsg, 200 INTERPOS_select, 201 INTERPOS_sendmsg, 202 INTERPOS_sendto, 203 INTERPOS_setcontext, 204 INTERPOS_sigaction, 205 INTERPOS_sigprocmask, 206 INTERPOS_sigsuspend, 207 INTERPOS_sigwait, 208 INTERPOS_sigtimedwait, 209 INTERPOS_sigwaitinfo, 210 INTERPOS_swapcontext, 211 INTERPOS_system, 212 INTERPOS_tcdrain, 213 INTERPOS_read, 214 INTERPOS_readv, 215 INTERPOS_wait4, 216 INTERPOS_write, 217 INTERPOS_writev, 218 INTERPOS__pthread_mutex_init_calloc_cb, 219 INTERPOS_MAX 220}; 221 222/* 223 * yplib internal interfaces 224 */ 225#ifdef YP 226int _yp_check(char **); 227#endif 228 229/* 230 * Initialise TLS for static programs 231 */ 232void _init_tls(void); 233 234/* 235 * Provides pthread_once()-like functionality for both single-threaded 236 * and multi-threaded applications. 237 */ 238int _once(pthread_once_t *, void (*)(void)); 239 240/* 241 * Set the TLS thread pointer 242 */ 243void _set_tp(void *tp); 244 245/* 246 * This is a pointer in the C run-time startup code. It is used 247 * by getprogname() and setprogname(). 248 */ 249extern const char *__progname; 250 251/* 252 * This function is used by the threading libraries to notify malloc that a 253 * thread is exiting. 254 */ 255void _malloc_thread_cleanup(void); 256 257/* 258 * These functions are used by the threading libraries in order to protect 259 * malloc across fork(). 260 */ 261void _malloc_prefork(void); 262void _malloc_postfork(void); 263 264void _malloc_first_thread(void); 265 266/* 267 * Function to clean up streams, called from abort() and exit(). 268 */ 269void (*__cleanup)(void) __hidden; 270 271/* 272 * Get kern.osreldate to detect ABI revisions. Explicitly 273 * ignores value of $OSVERSION and caches result. Prototypes 274 * for the wrapped "new" pad-less syscalls are here for now. 275 */ 276int __getosreldate(void); 277#include <sys/_types.h> 278#include <sys/_sigset.h> 279 280/* With pad */ 281__off_t __sys_freebsd6_lseek(int, int, __off_t, int); 282int __sys_freebsd6_ftruncate(int, int, __off_t); 283int __sys_freebsd6_truncate(const char *, int, __off_t); 284__ssize_t __sys_freebsd6_pread(int, void *, __size_t, int, __off_t); 285__ssize_t __sys_freebsd6_pwrite(int, const void *, __size_t, int, __off_t); 286void * __sys_freebsd6_mmap(void *, __size_t, int, int, int, int, __off_t); 287 288struct aiocb; 289struct fd_set; 290struct iovec; 291struct msghdr; 292struct pollfd; 293struct rusage; 294struct sigaction; 295struct sockaddr; 296struct timespec; 297struct timeval; 298struct timezone; 299struct __siginfo; 300struct __ucontext; 301int __sys_aio_suspend(const struct aiocb * const[], int, 302 const struct timespec *); 303int __sys_accept(int, struct sockaddr *, __socklen_t *); 304int __sys_accept4(int, struct sockaddr *, __socklen_t *, int); 305int __sys_clock_gettime(__clockid_t, struct timespec *ts); 306int __sys_close(int); 307int __sys_connect(int, const struct sockaddr *, __socklen_t); 308int __sys_fcntl(int, int, ...); 309int __sys_fsync(int); 310__pid_t __sys_fork(void); 311int __sys_ftruncate(int, __off_t); 312int __sys_gettimeofday(struct timeval *, struct timezone *); 313__off_t __sys_lseek(int, __off_t, int); 314void *__sys_mmap(void *, __size_t, int, int, int, __off_t); 315int __sys_msync(void *, __size_t, int); 316int __sys_nanosleep(const struct timespec *, struct timespec *); 317int __sys_open(const char *, int, ...); 318int __sys_openat(int, const char *, int, ...); 319int __sys_pselect(int, struct fd_set *, struct fd_set *, 320 struct fd_set *, const struct timespec *, 321 const __sigset_t *); 322int __sys_poll(struct pollfd *, unsigned, int); 323__ssize_t __sys_pread(int, void *, __size_t, __off_t); 324__ssize_t __sys_pwrite(int, const void *, __size_t, __off_t); 325__ssize_t __sys_read(int, void *, __size_t); 326__ssize_t __sys_readv(int, const struct iovec *, int); 327__ssize_t __sys_recv(int, void *, __size_t, int); 328__ssize_t __sys_recvfrom(int, void *, __size_t, int, struct sockaddr *, 329 __socklen_t *); 330__ssize_t __sys_recvmsg(int, struct msghdr *, int); 331int __sys_select(int, struct fd_set *, struct fd_set *, 332 struct fd_set *, struct timeval *); 333__ssize_t __sys_sendmsg(int, const struct msghdr *, int); 334__ssize_t __sys_sendto(int, const void *, __size_t, int, 335 const struct sockaddr *, __socklen_t); 336int __sys_setcontext(const struct __ucontext *); 337int __sys_sigaction(int, const struct sigaction *, 338 struct sigaction *); 339int __sys_sigprocmask(int, const __sigset_t *, __sigset_t *); 340int __sys_sigsuspend(const __sigset_t *); 341int __sys_sigtimedwait(const __sigset_t *, struct __siginfo *, 342 const struct timespec *); 343int __sys_sigwait(const __sigset_t *, int *); 344int __sys_sigwaitinfo(const __sigset_t *, struct __siginfo *); 345int __sys_swapcontext(struct __ucontext *, 346 const struct __ucontext *); 347int __sys_thr_kill(long, int); 348int __sys_thr_self(long *); 349int __sys_truncate(const char *, __off_t); 350__pid_t __sys_wait4(__pid_t, int *, int, struct rusage *); 351__ssize_t __sys_write(int, const void *, __size_t); 352__ssize_t __sys_writev(int, const struct iovec *, int); 353 354int __libc_sigwait(const __sigset_t * __restrict, 355 int * restrict sig); 356int __libc_system(const char *); 357int __libc_tcdrain(int); 358int __fcntl_compat(int fd, int cmd, ...); 359 360/* execve() with PATH processing to implement posix_spawnp() */ 361int _execvpe(const char *, char * const *, char * const *); 362 363int _elf_aux_info(int aux, void *buf, int buflen); 364struct dl_phdr_info; 365int __elf_phdr_match_addr(struct dl_phdr_info *, void *); 366void __init_elf_aux_vector(void); 367 368void _pthread_cancel_enter(int); 369void _pthread_cancel_leave(int); 370 371#endif /* _LIBC_PRIVATE_H_ */ 372