1 /* Copyright (C) 2002, 2003, 2004, 2005, 2006 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, write to the Free
17 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
26 #include <sys/syscall.h>
29 #include <lowlevellock.h>
30 #include <stackinfo.h>
31 #include <internaltypes.h>
32 #include <pthread-functions.h>
34 #include <kernel-features.h>
37 /* Atomic operations on TLS memory. */
38 #ifndef THREAD_ATOMIC_CMPXCHG_VAL
39 # define THREAD_ATOMIC_CMPXCHG_VAL(descr, member, new, old) \
40 atomic_compare_and_exchange_val_acq (&(descr)->member, new, old)
43 #ifndef THREAD_ATOMIC_BIT_SET
44 # define THREAD_ATOMIC_BIT_SET(descr, member, bit) \
45 atomic_bit_set (&(descr)->member, bit)
49 /* Adaptive mutex definitions. */
50 #ifndef MAX_ADAPTIVE_COUNT
51 # define MAX_ADAPTIVE_COUNT 100
55 /* Magic cookie representing robust mutex with dead owner. */
56 #define PTHREAD_MUTEX_INCONSISTENT INT_MAX
57 /* Magic cookie representing not recoverable robust mutex. */
58 #define PTHREAD_MUTEX_NOTRECOVERABLE (INT_MAX - 1)
61 /* Internal mutex type value. */
64 PTHREAD_MUTEX_ROBUST_NORMAL_NP
= 16,
65 PTHREAD_MUTEX_ROBUST_RECURSIVE_NP
66 = PTHREAD_MUTEX_ROBUST_NORMAL_NP
| PTHREAD_MUTEX_RECURSIVE_NP
,
67 PTHREAD_MUTEX_ROBUST_ERRORCHECK_NP
68 = PTHREAD_MUTEX_ROBUST_NORMAL_NP
| PTHREAD_MUTEX_ERRORCHECK_NP
,
69 PTHREAD_MUTEX_ROBUST_ADAPTIVE_NP
70 = PTHREAD_MUTEX_ROBUST_NORMAL_NP
| PTHREAD_MUTEX_ADAPTIVE_NP
,
71 PTHREAD_MUTEX_PRIO_INHERIT_PRIVATE_NP
= 32,
72 PTHREAD_MUTEX_PRIO_PROTECT_PRIVATE_NP
= 64
74 #define PTHREAD_MUTEX_PRIO_CEILING_SHIFT 16
75 #define PTHREAD_MUTEX_PRIO_CEILING_MASK 0x00ff0000
78 /* Flags in mutex attr. */
79 #define PTHREAD_MUTEXATTR_PROTOCOL_SHIFT 28
80 #define PTHREAD_MUTEXATTR_PROTOCOL_MASK 0x30000000
81 #define PTHREAD_MUTEXATTR_PRIO_CEILING_SHIFT 16
82 #define PTHREAD_MUTEXATTR_PRIO_CEILING_MASK 0x00ff0000
83 #define PTHREAD_MUTEXATTR_FLAG_ROBUST 0x40000000
84 #define PTHREAD_MUTEXATTR_FLAG_PSHARED 0x80000000
85 #define PTHREAD_MUTEXATTR_FLAG_BITS \
86 (PTHREAD_MUTEXATTR_FLAG_ROBUST | PTHREAD_MUTEXATTR_FLAG_PSHARED \
87 | PTHREAD_MUTEXATTR_PROTOCOL_MASK | PTHREAD_MUTEXATTR_PRIO_CEILING_MASK)
90 /* Bits used in robust mutex implementation. */
91 #define FUTEX_WAITERS 0x80000000
92 #define FUTEX_OWNER_DIED 0x40000000
93 #define FUTEX_TID_MASK 0x3fffffff
96 /* Internal variables. */
99 /* Default stack size. */
100 extern size_t __default_stacksize attribute_hidden
;
102 /* Size and alignment of static TLS block. */
103 extern size_t __static_tls_size attribute_hidden
;
104 extern size_t __static_tls_align_m1 attribute_hidden
;
106 /* Flag whether the machine is SMP or not. */
107 extern int __is_smp attribute_hidden
;
109 /* Thread descriptor handling. */
110 extern list_t __stack_user
;
111 hidden_proto (__stack_user
)
113 /* Attribute handling. */
114 extern struct pthread_attr
*__attr_list attribute_hidden
;
115 extern lll_lock_t __attr_list_lock attribute_hidden
;
117 /* First available RT signal. */
118 extern int __current_sigrtmin attribute_hidden
;
119 /* Last available RT signal. */
120 extern int __current_sigrtmax attribute_hidden
;
122 /* Concurrency handling. */
123 extern int __concurrency_level attribute_hidden
;
125 /* Thread-local data key handling. */
126 extern struct pthread_key_struct __pthread_keys
[PTHREAD_KEYS_MAX
];
127 hidden_proto (__pthread_keys
)
129 /* Number of threads running. */
130 extern unsigned int __nptl_nthreads attribute_hidden
;
132 #ifndef __ASSUME_SET_ROBUST_LIST
133 /* Negative if we do not have the system call and we can use it. */
134 extern int __set_robust_list_avail attribute_hidden
;
137 /* The library can run in debugging mode where it performs a lot more
139 extern int __pthread_debug attribute_hidden
;
140 /** For now disable debugging support. */
142 # define DEBUGGING_P __builtin_expect (__pthread_debug, 0)
143 # define INVALID_TD_P(pd) (DEBUGGING_P && __find_in_stack_list (pd) == NULL)
144 # define INVALID_NOT_TERMINATED_TD_P(pd) INVALID_TD_P (pd)
146 # define DEBUGGING_P 0
147 /* Simplified test. This will not catch all invalid descriptors but
148 is better than nothing. And if the test triggers the thread
149 descriptor is guaranteed to be invalid. */
150 # define INVALID_TD_P(pd) __builtin_expect ((pd)->tid <= 0, 0)
151 # define INVALID_NOT_TERMINATED_TD_P(pd) __builtin_expect ((pd)->tid < 0, 0)
155 /* Cancellation test. */
156 #define CANCELLATION_P(self) \
158 int cancelhandling = THREAD_GETMEM (self, cancelhandling); \
159 if (CANCEL_ENABLED_AND_CANCELED (cancelhandling)) \
161 THREAD_SETMEM (self, result, PTHREAD_CANCELED); \
167 extern void __pthread_unwind (__pthread_unwind_buf_t
*__buf
)
168 __cleanup_fct_attribute
__attribute ((__noreturn__
))
169 #if !defined SHARED && !defined IS_IN_libpthread
173 extern void __pthread_unwind_next (__pthread_unwind_buf_t
*__buf
)
174 __cleanup_fct_attribute
__attribute ((__noreturn__
))
179 extern void __pthread_register_cancel (__pthread_unwind_buf_t
*__buf
)
180 __cleanup_fct_attribute
;
181 extern void __pthread_unregister_cancel (__pthread_unwind_buf_t
*__buf
)
182 __cleanup_fct_attribute
;
183 #if defined NOT_IN_libc && defined IS_IN_libpthread
184 hidden_proto (__pthread_unwind
)
185 hidden_proto (__pthread_unwind_next
)
186 hidden_proto (__pthread_register_cancel
)
187 hidden_proto (__pthread_unregister_cancel
)
189 extern void attribute_hidden
pthread_cancel_init (void);
194 /* Called when a thread reacts on a cancellation request. */
196 __attribute ((noreturn
, always_inline
))
199 struct pthread
*self
= THREAD_SELF
;
201 /* Make sure we get no more cancellations. */
202 THREAD_ATOMIC_BIT_SET (self
, cancelhandling
, EXITING_BIT
);
204 __pthread_unwind ((__pthread_unwind_buf_t
*)
205 THREAD_GETMEM (self
, cleanup_jmp_buf
));
209 /* Set cancellation mode to asynchronous. */
210 #define CANCEL_ASYNC() \
211 __pthread_enable_asynccancel ()
212 /* Reset to previous cancellation mode. */
213 #define CANCEL_RESET(oldtype) \
214 __pthread_disable_asynccancel (oldtype)
216 #if !defined NOT_IN_libc
217 /* Same as CANCEL_ASYNC, but for use in libc.so. */
218 # define LIBC_CANCEL_ASYNC() \
219 __libc_enable_asynccancel ()
220 /* Same as CANCEL_RESET, but for use in libc.so. */
221 # define LIBC_CANCEL_RESET(oldtype) \
222 __libc_disable_asynccancel (oldtype)
223 # define LIBC_CANCEL_HANDLED() \
224 __asm (".globl " __SYMBOL_PREFIX "__libc_enable_asynccancel"); \
225 __asm (".globl " __SYMBOL_PREFIX "__libc_disable_asynccancel")
226 #elif defined NOT_IN_libc && defined IS_IN_libpthread
227 # define LIBC_CANCEL_ASYNC() CANCEL_ASYNC ()
228 # define LIBC_CANCEL_RESET(val) CANCEL_RESET (val)
229 # define LIBC_CANCEL_HANDLED() \
230 __asm (".globl " __SYMBOL_PREFIX "__pthread_enable_asynccancel"); \
231 __asm (".globl " __SYMBOL_PREFIX "__pthread_disable_asynccancel")
232 #elif defined NOT_IN_libc && defined IS_IN_librt
233 # define LIBC_CANCEL_ASYNC() \
234 __librt_enable_asynccancel ()
235 # define LIBC_CANCEL_RESET(val) \
236 __librt_disable_asynccancel (val)
237 # define LIBC_CANCEL_HANDLED() \
238 __asm (".globl " __SYMBOL_PREFIX "__librt_enable_asynccancel"); \
239 __asm (".globl " __SYMBOL_PREFIX "__librt_disable_asynccancel")
241 # define LIBC_CANCEL_ASYNC() 0 /* Just a dummy value. */
242 # define LIBC_CANCEL_RESET(val) ((void)(val)) /* Nothing, but evaluate it. */
243 # define LIBC_CANCEL_HANDLED() /* Nothing. */
246 /* The signal used for asynchronous cancelation. */
247 #define SIGCANCEL __SIGRTMIN
250 /* Signal needed for the kernel-supported POSIX timer implementation.
251 We can reuse the cancellation signal since we can distinguish
252 cancellation from timer expirations. */
253 #define SIGTIMER SIGCANCEL
256 /* Signal used to implement the setuid et.al. functions. */
257 #define SIGSETXID (__SIGRTMIN + 1)
259 /* Used to communicate with signal handler. */
260 extern struct xid_command
*__xidcmd attribute_hidden
;
263 /* Internal prototypes. */
265 /* Thread list handling. */
266 extern struct pthread
*__find_in_stack_list (struct pthread
*pd
)
267 attribute_hidden internal_function
;
269 /* Deallocate a thread's stack after optionally making sure the thread
270 descriptor is still valid. */
271 extern void __free_tcb (struct pthread
*pd
) attribute_hidden internal_function
;
273 /* Free allocated stack. */
274 extern void __deallocate_stack (struct pthread
*pd
)
275 attribute_hidden internal_function
;
277 /* Mark all the stacks except for the current one as available. This
278 function also re-initializes the lock for the stack cache. */
279 extern void __reclaim_stacks (void) attribute_hidden
;
281 /* Make all threads's stacks executable. */
282 extern int __make_stacks_executable (void **stack_endp
)
283 internal_function attribute_hidden
;
285 /* longjmp handling. */
286 extern void __pthread_cleanup_upto (__jmp_buf target
, char *targetframe
);
287 #if defined NOT_IN_libc && defined IS_IN_libpthread
288 hidden_proto (__pthread_cleanup_upto
)
292 /* Functions with versioned interfaces. */
293 extern int __pthread_create_2_1 (pthread_t
*newthread
,
294 const pthread_attr_t
*attr
,
295 void *(*start_routine
) (void *), void *arg
);
296 extern int __pthread_create_2_0 (pthread_t
*newthread
,
297 const pthread_attr_t
*attr
,
298 void *(*start_routine
) (void *), void *arg
);
299 extern int __pthread_attr_init_2_1 (pthread_attr_t
*attr
);
300 extern int __pthread_attr_init_2_0 (pthread_attr_t
*attr
);
303 /* Event handlers for libthread_db interface. */
304 extern void __nptl_create_event (void);
305 extern void __nptl_death_event (void);
306 hidden_proto (__nptl_create_event
)
307 hidden_proto (__nptl_death_event
)
309 /* Register the generation counter in the libpthread with the libc. */
310 #ifdef TLS_MULTIPLE_THREADS_IN_TCB
311 extern void __libc_pthread_init (unsigned long int *ptr
,
312 void (*reclaim
) (void),
313 const struct pthread_functions
*functions
)
316 extern int *__libc_pthread_init (unsigned long int *ptr
,
317 void (*reclaim
) (void),
318 const struct pthread_functions
*functions
)
321 /* Variable set to a nonzero value if more than one thread runs or ran. */
322 extern int __pthread_multiple_threads attribute_hidden
;
323 /* Pointer to the corresponding variable in libc. */
324 extern int *__libc_multiple_threads_ptr attribute_hidden
;
327 /* Find a thread given its TID. */
328 extern struct pthread
*__find_thread_by_id (pid_t tid
) attribute_hidden
333 #define __find_thread_by_id(tid) \
334 (__find_thread_by_id ? (__find_thread_by_id) (tid) : (struct pthread *) NULL)
337 extern void __pthread_init_static_tls (struct link_map
*) attribute_hidden
;
340 /* Namespace save aliases. */
341 extern int __pthread_getschedparam (pthread_t thread_id
, int *policy
,
342 struct sched_param
*param
);
343 extern int __pthread_setschedparam (pthread_t thread_id
, int policy
,
344 const struct sched_param
*param
);
345 extern int __pthread_setcancelstate (int state
, int *oldstate
);
346 extern int __pthread_mutex_init (pthread_mutex_t
*__mutex
,
347 __const pthread_mutexattr_t
*__mutexattr
);
348 extern int __pthread_mutex_init_internal (pthread_mutex_t
*__mutex
,
349 __const pthread_mutexattr_t
*__mutexattr
)
351 extern int __pthread_mutex_destroy (pthread_mutex_t
*__mutex
);
352 extern int __pthread_mutex_destroy_internal (pthread_mutex_t
*__mutex
)
354 extern int __pthread_mutex_trylock (pthread_mutex_t
*_mutex
);
355 extern int __pthread_mutex_lock (pthread_mutex_t
*__mutex
);
356 extern int __pthread_mutex_lock_internal (pthread_mutex_t
*__mutex
)
358 extern int __pthread_mutex_cond_lock (pthread_mutex_t
*__mutex
)
359 attribute_hidden internal_function
;
360 extern int __pthread_mutex_unlock (pthread_mutex_t
*__mutex
);
361 extern int __pthread_mutex_unlock_internal (pthread_mutex_t
*__mutex
)
363 extern int __pthread_mutex_unlock_usercnt (pthread_mutex_t
*__mutex
,
365 attribute_hidden internal_function
;
366 extern int __pthread_mutexattr_init (pthread_mutexattr_t
*attr
);
367 extern int __pthread_mutexattr_destroy (pthread_mutexattr_t
*attr
);
368 extern int __pthread_mutexattr_settype (pthread_mutexattr_t
*attr
, int kind
);
369 extern int __pthread_attr_destroy (pthread_attr_t
*attr
);
370 extern int __pthread_attr_getdetachstate (const pthread_attr_t
*attr
,
372 extern int __pthread_attr_setdetachstate (pthread_attr_t
*attr
,
374 extern int __pthread_attr_getinheritsched (const pthread_attr_t
*attr
,
376 extern int __pthread_attr_setinheritsched (pthread_attr_t
*attr
, int inherit
);
377 extern int __pthread_attr_getschedparam (const pthread_attr_t
*attr
,
378 struct sched_param
*param
);
379 extern int __pthread_attr_setschedparam (pthread_attr_t
*attr
,
380 const struct sched_param
*param
);
381 extern int __pthread_attr_getschedpolicy (const pthread_attr_t
*attr
,
383 extern int __pthread_attr_setschedpolicy (pthread_attr_t
*attr
, int policy
);
384 extern int __pthread_attr_getscope (const pthread_attr_t
*attr
, int *scope
);
385 extern int __pthread_attr_setscope (pthread_attr_t
*attr
, int scope
);
386 extern int __pthread_attr_getstackaddr (__const pthread_attr_t
*__restrict
387 __attr
, void **__restrict __stackaddr
);
388 extern int __pthread_attr_setstackaddr (pthread_attr_t
*__attr
,
390 extern int __pthread_attr_getstacksize (__const pthread_attr_t
*__restrict
392 size_t *__restrict __stacksize
);
393 extern int __pthread_attr_setstacksize (pthread_attr_t
*__attr
,
395 extern int __pthread_attr_getstack (__const pthread_attr_t
*__restrict __attr
,
396 void **__restrict __stackaddr
,
397 size_t *__restrict __stacksize
);
398 extern int __pthread_attr_setstack (pthread_attr_t
*__attr
, void *__stackaddr
,
400 extern int __pthread_rwlock_init (pthread_rwlock_t
*__restrict __rwlock
,
401 __const pthread_rwlockattr_t
*__restrict
403 extern int __pthread_rwlock_destroy (pthread_rwlock_t
*__rwlock
);
404 extern int __pthread_rwlock_rdlock (pthread_rwlock_t
*__rwlock
);
405 extern int __pthread_rwlock_rdlock_internal (pthread_rwlock_t
*__rwlock
);
406 extern int __pthread_rwlock_tryrdlock (pthread_rwlock_t
*__rwlock
);
407 extern int __pthread_rwlock_wrlock (pthread_rwlock_t
*__rwlock
);
408 extern int __pthread_rwlock_wrlock_internal (pthread_rwlock_t
*__rwlock
);
409 extern int __pthread_rwlock_trywrlock (pthread_rwlock_t
*__rwlock
);
410 extern int __pthread_rwlock_unlock (pthread_rwlock_t
*__rwlock
);
411 extern int __pthread_rwlock_unlock_internal (pthread_rwlock_t
*__rwlock
);
412 extern int __pthread_cond_broadcast (pthread_cond_t
*cond
);
413 extern int __pthread_cond_destroy (pthread_cond_t
*cond
);
414 extern int __pthread_cond_init (pthread_cond_t
*cond
,
415 const pthread_condattr_t
*cond_attr
);
416 extern int __pthread_cond_signal (pthread_cond_t
*cond
);
417 extern int __pthread_cond_wait (pthread_cond_t
*cond
, pthread_mutex_t
*mutex
);
418 extern int __pthread_cond_timedwait (pthread_cond_t
*cond
,
419 pthread_mutex_t
*mutex
,
420 const struct timespec
*abstime
);
421 extern int __pthread_condattr_destroy (pthread_condattr_t
*attr
);
422 extern int __pthread_condattr_init (pthread_condattr_t
*attr
);
423 extern int __pthread_key_create (pthread_key_t
*key
, void (*destr
) (void *));
424 extern int __pthread_key_create_internal (pthread_key_t
*key
,
425 void (*destr
) (void *));
426 extern void *__pthread_getspecific (pthread_key_t key
);
427 extern void *__pthread_getspecific_internal (pthread_key_t key
);
428 extern int __pthread_setspecific (pthread_key_t key
, const void *value
);
429 extern int __pthread_setspecific_internal (pthread_key_t key
,
431 extern int __pthread_once (pthread_once_t
*once_control
,
432 void (*init_routine
) (void));
433 extern int __pthread_once_internal (pthread_once_t
*once_control
,
434 void (*init_routine
) (void));
435 extern int __pthread_atfork (void (*prepare
) (void), void (*parent
) (void),
436 void (*child
) (void));
437 extern pthread_t
__pthread_self (void);
438 extern int __pthread_equal (pthread_t thread1
, pthread_t thread2
);
439 extern int __pthread_kill (pthread_t threadid
, int signo
);
440 extern void __pthread_exit (void *value
);
441 extern int __pthread_setcanceltype (int type
, int *oldtype
);
442 extern int __pthread_enable_asynccancel (void) attribute_hidden
;
443 extern void __pthread_disable_asynccancel (int oldtype
)
444 internal_function attribute_hidden
;
446 extern int __pthread_cond_broadcast_2_0 (pthread_cond_2_0_t
*cond
);
447 extern int __pthread_cond_destroy_2_0 (pthread_cond_2_0_t
*cond
);
448 extern int __pthread_cond_init_2_0 (pthread_cond_2_0_t
*cond
,
449 const pthread_condattr_t
*cond_attr
);
450 extern int __pthread_cond_signal_2_0 (pthread_cond_2_0_t
*cond
);
451 extern int __pthread_cond_timedwait_2_0 (pthread_cond_2_0_t
*cond
,
452 pthread_mutex_t
*mutex
,
453 const struct timespec
*abstime
);
454 extern int __pthread_cond_wait_2_0 (pthread_cond_2_0_t
*cond
,
455 pthread_mutex_t
*mutex
);
457 extern int __pthread_getaffinity_np (pthread_t th
, size_t cpusetsize
,
460 /* The two functions are in libc.so and not exported. */
461 extern int __libc_enable_asynccancel (void) attribute_hidden
;
462 extern void __libc_disable_asynccancel (int oldtype
)
463 internal_function attribute_hidden
;
466 /* The two functions are in librt.so and not exported. */
467 extern int __librt_enable_asynccancel (void) attribute_hidden
;
468 extern void __librt_disable_asynccancel (int oldtype
)
469 internal_function attribute_hidden
;
471 #ifdef IS_IN_libpthread
472 /* Special versions which use non-exported functions. */
473 extern void __pthread_cleanup_push (struct _pthread_cleanup_buffer
*buffer
,
474 void (*routine
) (void *), void *arg
)
476 # undef pthread_cleanup_push
477 # define pthread_cleanup_push(routine,arg) \
478 { struct _pthread_cleanup_buffer _buffer; \
479 __pthread_cleanup_push (&_buffer, (routine), (arg));
481 extern void __pthread_cleanup_pop (struct _pthread_cleanup_buffer
*buffer
,
482 int execute
) attribute_hidden
;
483 # undef pthread_cleanup_pop
484 # define pthread_cleanup_pop(execute) \
485 __pthread_cleanup_pop (&_buffer, (execute)); }
488 extern void __pthread_cleanup_push_defer (struct _pthread_cleanup_buffer
*buffer
,
489 void (*routine
) (void *), void *arg
);
490 extern void __pthread_cleanup_pop_restore (struct _pthread_cleanup_buffer
*buffer
,
493 /* Old cleanup interfaces, still used in libc.so. */
494 extern void _pthread_cleanup_push (struct _pthread_cleanup_buffer
*buffer
,
495 void (*routine
) (void *), void *arg
);
496 extern void _pthread_cleanup_pop (struct _pthread_cleanup_buffer
*buffer
,
498 extern void _pthread_cleanup_push_defer (struct _pthread_cleanup_buffer
*buffer
,
499 void (*routine
) (void *), void *arg
);
500 extern void _pthread_cleanup_pop_restore (struct _pthread_cleanup_buffer
*buffer
,
503 extern void __nptl_deallocate_tsd (void) attribute_hidden
;
505 extern int __nptl_setxid (struct xid_command
*cmdp
) attribute_hidden
;
508 # define PTHREAD_STATIC_FN_REQUIRE(name)
510 # define PTHREAD_STATIC_FN_REQUIRE(name) __asm (".globl " #name);
514 #ifndef __NR_set_robust_list
515 /* XXX For the time being... Once we can rely on the kernel headers
516 having the definition remove these lines. */
517 # if defined __i386__
518 # define __NR_set_robust_list 311
519 # elif defined __x86_64__
520 # define __NR_set_robust_list 273
524 #endif /* pthreadP.h */