pthread.h revision 110636
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 110636 2003-02-10 08:48:04Z alfred $ 3413547Sjulian */ 3513547Sjulian#ifndef _PTHREAD_H_ 3613547Sjulian#define _PTHREAD_H_ 3713547Sjulian 3813547Sjulian/* 3913547Sjulian * Header files. 4013547Sjulian */ 4113547Sjulian#include <sys/cdefs.h> 4213547Sjulian#include <sys/types.h> 4313547Sjulian#include <sys/time.h> 4417706Sjulian#include <sys/signal.h> 4517706Sjulian#include <limits.h> 4644965Sjb#include <sched.h> 4713547Sjulian 4813547Sjulian/* 4917706Sjulian * Run-time invariant values: 5013547Sjulian */ 5117706Sjulian#define PTHREAD_DESTRUCTOR_ITERATIONS 4 5217706Sjulian#define PTHREAD_KEYS_MAX 256 5317706Sjulian#define PTHREAD_STACK_MIN 1024 5417706Sjulian#define PTHREAD_THREADS_MAX ULONG_MAX 5513547Sjulian 5613547Sjulian/* 5722315Sjulian * Flags for threads and thread attributes. 5822315Sjulian */ 5922315Sjulian#define PTHREAD_DETACHED 0x1 6022315Sjulian#define PTHREAD_SCOPE_SYSTEM 0x2 6122315Sjulian#define PTHREAD_INHERIT_SCHED 0x4 6222315Sjulian#define PTHREAD_NOFLOAT 0x8 6322315Sjulian 6422315Sjulian#define PTHREAD_CREATE_DETACHED PTHREAD_DETACHED 6522315Sjulian#define PTHREAD_CREATE_JOINABLE 0 6622315Sjulian#define PTHREAD_SCOPE_PROCESS 0 6722315Sjulian#define PTHREAD_EXPLICIT_SCHED 0 6822315Sjulian 6922315Sjulian/* 7038919Salex * Flags for read/write lock attributes 7138919Salex */ 7238919Salex#define PTHREAD_PROCESS_PRIVATE 0 7338919Salex#define PTHREAD_PROCESS_SHARED 1 7438919Salex 7538919Salex/* 7653812Salfred * Flags for cancelling threads 7753812Salfred */ 7853812Salfred#define PTHREAD_CANCEL_ENABLE 0 7953812Salfred#define PTHREAD_CANCEL_DISABLE 1 8053812Salfred#define PTHREAD_CANCEL_DEFERRED 0 8153812Salfred#define PTHREAD_CANCEL_ASYNCHRONOUS 2 8253812Salfred#define PTHREAD_CANCELED ((void *) 1) 8353812Salfred 8453812Salfred/* 8517706Sjulian * Forward structure definitions. 8617706Sjulian * 8717706Sjulian * These are mostly opaque to the user. 8813547Sjulian */ 8917706Sjulianstruct pthread; 9017706Sjulianstruct pthread_attr; 9117706Sjulianstruct pthread_cond; 9217706Sjulianstruct pthread_cond_attr; 9317706Sjulianstruct pthread_mutex; 9417706Sjulianstruct pthread_mutex_attr; 9517706Sjulianstruct pthread_once; 9638919Salexstruct pthread_rwlock; 9738919Salexstruct pthread_rwlockattr; 9813547Sjulian 9913547Sjulian/* 10017706Sjulian * Primitive system data type definitions required by P1003.1c. 10117706Sjulian * 10217706Sjulian * Note that P1003.1c specifies that there are no defined comparison 10317706Sjulian * or assignment operators for the types pthread_attr_t, pthread_cond_t, 10417706Sjulian * pthread_condattr_t, pthread_mutex_t, pthread_mutexattr_t. 10513547Sjulian */ 10617706Sjuliantypedef struct pthread *pthread_t; 10717706Sjuliantypedef struct pthread_attr *pthread_attr_t; 10817706Sjuliantypedef struct pthread_mutex *pthread_mutex_t; 10917706Sjuliantypedef struct pthread_mutex_attr *pthread_mutexattr_t; 11017706Sjuliantypedef struct pthread_cond *pthread_cond_t; 11117706Sjuliantypedef struct pthread_cond_attr *pthread_condattr_t; 11217706Sjuliantypedef int pthread_key_t; 11317706Sjuliantypedef struct pthread_once pthread_once_t; 11438919Salextypedef struct pthread_rwlock *pthread_rwlock_t; 11538919Salextypedef struct pthread_rwlockattr *pthread_rwlockattr_t; 11613547Sjulian 11713547Sjulian/* 11817706Sjulian * Additional type definitions: 11917706Sjulian * 12017706Sjulian * Note that P1003.1c reserves the prefixes pthread_ and PTHREAD_ for 12117706Sjulian * use in header symbols. 12213547Sjulian */ 12317706Sjuliantypedef void *pthread_addr_t; 12493032Simptypedef void *(*pthread_startroutine_t)(void *); 12513547Sjulian 12613547Sjulian/* 12713547Sjulian * Once definitions. 12813547Sjulian */ 12913547Sjulianstruct pthread_once { 13017706Sjulian int state; 13117706Sjulian pthread_mutex_t mutex; 13213547Sjulian}; 13313547Sjulian 13413547Sjulian/* 13513547Sjulian * Flags for once initialization. 13613547Sjulian */ 13713547Sjulian#define PTHREAD_NEEDS_INIT 0 13813547Sjulian#define PTHREAD_DONE_INIT 1 13913547Sjulian 14013547Sjulian/* 14113547Sjulian * Static once initialization values. 14213547Sjulian */ 14317706Sjulian#define PTHREAD_ONCE_INIT { PTHREAD_NEEDS_INIT, NULL } 14413547Sjulian 14513547Sjulian/* 14635025Sjb * Static initialization values. 14713547Sjulian */ 14835025Sjb#define PTHREAD_MUTEX_INITIALIZER NULL 14935025Sjb#define PTHREAD_COND_INITIALIZER NULL 15038919Salex#define PTHREAD_RWLOCK_INITIALIZER NULL 15135025Sjb 15235025Sjb/* 15335025Sjb * Default attribute arguments (draft 4, deprecated). 15435025Sjb */ 15522315Sjulian#ifndef PTHREAD_KERNEL 15613547Sjulian#define pthread_condattr_default NULL 15713547Sjulian#define pthread_mutexattr_default NULL 15813547Sjulian#define pthread_attr_default NULL 15913547Sjulian#endif 16013547Sjulian 16144965Sjb#define PTHREAD_PRIO_NONE 0 16244965Sjb#define PTHREAD_PRIO_INHERIT 1 16344965Sjb#define PTHREAD_PRIO_PROTECT 2 16444965Sjb 16544965Sjb/* 16644965Sjb * Mutex types (Single UNIX Specification, Version 2, 1997). 16744965Sjb * 16844965Sjb * Note that a mutex attribute with one of the following types: 16944965Sjb * 17044965Sjb * PTHREAD_MUTEX_NORMAL 17144965Sjb * PTHREAD_MUTEX_RECURSIVE 17244965Sjb * MUTEX_TYPE_FAST (deprecated) 17344965Sjb * MUTEX_TYPE_COUNTING_FAST (deprecated) 17444965Sjb * 17544965Sjb * will deviate from POSIX specified semantics. 17644965Sjb */ 17719637Shsuenum pthread_mutextype { 17844965Sjb PTHREAD_MUTEX_ERRORCHECK = 1, /* Default POSIX mutex */ 17944965Sjb PTHREAD_MUTEX_RECURSIVE = 2, /* Recursive mutex */ 18044965Sjb PTHREAD_MUTEX_NORMAL = 3, /* No error checking */ 18119637Shsu MUTEX_TYPE_MAX 18219637Shsu}; 18319637Shsu 18444965Sjb#define PTHREAD_MUTEX_DEFAULT PTHREAD_MUTEX_ERRORCHECK 18544965Sjb#define MUTEX_TYPE_FAST PTHREAD_MUTEX_NORMAL 18641390Seivind#define MUTEX_TYPE_COUNTING_FAST PTHREAD_MUTEX_RECURSIVE 18741390Seivind 18813547Sjulian/* 18913547Sjulian * Thread function prototype definitions: 19013547Sjulian */ 19113547Sjulian__BEGIN_DECLS 19293032Simpint pthread_attr_destroy(pthread_attr_t *); 193110636Salfredint pthread_attr_getstack(const pthread_attr_t * __restrict, 194110636Salfred void ** __restrict stackaddr, 195110636Salfred size_t * __restrict stacksize); 19693032Simpint pthread_attr_getstacksize(const pthread_attr_t *, size_t *); 19793032Simpint pthread_attr_getguardsize(const pthread_attr_t *, size_t *); 19893032Simpint pthread_attr_getstackaddr(const pthread_attr_t *, void **); 19993032Simpint pthread_attr_getdetachstate(const pthread_attr_t *, int *); 20093032Simpint pthread_attr_init(pthread_attr_t *); 20193032Simpint pthread_attr_setstacksize(pthread_attr_t *, size_t); 20293032Simpint pthread_attr_setguardsize(pthread_attr_t *, size_t); 203110636Salfredint pthread_attr_setstack(pthread_attr_t *, void *, size_t); 20493032Simpint pthread_attr_setstackaddr(pthread_attr_t *, void *); 20593032Simpint pthread_attr_setdetachstate(pthread_attr_t *, int); 20693032Simpvoid pthread_cleanup_pop(int); 20793032Simpvoid pthread_cleanup_push(void (*) (void *), void *routine_arg); 20893032Simpint pthread_condattr_destroy(pthread_condattr_t *); 20993032Simpint pthread_condattr_init(pthread_condattr_t *); 21044965Sjb 21193032Simpint pthread_cond_broadcast(pthread_cond_t *); 21293032Simpint pthread_cond_destroy(pthread_cond_t *); 21393032Simpint pthread_cond_init(pthread_cond_t *, 21493032Simp const pthread_condattr_t *); 21593032Simpint pthread_cond_signal(pthread_cond_t *); 21693032Simpint pthread_cond_timedwait(pthread_cond_t *, 21793032Simp pthread_mutex_t *, const struct timespec *); 21893032Simpint pthread_cond_wait(pthread_cond_t *, pthread_mutex_t *); 21993032Simpint pthread_create(pthread_t *, const pthread_attr_t *, 22093032Simp void *(*) (void *), void *); 22193032Simpint pthread_detach(pthread_t); 22293032Simpint pthread_equal(pthread_t, pthread_t); 22393032Simpvoid pthread_exit(void *) __dead2; 22493032Simpvoid *pthread_getspecific(pthread_key_t); 22593032Simpint pthread_join(pthread_t, void **); 22693032Simpint pthread_key_create(pthread_key_t *, 22793032Simp void (*) (void *)); 22893032Simpint pthread_key_delete(pthread_key_t); 22993032Simpint pthread_kill(pthread_t, int); 23093032Simpint pthread_mutexattr_init(pthread_mutexattr_t *); 23193032Simpint pthread_mutexattr_destroy(pthread_mutexattr_t *); 23293032Simpint pthread_mutexattr_gettype(pthread_mutexattr_t *, int *); 23393032Simpint pthread_mutexattr_settype(pthread_mutexattr_t *, int); 23493032Simpint pthread_mutex_destroy(pthread_mutex_t *); 23593032Simpint pthread_mutex_init(pthread_mutex_t *, 23693032Simp const pthread_mutexattr_t *); 23793032Simpint pthread_mutex_lock(pthread_mutex_t *); 23893032Simpint pthread_mutex_trylock(pthread_mutex_t *); 23993032Simpint pthread_mutex_unlock(pthread_mutex_t *); 24093032Simpint pthread_once(pthread_once_t *, void (*) (void)); 24193032Simpint pthread_rwlock_destroy(pthread_rwlock_t *); 24293032Simpint pthread_rwlock_init(pthread_rwlock_t *, 24393032Simp const pthread_rwlockattr_t *); 24493032Simpint pthread_rwlock_rdlock(pthread_rwlock_t *); 24593032Simpint pthread_rwlock_tryrdlock(pthread_rwlock_t *); 24693032Simpint pthread_rwlock_trywrlock(pthread_rwlock_t *); 24793032Simpint pthread_rwlock_unlock(pthread_rwlock_t *); 24893032Simpint pthread_rwlock_wrlock(pthread_rwlock_t *); 24993032Simpint pthread_rwlockattr_init(pthread_rwlockattr_t *); 25093032Simpint pthread_rwlockattr_getpshared(const pthread_rwlockattr_t *, 25193032Simp int *); 25293032Simpint pthread_rwlockattr_setpshared(pthread_rwlockattr_t *, int); 25393032Simpint pthread_rwlockattr_destroy(pthread_rwlockattr_t *); 25493032Simppthread_t pthread_self(void); 25593032Simpint pthread_setspecific(pthread_key_t, const void *); 25693032Simpint pthread_sigmask(int, const sigset_t *, sigset_t *); 25717706Sjulian 25893032Simpint pthread_cancel(pthread_t); 25993032Simpint pthread_setcancelstate(int, int *); 26093032Simpint pthread_setcanceltype(int, int *); 26193032Simpvoid pthread_testcancel(void); 26217706Sjulian 26393032Simpint pthread_getprio(pthread_t); 26493032Simpint pthread_setprio(pthread_t, int); 26593032Simpvoid pthread_yield(void); 26644965Sjb 26793032Simpint pthread_mutexattr_getprioceiling(pthread_mutexattr_t *, 26893032Simp int *); 26993032Simpint pthread_mutexattr_setprioceiling(pthread_mutexattr_t *, 27093032Simp int); 27193032Simpint pthread_mutex_getprioceiling(pthread_mutex_t *, int *); 27293032Simpint pthread_mutex_setprioceiling(pthread_mutex_t *, int, int *); 27344965Sjb 27493032Simpint pthread_mutexattr_getprotocol(pthread_mutexattr_t *, int *); 27593032Simpint pthread_mutexattr_setprotocol(pthread_mutexattr_t *, int); 27644965Sjb 27793032Simpint pthread_attr_getinheritsched(const pthread_attr_t *, int *); 27893032Simpint pthread_attr_getschedparam(const pthread_attr_t *, 27993032Simp struct sched_param *); 28093032Simpint pthread_attr_getschedpolicy(const pthread_attr_t *, int *); 28193032Simpint pthread_attr_getscope(const pthread_attr_t *, int *); 28293032Simpint pthread_attr_setinheritsched(pthread_attr_t *, int); 28393032Simpint pthread_attr_setschedparam(pthread_attr_t *, 28493032Simp const struct sched_param *); 28593032Simpint pthread_attr_setschedpolicy(pthread_attr_t *, int); 28693032Simpint pthread_attr_setscope(pthread_attr_t *, int); 28793032Simpint pthread_getschedparam(pthread_t pthread, int *, 28893032Simp struct sched_param *); 28993032Simpint pthread_setschedparam(pthread_t, int, 29093032Simp const struct sched_param *); 29113547Sjulian__END_DECLS 29213547Sjulian 29313547Sjulian#endif 294