pthread.h revision 1.37.2.1
1 /* $NetBSD: pthread.h,v 1.37.2.1 2016/11/04 14:48:54 pgoyette 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 int pthread_atfork(void (*)(void), void (*)(void), void (*)(void)); 45 int pthread_create(pthread_t * __restrict, 46 const pthread_attr_t * __restrict, void *(*)(void *), 47 void * __restrict); 48 void pthread_exit(void *) __attribute__((__noreturn__)); 49 int pthread_join(pthread_t, void **); 50 int pthread_equal(pthread_t, pthread_t); 51 pthread_t pthread_self(void); 52 int pthread_detach(pthread_t); 53 54 int pthread_getrrtimer_np(void); 55 int pthread_setrrtimer_np(int); 56 57 int pthread_attr_init(pthread_attr_t *); 58 int pthread_attr_destroy(pthread_attr_t *); 59 int pthread_attr_get_np(pthread_t, pthread_attr_t *); 60 int pthread_attr_getguardsize(const pthread_attr_t * __restrict, 61 size_t * __restrict); 62 int pthread_attr_setguardsize(pthread_attr_t *, size_t); 63 int pthread_attr_getinheritsched(const pthread_attr_t * __restrict, 64 int * __restrict); 65 int pthread_attr_setinheritsched(pthread_attr_t *, int); 66 int pthread_attr_getschedparam(const pthread_attr_t * __restrict, 67 struct sched_param * __restrict); 68 int pthread_attr_setschedparam(pthread_attr_t * __restrict, 69 const struct sched_param * __restrict); 70 int pthread_attr_getschedpolicy(const pthread_attr_t * __restrict, 71 int * __restrict); 72 int pthread_attr_setschedpolicy(pthread_attr_t *, int); 73 int pthread_attr_getscope(const pthread_attr_t * __restrict, 74 int * __restrict); 75 int pthread_attr_setscope(pthread_attr_t *, int); 76 int pthread_attr_getstack(const pthread_attr_t * __restrict, 77 void ** __restrict, size_t * __restrict); 78 int pthread_attr_setstack(pthread_attr_t *, void *, size_t); 79 int pthread_attr_getstacksize(const pthread_attr_t * __restrict, 80 size_t * __restrict); 81 int pthread_attr_setstacksize(pthread_attr_t *, size_t); 82 int pthread_attr_getstackaddr(const pthread_attr_t * __restrict, 83 void ** __restrict); 84 int pthread_attr_setstackaddr(pthread_attr_t *, void *); 85 int pthread_attr_getdetachstate(const pthread_attr_t *, int *); 86 int pthread_attr_setdetachstate(pthread_attr_t *, int); 87 int pthread_attr_getname_np(const pthread_attr_t *, char *, 88 size_t, void **); 89 int pthread_attr_setname_np(pthread_attr_t *, const char *, void *); 90 91 int pthread_mutex_init(pthread_mutex_t * __restrict, 92 const pthread_mutexattr_t * __restrict); 93 int pthread_mutex_destroy(pthread_mutex_t *); 94 int pthread_mutex_lock(pthread_mutex_t *); 95 int pthread_mutex_trylock(pthread_mutex_t *); 96 int pthread_mutex_unlock(pthread_mutex_t *); 97 int pthread_mutex_timedlock(pthread_mutex_t * __restrict, 98 const struct timespec * __restrict); 99 int pthread_mutex_getprioceiling(const pthread_mutex_t * __restrict, 100 int * __restrict); 101 int pthread_mutex_setprioceiling(pthread_mutex_t * __restrict, int, 102 int * __restrict); 103 int pthread_mutexattr_init(pthread_mutexattr_t *); 104 int pthread_mutexattr_destroy(pthread_mutexattr_t *); 105 #ifdef _PTHREAD_PSHARED 106 int pthread_mutexattr_getpshared(const pthread_mutexattr_t * __restrict, 107 int * __restrict); 108 int pthread_mutexattr_setpshared(pthread_mutexattr_t *, int); 109 #endif 110 int pthread_mutexattr_gettype(const pthread_mutexattr_t * __restrict, 111 int * __restrict); 112 int pthread_mutexattr_settype(pthread_mutexattr_t *attr, int); 113 int pthread_mutexattr_getprotocol(const pthread_mutexattr_t * __restrict, 114 int * __restrict); 115 int pthread_mutexattr_setprotocol(pthread_mutexattr_t*, 116 int); 117 int pthread_mutexattr_getprioceiling(const pthread_mutexattr_t * __restrict, 118 int * __restrict); 119 int pthread_mutexattr_setprioceiling(pthread_mutexattr_t *, 120 int); 121 int pthread_cond_init(pthread_cond_t * __restrict, 122 const pthread_condattr_t * __restrict); 123 int pthread_cond_destroy(pthread_cond_t *); 124 int pthread_cond_wait(pthread_cond_t * __restrict, 125 pthread_mutex_t * __restrict); 126 #ifndef __LIBC12_SOURCE__ 127 int pthread_cond_timedwait(pthread_cond_t * __restrict, 128 pthread_mutex_t * __restrict, const struct timespec * __restrict); 129 #endif 130 int pthread_cond_signal(pthread_cond_t *); 131 int pthread_cond_broadcast(pthread_cond_t *); 132 int pthread_condattr_init(pthread_condattr_t *); 133 #if defined(_NETBSD_SOURCE) 134 int pthread_condattr_setclock(pthread_condattr_t *, clockid_t); 135 int pthread_condattr_getclock(const pthread_condattr_t * __restrict, 136 clockid_t * __restrict); 137 #endif 138 int pthread_condattr_destroy(pthread_condattr_t *); 139 #ifdef _PTHREAD_PSHARED 140 int pthread_condattr_getpshared(const pthread_condattr_t * __restrict, 141 int * __restrict); 142 int pthread_condattr_setpshared(pthread_condattr_t *, int); 143 #endif 144 int pthread_once(pthread_once_t *, void (*)(void)); 145 146 int pthread_key_create(pthread_key_t *, void (*)(void *)); 147 int pthread_key_delete(pthread_key_t); 148 int pthread_setspecific(pthread_key_t, const void *); 149 void* pthread_getspecific(pthread_key_t); 150 151 int pthread_cancel(pthread_t); 152 int pthread_setcancelstate(int, int *); 153 int pthread_setcanceltype(int, int *); 154 void pthread_testcancel(void); 155 156 int pthread_getname_np(pthread_t, char *, size_t); 157 int pthread_setname_np(pthread_t, const char *, void *); 158 159 int pthread_attr_setcreatesuspend_np(pthread_attr_t *); 160 int pthread_suspend_np(pthread_t); 161 int pthread_resume_np(pthread_t); 162 163 unsigned int pthread_curcpu_np(void); 164 165 int pthread_getcpuclockid(pthread_t, clockid_t *); 166 167 struct pthread_cleanup_store { 168 void *pad[4]; 169 }; 170 171 #define pthread_cleanup_push(routine, arg) \ 172 { \ 173 struct pthread_cleanup_store __store; \ 174 pthread__cleanup_push((routine),(arg), &__store); 175 176 #define pthread_cleanup_pop(execute) \ 177 pthread__cleanup_pop((execute), &__store); \ 178 } 179 180 void pthread__cleanup_push(void (*)(void *), void *, void *); 181 void pthread__cleanup_pop(int, void *); 182 183 int pthread_spin_init(pthread_spinlock_t *, int); 184 int pthread_spin_destroy(pthread_spinlock_t *); 185 int pthread_spin_lock(pthread_spinlock_t *); 186 int pthread_spin_trylock(pthread_spinlock_t *); 187 int pthread_spin_unlock(pthread_spinlock_t *); 188 189 int pthread_rwlock_init(pthread_rwlock_t * __restrict, 190 const pthread_rwlockattr_t * __restrict); 191 int pthread_rwlock_destroy(pthread_rwlock_t *); 192 int pthread_rwlock_rdlock(pthread_rwlock_t *); 193 int pthread_rwlock_tryrdlock(pthread_rwlock_t *); 194 int pthread_rwlock_wrlock(pthread_rwlock_t *); 195 int pthread_rwlock_trywrlock(pthread_rwlock_t *); 196 #ifndef __LIBC12_SOURCE__ 197 int pthread_rwlock_timedrdlock(pthread_rwlock_t * __restrict, 198 const struct timespec * __restrict); 199 int pthread_rwlock_timedwrlock(pthread_rwlock_t * __restrict, 200 const struct timespec * __restrict); 201 #endif 202 int pthread_rwlock_unlock(pthread_rwlock_t *); 203 int pthread_rwlockattr_init(pthread_rwlockattr_t *); 204 int pthread_rwlockattr_destroy(pthread_rwlockattr_t *); 205 #ifdef _PTHREAD_PSHARED 206 int pthread_rwlockattr_getpshared(const pthread_rwlockattr_t * __restrict, 207 int * __restrict); 208 int pthread_rwlockattr_setpshared(pthread_rwlockattr_t *, int); 209 #endif 210 int pthread_barrier_init(pthread_barrier_t * __restrict, 211 const pthread_barrierattr_t * __restrict, unsigned int); 212 int pthread_barrier_wait(pthread_barrier_t *); 213 int pthread_barrier_destroy(pthread_barrier_t *); 214 int pthread_barrierattr_init(pthread_barrierattr_t *); 215 int pthread_barrierattr_destroy(pthread_barrierattr_t *); 216 #ifdef _PTHREAD_PSHARED 217 int pthread_barrierattr_getpshared(const pthread_barrierattr_t * __restrict, 218 int * __restrict); 219 int pthread_barrierattr_setpshared(pthread_barrierattr_t *, int); 220 #endif 221 int pthread_getschedparam(pthread_t, int * __restrict, 222 struct sched_param * __restrict); 223 int pthread_setschedparam(pthread_t, int, const struct sched_param *); 224 int pthread_setschedprio(pthread_t, int); 225 226 int *pthread__errno(void); 227 228 #if defined(_NETBSD_SOURCE) 229 int pthread_getaffinity_np(pthread_t, size_t, cpuset_t *); 230 int pthread_setaffinity_np(pthread_t, size_t, cpuset_t *); 231 int pthread_getattr_np(pthread_t, pthread_attr_t *); 232 233 int pthread_mutex_held_np(pthread_mutex_t *); 234 pthread_t pthread_mutex_owner_np(pthread_mutex_t *); 235 236 int pthread_rwlock_held_np(pthread_rwlock_t *); 237 int pthread_rwlock_wrheld_np(pthread_rwlock_t *); 238 int pthread_rwlock_rdheld_np(pthread_rwlock_t *); 239 240 int pthread_cond_has_waiters_np(pthread_cond_t *); 241 #endif /* _NETBSD_SOURCE */ 242 243 __END_DECLS 244 245 #define PTHREAD_CREATE_JOINABLE 0 246 #define PTHREAD_CREATE_DETACHED 1 247 248 #define PTHREAD_INHERIT_SCHED 0 249 #define PTHREAD_EXPLICIT_SCHED 1 250 251 #define PTHREAD_SCOPE_PROCESS 0 252 #define PTHREAD_SCOPE_SYSTEM 1 253 254 #define PTHREAD_PROCESS_PRIVATE 0 255 #define PTHREAD_PROCESS_SHARED 1 256 257 #define PTHREAD_CANCEL_DEFERRED 0 258 #define PTHREAD_CANCEL_ASYNCHRONOUS 1 259 260 #define PTHREAD_CANCEL_ENABLE 0 261 #define PTHREAD_CANCEL_DISABLE 1 262 263 #define PTHREAD_BARRIER_SERIAL_THREAD 1234567 264 265 /* 266 * POSIX 1003.1-2001, section 2.5.9.3: "The symbolic constant 267 * PTHREAD_CANCELED expands to a constant expression of type (void *) 268 * whose value matches no pointer to an object in memory nor the value 269 * NULL." 270 */ 271 #define PTHREAD_CANCELED ((void *) 1) 272 273 /* 274 * Maximum length of a thread's name, including the terminating NUL. 275 */ 276 #define PTHREAD_MAX_NAMELEN_NP 32 277 278 /* 279 * Mutex attributes. 280 */ 281 #define PTHREAD_MUTEX_NORMAL 0 282 #define PTHREAD_MUTEX_ERRORCHECK 1 283 #define PTHREAD_MUTEX_RECURSIVE 2 284 #define PTHREAD_MUTEX_DEFAULT PTHREAD_MUTEX_NORMAL 285 286 #define PTHREAD_PRIO_NONE 0 287 #define PTHREAD_PRIO_INHERIT 1 288 #define PTHREAD_PRIO_PROTECT 2 289 290 #define PTHREAD_COND_INITIALIZER _PTHREAD_COND_INITIALIZER 291 #define PTHREAD_MUTEX_INITIALIZER _PTHREAD_MUTEX_INITIALIZER 292 #define PTHREAD_ONCE_INIT _PTHREAD_ONCE_INIT 293 #define PTHREAD_RWLOCK_INITIALIZER _PTHREAD_RWLOCK_INITIALIZER 294 #define PTHREAD_SPINLOCK_INITIALIZER _PTHREAD_SPINLOCK_INITIALIZER 295 296 /* 297 * Use macros to rename many pthread functions to the corresponding 298 * libc symbols which are either trivial/no-op stubs or the real 299 * thing, depending on whether libpthread is linked in to the 300 * program. This permits code, particularly libraries that do not 301 * directly use threads but want to be thread-safe in the presence of 302 * threaded callers, to use pthread mutexes and the like without 303 * unnecessairly including libpthread in their linkage. 304 * 305 * Left out of this list are functions that can't sensibly be trivial 306 * or no-op stubs in a single-threaded process (pthread_create, 307 * pthread_kill, pthread_detach), functions that normally block and 308 * wait for another thread to do something (pthread_join), and 309 * functions that don't make sense without the previous functions 310 * (pthread_attr_*). The pthread_cond_wait and pthread_cond_timedwait 311 * functions are useful in implementing certain protection mechanisms, 312 * though a non-buggy app shouldn't end up calling them in 313 * single-threaded mode. 314 * 315 * The rename is done as: 316 * #define pthread_foo __libc_foo 317 * instead of 318 * #define pthread_foo(x) __libc_foo((x)) 319 * in order that taking the address of the function ("func = 320 * &pthread_foo;") continue to work. 321 * 322 * POSIX/SUSv3 requires that its functions exist as functions (even if 323 * macro versions exist) and specifically that "#undef pthread_foo" is 324 * legal and should not break anything. Code that does such will not 325 * successfully get the stub behavior implemented here and will 326 * require libpthread to be linked in. 327 */ 328 329 #ifndef __LIBPTHREAD_SOURCE__ 330 __BEGIN_DECLS 331 int __libc_mutex_init(pthread_mutex_t * __restrict, const pthread_mutexattr_t * __restrict); 332 int __libc_mutex_lock(pthread_mutex_t *); 333 int __libc_mutex_trylock(pthread_mutex_t *); 334 int __libc_mutex_unlock(pthread_mutex_t *); 335 int __libc_mutex_destroy(pthread_mutex_t *); 336 337 int __libc_mutexattr_init(pthread_mutexattr_t *); 338 int __libc_mutexattr_settype(pthread_mutexattr_t *, int); 339 int __libc_mutexattr_destroy(pthread_mutexattr_t *); 340 __END_DECLS 341 342 #define pthread_mutex_init __libc_mutex_init 343 #define pthread_mutex_lock __libc_mutex_lock 344 #define pthread_mutex_trylock __libc_mutex_trylock 345 #define pthread_mutex_unlock __libc_mutex_unlock 346 #define pthread_mutex_destroy __libc_mutex_destroy 347 348 #define pthread_mutexattr_init __libc_mutexattr_init 349 #define pthread_mutexattr_settype __libc_mutexattr_settype 350 #define pthread_mutexattr_destroy __libc_mutexattr_destroy 351 352 __BEGIN_DECLS 353 int __libc_cond_init(pthread_cond_t * __restrict, 354 const pthread_condattr_t * __restrict); 355 int __libc_cond_signal(pthread_cond_t *); 356 int __libc_cond_broadcast(pthread_cond_t *); 357 int __libc_cond_wait(pthread_cond_t * __restrict, 358 pthread_mutex_t * __restrict); 359 #ifndef __LIBC12_SOURCE__ 360 int __libc_cond_timedwait(pthread_cond_t * __restrict, 361 pthread_mutex_t * __restrict, const struct timespec * __restrict); 362 #endif 363 int __libc_cond_destroy(pthread_cond_t *); 364 __END_DECLS 365 366 #define pthread_cond_init __libc_cond_init 367 #define pthread_cond_signal __libc_cond_signal 368 #define pthread_cond_broadcast __libc_cond_broadcast 369 #define pthread_cond_wait __libc_cond_wait 370 #define pthread_cond_timedwait __libc_cond_timedwait 371 #define pthread_cond_destroy __libc_cond_destroy 372 373 __BEGIN_DECLS 374 int __libc_rwlock_init(pthread_rwlock_t * __restrict, 375 const pthread_rwlockattr_t * __restrict); 376 int __libc_rwlock_rdlock(pthread_rwlock_t *); 377 int __libc_rwlock_wrlock(pthread_rwlock_t *); 378 int __libc_rwlock_tryrdlock(pthread_rwlock_t *); 379 int __libc_rwlock_trywrlock(pthread_rwlock_t *); 380 int __libc_rwlock_unlock(pthread_rwlock_t *); 381 int __libc_rwlock_destroy(pthread_rwlock_t *); 382 __END_DECLS 383 384 #define pthread_rwlock_init __libc_rwlock_init 385 #define pthread_rwlock_rdlock __libc_rwlock_rdlock 386 #define pthread_rwlock_wrlock __libc_rwlock_wrlock 387 #define pthread_rwlock_tryrdlock __libc_rwlock_tryrdlock 388 #define pthread_rwlock_trywrlock __libc_rwlock_trywrlock 389 #define pthread_rwlock_unlock __libc_rwlock_unlock 390 #define pthread_rwlock_destroy __libc_rwlock_destroy 391 392 __BEGIN_DECLS 393 int __libc_thr_keycreate(pthread_key_t *, void (*)(void *)); 394 int __libc_thr_setspecific(pthread_key_t, const void *); 395 void *__libc_thr_getspecific(pthread_key_t); 396 int __libc_thr_keydelete(pthread_key_t); 397 __END_DECLS 398 399 #define pthread_key_create __libc_thr_keycreate 400 #define pthread_setspecific __libc_thr_setspecific 401 #define pthread_getspecific __libc_thr_getspecific 402 #define pthread_key_delete __libc_thr_keydelete 403 404 __BEGIN_DECLS 405 int __libc_thr_once(pthread_once_t *, void (*)(void)); 406 pthread_t __libc_thr_self(void); 407 void __libc_thr_exit(void *) __attribute__((__noreturn__)); 408 int __libc_thr_setcancelstate(int, int *); 409 int __libc_thr_equal(pthread_t, pthread_t); 410 unsigned int __libc_thr_curcpu(void); 411 __END_DECLS 412 413 #define pthread_once __libc_thr_once 414 #define pthread_self __libc_thr_self 415 #define pthread_exit __libc_thr_exit 416 #define pthread_setcancelstate __libc_thr_setcancelstate 417 #define pthread_equal __libc_thr_equal 418 #define pthread_curcpu_np __libc_thr_curcpu 419 420 #endif /* __LIBPTHREAD_SOURCE__ */ 421 422 #endif /* _LIB_PTHREAD_H */ 423
Indexes created Sun Sep 21 19:09:51 GMT 2025