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