Struct gimli::read::DebugFrame

pub struct DebugFrame<R: Reader> { /* fields omitted */ }

DebugFrame contains the .debug_frame section's frame unwinding information required to unwind to and recover registers from older frames on the stack. For example, this is useful for a debugger that wants to print locals in a backtrace.

Most interesting methods are defined in the UnwindSection trait.

Differences between .debug_frame and .eh_frame

While the .debug_frame section's information has a lot of overlap with the .eh_frame section's information, the .eh_frame information tends to only encode the subset of information needed for exception handling. Often, only one of .eh_frame or .debug_frame will be present in an object file.

Methods

impl<R: Reader> DebugFrame<R>

pub fn set_address_size(&mut self, address_size: u8)

Set the size of a target address in bytes.

This defaults to the native word size. This is only used if the CIE version is less than 4.

pub fn set_segment_size(&mut self, segment_size: u8)

Set the size of a segment selector in bytes.

This defaults to 0. This is only used if the CIE version is less than 4.

impl<'input, Endian> DebugFrame<EndianSlice<'input, Endian>> where
    Endian: Endianity, 

pub fn new(section: &'input [u8], endian: Endian) -> Self

Construct a new DebugFrame instance from the data in the .debug_frame section.

It is the caller's responsibility to read the section and present it as a &[u8] slice. That means using some ELF loader on Linux, a Mach-O loader on OSX, etc.

use gimli::{DebugFrame, NativeEndian};

// Use with `.debug_frame`
let debug_frame = DebugFrame::new(read_debug_frame_section_somehow(), NativeEndian);

Trait Implementations

impl<R: Clone + Reader> Clone for DebugFrame<R>

fn clone(&self) -> DebugFrame<R>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<R: Copy + Reader> Copy for DebugFrame<R>

impl<R: Debug + Reader> Debug for DebugFrame<R>

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

Formats the value using the given formatter.

impl<R: Eq + Reader> Eq for DebugFrame<R>

impl<R: Reader> From<R> for DebugFrame<R>

fn from(section: R) -> Self

Performs the conversion.

impl<R: PartialEq + Reader> PartialEq<DebugFrame<R>> for DebugFrame<R>

fn eq(&self, other: &DebugFrame<R>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &DebugFrame<R>) -> bool

This method tests for !=.

impl<R: Reader> Section<R> for DebugFrame<R>

fn id() -> SectionId

Returns the section id for this type.

fn reader(&self) -> &R

Returns the Reader for this section.

fn section_name() -> &'static str

Returns the ELF section name for this type.

fn load<F, E>(f: F) -> Result<Self, E> where
    F: FnOnce(SectionId) -> Result<R, E>, 

Try to load the section using the given loader function.

fn lookup_offset_id(&self, id: ReaderOffsetId) -> Option<(SectionId, R::Offset)> where
    R: Reader, 

Returns the Reader for this section.

impl<R: Reader> StructuralEq for DebugFrame<R>

impl<R: Reader> StructuralPartialEq for DebugFrame<R>

impl<R: Reader> UnwindSection<R> for DebugFrame<R>

type Offset = DebugFrameOffset<R::Offset>

The offset type associated with this CFI section. Either DebugFrameOffset or EhFrameOffset.

fn entries<'bases>(
    &self,
    bases: &'bases BaseAddresses
) -> CfiEntriesIter<'bases, Self, R>

Iterate over the CommonInformationEntrys and FrameDescriptionEntrys in this .debug_frame section.

fn cie_from_offset(
    &self,
    bases: &BaseAddresses,
    offset: Self::Offset
) -> Result<CommonInformationEntry<R>>

Parse the CommonInformationEntry at the given offset.

fn partial_fde_from_offset<'bases>(
    &self,
    bases: &'bases BaseAddresses,
    offset: Self::Offset
) -> Result<PartialFrameDescriptionEntry<'bases, Self, R>>

Parse the PartialFrameDescriptionEntry at the given offset.

fn fde_from_offset<F>(
    &self,
    bases: &BaseAddresses,
    offset: Self::Offset,
    get_cie: F
) -> Result<FrameDescriptionEntry<R>> where
    F: FnMut(&Self, &BaseAddresses, Self::Offset) -> Result<CommonInformationEntry<R>>, 

Parse the FrameDescriptionEntry at the given offset.

fn fde_for_address<F>(
    &self,
    bases: &BaseAddresses,
    address: u64,
    get_cie: F
) -> Result<FrameDescriptionEntry<R>> where
    F: FnMut(&Self, &BaseAddresses, Self::Offset) -> Result<CommonInformationEntry<R>>, 

Find the FrameDescriptionEntry for the given address.

fn unwind_info_for_address<F>(
    &self,
    bases: &BaseAddresses,
    ctx: &mut UninitializedUnwindContext<R>,
    address: u64,
    get_cie: F
) -> Result<UnwindTableRow<R>> where
    F: FnMut(&Self, &BaseAddresses, Self::Offset) -> Result<CommonInformationEntry<R>>, 

Find the frame unwind information for the given address.