Struct TracingMemory 

pub struct TracingMemory {
    pub timestamp: u32,
    pub data: GuestMemory,
    pub min_block_size: Vec<u32>,
    pub access_adapter_records: DenseRecordArena,
    /* private fields */
}

Online memory that stores additional information for trace generation purposes. In particular, keeps track of timestamp.

Fields

timestamp: u32

data: GuestMemory

The underlying data memory, with memory cells typed by address space: see AddressMap.

min_block_size: Vec<u32>

For each addr_space, the minimum block size allowed for memory accesses. In other words, all memory accesses in addr_space must be aligned to this block size.

access_adapter_records: DenseRecordArena

Implementations

impl TracingMemory

pub fn data(&self) -> &GuestMemory

The underlying data memory, with memory cells typed by address space: see AddressMap.

impl TracingMemory

pub fn new( mem_config: &MemoryConfig, initial_block_size: usize, access_adapter_arena_size_bound: usize, ) -> Self

pub fn from_image( image: GuestMemory, initial_block_size: usize, access_adapter_arena_size_bound: usize, ) -> Self

Constructor from pre-existing memory image.

pub unsafe fn read<T, const BLOCK_SIZE: usize, const ALIGN: usize>( &mut self, address_space: u32, pointer: u32, ) -> (u32, [T; BLOCK_SIZE])

where T: Copy + Debug,

Atomic read operation which increments the timestamp by 1. Returns (t_prev, [pointer:BLOCK_SIZE]_{address_space}) where t_prev is the timestamp of the last memory access.

The previous memory access is treated as atomic even if previous accesses were for a smaller block size. This is made possible by internal memory access adapters that split/merge memory blocks. More specifically, the last memory access corresponding to t_prev may refer to an atomic access inserted by the memory access adapters.

Assumptions

The BLOCK_SIZE is a multiple of ALIGN, which must equal the minimum block size of address_space.

Safety

The type T must be stack-allocated repr(C) or repr(transparent), plain old data, and it must be the exact type used to represent a single memory cell in address space address_space. For standard usage, T is either u8 or F where F is the base field of the ZK backend.

In addition:

• address_space must be valid.

pub unsafe fn write<T, const BLOCK_SIZE: usize, const ALIGN: usize>( &mut self, address_space: u32, pointer: u32, values: [T; BLOCK_SIZE], ) -> (u32, [T; BLOCK_SIZE])

where T: Copy + Debug,

Atomic write operation that writes values into [pointer:BLOCK_SIZE]_{address_space} and then increments the timestamp by 1. Returns (t_prev, values_prev) which equal the timestamp and value [pointer:BLOCK_SIZE]_{address_space} of the last memory access.

The previous memory access is treated as atomic even if previous accesses were for a smaller block size. This is made possible by internal memory access adapters that split/merge memory blocks. More specifically, the last memory access corresponding to t_prev may refer to an atomic access inserted by the memory access adapters.

Assumptions

The BLOCK_SIZE is a multiple of ALIGN, which must equal the minimum block size of address_space.

Safety

The type T must be stack-allocated repr(C) or repr(transparent), and it must be the exact type used to represent a single memory cell in address space address_space. For standard usage, T is either u8 or F where F is the base field of the ZK backend.

In addition:

• address_space must be valid.

pub fn increment_timestamp(&mut self)

pub fn increment_timestamp_by(&mut self, amount: u32)

pub fn timestamp(&self) -> u32

pub fn finalize<F: Field>(&mut self, is_persistent: bool) -> TouchedMemory<F>

Finalize the boundary and merkle chips.

pub fn address_space_alignment(&self) -> Vec<u8>