mimobox-vm 0.1.0-alpha

MimoBox microVM sandbox backend using Linux KVM
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

#![cfg_attr(docsrs, feature(doc_cfg))]
#![warn(missing_docs)]

//! microVM sandbox backend for mimobox.
//!
//! This crate provides the microVM isolation layer used by the higher-level mimobox
//! sandbox APIs. It exposes configuration, lifecycle management, guest command
//! execution, file transfer, controlled HTTP proxying, snapshot serialization, and
//! optional pooling helpers.
//!
//! The main entry point is [`MicrovmSandbox`], which implements
//! [`mimobox_core::Sandbox`]. Linux builds with the `kvm` feature use `KvmBackend`
//! for the underlying VM lifecycle. Other platforms keep the public API available
//! but return [`MicrovmError::UnsupportedPlatform`] for KVM-only operations.
//!
//! Snapshot support is split into [`MicrovmSnapshot`] for self-describing in-memory
//! snapshots and file-backed [`mimobox_core::SandboxSnapshot`] values for fast
//! restore paths. [`VmPool`] prewarms fully booted VMs, while `RestorePool` keeps
//! empty VM shells ready for snapshot restoration on supported KVM builds.
//!
//! HTTP access from guests is intentionally host-mediated. [`HttpRequest`] values
//! are validated against `SandboxConfig::allowed_http_domains` and
//! executed by the host-side proxy rather than by giving the guest direct network
//! access.

mod guest_file_ops;
mod http_proxy;
/// Thread-safe microVM prewarm pool types.
pub mod pool;
mod snapshot;
mod vm;
mod vm_assets;

#[cfg(all(target_os = "linux", feature = "kvm"))]
mod kvm;
#[cfg(all(target_os = "linux", feature = "kvm"))]
mod restore_pool;

pub use http_proxy::{HttpProxyError, HttpRequest, HttpResponse};
pub use pool::{PoolError, PooledVm, VmPool, VmPoolConfig, VmPoolStats};
pub use snapshot::MicrovmSnapshot;
pub use vm::{
    GuestCommandResult, GuestExecOptions, GuestFileErrorKind, LifecycleError, MicrovmConfig,
    MicrovmError, MicrovmSandbox, MicrovmState, StreamEvent,
};
pub use vm_assets::{
    microvm_config_from_assets_dir, microvm_config_from_vm_assets, resolve_vm_assets_dir,
    vm_assets_dir,
};

#[cfg(all(target_os = "linux", feature = "kvm"))]
#[cfg_attr(docsrs, doc(cfg(feature = "kvm")))]
pub use kvm::{KvmBackend, KvmExitReason, KvmLifecycle, KvmTransport};
#[cfg(all(target_os = "linux", feature = "kvm"))]
#[cfg_attr(docsrs, doc(cfg(feature = "kvm")))]
pub use restore_pool::{PooledRestoreVm, RestorePool, RestorePoolConfig, RestorePoolError};