xref: /titanic_51/usr/src/lib/libc/inc/thr_uberdata.h (revision 7f79af0b29c00a006403444f61b261219f63cfbf)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 
22 /*
23  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 
27 #ifndef _THR_UBERDATA_H
28 #define	_THR_UBERDATA_H
29 
30 #include <stdlib.h>
31 #include <unistd.h>
32 #include <sys/types.h>
33 #include <fcntl.h>
34 #include <string.h>
35 #include <signal.h>
36 #include <ucontext.h>
37 #include <thread.h>
38 #include <pthread.h>
39 #include <atomic.h>
40 #include <link.h>
41 #include <sys/resource.h>
42 #include <sys/lwp.h>
43 #include <errno.h>
44 #include <sys/asm_linkage.h>
45 #include <sys/regset.h>
46 #include <sys/fcntl.h>
47 #include <sys/mman.h>
48 #include <synch.h>
49 #include <door.h>
50 #include <limits.h>
51 #include <sys/synch32.h>
52 #include <schedctl.h>
53 #include <sys/priocntl.h>
54 #include <thread_db.h>
55 #include <setjmp.h>
56 #include "libc_int.h"
57 #include "tdb_agent.h"
58 #include "thr_debug.h"
59 
60 /*
61  * This is an implementation-specific include file for threading support.
62  * It is not to be seen by the clients of the library.
63  *
64  * This file also describes uberdata in libc.
65  *
66  * The term "uberdata" refers to data that is unique and visible across
67  * all link maps.  The name is meant to imply that such data is truly
68  * global, not just locally global to a particular link map.
69  *
70  * See the Linker and Libraries Guide for a full description of alternate
71  * link maps and how they are set up and used.
72  *
73  * Alternate link maps implement multiple global namespaces within a single
74  * process.  There may be multiple instances of identical dynamic libraries
75  * loaded in a process's address space at the same time, each on a different
76  * link map (as determined by the dynamic linker), each with its own set of
77  * global variables.  Which particular instance of a global variable is seen
78  * by a thread running in the process is determined by the link map on which
79  * the thread happens to be executing at the time.
80  *
81  * However, there are aspects of a process that are unique across all
82  * link maps, in particular the structures used to implement threads
83  * of control (in Sparc terminology, there is only one %g7 regardless
84  * of the link map on which the thread is executing).
85  *
86  * All uberdata is referenced from a base pointer in the thread's ulwp_t
87  * structure (which is also uberdata).  All allocations and deallocations
88  * of uberdata are made via the uberdata-aware lmalloc() and lfree()
89  * interfaces (malloc() and free() are simply locally-global).
90  */
91 
92 /*
93  * Special libc-private access to errno.
94  * We do this so that references to errno do not invoke the dynamic linker.
95  */
96 #undef errno
97 #define	errno (*curthread->ul_errnop)
98 
99 /*
100  * See <sys/synch32.h> for the reasons for these values
101  * and why they are different for sparc and intel.
102  */
103 #if defined(__sparc)
104 
105 /* lock.lock64.pad[x]	   4 5 6 7 */
106 #define	LOCKMASK	0xff000000
107 #define	WAITERMASK	0x000000ff
108 #define	SPINNERMASK	0x00ff0000
109 #define	SPINNERSHIFT	16
110 #define	WAITER		0x00000001
111 #define	LOCKSET		0xff
112 #define	LOCKCLEAR	0
113 
114 #define	PIDSHIFT	32
115 #define	LOCKMASK64	0xffffffffff000000ULL
116 #define	LOCKBYTE64	0x00000000ff000000ULL
117 #define	WAITERMASK64	0x00000000000000ffULL
118 #define	SPINNERMASK64	0x0000000000ff0000ULL
119 
120 #elif defined(__x86)
121 
122 /* lock.lock64.pad[x]	   7 6 5 4 */
123 #define	LOCKMASK	0xff000000
124 #define	WAITERMASK	0x00ff0000
125 #define	SPINNERMASK	0x0000ff00
126 #define	SPINNERSHIFT	8
127 #define	WAITER		0x00010000
128 #define	LOCKSET		0x01
129 #define	LOCKCLEAR	0
130 
131 #define	PIDSHIFT	0
132 #define	LOCKMASK64	0xff000000ffffffffULL
133 #define	LOCKBYTE64	0x0100000000000000ULL
134 #define	WAITERMASK64	0x00ff000000000000ULL
135 #define	SPINNERMASK64	0x0000ff0000000000ULL
136 
137 #else
138 #error "neither __sparc nor __x86 is defined"
139 #endif
140 
141 /*
142  * Fetch the owner of a USYNC_THREAD mutex.
143  * Don't use this with process-shared mutexes;
144  * the owing thread may be in a different process.
145  */
146 #define	MUTEX_OWNER(mp)	((ulwp_t *)(uintptr_t)(mp)->mutex_owner)
147 
148 /*
149  * Test if a thread owns a process-private (USYNC_THREAD) mutex.
150  * This is inappropriate for a process-shared (USYNC_PROCESS) mutex.
151  * The 'mp' argument must not have side-effects since it is evaluated twice.
152  */
153 #define	MUTEX_OWNED(mp, thrp)	\
154 	((mp)->mutex_lockw != 0 && MUTEX_OWNER(mp) == thrp)
155 
156 
157 /*
158  * uberflags.uf_tdb_register_sync is an interface with libc_db to enable the
159  * collection of lock statistics by a debugger or other collecting tool.
160  *
161  * uberflags.uf_thread_error_detection is set by an environment variable:
162  *	_THREAD_ERROR_DETECTION
163  *		0 == no detection of locking primitive errors.
164  *		1 == detect errors and issue a warning message.
165  *		2 == detect errors, issue a warning message, and dump core.
166  *
167  * We bundle these together in uberflags.uf_trs_ted to make a test of either
168  * being non-zero a single memory reference (for speed of mutex_lock(), etc).
169  *
170  * uberflags.uf_mt is set non-zero when the first thread (in addition
171  * to the main thread) is created.
172  *
173  * We bundle all these flags together in uberflags.uf_all to make a test
174  * of any being non-zero a single memory reference (again, for speed).
175  */
176 typedef union {
177 	int	uf_all;			/* combined all flags */
178 	struct {
179 		short	h_pad;
180 		short	h_trs_ted;	/* combined reg sync & error detect */
181 	} uf_h;
182 	struct {
183 		char	x_mt;
184 		char	x_pad;
185 		char	x_tdb_register_sync;
186 		char	x_thread_error_detection;
187 	} uf_x;
188 } uberflags_t;
189 
190 #define	uf_mt				uf_x.x_mt
191 #define	uf_tdb_register_sync		uf_x.x_tdb_register_sync
192 #define	uf_thread_error_detection	uf_x.x_thread_error_detection
193 #define	uf_trs_ted			uf_h.h_trs_ted	/* both of the above */
194 
195 /*
196  * NOTE WELL:
197  * To enable further optimization, the "ul_schedctl_called" member
198  * of the ulwp_t structure (below) serves double-duty:
199  *	1. If NULL, it means that the thread must call __schedctl()
200  *	   to set up its schedctl mappings before acquiring a mutex.
201  *	   This is required by the implementation of adaptive mutex locking.
202  *	2. If non-NULL, it points to uberdata.uberflags, so that tests of
203  *	   uberflags can be made without additional memory references.
204  * This allows the common case of _mutex_lock() and _mutex_unlock() for
205  * USYNC_THREAD mutexes with no error detection and no lock statistics
206  * to be optimized for speed.
207  */
208 
209 /* double the default stack size for 64-bit processes */
210 #ifdef _LP64
211 #define	MINSTACK	(8 * 1024)
212 #define	DEFAULTSTACK	(2 * 1024 * 1024)
213 #else
214 #define	MINSTACK	(4 * 1024)
215 #define	DEFAULTSTACK	(1024 * 1024)
216 #endif
217 
218 #define	MUTEX_TRY	0
219 #define	MUTEX_LOCK	1
220 #define	MUTEX_NOCEIL	0x40
221 
222 #if defined(__x86)
223 
224 typedef struct {	/* structure returned by fnstenv */
225 	int	fctrl;		/* control word */
226 	int	fstat;		/* status word (flags, etc) */
227 	int	ftag;		/* tag of which regs busy */
228 	int	misc[4];	/* other stuff, 28 bytes total */
229 } fpuenv_t;
230 
231 #ifdef _SYSCALL32
232 typedef fpuenv_t fpuenv32_t;
233 #endif	/* _SYSCALL32 */
234 
235 #elif defined(__sparc)
236 
237 typedef struct {	/* fp state structure */
238 	greg_t	fsr;
239 	greg_t	fpu_en;
240 } fpuenv_t;
241 
242 #ifdef _SYSCALL32
243 typedef struct {
244 	greg32_t	fsr;
245 	greg32_t	fpu_en;
246 } fpuenv32_t;
247 #endif	/* _SYSCALL32 */
248 
249 #endif	/* __x86 */
250 
251 #if defined(__x86)
252 extern	void	ht_pause(void);		/* "pause" instruction */
253 #define	SMT_PAUSE()	ht_pause()
254 #else
255 #define	SMT_PAUSE()
256 #endif	/* __x86 */
257 
258 /*
259  * Cleanup handler related data.
260  * This structure is exported as _cleanup_t in pthread.h.
261  * pthread.h exports only the size of this structure, so check
262  * _cleanup_t in pthread.h before making any change here.
263  */
264 typedef struct __cleanup {
265 	struct __cleanup *next;		/* pointer to next handler */
266 	caddr_t	fp;			/* current frame pointer */
267 	void	(*func)(void *);	/* cleanup handler address */
268 	void	*arg;			/* handler's argument */
269 } __cleanup_t;
270 
271 /*
272  * Thread-Specific Data (TSD)
273  * TSD_NFAST includes the invalid key zero, so there
274  * are really only (TSD_NFAST - 1) fast key slots.
275  */
276 typedef	void (*PFrV)(void *);
277 #define	TSD_UNALLOCATED	((PFrV)1)
278 #define	TSD_NFAST	9
279 
280 /*
281  * The tsd union is designed to burn a little memory (9 words) to make
282  * lookups blindingly fast.  Note that tsd_nalloc could be placed at the
283  * end of the pad region to increase the likelihood that it falls on the
284  * same cache line as the data.
285  */
286 typedef union tsd {
287 	uint_t tsd_nalloc;		/* Amount of allocated storage */
288 	void *tsd_pad[TSD_NFAST];
289 	void *tsd_data[1];
290 } tsd_t;
291 
292 typedef struct {
293 	mutex_t tsdm_lock;		/* Lock protecting the data */
294 	uint_t tsdm_nkeys;		/* Number of allocated keys */
295 	uint_t tsdm_nused;		/* Number of used keys */
296 	PFrV *tsdm_destro;		/* Per-key destructors */
297 	char tsdm_pad[64 -		/* pad to 64 bytes */
298 		(sizeof (mutex_t) + 2 * sizeof (uint_t) + sizeof (PFrV *))];
299 } tsd_metadata_t;
300 
301 #ifdef _SYSCALL32
302 typedef union tsd32 {
303 	uint_t tsd_nalloc;		/* Amount of allocated storage */
304 	caddr32_t tsd_pad[TSD_NFAST];
305 	caddr32_t tsd_data[1];
306 } tsd32_t;
307 
308 typedef struct {
309 	mutex_t tsdm_lock;		/* Lock protecting the data */
310 	uint_t tsdm_nkeys;		/* Number of allocated keys */
311 	uint_t tsdm_nused;		/* Number of used keys */
312 	caddr32_t tsdm_destro;		/* Per-key destructors */
313 	char tsdm_pad[64 -		/* pad to 64 bytes */
314 		(sizeof (mutex_t) + 2 * sizeof (uint_t) + sizeof (caddr32_t))];
315 } tsd_metadata32_t;
316 #endif	/* _SYSCALL32 */
317 
318 
319 /*
320  * Thread-Local Storage (TLS)
321  */
322 typedef struct {
323 	void		*tls_data;
324 	size_t		tls_size;
325 } tls_t;
326 
327 typedef struct {
328 	mutex_t	tls_lock;		/* Lock protecting the data */
329 	tls_t	tls_modinfo;		/* Root of all TLS_modinfo data */
330 	tls_t	static_tls;		/* Template for static TLS */
331 	char	tls_pad[64 -		/* pad to 64 bytes */
332 		(sizeof (mutex_t) + 2 * sizeof (tls_t))];
333 } tls_metadata_t;
334 
335 #ifdef _SYSCALL32
336 typedef struct {
337 	caddr32_t	tls_data;
338 	size32_t	tls_size;
339 } tls32_t;
340 
341 typedef struct {
342 	mutex_t	tls_lock;		/* Lock protecting the data */
343 	tls32_t	tls_modinfo;		/* Root of all TLS_modinfo data */
344 	tls32_t	static_tls;		/* Template for static TLS */
345 	char	tls_pad[64 -		/* pad to 64 bytes */
346 		(sizeof (mutex_t) + 2 * sizeof (tls32_t))];
347 } tls_metadata32_t;
348 #endif	/* _SYSCALL32 */
349 
350 
351 /*
352  * Sleep queue root for USYNC_THREAD condvars and mutexes.
353  * There is a default queue root for each queue head (see below).
354  * Also, each ulwp_t contains a queue root that can be used
355  * when the thread is enqueued on the queue, if necessary
356  * (when more than one wchan hashes to the same queue head).
357  */
358 typedef struct queue_root {
359 	struct queue_root	*qr_next;
360 	struct queue_root	*qr_prev;
361 	struct ulwp		*qr_head;
362 	struct ulwp		*qr_tail;
363 	void			*qr_wchan;
364 	uint32_t		qr_rtcount;
365 	uint32_t		qr_qlen;
366 	uint32_t		qr_qmax;
367 } queue_root_t;
368 
369 #ifdef _SYSCALL32
370 typedef struct queue_root32 {
371 	caddr32_t		qr_next;
372 	caddr32_t		qr_prev;
373 	caddr32_t		qr_head;
374 	caddr32_t		qr_tail;
375 	caddr32_t		qr_wchan;
376 	uint32_t		qr_rtcount;
377 	uint32_t		qr_qlen;
378 	uint32_t		qr_qmax;
379 } queue_root32_t;
380 #endif
381 
382 /*
383  * Sleep queue heads for USYNC_THREAD condvars and mutexes.
384  * The size and alignment is 128 bytes to reduce cache conflicts.
385  * Each queue head points to a list of queue roots, defined above.
386  * Each queue head contains a default queue root for use when only one
387  * is needed.  It is always at the tail of the queue root hash chain.
388  */
389 typedef union {
390 	uint64_t		qh_64[16];
391 	struct {
392 		mutex_t		q_lock;
393 		uint8_t		q_qcnt;
394 		uint8_t		q_type;		/* MX or CV */
395 		uint8_t		q_pad1[2];
396 		uint32_t	q_lockcount;
397 		uint32_t	q_qlen;
398 		uint32_t	q_qmax;
399 		void		*q_wchan;	/* valid only while locked */
400 		struct queue_root *q_root;	/* valid only while locked */
401 		struct queue_root *q_hlist;
402 #if !defined(_LP64)
403 		caddr_t		q_pad2[3];
404 #endif
405 		queue_root_t	q_def_root;
406 		uint32_t	q_hlen;
407 		uint32_t	q_hmax;
408 	} qh_qh;
409 } queue_head_t;
410 
411 #define	qh_lock		qh_qh.q_lock
412 #define	qh_qcnt		qh_qh.q_qcnt
413 #define	qh_type		qh_qh.q_type
414 #if defined(THREAD_DEBUG)
415 #define	qh_lockcount	qh_qh.q_lockcount
416 #define	qh_qlen		qh_qh.q_qlen
417 #define	qh_qmax		qh_qh.q_qmax
418 #endif
419 #define	qh_wchan	qh_qh.q_wchan
420 #define	qh_root		qh_qh.q_root
421 #define	qh_hlist	qh_qh.q_hlist
422 #define	qh_def_root	qh_qh.q_def_root
423 #define	qh_hlen		qh_qh.q_hlen
424 #define	qh_hmax		qh_qh.q_hmax
425 
426 /* queue types passed to queue_lock() */
427 #define	MX	0
428 #define	CV	1
429 #define	QHASHSHIFT	9			/* number of hashing bits */
430 #define	QHASHSIZE	(1 << QHASHSHIFT)	/* power of 2 (1<<9 == 512) */
431 #define	QUEUE_HASH(wchan, type)	((uint_t)			\
432 	((((uintptr_t)(wchan) >> 3)				\
433 	^ ((uintptr_t)(wchan) >> (QHASHSHIFT + 3)))		\
434 	& (QHASHSIZE - 1)) + (((type) == MX)? 0 : QHASHSIZE))
435 
436 extern	queue_head_t	*queue_lock(void *, int);
437 extern	void		queue_unlock(queue_head_t *);
438 extern	void		enqueue(queue_head_t *, struct ulwp *, int);
439 extern	struct ulwp	*dequeue(queue_head_t *, int *);
440 extern	struct ulwp	**queue_slot(queue_head_t *, struct ulwp **, int *);
441 extern	struct ulwp	*queue_waiter(queue_head_t *);
442 extern	int		dequeue_self(queue_head_t *);
443 extern	void		queue_unlink(queue_head_t *,
444 				struct ulwp **, struct ulwp *);
445 extern	void		unsleep_self(void);
446 extern	void		spin_lock_set(mutex_t *);
447 extern	void		spin_lock_clear(mutex_t *);
448 
449 /*
450  * Scheduling class information structure.
451  */
452 typedef struct {
453 	short		pcc_state;
454 	short		pcc_policy;
455 	pri_t		pcc_primin;
456 	pri_t		pcc_primax;
457 	pcinfo_t	pcc_info;
458 } pcclass_t;
459 
460 /*
461  * Memory block for chain of owned ceiling mutexes.
462  */
463 typedef struct mxchain {
464 	struct mxchain	*mxchain_next;
465 	mutex_t		*mxchain_mx;
466 } mxchain_t;
467 
468 /*
469  * Pointer to an rwlock that is held for reading.
470  * Used in rw_rdlock() to allow a thread that already holds a read
471  * lock to acquire another read lock on the same rwlock even if
472  * there are writers waiting.  This to avoid deadlock when acquiring
473  * a read lock more than once in the presence of pending writers.
474  * POSIX mandates this behavior.
475  */
476 typedef struct {
477 	void	*rd_rwlock;	/* the rwlock held for reading */
478 	size_t	rd_count;	/* count of read locks applied */
479 } readlock_t;
480 
481 #ifdef _SYSCALL32
482 typedef struct {
483 	caddr32_t	rd_rwlock;
484 	size32_t	rd_count;
485 } readlock32_t;
486 #endif	/* _SYSCALL32 */
487 
488 /*
489  * Maximum number of read locks allowed for one thread on one rwlock.
490  * This could be as large as INT_MAX, but the SUSV3 test suite would
491  * take an inordinately long time to complete.  This is big enough.
492  */
493 #define	READ_LOCK_MAX	100000
494 
495 #define	ul_tlsent	ul_tls.tls_data	/* array of pointers to dynamic TLS */
496 #define	ul_ntlsent	ul_tls.tls_size	/* number of entries in ul_tlsent */
497 
498 /*
499  * Round up an integral value to a multiple of 64
500  */
501 #define	roundup64(x)	(-(-(x) & -64))
502 
503 /*
504  * NOTE:  Whatever changes are made to ulwp_t must be
505  * reflected in $SRC/cmd/mdb/common/modules/libc/libc.c
506  *
507  * NOTE: ul_self *must* be the first member of ulwp_t on x86
508  * Low-level x86 code relies on this.
509  */
510 typedef struct ulwp {
511 	/*
512 	 * These members always need to come first on sparc.
513 	 * For dtrace, a ulwp_t must be aligned on a 64-byte boundary.
514 	 */
515 #if defined(__sparc)
516 	uint32_t	ul_dinstr;	/* scratch space for dtrace */
517 	uint32_t	ul_padsparc0[15];
518 	uint32_t	ul_dsave;	/* dtrace: save %g1, %g0, %sp */
519 	uint32_t	ul_drestore;	/* dtrace: restore %g0, %g0, %g0 */
520 	uint32_t	ul_dftret;	/* dtrace: return probe fasttrap */
521 	uint32_t	ul_dreturn;	/* dtrace: return %o0 */
522 #endif
523 	struct ulwp	*ul_self;	/* pointer to self */
524 #if defined(__i386)
525 	uint8_t		ul_dinstr[40];	/* scratch space for dtrace */
526 #elif defined(__amd64)
527 	uint8_t		ul_dinstr[56];	/* scratch space for dtrace */
528 #endif
529 	struct uberdata *ul_uberdata;	/* uber (super-global) data */
530 	tls_t		ul_tls;		/* dynamic thread-local storage base */
531 	struct ulwp	*ul_forw;	/* forw, back all_lwps list, */
532 	struct ulwp	*ul_back;	/* protected by link_lock */
533 	struct ulwp	*ul_next;	/* list to keep track of stacks */
534 	struct ulwp	*ul_hash;	/* hash chain linked list */
535 	void		*ul_rval;	/* return value from thr_exit() */
536 	caddr_t		ul_stk;		/* mapping base of the stack */
537 	size_t		ul_mapsiz;	/* mapping size of the stack */
538 	size_t		ul_guardsize;	/* normally _lpagesize */
539 	uintptr_t	ul_stktop;	/* broken thr_stksegment() interface */
540 	size_t		ul_stksiz;	/* broken thr_stksegment() interface */
541 	stack_t		ul_ustack;	/* current stack boundaries */
542 	int		ul_ix;		/* hash index */
543 	lwpid_t		ul_lwpid;	/* thread id, aka the lwp id */
544 	pri_t		ul_pri;		/* scheduling priority */
545 	pri_t		ul_epri;	/* real-time ceiling priority */
546 	char		ul_policy;	/* scheduling policy */
547 	char		ul_cid;		/* scheduling class id */
548 	union {
549 		struct {
550 			char	cursig;	/* deferred signal number */
551 			char	pleasestop; /* lwp requested to stop itself */
552 		} s;
553 		short	curplease;	/* for testing both at once */
554 	} ul_cp;
555 	char		ul_stop;	/* reason for stopping */
556 	char		ul_signalled;	/* this lwp was cond_signal()d */
557 	char		ul_dead;	/* this lwp has called thr_exit */
558 	char		ul_unwind;	/* posix: unwind C++ stack */
559 	char		ul_detached;	/* THR_DETACHED at thread_create() */
560 					/* or pthread_detach() was called */
561 	char		ul_writer;	/* sleeping in rw_wrlock() */
562 	char		ul_stopping;	/* set by curthread: stopping self */
563 	char		ul_cancel_prologue;	/* for _cancel_prologue() */
564 	short		ul_preempt;	/* no_preempt()/preempt() */
565 	short		ul_savpreempt;	/* pre-existing preempt value */
566 	char		ul_sigsuspend;	/* thread is in sigsuspend/pollsys */
567 	char		ul_main;	/* thread is the main thread */
568 	char		ul_fork;	/* thread is performing a fork */
569 	char		ul_primarymap;	/* primary link-map is initialized */
570 	/* per-thread copies of the corresponding global variables */
571 	uint8_t		ul_max_spinners;	/* thread_max_spinners */
572 	char		ul_door_noreserve;	/* thread_door_noreserve */
573 	char		ul_queue_fifo;		/* thread_queue_fifo */
574 	char		ul_cond_wait_defer;	/* thread_cond_wait_defer */
575 	char		ul_error_detection;	/* thread_error_detection */
576 	char		ul_async_safe;		/* thread_async_safe */
577 	char		ul_rt;			/* found on an RT queue */
578 	char		ul_rtqueued;		/* was RT when queued */
579 	char		ul_misaligned;		/* thread_locks_misaligned */
580 	char		ul_pad[3];
581 	int		ul_adaptive_spin;	/* thread_adaptive_spin */
582 	int		ul_queue_spin;		/* thread_queue_spin */
583 	volatile int	ul_critical;	/* non-zero == in a critical region */
584 	int		ul_sigdefer;	/* non-zero == defer signals */
585 	int		ul_vfork;	/* thread is the child of vfork() */
586 	int		ul_cancelable;	/* _cancelon()/_canceloff() */
587 	char		ul_cancel_pending;  /* pthread_cancel() was called */
588 	char		ul_cancel_disabled; /* PTHREAD_CANCEL_DISABLE */
589 	char		ul_cancel_async;    /* PTHREAD_CANCEL_ASYNCHRONOUS */
590 	char		ul_save_async;	/* saved copy of ul_cancel_async */
591 	char		ul_mutator;	/* lwp is a mutator (java interface) */
592 	char		ul_created;	/* created suspended */
593 	char		ul_replace;	/* replacement; must be free()d */
594 	uchar_t		ul_nocancel;	/* cancellation can't happen */
595 	int		ul_errno;	/* per-thread errno */
596 	int		*ul_errnop;	/* pointer to errno or self->ul_errno */
597 	__cleanup_t	*ul_clnup_hdr;	/* head of cleanup handlers list */
598 	uberflags_t	*ul_schedctl_called;	/* ul_schedctl is set up */
599 	volatile sc_shared_t *ul_schedctl;	/* schedctl data */
600 	int		ul_bindflags;	/* bind_guard() interface to ld.so.1 */
601 	uint_t		ul_libc_locks;	/* count of cancel_safe_mutex_lock()s */
602 	tsd_t		*ul_stsd;	/* slow TLS for keys >= TSD_NFAST */
603 	void		*ul_ftsd[TSD_NFAST]; /* fast TLS for keys < TSD_NFAST */
604 	td_evbuf_t	ul_td_evbuf;	/* event buffer */
605 	char		ul_td_events_enable;	/* event mechanism enabled */
606 	char		ul_sync_obj_reg;	/* tdb_sync_obj_register() */
607 	char		ul_qtype;	/* MX or CV */
608 	char		ul_cv_wake;	/* != 0: just wake up, don't requeue */
609 	int		ul_usropts;	/* flags given to thr_create() */
610 	void		*(*ul_startpc)(void *); /* start func (thr_create()) */
611 	void		*ul_startarg;	/* argument for start function */
612 	void		*ul_wchan;	/* synch object when sleeping */
613 	struct ulwp	*ul_link;	/* sleep queue link */
614 	queue_head_t	*ul_sleepq;	/* sleep queue thread is waiting on */
615 	mutex_t		*ul_cvmutex;	/* mutex dropped when waiting on a cv */
616 	mxchain_t	*ul_mxchain;	/* chain of owned ceiling mutexes */
617 	int		ul_save_state;	/* bind_guard() interface to ld.so.1 */
618 	uint_t		ul_rdlockcnt;	/* # entries in ul_readlock array */
619 				/* 0 means there is but a single entry */
620 	union {				/* single entry or pointer to array */
621 		readlock_t	single;
622 		readlock_t	*array;
623 	} ul_readlock;
624 	uint_t		ul_heldlockcnt;	/* # entries in ul_heldlocks array */
625 				/* 0 means there is but a single entry */
626 	union {				/* single entry or pointer to array */
627 		mutex_t		*single;
628 		mutex_t		**array;
629 	} ul_heldlocks;
630 	/* PROBE_SUPPORT begin */
631 	void		*ul_tpdp;
632 	/* PROBE_SUPPORT end */
633 	ucontext_t	*ul_siglink;	/* pointer to previous context */
634 	uint_t		ul_spin_lock_spin;	/* spin lock statistics */
635 	uint_t		ul_spin_lock_spin2;
636 	uint_t		ul_spin_lock_sleep;
637 	uint_t		ul_spin_lock_wakeup;
638 	queue_root_t	ul_queue_root;	/* root of a sleep queue */
639 	id_t		ul_rtclassid;	/* real-time class id */
640 	uint_t		ul_pilocks;	/* count of PI locks held */
641 		/* the following members *must* be last in the structure */
642 		/* they are discarded when ulwp is replaced on thr_exit() */
643 	sigset_t	ul_sigmask;	/* thread's current signal mask */
644 	sigset_t	ul_tmpmask;	/* signal mask for sigsuspend/pollsys */
645 	siginfo_t	ul_siginfo;	/* deferred siginfo */
646 	mutex_t		ul_spinlock;	/* used when suspending/continuing */
647 	fpuenv_t	ul_fpuenv;	/* floating point state */
648 	uintptr_t	ul_sp;		/* stack pointer when blocked */
649 	void		*ul_ex_unwind;	/* address of _ex_unwind() or -1 */
650 #if defined(sparc)
651 	void		*ul_unwind_ret;	/* used only by _ex_clnup_handler() */
652 #endif
653 } ulwp_t;
654 
655 #define	ul_cursig	ul_cp.s.cursig		/* deferred signal number */
656 #define	ul_pleasestop	ul_cp.s.pleasestop	/* lwp requested to stop */
657 #define	ul_curplease	ul_cp.curplease		/* for testing both at once */
658 
659 /*
660  * This is the size of a replacement ulwp, retained only for the benefit
661  * of thr_join().  The trailing members are unneeded for this purpose.
662  */
663 #define	REPLACEMENT_SIZE	((size_t)&((ulwp_t *)NULL)->ul_sigmask)
664 
665 /*
666  * Definitions for static initialization of signal sets,
667  * plus some sneaky optimizations in various places.
668  */
669 
670 #define	SIGMASK(sig)	((uint32_t)1 << (((sig) - 1) & (32 - 1)))
671 
672 #if (MAXSIG > 32 && MAXSIG <= 64)
673 #define	FILLSET0	0xffffffffu
674 #define	FILLSET1	((1u << (MAXSIG - 32)) - 1)
675 #else
676 #error "fix me: MAXSIG out of bounds"
677 #endif
678 
679 #define	CANTMASK0	(SIGMASK(SIGKILL) | SIGMASK(SIGSTOP))
680 #define	CANTMASK1	0
681 
682 #define	MASKSET0	(FILLSET0 & ~CANTMASK0)
683 #define	MASKSET1	(FILLSET1 & ~CANTMASK1)
684 
685 extern	const sigset_t maskset;		/* set of all maskable signals */
686 
687 extern	int	thread_adaptive_spin;
688 extern	uint_t	thread_max_spinners;
689 extern	int	thread_queue_spin;
690 extern	int	thread_queue_fifo;
691 extern	int	thread_queue_dump;
692 extern	int	thread_cond_wait_defer;
693 extern	int	thread_async_safe;
694 extern	int	thread_queue_verify;
695 
696 /*
697  * pthread_atfork() related data, used to store atfork handlers.
698  */
699 typedef struct atfork {
700 	struct atfork *forw;		/* forward pointer */
701 	struct atfork *back;		/* backward pointer */
702 	void (*prepare)(void);		/* pre-fork handler */
703 	void (*parent)(void);		/* post-fork parent handler */
704 	void (*child)(void);		/* post-fork child handler */
705 } atfork_t;
706 
707 /*
708  * Element in the table of registered process robust locks.
709  * We keep track of these to make sure that we only call
710  * ___lwp_mutex_register() once for each such lock.
711  */
712 typedef struct robust {
713 	struct robust	*robust_next;
714 	mutex_t		*robust_lock;
715 } robust_t;
716 
717 /*
718  * Parameters of the lock registration hash table.
719  */
720 #define	LOCKSHIFT	15			/* number of hashing bits */
721 #define	LOCKHASHSZ	(1 << LOCKSHIFT)	/* power of 2 (1<<15 == 32K) */
722 #define	LOCK_HASH(addr)	(uint_t)			\
723 	((((uintptr_t)(addr) >> 3)			\
724 	^ ((uintptr_t)(addr) >> (LOCKSHIFT + 3)))	\
725 	& (LOCKHASHSZ - 1))
726 
727 /*
728  * Make our hot locks reside on private cache lines (64 bytes).
729  */
730 typedef struct {
731 	mutex_t	pad_lock;
732 	char	pad_pad[64 - sizeof (mutex_t)];
733 } pad_lock_t;
734 
735 /*
736  * Make our semi-hot locks reside on semi-private cache lines (32 bytes).
737  */
738 typedef struct {
739 	mutex_t	pad_lock;
740 	char	pad_pad[32 - sizeof (mutex_t)];
741 } pad32_lock_t;
742 
743 /*
744  * The threads hash table is used for fast lookup and locking of an active
745  * thread structure (ulwp_t) given a thread-id.  It is an N-element array of
746  * thr_hash_table_t structures, where N == 1 before the main thread creates
747  * the first additional thread and N == 1024 afterwards.  Each element of the
748  * table is 64 bytes in size and alignment to reduce cache conflicts.
749  */
750 typedef struct {
751 	mutex_t	hash_lock;	/* lock per bucket */
752 	cond_t	hash_cond;	/* convar per bucket */
753 	ulwp_t	*hash_bucket;	/* hash bucket points to the list of ulwps */
754 	char	hash_pad[64 -	/* pad out to 64 bytes */
755 		(sizeof (mutex_t) + sizeof (cond_t) + sizeof (ulwp_t *))];
756 } thr_hash_table_t;
757 
758 #ifdef _SYSCALL32
759 typedef struct {
760 	mutex_t	hash_lock;
761 	cond_t	hash_cond;
762 	caddr32_t hash_bucket;
763 	char	hash_pad[64 -
764 		(sizeof (mutex_t) + sizeof (cond_t) + sizeof (caddr32_t))];
765 } thr_hash_table32_t;
766 #endif	/* _SYSCALL32 */
767 
768 
769 /*
770  * siguaction members have 128-byte size and 64-byte alignment.
771  * We know that sizeof (struct sigaction) is 32 bytes for both
772  * _ILP32 and _LP64 and that sizeof (rwlock_t) is 64 bytes.
773  */
774 typedef struct {
775 	rwlock_t	sig_lock;
776 	struct sigaction sig_uaction;
777 	char	sig_pad[128 - sizeof (rwlock_t) - sizeof (struct sigaction)];
778 } siguaction_t;
779 
780 #ifdef _SYSCALL32
781 typedef struct {
782 	rwlock_t	sig_lock;
783 	struct sigaction32 sig_uaction;
784 	char	sig_pad[128 - sizeof (rwlock_t) - sizeof (struct sigaction32)];
785 } siguaction32_t;
786 #endif	/* _SYSCALL32 */
787 
788 
789 /*
790  * Bucket structures, used by lmalloc()/lfree().
791  * See port/threads/alloc.c for details.
792  * A bucket's size and alignment is 64 bytes.
793  */
794 typedef struct {
795 	mutex_t	bucket_lock;	/* protects the free list allocations */
796 	void	*free_list;	/* LIFO list of blocks to allocate/free */
797 	size_t	chunks;		/* number of 64K blocks mmap()ed last time */
798 	char	pad64[64 -	/* pad out to 64 bytes */
799 		(sizeof (mutex_t) + sizeof (void *) + sizeof (size_t))];
800 } bucket_t;
801 
802 #ifdef _SYSCALL32
803 typedef struct {
804 	mutex_t		bucket_lock;
805 	caddr32_t	free_list;
806 	size32_t	chunks;
807 	char	pad64[64 -	/* pad out to 64 bytes */
808 		(sizeof (mutex_t) + sizeof (caddr32_t) + sizeof (size32_t))];
809 } bucket32_t;
810 #endif	/* _SYSCALL32 */
811 
812 #define	NBUCKETS	10	/* sizes ranging from 64 to 32768 */
813 
814 
815 /*
816  * atexit() data structures.
817  * See port/gen/atexit.c for details.
818  */
819 typedef void (*_exithdlr_func_t) (void);
820 
821 typedef struct _exthdlr {
822 	struct _exthdlr 	*next;	/* next in handler list */
823 	_exithdlr_func_t	hdlr;	/* handler itself */
824 } _exthdlr_t;
825 
826 typedef struct {
827 	mutex_t		exitfns_lock;
828 	_exthdlr_t	*head;
829 	void		*exit_frame_monitor;
830 	char		exit_pad[64 -	/* pad out to 64 bytes */
831 		(sizeof (mutex_t) + sizeof (_exthdlr_t *) + sizeof (void *))];
832 } atexit_root_t;
833 
834 #ifdef _SYSCALL32
835 typedef struct {
836 	mutex_t		exitfns_lock;
837 	caddr32_t	head;
838 	caddr32_t	exit_frame_monitor;
839 	char		exit_pad[64 -	/* pad out to 64 bytes */
840 		(sizeof (mutex_t) + sizeof (caddr32_t) + sizeof (caddr32_t))];
841 } atexit_root32_t;
842 #endif	/* _SYSCALL32 */
843 
844 
845 /*
846  * This is data that is global to all link maps (uberdata, aka super-global).
847  */
848 typedef struct uberdata {
849 	pad_lock_t	_link_lock;
850 	pad_lock_t	_ld_lock;
851 	pad_lock_t	_fork_lock;
852 	pad_lock_t	_atfork_lock;
853 	pad32_lock_t	_callout_lock;
854 	pad32_lock_t	_tdb_hash_lock;
855 	tdb_sync_stats_t tdb_hash_lock_stats;
856 	siguaction_t	siguaction[NSIG];
857 	bucket_t	bucket[NBUCKETS];
858 	atexit_root_t	atexit_root;
859 	tsd_metadata_t	tsd_metadata;
860 	tls_metadata_t	tls_metadata;
861 	/*
862 	 * Every object before this point has size and alignment of 64 bytes.
863 	 * Don't add any other type of data before this point.
864 	 */
865 	char	primary_map;	/* set when primary link map is initialized */
866 	char	bucket_init;	/* set when bucket[NBUCKETS] is initialized */
867 	char	pad[2];
868 	uberflags_t	uberflags;
869 	queue_head_t	*queue_head;
870 	thr_hash_table_t *thr_hash_table;
871 	uint_t		hash_size;	/* # of entries in thr_hash_table[] */
872 	uint_t		hash_mask;	/* hash_size - 1 */
873 	ulwp_t	*ulwp_one;	/* main thread */
874 	ulwp_t	*all_lwps;	/* circular ul_forw/ul_back list of live lwps */
875 	ulwp_t	*all_zombies;	/* circular ul_forw/ul_back list of zombies */
876 	int	nthreads;	/* total number of live threads/lwps */
877 	int	nzombies;	/* total number of zombie threads */
878 	int	ndaemons;	/* total number of THR_DAEMON threads/lwps */
879 	pid_t	pid;		/* the current process's pid */
880 	void	(*sigacthandler)(int, siginfo_t *, void *);
881 	ulwp_t	*lwp_stacks;
882 	ulwp_t	*lwp_laststack;
883 	int	nfreestack;
884 	int	thread_stack_cache;
885 	ulwp_t	*ulwp_freelist;
886 	ulwp_t	*ulwp_lastfree;
887 	ulwp_t	*ulwp_replace_free;
888 	ulwp_t	*ulwp_replace_last;
889 	atfork_t	*atforklist;	/* circular Q for fork handlers */
890 	robust_t	**robustlocks;	/* table of registered robust locks */
891 	struct uberdata **tdb_bootstrap;
892 	tdb_t	tdb;		/* thread debug interfaces (for libc_db) */
893 } uberdata_t;
894 
895 #define	link_lock	_link_lock.pad_lock
896 #define	ld_lock		_ld_lock.pad_lock
897 #define	fork_lock	_fork_lock.pad_lock
898 #define	atfork_lock	_atfork_lock.pad_lock
899 #define	callout_lock	_callout_lock.pad_lock
900 #define	tdb_hash_lock	_tdb_hash_lock.pad_lock
901 
902 #pragma align 64(__uberdata)
903 extern	uberdata_t	__uberdata;
904 extern	uberdata_t	**__tdb_bootstrap;	/* known to libc_db and mdb */
905 extern	int		primary_link_map;
906 
907 #define	ulwp_mutex(ulwp, udp)	\
908 	(&(udp)->thr_hash_table[(ulwp)->ul_ix].hash_lock)
909 #define	ulwp_condvar(ulwp, udp)	\
910 	(&(udp)->thr_hash_table[(ulwp)->ul_ix].hash_cond)
911 
912 /*
913  * Grab and release the hash table lock for the specified lwp.
914  */
915 #define	ulwp_lock(ulwp, udp)	lmutex_lock(ulwp_mutex(ulwp, udp))
916 #define	ulwp_unlock(ulwp, udp)	lmutex_unlock(ulwp_mutex(ulwp, udp))
917 
918 #ifdef _SYSCALL32	/* needed by libc_db */
919 
920 typedef struct ulwp32 {
921 #if defined(__sparc)
922 	uint32_t	ul_dinstr;	/* scratch space for dtrace */
923 	uint32_t	ul_padsparc0[15];
924 	uint32_t	ul_dsave;	/* dtrace: save %g1, %g0, %sp */
925 	uint32_t	ul_drestore;	/* dtrace: restore %g0, %g0, %g0 */
926 	uint32_t	ul_dftret;	/* dtrace: return probe fasttrap */
927 	uint32_t	ul_dreturn;	/* dtrace: return %o0 */
928 #endif
929 	caddr32_t	ul_self;	/* pointer to self */
930 #if defined(__x86)
931 	uint8_t		ul_dinstr[40];	/* scratch space for dtrace */
932 #endif
933 	caddr32_t	ul_uberdata;	/* uber (super-global) data */
934 	tls32_t		ul_tls;		/* dynamic thread-local storage base */
935 	caddr32_t	ul_forw;	/* forw, back all_lwps list, */
936 	caddr32_t	ul_back;	/* protected by link_lock */
937 	caddr32_t	ul_next;	/* list to keep track of stacks */
938 	caddr32_t	ul_hash;	/* hash chain linked list */
939 	caddr32_t	ul_rval;	/* return value from thr_exit() */
940 	caddr32_t	ul_stk;		/* mapping base of the stack */
941 	size32_t	ul_mapsiz;	/* mapping size of the stack */
942 	size32_t	ul_guardsize;	/* normally _lpagesize */
943 	caddr32_t	ul_stktop;	/* broken thr_stksegment() interface */
944 	size32_t	ul_stksiz;	/* broken thr_stksegment() interface */
945 	stack32_t	ul_ustack;	/* current stack boundaries */
946 	int		ul_ix;		/* hash index */
947 	lwpid_t		ul_lwpid;	/* thread id, aka the lwp id */
948 	pri_t		ul_pri;		/* scheduling priority */
949 	pri_t		ul_epri;	/* real-time ceiling priority */
950 	char		ul_policy;	/* scheduling policy */
951 	char		ul_cid;		/* scheduling class id */
952 	union {
953 		struct {
954 			char	cursig;	/* deferred signal number */
955 			char	pleasestop; /* lwp requested to stop itself */
956 		} s;
957 		short	curplease;	/* for testing both at once */
958 	} ul_cp;
959 	char		ul_stop;	/* reason for stopping */
960 	char		ul_signalled;	/* this lwp was cond_signal()d */
961 	char		ul_dead;	/* this lwp has called thr_exit */
962 	char		ul_unwind;	/* posix: unwind C++ stack */
963 	char		ul_detached;	/* THR_DETACHED at thread_create() */
964 					/* or pthread_detach() was called */
965 	char		ul_writer;	/* sleeping in rw_wrlock() */
966 	char		ul_stopping;	/* set by curthread: stopping self */
967 	char		ul_cancel_prologue;	/* for _cancel_prologue() */
968 	short		ul_preempt;	/* no_preempt()/preempt() */
969 	short		ul_savpreempt;	/* pre-existing preempt value */
970 	char		ul_sigsuspend;	/* thread is in sigsuspend/pollsys */
971 	char		ul_main;	/* thread is the main thread */
972 	char		ul_fork;	/* thread is performing a fork */
973 	char		ul_primarymap;	/* primary link-map is initialized */
974 	/* per-thread copies of the corresponding global variables */
975 	uint8_t		ul_max_spinners;	/* thread_max_spinners */
976 	char		ul_door_noreserve;	/* thread_door_noreserve */
977 	char		ul_queue_fifo;		/* thread_queue_fifo */
978 	char		ul_cond_wait_defer;	/* thread_cond_wait_defer */
979 	char		ul_error_detection;	/* thread_error_detection */
980 	char		ul_async_safe;		/* thread_async_safe */
981 	char		ul_rt;			/* found on an RT queue */
982 	char		ul_rtqueued;		/* was RT when queued */
983 	char		ul_misaligned;		/* thread_locks_misaligned */
984 	char		ul_pad[3];
985 	int		ul_adaptive_spin;	/* thread_adaptive_spin */
986 	int		ul_queue_spin;		/* thread_queue_spin */
987 	int		ul_critical;	/* non-zero == in a critical region */
988 	int		ul_sigdefer;	/* non-zero == defer signals */
989 	int		ul_vfork;	/* thread is the child of vfork() */
990 	int		ul_cancelable;	/* _cancelon()/_canceloff() */
991 	char		ul_cancel_pending;  /* pthread_cancel() was called */
992 	char		ul_cancel_disabled; /* PTHREAD_CANCEL_DISABLE */
993 	char		ul_cancel_async;    /* PTHREAD_CANCEL_ASYNCHRONOUS */
994 	char		ul_save_async;	/* saved copy of ul_cancel_async */
995 	char		ul_mutator;	/* lwp is a mutator (java interface) */
996 	char		ul_created;	/* created suspended */
997 	char		ul_replace;	/* replacement; must be free()d */
998 	uchar_t		ul_nocancel;	/* cancellation can't happen */
999 	int		ul_errno;	/* per-thread errno */
1000 	caddr32_t	ul_errnop;	/* pointer to errno or self->ul_errno */
1001 	caddr32_t	ul_clnup_hdr;	/* head of cleanup handlers list */
1002 	caddr32_t	ul_schedctl_called; /* ul_schedctl is set up */
1003 	caddr32_t	ul_schedctl;	/* schedctl data */
1004 	int		ul_bindflags;	/* bind_guard() interface to ld.so.1 */
1005 	uint_t		ul_libc_locks;	/* count of cancel_safe_mutex_lock()s */
1006 	caddr32_t	ul_stsd;	/* slow TLS for keys >= TSD_NFAST */
1007 	caddr32_t	ul_ftsd[TSD_NFAST]; /* fast TLS for keys < TSD_NFAST */
1008 	td_evbuf32_t	ul_td_evbuf;	/* event buffer */
1009 	char		ul_td_events_enable;	/* event mechanism enabled */
1010 	char		ul_sync_obj_reg;	/* tdb_sync_obj_register() */
1011 	char		ul_qtype;	/* MX or CV */
1012 	char		ul_cv_wake;	/* != 0: just wake up, don't requeue */
1013 	int		ul_usropts;	/* flags given to thr_create() */
1014 	caddr32_t	ul_startpc;	/* start func (thr_create()) */
1015 	caddr32_t	ul_startarg;	/* argument for start function */
1016 	caddr32_t	ul_wchan;	/* synch object when sleeping */
1017 	caddr32_t	ul_link;	/* sleep queue link */
1018 	caddr32_t	ul_sleepq;	/* sleep queue thread is waiting on */
1019 	caddr32_t	ul_cvmutex;	/* mutex dropped when waiting on a cv */
1020 	caddr32_t	ul_mxchain;	/* chain of owned ceiling mutexes */
1021 	int		ul_save_state;	/* bind_guard() interface to ld.so.1 */
1022 	uint_t		ul_rdlockcnt;	/* # entries in ul_readlock array */
1023 				/* 0 means there is but a single entry */
1024 	union {				/* single entry or pointer to array */
1025 		readlock32_t	single;
1026 		caddr32_t	array;
1027 	} ul_readlock;
1028 	uint_t		ul_heldlockcnt;	/* # entries in ul_heldlocks array */
1029 				/* 0 means there is but a single entry */
1030 	union {				/* single entry or pointer to array */
1031 		caddr32_t	single;
1032 		caddr32_t	array;
1033 	} ul_heldlocks;
1034 	/* PROBE_SUPPORT begin */
1035 	caddr32_t	ul_tpdp;
1036 	/* PROBE_SUPPORT end */
1037 	caddr32_t	ul_siglink;	/* pointer to previous context */
1038 	uint_t		ul_spin_lock_spin;	/* spin lock statistics */
1039 	uint_t		ul_spin_lock_spin2;
1040 	uint_t		ul_spin_lock_sleep;
1041 	uint_t		ul_spin_lock_wakeup;
1042 	queue_root32_t	ul_queue_root;	/* root of a sleep queue */
1043 	id_t		ul_rtclassid;	/* real-time class id */
1044 	uint_t		ul_pilocks;	/* count of PI locks held */
1045 		/* the following members *must* be last in the structure */
1046 		/* they are discarded when ulwp is replaced on thr_exit() */
1047 	sigset32_t	ul_sigmask;	/* thread's current signal mask */
1048 	sigset32_t	ul_tmpmask;	/* signal mask for sigsuspend/pollsys */
1049 	siginfo32_t	ul_siginfo;	/* deferred siginfo */
1050 	mutex_t		ul_spinlock;	/* used when suspending/continuing */
1051 	fpuenv32_t	ul_fpuenv;	/* floating point state */
1052 	caddr32_t	ul_sp;		/* stack pointer when blocked */
1053 #if defined(sparc)
1054 	caddr32_t	ul_unwind_ret;	/* used only by _ex_clnup_handler() */
1055 #endif
1056 } ulwp32_t;
1057 
1058 #define	REPLACEMENT_SIZE32	((size_t)&((ulwp32_t *)NULL)->ul_sigmask)
1059 
1060 typedef struct uberdata32 {
1061 	pad_lock_t	_link_lock;
1062 	pad_lock_t	_ld_lock;
1063 	pad_lock_t	_fork_lock;
1064 	pad_lock_t	_atfork_lock;
1065 	pad32_lock_t	_callout_lock;
1066 	pad32_lock_t	_tdb_hash_lock;
1067 	tdb_sync_stats_t tdb_hash_lock_stats;
1068 	siguaction32_t	siguaction[NSIG];
1069 	bucket32_t	bucket[NBUCKETS];
1070 	atexit_root32_t	atexit_root;
1071 	tsd_metadata32_t tsd_metadata;
1072 	tls_metadata32_t tls_metadata;
1073 	char		primary_map;
1074 	char		bucket_init;
1075 	char		pad[2];
1076 	uberflags_t	uberflags;
1077 	caddr32_t	queue_head;
1078 	caddr32_t	thr_hash_table;
1079 	uint_t		hash_size;
1080 	uint_t		hash_mask;
1081 	caddr32_t	ulwp_one;
1082 	caddr32_t	all_lwps;
1083 	caddr32_t	all_zombies;
1084 	int		nthreads;
1085 	int		nzombies;
1086 	int		ndaemons;
1087 	int		pid;
1088 	caddr32_t	sigacthandler;
1089 	caddr32_t	lwp_stacks;
1090 	caddr32_t	lwp_laststack;
1091 	int		nfreestack;
1092 	int		thread_stack_cache;
1093 	caddr32_t	ulwp_freelist;
1094 	caddr32_t	ulwp_lastfree;
1095 	caddr32_t	ulwp_replace_free;
1096 	caddr32_t	ulwp_replace_last;
1097 	caddr32_t	atforklist;
1098 	caddr32_t	robustlocks;
1099 	caddr32_t	tdb_bootstrap;
1100 	tdb32_t		tdb;
1101 } uberdata32_t;
1102 
1103 #endif	/* _SYSCALL32 */
1104 
1105 /* ul_stop values */
1106 #define	TSTP_REGULAR	0x01	/* Stopped by thr_suspend() */
1107 #define	TSTP_MUTATOR	0x08	/* stopped by thr_suspend_*mutator*() */
1108 #define	TSTP_FORK	0x20	/* stopped by suspend_fork() */
1109 
1110 /*
1111  * Implementation-specific attribute types for pthread_mutexattr_init() etc.
1112  */
1113 
1114 typedef	struct	_cvattr {
1115 	int	pshared;
1116 	clockid_t clockid;
1117 } cvattr_t;
1118 
1119 typedef	struct	_mattr {
1120 	int	pshared;
1121 	int	protocol;
1122 	int	prioceiling;
1123 	int	type;
1124 	int	robustness;
1125 } mattr_t;
1126 
1127 typedef	struct	_thrattr {
1128 	size_t	stksize;
1129 	void	*stkaddr;
1130 	int	detachstate;
1131 	int	daemonstate;
1132 	int	scope;
1133 	int	prio;
1134 	int	policy;
1135 	int	inherit;
1136 	size_t	guardsize;
1137 } thrattr_t;
1138 
1139 typedef	struct	_rwlattr {
1140 	int	pshared;
1141 } rwlattr_t;
1142 
1143 /* _curthread() is inline for speed */
1144 extern	ulwp_t		*_curthread(void);
1145 #define	curthread	(_curthread())
1146 
1147 /* this version (also inline) can be tested for NULL */
1148 extern	ulwp_t		*__curthread(void);
1149 
1150 /* get the current stack pointer (also inline) */
1151 extern	greg_t		stkptr(void);
1152 
1153 /*
1154  * Suppress __attribute__((...)) if we are not compiling with gcc
1155  */
1156 #if !defined(__GNUC__)
1157 #define	__attribute__(string)
1158 #endif
1159 
1160 /* Fetch the dispatch (kernel) priority of a thread */
1161 #define	real_priority(ulwp)	\
1162 	((ulwp)->ul_schedctl? (ulwp)->ul_schedctl->sc_priority : 0)
1163 
1164 /*
1165  * Implementation functions.  Not visible outside of the library itself.
1166  */
1167 extern	int	__nanosleep(const timespec_t *, timespec_t *);
1168 extern	void	getgregs(ulwp_t *, gregset_t);
1169 extern	void	setgregs(ulwp_t *, gregset_t);
1170 extern	void	thr_panic(const char *);
1171 #pragma rarely_called(thr_panic)
1172 extern	ulwp_t	*find_lwp(thread_t);
1173 extern	void	finish_init(void);
1174 extern	void	update_sched(ulwp_t *);
1175 extern	void	queue_alloc(void);
1176 extern	void	tsd_exit(void);
1177 extern	void	tsd_free(ulwp_t *);
1178 extern	void	tls_setup(void);
1179 extern	void	tls_exit(void);
1180 extern	void	tls_free(ulwp_t *);
1181 extern	void	rwl_free(ulwp_t *);
1182 extern	void	heldlock_exit(void);
1183 extern	void	heldlock_free(ulwp_t *);
1184 extern	void	sigacthandler(int, siginfo_t *, void *);
1185 extern	void	signal_init(void);
1186 extern	int	sigequalset(const sigset_t *, const sigset_t *);
1187 extern	void	mutex_setup(void);
1188 extern	void	take_deferred_signal(int);
1189 extern	void	*setup_top_frame(void *, size_t, ulwp_t *);
1190 extern	int	setup_context(ucontext_t *, void *(*func)(ulwp_t *),
1191 			ulwp_t *ulwp, caddr_t stk, size_t stksize);
1192 extern	volatile sc_shared_t *setup_schedctl(void);
1193 extern	void	*lmalloc(size_t);
1194 extern	void	lfree(void *, size_t);
1195 extern	void	*libc_malloc(size_t);
1196 extern	void	*libc_realloc(void *, size_t);
1197 extern	void	libc_free(void *);
1198 extern	char	*libc_strdup(const char *);
1199 extern	void	ultos(uint64_t, int, char *);
1200 extern	void	lock_error(const mutex_t *, const char *, void *, const char *);
1201 extern	void	rwlock_error(const rwlock_t *, const char *, const char *);
1202 extern	void	thread_error(const char *);
1203 extern	void	grab_assert_lock(void);
1204 extern	void	dump_queue_statistics(void);
1205 extern	void	collect_queue_statistics(void);
1206 extern	void	record_spin_locks(ulwp_t *);
1207 extern	void	remember_lock(mutex_t *);
1208 extern	void	forget_lock(mutex_t *);
1209 extern	void	register_lock(mutex_t *);
1210 extern	void	unregister_locks(void);
1211 #if defined(__sparc)
1212 extern	void	_flush_windows(void);
1213 #else
1214 #define	_flush_windows()
1215 #endif
1216 extern	void	set_curthread(void *);
1217 
1218 /*
1219  * Utility function used when waking up many threads (more than MAXLWPS)
1220  * all at once.  See mutex_wakeup_all(), cond_broadcast(), and rw_unlock().
1221  */
1222 #define	MAXLWPS	128	/* max remembered lwpids before overflow */
1223 #define	NEWLWPS	2048	/* max remembered lwpids at first overflow */
1224 extern	lwpid_t	*alloc_lwpids(lwpid_t *, int *, int *);
1225 
1226 /* enter a critical section */
1227 #define	enter_critical(self)	(self->ul_critical++)
1228 
1229 /* exit a critical section, take deferred actions if necessary */
1230 extern	void	do_exit_critical(void);
1231 #define	exit_critical(self)					\
1232 	(void) (self->ul_critical--,				\
1233 	    ((self->ul_curplease && self->ul_critical == 0)?	\
1234 	    (do_exit_critical(), 0) : 0))
1235 
1236 /*
1237  * Like enter_critical()/exit_critical() but just for deferring signals.
1238  * Unlike enter_critical()/exit_critical(), ul_sigdefer may be set while
1239  * calling application functions like constructors and destructors.
1240  * Care must be taken if the application function attempts to set
1241  * the signal mask while a deferred signal is present; the setting
1242  * of the signal mask must also be deferred.
1243  */
1244 #define	sigoff(self)	(self->ul_sigdefer++)
1245 extern	void	sigon(ulwp_t *);
1246 
1247 /* these are exported functions */
1248 extern	void	_sigoff(void);
1249 extern	void	_sigon(void);
1250 
1251 #define	sigorset(s1, s2)				\
1252 	(((s1)->__sigbits[0] |= (s2)->__sigbits[0]),	\
1253 	((s1)->__sigbits[1] |= (s2)->__sigbits[1]),	\
1254 	((s1)->__sigbits[2] |= (s2)->__sigbits[2]),	\
1255 	((s1)->__sigbits[3] |= (s2)->__sigbits[3]))
1256 
1257 #define	sigandset(s1, s2)				\
1258 	(((s1)->__sigbits[0] &= (s2)->__sigbits[0]),	\
1259 	((s1)->__sigbits[1] &= (s2)->__sigbits[1]),	\
1260 	((s1)->__sigbits[2] &= (s2)->__sigbits[2]),	\
1261 	((s1)->__sigbits[3] &= (s2)->__sigbits[3]))
1262 
1263 #define	sigdiffset(s1, s2)				\
1264 	(((s1)->__sigbits[0] &= ~(s2)->__sigbits[0]),	\
1265 	((s1)->__sigbits[1] &= ~(s2)->__sigbits[1]),	\
1266 	((s1)->__sigbits[2] &= ~(s2)->__sigbits[2]),	\
1267 	((s1)->__sigbits[3] &= ~(s2)->__sigbits[3]))
1268 
1269 #define	delete_reserved_signals(s)			\
1270 	(((s)->__sigbits[0] &= MASKSET0),		\
1271 	((s)->__sigbits[1] &= (MASKSET1 & ~SIGMASK(SIGCANCEL))),\
1272 	((s)->__sigbits[2] = 0),			\
1273 	((s)->__sigbits[3] = 0))
1274 
1275 extern	void	block_all_signals(ulwp_t *self);
1276 
1277 /*
1278  * When restoring the signal mask after having previously called
1279  * block_all_signals(), if we have a deferred signal present then
1280  * do nothing other than ASSERT() that we are in a critical region.
1281  * The signal mask will be set when we emerge from the critical region
1282  * and call take_deferred_signal().  There is no race condition here
1283  * because the kernel currently has all signals blocked for this thread.
1284  */
1285 #define	restore_signals(self)						\
1286 	((void) ((self)->ul_cursig?					\
1287 	(ASSERT((self)->ul_critical + (self)->ul_sigdefer != 0), 0) :	\
1288 	__lwp_sigmask(SIG_SETMASK, &(self)->ul_sigmask, NULL)))
1289 
1290 extern	void	set_cancel_pending_flag(ulwp_t *, int);
1291 extern	void	set_cancel_eintr_flag(ulwp_t *);
1292 extern	void	set_parking_flag(ulwp_t *, int);
1293 extern	int	cancel_active(void);
1294 
1295 extern	void	*_thrp_setup(ulwp_t *);
1296 extern	void	_fpinherit(ulwp_t *);
1297 extern	void	_lwp_start(void);
1298 extern	void	_lwp_terminate(void);
1299 extern	void	lmutex_lock(mutex_t *);
1300 extern	void	lmutex_unlock(mutex_t *);
1301 extern	void	lrw_rdlock(rwlock_t *);
1302 extern	void	lrw_wrlock(rwlock_t *);
1303 extern	void	lrw_unlock(rwlock_t *);
1304 extern	void	sig_mutex_lock(mutex_t *);
1305 extern	void	sig_mutex_unlock(mutex_t *);
1306 extern	int	sig_mutex_trylock(mutex_t *);
1307 extern	int	sig_cond_wait(cond_t *, mutex_t *);
1308 extern	int	sig_cond_reltimedwait(cond_t *, mutex_t *, const timespec_t *);
1309 extern	void	cancel_safe_mutex_lock(mutex_t *);
1310 extern	void	cancel_safe_mutex_unlock(mutex_t *);
1311 extern	int	cancel_safe_mutex_trylock(mutex_t *);
1312 extern	void	_prefork_handler(void);
1313 extern	void	_postfork_parent_handler(void);
1314 extern	void	_postfork_child_handler(void);
1315 extern	void	postfork1_child(void);
1316 extern	void	postfork1_child_aio(void);
1317 extern	void	postfork1_child_sigev_aio(void);
1318 extern	void	postfork1_child_sigev_mq(void);
1319 extern	void	postfork1_child_sigev_timer(void);
1320 extern	void	postfork1_child_tpool(void);
1321 extern	void	fork_lock_enter(void);
1322 extern	void	fork_lock_exit(void);
1323 extern	void	suspend_fork(void);
1324 extern	void	continue_fork(int);
1325 extern	void	do_sigcancel(void);
1326 extern	void	setup_cancelsig(int);
1327 extern	void	init_sigev_thread(void);
1328 extern	void	init_aio(void);
1329 extern	void	_cancelon(void);
1330 extern	void	_canceloff(void);
1331 extern	void	_canceloff_nocancel(void);
1332 extern	void	_cancel_prologue(void);
1333 extern	void	_cancel_epilogue(void);
1334 extern	void	no_preempt(ulwp_t *);
1335 extern	void	preempt(ulwp_t *);
1336 extern	void	_thrp_unwind(void *);
1337 
1338 extern	pid_t	__forkx(int);
1339 extern	pid_t	__forkallx(int);
1340 extern	int	__open(const char *, int, ...);
1341 extern	int	__close(int);
1342 extern	ssize_t	__read(int, void *, size_t);
1343 extern	ssize_t	__write(int, const void *, size_t);
1344 extern	int	__fcntl(int, int, ...);
1345 extern	int	__lwp_continue(lwpid_t);
1346 extern	int	__lwp_create(ucontext_t *, uint_t, lwpid_t *);
1347 extern	int	___lwp_suspend(lwpid_t);
1348 extern	int	lwp_wait(lwpid_t, lwpid_t *);
1349 extern	int	__lwp_wait(lwpid_t, lwpid_t *);
1350 extern	int	__lwp_detach(lwpid_t);
1351 extern	sc_shared_t *__schedctl(void);
1352 
1353 /* actual system call traps */
1354 extern	int	__setcontext(const ucontext_t *);
1355 extern	int	__getcontext(ucontext_t *);
1356 extern	int	__clock_gettime(clockid_t, timespec_t *);
1357 extern	void	abstime_to_reltime(clockid_t, const timespec_t *, timespec_t *);
1358 extern	void	hrt2ts(hrtime_t, timespec_t *);
1359 
1360 extern	int	__sigaction(int, const struct sigaction *, struct sigaction *);
1361 extern	int	__lwp_sigmask(int, const sigset_t *, sigset_t *);
1362 extern	void	__sighndlr(int, siginfo_t *, ucontext_t *, void (*)());
1363 extern	caddr_t	__sighndlrend;
1364 #pragma unknown_control_flow(__sighndlr)
1365 
1366 /* belongs in <pthread.h> */
1367 #define	PTHREAD_CREATE_DAEMON_NP	0x100	/* = THR_DAEMON */
1368 #define	PTHREAD_CREATE_NONDAEMON_NP	0
1369 extern	int	pthread_attr_setdaemonstate_np(pthread_attr_t *, int);
1370 extern	int	pthread_attr_getdaemonstate_np(const pthread_attr_t *, int *);
1371 
1372 extern	int	mutex_held(mutex_t *);
1373 extern	int	mutex_lock_internal(mutex_t *, timespec_t *, int);
1374 extern	int	mutex_unlock_internal(mutex_t *, int);
1375 
1376 /* not cancellation points: */
1377 extern	int	__cond_wait(cond_t *, mutex_t *);
1378 extern	int	__cond_timedwait(cond_t *, mutex_t *, const timespec_t *);
1379 extern	int	__cond_reltimedwait(cond_t *, mutex_t *, const timespec_t *);
1380 
1381 extern	int	rw_read_held(rwlock_t *);
1382 extern	int	rw_write_held(rwlock_t *);
1383 
1384 extern	int	_thrp_create(void *, size_t, void *(*)(void *), void *, long,
1385 			thread_t *, size_t);
1386 extern	int	_thrp_suspend(thread_t, uchar_t);
1387 extern	int	_thrp_continue(thread_t, uchar_t);
1388 
1389 extern	void	_thrp_terminate(void *);
1390 extern	void	_thrp_exit(void);
1391 
1392 extern	const pcclass_t *get_info_by_class(id_t);
1393 extern	const pcclass_t *get_info_by_policy(int);
1394 extern	const thrattr_t *def_thrattr(void);
1395 extern	id_t	setparam(idtype_t, id_t, int, int);
1396 extern	id_t	setprio(idtype_t, id_t, int, int *);
1397 extern	id_t	getparam(idtype_t, id_t, int *, struct sched_param *);
1398 
1399 /*
1400  * System call wrappers (direct interfaces to the kernel)
1401  */
1402 extern	int	___lwp_mutex_register(mutex_t *);
1403 extern	int	___lwp_mutex_trylock(mutex_t *);
1404 extern	int	___lwp_mutex_timedlock(mutex_t *, timespec_t *);
1405 extern	int	___lwp_mutex_unlock(mutex_t *);
1406 extern	int	___lwp_mutex_wakeup(mutex_t *, int);
1407 extern	int	___lwp_cond_wait(cond_t *, mutex_t *, timespec_t *, int);
1408 extern	int	___lwp_sema_timedwait(lwp_sema_t *, timespec_t *, int);
1409 extern	int	__lwp_rwlock_rdlock(rwlock_t *, timespec_t *);
1410 extern	int	__lwp_rwlock_wrlock(rwlock_t *, timespec_t *);
1411 extern	int	__lwp_rwlock_tryrdlock(rwlock_t *);
1412 extern	int	__lwp_rwlock_trywrlock(rwlock_t *);
1413 extern	int	__lwp_rwlock_unlock(rwlock_t *);
1414 extern	int	__lwp_park(timespec_t *, lwpid_t);
1415 extern	int	__lwp_unpark(lwpid_t);
1416 extern	int	__lwp_unpark_all(lwpid_t *, int);
1417 #if defined(__x86)
1418 extern	int	___lwp_private(int, int, void *);
1419 #endif	/* __x86 */
1420 
1421 /*
1422  * inlines
1423  */
1424 extern	int		set_lock_byte(volatile uint8_t *);
1425 extern	uint32_t	atomic_swap_32(volatile uint32_t *, uint32_t);
1426 extern	uint32_t	atomic_cas_32(volatile uint32_t *, uint32_t, uint32_t);
1427 extern	void		atomic_inc_32(volatile uint32_t *);
1428 extern	void		atomic_dec_32(volatile uint32_t *);
1429 extern	void		atomic_and_32(volatile uint32_t *, uint32_t);
1430 extern	void		atomic_or_32(volatile uint32_t *, uint32_t);
1431 #if defined(__sparc)
1432 extern	ulong_t		caller(void);
1433 extern	ulong_t		getfp(void);
1434 #endif	/* __sparc */
1435 
1436 #include "thr_inlines.h"
1437 
1438 #endif	/* _THR_UBERDATA_H */
1439