Trait cranelift_module::Backend

pub trait Backendwhere
    Self: Sized,{
    type Builder;
    type CompiledFunction;
    type CompiledData;
    type FinalizedFunction;
    type FinalizedData;
    type Product;

    fn new(_: Self::Builder) -> Self;
    fn isa(&self) -> &dyn TargetIsa;
    fn declare_function(&mut self, name: &str, linkage: Linkage);
    fn declare_data(&mut self, name: &str, linkage: Linkage, writable: bool);
    fn define_function(
        &mut self,
        name: &str,
        ctx: &Context,
        namespace: &ModuleNamespace<'_, Self>,
        code_size: u32
    ) -> ModuleResult<Self::CompiledFunction>;
    fn define_data(
        &mut self,
        name: &str,
        writable: bool,
        data_ctx: &DataContext,
        namespace: &ModuleNamespace<'_, Self>
    ) -> ModuleResult<Self::CompiledData>;
    fn write_data_funcaddr(
        &mut self,
        data: &mut Self::CompiledData,
        offset: usize,
        what: FuncRef
    );
    fn write_data_dataaddr(
        &mut self,
        data: &mut Self::CompiledData,
        offset: usize,
        what: GlobalValue,
        addend: Addend
    );
    fn finalize_function(
        &mut self,
        func: &Self::CompiledFunction,
        namespace: &ModuleNamespace<'_, Self>
    ) -> Self::FinalizedFunction;
    fn get_finalized_function(
        &self,
        func: &Self::CompiledFunction
    ) -> Self::FinalizedFunction;
    fn finalize_data(
        &mut self,
        data: &Self::CompiledData,
        namespace: &ModuleNamespace<'_, Self>
    ) -> Self::FinalizedData;
    fn get_finalized_data(
        &self,
        data: &Self::CompiledData
    ) -> Self::FinalizedData;
    fn publish(&mut self);
    fn finish(self) -> Self::Product;
}

A Backend implements the functionality needed to support a Module.

Two notable implementations of this trait are:

• SimpleJITBackend, defined in cranelift-simplejit, which JITs the contents of a Module to memory which can be directly executed.
• FaerieBackend, defined in cranelift-faerie, which writes the contents of a Module out as a native object file.

Required Associated Types

type Builder

A builder for constructing Backend instances.

type CompiledFunction

The results of compiling a function.

type CompiledData

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

This is an object returned by Module’s finish function, if the Backend has a purpose for this.

Required Methods

fn new(_: Self::Builder) -> Self

Create a new Backend instance.

fn isa(&self) -> &dyn TargetIsa

Return the TargetIsa to compile for.

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

Declare a function.

fn declare_data(&mut self, name: &str, linkage: Linkage, writable: bool)

Declare a data object.

fn define_function(
    &mut self,
    name: &str,
    ctx: &Context,
    namespace: &ModuleNamespace<'_, Self>,
    code_size: u32
) -> ModuleResult<Self::CompiledFunction>

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

Functions must be declared before being defined.

fn define_data(
    &mut self,
    name: &str,
    writable: bool,
    data_ctx: &DataContext,
    namespace: &ModuleNamespace<'_, Self>
) -> ModuleResult<Self::CompiledData>

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

Data objects must be declared before being defined.

fn write_data_funcaddr(
    &mut self,
    data: &mut Self::CompiledData,
    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 Self::CompiledData,
    offset: usize,
    what: GlobalValue,
    addend: 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,
    func: &Self::CompiledFunction,
    namespace: &ModuleNamespace<'_, Self>
) -> Self::FinalizedFunction

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: &Self::CompiledFunction
) -> Self::FinalizedFunction

Return the finalized artifact from the backend, if relevant.

fn finalize_data(
    &mut self,
    data: &Self::CompiledData,
    namespace: &ModuleNamespace<'_, Self>
) -> Self::FinalizedData

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: &Self::CompiledData) -> Self::FinalizedData

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) -> Self::Product

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

Implementors