Struct MachBufferFinalized 

pub struct MachBufferFinalized<T: CompilePhase> {
    pub unwind_info: SmallVec<[(CodeOffset, UnwindInst); 8]>,
    pub alignment: u32,
    pub nop_units: Vec<Vec<u8>>,
    /* private fields */
}

A MachBuffer once emission is completed: holds generated code and records, without fixups. This allows the type to be independent of the backend.

Fields

unwind_info: SmallVec<[(CodeOffset, UnwindInst); 8]>

Any unwind info at a given location.

alignment: u32

The required alignment of this buffer.

nop_units: Vec<Vec<u8>>

The means by which to NOP out patchable call sites.

This allows a consumer of a MachBufferFinalized to disable patchable call sites (which are enabled by default) without specific knowledge of the target ISA.

Each entry is one form of nop, and these are required to be sorted in ascending-size order.

Implementations

impl MachBufferFinalized<Stencil>

pub fn apply_base_srcloc( self, base_srcloc: SourceLoc, ) -> MachBufferFinalized<Final>

Get a finalized machine buffer by applying the function’s base source location.

impl<T: CompilePhase> MachBufferFinalized<T>

pub fn get_srclocs_sorted(&self) -> &[T::MachSrcLocType]

Get a list of source location mapping tuples in sorted-by-start-offset order.

pub fn debug_tags(&self) -> impl Iterator<Item = MachBufferDebugTagList<'_>>

Get all debug tags, sorted by associated offset.

pub fn total_size(&self) -> CodeOffset

Get the total required size for the code.

pub fn stringify_code_bytes(&self) -> String

Return the code in this mach buffer as a hex string for testing purposes.

pub fn data(&self) -> &[u8]

Get the code bytes.

pub fn data_mut(&mut self) -> &mut [u8]

Get a mutable slice of the code bytes, allowing patching post-passes.

pub fn relocs(&self) -> &[FinalizedMachReloc]

Get the list of external relocations for this code.

pub fn traps(&self) -> &[MachTrap]

Get the list of trap records for this code.

pub fn user_stack_maps(&self) -> &[(CodeOffset, u32, UserStackMap)]

Get the user stack map metadata for this code.

pub fn take_user_stack_maps( &mut self, ) -> SmallVec<[(CodeOffset, u32, UserStackMap); 8]>

Take this buffer’s user strack map metadata.

pub fn call_sites(&self) -> impl Iterator<Item = FinalizedMachCallSite<'_>> + '_

Get the list of call sites for this code, along with associated exception handlers.

Each item yielded by the returned iterator is a struct with:

• The call site metadata record, with a ret_addr field directly accessible and denoting the offset of the return address into this buffer’s code.
• The slice of pairs of exception tags and code offsets denoting exception-handler entry points associated with this call site.

pub fn frame_layout(&self) -> Option<&MachBufferFrameLayout>

Get the frame layout, if known.

pub fn patchable_call_sites( &self, ) -> impl Iterator<Item = &MachPatchableCallSite> + '_

Get the list of patchable call sites for this code.

Each location in the buffer contains the bytes for a call instruction to the specified target. If the call is to be patched out, the bytes in the region should be replaced with those given in the MachBufferFinalized::nop array, repeated as many times as necessary. (The length of the patchable region is guaranteed to be an integer multiple of that NOP unit size.)

Trait Implementations

impl<T: Clone + CompilePhase> Clone for MachBufferFinalized<T>

where T::MachSrcLocType: Clone,

fn clone(&self) -> MachBufferFinalized<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + CompilePhase> Debug for MachBufferFinalized<T>

where T::MachSrcLocType: Debug,

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

Formats the value using the given formatter.

impl<'de, T: CompilePhase> Deserialize<'de> for MachBufferFinalized<T>

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: PartialEq + CompilePhase> PartialEq for MachBufferFinalized<T>

where T::MachSrcLocType: PartialEq,

fn eq(&self, other: &MachBufferFinalized<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T: CompilePhase> Serialize for MachBufferFinalized<T>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: CompilePhase> StructuralPartialEq for MachBufferFinalized<T>