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_keyval.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);
28 static struct ec_node_type_list node_type_list =
29 TAILQ_HEAD_INITIALIZER(node_type_list);
31 const struct ec_node_type *
32 ec_node_type_lookup(const char *name)
34 struct ec_node_type *type;
36 TAILQ_FOREACH(type, &node_type_list, next) {
37 if (!strcmp(name, type->name))
45 int ec_node_type_register(struct ec_node_type *type)
47 EC_CHECK_ARG(type->size >= sizeof(struct ec_node), -1, EINVAL);
49 if (ec_node_type_lookup(type->name) != NULL) {
54 TAILQ_INSERT_TAIL(&node_type_list, type, next);
59 void ec_node_type_dump(FILE *out)
61 struct ec_node_type *type;
63 TAILQ_FOREACH(type, &node_type_list, next)
64 fprintf(out, "%s\n", type->name);
67 struct ec_node *ec_node_from_type(const struct ec_node_type *type, const char *id)
69 struct ec_node *node = NULL;
71 EC_LOG(EC_LOG_DEBUG, "create node type=%s id=%s\n",
78 node = ec_calloc(1, type->size);
85 node->id = ec_strdup(id);
89 if (ec_asprintf(&node->desc, "<%s>", type->name) < 0)
92 node->attrs = ec_keyval();
93 if (node->attrs == NULL)
96 if (type->init_priv != NULL) {
97 if (type->init_priv(node) < 0)
105 ec_keyval_free(node->attrs);
114 const struct ec_config_schema *
115 ec_node_type_schema(const struct ec_node_type *type)
121 ec_node_type_name(const struct ec_node_type *type)
126 struct ec_node *ec_node(const char *typename, const char *id)
128 const struct ec_node_type *type;
130 type = ec_node_type_lookup(typename);
132 EC_LOG(EC_LOG_ERR, "type=%s does not exist\n",
137 return ec_node_from_type(type, id);
140 static void count_references(struct ec_node *node, unsigned int refs)
142 struct ec_node *child;
146 if (node->free.state == EC_NODE_FREE_STATE_TRAVERSED) {
147 node->free.refcnt += refs;
150 node->free.refcnt = refs;
151 node->free.state = EC_NODE_FREE_STATE_TRAVERSED;
152 n = ec_node_get_children_count(node);
153 for (i = 0; i < n; i++) {
154 ret = ec_node_get_child(node, i, &child, &refs);
156 count_references(child, refs);
160 static void mark_freeable(struct ec_node *node, enum ec_node_free_state mark)
162 struct ec_node *child;
167 if (mark == node->free.state)
170 if (node->refcnt > node->free.refcnt)
171 mark = EC_NODE_FREE_STATE_NOT_FREEABLE;
172 assert(node->refcnt >= node->free.refcnt);
173 node->free.state = mark;
175 n = ec_node_get_children_count(node);
176 for (i = 0; i < n; i++) {
177 ret = ec_node_get_child(node, i, &child, &refs);
179 mark_freeable(child, mark);
183 static void reset_mark(struct ec_node *node)
185 struct ec_node *child;
190 if (node->free.state == EC_NODE_FREE_STATE_NONE)
193 node->free.state = EC_NODE_FREE_STATE_NONE;
194 node->free.refcnt = 0;
196 n = ec_node_get_children_count(node);
197 for (i = 0; i < n; i++) {
198 ret = ec_node_get_child(node, i, &child, &refs);
204 /* free a node, taking care of loops in the node graph */
205 void ec_node_free(struct ec_node *node)
212 assert(node->refcnt > 0);
214 if (node->free.state == EC_NODE_FREE_STATE_NONE &&
217 /* Traverse the node tree starting from this node, and for each
218 * node, count the number of reachable references. Then, all
219 * nodes whose reachable references == total reference are
220 * marked as freeable, and other are marked as unfreeable. Any
221 * node reachable from an unfreeable node is also marked as
223 if (node->free.state == EC_NODE_FREE_STATE_NONE) {
224 count_references(node, 1);
225 mark_freeable(node, EC_NODE_FREE_STATE_FREEABLE);
229 if (node->free.state == EC_NODE_FREE_STATE_NOT_FREEABLE) {
235 if (node->free.state != EC_NODE_FREE_STATE_FREEING) {
236 node->free.state = EC_NODE_FREE_STATE_FREEING;
237 n = ec_node_get_children_count(node);
238 /* children should be freed by free_priv() */
239 assert(n == 0 || node->type->free_priv != NULL);
240 if (node->type->free_priv != NULL)
241 node->type->free_priv(node);
245 if (node->refcnt != 0)
248 node->free.state = EC_NODE_FREE_STATE_NONE;
249 node->free.refcnt = 0;
253 ec_keyval_free(node->attrs);
254 ec_config_free(node->config);
258 struct ec_node *ec_node_clone(struct ec_node *node)
265 size_t ec_node_get_children_count(const struct ec_node *node)
267 if (node->type->get_children_count == NULL)
269 return node->type->get_children_count(node);
273 ec_node_get_child(const struct ec_node *node, size_t i,
274 struct ec_node **child, unsigned int *refs)
278 if (node->type->get_child == NULL)
280 return node->type->get_child(node, i, child, refs);
284 ec_node_set_config(struct ec_node *node, struct ec_config *config)
286 if (node->type->schema == NULL) {
290 if (ec_config_validate(config, node->type->schema) < 0)
292 if (node->type->set_config != NULL) {
293 if (node->type->set_config(node, config) < 0)
297 ec_config_free(node->config);
298 node->config = config;
303 ec_config_free(config);
307 const struct ec_config *ec_node_get_config(struct ec_node *node)
312 struct ec_node *ec_node_find(struct ec_node *node, const char *id)
314 struct ec_node *child, *retnode;
315 const char *node_id = ec_node_id(node);
320 if (id != NULL && node_id != NULL && !strcmp(node_id, id))
323 n = ec_node_get_children_count(node);
324 for (i = 0; i < n; i++) {
325 ret = ec_node_get_child(node, i, &child, &refs);
327 retnode = ec_node_find(child, id);
335 const struct ec_node_type *ec_node_type(const struct ec_node *node)
340 struct ec_keyval *ec_node_attrs(const struct ec_node *node)
345 const char *ec_node_id(const struct ec_node *node)
350 static void __ec_node_dump(FILE *out,
351 const struct ec_node *node, size_t indent, struct ec_keyval *dict)
353 const char *id, *typename;
354 struct ec_node *child;
360 id = ec_node_id(node);
361 typename = node->type->name;
363 snprintf(buf, sizeof(buf), "%p", node);
364 if (ec_keyval_has_key(dict, buf)) {
365 fprintf(out, "%*s" "type=%s id=%s %p... (loop)\n",
366 (int)indent * 4, "", typename, id, node);
370 ec_keyval_set(dict, buf, NULL, NULL);
371 fprintf(out, "%*s" "type=%s id=%s %p refs=%u free_state=%d free_refs=%d\n",
372 (int)indent * 4, "", typename, id, node, node->refcnt,
373 node->free.state, node->free.refcnt);
375 n = ec_node_get_children_count(node);
376 for (i = 0; i < n; i++) {
377 ret = ec_node_get_child(node, i, &child, &refs);
379 __ec_node_dump(out, child, indent + 1, dict);
383 void ec_node_dump(FILE *out, const struct ec_node *node)
385 struct ec_keyval *dict = NULL;
387 fprintf(out, "------------------- node dump:\n");
390 fprintf(out, "node is NULL\n");
398 __ec_node_dump(out, node, 0, dict);
400 ec_keyval_free(dict);
404 ec_keyval_free(dict);
405 EC_LOG(EC_LOG_ERR, "failed to dump node\n");
408 const char *ec_node_desc(const struct ec_node *node)
410 if (node->type->desc != NULL)
411 return node->type->desc(node);
416 int ec_node_check_type(const struct ec_node *node,
417 const struct ec_node_type *type)
419 if (strcmp(node->type->name, type->name)) {
427 /* LCOV_EXCL_START */
428 static int ec_node_testcase(void)
430 struct ec_node *node = NULL, *expr = NULL;
431 struct ec_node *expr2 = NULL, *val = NULL, *op = NULL, *seq = NULL;
432 const struct ec_node_type *type;
433 struct ec_node *child;
441 node = EC_NODE_SEQ(EC_NO_ID,
442 ec_node_str("id_x", "x"),
443 ec_node_str("id_y", "y"));
450 f = open_memstream(&buf, &buflen);
453 ec_node_dump(f, node);
454 ec_node_type_dump(f);
455 ec_node_dump(f, NULL);
459 testres |= EC_TEST_CHECK(
460 strstr(buf, "type=seq id=no-id"), "bad dump\n");
461 testres |= EC_TEST_CHECK(
462 strstr(buf, "type=str id=id_x") &&
463 strstr(strstr(buf, "type=str id=id_x") + 1,
469 testres |= EC_TEST_CHECK(
470 !strcmp(ec_node_type(node)->name, "seq") &&
471 !strcmp(ec_node_id(node), EC_NO_ID) &&
472 !strcmp(ec_node_desc(node), "<seq>"),
475 testres |= EC_TEST_CHECK(
476 ec_node_get_children_count(node) == 2,
477 "bad children count\n");
478 ret = ec_node_get_child(node, 0, &child, &refs);
479 testres |= EC_TEST_CHECK(ret == 0 &&
481 !strcmp(ec_node_type(child)->name, "str") &&
482 !strcmp(ec_node_id(child), "id_x"),
484 ret = ec_node_get_child(node, 1, &child, &refs);
485 testres |= EC_TEST_CHECK(ret == 0 &&
487 !strcmp(ec_node_type(child)->name, "str") &&
488 !strcmp(ec_node_id(child), "id_y"),
490 ret = ec_node_get_child(node, 2, &child, &refs);
491 testres |= EC_TEST_CHECK(ret != 0,
492 "ret should be != 0");
493 testres |= EC_TEST_CHECK(child == NULL,
494 "child 2 should be NULL");
496 child = ec_node_find(node, "id_x");
497 testres |= EC_TEST_CHECK(child != NULL &&
498 !strcmp(ec_node_type(child)->name, "str") &&
499 !strcmp(ec_node_id(child), "id_x") &&
500 !strcmp(ec_node_desc(child), "x"),
502 child = ec_node_find(node, "id_dezdex");
503 testres |= EC_TEST_CHECK(child == NULL,
504 "child with wrong id should be NULL");
506 ret = ec_keyval_set(ec_node_attrs(node), "key", "val", NULL);
507 testres |= EC_TEST_CHECK(ret == 0,
508 "cannot set node attribute\n");
510 type = ec_node_type_lookup("seq");
511 testres |= EC_TEST_CHECK(type != NULL &&
512 ec_node_check_type(node, type) == 0,
513 "cannot get seq node type");
514 type = ec_node_type_lookup("str");
515 testres |= EC_TEST_CHECK(type != NULL &&
516 ec_node_check_type(node, type) < 0,
517 "node type should not be str");
522 node = ec_node("deznuindez", EC_NO_ID);
523 testres |= EC_TEST_CHECK(node == NULL,
524 "should not be able to create node\n");
527 expr = ec_node("or", EC_NO_ID);
528 val = ec_node_int(EC_NO_ID, 0, 10, 0);
529 op = ec_node_str(EC_NO_ID, "!");
530 seq = EC_NODE_SEQ(EC_NO_ID,
532 ec_node_clone(expr));
534 if (expr == NULL || val == NULL || seq == NULL)
536 if (ec_node_or_add(expr, ec_node_clone(seq)) < 0)
540 if (ec_node_or_add(expr, ec_node_clone(val)) < 0)
545 testres |= EC_TEST_CHECK_PARSE(expr, 1, "1");
546 testres |= EC_TEST_CHECK_PARSE(expr, 3, "!", "!", "1");
547 testres |= EC_TEST_CHECK_PARSE(expr, -1, "!", "!", "!");
552 /* same loop test, but keep some refs (released later) */
553 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)
571 testres |= EC_TEST_CHECK_PARSE(expr, 1, "1");
572 testres |= EC_TEST_CHECK_PARSE(expr, 3, "!", "!", "1");
573 testres |= EC_TEST_CHECK_PARSE(expr, -1, "!", "!", "!");
599 static struct ec_test ec_node_test = {
601 .test = ec_node_testcase,
604 EC_TEST_REGISTER(ec_node_test);