1*ea0d1f1fSderaadt /* $OpenBSD: pthread.h,v 1.4 2018/03/05 01:15:26 deraadt Exp $ */ 2249f38f2Sguenther 3249f38f2Sguenther /* 4249f38f2Sguenther * Copyright (c) 1993, 1994 by Chris Provenzano, proven@mit.edu 5249f38f2Sguenther * Copyright (c) 1995-1998 by John Birrell <jb@cimlogic.com.au> 6249f38f2Sguenther * All rights reserved. 7249f38f2Sguenther * 8249f38f2Sguenther * Redistribution and use in source and binary forms, with or without 9249f38f2Sguenther * modification, are permitted provided that the following conditions 10249f38f2Sguenther * are met: 11249f38f2Sguenther * 1. Redistributions of source code must retain the above copyright 12249f38f2Sguenther * notice, this list of conditions and the following disclaimer. 13249f38f2Sguenther * 2. Redistributions in binary form must reproduce the above copyright 14249f38f2Sguenther * notice, this list of conditions and the following disclaimer in the 15249f38f2Sguenther * documentation and/or other materials provided with the distribution. 16249f38f2Sguenther * 3. All advertising materials mentioning features or use of this software 17249f38f2Sguenther * must display the following acknowledgement: 18249f38f2Sguenther * This product includes software developed by Chris Provenzano. 19249f38f2Sguenther * 4. The name of Chris Provenzano may not be used to endorse or promote 20249f38f2Sguenther * products derived from this software without specific prior written 21249f38f2Sguenther * permission. 22249f38f2Sguenther * 23249f38f2Sguenther * THIS SOFTWARE IS PROVIDED BY CHRIS PROVENZANO ``AS IS'' AND 24249f38f2Sguenther * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 25249f38f2Sguenther * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 26249f38f2Sguenther * ARE DISCLAIMED. IN NO EVENT SHALL CHRIS PROVENZANO BE LIABLE FOR ANY 27249f38f2Sguenther * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 28249f38f2Sguenther * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 29249f38f2Sguenther * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 30249f38f2Sguenther * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 31249f38f2Sguenther * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 32249f38f2Sguenther * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 33249f38f2Sguenther * SUCH DAMAGE. 34249f38f2Sguenther * 35249f38f2Sguenther * $FreeBSD: pthread.h,v 1.13 1999/07/31 08:36:07 rse Exp $ 36249f38f2Sguenther */ 37249f38f2Sguenther #ifndef _PTHREAD_H_ 38249f38f2Sguenther #define _PTHREAD_H_ 39249f38f2Sguenther 40249f38f2Sguenther /* 41249f38f2Sguenther * Header files. 42249f38f2Sguenther */ 43249f38f2Sguenther #include <sys/types.h> 44249f38f2Sguenther #include <sys/time.h> 45249f38f2Sguenther #include <sys/signal.h> 46249f38f2Sguenther #include <limits.h> 47249f38f2Sguenther #include <sched.h> 48249f38f2Sguenther 49249f38f2Sguenther /* 50249f38f2Sguenther * Run-time invariant values: 51249f38f2Sguenther */ 52249f38f2Sguenther #define PTHREAD_DESTRUCTOR_ITERATIONS 4 53249f38f2Sguenther #define PTHREAD_KEYS_MAX 256 54*ea0d1f1fSderaadt #define PTHREAD_STACK_MIN (1U << _MAX_PAGE_SHIFT) 55249f38f2Sguenther #define PTHREAD_THREADS_MAX ULONG_MAX 56249f38f2Sguenther 57249f38f2Sguenther /* 58249f38f2Sguenther * Flags for threads and thread attributes. 59249f38f2Sguenther */ 60249f38f2Sguenther #define PTHREAD_DETACHED 0x1 61249f38f2Sguenther #define PTHREAD_SCOPE_SYSTEM 0x2 62249f38f2Sguenther #define PTHREAD_INHERIT_SCHED 0x4 63249f38f2Sguenther #define PTHREAD_NOFLOAT 0x8 64249f38f2Sguenther 65249f38f2Sguenther #define PTHREAD_CREATE_DETACHED PTHREAD_DETACHED 66249f38f2Sguenther #define PTHREAD_CREATE_JOINABLE 0 67249f38f2Sguenther #define PTHREAD_SCOPE_PROCESS 0 68249f38f2Sguenther #define PTHREAD_EXPLICIT_SCHED 0 69249f38f2Sguenther 70249f38f2Sguenther /* 71249f38f2Sguenther * Flags for read/write lock attributes 72249f38f2Sguenther */ 73249f38f2Sguenther #define PTHREAD_PROCESS_PRIVATE 0 74249f38f2Sguenther #define PTHREAD_PROCESS_SHARED 1 75249f38f2Sguenther 76249f38f2Sguenther /* 77249f38f2Sguenther * Flags for cancelling threads 78249f38f2Sguenther */ 79249f38f2Sguenther #define PTHREAD_CANCEL_ENABLE 0 80249f38f2Sguenther #define PTHREAD_CANCEL_DISABLE 1 81249f38f2Sguenther #define PTHREAD_CANCEL_DEFERRED 0 82249f38f2Sguenther #define PTHREAD_CANCEL_ASYNCHRONOUS 2 83249f38f2Sguenther #define PTHREAD_CANCELED ((void *) 1) 84249f38f2Sguenther 85249f38f2Sguenther /* 86249f38f2Sguenther * Barrier flags 87249f38f2Sguenther */ 88249f38f2Sguenther #define PTHREAD_BARRIER_SERIAL_THREAD -1 89249f38f2Sguenther 90249f38f2Sguenther /* 91249f38f2Sguenther * Forward structure definitions. 92249f38f2Sguenther * 93249f38f2Sguenther * These are mostly opaque to the user. 94249f38f2Sguenther */ 95249f38f2Sguenther struct pthread; 96249f38f2Sguenther struct pthread_attr; 97249f38f2Sguenther struct pthread_cond; 98249f38f2Sguenther struct pthread_cond_attr; 99249f38f2Sguenther struct pthread_mutex; 100249f38f2Sguenther struct pthread_mutex_attr; 101249f38f2Sguenther struct pthread_once; 102249f38f2Sguenther struct pthread_rwlock; 103249f38f2Sguenther struct pthread_rwlockattr; 104249f38f2Sguenther 105249f38f2Sguenther /* 106249f38f2Sguenther * Primitive system data type definitions required by P1003.1c. 107249f38f2Sguenther * 108249f38f2Sguenther * Note that P1003.1c specifies that there are no defined comparison 109249f38f2Sguenther * or assignment operators for the types pthread_attr_t, pthread_cond_t, 110249f38f2Sguenther * pthread_condattr_t, pthread_mutex_t, pthread_mutexattr_t. 111249f38f2Sguenther */ 112249f38f2Sguenther typedef struct pthread *pthread_t; 113249f38f2Sguenther typedef struct pthread_attr *pthread_attr_t; 114249f38f2Sguenther typedef volatile struct pthread_mutex *pthread_mutex_t; 115249f38f2Sguenther typedef struct pthread_mutex_attr *pthread_mutexattr_t; 116249f38f2Sguenther typedef struct pthread_cond *pthread_cond_t; 117249f38f2Sguenther typedef struct pthread_cond_attr *pthread_condattr_t; 118249f38f2Sguenther typedef int pthread_key_t; 119249f38f2Sguenther typedef struct pthread_once pthread_once_t; 120249f38f2Sguenther typedef struct pthread_rwlock *pthread_rwlock_t; 121249f38f2Sguenther typedef struct pthread_rwlockattr *pthread_rwlockattr_t; 122249f38f2Sguenther typedef struct pthread_barrier *pthread_barrier_t; 123249f38f2Sguenther typedef struct pthread_barrierattr *pthread_barrierattr_t; 124249f38f2Sguenther typedef struct pthread_spinlock *pthread_spinlock_t; 125249f38f2Sguenther 126249f38f2Sguenther /* 127249f38f2Sguenther * Additional type definitions: 128249f38f2Sguenther * 129249f38f2Sguenther * Note that P1003.1c reserves the prefixes pthread_ and PTHREAD_ for 130249f38f2Sguenther * use in header symbols. 131249f38f2Sguenther */ 132249f38f2Sguenther typedef void *pthread_addr_t; 133249f38f2Sguenther typedef void *(*pthread_startroutine_t)(void *); 134249f38f2Sguenther 135249f38f2Sguenther /* 136249f38f2Sguenther * Once definitions. 137249f38f2Sguenther */ 138249f38f2Sguenther struct pthread_once { 139249f38f2Sguenther int state; 140249f38f2Sguenther pthread_mutex_t mutex; 141249f38f2Sguenther }; 142249f38f2Sguenther 143249f38f2Sguenther /* 144249f38f2Sguenther * Flags for once initialization. 145249f38f2Sguenther */ 146249f38f2Sguenther #define PTHREAD_NEEDS_INIT 0 147249f38f2Sguenther #define PTHREAD_DONE_INIT 1 148249f38f2Sguenther 149249f38f2Sguenther /* 150249f38f2Sguenther * Static once initialization values. 151249f38f2Sguenther */ 152249f38f2Sguenther #define PTHREAD_ONCE_INIT { PTHREAD_NEEDS_INIT, PTHREAD_MUTEX_INITIALIZER } 153249f38f2Sguenther 154249f38f2Sguenther /* 155249f38f2Sguenther * Static initialization values. 156249f38f2Sguenther */ 157249f38f2Sguenther #define PTHREAD_MUTEX_INITIALIZER NULL 158249f38f2Sguenther #define PTHREAD_COND_INITIALIZER NULL 159249f38f2Sguenther #define PTHREAD_RWLOCK_INITIALIZER NULL 160249f38f2Sguenther 161249f38f2Sguenther #define PTHREAD_PRIO_NONE 0 162249f38f2Sguenther #define PTHREAD_PRIO_INHERIT 1 163249f38f2Sguenther #define PTHREAD_PRIO_PROTECT 2 164249f38f2Sguenther 165249f38f2Sguenther /* 166249f38f2Sguenther * Mutex types. 167249f38f2Sguenther */ 168249f38f2Sguenther enum pthread_mutextype { 169249f38f2Sguenther PTHREAD_MUTEX_ERRORCHECK = 1, /* Error checking mutex */ 170249f38f2Sguenther PTHREAD_MUTEX_RECURSIVE = 2, /* Recursive mutex */ 171249f38f2Sguenther PTHREAD_MUTEX_NORMAL = 3, /* No error checking */ 172249f38f2Sguenther PTHREAD_MUTEX_STRICT_NP = 4, /* Strict error checking */ 173249f38f2Sguenther PTHREAD_MUTEX_TYPE_MAX 174249f38f2Sguenther }; 175249f38f2Sguenther 176249f38f2Sguenther #define PTHREAD_MUTEX_ERRORCHECK PTHREAD_MUTEX_ERRORCHECK 177249f38f2Sguenther #define PTHREAD_MUTEX_RECURSIVE PTHREAD_MUTEX_RECURSIVE 178249f38f2Sguenther #define PTHREAD_MUTEX_NORMAL PTHREAD_MUTEX_NORMAL 179249f38f2Sguenther #define PTHREAD_MUTEX_STRICT_NP PTHREAD_MUTEX_STRICT_NP 180249f38f2Sguenther #define PTHREAD_MUTEX_DEFAULT PTHREAD_MUTEX_STRICT_NP 181249f38f2Sguenther 182249f38f2Sguenther /* 183249f38f2Sguenther * Thread function prototype definitions: 184249f38f2Sguenther */ 185249f38f2Sguenther __BEGIN_DECLS 186249f38f2Sguenther int pthread_atfork(void (*)(void), void (*)(void), void (*)(void)); 187249f38f2Sguenther int pthread_attr_destroy(pthread_attr_t *); 188249f38f2Sguenther int pthread_attr_getstack(const pthread_attr_t *, 189249f38f2Sguenther void **, size_t *); 190249f38f2Sguenther int pthread_attr_getstacksize(const pthread_attr_t *, size_t *); 191249f38f2Sguenther int pthread_attr_getstackaddr(const pthread_attr_t *, void **); 192249f38f2Sguenther int pthread_attr_getguardsize(const pthread_attr_t *, size_t *); 193249f38f2Sguenther int pthread_attr_getdetachstate(const pthread_attr_t *, int *); 194249f38f2Sguenther int pthread_attr_init(pthread_attr_t *); 195249f38f2Sguenther int pthread_attr_setstacksize(pthread_attr_t *, size_t); 196249f38f2Sguenther int pthread_attr_setstack(pthread_attr_t *, void *, size_t); 197249f38f2Sguenther int pthread_attr_setstackaddr(pthread_attr_t *, void *); 198249f38f2Sguenther int pthread_attr_setguardsize(pthread_attr_t *, size_t); 199249f38f2Sguenther int pthread_attr_setdetachstate(pthread_attr_t *, int); 200a318b99dSjca void pthread_cleanup_pop(int); 201a318b99dSjca void pthread_cleanup_push(void (*) (void *), void *routine_arg); 202249f38f2Sguenther int pthread_condattr_destroy(pthread_condattr_t *); 203249f38f2Sguenther int pthread_condattr_init(pthread_condattr_t *); 204249f38f2Sguenther 205249f38f2Sguenther int pthread_cond_broadcast(pthread_cond_t *); 206249f38f2Sguenther int pthread_cond_destroy(pthread_cond_t *); 207249f38f2Sguenther int pthread_cond_init(pthread_cond_t *, 208249f38f2Sguenther const pthread_condattr_t *); 209249f38f2Sguenther int pthread_cond_signal(pthread_cond_t *); 210249f38f2Sguenther int pthread_cond_timedwait(pthread_cond_t *, 211249f38f2Sguenther pthread_mutex_t *, const struct timespec *); 212249f38f2Sguenther int pthread_cond_wait(pthread_cond_t *, pthread_mutex_t *); 213249f38f2Sguenther int pthread_create(pthread_t *, const pthread_attr_t *, 214249f38f2Sguenther void *(*) (void *), void *); 215249f38f2Sguenther int pthread_detach(pthread_t); 216249f38f2Sguenther int pthread_equal(pthread_t, pthread_t); 217249f38f2Sguenther __dead void pthread_exit(void *); 218249f38f2Sguenther void *pthread_getspecific(pthread_key_t); 219249f38f2Sguenther int pthread_join(pthread_t, void **); 220249f38f2Sguenther int pthread_key_create(pthread_key_t *, 221249f38f2Sguenther void (*) (void *)); 222249f38f2Sguenther int pthread_key_delete(pthread_key_t); 223249f38f2Sguenther int pthread_kill(pthread_t, int); 224249f38f2Sguenther int pthread_mutexattr_init(pthread_mutexattr_t *); 225249f38f2Sguenther int pthread_mutexattr_destroy(pthread_mutexattr_t *); 226249f38f2Sguenther int pthread_mutexattr_gettype(pthread_mutexattr_t *, int *); 227249f38f2Sguenther int pthread_mutexattr_settype(pthread_mutexattr_t *, int); 228249f38f2Sguenther int pthread_mutex_destroy(pthread_mutex_t *); 229249f38f2Sguenther int pthread_mutex_init(pthread_mutex_t *, 230249f38f2Sguenther const pthread_mutexattr_t *); 231249f38f2Sguenther int pthread_mutex_lock(pthread_mutex_t *); 232249f38f2Sguenther int pthread_mutex_timedlock(pthread_mutex_t *, 233249f38f2Sguenther const struct timespec *); 234249f38f2Sguenther int pthread_mutex_trylock(pthread_mutex_t *); 235249f38f2Sguenther int pthread_mutex_unlock(pthread_mutex_t *); 236249f38f2Sguenther int pthread_once(pthread_once_t *, void (*) (void)); 237249f38f2Sguenther int pthread_rwlock_destroy(pthread_rwlock_t *); 238249f38f2Sguenther int pthread_rwlock_init(pthread_rwlock_t *, 239249f38f2Sguenther const pthread_rwlockattr_t *); 240249f38f2Sguenther int pthread_rwlock_rdlock(pthread_rwlock_t *); 241249f38f2Sguenther int pthread_rwlock_timedrdlock(pthread_rwlock_t *, 242249f38f2Sguenther const struct timespec *); 243249f38f2Sguenther int pthread_rwlock_timedwrlock(pthread_rwlock_t *, 244249f38f2Sguenther const struct timespec *); 245249f38f2Sguenther int pthread_rwlock_tryrdlock(pthread_rwlock_t *); 246249f38f2Sguenther int pthread_rwlock_trywrlock(pthread_rwlock_t *); 247249f38f2Sguenther int pthread_rwlock_unlock(pthread_rwlock_t *); 248249f38f2Sguenther int pthread_rwlock_wrlock(pthread_rwlock_t *); 249249f38f2Sguenther int pthread_rwlockattr_init(pthread_rwlockattr_t *); 250249f38f2Sguenther int pthread_rwlockattr_getpshared(const pthread_rwlockattr_t *, 251249f38f2Sguenther int *); 252249f38f2Sguenther int pthread_rwlockattr_setpshared(pthread_rwlockattr_t *, int); 253249f38f2Sguenther int pthread_rwlockattr_destroy(pthread_rwlockattr_t *); 254249f38f2Sguenther pthread_t pthread_self(void); 255249f38f2Sguenther int pthread_setspecific(pthread_key_t, const void *); 256249f38f2Sguenther 257249f38f2Sguenther int pthread_cancel(pthread_t); 258249f38f2Sguenther int pthread_setcancelstate(int, int *); 259249f38f2Sguenther int pthread_setcanceltype(int, int *); 260249f38f2Sguenther void pthread_testcancel(void); 261249f38f2Sguenther 262249f38f2Sguenther int pthread_getprio(pthread_t); 263249f38f2Sguenther int pthread_setprio(pthread_t, int); 264249f38f2Sguenther void pthread_yield(void); 265249f38f2Sguenther 266249f38f2Sguenther int pthread_mutexattr_getprioceiling(pthread_mutexattr_t *, 267249f38f2Sguenther int *); 268249f38f2Sguenther int pthread_mutexattr_setprioceiling(pthread_mutexattr_t *, 269249f38f2Sguenther int); 270249f38f2Sguenther int pthread_mutex_getprioceiling(pthread_mutex_t *, int *); 271249f38f2Sguenther int pthread_mutex_setprioceiling(pthread_mutex_t *, int, int *); 272249f38f2Sguenther 273249f38f2Sguenther int pthread_mutexattr_getprotocol(pthread_mutexattr_t *, int *); 274249f38f2Sguenther int pthread_mutexattr_setprotocol(pthread_mutexattr_t *, int); 275249f38f2Sguenther 276249f38f2Sguenther int pthread_condattr_getclock(const pthread_condattr_t *, 277249f38f2Sguenther clockid_t *); 278249f38f2Sguenther int pthread_condattr_setclock(pthread_condattr_t *, clockid_t); 279249f38f2Sguenther 280249f38f2Sguenther int pthread_attr_getinheritsched(const pthread_attr_t *, int *); 281249f38f2Sguenther int pthread_attr_getschedparam(const pthread_attr_t *, 282249f38f2Sguenther struct sched_param *); 283249f38f2Sguenther int pthread_attr_getschedpolicy(const pthread_attr_t *, int *); 284249f38f2Sguenther int pthread_attr_getscope(const pthread_attr_t *, int *); 285249f38f2Sguenther int pthread_attr_setinheritsched(pthread_attr_t *, int); 286249f38f2Sguenther int pthread_attr_setschedparam(pthread_attr_t *, 287249f38f2Sguenther const struct sched_param *); 288249f38f2Sguenther int pthread_attr_setschedpolicy(pthread_attr_t *, int); 289249f38f2Sguenther int pthread_attr_setscope(pthread_attr_t *, int); 290249f38f2Sguenther int pthread_getschedparam(pthread_t pthread, int *, 291249f38f2Sguenther struct sched_param *); 292249f38f2Sguenther int pthread_setschedparam(pthread_t, int, 293249f38f2Sguenther const struct sched_param *); 294249f38f2Sguenther int pthread_getconcurrency(void); 295249f38f2Sguenther int pthread_setconcurrency(int); 296249f38f2Sguenther int pthread_barrier_init(pthread_barrier_t *, 297249f38f2Sguenther pthread_barrierattr_t *, unsigned int); 298249f38f2Sguenther int pthread_barrier_destroy(pthread_barrier_t *); 299249f38f2Sguenther int pthread_barrier_wait(pthread_barrier_t *); 300249f38f2Sguenther int pthread_barrierattr_init(pthread_barrierattr_t *); 301249f38f2Sguenther int pthread_barrierattr_destroy(pthread_barrierattr_t *); 302249f38f2Sguenther int pthread_barrierattr_getpshared(pthread_barrierattr_t *, int *); 303249f38f2Sguenther int pthread_barrierattr_setpshared(pthread_barrierattr_t *, int); 304249f38f2Sguenther int pthread_spin_init(pthread_spinlock_t *, int); 305249f38f2Sguenther int pthread_spin_destroy(pthread_spinlock_t *); 306249f38f2Sguenther int pthread_spin_trylock(pthread_spinlock_t *); 307249f38f2Sguenther int pthread_spin_lock(pthread_spinlock_t *); 308249f38f2Sguenther int pthread_spin_unlock(pthread_spinlock_t *); 309249f38f2Sguenther 310249f38f2Sguenther #if __POSIX_VISIBLE >= 200112 311249f38f2Sguenther int pthread_getcpuclockid(pthread_t, clockid_t *); 312249f38f2Sguenther #endif 313249f38f2Sguenther __END_DECLS 314249f38f2Sguenther 315249f38f2Sguenther #endif /* _PTHREAD_H_ */ 316