pthread.h revision 146824
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 146824 2005-05-31 15:18:17Z rodrigc $ 34 */ 35#ifndef _PTHREAD_H_ 36#define _PTHREAD_H_ 37 38/* 39 * Header files. 40 */ 41#include <sys/cdefs.h> 42#include <sys/types.h> 43#include <sys/_pthreadtypes.h> 44#include <sys/time.h> 45#include <sys/signal.h> 46#include <limits.h> 47#include <sched.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_COND_INITIALIZER NULL 102#define PTHREAD_RWLOCK_INITIALIZER NULL 103 104/* 105 * Default attribute arguments (draft 4, deprecated). 106 */ 107#ifndef PTHREAD_KERNEL 108#define pthread_condattr_default NULL 109#define pthread_mutexattr_default NULL 110#define pthread_attr_default NULL 111#endif 112 113#define PTHREAD_PRIO_NONE 0 114#define PTHREAD_PRIO_INHERIT 1 115#define PTHREAD_PRIO_PROTECT 2 116 117/* 118 * Mutex types (Single UNIX Specification, Version 2, 1997). 119 * 120 * Note that a mutex attribute with one of the following types: 121 * 122 * PTHREAD_MUTEX_NORMAL 123 * PTHREAD_MUTEX_RECURSIVE 124 * MUTEX_TYPE_FAST (deprecated) 125 * MUTEX_TYPE_COUNTING_FAST (deprecated) 126 * 127 * will deviate from POSIX specified semantics. 128 */ 129enum pthread_mutextype { 130 PTHREAD_MUTEX_ERRORCHECK = 1, /* Default POSIX mutex */ 131 PTHREAD_MUTEX_RECURSIVE = 2, /* Recursive mutex */ 132 PTHREAD_MUTEX_NORMAL = 3, /* No error checking */ 133 MUTEX_TYPE_MAX 134}; 135 136#define PTHREAD_MUTEX_DEFAULT PTHREAD_MUTEX_ERRORCHECK 137#define MUTEX_TYPE_FAST PTHREAD_MUTEX_NORMAL 138#define MUTEX_TYPE_COUNTING_FAST PTHREAD_MUTEX_RECURSIVE 139 140/* 141 * Thread function prototype definitions: 142 */ 143__BEGIN_DECLS 144int pthread_atfork(void (*prepare)(void), void (*parent)(void), 145 void (*child)(void)); 146int pthread_attr_destroy(pthread_attr_t *); 147int pthread_attr_getstack(const pthread_attr_t * __restrict, 148 void ** __restrict stackaddr, 149 size_t * __restrict stacksize); 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); 169void pthread_cleanup_pop(int); 170void pthread_cleanup_push(void (*) (void *), void *routine_arg); 171int pthread_condattr_destroy(pthread_condattr_t *); 172int pthread_condattr_init(pthread_condattr_t *); 173int pthread_condattr_getclock(const pthread_condattr_t *, 174 clockid_t *); 175int pthread_condattr_setclock(pthread_condattr_t *, 176 clockid_t); 177 178int pthread_cond_broadcast(pthread_cond_t *); 179int pthread_cond_destroy(pthread_cond_t *); 180int pthread_cond_init(pthread_cond_t *, 181 const pthread_condattr_t *); 182int pthread_cond_signal(pthread_cond_t *); 183int pthread_cond_timedwait(pthread_cond_t *, 184 pthread_mutex_t *, const struct timespec *); 185int pthread_cond_wait(pthread_cond_t *, pthread_mutex_t *); 186int pthread_create(pthread_t *, const pthread_attr_t *, 187 void *(*) (void *), void *); 188int pthread_detach(pthread_t); 189int pthread_equal(pthread_t, pthread_t); 190void pthread_exit(void *) __dead2; 191void *pthread_getspecific(pthread_key_t); 192int pthread_join(pthread_t, void **); 193int pthread_key_create(pthread_key_t *, 194 void (*) (void *)); 195int pthread_key_delete(pthread_key_t); 196int pthread_kill(pthread_t, int); 197int pthread_mutexattr_init(pthread_mutexattr_t *); 198int pthread_mutexattr_destroy(pthread_mutexattr_t *); 199int pthread_mutexattr_gettype(pthread_mutexattr_t *, int *); 200int pthread_mutexattr_settype(pthread_mutexattr_t *, int); 201int pthread_mutex_destroy(pthread_mutex_t *); 202int pthread_mutex_init(pthread_mutex_t *, 203 const pthread_mutexattr_t *); 204int pthread_mutex_lock(pthread_mutex_t *); 205int pthread_mutex_trylock(pthread_mutex_t *); 206int pthread_mutex_timedlock(pthread_mutex_t *, 207 const struct timespec *); 208int pthread_mutex_unlock(pthread_mutex_t *); 209int pthread_once(pthread_once_t *, void (*) (void)); 210int pthread_rwlock_destroy(pthread_rwlock_t *); 211int pthread_rwlock_init(pthread_rwlock_t *, 212 const pthread_rwlockattr_t *); 213int pthread_rwlock_rdlock(pthread_rwlock_t *); 214int pthread_rwlock_timedrdlock(pthread_rwlock_t *, 215 const struct timespec *); 216int pthread_rwlock_timedwrlock(pthread_rwlock_t *, 217 const struct timespec *); 218int pthread_rwlock_tryrdlock(pthread_rwlock_t *); 219int pthread_rwlock_trywrlock(pthread_rwlock_t *); 220int pthread_rwlock_unlock(pthread_rwlock_t *); 221int pthread_rwlock_wrlock(pthread_rwlock_t *); 222int pthread_rwlockattr_init(pthread_rwlockattr_t *); 223int pthread_rwlockattr_getpshared(const pthread_rwlockattr_t *, 224 int *); 225int pthread_rwlockattr_setpshared(pthread_rwlockattr_t *, int); 226int pthread_rwlockattr_destroy(pthread_rwlockattr_t *); 227pthread_t pthread_self(void); 228int pthread_setspecific(pthread_key_t, const void *); 229int pthread_sigmask(int, const sigset_t *, sigset_t *); 230 231int pthread_spin_init(pthread_spinlock_t *, int); 232int pthread_spin_destroy(pthread_spinlock_t *); 233int pthread_spin_lock(pthread_spinlock_t *); 234int pthread_spin_trylock(pthread_spinlock_t *); 235int pthread_spin_unlock(pthread_spinlock_t *); 236int pthread_cancel(pthread_t); 237int pthread_setcancelstate(int, int *); 238int pthread_setcanceltype(int, int *); 239void pthread_testcancel(void); 240 241int pthread_getprio(pthread_t); 242int pthread_setprio(pthread_t, int); 243void pthread_yield(void); 244 245int pthread_mutexattr_getprioceiling(pthread_mutexattr_t *, 246 int *); 247int pthread_mutexattr_setprioceiling(pthread_mutexattr_t *, 248 int); 249int pthread_mutex_getprioceiling(pthread_mutex_t *, int *); 250int pthread_mutex_setprioceiling(pthread_mutex_t *, int, int *); 251 252int pthread_mutexattr_getprotocol(pthread_mutexattr_t *, int *); 253int pthread_mutexattr_setprotocol(pthread_mutexattr_t *, int); 254 255int pthread_attr_getinheritsched(const pthread_attr_t *, int *); 256int pthread_attr_getschedparam(const pthread_attr_t *, 257 struct sched_param *); 258int pthread_attr_getschedpolicy(const pthread_attr_t *, int *); 259int pthread_attr_getscope(const pthread_attr_t *, int *); 260int pthread_attr_setinheritsched(pthread_attr_t *, int); 261int pthread_attr_setschedparam(pthread_attr_t *, 262 const struct sched_param *); 263int pthread_attr_setschedpolicy(pthread_attr_t *, int); 264int pthread_attr_setscope(pthread_attr_t *, int); 265int pthread_getschedparam(pthread_t pthread, int *, 266 struct sched_param *); 267int pthread_setschedparam(pthread_t, int, 268 const struct sched_param *); 269int pthread_getconcurrency(void); 270int pthread_setconcurrency(int); 271__END_DECLS 272 273#endif 274