arcbox-vm 0.1.4

Firecracker-based sandbox VMM — orchestration, state, networking, and checkpoints.
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
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
use std::collections::HashMap;
use std::num::NonZeroU64;
use std::path::PathBuf;
use std::sync::{Arc, Mutex, RwLock};

use fc_sdk::VmBuilder;
use fc_sdk::types::{
    Balloon, BootSource, Drive, EntropyDevice, MemoryHotplugConfig, MmdsConfig, NetworkInterface,
    NetworkOverride, PartialDrive, PartialNetworkInterface, SerialDevice, Vsock,
};
use tracing::info;
use uuid::Uuid;

use crate::config::{RateLimitSpec, RestoreSpec, SnapshotRequest, SnapshotType, VmSpec, VmmConfig};
use crate::error::{Result, VmmError};
use crate::instance::{VmId, VmInfo, VmInstance, VmMetrics, VmState, VmSummary};
use crate::network::NetworkManager;
use crate::snapshot::{SnapshotCatalog, SnapshotInfo};
use crate::spawn::{spawn_direct, spawn_jailer};
use crate::store::VmStore;

/// Top-level orchestrator that manages the full lifecycle of multiple VMs.
pub struct VmmManager {
    /// Live VM registry.
    instances: Arc<RwLock<HashMap<VmId, Arc<Mutex<VmInstance>>>>>,
    /// Disk-backed persistence.
    store: Arc<VmStore>,
    /// TAP / IP pool manager.
    network: Arc<NetworkManager>,
    /// Snapshot catalog.
    snapshots: Arc<SnapshotCatalog>,
    /// Daemon configuration.
    config: VmmConfig,
}

impl VmmManager {
    /// Create a new manager from the given configuration.
    pub fn new(config: VmmConfig) -> Result<Self> {
        let store = Arc::new(VmStore::new(&config.firecracker.data_dir));
        let network = Arc::new(NetworkManager::new(
            &config.network.bridge,
            &config.network.cidr,
            &config.network.gateway,
            config.network.dns.clone(),
        )?);
        let snapshots = Arc::new(SnapshotCatalog::new(&config.firecracker.data_dir));

        Ok(Self {
            instances: Arc::new(RwLock::new(HashMap::new())),
            store,
            network,
            snapshots,
            config,
        })
    }

    // =========================================================================
    // VM lifecycle
    // =========================================================================

