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 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_from_type(type, id);
128 static void count_references(struct ec_node *node, unsigned int refs)
130 struct ec_node *child;
134 if (node->free.state == EC_NODE_FREE_STATE_TRAVERSED) {
135 node->free.refcnt += refs;
138 node->free.refcnt = refs;
139 node->free.state = EC_NODE_FREE_STATE_TRAVERSED;
140 n = ec_node_get_children_count(node);
141 for (i = 0; i < n; i++) {
142 ret = ec_node_get_child(node, i, &child, &refs);
144 count_references(child, refs);
148 static void mark_freeable(struct ec_node *node, enum ec_node_free_state mark)
150 struct ec_node *child;
155 if (mark == node->free.state)
158 if (node->refcnt > node->free.refcnt)
159 mark = EC_NODE_FREE_STATE_NOT_FREEABLE;
160 assert(node->refcnt >= node->free.refcnt);
161 node->free.state = mark;
163 n = ec_node_get_children_count(node);
164 for (i = 0; i < n; i++) {
165 ret = ec_node_get_child(node, i, &child, &refs);
167 mark_freeable(child, mark);
171 static void reset_mark(struct ec_node *node)
173 struct ec_node *child;
178 if (node->free.state == EC_NODE_FREE_STATE_NONE)
181 node->free.state = EC_NODE_FREE_STATE_NONE;
182 node->free.refcnt = 0;
184 n = ec_node_get_children_count(node);
185 for (i = 0; i < n; i++) {
186 ret = ec_node_get_child(node, i, &child, &refs);
192 /* free a node, taking care of loops in the node graph */
193 void ec_node_free(struct ec_node *node)
200 assert(node->refcnt > 0);
202 if (node->free.state == EC_NODE_FREE_STATE_NONE &&
205 /* Traverse the node tree starting from this node, and for each
206 * node, count the number of reachable references. Then, all
207 * nodes whose reachable references == total reference are
208 * marked as freeable, and other are marked as unfreeable. Any
209 * node reachable from an unfreeable node is also marked as
211 if (node->free.state == EC_NODE_FREE_STATE_NONE) {
212 count_references(node, 1);
213 mark_freeable(node, EC_NODE_FREE_STATE_FREEABLE);
217 if (node->free.state == EC_NODE_FREE_STATE_NOT_FREEABLE) {
223 if (node->free.state != EC_NODE_FREE_STATE_FREEING) {
224 node->free.state = EC_NODE_FREE_STATE_FREEING;
225 n = ec_node_get_children_count(node);
226 /* children should be freed by free_priv() */
227 assert(n == 0 || node->type->free_priv != NULL);
228 if (node->type->free_priv != NULL)
229 node->type->free_priv(node);
233 if (node->refcnt != 0)
236 node->free.state = EC_NODE_FREE_STATE_NONE;
237 node->free.refcnt = 0;
241 ec_keyval_free(node->attrs);
242 ec_config_free(node->config);
246 struct ec_node *ec_node_clone(struct ec_node *node)
253 size_t ec_node_get_children_count(const struct ec_node *node)
255 if (node->type->get_children_count == NULL)
257 return node->type->get_children_count(node);
261 ec_node_get_child(const struct ec_node *node, size_t i,
262 struct ec_node **child, unsigned int *refs)
266 if (node->type->get_child == NULL)
268 return node->type->get_child(node, i, child, refs);
272 ec_node_set_config(struct ec_node *node, struct ec_config *config)
274 if (node->type->schema == NULL) {
278 if (ec_config_validate(config, node->type->schema) < 0)
280 if (node->type->set_config != NULL) {
281 if (node->type->set_config(node, config) < 0)
285 ec_config_free(node->config);
286 node->config = config;
291 ec_config_free(config);
295 const struct ec_config *ec_node_get_config(struct ec_node *node)
300 struct ec_node *ec_node_find(struct ec_node *node, const char *id)
302 struct ec_node *child, *retnode;
303 const char *node_id = ec_node_id(node);
308 if (id != NULL && node_id != NULL && !strcmp(node_id, id))
311 n = ec_node_get_children_count(node);
312 for (i = 0; i < n; i++) {
313 ret = ec_node_get_child(node, i, &child, &refs);
315 retnode = ec_node_find(child, id);
323 const struct ec_node_type *ec_node_type(const struct ec_node *node)
328 struct ec_keyval *ec_node_attrs(const struct ec_node *node)
333 const char *ec_node_id(const struct ec_node *node)
338 static void __ec_node_dump(FILE *out,
339 const struct ec_node *node, size_t indent, struct ec_keyval *dict)
341 const char *id, *typename;
342 struct ec_node *child;
348 id = ec_node_id(node);
349 typename = node->type->name;
351 snprintf(buf, sizeof(buf), "%p", node);
352 if (ec_keyval_has_key(dict, buf)) {
353 fprintf(out, "%*s" "type=%s id=%s %p... (loop)\n",
354 (int)indent * 4, "", typename, id, node);
358 ec_keyval_set(dict, buf, NULL, NULL);
359 fprintf(out, "%*s" "type=%s id=%s %p refs=%u free_state=%d free_refs=%d\n",
360 (int)indent * 4, "", typename, id, node, node->refcnt,
361 node->free.state, node->free.refcnt);
363 n = ec_node_get_children_count(node);
364 for (i = 0; i < n; i++) {
365 ret = ec_node_get_child(node, i, &child, &refs);
367 __ec_node_dump(out, child, indent + 1, dict);
371 void ec_node_dump(FILE *out, const struct ec_node *node)
373 struct ec_keyval *dict = NULL;
375 fprintf(out, "------------------- node dump:\n");
378 fprintf(out, "node is NULL\n");
386 __ec_node_dump(out, node, 0, dict);
388 ec_keyval_free(dict);
392 ec_keyval_free(dict);
393 EC_LOG(EC_LOG_ERR, "failed to dump node\n");
396 const char *ec_node_desc(const struct ec_node *node)
398 if (node->type->desc != NULL)
399 return node->type->desc(node);
404 int ec_node_check_type(const struct ec_node *node,
405 const struct ec_node_type *type)
407 if (strcmp(node->type->name, type->name)) {
415 /* LCOV_EXCL_START */
416 static int ec_node_testcase(void)
418 struct ec_node *node = NULL, *expr = NULL;
419 struct ec_node *expr2 = NULL, *val = NULL, *op = NULL, *seq = NULL;
420 const struct ec_node_type *type;
421 struct ec_node *child;
429 node = EC_NODE_SEQ(EC_NO_ID,
430 ec_node_str("id_x", "x"),
431 ec_node_str("id_y", "y"));
438 f = open_memstream(&buf, &buflen);
441 ec_node_dump(f, node);
442 ec_node_type_dump(f);
443 ec_node_dump(f, NULL);
447 testres |= EC_TEST_CHECK(
448 strstr(buf, "type=seq id=no-id"), "bad dump\n");
449 testres |= EC_TEST_CHECK(
450 strstr(buf, "type=str id=id_x") &&
451 strstr(strstr(buf, "type=str id=id_x") + 1,
457 testres |= EC_TEST_CHECK(
458 !strcmp(ec_node_type(node)->name, "seq") &&
459 !strcmp(ec_node_id(node), EC_NO_ID) &&
460 !strcmp(ec_node_desc(node), "<seq>"),
463 testres |= EC_TEST_CHECK(
464 ec_node_get_children_count(node) == 2,
465 "bad children count\n");
466 ret = ec_node_get_child(node, 0, &child, &refs);
467 testres |= EC_TEST_CHECK(ret == 0 &&
469 !strcmp(ec_node_type(child)->name, "str") &&
470 !strcmp(ec_node_id(child), "id_x"),
472 ret = ec_node_get_child(node, 1, &child, &refs);
473 testres |= EC_TEST_CHECK(ret == 0 &&
475 !strcmp(ec_node_type(child)->name, "str") &&
476 !strcmp(ec_node_id(child), "id_y"),
478 ret = ec_node_get_child(node, 2, &child, &refs);
479 testres |= EC_TEST_CHECK(ret != 0,
480 "ret should be != 0");
481 testres |= EC_TEST_CHECK(child == NULL,
482 "child 2 should be NULL");
484 child = ec_node_find(node, "id_x");
485 testres |= EC_TEST_CHECK(child != NULL &&
486 !strcmp(ec_node_type(child)->name, "str") &&
487 !strcmp(ec_node_id(child), "id_x") &&
488 !strcmp(ec_node_desc(child), "x"),
490 child = ec_node_find(node, "id_dezdex");
491 testres |= EC_TEST_CHECK(child == NULL,
492 "child with wrong id should be NULL");
494 ret = ec_keyval_set(ec_node_attrs(node), "key", "val", NULL);
495 testres |= EC_TEST_CHECK(ret == 0,
496 "cannot set node attribute\n");
498 type = ec_node_type_lookup("seq");
499 testres |= EC_TEST_CHECK(type != NULL &&
500 ec_node_check_type(node, type) == 0,
501 "cannot get seq node type");
502 type = ec_node_type_lookup("str");
503 testres |= EC_TEST_CHECK(type != NULL &&
504 ec_node_check_type(node, type) < 0,
505 "node type should not be str");
510 node = ec_node("deznuindez", EC_NO_ID);
511 testres |= EC_TEST_CHECK(node == NULL,
512 "should not be able to create node\n");
515 expr = ec_node("or", EC_NO_ID);
516 val = ec_node_int(EC_NO_ID, 0, 10, 0);
517 op = ec_node_str(EC_NO_ID, "!");
518 seq = EC_NODE_SEQ(EC_NO_ID,
520 ec_node_clone(expr));
522 if (expr == NULL || val == NULL || seq == NULL)
524 if (ec_node_or_add(expr, ec_node_clone(seq)) < 0)
528 if (ec_node_or_add(expr, ec_node_clone(val)) < 0)
533 testres |= EC_TEST_CHECK_PARSE(expr, 1, "1");
534 testres |= EC_TEST_CHECK_PARSE(expr, 3, "!", "!", "1");
535 testres |= EC_TEST_CHECK_PARSE(expr, -1, "!", "!", "!");
540 /* same loop test, but keep some refs (released later) */
541 expr = ec_node("or", EC_NO_ID);
544 val = ec_node_int(EC_NO_ID, 0, 10, 0);
545 op = ec_node_str(EC_NO_ID, "!");
546 seq = EC_NODE_SEQ(EC_NO_ID,
548 ec_node_clone(expr));
550 if (expr == NULL || val == NULL || seq == NULL)
552 if (ec_node_or_add(expr, ec_node_clone(seq)) < 0)
556 if (ec_node_or_add(expr, ec_node_clone(val)) < 0)
559 testres |= EC_TEST_CHECK_PARSE(expr, 1, "1");
560 testres |= EC_TEST_CHECK_PARSE(expr, 3, "!", "!", "1");
561 testres |= EC_TEST_CHECK_PARSE(expr, -1, "!", "!", "!");
587 static struct ec_test ec_node_test = {
589 .test = ec_node_testcase,
592 EC_TEST_REGISTER(ec_node_test);