1331722Seadler/* 213547Sjulian * Copyright (c) 1993, 1994 by Chris Provenzano, proven@mit.edu 335025Sjb * Copyright (c) 1995-1998 by John Birrell <jb@cimlogic.com.au> 413547Sjulian * All rights reserved. 513547Sjulian * 613547Sjulian * Redistribution and use in source and binary forms, with or without 713547Sjulian * modification, are permitted provided that the following conditions 813547Sjulian * are met: 913547Sjulian * 1. Redistributions of source code must retain the above copyright 1013547Sjulian * notice, this list of conditions and the following disclaimer. 1113547Sjulian * 2. Redistributions in binary form must reproduce the above copyright 1213547Sjulian * notice, this list of conditions and the following disclaimer in the 1313547Sjulian * documentation and/or other materials provided with the distribution. 1413547Sjulian * 3. All advertising materials mentioning features or use of this software 1513547Sjulian * must display the following acknowledgement: 1613547Sjulian * This product includes software developed by Chris Provenzano. 1713547Sjulian * 4. The name of Chris Provenzano may not be used to endorse or promote 1813547Sjulian * products derived from this software without specific prior written 1913547Sjulian * permission. 2013547Sjulian * 2113547Sjulian * THIS SOFTWARE IS PROVIDED BY CHRIS PROVENZANO ``AS IS'' AND 2213547Sjulian * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 2313547Sjulian * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 2413547Sjulian * ARE DISCLAIMED. IN NO EVENT SHALL CHRIS PROVENZANO BE LIABLE FOR ANY 2513547Sjulian * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 2613547Sjulian * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 2713547Sjulian * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 2813547Sjulian * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2913547Sjulian * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 3013547Sjulian * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 3113547Sjulian * SUCH DAMAGE. 3213547Sjulian * 3350473Speter * $FreeBSD: stable/11/include/pthread.h 338707 2018-09-17 02:51:08Z pfg $ 3413547Sjulian */ 3513547Sjulian#ifndef _PTHREAD_H_ 36280820Spfg#define _PTHREAD_H_ 3713547Sjulian 3813547Sjulian/* 3913547Sjulian * Header files. 4013547Sjulian */ 4113547Sjulian#include <sys/cdefs.h> 42146824Srodrigc#include <sys/_pthreadtypes.h> 43149692Sstefanf#include <machine/_limits.h> 44149692Sstefanf#include <machine/_types.h> 45149692Sstefanf#include <sys/_sigset.h> 4644965Sjb#include <sched.h> 47149692Sstefanf#include <time.h> 4813547Sjulian 4913547Sjulian/* 5017706Sjulian * Run-time invariant values: 5113547Sjulian */ 52280820Spfg#define PTHREAD_DESTRUCTOR_ITERATIONS 4 53280820Spfg#define PTHREAD_KEYS_MAX 256 54280820Spfg#define PTHREAD_STACK_MIN __MINSIGSTKSZ 55280820Spfg#define PTHREAD_THREADS_MAX __ULONG_MAX 56280820Spfg#define PTHREAD_BARRIER_SERIAL_THREAD -1 5713547Sjulian 5813547Sjulian/* 5922315Sjulian * Flags for threads and thread attributes. 6022315Sjulian */ 61280820Spfg#define PTHREAD_DETACHED 0x1 62280820Spfg#define PTHREAD_SCOPE_SYSTEM 0x2 63280820Spfg#define PTHREAD_INHERIT_SCHED 0x4 64280820Spfg#define PTHREAD_NOFLOAT 0x8 6522315Sjulian 66280820Spfg#define PTHREAD_CREATE_DETACHED PTHREAD_DETACHED 67280820Spfg#define PTHREAD_CREATE_JOINABLE 0 68280820Spfg#define PTHREAD_SCOPE_PROCESS 0 69280820Spfg#define PTHREAD_EXPLICIT_SCHED 0 7022315Sjulian 7122315Sjulian/* 72296162Skib * Values for process shared/private attributes. 7338919Salex */ 74280820Spfg#define PTHREAD_PROCESS_PRIVATE 0 75280820Spfg#define PTHREAD_PROCESS_SHARED 1 7638919Salex 7738919Salex/* 7853812Salfred * Flags for cancelling threads 7953812Salfred */ 80280820Spfg#define PTHREAD_CANCEL_ENABLE 0 81280820Spfg#define PTHREAD_CANCEL_DISABLE 1 82280820Spfg#define PTHREAD_CANCEL_DEFERRED 0 83280820Spfg#define PTHREAD_CANCEL_ASYNCHRONOUS 2 84280820Spfg#define PTHREAD_CANCELED ((void *) 1) 8553812Salfred 8653812Salfred/* 8713547Sjulian * Flags for once initialization. 8813547Sjulian */ 89280820Spfg#define PTHREAD_NEEDS_INIT 0 90280820Spfg#define PTHREAD_DONE_INIT 1 9113547Sjulian 9213547Sjulian/* 93280820Spfg * Static once initialization values. 9413547Sjulian */ 95280820Spfg#define PTHREAD_ONCE_INIT { PTHREAD_NEEDS_INIT, NULL } 9613547Sjulian 9713547Sjulian/* 98280820Spfg * Static initialization values. 9913547Sjulian */ 100280820Spfg#define PTHREAD_MUTEX_INITIALIZER NULL 101280820Spfg#define PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP ((pthread_mutex_t)1) 102280820Spfg#define PTHREAD_COND_INITIALIZER NULL 103280820Spfg#define PTHREAD_RWLOCK_INITIALIZER NULL 10435025Sjb 10535025Sjb/* 10635025Sjb * Default attribute arguments (draft 4, deprecated). 10735025Sjb */ 10822315Sjulian#ifndef PTHREAD_KERNEL 109280820Spfg#define pthread_condattr_default NULL 110280820Spfg#define pthread_mutexattr_default NULL 111280820Spfg#define pthread_attr_default NULL 11213547Sjulian#endif 11313547Sjulian 114280820Spfg#define PTHREAD_PRIO_NONE 0 115280820Spfg#define PTHREAD_PRIO_INHERIT 1 116280820Spfg#define PTHREAD_PRIO_PROTECT 2 11744965Sjb 11844965Sjb/* 11944965Sjb * Mutex types (Single UNIX Specification, Version 2, 1997). 12044965Sjb * 12144965Sjb * Note that a mutex attribute with one of the following types: 12244965Sjb * 12344965Sjb * PTHREAD_MUTEX_NORMAL 12444965Sjb * PTHREAD_MUTEX_RECURSIVE 12544965Sjb * 12644965Sjb * will deviate from POSIX specified semantics. 12744965Sjb */ 12819637Shsuenum pthread_mutextype { 12944965Sjb PTHREAD_MUTEX_ERRORCHECK = 1, /* Default POSIX mutex */ 13044965Sjb PTHREAD_MUTEX_RECURSIVE = 2, /* Recursive mutex */ 13144965Sjb PTHREAD_MUTEX_NORMAL = 3, /* No error checking */ 132173154Skris PTHREAD_MUTEX_ADAPTIVE_NP = 4, /* Adaptive mutex, spins briefly before blocking on lock */ 133149298Sstefanf PTHREAD_MUTEX_TYPE_MAX 13419637Shsu}; 13519637Shsu 136280820Spfg#define PTHREAD_MUTEX_DEFAULT PTHREAD_MUTEX_ERRORCHECK 13741390Seivind 138300043Skib#define PTHREAD_MUTEX_STALLED 0 139300043Skib#define PTHREAD_MUTEX_ROBUST 1 140300043Skib 141179662Sdavidxustruct _pthread_cleanup_info { 142179662Sdavidxu __uintptr_t pthread_cleanup_pad[8]; 143179662Sdavidxu}; 144179662Sdavidxu 14513547Sjulian/* 14613547Sjulian * Thread function prototype definitions: 14713547Sjulian */ 14813547Sjulian__BEGIN_DECLS 149149273Sstefanfint pthread_atfork(void (*)(void), void (*)(void), void (*)(void)); 150332308Spfgint pthread_attr_destroy(pthread_attr_t *); 151315282Spfgint pthread_attr_getstack( 152332308Spfg const pthread_attr_t * __restrict, void ** __restrict, 153332308Spfg size_t * __restrict); 154338707Spfgint pthread_attr_getstacksize(const pthread_attr_t * __restrict, 155338707Spfg size_t * __restrict); 156338707Spfgint pthread_attr_getguardsize(const pthread_attr_t * __restrict, 157338707Spfg size_t * __restrict); 15893032Simpint pthread_attr_getstackaddr(const pthread_attr_t *, void **); 159332308Spfgint pthread_attr_getdetachstate(const pthread_attr_t *, 160332308Spfg int *); 161332308Spfgint pthread_attr_init(pthread_attr_t *); 162332308Spfgint pthread_attr_setstacksize(pthread_attr_t *, size_t); 163332308Spfgint pthread_attr_setguardsize(pthread_attr_t *, size_t); 164332308Spfgint pthread_attr_setstack(pthread_attr_t *, void *, 165315282Spfg size_t); 16693032Simpint pthread_attr_setstackaddr(pthread_attr_t *, void *); 167332308Spfgint pthread_attr_setdetachstate(pthread_attr_t *, int); 168332308Spfgint pthread_barrier_destroy(pthread_barrier_t *); 169338707Spfgint pthread_barrier_init(pthread_barrier_t * __restrict, 170338707Spfg const pthread_barrierattr_t * __restrict, unsigned); 171332308Spfgint pthread_barrier_wait(pthread_barrier_t *); 172332308Spfgint pthread_barrierattr_destroy(pthread_barrierattr_t *); 173315282Spfgint pthread_barrierattr_getpshared( 174338707Spfg const pthread_barrierattr_t * __restrict, int * __restrict); 175332308Spfgint pthread_barrierattr_init(pthread_barrierattr_t *); 176332308Spfgint pthread_barrierattr_setpshared(pthread_barrierattr_t *, int); 177179662Sdavidxu 178179662Sdavidxu#define pthread_cleanup_push(cleanup_routine, cleanup_arg) \ 179179662Sdavidxu { \ 180179662Sdavidxu struct _pthread_cleanup_info __cleanup_info__; \ 181179662Sdavidxu __pthread_cleanup_push_imp(cleanup_routine, cleanup_arg,\ 182179662Sdavidxu &__cleanup_info__); \ 183179662Sdavidxu { 184179662Sdavidxu 185179662Sdavidxu#define pthread_cleanup_pop(execute) \ 186256925Stijl (void)0; \ 187179662Sdavidxu } \ 188179662Sdavidxu __pthread_cleanup_pop_imp(execute); \ 189179662Sdavidxu } 190179662Sdavidxu 191332308Spfgint pthread_condattr_destroy(pthread_condattr_t *); 192338707Spfgint pthread_condattr_getclock(const pthread_condattr_t * __restrict, 193338707Spfg clockid_t * __restrict); 194332308Spfgint pthread_condattr_getpshared(const pthread_condattr_t *, int *); 195332308Spfgint pthread_condattr_init(pthread_condattr_t *); 196332308Spfgint pthread_condattr_setclock(pthread_condattr_t *, clockid_t); 197332308Spfgint pthread_condattr_setpshared(pthread_condattr_t *, int); 198332308Spfgint pthread_cond_broadcast(pthread_cond_t *); 199332308Spfgint pthread_cond_destroy(pthread_cond_t *); 200338707Spfgint pthread_cond_init(pthread_cond_t * __restrict, 201338707Spfg const pthread_condattr_t * __restrict); 202332308Spfgint pthread_cond_signal(pthread_cond_t *); 203332308Spfgint pthread_cond_timedwait(pthread_cond_t *, 204332308Spfg pthread_mutex_t * __mutex, 205332308Spfg const struct timespec *) 206311234Spfg __requires_exclusive(*__mutex); 207338707Spfgint pthread_cond_wait(pthread_cond_t * __restrict, 208338707Spfg pthread_mutex_t * __restrict __mutex) 209311234Spfg __requires_exclusive(*__mutex); 210338707Spfgint pthread_create(pthread_t * __restrict, 211338707Spfg const pthread_attr_t * __restrict, void *(*) (void *), 212338707Spfg void * __restrict); 21393032Simpint pthread_detach(pthread_t); 21493032Simpint pthread_equal(pthread_t, pthread_t); 21593032Simpvoid pthread_exit(void *) __dead2; 21693032Simpvoid *pthread_getspecific(pthread_key_t); 217332308Spfgint pthread_getcpuclockid(pthread_t, clockid_t *); 21893032Simpint pthread_join(pthread_t, void **); 219332308Spfgint pthread_key_create(pthread_key_t *, void (*) (void *)); 22093032Simpint pthread_key_delete(pthread_key_t); 221332308Spfgint pthread_mutexattr_init(pthread_mutexattr_t *); 222332308Spfgint pthread_mutexattr_destroy(pthread_mutexattr_t *); 223338707Spfgint pthread_mutexattr_getpshared( 224338707Spfg const pthread_mutexattr_t * __restrict, 225338707Spfg int * __restrict); 226338707Spfgint pthread_mutexattr_gettype( 227338707Spfg const pthread_mutexattr_t * __restrict, int * __restrict); 228332308Spfgint pthread_mutexattr_settype(pthread_mutexattr_t *, int); 229332308Spfgint pthread_mutexattr_setpshared(pthread_mutexattr_t *, int); 230332308Spfgint pthread_mutex_consistent(pthread_mutex_t * __mutex) 231315282Spfg __requires_exclusive(*__mutex); 232332308Spfgint pthread_mutex_destroy(pthread_mutex_t * __mutex) 233311234Spfg __requires_unlocked(*__mutex); 234338707Spfgint pthread_mutex_init(pthread_mutex_t * __restrict __mutex, 235338707Spfg const pthread_mutexattr_t * __restrict) 236311234Spfg __requires_unlocked(*__mutex); 237332308Spfgint pthread_mutex_lock(pthread_mutex_t * __mutex) 238315282Spfg __locks_exclusive(*__mutex); 239332308Spfgint pthread_mutex_trylock(pthread_mutex_t * __mutex) 240315282Spfg __trylocks_exclusive(0, *__mutex); 241338707Spfgint pthread_mutex_timedlock(pthread_mutex_t * __restrict __mutex, 242338707Spfg const struct timespec * __restrict) 243315282Spfg __trylocks_exclusive(0, *__mutex); 244332308Spfgint pthread_mutex_unlock(pthread_mutex_t * __mutex) 245311234Spfg __unlocks(*__mutex); 246332308Spfgint pthread_once(pthread_once_t *, void (*) (void)); 247332308Spfgint pthread_rwlock_destroy(pthread_rwlock_t * __rwlock) 248311234Spfg __requires_unlocked(*__rwlock); 249338707Spfgint pthread_rwlock_init(pthread_rwlock_t * __restrict __rwlock, 250338707Spfg const pthread_rwlockattr_t * __restrict) 251311234Spfg __requires_unlocked(*__rwlock); 252332308Spfgint pthread_rwlock_rdlock(pthread_rwlock_t * __rwlock) 253315282Spfg __locks_shared(*__rwlock); 254338707Spfgint pthread_rwlock_timedrdlock( 255338707Spfg pthread_rwlock_t * __restrict __rwlock, 256338707Spfg const struct timespec * __restrict) 257315282Spfg __trylocks_shared(0, *__rwlock); 258338707Spfgint pthread_rwlock_timedwrlock( 259338707Spfg pthread_rwlock_t * __restrict __rwlock, 260338707Spfg const struct timespec * __restrict) 261315282Spfg __trylocks_exclusive(0, *__rwlock); 262332308Spfgint pthread_rwlock_tryrdlock(pthread_rwlock_t * __rwlock) 263315282Spfg __trylocks_shared(0, *__rwlock); 264332308Spfgint pthread_rwlock_trywrlock(pthread_rwlock_t * __rwlock) 265315282Spfg __trylocks_exclusive(0, *__rwlock); 266332308Spfgint pthread_rwlock_unlock(pthread_rwlock_t * __rwlock) 267311234Spfg __unlocks(*__rwlock); 268332308Spfgint pthread_rwlock_wrlock(pthread_rwlock_t * __rwlock) 269315282Spfg __locks_exclusive(*__rwlock); 270332308Spfgint pthread_rwlockattr_destroy(pthread_rwlockattr_t *); 271332308Spfgint pthread_rwlockattr_getkind_np(const pthread_rwlockattr_t *, 272332308Spfg int *); 273338707Spfgint pthread_rwlockattr_getpshared( 274338707Spfg const pthread_rwlockattr_t * __restrict, 275338707Spfg int * __restrict); 276332308Spfgint pthread_rwlockattr_init(pthread_rwlockattr_t *); 277332308Spfgint pthread_rwlockattr_setkind_np(pthread_rwlockattr_t *, 278315282Spfg int); 279332308Spfgint pthread_rwlockattr_setpshared(pthread_rwlockattr_t *, int); 28093032Simppthread_t pthread_self(void); 28193032Simpint pthread_setspecific(pthread_key_t, const void *); 28217706Sjulian 283332308Spfgint pthread_spin_init(pthread_spinlock_t * __spin, int) 284311234Spfg __requires_unlocked(*__spin); 285332308Spfgint pthread_spin_destroy(pthread_spinlock_t * __spin) 286311234Spfg __requires_unlocked(*__spin); 287332308Spfgint pthread_spin_lock(pthread_spinlock_t * __spin) 288315282Spfg __locks_exclusive(*__spin); 289332308Spfgint pthread_spin_trylock(pthread_spinlock_t * __spin) 290315282Spfg __trylocks_exclusive(0, *__spin); 291332308Spfgint pthread_spin_unlock(pthread_spinlock_t * __spin) 292315282Spfg __unlocks(*__spin); 29393032Simpint pthread_cancel(pthread_t); 29493032Simpint pthread_setcancelstate(int, int *); 29593032Simpint pthread_setcanceltype(int, int *); 29693032Simpvoid pthread_testcancel(void); 29717706Sjulian 298189828Sdas#if __BSD_VISIBLE 29993032Simpint pthread_getprio(pthread_t); 30093032Simpint pthread_setprio(pthread_t, int); 30193032Simpvoid pthread_yield(void); 302189828Sdas#endif 30344965Sjb 304338707Spfgint pthread_mutexattr_getprioceiling( 305338707Spfg const pthread_mutexattr_t * __restrict, 306338707Spfg int * __restrict); 307315282Spfgint pthread_mutexattr_setprioceiling(pthread_mutexattr_t *, int); 308338707Spfgint pthread_mutex_getprioceiling(const pthread_mutex_t * __restrict, 309338707Spfg int * __restrict); 310338707Spfgint pthread_mutex_setprioceiling(pthread_mutex_t * __restrict, int, 311338707Spfg int * __restrict); 31244965Sjb 313338707Spfgint pthread_mutexattr_getprotocol( 314338707Spfg const pthread_mutexattr_t * __restrict, 315338707Spfg int * __restrict); 31693032Simpint pthread_mutexattr_setprotocol(pthread_mutexattr_t *, int); 31744965Sjb 318315282Spfgint pthread_mutexattr_getrobust( 319332308Spfg pthread_mutexattr_t * __restrict, int * __restrict); 320332308Spfgint pthread_mutexattr_setrobust(pthread_mutexattr_t *, int); 321300043Skib 322338707Spfgint pthread_attr_getinheritsched(const pthread_attr_t * __restrict, 323338707Spfg int * __restrict); 324332308Spfgint pthread_attr_getschedparam(const pthread_attr_t *, 325332308Spfg struct sched_param *); 326338707Spfgint pthread_attr_getschedpolicy(const pthread_attr_t * __restrict, 327338707Spfg int * __restrict); 328338707Spfgint pthread_attr_getscope(const pthread_attr_t * __restrict, 329338707Spfg int * __restrict); 33093032Simpint pthread_attr_setinheritsched(pthread_attr_t *, int); 331332308Spfgint pthread_attr_setschedparam(pthread_attr_t *, 332332308Spfg const struct sched_param *); 333332308Spfgint pthread_attr_setschedpolicy(pthread_attr_t *, int); 334332308Spfgint pthread_attr_setscope(pthread_attr_t *, int); 335338707Spfgint pthread_getschedparam(pthread_t pthread, int * __restrict, 336338707Spfg struct sched_param * __restrict); 33793032Simpint pthread_setschedparam(pthread_t, int, 338332308Spfg const struct sched_param *); 339189828Sdas#if __XSI_VISIBLE 340113729Sjdpint pthread_getconcurrency(void); 341113729Sjdpint pthread_setconcurrency(int); 342189828Sdas#endif 343179662Sdavidxu 344179662Sdavidxuvoid __pthread_cleanup_push_imp(void (*)(void *), void *, 345179662Sdavidxu struct _pthread_cleanup_info *); 346179662Sdavidxuvoid __pthread_cleanup_pop_imp(int); 34713547Sjulian__END_DECLS 34813547Sjulian 349331190Seadler#endif /* !_PTHREAD_H_ */ 350