refactor Interface

Author: IgnoreWarnings

common/include/villas/kernel/devices/device.hpp

@@ -11,43 +11,12 @@
 #include <filesystem>
 #include <optional>
 #include <villas/kernel/devices/driver.hpp>
-#include <villas/kernel/devices/utils.hpp>
 
 class Device {
-private:
-  static constexpr char PROBE_DEFAULT[] = "/sys/bus/platform/drivers_probe";
-  static constexpr char OVERRIDE_DEFAULT[] = "driver_override";
-
-public:
-  const std::filesystem::path path;
-  const std::filesystem::path probe_path;
-  const std::filesystem::path override_path;
-
 public:
-  Device(const std::filesystem::path path)
-      : Device(path, std::filesystem::path(PROBE_DEFAULT),
-               path / std::filesystem::path(OVERRIDE_DEFAULT)){};
-  Device(const std::filesystem::path path,
-         const std::filesystem::path probe_path,
-         const std::filesystem::path override_path)
-      : path(path), probe_path(probe_path), override_path(override_path){};
-
-  std::string name() const {
-    size_t pos = path.u8string().rfind('/');
-    return path.u8string().substr(pos + 1);
-  }
-
-  std::optional<Driver> driver() const {
-    std::filesystem::path driver_symlink =
-        this->path / std::filesystem::path("driver");
-
-    if (!std::filesystem::is_symlink(driver_symlink))
-      return std::nullopt;
-
-    std::filesystem::path driver_path =
-        std::filesystem::canonical(driver_symlink);
-    return Driver(driver_path);
-  };
-
-  void probe() const { write_to_file(this->name(), this->probe_path); };
+  virtual std::string name() const = 0;
+  virtual std::optional<Driver> driver() const = 0;
+  virtual int iommu_group() const = 0;
+  virtual void probe() const = 0;
+  virtual std::filesystem::path get_override_path() const = 0;
 };

common/include/villas/kernel/devices/ip_device.hpp

@@ -9,18 +9,18 @@
 #pragma once
 
 #include <filesystem>
-#include <villas/kernel/devices/device.hpp>
+#include <villas/kernel/devices/platform_device.hpp>
 
-class IpDevice : public Device {
+class IpDevice : public PlatformDevice {
+public:
 public:
   static IpDevice from(const std::filesystem::path unsafe_path);
   static bool is_path_valid(const std::filesystem::path unsafe_path);
 
 private:
-  IpDevice(const std::filesystem::path valid_path) : Device(valid_path){};
+  IpDevice(const std::filesystem::path valid_path) : PlatformDevice(path){};
 
 public:
   std::string ip_name() const;
   size_t addr() const;
-  int iommu_group() const;
 };

common/include/villas/kernel/devices/platform_device.hpp

@@ -0,0 +1,72 @@
+/* Platform Device
+ *
+ * Author: Pascal Bauer <pascal.bauer@rwth-aachen.de>
+ *
+ * SPDX-FileCopyrightText: 2023-2024 Pascal Bauer <pascal.bauer@rwth-aachen.de>
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#pragma once
+
+#include <filesystem>
+#include <villas/kernel/devices/device.hpp>
+#include <villas/kernel/devices/utils.hpp>
+
+class PlatformDevice : public Device {
+private:
+  static constexpr char PROBE_DEFAULT[] = "/sys/bus/platform/drivers_probe";
+  static constexpr char OVERRIDE_DEFAULT[] = "driver_override";
+
+public:
+  const std::filesystem::path path;
+  const std::filesystem::path probe_path;
+  const std::filesystem::path override_path;
+
+public:
+  PlatformDevice(const std::filesystem::path path)
+      : PlatformDevice(path, std::filesystem::path(PROBE_DEFAULT),
+                       path / std::filesystem::path(OVERRIDE_DEFAULT)){};
+  PlatformDevice(const std::filesystem::path path,
+                 const std::filesystem::path probe_path,
+                 const std::filesystem::path override_path)
+      : path(path), probe_path(probe_path), override_path(override_path){};
+
+  std::string name() const override {
+    size_t pos = path.u8string().rfind('/');
+    return path.u8string().substr(pos + 1);
+  }
+
+  std::optional<Driver> driver() const override {
+    std::filesystem::path driver_symlink =
+        this->path / std::filesystem::path("driver");
+
+    if (!std::filesystem::is_symlink(driver_symlink))
+      return std::nullopt;
+
+    std::filesystem::path driver_path =
+        std::filesystem::canonical(driver_symlink);
+    return Driver(driver_path);
+  };
+
+  int iommu_group() const override {
+    std::filesystem::path symlink =
+        std::filesystem::path(this->path.u8string() + "/iommu_group");
+
+    std::filesystem::path link;
+    link = std::filesystem::read_symlink(symlink);
+
+    std::string delimiter = "iommu_groups/";
+    int pos = link.u8string().find(delimiter);
+    int iommu_group =
+        std::stoi(link.u8string().substr(pos + delimiter.length()));
+    return iommu_group;
+  }
+
+  void probe() const override {
+    write_to_file(this->name(), this->probe_path);
+  };
+
+  virtual std::filesystem::path get_override_path() const override {
+    return this->override_path;
+  };
+};

common/lib/kernel/devices/driver.cpp

@@ -23,7 +23,7 @@ void Driver::unbind(const Device &device) const {
 };
 
 void Driver::override(const Device &device) const {
-  write_to_file(this->name(), device.override_path);
+  write_to_file(this->name(), device.get_override_path());
 };
 
 void Driver::attach(const Device &device) const {

common/lib/kernel/devices/ip_device.cpp

@@ -51,16 +51,3 @@ size_t IpDevice::addr() const {
 
   return addr;
 }
-
-int IpDevice::iommu_group() const {
-  std::filesystem::path symlink =
-      std::filesystem::path(this->path.u8string() + "/iommu_group");
-
-  std::filesystem::path link;
-  link = std::filesystem::read_symlink(symlink);
-
-  std::string delimiter = "iommu_groups/";
-  int pos = link.u8string().find(delimiter);
-  int iommu_group = std::stoi(link.u8string().substr(pos + delimiter.length()));
-  return iommu_group;
-}