Struct sp1_core::runtime::Instruction

pub struct Instruction {
    pub opcode: Opcode,
    pub op_a: u32,
    pub op_b: u32,
    pub op_c: u32,
    pub imm_b: bool,
    pub imm_c: bool,
}

An instruction specifies an operation to execute and the operands.

Fields

opcode: Opcode

op_a: u32

op_b: u32

op_c: u32

imm_b: bool

imm_c: bool

Implementations

impl Instruction

pub const fn from_r_type(opcode: Opcode, dec_insn: RType) -> Self

Create a new instruction from an R-type instruction.

pub const fn from_i_type(opcode: Opcode, dec_insn: IType) -> Self

Create a new instruction from an I-type instruction.

pub const fn from_i_type_shamt(opcode: Opcode, dec_insn: ITypeShamt) -> Self

Create a new instruction from an I-type instruction with a shamt.

pub const fn from_s_type(opcode: Opcode, dec_insn: SType) -> Self

Create a new instruction from an S-type instruction.

pub const fn from_b_type(opcode: Opcode, dec_insn: BType) -> Self

Create a new instruction from a B-type instruction.

pub const fn unimp() -> Self

Create a new instruction that is not implemented.

pub const fn is_r_type(&self) -> bool

Returns if the instruction is an R-type instruction.

pub const fn is_i_type(&self) -> bool

Returns whether the instruction is an I-type instruction.

pub fn r_type(&self) -> (Register, Register, Register)

Decode the instruction in the R-type format.

pub fn i_type(&self) -> (Register, Register, u32)

Decode the instruction in the I-type format.

pub fn s_type(&self) -> (Register, Register, u32)

Decode the instruction in the S-type format.

pub fn b_type(&self) -> (Register, Register, u32)

Decode the instruction in the B-type format.

pub fn j_type(&self) -> (Register, u32)

Decode the instruction in the J-type format.

pub fn u_type(&self) -> (Register, u32)

Decode the instruction in the U-type format.

impl Instruction

pub const fn new( opcode: Opcode, op_a: u32, op_b: u32, op_c: u32, imm_b: bool, imm_c: bool, ) -> Self

Create a new instruction.

pub const fn is_alu_instruction(&self) -> bool

Returns if the instruction is an ALU instruction.

pub fn is_ecall_instruction(&self) -> bool

Returns if the instruction is a ecall instruction.

pub const fn is_memory_instruction(&self) -> bool

Returns if the instruction is a memory instruction.

pub const fn is_branch_instruction(&self) -> bool

Returns if the instruction is a branch instruction.

pub const fn is_jump_instruction(&self) -> bool

Returns if the instruction is a jump instruction.

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<'de> Deserialize<'de> for Instruction

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Instruction

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Instruction