Struct Program

pub struct Program {
    pub instructions: Vec<Instruction>,
    pub pc_start: u32,
    pub pc_base: u32,
    pub memory_image: HashMap<u32, u32>,
    pub preprocessed_shape: Option<Shape<RiscvAirId>>,
}

A program that can be executed by the SP1 zkVM.

Contains a series of instructions along with the initial memory image. It also contains the start address and base address of the program.

Fields

instructions: Vec<Instruction>

The instructions of the program.

pc_start: u32

The start address of the program.

pc_base: u32

The base address of the program.

memory_image: HashMap<u32, u32>

The initial memory image, useful for global constants.

preprocessed_shape: Option<Shape<RiscvAirId>>

The shape for the preprocessed tables.

Implementations

impl Program

pub fn new(instructions: Vec<Instruction>, pc_start: u32, pc_base: u32) -> Self

Create a new Program.

pub fn from(input: &[u8]) -> Result<Self>

Disassemble a RV32IM ELF to a program that be executed by the VM.

Errors

This function may return an error if the ELF is not valid.

pub fn from_elf(path: &str) -> Result<Self>

Disassemble a RV32IM ELF to a program that be executed by the VM from a file path.

Errors

This function will return an error if the file cannot be opened or read.

pub fn fixed_log2_rows<F: Field, A: MachineAir<F>>( &self, air: &A, ) -> Option<usize>

Custom logic for padding the trace to a power of two according to the proof shape.

pub fn fetch(&self, pc: u32) -> &Instruction

Fetch the instruction at the given program counter.

Trait Implementations

impl Clone for Program

fn clone(&self) -> Program

Returns a duplicate 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<F: PrimeField32> MachineProgram<F> for Program

fn pc_start(&self) -> F

Gets the starting program counter.

fn initial_global_cumulative_sum(&self) -> SepticDigest<F>

Gets the initial global cumulative sum.

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.