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