uhyve 0.8.0

A specialized hypervisor for Hermit
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

#![warn(rust_2018_idioms)]
#![allow(clippy::useless_conversion)]

use std::path::PathBuf;

use thiserror::Error;

#[macro_use]
extern crate log;

mod arch;
pub mod consts;
mod fdt;
#[cfg(target_os = "linux")]
pub mod linux;
#[cfg(target_os = "linux")]
use linux as os;
#[cfg(target_os = "macos")]
pub mod macos;
#[cfg(target_os = "macos")]
use macos as os;
mod hypercall;
mod isolation;
pub mod mem;
pub(crate) mod paging;
pub mod params;
mod parking;
mod serial;
pub mod stats;
mod vcpu;
pub mod vm;

pub use arch::*;

#[derive(Debug, Error)]
pub enum HypervisorError {
	#[cfg(target_os = "linux")]
	#[error("The KVM backend reported an error: {0}")]
	BackendError(#[from] kvm_ioctls::Error),

	#[cfg(target_os = "macos")]
	#[error("The xhypervisor backend reported an error: {0}")]
	BackendError(#[from] xhypervisor::Error),

	#[error("IO Error: {0}")]
	IOError(#[from] std::io::Error),

	#[error("Invalid kernel path ({0})")]
	InvalidKernelPath(PathBuf),

	#[error(transparent)]
	HermitImageError(#[from] crate::isolation::filemap::HermitImageError),

	#[error("Unable to find Hermit image config in archive")]
	HermitImageConfigNotFound,

	#[error("Unable to parse Hermit image config: {0}")]
	HermitImageConfigParseError(#[from] toml::de::Error),

	#[error("Insufficient guest memory size: got = {got}, wanted = {wanted}")]
	InsufficientGuestMemorySize {
		got: byte_unit::Byte,
		wanted: byte_unit::Byte,
	},

	#[error("Insufficient guest CPU count: got = {got}, wanted = {wanted}")]
	InsufficientGuestCPUs { got: u32, wanted: u32 },

	#[error("Kernel Loading Error: {0}")]
	LoadedKernelError(#[from] vm::LoadKernelError),

	#[error("Kernel doesn't support the necessary features: {0}")]
	FeatureMismatch(&'static str),
}

impl HypervisorError {
	/// Report an (target independent) invalid value error e.g. during debug interactions
	#[cfg_attr(target_os = "macos", expect(unused))]
	fn backend_invalid_value() -> Self {
		Self::BackendError({
			#[cfg(target_os = "linux")]
			{
				kvm_ioctls::Error::new(libc::EINVAL)
			}
			#[cfg(target_os = "macos")]
			{
				xhypervisor::Error::BadArg
			}
		})
	}
}

pub type HypervisorResult<T> = Result<T, HypervisorError>;

pub mod net;
mod pci;
mod virtio;