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 #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 /* Fast sigblock var. */ 398 uint32_t fsigblock; 399 400 /* Queue entry for list of all threads. */ 401 TAILQ_ENTRY(pthread) tle; /* link for all threads in process */ 402 403 /* Queue entry for GC lists. */ 404 TAILQ_ENTRY(pthread) gcle; 405 406 /* Hash queue entry. */ 407 LIST_ENTRY(pthread) hle; 408 409 /* Sleep queue entry */ 410 TAILQ_ENTRY(pthread) wle; 411 412 /* Threads reference count. */ 413 int refcount; 414 415 /* 416 * Thread start routine, argument, stack pointer and thread 417 * attributes. 418 */ 419 void *(*start_routine)(void *); 420 void *arg; 421 struct pthread_attr attr; 422 423 #define SHOULD_CANCEL(thr) \ 424 ((thr)->cancel_pending && (thr)->cancel_enable && \ 425 (thr)->no_cancel == 0) 426 427 /* Cancellation is enabled */ 428 int cancel_enable; 429 430 /* Cancellation request is pending */ 431 int cancel_pending; 432 433 /* Thread is at cancellation point */ 434 int cancel_point; 435 436 /* Cancellation is temporarily disabled */ 437 int no_cancel; 438 439 /* Asynchronouse cancellation is enabled */ 440 int cancel_async; 441 442 /* Cancellation is in progress */ 443 int cancelling; 444 445 /* Thread temporary signal mask. */ 446 sigset_t sigmask; 447 448 /* Thread should unblock SIGCANCEL. */ 449 int unblock_sigcancel; 450 451 /* In sigsuspend state */ 452 int in_sigsuspend; 453 454 /* deferred signal info */ 455 siginfo_t deferred_siginfo; 456 457 /* signal mask to restore. */ 458 sigset_t deferred_sigmask; 459 460 /* the sigaction should be used for deferred signal. */ 461 struct sigaction deferred_sigact; 462 463 /* deferred signal delivery is performed, do not reenter. */ 464 int deferred_run; 465 466 /* Force new thread to exit. */ 467 int force_exit; 468 469 /* Thread state: */ 470 enum pthread_state state; 471 472 /* 473 * Error variable used instead of errno. The function __error() 474 * returns a pointer to this. 475 */ 476 int error; 477 478 /* 479 * The joiner is the thread that is joining to this thread. The 480 * join status keeps track of a join operation to another thread. 481 */ 482 struct pthread *joiner; 483 484 /* Miscellaneous flags; only set with scheduling lock held. */ 485 int flags; 486 #define THR_FLAGS_PRIVATE 0x0001 487 #define THR_FLAGS_NEED_SUSPEND 0x0002 /* thread should be suspended */ 488 #define THR_FLAGS_SUSPENDED 0x0004 /* thread is suspended */ 489 #define THR_FLAGS_DETACHED 0x0008 /* thread is detached */ 490 491 /* Thread list flags; only set with thread list lock held. */ 492 int tlflags; 493 #define TLFLAGS_GC_SAFE 0x0001 /* thread safe for cleaning */ 494 #define TLFLAGS_IN_TDLIST 0x0002 /* thread in all thread list */ 495 #define TLFLAGS_IN_GCLIST 0x0004 /* thread in gc list */ 496 497 /* 498 * Queues of the owned mutexes. Private queue must have index 499 * + 1 of the corresponding full queue. 500 */ 501 #define TMQ_NORM 0 /* NORMAL or PRIO_INHERIT normal */ 502 #define TMQ_NORM_PRIV 1 /* NORMAL or PRIO_INHERIT normal priv */ 503 #define TMQ_NORM_PP 2 /* PRIO_PROTECT normal mutexes */ 504 #define TMQ_NORM_PP_PRIV 3 /* PRIO_PROTECT normal priv */ 505 #define TMQ_ROBUST_PP 4 /* PRIO_PROTECT robust mutexes */ 506 #define TMQ_ROBUST_PP_PRIV 5 /* PRIO_PROTECT robust priv */ 507 #define TMQ_NITEMS 6 508 struct mutex_queue mq[TMQ_NITEMS]; 509 510 void *ret; 511 struct pthread_specific_elem *specific; 512 int specific_data_count; 513 514 /* Number rwlocks rdlocks held. */ 515 int rdlock_count; 516 517 /* 518 * Current locks bitmap for rtld. */ 519 int rtld_bits; 520 521 /* Thread control block */ 522 struct tcb *tcb; 523 524 /* Cleanup handlers Link List */ 525 struct pthread_cleanup *cleanup; 526 527 #ifdef _PTHREAD_FORCED_UNWIND 528 struct _Unwind_Exception ex; 529 void *unwind_stackend; 530 int unwind_disabled; 531 #endif 532 533 /* 534 * Magic value to help recognize a valid thread structure 535 * from an invalid one: 536 */ 537 #define THR_MAGIC ((u_int32_t) 0xd09ba115) 538 u_int32_t magic; 539 540 /* Enable event reporting */ 541 int report_events; 542 543 /* Event mask */ 544 int event_mask; 545 546 /* Event */ 547 td_event_msg_t event_buf; 548 549 /* Wait channel */ 550 void *wchan; 551 552 /* Referenced mutex. */ 553 struct pthread_mutex *mutex_obj; 554 555 /* Thread will sleep. */ 556 int will_sleep; 557 558 /* Number of threads deferred. */ 559 int nwaiter_defer; 560 561 int robust_inited; 562 uintptr_t robust_list; 563 uintptr_t priv_robust_list; 564 uintptr_t inact_mtx; 565 566 /* Deferred threads from pthread_cond_signal. */ 567 unsigned int *defer_waiters[MAX_DEFER_WAITERS]; 568 #define _pthread_endzero wake_addr 569 570 struct wake_addr *wake_addr; 571 #define WAKE_ADDR(td) ((td)->wake_addr) 572 573 /* Sleep queue */ 574 struct sleepqueue *sleepqueue; 575 576 /* pthread_set/get_name_np */ 577 char *name; 578 579 /* rtld thread-local dlerror message and seen control */ 580 char dlerror_msg[512]; 581 int dlerror_seen; 582 }; 583 584 #define THR_SHOULD_GC(thrd) \ 585 ((thrd)->refcount == 0 && (thrd)->state == PS_DEAD && \ 586 ((thrd)->flags & THR_FLAGS_DETACHED) != 0) 587 588 #define THR_IN_CRITICAL(thrd) \ 589 (((thrd)->locklevel > 0) || \ 590 ((thrd)->critical_count > 0)) 591 592 #define THR_CRITICAL_ENTER(thrd) \ 593 (thrd)->critical_count++ 594 595 #define THR_CRITICAL_LEAVE(thrd) \ 596 do { \ 597 (thrd)->critical_count--; \ 598 _thr_ast(thrd); \ 599 } while (0) 600 601 #define THR_UMUTEX_TRYLOCK(thrd, lck) \ 602 _thr_umutex_trylock((lck), TID(thrd)) 603 604 #define THR_UMUTEX_LOCK(thrd, lck) \ 605 _thr_umutex_lock((lck), TID(thrd)) 606 607 #define THR_UMUTEX_TIMEDLOCK(thrd, lck, timo) \ 608 _thr_umutex_timedlock((lck), TID(thrd), (timo)) 609 610 #define THR_UMUTEX_UNLOCK(thrd, lck) \ 611 _thr_umutex_unlock((lck), TID(thrd)) 612 613 #define THR_LOCK_ACQUIRE(thrd, lck) \ 614 do { \ 615 (thrd)->locklevel++; \ 616 _thr_umutex_lock(lck, TID(thrd)); \ 617 } while (0) 618 619 #define THR_LOCK_ACQUIRE_SPIN(thrd, lck) \ 620 do { \ 621 (thrd)->locklevel++; \ 622 _thr_umutex_lock_spin(lck, TID(thrd)); \ 623 } while (0) 624 625 #ifdef _PTHREADS_INVARIANTS 626 #define THR_ASSERT_LOCKLEVEL(thrd) \ 627 do { \ 628 if (__predict_false((thrd)->locklevel <= 0)) \ 629 _thr_assert_lock_level(); \ 630 } while (0) 631 #else 632 #define THR_ASSERT_LOCKLEVEL(thrd) 633 #endif 634 635 #define THR_LOCK_RELEASE(thrd, lck) \ 636 do { \ 637 THR_ASSERT_LOCKLEVEL(thrd); \ 638 _thr_umutex_unlock((lck), TID(thrd)); \ 639 (thrd)->locklevel--; \ 640 _thr_ast(thrd); \ 641 } while (0) 642 643 #define THR_LOCK(curthrd) THR_LOCK_ACQUIRE(curthrd, &(curthrd)->lock) 644 #define THR_UNLOCK(curthrd) THR_LOCK_RELEASE(curthrd, &(curthrd)->lock) 645 #define THR_THREAD_LOCK(curthrd, thr) THR_LOCK_ACQUIRE(curthrd, &(thr)->lock) 646 #define THR_THREAD_UNLOCK(curthrd, thr) THR_LOCK_RELEASE(curthrd, &(thr)->lock) 647 648 #define THREAD_LIST_RDLOCK(curthrd) \ 649 do { \ 650 (curthrd)->locklevel++; \ 651 _thr_rwl_rdlock(&_thr_list_lock); \ 652 } while (0) 653 654 #define THREAD_LIST_WRLOCK(curthrd) \ 655 do { \ 656 (curthrd)->locklevel++; \ 657 _thr_rwl_wrlock(&_thr_list_lock); \ 658 } while (0) 659 660 #define THREAD_LIST_UNLOCK(curthrd) \ 661 do { \ 662 _thr_rwl_unlock(&_thr_list_lock); \ 663 (curthrd)->locklevel--; \ 664 _thr_ast(curthrd); \ 665 } while (0) 666 667 /* 668 * Macros to insert/remove threads to the all thread list and 669 * the gc list. 670 */ 671 #define THR_LIST_ADD(thrd) do { \ 672 if (((thrd)->tlflags & TLFLAGS_IN_TDLIST) == 0) { \ 673 TAILQ_INSERT_HEAD(&_thread_list, thrd, tle); \ 674 _thr_hash_add(thrd); \ 675 (thrd)->tlflags |= TLFLAGS_IN_TDLIST; \ 676 } \ 677 } while (0) 678 #define THR_LIST_REMOVE(thrd) do { \ 679 if (((thrd)->tlflags & TLFLAGS_IN_TDLIST) != 0) { \ 680 TAILQ_REMOVE(&_thread_list, thrd, tle); \ 681 _thr_hash_remove(thrd); \ 682 (thrd)->tlflags &= ~TLFLAGS_IN_TDLIST; \ 683 } \ 684 } while (0) 685 #define THR_GCLIST_ADD(thrd) do { \ 686 if (((thrd)->tlflags & TLFLAGS_IN_GCLIST) == 0) { \ 687 TAILQ_INSERT_HEAD(&_thread_gc_list, thrd, gcle);\ 688 (thrd)->tlflags |= TLFLAGS_IN_GCLIST; \ 689 _gc_count++; \ 690 } \ 691 } while (0) 692 #define THR_GCLIST_REMOVE(thrd) do { \ 693 if (((thrd)->tlflags & TLFLAGS_IN_GCLIST) != 0) { \ 694 TAILQ_REMOVE(&_thread_gc_list, thrd, gcle); \ 695 (thrd)->tlflags &= ~TLFLAGS_IN_GCLIST; \ 696 _gc_count--; \ 697 } \ 698 } while (0) 699 700 #define THR_REF_ADD(curthread, pthread) { \ 701 THR_CRITICAL_ENTER(curthread); \ 702 pthread->refcount++; \ 703 } while (0) 704 705 #define THR_REF_DEL(curthread, pthread) { \ 706 pthread->refcount--; \ 707 THR_CRITICAL_LEAVE(curthread); \ 708 } while (0) 709 710 #define GC_NEEDED() (_gc_count >= 5) 711 712 #define SHOULD_REPORT_EVENT(curthr, e) \ 713 (curthr->report_events && \ 714 (((curthr)->event_mask | _thread_event_mask ) & e) != 0) 715 716 #ifndef __LIBC_ISTHREADED_DECLARED 717 #define __LIBC_ISTHREADED_DECLARED 718 extern int __isthreaded; 719 #endif 720 721 /* 722 * Global variables for the pthread kernel. 723 */ 724 725 extern char *_usrstack __hidden; 726 727 /* For debugger */ 728 extern int _libthr_debug; 729 extern int _thread_event_mask; 730 extern struct pthread *_thread_last_event; 731 /* Used in symbol lookup of libthread_db */ 732 extern struct pthread_key _thread_keytable[]; 733 734 /* List of all threads: */ 735 extern pthreadlist _thread_list; 736 737 /* List of threads needing GC: */ 738 extern pthreadlist _thread_gc_list __hidden; 739 740 extern int _thread_active_threads; 741 extern atfork_head _thr_atfork_list __hidden; 742 extern struct urwlock _thr_atfork_lock __hidden; 743 744 /* Default thread attributes: */ 745 extern struct pthread_attr _pthread_attr_default __hidden; 746 747 /* Default mutex attributes: */ 748 extern struct pthread_mutex_attr _pthread_mutexattr_default __hidden; 749 extern struct pthread_mutex_attr _pthread_mutexattr_adaptive_default __hidden; 750 751 /* Default condition variable attributes: */ 752 extern struct pthread_cond_attr _pthread_condattr_default __hidden; 753 754 extern struct pthread_prio _thr_priorities[] __hidden; 755 756 extern int _thr_is_smp __hidden; 757 758 extern size_t _thr_guard_default __hidden; 759 extern size_t _thr_stack_default __hidden; 760 extern size_t _thr_stack_initial __hidden; 761 extern int _thr_page_size __hidden; 762 extern int _thr_spinloops __hidden; 763 extern int _thr_yieldloops __hidden; 764 extern int _thr_queuefifo __hidden; 765 766 /* Garbage thread count. */ 767 extern int _gc_count __hidden; 768 769 extern struct umutex _mutex_static_lock __hidden; 770 extern struct umutex _cond_static_lock __hidden; 771 extern struct umutex _rwlock_static_lock __hidden; 772 extern struct umutex _keytable_lock __hidden; 773 extern struct urwlock _thr_list_lock __hidden; 774 extern struct umutex _thr_event_lock __hidden; 775 extern struct umutex _suspend_all_lock __hidden; 776 extern int _suspend_all_waiters __hidden; 777 extern int _suspend_all_cycle __hidden; 778 extern struct pthread *_single_thread __hidden; 779 780 extern bool _thr_after_fork __hidden; 781 782 /* 783 * Function prototype definitions. 784 */ 785 __BEGIN_DECLS 786 void _thr_setthreaded(int) __hidden; 787 int _mutex_cv_lock(struct pthread_mutex *, int, bool) __hidden; 788 int _mutex_cv_unlock(struct pthread_mutex *, int *, int *) __hidden; 789 int _mutex_cv_attach(struct pthread_mutex *, int) __hidden; 790 int _mutex_cv_detach(struct pthread_mutex *, int *) __hidden; 791 int _mutex_owned(struct pthread *, const struct pthread_mutex *) __hidden; 792 int _mutex_reinit(pthread_mutex_t *) __hidden; 793 void _mutex_fork(struct pthread *curthread) __hidden; 794 int _mutex_enter_robust(struct pthread *curthread, struct pthread_mutex *m) 795 __hidden; 796 void _mutex_leave_robust(struct pthread *curthread, struct pthread_mutex *m) 797 __hidden; 798 void _libpthread_init(struct pthread *) __hidden; 799 struct pthread *_thr_alloc(struct pthread *) __hidden; 800 void _thread_exit(const char *, int, const char *) __hidden __dead2; 801 void _thread_exitf(const char *, int, const char *, ...) __hidden __dead2 802 __printflike(3, 4); 803 int _thr_ref_add(struct pthread *, struct pthread *, int) __hidden; 804 void _thr_ref_delete(struct pthread *, struct pthread *) __hidden; 805 void _thr_ref_delete_unlocked(struct pthread *, struct pthread *) __hidden; 806 int _thr_find_thread(struct pthread *, struct pthread *, int) __hidden; 807 void _thr_rtld_init(void) __hidden; 808 void _thr_rtld_postfork_child(void) __hidden; 809 int _thr_stack_alloc(struct pthread_attr *) __hidden; 810 void _thr_stack_free(struct pthread_attr *) __hidden; 811 void _thr_free(struct pthread *, struct pthread *) __hidden; 812 void _thr_gc(struct pthread *) __hidden; 813 void _thread_cleanupspecific(void) __hidden; 814 void _thread_printf(int, const char *, ...) __hidden __printflike(2, 3); 815 void _thread_vprintf(int, const char *, va_list) __hidden; 816 void _thr_spinlock_init(void) __hidden; 817 void _thr_cancel_enter(struct pthread *) __hidden; 818 void _thr_cancel_enter2(struct pthread *, int) __hidden; 819 void _thr_cancel_leave(struct pthread *, int) __hidden; 820 void _thr_testcancel(struct pthread *) __hidden; 821 void _thr_signal_block(struct pthread *) __hidden; 822 void _thr_signal_unblock(struct pthread *) __hidden; 823 void _thr_signal_block_check_fast(void) __hidden; 824 void _thr_signal_block_setup(struct pthread *) __hidden; 825 void _thr_signal_init(int) __hidden; 826 void _thr_signal_deinit(void) __hidden; 827 int _thr_send_sig(struct pthread *, int sig) __hidden; 828 void _thr_list_init(void) __hidden; 829 void _thr_hash_add(struct pthread *) __hidden; 830 void _thr_hash_remove(struct pthread *) __hidden; 831 struct pthread *_thr_hash_find(struct pthread *) __hidden; 832 void _thr_link(struct pthread *, struct pthread *) __hidden; 833 void _thr_unlink(struct pthread *, struct pthread *) __hidden; 834 void _thr_assert_lock_level(void) __hidden __dead2; 835 void _thr_ast(struct pthread *) __hidden; 836 void _thr_report_creation(struct pthread *curthread, 837 struct pthread *newthread) __hidden; 838 void _thr_report_death(struct pthread *curthread) __hidden; 839 int _thr_getscheduler(lwpid_t, int *, struct sched_param *) __hidden; 840 int _thr_setscheduler(lwpid_t, int, const struct sched_param *) __hidden; 841 void _thr_signal_prefork(void) __hidden; 842 void _thr_signal_postfork(void) __hidden; 843 void _thr_signal_postfork_child(void) __hidden; 844 void _thr_suspend_all_lock(struct pthread *) __hidden; 845 void _thr_suspend_all_unlock(struct pthread *) __hidden; 846 void _thr_try_gc(struct pthread *, struct pthread *) __hidden; 847 int _rtp_to_schedparam(const struct rtprio *rtp, int *policy, 848 struct sched_param *param) __hidden; 849 int _schedparam_to_rtp(int policy, const struct sched_param *param, 850 struct rtprio *rtp) __hidden; 851 void _thread_bp_create(void); 852 void _thread_bp_death(void); 853 int _sched_yield(void); 854 855 void _pthread_cleanup_push(void (*)(void *), void *); 856 void _pthread_cleanup_pop(int); 857 void _pthread_exit_mask(void *status, sigset_t *mask) __dead2 __hidden; 858 #ifndef _LIBC_PRIVATE_H_ 859 void _pthread_cancel_enter(int maycancel); 860 void _pthread_cancel_leave(int maycancel); 861 #endif 862 int _pthread_mutex_consistent(pthread_mutex_t * _Nonnull); 863 int _pthread_mutexattr_getrobust(pthread_mutexattr_t * _Nonnull __restrict, 864 int * _Nonnull __restrict); 865 int _pthread_mutexattr_setrobust(pthread_mutexattr_t * _Nonnull, int); 866 867 /* #include <fcntl.h> */ 868 #ifdef _SYS_FCNTL_H_ 869 #ifndef _LIBC_PRIVATE_H_ 870 int __sys_fcntl(int, int, ...); 871 int __sys_openat(int, const char *, int, ...); 872 #endif /* _LIBC_PRIVATE_H_ */ 873 #endif /* _SYS_FCNTL_H_ */ 874 875 /* #include <signal.h> */ 876 #ifdef _SIGNAL_H_ 877 #ifndef _LIBC_PRIVATE_H_ 878 int __sys_sigaction(int, const struct sigaction *, struct sigaction *); 879 int __sys_sigprocmask(int, const sigset_t *, sigset_t *); 880 int __sys_sigsuspend(const sigset_t *); 881 int __sys_sigtimedwait(const sigset_t *, siginfo_t *, 882 const struct timespec *); 883 int __sys_sigwait(const sigset_t *, int *); 884 int __sys_sigwaitinfo(const sigset_t *set, siginfo_t *info); 885 #endif /* _LIBC_PRIVATE_H_ */ 886 #endif /* _SYS_FCNTL_H_ */ 887 888 /* #include <time.h> */ 889 #ifdef _TIME_H_ 890 #ifndef _LIBC_PRIVATE_H_ 891 int __sys_clock_nanosleep(clockid_t, int, const struct timespec *, 892 struct timespec *); 893 int __sys_nanosleep(const struct timespec *, struct timespec *); 894 #endif /* _LIBC_PRIVATE_H_ */ 895 #endif /* _SYS_FCNTL_H_ */ 896 897 /* #include <sys/ucontext.h> */ 898 #ifdef _SYS_UCONTEXT_H_ 899 #ifndef _LIBC_PRIVATE_H_ 900 int __sys_setcontext(const ucontext_t *ucp); 901 int __sys_swapcontext(ucontext_t *oucp, const ucontext_t *ucp); 902 #endif /* _LIBC_PRIVATE_H_ */ 903 #endif /* _SYS_FCNTL_H_ */ 904 905 /* #include <unistd.h> */ 906 #ifdef _UNISTD_H_ 907 #ifndef _LIBC_PRIVATE_H_ 908 int __sys_close(int); 909 int __sys_fork(void); 910 ssize_t __sys_read(int, void *, size_t); 911 #endif /* _LIBC_PRIVATE_H_ */ 912 #endif /* _SYS_FCNTL_H_ */ 913 914 static inline int 915 _thr_isthreaded(void) 916 { 917 return (__isthreaded != 0); 918 } 919 920 static inline int 921 _thr_is_inited(void) 922 { 923 return (_thr_initial != NULL); 924 } 925 926 static inline void 927 _thr_check_init(void) 928 { 929 if (_thr_initial == NULL) 930 _libpthread_init(NULL); 931 } 932 933 struct wake_addr *_thr_alloc_wake_addr(void); 934 void _thr_release_wake_addr(struct wake_addr *); 935 int _thr_sleep(struct pthread *, int, const struct timespec *); 936 937 void _thr_wake_addr_init(void) __hidden; 938 939 static inline void 940 _thr_clear_wake(struct pthread *td) 941 { 942 td->wake_addr->value = 0; 943 } 944 945 static inline int 946 _thr_is_woken(struct pthread *td) 947 { 948 return td->wake_addr->value != 0; 949 } 950 951 static inline void 952 _thr_set_wake(unsigned int *waddr) 953 { 954 *waddr = 1; 955 _thr_umtx_wake(waddr, INT_MAX, 0); 956 } 957 958 void _thr_wake_all(unsigned int *waddrs[], int) __hidden; 959 960 static inline struct pthread * 961 _sleepq_first(struct sleepqueue *sq) 962 { 963 return TAILQ_FIRST(&sq->sq_blocked); 964 } 965 966 void _sleepq_init(void) __hidden; 967 struct sleepqueue *_sleepq_alloc(void) __hidden; 968 void _sleepq_free(struct sleepqueue *) __hidden; 969 void _sleepq_lock(void *) __hidden; 970 void _sleepq_unlock(void *) __hidden; 971 struct sleepqueue *_sleepq_lookup(void *) __hidden; 972 void _sleepq_add(void *, struct pthread *) __hidden; 973 int _sleepq_remove(struct sleepqueue *, struct pthread *) __hidden; 974 void _sleepq_drop(struct sleepqueue *, 975 void (*cb)(struct pthread *, void *arg), void *) __hidden; 976 977 int _pthread_mutex_init_calloc_cb(pthread_mutex_t *mutex, 978 void *(calloc_cb)(size_t, size_t)); 979 980 struct dl_phdr_info; 981 void __pthread_cxa_finalize(struct dl_phdr_info *phdr_info); 982 void _thr_tsd_unload(struct dl_phdr_info *phdr_info) __hidden; 983 void _thr_sigact_unload(struct dl_phdr_info *phdr_info) __hidden; 984 void _thr_stack_fix_protection(struct pthread *thrd); 985 void __pthread_distribute_static_tls(size_t offset, void *src, size_t len, 986 size_t total_len); 987 988 int *__error_threaded(void) __hidden; 989 void __thr_interpose_libc(void) __hidden; 990 pid_t __thr_fork(void); 991 pid_t __thr_pdfork(int *, int); 992 int __thr_setcontext(const ucontext_t *ucp); 993 int __thr_sigaction(int sig, const struct sigaction *act, 994 struct sigaction *oact) __hidden; 995 int __thr_sigprocmask(int how, const sigset_t *set, sigset_t *oset); 996 int __thr_sigsuspend(const sigset_t * set); 997 int __thr_sigtimedwait(const sigset_t *set, siginfo_t *info, 998 const struct timespec * timeout); 999 int __thr_sigwait(const sigset_t *set, int *sig); 1000 int __thr_sigwaitinfo(const sigset_t *set, siginfo_t *info); 1001 int __thr_swapcontext(ucontext_t *oucp, const ucontext_t *ucp); 1002 1003 void __thr_map_stacks_exec(void); 1004 1005 struct _spinlock; 1006 void __thr_spinunlock(struct _spinlock *lck); 1007 void __thr_spinlock(struct _spinlock *lck); 1008 1009 struct tcb *_tcb_ctor(struct pthread *, int); 1010 void _tcb_dtor(struct tcb *); 1011 1012 void __thr_pshared_init(void) __hidden; 1013 void *__thr_pshared_offpage(void *key, int doalloc) __hidden; 1014 void __thr_pshared_destroy(void *key) __hidden; 1015 void __thr_pshared_atfork_pre(void) __hidden; 1016 void __thr_pshared_atfork_post(void) __hidden; 1017 1018 void *__thr_calloc(size_t num, size_t size); 1019 void __thr_free(void *cp); 1020 void *__thr_malloc(size_t nbytes); 1021 void *__thr_realloc(void *cp, size_t nbytes); 1022 void __thr_malloc_init(void); 1023 void __thr_malloc_prefork(struct pthread *curthread); 1024 void __thr_malloc_postfork(struct pthread *curthread); 1025 1026 int _thr_join(pthread_t, void **); 1027 int _Tthr_kill(pthread_t, int); 1028 int _thr_getthreadid_np(void); 1029 void __thr_cleanup_push_imp(void (*)(void *), void *, 1030 struct _pthread_cleanup_info *); 1031 void __thr_cleanup_pop_imp(int); 1032 void _thr_cleanup_push(void (*)(void *), void *); 1033 void _thr_cleanup_pop(int); 1034 void _Tthr_testcancel(void); 1035 void _Tthr_cancel_enter(int); 1036 void _Tthr_cancel_leave(int); 1037 int _thr_cancel(pthread_t); 1038 int _thr_atfork(void (*)(void), void (*)(void), void (*)(void)); 1039 int _thr_attr_destroy(pthread_attr_t *); 1040 int _thr_attr_get_np(pthread_t, pthread_attr_t *); 1041 int _thr_attr_getdetachstate(const pthread_attr_t *, int *); 1042 int _thr_attr_getguardsize(const pthread_attr_t * __restrict, 1043 size_t * __restrict); 1044 int _thr_attr_getinheritsched(const pthread_attr_t * __restrict, 1045 int * __restrict); 1046 int _thr_attr_getschedparam(const pthread_attr_t * __restrict, 1047 struct sched_param * __restrict); 1048 int _thr_attr_getschedpolicy(const pthread_attr_t * __restrict, 1049 int * __restrict); 1050 int _thr_attr_getscope(const pthread_attr_t * __restrict, int * __restrict); 1051 int _thr_attr_getstackaddr(const pthread_attr_t *, void **); 1052 int _thr_attr_getstacksize(const pthread_attr_t * __restrict, 1053 size_t * __restrict); 1054 int _thr_attr_init(pthread_attr_t *); 1055 int _thr_attr_setdetachstate(pthread_attr_t *, int); 1056 int _thr_attr_setguardsize(pthread_attr_t *, size_t); 1057 int _thr_attr_setinheritsched(pthread_attr_t *, int); 1058 int _thr_attr_setschedparam(pthread_attr_t * __restrict, 1059 const struct sched_param * __restrict); 1060 int _thr_attr_setschedpolicy(pthread_attr_t *, int); 1061 int _thr_attr_setscope(pthread_attr_t *, int); 1062 int _thr_attr_setstackaddr(pthread_attr_t *, void *); 1063 int _thr_attr_setstacksize(pthread_attr_t *, size_t); 1064 int _thr_cond_init(pthread_cond_t * __restrict, 1065 const pthread_condattr_t * __restrict); 1066 int _thr_cond_destroy(pthread_cond_t *); 1067 int _thr_cond_timedwait(pthread_cond_t * __restrict, 1068 pthread_mutex_t * __restrict, const struct timespec * __restrict); 1069 int _thr_cond_signal(pthread_cond_t * cond); 1070 int _thr_cond_broadcast(pthread_cond_t * cond); 1071 int __thr_cond_wait(pthread_cond_t *, pthread_mutex_t *); 1072 int _thr_cond_wait(pthread_cond_t *, pthread_mutex_t *); 1073 int _thr_detach(pthread_t); 1074 int _thr_equal(pthread_t, pthread_t); 1075 void _Tthr_exit(void *); 1076 int _thr_getname_np(pthread_t, char *, size_t); 1077 int _thr_key_create(pthread_key_t *, void (*)(void *)); 1078 int _thr_key_delete(pthread_key_t); 1079 int _thr_setspecific(pthread_key_t, const void *); 1080 void *_thr_getspecific(pthread_key_t); 1081 int _thr_setcancelstate(int, int *); 1082 int _thr_setcanceltype(int, int *); 1083 pthread_t _Tthr_self(void); 1084 int _thr_rwlock_init(pthread_rwlock_t *, const pthread_rwlockattr_t *); 1085 int _thr_rwlock_destroy(pthread_rwlock_t *); 1086 int _Tthr_rwlock_rdlock(pthread_rwlock_t *); 1087 int _Tthr_rwlock_tryrdlock(pthread_rwlock_t *); 1088 int _Tthr_rwlock_trywrlock(pthread_rwlock_t *); 1089 int _Tthr_rwlock_wrlock(pthread_rwlock_t *); 1090 int _Tthr_rwlock_unlock(pthread_rwlock_t *); 1091 int _thr_once(pthread_once_t *, void (*)(void)); 1092 int _thr_sigmask(int, const sigset_t *, sigset_t *); 1093 int _thr_main_np(void); 1094 int _thr_mutexattr_init(pthread_mutexattr_t *); 1095 int _thr_mutexattr_destroy(pthread_mutexattr_t *); 1096 int _thr_mutexattr_settype(pthread_mutexattr_t *, int); 1097 int _thr_mutexattr_getrobust(pthread_mutexattr_t *, int *); 1098 int _thr_mutexattr_setrobust(pthread_mutexattr_t *, int); 1099 int __Tthr_mutex_init(pthread_mutex_t * __restrict, 1100 const pthread_mutexattr_t * __restrict); 1101 int _Tthr_mutex_consistent(pthread_mutex_t *); 1102 int _thr_mutex_destroy(pthread_mutex_t *); 1103 int _thr_mutex_unlock(pthread_mutex_t *); 1104 int __Tthr_mutex_lock(pthread_mutex_t *); 1105 int __Tthr_mutex_trylock(pthread_mutex_t *); 1106 bool __thr_get_main_stack_base(char **base); 1107 bool __thr_get_main_stack_lim(size_t *lim); 1108 1109 __END_DECLS 1110 __NULLABILITY_PRAGMA_POP 1111 1112 #endif /* !_THR_PRIVATE_H */ 1113