virt_underhill: rename to virt_mshv_vtl (#63)

Currently and somewhat fundamentally, `virt_underhill` depends on the
mshv_vtl driver, even for SNP and TDX. When we want to support SNP/TDX
without the Microsoft hypervisor in the future, we will need to decide
whether the mshv_vtl driver will be extended to support that, or whether
we'll want to take a different approach.

But either way, in the meantime, this is a more accurate name for the
crate.

Author: jstarks

Cargo.lock

@@ -6676,7 +6676,7 @@ dependencies = [
  "vga_proxy",
  "video_core",
  "virt",
- "virt_underhill",
+ "virt_mshv_vtl",
  "vm_loader",
  "vm_manifest_builder",
  "vm_resource",
@@ -6782,7 +6782,7 @@ dependencies = [
  "thiserror",
  "tracing",
  "underhill_threadpool",
- "virt_underhill",
+ "virt_mshv_vtl",
  "vm_topology",
  "x86defs",
 ]
@@ -7112,6 +7112,51 @@ dependencies = [
  "zerocopy",
 ]
 
+[[package]]
+name = "virt_mshv_vtl"
+version = "0.0.0"
+dependencies = [
+ "aarch64defs",
+ "aarch64emu",
+ "anyhow",
+ "bitfield-struct",
+ "bitvec",
+ "build_rs_guest_arch",
+ "cfg-if",
+ "fs-err",
+ "guestmem",
+ "hcl",
+ "hv1_emulator",
+ "hv1_hypercall",
+ "hvdef",
+ "inspect",
+ "inspect_counters",
+ "libc",
+ "memory_range",
+ "mesh",
+ "pal",
+ "pal_async",
+ "pal_uring",
+ "parking_lot",
+ "pci_core",
+ "safe_x86_intrinsics",
+ "shared_pool_alloc",
+ "sidecar_client",
+ "thiserror",
+ "tracelimit",
+ "tracing",
+ "virt",
+ "virt_support_aarch64emu",
+ "virt_support_apic",
+ "virt_support_x86emu",
+ "vm_topology",
+ "vmcore",
+ "vtl_array",
+ "x86defs",
+ "x86emu",
+ "zerocopy",
+]
+
 [[package]]
 name = "virt_support_aarch64emu"
 version = "0.0.0"
@@ -7174,51 +7219,6 @@ dependencies = [
  "zerocopy",
 ]
 
-[[package]]
-name = "virt_underhill"
-version = "0.0.0"
-dependencies = [
- "aarch64defs",
- "aarch64emu",
- "anyhow",
- "bitfield-struct",
- "bitvec",
- "build_rs_guest_arch",
- "cfg-if",
- "fs-err",
- "guestmem",
- "hcl",
- "hv1_emulator",
- "hv1_hypercall",
- "hvdef",
- "inspect",
- "inspect_counters",
- "libc",
- "memory_range",
- "mesh",
- "pal",
- "pal_async",
- "pal_uring",
- "parking_lot",
- "pci_core",
- "safe_x86_intrinsics",
- "shared_pool_alloc",
- "sidecar_client",
- "thiserror",
- "tracelimit",
- "tracing",
- "virt",
- "virt_support_aarch64emu",
- "virt_support_apic",
- "virt_support_x86emu",
- "vm_topology",
- "vmcore",
- "vtl_array",
- "x86defs",
- "x86emu",
- "zerocopy",
-]
-
 [[package]]
 name = "virt_whp"
 version = "0.0.0"

Cargo.toml

@@ -158,7 +158,7 @@ underhill_init = { path = "openhcl/underhill_init" }
 underhill_mem = { path = "openhcl/underhill_mem" }
 openvmm_hcl_resources = { path = "openhcl/openvmm_hcl_resources" }
 underhill_threadpool = { path = "openhcl/underhill_threadpool" }
-virt_underhill = { path = "openhcl/virt_underhill" }
+virt_mshv_vtl = { path = "openhcl/virt_mshv_vtl" }
 
 aarch64defs = { path = "vm/aarch64/aarch64defs" }
 aarch64emu = { path = "vm/aarch64/aarch64emu" }

openhcl/underhill_core/Cargo.toml

@@ -9,7 +9,7 @@ edition = "2021"
 profiler = ["dep:profiler_worker", "diag_server/profiler"]
 
 # Enable gdbstub support
-gdb = ["debug_worker_defs", "vmm_core/gdb", "virt_underhill/gdb"]
+gdb = ["debug_worker_defs", "vmm_core/gdb", "virt_mshv_vtl/gdb"]
 
 # Enable locally compiling and statically linking a copy of OpenSSL.
 # The build process requires a C compiler, perl, and make.
@@ -92,7 +92,7 @@ underhill_threadpool.workspace = true
 bootloader_fdt_parser.workspace = true
 vga_proxy.workspace = true
 video_core.workspace = true
-virt_underhill.workspace = true
+virt_mshv_vtl.workspace = true
 vm_manifest_builder.workspace = true
 vmbus_async.workspace = true
 vmbus_user_channel.workspace = true

openhcl/underhill_core/src/dispatch/mod.rs

@@ -54,8 +54,8 @@ use tracing::instrument;
 use tracing::Instrument;
 use uevent::UeventListener;
 use underhill_threadpool::AffinitizedThreadpool;
-use virt_underhill::UhPartition;
-use virt_underhill::VtlCrash;
+use virt_mshv_vtl::UhPartition;
+use virt_mshv_vtl::VtlCrash;
 use vm_resource::ResourceResolver;
 use vm_topology::memory::MemoryRangeWithNode;
 use vmbus_channel::channel::VmbusDevice;

openhcl/underhill_core/src/emuplat/firmware.rs

@@ -9,7 +9,7 @@ use firmware_uefi::platform::logger::UefiLogger;
 use guest_emulation_transport::api::EventLogId;
 use guest_emulation_transport::GuestEmulationTransportClient;
 use std::sync::Weak;
-use virt_underhill::UhPartition;
+use virt_mshv_vtl::UhPartition;
 
 /// An Underhill specific logger used to log UEFI and PCAT events.
 #[derive(Debug)]

openhcl/underhill_core/src/emuplat/vga_proxy.rs

@@ -2,7 +2,7 @@
 
 use std::ops::RangeInclusive;
 use std::sync::Arc;
-use virt_underhill::UhPartition;
+use virt_mshv_vtl::UhPartition;
 
 pub struct UhRegisterHostIoFastPath(pub Arc<UhPartition>);
 

openhcl/underhill_core/src/vp.rs

@@ -11,7 +11,7 @@ use underhill_threadpool::AffinitizedThreadpool;
 
 pub(crate) async fn spawn_vps(
     tp: &AffinitizedThreadpool,
-    vps: Vec<virt_underhill::UhProcessorBox>,
+    vps: Vec<virt_mshv_vtl::UhProcessorBox>,
     runners: Vec<vmm_core::partition_unit::VpRunner>,
     chipset: &vmm_core::vmotherboard_adapter::ChipsetPlusSynic,
     isolation: Option<hcl::ioctl::IsolationType>,
@@ -27,7 +27,7 @@ pub(crate) async fn spawn_vps(
 
 /// An object to spawn and run a VP.
 struct VpSpawner {
-    vp: virt_underhill::UhProcessorBox,
+    vp: virt_mshv_vtl::UhProcessorBox,
     cpu: u32,
     chipset: vmm_core::vmotherboard_adapter::ChipsetPlusSynic,
     runner: vmm_core::partition_unit::VpRunner,
@@ -37,7 +37,7 @@ struct VpSpawner {
 impl VpSpawner {
     /// Creates a new spawner.
     pub fn new(
-        vp: virt_underhill::UhProcessorBox,
+        vp: virt_mshv_vtl::UhProcessorBox,
         chipset: vmm_core::vmotherboard_adapter::ChipsetPlusSynic,
         runner: vmm_core::partition_unit::VpRunner,
         isolation: Option<hcl::ioctl::IsolationType>,
@@ -71,14 +71,14 @@ impl VpSpawner {
         }
     }
 
-    async fn run_backed_vp<T: virt_underhill::Backing>(
+    async fn run_backed_vp<T: virt_mshv_vtl::Backing>(
         &mut self,
         saved_state: Option<vmcore::save_restore::SavedStateBlob>,
         control: Option<&mut IdleControl>,
         save_on_cancel: bool,
     ) -> anyhow::Result<Option<vmcore::save_restore::SavedStateBlob>>
     where
-        for<'a> virt_underhill::UhProcessor<'a, T>: vmcore::save_restore::ProtobufSaveRestore,
+        for<'a> virt_mshv_vtl::UhProcessor<'a, T>: vmcore::save_restore::ProtobufSaveRestore,
     {
         let thread = underhill_threadpool::Thread::current().unwrap();
         // TODO propagate this error back earlier. This is easiest if
@@ -116,7 +116,7 @@ impl VpSpawner {
     ) -> Option<vmcore::save_restore::SavedStateBlob> {
         let r = match self.isolation {
             None | Some(hcl::ioctl::IsolationType::Vbs) => {
-                self.run_backed_vp::<virt_underhill::HypervisorBacked>(
+                self.run_backed_vp::<virt_mshv_vtl::HypervisorBacked>(
                     saved_state,
                     control,
                     save_on_cancel,
@@ -125,21 +125,13 @@ impl VpSpawner {
             }
             #[cfg(guest_arch = "x86_64")]
             Some(hcl::ioctl::IsolationType::Snp) => {
-                self.run_backed_vp::<virt_underhill::SnpBacked>(
-                    saved_state,
-                    control,
-                    save_on_cancel,
-                )
-                .await
+                self.run_backed_vp::<virt_mshv_vtl::SnpBacked>(saved_state, control, save_on_cancel)
+                    .await
             }
             #[cfg(guest_arch = "x86_64")]
             Some(hcl::ioctl::IsolationType::Tdx) => {
-                self.run_backed_vp::<virt_underhill::TdxBacked>(
-                    saved_state,
-                    control,
-                    save_on_cancel,
-                )
-                .await
+                self.run_backed_vp::<virt_mshv_vtl::TdxBacked>(saved_state, control, save_on_cancel)
+                    .await
             }
             #[cfg(guest_arch = "aarch64")]
             _ => unimplemented!(),

openhcl/underhill_core/src/worker.rs

@@ -120,8 +120,8 @@ use virt::state::HvRegisterState;
 use virt::Partition;
 use virt::VpIndex;
 use virt::X86Partition;
-use virt_underhill::UhPartition;
-use virt_underhill::UhPartitionNewParams;
+use virt_mshv_vtl::UhPartition;
+use virt_mshv_vtl::UhPartitionNewParams;
 use vm_loader::initial_regs::initial_regs;
 use vm_resource::kind::DiskHandleKind;
 use vm_resource::kind::KeyboardInputHandleKind;
@@ -1255,15 +1255,15 @@ async fn new_underhill_vm(
         #[cfg(guest_arch = "x86_64")]
         Some(hcl::ioctl::IsolationType::Snp) => {
             let cpu_bytes = boot_info.cpus.len() as u64
-                * virt_underhill::snp_shared_pages_required_per_cpu()
+                * virt_mshv_vtl::snp_shared_pages_required_per_cpu()
                 * hvdef::HV_PAGE_SIZE;
 
             round_up_to_2mb(cpu_bytes + device_dma + attestation)
         }
         #[cfg(guest_arch = "x86_64")]
         Some(hcl::ioctl::IsolationType::Tdx) => {
             let cpu_bytes = boot_info.cpus.len() as u64
-                * virt_underhill::tdx_shared_pages_required_per_cpu()
+                * virt_mshv_vtl::tdx_shared_pages_required_per_cpu()
                 * hvdef::HV_PAGE_SIZE;
 
             round_up_to_2mb(cpu_bytes + device_dma + attestation)

openhcl/underhill_core/src/wrapped_partition.rs

@@ -6,7 +6,7 @@ use inspect::InspectMut;
 use memory_range::MemoryRange;
 use std::sync::Arc;
 use virt::PageVisibility;
-use virt_underhill::UhPartition;
+use virt_mshv_vtl::UhPartition;
 use vmcore::save_restore::NoSavedState;
 use vmcore::save_restore::RestoreError;
 use vmcore::save_restore::SaveError;

openhcl/underhill_mem/Cargo.toml

@@ -10,7 +10,7 @@ hcl.workspace = true
 hvdef.workspace = true
 memory_range.workspace = true
 underhill_threadpool.workspace = true
-virt_underhill.workspace = true
+virt_mshv_vtl.workspace = true
 vm_topology.workspace = true
 x86defs.workspace = true