Struct MemoryInstance

pub struct MemoryInstance { /* private fields */ }

The memory of the VM, represented as stack and heap.

Implementations

impl MemoryInstance

pub fn new() -> Self

Create a new VM memory.

pub fn reset(&mut self)

Resets memory to initial state, keeping the original allocations.

pub fn into_linear_memory(self) -> Vec<u8>

Returns a linear memory representation where stack is at the beginning and heap is at the end.

pub fn grow_stack(&mut self, new_sp: Word) -> Result<(), PanicReason>

Grows the stack to be at least new_sp bytes.

pub fn grow_heap_by( &mut self, sp_reg: Reg<'_, SP>, hp_reg: RegMut<'_, HP>, amount: Word, ) -> Result<(), PanicReason>

Grows the heap by amount bytes. Updates hp register.

pub fn verify<A: ToAddr, B: ToAddr>( &self, addr: A, count: B, ) -> Result<MemoryRange, PanicReason>

Verify that the memory range is accessble and return it as a range.

pub fn verify_const<A: ToAddr, const C: usize>( &self, addr: A, ) -> Result<MemoryRange, PanicReason>

Verify a constant-sized memory range.

pub fn read<A: ToAddr, C: ToAddr>( &self, addr: A, count: C, ) -> Result<&[u8], PanicReason>

Returns a reference to memory for reading, if possible.

pub fn read_bytes<A: ToAddr, const C: usize>( &self, at: A, ) -> Result<[u8; C], PanicReason>

Reads a constant-sized byte array from memory, if possible.

pub fn write_noownerchecks<A: ToAddr, B: ToAddr>( &mut self, addr: A, len: B, ) -> Result<&mut [u8], PanicReason>

Gets write access to memory, if possible. Doesn’t perform any ownership checks.

pub fn write_bytes_noownerchecks<A: ToAddr, const C: usize>( &mut self, addr: A, data: [u8; C], ) -> Result<(), PanicReason>

Writes a constant-sized byte array to memory, if possible. Doesn’t perform any ownership checks.

pub fn write<A: ToAddr, C: ToAddr>( &mut self, owner: OwnershipRegisters, addr: A, len: C, ) -> Result<&mut [u8], PanicReason>

Checks that memory is writable and returns a mutable slice to it.

pub fn write_bytes<A: ToAddr, const C: usize>( &mut self, owner: OwnershipRegisters, addr: A, data: [u8; C], ) -> Result<(), PanicReason>

Writes a constant-sized byte array to memory, checking for ownership.

pub fn memcopy( &mut self, dst: Word, src: Word, length: Word, owner: OwnershipRegisters, ) -> Result<(), PanicReason>

Copies the memory from src to dst verifying ownership.

Trait Implementations

impl AsMut<MemoryInstance> for MemoryInstance

fn as_mut(&mut self) -> &mut MemoryInstance

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<MemoryInstance> for MemoryInstance

fn as_ref(&self) -> &MemoryInstance

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for MemoryInstance

fn clone(&self) -> MemoryInstance

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MemoryInstance

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

Formats the value using the given formatter.

impl Default for MemoryInstance

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for MemoryInstance

fn eq(&self, other: &Self) -> bool

Equality comparison of the accessible memory.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for MemoryInstance