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_strvec.h>
  37 #include <ecoli_keyval.h>
  38 #include <ecoli_log.h>
  39 #include <ecoli_node.h>
  40
  41 EC_LOG_TYPE_REGISTER(node);
  42
  43 static struct ec_node_type_list node_type_list =
  44         TAILQ_HEAD_INITIALIZER(node_type_list);
  45
  46 struct ec_node_type *ec_node_type_lookup(const char *name)
  47 {
  48         struct ec_node_type *type;
  49
  50         TAILQ_FOREACH(type, &node_type_list, next) {
  51                 if (!strcmp(name, type->name))
  52                         return type;
  53         }
  54
  55         return NULL;
  56 }
  57
  58 int ec_node_type_register(struct ec_node_type *type)
  59 {
  60         if (ec_node_type_lookup(type->name) != NULL)
  61                 return -EEXIST;
  62         if (type->size < sizeof(struct ec_node))
  63                 return -EINVAL;
  64
  65         TAILQ_INSERT_TAIL(&node_type_list, type, next);
  66
  67         return 0;
  68 }
  69
  70 void ec_node_type_dump(FILE *out)
  71 {
  72         struct ec_node_type *type;
  73
  74         TAILQ_FOREACH(type, &node_type_list, next)
  75                 fprintf(out, "%s\n", type->name);
  76 }
  77
  78 struct ec_node *__ec_node(const struct ec_node_type *type, const char *id)
  79 {
  80         struct ec_node *node = NULL;
  81         char buf[256]; // XXX
  82
  83         EC_LOG(EC_LOG_DEBUG, "create node type=%s id=%s\n",
  84                 type->name, id);
  85
  86         node = ec_calloc(1, type->size);
  87         if (node == NULL)
  88                 goto fail;
  89
  90         TAILQ_INIT(&node->children);
  91         node->type = type;
  92         node->refcnt = 1;
  93
  94         if (id != NULL) {
  95                 node->id = ec_strdup(id);
  96                 if (node->id == NULL)
  97                         goto fail;
  98         }
  99
 100         snprintf(buf, sizeof(buf), "<%s>", type->name);
 101         node->desc = ec_strdup(buf); // XXX ec_asprintf ?
 102         if (node->desc == NULL)
 103                 goto fail;
 104
 105         node->attrs = ec_keyval();
 106         if (node->attrs == NULL)
 107                 goto fail;
 108
 109         return node;
 110
 111  fail:
 112         ec_node_free(node);
 113         return NULL;
 114 }
 115
 116 struct ec_node *ec_node(const char *typename, const char *id)
 117 {
 118         struct ec_node_type *type;
 119
 120         type = ec_node_type_lookup(typename);
 121         if (type == NULL) {
 122                 EC_LOG(EC_LOG_ERR, "type=%s does not exist\n",
 123                         typename);
 124                 return NULL;
 125         }
 126
 127         return __ec_node(type, id);
 128 }
 129
 130 void ec_node_free(struct ec_node *node)
 131 {
 132         if (node == NULL)
 133                 return;
 134
 135         assert(node->refcnt > 0);
 136
 137         if (--node->refcnt > 0)
 138                 return;
 139
 140         if (node->type != NULL && node->type->free_priv != NULL)
 141                 node->type->free_priv(node);
 142         ec_free(node->id);
 143         ec_free(node->desc);
 144         ec_free(node->attrs);
 145         ec_free(node);
 146 }
 147
 148 size_t ec_node_get_max_parse_len(const struct ec_node *node)
 149 {
 150         if (node->type->get_max_parse_len == NULL)
 151                 return SIZE_MAX;
 152         return node->type->get_max_parse_len(node);
 153 }
 154
 155 struct ec_node *ec_node_clone(struct ec_node *node)
 156 {
 157         if (node != NULL)
 158                 node->refcnt++;
 159         return node;
 160 }
 161
 162 struct ec_node *ec_node_find(struct ec_node *node, const char *id)
 163 {
 164         struct ec_node *child, *ret;
 165         const char *node_id = ec_node_id(node);
 166
 167         if (id != NULL && node_id != NULL && !strcmp(node_id, id))
 168                 return node;
 169
 170         TAILQ_FOREACH(child, &node->children, next) {
 171                 ret = ec_node_find(child, id);
 172                 if (ret != NULL)
 173                         return ret;
 174         }
 175
 176         return NULL;
 177 }
 178
 179 struct ec_keyval *ec_node_attrs(const struct ec_node *node)
 180 {
 181         return node->attrs;
 182 }
 183
 184 const char *ec_node_id(const struct ec_node *node)
 185 {
 186         if (node->id == NULL)
 187                 return "None";
 188         return node->id;
 189 }
 190
 191 struct ec_node *ec_node_parent(const struct ec_node *node)
 192 {
 193         return node->parent;
 194 }
 195
 196 static void __ec_node_dump(FILE *out,
 197         const struct ec_node *node, size_t indent)
 198 {
 199         const char *id, *typename, *desc;
 200         struct ec_node *child;
 201         size_t maxlen;
 202         size_t i;
 203
 204         maxlen = ec_node_get_max_parse_len(node);
 205         id = ec_node_id(node);
 206         typename = node->type->name;
 207         desc = ec_node_desc(node);
 208
 209         /* XXX enhance */
 210         for (i = 0; i < indent; i++) {
 211                 if (i % 2)
 212                         fprintf(out, " ");
 213                 else
 214                         fprintf(out, "|");
 215         }
 216
 217         fprintf(out, "node %p type=%s id=%s desc=%s ",
 218                 node, typename, id, desc);
 219         if (maxlen == SIZE_MAX)
 220                 fprintf(out, "maxlen=no\n");
 221         else
 222                 fprintf(out, "maxlen=%zu\n", maxlen);
 223         TAILQ_FOREACH(child, &node->children, next)
 224                 __ec_node_dump(out, child, indent + 2);
 225 }
 226
 227 void ec_node_dump(FILE *out, const struct ec_node *node)
 228 {
 229         fprintf(out, "------------------- node dump:\n"); //XXX
 230
 231         if (node == NULL) {
 232                 fprintf(out, "node is NULL\n");
 233                 return;
 234         }
 235
 236         __ec_node_dump(out, node, 0);
 237 }
 238
 239 const char *ec_node_desc(const struct ec_node *node)
 240 {
 241         if (node->type->desc != NULL)
 242                 return node->type->desc(node);
 243
 244         return node->desc;
 245 }
 246
 247 int ec_node_check_type(const struct ec_node *node,
 248                 const struct ec_node_type *type)
 249 {
 250         if (strcmp(node->type->name, type->name))
 251                 return -EINVAL;
 252         return 0;
 253 }