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 /* 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 #ifndef _ASM 143 144 /* 145 * cancellation cleanup structure 146 */ 147 typedef struct _cleanup { 148 uintptr_t pthread_cleanup_pad[4]; 149 } _cleanup_t; 150 151 void __pthread_cleanup_push(void (*)(void *), void *, caddr_t, _cleanup_t *); 152 void __pthread_cleanup_pop(int, _cleanup_t *); 153 caddr_t _getfp(void); 154 155 #if __cplusplus 156 extern "C" { 157 #endif 158 159 typedef void (*_Voidfp)(void*); /* pointer to extern "C" function */ 160 161 #if __cplusplus 162 } /* extern "C" */ 163 #endif 164 165 #define pthread_cleanup_push(routine, args) { \ 166 _cleanup_t _cleanup_info; \ 167 __pthread_cleanup_push((_Voidfp)(routine), (void *)(args), \ 168 (caddr_t)_getfp(), &_cleanup_info); 169 170 #define pthread_cleanup_pop(ex) \ 171 __pthread_cleanup_pop(ex, &_cleanup_info); \ 172 } 173 174 /* 175 * function prototypes - thread related calls 176 */ 177 178 /* 179 * pthread_atfork() is also declared in <unistd.h> as per SUSv2. The 180 * declarations are identical. A change to either one may also require 181 * appropriate namespace updates in order to avoid redeclaration 182 * warnings in the case where both prototypes are exposed via inclusion 183 * of both <pthread.h> and <unistd.h>. 184 */ 185 extern int pthread_atfork(void (*) (void), void (*) (void), void (*) (void)); 186 extern int pthread_attr_init(pthread_attr_t *); 187 extern int pthread_attr_destroy(pthread_attr_t *); 188 extern int pthread_attr_setstack(pthread_attr_t *, void *, size_t); 189 extern int pthread_attr_getstack(const pthread_attr_t *_RESTRICT_KYWD, 190 void **_RESTRICT_KYWD, size_t *_RESTRICT_KYWD); 191 extern int pthread_attr_setstacksize(pthread_attr_t *, size_t); 192 extern int pthread_attr_getstacksize(const pthread_attr_t *_RESTRICT_KYWD, 193 size_t *_RESTRICT_KYWD); 194 extern int pthread_attr_setstackaddr(pthread_attr_t *, void *); 195 extern int pthread_attr_getstackaddr(const pthread_attr_t *_RESTRICT_KYWD, 196 void **_RESTRICT_KYWD); 197 extern int pthread_attr_setdetachstate(pthread_attr_t *, int); 198 extern int pthread_attr_getdetachstate(const pthread_attr_t *, int *); 199 extern int pthread_attr_setscope(pthread_attr_t *, int); 200 extern int pthread_attr_getscope(const pthread_attr_t *_RESTRICT_KYWD, 201 int *_RESTRICT_KYWD); 202 extern int pthread_attr_setinheritsched(pthread_attr_t *, int); 203 extern int pthread_attr_getinheritsched(const pthread_attr_t *_RESTRICT_KYWD, 204 int *_RESTRICT_KYWD); 205 extern int pthread_attr_setschedpolicy(pthread_attr_t *, int); 206 extern int pthread_attr_getschedpolicy(const pthread_attr_t *_RESTRICT_KYWD, 207 int *_RESTRICT_KYWD); 208 extern int pthread_attr_setschedparam(pthread_attr_t *_RESTRICT_KYWD, 209 const struct sched_param *_RESTRICT_KYWD); 210 extern int pthread_attr_getschedparam(const pthread_attr_t *_RESTRICT_KYWD, 211 struct sched_param *_RESTRICT_KYWD); 212 extern int pthread_create(pthread_t *_RESTRICT_KYWD, 213 const pthread_attr_t *_RESTRICT_KYWD, void * (*)(void *), 214 void *_RESTRICT_KYWD); 215 extern int pthread_once(pthread_once_t *, void (*)(void)); 216 extern int pthread_join(pthread_t, void **); 217 extern int pthread_detach(pthread_t); 218 extern void pthread_exit(void *) __NORETURN; 219 extern int pthread_cancel(pthread_t); 220 extern int pthread_setschedparam(pthread_t, int, const struct sched_param *); 221 extern int pthread_getschedparam(pthread_t, int *_RESTRICT_KYWD, 222 struct sched_param *_RESTRICT_KYWD); 223 extern int pthread_setschedprio(pthread_t, int); 224 extern int pthread_setcancelstate(int, int *); 225 extern int pthread_setcanceltype(int, int *); 226 extern void pthread_testcancel(void); 227 extern int pthread_equal(pthread_t, pthread_t); 228 extern int pthread_key_create(pthread_key_t *, void (*)(void *)); 229 extern int pthread_key_create_once_np(pthread_key_t *, void (*)(void *)); 230 extern int pthread_key_delete(pthread_key_t); 231 extern int pthread_setspecific(pthread_key_t, const void *); 232 extern void *pthread_getspecific(pthread_key_t); 233 extern pthread_t pthread_self(void); 234 235 /* 236 * function prototypes - synchronization related calls 237 */ 238 extern int pthread_mutexattr_init(pthread_mutexattr_t *); 239 extern int pthread_mutexattr_destroy(pthread_mutexattr_t *); 240 extern int pthread_mutexattr_setpshared(pthread_mutexattr_t *, int); 241 extern int pthread_mutexattr_getpshared( 242 const pthread_mutexattr_t *_RESTRICT_KYWD, int *_RESTRICT_KYWD); 243 extern int pthread_mutexattr_setprotocol(pthread_mutexattr_t *, int); 244 extern int pthread_mutexattr_getprotocol( 245 const pthread_mutexattr_t *_RESTRICT_KYWD, int *_RESTRICT_KYWD); 246 extern int pthread_mutexattr_setprioceiling(pthread_mutexattr_t *, int); 247 extern int pthread_mutexattr_getprioceiling( 248 const pthread_mutexattr_t *_RESTRICT_KYWD, int *_RESTRICT_KYWD); 249 extern int pthread_mutexattr_setrobust(pthread_mutexattr_t *, int); 250 extern int pthread_mutexattr_getrobust( 251 const pthread_mutexattr_t *_RESTRICT_KYWD, int *_RESTRICT_KYWD); 252 extern int pthread_mutex_init(pthread_mutex_t *_RESTRICT_KYWD, 253 const pthread_mutexattr_t *_RESTRICT_KYWD); 254 extern int pthread_mutex_consistent(pthread_mutex_t *); 255 extern int pthread_mutex_destroy(pthread_mutex_t *); 256 extern int pthread_mutex_lock(pthread_mutex_t *); 257 extern int pthread_mutex_timedlock(pthread_mutex_t *_RESTRICT_KYWD, 258 const struct timespec *_RESTRICT_KYWD); 259 extern int pthread_mutex_reltimedlock_np(pthread_mutex_t *_RESTRICT_KYWD, 260 const struct timespec *_RESTRICT_KYWD); 261 extern int pthread_mutex_unlock(pthread_mutex_t *); 262 extern int pthread_mutex_trylock(pthread_mutex_t *); 263 extern int pthread_mutex_setprioceiling(pthread_mutex_t *_RESTRICT_KYWD, 264 int, int *_RESTRICT_KYWD); 265 extern int pthread_mutex_getprioceiling(const pthread_mutex_t *_RESTRICT_KYWD, 266 int *_RESTRICT_KYWD); 267 extern int pthread_condattr_init(pthread_condattr_t *); 268 extern int pthread_condattr_destroy(pthread_condattr_t *); 269 extern int pthread_condattr_setclock(pthread_condattr_t *, clockid_t); 270 extern int pthread_condattr_getclock(const pthread_condattr_t *_RESTRICT_KYWD, 271 clockid_t *_RESTRICT_KYWD); 272 extern int pthread_condattr_setpshared(pthread_condattr_t *, int); 273 extern int pthread_condattr_getpshared(const pthread_condattr_t *_RESTRICT_KYWD, 274 int *_RESTRICT_KYWD); 275 extern int pthread_cond_init(pthread_cond_t *_RESTRICT_KYWD, 276 const pthread_condattr_t *_RESTRICT_KYWD); 277 extern int pthread_cond_destroy(pthread_cond_t *); 278 extern int pthread_cond_broadcast(pthread_cond_t *); 279 extern int pthread_cond_signal(pthread_cond_t *); 280 extern int pthread_cond_wait(pthread_cond_t *_RESTRICT_KYWD, 281 pthread_mutex_t *_RESTRICT_KYWD); 282 extern int pthread_cond_timedwait(pthread_cond_t *_RESTRICT_KYWD, 283 pthread_mutex_t *_RESTRICT_KYWD, const struct timespec *_RESTRICT_KYWD); 284 extern int pthread_cond_reltimedwait_np(pthread_cond_t *_RESTRICT_KYWD, 285 pthread_mutex_t *_RESTRICT_KYWD, const struct timespec *_RESTRICT_KYWD); 286 extern int pthread_attr_getguardsize(const pthread_attr_t *_RESTRICT_KYWD, 287 size_t *_RESTRICT_KYWD); 288 extern int pthread_attr_setguardsize(pthread_attr_t *, size_t); 289 extern int pthread_getconcurrency(void); 290 extern int pthread_setconcurrency(int); 291 extern int pthread_mutexattr_settype(pthread_mutexattr_t *, int); 292 extern int pthread_mutexattr_gettype(const pthread_mutexattr_t *_RESTRICT_KYWD, 293 int *_RESTRICT_KYWD); 294 extern int pthread_rwlock_init(pthread_rwlock_t *_RESTRICT_KYWD, 295 const pthread_rwlockattr_t *_RESTRICT_KYWD); 296 extern int pthread_rwlock_destroy(pthread_rwlock_t *); 297 extern int pthread_rwlock_rdlock(pthread_rwlock_t *); 298 extern int pthread_rwlock_timedrdlock(pthread_rwlock_t *_RESTRICT_KYWD, 299 const struct timespec *_RESTRICT_KYWD); 300 extern int pthread_rwlock_reltimedrdlock_np(pthread_rwlock_t *_RESTRICT_KYWD, 301 const struct timespec *_RESTRICT_KYWD); 302 extern int pthread_rwlock_tryrdlock(pthread_rwlock_t *); 303 extern int pthread_rwlock_wrlock(pthread_rwlock_t *); 304 extern int pthread_rwlock_timedwrlock(pthread_rwlock_t *_RESTRICT_KYWD, 305 const struct timespec *_RESTRICT_KYWD); 306 extern int pthread_rwlock_reltimedwrlock_np(pthread_rwlock_t *_RESTRICT_KYWD, 307 const struct timespec *_RESTRICT_KYWD); 308 extern int pthread_rwlock_trywrlock(pthread_rwlock_t *); 309 extern int pthread_rwlock_unlock(pthread_rwlock_t *); 310 extern int pthread_rwlockattr_init(pthread_rwlockattr_t *); 311 extern int pthread_rwlockattr_destroy(pthread_rwlockattr_t *); 312 extern int pthread_rwlockattr_getpshared( 313 const pthread_rwlockattr_t *_RESTRICT_KYWD, int *_RESTRICT_KYWD); 314 extern int pthread_rwlockattr_setpshared(pthread_rwlockattr_t *, int); 315 extern int pthread_spin_init(pthread_spinlock_t *, int); 316 extern int pthread_spin_destroy(pthread_spinlock_t *); 317 extern int pthread_spin_lock(pthread_spinlock_t *); 318 extern int pthread_spin_trylock(pthread_spinlock_t *); 319 extern int pthread_spin_unlock(pthread_spinlock_t *); 320 extern int pthread_barrierattr_init(pthread_barrierattr_t *); 321 extern int pthread_barrierattr_destroy(pthread_barrierattr_t *); 322 extern int pthread_barrierattr_setpshared(pthread_barrierattr_t *, int); 323 extern int pthread_barrierattr_getpshared( 324 const pthread_barrierattr_t *_RESTRICT_KYWD, int *_RESTRICT_KYWD); 325 extern int pthread_barrier_init(pthread_barrier_t *_RESTRICT_KYWD, 326 const pthread_barrierattr_t *_RESTRICT_KYWD, uint_t); 327 extern int pthread_barrier_destroy(pthread_barrier_t *); 328 extern int pthread_barrier_wait(pthread_barrier_t *); 329 330 /* Historical names -- present only for binary compatibility */ 331 extern int pthread_mutex_consistent_np(pthread_mutex_t *); 332 extern int pthread_mutexattr_setrobust_np(pthread_mutexattr_t *, int); 333 extern int pthread_mutexattr_getrobust_np( 334 const pthread_mutexattr_t *_RESTRICT_KYWD, int *_RESTRICT_KYWD); 335 336 /* 337 * These are non-standardized extensions that we provide. Their origins are 338 * documented in their manual pages. 339 */ 340 #if !defined(_STRICT_SYMBOLS) || defined(__EXTENSIONS__) 341 extern int pthread_attr_get_np(pthread_t, pthread_attr_t *); 342 #endif /* !_STRICT_SYMBOLS || __EXTENSIONS__ */ 343 344 #endif /* _ASM */ 345 346 #ifdef __cplusplus 347 } 348 #endif 349 350 #endif /* _PTHREAD_H */ 351