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