Remove mshv internal feature and use only mshv3

Signed-off-by: Doru Blânzeanu <[email protected]>

Author: dblnz

Justfile

@@ -172,7 +172,7 @@ test-integration guest target=default-target features="":
 
 # tests compilation with no default features on different platforms
 test-compilation-no-default-features target=default-target:
-    @# Linux should fail without a hypervisor feature (kvm, mshv, or mshv3)
+    @# Linux should fail without a hypervisor feature (kvm or mshv3)
     {{ if os() == "linux" { "! " + cargo-cmd + " check -p hyperlight-host --no-default-features "+target-triple-flag+" 2> /dev/null" } else { "" } }}
     @# Windows should succeed even without default features
     {{ if os() == "windows" { cargo-cmd + " check -p hyperlight-host --no-default-features" } else { "" } }}
@@ -307,7 +307,7 @@ tar-static-lib: (build-rust-capi "release") (build-rust-capi "debug")
 # Downloads the benchmarks result from the given release tag.
 # If tag is not given, defaults to latest release
 # Options for os: "Windows", or "Linux"
-# Options for Linux hypervisor: "kvm", "mshv", "mshv3"
+# Options for Linux hypervisor: "kvm", "mshv3"
 # Options for Windows hypervisor: "hyperv"
 # Options for cpu: "amd", "intel"
 bench-download os hypervisor cpu tag="":

src/hyperlight_host/build.rs

@@ -86,17 +86,15 @@ fn main() -> Result<()> {
     }
 
     // Makes #[cfg(kvm)] == #[cfg(all(feature = "kvm", target_os = "linux"))]
-    // and #[cfg(mshv)] == #[cfg(all(feature = "mshv3", target_os = "linux"))].
-    // Essentially the kvm and mshv features are ignored on windows as long as you use #[cfg(kvm)] and not #[cfg(feature = "kvm")].
-    // You should never use #[cfg(feature = "kvm")] or #[cfg(feature = "mshv")] in the codebase.
+    // Essentially the kvm and mshv3 features are ignored on windows as long as you use #[cfg(kvm)] and not #[cfg(feature = "kvm")].
+    // You should never use #[cfg(feature = "kvm")] or #[cfg(feature = "mshv3")] in the codebase.
     cfg_aliases::cfg_aliases! {
         gdb: { all(feature = "gdb", debug_assertions) },
         kvm: { all(feature = "kvm", target_os = "linux") },
-        mshv: { all(feature = "mshv3", target_os = "linux") },
+        mshv3: { all(feature = "mshv3", target_os = "linux") },
         crashdump: { all(feature = "crashdump") },
         // print_debug feature is aliased with debug_assertions to make it only available in debug-builds.
         print_debug: { all(feature = "print_debug", debug_assertions) },
-        mshv3: { all(feature = "mshv3", target_os = "linux") },
     }
 
     #[cfg(feature = "build-metadata")]

src/hyperlight_host/src/error.rs

