lib/libthr/thread/thr_private.h

   1 /*
   2  * Copyright (C) 2005 Daniel M. Eischen <deischen@freebsd.org>
   3  * Copyright (c) 2005 David Xu <davidxu@freebsd.org>
   4  * Copyright (c) 1995-1998 John Birrell <jb@cimlogic.com.au>.
   5  *
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice unmodified, this list of conditions, and the following
  13  *    disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  *
  29  * $FreeBSD$
  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 #define pthread_attr_start_copy sched_policy
 265         int     sched_policy;
 266         int     sched_inherit;
 267         int     prio;
 268         int     suspend;
 269 #define THR_STACK_USER          0x100   /* 0xFF reserved for <pthread.h> */
 270         int     flags;
 271         void    *stackaddr_attr;
 272         size_t  stacksize_attr;
 273         size_t  guardsize_attr;
 274 #define pthread_attr_end_copy   cpuset
 275         cpuset_t        *cpuset;
 276         size_t  cpusetsize;
 277 };
 278
 279 struct wake_addr {
 280         struct wake_addr *link;
 281         unsigned int    value;
 282         char            pad[12];
 283 };
 284
 285 struct sleepqueue {
 286         TAILQ_HEAD(, pthread)    sq_blocked;
 287         SLIST_HEAD(, sleepqueue) sq_freeq;
 288         LIST_ENTRY(sleepqueue)   sq_hash;
 289         SLIST_ENTRY(sleepqueue)  sq_flink;
 290         void                     *sq_wchan;
 291         int                      sq_type;
 292 };
 293
 294 /*
 295  * Thread creation state attributes.
 296  */
 297 #define THR_CREATE_RUNNING              0
 298 #define THR_CREATE_SUSPENDED            1
 299
 300 /*
 301  * Miscellaneous definitions.
 302  */
 303 #define THR_STACK_DEFAULT               (sizeof(void *) / 4 * 1024 * 1024)
 304
 305 /*
 306  * Maximum size of initial thread's stack.  This perhaps deserves to be larger
 307  * than the stacks of other threads, since many applications are likely to run
 308  * almost entirely on this stack.
 309  */
 310 #define THR_STACK_INITIAL               (THR_STACK_DEFAULT * 2)
 311
 312 /*
 313  * Define priorities returned by kernel.
 314  */
 315 #define THR_MIN_PRIORITY                (_thr_priorities[SCHED_OTHER-1].pri_min)
 316 #define THR_MAX_PRIORITY                (_thr_priorities[SCHED_OTHER-1].pri_max)
 317 #define THR_DEF_PRIORITY                (_thr_priorities[SCHED_OTHER-1].pri_default)
 318
 319 #define THR_MIN_RR_PRIORITY             (_thr_priorities[SCHED_RR-1].pri_min)
 320 #define THR_MAX_RR_PRIORITY             (_thr_priorities[SCHED_RR-1].pri_max)
 321 #define THR_DEF_RR_PRIORITY             (_thr_priorities[SCHED_RR-1].pri_default)
 322
 323 /* XXX The SCHED_FIFO should have same priority range as SCHED_RR */
 324 #define THR_MIN_FIFO_PRIORITY           (_thr_priorities[SCHED_FIFO_1].pri_min)
 325 #define THR_MAX_FIFO_PRIORITY           (_thr_priorities[SCHED_FIFO-1].pri_max)
 326 #define THR_DEF_FIFO_PRIORITY           (_thr_priorities[SCHED_FIFO-1].pri_default)
 327
 328 struct pthread_prio {
 329         int     pri_min;
 330         int     pri_max;
 331         int     pri_default;
 332 };
 333
 334 struct pthread_rwlockattr {
 335         int             pshared;
 336 };
 337
 338 struct pthread_rwlock {
 339         struct urwlock  lock;
 340         uint32_t        owner;
 341 };
 342
 343 /*
 344  * Thread states.
 345  */
 346 enum pthread_state {
 347         PS_RUNNING,
 348         PS_DEAD
 349 };
 350
 351 struct pthread_specific_elem {
 352         const void      *data;
 353         int             seqno;
 354 };
 355
 356 struct pthread_key {
 357         volatile int    allocated;
 358         int             seqno;
 359         void            (*destructor)(void *);
 360 };
 361
 362 /*
 363  * lwpid_t is 32bit but kernel thr API exports tid as long type
 364  * to preserve the ABI for M:N model in very early date (r131431).
 365  */
 366 #define TID(thread)     ((uint32_t) ((thread)->tid))
 367
 368 /*
 369  * Thread structure.
 370  */
 371 struct pthread {
 372 #define _pthread_startzero      tid
 373         /* Kernel thread id. */
 374         long                    tid;
 375 #define TID_TERMINATED          1
 376
 377         /*
 378          * Lock for accesses to this thread structure.
 379          */
 380         struct umutex           lock;
 381
 382         /* Internal condition variable cycle number. */
 383         uint32_t                cycle;
 384
 385         /* How many low level locks the thread held. */
 386         int                     locklevel;
 387
 388         /*
 389          * Set to non-zero when this thread has entered a critical
 390          * region.  We allow for recursive entries into critical regions.
 391          */
 392         int                     critical_count;
 393
 394         /* Signal blocked counter. */
 395         int                     sigblock;
 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 };
 574
 575 #define THR_SHOULD_GC(thrd)                                             \
 576         ((thrd)->refcount == 0 && (thrd)->state == PS_DEAD &&           \
 577          ((thrd)->flags & THR_FLAGS_DETACHED) != 0)
 578
 579 #define THR_IN_CRITICAL(thrd)                           \
 580         (((thrd)->locklevel > 0) ||                     \
 581         ((thrd)->critical_count > 0))
 582
 583 #define THR_CRITICAL_ENTER(thrd)                        \
 584         (thrd)->critical_count++
 585
 586 #define THR_CRITICAL_LEAVE(thrd)                        \
 587         do {                                            \
 588                 (thrd)->critical_count--;               \
 589                 _thr_ast(thrd);                         \
 590         } while (0)
 591
 592 #define THR_UMUTEX_TRYLOCK(thrd, lck)                   \
 593         _thr_umutex_trylock((lck), TID(thrd))
 594
 595 #define THR_UMUTEX_LOCK(thrd, lck)                      \
 596         _thr_umutex_lock((lck), TID(thrd))
 597
 598 #define THR_UMUTEX_TIMEDLOCK(thrd, lck, timo)           \
 599         _thr_umutex_timedlock((lck), TID(thrd), (timo))
 600
 601 #define THR_UMUTEX_UNLOCK(thrd, lck)                    \
 602         _thr_umutex_unlock((lck), TID(thrd))
 603
 604 #define THR_LOCK_ACQUIRE(thrd, lck)                     \
 605 do {                                                    \
 606         (thrd)->locklevel++;                            \
 607         _thr_umutex_lock(lck, TID(thrd));               \
 608 } while (0)
 609
 610 #define THR_LOCK_ACQUIRE_SPIN(thrd, lck)                \
 611 do {                                                    \
 612         (thrd)->locklevel++;                            \
 613         _thr_umutex_lock_spin(lck, TID(thrd));          \
 614 } while (0)
 615
 616 #ifdef  _PTHREADS_INVARIANTS
 617 #define THR_ASSERT_LOCKLEVEL(thrd)                      \
 618 do {                                                    \
 619         if (__predict_false((thrd)->locklevel <= 0))    \
 620                 _thr_assert_lock_level();               \
 621 } while (0)
 622 #else
 623 #define THR_ASSERT_LOCKLEVEL(thrd)
 624 #endif
 625
 626 #define THR_LOCK_RELEASE(thrd, lck)                     \
 627 do {                                                    \
 628         THR_ASSERT_LOCKLEVEL(thrd);                     \
 629         _thr_umutex_unlock((lck), TID(thrd));           \
 630         (thrd)->locklevel--;                            \
 631         _thr_ast(thrd);                                 \
 632 } while (0)
 633
 634 #define THR_LOCK(curthrd)               THR_LOCK_ACQUIRE(curthrd, &(curthrd)->lock)
 635 #define THR_UNLOCK(curthrd)             THR_LOCK_RELEASE(curthrd, &(curthrd)->lock)
 636 #define THR_THREAD_LOCK(curthrd, thr)   THR_LOCK_ACQUIRE(curthrd, &(thr)->lock)
 637 #define THR_THREAD_UNLOCK(curthrd, thr) THR_LOCK_RELEASE(curthrd, &(thr)->lock)
 638
 639 #define THREAD_LIST_RDLOCK(curthrd)                             \
 640 do {                                                            \
 641         (curthrd)->locklevel++;                                 \
 642         _thr_rwl_rdlock(&_thr_list_lock);                       \
 643 } while (0)
 644
 645 #define THREAD_LIST_WRLOCK(curthrd)                             \
 646 do {                                                            \
 647         (curthrd)->locklevel++;                                 \
 648         _thr_rwl_wrlock(&_thr_list_lock);                       \
 649 } while (0)
 650
 651 #define THREAD_LIST_UNLOCK(curthrd)                             \
 652 do {                                                            \
 653         _thr_rwl_unlock(&_thr_list_lock);                       \
 654         (curthrd)->locklevel--;                                 \
 655         _thr_ast(curthrd);                                      \
 656 } while (0)
 657
 658 /*
 659  * Macros to insert/remove threads to the all thread list and
 660  * the gc list.
 661  */
 662 #define THR_LIST_ADD(thrd) do {                                 \
 663         if (((thrd)->tlflags & TLFLAGS_IN_TDLIST) == 0) {       \
 664                 TAILQ_INSERT_HEAD(&_thread_list, thrd, tle);    \
 665                 _thr_hash_add(thrd);                            \
 666                 (thrd)->tlflags |= TLFLAGS_IN_TDLIST;           \
 667         }                                                       \
 668 } while (0)
 669 #define THR_LIST_REMOVE(thrd) do {                              \
 670         if (((thrd)->tlflags & TLFLAGS_IN_TDLIST) != 0) {       \
 671                 TAILQ_REMOVE(&_thread_list, thrd, tle);         \
 672                 _thr_hash_remove(thrd);                         \
 673                 (thrd)->tlflags &= ~TLFLAGS_IN_TDLIST;          \
 674         }                                                       \
 675 } while (0)
 676 #define THR_GCLIST_ADD(thrd) do {                               \
 677         if (((thrd)->tlflags & TLFLAGS_IN_GCLIST) == 0) {       \
 678                 TAILQ_INSERT_HEAD(&_thread_gc_list, thrd, gcle);\
 679                 (thrd)->tlflags |= TLFLAGS_IN_GCLIST;           \
 680                 _gc_count++;                                    \
 681         }                                                       \
 682 } while (0)
 683 #define THR_GCLIST_REMOVE(thrd) do {                            \
 684         if (((thrd)->tlflags & TLFLAGS_IN_GCLIST) != 0) {       \
 685                 TAILQ_REMOVE(&_thread_gc_list, thrd, gcle);     \
 686                 (thrd)->tlflags &= ~TLFLAGS_IN_GCLIST;          \
 687                 _gc_count--;                                    \
 688         }                                                       \
 689 } while (0)
 690
 691 #define THR_REF_ADD(curthread, pthread) {                       \
 692         THR_CRITICAL_ENTER(curthread);                          \
 693         pthread->refcount++;                                    \
 694 } while (0)
 695
 696 #define THR_REF_DEL(curthread, pthread) {                       \
 697         pthread->refcount--;                                    \
 698         THR_CRITICAL_LEAVE(curthread);                          \
 699 } while (0)
 700
 701 #define GC_NEEDED()     (_gc_count >= 5)
 702
 703 #define SHOULD_REPORT_EVENT(curthr, e)                  \
 704         (curthr->report_events &&                       \
 705          (((curthr)->event_mask | _thread_event_mask ) & e) != 0)
 706
 707 #ifndef __LIBC_ISTHREADED_DECLARED
 708 #define __LIBC_ISTHREADED_DECLARED
 709 extern int __isthreaded;
 710 #endif
 711
 712 /*
 713  * Global variables for the pthread kernel.
 714  */
 715
 716 extern char             *_usrstack __hidden;
 717
 718 /* For debugger */
 719 extern int              _libthr_debug;
 720 extern int              _thread_event_mask;
 721 extern struct pthread   *_thread_last_event;
 722
 723 /* List of all threads: */
 724 extern pthreadlist      _thread_list;
 725
 726 /* List of threads needing GC: */
 727 extern pthreadlist      _thread_gc_list __hidden;
 728
 729 extern int              _thread_active_threads;
 730 extern atfork_head      _thr_atfork_list __hidden;
 731 extern struct urwlock   _thr_atfork_lock __hidden;
 732
 733 /* Default thread attributes: */
 734 extern struct pthread_attr _pthread_attr_default __hidden;
 735
 736 /* Default mutex attributes: */
 737 extern struct pthread_mutex_attr _pthread_mutexattr_default __hidden;
 738 extern struct pthread_mutex_attr _pthread_mutexattr_adaptive_default __hidden;
 739
 740 /* Default condition variable attributes: */
 741 extern struct pthread_cond_attr _pthread_condattr_default __hidden;
 742
 743 extern struct pthread_prio _thr_priorities[] __hidden;
 744
 745 extern int      _thr_is_smp __hidden;
 746
 747 extern size_t   _thr_guard_default __hidden;
 748 extern size_t   _thr_stack_default __hidden;
 749 extern size_t   _thr_stack_initial __hidden;
 750 extern int      _thr_page_size __hidden;
 751 extern int      _thr_spinloops __hidden;
 752 extern int      _thr_yieldloops __hidden;
 753 extern int      _thr_queuefifo __hidden;
 754
 755 /* Garbage thread count. */
 756 extern int      _gc_count __hidden;
 757
 758 extern struct umutex    _mutex_static_lock __hidden;
 759 extern struct umutex    _cond_static_lock __hidden;
 760 extern struct umutex    _rwlock_static_lock __hidden;
 761 extern struct umutex    _keytable_lock __hidden;
 762 extern struct urwlock   _thr_list_lock __hidden;
 763 extern struct umutex    _thr_event_lock __hidden;
 764 extern struct umutex    _suspend_all_lock __hidden;
 765 extern int              _suspend_all_waiters __hidden;
 766 extern int              _suspend_all_cycle __hidden;
 767 extern struct pthread   *_single_thread __hidden;
 768
 769 /*
 770  * Function prototype definitions.
 771  */
 772 __BEGIN_DECLS
 773 int     _thr_setthreaded(int) __hidden;
 774 int     _mutex_cv_lock(struct pthread_mutex *, int, bool) __hidden;
 775 int     _mutex_cv_unlock(struct pthread_mutex *, int *, int *) __hidden;
 776 int     _mutex_cv_attach(struct pthread_mutex *, int) __hidden;
 777 int     _mutex_cv_detach(struct pthread_mutex *, int *) __hidden;
 778 int     _mutex_owned(struct pthread *, const struct pthread_mutex *) __hidden;
 779 int     _mutex_reinit(pthread_mutex_t *) __hidden;
 780 void    _mutex_fork(struct pthread *curthread) __hidden;
 781 int     _mutex_enter_robust(struct pthread *curthread, struct pthread_mutex *m)
 782             __hidden;
 783 void    _mutex_leave_robust(struct pthread *curthread, struct pthread_mutex *m)
 784             __hidden;
 785 void    _libpthread_init(struct pthread *) __hidden;
 786 struct pthread *_thr_alloc(struct pthread *) __hidden;
 787 void    _thread_exit(const char *, int, const char *) __hidden __dead2;
 788 void    _thread_exitf(const char *, int, const char *, ...) __hidden __dead2
 789             __printflike(3, 4);
 790 int     _thr_ref_add(struct pthread *, struct pthread *, int) __hidden;
 791 void    _thr_ref_delete(struct pthread *, struct pthread *) __hidden;
 792 void    _thr_ref_delete_unlocked(struct pthread *, struct pthread *) __hidden;
 793 int     _thr_find_thread(struct pthread *, struct pthread *, int) __hidden;
 794 void    _thr_rtld_init(void) __hidden;
 795 void    _thr_rtld_postfork_child(void) __hidden;
 796 int     _thr_stack_alloc(struct pthread_attr *) __hidden;
 797 void    _thr_stack_free(struct pthread_attr *) __hidden;
 798 void    _thr_free(struct pthread *, struct pthread *) __hidden;
 799 void    _thr_gc(struct pthread *) __hidden;
 800 void    _thread_cleanupspecific(void) __hidden;
 801 void    _thread_printf(int, const char *, ...) __hidden __printflike(2, 3);
 802 void    _thread_vprintf(int, const char *, va_list) __hidden;
 803 void    _thr_spinlock_init(void) __hidden;
 804 void    _thr_cancel_enter(struct pthread *) __hidden;
 805 void    _thr_cancel_enter2(struct pthread *, int) __hidden;
 806 void    _thr_cancel_leave(struct pthread *, int) __hidden;
 807 void    _thr_testcancel(struct pthread *) __hidden;
 808 void    _thr_signal_block(struct pthread *) __hidden;
 809 void    _thr_signal_unblock(struct pthread *) __hidden;
 810 void    _thr_signal_init(int) __hidden;
 811 void    _thr_signal_deinit(void) __hidden;
 812 int     _thr_send_sig(struct pthread *, int sig) __hidden;
 813 void    _thr_list_init(void) __hidden;
 814 void    _thr_hash_add(struct pthread *) __hidden;
 815 void    _thr_hash_remove(struct pthread *) __hidden;
 816 struct pthread *_thr_hash_find(struct pthread *) __hidden;
 817 void    _thr_link(struct pthread *, struct pthread *) __hidden;
 818 void    _thr_unlink(struct pthread *, struct pthread *) __hidden;
 819 void    _thr_assert_lock_level(void) __hidden __dead2;
 820 void    _thr_ast(struct pthread *) __hidden;
 821 void    _thr_report_creation(struct pthread *curthread,
 822             struct pthread *newthread) __hidden;
 823 void    _thr_report_death(struct pthread *curthread) __hidden;
 824 int     _thr_getscheduler(lwpid_t, int *, struct sched_param *) __hidden;
 825 int     _thr_setscheduler(lwpid_t, int, const struct sched_param *) __hidden;
 826 void    _thr_signal_prefork(void) __hidden;
 827 void    _thr_signal_postfork(void) __hidden;
 828 void    _thr_signal_postfork_child(void) __hidden;
 829 void    _thr_suspend_all_lock(struct pthread *) __hidden;
 830 void    _thr_suspend_all_unlock(struct pthread *) __hidden;
 831 void    _thr_try_gc(struct pthread *, struct pthread *) __hidden;
 832 int     _rtp_to_schedparam(const struct rtprio *rtp, int *policy,
 833                 struct sched_param *param) __hidden;
 834 int     _schedparam_to_rtp(int policy, const struct sched_param *param,
 835                 struct rtprio *rtp) __hidden;
 836 void    _thread_bp_create(void);
 837 void    _thread_bp_death(void);
 838 int     _sched_yield(void);
 839
 840 void    _pthread_cleanup_push(void (*)(void *), void *);
 841 void    _pthread_cleanup_pop(int);
 842 void    _pthread_exit_mask(void *status, sigset_t *mask) __dead2 __hidden;
 843 #ifndef _LIBC_PRIVATE_H_
 844 void    _pthread_cancel_enter(int maycancel);
 845 void    _pthread_cancel_leave(int maycancel);
 846 #endif
 847 int     _pthread_mutex_consistent(pthread_mutex_t * _Nonnull);
 848 int     _pthread_mutexattr_getrobust(pthread_mutexattr_t * _Nonnull __restrict,
 849             int * _Nonnull __restrict);
 850 int     _pthread_mutexattr_setrobust(pthread_mutexattr_t * _Nonnull, int);
 851
 852 /* #include <fcntl.h> */
 853 #ifdef  _SYS_FCNTL_H_
 854 #ifndef _LIBC_PRIVATE_H_
 855 int     __sys_fcntl(int, int, ...);
 856 int     __sys_openat(int, const char *, int, ...);
 857 #endif /* _LIBC_PRIVATE_H_ */
 858 #endif /* _SYS_FCNTL_H_ */
 859
 860 /* #include <signal.h> */
 861 #ifdef _SIGNAL_H_
 862 int     __sys_kill(pid_t, int);
 863 int     __sys_sigaltstack(const struct sigaltstack *, struct sigaltstack *);
 864 int     __sys_sigpending(sigset_t *);
 865 int     __sys_sigreturn(const ucontext_t *);
 866 #ifndef _LIBC_PRIVATE_H_
 867 int     __sys_sigaction(int, const struct sigaction *, struct sigaction *);
 868 int     __sys_sigprocmask(int, const sigset_t *, sigset_t *);
 869 int     __sys_sigsuspend(const sigset_t *);
 870 int     __sys_sigtimedwait(const sigset_t *, siginfo_t *,
 871                 const struct timespec *);
 872 int     __sys_sigwait(const sigset_t *, int *);
 873 int     __sys_sigwaitinfo(const sigset_t *set, siginfo_t *info);
 874 #endif /* _LIBC_PRIVATE_H_ */
 875 #endif /* _SYS_FCNTL_H_ */
 876
 877 /* #include <time.h> */
 878 #ifdef  _TIME_H_
 879 #ifndef _LIBC_PRIVATE_H_
 880 int     __sys_clock_nanosleep(clockid_t, int, const struct timespec *,
 881             struct timespec *);
 882 int     __sys_nanosleep(const struct timespec *, struct timespec *);
 883 #endif /* _LIBC_PRIVATE_H_ */
 884 #endif /* _SYS_FCNTL_H_ */
 885
 886 /* #include <sys/ucontext.h> */
 887 #ifdef _SYS_UCONTEXT_H_
 888 #ifndef _LIBC_PRIVATE_H_
 889 int     __sys_setcontext(const ucontext_t *ucp);
 890 int     __sys_swapcontext(ucontext_t *oucp, const ucontext_t *ucp);
 891 #endif /* _LIBC_PRIVATE_H_ */
 892 #endif /* _SYS_FCNTL_H_ */
 893
 894 /* #include <unistd.h> */
 895 #ifdef  _UNISTD_H_
 896 void    __sys_exit(int);
 897 pid_t   __sys_getpid(void);
 898 #ifndef _LIBC_PRIVATE_H_
 899 int     __sys_close(int);
 900 int     __sys_fork(void);
 901 ssize_t __sys_read(int, void *, size_t);
 902 #endif /* _LIBC_PRIVATE_H_ */
 903 #endif /* _SYS_FCNTL_H_ */
 904
 905 static inline int
 906 _thr_isthreaded(void)
 907 {
 908         return (__isthreaded != 0);
 909 }
 910
 911 static inline int
 912 _thr_is_inited(void)
 913 {
 914         return (_thr_initial != NULL);
 915 }
 916
 917 static inline void
 918 _thr_check_init(void)
 919 {
 920         if (_thr_initial == NULL)
 921                 _libpthread_init(NULL);
 922 }
 923
 924 struct wake_addr *_thr_alloc_wake_addr(void);
 925 void    _thr_release_wake_addr(struct wake_addr *);
 926 int     _thr_sleep(struct pthread *, int, const struct timespec *);
 927
 928 void _thr_wake_addr_init(void) __hidden;
 929
 930 static inline void
 931 _thr_clear_wake(struct pthread *td)
 932 {
 933         td->wake_addr->value = 0;
 934 }
 935
 936 static inline int
 937 _thr_is_woken(struct pthread *td)
 938 {
 939         return td->wake_addr->value != 0;
 940 }
 941
 942 static inline void
 943 _thr_set_wake(unsigned int *waddr)
 944 {
 945         *waddr = 1;
 946         _thr_umtx_wake(waddr, INT_MAX, 0);
 947 }
 948
 949 void _thr_wake_all(unsigned int *waddrs[], int) __hidden;
 950
 951 static inline struct pthread *
 952 _sleepq_first(struct sleepqueue *sq)
 953 {
 954         return TAILQ_FIRST(&sq->sq_blocked);
 955 }
 956
 957 void    _sleepq_init(void) __hidden;
 958 struct sleepqueue *_sleepq_alloc(void) __hidden;
 959 void    _sleepq_free(struct sleepqueue *) __hidden;
 960 void    _sleepq_lock(void *) __hidden;
 961 void    _sleepq_unlock(void *) __hidden;
 962 struct sleepqueue *_sleepq_lookup(void *) __hidden;
 963 void    _sleepq_add(void *, struct pthread *) __hidden;
 964 int     _sleepq_remove(struct sleepqueue *, struct pthread *) __hidden;
 965 void    _sleepq_drop(struct sleepqueue *,
 966                 void (*cb)(struct pthread *, void *arg), void *) __hidden;
 967
 968 int     _pthread_mutex_init_calloc_cb(pthread_mutex_t *mutex,
 969             void *(calloc_cb)(size_t, size_t));
 970
 971 struct dl_phdr_info;
 972 void __pthread_cxa_finalize(struct dl_phdr_info *phdr_info);
 973 void _thr_tsd_unload(struct dl_phdr_info *phdr_info) __hidden;
 974 void _thr_sigact_unload(struct dl_phdr_info *phdr_info) __hidden;
 975 void _thr_stack_fix_protection(struct pthread *thrd);
 976
 977 int *__error_threaded(void) __hidden;
 978 void __thr_interpose_libc(void) __hidden;
 979 pid_t __thr_fork(void);
 980 int __thr_setcontext(const ucontext_t *ucp);
 981 int __thr_sigaction(int sig, const struct sigaction *act,
 982     struct sigaction *oact) __hidden;
 983 int __thr_sigprocmask(int how, const sigset_t *set, sigset_t *oset);
 984 int __thr_sigsuspend(const sigset_t * set);
 985 int __thr_sigtimedwait(const sigset_t *set, siginfo_t *info,
 986     const struct timespec * timeout);
 987 int __thr_sigwait(const sigset_t *set, int *sig);
 988 int __thr_sigwaitinfo(const sigset_t *set, siginfo_t *info);
 989 int __thr_swapcontext(ucontext_t *oucp, const ucontext_t *ucp);
 990
 991 void __thr_map_stacks_exec(void);
 992
 993 struct _spinlock;
 994 void __thr_spinunlock(struct _spinlock *lck);
 995 void __thr_spinlock(struct _spinlock *lck);
 996
 997 struct tcb *_tcb_ctor(struct pthread *, int);
 998 void    _tcb_dtor(struct tcb *);
 999
1000 void __thr_pshared_init(void) __hidden;
1001 void *__thr_pshared_offpage(void *key, int doalloc) __hidden;
1002 void __thr_pshared_destroy(void *key) __hidden;
1003 void __thr_pshared_atfork_pre(void) __hidden;
1004 void __thr_pshared_atfork_post(void) __hidden;
1005
1006 __END_DECLS
1007 __NULLABILITY_PRAGMA_POP
1008
1009 #endif  /* !_THR_PRIVATE_H */