1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright 2016, Olivier MATZ <zer0@droids-corp.org>
12 #include <ecoli_malloc.h>
13 #include <ecoli_string.h>
14 #include <ecoli_strvec.h>
15 #include <ecoli_dict.h>
16 #include <ecoli_log.h>
17 #include <ecoli_config.h>
18 #include <ecoli_test.h>
19 #include <ecoli_node.h>
21 #include <ecoli_node_str.h>
22 #include <ecoli_node_seq.h>
23 #include <ecoli_node_or.h>
24 #include <ecoli_node_int.h>
26 EC_LOG_TYPE_REGISTER(node);
29 const struct ec_node_type *type;
30 struct ec_config *config; /**< Generic configuration. */
33 struct ec_dict *attrs;
36 enum ec_node_free_state state; /**< State of loop detection */
37 unsigned int refcnt; /**< Number of reachable references
38 * starting from node beeing freed */
39 } free; /**< Freeing state: used for loop detection */
42 static struct ec_node_type_list node_type_list =
43 TAILQ_HEAD_INITIALIZER(node_type_list);
45 const struct ec_node_type *
46 ec_node_type_lookup(const char *name)
48 struct ec_node_type *type;
50 TAILQ_FOREACH(type, &node_type_list, next) {
51 if (!strcmp(name, type->name))
59 int ec_node_type_register(struct ec_node_type *type)
61 if (ec_node_type_lookup(type->name) != NULL) {
66 TAILQ_INSERT_TAIL(&node_type_list, type, next);
71 void ec_node_type_dump(FILE *out)
73 struct ec_node_type *type;
75 TAILQ_FOREACH(type, &node_type_list, next)
76 fprintf(out, "%s\n", type->name);
79 struct ec_node *ec_node_from_type(const struct ec_node_type *type, const char *id)
81 struct ec_node *node = NULL;
83 EC_LOG(EC_LOG_DEBUG, "create node type=%s id=%s\n",
90 node = ec_calloc(1, sizeof(*node) + type->size);
97 // XXX check that id matches [_a-zA-Z][:-_0-9a-zA-Z]*
98 node->id = ec_strdup(id);
102 if (ec_asprintf(&node->desc, "<%s>", type->name) < 0)
105 node->attrs = ec_dict();
106 if (node->attrs == NULL)
109 if (type->init_priv != NULL) {
110 if (type->init_priv(node) < 0)
118 ec_dict_free(node->attrs);
127 const struct ec_config_schema *
128 ec_node_type_schema(const struct ec_node_type *type)
134 ec_node_type_name(const struct ec_node_type *type)
139 struct ec_node *ec_node(const char *typename, const char *id)
141 const struct ec_node_type *type;
143 type = ec_node_type_lookup(typename);
145 EC_LOG(EC_LOG_ERR, "type=%s does not exist\n",
150 return ec_node_from_type(type, id);
153 static void count_references(struct ec_node *node, unsigned int refs)
155 struct ec_node *child;
159 if (node->free.state == EC_NODE_FREE_STATE_TRAVERSED) {
160 node->free.refcnt += refs;
163 node->free.refcnt = refs;
164 node->free.state = EC_NODE_FREE_STATE_TRAVERSED;
165 n = ec_node_get_children_count(node);
166 for (i = 0; i < n; i++) {
167 ret = ec_node_get_child(node, i, &child, &refs);
169 count_references(child, refs);
173 static void mark_freeable(struct ec_node *node, enum ec_node_free_state mark)
175 struct ec_node *child;
180 if (mark == node->free.state)
183 if (node->refcnt > node->free.refcnt)
184 mark = EC_NODE_FREE_STATE_NOT_FREEABLE;
185 assert(node->refcnt >= node->free.refcnt);
186 node->free.state = mark;
188 n = ec_node_get_children_count(node);
189 for (i = 0; i < n; i++) {
190 ret = ec_node_get_child(node, i, &child, &refs);
192 mark_freeable(child, mark);
196 static void reset_mark(struct ec_node *node)
198 struct ec_node *child;
203 if (node->free.state == EC_NODE_FREE_STATE_NONE)
206 node->free.state = EC_NODE_FREE_STATE_NONE;
207 node->free.refcnt = 0;
209 n = ec_node_get_children_count(node);
210 for (i = 0; i < n; i++) {
211 ret = ec_node_get_child(node, i, &child, &refs);
217 /* free a node, taking care of loops in the node graph */
218 void ec_node_free(struct ec_node *node)
225 assert(node->refcnt > 0);
227 if (node->free.state == EC_NODE_FREE_STATE_NONE &&
230 /* Traverse the node tree starting from this node, and for each
231 * node, count the number of reachable references. Then, all
232 * nodes whose reachable references == total reference are
233 * marked as freeable, and other are marked as unfreeable. Any
234 * node reachable from an unfreeable node is also marked as
236 if (node->free.state == EC_NODE_FREE_STATE_NONE) {
237 count_references(node, 1);
238 mark_freeable(node, EC_NODE_FREE_STATE_FREEABLE);
242 if (node->free.state == EC_NODE_FREE_STATE_NOT_FREEABLE) {
248 if (node->free.state != EC_NODE_FREE_STATE_FREEING) {
249 node->free.state = EC_NODE_FREE_STATE_FREEING;
251 /* children will be freed by config_free() and free_priv() */
252 ec_config_free(node->config);
254 n = ec_node_get_children_count(node);
255 assert(n == 0 || node->type->free_priv != NULL);
256 if (node->type->free_priv != NULL)
257 node->type->free_priv(node);
260 ec_dict_free(node->attrs);
264 if (node->refcnt != 0)
267 node->free.state = EC_NODE_FREE_STATE_NONE;
268 node->free.refcnt = 0;
273 struct ec_node *ec_node_clone(struct ec_node *node)
280 size_t ec_node_get_children_count(const struct ec_node *node)
282 if (node->type->get_children_count == NULL)
284 return node->type->get_children_count(node);
288 ec_node_get_child(const struct ec_node *node, size_t i,
289 struct ec_node **child, unsigned int *refs)
293 if (node->type->get_child == NULL)
295 return node->type->get_child(node, i, child, refs);
299 ec_node_set_config(struct ec_node *node, struct ec_config *config)
301 if (node->type->schema == NULL) {
305 if (ec_config_validate(config, node->type->schema) < 0)
307 if (node->type->set_config != NULL) {
308 if (node->type->set_config(node, config) < 0)
312 ec_config_free(node->config);
313 node->config = config;
318 ec_config_free(config);
322 const struct ec_config *ec_node_get_config(struct ec_node *node)
327 struct ec_node *ec_node_find(struct ec_node *node, const char *id)
329 struct ec_node *child, *retnode;
330 const char *node_id = ec_node_id(node);
335 if (id != NULL && node_id != NULL && !strcmp(node_id, id))
338 n = ec_node_get_children_count(node);
339 for (i = 0; i < n; i++) {
340 ret = ec_node_get_child(node, i, &child, &refs);
342 retnode = ec_node_find(child, id);
350 const struct ec_node_type *ec_node_type(const struct ec_node *node)
355 struct ec_dict *ec_node_attrs(const struct ec_node *node)
360 const char *ec_node_id(const struct ec_node *node)
365 static void __ec_node_dump(FILE *out,
366 const struct ec_node *node, size_t indent, struct ec_dict *dict)
368 const char *id, *typename;
369 struct ec_node *child;
375 id = ec_node_id(node);
376 typename = node->type->name;
378 snprintf(buf, sizeof(buf), "%p", node);
379 if (ec_dict_has_key(dict, buf)) {
380 fprintf(out, "%*s" "type=%s id=%s %p... (loop)\n",
381 (int)indent * 4, "", typename, id, node);
385 ec_dict_set(dict, buf, NULL, NULL);
386 fprintf(out, "%*s" "type=%s id=%s %p refs=%u free_state=%d free_refs=%d\n",
387 (int)indent * 4, "", typename, id, node, node->refcnt,
388 node->free.state, node->free.refcnt);
390 n = ec_node_get_children_count(node);
391 for (i = 0; i < n; i++) {
392 ret = ec_node_get_child(node, i, &child, &refs);
394 __ec_node_dump(out, child, indent + 1, dict);
398 /* XXX this is too much debug-oriented, we should have a parameter or 2 funcs */
399 void ec_node_dump(FILE *out, const struct ec_node *node)
401 struct ec_dict *dict = NULL;
403 fprintf(out, "------------------- node dump:\n");
406 fprintf(out, "node is NULL\n");
414 __ec_node_dump(out, node, 0, dict);
421 EC_LOG(EC_LOG_ERR, "failed to dump node\n");
424 const char *ec_node_desc(const struct ec_node *node)
426 if (node->type->desc != NULL)
427 return node->type->desc(node);
432 int ec_node_check_type(const struct ec_node *node,
433 const struct ec_node_type *type)
435 if (strcmp(node->type->name, type->name)) {
443 const char *ec_node_get_type_name(const struct ec_node *node)
445 return node->type->name;
448 void *ec_node_priv(const struct ec_node *node)
452 return (void *)(node + 1);
455 /* LCOV_EXCL_START */
456 static int ec_node_testcase(void)
458 struct ec_node *node = NULL, *expr = NULL;
459 struct ec_node *expr2 = NULL, *val = NULL, *op = NULL, *seq = NULL;
460 const struct ec_node_type *type;
461 struct ec_node *child;
469 node = EC_NODE_SEQ(EC_NO_ID,
470 ec_node_str("id_x", "x"),
471 ec_node_str("id_y", "y"));
478 f = open_memstream(&buf, &buflen);
481 ec_node_dump(f, node);
482 ec_node_type_dump(f);
483 ec_node_dump(f, NULL);
487 testres |= EC_TEST_CHECK(
488 strstr(buf, "type=seq id=no-id"), "bad dump\n");
489 testres |= EC_TEST_CHECK(
490 strstr(buf, "type=str id=id_x") &&
491 strstr(strstr(buf, "type=str id=id_x") + 1,
497 testres |= EC_TEST_CHECK(
498 !strcmp(ec_node_type(node)->name, "seq") &&
499 !strcmp(ec_node_id(node), EC_NO_ID) &&
500 !strcmp(ec_node_desc(node), "<seq>"),
503 testres |= EC_TEST_CHECK(
504 ec_node_get_children_count(node) == 2,
505 "bad children count\n");
506 ret = ec_node_get_child(node, 0, &child, &refs);
507 testres |= EC_TEST_CHECK(ret == 0 &&
509 !strcmp(ec_node_type(child)->name, "str") &&
510 !strcmp(ec_node_id(child), "id_x"),
512 ret = ec_node_get_child(node, 1, &child, &refs);
513 testres |= EC_TEST_CHECK(ret == 0 &&
515 !strcmp(ec_node_type(child)->name, "str") &&
516 !strcmp(ec_node_id(child), "id_y"),
518 ret = ec_node_get_child(node, 2, &child, &refs);
519 testres |= EC_TEST_CHECK(ret != 0,
520 "ret should be != 0");
521 testres |= EC_TEST_CHECK(child == NULL,
522 "child 2 should be NULL");
524 child = ec_node_find(node, "id_x");
525 testres |= EC_TEST_CHECK(child != NULL &&
526 !strcmp(ec_node_type(child)->name, "str") &&
527 !strcmp(ec_node_id(child), "id_x") &&
528 !strcmp(ec_node_desc(child), "x"),
530 child = ec_node_find(node, "id_dezdex");
531 testres |= EC_TEST_CHECK(child == NULL,
532 "child with wrong id should be NULL");
534 ret = ec_dict_set(ec_node_attrs(node), "key", "val", NULL);
535 testres |= EC_TEST_CHECK(ret == 0,
536 "cannot set node attribute\n");
538 type = ec_node_type_lookup("seq");
539 testres |= EC_TEST_CHECK(type != NULL &&
540 ec_node_check_type(node, type) == 0,
541 "cannot get seq node type");
542 type = ec_node_type_lookup("str");
543 testres |= EC_TEST_CHECK(type != NULL &&
544 ec_node_check_type(node, type) < 0,
545 "node type should not be str");
550 node = ec_node("deznuindez", EC_NO_ID);
551 testres |= EC_TEST_CHECK(node == NULL,
552 "should not be able to create node\n");
555 expr = ec_node("or", EC_NO_ID);
556 val = ec_node_int(EC_NO_ID, 0, 10, 0);
557 op = ec_node_str(EC_NO_ID, "!");
558 seq = EC_NODE_SEQ(EC_NO_ID,
560 ec_node_clone(expr));
562 if (expr == NULL || val == NULL || seq == NULL)
564 if (ec_node_or_add(expr, ec_node_clone(seq)) < 0)
568 if (ec_node_or_add(expr, ec_node_clone(val)) < 0)
573 testres |= EC_TEST_CHECK_PARSE(expr, 1, "1");
574 testres |= EC_TEST_CHECK_PARSE(expr, 3, "!", "!", "1");
575 testres |= EC_TEST_CHECK_PARSE(expr, -1, "!", "!", "!");
580 /* same loop test, but keep some refs (released later) */
581 expr = ec_node("or", EC_NO_ID);
584 val = ec_node_int(EC_NO_ID, 0, 10, 0);
585 op = ec_node_str(EC_NO_ID, "!");
586 seq = EC_NODE_SEQ(EC_NO_ID,
588 ec_node_clone(expr));
590 if (expr == NULL || val == NULL || seq == NULL)
592 if (ec_node_or_add(expr, ec_node_clone(seq)) < 0)
596 if (ec_node_or_add(expr, ec_node_clone(val)) < 0)
599 testres |= EC_TEST_CHECK_PARSE(expr, 1, "1");
600 testres |= EC_TEST_CHECK_PARSE(expr, 3, "!", "!", "1");
601 testres |= EC_TEST_CHECK_PARSE(expr, -1, "!", "!", "!");
627 static struct ec_test ec_node_test = {
629 .test = ec_node_testcase,
632 EC_TEST_REGISTER(ec_node_test);