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
  24 EC_LOG_TYPE_REGISTER(node);
  25
  26 static struct ec_node_type_list node_type_list =
  27         TAILQ_HEAD_INITIALIZER(node_type_list);
  28
  29 const struct ec_node_type *
  30 ec_node_type_lookup(const char *name)
  31 {
  32         struct ec_node_type *type;
  33
  34         TAILQ_FOREACH(type, &node_type_list, next) {
  35                 if (!strcmp(name, type->name))
  36                         return type;
  37         }
  38
  39         errno = ENOENT;
  40         return NULL;
  41 }
  42
  43 int ec_node_type_register(struct ec_node_type *type)
  44 {
  45         EC_CHECK_ARG(type->size >= sizeof(struct ec_node), -1, EINVAL);
  46
  47         if (ec_node_type_lookup(type->name) != NULL) {
  48                 errno = EEXIST;
  49                 return -1;
  50         }
  51
  52         TAILQ_INSERT_TAIL(&node_type_list, type, next);
  53
  54         return 0;
  55 }
  56
  57 void ec_node_type_dump(FILE *out)
  58 {
  59         struct ec_node_type *type;
  60
  61         TAILQ_FOREACH(type, &node_type_list, next)
  62                 fprintf(out, "%s\n", type->name);
  63 }
  64
  65 struct ec_node *__ec_node(const struct ec_node_type *type, const char *id)
  66 {
  67         struct ec_node *node = NULL;
  68
  69         EC_LOG(EC_LOG_DEBUG, "create node type=%s id=%s\n",
  70                 type->name, id);
  71         if (id == NULL) {
  72                 errno = EINVAL;
  73                 goto fail;
  74         }
  75
  76         node = ec_calloc(1, type->size);
  77         if (node == NULL)
  78                 goto fail;
  79
  80         node->type = type;
  81         node->refcnt = 1;
  82
  83         node->id = ec_strdup(id);
  84         if (node->id == NULL)
  85                 goto fail;
  86
  87         if (ec_asprintf(&node->desc, "<%s>", type->name) < 0)
  88                 goto fail;
  89
  90         node->attrs = ec_keyval();
  91         if (node->attrs == NULL)
  92                 goto fail;
  93
  94         if (type->init_priv != NULL) {
  95                 if (type->init_priv(node) < 0)
  96                         goto fail;
  97         }
  98
  99         return node;
 100
 101  fail:
 102         if (node != NULL) {
 103                 ec_keyval_free(node->attrs);
 104                 ec_free(node->desc);
 105                 ec_free(node->id);
 106         }
 107         ec_free(node);
 108
 109         return NULL;
 110 }
 111
 112 struct ec_node *ec_node(const char *typename, const char *id)
 113 {
 114         const struct ec_node_type *type;
 115
 116         type = ec_node_type_lookup(typename);
 117         if (type == NULL) {
 118                 EC_LOG(EC_LOG_ERR, "type=%s does not exist\n",
 119                         typename);
 120                 return NULL;
 121         }
 122
 123         return __ec_node(type, id);
 124 }
 125
 126 void ec_node_free(struct ec_node *node)
 127 {
 128         if (node == NULL)
 129                 return;
 130
 131         assert(node->refcnt > 0);
 132
 133         if (--node->refcnt > 0)
 134                 return;
 135
 136         if (node->type != NULL && node->type->free_priv != NULL)
 137                 node->type->free_priv(node);
 138         ec_free(node->children);
 139         ec_free(node->id);
 140         ec_free(node->desc);
 141         ec_keyval_free(node->attrs);
 142         ec_config_free(node->config);
 143         ec_free(node);
 144 }
 145
 146 struct ec_node *ec_node_clone(struct ec_node *node)
 147 {
 148         if (node != NULL)
 149                 node->refcnt++;
 150         return node;
 151 }
 152
 153 size_t ec_node_get_children_count(const struct ec_node *node)
 154 {
 155         return node->n_children;
 156 }
 157
 158 struct ec_node *
 159 ec_node_get_child(const struct ec_node *node, size_t i)
 160 {
 161         if (i >= ec_node_get_children_count(node))
 162                 return NULL;
 163         return node->children[i];
 164 }
 165
 166 int ec_node_add_child(struct ec_node *node, struct ec_node *child)
 167 {
 168         struct ec_node **children = NULL;
 169         size_t n;
 170
 171         if (node == NULL || child == NULL) {
 172                 errno = EINVAL;
 173                 goto fail;
 174         }
 175
 176         n = node->n_children;
 177         children = ec_realloc(node->children,
 178                         (n + 1) * sizeof(child));
 179         if (children == NULL)
 180                 goto fail;
 181
 182         children[n] = child;
 183         node->children = children;
 184         node->n_children = n + 1;
 185
 186         return 0;
 187
 188 fail:
 189         ec_free(children);
 190         assert(errno != 0);
 191         return -1;
 192 }
 193
 194 int
 195 ec_node_set_config(struct ec_node *node, struct ec_config *config)
 196 {
 197         if (node->type->schema == NULL) {
 198                 errno = EINVAL;
 199                 goto fail;
 200         }
 201         if (ec_config_validate(config, node->type->schema,
 202                                 node->type->schema_len) < 0)
 203                 goto fail;
 204         if (node->type->set_config != NULL) {
 205                 if (node->type->set_config(node, config) < 0)
 206                         goto fail;
 207         }
 208
 209         ec_config_free(node->config);
 210         node->config = config;
 211
 212         return 0;
 213
 214 fail:
 215         return -1;
 216 }
 217
 218 const struct ec_config *ec_node_get_config(struct ec_node *node)
 219 {
 220         return node->config;
 221 }
 222
 223 #if 0 /* later */
 224 int ec_node_del_child(struct ec_node *node, struct ec_node *child)
 225 {
 226         size_t i, n;
 227
 228         if (node == NULL || child == NULL)
 229                 goto fail;
 230
 231         n = node->n_children;
 232         for (i = 0; i < n; i++) {
 233                 if (node->children[i] != child)
 234                         continue;
 235                 memcpy(&node->children[i], &node->children[i+1],
 236                         (n - i - 1) * sizeof(child));
 237                 return 0;
 238         }
 239
 240 fail:
 241         errno = EINVAL;
 242         return -1;
 243 }
 244 #endif
 245
 246 struct ec_node *ec_node_find(struct ec_node *node, const char *id)
 247 {
 248         struct ec_node *child, *ret;
 249         const char *node_id = ec_node_id(node);
 250         size_t i, n;
 251
 252         if (id != NULL && node_id != NULL && !strcmp(node_id, id))
 253                 return node;
 254
 255         n = node->n_children;
 256         for (i = 0; i < n; i++) {
 257                 child = node->children[i];
 258                 ret = ec_node_find(child, id);
 259                 if (ret != NULL)
 260                         return ret;
 261         }
 262
 263         return NULL;
 264 }
 265
 266 const struct ec_node_type *ec_node_type(const struct ec_node *node)
 267 {
 268         return node->type;
 269 }
 270
 271 struct ec_keyval *ec_node_attrs(const struct ec_node *node)
 272 {
 273         return node->attrs;
 274 }
 275
 276 const char *ec_node_id(const struct ec_node *node)
 277 {
 278         return node->id;
 279 }
 280
 281 static void __ec_node_dump(FILE *out,
 282         const struct ec_node *node, size_t indent)
 283 {
 284         const char *id, *typename;
 285         struct ec_node *child;
 286         size_t i, n;
 287
 288         id = ec_node_id(node);
 289         typename = node->type->name;
 290
 291         fprintf(out, "%*s" "type=%s id=%s %p\n",
 292                 (int)indent * 4, "", typename, id, node);
 293         n = node->n_children;
 294         for (i = 0; i < n; i++) {
 295                 child = node->children[i];
 296                 __ec_node_dump(out, child, indent + 1);
 297         }
 298 }
 299
 300 void ec_node_dump(FILE *out, const struct ec_node *node)
 301 {
 302         fprintf(out, "------------------- node dump:\n");
 303
 304         if (node == NULL) {
 305                 fprintf(out, "node is NULL\n");
 306                 return;
 307         }
 308
 309         __ec_node_dump(out, node, 0);
 310 }
 311
 312 const char *ec_node_desc(const struct ec_node *node)
 313 {
 314         if (node->type->desc != NULL)
 315                 return node->type->desc(node);
 316
 317         return node->desc;
 318 }
 319
 320 int ec_node_check_type(const struct ec_node *node,
 321                 const struct ec_node_type *type)
 322 {
 323         if (strcmp(node->type->name, type->name)) {
 324                 errno = EINVAL;
 325                 return -1;
 326         }
 327
 328         return 0;
 329 }
 330
 331 /* LCOV_EXCL_START */
 332 static int ec_node_testcase(void)
 333 {
 334         struct ec_node *node = NULL;
 335         const struct ec_node *child;
 336         const struct ec_node_type *type;
 337         FILE *f = NULL;
 338         char *buf = NULL;
 339         size_t buflen = 0;
 340         int testres = 0;
 341         int ret;
 342
 343         node = EC_NODE_SEQ(EC_NO_ID,
 344                         ec_node_str("id_x", "x"),
 345                         ec_node_str("id_y", "y"));
 346         if (node == NULL)
 347                 goto fail;
 348
 349         ec_node_clone(node);
 350         ec_node_free(node);
 351
 352         f = open_memstream(&buf, &buflen);
 353         if (f == NULL)
 354                 goto fail;
 355         ec_node_dump(f, node);
 356         ec_node_type_dump(f);
 357         ec_node_dump(f, NULL);
 358         fclose(f);
 359         f = NULL;
 360
 361         testres |= EC_TEST_CHECK(
 362                 strstr(buf, "type=seq id=no-id"), "bad dump\n");
 363         testres |= EC_TEST_CHECK(
 364                 strstr(buf, "type=str id=id_x") &&
 365                 strstr(strstr(buf, "type=str id=id_x") + 1,
 366                         "type=str id=id_y"),
 367                 "bad dump\n");
 368         free(buf);
 369         buf = NULL;
 370
 371         testres |= EC_TEST_CHECK(
 372                 !strcmp(ec_node_type(node)->name, "seq") &&
 373                 !strcmp(ec_node_id(node), EC_NO_ID) &&
 374                 !strcmp(ec_node_desc(node), "<seq>"),
 375                 "bad child 0");
 376
 377         testres |= EC_TEST_CHECK(
 378                 ec_node_get_children_count(node) == 2,
 379                 "bad children count\n");
 380         child = ec_node_get_child(node, 0);
 381         testres |= EC_TEST_CHECK(child != NULL &&
 382                 !strcmp(ec_node_type(child)->name, "str") &&
 383                 !strcmp(ec_node_id(child), "id_x"),
 384                 "bad child 0");
 385         child = ec_node_get_child(node, 1);
 386         testres |= EC_TEST_CHECK(child != NULL &&
 387                 !strcmp(ec_node_type(child)->name, "str") &&
 388                 !strcmp(ec_node_id(child), "id_y"),
 389                 "bad child 1");
 390         child = ec_node_get_child(node, 2);
 391         testres |= EC_TEST_CHECK(child == NULL,
 392                 "child 2 should be NULL");
 393
 394         child = ec_node_find(node, "id_x");
 395         testres |= EC_TEST_CHECK(child != NULL &&
 396                 !strcmp(ec_node_type(child)->name, "str") &&
 397                 !strcmp(ec_node_id(child), "id_x") &&
 398                 !strcmp(ec_node_desc(child), "x"),
 399                 "bad child id_x");
 400         child = ec_node_find(node, "id_dezdex");
 401         testres |= EC_TEST_CHECK(child == NULL,
 402                 "child with wrong id should be NULL");
 403
 404         ret = ec_keyval_set(ec_node_attrs(node), "key", "val", NULL);
 405         testres |= EC_TEST_CHECK(ret == 0,
 406                 "cannot set node attribute\n");
 407
 408         type = ec_node_type_lookup("seq");
 409         testres |= EC_TEST_CHECK(type != NULL &&
 410                 ec_node_check_type(node, type) == 0,
 411                 "cannot get seq node type");
 412         type = ec_node_type_lookup("str");
 413         testres |= EC_TEST_CHECK(type != NULL &&
 414                 ec_node_check_type(node, type) < 0,
 415                 "node type should not be str");
 416
 417         ec_node_free(node);
 418         node = NULL;
 419
 420         node = ec_node("deznuindez", EC_NO_ID);
 421         testres |= EC_TEST_CHECK(node == NULL,
 422                         "should not be able to create node\n");
 423
 424         return testres;
 425
 426 fail:
 427         ec_node_free(node);
 428         if (f != NULL)
 429                 fclose(f);
 430         free(buf);
 431
 432         assert(errno != 0);
 433         return -1;
 434 }
 435 /* LCOV_EXCL_STOP */
 436
 437 static struct ec_test ec_node_test = {
 438         .name = "node",
 439         .test = ec_node_testcase,
 440 };
 441
 442 EC_TEST_REGISTER(ec_node_test);