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  * expressions
 108  */
 109
 110 enum {
 111         TYPED_EXPR  = -3, /* obj type stored in data.data.integer */
 112         ATTR_VALUE  = -2, /* attr name stored in data.data.string */
 113         FIELD_VALUE = -1, /* field type stored in data.data.integer */
 114         /*  0: const value (stored in data) */
 115         /* >0: operator id */
 116 };
 117
 118 struct sdb_store_expr {
 119         sdb_object_t super;
 120
 121         int type; /* see above */
 122         int data_type;
 123
 124         sdb_store_expr_t *left;
 125         sdb_store_expr_t *right;
 126
 127         sdb_data_t data;
 128 };
 129 #define CONST_EXPR(v) { SDB_OBJECT_INIT, 0, (v).type, NULL, NULL, (v) }
 130 #define EXPR_TO_STRING(e) \
 131         (((e)->type == TYPED_EXPR) ? "<typed>" \
 132                 : ((e)->type == ATTR_VALUE) ? "attribute" \
 133                 : ((e)->type == FIELD_VALUE) ? SDB_FIELD_TO_NAME((e)->data.data.integer) \
 134                 : ((e)->type == 0) ? "<constant>" \
 135                 : ((e)->type > 0) ? SDB_DATA_OP_TO_STRING((e)->type) \
 136                 : "<unknown>")
 137
 138 /*
 139  * matchers
 140  */
 141
 142 /* when adding to this, also update 'MATCHER_SYM' below and 'matchers' in
 143  * store_lookup.c */
 144 enum {
 145         MATCHER_OR,
 146         MATCHER_AND,
 147         MATCHER_NOT,
 148         MATCHER_ANY,
 149         MATCHER_ALL,
 150         MATCHER_IN,
 151         MATCHER_NIN,
 152
 153         /* unary operators */
 154         MATCHER_ISNULL,
 155         MATCHER_ISNNULL,
 156
 157         /* ary operators */
 158         MATCHER_LT,
 159         MATCHER_LE,
 160         MATCHER_EQ,
 161         MATCHER_NE,
 162         MATCHER_GE,
 163         MATCHER_GT,
 164         MATCHER_REGEX,
 165         MATCHER_NREGEX,
 166
 167         /* a generic query */
 168         MATCHER_QUERY,
 169 };
 170
 171 #define MATCHER_SYM(t) \
 172         (((t) == MATCHER_OR) ? "OR" \
 173                 : ((t) == MATCHER_AND) ? "AND" \
 174                 : ((t) == MATCHER_NOT) ? "NOT" \
 175                 : ((t) == MATCHER_ANY) ? "ANY" \
 176                 : ((t) == MATCHER_ALL) ? "ALL" \
 177                 : ((t) == MATCHER_IN) ? "IN" \
 178                 : ((t) == MATCHER_NIN) ? "NOT IN" \
 179                 : ((t) == MATCHER_ISNULL) ? "IS NULL" \
 180                 : ((t) == MATCHER_ISNNULL) ? "IS NOT NULL" \
 181                 : ((t) == MATCHER_LT) ? "<" \
 182                 : ((t) == MATCHER_LE) ? "<=" \
 183                 : ((t) == MATCHER_EQ) ? "=" \
 184                 : ((t) == MATCHER_NE) ? "!=" \
 185                 : ((t) == MATCHER_GE) ? ">=" \
 186                 : ((t) == MATCHER_GT) ? ">" \
 187                 : ((t) == MATCHER_REGEX) ? "=~" \
 188                 : ((t) == MATCHER_NREGEX) ? "!~" \
 189                 : ((t) == MATCHER_QUERY) ? "QUERY" \
 190                 : "UNKNOWN")
 191
 192 /* matcher base type */
 193 struct sdb_store_matcher {
 194         sdb_object_t super;
 195         /* type of the matcher */
 196         int type;
 197 };
 198 #define M(m) ((sdb_store_matcher_t *)(m))
 199
 200 /* infix operator matcher */
 201 typedef struct {
 202         sdb_store_matcher_t super;
 203
 204         /* left and right hand operands */
 205         sdb_store_matcher_t *left;
 206         sdb_store_matcher_t *right;
 207 } op_matcher_t;
 208 #define OP_M(m) ((op_matcher_t *)(m))
 209
 210 /* unary operator matcher */
 211 typedef struct {
 212         sdb_store_matcher_t super;
 213
 214         /* operand */
 215         sdb_store_matcher_t *op;
 216 } uop_matcher_t;
 217 #define UOP_M(m) ((uop_matcher_t *)(m))
 218
 219 /* iter matcher */
 220 typedef struct {
 221         sdb_store_matcher_t super;
 222         sdb_store_expr_t *iter;
 223         sdb_store_matcher_t *m;
 224 } iter_matcher_t;
 225 #define ITER_M(m) ((iter_matcher_t *)(m))
 226
 227 /* compare operator matcher */
 228 typedef struct {
 229         sdb_store_matcher_t super;
 230
 231         /* left and right hand expressions */
 232         sdb_store_expr_t *left;
 233         sdb_store_expr_t *right;
 234 } cmp_matcher_t;
 235 #define CMP_M(m) ((cmp_matcher_t *)(m))
 236
 237 typedef struct {
 238         sdb_store_matcher_t super;
 239         sdb_store_expr_t *expr;
 240 } isnull_matcher_t;
 241 #define ISNULL_M(m) ((isnull_matcher_t *)(m))
 242
 243 typedef struct {
 244         sdb_store_matcher_t super;
 245         sdb_ast_node_t *ast;
 246         sdb_store_matcher_t *matcher;
 247         sdb_store_matcher_t *filter;
 248 } query_matcher_t;
 249 #define QUERY_M(m) ((query_matcher_t *)(m))
 250
 251 #ifdef __cplusplus
 252 } /* extern "C" */
 253 #endif
 254
 255 #endif /* ! SDB_CORE_STORE_H */
 256
 257 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */
 258