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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
use std::collections::HashMap;
use std::path::{Path, PathBuf};
use std::sync::RwLock;

use super::disk;
use super::platform::create_platform_driver;
use crate::config::{VmConfig, VmHandle, VmState};
use crate::driver::{VmDriver, VmError};

/// Manages all VMs on this node. Auto-selects the correct hypervisor driver.
///
/// Thread-safe: uses RwLock for concurrent access to VM state.
pub struct VmManager {
    driver: Box<dyn VmDriver>,
    vms: RwLock<HashMap<String, VmHandle>>,
    base_dir: PathBuf,
}

impl VmManager {
    /// Create a new VmManager with auto-detected driver.
    ///
    /// `base_dir` is the root directory for VM data (disks, logs, configs).
    /// Typically `~/.vm-rs/vms/` for development or `/var/lib/vm-rs/` for production.
    pub fn new(base_dir: PathBuf) -> Result<Self, VmError> {
        let driver = create_platform_driver()?;
        std::fs::create_dir_all(&base_dir).map_err(VmError::Io)?;
        Ok(Self {
            driver,
            vms: RwLock::new(HashMap::new()),
            base_dir,
        })
    }

    /// Create a VmManager with a specific driver (useful for testing).
    pub fn with_driver(driver: Box<dyn VmDriver>, base_dir: PathBuf) -> Result<Self, VmError> {
        std::fs::create_dir_all(&base_dir).map_err(VmError::Io)?;
        Ok(Self {
            driver,
            vms: RwLock::new(HashMap::new()),
            base_dir,
        })
    }

    /// Base directory for all VM data.
    pub fn base_dir(&self) -> &Path {
        &self.base_dir
    }

    /// Directory for a specific VM's data (logs, disks, seed ISOs).
    pub fn vm_dir(&self, name: &str) -> PathBuf {
        self.base_dir.join(name)
    }

    /// Boot a VM. Creates the VM directory and delegates to the driver.
    pub fn start(&self, config: &VmConfig) -> Result<VmHandle, VmError> {
        config.validate()?;

        {
            let mut vms = self
                .vms
                .write()
                .map_err(|e| VmError::Hypervisor(format!("lock poisoned: {}", e)))?;
            if let Some(existing) = vms.get(&config.name) {
                if !matches!(existing.state, VmState::Stopped | VmState::Failed { .. }) {
                    return Err(VmError::BootFailed {
                        name: config.name.clone(),
                        detail: format!("VM already exists in state: {}", existing.state),
                    });
                }
            }
            vms.insert(
                config.name.clone(),
                VmHandle {
                    name: config.name.clone(),
                    namespace: config.namespace.clone(),
                    state: VmState::Starting,
                    process: None,
                    serial_log: config.serial_log.clone(),
                    machine_id: None,
                },
            );
        }

        let vm_dir = self.vm_dir(&config.name);
        if let Err(e) = std::fs::create_dir_all(&vm_dir) {
            let mut vms = self
                .vms
                .write()
                .map_err(|e| VmError::Hypervisor(format!("lock poisoned: {}", e)))?;
            vms.remove(&config.name);
            return Err(VmError::Io(e));
        }

        tracing::info!(
            vm = %config.name,
            cpus = config.cpus,
            memory_mb = config.memory_mb,
            "booting VM"
        );

        let handle = match self.driver.boot(config) {
            Ok(handle) => handle,
            Err(err) => {
                tracing::warn!(vm = %config.name, error = %err, "VM boot failed, cleaning up reservation");
                let mut vms = self
                    .vms
                    .write()
                    .map_err(|e| VmError::Hypervisor(format!("lock poisoned: {}", e)))?;
                vms.remove(&config.name);
                return Err(err);
            }
        };

        let mut vms = self
            .vms
            .write()
            .map_err(|e| VmError::Hypervisor(format!("lock poisoned: {}", e)))?;
        vms.insert(config.name.clone(), handle.clone());

        Ok(handle)
    }

    /// Stop a VM gracefully.
    pub fn stop(&self, name: &str) -> Result<(), VmError> {
        tracing::info!(vm = %name, "stopping VM");
        let handle = self.get_handle(name)?;
        self.driver.stop(&handle)?;
        self.update_cached_state(name, VmState::Stopped)
    }

    /// Force-kill a VM.
    pub fn kill(&self, name: &str) -> Result<(), VmError> {
        tracing::info!(vm = %name, "force-killing VM");
        let handle = self.get_handle(name)?;
        self.driver.kill(&handle)?;
        self.update_cached_state(name, VmState::Stopped)
    }

    /// Stop a VM using a pre-built handle (e.g. restored from persisted metadata).
    pub fn stop_by_handle(&self, handle: &VmHandle) -> Result<(), VmError> {
        tracing::info!(vm = %handle.name, "stopping VM by handle");
        self.driver.stop(handle)?;
        self.update_cached_state(&handle.name, VmState::Stopped)
    }

    /// Force-kill a VM using a pre-built handle (e.g. restored from persisted metadata).
    pub fn kill_by_handle(&self, handle: &VmHandle) -> Result<(), VmError> {
        tracing::info!(vm = %handle.name, "force-killing VM by handle");
        self.driver.kill(handle)?;
        self.update_cached_state(&handle.name, VmState::Stopped)
    }

    /// Pause a running VM.
    pub fn pause(&self, name: &str) -> Result<(), VmError> {
        let handle = self.get_handle(name)?;
        self.driver.pause(&handle)?;
        self.update_cached_state(name, VmState::Paused)
    }

    /// Resume a paused VM.
    pub fn resume(&self, name: &str) -> Result<(), VmError> {
        let handle = self.get_handle(name)?;
        self.driver.resume(&handle)?;
        let resumed_state = self.driver.state(&handle)?;
        self.update_cached_state(name, resumed_state)
    }

    /// Query current state of a VM.
    pub fn state(&self, name: &str) -> Result<VmState, VmError> {
        let handle = self.get_handle(name)?;
        let state = self.driver.state(&handle)?;
        self.update_cached_state(name, state.clone())?;
        Ok(state)
    }

    /// Get the IP address of a ready VM.
    pub fn get_ip(&self, name: &str) -> Result<Option<String>, VmError> {
        Ok(self.state(name)?.ip().map(ToOwned::to_owned))
    }

    /// List all tracked VMs.
    pub fn list(&self) -> Result<Vec<VmHandle>, VmError> {
        let vms = self
            .vms
            .read()
            .map_err(|e| VmError::Hypervisor(format!("lock poisoned: {}", e)))?;
        Ok(vms.values().cloned().collect())
    }

    /// Wait for all VMs to emit the readiness marker within the timeout.
    pub fn wait_all_ready(&self, timeout_secs: u64) -> Result<(), VmError> {
        let start = std::time::Instant::now();
        let timeout = std::time::Duration::from_secs(timeout_secs);

        loop {
            if start.elapsed() > timeout {
                let pending = self.pending_names(|state| state.is_ready())?;
                return Err(VmError::Hypervisor(format!(
                    "timeout waiting for VMs: {}",
                    pending.join(", ")
                )));
            }

            let mut all_ready = true;
            let names = self.vm_names()?;

            for name in &names {
                match self.state(name)? {
                    state if state.is_ready() => {}
                    VmState::Failed { reason } => {
                        return Err(VmError::BootFailed {
                            name: name.clone(),
                            detail: reason,
                        });
                    }
                    _ => {
                        all_ready = false;
                    }
                }
            }

            if all_ready {
                return Ok(());
            }

            let elapsed = start.elapsed().as_secs();
            if elapsed > 0 && elapsed.is_multiple_of(10) {
                let pending = self.pending_names(|state| state.is_ready())?;
                tracing::info!(
                    pending = ?pending,
                    elapsed_secs = elapsed,
                    "waiting for VMs to become ready"
                );
            }

            std::thread::sleep(std::time::Duration::from_secs(1));
        }
    }

