1 /* $NetBSD: pthread.h,v 1.46 2026/05/01 11:00:21 wiz Exp $ */ 2 3 /*- 4 * Copyright (c) 2001 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. 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 * 19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 29 * POSSIBILITY OF SUCH DAMAGE. 30 */ 31 32 #ifndef _LIB_PTHREAD_H 33 #define _LIB_PTHREAD_H 34 35 #include <sys/cdefs.h> 36 37 #include <time.h> /* For timespec */ 38 #include <sched.h> 39 #include <sys/featuretest.h> 40 41 #include <pthread_types.h> 42 43 __BEGIN_DECLS 44 #ifndef __PTHREAD_ATFORK_DECLARED 45 #define __PTHREAD_ATFORK_DECLARED 46 int pthread_atfork(void (*)(void), void (*)(void), void (*)(void)); 47 #endif 48 int pthread_create(pthread_t * __restrict, 49 const pthread_attr_t * __restrict, void *(*)(void *), 50 void * __restrict); 51 void pthread_exit(void *) __attribute__((__noreturn__)); 52 int pthread_join(pthread_t, void **); 53 int pthread_equal(pthread_t, pthread_t); 54 pthread_t pthread_self(void); 55 int pthread_detach(pthread_t); 56 57 int pthread_getrrtimer_np(void); 58 int pthread_setrrtimer_np(int); 59 60 int pthread_attr_init(pthread_attr_t *); 61 int pthread_attr_destroy(pthread_attr_t *); 62 int pthread_attr_get_np(pthread_t, pthread_attr_t *); 63 int pthread_attr_getguardsize(const pthread_attr_t * __restrict, 64 size_t * __restrict); 65 int pthread_attr_setguardsize(pthread_attr_t *, size_t); 66 int pthread_attr_getinheritsched(const pthread_attr_t * __restrict, 67 int * __restrict); 68 int pthread_attr_setinheritsched(pthread_attr_t *, int); 69 int pthread_attr_getschedparam(const pthread_attr_t * __restrict, 70 struct sched_param * __restrict); 71 int pthread_attr_setschedparam(pthread_attr_t * __restrict, 72 const struct sched_param * __restrict); 73 int pthread_attr_getschedpolicy(const pthread_attr_t * __restrict, 74 int * __restrict); 75 int pthread_attr_setschedpolicy(pthread_attr_t *, int); 76 int pthread_attr_getscope(const pthread_attr_t * __restrict, 77 int * __restrict); 78 int pthread_attr_setscope(pthread_attr_t *, int); 79 int pthread_attr_getstack(const pthread_attr_t * __restrict, 80 void ** __restrict, size_t * __restrict); 81 int pthread_attr_setstack(pthread_attr_t *, void *, size_t); 82 int pthread_attr_getstacksize(const pthread_attr_t * __restrict, 83 size_t * __restrict); 84 int pthread_attr_setstacksize(pthread_attr_t *, size_t); 85 int pthread_attr_getstackaddr(const pthread_attr_t * __restrict, 86 void ** __restrict); 87 int pthread_attr_setstackaddr(pthread_attr_t *, void *); 88 int pthread_attr_getdetachstate(const pthread_attr_t *, int *); 89 int pthread_attr_setdetachstate(pthread_attr_t *, int); 90 int pthread_attr_getname_np(const pthread_attr_t *, char *, 91 size_t, void **); 92 int pthread_attr_setname_np(pthread_attr_t *, const char *, void *); 93 94 int pthread_mutex_init(pthread_mutex_t * __restrict, 95 const pthread_mutexattr_t * __restrict); 96 int pthread_mutex_destroy(pthread_mutex_t *); 97 int pthread_mutex_lock(pthread_mutex_t *); 98 int pthread_mutex_trylock(pthread_mutex_t *); 99 int pthread_mutex_unlock(pthread_mutex_t *); 100 #ifndef __LIBC12_SOURCE__ 101 int pthread_mutex_timedlock(pthread_mutex_t * __restrict, 102 const struct timespec * __restrict); 103 #endif 104 int pthread_mutex_getprioceiling(const pthread_mutex_t * __restrict, 105 int * __restrict); 106 int pthread_mutex_setprioceiling(pthread_mutex_t * __restrict, int, 107 int * __restrict); 108 int pthread_mutexattr_init(pthread_mutexattr_t *); 109 int pthread_mutexattr_destroy(pthread_mutexattr_t *); 110 #ifdef _PTHREAD_PSHARED 111 int pthread_mutexattr_getpshared(const pthread_mutexattr_t * __restrict, 112 int * __restrict); 113 int pthread_mutexattr_setpshared(pthread_mutexattr_t *, int); 114 #endif 115 int pthread_mutexattr_gettype(const pthread_mutexattr_t * __restrict, 116 int * __restrict); 117 int pthread_mutexattr_settype(pthread_mutexattr_t *attr, int); 118 int pthread_mutexattr_getprotocol(const pthread_mutexattr_t * __restrict, 119 int * __restrict); 120 int pthread_mutexattr_setprotocol(pthread_mutexattr_t*, 121 int); 122 int pthread_mutexattr_getprioceiling(const pthread_mutexattr_t * __restrict, 123 int * __restrict); 124 int pthread_mutexattr_setprioceiling(pthread_mutexattr_t *, 125 int); 126 int pthread_cond_init(pthread_cond_t * __restrict, 127 const pthread_condattr_t * __restrict); 128 int pthread_cond_destroy(pthread_cond_t *); 129 int pthread_cond_wait(pthread_cond_t * __restrict, 130 pthread_mutex_t * __restrict); 131 #ifndef __LIBC12_SOURCE__ 132 int pthread_cond_timedwait(pthread_cond_t * __restrict, 133 pthread_mutex_t * __restrict, const struct timespec * __restrict); 134 #endif 135 int pthread_cond_signal(pthread_cond_t *); 136 int pthread_cond_broadcast(pthread_cond_t *); 137 int pthread_condattr_init(pthread_condattr_t *); 138 int pthread_condattr_setclock(pthread_condattr_t *, clockid_t); 139 int pthread_condattr_getclock(const pthread_condattr_t * __restrict, 140 clockid_t * __restrict); 141 int pthread_condattr_destroy(pthread_condattr_t *); 142 #ifdef _PTHREAD_PSHARED 143 int pthread_condattr_getpshared(const pthread_condattr_t * __restrict, 144 int * __restrict); 145 int pthread_condattr_setpshared(pthread_condattr_t *, int); 146 #endif 147 int pthread_once(pthread_once_t *, void (*)(void)); 148 149 int pthread_key_create(pthread_key_t *, void (*)(void *)); 150 int pthread_key_delete(pthread_key_t); 151 int pthread_setspecific(pthread_key_t, const void *); 152 void* pthread_getspecific(pthread_key_t); 153 154 int pthread_cancel(pthread_t); 155 int pthread_setcancelstate(int, int *); 156 int pthread_setcanceltype(int, int *); 157 void pthread_testcancel(void); 158 159 int pthread_getname_np(pthread_t, char *, size_t); 160 int pthread_setname_np(pthread_t, const char *, void *); 161 162 int pthread_attr_setcreatesuspend_np(pthread_attr_t *); 163 int pthread_suspend_np(pthread_t); 164 int pthread_resume_np(pthread_t); 165 166 unsigned int pthread_curcpu_np(void); 167 168 int pthread_main_np(void); 169 170 int pthread_getcpuclockid(pthread_t, clockid_t *); 171 172 struct pthread_cleanup_store { 173 void *pad[4]; 174 }; 175 176 #define pthread_cleanup_push(routine, arg) \ 177 { \ 178 struct pthread_cleanup_store __store; \ 179 pthread__cleanup_push((routine),(arg), &__store); 180 181 #define pthread_cleanup_pop(execute) \ 182 pthread__cleanup_pop((execute), &__store); \ 183 } 184 185 void pthread__cleanup_push(void (*)(void *), void *, void *); 186 void pthread__cleanup_pop(int, void *); 187 188 int pthread_spin_init(pthread_spinlock_t *, int); 189 int pthread_spin_destroy(pthread_spinlock_t *); 190 int pthread_spin_lock(pthread_spinlock_t *); 191 int pthread_spin_trylock(pthread_spinlock_t *); 192 int pthread_spin_unlock(pthread_spinlock_t *); 193 194 int pthread_rwlock_init(pthread_rwlock_t * __restrict, 195 const pthread_rwlockattr_t * __restrict); 196 int pthread_rwlock_destroy(pthread_rwlock_t *); 197 int pthread_rwlock_rdlock(pthread_rwlock_t *); 198 int pthread_rwlock_tryrdlock(pthread_rwlock_t *); 199 int pthread_rwlock_wrlock(pthread_rwlock_t *); 200 int pthread_rwlock_trywrlock(pthread_rwlock_t *); 201 #ifndef __LIBC12_SOURCE__ 202 int pthread_rwlock_timedrdlock(pthread_rwlock_t * __restrict, 203 const struct timespec * __restrict); 204 int pthread_rwlock_timedwrlock(pthread_rwlock_t * __restrict, 205 const struct timespec * __restrict); 206 #endif 207 int pthread_rwlock_unlock(pthread_rwlock_t *); 208 int pthread_rwlockattr_init(pthread_rwlockattr_t *); 209 int pthread_rwlockattr_destroy(pthread_rwlockattr_t *); 210 #ifdef _PTHREAD_PSHARED 211 int pthread_rwlockattr_getpshared(const pthread_rwlockattr_t * __restrict, 212 int * __restrict); 213 int pthread_rwlockattr_setpshared(pthread_rwlockattr_t *, int); 214 #endif 215 int pthread_barrier_init(pthread_barrier_t * __restrict, 216 const pthread_barrierattr_t * __restrict, unsigned int); 217 int pthread_barrier_wait(pthread_barrier_t *); 218 int pthread_barrier_destroy(pthread_barrier_t *); 219 int pthread_barrierattr_init(pthread_barrierattr_t *); 220 int pthread_barrierattr_destroy(pthread_barrierattr_t *); 221 #ifdef _PTHREAD_PSHARED 222 int pthread_barrierattr_getpshared(const pthread_barrierattr_t * __restrict, 223 int * __restrict); 224 int pthread_barrierattr_setpshared(pthread_barrierattr_t *, int); 225 #endif 226 int pthread_getschedparam(pthread_t, int * __restrict, 227 struct sched_param * __restrict); 228 int pthread_setschedparam(pthread_t, int, const struct sched_param *); 229 int pthread_setschedprio(pthread_t, int); 230 231 int *pthread__errno(void); 232 233 #if defined(_NETBSD_SOURCE) 234 int pthread_getaffinity_np(pthread_t, size_t, cpuset_t *); 235 int pthread_setaffinity_np(pthread_t, size_t, cpuset_t *); 236 int pthread_getattr_np(pthread_t, pthread_attr_t *); 237 238 int pthread_mutex_held_np(pthread_mutex_t *); 239 pthread_t pthread_mutex_owner_np(pthread_mutex_t *); 240 241 int pthread_rwlock_held_np(pthread_rwlock_t *); 242 int pthread_rwlock_wrheld_np(pthread_rwlock_t *); 243 int pthread_rwlock_rdheld_np(pthread_rwlock_t *); 244 245 int pthread_cond_has_waiters_np(pthread_cond_t *); 246 #endif /* _NETBSD_SOURCE */ 247 248 __END_DECLS 249 250 #define PTHREAD_CREATE_JOINABLE 0 251 #define PTHREAD_CREATE_DETACHED 1 252 253 #define PTHREAD_INHERIT_SCHED 0 254 #define PTHREAD_EXPLICIT_SCHED 1 255 256 #define PTHREAD_SCOPE_PROCESS 0 257 #define PTHREAD_SCOPE_SYSTEM 1 258 259 #define PTHREAD_PROCESS_PRIVATE 0 260 #define PTHREAD_PROCESS_SHARED 1 261 262 #define PTHREAD_CANCEL_DEFERRED 0 263 #define PTHREAD_CANCEL_ASYNCHRONOUS 1 264 265 #define PTHREAD_CANCEL_ENABLE 0 266 #define PTHREAD_CANCEL_DISABLE 1 267 268 #define PTHREAD_BARRIER_SERIAL_THREAD 1234567 269 270 /* 271 * POSIX 1003.1-2001, section 2.5.9.3: "The symbolic constant 272 * PTHREAD_CANCELED expands to a constant expression of type (void *) 273 * whose value matches no pointer to an object in memory nor the value 274 * NULL." 275 */ 276 #define PTHREAD_CANCELED ((void *) 1) 277 278 /* 279 * Maximum length of a thread's name, including the terminating NUL. 280 */ 281 #define PTHREAD_MAX_NAMELEN_NP 32 282 283 /* 284 * Mutex attributes. 285 */ 286 #define PTHREAD_MUTEX_NORMAL 0 287 #define PTHREAD_MUTEX_ERRORCHECK 1 288 #define PTHREAD_MUTEX_RECURSIVE 2 289 #define PTHREAD_MUTEX_DEFAULT PTHREAD_MUTEX_NORMAL 290 291 #define PTHREAD_PRIO_NONE 0 292 #define PTHREAD_PRIO_INHERIT 1 293 #define PTHREAD_PRIO_PROTECT 2 294 295 #define PTHREAD_COND_INITIALIZER _PTHREAD_COND_INITIALIZER 296 #define PTHREAD_MUTEX_INITIALIZER _PTHREAD_MUTEX_INITIALIZER 297 #define PTHREAD_ONCE_INIT _PTHREAD_ONCE_INIT 298 #define PTHREAD_RWLOCK_INITIALIZER _PTHREAD_RWLOCK_INITIALIZER 299 #define PTHREAD_SPINLOCK_INITIALIZER _PTHREAD_SPINLOCK_INITIALIZER 300 301 /* 302 * Use macros to rename many pthread functions to the corresponding 303 * libc symbols which are either trivial/no-op stubs or the real 304 * thing, depending on whether libpthread is linked in to the 305 * program. This permits code, particularly libraries that do not 306 * directly use threads but want to be thread-safe in the presence of 307 * threaded callers, to use pthread mutexes and the like without 308 * unnecessarily including libpthread in their linkage. 309 * 310 * A common mistake is to include pthread.h but not link against 311 * libpthread in applications that create threads. Since threading 312 * adds substantial overhead to basic libc functionality like stdio, we 313 * don't want to make libpthread default, but we do want to catch this 314 * mistake. We catch it by not defining pthread_create in libc or 315 * renaming it to a stub that is defined in libc by default. 316 * 317 * However, some libraries (like openssl libcrypto) will _optionally_ 318 * create threads in threaded applications. These libraries can 319 * request the stub by defining _PTHREAD_CREATE_WEAK, so they can be 320 * used by threaded applications -- which need to link against 321 * libpthread themselves to avoid runtime errors -- and non-threaded 322 * applications which don't link against libpthread at all. 323 * 324 * The rename is done as: 325 * #define pthread_foo __libc_foo 326 * instead of 327 * #define pthread_foo(x) __libc_foo((x)) 328 * in order that taking the address of the function ("func = 329 * &pthread_foo;") continue to work. 330 * 331 * POSIX/SUSv3 requires that its functions exist as functions (even if 332 * macro versions exist) and specifically that "#undef pthread_foo" is 333 * legal and should not break anything. Code that does such will not 334 * successfully get the stub behavior implemented here and will 335 * require libpthread to be linked in. 336 */ 337 338 #ifndef __LIBPTHREAD_SOURCE__ 339 __BEGIN_DECLS 340 int __libc_thr_create(pthread_t * __restrict, 341 const pthread_attr_t * __restrict, void *(*)(void *), 342 void * __restrict); 343 int __libc_thr_detach(pthread_t); 344 int __libc_thr_join(pthread_t, void **); 345 346 int __libc_thr_attr_init(pthread_attr_t *); 347 int __libc_thr_attr_setdetachstate(pthread_attr_t *, int); 348 int __libc_thr_attr_destroy(pthread_attr_t *); 349 __END_DECLS 350 351 /* 352 * If _NETBSD_PTHREAD_CREATE_WEAK is defined, make pthread_create 353 * expand to a symbol which is defined as a weak alias by libc, so 354 * libraries can opt into using it for threaded applications without 355 * requiring non-threaded applications to be linked against libpthread. 356 * Otherwise, if you include pthread.h _without_ defining 357 * _NETBSD_PTHREAD_CREATE_WEAK and try to call pthread_create without 358 * linking against libpthread, the linker will detect this as an error. 359 */ 360 #ifdef _NETBSD_PTHREAD_CREATE_WEAK 361 #define pthread_create __libc_thr_create 362 #endif 363 364 #define pthread_detach __libc_thr_detach 365 #define pthread_join __libc_thr_join 366 367 #define pthread_attr_init __libc_thr_attr_init 368 #define pthread_attr_setdetachstate __libc_thr_attr_setdetachstate 369 #define pthread_attr_destroy __libc_thr_attr_destroy 370 371 __BEGIN_DECLS 372 int __libc_mutex_init(pthread_mutex_t * __restrict, const pthread_mutexattr_t * __restrict); 373 int __libc_mutex_lock(pthread_mutex_t *); 374 int __libc_mutex_trylock(pthread_mutex_t *); 375 int __libc_mutex_unlock(pthread_mutex_t *); 376 int __libc_mutex_destroy(pthread_mutex_t *); 377 378 int __libc_mutexattr_init(pthread_mutexattr_t *); 379 int __libc_mutexattr_settype(pthread_mutexattr_t *, int); 380 int __libc_mutexattr_destroy(pthread_mutexattr_t *); 381 __END_DECLS 382 383 #define pthread_mutex_init __libc_mutex_init 384 #define pthread_mutex_lock __libc_mutex_lock 385 #define pthread_mutex_trylock __libc_mutex_trylock 386 #define pthread_mutex_unlock __libc_mutex_unlock 387 #define pthread_mutex_destroy __libc_mutex_destroy 388 389 #define pthread_mutexattr_init __libc_mutexattr_init 390 #define pthread_mutexattr_settype __libc_mutexattr_settype 391 #define pthread_mutexattr_destroy __libc_mutexattr_destroy 392 393 __BEGIN_DECLS 394 int __libc_cond_init(pthread_cond_t * __restrict, 395 const pthread_condattr_t * __restrict); 396 int __libc_cond_signal(pthread_cond_t *); 397 int __libc_cond_broadcast(pthread_cond_t *); 398 int __libc_cond_wait(pthread_cond_t * __restrict, 399 pthread_mutex_t * __restrict); 400 #ifndef __LIBC12_SOURCE__ 401 int __libc_cond_timedwait(pthread_cond_t * __restrict, 402 pthread_mutex_t * __restrict, const struct timespec * __restrict); 403 #endif 404 int __libc_cond_destroy(pthread_cond_t *); 405 __END_DECLS 406 407 #define pthread_cond_init __libc_cond_init 408 #define pthread_cond_signal __libc_cond_signal 409 #define pthread_cond_broadcast __libc_cond_broadcast 410 #define pthread_cond_wait __libc_cond_wait 411 #define pthread_cond_timedwait __libc_cond_timedwait 412 #define pthread_cond_destroy __libc_cond_destroy 413 414 __BEGIN_DECLS 415 int __libc_rwlock_init(pthread_rwlock_t * __restrict, 416 const pthread_rwlockattr_t * __restrict); 417 int __libc_rwlock_rdlock(pthread_rwlock_t *); 418 int __libc_rwlock_wrlock(pthread_rwlock_t *); 419 int __libc_rwlock_tryrdlock(pthread_rwlock_t *); 420 int __libc_rwlock_trywrlock(pthread_rwlock_t *); 421 int __libc_rwlock_unlock(pthread_rwlock_t *); 422 int __libc_rwlock_destroy(pthread_rwlock_t *); 423 __END_DECLS 424 425 #define pthread_rwlock_init __libc_rwlock_init 426 #define pthread_rwlock_rdlock __libc_rwlock_rdlock 427 #define pthread_rwlock_wrlock __libc_rwlock_wrlock 428 #define pthread_rwlock_tryrdlock __libc_rwlock_tryrdlock 429 #define pthread_rwlock_trywrlock __libc_rwlock_trywrlock 430 #define pthread_rwlock_unlock __libc_rwlock_unlock 431 #define pthread_rwlock_destroy __libc_rwlock_destroy 432 433 __BEGIN_DECLS 434 int __libc_thr_keycreate(pthread_key_t *, void (*)(void *)); 435 int __libc_thr_setspecific(pthread_key_t, const void *); 436 void *__libc_thr_getspecific(pthread_key_t); 437 int __libc_thr_keydelete(pthread_key_t); 438 __END_DECLS 439 440 #define pthread_key_create __libc_thr_keycreate 441 #define pthread_setspecific __libc_thr_setspecific 442 #define pthread_getspecific __libc_thr_getspecific 443 #define pthread_key_delete __libc_thr_keydelete 444 445 __BEGIN_DECLS 446 int __libc_thr_once(pthread_once_t *, void (*)(void)); 447 pthread_t __libc_thr_self(void); 448 void __libc_thr_exit(void *) __attribute__((__noreturn__)); 449 int __libc_thr_setcancelstate(int, int *); 450 int __libc_thr_equal(pthread_t, pthread_t); 451 unsigned int __libc_thr_curcpu(void); 452 __END_DECLS 453 454 #define pthread_once __libc_thr_once 455 #define pthread_self __libc_thr_self 456 #define pthread_exit __libc_thr_exit 457 #define pthread_setcancelstate __libc_thr_setcancelstate 458 #define pthread_equal __libc_thr_equal 459 #define pthread_curcpu_np __libc_thr_curcpu 460 461 #endif /* __LIBPTHREAD_SOURCE__ */ 462 463 #endif /* _LIB_PTHREAD_H */ 464
Indexes created Tue May 26 00:24:38 UTC 2026