2014-07-14 11:49:44 +00:00
|
|
|
/* Main routine.
|
2014-06-05 09:34:29 +00:00
|
|
|
*
|
2022-03-15 09:18:01 -04:00
|
|
|
* Author: Steffen Vogel <post@steffenvogel.de>
|
2022-03-15 09:28:57 -04:00
|
|
|
* SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
|
2022-07-04 18:20:03 +02:00
|
|
|
* SPDX-License-Identifier: Apache-2.0
|
2015-06-02 21:53:04 +02:00
|
|
|
*/
|
2014-06-05 09:34:29 +00:00
|
|
|
|
2019-06-23 16:57:00 +02:00
|
|
|
#include <cstdlib>
|
2014-06-05 09:34:29 +00:00
|
|
|
#include <unistd.h>
|
2015-08-22 17:42:38 +02:00
|
|
|
|
2021-06-21 16:11:42 -04:00
|
|
|
#include <iomanip>
|
2018-07-03 21:04:28 +02:00
|
|
|
#include <iostream>
|
|
|
|
|
2018-10-20 14:20:51 +02:00
|
|
|
#include <villas/api.hpp>
|
2023-09-07 11:46:39 +02:00
|
|
|
#include <villas/api/request.hpp>
|
|
|
|
#include <villas/capabilities.hpp>
|
2019-04-23 13:11:08 +02:00
|
|
|
#include <villas/colors.hpp>
|
2018-10-20 14:20:51 +02:00
|
|
|
#include <villas/exceptions.hpp>
|
2023-09-07 11:46:39 +02:00
|
|
|
#include <villas/format.hpp>
|
|
|
|
#include <villas/hook.hpp>
|
2018-10-20 14:20:51 +02:00
|
|
|
#include <villas/kernel/kernel.hpp>
|
|
|
|
#include <villas/kernel/rt.hpp>
|
2023-09-07 11:46:39 +02:00
|
|
|
#include <villas/log.hpp>
|
|
|
|
#include <villas/memory.hpp>
|
|
|
|
#include <villas/node.hpp>
|
|
|
|
#include <villas/node/config.hpp>
|
|
|
|
#include <villas/path.hpp>
|
|
|
|
#include <villas/plugin.hpp>
|
|
|
|
#include <villas/super_node.hpp>
|
|
|
|
#include <villas/tool.hpp>
|
|
|
|
#include <villas/utils.hpp>
|
|
|
|
#include <villas/version.hpp>
|
|
|
|
#include <villas/web.hpp>
|
2017-02-18 10:58:17 -05:00
|
|
|
|
2021-02-24 09:17:53 +01:00
|
|
|
#ifdef WITH_NODE_OPAL
|
2023-09-07 11:46:39 +02:00
|
|
|
#include <villas/nodes/opal.hpp>
|
2015-03-17 22:46:46 +01:00
|
|
|
#endif
|
|
|
|
|
2018-10-20 14:20:51 +02:00
|
|
|
using namespace villas;
|
2018-07-03 21:51:48 +02:00
|
|
|
using namespace villas::node;
|
2018-10-20 14:20:51 +02:00
|
|
|
using namespace villas::plugin;
|
2018-07-03 21:51:48 +02:00
|
|
|
|
2019-04-19 14:52:52 +02:00
|
|
|
namespace villas {
|
|
|
|
namespace node {
|
|
|
|
namespace tools {
|
2014-06-10 16:57:40 +00:00
|
|
|
|
2019-04-19 14:52:52 +02:00
|
|
|
class Node : public Tool {
|
2019-02-11 16:39:30 +01:00
|
|
|
|
2019-04-19 14:52:52 +02:00
|
|
|
public:
|
2023-09-07 11:46:39 +02:00
|
|
|
Node(int argc, char *argv[]) : Tool(argc, argv, "node") {}
|
2019-02-11 16:39:30 +01:00
|
|
|
|
2019-04-19 14:52:52 +02:00
|
|
|
protected:
|
2023-09-07 11:46:39 +02:00
|
|
|
SuperNode sn;
|
|
|
|
|
|
|
|
std::string uri;
|
|
|
|
bool showCapabilities = false;
|
|
|
|
|
|
|
|
void handler(int signal, siginfo_t *sinfo, void *ctx) {
|
|
|
|
switch (signal) {
|
|
|
|
case SIGALRM:
|
|
|
|
logger->info("Reached timeout. Terminating...");
|
|
|
|
break;
|
|
|
|
|
|
|
|
default:
|
|
|
|
logger->info("Received {} signal. Terminating...", strsignal(signal));
|
|
|
|
}
|
|
|
|
|
|
|
|
sn.setState(State::STOPPING);
|
|
|
|
}
|
|
|
|
|
|
|
|
void usage() {
|
|
|
|
std::cout
|
|
|
|
<< "Usage: villas-node [OPTIONS] [CONFIG]" << std::endl
|
|
|
|
<< " OPTIONS is one or more of the following options:" << std::endl
|
|
|
|
<< " -h show this usage information" << std::endl
|
|
|
|
<< " -d LVL set logging level" << std::endl
|
|
|
|
<< " -C show capabilities in JSON format" << std::endl
|
|
|
|
<< " -V show the version of the tool" << std::endl
|
|
|
|
<< std::endl
|
|
|
|
<< " CONFIG is the path to an optional configuration file" << std::endl
|
|
|
|
<< " if omitted, VILLASnode will start without a configuration"
|
|
|
|
<< std::endl
|
|
|
|
<< " and wait for provisioning over the web interface."
|
|
|
|
<< std::endl
|
|
|
|
<< std::endl
|
2021-02-24 09:17:53 +01:00
|
|
|
#ifdef WITH_NODE_OPAL
|
2023-09-07 11:46:39 +02:00
|
|
|
<< "Usage: villas-node OPAL_ASYNC_SHMEM_NAME OPAL_ASYNC_SHMEM_SIZE "
|
|
|
|
"OPAL_PRINT_SHMEM_NAME"
|
|
|
|
<< std::endl
|
|
|
|
<< " This type of invocation is used by OPAL-RT Asynchronous "
|
|
|
|
"processes."
|
|
|
|
<< std::endl
|
|
|
|
<< " See in the RT-LAB User Guide for more information." << std::endl
|
|
|
|
<< std::endl
|
2021-02-24 09:17:53 +01:00
|
|
|
#endif // WITH_NODE_OPAL
|
2017-08-05 21:02:09 +02:00
|
|
|
|
2023-09-07 11:46:39 +02:00
|
|
|
<< "Supported node-types:" << std::endl;
|
|
|
|
for (auto p : registry->lookup<NodeFactory>()) {
|
|
|
|
if (!p->isHidden())
|
|
|
|
std::cout << " - " << std::left << std::setw(18) << p->getName()
|
|
|
|
<< p->getDescription() << std::endl;
|
|
|
|
}
|
|
|
|
std::cout << std::endl;
|
|
|
|
|
|
|
|
std::cout << "Supported IO formats:" << std::endl;
|
|
|
|
for (auto p : registry->lookup<FormatFactory>()) {
|
|
|
|
if (!p->isHidden())
|
|
|
|
std::cout << " - " << std::left << std::setw(18) << p->getName()
|
|
|
|
<< p->getDescription() << std::endl;
|
|
|
|
}
|
|
|
|
std::cout << std::endl;
|
2020-10-16 11:40:30 +02:00
|
|
|
|
2017-12-09 02:23:29 +08:00
|
|
|
#ifdef WITH_HOOKS
|
2023-09-07 11:46:39 +02:00
|
|
|
std::cout << "Supported hooks:" << std::endl;
|
|
|
|
for (auto p : registry->lookup<HookFactory>()) {
|
|
|
|
if (!p->isHidden())
|
|
|
|
std::cout << " - " << std::left << std::setw(18) << p->getName()
|
|
|
|
<< p->getDescription() << std::endl;
|
|
|
|
}
|
|
|
|
std::cout << std::endl;
|
2023-06-20 15:36:13 +02:00
|
|
|
#endif // WITH_HOOKS
|
2017-05-05 19:24:16 +00:00
|
|
|
|
2018-10-20 14:20:51 +02:00
|
|
|
#ifdef WITH_API
|
2023-09-07 11:46:39 +02:00
|
|
|
std::cout << "Supported API commands:" << std::endl;
|
|
|
|
for (auto p : registry->lookup<api::RequestFactory>()) {
|
|
|
|
if (!p->isHidden())
|
|
|
|
std::cout << " - " << std::left << std::setw(18) << p->getName()
|
|
|
|
<< p->getDescription() << std::endl;
|
|
|
|
}
|
|
|
|
std::cout << std::endl;
|
2023-06-20 15:36:13 +02:00
|
|
|
#endif // WITH_API
|
2016-01-15 15:25:22 +01:00
|
|
|
|
2023-09-07 11:46:39 +02:00
|
|
|
printCopyright();
|
|
|
|
}
|
2018-10-21 22:28:38 +01:00
|
|
|
|
2023-09-07 11:46:39 +02:00
|
|
|
void parse() {
|
|
|
|
// Check arguments
|
2021-02-24 09:17:53 +01:00
|
|
|
#ifdef WITH_NODE_OPAL
|
2023-09-07 11:46:39 +02:00
|
|
|
if (argc != 4) {
|
|
|
|
usage();
|
|
|
|
exit(EXIT_FAILURE);
|
|
|
|
}
|
2017-05-05 19:24:16 +00:00
|
|
|
|
2023-09-07 11:46:39 +02:00
|
|
|
opal_register_region(argc, argv);
|
2017-09-16 11:52:30 +02:00
|
|
|
|
2023-09-07 11:46:39 +02:00
|
|
|
uri = "villas-node.conf";
|
2015-03-12 22:56:58 +01:00
|
|
|
#else
|
2018-10-04 02:41:01 +02:00
|
|
|
|
2023-09-07 11:46:39 +02:00
|
|
|
// Parse optional command line arguments
|
|
|
|
int c;
|
|
|
|
while ((c = getopt(argc, argv, "hCVd:")) != -1) {
|
|
|
|
switch (c) {
|
|
|
|
case 'V':
|
|
|
|
printVersion();
|
|
|
|
exit(EXIT_SUCCESS);
|
|
|
|
|
|
|
|
case 'd':
|
2024-07-29 12:35:42 +02:00
|
|
|
Log::getInstance().setLevel(optarg);
|
2023-09-07 11:46:39 +02:00
|
|
|
break;
|
|
|
|
|
|
|
|
case 'C':
|
|
|
|
showCapabilities = true;
|
|
|
|
break;
|
|
|
|
|
|
|
|
case 'h':
|
|
|
|
case '?':
|
|
|
|
usage();
|
|
|
|
exit(c == '?' ? EXIT_FAILURE : EXIT_SUCCESS);
|
|
|
|
}
|
|
|
|
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (argc == optind + 1)
|
|
|
|
uri = argv[optind];
|
|
|
|
else if (argc != optind) {
|
|
|
|
usage();
|
|
|
|
exit(EXIT_FAILURE);
|
|
|
|
}
|
2017-12-09 02:23:29 +08:00
|
|
|
#endif // ENABLE_OPAL_ASYNC
|
2023-09-07 11:46:39 +02:00
|
|
|
}
|
2017-09-16 11:52:30 +02:00
|
|
|
|
2023-09-07 11:46:39 +02:00
|
|
|
int main() { return showCapabilities ? capabilities() : daemon(); }
|
2021-09-21 15:22:09 +02:00
|
|
|
|
2023-09-07 11:46:39 +02:00
|
|
|
int capabilities() {
|
|
|
|
auto *json_caps = getCapabilities();
|
2021-09-21 15:22:09 +02:00
|
|
|
|
2023-09-07 11:46:39 +02:00
|
|
|
json_dumpf(json_caps, stdout, JSON_INDENT(4));
|
2021-09-21 15:22:09 +02:00
|
|
|
|
2023-09-07 11:46:39 +02:00
|
|
|
return 0;
|
|
|
|
}
|
2021-09-21 15:22:09 +02:00
|
|
|
|
2023-09-07 11:46:39 +02:00
|
|
|
int daemon() {
|
|
|
|
if (!uri.empty())
|
|
|
|
sn.parse(uri);
|
|
|
|
else
|
|
|
|
logger->warn("No configuration file specified. Starting unconfigured. "
|
|
|
|
"Use the API to configure this instance.");
|
2017-09-02 14:20:38 +02:00
|
|
|
|
2023-09-07 11:46:39 +02:00
|
|
|
sn.check();
|
|
|
|
sn.prepare();
|
|
|
|
sn.start();
|
|
|
|
sn.run();
|
|
|
|
sn.stop();
|
2014-12-05 12:41:06 +01:00
|
|
|
|
2023-09-07 11:46:39 +02:00
|
|
|
return 0;
|
|
|
|
}
|
2019-04-19 14:52:52 +02:00
|
|
|
};
|
2019-03-26 17:04:57 +01:00
|
|
|
|
2023-06-20 15:36:13 +02:00
|
|
|
} // namespace tools
|
|
|
|
} // namespace node
|
|
|
|
} // namespace villas
|
2019-04-19 14:52:52 +02:00
|
|
|
|
2023-09-07 11:46:39 +02:00
|
|
|
int main(int argc, char *argv[]) {
|
|
|
|
villas::node::tools::Node t(argc, argv);
|
2019-04-19 14:52:52 +02:00
|
|
|
|
2023-09-07 11:46:39 +02:00
|
|
|
return t.run();
|
2014-06-05 09:34:29 +00:00
|
|
|
}
|