msb_krun 0.1.39

Native Rust API for libkrun microVMs
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

//! Native Rust API for libkrun.
//!
//! This module provides a builder-pattern API for creating and entering microVMs
//! using nested builders for organized configuration.
//!
//! # Example
//!
//! ```rust,no_run
//! use msb_krun::{VmBuilder, Result};
//!
//! fn main() -> Result<()> {
//!     // enter() hands process lifecycle to the VMM.
//!     // On normal guest exit, the process terminates directly.
//!     // It only returns on early setup errors.
//!     VmBuilder::new()
//!         .machine(|m| m.vcpus(4).memory_mib(2048))
//!         .fs(|fs| fs.root("/path/to/rootfs"))
//!         .exec(|e| e.path("/bin/myapp").args(["--flag"]).env("HOME", "/root"))
//!         .build()?
//!         .enter()?;
//!
//!     unreachable!()
//! }
//! ```

//--------------------------------------------------------------------------------------------------
// Modules
//--------------------------------------------------------------------------------------------------

pub mod builder;
pub mod builders;
pub mod error;
pub mod exit_handle;
pub mod metrics;
pub mod vm;

//--------------------------------------------------------------------------------------------------
// Re-Exports
//--------------------------------------------------------------------------------------------------

pub use builder::VmBuilder;
#[cfg(feature = "blk")]
pub use builders::DiskBuilder;
#[cfg(feature = "blk")]
pub use builders::DiskImageFormat;
#[cfg(feature = "blk")]
pub use builders::DiskLayer;
#[cfg(not(target_os = "windows"))]
pub use builders::FsBuilder;
#[cfg(feature = "net")]
pub use builders::NetBuilder;
pub use builders::VsockBuilder;
#[cfg(feature = "blk")]
pub use builders::WritebackLimit;
pub use builders::{
    ConsoleBuilder, ConsolePortOptions, ExecBuilder, HostCpuId, HostMemoryPolicy, KernelBuilder,
    MachineBuilder, MemoryPlacementResult, NumaBuilder, NumaDistance, NumaNodeBuilder,
    NumaNodeConfig, NumaTopology, PlacementReport, VcpuPlacementResult,
};
#[cfg(feature = "blk")]
pub use devices::virtio::block::{ImageType as BlockImageFormat, SyncMode as BlockSyncMode};
#[cfg(feature = "blk")]
pub use devices::virtio::{BlockBackendSpec, BlockLayerSpec, PreparedBlockBackend};
pub use error::{BuildError, ConfigError, Error, Result, RuntimeError};
pub use exit_handle::ExitHandle;
pub use metrics::{
    BlockDeviceMetrics, BlockMetrics, CpuMetrics, FilesystemMetrics, MemoryMetrics, MetricsHandle,
    VmMetrics,
};
pub use vm::Vm;
#[cfg(not(feature = "tee"))]
pub use vm::{
    VmControl, VmCpuState, VmExecutionState, VmGenerationId, VmGenerationRequest,
    VmGenerationState, VmGenerationWaitOutcome, VmMemoryRestoreSource, VmMemoryRestoreTarget,
    VmMemoryState, VmPauseGeneration,
};
#[cfg(all(feature = "blk", not(feature = "tee")))]
pub use vmm::device_state::{BlockDeviceState, VirtioDeviceState};
#[cfg(not(feature = "tee"))]
pub use vmm::execution_state::{
    ExecutionArchitecture, ExecutionBackend, ExecutionState, VcpuExecutionState,
};
#[cfg(not(feature = "tee"))]
pub use vmm::memory_state::{
    FullCaptureReason, GuestMemoryRange, IncrementalCaptureDecision, MemoryBaselineToken,
    MemoryCaptureKind, MemoryCaptureOptions, MemoryCapturePlan, MemoryCaptureSink,
    MemoryCaptureStats, MemoryGeneration, MemoryTopologyGeneration,
};
#[cfg(not(feature = "tee"))]
pub use vmm::private_memory::{PrivateMemoryBacking, PrivateMemoryRegion};