Struct devices::virtio::vhost_user_frontend::VhostUserFrontend

pub struct VhostUserFrontend {
    device_type: DeviceType,
    worker_thread: Option<WorkerThread<Option<FrontendServer<BackendReqHandlerImpl>>>>,
    backend_client: BackendClient,
    avail_features: u64,
    acked_features: u64,
    protocol_features: VhostUserProtocolFeatures,
    backend_req_handler: Option<FrontendServer<BackendReqHandlerImpl>>,
    shmem_region: RefCell<Option<Option<SharedMemoryRegion>>>,
    queue_sizes: Vec<u16>,
    cfg: Option<Vec<u8>>,
    expose_shmem_descriptors_with_viommu: bool,
    pci_address: Option<PciAddress>,
}

Fields

device_type: DeviceType

worker_thread: Option<WorkerThread<Option<FrontendServer<BackendReqHandlerImpl>>>>

backend_client: BackendClient

avail_features: u64

acked_features: u64

protocol_features: VhostUserProtocolFeatures

backend_req_handler: Option<FrontendServer<BackendReqHandlerImpl>>

shmem_region: RefCell<Option<Option<SharedMemoryRegion>>>

queue_sizes: Vec<u16>

cfg: Option<Vec<u8>>

expose_shmem_descriptors_with_viommu: bool

pci_address: Option<PciAddress>

Implementations

impl VhostUserFrontend

pub fn new_fs( base_features: u64, connection: SystemStream, max_queue_size: Option<u16>, tag: Option<&str> ) -> Result<VhostUserFrontend, Error>

impl VhostUserFrontend

pub fn new( device_type: DeviceType, base_features: u64, connection: SystemStream, max_queue_size: Option<u16>, pci_address: Option<PciAddress> ) -> Result<VhostUserFrontend, Error>

Create a new VirtioDevice for a vhost-user device frontend.

Arguments

• device_type: virtio device type
• base_features: base virtio device features (e.g. VIRTIO_F_VERSION_1)
• connection: connection to the device backend
• max_queue_size: maximum number of entries in each queue (default: Queue::MAX_SIZE)

pub(crate) fn new_internal( connection: SystemStream, device_type: DeviceType, max_queue_size: Option<u16>, base_features: u64, cfg: Option<&[u8]>, pci_address: Option<PciAddress> ) -> Result<VhostUserFrontend, Error>

Create a new VirtioDevice for a vhost-user device frontend.

Arguments

• connection: connection to the device backend
• device_type: virtio device type
• max_queue_size: maximum number of entries in each queue (default: Queue::MAX_SIZE)
• base_features: base virtio device features (e.g. VIRTIO_F_VERSION_1)
• cfg: bytes to return for the virtio configuration space (queried from device if not specified)

fn set_mem_table(&mut self, mem: &GuestMemory) -> Result<(), Error>

fn activate_vring( &mut self, mem: &GuestMemory, queue_index: usize, queue: &Queue, irqfd: &Event ) -> Result<(), Error>

Activates a vring for the given queue.

fn start_worker(&mut self, interrupt: Interrupt, non_msix_evt: Event)

Helper to start up the worker thread that will be used with handling interrupts and requests from the device process.

Trait Implementations

impl VirtioDevice for VhostUserFrontend

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 features(&self) -> u64

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

fn ack_features(&mut self, features: u64)

Acknowledges that this set of features should be enabled.

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 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 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 get_shared_memory_region(&self) -> Option<SharedMemoryRegion>

Returns the device’s shared memory region if present.

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 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 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 is_vhost_user(&self) -> bool

Returns true if the device uses the vhost user protocol.

fn vhost_user_restore( &mut self, data: Value, queue_configs: &[QueueConfig], queue_evts: Option<Vec<Event>>, interrupt: Option<Interrupt>, mem: GuestMemory, msix_config: &Arc<Mutex<MsixConfig>>, device_activated: bool ) -> Result<()>

Vhost user device specific restore to be called instead of virtio_restore. This will rewire irqfds, queue_evts, start up the worker if needed, and send a RESTORE request 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 transport_type(&self) -> VirtioTransportType

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

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 bootorder_fw_cfg(&self, _pci_address: u8) -> Option<(Vec<u8>, usize)>