c7a6ee0c6ff547c906a101f6b2509725b1c9dd60
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_op_error(sdb_strbuf_t *errbuf, int op,
52 int iter_type, int cmp, int value_type)
53 {
54 sdb_strbuf_sprintf(errbuf, "Invalid iterator %s %s %s %s",
55 MATCHER_SYM(op), SDB_TYPE_TO_STRING(iter_type),
56 MATCHER_SYM(cmp), SDB_TYPE_TO_STRING(value_type));
57 if ((iter_type & 0xff) != value_type)
58 sdb_strbuf_append(errbuf, " (type mismatch)");
59 else
60 sdb_strbuf_append(errbuf, " (invalid operator)");
61 } /* iter_op_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 /* any ary operator will do but these are the once
182 * we currently support */
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_op_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 (ITER_M(m)->type == SDB_FIELD_BACKEND) {
198 if (CMP_M(ITER_M(m)->m)->right->data_type < 0)
199 return 0; /* skip further type checks */
200 if (CMP_M(ITER_M(m)->m)->right->data_type & SDB_TYPE_ARRAY) {
201 iter_op_error(errbuf, m->type,
202 CMP_M(ITER_M(m)->m)->left->data_type,
203 ITER_M(m)->m->type,
204 CMP_M(ITER_M(m)->m)->right->data_type);
205 return -1;
206 }
207 if ((CMP_M(ITER_M(m)->m)->left->data_type & 0xff)
208 != CMP_M(ITER_M(m)->m)->right->data_type) {
209 iter_op_error(errbuf, m->type,
210 CMP_M(ITER_M(m)->m)->left->data_type,
211 ITER_M(m)->m->type,
212 CMP_M(ITER_M(m)->m)->right->data_type);
213 return -1;
214 }
215 }
216 else if (analyze_matcher(ITER_M(m)->type, ITER_M(m)->m, errbuf))
217 return -1;
218 break;
220 case MATCHER_LT:
221 case MATCHER_LE:
222 case MATCHER_EQ:
223 case MATCHER_NE:
224 case MATCHER_GE:
225 case MATCHER_GT:
226 assert(CMP_M(m)->left && CMP_M(m)->right);
227 if (analyze_expr(context, CMP_M(m)->left, errbuf))
228 return -1;
229 if (analyze_expr(context, CMP_M(m)->right, errbuf))
230 return -1;
232 if ((CMP_M(m)->left->data_type > 0)
233 && (CMP_M(m)->right->data_type > 0)) {
234 if (CMP_M(m)->left->data_type == CMP_M(m)->right->data_type)
235 return 0;
236 cmp_error(errbuf, m->type, CMP_M(m)->left->data_type,
237 CMP_M(m)->right->data_type);
238 return -1;
239 }
240 if ((CMP_M(m)->left->data_type > 0)
241 && (CMP_M(m)->left->data_type & SDB_TYPE_ARRAY)) {
242 cmp_error(errbuf, m->type, CMP_M(m)->left->data_type,
243 CMP_M(m)->right->data_type);
244 return -1;
245 }
246 if ((CMP_M(m)->right->data_type > 0)
247 && (CMP_M(m)->right->data_type & SDB_TYPE_ARRAY)) {
248 cmp_error(errbuf, m->type, CMP_M(m)->left->data_type,
249 CMP_M(m)->right->data_type);
250 return -1;
251 }
252 break;
254 case MATCHER_IN:
255 case MATCHER_NIN:
256 if (analyze_expr(context, CMP_M(m)->left, errbuf))
257 return -1;
258 if (analyze_expr(context, CMP_M(m)->right, errbuf))
259 return -1;
261 /* the left operand may be a scalar or an array but the element
262 * type has to match */
263 if ((CMP_M(m)->right->data_type > 0)
264 && (! (CMP_M(m)->right->data_type & SDB_TYPE_ARRAY))) {
265 cmp_error(errbuf, m->type, CMP_M(m)->left->data_type,
266 CMP_M(m)->right->data_type);
267 return -1;
268 }
269 if ((CMP_M(m)->left->data_type > 0)
270 && (CMP_M(m)->right->data_type > 0)) {
271 if ((CMP_M(m)->left->data_type & 0xff)
272 != (CMP_M(m)->right->data_type & 0xff)) {
273 cmp_error(errbuf, m->type, CMP_M(m)->left->data_type,
274 CMP_M(m)->right->data_type);
275 return -1;
276 }
277 }
278 break;
280 case MATCHER_REGEX:
281 case MATCHER_NREGEX:
282 if (analyze_expr(context, CMP_M(m)->left, errbuf))
283 return -1;
284 if (analyze_expr(context, CMP_M(m)->right, errbuf))
285 return -1;
287 /* all types are supported for the left operand */
288 if ((CMP_M(m)->right->data_type > 0)
289 && (CMP_M(m)->right->data_type != SDB_TYPE_REGEX)
290 && (CMP_M(m)->right->data_type != SDB_TYPE_STRING)) {
291 cmp_error(errbuf, m->type, CMP_M(m)->left->data_type,
292 CMP_M(m)->right->data_type);
293 return -1;
294 }
295 break;
297 case MATCHER_ISNULL:
298 case MATCHER_ISNNULL:
299 if (analyze_expr(context, ISNULL_M(m)->expr, errbuf))
300 return -1;
301 break;
303 default:
304 sdb_strbuf_sprintf(errbuf, "Unknown matcher type %d", m->type);
305 return -1;
306 }
307 return 0;
308 } /* analyze_matcher */
310 /*
311 * public API
312 */
314 int
315 sdb_fe_analyze(sdb_conn_node_t *node, sdb_strbuf_t *errbuf)
316 {
317 sdb_store_matcher_t *m = NULL, *filter = NULL;
318 int context = -1;
319 int status = 0;
321 if (! node)
322 return -1;
324 /* For now, this function checks basic matcher attributes only;
325 * later, this may be turned into one of multiple AST visitors. */
326 if (node->cmd == SDB_CONNECTION_FETCH) {
327 conn_fetch_t *fetch = CONN_FETCH(node);
328 if ((fetch->type == SDB_HOST) && fetch->name) {
329 sdb_strbuf_sprintf(errbuf, "Unexpected STRING '%s'", fetch->name);
330 return -1;
331 }
332 if ((fetch->type != SDB_HOST) && (! fetch->name)) {
333 sdb_strbuf_sprintf(errbuf, "Missing %s name",
334 SDB_STORE_TYPE_TO_NAME(fetch->type));
335 return -1;
336 }
337 if (fetch->filter)
338 filter = fetch->filter->matcher;
339 context = fetch->type;
340 }
341 else if (node->cmd == SDB_CONNECTION_LIST) {
342 if (CONN_LIST(node)->filter)
343 filter = CONN_LIST(node)->filter->matcher;
344 context = CONN_LIST(node)->type;
345 }
346 else if (node->cmd == SDB_CONNECTION_LOOKUP) {
347 if (CONN_LOOKUP(node)->matcher)
348 m = CONN_LOOKUP(node)->matcher->matcher;
349 if (CONN_LOOKUP(node)->filter)
350 filter = CONN_LOOKUP(node)->filter->matcher;
351 context = CONN_LOOKUP(node)->type;
352 }
353 else if ((node->cmd == SDB_CONNECTION_STORE_HOST)
354 || (node->cmd == SDB_CONNECTION_STORE_SERVICE)
355 || (node->cmd == SDB_CONNECTION_STORE_METRIC)
356 || (node->cmd == SDB_CONNECTION_STORE_ATTRIBUTE)) {
357 return 0;
358 }
359 else if (node->cmd == SDB_CONNECTION_TIMESERIES) {
360 return 0;
361 }
362 else {
363 sdb_strbuf_sprintf(errbuf,
364 "Don't know how to analyze command %#x", node->cmd);
365 return -1;
366 }
368 if (analyze_matcher(context, m, errbuf))
369 status = -1;
370 if (analyze_matcher(-1, filter, errbuf))
371 status = -1;
372 return status;
373 } /* sdb_fe_analyze */
375 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */