1 /*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 4 * Copyright (c) 1998 John Birrell <jb@cimlogic.com.au>. 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 3. Neither the name of the author nor the names of any co-contributors 16 * may be used to endorse or promote products derived from this software 17 * without specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29 * SUCH DAMAGE. 30 * 31 * $FreeBSD$ 32 * 33 * Private definitions for libc, libc_r and libpthread. 34 * 35 */ 36 37 #ifndef _LIBC_PRIVATE_H_ 38 #define _LIBC_PRIVATE_H_ 39 #include <sys/_types.h> 40 #include <sys/_pthreadtypes.h> 41 42 /* 43 * This global flag is non-zero when a process has created one 44 * or more threads. It is used to avoid calling locking functions 45 * when they are not required. 46 */ 47 #ifndef __LIBC_ISTHREADED_DECLARED 48 #define __LIBC_ISTHREADED_DECLARED 49 extern int __isthreaded; 50 #endif 51 52 /* 53 * Elf_Auxinfo *__elf_aux_vector, the pointer to the ELF aux vector 54 * provided by kernel. Either set for us by rtld, or found at runtime 55 * on stack for static binaries. 56 * 57 * Type is void to avoid polluting whole libc with ELF types. 58 */ 59 extern void *__elf_aux_vector; 60 61 /* 62 * libc should use libc_dlopen internally, which respects a global 63 * flag where loading of new shared objects can be restricted. 64 */ 65 void *libc_dlopen(const char *, int); 66 67 /* 68 * For dynamic linker. 69 */ 70 void _rtld_error(const char *fmt, ...); 71 72 /* 73 * File lock contention is difficult to diagnose without knowing 74 * where locks were set. Allow a debug library to be built which 75 * records the source file and line number of each lock call. 76 */ 77 #ifdef _FLOCK_DEBUG 78 #define _FLOCKFILE(x) _flockfile_debug(x, __FILE__, __LINE__) 79 #else 80 #define _FLOCKFILE(x) _flockfile(x) 81 #endif 82 83 /* 84 * Macros for locking and unlocking FILEs. These test if the 85 * process is threaded to avoid locking when not required. 86 */ 87 #define FLOCKFILE(fp) if (__isthreaded) _FLOCKFILE(fp) 88 #define FUNLOCKFILE(fp) if (__isthreaded) _funlockfile(fp) 89 90 struct _spinlock; 91 extern struct _spinlock __stdio_thread_lock __hidden; 92 #define STDIO_THREAD_LOCK() \ 93 do { \ 94 if (__isthreaded) \ 95 _SPINLOCK(&__stdio_thread_lock); \ 96 } while (0) 97 #define STDIO_THREAD_UNLOCK() \ 98 do { \ 99 if (__isthreaded) \ 100 _SPINUNLOCK(&__stdio_thread_lock); \ 101 } while (0) 102 103 void __libc_spinlock_stub(struct _spinlock *); 104 void __libc_spinunlock_stub(struct _spinlock *); 105 106 /* 107 * Indexes into the pthread jump table. 108 * 109 * Warning! If you change this type, you must also change the threads 110 * libraries that reference it (libc_r, libpthread). 111 */ 112 typedef enum { 113 PJT_ATFORK, 114 PJT_ATTR_DESTROY, 115 PJT_ATTR_GETDETACHSTATE, 116 PJT_ATTR_GETGUARDSIZE, 117 PJT_ATTR_GETINHERITSCHED, 118 PJT_ATTR_GETSCHEDPARAM, 119 PJT_ATTR_GETSCHEDPOLICY, 120 PJT_ATTR_GETSCOPE, 121 PJT_ATTR_GETSTACKADDR, 122 PJT_ATTR_GETSTACKSIZE, 123 PJT_ATTR_INIT, 124 PJT_ATTR_SETDETACHSTATE, 125 PJT_ATTR_SETGUARDSIZE, 126 PJT_ATTR_SETINHERITSCHED, 127 PJT_ATTR_SETSCHEDPARAM, 128 PJT_ATTR_SETSCHEDPOLICY, 129 PJT_ATTR_SETSCOPE, 130 PJT_ATTR_SETSTACKADDR, 131 PJT_ATTR_SETSTACKSIZE, 132 PJT_CANCEL, 133 PJT_CLEANUP_POP, 134 PJT_CLEANUP_PUSH, 135 PJT_COND_BROADCAST, 136 PJT_COND_DESTROY, 137 PJT_COND_INIT, 138 PJT_COND_SIGNAL, 139 PJT_COND_TIMEDWAIT, 140 PJT_COND_WAIT, 141 PJT_DETACH, 142 PJT_EQUAL, 143 PJT_EXIT, 144 PJT_GETSPECIFIC, 145 PJT_JOIN, 146 PJT_KEY_CREATE, 147 PJT_KEY_DELETE, 148 PJT_KILL, 149 PJT_MAIN_NP, 150 PJT_MUTEXATTR_DESTROY, 151 PJT_MUTEXATTR_INIT, 152 PJT_MUTEXATTR_SETTYPE, 153 PJT_MUTEX_DESTROY, 154 PJT_MUTEX_INIT, 155 PJT_MUTEX_LOCK, 156 PJT_MUTEX_TRYLOCK, 157 PJT_MUTEX_UNLOCK, 158 PJT_ONCE, 159 PJT_RWLOCK_DESTROY, 160 PJT_RWLOCK_INIT, 161 PJT_RWLOCK_RDLOCK, 162 PJT_RWLOCK_TRYRDLOCK, 163 PJT_RWLOCK_TRYWRLOCK, 164 PJT_RWLOCK_UNLOCK, 165 PJT_RWLOCK_WRLOCK, 166 PJT_SELF, 167 PJT_SETCANCELSTATE, 168 PJT_SETCANCELTYPE, 169 PJT_SETSPECIFIC, 170 PJT_SIGMASK, 171 PJT_TESTCANCEL, 172 PJT_CLEANUP_POP_IMP, 173 PJT_CLEANUP_PUSH_IMP, 174 PJT_CANCEL_ENTER, 175 PJT_CANCEL_LEAVE, 176 PJT_MUTEX_CONSISTENT, 177 PJT_MUTEXATTR_GETROBUST, 178 PJT_MUTEXATTR_SETROBUST, 179 PJT_GETTHREADID_NP, 180 PJT_MAX 181 } pjt_index_t; 182 183 typedef int (*pthread_func_t)(void); 184 typedef pthread_func_t pthread_func_entry_t[2]; 185 186 extern pthread_func_entry_t __thr_jtable[]; 187 188 void __set_error_selector(int *(*arg)(void)); 189 int _pthread_mutex_init_calloc_cb_stub(pthread_mutex_t *mutex, 190 void *(calloc_cb)(__size_t, __size_t)); 191 192 typedef int (*interpos_func_t)(void); 193 interpos_func_t *__libc_interposing_slot(int interposno); 194 extern interpos_func_t __libc_interposing[] __hidden; 195 196 enum { 197 INTERPOS_accept, 198 INTERPOS_accept4, 199 INTERPOS_aio_suspend, 200 INTERPOS_close, 201 INTERPOS_connect, 202 INTERPOS_fcntl, 203 INTERPOS_fsync, 204 INTERPOS_fork, 205 INTERPOS_msync, 206 INTERPOS_nanosleep, 207 INTERPOS_openat, 208 INTERPOS_poll, 209 INTERPOS_pselect, 210 INTERPOS_recvfrom, 211 INTERPOS_recvmsg, 212 INTERPOS_select, 213 INTERPOS_sendmsg, 214 INTERPOS_sendto, 215 INTERPOS_setcontext, 216 INTERPOS_sigaction, 217 INTERPOS_sigprocmask, 218 INTERPOS_sigsuspend, 219 INTERPOS_sigwait, 220 INTERPOS_sigtimedwait, 221 INTERPOS_sigwaitinfo, 222 INTERPOS_swapcontext, 223 INTERPOS_system, 224 INTERPOS_tcdrain, 225 INTERPOS_read, 226 INTERPOS_readv, 227 INTERPOS_wait4, 228 INTERPOS_write, 229 INTERPOS_writev, 230 INTERPOS__pthread_mutex_init_calloc_cb, 231 INTERPOS_spinlock, 232 INTERPOS_spinunlock, 233 INTERPOS_kevent, 234 INTERPOS_wait6, 235 INTERPOS_ppoll, 236 INTERPOS_map_stacks_exec, 237 INTERPOS_fdatasync, 238 INTERPOS_clock_nanosleep, 239 INTERPOS_distribute_static_tls, 240 INTERPOS_MAX 241 }; 242 243 /* 244 * yplib internal interfaces 245 */ 246 #ifdef YP 247 int _yp_check(char **); 248 #endif 249 250 /* 251 * Initialise TLS for static programs 252 */ 253 void _init_tls(void); 254 255 /* 256 * Provides pthread_once()-like functionality for both single-threaded 257 * and multi-threaded applications. 258 */ 259 int _once(pthread_once_t *, void (*)(void)); 260 261 /* 262 * Set the TLS thread pointer 263 */ 264 void _set_tp(void *tp); 265 266 /* 267 * This is a pointer in the C run-time startup code. It is used 268 * by getprogname() and setprogname(). 269 */ 270 extern const char *__progname; 271 272 /* 273 * This function is used by the threading libraries to notify malloc that a 274 * thread is exiting. 275 */ 276 void _malloc_thread_cleanup(void); 277 278 /* 279 * This function is used by the threading libraries to notify libc that a 280 * thread is exiting, so its thread-local dtors should be called. 281 */ 282 void __cxa_thread_call_dtors(void); 283 int __cxa_thread_atexit_hidden(void (*dtor_func)(void *), void *obj, 284 void *dso_symbol) __hidden; 285 286 /* 287 * These functions are used by the threading libraries in order to protect 288 * malloc across fork(). 289 */ 290 void _malloc_prefork(void); 291 void _malloc_postfork(void); 292 293 void _malloc_first_thread(void); 294 295 /* 296 * Function to clean up streams, called from abort() and exit(). 297 */ 298 extern void (*__cleanup)(void) __hidden; 299 300 /* 301 * Get kern.osreldate to detect ABI revisions. Explicitly 302 * ignores value of $OSVERSION and caches result. 303 */ 304 int __getosreldate(void); 305 #include <sys/_types.h> 306 #include <sys/_sigset.h> 307 308 struct aiocb; 309 struct fd_set; 310 struct iovec; 311 struct kevent; 312 struct msghdr; 313 struct pollfd; 314 struct rusage; 315 struct sigaction; 316 struct sockaddr; 317 struct stat; 318 struct statfs; 319 struct timespec; 320 struct timeval; 321 struct timezone; 322 struct __siginfo; 323 struct __ucontext; 324 struct __wrusage; 325 enum idtype; 326 int __sys_aio_suspend(const struct aiocb * const[], int, 327 const struct timespec *); 328 int __sys_accept(int, struct sockaddr *, __socklen_t *); 329 int __sys_accept4(int, struct sockaddr *, __socklen_t *, int); 330 int __sys_clock_gettime(__clockid_t, struct timespec *ts); 331 int __sys_clock_nanosleep(__clockid_t, int, 332 const struct timespec *, struct timespec *); 333 int __sys_close(int); 334 int __sys_close_range(unsigned, unsigned, int); 335 int __sys_connect(int, const struct sockaddr *, __socklen_t); 336 int __sys_fcntl(int, int, ...); 337 int __sys_fdatasync(int); 338 int __sys_fstat(int fd, struct stat *); 339 int __sys_fstatfs(int fd, struct statfs *); 340 int __sys_fstatat(int, const char *, struct stat *, int); 341 int __sys_fsync(int); 342 __pid_t __sys_fork(void); 343 int __sys_ftruncate(int, __off_t); 344 __ssize_t __sys_getdirentries(int, char *, __size_t, __off_t *); 345 int __sys_getfsstat(struct statfs *, long, int); 346 int __sys_gettimeofday(struct timeval *, struct timezone *); 347 int __sys_kevent(int, const struct kevent *, int, struct kevent *, 348 int, const struct timespec *); 349 __off_t __sys_lseek(int, __off_t, int); 350 void *__sys_mmap(void *, __size_t, int, int, int, __off_t); 351 int __sys_msync(void *, __size_t, int); 352 int __sys_nanosleep(const struct timespec *, struct timespec *); 353 int __sys_open(const char *, int, ...); 354 int __sys_openat(int, const char *, int, ...); 355 int __sys_pselect(int, struct fd_set *, struct fd_set *, 356 struct fd_set *, const struct timespec *, 357 const __sigset_t *); 358 int __sys_ptrace(int, __pid_t, char *, int); 359 int __sys_poll(struct pollfd *, unsigned, int); 360 int __sys_ppoll(struct pollfd *, unsigned, const struct timespec *, 361 const __sigset_t *); 362 __ssize_t __sys_pread(int, void *, __size_t, __off_t); 363 __ssize_t __sys_pwrite(int, const void *, __size_t, __off_t); 364 __ssize_t __sys_read(int, void *, __size_t); 365 __ssize_t __sys_readv(int, const struct iovec *, int); 366 __ssize_t __sys_recv(int, void *, __size_t, int); 367 __ssize_t __sys_recvfrom(int, void *, __size_t, int, struct sockaddr *, 368 __socklen_t *); 369 __ssize_t __sys_recvmsg(int, struct msghdr *, int); 370 int __sys_select(int, struct fd_set *, struct fd_set *, 371 struct fd_set *, struct timeval *); 372 __ssize_t __sys_sendmsg(int, const struct msghdr *, int); 373 __ssize_t __sys_sendto(int, const void *, __size_t, int, 374 const struct sockaddr *, __socklen_t); 375 int __sys_setcontext(const struct __ucontext *); 376 int __sys_sigaction(int, const struct sigaction *, 377 struct sigaction *); 378 int __sys_sigprocmask(int, const __sigset_t *, __sigset_t *); 379 int __sys_sigsuspend(const __sigset_t *); 380 int __sys_sigtimedwait(const __sigset_t *, struct __siginfo *, 381 const struct timespec *); 382 int __sys_sigwait(const __sigset_t *, int *); 383 int __sys_sigwaitinfo(const __sigset_t *, struct __siginfo *); 384 int __sys_statfs(const char *, struct statfs *); 385 int __sys_swapcontext(struct __ucontext *, 386 const struct __ucontext *); 387 int __sys_thr_kill(long, int); 388 int __sys_thr_self(long *); 389 int __sys_truncate(const char *, __off_t); 390 __pid_t __sys_wait4(__pid_t, int *, int, struct rusage *); 391 __pid_t __sys_wait6(enum idtype, __id_t, int *, int, 392 struct __wrusage *, struct __siginfo *); 393 __ssize_t __sys_write(int, const void *, __size_t); 394 __ssize_t __sys_writev(int, const struct iovec *, int); 395 int __sys_shm_open2(const char *, int, __mode_t, int, const char *); 396 397 int __libc_sigaction(int, const struct sigaction *, 398 struct sigaction *) __hidden; 399 int __libc_sigprocmask(int, const __sigset_t *, __sigset_t *) 400 __hidden; 401 int __libc_sigsuspend(const __sigset_t *) __hidden; 402 int __libc_sigwait(const __sigset_t * __restrict, 403 int * restrict sig); 404 int __libc_system(const char *); 405 int __libc_tcdrain(int); 406 int __fcntl_compat(int fd, int cmd, ...); 407 408 int __sys_futimens(int fd, const struct timespec *times) __hidden; 409 int __sys_utimensat(int fd, const char *path, 410 const struct timespec *times, int flag) __hidden; 411 412 /* execve() with PATH processing to implement posix_spawnp() */ 413 int _execvpe(const char *, char * const *, char * const *); 414 415 int _elf_aux_info(int aux, void *buf, int buflen); 416 struct dl_phdr_info; 417 int __elf_phdr_match_addr(struct dl_phdr_info *, void *); 418 void __init_elf_aux_vector(void); 419 void __libc_map_stacks_exec(void); 420 void __libc_distribute_static_tls(__size_t, void *, __size_t, __size_t); 421 __uintptr_t __libc_static_tls_base(__size_t); 422 423 void _pthread_cancel_enter(int); 424 void _pthread_cancel_leave(int); 425 426 struct _pthread_cleanup_info; 427 void ___pthread_cleanup_push_imp(void (*)(void *), void *, 428 struct _pthread_cleanup_info *); 429 void ___pthread_cleanup_pop_imp(int); 430 431 void __throw_constraint_handler_s(const char * restrict msg, int error); 432 433 #endif /* _LIBC_PRIVATE_H_ */ 434