src/core/memstore-private.h

   1 /*
   2  * SysDB - src/core/memstore-private.h
   3  * Copyright (C) 2012-2013 Sebastian 'tokkee' Harl <sh@tokkee.org>
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  16  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  17  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  18  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
  19  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  22  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  23  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  24  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  25  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 /*
  29  * private data structures used by the memstore module
  30  */
  31
  32 #ifndef SDB_CORE_MEMSTORE_PRIVATE_H
  33 #define SDB_CORE_MEMSTORE_PRIVATE_H 1
  34
  35 #include "core/memstore.h"
  36 #include "core/store.h"
  37 #include "utils/avltree.h"
  38
  39 #include <sys/types.h>
  40 #include <regex.h>
  41
  42 #ifdef __cplusplus
  43 extern "C" {
  44 #endif
  45
  46 /*
  47  * core types
  48  */
  49
  50 struct sdb_memstore_obj {
  51         sdb_object_t super;
  52 #define _name super.name
  53
  54         /* object type */
  55         int type;
  56
  57         /* common meta information */
  58         sdb_time_t last_update;
  59         sdb_time_t interval; /* moving average */
  60         char **backends;
  61         size_t backends_num;
  62         sdb_memstore_obj_t *parent;
  63 };
  64 #define STORE_OBJ(obj) ((sdb_memstore_obj_t *)(obj))
  65 #define STORE_CONST_OBJ(obj) ((const sdb_memstore_obj_t *)(obj))
  66
  67 typedef struct {
  68         sdb_memstore_obj_t super;
  69
  70         sdb_data_t value;
  71 } attr_t;
  72 #define ATTR(obj) ((attr_t *)(obj))
  73 #define CONST_ATTR(obj) ((const attr_t *)(obj))
  74
  75 typedef struct {
  76         sdb_memstore_obj_t super;
  77
  78         sdb_avltree_t *attributes;
  79 } service_t;
  80 #define SVC(obj) ((service_t *)(obj))
  81 #define CONST_SVC(obj) ((const service_t *)(obj))
  82
  83 typedef struct {
  84         sdb_memstore_obj_t super;
  85
  86         sdb_avltree_t *attributes;
  87         struct {
  88                 char *type;
  89                 char *id;
  90                 sdb_time_t last_update;
  91         } store;
  92 } metric_t;
  93 #define METRIC(obj) ((metric_t *)(obj))
  94
  95 typedef struct {
  96         sdb_memstore_obj_t super;
  97
  98         sdb_avltree_t *services;
  99         sdb_avltree_t *metrics;
 100         sdb_avltree_t *attributes;
 101 } host_t;
 102 #define HOST(obj) ((host_t *)(obj))
 103 #define CONST_HOST(obj) ((const host_t *)(obj))
 104
 105 /* shortcuts for accessing service/host attributes */
 106 #define _last_update super.last_update
 107 #define _interval super.interval
 108
 109 /*
 110  * querying
 111  */
 112
 113 struct sdb_memstore_query {
 114         sdb_object_t super;
 115         sdb_ast_node_t *ast;
 116         sdb_memstore_matcher_t *matcher;
 117         sdb_memstore_matcher_t *filter;
 118 };
 119 #define QUERY(m) ((sdb_memstore_query_t *)(m))
 120
 121 /*
 122  * expressions
 123  */
 124
 125 enum {
 126         TYPED_EXPR  = -3, /* obj type stored in data.data.integer */
 127         ATTR_VALUE  = -2, /* attr name stored in data.data.string */
 128         FIELD_VALUE = -1, /* field type stored in data.data.integer */
 129         /*  0: const value (stored in data) */
 130         /* >0: operator id */
 131 };
 132
 133 struct sdb_memstore_expr {
 134         sdb_object_t super;
 135
 136         int type; /* see above */
 137         int data_type;
 138
 139         sdb_memstore_expr_t *left;
 140         sdb_memstore_expr_t *right;
 141
 142         sdb_data_t data;
 143 };
 144 #define CONST_EXPR(v) { SDB_OBJECT_INIT, 0, (v).type, NULL, NULL, (v) }
 145 #define EXPR_TO_STRING(e) \
 146         (((e)->type == TYPED_EXPR) ? "<typed>" \
 147                 : ((e)->type == ATTR_VALUE) ? "attribute" \
 148                 : ((e)->type == FIELD_VALUE) ? SDB_FIELD_TO_NAME((e)->data.data.integer) \
 149                 : ((e)->type == 0) ? "<constant>" \
 150                 : ((e)->type > 0) ? SDB_DATA_OP_TO_STRING((e)->type) \
 151                 : "<unknown>")
 152
 153 /*
 154  * matchers
 155  */
 156
 157 /* when adding to this, also update 'MATCHER_SYM' below and 'matchers' in
 158  * memstore_lookup.c */
 159 enum {
 160         MATCHER_OR,
 161         MATCHER_AND,
 162         MATCHER_NOT,
 163         MATCHER_ANY,
 164         MATCHER_ALL,
 165         MATCHER_IN,
 166
 167         /* unary operators */
 168         MATCHER_ISNULL,
 169         MATCHER_ISTRUE,
 170         MATCHER_ISFALSE,
 171
 172         /* ary operators */
 173         MATCHER_LT,
 174         MATCHER_LE,
 175         MATCHER_EQ,
 176         MATCHER_NE,
 177         MATCHER_GE,
 178         MATCHER_GT,
 179         MATCHER_REGEX,
 180         MATCHER_NREGEX,
 181
 182         /* a generic query */
 183         MATCHER_QUERY,
 184 };
 185
 186 #define MATCHER_SYM(t) \
 187         (((t) == MATCHER_OR) ? "OR" \
 188                 : ((t) == MATCHER_AND) ? "AND" \
 189                 : ((t) == MATCHER_NOT) ? "NOT" \
 190                 : ((t) == MATCHER_ANY) ? "ANY" \
 191                 : ((t) == MATCHER_ALL) ? "ALL" \
 192                 : ((t) == MATCHER_IN) ? "IN" \
 193                 : ((t) == MATCHER_ISNULL) ? "IS NULL" \
 194                 : ((t) == MATCHER_ISTRUE) ? "IS TRUE" \
 195                 : ((t) == MATCHER_ISFALSE) ? "IS FALSE" \
 196                 : ((t) == MATCHER_LT) ? "<" \
 197                 : ((t) == MATCHER_LE) ? "<=" \
 198                 : ((t) == MATCHER_EQ) ? "=" \
 199                 : ((t) == MATCHER_NE) ? "!=" \
 200                 : ((t) == MATCHER_GE) ? ">=" \
 201                 : ((t) == MATCHER_GT) ? ">" \
 202                 : ((t) == MATCHER_REGEX) ? "=~" \
 203                 : ((t) == MATCHER_NREGEX) ? "!~" \
 204                 : ((t) == MATCHER_QUERY) ? "QUERY" \
 205                 : "UNKNOWN")
 206
 207 /* matcher base type */
 208 struct sdb_memstore_matcher {
 209         sdb_object_t super;
 210         /* type of the matcher */
 211         int type;
 212 };
 213 #define M(m) ((sdb_memstore_matcher_t *)(m))
 214
 215 /* infix operator matcher */
 216 typedef struct {
 217         sdb_memstore_matcher_t super;
 218
 219         /* left and right hand operands */
 220         sdb_memstore_matcher_t *left;
 221         sdb_memstore_matcher_t *right;
 222 } op_matcher_t;
 223 #define OP_M(m) ((op_matcher_t *)(m))
 224
 225 /* unary operator matcher */
 226 typedef struct {
 227         sdb_memstore_matcher_t super;
 228
 229         /* operand */
 230         sdb_memstore_matcher_t *op;
 231 } uop_matcher_t;
 232 #define UOP_M(m) ((uop_matcher_t *)(m))
 233
 234 /* iter matcher */
 235 typedef struct {
 236         sdb_memstore_matcher_t super;
 237         sdb_memstore_expr_t *iter;
 238         sdb_memstore_matcher_t *m;
 239 } iter_matcher_t;
 240 #define ITER_M(m) ((iter_matcher_t *)(m))
 241
 242 /* compare operator matcher */
 243 typedef struct {
 244         sdb_memstore_matcher_t super;
 245
 246         /* left and right hand expressions */
 247         sdb_memstore_expr_t *left;
 248         sdb_memstore_expr_t *right;
 249 } cmp_matcher_t;
 250 #define CMP_M(m) ((cmp_matcher_t *)(m))
 251
 252 typedef struct {
 253         sdb_memstore_matcher_t super;
 254         sdb_memstore_expr_t *expr;
 255 } unary_matcher_t;
 256 #define UNARY_M(m) ((unary_matcher_t *)(m))
 257
 258 #ifdef __cplusplus
 259 } /* extern "C" */
 260 #endif
 261
 262 #endif /* ! SDB_CORE_MEMSTORE_H */
 263
 264 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */
 265