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 */ 34 #ifndef _PTHREAD_H_ 35 #define _PTHREAD_H_ 36 37 /* 38 * Header files. 39 */ 40 #include <sys/cdefs.h> 41 #include <sys/types.h> 42 #include <sys/time.h> 43 #include <sys/signal.h> 44 #include <limits.h> 45 #include <sched.h> 46 47 /* 48 * Run-time invariant values: 49 */ 50 #define PTHREAD_DESTRUCTOR_ITERATIONS 4 51 #define PTHREAD_KEYS_MAX 256 52 #define PTHREAD_STACK_MIN 1024 53 #define PTHREAD_THREADS_MAX ULONG_MAX 54 55 /* 56 * Compile time symbolic constants for portability specifications: 57 * 58 * Note that those commented out are not currently supported by the 59 * implementation. 60 */ 61 #define _POSIX_THREADS 62 #define _POSIX_THREAD_ATTR_STACKADDR 63 #define _POSIX_THREAD_ATTR_STACKSIZE 64 #define _POSIX_THREAD_PRIORITY_SCHEDULING 65 #define _POSIX_THREAD_PRIO_INHERIT 66 #define _POSIX_THREAD_PRIO_PROTECT 67 /* #define _POSIX_THREAD_PROCESS_SHARED */ 68 #define _POSIX_THREAD_SAFE_FUNCTIONS 69 70 /* 71 * Flags for threads and thread attributes. 72 */ 73 #define PTHREAD_DETACHED 0x1 74 #define PTHREAD_SCOPE_SYSTEM 0x2 75 #define PTHREAD_INHERIT_SCHED 0x4 76 #define PTHREAD_NOFLOAT 0x8 77 78 #define PTHREAD_CREATE_DETACHED PTHREAD_DETACHED 79 #define PTHREAD_CREATE_JOINABLE 0 80 #define PTHREAD_SCOPE_PROCESS 0 81 #define PTHREAD_EXPLICIT_SCHED 0 82 83 /* 84 * Flags for read/write lock attributes 85 */ 86 #define PTHREAD_PROCESS_PRIVATE 0 87 #define PTHREAD_PROCESS_SHARED 1 88 89 /* 90 * Forward structure definitions. 91 * 92 * These are mostly opaque to the user. 93 */ 94 struct pthread; 95 struct pthread_attr; 96 struct pthread_cond; 97 struct pthread_cond_attr; 98 struct pthread_mutex; 99 struct pthread_mutex_attr; 100 struct pthread_once; 101 struct pthread_rwlock; 102 struct pthread_rwlockattr; 103 104 /* 105 * Primitive system data type definitions required by P1003.1c. 106 * 107 * Note that P1003.1c specifies that there are no defined comparison 108 * or assignment operators for the types pthread_attr_t, pthread_cond_t, 109 * pthread_condattr_t, pthread_mutex_t, pthread_mutexattr_t. 110 */ 111 typedef struct pthread *pthread_t; 112 typedef struct pthread_attr *pthread_attr_t; 113 typedef struct pthread_mutex *pthread_mutex_t; 114 typedef struct pthread_mutex_attr *pthread_mutexattr_t; 115 typedef struct pthread_cond *pthread_cond_t; 116 typedef struct pthread_cond_attr *pthread_condattr_t; 117 typedef int pthread_key_t; 118 typedef struct pthread_once pthread_once_t; 119 typedef struct pthread_rwlock *pthread_rwlock_t; 120 typedef struct pthread_rwlockattr *pthread_rwlockattr_t; 121 122 /* 123 * Additional type definitions: 124 * 125 * Note that P1003.1c reserves the prefixes pthread_ and PTHREAD_ for 126 * use in header symbols. 127 */ 128 typedef void *pthread_addr_t; 129 typedef void *(*pthread_startroutine_t) __P((void *)); 130 131 /* 132 * Once definitions. 133 */ 134 struct pthread_once { 135 int state; 136 pthread_mutex_t mutex; 137 }; 138 139 /* 140 * Flags for once initialization. 141 */ 142 #define PTHREAD_NEEDS_INIT 0 143 #define PTHREAD_DONE_INIT 1 144 145 /* 146 * Static once initialization values. 147 */ 148 #define PTHREAD_ONCE_INIT { PTHREAD_NEEDS_INIT, NULL } 149 150 /* 151 * Static initialization values. 152 */ 153 #define PTHREAD_MUTEX_INITIALIZER NULL 154 #define PTHREAD_COND_INITIALIZER NULL 155 #define PTHREAD_RWLOCK_INITIALIZER NULL 156 157 /* 158 * Default attribute arguments (draft 4, deprecated). 159 */ 160 #ifndef PTHREAD_KERNEL 161 #define pthread_condattr_default NULL 162 #define pthread_mutexattr_default NULL 163 #define pthread_attr_default NULL 164 #endif 165 166 #define PTHREAD_PRIO_NONE 0 167 #ifdef _POSIX_THREAD_PRIO_PROTECT 168 #define PTHREAD_PRIO_INHERIT 1 169 #define PTHREAD_PRIO_PROTECT 2 170 #endif 171 172 /* 173 * Mutex types (Single UNIX Specification, Version 2, 1997). 174 * 175 * Note that a mutex attribute with one of the following types: 176 * 177 * PTHREAD_MUTEX_NORMAL 178 * PTHREAD_MUTEX_RECURSIVE 179 * MUTEX_TYPE_FAST (deprecated) 180 * MUTEX_TYPE_COUNTING_FAST (deprecated) 181 * 182 * will deviate from POSIX specified semantics. 183 */ 184 enum pthread_mutextype { 185 PTHREAD_MUTEX_ERRORCHECK = 1, /* Default POSIX mutex */ 186 PTHREAD_MUTEX_RECURSIVE = 2, /* Recursive mutex */ 187 PTHREAD_MUTEX_NORMAL = 3, /* No error checking */ 188 MUTEX_TYPE_MAX 189 }; 190 191 #define PTHREAD_MUTEX_DEFAULT PTHREAD_MUTEX_ERRORCHECK 192 #define MUTEX_TYPE_FAST PTHREAD_MUTEX_NORMAL 193 #define MUTEX_TYPE_COUNTING_FAST PTHREAD_MUTEX_RECURSIVE 194 195 /* 196 * Thread function prototype definitions: 197 */ 198 __BEGIN_DECLS 199 int pthread_attr_destroy __P((pthread_attr_t *)); 200 int pthread_attr_getstacksize __P((pthread_attr_t *, size_t *)); 201 int pthread_attr_getstackaddr __P((pthread_attr_t *, void **)); 202 int pthread_attr_getdetachstate __P((pthread_attr_t *, int *)); 203 int pthread_attr_init __P((pthread_attr_t *)); 204 int pthread_attr_setstacksize __P((pthread_attr_t *, size_t)); 205 int pthread_attr_setstackaddr __P((pthread_attr_t *, void *)); 206 int pthread_attr_setdetachstate __P((pthread_attr_t *, int)); 207 void pthread_cleanup_pop __P((int execute)); 208 void pthread_cleanup_push __P((void (*routine) (void *), 209 void *routine_arg)); 210 int pthread_condattr_destroy __P((pthread_condattr_t *attr)); 211 int pthread_condattr_init __P((pthread_condattr_t *attr)); 212 213 #if defined(_POSIX_THREAD_PROCESS_SHARED) 214 int pthread_condattr_getpshared __P((pthread_condattr_t *attr, 215 int *pshared)); 216 int pthread_condattr_setpshared __P((pthread_condattr_t *attr, 217 int pshared)); 218 #endif 219 220 int pthread_cond_broadcast __P((pthread_cond_t *)); 221 int pthread_cond_destroy __P((pthread_cond_t *)); 222 int pthread_cond_init __P((pthread_cond_t *, 223 const pthread_condattr_t *)); 224 int pthread_cond_signal __P((pthread_cond_t *)); 225 int pthread_cond_timedwait __P((pthread_cond_t *, 226 pthread_mutex_t *, const struct timespec * abstime)); 227 int pthread_cond_wait __P((pthread_cond_t *, pthread_mutex_t *)); 228 int pthread_create __P((pthread_t *, const pthread_attr_t *, 229 void *(*start_routine) (void *), void *)); 230 int pthread_detach __P((pthread_t)); 231 int pthread_equal __P((pthread_t, pthread_t)); 232 void pthread_exit __P((void *)); 233 void *pthread_getspecific __P((pthread_key_t)); 234 int pthread_join __P((pthread_t, void **)); 235 int pthread_key_create __P((pthread_key_t *, 236 void (*routine) (void *))); 237 int pthread_key_delete __P((pthread_key_t)); 238 int pthread_kill __P((struct pthread *, int)); 239 int pthread_mutexattr_init __P((pthread_mutexattr_t *)); 240 int pthread_mutexattr_destroy __P((pthread_mutexattr_t *)); 241 int pthread_mutexattr_settype __P((pthread_mutexattr_t *, int)); 242 int pthread_mutex_destroy __P((pthread_mutex_t *)); 243 int pthread_mutex_init __P((pthread_mutex_t *, 244 const pthread_mutexattr_t *)); 245 int pthread_mutex_lock __P((pthread_mutex_t *)); 246 int pthread_mutex_trylock __P((pthread_mutex_t *)); 247 int pthread_mutex_unlock __P((pthread_mutex_t *)); 248 int pthread_once __P((pthread_once_t *, 249 void (*init_routine) (void))); 250 int pthread_rwlock_destroy __P((pthread_rwlock_t *)); 251 int pthread_rwlock_init __P((pthread_rwlock_t *, 252 const pthread_rwlockattr_t *)); 253 int pthread_rwlock_rdlock __P((pthread_rwlock_t *)); 254 int pthread_rwlock_tryrdlock __P((pthread_rwlock_t *)); 255 int pthread_rwlock_trywrlock __P((pthread_rwlock_t *)); 256 int pthread_rwlock_unlock __P((pthread_rwlock_t *)); 257 int pthread_rwlock_wrlock __P((pthread_rwlock_t *)); 258 int pthread_rwlockattr_init __P((pthread_rwlockattr_t *)); 259 int pthread_rwlockattr_getpshared __P((const pthread_rwlockattr_t *, 260 int *)); 261 int pthread_rwlockattr_setpshared __P((pthread_rwlockattr_t *, 262 int *)); 263 int pthread_rwlockattr_destroy __P((pthread_rwlockattr_t *)); 264 pthread_t pthread_self __P((void)); 265 int pthread_setcancelstate __P((int, int *)); 266 int pthread_setcanceltype __P((int, int *)); 267 int pthread_setspecific __P((pthread_key_t, const void *)); 268 int pthread_sigmask __P((int, const sigset_t *, sigset_t *)); 269 int pthread_testcancel __P((void)); 270 271 272 int pthread_getprio __P((pthread_t)); 273 int pthread_setprio __P((pthread_t, int)); 274 void pthread_yield __P((void)); 275 276 #if defined(_POSIX_THREAD_PROCESS_SHARED) 277 int pthread_mutexattr_getpshared __P((pthread_mutexattr_t *, 278 int *pshared)); 279 int pthread_mutexattr_setpshared __P((pthread_mutexattr_t *, 280 int pshared)); 281 #endif 282 283 #if defined(_POSIX_THREAD_PRIO_PROTECT) 284 int pthread_mutexattr_getprioceiling __P((pthread_mutexattr_t *, 285 int *prioceiling)); 286 int pthread_mutexattr_setprioceiling __P((pthread_mutexattr_t *, 287 int prioceiling)); 288 int pthread_mutex_getprioceiling __P((pthread_mutex_t *, int *)); 289 int pthread_mutex_setprioceiling __P((pthread_mutex_t *, int, int *)); 290 #endif 291 292 #if defined(_POSIX_THREAD_PRIO_PROTECT) || defined (_POSIX_THREAD_PRIO_INHERIT) 293 int pthread_mutexattr_getprotocol __P((pthread_mutexattr_t *, 294 int *protocol)); 295 int pthread_mutexattr_setprotocol __P((pthread_mutexattr_t *, 296 int protocol)); 297 #endif 298 299 #if defined(_POSIX_THREAD_PRIORITY_SCHEDULING) 300 int pthread_attr_getinheritsched __P((pthread_attr_t *, int *)); 301 int pthread_attr_getschedparam __P((pthread_attr_t *, 302 struct sched_param *)); 303 int pthread_attr_getschedpolicy __P((pthread_attr_t *, int *)); 304 int pthread_attr_getscope __P((pthread_attr_t *, int *)); 305 int pthread_attr_setinheritsched __P((pthread_attr_t *, int)); 306 int pthread_attr_setschedparam __P((pthread_attr_t *, 307 struct sched_param *)); 308 int pthread_attr_setschedpolicy __P((pthread_attr_t *, int)); 309 int pthread_attr_setscope __P((pthread_attr_t *, int)); 310 int pthread_getschedparam __P((pthread_t pthread, int *policy, 311 struct sched_param * param)); 312 int pthread_setschedparam __P((pthread_t pthread, int policy, 313 struct sched_param * param)); 314 #endif 315 316 int pthread_attr_setfloatstate __P((pthread_attr_t *, int)); 317 int pthread_attr_getfloatstate __P((pthread_attr_t *, int *)); 318 int pthread_attr_setcleanup __P((pthread_attr_t *, 319 void (*routine) (void *), void *)); 320 __END_DECLS 321 322 #endif 323