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 } sdb_ast_node_t;
 170 #define SDB_AST_NODE(obj) ((sdb_ast_node_t *)(obj))
 171
 172 /*
 173  * sdb_ast_op_t represents a simple operation.
 174  */
 175 typedef struct {
 176         sdb_ast_node_t super;
 177         int kind;
 178         /* left operand is NULL for unary expressions */
 179         sdb_ast_node_t *left;
 180         sdb_ast_node_t *right;
 181 } sdb_ast_op_t;
 182 #define SDB_AST_OP(obj) ((sdb_ast_op_t *)(obj))
 183 #define SDB_AST_OP_INIT \
 184         { { SDB_OBJECT_INIT, SDB_AST_TYPE_OPERATOR }, -1, NULL, NULL }
 185
 186 /*
 187  * sdb_ast_iter_t represents an iterator.
 188  */
 189 typedef struct {
 190         sdb_ast_node_t super;
 191         int kind;
 192         int op;
 193         sdb_ast_node_t *iter;
 194         /* exactly one operand of the expression has to be unset and will be
 195          * filled in by the iterator value */
 196         sdb_ast_node_t *expr;
 197 } sdb_ast_iter_t;
 198 #define SDB_AST_ITER(obj) ((sdb_ast_iter_t *)(obj))
 199 #define SDB_AST_ITER_INIT \
 200         { { SDB_OBJECT_INIT, SDB_AST_TYPE_ITERATOR }, -1, -1, NULL, NULL }
 201
 202 /*
 203  * sdb_ast_typed_t represents a typed value.
 204  */
 205 typedef struct {
 206         sdb_ast_node_t super;
 207         int type;
 208         sdb_ast_node_t *expr;
 209 } sdb_ast_typed_t;
 210 #define SDB_AST_TYPED(obj) ((sdb_ast_typed_t *)(obj))
 211 #define SDB_AST_TYPED_INIT \
 212         { { SDB_OBJECT_INIT, SDB_AST_TYPE_TYPED }, -1, NULL }
 213
 214 /*
 215  * sdb_ast_const_t represents a constant value.
 216  */
 217 typedef struct {
 218         sdb_ast_node_t super;
 219         sdb_data_t value;
 220 } sdb_ast_const_t;
 221 #define SDB_AST_CONST(obj) ((sdb_ast_const_t *)(obj))
 222 #define SDB_AST_CONST_INIT \
 223         { { SDB_OBJECT_INIT, SDB_AST_TYPE_CONST }, SDB_DATA_INIT }
 224
 225 /*
 226  * sdb_ast_value_t represents an object-specific value: sibling nodes,
 227  * attributes, or field values.
 228  */
 229 typedef struct {
 230         sdb_ast_node_t super;
 231         int type; /* attribute or field */
 232         char *name; /* object name; optional */
 233 } sdb_ast_value_t;
 234 #define SDB_AST_VALUE(obj) ((sdb_ast_value_t *)(obj))
 235 #define SDB_AST_VALUE_INIT \
 236         { { SDB_OBJECT_INIT, SDB_AST_TYPE_VALUE }, -1, NULL }
 237
 238 /*
 239  * sdb_ast_fetch_t represents a FETCH command.
 240  */
 241 typedef struct {
 242         sdb_ast_node_t super;
 243         int obj_type;
 244         char *hostname; /* optional */
 245         char *name;
 246         sdb_ast_node_t *filter; /* optional */
 247 } sdb_ast_fetch_t;
 248 #define SDB_AST_FETCH(obj) ((sdb_ast_fetch_t *)(obj))
 249 #define SDB_AST_FETCH_INIT \
 250         { { SDB_OBJECT_INIT, SDB_AST_TYPE_FETCH }, -1, NULL, NULL, NULL }
 251
 252 /*
 253  * sdb_ast_list_t represents a LIST command.
 254  */
 255 typedef struct {
 256         sdb_ast_node_t super;
 257         int obj_type;
 258         sdb_ast_node_t *filter; /* optional */
 259 } sdb_ast_list_t;
 260 #define SDB_AST_LIST(obj) ((sdb_ast_list_t *)(obj))
 261 #define SDB_AST_LIST_INIT \
 262         { { SDB_OBJECT_INIT, SDB_AST_TYPE_LIST }, -1, NULL }
 263
 264 /*
 265  * sdb_ast_lookup_t represents a LOOKUP command.
 266  */
 267 typedef struct {
 268         sdb_ast_node_t super;
 269         int obj_type;
 270         sdb_ast_node_t *matcher; /* optional */
 271         sdb_ast_node_t *filter; /* optional */
 272 } sdb_ast_lookup_t;
 273 #define SDB_AST_LOOKUP(obj) ((sdb_ast_lookup_t *)(obj))
 274 #define SDB_AST_LOOKUP_INIT \
 275         { { SDB_OBJECT_INIT, SDB_AST_TYPE_LOOKUP }, -1, NULL, NULL }
 276
 277 /*
 278  * sdb_ast_store_t represents a STORE command.
 279  */
 280 typedef struct {
 281         sdb_ast_node_t super;
 282         int obj_type;
 283         char *hostname;  /* optional */
 284         int parent_type; /* optional */
 285         char *parent;    /* optional */
 286         char *name;
 287         sdb_time_t last_update;
 288
 289         /* metric specific */
 290         char *store_type;
 291         char *store_id;
 292
 293         /* attribute specific */
 294         sdb_data_t value;
 295 } sdb_ast_store_t;
 296 #define SDB_AST_STORE(obj) ((sdb_ast_store_t *)(obj))
 297 #define SDB_AST_STORE_INIT \
 298         { { SDB_OBJECT_INIT, SDB_AST_TYPE_STORE }, \
 299                 -1, NULL, -1, NULL, NULL, 0, NULL, NULL, SDB_DATA_INIT }
 300
 301 /*
 302  * sdb_ast_timeseries_t represents a TIMESERIES command.
 303  */
 304 typedef struct {
 305         sdb_ast_node_t super;
 306         char *hostname;
 307         char *metric;
 308         sdb_time_t start;
 309         sdb_time_t end;
 310 } sdb_ast_timeseries_t;
 311 #define SDB_AST_TIMESERIES(obj) ((sdb_ast_timeseries_t *)(obj))
 312 #define SDB_AST_TIMESERIES_INIT \
 313         { { SDB_OBJECT_INIT, SDB_AST_TYPE_TIMESERIES }, NULL, NULL, 0, 0 }
 314
 315 /*
 316  * AST constructors:
 317  * Newly created nodes take ownership of any dynamically allocated objects
 318  * (node objects, dynamically allocated constant values, strings). The memory
 319  * will be freed when destroying the node using sdb_object_deref.
 320  *
 321  * The constructors do not verify any arguments. The analyzer has to be used
 322  * for that purpose.
 323  */
 324
 325 /*
 326  * sdb_ast_op_create:
 327  * Creates an AST node representing a simple (ary or unary) operation. The
 328  * newly created node takes ownership of the left and right nodes.
 329  */
 330 sdb_ast_node_t *
 331 sdb_ast_op_create(int kind, sdb_ast_node_t *left, sdb_ast_node_t *right);
 332
 333 /*
 334  * sdb_ast_iter_create:
 335  * Creates an AST node representing an iterator. The newly created node takes
 336  * ownership of the iter and expr nodes.
 337  */
 338 sdb_ast_node_t *
 339 sdb_ast_iter_create(int kind, int op,
 340                 sdb_ast_node_t *iter, sdb_ast_node_t *expr);
 341
 342 /*
 343  * sdb_ast_typed_create:
 344  * Creates an AST node representing a typed expression. Thew newly created
 345  * node takes ownership of the expr node.
 346  */
 347 sdb_ast_node_t *
 348 sdb_ast_typed_create(int type, sdb_ast_node_t *expr);
 349
 350 /*
 351  * sdb_ast_const_create:
 352  * Creates an AST node representing a constant value. The newly created node
 353  * takes ownership of the value object.
 354  */
 355 sdb_ast_node_t *
 356 sdb_ast_const_create(sdb_data_t value);
 357
 358 /*
 359  * sdb_ast_value_create:
 360  * Creates an AST node representing an object-specific value (sibling nodes,
 361  * attributes, or field values). The newly created node takes ownership of the
 362  * string value.
 363  */
 364 sdb_ast_node_t *
 365 sdb_ast_value_create(int type, char *name);
 366
 367 /*
 368  * sdb_ast_fetch_create:
 369  * Creates an AST node representing a FETCH command. The newly created node
 370  * takes ownership of the strings and the filter node.
 371  */
 372 sdb_ast_node_t *
 373 sdb_ast_fetch_create(int obj_type, char *hostname, char *name,
 374                 sdb_ast_node_t *filter);
 375
 376 /*
 377  * sdb_ast_list_create:
 378  * Creates an AST node representing a LIST command. The newly created node
 379  * takes ownership of the filter node.
 380  */
 381 sdb_ast_node_t *
 382 sdb_ast_list_create(int obj_type, sdb_ast_node_t *filter);
 383
 384 /*
 385  * sdb_ast_lookup_create:
 386  * Creates an AST node representing a LOOKUP command. The newly created node
 387  * takes ownership of the matcher and filter nodes.
 388  */
 389 sdb_ast_node_t *
 390 sdb_ast_lookup_create(int obj_type, sdb_ast_node_t *matcher,
 391                 sdb_ast_node_t *filter);
 392
 393 /*
 394  * sdb_ast_store_create:
 395  * Creates an AST node representing a STORE command. Thew newly created node
 396  * takes ownership of all strings and the value object.
 397  */
 398 sdb_ast_node_t *
 399 sdb_ast_store_create(int obj_type, char *hostname,
 400                 int parent_type, char *parent, char *name, sdb_time_t last_update,
 401                 char *store_type, char *store_id, sdb_data_t value);
 402
 403 /*
 404  * sdb_ast_timeseries_create:
 405  * Creates an AST node representing a TIMESERIES command. The newly created
 406  * node takes ownership of the strings.
 407  */
 408 sdb_ast_node_t *
 409 sdb_ast_timeseries_create(char *hostname, char *metric,
 410                 sdb_time_t start, sdb_time_t end);
 411
 412 #ifdef __cplusplus
 413 } /* extern "C" */
 414 #endif
 415
 416 #endif /* ! SDB_PARSER_AST_H */
 417
 418 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */
 419