Struct MemoryLayout

pub struct MemoryLayout { /* private fields */ }

Describes the memory layout of a guest.

Implementations

impl MemoryLayout

pub fn new( ram_size: u64, gaps: &[MemoryRange], vtl2_range: Option<MemoryRange>, ) -> Result<Self, Error>

Makes a new memory layout for a guest with ram_size bytes of memory and MMIO gaps at the locations specified by gaps.

ram_size must be a multiple of the page size. Each gap must be non-empty, and the gaps must be in order and non-overlapping.

vtl2_range describes a range of memory reserved for VTL2. It is not reported in ram.

All RAM is assigned to NUMA node 0.

pub fn new_from_ranges( memory: &[MemoryRangeWithNode], gaps: &[MemoryRange], ) -> Result<Self, Error>

Makes a new memory layout for a guest with the given mmio gaps and memory ranges.

memory and gaps ranges must be in sorted order and non-overlapping, and describe page aligned ranges.

pub fn mmio(&self) -> &[MemoryRange]

The MMIO gap ranges.

pub fn ram(&self) -> &[MemoryRangeWithNode]

The populated RAM ranges. This does not include the vtl2_range.

pub fn vtl2_range(&self) -> Option<MemoryRange>

A special memory range for VTL2, if any. This memory range is treated like RAM, but is only used to hold VTL2 and is located above ram and mmio.

pub fn ram_size(&self) -> u64

The total RAM size in bytes. This is not contiguous.

pub fn end_of_ram(&self) -> u64

One past the last byte of RAM.

pub fn ram_below_4gb(&self) -> u64

The bytes of RAM below 4GB.

pub fn ram_above_4gb(&self) -> u64

The bytes of RAM at or above 4GB.

pub fn ram_above_high_mmio(&self) -> Option<u64>

The bytes of RAM above the high MMIO gap.

Returns None if there aren’t exactly 2 MMIO gaps.

pub fn max_ram_below_4gb(&self) -> Option<u64>

The ending RAM address below 4GB.

Returns None if there is no RAM mapped below 4GB.

pub fn end_of_ram_or_mmio(&self) -> u64

One past the last byte of RAM, or the highest mmio range.

Trait Implementations

impl Clone for MemoryLayout

fn clone(&self) -> MemoryLayout

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MemoryLayout

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

Formats the value using the given formatter.

impl Inspect for MemoryLayout

fn inspect(&self, req: Request<'_>)

Inspects the object.