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