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$ 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 47 extern 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 */ 57 extern 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 */ 63 void *libc_dlopen(const char *, int); 64 65 /* 66 * For dynamic linker. 67 */ 68 void _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 88 struct _spinlock; 89 extern struct _spinlock __stdio_thread_lock __hidden; 90 #define STDIO_THREAD_LOCK() \ 91 do { \ 92 if (__isthreaded) \ 93 _SPINLOCK(&__stdio_thread_lock); \ 94 } while (0) 95 #define STDIO_THREAD_UNLOCK() \ 96 do { \ 97 if (__isthreaded) \ 98 _SPINUNLOCK(&__stdio_thread_lock); \ 99 } while (0) 100 101 void __libc_spinlock_stub(struct _spinlock *); 102 void __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 */ 110 typedef 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 180 typedef int (*pthread_func_t)(void); 181 typedef pthread_func_t pthread_func_entry_t[2]; 182 183 extern pthread_func_entry_t __thr_jtable[]; 184 185 void __set_error_selector(int *(*arg)(void)); 186 int _pthread_mutex_init_calloc_cb_stub(pthread_mutex_t *mutex, 187 void *(calloc_cb)(__size_t, __size_t)); 188 189 typedef int (*interpos_func_t)(void); 190 interpos_func_t *__libc_interposing_slot(int interposno); 191 extern interpos_func_t __libc_interposing[] __hidden; 192 193 enum { 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_MAX 237 }; 238 239 /* 240 * yplib internal interfaces 241 */ 242 #ifdef YP 243 int _yp_check(char **); 244 #endif 245 246 /* 247 * Initialise TLS for static programs 248 */ 249 void _init_tls(void); 250 251 /* 252 * Provides pthread_once()-like functionality for both single-threaded 253 * and multi-threaded applications. 254 */ 255 int _once(pthread_once_t *, void (*)(void)); 256 257 /* 258 * Set the TLS thread pointer 259 */ 260 void _set_tp(void *tp); 261 262 /* 263 * This is a pointer in the C run-time startup code. It is used 264 * by getprogname() and setprogname(). 265 */ 266 extern const char *__progname; 267 268 /* 269 * This function is used by the threading libraries to notify malloc that a 270 * thread is exiting. 271 */ 272 void _malloc_thread_cleanup(void); 273 274 /* 275 * This function is used by the threading libraries to notify libc that a 276 * thread is exiting, so its thread-local dtors should be called. 277 */ 278 void __cxa_thread_call_dtors(void); 279 int __cxa_thread_atexit_hidden(void (*dtor_func)(void *), void *obj, 280 void *dso_symbol) __hidden; 281 282 /* 283 * These functions are used by the threading libraries in order to protect 284 * malloc across fork(). 285 */ 286 void _malloc_prefork(void); 287 void _malloc_postfork(void); 288 289 void _malloc_first_thread(void); 290 291 /* 292 * Function to clean up streams, called from abort() and exit(). 293 */ 294 extern void (*__cleanup)(void) __hidden; 295 296 /* 297 * Get kern.osreldate to detect ABI revisions. Explicitly 298 * ignores value of $OSVERSION and caches result. 299 */ 300 int __getosreldate(void); 301 #include <sys/_types.h> 302 #include <sys/_sigset.h> 303 304 struct aiocb; 305 struct fd_set; 306 struct iovec; 307 struct kevent; 308 struct msghdr; 309 struct pollfd; 310 struct rusage; 311 struct sigaction; 312 struct sockaddr; 313 struct stat; 314 struct statfs; 315 struct timespec; 316 struct timeval; 317 struct timezone; 318 struct __siginfo; 319 struct __ucontext; 320 struct __wrusage; 321 enum idtype; 322 int __sys_aio_suspend(const struct aiocb * const[], int, 323 const struct timespec *); 324 int __sys_accept(int, struct sockaddr *, __socklen_t *); 325 int __sys_accept4(int, struct sockaddr *, __socklen_t *, int); 326 int __sys_clock_gettime(__clockid_t, struct timespec *ts); 327 int __sys_clock_nanosleep(__clockid_t, int, 328 const struct timespec *, struct timespec *); 329 int __sys_close(int); 330 int __sys_connect(int, const struct sockaddr *, __socklen_t); 331 int __sys_fcntl(int, int, ...); 332 int __sys_fdatasync(int); 333 int __sys_fstat(int fd, struct stat *); 334 int __sys_fstatfs(int fd, struct statfs *); 335 int __sys_fstatat(int, const char *, struct stat *, int); 336 int __sys_fsync(int); 337 __pid_t __sys_fork(void); 338 int __sys_ftruncate(int, __off_t); 339 __ssize_t __sys_getdirentries(int, char *, __size_t, __off_t *); 340 int __sys_getfsstat(struct statfs *, long, int); 341 int __sys_gettimeofday(struct timeval *, struct timezone *); 342 int __sys_kevent(int, const struct kevent *, int, struct kevent *, 343 int, const struct timespec *); 344 __off_t __sys_lseek(int, __off_t, int); 345 void *__sys_mmap(void *, __size_t, int, int, int, __off_t); 346 int __sys_msync(void *, __size_t, int); 347 int __sys_nanosleep(const struct timespec *, struct timespec *); 348 int __sys_open(const char *, int, ...); 349 int __sys_openat(int, const char *, int, ...); 350 int __sys_pselect(int, struct fd_set *, struct fd_set *, 351 struct fd_set *, const struct timespec *, 352 const __sigset_t *); 353 int __sys_ptrace(int, __pid_t, char *, int); 354 int __sys_poll(struct pollfd *, unsigned, int); 355 int __sys_ppoll(struct pollfd *, unsigned, const struct timespec *, 356 const __sigset_t *); 357 __ssize_t __sys_pread(int, void *, __size_t, __off_t); 358 __ssize_t __sys_pwrite(int, const void *, __size_t, __off_t); 359 __ssize_t __sys_read(int, void *, __size_t); 360 __ssize_t __sys_readv(int, const struct iovec *, int); 361 __ssize_t __sys_recv(int, void *, __size_t, int); 362 __ssize_t __sys_recvfrom(int, void *, __size_t, int, struct sockaddr *, 363 __socklen_t *); 364 __ssize_t __sys_recvmsg(int, struct msghdr *, int); 365 int __sys_select(int, struct fd_set *, struct fd_set *, 366 struct fd_set *, struct timeval *); 367 __ssize_t __sys_sendmsg(int, const struct msghdr *, int); 368 __ssize_t __sys_sendto(int, const void *, __size_t, int, 369 const struct sockaddr *, __socklen_t); 370 int __sys_setcontext(const struct __ucontext *); 371 int __sys_sigaction(int, const struct sigaction *, 372 struct sigaction *); 373 int __sys_sigprocmask(int, const __sigset_t *, __sigset_t *); 374 int __sys_sigsuspend(const __sigset_t *); 375 int __sys_sigtimedwait(const __sigset_t *, struct __siginfo *, 376 const struct timespec *); 377 int __sys_sigwait(const __sigset_t *, int *); 378 int __sys_sigwaitinfo(const __sigset_t *, struct __siginfo *); 379 int __sys_statfs(const char *, struct statfs *); 380 int __sys_swapcontext(struct __ucontext *, 381 const struct __ucontext *); 382 int __sys_thr_kill(long, int); 383 int __sys_thr_self(long *); 384 int __sys_truncate(const char *, __off_t); 385 __pid_t __sys_wait4(__pid_t, int *, int, struct rusage *); 386 __pid_t __sys_wait6(enum idtype, __id_t, int *, int, 387 struct __wrusage *, struct __siginfo *); 388 __ssize_t __sys_write(int, const void *, __size_t); 389 __ssize_t __sys_writev(int, const struct iovec *, int); 390 391 int __libc_sigaction(int, const struct sigaction *, 392 struct sigaction *) __hidden; 393 int __libc_sigprocmask(int, const __sigset_t *, __sigset_t *) 394 __hidden; 395 int __libc_sigsuspend(const __sigset_t *) __hidden; 396 int __libc_sigwait(const __sigset_t * __restrict, 397 int * restrict sig); 398 int __libc_system(const char *); 399 int __libc_tcdrain(int); 400 int __fcntl_compat(int fd, int cmd, ...); 401 402 int __sys_futimens(int fd, const struct timespec *times) __hidden; 403 int __sys_utimensat(int fd, const char *path, 404 const struct timespec *times, int flag) __hidden; 405 406 /* execve() with PATH processing to implement posix_spawnp() */ 407 int _execvpe(const char *, char * const *, char * const *); 408 409 int _elf_aux_info(int aux, void *buf, int buflen); 410 struct dl_phdr_info; 411 int __elf_phdr_match_addr(struct dl_phdr_info *, void *); 412 void __init_elf_aux_vector(void); 413 void __libc_map_stacks_exec(void); 414 415 void _pthread_cancel_enter(int); 416 void _pthread_cancel_leave(int); 417 418 struct _pthread_cleanup_info; 419 void ___pthread_cleanup_push_imp(void (*)(void *), void *, 420 struct _pthread_cleanup_info *); 421 void ___pthread_cleanup_pop_imp(int); 422 423 void __throw_constraint_handler_s(const char * restrict msg, int error); 424 425 #endif /* _LIBC_PRIVATE_H_ */ 426