Struct gimli::read::cfi::UnwindContext

pub struct UnwindContext<R: Reader, A: UnwindContextStorage<R> = StoreOnHeap> {
    stack: ArrayVec<A::Stack>,
    initial_rule: Option<(Register, RegisterRule<R>)>,
    is_initialized: bool,
}

Common context needed when evaluating the call frame unwinding information.

This structure can be large so it is advisable to place it on the heap. To avoid re-allocating the context multiple times when evaluating multiple CFI programs, it can be reused.

use gimli::{UnwindContext, UnwindTable};

// An uninitialized context.
let mut ctx = Box::new(UnwindContext::new());

// Initialize the context by evaluating the CIE's initial instruction program,
// and generate the unwind table.
let mut table = some_fde.rows(&eh_frame, &bases, &mut ctx)?;
while let Some(row) = table.next_row()? {
    // Do stuff with each row...
}

Fields

stack: ArrayVec<A::Stack>

initial_rule: Option<(Register, RegisterRule<R>)>

is_initialized: bool

Implementations

impl<R: Reader> UnwindContext<R>

pub fn new() -> Self

Construct a new call frame unwinding context.

impl<R: Reader, A: UnwindContextStorage<R>> UnwindContext<R, A>

Signal Safe Methods

These methods are guaranteed not to allocate, acquire locks, or perform any other signal-unsafe operations, if an non-allocating storage is used.

pub fn new_in() -> Self

Construct a new call frame unwinding context.

fn initialize<Section: UnwindSection<R>>( &mut self, section: &Section, bases: &BaseAddresses, cie: &CommonInformationEntry<R> ) -> Result<()>

Run the CIE’s initial instructions and initialize this UnwindContext.

fn reset(&mut self)

fn row(&self) -> &UnwindTableRow<R, A>

fn row_mut(&mut self) -> &mut UnwindTableRow<R, A>

fn save_initial_rules(&mut self) -> Result<()>

fn start_address(&self) -> u64

fn set_start_address(&mut self, start_address: u64)

fn set_register_rule( &mut self, register: Register, rule: RegisterRule<R> ) -> Result<()>

fn get_initial_rule(&self, register: Register) -> Option<RegisterRule<R>>

Returns None if we have not completed evaluation of a CIE’s initial instructions.

fn set_cfa(&mut self, cfa: CfaRule<R>)

fn cfa_mut(&mut self) -> &mut CfaRule<R>

fn push_row(&mut self) -> Result<()>

fn pop_row(&mut self) -> Result<()>

Trait Implementations

impl<R: Clone + Reader, A: Clone + UnwindContextStorage<R>> Clone for UnwindContext<R, A>where A::Stack: Clone,

fn clone(&self) -> UnwindContext<R, A>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R: Reader, S: UnwindContextStorage<R>> Debug for UnwindContext<R, S>

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

Formats the value using the given formatter.

impl<R: Reader, A: UnwindContextStorage<R>> Default for UnwindContext<R, A>

fn default() -> Self

Returns the “default value” for a type.

impl<R: PartialEq + Reader, A: PartialEq + UnwindContextStorage<R>> PartialEq<UnwindContext<R, A>> for UnwindContext<R, A>where A::Stack: PartialEq,

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

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<R: Eq + Reader, A: Eq + UnwindContextStorage<R>> Eq for UnwindContext<R, A>where A::Stack: Eq,

impl<R: Reader, A: UnwindContextStorage<R>> StructuralEq for UnwindContext<R, A>

impl<R: Reader, A: UnwindContextStorage<R>> StructuralPartialEq for UnwindContext<R, A>