pthread_int.h revision 1.99
1 /* $NetBSD: pthread_int.h,v 1.99 2020/01/27 20:50:05 ad Exp $ */ 2 3 /*- 4 * Copyright (c) 2001, 2002, 2003, 2006, 2007, 2008, 2020 5 * The NetBSD Foundation, Inc. 6 * All rights reserved. 7 * 8 * This code is derived from software contributed to The NetBSD Foundation 9 * by Nathan J. Williams and Andrew Doran. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 24 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 30 * POSSIBILITY OF SUCH DAMAGE. 31 */ 32 33 #ifndef _LIB_PTHREAD_INT_H 34 #define _LIB_PTHREAD_INT_H 35 36 #include <sys/tls.h> 37 38 /* #define PTHREAD__DEBUG */ 39 #define ERRORCHECK 40 41 #include "pthread_types.h" 42 #include "pthread_queue.h" 43 #include "pthread_md.h" 44 45 /* Need to use libc-private names for atomic operations. */ 46 #include "../../common/lib/libc/atomic/atomic_op_namespace.h" 47 48 #include <sys/atomic.h> 49 #include <sys/rbtree.h> 50 51 #include <limits.h> 52 #include <lwp.h> 53 #include <signal.h> 54 #include <stdbool.h> 55 56 #ifdef __GNUC__ 57 #define PTHREAD_HIDE __attribute__ ((visibility("hidden"))) 58 #else 59 #define PTHREAD_HIDE /* nothing */ 60 #endif 61 62 #define PTHREAD__UNPARK_MAX 128 63 64 /* 65 * The size of this structure needs to be no larger than struct 66 * __pthread_cleanup_store, defined in pthread.h. 67 */ 68 struct pt_clean_t { 69 PTQ_ENTRY(pt_clean_t) ptc_next; 70 void (*ptc_cleanup)(void *); 71 void *ptc_arg; 72 }; 73 74 /* Private data for pthread_attr_t */ 75 struct pthread_attr_private { 76 char ptap_name[PTHREAD_MAX_NAMELEN_NP]; 77 void *ptap_namearg; 78 void *ptap_stackaddr; 79 size_t ptap_stacksize; 80 size_t ptap_guardsize; 81 struct sched_param ptap_sp; 82 int ptap_policy; 83 }; 84 85 struct pthread_lock_ops { 86 void (*plo_init)(__cpu_simple_lock_t *); 87 int (*plo_try)(__cpu_simple_lock_t *); 88 void (*plo_unlock)(__cpu_simple_lock_t *); 89 void (*plo_lock)(__cpu_simple_lock_t *); 90 }; 91 92 struct __pthread_st { 93 pthread_t pt_self; /* Must be first. */ 94 #if defined(__HAVE_TLS_VARIANT_I) || defined(__HAVE_TLS_VARIANT_II) 95 struct tls_tcb *pt_tls; /* Thread Local Storage area */ 96 #endif 97 unsigned int pt_magic; /* Magic number */ 98 int pt_state; /* running, blocked, etc. */ 99 pthread_mutex_t pt_lock; /* lock on state */ 100 int pt_flags; /* see PT_FLAG_* below */ 101 int pt_cancel; /* Deferred cancellation */ 102 int pt_errno; /* Thread-specific errno. */ 103 stack_t pt_stack; /* Our stack */ 104 bool pt_stack_allocated; 105 size_t pt_guardsize; 106 void *pt_exitval; /* Read by pthread_join() */ 107 char *pt_name; /* Thread's name, set by the app. */ 108 int pt_willpark; /* About to park */ 109 lwpid_t pt_unpark; /* Unpark this when parking */ 110 struct pthread_lock_ops pt_lockops;/* Cached to avoid PIC overhead */ 111 void *(*pt_func)(void *);/* Function to call at start. */ 112 void *pt_arg; /* Argument to pass at start. */ 113 114 /* Threads to defer waking, usually until pthread_mutex_unlock(). */ 115 lwpid_t pt_waiters[PTHREAD__UNPARK_MAX]; 116 size_t pt_nwaiters; 117 118 /* Stack of cancellation cleanup handlers and their arguments */ 119 PTQ_HEAD(, pt_clean_t) pt_cleanup_stack; 120 121 /* LWP ID and entry on the list of all threads. */ 122 lwpid_t pt_lid; 123 rb_node_t pt_alltree; 124 PTQ_ENTRY(__pthread_st) pt_allq; 125 PTQ_ENTRY(__pthread_st) pt_deadq; 126 127 /* 128 * General synchronization data. We try to align, as threads 129 * on other CPUs will access this data frequently. 130 */ 131 int pt_dummy1 __aligned(128); 132 struct lwpctl *pt_lwpctl; /* Kernel/user comms area */ 133 volatile int pt_rwlocked; /* Handed rwlock successfully */ 134 volatile int pt_signalled; /* Received pthread_cond_signal() */ 135 volatile int pt_mutexwait; /* Waiting to acquire mutex */ 136 void * volatile pt_mutexnext; /* Next thread in chain */ 137 void * volatile pt_sleepobj; /* Object slept on */ 138 PTQ_ENTRY(__pthread_st) pt_sleep; 139 void (*pt_early)(void *); 140 int pt_dummy2 __aligned(128); 141 142 /* Thread-specific data. Large so it sits close to the end. */ 143 int pt_havespecific; 144 struct pt_specific { 145 void *pts_value; 146 PTQ_ENTRY(pt_specific) pts_next; 147 } pt_specific[]; 148 }; 149 150 /* Thread states */ 151 #define PT_STATE_RUNNING 1 152 #define PT_STATE_ZOMBIE 5 153 #define PT_STATE_DEAD 6 154 155 /* Flag values */ 156 157 #define PT_FLAG_DETACHED 0x0001 158 #define PT_FLAG_CS_DISABLED 0x0004 /* Cancellation disabled */ 159 #define PT_FLAG_CS_ASYNC 0x0008 /* Cancellation is async */ 160 #define PT_FLAG_CS_PENDING 0x0010 161 #define PT_FLAG_SCOPE_SYSTEM 0x0040 162 #define PT_FLAG_EXPLICIT_SCHED 0x0080 163 #define PT_FLAG_SUSPENDED 0x0100 /* In the suspended queue */ 164 165 #define PT_MAGIC 0x11110001 166 #define PT_DEAD 0xDEAD0001 167 168 #define PT_ATTR_MAGIC 0x22220002 169 #define PT_ATTR_DEAD 0xDEAD0002 170 171 extern size_t pthread__stacksize; 172 extern size_t pthread__guardsize; 173 extern size_t pthread__pagesize; 174 extern int pthread__nspins; 175 extern int pthread__concurrency; 176 extern int pthread__osrev; 177 extern int pthread__unpark_max; 178 extern int pthread_keys_max; 179 180 extern int __uselibcstub; 181 182 /* Flag to be used in a ucontext_t's uc_flags indicating that 183 * the saved register state is "user" state only, not full 184 * trap state. 185 */ 186 #define _UC_USER_BIT 30 187 #define _UC_USER (1LU << _UC_USER_BIT) 188 189 /* Utility functions */ 190 void pthread__unpark_all(pthread_queue_t *, pthread_t, pthread_mutex_t *) 191 PTHREAD_HIDE; 192 void pthread__unpark(pthread_queue_t *, pthread_t, pthread_mutex_t *) 193 PTHREAD_HIDE; 194 int pthread__park(pthread_t, pthread_mutex_t *, pthread_queue_t *, 195 const struct timespec *, int, const void *) 196 PTHREAD_HIDE; 197 pthread_mutex_t *pthread__hashlock(volatile const void *) PTHREAD_HIDE; 198 199 /* Internal locking primitives */ 200 void pthread__lockprim_init(void) PTHREAD_HIDE; 201 void pthread_lockinit(pthread_spin_t *) PTHREAD_HIDE; 202 203 static inline void pthread__spinlock(pthread_t, pthread_spin_t *) 204 __attribute__((__always_inline__)); 205 static inline void 206 pthread__spinlock(pthread_t self, pthread_spin_t *lock) 207 { 208 if (__predict_true((*self->pt_lockops.plo_try)(lock))) 209 return; 210 (*self->pt_lockops.plo_lock)(lock); 211 } 212 213 static inline int pthread__spintrylock(pthread_t, pthread_spin_t *) 214 __attribute__((__always_inline__)); 215 static inline int 216 pthread__spintrylock(pthread_t self, pthread_spin_t *lock) 217 { 218 return (*self->pt_lockops.plo_try)(lock); 219 } 220 221 static inline void pthread__spinunlock(pthread_t, pthread_spin_t *) 222 __attribute__((__always_inline__)); 223 static inline void 224 pthread__spinunlock(pthread_t self, pthread_spin_t *lock) 225 { 226 (*self->pt_lockops.plo_unlock)(lock); 227 } 228 229 extern const struct pthread_lock_ops *pthread__lock_ops; 230 231 int pthread__simple_locked_p(__cpu_simple_lock_t *) PTHREAD_HIDE; 232 #define pthread__simple_lock_init(alp) (*pthread__lock_ops->plo_init)(alp) 233 #define pthread__simple_lock_try(alp) (*pthread__lock_ops->plo_try)(alp) 234 #define pthread__simple_unlock(alp) (*pthread__lock_ops->plo_unlock)(alp) 235 236 void pthread__testcancel(pthread_t) PTHREAD_HIDE; 237 int pthread__find(pthread_t) PTHREAD_HIDE; 238 239 #ifndef PTHREAD_MD_INIT 240 #define PTHREAD_MD_INIT 241 #endif 242 243 #ifndef _INITCONTEXT_U_MD 244 #define _INITCONTEXT_U_MD(ucp) 245 #endif 246 247 #define _INITCONTEXT_U(ucp) do { \ 248 (ucp)->uc_flags = _UC_CPU | _UC_STACK; \ 249 _INITCONTEXT_U_MD(ucp) \ 250 } while (/*CONSTCOND*/0) 251 252 253 #if !defined(__HAVE_TLS_VARIANT_I) && !defined(__HAVE_TLS_VARIANT_II) 254 #error Either __HAVE_TLS_VARIANT_I or __HAVE_TLS_VARIANT_II must be defined 255 #endif 256 257 #ifdef _PTHREAD_GETTCB_EXT 258 struct tls_tcb *_PTHREAD_GETTCB_EXT(void); 259 #endif 260 261 static inline pthread_t __constfunc 262 pthread__self(void) 263 { 264 #if defined(_PTHREAD_GETTCB_EXT) 265 struct tls_tcb * const tcb = _PTHREAD_GETTCB_EXT(); 266 #elif defined(__HAVE___LWP_GETTCB_FAST) 267 struct tls_tcb * const tcb = __lwp_gettcb_fast(); 268 #else 269 struct tls_tcb * const tcb = __lwp_getprivate_fast(); 270 #endif 271 return (pthread_t)tcb->tcb_pthread; 272 } 273 274 #define pthread__abort() \ 275 pthread__assertfunc(__FILE__, __LINE__, __func__, "unreachable") 276 277 #define pthread__assert(e) do { \ 278 if (__predict_false(!(e))) \ 279 pthread__assertfunc(__FILE__, __LINE__, __func__, #e); \ 280 } while (/*CONSTCOND*/0) 281 282 #define pthread__error(err, msg, e) do { \ 283 if (__predict_false(!(e))) { \ 284 pthread__errorfunc(__FILE__, __LINE__, __func__, msg); \ 285 return (err); \ 286 } \ 287 } while (/*CONSTCOND*/0) 288 289 void *pthread_tsd_init(size_t *) PTHREAD_HIDE; 290 void pthread__destroy_tsd(pthread_t) PTHREAD_HIDE; 291 void pthread__copy_tsd(pthread_t) PTHREAD_HIDE; 292 293 __dead void pthread__assertfunc(const char *, int, const char *, const char *) 294 PTHREAD_HIDE; 295 void pthread__errorfunc(const char *, int, const char *, const char *) 296 PTHREAD_HIDE; 297 char *pthread__getenv(const char *) PTHREAD_HIDE; 298 __dead void pthread__cancelled(void) PTHREAD_HIDE; 299 void pthread__mutex_deferwake(pthread_t, pthread_mutex_t *) PTHREAD_HIDE; 300 int pthread__checkpri(int) PTHREAD_HIDE; 301 int pthread__add_specific(pthread_t, pthread_key_t, const void *) PTHREAD_HIDE; 302 303 #ifndef pthread__smt_pause 304 #define pthread__smt_pause() /* nothing */ 305 #endif 306 #ifndef pthread__smt_wake 307 #define pthread__smt_wake() /* nothing */ 308 #endif 309 310 /* 311 * Bits in the owner field of the lock that indicate lock state. If the 312 * WRITE_LOCKED bit is clear, then the owner field is actually a count of 313 * the number of readers. 314 */ 315 #define RW_HAS_WAITERS 0x01 /* lock has waiters */ 316 #define RW_WRITE_WANTED 0x02 /* >= 1 waiter is a writer */ 317 #define RW_WRITE_LOCKED 0x04 /* lock is currently write locked */ 318 #define RW_UNUSED 0x08 /* currently unused */ 319 320 #define RW_FLAGMASK 0x0f 321 322 #define RW_READ_COUNT_SHIFT 4 323 #define RW_READ_INCR (1 << RW_READ_COUNT_SHIFT) 324 #define RW_THREAD ((uintptr_t)-RW_READ_INCR) 325 326 #endif /* _LIB_PTHREAD_INT_H */ 327
Indexes created Mon Sep 22 10:09:38 GMT 2025