mirror of
https://git.rwth-aachen.de/acs/public/villas/node/
synced 2025-03-16 00:00:02 +01:00
350 lines
No EOL
6.8 KiB
C
350 lines
No EOL
6.8 KiB
C
/** Nodes.
|
|
*
|
|
* @author Steffen Vogel <stvogel@eonerc.rwth-aachen.de>
|
|
* @copyright 2017, Institute for Automation of Complex Power Systems, EONERC
|
|
* @license GNU General Public License (version 3)
|
|
*
|
|
* VILLASnode
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*********************************************************************************/
|
|
|
|
#include <string.h>
|
|
|
|
#include "sample.h"
|
|
#include "node.h"
|
|
#include "utils.h"
|
|
#include "config.h"
|
|
#include "plugin.h"
|
|
#include "config_helper.h"
|
|
#include "mapping.h"
|
|
|
|
int node_init(struct node *n, struct node_type *vt)
|
|
{
|
|
static int max_id;
|
|
|
|
assert(n->state == STATE_DESTROYED);
|
|
|
|
n->_vt = vt;
|
|
n->_vd = alloc(vt->size);
|
|
|
|
n->name = NULL;
|
|
n->_name = NULL;
|
|
n->_name_long = NULL;
|
|
|
|
n->id = max_id++;
|
|
|
|
/* Default values */
|
|
n->vectorize = 1;
|
|
n->samplelen = DEFAULT_SAMPLELEN;
|
|
|
|
list_push(&vt->instances, n);
|
|
|
|
n->state = STATE_INITIALIZED;
|
|
|
|
return 0;
|
|
}
|
|
|
|
int node_parse(struct node *n, json_t *cfg, const char *name)
|
|
{
|
|
struct plugin *p;
|
|
int ret;
|
|
|
|
json_error_t err;
|
|
|
|
const char *type;
|
|
|
|
n->name = strdup(name);
|
|
|
|
ret = json_unpack_ex(cfg, &err, 0, "{ s: s, s?: i, s?: i }",
|
|
"type", &type,
|
|
"vectorize", &n->vectorize,
|
|
"samplelen", &n->samplelen
|
|
);
|
|
if (ret)
|
|
jerror(&err, "Failed to parse node '%s'", node_name(n));
|
|
|
|
p = plugin_lookup(PLUGIN_TYPE_NODE, type);
|
|
assert(&p->node == n->_vt);
|
|
|
|
ret = n->_vt->parse ? n->_vt->parse(n, cfg) : 0;
|
|
if (ret)
|
|
error("Failed to parse node '%s'", node_name(n));
|
|
|
|
n->cfg = cfg;
|
|
n->state = STATE_PARSED;
|
|
|
|
return ret;
|
|
}
|
|
|
|
int node_parse_cli(struct node *n, int argc, char *argv[])
|
|
{
|
|
int ret;
|
|
|
|
assert(n->_vt);
|
|
|
|
if (n->_vt->parse_cli) {
|
|
n->name = strdup("cli");
|
|
|
|
ret = n->_vt->parse_cli(n, argc, argv);
|
|
if (ret)
|
|
return ret;
|
|
|
|
n->state = STATE_PARSED;
|
|
}
|
|
else {
|
|
n->cfg = json_load_cli(argc, argv);
|
|
if (!n->cfg)
|
|
return -1;
|
|
|
|
ret = node_parse(n, n->cfg, "cli");
|
|
}
|
|
|
|
return ret;
|
|
}
|
|
|
|
int node_check(struct node *n)
|
|
{
|
|
assert(n->state != STATE_DESTROYED);
|
|
|
|
if (n->vectorize <= 0)
|
|
error("Invalid `vectorize` value %d for node %s. Must be natural number!", n->vectorize, node_name(n));
|
|
|
|
if (n->_vt->vectorize && n->_vt->vectorize < n->vectorize)
|
|
error("Invalid value for `vectorize`. Node type requires a number smaller than %d!",
|
|
n->_vt->vectorize);
|
|
|
|
n->state = STATE_CHECKED;
|
|
|
|
return 0;
|
|
}
|
|
|
|
int node_start(struct node *n)
|
|
{
|
|
int ret;
|
|
|
|
assert(n->state == STATE_CHECKED);
|
|
|
|
info("Starting node %s", node_name_long(n));
|
|
{ INDENT
|
|
ret = n->_vt->start ? n->_vt->start(n) : 0;
|
|
if (ret)
|
|
return ret;
|
|
}
|
|
|
|
n->state = STATE_STARTED;
|
|
|
|
n->sequence = 0;
|
|
|
|
return ret;
|
|
}
|
|
|
|
int node_stop(struct node *n)
|
|
{
|
|
int ret;
|
|
|
|
if (n->state != STATE_STARTED)
|
|
return 0;
|
|
|
|
info("Stopping node %s", node_name(n));
|
|
{ INDENT
|
|
ret = n->_vt->stop ? n->_vt->stop(n) : 0;
|
|
}
|
|
|
|
if (ret == 0)
|
|
n->state = STATE_STOPPED;
|
|
|
|
return ret;
|
|
}
|
|
|
|
int node_destroy(struct node *n)
|
|
{
|
|
assert(n->state != STATE_DESTROYED && n->state != STATE_STARTED);
|
|
|
|
if (n->_vt->destroy)
|
|
n->_vt->destroy(n);
|
|
|
|
list_remove(&n->_vt->instances, n);
|
|
|
|
if (n->_vd)
|
|
free(n->_vd);
|
|
|
|
if (n->_name)
|
|
free(n->_name);
|
|
|
|
if (n->_name_long)
|
|
free(n->_name_long);
|
|
|
|
if (n->name)
|
|
free(n->name);
|
|
|
|
n->state = STATE_DESTROYED;
|
|
|
|
return 0;
|
|
}
|
|
|
|
int node_read(struct node *n, struct sample *smps[], unsigned cnt)
|
|
{
|
|
int readd, nread = 0;
|
|
|
|
if (!n->_vt->read)
|
|
return -1;
|
|
|
|
/* Send in parts if vector not supported */
|
|
if (n->_vt->vectorize > 0 && n->_vt->vectorize < cnt) {
|
|
while (cnt - nread > 0) {
|
|
readd = n->_vt->read(n, &smps[nread], MIN(cnt - nread, n->_vt->vectorize));
|
|
if (readd < 0)
|
|
return readd;
|
|
|
|
nread += readd;
|
|
debug(LOG_NODES | 5, "Received %u samples from node %s", readd, node_name(n));
|
|
}
|
|
}
|
|
else {
|
|
nread = n->_vt->read(n, smps, cnt);
|
|
if (nread < 0)
|
|
return nread;
|
|
|
|
debug(LOG_NODES | 5, "Received %u samples from node %s", nread, node_name(n));
|
|
}
|
|
|
|
for (int i = 0; i < nread; i++)
|
|
smps[i]->source = n;
|
|
|
|
return nread;
|
|
}
|
|
|
|
int node_write(struct node *n, struct sample *smps[], unsigned cnt)
|
|
{
|
|
int sent, nsent = 0;
|
|
|
|
if (!n->_vt->write)
|
|
return -1;
|
|
|
|
/* Send in parts if vector not supported */
|
|
if (n->_vt->vectorize > 0 && n->_vt->vectorize < cnt) {
|
|
while (cnt - nsent > 0) {
|
|
sent = n->_vt->write(n, &smps[nsent], MIN(cnt - nsent, n->_vt->vectorize));
|
|
if (sent < 0)
|
|
return sent;
|
|
|
|
nsent += sent;
|
|
debug(LOG_NODES | 5, "Sent %u samples to node %s", sent, node_name(n));
|
|
}
|
|
}
|
|
else {
|
|
nsent = n->_vt->write(n, smps, cnt);
|
|
if (nsent < 0)
|
|
return nsent;
|
|
|
|
debug(LOG_NODES | 5, "Sent %u samples to node %s", nsent, node_name(n));
|
|
}
|
|
|
|
return nsent;
|
|
}
|
|
|
|
char * node_name(struct node *n)
|
|
{
|
|
if (!n->_name)
|
|
strcatf(&n->_name, CLR_RED("%s") "(" CLR_YEL("%s") ")", n->name, plugin_name(n->_vt));
|
|
|
|
return n->_name;
|
|
}
|
|
|
|
char * node_name_long(struct node *n)
|
|
{
|
|
if (!n->_name_long) {
|
|
if (n->_vt->print) {
|
|
struct node_type *vt = n->_vt;
|
|
char *name_long = vt->print(n);
|
|
strcatf(&n->_name_long, "%s: id=%d, vectorize=%d, samplelen=%d, %s", node_name(n), n->id, n->vectorize, n->samplelen, name_long);
|
|
free(name_long);
|
|
}
|
|
else
|
|
n->_name_long = node_name(n);
|
|
}
|
|
|
|
return n->_name_long;
|
|
}
|
|
|
|
const char * node_name_short(struct node *n)
|
|
{
|
|
return n->name;
|
|
}
|
|
|
|
int node_reverse(struct node *n)
|
|
{
|
|
return n->_vt->reverse ? n->_vt->reverse(n) : -1;
|
|
}
|
|
|
|
int node_fd(struct node *n)
|
|
{
|
|
return n->_vt->fd ? n->_vt->fd(n) : -1;
|
|
}
|
|
|
|
int node_parse_list(struct list *list, json_t *cfg, struct list *all)
|
|
{
|
|
struct node *node;
|
|
const char *str;
|
|
char *allstr = NULL;
|
|
|
|
size_t index;
|
|
json_t *elm;
|
|
|
|
switch (json_typeof(cfg)) {
|
|
case JSON_STRING:
|
|
str = json_string_value(cfg);
|
|
node = list_lookup(all, str);
|
|
if (!node)
|
|
goto invalid2;
|
|
|
|
list_push(list, node);
|
|
break;
|
|
|
|
case JSON_ARRAY:
|
|
json_array_foreach(cfg, index, elm) {
|
|
if (!json_is_string(elm))
|
|
goto invalid;
|
|
|
|
node = list_lookup(all, json_string_value(elm));
|
|
if (!node)
|
|
|
|
|
|
list_push(list, node);
|
|
}
|
|
break;
|
|
|
|
default:
|
|
goto invalid;
|
|
}
|
|
|
|
return 0;
|
|
|
|
invalid:
|
|
error("The node list must be an a single or an array of strings referring to the keys of the 'nodes' section");
|
|
|
|
return -1;
|
|
|
|
invalid2:
|
|
for (size_t i = 0; i < list_length(all); i++) {
|
|
struct node *n = list_at(all, i);
|
|
|
|
strcatf(&allstr, " %s", node_name_short(n));
|
|
}
|
|
|
|
error("Unknown node '%s'. Choose of one of: %s", str, allstr);
|
|
|
|
return 0;
|
|
} |