Enum fuel_vm::prelude::Opcode

source · [−]

pub enum Opcode {
Show 81 variants
    ADD(usize, usize, usize),
    ADDI(usize, usize, u16),
    AND(usize, usize, usize),
    ANDI(usize, usize, u16),
    DIV(usize, usize, usize),
    DIVI(usize, usize, u16),
    EQ(usize, usize, usize),
    EXP(usize, usize, usize),
    EXPI(usize, usize, u16),
    GT(usize, usize, usize),
    LT(usize, usize, usize),
    MLOG(usize, usize, usize),
    MROO(usize, usize, usize),
    MOD(usize, usize, usize),
    MODI(usize, usize, u16),
    MOVE(usize, usize),
    MUL(usize, usize, usize),
    MULI(usize, usize, u16),
    NOT(usize, usize),
    OR(usize, usize, usize),
    ORI(usize, usize, u16),
    SLL(usize, usize, usize),
    SLLI(usize, usize, u16),
    SRL(usize, usize, usize),
    SRLI(usize, usize, u16),
    SUB(usize, usize, usize),
    SUBI(usize, usize, u16),
    XOR(usize, usize, usize),
    XORI(usize, usize, u16),
    CIMV(usize, usize, usize),
    CTMV(usize, usize),
    JI(u32),
    JNEI(usize, usize, u16),
    RET(usize),
    RETD(usize, usize),
    CFEI(u32),
    CFSI(u32),
    LB(usize, usize, u16),
    LW(usize, usize, u16),
    ALOC(usize),
    MCL(usize, usize),
    MCLI(usize, u32),
    MCP(usize, usize, usize),
    MCPI(usize, usize, u16),
    MEQ(usize, usize, usize, usize),
    SB(usize, usize, u16),
    SW(usize, usize, u16),
    BAL(usize, usize, usize),
    BHSH(usize, usize),
    BHEI(usize),
    BURN(usize),
    CALL(usize, usize, usize, usize),
    CCP(usize, usize, usize, usize),
    CROO(usize, usize),
    CSIZ(usize, usize),
    CB(usize),
    LDC(usize, usize, usize),
    LOG(usize, usize, usize, usize),
    LOGD(usize, usize, usize, usize),
    MINT(usize),
    RVRT(usize),
    SLDC(usize, usize, usize),
    SRW(usize, usize),
    SRWQ(usize, usize),
    SWW(usize, usize),
    SWWQ(usize, usize),
    TR(usize, usize, usize),
    TRO(usize, usize, usize, usize),
    ECR(usize, usize, usize),
    K256(usize, usize, usize),
    S256(usize, usize, usize),
    XIL(usize, usize),
    XIS(usize, usize),
    XOL(usize, usize),
    XOS(usize, usize),
    XWL(usize, usize),
    XWS(usize, usize),
    NOOP,
    FLAG(usize),
    GM(usize, u32),
    Undefined,
}