    /// Allocate resources, spawn Firecracker, configure, and boot the VM.
    pub async fn create_vm(&self, mut spec: VmSpec) -> Result<VmId> {
        // Apply config defaults for fields not supplied by the caller.
        if spec.kernel.is_empty() {
            spec.kernel.clone_from(&self.config.defaults.kernel);
        }
        if spec.rootfs.is_empty() {
            spec.rootfs.clone_from(&self.config.defaults.rootfs);
        }
        if spec.boot_args.is_empty() {
            spec.boot_args.clone_from(&self.config.defaults.boot_args);
        }
        if spec.vcpus == 0 {
            spec.vcpus = self.config.defaults.vcpus;
        }
        if spec.memory_mib == 0 {
            spec.memory_mib = self.config.defaults.memory_mib;
        }

        // Ensure name uniqueness.
        {
            let instances = self.instances.read().unwrap();
            if instances
                .values()
                .any(|i| i.lock().unwrap().name == spec.name)
            {
                return Err(VmmError::AlreadyExists(spec.name.clone()));
            }
        }

        let id = Uuid::new_v4().to_string();
        let vm_dir = self.store.vm_dir(&id);
        std::fs::create_dir_all(&vm_dir).map_err(VmmError::Io)?;

        let log_path = vm_dir.join("firecracker.log");
        let metrics_path = vm_dir.join("firecracker.metrics");

        // Allocate network.
        let net_alloc = self.network.allocate(&id)?;

        // Create instance record (pre-boot).
        let mut instance = VmInstance::new(
            id.clone(),
            spec.name.clone(),
            spec.clone(),
            vm_dir.join("firecracker.sock"),
        );
        instance.network = Some(net_alloc.clone());
        self.store.save(&instance)?;

        // Build and spawn the Firecracker process (direct or via jailer).
        let fc_cfg = &self.config.firecracker;
        let (process, socket_path) = if let Some(ref jc) = fc_cfg.jailer {
            // --- Jailer mode ---
            let proc = spawn_jailer(jc, fc_cfg, &id).await?;
            let sock = proc.socket_path().to_owned();
            (proc, sock)
        } else {
            // --- Direct mode ---
            let sock = vm_dir.join("firecracker.sock");
            let proc = spawn_direct(fc_cfg, &id, &sock, &log_path, &metrics_path).await?;
            (proc, sock)
        };

        // Configure and boot the VM.
        let vcpu_count = NonZeroU64::new(spec.vcpus.max(1))
            .ok_or_else(|| VmmError::Config("vcpus must be > 0".into()))?;

        let vsock_path = vm_dir.join("vsock.sock");

        let mut builder = VmBuilder::new(&socket_path)
            .boot_source(BootSource {
                kernel_image_path: spec.kernel.clone(),
                boot_args: Some(spec.boot_args.clone()),
                initrd_path: spec.initrd.clone(),
            })
            .machine_config(fc_sdk::types::MachineConfiguration {
                vcpu_count,
                mem_size_mib: spec.memory_mib.cast_signed(),
                smt: spec.smt,
                track_dirty_pages: spec.track_dirty_pages,
                cpu_template: spec.cpu_template.map(Into::into),
                huge_pages: spec.huge_pages.map(Into::into),
            })
            .drive(Drive {
                drive_id: "rootfs".into(),
                path_on_host: Some(spec.rootfs.clone()),
                is_root_device: true,
                is_read_only: Some(spec.root_readonly),
                partuuid: spec.root_partuuid.clone(),
                cache_type: spec.root_cache_type.into(),
                rate_limiter: spec.root_rate_limit.clone().map(Into::into),
                io_engine: spec.root_io_engine.into(),
                socket: None,
            })
            .network_interface(NetworkInterface {
                iface_id: "eth0".into(),
                guest_mac: Some(net_alloc.mac_address.clone()),
                host_dev_name: net_alloc.tap_name.clone(),
                rx_rate_limiter: spec.net_rx_rate_limit.clone().map(Into::into),
                tx_rate_limiter: spec.net_tx_rate_limit.clone().map(Into::into),
            });

        // Extra block devices.
        for d in &spec.extra_drives {
            builder = builder.drive(Drive {
                drive_id: d.drive_id.clone(),
                path_on_host: Some(d.path.clone()),
                is_root_device: false,
                is_read_only: Some(d.readonly),
                partuuid: d.partuuid.clone(),
                cache_type: d.cache_type.into(),
                rate_limiter: d.rate_limit.clone().map(Into::into),
                io_engine: d.io_engine.into(),
                socket: None,
            });
        }

        // Optional devices.
        if let Some(ref b) = spec.balloon {
            builder = builder.balloon(Balloon {
                amount_mib: b.amount_mib,
                deflate_on_oom: b.deflate_on_oom,
                stats_polling_interval_s: b.stats_polling_interval_s,
                free_page_hinting: b.free_page_hinting,
                free_page_reporting: b.free_page_reporting,
            });
        }

        if let Some(ref v) = spec.vsock {
            builder = builder.vsock(Vsock {
                guest_cid: v.guest_cid,
                uds_path: vsock_path.to_string_lossy().into_owned(),
                vsock_id: None,
            });
        }

        if spec.entropy_device {
            builder = builder.entropy(EntropyDevice { rate_limiter: None });
        }

        if let Some(ref path) = spec.serial_out {
            builder = builder.serial(SerialDevice {
                serial_out_path: Some(path.clone()),
            });
        }

        if let Some(ref mh) = spec.memory_hotplug {
            builder = builder.memory_hotplug(MemoryHotplugConfig {
                total_size_mib: Some(mh.total_size_mib),
                slot_size_mib: mh.slot_size_mib.unwrap_or(128),
                block_size_mib: mh.block_size_mib.unwrap_or(2),
            });
        }

        if let Some(ref mmds) = spec.mmds {
            builder = builder.mmds_config(MmdsConfig {
                network_interfaces: mmds.network_interfaces.clone(),
                version: mmds.version.into(),
                ipv4_address: mmds
                    .ipv4_address
                    .clone()
                    .unwrap_or_else(|| "169.254.169.254".into()),
                imds_compat: mmds.imds_compat,
            });
            if let Some(ref data) = mmds.initial_data {
                builder = builder.mmds_data(data.clone());
            }
        }

        let vm = Arc::new(builder.start().await.map_err(VmmError::from)?);

        // Update instance to Running.
        {
            let mut instances = self.instances.write().unwrap();
            let entry = instances.entry(id.clone()).or_insert_with(|| {
                Arc::new(Mutex::new(VmInstance::new(
                    id.clone(),
                    spec.name.clone(),
                    spec.clone(),
                    socket_path.clone(),
                )))
            });
            let mut inst = entry.lock().unwrap();
            inst.process = Some(process);
            inst.vm = Some(vm);
            inst.state = VmState::Running;
            inst.started_at = Some(chrono::Utc::now());
            inst.network = Some(net_alloc);
            self.store.save(&inst)?;
        }

        info!(vm_id = %id, "VM created and running");
        Ok(id)
    }

