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