uhyve-interface 0.3.0

The interface between uhyve and a guest VM
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

#![doc(
	html_favicon_url = "https://media.githubusercontent.com/media/hermit-os/uhyve/main/img/uhyve_128.png"
)]
#![doc(
	html_logo_url = "https://media.githubusercontent.com/media/hermit-os/uhyve/main/img/uhyve_512.png"
)]
//! # Uhyve Hypercall Interface
//!
//! This crate specifies the interface between the [Hermit Unikernel](https://github.com/hermit-os/kernel) and the hypervisor [Uhyve](https://github.com/hermit-os/uhyve).
//! It includes the definition of the hypercalls and hypercall parameters and is intended to be used in both projects to ensure a coherent and well defined interface.

#![cfg_attr(not(feature = "std"), no_std)]

/// Each hypercall corresponds to an address, used by Uhyve to tell each hypercall apart.
/// "Converting" hypercall objects to hypercall addresses is done often.
/// This similarly applies to references of hypercall objects.
/// Normally, we would have to implement two similar From traits for each version.
/// This macro helps us reduce the boilerplate.
macro_rules! into_hypercall_addresses {
	(@internal $Self:ty; $name1:ident => $name2:ident) => { <$Self>::$name2 };
	(@internal $Self:ty; $name1:ident) => { <$Self>::$name1 };

	(
	impl From<$hc:ident> for $hca:ty {
		match {
			$( $name1:ident $(=> $name2:ident)? ),*
			$(,)?
		}
	}
	) => {
		impl From<$hc<'_>> for $hca {
			fn from(value: $hc<'_>) -> Self {
				match value {
					$($hc::$name1 { .. } => into_hypercall_addresses!(@internal Self; $name1 $(=> $name2)?)),*
				}
			}
		}
		impl From<&$hc<'_>> for $hca {
			fn from(value: &$hc<'_>) -> Self {
				match value {
					$($hc::$name1 { .. } => into_hypercall_addresses!(@internal Self; $name1 $(=> $name2)?)),*
				}
			}
		}
	}
}

/// Common parameters for versions 1 and 2 of the Hypercall Interface
mod parameters;

/// Version 1 of the Hypercall Interface
pub mod v1;
/// Version 2 of the Hypercall Interface
pub mod v2;

pub use memory_addresses::{PhysAddr as GuestPhysAddr, VirtAddr as GuestVirtAddr};

#[cfg(not(target_pointer_width = "64"))]
compile_error!("Using uhyve-interface on a non-64-bit system is not (yet?) supported");

/// The version of the Uhyve interface. Note: This is not the same as the semver of the crate but
/// should be increased on every version bump that changes the API.
pub const UHYVE_INTERFACE_VERSION: u32 = 3;