]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - lib/libthr/thread/thr_private.h
Merge libcxxrt master 03c83f5a57be8c5b1a29a68de5638744f17d28ba
[FreeBSD/FreeBSD.git] / lib / libthr / thread / thr_private.h
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/cdefs.h>
41 #include <sys/queue.h>
42 #include <sys/param.h>
43 #include <sys/cpuset.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 #define _pthread_endzero        wake_addr
567
568         struct wake_addr        *wake_addr;
569 #define WAKE_ADDR(td)           ((td)->wake_addr)
570
571         /* Sleep queue */
572         struct  sleepqueue      *sleepqueue;
573
574         /* pthread_set/get_name_np */
575         char                    *name;
576
577         /* rtld thread-local dlerror message and seen control */
578         char                    dlerror_msg[512];
579         int                     dlerror_seen;
580 };
581
582 #define THR_SHOULD_GC(thrd)                                             \
583         ((thrd)->refcount == 0 && (thrd)->state == PS_DEAD &&           \
584          ((thrd)->flags & THR_FLAGS_DETACHED) != 0)
585
586 #define THR_IN_CRITICAL(thrd)                           \
587         (((thrd)->locklevel > 0) ||                     \
588         ((thrd)->critical_count > 0))
589
590 #define THR_CRITICAL_ENTER(thrd)                        \
591         (thrd)->critical_count++
592
593 #define THR_CRITICAL_LEAVE(thrd)                        \
594         do {                                            \
595                 (thrd)->critical_count--;               \
596                 _thr_ast(thrd);                         \
597         } while (0)
598
599 #define THR_UMUTEX_TRYLOCK(thrd, lck)                   \
600         _thr_umutex_trylock((lck), TID(thrd))
601
602 #define THR_UMUTEX_LOCK(thrd, lck)                      \
603         _thr_umutex_lock((lck), TID(thrd))
604
605 #define THR_UMUTEX_TIMEDLOCK(thrd, lck, timo)           \
606         _thr_umutex_timedlock((lck), TID(thrd), (timo))
607
608 #define THR_UMUTEX_UNLOCK(thrd, lck)                    \
609         _thr_umutex_unlock((lck), TID(thrd))
610
611 #define THR_LOCK_ACQUIRE(thrd, lck)                     \
612 do {                                                    \
613         (thrd)->locklevel++;                            \
614         _thr_umutex_lock(lck, TID(thrd));               \
615 } while (0)
616
617 #define THR_LOCK_ACQUIRE_SPIN(thrd, lck)                \
618 do {                                                    \
619         (thrd)->locklevel++;                            \
620         _thr_umutex_lock_spin(lck, TID(thrd));          \
621 } while (0)
622
623 #ifdef  _PTHREADS_INVARIANTS
624 #define THR_ASSERT_LOCKLEVEL(thrd)                      \
625 do {                                                    \
626         if (__predict_false((thrd)->locklevel <= 0))    \
627                 _thr_assert_lock_level();               \
628 } while (0)
629 #else
630 #define THR_ASSERT_LOCKLEVEL(thrd)
631 #endif
632
633 #define THR_LOCK_RELEASE(thrd, lck)                     \
634 do {                                                    \
635         THR_ASSERT_LOCKLEVEL(thrd);                     \
636         _thr_umutex_unlock((lck), TID(thrd));           \
637         (thrd)->locklevel--;                            \
638         _thr_ast(thrd);                                 \
639 } while (0)
640
641 #define THR_LOCK(curthrd)               THR_LOCK_ACQUIRE(curthrd, &(curthrd)->lock)
642 #define THR_UNLOCK(curthrd)             THR_LOCK_RELEASE(curthrd, &(curthrd)->lock)
643 #define THR_THREAD_LOCK(curthrd, thr)   THR_LOCK_ACQUIRE(curthrd, &(thr)->lock)
644 #define THR_THREAD_UNLOCK(curthrd, thr) THR_LOCK_RELEASE(curthrd, &(thr)->lock)
645
646 #define THREAD_LIST_RDLOCK(curthrd)                             \
647 do {                                                            \
648         (curthrd)->locklevel++;                                 \
649         _thr_rwl_rdlock(&_thr_list_lock);                       \
650 } while (0)
651
652 #define THREAD_LIST_WRLOCK(curthrd)                             \
653 do {                                                            \
654         (curthrd)->locklevel++;                                 \
655         _thr_rwl_wrlock(&_thr_list_lock);                       \
656 } while (0)
657
658 #define THREAD_LIST_UNLOCK(curthrd)                             \
659 do {                                                            \
660         _thr_rwl_unlock(&_thr_list_lock);                       \
661         (curthrd)->locklevel--;                                 \
662         _thr_ast(curthrd);                                      \
663 } while (0)
664
665 /*
666  * Macros to insert/remove threads to the all thread list and
667  * the gc list.
668  */
669 #define THR_LIST_ADD(thrd) do {                                 \
670         if (((thrd)->tlflags & TLFLAGS_IN_TDLIST) == 0) {       \
671                 TAILQ_INSERT_HEAD(&_thread_list, thrd, tle);    \
672                 _thr_hash_add(thrd);                            \
673                 (thrd)->tlflags |= TLFLAGS_IN_TDLIST;           \
674         }                                                       \
675 } while (0)
676 #define THR_LIST_REMOVE(thrd) do {                              \
677         if (((thrd)->tlflags & TLFLAGS_IN_TDLIST) != 0) {       \
678                 TAILQ_REMOVE(&_thread_list, thrd, tle);         \
679                 _thr_hash_remove(thrd);                         \
680                 (thrd)->tlflags &= ~TLFLAGS_IN_TDLIST;          \
681         }                                                       \
682 } while (0)
683 #define THR_GCLIST_ADD(thrd) do {                               \
684         if (((thrd)->tlflags & TLFLAGS_IN_GCLIST) == 0) {       \
685                 TAILQ_INSERT_HEAD(&_thread_gc_list, thrd, gcle);\
686                 (thrd)->tlflags |= TLFLAGS_IN_GCLIST;           \
687                 _gc_count++;                                    \
688         }                                                       \
689 } while (0)
690 #define THR_GCLIST_REMOVE(thrd) do {                            \
691         if (((thrd)->tlflags & TLFLAGS_IN_GCLIST) != 0) {       \
692                 TAILQ_REMOVE(&_thread_gc_list, thrd, gcle);     \
693                 (thrd)->tlflags &= ~TLFLAGS_IN_GCLIST;          \
694                 _gc_count--;                                    \
695         }                                                       \
696 } while (0)
697
698 #define THR_REF_ADD(curthread, pthread) {                       \
699         THR_CRITICAL_ENTER(curthread);                          \
700         pthread->refcount++;                                    \
701 } while (0)
702
703 #define THR_REF_DEL(curthread, pthread) {                       \
704         pthread->refcount--;                                    \
705         THR_CRITICAL_LEAVE(curthread);                          \
706 } while (0)
707
708 #define GC_NEEDED()     (_gc_count >= 5)
709
710 #define SHOULD_REPORT_EVENT(curthr, e)                  \
711         (curthr->report_events &&                       \
712          (((curthr)->event_mask | _thread_event_mask ) & e) != 0)
713
714 #ifndef __LIBC_ISTHREADED_DECLARED
715 #define __LIBC_ISTHREADED_DECLARED
716 extern int __isthreaded;
717 #endif
718
719 /*
720  * Global variables for the pthread kernel.
721  */
722
723 extern char             *_usrstack __hidden;
724
725 /* For debugger */
726 extern int              _libthr_debug;
727 extern int              _thread_event_mask;
728 extern struct pthread   *_thread_last_event;
729 /* Used in symbol lookup of libthread_db */
730 extern struct pthread_key       _thread_keytable[];
731
732 /* List of all threads: */
733 extern pthreadlist      _thread_list;
734
735 /* List of threads needing GC: */
736 extern pthreadlist      _thread_gc_list __hidden;
737
738 extern int              _thread_active_threads;
739 extern atfork_head      _thr_atfork_list __hidden;
740 extern struct urwlock   _thr_atfork_lock __hidden;
741
742 /* Default thread attributes: */
743 extern struct pthread_attr _pthread_attr_default __hidden;
744
745 /* Default mutex attributes: */
746 extern struct pthread_mutex_attr _pthread_mutexattr_default __hidden;
747 extern struct pthread_mutex_attr _pthread_mutexattr_adaptive_default __hidden;
748
749 /* Default condition variable attributes: */
750 extern struct pthread_cond_attr _pthread_condattr_default __hidden;
751
752 extern struct pthread_prio _thr_priorities[] __hidden;
753
754 extern int      _thr_is_smp __hidden;
755
756 extern size_t   _thr_guard_default __hidden;
757 extern size_t   _thr_stack_default __hidden;
758 extern size_t   _thr_stack_initial __hidden;
759 extern int      _thr_page_size __hidden;
760 extern int      _thr_spinloops __hidden;
761 extern int      _thr_yieldloops __hidden;
762 extern int      _thr_queuefifo __hidden;
763
764 /* Garbage thread count. */
765 extern int      _gc_count __hidden;
766
767 extern struct umutex    _mutex_static_lock __hidden;
768 extern struct umutex    _cond_static_lock __hidden;
769 extern struct umutex    _rwlock_static_lock __hidden;
770 extern struct umutex    _keytable_lock __hidden;
771 extern struct urwlock   _thr_list_lock __hidden;
772 extern struct umutex    _thr_event_lock __hidden;
773 extern struct umutex    _suspend_all_lock __hidden;
774 extern int              _suspend_all_waiters __hidden;
775 extern int              _suspend_all_cycle __hidden;
776 extern struct pthread   *_single_thread __hidden;
777
778 extern bool             _thr_after_fork __hidden;
779
780 /*
781  * Function prototype definitions.
782  */
783 __BEGIN_DECLS
784 void    _thr_setthreaded(int) __hidden;
785 int     _mutex_cv_lock(struct pthread_mutex *, int, bool) __hidden;
786 int     _mutex_cv_unlock(struct pthread_mutex *, int *, int *) __hidden;
787 int     _mutex_cv_attach(struct pthread_mutex *, int) __hidden;
788 int     _mutex_cv_detach(struct pthread_mutex *, int *) __hidden;
789 int     _mutex_owned(struct pthread *, const struct pthread_mutex *) __hidden;
790 int     _mutex_reinit(pthread_mutex_t *) __hidden;
791 void    _mutex_fork(struct pthread *curthread) __hidden;
792 int     _mutex_enter_robust(struct pthread *curthread, struct pthread_mutex *m)
793             __hidden;
794 void    _mutex_leave_robust(struct pthread *curthread, struct pthread_mutex *m)
795             __hidden;
796 void    _libpthread_init(struct pthread *) __hidden;
797 struct pthread *_thr_alloc(struct pthread *) __hidden;
798 void    _thread_exit(const char *, int, const char *) __hidden __dead2;
799 void    _thread_exitf(const char *, int, const char *, ...) __hidden __dead2
800             __printflike(3, 4);
801 int     _thr_ref_add(struct pthread *, struct pthread *, int) __hidden;
802 void    _thr_ref_delete(struct pthread *, struct pthread *) __hidden;
803 void    _thr_ref_delete_unlocked(struct pthread *, struct pthread *) __hidden;
804 int     _thr_find_thread(struct pthread *, struct pthread *, int) __hidden;
805 void    _thr_rtld_init(void) __hidden;
806 void    _thr_rtld_postfork_child(void) __hidden;
807 int     _thr_stack_alloc(struct pthread_attr *) __hidden;
808 void    _thr_stack_free(struct pthread_attr *) __hidden;
809 void    _thr_free(struct pthread *, struct pthread *) __hidden;
810 void    _thr_gc(struct pthread *) __hidden;
811 void    _thread_cleanupspecific(void) __hidden;
812 void    _thread_printf(int, const char *, ...) __hidden __printflike(2, 3);
813 void    _thread_vprintf(int, const char *, va_list) __hidden;
814 void    _thr_spinlock_init(void) __hidden;
815 void    _thr_cancel_enter(struct pthread *) __hidden;
816 void    _thr_cancel_enter2(struct pthread *, int) __hidden;
817 void    _thr_cancel_leave(struct pthread *, int) __hidden;
818 void    _thr_testcancel(struct pthread *) __hidden;
819 void    _thr_signal_block(struct pthread *) __hidden;
820 void    _thr_signal_unblock(struct pthread *) __hidden;
821 void    _thr_signal_block_check_fast(void) __hidden;
822 void    _thr_signal_block_setup(struct pthread *) __hidden;
823 void    _thr_signal_init(int) __hidden;
824 void    _thr_signal_deinit(void) __hidden;
825 int     _thr_send_sig(struct pthread *, int sig) __hidden;
826 void    _thr_list_init(void) __hidden;
827 void    _thr_hash_add(struct pthread *) __hidden;
828 void    _thr_hash_remove(struct pthread *) __hidden;
829 struct pthread *_thr_hash_find(struct pthread *) __hidden;
830 void    _thr_link(struct pthread *, struct pthread *) __hidden;
831 void    _thr_unlink(struct pthread *, struct pthread *) __hidden;
832 void    _thr_assert_lock_level(void) __hidden __dead2;
833 void    _thr_ast(struct pthread *) __hidden;
834 void    _thr_report_creation(struct pthread *curthread,
835             struct pthread *newthread) __hidden;
836 void    _thr_report_death(struct pthread *curthread) __hidden;
837 int     _thr_getscheduler(lwpid_t, int *, struct sched_param *) __hidden;
838 int     _thr_setscheduler(lwpid_t, int, const struct sched_param *) __hidden;
839 void    _thr_signal_prefork(void) __hidden;
840 void    _thr_signal_postfork(void) __hidden;
841 void    _thr_signal_postfork_child(void) __hidden;
842 void    _thr_suspend_all_lock(struct pthread *) __hidden;
843 void    _thr_suspend_all_unlock(struct pthread *) __hidden;
844 void    _thr_try_gc(struct pthread *, struct pthread *) __hidden;
845 int     _rtp_to_schedparam(const struct rtprio *rtp, int *policy,
846                 struct sched_param *param) __hidden;
847 int     _schedparam_to_rtp(int policy, const struct sched_param *param,
848                 struct rtprio *rtp) __hidden;
849 void    _thread_bp_create(void);
850 void    _thread_bp_death(void);
851 int     _sched_yield(void);
852
853 void    _pthread_cleanup_push(void (*)(void *), void *);
854 void    _pthread_cleanup_pop(int);
855 void    _pthread_exit_mask(void *status, sigset_t *mask) __dead2 __hidden;
856 #ifndef _LIBC_PRIVATE_H_
857 void    _pthread_cancel_enter(int maycancel);
858 void    _pthread_cancel_leave(int maycancel);
859 #endif
860 int     _pthread_mutex_consistent(pthread_mutex_t * _Nonnull);
861 int     _pthread_mutexattr_getrobust(pthread_mutexattr_t * _Nonnull __restrict,
862             int * _Nonnull __restrict);
863 int     _pthread_mutexattr_setrobust(pthread_mutexattr_t * _Nonnull, int);
864
865 /* #include <fcntl.h> */
866 #ifdef  _SYS_FCNTL_H_
867 #ifndef _LIBC_PRIVATE_H_
868 int     __sys_fcntl(int, int, ...);
869 int     __sys_openat(int, const char *, int, ...);
870 #endif /* _LIBC_PRIVATE_H_ */
871 #endif /* _SYS_FCNTL_H_ */
872
873 /* #include <signal.h> */
874 #ifdef _SIGNAL_H_
875 #ifndef _LIBC_PRIVATE_H_
876 int     __sys_sigaction(int, const struct sigaction *, struct sigaction *);
877 int     __sys_sigprocmask(int, const sigset_t *, sigset_t *);
878 int     __sys_sigsuspend(const sigset_t *);
879 int     __sys_sigtimedwait(const sigset_t *, siginfo_t *,
880                 const struct timespec *);
881 int     __sys_sigwait(const sigset_t *, int *);
882 int     __sys_sigwaitinfo(const sigset_t *set, siginfo_t *info);
883 #endif /* _LIBC_PRIVATE_H_ */
884 #endif /* _SYS_FCNTL_H_ */
885
886 /* #include <time.h> */
887 #ifdef  _TIME_H_
888 #ifndef _LIBC_PRIVATE_H_
889 int     __sys_clock_nanosleep(clockid_t, int, const struct timespec *,
890             struct timespec *);
891 int     __sys_nanosleep(const struct timespec *, struct timespec *);
892 #endif /* _LIBC_PRIVATE_H_ */
893 #endif /* _SYS_FCNTL_H_ */
894
895 /* #include <sys/ucontext.h> */
896 #ifdef _SYS_UCONTEXT_H_
897 #ifndef _LIBC_PRIVATE_H_
898 int     __sys_setcontext(const ucontext_t *ucp);
899 int     __sys_swapcontext(ucontext_t *oucp, const ucontext_t *ucp);
900 #endif /* _LIBC_PRIVATE_H_ */
901 #endif /* _SYS_FCNTL_H_ */
902
903 /* #include <unistd.h> */
904 #ifdef  _UNISTD_H_
905 #ifndef _LIBC_PRIVATE_H_
906 int     __sys_close(int);
907 int     __sys_fork(void);
908 ssize_t __sys_read(int, void *, size_t);
909 #endif /* _LIBC_PRIVATE_H_ */
910 #endif /* _SYS_FCNTL_H_ */
911
912 static inline int
913 _thr_isthreaded(void)
914 {
915         return (__isthreaded != 0);
916 }
917
918 static inline int
919 _thr_is_inited(void)
920 {
921         return (_thr_initial != NULL);
922 }
923
924 static inline void
925 _thr_check_init(void)
926 {
927         if (_thr_initial == NULL)
928                 _libpthread_init(NULL);
929 }
930
931 struct wake_addr *_thr_alloc_wake_addr(void);
932 void    _thr_release_wake_addr(struct wake_addr *);
933 int     _thr_sleep(struct pthread *, int, const struct timespec *);
934
935 void _thr_wake_addr_init(void) __hidden;
936
937 static inline void
938 _thr_clear_wake(struct pthread *td)
939 {
940         td->wake_addr->value = 0;
941 }
942
943 static inline int
944 _thr_is_woken(struct pthread *td)
945 {
946         return td->wake_addr->value != 0;
947 }
948
949 static inline void
950 _thr_set_wake(unsigned int *waddr)
951 {
952         *waddr = 1;
953         _thr_umtx_wake(waddr, INT_MAX, 0);
954 }
955
956 void _thr_wake_all(unsigned int *waddrs[], int) __hidden;
957
958 static inline struct pthread *
959 _sleepq_first(struct sleepqueue *sq)
960 {
961         return TAILQ_FIRST(&sq->sq_blocked);
962 }
963
964 void    _sleepq_init(void) __hidden;
965 struct sleepqueue *_sleepq_alloc(void) __hidden;
966 void    _sleepq_free(struct sleepqueue *) __hidden;
967 void    _sleepq_lock(void *) __hidden;
968 void    _sleepq_unlock(void *) __hidden;
969 struct sleepqueue *_sleepq_lookup(void *) __hidden;
970 void    _sleepq_add(void *, struct pthread *) __hidden;
971 int     _sleepq_remove(struct sleepqueue *, struct pthread *) __hidden;
972 void    _sleepq_drop(struct sleepqueue *,
973                 void (*cb)(struct pthread *, void *arg), void *) __hidden;
974
975 int     _pthread_mutex_init_calloc_cb(pthread_mutex_t *mutex,
976             void *(calloc_cb)(size_t, size_t));
977
978 struct dl_phdr_info;
979 void __pthread_cxa_finalize(struct dl_phdr_info *phdr_info);
980 void _thr_tsd_unload(struct dl_phdr_info *phdr_info) __hidden;
981 void _thr_sigact_unload(struct dl_phdr_info *phdr_info) __hidden;
982 void _thr_stack_fix_protection(struct pthread *thrd);
983 void __pthread_distribute_static_tls(size_t offset, void *src, size_t len,
984     size_t total_len);
985
986 int *__error_threaded(void) __hidden;
987 void __thr_interpose_libc(void) __hidden;
988 pid_t __thr_fork(void);
989 pid_t __thr_pdfork(int *, int);
990 int __thr_setcontext(const ucontext_t *ucp);
991 int __thr_sigaction(int sig, const struct sigaction *act,
992     struct sigaction *oact) __hidden;
993 int __thr_sigprocmask(int how, const sigset_t *set, sigset_t *oset);
994 int __thr_sigsuspend(const sigset_t * set);
995 int __thr_sigtimedwait(const sigset_t *set, siginfo_t *info,
996     const struct timespec * timeout);
997 int __thr_sigwait(const sigset_t *set, int *sig);
998 int __thr_sigwaitinfo(const sigset_t *set, siginfo_t *info);
999 int __thr_swapcontext(ucontext_t *oucp, const ucontext_t *ucp);
1000
1001 void __thr_map_stacks_exec(void);
1002
1003 struct _spinlock;
1004 void __thr_spinunlock(struct _spinlock *lck);
1005 void __thr_spinlock(struct _spinlock *lck);
1006
1007 struct tcb *_tcb_ctor(struct pthread *, int);
1008 void    _tcb_dtor(struct tcb *);
1009
1010 void __thr_pshared_init(void) __hidden;
1011 void *__thr_pshared_offpage(void *key, int doalloc) __hidden;
1012 void __thr_pshared_destroy(void *key) __hidden;
1013 void __thr_pshared_atfork_pre(void) __hidden;
1014 void __thr_pshared_atfork_post(void) __hidden;
1015
1016 void *__thr_calloc(size_t num, size_t size);
1017 void __thr_free(void *cp);
1018 void *__thr_malloc(size_t nbytes);
1019 void *__thr_realloc(void *cp, size_t nbytes);
1020 void __thr_malloc_init(void);
1021 void __thr_malloc_prefork(struct pthread *curthread);
1022 void __thr_malloc_postfork(struct pthread *curthread);
1023
1024 int _thr_join(pthread_t, void **);
1025 int _Tthr_kill(pthread_t, int);
1026 int _thr_getthreadid_np(void);
1027 void __thr_cleanup_push_imp(void (*)(void *), void *,
1028     struct _pthread_cleanup_info *);
1029 void __thr_cleanup_pop_imp(int);
1030 void _thr_cleanup_push(void (*)(void *), void *);
1031 void _thr_cleanup_pop(int);
1032 void _Tthr_testcancel(void);
1033 void _Tthr_cancel_enter(int);
1034 void _Tthr_cancel_leave(int);
1035 int _thr_cancel(pthread_t);
1036 int _thr_atfork(void (*)(void), void (*)(void), void (*)(void));
1037 int _thr_attr_destroy(pthread_attr_t *);
1038 int _thr_attr_get_np(pthread_t, pthread_attr_t *);
1039 int _thr_attr_getdetachstate(const pthread_attr_t *, int *);
1040 int _thr_attr_getguardsize(const pthread_attr_t * __restrict,
1041     size_t * __restrict);
1042 int _thr_attr_getinheritsched(const pthread_attr_t * __restrict,
1043     int * __restrict);
1044 int _thr_attr_getschedparam(const pthread_attr_t * __restrict,
1045     struct sched_param * __restrict);
1046 int _thr_attr_getschedpolicy(const pthread_attr_t * __restrict,
1047     int * __restrict);
1048 int _thr_attr_getscope(const pthread_attr_t * __restrict, int * __restrict);
1049 int _thr_attr_getstackaddr(const pthread_attr_t *, void **);
1050 int _thr_attr_getstacksize(const pthread_attr_t * __restrict,
1051     size_t * __restrict);
1052 int _thr_attr_init(pthread_attr_t *);
1053 int _thr_attr_setdetachstate(pthread_attr_t *, int);
1054 int _thr_attr_setguardsize(pthread_attr_t *, size_t);
1055 int _thr_attr_setinheritsched(pthread_attr_t *, int);
1056 int _thr_attr_setschedparam(pthread_attr_t * __restrict,
1057     const struct sched_param * __restrict);
1058 int _thr_attr_setschedpolicy(pthread_attr_t *, int);
1059 int _thr_attr_setscope(pthread_attr_t *, int);
1060 int _thr_attr_setstackaddr(pthread_attr_t *, void *);
1061 int _thr_attr_setstacksize(pthread_attr_t *, size_t);
1062 int _thr_cond_init(pthread_cond_t * __restrict,
1063     const pthread_condattr_t * __restrict);
1064 int _thr_cond_destroy(pthread_cond_t *);
1065 int _thr_cond_timedwait(pthread_cond_t * __restrict,
1066     pthread_mutex_t * __restrict, const struct timespec * __restrict);
1067 int _thr_cond_signal(pthread_cond_t * cond);
1068 int _thr_cond_broadcast(pthread_cond_t * cond);
1069 int __thr_cond_wait(pthread_cond_t *, pthread_mutex_t *);
1070 int _thr_cond_wait(pthread_cond_t *, pthread_mutex_t *);
1071 int _thr_detach(pthread_t);
1072 int _thr_equal(pthread_t, pthread_t);
1073 void _Tthr_exit(void *);
1074 int _thr_getname_np(pthread_t, char *, size_t);
1075 int _thr_key_create(pthread_key_t *, void (*)(void *));
1076 int _thr_key_delete(pthread_key_t);
1077 int _thr_setspecific(pthread_key_t, const void *);
1078 void *_thr_getspecific(pthread_key_t);
1079 int _thr_setcancelstate(int, int *);
1080 int _thr_setcanceltype(int, int *);
1081 pthread_t _Tthr_self(void);
1082 int _thr_rwlock_init(pthread_rwlock_t *, const pthread_rwlockattr_t *);
1083 int _thr_rwlock_destroy(pthread_rwlock_t *);
1084 int _Tthr_rwlock_rdlock(pthread_rwlock_t *);
1085 int _Tthr_rwlock_tryrdlock(pthread_rwlock_t *);
1086 int _Tthr_rwlock_trywrlock(pthread_rwlock_t *);
1087 int _Tthr_rwlock_wrlock(pthread_rwlock_t *);
1088 int _Tthr_rwlock_unlock(pthread_rwlock_t *);
1089 int _thr_once(pthread_once_t *, void (*)(void));
1090 int _thr_sigmask(int, const sigset_t *, sigset_t *);
1091 int _thr_main_np(void);
1092 int _thr_mutexattr_init(pthread_mutexattr_t *);
1093 int _thr_mutexattr_destroy(pthread_mutexattr_t *);
1094 int _thr_mutexattr_settype(pthread_mutexattr_t *, int);
1095 int _thr_mutexattr_getrobust(pthread_mutexattr_t *, int *);
1096 int _thr_mutexattr_setrobust(pthread_mutexattr_t *, int);
1097 int __Tthr_mutex_init(pthread_mutex_t * __restrict,
1098     const pthread_mutexattr_t * __restrict);
1099 int _Tthr_mutex_consistent(pthread_mutex_t *);
1100 int _thr_mutex_destroy(pthread_mutex_t *);
1101 int _thr_mutex_unlock(pthread_mutex_t *);
1102 int __Tthr_mutex_lock(pthread_mutex_t *);
1103 int __Tthr_mutex_trylock(pthread_mutex_t *);
1104 bool __thr_get_main_stack_base(char **base);
1105 bool __thr_get_main_stack_lim(size_t *lim);
1106
1107 __END_DECLS
1108 __NULLABILITY_PRAGMA_POP
1109
1110 #endif  /* !_THR_PRIVATE_H */