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