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