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