pthread.h revision 280636
1139749Simp/* 2133589Smarius * Copyright (c) 1993, 1994 by Chris Provenzano, proven@mit.edu 3152683Smarius * Copyright (c) 1995-1998 by John Birrell <jb@cimlogic.com.au> 4133589Smarius * All rights reserved. 5133589Smarius * 6133589Smarius * Redistribution and use in source and binary forms, with or without 7133589Smarius * modification, are permitted provided that the following conditions 8133589Smarius * are met: 9133589Smarius * 1. Redistributions of source code must retain the above copyright 10133589Smarius * notice, this list of conditions and the following disclaimer. 11133589Smarius * 2. Redistributions in binary form must reproduce the above copyright 12133589Smarius * notice, this list of conditions and the following disclaimer in the 13133589Smarius * documentation and/or other materials provided with the distribution. 14133589Smarius * 3. All advertising materials mentioning features or use of this software 15133589Smarius * must display the following acknowledgement: 16133589Smarius * This product includes software developed by Chris Provenzano. 17133589Smarius * 4. The name of Chris Provenzano may not be used to endorse or promote 18133589Smarius * products derived from this software without specific prior written 19133589Smarius * permission. 20133589Smarius * 21133589Smarius * THIS SOFTWARE IS PROVIDED BY CHRIS PROVENZANO ``AS IS'' AND 22133589Smarius * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23133589Smarius * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24133589Smarius * ARE DISCLAIMED. IN NO EVENT SHALL CHRIS PROVENZANO BE LIABLE FOR ANY 25133589Smarius * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 26133589Smarius * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 27133589Smarius * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 28152683Smarius * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 29152683Smarius * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 30152683Smarius * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31152683Smarius * SUCH DAMAGE. 32152683Smarius * 33152683Smarius * $FreeBSD: head/include/pthread.h 280636 2015-03-25 21:53:17Z pfg $ 34152683Smarius */ 35152683Smarius#ifndef _PTHREAD_H_ 36133589Smarius#define _PTHREAD_H_ 37133589Smarius 38133589Smarius/* 39133589Smarius * Header files. 40133589Smarius */ 41133589Smarius#include <sys/cdefs.h> 42152683Smarius#include <sys/_pthreadtypes.h> 43152683Smarius#include <machine/_limits.h> 44152683Smarius#include <machine/_types.h> 45152683Smarius#include <sys/_sigset.h> 46152683Smarius#include <sched.h> 47152683Smarius#include <time.h> 48152683Smarius 49152683Smarius/* 50152683Smarius * Run-time invariant values: 51152683Smarius */ 52133589Smarius#define PTHREAD_DESTRUCTOR_ITERATIONS 4 53152683Smarius#define PTHREAD_KEYS_MAX 256 54133589Smarius#define PTHREAD_STACK_MIN __MINSIGSTKSZ 55133589Smarius#define PTHREAD_THREADS_MAX __ULONG_MAX 56133589Smarius#define PTHREAD_BARRIER_SERIAL_THREAD -1 57133589Smarius 58133589Smarius/* 59133589Smarius * Flags for threads and thread attributes. 60152683Smarius */ 61152683Smarius#define PTHREAD_DETACHED 0x1 62152683Smarius#define PTHREAD_SCOPE_SYSTEM 0x2 63152683Smarius#define PTHREAD_INHERIT_SCHED 0x4 64152683Smarius#define PTHREAD_NOFLOAT 0x8 65152683Smarius 66152683Smarius#define PTHREAD_CREATE_DETACHED PTHREAD_DETACHED 67133589Smarius#define PTHREAD_CREATE_JOINABLE 0 68133589Smarius#define PTHREAD_SCOPE_PROCESS 0 69133589Smarius#define PTHREAD_EXPLICIT_SCHED 0 70133589Smarius 71133589Smarius/* 72133589Smarius * Flags for read/write lock attributes 73133589Smarius */ 74133589Smarius#define PTHREAD_PROCESS_PRIVATE 0 75133589Smarius#define PTHREAD_PROCESS_SHARED 1 76133589Smarius 77133589Smarius/* 78133589Smarius * Flags for cancelling threads 79133589Smarius */ 80133589Smarius#define PTHREAD_CANCEL_ENABLE 0 81133589Smarius#define PTHREAD_CANCEL_DISABLE 1 82133589Smarius#define PTHREAD_CANCEL_DEFERRED 0 83133589Smarius#define PTHREAD_CANCEL_ASYNCHRONOUS 2 84133589Smarius#define PTHREAD_CANCELED ((void *) 1) 85133589Smarius 86133589Smarius/* 87133589Smarius * Flags for once initialization. 88133589Smarius */ 89133589Smarius#define PTHREAD_NEEDS_INIT 0 90133589Smarius#define PTHREAD_DONE_INIT 1 91133589Smarius 92233018Snwhitehorn/* 93133589Smarius * Static once initialization values. 94133589Smarius */ 95133589Smarius#define PTHREAD_ONCE_INIT { PTHREAD_NEEDS_INIT, NULL } 96133589Smarius 97133589Smarius/* 98133589Smarius * Static initialization values. 99133589Smarius */ 100133589Smarius#define PTHREAD_MUTEX_INITIALIZER NULL 101133589Smarius#define PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP ((pthread_mutex_t)1) 102133589Smarius#define PTHREAD_COND_INITIALIZER NULL 103152683Smarius#define PTHREAD_RWLOCK_INITIALIZER NULL 104152683Smarius 105152683Smarius/* 106152683Smarius * Default attribute arguments (draft 4, deprecated). 107152683Smarius */ 108152683Smarius#ifndef PTHREAD_KERNEL 109152683Smarius#define pthread_condattr_default NULL 110152683Smarius#define pthread_mutexattr_default NULL 111152683Smarius#define pthread_attr_default NULL 112133589Smarius#endif 113133589Smarius 114133589Smarius#define PTHREAD_PRIO_NONE 0 115133589Smarius#define PTHREAD_PRIO_INHERIT 1 116133589Smarius#define PTHREAD_PRIO_PROTECT 2 117133589Smarius 118133589Smarius/* 119133589Smarius * Mutex types (Single UNIX Specification, Version 2, 1997). 120133589Smarius * 121133589Smarius * Note that a mutex attribute with one of the following types: 122133589Smarius * 123133589Smarius * PTHREAD_MUTEX_NORMAL 124133589Smarius * PTHREAD_MUTEX_RECURSIVE 125133589Smarius * 126133589Smarius * will deviate from POSIX specified semantics. 127133589Smarius */ 128133589Smariusenum pthread_mutextype { 129133589Smarius PTHREAD_MUTEX_ERRORCHECK = 1, /* Default POSIX mutex */ 130133589Smarius PTHREAD_MUTEX_RECURSIVE = 2, /* Recursive mutex */ 131133589Smarius PTHREAD_MUTEX_NORMAL = 3, /* No error checking */ 132133589Smarius PTHREAD_MUTEX_ADAPTIVE_NP = 4, /* Adaptive mutex, spins briefly before blocking on lock */ 133133589Smarius PTHREAD_MUTEX_TYPE_MAX 134133589Smarius}; 135133589Smarius 136133589Smarius#define PTHREAD_MUTEX_DEFAULT PTHREAD_MUTEX_ERRORCHECK 137133589Smarius 138133589Smariusstruct _pthread_cleanup_info { 139133589Smarius __uintptr_t pthread_cleanup_pad[8]; 140133589Smarius}; 141133589Smarius 142133589Smarius/* 143133589Smarius * Thread function prototype definitions: 144133589Smarius */ 145133589Smarius__BEGIN_DECLS 146int pthread_atfork(void (*)(void), void (*)(void), void (*)(void)); 147int pthread_attr_destroy(pthread_attr_t *); 148int pthread_attr_getstack(const pthread_attr_t * __restrict, 149 void ** __restrict, size_t * __restrict); 150int pthread_attr_getstacksize(const pthread_attr_t *, size_t *); 151int pthread_attr_getguardsize(const pthread_attr_t *, size_t *); 152int pthread_attr_getstackaddr(const pthread_attr_t *, void **); 153int pthread_attr_getdetachstate(const pthread_attr_t *, int *); 154int pthread_attr_init(pthread_attr_t *); 155int pthread_attr_setstacksize(pthread_attr_t *, size_t); 156int pthread_attr_setguardsize(pthread_attr_t *, size_t); 157int pthread_attr_setstack(pthread_attr_t *, void *, size_t); 158int pthread_attr_setstackaddr(pthread_attr_t *, void *); 159int pthread_attr_setdetachstate(pthread_attr_t *, int); 160int pthread_barrier_destroy(pthread_barrier_t *); 161int pthread_barrier_init(pthread_barrier_t *, 162 const pthread_barrierattr_t *, unsigned); 163int pthread_barrier_wait(pthread_barrier_t *); 164int pthread_barrierattr_destroy(pthread_barrierattr_t *); 165int pthread_barrierattr_getpshared(const pthread_barrierattr_t *, 166 int *); 167int pthread_barrierattr_init(pthread_barrierattr_t *); 168int pthread_barrierattr_setpshared(pthread_barrierattr_t *, int); 169 170#define pthread_cleanup_push(cleanup_routine, cleanup_arg) \ 171 { \ 172 struct _pthread_cleanup_info __cleanup_info__; \ 173 __pthread_cleanup_push_imp(cleanup_routine, cleanup_arg,\ 174 &__cleanup_info__); \ 175 { 176 177#define pthread_cleanup_pop(execute) \ 178 (void)0; \ 179 } \ 180 __pthread_cleanup_pop_imp(execute); \ 181 } 182 183int pthread_condattr_destroy(pthread_condattr_t *); 184int pthread_condattr_getclock(const pthread_condattr_t *, 185 clockid_t *); 186int pthread_condattr_getpshared(const pthread_condattr_t *, int *); 187int pthread_condattr_init(pthread_condattr_t *); 188int pthread_condattr_setclock(pthread_condattr_t *, clockid_t); 189int pthread_condattr_setpshared(pthread_condattr_t *, int); 190int pthread_cond_broadcast(pthread_cond_t *); 191int pthread_cond_destroy(pthread_cond_t *); 192int pthread_cond_init(pthread_cond_t *, 193 const pthread_condattr_t *); 194int pthread_cond_signal(pthread_cond_t *); 195int pthread_cond_timedwait(pthread_cond_t *, 196 pthread_mutex_t *__mutex, const struct timespec *) 197 __requires_exclusive(*__mutex); 198int pthread_cond_wait(pthread_cond_t *, pthread_mutex_t *__mutex) 199 __requires_exclusive(*__mutex); 200int pthread_create(pthread_t *, const pthread_attr_t *, 201 void *(*) (void *), void *); 202int pthread_detach(pthread_t); 203int pthread_equal(pthread_t, pthread_t); 204void pthread_exit(void *) __dead2; 205void *pthread_getspecific(pthread_key_t); 206int pthread_getcpuclockid(pthread_t, clockid_t *); 207int pthread_join(pthread_t, void **); 208int pthread_key_create(pthread_key_t *, 209 void (*) (void *)); 210int pthread_key_delete(pthread_key_t); 211int pthread_mutexattr_init(pthread_mutexattr_t *); 212int pthread_mutexattr_destroy(pthread_mutexattr_t *); 213int pthread_mutexattr_getpshared(const pthread_mutexattr_t *, 214 int *); 215int pthread_mutexattr_gettype(pthread_mutexattr_t *, int *); 216int pthread_mutexattr_settype(pthread_mutexattr_t *, int); 217int pthread_mutexattr_setpshared(pthread_mutexattr_t *, int); 218int pthread_mutex_destroy(pthread_mutex_t *__mutex) 219 __requires_unlocked(*__mutex); 220int pthread_mutex_init(pthread_mutex_t *__mutex, 221 const pthread_mutexattr_t *) 222 __requires_unlocked(*__mutex); 223int pthread_mutex_lock(pthread_mutex_t *__mutex) 224 __locks_exclusive(*__mutex); 225int pthread_mutex_trylock(pthread_mutex_t *__mutex) 226 __trylocks_exclusive(0, *__mutex); 227int pthread_mutex_timedlock(pthread_mutex_t *__mutex, 228 const struct timespec *) 229 __trylocks_exclusive(0, *__mutex); 230int pthread_mutex_unlock(pthread_mutex_t *__mutex) 231 __unlocks(*__mutex); 232int pthread_once(pthread_once_t *, void (*) (void)); 233int pthread_rwlock_destroy(pthread_rwlock_t *__rwlock) 234 __requires_unlocked(*__rwlock); 235int pthread_rwlock_init(pthread_rwlock_t *__rwlock, 236 const pthread_rwlockattr_t *) 237 __requires_unlocked(*__rwlock); 238int pthread_rwlock_rdlock(pthread_rwlock_t *__rwlock) 239 __locks_shared(*__rwlock); 240int pthread_rwlock_timedrdlock(pthread_rwlock_t *__rwlock, 241 const struct timespec *) 242 __trylocks_shared(0, *__rwlock); 243int pthread_rwlock_timedwrlock(pthread_rwlock_t *__rwlock, 244 const struct timespec *) 245 __trylocks_exclusive(0, *__rwlock); 246int pthread_rwlock_tryrdlock(pthread_rwlock_t *__rwlock) 247 __trylocks_shared(0, *__rwlock); 248int pthread_rwlock_trywrlock(pthread_rwlock_t *__rwlock) 249 __trylocks_exclusive(0, *__rwlock); 250int pthread_rwlock_unlock(pthread_rwlock_t *__rwlock) 251 __unlocks(*__rwlock); 252int pthread_rwlock_wrlock(pthread_rwlock_t *__rwlock) 253 __locks_exclusive(*__rwlock); 254int pthread_rwlockattr_destroy(pthread_rwlockattr_t *); 255int pthread_rwlockattr_getkind_np(const pthread_rwlockattr_t *, 256 int *); 257int pthread_rwlockattr_getpshared(const pthread_rwlockattr_t *, 258 int *); 259int pthread_rwlockattr_init(pthread_rwlockattr_t *); 260int pthread_rwlockattr_setkind_np(pthread_rwlockattr_t *, int); 261int pthread_rwlockattr_setpshared(pthread_rwlockattr_t *, int); 262pthread_t pthread_self(void); 263int pthread_setspecific(pthread_key_t, const void *); 264 265int pthread_spin_init(pthread_spinlock_t *__spin, int) 266 __requires_unlocked(*__spin); 267int pthread_spin_destroy(pthread_spinlock_t *__spin) 268 __requires_unlocked(*__spin); 269int pthread_spin_lock(pthread_spinlock_t *__spin) 270 __locks_exclusive(*__spin); 271int pthread_spin_trylock(pthread_spinlock_t *__spin) 272 __trylocks_exclusive(0, *__spin); 273int pthread_spin_unlock(pthread_spinlock_t *__spin) 274 __unlocks(*__spin); 275int pthread_cancel(pthread_t); 276int pthread_setcancelstate(int, int *); 277int pthread_setcanceltype(int, int *); 278void pthread_testcancel(void); 279 280#if __BSD_VISIBLE 281int pthread_getprio(pthread_t); 282int pthread_setprio(pthread_t, int); 283void pthread_yield(void); 284#endif 285 286int pthread_mutexattr_getprioceiling(pthread_mutexattr_t *, 287 int *); 288int pthread_mutexattr_setprioceiling(pthread_mutexattr_t *, 289 int); 290int pthread_mutex_getprioceiling(pthread_mutex_t *, int *); 291int pthread_mutex_setprioceiling(pthread_mutex_t *, int, int *); 292 293int pthread_mutexattr_getprotocol(pthread_mutexattr_t *, int *); 294int pthread_mutexattr_setprotocol(pthread_mutexattr_t *, int); 295 296int pthread_attr_getinheritsched(const pthread_attr_t *, int *); 297int pthread_attr_getschedparam(const pthread_attr_t *, 298 struct sched_param *); 299int pthread_attr_getschedpolicy(const pthread_attr_t *, int *); 300int pthread_attr_getscope(const pthread_attr_t *, int *); 301int pthread_attr_setinheritsched(pthread_attr_t *, int); 302int pthread_attr_setschedparam(pthread_attr_t *, 303 const struct sched_param *); 304int pthread_attr_setschedpolicy(pthread_attr_t *, int); 305int pthread_attr_setscope(pthread_attr_t *, int); 306int pthread_getschedparam(pthread_t pthread, int *, 307 struct sched_param *); 308int pthread_setschedparam(pthread_t, int, 309 const struct sched_param *); 310#if __XSI_VISIBLE 311int pthread_getconcurrency(void); 312int pthread_setconcurrency(int); 313#endif 314 315void __pthread_cleanup_push_imp(void (*)(void *), void *, 316 struct _pthread_cleanup_info *); 317void __pthread_cleanup_pop_imp(int); 318__END_DECLS 319 320#endif 321