Home | History | Annotate | Line # | Download | only in libpthread
pthread_int.h revision 1.1.2.38
      1 /*	$NetBSD: pthread_int.h,v 1.1.2.38 2003/01/13 18:53:15 nathanw Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 2001 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 #include <sa.h>
     43 #include <signal.h>
     44 
     45 #define PTHREAD__DEBUG
     46 #define ERRORCHECK
     47 
     48 #include "pthread_types.h"
     49 #include "pthread_queue.h"
     50 #include "pthread_debug.h"
     51 
     52 /*
     53  * The size of this structure needs to be no larger than struct
     54  * __pthread_cleanup_store, defined in pthread.h.
     55  */
     56 struct pt_clean_t {
     57 	PTQ_ENTRY(pt_clean_t)	ptc_next;
     58 	void	(*ptc_cleanup)(void *);
     59 	void	*ptc_arg;
     60 };
     61 
     62 struct pt_alarm_t {
     63 	PTQ_ENTRY(pt_alarm_t)	pta_next;
     64 	pthread_spin_t	pta_lock;
     65 	const struct timespec	*pta_time;
     66 	void	(*pta_func)(void *);
     67 	void	*pta_arg;
     68 	int	pta_fired;
     69 };
     70 
     71 struct	pthread_st {
     72 	unsigned int	pt_magic;
     73 
     74 	int	pt_type;	/* normal, upcall, or idle */
     75 	int	pt_state;	/* running, blocked, etc. */
     76 	pthread_spin_t pt_statelock;	/* lock on pt_state */
     77 	int	pt_flags;	/* see PT_FLAG_* below */
     78 	int	pt_cancel;	/* Deferred cancellation */
     79 	int	pt_spinlocks;	/* Number of spinlocks held. */
     80 	int	pt_blockedlwp;	/* LWP/SA number when blocked */
     81 
     82 	int	pt_errno;	/* Thread-specific errno. */
     83 
     84 	/* Entry on the run queue */
     85 	PTQ_ENTRY(pthread_st)	pt_runq;
     86 	/* Entry on the list of all threads */
     87 	PTQ_ENTRY(pthread_st)	pt_allq;
     88 	/* Entry on the sleep queue (xxx should be same as run queue?) */
     89 	PTQ_ENTRY(pthread_st)	pt_sleep;
     90 	/* Object we're sleeping on */
     91 	void	*pt_sleepobj;
     92 	/* Queue we're sleeping on */
     93 	struct pthread_queue_t		*pt_sleepq;
     94 	/* Lock protecting that queue */
     95 	pthread_spin_t		*pt_sleeplock;
     96 
     97 	stack_t		pt_stack;	/* Our stack */
     98 	ucontext_t	*pt_uc;		/* Saved context when we're stopped */
     99 
    100 	sigset_t	pt_sigmask;	/* Signals we won't take. */
    101 	sigset_t	pt_siglist;	/* Signals pending for us. */
    102 	pthread_spin_t	pt_siglock;	/* Lock on above */
    103 
    104 	void *		pt_exitval;	/* Read by pthread_join() */
    105 
    106 	/* Stack of cancellation cleanup handlers and their arguments */
    107 	PTQ_HEAD(, pt_clean_t)	pt_cleanup_stack;
    108 
    109 	/* Other threads trying to pthread_join() us. */
    110 	struct pthread_queue_t	pt_joiners;
    111 	/* Lock for above, and for changing pt_state to ZOMBIE or DEAD,
    112 	 * and for setting the DETACHED flag
    113 	 */
    114 	pthread_spin_t	pt_join_lock;
    115 
    116 	/* Thread we were going to switch to before we were preempted
    117 	 * ourselves. Will be used by the upcall that's continuing us.
    118 	 */
    119 	pthread_t	pt_switchto;
    120 	ucontext_t*	pt_switchtouc;
    121 
    122 	/* The context we saved in pthread__locked_switch but which
    123 	 * was trashed when we were preempted before switching stacks.
    124 	 */
    125 	ucontext_t*	pt_sleepuc;
    126 
    127 	/* Threads that are preempted with spinlocks held will be
    128 	 * continued until they unlock their spinlock. When they do
    129 	 * so, they should jump ship to the thread pointed to by
    130 	 * pt_next.
    131 	 */
    132 	pthread_t	pt_next;
    133 
    134 	/* The upcall that is continuing this thread */
    135 	pthread_t	pt_parent;
    136 
    137 	/* A queue lock that this thread held while trying to
    138 	 * context switch to another process.
    139 	 */
    140 	pthread_spin_t*	pt_heldlock;
    141 
    142 	/* Identifier, for debugging. */
    143 	int		pt_num;
    144 
    145 	/* Thread-specific data */
    146 	void*		pt_specific[PTHREAD_KEYS_MAX];
    147 
    148 #ifdef PTHREAD__DEBUG
    149 	int	blocks;
    150 	int	preempts;
    151 	int	rescheds;
    152 #endif
    153 };
    154 
    155 struct pthread_lock_ops {
    156 	void	(*plo_init)(__cpu_simple_lock_t *);
    157 	int	(*plo_try)(__cpu_simple_lock_t *);
    158 	void	(*plo_unlock)(__cpu_simple_lock_t *);
    159 };
    160 
    161 /* Thread types */
    162 #define PT_THREAD_NORMAL	1
    163 #define PT_THREAD_UPCALL	2
    164 #define PT_THREAD_IDLE		3
    165 
    166 /* Thread states */
    167 #define PT_STATE_RUNNING	1
    168 #define PT_STATE_RUNNABLE	2
    169 #define PT_STATE_BLOCKED_SYS	3
    170 #define PT_STATE_BLOCKED_QUEUE	4
    171 #define PT_STATE_ZOMBIE		5
    172 #define PT_STATE_DEAD		6
    173 #define PT_STATE_RECYCLABLE	7
    174 
    175 /* Flag values */
    176 
    177 #define PT_FLAG_DETACHED	0x0001
    178 #define PT_FLAG_IDLED		0x0002
    179 #define PT_FLAG_CS_DISABLED	0x0004	/* Cancellation disabled */
    180 #define PT_FLAG_CS_ASYNC	0x0008  /* Cancellation is async */
    181 #define PT_FLAG_CS_PENDING	0x0010
    182 #define PT_FLAG_SIGCATCH	0x0020	/* Interrupt sleep on a signal */
    183 
    184 #define PT_MAGIC	0x11110001
    185 #define PT_DEAD		0xDEAD0001
    186 
    187 #define PT_ATTR_MAGIC	0x22220002
    188 #define PT_ATTR_DEAD	0xDEAD0002
    189 
    190 #define PT_STACKSIZE	(1<<18)
    191 #define PT_STACKMASK	(PT_STACKSIZE-1)
    192 
    193 #define PT_UPCALLSTACKS	16
    194 
    195 #define PT_ALARMTIMER_MAGIC	0x88880010
    196 #define PT_RRTIMER_MAGIC	0x88880020
    197 #define NIDLETHREADS	4
    198 #define IDLESPINS	1000
    199 
    200 /* Flag to be used in a ucontext_t's uc_flags indicating that
    201  * the saved register state is "user" state only, not full
    202  * trap state.
    203  */
    204 #define _UC_USER_BIT		30
    205 #define _UC_USER		(1LU << _UC_USER_BIT)
    206 
    207 void	pthread_init(void)  __attribute__ ((__constructor__));
    208 
    209 /* Utility functions */
    210 
    211 /* Set up/clean up a thread's basic state. */
    212 void	pthread__initthread(pthread_t self, pthread_t t);
    213 
    214 /* Go do something else. Don't go back on the run queue */
    215 void	pthread__block(pthread_t self, pthread_spin_t* queuelock);
    216 /* Put a thread back on the run queue */
    217 void	pthread__sched(pthread_t self, pthread_t thread);
    218 void	pthread__sched_idle(pthread_t self, pthread_t thread);
    219 void	pthread__sched_idle2(pthread_t self);
    220 
    221 void	pthread__sched_bulk(pthread_t self, pthread_t qhead);
    222 
    223 void	pthread__idle(void);
    224 
    225 /* Get the next thread */
    226 pthread_t pthread__next(pthread_t self);
    227 
    228 int	pthread__stackalloc(pthread_t *t);
    229 void	pthread__initmain(pthread_t *t);
    230 
    231 void	pthread__sa_start(void);
    232 void	pthread__sa_recycle(pthread_t old, pthread_t new);
    233 
    234 /* Alarm code */
    235 void	pthread__alarm_init(void);
    236 void	pthread__alarm_add(pthread_t, struct pt_alarm_t *,
    237     const struct timespec *, void (*)(void *), void *);
    238 void	pthread__alarm_del(pthread_t, struct pt_alarm_t *);
    239 int	pthread__alarm_fired(struct pt_alarm_t *);
    240 void	pthread__alarm_process(pthread_t self, void *arg);
    241 
    242 /* Internal locking primitives */
    243 void	pthread__lockprim_init(void);
    244 void	pthread_lockinit(pthread_spin_t *lock);
    245 void	pthread_spinlock(pthread_t thread, pthread_spin_t *lock);
    246 int	pthread_spintrylock(pthread_t thread, pthread_spin_t *lock);
    247 void	pthread_spinunlock(pthread_t thread, pthread_spin_t *lock);
    248 
    249 extern const struct pthread_lock_ops *pthread__lock_ops;
    250 
    251 #define	pthread__simple_lock_init(alp)	(*pthread__lock_ops->plo_init)(alp)
    252 #define	pthread__simple_lock_try(alp)	(*pthread__lock_ops->plo_try)(alp)
    253 #define	pthread__simple_unlock(alp)	(*pthread__lock_ops->plo_unlock)(alp)
    254 
    255 int	_getcontext_u(ucontext_t *);
    256 int	_setcontext_u(const ucontext_t *);
    257 int	_swapcontext_u(ucontext_t *, const ucontext_t *);
    258 
    259 void	pthread__testcancel(pthread_t self);
    260 int	pthread__find(pthread_t self, pthread_t target);
    261 
    262 #include "pthread_md.h"
    263 
    264 #ifndef PTHREAD_MD_INIT
    265 #define PTHREAD_MD_INIT
    266 #endif
    267 
    268 #ifndef _INITCONTEXT_U_MD
    269 #define _INITCONTEXT_U_MD(ucp)
    270 #endif
    271 
    272 #define _INITCONTEXT_U(ucp) do {					\
    273 	(ucp)->uc_flags = _UC_CPU | _UC_STACK;				\
    274 	_INITCONTEXT_U_MD(ucp)						\
    275 	} while (0)
    276 
    277 /* Stack location of pointer to a particular thread */
    278 #define pthread__id(sp) \
    279 	((pthread_t) (((vaddr_t)(sp)) & ~PT_STACKMASK))
    280 
    281 #define pthread__self() (pthread__id(pthread__sp()))
    282 
    283 /* These three routines are defined in processor-specific code. */
    284 void	pthread__upcall_switch(pthread_t self, pthread_t next);
    285 void	pthread__switch(pthread_t self, pthread_t next);
    286 void	pthread__locked_switch(pthread_t self, pthread_t next,
    287     pthread_spin_t *lock);
    288 
    289 void	pthread__signal_init(void);
    290 
    291 void	pthread__signal(pthread_t t, int sig, int code);
    292 
    293 void	pthread__destroy_tsd(pthread_t self);
    294 
    295 
    296 #endif /* _LIB_PTHREAD_INT_H */
    297