1cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng/* Backend hook signatures internal interface for libebl. 2cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng Copyright (C) 2000,2001,2002,2004,2005,2006,2007,2008 Red Hat, Inc. 3cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng This file is part of Red Hat elfutils. 4cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 5cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng Red Hat elfutils is free software; you can redistribute it and/or modify 6cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng it under the terms of the GNU General Public License as published by the 7cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng Free Software Foundation; version 2 of the License. 8cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 9cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng Red Hat elfutils is distributed in the hope that it will be useful, but 10cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng WITHOUT ANY WARRANTY; without even the implied warranty of 11cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 12cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng General Public License for more details. 13cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 14cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng You should have received a copy of the GNU General Public License along 15cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng with Red Hat elfutils; if not, write to the Free Software Foundation, 16cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA. 17cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 18cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng In addition, as a special exception, Red Hat, Inc. gives You the 19cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng additional right to link the code of Red Hat elfutils with code licensed 20cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng under any Open Source Initiative certified open source license 21cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng (http://www.opensource.org/licenses/index.php) which requires the 22cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng distribution of source code with any binary distribution and to 23cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng distribute linked combinations of the two. Non-GPL Code permitted under 24cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng this exception must only link to the code of Red Hat elfutils through 25cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng those well defined interfaces identified in the file named EXCEPTION 26cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng found in the source code files (the "Approved Interfaces"). The files 27cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng of Non-GPL Code may instantiate templates or use macros or inline 28cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng functions from the Approved Interfaces without causing the resulting 29cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng work to be covered by the GNU General Public License. Only Red Hat, 30cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng Inc. may make changes or additions to the list of Approved Interfaces. 31cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng Red Hat's grant of this exception is conditioned upon your not adding 32cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng any new exceptions. If you wish to add a new Approved Interface or 33cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng exception, please contact Red Hat. You must obey the GNU General Public 34cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng License in all respects for all of the Red Hat elfutils code and other 35cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng code used in conjunction with Red Hat elfutils except the Non-GPL Code 36cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng covered by this exception. If you modify this file, you may extend this 37cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng exception to your version of the file, but you are not obligated to do 38cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng so. If you do not wish to provide this exception without modification, 39cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng you must delete this exception statement from your version and license 40cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng this file solely under the GPL without exception. 41cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 42cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng Red Hat elfutils is an included package of the Open Invention Network. 43cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng An included package of the Open Invention Network is a package for which 44cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng Open Invention Network licensees cross-license their patents. No patent 45cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng license is granted, either expressly or impliedly, by designation as an 46cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng included package. Should you wish to participate in the Open Invention 47cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng Network licensing program, please visit www.openinventionnetwork.com 48cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng <http://www.openinventionnetwork.com>. */ 49cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 50cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng/* Return symbol representaton of object file type. */ 51cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Chengconst char *EBLHOOK(object_type_name) (int, char *, size_t); 52cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 53cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng/* Return symbolic representation of relocation type. */ 54cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Chengconst char *EBLHOOK(reloc_type_name) (int, char *, size_t); 55cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 56cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng/* Check relocation type. */ 57cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Chengbool EBLHOOK(reloc_type_check) (int); 58cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 59cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng/* Check if relocation type is for simple absolute relocations. */ 60cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben ChengElf_Type EBLHOOK(reloc_simple_type) (Ebl *, int); 61cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 62cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng/* Check relocation type use. */ 63cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Chengbool EBLHOOK(reloc_valid_use) (Elf *, int); 64cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 65cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng/* Return true if the symbol type is that referencing the GOT. */ 66cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Chengbool EBLHOOK(gotpc_reloc_check) (Elf *, int); 67cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 68cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng/* Return symbolic representation of segment type. */ 69cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Chengconst char *EBLHOOK(segment_type_name) (int, char *, size_t); 70cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 71cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng/* Return symbolic representation of section type. */ 72cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Chengconst char *EBLHOOK(section_type_name) (int, char *, size_t); 73cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 74cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng/* Return section name. */ 75cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Chengconst char *EBLHOOK(section_name) (int, int, char *, size_t); 76cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 77cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng/* Return next machine flag name. */ 78cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Chengconst char *EBLHOOK(machine_flag_name) (GElf_Word *); 79cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 80cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng/* Check whether machine flags are valid. */ 81cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Chengbool EBLHOOK(machine_flag_check) (GElf_Word); 82cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 83cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng/* Check whether SHF_MASKPROC flag bits are valid. */ 84cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Chengbool EBLHOOK(machine_section_flag_check) (GElf_Xword); 85cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 86cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng/* Check whether the section with the given index, header, and name 87cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng is a special machine section that is valid despite a combination 88cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng of flags or other details that are not generically valid. */ 89cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Chengbool EBLHOOK(check_special_section) (Ebl *, int, 90cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng const GElf_Shdr *, const char *); 91cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 92cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng/* Return symbolic representation of symbol type. */ 93cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Chengconst char *EBLHOOK(symbol_type_name) (int, char *, size_t); 94cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 95cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng/* Return symbolic representation of symbol binding. */ 96cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Chengconst char *EBLHOOK(symbol_binding_name) (int, char *, size_t); 97cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 98cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng/* Return symbolic representation of dynamic tag. */ 99cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Chengconst char *EBLHOOK(dynamic_tag_name) (int64_t, char *, size_t); 100cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 101cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng/* Check dynamic tag. */ 102cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Chengbool EBLHOOK(dynamic_tag_check) (int64_t); 103cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 104cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng/* Combine section header flags values. */ 105cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben ChengGElf_Word EBLHOOK(sh_flags_combine) (GElf_Word, GElf_Word); 106cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 107cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng/* Return symbolic representation of OS ABI. */ 108cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Chengconst char *EBLHOOK(osabi_name) (int, char *, size_t); 109cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 110cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng/* Name of a note entry type for core files. */ 111cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Chengconst char *EBLHOOK(core_note_type_name) (uint32_t, char *, size_t); 112cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 113cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng/* Name of a note entry type for object files. */ 114cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Chengconst char *EBLHOOK(object_note_type_name) (uint32_t, char *, size_t); 115cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 116cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng/* Describe core note format. */ 117cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Chengint EBLHOOK(core_note) (GElf_Word, GElf_Word, GElf_Word *, size_t *, 118cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng const Ebl_Register_Location **, 119cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng size_t *, const Ebl_Core_Item **); 120cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 121cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng/* Handle object file note. */ 122cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Chengbool EBLHOOK(object_note) (const char *, uint32_t, uint32_t, const char *); 123cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 124cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng/* Check object attribute. */ 125cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Chengbool EBLHOOK(check_object_attribute) (Ebl *, const char *, int, uint64_t, 126cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng const char **, const char **); 127cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 128cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng/* Describe auxv element type. */ 129cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Chengint EBLHOOK(auxv_info) (GElf_Xword, const char **, const char **); 130cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 131cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng/* Check section name for being that of a debug informatino section. */ 132cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Chengbool EBLHOOK(debugscn_p) (const char *); 133cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 134cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng/* Check whether given relocation is a copy relocation. */ 135cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Chengbool EBLHOOK(copy_reloc_p) (int); 136cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 137cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng/* Check whether given relocation is a no-op relocation. */ 138cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Chengbool EBLHOOK(none_reloc_p) (int); 139cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 140cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng/* Check whether given relocation is a relative relocation. */ 141cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Chengbool EBLHOOK(relative_reloc_p) (int); 142cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 143cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng/* Check whether given symbol's value is ok despite normal checks. */ 144cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Chengbool EBLHOOK(check_special_symbol) (Elf *, GElf_Ehdr *, const GElf_Sym *, 145cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng const char *, const GElf_Shdr *); 146cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 147cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng/* Check if backend uses a bss PLT in this file. */ 148cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Chengbool EBLHOOK(bss_plt_p) (Elf *, GElf_Ehdr *); 149cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 150cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng/* Return location expression to find return value given the 151cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng DW_AT_type DIE of a DW_TAG_subprogram DIE. */ 152cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Chengint EBLHOOK(return_value_location) (Dwarf_Die *functypedie, 153cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng const Dwarf_Op **locp); 154cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 155cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng/* Return register name information. */ 156cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Chengssize_t EBLHOOK(register_info) (Ebl *ebl, 157cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng int regno, char *name, size_t namelen, 158cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng const char **prefix, const char **setname, 159cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng int *bits, int *type); 160cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 161cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng/* Return system call ABI registers. */ 162cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Chengint EBLHOOK(syscall_abi) (Ebl *ebl, int *sp, int *pc, 163cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng int *callno, int args[6]); 164cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 165cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng/* Disassembler function. */ 166cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Chengint EBLHOOK(disasm) (const uint8_t **startp, const uint8_t *end, 167cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng GElf_Addr addr, const char *fmt, DisasmOutputCB_t outcb, 168cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng DisasmGetSymCB_t symcb, void *outcbarg, void *symcbarg); 169cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 170cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng 171cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Cheng/* Destructor for ELF backend handle. */ 172cc6695e2684ce93cdf8bd2da63d55d2cf49ff076Ben Chengvoid EBLHOOK(destr) (struct ebl *); 173