Home | History | Annotate | Line # | Download | only in libpthread
pthread_int.h revision 1.47
      1 /*	$NetBSD: pthread_int.h,v 1.47 2007/08/16 01:09:35 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 	void		*pt_exitval;	/* Read by pthread_join() */
     85 	char		*pt_name;	/* Thread's name, set by the app. */
     86 	int		pt_willpark;	/* About to park */
     87 	lwpid_t		pt_unpark;	/* Unpark this when parking */
     88 	void		*pt_unparkhint;	/* Hint for the above */
     89 
     90 	/* Stack of cancellation cleanup handlers and their arguments */
     91 	PTQ_HEAD(, pt_clean_t)	pt_cleanup_stack;
     92 
     93 	/* Thread-specific data */
     94 	void		*pt_specific[PTHREAD_KEYS_MAX];
     95 
     96 	/* For debugger: LWPs waiting to join. */
     97 	pthread_queue_t	pt_joiners;
     98 	PTQ_ENTRY(__pthread_st) pt_joinq;
     99 
    100 	/* LWP ID and entry on the list of all threads. */
    101 	lwpid_t		pt_lid;
    102 	PTQ_ENTRY(__pthread_st)	pt_allq;
    103 
    104 	/*
    105 	 * General synchronization data.  We try to align, as threads
    106 	 * on other CPUs will access this data frequently.
    107 	 */
    108 	int		pt_dummy1 __aligned(128);
    109 	int		pt_sleeponq;	/* on a sleep queue */
    110 	int		pt_signalled;	/* Received pthread_cond_signal() */
    111 	void		*pt_sleepobj;	/* object slept on */
    112 	pthread_queue_t	*pt_sleepq;	/* sleep queue */
    113 	PTQ_ENTRY(__pthread_st)	pt_sleep;
    114 	int		pt_dummy2 __aligned(128);
    115 
    116 	/*
    117 	 * Context for thread creation.  At the end as it's cached
    118 	 * and then only ever passed to _lwp_create().
    119 	 */
    120 	ucontext_t	pt_uc;
    121 };
    122 
    123 /* Thread states */
    124 #define PT_STATE_RUNNING	1
    125 #define PT_STATE_ZOMBIE		5
    126 #define PT_STATE_DEAD		6
    127 
    128 /* Flag values */
    129 
    130 #define PT_FLAG_DETACHED	0x0001
    131 #define PT_FLAG_CS_DISABLED	0x0004	/* Cancellation disabled */
    132 #define PT_FLAG_CS_ASYNC	0x0008  /* Cancellation is async */
    133 #define PT_FLAG_CS_PENDING	0x0010
    134 #define PT_FLAG_SCOPE_SYSTEM	0x0040
    135 #define PT_FLAG_EXPLICIT_SCHED	0x0080
    136 #define PT_FLAG_SUSPENDED	0x0100	/* In the suspended queue */
    137 
    138 #define PT_MAGIC	0x11110001
    139 #define PT_DEAD		0xDEAD0001
    140 
    141 #define PT_ATTR_MAGIC	0x22220002
    142 #define PT_ATTR_DEAD	0xDEAD0002
    143 
    144 extern	int		pthread__stacksize_lg;
    145 extern	size_t		pthread__stacksize;
    146 extern	vaddr_t		pthread__stackmask;
    147 
    148 /* Flag to be used in a ucontext_t's uc_flags indicating that
    149  * the saved register state is "user" state only, not full
    150  * trap state.
    151  */
    152 #define _UC_USER_BIT		30
    153 #define _UC_USER		(1LU << _UC_USER_BIT)
    154 
    155 void	pthread_init(void)  __attribute__ ((__constructor__));
    156 
    157 /* Utility functions */
    158 void	pthread__unpark_all(pthread_t self, pthread_spin_t *lock,
    159 			    pthread_queue_t *threadq);
    160 void	pthread__unpark(pthread_t self, pthread_spin_t *lock,
    161 			pthread_queue_t *queue, pthread_t target);
    162 int	pthread__park(pthread_t self, pthread_spin_t *lock,
    163 		      pthread_queue_t *threadq,
    164 		      const struct timespec *abs_timeout,
    165 		      int cancelpt, const void *hint);
    166 
    167 /* Internal locking primitives */
    168 void	pthread__lockprim_init(int ncpu);
    169 void	pthread_lockinit(pthread_spin_t *lock);
    170 void	pthread_spinlock(pthread_t thread, pthread_spin_t *lock);
    171 int	pthread_spintrylock(pthread_t thread, pthread_spin_t *lock);
    172 void	pthread_spinunlock(pthread_t thread, pthread_spin_t *lock);
    173 
    174 extern const struct pthread_lock_ops *pthread__lock_ops;
    175 
    176 void	pthread__simple_lock_init(__cpu_simple_lock_t *);
    177 int	pthread__simple_lock_try(__cpu_simple_lock_t *);
    178 void	pthread__simple_unlock(__cpu_simple_lock_t *);
    179 
    180 #ifndef _getcontext_u
    181 int	_getcontext_u(ucontext_t *);
    182 #endif
    183 #ifndef _setcontext_u
    184 int	_setcontext_u(const ucontext_t *);
    185 #endif
    186 #ifndef _swapcontext_u
    187 int	_swapcontext_u(ucontext_t *, const ucontext_t *);
    188 #endif
    189 
    190 void	pthread__testcancel(pthread_t self);
    191 int	pthread__find(pthread_t self, pthread_t target);
    192 
    193 #ifndef PTHREAD_MD_INIT
    194 #define PTHREAD_MD_INIT
    195 #endif
    196 
    197 #ifndef _INITCONTEXT_U_MD
    198 #define _INITCONTEXT_U_MD(ucp)
    199 #endif
    200 
    201 #define _INITCONTEXT_U(ucp) do {					\
    202 	(ucp)->uc_flags = _UC_CPU | _UC_STACK;				\
    203 	_INITCONTEXT_U_MD(ucp)						\
    204 	} while (/*CONSTCOND*/0)
    205 
    206 #ifdef PTHREAD_MACHINE_HAS_ID_REGISTER
    207 #define pthread__id(reg) (reg)
    208 #else
    209 /* Stack location of pointer to a particular thread */
    210 #define pthread__id(sp) \
    211 	((pthread_t) (((vaddr_t)(sp)) & ~pthread__stackmask))
    212 
    213 #define pthread__id_reg() pthread__sp()
    214 #endif
    215 
    216 #define pthread__self() (pthread__id(pthread__id_reg()))
    217 
    218 #define pthread__abort()						\
    219 	pthread__assertfunc(__FILE__, __LINE__, __func__, "unreachable")
    220 
    221 #define pthread__assert(e) do {						\
    222 	if (__predict_false(!(e)))					\
    223        	       pthread__assertfunc(__FILE__, __LINE__, __func__, #e);	\
    224         } while (/*CONSTCOND*/0)
    225 
    226 #define pthread__error(err, msg, e) do {				\
    227 	if (__predict_false(!(e))) {					\
    228        	       pthread__errorfunc(__FILE__, __LINE__, __func__, msg);	\
    229 	       return (err);						\
    230 	} 								\
    231         } while (/*CONSTCOND*/0)
    232 
    233 void	pthread__destroy_tsd(pthread_t self);
    234 void	pthread__assertfunc(const char *file, int line, const char *function,
    235 		const char *expr);
    236 void	pthread__errorfunc(const char *file, int line, const char *function,
    237 		const char *msg);
    238 
    239 #if defined(i386) || defined(__x86_64__)
    240 #define	pthread__smt_pause()	__asm __volatile("rep; nop" ::: "memory")
    241 #else
    242 #define	pthread__smt_pause()	/* nothing */
    243 #endif
    244 
    245 extern int pthread__nspins;
    246 extern int pthread__osrev;
    247 
    248 #endif /* _LIB_PTHREAD_INT_H */
    249