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: head/lib/libc/include/libc_private.h 213153 2010-09-25 01:57:47Z davidxu $
  30  *
  31  * Private definitions for libc, libc_r and libpthread.
  32  *
  33  */
  34
  35 #ifndef _LIBC_PRIVATE_H_
  36 #define _LIBC_PRIVATE_H_
  37
  38 #include <machine/types.h>
  39 #include <sys/_pthreadtypes.h>
  40
  41 /*
  42  * With this attribute set, do not require a function call for accessing
  43  * this variable when the code is compiled -fPIC.  Use in combination
  44  * with __thread.
  45  *
  46  * Must be empty for libc_rtld.
  47  */
  48 #ifdef __LIBC_RTLD
  49 #define TLS_ATTRIBUTE
  50 #else
  51 #define TLS_ATTRIBUTE __attribute__ ((tls_model ("initial-exec")))
  52 #endif
  53
  54 /*
  55  * This global flag is non-zero when a process has created one
  56  * or more threads. It is used to avoid calling locking functions
  57  * when they are not required.
  58  */
  59 #ifndef __LIBC_ISTHREADED_DECLARED
  60 #define __LIBC_ISTHREADED_DECLARED
  61 extern int      __isthreaded;
  62 #endif
  63
  64 /*
  65  * File lock contention is difficult to diagnose without knowing
  66  * where locks were set. Allow a debug library to be built which
  67  * records the source file and line number of each lock call.
  68  */
  69 #ifdef  _FLOCK_DEBUG
  70 #define _FLOCKFILE(x)   _flockfile_debug(x, __FILE__, __LINE__)
  71 #else
  72 #define _FLOCKFILE(x)   _flockfile(x)
  73 #endif
  74
  75 /*
  76  * Macros for locking and unlocking FILEs. These test if the
  77  * process is threaded to avoid locking when not required.
  78  */
  79 #define FLOCKFILE(fp)           if (__isthreaded) _FLOCKFILE(fp)
  80 #define FUNLOCKFILE(fp)         if (__isthreaded) _funlockfile(fp)
  81
  82 /*
  83  * Initialise TLS static programs
  84  */
  85 int __get_errno_GS_offset(void);
  86 void *__get_errno_GOT_ptr(void);
  87
  88 struct statfs;
  89 struct statvfs;
  90
  91 /*
  92  * yplib internal interfaces
  93  */
  94 #ifdef YP
  95 int _yp_check(char **);
  96 #endif
  97
  98 /*
  99  * This is a pointer in the C run-time startup code. It is used
 100  * by getprogname() and setprogname().
 101  */
 102 extern const char *__progname;
 103
 104 /*
 105  * Notify libc that thread is exiting and its TLS destructors can be called.
 106  */
 107 void _thread_finalize(void);
 108
 109 /*
 110  * Function to clean up streams, called from abort() and exit().
 111  */
 112 extern void (*__cleanup)(void);
 113
 114 /* execve() with PATH processing to implement posix_spawnp() */
 115 int _execvpe(const char *, char * const *, char * const *);
 116 void _libc_thr_init(void);
 117 void _nmalloc_thr_init(void);
 118 void _upmap_thr_init(void);
 119 void _nmalloc_thr_prepfork(void);
 120 void _nmalloc_thr_parentfork(void);
 121 void _nmalloc_thr_childfork(void);
 122
 123 struct dl_phdr_info;
 124 int __elf_phdr_match_addr(struct dl_phdr_info *, void *);
 125 void __libc_distribute_static_tls(__size_t, void *, __size_t, __size_t);
 126 __uintptr_t __libc_static_tls_base(__size_t);
 127
 128 /*
 129  * libc should use libc_dlopen internally, which respects a global
 130  * flag where loading of new shared objects can be restricted.
 131  */
 132 void *libc_dlopen(const char *, int);
 133
 134 /*
 135  * For dynamic linker
 136  */
 137 void _rtld_error(const char *fmt, ...);
 138
 139 /*
 140  * Provides pthread_once()-like functionality for both single-threaded
 141  * and multi-threaded applications
 142  */
 143 int _once(pthread_once_t *, void (*)(void));
 144
 145 void __throw_constraint_handler_s(const char * restrict msg, int error);
 146
 147 #endif /* _LIBC_PRIVATE_H_ */