Introduce clang-tidy

.clang-tidy

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

.envrc

@@ -2,3 +2,4 @@
 # SPDX-License-Identifier: Apache-2.0
 
 use flake
+pre-commit install

CMakeLists.txt

@@ -53,7 +53,13 @@ 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-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;
@@ -62,9 +62,9 @@ class Shmem : public Tool {
       return 1;
     }
 
-    std::string wname = argv[1];
-    std::string rname = argv[2];
-    int vectorize = atoi(argv[3]);
+    std::string const wname = argv[1];
+    std::string const rname = argv[2];
+    int const vectorize = atoi(argv[3]);
 
     ret = shmem_int_open(wname.c_str(), rname.c_str(), &shm, &conf);
     if (ret < 0)
@@ -87,7 +87,7 @@ class Shmem : public Tool {
         outsmps[i]->sequence = insmps[i]->sequence;
         outsmps[i]->ts = insmps[i]->ts;
 
-        int len = MIN(insmps[i]->length, outsmps[i]->capacity);
+        int const len = MIN(insmps[i]->length, outsmps[i]->capacity);
         memcpy(outsmps[i]->data, insmps[i]->data, SAMPLE_DATA_LENGTH(len));
 
         outsmps[i]->length = len;

common/include/villas/cpuset.hpp

@@ -75,7 +75,7 @@ class CpuSet {
   size_t size() const { return sz; }
 
   CpuSet operator~() {
-    CpuSet full = UINTMAX_MAX;
+    CpuSet const full = UINTMAX_MAX;
 
     return full ^ *this;
   }

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

@@ -92,7 +92,7 @@ class ConfigError : public std::runtime_error {
   }
 
 public:
-  ~ConfigError() {
+  ~ConfigError() override {
     if (msg)
       free(msg);
   }
@@ -132,12 +132,12 @@ class ConfigError : public std::runtime_error {
   }
 
   std::string docUri() const {
-    std::string baseUri = "https://villas.fein-aachen.org/doc/jump?";
+    std::string const baseUri = "https://villas.fein-aachen.org/doc/jump?";
 
     return baseUri + id;
   }
 
-  virtual const char *what() const noexcept { return msg; }
+  const char *what() const noexcept override { return msg; }
 };
 
 } // namespace villas

common/include/villas/graph/directed.hpp

@@ -100,7 +100,7 @@ class DirectedGraph {
   EdgeIdentifier addDefaultEdge(VertexIdentifier fromVertexId,
                                 VertexIdentifier toVertexId) {
     // Create a new edge
-    std::shared_ptr<EdgeType> edge(new EdgeType);
+    std::shared_ptr<EdgeType> const edge(new EdgeType);
 
     return addEdge(edge, fromVertexId, toVertexId);
   }

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

@@ -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() {}
 };
 
 } // namespace devices

common/include/villas/kernel/vfio_device.hpp

@@ -11,8 +11,6 @@
 
 #pragma once
 
-#include <list>
-#include <memory>
 #include <string>
 #include <vector>
 
@@ -99,7 +97,7 @@ class Device {
   std::vector<void *> mappings;
 
   // libpci handle of the device
-  const kernel::devices::PciDevice *pci_device;
+  [[maybe_unused]] const kernel::devices::PciDevice *pci_device;
 
   Logger log;
 };

common/include/villas/memory.hpp