@@ -169,7 +169,7 @@ pub enum HyperlightError {
 
     /// mshv Error Occurred
     #[error("mshv Error {0:?}")]
-    #[cfg(mshv)]
+    #[cfg(mshv3)]
     MSHVError(#[from] mshv_ioctls::MshvError),
 
     /// No Hypervisor was found for Sandbox.

src/hyperlight_host/src/hypervisor/gdb/mod.rs

@@ -20,7 +20,7 @@ mod event_loop;
 mod hyperv_debug;
 #[cfg(kvm)]
 mod kvm_debug;
-#[cfg(mshv)]
+#[cfg(mshv3)]
 mod mshv_debug;
 mod x86_64_target;
 
@@ -40,7 +40,7 @@ use hyperlight_common::mem::PAGE_SIZE;
 pub(crate) use hyperv_debug::HypervDebug;
 #[cfg(kvm)]
 pub(crate) use kvm_debug::KvmDebug;
-#[cfg(mshv)]
+#[cfg(mshv3)]
 pub(crate) use mshv_debug::MshvDebug;
 use thiserror::Error;
 use x86_64_target::HyperlightSandboxTarget;

src/hyperlight_host/src/hypervisor/hyperv_linux.rs

@@ -14,9 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-#[cfg(mshv3)]
 extern crate mshv_bindings3 as mshv_bindings;
-#[cfg(mshv3)]
 extern crate mshv_ioctls3 as mshv_ioctls;
 
 use std::fmt::{Debug, Formatter};
@@ -27,7 +25,9 @@ use log::{LevelFilter, error};
 use mshv_bindings::{
     FloatingPointUnit, SpecialRegisters, StandardRegisters, hv_message_type,
     hv_message_type_HVMSG_GPA_INTERCEPT, hv_message_type_HVMSG_UNMAPPED_GPA,
-    hv_message_type_HVMSG_X64_HALT, hv_message_type_HVMSG_X64_IO_PORT_INTERCEPT, hv_register_assoc,
+    hv_message_type_HVMSG_X64_HALT, hv_message_type_HVMSG_X64_IO_PORT_INTERCEPT,
+    hv_partition_property_code_HV_PARTITION_PROPERTY_SYNTHETIC_PROC_FEATURES,
+    hv_partition_synthetic_processor_features, hv_register_assoc,
     hv_register_name_HV_X64_REGISTER_RIP, hv_register_value, mshv_user_mem_region,
 };
 #[cfg(gdb)]
@@ -36,11 +36,6 @@ use mshv_bindings::{
     hv_intercept_type_HV_INTERCEPT_TYPE_EXCEPTION, hv_message_type_HVMSG_X64_EXCEPTION_INTERCEPT,
     mshv_install_intercept,
 };
-#[cfg(mshv3)]
-use mshv_bindings::{
-    hv_partition_property_code_HV_PARTITION_PROPERTY_SYNTHETIC_PROC_FEATURES,
-    hv_partition_synthetic_processor_features,
-};
 use mshv_ioctls::{Mshv, VcpuFd, VmFd};
 use tracing::{Span, instrument};
 #[cfg(feature = "trace_guest")]
@@ -319,7 +314,7 @@ impl HypervLinuxDriver {
     ) -> Result<Self> {
         let mshv = Mshv::new()?;
         let pr = Default::default();
-        #[cfg(mshv3)]
+
         let vm_fd = {
             // It's important to avoid create_vm() and explicitly use
             // create_vm_with_args() with an empty arguments structure
@@ -688,7 +683,6 @@ impl Hypervisor for HypervLinuxDriver {
             // to interrupt it until `running` is set to false. The `vcpu_fd::run()` call will
             // return either normally with an exit reason, or from being "kicked" by out signal handler, with an EINTR error,
             // both of which are fine.
-            #[cfg(mshv3)]
             self.vcpu_fd.run()
         };
         // Note: if a `InterruptHandle::kill()` called while this thread is **here**

src/hyperlight_host/src/hypervisor/mod.rs

@@ -29,7 +29,7 @@ use crate::sandbox::trace::MemTraceInfo;
 use crate::{HyperlightError, Result, log_then_return};
 
 /// HyperV-on-linux functionality
-#[cfg(mshv)]
+#[cfg(mshv3)]
 pub mod hyperv_linux;
 #[cfg(target_os = "windows")]
 /// Hyperv-on-windows functionality
@@ -63,10 +63,10 @@ pub(crate) mod crashdump;
 
 use std::fmt::Debug;
 use std::str::FromStr;
-#[cfg(any(kvm, mshv))]
+#[cfg(any(kvm, mshv3))]
 use std::sync::atomic::{AtomicBool, AtomicU64, Ordering};
 use std::sync::{Arc, Mutex};
-#[cfg(any(kvm, mshv))]
+#[cfg(any(kvm, mshv3))]
 use std::time::Duration;
 
 #[cfg(gdb)]
@@ -486,7 +486,7 @@ pub trait InterruptHandle: Debug + Send + Sync {
     fn dropped(&self) -> bool;
 }
 
-#[cfg(any(kvm, mshv))]
+#[cfg(any(kvm, mshv3))]
 #[derive(Debug)]
 pub(super) struct LinuxInterruptHandle {
     /// Invariant: vcpu is running => most significant bit (63) of `running` is set. (Neither converse nor inverse is true)
@@ -531,7 +531,7 @@ pub(super) struct LinuxInterruptHandle {
     sig_rt_min_offset: u8,
 }
 
-#[cfg(any(kvm, mshv))]
+#[cfg(any(kvm, mshv3))]
 impl LinuxInterruptHandle {
     const RUNNING_BIT: u64 = 1 << 63;
     const MAX_GENERATION: u64 = Self::RUNNING_BIT - 1;
@@ -593,7 +593,7 @@ impl LinuxInterruptHandle {
     }
 }
 
-#[cfg(any(kvm, mshv))]
+#[cfg(any(kvm, mshv3))]
 impl InterruptHandle for LinuxInterruptHandle {
     fn kill(&self) -> bool {
         self.cancel_requested.store(true, Ordering::Relaxed);

src/hyperlight_host/src/hypervisor/regs/fpu.rs

@@ -23,7 +23,7 @@ use std::collections::HashSet;
 
 #[cfg(kvm)]
 use kvm_bindings::kvm_fpu;
-#[cfg(mshv)]
+#[cfg(mshv3)]
 use mshv_bindings::FloatingPointUnit;
 
 #[cfg(target_os = "windows")]
@@ -86,7 +86,7 @@ impl From<&CommonFpu> for kvm_fpu {
     }
 }
 
-#[cfg(mshv)]
+#[cfg(mshv3)]
 impl From<&CommonFpu> for FloatingPointUnit {
     fn from(common_fpu: &CommonFpu) -> FloatingPointUnit {
         FloatingPointUnit {
@@ -124,7 +124,7 @@ impl From<&kvm_fpu> for CommonFpu {
     }
 }
 
-#[cfg(mshv)]
+#[cfg(mshv3)]
 impl From<&FloatingPointUnit> for CommonFpu {
     fn from(mshv_fpu: &FloatingPointUnit) -> Self {
         Self {
@@ -385,7 +385,7 @@ mod tests {
         assert_eq!(original, round_tripped);
     }
 
-    #[cfg(mshv)]
+    #[cfg(mshv3)]
     #[test]
     fn round_trip_mshv_fpu() {
         use mshv_bindings::FloatingPointUnit;

src/hyperlight_host/src/hypervisor/regs/special_regs.rs

@@ -24,7 +24,7 @@ use std::collections::HashSet;
 
 #[cfg(kvm)]
 use kvm_bindings::{kvm_dtable, kvm_segment, kvm_sregs};
-#[cfg(mshv)]
+#[cfg(mshv3)]
 use mshv_bindings::{SegmentRegister, SpecialRegisters, TableRegister};
 #[cfg(target_os = "windows")]
 use windows::Win32::System::Hypervisor::*;
@@ -54,7 +54,7 @@ pub(crate) struct CommonSpecialRegisters {
     pub interrupt_bitmap: [u64; 4],
 }
 
-#[cfg(mshv)]
+#[cfg(mshv3)]
 impl From<&SpecialRegisters> for CommonSpecialRegisters {
     fn from(value: &SpecialRegisters) -> Self {
         CommonSpecialRegisters {
@@ -80,7 +80,7 @@ impl From<&SpecialRegisters> for CommonSpecialRegisters {
     }
 }
 
-#[cfg(mshv)]
+#[cfg(mshv3)]
 impl From<&CommonSpecialRegisters> for SpecialRegisters {
     fn from(other: &CommonSpecialRegisters) -> Self {
         SpecialRegisters {
@@ -340,7 +340,7 @@ pub(crate) struct CommonSegmentRegister {
     pub padding: u8,
 }
 
-#[cfg(mshv)]
+#[cfg(mshv3)]
 impl From<SegmentRegister> for CommonSegmentRegister {
     fn from(other: SegmentRegister) -> Self {
         CommonSegmentRegister {
@@ -361,7 +361,7 @@ impl From<SegmentRegister> for CommonSegmentRegister {
     }
 }
 
-#[cfg(mshv)]
+#[cfg(mshv3)]
 impl From<CommonSegmentRegister> for SegmentRegister {
     fn from(other: CommonSegmentRegister) -> Self {
         SegmentRegister {
@@ -493,7 +493,7 @@ pub(crate) struct CommonTableRegister {
     pub limit: u16,
 }
 
-#[cfg(mshv)]
+#[cfg(mshv3)]
 impl From<TableRegister> for CommonTableRegister {
     fn from(other: TableRegister) -> Self {
         CommonTableRegister {
@@ -503,7 +503,7 @@ impl From<TableRegister> for CommonTableRegister {
     }
 }
 
-#[cfg(mshv)]
+#[cfg(mshv3)]
 impl From<CommonTableRegister> for TableRegister {
     fn from(other: CommonTableRegister) -> Self {
         TableRegister {
@@ -618,7 +618,7 @@ mod tests {
         assert_eq!(original, roundtrip);
     }
 
-    #[cfg(mshv)]
+    #[cfg(mshv3)]
     #[test]
     fn round_trip_mshv_sregs() {
         let original = sample_common_special_registers();

src/hyperlight_host/src/hypervisor/regs/standard_regs.rs

@@ -21,7 +21,7 @@ extern crate mshv_ioctls3 as mshv_ioctls;
 
 #[cfg(kvm)]
 use kvm_bindings::kvm_regs;
-#[cfg(mshv)]
+#[cfg(mshv3)]
 use mshv_bindings::StandardRegisters;
 
 #[derive(Debug, Default, Copy, Clone, PartialEq)]
@@ -101,7 +101,7 @@ impl From<&CommonRegisters> for kvm_regs {
 
 // --- MSHV ---
 
-#[cfg(mshv)]
+#[cfg(mshv3)]
 impl From<&StandardRegisters> for CommonRegisters {
     fn from(mshv_regs: &StandardRegisters) -> Self {
         CommonRegisters {
@@ -127,7 +127,7 @@ impl From<&StandardRegisters> for CommonRegisters {
     }
 }
 
-#[cfg(mshv)]
+#[cfg(mshv3)]
 impl From<&CommonRegisters> for StandardRegisters {
     fn from(regs: &CommonRegisters) -> Self {
         StandardRegisters {
@@ -375,7 +375,7 @@ mod tests {
         assert_eq!(original, converted);
     }
 
-    #[cfg(mshv)]
+    #[cfg(mshv3)]
     #[test]
     fn round_trip_mshv_regs() {
         let original = common_regs();

src/hyperlight_host/src/mem/memory_region.rs

@@ -22,7 +22,7 @@ extern crate mshv_ioctls3 as mshv_ioctls;
 use std::ops::Range;
 
 use bitflags::bitflags;
-#[cfg(mshv)]
+#[cfg(mshv3)]
 use hyperlight_common::mem::PAGE_SHIFT;
 use hyperlight_common::mem::PAGE_SIZE_USIZE;
 #[cfg(kvm)]
@@ -31,7 +31,7 @@ use kvm_bindings::{KVM_MEM_READONLY, kvm_userspace_memory_region};
 use mshv_bindings::{
     MSHV_SET_MEM_BIT_EXECUTABLE, MSHV_SET_MEM_BIT_UNMAP, MSHV_SET_MEM_BIT_WRITABLE,
 };
-#[cfg(mshv)]
+#[cfg(mshv3)]
 use mshv_bindings::{hv_x64_memory_intercept_message, mshv_user_mem_region};
 #[cfg(target_os = "windows")]
 use windows::Win32::System::Hypervisor::{self, WHV_MEMORY_ACCESS_TYPE};
@@ -127,7 +127,7 @@ impl TryFrom<WHV_MEMORY_ACCESS_TYPE> for MemoryRegionFlags {
     }
 }
 
-#[cfg(mshv)]
+#[cfg(mshv3)]
 impl TryFrom<hv_x64_memory_intercept_message> for MemoryRegionFlags {
     type Error = crate::HyperlightError;
 
@@ -252,33 +252,30 @@ impl MemoryRegionVecBuilder {
     }
 }
 
-#[cfg(mshv)]
+#[cfg(mshv3)]
 impl From<MemoryRegion> for mshv_user_mem_region {
     fn from(region: MemoryRegion) -> Self {
         let size = (region.guest_region.end - region.guest_region.start) as u64;
         let guest_pfn = region.guest_region.start as u64 >> PAGE_SHIFT;
         let userspace_addr = region.host_region.start as u64;
 
-        #[cfg(mshv3)]
-        {
-            let flags: u8 = region.flags.iter().fold(0, |acc, flag| {
-                let flag_value = match flag {
-                    MemoryRegionFlags::NONE => 1 << MSHV_SET_MEM_BIT_UNMAP,
-                    MemoryRegionFlags::READ => 0,
-                    MemoryRegionFlags::WRITE => 1 << MSHV_SET_MEM_BIT_WRITABLE,
-                    MemoryRegionFlags::EXECUTE => 1 << MSHV_SET_MEM_BIT_EXECUTABLE,
-                    _ => 0, // ignore any unknown flags
-                };
-                acc | flag_value
-            });
-
-            mshv_user_mem_region {
-                guest_pfn,
-                size,
-                userspace_addr,
-                flags,
-                ..Default::default()
-            }
+        let flags: u8 = region.flags.iter().fold(0, |acc, flag| {
+            let flag_value = match flag {
+                MemoryRegionFlags::NONE => 1 << MSHV_SET_MEM_BIT_UNMAP,
+                MemoryRegionFlags::READ => 0,
+                MemoryRegionFlags::WRITE => 1 << MSHV_SET_MEM_BIT_WRITABLE,
+                MemoryRegionFlags::EXECUTE => 1 << MSHV_SET_MEM_BIT_EXECUTABLE,
+                _ => 0, // ignore any unknown flags
+            };
+            acc | flag_value
+        });
+
+        mshv_user_mem_region {
+            guest_pfn,
+            size,
+            userspace_addr,
+            flags,
+            ..Default::default()
         }
     }
 }