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