| /* Interface for libebl. |
| Copyright (C) 2000-2010 Red Hat, Inc. |
| This file is part of elfutils. |
| |
| This file is free software; you can redistribute it and/or modify |
| it under the terms of either |
| |
| * the GNU Lesser General Public License as published by the Free |
| Software Foundation; either version 3 of the License, or (at |
| your option) any later version |
| |
| or |
| |
| * the GNU General Public License as published by the Free |
| Software Foundation; either version 2 of the License, or (at |
| your option) any later version |
| |
| or both in parallel, as here. |
| |
| elfutils is distributed in the hope that it will be useful, but |
| WITHOUT ANY WARRANTY; without even the implied warranty of |
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| General Public License for more details. |
| |
| You should have received copies of the GNU General Public License and |
| the GNU Lesser General Public License along with this program. If |
| not, see <http://www.gnu.org/licenses/>. */ |
| |
| #ifndef _LIBEBL_H |
| #define _LIBEBL_H 1 |
| |
| #include <gelf.h> |
| #include "libdw.h" |
| #include <stdbool.h> |
| #include <stddef.h> |
| #include <stdint.h> |
| |
| #include "elf-knowledge.h" |
| |
| |
| /* Opaque type for the handle. */ |
| typedef struct ebl Ebl; |
| |
| |
| #ifdef __cplusplus |
| extern "C" { |
| #endif |
| |
| /* Get backend handle for object associated with ELF handle. */ |
| extern Ebl *ebl_openbackend (Elf *elf); |
| /* Similar but without underlying ELF file. */ |
| extern Ebl *ebl_openbackend_machine (GElf_Half machine); |
| /* Similar but with emulation name given. */ |
| extern Ebl *ebl_openbackend_emulation (const char *emulation); |
| |
| /* Free resources allocated for backend handle. */ |
| extern void ebl_closebackend (Ebl *bh); |
| |
| |
| /* Information about the descriptor. */ |
| |
| /* Get ELF machine. */ |
| extern int ebl_get_elfmachine (Ebl *ebl) __attribute__ ((__pure__)); |
| |
| /* Get ELF class. */ |
| extern int ebl_get_elfclass (Ebl *ebl) __attribute__ ((__pure__)); |
| |
| /* Get ELF data encoding. */ |
| extern int ebl_get_elfdata (Ebl *ebl) __attribute__ ((__pure__)); |
| |
| |
| /* Function to call the callback functions including default ELF |
| handling. */ |
| |
| /* Return backend name. */ |
| extern const char *ebl_backend_name (Ebl *ebl); |
| |
| /* Return relocation type name. */ |
| extern const char *ebl_object_type_name (Ebl *ebl, int object, |
| char *buf, size_t len); |
| |
| /* Return relocation type name. */ |
| extern const char *ebl_reloc_type_name (Ebl *ebl, int reloc, |
| char *buf, size_t len); |
| |
| /* Check relocation type. */ |
| extern bool ebl_reloc_type_check (Ebl *ebl, int reloc); |
| |
| /* Check relocation type use. */ |
| extern bool ebl_reloc_valid_use (Ebl *ebl, int reloc); |
| |
| /* Check if relocation type is for simple absolute relocations. |
| Return ELF_T_{BYTE,HALF,SWORD,SXWORD} for a simple type, else ELF_T_NUM. */ |
| extern Elf_Type ebl_reloc_simple_type (Ebl *ebl, int reloc); |
| |
| /* Return true if the symbol type is that referencing the GOT. E.g., |
| R_386_GOTPC. */ |
| extern bool ebl_gotpc_reloc_check (Ebl *ebl, int reloc); |
| |
| /* Return segment type name. */ |
| extern const char *ebl_segment_type_name (Ebl *ebl, int segment, |
| char *buf, size_t len); |
| |
| /* Return section type name. */ |
| extern const char *ebl_section_type_name (Ebl *ebl, int section, |
| char *buf, size_t len); |
| |
| /* Return section name. */ |
| extern const char *ebl_section_name (Ebl *ebl, int section, int xsection, |
| char *buf, size_t len, |
| const char *scnnames[], size_t shnum); |
| |
| /* Return machine flag names. */ |
| extern const char *ebl_machine_flag_name (Ebl *ebl, GElf_Word flags, |
| char *buf, size_t len); |
| |
| /* Check whether machine flag is valid. */ |
| extern bool ebl_machine_flag_check (Ebl *ebl, GElf_Word flags); |
| |
| /* Check whether SHF_MASKPROC flags are valid. */ |
| extern bool ebl_machine_section_flag_check (Ebl *ebl, GElf_Xword flags); |
| |
| /* Check whether the section with the given index, header, and name |
| is a special machine section that is valid despite a combination |
| of flags or other details that are not generically valid. */ |
| extern bool ebl_check_special_section (Ebl *ebl, int ndx, |
| const GElf_Shdr *shdr, const char *name); |
| |
| /* Return symbol type name. */ |
| extern const char *ebl_symbol_type_name (Ebl *ebl, int symbol, |
| char *buf, size_t len); |
| |
| /* Return symbol binding name. */ |
| extern const char *ebl_symbol_binding_name (Ebl *ebl, int binding, |
| char *buf, size_t len); |
| |
| /* Return dynamic tag name. */ |
| extern const char *ebl_dynamic_tag_name (Ebl *ebl, int64_t tag, |
| char *buf, size_t len); |
| |
| /* Check dynamic tag. */ |
| extern bool ebl_dynamic_tag_check (Ebl *ebl, int64_t tag); |
| |
| /* Check whether given symbol's st_value and st_size are OK despite failing |
| normal checks. */ |
| extern bool ebl_check_special_symbol (Ebl *ebl, GElf_Ehdr *ehdr, |
| const GElf_Sym *sym, const char *name, |
| const GElf_Shdr *destshdr); |
| |
| /* Check whether only valid bits are set on the st_other symbol flag. */ |
| extern bool ebl_check_st_other_bits (Ebl *ebl, unsigned char st_other); |
| |
| /* Return combined section header flags value. */ |
| extern GElf_Word ebl_sh_flags_combine (Ebl *ebl, GElf_Word flags1, |
| GElf_Word flags2); |
| |
| /* Return symbolic representation of OS ABI. */ |
| extern const char *ebl_osabi_name (Ebl *ebl, int osabi, char *buf, size_t len); |
| |
| |
| /* Return name of the note section type for a core file. */ |
| extern const char *ebl_core_note_type_name (Ebl *ebl, uint32_t type, char *buf, |
| size_t len); |
| |
| /* Return name of the note section type for an object file. */ |
| extern const char *ebl_object_note_type_name (Ebl *ebl, const char *name, |
| uint32_t type, char *buf, |
| size_t len); |
| |
| /* Print information about object note if available. */ |
| extern void ebl_object_note (Ebl *ebl, const char *name, uint32_t type, |
| uint32_t descsz, const char *desc); |
| |
| /* Check whether an attribute in a .gnu_attributes section is recognized. |
| Fills in *TAG_NAME with the name for this tag. |
| If VALUE is a known value for that tag, also fills in *VALUE_NAME. */ |
| extern bool ebl_check_object_attribute (Ebl *ebl, const char *vendor, |
| int tag, uint64_t value, |
| const char **tag_name, |
| const char **value_name); |
| |
| |
| /* Check section name for being that of a debug informatino section. */ |
| extern bool ebl_debugscn_p (Ebl *ebl, const char *name); |
| |
| /* Check whether given relocation is a copy relocation. */ |
| extern bool ebl_copy_reloc_p (Ebl *ebl, int reloc); |
| |
| /* Check whether given relocation is a no-op relocation. */ |
| extern bool ebl_none_reloc_p (Ebl *ebl, int reloc); |
| |
| /* Check whether given relocation is a relative relocation. */ |
| extern bool ebl_relative_reloc_p (Ebl *ebl, int reloc); |
| |
| /* Check whether section should be stripped. */ |
| extern bool ebl_section_strip_p (Ebl *ebl, const GElf_Ehdr *ehdr, |
| const GElf_Shdr *shdr, const char *name, |
| bool remove_comment, bool only_remove_debug); |
| |
| /* Check if backend uses a bss PLT in this file. */ |
| extern bool ebl_bss_plt_p (Ebl *ebl, GElf_Ehdr *ehdr); |
| |
| /* Return size of entry in SysV-style hash table. */ |
| extern int ebl_sysvhash_entrysize (Ebl *ebl); |
| |
| /* Return location expression to find return value given a |
| DW_TAG_subprogram, DW_TAG_subroutine_type, or similar DIE describing |
| function itself (whose DW_AT_type attribute describes its return type). |
| Returns -1 for a libdw error (see dwarf_errno). |
| Returns -2 for an unrecognized type formation. |
| Returns zero if the function has no return value (e.g. "void" in C). |
| Otherwise, *LOCOPS gets a location expression to find the return value, |
| and returns the number of operations in the expression. The pointer is |
| permanently allocated at least as long as the Ebl handle is open. */ |
| extern int ebl_return_value_location (Ebl *ebl, |
| Dwarf_Die *functypedie, |
| const Dwarf_Op **locops); |
| |
| /* Fill in register information given DWARF register numbers. |
| If NAME is null, return the maximum REGNO + 1 that has a name. |
| Otherwise, store in NAME the name for DWARF register number REGNO |
| and return the number of bytes written (including '\0' terminator). |
| Return -1 if NAMELEN is too short or REGNO is negative or too large. |
| Return 0 if REGNO is unused (a gap in the DWARF number assignment). |
| On success, set *SETNAME to a description like "integer" or "FPU" |
| fit for "%s registers" title display, and *PREFIX to the string |
| that precedes NAME in canonical assembler syntax (e.g. "%" or "$"). |
| The NAME string contains identifier characters only (maybe just digits). */ |
| extern ssize_t ebl_register_info (Ebl *ebl, |
| int regno, char *name, size_t namelen, |
| const char **prefix, const char **setname, |
| int *bits, int *type); |
| |
| /* Fill in the DWARF register numbers for the registers used in system calls. |
| The SP and PC are what kernel reports call the user stack pointer and PC. |
| The CALLNO and ARGS are the system call number and incoming arguments. |
| Each of these is filled with the DWARF register number corresponding, |
| or -1 if there is none. Returns zero when the information is available. */ |
| extern int ebl_syscall_abi (Ebl *ebl, int *sp, int *pc, |
| int *callno, int args[6]); |
| |
| /* Supply the ABI-specified state of DWARF CFI before CIE initial programs. |
| |
| The DWARF 3.0 spec says that the default initial states of all registers |
| are "undefined", unless otherwise specified by the machine/compiler ABI. |
| |
| This default is wrong for every machine with the CFI generated by GCC. |
| The EH unwinder does not really distinguish "same_value" and "undefined", |
| since it doesn't matter for unwinding (in either case there is no change |
| to make for that register). GCC generates CFI that says nothing at all |
| about registers it hasn't spilled somewhere. For our unwinder to give |
| the true story, the backend must supply an initial state that uses |
| "same_value" rules for all the callee-saves registers. |
| |
| This can fill in the initial_instructions, initial_instructions_end |
| members of *ABI_INFO to point at a CFI instruction stream to process |
| before each CIE's initial instructions. It should set the |
| data_alignment_factor member if it affects the initial instructions. |
| |
| As a shorthand for some common cases, for this instruction stream |
| we overload some CFI instructions that cannot be used in a CIE: |
| |
| DW_CFA_restore -- Change default rule for all unmentioned |
| registers from undefined to same_value. |
| |
| This function can also fill in ABI_INFO->return_address_register with the |
| DWARF register number that identifies the actual PC in machine state. |
| If there is no canonical DWARF register number with that meaning, it's |
| left unchanged (callers usually initialize with (Dwarf_Word) -1). |
| This value is not used by CFI per se. |
| |
| Function returns 0 on success and -1 for error or unsupported by the |
| backend. */ |
| extern int ebl_abi_cfi (Ebl *ebl, Dwarf_CIE *abi_info) |
| __nonnull_attribute__ (2); |
| |
| /* ELF string table handling. */ |
| struct Ebl_Strtab; |
| struct Ebl_Strent; |
| |
| /* Create new ELF string table object in memory. */ |
| extern struct Ebl_Strtab *ebl_strtabinit (bool nullstr); |
| |
| /* Free resources allocated for ELF string table ST. */ |
| extern void ebl_strtabfree (struct Ebl_Strtab *st); |
| |
| /* Add string STR (length LEN is != 0) to ELF string table ST. */ |
| extern struct Ebl_Strent *ebl_strtabadd (struct Ebl_Strtab *st, |
| const char *str, size_t len); |
| |
| /* Finalize string table ST and store size and memory location information |
| in DATA. */ |
| extern void ebl_strtabfinalize (struct Ebl_Strtab *st, Elf_Data *data); |
| |
| /* Get offset in string table for string associated with SE. */ |
| extern size_t ebl_strtaboffset (struct Ebl_Strent *se); |
| |
| /* Return the string associated with SE. */ |
| extern const char *ebl_string (struct Ebl_Strent *se); |
| |
| |
| /* ELF wide char string table handling. */ |
| struct Ebl_WStrtab; |
| struct Ebl_WStrent; |
| |
| /* Create new ELF wide char string table object in memory. */ |
| extern struct Ebl_WStrtab *ebl_wstrtabinit (bool nullstr); |
| |
| /* Free resources allocated for ELF wide char string table ST. */ |
| extern void ebl_wstrtabfree (struct Ebl_WStrtab *st); |
| |
| /* Add string STR (length LEN is != 0) to ELF string table ST. */ |
| extern struct Ebl_WStrent *ebl_wstrtabadd (struct Ebl_WStrtab *st, |
| const wchar_t *str, size_t len); |
| |
| /* Finalize string table ST and store size and memory location information |
| in DATA. */ |
| extern void ebl_wstrtabfinalize (struct Ebl_WStrtab *st, Elf_Data *data); |
| |
| /* Get offset in wide char string table for string associated with SE. */ |
| extern size_t ebl_wstrtaboffset (struct Ebl_WStrent *se); |
| |
| |
| /* Generic string table handling. */ |
| struct Ebl_GStrtab; |
| struct Ebl_GStrent; |
| |
| /* Create new string table object in memory. */ |
| extern struct Ebl_GStrtab *ebl_gstrtabinit (unsigned int width, bool nullstr); |
| |
| /* Free resources allocated for string table ST. */ |
| extern void ebl_gstrtabfree (struct Ebl_GStrtab *st); |
| |
| /* Add string STR (length LEN is != 0) to string table ST. */ |
| extern struct Ebl_GStrent *ebl_gstrtabadd (struct Ebl_GStrtab *st, |
| const char *str, size_t len); |
| |
| /* Finalize string table ST and store size and memory location information |
| in DATA. */ |
| extern void ebl_gstrtabfinalize (struct Ebl_GStrtab *st, Elf_Data *data); |
| |
| /* Get offset in wide char string table for string associated with SE. */ |
| extern size_t ebl_gstrtaboffset (struct Ebl_GStrent *se); |
| |
| |
| /* Register map info. */ |
| typedef struct |
| { |
| Dwarf_Half offset; /* Byte offset in register data block. */ |
| Dwarf_Half regno; /* DWARF register number. */ |
| uint8_t bits; /* Bits of data for one register. */ |
| uint8_t pad; /* Bytes of padding after register's data. */ |
| Dwarf_Half count; /* Consecutive register numbers here. */ |
| } Ebl_Register_Location; |
| |
| /* Non-register data items in core notes. */ |
| typedef struct |
| { |
| const char *name; /* Printable identifier. */ |
| const char *group; /* Identifier for category of related items. */ |
| Dwarf_Half offset; /* Byte offset in note data. */ |
| Dwarf_Half count; |
| Elf_Type type; |
| char format; |
| bool thread_identifier; |
| } Ebl_Core_Item; |
| |
| /* Describe the format of a core file note with the given header and NAME. |
| NAME is not guaranteed terminated, it's NHDR->n_namesz raw bytes. */ |
| extern int ebl_core_note (Ebl *ebl, const GElf_Nhdr *nhdr, const char *name, |
| GElf_Word *regs_offset, size_t *nregloc, |
| const Ebl_Register_Location **reglocs, |
| size_t *nitems, const Ebl_Core_Item **items) |
| __nonnull_attribute__ (1, 2, 3, 4, 5, 6, 7, 8); |
| |
| /* Describe the auxv type number. */ |
| extern int ebl_auxv_info (Ebl *ebl, GElf_Xword a_type, |
| const char **name, const char **format) |
| __nonnull_attribute__ (1, 3, 4); |
| |
| |
| #ifdef __cplusplus |
| } |
| #endif |
| |
| #endif /* libebl.h */ |