linker.h revision 8f2a5a0b40fc82126c691d5c30131d908772aab7
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 */ 281dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 291dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project#ifndef _LINKER_H_ 301dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project#define _LINKER_H_ 311dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 321dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project#include <unistd.h> 331dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project#include <sys/types.h> 349ec0f03a0d0b17bbb94ac0b9fef6add28a133c3aNick Kralevich#include <elf.h> 359ec0f03a0d0b17bbb94ac0b9fef6add28a133c3aNick Kralevich#include <sys/exec_elf.h> 361dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 37b7beb6907599b36809effe1b4db76039ac649518Pavel Chupin#include <link.h> 384688279db5dcc4004941e7f133c4a1c3617d842cElliott Hughes 398f2a5a0b40fc82126c691d5c30131d908772aab7Elliott Hughes#include "private/libc_logging.h" 40650be4e584eeab3591b9e273bfd6d169eea60853Elliott Hughes 41650be4e584eeab3591b9e273bfd6d169eea60853Elliott Hughes#define DL_ERR(fmt, x...) \ 42650be4e584eeab3591b9e273bfd6d169eea60853Elliott Hughes do { \ 43650be4e584eeab3591b9e273bfd6d169eea60853Elliott Hughes __libc_format_buffer(linker_get_error_buffer(), linker_get_error_buffer_size(), fmt, ##x); \ 44650be4e584eeab3591b9e273bfd6d169eea60853Elliott Hughes /* If LD_DEBUG is set high enough, log every dlerror(3) message. */ \ 45650be4e584eeab3591b9e273bfd6d169eea60853Elliott Hughes DEBUG("%s\n", linker_get_error_buffer()); \ 46650be4e584eeab3591b9e273bfd6d169eea60853Elliott Hughes } while(0) 47650be4e584eeab3591b9e273bfd6d169eea60853Elliott Hughes 481a6961650c82168864afe040dbdc05977db701dfElliott Hughes// Returns the address of the page containing address 'x'. 491a6961650c82168864afe040dbdc05977db701dfElliott Hughes#define PAGE_START(x) ((x) & PAGE_MASK) 50c1bd559d5b0fdcc25db2b6ae2705914103b24699David 'Digit' Turner 511a6961650c82168864afe040dbdc05977db701dfElliott Hughes// Returns the offset of address 'x' in its page. 521a6961650c82168864afe040dbdc05977db701dfElliott Hughes#define PAGE_OFFSET(x) ((x) & ~PAGE_MASK) 53c1bd559d5b0fdcc25db2b6ae2705914103b24699David 'Digit' Turner 541a6961650c82168864afe040dbdc05977db701dfElliott Hughes// Returns the address of the next page after address 'x', unless 'x' is 551a6961650c82168864afe040dbdc05977db701dfElliott Hughes// itself at the start of a page. 56c1bd559d5b0fdcc25db2b6ae2705914103b24699David 'Digit' Turner#define PAGE_END(x) PAGE_START((x) + (PAGE_SIZE-1)) 571dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 58d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes// Magic shared structures that GDB knows about. 59d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes 60ca0c11bd823f37f03cc8067cb182876827d5275aElliott Hughesstruct link_map_t { 61d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes uintptr_t l_addr; 62d4ee82dfa3ba01baa10e3ca48fcb31a27b8a4e81Brian Carlstrom char* l_name; 63d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes uintptr_t l_ld; 64ca0c11bd823f37f03cc8067cb182876827d5275aElliott Hughes link_map_t* l_next; 65ca0c11bd823f37f03cc8067cb182876827d5275aElliott Hughes link_map_t* l_prev; 661dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project}; 671dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 681dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project// Values for r_debug->state 691dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Projectenum { 70d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes RT_CONSISTENT, 71d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes RT_ADD, 72d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes RT_DELETE 731dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project}; 741dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 75d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughesstruct r_debug { 76d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes int32_t r_version; 77ca0c11bd823f37f03cc8067cb182876827d5275aElliott Hughes link_map_t* r_map; 78d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes void (*r_brk)(void); 79d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes int32_t r_state; 80d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes uintptr_t r_ldbase; 811dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project}; 821dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 831dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project#define FLAG_LINKED 0x00000001 841dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project#define FLAG_EXE 0x00000004 // The main executable 85468319ce4f3f7383d788b76c09cda2a405311f36Nick Kralevich#define FLAG_LINKER 0x00000010 // The linker itself 861dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 871dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project#define SOINFO_NAME_LEN 128 881dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 89ca0c11bd823f37f03cc8067cb182876827d5275aElliott Hughestypedef void (*linker_function_t)(); 90ca0c11bd823f37f03cc8067cb182876827d5275aElliott Hughes 9118a206c81d9743481e364384affd43306911283dElliott Hughesstruct soinfo { 92ca0c11bd823f37f03cc8067cb182876827d5275aElliott Hughes public: 93d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes char name[SOINFO_NAME_LEN]; 94d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes const Elf32_Phdr* phdr; 95ca0c11bd823f37f03cc8067cb182876827d5275aElliott Hughes size_t phnum; 96fa8c05dc00bb41ae8fe5cb5e4f82816e30f7f7b2Kito Cheng Elf32_Addr entry; 97fa8c05dc00bb41ae8fe5cb5e4f82816e30f7f7b2Kito Cheng Elf32_Addr base; 98d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes unsigned size; 991dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 100ca0c11bd823f37f03cc8067cb182876827d5275aElliott Hughes uint32_t unused1; // DO NOT USE, maintained for compatibility. 10138bccb271f121fc06eaa0d8fbd3c982bc44c36b7Nick Kralevich 102d4ee82dfa3ba01baa10e3ca48fcb31a27b8a4e81Brian Carlstrom Elf32_Dyn* dynamic; 1031dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 104ca0c11bd823f37f03cc8067cb182876827d5275aElliott Hughes uint32_t unused2; // DO NOT USE, maintained for compatibility 105ca0c11bd823f37f03cc8067cb182876827d5275aElliott Hughes uint32_t unused3; // DO NOT USE, maintained for compatibility 1061dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 107d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes soinfo* next; 108d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes unsigned flags; 1091dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 110d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes const char* strtab; 111d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes Elf32_Sym* symtab; 1121dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 113ca0c11bd823f37f03cc8067cb182876827d5275aElliott Hughes size_t nbucket; 114ca0c11bd823f37f03cc8067cb182876827d5275aElliott Hughes size_t nchain; 115d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes unsigned* bucket; 116d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes unsigned* chain; 1171dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 118d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes unsigned* plt_got; 1191dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 120d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes Elf32_Rel* plt_rel; 121ca0c11bd823f37f03cc8067cb182876827d5275aElliott Hughes size_t plt_rel_count; 1221dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 123d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes Elf32_Rel* rel; 124ca0c11bd823f37f03cc8067cb182876827d5275aElliott Hughes size_t rel_count; 1251dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 126ca0c11bd823f37f03cc8067cb182876827d5275aElliott Hughes linker_function_t* preinit_array; 127ca0c11bd823f37f03cc8067cb182876827d5275aElliott Hughes size_t preinit_array_count; 1281dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 129ca0c11bd823f37f03cc8067cb182876827d5275aElliott Hughes linker_function_t* init_array; 130ca0c11bd823f37f03cc8067cb182876827d5275aElliott Hughes size_t init_array_count; 131ca0c11bd823f37f03cc8067cb182876827d5275aElliott Hughes linker_function_t* fini_array; 132ca0c11bd823f37f03cc8067cb182876827d5275aElliott Hughes size_t fini_array_count; 1331dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 134ca0c11bd823f37f03cc8067cb182876827d5275aElliott Hughes linker_function_t init_func; 135ca0c11bd823f37f03cc8067cb182876827d5275aElliott Hughes linker_function_t fini_func; 1361dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 137d7daacb46372132ae3f0121647074936c304b572Raghu Gandham#if defined(ANDROID_ARM_LINKER) 138d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes // ARM EABI section used for stack unwinding. 139d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes unsigned* ARM_exidx; 140ca0c11bd823f37f03cc8067cb182876827d5275aElliott Hughes size_t ARM_exidx_count; 141d7daacb46372132ae3f0121647074936c304b572Raghu Gandham#elif defined(ANDROID_MIPS_LINKER) 142d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes unsigned mips_symtabno; 143d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes unsigned mips_local_gotno; 144d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes unsigned mips_gotsym; 1451dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project#endif 1461dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 147ca0c11bd823f37f03cc8067cb182876827d5275aElliott Hughes size_t ref_count; 148ca0c11bd823f37f03cc8067cb182876827d5275aElliott Hughes link_map_t link_map; 149e83c56dfbb6a9a61f0f18031620322af97e80162Evgeniy Stepanov 150d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes bool constructors_called; 1519ec0f03a0d0b17bbb94ac0b9fef6add28a133c3aNick Kralevich 152d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes // When you read a virtual address from the ELF file, add this 153d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes // value to get the corresponding address in the process' address space. 154d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes Elf32_Addr load_bias; 1555ae44f302b7d1d19f25c4c6f125e32dc369961d9Ard Biesheuvel 156d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes bool has_text_relocations; 157d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes bool has_DT_SYMBOLIC; 158d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes 159d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes void CallConstructors(); 160d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes void CallDestructors(); 161d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes void CallPreInitConstructors(); 162d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes 163d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes private: 164ca0c11bd823f37f03cc8067cb182876827d5275aElliott Hughes void CallArray(const char* array_name, linker_function_t* functions, size_t count, bool reverse); 165ca0c11bd823f37f03cc8067cb182876827d5275aElliott Hughes void CallFunction(const char* function_name, linker_function_t function); 1661dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project}; 1671dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 1681dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Projectextern soinfo libdl_info; 1691dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 170a6a3ac59243d8c95c94c3069e9332051f785c05fElliott Hughes// These aren't defined in <sys/exec_elf.h>. 1711dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project#ifndef DT_PREINIT_ARRAY 1721dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project#define DT_PREINIT_ARRAY 32 1731dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project#endif 1741dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project#ifndef DT_PREINIT_ARRAYSZ 1751dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project#define DT_PREINIT_ARRAYSZ 33 1761dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project#endif 1771dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 178cade4c36e7c9c62db3f476a0f9cfc329bac9acb7Elliott Hughesvoid do_android_update_LD_LIBRARY_PATH(const char* ld_library_path); 179e66190d2a97a713ae4b4786e60ca3d67ab8aa192Elliott Hughessoinfo* do_dlopen(const char* name, int flags); 180d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughesint do_dlclose(soinfo* si); 18116084168111cd7d2ac8a6b92e6fa6df5696928a5David 'Digit' Turner 182d4ee82dfa3ba01baa10e3ca48fcb31a27b8a4e81Brian CarlstromElf32_Sym* dlsym_linear_lookup(const char* name, soinfo** found, soinfo* start); 183d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughessoinfo* find_containing_library(const void* addr); 1841dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 185d4ee82dfa3ba01baa10e3ca48fcb31a27b8a4e81Brian CarlstromElf32_Sym* dladdr_find_symbol(soinfo* si, const void* addr); 186d4ee82dfa3ba01baa10e3ca48fcb31a27b8a4e81Brian CarlstromElf32_Sym* dlsym_handle_lookup(soinfo* si, const char* name); 187d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes 188d4ee82dfa3ba01baa10e3ca48fcb31a27b8a4e81Brian Carlstromvoid debuggerd_init(); 18918a206c81d9743481e364384affd43306911283dElliott Hughesextern "C" void notify_gdb_of_libraries(); 1904688279db5dcc4004941e7f133c4a1c3617d842cElliott Hughes 191650be4e584eeab3591b9e273bfd6d169eea60853Elliott Hugheschar* linker_get_error_buffer(); 192650be4e584eeab3591b9e273bfd6d169eea60853Elliott Hughessize_t linker_get_error_buffer_size(); 193650be4e584eeab3591b9e273bfd6d169eea60853Elliott Hughes 1941dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project#endif 195