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