nptl/pthreadP.h

   1 /* Copyright (C) 2002, 2003 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, write to the Free
  17    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  18    02111-1307 USA.  */
  19
  20 #ifndef _PTHREADP_H
  21 #define _PTHREADP_H     1
  22
  23 #include <pthread.h>
  24 #include <setjmp.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
  34
  35 /* Atomic operations on TLS memory.  */
  36 #ifndef THREAD_ATOMIC_CMPXCHG_VAL
  37 # define THREAD_ATOMIC_CMPXCHG_VAL(descr, member, new, old) \
  38   atomic_compare_and_exchange_val_acq (&(descr)->member, new, old)
  39 #endif
  40
  41 #ifndef THREAD_ATOMIC_BIT_SET
  42 # define THREAD_ATOMIC_BIT_SET(descr, member, bit) \
  43   atomic_bit_set (&(descr)->member, bit)
  44 #endif
  45
  46
  47 /* Internal variables.  */
  48
  49
  50 /* Default stack size.  */
  51 extern size_t __default_stacksize attribute_hidden;
  52
  53 /* Size and alignment of static TLS block.  */
  54 extern size_t __static_tls_size attribute_hidden;
  55 extern size_t __static_tls_align_m1 attribute_hidden;
  56
  57 /* Thread descriptor handling.  */
  58 extern list_t __stack_user;
  59 hidden_proto (__stack_user)
  60
  61 /* Attribute handling.  */
  62 extern struct pthread_attr *__attr_list attribute_hidden;
  63 extern lll_lock_t __attr_list_lock attribute_hidden;
  64
  65 /* First available RT signal.  */
  66 extern int __current_sigrtmin attribute_hidden;
  67 /* Last available RT signal.  */
  68 extern int __current_sigrtmax attribute_hidden;
  69
  70 /* Concurrency handling.  */
  71 extern int __concurrency_level attribute_hidden;
  72
  73 /* Thread-local data key handling.  */
  74 extern struct pthread_key_struct __pthread_keys[PTHREAD_KEYS_MAX];
  75 hidden_proto (__pthread_keys)
  76
  77 /* Number of threads running.  */
  78 extern unsigned int __nptl_nthreads attribute_hidden;
  79
  80 /* The library can run in debugging mode where it performs a lot more
  81    tests.  */
  82 extern int __pthread_debug attribute_hidden;
  83 /** For now disable debugging support.  */
  84 #if 0
  85 # define DEBUGGING_P __builtin_expect (__pthread_debug, 0)
  86 # define INVALID_TD_P(pd) (DEBUGGING_P && __find_in_stack_list (pd) == NULL)
  87 # define INVALID_NOT_TERMINATED_TD_P(pd) INVALID_TD_P (pd)
  88 #else
  89 # define DEBUGGING_P 0
  90 /* Simplified test.  This will not catch all invalid descriptors but
  91    is better than nothing.  And if the test triggers the thread
  92    descriptor is guaranteed to be invalid.  */
  93 # define INVALID_TD_P(pd) __builtin_expect ((pd)->tid <= 0, 0)
  94 # define INVALID_NOT_TERMINATED_TD_P(pd) __builtin_expect ((pd)->tid < 0, 0)
  95 #endif
  96
  97
  98 /* Cancellation test.  */
  99 #define CANCELLATION_P(self) \
 100   do {                                                                        \
 101     int cancelhandling = THREAD_GETMEM (self, cancelhandling);                \
 102     if (CANCEL_ENABLED_AND_CANCELED (cancelhandling))                         \
 103       {                                                                       \
 104         THREAD_SETMEM (self, result, PTHREAD_CANCELED);                       \
 105         __do_cancel ();                                                       \
 106       }                                                                       \
 107   } while (0)
 108
 109
 110 extern void __pthread_unwind (__pthread_unwind_buf_t *__buf)
 111      __cleanup_fct_attribute __attribute ((__noreturn__))
 112 #ifndef SHARED
 113      weak_function
 114 #endif
 115      ;
 116
 117 /* Called when a thread reacts on a cancellation request.  */
 118 static inline void
 119 __attribute ((noreturn))
 120 __do_cancel (void)
 121 {
 122   struct pthread *self = THREAD_SELF;
 123
 124   /* Make sure we get no more cancellations.  */
 125   THREAD_ATOMIC_BIT_SET (self, cancelhandling, EXITING_BIT);
 126
 127   __pthread_unwind ((__pthread_unwind_buf_t *)
 128                     THREAD_GETMEM (self, cleanup_jmp_buf));
 129 }
 130
 131
 132 /* Set cancellation mode to asynchronous.  */
 133 #define CANCEL_ASYNC() \
 134   __pthread_enable_asynccancel ()
 135 /* Reset to previous cancellation mode.  */
 136 #define CANCEL_RESET(oldtype) \
 137   __pthread_disable_asynccancel (oldtype)
 138
 139 #if !defined NOT_IN_libc
 140 /* Same as CANCEL_ASYNC, but for use in libc.so.  */
 141 # define LIBC_CANCEL_ASYNC() \
 142   __libc_enable_asynccancel ()
 143 /* Same as CANCEL_RESET, but for use in libc.so.  */
 144 # define LIBC_CANCEL_RESET(oldtype) \
 145   __libc_disable_asynccancel (oldtype)
 146 # define LIBC_CANCEL_HANDLED() \
 147   __asm (".globl " __SYMBOL_PREFIX "__libc_enable_asynccancel"); \
 148   __asm (".globl " __SYMBOL_PREFIX "__libc_disable_asynccancel")
 149 #elif defined NOT_IN_libc && defined IS_IN_libpthread
 150 # define LIBC_CANCEL_ASYNC() CANCEL_ASYNC ()
 151 # define LIBC_CANCEL_RESET(val) CANCEL_RESET (val)
 152 # define LIBC_CANCEL_HANDLED() \
 153   __asm (".globl " __SYMBOL_PREFIX "__pthread_enable_asynccancel"); \
 154   __asm (".globl " __SYMBOL_PREFIX "__pthread_disable_asynccancel")
 155 #else
 156 # define LIBC_CANCEL_ASYNC()    0 /* Just a dummy value.  */
 157 # define LIBC_CANCEL_RESET(val) ((void)(val)) /* Nothing, but evaluate it.  */
 158 # define LIBC_CANCEL_HANDLED()  /* Nothing.  */
 159 #endif
 160
 161 /* The signal used for asynchronous cancelation.  */
 162 #define SIGCANCEL       __SIGRTMIN
 163
 164
 165 /* Signal needed for the kernel-supported POSIX timer implementation.
 166    We can reuse the cancellation signal since we can distinguish
 167    cancellation from timer expirations.  */
 168 #define SIGTIMER        SIGCANCEL
 169
 170
 171 /* Internal prototypes.  */
 172
 173 /* Thread list handling.  */
 174 extern struct pthread *__find_in_stack_list (struct pthread *pd)
 175      attribute_hidden internal_function;
 176
 177 /* Deallocate a thread's stack after optionally making sure the thread
 178    descriptor is still valid.  */
 179 extern void __free_tcb (struct pthread *pd) attribute_hidden internal_function;
 180
 181 /* Free allocated stack.  */
 182 extern void __deallocate_stack (struct pthread *pd)
 183      attribute_hidden internal_function;
 184
 185 /* Mark all the stacks except for the current one as available.  This
 186    function also re-initializes the lock for the stack cache.  */
 187 extern void __reclaim_stacks (void) attribute_hidden;
 188
 189 /* longjmp handling.  */
 190 extern void __pthread_cleanup_upto (__jmp_buf target, char *targetframe);
 191
 192
 193 /* Functions with versioned interfaces.  */
 194 extern int __pthread_create_2_1 (pthread_t *newthread,
 195                                  const pthread_attr_t *attr,
 196                                  void *(*start_routine) (void *), void *arg);
 197 extern int __pthread_create_2_0 (pthread_t *newthread,
 198                                  const pthread_attr_t *attr,
 199                                  void *(*start_routine) (void *), void *arg);
 200 extern int __pthread_attr_init_2_1 (pthread_attr_t *attr);
 201 extern int __pthread_attr_init_2_0 (pthread_attr_t *attr);
 202
 203
 204 /* Event handlers for libthread_db interface.  */
 205 extern void __nptl_create_event (void);
 206 extern void __nptl_death_event (void);
 207 hidden_proto (__nptl_create_event)
 208 hidden_proto (__nptl_death_event)
 209
 210 /* Register the generation counter in the libpthread with the libc.  */
 211 #ifdef TLS_MULTIPLE_THREADS_IN_TCB
 212 extern void __libc_pthread_init (unsigned long int *ptr,
 213                                  void (*reclaim) (void),
 214                                  const struct pthread_functions *functions)
 215      internal_function;
 216 #else
 217 extern int *__libc_pthread_init (unsigned long int *ptr,
 218                                  void (*reclaim) (void),
 219                                  const struct pthread_functions *functions)
 220      internal_function;
 221
 222 /* Variable set to a nonzero value if more than one thread runs or ran.  */
 223 extern int __pthread_multiple_threads attribute_hidden;
 224 /* Pointer to the corresponding variable in libc.  */
 225 extern int *__libc_multiple_threads_ptr attribute_hidden;
 226 #endif
 227
 228
 229 /* Namespace save aliases.  */
 230 extern int __pthread_getschedparam (pthread_t thread_id, int *policy,
 231                                     struct sched_param *param);
 232 extern int __pthread_setschedparam (pthread_t thread_id, int policy,
 233                                     const struct sched_param *param);
 234 extern int __pthread_setcancelstate (int state, int *oldstate);
 235 extern int __pthread_mutex_init (pthread_mutex_t *__mutex,
 236                                  __const pthread_mutexattr_t *__mutexattr);
 237 extern int __pthread_mutex_init_internal (pthread_mutex_t *__mutex,
 238                                           __const pthread_mutexattr_t *__mutexattr);
 239 extern int __pthread_mutex_destroy (pthread_mutex_t *__mutex);
 240 extern int __pthread_mutex_destroy_internal (pthread_mutex_t *__mutex);
 241 extern int __pthread_mutex_trylock (pthread_mutex_t *_mutex);
 242 extern int __pthread_mutex_lock (pthread_mutex_t *__mutex);
 243 extern int __pthread_mutex_lock_internal (pthread_mutex_t *__mutex);
 244 extern int __pthread_mutex_unlock (pthread_mutex_t *__mutex);
 245 extern int __pthread_mutex_unlock_internal (pthread_mutex_t *__mutex);
 246 extern int __pthread_mutexattr_init (pthread_mutexattr_t *attr);
 247 extern int __pthread_mutexattr_destroy (pthread_mutexattr_t *attr);
 248 extern int __pthread_mutexattr_settype (pthread_mutexattr_t *attr, int kind);
 249 extern int __pthread_attr_destroy (pthread_attr_t *attr);
 250 extern int __pthread_attr_getdetachstate (const pthread_attr_t *attr,
 251                                           int *detachstate);
 252 extern int __pthread_attr_setdetachstate (pthread_attr_t *attr,
 253                                           int detachstate);
 254 extern int __pthread_attr_getinheritsched (const pthread_attr_t *attr,
 255                                            int *inherit);
 256 extern int __pthread_attr_setinheritsched (pthread_attr_t *attr, int inherit);
 257 extern int __pthread_attr_getschedparam (const pthread_attr_t *attr,
 258                                          struct sched_param *param);
 259 extern int __pthread_attr_setschedparam (pthread_attr_t *attr,
 260                                          const struct sched_param *param);
 261 extern int __pthread_attr_getschedpolicy (const pthread_attr_t *attr,
 262                                           int *policy);
 263 extern int __pthread_attr_setschedpolicy (pthread_attr_t *attr, int policy);
 264 extern int __pthread_attr_getscope (const pthread_attr_t *attr, int *scope);
 265 extern int __pthread_attr_setscope (pthread_attr_t *attr, int scope);
 266 extern int __pthread_attr_getstackaddr (__const pthread_attr_t *__restrict
 267                                         __attr, void **__restrict __stackaddr);
 268 extern int __pthread_attr_setstackaddr (pthread_attr_t *__attr,
 269                                         void *__stackaddr);
 270 extern int __pthread_attr_getstacksize (__const pthread_attr_t *__restrict
 271                                         __attr,
 272                                         size_t *__restrict __stacksize);
 273 extern int __pthread_attr_setstacksize (pthread_attr_t *__attr,
 274                                         size_t __stacksize);
 275 extern int __pthread_attr_getstack (__const pthread_attr_t *__restrict __attr,
 276                                     void **__restrict __stackaddr,
 277                                     size_t *__restrict __stacksize);
 278 extern int __pthread_attr_setstack (pthread_attr_t *__attr, void *__stackaddr,
 279                                     size_t __stacksize);
 280 extern int __pthread_rwlock_init (pthread_rwlock_t *__restrict __rwlock,
 281                                   __const pthread_rwlockattr_t *__restrict
 282                                   __attr);
 283 extern int __pthread_rwlock_destroy (pthread_rwlock_t *__rwlock);
 284 extern int __pthread_rwlock_rdlock (pthread_rwlock_t *__rwlock);
 285 extern int __pthread_rwlock_rdlock_internal (pthread_rwlock_t *__rwlock);
 286 extern int __pthread_rwlock_tryrdlock (pthread_rwlock_t *__rwlock);
 287 extern int __pthread_rwlock_wrlock (pthread_rwlock_t *__rwlock);
 288 extern int __pthread_rwlock_wrlock_internal (pthread_rwlock_t *__rwlock);
 289 extern int __pthread_rwlock_trywrlock (pthread_rwlock_t *__rwlock);
 290 extern int __pthread_rwlock_unlock (pthread_rwlock_t *__rwlock);
 291 extern int __pthread_rwlock_unlock_internal (pthread_rwlock_t *__rwlock);
 292 extern int __pthread_cond_broadcast (pthread_cond_t *cond);
 293 extern int __pthread_cond_destroy (pthread_cond_t *cond);
 294 extern int __pthread_cond_init (pthread_cond_t *cond,
 295                                 const pthread_condattr_t *cond_attr);
 296 extern int __pthread_cond_signal (pthread_cond_t *cond);
 297 extern int __pthread_cond_wait (pthread_cond_t *cond, pthread_mutex_t *mutex);
 298 extern int __pthread_cond_timedwait (pthread_cond_t *cond,
 299                                      pthread_mutex_t *mutex,
 300                                      const struct timespec *abstime);
 301 extern int __pthread_condattr_destroy (pthread_condattr_t *attr);
 302 extern int __pthread_condattr_init (pthread_condattr_t *attr);
 303 extern int __pthread_key_create (pthread_key_t *key, void (*destr) (void *));
 304 extern int __pthread_key_create_internal (pthread_key_t *key,
 305                                           void (*destr) (void *));
 306 extern void *__pthread_getspecific (pthread_key_t key);
 307 extern void *__pthread_getspecific_internal (pthread_key_t key);
 308 extern int __pthread_setspecific (pthread_key_t key, const void *value);
 309 extern int __pthread_setspecific_internal (pthread_key_t key,
 310                                            const void *value);
 311 extern int __pthread_once (pthread_once_t *once_control,
 312                            void (*init_routine) (void));
 313 extern int __pthread_once_internal (pthread_once_t *once_control,
 314                                     void (*init_routine) (void));
 315 extern int __pthread_atfork (void (*prepare) (void), void (*parent) (void),
 316                              void (*child) (void));
 317 extern pthread_t __pthread_self (void);
 318 extern int __pthread_equal (pthread_t thread1, pthread_t thread2);
 319 extern int __pthread_kill (pthread_t threadid, int signo);
 320 extern void __pthread_exit (void *value);
 321 extern int __pthread_setcanceltype (int type, int *oldtype);
 322 extern int __pthread_enable_asynccancel (void) attribute_hidden;
 323 extern void __pthread_enable_asynccancel_2 (int *oldvalp)
 324      internal_function attribute_hidden;
 325 extern void __pthread_disable_asynccancel (int oldtype)
 326      internal_function attribute_hidden;
 327
 328 extern int __pthread_cond_broadcast_2_0 (pthread_cond_2_0_t *cond);
 329 extern int __pthread_cond_destroy_2_0 (pthread_cond_2_0_t *cond);
 330 extern int __pthread_cond_init_2_0 (pthread_cond_2_0_t *cond,
 331                                     const pthread_condattr_t *cond_attr);
 332 extern int __pthread_cond_signal_2_0 (pthread_cond_2_0_t *cond);
 333 extern int __pthread_cond_timedwait_2_0 (pthread_cond_2_0_t *cond,
 334                                          pthread_mutex_t *mutex,
 335                                          const struct timespec *abstime);
 336 extern int __pthread_cond_wait_2_0 (pthread_cond_2_0_t *cond,
 337                                     pthread_mutex_t *mutex);
 338
 339
 340 /* The two functions are in libc.so and not exported.  */
 341 extern int __libc_enable_asynccancel (void) attribute_hidden;
 342 extern void __libc_disable_asynccancel (int oldtype)
 343      internal_function attribute_hidden;
 344
 345 #ifdef IS_IN_libpthread
 346 /* Special versions which use non-exported functions.  */
 347 extern void __pthread_cleanup_push (struct _pthread_cleanup_buffer *buffer,
 348                                     void (*routine) (void *), void *arg)
 349      attribute_hidden;
 350 # undef pthread_cleanup_push
 351 # define pthread_cleanup_push(routine,arg) \
 352   { struct _pthread_cleanup_buffer _buffer;                                   \
 353     __pthread_cleanup_push (&_buffer, (routine), (arg));
 354
 355 extern void __pthread_cleanup_pop (struct _pthread_cleanup_buffer *buffer,
 356                                    int execute) attribute_hidden;
 357 # undef pthread_cleanup_pop
 358 # define pthread_cleanup_pop(execute) \
 359     __pthread_cleanup_pop (&_buffer, (execute)); }
 360 #endif
 361
 362 extern void __pthread_cleanup_push_defer (struct _pthread_cleanup_buffer *buffer,
 363                                           void (*routine) (void *), void *arg);
 364 extern void __pthread_cleanup_pop_restore (struct _pthread_cleanup_buffer *buffer,
 365                                            int execute);
 366
 367 /* Old cleanup interfaces, still used in libc.so.  */
 368 extern void _pthread_cleanup_push (struct _pthread_cleanup_buffer *buffer,
 369                                    void (*routine) (void *), void *arg);
 370 extern void _pthread_cleanup_pop (struct _pthread_cleanup_buffer *buffer,
 371                                   int execute);
 372 extern void _pthread_cleanup_push_defer (struct _pthread_cleanup_buffer *buffer,
 373                                          void (*routine) (void *), void *arg);
 374 extern void _pthread_cleanup_pop_restore (struct _pthread_cleanup_buffer *buffer,
 375                                           int execute);
 376
 377 #endif  /* pthreadP.h */