src/core/store_expr.c

   1 /*
   2  * SysDB - src/core/store_expr.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  */
  27
  28 /*
  29  * This module implements expressions which may be executed in the store.
  30  */
  31
  32 #if HAVE_CONFIG_H
  33 #       include "config.h"
  34 #endif /* HAVE_CONFIG_H */
  35
  36 #include "sysdb.h"
  37 #include "core/store-private.h"
  38 #include "core/data.h"
  39 #include "core/object.h"
  40
  41 #include <assert.h>
  42 #include <stdbool.h>
  43 #include <stdlib.h>
  44 #include <string.h>
  45
  46 /*
  47  * private data types
  48  */
  49
  50 /* iterate through either a list of child nodes or arrays */
  51 struct sdb_store_expr_iter {
  52         sdb_store_obj_t *obj;
  53         sdb_store_expr_t *expr;
  54
  55         sdb_avltree_iter_t *tree;
  56
  57         sdb_data_t array;
  58         size_t array_idx;
  59         bool free_array;
  60
  61         sdb_store_matcher_t *filter;
  62 };
  63
  64 /*
  65  * private types
  66  */
  67
  68 static int
  69 expr_init(sdb_object_t *obj, va_list ap)
  70 {
  71         int type = va_arg(ap, int);
  72         sdb_store_expr_t *left  = va_arg(ap, sdb_store_expr_t *);
  73         sdb_store_expr_t *right = va_arg(ap, sdb_store_expr_t *);
  74         const sdb_data_t *value = va_arg(ap, const sdb_data_t *);
  75
  76         sdb_store_expr_t *expr = SDB_STORE_EXPR(obj);
  77
  78         if (type <= 0) {
  79                 if (! value)
  80                         return -1;
  81                 if ((type == TYPED_EXPR) && (! left))
  82                         return -1;
  83         } else {
  84                 if (value)
  85                         return -1;
  86                 if ((! left) || (! right))
  87                         return -1;
  88         }
  89
  90         if (value)
  91                 expr->data = *value;
  92
  93         sdb_object_ref(SDB_OBJ(left));
  94         sdb_object_ref(SDB_OBJ(right));
  95
  96         expr->type  = type;
  97         expr->left  = left;
  98         expr->right = right;
  99
 100         /* unknown for now */
 101         expr->data_type = -1;
 102         return 0;
 103 } /* expr_init */
 104
 105 static void
 106 expr_destroy(sdb_object_t *obj)
 107 {
 108         sdb_store_expr_t *expr = SDB_STORE_EXPR(obj);
 109         sdb_object_deref(SDB_OBJ(expr->left));
 110         sdb_object_deref(SDB_OBJ(expr->right));
 111
 112         if (expr->data.type)
 113                 sdb_data_free_datum(&expr->data);
 114 } /* expr_destroy */
 115
 116 static sdb_type_t expr_type = {
 117         /* size = */ sizeof(sdb_store_expr_t),
 118         /* init = */ expr_init,
 119         /* destroy = */ expr_destroy,
 120 };
 121
 122 /*
 123  * public API
 124  */
 125
 126 sdb_store_expr_t *
 127 sdb_store_expr_create(int op, sdb_store_expr_t *left, sdb_store_expr_t *right)
 128 {
 129         sdb_data_t value = SDB_DATA_INIT;
 130         sdb_store_expr_t *e;
 131
 132         if ((op < 0) || (SDB_DATA_CONCAT < op) || (! left) || (! right))
 133                 return NULL;
 134
 135         if (left->type || right->type) {
 136                 e = SDB_STORE_EXPR(sdb_object_create("store-expr", expr_type,
 137                                         op, left, right, NULL));
 138                 e->data_type = sdb_data_expr_type(op, left->type, right->type);
 139                 return e;
 140         }
 141         /* else: both expressions are constant values; evaluate now */
 142
 143         if (sdb_data_expr_eval(op, &left->data, &right->data, &value))
 144                 return NULL;
 145         e = SDB_STORE_EXPR(sdb_object_create("store-constvalue", expr_type,
 146                                 0, NULL, NULL, &value));
 147         e->data_type = value.type;
 148         return e;
 149 } /* sdb_store_expr_create */
 150
 151 sdb_store_expr_t *
 152 sdb_store_expr_typed(int typ, sdb_store_expr_t *expr)
 153 {
 154         sdb_data_t value = { SDB_TYPE_INTEGER, { .integer = typ } };
 155         sdb_store_expr_t *e;
 156
 157         if ((typ < SDB_HOST) || (SDB_ATTRIBUTE < typ))
 158                 return NULL;
 159
 160         e = SDB_STORE_EXPR(sdb_object_create("store-typedexpr", expr_type,
 161                                 TYPED_EXPR, expr, NULL, &value));
 162         e->data_type = expr->data_type;
 163         return e;
 164 } /* sdb_store_expr_typed */
 165
 166 sdb_store_expr_t *
 167 sdb_store_expr_fieldvalue(int field)
 168 {
 169         sdb_data_t value = { SDB_TYPE_INTEGER, { .integer = field } };
 170         sdb_store_expr_t *e;
 171
 172         if ((field < SDB_FIELD_NAME) || (SDB_FIELD_TIMESERIES < field))
 173                 return NULL;
 174         e = SDB_STORE_EXPR(sdb_object_create("store-fieldvalue", expr_type,
 175                                 FIELD_VALUE, NULL, NULL, &value));
 176         e->data_type = SDB_FIELD_TYPE(field);
 177         return e;
 178 } /* sdb_store_expr_fieldvalue */
 179
 180 sdb_store_expr_t *
 181 sdb_store_expr_attrvalue(const char *name)
 182 {
 183         sdb_data_t value = { SDB_TYPE_STRING, { .string = NULL} };
 184         sdb_store_expr_t *expr;
 185
 186         value.data.string = strdup(name);
 187         if (! value.data.string)
 188                 return NULL;
 189
 190         expr = SDB_STORE_EXPR(sdb_object_create("store-attrvalue", expr_type,
 191                                 ATTR_VALUE, NULL, NULL, &value));
 192         if (! expr)
 193                 free(value.data.string);
 194         expr->data_type = -1;
 195         return expr;
 196 } /* sdb_store_expr_attrvalue */
 197
 198 sdb_store_expr_t *
 199 sdb_store_expr_constvalue(const sdb_data_t *value)
 200 {
 201         sdb_data_t data = SDB_DATA_INIT;
 202         sdb_store_expr_t *e;
 203
 204         if (sdb_data_copy(&data, value))
 205                 return NULL;
 206         e = SDB_STORE_EXPR(sdb_object_create("store-constvalue", expr_type,
 207                                 0, NULL, NULL, &data));
 208         e->data_type = data.type;
 209         return e;
 210 } /* sdb_store_expr_constvalue */
 211
 212 int
 213 sdb_store_expr_eval(sdb_store_expr_t *expr, sdb_store_obj_t *obj,
 214                 sdb_data_t *res, sdb_store_matcher_t *filter)
 215 {
 216         sdb_data_t v1 = SDB_DATA_INIT, v2 = SDB_DATA_INIT;
 217         int status = 0;
 218
 219         if ((! expr) || (! res))
 220                 return -1;
 221
 222         if (filter && obj && (! sdb_store_matcher_matches(filter, obj, NULL)))
 223                 obj = NULL; /* this object does not exist */
 224
 225         if (! expr->type)
 226                 return sdb_data_copy(res, &expr->data);
 227         else if (expr->type == FIELD_VALUE)
 228                 return sdb_store_get_field(obj, (int)expr->data.data.integer, res);
 229         else if (expr->type == ATTR_VALUE) {
 230                 status = sdb_store_get_attr(obj, expr->data.data.string, res, filter);
 231                 if ((status < 0) && obj) {
 232                         /* attribute does not exist => NULL */
 233                         status = 0;
 234                         res->type = SDB_TYPE_STRING;
 235                         res->data.string = NULL;
 236                 }
 237                 return status;
 238         }
 239         else if (expr->type == TYPED_EXPR) {
 240                 int typ = (int)expr->data.data.integer;
 241                 if (typ != obj->type) {
 242                         /* we support self-references and { service, metric } -> host */
 243                         if ((typ != SDB_HOST)
 244                                         || ((obj->type != SDB_SERVICE)
 245                                                 && (obj->type != SDB_METRIC)))
 246                                 return -1;
 247                         obj = obj->parent;
 248                 }
 249                 return sdb_store_expr_eval(expr->left, obj, res, filter);
 250         }
 251
 252         if (sdb_store_expr_eval(expr->left, obj, &v1, filter))
 253                 return -1;
 254         if (sdb_store_expr_eval(expr->right, obj, &v2, filter)) {
 255                 sdb_data_free_datum(&v1);
 256                 return -1;
 257         }
 258
 259         if (sdb_data_expr_eval(expr->type, &v1, &v2, res))
 260                 status = -1;
 261         sdb_data_free_datum(&v1);
 262         sdb_data_free_datum(&v2);
 263         return status;
 264 } /* sdb_store_expr_eval */
 265
 266 bool
 267 sdb_store_expr_iterable(sdb_store_expr_t *expr, int context)
 268 {
 269         if (expr->type == TYPED_EXPR) {
 270                 if ((context != SDB_HOST) && (context != SDB_SERVICE)
 271                                 && (context != SDB_METRIC))
 272                         return 0;
 273                 if (context == expr->data.data.integer)
 274                         return 0;
 275                 if ((expr->data.data.integer != SDB_SERVICE)
 276                                 && (expr->data.data.integer != SDB_METRIC)
 277                                 && (expr->data.data.integer != SDB_ATTRIBUTE))
 278                         return 0;
 279                 if ((context == SDB_SERVICE)
 280                                 && (expr->data.data.integer == SDB_METRIC))
 281                         return 0;
 282                 else if ((context == SDB_METRIC)
 283                                 && (expr->data.data.integer == SDB_SERVICE))
 284                         return 0;
 285                 return 1;
 286         }
 287         else if (expr->type == FIELD_VALUE) {
 288                 if ((context != SDB_HOST) && (context != SDB_SERVICE)
 289                                 && (context != SDB_METRIC) && (context != SDB_ATTRIBUTE))
 290                         return 0;
 291                 if (expr->data.data.integer == SDB_FIELD_BACKEND)
 292                         return 1;
 293                 else if (expr->data.data.integer == SDB_FIELD_VALUE)
 294                         /* we don't current support this just like when using
 295                          * the attribute[<name>] syntax */
 296                         return 0;
 297         }
 298         else if (! expr->type) {
 299                 return !!(expr->data.type & SDB_TYPE_ARRAY);
 300         }
 301         return 0;
 302 } /* sdb_store_expr_iterable */
 303
 304 sdb_store_expr_iter_t *
 305 sdb_store_expr_iter(sdb_store_expr_t *expr, sdb_store_obj_t *obj,
 306                 sdb_store_matcher_t *filter)
 307 {
 308         sdb_store_expr_iter_t *iter;
 309         sdb_avltree_iter_t *tree = NULL;
 310         sdb_data_t array = SDB_DATA_INIT;
 311         bool free_array = 0;
 312
 313         if (! expr)
 314                 return NULL;
 315
 316         if (expr->type == TYPED_EXPR) {
 317                 if (! obj)
 318                         return NULL;
 319                 if (obj->type == SDB_HOST) {
 320                         if (expr->data.data.integer == SDB_SERVICE)
 321                                 tree = sdb_avltree_get_iter(HOST(obj)->services);
 322                         else if (expr->data.data.integer == SDB_METRIC)
 323                                 tree = sdb_avltree_get_iter(HOST(obj)->metrics);
 324                         else if (expr->data.data.integer == SDB_ATTRIBUTE)
 325                                 tree = sdb_avltree_get_iter(HOST(obj)->attributes);
 326                 }
 327                 else if (obj->type == SDB_SERVICE) {
 328                         if (expr->data.data.integer == SDB_ATTRIBUTE)
 329                                 tree = sdb_avltree_get_iter(SVC(obj)->attributes);
 330                 }
 331                 else if (obj->type == SDB_METRIC) {
 332                         if (expr->data.data.integer == SDB_ATTRIBUTE)
 333                                 tree = sdb_avltree_get_iter(METRIC(obj)->attributes);
 334                 }
 335         }
 336         else if (expr->type == FIELD_VALUE) {
 337                 if (! obj)
 338                         return NULL;
 339                 if (expr->data.data.integer == SDB_FIELD_BACKEND) {
 340                         /* while scanning the store, we hold a read lock, so it's safe to
 341                          * access the data without copying */
 342                         array.type = SDB_TYPE_ARRAY | SDB_TYPE_STRING;
 343                         array.data.array.length = obj->backends_num;
 344                         array.data.array.values = obj->backends;
 345                 }
 346         }
 347         else if (! expr->type) {
 348                 if (expr->data.type & SDB_TYPE_ARRAY)
 349                         array = expr->data;
 350         }
 351         else {
 352                 sdb_data_t value = SDB_DATA_INIT;
 353                 if (sdb_store_expr_eval(expr, obj, &value, filter))
 354                         return NULL;
 355                 if (! (value.type & SDB_TYPE_ARRAY)) {
 356                         sdb_data_free_datum(&value);
 357                         return NULL;
 358                 }
 359                 array = value;
 360                 free_array = 1;
 361         }
 362
 363         if ((! tree) && (array.type == SDB_TYPE_NULL))
 364                 return NULL;
 365
 366         iter = calloc(1, sizeof(*iter));
 367         if (! iter) {
 368                 if (free_array)
 369                         sdb_data_free_datum(&array);
 370                 return NULL;
 371         }
 372
 373         sdb_object_ref(SDB_OBJ(obj));
 374         sdb_object_ref(SDB_OBJ(expr));
 375         sdb_object_ref(SDB_OBJ(filter));
 376
 377         iter->obj = obj;
 378         iter->expr = expr;
 379         iter->tree = tree;
 380         iter->array = array;
 381         iter->free_array = free_array;
 382         iter->filter = filter;
 383         return iter;
 384 } /* sdb_store_expr_iter */
 385
 386 void
 387 sdb_store_expr_iter_destroy(sdb_store_expr_iter_t *iter)
 388 {
 389         sdb_data_t null = SDB_DATA_INIT;
 390
 391         if (! iter)
 392                 return;
 393
 394         if (iter->tree)
 395                 sdb_avltree_iter_destroy(iter->tree);
 396         iter->tree = NULL;
 397
 398         if (iter->free_array)
 399                 sdb_data_free_datum(&iter->array);
 400         iter->array = null;
 401         iter->array_idx = 0;
 402
 403         sdb_object_deref(SDB_OBJ(iter->obj));
 404         sdb_object_deref(SDB_OBJ(iter->expr));
 405         sdb_object_deref(SDB_OBJ(iter->filter));
 406         free(iter);
 407 } /* sdb_store_expr_iter_destroy */
 408
 409 bool
 410 sdb_store_expr_iter_has_next(sdb_store_expr_iter_t *iter)
 411 {
 412         if (! iter)
 413                 return 0;
 414
 415         if (iter->tree) {
 416                 /* this function may be called before get_next,
 417                  * so we'll have to apply filters here as well */
 418                 if (iter->filter) {
 419                         sdb_store_obj_t *child;
 420                         while ((child = STORE_OBJ(sdb_avltree_iter_peek_next(iter->tree)))) {
 421                                 if (sdb_store_matcher_matches(iter->filter, child, NULL))
 422                                         break;
 423                                 (void)sdb_avltree_iter_get_next(iter->tree);
 424                         }
 425                 }
 426
 427                 return sdb_avltree_iter_has_next(iter->tree);
 428         }
 429
 430         return iter->array_idx < iter->array.data.array.length;
 431 } /* sdb_store_expr_iter_has_next */
 432
 433 sdb_data_t
 434 sdb_store_expr_iter_get_next(sdb_store_expr_iter_t *iter)
 435 {
 436         sdb_data_t null = SDB_DATA_INIT;
 437         sdb_data_t ret = SDB_DATA_INIT;
 438         sdb_data_t tmp = SDB_DATA_INIT;
 439
 440         if (! iter)
 441                 return null;
 442
 443         if (iter->tree) {
 444                 sdb_store_obj_t *child;
 445
 446                 while (42) {
 447                         child = STORE_OBJ(sdb_avltree_iter_get_next(iter->tree));
 448                         if (! child)
 449                                 break;
 450                         if (iter->filter
 451                                         && (! sdb_store_matcher_matches(iter->filter, child, NULL)))
 452                                 continue;
 453
 454                         if (sdb_store_expr_eval(iter->expr, child, &ret, iter->filter))
 455                                 return null;
 456                         break;
 457                 }
 458
 459                 /* Skip over any filtered objects */
 460                 if (iter->filter) {
 461                         while ((child = STORE_OBJ(sdb_avltree_iter_peek_next(iter->tree)))) {
 462                                 if (sdb_store_matcher_matches(iter->filter, child, NULL))
 463                                         break;
 464                                 (void)sdb_avltree_iter_get_next(iter->tree);
 465                         }
 466                 }
 467
 468                 return ret;
 469         }
 470
 471         if (iter->array_idx >= iter->array.data.array.length)
 472                 return null;
 473
 474         ++iter->array_idx;
 475         if (sdb_data_array_get(&iter->array, iter->array_idx - 1, &ret))
 476                 return null;
 477         if (sdb_data_copy(&tmp, &ret))
 478                 return null;
 479         ret = tmp;
 480         return ret;
 481 } /* sdb_store_expr_iter_get_next */
 482
 483 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */
 484