Struct Vmm 

pub struct Vmm {
    pub instance_info: InstanceInfo,
    pub vm: Arc<Vm>,
    pub vcpus_handles: Vec<VcpuHandle>,
    pub device_manager: DeviceManager,
    /* private fields */
}

Contains the state and associated methods required for the Firecracker VMM.

Fields

instance_info: InstanceInfo

The InstanceInfo state of this Vmm.

vm: Arc<Vm>

VM object

vcpus_handles: Vec<VcpuHandle>

Handles to the vcpu threads with vcpu_fds inside them.

device_manager: DeviceManager

Implementations

impl Vmm

pub fn version(&self) -> String

Gets Vmm version.

pub fn instance_info(&self) -> InstanceInfo

Gets Vmm instance info.

pub fn kvm(&self) -> &Kvm

Provides access to the underlying KVM handle.

pub fn shutdown_exit_code(&self) -> Option<FcExitCode>

Provides the Vmm shutdown exit code if there is one.

pub fn clear_shutdown_exit_code(&mut self)

Clears any shutdown exit code and returns the VM to a paused state.

pub fn start_vcpus( &mut self, vcpus: Vec<Vcpu>, vcpu_seccomp_filter: Arc<BpfProgram>, ) -> Result<(), StartVcpusError>

Starts the microVM vcpus.

Errors

When:

• [vmm::VmmEventsObserver::on_vmm_boot] errors.
• [vmm::vstate::vcpu::Vcpu::start_threaded] errors.

pub fn resume_vm(&mut self) -> Result<(), VmmError>

Sends a resume command to the vCPUs.

pub fn pause_vm(&mut self) -> Result<(), VmmError>

Sends a pause command to the vCPUs.

pub fn send_ctrl_alt_del(&mut self) -> Result<(), VmmError>

Injects CTRL+ALT+DEL keystroke combo in the i8042 device.

pub fn save_state( &mut self, vm_info: &VmInfo, ) -> Result<MicrovmState, MicrovmStateError>

Saves the state of a paused Microvm.

pub fn dump_cpu_config( &mut self, ) -> Result<Vec<CpuConfiguration>, DumpCpuConfigError>

Dumps CPU configuration.

pub fn update_block_device_path( &mut self, drive_id: &str, path_on_host: String, ) -> Result<(), VmmError>

Updates the path of the host file backing the emulated block device with id drive_id. We update the disk image on the device and its virtio configuration.

pub fn update_block_rate_limiter( &mut self, drive_id: &str, rl_bytes: BucketUpdate, rl_ops: BucketUpdate, ) -> Result<(), VmmError>

Updates the rate limiter parameters for block device with drive_id id.

pub fn update_vhost_user_block_config( &mut self, drive_id: &str, ) -> Result<(), VmmError>

Updates the rate limiter parameters for block device with drive_id id.

pub fn update_net_rate_limiters( &mut self, net_id: &str, rx_bytes: BucketUpdate, rx_ops: BucketUpdate, tx_bytes: BucketUpdate, tx_ops: BucketUpdate, ) -> Result<(), VmmError>

Updates the rate limiter parameters for net device with net_id id.

pub fn balloon_config(&self) -> Result<BalloonConfig, VmmError>

Returns a reference to the balloon device if present.

pub fn latest_balloon_stats(&self) -> Result<BalloonStats, VmmError>

Returns the latest balloon statistics if they are enabled.

pub fn update_balloon_config(&mut self, amount_mib: u32) -> Result<(), VmmError>

Updates configuration for the balloon device target size.

pub fn update_balloon_stats_config( &mut self, stats_polling_interval_s: u16, ) -> Result<(), VmmError>

Updates configuration for the balloon device as described in balloon_stats_update.

pub fn memory_hotplug_status(&self) -> Result<VirtioMemStatus, VmmError>

Returns the current state of the memory hotplug device.

pub fn update_memory_hotplug_size( &self, requested_size_mib: usize, ) -> Result<(), VmmError>

Returns the current state of the memory hotplug device.

pub fn start_balloon_hinting( &mut self, cmd: StartHintingCmd, ) -> Result<(), VmmError>

Starts the balloon free page hinting run

pub fn get_balloon_hinting_status(&mut self) -> Result<HintingStatus, VmmError>

Retrieves the status of the balloon hinting run

pub fn stop_balloon_hinting(&mut self) -> Result<(), VmmError>

Stops the balloon free page hinting run

pub fn stop(&mut self, exit_code: FcExitCode)

Signals Vmm to stop and exit.

Trait Implementations

impl Debug for Vmm

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

Formats the value using the given formatter.

impl Drop for Vmm

fn drop(&mut self)

Executes the destructor for this type.

impl MutEventSubscriber for Vmm

fn process(&mut self, event: Events, _: &mut EventOps<'_>)

Handle a read event (EPOLLIN).

fn init(&mut self, ops: &mut EventOps<'_>)

Initialization called by the EventManager when the subscriber is registered.