Expand description

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(usize, usize, usize)`

Adds two registers.

Execution

$of is assigned the overflow of the operation. $err is cleared.

`ADDI(usize, usize, u16)`

Adds a register and an immediate value.

Execution

$of is assigned the overflow of the operation. $err is cleared.

`AND(usize, usize, usize)`

Bitwise ANDs two registers.

`ANDI(usize, usize, u16)`

Bitwise ANDs a register and an immediate value.

Execution

imm is extended to 64 bits, with the high 52 bits set to 0. $of and $err are cleared.

`DIV(usize, usize, usize)`

Divides two registers.

Execution

If $rC == 0, $rA is cleared and $err is set to true. Otherwise, $err is cleared. $of is cleared.

`DIVI(usize, usize, u16)`

Divides a register and an immediate value.

Execution

If imm == 0, $rA is cleared and $err is set to true. Otherwise, $err is cleared. $of is cleared.

`EQ(usize, usize, usize)`

Compares two registers for equality.

`EXP(usize, usize, usize)`

Raises one register to the power of another.

Execution

If the result cannot fit in 8 bytes, $of is set to 1, otherwise $of is cleared. $err is cleared.

`EXPI(usize, usize, u16)`

Raises one register to the power of an immediate value.

Execution

If the result cannot fit in 8 bytes, $of is set to 1, otherwise $of is cleared. $err is cleared.

`GT(usize, usize, usize)`

Compares two registers for greater-than.

`LT(usize, usize, usize)`

Compares two registers for less-than.

`MLOG(usize, usize, usize)`

The (integer) logarithm base $rC of $rB.

Execution

If $rB == 0, both $rA and $of are cleared and $err is set to true.

If $rC <= 1, both $rA and $of are cleared and $err is set to true.

Otherwise, $of and $err are cleared.

`MROO(usize, usize, usize)`

The (integer) $rCth root of $rB.

Execution

If $rC == 0, both $rA and $of are cleared and $err is set to true.

Otherwise, $of and $err are cleared.

`MOD(usize, usize, usize)`

Modulo remainder of two registers.

Execution

If $rC == 0, both $rA and $of are cleared and $err is set to true.

Otherwise, $of and $err are cleared.

`MODI(usize, usize, u16)`

Modulo remainder of a register and an immediate value.

Execution

If imm == 0, both $rA and $of are cleared and $err is set to true.

Otherwise, $of and $err are cleared.

`MOVE(usize, usize)`

Copy from one register to another.

`MUL(usize, usize, usize)`

Multiplies two registers.

Execution

$of is assigned the overflow of the operation.

$err is cleared.

`MULI(usize, usize, u16)`

Multiplies a register and an immediate value.

Execution

$of is assigned the overflow of the operation.

$err is cleared.

`NOT(usize, usize)`

Bitwise NOT a register.

`OR(usize, usize, usize)`

Bitwise ORs two registers.

`ORI(usize, usize, u16)`

Bitwise ORs a register and an immediate value.

Execution

imm is extended to 64 bits, with the high 52 bits set to 0.

$of and $err are cleared.

`SLL(usize, usize, usize)`

Left shifts a register by a register.

Execution

$of is assigned the overflow of the operation.

$err is cleared.

`SLLI(usize, usize, u16)`

Left shifts a register by an immediate value.

Execution

$of is assigned the overflow of the operation.

$err is cleared.

`SRL(usize, usize, usize)`

Right shifts a register by a register.

Execution

$of is assigned the underflow of the operation, as though $of is the high byte of a 128-bit register.

$err is cleared.

`SRLI(usize, usize, u16)`

Right shifts a register by an immediate value.

Execution

$of is assigned the underflow of the operation, as though $of is the high byte of a 128-bit register.

$err is cleared.

`SUB(usize, usize, usize)`

Subtracts two registers.

Execution

$of is assigned the underflow of the operation, as though $of is the high byte of a 128-bit register.

$err is cleared.

`SUBI(usize, usize, u16)`

Subtracts a register and an immediate value.

Execution

$of is assigned the underflow of the operation, as though $of is the high byte of a 128-bit register.

$err is cleared.

`XOR(usize, usize, usize)`

Bitwise XORs two registers.

`XORI(usize, usize, u16)`

Bitwise XORs a register and an immediate value.

`CIMV(usize, usize, usize)`

Set $rA to true if the $rC <= tx.input[$rB].maturity.

Panics

$rA is a reserved register
$rC > tx.input[$rB].maturity
the input $rB is not of type InputType.Coin
$rB > tx.inputsCount

Execution

Otherwise, advance the program counter $pc by 4.

`CTMV(usize, usize)`

Set $rA to true if $rB <= tx.maturity.

Panics

$rA is a reserved register
$rB > tx.maturity

Execution

Otherwise, advance the program counter $pc by 4.

See also: BIP-65 and Bitcoin’s Time Locks.

`JI(u32)`

Jumps to the code instruction offset by imm.

`JNEI(usize, usize, u16)`

Jump to the code instruction offset by imm if $rA is not equal to $rB.

`RET(usize)`

Returns from context with value $rA.

If current context is external, cease VM execution and return $rA.

Returns from contract call, popping the call frame. Before popping:

Return the unused forwarded gas to the caller:
- $cgas = $cgas + $fp->$cgas (add remaining context gas from previous context to current remaining context gas)

Then pop the call frame and restoring registers except $ggas and $cgas. Afterwards, set the following registers:

$pc = $pc + 4 (advance program counter from where we called)

`RETD(usize, usize)`

Return from context with data

If current context is external, cease VM execution and return MEM[$rA, $rB].

Returns from contract call, popping the call frame. Before popping:

Return the unused forwarded gas to the caller:
- $cgas = $cgas + $fp->$cgas (add remaining context gas from previous context to current remaining context gas)

Then pop the call frame and restoring registers except $ggas and $cgas. Afterwards, set the following registers:

Set the return value:

$ret = $rA
$retl = $rB
$pc = $pc + 4 (advance program counter from where we called)

`CFEI(u32)`

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

`CFSI(u32)`

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

Panics

$sp - imm underflows
$sp - imm < $ssp

`LB(usize, usize, u16)`

A byte is loaded from the specified address offset by imm.

Panics

$rA is a reserved register
$rB + imm + 1 overflows
$rB + imm + 1 > VM_MAX_RAM

`LW(usize, usize, u16)`

Panics

$rA is a reserved register
$rB + imm + 8 overflows
$rB + imm + 8 > VM_MAX_RAM

`ALOC(usize)`

Allocate a number of bytes from the heap.

`MCL(usize, usize)`

Clear bytes in memory.

Panics

$rA + $rB overflows
$rA + $rB > VM_MAX_RAM
$rB > MEM_MAX_ACCESS_SIZE
The memory range MEM[$rA, $rB] does not pass ownership check

`MCLI(usize, u32)`

Clear bytes in memory.

Panics

$rA + imm overflows
$rA + imm > VM_MAX_RAM
imm > MEM_MAX_ACCESS_SIZE
The memory range MEM[$rA, imm] does not pass ownership check

`MCP(usize, usize, usize)`

Copy bytes in memory.

Panics

$rA + $rC overflows
$rB + $rC overflows
$rA + $rC > VM_MAX_RAM
$rB + $rC > VM_MAX_RAM
$rC > MEM_MAX_ACCESS_SIZE
The memory ranges MEM[$rA, $rC] and MEM[$rB, $rC] overlap
The memory range MEM[$rA, $rC] does not pass ownership check

`MCPI(usize, usize, u16)`

Copy bytes in memory.

Panics

$rA + imm overflows
$rB + imm overflows
$rA + imm > VM_MAX_RAM
$rB + imm > VM_MAX_RAM
imm > MEM_MAX_ACCESS_SIZE
The memory ranges MEM[$rA, imm] and MEM[$rB, imm] overlap
The memory range MEM[$rA, imm] does not pass ownership check

`MEQ(usize, usize, usize, usize)`

Compare bytes in memory.

Panics

$rA is a reserved register
$rB + $rD overflows
$rC + $rD overflows
$rB + $rD > VM_MAX_RAM
$rC + $rD > VM_MAX_RAM
$rD > MEM_MAX_ACCESS_SIZE

`SB(usize, usize, u16)`

The least significant byte of $rB is stored at the address $rA offset by imm.

Panics

$rA + imm + 1 overflows
$rA + imm + 1 > VM_MAX_RAM
The memory range MEM[$rA + imm, 1] does not pass ownership check

`SW(usize, usize, u16)`

The value of $rB is stored at the address $rA offset by imm.

Panics

$rA + imm + 8 overflows
$rA + imm + 8 > VM_MAX_RAM
The memory range MEM[$rA + imm, 8] does not pass ownership check

Set $rA to the balance of color at $rB for contract with ID at $rC. Where helper balance(color: byte[32], contract_id: byte[32]) -> uint64 returns the current balance of color of contract with ID contract_id.

Panics

$rA is a reserved register
$rB + 32 overflows
$rB + 32 > VM_MAX_RAM
$rC + 32 overflows
$rC + 32 > VM_MAX_RAM
Contract with ID MEM[$rC, 32] is not in tx.inputs

`BHSH(usize, usize)`

Get block header hash.

Panics

$rA + 32 overflows
$rA + 32 > VM_MAX_RAM
The memory range MEM[$rA, 32] does not pass ownership check

Block header hashes for blocks with height greater than or equal to current block height are zero (0x00**32).

`BHEI(usize)`

Get Fuel block height.

Panics

$rA is a reserved register

`BURN(usize)`

Burn $rA coins of the current contract’s color.

Panic

Balance of color MEM[$fp, 32] of output with contract ID MEM[$fp, 32] minus $rA underflows
$fp == 0 (in the script context)

For output with contract ID MEM[$fp, 32], decrease balance of color MEM[$fp, 32] by $rA.

This modifies the balanceRoot field of the appropriate output.

`CALL(usize, usize, usize, usize)`

Call contract.

Panics

$rA + 32 overflows
$rC + 32 overflows
Contract with ID MEM[$rA, 32] is not in tx.inputs
Reading past MEM[VM_MAX_RAM - 1]
Any output range does not pass ownership check
In an external context, if $rB > MEM[balanceOfStart(MEM[$rC, 32]), 8]
In an internal context, if $rB is greater than the balance of color MEM[$rC, 32] of output with contract ID MEM[$rA, 32]

Register $rA is a memory address from which the following fields are set (word-aligned).

$rD is the amount of gas to forward. If it is set to an amount greater than the available gas, all available gas is forwarded.

For output with contract ID MEM[$rA, 32], increase balance of color MEM[$rC, 32] by $rB. In an external context, decrease MEM[balanceOfStart(MEM[$rC, 32]), 8] by $rB. In an internal context, decrease color MEM[$rC, 32] balance of output with contract ID MEM[$fp, 32] by $rB.

A call frame is pushed at $sp. In addition to filling in the values of the call frame, the following registers are set:

$fp = $sp (on top of the previous call frame is the beginning of this call frame) 1. Set $ssp and $sp to the start of the writable stack area of the call frame. 1. Set $pc and $is to the starting address of the code. 1. $bal = $rD (forward coins)
$cgas = $rD or all available gas (forward gas)

This modifies the balanceRoot field of the appropriate output(s).

`CCP(usize, usize, usize, usize)`

Copy $rD bytes of code starting at $rC for contract with ID equal to the 32 bytes in memory starting at $rB into memory starting at $rA.

Panics

$rA + $rD overflows
$rB + 32 overflows
$rA + $rD > VM_MAX_RAM
$rB + 32 > VM_MAX_RAM
The memory range MEM[$rA, $rD] does not pass ownership check
$rD > MEM_MAX_ACCESS_SIZE
Contract with ID MEM[$rB, 32] is not in tx.inputs

`CROO(usize, usize)`

Set the 32 bytes in memory starting at $rA to the code root for contract with ID equal to the 32 bytes in memory starting at $rB.

Panics

$rA + 32 overflows
$rB + 32 overflows
$rA + 32 > VM_MAX_RAM
$rB + 32 > VM_MAX_RAM
The memory range MEM[$rA, 32] does not pass ownership check
Contract with ID MEM[$rB, 32] is not in tx.inputs

Code root compuration is defined here.

`CSIZ(usize, usize)`

Set $rA to the size of the code for contract with ID equal to the 32 bytes in memory starting at $rB.

Panics

$rA is a reserved register
$rB + 32 overflows
$rB + 32 > VM_MAX_RAM
Contract with ID MEM[$rB, 32] is not in tx.inputs

`CB(usize)`

Get block proposer address.

Panics

$rA + 32 overflows
$rA + 32 > VM_MAX_RAM
The memory range MEM[$rA, 32] does not pass ownership check

`LDC(usize, usize, usize)`

Copy $rC bytes of code starting at $rB for contract with ID equal to the 32 bytes in memory starting at $rA into memory starting at $ssp.

Panics

$ssp + $rC overflows
$rA + 32 overflows
$ssp + $rC > VM_MAX_RAM
$rA + 32 > VM_MAX_RAM
$ssp != $sp
$ssp + $rC > $hp
$rC > CONTRACT_MAX_SIZE
$rC > MEM_MAX_ACCESS_SIZE
Contract with ID MEM[$rA, 32] is not in tx.inputs

Increment $hp->codesize, $ssp, and $sp by $rC padded to word alignment.

This opcode can be used to concatenate the code of multiple contracts together. It can only be used when the stack area of the call frame is unused (i.e. prior to being used).

`LOG(usize, usize, usize, usize)`

Log an event. This is a no-op.

`LOGD(usize, usize, usize, usize)`

Logs the memory range MEM[$rC, $rD]. This is a no-op.

`MINT(usize)`

Mint $rA coins of the current contract’s color.

Panics

Balance of color MEM[$fp, 32] of output with contract ID MEM[$fp, 32] plus $rA overflows
$fp == 0 (in the script context)

For output with contract ID MEM[$fp, 32], increase balance of color MEM[$fp, 32] by $rA.

This modifies the balanceRoot field of the appropriate output.

`RVRT(usize)`

Halt execution, reverting state changes and returning value in $rA.

After a revert:

All OutputContract outputs will have the same amount and stateRoot as on initialization. 1. All OutputVariable (../protocol/tx_format.md outputs#outputvariable) outputs will have to and amount of zero.
All OutputContractConditional (../protocol/tx_format.md# outputcontractconditional) outputs will have contractID, amount, and stateRoot of zero.

`SLDC(usize, usize, usize)`

Copy $rC bytes of code starting at $rB for contract with static index $rA into memory starting at $ssp.

Panics

$ssp + $rC overflows
$ssp + $rC > VM_MAX_RAM
$rA >= MAX_STATIC_CONTRACTS
$rA is greater than or equal to staticContractsCount for the contract with ID MEM[$fp, 32]
$ssp != $sp
$ssp + $rC > $hp
$rC > CONTRACT_MAX_SIZE
$rC > MEM_MAX_ACCESS_SIZE
$fp == 0 (in the script context)

Increment $hp->codesize, $ssp, and $sp by $rC padded to word alignment.

This opcode can be used to concatenate the code of multiple contracts together. It can only be used when the stack area of the call frame is unused (i.e. prior to being used).

`SRW(usize, usize)`

A word is read from the current contract’s state.

Panics

$rA is a reserved register
$rB + 32 overflows
$rB + 32 > VM_MAX_RAM
$fp == 0 (in the script context)

`SRWQ(usize, usize)`

32 bytes is read from the current contract’s state.

Panics

$rA + 32 overflows
$rB + 32 overflows
$rA + 32 > VM_MAX_RAM
$rB + 32 > VM_MAX_RAM
The memory range MEM[$rA, 32] does not pass ownership check
$fp == 0 (in the script context)

`SWW(usize, usize)`

A word is written to the current contract’s state.

Panics

$rA + 32 overflows
$rA + 32 > VM_MAX_RAM
$fp == 0 (in the script context)

`SWWQ(usize, usize)`

32 bytes is written to the current contract’s state.

Panics

$rA + 32 overflows
$rB + 32 overflows
$rA + 32 > VM_MAX_RAM
$rB + 32 > VM_MAX_RAM
$fp == 0 (in the script context)

`TR(usize, usize, usize)`

Transfer $rB coins with color at $rC to contract with ID at $rA.

Given helper balanceOfStart(color: byte[32]) -> uint32 which returns the memory address of color balance, or 0 if color has no balance.

Panics

$rA + 32 overflows
$rC + 32 overflows
$rA + 32 > VM_MAX_RAM
$rC + 32 > VM_MAX_RAM
Contract with ID MEM[$rA, 32] is not in tx.inputs
In an external context, if $rB > MEM[balanceOf(MEM[$rC, 32]), 8]
In an internal context, if $rB is greater than the balance of color MEM[$rC, 32] of output with contract ID MEM[$fp, 32]
$rB == 0

For output with contract ID MEM[$rA, 32], increase balance of color MEM[$rC, 32] by $rB. In an external context, decrease MEM[balanceOfStart(MEM[$rC, 32]), 8] by $rB. In an internal context, decrease color MEM[$rC, 32] balance of output with contract ID MEM[$fp, 32] by $rB.

This modifies the balanceRoot field of the appropriate output(s).

`TRO(usize, usize, usize, usize)`

Given helper balanceOfStart(color: byte[32]) -> uint32 which returns the memory address of color balance, or 0 if color has no balance.

Panics

$rA + 32 overflows
$rD + 32 overflows
$rA + 32 > VM_MAX_RAM
$rD + 32 > VM_MAX_RAM
$rB > tx.outputsCount
In an external context, if $rC > MEM[balanceOf(MEM[$rD, 32]), 8]
In an internal context, if $rC is greater than the balance of color MEM[$rD, 32] of output with contract ID MEM[$fp, 32]
$rC == 0
tx.outputs[$rB].type != OutputType.Variable
tx.outputs[$rB].amount != 0

In an external context, decrease MEM[balanceOfStart(MEM[$rD, 32]), 8] by $rC. In an internal context, decrease color MEM[$rD, 32] balance of output with contract ID MEM[$fp, 32] by $rC. Then set: