Struct MmapMemory

pub struct MmapMemory {
    pub flags: u32,
    pub memory_size: usize,
    pub guest_address: GuestPhysAddr,
    pub host_address: *mut u8,
}

A general purpose VM memory section that can exploit some Linux Kernel features.

Fields

flags: u32

memory_size: usize

guest_address: GuestPhysAddr

host_address: *mut u8

Implementations

impl MmapMemory

pub fn new( flags: u32, memory_size: usize, guest_address: GuestPhysAddr, huge_pages: bool, mergeable: bool, ) -> MmapMemory

pub unsafe fn as_slice_mut(&self) -> &mut [u8]

This can create multiple aliasing. During the lifetime of the returned slice, the memory must not be altered, dropped or simmilar.

pub unsafe fn as_slice_uninit_mut(&self) -> &mut [MaybeUninit<u8>]

Same as [as_slice_mut], but for MaybeUninit<u8>. Actually the memory is initialized, as Mmap zero initializes it, but some fns like [hermit_entry::elf::load_kernel] require MaybeUninits.

pub unsafe fn slice_at( &self, addr: GuestPhysAddr, len: usize, ) -> Result<&[u8], MemoryError>

Read a section of the memory.

Safety

This is unsafe, as can create multiple aliasing. During the lifetime of the returned slice, the memory must not be altered to prevent undfined behaviour.

pub unsafe fn slice_at_mut( &self, addr: GuestPhysAddr, len: usize, ) -> Result<&mut [u8], MemoryError>

Writeable access to a section of the memory.

Safety

This is unsafe, as it can create multiple aliasing. During the lifetime of the returned slice, the memory must not be altered to prevent undfined behavior.

pub fn host_address( &self, addr: GuestPhysAddr, ) -> Result<*const u8, MemoryError>

Returns the host address of the given internal physical address in the memory, if the address is valid.

pub fn read<T>(&self, addr: GuestPhysAddr) -> Result<T, MemoryError>

Read the value in the memory at the given address

pub unsafe fn get_ref<T>(&self, addr: GuestPhysAddr) -> Result<&T, MemoryError>

Get a reference to the type at the given address in the memory.

pub unsafe fn get_ref_mut<T>( &self, addr: GuestPhysAddr, ) -> Result<&mut T, MemoryError>

Get a mutable reference to the type at the given address in the memory.

Trait Implementations

impl Debug for MmapMemory

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

Formats the value using the given formatter.

impl Drop for MmapMemory

fn drop(&mut self)

Executes the destructor for this type.

impl Index<usize> for MmapMemory

type Output = u8

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.