pub struct ElfObject<'data> { /* private fields */ }
Expand description
Executable and Linkable Format, used for executables and libraries on Linux.
Implementations§
source§impl<'data> ElfObject<'data>
impl<'data> ElfObject<'data>
sourcepub fn parse(data: &'data [u8]) -> Result<ElfObject<'data>, ElfError>
pub fn parse(data: &'data [u8]) -> Result<ElfObject<'data>, ElfError>
Tries to parse an ELF object from the given slice. Will return a partially parsed ELF object if at least the program and section headers can be parsed.
sourcepub fn file_format(&self) -> FileFormat
pub fn file_format(&self) -> FileFormat
The container file format, which is always FileFormat::Elf
.
sourcepub fn code_id(&self) -> Option<CodeId>
pub fn code_id(&self) -> Option<CodeId>
The code identifier of this object.
As opposed to Mach-O, ELF does not specify a unique ID for object files in
its header. Compilers and linkers usually add either SHT_NOTE
sections or
PT_NOTE
program header elements for this purpose.
sourcepub fn debug_link(&self) -> Result<Option<DebugLink<'_>>, DebugLinkError<'_>>
pub fn debug_link(&self) -> Result<Option<DebugLink<'_>>, DebugLinkError<'_>>
The debug link of this object.
The debug link is an alternative to the build id for specifying the location of an ELF’s debugging information. It refers to a filename that can be used to build various debug paths where debuggers can look for the debug files.
Errors
- None if there is no gnu_debuglink section
- DebugLinkError if this section exists, but is malformed
sourcepub fn debug_id(&self) -> DebugId
pub fn debug_id(&self) -> DebugId
The debug information identifier of an ELF object.
The debug identifier is a rehash of the first 16 bytes of the code_id
, if
present. Otherwise, this function will hash the first page of the .text
section (program code) to synthesize a unique ID. This is likely not a valid
UUID since was generated off a hash value.
If all of the above fails, the identifier will be an empty DebugId
.
sourcepub fn arch(&self) -> Arch
pub fn arch(&self) -> Arch
The CPU architecture of this object, as specified in the ELF header.
sourcepub fn kind(&self) -> ObjectKind
pub fn kind(&self) -> ObjectKind
The kind of this object, as specified in the ELF header.
sourcepub fn load_address(&self) -> u64
pub fn load_address(&self) -> u64
The address at which the image prefers to be loaded into memory.
ELF files store all internal addresses as if it was loaded at that address. When the image is actually loaded, that spot might already be taken by other images and so it must be relocated to a new address. At runtime, a relocation table manages the arithmetics behind this.
Addresses used in symbols
or debug_session
have already been rebased relative to that
load address, so that the caller only has to deal with addresses relative to the actual
start of the image.
sourcepub fn has_symbols(&self) -> bool
pub fn has_symbols(&self) -> bool
Determines whether this object exposes a public symbol table.
sourcepub fn symbols(&self) -> ElfSymbolIterator<'data, '_> ⓘ
pub fn symbols(&self) -> ElfSymbolIterator<'data, '_> ⓘ
Returns an iterator over symbols in the public symbol table.
sourcepub fn symbol_map(&self) -> SymbolMap<'data>
pub fn symbol_map(&self) -> SymbolMap<'data>
Returns an ordered map of symbols in the symbol table.
sourcepub fn has_debug_info(&self) -> bool
pub fn has_debug_info(&self) -> bool
Determines whether this object contains debug information.
sourcepub fn debug_session(&self) -> Result<DwarfDebugSession<'data>, DwarfError>
pub fn debug_session(&self) -> Result<DwarfDebugSession<'data>, DwarfError>
Constructs a debugging session.
A debugging session loads certain information from the object file and creates caches for efficient access to various records in the debug information. Since this can be quite a costly process, try to reuse the debugging session as long as possible.
ELF files generally use DWARF debugging information, which is also used by MachO containers on macOS.
Constructing this session will also work if the object does not contain debugging
information, in which case the session will be a no-op. This can be checked via
has_debug_info
.
sourcepub fn has_unwind_info(&self) -> bool
pub fn has_unwind_info(&self) -> bool
Determines whether this object contains stack unwinding information.
sourcepub fn has_sources(&self) -> bool
pub fn has_sources(&self) -> bool
Determines whether this object contains embedded source.
sourcepub fn is_malformed(&self) -> bool
pub fn is_malformed(&self) -> bool
Determines whether this object is malformed and was only partially parsed