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