pthread.h revision 144892
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: head/include/pthread.h 144892 2005-04-11 03:47:42Z davidxu $ 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 MINSIGSTKSZ 54#define PTHREAD_THREADS_MAX ULONG_MAX 55#define PTHREAD_BARRIER_SERIAL_THREAD -1 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 */ 90struct pthread; 91struct pthread_attr; 92struct pthread_cond; 93struct pthread_cond_attr; 94struct pthread_mutex; 95struct pthread_mutex_attr; 96struct pthread_once; 97struct pthread_rwlock; 98struct pthread_rwlockattr; 99struct pthread_barrier; 100struct pthread_barrier_attr; 101struct pthread_spinlock; 102 103/* 104 * Primitive system data type definitions required by P1003.1c. 105 * 106 * Note that P1003.1c specifies that there are no defined comparison 107 * or assignment operators for the types pthread_attr_t, pthread_cond_t, 108 * pthread_condattr_t, pthread_mutex_t, pthread_mutexattr_t. 109 */ 110typedef struct pthread *pthread_t; 111typedef struct pthread_attr *pthread_attr_t; 112typedef struct pthread_mutex *pthread_mutex_t; 113typedef struct pthread_mutex_attr *pthread_mutexattr_t; 114typedef struct pthread_cond *pthread_cond_t; 115typedef struct pthread_cond_attr *pthread_condattr_t; 116typedef int pthread_key_t; 117typedef struct pthread_once pthread_once_t; 118typedef struct pthread_rwlock *pthread_rwlock_t; 119typedef struct pthread_rwlockattr *pthread_rwlockattr_t; 120typedef struct pthread_barrier *pthread_barrier_t; 121typedef struct pthread_barrierattr *pthread_barrierattr_t; 122typedef struct pthread_spinlock *pthread_spinlock_t; 123 124/* 125 * Additional type definitions: 126 * 127 * Note that P1003.1c reserves the prefixes pthread_ and PTHREAD_ for 128 * use in header symbols. 129 */ 130typedef void *pthread_addr_t; 131typedef void *(*pthread_startroutine_t)(void *); 132 133/* 134 * Once definitions. 135 */ 136struct pthread_once { 137 int state; 138 pthread_mutex_t mutex; 139}; 140 141/* 142 * Flags for once initialization. 143 */ 144#define PTHREAD_NEEDS_INIT 0 145#define PTHREAD_DONE_INIT 1 146 147/* 148 * Static once initialization values. 149 */ 150#define PTHREAD_ONCE_INIT { PTHREAD_NEEDS_INIT, NULL } 151 152/* 153 * Static initialization values. 154 */ 155#define PTHREAD_MUTEX_INITIALIZER NULL 156#define PTHREAD_COND_INITIALIZER NULL 157#define PTHREAD_RWLOCK_INITIALIZER NULL 158 159/* 160 * Default attribute arguments (draft 4, deprecated). 161 */ 162#ifndef PTHREAD_KERNEL 163#define pthread_condattr_default NULL 164#define pthread_mutexattr_default NULL 165#define pthread_attr_default NULL 166#endif 167 168#define PTHREAD_PRIO_NONE 0 169#define PTHREAD_PRIO_INHERIT 1 170#define PTHREAD_PRIO_PROTECT 2 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 */ 184enum 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 199int pthread_atfork(void (*prepare)(void), void (*parent)(void), 200 void (*child)(void)); 201int pthread_attr_destroy(pthread_attr_t *); 202int pthread_attr_getstack(const pthread_attr_t * __restrict, 203 void ** __restrict stackaddr, 204 size_t * __restrict stacksize); 205int pthread_attr_getstacksize(const pthread_attr_t *, size_t *); 206int pthread_attr_getguardsize(const pthread_attr_t *, size_t *); 207int pthread_attr_getstackaddr(const pthread_attr_t *, void **); 208int pthread_attr_getdetachstate(const pthread_attr_t *, int *); 209int pthread_attr_init(pthread_attr_t *); 210int pthread_attr_setstacksize(pthread_attr_t *, size_t); 211int pthread_attr_setguardsize(pthread_attr_t *, size_t); 212int pthread_attr_setstack(pthread_attr_t *, void *, size_t); 213int pthread_attr_setstackaddr(pthread_attr_t *, void *); 214int pthread_attr_setdetachstate(pthread_attr_t *, int); 215int pthread_barrier_destroy(pthread_barrier_t *); 216int pthread_barrier_init(pthread_barrier_t *, 217 const pthread_barrierattr_t *, unsigned); 218int pthread_barrier_wait(pthread_barrier_t *); 219int pthread_barrierattr_destroy(pthread_barrierattr_t *); 220int pthread_barrierattr_getpshared(const pthread_barrierattr_t *, 221 int *); 222int pthread_barrierattr_init(pthread_barrierattr_t *); 223int pthread_barrierattr_setpshared(pthread_barrierattr_t *, int); 224void pthread_cleanup_pop(int); 225void pthread_cleanup_push(void (*) (void *), void *routine_arg); 226int pthread_condattr_destroy(pthread_condattr_t *); 227int pthread_condattr_init(pthread_condattr_t *); 228int pthread_condattr_getclock(const pthread_condattr_t *, 229 clockid_t *); 230int pthread_condattr_setclock(pthread_condattr_t *, 231 clockid_t); 232 233int pthread_cond_broadcast(pthread_cond_t *); 234int pthread_cond_destroy(pthread_cond_t *); 235int pthread_cond_init(pthread_cond_t *, 236 const pthread_condattr_t *); 237int pthread_cond_signal(pthread_cond_t *); 238int pthread_cond_timedwait(pthread_cond_t *, 239 pthread_mutex_t *, const struct timespec *); 240int pthread_cond_wait(pthread_cond_t *, pthread_mutex_t *); 241int pthread_create(pthread_t *, const pthread_attr_t *, 242 void *(*) (void *), void *); 243int pthread_detach(pthread_t); 244int pthread_equal(pthread_t, pthread_t); 245void pthread_exit(void *) __dead2; 246void *pthread_getspecific(pthread_key_t); 247int pthread_join(pthread_t, void **); 248int pthread_key_create(pthread_key_t *, 249 void (*) (void *)); 250int pthread_key_delete(pthread_key_t); 251int pthread_kill(pthread_t, int); 252int pthread_mutexattr_init(pthread_mutexattr_t *); 253int pthread_mutexattr_destroy(pthread_mutexattr_t *); 254int pthread_mutexattr_gettype(pthread_mutexattr_t *, int *); 255int pthread_mutexattr_settype(pthread_mutexattr_t *, int); 256int pthread_mutex_destroy(pthread_mutex_t *); 257int pthread_mutex_init(pthread_mutex_t *, 258 const pthread_mutexattr_t *); 259int pthread_mutex_lock(pthread_mutex_t *); 260int pthread_mutex_trylock(pthread_mutex_t *); 261int pthread_mutex_timedlock(pthread_mutex_t *, 262 const struct timespec *); 263int pthread_mutex_unlock(pthread_mutex_t *); 264int pthread_once(pthread_once_t *, void (*) (void)); 265int pthread_rwlock_destroy(pthread_rwlock_t *); 266int pthread_rwlock_init(pthread_rwlock_t *, 267 const pthread_rwlockattr_t *); 268int pthread_rwlock_rdlock(pthread_rwlock_t *); 269int pthread_rwlock_timedrdlock(pthread_rwlock_t *, 270 const struct timespec *); 271int pthread_rwlock_timedwrlock(pthread_rwlock_t *, 272 const struct timespec *); 273int pthread_rwlock_tryrdlock(pthread_rwlock_t *); 274int pthread_rwlock_trywrlock(pthread_rwlock_t *); 275int pthread_rwlock_unlock(pthread_rwlock_t *); 276int pthread_rwlock_wrlock(pthread_rwlock_t *); 277int pthread_rwlockattr_init(pthread_rwlockattr_t *); 278int pthread_rwlockattr_getpshared(const pthread_rwlockattr_t *, 279 int *); 280int pthread_rwlockattr_setpshared(pthread_rwlockattr_t *, int); 281int pthread_rwlockattr_destroy(pthread_rwlockattr_t *); 282pthread_t pthread_self(void); 283int pthread_setspecific(pthread_key_t, const void *); 284int pthread_sigmask(int, const sigset_t *, sigset_t *); 285 286int pthread_spin_init(pthread_spinlock_t *, int); 287int pthread_spin_destroy(pthread_spinlock_t *); 288int pthread_spin_lock(pthread_spinlock_t *); 289int pthread_spin_trylock(pthread_spinlock_t *); 290int pthread_spin_unlock(pthread_spinlock_t *); 291int pthread_cancel(pthread_t); 292int pthread_setcancelstate(int, int *); 293int pthread_setcanceltype(int, int *); 294void pthread_testcancel(void); 295 296int pthread_getprio(pthread_t); 297int pthread_setprio(pthread_t, int); 298void pthread_yield(void); 299 300int pthread_mutexattr_getprioceiling(pthread_mutexattr_t *, 301 int *); 302int pthread_mutexattr_setprioceiling(pthread_mutexattr_t *, 303 int); 304int pthread_mutex_getprioceiling(pthread_mutex_t *, int *); 305int pthread_mutex_setprioceiling(pthread_mutex_t *, int, int *); 306 307int pthread_mutexattr_getprotocol(pthread_mutexattr_t *, int *); 308int pthread_mutexattr_setprotocol(pthread_mutexattr_t *, int); 309 310int pthread_attr_getinheritsched(const pthread_attr_t *, int *); 311int pthread_attr_getschedparam(const pthread_attr_t *, 312 struct sched_param *); 313int pthread_attr_getschedpolicy(const pthread_attr_t *, int *); 314int pthread_attr_getscope(const pthread_attr_t *, int *); 315int pthread_attr_setinheritsched(pthread_attr_t *, int); 316int pthread_attr_setschedparam(pthread_attr_t *, 317 const struct sched_param *); 318int pthread_attr_setschedpolicy(pthread_attr_t *, int); 319int pthread_attr_setscope(pthread_attr_t *, int); 320int pthread_getschedparam(pthread_t pthread, int *, 321 struct sched_param *); 322int pthread_setschedparam(pthread_t, int, 323 const struct sched_param *); 324int pthread_getconcurrency(void); 325int pthread_setconcurrency(int); 326__END_DECLS 327 328#endif 329