pthread_int.h revision 1.100
1 /* $NetBSD: pthread_int.h,v 1.100 2020/01/28 13:08:40 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 #include <sys/param.h> 51 52 #include <limits.h> 53 #include <lwp.h> 54 #include <signal.h> 55 #include <stdbool.h> 56 57 #ifdef __GNUC__ 58 #define PTHREAD_HIDE __attribute__ ((visibility("hidden"))) 59 #else 60 #define PTHREAD_HIDE /* nothing */ 61 #endif 62 63 #define PTHREAD__UNPARK_MAX 128 64 65 /* 66 * The size of this structure needs to be no larger than struct 67 * __pthread_cleanup_store, defined in pthread.h. 68 */ 69 struct pt_clean_t { 70 PTQ_ENTRY(pt_clean_t) ptc_next; 71 void (*ptc_cleanup)(void *); 72 void *ptc_arg; 73 }; 74 75 /* Private data for pthread_attr_t */ 76 struct pthread_attr_private { 77 char ptap_name[PTHREAD_MAX_NAMELEN_NP]; 78 void *ptap_namearg; 79 void *ptap_stackaddr; 80 size_t ptap_stacksize; 81 size_t ptap_guardsize; 82 struct sched_param ptap_sp; 83 int ptap_policy; 84 }; 85 86 struct pthread_lock_ops { 87 void (*plo_init)(__cpu_simple_lock_t *); 88 int (*plo_try)(__cpu_simple_lock_t *); 89 void (*plo_unlock)(__cpu_simple_lock_t *); 90 void (*plo_lock)(__cpu_simple_lock_t *); 91 }; 92 93 struct __pthread_st { 94 pthread_t pt_self; /* Must be first. */ 95 #if defined(__HAVE_TLS_VARIANT_I) || defined(__HAVE_TLS_VARIANT_II) 96 struct tls_tcb *pt_tls; /* Thread Local Storage area */ 97 #endif 98 unsigned int pt_magic; /* Magic number */ 99 int pt_state; /* running, blocked, etc. */ 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 PTQ_ENTRY(__pthread_st) pt_deadq; 124 125 /* 126 * rbtree node and entry on the list of all threads. pt_alltree in 127 * its own cacheline, so pthread__find() is not needlessly impacted 128 * by threads going about their normal business. pt_allq is 129 * adjusted at the same time as pt_alltree. 130 */ 131 rb_node_t pt_alltree __aligned(COHERENCY_UNIT); 132 PTQ_ENTRY(__pthread_st) pt_allq; 133 134 /* Lock on state also gets its own line. */ 135 pthread_mutex_t pt_lock __aligned(COHERENCY_UNIT); 136 137 /* 138 * General synchronization data. We try to align, as threads 139 * on other CPUs will access this data frequently. 140 */ 141 int pt_dummy1 __aligned(COHERENCY_UNIT); 142 struct lwpctl *pt_lwpctl; /* Kernel/user comms area */ 143 volatile int pt_rwlocked; /* Handed rwlock successfully */ 144 volatile int pt_signalled; /* Received pthread_cond_signal() */ 145 volatile int pt_mutexwait; /* Waiting to acquire mutex */ 146 void * volatile pt_mutexnext; /* Next thread in chain */ 147 void * volatile pt_sleepobj; /* Object slept on */ 148 PTQ_ENTRY(__pthread_st) pt_sleep; 149 void (*pt_early)(void *); 150 151 /* Thread-specific data. Large so it sits close to the end. */ 152 int pt_havespecific __aligned(COHERENCY_UNIT); 153 struct pt_specific { 154 void *pts_value; 155 PTQ_ENTRY(pt_specific) pts_next; 156 } pt_specific[]; 157 }; 158 159 /* Thread states */ 160 #define PT_STATE_RUNNING 1 161 #define PT_STATE_ZOMBIE 5 162 #define PT_STATE_DEAD 6 163 164 /* Flag values */ 165 166 #define PT_FLAG_DETACHED 0x0001 167 #define PT_FLAG_CS_DISABLED 0x0004 /* Cancellation disabled */ 168 #define PT_FLAG_CS_ASYNC 0x0008 /* Cancellation is async */ 169 #define PT_FLAG_CS_PENDING 0x0010 170 #define PT_FLAG_SCOPE_SYSTEM 0x0040 171 #define PT_FLAG_EXPLICIT_SCHED 0x0080 172 #define PT_FLAG_SUSPENDED 0x0100 /* In the suspended queue */ 173 174 #define PT_MAGIC 0x11110001 175 #define PT_DEAD 0xDEAD0001 176 177 #define PT_ATTR_MAGIC 0x22220002 178 #define PT_ATTR_DEAD 0xDEAD0002 179 180 extern size_t pthread__stacksize; 181 extern size_t pthread__guardsize; 182 extern size_t pthread__pagesize; 183 extern int pthread__nspins; 184 extern int pthread__concurrency; 185 extern int pthread__osrev; 186 extern int pthread__unpark_max; 187 extern int pthread_keys_max; 188 189 extern int __uselibcstub; 190 191 /* Flag to be used in a ucontext_t's uc_flags indicating that 192 * the saved register state is "user" state only, not full 193 * trap state. 194 */ 195 #define _UC_USER_BIT 30 196 #define _UC_USER (1LU << _UC_USER_BIT) 197 198 /* Utility functions */ 199 void pthread__unpark_all(pthread_queue_t *, pthread_t, pthread_mutex_t *) 200 PTHREAD_HIDE; 201 void pthread__unpark(pthread_queue_t *, pthread_t, pthread_mutex_t *) 202 PTHREAD_HIDE; 203 int pthread__park(pthread_t, pthread_mutex_t *, pthread_queue_t *, 204 const struct timespec *, int, const void *) 205 PTHREAD_HIDE; 206 pthread_mutex_t *pthread__hashlock(volatile const void *) PTHREAD_HIDE; 207 208 /* Internal locking primitives */ 209 void pthread__lockprim_init(void) PTHREAD_HIDE; 210 void pthread_lockinit(pthread_spin_t *) PTHREAD_HIDE; 211 212 static inline void pthread__spinlock(pthread_t, pthread_spin_t *) 213 __attribute__((__always_inline__)); 214 static inline void 215 pthread__spinlock(pthread_t self, pthread_spin_t *lock) 216 { 217 if (__predict_true((*self->pt_lockops.plo_try)(lock))) 218 return; 219 (*self->pt_lockops.plo_lock)(lock); 220 } 221 222 static inline int pthread__spintrylock(pthread_t, pthread_spin_t *) 223 __attribute__((__always_inline__)); 224 static inline int 225 pthread__spintrylock(pthread_t self, pthread_spin_t *lock) 226 { 227 return (*self->pt_lockops.plo_try)(lock); 228 } 229 230 static inline void pthread__spinunlock(pthread_t, pthread_spin_t *) 231 __attribute__((__always_inline__)); 232 static inline void 233 pthread__spinunlock(pthread_t self, pthread_spin_t *lock) 234 { 235 (*self->pt_lockops.plo_unlock)(lock); 236 } 237 238 extern const struct pthread_lock_ops *pthread__lock_ops; 239 240 int pthread__simple_locked_p(__cpu_simple_lock_t *) PTHREAD_HIDE; 241 #define pthread__simple_lock_init(alp) (*pthread__lock_ops->plo_init)(alp) 242 #define pthread__simple_lock_try(alp) (*pthread__lock_ops->plo_try)(alp) 243 #define pthread__simple_unlock(alp) (*pthread__lock_ops->plo_unlock)(alp) 244 245 void pthread__testcancel(pthread_t) PTHREAD_HIDE; 246 int pthread__find(pthread_t) PTHREAD_HIDE; 247 248 #ifndef PTHREAD_MD_INIT 249 #define PTHREAD_MD_INIT 250 #endif 251 252 #ifndef _INITCONTEXT_U_MD 253 #define _INITCONTEXT_U_MD(ucp) 254 #endif 255 256 #define _INITCONTEXT_U(ucp) do { \ 257 (ucp)->uc_flags = _UC_CPU | _UC_STACK; \ 258 _INITCONTEXT_U_MD(ucp) \ 259 } while (/*CONSTCOND*/0) 260 261 262 #if !defined(__HAVE_TLS_VARIANT_I) && !defined(__HAVE_TLS_VARIANT_II) 263 #error Either __HAVE_TLS_VARIANT_I or __HAVE_TLS_VARIANT_II must be defined 264 #endif 265 266 #ifdef _PTHREAD_GETTCB_EXT 267 struct tls_tcb *_PTHREAD_GETTCB_EXT(void); 268 #endif 269 270 static inline pthread_t __constfunc 271 pthread__self(void) 272 { 273 #if defined(_PTHREAD_GETTCB_EXT) 274 struct tls_tcb * const tcb = _PTHREAD_GETTCB_EXT(); 275 #elif defined(__HAVE___LWP_GETTCB_FAST) 276 struct tls_tcb * const tcb = __lwp_gettcb_fast(); 277 #else 278 struct tls_tcb * const tcb = __lwp_getprivate_fast(); 279 #endif 280 return (pthread_t)tcb->tcb_pthread; 281 } 282 283 #define pthread__abort() \ 284 pthread__assertfunc(__FILE__, __LINE__, __func__, "unreachable") 285 286 #define pthread__assert(e) do { \ 287 if (__predict_false(!(e))) \ 288 pthread__assertfunc(__FILE__, __LINE__, __func__, #e); \ 289 } while (/*CONSTCOND*/0) 290 291 #define pthread__error(err, msg, e) do { \ 292 if (__predict_false(!(e))) { \ 293 pthread__errorfunc(__FILE__, __LINE__, __func__, msg); \ 294 return (err); \ 295 } \ 296 } while (/*CONSTCOND*/0) 297 298 void *pthread_tsd_init(size_t *) PTHREAD_HIDE; 299 void pthread__destroy_tsd(pthread_t) PTHREAD_HIDE; 300 void pthread__copy_tsd(pthread_t) PTHREAD_HIDE; 301 302 __dead void pthread__assertfunc(const char *, int, const char *, const char *) 303 PTHREAD_HIDE; 304 void pthread__errorfunc(const char *, int, const char *, const char *) 305 PTHREAD_HIDE; 306 char *pthread__getenv(const char *) PTHREAD_HIDE; 307 __dead void pthread__cancelled(void) PTHREAD_HIDE; 308 void pthread__mutex_deferwake(pthread_t, pthread_mutex_t *) PTHREAD_HIDE; 309 int pthread__checkpri(int) PTHREAD_HIDE; 310 int pthread__add_specific(pthread_t, pthread_key_t, const void *) PTHREAD_HIDE; 311 312 #ifndef pthread__smt_pause 313 #define pthread__smt_pause() /* nothing */ 314 #endif 315 #ifndef pthread__smt_wake 316 #define pthread__smt_wake() /* nothing */ 317 #endif 318 319 /* 320 * Bits in the owner field of the lock that indicate lock state. If the 321 * WRITE_LOCKED bit is clear, then the owner field is actually a count of 322 * the number of readers. 323 */ 324 #define RW_HAS_WAITERS 0x01 /* lock has waiters */ 325 #define RW_WRITE_WANTED 0x02 /* >= 1 waiter is a writer */ 326 #define RW_WRITE_LOCKED 0x04 /* lock is currently write locked */ 327 #define RW_UNUSED 0x08 /* currently unused */ 328 329 #define RW_FLAGMASK 0x0f 330 331 #define RW_READ_COUNT_SHIFT 4 332 #define RW_READ_INCR (1 << RW_READ_COUNT_SHIFT) 333 #define RW_THREAD ((uintptr_t)-RW_READ_INCR) 334 335 #endif /* _LIB_PTHREAD_INT_H */ 336
Indexes created Mon Sep 22 05:09:51 GMT 2025