hcl/
lib.rs

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
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

//! Crate for interacting with the hypervisor via the /dev/mshv_vtl device and
//! related kernel functionality.

#![cfg(target_os = "linux")]
// UNSAFETY: Calling ioctls.
#![expect(unsafe_code)]

use hvdef::Vtl;
use hvdef::hypercall::HvInputVtl;
use inspect::Inspect;
use thiserror::Error;

pub mod ioctl;
mod mapped_page;
pub mod protocol;
pub mod stats;
pub mod vmbus;
pub mod vmsa;

/// The VTL, exclusive of the paravisor VTL (VTL2).
///
/// This is useful to use instead of [`Vtl`] to statically ensure that the VTL
/// is not VTL2.
#[derive(Copy, Clone, Debug, Inspect, PartialEq, Eq, PartialOrd, Ord)]
pub enum GuestVtl {
    /// VTL0
    Vtl0 = 0,
    /// VTL1
    Vtl1 = 1,
}

impl From<GuestVtl> for HvInputVtl {
    fn from(value: GuestVtl) -> Self {
        Vtl::from(value).into()
    }
}

impl From<GuestVtl> for u8 {
    fn from(value: GuestVtl) -> Self {
        Vtl::from(value).into()
    }
}

impl From<GuestVtl> for Vtl {
    fn from(value: GuestVtl) -> Self {
        match value {
            GuestVtl::Vtl0 => Vtl::Vtl0,
            GuestVtl::Vtl1 => Vtl::Vtl1,
        }
    }
}

/// The specified VTL is not supported in the current context.
#[derive(Debug, Error)]
#[error("unsupported guest VTL")]
pub struct UnsupportedGuestVtl(pub u8);

impl TryFrom<Vtl> for GuestVtl {
    type Error = UnsupportedGuestVtl;

    fn try_from(value: Vtl) -> Result<Self, Self::Error> {
        Ok(match value {
            Vtl::Vtl0 => GuestVtl::Vtl0,
            Vtl::Vtl1 => GuestVtl::Vtl1,
            _ => return Err(UnsupportedGuestVtl(value.into())),
        })
    }
}

impl TryFrom<u8> for GuestVtl {
    type Error = UnsupportedGuestVtl;

    fn try_from(value: u8) -> Result<Self, Self::Error> {
        Ok(match value {
            0 => GuestVtl::Vtl0,
            1 => GuestVtl::Vtl1,
            _ => return Err(UnsupportedGuestVtl(value)),
        })
    }
}