    /// Create a disk image as a CoW clone of a base image.
    pub fn clone_disk(base: &Path, target: &Path) -> Result<(), VmError> {
        disk::clone_disk(base, target)
    }

    fn get_handle(&self, name: &str) -> Result<VmHandle, VmError> {
        let vms = self
            .vms
            .read()
            .map_err(|e| VmError::Hypervisor(format!("lock poisoned: {}", e)))?;
        vms.get(name).cloned().ok_or_else(|| VmError::NotFound {
            name: name.to_string(),
        })
    }

    fn update_cached_state(&self, name: &str, state: VmState) -> Result<(), VmError> {
        let mut vms = self
            .vms
            .write()
            .map_err(|e| VmError::Hypervisor(format!("lock poisoned: {}", e)))?;
        if let Some(handle) = vms.get_mut(name) {
            handle.state = state;
        }
        Ok(())
    }

    fn vm_names(&self) -> Result<Vec<String>, VmError> {
        let vms = self
            .vms
            .read()
            .map_err(|e| VmError::Hypervisor(format!("lock poisoned: {}", e)))?;
        Ok(vms.keys().cloned().collect())
    }

    fn pending_names(&self, predicate: impl Fn(&VmState) -> bool) -> Result<Vec<String>, VmError> {
        let vms = self
            .vms
            .read()
            .map_err(|e| VmError::Hypervisor(format!("lock poisoned: {}", e)))?;
        Ok(vms
            .iter()
            .filter(|(_, handle)| !predicate(&handle.state))
            .map(|(name, _)| name.clone())
            .collect())
    }
}

#[cfg(test)]
mod tests {
    use std::path::{Path, PathBuf};
    use std::sync::atomic::{AtomicUsize, Ordering};
    use std::sync::{mpsc, Arc, Mutex};

    use super::*;

    struct BlockingDriver {
        boot_calls: AtomicUsize,
        release_rx: Mutex<Option<mpsc::Receiver<()>>>,
    }

    struct FailedStateDriver;
    struct ReadyAfterTwoPollsDriver {
        polls: AtomicUsize,
    }

    impl VmDriver for Arc<BlockingDriver> {
        fn boot(&self, config: &VmConfig) -> Result<VmHandle, VmError> {
            self.boot_calls.fetch_add(1, Ordering::SeqCst);
            if let Some(rx) = self.release_rx.lock().expect("release lock").take() {
                rx.recv().expect("release boot");
            }
            Ok(VmHandle {
                name: config.name.clone(),
                namespace: config.namespace.clone(),
                state: VmState::Starting,
                process: None,
                serial_log: config.serial_log.clone(),
                machine_id: None,
            })
        }

        fn stop(&self, _handle: &VmHandle) -> Result<(), VmError> {
            Ok(())
        }

        fn kill(&self, _handle: &VmHandle) -> Result<(), VmError> {
            Ok(())
        }

        fn state(&self, _handle: &VmHandle) -> Result<VmState, VmError> {
            Ok(VmState::Stopped)
        }
    }

    impl VmDriver for FailedStateDriver {
        fn boot(&self, config: &VmConfig) -> Result<VmHandle, VmError> {
            Ok(VmHandle {
                name: config.name.clone(),
                namespace: config.namespace.clone(),
                state: VmState::Starting,
                process: None,
                serial_log: config.serial_log.clone(),
                machine_id: None,
            })
        }

        fn stop(&self, _handle: &VmHandle) -> Result<(), VmError> {
            Ok(())
        }

        fn kill(&self, _handle: &VmHandle) -> Result<(), VmError> {
            Ok(())
        }

        fn state(&self, _handle: &VmHandle) -> Result<VmState, VmError> {
            Ok(VmState::Failed {
                reason: "crashed".into(),
            })
        }
    }

