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 2007 Sun Microsystems, Inc. All rights reserved. 24 * Use is subject to license terms. 25 */ 26 27 #ifndef _PTHREAD_H 28 #define _PTHREAD_H 29 30 #pragma ident "%Z%%M% %I% %E% SMI" 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 robustness attribute values. The robustness attribute is a 94 * Solaris specific extension to support robust mutexes. Note the _NP suffix 95 * to indicate these are not part of the current POSIX spec (POSIX 1003.1 1996), 96 * but are platform specific non-portable extensions. Keep these in synch 97 * with sys/synch.h lock types. 98 */ 99 #define PTHREAD_MUTEX_STALL_NP 0x0 100 #define PTHREAD_MUTEX_ROBUST_NP 0x40 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, _DEFAULT_TYPE, _MUTEX_MAGIC}, {{{0}}}, 0} 113 114 #define PTHREAD_COND_INITIALIZER /* = DEFAULTCV */ \ 115 {{{0, 0, 0, 0}, _DEFAULT_TYPE, _COND_MAGIC}, 0} 116 117 #define PTHREAD_RWLOCK_INITIALIZER /* = DEFAULTRWLOCK */ \ 118 {0, _DEFAULT_TYPE, _RWL_MAGIC, PTHREAD_MUTEX_INITIALIZER, \ 119 PTHREAD_COND_INITIALIZER, PTHREAD_COND_INITIALIZER} 120 121 /* cancellation type and state */ 122 #define PTHREAD_CANCEL_ENABLE 0x00 123 #define PTHREAD_CANCEL_DISABLE 0x01 124 #define PTHREAD_CANCEL_DEFERRED 0x00 125 #define PTHREAD_CANCEL_ASYNCHRONOUS 0x02 126 #define PTHREAD_CANCELED (void *)-19 127 128 /* pthread_once related values */ 129 #define PTHREAD_ONCE_NOTDONE 0 130 #define PTHREAD_ONCE_DONE 1 131 #define PTHREAD_ONCE_INIT {0, 0, 0, PTHREAD_ONCE_NOTDONE} 132 133 /* 134 * The key to be created by pthread_key_create_once_np() 135 * must be statically initialized with PTHREAD_ONCE_KEY_NP. 136 * This must be the same as THR_ONCE_KEY in <thread.h> 137 */ 138 #define PTHREAD_ONCE_KEY_NP (pthread_key_t)(-1) 139 140 /* barriers */ 141 #define PTHREAD_BARRIER_SERIAL_THREAD -2 142 143 #ifndef _ASM 144 145 /* 146 * cancellation cleanup structure 147 */ 148 typedef struct _cleanup { 149 uintptr_t pthread_cleanup_pad[4]; 150 } _cleanup_t; 151 152 #ifdef __STDC__ 153 154 void __pthread_cleanup_push(void (*)(void *), void *, caddr_t, _cleanup_t *); 155 void __pthread_cleanup_pop(int, _cleanup_t *); 156 caddr_t _getfp(void); 157 158 #else /* __STDC__ */ 159 160 void __pthread_cleanup_push(); 161 void __pthread_cleanup_pop(); 162 caddr_t _getfp(); 163 164 #endif /* __STDC__ */ 165 166 #if __cplusplus 167 extern "C" { 168 #endif 169 170 typedef void (*_Voidfp)(void*); /* pointer to extern "C" function */ 171 172 #if __cplusplus 173 } /* extern "C" */ 174 #endif 175 176 #define pthread_cleanup_push(routine, args) { \ 177 _cleanup_t _cleanup_info; \ 178 __pthread_cleanup_push((_Voidfp)(routine), (void *)(args), \ 179 (caddr_t)_getfp(), &_cleanup_info); 180 181 #define pthread_cleanup_pop(ex) \ 182 __pthread_cleanup_pop(ex, &_cleanup_info); \ 183 } 184 185 #ifdef __STDC__ 186 187 /* 188 * function prototypes - thread related calls 189 */ 190 191 /* 192 * pthread_atfork() is also declared in <unistd.h> as per SUSv2. The 193 * declarations are identical. A change to either one may also require 194 * appropriate namespace updates in order to avoid redeclaration 195 * warnings in the case where both prototypes are exposed via inclusion 196 * of both <pthread.h> and <unistd.h>. 197 */ 198 extern int pthread_atfork(void (*) (void), void (*) (void), void (*) (void)); 199 extern int pthread_attr_init(pthread_attr_t *); 200 extern int pthread_attr_destroy(pthread_attr_t *); 201 extern int pthread_attr_setstack(pthread_attr_t *, void *, size_t); 202 extern int pthread_attr_getstack(const pthread_attr_t *_RESTRICT_KYWD, 203 void **_RESTRICT_KYWD, size_t *_RESTRICT_KYWD); 204 extern int pthread_attr_setstacksize(pthread_attr_t *, size_t); 205 extern int pthread_attr_getstacksize(const pthread_attr_t *_RESTRICT_KYWD, 206 size_t *_RESTRICT_KYWD); 207 extern int pthread_attr_setstackaddr(pthread_attr_t *, void *); 208 extern int pthread_attr_getstackaddr(const pthread_attr_t *_RESTRICT_KYWD, 209 void **_RESTRICT_KYWD); 210 extern int pthread_attr_setdetachstate(pthread_attr_t *, int); 211 extern int pthread_attr_getdetachstate(const pthread_attr_t *, int *); 212 extern int pthread_attr_setscope(pthread_attr_t *, int); 213 extern int pthread_attr_getscope(const pthread_attr_t *_RESTRICT_KYWD, 214 int *_RESTRICT_KYWD); 215 extern int pthread_attr_setinheritsched(pthread_attr_t *, int); 216 extern int pthread_attr_getinheritsched(const pthread_attr_t *_RESTRICT_KYWD, 217 int *_RESTRICT_KYWD); 218 extern int pthread_attr_setschedpolicy(pthread_attr_t *, int); 219 extern int pthread_attr_getschedpolicy(const pthread_attr_t *_RESTRICT_KYWD, 220 int *_RESTRICT_KYWD); 221 extern int pthread_attr_setschedparam(pthread_attr_t *_RESTRICT_KYWD, 222 const struct sched_param *_RESTRICT_KYWD); 223 extern int pthread_attr_getschedparam(const pthread_attr_t *_RESTRICT_KYWD, 224 struct sched_param *_RESTRICT_KYWD); 225 extern int pthread_create(pthread_t *_RESTRICT_KYWD, 226 const pthread_attr_t *_RESTRICT_KYWD, void * (*)(void *), 227 void *_RESTRICT_KYWD); 228 extern int pthread_once(pthread_once_t *, void (*)(void)); 229 extern int pthread_join(pthread_t, void **); 230 extern int pthread_detach(pthread_t); 231 extern void pthread_exit(void *) __NORETURN; 232 extern int pthread_cancel(pthread_t); 233 extern int pthread_setschedparam(pthread_t, int, const struct sched_param *); 234 extern int pthread_getschedparam(pthread_t, int *_RESTRICT_KYWD, 235 struct sched_param *_RESTRICT_KYWD); 236 extern int pthread_setschedprio(pthread_t, int); 237 extern int pthread_setcancelstate(int, int *); 238 extern int pthread_setcanceltype(int, int *); 239 extern void pthread_testcancel(void); 240 extern int pthread_equal(pthread_t, pthread_t); 241 extern int pthread_key_create(pthread_key_t *, void (*)(void *)); 242 extern int pthread_key_create_once_np(pthread_key_t *, void (*)(void *)); 243 extern int pthread_key_delete(pthread_key_t); 244 extern int pthread_setspecific(pthread_key_t, const void *); 245 extern void *pthread_getspecific(pthread_key_t); 246 extern pthread_t pthread_self(void); 247 248 /* 249 * function prototypes - synchronization related calls 250 */ 251 extern int pthread_mutexattr_init(pthread_mutexattr_t *); 252 extern int pthread_mutexattr_destroy(pthread_mutexattr_t *); 253 extern int pthread_mutexattr_setpshared(pthread_mutexattr_t *, int); 254 extern int pthread_mutexattr_getpshared( 255 const pthread_mutexattr_t *_RESTRICT_KYWD, int *_RESTRICT_KYWD); 256 extern int pthread_mutexattr_setprotocol(pthread_mutexattr_t *, int); 257 extern int pthread_mutexattr_getprotocol( 258 const pthread_mutexattr_t *_RESTRICT_KYWD, int *_RESTRICT_KYWD); 259 extern int pthread_mutexattr_setprioceiling(pthread_mutexattr_t *, int); 260 extern int pthread_mutexattr_getprioceiling( 261 const pthread_mutexattr_t *_RESTRICT_KYWD, int *_RESTRICT_KYWD); 262 extern int pthread_mutexattr_setrobust_np(pthread_mutexattr_t *, int); 263 extern int pthread_mutexattr_getrobust_np( 264 const pthread_mutexattr_t *_RESTRICT_KYWD, int *_RESTRICT_KYWD); 265 extern int pthread_mutex_init(pthread_mutex_t *_RESTRICT_KYWD, 266 const pthread_mutexattr_t *_RESTRICT_KYWD); 267 extern int pthread_mutex_consistent_np(pthread_mutex_t *); 268 extern int pthread_mutex_destroy(pthread_mutex_t *); 269 extern int pthread_mutex_lock(pthread_mutex_t *); 270 extern int pthread_mutex_timedlock(pthread_mutex_t *_RESTRICT_KYWD, 271 const struct timespec *_RESTRICT_KYWD); 272 extern int pthread_mutex_reltimedlock_np(pthread_mutex_t *_RESTRICT_KYWD, 273 const struct timespec *_RESTRICT_KYWD); 274 extern int pthread_mutex_unlock(pthread_mutex_t *); 275 extern int pthread_mutex_trylock(pthread_mutex_t *); 276 extern int pthread_mutex_setprioceiling(pthread_mutex_t *_RESTRICT_KYWD, 277 int, int *_RESTRICT_KYWD); 278 extern int pthread_mutex_getprioceiling(const pthread_mutex_t *_RESTRICT_KYWD, 279 int *_RESTRICT_KYWD); 280 extern int pthread_condattr_init(pthread_condattr_t *); 281 extern int pthread_condattr_destroy(pthread_condattr_t *); 282 extern int pthread_condattr_setclock(pthread_condattr_t *, clockid_t); 283 extern int pthread_condattr_getclock(const pthread_condattr_t *_RESTRICT_KYWD, 284 clockid_t *_RESTRICT_KYWD); 285 extern int pthread_condattr_setpshared(pthread_condattr_t *, int); 286 extern int pthread_condattr_getpshared(const pthread_condattr_t *_RESTRICT_KYWD, 287 int *_RESTRICT_KYWD); 288 extern int pthread_cond_init(pthread_cond_t *_RESTRICT_KYWD, 289 const pthread_condattr_t *_RESTRICT_KYWD); 290 extern int pthread_cond_destroy(pthread_cond_t *); 291 extern int pthread_cond_broadcast(pthread_cond_t *); 292 extern int pthread_cond_signal(pthread_cond_t *); 293 extern int pthread_cond_wait(pthread_cond_t *_RESTRICT_KYWD, 294 pthread_mutex_t *_RESTRICT_KYWD); 295 extern int pthread_cond_timedwait(pthread_cond_t *_RESTRICT_KYWD, 296 pthread_mutex_t *_RESTRICT_KYWD, const struct timespec *_RESTRICT_KYWD); 297 extern int pthread_cond_reltimedwait_np(pthread_cond_t *_RESTRICT_KYWD, 298 pthread_mutex_t *_RESTRICT_KYWD, const struct timespec *_RESTRICT_KYWD); 299 extern int pthread_attr_getguardsize(const pthread_attr_t *_RESTRICT_KYWD, 300 size_t *_RESTRICT_KYWD); 301 extern int pthread_attr_setguardsize(pthread_attr_t *, size_t); 302 extern int pthread_getconcurrency(void); 303 extern int pthread_setconcurrency(int); 304 extern int pthread_mutexattr_settype(pthread_mutexattr_t *, int); 305 extern int pthread_mutexattr_gettype(const pthread_mutexattr_t *_RESTRICT_KYWD, 306 int *_RESTRICT_KYWD); 307 extern int pthread_rwlock_init(pthread_rwlock_t *_RESTRICT_KYWD, 308 const pthread_rwlockattr_t *_RESTRICT_KYWD); 309 extern int pthread_rwlock_destroy(pthread_rwlock_t *); 310 extern int pthread_rwlock_rdlock(pthread_rwlock_t *); 311 extern int pthread_rwlock_timedrdlock(pthread_rwlock_t *_RESTRICT_KYWD, 312 const struct timespec *_RESTRICT_KYWD); 313 extern int pthread_rwlock_reltimedrdlock_np(pthread_rwlock_t *_RESTRICT_KYWD, 314 const struct timespec *_RESTRICT_KYWD); 315 extern int pthread_rwlock_tryrdlock(pthread_rwlock_t *); 316 extern int pthread_rwlock_wrlock(pthread_rwlock_t *); 317 extern int pthread_rwlock_timedwrlock(pthread_rwlock_t *_RESTRICT_KYWD, 318 const struct timespec *_RESTRICT_KYWD); 319 extern int pthread_rwlock_reltimedwrlock_np(pthread_rwlock_t *_RESTRICT_KYWD, 320 const struct timespec *_RESTRICT_KYWD); 321 extern int pthread_rwlock_trywrlock(pthread_rwlock_t *); 322 extern int pthread_rwlock_unlock(pthread_rwlock_t *); 323 extern int pthread_rwlockattr_init(pthread_rwlockattr_t *); 324 extern int pthread_rwlockattr_destroy(pthread_rwlockattr_t *); 325 extern int pthread_rwlockattr_getpshared( 326 const pthread_rwlockattr_t *_RESTRICT_KYWD, int *_RESTRICT_KYWD); 327 extern int pthread_rwlockattr_setpshared(pthread_rwlockattr_t *, int); 328 extern int pthread_spin_init(pthread_spinlock_t *, int); 329 extern int pthread_spin_destroy(pthread_spinlock_t *); 330 extern int pthread_spin_lock(pthread_spinlock_t *); 331 extern int pthread_spin_trylock(pthread_spinlock_t *); 332 extern int pthread_spin_unlock(pthread_spinlock_t *); 333 extern int pthread_barrierattr_init(pthread_barrierattr_t *); 334 extern int pthread_barrierattr_destroy(pthread_barrierattr_t *); 335 extern int pthread_barrierattr_setpshared(pthread_barrierattr_t *, int); 336 extern int pthread_barrierattr_getpshared( 337 const pthread_barrierattr_t *_RESTRICT_KYWD, int *_RESTRICT_KYWD); 338 extern int pthread_barrier_init(pthread_barrier_t *_RESTRICT_KYWD, 339 const pthread_barrierattr_t *_RESTRICT_KYWD, uint_t); 340 extern int pthread_barrier_destroy(pthread_barrier_t *); 341 extern int pthread_barrier_wait(pthread_barrier_t *); 342 343 #else /* __STDC__ */ 344 345 /* 346 * function prototypes - thread related calls 347 */ 348 extern int pthread_atfork(); 349 extern int pthread_attr_init(); 350 extern int pthread_attr_destroy(); 351 extern int pthread_attr_setstack(); 352 extern int pthread_attr_getstack(); 353 extern int pthread_attr_setstacksize(); 354 extern int pthread_attr_getstacksize(); 355 extern int pthread_attr_setstackaddr(); 356 extern int pthread_attr_getstackaddr(); 357 extern int pthread_attr_setdetachstate(); 358 extern int pthread_attr_getdetachstate(); 359 extern int pthread_attr_setscope(); 360 extern int pthread_attr_getscope(); 361 extern int pthread_attr_setinheritsched(); 362 extern int pthread_attr_getinheritsched(); 363 extern int pthread_attr_setschedpolicy(); 364 extern int pthread_attr_getschedpolicy(); 365 extern int pthread_attr_setschedparam(); 366 extern int pthread_attr_getschedparam(); 367 extern int pthread_create(); 368 extern int pthread_once(); 369 extern int pthread_join(); 370 extern int pthread_detach(); 371 extern void pthread_exit(); 372 extern int pthread_cancel(); 373 extern int pthread_setschedparam(); 374 extern int pthread_getschedparam(); 375 extern int pthread_setschedprio(); 376 extern int pthread_setcancelstate(); 377 extern int pthread_setcanceltype(); 378 extern void pthread_testcancel(); 379 extern int pthread_equal(); 380 extern int pthread_key_create(); 381 extern int pthread_key_create_once_np(); 382 extern int pthread_key_delete(); 383 extern int pthread_setspecific(); 384 extern void *pthread_getspecific(); 385 extern pthread_t pthread_self(); 386 /* 387 * function prototypes - synchronization related calls 388 */ 389 extern int pthread_mutexattr_init(); 390 extern int pthread_mutexattr_destroy(); 391 extern int pthread_mutexattr_setpshared(); 392 extern int pthread_mutexattr_getpshared(); 393 extern int pthread_mutexattr_setprotocol(); 394 extern int pthread_mutexattr_getprotocol(); 395 extern int pthread_mutexattr_setprioceiling(); 396 extern int pthread_mutexattr_getprioceiling(); 397 extern int pthread_mutexattr_setrobust_np(); 398 extern int pthread_mutexattr_getrobust_np(); 399 extern int pthread_mutex_init(); 400 extern int pthread_mutex_consistent_np(); 401 extern int pthread_mutex_destroy(); 402 extern int pthread_mutex_lock(); 403 extern int pthread_mutex_timedlock(); 404 extern int pthread_mutex_reltimedlock_np(); 405 extern int pthread_mutex_unlock(); 406 extern int pthread_mutex_trylock(); 407 extern int pthread_mutex_setprioceiling(); 408 extern int pthread_mutex_getprioceiling(); 409 extern int pthread_condattr_init(); 410 extern int pthread_condattr_destroy(); 411 extern int pthread_condattr_setclock(); 412 extern int pthread_condattr_getclock(); 413 extern int pthread_condattr_setpshared(); 414 extern int pthread_condattr_getpshared(); 415 extern int pthread_cond_init(); 416 extern int pthread_cond_destroy(); 417 extern int pthread_cond_broadcast(); 418 extern int pthread_cond_signal(); 419 extern int pthread_cond_wait(); 420 extern int pthread_cond_timedwait(); 421 extern int pthread_cond_reltimedwait_np(); 422 extern int pthread_attr_getguardsize(); 423 extern int pthread_attr_setguardsize(); 424 extern int pthread_getconcurrency(); 425 extern int pthread_setconcurrency(); 426 extern int pthread_mutexattr_settype(); 427 extern int pthread_mutexattr_gettype(); 428 extern int pthread_rwlock_init(); 429 extern int pthread_rwlock_destroy(); 430 extern int pthread_rwlock_rdlock(); 431 extern int pthread_rwlock_tryrdlock(); 432 extern int pthread_rwlock_wrlock(); 433 extern int pthread_rwlock_trywrlock(); 434 extern int pthread_rwlock_unlock(); 435 extern int pthread_rwlockattr_init(); 436 extern int pthread_rwlockattr_destroy(); 437 extern int pthread_rwlockattr_getpshared(); 438 extern int pthread_rwlockattr_setpshared(); 439 extern int pthread_spin_init(); 440 extern int pthread_spin_destroy(); 441 extern int pthread_spin_lock(); 442 extern int pthread_spin_trylock(); 443 extern int pthread_spin_unlock(); 444 extern int pthread_barrierattr_init(); 445 extern int pthread_barrierattr_destroy(); 446 extern int pthread_barrierattr_setpshared(); 447 extern int pthread_barrierattr_getpshared(); 448 extern int pthread_barrier_init(); 449 extern int pthread_barrier_destroy(); 450 extern int pthread_barrier_wait(); 451 452 #endif /* __STDC__ */ 453 454 #endif /* _ASM */ 455 456 #ifdef __cplusplus 457 } 458 #endif 459 460 #endif /* _PTHREAD_H */ 461