Struct symbolic_debuginfo::elf::ElfObject

pub struct ElfObject<'d> { /* fields omitted */ }

Executable and Linkable Format, used for executables and libraries on Linux.

Methods

impl<'d> ElfObject<'d>

pub fn test(data: &[u8]) -> bool

Tests whether the buffer could contain an ELF object.

pub fn parse(data: &'d [u8]) -> Result<Self, ElfError>

Tries to parse an ELF object from the given slice.

pub fn file_format(&self) -> FileFormat

The container file format, which is always FileFormat::Elf.

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.

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.

pub fn arch(&self) -> Arch

The CPU architecture of this object, as specified in the ELF header.

pub fn kind(&self) -> ObjectKind

The kind of this object, as specified in the ELF header.

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.

pub fn has_symbols(&self) -> bool

Determines whether this object exposes a public symbol table.

Important traits for ElfSymbolIterator<'d, 'o>

impl<'d, 'o> Iterator for ElfSymbolIterator<'d, 'o> type Item = Symbol<'d>;

pub fn symbols(&self) -> ElfSymbolIterator<'d, '_>

Returns an iterator over symbols in the public symbol table.

pub fn symbol_map(&self) -> SymbolMap<'d>

Returns an ordered map of symbols in the symbol table.

pub fn has_debug_info(&self) -> bool

Determines whether this object contains debug information.

pub fn debug_session(&self) -> Result<DwarfDebugSession<'d>, 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.

pub fn has_unwind_info(&self) -> bool

Determines whether this object contains stack unwinding information.

pub fn data(&self) -> &'d [u8]

Returns the raw data of the ELF file.

Trait Implementations

impl<'d> ObjectLike for ElfObject<'d>

type Error = DwarfError

Errors thrown when reading information from this object.

type Session = DwarfDebugSession<'d>

A session that allows optimized access to debugging information.

fn file_format(&self) -> FileFormat

The container format of this file.

fn code_id(&self) -> Option<CodeId>

The code identifier of this object.

fn debug_id(&self) -> DebugId

The debug information identifier of this object.

fn arch(&self) -> Arch

The CPU architecture of this object.

fn kind(&self) -> ObjectKind

The kind of this object.

fn load_address(&self) -> u64

The address at which the image prefers to be loaded into memory.

fn has_symbols(&self) -> bool

Determines whether this object exposes a public symbol table.

fn symbols(&self) -> DynIterator<Symbol>

Returns an iterator over symbols in the public symbol table.

fn symbol_map(&self) -> SymbolMap

Returns an ordered map of symbols in the symbol table.

fn has_debug_info(&self) -> bool

Determines whether this object contains debug information.

fn debug_session(&self) -> Result<Self::Session, Self::Error>

Constructs a debugging session.

fn has_unwind_info(&self) -> bool

Determines whether this object contains stack unwinding information.

fn debug_file_name(&self) -> Option<Cow<str>>

The filename of the debug companion file.

impl<'d> Dwarf<'d> for ElfObject<'d>

fn endianity(&self) -> Endian

Returns whether the file was written on a big-endian or little-endian machine.

fn raw_section(&self, name: &str) -> Option<DwarfSection<'d>>

Returns information and raw data of a section.

fn section(&self, name: &str) -> Option<DwarfSection<'d>>

Returns information and data of a section.

fn has_section(&self, name: &str) -> bool

Determines whether the specified section exists.

impl<'_> Debug for ElfObject<'_>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'slf, 'd: 'slf> AsSelf<'slf> for ElfObject<'d>

type Ref = ElfObject<'slf>

The Self type with 'slf lifetimes, returned by as_self.

fn as_self(&'slf self) -> &Self::Ref

Returns a reference to self with downcasted lifetime.