    /// Resume a stopped VM.
    pub async fn start_vm(&self, id: &VmId) -> Result<()> {
        let vm_handle = {
            let instance = self.get_instance(id)?;
            let inst = instance.lock().unwrap();
            match inst.state {
                VmState::Stopped => {}
                s => {
                    return Err(VmmError::WrongState {
                        id: id.clone(),
                        expected: "Stopped".into(),
                        actual: s.to_string(),
                    });
                }
            }
            inst.vm.as_ref().map(Arc::clone)
        };

        if let Some(vm) = vm_handle {
            vm.resume().await.map_err(VmmError::from)?;
        }

        let instance = self.get_instance(id)?;
        let mut inst = instance.lock().unwrap();
        inst.state = VmState::Running;
        inst.started_at = Some(chrono::Utc::now());
        self.store.save(&inst)?;
        info!(vm_id = %id, "VM started");
        Ok(())
    }

    /// Stop a running VM.
    ///
    /// `force = true` sends SIGKILL to the Firecracker process;
    /// `force = false` sends Ctrl+Alt+Del to the guest.
    pub async fn stop_vm(&self, id: &VmId, force: bool) -> Result<()> {
        let (vm_handle, has_process) = {
            let instance = self.get_instance(id)?;
            let inst = instance.lock().unwrap();
            match inst.state {
                VmState::Running | VmState::Paused => {}
                s => {
                    return Err(VmmError::WrongState {
                        id: id.clone(),
                        expected: "Running or Paused".into(),
                        actual: s.to_string(),
                    });
                }
            }
            (inst.vm.as_ref().map(Arc::clone), inst.process.is_some())
        };

        if force && has_process {
            let instance = self.get_instance(id)?;
            let mut inst = instance.lock().unwrap();
            if let Some(ref mut process) = inst.process
                && let Some(pid) = process.pid()
            {
                #[allow(clippy::cast_possible_wrap)]
                let _ = nix::sys::signal::kill(
                    nix::unistd::Pid::from_raw(pid as i32),
                    nix::sys::signal::Signal::SIGKILL,
                );
            }
        } else if let Some(vm) = vm_handle {
            vm.send_ctrl_alt_del().await.map_err(VmmError::from)?;
        }

        let instance = self.get_instance(id)?;
        let mut inst = instance.lock().unwrap();
        inst.state = VmState::Stopped;
        self.store.save(&inst)?;
        info!(vm_id = %id, force, "VM stopped");
        Ok(())
    }

