Struct PetriVmConfigOpenVmm

pub struct PetriVmConfigOpenVmm { /* private fields */ }

Configuration state for a test VM.

Implementations

impl PetriVmConfigOpenVmm

pub fn new( params: &PetriTestParams<'_>, artifacts: PetriVmArtifactsOpenVmm, driver: &DefaultDriver, ) -> Result<Self>

Create a new VM configuration.

impl PetriVmConfigOpenVmm

pub fn with_vmbus_redirect(self) -> Self

Enable VMBus redirection.

pub fn with_vtl0_alias_map(self) -> Self

Enable the VTL0 alias map.

pub fn with_tpm(self) -> Self

Enable the TPM with ephemeral storage.

pub fn with_processor_topology(self, topology: ProcessorTopology) -> Self

Set the VM to use the specified number of virtual processors.

Using 1 CPU is useful for heavier OpenHCL tests, as our WHP emulation layer is rather slow when dealing with cross-cpu communication.

pub fn with_secure_boot(self) -> Self

Set the VM to enable secure boot and inject the templates per OS flavor.

pub fn with_windows_secure_boot_template(self) -> Self

Inject Windows secure boot templates into the VM’s UEFI.

pub fn with_uefi_ca_secure_boot_template(self) -> Self

Inject UEFI CA secure boot templates into the VM’s UEFI.

pub fn with_battery(self) -> Self

Enable the battery for the VM.

pub fn with_tpm_state_persistence(self) -> Self

Enable TPM state persistence

pub fn with_igvm_attest_test_config(self, config: IgvmAttestTestConfig) -> Self

Set test config for the GED’s IGVM attest request handler

pub fn with_nic(self) -> Self

Enable a synthnic for the VM.

Uses a mana emulator and the paravisor if a paravisor is present.

pub fn with_uefi_frontpage(self, enable_frontpage: bool) -> Self

Specifies whether the UEFI frontpage app is enabled.

If it is disabled, then the VM will shutdown if there are no configured boot apps.

pub fn with_default_boot_always_attempt(self, val: bool) -> Self

Specifies whether the UEFI will always attempt a default boot

pub fn with_vmgs<T: IsTestVmgs>(self, vmgs: PetriVmgsResource<T>) -> Self

Specifies an existing VMGS file to use

pub fn with_openhcl_command_line(self, additional_cmdline: &str) -> Self

Add custom command line arguments to OpenHCL.

pub fn with_confidential_filtering(self) -> Self

Enable confidential filtering, even if the VM is not confidential.

pub fn with_custom_openhcl(self, artifact: ResolvedArtifact) -> Self

Load a custom OpenHCL firmware file.

pub fn with_custom_vtl2_settings( self, f: impl FnOnce(&mut Vtl2Settings), ) -> Self

Add custom VTL 2 settings.

pub fn with_vtl2_relocation_mode(self, mode: Vtl2BaseAddressType) -> Self

Load with the specified VTL2 relocation mode.

pub fn with_custom_config(self, f: impl FnOnce(&mut Config)) -> Self

This is intended for special one-off use cases. As soon as something is needed in multiple tests we should consider making it a supported pattern.

pub fn with_agent_file(self, name: &str, artifact: ResolvedArtifact) -> Self

Adds a file to the agent image.

pub fn with_openhcl_agent_file( self, name: &str, artifact: ResolvedArtifact, ) -> Self

Adds a file to the OpenHCL agent image.

pub fn with_allow_early_vtl0_access(self, allow: bool) -> Self

Specifies whether VTL2 should be allowed to access VTL0 memory before it sets any VTL protections.

This is needed just for the TMK VMM, and only until it gains support for setting VTL protections.

impl PetriVmConfigOpenVmm

pub async fn run_without_agent(self) -> Result<PetriVmOpenVmm>

Build and boot the requested VM. Does not configure and start pipette. Should only be used for testing platforms that pipette does not support.

pub async fn run(self) -> Result<(PetriVmOpenVmm, PipetteClient)>

Run the VM, launching pipette and returning a client to it.

pub async fn run_with_lazy_pipette(self) -> Result<PetriVmOpenVmm>

Run the VM, configuring pipette to automatically start, but do not wait for it to connect. This is useful for tests where the first boot attempt is expected to not succeed, but pipette functionality is still desired.

impl PetriVmConfigOpenVmm

pub fn os_flavor(&self) -> OsFlavor

Get the OS that the VM will boot into.

Trait Implementations

impl PetriVmConfig for PetriVmConfigOpenVmm

fn run_without_agent<'async_trait>( self: Box<Self>, ) -> Pin<Box<dyn Future<Output = Result<Box<dyn PetriVm>>> + Send + 'async_trait>>

where Self: 'async_trait,

Build and boot the requested VM. Does not configure and start pipette. Should only be used for testing platforms that pipette does not support.

fn run_with_lazy_pipette<'async_trait>( self: Box<Self>, ) -> Pin<Box<dyn Future<Output = Result<Box<dyn PetriVm>>> + Send + 'async_trait>>

where Self: 'async_trait,

Run the VM, configuring pipette to automatically start, but do not wait for it to connect. This is useful for tests where the first boot attempt is expected to not succeed, but pipette functionality is still desired.

fn run<'async_trait>( self: Box<Self>, ) -> Pin<Box<dyn Future<Output = Result<(Box<dyn PetriVm>, PipetteClient)>> + Send + 'async_trait>>

where Self: 'async_trait,

Run the VM, launching pipette and returning a client to it.

fn with_secure_boot(self: Box<Self>) -> Box<dyn PetriVmConfig>

Set the VM to enable secure boot and inject the templates per OS flavor.

fn with_windows_secure_boot_template(self: Box<Self>) -> Box<dyn PetriVmConfig>

Inject Windows secure boot templates into the VM’s UEFI.

fn with_uefi_ca_secure_boot_template(self: Box<Self>) -> Box<dyn PetriVmConfig>

Inject UEFI CA secure boot templates into the VM’s UEFI.

fn with_processor_topology( self: Box<Self>, topology: ProcessorTopology, ) -> Box<dyn PetriVmConfig>

Set the VM to use the specified processor topology.

fn with_custom_openhcl( self: Box<Self>, artifact: ResolvedArtifact, ) -> Box<dyn PetriVmConfig>

Sets a custom OpenHCL IGVM file to use.

fn with_openhcl_command_line( self: Box<Self>, command_line: &str, ) -> Box<dyn PetriVmConfig>

Sets the command line for the paravisor.

fn with_agent_file( self: Box<Self>, name: &str, artifact: ResolvedArtifact, ) -> Box<dyn PetriVmConfig>

Adds a file to the VM’s pipette agent image.

fn with_openhcl_agent_file( self: Box<Self>, name: &str, artifact: ResolvedArtifact, ) -> Box<dyn PetriVmConfig>

Adds a file to the paravisor’s pipette agent image.

fn with_uefi_frontpage(self: Box<Self>, enable: bool) -> Box<dyn PetriVmConfig>

Sets whether UEFI frontpage is enabled.

fn with_vmbus_redirect(self: Box<Self>, _: bool) -> Box<dyn PetriVmConfig>

Run the VM with Enable VMBus relay enabled

fn os_flavor(&self) -> OsFlavor

Get the OS that the VM will boot into.