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