Home | History | Annotate | Line # | Download | only in libpthread
pthread_int.h revision 1.43
      1 /*	$NetBSD: pthread_int.h,v 1.43 2007/08/04 13:37:49 ad Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 2001, 2002, 2003, 2006, 2007 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 and Andrew Doran.
      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 #include <lwp.h>
     51 #include <signal.h>
     52 
     53 #define PTHREAD_KEYS_MAX 256
     54 /*
     55  * The size of this structure needs to be no larger than struct
     56  * __pthread_cleanup_store, defined in pthread.h.
     57  */
     58 struct pt_clean_t {
     59 	PTQ_ENTRY(pt_clean_t)	ptc_next;
     60 	void	(*ptc_cleanup)(void *);
     61 	void	*ptc_arg;
     62 };
     63 
     64 /* Private data for pthread_attr_t */
     65 struct pthread_attr_private {
     66 	char ptap_name[PTHREAD_MAX_NAMELEN_NP];
     67 	void *ptap_namearg;
     68 	void *ptap_stackaddr;
     69 	size_t ptap_stacksize;
     70 	size_t ptap_guardsize;
     71 };
     72 
     73 struct	__pthread_st {
     74 	unsigned int	pt_magic;	/* Magic number */
     75 	int		pt_num;		/* ID XXX should die */
     76 	int		pt_state;	/* running, blocked, etc. */
     77 	pthread_spin_t	pt_lock;	/* lock on state */
     78 	int		pt_flags;	/* see PT_FLAG_* below */
     79 	int		pt_cancel;	/* Deferred cancellation */
     80 	int		pt_spinlocks;	/* Number of spinlocks held. */
     81 	void		*pt_mutexhint;	/* Last mutex held. */
     82 	int		pt_errno;	/* Thread-specific errno. */
     83 	stack_t		pt_stack;	/* Our stack */
     84 	ucontext_t	*pt_uc;		/* Saved context when we're stopped */
     85 	void		*pt_exitval;	/* Read by pthread_join() */
     86 	char		*pt_name;	/* Thread's name, set by the app. */
     87 
     88 	/* Stack of cancellation cleanup handlers and their arguments */
     89 	PTQ_HEAD(, pt_clean_t)	pt_cleanup_stack;
     90 
     91 	/* Thread-specific data */
     92 	void		*pt_specific[PTHREAD_KEYS_MAX];
     93 
     94 	/* LWP ID and entry on the list of all threads. */
     95 	lwpid_t		pt_lid;
     96 	PTQ_ENTRY(__pthread_st)	pt_allq;
     97 
     98 	/*
     99 	 * General synchronization data.  We try to align, as threads
    100 	 * on other CPUs will access this data frequently.
    101 	 */
    102 	int		pt_dummy1 __aligned(128);
    103 	int		pt_sleeponq;	/* on a sleep queue */
    104 	int		pt_signalled;	/* Received pthread_cond_signal() */
    105 	void		*pt_sleepobj;	/* object slept on */
    106 	pthread_queue_t	*pt_sleepq;	/* sleep queue */
    107 	PTQ_ENTRY(__pthread_st)	pt_sleep;
    108 	int		pt_dummy2 __aligned(128);
    109 };
    110 
    111 /* Thread states */
    112 #define PT_STATE_RUNNING	1
    113 #define PT_STATE_ZOMBIE		5
    114 #define PT_STATE_DEAD		6
    115 
    116 /* Flag values */
    117 
    118 #define PT_FLAG_DETACHED	0x0001
    119 #define PT_FLAG_CS_DISABLED	0x0004	/* Cancellation disabled */
    120 #define PT_FLAG_CS_ASYNC	0x0008  /* Cancellation is async */
    121 #define PT_FLAG_CS_PENDING	0x0010
    122 #define PT_FLAG_SCOPE_SYSTEM	0x0040
    123 #define PT_FLAG_EXPLICIT_SCHED	0x0080
    124 #define PT_FLAG_SUSPENDED	0x0100	/* In the suspended queue */
    125 
    126 #define PT_MAGIC	0x11110001
    127 #define PT_DEAD		0xDEAD0001
    128 
    129 #define PT_ATTR_MAGIC	0x22220002
    130 #define PT_ATTR_DEAD	0xDEAD0002
    131 
    132 #ifdef PT_FIXEDSTACKSIZE_LG
    133 
    134 #define	PT_STACKSIZE_LG	PT_FIXEDSTACKSIZE_LG
    135 #define	PT_STACKSIZE	(1<<(PT_STACKSIZE_LG))
    136 #define	PT_STACKMASK	(PT_STACKSIZE-1)
    137 
    138 #else  /* PT_FIXEDSTACKSIZE_LG */
    139 
    140 extern	int		pthread_stacksize_lg;
    141 extern	size_t		pthread_stacksize;
    142 extern	vaddr_t		pthread_stackmask;
    143 
    144 #define	PT_STACKSIZE_LG	pthread_stacksize_lg
    145 #define	PT_STACKSIZE	pthread_stacksize
    146 #define	PT_STACKMASK	pthread_stackmask
    147 
    148 #endif /* PT_FIXEDSTACKSIZE_LG */
    149 
    150 /* Flag to be used in a ucontext_t's uc_flags indicating that
    151  * the saved register state is "user" state only, not full
    152  * trap state.
    153  */
    154 #define _UC_USER_BIT		30
    155 #define _UC_USER		(1LU << _UC_USER_BIT)
    156 
    157 void	pthread_init(void)  __attribute__ ((__constructor__));
    158 
    159 /* Utility functions */
    160 
    161 /* Get offset from stack start to struct sa_stackinfo */
    162 ssize_t	pthread__stackinfo_offset(void);
    163 
    164 void	pthread__unpark_all(pthread_t self, pthread_spin_t *lock,
    165 			    pthread_queue_t *threadq);
    166 void	pthread__unpark(pthread_t self, pthread_spin_t *lock,
    167 			pthread_queue_t *queue, pthread_t target);
    168 int	pthread__park(pthread_t self, pthread_spin_t *lock,
    169 		      pthread_queue_t *threadq,
    170 		      const struct timespec *abs_timeout,
    171 		      int cancelpt, const void *hint);
    172 
    173 int	pthread__stackalloc(pthread_t *t);
    174 void	pthread__initmain(pthread_t *t);
    175 
    176 /* Internal locking primitives */
    177 void	pthread__lockprim_init(int ncpu);
    178 void	pthread_lockinit(pthread_spin_t *lock);
    179 void	pthread_spinlock(pthread_t thread, pthread_spin_t *lock);
    180 int	pthread_spintrylock(pthread_t thread, pthread_spin_t *lock);
    181 void	pthread_spinunlock(pthread_t thread, pthread_spin_t *lock);
    182 
    183 extern const struct pthread_lock_ops *pthread__lock_ops;
    184 
    185 void	pthread__simple_lock_init(__cpu_simple_lock_t *);
    186 int	pthread__simple_lock_try(__cpu_simple_lock_t *);
    187 void	pthread__simple_unlock(__cpu_simple_lock_t *);
    188 
    189 #ifndef _getcontext_u
    190 int	_getcontext_u(ucontext_t *);
    191 #endif
    192 #ifndef _setcontext_u
    193 int	_setcontext_u(const ucontext_t *);
    194 #endif
    195 #ifndef _swapcontext_u
    196 int	_swapcontext_u(ucontext_t *, const ucontext_t *);
    197 #endif
    198 
    199 void	pthread__testcancel(pthread_t self);
    200 int	pthread__find(pthread_t self, pthread_t target);
    201 
    202 #ifndef PTHREAD_MD_INIT
    203 #define PTHREAD_MD_INIT
    204 #endif
    205 
    206 #ifndef _INITCONTEXT_U_MD
    207 #define _INITCONTEXT_U_MD(ucp)
    208 #endif
    209 
    210 #define _INITCONTEXT_U(ucp) do {					\
    211 	(ucp)->uc_flags = _UC_CPU | _UC_STACK;				\
    212 	_INITCONTEXT_U_MD(ucp)						\
    213 	} while (/*CONSTCOND*/0)
    214 
    215 #ifdef PTHREAD_MACHINE_HAS_ID_REGISTER
    216 #define pthread__id(reg) (reg)
    217 #else
    218 /* Stack location of pointer to a particular thread */
    219 #define pthread__id(sp) \
    220 	((pthread_t) (((vaddr_t)(sp)) & ~PT_STACKMASK))
    221 
    222 #define pthread__id_reg() pthread__sp()
    223 #endif
    224 
    225 #define pthread__self() (pthread__id(pthread__id_reg()))
    226 
    227 #define pthread__abort()						\
    228 	pthread__assertfunc(__FILE__, __LINE__, __func__, "unreachable")
    229 
    230 #define pthread__assert(e) do {						\
    231 	if (__predict_false(!(e)))					\
    232        	       pthread__assertfunc(__FILE__, __LINE__, __func__, #e);	\
    233         } while (/*CONSTCOND*/0)
    234 
    235 #define pthread__error(err, msg, e) do {				\
    236 	if (__predict_false(!(e))) {					\
    237        	       pthread__errorfunc(__FILE__, __LINE__, __func__, msg);	\
    238 	       return (err);						\
    239 	} 								\
    240         } while (/*CONSTCOND*/0)
    241 
    242 void	pthread__destroy_tsd(pthread_t self);
    243 void	pthread__assertfunc(const char *file, int line, const char *function,
    244 		const char *expr);
    245 void	pthread__errorfunc(const char *file, int line, const char *function,
    246 		const char *msg);
    247 
    248 #if defined(i386) || defined(__x86_64__)
    249 #define	pthread__smt_pause()	__asm __volatile("rep; nop" ::: "memory")
    250 #else
    251 #define	pthread__smt_pause()	/* nothing */
    252 #endif
    253 
    254 extern int pthread__nspins;
    255 
    256 #endif /* _LIB_PTHREAD_INT_H */
    257