Struct Function 

pub struct Function {
    pub name: Ident,
    pub selector: Option<[u8; 4]>,
    pub attributes: FunctionAttributes,
    pub params: Vec<MirType>,
    pub returns: Vec<MirType>,
    pub internal_frame_size: u64,
    pub external_static_return_size: u64,
    pub values: IndexVec<ValueId, Value>,
    pub instructions: IndexVec<InstId, Instruction>,
    pub blocks: IndexVec<BlockId, BasicBlock>,
    pub entry_block: BlockId,
}

A function in the MIR.

Fields

name: Ident

Function name.

selector: Option<[u8; 4]>

Function selector (4 bytes, for external functions).

attributes: FunctionAttributes

Function attributes.

params: Vec<MirType>

Parameter types.

returns: Vec<MirType>

Return types.

internal_frame_size: u64

Bytes reserved for lowered local memory slots.

Internal-call functions place these in the internal frame; external entries reserve the same space in their low-memory scratch layout.

external_static_return_size: u64

Bytes reserved for the low-memory external ABI return buffer.

values: IndexVec<ValueId, Value>

All values in this function.

instructions: IndexVec<InstId, Instruction>

All instructions in this function.

blocks: IndexVec<BlockId, BasicBlock>

All basic blocks in this function.

entry_block: BlockId

The entry block.

Implementations

impl Function

pub fn new(name: Ident) -> Function

Creates a new function.

pub fn value(&self, id: ValueId) -> &Value

Returns the value for the given ID.

pub fn value_u256(&self, id: ValueId) -> Option<Uint<256, 4>>

Returns an immediate value as U256.

pub fn value_u64(&self, id: ValueId) -> Option<u64>

Returns an immediate value as u64 when lossless.

pub fn value_u256_after_replacements( &self, id: ValueId, replacements: &HashMap<ValueId, ValueId, FxBuildHasher>, ) -> Option<Uint<256, 4>>

Returns a possibly replaced immediate value as U256.

pub fn memory_region_for_addr(&self, addr: ValueId) -> MemoryRegion

Returns the statically known memory region for an address value.

pub fn instruction(&self, id: InstId) -> &Instruction

Returns the instruction for the given ID.

pub fn inst_result_value(&self, id: InstId) -> Option<ValueId>

Returns the value produced by the given instruction, if it has one.

pub fn inst_results(&self) -> HashMap<InstId, ValueId, FxBuildHasher>

Returns a map from each instruction to its result value.

pub fn inst_blocks(&self) -> HashMap<InstId, BlockId, FxBuildHasher>

Returns a map from each instruction to the block containing it.

pub fn unique_predecessors(&self, block: BlockId) -> Vec<BlockId>

Returns predecessors with duplicate CFG edges collapsed.

pub fn block_has_phi(&self, block: BlockId) -> bool

Returns true if the block contains any phi instruction.

pub fn block_has_only_phis(&self, block: BlockId) -> bool

Returns true if every instruction in the block is a phi instruction.

pub fn block_phi_results( &self, block: BlockId, ) -> HashSet<ValueId, FxBuildHasher>

Returns the result values produced by phi instructions in the block.

pub fn block(&self, id: BlockId) -> &BasicBlock

Returns the basic block for the given ID.

pub fn block_mut(&mut self, id: BlockId) -> &mut BasicBlock

Returns a mutable reference to the basic block.

pub fn entry(&self) -> &BasicBlock

Returns the entry block.

pub fn alloc_value(&mut self, value: Value) -> ValueId

Allocates a new value.

pub fn alloc_inst(&mut self, inst: Instruction) -> InstId

Allocates a new instruction.

pub fn alloc_block(&mut self) -> BlockId

Allocates a new basic block.

pub fn replace_uses( &mut self, replacements: &HashMap<ValueId, ValueId, FxBuildHasher>, )

Replaces all value uses according to a one-step replacement map.

pub fn replace_uses_canonicalized( &mut self, replacements: &HashMap<ValueId, ValueId, FxBuildHasher>, )

Replaces all value uses according to a canonicalized replacement map.

pub fn storage_alias(&self, inst_id: InstId, slot: ValueId) -> StorageAlias

Returns stored storage-alias metadata, or computes a conservative alias key.

pub fn storage_alias_after_replacements( &self, inst_id: InstId, slot: ValueId, replacements: &HashMap<ValueId, ValueId, FxBuildHasher>, ) -> StorageAlias

Returns storage-alias metadata after applying value replacements.

pub fn is_public(&self) -> bool

Returns true if this function is public or external.

pub fn selector_hex(&self) -> Option<String>

Returns the function selector as a hex string.

pub fn to_text(&self) -> impl Display

Returns the human-readable textual MIR representation of this function.

pub fn to_dot(&self) -> impl Display

Returns this function’s DOT-format CFG.

Trait Implementations

impl Clone for Function

fn clone(&self) -> Function

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.

impl Display for Function

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

Formats the value using the given formatter.