lib/libc/include/libc_private.h

   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/_pthreadtypes.h>
  38
  39 /*
  40  * This global flag is non-zero when a process has created one
  41  * or more threads. It is used to avoid calling locking functions
  42  * when they are not required.
  43  */
  44 extern int      __isthreaded;
  45
  46 /*
  47  * Elf_Auxinfo *__elf_aux_vector, the pointer to the ELF aux vector
  48  * provided by kernel. Either set for us by rtld, or found at runtime
  49  * on stack for static binaries.
  50  *
  51  * Type is void to avoid polluting whole libc with ELF types.
  52  */
  53 extern void     *__elf_aux_vector;
  54
  55 /*
  56  * libc should use libc_dlopen internally, which respects a global
  57  * flag where loading of new shared objects can be restricted.
  58  */
  59 void *libc_dlopen(const char *, int);
  60
  61 /*
  62  * For dynamic linker.
  63  */
  64 void _rtld_error(const char *fmt, ...);
  65
  66 /*
  67  * File lock contention is difficult to diagnose without knowing
  68  * where locks were set. Allow a debug library to be built which
  69  * records the source file and line number of each lock call.
  70  */
  71 #ifdef  _FLOCK_DEBUG
  72 #define _FLOCKFILE(x)   _flockfile_debug(x, __FILE__, __LINE__)
  73 #else
  74 #define _FLOCKFILE(x)   _flockfile(x)
  75 #endif
  76
  77 /*
  78  * Macros for locking and unlocking FILEs. These test if the
  79  * process is threaded to avoid locking when not required.
  80  */
  81 #define FLOCKFILE(fp)           if (__isthreaded) _FLOCKFILE(fp)
  82 #define FUNLOCKFILE(fp)         if (__isthreaded) _funlockfile(fp)
  83
  84 struct _spinlock;
  85 extern struct _spinlock __stdio_thread_lock;
  86 #define STDIO_THREAD_LOCK()                             \
  87 do {                                                    \
  88         if (__isthreaded)                               \
  89                 _SPINLOCK(&__stdio_thread_lock);        \
  90 } while (0)
  91 #define STDIO_THREAD_UNLOCK()                           \
  92 do {                                                    \
  93         if (__isthreaded)                               \
  94                 _SPINUNLOCK(&__stdio_thread_lock);      \
  95 } while (0)
  96
  97 /*
  98  * Indexes into the pthread jump table.
  99  *
 100  * Warning! If you change this type, you must also change the threads
 101  * libraries that reference it (libc_r, libpthread).
 102  */
 103 typedef enum {
 104         PJT_ATFORK,
 105         PJT_ATTR_DESTROY,
 106         PJT_ATTR_GETDETACHSTATE,
 107         PJT_ATTR_GETGUARDSIZE,
 108         PJT_ATTR_GETINHERITSCHED,
 109         PJT_ATTR_GETSCHEDPARAM,
 110         PJT_ATTR_GETSCHEDPOLICY,
 111         PJT_ATTR_GETSCOPE,
 112         PJT_ATTR_GETSTACKADDR,
 113         PJT_ATTR_GETSTACKSIZE,
 114         PJT_ATTR_INIT,
 115         PJT_ATTR_SETDETACHSTATE,
 116         PJT_ATTR_SETGUARDSIZE,
 117         PJT_ATTR_SETINHERITSCHED,
 118         PJT_ATTR_SETSCHEDPARAM,
 119         PJT_ATTR_SETSCHEDPOLICY,
 120         PJT_ATTR_SETSCOPE,
 121         PJT_ATTR_SETSTACKADDR,
 122         PJT_ATTR_SETSTACKSIZE,
 123         PJT_CANCEL,
 124         PJT_CLEANUP_POP,
 125         PJT_CLEANUP_PUSH,
 126         PJT_COND_BROADCAST,
 127         PJT_COND_DESTROY,
 128         PJT_COND_INIT,
 129         PJT_COND_SIGNAL,
 130         PJT_COND_TIMEDWAIT,
 131         PJT_COND_WAIT,
 132         PJT_DETACH,
 133         PJT_EQUAL,
 134         PJT_EXIT,
 135         PJT_GETSPECIFIC,
 136         PJT_JOIN,
 137         PJT_KEY_CREATE,
 138         PJT_KEY_DELETE,
 139         PJT_KILL,
 140         PJT_MAIN_NP,
 141         PJT_MUTEXATTR_DESTROY,
 142         PJT_MUTEXATTR_INIT,
 143         PJT_MUTEXATTR_SETTYPE,
 144         PJT_MUTEX_DESTROY,
 145         PJT_MUTEX_INIT,
 146         PJT_MUTEX_LOCK,
 147         PJT_MUTEX_TRYLOCK,
 148         PJT_MUTEX_UNLOCK,
 149         PJT_ONCE,
 150         PJT_RWLOCK_DESTROY,
 151         PJT_RWLOCK_INIT,
 152         PJT_RWLOCK_RDLOCK,
 153         PJT_RWLOCK_TRYRDLOCK,
 154         PJT_RWLOCK_TRYWRLOCK,
 155         PJT_RWLOCK_UNLOCK,
 156         PJT_RWLOCK_WRLOCK,
 157         PJT_SELF,
 158         PJT_SETCANCELSTATE,
 159         PJT_SETCANCELTYPE,
 160         PJT_SETSPECIFIC,
 161         PJT_SIGMASK,
 162         PJT_TESTCANCEL,
 163         PJT_CLEANUP_POP_IMP,
 164         PJT_CLEANUP_PUSH_IMP,
 165         PJT_CANCEL_ENTER,
 166         PJT_CANCEL_LEAVE,
 167         PJT_MAX
 168 } pjt_index_t;
 169
 170 typedef int (*pthread_func_t)(void);
 171 typedef pthread_func_t pthread_func_entry_t[2];
 172
 173 extern pthread_func_entry_t __thr_jtable[];
 174
 175 /*
 176  * yplib internal interfaces
 177  */
 178 #ifdef YP
 179 int _yp_check(char **);
 180 #endif
 181
 182 /*
 183  * Initialise TLS for static programs
 184  */
 185 void _init_tls(void);
 186
 187 /*
 188  * Provides pthread_once()-like functionality for both single-threaded
 189  * and multi-threaded applications.
 190  */
 191 int _once(pthread_once_t *, void (*)(void));
 192
 193 /*
 194  * Set the TLS thread pointer
 195  */
 196 void _set_tp(void *tp);
 197
 198 /*
 199  * This is a pointer in the C run-time startup code. It is used
 200  * by getprogname() and setprogname().
 201  */
 202 extern const char *__progname;
 203
 204 /*
 205  * This function is used by the threading libraries to notify malloc that a
 206  * thread is exiting.
 207  */
 208 void _malloc_thread_cleanup(void);
 209
 210 /*
 211  * These functions are used by the threading libraries in order to protect
 212  * malloc across fork().
 213  */
 214 void _malloc_prefork(void);
 215 void _malloc_postfork(void);
 216
 217 /*
 218  * Function to clean up streams, called from abort() and exit().
 219  */
 220 extern void (*__cleanup)(void);
 221
 222 /*
 223  * Get kern.osreldate to detect ABI revisions.  Explicitly
 224  * ignores value of $OSVERSION and caches result.  Prototypes
 225  * for the wrapped "new" pad-less syscalls are here for now.
 226  */
 227 extern int __getosreldate(void);
 228 #include <sys/_types.h>
 229 /* Without pad */
 230 extern __off_t  __sys_lseek(int, __off_t, int);
 231 extern int      __sys_ftruncate(int, __off_t);
 232 extern int      __sys_truncate(const char *, __off_t);
 233 extern __ssize_t __sys_pread(int, void *, __size_t, __off_t);
 234 extern __ssize_t __sys_pwrite(int, const void *, __size_t, __off_t);
 235 extern void *   __sys_mmap(void *, __size_t, int, int, int, __off_t);
 236
 237 /* With pad */
 238 extern __off_t  __sys_freebsd6_lseek(int, int, __off_t, int);
 239 extern int      __sys_freebsd6_ftruncate(int, int, __off_t);
 240 extern int      __sys_freebsd6_truncate(const char *, int, __off_t);
 241 extern __ssize_t __sys_freebsd6_pread(int, void *, __size_t, int, __off_t);
 242 extern __ssize_t __sys_freebsd6_pwrite(int, const void *, __size_t, int, __off_t);
 243 extern void *   __sys_freebsd6_mmap(void *, __size_t, int, int, int, int, __off_t);
 244
 245 /* Without back-compat translation */
 246 extern int      __sys_fcntl(int, int, ...);
 247
 248 /* execve() with PATH processing to implement posix_spawnp() */
 249 int _execvpe(const char *, char * const *, char * const *);
 250
 251 int _elf_aux_info(int aux, void *buf, int buflen);
 252 struct dl_phdr_info;
 253 int __elf_phdr_match_addr(struct dl_phdr_info *, void *);
 254 void __init_elf_aux_vector(void);
 255
 256 void    _pthread_cancel_enter(int);
 257 void    _pthread_cancel_leave(int);
 258
 259 #endif /* _LIBC_PRIVATE_H_ */