lib/ecoli_node.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright 2016, Olivier MATZ <zer0@droids-corp.org>
   3  */
   4
   5 #include <stdio.h>
   6 #include <stdlib.h>
   7 #include <stdint.h>
   8 #include <string.h>
   9 #include <assert.h>
  10 #include <errno.h>
  11
  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>
  20
  21 #include <ecoli_node_str.h>
  22 #include <ecoli_node_seq.h>
  23 #include <ecoli_node_or.h>
  24 #include <ecoli_node_int.h>
  25
  26 EC_LOG_TYPE_REGISTER(node);
  27
  28 static struct ec_node_type_list node_type_list =
  29         TAILQ_HEAD_INITIALIZER(node_type_list);
  30
  31 const struct ec_node_type *
  32 ec_node_type_lookup(const char *name)
  33 {
  34         struct ec_node_type *type;
  35
  36         TAILQ_FOREACH(type, &node_type_list, next) {
  37                 if (!strcmp(name, type->name))
  38                         return type;
  39         }
  40
  41         errno = ENOENT;
  42         return NULL;
  43 }
  44
  45 int ec_node_type_register(struct ec_node_type *type)
  46 {
  47         EC_CHECK_ARG(type->size >= sizeof(struct ec_node), -1, EINVAL);
  48
  49         if (ec_node_type_lookup(type->name) != NULL) {
  50                 errno = EEXIST;
  51                 return -1;
  52         }
  53
  54         TAILQ_INSERT_TAIL(&node_type_list, type, next);
  55
  56         return 0;
  57 }
  58
  59 void ec_node_type_dump(FILE *out)
  60 {
  61         struct ec_node_type *type;
  62
  63         TAILQ_FOREACH(type, &node_type_list, next)
  64                 fprintf(out, "%s\n", type->name);
  65 }
  66
  67 struct ec_node *ec_node_from_type(const struct ec_node_type *type, const char *id)
  68 {
  69         struct ec_node *node = NULL;
  70
  71         EC_LOG(EC_LOG_DEBUG, "create node type=%s id=%s\n",
  72                 type->name, id);
  73         if (id == NULL) {
  74                 errno = EINVAL;
  75                 goto fail;
  76         }
  77
  78         node = ec_calloc(1, type->size);
  79         if (node == NULL)
  80                 goto fail;
  81
  82         node->type = type;
  83         node->refcnt = 1;
  84
  85         node->id = ec_strdup(id);
  86         if (node->id == NULL)
  87                 goto fail;
  88
  89         if (ec_asprintf(&node->desc, "<%s>", type->name) < 0)
  90                 goto fail;
  91
  92         node->attrs = ec_keyval();
  93         if (node->attrs == NULL)
  94                 goto fail;
  95
  96         if (type->init_priv != NULL) {
  97                 if (type->init_priv(node) < 0)
  98                         goto fail;
  99         }
 100
 101         return node;
 102
 103  fail:
 104         if (node != NULL) {
 105                 ec_keyval_free(node->attrs);
 106                 ec_free(node->desc);
 107                 ec_free(node->id);
 108         }
 109         ec_free(node);
 110
 111         return NULL;
 112 }
 113
 114 struct ec_node *ec_node(const char *typename, const char *id)
 115 {
 116         const struct ec_node_type *type;
 117
 118         type = ec_node_type_lookup(typename);
 119         if (type == NULL) {
 120                 EC_LOG(EC_LOG_ERR, "type=%s does not exist\n",
 121                         typename);
 122                 return NULL;
 123         }
 124
 125         return ec_node_from_type(type, id);
 126 }
 127
 128 static void count_references(struct ec_node *node, unsigned int refs)
 129 {
 130         struct ec_node *child;
 131         size_t i, n;
 132         int ret;
 133
 134         if (node->free.state == EC_NODE_FREE_STATE_TRAVERSED) {
 135                 node->free.refcnt += refs;
 136                 return;
 137         }
 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);
 143                 assert(ret == 0);
 144                 count_references(child, refs);
 145         }
 146 }
 147
 148 static void mark_freeable(struct ec_node *node, enum ec_node_free_state mark)
 149 {
 150         struct ec_node *child;
 151         unsigned int refs;
 152         size_t i, n;
 153         int ret;
 154
 155         if (mark == node->free.state)
 156                 return;
 157
 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;
 162
 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);
 166                 assert(ret == 0);
 167                 mark_freeable(child, mark);
 168         }
 169 }
 170
 171 static void reset_mark(struct ec_node *node)
 172 {
 173         struct ec_node *child;
 174         unsigned int refs;
 175         size_t i, n;
 176         int ret;
 177
 178         if (node->free.state == EC_NODE_FREE_STATE_NONE)
 179                 return;
 180
 181         node->free.state = EC_NODE_FREE_STATE_NONE;
 182         node->free.refcnt = 0;
 183
 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);
 187                 assert(ret == 0);
 188                 reset_mark(child);
 189         }
 190 }
 191
 192 /* free a node, taking care of loops in the node graph */
 193 void ec_node_free(struct ec_node *node)
 194 {
 195         size_t n;
 196
 197         if (node == NULL)
 198                 return;
 199
 200         assert(node->refcnt > 0);
 201
 202         if (node->free.state == EC_NODE_FREE_STATE_NONE &&
 203                         node->refcnt != 1) {
 204
 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
 210                  * unfreeable. */
 211                 if (node->free.state == EC_NODE_FREE_STATE_NONE) {
 212                         count_references(node, 1);
 213                         mark_freeable(node, EC_NODE_FREE_STATE_FREEABLE);
 214                 }
 215         }
 216
 217         if (node->free.state == EC_NODE_FREE_STATE_NOT_FREEABLE) {
 218                 node->refcnt--;
 219                 reset_mark(node);
 220                 return;
 221         }
 222
 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);
 230         }
 231
 232         node->refcnt--;
 233         if (node->refcnt != 0)
 234                 return;
 235
 236         node->free.state = EC_NODE_FREE_STATE_NONE;
 237         node->free.refcnt = 0;
 238
 239         ec_free(node->id);
 240         ec_free(node->desc);
 241         ec_keyval_free(node->attrs);
 242         ec_config_free(node->config);
 243         ec_free(node);
 244 }
 245
 246 struct ec_node *ec_node_clone(struct ec_node *node)
 247 {
 248         if (node != NULL)
 249                 node->refcnt++;
 250         return node;
 251 }
 252
 253 size_t ec_node_get_children_count(const struct ec_node *node)
 254 {
 255         if (node->type->get_children_count == NULL)
 256                 return 0;
 257         return node->type->get_children_count(node);
 258 }
 259
 260 int
 261 ec_node_get_child(const struct ec_node *node, size_t i,
 262         struct ec_node **child, unsigned int *refs)
 263 {
 264         *child = NULL;
 265         *refs = 0;
 266         if (node->type->get_child == NULL)
 267                 return -1;
 268         return node->type->get_child(node, i, child, refs);
 269 }
 270
 271 int
 272 ec_node_set_config(struct ec_node *node, struct ec_config *config)
 273 {
 274         if (node->type->schema == NULL) {
 275                 errno = EINVAL;
 276                 goto fail;
 277         }
 278         if (ec_config_validate(config, node->type->schema) < 0)
 279                 goto fail;
 280         if (node->type->set_config != NULL) {
 281                 if (node->type->set_config(node, config) < 0)
 282                         goto fail;
 283         }
 284
 285         ec_config_free(node->config);
 286         node->config = config;
 287
 288         return 0;
 289
 290 fail:
 291         ec_config_free(config);
 292         return -1;
 293 }
 294
 295 const struct ec_config *ec_node_get_config(struct ec_node *node)
 296 {
 297         return node->config;
 298 }
 299
 300 struct ec_node *ec_node_find(struct ec_node *node, const char *id)
 301 {
 302         struct ec_node *child, *retnode;
 303         const char *node_id = ec_node_id(node);
 304         unsigned int refs;
 305         size_t i, n;
 306         int ret;
 307
 308         if (id != NULL && node_id != NULL && !strcmp(node_id, id))
 309                 return node;
 310
 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);
 314                 assert(ret == 0);
 315                 retnode = ec_node_find(child, id);
 316                 if (retnode != NULL)
 317                         return retnode;
 318         }
 319
 320         return NULL;
 321 }
 322
 323 const struct ec_node_type *ec_node_type(const struct ec_node *node)
 324 {
 325         return node->type;
 326 }
 327
 328 struct ec_keyval *ec_node_attrs(const struct ec_node *node)
 329 {
 330         return node->attrs;
 331 }
 332
 333 const char *ec_node_id(const struct ec_node *node)
 334 {
 335         return node->id;
 336 }
 337
 338 static void __ec_node_dump(FILE *out,
 339         const struct ec_node *node, size_t indent, struct ec_keyval *dict)
 340 {
 341         const char *id, *typename;
 342         struct ec_node *child;
 343         unsigned int refs;
 344         char buf[32];
 345         size_t i, n;
 346         int ret;
 347
 348         id = ec_node_id(node);
 349         typename = node->type->name;
 350
 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);
 355                 return;
 356         }
 357
 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);
 362
 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);
 366                 assert(ret == 0);
 367                 __ec_node_dump(out, child, indent + 1, dict);
 368         }
 369 }
 370
 371 void ec_node_dump(FILE *out, const struct ec_node *node)
 372 {
 373         struct ec_keyval *dict = NULL;
 374
 375         fprintf(out, "------------------- node dump:\n");
 376
 377         if (node == NULL) {
 378                 fprintf(out, "node is NULL\n");
 379                 return;
 380         }
 381
 382         dict = ec_keyval();
 383         if (dict == NULL)
 384                 goto fail;
 385
 386         __ec_node_dump(out, node, 0, dict);
 387
 388         ec_keyval_free(dict);
 389         return;
 390
 391 fail:
 392         ec_keyval_free(dict);
 393         EC_LOG(EC_LOG_ERR, "failed to dump node\n");
 394 }
 395
 396 const char *ec_node_desc(const struct ec_node *node)
 397 {
 398         if (node->type->desc != NULL)
 399                 return node->type->desc(node);
 400
 401         return node->desc;
 402 }
 403
 404 int ec_node_check_type(const struct ec_node *node,
 405                 const struct ec_node_type *type)
 406 {
 407         if (strcmp(node->type->name, type->name)) {
 408                 errno = EINVAL;
 409                 return -1;
 410         }
 411
 412         return 0;
 413 }
 414
 415 /* LCOV_EXCL_START */
 416 static int ec_node_testcase(void)
 417 {
 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;
 422         unsigned int refs;
 423         FILE *f = NULL;
 424         char *buf = NULL;
 425         size_t buflen = 0;
 426         int testres = 0;
 427         int ret;
 428
 429         node = EC_NODE_SEQ(EC_NO_ID,
 430                         ec_node_str("id_x", "x"),
 431                         ec_node_str("id_y", "y"));
 432         if (node == NULL)
 433                 goto fail;
 434
 435         ec_node_clone(node);
 436         ec_node_free(node);
 437
 438         f = open_memstream(&buf, &buflen);
 439         if (f == NULL)
 440                 goto fail;
 441         ec_node_dump(f, node);
 442         ec_node_type_dump(f);
 443         ec_node_dump(f, NULL);
 444         fclose(f);
 445         f = NULL;
 446
 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,
 452                         "type=str id=id_y"),
 453                 "bad dump\n");
 454         free(buf);
 455         buf = NULL;
 456
 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>"),
 461                 "bad child 0");
 462
 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 &&
 468                 child != NULL &&
 469                 !strcmp(ec_node_type(child)->name, "str") &&
 470                 !strcmp(ec_node_id(child), "id_x"),
 471                 "bad child 0");
 472         ret = ec_node_get_child(node, 1, &child, &refs);
 473         testres |= EC_TEST_CHECK(ret == 0 &&
 474                 child != NULL &&
 475                 !strcmp(ec_node_type(child)->name, "str") &&
 476                 !strcmp(ec_node_id(child), "id_y"),
 477                 "bad child 1");
 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");
 483
 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"),
 489                 "bad child id_x");
 490         child = ec_node_find(node, "id_dezdex");
 491         testres |= EC_TEST_CHECK(child == NULL,
 492                 "child with wrong id should be NULL");
 493
 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");
 497
 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");
 506
 507         ec_node_free(node);
 508         node = NULL;
 509
 510         node = ec_node("deznuindez", EC_NO_ID);
 511         testres |= EC_TEST_CHECK(node == NULL,
 512                         "should not be able to create node\n");
 513
 514         /* test loop */
 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,
 519                         op,
 520                         ec_node_clone(expr));
 521         op = NULL;
 522         if (expr == NULL || val == NULL || seq == NULL)
 523                 goto fail;
 524         if (ec_node_or_add(expr, ec_node_clone(seq)) < 0)
 525                 goto fail;
 526         ec_node_free(seq);
 527         seq = NULL;
 528         if (ec_node_or_add(expr, ec_node_clone(val)) < 0)
 529                 goto fail;
 530         ec_node_free(val);
 531         val = NULL;
 532
 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, "!", "!", "!");
 536
 537         ec_node_free(expr);
 538         expr = NULL;
 539
 540         /* same loop test, but keep some refs (released later) */
 541         expr = ec_node("or", EC_NO_ID);
 542         ec_node_clone(expr);
 543         expr2 = expr;
 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,
 547                         op,
 548                         ec_node_clone(expr));
 549         op = NULL;
 550         if (expr == NULL || val == NULL || seq == NULL)
 551                 goto fail;
 552         if (ec_node_or_add(expr, ec_node_clone(seq)) < 0)
 553                 goto fail;
 554         ec_node_free(seq);
 555         seq = NULL;
 556         if (ec_node_or_add(expr, ec_node_clone(val)) < 0)
 557                 goto fail;
 558
 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, "!", "!", "!");
 562
 563         ec_node_free(expr2);
 564         expr2 = NULL;
 565         ec_node_free(val);
 566         val = NULL;
 567         ec_node_free(expr);
 568         expr = NULL;
 569
 570         return testres;
 571
 572 fail:
 573         ec_node_free(expr);
 574         ec_node_free(expr2);
 575         ec_node_free(val);
 576         ec_node_free(seq);
 577         ec_node_free(node);
 578         if (f != NULL)
 579                 fclose(f);
 580         free(buf);
 581
 582         assert(errno != 0);
 583         return -1;
 584 }
 585 /* LCOV_EXCL_STOP */
 586
 587 static struct ec_test ec_node_test = {
 588         .name = "node",
 589         .test = ec_node_testcase,
 590 };
 591
 592 EC_TEST_REGISTER(ec_node_test);