Introduce clang-tidy

.clang-tidy

@@ -0,0 +1,9 @@
+# SPDX-FileCopyrightText: 2025 Institute for Automation of Complex Power Systems, RWTH Aachen University
+# SPDX-License-Identifier: Apache-2.0
+
+Checks: >
+  -*,
+  modernize-use-override,
+WarningsAsErrors: '*'
+HeaderFilterRegex: villas/.*
+FormatStyle: file

CMakeLists.txt

@@ -52,7 +52,14 @@ include(FindSymbol)
 include(CMakeDependentOption)
 
 add_definitions(-D_POSIX_C_SOURCE=200809L -D_GNU_SOURCE)
-add_compile_options(-Wall -Wno-unknown-pragmas -fdiagnostics-color=auto)
+add_compile_options(
+    -Wall
+    -Wno-unknown-pragmas
+    -Wno-unknown-warning-option
+    -Wno-vla-cxx-extension
+    -Wno-unused-command-line-argument
+    -fdiagnostics-color=auto
+)
 
 # Check OS
 check_include_file("sys/eventfd.h" HAS_EVENTFD)

clients/shmem/villas-shmem.cpp

@@ -34,7 +34,7 @@ class Shmem : public Tool {
 protected:
   std::atomic<bool> stop;
 
-  void usage() {
+  void usage() override {
     std::cout
         << "Usage: villas-test-shmem WNAME VECTORIZE" << std::endl
         << "  WNAME     name of the shared memory object for the output queue"
@@ -47,9 +47,9 @@ class Shmem : public Tool {
     printCopyright();
   }
 
-  void handler(int, siginfo_t *, void *) { stop = true; }
+  void handler(int, siginfo_t *, void *) override { stop = true; }
 
-  int main() {
+  int main() override {
     int ret, readcnt, writecnt, avail;
 
     struct ShmemInterface shm;

common/include/villas/cpuset.hpp

@@ -80,7 +80,9 @@ class CpuSet {
     return full ^ *this;
   }
 
-  bool operator==(const CpuSet &rhs) { return CPU_EQUAL_S(sz, setp, rhs.setp); }
+  friend bool operator==(const CpuSet &lhs, const CpuSet &rhs) {
+    return CPU_EQUAL_S(lhs.sz, lhs.setp, rhs.setp);
+  }
 
   CpuSet &operator&=(const CpuSet &rhs) {
     CPU_AND_S(sz, setp, setp, rhs.setp);

common/include/villas/dsp/window_cosine.hpp

@@ -27,7 +27,7 @@ class CosineWindow : public Window<T> {
 
   T correctionFactor;
 
-  virtual T filter(T in, size_type i) const { return in * coefficients[i]; }
+  T filter(T in, size_type i) const override { return in * coefficients[i]; }
 
 public:
   CosineWindow(double a0, double a1, double a2, double a3, double a4,

common/include/villas/exceptions.hpp

@@ -90,7 +90,7 @@ class ConfigError : public std::runtime_error {
   }
 
 public:
-  ~ConfigError() {
+  ~ConfigError() override {
     if (msg)
       free(msg);
   }

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

@@ -1,4 +1,4 @@
-/* Interface for device drivers. OS/platform independend.
+/* Interface for device drivers. OS/platform independent.
  * Implemented for Linux/Unix drivers in linux_driver.hpp
  *
  * Author: Pascal Bauer <pascal.bauer@rwth-aachen.de>
@@ -24,6 +24,7 @@ class Driver {
   virtual std::string name() const = 0;
   virtual void override(const Device &device) const = 0;
   virtual void unbind(const Device &device) const = 0;
+  virtual ~Driver() = default;
 };
 
 } // namespace devices

common/include/villas/kernel/vfio_device.hpp

@@ -98,9 +98,6 @@ class Device {
   std::vector<struct vfio_region_info> regions;
   std::vector<void *> mappings;
 
-  // libpci handle of the device
-  const kernel::devices::PciDevice *pci_device;
-
   Logger log;
 };
 

common/include/villas/memory.hpp

@@ -135,8 +135,9 @@ template <typename DerivedAllocator> class BaseAllocator {
     derivedAlloc = nullptr;
   }
 
-  virtual std::unique_ptr<MemoryBlock, MemoryBlock::deallocator_fn>
+  virtual ~BaseAllocator() = default;
 
+  virtual std::unique_ptr<MemoryBlock, MemoryBlock::deallocator_fn>
   allocateBlock(size_t size) = 0;
 
   template <typename T> MemoryAccessor<T> allocate(size_t num) {
@@ -217,8 +218,8 @@ class LinearAllocator : public BaseAllocator<LinearAllocator> {
 
   std::string getName() const;
 
-  virtual std::unique_ptr<MemoryBlock, MemoryBlock::deallocator_fn>
-  allocateBlock(size_t size);
+  std::unique_ptr<MemoryBlock, MemoryBlock::deallocator_fn>
+  allocateBlock(size_t size) override;
 
 private:
   static constexpr size_t alignBytes = sizeof(uintptr_t);
@@ -247,7 +248,7 @@ class HostRam {
     std::string getName() const { return "HostRamAlloc"; }
 
     std::unique_ptr<MemoryBlock, MemoryBlock::deallocator_fn>
-    allocateBlock(size_t size);
+    allocateBlock(size_t size) override;
   };
 
   static HostRamAllocator &getAllocator() {
@@ -264,7 +265,7 @@ class HostDmaRam {
   public:
     HostDmaRamAllocator(int num);
 
-    virtual ~HostDmaRamAllocator();
+    ~HostDmaRamAllocator() override;
 
     std::string getName() const { return getUdmaBufName(num); }
 

common/include/villas/popen.hpp

@@ -70,6 +70,11 @@ class PopenStream : public Popen {
   void open();
   int close();
 
+  template <typename T>
+  friend std::istream &operator>>(villas::utils::PopenStream &po, T &value) {
+    return *(po.input.stream) >> value;
+  }
+
 protected:
   struct {
     std::unique_ptr<std::istream> stream;
@@ -84,8 +89,3 @@ class PopenStream : public Popen {
 
 } // namespace utils
 } // namespace villas
-
-template <typename T>
-std::istream &operator>>(villas::utils::PopenStream &po, T &value) {
-  return *(po.input.stream) >> value;
-}

common/lib/kernel/vfio_device.cpp

@@ -55,7 +55,7 @@ static const char *vfio_pci_irq_names[] = {
 Device::Device(const std::string &name, int groupFileDescriptor,
                const kernel::devices::PciDevice *pci_device)
     : name(name), fd(-1), attachedToGroup(false), groupFd(groupFileDescriptor),
-      info(), info_irq_vectors(), regions(), mappings(), pci_device(pci_device),
+      info(), info_irq_vectors(), regions(), mappings(),
       log(Log::get("kernel:vfio:device")) {
   if (groupFileDescriptor < 0)
     throw RuntimeError("Invalid group file descriptor");
@@ -254,7 +254,7 @@ bool Device::pciEnable() {
 std::vector<Device::IrqVectorInfo> Device::initEventFds() {
   std::vector<Device::IrqVectorInfo> vectors;
   for (auto info_irq_vector : info_irq_vectors) {
-    Device::IrqVectorInfo irq = {0};
+    Device::IrqVectorInfo irq = {.eventFds = {0}};
     const size_t irqCount = info_irq_vector.count;
     const size_t irqSetSize =
         sizeof(struct vfio_irq_set) + sizeof(int) * irqCount;
@@ -296,7 +296,7 @@ std::vector<Device::IrqVectorInfo> Device::initEventFds() {
   return vectors;
 }
 
-int Device::pciMsiInit(int efds[]) {
+int Device::pciMsiInit(int efds[32]) {
   // Check if this is really a vfio-pci device
   if (not isVfioPciDevice())
     return -1;
@@ -341,7 +341,7 @@ int Device::pciMsiInit(int efds[]) {
   return irqCount;
 }
 
-int Device::pciMsiDeinit(int efds[]) {
+int Device::pciMsiDeinit(int efds[32]) {
   Log::get("Device")->debug("Deinitializing MSI interrupts for device {}",
                             name);
   // Check if this is really a vfio-pci device
@@ -381,7 +381,7 @@ int Device::pciMsiDeinit(int efds[]) {
   return irqCount;
 }
 
-bool Device::pciMsiFind(int nos[]) {
+bool Device::pciMsiFind(int nos[32]) {
   int ret, idx, irq;
   char *end, *col, *last, line[1024], name[13];
   FILE *f;

common/tests/unit/utils.cpp

@@ -86,7 +86,7 @@ Test(utils, cpuset) {
   cset4.clear(6);
   cr_assert_not(cset4[6]);
 
-  cr_assert_str_eq(static_cast<std::string>(cset4).c_str(), "1-5");
+  cr_assert_eq(static_cast<std::string>(cset4), "1-5");
 
   cr_assert_any_throw(CpuSet cset5("0-"));
 

flake.nix

@@ -81,6 +81,10 @@
           withAllNodes = true;
         };
 
+        villas-node-clang = pkgs.villas-node.override {
+          stdenv = pkgs.clangStdenv;
+        };
+
         dockerImage = pkgs.dockerTools.buildLayeredImage {
           name = "villas-node";
           tag = "latest-nix";
@@ -89,7 +93,6 @@
         };
 
         # Cross-compiled packages
-
         villas-node-x86_64-linux =
           if pkgs.system == "x86_64-linux" then pkgs.villas-node else pkgs.pkgsCross.x86_64-linux.villas-node;
         villas-node-aarch64-linux =
@@ -144,7 +147,7 @@
         system:
         let
           pkgs = devPkgsFor system;
-          hardeningDisable = [ "all" ];
+
           packages = with pkgs; [
             bashInteractive
             bc
@@ -161,19 +164,35 @@
             pre-commit
             ruby # for pre-commit markdownlint hook
           ];
+
+          mkShellFor = stdenv: pkg: stdenv.mkDerivation {
+            name = "${pkg.pname}-${stdenv.cc.cc.pname}-devShell";
+
+            # disable all hardening to suppress warnings in debug builds
+            hardeningDisable = [ "all" ];
+
+            # inherit inputs from pkg
+            buildInputs = pkg.buildInputs ++ packages;
+            nativeBuildInputs = pkg.nativeBuildInputs ++ packages;
+            propagatedBuildInputs = pkg.propagatedBuildInputs;
+            propagatedNativeBuildInputs = pkg.propagatedNativeBuildInputs;
+
+            # configure nix-ld for pre-commit
+            env = {
+              NIX_LD = lib.fileContents "${stdenv.cc}/nix-support/dynamic-linker";
+              NIX_LD_LIBRARY_PATH = lib.makeLibraryPath [ pkgs.gcc-unwrapped.lib ];
+            };
+          };
         in
         rec {
-          default = full;
+          default = gcc;
 
-          full = pkgs.mkShell {
-            inherit hardeningDisable packages;
-            name = "full";
-            inputsFrom = with pkgs; [ villas-node ];
-          };
+          gcc = mkShellFor pkgs.stdenv pkgs.villas-node;
+          clang = mkShellFor pkgs.clangStdenv pkgs.villas-node;
 
           python = pkgs.mkShell {
-            inherit hardeningDisable;
-            name = "python";
+            name = "villas-python-devShell";
+            hardeningDisable = [ "all" ];
             inputsFrom = with pkgs; [ villas-node-python ];
             packages =
               with pkgs;

fpga/include/villas/fpga/core.hpp

@@ -227,15 +227,15 @@ class CoreFactory : public plugin::Plugin {
   // Returns a running and checked FPGA IP
   static std::list<std::shared_ptr<Core>> make(Card *card, json_t *json_ips);
 
-  virtual std::string getType() const { return "core"; }
+  std::string getType() const override { return "core"; }
 
 protected:
   enum PollingMode {
     POLL,
     IRQ,
   };
 
-  Logger getLogger() { return villas::Log::get(getName()); }
+  Logger getLogger() override { return villas::Log::get(getName()); }
 
   // Configure IP instance from JSON config
   virtual void parse(Core &, json_t *) {}
@@ -257,15 +257,15 @@ template <typename T, const char *name, const char *desc, const char *vlnv>
 class CorePlugin : public CoreFactory {
 
 public:
-  virtual std::string getName() const { return name; }
+  std::string getName() const override { return name; }
 
-  virtual std::string getDescription() const { return desc; }
+  std::string getDescription() const override { return desc; }
 
 private:
-  virtual Vlnv getCompatibleVlnv() const { return Vlnv(vlnv); }
+  Vlnv getCompatibleVlnv() const override { return Vlnv(vlnv); }
 
   // Create a concrete IP instance
-  Core *make() const { return new T; };
+  Core *make() const override { return new T; };
 };
 
 } // namespace ip

fpga/include/villas/fpga/ips/aurora.hpp

@@ -18,15 +18,17 @@ class Aurora : public Node {
   static constexpr const char *masterPort = "m_axis";
   static constexpr const char *slavePort = "s_axis";
 
-  virtual void dump() override;
+  void dump() override;
 
-  std::list<std::string> getMemoryBlocks() const { return {registerMemory}; }
+  std::list<std::string> getMemoryBlocks() const override {
+    return {registerMemory};
+  }
 
-  const StreamVertex &getDefaultSlavePort() const {
+  const StreamVertex &getDefaultSlavePort() const override {
     return getSlavePort(slavePort);
   }
 
-  const StreamVertex &getDefaultMasterPort() const {
+  const StreamVertex &getDefaultMasterPort() const override {
     return getMasterPort(masterPort);
   }
 

fpga/include/villas/fpga/ips/aurora_xilinx.hpp

@@ -18,11 +18,11 @@ class AuroraXilinx : public Node {
   static constexpr const char *masterPort = "USER_DATA_M_AXI_RX";
   static constexpr const char *slavePort = "USER_DATA_S_AXI_TX";
 
-  const StreamVertex &getDefaultSlavePort() const {
+  const StreamVertex &getDefaultSlavePort() const override {
     return getSlavePort(slavePort);
   }
 
-  const StreamVertex &getDefaultMasterPort() const {
+  const StreamVertex &getDefaultMasterPort() const override {
     return getMasterPort(masterPort);
   }
 };

fpga/include/villas/fpga/ips/axis_cache.hpp

@@ -18,9 +18,9 @@ namespace ip {
 class AxisCache : public Node {
 public:
   AxisCache();
-  virtual ~AxisCache();
-  virtual bool init() override;
-  virtual bool check() override;
+  ~AxisCache() override;
+  bool init() override;
+  bool check() override;
   void invalidate();
 
 protected: