Struct devices::virtio::Balloon

pub struct Balloon {
    command_tube: Option<Tube>,
    release_memory_tube: Option<Tube>,
    pending_adjusted_response_event: Event,
    state: Arc<RwLock<BalloonState>>,
    features: u64,
    acked_features: u64,
    worker_thread: Option<WorkerThread<WorkerReturn>>,
    registered_evt_q: Option<SendTube>,
    ws_num_bins: u8,
    target_reached_evt: Option<Event>,
}

Virtio device for memory balloon inflation/deflation.

Fields

command_tube: Option<Tube>

release_memory_tube: Option<Tube>

pending_adjusted_response_event: Event

state: Arc<RwLock<BalloonState>>

features: u64

acked_features: u64

worker_thread: Option<WorkerThread<WorkerReturn>>

registered_evt_q: Option<SendTube>

ws_num_bins: u8

target_reached_evt: Option<Event>

Implementations

impl Balloon

pub fn new( base_features: u64, command_tube: Tube, release_memory_tube: Option<Tube>, init_balloon_size: u64, enabled_features: u64, registered_evt_q: Option<SendTube>, ws_num_bins: u8 ) -> Result<Balloon, BalloonError>

Creates a new virtio balloon device. To let Balloon able to successfully release the memory which are pinned by CoIOMMU to host, the release_memory_tube will be used to send the inflate ranges to CoIOMMU with UnpinRequest/UnpinResponse messages, so that The memory in the inflate range can be unpinned first.

fn get_config(&self) -> virtio_balloon_config

fn stop_worker(&mut self) -> StoppedWorker<PausedQueues>

fn get_queues_from_map( &self, queues: BTreeMap<usize, Queue> ) -> Result<BalloonQueues>

Given a filtered queue vector from VirtioDevice::activate, extract the queues (accounting for queues that are missing because the features are not negotiated) into a structure that is easier to work with.

fn start_worker( &mut self, mem: GuestMemory, interrupt: Interrupt, queues: BalloonQueues ) -> Result<()>

Trait Implementations

impl VirtioDevice for Balloon

fn keep_rds(&self) -> Vec<RawDescriptor>

A vector of device-specific file descriptors that must be kept open after jailing. Must be called before the process is jailed.

fn device_type(&self) -> DeviceType

The virtio device type.

fn queue_max_sizes(&self) -> &[u16]

The maximum size of each queue that this device supports.

fn read_config(&self, offset: u64, data: &mut [u8])

Reads this device configuration space at offset.

fn write_config(&mut self, offset: u64, data: &[u8])

Writes to this device configuration space at offset.

fn features(&self) -> u64

The set of feature bits that this device supports in addition to the base features.

fn ack_features(&mut self, value: u64)

Acknowledges that this set of features should be enabled.

fn activate( &mut self, mem: GuestMemory, interrupt: Interrupt, queues: BTreeMap<usize, Queue> ) -> Result<()>

Activates this device for real usage.

fn reset(&mut self) -> Result<()>

Optionally deactivates this device. If the reset method is not able to reset the virtio device, or the virtio device model doesn’t implement the reset method, an Err value is returned to indicate the reset is not successful. Otherwise Ok(()) should be returned.

fn virtio_sleep(&mut self) -> Result<Option<BTreeMap<usize, Queue>>>

Pause all processing.

fn virtio_wake( &mut self, queues_state: Option<(GuestMemory, Interrupt, BTreeMap<usize, Queue>)> ) -> Result<()>

Resume all processing.

fn virtio_snapshot(&mut self) -> Result<Value>

Snapshot current state. Device must be asleep.

fn virtio_restore(&mut self, data: Value) -> Result<()>

Restore device state from a snapshot. TODO(b/280607404): Vhost user will need fds passed to the device process.

fn debug_label(&self) -> String

Returns a label suitable for debug output.

fn num_interrupts(&self) -> usize

The number of interrupts used by this device.

fn get_device_bars(&mut self, _address: PciAddress) -> Vec<PciBarConfiguration>

Returns any additional BAR configuration required by the device.

fn get_device_caps(&self) -> Vec<Box<dyn PciCapability>>

Returns any additional capabiltiies required by the device.

fn on_device_sandboxed(&mut self)

Invoked when the device is sandboxed.

fn control_notify(&self, _behavior: MsixStatus)

fn generate_acpi( &mut self, _pci_address: &Option<PciAddress>, sdts: Vec<SDT> ) -> Option<Vec<SDT>>

fn read_bar(&mut self, _bar_index: PciBarIndex, _offset: u64, _data: &mut [u8])

Reads from a BAR region mapped in to the device.

fn write_bar(&mut self, _bar_index: PciBarIndex, _offset: u64, _data: &[u8])

Writes to a BAR region mapped in to the device.

fn pci_address(&self) -> Option<PciAddress>

Returns the PCI address where the device will be allocated. Returns None if any address is good for the device.

fn transport_type(&self) -> VirtioTransportType

Returns the Virtio transport type: PCI (default for crosvm) or MMIO.

fn get_shared_memory_region(&self) -> Option<SharedMemoryRegion>

Returns the device’s shared memory region if present.

fn expose_shmem_descriptors_with_viommu(&self) -> bool

If true, VFIO passthrough devices can access descriptors mapped into this region by mapping the corresponding addresses from this device’s PCI bar into their IO address space with virtio-iommu.

fn set_shared_memory_mapper(&mut self, _mapper: Box<dyn SharedMemoryMapper>)

Provides the trait object used to map files into the device’s shared memory region.

fn set_shared_memory_region_base(&mut self, _addr: GuestAddress)

Provides the base address of the shared memory region, if one is present. Will be called before activate.

fn get_shared_memory_prepare_type(&mut self) -> SharedMemoryPrepareType

Queries the implementation whether a single prepared hypervisor memory mapping with explicit caching type should be setup lazily on first mapping request, or whether to dynamically setup a hypervisor mapping with every request’s caching type.

fn bootorder_fw_cfg(&self, _pci_address: u8) -> Option<(Vec<u8>, usize)>