Struct AddressSpaceRegion

pub struct AddressSpaceRegion {
    pub ty: AddressSpaceRegionType,
    pub base: GuestAddress,
    pub size: GuestUsize,
    pub host_numa_node_id: Option<u32>,
    /* private fields */
}

Struct to maintain configuration information about a guest address region.

Fields

ty: AddressSpaceRegionType

Type of address space regions.

base: GuestAddress

Base address of the region in virtual machine’s physical address space.

size: GuestUsize

Size of the address space region.

host_numa_node_id: Option<u32>

Host NUMA node ids assigned to this region.

Implementations

impl AddressSpaceRegion

pub fn new( ty: AddressSpaceRegionType, base: GuestAddress, size: GuestUsize, ) -> Self

Create an address space region with default configuration.

pub fn build( ty: AddressSpaceRegionType, base: GuestAddress, size: GuestUsize, host_numa_node_id: Option<u32>, file_offset: Option<FileOffset>, perm_flags: i32, prot_flags: i32, is_hotplug: bool, ) -> Self

Create an address space region with all configurable information.

Arguments

• ty - Type of the address region
• base - Base address in VM to map content
• size - Length of content to map
• numa_node_id - Optional NUMA node id to allocate memory from
• file_offset - Optional file descriptor and offset to map content from
• perm_flags - mmap permission flags
• prot_flags - mmap protection flags
• is_hotplug - Whether it’s a region for hotplug.

pub fn create_default_memory_region( base: GuestAddress, size: GuestUsize, numa_node_id: Option<u32>, mem_type: &str, mem_file_path: &str, mem_prealloc: bool, is_hotplug: bool, ) -> Result<AddressSpaceRegion, AddressSpaceError>

Create an address space region to map memory into the virtual machine.

Arguments

• base - Base address in VM to map content
• size - Length of content to map
• numa_node_id - Optional NUMA node id to allocate memory from
• mem_type - Memory mapping from, ‘shmem’ or ‘hugetlbfs’
• mem_file_path - Memory file path
• mem_prealloc - Whether to enable pre-allocation of guest memory
• is_hotplug - Whether it’s a region for hotplug.

pub fn create_memory_region( base: GuestAddress, size: GuestUsize, numa_node_id: Option<u32>, mem_type: &str, mem_file_path: &str, mem_prealloc: bool, prot_flags: i32, is_hotplug: bool, ) -> Result<AddressSpaceRegion, AddressSpaceError>

Create an address space region to map memory from memfd/hugetlbfs into the virtual machine.

Arguments

• base - Base address in VM to map content
• size - Length of content to map
• numa_node_id - Optional NUMA node id to allocate memory from
• mem_type - Memory mapping from, ‘shmem’ or ‘hugetlbfs’
• mem_file_path - Memory file path
• mem_prealloc - Whether to enable pre-allocation of guest memory
• is_hotplug - Whether it’s a region for hotplug.
• prot_flags - mmap protection flags

pub fn create_device_region( base: GuestAddress, size: GuestUsize, ) -> Result<AddressSpaceRegion, AddressSpaceError>

Create an address region for device MMIO.

Arguments

• base - Base address in VM to map content
• size - Length of content to map

pub fn region_type(&self) -> AddressSpaceRegionType

Get type of the address space region.

pub fn len(&self) -> GuestUsize

Get size of region.

pub fn start_addr(&self) -> GuestAddress

Get the inclusive start physical address of the region.

pub fn last_addr(&self) -> GuestAddress

Get the inclusive end physical address of the region.

pub fn perm_flags(&self) -> i32

Get mmap permission flags of the address space region.

pub fn set_perm_flags(&mut self, perm_flags: i32)

Set mmap permission flags for the address space region.

pub fn prot_flags(&self) -> i32

Get mmap protection flags of the address space region.

pub fn set_prot_flags(&mut self, prot_flags: i32)

Set mmap protection flags for the address space region.

pub fn host_numa_node_id(&self) -> Option<u32>

Get host_numa_node_id flags

pub fn set_host_numa_node_id(&mut self, host_numa_node_id: Option<u32>)

Set associated NUMA node ID to allocate memory from for this region.

pub fn has_file(&self) -> bool

Check whether the address space region is backed by a memory file.

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

Get optional file associated with the region.

pub fn set_file_offset(&mut self, file_offset: Option<FileOffset>)

Set associated file/offset pair for the region.

pub fn set_hotplug(&mut self)

Set the hotplug hint.

pub fn is_hotplug(&self) -> bool

Get the hotplug hint.

pub fn set_hugepage(&mut self)

Set hugepage hint for madvise(), only takes effect when the memory type is shmem.

pub fn is_hugepage(&self) -> bool

Get the hugepage hint.

pub fn set_anonpage(&mut self)

Set the anonymous memory hint.

pub fn is_anonpage(&self) -> bool

Get the anonymous memory hint.

pub fn is_valid(&self) -> bool

Check whether the address space region is valid.

pub fn intersect_with(&self, other: &AddressSpaceRegion) -> bool

Check whether the address space region intersects with another one.

Trait Implementations

impl Clone for AddressSpaceRegion

fn clone(&self) -> AddressSpaceRegion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AddressSpaceRegion

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

Formats the value using the given formatter.