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 <nptl/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
52static 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. */
69enum
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. */
201extern union pthread_attr_transparent __default_pthread_attr;
202libc_hidden_proto (__default_pthread_attr)
203extern int __default_pthread_attr_lock;
204libc_hidden_proto (__default_pthread_attr_lock)
205/* Called from __libc_freeres to deallocate the default attribute. */
206extern void __default_pthread_attr_freeres (void) attribute_hidden;
207
208/* Attribute handling. */
209extern struct pthread_attr *__attr_list attribute_hidden;
210extern int __attr_list_lock attribute_hidden;
211
212/* Concurrency handling. */
213extern int __concurrency_level attribute_hidden;
214
215/* Thread-local data key handling. */
216extern struct pthread_key_struct __pthread_keys[PTHREAD_KEYS_MAX];
217libc_hidden_proto (__pthread_keys)
218
219/* Number of threads running. */
220extern unsigned int __nptl_nthreads;
221libc_hidden_proto (__nptl_nthreads)
222
223#ifndef __ASSUME_SET_ROBUST_LIST
224/* True if the set_robust_list system call works. Initialized in
225 __tls_init_tp. */
226extern bool __nptl_set_robust_list_avail;
227rtld_hidden_proto (__nptl_set_robust_list_avail)
228#endif
229
230/* Thread Priority Protection. */
231extern int __sched_fifo_min_prio;
232libc_hidden_proto (__sched_fifo_min_prio)
233extern int __sched_fifo_max_prio;
234libc_hidden_proto (__sched_fifo_max_prio)
235extern void __init_sched_fifo_prio (void);
236libc_hidden_proto (__init_sched_fifo_prio)
237extern int __pthread_tpp_change_priority (int prev_prio, int new_prio);
238libc_hidden_proto (__pthread_tpp_change_priority)
239extern int __pthread_current_priority (void);
240libc_hidden_proto (__pthread_current_priority)
241
242/* This will not catch all invalid descriptors but is better than
243 nothing. And if the test triggers the thread descriptor is
244 guaranteed to be invalid. */
245#define INVALID_TD_P(pd) __builtin_expect ((pd)->tid <= 0, 0)
246#define INVALID_NOT_TERMINATED_TD_P(pd) __builtin_expect ((pd)->tid < 0, 0)
247
248extern void __pthread_unwind (__pthread_unwind_buf_t *__buf)
249 __cleanup_fct_attribute __attribute ((__noreturn__))
250#if !defined SHARED && !IS_IN (libpthread)
251 weak_function
252#endif
253 ;
254libc_hidden_proto (__pthread_unwind)
255extern void __pthread_unwind_next (__pthread_unwind_buf_t *__buf)
256 __cleanup_fct_attribute __attribute ((__noreturn__))
257#ifndef SHARED
258 weak_function
259#endif
260 ;
261/* NB: No hidden proto for __pthread_unwind_next: inside glibc, the
262 legacy unwinding mechanism is used. */
263
264extern void __pthread_register_cancel (__pthread_unwind_buf_t *__buf)
265 __cleanup_fct_attribute;
266libc_hidden_proto (__pthread_register_cancel)
267extern void __pthread_unregister_cancel (__pthread_unwind_buf_t *__buf)
268 __cleanup_fct_attribute;
269libc_hidden_proto (__pthread_unregister_cancel)
270
271/* Called when a thread reacts on a cancellation request. */
272static inline void
273__attribute ((noreturn, always_inline))
274__do_cancel (void)
275{
276 struct pthread *self = THREAD_SELF;
277
278 /* Make sure we get no more cancellations. */
279 THREAD_ATOMIC_BIT_SET (self, cancelhandling, EXITING_BIT);
280
281 __pthread_unwind ((__pthread_unwind_buf_t *)
282 THREAD_GETMEM (self, cleanup_jmp_buf));
283}
284
285
286/* Internal prototypes. */
287
288/* Deallocate a thread's stack after optionally making sure the thread
289 descriptor is still valid. */
290extern void __nptl_free_tcb (struct pthread *pd);
291libc_hidden_proto (__nptl_free_tcb)
292
293/* Change the permissions of a thread stack. Called from
294 _dl_make_stacks_executable and pthread_create. */
295int
296__nptl_change_stack_perm (struct pthread *pd);
297rtld_hidden_proto (__nptl_change_stack_perm)
298
299/* longjmp handling. */
300extern void __pthread_cleanup_upto (__jmp_buf target, char *targetframe);
301libc_hidden_proto (__pthread_cleanup_upto)
302
303
304/* Functions with versioned interfaces. */
305extern int __pthread_create (pthread_t *newthread,
306 const pthread_attr_t *attr,
307 void *(*start_routine) (void *), void *arg);
308libc_hidden_proto (__pthread_create)
309extern int __pthread_create_2_0 (pthread_t *newthread,
310 const pthread_attr_t *attr,
311 void *(*start_routine) (void *), void *arg);
312extern int __pthread_attr_init (pthread_attr_t *attr);
313libc_hidden_proto (__pthread_attr_init)
314extern int __pthread_attr_init_2_0 (pthread_attr_t *attr);
315
316/* Part of the legacy thread events interface (which has been
317 superseded by PTRACE_O_TRACECLONE). This can be set by the
318 debugger before initialization is complete. */
319extern bool __nptl_initial_report_events;
320rtld_hidden_proto (__nptl_initial_report_events)
321
322/* Event handlers for libthread_db interface. */
323extern void __nptl_create_event (void);
324extern void __nptl_death_event (void);
325libc_hidden_proto (__nptl_create_event)
326libc_hidden_proto (__nptl_death_event)
327
328/* The fork generation counter, defined in libpthread. */
329extern unsigned long int __fork_generation attribute_hidden;
330
331/* Pointer to the fork generation counter in the thread library. */
332extern unsigned long int *__fork_generation_pointer attribute_hidden;
333
334extern size_t __pthread_get_minstack (const pthread_attr_t *attr);
335libc_hidden_proto (__pthread_get_minstack)
336
337/* Namespace save aliases. */
338extern int __pthread_getschedparam (pthread_t thread_id, int *policy,
339 struct sched_param *param);
340libc_hidden_proto (__pthread_getschedparam)
341extern int __pthread_setschedparam (pthread_t thread_id, int policy,
342 const struct sched_param *param);
343extern int __pthread_mutex_init (pthread_mutex_t *__mutex,
344 const pthread_mutexattr_t *__mutexattr);
345libc_hidden_proto (__pthread_mutex_init)
346extern int __pthread_mutex_destroy (pthread_mutex_t *__mutex);
347libc_hidden_proto (__pthread_mutex_destroy)
348extern int __pthread_mutex_trylock (pthread_mutex_t *_mutex);
349libc_hidden_proto (__pthread_mutex_trylock)
350extern int __pthread_mutex_lock (pthread_mutex_t *__mutex);
351libc_hidden_proto (__pthread_mutex_lock)
352extern int __pthread_mutex_timedlock (pthread_mutex_t *__mutex,
353 const struct timespec *__abstime);
354extern int __pthread_mutex_cond_lock (pthread_mutex_t *__mutex)
355 attribute_hidden;
356extern void __pthread_mutex_cond_lock_adjust (pthread_mutex_t *__mutex)
357 attribute_hidden;
358extern int __pthread_mutex_unlock (pthread_mutex_t *__mutex);
359libc_hidden_proto (__pthread_mutex_unlock)
360extern int __pthread_mutex_unlock_usercnt (pthread_mutex_t *__mutex,
361 int __decr);
362libc_hidden_proto (__pthread_mutex_unlock_usercnt)
363extern int __pthread_mutexattr_init (pthread_mutexattr_t *attr);
364libc_hidden_proto (__pthread_mutexattr_init)
365extern int __pthread_mutexattr_destroy (pthread_mutexattr_t *attr);
366extern int __pthread_mutexattr_settype (pthread_mutexattr_t *attr, int kind);
367libc_hidden_proto (__pthread_mutexattr_settype)
368extern int __pthread_attr_destroy (pthread_attr_t *attr);
369libc_hidden_proto (__pthread_attr_destroy)
370extern int __pthread_attr_getdetachstate (const pthread_attr_t *attr,
371 int *detachstate);
372extern int __pthread_attr_setdetachstate (pthread_attr_t *attr,
373 int detachstate);
374extern int __pthread_attr_getinheritsched (const pthread_attr_t *attr,
375 int *inherit);
376extern int __pthread_attr_setinheritsched (pthread_attr_t *attr, int inherit);
377extern int __pthread_attr_getschedparam (const pthread_attr_t *attr,
378 struct sched_param *param);
379extern int __pthread_attr_setschedparam (pthread_attr_t *attr,
380 const struct sched_param *param);
381extern int __pthread_attr_getschedpolicy (const pthread_attr_t *attr,
382 int *policy);
383extern int __pthread_attr_setschedpolicy (pthread_attr_t *attr, int policy);
384extern int __pthread_attr_getscope (const pthread_attr_t *attr, int *scope);
385extern int __pthread_attr_setscope (pthread_attr_t *attr, int scope);
386extern int __pthread_attr_getstackaddr (const pthread_attr_t *__restrict
387 __attr, void **__restrict __stackaddr);
388extern int __pthread_attr_setstackaddr (pthread_attr_t *__attr,
389 void *__stackaddr);
390extern int __pthread_attr_getstacksize (const pthread_attr_t *__restrict
391 __attr,
392 size_t *__restrict __stacksize);
393extern int __pthread_attr_setstacksize (pthread_attr_t *__attr,
394 size_t __stacksize);
395extern int __pthread_attr_getstack (const pthread_attr_t *__restrict __attr,
396 void **__restrict __stackaddr,
397 size_t *__restrict __stacksize);
398extern int __pthread_attr_setstack (pthread_attr_t *__attr, void *__stackaddr,
399 size_t __stacksize);
400int __pthread_attr_setaffinity_np (pthread_attr_t *, size_t, const cpu_set_t *);
401libc_hidden_proto (__pthread_attr_setaffinity_np)
402extern __typeof (pthread_getattr_default_np) __pthread_getattr_default_np;
403libc_hidden_proto (__pthread_getattr_default_np)
404extern int __pthread_rwlock_init (pthread_rwlock_t *__restrict __rwlock,
405 const pthread_rwlockattr_t *__restrict
406 __attr);
407extern int __pthread_rwlock_destroy (pthread_rwlock_t *__rwlock);
408extern int __pthread_rwlock_rdlock (pthread_rwlock_t *__rwlock);
409libc_hidden_proto (__pthread_rwlock_rdlock)
410extern int __pthread_rwlock_tryrdlock (pthread_rwlock_t *__rwlock);
411extern int __pthread_rwlock_wrlock (pthread_rwlock_t *__rwlock);
412libc_hidden_proto (__pthread_rwlock_wrlock)
413extern int __pthread_rwlock_trywrlock (pthread_rwlock_t *__rwlock);
414extern int __pthread_rwlock_unlock (pthread_rwlock_t *__rwlock);
415extern int __pthread_cond_broadcast (pthread_cond_t *cond);
416libc_hidden_proto (__pthread_cond_broadcast)
417extern int __pthread_cond_destroy (pthread_cond_t *cond);
418libc_hidden_proto (__pthread_cond_destroy)
419extern int __pthread_cond_init (pthread_cond_t *cond,
420 const pthread_condattr_t *cond_attr);
421libc_hidden_proto (__pthread_cond_init)
422extern int __pthread_cond_signal (pthread_cond_t *cond);
423libc_hidden_proto (__pthread_cond_signal)
424extern int __pthread_cond_wait (pthread_cond_t *cond, pthread_mutex_t *mutex);
425libc_hidden_proto (__pthread_cond_wait)
426
427#if __TIMESIZE == 64
428# define __pthread_clockjoin_np64 __pthread_clockjoin_np
429# define __pthread_timedjoin_np64 __pthread_timedjoin_np
430# define __pthread_cond_timedwait64 __pthread_cond_timedwait
431# define __pthread_cond_clockwait64 __pthread_cond_clockwait
432# define __pthread_rwlock_clockrdlock64 __pthread_rwlock_clockrdlock
433# define __pthread_rwlock_clockwrlock64 __pthread_rwlock_clockwrlock
434# define __pthread_rwlock_timedrdlock64 __pthread_rwlock_timedrdlock
435# define __pthread_rwlock_timedwrlock64 __pthread_rwlock_timedwrlock
436# define __pthread_mutex_clocklock64 __pthread_mutex_clocklock
437# define __pthread_mutex_timedlock64 __pthread_mutex_timedlock
438#else
439extern int __pthread_clockjoin_np64 (pthread_t threadid, void **thread_return,
440 clockid_t clockid,
441 const struct __timespec64 *abstime);
442libc_hidden_proto (__pthread_clockjoin_np64)
443extern int __pthread_timedjoin_np64 (pthread_t threadid, void **thread_return,
444 const struct __timespec64 *abstime);
445libc_hidden_proto (__pthread_timedjoin_np64)
446extern int __pthread_cond_timedwait64 (pthread_cond_t *cond,
447 pthread_mutex_t *mutex,
448 const struct __timespec64 *abstime);
449libc_hidden_proto (__pthread_cond_timedwait64)
450extern int __pthread_cond_clockwait64 (pthread_cond_t *cond,
451 pthread_mutex_t *mutex,
452 clockid_t clockid,
453 const struct __timespec64 *abstime);
454libc_hidden_proto (__pthread_cond_clockwait64)
455extern int __pthread_rwlock_clockrdlock64 (pthread_rwlock_t *rwlock,
456 clockid_t clockid,
457 const struct __timespec64 *abstime);
458libc_hidden_proto (__pthread_rwlock_clockrdlock64)
459extern int __pthread_rwlock_clockwrlock64 (pthread_rwlock_t *rwlock,
460 clockid_t clockid,
461 const struct __timespec64 *abstime);
462libc_hidden_proto (__pthread_rwlock_clockwrlock64)
463extern int __pthread_rwlock_timedrdlock64 (pthread_rwlock_t *rwlock,
464 const struct __timespec64 *abstime);
465libc_hidden_proto (__pthread_rwlock_timedrdlock64)
466extern int __pthread_rwlock_timedwrlock64 (pthread_rwlock_t *rwlock,
467 const struct __timespec64 *abstime);
468libc_hidden_proto (__pthread_rwlock_timedwrlock64)
469extern int __pthread_mutex_clocklock64 (pthread_mutex_t *mutex,
470 clockid_t clockid,
471 const struct __timespec64 *abstime);
472libc_hidden_proto (__pthread_mutex_clocklock64)
473extern int __pthread_mutex_timedlock64 (pthread_mutex_t *mutex,
474 const struct __timespec64 *abstime);
475libc_hidden_proto (__pthread_mutex_timedlock64)
476#endif
477
478extern int __pthread_cond_timedwait (pthread_cond_t *cond,
479 pthread_mutex_t *mutex,
480 const struct timespec *abstime);
481libc_hidden_proto (__pthread_cond_timedwait)
482extern int __pthread_cond_clockwait (pthread_cond_t *cond,
483 pthread_mutex_t *mutex,
484 clockid_t clockid,
485 const struct timespec *abstime)
486 __nonnull ((1, 2, 4));
487libc_hidden_proto (__pthread_cond_clockwait)
488
489extern int __pthread_mutex_clocklock (pthread_mutex_t *mutex,
490 clockid_t clockid,
491 const struct timespec *abstime);
492libc_hidden_proto (__pthread_mutex_clocklock)
493extern int __pthread_mutex_timedlock (pthread_mutex_t *mutex,
494 const struct timespec *abstime);
495libc_hidden_proto (__pthread_mutex_timedlock)
496
497extern int __pthread_condattr_destroy (pthread_condattr_t *attr);
498extern int __pthread_condattr_init (pthread_condattr_t *attr);
499extern int __pthread_key_create (pthread_key_t *key, void (*destr) (void *));
500libc_hidden_proto (__pthread_key_create)
501extern int __pthread_key_delete (pthread_key_t key);
502libc_hidden_proto (__pthread_key_delete)
503extern void *__pthread_getspecific (pthread_key_t key);
504libc_hidden_proto (__pthread_getspecific)
505extern int __pthread_setspecific (pthread_key_t key, const void *value);
506libc_hidden_proto (__pthread_setspecific)
507extern int __pthread_once (pthread_once_t *once_control,
508 void (*init_routine) (void));
509libc_hidden_proto (__pthread_once)
510extern int __pthread_atfork (void (*prepare) (void), void (*parent) (void),
511 void (*child) (void));
512libc_hidden_proto (__pthread_self)
513extern int __pthread_equal (pthread_t thread1, pthread_t thread2);
514extern int __pthread_detach (pthread_t th);
515libc_hidden_proto (__pthread_detach)
516extern int __pthread_kill (pthread_t threadid, int signo);
517libc_hidden_proto (__pthread_kill)
518extern int __pthread_cancel (pthread_t th);
519extern int __pthread_kill_internal (pthread_t threadid, int signo)
520 attribute_hidden;
521extern void __pthread_exit (void *value) __attribute__ ((__noreturn__));
522libc_hidden_proto (__pthread_exit)
523extern int __pthread_join (pthread_t threadid, void **thread_return);
524libc_hidden_proto (__pthread_join)
525extern int __pthread_setcanceltype (int type, int *oldtype);
526libc_hidden_proto (__pthread_setcanceltype)
527extern void __pthread_testcancel (void);
528libc_hidden_proto (__pthread_testcancel)
529extern int __pthread_clockjoin_ex (pthread_t, void **, clockid_t,
530 const struct __timespec64 *, bool)
531 attribute_hidden;
532extern int __pthread_sigmask (int, const sigset_t *, sigset_t *);
533libc_hidden_proto (__pthread_sigmask);
534
535
536#if IS_IN (libpthread)
537hidden_proto (__pthread_rwlock_unlock)
538#endif
539
540extern int __pthread_cond_broadcast_2_0 (pthread_cond_2_0_t *cond);
541extern int __pthread_cond_destroy_2_0 (pthread_cond_2_0_t *cond);
542extern int __pthread_cond_init_2_0 (pthread_cond_2_0_t *cond,
543 const pthread_condattr_t *cond_attr);
544extern int __pthread_cond_signal_2_0 (pthread_cond_2_0_t *cond);
545extern int __pthread_cond_timedwait_2_0 (pthread_cond_2_0_t *cond,
546 pthread_mutex_t *mutex,
547 const struct timespec *abstime);
548extern int __pthread_cond_wait_2_0 (pthread_cond_2_0_t *cond,
549 pthread_mutex_t *mutex);
550
551extern int __pthread_getaffinity_np (pthread_t th, size_t cpusetsize,
552 cpu_set_t *cpuset);
553libc_hidden_proto (__pthread_getaffinity_np)
554
555/* Special internal version of pthread_attr_setsigmask_np which does
556 not filter out internal signals from *SIGMASK. This can be used to
557 launch threads with internal signals blocked. */
558 extern int __pthread_attr_setsigmask_internal (pthread_attr_t *attr,
559 const sigset_t *sigmask);
560libc_hidden_proto (__pthread_attr_setsigmask_internal)
561
562extern __typeof (pthread_attr_getsigmask_np) __pthread_attr_getsigmask_np;
563libc_hidden_proto (__pthread_attr_getsigmask_np)
564
565/* Special versions which use non-exported functions. */
566extern void __pthread_cleanup_push (struct _pthread_cleanup_buffer *buffer,
567 void (*routine) (void *), void *arg);
568libc_hidden_proto (__pthread_cleanup_push)
569
570/* Replace cleanup macros defined in <pthread.h> with internal
571 versions that don't depend on unwind info and better support
572 cancellation. */
573# undef pthread_cleanup_push
574# define pthread_cleanup_push(routine,arg) \
575 { struct _pthread_cleanup_buffer _buffer; \
576 __pthread_cleanup_push (&_buffer, (routine), (arg));
577
578extern void __pthread_cleanup_pop (struct _pthread_cleanup_buffer *buffer,
579 int execute);
580libc_hidden_proto (__pthread_cleanup_pop)
581# undef pthread_cleanup_pop
582# define pthread_cleanup_pop(execute) \
583 __pthread_cleanup_pop (&_buffer, (execute)); }
584
585#if defined __EXCEPTIONS && !defined __cplusplus
586/* Structure to hold the cleanup handler information. */
587struct __pthread_cleanup_combined_frame
588{
589 void (*__cancel_routine) (void *);
590 void *__cancel_arg;
591 int __do_it;
592 struct _pthread_cleanup_buffer __buffer;
593};
594
595/* Special cleanup macros which register cleanup both using
596 __pthread_cleanup_{push,pop} and using cleanup attribute. This is needed
597 for pthread_once, so that it supports both throwing exceptions from the
598 pthread_once callback (only cleanup attribute works there) and cancellation
599 of the thread running the callback if the callback or some routines it
600 calls don't have unwind information. */
601
602static __always_inline void
603__pthread_cleanup_combined_routine (struct __pthread_cleanup_combined_frame
604 *__frame)
605{
606 if (__frame->__do_it)
607 {
608 __frame->__cancel_routine (__frame->__cancel_arg);
609 __frame->__do_it = 0;
610 __pthread_cleanup_pop (&__frame->__buffer, 0);
611 }
612}
613
614static inline void
615__pthread_cleanup_combined_routine_voidptr (void *__arg)
616{
617 struct __pthread_cleanup_combined_frame *__frame
618 = (struct __pthread_cleanup_combined_frame *) __arg;
619 if (__frame->__do_it)
620 {
621 __frame->__cancel_routine (__frame->__cancel_arg);
622 __frame->__do_it = 0;
623 }
624}
625
626# define pthread_cleanup_combined_push(routine, arg) \
627 do { \
628 void (*__cancel_routine) (void *) = (routine); \
629 struct __pthread_cleanup_combined_frame __clframe \
630 __attribute__ ((__cleanup__ (__pthread_cleanup_combined_routine))) \
631 = { .__cancel_routine = __cancel_routine, .__cancel_arg = (arg), \
632 .__do_it = 1 }; \
633 __pthread_cleanup_push (&__clframe.__buffer, \
634 __pthread_cleanup_combined_routine_voidptr, \
635 &__clframe);
636
637# define pthread_cleanup_combined_pop(execute) \
638 __pthread_cleanup_pop (&__clframe.__buffer, 0); \
639 __clframe.__do_it = 0; \
640 if (execute) \
641 __cancel_routine (__clframe.__cancel_arg); \
642 } while (0)
643
644#endif /* __EXCEPTIONS && !defined __cplusplus */
645
646extern void __pthread_cleanup_push_defer (struct _pthread_cleanup_buffer *buffer,
647 void (*routine) (void *), void *arg);
648extern void __pthread_cleanup_pop_restore (struct _pthread_cleanup_buffer *buffer,
649 int execute);
650
651/* Old cleanup interfaces, still used in libc.so. */
652extern void _pthread_cleanup_push (struct _pthread_cleanup_buffer *buffer,
653 void (*routine) (void *), void *arg);
654extern void _pthread_cleanup_pop (struct _pthread_cleanup_buffer *buffer,
655 int execute);
656extern void _pthread_cleanup_push_defer (struct _pthread_cleanup_buffer *buffer,
657 void (*routine) (void *), void *arg);
658extern void _pthread_cleanup_pop_restore (struct _pthread_cleanup_buffer *buffer,
659 int execute);
660
661extern void __nptl_deallocate_tsd (void);
662libc_hidden_proto (__nptl_deallocate_tsd)
663
664void __nptl_setxid_sighandler (int sig, siginfo_t *si, void *ctx);
665libc_hidden_proto (__nptl_setxid_sighandler)
666extern int __nptl_setxid (struct xid_command *cmdp) attribute_hidden;
667
668extern void __wait_lookup_done (void) attribute_hidden;
669
670/* Allocates the extension space for ATTR. Returns an error code on
671 memory allocation failure, zero on success. If ATTR already has an
672 extension space, this function does nothing. */
673int __pthread_attr_extension (struct pthread_attr *attr) attribute_hidden
674 __attribute_warn_unused_result__;
675
676#ifdef SHARED
677# define PTHREAD_STATIC_FN_REQUIRE(name)
678#else
679# define PTHREAD_STATIC_FN_REQUIRE(name) __asm (".globl " #name);
680#endif
681
682/* Make a deep copy of the attribute *SOURCE in *TARGET. *TARGET is
683 not assumed to have been initialized. Returns 0 on success, or a
684 positive error code otherwise. */
685int __pthread_attr_copy (pthread_attr_t *target, const pthread_attr_t *source);
686libc_hidden_proto (__pthread_attr_copy)
687
688/* Returns 0 if POL is a valid scheduling policy. */
689static inline int
690check_sched_policy_attr (int pol)
691{
692 if (pol == SCHED_OTHER || pol == SCHED_FIFO || pol == SCHED_RR)
693 return 0;
694
695 return EINVAL;
696}
697
698/* Returns 0 if PR is within the accepted range of priority values for
699 the scheduling policy POL or EINVAL otherwise. */
700static inline int
701check_sched_priority_attr (int pr, int pol)
702{
703 int min = __sched_get_priority_min (pol);
704 int max = __sched_get_priority_max (pol);
705
706 if (min >= 0 && max >= 0 && pr >= min && pr <= max)
707 return 0;
708
709 return EINVAL;
710}
711
712/* Returns 0 if ST is a valid stack size for a thread stack and EINVAL
713 otherwise. */
714static inline int
715check_stacksize_attr (size_t st)
716{
717 if (st >= PTHREAD_STACK_MIN)
718 return 0;
719
720 return EINVAL;
721}
722
723#define ASSERT_TYPE_SIZE(type, size) \
724 _Static_assert (sizeof (type) == size, \
725 "sizeof (" #type ") != " #size)
726
727#define ASSERT_PTHREAD_INTERNAL_SIZE(type, internal) \
728 _Static_assert (sizeof ((type) { { 0 } }).__size >= sizeof (internal),\
729 "sizeof (" #type ".__size) < sizeof (" #internal ")")
730
731#define ASSERT_PTHREAD_STRING(x) __STRING (x)
732#define ASSERT_PTHREAD_INTERNAL_OFFSET(type, member, offset) \
733 _Static_assert (offsetof (type, member) == offset, \
734 "offset of " #member " field of " #type " != " \
735 ASSERT_PTHREAD_STRING (offset))
736#define ASSERT_PTHREAD_INTERNAL_MEMBER_SIZE(type, member, mtype) \
737 _Static_assert (sizeof (((type) { 0 }).member) != 8, \
738 "sizeof (" #type "." #member ") != sizeof (" #mtype "))")
739
740#endif /* pthreadP.h */
741