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