Trait VirtualMachine 

pub trait VirtualMachine: Send + Sync {
    type Vcpu: Vcpu;
    type Memory: GuestMemory;

    // Required methods
    fn memory(&self) -> &Self::Memory;
    fn create_vcpu(&mut self, id: u32) -> Result<Self::Vcpu, HypervisorError>;
    fn add_virtio_device(
        &mut self,
        device: VirtioDeviceConfig,
    ) -> Result<(), HypervisorError>;
    fn start(&mut self) -> Result<(), HypervisorError>;
    fn pause(&mut self) -> Result<(), HypervisorError>;
    fn resume(&mut self) -> Result<(), HypervisorError>;
    fn stop(&mut self) -> Result<(), HypervisorError>;
    fn as_any(&self) -> &dyn Any;
    fn as_any_mut(&mut self) -> &mut dyn Any;
    fn vcpu_count(&self) -> u32;
    fn snapshot_devices(&self) -> Result<Vec<DeviceSnapshot>, HypervisorError>;
    fn restore_devices(
        &mut self,
        snapshots: &[DeviceSnapshot],
    ) -> Result<(), HypervisorError>;

    // Provided method
    fn is_managed_execution(&self) -> bool { ... }
}

Virtual machine trait for managing VM lifecycle and devices.

Required Associated Types

type Vcpu: Vcpu

The vCPU type for this VM.

type Memory: GuestMemory

The guest memory type for this VM.

Required Methods

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.

For managed execution VMs, this may return a placeholder vCPU.

Errors

Returns an error if the vCPU cannot be created.

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

Adds a VirtIO device to the VM.

Errors

Returns an error if the device cannot be added.

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

Starts the VM.

Errors

Returns an error if the VM cannot be started.

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

Pauses the VM.

Errors

Returns an error if the VM cannot be paused.

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

Resumes a paused VM.

Errors

Returns an error if the VM cannot be resumed.

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

Stops the VM.

Errors

Returns an error if the VM cannot be stopped.

fn as_any(&self) -> &dyn Any

Returns the VM as a reference to Any for downcasting.

This allows the caller to downcast the VM to its concrete type for platform-specific operations like IRQ injection.

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.

Errors

Returns an error if device states cannot be captured.

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

Restores device states from snapshots.

Errors

Returns an error if device states cannot be restored.

Provided Methods

fn is_managed_execution(&self) -> bool

Returns whether this VM uses managed execution.

Managed execution (returns true):

• The hypervisor manages vCPU execution internally
• start() begins VM execution, stop() ends it
• create_vcpu() is optional/placeholder
• Examples: macOS Virtualization.framework

Manual execution (returns false):

• The caller must create vCPU threads and call vcpu.run() in a loop
• start() and stop() are optional state markers
• Examples: Linux KVM

Implementors

impl VirtualMachine for KvmVm

type Vcpu = KvmVcpu

type Memory = KvmMemory