pthread_internal.h revision d26e780df66b9add4cf7e7ebb2f6c6749d1c5050 
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#include <stdatomic.h>
33
34#include "private/bionic_lock.h"
35#include "private/bionic_tls.h"
36
37/* Has the thread been detached by a pthread_join or pthread_detach call? */
38#define PTHREAD_ATTR_FLAG_DETACHED 0x00000001
39
40/* Has the thread been joined by another thread? */
41#define PTHREAD_ATTR_FLAG_JOINED 0x00000002
42
43struct pthread_key_data_t {
44  uintptr_t seq; // Use uintptr_t just for alignment, as we use pointer below.
45  void* data;
46};
47
48enum ThreadJoinState {
49  THREAD_NOT_JOINED,
50  THREAD_EXITED_NOT_JOINED,
51  THREAD_JOINED,
52  THREAD_DETACHED
53};
54
55struct pthread_internal_t {
56  struct pthread_internal_t* next;
57  struct pthread_internal_t* prev;
58
59  pid_t tid;
60
61 private:
62  pid_t cached_pid_;
63
64 public:
65  pid_t invalidate_cached_pid() {
66    pid_t old_value;
67    get_cached_pid(&old_value);
68    set_cached_pid(0);
69    return old_value;
70  }
71
72  void set_cached_pid(pid_t value) {
73    cached_pid_ = value;
74  }
75
76  bool get_cached_pid(pid_t* cached_pid) {
77    *cached_pid = cached_pid_;
78    return (*cached_pid != 0);
79  }
80
81  pthread_attr_t attr;
82
83  _Atomic(ThreadJoinState) join_state;
84
85  __pthread_cleanup_t* cleanup_stack;
86
87  void* (*start_routine)(void*);
88  void* start_routine_arg;
89  void* return_value;
90
91  void* alternate_signal_stack;
92
93  Lock startup_handshake_lock;
94
95  size_t mmap_size;
96
97  void* tls[BIONIC_TLS_SLOTS];
98
99  pthread_key_data_t key_data[BIONIC_PTHREAD_KEY_COUNT];
100
101  /*
102   * The dynamic linker implements dlerror(3), which makes it hard for us to implement this
103   * per-thread buffer by simply using malloc(3) and free(3).
104   */
105#define __BIONIC_DLERROR_BUFFER_SIZE 512
106  char dlerror_buffer[__BIONIC_DLERROR_BUFFER_SIZE];
107};
108
109__LIBC_HIDDEN__ int __init_thread(pthread_internal_t* thread);
110__LIBC_HIDDEN__ void __init_tls(pthread_internal_t* thread);
111__LIBC_HIDDEN__ void __init_alternate_signal_stack(pthread_internal_t*);
112
113__LIBC_HIDDEN__ pthread_t           __pthread_internal_add(pthread_internal_t* thread);
114__LIBC_HIDDEN__ pthread_internal_t* __pthread_internal_find(pthread_t pthread_id);
115__LIBC_HIDDEN__ void                __pthread_internal_remove(pthread_internal_t* thread);
116__LIBC_HIDDEN__ void                __pthread_internal_remove_and_free(pthread_internal_t* thread);
117
118// Make __get_thread() inlined for performance reason. See http://b/19825434.
119static inline __always_inline pthread_internal_t* __get_thread() {
120  return reinterpret_cast<pthread_internal_t*>(__get_tls()[TLS_SLOT_THREAD_ID]);
121}
122
123__LIBC_HIDDEN__ void pthread_key_clean_all(void);
124
125/*
126 * Traditionally we gave threads a 1MiB stack. When we started
127 * allocating per-thread alternate signal stacks to ease debugging of
128 * stack overflows, we subtracted the same amount we were using there
129 * from the default thread stack size. This should keep memory usage
130 * roughly constant.
131 */
132#define PTHREAD_STACK_SIZE_DEFAULT ((1 * 1024 * 1024) - SIGSTKSZ)
133
134// Leave room for a guard page in the internally created signal stacks.
135#if defined(__LP64__)
136// SIGSTKSZ is not big enough for 64-bit arch. See http://b/23041777.
137#define SIGNAL_STACK_SIZE (16 * 1024 + PAGE_SIZE)
138#else
139#define SIGNAL_STACK_SIZE (SIGSTKSZ + PAGE_SIZE)
140#endif
141
142/* Needed by fork. */
143__LIBC_HIDDEN__ extern void __bionic_atfork_run_prepare();
144__LIBC_HIDDEN__ extern void __bionic_atfork_run_child();
145__LIBC_HIDDEN__ extern void __bionic_atfork_run_parent();
146
147#endif /* _PTHREAD_INTERNAL_H_ */
148