Home | History | Annotate | Line # | Download | only in libpthread
pthread_int.h revision 1.36
      1 /*	$NetBSD: pthread_int.h,v 1.36 2006/12/24 18:39:46 ad Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 2001,2002,2003 The NetBSD Foundation, Inc.
      5  * All rights reserved.
      6  *
      7  * This code is derived from software contributed to The NetBSD Foundation
      8  * by Nathan J. Williams.
      9  *
     10  * Redistribution and use in source and binary forms, with or without
     11  * modification, are permitted provided that the following conditions
     12  * are met:
     13  * 1. Redistributions of source code must retain the above copyright
     14  *    notice, this list of conditions and the following disclaimer.
     15  * 2. Redistributions in binary form must reproduce the above copyright
     16  *    notice, this list of conditions and the following disclaimer in the
     17  *    documentation and/or other materials provided with the distribution.
     18  * 3. All advertising materials mentioning features or use of this software
     19  *    must display the following acknowledgement:
     20  *        This product includes software developed by the NetBSD
     21  *        Foundation, Inc. and its contributors.
     22  * 4. Neither the name of The NetBSD Foundation nor the names of its
     23  *    contributors may be used to endorse or promote products derived
     24  *    from this software without specific prior written permission.
     25  *
     26  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     27  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     28  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     29  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     36  * POSSIBILITY OF SUCH DAMAGE.
     37  */
     38 
     39 #ifndef _LIB_PTHREAD_INT_H
     40 #define _LIB_PTHREAD_INT_H
     41 
     42 #define PTHREAD__DEBUG
     43 #define ERRORCHECK
     44 
     45 #include "pthread_types.h"
     46 #include "pthread_queue.h"
     47 #include "pthread_debug.h"
     48 #include "pthread_md.h"
     49 
     50 #ifndef PTHREAD_SA
     51 #include <lwp.h>
     52 #endif
     53 
     54 #include <sa.h>
     55 #include <signal.h>
     56 
     57 #define PTHREAD_KEYS_MAX 256
     58 /*
     59  * The size of this structure needs to be no larger than struct
     60  * __pthread_cleanup_store, defined in pthread.h.
     61  */
     62 struct pt_clean_t {
     63 	PTQ_ENTRY(pt_clean_t)	ptc_next;
     64 	void	(*ptc_cleanup)(void *);
     65 	void	*ptc_arg;
     66 };
     67 
     68 struct pt_alarm_t {
     69 	PTQ_ENTRY(pt_alarm_t)	pta_next;
     70 	pthread_spin_t	pta_lock;
     71 	const struct timespec	*pta_time;
     72 	void	(*pta_func)(void *);
     73 	void	*pta_arg;
     74 	int	pta_fired;
     75 };
     76 
     77 /* Private data for pthread_attr_t */
     78 struct pthread_attr_private {
     79 	char ptap_name[PTHREAD_MAX_NAMELEN_NP];
     80 	void *ptap_namearg;
     81 	void *ptap_stackaddr;
     82 	size_t ptap_stacksize;
     83 	size_t ptap_guardsize;
     84 };
     85 
     86 struct	__pthread_st {
     87 	unsigned int	pt_magic;
     88 	/* Identifier, for debugging and for preventing recycling. */
     89 	int		pt_num;
     90 
     91 #ifdef PTHREAD_SA
     92 	int	pt_type;	/* normal, upcall, or idle */
     93 #else
     94 	lwpid_t	pt_lid;		/* LWP ID */
     95 #endif
     96 	int	pt_state;	/* running, blocked, etc. */
     97 	pthread_spin_t pt_statelock;	/* lock on pt_state */
     98 	int	pt_flags;	/* see PT_FLAG_* below */
     99 	pthread_spin_t pt_flaglock;	/* lock on pt_flag */
    100 	int	pt_cancel;	/* Deferred cancellation */
    101 	int	pt_spinlocks;	/* Number of spinlocks held. */
    102 	int	pt_blockedlwp;	/* LWP/SA number when blocked */
    103 	int	pt_vpid;	/* VP number */
    104 	int	pt_blockgen;	/* SA_UPCALL_BLOCKED counter */
    105 #ifdef PTHREAD_SA
    106 	int	pt_unblockgen;	/* SA_UPCALL_UNBLOCKED counter */
    107 #else
    108 	int	pt_sleeponq;	/* on a sleep queue */
    109 #endif
    110 
    111 	int	pt_errno;	/* Thread-specific errno. */
    112 
    113 	/* Entry on the run queue */
    114 	PTQ_ENTRY(__pthread_st)	pt_runq;
    115 	/* Entry on the list of all threads */
    116 	PTQ_ENTRY(__pthread_st)	pt_allq;
    117 	/* Entry on the sleep queue (xxx should be same as run queue?) */
    118 	PTQ_ENTRY(__pthread_st)	pt_sleep;
    119 	/*
    120 	 * Object we're sleeping on.  For 1:1 threads (!SA), this is
    121 	 * protected by the interlock on the object that the thread is
    122 	 * sleeping on.
    123 	 */
    124 	void			*pt_sleepobj;
    125 	/* Queue we're sleeping on */
    126 	struct pthread_queue_t	*pt_sleepq;
    127 	/* Lock protecting that queue */
    128 	pthread_spin_t		*pt_sleeplock;
    129 
    130 	stack_t		pt_stack;	/* Our stack */
    131 	ucontext_t	*pt_uc;		/* Saved context when we're stopped */
    132 	ucontext_t	*pt_trapuc;   	/* Kernel-saved context */
    133 	ucontext_t	*__pt_blockuc;  /* Kernel-saved context when blocked */
    134 
    135 	sigset_t	pt_sigmask;	/* Signals we won't take. */
    136 	sigset_t	pt_siglist;	/* Signals pending for us. */
    137 	sigset_t	pt_sigblocked;	/* Signals delivered while blocked. */
    138 	sigset_t	*pt_sigwait;	/* Signals waited for in sigwait */
    139 	siginfo_t	*pt_wsig;
    140 	pthread_spin_t	pt_siglock;	/* Lock on above */
    141 
    142 	void *		pt_exitval;	/* Read by pthread_join() */
    143 
    144 	/* Stack of cancellation cleanup handlers and their arguments */
    145 	PTQ_HEAD(, pt_clean_t)	pt_cleanup_stack;
    146 
    147 	/* Thread's name, set by the application. */
    148 	char*		pt_name;
    149 
    150 	/* Other threads trying to pthread_join() us. */
    151 	struct pthread_queue_t	pt_joiners;
    152 	/* Lock for above, and for changing pt_state to ZOMBIE or DEAD,
    153 	 * and for setting the DETACHED flag.  Also protects pt_name.
    154 	 */
    155 	pthread_spin_t	pt_join_lock;
    156 
    157 	/* Thread we were going to switch to before we were preempted
    158 	 * ourselves. Will be used by the upcall that's continuing us.
    159 	 */
    160 	pthread_t	pt_switchto;
    161 	ucontext_t*	pt_switchtouc;
    162 
    163 	/* Threads that are preempted with spinlocks held will be
    164 	 * continued until they unlock their spinlock. When they do
    165 	 * so, they should jump ship to the thread pointed to by
    166 	 * pt_next.
    167 	 */
    168 	pthread_t	pt_next;
    169 
    170 	/* The upcall that is continuing this thread */
    171 	pthread_t	pt_parent;
    172 
    173 	/* A queue lock that this thread held while trying to
    174 	 * context switch to another process.
    175 	 */
    176 	pthread_spin_t*	pt_heldlock;
    177 
    178 	/* Upcall stack information shared between kernel and
    179 	 * userland.
    180 	 */
    181 	struct sa_stackinfo_t	pt_stackinfo;
    182 
    183 	/* Thread-specific data */
    184 	void*		pt_specific[PTHREAD_KEYS_MAX];
    185 
    186 #ifdef PTHREAD__DEBUG
    187 	int	blocks;
    188 	int	preempts;
    189 	int	rescheds;
    190 #endif
    191 };
    192 
    193 struct pthread_lock_ops {
    194 	void	(*plo_init)(__cpu_simple_lock_t *);
    195 	int	(*plo_try)(__cpu_simple_lock_t *);
    196 	void	(*plo_unlock)(__cpu_simple_lock_t *);
    197 };
    198 
    199 #ifdef PTHREAD_SA
    200 
    201 /* Thread types */
    202 #define PT_THREAD_NORMAL	1
    203 #define PT_THREAD_UPCALL	2
    204 #define PT_THREAD_IDLE		3
    205 
    206 /* Thread states */
    207 #define PT_STATE_RUNNING	1
    208 #define PT_STATE_RUNNABLE	2
    209 #define _PT_STATE_BLOCKED_SYS	3	/* Only used in libpthread_dbg */
    210 #define PT_STATE_BLOCKED_QUEUE	4
    211 #define PT_STATE_ZOMBIE		5
    212 #define PT_STATE_DEAD		6
    213 #define PT_STATE_SUSPENDED	7
    214 
    215 #else	/* PTHREAD_SA */
    216 
    217 /* Thread states */
    218 #define PT_STATE_RUNNING	1
    219 #define PT_STATE_ZOMBIE		5
    220 #define PT_STATE_DEAD		6
    221 
    222 #endif	/* PTHREAD_SA */
    223 
    224 /* Flag values */
    225 
    226 #define PT_FLAG_DETACHED	0x0001
    227 #define PT_FLAG_IDLED		0x0002
    228 #define PT_FLAG_CS_DISABLED	0x0004	/* Cancellation disabled */
    229 #define PT_FLAG_CS_ASYNC	0x0008  /* Cancellation is async */
    230 #define PT_FLAG_CS_PENDING	0x0010
    231 #define PT_FLAG_SIGDEFERRED     0x0020	/* There are signals to take */
    232 #define PT_FLAG_SCOPE_SYSTEM	0x0040
    233 #define PT_FLAG_EXPLICIT_SCHED	0x0080
    234 #define PT_FLAG_SUSPENDED	0x0100	/* In the suspended queue */
    235 #define PT_FLAG_SIGNALED	0x0200
    236 
    237 #define PT_MAGIC	0x11110001
    238 #define PT_DEAD		0xDEAD0001
    239 
    240 #define PT_ATTR_MAGIC	0x22220002
    241 #define PT_ATTR_DEAD	0xDEAD0002
    242 
    243 #ifdef PT_FIXEDSTACKSIZE_LG
    244 
    245 #define	PT_STACKSIZE_LG	PT_FIXEDSTACKSIZE_LG
    246 #define	PT_STACKSIZE	(1<<(PT_STACKSIZE_LG))
    247 #define	PT_STACKMASK	(PT_STACKSIZE-1)
    248 
    249 #else  /* PT_FIXEDSTACKSIZE_LG */
    250 
    251 extern	int		pthread_stacksize_lg;
    252 extern	size_t		pthread_stacksize;
    253 extern	vaddr_t		pthread_stackmask;
    254 
    255 #define	PT_STACKSIZE_LG	pthread_stacksize_lg
    256 #define	PT_STACKSIZE	pthread_stacksize
    257 #define	PT_STACKMASK	pthread_stackmask
    258 
    259 #endif /* PT_FIXEDSTACKSIZE_LG */
    260 
    261 
    262 #define PT_UPCALLSTACKS	16
    263 
    264 #define PT_ALARMTIMER_MAGIC	0x88880010
    265 #define PT_RRTIMER_MAGIC	0x88880020
    266 #define NIDLETHREADS	4
    267 
    268 /* Flag to be used in a ucontext_t's uc_flags indicating that
    269  * the saved register state is "user" state only, not full
    270  * trap state.
    271  */
    272 #define _UC_USER_BIT		30
    273 #define _UC_USER		(1LU << _UC_USER_BIT)
    274 
    275 void	pthread_init(void)  __attribute__ ((__constructor__));
    276 
    277 /* Utility functions */
    278 
    279 /* Set up/clean up a thread's basic state. */
    280 void	pthread__initthread(pthread_t self, pthread_t t);
    281 /* Get offset from stack start to struct sa_stackinfo */
    282 ssize_t	pthread__stackinfo_offset(void);
    283 
    284 /* Go do something else. Don't go back on the run queue */
    285 void	pthread__block(pthread_t self, pthread_spin_t* queuelock);
    286 /* Put a thread back on the suspended queue */
    287 void	pthread__suspend(pthread_t self, pthread_t thread);
    288 /* Put a thread back on the run queue */
    289 void	pthread__sched(pthread_t self, pthread_t thread);
    290 void	pthread__sched_sleepers(pthread_t self, struct pthread_queue_t *threadq);
    291 void	pthread__sched_idle(pthread_t self, pthread_t thread);
    292 void	pthread__sched_idle2(pthread_t self);
    293 
    294 void	pthread__sched_bulk(pthread_t self, pthread_t qhead);
    295 
    296 void	pthread__idle(void);
    297 
    298 /* Get the next thread */
    299 pthread_t pthread__next(pthread_t self);
    300 
    301 #ifndef PTHREAD_SA
    302 void	pthread__unpark_all(pthread_t self, pthread_spin_t *lock,
    303 			    void *obj, struct pthread_queue_t *threadq);
    304 void	pthread__unpark(pthread_t self, pthread_spin_t *lock,
    305 			void *obj, pthread_t target);
    306 int	pthread__park(pthread_t self, pthread_spin_t *lock,
    307 		      void *obj, struct pthread_queue_t *threadq,
    308 		      const struct timespec *abs_timeout, int tail,
    309 		      int cancelpt);
    310 #endif
    311 
    312 int	pthread__stackalloc(pthread_t *t);
    313 void	pthread__initmain(pthread_t *t);
    314 
    315 void	pthread__sa_start(void);
    316 void	pthread__sa_recycle(pthread_t old, pthread_t new);
    317 void	pthread__setconcurrency(int);
    318 
    319 /* Alarm code */
    320 void	pthread__alarm_init(void);
    321 void	pthread__alarm_add(pthread_t, struct pt_alarm_t *,
    322     const struct timespec *, void (*)(void *), void *);
    323 void	pthread__alarm_del(pthread_t, struct pt_alarm_t *);
    324 int	pthread__alarm_fired(struct pt_alarm_t *);
    325 void	pthread__alarm_process(pthread_t self, void *arg);
    326 
    327 /* Internal locking primitives */
    328 void	pthread__lockprim_init(int ncpu);
    329 void	pthread_lockinit(pthread_spin_t *lock);
    330 void	pthread_spinlock(pthread_t thread, pthread_spin_t *lock);
    331 int	pthread_spintrylock(pthread_t thread, pthread_spin_t *lock);
    332 void	pthread_spinunlock(pthread_t thread, pthread_spin_t *lock);
    333 
    334 extern const struct pthread_lock_ops *pthread__lock_ops;
    335 
    336 #define	pthread__simple_lock_init(alp)	(*pthread__lock_ops->plo_init)(alp)
    337 #define	pthread__simple_lock_try(alp)	(*pthread__lock_ops->plo_try)(alp)
    338 #define	pthread__simple_unlock(alp)	(*pthread__lock_ops->plo_unlock)(alp)
    339 
    340 #ifndef _getcontext_u
    341 int	_getcontext_u(ucontext_t *);
    342 #endif
    343 #ifndef _setcontext_u
    344 int	_setcontext_u(const ucontext_t *);
    345 #endif
    346 #ifndef _swapcontext_u
    347 int	_swapcontext_u(ucontext_t *, const ucontext_t *);
    348 #endif
    349 
    350 void	pthread__testcancel(pthread_t self);
    351 int	pthread__find(pthread_t self, pthread_t target);
    352 
    353 #ifndef PTHREAD_MD_INIT
    354 #define PTHREAD_MD_INIT
    355 #endif
    356 
    357 #ifndef _INITCONTEXT_U_MD
    358 #define _INITCONTEXT_U_MD(ucp)
    359 #endif
    360 
    361 #define _INITCONTEXT_U(ucp) do {					\
    362 	(ucp)->uc_flags = _UC_CPU | _UC_STACK;				\
    363 	_INITCONTEXT_U_MD(ucp)						\
    364 	} while (/*CONSTCOND*/0)
    365 
    366 #ifdef PTHREAD_MACHINE_HAS_ID_REGISTER
    367 #define pthread__id(reg) (reg)
    368 #else
    369 /* Stack location of pointer to a particular thread */
    370 #define pthread__id(sp) \
    371 	((pthread_t) (((vaddr_t)(sp)) & ~PT_STACKMASK))
    372 
    373 #define pthread__id_reg() pthread__sp()
    374 #endif
    375 
    376 #define pthread__self() (pthread__id(pthread__id_reg()))
    377 
    378 #define pthread__abort()						\
    379 	pthread__assertfunc(__FILE__, __LINE__, __func__, "unreachable")
    380 
    381 #define pthread__assert(e) do {						\
    382 	if (__predict_false(!(e)))					\
    383        	       pthread__assertfunc(__FILE__, __LINE__, __func__, #e);	\
    384         } while (/*CONSTCOND*/0)
    385 
    386 #define pthread__error(err, msg, e) do {				\
    387 	if (__predict_false(!(e))) {					\
    388        	       pthread__errorfunc(__FILE__, __LINE__, __func__, msg);	\
    389 	       return (err);						\
    390 	} 								\
    391         } while (/*CONSTCOND*/0)
    392 
    393 
    394 
    395 /* These three routines are defined in processor-specific code. */
    396 void	pthread__upcall_switch(pthread_t self, pthread_t next);
    397 void	pthread__switch(pthread_t self, pthread_t next);
    398 void	pthread__locked_switch(pthread_t self, pthread_t next,
    399     pthread_spin_t *lock);
    400 
    401 void	pthread__signal_init(void);
    402 void	pthread__signal_start(void);
    403 
    404 void	pthread__signal(pthread_t self, pthread_t t, siginfo_t *si);
    405 void	pthread__deliver_signal(pthread_t self, pthread_t t, siginfo_t *si);
    406 void	pthread__signal_deferred(pthread_t self, pthread_t t);
    407 
    408 void	pthread__destroy_tsd(pthread_t self);
    409 void	pthread__assertfunc(const char *file, int line, const char *function,
    410 		const char *expr);
    411 void	pthread__errorfunc(const char *file, int line, const char *function,
    412 		const char *msg);
    413 
    414 #endif /* _LIB_PTHREAD_INT_H */
    415