1 /*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (C) 2005 Daniel M. Eischen <deischen@freebsd.org>
5 * Copyright (c) 2005 David Xu <davidxu@freebsd.org>
6 * Copyright (c) 1995-1998 John Birrell <jb@cimlogic.com.au>.
7 *
8 * All rights reserved.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice unmodified, this list of conditions, and the following
15 * disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
21 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
24 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 */
31
32 #ifndef _THR_PRIVATE_H
33 #define _THR_PRIVATE_H
34
35 /*
36 * Include files.
37 */
38 #include <sys/types.h>
39 #include <sys/time.h>
40 #include <sys/queue.h>
41 #include <sys/param.h>
42 #include <sys/cpuset.h>
43 #include <sys/exterrvar.h>
44 #include <machine/atomic.h>
45 #include <errno.h>
46 #include <limits.h>
47 #include <signal.h>
48 #include <stdbool.h>
49 #include <stddef.h>
50 #include <stdio.h>
51 #include <unistd.h>
52 #include <ucontext.h>
53 #include <sys/thr.h>
54 #include <pthread.h>
55
56 __NULLABILITY_PRAGMA_PUSH
57
58 #define SYM_FB10(sym) __CONCAT(sym, _fb10)
59 #define SYM_FBP10(sym) __CONCAT(sym, _fbp10)
60 #define WEAK_REF(sym, alias) __weak_reference(sym, alias)
61 #define SYM_COMPAT(sym, impl, ver) __sym_compat(sym, impl, ver)
62 #define SYM_DEFAULT(sym, impl, ver) __sym_default(sym, impl, ver)
63
64 #define FB10_COMPAT(func, sym) \
65 WEAK_REF(func, SYM_FB10(sym)); \
66 SYM_COMPAT(sym, SYM_FB10(sym), FBSD_1.0)
67
68 #define FB10_COMPAT_PRIVATE(func, sym) \
69 WEAK_REF(func, SYM_FBP10(sym)); \
70 SYM_DEFAULT(sym, SYM_FBP10(sym), FBSDprivate_1.0)
71
72 struct pthread;
73 extern struct pthread *_thr_initial __hidden;
74
75 #include "pthread_md.h"
76 #include "thr_umtx.h"
77 #include "thread_db.h"
78
79 #ifdef _PTHREAD_FORCED_UNWIND
80 #define _BSD_SOURCE
81 #include <unwind.h>
82 #endif
83
84 typedef TAILQ_HEAD(pthreadlist, pthread) pthreadlist;
85 typedef TAILQ_HEAD(atfork_head, pthread_atfork) atfork_head;
86 TAILQ_HEAD(mutex_queue, pthread_mutex);
87
88 /* Signal to do cancellation */
89 #define SIGCANCEL SIGTHR
90
91 /*
92 * Kernel fatal error handler macro.
93 */
94 #define PANIC(args...) _thread_exitf(__FILE__, __LINE__, ##args)
95
96 /* Output debug messages like this: */
97 #define stdout_debug(args...) _thread_printf(STDOUT_FILENO, ##args)
98 #define stderr_debug(args...) _thread_printf(STDERR_FILENO, ##args)
99
100 #ifdef _PTHREADS_INVARIANTS
101 #define THR_ASSERT(cond, msg) do { \
102 if (__predict_false(!(cond))) \
103 PANIC(msg); \
104 } while (0)
105 #else
106 #define THR_ASSERT(cond, msg)
107 #endif
108
109 #ifdef PIC
110 # define STATIC_LIB_REQUIRE(name)
111 #else
112 # define STATIC_LIB_REQUIRE(name) __asm (".globl " #name)
113 #endif
114
115 #define TIMESPEC_ADD(dst, src, val) \
116 do { \
117 (dst)->tv_sec = (src)->tv_sec + (val)->tv_sec; \
118 (dst)->tv_nsec = (src)->tv_nsec + (val)->tv_nsec; \
119 if ((dst)->tv_nsec >= 1000000000) { \
120 (dst)->tv_sec++; \
121 (dst)->tv_nsec -= 1000000000; \
122 } \
123 } while (0)
124
125 #define TIMESPEC_SUB(dst, src, val) \
126 do { \
127 (dst)->tv_sec = (src)->tv_sec - (val)->tv_sec; \
128 (dst)->tv_nsec = (src)->tv_nsec - (val)->tv_nsec; \
129 if ((dst)->tv_nsec < 0) { \
130 (dst)->tv_sec--; \
131 (dst)->tv_nsec += 1000000000; \
132 } \
133 } while (0)
134
135 /* Magic cookie set for shared pthread locks and cv's pointers */
136 #define THR_PSHARED_PTR \
137 ((void *)(uintptr_t)((1ULL << (NBBY * sizeof(long) - 1)) | 1))
138
139 /* XXX These values should be same as those defined in pthread.h */
140 #define THR_MUTEX_INITIALIZER ((struct pthread_mutex *)NULL)
141 #define THR_ADAPTIVE_MUTEX_INITIALIZER ((struct pthread_mutex *)1)
142 #define THR_MUTEX_DESTROYED ((struct pthread_mutex *)2)
143 #define THR_COND_INITIALIZER ((struct pthread_cond *)NULL)
144 #define THR_COND_DESTROYED ((struct pthread_cond *)1)
145 #define THR_RWLOCK_INITIALIZER ((struct pthread_rwlock *)NULL)
146 #define THR_RWLOCK_DESTROYED ((struct pthread_rwlock *)1)
147
148 #define PMUTEX_FLAG_TYPE_MASK 0x0ff
149 #define PMUTEX_FLAG_PRIVATE 0x100
150 #define PMUTEX_FLAG_DEFERRED 0x200
151 #define PMUTEX_TYPE(mtxflags) ((mtxflags) & PMUTEX_FLAG_TYPE_MASK)
152
153 #define PMUTEX_OWNER_ID(m) ((m)->m_lock.m_owner & ~UMUTEX_CONTESTED)
154
155 #define MAX_DEFER_WAITERS 50
156
157 /*
158 * Values for pthread_mutex m_ps indicator.
159 */
160 #define PMUTEX_INITSTAGE_ALLOC 0
161 #define PMUTEX_INITSTAGE_BUSY 1
162 #define PMUTEX_INITSTAGE_DONE 2
163
164 struct pthread_mutex {
165 /*
166 * Lock for accesses to this structure.
167 */
168 struct umutex m_lock;
169 int m_flags;
170 int m_count;
171 int m_spinloops;
172 int m_yieldloops;
173 int m_ps; /* pshared init stage */
174 /*
175 * Link for all mutexes a thread currently owns, of the same
176 * prio type.
177 */
178 TAILQ_ENTRY(pthread_mutex) m_qe;
179 /* Link for all private mutexes a thread currently owns. */
180 TAILQ_ENTRY(pthread_mutex) m_pqe;
181 struct pthread_mutex *m_rb_prev;
182 };
183
184 struct pthread_mutex_attr {
185 enum pthread_mutextype m_type;
186 int m_protocol;
187 int m_ceiling;
188 int m_pshared;
189 int m_robust;
190 };
191
192 #define PTHREAD_MUTEXATTR_STATIC_INITIALIZER \
193 { PTHREAD_MUTEX_DEFAULT, PTHREAD_PRIO_NONE, 0, MUTEX_FLAGS_PRIVATE, \
194 PTHREAD_MUTEX_STALLED }
195
196 struct pthread_cond {
197 __uint32_t __has_user_waiters;
198 struct ucond kcond;
199 };
200
201 struct pthread_cond_attr {
202 int c_pshared;
203 int c_clockid;
204 };
205
206 struct pthread_barrier {
207 struct umutex b_lock;
208 struct ucond b_cv;
209 int64_t b_cycle;
210 int b_count;
211 int b_waiters;
212 int b_refcount;
213 int b_destroying;
214 };
215
216 struct pthread_barrierattr {
217 int pshared;
218 };
219
220 struct pthread_spinlock {
221 struct umutex s_lock;
222 };
223
224 /*
225 * Flags for condition variables.
226 */
227 #define COND_FLAGS_PRIVATE 0x01
228 #define COND_FLAGS_INITED 0x02
229 #define COND_FLAGS_BUSY 0x04
230
231 /*
232 * Cleanup definitions.
233 */
234 struct pthread_cleanup {
235 struct pthread_cleanup *prev;
236 void (*routine)(void *);
237 void *routine_arg;
238 int onheap;
239 };
240
241 #define THR_CLEANUP_PUSH(td, func, arg) { \
242 struct pthread_cleanup __cup; \
243 \
244 __cup.routine = func; \
245 __cup.routine_arg = arg; \
246 __cup.onheap = 0; \
247 __cup.prev = (td)->cleanup; \
248 (td)->cleanup = &__cup;
249
250 #define THR_CLEANUP_POP(td, exec) \
251 (td)->cleanup = __cup.prev; \
252 if ((exec) != 0) \
253 __cup.routine(__cup.routine_arg); \
254 }
255
256 struct pthread_atfork {
257 TAILQ_ENTRY(pthread_atfork) qe;
258 void (*prepare)(void);
259 void (*parent)(void);
260 void (*child)(void);
261 };
262
263 struct pthread_attr {
264 int sched_policy;
265 int sched_inherit;
266 int prio;
267 int suspend;
268 #define THR_STACK_USER 0x100 /* 0xFF reserved for <pthread.h> */
269 int flags;
270 void *stackaddr_attr;
271 size_t stacksize_attr;
272 size_t guardsize_attr;
273 cpuset_t *cpuset;
274 size_t cpusetsize;
275 };
276
277 struct wake_addr {
278 struct wake_addr *link;
279 unsigned int value;
280 char pad[12];
281 };
282
283 struct sleepqueue {
284 TAILQ_HEAD(, pthread) sq_blocked;
285 SLIST_HEAD(, sleepqueue) sq_freeq;
286 LIST_ENTRY(sleepqueue) sq_hash;
287 SLIST_ENTRY(sleepqueue) sq_flink;
288 void *sq_wchan;
289 int sq_type;
290 };
291
292 /*
293 * Thread creation state attributes.
294 */
295 #define THR_CREATE_RUNNING 0
296 #define THR_CREATE_SUSPENDED 1
297
298 /*
299 * Miscellaneous definitions.
300 */
301 #define THR_STACK_DEFAULT (sizeof(void *) / 4 * 1024 * 1024)
302
303 /*
304 * Maximum size of initial thread's stack. This perhaps deserves to be larger
305 * than the stacks of other threads, since many applications are likely to run
306 * almost entirely on this stack.
307 */
308 #define THR_STACK_INITIAL (THR_STACK_DEFAULT * 2)
309
310 /*
311 * Define priorities returned by kernel.
312 */
313 #define THR_MIN_PRIORITY (_thr_priorities[SCHED_OTHER-1].pri_min)
314 #define THR_MAX_PRIORITY (_thr_priorities[SCHED_OTHER-1].pri_max)
315 #define THR_DEF_PRIORITY (_thr_priorities[SCHED_OTHER-1].pri_default)
316
317 #define THR_MIN_RR_PRIORITY (_thr_priorities[SCHED_RR-1].pri_min)
318 #define THR_MAX_RR_PRIORITY (_thr_priorities[SCHED_RR-1].pri_max)
319 #define THR_DEF_RR_PRIORITY (_thr_priorities[SCHED_RR-1].pri_default)
320
321 /* XXX The SCHED_FIFO should have same priority range as SCHED_RR */
322 #define THR_MIN_FIFO_PRIORITY (_thr_priorities[SCHED_FIFO_1].pri_min)
323 #define THR_MAX_FIFO_PRIORITY (_thr_priorities[SCHED_FIFO-1].pri_max)
324 #define THR_DEF_FIFO_PRIORITY (_thr_priorities[SCHED_FIFO-1].pri_default)
325
326 struct pthread_prio {
327 int pri_min;
328 int pri_max;
329 int pri_default;
330 };
331
332 struct pthread_rwlockattr {
333 int pshared;
334 };
335
336 struct pthread_rwlock {
337 struct urwlock lock;
338 uint32_t owner;
339 };
340
341 /*
342 * Thread states.
343 */
344 enum pthread_state {
345 PS_RUNNING,
346 PS_DEAD
347 };
348
349 struct pthread_specific_elem {
350 const void *data;
351 int seqno;
352 };
353
354 struct pthread_key {
355 volatile int allocated;
356 int seqno;
357 void (*destructor)(void *);
358 };
359
360 /*
361 * lwpid_t is 32bit but kernel thr API exports tid as long type
362 * to preserve the ABI for M:N model in very early date (r131431).
363 */
364 #define TID(thread) ((uint32_t) ((thread)->tid))
365
366 /*
367 * Thread structure.
368 */
369 struct pthread {
370 #define _pthread_startzero tid
371 /* Kernel thread id. */
372 long tid;
373 #define TID_TERMINATED 1
374
375 /*
376 * Lock for accesses to this thread structure.
377 */
378 struct umutex lock;
379
380 /* Internal condition variable cycle number. */
381 uint32_t cycle;
382
383 /* How many low level locks the thread held. */
384 int locklevel;
385
386 /*
387 * Set to non-zero when this thread has entered a critical
388 * region. We allow for recursive entries into critical regions.
389 */
390 int critical_count;
391
392 /* Signal blocked counter. */
393 int sigblock;
394
395 /* Fast sigblock var. */
396 uint32_t fsigblock;
397
398 /* Queue entry for list of all threads. */
399 TAILQ_ENTRY(pthread) tle; /* link for all threads in process */
400
401 /* Queue entry for GC lists. */
402 TAILQ_ENTRY(pthread) gcle;
403
404 /* Hash queue entry. */
405 LIST_ENTRY(pthread) hle;
406
407 /* Sleep queue entry */
408 TAILQ_ENTRY(pthread) wle;
409
410 /* Threads reference count. */
411 int refcount;
412
413 /*
414 * Thread start routine, argument, stack pointer and thread
415 * attributes.
416 */
417 void *(*start_routine)(void *);
418 void *arg;
419 struct pthread_attr attr;
420
421 #define SHOULD_CANCEL(thr) \
422 ((thr)->cancel_pending && (thr)->cancel_enable && \
423 (thr)->no_cancel == 0)
424
425 /* Cancellation is enabled */
426 int cancel_enable;
427
428 /* Cancellation request is pending */
429 int cancel_pending;
430
431 /* Thread is at cancellation point */
432 int cancel_point;
433
434 /* Cancellation is temporarily disabled */
435 int no_cancel;
436
437 /* Asynchronouse cancellation is enabled */
438 int cancel_async;
439
440 /* Cancellation is in progress */
441 int cancelling;
442
443 /* Thread temporary signal mask. */
444 sigset_t sigmask;
445
446 /* Thread should unblock SIGCANCEL. */
447 int unblock_sigcancel;
448
449 /* In sigsuspend state */
450 int in_sigsuspend;
451
452 /* deferred signal info */
453 siginfo_t deferred_siginfo;
454
455 /* signal mask to restore. */
456 sigset_t deferred_sigmask;
457
458 /* the sigaction should be used for deferred signal. */
459 struct sigaction deferred_sigact;
460
461 /* deferred signal delivery is performed, do not reenter. */
462 int deferred_run;
463
464 /* Force new thread to exit. */
465 int force_exit;
466
467 /* Thread state: */
468 enum pthread_state state;
469
470 /*
471 * Error variable used instead of errno. The function __error()
472 * returns a pointer to this.
473 */
474 int error;
475
476 /*
477 * The joiner is the thread that is joining to this thread. The
478 * join status keeps track of a join operation to another thread.
479 */
480 struct pthread *joiner;
481
482 /* Miscellaneous flags; only set with scheduling lock held. */
483 int flags;
484 #define THR_FLAGS_PRIVATE 0x0001
485 #define THR_FLAGS_NEED_SUSPEND 0x0002 /* thread should be suspended */
486 #define THR_FLAGS_SUSPENDED 0x0004 /* thread is suspended */
487 #define THR_FLAGS_DETACHED 0x0008 /* thread is detached */
488
489 /* Thread list flags; only set with thread list lock held. */
490 int tlflags;
491 #define TLFLAGS_GC_SAFE 0x0001 /* thread safe for cleaning */
492 #define TLFLAGS_IN_TDLIST 0x0002 /* thread in all thread list */
493 #define TLFLAGS_IN_GCLIST 0x0004 /* thread in gc list */
494
495 /*
496 * Queues of the owned mutexes. Private queue must have index
497 * + 1 of the corresponding full queue.
498 */
499 #define TMQ_NORM 0 /* NORMAL or PRIO_INHERIT normal */
500 #define TMQ_NORM_PRIV 1 /* NORMAL or PRIO_INHERIT normal priv */
501 #define TMQ_NORM_PP 2 /* PRIO_PROTECT normal mutexes */
502 #define TMQ_NORM_PP_PRIV 3 /* PRIO_PROTECT normal priv */
503 #define TMQ_ROBUST_PP 4 /* PRIO_PROTECT robust mutexes */
504 #define TMQ_ROBUST_PP_PRIV 5 /* PRIO_PROTECT robust priv */
505 #define TMQ_NITEMS 6
506 struct mutex_queue mq[TMQ_NITEMS];
507
508 void *ret;
509 struct pthread_specific_elem *specific;
510 int specific_data_count;
511
512 /* Number rwlocks rdlocks held. */
513 int rdlock_count;
514
515 /*
516 * Current locks bitmap for rtld. */
517 int rtld_bits;
518
519 /* Thread control block */
520 struct tcb *tcb;
521
522 /* Cleanup handlers Link List */
523 struct pthread_cleanup *cleanup;
524
525 #ifdef _PTHREAD_FORCED_UNWIND
526 struct _Unwind_Exception ex;
527 void *unwind_stackend;
528 int unwind_disabled;
529 #endif
530
531 /*
532 * Magic value to help recognize a valid thread structure
533 * from an invalid one:
534 */
535 #define THR_MAGIC ((u_int32_t) 0xd09ba115)
536 u_int32_t magic;
537
538 /* Enable event reporting */
539 int report_events;
540
541 /* Event mask */
542 int event_mask;
543
544 /* Event */
545 td_event_msg_t event_buf;
546
547 /* Wait channel */
548 void *wchan;
549
550 /* Referenced mutex. */
551 struct pthread_mutex *mutex_obj;
552
553 /* Thread will sleep. */
554 int will_sleep;
555
556 /* Number of threads deferred. */
557 int nwaiter_defer;
558
559 int robust_inited;
560 uintptr_t robust_list;
561 uintptr_t priv_robust_list;
562 uintptr_t inact_mtx;
563
564 /* Deferred threads from pthread_cond_signal. */
565 unsigned int *defer_waiters[MAX_DEFER_WAITERS];
566
567 /* rtld thread-local dlerror message and seen control */
568 char dlerror_msg[512];
569 int dlerror_seen;
570
571 #define _pthread_endzero wake_addr
572 struct wake_addr *wake_addr;
573 #define WAKE_ADDR(td) ((td)->wake_addr)
574
575 /* Sleep queue */
576 struct sleepqueue *sleepqueue;
577
578 /* pthread_set/get_name_np */
579 char *name;
580
581 struct uexterror uexterr;
582 };
583
584 #define THR_SHOULD_GC(thrd) \
585 ((thrd)->refcount == 0 && (thrd)->state == PS_DEAD && \
586 ((thrd)->flags & THR_FLAGS_DETACHED) != 0)
587
588 #define THR_IN_CRITICAL(thrd) \
589 (((thrd)->locklevel > 0) || \
590 ((thrd)->critical_count > 0))
591
592 #define THR_CRITICAL_ENTER(thrd) \
593 (thrd)->critical_count++
594
595 #define THR_CRITICAL_LEAVE(thrd) \
596 do { \
597 (thrd)->critical_count--; \
598 _thr_ast(thrd); \
599 } while (0)
600
601 #define THR_UMUTEX_TRYLOCK(thrd, lck) \
602 _thr_umutex_trylock((lck), TID(thrd))
603
604 #define THR_UMUTEX_LOCK(thrd, lck) \
605 _thr_umutex_lock((lck), TID(thrd))
606
607 #define THR_UMUTEX_TIMEDLOCK(thrd, lck, timo) \
608 _thr_umutex_timedlock((lck), TID(thrd), (timo))
609
610 #define THR_UMUTEX_UNLOCK(thrd, lck) \
611 _thr_umutex_unlock((lck), TID(thrd))
612
613 #define THR_LOCK_ACQUIRE(thrd, lck) \
614 do { \
615 (thrd)->locklevel++; \
616 _thr_umutex_lock(lck, TID(thrd)); \
617 } while (0)
618
619 #define THR_LOCK_ACQUIRE_SPIN(thrd, lck) \
620 do { \
621 (thrd)->locklevel++; \
622 _thr_umutex_lock_spin(lck, TID(thrd)); \
623 } while (0)
624
625 #ifdef _PTHREADS_INVARIANTS
626 #define THR_ASSERT_LOCKLEVEL(thrd) \
627 do { \
628 if (__predict_false((thrd)->locklevel <= 0)) \
629 _thr_assert_lock_level(); \
630 } while (0)
631 #else
632 #define THR_ASSERT_LOCKLEVEL(thrd)
633 #endif
634
635 #define THR_LOCK_RELEASE(thrd, lck) \
636 do { \
637 THR_ASSERT_LOCKLEVEL(thrd); \
638 _thr_umutex_unlock((lck), TID(thrd)); \
639 (thrd)->locklevel--; \
640 _thr_ast(thrd); \
641 } while (0)
642
643 #define THR_LOCK(curthrd) THR_LOCK_ACQUIRE(curthrd, &(curthrd)->lock)
644 #define THR_UNLOCK(curthrd) THR_LOCK_RELEASE(curthrd, &(curthrd)->lock)
645 #define THR_THREAD_LOCK(curthrd, thr) THR_LOCK_ACQUIRE(curthrd, &(thr)->lock)
646 #define THR_THREAD_UNLOCK(curthrd, thr) THR_LOCK_RELEASE(curthrd, &(thr)->lock)
647
648 #define THREAD_LIST_RDLOCK(curthrd) \
649 do { \
650 (curthrd)->locklevel++; \
651 _thr_rwl_rdlock(&_thr_list_lock); \
652 } while (0)
653
654 #define THREAD_LIST_WRLOCK(curthrd) \
655 do { \
656 (curthrd)->locklevel++; \
657 _thr_rwl_wrlock(&_thr_list_lock); \
658 } while (0)
659
660 #define THREAD_LIST_UNLOCK(curthrd) \
661 do { \
662 _thr_rwl_unlock(&_thr_list_lock); \
663 (curthrd)->locklevel--; \
664 _thr_ast(curthrd); \
665 } while (0)
666
667 /*
668 * Macros to insert/remove threads to the all thread list and
669 * the gc list.
670 */
671 #define THR_LIST_ADD(thrd) do { \
672 if (((thrd)->tlflags & TLFLAGS_IN_TDLIST) == 0) { \
673 TAILQ_INSERT_HEAD(&_thread_list, thrd, tle); \
674 _thr_hash_add(thrd); \
675 (thrd)->tlflags |= TLFLAGS_IN_TDLIST; \
676 } \
677 } while (0)
678 #define THR_LIST_REMOVE(thrd) do { \
679 if (((thrd)->tlflags & TLFLAGS_IN_TDLIST) != 0) { \
680 TAILQ_REMOVE(&_thread_list, thrd, tle); \
681 _thr_hash_remove(thrd); \
682 (thrd)->tlflags &= ~TLFLAGS_IN_TDLIST; \
683 } \
684 } while (0)
685 #define THR_GCLIST_ADD(thrd) do { \
686 if (((thrd)->tlflags & TLFLAGS_IN_GCLIST) == 0) { \
687 TAILQ_INSERT_HEAD(&_thread_gc_list, thrd, gcle);\
688 (thrd)->tlflags |= TLFLAGS_IN_GCLIST; \
689 _gc_count++; \
690 } \
691 } while (0)
692 #define THR_GCLIST_REMOVE(thrd) do { \
693 if (((thrd)->tlflags & TLFLAGS_IN_GCLIST) != 0) { \
694 TAILQ_REMOVE(&_thread_gc_list, thrd, gcle); \
695 (thrd)->tlflags &= ~TLFLAGS_IN_GCLIST; \
696 _gc_count--; \
697 } \
698 } while (0)
699
700 #define THR_REF_ADD(curthread, pthread) { \
701 THR_CRITICAL_ENTER(curthread); \
702 pthread->refcount++; \
703 } while (0)
704
705 #define THR_REF_DEL(curthread, pthread) { \
706 pthread->refcount--; \
707 THR_CRITICAL_LEAVE(curthread); \
708 } while (0)
709
710 #define GC_NEEDED() (_gc_count >= 5)
711
712 #define SHOULD_REPORT_EVENT(curthr, e) \
713 (curthr->report_events && \
714 (((curthr)->event_mask | _thread_event_mask ) & e) != 0)
715
716 #ifndef __LIBC_ISTHREADED_DECLARED
717 #define __LIBC_ISTHREADED_DECLARED
718 extern int __isthreaded;
719 #endif
720
721 /*
722 * Global variables for the pthread kernel.
723 */
724
725 extern char *_usrstack __hidden;
726
727 /* For debugger */
728 extern int _libthr_debug;
729 extern int _thread_event_mask;
730 extern struct pthread *_thread_last_event;
731 /* Used in symbol lookup of libthread_db */
732 extern struct pthread_key _thread_keytable[];
733
734 /* List of all threads: */
735 extern pthreadlist _thread_list;
736
737 /* List of threads needing GC: */
738 extern pthreadlist _thread_gc_list __hidden;
739
740 extern int _thread_active_threads;
741 extern atfork_head _thr_atfork_list __hidden;
742 extern struct urwlock _thr_atfork_lock __hidden;
743
744 /* Default thread attributes: */
745 extern struct pthread_attr _pthread_attr_default __hidden;
746
747 /* Default mutex attributes: */
748 extern struct pthread_mutex_attr _pthread_mutexattr_default __hidden;
749 extern struct pthread_mutex_attr _pthread_mutexattr_adaptive_default __hidden;
750
751 /* Default condition variable attributes: */
752 extern struct pthread_cond_attr _pthread_condattr_default __hidden;
753
754 extern struct pthread_prio _thr_priorities[] __hidden;
755
756 extern int _thr_is_smp __hidden;
757
758 extern size_t _thr_guard_default __hidden;
759 extern size_t _thr_stack_default __hidden;
760 extern size_t _thr_stack_initial __hidden;
761 extern int _thr_page_size __hidden;
762 extern int _thr_spinloops __hidden;
763 extern int _thr_yieldloops __hidden;
764 extern int _thr_queuefifo __hidden;
765
766 /* Garbage thread count. */
767 extern int _gc_count __hidden;
768
769 extern struct umutex _mutex_static_lock __hidden;
770 extern struct umutex _cond_static_lock __hidden;
771 extern struct umutex _rwlock_static_lock __hidden;
772 extern struct umutex _keytable_lock __hidden;
773 extern struct urwlock _thr_list_lock __hidden;
774 extern struct umutex _thr_event_lock __hidden;
775 extern struct umutex _suspend_all_lock __hidden;
776 extern int _suspend_all_waiters __hidden;
777 extern int _suspend_all_cycle __hidden;
778 extern struct pthread *_single_thread __hidden;
779
780 extern bool _thr_after_fork __hidden;
781
782 extern int __thr_new_flags;
783
784 /*
785 * Function prototype definitions.
786 */
787 __BEGIN_DECLS
788 void _thr_setthreaded(int) __hidden;
789 int _mutex_cv_lock(struct pthread_mutex *, int, bool) __hidden;
790 int _mutex_cv_unlock(struct pthread_mutex *, int *, int *) __hidden;
791 int _mutex_cv_attach(struct pthread_mutex *, int) __hidden;
792 int _mutex_cv_detach(struct pthread_mutex *, int *) __hidden;
793 int _mutex_owned(struct pthread *, const struct pthread_mutex *) __hidden;
794 int _mutex_reinit(pthread_mutex_t *) __hidden;
795 void _mutex_fork(struct pthread *curthread) __hidden;
796 int _mutex_enter_robust(struct pthread *curthread, struct pthread_mutex *m)
797 __hidden;
798 void _mutex_leave_robust(struct pthread *curthread, struct pthread_mutex *m)
799 __hidden;
800 void _libpthread_init(struct pthread *) __hidden;
801 struct pthread *_thr_alloc(struct pthread *) __hidden;
802 void _thread_exit(const char *, int, const char *) __hidden __dead2;
803 void _thread_exitf(const char *, int, const char *, ...) __hidden __dead2
804 __printflike(3, 4);
805 int _thr_ref_add(struct pthread *, struct pthread *, int) __hidden;
806 void _thr_ref_delete(struct pthread *, struct pthread *) __hidden;
807 void _thr_ref_delete_unlocked(struct pthread *, struct pthread *) __hidden;
808 int _thr_find_thread(struct pthread *, struct pthread *, int) __hidden;
809 void _thr_rtld_init(void) __hidden;
810 void _thr_rtld_postfork_child(void) __hidden;
811 int _thr_stack_alloc(struct pthread_attr *) __hidden;
812 void _thr_stack_free(struct pthread_attr *) __hidden;
813 void _thr_free(struct pthread *, struct pthread *) __hidden;
814 void _thr_gc(struct pthread *) __hidden;
815 void _thread_cleanupspecific(void) __hidden;
816 void _thread_printf(int, const char *, ...) __hidden __printflike(2, 3);
817 void _thread_vprintf(int, const char *, va_list) __hidden;
818 void _thr_spinlock_init(void) __hidden;
819 void _thr_cancel_enter(struct pthread *) __hidden;
820 void _thr_cancel_enter2(struct pthread *, int) __hidden;
821 void _thr_cancel_leave(struct pthread *, int) __hidden;
822 void _thr_testcancel(struct pthread *) __hidden;
823 void _thr_signal_block(struct pthread *) __hidden;
824 void _thr_signal_unblock(struct pthread *) __hidden;
825 void _thr_signal_block_check_fast(void) __hidden;
826 void _thr_signal_block_setup(struct pthread *) __hidden;
827 void _thr_signal_init(int) __hidden;
828 void _thr_signal_deinit(void) __hidden;
829 int _thr_send_sig(struct pthread *, int sig) __hidden;
830 void _thr_list_init(void) __hidden;
831 void _thr_hash_add(struct pthread *) __hidden;
832 void _thr_hash_remove(struct pthread *) __hidden;
833 struct pthread *_thr_hash_find(struct pthread *) __hidden;
834 void _thr_link(struct pthread *, struct pthread *) __hidden;
835 void _thr_unlink(struct pthread *, struct pthread *) __hidden;
836 void _thr_assert_lock_level(void) __hidden __dead2;
837 void _thr_ast(struct pthread *) __hidden;
838 void _thr_report_creation(struct pthread *curthread,
839 struct pthread *newthread) __hidden;
840 void _thr_report_death(struct pthread *curthread) __hidden;
841 int _thr_getscheduler(lwpid_t, int *, struct sched_param *) __hidden;
842 int _thr_setscheduler(lwpid_t, int, const struct sched_param *) __hidden;
843 void _thr_signal_prefork(void) __hidden;
844 void _thr_signal_postfork(void) __hidden;
845 void _thr_signal_postfork_child(void) __hidden;
846 void _thr_suspend_all_lock(struct pthread *) __hidden;
847 void _thr_suspend_all_unlock(struct pthread *) __hidden;
848 void _thr_suspend_all_np(void) __hidden;
849 void _thr_resume_all_np(void) __hidden;
850 void _thr_try_gc(struct pthread *, struct pthread *) __hidden;
851 int _rtp_to_schedparam(const struct rtprio *rtp, int *policy,
852 struct sched_param *param) __hidden;
853 int _schedparam_to_rtp(int policy, const struct sched_param *param,
854 struct rtprio *rtp) __hidden;
855 void _thread_bp_create(void);
856 void _thread_bp_death(void);
857 int _sched_yield(void);
858
859 void _pthread_cleanup_push(void (*)(void *), void *);
860 void _pthread_cleanup_pop(int);
861 void _pthread_exit_mask(void *status, sigset_t *mask) __dead2 __hidden;
862 #ifndef _LIBC_PRIVATE_H_
863 void _pthread_cancel_enter(int maycancel);
864 void _pthread_cancel_leave(int maycancel);
865 #endif
866 int _pthread_mutex_consistent(pthread_mutex_t * _Nonnull);
867 int _pthread_mutexattr_getrobust(pthread_mutexattr_t * _Nonnull __restrict,
868 int * _Nonnull __restrict);
869 int _pthread_mutexattr_setrobust(pthread_mutexattr_t * _Nonnull, int);
870
871 /* #include <fcntl.h> */
872 #ifdef _SYS_FCNTL_H_
873 #ifndef _LIBC_PRIVATE_H_
874 int __sys_fcntl(int, int, intptr_t);
875 int __sys_openat(int, const char *, int, int);
876 #endif /* _LIBC_PRIVATE_H_ */
877 #endif /* _SYS_FCNTL_H_ */
878
879 /* #include <signal.h> */
880 #ifdef _SIGNAL_H_
881 #ifndef _LIBC_PRIVATE_H_
882 int __sys_sigaction(int, const struct sigaction *, struct sigaction *);
883 int __sys_sigprocmask(int, const sigset_t *, sigset_t *);
884 int __sys_sigsuspend(const sigset_t *);
885 int __sys_sigtimedwait(const sigset_t *, siginfo_t *,
886 const struct timespec *);
887 int __sys_sigwait(const sigset_t *, int *);
888 int __sys_sigwaitinfo(const sigset_t *set, siginfo_t *info);
889 #endif /* _LIBC_PRIVATE_H_ */
890 #endif /* _SYS_FCNTL_H_ */
891
892 /* #include <time.h> */
893 #ifdef _TIME_H_
894 #ifndef _LIBC_PRIVATE_H_
895 int __sys_clock_nanosleep(clockid_t, int, const struct timespec *,
896 struct timespec *);
897 int __sys_nanosleep(const struct timespec *, struct timespec *);
898 #endif /* _LIBC_PRIVATE_H_ */
899 #endif /* _SYS_FCNTL_H_ */
900
901 /* #include <sys/ucontext.h> */
902 #ifdef _SYS_UCONTEXT_H_
903 #ifndef _LIBC_PRIVATE_H_
904 int __sys_setcontext(const ucontext_t *ucp);
905 int __sys_swapcontext(ucontext_t *oucp, const ucontext_t *ucp);
906 #endif /* _LIBC_PRIVATE_H_ */
907 #endif /* _SYS_FCNTL_H_ */
908
909 /* #include <unistd.h> */
910 #ifdef _UNISTD_H_
911 #ifndef _LIBC_PRIVATE_H_
912 int __sys_close(int);
913 int __sys_fork(void);
914 ssize_t __sys_read(int, void *, size_t);
915 #endif /* _LIBC_PRIVATE_H_ */
916 #endif /* _SYS_FCNTL_H_ */
917
918 static inline int
_thr_isthreaded(void)919 _thr_isthreaded(void)
920 {
921 return (__isthreaded != 0);
922 }
923
924 static inline int
_thr_is_inited(void)925 _thr_is_inited(void)
926 {
927 return (_thr_initial != NULL);
928 }
929
930 static inline void
_thr_check_init(void)931 _thr_check_init(void)
932 {
933 if (_thr_initial == NULL)
934 _libpthread_init(NULL);
935 }
936
937 struct wake_addr *_thr_alloc_wake_addr(void);
938 void _thr_release_wake_addr(struct wake_addr *);
939 int _thr_sleep(struct pthread *, int, const struct timespec *);
940
941 void _thr_wake_addr_init(void) __hidden;
942
943 static inline void
_thr_clear_wake(struct pthread * td)944 _thr_clear_wake(struct pthread *td)
945 {
946 td->wake_addr->value = 0;
947 }
948
949 static inline int
_thr_is_woken(struct pthread * td)950 _thr_is_woken(struct pthread *td)
951 {
952 return td->wake_addr->value != 0;
953 }
954
955 static inline void
_thr_set_wake(unsigned int * waddr)956 _thr_set_wake(unsigned int *waddr)
957 {
958 *waddr = 1;
959 _thr_umtx_wake(waddr, INT_MAX, 0);
960 }
961
962 void _thr_wake_all(unsigned int *waddrs[], int) __hidden;
963
964 static inline struct pthread *
_sleepq_first(struct sleepqueue * sq)965 _sleepq_first(struct sleepqueue *sq)
966 {
967 return TAILQ_FIRST(&sq->sq_blocked);
968 }
969
970 void _sleepq_init(void) __hidden;
971 struct sleepqueue *_sleepq_alloc(void) __hidden;
972 void _sleepq_free(struct sleepqueue *) __hidden;
973 void _sleepq_lock(void *) __hidden;
974 void _sleepq_unlock(void *) __hidden;
975 struct sleepqueue *_sleepq_lookup(void *) __hidden;
976 void _sleepq_add(void *, struct pthread *) __hidden;
977 int _sleepq_remove(struct sleepqueue *, struct pthread *) __hidden;
978 void _sleepq_drop(struct sleepqueue *,
979 void (*cb)(struct pthread *, void *arg), void *) __hidden;
980
981 int _pthread_mutex_init_calloc_cb(pthread_mutex_t *mutex,
982 void *(calloc_cb)(size_t, size_t));
983
984 struct dl_phdr_info;
985 void __pthread_cxa_finalize(struct dl_phdr_info *phdr_info);
986 void _thr_tsd_unload(struct dl_phdr_info *phdr_info) __hidden;
987 void _thr_sigact_unload(struct dl_phdr_info *phdr_info) __hidden;
988 void _thr_stack_fix_protection(struct pthread *thrd);
989 void __pthread_distribute_static_tls(size_t offset, void *src, size_t len,
990 size_t total_len);
991
992 int *__error_threaded(void) __hidden;
993 void __thr_interpose_libc(void) __hidden;
994 pid_t __thr_fork(void);
995 pid_t __thr_pdfork(int *, int);
996 int __thr_setcontext(const ucontext_t *ucp);
997 int __thr_sigaction(int sig, const struct sigaction *act,
998 struct sigaction *oact) __hidden;
999 int __thr_sigprocmask(int how, const sigset_t *set, sigset_t *oset);
1000 int __thr_sigsuspend(const sigset_t * set);
1001 int __thr_sigtimedwait(const sigset_t *set, siginfo_t *info,
1002 const struct timespec * timeout);
1003 int __thr_sigwait(const sigset_t *set, int *sig);
1004 int __thr_sigwaitinfo(const sigset_t *set, siginfo_t *info);
1005 int __thr_swapcontext(ucontext_t *oucp, const ucontext_t *ucp);
1006
1007 void __thr_map_stacks_exec(void);
1008
1009 struct _spinlock;
1010 void __thr_spinunlock(struct _spinlock *lck);
1011 void __thr_spinlock(struct _spinlock *lck);
1012
1013 struct tcb *_tcb_ctor(struct pthread *, int);
1014 void _tcb_dtor(struct tcb *);
1015
1016 void __thr_pshared_init(void) __hidden;
1017 void *__thr_pshared_offpage(void *key, int doalloc) __hidden;
1018 void __thr_pshared_destroy(void *key) __hidden;
1019 void __thr_pshared_atfork_pre(void) __hidden;
1020 void __thr_pshared_atfork_post(void) __hidden;
1021
1022 void *__thr_aligned_alloc_offset(size_t align, size_t size, size_t offset);
1023 void *__thr_calloc(size_t num, size_t size);
1024 void __thr_free(void *cp);
1025 void *__thr_malloc(size_t nbytes);
1026 void *__thr_realloc(void *cp, size_t nbytes);
1027 void __thr_malloc_init(void);
1028 void __thr_malloc_prefork(struct pthread *curthread);
1029 void __thr_malloc_postfork(struct pthread *curthread);
1030
1031 int _thr_join(pthread_t, void **);
1032 int _Tthr_kill(pthread_t, int);
1033 int _thr_getthreadid_np(void);
1034 void __thr_cleanup_push_imp(void (*)(void *), void *,
1035 struct _pthread_cleanup_info *);
1036 void __thr_cleanup_pop_imp(int);
1037 void _thr_cleanup_push(void (*)(void *), void *);
1038 void _thr_cleanup_pop(int);
1039 void _Tthr_testcancel(void);
1040 void _Tthr_cancel_enter(int);
1041 void _Tthr_cancel_leave(int);
1042 int _thr_cancel(pthread_t);
1043 int _thr_atfork(void (*)(void), void (*)(void), void (*)(void));
1044 int _thr_attr_destroy(pthread_attr_t *);
1045 int _thr_attr_get_np(pthread_t, pthread_attr_t *);
1046 int _thr_attr_getdetachstate(const pthread_attr_t *, int *);
1047 int _thr_attr_getguardsize(const pthread_attr_t * __restrict,
1048 size_t * __restrict);
1049 int _thr_attr_getinheritsched(const pthread_attr_t * __restrict,
1050 int * __restrict);
1051 int _thr_attr_getschedparam(const pthread_attr_t * __restrict,
1052 struct sched_param * __restrict);
1053 int _thr_attr_getschedpolicy(const pthread_attr_t * __restrict,
1054 int * __restrict);
1055 int _thr_attr_getscope(const pthread_attr_t * __restrict, int * __restrict);
1056 int _thr_attr_getstackaddr(const pthread_attr_t *, void **);
1057 int _thr_attr_getstacksize(const pthread_attr_t * __restrict,
1058 size_t * __restrict);
1059 int _thr_attr_init(pthread_attr_t *);
1060 int _thr_attr_setdetachstate(pthread_attr_t *, int);
1061 int _thr_attr_setguardsize(pthread_attr_t *, size_t);
1062 int _thr_attr_setinheritsched(pthread_attr_t *, int);
1063 int _thr_attr_setschedparam(pthread_attr_t * __restrict,
1064 const struct sched_param * __restrict);
1065 int _thr_attr_setschedpolicy(pthread_attr_t *, int);
1066 int _thr_attr_setscope(pthread_attr_t *, int);
1067 int _thr_attr_setstackaddr(pthread_attr_t *, void *);
1068 int _thr_attr_setstacksize(pthread_attr_t *, size_t);
1069 int _thr_cond_init(pthread_cond_t * __restrict,
1070 const pthread_condattr_t * __restrict);
1071 int _thr_cond_destroy(pthread_cond_t *);
1072 int _thr_cond_timedwait(pthread_cond_t * __restrict,
1073 pthread_mutex_t * __restrict, const struct timespec * __restrict);
1074 int _thr_cond_signal(pthread_cond_t * cond);
1075 int _thr_cond_broadcast(pthread_cond_t * cond);
1076 int __thr_cond_wait(pthread_cond_t *, pthread_mutex_t *);
1077 int _thr_cond_wait(pthread_cond_t *, pthread_mutex_t *);
1078 int _thr_detach(pthread_t);
1079 int _thr_equal(pthread_t, pthread_t);
1080 void _Tthr_exit(void *);
1081 int _thr_getname_np(pthread_t, char *, size_t);
1082 int _thr_key_create(pthread_key_t *, void (*)(void *));
1083 int _thr_key_delete(pthread_key_t);
1084 int _thr_setspecific(pthread_key_t, const void *);
1085 void *_thr_getspecific(pthread_key_t);
1086 int _thr_setcancelstate(int, int *);
1087 int _thr_setcanceltype(int, int *);
1088 pthread_t _Tthr_self(void);
1089 int _thr_rwlock_init(pthread_rwlock_t *, const pthread_rwlockattr_t *);
1090 int _thr_rwlock_destroy(pthread_rwlock_t *);
1091 int _Tthr_rwlock_rdlock(pthread_rwlock_t *);
1092 int _Tthr_rwlock_tryrdlock(pthread_rwlock_t *);
1093 int _Tthr_rwlock_trywrlock(pthread_rwlock_t *);
1094 int _Tthr_rwlock_wrlock(pthread_rwlock_t *);
1095 int _Tthr_rwlock_unlock(pthread_rwlock_t *);
1096 int _thr_once(pthread_once_t *, void (*)(void));
1097 int _thr_sigmask(int, const sigset_t *, sigset_t *);
1098 int _thr_main_np(void);
1099 int _thr_mutexattr_init(pthread_mutexattr_t *);
1100 int _thr_mutexattr_destroy(pthread_mutexattr_t *);
1101 int _thr_mutexattr_settype(pthread_mutexattr_t *, int);
1102 int _thr_mutexattr_getrobust(pthread_mutexattr_t *, int *);
1103 int _thr_mutexattr_setrobust(pthread_mutexattr_t *, int);
1104 int __Tthr_mutex_init(pthread_mutex_t * __restrict,
1105 const pthread_mutexattr_t * __restrict);
1106 int _Tthr_mutex_consistent(pthread_mutex_t *);
1107 int _thr_mutex_destroy(pthread_mutex_t *);
1108 int _thr_mutex_unlock(pthread_mutex_t *);
1109 int __Tthr_mutex_lock(pthread_mutex_t *);
1110 int __Tthr_mutex_trylock(pthread_mutex_t *);
1111 bool __thr_get_main_stack_base(char **base);
1112 bool __thr_get_main_stack_lim(size_t *lim);
1113 int _Tthr_sigqueue(pthread_t pthread, int sig, const union sigval value);
1114 void _thr_resolve_machdep(void);
1115
1116 __END_DECLS
1117 __NULLABILITY_PRAGMA_POP
1118
1119 #endif /* !_THR_PRIVATE_H */
1120