Struct symbolic_debuginfo::pe::UnwindInfo

pub struct UnwindInfo<'a> {
    pub version: u8,
    pub size_of_prolog: u8,
    pub frame_register: Register,
    pub frame_register_offset: u32,
    pub chained_info: Option<RuntimeFunction>,
    pub handler: Option<UnwindHandler<'a>>,
    // some fields omitted
}

Unwind information for a function or portion of a function.

The unwind info structure is used to record the effects a function has on the stack pointer and where the nonvolatile registers are saved on the stack. The unwind codes can be enumerated with unwind_codes.

This unwind info might only be secondary information, and link to a chained unwind handler. For unwinding, this link shall be followed until the root unwind info record has been resolved.

Fields

version: u8

Version of this unwind info.

size_of_prolog: u8

Length of the function prolog in bytes.

frame_register: Register

The nonvolatile register used as the frame pointer of this function.

If this register is non-zero, all stack frame offsets used in unwind operations are of type StackFrameOffset::FP. When loading these offsets, they have to be based off the value of this frame register instead of the conventional RSP. This allows the RSP to be modified.

frame_register_offset: u32

Offset from RSP that is applied to the FP register when it is established.

When loading offsets of type StackFrameOffset::FP from the stack, this offset has to be subtracted before loading the value since the actual RSP was lower by that amount in the prolog.

chained_info: Option<RuntimeFunction>

A record pointing to chained unwind information.

If chained unwind info is present, then this unwind info is a secondary one and the linked unwind info contains primary information. Chained info is useful in two situations. First, it is used for noncontiguous code segments. Second, this mechanism is sometimes used to group volatile register saves.

The referenced unwind info can itself specify chained unwind information, until it arrives at the root unwind info. Generally, the entire chain should be considered when unwinding.

handler: Option<UnwindHandler<'a>>

An exception or termination handler called as part of the unwind.

Methods

impl<'a> UnwindInfo<'a>

pub fn parse(bytes: &'a [u8], offset: usize) -> Result<UnwindInfo<'a>, Error>

Parses unwind information from the image at the given offset.

Important traits for UnwindCodeIterator<'_>

impl<'_> Iterator for UnwindCodeIterator<'_> type Item = Result<UnwindCode, Error>;

pub fn unwind_codes(&self) -> UnwindCodeIterator<'a>

Returns an iterator over unwind codes in this unwind info.

Unwind codes are iterated in descending code_offset order suitable for unwinding. If the optional [chained_info] is present, codes of that unwind info should be interpreted immediately afterwards.

Trait Implementations

impl<'a, '_> IntoIterator for &'_ UnwindInfo<'a>

type Item = Result<UnwindCode, Error>

The type of the elements being iterated over.

type IntoIter = UnwindCodeIterator<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'_ UnwindInfo<'a> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<'_> Debug for UnwindInfo<'_>

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

Formats the value using the given formatter.

impl<'a> Clone for UnwindInfo<'a>

fn clone(&self) -> UnwindInfo<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.