@@ -116,7 +116,8 @@ template <typename DerivedAllocator> class BaseAllocator {
       : memoryAddrSpaceId(memoryAddrSpaceId) {
     // CRTP
     derivedAlloc = static_cast<DerivedAllocator *>(this);
-    std::string loggerName = fmt::format("memory:", derivedAlloc->getName());
+    std::string const loggerName =
+        fmt::format("memory:", derivedAlloc->getName());
     logger = Log::get(loggerName);
 
     // Default deallocation callback
@@ -136,7 +137,6 @@ template <typename DerivedAllocator> class BaseAllocator {
   }
 
   virtual std::unique_ptr<MemoryBlock, MemoryBlock::deallocator_fn>
-
   allocateBlock(size_t size) = 0;
 
   template <typename T> MemoryAccessor<T> allocate(size_t num) {
@@ -152,7 +152,7 @@ template <typename DerivedAllocator> class BaseAllocator {
     // Check if the allocated memory is really accessible by writing to the
     // allocated memory and reading back. Exponentially increase offset to
     // speed up testing.
-    MemoryAccessor<volatile uint8_t> byteAccessor(*mem);
+    MemoryAccessor<volatile uint8_t> const byteAccessor(*mem);
     size_t idx = 0;
     for (int i = 0; idx < mem->getSize(); i++, idx = (1 << i)) {
       auto val = static_cast<uint8_t>(i);
@@ -166,6 +166,8 @@ template <typename DerivedAllocator> class BaseAllocator {
     return MemoryAccessor<T>(std::move(mem));
   }
 
+  virtual ~BaseAllocator() {}
+
 protected:
   void insertMemoryBlock(const MemoryBlock &mem) {
     auto &mm = MemoryManager::get();
@@ -217,8 +219,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 +249,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 +266,7 @@ class HostDmaRam {
   public:
     HostDmaRamAllocator(int num);
 
-    virtual ~HostDmaRamAllocator();
+    ~HostDmaRamAllocator() override;
 
     std::string getName() const { return getUdmaBufName(num); }
 

common/include/villas/popen.hpp

@@ -67,6 +67,11 @@ class PopenStream : public Popen {
 
   std::ostream &cout() { return *(output.stream); }
 
+  template <typename T>
+  friend std::istream &operator>>(PopenStream &po, T &value) {
+    return *(po.input.stream) >> value;
+  }
+
   void open();
   int close();
 
@@ -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/include/villas/utils.hpp

@@ -81,8 +81,8 @@
 #endif
 #define MAX(a, b)                                                              \
   ({                                                                           \
-    __typeof__(a) _a = (a);                                                    \
-    __typeof__(b) _b = (b);                                                    \
+    __typeof__(a) const &_a = (a);                                             \
+    __typeof__(b) const &_b = (b);                                             \
     _a > _b ? _a : _b;                                                         \
   })
 
@@ -92,8 +92,8 @@
 #endif
 #define MIN(a, b)                                                              \
   ({                                                                           \
-    __typeof__(a) _a = (a);                                                    \
-    __typeof__(b) _b = (b);                                                    \
+    __typeof__(a) const &_a = (a);                                             \
+    __typeof__(b) const &_b = (b);                                             \
     _a < _b ? _a : _b;                                                         \
   })
 #define MIN3(a, b, c) MIN(MIN((a), (b)), (c))

common/lib/dsp/pid.cpp

@@ -20,18 +20,18 @@ PID::PID(double _dt, double _max, double _min, double _Kp, double _Kd,
 
 double PID::calculate(double setpoint, double pv) {
   // Calculate error
-  double error = setpoint - pv;
+  double const error = setpoint - pv;
 
   // Proportional term
-  double Pout = Kp * error;
+  double const Pout = Kp * error;
 
   // Integral term
   integral += error * dt;
-  double Iout = Ki * integral;
+  double const Iout = Ki * integral;
 
   // Derivative term
-  double derivative = (error - pre_error) / dt;
-  double Dout = Kd * derivative;
+  double const derivative = (error - pre_error) / dt;
+  double const Dout = Kd * derivative;
 
   // Calculate total output
   double output = Pout + Iout + Dout;

common/lib/hist.cpp

@@ -45,7 +45,7 @@ void Hist::put(double value) {
       // There is no warmup phase
       // TODO resolution = ?
     } else {
-      idx_t idx = std::round((value - low) / resolution);
+      idx_t const idx = std::round((value - low) / resolution);
 
       // Check bounds and increment
       if (idx >= (idx_t)data.size())
@@ -123,7 +123,7 @@ void Hist::print(Logger logger, bool details, std::string prefix) const {
 
 void Hist::plot(Logger logger) const {
   // Get highest bar
-  Hist::cnt_t max = *std::max_element(data.begin(), data.end());
+  Hist::cnt_t const max = *std::max_element(data.begin(), data.end());
 
   std::vector<TableColumn> cols = {
       {-9, TableColumn::Alignment::RIGHT, "Value", "%+9.3g"},
@@ -136,9 +136,9 @@ void Hist::plot(Logger logger) const {
   table.header();
 
   for (size_t i = 0; i < data.size(); i++) {
-    double value = low + (i)*resolution;
-    Hist::cnt_t cnt = data[i];
-    int bar = cols[2].getWidth() * ((double)cnt / max);
+    double const value = low + (i)*resolution;
+    Hist::cnt_t const cnt = data[i];
+    int const bar = cols[2].getWidth() * ((double)cnt / max);
 
     char *buf = strf("%s", "");
     for (int i = 0; i < bar; i++)
@@ -196,7 +196,7 @@ json_t *Hist::toJson() const {
 int Hist::dumpJson(FILE *f) const {
   json_t *j = Hist::toJson();
 
-  int ret = json_dumpf(j, f, 0);
+  int const ret = json_dumpf(j, f, 0);
 
   json_decref(j);
 

common/lib/kernel/devices/device_connection.cpp

@@ -26,7 +26,7 @@ DeviceConnection DeviceConnection::from(
   auto logger = villas::Log::get("Builder: DeviceConnection");
 
   // Bind the devicetree device to vfio driver
-  LinuxDriver driver(
+  LinuxDriver const driver(
       std::filesystem::path("/sys/bus/platform/drivers/vfio-platform"));
   driver.attach(device);
 
@@ -55,9 +55,9 @@ void DeviceConnection::addToMemorygraph() const {
 
   // Create memorygraph edge from process to vfio device
   auto &mm = MemoryManager::get();
-  size_t srcVertexId = mm.getProcessAddressSpace();
+  size_t const srcVertexId = mm.getProcessAddressSpace();
   const size_t mem_size = this->vfio_device->regionGetSize(0);
-  size_t targetVertexId =
+  size_t const targetVertexId =
       mm.getOrCreateAddressSpace(this->vfio_device->getName());
   mm.createMapping(reinterpret_cast<uintptr_t>(mapping), 0, mem_size,
                    "process to vfio", srcVertexId, targetVertexId);

common/lib/kernel/devices/ip_device.cpp

@@ -25,13 +25,13 @@ IpDevice IpDevice::from(const std::filesystem::path unsafe_path) {
 }
 
 std::string IpDevice::ip_name() const {
-  int pos = name().find('.');
+  int const pos = name().find('.');
   return name().substr(pos + 1);
 }
 
 size_t IpDevice::addr() const {
-  size_t pos = name().find('.');
-  std::string addr_hex = name().substr(0, pos);
+  size_t const pos = name().find('.');
+  std::string const addr_hex = name().substr(0, pos);
 
   // Convert from hex-string to number
   std::stringstream ss;
@@ -43,7 +43,7 @@ size_t IpDevice::addr() const {
 }
 
 bool IpDevice::is_path_valid(const std::filesystem::path unsafe_path) {
-  std::string assumed_device_name = unsafe_path.filename();
+  std::string const assumed_device_name = unsafe_path.filename();
 
   // Match format of hexaddr.devicename
   if (!std::regex_match(assumed_device_name,

common/lib/kernel/devices/linux_driver.cpp

@@ -26,7 +26,7 @@ void LinuxDriver::bind(const Device &device) const {
 }
 
 std::string LinuxDriver::name() const {
-  size_t pos = path.u8string().rfind('/');
+  size_t const pos = path.u8string().rfind('/');
   return path.u8string().substr(pos + 1);
 }