vm-rs 0.2.4

Cross-platform VM lifecycle management — Apple Virtualization.framework (macOS) + Cloud Hypervisor (Linux)
Documentation 
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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

//! VmDriver trait — platform-agnostic VM lifecycle.
//!
//! Two implementations:
//! - `AppleVzDriver` — macOS via Apple Virtualization.framework
//! - `CloudHvDriver` — Linux via Cloud Hypervisor REST API

#[cfg(target_os = "macos")]
pub mod apple_vz;

#[cfg(target_os = "linux")]
pub mod cloud_hv;

#[cfg(target_os = "windows")]
pub mod boot;

#[cfg(target_os = "windows")]
pub mod whp;

#[cfg(any(target_os = "macos", target_os = "linux"))]
mod ready;

use crate::config::{VmConfig, VmHandle, VmState};
#[cfg(any(target_os = "macos", target_os = "linux"))]
pub(crate) use ready::{check_ready_marker, ReadyMarkerCache};

/// Platform-agnostic VM lifecycle.
///
/// Apple VZ on macOS, Cloud Hypervisor on Linux.
/// Each driver manages the hypervisor-specific details of booting,
/// stopping, and querying VMs.
pub trait VmDriver: Send + Sync {
    /// Boot a VM with the given configuration.
    ///
    /// Returns a handle that can be used to query state, stop, or kill the VM.
    /// The VM may still be in `Starting` state when this returns — use
    /// `state()` to poll for `Running`/`Ready`.
    fn boot(&self, config: &VmConfig) -> Result<VmHandle, VmError>;

    /// Stop a running VM gracefully.
    ///
    /// Sends a shutdown signal and waits for the guest to power off.
    fn stop(&self, handle: &VmHandle) -> Result<(), VmError>;

    /// Force-kill a VM immediately.
    ///
    /// Does not wait for graceful shutdown. Use as a last resort.
    fn kill(&self, handle: &VmHandle) -> Result<(), VmError>;

    /// Query current VM state.
    fn state(&self, handle: &VmHandle) -> Result<VmState, VmError>;

    /// Pause a running VM (suspend execution, preserve state).
    ///
    /// Not all drivers support pause. The default returns an error.
    fn pause(&self, handle: &VmHandle) -> Result<(), VmError> {
        Err(VmError::Hypervisor(format!(
            "pause is not supported by this driver for VM '{}'",
            handle.name
        )))
    }

    /// Resume a paused VM.
    ///
    /// Not all drivers support resume. The default returns an error.
    fn resume(&self, handle: &VmHandle) -> Result<(), VmError> {
        Err(VmError::Hypervisor(format!(
            "resume is not supported by this driver for VM '{}'",
            handle.name
        )))
    }
}

/// VM operation errors.
#[derive(Debug, thiserror::Error)]
pub enum VmError {
    /// VM boot failed.
    #[error("boot failed for '{name}': {detail}")]
    BootFailed { name: String, detail: String },

    /// VM not found (already stopped/destroyed, or never existed).
    #[error("VM '{name}' not found")]
    NotFound { name: String },

    /// Stop/kill failed.
    #[error("failed to stop '{name}': {detail}")]
    StopFailed { name: String, detail: String },

    /// State query failed.
    #[error("failed to query state for '{name}': {detail}")]
    StateFailed { name: String, detail: String },

    /// Hypervisor-specific error (e.g., Apple VZ framework error, Cloud Hypervisor API error).
    #[error("hypervisor error: {0}")]
    Hypervisor(String),

    /// I/O error (disk, network, file operations).
    #[error("I/O error: {0}")]
    Io(#[from] std::io::Error),

    /// Configuration error.
    #[error("invalid config: {0}")]
    InvalidConfig(String),
}

impl From<crate::oci::registry::OciError> for VmError {
    fn from(e: crate::oci::registry::OciError) -> Self {
        VmError::Hypervisor(format!("OCI error: {}", e))
    }
}

impl From<crate::setup::SetupError> for VmError {
    fn from(e: crate::setup::SetupError) -> Self {
        VmError::Hypervisor(format!("setup error: {}", e))
    }
}