nptl/pthreadP.h

   1 /* Copyright (C) 2002-2021 Free Software Foundation, Inc.
   2    This file is part of the GNU C Library.
   3    Contributed by Ulrich Drepper <drepper@redhat.com>, 2002.
   4
   5    The GNU C Library is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU Lesser General Public
   7    License as published by the Free Software Foundation; either
   8    version 2.1 of the License, or (at your option) any later version.
   9
  10    The GNU C Library 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 GNU
  13    Lesser General Public License for more details.
  14
  15    You should have received a copy of the GNU Lesser General Public
  16    License along with the GNU C Library; if not, see
  17    <https://www.gnu.org/licenses/>.  */
  18
  19 #ifndef _PTHREADP_H
  20 #define _PTHREADP_H     1
  21
  22 #define __PTHREAD_NPTL
  23
  24 #include <pthread.h>
  25 #include <setjmp.h>
  26 #include <stdbool.h>
  27 #include <sys/syscall.h>
  28 #include "descr.h"
  29 #include <tls.h>
  30 #include <lowlevellock.h>
  31 #include <stackinfo.h>
  32 #include <internaltypes.h>
  33 #include <atomic.h>
  34 #include <kernel-features.h>
  35 #include <errno.h>
  36 #include <internal-signals.h>
  37 #include "pthread_mutex_conf.h"
  38
  39
  40 /* Atomic operations on TLS memory.  */
  41 #ifndef THREAD_ATOMIC_CMPXCHG_VAL
  42 # define THREAD_ATOMIC_CMPXCHG_VAL(descr, member, new, old) \
  43   atomic_compare_and_exchange_val_acq (&(descr)->member, new, old)
  44 #endif
  45
  46 #ifndef THREAD_ATOMIC_BIT_SET
  47 # define THREAD_ATOMIC_BIT_SET(descr, member, bit) \
  48   atomic_bit_set (&(descr)->member, bit)
  49 #endif
  50
  51
  52 static inline short max_adaptive_count (void)
  53 {
  54 #if HAVE_TUNABLES
  55   return __mutex_aconf.spin_count;
  56 #else
  57   return DEFAULT_ADAPTIVE_COUNT;
  58 #endif
  59 }
  60
  61
  62 /* Magic cookie representing robust mutex with dead owner.  */
  63 #define PTHREAD_MUTEX_INCONSISTENT      INT_MAX
  64 /* Magic cookie representing not recoverable robust mutex.  */
  65 #define PTHREAD_MUTEX_NOTRECOVERABLE    (INT_MAX - 1)
  66
  67
  68 /* Internal mutex type value.  */
  69 enum
  70 {
  71   PTHREAD_MUTEX_KIND_MASK_NP = 3,
  72
  73   PTHREAD_MUTEX_ELISION_NP    = 256,
  74   PTHREAD_MUTEX_NO_ELISION_NP = 512,
  75
  76   PTHREAD_MUTEX_ROBUST_NORMAL_NP = 16,
  77   PTHREAD_MUTEX_ROBUST_RECURSIVE_NP
  78   = PTHREAD_MUTEX_ROBUST_NORMAL_NP | PTHREAD_MUTEX_RECURSIVE_NP,
  79   PTHREAD_MUTEX_ROBUST_ERRORCHECK_NP
  80   = PTHREAD_MUTEX_ROBUST_NORMAL_NP | PTHREAD_MUTEX_ERRORCHECK_NP,
  81   PTHREAD_MUTEX_ROBUST_ADAPTIVE_NP
  82   = PTHREAD_MUTEX_ROBUST_NORMAL_NP | PTHREAD_MUTEX_ADAPTIVE_NP,
  83   PTHREAD_MUTEX_PRIO_INHERIT_NP = 32,
  84   PTHREAD_MUTEX_PI_NORMAL_NP
  85   = PTHREAD_MUTEX_PRIO_INHERIT_NP | PTHREAD_MUTEX_NORMAL,
  86   PTHREAD_MUTEX_PI_RECURSIVE_NP
  87   = PTHREAD_MUTEX_PRIO_INHERIT_NP | PTHREAD_MUTEX_RECURSIVE_NP,
  88   PTHREAD_MUTEX_PI_ERRORCHECK_NP
  89   = PTHREAD_MUTEX_PRIO_INHERIT_NP | PTHREAD_MUTEX_ERRORCHECK_NP,
  90   PTHREAD_MUTEX_PI_ADAPTIVE_NP
  91   = PTHREAD_MUTEX_PRIO_INHERIT_NP | PTHREAD_MUTEX_ADAPTIVE_NP,
  92   PTHREAD_MUTEX_PI_ROBUST_NORMAL_NP
  93   = PTHREAD_MUTEX_PRIO_INHERIT_NP | PTHREAD_MUTEX_ROBUST_NORMAL_NP,
  94   PTHREAD_MUTEX_PI_ROBUST_RECURSIVE_NP
  95   = PTHREAD_MUTEX_PRIO_INHERIT_NP | PTHREAD_MUTEX_ROBUST_RECURSIVE_NP,
  96   PTHREAD_MUTEX_PI_ROBUST_ERRORCHECK_NP
  97   = PTHREAD_MUTEX_PRIO_INHERIT_NP | PTHREAD_MUTEX_ROBUST_ERRORCHECK_NP,
  98   PTHREAD_MUTEX_PI_ROBUST_ADAPTIVE_NP
  99   = PTHREAD_MUTEX_PRIO_INHERIT_NP | PTHREAD_MUTEX_ROBUST_ADAPTIVE_NP,
 100   PTHREAD_MUTEX_PRIO_PROTECT_NP = 64,
 101   PTHREAD_MUTEX_PP_NORMAL_NP
 102   = PTHREAD_MUTEX_PRIO_PROTECT_NP | PTHREAD_MUTEX_NORMAL,
 103   PTHREAD_MUTEX_PP_RECURSIVE_NP
 104   = PTHREAD_MUTEX_PRIO_PROTECT_NP | PTHREAD_MUTEX_RECURSIVE_NP,
 105   PTHREAD_MUTEX_PP_ERRORCHECK_NP
 106   = PTHREAD_MUTEX_PRIO_PROTECT_NP | PTHREAD_MUTEX_ERRORCHECK_NP,
 107   PTHREAD_MUTEX_PP_ADAPTIVE_NP
 108   = PTHREAD_MUTEX_PRIO_PROTECT_NP | PTHREAD_MUTEX_ADAPTIVE_NP,
 109   PTHREAD_MUTEX_ELISION_FLAGS_NP
 110   = PTHREAD_MUTEX_ELISION_NP | PTHREAD_MUTEX_NO_ELISION_NP,
 111
 112   PTHREAD_MUTEX_TIMED_ELISION_NP =
 113           PTHREAD_MUTEX_TIMED_NP | PTHREAD_MUTEX_ELISION_NP,
 114   PTHREAD_MUTEX_TIMED_NO_ELISION_NP =
 115           PTHREAD_MUTEX_TIMED_NP | PTHREAD_MUTEX_NO_ELISION_NP,
 116 };
 117 #define PTHREAD_MUTEX_PSHARED_BIT 128
 118
 119 /* See concurrency notes regarding __kind in struct __pthread_mutex_s
 120    in sysdeps/nptl/bits/thread-shared-types.h.  */
 121 #define PTHREAD_MUTEX_TYPE(m) \
 122   (atomic_load_relaxed (&((m)->__data.__kind)) & 127)
 123 /* Don't include NO_ELISION, as that type is always the same
 124    as the underlying lock type.  */
 125 #define PTHREAD_MUTEX_TYPE_ELISION(m) \
 126   (atomic_load_relaxed (&((m)->__data.__kind))  \
 127    & (127 | PTHREAD_MUTEX_ELISION_NP))
 128
 129 #if LLL_PRIVATE == 0 && LLL_SHARED == 128
 130 # define PTHREAD_MUTEX_PSHARED(m) \
 131   (atomic_load_relaxed (&((m)->__data.__kind)) & 128)
 132 #else
 133 # define PTHREAD_MUTEX_PSHARED(m) \
 134   ((atomic_load_relaxed (&((m)->__data.__kind)) & 128)  \
 135    ? LLL_SHARED : LLL_PRIVATE)
 136 #endif
 137
 138 /* The kernel when waking robust mutexes on exit never uses
 139    FUTEX_PRIVATE_FLAG FUTEX_WAKE.  */
 140 #define PTHREAD_ROBUST_MUTEX_PSHARED(m) LLL_SHARED
 141
 142 /* Ceiling in __data.__lock.  __data.__lock is signed, so don't
 143    use the MSB bit in there, but in the mask also include that bit,
 144    so that the compiler can optimize & PTHREAD_MUTEX_PRIO_CEILING_MASK
 145    masking if the value is then shifted down by
 146    PTHREAD_MUTEX_PRIO_CEILING_SHIFT.  */
 147 #define PTHREAD_MUTEX_PRIO_CEILING_SHIFT        19
 148 #define PTHREAD_MUTEX_PRIO_CEILING_MASK         0xfff80000
 149
 150
 151 /* Flags in mutex attr.  */
 152 #define PTHREAD_MUTEXATTR_PROTOCOL_SHIFT        28
 153 #define PTHREAD_MUTEXATTR_PROTOCOL_MASK         0x30000000
 154 #define PTHREAD_MUTEXATTR_PRIO_CEILING_SHIFT    12
 155 #define PTHREAD_MUTEXATTR_PRIO_CEILING_MASK     0x00fff000
 156 #define PTHREAD_MUTEXATTR_FLAG_ROBUST           0x40000000
 157 #define PTHREAD_MUTEXATTR_FLAG_PSHARED          0x80000000
 158 #define PTHREAD_MUTEXATTR_FLAG_BITS \
 159   (PTHREAD_MUTEXATTR_FLAG_ROBUST | PTHREAD_MUTEXATTR_FLAG_PSHARED \
 160    | PTHREAD_MUTEXATTR_PROTOCOL_MASK | PTHREAD_MUTEXATTR_PRIO_CEILING_MASK)
 161
 162
 163 /* For the following, see pthread_rwlock_common.c.  */
 164 #define PTHREAD_RWLOCK_WRPHASE          1
 165 #define PTHREAD_RWLOCK_WRLOCKED         2
 166 #define PTHREAD_RWLOCK_RWAITING         4
 167 #define PTHREAD_RWLOCK_READER_SHIFT     3
 168 #define PTHREAD_RWLOCK_READER_OVERFLOW  ((unsigned int) 1 \
 169                                          << (sizeof (unsigned int) * 8 - 1))
 170 #define PTHREAD_RWLOCK_WRHANDOVER       ((unsigned int) 1 \
 171                                          << (sizeof (unsigned int) * 8 - 1))
 172 #define PTHREAD_RWLOCK_FUTEX_USED       2
 173
 174
 175 /* Bits used in robust mutex implementation.  */
 176 #define FUTEX_WAITERS           0x80000000
 177 #define FUTEX_OWNER_DIED        0x40000000
 178 #define FUTEX_TID_MASK          0x3fffffff
 179
 180
 181 /* pthread_once definitions.  See __pthread_once for how these are used.  */
 182 #define __PTHREAD_ONCE_INPROGRESS       1
 183 #define __PTHREAD_ONCE_DONE             2
 184 #define __PTHREAD_ONCE_FORK_GEN_INCR    4
 185
 186 /* Attribute to indicate thread creation was issued from C11 thrd_create.  */
 187 #define ATTR_C11_THREAD ((void*)(uintptr_t)-1)
 188
 189
 190 /* Condition variable definitions.  See __pthread_cond_wait_common.
 191    Need to be defined here so there is one place from which
 192    nptl_lock_constants can grab them.  */
 193 #define __PTHREAD_COND_CLOCK_MONOTONIC_MASK 2
 194 #define __PTHREAD_COND_SHARED_MASK 1
 195
 196
 197 /* Internal variables.  */
 198
 199
 200 /* Default pthread attributes.  */
 201 extern union pthread_attr_transparent __default_pthread_attr;
 202 libc_hidden_proto (__default_pthread_attr)
 203 extern int __default_pthread_attr_lock;
 204 libc_hidden_proto (__default_pthread_attr_lock)
 205 /* Called from __libc_freeres to deallocate the default attribute.  */
 206 extern void __default_pthread_attr_freeres (void) attribute_hidden;
 207
 208 /* Size and alignment of static TLS block.  */
 209 extern size_t __static_tls_size attribute_hidden;
 210 extern size_t __static_tls_align_m1 attribute_hidden;
 211
 212 /* Attribute handling.  */
 213 extern struct pthread_attr *__attr_list attribute_hidden;
 214 extern int __attr_list_lock attribute_hidden;
 215
 216 /* Concurrency handling.  */
 217 extern int __concurrency_level attribute_hidden;
 218
 219 /* Thread-local data key handling.  */
 220 extern struct pthread_key_struct __pthread_keys[PTHREAD_KEYS_MAX];
 221 libc_hidden_proto (__pthread_keys)
 222
 223 /* Number of threads running.  */
 224 extern unsigned int __nptl_nthreads;
 225 libc_hidden_proto (__nptl_nthreads)
 226
 227 #ifndef __ASSUME_SET_ROBUST_LIST
 228 /* True if the set_robust_list system call works.  Initialized in
 229    __tls_init_tp.  */
 230 extern bool __nptl_set_robust_list_avail;
 231 rtld_hidden_proto (__nptl_set_robust_list_avail)
 232 #endif
 233
 234 /* Thread Priority Protection.  */
 235 extern int __sched_fifo_min_prio;
 236 libc_hidden_proto (__sched_fifo_min_prio)
 237 extern int __sched_fifo_max_prio;
 238 libc_hidden_proto (__sched_fifo_max_prio)
 239 extern void __init_sched_fifo_prio (void);
 240 libc_hidden_proto (__init_sched_fifo_prio)
 241 extern int __pthread_tpp_change_priority (int prev_prio, int new_prio);
 242 libc_hidden_proto (__pthread_tpp_change_priority)
 243 extern int __pthread_current_priority (void);
 244 libc_hidden_proto (__pthread_current_priority)
 245
 246 /* This will not catch all invalid descriptors but is better than
 247    nothing.  And if the test triggers the thread descriptor is
 248    guaranteed to be invalid.  */
 249 #define INVALID_TD_P(pd) __builtin_expect ((pd)->tid <= 0, 0)
 250 #define INVALID_NOT_TERMINATED_TD_P(pd) __builtin_expect ((pd)->tid < 0, 0)
 251
 252 /* Cancellation test.  */
 253 #define CANCELLATION_P(self) \
 254   do {                                                                        \
 255     int cancelhandling = THREAD_GETMEM (self, cancelhandling);                \
 256     if (CANCEL_ENABLED_AND_CANCELED (cancelhandling))                         \
 257       {                                                                       \
 258         THREAD_SETMEM (self, result, PTHREAD_CANCELED);                       \
 259         __do_cancel ();                                                       \
 260       }                                                                       \
 261   } while (0)
 262
 263
 264 extern void __pthread_unwind (__pthread_unwind_buf_t *__buf)
 265      __cleanup_fct_attribute __attribute ((__noreturn__))
 266 #if !defined SHARED && !IS_IN (libpthread)
 267      weak_function
 268 #endif
 269      ;
 270 libc_hidden_proto (__pthread_unwind)
 271 extern void __pthread_unwind_next (__pthread_unwind_buf_t *__buf)
 272      __cleanup_fct_attribute __attribute ((__noreturn__))
 273 #ifndef SHARED
 274      weak_function
 275 #endif
 276      ;
 277 /* NB: No hidden proto for __pthread_unwind_next: inside glibc, the
 278    legacy unwinding mechanism is used.  */
 279
 280 extern void __pthread_register_cancel (__pthread_unwind_buf_t *__buf)
 281      __cleanup_fct_attribute;
 282 libc_hidden_proto (__pthread_register_cancel)
 283 extern void __pthread_unregister_cancel (__pthread_unwind_buf_t *__buf)
 284      __cleanup_fct_attribute;
 285 libc_hidden_proto (__pthread_unregister_cancel)
 286
 287 /* Called when a thread reacts on a cancellation request.  */
 288 static inline void
 289 __attribute ((noreturn, always_inline))
 290 __do_cancel (void)
 291 {
 292   struct pthread *self = THREAD_SELF;
 293
 294   /* Make sure we get no more cancellations.  */
 295   THREAD_ATOMIC_BIT_SET (self, cancelhandling, EXITING_BIT);
 296
 297   __pthread_unwind ((__pthread_unwind_buf_t *)
 298                     THREAD_GETMEM (self, cleanup_jmp_buf));
 299 }
 300
 301
 302 /* Internal prototypes.  */
 303
 304 /* Deallocate a thread's stack after optionally making sure the thread
 305    descriptor is still valid.  */
 306 extern void __nptl_free_tcb (struct pthread *pd);
 307 libc_hidden_proto (__nptl_free_tcb)
 308
 309 /* Change the permissions of a thread stack.  Called from
 310    _dl_make_stacks_executable and pthread_create.  */
 311 int
 312 __nptl_change_stack_perm (struct pthread *pd);
 313 rtld_hidden_proto (__nptl_change_stack_perm)
 314
 315 /* longjmp handling.  */
 316 extern void __pthread_cleanup_upto (__jmp_buf target, char *targetframe);
 317 libc_hidden_proto (__pthread_cleanup_upto)
 318
 319
 320 /* Functions with versioned interfaces.  */
 321 extern int __pthread_create_2_1 (pthread_t *newthread,
 322                                  const pthread_attr_t *attr,
 323                                  void *(*start_routine) (void *), void *arg);
 324 extern int __pthread_create_2_0 (pthread_t *newthread,
 325                                  const pthread_attr_t *attr,
 326                                  void *(*start_routine) (void *), void *arg);
 327 extern int __pthread_attr_init (pthread_attr_t *attr);
 328 libc_hidden_proto (__pthread_attr_init)
 329 extern int __pthread_attr_init_2_0 (pthread_attr_t *attr);
 330
 331
 332 /* Event handlers for libthread_db interface.  */
 333 extern void __nptl_create_event (void);
 334 extern void __nptl_death_event (void);
 335 hidden_proto (__nptl_create_event)
 336 hidden_proto (__nptl_death_event)
 337
 338 /* The fork generation counter, defined in libpthread.  */
 339 extern unsigned long int __fork_generation attribute_hidden;
 340
 341 /* Pointer to the fork generation counter in the thread library.  */
 342 extern unsigned long int *__fork_generation_pointer attribute_hidden;
 343
 344 extern size_t __pthread_get_minstack (const pthread_attr_t *attr);
 345
 346 /* Namespace save aliases.  */
 347 extern int __pthread_getschedparam (pthread_t thread_id, int *policy,
 348                                     struct sched_param *param);
 349 extern int __pthread_setschedparam (pthread_t thread_id, int policy,
 350                                     const struct sched_param *param);
 351 extern int __pthread_mutex_init (pthread_mutex_t *__mutex,
 352                                  const pthread_mutexattr_t *__mutexattr);
 353 libc_hidden_proto (__pthread_mutex_init)
 354 extern int __pthread_mutex_destroy (pthread_mutex_t *__mutex);
 355 libc_hidden_proto (__pthread_mutex_destroy)
 356 extern int __pthread_mutex_trylock (pthread_mutex_t *_mutex);
 357 libc_hidden_proto (__pthread_mutex_trylock)
 358 extern int __pthread_mutex_lock (pthread_mutex_t *__mutex);
 359 libc_hidden_proto (__pthread_mutex_lock)
 360 extern int __pthread_mutex_timedlock (pthread_mutex_t *__mutex,
 361      const struct timespec *__abstime);
 362 extern int __pthread_mutex_cond_lock (pthread_mutex_t *__mutex)
 363      attribute_hidden;
 364 extern void __pthread_mutex_cond_lock_adjust (pthread_mutex_t *__mutex)
 365      attribute_hidden;
 366 extern int __pthread_mutex_unlock (pthread_mutex_t *__mutex);
 367 libc_hidden_proto (__pthread_mutex_unlock)
 368 extern int __pthread_mutex_unlock_usercnt (pthread_mutex_t *__mutex,
 369                                            int __decr);
 370 libc_hidden_proto (__pthread_mutex_unlock_usercnt)
 371 extern int __pthread_mutexattr_init (pthread_mutexattr_t *attr);
 372 libc_hidden_proto (__pthread_mutexattr_init)
 373 extern int __pthread_mutexattr_destroy (pthread_mutexattr_t *attr);
 374 extern int __pthread_mutexattr_settype (pthread_mutexattr_t *attr, int kind);
 375 libc_hidden_proto (__pthread_mutexattr_settype)
 376 extern int __pthread_attr_destroy (pthread_attr_t *attr);
 377 libc_hidden_proto (__pthread_attr_destroy)
 378 extern int __pthread_attr_getdetachstate (const pthread_attr_t *attr,
 379                                           int *detachstate);
 380 extern int __pthread_attr_setdetachstate (pthread_attr_t *attr,
 381                                           int detachstate);
 382 extern int __pthread_attr_getinheritsched (const pthread_attr_t *attr,
 383                                            int *inherit);
 384 extern int __pthread_attr_setinheritsched (pthread_attr_t *attr, int inherit);
 385 extern int __pthread_attr_getschedparam (const pthread_attr_t *attr,
 386                                          struct sched_param *param);
 387 extern int __pthread_attr_setschedparam (pthread_attr_t *attr,
 388                                          const struct sched_param *param);
 389 extern int __pthread_attr_getschedpolicy (const pthread_attr_t *attr,
 390                                           int *policy);
 391 extern int __pthread_attr_setschedpolicy (pthread_attr_t *attr, int policy);
 392 extern int __pthread_attr_getscope (const pthread_attr_t *attr, int *scope);
 393 extern int __pthread_attr_setscope (pthread_attr_t *attr, int scope);
 394 extern int __pthread_attr_getstackaddr (const pthread_attr_t *__restrict
 395                                         __attr, void **__restrict __stackaddr);
 396 extern int __pthread_attr_setstackaddr (pthread_attr_t *__attr,
 397                                         void *__stackaddr);
 398 extern int __pthread_attr_getstacksize (const pthread_attr_t *__restrict
 399                                         __attr,
 400                                         size_t *__restrict __stacksize);
 401 extern int __pthread_attr_setstacksize (pthread_attr_t *__attr,
 402                                         size_t __stacksize);
 403 extern int __pthread_attr_getstack (const pthread_attr_t *__restrict __attr,
 404                                     void **__restrict __stackaddr,
 405                                     size_t *__restrict __stacksize);
 406 extern int __pthread_attr_setstack (pthread_attr_t *__attr, void *__stackaddr,
 407                                     size_t __stacksize);
 408 int __pthread_attr_setaffinity_np (pthread_attr_t *, size_t, const cpu_set_t *);
 409 libc_hidden_proto (__pthread_attr_setaffinity_np)
 410 extern __typeof (pthread_getattr_default_np) __pthread_getattr_default_np;
 411 libpthread_hidden_proto (__pthread_getattr_default_np)
 412 extern int __pthread_rwlock_init (pthread_rwlock_t *__restrict __rwlock,
 413                                   const pthread_rwlockattr_t *__restrict
 414                                   __attr);
 415 extern int __pthread_rwlock_destroy (pthread_rwlock_t *__rwlock);
 416 extern int __pthread_rwlock_rdlock (pthread_rwlock_t *__rwlock);
 417 libc_hidden_proto (__pthread_rwlock_rdlock)
 418 extern int __pthread_rwlock_tryrdlock (pthread_rwlock_t *__rwlock);
 419 extern int __pthread_rwlock_wrlock (pthread_rwlock_t *__rwlock);
 420 libc_hidden_proto (__pthread_rwlock_wrlock)
 421 extern int __pthread_rwlock_trywrlock (pthread_rwlock_t *__rwlock);
 422 extern int __pthread_rwlock_unlock (pthread_rwlock_t *__rwlock);
 423 extern int __pthread_cond_broadcast (pthread_cond_t *cond);
 424 libc_hidden_proto (__pthread_cond_broadcast)
 425 extern int __pthread_cond_destroy (pthread_cond_t *cond);
 426 libc_hidden_proto (__pthread_cond_destroy)
 427 extern int __pthread_cond_init (pthread_cond_t *cond,
 428                                 const pthread_condattr_t *cond_attr);
 429 libc_hidden_proto (__pthread_cond_init)
 430 extern int __pthread_cond_signal (pthread_cond_t *cond);
 431 libc_hidden_proto (__pthread_cond_signal)
 432 extern int __pthread_cond_wait (pthread_cond_t *cond, pthread_mutex_t *mutex);
 433 libc_hidden_proto (__pthread_cond_wait)
 434
 435 #if __TIMESIZE == 64
 436 # define __pthread_clockjoin_np64 __pthread_clockjoin_np
 437 # define __pthread_timedjoin_np64 __pthread_timedjoin_np
 438 # define __pthread_cond_timedwait64 __pthread_cond_timedwait
 439 # define __pthread_cond_clockwait64 __pthread_cond_clockwait
 440 # define __pthread_rwlock_clockrdlock64 __pthread_rwlock_clockrdlock
 441 # define __pthread_rwlock_clockwrlock64 __pthread_rwlock_clockwrlock
 442 # define __pthread_rwlock_timedrdlock64 __pthread_rwlock_timedrdlock
 443 # define __pthread_rwlock_timedwrlock64 __pthread_rwlock_timedwrlock
 444 # define __pthread_mutex_clocklock64 __pthread_mutex_clocklock
 445 # define __pthread_mutex_timedlock64 __pthread_mutex_timedlock
 446 #else
 447 extern int __pthread_clockjoin_np64 (pthread_t threadid, void **thread_return,
 448                                      clockid_t clockid,
 449                                      const struct __timespec64 *abstime);
 450 libc_hidden_proto (__pthread_clockjoin_np64)
 451 extern int __pthread_timedjoin_np64 (pthread_t threadid, void **thread_return,
 452                                      const struct __timespec64 *abstime);
 453 libc_hidden_proto (__pthread_timedjoin_np64)
 454 extern int __pthread_cond_timedwait64 (pthread_cond_t *cond,
 455                                        pthread_mutex_t *mutex,
 456                                        const struct __timespec64 *abstime);
 457 libc_hidden_proto (__pthread_cond_timedwait64)
 458 extern int __pthread_cond_clockwait64 (pthread_cond_t *cond,
 459                                        pthread_mutex_t *mutex,
 460                                        clockid_t clockid,
 461                                        const struct __timespec64 *abstime);
 462 libc_hidden_proto (__pthread_cond_clockwait64)
 463 extern int __pthread_rwlock_clockrdlock64 (pthread_rwlock_t *rwlock,
 464                                            clockid_t clockid,
 465                                            const struct __timespec64 *abstime);
 466 libc_hidden_proto (__pthread_rwlock_clockrdlock64)
 467 extern int __pthread_rwlock_clockwrlock64 (pthread_rwlock_t *rwlock,
 468                                            clockid_t clockid,
 469                                            const struct __timespec64 *abstime);
 470 libc_hidden_proto (__pthread_rwlock_clockwrlock64)
 471 extern int __pthread_rwlock_timedrdlock64 (pthread_rwlock_t *rwlock,
 472                                            const struct __timespec64 *abstime);
 473 libc_hidden_proto (__pthread_rwlock_timedrdlock64)
 474 extern int __pthread_rwlock_timedwrlock64 (pthread_rwlock_t *rwlock,
 475                                            const struct __timespec64 *abstime);
 476 libc_hidden_proto (__pthread_rwlock_timedwrlock64)
 477 extern int __pthread_mutex_clocklock64 (pthread_mutex_t *mutex,
 478                                         clockid_t clockid,
 479                                         const struct __timespec64 *abstime);
 480 libc_hidden_proto (__pthread_mutex_clocklock64)
 481 extern int __pthread_mutex_timedlock64 (pthread_mutex_t *mutex,
 482                                         const struct __timespec64 *abstime);
 483 libc_hidden_proto (__pthread_mutex_timedlock64)
 484 #endif
 485
 486 extern int __pthread_cond_timedwait (pthread_cond_t *cond,
 487                                      pthread_mutex_t *mutex,
 488                                      const struct timespec *abstime);
 489 libc_hidden_proto (__pthread_cond_timedwait)
 490 extern int __pthread_cond_clockwait (pthread_cond_t *cond,
 491                                      pthread_mutex_t *mutex,
 492                                      clockid_t clockid,
 493                                      const struct timespec *abstime)
 494   __nonnull ((1, 2, 4));
 495 libc_hidden_proto (__pthread_cond_clockwait)
 496
 497 extern int __pthread_mutex_clocklock (pthread_mutex_t *mutex,
 498                                       clockid_t clockid,
 499                                       const struct timespec *abstime);
 500 libc_hidden_proto (__pthread_mutex_clocklock)
 501 extern int __pthread_mutex_timedlock (pthread_mutex_t *mutex,
 502                                       const struct timespec *abstime);
 503 libc_hidden_proto (__pthread_mutex_timedlock)
 504
 505 extern int __pthread_condattr_destroy (pthread_condattr_t *attr);
 506 extern int __pthread_condattr_init (pthread_condattr_t *attr);
 507 extern int __pthread_key_create (pthread_key_t *key, void (*destr) (void *));
 508 libc_hidden_proto (__pthread_key_create)
 509 extern int __pthread_key_delete (pthread_key_t key);
 510 libc_hidden_proto (__pthread_key_delete)
 511 extern void *__pthread_getspecific (pthread_key_t key);
 512 libc_hidden_proto (__pthread_getspecific)
 513 extern int __pthread_setspecific (pthread_key_t key, const void *value);
 514 libc_hidden_proto (__pthread_setspecific)
 515 extern int __pthread_once (pthread_once_t *once_control,
 516                            void (*init_routine) (void));
 517 libc_hidden_proto (__pthread_once)
 518 extern int __pthread_atfork (void (*prepare) (void), void (*parent) (void),
 519                              void (*child) (void));
 520 extern pthread_t __pthread_self (void);
 521 extern int __pthread_equal (pthread_t thread1, pthread_t thread2);
 522 extern int __pthread_detach (pthread_t th);
 523 libc_hidden_proto (__pthread_detach)
 524 extern int __pthread_kill (pthread_t threadid, int signo);
 525 extern void __pthread_exit (void *value) __attribute__ ((__noreturn__));
 526 libc_hidden_proto (__pthread_exit)
 527 extern int __pthread_join (pthread_t threadid, void **thread_return);
 528 libc_hidden_proto (__pthread_join)
 529 extern int __pthread_setcanceltype (int type, int *oldtype);
 530 libc_hidden_proto (__pthread_setcanceltype)
 531 extern void __pthread_testcancel (void);
 532 libc_hidden_proto (__pthread_testcancel)
 533 extern int __pthread_clockjoin_ex (pthread_t, void **, clockid_t,
 534                                    const struct __timespec64 *, bool)
 535   attribute_hidden;
 536 extern int __pthread_sigmask (int, const sigset_t *, sigset_t *);
 537 libc_hidden_proto (__pthread_sigmask);
 538
 539
 540 #if IS_IN (libpthread)
 541 hidden_proto (__pthread_rwlock_unlock)
 542 #endif
 543
 544 extern int __pthread_cond_broadcast_2_0 (pthread_cond_2_0_t *cond);
 545 extern int __pthread_cond_destroy_2_0 (pthread_cond_2_0_t *cond);
 546 extern int __pthread_cond_init_2_0 (pthread_cond_2_0_t *cond,
 547                                     const pthread_condattr_t *cond_attr);
 548 extern int __pthread_cond_signal_2_0 (pthread_cond_2_0_t *cond);
 549 extern int __pthread_cond_timedwait_2_0 (pthread_cond_2_0_t *cond,
 550                                          pthread_mutex_t *mutex,
 551                                          const struct timespec *abstime);
 552 extern int __pthread_cond_wait_2_0 (pthread_cond_2_0_t *cond,
 553                                     pthread_mutex_t *mutex);
 554
 555 extern int __pthread_getaffinity_np (pthread_t th, size_t cpusetsize,
 556                                      cpu_set_t *cpuset);
 557 libc_hidden_proto (__pthread_getaffinity_np)
 558
 559 /* Special internal version of pthread_attr_setsigmask_np which does
 560    not filter out internal signals from *SIGMASK.  This can be used to
 561    launch threads with internal signals blocked.  */
 562   extern int __pthread_attr_setsigmask_internal (pthread_attr_t *attr,
 563                                                  const sigset_t *sigmask);
 564 libc_hidden_proto (__pthread_attr_setsigmask_internal)
 565
 566 extern __typeof (pthread_attr_getsigmask_np) __pthread_attr_getsigmask_np;
 567 libc_hidden_proto (__pthread_attr_getsigmask_np)
 568
 569 /* Special versions which use non-exported functions.  */
 570 extern void __pthread_cleanup_push (struct _pthread_cleanup_buffer *buffer,
 571                                     void (*routine) (void *), void *arg);
 572 libc_hidden_proto (__pthread_cleanup_push)
 573
 574 /* Replace cleanup macros defined in <pthread.h> with internal
 575    versions that don't depend on unwind info and better support
 576    cancellation.  */
 577 # undef pthread_cleanup_push
 578 # define pthread_cleanup_push(routine,arg)              \
 579   { struct _pthread_cleanup_buffer _buffer;             \
 580   __pthread_cleanup_push (&_buffer, (routine), (arg));
 581
 582 extern void __pthread_cleanup_pop (struct _pthread_cleanup_buffer *buffer,
 583                                    int execute);
 584 libc_hidden_proto (__pthread_cleanup_pop)
 585 # undef pthread_cleanup_pop
 586 # define pthread_cleanup_pop(execute)                   \
 587   __pthread_cleanup_pop (&_buffer, (execute)); }
 588
 589 #if defined __EXCEPTIONS && !defined __cplusplus
 590 /* Structure to hold the cleanup handler information.  */
 591 struct __pthread_cleanup_combined_frame
 592 {
 593   void (*__cancel_routine) (void *);
 594   void *__cancel_arg;
 595   int __do_it;
 596   struct _pthread_cleanup_buffer __buffer;
 597 };
 598
 599 /* Special cleanup macros which register cleanup both using
 600    __pthread_cleanup_{push,pop} and using cleanup attribute.  This is needed
 601    for pthread_once, so that it supports both throwing exceptions from the
 602    pthread_once callback (only cleanup attribute works there) and cancellation
 603    of the thread running the callback if the callback or some routines it
 604    calls don't have unwind information.  */
 605
 606 static __always_inline void
 607 __pthread_cleanup_combined_routine (struct __pthread_cleanup_combined_frame
 608                                     *__frame)
 609 {
 610   if (__frame->__do_it)
 611     {
 612       __frame->__cancel_routine (__frame->__cancel_arg);
 613       __frame->__do_it = 0;
 614       __pthread_cleanup_pop (&__frame->__buffer, 0);
 615     }
 616 }
 617
 618 static inline void
 619 __pthread_cleanup_combined_routine_voidptr (void *__arg)
 620 {
 621   struct __pthread_cleanup_combined_frame *__frame
 622     = (struct __pthread_cleanup_combined_frame *) __arg;
 623   if (__frame->__do_it)
 624     {
 625       __frame->__cancel_routine (__frame->__cancel_arg);
 626       __frame->__do_it = 0;
 627     }
 628 }
 629
 630 # define pthread_cleanup_combined_push(routine, arg) \
 631   do {                                                                        \
 632     void (*__cancel_routine) (void *) = (routine);                            \
 633     struct __pthread_cleanup_combined_frame __clframe                         \
 634       __attribute__ ((__cleanup__ (__pthread_cleanup_combined_routine)))      \
 635       = { .__cancel_routine = __cancel_routine, .__cancel_arg = (arg),        \
 636           .__do_it = 1 };                                                     \
 637     __pthread_cleanup_push (&__clframe.__buffer,                              \
 638                             __pthread_cleanup_combined_routine_voidptr,       \
 639                             &__clframe);
 640
 641 # define pthread_cleanup_combined_pop(execute) \
 642     __pthread_cleanup_pop (&__clframe.__buffer, 0);                           \
 643     __clframe.__do_it = 0;                                                    \
 644     if (execute)                                                              \
 645       __cancel_routine (__clframe.__cancel_arg);                              \
 646   } while (0)
 647
 648 #endif /* __EXCEPTIONS && !defined __cplusplus */
 649
 650 extern void __pthread_cleanup_push_defer (struct _pthread_cleanup_buffer *buffer,
 651                                           void (*routine) (void *), void *arg);
 652 extern void __pthread_cleanup_pop_restore (struct _pthread_cleanup_buffer *buffer,
 653                                            int execute);
 654
 655 /* Old cleanup interfaces, still used in libc.so.  */
 656 extern void _pthread_cleanup_push (struct _pthread_cleanup_buffer *buffer,
 657                                    void (*routine) (void *), void *arg);
 658 extern void _pthread_cleanup_pop (struct _pthread_cleanup_buffer *buffer,
 659                                   int execute);
 660 extern void _pthread_cleanup_push_defer (struct _pthread_cleanup_buffer *buffer,
 661                                          void (*routine) (void *), void *arg);
 662 extern void _pthread_cleanup_pop_restore (struct _pthread_cleanup_buffer *buffer,
 663                                           int execute);
 664
 665 extern void __nptl_deallocate_tsd (void);
 666 libc_hidden_proto (__nptl_deallocate_tsd)
 667
 668 void __nptl_setxid_sighandler (int sig, siginfo_t *si, void *ctx);
 669 libc_hidden_proto (__nptl_setxid_sighandler)
 670 extern int __nptl_setxid (struct xid_command *cmdp) attribute_hidden;
 671
 672 extern void __wait_lookup_done (void) attribute_hidden;
 673
 674 /* Allocates the extension space for ATTR.  Returns an error code on
 675    memory allocation failure, zero on success.  If ATTR already has an
 676    extension space, this function does nothing.  */
 677 int __pthread_attr_extension (struct pthread_attr *attr) attribute_hidden
 678   __attribute_warn_unused_result__;
 679
 680 #ifdef SHARED
 681 # define PTHREAD_STATIC_FN_REQUIRE(name)
 682 #else
 683 # define PTHREAD_STATIC_FN_REQUIRE(name) __asm (".globl " #name);
 684 #endif
 685
 686 /* Make a deep copy of the attribute *SOURCE in *TARGET.  *TARGET is
 687    not assumed to have been initialized.  Returns 0 on success, or a
 688    positive error code otherwise.  */
 689 int __pthread_attr_copy (pthread_attr_t *target, const pthread_attr_t *source);
 690 libc_hidden_proto (__pthread_attr_copy)
 691
 692 /* Returns 0 if POL is a valid scheduling policy.  */
 693 static inline int
 694 check_sched_policy_attr (int pol)
 695 {
 696   if (pol == SCHED_OTHER || pol == SCHED_FIFO || pol == SCHED_RR)
 697     return 0;
 698
 699   return EINVAL;
 700 }
 701
 702 /* Returns 0 if PR is within the accepted range of priority values for
 703    the scheduling policy POL or EINVAL otherwise.  */
 704 static inline int
 705 check_sched_priority_attr (int pr, int pol)
 706 {
 707   int min = __sched_get_priority_min (pol);
 708   int max = __sched_get_priority_max (pol);
 709
 710   if (min >= 0 && max >= 0 && pr >= min && pr <= max)
 711     return 0;
 712
 713   return EINVAL;
 714 }
 715
 716 /* Returns 0 if ST is a valid stack size for a thread stack and EINVAL
 717    otherwise.  */
 718 static inline int
 719 check_stacksize_attr (size_t st)
 720 {
 721   if (st >= PTHREAD_STACK_MIN)
 722     return 0;
 723
 724   return EINVAL;
 725 }
 726
 727 #define ASSERT_TYPE_SIZE(type, size)                                    \
 728   _Static_assert (sizeof (type) == size,                                \
 729                   "sizeof (" #type ") != " #size)
 730
 731 #define ASSERT_PTHREAD_INTERNAL_SIZE(type, internal)                    \
 732   _Static_assert (sizeof ((type) { { 0 } }).__size >= sizeof (internal),\
 733                   "sizeof (" #type ".__size) < sizeof (" #internal ")")
 734
 735 #define ASSERT_PTHREAD_STRING(x) __STRING (x)
 736 #define ASSERT_PTHREAD_INTERNAL_OFFSET(type, member, offset)            \
 737   _Static_assert (offsetof (type, member) == offset,                    \
 738                   "offset of " #member " field of " #type " != "        \
 739                   ASSERT_PTHREAD_STRING (offset))
 740 #define ASSERT_PTHREAD_INTERNAL_MEMBER_SIZE(type, member, mtype)        \
 741   _Static_assert (sizeof (((type) { 0 }).member) != 8,  \
 742                   "sizeof (" #type "." #member ") != sizeof (" #mtype "))")
 743
 744 #endif  /* pthreadP.h */