Merge from vendor branch INTEL_ACPICA:
[dragonfly.git] / include / pthread.h
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: src/include/pthread.h,v 1.20.2.4 2003/05/27 18:18:01 jdp Exp $
34  * $DragonFly: src/include/pthread.h,v 1.9 2006/04/06 13:00:44 davidxu Exp $
35  */
36 #ifndef _PTHREAD_H_
37 #define _PTHREAD_H_
38
39 /*
40  * Header files.
41  */
42 #include <sys/cdefs.h>
43 #include <sys/types.h>
44 #include <sys/time.h>
45 #include <sys/signal.h>
46 #include <limits.h>
47 #include <sched.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                       1024
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  * Forward structure definitions.
88  *
89  * These are mostly opaque to the user.
90  */
91 struct pthread;
92 struct pthread_attr;
93 struct pthread_cond;
94 struct pthread_cond_attr;
95 struct pthread_mutex;
96 struct pthread_mutex_attr;
97 struct pthread_once;
98 struct pthread_rwlock;
99 struct pthread_rwlockattr;
100 struct pthread_barrier;
101 struct pthread_barrier_attr;
102
103 /*
104  * Primitive system data type definitions required by P1003.1c.
105  *
106  * Note that P1003.1c specifies that there are no defined comparison
107  * or assignment operators for the types pthread_attr_t, pthread_cond_t,
108  * pthread_condattr_t, pthread_mutex_t, pthread_mutexattr_t.
109  */
110 typedef struct  pthread                 *pthread_t;
111 typedef struct  pthread_attr            *pthread_attr_t;
112 typedef struct  pthread_mutex           *pthread_mutex_t;
113 typedef struct  pthread_mutex_attr      *pthread_mutexattr_t;
114 typedef struct  pthread_cond            *pthread_cond_t;
115 typedef struct  pthread_cond_attr       *pthread_condattr_t;
116 typedef int                             pthread_key_t;
117 typedef struct  pthread_once            pthread_once_t;
118 typedef struct  pthread_rwlock          *pthread_rwlock_t;
119 typedef struct  pthread_rwlockattr      *pthread_rwlockattr_t;
120 typedef struct  pthread_barrier         *pthread_barrier_t;
121 typedef struct  pthread_barrierattr     *pthread_barrierattr_t;
122
123 /*
124  * Additional type definitions:
125  *
126  * Note that P1003.1c reserves the prefixes pthread_ and PTHREAD_ for
127  * use in header symbols.
128  */
129 typedef void    *pthread_addr_t;
130 typedef void    *(*pthread_startroutine_t) (void *);
131
132 /*
133  * Once definitions.
134  */
135 struct pthread_once {
136         int             state;
137         pthread_mutex_t mutex;
138 };
139
140 /*
141  * Flags for once initialization.
142  */
143 #define PTHREAD_NEEDS_INIT  0
144 #define PTHREAD_DONE_INIT   1
145
146 /*
147  * Static once initialization values. 
148  */
149 #define PTHREAD_ONCE_INIT   { PTHREAD_NEEDS_INIT, NULL }
150
151 /*
152  * Static initialization values. 
153  */
154 #define PTHREAD_MUTEX_INITIALIZER       NULL
155 #define PTHREAD_COND_INITIALIZER        NULL
156 #define PTHREAD_RWLOCK_INITIALIZER      NULL
157
158 /*
159  * Default attribute arguments (draft 4, deprecated).
160  */
161 #ifndef PTHREAD_KERNEL
162 #define pthread_condattr_default    NULL
163 #define pthread_mutexattr_default   NULL
164 #define pthread_attr_default        NULL
165 #endif
166
167 #define PTHREAD_PRIO_NONE       0
168 #define PTHREAD_PRIO_INHERIT    1
169 #define PTHREAD_PRIO_PROTECT    2
170
171 /*
172  * Mutex types (Single UNIX Specification, Version 2, 1997).
173  *
174  * Note that a mutex attribute with one of the following types:
175  *
176  *      PTHREAD_MUTEX_NORMAL
177  *      PTHREAD_MUTEX_RECURSIVE
178  *      MUTEX_TYPE_FAST (deprecated)
179  *      MUTEX_TYPE_COUNTING_FAST (deprecated)
180  *
181  * will deviate from POSIX specified semantics.
182  */
183 enum pthread_mutextype {
184         PTHREAD_MUTEX_ERRORCHECK        = 1,    /* Default POSIX mutex */
185         PTHREAD_MUTEX_RECURSIVE         = 2,    /* Recursive mutex */
186         PTHREAD_MUTEX_NORMAL            = 3,    /* No error checking */
187         MUTEX_TYPE_MAX
188 };
189
190 #define PTHREAD_MUTEX_DEFAULT           PTHREAD_MUTEX_ERRORCHECK
191 #define MUTEX_TYPE_FAST                 PTHREAD_MUTEX_NORMAL
192 #define MUTEX_TYPE_COUNTING_FAST        PTHREAD_MUTEX_RECURSIVE
193
194 /*
195  * Thread function prototype definitions:
196  */
197 __BEGIN_DECLS
198 int             pthread_atfork(void (*)(void), void (*)(void), void (*)(void));
199 int             pthread_attr_destroy(pthread_attr_t *);
200 int             pthread_attr_getguardsize(const pthread_attr_t * __restrict,
201                         size_t *);
202 int             pthread_attr_getstack(const pthread_attr_t * __restrict,
203                                       void ** __restrict, size_t * __restrict);
204 int             pthread_attr_getstacksize(const pthread_attr_t *, size_t *);
205 int             pthread_attr_getstackaddr(const pthread_attr_t *, void **);
206 int             pthread_attr_getdetachstate(const pthread_attr_t *, int *);
207 int             pthread_attr_init(pthread_attr_t *);
208 int             pthread_attr_setguardsize(pthread_attr_t *, size_t);
209 int             pthread_attr_setstack(pthread_attr_t *, void *, size_t);
210 int             pthread_attr_setstacksize(pthread_attr_t *, size_t);
211 int             pthread_attr_setstackaddr(pthread_attr_t *, void *);
212 int             pthread_attr_setdetachstate(pthread_attr_t *, int);
213 int             pthread_barrier_destroy(pthread_barrier_t *);
214 int             pthread_barrier_init(pthread_barrier_t *,
215                         const pthread_barrierattr_t *, unsigned);
216 int             pthread_barrier_wait(pthread_barrier_t *);
217 int             pthread_barrierattr_destroy(pthread_barrierattr_t *);
218 int             pthread_barrierattr_init(pthread_barrierattr_t *);
219 #if defined(_POSIX_THREAD_PROCESS_SHARED)
220 int             pthread_barrierattr_getpshared(const pthread_barrierattr_t *,
221                         int *);
222 int             pthread_barrierattr_setpshared(pthread_barrierattr_t *, int);
223 #endif
224 void            pthread_cleanup_pop(int);
225 void            pthread_cleanup_push(void (*) (void *), void *);
226 int             pthread_condattr_destroy(pthread_condattr_t *);
227 int             pthread_condattr_init(pthread_condattr_t *);
228
229 #if defined(_POSIX_THREAD_PROCESS_SHARED)
230 int             pthread_condattr_getpshared(pthread_condattr_t *, int *);
231 int             pthread_condattr_setpshared(pthread_condattr_t *, int);
232 #endif
233
234 int             pthread_condattr_getclock(const pthread_condattr_t *, clockid_t *);
235 int             pthread_condattr_setclock(pthread_condattr_t *, clockid_t);
236
237 int             pthread_cond_broadcast(pthread_cond_t *);
238 int             pthread_cond_destroy(pthread_cond_t *);
239 int             pthread_cond_init(pthread_cond_t *,
240                                   const pthread_condattr_t *);
241 int             pthread_cond_signal(pthread_cond_t *);
242 int             pthread_cond_timedwait(pthread_cond_t *, pthread_mutex_t *,
243                                        const struct timespec *);
244 int             pthread_cond_wait(pthread_cond_t *, pthread_mutex_t *);
245 int             pthread_create(pthread_t *, const pthread_attr_t *,
246                                void *(*) (void *), void *);
247 int             pthread_detach(pthread_t);
248 int             pthread_equal(pthread_t, pthread_t);
249 void            pthread_exit(void *) __dead2;
250 void            *pthread_getspecific(pthread_key_t);
251 int             pthread_join(pthread_t, void **);
252 int             pthread_key_create(pthread_key_t *, void (*) (void *));
253 int             pthread_key_delete(pthread_key_t);
254 int             pthread_kill(pthread_t, int);
255 int             pthread_mutexattr_init(pthread_mutexattr_t *);
256 int             pthread_mutexattr_destroy(pthread_mutexattr_t *);
257 int             pthread_mutexattr_gettype(pthread_mutexattr_t *, int *);
258 int             pthread_mutexattr_settype(pthread_mutexattr_t *, int);
259 int             pthread_mutex_destroy(pthread_mutex_t *);
260 int             pthread_mutex_init(pthread_mutex_t *,
261                                    const pthread_mutexattr_t *);
262 int             pthread_mutex_lock(pthread_mutex_t *);
263 int             pthread_mutex_timedlock(pthread_mutex_t *,
264                                         const struct timespec *);
265 int             pthread_mutex_trylock(pthread_mutex_t *);
266 int             pthread_mutex_unlock(pthread_mutex_t *);
267 int             pthread_once(pthread_once_t *, void (*) (void));
268 int             pthread_rwlock_destroy(pthread_rwlock_t *);
269 int             pthread_rwlock_init(pthread_rwlock_t *,
270                                     const pthread_rwlockattr_t *);
271 int             pthread_rwlock_rdlock(pthread_rwlock_t *);
272 int             pthread_rwlock_timedrdlock(pthread_rwlock_t *,
273                                     const struct timespec *);
274 int             pthread_rwlock_tryrdlock(pthread_rwlock_t *);
275 int             pthread_rwlock_trywrlock(pthread_rwlock_t *);
276 int             pthread_rwlock_unlock(pthread_rwlock_t *);
277 int             pthread_rwlock_wrlock(pthread_rwlock_t *);
278 int             pthread_rwlock_timedwrlock(pthread_rwlock_t *,
279                                     const struct timespec *);
280 int             pthread_rwlockattr_init(pthread_rwlockattr_t *);
281 int             pthread_rwlockattr_getpshared(const pthread_rwlockattr_t *,
282                                               int *);
283 int             pthread_rwlockattr_setpshared(pthread_rwlockattr_t *, int);
284 int             pthread_rwlockattr_destroy(pthread_rwlockattr_t *);
285 pthread_t       pthread_self(void);
286 int             pthread_setspecific(pthread_key_t, const void *);
287 int             pthread_sigmask(int, const sigset_t *, sigset_t *);
288
289 int             pthread_cancel(pthread_t);
290 int             pthread_setcancelstate(int, int *);
291 int             pthread_setcanceltype(int, int *);
292 void            pthread_testcancel(void);
293
294 int             pthread_getprio(pthread_t);
295 int             pthread_setprio(pthread_t, int);
296 void            pthread_yield(void);
297
298 #if defined(_POSIX_THREAD_PROCESS_SHARED)
299 int             pthread_mutexattr_getpshared(pthread_mutexattr_t *, int *);
300 int             pthread_mutexattr_setpshared(pthread_mutexattr_t *, int);
301 #endif
302
303 int             pthread_mutexattr_getprioceiling(pthread_mutexattr_t *, int *);
304 int             pthread_mutexattr_setprioceiling(pthread_mutexattr_t *, int);
305 int             pthread_mutex_getprioceiling(pthread_mutex_t *, int *);
306 int             pthread_mutex_setprioceiling(pthread_mutex_t *, int, int *);
307
308 int             pthread_mutexattr_getprotocol(pthread_mutexattr_t *, int *);
309 int             pthread_mutexattr_setprotocol(pthread_mutexattr_t *, int);
310
311 int             pthread_attr_getinheritsched(const pthread_attr_t *, int *);
312 int             pthread_attr_getschedparam(const pthread_attr_t *,
313                                            struct sched_param *);
314 int             pthread_attr_getschedpolicy(const pthread_attr_t *, int *);
315 int             pthread_attr_getscope(const pthread_attr_t *, int *);
316 int             pthread_attr_setinheritsched(pthread_attr_t *, int);
317 int             pthread_attr_setschedparam(pthread_attr_t *,
318                                            const struct sched_param *);
319 int             pthread_attr_setschedpolicy(pthread_attr_t *, int);
320 int             pthread_attr_setscope(pthread_attr_t *, int);
321 int             pthread_getschedparam(pthread_t pthread, int *,
322                                       struct sched_param *);
323 int             pthread_setschedparam(pthread_t, int,
324                                       const struct sched_param *);
325 int             pthread_getconcurrency(void);
326 int             pthread_setconcurrency(int);
327
328 int             pthread_attr_setfloatstate(pthread_attr_t *, int);
329 int             pthread_attr_getfloatstate(pthread_attr_t *, int *);
330 __END_DECLS
331
332 #endif