Struct KvmVcpu 

pub struct KvmVcpu {
    pub index: u8,
    pub fd: VcpuFd,
    pub peripherals: Peripherals,
    /* private fields */
}

A wrapper around creating and using a kvm x86_64 vcpu.

Fields

index: u8

Index of vcpu.

fd: VcpuFd

KVM vcpu fd.

peripherals: Peripherals

Vcpu peripherals, such as buses

Implementations

impl KvmVcpu

pub fn new(index: u8, vm: &Vm) -> Result<Self, KvmVcpuError>

Constructs a new kvm vcpu with arch specific functionality.

Arguments

• index - Represents the 0-based CPU index between [0, max vcpus).
• vm - The vm to which this vcpu will get attached.

pub fn configure( &mut self, guest_mem: &GuestMemoryMmap, kernel_entry_point: EntryPoint, vcpu_config: &VcpuConfig, ) -> Result<(), KvmVcpuConfigureError>

Configures a x86_64 specific vcpu for booting Linux and should be called once per vcpu.

Arguments

• guest_mem - The guest memory used by this microvm.
• kernel_entry_point - Specifies the boot protocol and offset from guest_mem at which the kernel starts.
• vcpu_config - The vCPU configuration.
• cpuid - The capabilities exposed by this vCPU.

pub fn set_pio_bus(&mut self, pio_bus: Arc<Bus>)

Sets a Port Mapped IO bus for this vcpu.

pub fn kvmclock_ctrl(&self)

Calls KVM_KVMCLOCK_CTRL to avoid guest soft lockup watchdog panics on resume. See https://docs.kernel.org/virt/kvm/api.html .

pub fn get_tsc_khz(&self) -> Result<u32, GetTscError>

Get the current TSC frequency for this vCPU.

Errors

When [kvm_ioctls::VcpuFd::get_tsc_khz] errors.

pub fn get_msr_chunk( &self, msr_index_iter: impl Iterator<Item = u32>, chunk_size: usize, ) -> Result<Msrs, KvmVcpuError>

Get single MSR chunk for the given MSR index iterator with specified length. Iterator should have enough elements to fill the chunk with indices, otherwise KVM will return an error when processing half filled chunk.

Arguments

• msr_index_iter: Iterator over MSR indices.
• chunk_size: Length of a chunk.

Errors

• When [kvm_bindings::Msrs::new] returns errors.
• When [kvm_ioctls::VcpuFd::get_msrs] returns errors.
• When the return value of [kvm_ioctls::VcpuFd::get_msrs] (the number of entries that could be gotten) is less than expected.

pub fn get_msrs( &self, msr_index_iter: impl ExactSizeIterator<Item = u32>, ) -> Result<BTreeMap<u32, u64>, KvmVcpuError>

Get MSRs for the given MSR index list.

Arguments

• msr_index_list: List of MSR indices

Errors

• When KvmVcpu::get_msr_chunks() returns errors.

pub fn save_state(&self) -> Result<VcpuState, KvmVcpuError>

Save the KVM internal state.

pub fn dump_cpu_config(&self) -> Result<CpuConfiguration, KvmVcpuError>

Dumps CPU configuration (CPUID and MSRs).

Opposed to save_state(), this dumps all the supported and dumpable MSRs not limited to serializable ones.

pub fn is_tsc_scaling_required( &self, state_tsc_freq: u32, ) -> Result<bool, GetTscError>

Checks whether the TSC needs scaling when restoring a snapshot.

Errors

When

pub fn set_tsc_khz(&self, tsc_freq: u32) -> Result<(), SetTscError>

Scale the TSC frequency of this vCPU to the one provided as a parameter.

pub fn restore_state(&self, state: &VcpuState) -> Result<(), KvmVcpuError>

Use provided state to populate KVM internal state.

Trait Implementations

impl Debug for KvmVcpu

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.