src/include/parser/ast.h

   1 /*
   2  * SysDB - src/include/parser/ast.h
   3  * Copyright (C) 2013-2015 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  * The SysDB query language AST describes the parse-tree of an SysQL query.
  30  */
  31
  32 #ifndef SDB_PARSER_AST_H
  33 #define SDB_PARSER_AST_H 1
  34
  35 #include "core/data.h"
  36 #include "core/time.h"
  37 #include "core/object.h"
  38
  39 #include <assert.h>
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 /*
  46  * sdb_ast_node_type_t describes the type of an AST node.
  47  */
  48 typedef enum {
  49         /* command nodes */
  50         SDB_AST_TYPE_FETCH      = 1,
  51         SDB_AST_TYPE_LIST       = 2,
  52         SDB_AST_TYPE_LOOKUP     = 3,
  53         SDB_AST_TYPE_STORE      = 4,
  54         SDB_AST_TYPE_TIMESERIES = 5,
  55
  56         /* generic expressions */
  57         SDB_AST_TYPE_OPERATOR   = 100,
  58         SDB_AST_TYPE_ITERATOR   = 101,
  59
  60         /* values */
  61         SDB_AST_TYPE_CONST      = 200,
  62         SDB_AST_TYPE_VALUE      = 201,
  63
  64         SDB_AST_TYPE_TYPED      = 210,
  65 } sdb_ast_node_type_t;
  66
  67 /*
  68  * sdb_ast_operator_t describes the type of an operator.
  69  */
  70 typedef enum {
  71         /* logical and comparison operators */
  72 #define SDB_AST_IS_LOGICAL(n) \
  73         ((((n)->type == SDB_AST_TYPE_OPERATOR) \
  74                         && ((SDB_AST_AND <= SDB_AST_OP(n)->kind) \
  75                                 && (SDB_AST_OP(n)->kind <= SDB_AST_IN))) \
  76                 || (((n)->type == SDB_AST_TYPE_ITERATOR) \
  77                         && ((SDB_AST_ALL <= SDB_AST_ITER(n)->kind) \
  78                                 && (SDB_AST_ITER(n)->kind <= SDB_AST_ANY))))
  79         SDB_AST_AND    = 1000,
  80         SDB_AST_OR     = 1001,
  81         SDB_AST_NOT    = 1002,
  82
  83         SDB_AST_LT     = 1010,
  84         SDB_AST_LE     = 1011,
  85         SDB_AST_EQ     = 1012,
  86         SDB_AST_NE     = 1013,
  87         SDB_AST_GE     = 1014,
  88         SDB_AST_GT     = 1015,
  89         SDB_AST_REGEX  = 1016,
  90         SDB_AST_NREGEX = 1017,
  91         SDB_AST_ISNULL = 1018,
  92         SDB_AST_IN     = 1019,
  93
  94         /* arithmetic expressions */
  95 #define SDB_AST_IS_ARITHMETIC(n) \
  96         (((n)->type == SDB_AST_TYPE_CONST) \
  97                 || ((n)->type == SDB_AST_TYPE_VALUE) \
  98                 || ((n)->type == SDB_AST_TYPE_TYPED) \
  99                 || (((n)->type == SDB_AST_TYPE_OPERATOR) \
 100                         && ((SDB_AST_ADD <= SDB_AST_OP(n)->kind) \
 101                                 && (SDB_AST_OP(n)->kind <= SDB_AST_CONCAT))))
 102         SDB_AST_ADD    = 2000,
 103         SDB_AST_SUB    = 2001,
 104         SDB_AST_MUL    = 2002,
 105         SDB_AST_DIV    = 2003,
 106         SDB_AST_MOD    = 2004,
 107         SDB_AST_CONCAT = 2005,
 108
 109         /* iterators */
 110 #define SDB_AST_IS_ITERATOR(n) \
 111         (((n)->type == SDB_AST_TYPE_ITERATOR) \
 112                 && ((SDB_AST_ALL <= SDB_AST_ITER(n)->kind) \
 113                         && (SDB_AST_ITER(n)->kind <= SDB_AST_ANY)))
 114         SDB_AST_ALL    = 3000,
 115         SDB_AST_ANY    = 3001,
 116 } sdb_ast_operator_t;
 117
 118 #define SDB_AST_OP_TO_STRING(op) \
 119         (((op) == SDB_AST_AND) ? "AND" \
 120                 : ((op) == SDB_AST_OR) ? "OR" \
 121                 : ((op) == SDB_AST_NOT) ? "NOT" \
 122                 : ((op) == SDB_AST_LT) ? "LT" \
 123                 : ((op) == SDB_AST_LE) ? "LE" \
 124                 : ((op) == SDB_AST_EQ) ? "EQ" \
 125                 : ((op) == SDB_AST_NE) ? "NE" \
 126                 : ((op) == SDB_AST_GE) ? "GE" \
 127                 : ((op) == SDB_AST_GT) ? "GT" \
 128                 : ((op) == SDB_AST_REGEX) ? "REGEX" \
 129                 : ((op) == SDB_AST_NREGEX) ? "NREGEX" \
 130                 : ((op) == SDB_AST_ISNULL) ? "ISNULL" \
 131                 : ((op) == SDB_AST_IN) ? "IN" \
 132                 : ((op) == SDB_AST_ADD) ? "ADD" \
 133                 : ((op) == SDB_AST_SUB) ? "SUB" \
 134                 : ((op) == SDB_AST_MUL) ? "MUL" \
 135                 : ((op) == SDB_AST_DIV) ? "DIV" \
 136                 : ((op) == SDB_AST_MOD) ? "MOD" \
 137                 : ((op) == SDB_AST_CONCAT) ? "CONCAT" \
 138                 : ((op) == SDB_AST_ALL) ? "ALL" \
 139                 : ((op) == SDB_AST_ANY) ? "ANY" \
 140                 : "UNKNOWN")
 141
 142 #define SDB_AST_TYPE_TO_STRING(n) \
 143         (((n)->type == SDB_AST_TYPE_FETCH) ? "FETCH" \
 144                 : ((n)->type == SDB_AST_TYPE_LIST) ? "LIST" \
 145                 : ((n)->type == SDB_AST_TYPE_LOOKUP) ? "LOOKUP" \
 146                 : ((n)->type == SDB_AST_TYPE_STORE) ? "STORE" \
 147                 : ((n)->type == SDB_AST_TYPE_TIMESERIES) ? "TIMESERIES" \
 148                 : ((n)->type == SDB_AST_TYPE_OPERATOR) \
 149                         ? SDB_AST_OP_TO_STRING(SDB_AST_OP(n)->kind) \
 150                 : ((n)->type == SDB_AST_TYPE_ITERATOR) ? "ITERATOR" \
 151                 : ((n)->type == SDB_AST_TYPE_CONST) ? "CONSTANT" \
 152                 : ((n)->type == SDB_AST_TYPE_VALUE) ? "VALUE" \
 153                 : ((n)->type == SDB_AST_TYPE_TYPED) ? "TYPED VALUE" \
 154                 : "UNKNOWN")
 155
 156 /*
 157  * sdb_ast_node_t is the interface for AST nodes. The first field of any
 158  * actual implementation of the interface is of type sdb_ast_node_t to
 159  * fascilitate casting between the interface and implementation types.
 160  *
 161  * It inherits from sdb_object_t and instances may safely be cast to a generic
 162  * object as well.
 163  */
 164 typedef struct {
 165         sdb_object_t super;
 166
 167         /* type describes the type of the actual node */
 168         int type;
 169
 170         /* data-type describes the type of the result value */
 171         int data_type;
 172 } sdb_ast_node_t;
 173 #define SDB_AST_NODE(obj) ((sdb_ast_node_t *)(obj))
 174
 175 /*
 176  * sdb_ast_op_t represents a simple operation.
 177  */
 178 typedef struct {
 179         sdb_ast_node_t super;
 180         int kind;
 181         /* left operand is NULL for unary expressions */
 182         sdb_ast_node_t *left;
 183         sdb_ast_node_t *right;
 184 } sdb_ast_op_t;
 185 #define SDB_AST_OP(obj) ((sdb_ast_op_t *)(obj))
 186 #define SDB_AST_OP_INIT \
 187         { { SDB_OBJECT_INIT, SDB_AST_TYPE_OPERATOR, -1 }, -1, NULL, NULL }
 188
 189 /*
 190  * sdb_ast_iter_t represents an iterator.
 191  */
 192 typedef struct {
 193         sdb_ast_node_t super;
 194         int kind;
 195         sdb_ast_node_t *iter;
 196         /* exactly one operand of the expression has to be unset and will be
 197          * filled in by the iterator value */
 198         sdb_ast_node_t *expr;
 199 } sdb_ast_iter_t;
 200 #define SDB_AST_ITER(obj) ((sdb_ast_iter_t *)(obj))
 201 #define SDB_AST_ITER_INIT \
 202         { { SDB_OBJECT_INIT, SDB_AST_TYPE_ITERATOR, -1 }, -1, NULL, NULL }
 203
 204 /*
 205  * sdb_ast_typed_t represents a typed value.
 206  */
 207 typedef struct {
 208         sdb_ast_node_t super;
 209         int type;
 210         sdb_ast_node_t *expr;
 211 } sdb_ast_typed_t;
 212 #define SDB_AST_TYPED(obj) ((sdb_ast_typed_t *)(obj))
 213 #define SDB_AST_TYPED_INIT \
 214         { { SDB_OBJECT_INIT, SDB_AST_TYPE_TYPED, -1 }, -1, NULL }
 215
 216 /*
 217  * sdb_ast_const_t represents a constant value.
 218  */
 219 typedef struct {
 220         sdb_ast_node_t super;
 221         sdb_data_t value;
 222 } sdb_ast_const_t;
 223 #define SDB_AST_CONST(obj) ((sdb_ast_const_t *)(obj))
 224 #define SDB_AST_CONST_INIT \
 225         { { SDB_OBJECT_INIT, SDB_AST_TYPE_CONST, -1 }, SDB_DATA_INIT }
 226
 227 /*
 228  * sdb_ast_value_t represents an object-specific value: sibling nodes,
 229  * attributes, or field values.
 230  */
 231 typedef struct {
 232         sdb_ast_node_t super;
 233         int type; /* attribute or field */
 234         char *name; /* object name; optional */
 235 } sdb_ast_value_t;
 236 #define SDB_AST_VALUE(obj) ((sdb_ast_value_t *)(obj))
 237 #define SDB_AST_VALUE_INIT \
 238         { { SDB_OBJECT_INIT, SDB_AST_TYPE_VALUE, -1 }, -1, NULL }
 239
 240 /*
 241  * sdb_ast_fetch_t represents a FETCH command.
 242  */
 243 typedef struct {
 244         sdb_ast_node_t super;
 245         int obj_type;
 246         char *hostname; /* optional */
 247         char *name;
 248         sdb_ast_node_t *filter; /* optional */
 249 } sdb_ast_fetch_t;
 250 #define SDB_AST_FETCH(obj) ((sdb_ast_fetch_t *)(obj))
 251 #define SDB_AST_FETCH_INIT \
 252         { { SDB_OBJECT_INIT, SDB_AST_TYPE_FETCH, -1 }, -1, NULL, NULL, NULL }
 253
 254 /*
 255  * sdb_ast_list_t represents a LIST command.
 256  */
 257 typedef struct {
 258         sdb_ast_node_t super;
 259         int obj_type;
 260         sdb_ast_node_t *filter; /* optional */
 261 } sdb_ast_list_t;
 262 #define SDB_AST_LIST(obj) ((sdb_ast_list_t *)(obj))
 263 #define SDB_AST_LIST_INIT \
 264         { { SDB_OBJECT_INIT, SDB_AST_TYPE_LIST, -1 }, -1, NULL }
 265
 266 /*
 267  * sdb_ast_lookup_t represents a LOOKUP command.
 268  */
 269 typedef struct {
 270         sdb_ast_node_t super;
 271         int obj_type;
 272         sdb_ast_node_t *matcher; /* optional */
 273         sdb_ast_node_t *filter; /* optional */
 274 } sdb_ast_lookup_t;
 275 #define SDB_AST_LOOKUP(obj) ((sdb_ast_lookup_t *)(obj))
 276 #define SDB_AST_LOOKUP_INIT \
 277         { { SDB_OBJECT_INIT, SDB_AST_TYPE_LOOKUP, -1 }, -1, NULL, NULL }
 278
 279 /*
 280  * sdb_ast_store_t represents a STORE command.
 281  */
 282 typedef struct {
 283         sdb_ast_node_t super;
 284         int obj_type;
 285         char *hostname;  /* optional */
 286         int parent_type; /* optional */
 287         char *parent;    /* optional */
 288         char *name;
 289         sdb_time_t last_update;
 290
 291         /* metric specific */
 292         char *store_type;
 293         char *store_id;
 294
 295         /* attribute specific */
 296         sdb_data_t value;
 297 } sdb_ast_store_t;
 298 #define SDB_AST_STORE(obj) ((sdb_ast_store_t *)(obj))
 299 #define SDB_AST_STORE_INIT \
 300         { { SDB_OBJECT_INIT, SDB_AST_TYPE_STORE, -1 }, \
 301                 -1, NULL, -1, NULL, NULL, 0, NULL, NULL, SDB_DATA_INIT }
 302
 303 /*
 304  * sdb_ast_timeseries_t represents a TIMESERIES command.
 305  */
 306 typedef struct {
 307         sdb_ast_node_t super;
 308         char *hostname;
 309         char *metric;
 310         sdb_time_t start;
 311         sdb_time_t end;
 312 } sdb_ast_timeseries_t;
 313 #define SDB_AST_TIMESERIES(obj) ((sdb_ast_timeseries_t *)(obj))
 314 #define SDB_AST_TIMESERIES_INIT \
 315         { { SDB_OBJECT_INIT, SDB_AST_TYPE_TIMESERIES, -1 }, NULL, NULL, 0, 0 }
 316
 317 /*
 318  * AST constructors:
 319  * Newly created nodes take ownership of any dynamically allocated objects
 320  * (node objects, dynamically allocated constant values, strings). The memory
 321  * will be freed when destroying the node using sdb_object_deref.
 322  *
 323  * The constructors do not verify any arguments. The analyzer has to be used
 324  * for that purpose.
 325  */
 326
 327 /*
 328  * sdb_ast_op_create:
 329  * Creates an AST node representing a simple (ary or unary) operation. The
 330  * newly created node takes ownership of the left and right nodes.
 331  */
 332 sdb_ast_node_t *
 333 sdb_ast_op_create(int kind, sdb_ast_node_t *left, sdb_ast_node_t *right);
 334
 335 /*
 336  * sdb_ast_iter_create:
 337  * Creates an AST node representing an iterator. The newly created node takes
 338  * ownership of the iter and expr nodes.
 339  */
 340 sdb_ast_node_t *
 341 sdb_ast_iter_create(int kind, sdb_ast_node_t *iter, sdb_ast_node_t *expr);
 342
 343 /*
 344  * sdb_ast_typed_create:
 345  * Creates an AST node representing a typed expression. Thew newly created
 346  * node takes ownership of the expr node.
 347  */
 348 sdb_ast_node_t *
 349 sdb_ast_typed_create(int type, sdb_ast_node_t *expr);
 350
 351 /*
 352  * sdb_ast_const_create:
 353  * Creates an AST node representing a constant value. The newly created node
 354  * takes ownership of the value object.
 355  */
 356 sdb_ast_node_t *
 357 sdb_ast_const_create(sdb_data_t value);
 358
 359 /*
 360  * sdb_ast_value_create:
 361  * Creates an AST node representing an object-specific value (sibling nodes,
 362  * attributes, or field values). The newly created node takes ownership of the
 363  * string value.
 364  */
 365 sdb_ast_node_t *
 366 sdb_ast_value_create(int type, char *name);
 367
 368 /*
 369  * sdb_ast_fetch_create:
 370  * Creates an AST node representing a FETCH command. The newly created node
 371  * takes ownership of the strings and the filter node.
 372  */
 373 sdb_ast_node_t *
 374 sdb_ast_fetch_create(int obj_type, char *hostname, char *name,
 375                 sdb_ast_node_t *filter);
 376
 377 /*
 378  * sdb_ast_list_create:
 379  * Creates an AST node representing a LIST command. The newly created node
 380  * takes ownership of the filter node.
 381  */
 382 sdb_ast_node_t *
 383 sdb_ast_list_create(int obj_type, sdb_ast_node_t *filter);
 384
 385 /*
 386  * sdb_ast_lookup_create:
 387  * Creates an AST node representing a LOOKUP command. The newly created node
 388  * takes ownership of the matcher and filter nodes.
 389  */
 390 sdb_ast_node_t *
 391 sdb_ast_lookup_create(int obj_type, sdb_ast_node_t *matcher,
 392                 sdb_ast_node_t *filter);
 393
 394 /*
 395  * sdb_ast_store_create:
 396  * Creates an AST node representing a STORE command. Thew newly created node
 397  * takes ownership of all strings and the value object.
 398  */
 399 sdb_ast_node_t *
 400 sdb_ast_store_create(int obj_type, char *hostname,
 401                 int parent_type, char *parent, char *name, sdb_time_t last_update,
 402                 char *store_type, char *store_id, sdb_data_t value);
 403
 404 /*
 405  * sdb_ast_timeseries_create:
 406  * Creates an AST node representing a TIMESERIES command. The newly created
 407  * node takes ownership of the strings.
 408  */
 409 sdb_ast_node_t *
 410 sdb_ast_timeseries_create(char *hostname, char *metric,
 411                 sdb_time_t start, sdb_time_t end);
 412
 413 #ifdef __cplusplus
 414 } /* extern "C" */
 415 #endif
 416
 417 #endif /* ! SDB_PARSER_AST_H */
 418
 419 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */
 420