Struct StackMap

pub struct StackMap { /* private fields */ }

A map for determining where live GC references live in a stack frame.

Note that this is currently primarily documented as cranelift’s binemit::StackMap, so for detailed documentation about this please read the docs over there.

Implementations

impl StackMap

pub fn new(frame_size: u32, bits: CompoundBitSet) -> StackMap

Creates a new StackMap, typically from a preexisting binemit::StackMap.

pub fn frame_size(&self) -> u32

Returns the byte size of this stack map’s frame.

pub unsafe fn sp(&self, fp: *mut usize) -> *mut usize

Given a frame pointer, get the stack pointer.

Safety

The fp must be the frame pointer at the code offset that this stack map is associated with.

pub unsafe fn live_gc_refs( &self, sp: *mut usize, ) -> impl Iterator<Item = *mut u32> + '_

Given the stack pointer, get a reference to each live GC reference in the stack frame.

Safety

The sp must be the stack pointer at the code offset that this stack map is associated with.

Trait Implementations

impl Debug for StackMap

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StackMap

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for StackMap

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.