lib/ecoli_node.h

   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 #ifndef ECOLI_NODE_
  29 #define ECOLI_NODE_
  30
  31 #include <sys/queue.h>
  32 #include <sys/types.h>
  33 #include <stdio.h>
  34
  35 #define EC_NODE_ENDLIST ((void *)1)
  36
  37 struct ec_node;
  38 struct ec_parsed;
  39 struct ec_completed;
  40 struct ec_strvec;
  41 struct ec_keyval;
  42
  43 #define EC_NODE_TYPE_REGISTER(t)                                                \
  44         static void ec_node_init_##t(void);                             \
  45         static void __attribute__((constructor, used))                  \
  46         ec_node_init_##t(void)                                          \
  47         {                                                               \
  48                 if (ec_node_type_register(&t) < 0)                      \
  49                         fprintf(stderr, "cannot register %s\n", t.name); \
  50         }
  51
  52 TAILQ_HEAD(ec_node_type_list, ec_node_type);
  53
  54 /* return 0 on success, else -errno. */
  55 typedef int (*ec_node_build_t)(struct ec_node *node);
  56
  57 typedef int (*ec_node_parse_t)(const struct ec_node *node,
  58                         struct ec_parsed *state,
  59                         const struct ec_strvec *strvec);
  60 typedef int (*ec_node_complete_t)(const struct ec_node *node,
  61                                 struct ec_completed *completed_state,
  62                                 struct ec_parsed *parsed_state,
  63                                 const struct ec_strvec *strvec);
  64 typedef size_t (*ec_node_get_max_parse_len_t)(const struct ec_node *node);
  65 typedef const char * (*ec_node_desc_t)(const struct ec_node *);
  66 typedef void (*ec_node_init_priv_t)(struct ec_node *);
  67 typedef void (*ec_node_free_priv_t)(struct ec_node *);
  68
  69 /**
  70  * A structure describing a node type.
  71  */
  72 struct ec_node_type {
  73         TAILQ_ENTRY(ec_node_type) next;  /**< Next in list. */
  74         const char *name;              /**< Node type name. */
  75         ec_node_build_t build; /* (re)build the node, called by generic parse */
  76         ec_node_parse_t parse;
  77         ec_node_complete_t complete;
  78         ec_node_get_max_parse_len_t get_max_parse_len;
  79         ec_node_desc_t desc;
  80         size_t size;
  81         ec_node_init_priv_t init_priv;
  82         ec_node_free_priv_t free_priv;
  83 };
  84
  85 /**
  86  * Register a node type.
  87  *
  88  * @param type
  89  *   A pointer to a ec_test structure describing the test
  90  *   to be registered.
  91  * @return
  92  *   0 on success, negative value on error.
  93  */
  94 int ec_node_type_register(struct ec_node_type *type);
  95
  96 /**
  97  * Lookup node type by name
  98  *
  99  * @param name
 100  *   The name of the node type to search.
 101  * @return
 102  *   The node type if found, or NULL on error.
 103  */
 104 struct ec_node_type *ec_node_type_lookup(const char *name);
 105
 106 /**
 107  * Dump registered log types
 108  */
 109 void ec_node_type_dump(FILE *out);
 110
 111 TAILQ_HEAD(ec_node_list, ec_node);
 112
 113 struct ec_node {
 114         const struct ec_node_type *type;
 115         char *id;
 116         char *desc;
 117         struct ec_keyval *attrs;
 118         /* XXX ensure parent and child are properly set in all nodes */
 119         struct ec_node *parent;
 120         unsigned int refcnt;
 121 #define EC_NODE_F_BUILT 0x0001 /** set if configuration is built */
 122         unsigned int flags;
 123
 124         TAILQ_ENTRY(ec_node) next;
 125         struct ec_node_list children;
 126 };
 127
 128 /* create a new node when the type is known, typically called from the node
 129  * code */
 130 struct ec_node *__ec_node(const struct ec_node_type *type, const char *id);
 131
 132 /* create a_new node node */
 133 struct ec_node *ec_node(const char *typename, const char *id);
 134
 135 struct ec_node *ec_node_clone(struct ec_node *node);
 136 void ec_node_free(struct ec_node *node);
 137
 138 /**
 139  * Get the max len of strvec that can be parsed by this node
 140  *
 141  * If there is no maximum, return SIZE_MAX.
 142  */
 143 size_t ec_node_get_max_parse_len(const struct ec_node *node);
 144
 145 /* XXX add more accessors */
 146 struct ec_keyval *ec_node_attrs(const struct ec_node *node);
 147 struct ec_node *ec_node_parent(const struct ec_node *node);
 148 const char *ec_node_id(const struct ec_node *node);
 149 const char *ec_node_desc(const struct ec_node *node);
 150
 151 void ec_node_dump(FILE *out, const struct ec_node *node);
 152 struct ec_node *ec_node_find(struct ec_node *node, const char *id);
 153
 154 #endif