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 <stddef.h>
  49 #include <stdio.h>
  50 #include <unistd.h>
  51 #include <ucontext.h>
  52 #include <sys/thr.h>
  53 #include <pthread.h>
  54
  55 #define SYM_FB10(sym)                   __CONCAT(sym, _fb10)
  56 #define SYM_FBP10(sym)                  __CONCAT(sym, _fbp10)
  57 #define WEAK_REF(sym, alias)            __weak_reference(sym, alias)
  58 #define SYM_COMPAT(sym, impl, ver)      __sym_compat(sym, impl, ver)
  59 #define SYM_DEFAULT(sym, impl, ver)     __sym_default(sym, impl, ver)
  60
  61 #define FB10_COMPAT(func, sym)                          \
  62         WEAK_REF(func, SYM_FB10(sym));                  \
  63         SYM_COMPAT(sym, SYM_FB10(sym), FBSD_1.0)
  64
  65 #define FB10_COMPAT_PRIVATE(func, sym)                  \
  66         WEAK_REF(func, SYM_FBP10(sym));                 \
  67         SYM_DEFAULT(sym, SYM_FBP10(sym), FBSDprivate_1.0)
  68
  69 #include "pthread_md.h"
  70 #include "thr_umtx.h"
  71 #include "thread_db.h"
  72
  73 #ifdef _PTHREAD_FORCED_UNWIND
  74 #define _BSD_SOURCE
  75 #include <unwind.h>
  76 #endif
  77
  78 typedef TAILQ_HEAD(pthreadlist, pthread) pthreadlist;
  79 typedef TAILQ_HEAD(atfork_head, pthread_atfork) atfork_head;
  80 TAILQ_HEAD(mutex_queue, pthread_mutex);
  81
  82 /* Signal to do cancellation */
  83 #define SIGCANCEL               SIGTHR
  84
  85 /*
  86  * Kernel fatal error handler macro.
  87  */
  88 #define PANIC(string)           _thread_exit(__FILE__,__LINE__,string)
  89
  90 /* Output debug messages like this: */
  91 #define stdout_debug(args...)   _thread_printf(STDOUT_FILENO, ##args)
  92 #define stderr_debug(args...)   _thread_printf(STDERR_FILENO, ##args)
  93
  94 #ifdef _PTHREADS_INVARIANTS
  95 #define THR_ASSERT(cond, msg) do {      \
  96         if (__predict_false(!(cond)))   \
  97                 PANIC(msg);             \
  98 } while (0)
  99 #else
 100 #define THR_ASSERT(cond, msg)
 101 #endif
 102
 103 #ifdef PIC
 104 # define STATIC_LIB_REQUIRE(name)
 105 #else
 106 # define STATIC_LIB_REQUIRE(name) __asm (".globl " #name)
 107 #endif
 108
 109 #define TIMESPEC_ADD(dst, src, val)                             \
 110         do {                                                    \
 111                 (dst)->tv_sec = (src)->tv_sec + (val)->tv_sec;  \
 112                 (dst)->tv_nsec = (src)->tv_nsec + (val)->tv_nsec; \
 113                 if ((dst)->tv_nsec >= 1000000000) {             \
 114                         (dst)->tv_sec++;                        \
 115                         (dst)->tv_nsec -= 1000000000;           \
 116                 }                                               \
 117         } while (0)
 118
 119 #define TIMESPEC_SUB(dst, src, val)                             \
 120         do {                                                    \
 121                 (dst)->tv_sec = (src)->tv_sec - (val)->tv_sec;  \
 122                 (dst)->tv_nsec = (src)->tv_nsec - (val)->tv_nsec; \
 123                 if ((dst)->tv_nsec < 0) {                       \
 124                         (dst)->tv_sec--;                        \
 125                         (dst)->tv_nsec += 1000000000;           \
 126                 }                                               \
 127         } while (0)
 128
 129 /* XXX These values should be same as those defined in pthread.h */
 130 #define THR_MUTEX_INITIALIZER           ((struct pthread_mutex *)NULL)
 131 #define THR_ADAPTIVE_MUTEX_INITIALIZER  ((struct pthread_mutex *)1)
 132 #define THR_MUTEX_DESTROYED             ((struct pthread_mutex *)2)
 133 #define THR_COND_INITIALIZER            ((struct pthread_cond *)NULL)
 134 #define THR_COND_DESTROYED              ((struct pthread_cond *)1)
 135 #define THR_RWLOCK_INITIALIZER          ((struct pthread_rwlock *)NULL)
 136 #define THR_RWLOCK_DESTROYED            ((struct pthread_rwlock *)1)
 137
 138 #define PMUTEX_FLAG_TYPE_MASK   0x0ff
 139 #define PMUTEX_FLAG_PRIVATE     0x100
 140 #define PMUTEX_FLAG_DEFERED     0x200
 141 #define PMUTEX_TYPE(mtxflags)   ((mtxflags) & PMUTEX_FLAG_TYPE_MASK)
 142
 143 #define MAX_DEFER_WAITERS       50
 144
 145 struct pthread_mutex {
 146         /*
 147          * Lock for accesses to this structure.
 148          */
 149         struct umutex                   m_lock;
 150         int                             m_flags;
 151         struct pthread                  *m_owner;
 152         int                             m_count;
 153         int                             m_spinloops;
 154         int                             m_yieldloops;
 155         /*
 156          * Link for all mutexes a thread currently owns.
 157          */
 158         TAILQ_ENTRY(pthread_mutex)      m_qe;
 159 };
 160
 161 struct pthread_mutex_attr {
 162         enum pthread_mutextype  m_type;
 163         int                     m_protocol;
 164         int                     m_ceiling;
 165 };
 166
 167 #define PTHREAD_MUTEXATTR_STATIC_INITIALIZER \
 168         { PTHREAD_MUTEX_DEFAULT, PTHREAD_PRIO_NONE, 0, MUTEX_FLAGS_PRIVATE }
 169
 170 struct pthread_cond {
 171         __uint32_t      __has_user_waiters;
 172         __uint32_t      __has_kern_waiters;
 173         __uint32_t      __flags;
 174         __uint32_t      __clock_id;
 175 };
 176
 177 struct pthread_cond_attr {
 178         int             c_pshared;
 179         int             c_clockid;
 180 };
 181
 182 struct pthread_barrier {
 183         struct umutex           b_lock;
 184         struct ucond            b_cv;
 185         int64_t                 b_cycle;
 186         int                     b_count;
 187         int                     b_waiters;
 188         int                     b_refcount;
 189         int                     b_destroying;
 190 };
 191
 192 struct pthread_barrierattr {
 193         int             pshared;
 194 };
 195
 196 struct pthread_spinlock {
 197         struct umutex   s_lock;
 198 };
 199
 200 /*
 201  * Flags for condition variables.
 202  */
 203 #define COND_FLAGS_PRIVATE      0x01
 204 #define COND_FLAGS_INITED       0x02
 205 #define COND_FLAGS_BUSY         0x04
 206
 207 /*
 208  * Cleanup definitions.
 209  */
 210 struct pthread_cleanup {
 211         struct pthread_cleanup  *prev;
 212         void                    (*routine)(void *);
 213         void                    *routine_arg;
 214         int                     onheap;
 215 };
 216
 217 #define THR_CLEANUP_PUSH(td, func, arg) {               \
 218         struct pthread_cleanup __cup;                   \
 219                                                         \
 220         __cup.routine = func;                           \
 221         __cup.routine_arg = arg;                        \
 222         __cup.onheap = 0;                               \
 223         __cup.prev = (td)->cleanup;                     \
 224         (td)->cleanup = &__cup;
 225
 226 #define THR_CLEANUP_POP(td, exec)                       \
 227         (td)->cleanup = __cup.prev;                     \
 228         if ((exec) != 0)                                \
 229                 __cup.routine(__cup.routine_arg);       \
 230 }
 231
 232 struct pthread_atfork {
 233         TAILQ_ENTRY(pthread_atfork) qe;
 234         void (*prepare)(void);
 235         void (*parent)(void);
 236         void (*child)(void);
 237 };
 238
 239 struct pthread_attr {
 240 #define pthread_attr_start_copy sched_policy
 241         int     sched_policy;
 242         int     sched_inherit;
 243         int     prio;
 244         int     suspend;
 245 #define THR_STACK_USER          0x100   /* 0xFF reserved for <pthread.h> */
 246         int     flags;
 247         void    *stackaddr_attr;
 248         size_t  stacksize_attr;
 249         size_t  guardsize_attr;
 250 #define pthread_attr_end_copy   cpuset
 251         cpuset_t        *cpuset;
 252         size_t  cpusetsize;
 253 };
 254
 255 struct wake_addr {
 256         struct wake_addr *link;
 257         unsigned int    value;
 258         char            pad[12];
 259 };
 260
 261 struct sleepqueue {
 262         TAILQ_HEAD(, pthread)    sq_blocked;
 263         SLIST_HEAD(, sleepqueue) sq_freeq;
 264         LIST_ENTRY(sleepqueue)   sq_hash;
 265         SLIST_ENTRY(sleepqueue)  sq_flink;
 266         void                     *sq_wchan;
 267         int                      sq_type;
 268 };
 269
 270 /*
 271  * Thread creation state attributes.
 272  */
 273 #define THR_CREATE_RUNNING              0
 274 #define THR_CREATE_SUSPENDED            1
 275
 276 /*
 277  * Miscellaneous definitions.
 278  */
 279 #define THR_STACK_DEFAULT               (sizeof(void *) / 4 * 1024 * 1024)
 280
 281 /*
 282  * Maximum size of initial thread's stack.  This perhaps deserves to be larger
 283  * than the stacks of other threads, since many applications are likely to run
 284  * almost entirely on this stack.
 285  */
 286 #define THR_STACK_INITIAL               (THR_STACK_DEFAULT * 2)
 287
 288 /*
 289  * Define priorities returned by kernel.
 290  */
 291 #define THR_MIN_PRIORITY                (_thr_priorities[SCHED_OTHER-1].pri_min)
 292 #define THR_MAX_PRIORITY                (_thr_priorities[SCHED_OTHER-1].pri_max)
 293 #define THR_DEF_PRIORITY                (_thr_priorities[SCHED_OTHER-1].pri_default)
 294
 295 #define THR_MIN_RR_PRIORITY             (_thr_priorities[SCHED_RR-1].pri_min)
 296 #define THR_MAX_RR_PRIORITY             (_thr_priorities[SCHED_RR-1].pri_max)
 297 #define THR_DEF_RR_PRIORITY             (_thr_priorities[SCHED_RR-1].pri_default)
 298
 299 /* XXX The SCHED_FIFO should have same priority range as SCHED_RR */
 300 #define THR_MIN_FIFO_PRIORITY           (_thr_priorities[SCHED_FIFO_1].pri_min)
 301 #define THR_MAX_FIFO_PRIORITY           (_thr_priorities[SCHED_FIFO-1].pri_max)
 302 #define THR_DEF_FIFO_PRIORITY           (_thr_priorities[SCHED_FIFO-1].pri_default)
 303
 304 struct pthread_prio {
 305         int     pri_min;
 306         int     pri_max;
 307         int     pri_default;
 308 };
 309
 310 struct pthread_rwlockattr {
 311         int             pshared;
 312 };
 313
 314 struct pthread_rwlock {
 315         struct urwlock  lock;
 316         struct pthread  *owner;
 317 };
 318
 319 /*
 320  * Thread states.
 321  */
 322 enum pthread_state {
 323         PS_RUNNING,
 324         PS_DEAD
 325 };
 326
 327 struct pthread_specific_elem {
 328         const void      *data;
 329         int             seqno;
 330 };
 331
 332 struct pthread_key {
 333         volatile int    allocated;
 334         int             seqno;
 335         void            (*destructor)(void *);
 336 };
 337
 338 /*
 339  * lwpid_t is 32bit but kernel thr API exports tid as long type
 340  * in very earily date.
 341  */
 342 #define TID(thread)     ((uint32_t) ((thread)->tid))
 343
 344 /*
 345  * Thread structure.
 346  */
 347 struct pthread {
 348 #define _pthread_startzero      tid
 349         /* Kernel thread id. */
 350         long                    tid;
 351 #define TID_TERMINATED          1
 352
 353         /*
 354          * Lock for accesses to this thread structure.
 355          */
 356         struct umutex           lock;
 357
 358         /* Internal condition variable cycle number. */
 359         uint32_t                cycle;
 360
 361         /* How many low level locks the thread held. */
 362         int                     locklevel;
 363
 364         /*
 365          * Set to non-zero when this thread has entered a critical
 366          * region.  We allow for recursive entries into critical regions.
 367          */
 368         int                     critical_count;
 369
 370         /* Signal blocked counter. */
 371         int                     sigblock;
 372
 373         /* Queue entry for list of all threads. */
 374         TAILQ_ENTRY(pthread)    tle;    /* link for all threads in process */
 375
 376         /* Queue entry for GC lists. */
 377         TAILQ_ENTRY(pthread)    gcle;
 378
 379         /* Hash queue entry. */
 380         LIST_ENTRY(pthread)     hle;
 381
 382         /* Sleep queue entry */
 383         TAILQ_ENTRY(pthread)    wle;
 384
 385         /* Threads reference count. */
 386         int                     refcount;
 387
 388         /*
 389          * Thread start routine, argument, stack pointer and thread
 390          * attributes.
 391          */
 392         void                    *(*start_routine)(void *);
 393         void                    *arg;
 394         struct pthread_attr     attr;
 395
 396 #define SHOULD_CANCEL(thr)                                      \
 397         ((thr)->cancel_pending && (thr)->cancel_enable &&       \
 398          (thr)->no_cancel == 0)
 399
 400         /* Cancellation is enabled */
 401         int                     cancel_enable;
 402
 403         /* Cancellation request is pending */
 404         int                     cancel_pending;
 405
 406         /* Thread is at cancellation point */
 407         int                     cancel_point;
 408
 409         /* Cancellation is temporarily disabled */
 410         int                     no_cancel;
 411
 412         /* Asynchronouse cancellation is enabled */
 413         int                     cancel_async;
 414
 415         /* Cancellation is in progress */
 416         int                     cancelling;
 417
 418         /* Thread temporary signal mask. */
 419         sigset_t                sigmask;
 420
 421         /* Thread should unblock SIGCANCEL. */
 422         int                     unblock_sigcancel;
 423
 424         /* In sigsuspend state */
 425         int                     in_sigsuspend;
 426
 427         /* deferred signal info */
 428         siginfo_t               deferred_siginfo;
 429
 430         /* signal mask to restore. */
 431         sigset_t                deferred_sigmask;
 432
 433         /* the sigaction should be used for deferred signal. */
 434         struct sigaction        deferred_sigact;
 435
 436         /* deferred signal delivery is performed, do not reenter. */
 437         int                     deferred_run;
 438
 439         /* Force new thread to exit. */
 440         int                     force_exit;
 441
 442         /* Thread state: */
 443         enum pthread_state      state;
 444
 445         /*
 446          * Error variable used instead of errno. The function __error()
 447          * returns a pointer to this.
 448          */
 449         int                     error;
 450
 451         /*
 452          * The joiner is the thread that is joining to this thread.  The
 453          * join status keeps track of a join operation to another thread.
 454          */
 455         struct pthread          *joiner;
 456
 457         /* Miscellaneous flags; only set with scheduling lock held. */
 458         int                     flags;
 459 #define THR_FLAGS_PRIVATE       0x0001
 460 #define THR_FLAGS_NEED_SUSPEND  0x0002  /* thread should be suspended */
 461 #define THR_FLAGS_SUSPENDED     0x0004  /* thread is suspended */
 462 #define THR_FLAGS_DETACHED      0x0008  /* thread is detached */
 463
 464         /* Thread list flags; only set with thread list lock held. */
 465         int                     tlflags;
 466 #define TLFLAGS_GC_SAFE         0x0001  /* thread safe for cleaning */
 467 #define TLFLAGS_IN_TDLIST       0x0002  /* thread in all thread list */
 468 #define TLFLAGS_IN_GCLIST       0x0004  /* thread in gc list */
 469
 470         /* Queue of currently owned NORMAL or PRIO_INHERIT type mutexes. */
 471         struct mutex_queue      mutexq;
 472
 473         /* Queue of all owned PRIO_PROTECT mutexes. */
 474         struct mutex_queue      pp_mutexq;
 475
 476         void                            *ret;
 477         struct pthread_specific_elem    *specific;
 478         int                             specific_data_count;
 479
 480         /* Number rwlocks rdlocks held. */
 481         int                     rdlock_count;
 482
 483         /*
 484          * Current locks bitmap for rtld. */
 485         int                     rtld_bits;
 486
 487         /* Thread control block */
 488         struct tcb              *tcb;
 489
 490         /* Cleanup handlers Link List */
 491         struct pthread_cleanup  *cleanup;
 492
 493 #ifdef _PTHREAD_FORCED_UNWIND
 494         struct _Unwind_Exception        ex;
 495         void                    *unwind_stackend;
 496         int                     unwind_disabled;
 497 #endif
 498
 499         /*
 500          * Magic value to help recognize a valid thread structure
 501          * from an invalid one:
 502          */
 503 #define THR_MAGIC               ((u_int32_t) 0xd09ba115)
 504         u_int32_t               magic;
 505
 506         /* Enable event reporting */
 507         int                     report_events;
 508
 509         /* Event mask */
 510         int                     event_mask;
 511
 512         /* Event */
 513         td_event_msg_t          event_buf;
 514
 515         /* Wait channel */
 516         void                    *wchan;
 517
 518         /* Referenced mutex. */
 519         struct pthread_mutex    *mutex_obj;
 520
 521         /* Thread will sleep. */
 522         int                     will_sleep;
 523
 524         /* Number of threads deferred. */
 525         int                     nwaiter_defer;
 526
 527         /* Deferred threads from pthread_cond_signal. */
 528         unsigned int            *defer_waiters[MAX_DEFER_WAITERS];
 529 #define _pthread_endzero        wake_addr
 530
 531         struct wake_addr        *wake_addr;
 532 #define WAKE_ADDR(td)           ((td)->wake_addr)
 533
 534         /* Sleep queue */
 535         struct  sleepqueue      *sleepqueue;
 536
 537 };
 538
 539 #define THR_SHOULD_GC(thrd)                                             \
 540         ((thrd)->refcount == 0 && (thrd)->state == PS_DEAD &&           \
 541          ((thrd)->flags & THR_FLAGS_DETACHED) != 0)
 542
 543 #define THR_IN_CRITICAL(thrd)                           \
 544         (((thrd)->locklevel > 0) ||                     \
 545         ((thrd)->critical_count > 0))
 546
 547 #define THR_CRITICAL_ENTER(thrd)                        \
 548         (thrd)->critical_count++
 549
 550 #define THR_CRITICAL_LEAVE(thrd)                        \
 551         do {                                            \
 552                 (thrd)->critical_count--;               \
 553                 _thr_ast(thrd);                         \
 554         } while (0)
 555
 556 #define THR_UMUTEX_TRYLOCK(thrd, lck)                   \
 557         _thr_umutex_trylock((lck), TID(thrd))
 558
 559 #define THR_UMUTEX_LOCK(thrd, lck)                      \
 560         _thr_umutex_lock((lck), TID(thrd))
 561
 562 #define THR_UMUTEX_TIMEDLOCK(thrd, lck, timo)           \
 563         _thr_umutex_timedlock((lck), TID(thrd), (timo))
 564
 565 #define THR_UMUTEX_UNLOCK(thrd, lck)                    \
 566         _thr_umutex_unlock((lck), TID(thrd))
 567
 568 #define THR_LOCK_ACQUIRE(thrd, lck)                     \
 569 do {                                                    \
 570         (thrd)->locklevel++;                            \
 571         _thr_umutex_lock(lck, TID(thrd));               \
 572 } while (0)
 573
 574 #define THR_LOCK_ACQUIRE_SPIN(thrd, lck)                \
 575 do {                                                    \
 576         (thrd)->locklevel++;                            \
 577         _thr_umutex_lock_spin(lck, TID(thrd));          \
 578 } while (0)
 579
 580 #ifdef  _PTHREADS_INVARIANTS
 581 #define THR_ASSERT_LOCKLEVEL(thrd)                      \
 582 do {                                                    \
 583         if (__predict_false((thrd)->locklevel <= 0))    \
 584                 _thr_assert_lock_level();               \
 585 } while (0)
 586 #else
 587 #define THR_ASSERT_LOCKLEVEL(thrd)
 588 #endif
 589
 590 #define THR_LOCK_RELEASE(thrd, lck)                     \
 591 do {                                                    \
 592         THR_ASSERT_LOCKLEVEL(thrd);                     \
 593         _thr_umutex_unlock((lck), TID(thrd));           \
 594         (thrd)->locklevel--;                            \
 595         _thr_ast(thrd);                                 \
 596 } while (0)
 597
 598 #define THR_LOCK(curthrd)               THR_LOCK_ACQUIRE(curthrd, &(curthrd)->lock)
 599 #define THR_UNLOCK(curthrd)             THR_LOCK_RELEASE(curthrd, &(curthrd)->lock)
 600 #define THR_THREAD_LOCK(curthrd, thr)   THR_LOCK_ACQUIRE(curthrd, &(thr)->lock)
 601 #define THR_THREAD_UNLOCK(curthrd, thr) THR_LOCK_RELEASE(curthrd, &(thr)->lock)
 602
 603 #define THREAD_LIST_RDLOCK(curthrd)                             \
 604 do {                                                            \
 605         (curthrd)->locklevel++;                                 \
 606         _thr_rwl_rdlock(&_thr_list_lock);                       \
 607 } while (0)
 608
 609 #define THREAD_LIST_WRLOCK(curthrd)                             \
 610 do {                                                            \
 611         (curthrd)->locklevel++;                                 \
 612         _thr_rwl_wrlock(&_thr_list_lock);                       \
 613 } while (0)
 614
 615 #define THREAD_LIST_UNLOCK(curthrd)                             \
 616 do {                                                            \
 617         _thr_rwl_unlock(&_thr_list_lock);                       \
 618         (curthrd)->locklevel--;                                 \
 619         _thr_ast(curthrd);                                      \
 620 } while (0)
 621
 622 /*
 623  * Macros to insert/remove threads to the all thread list and
 624  * the gc list.
 625  */
 626 #define THR_LIST_ADD(thrd) do {                                 \
 627         if (((thrd)->tlflags & TLFLAGS_IN_TDLIST) == 0) {       \
 628                 TAILQ_INSERT_HEAD(&_thread_list, thrd, tle);    \
 629                 _thr_hash_add(thrd);                            \
 630                 (thrd)->tlflags |= TLFLAGS_IN_TDLIST;           \
 631         }                                                       \
 632 } while (0)
 633 #define THR_LIST_REMOVE(thrd) do {                              \
 634         if (((thrd)->tlflags & TLFLAGS_IN_TDLIST) != 0) {       \
 635                 TAILQ_REMOVE(&_thread_list, thrd, tle);         \
 636                 _thr_hash_remove(thrd);                         \
 637                 (thrd)->tlflags &= ~TLFLAGS_IN_TDLIST;          \
 638         }                                                       \
 639 } while (0)
 640 #define THR_GCLIST_ADD(thrd) do {                               \
 641         if (((thrd)->tlflags & TLFLAGS_IN_GCLIST) == 0) {       \
 642                 TAILQ_INSERT_HEAD(&_thread_gc_list, thrd, gcle);\
 643                 (thrd)->tlflags |= TLFLAGS_IN_GCLIST;           \
 644                 _gc_count++;                                    \
 645         }                                                       \
 646 } while (0)
 647 #define THR_GCLIST_REMOVE(thrd) do {                            \
 648         if (((thrd)->tlflags & TLFLAGS_IN_GCLIST) != 0) {       \
 649                 TAILQ_REMOVE(&_thread_gc_list, thrd, gcle);     \
 650                 (thrd)->tlflags &= ~TLFLAGS_IN_GCLIST;          \
 651                 _gc_count--;                                    \
 652         }                                                       \
 653 } while (0)
 654
 655 #define THR_REF_ADD(curthread, pthread) {                       \
 656         THR_CRITICAL_ENTER(curthread);                          \
 657         pthread->refcount++;                                    \
 658 } while (0)
 659
 660 #define THR_REF_DEL(curthread, pthread) {                       \
 661         pthread->refcount--;                                    \
 662         THR_CRITICAL_LEAVE(curthread);                          \
 663 } while (0)
 664
 665 #define GC_NEEDED()     (_gc_count >= 5)
 666
 667 #define SHOULD_REPORT_EVENT(curthr, e)                  \
 668         (curthr->report_events &&                       \
 669          (((curthr)->event_mask | _thread_event_mask ) & e) != 0)
 670
 671 extern int __isthreaded;
 672
 673 /*
 674  * Global variables for the pthread kernel.
 675  */
 676
 677 extern char             *_usrstack __hidden;
 678 extern struct pthread   *_thr_initial __hidden;
 679
 680 /* For debugger */
 681 extern int              _libthr_debug;
 682 extern int              _thread_event_mask;
 683 extern struct pthread   *_thread_last_event;
 684
 685 /* List of all threads: */
 686 extern pthreadlist      _thread_list;
 687
 688 /* List of threads needing GC: */
 689 extern pthreadlist      _thread_gc_list __hidden;
 690
 691 extern int              _thread_active_threads;
 692 extern atfork_head      _thr_atfork_list __hidden;
 693 extern struct urwlock   _thr_atfork_lock __hidden;
 694
 695 /* Default thread attributes: */
 696 extern struct pthread_attr _pthread_attr_default __hidden;
 697
 698 /* Default mutex attributes: */
 699 extern struct pthread_mutex_attr _pthread_mutexattr_default __hidden;
 700 extern struct pthread_mutex_attr _pthread_mutexattr_adaptive_default __hidden;
 701
 702 /* Default condition variable attributes: */
 703 extern struct pthread_cond_attr _pthread_condattr_default __hidden;
 704
 705 extern struct pthread_prio _thr_priorities[] __hidden;
 706
 707 extern pid_t    _thr_pid __hidden;
 708 extern int      _thr_is_smp __hidden;
 709
 710 extern size_t   _thr_guard_default __hidden;
 711 extern size_t   _thr_stack_default __hidden;
 712 extern size_t   _thr_stack_initial __hidden;
 713 extern int      _thr_page_size __hidden;
 714 extern int      _thr_spinloops __hidden;
 715 extern int      _thr_yieldloops __hidden;
 716 extern int      _thr_queuefifo __hidden;
 717
 718 /* Garbage thread count. */
 719 extern int      _gc_count __hidden;
 720
 721 extern struct umutex    _mutex_static_lock __hidden;
 722 extern struct umutex    _cond_static_lock __hidden;
 723 extern struct umutex    _rwlock_static_lock __hidden;
 724 extern struct umutex    _keytable_lock __hidden;
 725 extern struct urwlock   _thr_list_lock __hidden;
 726 extern struct umutex    _thr_event_lock __hidden;
 727 extern struct umutex    _suspend_all_lock __hidden;
 728 extern int              _suspend_all_waiters __hidden;
 729 extern int              _suspend_all_cycle __hidden;
 730 extern struct pthread   *_single_thread __hidden;
 731
 732 /*
 733  * Function prototype definitions.
 734  */
 735 __BEGIN_DECLS
 736 int     _thr_setthreaded(int) __hidden;
 737 int     _mutex_cv_lock(struct pthread_mutex *, int) __hidden;
 738 int     _mutex_cv_unlock(struct pthread_mutex *, int *, int *) __hidden;
 739 int     _mutex_cv_attach(struct pthread_mutex *, int) __hidden;
 740 int     _mutex_cv_detach(struct pthread_mutex *, int *) __hidden;
 741 int     _mutex_owned(struct pthread *, const struct pthread_mutex *) __hidden;
 742 int     _mutex_reinit(pthread_mutex_t *) __hidden;
 743 void    _mutex_fork(struct pthread *curthread) __hidden;
 744 void    _libpthread_init(struct pthread *) __hidden;
 745 struct pthread *_thr_alloc(struct pthread *) __hidden;
 746 void    _thread_exit(const char *, int, const char *) __hidden __dead2;
 747 int     _thr_ref_add(struct pthread *, struct pthread *, int) __hidden;
 748 void    _thr_ref_delete(struct pthread *, struct pthread *) __hidden;
 749 void    _thr_ref_delete_unlocked(struct pthread *, struct pthread *) __hidden;
 750 int     _thr_find_thread(struct pthread *, struct pthread *, int) __hidden;
 751 void    _thr_rtld_init(void) __hidden;
 752 void    _thr_rtld_postfork_child(void) __hidden;
 753 int     _thr_stack_alloc(struct pthread_attr *) __hidden;
 754 void    _thr_stack_free(struct pthread_attr *) __hidden;
 755 void    _thr_free(struct pthread *, struct pthread *) __hidden;
 756 void    _thr_gc(struct pthread *) __hidden;
 757 void    _thread_cleanupspecific(void) __hidden;
 758 void    _thread_printf(int, const char *, ...) __hidden;
 759 void    _thr_spinlock_init(void) __hidden;
 760 void    _thr_cancel_enter(struct pthread *) __hidden;
 761 void    _thr_cancel_enter2(struct pthread *, int) __hidden;
 762 void    _thr_cancel_leave(struct pthread *, int) __hidden;
 763 void    _thr_testcancel(struct pthread *) __hidden;
 764 void    _thr_signal_block(struct pthread *) __hidden;
 765 void    _thr_signal_unblock(struct pthread *) __hidden;
 766 void    _thr_signal_init(void) __hidden;
 767 void    _thr_signal_deinit(void) __hidden;
 768 int     _thr_send_sig(struct pthread *, int sig) __hidden;
 769 void    _thr_list_init(void) __hidden;
 770 void    _thr_hash_add(struct pthread *) __hidden;
 771 void    _thr_hash_remove(struct pthread *) __hidden;
 772 struct pthread *_thr_hash_find(struct pthread *) __hidden;
 773 void    _thr_link(struct pthread *, struct pthread *) __hidden;
 774 void    _thr_unlink(struct pthread *, struct pthread *) __hidden;
 775 void    _thr_assert_lock_level(void) __hidden __dead2;
 776 void    _thr_ast(struct pthread *) __hidden;
 777 void    _thr_once_init(void) __hidden;
 778 void    _thr_report_creation(struct pthread *curthread,
 779             struct pthread *newthread) __hidden;
 780 void    _thr_report_death(struct pthread *curthread) __hidden;
 781 int     _thr_getscheduler(lwpid_t, int *, struct sched_param *) __hidden;
 782 int     _thr_setscheduler(lwpid_t, int, const struct sched_param *) __hidden;
 783 void    _thr_signal_prefork(void) __hidden;
 784 void    _thr_signal_postfork(void) __hidden;
 785 void    _thr_signal_postfork_child(void) __hidden;
 786 void    _thr_suspend_all_lock(struct pthread *) __hidden;
 787 void    _thr_suspend_all_unlock(struct pthread *) __hidden;
 788 void    _thr_try_gc(struct pthread *, struct pthread *) __hidden;
 789 int     _rtp_to_schedparam(const struct rtprio *rtp, int *policy,
 790                 struct sched_param *param) __hidden;
 791 int     _schedparam_to_rtp(int policy, const struct sched_param *param,
 792                 struct rtprio *rtp) __hidden;
 793 void    _thread_bp_create(void);
 794 void    _thread_bp_death(void);
 795 int     _sched_yield(void);
 796
 797 void    _pthread_cleanup_push(void (*)(void *), void *);
 798 void    _pthread_cleanup_pop(int);
 799 void    _pthread_exit_mask(void *status, sigset_t *mask) __dead2 __hidden;
 800 void    _pthread_cancel_enter(int maycancel);
 801 void    _pthread_cancel_leave(int maycancel);
 802
 803 /* #include <fcntl.h> */
 804 #ifdef  _SYS_FCNTL_H_
 805 int     __sys_fcntl(int, int, ...);
 806 int     __sys_open(const char *, int, ...);
 807 int     __sys_openat(int, const char *, int, ...);
 808 #endif
 809
 810 /* #include <signal.h> */
 811 #ifdef _SIGNAL_H_
 812 int     __sys_kill(pid_t, int);
 813 int     __sys_sigaction(int, const struct sigaction *, struct sigaction *);
 814 int     __sys_sigpending(sigset_t *);
 815 int     __sys_sigprocmask(int, const sigset_t *, sigset_t *);
 816 int     __sys_sigsuspend(const sigset_t *);
 817 int     __sys_sigreturn(const ucontext_t *);
 818 int     __sys_sigaltstack(const struct sigaltstack *, struct sigaltstack *);
 819 int     __sys_sigwait(const sigset_t *, int *);
 820 int     __sys_sigtimedwait(const sigset_t *, siginfo_t *,
 821                 const struct timespec *);
 822 int     __sys_sigwaitinfo(const sigset_t *set, siginfo_t *info);
 823 #endif
 824
 825 /* #include <time.h> */
 826 #ifdef  _TIME_H_
 827 int     __sys_nanosleep(const struct timespec *, struct timespec *);
 828 #endif
 829
 830 /* #include <sys/ucontext.h> */
 831 #ifdef _SYS_UCONTEXT_H_
 832 int     __sys_setcontext(const ucontext_t *ucp);
 833 int     __sys_swapcontext(ucontext_t *oucp, const ucontext_t *ucp);
 834 #endif
 835
 836 /* #include <unistd.h> */
 837 #ifdef  _UNISTD_H_
 838 int     __sys_close(int);
 839 int     __sys_fork(void);
 840 pid_t   __sys_getpid(void);
 841 ssize_t __sys_read(int, void *, size_t);
 842 ssize_t __sys_write(int, const void *, size_t);
 843 void    __sys_exit(int);
 844 #endif
 845
 846 static inline int
 847 _thr_isthreaded(void)
 848 {
 849         return (__isthreaded != 0);
 850 }
 851
 852 static inline int
 853 _thr_is_inited(void)
 854 {
 855         return (_thr_initial != NULL);
 856 }
 857
 858 static inline void
 859 _thr_check_init(void)
 860 {
 861         if (_thr_initial == NULL)
 862                 _libpthread_init(NULL);
 863 }
 864
 865 struct wake_addr *_thr_alloc_wake_addr(void);
 866 void    _thr_release_wake_addr(struct wake_addr *);
 867 int     _thr_sleep(struct pthread *, int, const struct timespec *);
 868
 869 void _thr_wake_addr_init(void) __hidden;
 870
 871 static inline void
 872 _thr_clear_wake(struct pthread *td)
 873 {
 874         td->wake_addr->value = 0;
 875 }
 876
 877 static inline int
 878 _thr_is_woken(struct pthread *td)
 879 {
 880         return td->wake_addr->value != 0;
 881 }
 882
 883 static inline void
 884 _thr_set_wake(unsigned int *waddr)
 885 {
 886         *waddr = 1;
 887         _thr_umtx_wake(waddr, INT_MAX, 0);
 888 }
 889
 890 void _thr_wake_all(unsigned int *waddrs[], int) __hidden;
 891
 892 static inline struct pthread *
 893 _sleepq_first(struct sleepqueue *sq)
 894 {
 895         return TAILQ_FIRST(&sq->sq_blocked);
 896 }
 897
 898 void    _sleepq_init(void) __hidden;
 899 struct sleepqueue *_sleepq_alloc(void) __hidden;
 900 void    _sleepq_free(struct sleepqueue *) __hidden;
 901 void    _sleepq_lock(void *) __hidden;
 902 void    _sleepq_unlock(void *) __hidden;
 903 struct sleepqueue *_sleepq_lookup(void *) __hidden;
 904 void    _sleepq_add(void *, struct pthread *) __hidden;
 905 int     _sleepq_remove(struct sleepqueue *, struct pthread *) __hidden;
 906 void    _sleepq_drop(struct sleepqueue *,
 907                 void (*cb)(struct pthread *, void *arg), void *) __hidden;
 908
 909 struct dl_phdr_info;
 910 void __pthread_cxa_finalize(struct dl_phdr_info *phdr_info);
 911 void _thr_tsd_unload(struct dl_phdr_info *phdr_info) __hidden;
 912 void _thr_sigact_unload(struct dl_phdr_info *phdr_info) __hidden;
 913 void _thr_stack_fix_protection(struct pthread *thrd);
 914
 915 __END_DECLS
 916
 917 #endif  /* !_THR_PRIVATE_H */