]> git.saurik.com Git - apple/libc.git/blame - pthreads/pthread.h
Libc-262.3.2.tar.gz
[apple/libc.git] / pthreads / pthread.h
CommitLineData
e9ce8d39
A
1/*
2 * Copyright 1996 1995 by Open Software Foundation, Inc. 1997 1996 1995 1994 1993 1992 1991
3 * All Rights Reserved
4 *
5 * Permission to use, copy, modify, and distribute this software and
6 * its documentation for any purpose and without fee is hereby granted,
7 * provided that the above copyright notice appears in all copies and
8 * that both the copyright notice and this permission notice appear in
9 * supporting documentation.
10 *
11 * OSF DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE
12 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
13 * FOR A PARTICULAR PURPOSE.
14 *
15 * IN NO EVENT SHALL OSF BE LIABLE FOR ANY SPECIAL, INDIRECT, OR
16 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
17 * LOSS OF USE, DATA OR PROFITS, WHETHER IN ACTION OF CONTRACT,
18 * NEGLIGENCE, OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
19 * WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
20 *
21 */
22/*
23 * MkLinux
24 */
25
26/*
27 * POSIX Threads - IEEE 1003.1c
28 */
29
30#ifndef _POSIX_PTHREAD_H
31#define _POSIX_PTHREAD_H
32
33#ifndef __POSIX_LIB__
34#include <pthread_impl.h>
35#endif
36#include <errno.h>
37#include <sched.h>
38#include <time.h>
e9ce8d39
A
39#include <unistd.h>
40#include <limits.h>
5b2abdfb
A
41#include <signal.h>
42
43#ifndef _POSIX_C_SOURCE
44#include <mach/mach_types.h>
45#endif /* ! _POSIX_C_SOURCE */
e9ce8d39
A
46
47/*
48 * These symbols indicate which [optional] features are available
49 * They can be tested at compile time via '#ifdef XXX'
50 * The way to check for pthreads is like so:
51
52 * #include <unistd.h>
53 * #ifdef _POSIX_THREADS
54 * #include <pthread.h>
55 * #endif
56
57 */
58
59/* These will be moved to unistd.h */
60
61
62/* These two should be defined also */
63#undef _POSIX_THREAD_PROCESS_SHARED
64#undef _POSIX_THREAD_SAFE_FUNCTIONS
65
66/*
67 * Note: These data structures are meant to be opaque. Only enough
68 * structure is exposed to support initializers.
69 * All of the typedefs will be moved to <sys/types.h>
70 */
71
72#include <sys/cdefs.h>
73
74__BEGIN_DECLS
75/*
76 * Threads
77 */
78
79
80/*
81 * Cancel cleanup handler management. Note, since these are implemented as macros,
82 * they *MUST* occur in matched pairs!
83 */
84
85#define pthread_cleanup_push(func, val) \
86 { \
87 struct _pthread_handler_rec __handler; \
88 pthread_t __self = pthread_self(); \
89 __handler.routine = func; \
90 __handler.arg = val; \
91 __handler.next = __self->cleanup_stack; \
92 __self->cleanup_stack = &__handler;
93
94#define pthread_cleanup_pop(execute) \
95 /* Note: 'handler' must be in this same lexical context! */ \
96 __self->cleanup_stack = __handler.next; \
97 if (execute) (__handler.routine)(__handler.arg); \
98 }
99
100/*
101 * Thread attributes
102 */
103
104#define PTHREAD_CREATE_JOINABLE 1
105#define PTHREAD_CREATE_DETACHED 2
106
107#define PTHREAD_INHERIT_SCHED 1
108#define PTHREAD_EXPLICIT_SCHED 2
109
110#define PTHREAD_CANCEL_ENABLE 0x01 /* Cancel takes place at next cancellation point */
111#define PTHREAD_CANCEL_DISABLE 0x00 /* Cancel postponed */
112#define PTHREAD_CANCEL_DEFERRED 0x02 /* Cancel waits until cancellation point */
113#define PTHREAD_CANCEL_ASYNCHRONOUS 0x00 /* Cancel occurs immediately */
114
115/* We only support PTHREAD_SCOPE_SYSTEM */
116#define PTHREAD_SCOPE_SYSTEM 1
117#define PTHREAD_SCOPE_PROCESS 2
118
5b2abdfb
A
119/* We only support PTHREAD_PROCESS_PRIVATE */
120#define PTHREAD_PROCESS_SHARED 1
121#define PTHREAD_PROCESS_PRIVATE 2
122
e9ce8d39
A
123/* Who defines this? */
124
125#if !defined(ENOTSUP)
126#define ENOTSUP 89
127#endif
128/*
5b2abdfb 129 * Mutex protocol attributes
e9ce8d39
A
130 */
131#define PTHREAD_PRIO_NONE 0
132#define PTHREAD_PRIO_INHERIT 1
133#define PTHREAD_PRIO_PROTECT 2
134
5b2abdfb
A
135/*
136 * Mutex type attributes
137 */
138#define PTHREAD_MUTEX_NORMAL 0
139#define PTHREAD_MUTEX_ERRORCHECK 1
140#define PTHREAD_MUTEX_RECURSIVE 2
141#define PTHREAD_MUTEX_DEFAULT PTHREAD_MUTEX_NORMAL
e9ce8d39
A
142/*
143 * Mutex variables
144 */
145
5b2abdfb 146#define PTHREAD_MUTEX_INITIALIZER {_PTHREAD_MUTEX_SIG_init, {}}
e9ce8d39
A
147
148/*
149 * Condition variable attributes
150 */
151
152/*
153 * Condition variables
154 */
155
5b2abdfb 156#define PTHREAD_COND_INITIALIZER {_PTHREAD_COND_SIG_init, {}}
e9ce8d39
A
157
158/*
159 * Initialization control (once) variables
160 */
161
5b2abdfb 162#define PTHREAD_ONCE_INIT {_PTHREAD_ONCE_SIG_init, {}}
e9ce8d39
A
163
164/*
165 * Thread Specific Data - keys
166 */
167
168#include <sys/time.h>
169
170/*
171 * Prototypes for all PTHREAD interfaces
172 */
173int pthread_attr_destroy __P((pthread_attr_t *attr));
174int pthread_attr_getdetachstate __P((const pthread_attr_t *attr,
175 int *detachstate));
176int pthread_attr_getinheritsched __P((const pthread_attr_t *attr,
177 int *inheritsched));
178int pthread_attr_getschedparam __P((const pthread_attr_t *attr,
179 struct sched_param *param));
180int pthread_attr_getschedpolicy __P((const pthread_attr_t *attr,
181 int *policy));
182int pthread_attr_getstackaddr __P((const pthread_attr_t *attr,
183 void **stackaddr));
184int pthread_attr_getstacksize __P((const pthread_attr_t *attr,
185 size_t *stacksize));
5b2abdfb
A
186int pthread_attr_getstack __P((const pthread_attr_t *attr,
187 void **stackaddr, size_t *stacksize));
e9ce8d39
A
188int pthread_attr_init __P((pthread_attr_t *attr));
189int pthread_attr_setdetachstate __P((pthread_attr_t *attr,
190 int detachstate));
191int pthread_attr_setinheritsched __P((pthread_attr_t *attr,
192 int inheritsched));
193int pthread_attr_setschedparam __P((pthread_attr_t *attr,
194 const struct sched_param *param));
195int pthread_attr_setschedpolicy __P((pthread_attr_t *attr,
196 int policy));
197int pthread_attr_setstackaddr __P((pthread_attr_t *attr,
198 void *stackaddr));
199int pthread_attr_setstacksize __P((pthread_attr_t *attr,
200 size_t stacksize));
5b2abdfb
A
201int pthread_attr_setstack __P((pthread_attr_t *attr,
202 void *stackaddr, size_t stacksize));
e9ce8d39
A
203int pthread_cancel __P((pthread_t thread));
204int pthread_setcancelstate __P((int state, int *oldstate));
205int pthread_setcanceltype __P((int type, int *oldtype));
206void pthread_testcancel __P((void));
207int pthread_cond_broadcast __P((pthread_cond_t *cond));
208int pthread_cond_destroy __P((pthread_cond_t *cond));
209int pthread_cond_init __P((pthread_cond_t *cond,
210 const pthread_condattr_t *attr));
211int pthread_cond_signal __P((pthread_cond_t *cond));
212int pthread_cond_wait __P((pthread_cond_t *cond,
213 pthread_mutex_t *mutex));
214int pthread_cond_timedwait __P((pthread_cond_t *cond,
215 pthread_mutex_t *mutex,
216 const struct timespec *abstime));
5b2abdfb
A
217int pthread_condattr_init __P((pthread_condattr_t *attr));
218int pthread_condattr_destroy __P((pthread_condattr_t *attr));
219int pthread_condattr_getpshared __P((const pthread_condattr_t *attr,
220 int *pshared));
221int pthread_condattr_setpshared __P((pthread_condattr_t *attr,
222 int pshared));
e9ce8d39
A
223int pthread_create __P((pthread_t *thread,
224 const pthread_attr_t *attr,
225 void *(*start_routine)(void *),
226 void *arg));
227int pthread_detach __P((pthread_t thread));
228int pthread_equal __P((pthread_t t1,
229 pthread_t t2));
230void pthread_exit __P((void *value_ptr));
5b2abdfb
A
231int pthread_kill __P((pthread_t, int));
232int pthread_sigmask __P((int, const sigset_t *, sigset_t *));
233int sigwait __P((const sigset_t *, int *));
e9ce8d39
A
234int pthread_getschedparam __P((pthread_t thread,
235 int *policy,
236 struct sched_param *param));
237int pthread_join __P((pthread_t thread,
238 void **value_ptr));
239int pthread_mutex_destroy __P((pthread_mutex_t *mutex));
240int pthread_mutex_getprioceiling __P((const pthread_mutex_t *mutex,
241 int *prioceiling));
242int pthread_mutex_init __P((pthread_mutex_t *mutex,
243 const pthread_mutexattr_t *attr));
244int pthread_mutex_lock __P((pthread_mutex_t *mutex));
245int pthread_mutex_setprioceiling __P((pthread_mutex_t *mutex,
246 int prioceiling,
247 int *old_prioceiling));
248int pthread_mutex_trylock __P((pthread_mutex_t *mutex));
249int pthread_mutex_unlock __P((pthread_mutex_t *mutex));
250int pthread_mutexattr_destroy __P((pthread_mutexattr_t *attr));
251int pthread_mutexattr_getprioceiling __P((const pthread_mutexattr_t *attr,
252 int *prioceiling));
253int pthread_mutexattr_getprotocol __P((const pthread_mutexattr_t *attr,
254 int *protocol));
5b2abdfb
A
255int pthread_mutexattr_getpshared __P((const pthread_mutexattr_t *attr,
256 int *pshared));
257int pthread_mutexattr_gettype __P((const pthread_mutexattr_t *attr,
258 int *type));
e9ce8d39
A
259int pthread_mutexattr_init __P((pthread_mutexattr_t *attr));
260int pthread_mutexattr_setprioceiling __P((pthread_mutexattr_t *attr,
261 int prioceiling));
262int pthread_mutexattr_setprotocol __P((pthread_mutexattr_t *attr,
263 int protocol));
5b2abdfb
A
264int pthread_mutexattr_settype __P((pthread_mutexattr_t *attr,
265 int type));
266int pthread_mutexattr_setpshared __P((pthread_mutexattr_t *attr,
267 int pshared));
e9ce8d39
A
268int pthread_once __P((pthread_once_t *once_control,
269 void (*init_routine)(void)));
270pthread_t pthread_self __P((void));
271int pthread_setschedparam __P((pthread_t thread,
272 int policy,
273 const struct sched_param *param));
274int pthread_key_create __P((pthread_key_t *key,
275 void (*destructor)(void *)));
276int pthread_key_delete __P((pthread_key_t key));
277int pthread_setspecific __P((pthread_key_t key,
278 const void *value));
279void *pthread_getspecific __P((pthread_key_t key));
280int pthread_attr_getscope __P((pthread_attr_t *, int *));
281int pthread_attr_setscope __P((pthread_attr_t *, int));
5b2abdfb
A
282int pthread_getconcurrency __P((void));
283int pthread_setconcurrency __P((int));
284int pthread_rwlock_destroy __P((pthread_rwlock_t * rwlock));
285int pthread_rwlock_init __P((pthread_rwlock_t * rwlock,
286 const pthread_rwlockattr_t *attr));
287int pthread_rwlock_rdlock __P((pthread_rwlock_t *rwlock));
288int pthread_rwlock_tryrdlock __P((pthread_rwlock_t *rwlock));
289int pthread_rwlock_wrlock __P((pthread_rwlock_t *rwlock));
290int pthread_rwlock_trywrlock __P((pthread_rwlock_t *rwlock));
291int pthread_rwlock_unlock __P((pthread_rwlock_t *rwlock));
292int pthread_rwlockattr_init __P((pthread_rwlockattr_t *attr));
293int pthread_rwlockattr_destroy __P((pthread_rwlockattr_t *attr));
294int pthread_rwlockattr_getpshared __P((const pthread_rwlockattr_t *attr,
295 int *pshared));
296int pthread_rwlockattr_setpshared __P((pthread_rwlockattr_t *attr,
297 int pshared));
298
299#ifndef _POSIX_C_SOURCE
e9ce8d39
A
300/* returns non-zero if pthread_create or cthread_fork have been called */
301int pthread_is_threaded_np __P((void));
302
5b2abdfb
A
303/* returns non-zero if the current thread is the main thread */
304int pthread_main_np __P((void));
305
e9ce8d39
A
306/* return the mach thread bound to the pthread */
307mach_port_t pthread_mach_thread_np __P((pthread_t));
308size_t pthread_get_stacksize_np __P((pthread_t));
309void * pthread_get_stackaddr_np __P((pthread_t));
310
311/* Like pthread_cond_signal(), but only wake up the specified pthread */
312int pthread_cond_signal_thread_np __P((pthread_cond_t *, pthread_t));
313
5b2abdfb
A
314/* Like pthread_cond_timedwait, but use a relative timeout */
315int pthread_cond_timedwait_relative_np __P((pthread_cond_t *cond,
316 pthread_mutex_t *mutex,
317 const struct timespec *reltime));
318
e9ce8d39
A
319/* Like pthread_create(), but leaves the thread suspended */
320int pthread_create_suspended_np __P((pthread_t *thread,
321 const pthread_attr_t *attr,
322 void *(*start_routine)(void *),
323 void *arg));
5b2abdfb
A
324void pthread_yield_np __P((void));
325#endif /* ! _POSIX_C_SOURCE */
e9ce8d39
A
326__END_DECLS
327#endif /* _POSIX_PTHREAD_H */