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