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> 331887621de8a48eece8a05f2400ddd783b9833147Elliott Hughes#include <sys/limits.h> 3403eebcb6e8762e668a0d3af6bb303cccb88c5b81Christopher Ferris#include "bionic_macros.h" 352a0b873065edb304fa2d1c54f8de663ea638b8abElliott Hughes#include "__get_tls.h" 361dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 371dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project__BEGIN_DECLS 381dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 391dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project/** WARNING WARNING WARNING 401dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project ** 411dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project ** This header file is *NOT* part of the public Bionic ABI/API 421dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project ** and should not be used/included by user-serviceable parts of 431dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project ** the system (e.g. applications). 441dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project ** 451dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project ** It is only provided here for the benefit of the system dynamic 461dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project ** linker and the OpenGL sub-system (which needs to access the 471dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project ** pre-allocated slot directly for performance reason). 481dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project **/ 491dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 50b30aff405a220495941f1673b0a5e66c4fa8b84cElliott Hughes// Well-known TLS slots. What data goes in which slot is arbitrary unless otherwise noted. 5144b53ad6818de344e0b499ad8fdbb21fcb0ff2b6Elliott Hughesenum { 52b30aff405a220495941f1673b0a5e66c4fa8b84cElliott Hughes TLS_SLOT_SELF = 0, // The kernel requires this specific slot for x86. 5344b53ad6818de344e0b499ad8fdbb21fcb0ff2b6Elliott Hughes TLS_SLOT_THREAD_ID, 5444b53ad6818de344e0b499ad8fdbb21fcb0ff2b6Elliott Hughes TLS_SLOT_ERRNO, 553e898476c7230b60a0f76968e64ff25f475b48c0Elliott Hughes 56b30aff405a220495941f1673b0a5e66c4fa8b84cElliott Hughes // These two aren't used by bionic itself, but allow the graphics code to 57b30aff405a220495941f1673b0a5e66c4fa8b84cElliott Hughes // access TLS directly rather than using the pthread API. 5844b53ad6818de344e0b499ad8fdbb21fcb0ff2b6Elliott Hughes TLS_SLOT_OPENGL_API = 3, 5944b53ad6818de344e0b499ad8fdbb21fcb0ff2b6Elliott Hughes TLS_SLOT_OPENGL = 4, 603e898476c7230b60a0f76968e64ff25f475b48c0Elliott Hughes 61b30aff405a220495941f1673b0a5e66c4fa8b84cElliott Hughes // This slot is only used to pass information from the dynamic linker to 62b30aff405a220495941f1673b0a5e66c4fa8b84cElliott Hughes // libc.so when the C library is loaded in to memory. The C runtime init 63b30aff405a220495941f1673b0a5e66c4fa8b84cElliott Hughes // function will then clear it. Since its use is extremely temporary, 64b30aff405a220495941f1673b0a5e66c4fa8b84cElliott Hughes // we reuse an existing location that isn't needed during libc startup. 653e898476c7230b60a0f76968e64ff25f475b48c0Elliott Hughes TLS_SLOT_BIONIC_PREINIT = TLS_SLOT_OPENGL_API, 663e898476c7230b60a0f76968e64ff25f475b48c0Elliott Hughes 67b30aff405a220495941f1673b0a5e66c4fa8b84cElliott Hughes TLS_SLOT_STACK_GUARD = 5, // GCC requires this specific slot for x86. 6844b53ad6818de344e0b499ad8fdbb21fcb0ff2b6Elliott Hughes TLS_SLOT_DLERROR, 691dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 70b30aff405a220495941f1673b0a5e66c4fa8b84cElliott Hughes TLS_SLOT_FIRST_USER_SLOT // Must come last! 7144b53ad6818de344e0b499ad8fdbb21fcb0ff2b6Elliott Hughes}; 725419b9474753d25dff947c7740532f86d130c0beElliott Hughes 733e898476c7230b60a0f76968e64ff25f475b48c0Elliott Hughes/* 743e898476c7230b60a0f76968e64ff25f475b48c0Elliott Hughes * There are two kinds of slot used internally by bionic --- there are the well-known slots 753e898476c7230b60a0f76968e64ff25f475b48c0Elliott Hughes * enumerated above, and then there are those that are allocated during startup by calls to 763e898476c7230b60a0f76968e64ff25f475b48c0Elliott Hughes * pthread_key_create; grep for GLOBAL_INIT_THREAD_LOCAL_BUFFER to find those. We need to manually 773e898476c7230b60a0f76968e64ff25f475b48c0Elliott Hughes * maintain that second number, but pthread_test will fail if we forget. 78ef0bd1857041ffde069cf52138aaf22c1af7130eDavid 'Digit' Turner */ 792f68866f371faa8ef727fc91e59e1e93326a3949Elliott Hughes#define GLOBAL_INIT_THREAD_LOCAL_BUFFER_COUNT 5 801887621de8a48eece8a05f2400ddd783b9833147Elliott Hughes 8172bbd423579bb971dc06cdd3c06201faf3fe95e6Christopher Ferris#if defined(USE_JEMALLOC) 8272bbd423579bb971dc06cdd3c06201faf3fe95e6Christopher Ferris/* jemalloc uses 5 keys for itself. */ 8372bbd423579bb971dc06cdd3c06201faf3fe95e6Christopher Ferris#define BIONIC_TLS_RESERVED_SLOTS (GLOBAL_INIT_THREAD_LOCAL_BUFFER_COUNT + 5) 8472bbd423579bb971dc06cdd3c06201faf3fe95e6Christopher Ferris#else 8572bbd423579bb971dc06cdd3c06201faf3fe95e6Christopher Ferris#define BIONIC_TLS_RESERVED_SLOTS GLOBAL_INIT_THREAD_LOCAL_BUFFER_COUNT 8672bbd423579bb971dc06cdd3c06201faf3fe95e6Christopher Ferris#endif 8772bbd423579bb971dc06cdd3c06201faf3fe95e6Christopher Ferris 88c03e1e74390c1b8a30341399cd85cc869d0842b0Elliott Hughes/* 891887621de8a48eece8a05f2400ddd783b9833147Elliott Hughes * Maximum number of elements in the TLS array. 901887621de8a48eece8a05f2400ddd783b9833147Elliott Hughes * This includes space for pthread keys and our own internal slots. 911887621de8a48eece8a05f2400ddd783b9833147Elliott Hughes * We need to round up to maintain stack alignment. 92c03e1e74390c1b8a30341399cd85cc869d0842b0Elliott Hughes */ 9372bbd423579bb971dc06cdd3c06201faf3fe95e6Christopher Ferris#define BIONIC_TLS_SLOTS BIONIC_ALIGN(PTHREAD_KEYS_MAX + TLS_SLOT_FIRST_USER_SLOT + BIONIC_TLS_RESERVED_SLOTS, 4) 941dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 951dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project__END_DECLS 961dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 97d3920b3a996b358e48232f417aa0a1e44a60f155Elliott Hughes#if defined(__cplusplus) 98edad1e1558bf5a561ffb33c5bf5ca0553711e1eeBernhard Rosenkraenzerclass KernelArgumentBlock; 99ce532721aaf61d4b6a171903c851ac82adf08aa8Elliott Hughesextern __LIBC_HIDDEN__ void __libc_init_tls(KernelArgumentBlock& args); 100d3920b3a996b358e48232f417aa0a1e44a60f155Elliott Hughes#endif 101d3920b3a996b358e48232f417aa0a1e44a60f155Elliott Hughes 1022a0b873065edb304fa2d1c54f8de663ea638b8abElliott Hughes#endif /* __BIONIC_PRIVATE_BIONIC_TLS_H_ */ 103