Document use of CC and CFLAGS in more detail (bug 20980, bug 21234).
[glibc.git] / nptl / pthreadP.h
blob583515ff4896afd7b91b68986f2d1ebe6851f3b9
1 /* Copyright (C) 2002-2018 Free Software Foundation, Inc.
2 This file is part of the GNU C Library.
3 Contributed by Ulrich Drepper <drepper@redhat.com>, 2002.
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.
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.
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 <http://www.gnu.org/licenses/>. */
19 #ifndef _PTHREADP_H
20 #define _PTHREADP_H 1
22 #include <pthread.h>
23 #include <setjmp.h>
24 #include <stdbool.h>
25 #include <sys/syscall.h>
26 #include "descr.h"
27 #include <tls.h>
28 #include <lowlevellock.h>
29 #include <stackinfo.h>
30 #include <internaltypes.h>
31 #include <pthread-functions.h>
32 #include <atomic.h>
33 #include <kernel-features.h>
34 #include <errno.h>
35 #include <nptl-signals.h>
38 /* Atomic operations on TLS memory. */
39 #ifndef THREAD_ATOMIC_CMPXCHG_VAL
40 # define THREAD_ATOMIC_CMPXCHG_VAL(descr, member, new, old) \
41 atomic_compare_and_exchange_val_acq (&(descr)->member, new, old)
42 #endif
44 #ifndef THREAD_ATOMIC_BIT_SET
45 # define THREAD_ATOMIC_BIT_SET(descr, member, bit) \
46 atomic_bit_set (&(descr)->member, bit)
47 #endif
50 /* Adaptive mutex definitions. */
51 #ifndef MAX_ADAPTIVE_COUNT
52 # define MAX_ADAPTIVE_COUNT 100
53 #endif
56 /* Magic cookie representing robust mutex with dead owner. */
57 #define PTHREAD_MUTEX_INCONSISTENT INT_MAX
58 /* Magic cookie representing not recoverable robust mutex. */
59 #define PTHREAD_MUTEX_NOTRECOVERABLE (INT_MAX - 1)
62 /* Internal mutex type value. */
63 enum
65 PTHREAD_MUTEX_KIND_MASK_NP = 3,
67 PTHREAD_MUTEX_ELISION_NP = 256,
68 PTHREAD_MUTEX_NO_ELISION_NP = 512,
70 PTHREAD_MUTEX_ROBUST_NORMAL_NP = 16,
71 PTHREAD_MUTEX_ROBUST_RECURSIVE_NP
72 = PTHREAD_MUTEX_ROBUST_NORMAL_NP | PTHREAD_MUTEX_RECURSIVE_NP,
73 PTHREAD_MUTEX_ROBUST_ERRORCHECK_NP
74 = PTHREAD_MUTEX_ROBUST_NORMAL_NP | PTHREAD_MUTEX_ERRORCHECK_NP,
75 PTHREAD_MUTEX_ROBUST_ADAPTIVE_NP
76 = PTHREAD_MUTEX_ROBUST_NORMAL_NP | PTHREAD_MUTEX_ADAPTIVE_NP,
77 PTHREAD_MUTEX_PRIO_INHERIT_NP = 32,
78 PTHREAD_MUTEX_PI_NORMAL_NP
79 = PTHREAD_MUTEX_PRIO_INHERIT_NP | PTHREAD_MUTEX_NORMAL,
80 PTHREAD_MUTEX_PI_RECURSIVE_NP
81 = PTHREAD_MUTEX_PRIO_INHERIT_NP | PTHREAD_MUTEX_RECURSIVE_NP,
82 PTHREAD_MUTEX_PI_ERRORCHECK_NP
83 = PTHREAD_MUTEX_PRIO_INHERIT_NP | PTHREAD_MUTEX_ERRORCHECK_NP,
84 PTHREAD_MUTEX_PI_ADAPTIVE_NP
85 = PTHREAD_MUTEX_PRIO_INHERIT_NP | PTHREAD_MUTEX_ADAPTIVE_NP,
86 PTHREAD_MUTEX_PI_ROBUST_NORMAL_NP
87 = PTHREAD_MUTEX_PRIO_INHERIT_NP | PTHREAD_MUTEX_ROBUST_NORMAL_NP,
88 PTHREAD_MUTEX_PI_ROBUST_RECURSIVE_NP
89 = PTHREAD_MUTEX_PRIO_INHERIT_NP | PTHREAD_MUTEX_ROBUST_RECURSIVE_NP,
90 PTHREAD_MUTEX_PI_ROBUST_ERRORCHECK_NP
91 = PTHREAD_MUTEX_PRIO_INHERIT_NP | PTHREAD_MUTEX_ROBUST_ERRORCHECK_NP,
92 PTHREAD_MUTEX_PI_ROBUST_ADAPTIVE_NP
93 = PTHREAD_MUTEX_PRIO_INHERIT_NP | PTHREAD_MUTEX_ROBUST_ADAPTIVE_NP,
94 PTHREAD_MUTEX_PRIO_PROTECT_NP = 64,
95 PTHREAD_MUTEX_PP_NORMAL_NP
96 = PTHREAD_MUTEX_PRIO_PROTECT_NP | PTHREAD_MUTEX_NORMAL,
97 PTHREAD_MUTEX_PP_RECURSIVE_NP
98 = PTHREAD_MUTEX_PRIO_PROTECT_NP | PTHREAD_MUTEX_RECURSIVE_NP,
99 PTHREAD_MUTEX_PP_ERRORCHECK_NP
100 = PTHREAD_MUTEX_PRIO_PROTECT_NP | PTHREAD_MUTEX_ERRORCHECK_NP,
101 PTHREAD_MUTEX_PP_ADAPTIVE_NP
102 = PTHREAD_MUTEX_PRIO_PROTECT_NP | PTHREAD_MUTEX_ADAPTIVE_NP,
103 PTHREAD_MUTEX_ELISION_FLAGS_NP
104 = PTHREAD_MUTEX_ELISION_NP | PTHREAD_MUTEX_NO_ELISION_NP,
106 PTHREAD_MUTEX_TIMED_ELISION_NP =
107 PTHREAD_MUTEX_TIMED_NP | PTHREAD_MUTEX_ELISION_NP,
108 PTHREAD_MUTEX_TIMED_NO_ELISION_NP =
109 PTHREAD_MUTEX_TIMED_NP | PTHREAD_MUTEX_NO_ELISION_NP,
111 #define PTHREAD_MUTEX_PSHARED_BIT 128
113 #define PTHREAD_MUTEX_TYPE(m) \
114 ((m)->__data.__kind & 127)
115 /* Don't include NO_ELISION, as that type is always the same
116 as the underlying lock type. */
117 #define PTHREAD_MUTEX_TYPE_ELISION(m) \
118 ((m)->__data.__kind & (127|PTHREAD_MUTEX_ELISION_NP))
120 #if LLL_PRIVATE == 0 && LLL_SHARED == 128
121 # define PTHREAD_MUTEX_PSHARED(m) \
122 ((m)->__data.__kind & 128)
123 #else
124 # define PTHREAD_MUTEX_PSHARED(m) \
125 (((m)->__data.__kind & 128) ? LLL_SHARED : LLL_PRIVATE)
126 #endif
128 /* The kernel when waking robust mutexes on exit never uses
129 FUTEX_PRIVATE_FLAG FUTEX_WAKE. */
130 #define PTHREAD_ROBUST_MUTEX_PSHARED(m) LLL_SHARED
132 /* Ceiling in __data.__lock. __data.__lock is signed, so don't
133 use the MSB bit in there, but in the mask also include that bit,
134 so that the compiler can optimize & PTHREAD_MUTEX_PRIO_CEILING_MASK
135 masking if the value is then shifted down by
136 PTHREAD_MUTEX_PRIO_CEILING_SHIFT. */
137 #define PTHREAD_MUTEX_PRIO_CEILING_SHIFT 19
138 #define PTHREAD_MUTEX_PRIO_CEILING_MASK 0xfff80000
141 /* Flags in mutex attr. */
142 #define PTHREAD_MUTEXATTR_PROTOCOL_SHIFT 28
143 #define PTHREAD_MUTEXATTR_PROTOCOL_MASK 0x30000000
144 #define PTHREAD_MUTEXATTR_PRIO_CEILING_SHIFT 12
145 #define PTHREAD_MUTEXATTR_PRIO_CEILING_MASK 0x00fff000
146 #define PTHREAD_MUTEXATTR_FLAG_ROBUST 0x40000000
147 #define PTHREAD_MUTEXATTR_FLAG_PSHARED 0x80000000
148 #define PTHREAD_MUTEXATTR_FLAG_BITS \
149 (PTHREAD_MUTEXATTR_FLAG_ROBUST | PTHREAD_MUTEXATTR_FLAG_PSHARED \
150 | PTHREAD_MUTEXATTR_PROTOCOL_MASK | PTHREAD_MUTEXATTR_PRIO_CEILING_MASK)
153 /* For the following, see pthread_rwlock_common.c. */
154 #define PTHREAD_RWLOCK_WRPHASE 1
155 #define PTHREAD_RWLOCK_WRLOCKED 2
156 #define PTHREAD_RWLOCK_RWAITING 4
157 #define PTHREAD_RWLOCK_READER_SHIFT 3
158 #define PTHREAD_RWLOCK_READER_OVERFLOW ((unsigned int) 1 \
159 << (sizeof (unsigned int) * 8 - 1))
160 #define PTHREAD_RWLOCK_WRHANDOVER ((unsigned int) 1 \
161 << (sizeof (unsigned int) * 8 - 1))
162 #define PTHREAD_RWLOCK_FUTEX_USED 2
165 /* Bits used in robust mutex implementation. */
166 #define FUTEX_WAITERS 0x80000000
167 #define FUTEX_OWNER_DIED 0x40000000
168 #define FUTEX_TID_MASK 0x3fffffff
171 /* pthread_once definitions. See __pthread_once for how these are used. */
172 #define __PTHREAD_ONCE_INPROGRESS 1
173 #define __PTHREAD_ONCE_DONE 2
174 #define __PTHREAD_ONCE_FORK_GEN_INCR 4
177 /* Condition variable definitions. See __pthread_cond_wait_common.
178 Need to be defined here so there is one place from which
179 nptl_lock_constants can grab them. */
180 #define __PTHREAD_COND_CLOCK_MONOTONIC_MASK 2
181 #define __PTHREAD_COND_SHARED_MASK 1
184 /* Internal variables. */
187 /* Default pthread attributes. */
188 extern struct pthread_attr __default_pthread_attr attribute_hidden;
189 extern int __default_pthread_attr_lock attribute_hidden;
191 /* Size and alignment of static TLS block. */
192 extern size_t __static_tls_size attribute_hidden;
193 extern size_t __static_tls_align_m1 attribute_hidden;
195 /* Flag whether the machine is SMP or not. */
196 extern int __is_smp attribute_hidden;
198 /* Thread descriptor handling. */
199 extern list_t __stack_user;
200 hidden_proto (__stack_user)
202 /* Attribute handling. */
203 extern struct pthread_attr *__attr_list attribute_hidden;
204 extern int __attr_list_lock attribute_hidden;
206 /* Concurrency handling. */
207 extern int __concurrency_level attribute_hidden;
209 /* Thread-local data key handling. */
210 extern struct pthread_key_struct __pthread_keys[PTHREAD_KEYS_MAX];
211 hidden_proto (__pthread_keys)
213 /* Number of threads running. */
214 extern unsigned int __nptl_nthreads attribute_hidden;
216 #ifndef __ASSUME_SET_ROBUST_LIST
217 /* Negative if we do not have the system call and we can use it. */
218 extern int __set_robust_list_avail attribute_hidden;
219 #endif
221 /* Thread Priority Protection. */
222 extern int __sched_fifo_min_prio attribute_hidden;
223 extern int __sched_fifo_max_prio attribute_hidden;
224 extern void __init_sched_fifo_prio (void) attribute_hidden;
225 extern int __pthread_tpp_change_priority (int prev_prio, int new_prio)
226 attribute_hidden;
227 extern int __pthread_current_priority (void) attribute_hidden;
229 /* The library can run in debugging mode where it performs a lot more
230 tests. */
231 extern int __pthread_debug attribute_hidden;
232 /** For now disable debugging support. */
233 #if 0
234 # define DEBUGGING_P __builtin_expect (__pthread_debug, 0)
235 # define INVALID_TD_P(pd) (DEBUGGING_P && __find_in_stack_list (pd) == NULL)
236 # define INVALID_NOT_TERMINATED_TD_P(pd) INVALID_TD_P (pd)
237 #else
238 # define DEBUGGING_P 0
239 /* Simplified test. This will not catch all invalid descriptors but
240 is better than nothing. And if the test triggers the thread
241 descriptor is guaranteed to be invalid. */
242 # define INVALID_TD_P(pd) __builtin_expect ((pd)->tid <= 0, 0)
243 # define INVALID_NOT_TERMINATED_TD_P(pd) __builtin_expect ((pd)->tid < 0, 0)
244 #endif
247 /* Cancellation test. */
248 #define CANCELLATION_P(self) \
249 do { \
250 int cancelhandling = THREAD_GETMEM (self, cancelhandling); \
251 if (CANCEL_ENABLED_AND_CANCELED (cancelhandling)) \
253 THREAD_SETMEM (self, result, PTHREAD_CANCELED); \
254 __do_cancel (); \
256 } while (0)
259 extern void __pthread_unwind (__pthread_unwind_buf_t *__buf)
260 __cleanup_fct_attribute __attribute ((__noreturn__))
261 #if !defined SHARED && !IS_IN (libpthread)
262 weak_function
263 #endif
265 extern void __pthread_unwind_next (__pthread_unwind_buf_t *__buf)
266 __cleanup_fct_attribute __attribute ((__noreturn__))
267 #ifndef SHARED
268 weak_function
269 #endif
271 extern void __pthread_register_cancel (__pthread_unwind_buf_t *__buf)
272 __cleanup_fct_attribute;
273 extern void __pthread_unregister_cancel (__pthread_unwind_buf_t *__buf)
274 __cleanup_fct_attribute;
275 #if IS_IN (libpthread)
276 hidden_proto (__pthread_unwind)
277 hidden_proto (__pthread_unwind_next)
278 hidden_proto (__pthread_register_cancel)
279 hidden_proto (__pthread_unregister_cancel)
280 # ifdef SHARED
281 extern void attribute_hidden pthread_cancel_init (void);
282 extern void __unwind_freeres (void);
283 # endif
284 #endif
287 /* Called when a thread reacts on a cancellation request. */
288 static inline void
289 __attribute ((noreturn, always_inline))
290 __do_cancel (void)
292 struct pthread *self = THREAD_SELF;
294 /* Make sure we get no more cancellations. */
295 THREAD_ATOMIC_BIT_SET (self, cancelhandling, EXITING_BIT);
297 __pthread_unwind ((__pthread_unwind_buf_t *)
298 THREAD_GETMEM (self, cleanup_jmp_buf));
302 /* Set cancellation mode to asynchronous. */
303 #define CANCEL_ASYNC() \
304 __pthread_enable_asynccancel ()
305 /* Reset to previous cancellation mode. */
306 #define CANCEL_RESET(oldtype) \
307 __pthread_disable_asynccancel (oldtype)
309 #if IS_IN (libc)
310 /* Same as CANCEL_ASYNC, but for use in libc.so. */
311 # define LIBC_CANCEL_ASYNC() \
312 __libc_enable_asynccancel ()
313 /* Same as CANCEL_RESET, but for use in libc.so. */
314 # define LIBC_CANCEL_RESET(oldtype) \
315 __libc_disable_asynccancel (oldtype)
316 # define LIBC_CANCEL_HANDLED() \
317 __asm (".globl " __SYMBOL_PREFIX "__libc_enable_asynccancel"); \
318 __asm (".globl " __SYMBOL_PREFIX "__libc_disable_asynccancel")
319 #elif IS_IN (libpthread)
320 # define LIBC_CANCEL_ASYNC() CANCEL_ASYNC ()
321 # define LIBC_CANCEL_RESET(val) CANCEL_RESET (val)
322 # define LIBC_CANCEL_HANDLED() \
323 __asm (".globl " __SYMBOL_PREFIX "__pthread_enable_asynccancel"); \
324 __asm (".globl " __SYMBOL_PREFIX "__pthread_disable_asynccancel")
325 #elif IS_IN (librt)
326 # define LIBC_CANCEL_ASYNC() \
327 __librt_enable_asynccancel ()
328 # define LIBC_CANCEL_RESET(val) \
329 __librt_disable_asynccancel (val)
330 # define LIBC_CANCEL_HANDLED() \
331 __asm (".globl " __SYMBOL_PREFIX "__librt_enable_asynccancel"); \
332 __asm (".globl " __SYMBOL_PREFIX "__librt_disable_asynccancel")
333 #else
334 # define LIBC_CANCEL_ASYNC() 0 /* Just a dummy value. */
335 # define LIBC_CANCEL_RESET(val) ((void)(val)) /* Nothing, but evaluate it. */
336 # define LIBC_CANCEL_HANDLED() /* Nothing. */
337 #endif
340 /* Internal prototypes. */
342 /* Thread list handling. */
343 extern struct pthread *__find_in_stack_list (struct pthread *pd)
344 attribute_hidden;
346 /* Deallocate a thread's stack after optionally making sure the thread
347 descriptor is still valid. */
348 extern void __free_tcb (struct pthread *pd) attribute_hidden;
350 /* Free allocated stack. */
351 extern void __deallocate_stack (struct pthread *pd) attribute_hidden;
353 /* Mark all the stacks except for the current one as available. This
354 function also re-initializes the lock for the stack cache. */
355 extern void __reclaim_stacks (void) attribute_hidden;
357 /* Make all threads's stacks executable. */
358 extern int __make_stacks_executable (void **stack_endp) attribute_hidden;
360 /* longjmp handling. */
361 extern void __pthread_cleanup_upto (__jmp_buf target, char *targetframe);
362 #if IS_IN (libpthread)
363 hidden_proto (__pthread_cleanup_upto)
364 #endif
367 /* Functions with versioned interfaces. */
368 extern int __pthread_create_2_1 (pthread_t *newthread,
369 const pthread_attr_t *attr,
370 void *(*start_routine) (void *), void *arg);
371 extern int __pthread_create_2_0 (pthread_t *newthread,
372 const pthread_attr_t *attr,
373 void *(*start_routine) (void *), void *arg);
374 extern int __pthread_attr_init_2_1 (pthread_attr_t *attr);
375 extern int __pthread_attr_init_2_0 (pthread_attr_t *attr);
378 /* Event handlers for libthread_db interface. */
379 extern void __nptl_create_event (void);
380 extern void __nptl_death_event (void);
381 hidden_proto (__nptl_create_event)
382 hidden_proto (__nptl_death_event)
384 /* Register the generation counter in the libpthread with the libc. */
385 #ifdef TLS_MULTIPLE_THREADS_IN_TCB
386 extern void __libc_pthread_init (unsigned long int *ptr,
387 void (*reclaim) (void),
388 const struct pthread_functions *functions);
389 #else
390 extern int *__libc_pthread_init (unsigned long int *ptr,
391 void (*reclaim) (void),
392 const struct pthread_functions *functions);
394 /* Variable set to a nonzero value either if more than one thread runs or ran,
395 or if a single-threaded process is trying to cancel itself. See
396 nptl/descr.h for more context on the single-threaded process case. */
397 extern int __pthread_multiple_threads attribute_hidden;
398 /* Pointer to the corresponding variable in libc. */
399 extern int *__libc_multiple_threads_ptr attribute_hidden;
400 #endif
402 /* Find a thread given its TID. */
403 extern struct pthread *__find_thread_by_id (pid_t tid) attribute_hidden
404 #ifdef SHARED
406 #else
407 weak_function;
408 #define __find_thread_by_id(tid) \
409 (__find_thread_by_id ? (__find_thread_by_id) (tid) : (struct pthread *) NULL)
410 #endif
412 extern void __pthread_init_static_tls (struct link_map *) attribute_hidden;
414 extern size_t __pthread_get_minstack (const pthread_attr_t *attr);
416 /* Namespace save aliases. */
417 extern int __pthread_getschedparam (pthread_t thread_id, int *policy,
418 struct sched_param *param);
419 extern int __pthread_setschedparam (pthread_t thread_id, int policy,
420 const struct sched_param *param);
421 extern int __pthread_setcancelstate (int state, int *oldstate);
422 extern int __pthread_mutex_init (pthread_mutex_t *__mutex,
423 const pthread_mutexattr_t *__mutexattr);
424 extern int __pthread_mutex_destroy (pthread_mutex_t *__mutex);
425 extern int __pthread_mutex_trylock (pthread_mutex_t *_mutex);
426 extern int __pthread_mutex_lock (pthread_mutex_t *__mutex);
427 extern int __pthread_mutex_timedlock (pthread_mutex_t *__mutex,
428 const struct timespec *__abstime);
429 extern int __pthread_mutex_cond_lock (pthread_mutex_t *__mutex)
430 attribute_hidden;
431 extern void __pthread_mutex_cond_lock_adjust (pthread_mutex_t *__mutex)
432 attribute_hidden;
433 extern int __pthread_mutex_unlock (pthread_mutex_t *__mutex);
434 extern int __pthread_mutex_unlock_usercnt (pthread_mutex_t *__mutex,
435 int __decr) attribute_hidden;
436 extern int __pthread_mutexattr_init (pthread_mutexattr_t *attr);
437 extern int __pthread_mutexattr_destroy (pthread_mutexattr_t *attr);
438 extern int __pthread_mutexattr_settype (pthread_mutexattr_t *attr, int kind);
439 extern int __pthread_attr_destroy (pthread_attr_t *attr);
440 extern int __pthread_attr_getdetachstate (const pthread_attr_t *attr,
441 int *detachstate);
442 extern int __pthread_attr_setdetachstate (pthread_attr_t *attr,
443 int detachstate);
444 extern int __pthread_attr_getinheritsched (const pthread_attr_t *attr,
445 int *inherit);
446 extern int __pthread_attr_setinheritsched (pthread_attr_t *attr, int inherit);
447 extern int __pthread_attr_getschedparam (const pthread_attr_t *attr,
448 struct sched_param *param);
449 extern int __pthread_attr_setschedparam (pthread_attr_t *attr,
450 const struct sched_param *param);
451 extern int __pthread_attr_getschedpolicy (const pthread_attr_t *attr,
452 int *policy);
453 extern int __pthread_attr_setschedpolicy (pthread_attr_t *attr, int policy);
454 extern int __pthread_attr_getscope (const pthread_attr_t *attr, int *scope);
455 extern int __pthread_attr_setscope (pthread_attr_t *attr, int scope);
456 extern int __pthread_attr_getstackaddr (const pthread_attr_t *__restrict
457 __attr, void **__restrict __stackaddr);
458 extern int __pthread_attr_setstackaddr (pthread_attr_t *__attr,
459 void *__stackaddr);
460 extern int __pthread_attr_getstacksize (const pthread_attr_t *__restrict
461 __attr,
462 size_t *__restrict __stacksize);
463 extern int __pthread_attr_setstacksize (pthread_attr_t *__attr,
464 size_t __stacksize);
465 extern int __pthread_attr_getstack (const pthread_attr_t *__restrict __attr,
466 void **__restrict __stackaddr,
467 size_t *__restrict __stacksize);
468 extern int __pthread_attr_setstack (pthread_attr_t *__attr, void *__stackaddr,
469 size_t __stacksize);
470 extern int __pthread_rwlock_init (pthread_rwlock_t *__restrict __rwlock,
471 const pthread_rwlockattr_t *__restrict
472 __attr);
473 extern int __pthread_rwlock_destroy (pthread_rwlock_t *__rwlock);
474 extern int __pthread_rwlock_rdlock (pthread_rwlock_t *__rwlock);
475 extern int __pthread_rwlock_tryrdlock (pthread_rwlock_t *__rwlock);
476 extern int __pthread_rwlock_wrlock (pthread_rwlock_t *__rwlock);
477 extern int __pthread_rwlock_trywrlock (pthread_rwlock_t *__rwlock);
478 extern int __pthread_rwlock_unlock (pthread_rwlock_t *__rwlock);
479 extern int __pthread_cond_broadcast (pthread_cond_t *cond);
480 extern int __pthread_cond_destroy (pthread_cond_t *cond);
481 extern int __pthread_cond_init (pthread_cond_t *cond,
482 const pthread_condattr_t *cond_attr);
483 extern int __pthread_cond_signal (pthread_cond_t *cond);
484 extern int __pthread_cond_wait (pthread_cond_t *cond, pthread_mutex_t *mutex);
485 extern int __pthread_cond_timedwait (pthread_cond_t *cond,
486 pthread_mutex_t *mutex,
487 const struct timespec *abstime);
488 extern int __pthread_condattr_destroy (pthread_condattr_t *attr);
489 extern int __pthread_condattr_init (pthread_condattr_t *attr);
490 extern int __pthread_key_create (pthread_key_t *key, void (*destr) (void *));
491 extern int __pthread_key_delete (pthread_key_t key);
492 extern void *__pthread_getspecific (pthread_key_t key);
493 extern int __pthread_setspecific (pthread_key_t key, const void *value);
494 extern int __pthread_once (pthread_once_t *once_control,
495 void (*init_routine) (void));
496 extern int __pthread_atfork (void (*prepare) (void), void (*parent) (void),
497 void (*child) (void));
498 extern pthread_t __pthread_self (void);
499 extern int __pthread_equal (pthread_t thread1, pthread_t thread2);
500 extern int __pthread_detach (pthread_t th);
501 extern int __pthread_cancel (pthread_t th);
502 extern int __pthread_kill (pthread_t threadid, int signo);
503 extern void __pthread_exit (void *value) __attribute__ ((__noreturn__));
504 extern int __pthread_join (pthread_t threadid, void **thread_return);
505 extern int __pthread_setcanceltype (int type, int *oldtype);
506 extern int __pthread_enable_asynccancel (void) attribute_hidden;
507 extern void __pthread_disable_asynccancel (int oldtype) attribute_hidden;
508 extern void __pthread_testcancel (void);
509 extern int __pthread_timedjoin_ex (pthread_t, void **, const struct timespec *,
510 bool);
512 #if IS_IN (libpthread)
513 hidden_proto (__pthread_mutex_init)
514 hidden_proto (__pthread_mutex_destroy)
515 hidden_proto (__pthread_mutex_lock)
516 hidden_proto (__pthread_mutex_trylock)
517 hidden_proto (__pthread_mutex_unlock)
518 hidden_proto (__pthread_rwlock_rdlock)
519 hidden_proto (__pthread_rwlock_wrlock)
520 hidden_proto (__pthread_rwlock_unlock)
521 hidden_proto (__pthread_key_create)
522 hidden_proto (__pthread_getspecific)
523 hidden_proto (__pthread_setspecific)
524 hidden_proto (__pthread_once)
525 hidden_proto (__pthread_setcancelstate)
526 hidden_proto (__pthread_testcancel)
527 hidden_proto (__pthread_mutexattr_init)
528 hidden_proto (__pthread_mutexattr_settype)
529 hidden_proto (__pthread_timedjoin_ex)
530 #endif
532 extern int __pthread_cond_broadcast_2_0 (pthread_cond_2_0_t *cond);
533 extern int __pthread_cond_destroy_2_0 (pthread_cond_2_0_t *cond);
534 extern int __pthread_cond_init_2_0 (pthread_cond_2_0_t *cond,
535 const pthread_condattr_t *cond_attr);
536 extern int __pthread_cond_signal_2_0 (pthread_cond_2_0_t *cond);
537 extern int __pthread_cond_timedwait_2_0 (pthread_cond_2_0_t *cond,
538 pthread_mutex_t *mutex,
539 const struct timespec *abstime);
540 extern int __pthread_cond_wait_2_0 (pthread_cond_2_0_t *cond,
541 pthread_mutex_t *mutex);
543 extern int __pthread_getaffinity_np (pthread_t th, size_t cpusetsize,
544 cpu_set_t *cpuset);
546 /* The two functions are in libc.so and not exported. */
547 extern int __libc_enable_asynccancel (void) attribute_hidden;
548 extern void __libc_disable_asynccancel (int oldtype) attribute_hidden;
551 /* The two functions are in librt.so and not exported. */
552 extern int __librt_enable_asynccancel (void) attribute_hidden;
553 extern void __librt_disable_asynccancel (int oldtype) attribute_hidden;
555 #if IS_IN (libpthread)
556 /* Special versions which use non-exported functions. */
557 extern void __pthread_cleanup_push (struct _pthread_cleanup_buffer *buffer,
558 void (*routine) (void *), void *arg)
559 attribute_hidden;
561 /* Replace cleanup macros defined in <pthread.h> with internal
562 versions that don't depend on unwind info and better support
563 cancellation. */
564 # undef pthread_cleanup_push
565 # define pthread_cleanup_push(routine,arg) \
566 { struct _pthread_cleanup_buffer _buffer; \
567 __pthread_cleanup_push (&_buffer, (routine), (arg));
569 extern void __pthread_cleanup_pop (struct _pthread_cleanup_buffer *buffer,
570 int execute) attribute_hidden;
571 # undef pthread_cleanup_pop
572 # define pthread_cleanup_pop(execute) \
573 __pthread_cleanup_pop (&_buffer, (execute)); }
574 #endif
576 extern void __pthread_cleanup_push_defer (struct _pthread_cleanup_buffer *buffer,
577 void (*routine) (void *), void *arg);
578 extern void __pthread_cleanup_pop_restore (struct _pthread_cleanup_buffer *buffer,
579 int execute);
581 /* Old cleanup interfaces, still used in libc.so. */
582 extern void _pthread_cleanup_push (struct _pthread_cleanup_buffer *buffer,
583 void (*routine) (void *), void *arg);
584 extern void _pthread_cleanup_pop (struct _pthread_cleanup_buffer *buffer,
585 int execute);
586 extern void _pthread_cleanup_push_defer (struct _pthread_cleanup_buffer *buffer,
587 void (*routine) (void *), void *arg);
588 extern void _pthread_cleanup_pop_restore (struct _pthread_cleanup_buffer *buffer,
589 int execute);
591 extern void __nptl_deallocate_tsd (void) attribute_hidden;
593 extern void __nptl_setxid_error (struct xid_command *cmdp, int error)
594 attribute_hidden;
595 extern int __nptl_setxid (struct xid_command *cmdp) attribute_hidden;
596 #ifndef SHARED
597 extern void __nptl_set_robust (struct pthread *self);
598 #endif
600 extern void __free_stacks (size_t limit) attribute_hidden;
602 extern void __wait_lookup_done (void) attribute_hidden;
604 #ifdef SHARED
605 # define PTHREAD_STATIC_FN_REQUIRE(name)
606 #else
607 # define PTHREAD_STATIC_FN_REQUIRE(name) __asm (".globl " #name);
608 #endif
610 /* Returns 0 if POL is a valid scheduling policy. */
611 static inline int
612 check_sched_policy_attr (int pol)
614 if (pol == SCHED_OTHER || pol == SCHED_FIFO || pol == SCHED_RR)
615 return 0;
617 return EINVAL;
620 /* Returns 0 if PR is within the accepted range of priority values for
621 the scheduling policy POL or EINVAL otherwise. */
622 static inline int
623 check_sched_priority_attr (int pr, int pol)
625 int min = __sched_get_priority_min (pol);
626 int max = __sched_get_priority_max (pol);
628 if (min >= 0 && max >= 0 && pr >= min && pr <= max)
629 return 0;
631 return EINVAL;
634 /* Returns 0 if ST is a valid stack size for a thread stack and EINVAL
635 otherwise. */
636 static inline int
637 check_stacksize_attr (size_t st)
639 if (st >= PTHREAD_STACK_MIN)
640 return 0;
642 return EINVAL;
645 #define ASSERT_TYPE_SIZE(type, size) \
646 _Static_assert (sizeof (type) == size, \
647 "sizeof (" #type ") != " #size)
649 #define ASSERT_PTHREAD_INTERNAL_SIZE(type, internal) \
650 _Static_assert (sizeof ((type) { { 0 } }).__size >= sizeof (internal),\
651 "sizeof (" #type ".__size) < sizeof (" #internal ")")
653 #define ASSERT_PTHREAD_STRING(x) __STRING (x)
654 #define ASSERT_PTHREAD_INTERNAL_OFFSET(type, member, offset) \
655 _Static_assert (offsetof (type, member) == offset, \
656 "offset of " #member " field of " #type " != " \
657 ASSERT_PTHREAD_STRING (offset))
659 #endif /* pthreadP.h */