libc/bionic/pthread_internal.h

   1 /*
   2  * Copyright (C) 2008 The Android Open Source Project
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *  * Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  *  * Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in
  12  *    the documentation and/or other materials provided with the
  13  *    distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  16  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  17  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  18  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  19  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  21  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
  22  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  23  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  24  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  25  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  */
  28 #ifndef _PTHREAD_INTERNAL_H_
  29 #define _PTHREAD_INTERNAL_H_
  30
  31 #include <pthread.h>
  32
  33 /* Has the thread been detached by a pthread_join or pthread_detach call? */
  34 #define PTHREAD_ATTR_FLAG_DETACHED 0x00000001
  35
  36 /* Was the thread's stack allocated by the user rather than by us? */
  37 #define PTHREAD_ATTR_FLAG_USER_ALLOCATED_STACK 0x00000002
  38
  39 /* Has the thread been joined by another thread? */
  40 #define PTHREAD_ATTR_FLAG_JOINED 0x00000004
  41
  42 /* Is this the main thread? */
  43 #define PTHREAD_ATTR_FLAG_MAIN_THREAD 0x80000000
  44
  45 struct pthread_internal_t {
  46   struct pthread_internal_t* next;
  47   struct pthread_internal_t* prev;
  48
  49   pid_t tid;
  50
  51  private:
  52   pid_t cached_pid_;
  53
  54  public:
  55   pid_t invalidate_cached_pid() {
  56     pid_t old_value;
  57     get_cached_pid(&old_value);
  58     set_cached_pid(0);
  59     return old_value;
  60   }
  61
  62   void set_cached_pid(pid_t value) {
  63     cached_pid_ = value;
  64   }
  65
  66   bool get_cached_pid(pid_t* cached_pid) {
  67     *cached_pid = cached_pid_;
  68     return (*cached_pid != 0);
  69   }
  70
  71   bool user_allocated_stack() {
  72     return (attr.flags & PTHREAD_ATTR_FLAG_USER_ALLOCATED_STACK) != 0;
  73   }
  74
  75   void** tls;
  76
  77   pthread_attr_t attr;
  78
  79   __pthread_cleanup_t* cleanup_stack;
  80
  81   void* (*start_routine)(void*);
  82   void* start_routine_arg;
  83   void* return_value;
  84
  85   void* alternate_signal_stack;
  86
  87   pthread_mutex_t startup_handshake_mutex;
  88
  89   /*
  90    * The dynamic linker implements dlerror(3), which makes it hard for us to implement this
  91    * per-thread buffer by simply using malloc(3) and free(3).
  92    */
  93 #define __BIONIC_DLERROR_BUFFER_SIZE 512
  94   char dlerror_buffer[__BIONIC_DLERROR_BUFFER_SIZE];
  95 };
  96
  97 __LIBC_HIDDEN__ int __init_thread(pthread_internal_t* thread, bool add_to_thread_list);
  98 __LIBC_HIDDEN__ void __init_tls(pthread_internal_t* thread);
  99 __LIBC_HIDDEN__ void __init_alternate_signal_stack(pthread_internal_t*);
 100 __LIBC_HIDDEN__ void _pthread_internal_add(pthread_internal_t* thread);
 101 __LIBC_HIDDEN__ pthread_internal_t* __get_thread(void);
 102
 103 __LIBC_HIDDEN__ void pthread_key_clean_all(void);
 104 __LIBC_HIDDEN__ void _pthread_internal_remove_locked(pthread_internal_t* thread);
 105
 106 /*
 107  * Traditionally we gave threads a 1MiB stack. When we started
 108  * allocating per-thread alternate signal stacks to ease debugging of
 109  * stack overflows, we subtracted the same amount we were using there
 110  * from the default thread stack size. This should keep memory usage
 111  * roughly constant.
 112  */
 113 #define PTHREAD_STACK_SIZE_DEFAULT ((1 * 1024 * 1024) - SIGSTKSZ)
 114
 115 __LIBC_HIDDEN__ extern pthread_internal_t* g_thread_list;
 116 __LIBC_HIDDEN__ extern pthread_mutex_t g_thread_list_lock;
 117
 118 __LIBC_HIDDEN__ int __timespec_from_absolute(timespec*, const timespec*, clockid_t);
 119
 120 /* Needed by fork. */
 121 __LIBC_HIDDEN__ extern void __bionic_atfork_run_prepare();
 122 __LIBC_HIDDEN__ extern void __bionic_atfork_run_child();
 123 __LIBC_HIDDEN__ extern void __bionic_atfork_run_parent();
 124
 125 #endif /* _PTHREAD_INTERNAL_H_ */