linuxthreads/sysdeps/pthread/pthread.h

   1 /* Linuxthreads - a simple clone()-based implementation of Posix        */
   2 /* threads for Linux.                                                   */
   3 /* Copyright (C) 1996 Xavier Leroy (Xavier.Leroy@inria.fr)              */
   4 /*                                                                      */
   5 /* This program is free software; you can redistribute it and/or        */
   6 /* modify it under the terms of the GNU Library General Public License  */
   7 /* as published by the Free Software Foundation; either version 2       */
   8 /* of the License, or (at your option) any later version.               */
   9 /*                                                                      */
  10 /* This program is distributed in the hope that it will be useful,      */
  11 /* but WITHOUT ANY WARRANTY; without even the implied warranty of       */
  12 /* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        */
  13 /* GNU Library General Public License for more details.                 */
  14
  15 #ifndef _PTHREAD_H
  16 #define _PTHREAD_H      1
  17
  18 #include <features.h>
  19
  20 #include <sched.h>
  21 #include <time.h>
  22
  23 #define __need_sigset_t
  24 #include <signal.h>
  25 #include <bits/pthreadtypes.h>
  26 #include <bits/initspin.h>
  27
  28
  29 __BEGIN_DECLS
  30
  31 /* Initializers.  */
  32
  33 #define PTHREAD_MUTEX_INITIALIZER \
  34   {0, 0, 0, PTHREAD_MUTEX_TIMED_NP, __LOCK_INITIALIZER}
  35 #ifdef __USE_GNU
  36 # define PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP \
  37   {0, 0, 0, PTHREAD_MUTEX_RECURSIVE_NP, __LOCK_INITIALIZER}
  38 # define PTHREAD_ERRORCHECK_MUTEX_INITIALIZER_NP \
  39   {0, 0, 0, PTHREAD_MUTEX_ERRORCHECK_NP, __LOCK_INITIALIZER}
  40 # define PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP \
  41   {0, 0, 0, PTHREAD_MUTEX_ADAPTIVE_NP, __LOCK_INITIALIZER}
  42 #endif
  43
  44 #define PTHREAD_COND_INITIALIZER {__LOCK_INITIALIZER, 0, "", 0}
  45
  46 #if defined __USE_UNIX98 || defined __USE_XOPEN2K
  47 # define PTHREAD_RWLOCK_INITIALIZER \
  48   { __LOCK_INITIALIZER, 0, NULL, NULL, NULL,                                  \
  49     PTHREAD_RWLOCK_DEFAULT_NP, PTHREAD_PROCESS_PRIVATE }
  50 #endif
  51 #ifdef __USE_GNU
  52 # define PTHREAD_RWLOCK_WRITER_NONRECURSIVE_INITIALIZER_NP \
  53   { __LOCK_INITIALIZER, 0, NULL, NULL, NULL,                                  \
  54     PTHREAD_RWLOCK_PREFER_WRITER_NONRECURSIVE_NP, PTHREAD_PROCESS_PRIVATE }
  55 #endif
  56
  57 /* Values for attributes.  */
  58
  59 enum
  60 {
  61   PTHREAD_CREATE_JOINABLE,
  62 #define PTHREAD_CREATE_JOINABLE PTHREAD_CREATE_JOINABLE
  63   PTHREAD_CREATE_DETACHED
  64 #define PTHREAD_CREATE_DETACHED PTHREAD_CREATE_DETACHED
  65 };
  66
  67 enum
  68 {
  69   PTHREAD_INHERIT_SCHED,
  70 #define PTHREAD_INHERIT_SCHED   PTHREAD_INHERIT_SCHED
  71   PTHREAD_EXPLICIT_SCHED
  72 #define PTHREAD_EXPLICIT_SCHED  PTHREAD_EXPLICIT_SCHED
  73 };
  74
  75 enum
  76 {
  77   PTHREAD_SCOPE_SYSTEM,
  78 #define PTHREAD_SCOPE_SYSTEM    PTHREAD_SCOPE_SYSTEM
  79   PTHREAD_SCOPE_PROCESS
  80 #define PTHREAD_SCOPE_PROCESS   PTHREAD_SCOPE_PROCESS
  81 };
  82
  83 enum
  84 {
  85   PTHREAD_MUTEX_TIMED_NP,
  86   PTHREAD_MUTEX_RECURSIVE_NP,
  87   PTHREAD_MUTEX_ERRORCHECK_NP,
  88   PTHREAD_MUTEX_ADAPTIVE_NP
  89 #ifdef __USE_UNIX98
  90   ,
  91   PTHREAD_MUTEX_NORMAL = PTHREAD_MUTEX_TIMED_NP,
  92   PTHREAD_MUTEX_RECURSIVE = PTHREAD_MUTEX_RECURSIVE_NP,
  93   PTHREAD_MUTEX_ERRORCHECK = PTHREAD_MUTEX_ERRORCHECK_NP,
  94   PTHREAD_MUTEX_DEFAULT = PTHREAD_MUTEX_NORMAL
  95 #endif
  96 #ifdef __USE_GNU
  97   /* For compatibility.  */
  98   , PTHREAD_MUTEX_FAST_NP = PTHREAD_MUTEX_ADAPTIVE_NP
  99 #endif
 100 };
 101
 102 enum
 103 {
 104   PTHREAD_PROCESS_PRIVATE,
 105 #define PTHREAD_PROCESS_PRIVATE PTHREAD_PROCESS_PRIVATE
 106   PTHREAD_PROCESS_SHARED
 107 #define PTHREAD_PROCESS_SHARED  PTHREAD_PROCESS_SHARED
 108 };
 109
 110 #if defined __USE_UNIX98 || defined __USE_XOPEN2K
 111 enum
 112 {
 113   PTHREAD_RWLOCK_PREFER_READER_NP,
 114   PTHREAD_RWLOCK_PREFER_WRITER_NP,
 115   PTHREAD_RWLOCK_PREFER_WRITER_NONRECURSIVE_NP,
 116   PTHREAD_RWLOCK_DEFAULT_NP = PTHREAD_RWLOCK_PREFER_WRITER_NP
 117 };
 118 #endif  /* Unix98 */
 119
 120 #define PTHREAD_ONCE_INIT 0
 121
 122 /* Special constants */
 123
 124 #ifdef __USE_XOPEN2K
 125 /* -1 is distinct from 0 and all errno constants */
 126 # define PTHREAD_BARRIER_SERIAL_THREAD -1
 127 #endif
 128
 129 /* Cleanup buffers */
 130
 131 struct _pthread_cleanup_buffer
 132 {
 133   void (*__routine) (void *);             /* Function to call.  */
 134   void *__arg;                            /* Its argument.  */
 135   int __canceltype;                       /* Saved cancellation type. */
 136   struct _pthread_cleanup_buffer *__prev; /* Chaining of cleanup functions.  */
 137 };
 138
 139 /* Cancellation */
 140
 141 enum
 142 {
 143   PTHREAD_CANCEL_ENABLE,
 144 #define PTHREAD_CANCEL_ENABLE   PTHREAD_CANCEL_ENABLE
 145   PTHREAD_CANCEL_DISABLE
 146 #define PTHREAD_CANCEL_DISABLE  PTHREAD_CANCEL_DISABLE
 147 };
 148 enum
 149 {
 150   PTHREAD_CANCEL_DEFERRED,
 151 #define PTHREAD_CANCEL_DEFERRED PTHREAD_CANCEL_DEFERRED
 152   PTHREAD_CANCEL_ASYNCHRONOUS
 153 #define PTHREAD_CANCEL_ASYNCHRONOUS     PTHREAD_CANCEL_ASYNCHRONOUS
 154 };
 155 #define PTHREAD_CANCELED ((void *) -1)
 156
 157
 158 /* Function for handling threads.  */
 159
 160 /* Create a thread with given attributes ATTR (or default attributes
 161    if ATTR is NULL), and call function START_ROUTINE with given
 162    arguments ARG.  */
 163 extern int pthread_create (pthread_t *__restrict __threadp,
 164                            __const pthread_attr_t *__restrict __attr,
 165                            void *(*__start_routine) (void *),
 166                            void *__restrict __arg) __THROW;
 167
 168 /* Obtain the identifier of the current thread.  */
 169 extern pthread_t pthread_self (void) __THROW;
 170
 171 /* Compare two thread identifiers.  */
 172 extern int pthread_equal (pthread_t __thread1, pthread_t __thread2) __THROW;
 173
 174 /* Terminate calling thread.  */
 175 extern void pthread_exit (void *__retval) __attribute__ ((__noreturn__));
 176
 177 /* Make calling thread wait for termination of the thread TH.  The
 178    exit status of the thread is stored in *THREAD_RETURN, if THREAD_RETURN
 179    is not NULL.  */
 180 extern int pthread_join (pthread_t __th, void **__thread_return);
 181
 182 /* Indicate that the thread TH is never to be joined with PTHREAD_JOIN.
 183    The resources of TH will therefore be freed immediately when it
 184    terminates, instead of waiting for another thread to perform PTHREAD_JOIN
 185    on it.  */
 186 extern int pthread_detach (pthread_t __th) __THROW;
 187
 188
 189 /* Functions for handling attributes.  */
 190
 191 /* Initialize thread attribute *ATTR with default attributes
 192    (detachstate is PTHREAD_JOINABLE, scheduling policy is SCHED_OTHER,
 193     no user-provided stack).  */
 194 extern int pthread_attr_init (pthread_attr_t *__attr) __THROW;
 195
 196 /* Destroy thread attribute *ATTR.  */
 197 extern int pthread_attr_destroy (pthread_attr_t *__attr) __THROW;
 198
 199 /* Set the `detachstate' attribute in *ATTR according to DETACHSTATE.  */
 200 extern int pthread_attr_setdetachstate (pthread_attr_t *__attr,
 201                                         int __detachstate) __THROW;
 202
 203 /* Return in *DETACHSTATE the `detachstate' attribute in *ATTR.  */
 204 extern int pthread_attr_getdetachstate (__const pthread_attr_t *__attr,
 205                                         int *__detachstate) __THROW;
 206
 207 /* Set scheduling parameters (priority, etc) in *ATTR according to PARAM.  */
 208 extern int pthread_attr_setschedparam (pthread_attr_t *__restrict __attr,
 209                                        __const struct sched_param *__restrict
 210                                        __param) __THROW;
 211
 212 /* Return in *PARAM the scheduling parameters of *ATTR.  */
 213 extern int pthread_attr_getschedparam (__const pthread_attr_t *__restrict
 214                                        __attr,
 215                                        struct sched_param *__restrict __param)
 216      __THROW;
 217
 218 /* Set scheduling policy in *ATTR according to POLICY.  */
 219 extern int pthread_attr_setschedpolicy (pthread_attr_t *__attr, int __policy)
 220      __THROW;
 221
 222 /* Return in *POLICY the scheduling policy of *ATTR.  */
 223 extern int pthread_attr_getschedpolicy (__const pthread_attr_t *__restrict
 224                                         __attr, int *__restrict __policy)
 225      __THROW;
 226
 227 /* Set scheduling inheritance mode in *ATTR according to INHERIT.  */
 228 extern int pthread_attr_setinheritsched (pthread_attr_t *__attr,
 229                                          int __inherit) __THROW;
 230
 231 /* Return in *INHERIT the scheduling inheritance mode of *ATTR.  */
 232 extern int pthread_attr_getinheritsched (__const pthread_attr_t *__restrict
 233                                          __attr, int *__restrict __inherit)
 234      __THROW;
 235
 236 /* Set scheduling contention scope in *ATTR according to SCOPE.  */
 237 extern int pthread_attr_setscope (pthread_attr_t *__attr, int __scope)
 238      __THROW;
 239
 240 /* Return in *SCOPE the scheduling contention scope of *ATTR.  */
 241 extern int pthread_attr_getscope (__const pthread_attr_t *__restrict __attr,
 242                                   int *__restrict __scope) __THROW;
 243
 244 #ifdef __USE_UNIX98
 245 /* Set the size of the guard area at the bottom of the thread.  */
 246 extern int pthread_attr_setguardsize (pthread_attr_t *__attr,
 247                                       size_t __guardsize) __THROW;
 248
 249 /* Get the size of the guard area at the bottom of the thread.  */
 250 extern int pthread_attr_getguardsize (__const pthread_attr_t *__restrict
 251                                       __attr, size_t *__restrict __guardsize)
 252      __THROW;
 253 #endif
 254
 255 /* Set the starting address of the stack of the thread to be created.
 256    Depending on whether the stack grows up or down the value must either
 257    be higher or lower than all the address in the memory block.  The
 258    minimal size of the block must be PTHREAD_STACK_MIN.  */
 259 extern int pthread_attr_setstackaddr (pthread_attr_t *__attr,
 260                                       void *__stackaddr) __THROW;
 261
 262 /* Return the previously set address for the stack.  */
 263 extern int pthread_attr_getstackaddr (__const pthread_attr_t *__restrict
 264                                       __attr, void **__restrict __stackaddr)
 265      __THROW;
 266
 267 #ifdef __USE_XOPEN2K
 268 /* The following two interfaces are intended to replace the last two.  They
 269    require setting the address as well as the size since only setting the
 270    address will make the implementation on some architectures impossible.  */
 271 extern int pthread_attr_setstack (pthread_attr_t *__attr, void *__stackaddr,
 272                                   size_t __stacksize) __THROW;
 273
 274 /* Return the previously set address for the stack.  */
 275 extern int pthread_attr_getstack (__const pthread_attr_t *__restrict __attr,
 276                                   void **__restrict __stackaddr,
 277                                   size_t *__restrict __stacksize) __THROW;
 278 #endif
 279
 280 /* Add information about the minimum stack size needed for the thread
 281    to be started.  This size must never be less than PTHREAD_STACK_MIN
 282    and must also not exceed the system limits.  */
 283 extern int pthread_attr_setstacksize (pthread_attr_t *__attr,
 284                                       size_t __stacksize) __THROW;
 285
 286 /* Return the currently used minimal stack size.  */
 287 extern int pthread_attr_getstacksize (__const pthread_attr_t *__restrict
 288                                       __attr, size_t *__restrict __stacksize)
 289      __THROW;
 290
 291 #ifdef __USE_GNU
 292 /* Initialize thread attribute *ATTR with attributes corresponding to the
 293    already running thread TH.  It shall be called on unitialized ATTR
 294    and destroyed with pthread_attr_destroy when no longer needed.  */
 295 extern int pthread_getattr_np (pthread_t __th, pthread_attr_t *__attr) __THROW;
 296 #endif
 297
 298 /* Functions for scheduling control.  */
 299
 300 /* Set the scheduling parameters for TARGET_THREAD according to POLICY
 301    and *PARAM.  */
 302 extern int pthread_setschedparam (pthread_t __target_thread, int __policy,
 303                                   __const struct sched_param *__param)
 304      __THROW;
 305
 306 /* Return in *POLICY and *PARAM the scheduling parameters for TARGET_THREAD.  */
 307 extern int pthread_getschedparam (pthread_t __target_thread,
 308                                   int *__restrict __policy,
 309                                   struct sched_param *__restrict __param)
 310      __THROW;
 311
 312 #ifdef __USE_UNIX98
 313 /* Determine level of concurrency.  */
 314 extern int pthread_getconcurrency (void) __THROW;
 315
 316 /* Set new concurrency level to LEVEL.  */
 317 extern int pthread_setconcurrency (int __level) __THROW;
 318 #endif
 319
 320 #ifdef __USE_GNU
 321 /* Yield the processor to another thread or process.
 322    This function is similar to the POSIX `sched_yield' function but
 323    might be differently implemented in the case of a m-on-n thread
 324    implementation.  */
 325 extern int pthread_yield (void) __THROW;
 326 #endif
 327
 328 /* Functions for mutex handling.  */
 329
 330 /* Initialize MUTEX using attributes in *MUTEX_ATTR, or use the
 331    default values if later is NULL.  */
 332 extern int pthread_mutex_init (pthread_mutex_t *__restrict __mutex,
 333                                __const pthread_mutexattr_t *__restrict
 334                                __mutex_attr) __THROW;
 335
 336 /* Destroy MUTEX.  */
 337 extern int pthread_mutex_destroy (pthread_mutex_t *__mutex) __THROW;
 338
 339 /* Try to lock MUTEX.  */
 340 extern int pthread_mutex_trylock (pthread_mutex_t *__mutex) __THROW;
 341
 342 /* Wait until lock for MUTEX becomes available and lock it.  */
 343 extern int pthread_mutex_lock (pthread_mutex_t *__mutex) __THROW;
 344
 345 #ifdef __USE_XOPEN2K
 346 /* Wait until lock becomes available, or specified time passes. */
 347 extern int pthread_mutex_timedlock (pthread_mutex_t *__restrict __mutex,
 348                                     __const struct timespec *__restrict
 349                                     __abstime) __THROW;
 350 #endif
 351
 352 /* Unlock MUTEX.  */
 353 extern int pthread_mutex_unlock (pthread_mutex_t *__mutex) __THROW;
 354
 355
 356 /* Functions for handling mutex attributes.  */
 357
 358 /* Initialize mutex attribute object ATTR with default attributes
 359    (kind is PTHREAD_MUTEX_TIMED_NP).  */
 360 extern int pthread_mutexattr_init (pthread_mutexattr_t *__attr) __THROW;
 361
 362 /* Destroy mutex attribute object ATTR.  */
 363 extern int pthread_mutexattr_destroy (pthread_mutexattr_t *__attr) __THROW;
 364
 365 /* Get the process-shared flag of the mutex attribute ATTR.  */
 366 extern int pthread_mutexattr_getpshared (__const pthread_mutexattr_t *
 367                                          __restrict __attr,
 368                                          int *__restrict __pshared) __THROW;
 369
 370 /* Set the process-shared flag of the mutex attribute ATTR.  */
 371 extern int pthread_mutexattr_setpshared (pthread_mutexattr_t *__attr,
 372                                          int __pshared) __THROW;
 373
 374 #ifdef __USE_UNIX98
 375 /* Set the mutex kind attribute in *ATTR to KIND (either PTHREAD_MUTEX_NORMAL,
 376    PTHREAD_MUTEX_RECURSIVE, PTHREAD_MUTEX_ERRORCHECK, or
 377    PTHREAD_MUTEX_DEFAULT).  */
 378 extern int pthread_mutexattr_settype (pthread_mutexattr_t *__attr, int __kind)
 379      __THROW;
 380
 381 /* Return in *KIND the mutex kind attribute in *ATTR.  */
 382 extern int pthread_mutexattr_gettype (__const pthread_mutexattr_t *__restrict
 383                                       __attr, int *__restrict __kind) __THROW;
 384 #endif
 385
 386
 387 /* Functions for handling conditional variables.  */
 388
 389 /* Initialize condition variable COND using attributes ATTR, or use
 390    the default values if later is NULL.  */
 391 extern int pthread_cond_init (pthread_cond_t *__restrict __cond,
 392                               __const pthread_condattr_t *__restrict
 393                               __cond_attr) __THROW;
 394
 395 /* Destroy condition variable COND.  */
 396 extern int pthread_cond_destroy (pthread_cond_t *__cond) __THROW;
 397
 398 /* Wake up one thread waiting for condition variable COND.  */
 399 extern int pthread_cond_signal (pthread_cond_t *__cond) __THROW;
 400
 401 /* Wake up all threads waiting for condition variables COND.  */
 402 extern int pthread_cond_broadcast (pthread_cond_t *__cond) __THROW;
 403
 404 /* Wait for condition variable COND to be signaled or broadcast.
 405    MUTEX is assumed to be locked before.  */
 406 extern int pthread_cond_wait (pthread_cond_t *__restrict __cond,
 407                               pthread_mutex_t *__restrict __mutex);
 408
 409 /* Wait for condition variable COND to be signaled or broadcast until
 410    ABSTIME.  MUTEX is assumed to be locked before.  ABSTIME is an
 411    absolute time specification; zero is the beginning of the epoch
 412    (00:00:00 GMT, January 1, 1970).  */
 413 extern int pthread_cond_timedwait (pthread_cond_t *__restrict __cond,
 414                                    pthread_mutex_t *__restrict __mutex,
 415                                    __const struct timespec *__restrict
 416                                    __abstime);
 417
 418 /* Functions for handling condition variable attributes.  */
 419
 420 /* Initialize condition variable attribute ATTR.  */
 421 extern int pthread_condattr_init (pthread_condattr_t *__attr) __THROW;
 422
 423 /* Destroy condition variable attribute ATTR.  */
 424 extern int pthread_condattr_destroy (pthread_condattr_t *__attr) __THROW;
 425
 426 /* Get the process-shared flag of the condition variable attribute ATTR.  */
 427 extern int pthread_condattr_getpshared (__const pthread_condattr_t *
 428                                         __restrict __attr,
 429                                         int *__restrict __pshared) __THROW;
 430
 431 /* Set the process-shared flag of the condition variable attribute ATTR.  */
 432 extern int pthread_condattr_setpshared (pthread_condattr_t *__attr,
 433                                         int __pshared) __THROW;
 434
 435
 436 #if defined __USE_UNIX98 || defined __USE_XOPEN2K
 437 /* Functions for handling read-write locks.  */
 438
 439 /* Initialize read-write lock RWLOCK using attributes ATTR, or use
 440    the default values if later is NULL.  */
 441 extern int pthread_rwlock_init (pthread_rwlock_t *__restrict __rwlock,
 442                                 __const pthread_rwlockattr_t *__restrict
 443                                 __attr) __THROW;
 444
 445 /* Destroy read-write lock RWLOCK.  */
 446 extern int pthread_rwlock_destroy (pthread_rwlock_t *__rwlock) __THROW;
 447
 448 /* Acquire read lock for RWLOCK.  */
 449 extern int pthread_rwlock_rdlock (pthread_rwlock_t *__rwlock) __THROW;
 450
 451 /* Try to acquire read lock for RWLOCK.  */
 452 extern int pthread_rwlock_tryrdlock (pthread_rwlock_t *__rwlock) __THROW;
 453
 454 # ifdef __USE_XOPEN2K
 455 /* Try to acquire read lock for RWLOCK or return after specfied time.  */
 456 extern int pthread_rwlock_timedrdlock (pthread_rwlock_t *__restrict __rwlock,
 457                                        __const struct timespec *__restrict
 458                                        __abstime) __THROW;
 459 # endif
 460
 461 /* Acquire write lock for RWLOCK.  */
 462 extern int pthread_rwlock_wrlock (pthread_rwlock_t *__rwlock) __THROW;
 463
 464 /* Try to acquire write lock for RWLOCK.  */
 465 extern int pthread_rwlock_trywrlock (pthread_rwlock_t *__rwlock) __THROW;
 466
 467 # ifdef __USE_XOPEN2K
 468 /* Try to acquire write lock for RWLOCK or return after specfied time.  */
 469 extern int pthread_rwlock_timedwrlock (pthread_rwlock_t *__restrict __rwlock,
 470                                        __const struct timespec *__restrict
 471                                        __abstime) __THROW;
 472 # endif
 473
 474 /* Unlock RWLOCK.  */
 475 extern int pthread_rwlock_unlock (pthread_rwlock_t *__rwlock) __THROW;
 476
 477
 478 /* Functions for handling read-write lock attributes.  */
 479
 480 /* Initialize attribute object ATTR with default values.  */
 481 extern int pthread_rwlockattr_init (pthread_rwlockattr_t *__attr) __THROW;
 482
 483 /* Destroy attribute object ATTR.  */
 484 extern int pthread_rwlockattr_destroy (pthread_rwlockattr_t *__attr) __THROW;
 485
 486 /* Return current setting of process-shared attribute of ATTR in PSHARED.  */
 487 extern int pthread_rwlockattr_getpshared (__const pthread_rwlockattr_t *
 488                                           __restrict __attr,
 489                                           int *__restrict __pshared) __THROW;
 490
 491 /* Set process-shared attribute of ATTR to PSHARED.  */
 492 extern int pthread_rwlockattr_setpshared (pthread_rwlockattr_t *__attr,
 493                                           int __pshared) __THROW;
 494
 495 /* Return current setting of reader/writer preference.  */
 496 extern int pthread_rwlockattr_getkind_np (__const pthread_rwlockattr_t *__attr,
 497                                           int *__pref) __THROW;
 498
 499 /* Set reader/write preference.  */
 500 extern int pthread_rwlockattr_setkind_np (pthread_rwlockattr_t *__attr,
 501                                           int __pref) __THROW;
 502 #endif
 503
 504 #ifdef __USE_XOPEN2K
 505 /* The IEEE Std. 1003.1j-2000 introduces functions to implement
 506    spinlocks.  */
 507
 508 /* Initialize the spinlock LOCK.  If PSHARED is nonzero the spinlock can
 509    be shared between different processes.  */
 510 extern int pthread_spin_init (pthread_spinlock_t *__lock, int __pshared)
 511      __THROW;
 512
 513 /* Destroy the spinlock LOCK.  */
 514 extern int pthread_spin_destroy (pthread_spinlock_t *__lock) __THROW;
 515
 516 /* Wait until spinlock LOCK is retrieved.  */
 517 extern int pthread_spin_lock (pthread_spinlock_t *__lock) __THROW;
 518
 519 /* Try to lock spinlock LOCK.  */
 520 extern int pthread_spin_trylock (pthread_spinlock_t *__lock) __THROW;
 521
 522 /* Release spinlock LOCK.  */
 523 extern int pthread_spin_unlock (pthread_spinlock_t *__lock) __THROW;
 524
 525
 526 /* Barriers are a also a new feature in 1003.1j-2000. */
 527
 528 extern int pthread_barrier_init (pthread_barrier_t *__restrict __barrier,
 529                                  __const pthread_barrierattr_t *__restrict
 530                                  __attr, unsigned int __count) __THROW;
 531
 532 extern int pthread_barrier_destroy (pthread_barrier_t *__barrier) __THROW;
 533
 534 extern int pthread_barrierattr_init (pthread_barrierattr_t *__attr) __THROW;
 535
 536 extern int pthread_barrierattr_destroy (pthread_barrierattr_t *__attr) __THROW;
 537
 538 extern int pthread_barrierattr_getpshared (__const pthread_barrierattr_t *
 539                                            __restrict __attr,
 540                                            int *__restrict __pshared) __THROW;
 541
 542 extern int pthread_barrierattr_setpshared (pthread_barrierattr_t *__attr,
 543                                            int __pshared) __THROW;
 544
 545 extern int pthread_barrier_wait (pthread_barrier_t *__barrier) __THROW;
 546 #endif
 547
 548
 549 /* Functions for handling thread-specific data.  */
 550
 551 /* Create a key value identifying a location in the thread-specific
 552    data area.  Each thread maintains a distinct thread-specific data
 553    area.  DESTR_FUNCTION, if non-NULL, is called with the value
 554    associated to that key when the key is destroyed.
 555    DESTR_FUNCTION is not called if the value associated is NULL when
 556    the key is destroyed.  */
 557 extern int pthread_key_create (pthread_key_t *__key,
 558                                void (*__destr_function) (void *)) __THROW;
 559
 560 /* Destroy KEY.  */
 561 extern int pthread_key_delete (pthread_key_t __key) __THROW;
 562
 563 /* Store POINTER in the thread-specific data slot identified by KEY. */
 564 extern int pthread_setspecific (pthread_key_t __key,
 565                                 __const void *__pointer) __THROW;
 566
 567 /* Return current value of the thread-specific data slot identified by KEY.  */
 568 extern void *pthread_getspecific (pthread_key_t __key) __THROW;
 569
 570
 571 /* Functions for handling initialization.  */
 572
 573 /* Guarantee that the initialization function INIT_ROUTINE will be called
 574    only once, even if pthread_once is executed several times with the
 575    same ONCE_CONTROL argument. ONCE_CONTROL must point to a static or
 576    extern variable initialized to PTHREAD_ONCE_INIT.
 577
 578    The initialization functions might throw exception which is why
 579    this function is not marked with __THROW.  */
 580 extern int pthread_once (pthread_once_t *__once_control,
 581                          void (*__init_routine) (void));
 582
 583
 584 /* Functions for handling cancellation.  */
 585
 586 /* Set cancelability state of current thread to STATE, returning old
 587    state in *OLDSTATE if OLDSTATE is not NULL.  */
 588 extern int pthread_setcancelstate (int __state, int *__oldstate);
 589
 590 /* Set cancellation state of current thread to TYPE, returning the old
 591    type in *OLDTYPE if OLDTYPE is not NULL.  */
 592 extern int pthread_setcanceltype (int __type, int *__oldtype);
 593
 594 /* Cancel THREAD immediately or at the next possibility.  */
 595 extern int pthread_cancel (pthread_t __cancelthread);
 596
 597 /* Test for pending cancellation for the current thread and terminate
 598    the thread as per pthread_exit(PTHREAD_CANCELED) if it has been
 599    cancelled.  */
 600 extern void pthread_testcancel (void);
 601
 602
 603 /* Install a cleanup handler: ROUTINE will be called with arguments ARG
 604    when the thread is cancelled or calls pthread_exit.  ROUTINE will also
 605    be called with arguments ARG when the matching pthread_cleanup_pop
 606    is executed with non-zero EXECUTE argument.
 607    pthread_cleanup_push and pthread_cleanup_pop are macros and must always
 608    be used in matching pairs at the same nesting level of braces. */
 609
 610 #define pthread_cleanup_push(routine,arg) \
 611   { struct _pthread_cleanup_buffer _buffer;                                   \
 612     _pthread_cleanup_push (&_buffer, (routine), (arg));
 613
 614 extern void _pthread_cleanup_push (struct _pthread_cleanup_buffer *__buffer,
 615                                    void (*__routine) (void *),
 616                                    void *__arg) __THROW;
 617
 618 /* Remove a cleanup handler installed by the matching pthread_cleanup_push.
 619    If EXECUTE is non-zero, the handler function is called. */
 620
 621 #define pthread_cleanup_pop(execute) \
 622     _pthread_cleanup_pop (&_buffer, (execute)); }
 623
 624 extern void _pthread_cleanup_pop (struct _pthread_cleanup_buffer *__buffer,
 625                                   int __execute) __THROW;
 626
 627 /* Install a cleanup handler as pthread_cleanup_push does, but also
 628    saves the current cancellation type and set it to deferred cancellation.  */
 629
 630 #ifdef __USE_GNU
 631 # define pthread_cleanup_push_defer_np(routine,arg) \
 632   { struct _pthread_cleanup_buffer _buffer;                                   \
 633     _pthread_cleanup_push_defer (&_buffer, (routine), (arg));
 634
 635 extern void _pthread_cleanup_push_defer (struct _pthread_cleanup_buffer *__buffer,
 636                                          void (*__routine) (void *),
 637                                          void *__arg) __THROW;
 638
 639 /* Remove a cleanup handler as pthread_cleanup_pop does, but also
 640    restores the cancellation type that was in effect when the matching
 641    pthread_cleanup_push_defer was called.  */
 642
 643 # define pthread_cleanup_pop_restore_np(execute) \
 644   _pthread_cleanup_pop_restore (&_buffer, (execute)); }
 645
 646 extern void _pthread_cleanup_pop_restore (struct _pthread_cleanup_buffer *__buffer,
 647                                           int __execute) __THROW;
 648 #endif
 649
 650
 651 #ifdef __USE_XOPEN2K
 652 /* Get ID of CPU-time clock for thread THREAD_ID.  */
 653 extern int pthread_getcpuclockid (pthread_t __thread_id,
 654                                   __clockid_t *__clock_id) __THROW;
 655 #endif
 656
 657
 658 /* Functions for handling signals.  */
 659 #include <bits/sigthread.h>
 660
 661
 662 /* Functions for handling process creation and process execution.  */
 663
 664 /* Install handlers to be called when a new process is created with FORK.
 665    The PREPARE handler is called in the parent process just before performing
 666    FORK. The PARENT handler is called in the parent process just after FORK.
 667    The CHILD handler is called in the child process.  Each of the three
 668    handlers can be NULL, meaning that no handler needs to be called at that
 669    point.
 670    PTHREAD_ATFORK can be called several times, in which case the PREPARE
 671    handlers are called in LIFO order (last added with PTHREAD_ATFORK,
 672    first called before FORK), and the PARENT and CHILD handlers are called
 673    in FIFO (first added, first called).  */
 674
 675 extern int pthread_atfork (void (*__prepare) (void),
 676                            void (*__parent) (void),
 677                            void (*__child) (void)) __THROW;
 678
 679 /* Terminate all threads in the program except the calling process.
 680    Should be called just before invoking one of the exec*() functions.  */
 681
 682 extern void pthread_kill_other_threads_np (void) __THROW;
 683
 684 __END_DECLS
 685
 686 #endif  /* pthread.h */