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