petri: allow test to override default VTL2 allocation scheme (#2224)

Promote the settings that change how VTL2 memory is allocated to the
Petri VM objects, rather than being hidden in the depths of the OpenVMM
config. This is a convenience for additional tests coming as part of
#2215 .

Author: mattkur

petri/src/vm/hyperv/mod.rs

@@ -467,9 +467,14 @@ impl PetriVmmBackend for HyperVPetriBackend {
                 vmbus_redirect,
                 command_line: _,
                 log_levels: _,
+                vtl2_base_address_type,
             },
         )) = &openhcl_config
         {
+            if vtl2_base_address_type.is_some() {
+                todo!("custom VTL2 base address type not yet supported for Hyper-V")
+            }
+
             // Copy the IGVM file locally, since it may not be accessible by
             // Hyper-V (e.g., if it is in a WSL filesystem).
             let igvm_file = temp_dir.path().join("igvm.bin");

petri/src/vm/mod.rs

@@ -15,6 +15,7 @@ use crate::disk_image::AgentImage;
 use crate::openhcl_diag::OpenHclDiagHandler;
 use async_trait::async_trait;
 use get_resources::ged::FirmwareEvent;
+use hvlite_defs::config::Vtl2BaseAddressType;
 use mesh::CancelContext;
 use pal_async::DefaultDriver;
 use pal_async::task::Spawn;
@@ -477,6 +478,19 @@ impl<T: PetriVmmBackend> PetriVmBuilder<T> {
         self
     }
 
+    /// Sets a custom OpenHCL IGVM VTL2 address type. This controls the behavior
+    /// of where VTL2 is placed in address space, and also the total size of memory
+    /// allocated for VTL2. VTL2 start will fail if `address_type` is specified
+    /// and leads to the loader allocating less memory than what is in the IGVM file.
+    pub fn with_vtl2_base_address_type(mut self, address_type: Vtl2BaseAddressType) -> Self {
+        self.config
+            .firmware
+            .openhcl_config_mut()
+            .expect("OpenHCL firmware is required to set custom VTL2 address type.")
+            .vtl2_base_address_type = Some(address_type);
+        self
+    }
+
     /// Sets a custom OpenHCL IGVM file to use.
     pub fn with_custom_openhcl(mut self, artifact: ResolvedArtifact<impl IsOpenhclIgvm>) -> Self {
         match &mut self.config.firmware {
@@ -1193,6 +1207,9 @@ pub struct OpenHclConfig {
     /// from `command_line` so that petri can decide to use default log
     /// levels.
     pub log_levels: OpenHclLogConfig,
+    /// How to place VTL2 in address space. If `None`, the backend VMM
+    /// will decide on default behavior.
+    pub vtl2_base_address_type: Option<Vtl2BaseAddressType>,
 }
 
 impl OpenHclConfig {
@@ -1239,6 +1256,7 @@ impl Default for OpenHclConfig {
             vmbus_redirect: false,
             command_line: None,
             log_levels: OpenHclLogConfig::TestDefault,
+            vtl2_base_address_type: None,
         }
     }
 }

petri/src/vm/openvmm/construct.rs

@@ -184,11 +184,23 @@ impl PetriVmConfigOpenVmm {
                     framebuffer.is_some(),
                     tpm_state_persistence,
                 )?;
+
+                let late_map_vtl0_memory = match load_mode {
+                    LoadMode::Igvm {
+                        vtl2_base_address: Vtl2BaseAddressType::Vtl2Allocate { .. },
+                        ..
+                    } => {
+                        // Late Map VTL0 memory not supported when test supplies Vtl2Allocate
+                        None
+                    }
+                    _ => Some(LateMapVtl0MemoryPolicy::InjectException),
+                };
+
                 let (vtl2_vsock_listener, vtl2_vsock_path) = make_vsock_listener()?;
                 (
                     Some(Vtl2Config {
                         vtl0_alias_map: false, // TODO: enable when OpenVMM supports it for DMA
-                        late_map_vtl0_memory: Some(LateMapVtl0MemoryPolicy::InjectException),
+                        late_map_vtl0_memory,
                     }),
                     Some(VmbusConfig {
                         vsock_listener: Some(vtl2_vsock_listener),
@@ -686,6 +698,7 @@ impl PetriVmConfigSetupCore<'_> {
                     vmbus_redirect: _, // config_openhcl_vmbus_devices
                     command_line: _,
                     log_levels: _,
+                    vtl2_base_address_type,
                 } = openhcl_config;
 
                 let mut cmdline = Some(openhcl_config.command_line());
@@ -706,23 +719,28 @@ impl PetriVmConfigSetupCore<'_> {
                     Firmware::OpenhclUefi { isolation, .. } if isolation.is_some() => true,
                     _ => false,
                 };
-                let file = File::open(igvm_path.clone())
-                    .context("failed to open openhcl firmware file")?
-                    .into();
-                LoadMode::Igvm {
-                    file,
-                    cmdline: cmdline.unwrap_or_default(),
-                    vtl2_base_address: if isolated {
+
+                let vtl2_base_address = vtl2_base_address_type.unwrap_or_else(|| {
+                    if isolated {
                         // Isolated VMs must load at the location specified by
                         // the file, as they do not support relocation.
                         Vtl2BaseAddressType::File
                     } else {
-                        // By default, utilize IGVM relocation and tell hvlite
+                        // By default, utilize IGVM relocation and tell OpenVMM
                         // to place VTL2 at 2GB. This tests both relocation
-                        // support in hvlite, and relocation support within
-                        // underhill.
+                        // support in OpenVMM, and relocation support within
+                        // OpenHCL.
                         Vtl2BaseAddressType::Absolute(2 * SIZE_1_GB)
-                    },
+                    }
+                });
+
+                let file = File::open(igvm_path.clone())
+                    .context("failed to open openhcl firmware file")?
+                    .into();
+                LoadMode::Igvm {
+                    file,
+                    cmdline: cmdline.unwrap_or_default(),
+                    vtl2_base_address,
                     com_serial: Some(SerialInformation {
                         io_port: ComPort::Com3.io_port(),
                         irq: ComPort::Com3.irq().into(),

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

@@ -6,6 +6,7 @@
 use crate::x86_64::storage::new_test_vtl2_nvme_device;
 use guid::Guid;
 use hvlite_defs::config::Vtl2BaseAddressType;
+use petri::MemoryConfig;
 use petri::OpenHclServicingFlags;
 use petri::PetriVmBuilder;
 use petri::ResolvedArtifact;
@@ -206,30 +207,12 @@ async fn openhcl_linux_vtl2_ram_self_allocate(
     let vtl2_ram_size = 1024 * 1024 * 1024; // 1GB
     let vm_ram_size = 6 * 1024 * 1024 * 1024; // 6GB
     let (mut vm, agent) = config
-        .modify_backend(move |b| {
-            b.with_custom_config(|cfg| {
-                if let hvlite_defs::config::LoadMode::Igvm {
-                    ref mut vtl2_base_address,
-                    ..
-                } = cfg.load_mode
-                {
-                    *vtl2_base_address = Vtl2BaseAddressType::Vtl2Allocate {
-                        size: Some(vtl2_ram_size),
-                    }
-                } else {
-                    panic!("unexpected load mode, must be igvm");
-                }
-
-                // Disable late map vtl0 memory when vtl2 allocation mode is used.
-                cfg.hypervisor
-                    .with_vtl2
-                    .as_mut()
-                    .unwrap()
-                    .late_map_vtl0_memory = None;
-
-                // Set overall VM ram.
-                cfg.memory.mem_size = vm_ram_size;
-            })
+        .with_memory(MemoryConfig {
+            startup_bytes: vm_ram_size,
+            ..Default::default()
+        })
+        .with_vtl2_base_address_type(Vtl2BaseAddressType::Vtl2Allocate {
+            size: Some(vtl2_ram_size),
         })
         .run()
         .await?;

vmm_tests/vmm_tests/tests/tests/x86_64/openhcl_uefi.rs

@@ -38,9 +38,12 @@ async fn nvme_relay_test_core(
         .with_openhcl_command_line(openhcl_cmdline)
         .with_vmbus_redirect(true)
         .with_processor_topology(ProcessorTopology {
-            vp_count: 1,
+            vp_count: 4, // Ideally, with 16GB RAM to match D4v5
             ..Default::default()
         })
+        .with_vtl2_base_address_type(hvlite_defs::config::Vtl2BaseAddressType::Vtl2Allocate {
+            size: Some(512 * 1024 * 1024), // 512MB to be more than what is defined in the dev manifest json
+        })
         .run()
         .await?;