Struct rustcracker::components::machine::Machine

pub struct Machine { /* private fields */ }

Machine is process handler of rust side

Implementations

impl Machine

pub async fn start_vmm_test(&mut self) -> Result<(), MachineError>

impl Machine

functional methods

pub fn new( cfg: Config ) -> Result<(Machine, Sender<MachineMessage>), MachineError>

new initializes a new Machine instance and performs validation of the provided Config.

pub fn rebuild( core: MachineCore ) -> Result<(Machine, Sender<MachineMessage>), MachineError>

Rebuild Machine from raw metadata (MachineCore)

pub fn dump_into_core(&self) -> Result<MachineCore, MachineError>

pub async fn start(&mut self) -> Result<(), MachineError>

Start actually start a Firecracker microVM.

pub async fn wait(&mut self) -> Result<(), MachineError>

wait will wait until the firecracker process has finished, or has been forced to terminate.

pub async fn shutdown(&self) -> Result<(), MachineError>

shutdown requests a clean shutdown of the VM by sending CtrlAltDelete on the virtual keyboard

pub async fn pause(&self) -> Result<(), MachineError>

pause pauses the microVM

pub async fn resume(&self) -> Result<(), MachineError>

resume resumes the microVM from pausing

pub async fn stop_vmm(&mut self) -> Result<(), MachineError>

stop_vmm stops the current VMM by sending a SIGTERM

pub async fn stop_vmm_force(&mut self) -> Result<(), MachineError>

stop_vmm_force stops the current VMM by sending a SIGKILL

impl Machine

util methods

pub fn get_log_file(&self) -> Option<PathBuf>

pub fn set_command(&mut self, cmd: Command)

pub fn pid(&self) -> Result<u32, MachineError>

PID returns the machine’s running process PID or an error if not running

impl Machine

useful methods that could be exposed to users

pub async fn update_metadata( &self, metadata: &String ) -> Result<(), MachineError>

update_metadata patches the machine’s metadata for MDDS

pub async fn get_metadata(&self) -> Result<String, MachineError>

get_metadata gets the machine’s metadata from MDDS and unmarshals it into v

pub async fn update_guest_drive( &self, drive_id: String, path_on_host: PathBuf ) -> Result<(), MachineError>

update_guest_drive will modify the current guest drive of ID index with the new parameters of the partialDrive

pub async fn describe_instance_info(&self) -> Result<InstanceInfo, MachineError>

describe_instance_info gets the information of the microVM.

pub async fn create_snapshot( &self, mem_file_path: PathBuf, snapshot_path: PathBuf ) -> Result<(), MachineError>

create_snapshot creates a snapshot of the VM.

pub async fn get_balloon_config(&self) -> Result<Balloon, MachineError>

get_balloon_config gets the current balloon device configuration.

pub async fn update_balloon(&self, amount_mib: i64) -> Result<(), MachineError>

update_balloon will update an existing balloon device, before or after machine startup.

pub async fn get_balloon_stats(&self) -> Result<BalloonStatistics, MachineError>

get_balloon_stats gets the latest balloon device statistics, only if enabled pre-boot.

pub async fn update_balloon_stats( &self, stats_polling_interval_s: i64 ) -> Result<(), MachineError>

update_balloon_stats will update a balloon device statistics polling interval.

pub async fn update_guest_network_interface_rate_limit( &self, iface_id: String, rate_limiters: RateLimiterSet ) -> Result<(), MachineError>

update_guest_network_interface_rate_limit modifies the specified network interface’s rate limits

pub async fn refresh_machine_configuration( &mut self ) -> Result<(), MachineError>

refresh_machine_configuration synchronizes our cached representation of the machine configuration with that reported by the Firecracker API

pub async fn get_export_vm_config( &mut self ) -> Result<FullVmConfiguration, MachineError>

pub async fn get_firecracker_version( &mut self ) -> Result<FirecrackerVersion, MachineError>

pub async fn update_machine_configuration( &mut self, machine_config: &MachineConfiguration ) -> Result<(), MachineError>

pub async fn load_from_snapshot( &mut self, snapshot_load_params: &SnapshotLoadParams ) -> Result<(), MachineError>

Trait Implementations

impl Send for Machine

impl Sync for Machine