Enum VmExit 

#[non_exhaustive]
pub enum VmExit {
    Mmio {
        addr: u64,
        write: bool,
        data: ExitData,
    },
    Pio {
        port: u16,
        write: bool,
        data: ExitData,
    },
    Hypercall {
        func: u64,
        args: [u64; 6],
    },
    Wfi,
    Wfe,
    Hlt,
    Reset,
    Shutdown,
    Debug(DebugInfo),
    InternalError(String),
}

The reason a vCPU returned from its run loop.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Mmio

Memory-mapped I/O access. The MMIO bus router in squib-vmm dispatches to the appropriate device emulation.

Fields

addr: u64

The guest-physical address being accessed.

write: bool

true for a write, false for a read.

data: ExitData

Payload bytes (read: filled by the device; write: the bytes the guest wrote).

Pio

Port-mapped I/O access. x86-only; on other architectures this variant never appears.

Fields

port: u16

The I/O port number.

write: bool

true for OUT, false for IN.

data: ExitData

Payload bytes (1, 2, or 4 wide).

Hypercall

The guest issued a hypercall (HVC on aarch64, VMCALL on x86).

Fields

func: u64

Hypercall function number.

args: [u64; 6]

Up to six argument registers from the calling convention.

Wfi

The guest executed WFI (wait-for-interrupt). The vCPU should sleep until an interrupt is injected.

Wfe

The guest executed WFE (wait-for-event). x86’s HLT maps to VmExit::Hlt instead.

Hlt

The guest executed HLT (x86). Equivalent to WFI in practice.

Reset

The guest issued a system reset.

Shutdown

The guest powered down.

Debug(DebugInfo)

A debug exception (single-step, breakpoint). Surfaced when the optional gdb feature is wired up; otherwise the backend treats this as an internal error.

InternalError(String)

The hypervisor reported an internal failure that does not fit any of the above variants. The string is for human consumption only; programmatic consumers should treat this as fatal.

Trait Implementations

impl Clone for VmExit

fn clone(&self) -> VmExit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VmExit

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

Formats the value using the given formatter.