Struct triton_vm::vm::VMState

pub struct VMState {
    pub program: Vec<Instruction>,
    pub public_input: VecDeque<BFieldElement>,
    pub public_output: Vec<BFieldElement>,
    pub secret_individual_tokens: VecDeque<BFieldElement>,
    pub secret_digests: VecDeque<Digest>,
    pub ram: HashMap<BFieldElement, BFieldElement>,
    pub op_stack: OpStack,
    pub jump_stack: Vec<(BFieldElement, BFieldElement)>,
    pub cycle_count: u32,
    pub instruction_pointer: usize,
    pub sponge: Option<Tip5>,
    pub halting: bool,
    /* private fields */
}

Fields

program: Vec<Instruction>

The program memory stores the instructions (and their arguments) of the program currently being executed by Triton VM. It is read-only.

public_input: VecDeque<BFieldElement>

A list of BFieldElements the program can read from using instruction read_io.

public_output: Vec<BFieldElement>

A list of BFieldElements the program can write to using instruction write_io.

secret_individual_tokens: VecDeque<BFieldElement>

A list of BFieldElements the program can read from using instruction divine.

secret_digests: VecDeque<Digest>

A list of Digests the program can read from using instruction divine_sibling.

ram: HashMap<BFieldElement, BFieldElement>

The read-write random-access memory allows Triton VM to store arbitrary data.

op_stack: OpStack

The Op-stack memory stores Triton VM’s entire operational stack.

jump_stack: Vec<(BFieldElement, BFieldElement)>

The Jump-stack memory stores the entire jump stack.

cycle_count: u32

Number of cycles the program has been running for

instruction_pointer: usize

Current instruction’s address in program memory

sponge: Option<Tip5>

The current state of the one, global Sponge that can be manipulated using instructions SpongeInit, SpongeAbsorb, and SpongeSqueeze. Instruction SpongeInit resets the Sponge.

Note that this is the full state, including capacity. The capacity should never be exposed outside the VM.

halting: bool

Indicates whether the terminating instruction halt has been executed.

Implementations

impl VMState

pub fn new( program: &Program, public_input: PublicInput, non_determinism: NonDeterminism ) -> Self

Create initial VMState for a given program

Since program is read-only across individual states, and multiple inner helper functions refer to it, a read-only reference is kept in the struct.

pub fn derive_helper_variables(&self) -> [BFieldElement; 6]

pub fn step(&mut self) -> Result<Vec<CoProcessorCall>, InstructionError>

Perform the state transition as a mutable operation on self.

pub fn to_processor_row(&self) -> Array1<BFieldElement>

pub fn current_instruction(&self) -> Result<Instruction, InstructionError>

pub fn next_instruction(&self) -> Result<Instruction, InstructionError>

Return the next instruction on the tape, skipping arguments.

Note that this is not necessarily the next instruction to execute, since the current instruction could be a jump, but it is either program[ip + 1] or program[ip + 2], depending on whether the current instruction takes an argument.

pub fn run(&mut self) -> Result<(), InstructionError>

Run Triton VM on this state to completion, or until an error occurs.

Trait Implementations

impl<'arbitrary> Arbitrary<'arbitrary> for VMState

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 VMState

fn clone(&self) -> VMState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VMState

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VMState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for VMState

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

Formats the value using the given formatter.

impl PartialEq for VMState

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for VMState

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for VMState

impl StructuralPartialEq for VMState