Struct cranelift_module::DataDescription

pub struct DataDescription {
    pub init: Init,
    pub function_decls: PrimaryMap<FuncRef, ModuleRelocTarget>,
    pub data_decls: PrimaryMap<GlobalValue, ModuleRelocTarget>,
    pub function_relocs: Vec<(CodeOffset, FuncRef)>,
    pub data_relocs: Vec<(CodeOffset, GlobalValue, Addend)>,
    pub custom_segment_section: Option<(String, String)>,
    pub align: Option<u64>,
}

A description of a data object.

Fields

init: Init

How the data should be initialized.

function_decls: PrimaryMap<FuncRef, ModuleRelocTarget>

External function declarations.

data_decls: PrimaryMap<GlobalValue, ModuleRelocTarget>

External data object declarations.

function_relocs: Vec<(CodeOffset, FuncRef)>

Function addresses to write at specified offsets.

data_relocs: Vec<(CodeOffset, GlobalValue, Addend)>

Data addresses to write at specified offsets.

custom_segment_section: Option<(String, String)>

Object file section

align: Option<u64>

Alignment in bytes. None means that the default alignment of the respective module should be used.

Implementations

impl DataDescription

pub fn new() -> Self

Allocate a new DataDescription.

pub fn clear(&mut self)

Clear all data structures in this DataDescription.

pub fn define_zeroinit(&mut self, size: usize)

Define a zero-initialized object with the given size.

pub fn define(&mut self, contents: Box<[u8]>)

Define an object initialized with the given contents.

TODO: Can we avoid a Box here?

pub fn set_segment_section(&mut self, seg: &str, sec: &str)

Override the segment/section for data, only supported on Object backend

pub fn set_align(&mut self, align: u64)

Set the alignment for data. The alignment must be a power of two.

pub fn import_function(&mut self, name: ModuleRelocTarget) -> FuncRef

Declare an external function import.

Users of the Module API generally should call Module::declare_func_in_data instead, as it takes care of generating the appropriate ExternalName.

pub fn import_global_value(&mut self, name: ModuleRelocTarget) -> GlobalValue

Declares a global value import.

TODO: Rename to import_data?

Users of the Module API generally should call Module::declare_data_in_data instead, as it takes care of generating the appropriate ExternalName.

pub fn write_function_addr(&mut self, offset: CodeOffset, func: FuncRef)

Write the address of func into the data at offset offset.

pub fn write_data_addr( &mut self, offset: CodeOffset, data: GlobalValue, addend: Addend )

Write the address of data into the data at offset offset.

pub fn all_relocs<'a>( &'a self, pointer_reloc: Reloc ) -> impl Iterator<Item = ModuleReloc> + 'a

An iterator over all relocations of the data object.

Trait Implementations

impl Clone for DataDescription

fn clone(&self) -> DataDescription

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DataDescription

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

Formats the value using the given formatter.