1/*
2 * Copyright 2001-2011 Haiku, Inc. All Rights Reserved.
3 * Distributed under the terms of the MIT License.
4 */
5#ifndef _PTHREAD_H_
6#define _PTHREAD_H_
7
8
9#include <sched.h>
10#include <stdint.h>
11#include <sys/types.h>
12#include <time.h>
13
14
15#define PTHREAD_MUTEX_DEFAULT		0
16#define PTHREAD_MUTEX_NORMAL		1
17#define PTHREAD_MUTEX_ERRORCHECK	2
18#define PTHREAD_MUTEX_RECURSIVE		3
19
20#define PTHREAD_PROCESS_PRIVATE		0
21#define PTHREAD_PROCESS_SHARED		1
22
23/*
24 * Flags for threads and thread attributes.
25 */
26#define PTHREAD_DETACHED			0x1
27#define PTHREAD_SCOPE_SYSTEM		0x2
28#define PTHREAD_INHERIT_SCHED		0x4
29#define PTHREAD_NOFLOAT				0x8
30
31#define PTHREAD_CREATE_DETACHED		PTHREAD_DETACHED
32#define PTHREAD_CREATE_JOINABLE		0
33#define PTHREAD_SCOPE_PROCESS		0
34#define PTHREAD_EXPLICIT_SCHED		0
35
36/*
37 * Flags for cancelling threads
38 */
39#define PTHREAD_CANCEL_ENABLE		0
40#define PTHREAD_CANCEL_DISABLE		1
41#define PTHREAD_CANCEL_DEFERRED		0
42#define PTHREAD_CANCEL_ASYNCHRONOUS	2
43#define PTHREAD_CANCELED			((void *) 1)
44
45#define PTHREAD_ONCE_INIT 			{ -1 }
46
47#define PTHREAD_BARRIER_SERIAL_THREAD 1
48
49#define PTHREAD_PRIO_NONE			0
50#define PTHREAD_PRIO_INHERIT		1
51#define PTHREAD_PRIO_PROTECT		2
52
53
54/* private structure */
55struct __pthread_cleanup_handler {
56	struct __pthread_cleanup_handler *previous;
57	void	(*function)(void *argument);
58	void	*argument;
59};
60
61#define pthread_cleanup_push(func, arg) \
62	do { \
63		struct __pthread_cleanup_handler __handler; \
64		__handler.function = (func); \
65		__handler.argument = (arg); \
66		__pthread_cleanup_push_handler(&__handler);
67
68#define pthread_cleanup_pop(execute) \
69		if (execute) \
70			__handler.function(__handler.argument); \
71		__pthread_cleanup_pop_handler(); \
72	} while (0)
73
74
75#ifdef __cplusplus
76extern "C" {
77#endif
78
79#define PTHREAD_MUTEX_INITIALIZER \
80	{ PTHREAD_MUTEX_DEFAULT, 0, -42, -1, 0 }
81#define PTHREAD_RECURSIVE_MUTEX_INITIALIZER \
82	{ PTHREAD_MUTEX_RECURSIVE, 0, -42, -1, 0 }
83#define PTHREAD_COND_INITIALIZER	\
84	{ 0, -42, NULL, 0, 0 }
85#define PTHREAD_RWLOCK_INITIALIZER	\
86	{ 0, -1, {{0}} }
87
88/* mutex functions */
89extern int pthread_mutex_destroy(pthread_mutex_t *mutex);
90extern int pthread_mutex_getprioceiling(const pthread_mutex_t *mutex,
91	int *_priorityCeiling);
92extern int pthread_mutex_init(pthread_mutex_t *mutex,
93	const pthread_mutexattr_t *attr);
94extern int pthread_mutex_lock(pthread_mutex_t *mutex);
95extern int pthread_mutex_setprioceiling(pthread_mutex_t *mutex,
96	int newPriorityCeiling, int *_oldPriorityCeiling);
97extern int pthread_mutex_clocklock(pthread_mutex_t *mutex,
98	clockid_t clock_id, const struct timespec *abstime);
99extern int pthread_mutex_timedlock(pthread_mutex_t *mutex,
100	const struct timespec *abstime);
101extern int pthread_mutex_trylock(pthread_mutex_t *mutex);
102extern int pthread_mutex_unlock(pthread_mutex_t *mutex);
103
104/* mutex attribute functions */
105extern int pthread_mutexattr_destroy(pthread_mutexattr_t *mutexAttr);
106extern int pthread_mutexattr_getprioceiling(const pthread_mutexattr_t *mutexAttr,
107	int *_priorityCeiling);
108extern int pthread_mutexattr_getprotocol(const pthread_mutexattr_t *mutexAttr,
109	int *_protocol);
110extern int pthread_mutexattr_getpshared(const pthread_mutexattr_t *mutexAttr,
111	int *_processShared);
112extern int pthread_mutexattr_gettype(const pthread_mutexattr_t *mutexAttr,
113	int *_type);
114extern int pthread_mutexattr_init(pthread_mutexattr_t *mutexAttr);
115extern int pthread_mutexattr_setprioceiling(pthread_mutexattr_t *mutexAttr,
116	int priorityCeiling);
117extern int pthread_mutexattr_setprotocol(pthread_mutexattr_t *mutexAttr,
118	int protocol);
119extern int pthread_mutexattr_setpshared(pthread_mutexattr_t *mutexAttr,
120	int processShared);
121extern int pthread_mutexattr_settype(pthread_mutexattr_t *mutexAttr, int type);
122
123/* barrier functions */
124extern int pthread_barrier_init(pthread_barrier_t *barrier,
125	const pthread_barrierattr_t *attr, unsigned count);
126extern int pthread_barrier_destroy(pthread_barrier_t *barrier);
127extern int pthread_barrier_wait(pthread_barrier_t *barrier);
128
129/* barrier attribute functions */
130extern int pthread_barrierattr_destroy(pthread_barrierattr_t *attr);
131extern int pthread_barrierattr_getpshared(const pthread_barrierattr_t *attr,
132	int *shared);
133extern int pthread_barrierattr_init(pthread_barrierattr_t *attr);
134extern int pthread_barrierattr_setpshared(pthread_barrierattr_t *attr,
135	int shared);
136
137/* condition variable functions */
138extern int pthread_cond_destroy(pthread_cond_t *cond);
139extern int pthread_cond_init(pthread_cond_t *cond,
140	const pthread_condattr_t *attr);
141extern int pthread_cond_broadcast(pthread_cond_t *cond);
142extern int pthread_cond_signal(pthread_cond_t *cond);
143extern int pthread_cond_clockwait(pthread_cond_t *cond, pthread_mutex_t *mutex,
144	clockid_t clock_id, const struct timespec *abstime);
145extern int pthread_cond_timedwait(pthread_cond_t *cond, pthread_mutex_t *mutex,
146	const struct timespec *abstime);
147extern int pthread_cond_wait(pthread_cond_t *cond, pthread_mutex_t *mutex);
148
149/* condition variable attribute functions */
150extern int pthread_condattr_destroy(pthread_condattr_t *condAttr);
151extern int pthread_condattr_init(pthread_condattr_t *condAttr);
152extern int pthread_condattr_getpshared(const pthread_condattr_t *condAttr,
153	int *processShared);
154extern int pthread_condattr_setpshared(pthread_condattr_t *condAttr,
155	int processShared);
156extern int pthread_condattr_getclock(const pthread_condattr_t *condAttr,
157	clockid_t *clockID);
158extern int pthread_condattr_setclock(pthread_condattr_t *condAttr,
159	clockid_t clockID);
160
161/* rwlock functions */
162extern int pthread_rwlock_init(pthread_rwlock_t *lock,
163	const pthread_rwlockattr_t *attr);
164extern int pthread_rwlock_destroy(pthread_rwlock_t *lock);
165extern int pthread_rwlock_rdlock(pthread_rwlock_t *lock);
166extern int pthread_rwlock_tryrdlock(pthread_rwlock_t *lock);
167extern int pthread_rwlock_clockrdlock(pthread_rwlock_t* rwlock,
168	clockid_t clock_id, const struct timespec* abstime);
169extern int pthread_rwlock_timedrdlock(pthread_rwlock_t *lock,
170	const struct timespec *abstime);
171extern int pthread_rwlock_wrlock(pthread_rwlock_t *lock);
172extern int pthread_rwlock_trywrlock(pthread_rwlock_t *lock);
173extern int pthread_rwlock_clockwrlock(pthread_rwlock_t* rwlock,
174	clockid_t clock_id, const struct timespec* abstime);
175extern int pthread_rwlock_timedwrlock(pthread_rwlock_t *lock,
176	const struct timespec *abstime);
177extern int pthread_rwlock_unlock(pthread_rwlock_t *lock);
178
179/* rwlock attribute functions */
180extern int pthread_rwlockattr_init(pthread_rwlockattr_t *attr);
181extern int pthread_rwlockattr_destroy(pthread_rwlockattr_t *attr);
182extern int pthread_rwlockattr_getpshared(const pthread_rwlockattr_t *attr,
183	int *shared);
184extern int pthread_rwlockattr_setpshared(pthread_rwlockattr_t *attr,
185	int shared);
186
187/* spinlock functions */
188extern int pthread_spin_init(pthread_spinlock_t* spinlock, int pshared);
189extern int pthread_spin_destroy(pthread_spinlock_t* spinlock);
190extern int pthread_spin_lock(pthread_spinlock_t* spinlock);
191extern int pthread_spin_trylock(pthread_spinlock_t* spinlock);
192extern int pthread_spin_unlock(pthread_spinlock_t* spinlock);
193
194/* misc. functions */
195extern int pthread_atfork(void (*prepare)(void), void (*parent)(void),
196	void (*child)(void));
197extern int pthread_once(pthread_once_t *once_control,
198	void (*init_routine)(void));
199
200/* thread attributes functions */
201extern int pthread_attr_destroy(pthread_attr_t *attr);
202extern int pthread_attr_init(pthread_attr_t *attr);
203extern int pthread_attr_getdetachstate(const pthread_attr_t *attr,
204	int *detachstate);
205extern int pthread_attr_setdetachstate(pthread_attr_t *attr, int detachstate);
206extern int pthread_attr_getstacksize(const pthread_attr_t *attr,
207	size_t *stacksize);
208extern int pthread_attr_setstacksize(pthread_attr_t *attr, size_t stacksize);
209extern int pthread_attr_getscope(const pthread_attr_t *attr,
210	int *contentionScope);
211extern int pthread_attr_setscope(pthread_attr_t *attr, int contentionScope);
212
213extern int pthread_attr_getschedparam(const pthread_attr_t *attr,
214	struct sched_param *param);
215extern int pthread_attr_setschedparam(pthread_attr_t *attr,
216	const struct sched_param *param);
217
218extern int pthread_attr_getguardsize(const pthread_attr_t *attr,
219	size_t *guardsize);
220extern int pthread_attr_setguardsize(pthread_attr_t *attr, size_t guardsize);
221
222extern int pthread_attr_getstack(const pthread_attr_t *attr,
223	void **stackaddr, size_t *stacksize);
224extern int pthread_attr_setstack(pthread_attr_t *attr, void *stackaddr,
225	size_t stacksize);
226
227#if 0   /* Unimplemented attribute functions: */
228
229/* [TPS] */
230extern int pthread_attr_getinheritsched(const pthread_attr_t *attr,
231	int *inheritsched);
232extern int pthread_attr_setinheritsched(pthread_attr_t *attr, int inheritsched);
233
234extern int pthread_attr_getschedpolicy(const pthread_attr_t *attr,
235	int *policy);
236extern int pthread_attr_setschedpolicy(pthread_attr_t *attr, int policy);
237
238#endif	/* 0 */
239
240/* thread functions */
241extern int pthread_create(pthread_t *thread, const pthread_attr_t *attr,
242	void *(*start_routine)(void*), void *arg);
243extern int pthread_detach(pthread_t thread);
244extern int pthread_equal(pthread_t t1, pthread_t t2);
245extern void pthread_exit(void *value_ptr) __attribute__ ((noreturn));
246extern int pthread_join(pthread_t thread, void **_value);
247extern pthread_t pthread_self(void);
248extern int pthread_getconcurrency(void);
249extern int pthread_setconcurrency(int newLevel);
250
251extern int pthread_cancel(pthread_t thread);
252extern int pthread_setcancelstate(int state, int *_oldState);
253extern int pthread_setcanceltype(int type, int *_oldType);
254extern void pthread_testcancel(void);
255
256extern int pthread_getschedparam(pthread_t thread, int *policy,
257	struct sched_param *param);
258extern int pthread_setschedparam(pthread_t thread, int policy,
259	const struct sched_param *param);
260
261/* thread specific data functions */
262extern int pthread_key_create(pthread_key_t *key,
263	void (*destructorFunc)(void*));
264extern int pthread_key_delete(pthread_key_t key);
265extern void *pthread_getspecific(pthread_key_t key);
266extern int pthread_setspecific(pthread_key_t key, const void *value);
267
268/* private functions */
269extern void __pthread_cleanup_push_handler(
270	struct __pthread_cleanup_handler *handler);
271extern struct __pthread_cleanup_handler *__pthread_cleanup_pop_handler(void);
272
273#ifdef __cplusplus
274}
275#endif
276
277#endif	/* _PTHREAD_ */
278