pthread.h revision 214007
113547Sjulian/* 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: head/include/pthread.h 214007 2010-10-18 05:09:22Z davidxu $ 3413547Sjulian */ 3513547Sjulian#ifndef _PTHREAD_H_ 3613547Sjulian#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 */ 5217706Sjulian#define PTHREAD_DESTRUCTOR_ITERATIONS 4 5317706Sjulian#define PTHREAD_KEYS_MAX 256 54149692Sstefanf#define PTHREAD_STACK_MIN __MINSIGSTKSZ 55149692Sstefanf#define PTHREAD_THREADS_MAX __ULONG_MAX 56119736Sdavidxu#define PTHREAD_BARRIER_SERIAL_THREAD -1 5713547Sjulian 5813547Sjulian/* 5922315Sjulian * Flags for threads and thread attributes. 6022315Sjulian */ 6122315Sjulian#define PTHREAD_DETACHED 0x1 6222315Sjulian#define PTHREAD_SCOPE_SYSTEM 0x2 6322315Sjulian#define PTHREAD_INHERIT_SCHED 0x4 6422315Sjulian#define PTHREAD_NOFLOAT 0x8 6522315Sjulian 6622315Sjulian#define PTHREAD_CREATE_DETACHED PTHREAD_DETACHED 6722315Sjulian#define PTHREAD_CREATE_JOINABLE 0 6822315Sjulian#define PTHREAD_SCOPE_PROCESS 0 6922315Sjulian#define PTHREAD_EXPLICIT_SCHED 0 7022315Sjulian 7122315Sjulian/* 7238919Salex * Flags for read/write lock attributes 7338919Salex */ 7438919Salex#define PTHREAD_PROCESS_PRIVATE 0 7538919Salex#define PTHREAD_PROCESS_SHARED 1 7638919Salex 7738919Salex/* 7853812Salfred * Flags for cancelling threads 7953812Salfred */ 8053812Salfred#define PTHREAD_CANCEL_ENABLE 0 8153812Salfred#define PTHREAD_CANCEL_DISABLE 1 8253812Salfred#define PTHREAD_CANCEL_DEFERRED 0 8353812Salfred#define PTHREAD_CANCEL_ASYNCHRONOUS 2 8453812Salfred#define PTHREAD_CANCELED ((void *) 1) 8553812Salfred 8653812Salfred/* 8713547Sjulian * Flags for once initialization. 8813547Sjulian */ 8913547Sjulian#define PTHREAD_NEEDS_INIT 0 9013547Sjulian#define PTHREAD_DONE_INIT 1 9113547Sjulian 9213547Sjulian/* 9313547Sjulian * Static once initialization values. 9413547Sjulian */ 9517706Sjulian#define PTHREAD_ONCE_INIT { PTHREAD_NEEDS_INIT, NULL } 9613547Sjulian 9713547Sjulian/* 9835025Sjb * Static initialization values. 9913547Sjulian */ 10035025Sjb#define PTHREAD_MUTEX_INITIALIZER NULL 101213241Sdavidxu#define PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP ((pthread_mutex_t)1) 10235025Sjb#define PTHREAD_COND_INITIALIZER NULL 10338919Salex#define PTHREAD_RWLOCK_INITIALIZER NULL 10435025Sjb 10535025Sjb/* 10635025Sjb * Default attribute arguments (draft 4, deprecated). 10735025Sjb */ 10822315Sjulian#ifndef PTHREAD_KERNEL 10913547Sjulian#define pthread_condattr_default NULL 11013547Sjulian#define pthread_mutexattr_default NULL 11113547Sjulian#define pthread_attr_default NULL 11213547Sjulian#endif 11313547Sjulian 11444965Sjb#define PTHREAD_PRIO_NONE 0 11544965Sjb#define PTHREAD_PRIO_INHERIT 1 11644965Sjb#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 13644965Sjb#define PTHREAD_MUTEX_DEFAULT PTHREAD_MUTEX_ERRORCHECK 13741390Seivind 138214007Sdavidxuenum pthread_rwlocktype_np 139214007Sdavidxu{ 140214007Sdavidxu PTHREAD_RWLOCK_PREFER_READER_NP, 141214007Sdavidxu PTHREAD_RWLOCK_PREFER_WRITER_NONRECURSIVE_NP, 142214007Sdavidxu PTHREAD_RWLOCK_PREFER_WRITER_NP, 143214007Sdavidxu PTHREAD_RWLOCK_DEFAULT_NP = 144214007Sdavidxu PTHREAD_RWLOCK_PREFER_WRITER_NONRECURSIVE_NP 145214007Sdavidxu}; 146214007Sdavidxu 147179662Sdavidxustruct _pthread_cleanup_info { 148179662Sdavidxu __uintptr_t pthread_cleanup_pad[8]; 149179662Sdavidxu}; 150179662Sdavidxu 15113547Sjulian/* 15213547Sjulian * Thread function prototype definitions: 15313547Sjulian */ 15413547Sjulian__BEGIN_DECLS 155149273Sstefanfint pthread_atfork(void (*)(void), void (*)(void), void (*)(void)); 15693032Simpint pthread_attr_destroy(pthread_attr_t *); 157110636Salfredint pthread_attr_getstack(const pthread_attr_t * __restrict, 158149273Sstefanf void ** __restrict, size_t * __restrict); 15993032Simpint pthread_attr_getstacksize(const pthread_attr_t *, size_t *); 16093032Simpint pthread_attr_getguardsize(const pthread_attr_t *, size_t *); 16193032Simpint pthread_attr_getstackaddr(const pthread_attr_t *, void **); 16293032Simpint pthread_attr_getdetachstate(const pthread_attr_t *, int *); 16393032Simpint pthread_attr_init(pthread_attr_t *); 16493032Simpint pthread_attr_setstacksize(pthread_attr_t *, size_t); 16593032Simpint pthread_attr_setguardsize(pthread_attr_t *, size_t); 166110636Salfredint pthread_attr_setstack(pthread_attr_t *, void *, size_t); 16793032Simpint pthread_attr_setstackaddr(pthread_attr_t *, void *); 16893032Simpint pthread_attr_setdetachstate(pthread_attr_t *, int); 169119736Sdavidxuint pthread_barrier_destroy(pthread_barrier_t *); 170119736Sdavidxuint pthread_barrier_init(pthread_barrier_t *, 171119736Sdavidxu const pthread_barrierattr_t *, unsigned); 172119736Sdavidxuint pthread_barrier_wait(pthread_barrier_t *); 173119736Sdavidxuint pthread_barrierattr_destroy(pthread_barrierattr_t *); 174119736Sdavidxuint pthread_barrierattr_getpshared(const pthread_barrierattr_t *, 175119736Sdavidxu int *); 176119736Sdavidxuint pthread_barrierattr_init(pthread_barrierattr_t *); 177119736Sdavidxuint pthread_barrierattr_setpshared(pthread_barrierattr_t *, int); 178179662Sdavidxu 179179662Sdavidxu#define pthread_cleanup_push(cleanup_routine, cleanup_arg) \ 180179662Sdavidxu { \ 181179662Sdavidxu struct _pthread_cleanup_info __cleanup_info__; \ 182179662Sdavidxu __pthread_cleanup_push_imp(cleanup_routine, cleanup_arg,\ 183179662Sdavidxu &__cleanup_info__); \ 184179662Sdavidxu { 185179662Sdavidxu 186179662Sdavidxu#define pthread_cleanup_pop(execute) \ 187179662Sdavidxu } \ 188179662Sdavidxu __pthread_cleanup_pop_imp(execute); \ 189179662Sdavidxu } 190179662Sdavidxu 19193032Simpint pthread_condattr_destroy(pthread_condattr_t *); 192151617Sdavidxuint pthread_condattr_getclock(const pthread_condattr_t *, 193151617Sdavidxu clockid_t *); 194151617Sdavidxuint pthread_condattr_getpshared(const pthread_condattr_t *, int *); 19593032Simpint pthread_condattr_init(pthread_condattr_t *); 196151617Sdavidxuint pthread_condattr_setclock(pthread_condattr_t *, clockid_t); 197151617Sdavidxuint pthread_condattr_setpshared(pthread_condattr_t *, int); 19893032Simpint pthread_cond_broadcast(pthread_cond_t *); 19993032Simpint pthread_cond_destroy(pthread_cond_t *); 20093032Simpint pthread_cond_init(pthread_cond_t *, 20193032Simp const pthread_condattr_t *); 20293032Simpint pthread_cond_signal(pthread_cond_t *); 20393032Simpint pthread_cond_timedwait(pthread_cond_t *, 20493032Simp pthread_mutex_t *, const struct timespec *); 20593032Simpint pthread_cond_wait(pthread_cond_t *, pthread_mutex_t *); 20693032Simpint pthread_create(pthread_t *, const pthread_attr_t *, 20793032Simp void *(*) (void *), void *); 20893032Simpint pthread_detach(pthread_t); 20993032Simpint pthread_equal(pthread_t, pthread_t); 21093032Simpvoid pthread_exit(void *) __dead2; 21193032Simpvoid *pthread_getspecific(pthread_key_t); 212177494Sdavidxuint pthread_getcpuclockid(pthread_t, clockid_t *); 21393032Simpint pthread_join(pthread_t, void **); 21493032Simpint pthread_key_create(pthread_key_t *, 21593032Simp void (*) (void *)); 21693032Simpint pthread_key_delete(pthread_key_t); 21793032Simpint pthread_mutexattr_init(pthread_mutexattr_t *); 21893032Simpint pthread_mutexattr_destroy(pthread_mutexattr_t *); 219151617Sdavidxuint pthread_mutexattr_getpshared(const pthread_mutexattr_t *, 220151617Sdavidxu int *); 22193032Simpint pthread_mutexattr_gettype(pthread_mutexattr_t *, int *); 22293032Simpint pthread_mutexattr_settype(pthread_mutexattr_t *, int); 223151617Sdavidxuint pthread_mutexattr_setpshared(pthread_mutexattr_t *, int); 22493032Simpint pthread_mutex_destroy(pthread_mutex_t *); 22593032Simpint pthread_mutex_init(pthread_mutex_t *, 22693032Simp const pthread_mutexattr_t *); 22793032Simpint pthread_mutex_lock(pthread_mutex_t *); 22893032Simpint pthread_mutex_trylock(pthread_mutex_t *); 229119736Sdavidxuint pthread_mutex_timedlock(pthread_mutex_t *, 230119736Sdavidxu const struct timespec *); 23193032Simpint pthread_mutex_unlock(pthread_mutex_t *); 23293032Simpint pthread_once(pthread_once_t *, void (*) (void)); 23393032Simpint pthread_rwlock_destroy(pthread_rwlock_t *); 23493032Simpint pthread_rwlock_init(pthread_rwlock_t *, 23593032Simp const pthread_rwlockattr_t *); 23693032Simpint pthread_rwlock_rdlock(pthread_rwlock_t *); 237119790Sdavidxuint pthread_rwlock_timedrdlock(pthread_rwlock_t *, 238119790Sdavidxu const struct timespec *); 239139902Sdavidxuint pthread_rwlock_timedwrlock(pthread_rwlock_t *, 240119790Sdavidxu const struct timespec *); 24193032Simpint pthread_rwlock_tryrdlock(pthread_rwlock_t *); 24293032Simpint pthread_rwlock_trywrlock(pthread_rwlock_t *); 24393032Simpint pthread_rwlock_unlock(pthread_rwlock_t *); 24493032Simpint pthread_rwlock_wrlock(pthread_rwlock_t *); 245214007Sdavidxuint pthread_rwlockattr_destroy(pthread_rwlockattr_t *); 246214007Sdavidxuint pthread_rwlockattr_getkind_np(const pthread_rwlockattr_t *, 247214007Sdavidxu int *); 24893032Simpint pthread_rwlockattr_getpshared(const pthread_rwlockattr_t *, 24993032Simp int *); 250214007Sdavidxuint pthread_rwlockattr_init(pthread_rwlockattr_t *); 251214007Sdavidxuint pthread_rwlockattr_setkind_np(pthread_rwlockattr_t *, int); 25293032Simpint pthread_rwlockattr_setpshared(pthread_rwlockattr_t *, int); 25393032Simppthread_t pthread_self(void); 25493032Simpint pthread_setspecific(pthread_key_t, const void *); 25517706Sjulian 256119909Sdavidxuint pthread_spin_init(pthread_spinlock_t *, int); 257119909Sdavidxuint pthread_spin_destroy(pthread_spinlock_t *); 258119909Sdavidxuint pthread_spin_lock(pthread_spinlock_t *); 259119909Sdavidxuint pthread_spin_trylock(pthread_spinlock_t *); 260119909Sdavidxuint pthread_spin_unlock(pthread_spinlock_t *); 26193032Simpint pthread_cancel(pthread_t); 26293032Simpint pthread_setcancelstate(int, int *); 26393032Simpint pthread_setcanceltype(int, int *); 26493032Simpvoid pthread_testcancel(void); 26517706Sjulian 266189828Sdas#if __BSD_VISIBLE 26793032Simpint pthread_getprio(pthread_t); 26893032Simpint pthread_setprio(pthread_t, int); 26993032Simpvoid pthread_yield(void); 270189828Sdas#endif 27144965Sjb 27293032Simpint pthread_mutexattr_getprioceiling(pthread_mutexattr_t *, 27393032Simp int *); 27493032Simpint pthread_mutexattr_setprioceiling(pthread_mutexattr_t *, 27593032Simp int); 27693032Simpint pthread_mutex_getprioceiling(pthread_mutex_t *, int *); 27793032Simpint pthread_mutex_setprioceiling(pthread_mutex_t *, int, int *); 27844965Sjb 27993032Simpint pthread_mutexattr_getprotocol(pthread_mutexattr_t *, int *); 28093032Simpint pthread_mutexattr_setprotocol(pthread_mutexattr_t *, int); 28144965Sjb 28293032Simpint pthread_attr_getinheritsched(const pthread_attr_t *, int *); 28393032Simpint pthread_attr_getschedparam(const pthread_attr_t *, 28493032Simp struct sched_param *); 28593032Simpint pthread_attr_getschedpolicy(const pthread_attr_t *, int *); 28693032Simpint pthread_attr_getscope(const pthread_attr_t *, int *); 28793032Simpint pthread_attr_setinheritsched(pthread_attr_t *, int); 28893032Simpint pthread_attr_setschedparam(pthread_attr_t *, 28993032Simp const struct sched_param *); 29093032Simpint pthread_attr_setschedpolicy(pthread_attr_t *, int); 29193032Simpint pthread_attr_setscope(pthread_attr_t *, int); 29293032Simpint pthread_getschedparam(pthread_t pthread, int *, 29393032Simp struct sched_param *); 29493032Simpint pthread_setschedparam(pthread_t, int, 29593032Simp const struct sched_param *); 296189828Sdas#if __XSI_VISIBLE 297113729Sjdpint pthread_getconcurrency(void); 298113729Sjdpint pthread_setconcurrency(int); 299189828Sdas#endif 300179662Sdavidxu 301179662Sdavidxuvoid __pthread_cleanup_push_imp(void (*)(void *), void *, 302179662Sdavidxu struct _pthread_cleanup_info *); 303179662Sdavidxuvoid __pthread_cleanup_pop_imp(int); 30413547Sjulian__END_DECLS 30513547Sjulian 30613547Sjulian#endif 307