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, sdb_store_expr_t *iter, int context)
44 {
45 sdb_strbuf_sprintf(errbuf, "Invalid %s iterator: %s %s "
46 "not iterable in %s context", MATCHER_SYM(op),
47 EXPR_TO_STRING(iter), SDB_STORE_TYPE_TO_NAME(iter->data_type),
48 SDB_STORE_TYPE_TO_NAME(context));
49 } /* iter_error */
51 static void
52 iter_op_error(sdb_strbuf_t *errbuf, int op,
53 int iter_type, int cmp, int value_type)
54 {
55 sdb_strbuf_sprintf(errbuf, "Invalid iterator %s %s %s %s",
56 MATCHER_SYM(op), SDB_TYPE_TO_STRING(iter_type),
57 MATCHER_SYM(cmp), SDB_TYPE_TO_STRING(value_type));
58 if ((iter_type & 0xff) != value_type)
59 sdb_strbuf_append(errbuf, " (type mismatch)");
60 else
61 sdb_strbuf_append(errbuf, " (invalid operator)");
62 } /* iter_op_error */
64 static void
65 cmp_error(sdb_strbuf_t *errbuf, int op, int left, int right)
66 {
67 sdb_strbuf_sprintf(errbuf, "Invalid operator %s for types %s and %s",
68 MATCHER_SYM(op), SDB_TYPE_TO_STRING(left),
69 SDB_TYPE_TO_STRING(right));
70 } /* cmp_error */
72 static void
73 op_error(sdb_strbuf_t *errbuf, int op, int left, int right)
74 {
75 sdb_strbuf_sprintf(errbuf, "Invalid operator %s for types %s and %s",
76 SDB_DATA_OP_TO_STRING(op), SDB_TYPE_TO_STRING(left),
77 SDB_TYPE_TO_STRING(right));
78 } /* cmp_error */
80 static int
81 analyze_expr(int context, sdb_store_expr_t *e, sdb_strbuf_t *errbuf)
82 {
83 if (! e)
84 return 0;
86 if ((e->type < TYPED_EXPR) || (SDB_DATA_CONCAT < e->type)) {
87 sdb_strbuf_sprintf(errbuf, "Invalid expression of type %d", e->type);
88 return -1;
89 }
91 switch (e->type) {
92 case TYPED_EXPR:
93 if (analyze_expr((int)e->data.data.integer, e->left, errbuf))
94 return -1;
95 if (context == (int)e->data.data.integer)
96 return 0;
97 if ((e->data.data.integer == SDB_HOST) &&
98 ((context == SDB_SERVICE) || (context == SDB_METRIC)))
99 return 0;
100 sdb_strbuf_sprintf(errbuf, "Invalid expression %s.%s "
101 "in %s context",
102 SDB_STORE_TYPE_TO_NAME(e->data.data.integer),
103 EXPR_TO_STRING(e->left), SDB_STORE_TYPE_TO_NAME(context));
104 return -1;
106 case ATTR_VALUE:
107 case FIELD_VALUE:
108 case 0:
109 break;
111 default:
112 if (analyze_expr(context, e->left, errbuf))
113 return -1;
114 if (analyze_expr(context, e->right, errbuf))
115 return -1;
117 if ((e->left->data_type > 0) && (e->right->data_type > 0)) {
118 if (sdb_data_expr_type(e->type, e->left->data_type,
119 e->right->data_type) < 0) {
120 op_error(errbuf, e->type, e->left->data_type,
121 e->right->data_type);
122 return -1;
123 }
124 }
125 break;
126 }
127 return 0;
128 } /* analyze_expr */
130 static int
131 analyze_matcher(int context, int parent_type,
132 sdb_store_matcher_t *m, sdb_strbuf_t *errbuf)
133 {
134 if (! m)
135 return 0;
137 switch (m->type) {
138 case MATCHER_OR:
139 case MATCHER_AND:
140 assert(OP_M(m)->left && OP_M(m)->right);
141 if (analyze_matcher(context, m->type, OP_M(m)->left, errbuf))
142 return -1;
143 if (analyze_matcher(context, m->type, OP_M(m)->right, errbuf))
144 return -1;
145 break;
147 case MATCHER_NOT:
148 assert(UOP_M(m)->op);
149 if (analyze_matcher(context, m->type, UOP_M(m)->op, errbuf))
150 return -1;
151 break;
153 case MATCHER_ANY:
154 case MATCHER_ALL:
155 {
156 int child_context = -1;
157 int left_type = -1;
159 assert(ITER_M(m)->m);
161 if (! sdb_store_expr_iterable(ITER_M(m)->iter, context)) {
162 iter_error(errbuf, m->type, ITER_M(m)->iter, context);
163 return -1;
164 }
166 if (ITER_M(m)->iter->type == TYPED_EXPR) {
167 child_context = (int)ITER_M(m)->iter->data.data.integer;
168 left_type = ITER_M(m)->iter->data_type;
169 }
170 else if (ITER_M(m)->iter->type == FIELD_VALUE) {
171 child_context = context;
172 /* element type of the field */
173 left_type = ITER_M(m)->iter->data_type & 0xff;
174 }
175 else if (! ITER_M(m)->iter->type) {
176 child_context = context;
177 /* elements of the array constant */
178 left_type = ITER_M(m)->iter->data.type & 0xff;
179 }
180 else {
181 iter_error(errbuf, m->type, ITER_M(m)->iter, context);
182 return -1;
183 }
185 /* any ary operator will do but these are the once
186 * we currently support */
187 if ((ITER_M(m)->m->type != MATCHER_LT)
188 && (ITER_M(m)->m->type != MATCHER_LE)
189 && (ITER_M(m)->m->type != MATCHER_EQ)
190 && (ITER_M(m)->m->type != MATCHER_NE)
191 && (ITER_M(m)->m->type != MATCHER_GE)
192 && (ITER_M(m)->m->type != MATCHER_GT)
193 && (ITER_M(m)->m->type != MATCHER_REGEX)
194 && (ITER_M(m)->m->type != MATCHER_NREGEX)) {
195 iter_op_error(errbuf, m->type,
196 left_type, ITER_M(m)->m->type,
197 CMP_M(ITER_M(m)->m)->right->data_type);
198 return -1;
199 }
200 if ((left_type >= 0)
201 && (CMP_M(ITER_M(m)->m)->right->data_type >= 0)) {
202 if (left_type != CMP_M(ITER_M(m)->m)->right->data_type) {
203 iter_op_error(errbuf, m->type,
204 left_type, ITER_M(m)->m->type,
205 CMP_M(ITER_M(m)->m)->right->data_type);
206 return -1;
207 }
208 }
209 if (analyze_matcher(child_context, m->type, ITER_M(m)->m, errbuf))
210 return -1;
211 break;
212 }
214 case MATCHER_LT:
215 case MATCHER_LE:
216 case MATCHER_EQ:
217 case MATCHER_NE:
218 case MATCHER_GE:
219 case MATCHER_GT:
220 {
221 int left_type = -1;
223 assert(CMP_M(m)->right);
224 if ((parent_type == MATCHER_ALL)
225 || (parent_type == MATCHER_ANY)) {
226 assert(! CMP_M(m)->left);
227 }
228 else {
229 assert(CMP_M(m)->left);
230 left_type = CMP_M(m)->left->data_type;
231 }
233 if (analyze_expr(context, CMP_M(m)->left, errbuf))
234 return -1;
235 if (analyze_expr(context, CMP_M(m)->right, errbuf))
236 return -1;
238 if ((left_type > 0) && (CMP_M(m)->right->data_type > 0)) {
239 if (left_type == CMP_M(m)->right->data_type)
240 return 0;
241 cmp_error(errbuf, m->type, left_type,
242 CMP_M(m)->right->data_type);
243 return -1;
244 }
245 if ((left_type > 0) && (left_type & SDB_TYPE_ARRAY)) {
246 cmp_error(errbuf, m->type, left_type,
247 CMP_M(m)->right->data_type);
248 return -1;
249 }
250 if ((CMP_M(m)->right->data_type > 0)
251 && (CMP_M(m)->right->data_type & SDB_TYPE_ARRAY)) {
252 cmp_error(errbuf, m->type, left_type,
253 CMP_M(m)->right->data_type);
254 return -1;
255 }
256 break;
257 }
259 case MATCHER_IN:
260 case MATCHER_NIN:
261 if (analyze_expr(context, CMP_M(m)->left, errbuf))
262 return -1;
263 if (analyze_expr(context, CMP_M(m)->right, errbuf))
264 return -1;
266 /* the left operand may be a scalar or an array but the element
267 * type has to match */
268 if ((CMP_M(m)->right->data_type > 0)
269 && (! (CMP_M(m)->right->data_type & SDB_TYPE_ARRAY))) {
270 cmp_error(errbuf, m->type, CMP_M(m)->left->data_type,
271 CMP_M(m)->right->data_type);
272 return -1;
273 }
274 if ((CMP_M(m)->left->data_type > 0)
275 && (CMP_M(m)->right->data_type > 0)) {
276 if ((CMP_M(m)->left->data_type & 0xff)
277 != (CMP_M(m)->right->data_type & 0xff)) {
278 cmp_error(errbuf, m->type, CMP_M(m)->left->data_type,
279 CMP_M(m)->right->data_type);
280 return -1;
281 }
282 }
283 break;
285 case MATCHER_REGEX:
286 case MATCHER_NREGEX:
287 if (analyze_expr(context, CMP_M(m)->left, errbuf))
288 return -1;
289 if (analyze_expr(context, CMP_M(m)->right, errbuf))
290 return -1;
292 /* all types are supported for the left operand */
293 if ((CMP_M(m)->right->data_type > 0)
294 && (CMP_M(m)->right->data_type != SDB_TYPE_REGEX)
295 && (CMP_M(m)->right->data_type != SDB_TYPE_STRING)) {
296 cmp_error(errbuf, m->type, CMP_M(m)->left->data_type,
297 CMP_M(m)->right->data_type);
298 return -1;
299 }
300 break;
302 case MATCHER_ISNULL:
303 case MATCHER_ISNNULL:
304 if (analyze_expr(context, ISNULL_M(m)->expr, errbuf))
305 return -1;
306 break;
308 default:
309 sdb_strbuf_sprintf(errbuf, "Unknown matcher type %d", m->type);
310 return -1;
311 }
312 return 0;
313 } /* analyze_matcher */
315 /*
316 * public API
317 */
319 int
320 sdb_fe_analyze(sdb_conn_node_t *node, sdb_strbuf_t *errbuf)
321 {
322 sdb_store_matcher_t *m = NULL, *filter = NULL;
323 int context = -1;
324 int status = 0;
326 if (! node)
327 return -1;
329 /* For now, this function checks basic matcher attributes only;
330 * later, this may be turned into one of multiple AST visitors. */
331 if (node->cmd == SDB_CONNECTION_FETCH) {
332 conn_fetch_t *fetch = CONN_FETCH(node);
333 if ((fetch->type == SDB_HOST) && fetch->name) {
334 sdb_strbuf_sprintf(errbuf, "Unexpected STRING '%s'", fetch->name);
335 return -1;
336 }
337 if ((fetch->type != SDB_HOST) && (! fetch->name)) {
338 sdb_strbuf_sprintf(errbuf, "Missing %s name",
339 SDB_STORE_TYPE_TO_NAME(fetch->type));
340 return -1;
341 }
342 if (fetch->filter)
343 filter = fetch->filter->matcher;
344 context = fetch->type;
345 }
346 else if (node->cmd == SDB_CONNECTION_LIST) {
347 if (CONN_LIST(node)->filter)
348 filter = CONN_LIST(node)->filter->matcher;
349 context = CONN_LIST(node)->type;
350 }
351 else if (node->cmd == SDB_CONNECTION_LOOKUP) {
352 if (CONN_LOOKUP(node)->matcher)
353 m = CONN_LOOKUP(node)->matcher->matcher;
354 if (CONN_LOOKUP(node)->filter)
355 filter = CONN_LOOKUP(node)->filter->matcher;
356 context = CONN_LOOKUP(node)->type;
357 }
358 else if ((node->cmd == SDB_CONNECTION_STORE_HOST)
359 || (node->cmd == SDB_CONNECTION_STORE_SERVICE)
360 || (node->cmd == SDB_CONNECTION_STORE_METRIC)
361 || (node->cmd == SDB_CONNECTION_STORE_ATTRIBUTE)) {
362 return 0;
363 }
364 else if (node->cmd == SDB_CONNECTION_TIMESERIES) {
365 return 0;
366 }
367 else {
368 sdb_strbuf_sprintf(errbuf,
369 "Don't know how to analyze command %#x", node->cmd);
370 return -1;
371 }
373 if (analyze_matcher(context, -1, m, errbuf))
374 status = -1;
375 if (analyze_matcher(-1, -1, filter, errbuf))
376 status = -1;
377 return status;
378 } /* sdb_fe_analyze */
380 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */