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