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(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 struct ec_node *ec_node(const char *typename, const char *id)
116 const struct ec_node_type *type;
118 type = ec_node_type_lookup(typename);
120 EC_LOG(EC_LOG_ERR, "type=%s does not exist\n",
125 return __ec_node(type, id);
128 static void count_references(struct ec_node *node)
130 struct ec_node *child;
133 if (node->free.state == EC_NODE_FREE_STATE_TRAVERSED) {
137 node->free.refcnt = 1;
138 node->free.state = EC_NODE_FREE_STATE_TRAVERSED;
139 n = ec_node_get_children_count(node);
140 for (i = 0; i < n; i++) {
141 child = ec_node_get_child(node, i);
142 count_references(child);
146 static void mark_freeable(struct ec_node *node, enum ec_node_free_state mark)
148 struct ec_node *child;
151 if (mark == node->free.state)
154 if (node->refcnt != node->free.refcnt)
155 mark = EC_NODE_FREE_STATE_NOT_FREEABLE;
156 node->free.state = mark;
158 n = ec_node_get_children_count(node);
159 for (i = 0; i < n; i++) {
160 child = ec_node_get_child(node, i);
161 mark_freeable(child, mark);
165 static void reset_mark(struct ec_node *node)
167 struct ec_node *child;
170 if (node->free.state == EC_NODE_FREE_STATE_NONE)
173 node->free.state = EC_NODE_FREE_STATE_NONE;
174 node->free.refcnt = 0;
176 n = ec_node_get_children_count(node);
177 for (i = 0; i < n; i++) {
178 child = ec_node_get_child(node, i);
183 /* free a node, taking care of loops in the node graph */
184 void ec_node_free(struct ec_node *node)
186 struct ec_node *child;
192 assert(node->refcnt > 0);
194 if (node->free.state == EC_NODE_FREE_STATE_NONE &&
197 /* Traverse the node tree starting from this node, and for each
198 * node, count the number of reachable references. Then, all
199 * nodes whose reachable references == total reference are
200 * marked as freeable, and other are marked as unfreeable. Any
201 * node reachable from an unfreeable node is also marked as
203 if (node->free.state == EC_NODE_FREE_STATE_NONE) {
204 count_references(node);
205 mark_freeable(node, EC_NODE_FREE_STATE_FREEABLE);
209 if (node->free.state == EC_NODE_FREE_STATE_NOT_FREEABLE) {
215 if (node->free.state != EC_NODE_FREE_STATE_FREEING) {
216 node->free.state = EC_NODE_FREE_STATE_FREEING;
217 n = ec_node_get_children_count(node);
218 for (i = 0; i < n; i++) {
219 child = ec_node_get_child(node, i);
225 if (node->refcnt != 0)
228 node->free.state = EC_NODE_FREE_STATE_NONE;
229 node->free.refcnt = 0;
231 if (node->type != NULL && node->type->free_priv != NULL)
232 node->type->free_priv(node);
235 ec_keyval_free(node->attrs);
236 ec_config_free(node->config);
240 struct ec_node *ec_node_clone(struct ec_node *node)
247 size_t ec_node_get_children_count(const struct ec_node *node)
249 if (node->type->get_children_count == NULL)
251 return node->type->get_children_count(node);
255 ec_node_get_child(const struct ec_node *node, size_t i)
257 if (node->type->get_child == NULL)
259 return node->type->get_child(node, i);
263 ec_node_set_config(struct ec_node *node, struct ec_config *config)
265 if (node->type->schema == NULL) {
269 if (ec_config_validate(config, node->type->schema,
270 node->type->schema_len) < 0)
272 if (node->type->set_config != NULL) {
273 if (node->type->set_config(node, config) < 0)
277 ec_config_free(node->config);
278 node->config = config;
283 ec_config_free(config);
287 const struct ec_config *ec_node_get_config(struct ec_node *node)
292 struct ec_node *ec_node_find(struct ec_node *node, const char *id)
294 struct ec_node *child, *ret;
295 const char *node_id = ec_node_id(node);
298 if (id != NULL && node_id != NULL && !strcmp(node_id, id))
301 n = ec_node_get_children_count(node);
302 for (i = 0; i < n; i++) {
303 child = ec_node_get_child(node, i);
304 ret = ec_node_find(child, id);
312 const struct ec_node_type *ec_node_type(const struct ec_node *node)
317 struct ec_keyval *ec_node_attrs(const struct ec_node *node)
322 const char *ec_node_id(const struct ec_node *node)
327 static void __ec_node_dump(FILE *out,
328 const struct ec_node *node, size_t indent, struct ec_keyval *dict)
330 const char *id, *typename;
331 struct ec_node *child;
335 id = ec_node_id(node);
336 typename = node->type->name;
338 snprintf(buf, sizeof(buf), "%p", node);
339 if (ec_keyval_has_key(dict, buf)) {
340 fprintf(out, "%*s" "type=%s id=%s %p... (loop)\n",
341 (int)indent * 4, "", typename, id, node);
345 ec_keyval_set(dict, buf, NULL, NULL);
346 fprintf(out, "%*s" "type=%s id=%s %p refs=%u free=(%d,%d)\n",
347 (int)indent * 4, "", typename, id, node, node->refcnt,
348 node->free.state, node->free.refcnt);
350 n = ec_node_get_children_count(node);
351 for (i = 0; i < n; i++) {
352 child = ec_node_get_child(node, i);
353 __ec_node_dump(out, child, indent + 1, dict);
357 void ec_node_dump(FILE *out, const struct ec_node *node)
359 struct ec_keyval *dict = NULL;
361 fprintf(out, "------------------- node dump:\n");
364 fprintf(out, "node is NULL\n");
372 __ec_node_dump(out, node, 0, dict);
374 ec_keyval_free(dict);
378 ec_keyval_free(dict);
379 EC_LOG(EC_LOG_ERR, "failed to dump node\n");
382 const char *ec_node_desc(const struct ec_node *node)
384 if (node->type->desc != NULL)
385 return node->type->desc(node);
390 int ec_node_check_type(const struct ec_node *node,
391 const struct ec_node_type *type)
393 if (strcmp(node->type->name, type->name)) {
401 /* LCOV_EXCL_START */
402 static int ec_node_testcase(void)
404 struct ec_node *node = NULL, *expr = NULL;
405 struct ec_node *expr2 = NULL, *val = NULL, *op = NULL, *seq = NULL;
406 const struct ec_node *child;
407 const struct ec_node_type *type;
414 node = EC_NODE_SEQ(EC_NO_ID,
415 ec_node_str("id_x", "x"),
416 ec_node_str("id_y", "y"));
423 f = open_memstream(&buf, &buflen);
426 ec_node_dump(f, node);
427 ec_node_type_dump(f);
428 ec_node_dump(f, NULL);
432 testres |= EC_TEST_CHECK(
433 strstr(buf, "type=seq id=no-id"), "bad dump\n");
434 testres |= EC_TEST_CHECK(
435 strstr(buf, "type=str id=id_x") &&
436 strstr(strstr(buf, "type=str id=id_x") + 1,
442 testres |= EC_TEST_CHECK(
443 !strcmp(ec_node_type(node)->name, "seq") &&
444 !strcmp(ec_node_id(node), EC_NO_ID) &&
445 !strcmp(ec_node_desc(node), "<seq>"),
448 testres |= EC_TEST_CHECK(
449 ec_node_get_children_count(node) == 2,
450 "bad children count\n");
451 child = ec_node_get_child(node, 0);
452 testres |= EC_TEST_CHECK(child != NULL &&
453 !strcmp(ec_node_type(child)->name, "str") &&
454 !strcmp(ec_node_id(child), "id_x"),
456 child = ec_node_get_child(node, 1);
457 testres |= EC_TEST_CHECK(child != NULL &&
458 !strcmp(ec_node_type(child)->name, "str") &&
459 !strcmp(ec_node_id(child), "id_y"),
461 child = ec_node_get_child(node, 2);
462 testres |= EC_TEST_CHECK(child == NULL,
463 "child 2 should be NULL");
465 child = ec_node_find(node, "id_x");
466 testres |= EC_TEST_CHECK(child != NULL &&
467 !strcmp(ec_node_type(child)->name, "str") &&
468 !strcmp(ec_node_id(child), "id_x") &&
469 !strcmp(ec_node_desc(child), "x"),
471 child = ec_node_find(node, "id_dezdex");
472 testres |= EC_TEST_CHECK(child == NULL,
473 "child with wrong id should be NULL");
475 ret = ec_keyval_set(ec_node_attrs(node), "key", "val", NULL);
476 testres |= EC_TEST_CHECK(ret == 0,
477 "cannot set node attribute\n");
479 type = ec_node_type_lookup("seq");
480 testres |= EC_TEST_CHECK(type != NULL &&
481 ec_node_check_type(node, type) == 0,
482 "cannot get seq node type");
483 type = ec_node_type_lookup("str");
484 testres |= EC_TEST_CHECK(type != NULL &&
485 ec_node_check_type(node, type) < 0,
486 "node type should not be str");
491 node = ec_node("deznuindez", EC_NO_ID);
492 testres |= EC_TEST_CHECK(node == NULL,
493 "should not be able to create node\n");
496 expr = ec_node("or", EC_NO_ID);
497 val = ec_node_int(EC_NO_ID, 0, 10, 0);
498 op = ec_node_str(EC_NO_ID, "!");
499 seq = EC_NODE_SEQ(EC_NO_ID,
501 ec_node_clone(expr));
503 if (expr == NULL || val == NULL || seq == NULL)
505 if (ec_node_or_add(expr, ec_node_clone(seq)) < 0)
509 if (ec_node_or_add(expr, ec_node_clone(val)) < 0)
514 testres |= EC_TEST_CHECK_PARSE(expr, 1, "1");
515 testres |= EC_TEST_CHECK_PARSE(expr, 3, "!", "!", "1");
516 testres |= EC_TEST_CHECK_PARSE(expr, -1, "!", "!", "!");
521 /* same loop test, but keep some refs (released later) */
522 expr = ec_node("or", EC_NO_ID);
525 val = ec_node_int(EC_NO_ID, 0, 10, 0);
526 op = ec_node_str(EC_NO_ID, "!");
527 seq = EC_NODE_SEQ(EC_NO_ID,
529 ec_node_clone(expr));
531 if (expr == NULL || val == NULL || seq == NULL)
533 if (ec_node_or_add(expr, ec_node_clone(seq)) < 0)
537 if (ec_node_or_add(expr, ec_node_clone(val)) < 0)
540 testres |= EC_TEST_CHECK_PARSE(expr, 1, "1");
541 testres |= EC_TEST_CHECK_PARSE(expr, 3, "!", "!", "1");
542 testres |= EC_TEST_CHECK_PARSE(expr, -1, "!", "!", "!");
568 static struct ec_test ec_node_test = {
570 .test = ec_node_testcase,
573 EC_TEST_REGISTER(ec_node_test);