Struct PetriVmOpenVmm

pub struct PetriVmOpenVmm { /* private fields */ }

A running VM that tests can interact with.

Implementations

impl PetriVmOpenVmm

pub fn vtl2_vsock_path(&self) -> Result<&Path>

Get the path to the VTL 2 vsock socket, if the VM is configured with OpenHCL.

pub async fn wait_for_boot_event(&mut self) -> Result<FirmwareEvent>

Waits for an event emitted by the firmware about its boot status, and returns that status.

pub async fn wait_for_enlightened_shutdown_ready( &mut self, ) -> Result<OneshotReceiver<()>>

Waits for the Hyper-V shutdown IC to be ready, returning a receiver that will be closed when it is no longer ready.

pub async fn send_enlightened_shutdown( &mut self, kind: ShutdownKind, ) -> Result<()>

Instruct the guest to shutdown via the Hyper-V shutdown IC.

pub async fn wait_for_kvp(&mut self) -> Result<Sender<KvpRpc>>

Waits for the KVP IC to be ready, returning a sender that can be used to send requests to it.

pub async fn save_openhcl( &mut self, new_openhcl: &ResolvedArtifact, flags: OpenHclServicingFlags, ) -> Result<()>

Stages the new OpenHCL file and saves the existing state.

pub async fn restore_openhcl(&mut self) -> Result<()>

Restores OpenHCL from a previously saved state.

pub async fn reset(&mut self) -> Result<()>

Resets the hardware state of the VM, simulating a power cycle.

pub async fn wait_for_agent( &mut self, set_high_vtl: bool, ) -> Result<PipetteClient>

Wait for a connection from a pipette agent

pub async fn modify_vtl2_settings( &mut self, f: impl FnOnce(&mut Vtl2Settings), ) -> Result<()>

Modifies OpenHCL VTL2 settings.

pub async fn wait_for_halt_or<T, F: Future<Output = Result<T>>>( &mut self, future: F, ) -> Result<T>

Wrap the provided future in a race with the worker process’s halt notification channel. This is useful for preventing a future from waiting indefinitely if the VM dies for any reason. If the worker process crashes the halt notification channel will return an error, and if the VM halts for any other reason the future will complete with that reason.

Trait Implementations

impl PetriVmRuntime for PetriVmOpenVmm

type VmInspector = OpenVmmInspector

Interface for inspecting the VM

type VmFramebufferAccess = OpenVmmFramebufferAccess

Interface for accessing the framebuffer

fn teardown<'async_trait>( self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait,

Cleanly tear down the VM immediately.

fn wait_for_halt<'life0, 'async_trait>( &'life0 mut self, allow_reset: bool, ) -> Pin<Box<dyn Future<Output = Result<PetriHaltReason>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Wait for the VM to halt, returning the reason for the halt. The VM should automatically restart the VM on reset if allow_reset is true.

fn wait_for_agent<'life0, 'async_trait>( &'life0 mut self, set_high_vtl: bool, ) -> Pin<Box<dyn Future<Output = Result<PipetteClient>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Wait for a connection from a pipette agent

fn openhcl_diag(&self) -> Option<OpenHclDiagHandler>

Get an OpenHCL diagnostics handler for the VM

fn wait_for_boot_event<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<FirmwareEvent>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Waits for an event emitted by the firmware about its boot status, and returns that status.

fn wait_for_enlightened_shutdown_ready<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Waits for the Hyper-V shutdown IC to be ready

fn send_enlightened_shutdown<'life0, 'async_trait>( &'life0 mut self, kind: ShutdownKind, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Instruct the guest to shutdown via the Hyper-V shutdown IC.

fn restart_openhcl<'life0, 'life1, 'async_trait>( &'life0 mut self, new_openhcl: &'life1 ResolvedArtifact, flags: OpenHclServicingFlags, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Instruct the OpenHCL to restart the VTL2 paravisor. Will fail if the VM is not running OpenHCL. Will also fail if the VM is not running.

fn save_openhcl<'life0, 'life1, 'async_trait>( &'life0 mut self, new_openhcl: &'life1 ResolvedArtifact, flags: OpenHclServicingFlags, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Instruct the OpenHCL to save the state of the VTL2 paravisor. Will fail if the VM is not running OpenHCL. Will also fail if the VM is not running or if this is called twice in succession without a call to restore_openhcl.

fn restore_openhcl<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Instruct the OpenHCL to restore the state of the VTL2 paravisor. Will fail if the VM is not running OpenHCL. Will also fail if the VM is running or if this is called without prior save.

fn inspector(&self) -> Option<OpenVmmInspector>

If the backend supports it, get an inspect interface

fn take_framebuffer_access(&mut self) -> Option<OpenVmmFramebufferAccess>

If the backend supports it, take the screenshot interface (subsequent calls may return None).

fn reset<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Issue a hard reset to the VM

fn get_guest_state_file<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Option<PathBuf>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get the path to the VM’s guest state file