pthread.h revision 281130
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: head/include/pthread.h 281130 2015-04-06 01:39:16Z pfg $ 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 * Flags for read/write lock 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 138struct _pthread_cleanup_info { 139 __uintptr_t pthread_cleanup_pad[8]; 140}; 141 142/* 143 * Thread function prototype definitions: 144 */ 145__BEGIN_DECLS 146int pthread_atfork(void (*)(void), void (*)(void), void (*)(void)); 147int pthread_attr_destroy(pthread_attr_t *) __nonnull(1); 148int pthread_attr_getstack(const pthread_attr_t * __restrict, 149 void ** __restrict, size_t * __restrict) 150 __nonnull_all; 151int pthread_attr_getstacksize(const pthread_attr_t *, size_t *) 152 __nonnull_all; 153int pthread_attr_getguardsize(const pthread_attr_t *, size_t *); 154int pthread_attr_getstackaddr(const pthread_attr_t *, void **); 155int pthread_attr_getdetachstate(const pthread_attr_t *, int *) 156 __nonnull_all; 157int pthread_attr_init(pthread_attr_t *) __nonnull(1); 158int pthread_attr_setstacksize(pthread_attr_t *, size_t) 159 __nonnull(1); 160int pthread_attr_setguardsize(pthread_attr_t *, size_t) 161 __nonnull(1); 162int pthread_attr_setstack(pthread_attr_t *, void *, size_t) 163 __nonnull(1); 164int pthread_attr_setstackaddr(pthread_attr_t *, void *); 165int pthread_attr_setdetachstate(pthread_attr_t *, int) __nonnull(1); 166int pthread_barrier_destroy(pthread_barrier_t *); 167int pthread_barrier_init(pthread_barrier_t *, 168 const pthread_barrierattr_t *, unsigned); 169int pthread_barrier_wait(pthread_barrier_t *); 170int pthread_barrierattr_destroy(pthread_barrierattr_t *); 171int pthread_barrierattr_getpshared(const pthread_barrierattr_t *, 172 int *); 173int pthread_barrierattr_init(pthread_barrierattr_t *) __nonnull(1); 174int pthread_barrierattr_setpshared(pthread_barrierattr_t *, int); 175 176#define pthread_cleanup_push(cleanup_routine, cleanup_arg) \ 177 { \ 178 struct _pthread_cleanup_info __cleanup_info__; \ 179 __pthread_cleanup_push_imp(cleanup_routine, cleanup_arg,\ 180 &__cleanup_info__); \ 181 { 182 183#define pthread_cleanup_pop(execute) \ 184 (void)0; \ 185 } \ 186 __pthread_cleanup_pop_imp(execute); \ 187 } 188 189int pthread_condattr_destroy(pthread_condattr_t *) __nonnull(1); 190int pthread_condattr_getclock(const pthread_condattr_t *, 191 clockid_t *) __nonnull_all; 192int pthread_condattr_getpshared(const pthread_condattr_t *, int *) 193 __nonnull_all; 194int pthread_condattr_init(pthread_condattr_t *) __nonnull(1); 195int pthread_condattr_setclock(pthread_condattr_t *, clockid_t) 196 __nonnull(1); 197int pthread_condattr_setpshared(pthread_condattr_t *, int) 198 __nonnull(1); 199int pthread_cond_broadcast(pthread_cond_t *) 200 __nonnull(1); 201int pthread_cond_destroy(pthread_cond_t *) 202 __nonnull(1); 203int pthread_cond_init(pthread_cond_t *, 204 const pthread_condattr_t *) __nonnull(1); 205int pthread_cond_signal(pthread_cond_t *) __nonnull(1); 206int pthread_cond_timedwait(pthread_cond_t *, 207 pthread_mutex_t *__mutex, const struct timespec *) 208 __nonnull_all __requires_exclusive(*__mutex); 209int pthread_cond_wait(pthread_cond_t *, pthread_mutex_t *__mutex) 210 __nonnull_all __requires_exclusive(*__mutex); 211int pthread_create(pthread_t *, const pthread_attr_t *, 212 void *(*) (void *), void *) __nonnull(1) __nonnull(3); 213int pthread_detach(pthread_t); 214int pthread_equal(pthread_t, pthread_t); 215void pthread_exit(void *) __dead2; 216void *pthread_getspecific(pthread_key_t); 217int pthread_getcpuclockid(pthread_t, clockid_t *) __nonnull(2); 218int pthread_join(pthread_t, void **); 219int pthread_key_create(pthread_key_t *, 220 void (*) (void *)) __nonnull(1); 221int pthread_key_delete(pthread_key_t); 222int pthread_mutexattr_init(pthread_mutexattr_t *) __nonnull(1); 223int pthread_mutexattr_destroy(pthread_mutexattr_t *) __nonnull(1); 224int pthread_mutexattr_getpshared(const pthread_mutexattr_t *, 225 int *) __nonnull_all; 226int pthread_mutexattr_gettype(pthread_mutexattr_t *, int *) 227 __nonnull_all; 228int pthread_mutexattr_settype(pthread_mutexattr_t *, int) 229 __nonnull(1); 230int pthread_mutexattr_setpshared(pthread_mutexattr_t *, int) 231 __nonnull(1); 232int pthread_mutex_destroy(pthread_mutex_t *__mutex) 233 __nonnull(1) __requires_unlocked(*__mutex); 234int pthread_mutex_init(pthread_mutex_t *__mutex, 235 const pthread_mutexattr_t *) 236 __nonnull(1) __requires_unlocked(*__mutex); 237int pthread_mutex_lock(pthread_mutex_t *__mutex) 238 __nonnull(1) __locks_exclusive(*__mutex); 239int pthread_mutex_trylock(pthread_mutex_t *__mutex) 240 __nonnull(1) __trylocks_exclusive(0, *__mutex); 241int pthread_mutex_timedlock(pthread_mutex_t *__mutex, 242 const struct timespec *) 243 __nonnull_all __trylocks_exclusive(0, *__mutex); 244int pthread_mutex_unlock(pthread_mutex_t *__mutex) 245 __nonnull(1) __unlocks(*__mutex); 246int pthread_once(pthread_once_t *, void (*) (void)) __nonnull_all; 247int pthread_rwlock_destroy(pthread_rwlock_t *__rwlock) 248 __nonnull(1) __requires_unlocked(*__rwlock); 249int pthread_rwlock_init(pthread_rwlock_t *__rwlock, 250 const pthread_rwlockattr_t *) 251 __nonnull(1) __requires_unlocked(*__rwlock); 252int pthread_rwlock_rdlock(pthread_rwlock_t *__rwlock) 253 __nonnull(1) __locks_shared(*__rwlock); 254int pthread_rwlock_timedrdlock(pthread_rwlock_t *__rwlock, 255 const struct timespec *) 256 __nonnull_all __trylocks_shared(0, *__rwlock); 257int pthread_rwlock_timedwrlock(pthread_rwlock_t *__rwlock, 258 const struct timespec *) 259 __nonnull_all __trylocks_exclusive(0, *__rwlock); 260int pthread_rwlock_tryrdlock(pthread_rwlock_t *__rwlock) 261 __nonnull(1) __trylocks_shared(0, *__rwlock); 262int pthread_rwlock_trywrlock(pthread_rwlock_t *__rwlock) 263 __nonnull(1) __trylocks_exclusive(0, *__rwlock); 264int pthread_rwlock_unlock(pthread_rwlock_t *__rwlock) 265 __nonnull(1) __unlocks(*__rwlock); 266int pthread_rwlock_wrlock(pthread_rwlock_t *__rwlock) 267 __nonnull(1) __locks_exclusive(*__rwlock); 268int pthread_rwlockattr_destroy(pthread_rwlockattr_t *) 269 __nonnull(1); 270int pthread_rwlockattr_getkind_np(const pthread_rwlockattr_t *, 271 int *); 272int pthread_rwlockattr_getpshared(const pthread_rwlockattr_t *, 273 int *) __nonnull_all; 274int pthread_rwlockattr_init(pthread_rwlockattr_t *) 275 __nonnull(1); 276int pthread_rwlockattr_setkind_np(pthread_rwlockattr_t *, int); 277int pthread_rwlockattr_setpshared(pthread_rwlockattr_t *, int) 278 __nonnull(1); 279pthread_t pthread_self(void); 280int pthread_setspecific(pthread_key_t, const void *); 281 282int pthread_spin_init(pthread_spinlock_t *__spin, int) 283 __requires_unlocked(*__spin); 284int pthread_spin_destroy(pthread_spinlock_t *__spin) 285 __requires_unlocked(*__spin); 286int pthread_spin_lock(pthread_spinlock_t *__spin) 287 __locks_exclusive(*__spin); 288int pthread_spin_trylock(pthread_spinlock_t *__spin) 289 __trylocks_exclusive(0, *__spin); 290int pthread_spin_unlock(pthread_spinlock_t *__spin) 291 __unlocks(*__spin); 292int pthread_cancel(pthread_t); 293int pthread_setcancelstate(int, int *); 294int pthread_setcanceltype(int, int *); 295void pthread_testcancel(void); 296 297#if __BSD_VISIBLE 298int pthread_getprio(pthread_t); 299int pthread_setprio(pthread_t, int); 300void pthread_yield(void); 301#endif 302 303int pthread_mutexattr_getprioceiling(pthread_mutexattr_t *, 304 int *); 305int pthread_mutexattr_setprioceiling(pthread_mutexattr_t *, 306 int); 307int pthread_mutex_getprioceiling(pthread_mutex_t *, int *); 308int pthread_mutex_setprioceiling(pthread_mutex_t *, int, int *); 309 310int pthread_mutexattr_getprotocol(pthread_mutexattr_t *, int *); 311int pthread_mutexattr_setprotocol(pthread_mutexattr_t *, int); 312 313int pthread_attr_getinheritsched(const pthread_attr_t *, int *); 314int pthread_attr_getschedparam(const pthread_attr_t *, 315 struct sched_param *) __nonnull_all; 316int pthread_attr_getschedpolicy(const pthread_attr_t *, int *) 317 __nonnull_all; 318int pthread_attr_getscope(const pthread_attr_t *, int *) 319 __nonnull_all; 320int pthread_attr_setinheritsched(pthread_attr_t *, int); 321int pthread_attr_setschedparam(pthread_attr_t *, 322 const struct sched_param *) __nonnull(1) __nonnull(2); 323int pthread_attr_setschedpolicy(pthread_attr_t *, int) __nonnull(1); 324int pthread_attr_setscope(pthread_attr_t *, int) __nonnull(1); 325int pthread_getschedparam(pthread_t pthread, int *, 326 struct sched_param *) __nonnull(2) __nonnull(3); 327int pthread_setschedparam(pthread_t, int, 328 const struct sched_param *) __nonnull(3); 329#if __XSI_VISIBLE 330int pthread_getconcurrency(void); 331int pthread_setconcurrency(int); 332#endif 333 334void __pthread_cleanup_push_imp(void (*)(void *), void *, 335 struct _pthread_cleanup_info *); 336void __pthread_cleanup_pop_imp(int); 337__END_DECLS 338 339#endif 340