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>.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice unmodified, this list of conditions, and the following
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.
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.
32 #ifndef _THR_PRIVATE_H
33 #define _THR_PRIVATE_H
38 #include <sys/types.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>
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)
61 #define FB10_COMPAT(func, sym) \
62 WEAK_REF(func, SYM_FB10(sym)); \
63 SYM_COMPAT(sym, SYM_FB10(sym), FBSD_1.0)
65 #define FB10_COMPAT_PRIVATE(func, sym) \
66 WEAK_REF(func, SYM_FBP10(sym)); \
67 SYM_DEFAULT(sym, SYM_FBP10(sym), FBSDprivate_1.0)
70 #define __hidden __attribute__((visibility("hidden")))
73 #include "pthread_md.h"
75 #include "thread_db.h"
77 typedef TAILQ_HEAD(pthreadlist, pthread) pthreadlist;
78 typedef TAILQ_HEAD(atfork_head, pthread_atfork) atfork_head;
79 TAILQ_HEAD(mutex_queue, pthread_mutex);
81 /* Signal to do cancellation */
85 * Kernel fatal error handler macro.
87 #define PANIC(string) _thread_exit(__FILE__,__LINE__,string)
89 /* Output debug messages like this: */
90 #define stdout_debug(args...) _thread_printf(STDOUT_FILENO, ##args)
91 #define stderr_debug(args...) _thread_printf(STDERR_FILENO, ##args)
93 #ifdef _PTHREADS_INVARIANTS
94 #define THR_ASSERT(cond, msg) do { \
95 if (__predict_false(!(cond))) \
99 #define THR_ASSERT(cond, msg)
103 # define STATIC_LIB_REQUIRE(name)
105 # define STATIC_LIB_REQUIRE(name) __asm (".globl " #name)
108 #define TIMESPEC_ADD(dst, src, val) \
110 (dst)->tv_sec = (src)->tv_sec + (val)->tv_sec; \
111 (dst)->tv_nsec = (src)->tv_nsec + (val)->tv_nsec; \
112 if ((dst)->tv_nsec >= 1000000000) { \
114 (dst)->tv_nsec -= 1000000000; \
118 #define TIMESPEC_SUB(dst, src, val) \
120 (dst)->tv_sec = (src)->tv_sec - (val)->tv_sec; \
121 (dst)->tv_nsec = (src)->tv_nsec - (val)->tv_nsec; \
122 if ((dst)->tv_nsec < 0) { \
124 (dst)->tv_nsec += 1000000000; \
128 struct pthread_mutex {
130 * Lock for accesses to this structure.
132 struct umutex m_lock;
133 enum pthread_mutextype m_type;
134 struct pthread *m_owner;
140 * Link for all mutexes a thread currently owns.
142 TAILQ_ENTRY(pthread_mutex) m_qe;
145 struct pthread_mutex_attr {
146 enum pthread_mutextype m_type;
151 #define PTHREAD_MUTEXATTR_STATIC_INITIALIZER \
152 { PTHREAD_MUTEX_DEFAULT, PTHREAD_PRIO_NONE, 0, MUTEX_FLAGS_PRIVATE }
154 struct pthread_cond {
155 struct umutex c_lock;
156 struct ucond c_kerncv;
161 struct pthread_cond_attr {
166 struct pthread_barrier {
167 struct umutex b_lock;
169 volatile int64_t b_cycle;
170 volatile int b_count;
171 volatile int b_waiters;
174 struct pthread_barrierattr {
178 struct pthread_spinlock {
179 struct umutex s_lock;
183 * Flags for condition variables.
185 #define COND_FLAGS_PRIVATE 0x01
186 #define COND_FLAGS_INITED 0x02
187 #define COND_FLAGS_BUSY 0x04
190 * Cleanup definitions.
192 struct pthread_cleanup {
193 struct pthread_cleanup *prev;
194 void (*routine)(void *);
199 #define THR_CLEANUP_PUSH(td, func, arg) { \
200 struct pthread_cleanup __cup; \
202 __cup.routine = func; \
203 __cup.routine_arg = arg; \
205 __cup.prev = (td)->cleanup; \
206 (td)->cleanup = &__cup;
208 #define THR_CLEANUP_POP(td, exec) \
209 (td)->cleanup = __cup.prev; \
211 __cup.routine(__cup.routine_arg); \
214 struct pthread_atfork {
215 TAILQ_ENTRY(pthread_atfork) qe;
216 void (*prepare)(void);
217 void (*parent)(void);
221 struct pthread_attr {
226 #define THR_STACK_USER 0x100 /* 0xFF reserved for <pthread.h> */
228 void *stackaddr_attr;
229 size_t stacksize_attr;
230 size_t guardsize_attr;
236 * Thread creation state attributes.
238 #define THR_CREATE_RUNNING 0
239 #define THR_CREATE_SUSPENDED 1
242 * Miscellaneous definitions.
244 #define THR_STACK_DEFAULT (sizeof(void *) / 4 * 1024 * 1024)
247 * Maximum size of initial thread's stack. This perhaps deserves to be larger
248 * than the stacks of other threads, since many applications are likely to run
249 * almost entirely on this stack.
251 #define THR_STACK_INITIAL (THR_STACK_DEFAULT * 2)
254 * Define priorities returned by kernel.
256 #define THR_MIN_PRIORITY (_thr_priorities[SCHED_OTHER-1].pri_min)
257 #define THR_MAX_PRIORITY (_thr_priorities[SCHED_OTHER-1].pri_max)
258 #define THR_DEF_PRIORITY (_thr_priorities[SCHED_OTHER-1].pri_default)
260 #define THR_MIN_RR_PRIORITY (_thr_priorities[SCHED_RR-1].pri_min)
261 #define THR_MAX_RR_PRIORITY (_thr_priorities[SCHED_RR-1].pri_max)
262 #define THR_DEF_RR_PRIORITY (_thr_priorities[SCHED_RR-1].pri_default)
264 /* XXX The SCHED_FIFO should have same priority range as SCHED_RR */
265 #define THR_MIN_FIFO_PRIORITY (_thr_priorities[SCHED_FIFO_1].pri_min)
266 #define THR_MAX_FIFO_PRIORITY (_thr_priorities[SCHED_FIFO-1].pri_max)
267 #define THR_DEF_FIFO_PRIORITY (_thr_priorities[SCHED_FIFO-1].pri_default)
269 struct pthread_prio {
275 struct pthread_rwlockattr {
279 struct pthread_rwlock {
281 struct pthread *owner;
292 struct pthread_specific_elem {
298 volatile int allocated;
300 void (*destructor)(void *);
304 * lwpid_t is 32bit but kernel thr API exports tid as long type
305 * in very earily date.
307 #define TID(thread) ((uint32_t) ((thread)->tid))
313 /* Kernel thread id. */
315 #define TID_TERMINATED 1
318 * Lock for accesses to this thread structure.
322 /* Internal condition variable cycle number. */
325 /* How many low level locks the thread held. */
329 * Set to non-zero when this thread has entered a critical
330 * region. We allow for recursive entries into critical regions.
334 /* Signal blocked counter. */
337 /* Queue entry for list of all threads. */
338 TAILQ_ENTRY(pthread) tle; /* link for all threads in process */
340 /* Queue entry for GC lists. */
341 TAILQ_ENTRY(pthread) gcle;
343 /* Hash queue entry. */
344 LIST_ENTRY(pthread) hle;
346 /* Threads reference count. */
350 * Thread start routine, argument, stack pointer and thread
353 void *(*start_routine)(void *);
355 struct pthread_attr attr;
357 #define SHOULD_CANCEL(thr) \
358 ((thr)->cancel_pending && \
359 ((thr)->cancel_point || (thr)->cancel_async) && \
360 (thr)->cancel_enable && (thr)->cancelling == 0)
362 /* Cancellation is enabled */
365 /* Cancellation request is pending */
368 /* Thread is at cancellation point */
371 /* Cancellation should be synchoronized */
374 /* Asynchronouse cancellation is enabled */
377 /* Cancellation is in progress */
380 /* Thread temporary signal mask. */
383 /* Thread is in SIGCANCEL handler. */
384 int in_sigcancel_handler;
386 /* New thread should unblock SIGCANCEL. */
387 int unblock_sigcancel;
389 /* Force new thread to exit. */
393 enum pthread_state state;
396 * Error variable used instead of errno. The function __error()
397 * returns a pointer to this.
402 * The joiner is the thread that is joining to this thread. The
403 * join status keeps track of a join operation to another thread.
405 struct pthread *joiner;
407 /* Miscellaneous flags; only set with scheduling lock held. */
409 #define THR_FLAGS_PRIVATE 0x0001
410 #define THR_FLAGS_NEED_SUSPEND 0x0002 /* thread should be suspended */
411 #define THR_FLAGS_SUSPENDED 0x0004 /* thread is suspended */
413 /* Thread list flags; only set with thread list lock held. */
415 #define TLFLAGS_GC_SAFE 0x0001 /* thread safe for cleaning */
416 #define TLFLAGS_IN_TDLIST 0x0002 /* thread in all thread list */
417 #define TLFLAGS_IN_GCLIST 0x0004 /* thread in gc list */
418 #define TLFLAGS_DETACHED 0x0008 /* thread is detached */
420 /* Queue of currently owned NORMAL or PRIO_INHERIT type mutexes. */
421 struct mutex_queue mutexq;
423 /* Queue of all owned PRIO_PROTECT mutexes. */
424 struct mutex_queue pp_mutexq;
427 struct pthread_specific_elem *specific;
428 int specific_data_count;
430 /* Number rwlocks rdlocks held. */
434 * Current locks bitmap for rtld. */
437 /* Thread control block */
440 /* Cleanup handlers Link List */
441 struct pthread_cleanup *cleanup;
444 * Magic value to help recognize a valid thread structure
445 * from an invalid one:
447 #define THR_MAGIC ((u_int32_t) 0xd09ba115)
450 /* Enable event reporting */
457 td_event_msg_t event_buf;
460 #define THR_IN_CRITICAL(thrd) \
461 (((thrd)->locklevel > 0) || \
462 ((thrd)->critical_count > 0))
464 #define THR_CRITICAL_ENTER(thrd) \
465 (thrd)->critical_count++
467 #define THR_CRITICAL_LEAVE(thrd) \
469 (thrd)->critical_count--; \
473 #define THR_UMUTEX_TRYLOCK(thrd, lck) \
474 _thr_umutex_trylock((lck), TID(thrd))
476 #define THR_UMUTEX_LOCK(thrd, lck) \
477 _thr_umutex_lock((lck), TID(thrd))
479 #define THR_UMUTEX_TIMEDLOCK(thrd, lck, timo) \
480 _thr_umutex_timedlock((lck), TID(thrd), (timo))
482 #define THR_UMUTEX_UNLOCK(thrd, lck) \
483 _thr_umutex_unlock((lck), TID(thrd))
485 #define THR_LOCK_ACQUIRE(thrd, lck) \
487 (thrd)->locklevel++; \
488 _thr_umutex_lock(lck, TID(thrd)); \
491 #ifdef _PTHREADS_INVARIANTS
492 #define THR_ASSERT_LOCKLEVEL(thrd) \
494 if (__predict_false((thrd)->locklevel <= 0)) \
495 _thr_assert_lock_level(); \
498 #define THR_ASSERT_LOCKLEVEL(thrd)
501 #define THR_LOCK_RELEASE(thrd, lck) \
503 THR_ASSERT_LOCKLEVEL(thrd); \
504 _thr_umutex_unlock((lck), TID(thrd)); \
505 (thrd)->locklevel--; \
509 #define THR_LOCK(curthrd) THR_LOCK_ACQUIRE(curthrd, &(curthrd)->lock)
510 #define THR_UNLOCK(curthrd) THR_LOCK_RELEASE(curthrd, &(curthrd)->lock)
511 #define THR_THREAD_LOCK(curthrd, thr) THR_LOCK_ACQUIRE(curthrd, &(thr)->lock)
512 #define THR_THREAD_UNLOCK(curthrd, thr) THR_LOCK_RELEASE(curthrd, &(thr)->lock)
514 #define THREAD_LIST_LOCK(curthrd) \
516 THR_LOCK_ACQUIRE((curthrd), &_thr_list_lock); \
519 #define THREAD_LIST_UNLOCK(curthrd) \
521 THR_LOCK_RELEASE((curthrd), &_thr_list_lock); \
525 * Macros to insert/remove threads to the all thread list and
528 #define THR_LIST_ADD(thrd) do { \
529 if (((thrd)->tlflags & TLFLAGS_IN_TDLIST) == 0) { \
530 TAILQ_INSERT_HEAD(&_thread_list, thrd, tle); \
531 _thr_hash_add(thrd); \
532 (thrd)->tlflags |= TLFLAGS_IN_TDLIST; \
535 #define THR_LIST_REMOVE(thrd) do { \
536 if (((thrd)->tlflags & TLFLAGS_IN_TDLIST) != 0) { \
537 TAILQ_REMOVE(&_thread_list, thrd, tle); \
538 _thr_hash_remove(thrd); \
539 (thrd)->tlflags &= ~TLFLAGS_IN_TDLIST; \
542 #define THR_GCLIST_ADD(thrd) do { \
543 if (((thrd)->tlflags & TLFLAGS_IN_GCLIST) == 0) { \
544 TAILQ_INSERT_HEAD(&_thread_gc_list, thrd, gcle);\
545 (thrd)->tlflags |= TLFLAGS_IN_GCLIST; \
549 #define THR_GCLIST_REMOVE(thrd) do { \
550 if (((thrd)->tlflags & TLFLAGS_IN_GCLIST) != 0) { \
551 TAILQ_REMOVE(&_thread_gc_list, thrd, gcle); \
552 (thrd)->tlflags &= ~TLFLAGS_IN_GCLIST; \
557 #define GC_NEEDED() (_gc_count >= 5)
559 #define SHOULD_REPORT_EVENT(curthr, e) \
560 (curthr->report_events && \
561 (((curthr)->event_mask | _thread_event_mask ) & e) != 0)
563 extern int __isthreaded;
566 * Global variables for the pthread kernel.
569 extern char *_usrstack __hidden;
570 extern struct pthread *_thr_initial __hidden;
573 extern int _libthr_debug;
574 extern int _thread_event_mask;
575 extern struct pthread *_thread_last_event;
577 /* List of all threads: */
578 extern pthreadlist _thread_list;
580 /* List of threads needing GC: */
581 extern pthreadlist _thread_gc_list __hidden;
583 extern int _thread_active_threads;
584 extern atfork_head _thr_atfork_list __hidden;
585 extern struct umutex _thr_atfork_lock __hidden;
587 /* Default thread attributes: */
588 extern struct pthread_attr _pthread_attr_default __hidden;
590 /* Default mutex attributes: */
591 extern struct pthread_mutex_attr _pthread_mutexattr_default __hidden;
593 /* Default condition variable attributes: */
594 extern struct pthread_cond_attr _pthread_condattr_default __hidden;
596 extern struct pthread_prio _thr_priorities[] __hidden;
598 extern pid_t _thr_pid __hidden;
599 extern int _thr_is_smp __hidden;
601 extern size_t _thr_guard_default __hidden;
602 extern size_t _thr_stack_default __hidden;
603 extern size_t _thr_stack_initial __hidden;
604 extern int _thr_page_size __hidden;
605 extern int _thr_spinloops __hidden;
606 extern int _thr_yieldloops __hidden;
608 /* Garbage thread count. */
609 extern int _gc_count __hidden;
611 extern struct umutex _mutex_static_lock __hidden;
612 extern struct umutex _cond_static_lock __hidden;
613 extern struct umutex _rwlock_static_lock __hidden;
614 extern struct umutex _keytable_lock __hidden;
615 extern struct umutex _thr_list_lock __hidden;
616 extern struct umutex _thr_event_lock __hidden;
619 * Function prototype definitions.
622 int _thr_setthreaded(int) __hidden;
623 int _mutex_cv_lock(pthread_mutex_t *, int count) __hidden;
624 int _mutex_cv_unlock(pthread_mutex_t *, int *count) __hidden;
625 int _mutex_reinit(pthread_mutex_t *) __hidden;
626 void _mutex_fork(struct pthread *curthread) __hidden;
627 void _libpthread_init(struct pthread *) __hidden;
628 struct pthread *_thr_alloc(struct pthread *) __hidden;
629 void _thread_exit(const char *, int, const char *) __hidden __dead2;
630 void _thr_exit_cleanup(void) __hidden;
631 int _thr_ref_add(struct pthread *, struct pthread *, int) __hidden;
632 void _thr_ref_delete(struct pthread *, struct pthread *) __hidden;
633 void _thr_ref_delete_unlocked(struct pthread *, struct pthread *) __hidden;
634 int _thr_find_thread(struct pthread *, struct pthread *, int) __hidden;
635 void _thr_rtld_init(void) __hidden;
636 void _thr_rtld_fini(void) __hidden;
637 int _thr_stack_alloc(struct pthread_attr *) __hidden;
638 void _thr_stack_free(struct pthread_attr *) __hidden;
639 void _thr_free(struct pthread *, struct pthread *) __hidden;
640 void _thr_gc(struct pthread *) __hidden;
641 void _thread_cleanupspecific(void) __hidden;
642 void _thread_dump_info(void) __hidden;
643 void _thread_printf(int, const char *, ...) __hidden;
644 void _thr_spinlock_init(void) __hidden;
645 void _thr_cancel_enter(struct pthread *) __hidden;
646 void _thr_cancel_leave(struct pthread *) __hidden;
647 void _thr_cancel_enter_defer(struct pthread *) __hidden;
648 void _thr_cancel_leave_defer(struct pthread *, int) __hidden;
649 void _thr_testcancel(struct pthread *) __hidden;
650 void _thr_signal_block(struct pthread *) __hidden;
651 void _thr_signal_unblock(struct pthread *) __hidden;
652 void _thr_signal_init(void) __hidden;
653 void _thr_signal_deinit(void) __hidden;
654 int _thr_send_sig(struct pthread *, int sig) __hidden;
655 void _thr_list_init(void) __hidden;
656 void _thr_hash_add(struct pthread *) __hidden;
657 void _thr_hash_remove(struct pthread *) __hidden;
658 struct pthread *_thr_hash_find(struct pthread *) __hidden;
659 void _thr_link(struct pthread *, struct pthread *) __hidden;
660 void _thr_unlink(struct pthread *, struct pthread *) __hidden;
661 void _thr_suspend_check(struct pthread *) __hidden;
662 void _thr_assert_lock_level(void) __hidden __dead2;
663 void _thr_ast(struct pthread *) __hidden;
664 void _thr_once_init(void) __hidden;
665 void _thr_report_creation(struct pthread *curthread,
666 struct pthread *newthread) __hidden;
667 void _thr_report_death(struct pthread *curthread) __hidden;
668 int _thr_getscheduler(lwpid_t, int *, struct sched_param *) __hidden;
669 int _thr_setscheduler(lwpid_t, int, const struct sched_param *) __hidden;
670 int _rtp_to_schedparam(const struct rtprio *rtp, int *policy,
671 struct sched_param *param) __hidden;
672 int _schedparam_to_rtp(int policy, const struct sched_param *param,
673 struct rtprio *rtp) __hidden;
674 void _thread_bp_create(void);
675 void _thread_bp_death(void);
676 int _sched_yield(void);
677 void _thr_sem_prefork(void);
678 void _thr_sem_postfork(void);
679 void _thr_sem_child_postfork(void);
681 void _pthread_cleanup_push(void (*)(void *), void *);
682 void _pthread_cleanup_pop(int);
684 /* #include <fcntl.h> */
686 int __sys_fcntl(int, int, ...);
687 int __sys_open(const char *, int, ...);
688 int __sys_openat(int, const char *, int, ...);
691 /* #include <signal.h> */
693 int __sys_kill(pid_t, int);
694 int __sys_sigaction(int, const struct sigaction *, struct sigaction *);
695 int __sys_sigpending(sigset_t *);
696 int __sys_sigprocmask(int, const sigset_t *, sigset_t *);
697 int __sys_sigsuspend(const sigset_t *);
698 int __sys_sigreturn(ucontext_t *);
699 int __sys_sigaltstack(const struct sigaltstack *, struct sigaltstack *);
700 int __sys_sigwait(const sigset_t *, int *);
701 int __sys_sigtimedwait(const sigset_t *, siginfo_t *,
702 const struct timespec *);
703 int __sys_sigwaitinfo(const sigset_t *set, siginfo_t *info);
706 /* #include <time.h> */
708 int __sys_nanosleep(const struct timespec *, struct timespec *);
711 /* #include <unistd.h> */
713 int __sys_close(int);
714 int __sys_fork(void);
715 pid_t __sys_getpid(void);
716 ssize_t __sys_read(int, void *, size_t);
717 ssize_t __sys_write(int, const void *, size_t);
718 void __sys_exit(int);
721 int _umtx_op_err(void *, int op, u_long, void *, void *) __hidden;
724 _thr_isthreaded(void)
726 return (__isthreaded != 0);
732 return (_thr_initial != NULL);
736 _thr_check_init(void)
738 if (_thr_initial == NULL)
739 _libpthread_init(NULL);
744 #endif /* !_THR_PRIVATE_H */