src/core/store-private.h

   1 /*
   2  * SysDB - src/core/store-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_STORE_PRIVATE_H
  33 #define SDB_CORE_STORE_PRIVATE_H 1
  34
  35 #include "core/store.h"
  36 #include "utils/avltree.h"
  37
  38 #include <sys/types.h>
  39 #include <regex.h>
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 /*
  46  * core types
  47  */
  48
  49 struct sdb_memstore_obj {
  50         sdb_object_t super;
  51 #define _name super.name
  52
  53         /* object type */
  54         int type;
  55
  56         /* common meta information */
  57         sdb_time_t last_update;
  58         sdb_time_t interval; /* moving average */
  59         char **backends;
  60         size_t backends_num;
  61         sdb_memstore_obj_t *parent;
  62 };
  63 #define STORE_OBJ(obj) ((sdb_memstore_obj_t *)(obj))
  64 #define STORE_CONST_OBJ(obj) ((const sdb_memstore_obj_t *)(obj))
  65
  66 typedef struct {
  67         sdb_memstore_obj_t super;
  68
  69         sdb_data_t value;
  70 } attr_t;
  71 #define ATTR(obj) ((attr_t *)(obj))
  72 #define CONST_ATTR(obj) ((const attr_t *)(obj))
  73
  74 typedef struct {
  75         sdb_memstore_obj_t super;
  76
  77         sdb_avltree_t *attributes;
  78 } service_t;
  79 #define SVC(obj) ((service_t *)(obj))
  80 #define CONST_SVC(obj) ((const service_t *)(obj))
  81
  82 typedef struct {
  83         sdb_memstore_obj_t super;
  84
  85         sdb_avltree_t *attributes;
  86         struct {
  87                 char *type;
  88                 char *id;
  89         } store;
  90 } metric_t;
  91 #define METRIC(obj) ((metric_t *)(obj))
  92
  93 typedef struct {
  94         sdb_memstore_obj_t super;
  95
  96         sdb_avltree_t *services;
  97         sdb_avltree_t *metrics;
  98         sdb_avltree_t *attributes;
  99 } host_t;
 100 #define HOST(obj) ((host_t *)(obj))
 101 #define CONST_HOST(obj) ((const host_t *)(obj))
 102
 103 /* shortcuts for accessing service/host attributes */
 104 #define _last_update super.last_update
 105 #define _interval super.interval
 106
 107 /*
 108  * querying
 109  */
 110
 111 struct sdb_memstore_query {
 112         sdb_object_t super;
 113         sdb_ast_node_t *ast;
 114         sdb_memstore_matcher_t *matcher;
 115         sdb_memstore_matcher_t *filter;
 116 };
 117 #define QUERY(m) ((sdb_memstore_query_t *)(m))
 118
 119 /*
 120  * expressions
 121  */
 122
 123 enum {
 124         TYPED_EXPR  = -3, /* obj type stored in data.data.integer */
 125         ATTR_VALUE  = -2, /* attr name stored in data.data.string */
 126         FIELD_VALUE = -1, /* field type stored in data.data.integer */
 127         /*  0: const value (stored in data) */
 128         /* >0: operator id */
 129 };
 130
 131 struct sdb_memstore_expr {
 132         sdb_object_t super;
 133
 134         int type; /* see above */
 135         int data_type;
 136
 137         sdb_memstore_expr_t *left;
 138         sdb_memstore_expr_t *right;
 139
 140         sdb_data_t data;
 141 };
 142 #define CONST_EXPR(v) { SDB_OBJECT_INIT, 0, (v).type, NULL, NULL, (v) }
 143 #define EXPR_TO_STRING(e) \
 144         (((e)->type == TYPED_EXPR) ? "<typed>" \
 145                 : ((e)->type == ATTR_VALUE) ? "attribute" \
 146                 : ((e)->type == FIELD_VALUE) ? SDB_FIELD_TO_NAME((e)->data.data.integer) \
 147                 : ((e)->type == 0) ? "<constant>" \
 148                 : ((e)->type > 0) ? SDB_DATA_OP_TO_STRING((e)->type) \
 149                 : "<unknown>")
 150
 151 /*
 152  * matchers
 153  */
 154
 155 /* when adding to this, also update 'MATCHER_SYM' below and 'matchers' in
 156  * store_lookup.c */
 157 enum {
 158         MATCHER_OR,
 159         MATCHER_AND,
 160         MATCHER_NOT,
 161         MATCHER_ANY,
 162         MATCHER_ALL,
 163         MATCHER_IN,
 164
 165         /* unary operators */
 166         MATCHER_ISNULL,
 167         MATCHER_ISTRUE,
 168         MATCHER_ISFALSE,
 169
 170         /* ary operators */
 171         MATCHER_LT,
 172         MATCHER_LE,
 173         MATCHER_EQ,
 174         MATCHER_NE,
 175         MATCHER_GE,
 176         MATCHER_GT,
 177         MATCHER_REGEX,
 178         MATCHER_NREGEX,
 179
 180         /* a generic query */
 181         MATCHER_QUERY,
 182 };
 183
 184 #define MATCHER_SYM(t) \
 185         (((t) == MATCHER_OR) ? "OR" \
 186                 : ((t) == MATCHER_AND) ? "AND" \
 187                 : ((t) == MATCHER_NOT) ? "NOT" \
 188                 : ((t) == MATCHER_ANY) ? "ANY" \
 189                 : ((t) == MATCHER_ALL) ? "ALL" \
 190                 : ((t) == MATCHER_IN) ? "IN" \
 191                 : ((t) == MATCHER_ISNULL) ? "IS NULL" \
 192                 : ((t) == MATCHER_ISTRUE) ? "IS TRUE" \
 193                 : ((t) == MATCHER_ISFALSE) ? "IS FALSE" \
 194                 : ((t) == MATCHER_LT) ? "<" \
 195                 : ((t) == MATCHER_LE) ? "<=" \
 196                 : ((t) == MATCHER_EQ) ? "=" \
 197                 : ((t) == MATCHER_NE) ? "!=" \
 198                 : ((t) == MATCHER_GE) ? ">=" \
 199                 : ((t) == MATCHER_GT) ? ">" \
 200                 : ((t) == MATCHER_REGEX) ? "=~" \
 201                 : ((t) == MATCHER_NREGEX) ? "!~" \
 202                 : ((t) == MATCHER_QUERY) ? "QUERY" \
 203                 : "UNKNOWN")
 204
 205 /* matcher base type */
 206 struct sdb_memstore_matcher {
 207         sdb_object_t super;
 208         /* type of the matcher */
 209         int type;
 210 };
 211 #define M(m) ((sdb_memstore_matcher_t *)(m))
 212
 213 /* infix operator matcher */
 214 typedef struct {
 215         sdb_memstore_matcher_t super;
 216
 217         /* left and right hand operands */
 218         sdb_memstore_matcher_t *left;
 219         sdb_memstore_matcher_t *right;
 220 } op_matcher_t;
 221 #define OP_M(m) ((op_matcher_t *)(m))
 222
 223 /* unary operator matcher */
 224 typedef struct {
 225         sdb_memstore_matcher_t super;
 226
 227         /* operand */
 228         sdb_memstore_matcher_t *op;
 229 } uop_matcher_t;
 230 #define UOP_M(m) ((uop_matcher_t *)(m))
 231
 232 /* iter matcher */
 233 typedef struct {
 234         sdb_memstore_matcher_t super;
 235         sdb_memstore_expr_t *iter;
 236         sdb_memstore_matcher_t *m;
 237 } iter_matcher_t;
 238 #define ITER_M(m) ((iter_matcher_t *)(m))
 239
 240 /* compare operator matcher */
 241 typedef struct {
 242         sdb_memstore_matcher_t super;
 243
 244         /* left and right hand expressions */
 245         sdb_memstore_expr_t *left;
 246         sdb_memstore_expr_t *right;
 247 } cmp_matcher_t;
 248 #define CMP_M(m) ((cmp_matcher_t *)(m))
 249
 250 typedef struct {
 251         sdb_memstore_matcher_t super;
 252         sdb_memstore_expr_t *expr;
 253 } unary_matcher_t;
 254 #define UNARY_M(m) ((unary_matcher_t *)(m))
 255
 256 #ifdef __cplusplus
 257 } /* extern "C" */
 258 #endif
 259
 260 #endif /* ! SDB_CORE_STORE_H */
 261
 262 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */
 263