Struct VmResources 

pub struct VmResources {

    pub machine_config: MachineConfig,
    pub boot_source: BootSource,
    pub block: BlockBuilder,
    pub vsock: VsockBuilder,
    pub balloon: BalloonBuilder,
    pub net_builder: NetBuilder,
    pub entropy: EntropyDeviceBuilder,
    pub pmem: PmemBuilder,
    pub memory_hotplug: Option<MemoryHotplugConfig>,
    pub mmds: Option<Arc<Mutex<Mmds>>>,
    pub mmds_size_limit: usize,
    pub boot_timer: bool,
    pub pci_enabled: bool,
    pub serial_out_path: Option<PathBuf>,
}

A data structure that encapsulates the device configurations held in the Vmm.

Fields

machine_config: MachineConfig

The vCpu and memory configuration for this microVM.

boot_source: BootSource

The boot source spec (contains both config and builder) for this microVM.

block: BlockBuilder

The block devices.

vsock: VsockBuilder

The vsock device.

balloon: BalloonBuilder

The balloon device.

net_builder: NetBuilder

The network devices builder.

entropy: EntropyDeviceBuilder

The entropy device builder.

pmem: PmemBuilder

The pmem devices.

memory_hotplug: Option<MemoryHotplugConfig>

The memory hotplug configuration.

mmds: Option<Arc<Mutex<Mmds>>>

The optional Mmds data store.

mmds_size_limit: usize

Data store limit for the mmds.

boot_timer: bool

Whether or not to load boot timer device.

pci_enabled: bool

Whether or not to use PCIe transport for VirtIO devices.

serial_out_path: Option<PathBuf>

Where serial console output should be written to

Implementations

impl VmResources

pub fn from_json( config_json: &str, instance_info: &InstanceInfo, mmds_size_limit: usize, metadata_json: Option<&str>, ) -> Result<Self, ResourcesError>

Configures Vmm resources as described by the config_json param.

pub fn mmds_or_default(&mut self) -> Result<&Arc<Mutex<Mmds>>, MmdsConfigError>

If not initialised, create the mmds data store with the default config.

pub fn locked_mmds_or_default( &mut self, ) -> Result<MutexGuard<'_, Mmds>, MmdsConfigError>

If not initialised, create the mmds data store with the default config.

pub fn set_custom_cpu_template(&mut self, cpu_template: CustomCpuTemplate)

Add a custom CPU template to the VM resources to configure vCPUs.

pub fn update_machine_config( &mut self, update: &MachineConfigUpdate, ) -> Result<(), MachineConfigError>

Updates the configuration of the microVM.

pub fn set_balloon_device( &mut self, config: BalloonDeviceConfig, ) -> Result<(), BalloonConfigError>

Sets a balloon device to be attached when the VM starts.

pub fn build_boot_source( &mut self, boot_source_cfg: BootSourceConfig, ) -> Result<(), BootSourceConfigError>

Obtains the boot source hooks (kernel fd, command line creation and validation).

pub fn set_block_device( &mut self, block_device_config: BlockDeviceConfig, ) -> Result<(), DriveError>

Inserts a block to be attached when the VM starts.

pub fn build_net_device( &mut self, body: NetworkInterfaceConfig, ) -> Result<(), NetworkInterfaceError>

Builds a network device to be attached when the VM starts.

pub fn set_vsock_device( &mut self, config: VsockDeviceConfig, ) -> Result<(), VsockConfigError>

Sets a vsock device to be attached when the VM starts.

pub fn build_entropy_device( &mut self, body: EntropyDeviceConfig, ) -> Result<(), EntropyDeviceError>

Builds an entropy device to be attached when the VM starts.

pub fn build_pmem_device( &mut self, body: PmemConfig, ) -> Result<(), PmemConfigError>

Builds a pmem device to be attached when the VM starts.

pub fn set_memory_hotplug_config( &mut self, config: MemoryHotplugConfig, ) -> Result<(), MemoryHotplugConfigError>

Sets the memory hotplug configuration.

pub fn set_mmds_config( &mut self, config: MmdsConfig, instance_id: &str, ) -> Result<(), MmdsConfigError>

Setter for mmds config.

pub fn set_mmds_basic_config( &mut self, version: MmdsVersion, imds_compat: bool, instance_id: &str, ) -> Result<(), MmdsConfigError>

Updates MMDS-related config other than MMDS network stack.

pub fn allocate_guest_memory(&self) -> Result<Vec<GuestRegionMmap>, MemoryError>

Allocates guest memory in a configuration most appropriate for these VmResources.

pub fn allocate_memory_region( &self, start: GuestAddress, size: usize, ) -> Result<GuestRegionMmap, MemoryError>

Allocates a single guest memory region.

Trait Implementations

impl Debug for VmResources

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

Formats the value using the given formatter.

impl Default for VmResources

fn default() -> VmResources

Returns the “default value” for a type.

impl From<&VmResources> for VmInfo

fn from(value: &VmResources) -> Self

Converts to this type from the input type.

impl From<&VmResources> for VmmConfig

fn from(resources: &VmResources) -> Self

Converts to this type from the input type.

impl From<MockVmResources> for VmResources

fn from(src: MockVmResources) -> VmResources

Converts to this type from the input type.