Struct gimli::read::UnwindTable

pub struct UnwindTable<'a, 'ctx, R, S = StoreOnHeap>
where
    R: Reader,
    S: UnwindContextStorage<R::Offset>,
{
    code_alignment_factor: Wrapping<u64>,
    data_alignment_factor: Wrapping<i64>,
    address_size: u8,
    next_start_address: u64,
    last_end_address: u64,
    returned_last_row: bool,
    current_row_valid: bool,
    instructions: CallFrameInstructionIter<'a, R>,
    ctx: &'ctx mut UnwindContext<R::Offset, S>,
}

The UnwindTable iteratively evaluates a FrameDescriptionEntry’s CallFrameInstruction program, yielding the each row one at a time.

6.4.1 Structure of Call Frame Information

DWARF supports virtual unwinding by defining an architecture independent basis for recording how procedures save and restore registers during their lifetimes. This basis must be augmented on some machines with specific information that is defined by an architecture specific ABI authoring committee, a hardware vendor, or a compiler producer. The body defining a specific augmentation is referred to below as the “augmenter.”

Abstractly, this mechanism describes a very large table that has the following structure:

LOC	CFA	R0	R1	...	RN
L0
L1
...
LN

The first column indicates an address for every location that contains code in a program. (In shared objects, this is an object-relative offset.) The remaining columns contain virtual unwinding rules that are associated with the indicated location.

The CFA column defines the rule which computes the Canonical Frame Address value; it may be either a register and a signed offset that are added together, or a DWARF expression that is evaluated.

The remaining columns are labeled by register number. This includes some registers that have special designation on some architectures such as the PC and the stack pointer register. (The actual mapping of registers for a particular architecture is defined by the augmenter.) The register columns contain rules that describe whether a given register has been saved and the rule to find the value for the register in the previous frame.

…

This table would be extremely large if actually constructed as described. Most of the entries at any point in the table are identical to the ones above them. The whole table can be represented quite compactly by recording just the differences starting at the beginning address of each subroutine in the program.

Fields

code_alignment_factor: Wrapping<u64>

data_alignment_factor: Wrapping<i64>

address_size: u8

next_start_address: u64

last_end_address: u64

returned_last_row: bool

current_row_valid: bool

instructions: CallFrameInstructionIter<'a, R>

ctx: &'ctx mut UnwindContext<R::Offset, S>

Implementations

impl<'a, 'ctx, R, S> UnwindTable<'a, 'ctx, R, S>

where R: Reader, S: UnwindContextStorage<R::Offset>,

Signal Safe Methods

These methods are guaranteed not to allocate, acquire locks, or perform any other signal-unsafe operations.

pub fn new<Section: UnwindSection<R>>( section: &'a Section, bases: &'a BaseAddresses, ctx: &'ctx mut UnwindContext<R::Offset, S>, fde: &FrameDescriptionEntry<R>, ) -> Result<Self>

Construct a new UnwindTable for the given FrameDescriptionEntry’s CFI unwinding program.

fn new_for_fde<Section: UnwindSection<R>>( section: &'a Section, bases: &'a BaseAddresses, ctx: &'ctx mut UnwindContext<R::Offset, S>, fde: &FrameDescriptionEntry<R>, ) -> Self

fn new_for_cie<Section: UnwindSection<R>>( section: &'a Section, bases: &'a BaseAddresses, ctx: &'ctx mut UnwindContext<R::Offset, S>, cie: &CommonInformationEntry<R>, ) -> Self

pub fn next_row(&mut self) -> Result<Option<&UnwindTableRow<R::Offset, S>>>

Evaluate call frame instructions until the next row of the table is completed, and return it.

Unfortunately, this cannot be used with FallibleIterator because of the restricted lifetime of the yielded item.

pub fn into_current_row(self) -> Option<&'ctx UnwindTableRow<R::Offset, S>>

Returns the current row with the lifetime of the context.

fn evaluate( &mut self, instruction: CallFrameInstruction<R::Offset>, ) -> Result<bool>

Evaluate one call frame instruction. Return Ok(true) if the row is complete, Ok(false) otherwise.

Trait Implementations

impl<'a, 'ctx, R, S> Debug for UnwindTable<'a, 'ctx, R, S>

where R: Reader + Debug, S: UnwindContextStorage<R::Offset> + Debug, R::Offset: Debug,

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

Formats the value using the given formatter.