1/*
2 * CDDL HEADER START
3 *
4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
7 *
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
12 *
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
18 *
19 * CDDL HEADER END
20 */
21
22/*
23 * Copyright 2014 Garrett D'Amore <garrett@damore.org>
24 * Copyright 2018 Joyent, Inc.
25 *
26 * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
27 * Use is subject to license terms.
28 */
29
30#ifndef _PTHREAD_H
31#define	_PTHREAD_H
32
33#include <sys/feature_tests.h>
34
35#ifndef	_ASM
36#include <sys/types.h>
37#include <time.h>
38#include <sched.h>
39#endif	/* _ASM */
40
41#ifdef	__cplusplus
42extern "C" {
43#endif
44
45/*
46 * Thread related attribute values defined as in thread.h.
47 * These are defined as bit pattern in thread.h.
48 * Any change here should be reflected in thread.h.
49 */
50/* detach */
51#define	PTHREAD_CREATE_DETACHED		0x40	/* = THR_DETACHED */
52#define	PTHREAD_CREATE_JOINABLE		0
53/* scope */
54#define	PTHREAD_SCOPE_SYSTEM		0x01	/* = THR_BOUND */
55#define	PTHREAD_SCOPE_PROCESS		0
56
57/*
58 * Other attributes which are not defined in thread.h
59 */
60/* inherit */
61#define	PTHREAD_INHERIT_SCHED		1
62#define	PTHREAD_EXPLICIT_SCHED		0
63
64/*
65 * Value of process-shared attribute
66 * These are defined as values defined in sys/synch.h
67 * Any change here should be reflected in sys/synch.h.
68 */
69#define	PTHREAD_PROCESS_SHARED		1	/* = USYNC_PROCESS */
70#define	PTHREAD_PROCESS_PRIVATE		0	/* = USYNC_THREAD */
71
72/*
73 * mutex types
74 * keep these in synch which sys/synch.h lock flags
75 */
76#define	PTHREAD_MUTEX_NORMAL		0x0
77#define	PTHREAD_MUTEX_ERRORCHECK	0x2
78#define	PTHREAD_MUTEX_RECURSIVE		0x4
79#define	PTHREAD_MUTEX_DEFAULT		PTHREAD_MUTEX_NORMAL
80
81/*
82 * Mutex protocol values. Keep these in synch with sys/synch.h lock types.
83 */
84#define	PTHREAD_PRIO_NONE		0x0
85#define	PTHREAD_PRIO_INHERIT		0x10
86#define	PTHREAD_PRIO_PROTECT		0x20
87
88/*
89 * Mutex robust attribute values.
90 * Keep these in synch with sys/synch.h lock types.
91 */
92#define	PTHREAD_MUTEX_STALLED		0x0
93#define	PTHREAD_MUTEX_ROBUST		0x40
94/*
95 * Historical solaris-specific names,
96 * from before pthread_mutexattr_getrobust() became standardized
97 */
98#define	PTHREAD_MUTEX_STALL_NP		PTHREAD_MUTEX_STALLED
99#define	PTHREAD_MUTEX_ROBUST_NP		PTHREAD_MUTEX_ROBUST
100
101/*
102 * macros - default initializers defined as in synch.h
103 * Any change here should be reflected in synch.h.
104 *
105 * NOTE:
106 * Make sure that any change in the macros is consistent with the definition
107 * of the corresponding types in sys/types.h (e.g. PTHREAD_MUTEX_INITIALIZER
108 * should be consistent with the definition for pthread_mutex_t).
109 */
110#define	PTHREAD_MUTEX_INITIALIZER		/* = DEFAULTMUTEX */	\
111	{{0, 0, 0, PTHREAD_PROCESS_PRIVATE, _MUTEX_MAGIC}, {{{0}}}, 0}
112
113#define	PTHREAD_COND_INITIALIZER		/* = DEFAULTCV */	\
114	{{{0, 0, 0, 0}, PTHREAD_PROCESS_PRIVATE, _COND_MAGIC}, 0}
115
116#define	PTHREAD_RWLOCK_INITIALIZER		/* = DEFAULTRWLOCK */	\
117	{0, PTHREAD_PROCESS_PRIVATE, _RWL_MAGIC, PTHREAD_MUTEX_INITIALIZER, \
118	PTHREAD_COND_INITIALIZER, PTHREAD_COND_INITIALIZER}
119
120/* cancellation type and state */
121#define	PTHREAD_CANCEL_ENABLE		0x00
122#define	PTHREAD_CANCEL_DISABLE		0x01
123#define	PTHREAD_CANCEL_DEFERRED		0x00
124#define	PTHREAD_CANCEL_ASYNCHRONOUS	0x02
125#define	PTHREAD_CANCELED		(void *)-19
126
127/* pthread_once related values */
128#define	PTHREAD_ONCE_NOTDONE	0
129#define	PTHREAD_ONCE_DONE	1
130#define	PTHREAD_ONCE_INIT	{ {0, 0, 0, PTHREAD_ONCE_NOTDONE} }
131
132/*
133 * The key to be created by pthread_key_create_once_np()
134 * must be statically initialized with PTHREAD_ONCE_KEY_NP.
135 * This must be the same as THR_ONCE_KEY in <thread.h>
136 */
137#define	PTHREAD_ONCE_KEY_NP	(pthread_key_t)(-1)
138
139/* barriers */
140#define	PTHREAD_BARRIER_SERIAL_THREAD	-2
141
142/* For pthread_{get,set}name_np(). */
143#define	PTHREAD_MAX_NAMELEN_NP (32)
144
145#ifndef	_ASM
146
147/*
148 * cancellation cleanup structure
149 */
150typedef struct _cleanup {
151	uintptr_t	pthread_cleanup_pad[4];
152} _cleanup_t;
153
154void	__pthread_cleanup_push(void (*)(void *), void *, caddr_t, _cleanup_t *);
155void	__pthread_cleanup_pop(int, _cleanup_t *);
156caddr_t	_getfp(void);
157
158#if __cplusplus
159extern "C" {
160#endif
161
162typedef void (*_Voidfp)(void*); /* pointer to extern "C" function */
163
164#if __cplusplus
165} /* extern "C" */
166#endif
167
168#define	pthread_cleanup_push(routine, args) { \
169	_cleanup_t _cleanup_info; \
170	__pthread_cleanup_push((_Voidfp)(routine), (void *)(args), \
171				(caddr_t)_getfp(), &_cleanup_info);
172
173#define	pthread_cleanup_pop(ex) \
174	__pthread_cleanup_pop(ex, &_cleanup_info); \
175}
176
177/*
178 * function prototypes - thread related calls
179 */
180
181/*
182 * pthread_atfork() is also declared in <unistd.h> as per SUSv2. The
183 * declarations are identical. A change to either one may also require
184 * appropriate namespace updates in order to avoid redeclaration
185 * warnings in the case where both prototypes are exposed via inclusion
186 * of both <pthread.h> and <unistd.h>.
187 */
188extern int pthread_atfork(void (*) (void), void (*) (void), void (*) (void));
189extern int pthread_attr_init(pthread_attr_t *);
190extern int pthread_attr_destroy(pthread_attr_t *);
191extern int pthread_attr_setstack(pthread_attr_t *, void *, size_t);
192extern int pthread_attr_getstack(const pthread_attr_t *_RESTRICT_KYWD,
193		void **_RESTRICT_KYWD, size_t *_RESTRICT_KYWD);
194extern int pthread_attr_setstacksize(pthread_attr_t *, size_t);
195extern int pthread_attr_getstacksize(const pthread_attr_t *_RESTRICT_KYWD,
196		size_t *_RESTRICT_KYWD);
197extern int pthread_attr_setstackaddr(pthread_attr_t *, void *);
198extern int pthread_attr_getstackaddr(const pthread_attr_t *_RESTRICT_KYWD,
199		void **_RESTRICT_KYWD);
200extern int pthread_attr_setdetachstate(pthread_attr_t *, int);
201extern int pthread_attr_getdetachstate(const pthread_attr_t *, int *);
202extern int pthread_attr_setscope(pthread_attr_t *, int);
203extern int pthread_attr_getscope(const pthread_attr_t *_RESTRICT_KYWD,
204	int *_RESTRICT_KYWD);
205extern int pthread_attr_setinheritsched(pthread_attr_t *, int);
206extern int pthread_attr_getinheritsched(const pthread_attr_t *_RESTRICT_KYWD,
207	int *_RESTRICT_KYWD);
208extern int pthread_attr_setschedpolicy(pthread_attr_t *, int);
209extern int pthread_attr_getschedpolicy(const pthread_attr_t *_RESTRICT_KYWD,
210	int *_RESTRICT_KYWD);
211extern int pthread_attr_setschedparam(pthread_attr_t *_RESTRICT_KYWD,
212		const struct sched_param *_RESTRICT_KYWD);
213extern int pthread_attr_getschedparam(const pthread_attr_t *_RESTRICT_KYWD,
214		struct sched_param *_RESTRICT_KYWD);
215extern int pthread_attr_setname_np(pthread_attr_t *_RESTRICT_KYWD,
216    const char *_RESTRICT_KYWD);
217extern int pthread_attr_getname_np(pthread_attr_t *_RESTRICT_KYWD,
218    char *_RESTRICT_KYWD, size_t);
219extern int pthread_create(pthread_t *_RESTRICT_KYWD,
220		const pthread_attr_t *_RESTRICT_KYWD, void * (*)(void *),
221		void *_RESTRICT_KYWD);
222extern int pthread_once(pthread_once_t *, void (*)(void));
223extern int pthread_join(pthread_t, void **);
224extern int pthread_detach(pthread_t);
225extern void pthread_exit(void *) __NORETURN;
226extern int pthread_cancel(pthread_t);
227extern int pthread_setschedparam(pthread_t, int, const struct sched_param *);
228extern int pthread_getschedparam(pthread_t, int *_RESTRICT_KYWD,
229		struct sched_param *_RESTRICT_KYWD);
230extern int pthread_setschedprio(pthread_t, int);
231extern int pthread_setcancelstate(int, int *);
232extern int pthread_setcanceltype(int, int *);
233extern void pthread_testcancel(void);
234extern int pthread_equal(pthread_t, pthread_t);
235extern int pthread_key_create(pthread_key_t *, void (*)(void *));
236extern int pthread_key_create_once_np(pthread_key_t *, void (*)(void *));
237extern int pthread_key_delete(pthread_key_t);
238extern int pthread_setspecific(pthread_key_t, const void *);
239extern void *pthread_getspecific(pthread_key_t);
240extern pthread_t pthread_self(void);
241extern int pthread_setname_np(pthread_t, const char *);
242extern int pthread_getname_np(pthread_t, char *, size_t);
243
244/*
245 * function prototypes - synchronization related calls
246 */
247extern int pthread_mutexattr_init(pthread_mutexattr_t *);
248extern int pthread_mutexattr_destroy(pthread_mutexattr_t *);
249extern int pthread_mutexattr_setpshared(pthread_mutexattr_t *, int);
250extern int pthread_mutexattr_getpshared(
251	const pthread_mutexattr_t *_RESTRICT_KYWD, int *_RESTRICT_KYWD);
252extern int pthread_mutexattr_setprotocol(pthread_mutexattr_t *, int);
253extern int pthread_mutexattr_getprotocol(
254	const pthread_mutexattr_t *_RESTRICT_KYWD, int *_RESTRICT_KYWD);
255extern int pthread_mutexattr_setprioceiling(pthread_mutexattr_t *, int);
256extern int pthread_mutexattr_getprioceiling(
257	const pthread_mutexattr_t *_RESTRICT_KYWD, int *_RESTRICT_KYWD);
258extern int pthread_mutexattr_setrobust(pthread_mutexattr_t *, int);
259extern int pthread_mutexattr_getrobust(
260	const pthread_mutexattr_t *_RESTRICT_KYWD, int *_RESTRICT_KYWD);
261extern int pthread_mutex_init(pthread_mutex_t *_RESTRICT_KYWD,
262	const pthread_mutexattr_t *_RESTRICT_KYWD);
263extern int pthread_mutex_consistent(pthread_mutex_t *);
264extern int pthread_mutex_destroy(pthread_mutex_t *);
265extern int pthread_mutex_lock(pthread_mutex_t *);
266extern int pthread_mutex_timedlock(pthread_mutex_t *_RESTRICT_KYWD,
267	const struct timespec *_RESTRICT_KYWD);
268extern int pthread_mutex_reltimedlock_np(pthread_mutex_t *_RESTRICT_KYWD,
269	const struct timespec *_RESTRICT_KYWD);
270extern int pthread_mutex_unlock(pthread_mutex_t *);
271extern int pthread_mutex_trylock(pthread_mutex_t *);
272extern int pthread_mutex_setprioceiling(pthread_mutex_t *_RESTRICT_KYWD,
273	int, int *_RESTRICT_KYWD);
274extern int pthread_mutex_getprioceiling(const pthread_mutex_t *_RESTRICT_KYWD,
275	int *_RESTRICT_KYWD);
276extern int pthread_condattr_init(pthread_condattr_t *);
277extern int pthread_condattr_destroy(pthread_condattr_t *);
278extern int pthread_condattr_setclock(pthread_condattr_t *, clockid_t);
279extern int pthread_condattr_getclock(const pthread_condattr_t *_RESTRICT_KYWD,
280	clockid_t *_RESTRICT_KYWD);
281extern int pthread_condattr_setpshared(pthread_condattr_t *, int);
282extern int pthread_condattr_getpshared(const pthread_condattr_t *_RESTRICT_KYWD,
283	int *_RESTRICT_KYWD);
284extern int pthread_cond_init(pthread_cond_t *_RESTRICT_KYWD,
285	const pthread_condattr_t *_RESTRICT_KYWD);
286extern int pthread_cond_destroy(pthread_cond_t *);
287extern int pthread_cond_broadcast(pthread_cond_t *);
288extern int pthread_cond_signal(pthread_cond_t *);
289extern int pthread_cond_wait(pthread_cond_t *_RESTRICT_KYWD,
290	pthread_mutex_t *_RESTRICT_KYWD);
291extern int pthread_cond_timedwait(pthread_cond_t *_RESTRICT_KYWD,
292	pthread_mutex_t *_RESTRICT_KYWD, const struct timespec *_RESTRICT_KYWD);
293extern int pthread_cond_reltimedwait_np(pthread_cond_t *_RESTRICT_KYWD,
294	pthread_mutex_t *_RESTRICT_KYWD, const struct timespec *_RESTRICT_KYWD);
295extern int pthread_attr_getguardsize(const pthread_attr_t *_RESTRICT_KYWD,
296	size_t *_RESTRICT_KYWD);
297extern int pthread_attr_setguardsize(pthread_attr_t *, size_t);
298extern int pthread_getconcurrency(void);
299extern int pthread_setconcurrency(int);
300extern int pthread_mutexattr_settype(pthread_mutexattr_t *, int);
301extern int pthread_mutexattr_gettype(const pthread_mutexattr_t *_RESTRICT_KYWD,
302	int *_RESTRICT_KYWD);
303extern int pthread_rwlock_init(pthread_rwlock_t *_RESTRICT_KYWD,
304	const pthread_rwlockattr_t *_RESTRICT_KYWD);
305extern int pthread_rwlock_destroy(pthread_rwlock_t *);
306extern int pthread_rwlock_rdlock(pthread_rwlock_t *);
307extern int pthread_rwlock_timedrdlock(pthread_rwlock_t *_RESTRICT_KYWD,
308	const struct timespec *_RESTRICT_KYWD);
309extern int pthread_rwlock_reltimedrdlock_np(pthread_rwlock_t *_RESTRICT_KYWD,
310	const struct timespec *_RESTRICT_KYWD);
311extern int pthread_rwlock_tryrdlock(pthread_rwlock_t *);
312extern int pthread_rwlock_wrlock(pthread_rwlock_t *);
313extern int pthread_rwlock_timedwrlock(pthread_rwlock_t *_RESTRICT_KYWD,
314	const struct timespec *_RESTRICT_KYWD);
315extern int pthread_rwlock_reltimedwrlock_np(pthread_rwlock_t *_RESTRICT_KYWD,
316	const struct timespec *_RESTRICT_KYWD);
317extern int pthread_rwlock_trywrlock(pthread_rwlock_t *);
318extern int pthread_rwlock_unlock(pthread_rwlock_t *);
319extern int pthread_rwlockattr_init(pthread_rwlockattr_t *);
320extern int pthread_rwlockattr_destroy(pthread_rwlockattr_t *);
321extern int pthread_rwlockattr_getpshared(
322	const pthread_rwlockattr_t *_RESTRICT_KYWD, int *_RESTRICT_KYWD);
323extern int pthread_rwlockattr_setpshared(pthread_rwlockattr_t *, int);
324extern int pthread_spin_init(pthread_spinlock_t *, int);
325extern int pthread_spin_destroy(pthread_spinlock_t *);
326extern int pthread_spin_lock(pthread_spinlock_t *);
327extern int pthread_spin_trylock(pthread_spinlock_t *);
328extern int pthread_spin_unlock(pthread_spinlock_t *);
329extern int pthread_barrierattr_init(pthread_barrierattr_t *);
330extern int pthread_barrierattr_destroy(pthread_barrierattr_t *);
331extern int pthread_barrierattr_setpshared(pthread_barrierattr_t *, int);
332extern int pthread_barrierattr_getpshared(
333	const pthread_barrierattr_t *_RESTRICT_KYWD, int *_RESTRICT_KYWD);
334extern int pthread_barrier_init(pthread_barrier_t *_RESTRICT_KYWD,
335	const pthread_barrierattr_t *_RESTRICT_KYWD, uint_t);
336extern int pthread_barrier_destroy(pthread_barrier_t *);
337extern int pthread_barrier_wait(pthread_barrier_t *);
338
339/* Historical names -- present only for binary compatibility */
340extern int pthread_mutex_consistent_np(pthread_mutex_t *);
341extern int pthread_mutexattr_setrobust_np(pthread_mutexattr_t *, int);
342extern int pthread_mutexattr_getrobust_np(
343	const pthread_mutexattr_t *_RESTRICT_KYWD, int *_RESTRICT_KYWD);
344
345/*
346 * These are non-standardized extensions that we provide. Their origins are
347 * documented in their manual pages.
348 */
349#if !defined(_STRICT_SYMBOLS) || defined(__EXTENSIONS__)
350extern int pthread_attr_get_np(pthread_t, pthread_attr_t *);
351#endif	/* !_STRICT_SYMBOLS || __EXTENSIONS__ */
352
353#endif	/* _ASM */
354
355#ifdef	__cplusplus
356}
357#endif
358
359#endif	/* _PTHREAD_H */
360