Struct risc0_binfmt::MemoryImage

pub struct MemoryImage {
    pub pages: BTreeMap<u32, Vec<u8>>,
    pub info: PageTableInfo,
    pub pc: u32,
}

An image of a zkVM guest’s memory

This is an image of the full memory state of the zkVM, including the data, text, inputs, page table, and system memory. In addition to the memory image proper, this includes some metadata about the page table.

Fields

pages: BTreeMap<u32, Vec<u8>>

Sparse memory memory image as a map from page index to page.

info: PageTableInfo

Metadata about the structure of the page table

pc: u32

Program Counter from Program entry point

Implementations

impl MemoryImage

pub fn new(program: &Program, page_size: u32) -> Result<Self>

Construct the initial memory image for program

The result is a MemoryImage with the ELF of program loaded (but execution not yet begun), and with the page table Merkle tree constructed.

pub fn load_page(&self, page_idx: u32) -> Vec<u8>

Load a page specified by page_idx. If no page is found, a zero page is returned.

pub fn store_region_in_page(&mut self, addr: u32, bytes: &[u8])

Writes the given byte array in this memory image at the given address. The caller is responsible for ensuring the bytes do not overlap a page boundary.

pub fn load_region_in_page(&self, addr: u32, bytes: &mut [u8]) -> Result<()>

Reads the given byte array in this memory image at the given address The caller is responsible for ensuring the bytes do not overlap a page boundary.

pub fn hash_pages(&mut self) -> Result<()>

Calculate and update the image merkle tree within this image.

pub fn hash_pages_iter<I: Iterator<Item = u32>>( &mut self, iter: I ) -> Result<()>

Calculate and update the image merkle tree within this image based on the supplied page indices.

pub fn compute_root_hash(&self) -> Result<Digest>

Compute and return the root merkle entry of this image.

pub fn compute_id(&self) -> Result<Digest>

Compute and return the ImageID of this image.

pub fn get_system_state(&self) -> Result<SystemState>

Return the SystemState for this image.

Trait Implementations

impl Clone for MemoryImage

fn clone(&self) -> MemoryImage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'de> Deserialize<'de> for MemoryImage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for MemoryImage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.