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 struct pthread_internal_t {
  34   struct pthread_internal_t* next;
  35   struct pthread_internal_t* prev;
  36
  37   pid_t tid;
  38
  39   void** tls;
  40
  41   pthread_attr_t attr;
  42
  43   __pthread_cleanup_t* cleanup_stack;
  44
  45   void* (*start_routine)(void*);
  46   void* start_routine_arg;
  47   void* return_value;
  48
  49   void* alternate_signal_stack;
  50
  51   /*
  52    * The dynamic linker implements dlerror(3), which makes it hard for us to implement this
  53    * per-thread buffer by simply using malloc(3) and free(3).
  54    */
  55 #define __BIONIC_DLERROR_BUFFER_SIZE 512
  56   char dlerror_buffer[__BIONIC_DLERROR_BUFFER_SIZE];
  57 };
  58
  59 __LIBC_HIDDEN__ int __init_thread(pthread_internal_t* thread, bool add_to_thread_list);
  60 __LIBC_HIDDEN__ void __init_tls(pthread_internal_t* thread);
  61 __LIBC_HIDDEN__ void __init_alternate_signal_stack(pthread_internal_t*);
  62 __LIBC_HIDDEN__ void _pthread_internal_add(pthread_internal_t* thread);
  63 __LIBC_HIDDEN__ pthread_internal_t* __get_thread(void);
  64
  65 __LIBC_HIDDEN__ void pthread_key_clean_all(void);
  66 __LIBC_HIDDEN__ void _pthread_internal_remove_locked(pthread_internal_t* thread);
  67
  68 /* Has the thread been detached by a pthread_join or pthread_detach call? */
  69 #define PTHREAD_ATTR_FLAG_DETACHED 0x00000001
  70
  71 /* Was the thread's stack allocated by the user rather than by us? */
  72 #define PTHREAD_ATTR_FLAG_USER_ALLOCATED_STACK 0x00000002
  73
  74 /* Has the thread been joined by another thread? */
  75 #define PTHREAD_ATTR_FLAG_JOINED 0x00000004
  76
  77 /* Is this the main thread? */
  78 #define PTHREAD_ATTR_FLAG_MAIN_THREAD 0x80000000
  79
  80 /*
  81  * Traditionally we give threads a 1MiB stack. When we started
  82  * allocating per-thread alternate signal stacks to ease debugging of
  83  * stack overflows, we subtracted the same amount we were using there
  84  * from the default thread stack size. This should keep memory usage
  85  * roughly constant.
  86  */
  87 #define PTHREAD_STACK_SIZE_DEFAULT ((1 * 1024 * 1024) - SIGSTKSZ)
  88
  89 __LIBC_HIDDEN__ extern pthread_internal_t* gThreadList;
  90 __LIBC_HIDDEN__ extern pthread_mutex_t gThreadListLock;
  91
  92 __LIBC_HIDDEN__ int __timespec_from_absolute(timespec*, const timespec*, clockid_t);
  93
  94 /* needed by fork.c */
  95 __LIBC_HIDDEN__ extern void __timer_table_start_stop(int);
  96 __LIBC_HIDDEN__ extern void __bionic_atfork_run_prepare();
  97 __LIBC_HIDDEN__ extern void __bionic_atfork_run_child();
  98 __LIBC_HIDDEN__ extern void __bionic_atfork_run_parent();
  99
 100 #endif /* _PTHREAD_INTERNAL_H_ */