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>
51 __NULLABILITY_PRAGMA_PUSH
54 * Run-time invariant values:
56 #define PTHREAD_DESTRUCTOR_ITERATIONS 4
57 #define PTHREAD_KEYS_MAX 256
58 #define PTHREAD_STACK_MIN __MINSIGSTKSZ
59 #define PTHREAD_THREADS_MAX __ULONG_MAX
60 #define PTHREAD_BARRIER_SERIAL_THREAD -1
63 * Flags for threads and thread attributes.
65 #define PTHREAD_DETACHED 0x1
66 #define PTHREAD_SCOPE_SYSTEM 0x2
67 #define PTHREAD_INHERIT_SCHED 0x4
68 #define PTHREAD_NOFLOAT 0x8
70 #define PTHREAD_CREATE_DETACHED PTHREAD_DETACHED
71 #define PTHREAD_CREATE_JOINABLE 0
72 #define PTHREAD_SCOPE_PROCESS 0
73 #define PTHREAD_EXPLICIT_SCHED 0
76 * Values for process shared/private attributes.
78 #define PTHREAD_PROCESS_PRIVATE 0
79 #define PTHREAD_PROCESS_SHARED 1
82 * Flags for cancelling threads
84 #define PTHREAD_CANCEL_ENABLE 0
85 #define PTHREAD_CANCEL_DISABLE 1
86 #define PTHREAD_CANCEL_DEFERRED 0
87 #define PTHREAD_CANCEL_ASYNCHRONOUS 2
88 #define PTHREAD_CANCELED ((void *) 1)
91 * Flags for once initialization.
93 #define PTHREAD_NEEDS_INIT 0
94 #define PTHREAD_DONE_INIT 1
97 * Static once initialization values.
99 #define PTHREAD_ONCE_INIT { PTHREAD_NEEDS_INIT, NULL }
102 * Static initialization values.
104 #define PTHREAD_MUTEX_INITIALIZER NULL
105 #define PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP ((pthread_mutex_t)1)
106 #define PTHREAD_COND_INITIALIZER NULL
107 #define PTHREAD_RWLOCK_INITIALIZER NULL
110 * Default attribute arguments (draft 4, deprecated).
112 #ifndef PTHREAD_KERNEL
113 #define pthread_condattr_default NULL
114 #define pthread_mutexattr_default NULL
115 #define pthread_attr_default NULL
118 #define PTHREAD_PRIO_NONE 0
119 #define PTHREAD_PRIO_INHERIT 1
120 #define PTHREAD_PRIO_PROTECT 2
123 * Mutex types (Single UNIX Specification, Version 2, 1997).
125 * Note that a mutex attribute with one of the following types:
127 * PTHREAD_MUTEX_NORMAL
128 * PTHREAD_MUTEX_RECURSIVE
130 * will deviate from POSIX specified semantics.
132 enum pthread_mutextype {
133 PTHREAD_MUTEX_ERRORCHECK = 1, /* Default POSIX mutex */
134 PTHREAD_MUTEX_RECURSIVE = 2, /* Recursive mutex */
135 PTHREAD_MUTEX_NORMAL = 3, /* No error checking */
136 PTHREAD_MUTEX_ADAPTIVE_NP = 4, /* Adaptive mutex, spins briefly before blocking on lock */
137 PTHREAD_MUTEX_TYPE_MAX
140 #define PTHREAD_MUTEX_DEFAULT PTHREAD_MUTEX_ERRORCHECK
142 #define PTHREAD_MUTEX_STALLED 0
143 #define PTHREAD_MUTEX_ROBUST 1
145 struct _pthread_cleanup_info {
146 __uintptr_t pthread_cleanup_pad[8];
150 * Thread function prototype definitions:
153 int pthread_atfork(void (*)(void), void (*)(void), void (*)(void));
154 int pthread_attr_destroy(pthread_attr_t * _Nonnull);
155 int pthread_attr_getstack(
156 const pthread_attr_t * _Nonnull __restrict,
157 void ** _Nonnull __restrict,
158 size_t * _Nonnull __restrict);
159 int pthread_attr_getstacksize(const pthread_attr_t * _Nonnull,
161 int pthread_attr_getguardsize(const pthread_attr_t * _Nonnull,
163 int pthread_attr_getstackaddr(const pthread_attr_t *, void **);
164 int pthread_attr_getdetachstate(const pthread_attr_t * _Nonnull,
166 int pthread_attr_init(pthread_attr_t * _Nonnull);
167 int pthread_attr_setstacksize(pthread_attr_t * _Nonnull, size_t);
168 int pthread_attr_setguardsize(pthread_attr_t * _Nonnull, size_t);
169 int pthread_attr_setstack(pthread_attr_t * _Nonnull, void *,
171 int pthread_attr_setstackaddr(pthread_attr_t *, void *);
172 int pthread_attr_setdetachstate(pthread_attr_t * _Nonnull, int);
173 int pthread_barrier_destroy(pthread_barrier_t * _Nonnull);
174 int pthread_barrier_init(pthread_barrier_t * _Nonnull,
175 const pthread_barrierattr_t *, unsigned);
176 int pthread_barrier_wait(pthread_barrier_t * _Nonnull);
177 int pthread_barrierattr_destroy(pthread_barrierattr_t * _Nonnull);
178 int pthread_barrierattr_getpshared(
179 const pthread_barrierattr_t * _Nonnull, int * _Nonnull);
180 int pthread_barrierattr_init(pthread_barrierattr_t * _Nonnull);
181 int pthread_barrierattr_setpshared(pthread_barrierattr_t * _Nonnull,
184 #define pthread_cleanup_push(cleanup_routine, cleanup_arg) \
186 struct _pthread_cleanup_info __cleanup_info__; \
187 __pthread_cleanup_push_imp(cleanup_routine, cleanup_arg,\
188 &__cleanup_info__); \
191 #define pthread_cleanup_pop(execute) \
194 __pthread_cleanup_pop_imp(execute); \
197 int pthread_condattr_destroy(pthread_condattr_t * _Nonnull);
198 int pthread_condattr_getclock(const pthread_condattr_t * _Nonnull,
199 clockid_t * _Nonnull);
200 int pthread_condattr_getpshared(const pthread_condattr_t * _Nonnull,
202 int pthread_condattr_init(pthread_condattr_t * _Nonnull);
203 int pthread_condattr_setclock(pthread_condattr_t * _Nonnull,
205 int pthread_condattr_setpshared(pthread_condattr_t * _Nonnull, int);
206 int pthread_cond_broadcast(pthread_cond_t * _Nonnull);
207 int pthread_cond_destroy(pthread_cond_t * _Nonnull);
208 int pthread_cond_init(pthread_cond_t * _Nonnull,
209 const pthread_condattr_t *);
210 int pthread_cond_signal(pthread_cond_t * _Nonnull);
211 int pthread_cond_timedwait(pthread_cond_t * _Nonnull,
212 pthread_mutex_t * _Nonnull __mutex,
213 const struct timespec * _Nonnull)
214 __requires_exclusive(*__mutex);
215 int pthread_cond_wait(pthread_cond_t * _Nonnull,
216 pthread_mutex_t * _Nonnull __mutex)
217 __requires_exclusive(*__mutex);
218 int pthread_create(pthread_t * _Nonnull, const pthread_attr_t *,
219 void *(* _Nonnull) (void *), void *);
220 int pthread_detach(pthread_t);
221 int pthread_equal(pthread_t, pthread_t);
222 void pthread_exit(void *) __dead2;
223 void *pthread_getspecific(pthread_key_t);
224 int pthread_getcpuclockid(pthread_t, clockid_t * _Nonnull);
225 int pthread_join(pthread_t, void **);
226 int pthread_key_create(pthread_key_t * _Nonnull,
228 int pthread_key_delete(pthread_key_t);
229 int pthread_mutexattr_init(pthread_mutexattr_t * _Nonnull);
230 int pthread_mutexattr_destroy(pthread_mutexattr_t * _Nonnull);
231 int pthread_mutexattr_getpshared(
232 const pthread_mutexattr_t * _Nonnull, int * _Nonnull);
233 int pthread_mutexattr_gettype(pthread_mutexattr_t * _Nonnull,
235 int pthread_mutexattr_settype(pthread_mutexattr_t * _Nonnull, int);
236 int pthread_mutexattr_setpshared(pthread_mutexattr_t * _Nonnull,
238 int pthread_mutex_consistent(pthread_mutex_t * _Nonnull __mutex)
239 __requires_exclusive(*__mutex);
240 int pthread_mutex_destroy(pthread_mutex_t * _Nonnull __mutex)
241 __requires_unlocked(*__mutex);
242 int pthread_mutex_init(pthread_mutex_t * _Nonnull __mutex,
243 const pthread_mutexattr_t *)
244 __requires_unlocked(*__mutex);
245 int pthread_mutex_lock(pthread_mutex_t * _Nonnull __mutex)
246 __locks_exclusive(*__mutex);
247 int pthread_mutex_trylock(pthread_mutex_t * _Nonnull __mutex)
248 __trylocks_exclusive(0, *__mutex);
249 int pthread_mutex_timedlock(pthread_mutex_t * _Nonnull __mutex,
250 const struct timespec * _Nonnull)
251 __trylocks_exclusive(0, *__mutex);
252 int pthread_mutex_unlock(pthread_mutex_t * _Nonnull __mutex)
254 int pthread_once(pthread_once_t * _Nonnull,
255 void (* _Nonnull) (void));
256 int pthread_rwlock_destroy(pthread_rwlock_t * _Nonnull __rwlock)
257 __requires_unlocked(*__rwlock);
258 int pthread_rwlock_init(pthread_rwlock_t * _Nonnull __rwlock,
259 const pthread_rwlockattr_t *)
260 __requires_unlocked(*__rwlock);
261 int pthread_rwlock_rdlock(pthread_rwlock_t * _Nonnull __rwlock)
262 __locks_shared(*__rwlock);
263 int pthread_rwlock_timedrdlock(pthread_rwlock_t * _Nonnull __rwlock,
264 const struct timespec * _Nonnull)
265 __trylocks_shared(0, *__rwlock);
266 int pthread_rwlock_timedwrlock(pthread_rwlock_t * _Nonnull __rwlock,
267 const struct timespec * _Nonnull)
268 __trylocks_exclusive(0, *__rwlock);
269 int pthread_rwlock_tryrdlock(pthread_rwlock_t * _Nonnull __rwlock)
270 __trylocks_shared(0, *__rwlock);
271 int pthread_rwlock_trywrlock(pthread_rwlock_t * _Nonnull __rwlock)
272 __trylocks_exclusive(0, *__rwlock);
273 int pthread_rwlock_unlock(pthread_rwlock_t * _Nonnull __rwlock)
274 __unlocks(*__rwlock);
275 int pthread_rwlock_wrlock(pthread_rwlock_t * _Nonnull __rwlock)
276 __locks_exclusive(*__rwlock);
277 int pthread_rwlockattr_destroy(pthread_rwlockattr_t * _Nonnull);
278 int pthread_rwlockattr_getkind_np(
279 const pthread_rwlockattr_t * _Nonnull, int *);
280 int pthread_rwlockattr_getpshared(
281 const pthread_rwlockattr_t * _Nonnull, int * _Nonnull);
282 int pthread_rwlockattr_init(pthread_rwlockattr_t * _Nonnull);
283 int pthread_rwlockattr_setkind_np(pthread_rwlockattr_t * _Nonnull,
285 int pthread_rwlockattr_setpshared(pthread_rwlockattr_t * _Nonnull,
287 pthread_t pthread_self(void);
288 int pthread_setspecific(pthread_key_t, const void *);
290 int pthread_spin_init(pthread_spinlock_t * _Nonnull __spin, int)
291 __requires_unlocked(*__spin);
292 int pthread_spin_destroy(pthread_spinlock_t * _Nonnull __spin)
293 __requires_unlocked(*__spin);
294 int pthread_spin_lock(pthread_spinlock_t * _Nonnull __spin)
295 __locks_exclusive(*__spin);
296 int pthread_spin_trylock(pthread_spinlock_t * _Nonnull __spin)
297 __trylocks_exclusive(0, *__spin);
298 int pthread_spin_unlock(pthread_spinlock_t * _Nonnull __spin)
300 int pthread_cancel(pthread_t);
301 int pthread_setcancelstate(int, int *);
302 int pthread_setcanceltype(int, int *);
303 void pthread_testcancel(void);
306 int pthread_getprio(pthread_t);
307 int pthread_setprio(pthread_t, int);
308 void pthread_yield(void);
311 int pthread_mutexattr_getprioceiling(pthread_mutexattr_t *, int *);
312 int pthread_mutexattr_setprioceiling(pthread_mutexattr_t *, int);
313 int pthread_mutex_getprioceiling(pthread_mutex_t *, int *);
314 int pthread_mutex_setprioceiling(pthread_mutex_t *, int, int *);
316 int pthread_mutexattr_getprotocol(pthread_mutexattr_t *, int *);
317 int pthread_mutexattr_setprotocol(pthread_mutexattr_t *, int);
319 int pthread_mutexattr_getrobust(
320 pthread_mutexattr_t * _Nonnull __restrict,
321 int * _Nonnull __restrict);
322 int pthread_mutexattr_setrobust(pthread_mutexattr_t * _Nonnull,
325 int pthread_attr_getinheritsched(const pthread_attr_t *, int *);
326 int pthread_attr_getschedparam(const pthread_attr_t * _Nonnull,
327 struct sched_param * _Nonnull);
328 int pthread_attr_getschedpolicy(const pthread_attr_t * _Nonnull,
330 int pthread_attr_getscope(const pthread_attr_t * _Nonnull,
332 int pthread_attr_setinheritsched(pthread_attr_t *, int);
333 int pthread_attr_setschedparam(pthread_attr_t * _Nonnull,
334 const struct sched_param * _Nonnull);
335 int pthread_attr_setschedpolicy(pthread_attr_t * _Nonnull, int);
336 int pthread_attr_setscope(pthread_attr_t * _Nonnull, int);
337 int pthread_getschedparam(pthread_t pthread, int * _Nonnull,
338 struct sched_param * _Nonnull);
339 int pthread_setschedparam(pthread_t, int,
340 const struct sched_param * _Nonnull);
342 int pthread_getconcurrency(void);
343 int pthread_setconcurrency(int);
346 void __pthread_cleanup_push_imp(void (*)(void *), void *,
347 struct _pthread_cleanup_info *);
348 void __pthread_cleanup_pop_imp(int);
350 __NULLABILITY_PRAGMA_POP
352 #endif /* !_PTHREAD_H_ */