linker.h revision 650be4e584eeab3591b9e273bfd6d169eea60853
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 39650be4e584eeab3591b9e273bfd6d169eea60853Elliott Hughes#include <private/debug_format.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 60d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughesstruct link_map { 61d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes uintptr_t l_addr; 62d4ee82dfa3ba01baa10e3ca48fcb31a27b8a4e81Brian Carlstrom char* l_name; 63d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes uintptr_t l_ld; 64d4ee82dfa3ba01baa10e3ca48fcb31a27b8a4e81Brian Carlstrom struct link_map* l_next; 65d4ee82dfa3ba01baa10e3ca48fcb31a27b8a4e81Brian Carlstrom struct link_map* 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; 77d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes struct link_map* 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 8918a206c81d9743481e364384affd43306911283dElliott Hughesstruct soinfo { 90d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes char name[SOINFO_NAME_LEN]; 91d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes const Elf32_Phdr* phdr; 92d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes int phnum; 93d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes unsigned entry; 94d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes unsigned base; 95d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes unsigned size; 961dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 97d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes int unused; // DO NOT USE, maintained for compatibility. 9838bccb271f121fc06eaa0d8fbd3c982bc44c36b7Nick Kralevich 99d4ee82dfa3ba01baa10e3ca48fcb31a27b8a4e81Brian Carlstrom Elf32_Dyn* dynamic; 1001dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 101d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes unsigned unused2; // DO NOT USE, maintained for compatibility 102d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes unsigned unused3; // DO NOT USE, maintained for compatibility 1031dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 104d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes soinfo* next; 105d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes unsigned flags; 1061dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 107d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes const char* strtab; 108d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes Elf32_Sym* symtab; 1091dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 110d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes unsigned nbucket; 111d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes unsigned nchain; 112d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes unsigned* bucket; 113d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes unsigned* chain; 1141dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 115d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes unsigned* plt_got; 1161dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 117d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes Elf32_Rel* plt_rel; 118d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes unsigned plt_rel_count; 1191dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 120d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes Elf32_Rel* rel; 121d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes unsigned rel_count; 1221dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 123d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes unsigned* preinit_array; 124d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes unsigned preinit_array_count; 1251dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 126d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes unsigned* init_array; 127d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes unsigned init_array_count; 128d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes unsigned* fini_array; 129d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes unsigned fini_array_count; 1301dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 131d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes void (*init_func)(); 132d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes void (*fini_func)(); 1331dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 134d7daacb46372132ae3f0121647074936c304b572Raghu Gandham#if defined(ANDROID_ARM_LINKER) 135d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes // ARM EABI section used for stack unwinding. 136d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes unsigned* ARM_exidx; 137d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes unsigned ARM_exidx_count; 138d7daacb46372132ae3f0121647074936c304b572Raghu Gandham#elif defined(ANDROID_MIPS_LINKER) 139d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes unsigned mips_symtabno; 140d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes unsigned mips_local_gotno; 141d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes unsigned mips_gotsym; 1421dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project#endif 1431dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 144d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes unsigned refcount; 145d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes struct link_map linkmap; 146e83c56dfbb6a9a61f0f18031620322af97e80162Evgeniy Stepanov 147d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes bool constructors_called; 1489ec0f03a0d0b17bbb94ac0b9fef6add28a133c3aNick Kralevich 149d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes // When you read a virtual address from the ELF file, add this 150d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes // value to get the corresponding address in the process' address space. 151d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes Elf32_Addr load_bias; 1525ae44f302b7d1d19f25c4c6f125e32dc369961d9Ard Biesheuvel 153d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes bool has_text_relocations; 154d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes bool has_DT_SYMBOLIC; 155d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes 156d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes void CallConstructors(); 157d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes void CallDestructors(); 158d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes void CallPreInitConstructors(); 159d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes 160d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes private: 161d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes void CallArray(const char* array_name, unsigned* array, int count, bool reverse); 162d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes void CallFunction(const char* function_name, void (*function)()); 1631dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project}; 1641dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 1651dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Projectextern soinfo libdl_info; 1661dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 167a6a3ac59243d8c95c94c3069e9332051f785c05fElliott Hughes// These aren't defined in <sys/exec_elf.h>. 1681dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project#ifndef DT_PREINIT_ARRAY 1691dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project#define DT_PREINIT_ARRAY 32 1701dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project#endif 1711dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project#ifndef DT_PREINIT_ARRAYSZ 1721dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project#define DT_PREINIT_ARRAYSZ 33 1731dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project#endif 1741dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 175cade4c36e7c9c62db3f476a0f9cfc329bac9acb7Elliott Hughesvoid do_android_update_LD_LIBRARY_PATH(const char* ld_library_path); 176e66190d2a97a713ae4b4786e60ca3d67ab8aa192Elliott Hughessoinfo* do_dlopen(const char* name, int flags); 177d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughesint do_dlclose(soinfo* si); 17816084168111cd7d2ac8a6b92e6fa6df5696928a5David 'Digit' Turner 179d4ee82dfa3ba01baa10e3ca48fcb31a27b8a4e81Brian CarlstromElf32_Sym* dlsym_linear_lookup(const char* name, soinfo** found, soinfo* start); 180d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughessoinfo* find_containing_library(const void* addr); 1811dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project 182d4ee82dfa3ba01baa10e3ca48fcb31a27b8a4e81Brian CarlstromElf32_Sym* dladdr_find_symbol(soinfo* si, const void* addr); 183d4ee82dfa3ba01baa10e3ca48fcb31a27b8a4e81Brian CarlstromElf32_Sym* dlsym_handle_lookup(soinfo* si, const char* name); 184d23736e4f228e46304b7cbc674a1d0094d73e0f5Elliott Hughes 185d4ee82dfa3ba01baa10e3ca48fcb31a27b8a4e81Brian Carlstromvoid debuggerd_init(); 18618a206c81d9743481e364384affd43306911283dElliott Hughesextern "C" void notify_gdb_of_libraries(); 1874688279db5dcc4004941e7f133c4a1c3617d842cElliott Hughes 188650be4e584eeab3591b9e273bfd6d169eea60853Elliott Hugheschar* linker_get_error_buffer(); 189650be4e584eeab3591b9e273bfd6d169eea60853Elliott Hughessize_t linker_get_error_buffer_size(); 190650be4e584eeab3591b9e273bfd6d169eea60853Elliott Hughes 1911dc9e472e19acfe6dc7f41e429236e7eef7ceda1The Android Open Source Project#endif 192