Struct vm_memory::mmap::MmapRegion

pub struct MmapRegion<B> { /* private fields */ }

Helper structure for working with mmaped memory regions in Unix.

The structure is used for accessing the guest’s physical memory by mmapping it into the current process.

Limitations

When running a 64-bit virtual machine on a 32-bit hypervisor, only part of the guest’s physical memory may be mapped into the current process due to the limited virtual address space size of the process.

Implementations

impl<B: NewBitmap> MmapRegion<B>

pub fn new(size: usize) -> Result<Self>

Creates a shared anonymous mapping of size bytes.

Arguments

• size - The size of the memory region in bytes.

pub fn from_file(file_offset: FileOffset, size: usize) -> Result<Self>

Creates a shared file mapping of size bytes.

Arguments

• file_offset - The mapping will be created at offset file_offset.start in the file referred to by file_offset.file.
• size - The size of the memory region in bytes.

impl<B: Bitmap> MmapRegion<B>

pub fn as_ptr(&self) -> *mut u8

Returns a pointer to the beginning of the memory region. Mutable accesses performed using the resulting pointer are not automatically accounted for by the dirty bitmap tracking functionality.

Should only be used for passing this region to ioctls for setting guest memory.

pub fn size(&self) -> usize

Returns the size of this region.

pub fn file_offset(&self) -> Option<&FileOffset>

Returns information regarding the offset into the file backing this region (if any).

pub fn bitmap(&self) -> &B

Returns a reference to the inner bitmap object.

Trait Implementations

impl<B: Debug> Debug for MmapRegion<B>

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

Formats the value using the given formatter.

impl<B> Drop for MmapRegion<B>

fn drop(&mut self)

Executes the destructor for this type.

impl<B: Bitmap> VolatileMemory for MmapRegion<B>

type B = B

Type used for dirty memory tracking.

fn len(&self) -> usize

Gets the size of this slice.

fn get_slice(
    &self,
    offset: usize,
    count: usize
) -> Result<VolatileSlice<'_, BS<'_, Self::B>>>

Returns a VolatileSlice of count bytes starting at offset.

fn is_empty(&self) -> bool

Check whether the region is empty.

fn as_volatile_slice(&self) -> VolatileSlice<'_, BS<'_, Self::B>>

Gets a slice of memory for the entire region that supports volatile access.

fn get_ref<T: ByteValued>(
    &self,
    offset: usize
) -> Result<VolatileRef<'_, T, BS<'_, Self::B>>>

Gets a VolatileRef at offset.

fn get_array_ref<T: ByteValued>(
    &self,
    offset: usize,
    n: usize
) -> Result<VolatileArrayRef<'_, T, BS<'_, Self::B>>>

Returns a VolatileArrayRef of n elements starting at offset.

unsafe fn aligned_as_ref<T: ByteValued>(&self, offset: usize) -> Result<&T>

Returns a reference to an instance of T at offset.

unsafe fn aligned_as_mut<T: ByteValued>(&self, offset: usize) -> Result<&mut T>

Returns a mutable reference to an instance of T at offset. Mutable accesses performed using the resulting reference are not automatically accounted for by the dirty bitmap tracking functionality.

fn get_atomic_ref<T: AtomicInteger>(&self, offset: usize) -> Result<&T>

Returns a reference to an instance of T at offset. Mutable accesses performed using the resulting reference are not automatically accounted for by the dirty bitmap tracking functionality.

fn compute_end_offset(&self, base: usize, offset: usize) -> Result<usize>

Returns the sum of base and offset if the resulting address is valid.

impl<B: Send> Send for MmapRegion<B>

impl<B: Sync> Sync for MmapRegion<B>