VILLASframework · stv0g · Aug 7, 2026 · Aug 7, 2026 · Aug 7, 2026 · Aug 7, 2026
@@ -47,26 +47,26 @@ repos:
  - id: editorconfig-checker
  alias: ec
  args:
- - -disable-indent-size
- - -exclude
- - ^LICENSE$|^LICENSES/|\.ecf$
+- -disable-indent-size
+- -exclude
+- ^LICENSE$|^LICENSES/|\.ecf$
 
  # Using this mirror lets us use mypyc-compiled black, which is about 2x faster
  - repo: https://github.com/psf/black-pre-commit-mirror
- rev: "23.3.0"
+ rev: "24.10.0"
  hooks:
  - id: black-jupyter
  exclude: .*_pb2.pyi?$
  args:
- - --line-length=90
+- --line-length=90
 
  - repo: https://github.com/pycqa/flake8
  rev: "7.3.0"
  hooks:
  - id: flake8
  exclude: .*_pb2.pyi?$
  args:
- - --max-line-length=90
+- --max-line-length=90
 
  - repo: https://github.com/markdownlint/markdownlint
  rev: "v0.13.0"

@@ -36,7 +36,7 @@ class Shmem : public Tool {
 
  void usage() override {
  std::cout
- << "Usage: villas-test-shmem WNAME VECTORIZE" << std::endl
+ << "Usage: villas-test-shmem WNAME RNAME VECTORIZE" << std::endl
  << " WNAME name of the shared memory object for the output queue"
  << std::endl
  << " RNAME name of the shared memory object for the input queue"

@@ -1,4 +1,4 @@
-/* Compatability for different library versions.
+/* Compatibility for different library versions.
  *
  * Author: Steffen Vogel <post@steffenvogel.de>
  * SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University

@@ -24,7 +24,7 @@ namespace villas {
 namespace kernel {
 namespace vfio {
 
-// Backwards compatability with older kernels
+// Backwards compatibility with older kernels
 #ifdef VFIO_UPDATE_VADDR
 static constexpr size_t EXTENSION_SIZE = VFIO_UPDATE_VADDR + 1;
 #elif defined(VFIO_UNMAP_ALL)

@@ -64,7 +64,7 @@ void list_push(struct List *l, void *p);
 // Clear list.
 void list_clear(struct List *l);
 
-// Remove all occurences of a list item.
+// Remove all occurrences of a list item.
 void list_remove_all(struct List *l, void *p);
 
 int list_remove(struct List *l, size_t idx);
@@ -74,7 +74,7 @@ int list_insert(struct List *l, size_t idx, void *p);
 // Return the first element of the list for which cmp returns zero.
 void *list_search(struct List *l, cmp_cb_t cmp, const void *ctx);
 
-// Returns the number of occurences for which cmp returns zero when called on all list elements.
+// Returns the number of occurrences for which cmp returns zero when called on all list elements.
 int list_count(struct List *l, cmp_cb_t cmp, void *ctx);
 
 // Return 0 if list contains pointer p.

@@ -66,18 +66,18 @@ char *decolor(char *str);
 // @return Normal variate random variable (Gaussian)
 double boxMuller(float m, float s);
 
-// Double precission uniform random variable
+// Double precision uniform random variable
 double randf();
 
 // Concat formatted string to an existing string.
 //
 // This function uses realloc() to resize the destination.
-// Please make sure to only on dynamic allocated destionations!!!
+// Please make sure to only use it on dynamically allocated destinations!!!
 //
 // @param dest A pointer to a malloc() allocated memory region
 // @param fmt A format string like for printf()
 // @param ... Optional parameters like for printf()
-// @retval The the new value of the dest buffer.
+// @retval The new value of the dest buffer.
 char *strcatf(char **dest, const char *fmt, ...)
  __attribute__((format(printf, 2, 3)));
 

@@ -1,4 +1,4 @@
-/* Compatability for different library versions.
+/* Compatibility for different library versions.
  *
  * Author: Steffen Vogel <post@steffenvogel.de>
  * SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University

@@ -19,7 +19,7 @@ using villas::kernel::devices::IpDevice;
 IpDevice IpDevice::from(const fs::path unsafe_path) {
  if (!is_path_valid(unsafe_path))
  throw RuntimeError(
- "Path {} failed validation as IpDevicePath [adress in hex].[name] ",
+ "Path {} failed validation as IpDevicePath [address in hex].[name] ",
  unsafe_path.string());
  return IpDevice(unsafe_path);
 }

@@ -57,7 +57,7 @@ static std::array<std::string, EXTENSION_SIZE> construct_vfio_extension_str() {
  ret[VFIO_SPAPR_TCE_v2_IOMMU] = "SPAPR TCE v2";
  // cppcheck-suppress containerOutOfBounds
  ret[VFIO_NOIOMMU_IOMMU] = "No IOMMU";
-// Backwards compatability with older kernels
+// Backwards compatibility with older kernels
 #ifdef VFIO_UNMAP_ALL
  ret[VFIO_UNMAP_ALL] = "Unmap all";
 #endif

@@ -1,4 +1,4 @@
-/* Memory managment.
+/* Memory management.
  *
  * Author: Daniel Krebs <github@daniel-krebs.net>
  * SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University

@@ -1,4 +1,4 @@
-/* Memory managment.
+/* Memory management.
  *
  * Author: Daniel Krebs <github@daniel-krebs.net>
  * SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University

@@ -43,14 +43,14 @@ std::vector<std::string> tokenize(const std::string &s,
  std::vector<std::string> tokens;
 
  size_t lastPos = 0;
- size_t curentPos;
+ size_t currentPos;
 
- while ((curentPos = s.find(delimiter, lastPos)) != std::string::npos) {
- const size_t tokenLength = curentPos - lastPos;
+ while ((currentPos = s.find(delimiter, lastPos)) != std::string::npos) {
+ const size_t tokenLength = currentPos - lastPos;
  tokens.push_back(s.substr(lastPos, tokenLength));
 
  // Advance in string
- lastPos = curentPos + delimiter.length();
+ lastPos = currentPos + delimiter.length();
  }
 
  // Check if there's a last token behind the last delimiter.
@@ -159,7 +159,7 @@ char *decolor(char *str) {
 }
 
 void killme(int sig) {
- // Send only to main thread in case the ID was initilized by signalsInit()
+ // Send only to main thread in case the ID was initialized by signalsInit()
  if (main_thread)
  pthread_kill(main_thread, sig);
  else
@@ -198,9 +198,17 @@ char *vstrcatf(char **dest, const char *fmt, va_list ap) {
  int n = *dest ? strlen(*dest) : 0;
  int i = vasprintf(&tmp, fmt, ap);
 
- *dest = (char *)(realloc(*dest, n + i + 1));
- if (*dest != nullptr)
- strncpy(*dest + n, tmp, i + 1);
+ if (i < 0)
+ return *dest;
+
+ char *p = (char *)realloc(*dest, n + i + 1);
+ if (p == nullptr) {
+ free(tmp);
+ return *dest;
+ }
+
+ *dest = p;
+ strncpy(*dest + n, tmp, i + 1);
 
  free(tmp);
 

@@ -84,7 +84,7 @@ allOf:
  - center
  - right
  default: center
- description: The timestamp alignment in respect to the the window.
+ description: The timestamp alignment in respect to the window.
  phase_offset:
  type: number
  default: 0.0

@@ -4,12 +4,20 @@
 ---
 type: object
 properties:
+ enabled:
+ type: boolean
+ default: true
+ title: Enable HTTP/WebSocket server
+ description: |
+ Whether the HTTP & WebSocket server listens on a port.
+
  port:
  type: integer
- default: 80
+ default: 8080
  title: Listening port
  description: |
- The TCP port number on which HTTP & WebSocket server.
+ The TCP port number on which the HTTP & WebSocket server listens.
+ Defaults to 80 when running as root, otherwise 8080.
 
  ssl_cert:
  type: string

@@ -29,5 +29,12 @@ allOf:
  format: uri
  description: A WebSocket URI
 
+ wait_connected:
+ type: boolean
+ default: true
+ description: |
+ Wait until all configured client connections in `destinations` are
+ established before finishing node startup.
+
 - $ref: ../node_signals.yaml
 - $ref: ../node.yaml
@@ -14,6 +14,15 @@ allOf:
  - pubsub
  - radiodish
 
+ pattern:
+ type: string
+ enum:
+ - pubsub
+ - radiodish
+ default: pubsub
+ description: |
+ The ZeroMQ socket pattern to use.
+
  publish:
  type: string
  format: uri
@@ -49,10 +58,10 @@ allOf:
  description: |
  The public key of the server.
 
-private_key:
+secret_key:
  type: string
  description: |
- The private key of the server.
+ The secret (private) key of the server.
 
  out:
  type: object

@@ -64,7 +64,7 @@ properties:
 
  mask:
  description: |
- This setting allows masking the the input nodes which can trigger the path.
+ This setting allows masking the input nodes which can trigger the path.
 
  See also `mode` setting.
 
@@ -107,7 +107,7 @@ properties:
  A boolean flag which enables the poll-based mode for reading samples from multiple path sources.
 
  **Note:** This is an advanced setting.
- Most users should use the the default value which will always do the right thing based on the number and type of input nodes for this path.
+ Most users should use the default value which will always do the right thing based on the number and type of input nodes for this path.
 
  type: boolean
 

@@ -13,7 +13,7 @@ paths = (
  type = "skip_first"
 
  seconds = 10
- # sequence = 10
+ # samples = 10
  }
  )
  }

@@ -5,7 +5,7 @@ nodes = {
  file_node = {
  type = "file"
 
- # These options specify the URI where the the files are stored
+ # These options specify the URI where the files are stored
  # The URI accepts all format tokens of (see strftime(3))
  uri = "logs/input.log"
  # uri = "logs/output_%F_%T.log"

@@ -5,7 +5,7 @@ nodes = {
  ngsi_node = {
  type = "ngsi"
 
- # The HTTP REST API endpoint of the FIRWARE context broker
+ # The HTTP REST API endpoint of the FIWARE context broker
  endpoint = "http://46.101.131.212:1026"
 
  # Add an 'Auth-Token' token header to each request

@@ -12,7 +12,7 @@ nodes = {
  # The Redis key to be used for mode = 'key' or 'hash' (default is the node name)
  key = "my_key"
 
- # The Redis channel tp be used for mode = 'channel' (default is the node name)
+ # The Redis channel to be used for mode = 'channel' (default is the node name)
  channel = "my_channel"
 
  # One of:

@@ -1,9 +1,9 @@
-/* Setup interface queuing desciplines for network emulation.
+/* Setup interface queuing disciplines for network emulation.
  *
  * We use the firewall mark to apply individual netem qdiscs
  * per node. Every node uses an own BSD socket.
  * By using so SO_MARK socket option (see socket(7))
- * we can classify traffic originating from a node seperately.
+ * we can classify traffic originating from a node separately.
  *
  * Author: Steffen Vogel <post@steffenvogel.de>
  * SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University

@@ -3,7 +3,7 @@
  * We use the firewall mark to apply individual netem qdiscs
  * per node. Every node uses an own BSD socket.
  * By using so SO_MARK socket option (see socket(7))
- * we can classify traffic originating from a node seperately.
+ * we can classify traffic originating from a node separately.
  *
  * Author: Steffen Vogel <post@steffenvogel.de>
  * SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University

@@ -18,7 +18,7 @@
 #define MAX_SAMPLE_LENGTH 512u
 #define DEFAULT_FORMAT_BUFFER_LENGTH 4096u
 
-/* Number of hugepages which are requested from the the kernel.
+/* Number of hugepages which are requested from the kernel.
  * @see https://www.kernel.org/doc/Documentation/vm/hugetlbpage.txt
  */
 #define DEFAULT_NR_HUGEPAGES 100

@@ -1,4 +1,4 @@
-/* Node compatability layer for C++.
+/* Node compatibility layer for C++.
  *
  * Author: Steffen Vogel <post@steffenvogel.de>
  * SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University

@@ -34,7 +34,7 @@ struct comedi_direction {
  int sample_rate_hz; // Sample rate in Hz
  bool present; // Config present
  bool enabled; // Card is started successfully
- bool running; // Card is actively transfering samples
+ bool running; // Card is actively transferring samples
  struct timespec started; // Timestamp when sampling started
  struct timespec last_debug; // Timestamp of last debug output
  size_t counter; // Number of villas samples transfered

@@ -76,11 +76,11 @@ struct infiniband {
  // Counter to keep track of available recv. WRs
  unsigned available_recv_wrs;
 
- /* Fixed number to substract from min. number available
+ /* Fixed number to subtract from min. number available
  * WRs in receive queue */
  unsigned buffer_subtraction;
 
- // Unrealiable connectionless data
+ // Unreliable connectionless data
  struct ud_s {
  ::rdma_ud_param ud;
  ::ibv_ah *ah;

@@ -56,7 +56,7 @@ struct ShmemInterface {
  * calls will be written to this pointer.
  * @param[in] conf Configuration parameters for the output queue.
  * @retval 0 The objects were opened and initialized successfully.
- * @retval <0 An error occured; errno is set accordingly.
+ * @retval <0 An error occurred; errno is set accordingly.
  */
 int shmem_int_open(const char *wname, const char *rname,
  struct ShmemInterface *shm, struct ShmemConfig *conf);

@@ -40,7 +40,7 @@ enum class SocketLayer { ETH, IP, UDP, UNIX, TCP_CLIENT, TCP_SERVER };
 /* Generate printable socket address depending on the address family
  *
  * A IPv4 address is formatted as dotted decimals followed by the port/protocol number
- * A link layer address is formatted in hexadecimals digits seperated by colons and the inferface name
+ * A link layer address is formatted in hexadecimals digits separated by colons and the interface name
  *
  * @param sa	A pointer to the socket address.
  * @return	The buffer containing the textual representation of the address. The caller is responsible to free() this buffer!

@@ -67,7 +67,7 @@ class Web final {
 
  Api *getApi() { return api; }
 
- // for C-compatability
+ // for C-compatibility
  lws_context *getContext() { return context; }
 
  lws_vhost *getVHost() { return vhost; }