supermachine 0.4.25

Run any OCI/Docker image as a hardware-isolated microVM on macOS HVF (Linux KVM and Windows WHP in progress). Single library API, zero flags for the common case, sub-100 ms cold-restore from snapshot.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

// Source size: 1208 + 1193 LOC
// Status: compact port — virtq descriptor walk + MMIO register
//         shell. Stripped of x86 PCI bits, async hooks, non-vsock
//         feature bits. ~500 LOC.
//
// Two layers:
//   queue::Queue  — descriptor / avail / used ring walking against
//                   guest memory accessed by raw pointer. The guest
//                   memory pointer comes from the same mmap that
//                   `vmm::vstate::MicroVm::ram_host` holds.
//   mmio::MmioVirtio — generic virtio-mmio register layout; wraps
//                      a Device trait.

pub mod balloon;
pub mod blk;
pub mod mmio;
pub mod queue;
pub mod rng;
pub mod vsock;

/// Virtio status bits (subset).
pub const STATUS_ACKNOWLEDGE: u32 = 1;
pub const STATUS_DRIVER: u32 = 2;
pub const STATUS_DRIVER_OK: u32 = 4;
pub const STATUS_FEATURES_OK: u32 = 8;
pub const STATUS_FAILED: u32 = 0x80;

/// Virtio device IDs (subset).
pub const VIRTIO_ID_BLOCK: u32 = 2;
pub const VIRTIO_ID_RNG: u32 = 4;
pub const VIRTIO_ID_VSOCK: u32 = 19;

/// Generic virtio device trait. Implementations describe themselves
/// + handle queue notifications.
pub trait VirtioDevice: Send + Sync {
    fn device_id(&self) -> u32;
    fn vendor_id(&self) -> u32 {
        0x554d4551
    } // 'QEMU' — the conventional virtio-mmio vendor ID
    fn num_queues(&self) -> usize;
    fn queue_max_size(&self) -> u16 {
        256
    }
    /// Device-specific configuration space (read-only to the guest
    /// from the offset-0x100 MMIO window).
    fn config(&self) -> Vec<u8> {
        Vec::new()
    }
    /// Device feature bits offered to the driver.
    fn features(&self) -> u64 {
        1u64 << 32 /* VIRTIO_F_VERSION_1 */
    }
    /// Called when the driver kicks queue `q` (writes to QueueNotify).
    fn notify(&self, q: u16);
    /// Called when the driver transitions the device to DRIVER_OK.
    fn activate(&self, queues: Vec<queue::Queue>);
    /// Snapshot the device's CURRENT live queue state (with up-to-date
    /// last_avail_idx / next_used_idx cursors). Defaults to empty for
    /// pre-snapshot devices (caller falls back to the MmioVirtio
    /// mirror in that case). Required for snapshot/restore correctness:
    /// once `activate` clones queues into the device, the device
    /// bumps cursors in its own copy — the MmioVirtio's mirror goes
    /// stale.
    fn snapshot_queues(&self) -> Vec<queue::Queue> {
        Vec::new()
    }
    /// Guest writes to device-specific config space (offset >= 0x100,
    /// relative offset passed in). Default no-op. virtio-balloon's
    /// `actual` register at config-offset 0x004 is the only user.
    fn config_write(&self, _offset: usize, _value: u32) {}
}