Kernel/PCI: Hold a reference to DeviceIdentifier in the Device class

There are now 2 separate classes for almost the same object type:
- EnumerableDeviceIdentifier, which is used in the enumeration code for
  all PCI host controller classes. This is allowed to be moved and
  copied, as it doesn't support ref-counting.
- DeviceIdentifier, which inherits from EnumerableDeviceIdentifier. This
  class uses ref-counting, and is not allowed to be copied. It has a
  spinlock member in its structure to allow safely executing complicated
  IO sequences on a PCI device and its space configuration.
  There's a static method that allows a quick conversion from
  EnumerableDeviceIdentifier to DeviceIdentifier while creating a
  NonnullRefPtr out of it.

The reason for doing this is for the sake of integrity and reliablity of
the system in 2 places:
- Ensure that "complicated" tasks that rely on manipulating PCI device
  registers are done in a safe manner. For example, determining a PCI
  BAR space size requires multiple read and writes to the same register,
  and if another CPU tries to do something else with our selected
  register, then the result will be a catastrophe.
- Allow the PCI API to have a united form around a shared object which
  actually holds much more data than the PCI::Address structure. This is
  fundamental if we want to do certain types of optimizations, and be
  able to support more features of the PCI bus in the foreseeable
  future.

This patch already has several implications:
- All PCI::Device(s) hold a reference to a DeviceIdentifier structure
  being given originally from the PCI::Access singleton. This means that
  all instances of DeviceIdentifier structures are located in one place,
  and all references are pointing to that location. This ensures that
  locking the operation spinlock will take effect in all the appropriate
  places.
- We no longer support adding PCI host controllers and then immediately
  allow for enumerating it with a lambda function. It was found that
  this method is extremely broken and too much complicated to work
  reliably with the new paradigm being introduced in this patch. This
  means that for Volume Management Devices (Intel VMD devices), we
  simply first enumerate the PCI bus for such devices in the storage
  code, and if we find a device, we attach it in the PCI::Access method
  which will scan for devices behind that bridge and will add new
  DeviceIdentifier(s) objects to its internal Vector. Afterwards, we
  just continue as usual with scanning for actual storage controllers,
  so we will find a corresponding NVMe controllers if there were any
  behind that VMD bridge.

1 files changed, 66 insertions, 35 deletions

diff --git a/Kernel/Bus/PCI/Definitions.h b/Kernel/Bus/PCI/Definitions.h
index 9a2437ed18..9dec250a8d 100644
--- a/Kernel/Bus/PCI/Definitions.h
+++ b/Kernel/Bus/PCI/Definitions.h
@@ -12,6 +12,7 @@
 #include <AK/Types.h>
 #include <AK/Vector.h>
 #include <Kernel/Debug.h>
