pthread.h revision 303975
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: releng/11.0/include/pthread.h 300043 2016-05-17 09:56:22Z kib $ 34 */ 35#ifndef _PTHREAD_H_ 36#define _PTHREAD_H_ 37 38/* 39 * Header files. 40 */ 41#include <sys/cdefs.h> 42#include <sys/_pthreadtypes.h> 43#include <machine/_limits.h> 44#include <machine/_types.h> 45#include <sys/_sigset.h> 46#include <sched.h> 47#include <time.h> 48 49/* 50 * Run-time invariant values: 51 */ 52#define PTHREAD_DESTRUCTOR_ITERATIONS 4 53#define PTHREAD_KEYS_MAX 256 54#define PTHREAD_STACK_MIN __MINSIGSTKSZ 55#define PTHREAD_THREADS_MAX __ULONG_MAX 56#define PTHREAD_BARRIER_SERIAL_THREAD -1 57 58/* 59 * Flags for threads and thread attributes. 60 */ 61#define PTHREAD_DETACHED 0x1 62#define PTHREAD_SCOPE_SYSTEM 0x2 63#define PTHREAD_INHERIT_SCHED 0x4 64#define PTHREAD_NOFLOAT 0x8 65 66#define PTHREAD_CREATE_DETACHED PTHREAD_DETACHED 67#define PTHREAD_CREATE_JOINABLE 0 68#define PTHREAD_SCOPE_PROCESS 0 69#define PTHREAD_EXPLICIT_SCHED 0 70 71/* 72 * Values for process shared/private attributes. 73 */ 74#define PTHREAD_PROCESS_PRIVATE 0 75#define PTHREAD_PROCESS_SHARED 1 76 77/* 78 * Flags for cancelling threads 79 */ 80#define PTHREAD_CANCEL_ENABLE 0 81#define PTHREAD_CANCEL_DISABLE 1 82#define PTHREAD_CANCEL_DEFERRED 0 83#define PTHREAD_CANCEL_ASYNCHRONOUS 2 84#define PTHREAD_CANCELED ((void *) 1) 85 86/* 87 * Flags for once initialization. 88 */ 89#define PTHREAD_NEEDS_INIT 0 90#define PTHREAD_DONE_INIT 1 91 92/* 93 * Static once initialization values. 94 */ 95#define PTHREAD_ONCE_INIT { PTHREAD_NEEDS_INIT, NULL } 96 97/* 98 * Static initialization values. 99 */ 100#define PTHREAD_MUTEX_INITIALIZER NULL 101#define PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP ((pthread_mutex_t)1) 102#define PTHREAD_COND_INITIALIZER NULL 103#define PTHREAD_RWLOCK_INITIALIZER NULL 104 105/* 106 * Default attribute arguments (draft 4, deprecated). 107 */ 108#ifndef PTHREAD_KERNEL 109#define pthread_condattr_default NULL 110#define pthread_mutexattr_default NULL 111#define pthread_attr_default NULL 112#endif 113 114#define PTHREAD_PRIO_NONE 0 115#define PTHREAD_PRIO_INHERIT 1 116#define PTHREAD_PRIO_PROTECT 2 117 118/* 119 * Mutex types (Single UNIX Specification, Version 2, 1997). 120 * 121 * Note that a mutex attribute with one of the following types: 122 * 123 * PTHREAD_MUTEX_NORMAL 124 * PTHREAD_MUTEX_RECURSIVE 125 * 126 * will deviate from POSIX specified semantics. 127 */ 128enum pthread_mutextype { 129 PTHREAD_MUTEX_ERRORCHECK = 1, /* Default POSIX mutex */ 130 PTHREAD_MUTEX_RECURSIVE = 2, /* Recursive mutex */ 131 PTHREAD_MUTEX_NORMAL = 3, /* No error checking */ 132 PTHREAD_MUTEX_ADAPTIVE_NP = 4, /* Adaptive mutex, spins briefly before blocking on lock */ 133 PTHREAD_MUTEX_TYPE_MAX 134}; 135 136#define PTHREAD_MUTEX_DEFAULT PTHREAD_MUTEX_ERRORCHECK 137 138#define PTHREAD_MUTEX_STALLED 0 139#define PTHREAD_MUTEX_ROBUST 1 140 141struct _pthread_cleanup_info { 142 __uintptr_t pthread_cleanup_pad[8]; 143}; 144 145/* 146 * Thread function prototype definitions: 147 */ 148__BEGIN_DECLS 149int pthread_atfork(void (*)(void), void (*)(void), void (*)(void)); 150int pthread_attr_destroy(pthread_attr_t *) __nonnull(1); 151int pthread_attr_getstack(const pthread_attr_t * __restrict, 152 void ** __restrict, size_t * __restrict) 153 __nonnull_all; 154int pthread_attr_getstacksize(const pthread_attr_t *, size_t *) 155 __nonnull_all; 156int pthread_attr_getguardsize(const pthread_attr_t *, size_t *); 157int pthread_attr_getstackaddr(const pthread_attr_t *, void **); 158int pthread_attr_getdetachstate(const pthread_attr_t *, int *) 159 __nonnull_all; 160int pthread_attr_init(pthread_attr_t *) __nonnull(1); 161int pthread_attr_setstacksize(pthread_attr_t *, size_t) 162 __nonnull(1); 163int pthread_attr_setguardsize(pthread_attr_t *, size_t) 164 __nonnull(1); 165int pthread_attr_setstack(pthread_attr_t *, void *, size_t) 166 __nonnull(1); 167int pthread_attr_setstackaddr(pthread_attr_t *, void *); 168int pthread_attr_setdetachstate(pthread_attr_t *, int) __nonnull(1); 169int pthread_barrier_destroy(pthread_barrier_t *); 170int pthread_barrier_init(pthread_barrier_t *, 171 const pthread_barrierattr_t *, unsigned); 172int pthread_barrier_wait(pthread_barrier_t *); 173int pthread_barrierattr_destroy(pthread_barrierattr_t *); 174int pthread_barrierattr_getpshared(const pthread_barrierattr_t *, 175 int *); 176int pthread_barrierattr_init(pthread_barrierattr_t *) __nonnull(1); 177int pthread_barrierattr_setpshared(pthread_barrierattr_t *, int); 178 179#define pthread_cleanup_push(cleanup_routine, cleanup_arg) \ 180 { \ 181 struct _pthread_cleanup_info __cleanup_info__; \ 182 __pthread_cleanup_push_imp(cleanup_routine, cleanup_arg,\ 183 &__cleanup_info__); \ 184 { 185 186#define pthread_cleanup_pop(execute) \ 187 (void)0; \ 188 } \ 189 __pthread_cleanup_pop_imp(execute); \ 190 } 191 192int pthread_condattr_destroy(pthread_condattr_t *) __nonnull(1); 193int pthread_condattr_getclock(const pthread_condattr_t *, 194 clockid_t *) __nonnull_all; 195int pthread_condattr_getpshared(const pthread_condattr_t *, int *) 196 __nonnull_all; 197int pthread_condattr_init(pthread_condattr_t *) __nonnull(1); 198int pthread_condattr_setclock(pthread_condattr_t *, clockid_t) 199 __nonnull(1); 200int pthread_condattr_setpshared(pthread_condattr_t *, int) 201 __nonnull(1); 202int pthread_cond_broadcast(pthread_cond_t *) 203 __nonnull(1); 204int pthread_cond_destroy(pthread_cond_t *) 205 __nonnull(1); 206int pthread_cond_init(pthread_cond_t *, 207 const pthread_condattr_t *) __nonnull(1); 208int pthread_cond_signal(pthread_cond_t *) __nonnull(1); 209int pthread_cond_timedwait(pthread_cond_t *, 210 pthread_mutex_t *__mutex, const struct timespec *) 211 __nonnull_all __requires_exclusive(*__mutex); 212int pthread_cond_wait(pthread_cond_t *, pthread_mutex_t *__mutex) 213 __nonnull_all __requires_exclusive(*__mutex); 214int pthread_create(pthread_t *, const pthread_attr_t *, 215 void *(*) (void *), void *) __nonnull(1) __nonnull(3); 216int pthread_detach(pthread_t); 217int pthread_equal(pthread_t, pthread_t); 218void pthread_exit(void *) __dead2; 219void *pthread_getspecific(pthread_key_t); 220int pthread_getcpuclockid(pthread_t, clockid_t *) __nonnull(2); 221int pthread_join(pthread_t, void **); 222int pthread_key_create(pthread_key_t *, 223 void (*) (void *)) __nonnull(1); 224int pthread_key_delete(pthread_key_t); 225int pthread_mutexattr_init(pthread_mutexattr_t *) __nonnull(1); 226int pthread_mutexattr_destroy(pthread_mutexattr_t *) __nonnull(1); 227int pthread_mutexattr_getpshared(const pthread_mutexattr_t *, 228 int *) __nonnull_all; 229int pthread_mutexattr_gettype(pthread_mutexattr_t *, int *) 230 __nonnull_all; 231int pthread_mutexattr_settype(pthread_mutexattr_t *, int) 232 __nonnull(1); 233int pthread_mutexattr_setpshared(pthread_mutexattr_t *, int) 234 __nonnull(1); 235int pthread_mutex_consistent(pthread_mutex_t *__mutex) 236 __nonnull(1) __requires_exclusive(*__mutex); 237int pthread_mutex_destroy(pthread_mutex_t *__mutex) 238 __nonnull(1) __requires_unlocked(*__mutex); 239int pthread_mutex_init(pthread_mutex_t *__mutex, 240 const pthread_mutexattr_t *) 241 __nonnull(1) __requires_unlocked(*__mutex); 242int pthread_mutex_lock(pthread_mutex_t *__mutex) 243 __nonnull(1) __locks_exclusive(*__mutex); 244int pthread_mutex_trylock(pthread_mutex_t *__mutex) 245 __nonnull(1) __trylocks_exclusive(0, *__mutex); 246int pthread_mutex_timedlock(pthread_mutex_t *__mutex, 247 const struct timespec *) 248 __nonnull_all __trylocks_exclusive(0, *__mutex); 249int pthread_mutex_unlock(pthread_mutex_t *__mutex) 250 __nonnull(1) __unlocks(*__mutex); 251int pthread_once(pthread_once_t *, void (*) (void)) __nonnull_all; 252int pthread_rwlock_destroy(pthread_rwlock_t *__rwlock) 253 __nonnull(1) __requires_unlocked(*__rwlock); 254int pthread_rwlock_init(pthread_rwlock_t *__rwlock, 255 const pthread_rwlockattr_t *) 256 __nonnull(1) __requires_unlocked(*__rwlock); 257int pthread_rwlock_rdlock(pthread_rwlock_t *__rwlock) 258 __nonnull(1) __locks_shared(*__rwlock); 259int pthread_rwlock_timedrdlock(pthread_rwlock_t *__rwlock, 260 const struct timespec *) 261 __nonnull_all __trylocks_shared(0, *__rwlock); 262int pthread_rwlock_timedwrlock(pthread_rwlock_t *__rwlock, 263 const struct timespec *) 264 __nonnull_all __trylocks_exclusive(0, *__rwlock); 265int pthread_rwlock_tryrdlock(pthread_rwlock_t *__rwlock) 266 __nonnull(1) __trylocks_shared(0, *__rwlock); 267int pthread_rwlock_trywrlock(pthread_rwlock_t *__rwlock) 268 __nonnull(1) __trylocks_exclusive(0, *__rwlock); 269int pthread_rwlock_unlock(pthread_rwlock_t *__rwlock) 270 __nonnull(1) __unlocks(*__rwlock); 271int pthread_rwlock_wrlock(pthread_rwlock_t *__rwlock) 272 __nonnull(1) __locks_exclusive(*__rwlock); 273int pthread_rwlockattr_destroy(pthread_rwlockattr_t *) 274 __nonnull(1); 275int pthread_rwlockattr_getkind_np(const pthread_rwlockattr_t *, 276 int *); 277int pthread_rwlockattr_getpshared(const pthread_rwlockattr_t *, 278 int *) __nonnull_all; 279int pthread_rwlockattr_init(pthread_rwlockattr_t *) 280 __nonnull(1); 281int pthread_rwlockattr_setkind_np(pthread_rwlockattr_t *, int); 282int pthread_rwlockattr_setpshared(pthread_rwlockattr_t *, int) 283 __nonnull(1); 284pthread_t pthread_self(void); 285int pthread_setspecific(pthread_key_t, const void *); 286 287int pthread_spin_init(pthread_spinlock_t *__spin, int) 288 __requires_unlocked(*__spin); 289int pthread_spin_destroy(pthread_spinlock_t *__spin) 290 __requires_unlocked(*__spin); 291int pthread_spin_lock(pthread_spinlock_t *__spin) 292 __locks_exclusive(*__spin); 293int pthread_spin_trylock(pthread_spinlock_t *__spin) 294 __trylocks_exclusive(0, *__spin); 295int pthread_spin_unlock(pthread_spinlock_t *__spin) 296 __unlocks(*__spin); 297int pthread_cancel(pthread_t); 298int pthread_setcancelstate(int, int *); 299int pthread_setcanceltype(int, int *); 300void pthread_testcancel(void); 301 302#if __BSD_VISIBLE 303int pthread_getprio(pthread_t); 304int pthread_setprio(pthread_t, int); 305void pthread_yield(void); 306#endif 307 308int pthread_mutexattr_getprioceiling(pthread_mutexattr_t *, 309 int *); 310int pthread_mutexattr_setprioceiling(pthread_mutexattr_t *, 311 int); 312int pthread_mutex_getprioceiling(pthread_mutex_t *, int *); 313int pthread_mutex_setprioceiling(pthread_mutex_t *, int, int *); 314 315int pthread_mutexattr_getprotocol(pthread_mutexattr_t *, int *); 316int pthread_mutexattr_setprotocol(pthread_mutexattr_t *, int); 317 318int pthread_mutexattr_getrobust(pthread_mutexattr_t *__restrict, 319 int *__restrict) __nonnull_all; 320int pthread_mutexattr_setrobust(pthread_mutexattr_t *, int) 321 __nonnull(1); 322 323int pthread_attr_getinheritsched(const pthread_attr_t *, int *); 324int pthread_attr_getschedparam(const pthread_attr_t *, 325 struct sched_param *) __nonnull_all; 326int pthread_attr_getschedpolicy(const pthread_attr_t *, int *) 327 __nonnull_all; 328int pthread_attr_getscope(const pthread_attr_t *, int *) 329 __nonnull_all; 330int pthread_attr_setinheritsched(pthread_attr_t *, int); 331int pthread_attr_setschedparam(pthread_attr_t *, 332 const struct sched_param *) __nonnull(1) __nonnull(2); 333int pthread_attr_setschedpolicy(pthread_attr_t *, int) __nonnull(1); 334int pthread_attr_setscope(pthread_attr_t *, int) __nonnull(1); 335int pthread_getschedparam(pthread_t pthread, int *, 336 struct sched_param *) __nonnull(2) __nonnull(3); 337int pthread_setschedparam(pthread_t, int, 338 const struct sched_param *) __nonnull(3); 339#if __XSI_VISIBLE 340int pthread_getconcurrency(void); 341int pthread_setconcurrency(int); 342#endif 343 344void __pthread_cleanup_push_imp(void (*)(void *), void *, 345 struct _pthread_cleanup_info *); 346void __pthread_cleanup_pop_imp(int); 347__END_DECLS 348 349#endif 350