lib/ecoli_node.c

   1 /*
   2  * Copyright (c) 2016, Olivier MATZ <zer0@droids-corp.org>
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  *     * Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *     * Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *     * Neither the name of the University of California, Berkeley nor the
  13  *       names of its contributors may be used to endorse or promote products
  14  *       derived from this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  25  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 #include <stdio.h>
  29 #include <stdlib.h>
  30 #include <stdint.h>
  31 #include <string.h>
  32 #include <assert.h>
  33 #include <errno.h>
  34
  35 #include <ecoli_malloc.h>
  36 #include <ecoli_string.h>
  37 #include <ecoli_strvec.h>
  38 #include <ecoli_keyval.h>
  39 #include <ecoli_log.h>
  40 #include <ecoli_node.h>
  41
  42 EC_LOG_TYPE_REGISTER(node);
  43
  44 static struct ec_node_type_list node_type_list =
  45         TAILQ_HEAD_INITIALIZER(node_type_list);
  46
  47 struct ec_node_type *ec_node_type_lookup(const char *name)
  48 {
  49         struct ec_node_type *type;
  50
  51         TAILQ_FOREACH(type, &node_type_list, next) {
  52                 if (!strcmp(name, type->name))
  53                         return type;
  54         }
  55
  56         return NULL;
  57 }
  58
  59 int ec_node_type_register(struct ec_node_type *type)
  60 {
  61         if (ec_node_type_lookup(type->name) != NULL)
  62                 return -EEXIST;
  63         if (type->size < sizeof(struct ec_node))
  64                 return -EINVAL;
  65
  66         TAILQ_INSERT_TAIL(&node_type_list, type, next);
  67
  68         return 0;
  69 }
  70
  71 void ec_node_type_dump(FILE *out)
  72 {
  73         struct ec_node_type *type;
  74
  75         TAILQ_FOREACH(type, &node_type_list, next)
  76                 fprintf(out, "%s\n", type->name);
  77 }
  78
  79 struct ec_node *__ec_node(const struct ec_node_type *type, const char *id)
  80 {
  81         struct ec_node *node = NULL;
  82
  83         EC_LOG(EC_LOG_DEBUG, "create node type=%s id=%s\n",
  84                 type->name, id);
  85         if (id == NULL) {
  86                 errno = EINVAL;
  87                 goto fail;
  88         }
  89
  90         node = ec_calloc(1, type->size);
  91         if (node == NULL)
  92                 goto fail;
  93
  94         node->type = type;
  95         node->refcnt = 1;
  96
  97         node->id = ec_strdup(id);
  98         if (node->id == NULL)
  99                 goto fail;
 100
 101         if (ec_asprintf(&node->desc, "<%s>", type->name) < 0)
 102                 goto fail;
 103
 104         node->attrs = ec_keyval();
 105         if (node->attrs == NULL)
 106                 goto fail;
 107
 108         if (type->init_priv != NULL) {
 109                 if (type->init_priv(node) < 0)
 110                         goto fail;
 111         }
 112
 113         return node;
 114
 115  fail:
 116         if (node != NULL) {
 117                 ec_keyval_free(node->attrs);
 118                 ec_free(node->desc);
 119                 ec_free(node->id);
 120         }
 121         ec_free(node);
 122
 123         return NULL;
 124 }
 125
 126 struct ec_node *ec_node(const char *typename, const char *id)
 127 {
 128         struct ec_node_type *type;
 129
 130         type = ec_node_type_lookup(typename);
 131         if (type == NULL) {
 132                 EC_LOG(EC_LOG_ERR, "type=%s does not exist\n",
 133                         typename);
 134                 return NULL;
 135         }
 136
 137         return __ec_node(type, id);
 138 }
 139
 140 void ec_node_free(struct ec_node *node)
 141 {
 142         if (node == NULL)
 143                 return;
 144
 145         assert(node->refcnt > 0);
 146
 147         if (--node->refcnt > 0)
 148                 return;
 149
 150         if (node->type != NULL && node->type->free_priv != NULL)
 151                 node->type->free_priv(node);
 152         ec_free(node->children);
 153         ec_free(node->id);
 154         ec_free(node->desc);
 155         ec_free(node->attrs);
 156         ec_free(node);
 157 }
 158
 159 struct ec_node *ec_node_clone(struct ec_node *node)
 160 {
 161         if (node != NULL)
 162                 node->refcnt++;
 163         return node;
 164 }
 165
 166 size_t ec_node_get_children_count(const struct ec_node *node)
 167 {
 168         return node->n_children;
 169 }
 170
 171 struct ec_node *
 172 ec_node_get_child(const struct ec_node *node, size_t i)
 173 {
 174         if (i >= ec_node_get_children_count(node))
 175                 return NULL;
 176         return node->children[i];
 177 }
 178
 179 int ec_node_add_child(struct ec_node *node, struct ec_node *child)
 180 {
 181         struct ec_node **children = NULL;
 182         size_t n;
 183
 184         if (node == NULL || child == NULL) {
 185                 errno = EINVAL;
 186                 goto fail;
 187         }
 188
 189         n = node->n_children;
 190         children = ec_realloc(node->children,
 191                         (n + 1) * sizeof(child));
 192         if (children == NULL)
 193                 goto fail;
 194
 195         children[n] = child;
 196         node->children = children;
 197         node->n_children = n + 1;
 198
 199         return 0;
 200
 201 fail:
 202         ec_free(children);
 203         return -1;
 204 }
 205
 206 int ec_node_del_child(struct ec_node *node, struct ec_node *child)
 207 {
 208         size_t i, n;
 209
 210         if (node == NULL || child == NULL)
 211                 goto fail;
 212
 213         n = node->n_children;
 214         for (i = 0; i < n; i++) {
 215                 if (node->children[i] != child)
 216                         continue;
 217                 memcpy(&node->children[i], &node->children[i+1],
 218                         (n - i - 1) * sizeof(child));
 219                 return 0;
 220         }
 221
 222 fail:
 223         errno = EINVAL;
 224         return -1;
 225 }
 226
 227 struct ec_node *ec_node_find(struct ec_node *node, const char *id)
 228 {
 229         struct ec_node *child, *ret;
 230         const char *node_id = ec_node_id(node);
 231         size_t i, n;
 232
 233         if (id != NULL && node_id != NULL && !strcmp(node_id, id))
 234                 return node;
 235
 236         n = node->n_children;
 237         for (i = 0; i < n; i++) {
 238                 child = node->children[i];
 239                 ret = ec_node_find(child, id);
 240                 if (ret != NULL)
 241                         return ret;
 242         }
 243
 244         return NULL;
 245 }
 246
 247 struct ec_keyval *ec_node_attrs(const struct ec_node *node)
 248 {
 249         return node->attrs;
 250 }
 251
 252 const char *ec_node_id(const struct ec_node *node)
 253 {
 254         if (node->id == NULL)
 255                 return "None";
 256         return node->id;
 257 }
 258
 259 static void __ec_node_dump(FILE *out,
 260         const struct ec_node *node, size_t indent)
 261 {
 262         const char *id, *typename, *desc;
 263         struct ec_node *child;
 264         size_t i, n;
 265
 266         id = ec_node_id(node);
 267         typename = node->type->name;
 268         desc = ec_node_desc(node);
 269
 270         /* XXX enhance */
 271         for (i = 0; i < indent; i++) {
 272                 if (i % 2)
 273                         fprintf(out, " ");
 274                 else
 275                         fprintf(out, "|");
 276         }
 277
 278         fprintf(out, "node %p type=%s id=%s desc=%s\n",
 279                 node, typename, id, desc);
 280         n = node->n_children;
 281         for (i = 0; i < n; i++) {
 282                 child = node->children[i];
 283                 __ec_node_dump(out, child, indent + 2);
 284         }
 285 }
 286
 287 void ec_node_dump(FILE *out, const struct ec_node *node)
 288 {
 289         fprintf(out, "------------------- node dump:\n"); //XXX
 290
 291         if (node == NULL) {
 292                 fprintf(out, "node is NULL\n");
 293                 return;
 294         }
 295
 296         __ec_node_dump(out, node, 0);
 297 }
 298
 299 const char *ec_node_desc(const struct ec_node *node)
 300 {
 301         if (node->type->desc != NULL)
 302                 return node->type->desc(node);
 303
 304         return node->desc;
 305 }
 306
 307 int ec_node_check_type(const struct ec_node *node,
 308                 const struct ec_node_type *type)
 309 {
 310         if (strcmp(node->type->name, type->name)) {
 311                 errno = EINVAL;
 312                 return -1;
 313         }
 314         return 0;
 315 }