Struct triton_vm::program::Program

pub struct Program {
    pub instructions: Vec<Instruction>,
}

A Program is a Vec<Instruction> that contains duplicate elements for instructions with a size of 2. This means that the index in the vector corresponds to the VM’s instruction_pointer. These duplicate values should most often be skipped/ignored, e.g. when pretty-printing.

Fields

instructions: Vec<Instruction>

Implementations

impl Program

pub fn new(input: &[LabelledInstruction]) -> Self

Create a Program from a slice of Instruction.

pub fn from_code(code: &str) -> Result<Self>

Create a Program by parsing source code.

pub fn to_bwords(&self) -> Vec<BFieldElement>

Convert a Program to a Vec<BFieldElement>.

Every single-word instruction is converted to a single word.

Every double-word instruction is converted to two words.

pub fn len_bwords(&self) -> usize

The total length of the program as BFieldElements. Double-word instructions contribute two BFieldElements.

pub fn is_empty(&self) -> bool

pub fn hash<H: AlgebraicHasher>(&self) -> Digest

Hash the program using the given AlgebraicHasher.

pub fn run( &self, public_input: PublicInput, non_determinism: NonDeterminism<BFieldElement> ) -> Result<Vec<BFieldElement>>

Run Triton VM on the given Program with the given public and secret input.

See also trace_execution and debug.

pub fn trace_execution( &self, public_input: PublicInput, non_determinism: NonDeterminism<BFieldElement> ) -> Result<(AlgebraicExecutionTrace, Vec<BFieldElement>)>

Trace the execution of a Program. That is, run the Program and additionally record that part of every encountered state that is necessary for proving correct execution. If execution succeeds, returns

1. an AlgebraicExecutionTrace, and
2. the output of the program.

See also debug and run.

pub fn debug<'pgm>( &'pgm self, public_input: PublicInput, non_determinism: NonDeterminism<BFieldElement>, initial_state: Option<VMState<'pgm>>, num_cycles_to_execute: Option<u32> ) -> (Vec<VMState<'pgm>>, Option<Error>)

Similar to run, but also returns a Vec of VMStates, one for each step of the VM. On premature termination of the VM, returns all VMStates up to the point of failure.

The VM’s initial state is either the provided initial_state, or a new VMState if initial_state is None. The initial state is included in the returned Vec of VMStates. If an initial state is provided, the program, public_input and private_input provided to this method are ignored and the initial state’s program and inputs are used instead.

If num_cycles_to_execute is Some(number_of_cycles), the VM will execute at most number_of_cycles cycles. If num_cycles_to_execute is None, the VM will execute until it halts or the maximum number of cycles (2^{32}) is reached.

See also debug_terminal_state and trace_execution.

pub fn debug_terminal_state<'pgm>( &'pgm self, public_input: PublicInput, non_determinism: NonDeterminism<BFieldElement>, initial_state: Option<VMState<'pgm>>, num_cycles_to_execute: Option<u32> ) -> Result<VMState<'pgm>, (Error, VMState<'pgm>)>

Run Triton VM on the given Program with the given public and secret input, and return the final VMState. Requires substantially less RAM than debug since no intermediate states are recorded.

Parameters initial_state and num_cycles_to_execute are handled like in debug; see there for more details.

If an error is encountered, returns the error and the VMState at the point of failure.

See also trace_execution and run.

pub fn profile( labelled_instructions: &[LabelledInstruction], public_input: PublicInput, non_determinism: NonDeterminism<BFieldElement> ) -> Result<(Vec<BFieldElement>, Vec<ProfileLine>)>

Run Triton VM on the given program with the given public and secret input, but record the number of cycles spent in each callable block of instructions. This function returns a Result wrapping a program profiler report, which is a Vec of ProfileLines.

Note that the program is given as a list of LabelledInstructions rather than as a Program because the labels are needed to build a meaningful profiler report.

See also run, trace_execution and debug.

Trait Implementations

impl BFieldCodec for Program

fn decode(sequence: &[BFieldElement]) -> Result<Box<Self>>

fn encode(&self) -> Vec<BFieldElement>

fn static_length() -> Option<usize>

Returns the length in number of BFieldElements if it is known at compile-time. Otherwise, None.

impl Clone for Program

fn clone(&self) -> Program

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Program

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

Formats the value using the given formatter.

impl Default for Program

fn default() -> Program

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Program

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

Deserialize this value from the given Serde deserializer.

impl Display for Program

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

Formats the value using the given formatter.

impl GetSize for Program

fn get_heap_size(&self) -> usize

Determines how many bytes this object occupies inside the heap.

fn get_stack_size() -> usize

Determines how may bytes this object occupies inside the stack.

fn get_size(&self) -> usize

Determines the total size of the object.

impl IntoIterator for Program

type Item = AnInstruction<BFieldElement>

The type of the elements being iterated over.

type IntoIter = InstructionIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq<Program> for Program

fn eq(&self, other: &Program) -> 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 Program

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 Program

impl StructuralEq for Program

impl StructuralPartialEq for Program