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 */ 35 #ifndef _PTHREAD_H_ 36 #define _PTHREAD_H_ 37 38 /* 39 * Header files. 40 */ 41 #include <sys/cdefs.h> 42 #include <sys/_pthreadtypes.h> 43 #include <sys/time.h> 44 #include <machine/limits.h> 45 #include <sys/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 16384 53 #define PTHREAD_THREADS_MAX ULONG_MAX 54 #define PTHREAD_BARRIER_SERIAL_THREAD -1 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 * Values for process shared/private 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 * Flags for once initialization. 86 */ 87 #define PTHREAD_NEEDS_INIT 0 88 #define PTHREAD_DONE_INIT 1 89 90 /* 91 * Static once initialization values. 92 */ 93 #define PTHREAD_ONCE_INIT { PTHREAD_NEEDS_INIT, NULL } 94 95 /* 96 * Static initialization values. 97 */ 98 #define PTHREAD_MUTEX_INITIALIZER NULL 99 #define PTHREAD_COND_INITIALIZER NULL 100 #define PTHREAD_RWLOCK_INITIALIZER NULL 101 102 /* 103 * Default attribute arguments (draft 4, deprecated). 104 */ 105 #ifndef PTHREAD_KERNEL 106 #define pthread_condattr_default NULL 107 #define pthread_mutexattr_default NULL 108 #define pthread_attr_default NULL 109 #endif 110 111 #define PTHREAD_PRIO_NONE 0 112 #define PTHREAD_PRIO_INHERIT 1 113 #define PTHREAD_PRIO_PROTECT 2 114 115 /* 116 * Mutex types (Single UNIX Specification, Version 2, 1997). 117 * 118 * Note that a mutex attribute with one of the following types: 119 * 120 * PTHREAD_MUTEX_NORMAL 121 * PTHREAD_MUTEX_RECURSIVE 122 * 123 * will deviate from POSIX specified semantics. 124 */ 125 enum pthread_mutextype { 126 PTHREAD_MUTEX_ERRORCHECK = 1, /* Default POSIX mutex */ 127 PTHREAD_MUTEX_RECURSIVE = 2, /* Recursive mutex */ 128 PTHREAD_MUTEX_NORMAL = 3, /* No error checking */ 129 PTHREAD_MUTEX_TYPE_MAX 130 }; 131 132 #define PTHREAD_MUTEX_DEFAULT PTHREAD_MUTEX_ERRORCHECK 133 134 /* 135 * Thread function prototype definitions: 136 */ 137 __BEGIN_DECLS 138 int pthread_atfork(void (*)(void), void (*)(void), void (*)(void)); 139 int pthread_attr_destroy(pthread_attr_t *); 140 int pthread_attr_getguardsize(const pthread_attr_t * __restrict, 141 size_t * __restrict); 142 int pthread_attr_getstack(const pthread_attr_t * __restrict, 143 void ** __restrict, size_t * __restrict); 144 int pthread_attr_getstacksize(const pthread_attr_t * __restrict, 145 size_t * __restrict); 146 #if __BSD_VISIBLE || (__POSIX_VISIBLE && __POSIX_VISIBLE < 200809) 147 int pthread_attr_getstackaddr(const pthread_attr_t *, void **); 148 #endif 149 int pthread_attr_getdetachstate(const pthread_attr_t *, int *); 150 int pthread_attr_init(pthread_attr_t *) __nonnull(1); 151 int pthread_attr_setguardsize(pthread_attr_t *, size_t); 152 #if __BSD_VISIBLE || (__POSIX_VISIBLE && __POSIX_VISIBLE < 200809) 153 int pthread_attr_setstackaddr(pthread_attr_t *, void *); 154 #endif 155 int pthread_attr_setstacksize(pthread_attr_t *, size_t); 156 int pthread_attr_setstack(pthread_attr_t *, void *, size_t); 157 int pthread_attr_setdetachstate(pthread_attr_t *, int); 158 159 int pthread_barrier_destroy(pthread_barrier_t *); 160 int pthread_barrier_init(pthread_barrier_t * __restrict, 161 const pthread_barrierattr_t * __restrict, unsigned); 162 int pthread_barrier_wait(pthread_barrier_t *); 163 int pthread_barrierattr_destroy(pthread_barrierattr_t *); 164 int pthread_barrierattr_getpshared(const pthread_barrierattr_t * __restrict, 165 int * __restrict); 166 int pthread_barrierattr_init(pthread_barrierattr_t *); 167 int pthread_barrierattr_setpshared(pthread_barrierattr_t *, int); 168 169 void pthread_cleanup_pop(int); 170 void pthread_cleanup_push(void (*) (void *), void *); 171 172 int pthread_condattr_destroy(pthread_condattr_t *); 173 int pthread_condattr_getclock(const pthread_condattr_t * __restrict, 174 clockid_t * __restrict) __nonnull(2); 175 int pthread_condattr_getpshared(const pthread_condattr_t * __restrict, 176 int * __restrict) __nonnull(2); 177 int pthread_condattr_init(pthread_condattr_t *) __nonnull(1); 178 int pthread_condattr_setclock(pthread_condattr_t *, clockid_t); 179 int pthread_condattr_setpshared(pthread_condattr_t *, int); 180 181 int pthread_cond_broadcast(pthread_cond_t *) __nonnull(1); 182 int pthread_cond_destroy(pthread_cond_t *); 183 int pthread_cond_init(pthread_cond_t * __restrict, 184 const pthread_condattr_t * __restrict) __nonnull(1); 185 int pthread_cond_signal(pthread_cond_t *) __nonnull(1); 186 int pthread_cond_timedwait(pthread_cond_t * __restrict, 187 pthread_mutex_t * __restrict, const struct timespec * __restrict) 188 __nonnull(2); 189 int pthread_cond_wait(pthread_cond_t * __restrict, 190 pthread_mutex_t * __restrict) __nonnull(1, 2); 191 192 int pthread_create(pthread_t * __restrict, 193 const pthread_attr_t * __restrict, void *(*) (void *), 194 void * __restrict) __nonnull(1, 3); 195 int pthread_detach(pthread_t); 196 int pthread_equal(pthread_t, pthread_t); 197 void pthread_exit(void *) __dead2; 198 void *pthread_getspecific(pthread_key_t); 199 int pthread_getcpuclockid(pthread_t, clockid_t *) __nonnull(2); 200 int pthread_join(pthread_t, void **); 201 int pthread_key_create(pthread_key_t *, void (*) (void *)) __nonnull(1); 202 int pthread_key_delete(pthread_key_t); 203 204 int pthread_mutexattr_init(pthread_mutexattr_t *) __nonnull(1); 205 int pthread_mutexattr_destroy(pthread_mutexattr_t *); 206 int pthread_mutexattr_getpshared(const pthread_mutexattr_t * __restrict, 207 int * __restrict) __nonnull(2); 208 int pthread_mutexattr_gettype(const pthread_mutexattr_t * __restrict, 209 int * __restrict) __nonnull(2); 210 int pthread_mutexattr_setpshared(pthread_mutexattr_t *, int); 211 int pthread_mutexattr_settype(pthread_mutexattr_t *, int); 212 int pthread_mutex_destroy(pthread_mutex_t *); 213 int pthread_mutex_init(pthread_mutex_t * __restrict, 214 const pthread_mutexattr_t * __restrict) __nonnull(1); 215 int pthread_mutex_lock(pthread_mutex_t *); 216 int pthread_mutex_timedlock(pthread_mutex_t * __restrict, 217 const struct timespec * __restrict); 218 int pthread_mutex_trylock(pthread_mutex_t *) __nonnull(1); 219 int pthread_mutex_unlock(pthread_mutex_t *); 220 221 int pthread_once(pthread_once_t *, void (*) (void)) __nonnull(1); 222 223 int pthread_rwlock_destroy(pthread_rwlock_t *); 224 int pthread_rwlock_init(pthread_rwlock_t * __restrict, 225 const pthread_rwlockattr_t * __restrict) __nonnull(1); 226 int pthread_rwlock_rdlock(pthread_rwlock_t *) __nonnull(1); 227 int pthread_rwlock_timedrdlock(pthread_rwlock_t * __restrict, 228 const struct timespec * __restrict) __nonnull(1, 2); 229 int pthread_rwlock_timedwrlock(pthread_rwlock_t * __restrict, 230 const struct timespec * __restrict) __nonnull(1, 2); 231 int pthread_rwlock_tryrdlock(pthread_rwlock_t *); 232 int pthread_rwlock_trywrlock(pthread_rwlock_t *); 233 int pthread_rwlock_unlock(pthread_rwlock_t *); 234 int pthread_rwlock_wrlock(pthread_rwlock_t *) __nonnull(1); 235 236 int pthread_rwlockattr_destroy(pthread_rwlockattr_t *); 237 int pthread_rwlockattr_getpshared(const pthread_rwlockattr_t * __restrict, 238 int * __restrict) __nonnull(1, 2); 239 int pthread_rwlockattr_init(pthread_rwlockattr_t *); 240 int pthread_rwlockattr_setpshared(pthread_rwlockattr_t *, int) __nonnull(1); 241 242 pthread_t pthread_self(void); 243 int pthread_setspecific(pthread_key_t, const void *); 244 245 int pthread_spin_destroy(pthread_spinlock_t *); 246 int pthread_spin_init(pthread_spinlock_t *, int); 247 int pthread_spin_lock(pthread_spinlock_t *); 248 int pthread_spin_trylock(pthread_spinlock_t *); 249 int pthread_spin_unlock(pthread_spinlock_t *); 250 251 int pthread_cancel(pthread_t); 252 int pthread_setcancelstate(int, int *); 253 int pthread_setcanceltype(int, int *); 254 void pthread_testcancel(void); 255 256 #if __BSD_VISIBLE 257 int pthread_getprio(pthread_t); 258 int pthread_setprio(pthread_t, int); 259 void pthread_yield(void); 260 #endif 261 262 int pthread_mutexattr_getprioceiling(const pthread_mutexattr_t * __restrict, 263 int * __restrict); 264 int pthread_mutexattr_setprioceiling(pthread_mutexattr_t *, int); 265 266 int pthread_mutexattr_getprotocol(const pthread_mutexattr_t * __restrict, 267 int * __restrict); 268 int pthread_mutexattr_setprotocol(pthread_mutexattr_t *, int); 269 270 int pthread_mutex_getprioceiling(const pthread_mutex_t * __restrict, 271 int * __restrict); 272 int pthread_mutex_setprioceiling(pthread_mutex_t * __restrict, int, 273 int * __restrict); 274 275 int pthread_attr_getinheritsched(const pthread_attr_t * __restrict, 276 int * __restrict); 277 int pthread_attr_getschedparam(const pthread_attr_t * __restrict, 278 struct sched_param * __restrict); 279 int pthread_attr_getschedpolicy(const pthread_attr_t * __restrict, 280 int * __restrict); 281 int pthread_attr_getscope(const pthread_attr_t * __restrict, 282 int * __restrict); 283 int pthread_attr_setinheritsched(pthread_attr_t *, int); 284 int pthread_attr_setschedparam(pthread_attr_t * __restrict, 285 const struct sched_param * __restrict); 286 int pthread_attr_setschedpolicy(pthread_attr_t *, int); 287 int pthread_attr_setscope(pthread_attr_t *, int); 288 int pthread_getschedparam(pthread_t, int * __restrict, 289 struct sched_param * __restrict); 290 int pthread_setschedparam(pthread_t, int, const struct sched_param *) 291 __nonnull(3); 292 #if __XSI_VISIBLE 293 int pthread_getconcurrency(void); 294 int pthread_setconcurrency(int); 295 #endif 296 __END_DECLS 297 298 #if 0 /* XXX missing */ 299 int pthread_mutex_consistent(pthread_mutex_t *); 300 int pthread_mutexattr_getrobust(const pthread_mutexattr_t * __restrict, 301 int * __restrict); 302 int pthread_mutexattr_setrobust(pthread_mutexattr_t *, int); 303 int pthread_setschedprio(pthread_t, int); 304 #endif 305 306 /* 307 * Provide pthread_*_np() prototypes for compatibility with other pthread 308 * implementations to help with porting efforts. 309 */ 310 #if __BSD_VISIBLE 311 #include <pthread_np.h> 312 #endif 313 314 #endif /* !_PTHREAD_H_ */ 315