pthread_int.h revision 1.58
1 /* $NetBSD: pthread_int.h,v 1.58 2007/10/16 15:07:02 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 <sys/tree.h> 51 52 #include <lwp.h> 53 #include <signal.h> 54 55 #define PTHREAD_KEYS_MAX 256 56 #define PTHREAD__UNPARK_MAX 32 57 58 /* 59 * The size of this structure needs to be no larger than struct 60 * __pthread_cleanup_store, defined in pthread.h. 61 */ 62 struct pt_clean_t { 63 PTQ_ENTRY(pt_clean_t) ptc_next; 64 void (*ptc_cleanup)(void *); 65 void *ptc_arg; 66 }; 67 68 /* Private data for pthread_attr_t */ 69 struct pthread_attr_private { 70 char ptap_name[PTHREAD_MAX_NAMELEN_NP]; 71 void *ptap_namearg; 72 void *ptap_stackaddr; 73 size_t ptap_stacksize; 74 size_t ptap_guardsize; 75 }; 76 77 struct __pthread_st { 78 unsigned int pt_magic; /* Magic number */ 79 int pt_num; /* ID XXX should die */ 80 int pt_state; /* running, blocked, etc. */ 81 pthread_mutex_t pt_lock; /* lock on state */ 82 int pt_flags; /* see PT_FLAG_* below */ 83 int pt_cancel; /* Deferred cancellation */ 84 int pt_spinlocks; /* Number of spinlocks held. */ 85 int pt_errno; /* Thread-specific errno. */ 86 stack_t pt_stack; /* Our stack */ 87 void *pt_exitval; /* Read by pthread_join() */ 88 char *pt_name; /* Thread's name, set by the app. */ 89 int pt_willpark; /* About to park */ 90 lwpid_t pt_unpark; /* Unpark this when parking */ 91 void *pt_unparkhint; /* Hint for the above */ 92 93 /* Threads to defer waking, usually until pthread_mutex_unlock(). */ 94 lwpid_t pt_waiters[PTHREAD__UNPARK_MAX]; 95 size_t pt_nwaiters; 96 97 /* Stack of cancellation cleanup handlers and their arguments */ 98 PTQ_HEAD(, pt_clean_t) pt_cleanup_stack; 99 100 /* For debugger: LWPs waiting to join. */ 101 pthread_queue_t pt_joiners; 102 PTQ_ENTRY(__pthread_st) pt_joinq; 103 104 /* LWP ID and entry on the list of all threads. */ 105 lwpid_t pt_lid; 106 RB_ENTRY(__pthread_st) pt_alltree; 107 PTQ_ENTRY(__pthread_st) pt_allq; 108 PTQ_ENTRY(__pthread_st) pt_deadq; 109 110 /* 111 * General synchronization data. We try to align, as threads 112 * on other CPUs will access this data frequently. 113 */ 114 int pt_dummy1 __aligned(128); 115 volatile int pt_rwlocked; /* Handed rwlock successfully */ 116 volatile int pt_sleeponq; /* On a sleep queue */ 117 volatile int pt_signalled; /* Received pthread_cond_signal() */ 118 void * volatile pt_sleepobj; /* Object slept on */ 119 PTQ_ENTRY(__pthread_st) pt_sleep; 120 void (*pt_early)(void *); 121 int pt_dummy2 __aligned(128); 122 123 /* Thread-specific data. Large so it sits close to the end. */ 124 int pt_havespecific; 125 void *pt_specific[PTHREAD_KEYS_MAX]; 126 127 /* 128 * Context for thread creation. At the end as it's cached 129 * and then only ever passed to _lwp_create(). 130 */ 131 ucontext_t pt_uc; 132 }; 133 134 struct pthread_lock_ops { 135 void (*plo_init)(__cpu_simple_lock_t *); 136 int (*plo_try)(__cpu_simple_lock_t *); 137 void (*plo_unlock)(__cpu_simple_lock_t *); 138 }; 139 140 /* Thread states */ 141 #define PT_STATE_RUNNING 1 142 #define PT_STATE_ZOMBIE 5 143 #define PT_STATE_DEAD 6 144 145 /* Flag values */ 146 147 #define PT_FLAG_DETACHED 0x0001 148 #define PT_FLAG_CS_DISABLED 0x0004 /* Cancellation disabled */ 149 #define PT_FLAG_CS_ASYNC 0x0008 /* Cancellation is async */ 150 #define PT_FLAG_CS_PENDING 0x0010 151 #define PT_FLAG_SCOPE_SYSTEM 0x0040 152 #define PT_FLAG_EXPLICIT_SCHED 0x0080 153 #define PT_FLAG_SUSPENDED 0x0100 /* In the suspended queue */ 154 155 #define PT_MAGIC 0x11110001 156 #define PT_DEAD 0xDEAD0001 157 158 #define PT_ATTR_MAGIC 0x22220002 159 #define PT_ATTR_DEAD 0xDEAD0002 160 161 extern int pthread__stacksize_lg; 162 extern size_t pthread__stacksize; 163 extern vaddr_t pthread__stackmask; 164 extern vaddr_t pthread__threadmask; 165 extern int pthread__nspins; 166 extern int pthread__concurrency; 167 extern int pthread__osrev; 168 extern int pthread__unpark_max; 169 170 /* Flag to be used in a ucontext_t's uc_flags indicating that 171 * the saved register state is "user" state only, not full 172 * trap state. 173 */ 174 #define _UC_USER_BIT 30 175 #define _UC_USER (1LU << _UC_USER_BIT) 176 177 void pthread_init(void) __attribute__ ((__constructor__)); 178 179 /* Utility functions */ 180 void pthread__unpark_all(pthread_t self, pthread_spin_t *lock, 181 pthread_queue_t *threadq); 182 void pthread__unpark(pthread_t self, pthread_spin_t *lock, 183 pthread_queue_t *queue, pthread_t target); 184 int pthread__park(pthread_t self, pthread_spin_t *lock, 185 pthread_queue_t *threadq, 186 const struct timespec *abs_timeout, 187 int cancelpt, const void *hint); 188 189 /* Internal locking primitives */ 190 void pthread__lockprim_init(void); 191 void pthread_lockinit(pthread_spin_t *); 192 void pthread_spinlock(pthread_spin_t *); 193 int pthread_spintrylock(pthread_spin_t *); 194 void pthread_spinunlock(pthread_spin_t *); 195 196 extern const struct pthread_lock_ops *pthread__lock_ops; 197 198 int pthread__simple_locked_p(__cpu_simple_lock_t *); 199 #define pthread__simple_lock_init(alp) (*pthread__lock_ops->plo_init)(alp) 200 #define pthread__simple_lock_try(alp) (*pthread__lock_ops->plo_try)(alp) 201 #define pthread__simple_unlock(alp) (*pthread__lock_ops->plo_unlock)(alp) 202 203 #ifndef _getcontext_u 204 int _getcontext_u(ucontext_t *); 205 #endif 206 #ifndef _setcontext_u 207 int _setcontext_u(const ucontext_t *); 208 #endif 209 #ifndef _swapcontext_u 210 int _swapcontext_u(ucontext_t *, const ucontext_t *); 211 #endif 212 213 void pthread__testcancel(pthread_t); 214 int pthread__find(pthread_t); 215 216 #ifndef PTHREAD_MD_INIT 217 #define PTHREAD_MD_INIT 218 #endif 219 220 #ifndef _INITCONTEXT_U_MD 221 #define _INITCONTEXT_U_MD(ucp) 222 #endif 223 224 #define _INITCONTEXT_U(ucp) do { \ 225 (ucp)->uc_flags = _UC_CPU | _UC_STACK; \ 226 _INITCONTEXT_U_MD(ucp) \ 227 } while (/*CONSTCOND*/0) 228 229 #ifdef PTHREAD_MACHINE_HAS_ID_REGISTER 230 #define pthread__id(reg) (reg) 231 #else 232 /* Stack location of pointer to a particular thread */ 233 #define pthread__id(sp) \ 234 ((pthread_t) (((vaddr_t)(sp)) & pthread__threadmask)) 235 236 #define pthread__id_reg() pthread__sp() 237 #endif 238 239 #define pthread__self() (pthread__id(pthread__id_reg())) 240 241 #define pthread__abort() \ 242 pthread__assertfunc(__FILE__, __LINE__, __func__, "unreachable") 243 244 #define pthread__assert(e) do { \ 245 if (__predict_false(!(e))) \ 246 pthread__assertfunc(__FILE__, __LINE__, __func__, #e); \ 247 } while (/*CONSTCOND*/0) 248 249 #define pthread__error(err, msg, e) do { \ 250 if (__predict_false(!(e))) { \ 251 pthread__errorfunc(__FILE__, __LINE__, __func__, msg); \ 252 return (err); \ 253 } \ 254 } while (/*CONSTCOND*/0) 255 256 void pthread__destroy_tsd(pthread_t self); 257 void pthread__assertfunc(const char *file, int line, const char *function, 258 const char *expr); 259 void pthread__errorfunc(const char *file, int line, const char *function, 260 const char *msg); 261 262 int pthread__atomic_cas_ptr(volatile void *, void **, void *); 263 void *pthread__atomic_swap_ptr(volatile void *, void *); 264 void pthread__membar_full(void); 265 void pthread__membar_producer(void); 266 void pthread__membar_consumer(void); 267 268 int pthread__mutex_deferwake(pthread_t, pthread_mutex_t *); 269 int pthread__mutex_catchup(pthread_mutex_t *); 270 271 #ifndef pthread__smt_pause 272 #define pthread__smt_pause() /* nothing */ 273 #endif 274 275 /* 276 * Bits in the owner field of the lock that indicate lock state. If the 277 * WRITE_LOCKED bit is clear, then the owner field is actually a count of 278 * the number of readers. 279 */ 280 #define RW_HAS_WAITERS 0x01 /* lock has waiters */ 281 #define RW_WRITE_WANTED 0x02 /* >= 1 waiter is a writer */ 282 #define RW_WRITE_LOCKED 0x04 /* lock is currently write locked */ 283 #define RW_UNUSED 0x08 /* currently unused */ 284 285 #define RW_FLAGMASK 0x0f 286 287 #define RW_READ_COUNT_SHIFT 4 288 #define RW_READ_INCR (1 << RW_READ_COUNT_SHIFT) 289 #define RW_THREAD ((uintptr_t)-RW_READ_INCR) 290 #define RW_OWNER(rw) ((rw)->rw_owner & RW_THREAD) 291 #define RW_COUNT(rw) ((rw)->rw_owner & RW_THREAD) 292 #define RW_FLAGS(rw) ((rw)->rw_owner & ~RW_THREAD) 293 294 #define ptr_owner ptr_writer 295 296 #endif /* _LIB_PTHREAD_INT_H */ 297
Indexes created Sun Sep 21 20:09:37 GMT 2025