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