Struct MachBufferFinalized

Source

pub struct MachBufferFinalized {
    pub nop_units: Vec<Vec<u8>>,
    /* private fields */
}

Expand description

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

Fields§

§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§

Source §

impl MachBufferFinalized

Source

pub fn apply_base_srcloc(&mut self, base_srcloc: SourceLoc)

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

Source §

impl MachBufferFinalized

Source

pub fn get_srclocs_sorted(&self) -> &[MachSrcLoc]

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

Source

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

Get all debug tags, sorted by associated offset.

Source

pub fn total_size(&self) -> CodeOffset

Get the total required size for the code.

Source

pub fn stringify_code_bytes(&self) -> String

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

Source

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

Get the code bytes.

Source

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

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

Source

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

Get the list of external relocations for this code.

Source

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

Get the list of trap records for this code.

Source

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

Get the user stack map metadata for this code.

Source

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

Take this buffer’s user stack map metadata.

Source

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

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.

Source

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

Get the frame layout, if known.

Source

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.)