Struct cranelift_faerie::FaerieBackend

pub struct FaerieBackend { /* fields omitted */ }

A FaerieBackend implements Backend and emits ".o" files using the faerie library.

See the FaerieBuilder for a convenient way to construct FaerieBackend instances.

Trait Implementations

impl Backend for FaerieBackend

type Builder = FaerieBuilder

A builder for constructing Backend instances.

type CompiledFunction = FaerieCompiledFunction

The results of compiling a function.

type CompiledData = FaerieCompiledData

The results of "compiling" a data object.

type FinalizedFunction = ()

The completed output artifact for a function, if this is meaningful for the Backend.

type FinalizedData = ()

The completed output artifact for a data object, if this is meaningful for the Backend.

type Product = FaerieProduct

The returned value here provides functions for emitting object files to memory and files.

fn new(builder: FaerieBuilder) -> Self

Create a new FaerieBackend using the given Cranelift target.

fn isa(&self) -> &dyn TargetIsa

Return the TargetIsa to compile for.

fn declare_function(&mut self, _id: FuncId, name: &str, linkage: Linkage)

Declare a function.

fn declare_data(
    &mut self,
    _id: DataId,
    name: &str,
    linkage: Linkage,
    writable: bool,
    align: Option<u8>
)

Declare a data object.

fn define_function(
    &mut self,
    _id: FuncId,
    name: &str,
    ctx: &Context,
    namespace: &ModuleNamespace<Self>,
    total_size: u32
) -> ModuleResult<FaerieCompiledFunction>

Define a function, producing the function body from the given Context.

fn define_function_bytes(
    &mut self,
    _id: FuncId,
    name: &str,
    bytes: &[u8],
    _namespace: &ModuleNamespace<Self>,
    traps: Vec<TrapSite>
) -> ModuleResult<FaerieCompiledFunction>

Define a function, taking the function body from the given bytes.

fn define_data(
    &mut self,
    _id: DataId,
    name: &str,
    _writable: bool,
    _align: Option<u8>,
    data_ctx: &DataContext,
    namespace: &ModuleNamespace<Self>
) -> ModuleResult<FaerieCompiledData>

Define a zero-initialized data object of the given size.

fn write_data_funcaddr(
    &mut self,
    _data: &mut FaerieCompiledData,
    _offset: usize,
    _what: FuncRef
)

Write the address of what into the data for data at offset. data must refer to a defined data object.

fn write_data_dataaddr(
    &mut self,
    _data: &mut FaerieCompiledData,
    _offset: usize,
    _what: GlobalValue,
    _usize: Addend
)

Write the address of what plus addend into the data for data at offset. data must refer to a defined data object.

fn finalize_function(
    &mut self,
    _id: FuncId,
    _func: &FaerieCompiledFunction,
    _namespace: &ModuleNamespace<Self>
)

Perform all outstanding relocations on the given function. This requires all Local and Export entities referenced to be defined.

fn get_finalized_function(&self, _func: &FaerieCompiledFunction)

Return the finalized artifact from the backend, if relevant.

fn finalize_data(
    &mut self,
    _id: DataId,
    _data: &FaerieCompiledData,
    _namespace: &ModuleNamespace<Self>
)

Perform all outstanding relocations on the given data object. This requires all Local and Export entities referenced to be defined.

fn get_finalized_data(&self, _data: &FaerieCompiledData)

Return the finalized artifact from the backend, if relevant.

fn publish(&mut self)

"Publish" all finalized functions and data objects to their ultimate destinations.

fn finish(self, _namespace: &ModuleNamespace<Self>) -> FaerieProduct

Consume this Backend and return a result. Some implementations may provide additional functionality through this result.