pci, vmm: Extend PciDevice trait to support BAR relocation

By adding a new method id() to the PciDevice trait, we allow the caller
to retrieve a unique identifier. This is used in the context of BAR
relocation to identify the device being relocated, so that we can update
the DeviceTree resources for all PCI devices (and not only
VirtioPciDevice).

Signed-off-by: Sebastien Boeuf <sebastien.boeuf@intel.com>

pci/src/bus.rs

@@ -88,6 +88,10 @@ impl PciDevice for PciRoot {
     fn as_any(&mut self) -> &mut dyn Any {
         self
     }
+
+    fn id(&self) -> Option<String> {
+        None
+    }
 }
 
 pub struct PciBus {

pci/src/device.rs

@@ -110,6 +110,9 @@ pub trait PciDevice: BusDevice {
     /// Provides a mutable reference to the Any trait. This is useful to let
     /// the caller have access to the underlying type behind the trait.
     fn as_any(&mut self) -> &mut dyn Any;
+
+    /// Optionally returns a unique identifier.
+    fn id(&self) -> Option<String>;
 }
 
 /// This trait defines a set of functions which can be triggered whenever a

pci/src/vfio.rs

@@ -976,6 +976,7 @@ impl VfioCommon {
 /// The VMM creates a VfioDevice, then assigns it to a VfioPciDevice,
 /// which then gets added to the PCI bus.
 pub struct VfioPciDevice {
+    id: String,
     vm: Arc<dyn hypervisor::Vm>,
     device: Arc<VfioDevice>,
     container: Arc<VfioContainer>,
@@ -986,7 +987,9 @@ pub struct VfioPciDevice {
 
 impl VfioPciDevice {
     /// Constructs a new Vfio Pci device for the given Vfio device
+    #[allow(clippy::too_many_arguments)]
     pub fn new(
+        id: String,
         vm: &Arc<dyn hypervisor::Vm>,
         device: VfioDevice,
         container: Arc<VfioContainer>,
@@ -1027,6 +1030,7 @@ impl VfioPciDevice {
         common.initialize_legacy_interrupt(legacy_interrupt_group, &vfio_wrapper)?;
 
         let vfio_pci_device = VfioPciDevice {
+            id,
             vm: vm.clone(),
             device,
             container,
@@ -1438,4 +1442,8 @@ impl PciDevice for VfioPciDevice {
     fn as_any(&mut self) -> &mut dyn Any {
         self
     }
+
+    fn id(&self) -> Option<String> {
+        Some(self.id.clone())
+    }
 }

pci/src/vfio_user.rs

@@ -30,6 +30,7 @@ use vm_memory::{
 use vmm_sys_util::eventfd::EventFd;
 
 pub struct VfioUserPciDevice {
+    id: String,
     vm: Arc<dyn hypervisor::Vm>,
     client: Arc<Mutex<Client>>,
     vfio_wrapper: VfioUserClientWrapper,
@@ -63,6 +64,7 @@ impl PciSubclass for PciVfioUserSubclass {
 
 impl VfioUserPciDevice {
     pub fn new(
+        id: String,
         vm: &Arc<dyn hypervisor::Vm>,
         client: Arc<Mutex<Client>>,
         msi_interrupt_manager: &Arc<dyn InterruptManager<GroupConfig = MsiIrqGroupConfig>>,
@@ -111,6 +113,7 @@ impl VfioUserPciDevice {
             .map_err(VfioUserPciDeviceError::InitializeLegacyInterrupts)?;
 
         Ok(Self {
+            id,
             vm: vm.clone(),
             client,
             vfio_wrapper,
@@ -486,6 +489,10 @@ impl PciDevice for VfioUserPciDevice {
 
         Ok(())
     }
+
+    fn id(&self) -> Option<String> {
+        Some(self.id.clone())
+    }
 }
 
 impl Drop for VfioUserPciDevice {