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