Struct ArchVm 

pub struct ArchVm {
    pub common: VmCommon,
    pub pio_bus: Arc<Bus>,
    /* private fields */
}

Structure representing the current architecture’s understand of what a “virtual machine” is.

Fields

common: VmCommon

Architecture independent parts of a vm

pio_bus: Arc<Bus>

Port IO bus

Implementations

impl ArchVm

pub fn new(kvm: &Kvm) -> Result<ArchVm, VmError>

Create a new Vm struct.

pub fn arch_pre_create_vcpus(&mut self, _: u8) -> Result<(), ArchVmError>

Pre-vCPU creation setup.

pub fn arch_post_create_vcpus(&mut self, _: u8) -> Result<(), ArchVmError>

Post-vCPU creation setup.

pub fn restore_state(&mut self, state: &VmState) -> Result<(), ArchVmError>

Restores the KVM VM state.

Errors

When:

• [kvm_ioctls::VmFd::set_pit] errors.
• [kvm_ioctls::VmFd::set_clock] errors.
• [kvm_ioctls::VmFd::set_irqchip] errors.
• [kvm_ioctls::VmFd::set_irqchip] errors.
• [kvm_ioctls::VmFd::set_irqchip] errors.

pub fn setup_irqchip(&self) -> Result<(), ArchVmError>

Creates the irq chip and an in-kernel device model for the PIT.

pub fn save_state(&self) -> Result<VmState, ArchVmError>

Saves and returns the Kvm Vm state.

pub fn msrs_to_save(&self) -> &[u32]

Gets the list of MSRs to save when creating snapshots

pub fn xsave2_size(&self) -> Option<usize>

Gets the size (in bytes) of the kvm_xsave struct.

impl Vm

Contains Vm functions that are usable across CPU architectures

pub fn create_common(kvm: &Kvm) -> Result<VmCommon, VmError>

Create a KVM VM

pub fn create_vcpus( &mut self, vcpu_count: u8, ) -> Result<(Vec<Vcpu>, EventFd), VmError>

Creates the specified number of Vcpus.

The returned [EventFd] is written to whenever any of the vcpus exit.

pub fn next_kvm_slot(&self, slot_cnt: u32) -> Option<u32>

Reserves the next slot_cnt contiguous kvm slot ids and returns the first one

pub fn register_dram_memory_regions( &mut self, regions: Vec<GuestRegionMmap>, ) -> Result<(), VmError>

Register a list of new memory regions to this Vm.

pub fn register_hotpluggable_memory_region( &mut self, region: GuestRegionMmap, slot_size: usize, ) -> Result<(), VmError>

Register a new hotpluggable region to this Vm.

pub fn restore_memory_regions( &mut self, regions: Vec<GuestRegionMmap>, state: &GuestMemoryState, ) -> Result<(), VmError>

Register a list of new memory regions to this Vm.

Note: regions and state.regions need to be in the same order.

pub fn fd(&self) -> &VmFd

Gets a reference to the kvm file descriptor owned by this VM.

pub fn guest_memory(&self) -> &GuestMemoryMmap

Gets a reference to this Vm’s GuestMemoryMmap object

pub fn resource_allocator(&self) -> MutexGuard<'_, ResourceAllocator>

Gets a mutable reference to this Vm’s ResourceAllocator object

pub fn reset_dirty_bitmap(&self)

Resets the KVM dirty bitmap for each of the guest’s memory regions.

pub fn reset_dirty_rings(&self) -> Result<(), VmError>

Resets the KVM dirty ring tracking for all vcpus.

pub fn get_dirty_bitmap(&self) -> Result<DirtyBitmap, VmError>

Retrieves the KVM dirty bitmap for each of the guest’s memory regions.

pub fn register_irq(&self, fd: &EventFd, gsi: u32) -> Result<(), Error>

Register a device IRQ

pub fn register_msi( &self, route: &MsixVector, masked: bool, config: MsixVectorConfig, ) -> Result<(), Error>

Register an MSI device interrupt

pub fn create_msix_group( vm: Arc<Vm>, count: u16, ) -> Result<MsixVectorGroup, InterruptError>

Create a group of MSI-X interrupts

pub fn set_gsi_routes(&self) -> Result<(), InterruptError>

Set GSI routes to KVM

Trait Implementations

impl Debug for ArchVm

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

Formats the value using the given formatter.

impl DeviceRelocation for Vm

fn move_bar( &self, _old_base: u64, _new_base: u64, _len: u64, _pci_dev: &mut dyn PciDevice, ) -> Result<(), DeviceRelocationError>

The BAR needs to be moved to a different location in the guest address space. This follows a decision from the software running in the guest.