Struct cranelift_codegen::ir::function::Function

pub struct Function {
    pub name: UserFuncName,
    pub stencil: FunctionStencil,
    pub params: FunctionParameters,
}

Functions can be cloned, but it is not a very fast operation. The clone will have all the same entity numbers as the original.

Fields

name: UserFuncName

Name of this function.

Mostly used by .clif files, only there for debugging / naming purposes.

stencil: FunctionStencil

All the fields required for compiling a function, independently of details irrelevant to compilation and that are stored in the FunctionParameters params field instead.

params: FunctionParameters

All the parameters that can be applied onto the function stencil, that is, that don’t matter when caching compilation artifacts.

Implementations

impl Function

pub fn with_name_signature(name: UserFuncName, sig: Signature) -> Self

Create a function with the given name and signature.

pub fn clear(&mut self)

Clear all data structures in this function.

pub fn new() -> Self

Create a new empty, anonymous function with a Fast calling convention.

pub fn display(&self) -> DisplayFunction<'_>

Return an object that can display this function with correct ISA-specific annotations.

pub fn display_with<'a>( &'a self, annotations: DisplayFunctionAnnotations<'a> ) -> DisplayFunction<'a>

Return an object that can display this function with correct ISA-specific annotations.

pub fn set_srcloc(&mut self, inst: Inst, srcloc: SourceLoc)

Sets an absolute source location for the given instruction.

If no base source location has been set yet, records it at the same time.

pub fn srcloc(&self, inst: Inst) -> SourceLoc

Returns an absolute source location for the given instruction.

pub fn declare_imported_user_function( &mut self, name: UserExternalName ) -> UserExternalNameRef

Declare a user-defined external function import, to be referenced in ExtFuncData::User later.

pub fn import_function(&mut self, data: ExtFuncData) -> FuncRef

Declare an external function import.

Methods from Deref<Target = FunctionStencil>

pub fn create_jump_table(&mut self, data: JumpTableData) -> JumpTable

Creates a jump table in the function, to be used by br_table instructions.

pub fn create_sized_stack_slot(&mut self, data: StackSlotData) -> StackSlot

Creates a sized stack slot in the function, to be used by stack_load, stack_store and stack_addr instructions.

pub fn create_dynamic_stack_slot( &mut self, data: DynamicStackSlotData ) -> DynamicStackSlot

Creates a dynamic stack slot in the function, to be used by dynamic_stack_load, dynamic_stack_store and dynamic_stack_addr instructions.

pub fn import_signature(&mut self, signature: Signature) -> SigRef

Adds a signature which can later be used to declare an external function import.

pub fn create_global_value(&mut self, data: GlobalValueData) -> GlobalValue

Declares a global value accessible to the function.

pub fn get_dyn_scale(&self, ty: DynamicType) -> GlobalValue

Find the global dyn_scale value associated with given DynamicType

pub fn get_dynamic_slot_scale(&self, dss: DynamicStackSlot) -> GlobalValue

Find the global dyn_scale for the given stack slot.

pub fn get_concrete_dynamic_ty(&self, ty: DynamicType) -> Option<Type>

Get a concrete Type from a user defined DynamicType.

pub fn create_heap(&mut self, data: HeapData) -> Heap

Declares a heap accessible to the function.

pub fn create_table(&mut self, data: TableData) -> Table

Declares a table accessible to the function.

pub fn special_param(&self, purpose: ArgumentPurpose) -> Option<Value>

Find a presumed unique special-purpose function parameter value.

Returns the value of the last purpose parameter, or None if no such parameter exists.

pub fn collect_debug_info(&mut self)

Starts collection of debug information.

pub fn change_branch_destination(&mut self, inst: Inst, new_dest: Block)

Changes the destination of a jump or branch instruction. Does nothing if called with a non-jump or non-branch instruction.

Note that this method ignores multi-destination branches like br_table.

pub fn rewrite_branch_destination( &mut self, inst: Inst, old_dest: Block, new_dest: Block )

Rewrite the branch destination to new_dest if the destination matches old_dest. Does nothing if called with a non-jump or non-branch instruction.

Unlike change_branch_destination, this method rewrite the destinations of multi-destination branches like br_table.

pub fn is_block_basic(&self, block: Block) -> Result<(), (Inst, &'static str)>

Checks that the specified block can be encoded as a basic block.

On error, returns the first invalid instruction and an error message.

pub fn is_leaf(&self) -> bool

Returns true if the function is function that doesn’t call any other functions. This is not to be confused with a “leaf function” in Windows terminology.

pub fn transplant_inst(&mut self, dst: Inst, src: Inst)

Replace the dst instruction’s data with the src instruction’s data and then remove src.

src and its result values should not be used at all, as any uses would be left dangling after calling this method.

src and dst must have the same number of resulting values, and src’s i^th value must have the same type as dst’s i^th value.

pub fn fixed_stack_size(&self) -> u32

Size occupied by all stack slots associated with this function.

Does not include any padding necessary due to offsets

Trait Implementations

impl Clone for Function

fn clone(&self) -> Function

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Function

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

Formats the value using the given formatter.

impl Deref for Function

type Target = FunctionStencil

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Function

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Display for Function

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

Formats the value using the given formatter.