Struct BasicMemory 

pub struct BasicMemory<const BASE_ADDR: u64, const SIZE: usize> { /* private fields */ }

Basic memory implementation.

Flat structure, no rwx protections, no alignment requirements. It uses stack, so for larger allocation it’ll need to be boxed (zero-initialized is fine) or a custom implementation to be used.

This implementation is intentionally basic and correct, but not the most performant. It is possible to have a more efficient implementation that skips certain checks by placing additional constraints on the program.

This works for simpler cases, while a more sophisticated implementation might prevent certain memory from being writable, supporting actual virtual memory with dynamically allocated memory pages, etc.

Implementations

impl<const BASE_ADDR: u64, const SIZE: usize> BasicMemory<BASE_ADDR, SIZE>

pub fn get_mut_bytes( &mut self, address: u64, size: usize, ) -> Result<&mut [u8], VirtualMemoryError>

Get a mutable slice of memory.

This is primarily useful for setting up the program and should not be used beyond that.

Trait Implementations

impl<const BASE_ADDR: u64, const SIZE: usize> Clone for BasicMemory<BASE_ADDR, SIZE>

fn clone(&self) -> BasicMemory<BASE_ADDR, SIZE>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const BASE_ADDR: u64, const SIZE: usize> Debug for BasicMemory<BASE_ADDR, SIZE>

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

Formats the value using the given formatter.

impl<const BASE_ADDR: u64, const SIZE: usize> Default for BasicMemory<BASE_ADDR, SIZE>

fn default() -> Self

Returns the “default value” for a type.

impl<const BASE_ADDR: u64, const SIZE: usize> VirtualMemory for BasicMemory<BASE_ADDR, SIZE>

fn read<T>(&self, address: u64) -> Result<T, VirtualMemoryError>

where T: BasicInt,

Read a value from memory at the specified address

unsafe fn read_unchecked<T>(&self, address: u64) -> T

where T: BasicInt,

Unchecked read a value from memory at the specified address.

fn read_slice( &self, address: u64, len: u32, ) -> Result<&[u8], VirtualMemoryError>

Read a contiguous byte slice from memory

fn read_slice_up_to(&self, address: u64, len: u32) -> &[u8]

Read as many contiguous bytes as possible starting at address, up to len bytes total.

fn write<T>(&mut self, address: u64, value: T) -> Result<(), VirtualMemoryError>

where T: BasicInt,

Write a value to memory at the specified address

fn write_slice( &mut self, address: u64, data: &[u8], ) -> Result<(), VirtualMemoryError>

Write a contiguous byte slice to memory

impl<const BASE_ADDR: u64, const SIZE: usize> Copy for BasicMemory<BASE_ADDR, SIZE>