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 store 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_store_obj {
  50         sdb_object_t super;
  51
  52         /* object type */
  53         int type;
  54
  55         /* common meta information */
  56         sdb_time_t last_update;
  57         sdb_time_t interval; /* moving average */
  58         char **backends;
  59         size_t backends_num;
  60         sdb_store_obj_t *parent;
  61 };
  62 #define STORE_OBJ(obj) ((sdb_store_obj_t *)(obj))
  63 #define STORE_CONST_OBJ(obj) ((const sdb_store_obj_t *)(obj))
  64
  65 typedef struct {
  66         sdb_store_obj_t super;
  67
  68         sdb_data_t value;
  69 } sdb_attribute_t;
  70 #define ATTR(obj) ((sdb_attribute_t *)(obj))
  71 #define CONST_ATTR(obj) ((const sdb_attribute_t *)(obj))
  72
  73 typedef struct {
  74         sdb_store_obj_t super;
  75
  76         sdb_avltree_t *attributes;
  77 } sdb_service_t;
  78 #define SVC(obj) ((sdb_service_t *)(obj))
  79 #define CONST_SVC(obj) ((const sdb_service_t *)(obj))
  80
  81 typedef struct {
  82         sdb_store_obj_t super;
  83
  84         sdb_avltree_t *attributes;
  85         struct {
  86                 char *type;
  87                 char *id;
  88         } store;
  89 } sdb_metric_t;
  90 #define METRIC(obj) ((sdb_metric_t *)(obj))
  91
  92 typedef struct {
  93         sdb_store_obj_t super;
  94
  95         sdb_avltree_t *services;
  96         sdb_avltree_t *metrics;
  97         sdb_avltree_t *attributes;
  98 } sdb_host_t;
  99 #define HOST(obj) ((sdb_host_t *)(obj))
 100 #define CONST_HOST(obj) ((const sdb_host_t *)(obj))
 101
 102 /* shortcuts for accessing service/host attributes */
 103 #define _last_update super.last_update
 104 #define _interval super.interval
 105
 106 /*
 107  * querying
 108  */
 109
 110 struct sdb_store_query {
 111         sdb_object_t super;
 112         sdb_ast_node_t *ast;
 113         sdb_store_matcher_t *matcher;
 114         sdb_store_matcher_t *filter;
 115 };
 116 #define QUERY(m) ((sdb_store_query_t *)(m))
 117
 118 /*
 119  * expressions
 120  */
 121
 122 enum {
 123         TYPED_EXPR  = -3, /* obj type stored in data.data.integer */
 124         ATTR_VALUE  = -2, /* attr name stored in data.data.string */
 125         FIELD_VALUE = -1, /* field type stored in data.data.integer */
 126         /*  0: const value (stored in data) */
 127         /* >0: operator id */
 128 };
 129
 130 struct sdb_store_expr {
 131         sdb_object_t super;
 132
 133         int type; /* see above */
 134         int data_type;
 135
 136         sdb_store_expr_t *left;
 137         sdb_store_expr_t *right;
 138
 139         sdb_data_t data;
 140 };
 141 #define CONST_EXPR(v) { SDB_OBJECT_INIT, 0, (v).type, NULL, NULL, (v) }
 142 #define EXPR_TO_STRING(e) \
 143         (((e)->type == TYPED_EXPR) ? "<typed>" \
 144                 : ((e)->type == ATTR_VALUE) ? "attribute" \
 145                 : ((e)->type == FIELD_VALUE) ? SDB_FIELD_TO_NAME((e)->data.data.integer) \
 146                 : ((e)->type == 0) ? "<constant>" \
 147                 : ((e)->type > 0) ? SDB_DATA_OP_TO_STRING((e)->type) \
 148                 : "<unknown>")
 149
 150 /*
 151  * matchers
 152  */
 153
 154 /* when adding to this, also update 'MATCHER_SYM' below and 'matchers' in
 155  * store_lookup.c */
 156 enum {
 157         MATCHER_OR,
 158         MATCHER_AND,
 159         MATCHER_NOT,
 160         MATCHER_ANY,
 161         MATCHER_ALL,
 162         MATCHER_IN,
 163         MATCHER_NIN,
 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_NIN) ? "NOT IN" \
 192                 : ((t) == MATCHER_ISNULL) ? "IS NULL" \
 193                 : ((t) == MATCHER_ISTRUE) ? "IS TRUE" \
 194                 : ((t) == MATCHER_ISFALSE) ? "IS FALSE" \
 195                 : ((t) == MATCHER_LT) ? "<" \
 196                 : ((t) == MATCHER_LE) ? "<=" \
 197                 : ((t) == MATCHER_EQ) ? "=" \
 198                 : ((t) == MATCHER_NE) ? "!=" \
 199                 : ((t) == MATCHER_GE) ? ">=" \
 200                 : ((t) == MATCHER_GT) ? ">" \
 201                 : ((t) == MATCHER_REGEX) ? "=~" \
 202                 : ((t) == MATCHER_NREGEX) ? "!~" \
 203                 : ((t) == MATCHER_QUERY) ? "QUERY" \
 204                 : "UNKNOWN")
 205
 206 /* matcher base type */
 207 struct sdb_store_matcher {
 208         sdb_object_t super;
 209         /* type of the matcher */
 210         int type;
 211 };
 212 #define M(m) ((sdb_store_matcher_t *)(m))
 213
 214 /* infix operator matcher */
 215 typedef struct {
 216         sdb_store_matcher_t super;
 217
 218         /* left and right hand operands */
 219         sdb_store_matcher_t *left;
 220         sdb_store_matcher_t *right;
 221 } op_matcher_t;
 222 #define OP_M(m) ((op_matcher_t *)(m))
 223
 224 /* unary operator matcher */
 225 typedef struct {
 226         sdb_store_matcher_t super;
 227
 228         /* operand */
 229         sdb_store_matcher_t *op;
 230 } uop_matcher_t;
 231 #define UOP_M(m) ((uop_matcher_t *)(m))
 232
 233 /* iter matcher */
 234 typedef struct {
 235         sdb_store_matcher_t super;
 236         sdb_store_expr_t *iter;
 237         sdb_store_matcher_t *m;
 238 } iter_matcher_t;
 239 #define ITER_M(m) ((iter_matcher_t *)(m))
 240
 241 /* compare operator matcher */
 242 typedef struct {
 243         sdb_store_matcher_t super;
 244
 245         /* left and right hand expressions */
 246         sdb_store_expr_t *left;
 247         sdb_store_expr_t *right;
 248 } cmp_matcher_t;
 249 #define CMP_M(m) ((cmp_matcher_t *)(m))
 250
 251 typedef struct {
 252         sdb_store_matcher_t super;
 253         sdb_store_expr_t *expr;
 254 } unary_matcher_t;
 255 #define UNARY_M(m) ((unary_matcher_t *)(m))
 256
 257 #ifdef __cplusplus
 258 } /* extern "C" */
 259 #endif
 260
 261 #endif /* ! SDB_CORE_STORE_H */
 262
 263 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */
 264