1 /*
2 * SysDB - src/frontend/analyzer.c
3 * Copyright (C) 2014 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 #include "sysdb.h"
30 #include "core/store-private.h"
31 #include "frontend/connection-private.h"
32 #include "frontend/parser.h"
33 #include "utils/error.h"
34 #include "utils/strbuf.h"
36 #include <assert.h>
38 /*
39 * private helper functions
40 */
42 static void
43 iter_error(sdb_strbuf_t *errbuf, int op, int oper, int context)
44 {
45 sdb_strbuf_sprintf(errbuf, "Cannot use %s %s in %s context",
46 MATCHER_SYM(op), SDB_STORE_TYPE_TO_NAME(oper),
47 SDB_STORE_TYPE_TO_NAME(context));
48 } /* iter_error */
50 static void
51 iter_array_error(sdb_strbuf_t *errbuf, int op,
52 int array_type, int cmp, int value_type)
53 {
54 sdb_strbuf_sprintf(errbuf, "Invalid array iterator %s %s %s %s",
55 MATCHER_SYM(op), SDB_TYPE_TO_STRING(array_type),
56 MATCHER_SYM(cmp), SDB_TYPE_TO_STRING(value_type));
57 if ((array_type & 0xff) != value_type)
58 sdb_strbuf_append(errbuf, " (type mismatch)");
59 else
60 sdb_strbuf_append(errbuf, " (invalid operator)");
61 } /* iter_array_error */
63 static void
64 cmp_error(sdb_strbuf_t *errbuf, int op, int left, int right)
65 {
66 sdb_strbuf_sprintf(errbuf, "Invalid operator %s for types %s and %s",
67 MATCHER_SYM(op), SDB_TYPE_TO_STRING(left),
68 SDB_TYPE_TO_STRING(right));
69 } /* cmp_error */
71 static void
72 op_error(sdb_strbuf_t *errbuf, int op, int left, int right)
73 {
74 sdb_strbuf_sprintf(errbuf, "Invalid operator %s for types %s and %s",
75 SDB_DATA_OP_TO_STRING(op), SDB_TYPE_TO_STRING(left),
76 SDB_TYPE_TO_STRING(right));
77 } /* cmp_error */
79 static int
80 analyze_expr(int context, sdb_store_expr_t *e, sdb_strbuf_t *errbuf)
81 {
82 if (! e)
83 return 0;
85 if ((e->type < TYPED_EXPR) || (SDB_DATA_CONCAT < e->type)) {
86 sdb_strbuf_sprintf(errbuf, "Invalid expression of type %d", e->type);
87 return -1;
88 }
90 switch (e->type) {
91 case TYPED_EXPR:
92 if (analyze_expr((int)e->data.data.integer, e->left, errbuf))
93 return -1;
94 if (context == (int)e->data.data.integer)
95 return 0;
96 if ((e->data.data.integer == SDB_HOST) &&
97 ((context == SDB_SERVICE) || (context == SDB_METRIC)))
98 return 0;
99 sdb_strbuf_sprintf(errbuf, "Invalid expression %s.%s "
100 "in %s context",
101 SDB_STORE_TYPE_TO_NAME(e->data.data.integer),
102 EXPR_TO_STRING(e->left), SDB_STORE_TYPE_TO_NAME(context));
103 return -1;
105 case ATTR_VALUE:
106 case FIELD_VALUE:
107 case 0:
108 break;
110 default:
111 if (analyze_expr(context, e->left, errbuf))
112 return -1;
113 if (analyze_expr(context, e->right, errbuf))
114 return -1;
116 if ((e->left->data_type > 0) && (e->right->data_type > 0)) {
117 if (sdb_data_expr_type(e->type, e->left->data_type,
118 e->right->data_type) < 0) {
119 op_error(errbuf, e->type, e->left->data_type,
120 e->right->data_type);
121 return -1;
122 }
123 }
124 break;
125 }
126 return 0;
127 } /* analyze_expr */
129 static int
130 analyze_matcher(int context, sdb_store_matcher_t *m, sdb_strbuf_t *errbuf)
131 {
132 if (! m)
133 return 0;
135 switch (m->type) {
136 case MATCHER_OR:
137 case MATCHER_AND:
138 assert(OP_M(m)->left && OP_M(m)->right);
139 if (analyze_matcher(context, OP_M(m)->left, errbuf))
140 return -1;
141 if (analyze_matcher(context, OP_M(m)->right, errbuf))
142 return -1;
143 break;
145 case MATCHER_NOT:
146 assert(UOP_M(m)->op);
147 if (analyze_matcher(context, UOP_M(m)->op, errbuf))
148 return -1;
149 break;
151 case MATCHER_ANY:
152 case MATCHER_ALL:
153 assert(ITER_M(m)->m);
154 if ((context != SDB_HOST)
155 && (context != SDB_SERVICE)
156 && (context != SDB_METRIC)) {
157 iter_error(errbuf, m->type, ITER_M(m)->type, context);
158 return -1;
159 }
160 if (ITER_M(m)->type == context) {
161 iter_error(errbuf, m->type, ITER_M(m)->type, context);
162 return -1;
163 }
164 if ((ITER_M(m)->type != SDB_SERVICE)
165 && (ITER_M(m)->type != SDB_METRIC)
166 && (ITER_M(m)->type != SDB_ATTRIBUTE)
167 && (ITER_M(m)->type != SDB_FIELD_BACKEND)) {
168 iter_error(errbuf, m->type, ITER_M(m)->type, context);
169 return -1;
170 }
171 if ((context == SDB_SERVICE)
172 && (ITER_M(m)->type == SDB_METRIC)) {
173 iter_error(errbuf, m->type, ITER_M(m)->type, context);
174 return -1;
175 }
176 else if ((context == SDB_METRIC)
177 && (ITER_M(m)->type == SDB_SERVICE)) {
178 iter_error(errbuf, m->type, ITER_M(m)->type, context);
179 return -1;
180 }
181 if (ITER_M(m)->type == SDB_FIELD_BACKEND) {
182 /* array iterators only support simple comparison atm */
183 if ((ITER_M(m)->m->type != MATCHER_LT)
184 && (ITER_M(m)->m->type != MATCHER_LE)
185 && (ITER_M(m)->m->type != MATCHER_EQ)
186 && (ITER_M(m)->m->type != MATCHER_NE)
187 && (ITER_M(m)->m->type != MATCHER_GE)
188 && (ITER_M(m)->m->type != MATCHER_GT)
189 && (ITER_M(m)->m->type != MATCHER_REGEX)
190 && (ITER_M(m)->m->type != MATCHER_NREGEX)) {
191 iter_array_error(errbuf, m->type,
192 CMP_M(ITER_M(m)->m)->left->data_type,
193 ITER_M(m)->m->type,
194 CMP_M(ITER_M(m)->m)->right->data_type);
195 return -1;
196 }
197 if (CMP_M(ITER_M(m)->m)->right->data_type < 0)
198 return 0; /* skip further type checks */
199 if (CMP_M(ITER_M(m)->m)->right->data_type & SDB_TYPE_ARRAY) {
200 iter_array_error(errbuf, m->type,
201 CMP_M(ITER_M(m)->m)->left->data_type,
202 ITER_M(m)->m->type,
203 CMP_M(ITER_M(m)->m)->right->data_type);
204 return -1;
205 }
206 if ((CMP_M(ITER_M(m)->m)->left->data_type & 0xff)
207 != CMP_M(ITER_M(m)->m)->right->data_type) {
208 iter_array_error(errbuf, m->type,
209 CMP_M(ITER_M(m)->m)->left->data_type,
210 ITER_M(m)->m->type,
211 CMP_M(ITER_M(m)->m)->right->data_type);
212 return -1;
213 }
214 }
215 else if (analyze_matcher(ITER_M(m)->type, ITER_M(m)->m, errbuf))
216 return -1;
217 break;
219 case MATCHER_LT:
220 case MATCHER_LE:
221 case MATCHER_EQ:
222 case MATCHER_NE:
223 case MATCHER_GE:
224 case MATCHER_GT:
225 assert(CMP_M(m)->left && CMP_M(m)->right);
226 if (analyze_expr(context, CMP_M(m)->left, errbuf))
227 return -1;
228 if (analyze_expr(context, CMP_M(m)->right, errbuf))
229 return -1;
231 if ((CMP_M(m)->left->data_type > 0)
232 && (CMP_M(m)->right->data_type > 0)) {
233 if (CMP_M(m)->left->data_type == CMP_M(m)->right->data_type)
234 return 0;
235 cmp_error(errbuf, m->type, CMP_M(m)->left->data_type,
236 CMP_M(m)->right->data_type);
237 return -1;
238 }
239 if ((CMP_M(m)->left->data_type > 0)
240 && (CMP_M(m)->left->data_type & SDB_TYPE_ARRAY)) {
241 cmp_error(errbuf, m->type, CMP_M(m)->left->data_type,
242 CMP_M(m)->right->data_type);
243 return -1;
244 }
245 if ((CMP_M(m)->right->data_type > 0)
246 && (CMP_M(m)->right->data_type & SDB_TYPE_ARRAY)) {
247 cmp_error(errbuf, m->type, CMP_M(m)->left->data_type,
248 CMP_M(m)->right->data_type);
249 return -1;
250 }
251 break;
253 case MATCHER_IN:
254 if (analyze_expr(context, CMP_M(m)->left, errbuf))
255 return -1;
256 if (analyze_expr(context, CMP_M(m)->right, errbuf))
257 return -1;
259 /* the left operand may be a scalar or an array but the element
260 * type has to match */
261 if ((CMP_M(m)->right->data_type > 0)
262 && (! (CMP_M(m)->right->data_type & SDB_TYPE_ARRAY))) {
263 cmp_error(errbuf, m->type, CMP_M(m)->left->data_type,
264 CMP_M(m)->right->data_type);
265 return -1;
266 }
267 if ((CMP_M(m)->left->data_type > 0)
268 && (CMP_M(m)->right->data_type > 0)) {
269 if ((CMP_M(m)->left->data_type & 0xff)
270 != (CMP_M(m)->right->data_type & 0xff)) {
271 cmp_error(errbuf, m->type, CMP_M(m)->left->data_type,
272 CMP_M(m)->right->data_type);
273 return -1;
274 }
275 }
276 break;
278 case MATCHER_REGEX:
279 case MATCHER_NREGEX:
280 if (analyze_expr(context, CMP_M(m)->left, errbuf))
281 return -1;
282 if (analyze_expr(context, CMP_M(m)->right, errbuf))
283 return -1;
285 /* all types are supported for the left operand */
286 if ((CMP_M(m)->right->data_type > 0)
287 && (CMP_M(m)->right->data_type != SDB_TYPE_REGEX)
288 && (CMP_M(m)->right->data_type != SDB_TYPE_STRING)) {
289 cmp_error(errbuf, m->type, CMP_M(m)->left->data_type,
290 CMP_M(m)->right->data_type);
291 return -1;
292 }
293 break;
295 case MATCHER_ISNULL:
296 case MATCHER_ISNNULL:
297 if (analyze_expr(context, ISNULL_M(m)->expr, errbuf))
298 return -1;
299 break;
301 default:
302 sdb_strbuf_sprintf(errbuf, "Unknown matcher type %d", m->type);
303 return -1;
304 }
305 return 0;
306 } /* analyze_matcher */
308 /*
309 * public API
310 */
312 int
313 sdb_fe_analyze(sdb_conn_node_t *node, sdb_strbuf_t *errbuf)
314 {
315 sdb_store_matcher_t *m = NULL, *filter = NULL;
316 int context = -1;
317 int status = 0;
319 if (! node)
320 return -1;
322 /* For now, this function checks basic matcher attributes only;
323 * later, this may be turned into one of multiple AST visitors. */
324 if (node->cmd == SDB_CONNECTION_FETCH) {
325 conn_fetch_t *fetch = CONN_FETCH(node);
326 if ((fetch->type == SDB_HOST) && fetch->name) {
327 sdb_strbuf_sprintf(errbuf, "Unexpected STRING '%s'", fetch->name);
328 return -1;
329 }
330 if ((fetch->type != SDB_HOST) && (! fetch->name)) {
331 sdb_strbuf_sprintf(errbuf, "Missing %s name",
332 SDB_STORE_TYPE_TO_NAME(fetch->type));
333 return -1;
334 }
335 if (fetch->filter)
336 filter = fetch->filter->matcher;
337 context = fetch->type;
338 }
339 else if (node->cmd == SDB_CONNECTION_LIST) {
340 if (CONN_LIST(node)->filter)
341 filter = CONN_LIST(node)->filter->matcher;
342 context = CONN_LIST(node)->type;
343 }
344 else if (node->cmd == SDB_CONNECTION_LOOKUP) {
345 if (CONN_LOOKUP(node)->matcher)
346 m = CONN_LOOKUP(node)->matcher->matcher;
347 if (CONN_LOOKUP(node)->filter)
348 filter = CONN_LOOKUP(node)->filter->matcher;
349 context = CONN_LOOKUP(node)->type;
350 }
351 else if ((node->cmd == SDB_CONNECTION_STORE_HOST)
352 || (node->cmd == SDB_CONNECTION_STORE_SERVICE)
353 || (node->cmd == SDB_CONNECTION_STORE_METRIC)
354 || (node->cmd == SDB_CONNECTION_STORE_ATTRIBUTE)) {
355 return 0;
356 }
357 else if (node->cmd == SDB_CONNECTION_TIMESERIES) {
358 return 0;
359 }
360 else {
361 sdb_strbuf_sprintf(errbuf,
362 "Don't know how to analyze command %#x", node->cmd);
363 return -1;
364 }
366 if (analyze_matcher(context, m, errbuf))
367 status = -1;
368 if (analyze_matcher(-1, filter, errbuf))
369 status = -1;
370 return status;
371 } /* sdb_fe_analyze */
373 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */