2 * Copyright (c) 1995-1998 John Birrell <jb@cimlogic.com.au>.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 * must display the following acknowledgement:
15 * This product includes software developed by John Birrell.
16 * 4. Neither the name of the author nor the names of any co-contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * Private thread definitions for the uthread kernel.
37 #ifndef _THR_PRIVATE_H
38 #define _THR_PRIVATE_H
46 #include <sys/queue.h>
47 #include <sys/types.h>
49 #include <sys/cdefs.h>
55 #include <pthread_np.h>
58 #include "pthread_md.h"
61 * Evaluate the storage class specifier.
63 #ifdef GLOBAL_PTHREAD_PRIVATE
65 #define SCLASS_PRESET(x...) = x
68 #define SCLASS_PRESET(x...)
72 * Kernel fatal error handler macro.
74 #define PANIC(string) _thr_exit(__FILE__,__LINE__,string)
77 /* Output debug messages like this: */
78 #define stdout_debug(args...) _thread_printf(STDOUT_FILENO, ##args)
79 #define stderr_debug(args...) _thread_printf(STDOUT_FILENO, ##args)
81 #define DBG_MUTEX 0x0001
82 #define DBG_SIG 0x0002
84 #ifdef _PTHREADS_INVARIANTS
85 #define THR_ASSERT(cond, msg) do { \
90 #define THR_ASSERT(cond, msg)
94 * State change macro without scheduling queue change:
96 #define THR_SET_STATE(thrd, newstate) do { \
97 (thrd)->state = newstate; \
98 (thrd)->fname = __FILE__; \
99 (thrd)->lineno = __LINE__; \
103 #define TIMESPEC_ADD(dst, src, val) \
105 (dst)->tv_sec = (src)->tv_sec + (val)->tv_sec; \
106 (dst)->tv_nsec = (src)->tv_nsec + (val)->tv_nsec; \
107 if ((dst)->tv_nsec > 1000000000) { \
109 (dst)->tv_nsec -= 1000000000; \
113 #define TIMESPEC_SUB(dst, src, val) \
115 (dst)->tv_sec = (src)->tv_sec - (val)->tv_sec; \
116 (dst)->tv_nsec = (src)->tv_nsec - (val)->tv_nsec; \
117 if ((dst)->tv_nsec < 0) { \
119 (dst)->tv_nsec += 1000000000; \
126 * XXX It'd be nice if these were contained in uthread_priority_queue.[ch].
128 typedef struct pq_list {
129 TAILQ_HEAD(, pthread) pl_head; /* list of threads at this priority */
130 TAILQ_ENTRY(pq_list) pl_link; /* link for queue of priority lists */
131 int pl_prio; /* the priority of this list */
132 int pl_queued; /* is this in the priority queue */
135 typedef struct pq_queue {
136 TAILQ_HEAD(, pq_list) pq_queue; /* queue of priority lists */
137 pq_list_t *pq_lists; /* array of all priority lists */
138 int pq_size; /* number of priority lists */
139 #define PQF_ACTIVE 0x0001
145 * Each KSEG has a scheduling queue. For now, threads that exist in their
146 * own KSEG (system scope) will get a full priority queue. In the future
147 * this can be optimized for the single thread per KSEG case.
151 TAILQ_HEAD(, pthread) sq_waitq; /* waiting in userland */
154 typedef struct kse_thr_mailbox *kse_critical_t;
158 #define MAX_KSE_LOCKLEVEL 5
160 /* -- location and order specific items for gdb -- */
162 struct pthread *k_curthread; /* current thread */
163 struct kse_group *k_kseg; /* parent KSEG */
164 struct sched_queue *k_schedq; /* scheduling queue */
165 /* -- end of location and order specific items -- */
166 TAILQ_ENTRY(kse) k_qe; /* KSE list link entry */
167 TAILQ_ENTRY(kse) k_kgqe; /* KSEG's KSE list entry */
169 * Items that are only modified by the kse, or that otherwise
170 * don't need to be locked when accessed
173 struct lockuser k_lockusers[MAX_KSE_LOCKLEVEL];
177 #define KF_STARTED 0x0001 /* kernel kse created */
178 #define KF_INITIALIZED 0x0002 /* initialized on 1st upcall */
179 #define KF_TERMINATED 0x0004 /* kse is terminated */
180 #define KF_IDLE 0x0008 /* kse is idle */
181 #define KF_SWITCH 0x0010 /* thread switch in UTS */
182 int k_error; /* syscall errno in critical */
183 int k_cpu; /* CPU ID when bound */
184 int k_sigseqno; /* signal buffered count */
187 #define KSE_SET_IDLE(kse) ((kse)->k_flags |= KF_IDLE)
188 #define KSE_CLEAR_IDLE(kse) ((kse)->k_flags &= ~KF_IDLE)
189 #define KSE_IS_IDLE(kse) (((kse)->k_flags & KF_IDLE) != 0)
190 #define KSE_SET_SWITCH(kse) ((kse)->k_flags |= KF_SWITCH)
191 #define KSE_CLEAR_SWITCH(kse) ((kse)->k_flags &= ~KF_SWITCH)
192 #define KSE_IS_SWITCH(kse) (((kse)->k_flags & KF_SWITCH) != 0)
195 * Each KSE group contains one or more KSEs in which threads can run.
196 * At least for now, there is one scheduling queue per KSE group; KSEs
197 * within the same KSE group compete for threads from the same scheduling
198 * queue. A scope system thread has one KSE in one KSE group; the group
199 * does not use its scheduling queue.
202 TAILQ_HEAD(, kse) kg_kseq; /* list of KSEs in group */
203 TAILQ_HEAD(, pthread) kg_threadq; /* list of threads in group */
204 TAILQ_ENTRY(kse_group) kg_qe; /* link entry */
205 struct sched_queue kg_schedq; /* scheduling queue */
207 int kg_threadcount; /* # of assigned threads */
208 int kg_ksecount; /* # of assigned KSEs */
211 #define KGF_SINGLE_THREAD 0x0001 /* scope system kse group */
212 #define KGF_SCHEDQ_INITED 0x0002 /* has an initialized schedq */
216 * Add/remove threads from a KSE's scheduling queue.
217 * For now the scheduling queue is hung off the KSEG.
219 #define KSEG_THRQ_ADD(kseg, thr) \
221 TAILQ_INSERT_TAIL(&(kseg)->kg_threadq, thr, kle);\
222 (kseg)->kg_threadcount++; \
225 #define KSEG_THRQ_REMOVE(kseg, thr) \
227 TAILQ_REMOVE(&(kseg)->kg_threadq, thr, kle); \
228 (kseg)->kg_threadcount--; \
233 * Lock acquire and release for KSEs.
235 #define KSE_LOCK_ACQUIRE(kse, lck) \
237 if ((kse)->k_locklevel < MAX_KSE_LOCKLEVEL) { \
238 (kse)->k_locklevel++; \
239 _lock_acquire((lck), \
240 &(kse)->k_lockusers[(kse)->k_locklevel - 1], 0); \
243 PANIC("Exceeded maximum lock level"); \
246 #define KSE_LOCK_RELEASE(kse, lck) \
248 if ((kse)->k_locklevel > 0) { \
249 _lock_release((lck), \
250 &(kse)->k_lockusers[(kse)->k_locklevel - 1]); \
251 (kse)->k_locklevel--; \
258 #define KSE_LOCK(curkse) \
259 KSE_LOCK_ACQUIRE(curkse, &(curkse)->k_kseg->kg_lock)
260 #define KSE_UNLOCK(curkse) \
261 KSE_LOCK_RELEASE(curkse, &(curkse)->k_kseg->kg_lock)
264 * Lock a potentially different KSEG.
266 #define KSE_SCHED_LOCK(curkse, kseg) \
267 KSE_LOCK_ACQUIRE(curkse, &(kseg)->kg_lock)
268 #define KSE_SCHED_UNLOCK(curkse, kseg) \
269 KSE_LOCK_RELEASE(curkse, &(kseg)->kg_lock)
272 * Waiting queue manipulation macros (using pqe link):
274 #define KSE_WAITQ_REMOVE(kse, thrd) \
276 if (((thrd)->flags & THR_FLAGS_IN_WAITQ) != 0) { \
277 TAILQ_REMOVE(&(kse)->k_schedq->sq_waitq, thrd, pqe); \
278 (thrd)->flags &= ~THR_FLAGS_IN_WAITQ; \
281 #define KSE_WAITQ_INSERT(kse, thrd) kse_waitq_insert(thrd)
282 #define KSE_WAITQ_FIRST(kse) TAILQ_FIRST(&(kse)->k_schedq->sq_waitq)
284 #define KSE_WAKEUP(kse) kse_wakeup(&(kse)->k_kcb->kcb_kmbx)
287 * TailQ initialization values.
289 #define TAILQ_INITIALIZER { NULL, NULL }
292 * lock initialization values.
294 #define LCK_INITIALIZER { NULL, NULL, LCK_DEFAULT }
296 struct pthread_mutex {
298 * Lock for accesses to this structure.
301 enum pthread_mutextype m_type;
303 TAILQ_HEAD(mutex_head, pthread) m_queue;
304 struct pthread *m_owner;
310 * Used for priority inheritence and protection.
312 * m_prio - For priority inheritence, the highest active
313 * priority (threads locking the mutex inherit
314 * this priority). For priority protection, the
315 * ceiling priority of this mutex.
316 * m_saved_prio - mutex owners inherited priority before
317 * taking the mutex, restored when the owner
324 * Link for list of all mutexes a thread currently owns.
326 TAILQ_ENTRY(pthread_mutex) m_qe;
332 #define MUTEX_FLAGS_PRIVATE 0x01
333 #define MUTEX_FLAGS_INITED 0x02
334 #define MUTEX_FLAGS_BUSY 0x04
337 * Static mutex initialization values.
339 #define PTHREAD_MUTEX_STATIC_INITIALIZER \
340 { LCK_INITIALIZER, PTHREAD_MUTEX_DEFAULT, PTHREAD_PRIO_NONE, \
341 TAILQ_INITIALIZER, NULL, MUTEX_FLAGS_PRIVATE, 0, 0, 0, 0, \
344 struct pthread_mutex_attr {
345 enum pthread_mutextype m_type;
351 #define PTHREAD_MUTEXATTR_STATIC_INITIALIZER \
352 { PTHREAD_MUTEX_DEFAULT, PTHREAD_PRIO_NONE, 0, MUTEX_FLAGS_PRIVATE }
355 * Condition variable definitions.
357 enum pthread_cond_type {
362 struct pthread_cond {
364 * Lock for accesses to this structure.
367 enum pthread_cond_type c_type;
368 TAILQ_HEAD(cond_head, pthread) c_queue;
369 struct pthread_mutex *c_mutex;
374 struct pthread_cond_attr {
375 enum pthread_cond_type c_type;
379 struct pthread_barrier {
380 pthread_mutex_t b_lock;
381 pthread_cond_t b_cond;
387 struct pthread_barrierattr {
391 struct pthread_spinlock {
397 * Flags for condition variables.
399 #define COND_FLAGS_PRIVATE 0x01
400 #define COND_FLAGS_INITED 0x02
401 #define COND_FLAGS_BUSY 0x04
404 * Static cond initialization values.
406 #define PTHREAD_COND_STATIC_INITIALIZER \
407 { LCK_INITIALIZER, COND_TYPE_FAST, TAILQ_INITIALIZER, \
411 * Cleanup definitions.
413 struct pthread_cleanup {
414 struct pthread_cleanup *next;
419 struct pthread_atfork {
420 TAILQ_ENTRY(pthread_atfork) qe;
421 void (*prepare)(void);
422 void (*parent)(void);
426 struct pthread_attr {
432 #define THR_STACK_USER 0x100 /* 0xFF reserved for <pthread.h> */
435 void (*cleanup_attr) ();
436 void *stackaddr_attr;
437 size_t stacksize_attr;
438 size_t guardsize_attr;
442 * Thread creation state attributes.
444 #define THR_CREATE_RUNNING 0
445 #define THR_CREATE_SUSPENDED 1
448 * Miscellaneous definitions.
450 #define THR_STACK_DEFAULT 65536
453 * Maximum size of initial thread's stack. This perhaps deserves to be larger
454 * than the stacks of other threads, since many applications are likely to run
455 * almost entirely on this stack.
457 #define THR_STACK_INITIAL 0x100000
460 * Define the different priority ranges. All applications have thread
461 * priorities constrained within 0-31. The threads library raises the
462 * priority when delivering signals in order to ensure that signal
463 * delivery happens (from the POSIX spec) "as soon as possible".
464 * In the future, the threads library will also be able to map specific
465 * threads into real-time (cooperating) processes or kernel threads.
466 * The RT and SIGNAL priorities will be used internally and added to
467 * thread base priorities so that the scheduling queue can handle both
468 * normal and RT priority threads with and without signal handling.
470 * The approach taken is that, within each class, signal delivery
471 * always has priority over thread execution.
473 #define THR_DEFAULT_PRIORITY 15
474 #define THR_MIN_PRIORITY 0
475 #define THR_MAX_PRIORITY 31 /* 0x1F */
476 #define THR_SIGNAL_PRIORITY 32 /* 0x20 */
477 #define THR_RT_PRIORITY 64 /* 0x40 */
478 #define THR_FIRST_PRIORITY THR_MIN_PRIORITY
479 #define THR_LAST_PRIORITY \
480 (THR_MAX_PRIORITY + THR_SIGNAL_PRIORITY + THR_RT_PRIORITY)
481 #define THR_BASE_PRIORITY(prio) ((prio) & THR_MAX_PRIORITY)
484 * Clock resolution in microseconds.
486 #define CLOCK_RES_USEC 10000
489 * Time slice period in microseconds.
491 #define TIMESLICE_USEC 20000
494 * XXX - Define a thread-safe macro to get the current time of day
495 * which is updated at regular intervals by something.
497 * For now, we just make the system call to get the time.
499 #define KSE_GET_TOD(curkse, tsp) \
501 *tsp = (curkse)->k_kcb->kcb_kmbx.km_timeofday; \
502 if ((tsp)->tv_sec == 0) \
503 clock_gettime(CLOCK_REALTIME, tsp); \
506 struct pthread_rwlockattr {
510 struct pthread_rwlock {
511 pthread_mutex_t lock; /* monitor lock */
512 pthread_cond_t read_signal;
513 pthread_cond_t write_signal;
514 int state; /* 0 = idle >0 = # of readers -1 = writer */
536 struct sigwait_data {
538 siginfo_t *siginfo; /* used to save siginfo for sigwaitinfo() */
541 union pthread_wait_data {
542 pthread_mutex_t mutex;
545 struct sigwait_data *sigwait;
549 * Define a continuation routine that can be used to perform a
550 * transfer of control:
552 typedef void (*thread_continuation_t) (void *);
555 * This stores a thread's state prior to running a signal handler.
556 * It is used when a signal is delivered to a thread blocked in
557 * userland. If the signal handler returns normally, the thread's
558 * state is restored from here.
560 struct pthread_sigframe {
566 enum pthread_state psf_state;
567 union pthread_wait_data psf_wait_data;
568 struct timespec psf_wakeup_time;
570 sigset_t psf_sigmask;
575 struct pthread *thread;
580 struct pthread_specific_elem {
586 #define MAX_THR_LOCKLEVEL 5
592 * Thread mailbox is first so it cal be aligned properly.
597 * Magic value to help recognize a valid thread structure
598 * from an invalid one:
600 #define THR_MAGIC ((u_int32_t) 0xd09ba115)
603 u_int64_t uniqueid; /* for gdb */
605 /* Queue entry for list of all threads: */
606 TAILQ_ENTRY(pthread) tle; /* link for all threads in process */
607 TAILQ_ENTRY(pthread) kle; /* link for all threads in KSE/KSEG */
609 /* Queue entry for GC lists: */
610 TAILQ_ENTRY(pthread) gcle;
612 /* Hash queue entry */
613 LIST_ENTRY(pthread) hle;
616 * Lock for accesses to this thread structure.
619 struct lockuser lockusers[MAX_THR_LOCKLEVEL];
621 kse_critical_t critical[MAX_KSE_LOCKLEVEL];
623 struct kse_group *kseg;
626 * Thread start routine, argument, stack pointer and thread
629 void *(*start_routine)(void *);
631 struct pthread_attr attr;
633 int active; /* thread running */
634 int blocked; /* thread blocked in kernel */
638 * Used for tracking delivery of signal handlers.
640 struct pthread_sigframe *curframe;
644 * Cancelability flags - the lower 2 bits are used by cancel
645 * definitions in pthread.h
647 #define THR_AT_CANCEL_POINT 0x0004
648 #define THR_CANCELLING 0x0008
649 #define THR_CANCEL_NEEDED 0x0010
652 thread_continuation_t continuation;
655 * The thread's base and pending signal masks. The active
656 * signal mask is stored in the thread's context (in mailbox).
660 volatile int check_pending;
664 enum pthread_state state;
665 volatile int lock_switch;
668 * Number of microseconds accumulated by this thread when
669 * time slicing is active.
674 * Time to wake up thread. This is used for sleeping threads and
675 * for any operation which may time out (such as select).
677 struct timespec wakeup_time;
679 /* TRUE if operation has timed out. */
683 * Error variable used instead of errno. The function __error()
684 * returns a pointer to this.
689 * The joiner is the thread that is joining to this thread. The
690 * join status keeps track of a join operation to another thread.
692 struct pthread *joiner;
693 struct join_status join_status;
696 * The current thread can belong to only one scheduling queue at
697 * a time (ready or waiting queue). It can also belong to:
699 * o A queue of threads waiting for a mutex
700 * o A queue of threads waiting for a condition variable
702 * It is possible for a thread to belong to more than one of the
703 * above queues if it is handling a signal. A thread may only
704 * enter a mutex or condition variable queue when it is not
705 * being called from a signal handler. If a thread is a member
706 * of one of these queues when a signal handler is invoked, it
707 * must be removed from the queue before invoking the handler
708 * and then added back to the queue after return from the handler.
710 * Use pqe for the scheduling queue link (both ready and waiting),
711 * sqe for synchronization (mutex, condition variable, and join)
712 * queue links, and qe for all other links.
714 TAILQ_ENTRY(pthread) pqe; /* priority, wait queues link */
715 TAILQ_ENTRY(pthread) sqe; /* synchronization queue link */
718 union pthread_wait_data data;
721 * Set to TRUE if a blocking operation was
722 * interrupted by a signal:
727 * Set to non-zero when this thread has entered a critical
728 * region. We allow for recursive entries into critical regions.
733 * Set to TRUE if this thread should yield after leaving a
734 * critical region to check for signals, messages, etc.
739 #define THR_FLAGS_IN_SYNCQ 0x0001
741 /* Miscellaneous flags; only set with scheduling lock held. */
743 #define THR_FLAGS_PRIVATE 0x0001
744 #define THR_FLAGS_IN_WAITQ 0x0002 /* in waiting queue using pqe link */
745 #define THR_FLAGS_IN_RUNQ 0x0004 /* in run queue using pqe link */
746 #define THR_FLAGS_EXITING 0x0008 /* thread is exiting */
747 #define THR_FLAGS_SUSPENDED 0x0010 /* thread is suspended */
748 #define THR_FLAGS_GC_SAFE 0x0020 /* thread safe for cleaning */
749 #define THR_FLAGS_IN_TDLIST 0x0040 /* thread in all thread list */
750 #define THR_FLAGS_IN_GCLIST 0x0080 /* thread in gc list */
752 * Base priority is the user setable and retrievable priority
753 * of the thread. It is only affected by explicit calls to
754 * set thread priority and upon thread creation via a thread
755 * attribute or default priority.
760 * Inherited priority is the priority a thread inherits by
761 * taking a priority inheritence or protection mutex. It
762 * is not affected by base priority changes. Inherited
763 * priority defaults to and remains 0 until a mutex is taken
764 * that is being waited on by any other thread whose priority
767 char inherited_priority;
770 * Active priority is always the maximum of the threads base
771 * priority and inherited priority. When there is a change
772 * in either the base or inherited priority, the active
773 * priority must be recalculated.
775 char active_priority;
777 /* Number of priority ceiling or protection mutexes owned. */
778 int priority_mutex_count;
780 /* Number rwlocks rdlocks held. */
784 * Queue of currently owned mutexes.
786 TAILQ_HEAD(, pthread_mutex) mutexq;
789 struct pthread_specific_elem *specific;
790 int specific_data_count;
792 /* Alternative stack for sigaltstack() */
796 * Current locks bitmap for rtld.
800 /* Cleanup handlers Link List */
801 struct pthread_cleanup *cleanup;
802 char *fname; /* Ptr to source file name */
803 int lineno; /* Source line number. */
807 * Critical regions can also be detected by looking at the threads
808 * current lock level. Ensure these macros increment and decrement
809 * the lock levels such that locks can not be held with a lock level
812 #define THR_IN_CRITICAL(thrd) \
813 (((thrd)->locklevel > 0) || \
814 ((thrd)->critical_count > 0))
816 #define THR_YIELD_CHECK(thrd) \
818 if (((thrd)->critical_yield != 0) && \
819 !(THR_IN_CRITICAL(thrd))) \
820 _thr_sched_switch(thrd); \
821 else if (((thrd)->check_pending != 0) && \
822 !(THR_IN_CRITICAL(thrd))) \
823 _thr_sig_check_pending(thrd); \
826 #define THR_LOCK_ACQUIRE(thrd, lck) \
828 if ((thrd)->locklevel < MAX_THR_LOCKLEVEL) { \
829 THR_DEACTIVATE_LAST_LOCK(thrd); \
830 (thrd)->locklevel++; \
831 _lock_acquire((lck), \
832 &(thrd)->lockusers[(thrd)->locklevel - 1], \
833 (thrd)->active_priority); \
835 PANIC("Exceeded maximum lock level"); \
838 #define THR_LOCK_RELEASE(thrd, lck) \
840 if ((thrd)->locklevel > 0) { \
841 _lock_release((lck), \
842 &(thrd)->lockusers[(thrd)->locklevel - 1]); \
843 (thrd)->locklevel--; \
844 THR_ACTIVATE_LAST_LOCK(thrd); \
845 if ((thrd)->locklevel == 0) \
846 THR_YIELD_CHECK(thrd); \
850 #define THR_ACTIVATE_LAST_LOCK(thrd) \
852 if ((thrd)->locklevel > 0) \
853 _lockuser_setactive( \
854 &(thrd)->lockusers[(thrd)->locklevel - 1], 1); \
857 #define THR_DEACTIVATE_LAST_LOCK(thrd) \
859 if ((thrd)->locklevel > 0) \
860 _lockuser_setactive( \
861 &(thrd)->lockusers[(thrd)->locklevel - 1], 0); \
865 * For now, threads will have their own lock separate from their
866 * KSE scheduling lock.
868 #define THR_LOCK(thr) THR_LOCK_ACQUIRE(thr, &(thr)->lock)
869 #define THR_UNLOCK(thr) THR_LOCK_RELEASE(thr, &(thr)->lock)
870 #define THR_THREAD_LOCK(curthrd, thr) THR_LOCK_ACQUIRE(curthrd, &(thr)->lock)
871 #define THR_THREAD_UNLOCK(curthrd, thr) THR_LOCK_RELEASE(curthrd, &(thr)->lock)
874 * Priority queue manipulation macros (using pqe link). We use
875 * the thread's kseg link instead of the kse link because a thread
876 * does not (currently) have a statically assigned kse.
878 #define THR_RUNQ_INSERT_HEAD(thrd) \
879 _pq_insert_head(&(thrd)->kseg->kg_schedq.sq_runq, thrd)
880 #define THR_RUNQ_INSERT_TAIL(thrd) \
881 _pq_insert_tail(&(thrd)->kseg->kg_schedq.sq_runq, thrd)
882 #define THR_RUNQ_REMOVE(thrd) \
883 _pq_remove(&(thrd)->kseg->kg_schedq.sq_runq, thrd)
884 #define THR_RUNQ_FIRST(thrd) \
885 _pq_first(&(thrd)->kseg->kg_schedq.sq_runq)
888 * Macros to insert/remove threads to the all thread list and
891 #define THR_LIST_ADD(thrd) do { \
892 if (((thrd)->flags & THR_FLAGS_IN_TDLIST) == 0) { \
893 TAILQ_INSERT_HEAD(&_thread_list, thrd, tle); \
894 _thr_hash_add(thrd); \
895 (thrd)->flags |= THR_FLAGS_IN_TDLIST; \
898 #define THR_LIST_REMOVE(thrd) do { \
899 if (((thrd)->flags & THR_FLAGS_IN_TDLIST) != 0) { \
900 TAILQ_REMOVE(&_thread_list, thrd, tle); \
901 _thr_hash_remove(thrd); \
902 (thrd)->flags &= ~THR_FLAGS_IN_TDLIST; \
905 #define THR_GCLIST_ADD(thrd) do { \
906 if (((thrd)->flags & THR_FLAGS_IN_GCLIST) == 0) { \
907 TAILQ_INSERT_HEAD(&_thread_gc_list, thrd, gcle);\
908 (thrd)->flags |= THR_FLAGS_IN_GCLIST; \
912 #define THR_GCLIST_REMOVE(thrd) do { \
913 if (((thrd)->flags & THR_FLAGS_IN_GCLIST) != 0) { \
914 TAILQ_REMOVE(&_thread_gc_list, thrd, gcle); \
915 (thrd)->flags &= ~THR_FLAGS_IN_GCLIST; \
920 #define GC_NEEDED() (atomic_load_acq_int(&_gc_count) >= 5)
923 * Locking the scheduling queue for another thread uses that thread's
926 #define THR_SCHED_LOCK(curthr, thr) do { \
927 (curthr)->critical[(curthr)->locklevel] = _kse_critical_enter(); \
928 (curthr)->locklevel++; \
929 KSE_SCHED_LOCK((curthr)->kse, (thr)->kseg); \
932 #define THR_SCHED_UNLOCK(curthr, thr) do { \
933 KSE_SCHED_UNLOCK((curthr)->kse, (thr)->kseg); \
934 (curthr)->locklevel--; \
935 _kse_critical_leave((curthr)->critical[(curthr)->locklevel]); \
938 /* Take the scheduling lock with the intent to call the scheduler. */
939 #define THR_LOCK_SWITCH(curthr) do { \
940 (void)_kse_critical_enter(); \
941 KSE_SCHED_LOCK((curthr)->kse, (curthr)->kseg); \
943 #define THR_UNLOCK_SWITCH(curthr) do { \
944 KSE_SCHED_UNLOCK((curthr)->kse, (curthr)->kseg);\
947 #define THR_CRITICAL_ENTER(thr) (thr)->critical_count++
948 #define THR_CRITICAL_LEAVE(thr) do { \
949 (thr)->critical_count--; \
950 if (((thr)->critical_yield != 0) && \
951 ((thr)->critical_count == 0)) { \
952 (thr)->critical_yield = 0; \
953 _thr_sched_switch(thr); \
957 #define THR_IS_ACTIVE(thrd) \
958 ((thrd)->kse != NULL) && ((thrd)->kse->k_curthread == (thrd))
960 #define THR_IN_SYNCQ(thrd) (((thrd)->sflags & THR_FLAGS_IN_SYNCQ) != 0)
962 #define THR_IS_SUSPENDED(thrd) \
963 (((thrd)->state == PS_SUSPENDED) || \
964 (((thrd)->flags & THR_FLAGS_SUSPENDED) != 0))
965 #define THR_IS_EXITING(thrd) (((thrd)->flags & THR_FLAGS_EXITING) != 0)
967 extern int __isthreaded;
970 _kse_isthreaded(void)
972 return (__isthreaded != 0);
976 * Global variables for the pthread kernel.
979 SCLASS void *_usrstack SCLASS_PRESET(NULL);
980 SCLASS struct kse *_kse_initial SCLASS_PRESET(NULL);
981 SCLASS struct pthread *_thr_initial SCLASS_PRESET(NULL);
983 /* List of all threads: */
984 SCLASS TAILQ_HEAD(, pthread) _thread_list
985 SCLASS_PRESET(TAILQ_HEAD_INITIALIZER(_thread_list));
987 /* List of threads needing GC: */
988 SCLASS TAILQ_HEAD(, pthread) _thread_gc_list
989 SCLASS_PRESET(TAILQ_HEAD_INITIALIZER(_thread_gc_list));
991 SCLASS int _thr_active_threads SCLASS_PRESET(1);
993 SCLASS TAILQ_HEAD(atfork_head, pthread_atfork) _thr_atfork_list;
994 SCLASS pthread_mutex_t _thr_atfork_mutex;
996 /* Default thread attributes: */
997 SCLASS struct pthread_attr _pthread_attr_default
999 SCHED_RR, 0, TIMESLICE_USEC, THR_DEFAULT_PRIORITY,
1000 THR_CREATE_RUNNING, PTHREAD_CREATE_JOINABLE, NULL,
1001 NULL, NULL, THR_STACK_DEFAULT, /* guardsize */0
1004 /* Default mutex attributes: */
1005 SCLASS struct pthread_mutex_attr _pthread_mutexattr_default
1006 SCLASS_PRESET({PTHREAD_MUTEX_DEFAULT, PTHREAD_PRIO_NONE, 0, 0 });
1008 /* Default condition variable attributes: */
1009 SCLASS struct pthread_cond_attr _pthread_condattr_default
1010 SCLASS_PRESET({COND_TYPE_FAST, 0});
1012 /* Clock resolution in usec. */
1013 SCLASS int _clock_res_usec SCLASS_PRESET(CLOCK_RES_USEC);
1015 /* Array of signal actions for this process: */
1016 SCLASS struct sigaction _thread_sigact[_SIG_MAXSIG];
1019 * Lock for above count of dummy handlers and for the process signal
1020 * mask and pending signal sets.
1022 SCLASS struct lock _thread_signal_lock;
1024 /* Pending signals and mask for this process: */
1025 SCLASS sigset_t _thr_proc_sigpending;
1026 SCLASS siginfo_t _thr_proc_siginfo[_SIG_MAXSIG];
1028 SCLASS pid_t _thr_pid SCLASS_PRESET(0);
1030 /* Garbage collector lock. */
1031 SCLASS struct lock _gc_lock;
1032 SCLASS int _gc_check SCLASS_PRESET(0);
1033 SCLASS int _gc_count SCLASS_PRESET(0);
1035 SCLASS struct lock _mutex_static_lock;
1036 SCLASS struct lock _rwlock_static_lock;
1037 SCLASS struct lock _keytable_lock;
1038 SCLASS struct lock _thread_list_lock;
1039 SCLASS int _thr_guard_default;
1040 SCLASS int _thr_page_size;
1041 SCLASS pthread_t _thr_sig_daemon;
1042 SCLASS int _thr_debug_flags SCLASS_PRESET(0);
1044 /* Undefine the storage class and preset specifiers: */
1046 #undef SCLASS_PRESET
1050 * Function prototype definitions.
1053 int _cond_reinit(pthread_cond_t *);
1054 void _cond_wait_backout(struct pthread *);
1055 struct kse *_kse_alloc(struct pthread *, int sys_scope);
1056 kse_critical_t _kse_critical_enter(void);
1057 void _kse_critical_leave(kse_critical_t);
1058 int _kse_in_critical(void);
1059 void _kse_free(struct pthread *, struct kse *);
1061 struct kse_group *_kseg_alloc(struct pthread *);
1062 void _kse_lock_wait(struct lock *, struct lockuser *lu);
1063 void _kse_lock_wakeup(struct lock *, struct lockuser *lu);
1064 void _kse_single_thread(struct pthread *);
1065 int _kse_setthreaded(int);
1066 void _kseg_free(struct kse_group *);
1067 int _mutex_cv_lock(pthread_mutex_t *);
1068 int _mutex_cv_unlock(pthread_mutex_t *);
1069 void _mutex_lock_backout(struct pthread *);
1070 void _mutex_notify_priochange(struct pthread *, struct pthread *, int);
1071 int _mutex_reinit(struct pthread_mutex *);
1072 void _mutex_unlock_private(struct pthread *);
1073 void _libpthread_init(struct pthread *);
1074 int _pq_alloc(struct pq_queue *, int, int);
1075 void _pq_free(struct pq_queue *);
1076 int _pq_init(struct pq_queue *);
1077 void _pq_remove(struct pq_queue *pq, struct pthread *);
1078 void _pq_insert_head(struct pq_queue *pq, struct pthread *);
1079 void _pq_insert_tail(struct pq_queue *pq, struct pthread *);
1080 struct pthread *_pq_first(struct pq_queue *pq);
1081 void *_pthread_getspecific(pthread_key_t);
1082 int _pthread_key_create(pthread_key_t *, void (*) (void *));
1083 int _pthread_key_delete(pthread_key_t);
1084 int _pthread_mutex_destroy(pthread_mutex_t *);
1085 int _pthread_mutex_init(pthread_mutex_t *, const pthread_mutexattr_t *);
1086 int _pthread_mutex_lock(pthread_mutex_t *);
1087 int _pthread_mutex_trylock(pthread_mutex_t *);
1088 int _pthread_mutex_unlock(pthread_mutex_t *);
1089 int _pthread_mutexattr_init(pthread_mutexattr_t *);
1090 int _pthread_mutexattr_destroy(pthread_mutexattr_t *);
1091 int _pthread_mutexattr_settype(pthread_mutexattr_t *, int);
1092 int _pthread_once(pthread_once_t *, void (*) (void));
1093 int _pthread_rwlock_init(pthread_rwlock_t *, const pthread_rwlockattr_t *);
1094 int _pthread_rwlock_destroy (pthread_rwlock_t *);
1095 struct pthread *_pthread_self(void);
1096 int _pthread_setspecific(pthread_key_t, const void *);
1097 void _pthread_yield(void);
1098 void _pthread_cleanup_push(void (*routine) (void *), void *routine_arg);
1099 void _pthread_cleanup_pop(int execute);
1100 struct pthread *_thr_alloc(struct pthread *);
1101 void _thr_exit(char *, int, char *);
1102 void _thr_exit_cleanup(void);
1103 void _thr_lock_wait(struct lock *lock, struct lockuser *lu);
1104 void _thr_lock_wakeup(struct lock *lock, struct lockuser *lu);
1105 void _thr_mutex_reinit(pthread_mutex_t *);
1106 int _thr_ref_add(struct pthread *, struct pthread *, int);
1107 void _thr_ref_delete(struct pthread *, struct pthread *);
1108 void _thr_rtld_init(void);
1109 void _thr_rtld_fini(void);
1110 int _thr_schedule_add(struct pthread *, struct pthread *);
1111 void _thr_schedule_remove(struct pthread *, struct pthread *);
1112 void _thr_setrunnable(struct pthread *curthread, struct pthread *thread);
1113 struct kse_mailbox *_thr_setrunnable_unlocked(struct pthread *thread);
1114 struct kse_mailbox *_thr_sig_add(struct pthread *, int, siginfo_t *);
1115 void _thr_sig_dispatch(struct kse *, int, siginfo_t *);
1116 int _thr_stack_alloc(struct pthread_attr *);
1117 void _thr_stack_free(struct pthread_attr *);
1118 void _thr_exit_cleanup(void);
1119 void _thr_free(struct pthread *, struct pthread *);
1120 void _thr_gc(struct pthread *);
1121 void _thr_panic_exit(char *, int, char *);
1122 void _thread_cleanupspecific(void);
1123 void _thread_dump_info(void);
1124 void _thread_printf(int, const char *, ...);
1125 void _thr_sched_switch(struct pthread *);
1126 void _thr_sched_switch_unlocked(struct pthread *);
1127 void _thr_set_timeout(const struct timespec *);
1128 void _thr_seterrno(struct pthread *, int);
1129 void _thr_sig_handler(int, siginfo_t *, ucontext_t *);
1130 void _thr_sig_check_pending(struct pthread *);
1131 void _thr_sig_rundown(struct pthread *, ucontext_t *,
1132 struct pthread_sigframe *);
1133 void _thr_sig_send(struct pthread *pthread, int sig);
1134 void _thr_sigframe_restore(struct pthread *thread, struct pthread_sigframe *psf);
1135 void _thr_spinlock_init(void);
1136 void _thr_cancel_enter(struct pthread *);
1137 void _thr_cancel_leave(struct pthread *, int);
1138 int _thr_setconcurrency(int new_level);
1139 int _thr_setmaxconcurrency(void);
1140 void _thr_critical_enter(struct pthread *);
1141 void _thr_critical_leave(struct pthread *);
1142 int _thr_start_sig_daemon(void);
1143 int _thr_getprocsig(int sig, siginfo_t *siginfo);
1144 int _thr_getprocsig_unlocked(int sig, siginfo_t *siginfo);
1145 void _thr_signal_init(void);
1146 void _thr_signal_deinit(void);
1147 void _thr_hash_add(struct pthread *);
1148 void _thr_hash_remove(struct pthread *);
1149 struct pthread *_thr_hash_find(struct pthread *);
1150 void _thr_finish_cancellation(void *arg);
1151 int _thr_sigonstack(void *sp);
1154 * Aliases for _pthread functions. Should be called instead of
1155 * originals if PLT replocation is unwanted at runtme.
1157 int _thr_cond_broadcast(pthread_cond_t *);
1158 int _thr_cond_signal(pthread_cond_t *);
1159 int _thr_cond_wait(pthread_cond_t *, pthread_mutex_t *);
1160 int _thr_mutex_lock(pthread_mutex_t *);
1161 int _thr_mutex_unlock(pthread_mutex_t *);
1162 int _thr_rwlock_rdlock (pthread_rwlock_t *);
1163 int _thr_rwlock_wrlock (pthread_rwlock_t *);
1164 int _thr_rwlock_unlock (pthread_rwlock_t *);
1166 /* #include <sys/aio.h> */
1168 int __sys_aio_suspend(const struct aiocb * const[], int, const struct timespec *);
1171 /* #include <fcntl.h> */
1172 #ifdef _SYS_FCNTL_H_
1173 int __sys_fcntl(int, int, ...);
1174 int __sys_open(const char *, int, ...);
1177 /* #include <sys/ioctl.h> */
1178 #ifdef _SYS_IOCTL_H_
1179 int __sys_ioctl(int, unsigned long, ...);
1182 /* #inclde <sched.h> */
1184 int __sys_sched_yield(void);
1187 /* #include <signal.h> */
1189 int __sys_kill(pid_t, int);
1190 int __sys_sigaction(int, const struct sigaction *, struct sigaction *);
1191 int __sys_sigpending(sigset_t *);
1192 int __sys_sigprocmask(int, const sigset_t *, sigset_t *);
1193 int __sys_sigsuspend(const sigset_t *);
1194 int __sys_sigreturn(ucontext_t *);
1195 int __sys_sigaltstack(const struct sigaltstack *, struct sigaltstack *);
1198 /* #include <sys/socket.h> */
1199 #ifdef _SYS_SOCKET_H_
1200 int __sys_accept(int, struct sockaddr *, socklen_t *);
1201 int __sys_connect(int, const struct sockaddr *, socklen_t);
1202 int __sys_sendfile(int, int, off_t, size_t, struct sf_hdtr *,
1206 /* #include <sys/uio.h> */
1208 ssize_t __sys_readv(int, const struct iovec *, int);
1209 ssize_t __sys_writev(int, const struct iovec *, int);
1212 /* #include <time.h> */
1214 int __sys_nanosleep(const struct timespec *, struct timespec *);
1217 /* #include <unistd.h> */
1219 int __sys_close(int);
1220 int __sys_execve(const char *, char * const *, char * const *);
1221 int __sys_fork(void);
1222 int __sys_fsync(int);
1223 pid_t __sys_getpid(void);
1224 int __sys_select(int, fd_set *, fd_set *, fd_set *, struct timeval *);
1225 ssize_t __sys_read(int, void *, size_t);
1226 ssize_t __sys_write(int, const void *, size_t);
1227 void __sys_exit(int);
1228 int __sys_sigwait(const sigset_t *, int *);
1229 int __sys_sigtimedwait(sigset_t *, siginfo_t *, struct timespec *);
1232 /* #include <poll.h> */
1234 int __sys_poll(struct pollfd *, unsigned, int);
1237 /* #include <sys/mman.h> */
1239 int __sys_msync(void *, size_t, int);
1242 #endif /* !_THR_PRIVATE_H */