Struct KvmVm 

pub struct KvmVm { /* private fields */ }

Virtual machine implementation for Linux KVM.

This wraps a KVM VM and provides the platform-agnostic interface.

Implementations

impl KvmVm

pub fn id(&self) -> u64

Returns the VM ID.

pub fn config(&self) -> &VmConfig

Returns the VM configuration.

pub fn state(&self) -> VmState

Returns the current VM state.

pub fn is_running(&self) -> bool

Returns whether the VM is running.

pub fn add_memory_region( &self, guest_addr: GuestAddress, host_addr: *mut u8, size: u64, read_only: bool, ) -> Result<u32, HypervisorError>

Adds an additional memory region to the VM.

pub fn remove_memory_region(&self, slot: u32) -> Result<(), HypervisorError>

Removes a memory region from the VM.

pub fn set_irq_line(&self, gsi: u32, level: bool) -> Result<(), HypervisorError>

Sets the IRQ line level on the in-kernel irqchip.

For edge-triggered interrupts, call with level=true then level=false. For level-triggered interrupts, keep level=true until acknowledged.

Arguments

• gsi - Global System Interrupt number
• level - true to assert, false to deassert

pub fn trigger_edge_irq(&self, gsi: u32) -> Result<(), HypervisorError>

Triggers an edge-triggered interrupt.

Convenience method that asserts then immediately deasserts the IRQ line.

pub fn register_irqfd( &self, eventfd: RawFd, gsi: u32, resample_fd: Option<RawFd>, ) -> Result<(), HypervisorError>

Registers an eventfd for IRQ injection (IRQFD).

When the eventfd is signaled (write 1 to it), KVM will automatically inject the specified GSI into the guest. This is the most efficient method for interrupt delivery.

Arguments

• eventfd - The eventfd file descriptor
• gsi - The GSI to inject when eventfd is signaled
• resample_fd - For level-triggered IRQs, optional resample eventfd

pub fn unregister_irqfd( &self, eventfd: RawFd, gsi: u32, ) -> Result<(), HypervisorError>

Unregisters an eventfd for IRQ injection.

pub fn virtio_devices(&self) -> Result<Vec<VirtioDeviceInfo>, HypervisorError>

Returns a copy of the attached VirtIO devices info.

pub fn enable_dirty_tracking(&self) -> Result<(), HypervisorError>

Enables dirty page tracking for all memory regions.

When enabled, KVM tracks which pages have been written to by the guest. Use get_dirty_pages to retrieve and clear the dirty page bitmap.

This is useful for:

• Live migration: Only transfer modified pages
• Snapshotting: Track incremental changes

Errors

Returns an error if dirty logging cannot be enabled.

pub fn disable_dirty_tracking(&self) -> Result<(), HypervisorError>

Disables dirty page tracking for all memory regions.

Errors

Returns an error if dirty logging cannot be disabled.

pub fn is_dirty_tracking_enabled(&self) -> bool

Returns whether dirty page tracking is enabled.

pub fn get_dirty_pages(&self) -> Result<Vec<DirtyPageInfo>, HypervisorError>

Gets the list of dirty pages across all memory regions.

This retrieves and clears the dirty page bitmap from KVM. Each call returns pages that were written since the last call.

Errors

Returns an error if dirty tracking is not enabled or if the dirty log cannot be retrieved.

Trait Implementations

impl Drop for KvmVm

fn drop(&mut self)

Executes the destructor for this type.

impl VirtualMachine for KvmVm

type Vcpu = KvmVcpu

The vCPU type for this VM.

type Memory = KvmMemory

The guest memory type for this VM.

fn memory(&self) -> &Self::Memory

Returns a reference to the guest memory.

fn create_vcpu(&mut self, id: u32) -> Result<Self::Vcpu, HypervisorError>

Creates a new vCPU.

fn add_virtio_device( &mut self, device: VirtioDeviceConfig, ) -> Result<(), HypervisorError>

Adds a VirtIO device to the VM.

fn start(&mut self) -> Result<(), HypervisorError>

Starts the VM.

fn pause(&mut self) -> Result<(), HypervisorError>

Pauses the VM.

fn resume(&mut self) -> Result<(), HypervisorError>

Resumes a paused VM.

fn stop(&mut self) -> Result<(), HypervisorError>

Stops the VM.

fn as_any(&self) -> &dyn Any

Returns the VM as a reference to Any for downcasting.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the VM as a mutable reference to Any for downcasting.

fn vcpu_count(&self) -> u32

Returns the number of vCPUs in the VM.

fn snapshot_devices(&self) -> Result<Vec<DeviceSnapshot>, HypervisorError>

Gets snapshots of all device states.

fn restore_devices( &mut self, snapshots: &[DeviceSnapshot], ) -> Result<(), HypervisorError>

Restores device states from snapshots.

fn is_managed_execution(&self) -> bool

Returns whether this VM uses managed execution.

impl Send for KvmVm

impl Sync for KvmVm