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