Struct sway_ir::function::Function

pub struct Function(pub DefaultKey);

A wrapper around an ECS handle into the Context.

Tuple Fields

0: DefaultKey

Implementations

impl Function

pub fn new( context: &mut Context<'_>, module: Module, name: String, args: Vec<(String, Type, Option<MetadataIndex>)>, return_type: Type, selector: Option<[u8; 4]>, is_public: bool, is_entry: bool, is_original_entry: bool, is_fallback: bool, metadata: Option<MetadataIndex>, ) -> Function

Return a new Function handle.

Creates a Function in the context within module and returns a handle.

name, args, return_type and is_public are the usual suspects. selector is a special value used for Sway contract calls; much like name is unique and not particularly used elsewhere in the IR.

pub fn create_block( &self, context: &mut Context<'_>, label: Option<Label>, ) -> Block

Create and append a new Block to this function.

pub fn create_block_before( &self, context: &mut Context<'_>, other: &Block, label: Option<Label>, ) -> Result<Block, IrError>

Create and insert a new Block into this function.

The new block is inserted before other.

pub fn create_block_after( &self, context: &mut Context<'_>, other: &Block, label: Option<Label>, ) -> Result<Block, IrError>

Create and insert a new Block into this function.

The new block is inserted after other.

pub fn remove_block( &self, context: &mut Context<'_>, block: &Block, ) -> Result<(), IrError>

Remove a Block from this function.

Care must be taken to ensure the block has no predecessors otherwise the function will be made invalid.

pub fn get_unique_label( &self, context: &mut Context<'_>, hint: Option<String>, ) -> String

Get a new unique block label.

If hint is None then the label will be in the form "blockN" where N is an incrementing decimal.

Otherwise if the hint is already unique to this function it will be returned. If not already unique it will have N appended to it until it is unique.

pub fn num_blocks(&self, context: &Context<'_>) -> usize

Return the number of blocks in this function.

pub fn num_instructions(&self, context: &Context<'_>) -> usize

Return the number of instructions in this function.

The crate::InstOp::AsmBlock is counted as a single instruction, regardless of the number of crate::asm::AsmInstructions in the ASM block. E.g., even if the ASM block is empty and contains no instructions, it will still be counted as a single instruction.

If you want to count every ASM instruction as an instruction, use num_instructions_incl_asm_instructions instead.

pub fn num_instructions_incl_asm_instructions( &self, context: &Context<'_>, ) -> usize

Return the number of instructions in this function, including the crate::asm::AsmInstructions found in crate::InstOp::AsmBlocks.

Every crate::asm::AsmInstruction encountered in any of the ASM blocks will be counted as an instruction. The crate::InstOp::AsmBlock itself is not counted but rather replaced with the number of ASM instructions found in the block. In other words, empty ASM blocks do not count as instructions.

If you want to count crate::InstOp::AsmBlocks as single instructions, use num_instructions instead.

pub fn get_name<'a>(&self, context: &'a Context<'_>) -> &'a str

Return the function name.

pub fn get_module(&self, context: &Context<'_>) -> Module

Return the module that this function belongs to.

pub fn get_entry_block(&self, context: &Context<'_>) -> Block

Return the function entry (i.e., the first) block.

pub fn get_metadata(&self, context: &Context<'_>) -> Option<MetadataIndex>

Return the attached metadata.

pub fn has_selector(&self, context: &Context<'_>) -> bool

Whether this function has a valid selector.

pub fn get_selector(&self, context: &Context<'_>) -> Option<[u8; 4]>

Return the function selector, if it has one.

pub fn is_entry(&self, context: &Context<'_>) -> bool

Whether or not the function is a program entry point, i.e. main, #[test] fns or abi methods.

pub fn is_original_entry(&self, context: &Context<'_>) -> bool

Whether or not the function was a program entry point, i.e. main, #[test] fns or abi methods, before it got wrapped within the __entry function.

pub fn is_fallback(&self, context: &Context<'_>) -> bool

Whether or not this function is a contract fallback function

pub fn get_return_type(&self, context: &Context<'_>) -> Type

pub fn set_return_type(&self, context: &mut Context<'_>, new_ret_type: Type)

pub fn num_args(&self, context: &Context<'_>) -> usize

Get the number of args.

pub fn get_arg(&self, context: &Context<'_>, name: &str) -> Option<Value>

Get an arg value by name, if found.

pub fn add_arg<S: Into<String>>( &self, context: &mut Context<'_>, name: S, arg: Value, )

Append an extra argument to the function signature.

NOTE: arg must be a BlockArgument value with the correct index otherwise add_arg will panic.

pub fn lookup_arg_name<'a>( &self, context: &'a Context<'_>, value: &Value, ) -> Option<&'a String>

Find the name of an arg by value.

pub fn args_iter<'a>( &self, context: &'a Context<'_>, ) -> impl Iterator<Item = &'a (String, Value)>

Return an iterator for each of the function arguments.

pub fn get_local_var( &self, context: &Context<'_>, name: &str, ) -> Option<LocalVar>

Get a pointer to a local value by name, if found.

pub fn lookup_local_name<'a>( &self, context: &'a Context<'_>, var: &LocalVar, ) -> Option<&'a String>

Find the name of a local value by pointer.

pub fn new_local_var( &self, context: &mut Context<'_>, name: String, local_type: Type, initializer: Option<Constant>, mutable: bool, ) -> Result<LocalVar, IrError>

Add a value to the function local storage.

The name must be unique to this function else an error is returned.

pub fn new_unique_local_var( &self, context: &mut Context<'_>, name: String, local_type: Type, initializer: Option<Constant>, mutable: bool, ) -> LocalVar

Add a value to the function local storage, by forcing the name to be unique if needed.

Will use the provided name as a hint and rename to guarantee insertion.

pub fn locals_iter<'a>( &self, context: &'a Context<'_>, ) -> impl Iterator<Item = (&'a String, &'a LocalVar)>

Return an iterator to all of the values in this function’s local storage.

pub fn remove_locals(&self, context: &mut Context<'_>, removals: &Vec<String>)

Remove given list of locals

pub fn merge_locals_from( &self, context: &mut Context<'_>, other: Function, ) -> HashMap<LocalVar, LocalVar>

Merge values from another Function into this one.

The names of the merged values are guaranteed to be unique via the use of Function::new_unique_local_var.

Returns a map from the original pointers to the newly merged pointers.

pub fn block_iter(&self, context: &Context<'_>) -> BlockIterator

Return an iterator to each block in this function.

pub fn instruction_iter<'a>( &self, context: &'a Context<'_>, ) -> impl Iterator<Item = (Block, Value)> + 'a

Return an iterator to each instruction in each block in this function.

This is a convenience method for when all instructions in a function need to be inspected. The instruction value is returned from the iterator along with the block it belongs to.

pub fn replace_values( &self, context: &mut Context<'_>, replace_map: &FxHashMap<Value, Value>, starting_block: Option<Block>, )

Replace a value with another within this function.

This is a convenience method which iterates over this function’s blocks and calls Block::replace_values in turn.

starting_block is an optimisation for when the first possible reference to old_val is known.

pub fn replace_value( &self, context: &mut Context<'_>, old_val: Value, new_val: Value, starting_block: Option<Block>, )

pub fn dot_cfg(&self, context: &Context<'_>) -> String

A graphviz dot graph of the control-flow-graph.

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, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for Function

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Function

fn eq(&self, other: &Function) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PassScope for Function

fn get_arena_idx(&self) -> DefaultKey

impl Copy for Function

impl Eq for Function

impl StructuralPartialEq for Function