bionic_tls.h revision 877ec6d90418ff1d6597147d355a2229fdffae7e
11dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project/* 21dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project * Copyright (C) 2008 The Android Open Source Project 31dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project * All rights reserved. 41dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project * 51dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project * Redistribution and use in source and binary forms, with or without 61dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project * modification, are permitted provided that the following conditions 71dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project * are met: 81dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project * * Redistributions of source code must retain the above copyright 91dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project * notice, this list of conditions and the following disclaimer. 101dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project * * Redistributions in binary form must reproduce the above copyright 111dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project * notice, this list of conditions and the following disclaimer in 121dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project * the documentation and/or other materials provided with the 131dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project * distribution. 141dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project * 151dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 161dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 171dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 181dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 191dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 201dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 211dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 221dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 231dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 241dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 251dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 261dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project * SUCH DAMAGE. 271dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project */ 282a0b873065edb304fa2d1c54f8de663ea638b8abElliott Hughes 292a0b873065edb304fa2d1c54f8de663ea638b8abElliott Hughes#ifndef __BIONIC_PRIVATE_BIONIC_TLS_H_ 302a0b873065edb304fa2d1c54f8de663ea638b8abElliott Hughes#define __BIONIC_PRIVATE_BIONIC_TLS_H_ 311dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 321dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project#include <sys/cdefs.h> 332a0b873065edb304fa2d1c54f8de663ea638b8abElliott Hughes#include "__get_tls.h" 341dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 351dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project__BEGIN_DECLS 361dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 371dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project/** WARNING WARNING WARNING 381dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project ** 391dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project ** This header file is *NOT* part of the public Bionic ABI/API 401dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project ** and should not be used/included by user-serviceable parts of 411dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project ** the system (e.g. applications). 421dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project ** 431dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project ** It is only provided here for the benefit of the system dynamic 441dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project ** linker and the OpenGL sub-system (which needs to access the 451dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project ** pre-allocated slot directly for performance reason). 461dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project **/ 471dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 48ad88a0863110798cef5169dcf917e18b967a7cf6Elliott Hughes/* Well-known TLS slots. What data goes in which slot is arbitrary unless otherwise noted. */ 4944b53ad6818de344e0b499ad8fdbb21fcb0ff2b6Elliott Hughesenum { 5044b53ad6818de344e0b499ad8fdbb21fcb0ff2b6Elliott Hughes TLS_SLOT_SELF = 0, /* The kernel requires this specific slot for x86. */ 5144b53ad6818de344e0b499ad8fdbb21fcb0ff2b6Elliott Hughes TLS_SLOT_THREAD_ID, 5244b53ad6818de344e0b499ad8fdbb21fcb0ff2b6Elliott Hughes TLS_SLOT_ERRNO, 533e898476c7230b60a0f76968e64ff25f475b48c0Elliott Hughes 54877ec6d90418ff1d6597147d355a2229fdffae7eElliott Hughes /* This slot in the child's TLS is used to synchronize the parent and child 55877ec6d90418ff1d6597147d355a2229fdffae7eElliott Hughes * during thread initialization. The child finishes with this mutex before 56877ec6d90418ff1d6597147d355a2229fdffae7eElliott Hughes * running any code that can set errno, so we can reuse the errno slot. */ 5770b24b1cc2a1a4436b1fea3f8b76616fdcb27224Elliott Hughes TLS_SLOT_START_MUTEX = TLS_SLOT_ERRNO, 5870b24b1cc2a1a4436b1fea3f8b76616fdcb27224Elliott Hughes 593e898476c7230b60a0f76968e64ff25f475b48c0Elliott Hughes /* These two aren't used by bionic itself, but allow the graphics code to 603e898476c7230b60a0f76968e64ff25f475b48c0Elliott Hughes * access TLS directly rather than using the pthread API. */ 6144b53ad6818de344e0b499ad8fdbb21fcb0ff2b6Elliott Hughes TLS_SLOT_OPENGL_API = 3, 6244b53ad6818de344e0b499ad8fdbb21fcb0ff2b6Elliott Hughes TLS_SLOT_OPENGL = 4, 633e898476c7230b60a0f76968e64ff25f475b48c0Elliott Hughes 643e898476c7230b60a0f76968e64ff25f475b48c0Elliott Hughes /* This slot is only used to pass information from the dynamic linker to 653e898476c7230b60a0f76968e64ff25f475b48c0Elliott Hughes * libc.so when the C library is loaded in to memory. The C runtime init 663e898476c7230b60a0f76968e64ff25f475b48c0Elliott Hughes * function will then clear it. Since its use is extremely temporary, 673e898476c7230b60a0f76968e64ff25f475b48c0Elliott Hughes * we reuse an existing location that isn't needed during libc startup. */ 683e898476c7230b60a0f76968e64ff25f475b48c0Elliott Hughes TLS_SLOT_BIONIC_PREINIT = TLS_SLOT_OPENGL_API, 693e898476c7230b60a0f76968e64ff25f475b48c0Elliott Hughes 7044b53ad6818de344e0b499ad8fdbb21fcb0ff2b6Elliott Hughes TLS_SLOT_STACK_GUARD = 5, /* GCC requires this specific slot for x86. */ 7144b53ad6818de344e0b499ad8fdbb21fcb0ff2b6Elliott Hughes TLS_SLOT_DLERROR, 721dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 7344b53ad6818de344e0b499ad8fdbb21fcb0ff2b6Elliott Hughes TLS_SLOT_FIRST_USER_SLOT /* Must come last! */ 7444b53ad6818de344e0b499ad8fdbb21fcb0ff2b6Elliott Hughes}; 755419b9474753d25dff947c7740532f86d130c0beElliott Hughes 763e898476c7230b60a0f76968e64ff25f475b48c0Elliott Hughes/* 773e898476c7230b60a0f76968e64ff25f475b48c0Elliott Hughes * Maximum number of elements in the TLS array. 783e898476c7230b60a0f76968e64ff25f475b48c0Elliott Hughes * POSIX says this must be at least 128, but Android has traditionally had only 64, minus those 793e898476c7230b60a0f76968e64ff25f475b48c0Elliott Hughes * ones used internally by bionic itself. 803e898476c7230b60a0f76968e64ff25f475b48c0Elliott Hughes * There are two kinds of slot used internally by bionic --- there are the well-known slots 813e898476c7230b60a0f76968e64ff25f475b48c0Elliott Hughes * enumerated above, and then there are those that are allocated during startup by calls to 823e898476c7230b60a0f76968e64ff25f475b48c0Elliott Hughes * pthread_key_create; grep for GLOBAL_INIT_THREAD_LOCAL_BUFFER to find those. We need to manually 833e898476c7230b60a0f76968e64ff25f475b48c0Elliott Hughes * maintain that second number, but pthread_test will fail if we forget. 84ef0bd1857041ffde069cf52138aaf22c1af7130eDavid 'Digit' Turner */ 853e898476c7230b60a0f76968e64ff25f475b48c0Elliott Hughes#define GLOBAL_INIT_THREAD_LOCAL_BUFFER_COUNT 4 86c03e1e74390c1b8a30341399cd85cc869d0842b0Elliott Hughes/* 87c03e1e74390c1b8a30341399cd85cc869d0842b0Elliott Hughes * This is PTHREAD_KEYS_MAX + TLS_SLOT_FIRST_USER_SLOT + GLOBAL_INIT_THREAD_LOCAL_BUFFER_COUNT 88c03e1e74390c1b8a30341399cd85cc869d0842b0Elliott Hughes * rounded up to maintain stack alignment. 89c03e1e74390c1b8a30341399cd85cc869d0842b0Elliott Hughes */ 90c03e1e74390c1b8a30341399cd85cc869d0842b0Elliott Hughes#define BIONIC_ALIGN(x, a) (((x) + (a - 1)) & ~(a - 1)) 91c03e1e74390c1b8a30341399cd85cc869d0842b0Elliott Hughes#define BIONIC_TLS_SLOTS BIONIC_ALIGN(128 + TLS_SLOT_FIRST_USER_SLOT + GLOBAL_INIT_THREAD_LOCAL_BUFFER_COUNT, 4) 921dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 931dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project__END_DECLS 941dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 95d3920b3a996b358e48232f417aa0a1e44a60f155Elliott Hughes#if defined(__cplusplus) 96edad1e1558bf5a561ffb33c5bf5ca0553711e1eeBernhard Rosenkraenzerclass KernelArgumentBlock; 97ce532721aaf61d4b6a171903c851ac82adf08aa8Elliott Hughesextern __LIBC_HIDDEN__ void __libc_init_tls(KernelArgumentBlock& args); 98d3920b3a996b358e48232f417aa0a1e44a60f155Elliott Hughes#endif 99d3920b3a996b358e48232f417aa0a1e44a60f155Elliott Hughes 1002a0b873065edb304fa2d1c54f8de663ea638b8abElliott Hughes#endif /* __BIONIC_PRIVATE_BIONIC_TLS_H_ */ 101