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