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