+#include <Kernel/Locking/Spinlock.h>
 #include <Kernel/PhysicalAddress.h>
 
 namespace Kernel::PCI {
@@ -38,30 +39,31 @@ enum class BARSpaceType {
 };
 
 enum class RegisterOffset {
-    VENDOR_ID = 0x00,            // word
-    DEVICE_ID = 0x02,            // word
-    COMMAND = 0x04,              // word
-    STATUS = 0x06,               // word
-    REVISION_ID = 0x08,          // byte
-    PROG_IF = 0x09,              // byte
-    SUBCLASS = 0x0a,             // byte
-    CLASS = 0x0b,                // byte
-    CACHE_LINE_SIZE = 0x0c,      // byte
-    LATENCY_TIMER = 0x0d,        // byte
-    HEADER_TYPE = 0x0e,          // byte
-    BIST = 0x0f,                 // byte
-    BAR0 = 0x10,                 // u32
-    BAR1 = 0x14,                 // u32
-    BAR2 = 0x18,                 // u32
-    SECONDARY_BUS = 0x19,        // byte
-    BAR3 = 0x1C,                 // u32
-    BAR4 = 0x20,                 // u32
-    BAR5 = 0x24,                 // u32
-    SUBSYSTEM_VENDOR_ID = 0x2C,  // u16
-    SUBSYSTEM_ID = 0x2E,         // u16
-    CAPABILITIES_POINTER = 0x34, // u8
-    INTERRUPT_LINE = 0x3C,       // byte
-    INTERRUPT_PIN = 0x3D,        // byte
+    VENDOR_ID = 0x00,             // word
+    DEVICE_ID = 0x02,             // word
+    COMMAND = 0x04,               // word
+    STATUS = 0x06,                // word
+    REVISION_ID = 0x08,           // byte
+    PROG_IF = 0x09,               // byte
+    SUBCLASS = 0x0a,              // byte
+    CLASS = 0x0b,                 // byte
+    CACHE_LINE_SIZE = 0x0c,       // byte
+    LATENCY_TIMER = 0x0d,         // byte
+    HEADER_TYPE = 0x0e,           // byte
+    BIST = 0x0f,                  // byte
+    BAR0 = 0x10,                  // u32
+    BAR1 = 0x14,                  // u32
+    BAR2 = 0x18,                  // u32
+    SECONDARY_BUS = 0x19,         // byte
+    BAR3 = 0x1C,                  // u32
+    BAR4 = 0x20,                  // u32
+    BAR5 = 0x24,                  // u32
+    SUBSYSTEM_VENDOR_ID = 0x2C,   // u16
+    SUBSYSTEM_ID = 0x2E,          // u16
+    EXPANSION_ROM_POINTER = 0x30, // u32
+    CAPABILITIES_POINTER = 0x34,  // u8
+    INTERRUPT_LINE = 0x3C,        // byte
+    INTERRUPT_PIN = 0x3D,         // byte
 };
 
 enum class Limits {
@@ -213,7 +215,7 @@ private:
 
 class Capability {
 public:
-    Capability(Address const& address, u8 id, u8 ptr)
+    Capability(Address address, u8 id, u8 ptr)
         : m_address(address)
         , m_id(id)
         , m_ptr(ptr)
@@ -222,15 +224,12 @@ public:
 
     CapabilityID id() const { return m_id; }
 
-    u8 read8(u32) const;
-    u16 read16(u32) const;
-    u32 read32(u32) const;
-    void write8(u32, u8);
-    void write16(u32, u16);
-    void write32(u32, u32);
+    u8 read8(size_t offset) const;
+    u16 read16(size_t offset) const;
+    u32 read32(size_t offset) const;
 
 private:
-    Address m_address;
+    const Address m_address;
     const CapabilityID m_id;
     const u8 m_ptr;
 };
@@ -245,9 +244,9 @@ AK_TYPEDEF_DISTINCT_ORDERED_ID(u8, InterruptLine);
 AK_TYPEDEF_DISTINCT_ORDERED_ID(u8, InterruptPin);
 
 class Access;
-class DeviceIdentifier {
+class EnumerableDeviceIdentifier {
 public:
-    DeviceIdentifier(Address address, HardwareID hardware_id, RevisionID revision_id, ClassCode class_code, SubclassCode subclass_code, ProgrammingInterface prog_if, SubsystemID subsystem_id, SubsystemVendorID subsystem_vendor_id, InterruptLine interrupt_line, InterruptPin interrupt_pin, Vector<Capability> const& capabilities)
+    EnumerableDeviceIdentifier(Address address, HardwareID hardware_id, RevisionID revision_id, ClassCode class_code, SubclassCode subclass_code, ProgrammingInterface prog_if, SubsystemID subsystem_id, SubsystemVendorID subsystem_vendor_id, InterruptLine interrupt_line, InterruptPin interrupt_pin, Vector<Capability> const& capabilities)
         : m_address(address)
         , m_hardware_id(hardware_id)
         , m_revision_id(revision_id)
@@ -289,7 +288,7 @@ public:
         m_prog_if = new_progif;
     }
 
-private:
+protected:
     Address m_address;
     HardwareID m_hardware_id;
 
@@ -306,6 +305,38 @@ private:
     Vector<Capability> m_capabilities;
 };
 
+class DeviceIdentifier
+    : public RefCounted<DeviceIdentifier>
+    , public EnumerableDeviceIdentifier {
+    AK_MAKE_NONCOPYABLE(DeviceIdentifier);
+
+public:
+    static ErrorOr<NonnullRefPtr<DeviceIdentifier>> from_enumerable_identifier(EnumerableDeviceIdentifier const& other_identifier);
+
+    Spinlock<LockRank::None>& operation_lock() { return m_operation_lock; }
+    Spinlock<LockRank::None>& operation_lock() const { return m_operation_lock; }
+
+    virtual ~DeviceIdentifier() = default;
+
+private:
+    DeviceIdentifier(EnumerableDeviceIdentifier const& other_identifier)
+        : EnumerableDeviceIdentifier(other_identifier.address(),
+            other_identifier.hardware_id(),
+            other_identifier.revision_id(),
+            other_identifier.class_code(),
+            other_identifier.subclass_code(),
+            other_identifier.prog_if(),
+            other_identifier.subsystem_id(),
+            other_identifier.subsystem_vendor_id(),
+            other_identifier.interrupt_line(),
+            other_identifier.interrupt_pin(),
+            other_identifier.capabilities())
+    {
+    }
+
+    mutable Spinlock<LockRank::None> m_operation_lock;
+};
+
 class Domain;
 class Device;