VILLASnode/include/villas/super_node.hpp

/* The super node object holding the state of the application.
 *
 * Author: Steffen Vogel <post@steffenvogel.de>
 * SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
 * SPDX-License-Identifier: Apache-2.0
 */

#pragma once

#include <villas/node/config.hpp>

#ifdef WITH_GRAPHVIZ
extern "C" {
#include <graphviz/gvc.h>
}
#endif

#include <fstream>

#include <villas/api.hpp>
#include <villas/common.hpp>
#include <villas/config_class.hpp>
#include <villas/kernel/if.hpp>
#include <villas/log.hpp>
#include <villas/node.hpp>
#include <villas/node_list.hpp>
#include <villas/path_list.hpp>
#include <villas/task.hpp>
#include <villas/web.hpp>

namespace villas {
namespace node {

// Forward declarations
class Node;

// Global configuration
class SuperNode {

protected:
  enum State state;

  int idleStop;

  Logger logger;

  NodeList nodes;
  PathList paths;
  std::list<kernel::Interface *> interfaces;

#ifdef WITH_API
  Api api;
#endif

#ifdef WITH_WEB
  Web web;
#endif

  int priority;     // Process priority (lower is better)
  int affinity;     // Process affinity of the server and all created threads
  int hugepages;    // Number of hugepages to reserve.
  double statsRate; // Rate at which we display the periodic stats.

  struct Task task; // Task for periodic stats output

  uuid_t uuid; // A globally unique identifier of the instance

  struct timespec started; // The time at which the instance has been started.

  std::string uri; // URI of configuration

  Config config; // The configuration file.

public:
  // Inititalize configuration object before parsing the configuration.
  SuperNode();

  int init();

  // Wrapper for parse() which loads the config first.
  void parse(const std::string &name);

  /* Parse super-node configuration.
	 *
	 * @param json A libjansson object which contains the configuration.
	 */
  void parse(json_t *json);

  // Check validity of super node configuration.
  void check();

  // Initialize after parsing the configuration file.
  void prepare();
  void start();
  void stop();
  void run();

  void preparePaths();
  void prepareNodes();
  void prepareNodeTypes();

  void startPaths();
  void startNodes();
  void startInterfaces();

  void stopPaths();
  void stopNodes();
  void stopNodeTypes();
  void stopInterfaces();

#ifdef WITH_GRAPHVIZ
  graph_t *getGraph();
#endif

  // Run periodic hooks of this super node.
  int periodic();

  void setState(enum State st) { state = st; }

  Node *getNode(const std::string &name) { return nodes.lookup(name); }

  NodeList &getNodes() { return nodes; }

  PathList &getPaths() { return paths; }

  std::list<kernel::Interface *> &getInterfaces() { return interfaces; }

  enum State getState() const { return state; }

  const uuid_t &getUuid() const { return uuid; }

  struct timespec getStartTime() const { return started; }

#ifdef WITH_API
  Api *getApi() { return &api; }
#endif

#ifdef WITH_WEB
  Web *getWeb() { return &web; }
#endif

  json_t *getConfig() { return config.root; }

  std::filesystem::path &getConfigPath() { return config.getConfigPath(); }

  std::string getConfigUri() const { return uri; }

  int getAffinity() const { return affinity; }

  Logger getLogger() { return logger; }

  // Destroy configuration object.
  ~SuperNode();
};

} // namespace node
} // namespace villas