Struct crosvm::crosvm::sys::linux::pci_hotplug_manager::PciHotPlugManager

pub struct PciHotPlugManager {
    port_pool: PortPool,
    occupied_ports: HashMap<u8, PortStub>,
    jail_warden: Box<dyn JailWarden>,
    rootbus_controller: Option<Sender<PciRootCommand>>,
}

PciHotPlugManager manages hotplug ports, and handles PCI device hot plug and hot removal.

Fields

port_pool: PortPool

map of empty ports available.

empty ports are sorted such to ensure the ordering of the hotplugged devices. Specifically, if multiple devices are hotplugged before PCI enumeration, they will appear in the guest OS in the same order hotplug_device is called.

occupied_ports: HashMap<u8, PortStub>

map of occupied ports, indexed by downstream bus number

jail_warden: Box<dyn JailWarden>

JailWarden for jailing hotplug devices

rootbus_controller: Option<Sender<PciRootCommand>>

control channel to root bus

Implementations

impl PciHotPlugManager

pub fn new( guest_memory: GuestMemory, config: &Config, swap_device_helper: Option<SwapDeviceHelper> ) -> Result<Self, Error>

Constructs PciHotPlugManager.

Constructor uses forking, therefore has to be called early, before crosvm enters a multi-threaded context.

pub fn set_rootbus_controller( &mut self, rootbus_controller: Sender<PciRootCommand> ) -> Result<(), Error>

Starts PciHotPlugManager. Required before any other commands.

PciHotPlugManager::new must be called in a single-threaded context as it forks. However, rootbus_controller is only available after VM boots when crosvm is multi-threaded.

TODO(293801301): Remove unused after aarch64 support

pub fn add_port( &mut self, port: Arc<Mutex<dyn HotPlugBus>> ) -> Result<(), Error>

Adds a hotplug capable port to manage.

PciHotPlugManager assumes exclusive control for adding and removing devices to this port. TODO(293801301): Remove unused_variables after aarch64 support

pub fn hotplug_device<V: VmArch, Vcpu: VcpuArch>( &mut self, resource_carriers: Vec<ResourceCarrier>, linux: &mut RunnableLinuxVm<V, Vcpu>, resources: &mut SystemAllocator ) -> Result<u8, Error>

hotplugs up to 8 PCI devices as “functions of a device” (in PCI Bus Device Function sense).

returns the bus number of the bus on success.

pub fn remove_hotplug_device<V: VmArch, Vcpu: VcpuArch>( &mut self, bus: u8, linux: &mut RunnableLinuxVm<V, Vcpu>, resources: &mut SystemAllocator ) -> Result<(), Error>

Removes all hotplugged devices on the hotplug bus.

fn remove_device_from_port(&self, bus: u8) -> Result<Receiver<()>, Error>

Sends eject signal on the port, and removes downstream devices on the port.