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