2 * Copyright (c) 1993, 1994 by Chris Provenzano, proven@mit.edu
3 * Copyright (c) 1995-1998 by John Birrell <jb@cimlogic.com.au>
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
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
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
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>
50 * Run-time invariant values:
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
59 * Flags for threads and thread attributes.
61 #define PTHREAD_DETACHED 0x1
62 #define PTHREAD_SCOPE_SYSTEM 0x2
63 #define PTHREAD_INHERIT_SCHED 0x4
64 #define PTHREAD_NOFLOAT 0x8
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
72 * Values for process shared/private attributes.
74 #define PTHREAD_PROCESS_PRIVATE 0
75 #define PTHREAD_PROCESS_SHARED 1
78 * Flags for cancelling threads
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)
87 * Flags for once initialization.
89 #define PTHREAD_NEEDS_INIT 0
90 #define PTHREAD_DONE_INIT 1
93 * Static once initialization values.
95 #define PTHREAD_ONCE_INIT { PTHREAD_NEEDS_INIT, NULL }
98 * Static initialization values.
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
106 * Default attribute arguments (draft 4, deprecated).
108 #ifndef PTHREAD_KERNEL
109 #define pthread_condattr_default NULL
110 #define pthread_mutexattr_default NULL
111 #define pthread_attr_default NULL
114 #define PTHREAD_PRIO_NONE 0
115 #define PTHREAD_PRIO_INHERIT 1
116 #define PTHREAD_PRIO_PROTECT 2
119 * Mutex types (Single UNIX Specification, Version 2, 1997).
121 * Note that a mutex attribute with one of the following types:
123 * PTHREAD_MUTEX_NORMAL
124 * PTHREAD_MUTEX_RECURSIVE
126 * will deviate from POSIX specified semantics.
128 enum 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
136 #define PTHREAD_MUTEX_DEFAULT PTHREAD_MUTEX_ERRORCHECK
138 #define PTHREAD_MUTEX_STALLED 0
139 #define PTHREAD_MUTEX_ROBUST 1
141 struct _pthread_cleanup_info {
142 __uintptr_t pthread_cleanup_pad[8];
146 * Thread function prototype definitions:
149 int pthread_atfork(void (*)(void), void (*)(void), void (*)(void));
150 int pthread_attr_destroy(pthread_attr_t *);
151 int pthread_attr_getstack(
152 const pthread_attr_t * __restrict, void ** __restrict,
153 size_t * __restrict);
154 int pthread_attr_getstacksize(const pthread_attr_t * __restrict,
155 size_t * __restrict);
156 int pthread_attr_getguardsize(const pthread_attr_t * __restrict,
157 size_t * __restrict);
158 int pthread_attr_getstackaddr(const pthread_attr_t *, void **);
159 int pthread_attr_getdetachstate(const pthread_attr_t *,
161 int pthread_attr_init(pthread_attr_t *);
162 int pthread_attr_setstacksize(pthread_attr_t *, size_t);
163 int pthread_attr_setguardsize(pthread_attr_t *, size_t);
164 int pthread_attr_setstack(pthread_attr_t *, void *,
166 int pthread_attr_setstackaddr(pthread_attr_t *, void *);
167 int pthread_attr_setdetachstate(pthread_attr_t *, int);
168 int pthread_barrier_destroy(pthread_barrier_t *);
169 int pthread_barrier_init(pthread_barrier_t * __restrict,
170 const pthread_barrierattr_t * __restrict, unsigned);
171 int pthread_barrier_wait(pthread_barrier_t *);
172 int pthread_barrierattr_destroy(pthread_barrierattr_t *);
173 int pthread_barrierattr_getpshared(
174 const pthread_barrierattr_t * __restrict, int * __restrict);
175 int pthread_barrierattr_init(pthread_barrierattr_t *);
176 int pthread_barrierattr_setpshared(pthread_barrierattr_t *, int);
178 #define pthread_cleanup_push(cleanup_routine, cleanup_arg) \
180 struct _pthread_cleanup_info __cleanup_info__; \
181 __pthread_cleanup_push_imp(cleanup_routine, cleanup_arg,\
182 &__cleanup_info__); \
185 #define pthread_cleanup_pop(execute) \
188 __pthread_cleanup_pop_imp(execute); \
191 int pthread_condattr_destroy(pthread_condattr_t *);
192 int pthread_condattr_getclock(const pthread_condattr_t * __restrict,
193 clockid_t * __restrict);
194 int pthread_condattr_getpshared(const pthread_condattr_t *, int *);
195 int pthread_condattr_init(pthread_condattr_t *);
196 int pthread_condattr_setclock(pthread_condattr_t *, clockid_t);
197 int pthread_condattr_setpshared(pthread_condattr_t *, int);
198 int pthread_cond_broadcast(pthread_cond_t *);
199 int pthread_cond_destroy(pthread_cond_t *);
200 int pthread_cond_init(pthread_cond_t * __restrict,
201 const pthread_condattr_t * __restrict);
202 int pthread_cond_signal(pthread_cond_t *);
203 int pthread_cond_timedwait(pthread_cond_t *,
204 pthread_mutex_t * __mutex,
205 const struct timespec *)
206 __requires_exclusive(*__mutex);
207 int pthread_cond_wait(pthread_cond_t * __restrict,
208 pthread_mutex_t * __restrict __mutex)
209 __requires_exclusive(*__mutex);
210 int pthread_create(pthread_t * __restrict,
211 const pthread_attr_t * __restrict, void *(*) (void *),
213 int pthread_detach(pthread_t);
214 int pthread_equal(pthread_t, pthread_t);
215 void pthread_exit(void *) __dead2;
216 void *pthread_getspecific(pthread_key_t);
217 int pthread_getcpuclockid(pthread_t, clockid_t *);
218 int pthread_join(pthread_t, void **);
219 int pthread_key_create(pthread_key_t *, void (*) (void *));
220 int pthread_key_delete(pthread_key_t);
221 int pthread_mutexattr_init(pthread_mutexattr_t *);
222 int pthread_mutexattr_destroy(pthread_mutexattr_t *);
223 int pthread_mutexattr_getpshared(
224 const pthread_mutexattr_t * __restrict,
226 int pthread_mutexattr_gettype(
227 const pthread_mutexattr_t * __restrict, int * __restrict);
228 int pthread_mutexattr_settype(pthread_mutexattr_t *, int);
229 int pthread_mutexattr_setpshared(pthread_mutexattr_t *, int);
230 int pthread_mutex_consistent(pthread_mutex_t * __mutex)
231 __requires_exclusive(*__mutex);
232 int pthread_mutex_destroy(pthread_mutex_t * __mutex)
233 __requires_unlocked(*__mutex);
234 int pthread_mutex_init(pthread_mutex_t * __restrict __mutex,
235 const pthread_mutexattr_t * __restrict)
236 __requires_unlocked(*__mutex);
237 int pthread_mutex_lock(pthread_mutex_t * __mutex)
238 __locks_exclusive(*__mutex);
239 int pthread_mutex_trylock(pthread_mutex_t * __mutex)
240 __trylocks_exclusive(0, *__mutex);
241 int pthread_mutex_timedlock(pthread_mutex_t * __restrict __mutex,
242 const struct timespec * __restrict)
243 __trylocks_exclusive(0, *__mutex);
244 int pthread_mutex_unlock(pthread_mutex_t * __mutex)
246 int pthread_once(pthread_once_t *, void (*) (void));
247 int pthread_rwlock_destroy(pthread_rwlock_t * __rwlock)
248 __requires_unlocked(*__rwlock);
249 int pthread_rwlock_init(pthread_rwlock_t * __restrict __rwlock,
250 const pthread_rwlockattr_t * __restrict)
251 __requires_unlocked(*__rwlock);
252 int pthread_rwlock_rdlock(pthread_rwlock_t * __rwlock)
253 __locks_shared(*__rwlock);
254 int pthread_rwlock_timedrdlock(
255 pthread_rwlock_t * __restrict __rwlock,
256 const struct timespec * __restrict)
257 __trylocks_shared(0, *__rwlock);
258 int pthread_rwlock_timedwrlock(
259 pthread_rwlock_t * __restrict __rwlock,
260 const struct timespec * __restrict)
261 __trylocks_exclusive(0, *__rwlock);
262 int pthread_rwlock_tryrdlock(pthread_rwlock_t * __rwlock)
263 __trylocks_shared(0, *__rwlock);
264 int pthread_rwlock_trywrlock(pthread_rwlock_t * __rwlock)
265 __trylocks_exclusive(0, *__rwlock);
266 int pthread_rwlock_unlock(pthread_rwlock_t * __rwlock)
267 __unlocks(*__rwlock);
268 int pthread_rwlock_wrlock(pthread_rwlock_t * __rwlock)
269 __locks_exclusive(*__rwlock);
270 int pthread_rwlockattr_destroy(pthread_rwlockattr_t *);
271 int pthread_rwlockattr_getkind_np(const pthread_rwlockattr_t *,
273 int pthread_rwlockattr_getpshared(
274 const pthread_rwlockattr_t * __restrict,
276 int pthread_rwlockattr_init(pthread_rwlockattr_t *);
277 int pthread_rwlockattr_setkind_np(pthread_rwlockattr_t *,
279 int pthread_rwlockattr_setpshared(pthread_rwlockattr_t *, int);
280 pthread_t pthread_self(void);
281 int pthread_setspecific(pthread_key_t, const void *);
283 int pthread_spin_init(pthread_spinlock_t * __spin, int)
284 __requires_unlocked(*__spin);
285 int pthread_spin_destroy(pthread_spinlock_t * __spin)
286 __requires_unlocked(*__spin);
287 int pthread_spin_lock(pthread_spinlock_t * __spin)
288 __locks_exclusive(*__spin);
289 int pthread_spin_trylock(pthread_spinlock_t * __spin)
290 __trylocks_exclusive(0, *__spin);
291 int pthread_spin_unlock(pthread_spinlock_t * __spin)
293 int pthread_cancel(pthread_t);
294 int pthread_setcancelstate(int, int *);
295 int pthread_setcanceltype(int, int *);
296 void pthread_testcancel(void);
299 int pthread_getprio(pthread_t);
300 int pthread_setprio(pthread_t, int);
301 void pthread_yield(void);
304 int pthread_mutexattr_getprioceiling(
305 const pthread_mutexattr_t * __restrict,
307 int pthread_mutexattr_setprioceiling(pthread_mutexattr_t *, int);
308 int pthread_mutex_getprioceiling(const pthread_mutex_t * __restrict,
310 int pthread_mutex_setprioceiling(pthread_mutex_t * __restrict, int,
313 int pthread_mutexattr_getprotocol(
314 const pthread_mutexattr_t * __restrict,
316 int pthread_mutexattr_setprotocol(pthread_mutexattr_t *, int);
318 int pthread_mutexattr_getrobust(
319 pthread_mutexattr_t * __restrict, int * __restrict);
320 int pthread_mutexattr_setrobust(pthread_mutexattr_t *, int);
322 int pthread_attr_getinheritsched(const pthread_attr_t * __restrict,
324 int pthread_attr_getschedparam(const pthread_attr_t *,
325 struct sched_param *);
326 int pthread_attr_getschedpolicy(const pthread_attr_t * __restrict,
328 int pthread_attr_getscope(const pthread_attr_t * __restrict,
330 int pthread_attr_setinheritsched(pthread_attr_t *, int);
331 int pthread_attr_setschedparam(pthread_attr_t *,
332 const struct sched_param *);
333 int pthread_attr_setschedpolicy(pthread_attr_t *, int);
334 int pthread_attr_setscope(pthread_attr_t *, int);
335 int pthread_getschedparam(pthread_t pthread, int * __restrict,
336 struct sched_param * __restrict);
337 int pthread_setschedparam(pthread_t, int,
338 const struct sched_param *);
340 int pthread_getconcurrency(void);
341 int pthread_setconcurrency(int);
344 void __pthread_cleanup_push_imp(void (*)(void *), void *,
345 struct _pthread_cleanup_info *);
346 void __pthread_cleanup_pop_imp(int);
349 #endif /* !_PTHREAD_H_ */