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