Enum fuel_asm::Opcode

pub enum Opcode {
    ADD(RegisterId, RegisterId, RegisterId),
    ADDI(RegisterId, RegisterId, Immediate12),
    AND(RegisterId, RegisterId, RegisterId),
    ANDI(RegisterId, RegisterId, Immediate12),
    DIV(RegisterId, RegisterId, RegisterId),
    DIVI(RegisterId, RegisterId, Immediate12),
    EQ(RegisterId, RegisterId, RegisterId),
    EXP(RegisterId, RegisterId, RegisterId),
    EXPI(RegisterId, RegisterId, Immediate12),
    GT(RegisterId, RegisterId, RegisterId),
    LT(RegisterId, RegisterId, RegisterId),
    MLOG(RegisterId, RegisterId, RegisterId),
    MROO(RegisterId, RegisterId, RegisterId),
    MOD(RegisterId, RegisterId, RegisterId),
    MODI(RegisterId, RegisterId, Immediate12),
    MOVE(RegisterId, RegisterId),
    MOVI(RegisterId, Immediate18),
    MUL(RegisterId, RegisterId, RegisterId),
    MULI(RegisterId, RegisterId, Immediate12),
    NOT(RegisterId, RegisterId),
    OR(RegisterId, RegisterId, RegisterId),
    ORI(RegisterId, RegisterId, Immediate12),
    SLL(RegisterId, RegisterId, RegisterId),
    SLLI(RegisterId, RegisterId, Immediate12),
    SRL(RegisterId, RegisterId, RegisterId),
    SRLI(RegisterId, RegisterId, Immediate12),
    SUB(RegisterId, RegisterId, RegisterId),
    SUBI(RegisterId, RegisterId, Immediate12),
    XOR(RegisterId, RegisterId, RegisterId),
    XORI(RegisterId, RegisterId, Immediate12),
    JI(Immediate24),
    JNEI(RegisterId, RegisterId, Immediate12),
    JNZI(RegisterId, Immediate18),
    JMP(RegisterId),
    JNE(RegisterId, RegisterId, RegisterId),
    RET(RegisterId),
    RETD(RegisterId, RegisterId),
    CFEI(Immediate24),
    CFSI(Immediate24),
    LB(RegisterId, RegisterId, Immediate12),
    LW(RegisterId, RegisterId, Immediate12),
    ALOC(RegisterId),
    MCL(RegisterId, RegisterId),
    MCLI(RegisterId, Immediate18),
    MCP(RegisterId, RegisterId, RegisterId),
    MCPI(RegisterId, RegisterId, Immediate12),
    MEQ(RegisterId, RegisterId, RegisterId, RegisterId),
    SB(RegisterId, RegisterId, Immediate12),
    SW(RegisterId, RegisterId, Immediate12),
    BAL(RegisterId, RegisterId, RegisterId),
    BHSH(RegisterId, RegisterId),
    BHEI(RegisterId),
    BURN(RegisterId),
    CALL(RegisterId, RegisterId, RegisterId, RegisterId),
    CCP(RegisterId, RegisterId, RegisterId, RegisterId),
    CROO(RegisterId, RegisterId),
    CSIZ(RegisterId, RegisterId),
    CB(RegisterId),
    LDC(RegisterId, RegisterId, RegisterId),
    LOG(RegisterId, RegisterId, RegisterId, RegisterId),
    LOGD(RegisterId, RegisterId, RegisterId, RegisterId),
    MINT(RegisterId),
    RVRT(RegisterId),
    SMO(RegisterId, RegisterId, RegisterId, RegisterId),
    SRW(RegisterId, RegisterId),
    SRWQ(RegisterId, RegisterId),
    SWW(RegisterId, RegisterId),
    SWWQ(RegisterId, RegisterId),
    TIME(RegisterId, RegisterId),
    TR(RegisterId, RegisterId, RegisterId),
    TRO(RegisterId, RegisterId, RegisterId, RegisterId),
    ECR(RegisterId, RegisterId, RegisterId),
    K256(RegisterId, RegisterId, RegisterId),
    S256(RegisterId, RegisterId, RegisterId),
    NOOP,
    FLAG(RegisterId),
    GM(RegisterId, Immediate18),
    GTF(RegisterId, RegisterId, Immediate12),
    Undefined,
}

Instruction representation for the interpreter.

Memory Opcodes

All these opcodes advance the program counter $pc by 4 after performing their operation. Every instruction is guaranteed to fit in u32 representation.

Arithmetic/Logic (ALU) Opcodes

All these opcodes advance the program counter $pc by 4 after performing their operation.

If the F_UNSAFEMATH flag is unset, an operation that would have set $err to true is instead a panic.

If the F_WRAPPING flag is unset, an operation that would have set $of to a non-zero value is instead a panic. ## Contract Opcodes

All these opcodes advance the program counter $pc by 4 after performing their operation, except for CALL and REVERT.

Cryptographic Opcodes

All these opcodes advance the program counter $pc by 4 after performing their operation.

Variants

ADD(RegisterId, RegisterId, RegisterId)

Adds two registers.

