PageRenderTime 54ms CodeModel.GetById 10ms app.highlight 39ms RepoModel.GetById 1ms app.codeStats 1ms

/include/pthread.h

https://bitbucket.org/freebsd/freebsd-head/
C++ Header | 297 lines | 198 code | 25 blank | 74 comment | 0 complexity | 8ee5b9cd71936414d12a6615bdfbad31 MD5 | raw file
  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$
 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 *);
148int		pthread_attr_getstack(const pthread_attr_t * __restrict, 
149			void ** __restrict, size_t * __restrict);
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);
169
170#define		pthread_cleanup_push(cleanup_routine, cleanup_arg)		\
171		{								\
172			struct _pthread_cleanup_info __cleanup_info__;		\
173			__pthread_cleanup_push_imp(cleanup_routine, cleanup_arg,\
174				&__cleanup_info__);				\
175			{
176
177#define		pthread_cleanup_pop(execute)					\
178			}							\
179			__pthread_cleanup_pop_imp(execute);			\
180		}
181
182int		pthread_condattr_destroy(pthread_condattr_t *);
183int		pthread_condattr_getclock(const pthread_condattr_t *,
184			clockid_t *);
185int		pthread_condattr_getpshared(const pthread_condattr_t *, int *);
186int		pthread_condattr_init(pthread_condattr_t *);
187int		pthread_condattr_setclock(pthread_condattr_t *, clockid_t);
188int		pthread_condattr_setpshared(pthread_condattr_t *, int);
189int		pthread_cond_broadcast(pthread_cond_t *);
190int		pthread_cond_destroy(pthread_cond_t *);
191int		pthread_cond_init(pthread_cond_t *,
192			const pthread_condattr_t *);
193int		pthread_cond_signal(pthread_cond_t *);
194int		pthread_cond_timedwait(pthread_cond_t *,
195			pthread_mutex_t *, const struct timespec *);
196int		pthread_cond_wait(pthread_cond_t *, pthread_mutex_t *);
197int		pthread_create(pthread_t *, const pthread_attr_t *,
198			void *(*) (void *), void *);
199int		pthread_detach(pthread_t);
200int		pthread_equal(pthread_t, pthread_t);
201void		pthread_exit(void *) __dead2;
202void		*pthread_getspecific(pthread_key_t);
203int		pthread_getcpuclockid(pthread_t, clockid_t *);
204int		pthread_join(pthread_t, void **);
205int		pthread_key_create(pthread_key_t *,
206			void (*) (void *));
207int		pthread_key_delete(pthread_key_t);
208int		pthread_mutexattr_init(pthread_mutexattr_t *);
209int		pthread_mutexattr_destroy(pthread_mutexattr_t *);
210int		pthread_mutexattr_getpshared(const pthread_mutexattr_t *,
211			int *);
212int		pthread_mutexattr_gettype(pthread_mutexattr_t *, int *);
213int		pthread_mutexattr_settype(pthread_mutexattr_t *, int);
214int		pthread_mutexattr_setpshared(pthread_mutexattr_t *, int);
215int		pthread_mutex_destroy(pthread_mutex_t *);
216int		pthread_mutex_init(pthread_mutex_t *,
217			const pthread_mutexattr_t *);
218int		pthread_mutex_lock(pthread_mutex_t *);
219int		pthread_mutex_trylock(pthread_mutex_t *);
220int		pthread_mutex_timedlock(pthread_mutex_t *,
221			const struct timespec *);
222int		pthread_mutex_unlock(pthread_mutex_t *);
223int		pthread_once(pthread_once_t *, void (*) (void));
224int		pthread_rwlock_destroy(pthread_rwlock_t *);
225int		pthread_rwlock_init(pthread_rwlock_t *,
226			const pthread_rwlockattr_t *);
227int		pthread_rwlock_rdlock(pthread_rwlock_t *);
228int		pthread_rwlock_timedrdlock(pthread_rwlock_t *,
229			const struct timespec *);
230int		pthread_rwlock_timedwrlock(pthread_rwlock_t *,
231			const struct timespec *);
232int		pthread_rwlock_tryrdlock(pthread_rwlock_t *);
233int		pthread_rwlock_trywrlock(pthread_rwlock_t *);
234int		pthread_rwlock_unlock(pthread_rwlock_t *);
235int		pthread_rwlock_wrlock(pthread_rwlock_t *);
236int		pthread_rwlockattr_destroy(pthread_rwlockattr_t *);
237int		pthread_rwlockattr_getkind_np(const pthread_rwlockattr_t *,
238			int *);
239int		pthread_rwlockattr_getpshared(const pthread_rwlockattr_t *,
240			int *);
241int		pthread_rwlockattr_init(pthread_rwlockattr_t *);
242int		pthread_rwlockattr_setkind_np(pthread_rwlockattr_t *, int);
243int		pthread_rwlockattr_setpshared(pthread_rwlockattr_t *, int);
244pthread_t	pthread_self(void);
245int		pthread_setspecific(pthread_key_t, const void *);
246
247int		pthread_spin_init(pthread_spinlock_t *, int);
248int		pthread_spin_destroy(pthread_spinlock_t *);
249int		pthread_spin_lock(pthread_spinlock_t *);
250int		pthread_spin_trylock(pthread_spinlock_t *);
251int		pthread_spin_unlock(pthread_spinlock_t *);
252int		pthread_cancel(pthread_t);
253int		pthread_setcancelstate(int, int *);
254int		pthread_setcanceltype(int, int *);
255void		pthread_testcancel(void);
256
257#if __BSD_VISIBLE
258int		pthread_getprio(pthread_t);
259int		pthread_setprio(pthread_t, int);
260void		pthread_yield(void);
261#endif
262
263int		pthread_mutexattr_getprioceiling(pthread_mutexattr_t *,
264			int *);
265int		pthread_mutexattr_setprioceiling(pthread_mutexattr_t *,
266			int);
267int		pthread_mutex_getprioceiling(pthread_mutex_t *, int *);
268int		pthread_mutex_setprioceiling(pthread_mutex_t *, int, int *);
269
270int		pthread_mutexattr_getprotocol(pthread_mutexattr_t *, int *);
271int		pthread_mutexattr_setprotocol(pthread_mutexattr_t *, int);
272
273int		pthread_attr_getinheritsched(const pthread_attr_t *, int *);
274int		pthread_attr_getschedparam(const pthread_attr_t *,
275			struct sched_param *);
276int		pthread_attr_getschedpolicy(const pthread_attr_t *, int *);
277int		pthread_attr_getscope(const pthread_attr_t *, int *);
278int		pthread_attr_setinheritsched(pthread_attr_t *, int);
279int		pthread_attr_setschedparam(pthread_attr_t *,
280			const struct sched_param *);
281int		pthread_attr_setschedpolicy(pthread_attr_t *, int);
282int		pthread_attr_setscope(pthread_attr_t *, int);
283int		pthread_getschedparam(pthread_t pthread, int *,
284			struct sched_param *);
285int		pthread_setschedparam(pthread_t, int,
286			const struct sched_param *);
287#if __XSI_VISIBLE
288int		pthread_getconcurrency(void);
289int		pthread_setconcurrency(int);
290#endif
291
292void		__pthread_cleanup_push_imp(void (*)(void *), void *,
293			struct _pthread_cleanup_info *);
294void		__pthread_cleanup_pop_imp(int);
295__END_DECLS
296
297#endif