    /// Stop and clean up all resources for a VM.
    pub async fn remove_vm(&self, id: &VmId, force: bool) -> Result<()> {
        let _ = self.stop_vm(id, force).await;

        let instance = {
            let mut instances = self.instances.write().unwrap();
            instances.remove(id)
        };

        if let Some(instance) = instance {
            let inst = instance.lock().unwrap();
            if let Some(net) = &inst.network {
                self.network.release(net);
            }
            if inst.socket_path.exists() {
                let _ = std::fs::remove_file(&inst.socket_path);
            }
        }

        self.store.delete(id)?;
        info!(vm_id = %id, "VM removed");
        Ok(())
    }

    /// List VMs.  `all = false` returns only running VMs.
    pub fn list_vms(&self, all: bool) -> Result<Vec<VmSummary>> {
        let instances = self.instances.read().unwrap();
        let summaries = instances
            .values()
            .filter_map(|arc| {
                let inst = arc.lock().unwrap();
                if !all && inst.state != VmState::Running {
                    return None;
                }
                Some(VmSummary {
                    id: inst.id.clone(),
                    name: inst.name.clone(),
                    state: inst.state,
                    vcpus: inst.spec.vcpus,
                    memory_mib: inst.spec.memory_mib,
                    ip_address: inst.network.as_ref().map(|n| n.ip_address.to_string()),
                    created_at: inst.created_at,
                })
            })
            .collect();
        Ok(summaries)
    }

    /// Full detail for a single VM.
    pub fn inspect_vm(&self, id: &VmId) -> Result<VmInfo> {
        let instance = self.get_instance(id)?;
        let inst = instance.lock().unwrap();
        Ok(VmInfo {
            id: inst.id.clone(),
            name: inst.name.clone(),
            state: inst.state,
            spec: inst.spec.clone(),
            network: inst.network.clone(),
            socket_path: inst.socket_path.clone(),
            created_at: inst.created_at,
            started_at: inst.started_at,
        })
    }

    // =========================================================================
    // Pause / Resume / Snapshot
    // =========================================================================

    /// Pause a running VM.
    pub async fn pause_vm(&self, id: &VmId) -> Result<()> {
        let vm = self.get_vm_handle(id)?;
        vm.pause().await.map_err(VmmError::from)?;
        self.set_state(id, VmState::Paused)?;
        info!(vm_id = %id, "VM paused");
        Ok(())
    }

    /// Resume a paused VM.
    pub async fn resume_vm(&self, id: &VmId) -> Result<()> {
        let vm = self.get_vm_handle(id)?;
        vm.resume().await.map_err(VmmError::from)?;
        self.set_state(id, VmState::Running)?;
        info!(vm_id = %id, "VM resumed");
        Ok(())
    }

    /// Pause, snapshot, and resume a VM.
    pub async fn snapshot_vm(&self, id: &VmId, req: SnapshotRequest) -> Result<SnapshotInfo> {
        let was_running = {
            let instance = self.get_instance(id)?;
            let inst = instance.lock().unwrap();
            inst.state == VmState::Running
        };

        if was_running {
            self.pause_vm(id).await?;
        }

        let snapshot_id = Uuid::new_v4().to_string();
        let snap_dir = self.snapshots.prepare_dir(id, &snapshot_id)?;
        let vmstate_path = snap_dir.join("vmstate");
        let mem_path = snap_dir.join("mem");

        let vm = self.get_vm_handle(id)?;
        match req.snapshot_type {
            SnapshotType::Full => {
                vm.create_snapshot(vmstate_path.to_str().unwrap(), mem_path.to_str().unwrap())
                    .await
                    .map_err(VmmError::from)?;
            }
            SnapshotType::Diff => {
                vm.create_diff_snapshot(vmstate_path.to_str().unwrap(), mem_path.to_str().unwrap())
                    .await
                    .map_err(VmmError::from)?;
            }
        }

        let meta = self.snapshots.register(
            id,
            req.name,
            req.snapshot_type,
            vmstate_path,
            Some(mem_path),
            None,
            None,
            None,
        )?;

        if was_running {
            self.resume_vm(id).await?;
        }

        info!(vm_id = %id, snapshot_id = %meta.id, "snapshot created");
        Ok(SnapshotInfo::from(&meta))
    }