ADDI(RegisterId, RegisterId, Immediate12)

Adds a register and an immediate value.

AND(RegisterId, RegisterId, RegisterId)

Bitwise ANDs two registers.

ANDI(RegisterId, RegisterId, Immediate12)

Bitwise ANDs a register and an immediate value.

DIV(RegisterId, RegisterId, RegisterId)

Divides two registers.

DIVI(RegisterId, RegisterId, Immediate12)

Divides a register and an immediate value.

EQ(RegisterId, RegisterId, RegisterId)

Compares two registers for equality.

EXP(RegisterId, RegisterId, RegisterId)

Raises one register to the power of another.

EXPI(RegisterId, RegisterId, Immediate12)

Raises one register to the power of an immediate value.

GT(RegisterId, RegisterId, RegisterId)

Compares two registers for greater-than.

LT(RegisterId, RegisterId, RegisterId)

Compares two registers for less-than.

MLOG(RegisterId, RegisterId, RegisterId)

The integer logarithm of a register.

MROO(RegisterId, RegisterId, RegisterId)

The integer root of a register.

MOD(RegisterId, RegisterId, RegisterId)

Modulo remainder of two registers.

MODI(RegisterId, RegisterId, Immediate12)

Modulo remainder of a register and an immediate value.

MOVE(RegisterId, RegisterId)

Copy from one register to another.

MOVI(RegisterId, Immediate18)

Copy immediate value into a register

MUL(RegisterId, RegisterId, RegisterId)

Multiplies two registers.

MULI(RegisterId, RegisterId, Immediate12)

Multiplies a register and an immediate value.

NOT(RegisterId, RegisterId)

Bitwise NOT a register.

OR(RegisterId, RegisterId, RegisterId)

Bitwise ORs two registers.

ORI(RegisterId, RegisterId, Immediate12)

Bitwise ORs a register and an immediate value.

SLL(RegisterId, RegisterId, RegisterId)

Left shifts a register by a register.

SLLI(RegisterId, RegisterId, Immediate12)

Left shifts a register by an immediate value.

SRL(RegisterId, RegisterId, RegisterId)

Right shifts a register by a register.

SRLI(RegisterId, RegisterId, Immediate12)

Right shifts a register by an immediate value.

SUB(RegisterId, RegisterId, RegisterId)

Subtracts two registers.

SUBI(RegisterId, RegisterId, Immediate12)

Subtracts a register and an immediate value.

XOR(RegisterId, RegisterId, RegisterId)

Bitwise XORs two registers.

XORI(RegisterId, RegisterId, Immediate12)

Bitwise XORs a register and an immediate value.

JI(Immediate24)

Jump.

JNEI(RegisterId, RegisterId, Immediate12)

Conditional jump.

JNZI(RegisterId, Immediate18)

Conditional jump against zero.

JMP(RegisterId)

Dynamic jump.

JNE(RegisterId, RegisterId, RegisterId)

Conditional dynamic jump.

RET(RegisterId)

Return from context.

RETD(RegisterId, RegisterId)

Return from context with data.

CFEI(Immediate24)

Extend the current call frame’s stack by an immediate value.

CFSI(Immediate24)

Shrink the current call frame’s stack by an immediate value.

LB(RegisterId, RegisterId, Immediate12)

A byte is loaded from the specified address offset by an immediate value.

LW(RegisterId, RegisterId, Immediate12)

A word is loaded from the specified address offset by an immediate value.

ALOC(RegisterId)

Allocate a number of bytes from the heap.

MCL(RegisterId, RegisterId)

Clear a variable number of bytes in memory.

MCLI(RegisterId, Immediate18)

Clear an immediate number of bytes in memory.

MCP(RegisterId, RegisterId, RegisterId)

Copy a variable number of bytes in memory.

MCPI(RegisterId, RegisterId, Immediate12)

Copy an immediate number of bytes in memory.

MEQ(RegisterId, RegisterId, RegisterId, RegisterId)

Compare bytes in memory.

SB(RegisterId, RegisterId, Immediate12)

Write the least significant byte of a register to memory.

SW(RegisterId, RegisterId, Immediate12)

Write a register to memory.

BAL(RegisterId, RegisterId, RegisterId)

Get the balance of contract of an asset ID.

BHSH(RegisterId, RegisterId)

Get block header hash for height.

BHEI(RegisterId)

Get current block height.

BURN(RegisterId)

Burn coins of the current contract’s asset ID.

CALL(RegisterId, RegisterId, RegisterId, RegisterId)

Call a contract.

CCP(RegisterId, RegisterId, RegisterId, RegisterId)

Copy contract code for a contract.

CROO(RegisterId, RegisterId)

Get code root of a contract.

CSIZ(RegisterId, RegisterId)

Get code size of a contract.

CB(RegisterId)

Get current block proposer’s address.

LDC(RegisterId, RegisterId, RegisterId)

Load a contract’s code as executable.

LOG(RegisterId, RegisterId, RegisterId, RegisterId)

Log an event.

LOGD(RegisterId, RegisterId, RegisterId, RegisterId)

Log data.

MINT(RegisterId)

