Struct MemoryController

pub struct MemoryController<F> {
    pub memory_bus: MemoryBus,
    pub interface_chip: MemoryInterface<F>,
    pub range_checker: SharedVariableRangeCheckerChip,
    pub access_adapters: AccessAdapterInventory<F>,
    /* private fields */
}

Fields

memory_bus: MemoryBus

interface_chip: MemoryInterface<F>

range_checker: SharedVariableRangeCheckerChip

access_adapters: AccessAdapterInventory<F>

Implementations

impl<F> MemoryController<F>

pub fn mem_config(&self) -> &MemoryConfig

impl<F: PrimeField32> MemoryController<F>

pub fn continuation_enabled(&self) -> bool

pub fn with_volatile_memory( memory_bus: MemoryBus, mem_config: MemoryConfig, range_checker: SharedVariableRangeCheckerChip, ) -> Self

pub fn with_persistent_memory( memory_bus: MemoryBus, mem_config: MemoryConfig, range_checker: SharedVariableRangeCheckerChip, merkle_bus: PermutationCheckBus, compression_bus: PermutationCheckBus, ) -> Self

Creates a new memory controller for persistent memory.

Call set_initial_memory to set the initial memory state after construction.

pub fn memory_image(&self) -> &MemoryImage<F>

pub fn set_override_trace_heights( &mut self, overridden_heights: MemoryTraceHeights, )

pub fn set_initial_memory(&mut self, memory: MemoryImage<F>)

pub fn memory_bridge(&self) -> MemoryBridge

pub fn read_cell(&mut self, address_space: F, pointer: F) -> (RecordId, F)

pub fn read<const N: usize>( &mut self, address_space: F, pointer: F, ) -> (RecordId, [F; N])

pub fn unsafe_read_cell(&self, addr_space: F, ptr: F) -> F

Reads a word directly from memory without updating internal state.

Any value returned is unconstrained.

pub fn unsafe_read<const N: usize>(&self, addr_space: F, ptr: F) -> [F; N]

Reads a word directly from memory without updating internal state.

Any value returned is unconstrained.

pub fn write_cell( &mut self, address_space: F, pointer: F, data: F, ) -> (RecordId, F)

Writes data to the given cell.

Returns the RecordId and previous data.

pub fn write<const N: usize>( &mut self, address_space: F, pointer: F, data: [F; N], ) -> (RecordId, [F; N])

pub fn aux_cols_factory(&self) -> MemoryAuxColsFactory<F>

pub fn increment_timestamp(&mut self)

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

pub fn timestamp(&self) -> u32

pub fn replay_access( entry: MemoryLogEntry<F>, offline_memory: &mut OfflineMemory<F>, interface_chip: &mut MemoryInterface<F>, adapter_records: &mut AccessAdapterInventory<F>, )

Low-level API to replay a single memory access log entry and populate the OfflineMemory, MemoryInterface, and AccessAdapterInventory.

pub fn finalize<H>(&mut self, hasher: Option<&mut H>)

where H: HasherChip<CHUNK, F> + Sync + for<'a> SerialReceiver<&'a [F]>,

Returns the final memory state if persistent.

pub fn generate_air_proof_inputs<SC: StarkGenericConfig>( self, ) -> Vec<AirProofInput<SC>>

where Domain<SC>: PolynomialSpace<Val = F>,

pub fn airs<SC: StarkGenericConfig>(&self) -> Vec<AirRef<SC>>

where Domain<SC>: PolynomialSpace<Val = F>,

pub fn num_airs(&self) -> usize

Return the number of AIRs in the memory controller.

pub fn air_names(&self) -> Vec<String>

pub fn current_trace_heights(&self) -> Vec<usize>

pub fn get_memory_trace_heights(&self) -> MemoryTraceHeights

pub fn get_dummy_memory_trace_heights(&self) -> MemoryTraceHeights

pub fn current_trace_cells(&self) -> Vec<usize>

pub fn offline_memory(&self) -> Arc<Mutex<OfflineMemory<F>>>

Returns a reference to the offline memory.

Until finalize is called, the OfflineMemory does not contain useful state, and should therefore not be used by any chip during execution. However, to obtain a reference to the offline memory that will be useful in trace generation, a chip can call offline_memory() and store the returned reference for later use.

pub fn get_memory_logs(&self) -> &Vec<MemoryLogEntry<F>>

pub fn set_memory_logs(&mut self, logs: Vec<MemoryLogEntry<F>>)

pub fn take_memory_logs(&mut self) -> Vec<MemoryLogEntry<F>>