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