    impl VmDriver for ReadyAfterTwoPollsDriver {
        fn boot(&self, config: &VmConfig) -> Result<VmHandle, VmError> {
            Ok(VmHandle {
                name: config.name.clone(),
                namespace: config.namespace.clone(),
                state: VmState::Starting,
                process: None,
                serial_log: config.serial_log.clone(),
                machine_id: None,
            })
        }

        fn stop(&self, _handle: &VmHandle) -> Result<(), VmError> {
            Ok(())
        }

        fn kill(&self, _handle: &VmHandle) -> Result<(), VmError> {
            Ok(())
        }

        fn state(&self, _handle: &VmHandle) -> Result<VmState, VmError> {
            let poll = self.polls.fetch_add(1, Ordering::SeqCst);
            if poll == 0 {
                Ok(VmState::Running)
            } else {
                Ok(VmState::Ready {
                    ip: "10.0.0.2".into(),
                })
            }
        }
    }

    fn test_config(base_dir: &Path) -> VmConfig {
        VmConfig {
            name: "test-vm".into(),
            namespace: "tests".into(),
            kernel: PathBuf::from("/tmp/kernel"),
            initramfs: None,
            root_disk: None,
            data_disk: None,
            seed_iso: None,
            cpus: 1,
            memory_mb: 256,
            networks: vec![],
            shared_dirs: vec![],
            serial_log: base_dir.join("serial.log"),
            cmdline: None,
            netns: None,
            vsock: false,
            machine_id: None,
            efi_variable_store: None,
            rosetta: false,
        }
    }

    #[test]
    fn start_reserves_name_before_driver_boot() {
        let tmp = tempfile::tempdir().expect("tempdir");
        let (release_tx, release_rx) = mpsc::channel();
        let driver = Arc::new(BlockingDriver {
            boot_calls: AtomicUsize::new(0),
            release_rx: Mutex::new(Some(release_rx)),
        });
        let manager = Arc::new(
            VmManager::with_driver(Box::new(driver.clone()), tmp.path().to_path_buf())
                .expect("manager"),
        );
        let config = test_config(tmp.path());

        let manager_clone = Arc::clone(&manager);
        let config_clone = config.clone();
        let boot_thread = std::thread::spawn(move || manager_clone.start(&config_clone));

        while driver.boot_calls.load(Ordering::SeqCst) == 0 {
            std::thread::sleep(std::time::Duration::from_millis(10));
        }

        let err = manager
            .start(&config)
            .expect_err("second concurrent start should fail");
        assert!(err.to_string().contains("already exists"));

        release_tx.send(()).expect("release first boot");
        boot_thread
            .join()
            .expect("join")
            .expect("first boot should succeed");

        assert_eq!(driver.boot_calls.load(Ordering::SeqCst), 1);
    }

    #[test]
    fn restart_is_allowed_after_failed_state_is_observed() {
        let tmp = tempfile::tempdir().expect("tempdir");
        let manager = VmManager::with_driver(Box::new(FailedStateDriver), tmp.path().to_path_buf())
            .expect("manager");
        let config = test_config(tmp.path());

        manager.start(&config).expect("first boot");
        let state = manager.state(&config.name).expect("state query");
        assert!(matches!(state, VmState::Failed { .. }));

        manager
            .start(&config)
            .expect("restart after failed state should be allowed");
    }

    #[test]
    fn wait_all_ready_waits_for_ready_not_just_running() {
        let tmp = tempfile::tempdir().expect("tempdir");
        let manager = VmManager::with_driver(
            Box::new(ReadyAfterTwoPollsDriver {
                polls: AtomicUsize::new(0),
            }),
            tmp.path().to_path_buf(),
        )
        .expect("manager");
        let config = test_config(tmp.path());

        manager.start(&config).expect("boot");
        manager
            .wait_all_ready(2)
            .expect("wait_all_ready should wait until ready");
        assert_eq!(
            manager.get_ip(&config.name).expect("ip query"),
            Some("10.0.0.2".into())
        );
    }
}