Struct ReadonlySharedMemory 

pub struct ReadonlySharedMemory { /* private fields */ }

A ReadonlySharedMemory is a different kind of shared memory, separate from the exclusive/host/guest lifecycle, used to represent read-only mappings of snapshot pages into the guest efficiently.

Trait Implementations

impl AsRef<[u8]> for ReadonlySharedMemory

fn as_ref(&self) -> &[u8]

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

impl Clone for ReadonlySharedMemory

fn clone(&self) -> ReadonlySharedMemory

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReadonlySharedMemory

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

Formats the value using the given formatter.

impl<S: SharedMemory> PartialEq<S> for ReadonlySharedMemory

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

Tests for self and other values to be equal, and is used by ==.

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 SharedMemory for ReadonlySharedMemory

fn region(&self) -> &HostMapping

Return a readonly reference to the host mapping backing this SharedMemory

fn with_exclusivity<T, F: FnOnce(&mut ExclusiveSharedMemory) -> T>( &mut self, _: F, ) -> Result<T>

Run some code with exclusive access to the SharedMemory underlying this. If the SharedMemory is not an ExclusiveSharedMemory, any concurrent accesses to the relevant HostSharedMemory/GuestSharedMemory may make this fail, or be made to fail by this, and should be avoided.

fn with_contents<T, F: FnOnce(&[u8]) -> T>(&mut self, f: F) -> Result<T>

Run some code that is allowed to access the contents of the SharedMemory as if it is a normal slice. By default, this is implemented via SharedMemory::with_exclusivity, which is the correct implementation for a memory that can be mutated, but a ReadonlySharedMemory, can support this.

fn base_addr(&self) -> usize

Return the base address of the host mapping of this region. Following the general Rust philosophy, this does not need to be marked as unsafe because doing anything with this pointer itself requires unsafe.

fn base_ptr(&self) -> *mut u8

Return the base address of the host mapping of this region as a pointer. Following the general Rust philosophy, this does not need to be marked as unsafe because doing anything with this pointer itself requires unsafe.

fn mem_size(&self) -> usize

Return the length of usable memory contained in self. The returned size does not include the size of the surrounding guard pages.

fn raw_ptr(&self) -> *mut u8

Return the raw base address of the host mapping, including the guard pages.

fn raw_mem_size(&self) -> usize

Return the raw size of the host mapping, including the guard pages.

fn host_region_base( &self, ) -> <HostGuestMemoryRegion as MemoryRegionKind>::HostBaseType

Extract a base address that can be mapped into a VM for this SharedMemory.

fn host_region_end( &self, ) -> <HostGuestMemoryRegion as MemoryRegionKind>::HostBaseType

Return the end address of the host region (base + usable size).

fn zero(&mut self) -> Result<()>

Zero a shared memory region

impl Send for ReadonlySharedMemory

impl Sync for ReadonlySharedMemory