Struct ProcessorRunner

pub struct ProcessorRunner<'a, T: Backing<'a>> { /* private fields */ }

Object used to run and to access state for a specific VP.

Implementations

impl ProcessorRunner<'_, MshvArm64>

pub fn cpu_context(&self) -> &hcl_cpu_context_aarch64

Returns a reference to the current VTL’s CPU context.

pub fn cpu_context_mut(&mut self) -> &mut hcl_cpu_context_aarch64

Returns a mutable reference to the current VTL’s CPU context.

impl<'a> ProcessorRunner<'a, Snp<'a>>

pub fn vmsa(&self, vtl: GuestVtl) -> VmsaWrapper<'_, &SevVmsa>

Gets a reference to the VMSA and backing state of a VTL

pub fn vmsa_mut(&mut self, vtl: GuestVtl) -> VmsaWrapper<'_, &mut SevVmsa>

Gets a mutable reference to the VMSA and backing state of a VTL.

pub fn vmsas_mut(&mut self) -> [VmsaWrapper<'_, &mut SevVmsa>; 2]

Returns the VMSAs for [VTL0, VTL1].

impl<'a> ProcessorRunner<'a, Tdx<'a>>

pub fn tdx_enter_guest_gps(&self) -> &[u64; 16]

Gets a reference to the TDX enter guest state’s GP list.

pub fn tdx_enter_guest_gps_mut(&mut self) -> &mut [u64; 16]

Gets a mutable reference to the TDX enter guest state’s GP list.

pub fn tdx_vp_enter_exit_info(&self) -> &tdx_tdg_vp_enter_exit_info

Gets a reference to the tdx exit info from a VP.ENTER call.

pub fn tdx_apic_page(&self, vtl: GuestVtl) -> &ApicPage

Gets a reference to the tdx APIC page for the given VTL.

pub fn tdx_apic_page_mut(&mut self, vtl: GuestVtl) -> &mut ApicPage

Gets a mutable reference to the tdx APIC page for the given VTL.

pub fn cr2(&self) -> u64

Gets the value of CR2 from the shared kernel state.

pub fn set_cr2(&mut self, value: u64)

Gets the value of CR2 from the shared kernel state.

pub fn tdx_vp_state_flags_mut(&mut self) -> &mut tdx_vp_state_flags

Gets a mutable reference to TDX specific VP flags.

pub fn read_private_regs(&self, regs: &mut TdxPrivateRegs)

Reads the private registers from the kernel’s shared run page into the given TdxPrivateRegs.

pub fn write_private_regs(&mut self, regs: &TdxPrivateRegs)

Writes the private registers from the given TdxPrivateRegs to the kernel’s shared run page.

pub fn write_vmcs64( &mut self, vtl: GuestVtl, field: VmcsField, mask: u64, value: u64, ) -> u64

Write a 64-bit VMCS field.

Only updates the bits that are set in mask. Returns the old value of the field.

Panics if the field is not a 64-bit field, or if there is an error in the TDX module when writing the field.

pub fn read_vmcs64(&self, vtl: GuestVtl, field: VmcsField) -> u64

Reads a 64-bit VMCS field.

Panics if the field is not a 64-bit field, or if there is an error in the TDX module when reading the field.

pub fn write_vmcs32( &mut self, vtl: GuestVtl, field: VmcsField, mask: u32, value: u32, ) -> u32

Write a 32-bit VMCS field.

Only updates the bits that are set in mask. Returns the old value of the field.

Panics if the field is not a 32-bit field, or if there is an error in the TDX module when writing the field.

pub fn read_vmcs32(&self, vtl: GuestVtl, field: VmcsField) -> u32

Reads a 32-bit VMCS field.

Panics if the field is not a 32-bit field, or if there is an error in the TDX module when reading the field.

pub fn write_vmcs16( &mut self, vtl: GuestVtl, field: VmcsField, mask: u16, value: u16, ) -> u16

Write a 16-bit VMCS field.

Only updates the bits that are set in mask. Returns the old value of the field.

Panics if the field is not a 16-bit field, or if there is an error in the TDX module when writing the field.

pub fn read_vmcs16(&self, vtl: GuestVtl, field: VmcsField) -> u16

Reads a 16-bit VMCS field.

Panics if the field is not a 16-bit field, or if there is an error in the TDX module when reading the field.

pub fn write_msr_bitmap( &self, vtl: GuestVtl, i: u32, mask: u64, word: u64, ) -> u64

Writes 64-bit word with index i of the MSR bitmap.

Only updates the bits that are set in mask. Returns the old value of the word.

Panics if there is an error in the TDX module when writing the word.

pub fn set_l2_ctls( &self, vtl: GuestVtl, value: TdxL2Ctls, ) -> Result<TdxL2Ctls, TdCallResult>

Sets the L2_CTLS field of the VP.

Returns the old value of the field.

pub fn invgla( &self, gla_flags: TdGlaVmAndFlags, gla_info: TdxGlaListInfo, ) -> Result<(), TdCallResult>

Issues an INVGLA instruction for the VP.

pub fn fx_state(&self) -> &Fxsave

Gets the FPU state for the VP.

pub fn fx_state_mut(&mut self) -> &mut Fxsave

Sets the FPU state for the VP.

impl<'a> ProcessorRunner<'a, MshvX64<'a>>

pub fn reg_page_vtl(&self) -> Result<GuestVtl, RegisterPageVtlError>

Returns the last VTL according to the register page.

pub fn cpu_context(&self) -> &hcl_cpu_context_x64

Returns a reference to the current VTL’s CPU context.

pub fn cpu_context_mut(&mut self) -> &mut hcl_cpu_context_x64

Returns a mutable reference to the current VTL’s CPU context.

pub fn translate_gva_to_gpa( &mut self, gva: u64, control_flags: TranslateGvaControlFlagsX64, ) -> Result<Result<TranslateResult, TranslateErrorX64>, TranslateGvaToGpaError>

Translate the following gva to a gpa page in the context of the current VP.

The caller must ensure control_flags.input_vtl() is set to a specific VTL.

impl<'a, T: Backing<'a>> ProcessorRunner<'a, T>

pub fn flush_deferred_state(&mut self)

Flushes any deferred state. Must be called if preparing the partition for save/restore (servicing).

impl<'a, T: Backing<'a>> ProcessorRunner<'a, T>

pub fn clear_cancel(&mut self)

Clears the cancel flag so that the VP can be run again.

pub fn set_halted(&mut self, halted: bool)

Set the halted state of the VP. If true, then run() will not actually run the VP but will just wait for a cancel request or signal.

pub fn proxy_irr_vtl0(&mut self) -> Option<[u32; 8]>

Gets the proxied interrupt request bitmap for VTL 0 from the hypervisor.

pub fn update_proxy_irr_filter_vtl0(&mut self, irr_filter: &[u32; 8])

Update the proxy_irr_blocked for VTL 0 in the run page

pub fn proxy_irr_exit_mut_vtl0(&mut self) -> &mut [u32; 8]

Gets the proxy_irr_exit bitmask for VTL 0. This mask ensures that the masked interrupts always exit to user-space, and cannot be injected in the kernel. Interrupts matching this condition will be left on the proxy_irr field.

pub fn offload_flags_mut(&mut self) -> &mut hcl_intr_offload_flags

Gets the current offload_flags from the run page.

pub fn run_sidecar(&mut self) -> Result<SidecarRun<'_, 'a>, Error>

Runs the VP via the sidecar kernel.

pub fn run(&mut self) -> Result<bool, Error>

Run the following VP until an exit, error, or interrupt (cancel or signal) occurs.

Returns Ok(true) if there is an exit to process, Ok(false) if there was a signal or cancel request.

pub fn enter_mode(&mut self) -> Option<&mut EnterModes>

Gets a reference to enter mode value, used by the kernel to specify the mode used when entering a lower VTL.

pub fn exit_message(&self) -> &HvMessage

Returns a reference to the exit message from the last exit.

pub fn is_sidecar(&self) -> bool

Returns whether this is a sidecar VP.

impl<'a, T: Backing<'a>> ProcessorRunner<'a, T>

pub fn get_vp_register( &mut self, vtl: GuestVtl, name: HvX64RegisterName, ) -> Result<HvRegisterValue, Error>

Get the following register on the current VP.

This will fail for registers that are in the mmapped CPU context, i.e. registers that are shared between VTL0 and VTL2.

pub fn get_vp_registers( &mut self, vtl: GuestVtl, names: &[HvX64RegisterName], values: &mut [HvRegisterValue], ) -> Result<(), Error>

Get the following VP registers on the current VP.

Panics

Panics if names.len() != values.len().

pub fn set_vp_register( &mut self, vtl: GuestVtl, name: HvX64RegisterName, value: HvRegisterValue, ) -> Result<(), Error>

Set the following register on the current VP.

This will fail for registers that are in the mmapped CPU context, i.e. registers that are shared between VTL0 and VTL2.

pub fn set_vp_registers<I>( &mut self, vtl: GuestVtl, values: I, ) -> Result<(), Error>

where I: IntoIterator, I::Item: Into<HvRegisterAssoc> + Clone,

Sets a set of VP registers.

pub fn set_vp_registers_hvcall<I>( &mut self, vtl: Vtl, values: I, ) -> Result<(), HvError>

where I: IntoIterator, I::Item: Into<HvRegisterAssoc> + Clone,

Sets the following registers on the current VP and given VTL using a direct hypercall.

This should not be used on the fast path. Therefore only a select set of registers are supported, and others will cause a panic.

This function can be used with VTL2 as a target.

pub fn set_exit_vtl(&mut self, vtl: GuestVtl)

Sets the VTL that should be returned to when underhill exits

Trait Implementations

impl<'a, T: Backing<'a>> Drop for ProcessorRunner<'a, T>

fn drop(&mut self)

Executes the destructor for this type.