Mint coins of the current contract’s asset ID.

RVRT(RegisterId)

Halt execution, reverting state changes and returning a value.

SMO(RegisterId, RegisterId, RegisterId, RegisterId)

Send a message to recipient address with call abi, coins, and output.

SRW(RegisterId, RegisterId)

Load a word from contract storage.

SRWQ(RegisterId, RegisterId)

Load 32 bytes from contract storage.

SWW(RegisterId, RegisterId)

Store a word in contract storage.

SWWQ(RegisterId, RegisterId)

Store 32 bytes in contract storage.

TIME(RegisterId, RegisterId)

Get timestamp of block at given height.

TR(RegisterId, RegisterId, RegisterId)

Transfer coins to a contract unconditionally.

TRO(RegisterId, RegisterId, RegisterId, RegisterId)

Transfer coins to a variable output.

ECR(RegisterId, RegisterId, RegisterId)

The 64-byte public key (x, y) recovered from 64-byte signature on 32-byte message.

K256(RegisterId, RegisterId, RegisterId)

The keccak-256 hash of a slice.

S256(RegisterId, RegisterId, RegisterId)

The SHA-2-256 hash of a slice.

NOOP

Performs no operation.

FLAG(RegisterId)

Set flag register to a register.

GM(RegisterId, Immediate18)

Get metadata from memory.

GTF(RegisterId, RegisterId, Immediate12)

Get transaction fields.

Undefined

Undefined opcode, potentially from inconsistent serialization.

Implementations

impl Opcode

pub const LEN: usize = 4usize

Size of the struct when serialized into bytes

pub const fn new(instruction: Instruction) -> Self

Create a new Opcode given the internal attributes

pub unsafe fn from_bytes_unchecked(bytes: &[u8]) -> Self

Create a Opcode from a slice of bytes

Safety

Reflects the requirements of bytes::from_slice_unchecked

pub fn to_bytes(self) -> [u8; 4]

Convert the opcode to bytes representation

pub const fn registers(&self) -> [Option<RegisterId>; 4]

Transform the Opcode into an optional array of 4 register identifiers

pub const fn immediate(&self) -> Option<Word>

Return the underlying immediate value, if present

pub const fn gm(ra: RegisterId, args: GMArgs) -> Self

Create a new Opcode::GM instruction from its args

pub const fn gtf(ra: RegisterId, rb: RegisterId, args: GTFArgs) -> Self

Create a new Opcode::GTF instruction from its args

impl Opcode

pub fn from_bytes(bytes: &[u8]) -> Result<Self>

Available on crate feature std only.

Create a Opcode from a slice of bytes

This function will fail if the length of the bytes is smaller than Opcode::LEN.

pub fn from_bytes_iter<I>(bytes: I) -> Vec<Self> where
    I: IntoIterator<Item = u8>, 

Available on crate feature std only.

Create a set of Opcode from an iterator of bytes

If not padded to Self::LEN, will consume the unaligned bytes but won’t try to parse an opcode from them.

Trait Implementations

impl<'arbitrary> Arbitrary<'arbitrary> for Opcode

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Clone for Opcode

fn clone(&self) -> Opcode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Opcode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Opcode

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl From<[u8; 4]> for Opcode

fn from(b: [u8; 4]) -> Self

Converts to this type from the input type.

impl From<Instruction> for Opcode

fn from(parsed: Instruction) -> Self

Converts to this type from the input type.

impl From<InstructionResult> for Opcode

fn from(r: InstructionResult) -> Self

Converts to this type from the input type.

impl From<Opcode> for Instruction

fn from(op: Opcode) -> Self

Converts to this type from the input type.

impl From<Opcode> for u32

fn from(opcode: Opcode) -> u32

Converts to this type from the input type.

impl From<u32> for Opcode

fn from(instruction: u32) -> Self

Converts to this type from the input type.

impl FromIterator<Opcode> for Vec<Instruction>

Available on crate feature std only.

fn from_iter<T>(iter: T) -> Self where
    T: IntoIterator<Item = Opcode>, 

Creates a value from an iterator.

impl FromIterator<Opcode> for Vec<u8>

Available on crate feature std only.

fn from_iter<T>(iter: T) -> Self where
    T: IntoIterator<Item = Opcode>, 

Creates a value from an iterator.

impl Hash for Opcode

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<Opcode> for Opcode

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

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

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

This method tests for !=.

impl Read for Opcode

Available on crate feature std only.

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬 This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: &mut ReadBuf<'_>) -> Result<(), Error>

🔬 This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, buf: &mut ReadBuf<'_>) -> Result<(), Error>

🔬 This is a nightly-only experimental API. (read_buf)

Read the exact number of bytes required to fill buf.

fn by_ref(&mut self) -> &mut Self

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R> where
    R: Read, 

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

Creates an adapter which will read at most limit bytes from it.

impl Serialize for Opcode

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Write for Opcode

Available on crate feature std only.

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬 This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬 This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

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

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

Creates a “by reference” adapter for this instance of Write.

impl Copy for Opcode

impl Eq for Opcode

impl StructuralEq for Opcode

impl StructuralPartialEq for Opcode