xref: /freebsd/lib/libc/gen/_pthread_stubs.c (revision 86c9d9918f1db7cdd968b60f8902466887bcd9e9)
1 /*
2  * Copyright (c) 2001 Daniel Eischen <deischen@FreeBSD.org>.
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  *
14  * THIS SOFTWARE IS PROVIDED BY DANIEL EISCHEN AND CONTRIBUTORS ``AS IS''
15  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  */
26 
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
29 
30 #include <signal.h>
31 #include <pthread.h>
32 #include <stdlib.h>
33 #include <errno.h>
34 
35 #include "libc_private.h"
36 
37 /*
38  * Weak symbols: All libc internal usage of these functions should
39  * use the weak symbol versions (_pthread_XXX).  If libpthread is
40  * linked, it will override these functions with (non-weak) routines.
41  * The _pthread_XXX functions are provided solely for internal libc
42  * usage to avoid unwanted cancellation points and to differentiate
43  * between application locks and libc locks (threads holding the
44  * latter can't be allowed to exit/terminate).
45  */
46 
47 /* Define a null pthread structure just to satisfy _pthread_self. */
48 struct pthread {
49 };
50 
51 static struct pthread	main_thread;
52 
53 static int		stub_main(void);
54 static void 		*stub_null(void);
55 static struct pthread	*stub_self(void);
56 static int		stub_zero(void);
57 static int		stub_fail(void);
58 static int		stub_true(void);
59 static void		stub_exit(void);
60 
61 #define	PJT_DUAL_ENTRY(entry)	\
62 	(pthread_func_t)entry, (pthread_func_t)entry
63 
64 pthread_func_entry_t __thr_jtable[PJT_MAX] = {
65 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_ATFORK */
66 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_ATTR_DESTROY */
67 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_ATTR_GETDETACHSTATE */
68 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_ATTR_GETGUARDSIZE */
69 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_ATTR_GETINHERITSCHED */
70 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_ATTR_GETSCHEDPARAM */
71 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_ATTR_GETSCHEDPOLICY */
72 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_ATTR_GETSCOPE */
73 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_ATTR_GETSTACKADDR */
74 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_ATTR_GETSTACKSIZE */
75 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_ATTR_INIT */
76 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_ATTR_SETDETACHSTATE */
77 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_ATTR_SETGUARDSIZE */
78 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_ATTR_SETINHERITSCHED */
79 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_ATTR_SETSCHEDPARAM */
80 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_ATTR_SETSCHEDPOLICY */
81 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_ATTR_SETSCOPE */
82 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_ATTR_SETSTACKADDR */
83 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_ATTR_SETSTACKSIZE */
84 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_CANCEL */
85 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_CLEANUP_POP */
86 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_CLEANUP_PUSH */
87 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_COND_BROADCAST */
88 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_COND_DESTROY */
89 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_COND_INIT */
90 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_COND_SIGNAL */
91 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_COND_TIMEDWAIT */
92 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_COND_WAIT */
93 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_DETACH */
94 	{PJT_DUAL_ENTRY(stub_true)},    /* PJT_EQUAL */
95 	{PJT_DUAL_ENTRY(stub_exit)},    /* PJT_EXIT */
96 	{PJT_DUAL_ENTRY(stub_null)},    /* PJT_GETSPECIFIC */
97 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_JOIN */
98 	{PJT_DUAL_ENTRY(stub_fail)},    /* PJT_KEY_CREATE */
99 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_KEY_DELETE */
100 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_KILL */
101 	{PJT_DUAL_ENTRY(stub_main)},    /* PJT_MAIN_NP */
102 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_MUTEXATTR_DESTROY */
103 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_MUTEXATTR_INIT */
104 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_MUTEXATTR_SETTYPE */
105 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_MUTEX_DESTROY */
106 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_MUTEX_INIT */
107 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_MUTEX_LOCK */
108 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_MUTEX_TRYLOCK */
109 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_MUTEX_UNLOCK */
110 	{PJT_DUAL_ENTRY(stub_fail)},    /* PJT_ONCE */
111 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_RWLOCK_DESTROY */
112 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_RWLOCK_INIT */
113 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_RWLOCK_RDLOCK */
114 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_RWLOCK_TRYRDLOCK */
115 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_RWLOCK_TRYWRLOCK */
116 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_RWLOCK_UNLOCK */
117 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_RWLOCK_WRLOCK */
118 	{PJT_DUAL_ENTRY(stub_self)},    /* PJT_SELF */
119 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_SETCANCELSTATE */
120 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_SETCANCELTYPE */
121 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_SETSPECIFIC */
122 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_SIGMASK */
123 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_TESTCANCEL */
124 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_CLEANUP_POP_IMP */
125 	{PJT_DUAL_ENTRY(stub_zero)},    /* PJT_CLEANUP_PUSH_IMP */
126 	{PJT_DUAL_ENTRY(stub_zero)},	/* PJT_CANCEL_ENTER */
127 	{PJT_DUAL_ENTRY(stub_zero)},	/* PJT_CANCEL_LEAVE */
128 	{PJT_DUAL_ENTRY(stub_zero)},	/* PJT_MUTEX_CONSISTENT */
129 	{PJT_DUAL_ENTRY(stub_zero)},	/* PJT_MUTEXATTR_GETROBUST */
130 	{PJT_DUAL_ENTRY(stub_zero)},	/* PJT_MUTEXATTR_SETROBUST */
131 };
132 
133 /*
134  * Weak aliases for exported (pthread_*) and internal (_pthread_*) routines.
135  */
136 #define	WEAK_REF(sym, alias)	__weak_reference(sym, alias)
137 
138 #define	FUNC_TYPE(name)		__CONCAT(name, _func_t)
139 #define	FUNC_INT(name)		__CONCAT(name, _int)
140 #define	FUNC_EXP(name)		__CONCAT(name, _exp)
141 
142 #define	STUB_FUNC(name, idx, ret)				\
143 	static ret FUNC_EXP(name)(void) __used;			\
144 	static ret FUNC_INT(name)(void) __used;			\
145 	WEAK_REF(FUNC_EXP(name), name);				\
146 	WEAK_REF(FUNC_INT(name), __CONCAT(_, name));		\
147 	typedef ret (*FUNC_TYPE(name))(void);			\
148 	static ret FUNC_EXP(name)(void)				\
149 	{							\
150 		FUNC_TYPE(name) func;				\
151 		func = (FUNC_TYPE(name))__thr_jtable[idx][0];	\
152 		return (func());				\
153 	}							\
154 	static ret FUNC_INT(name)(void)				\
155 	{							\
156 		FUNC_TYPE(name) func;				\
157 		func = (FUNC_TYPE(name))__thr_jtable[idx][1];	\
158 		return (func());				\
159 	}
160 
161 #define	STUB_FUNC1(name, idx, ret, p0_type)			\
162 	static ret FUNC_EXP(name)(p0_type) __used;		\
163 	static ret FUNC_INT(name)(p0_type) __used;		\
164 	WEAK_REF(FUNC_EXP(name), name);				\
165 	WEAK_REF(FUNC_INT(name), __CONCAT(_, name));		\
166 	typedef ret (*FUNC_TYPE(name))(p0_type);		\
167 	static ret FUNC_EXP(name)(p0_type p0)			\
168 	{							\
169 		FUNC_TYPE(name) func;				\
170 		func = (FUNC_TYPE(name))__thr_jtable[idx][0];	\
171 		return (func(p0));				\
172 	}							\
173 	static ret FUNC_INT(name)(p0_type p0)			\
174 	{							\
175 		FUNC_TYPE(name) func;				\
176 		func = (FUNC_TYPE(name))__thr_jtable[idx][1];	\
177 		return (func(p0));				\
178 	}
179 
180 #define	STUB_FUNC2(name, idx, ret, p0_type, p1_type)		\
181 	static ret FUNC_EXP(name)(p0_type, p1_type) __used;	\
182 	static ret FUNC_INT(name)(p0_type, p1_type) __used;	\
183 	WEAK_REF(FUNC_EXP(name), name);				\
184 	WEAK_REF(FUNC_INT(name), __CONCAT(_, name));		\
185 	typedef ret (*FUNC_TYPE(name))(p0_type, p1_type);	\
186 	static ret FUNC_EXP(name)(p0_type p0, p1_type p1)	\
187 	{							\
188 		FUNC_TYPE(name) func;				\
189 		func = (FUNC_TYPE(name))__thr_jtable[idx][0];	\
190 		return (func(p0, p1));				\
191 	}							\
192 	static ret FUNC_INT(name)(p0_type p0, p1_type p1)	\
193 	{							\
194 		FUNC_TYPE(name) func;				\
195 		func = (FUNC_TYPE(name))__thr_jtable[idx][1];	\
196 		return (func(p0, p1));				\
197 	}
198 
199 #define	STUB_FUNC3(name, idx, ret, p0_type, p1_type, p2_type)	\
200 	static ret FUNC_EXP(name)(p0_type, p1_type, p2_type) __used; \
201 	static ret FUNC_INT(name)(p0_type, p1_type, p2_type) __used; \
202 	WEAK_REF(FUNC_EXP(name), name);				\
203 	WEAK_REF(FUNC_INT(name), __CONCAT(_, name));		\
204 	typedef ret (*FUNC_TYPE(name))(p0_type, p1_type, p2_type); \
205 	static ret FUNC_EXP(name)(p0_type p0, p1_type p1, p2_type p2) \
206 	{							\
207 		FUNC_TYPE(name) func;				\
208 		func = (FUNC_TYPE(name))__thr_jtable[idx][0];	\
209 		return (func(p0, p1, p2));			\
210 	}							\
211 	static ret FUNC_INT(name)(p0_type p0, p1_type p1, p2_type p2) \
212 	{							\
213 		FUNC_TYPE(name) func;				\
214 		func = (FUNC_TYPE(name))__thr_jtable[idx][1];	\
215 		return (func(p0, p1, p2));			\
216 	}
217 
218 STUB_FUNC1(pthread_cond_broadcast, PJT_COND_BROADCAST, int, void *)
219 STUB_FUNC1(pthread_cond_destroy, PJT_COND_DESTROY, int, void *)
220 STUB_FUNC2(pthread_cond_init,	PJT_COND_INIT, int, void *, void *)
221 STUB_FUNC1(pthread_cond_signal,	PJT_COND_SIGNAL, int, void *)
222 STUB_FUNC2(pthread_cond_wait,	PJT_COND_WAIT, int, void *, void *)
223 STUB_FUNC1(pthread_getspecific,	PJT_GETSPECIFIC, void *, pthread_key_t)
224 STUB_FUNC2(pthread_key_create,	PJT_KEY_CREATE, int, void *, void *)
225 STUB_FUNC1(pthread_key_delete,	PJT_KEY_DELETE, int, pthread_key_t)
226 STUB_FUNC(pthread_main_np,	PJT_MAIN_NP, int)
227 STUB_FUNC1(pthread_mutex_destroy, PJT_MUTEX_DESTROY, int, void *)
228 STUB_FUNC2(pthread_mutex_init,	PJT_MUTEX_INIT, int, void *, void *)
229 STUB_FUNC1(pthread_mutex_lock,	PJT_MUTEX_LOCK, int, void *)
230 STUB_FUNC1(pthread_mutex_trylock, PJT_MUTEX_TRYLOCK, int, void *)
231 STUB_FUNC1(pthread_mutex_unlock, PJT_MUTEX_UNLOCK, int, void *)
232 STUB_FUNC1(pthread_mutex_consistent, PJT_MUTEX_CONSISTENT, int, void *)
233 STUB_FUNC1(pthread_mutexattr_destroy, PJT_MUTEXATTR_DESTROY, int, void *)
234 STUB_FUNC1(pthread_mutexattr_init, PJT_MUTEXATTR_INIT, int, void *)
235 STUB_FUNC2(pthread_mutexattr_settype, PJT_MUTEXATTR_SETTYPE, int, void *, int)
236 STUB_FUNC2(pthread_mutexattr_getrobust, PJT_MUTEXATTR_GETROBUST, int, void *,
237     int *)
238 STUB_FUNC2(pthread_mutexattr_setrobust, PJT_MUTEXATTR_SETROBUST, int, void *,
239     int)
240 STUB_FUNC2(pthread_once, 	PJT_ONCE, int, void *, void *)
241 STUB_FUNC1(pthread_rwlock_destroy, PJT_RWLOCK_DESTROY, int, void *)
242 STUB_FUNC2(pthread_rwlock_init,	PJT_RWLOCK_INIT, int, void *, void *)
243 STUB_FUNC1(pthread_rwlock_rdlock, PJT_RWLOCK_RDLOCK, int, void *)
244 STUB_FUNC1(pthread_rwlock_tryrdlock, PJT_RWLOCK_TRYRDLOCK, int, void *)
245 STUB_FUNC1(pthread_rwlock_trywrlock, PJT_RWLOCK_TRYWRLOCK, int, void *)
246 STUB_FUNC1(pthread_rwlock_unlock, PJT_RWLOCK_UNLOCK, int, void *)
247 STUB_FUNC1(pthread_rwlock_wrlock, PJT_RWLOCK_WRLOCK, int, void *)
248 STUB_FUNC(pthread_self,		PJT_SELF, pthread_t)
249 STUB_FUNC2(pthread_setspecific, PJT_SETSPECIFIC, int, pthread_key_t, void *)
250 STUB_FUNC3(pthread_sigmask, PJT_SIGMASK, int, int, void *, void *)
251 STUB_FUNC3(pthread_atfork, PJT_ATFORK, int, void *, void *, void*)
252 STUB_FUNC1(pthread_attr_destroy, PJT_ATTR_DESTROY, int, void *);
253 STUB_FUNC2(pthread_attr_getdetachstate, PJT_ATTR_GETDETACHSTATE, int, void *, void *)
254 STUB_FUNC2(pthread_attr_getguardsize, PJT_ATTR_GETGUARDSIZE, int, void *, void *)
255 STUB_FUNC2(pthread_attr_getstackaddr, PJT_ATTR_GETSTACKADDR, int, void *, void *)
256 STUB_FUNC2(pthread_attr_getstacksize, PJT_ATTR_GETSTACKSIZE, int, void *, void *)
257 STUB_FUNC2(pthread_attr_getinheritsched, PJT_ATTR_GETINHERITSCHED, int, void *, void *)
258 STUB_FUNC2(pthread_attr_getschedparam, PJT_ATTR_GETSCHEDPARAM, int, void *, void *)
259 STUB_FUNC2(pthread_attr_getschedpolicy, PJT_ATTR_GETSCHEDPOLICY, int, void *, void *)
260 STUB_FUNC2(pthread_attr_getscope, PJT_ATTR_GETSCOPE, int, void *, void *)
261 STUB_FUNC1(pthread_attr_init, PJT_ATTR_INIT, int, void *)
262 STUB_FUNC2(pthread_attr_setdetachstate, PJT_ATTR_SETDETACHSTATE, int, void *, int)
263 STUB_FUNC2(pthread_attr_setguardsize, PJT_ATTR_SETGUARDSIZE, int, void *, size_t)
264 STUB_FUNC2(pthread_attr_setstackaddr, PJT_ATTR_SETSTACKADDR, int, void *, void *)
265 STUB_FUNC2(pthread_attr_setstacksize, PJT_ATTR_SETSTACKSIZE, int, void *, size_t)
266 STUB_FUNC2(pthread_attr_setinheritsched, PJT_ATTR_SETINHERITSCHED, int, void *, int)
267 STUB_FUNC2(pthread_attr_setschedparam, PJT_ATTR_SETSCHEDPARAM, int, void *, void *)
268 STUB_FUNC2(pthread_attr_setschedpolicy, PJT_ATTR_SETSCHEDPOLICY, int, void *, int)
269 STUB_FUNC2(pthread_attr_setscope, PJT_ATTR_SETSCOPE, int, void *, int)
270 STUB_FUNC1(pthread_cancel, PJT_CANCEL, int, void *)
271 STUB_FUNC1(pthread_cleanup_pop, PJT_CLEANUP_POP, int, int)
272 STUB_FUNC2(pthread_cleanup_push, PJT_CLEANUP_PUSH, void, void *, void *)
273 STUB_FUNC3(pthread_cond_timedwait, PJT_COND_TIMEDWAIT, int, void *, void *, void *)
274 STUB_FUNC1(pthread_detach, PJT_DETACH, int, void *)
275 STUB_FUNC2(pthread_equal, PJT_EQUAL, int, void *, void *)
276 STUB_FUNC1(pthread_exit, PJT_EXIT, void, void *)
277 STUB_FUNC2(pthread_join, PJT_JOIN, int, void *, void *)
278 STUB_FUNC2(pthread_kill, PJT_KILL, int, void *, int)
279 STUB_FUNC2(pthread_setcancelstate, PJT_SETCANCELSTATE, int, int, void *)
280 STUB_FUNC2(pthread_setcanceltype, PJT_SETCANCELTYPE, int, int, void *)
281 STUB_FUNC(pthread_testcancel, PJT_TESTCANCEL, void)
282 STUB_FUNC1(__pthread_cleanup_pop_imp, PJT_CLEANUP_POP_IMP, int, int)
283 STUB_FUNC2(__pthread_cleanup_push_imp, PJT_CLEANUP_PUSH_IMP, void, void*, void *);
284 STUB_FUNC1(_pthread_cancel_enter, PJT_CANCEL_ENTER, int, int)
285 STUB_FUNC1(_pthread_cancel_leave, PJT_CANCEL_LEAVE, int, int)
286 
287 static int
288 stub_zero(void)
289 {
290 	return (0);
291 }
292 
293 static void *
294 stub_null(void)
295 {
296 	return (NULL);
297 }
298 
299 static struct pthread *
300 stub_self(void)
301 {
302 	return (&main_thread);
303 }
304 
305 static int
306 stub_fail(void)
307 {
308 	return (ENOSYS);
309 }
310 
311 static int
312 stub_main(void)
313 {
314 	return (-1);
315 }
316 
317 static int
318 stub_true(void)
319 {
320 	return (1);
321 }
322 
323 static void
324 stub_exit(void)
325 {
326 	exit(0);
327 }
328