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