    /// Restore a VM from a snapshot.
    pub async fn restore_vm(&self, spec: RestoreSpec) -> Result<VmId> {
        let id = Uuid::new_v4().to_string();
        let vm_dir = self.store.vm_dir(&id);
        std::fs::create_dir_all(&vm_dir).map_err(VmmError::Io)?;
        let socket_path = vm_dir.join("firecracker.sock");

        let net_alloc = if spec.network_override {
            Some(self.network.allocate(&id)?)
        } else {
            None
        };

        let log_path = vm_dir.join("firecracker.log");
        let metrics_path = vm_dir.join("firecracker.metrics");
        let process = spawn_direct(
            &self.config.firecracker,
            &id,
            &socket_path,
            &log_path,
            &metrics_path,
        )
        .await?;

        let snap_dir = PathBuf::from(&spec.snapshot_dir);
        let vmstate_path = snap_dir.join("vmstate").to_str().unwrap().to_owned();
        let mem_path = snap_dir.join("mem");
        let mem_file_path = if mem_path.exists() {
            Some(mem_path.to_str().unwrap().to_owned())
        } else {
            None
        };

        let mut load_params = fc_sdk::types::SnapshotLoadParams {
            snapshot_path: vmstate_path,
            mem_file_path,
            mem_backend: None,
            enable_diff_snapshots: None,
            track_dirty_pages: None,
            resume_vm: Some(true),
            network_overrides: vec![],
        };

        if let Some(ref net) = net_alloc {
            load_params.network_overrides = vec![NetworkOverride {
                iface_id: "eth0".into(),
                host_dev_name: net.tap_name.clone(),
            }];
        }

        let vm = Arc::new(
            fc_sdk::restore(socket_path.to_str().unwrap(), load_params)
                .await
                .map_err(VmmError::from)?,
        );

        let mut instance = VmInstance::new(
            id.clone(),
            spec.name.clone(),
            VmSpec {
                name: spec.name.clone(),
                ..Default::default()
            },
            socket_path,
        );
        instance.process = Some(process);
        instance.vm = Some(vm);
        instance.state = VmState::Running;
        instance.started_at = Some(chrono::Utc::now());
        instance.network = net_alloc;
        self.store.save(&instance)?;

        {
            let mut instances = self.instances.write().unwrap();
            instances.insert(id.clone(), Arc::new(Mutex::new(instance)));
        }

        info!(vm_id = %id, snapshot_dir = %spec.snapshot_dir, "VM restored");
        Ok(id)
    }

    /// List snapshots for a VM.
    pub fn list_snapshots(&self, id: &VmId) -> Result<Vec<SnapshotInfo>> {
        self.snapshots.list(id)
    }

    /// Delete a snapshot.
    pub fn delete_snapshot(&self, vm_id: &VmId, snapshot_id: &str) -> Result<()> {
        self.snapshots.delete(vm_id, snapshot_id)
    }

    // =========================================================================
    // Metrics / Live Updates
    // =========================================================================

