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>),
    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: Aggregate,
        index_val: Value,
    },
    ExtractValue {
        aggregate: Value,
        ty: Aggregate,
        indices: Vec<u64>,
    },
    GetStorageKey,
    Gtf {
        index: Value,
        tx_field_id: u64,
    },
    GetPointer {
        base_ptr: Pointer,
        ptr_ty: Pointer,
        offset: u64,
    },
    InsertElement {
        array: Value,
        ty: Aggregate,
        value: Value,
        index_val: Value,
    },
    InsertValue {
        aggregate: Value,
        ty: Aggregate,
        value: Value,
        indices: Vec<u64>,
    },
    IntToPtr(Value, Type),
    Load(Value),
    Log {
        log_val: Value,
        log_ty: Type,
        log_id: Value,
    },
    MemCopy {
        dst_val: Value,
        src_val: Value,
        byte_len: u64,
    },
    Nop,
    ReadRegister(Register),
    Ret(Value, Type),
    Revert(Value),
    StateLoadQuadWord {
        load_val: Value,
        key: Value,
    },
    StateLoadWord(Value),
    StateStoreQuadWord {
        stored_val: Value,
        key: Value,
    },
    StateStoreWord {
        stored_val: Value,
        key: Value,
    },
    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.

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: Aggregate

index_val: Value

Reading a specific element from an array.

ExtractValue

Fields

aggregate: Value

ty: Aggregate

indices: Vec<u64>

Reading a specific field from (nested) structs.

GetStorageKey

Generate a unique integer value

Gtf

Fields

index: Value

tx_field_id: u64

GetPointer

Fields

base_ptr: Pointer

ptr_ty: Pointer

offset: u64

Return a pointer as a value.

InsertElement

Fields

array: Value

ty: Aggregate

value: Value

index_val: Value

Writing a specific value to an array.

InsertValue

Fields

aggregate: Value

ty: Aggregate

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.

Log

Fields

log_val: Value

log_ty: Type

log_id: Value

Logs a value along with an identifier.

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.

ReadRegister(Register)

Reads a special register in the VM.

Ret(Value, Type)

Return from a function.

Revert(Value)

Revert VM execution.

StateLoadQuadWord

Fields

load_val: Value

key: Value

Read a quad word from a storage slot. Type of load_val must be a B256 ptr.

StateLoadWord(Value)

Read a single word from a storage slot.

StateStoreQuadWord

Fields

stored_val: Value

key: Value

Write a value to a storage slot. Key must be a B256, type of stored_val must be a Uint(256) ptr.

StateStoreWord

Fields

stored_val: Value

key: Value

Write a value to a storage slot. Key must be a B256, type of stored_val must be a Uint(64) value.

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<Aggregate>

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>