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