Code

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