c3459e2a5730109a532ede02c7772b36c3dc786c
[dragonfly.git] / 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  * This global flag is non-zero when a process has created one
43  * or more threads. It is used to avoid calling locking functions
44  * when they are not required.
45  */
46 #ifndef __LIBC_ISTHREADED_DECLARED
47 #define __LIBC_ISTHREADED_DECLARED
48 extern int      __isthreaded;
49 #endif
50
51 /*
52  * File lock contention is difficult to diagnose without knowing
53  * where locks were set. Allow a debug library to be built which
54  * records the source file and line number of each lock call.
55  */
56 #ifdef  _FLOCK_DEBUG
57 #define _FLOCKFILE(x)   _flockfile_debug(x, __FILE__, __LINE__)
58 #else
59 #define _FLOCKFILE(x)   _flockfile(x)
60 #endif
61
62 /*
63  * Macros for locking and unlocking FILEs. These test if the
64  * process is threaded to avoid locking when not required.
65  */
66 #define FLOCKFILE(fp)           if (__isthreaded) _FLOCKFILE(fp)
67 #define FUNLOCKFILE(fp)         if (__isthreaded) _funlockfile(fp)
68
69 /*
70  * Initialise TLS static programs
71  */
72 int __get_errno_GS_offset(void);
73 void *__get_errno_GOT_ptr(void);
74
75 struct statfs;
76 struct statvfs;
77
78 /*
79  * yplib internal interfaces
80  */
81 #ifdef YP
82 int _yp_check(char **);
83 #endif
84
85 /*
86  * This is a pointer in the C run-time startup code. It is used
87  * by getprogname() and setprogname().
88  */
89 extern const char *__progname;
90
91 /*
92  * Notify libc that thread is exiting and its TLS destructors can be called.
93  */
94 void _thread_finalize(void);
95
96 /*
97  * Function to clean up streams, called from abort() and exit().
98  */
99 extern void (*__cleanup)(void);
100
101 /* execve() with PATH processing to implement posix_spawnp() */
102 int _execvpe(const char *, char * const *, char * const *);
103 void _nmalloc_thr_init(void);
104 void _nmalloc_thr_prepfork(void);
105 void _nmalloc_thr_parentfork(void);
106 void _nmalloc_thr_childfork(void);
107
108 struct dl_phdr_info;
109 int __elf_phdr_match_addr(struct dl_phdr_info *, void *);
110 void __libc_distribute_static_tls(__size_t, void *, __size_t, __size_t);
111 __uintptr_t __libc_static_tls_base(__size_t);
112
113 /*
114  * libc should use libc_dlopen internally, which respects a global
115  * flag where loading of new shared objects can be restricted.
116  */
117 void *libc_dlopen(const char *, int);
118
119 /*
120  * For dynamic linker
121  */
122 void _rtld_error(const char *fmt, ...);
123
124 /*
125  * Provides pthread_once()-like functionality for both single-threaded
126  * and multi-threaded applications
127  */
128 int _once(pthread_once_t *, void (*)(void));
129
130 void __throw_constraint_handler_s(const char * restrict msg, int error);
131
132 #endif /* _LIBC_PRIVATE_H_ */