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, unsigned int refs)
130 struct ec_node *child;
133 if (node->free.state == EC_NODE_FREE_STATE_TRAVERSED) {
134 node->free.refcnt += refs;
137 node->free.refcnt = refs;
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 refs = ec_node_get_child_refs(node, i);
143 count_references(child, refs);
147 static void mark_freeable(struct ec_node *node, enum ec_node_free_state mark)
149 struct ec_node *child;
152 if (mark == node->free.state)
155 if (node->refcnt > node->free.refcnt)
156 mark = EC_NODE_FREE_STATE_NOT_FREEABLE;
157 assert(node->refcnt >= node->free.refcnt);
158 node->free.state = mark;
160 n = ec_node_get_children_count(node);
161 for (i = 0; i < n; i++) {
162 child = ec_node_get_child(node, i);
163 mark_freeable(child, mark);
167 static void reset_mark(struct ec_node *node)
169 struct ec_node *child;
172 if (node->free.state == EC_NODE_FREE_STATE_NONE)
175 node->free.state = EC_NODE_FREE_STATE_NONE;
176 node->free.refcnt = 0;
178 n = ec_node_get_children_count(node);
179 for (i = 0; i < n; i++) {
180 child = ec_node_get_child(node, i);
185 /* free a node, taking care of loops in the node graph */
186 void ec_node_free(struct ec_node *node)
193 assert(node->refcnt > 0);
195 if (node->free.state == EC_NODE_FREE_STATE_NONE &&
198 /* Traverse the node tree starting from this node, and for each
199 * node, count the number of reachable references. Then, all
200 * nodes whose reachable references == total reference are
201 * marked as freeable, and other are marked as unfreeable. Any
202 * node reachable from an unfreeable node is also marked as
204 if (node->free.state == EC_NODE_FREE_STATE_NONE) {
205 count_references(node, 1);
206 mark_freeable(node, EC_NODE_FREE_STATE_FREEABLE);
210 if (node->free.state == EC_NODE_FREE_STATE_NOT_FREEABLE) {
216 if (node->free.state != EC_NODE_FREE_STATE_FREEING) {
217 node->free.state = EC_NODE_FREE_STATE_FREEING;
218 n = ec_node_get_children_count(node);
219 /* children should be freed by free_priv() */
220 assert(n == 0 || node->type->free_priv != NULL);
221 if (node->type->free_priv != NULL)
222 node->type->free_priv(node);
226 if (node->refcnt != 0)
229 node->free.state = EC_NODE_FREE_STATE_NONE;
230 node->free.refcnt = 0;
234 ec_keyval_free(node->attrs);
235 ec_config_free(node->config);
239 struct ec_node *ec_node_clone(struct ec_node *node)
246 size_t ec_node_get_children_count(const struct ec_node *node)
248 if (node->type->get_children_count == NULL)
250 return node->type->get_children_count(node);
254 ec_node_get_child(const struct ec_node *node, size_t i)
256 if (node->type->get_child == NULL)
258 return node->type->get_child(node, i);
262 ec_node_get_child_refs(const struct ec_node *node, size_t i)
264 if (node->type->get_child_refs == NULL)
266 return node->type->get_child_refs(node, i);
270 ec_node_set_config(struct ec_node *node, struct ec_config *config)
272 if (node->type->schema == NULL) {
276 if (ec_config_validate(config, node->type->schema,
277 node->type->schema_len) < 0)
279 if (node->type->set_config != NULL) {
280 if (node->type->set_config(node, config) < 0)
284 ec_config_free(node->config);
285 node->config = config;
290 ec_config_free(config);
294 const struct ec_config *ec_node_get_config(struct ec_node *node)
299 struct ec_node *ec_node_find(struct ec_node *node, const char *id)
301 struct ec_node *child, *ret;
302 const char *node_id = ec_node_id(node);
305 if (id != NULL && node_id != NULL && !strcmp(node_id, id))
308 n = ec_node_get_children_count(node);
309 for (i = 0; i < n; i++) {
310 child = ec_node_get_child(node, i);
311 ret = ec_node_find(child, id);
319 const struct ec_node_type *ec_node_type(const struct ec_node *node)
324 struct ec_keyval *ec_node_attrs(const struct ec_node *node)
329 const char *ec_node_id(const struct ec_node *node)
334 static void __ec_node_dump(FILE *out,
335 const struct ec_node *node, size_t indent, struct ec_keyval *dict)
337 const char *id, *typename;
338 struct ec_node *child;
342 id = ec_node_id(node);
343 typename = node->type->name;
345 snprintf(buf, sizeof(buf), "%p", node);
346 if (ec_keyval_has_key(dict, buf)) {
347 fprintf(out, "%*s" "type=%s id=%s %p... (loop)\n",
348 (int)indent * 4, "", typename, id, node);
352 ec_keyval_set(dict, buf, NULL, NULL);
353 fprintf(out, "%*s" "type=%s id=%s %p refs=%u free_state=%d free_refs=%d\n",
354 (int)indent * 4, "", typename, id, node, node->refcnt,
355 node->free.state, node->free.refcnt);
357 n = ec_node_get_children_count(node);
358 for (i = 0; i < n; i++) {
359 child = ec_node_get_child(node, i);
360 __ec_node_dump(out, child, indent + 1, dict);
364 void ec_node_dump(FILE *out, const struct ec_node *node)
366 struct ec_keyval *dict = NULL;
368 fprintf(out, "------------------- node dump:\n");
371 fprintf(out, "node is NULL\n");
379 __ec_node_dump(out, node, 0, dict);
381 ec_keyval_free(dict);
385 ec_keyval_free(dict);
386 EC_LOG(EC_LOG_ERR, "failed to dump node\n");
389 const char *ec_node_desc(const struct ec_node *node)
391 if (node->type->desc != NULL)
392 return node->type->desc(node);
397 int ec_node_check_type(const struct ec_node *node,
398 const struct ec_node_type *type)
400 if (strcmp(node->type->name, type->name)) {
408 /* LCOV_EXCL_START */
409 static int ec_node_testcase(void)
411 struct ec_node *node = NULL, *expr = NULL;
412 struct ec_node *expr2 = NULL, *val = NULL, *op = NULL, *seq = NULL;
413 const struct ec_node *child;
414 const struct ec_node_type *type;
421 node = EC_NODE_SEQ(EC_NO_ID,
422 ec_node_str("id_x", "x"),
423 ec_node_str("id_y", "y"));
430 f = open_memstream(&buf, &buflen);
433 ec_node_dump(f, node);
434 ec_node_type_dump(f);
435 ec_node_dump(f, NULL);
439 testres |= EC_TEST_CHECK(
440 strstr(buf, "type=seq id=no-id"), "bad dump\n");
441 testres |= EC_TEST_CHECK(
442 strstr(buf, "type=str id=id_x") &&
443 strstr(strstr(buf, "type=str id=id_x") + 1,
449 testres |= EC_TEST_CHECK(
450 !strcmp(ec_node_type(node)->name, "seq") &&
451 !strcmp(ec_node_id(node), EC_NO_ID) &&
452 !strcmp(ec_node_desc(node), "<seq>"),
455 testres |= EC_TEST_CHECK(
456 ec_node_get_children_count(node) == 2,
457 "bad children count\n");
458 child = ec_node_get_child(node, 0);
459 testres |= EC_TEST_CHECK(child != NULL &&
460 !strcmp(ec_node_type(child)->name, "str") &&
461 !strcmp(ec_node_id(child), "id_x"),
463 child = ec_node_get_child(node, 1);
464 testres |= EC_TEST_CHECK(child != NULL &&
465 !strcmp(ec_node_type(child)->name, "str") &&
466 !strcmp(ec_node_id(child), "id_y"),
468 child = ec_node_get_child(node, 2);
469 testres |= EC_TEST_CHECK(child == NULL,
470 "child 2 should be NULL");
472 child = ec_node_find(node, "id_x");
473 testres |= EC_TEST_CHECK(child != NULL &&
474 !strcmp(ec_node_type(child)->name, "str") &&
475 !strcmp(ec_node_id(child), "id_x") &&
476 !strcmp(ec_node_desc(child), "x"),
478 child = ec_node_find(node, "id_dezdex");
479 testres |= EC_TEST_CHECK(child == NULL,
480 "child with wrong id should be NULL");
482 ret = ec_keyval_set(ec_node_attrs(node), "key", "val", NULL);
483 testres |= EC_TEST_CHECK(ret == 0,
484 "cannot set node attribute\n");
486 type = ec_node_type_lookup("seq");
487 testres |= EC_TEST_CHECK(type != NULL &&
488 ec_node_check_type(node, type) == 0,
489 "cannot get seq node type");
490 type = ec_node_type_lookup("str");
491 testres |= EC_TEST_CHECK(type != NULL &&
492 ec_node_check_type(node, type) < 0,
493 "node type should not be str");
498 node = ec_node("deznuindez", EC_NO_ID);
499 testres |= EC_TEST_CHECK(node == NULL,
500 "should not be able to create node\n");
503 expr = ec_node("or", EC_NO_ID);
504 val = ec_node_int(EC_NO_ID, 0, 10, 0);
505 op = ec_node_str(EC_NO_ID, "!");
506 seq = EC_NODE_SEQ(EC_NO_ID,
508 ec_node_clone(expr));
510 if (expr == NULL || val == NULL || seq == NULL)
512 if (ec_node_or_add(expr, ec_node_clone(seq)) < 0)
516 if (ec_node_or_add(expr, ec_node_clone(val)) < 0)
521 testres |= EC_TEST_CHECK_PARSE(expr, 1, "1");
522 testres |= EC_TEST_CHECK_PARSE(expr, 3, "!", "!", "1");
523 testres |= EC_TEST_CHECK_PARSE(expr, -1, "!", "!", "!");
528 /* same loop test, but keep some refs (released later) */
529 expr = ec_node("or", EC_NO_ID);
532 val = ec_node_int(EC_NO_ID, 0, 10, 0);
533 op = ec_node_str(EC_NO_ID, "!");
534 seq = EC_NODE_SEQ(EC_NO_ID,
536 ec_node_clone(expr));
538 if (expr == NULL || val == NULL || seq == NULL)
540 if (ec_node_or_add(expr, ec_node_clone(seq)) < 0)
544 if (ec_node_or_add(expr, ec_node_clone(val)) < 0)
547 testres |= EC_TEST_CHECK_PARSE(expr, 1, "1");
548 testres |= EC_TEST_CHECK_PARSE(expr, 3, "!", "!", "1");
549 testres |= EC_TEST_CHECK_PARSE(expr, -1, "!", "!", "!");
575 static struct ec_test ec_node_test = {
577 .test = ec_node_testcase,
580 EC_TEST_REGISTER(ec_node_test);