Enum sway_ir::instruction::Instruction

pub enum Instruction {
    AddrOf(Value),
    AsmBlock(AsmBlock, Vec<AsmArg>),
    BinaryOp {
        op: BinaryOpKind,
        arg1: Value,
        arg2: Value,
    },
    BitCast(Value, Type),
    Branch(BranchToWithArgs),
    Call(Function, Vec<Value>),
    CastPtr(Value, Type, u64),
    Cmp(Predicate, Value, Value),
    ConditionalBranch {
        cond_value: Value,
        true_block: BranchToWithArgs,
        false_block: BranchToWithArgs,
    },
    ContractCall {
        return_type: Type,
        name: String,
        params: Value,
        coins: Value,
        asset_id: Value,
        gas: Value,
    },
    ExtractElement {
        array: Value,
        ty: Type,
        index_val: Value,
    },
    ExtractValue {
        aggregate: Value,
        ty: Type,
        indices: Vec<u64>,
    },
    FuelVm(FuelVmInstruction),
    GetLocal(LocalVar),
    InsertElement {
        array: Value,
        ty: Type,
        value: Value,
        index_val: Value,
    },
    InsertValue {
        aggregate: Value,
        ty: Type,
        value: Value,
        indices: Vec<u64>,
    },
    IntToPtr(Value, Type),
    Load(Value),
    MemCopy {
        dst_val: Value,
        src_val: Value,
        byte_len: u64,
    },
    Nop,
    Ret(Value, Type),
    Store {
        dst_val: Value,
        stored_val: Value,
    },
}

Variants

AddrOf(Value)

Address of a non-copy (memory) value

AsmBlock(AsmBlock, Vec<AsmArg>)

An opaque list of ASM instructions passed directly to codegen.

BinaryOp

Fields

op: BinaryOpKind

arg1: Value

arg2: Value

Binary arithmetic operations

BitCast(Value, Type)

Cast the type of a value without changing its actual content.

Branch(BranchToWithArgs)

An unconditional jump.

Call(Function, Vec<Value>)

A function call with a list of arguments.

CastPtr(Value, Type, u64)

Temporary! Cast between ‘pointers’ to reference types. At this intermediate stage, where we have removed the old get_ptr instruction, we have no way to do the casting and offsetting it did, which was used almost exclusively by storage accesses. When we reintroduce pointers we can make them untyped/opaque which removes the need for casting, and we can introduce GEP which will allow indexing into aggregates.

Until then we can replicate the get_ptr functionality with CastPtr. The Value here should always be a get_local and the types must be non-copy.

Cmp(Predicate, Value, Value)

Comparison between two values using various comparators and returning a boolean.

ConditionalBranch

Fields

cond_value: Value

true_block: BranchToWithArgs

false_block: BranchToWithArgs

A conditional jump with the boolean condition value and true or false destinations.

ContractCall

Fields

return_type: Type

name: String

params: Value

coins: Value

asset_id: Value

gas: Value

A contract call with a list of arguments

ExtractElement

Fields

array: Value

ty: Type

index_val: Value

Reading a specific element from an array.

ExtractValue

Fields

aggregate: Value

ty: Type

indices: Vec<u64>

Reading a specific field from (nested) structs.

FuelVm(FuelVmInstruction)

Umbrella instruction variant for FuelVM-specific instructions

GetLocal(LocalVar)

Return a local variable.

InsertElement

Fields

array: Value

ty: Type

value: Value

index_val: Value

Writing a specific value to an array.

InsertValue

Fields

aggregate: Value

ty: Type

value: Value

indices: Vec<u64>

Writing a specific value to a (nested) struct field.

IntToPtr(Value, Type)

Re-interpret an integer value as pointer of some type

Load(Value)

Read a value from a memory pointer.

MemCopy

Fields

dst_val: Value

src_val: Value

byte_len: u64

Copy a specified number of bytes between pointers.

Nop

No-op, handy as a placeholder instruction.

Ret(Value, Type)

Return from a function.

Store

Fields

dst_val: Value

stored_val: Value

Write a value to a memory pointer.

Implementations

impl Instruction

pub fn get_type(&self, context: &Context) -> Option<Type>

Some Instructions can return a value, but for some a return value doesn’t make sense.

Those which perform side effects such as writing to memory and also terminators such as Ret do not have a type.

pub fn get_aggregate(&self, context: &Context) -> Option<Type>

Some Instructions may have struct arguments. Return it if so for this instruction.

pub fn get_operands(&self) -> Vec<Value>

pub fn replace_values(&mut self, replace_map: &FxHashMap<Value, Value>)

Replace old_val with new_val if it is referenced by this instruction’s arguments.

pub fn may_have_side_effect(&self) -> bool

pub fn is_terminator(&self) -> bool

Trait Implementations

impl Clone for Instruction

fn clone(&self) -> Instruction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Instruction

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

Formats the value using the given formatter.

impl DebugWithContext for Instruction

fn fmt_with_context<'a, 'c>( &'a self, formatter: &mut Formatter<'_>, context: &'c Context ) -> Result

fn with_context<'a, 'c>( &'a self, context: &'c Context ) -> WithContext<'a, 'c, Self>