petri: add with_nic helper to config (#796)

Currently, mana tests write a good amount of boilerplate code to add
devices. This change adds a `with_nic` helper to streamline writing mana
tests.

Author: justus-camp-microsoft

Cargo.lock

@@ -5148,6 +5148,7 @@ dependencies = [
  "fscommon",
  "futures",
  "futures-concurrency",
+ "gdma_resources",
  "get_resources",
  "gptman",
  "guid",
@@ -5166,6 +5167,7 @@ dependencies = [
  "mesh",
  "mesh_process",
  "mesh_worker",
+ "net_backend_resources",
  "nvme_resources",
  "pal",
  "pal_async",
@@ -8494,13 +8496,11 @@ dependencies = [
  "anyhow",
  "build_rs_guest_arch",
  "disk_backend_resources",
- "gdma_resources",
  "guid",
  "hvlite_defs",
  "hvlite_ttrpc_vmservice",
  "mesh",
  "mesh_rpc",
- "net_backend_resources",
  "nvme_resources",
  "pal_async",
  "petri",

petri/Cargo.toml

@@ -20,13 +20,15 @@ hvlite_helpers.workspace = true
 hvlite_pcat_locator.workspace = true
 hyperv_ic_resources.workspace = true
 hyperv_secure_boot_templates.workspace = true
+gdma_resources.workspace = true
 vmbus_serial_resources.workspace = true
 underhill_confidentiality.workspace = true
 vtl2_settings_proto.workspace = true
 disk_backend_resources.workspace = true
 framebuffer.workspace = true
 get_resources.workspace = true
 ide_resources.workspace = true
+net_backend_resources.workspace = true
 nvme_resources.workspace = true
 scsidisk_resources.workspace = true
 serial_core.workspace = true

petri/src/vm/openvmm/mod.rs

@@ -51,6 +51,9 @@ pub(crate) const SCSI_INSTANCE: Guid =
 pub(crate) const BOOT_NVME_INSTANCE: Guid =
     Guid::from_static_str("92bc8346-718b-449a-8751-edbf3dcd27e4");
 
+/// The instance guid for the MANA nic automatically added when specifying `PetriVmConfigOpenVmm::with_nic`
+const MANA_INSTANCE: Guid = Guid::from_static_str("f9641cf4-d915-4743-a7d8-efa75db7b85a");
+
 /// The namespace ID for the NVMe controller automatically added for boot media.
 pub(crate) const BOOT_NVME_NSID: u32 = 37;
 

petri/src/vm/openvmm/modify.rs

@@ -4,11 +4,16 @@
 //! Helpers to modify a [`PetriVmConfigOpenVmm`] from its defaults.
 
 use super::PetriVmConfigOpenVmm;
+use super::MANA_INSTANCE;
 use chipset_resources::battery::BatteryDeviceHandleX64;
 use chipset_resources::battery::HostBatteryUpdate;
 use fs_err::File;
+use gdma_resources::GdmaDeviceHandle;
+use gdma_resources::VportDefinition;
 use hvlite_defs::config::Config;
+use hvlite_defs::config::DeviceVtl;
 use hvlite_defs::config::LoadMode;
+use hvlite_defs::config::VpciDeviceConfig;
 use hvlite_defs::config::Vtl2BaseAddressType;
 use petri_artifacts_common::tags::IsOpenhclIgvm;
 use petri_artifacts_core::ArtifactHandle;
@@ -131,6 +136,37 @@ impl PetriVmConfigOpenVmm {
         self
     }
 
+    /// Enable an emulated mana device for the VM.
+    pub fn with_nic(mut self) -> Self {
+        self.config.vpci_devices.push(VpciDeviceConfig {
+            vtl: DeviceVtl::Vtl2,
+            instance_id: MANA_INSTANCE,
+            resource: GdmaDeviceHandle {
+                vports: vec![VportDefinition {
+                    mac_address: [0x00, 0x15, 0x5D, 0x12, 0x12, 0x12].into(),
+                    endpoint: net_backend_resources::consomme::ConsommeHandle { cidr: None }
+                        .into_resource(),
+                }],
+            }
+            .into_resource(),
+        });
+
+        self.vtl2_settings
+            .as_mut()
+            .unwrap()
+            .dynamic
+            .as_mut()
+            .unwrap()
+            .nic_devices
+            .push(vtl2_settings_proto::NicDeviceLegacy {
+                instance_id: MANA_INSTANCE.to_string(),
+                subordinate_instance_id: None,
+                max_sub_channels: None,
+            });
+
+        self
+    }
+
     /// Add custom command line arguments to OpenHCL.
     pub fn with_openhcl_command_line(mut self, additional_cmdline: &str) -> Self {
         if !self.firmware.is_openhcl() {

vmm_tests/vmm_tests/Cargo.toml

@@ -38,9 +38,6 @@ tracing.workspace = true
 
 hvlite_ttrpc_vmservice.workspace = true
 
-gdma_resources.workspace = true
-net_backend_resources.workspace = true
-
 mesh_rpc.workspace = true
 
 [build-dependencies]

vmm_tests/vmm_tests/tests/tests/x86_64/openhcl_linux_direct.rs

@@ -6,8 +6,6 @@
 use anyhow::Context;
 use disk_backend_resources::layer::RamDiskLayerHandle;
 use disk_backend_resources::LayeredDiskHandle;
-use gdma_resources::GdmaDeviceHandle;
-use gdma_resources::VportDefinition;
 use guid::Guid;
 use hvlite_defs::config::DeviceVtl;
 use hvlite_defs::config::VpciDeviceConfig;
@@ -16,7 +14,6 @@ use mesh::rpc::RpcSend;
 use nvme_resources::NamespaceDefinition;
 use nvme_resources::NvmeControllerHandle;
 use petri::openvmm::PetriVmConfigOpenVmm;
-use petri::openvmm::PetriVmOpenVmm;
 use petri::pipette::cmd;
 use petri::pipette::PipetteClient;
 use petri::OpenHclServicingFlags;
@@ -48,52 +45,11 @@ async fn validate_mana_nic(agent: &PipetteClient) -> Result<(), anyhow::Error> {
     Ok(())
 }
 
-/// Boot an OpenHCL Linux direct VM with a MANA nic assigned to VTL2 (backed by
-/// the MANA emulator), and vmbus relay. This should expose a nic to VTL0 via
-/// vmbus.
-async fn boot_openhcl_linux_mana_nic(
-    config: PetriVmConfigOpenVmm,
-) -> Result<(PetriVmOpenVmm, PipetteClient), anyhow::Error> {
-    const MANA_INSTANCE: Guid = Guid::from_static_str("27b553e8-8b39-411b-a55f-839971a7884f");
-
-    let (vm, agent) = config
-        .with_vmbus_redirect()
-        .with_custom_config(|c| {
-            c.vpci_devices.push(VpciDeviceConfig {
-                vtl: DeviceVtl::Vtl2,
-                instance_id: MANA_INSTANCE,
-                resource: GdmaDeviceHandle {
-                    vports: vec![VportDefinition {
-                        mac_address: [0x00, 0x15, 0x5D, 0x12, 0x12, 0x12].into(),
-                        endpoint: net_backend_resources::consomme::ConsommeHandle { cidr: None }
-                            .into_resource(),
-                    }],
-                }
-                .into_resource(),
-            });
-        })
-        .with_custom_vtl2_settings(|v| {
-            v.dynamic
-                .as_mut()
-                .unwrap()
-                .nic_devices
-                .push(vtl2_settings_proto::NicDeviceLegacy {
-                    instance_id: MANA_INSTANCE.to_string(),
-                    subordinate_instance_id: None,
-                    max_sub_channels: None,
-                })
-        })
-        .run()
-        .await?;
-
-    Ok((vm, agent))
-}
-
 /// Test an OpenHCL Linux direct VM with a MANA nic assigned to VTL2 (backed by
 /// the MANA emulator), and vmbus relay.
 #[openvmm_test(openhcl_linux_direct_x64)]
 async fn mana_nic(config: PetriVmConfigOpenVmm) -> Result<(), anyhow::Error> {
-    let (vm, agent) = boot_openhcl_linux_mana_nic(config).await?;
+    let (vm, agent) = config.with_vmbus_redirect().with_nic().run().await?;
 
     validate_mana_nic(&agent).await?;
 
@@ -108,10 +64,12 @@ async fn mana_nic(config: PetriVmConfigOpenVmm) -> Result<(), anyhow::Error> {
 /// the shared pool dma path.
 #[openvmm_test(openhcl_linux_direct_x64)]
 async fn mana_nic_shared_pool(config: PetriVmConfigOpenVmm) -> Result<(), anyhow::Error> {
-    let (vm, agent) = boot_openhcl_linux_mana_nic(
-        config.with_openhcl_command_line("OPENHCL_ENABLE_SHARED_VISIBILITY_POOL=1"),
-    )
-    .await?;
+    let (vm, agent) = config
+        .with_vmbus_redirect()
+        .with_nic()
+        .with_openhcl_command_line("OPENHCL_ENABLE_SHARED_VISIBILITY_POOL=1")
+        .run()
+        .await?;
 
     validate_mana_nic(&agent).await?;
 
@@ -126,7 +84,12 @@ async fn mana_nic_shared_pool(config: PetriVmConfigOpenVmm) -> Result<(), anyhow
 /// nic is still functional.
 #[openvmm_test(openhcl_linux_direct_x64)]
 async fn mana_nic_servicing(config: PetriVmConfigOpenVmm) -> Result<(), anyhow::Error> {
-    let (mut vm, agent) = boot_openhcl_linux_mana_nic(config).await?;
+    let (mut vm, agent) = config
+        .with_vmbus_redirect()
+        .with_nic()
+        .with_openhcl_command_line("OPENHCL_ENABLE_SHARED_VISIBILITY_POOL=1")
+        .run()
+        .await?;
 
     validate_mana_nic(&agent).await?;