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