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