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