1/* $OpenBSD: pthread.h,v 1.5 2025/11/11 18:54:05 semarie Exp $ */
2
3/*
4 * Copyright (c) 1993, 1994 by Chris Provenzano, proven@mit.edu
5 * Copyright (c) 1995-1998 by John Birrell <jb@cimlogic.com.au>
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
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
21 * permission.
22 *
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
33 * SUCH DAMAGE.
34 *
35 * $FreeBSD: pthread.h,v 1.13 1999/07/31 08:36:07 rse Exp $
36 */
37#ifndef _PTHREAD_H_
38#define _PTHREAD_H_
39
40/*
41 * Header files.
42 */
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 512
54#define PTHREAD_STACK_MIN (1U << _MAX_PAGE_SHIFT)
55#define PTHREAD_THREADS_MAX ULONG_MAX
56
57/*
58 * Flags for threads and thread attributes.
59 */
60#define PTHREAD_DETACHED 0x1
61#define PTHREAD_SCOPE_SYSTEM 0x2
62#define PTHREAD_INHERIT_SCHED 0x4
63#define PTHREAD_NOFLOAT 0x8
64
65#define PTHREAD_CREATE_DETACHED PTHREAD_DETACHED
66#define PTHREAD_CREATE_JOINABLE 0
67#define PTHREAD_SCOPE_PROCESS 0
68#define PTHREAD_EXPLICIT_SCHED 0
69
70/*
71 * Flags for read/write lock attributes
72 */
73#define PTHREAD_PROCESS_PRIVATE 0
74#define PTHREAD_PROCESS_SHARED 1
75
76/*
77 * Flags for cancelling threads
78 */
79#define PTHREAD_CANCEL_ENABLE 0
80#define PTHREAD_CANCEL_DISABLE 1
81#define PTHREAD_CANCEL_DEFERRED 0
82#define PTHREAD_CANCEL_ASYNCHRONOUS 2
83#define PTHREAD_CANCELED ((void *) 1)
84
85/*
86 * Barrier flags
87 */
88#define PTHREAD_BARRIER_SERIAL_THREAD -1
89
90/*
91 * Forward structure definitions.
92 *
93 * These are mostly opaque to the user.
94 */
95struct pthread;
96struct pthread_attr;
97struct pthread_cond;
98struct pthread_cond_attr;
99struct pthread_mutex;
100struct pthread_mutex_attr;
101struct pthread_once;
102struct pthread_rwlock;
103struct pthread_rwlockattr;
104
105/*
106 * Primitive system data type definitions required by P1003.1c.
107 *
108 * Note that P1003.1c specifies that there are no defined comparison
109 * or assignment operators for the types pthread_attr_t, pthread_cond_t,
110 * pthread_condattr_t, pthread_mutex_t, pthread_mutexattr_t.
111 */
112typedef struct pthread *pthread_t;
113typedef struct pthread_attr *pthread_attr_t;
114typedef volatile struct pthread_mutex *pthread_mutex_t;
115typedef struct pthread_mutex_attr *pthread_mutexattr_t;
116typedef struct pthread_cond *pthread_cond_t;
117typedef struct pthread_cond_attr *pthread_condattr_t;
118typedef int pthread_key_t;
119typedef struct pthread_once pthread_once_t;
120typedef struct pthread_rwlock *pthread_rwlock_t;
121typedef struct pthread_rwlockattr *pthread_rwlockattr_t;
122typedef struct pthread_barrier *pthread_barrier_t;
123typedef struct pthread_barrierattr *pthread_barrierattr_t;
124typedef struct pthread_spinlock *pthread_spinlock_t;
125
126/*
127 * Additional type definitions:
128 *
129 * Note that P1003.1c reserves the prefixes pthread_ and PTHREAD_ for
130 * use in header symbols.
131 */
132typedef void *pthread_addr_t;
133typedef void *(*pthread_startroutine_t)(void *);
134
135/*
136 * Once definitions.
137 */
138struct pthread_once {
139 int state;
140 pthread_mutex_t mutex;
141};
142
143/*
144 * Flags for once initialization.
145 */
146#define PTHREAD_NEEDS_INIT 0
147#define PTHREAD_DONE_INIT 1
148
149/*
150 * Static once initialization values.
151 */
152#define PTHREAD_ONCE_INIT { PTHREAD_NEEDS_INIT, PTHREAD_MUTEX_INITIALIZER }
153
154/*
155 * Static initialization values.
156 */
157#define PTHREAD_MUTEX_INITIALIZER NULL
158#define PTHREAD_COND_INITIALIZER NULL
159#define PTHREAD_RWLOCK_INITIALIZER NULL
160
161#define PTHREAD_PRIO_NONE 0
162#define PTHREAD_PRIO_INHERIT 1
163#define PTHREAD_PRIO_PROTECT 2
164
165/*
166 * Mutex types.
167 */
168enum pthread_mutextype {
169 PTHREAD_MUTEX_ERRORCHECK = 1, /* Error checking mutex */
170 PTHREAD_MUTEX_RECURSIVE = 2, /* Recursive mutex */
171 PTHREAD_MUTEX_NORMAL = 3, /* No error checking */
172 PTHREAD_MUTEX_STRICT_NP = 4, /* Strict error checking */
173 PTHREAD_MUTEX_TYPE_MAX
174};
175
176#define PTHREAD_MUTEX_ERRORCHECK PTHREAD_MUTEX_ERRORCHECK
177#define PTHREAD_MUTEX_RECURSIVE PTHREAD_MUTEX_RECURSIVE
178#define PTHREAD_MUTEX_NORMAL PTHREAD_MUTEX_NORMAL
179#define PTHREAD_MUTEX_STRICT_NP PTHREAD_MUTEX_STRICT_NP
180#define PTHREAD_MUTEX_DEFAULT PTHREAD_MUTEX_STRICT_NP
181
182/*
183 * Thread function prototype definitions:
184 */
185__BEGIN_DECLS
186int pthread_atfork(void (*)(void), void (*)(void), void (*)(void));
187int pthread_attr_destroy(pthread_attr_t *);
188int pthread_attr_getstack(const pthread_attr_t *,
189 void **, size_t *);
190int pthread_attr_getstacksize(const pthread_attr_t *, size_t *);
191int pthread_attr_getstackaddr(const pthread_attr_t *, void **);
192int pthread_attr_getguardsize(const pthread_attr_t *, size_t *);
193int pthread_attr_getdetachstate(const pthread_attr_t *, int *);
194int pthread_attr_init(pthread_attr_t *);
195int pthread_attr_setstacksize(pthread_attr_t *, size_t);
196int pthread_attr_setstack(pthread_attr_t *, void *, size_t);
197int pthread_attr_setstackaddr(pthread_attr_t *, void *);
198int pthread_attr_setguardsize(pthread_attr_t *, size_t);
199int pthread_attr_setdetachstate(pthread_attr_t *, int);
200void pthread_cleanup_pop(int);
201void pthread_cleanup_push(void (*) (void *), void *routine_arg);
202int pthread_condattr_destroy(pthread_condattr_t *);
203int pthread_condattr_init(pthread_condattr_t *);
204
205int pthread_cond_broadcast(pthread_cond_t *);
206int pthread_cond_destroy(pthread_cond_t *);
207int pthread_cond_init(pthread_cond_t *,
208 const pthread_condattr_t *);
209int pthread_cond_signal(pthread_cond_t *);
210int pthread_cond_timedwait(pthread_cond_t *,
211 pthread_mutex_t *, const struct timespec *);
212int pthread_cond_wait(pthread_cond_t *, pthread_mutex_t *);
213int pthread_create(pthread_t *, const pthread_attr_t *,
214 void *(*) (void *), void *);
215int pthread_detach(pthread_t);
216int pthread_equal(pthread_t, pthread_t);
217__dead void pthread_exit(void *);
218void *pthread_getspecific(pthread_key_t);
219int pthread_join(pthread_t, void **);
220int pthread_key_create(pthread_key_t *,
221 void (*) (void *));
222int pthread_key_delete(pthread_key_t);
223int pthread_kill(pthread_t, int);
224int pthread_mutexattr_init(pthread_mutexattr_t *);
225int pthread_mutexattr_destroy(pthread_mutexattr_t *);
226int pthread_mutexattr_gettype(pthread_mutexattr_t *, int *);
227int pthread_mutexattr_settype(pthread_mutexattr_t *, int);
228int pthread_mutex_destroy(pthread_mutex_t *);
229int pthread_mutex_init(pthread_mutex_t *,
230 const pthread_mutexattr_t *);
231int pthread_mutex_lock(pthread_mutex_t *);
232int pthread_mutex_timedlock(pthread_mutex_t *,
233 const struct timespec *);
234int pthread_mutex_trylock(pthread_mutex_t *);
235int pthread_mutex_unlock(pthread_mutex_t *);
236int pthread_once(pthread_once_t *, void (*) (void));
237int pthread_rwlock_destroy(pthread_rwlock_t *);
238int pthread_rwlock_init(pthread_rwlock_t *,
239 const pthread_rwlockattr_t *);
240int pthread_rwlock_rdlock(pthread_rwlock_t *);
241int pthread_rwlock_timedrdlock(pthread_rwlock_t *,
242 const struct timespec *);
243int pthread_rwlock_timedwrlock(pthread_rwlock_t *,
244 const struct timespec *);
245int pthread_rwlock_tryrdlock(pthread_rwlock_t *);
246int pthread_rwlock_trywrlock(pthread_rwlock_t *);
247int pthread_rwlock_unlock(pthread_rwlock_t *);
248int pthread_rwlock_wrlock(pthread_rwlock_t *);
249int pthread_rwlockattr_init(pthread_rwlockattr_t *);
250int pthread_rwlockattr_getpshared(const pthread_rwlockattr_t *,
251 int *);
252int pthread_rwlockattr_setpshared(pthread_rwlockattr_t *, int);
253int pthread_rwlockattr_destroy(pthread_rwlockattr_t *);
254pthread_t pthread_self(void);
255int pthread_setspecific(pthread_key_t, const void *);
256
257int pthread_cancel(pthread_t);
258int pthread_setcancelstate(int, int *);
259int pthread_setcanceltype(int, int *);
260void pthread_testcancel(void);
261
262int pthread_getprio(pthread_t);
263int pthread_setprio(pthread_t, int);
264void pthread_yield(void);
265
266int pthread_mutexattr_getprioceiling(pthread_mutexattr_t *,
267 int *);
268int pthread_mutexattr_setprioceiling(pthread_mutexattr_t *,
269 int);
270int pthread_mutex_getprioceiling(pthread_mutex_t *, int *);
271int pthread_mutex_setprioceiling(pthread_mutex_t *, int, int *);
272
273int pthread_mutexattr_getprotocol(pthread_mutexattr_t *, int *);
274int pthread_mutexattr_setprotocol(pthread_mutexattr_t *, int);
275
276int pthread_condattr_getclock(const pthread_condattr_t *,
277 clockid_t *);
278int pthread_condattr_setclock(pthread_condattr_t *, clockid_t);
279
280int pthread_attr_getinheritsched(const pthread_attr_t *, int *);
281int pthread_attr_getschedparam(const pthread_attr_t *,
282 struct sched_param *);
283int pthread_attr_getschedpolicy(const pthread_attr_t *, int *);
284int pthread_attr_getscope(const pthread_attr_t *, int *);
285int pthread_attr_setinheritsched(pthread_attr_t *, int);
286int pthread_attr_setschedparam(pthread_attr_t *,
287 const struct sched_param *);
288int pthread_attr_setschedpolicy(pthread_attr_t *, int);
289int pthread_attr_setscope(pthread_attr_t *, int);
290int pthread_getschedparam(pthread_t pthread, int *,
291 struct sched_param *);
292int pthread_setschedparam(pthread_t, int,
293 const struct sched_param *);
294int pthread_getconcurrency(void);
295int pthread_setconcurrency(int);
296int pthread_barrier_init(pthread_barrier_t *,
297 pthread_barrierattr_t *, unsigned int);
298int pthread_barrier_destroy(pthread_barrier_t *);
299int pthread_barrier_wait(pthread_barrier_t *);
300int pthread_barrierattr_init(pthread_barrierattr_t *);
301int pthread_barrierattr_destroy(pthread_barrierattr_t *);
302int pthread_barrierattr_getpshared(pthread_barrierattr_t *, int *);
303int pthread_barrierattr_setpshared(pthread_barrierattr_t *, int);
304int pthread_spin_init(pthread_spinlock_t *, int);
305int pthread_spin_destroy(pthread_spinlock_t *);
306int pthread_spin_trylock(pthread_spinlock_t *);
307int pthread_spin_lock(pthread_spinlock_t *);
308int pthread_spin_unlock(pthread_spinlock_t *);
309
310#if __POSIX_VISIBLE >= 200112
311int pthread_getcpuclockid(pthread_t, clockid_t *);
312#endif
313__END_DECLS
314
315#endif /* _PTHREAD_H_ */