1 /* 2 * Copyright (c) 1993, 1994 by Chris Provenzano, proven@mit.edu 3 * Copyright (c) 1995-1998 by John Birrell <jb@cimlogic.com.au> 4 * All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 3. All advertising materials mentioning features or use of this software 15 * must display the following acknowledgement: 16 * This product includes software developed by Chris Provenzano. 17 * 4. The name of Chris Provenzano may not be used to endorse or promote 18 * products derived from this software without specific prior written 19 * permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY CHRIS PROVENZANO ``AS IS'' AND 22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24 * ARE DISCLAIMED. IN NO EVENT SHALL CHRIS PROVENZANO BE LIABLE FOR ANY 25 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 26 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 27 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 28 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * $FreeBSD: src/include/pthread.h,v 1.20.2.4 2003/05/27 18:18:01 jdp Exp $ 34 * $DragonFly: src/include/pthread.h,v 1.10 2007/06/26 23:30:05 josepht Exp $ 35 */ 36 #ifndef _PTHREAD_H_ 37 #define _PTHREAD_H_ 38 39 /* 40 * Header files. 41 */ 42 #include <sys/cdefs.h> 43 #include <sys/types.h> 44 #include <sys/time.h> 45 #include <sys/signal.h> 46 #include <limits.h> 47 #include <sys/sched.h> 48 49 /* 50 * Run-time invariant values: 51 */ 52 #define PTHREAD_DESTRUCTOR_ITERATIONS 4 53 #define PTHREAD_KEYS_MAX 256 54 #define PTHREAD_STACK_MIN 1024 55 #define PTHREAD_THREADS_MAX ULONG_MAX 56 #define PTHREAD_BARRIER_SERIAL_THREAD -1 57 58 /* 59 * Flags for threads and thread attributes. 60 */ 61 #define PTHREAD_DETACHED 0x1 62 #define PTHREAD_SCOPE_SYSTEM 0x2 63 #define PTHREAD_INHERIT_SCHED 0x4 64 #define PTHREAD_NOFLOAT 0x8 65 66 #define PTHREAD_CREATE_DETACHED PTHREAD_DETACHED 67 #define PTHREAD_CREATE_JOINABLE 0 68 #define PTHREAD_SCOPE_PROCESS 0 69 #define PTHREAD_EXPLICIT_SCHED 0 70 71 /* 72 * Flags for read/write lock attributes 73 */ 74 #define PTHREAD_PROCESS_PRIVATE 0 75 #define PTHREAD_PROCESS_SHARED 1 76 77 /* 78 * Flags for cancelling threads 79 */ 80 #define PTHREAD_CANCEL_ENABLE 0 81 #define PTHREAD_CANCEL_DISABLE 1 82 #define PTHREAD_CANCEL_DEFERRED 0 83 #define PTHREAD_CANCEL_ASYNCHRONOUS 2 84 #define PTHREAD_CANCELED ((void *) 1) 85 86 /* 87 * Flags for once initialization. 88 */ 89 #define PTHREAD_NEEDS_INIT 0 90 #define PTHREAD_DONE_INIT 1 91 92 /* 93 * Static once initialization values. 94 */ 95 #define PTHREAD_ONCE_INIT { PTHREAD_NEEDS_INIT, NULL } 96 97 /* 98 * Static initialization values. 99 */ 100 #define PTHREAD_MUTEX_INITIALIZER NULL 101 #define PTHREAD_COND_INITIALIZER NULL 102 #define PTHREAD_RWLOCK_INITIALIZER NULL 103 104 /* 105 * Default attribute arguments (draft 4, deprecated). 106 */ 107 #ifndef PTHREAD_KERNEL 108 #define pthread_condattr_default NULL 109 #define pthread_mutexattr_default NULL 110 #define pthread_attr_default NULL 111 #endif 112 113 #define PTHREAD_PRIO_NONE 0 114 #define PTHREAD_PRIO_INHERIT 1 115 #define PTHREAD_PRIO_PROTECT 2 116 117 /* 118 * Mutex types (Single UNIX Specification, Version 2, 1997). 119 * 120 * Note that a mutex attribute with one of the following types: 121 * 122 * PTHREAD_MUTEX_NORMAL 123 * PTHREAD_MUTEX_RECURSIVE 124 * MUTEX_TYPE_FAST (deprecated) 125 * MUTEX_TYPE_COUNTING_FAST (deprecated) 126 * 127 * will deviate from POSIX specified semantics. 128 */ 129 enum pthread_mutextype { 130 PTHREAD_MUTEX_ERRORCHECK = 1, /* Default POSIX mutex */ 131 PTHREAD_MUTEX_RECURSIVE = 2, /* Recursive mutex */ 132 PTHREAD_MUTEX_NORMAL = 3, /* No error checking */ 133 MUTEX_TYPE_MAX 134 }; 135 136 #define PTHREAD_MUTEX_DEFAULT PTHREAD_MUTEX_ERRORCHECK 137 #define MUTEX_TYPE_FAST PTHREAD_MUTEX_NORMAL 138 #define MUTEX_TYPE_COUNTING_FAST PTHREAD_MUTEX_RECURSIVE 139 140 /* 141 * Thread function prototype definitions: 142 */ 143 __BEGIN_DECLS 144 int pthread_atfork(void (*)(void), void (*)(void), void (*)(void)); 145 int pthread_attr_destroy(pthread_attr_t *); 146 int pthread_attr_getguardsize(const pthread_attr_t * __restrict, 147 size_t *); 148 int pthread_attr_getstack(const pthread_attr_t * __restrict, 149 void ** __restrict, size_t * __restrict); 150 int pthread_attr_getstacksize(const pthread_attr_t *, size_t *); 151 int pthread_attr_getstackaddr(const pthread_attr_t *, void **); 152 int pthread_attr_getdetachstate(const pthread_attr_t *, int *); 153 int pthread_attr_init(pthread_attr_t *); 154 int pthread_attr_setguardsize(pthread_attr_t *, size_t); 155 int pthread_attr_setstack(pthread_attr_t *, void *, size_t); 156 int pthread_attr_setstacksize(pthread_attr_t *, size_t); 157 int pthread_attr_setstackaddr(pthread_attr_t *, void *); 158 int pthread_attr_setdetachstate(pthread_attr_t *, int); 159 int pthread_barrier_destroy(pthread_barrier_t *); 160 int pthread_barrier_init(pthread_barrier_t *, 161 const pthread_barrierattr_t *, unsigned); 162 int pthread_barrier_wait(pthread_barrier_t *); 163 int pthread_barrierattr_destroy(pthread_barrierattr_t *); 164 int pthread_barrierattr_init(pthread_barrierattr_t *); 165 #if defined(_POSIX_THREAD_PROCESS_SHARED) 166 int pthread_barrierattr_getpshared(const pthread_barrierattr_t *, 167 int *); 168 int pthread_barrierattr_setpshared(pthread_barrierattr_t *, int); 169 #endif 170 void pthread_cleanup_pop(int); 171 void pthread_cleanup_push(void (*) (void *), void *); 172 int pthread_condattr_destroy(pthread_condattr_t *); 173 int pthread_condattr_init(pthread_condattr_t *); 174 175 #if defined(_POSIX_THREAD_PROCESS_SHARED) 176 int pthread_condattr_getpshared(pthread_condattr_t *, int *); 177 int pthread_condattr_setpshared(pthread_condattr_t *, int); 178 #endif 179 180 int pthread_condattr_getclock(const pthread_condattr_t *, clockid_t *); 181 int pthread_condattr_setclock(pthread_condattr_t *, clockid_t); 182 183 int pthread_cond_broadcast(pthread_cond_t *); 184 int pthread_cond_destroy(pthread_cond_t *); 185 int pthread_cond_init(pthread_cond_t *, 186 const pthread_condattr_t *); 187 int pthread_cond_signal(pthread_cond_t *); 188 int pthread_cond_timedwait(pthread_cond_t *, pthread_mutex_t *, 189 const struct timespec *); 190 int pthread_cond_wait(pthread_cond_t *, pthread_mutex_t *); 191 int pthread_create(pthread_t *, const pthread_attr_t *, 192 void *(*) (void *), void *); 193 int pthread_detach(pthread_t); 194 int pthread_equal(pthread_t, pthread_t); 195 void pthread_exit(void *) __dead2; 196 void *pthread_getspecific(pthread_key_t); 197 int pthread_join(pthread_t, void **); 198 int pthread_key_create(pthread_key_t *, void (*) (void *)); 199 int pthread_key_delete(pthread_key_t); 200 int pthread_kill(pthread_t, int); 201 int pthread_mutexattr_init(pthread_mutexattr_t *); 202 int pthread_mutexattr_destroy(pthread_mutexattr_t *); 203 int pthread_mutexattr_gettype(pthread_mutexattr_t *, int *); 204 int pthread_mutexattr_settype(pthread_mutexattr_t *, int); 205 int pthread_mutex_destroy(pthread_mutex_t *); 206 int pthread_mutex_init(pthread_mutex_t *, 207 const pthread_mutexattr_t *); 208 int pthread_mutex_lock(pthread_mutex_t *); 209 int pthread_mutex_timedlock(pthread_mutex_t *, 210 const struct timespec *); 211 int pthread_mutex_trylock(pthread_mutex_t *); 212 int pthread_mutex_unlock(pthread_mutex_t *); 213 int pthread_once(pthread_once_t *, void (*) (void)); 214 int pthread_rwlock_destroy(pthread_rwlock_t *); 215 int pthread_rwlock_init(pthread_rwlock_t *, 216 const pthread_rwlockattr_t *); 217 int pthread_rwlock_rdlock(pthread_rwlock_t *); 218 int pthread_rwlock_timedrdlock(pthread_rwlock_t *, 219 const struct timespec *); 220 int pthread_rwlock_tryrdlock(pthread_rwlock_t *); 221 int pthread_rwlock_trywrlock(pthread_rwlock_t *); 222 int pthread_rwlock_unlock(pthread_rwlock_t *); 223 int pthread_rwlock_wrlock(pthread_rwlock_t *); 224 int pthread_rwlock_timedwrlock(pthread_rwlock_t *, 225 const struct timespec *); 226 int pthread_rwlockattr_init(pthread_rwlockattr_t *); 227 int pthread_rwlockattr_getpshared(const pthread_rwlockattr_t *, 228 int *); 229 int pthread_rwlockattr_setpshared(pthread_rwlockattr_t *, int); 230 int pthread_rwlockattr_destroy(pthread_rwlockattr_t *); 231 pthread_t pthread_self(void); 232 int pthread_setspecific(pthread_key_t, const void *); 233 int pthread_sigmask(int, const sigset_t *, sigset_t *); 234 235 int pthread_spin_destroy(pthread_spinlock_t *); 236 int pthread_spin_init(pthread_spinlock_t *, int); 237 int pthread_spin_lock(pthread_spinlock_t *); 238 int pthread_spin_trylock(pthread_spinlock_t *); 239 int pthread_spin_unlock(pthread_spinlock_t *); 240 241 int pthread_cancel(pthread_t); 242 int pthread_setcancelstate(int, int *); 243 int pthread_setcanceltype(int, int *); 244 void pthread_testcancel(void); 245 246 int pthread_getprio(pthread_t); 247 int pthread_setprio(pthread_t, int); 248 void pthread_yield(void); 249 250 #if defined(_POSIX_THREAD_PROCESS_SHARED) 251 int pthread_mutexattr_getpshared(pthread_mutexattr_t *, int *); 252 int pthread_mutexattr_setpshared(pthread_mutexattr_t *, int); 253 #endif 254 255 int pthread_mutexattr_getprioceiling(pthread_mutexattr_t *, int *); 256 int pthread_mutexattr_setprioceiling(pthread_mutexattr_t *, int); 257 int pthread_mutex_getprioceiling(pthread_mutex_t *, int *); 258 int pthread_mutex_setprioceiling(pthread_mutex_t *, int, int *); 259 260 int pthread_mutexattr_getprotocol(pthread_mutexattr_t *, int *); 261 int pthread_mutexattr_setprotocol(pthread_mutexattr_t *, int); 262 263 int pthread_attr_getinheritsched(const pthread_attr_t *, int *); 264 int pthread_attr_getschedparam(const pthread_attr_t *, 265 struct sched_param *); 266 int pthread_attr_getschedpolicy(const pthread_attr_t *, int *); 267 int pthread_attr_getscope(const pthread_attr_t *, int *); 268 int pthread_attr_setinheritsched(pthread_attr_t *, int); 269 int pthread_attr_setschedparam(pthread_attr_t *, 270 const struct sched_param *); 271 int pthread_attr_setschedpolicy(pthread_attr_t *, int); 272 int pthread_attr_setscope(pthread_attr_t *, int); 273 int pthread_getschedparam(pthread_t pthread, int *, 274 struct sched_param *); 275 int pthread_setschedparam(pthread_t, int, 276 const struct sched_param *); 277 int pthread_getconcurrency(void); 278 int pthread_setconcurrency(int); 279 280 int pthread_attr_setfloatstate(pthread_attr_t *, int); 281 int pthread_attr_getfloatstate(pthread_attr_t *, int *); 282 __END_DECLS 283 284 #endif 285