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 /* 99 * Indexes into the pthread jump table. 100 * 101 * Warning! If you change this type, you must also change the threads 102 * libraries that reference it (libc_r, libpthread). 103 */ 104 typedef enum { 105 PJT_ATFORK, 106 PJT_ATTR_DESTROY, 107 PJT_ATTR_GETDETACHSTATE, 108 PJT_ATTR_GETGUARDSIZE, 109 PJT_ATTR_GETINHERITSCHED, 110 PJT_ATTR_GETSCHEDPARAM, 111 PJT_ATTR_GETSCHEDPOLICY, 112 PJT_ATTR_GETSCOPE, 113 PJT_ATTR_GETSTACKADDR, 114 PJT_ATTR_GETSTACKSIZE, 115 PJT_ATTR_INIT, 116 PJT_ATTR_SETDETACHSTATE, 117 PJT_ATTR_SETGUARDSIZE, 118 PJT_ATTR_SETINHERITSCHED, 119 PJT_ATTR_SETSCHEDPARAM, 120 PJT_ATTR_SETSCHEDPOLICY, 121 PJT_ATTR_SETSCOPE, 122 PJT_ATTR_SETSTACKADDR, 123 PJT_ATTR_SETSTACKSIZE, 124 PJT_CANCEL, 125 PJT_CLEANUP_POP, 126 PJT_CLEANUP_PUSH, 127 PJT_COND_BROADCAST, 128 PJT_COND_DESTROY, 129 PJT_COND_INIT, 130 PJT_COND_SIGNAL, 131 PJT_COND_TIMEDWAIT, 132 PJT_COND_WAIT, 133 PJT_DETACH, 134 PJT_EQUAL, 135 PJT_EXIT, 136 PJT_GETSPECIFIC, 137 PJT_JOIN, 138 PJT_KEY_CREATE, 139 PJT_KEY_DELETE, 140 PJT_KILL, 141 PJT_MAIN_NP, 142 PJT_MUTEXATTR_DESTROY, 143 PJT_MUTEXATTR_INIT, 144 PJT_MUTEXATTR_SETTYPE, 145 PJT_MUTEX_DESTROY, 146 PJT_MUTEX_INIT, 147 PJT_MUTEX_LOCK, 148 PJT_MUTEX_TRYLOCK, 149 PJT_MUTEX_UNLOCK, 150 PJT_ONCE, 151 PJT_RWLOCK_DESTROY, 152 PJT_RWLOCK_INIT, 153 PJT_RWLOCK_RDLOCK, 154 PJT_RWLOCK_TRYRDLOCK, 155 PJT_RWLOCK_TRYWRLOCK, 156 PJT_RWLOCK_UNLOCK, 157 PJT_RWLOCK_WRLOCK, 158 PJT_SELF, 159 PJT_SETCANCELSTATE, 160 PJT_SETCANCELTYPE, 161 PJT_SETSPECIFIC, 162 PJT_SIGMASK, 163 PJT_TESTCANCEL, 164 PJT_CLEANUP_POP_IMP, 165 PJT_CLEANUP_PUSH_IMP, 166 PJT_CANCEL_ENTER, 167 PJT_CANCEL_LEAVE, 168 PJT_MAX 169 } pjt_index_t; 170 171 typedef int (*pthread_func_t)(void); 172 typedef pthread_func_t pthread_func_entry_t[2]; 173 174 extern pthread_func_entry_t __thr_jtable[]; 175 176 /* 177 * yplib internal interfaces 178 */ 179 #ifdef YP 180 int _yp_check(char **); 181 #endif 182 183 /* 184 * Initialise TLS for static programs 185 */ 186 void _init_tls(void); 187 188 /* 189 * Provides pthread_once()-like functionality for both single-threaded 190 * and multi-threaded applications. 191 */ 192 int _once(pthread_once_t *, void (*)(void)); 193 194 /* 195 * Set the TLS thread pointer 196 */ 197 void _set_tp(void *tp); 198 199 /* 200 * This is a pointer in the C run-time startup code. It is used 201 * by getprogname() and setprogname(). 202 */ 203 extern const char *__progname; 204 205 /* 206 * This function is used by the threading libraries to notify malloc that a 207 * thread is exiting. 208 */ 209 void _malloc_thread_cleanup(void); 210 211 /* 212 * These functions are used by the threading libraries in order to protect 213 * malloc across fork(). 214 */ 215 void _malloc_prefork(void); 216 void _malloc_postfork(void); 217 218 /* 219 * Function to clean up streams, called from abort() and exit(). 220 */ 221 extern void (*__cleanup)(void) __hidden; 222 223 /* 224 * Get kern.osreldate to detect ABI revisions. Explicitly 225 * ignores value of $OSVERSION and caches result. Prototypes 226 * for the wrapped "new" pad-less syscalls are here for now. 227 */ 228 extern int __getosreldate(void); 229 #include <sys/_types.h> 230 /* Without pad */ 231 extern __off_t __sys_lseek(int, __off_t, int); 232 extern int __sys_ftruncate(int, __off_t); 233 extern int __sys_truncate(const char *, __off_t); 234 extern __ssize_t __sys_pread(int, void *, __size_t, __off_t); 235 extern __ssize_t __sys_pwrite(int, const void *, __size_t, __off_t); 236 extern void * __sys_mmap(void *, __size_t, int, int, int, __off_t); 237 238 /* With pad */ 239 extern __off_t __sys_freebsd6_lseek(int, int, __off_t, int); 240 extern int __sys_freebsd6_ftruncate(int, int, __off_t); 241 extern int __sys_freebsd6_truncate(const char *, int, __off_t); 242 extern __ssize_t __sys_freebsd6_pread(int, void *, __size_t, int, __off_t); 243 extern __ssize_t __sys_freebsd6_pwrite(int, const void *, __size_t, int, __off_t); 244 extern void * __sys_freebsd6_mmap(void *, __size_t, int, int, int, int, __off_t); 245 246 /* Without back-compat translation */ 247 extern int __sys_fcntl(int, int, ...); 248 249 struct timespec; 250 struct timeval; 251 struct timezone; 252 int __sys_gettimeofday(struct timeval *, struct timezone *); 253 int __sys_clock_gettime(__clockid_t, struct timespec *ts); 254 255 /* execve() with PATH processing to implement posix_spawnp() */ 256 int _execvpe(const char *, char * const *, char * const *); 257 258 int _elf_aux_info(int aux, void *buf, int buflen); 259 struct dl_phdr_info; 260 int __elf_phdr_match_addr(struct dl_phdr_info *, void *); 261 void __init_elf_aux_vector(void); 262 263 void _pthread_cancel_enter(int); 264 void _pthread_cancel_leave(int); 265 266 #endif /* _LIBC_PRIVATE_H_ */ 267