2 * SPDX-License-Identifier: BSD-4-Clause
4 * Copyright (c) 1993, 1994 by Chris Provenzano, proven@mit.edu
5 * Copyright (c) 1995-1998 by John Birrell <jb@cimlogic.com.au>
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. All advertising materials mentioning features or use of this software
17 * must display the following acknowledgement:
18 * This product includes software developed by Chris Provenzano.
19 * 4. The name of Chris Provenzano may not be used to endorse or promote
20 * products derived from this software without specific prior written
23 * THIS SOFTWARE IS PROVIDED BY CHRIS PROVENZANO ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL CHRIS PROVENZANO BE LIABLE FOR ANY
27 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
28 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
29 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
30 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
43 #include <sys/cdefs.h>
44 #include <sys/_pthreadtypes.h>
45 #include <machine/_limits.h>
46 #include <machine/_types.h>
47 #include <sys/_sigset.h>
52 * Run-time invariant values:
54 #define PTHREAD_DESTRUCTOR_ITERATIONS 4
55 #define PTHREAD_KEYS_MAX 256
56 #define PTHREAD_STACK_MIN __MINSIGSTKSZ
57 #define PTHREAD_THREADS_MAX __ULONG_MAX
58 #define PTHREAD_BARRIER_SERIAL_THREAD -1
61 * Flags for threads and thread attributes.
63 #define PTHREAD_DETACHED 0x1
64 #define PTHREAD_SCOPE_SYSTEM 0x2
65 #define PTHREAD_INHERIT_SCHED 0x4
66 #define PTHREAD_NOFLOAT 0x8
68 #define PTHREAD_CREATE_DETACHED PTHREAD_DETACHED
69 #define PTHREAD_CREATE_JOINABLE 0
70 #define PTHREAD_SCOPE_PROCESS 0
71 #define PTHREAD_EXPLICIT_SCHED 0
74 * Values for process shared/private attributes.
76 #define PTHREAD_PROCESS_PRIVATE 0
77 #define PTHREAD_PROCESS_SHARED 1
80 * Flags for cancelling threads
82 #define PTHREAD_CANCEL_ENABLE 0
83 #define PTHREAD_CANCEL_DISABLE 1
84 #define PTHREAD_CANCEL_DEFERRED 0
85 #define PTHREAD_CANCEL_ASYNCHRONOUS 2
86 #define PTHREAD_CANCELED ((void *) 1)
89 * Flags for once initialization.
91 #define PTHREAD_NEEDS_INIT 0
92 #define PTHREAD_DONE_INIT 1
95 * Static once initialization values.
97 #define PTHREAD_ONCE_INIT { PTHREAD_NEEDS_INIT, NULL }
100 * Static initialization values.
102 #define PTHREAD_MUTEX_INITIALIZER NULL
103 #define PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP ((pthread_mutex_t)1)
104 #define PTHREAD_COND_INITIALIZER NULL
105 #define PTHREAD_RWLOCK_INITIALIZER NULL
108 * Default attribute arguments (draft 4, deprecated).
110 #ifndef PTHREAD_KERNEL
111 #define pthread_condattr_default NULL
112 #define pthread_mutexattr_default NULL
113 #define pthread_attr_default NULL
116 #define PTHREAD_PRIO_NONE 0
117 #define PTHREAD_PRIO_INHERIT 1
118 #define PTHREAD_PRIO_PROTECT 2
121 * Mutex types (Single UNIX Specification, Version 2, 1997).
123 * Note that a mutex attribute with one of the following types:
125 * PTHREAD_MUTEX_NORMAL
126 * PTHREAD_MUTEX_RECURSIVE
128 * will deviate from POSIX specified semantics.
130 enum pthread_mutextype {
131 PTHREAD_MUTEX_ERRORCHECK = 1, /* Default POSIX mutex */
132 PTHREAD_MUTEX_RECURSIVE = 2, /* Recursive mutex */
133 PTHREAD_MUTEX_NORMAL = 3, /* No error checking */
134 PTHREAD_MUTEX_ADAPTIVE_NP = 4, /* Adaptive mutex, spins briefly before blocking on lock */
135 PTHREAD_MUTEX_TYPE_MAX
138 #define PTHREAD_MUTEX_DEFAULT PTHREAD_MUTEX_ERRORCHECK
140 #define PTHREAD_MUTEX_STALLED 0
141 #define PTHREAD_MUTEX_ROBUST 1
143 struct _pthread_cleanup_info {
144 __uintptr_t pthread_cleanup_pad[8];
148 * Thread function prototype definitions:
151 int pthread_atfork(void (*)(void), void (*)(void), void (*)(void));
152 int pthread_attr_destroy(pthread_attr_t *);
153 int pthread_attr_getstack(
154 const pthread_attr_t * __restrict, void ** __restrict,
155 size_t * __restrict);
156 int pthread_attr_getstacksize(const pthread_attr_t *,
158 int pthread_attr_getguardsize(const pthread_attr_t *,
160 int pthread_attr_getstackaddr(const pthread_attr_t *, void **);
161 int pthread_attr_getdetachstate(const pthread_attr_t *,
163 int pthread_attr_init(pthread_attr_t *);
164 int pthread_attr_setstacksize(pthread_attr_t *, size_t);
165 int pthread_attr_setguardsize(pthread_attr_t *, size_t);
166 int pthread_attr_setstack(pthread_attr_t *, void *,
168 int pthread_attr_setstackaddr(pthread_attr_t *, void *);
169 int pthread_attr_setdetachstate(pthread_attr_t *, int);
170 int pthread_barrier_destroy(pthread_barrier_t *);
171 int pthread_barrier_init(pthread_barrier_t *,
172 const pthread_barrierattr_t *, unsigned);
173 int pthread_barrier_wait(pthread_barrier_t *);
174 int pthread_barrierattr_destroy(pthread_barrierattr_t *);
175 int pthread_barrierattr_getpshared(
176 const pthread_barrierattr_t *, int *);
177 int pthread_barrierattr_init(pthread_barrierattr_t *);
178 int pthread_barrierattr_setpshared(pthread_barrierattr_t *, int);
180 #define pthread_cleanup_push(cleanup_routine, cleanup_arg) \
182 struct _pthread_cleanup_info __cleanup_info__; \
183 __pthread_cleanup_push_imp(cleanup_routine, cleanup_arg,\
184 &__cleanup_info__); \
187 #define pthread_cleanup_pop(execute) \
190 __pthread_cleanup_pop_imp(execute); \
193 int pthread_condattr_destroy(pthread_condattr_t *);
194 int pthread_condattr_getclock(const pthread_condattr_t *,
196 int pthread_condattr_getpshared(const pthread_condattr_t *, int *);
197 int pthread_condattr_init(pthread_condattr_t *);
198 int pthread_condattr_setclock(pthread_condattr_t *, clockid_t);
199 int pthread_condattr_setpshared(pthread_condattr_t *, int);
200 int pthread_cond_broadcast(pthread_cond_t *);
201 int pthread_cond_destroy(pthread_cond_t *);
202 int pthread_cond_init(pthread_cond_t *, const pthread_condattr_t *);
203 int pthread_cond_signal(pthread_cond_t *);
204 int pthread_cond_timedwait(pthread_cond_t *,
205 pthread_mutex_t * __mutex,
206 const struct timespec *)
207 __requires_exclusive(*__mutex);
208 int pthread_cond_wait(pthread_cond_t *, pthread_mutex_t * __mutex)
209 __requires_exclusive(*__mutex);
210 int pthread_create(pthread_t *, const pthread_attr_t *,
211 void *(*) (void *), void *);
212 int pthread_detach(pthread_t);
213 int pthread_equal(pthread_t, pthread_t);
214 void pthread_exit(void *) __dead2;
215 void *pthread_getspecific(pthread_key_t);
216 int pthread_getcpuclockid(pthread_t, clockid_t *);
217 int pthread_join(pthread_t, void **);
218 int pthread_key_create(pthread_key_t *, void (*) (void *));
219 int pthread_key_delete(pthread_key_t);
220 int pthread_mutexattr_init(pthread_mutexattr_t *);
221 int pthread_mutexattr_destroy(pthread_mutexattr_t *);
222 int pthread_mutexattr_getpshared(const pthread_mutexattr_t *,
224 int pthread_mutexattr_gettype(pthread_mutexattr_t *, int *);
225 int pthread_mutexattr_settype(pthread_mutexattr_t *, int);
226 int pthread_mutexattr_setpshared(pthread_mutexattr_t *, int);
227 int pthread_mutex_consistent(pthread_mutex_t * __mutex)
228 __requires_exclusive(*__mutex);
229 int pthread_mutex_destroy(pthread_mutex_t * __mutex)
230 __requires_unlocked(*__mutex);
231 int pthread_mutex_init(pthread_mutex_t * __mutex,
232 const pthread_mutexattr_t *)
233 __requires_unlocked(*__mutex);
234 int pthread_mutex_lock(pthread_mutex_t * __mutex)
235 __locks_exclusive(*__mutex);
236 int pthread_mutex_trylock(pthread_mutex_t * __mutex)
237 __trylocks_exclusive(0, *__mutex);
238 int pthread_mutex_timedlock(pthread_mutex_t * __mutex,
239 const struct timespec *)
240 __trylocks_exclusive(0, *__mutex);
241 int pthread_mutex_unlock(pthread_mutex_t * __mutex)
243 int pthread_once(pthread_once_t *, void (*) (void));
244 int pthread_rwlock_destroy(pthread_rwlock_t * __rwlock)
245 __requires_unlocked(*__rwlock);
246 int pthread_rwlock_init(pthread_rwlock_t * __rwlock,
247 const pthread_rwlockattr_t *)
248 __requires_unlocked(*__rwlock);
249 int pthread_rwlock_rdlock(pthread_rwlock_t * __rwlock)
250 __locks_shared(*__rwlock);
251 int pthread_rwlock_timedrdlock(pthread_rwlock_t * __rwlock,
252 const struct timespec *)
253 __trylocks_shared(0, *__rwlock);
254 int pthread_rwlock_timedwrlock(pthread_rwlock_t * __rwlock,
255 const struct timespec *)
256 __trylocks_exclusive(0, *__rwlock);
257 int pthread_rwlock_tryrdlock(pthread_rwlock_t * __rwlock)
258 __trylocks_shared(0, *__rwlock);
259 int pthread_rwlock_trywrlock(pthread_rwlock_t * __rwlock)
260 __trylocks_exclusive(0, *__rwlock);
261 int pthread_rwlock_unlock(pthread_rwlock_t * __rwlock)
262 __unlocks(*__rwlock);
263 int pthread_rwlock_wrlock(pthread_rwlock_t * __rwlock)
264 __locks_exclusive(*__rwlock);
265 int pthread_rwlockattr_destroy(pthread_rwlockattr_t *);
266 int pthread_rwlockattr_getkind_np(const pthread_rwlockattr_t *,
268 int pthread_rwlockattr_getpshared(const pthread_rwlockattr_t *,
270 int pthread_rwlockattr_init(pthread_rwlockattr_t *);
271 int pthread_rwlockattr_setkind_np(pthread_rwlockattr_t *,
273 int pthread_rwlockattr_setpshared(pthread_rwlockattr_t *, int);
274 pthread_t pthread_self(void);
275 int pthread_setspecific(pthread_key_t, const void *);
277 int pthread_spin_init(pthread_spinlock_t * __spin, int)
278 __requires_unlocked(*__spin);
279 int pthread_spin_destroy(pthread_spinlock_t * __spin)
280 __requires_unlocked(*__spin);
281 int pthread_spin_lock(pthread_spinlock_t * __spin)
282 __locks_exclusive(*__spin);
283 int pthread_spin_trylock(pthread_spinlock_t * __spin)
284 __trylocks_exclusive(0, *__spin);
285 int pthread_spin_unlock(pthread_spinlock_t * __spin)
287 int pthread_cancel(pthread_t);
288 int pthread_setcancelstate(int, int *);
289 int pthread_setcanceltype(int, int *);
290 void pthread_testcancel(void);
293 int pthread_getprio(pthread_t);
294 int pthread_setprio(pthread_t, int);
295 void pthread_yield(void);
298 int pthread_mutexattr_getprioceiling(pthread_mutexattr_t *, int *);
299 int pthread_mutexattr_setprioceiling(pthread_mutexattr_t *, int);
300 int pthread_mutex_getprioceiling(pthread_mutex_t *, int *);
301 int pthread_mutex_setprioceiling(pthread_mutex_t *, int, int *);
303 int pthread_mutexattr_getprotocol(pthread_mutexattr_t *, int *);
304 int pthread_mutexattr_setprotocol(pthread_mutexattr_t *, int);
306 int pthread_mutexattr_getrobust(
307 pthread_mutexattr_t * __restrict, int * __restrict);
308 int pthread_mutexattr_setrobust(pthread_mutexattr_t *, int);
310 int pthread_attr_getinheritsched(const pthread_attr_t *, int *);
311 int pthread_attr_getschedparam(const pthread_attr_t *,
312 struct sched_param *);
313 int pthread_attr_getschedpolicy(const pthread_attr_t *, int *);
314 int pthread_attr_getscope(const pthread_attr_t *, int *);
315 int pthread_attr_setinheritsched(pthread_attr_t *, int);
316 int pthread_attr_setschedparam(pthread_attr_t *,
317 const struct sched_param *);
318 int pthread_attr_setschedpolicy(pthread_attr_t *, int);
319 int pthread_attr_setscope(pthread_attr_t *, int);
320 int pthread_getschedparam(pthread_t pthread, int *,
321 struct sched_param *);
322 int pthread_setschedparam(pthread_t, int,
323 const struct sched_param *);
325 int pthread_getconcurrency(void);
326 int pthread_setconcurrency(int);
329 void __pthread_cleanup_push_imp(void (*)(void *), void *,
330 struct _pthread_cleanup_info *);
331 void __pthread_cleanup_pop_imp(int);
334 #endif /* !_PTHREAD_H_ */