    /// Retrieve balloon metrics for a VM.
    pub async fn get_metrics(&self, id: &VmId) -> Result<VmMetrics> {
        let vm = self.get_vm_handle(id)?;
        let (target, actual) = match vm.balloon_config().await {
            Ok(b) => {
                let stats = vm.balloon_stats().await.ok();
                (Some(b.amount_mib), stats.map(|s| s.actual_mib))
            }
            Err(_) => (None, None),
        };
        Ok(VmMetrics {
            vm_id: id.clone(),
            balloon_target_mib: target,
            balloon_actual_mib: actual,
        })
    }

    /// Adjust the memory balloon target.
    pub async fn update_balloon(&self, id: &VmId, amount_mib: i64) -> Result<()> {
        let vm = self.get_vm_handle(id)?;
        vm.update_balloon(amount_mib)
            .await
            .map_err(VmmError::from)?;
        Ok(())
    }

    /// Update the balloon statistics polling interval.
    pub async fn update_balloon_stats_interval(&self, id: &VmId, interval_s: i64) -> Result<()> {
        let vm = self.get_vm_handle(id)?;
        vm.update_balloon_stats_interval(interval_s)
            .await
            .map_err(VmmError::from)?;
        Ok(())
    }

    /// Update the hotpluggable memory region size.
    pub async fn update_memory(&self, id: &VmId, size_mib: i64) -> Result<()> {
        let vm = self.get_vm_handle(id)?;
        vm.update_memory_hotplug(Some(size_mib))
            .await
            .map_err(VmmError::from)?;
        Ok(())
    }

    /// Hot-swap a drive path or update its rate limiter.
    pub async fn update_drive(
        &self,
        id: &VmId,
        drive_id: &str,
        path_on_host: Option<String>,
        rate_limit: Option<RateLimitSpec>,
    ) -> Result<()> {
        let vm = self.get_vm_handle(id)?;
        vm.update_drive(
            drive_id,
            PartialDrive {
                drive_id: drive_id.to_owned(),
                path_on_host,
                rate_limiter: rate_limit.map(Into::into),
            },
        )
        .await
        .map_err(VmmError::from)?;
        Ok(())
    }

    /// Update the rate limiters on a network interface.
    pub async fn update_network_interface(
        &self,
        id: &VmId,
        iface_id: &str,
        rx: Option<RateLimitSpec>,
        tx: Option<RateLimitSpec>,
    ) -> Result<()> {
        let vm = self.get_vm_handle(id)?;
        vm.update_network_interface(
            iface_id,
            PartialNetworkInterface {
                iface_id: iface_id.to_owned(),
                rx_rate_limiter: rx.map(Into::into),
                tx_rate_limiter: tx.map(Into::into),
            },
        )
        .await
        .map_err(VmmError::from)?;
        Ok(())
    }

    /// Flush Firecracker metrics to disk immediately.
    pub async fn flush_metrics(&self, id: &VmId) -> Result<()> {
        let vm = self.get_vm_handle(id)?;
        vm.flush_metrics().await.map_err(VmmError::from)?;
        Ok(())
    }

    // =========================================================================
    // Helpers
    // =========================================================================

    fn get_instance(&self, id: &VmId) -> Result<Arc<Mutex<VmInstance>>> {
        self.instances
            .read()
            .unwrap()
            .get(id)
            .cloned()
            .ok_or_else(|| VmmError::NotFound(id.clone()))
    }

    /// Return a shared `fc_sdk::Vm` handle for the given VM.
    fn get_vm_handle(&self, id: &VmId) -> Result<Arc<fc_sdk::Vm>> {
        let instance = self.get_instance(id)?;
        let inst = instance.lock().unwrap();
        inst.vm
            .as_ref()
            .map(Arc::clone)
            .ok_or_else(|| VmmError::WrongState {
                id: id.clone(),
                expected: "Running or Paused".into(),
                actual: inst.state.to_string(),
            })
    }

    fn set_state(&self, id: &VmId, state: VmState) -> Result<()> {
        let instance = self.get_instance(id)?;
        let mut inst = instance.lock().unwrap();
        inst.state = state;
        self.store.save(&inst)?;
        Ok(())
    }
}