Struct sway_ir::block::Block

pub struct Block(pub Index);

A wrapper around an ECS handle into the Context.

Tuple Fields

0: Index

Implementations

impl Block

pub fn new(
    context: &mut Context,
    function: Function,
    label: Option<String>
) -> Block

Return a new block handle.

Creates a new Block belonging to function in the context and returns its handle. label is optional and is used only when printing the IR.

pub fn get_function(&self, context: &Context) -> Function

Get the parent function for this block.

pub fn ins<'a>(&self, context: &'a mut Context) -> InstructionInserter<'a>

Create a new InstructionIterator to more easily append instructions to this block.

pub fn get_label(&self, context: &Context) -> String

Get the label of this block. If it wasn’t given one upon creation it will be a generated label.

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

Get the number of instructions in this block, NOT including the phi instruction.

pub fn get_phi(&self, context: &Context) -> Value

Get the phi instruction for this block.

pub fn num_predecessors(&self, context: &Context) -> usize

Get the number of predecessor blocks, i.e., blocks which branch to this one.

pub fn add_phi(&self, context: &mut Context, from_block: Block, phi_value: Value)

Add a new phi entry to this block.

This indicates that if control flow comes from from_block then the phi instruction should use phi_value.

pub fn get_phi_val_coming_from(
    &self,
    context: &Context,
    from_block: &Block
) -> Option<Value>

Get the value from the phi instruction which correlates to from_block.

Returns None if from_block isn’t found.

pub fn remove_phi_val_coming_from(
    &self,
    context: &mut Context,
    from_block: &Block
)

Remove the value in the phi instruction which correlates to from_block.

pub fn update_phi_source_block(
    &self,
    context: &mut Context,
    old_source: Block,
    new_source: Block
)

Replace a block reference in the phi instruction.

Any reference to old_source will be replace with new_source in the list of phi values.

pub fn get_terminator<'a>(&self, context: &'a Context) -> Option<&'a Instruction>

Get a reference to the block terminator.

Returns None if block is empty.

pub fn is_terminated(&self, context: &Context) -> bool

Return whether this block is already terminated. Checks if the final instruction, if it exists, is a terminator.

pub fn is_terminated_by_ret(&self, context: &Context) -> bool

Return whether this block is already terminated specifically by a Ret instruction.

pub fn replace_value(&self, context: &mut Context, old_val: Value, new_val: Value)

Replace a value within this block.

For every instruction within the block, any reference to old_val is replaced with new_val.

pub fn remove_instruction(&self, context: &mut Context, instr_val: Value)

Remove an instruction from this block.

NOTE: We must be very careful! We mustn’t remove the phi or the terminator. Some extra checks should probably be performed here to avoid corruption! Ideally we use get a user/uses system implemented. Using Vec::remove() is also O(n) which we may want to avoid someday.

pub fn replace_instruction(
    &self,
    context: &mut Context,
    old_instr_val: Value,
    new_instr_val: Value
) -> Result<(), IrError>

Replace an instruction in this block with another. Will return a ValueNotFound on error. Any use of the old instruction value will also be replaced by the new value throughout the owning function.

pub fn split_at(&self, context: &mut Context, split_idx: usize) -> (Block, Block)

Split the block into two.

This will create a new block and move the instructions at and following split_idx to it. Returns both blocks.

pub fn instruction_iter(&self, context: &Context) -> InstructionIterator

Return an instruction iterator for each instruction in this block.

Trait Implementations

impl Clone for Block

fn clone(&self) -> Block

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Block

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

Formats the value using the given formatter.

impl Hash for Block

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, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Block> for Block

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for Block

impl Eq for Block

impl StructuralEq for Block

impl StructuralPartialEq for Block