Struct cranelift_object::ObjectModule

pub struct ObjectModule { /* private fields */ }

An ObjectModule implements Module and emits “.o” files using the object library.

See the ObjectBuilder for a convenient way to construct ObjectModule instances.

Implementations

impl ObjectModule

pub fn new(builder: ObjectBuilder) -> Self

Create a new ObjectModule using the given Cranelift target.

impl ObjectModule

pub fn finish(self) -> ObjectProduct

Finalize all relocations and output an object.

Trait Implementations

impl Module for ObjectModule

fn isa(&self) -> &dyn TargetIsa

Return the TargetIsa to compile for.

fn declarations(&self) -> &ModuleDeclarations

Get all declarations in this module.

fn declare_function( &mut self, name: &str, linkage: Linkage, signature: &Signature ) -> ModuleResult<FuncId>

Declare a function in this module.

fn declare_anonymous_function( &mut self, signature: &Signature ) -> ModuleResult<FuncId>

Declare an anonymous function in this module.

fn declare_data( &mut self, name: &str, linkage: Linkage, writable: bool, tls: bool ) -> ModuleResult<DataId>

Declare a data object in this module.

fn declare_anonymous_data( &mut self, writable: bool, tls: bool ) -> ModuleResult<DataId>

Declare an anonymous data object in this module.

fn define_function_with_control_plane( &mut self, func_id: FuncId, ctx: &mut Context, ctrl_plane: &mut ControlPlane ) -> ModuleResult<()>

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

fn define_function_bytes( &mut self, func_id: FuncId, func: &Function, alignment: u64, bytes: &[u8], relocs: &[FinalizedMachReloc] ) -> ModuleResult<()>

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

fn define_data( &mut self, data_id: DataId, data: &DataDescription ) -> ModuleResult<()>

Define a data object, producing the data contents from the given DataContext.

fn get_name(&self, name: &str) -> Option<FuncOrDataId>

Get the module identifier for a given name, if that name has been declared.

fn target_config(&self) -> TargetFrontendConfig

Return the target information needed by frontends to produce Cranelift IR for the current target.

fn make_context(&self) -> Context

Create a new Context initialized for use with this Module.

fn clear_context(&self, ctx: &mut Context)

Clear the given Context and reset it for use with a new function.

fn make_signature(&self) -> Signature

Create a new empty Signature with the default calling convention for the TargetIsa, to which parameter and return types can be added for declaring a function to be called by this Module.

fn clear_signature(&self, sig: &mut Signature)

Clear the given Signature and reset for use with a new function.

fn declare_func_in_func( &mut self, func_id: FuncId, func: &mut Function ) -> FuncRef

Use this when you’re building the IR of a function to reference a function.

fn declare_data_in_func(&self, data: DataId, func: &mut Function) -> GlobalValue

Use this when you’re building the IR of a function to reference a data object.

fn declare_func_in_data( &self, func_id: FuncId, data: &mut DataDescription ) -> FuncRef

TODO: Same as above.

fn declare_data_in_data( &self, data_id: DataId, data: &mut DataDescription ) -> GlobalValue

TODO: Same as above.

fn define_function( &mut self, func: FuncId, ctx: &mut Context ) -> Result<(), ModuleError>

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