Struct devices::platform::vfio_platform::VfioPlatformDevice

pub struct VfioPlatformDevice {
    device: Arc<VfioDevice>,
    interrupt_edge_evt: Vec<IrqEdgeEvent>,
    interrupt_level_evt: Vec<IrqLevelEvent>,
    mmio_regions: Vec<MmioInfo>,
    vm_memory_client: VmMemoryClient,
    mem: Vec<MemoryMapping>,
}

Fields

device: Arc<VfioDevice>

interrupt_edge_evt: Vec<IrqEdgeEvent>

interrupt_level_evt: Vec<IrqLevelEvent>

mmio_regions: Vec<MmioInfo>

vm_memory_client: VmMemoryClient

mem: Vec<MemoryMapping>

Implementations

impl VfioPlatformDevice

pub fn new(device: VfioDevice, vm_memory_client: VmMemoryClient) -> Self

Constructs a new Vfio Platform device for the given Vfio device

pub fn get_platform_irqs(&self) -> Result<Vec<VfioIrq>, VfioError>

pub fn irq_is_automask(&self, irq: &VfioIrq) -> bool

fn setup_irq_resample(&mut self, resample_evt: &Event, index: u32) -> Result<()>

pub fn assign_edge_platform_irq( &mut self, irq_evt: &IrqEdgeEvent, index: u32, ) -> Result<()>

pub fn assign_level_platform_irq( &mut self, irq_evt: &IrqLevelEvent, index: u32, ) -> Result<()>

fn find_region(&self, addr: u64) -> Option<MmioInfo>

pub fn allocate_regions( &mut self, resources: &mut SystemAllocator, ) -> Result<Vec<(u64, u64)>, Error>

fn region_mmap_early(&self, vm: &mut impl Vm, index: usize, start_addr: u64)

pub fn regions_mmap_early(&mut self, vm: &mut impl Vm)

Force adding the MMIO regions to the guest memory space.

By default, MMIO regions are mapped lazily when the guest first accesses them. Instead, this function maps them, even if the guest might end up not accessing them. It only runs in the current thread and can therefore be called before the VM is started.

fn region_mmap(&self, index: usize, start_addr: u64) -> Vec<MemoryMapping>

fn regions_mmap(&mut self)

fn disable_irqs(&mut self, index: u32)

fn read_mmio(&mut self, addr: u64, data: &mut [u8])

fn write_mmio(&mut self, addr: u64, data: &[u8])

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

pub fn device_file(&self) -> &File

Gets the vfio device backing File.

pub fn dt_symbol(&self) -> Option<&str>

Returns the DT symbol (node label) of the VFIO device.

pub fn iommu(&self) -> Option<(IommuDevType, Option<u32>, &[u32])>

Returns the type and indentifier (if applicable) of the IOMMU used by this VFIO device and its master IDs.

Trait Implementations

impl BusDevice for VfioPlatformDevice

fn device_id(&self) -> DeviceId

Returns a unique id per device type suitable for metrics gathering.

fn debug_label(&self) -> String

Returns a label suitable for debug output.

fn read(&mut self, info: BusAccessInfo, data: &mut [u8])

Reads at offset from this device

fn write(&mut self, info: BusAccessInfo, data: &[u8])

Writes at offset into this device

fn config_register_write( &mut self, reg_idx: usize, offset: u64, data: &[u8], ) -> ConfigWriteResult

Sets a register in the configuration space. Only used by PCI.

fn config_register_read(&self, reg_idx: usize) -> u32

Gets a register from the configuration space. Only used by PCI.

fn init_pci_config_mapping( &mut self, shmem: &SharedMemory, base: usize, len: usize, ) -> bool

Provides a memory region to back MMIO access to the configuration space. If the device can keep the memory region up to date, then it should return true, after which no more calls to config_register_read will be made. Otherwise the device should return false.

fn virtual_config_register_write(&mut self, reg_idx: usize, value: u32)

Sets a register in the virtual config space. Only used by PCI.

fn virtual_config_register_read(&self, reg_idx: usize) -> u32

Gets a register from the virtual config space. Only used by PCI.

fn on_sandboxed(&mut self)

Invoked when the device is sandboxed.

fn get_ranges(&self) -> Vec<(BusRange, BusType)>

Gets a list of all ranges registered by this BusDevice.

fn destroy_device(&mut self)

Invoked when the device is destroyed

fn is_bridge(&self) -> Option<u8>

Returns the secondary bus number if this bus device is pci bridge

impl BusDeviceObj for VfioPlatformDevice

fn as_platform_device(&self) -> Option<&VfioPlatformDevice>

fn as_platform_device_mut(&mut self) -> Option<&mut VfioPlatformDevice>

fn into_platform_device(self: Box<Self>) -> Option<Box<VfioPlatformDevice>>

fn as_pci_device(&self) -> Option<&dyn PciDevice>

fn as_pci_device_mut(&mut self) -> Option<&mut dyn PciDevice>

fn into_pci_device(self: Box<Self>) -> Option<Box<dyn PciDevice>>

impl Suspendable for VfioPlatformDevice

fn snapshot(&mut self) -> Result<AnySnapshot>

Save the device state in an image that can be restored.

fn restore(&mut self, _data: AnySnapshot) -> Result<()>

Load a saved snapshot of an image.

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

Stop all threads related to the device. Sleep should be idempotent.

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

Create/Resume all threads related to the device. Wake should be idempotent.