Move to kernel style SPDX license identifiers
[lttng-tools.git] / src / lib / lttng-ctl / filter / filter-visitor-generate-ir.c
index 1458cc72857dc2eb4378603d0fe6c180e4108537..024aac6398ab068ac2d9a2ff860e7cd65f5d5287 100644 (file)
@@ -3,20 +3,10 @@
  *
  * LTTng filter generate intermediate representation
  *
- * Copyright 2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ * Copyright 2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
  *
- * This library is free software; you can redistribute it and/or modify it
- * under the terms of the GNU Lesser General Public License, version 2.1 only,
- * as published by the Free Software Foundation.
+ * SPDX-License-Identifier: LGPL-2.1-only
  *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this library; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 #include <stdio.h>
@@ -31,6 +21,7 @@
 #include "filter-ir.h"
 
 #include <common/macros.h>
+#include <common/string-utils/string-utils.h>
 
 static
 struct ir_op *generate_ir_recursive(struct filter_parser_ctx *ctx,
@@ -57,6 +48,7 @@ struct ir_op *make_op_root(struct ir_op *child, enum ir_side side)
        case IR_DATA_NUMERIC:
        case IR_DATA_FIELD_REF:
        case IR_DATA_GET_CONTEXT_REF:
+       case IR_DATA_EXPRESSION:
                /* ok */
                break;
        }
@@ -68,6 +60,22 @@ struct ir_op *make_op_root(struct ir_op *child, enum ir_side side)
        return op;
 }
 
+static
+enum ir_load_string_type get_literal_string_type(const char *string)
+{
+       assert(string);
+
+       if (strutils_is_star_glob_pattern(string)) {
+               if (strutils_is_star_at_the_end_only_glob_pattern(string)) {
+                       return IR_LOAD_STRING_TYPE_GLOB_STAR_END;
+               }
+
+               return IR_LOAD_STRING_TYPE_GLOB_STAR;
+       }
+
+       return IR_LOAD_STRING_TYPE_PLAIN;
+}
+
 static
 struct ir_op *make_op_load_string(char *string, enum ir_side side)
 {
@@ -80,8 +88,9 @@ struct ir_op *make_op_load_string(char *string, enum ir_side side)
        op->data_type = IR_DATA_STRING;
        op->signedness = IR_SIGN_UNKNOWN;
        op->side = side;
-       op->u.load.u.string = strdup(string);
-       if (!op->u.load.u.string) {
+       op->u.load.u.string.type = get_literal_string_type(string);
+       op->u.load.u.string.value = strdup(string);
+       if (!op->u.load.u.string.value) {
                free(op);
                return NULL;
        }
@@ -122,27 +131,149 @@ struct ir_op *make_op_load_float(double v, enum ir_side side)
 }
 
 static
-struct ir_op *make_op_load_field_ref(char *string, enum ir_side side)
+void free_load_expression(struct ir_load_expression *load_expression)
 {
-       struct ir_op *op;
+       struct ir_load_expression_op *exp_op;
 
-       op = calloc(sizeof(struct ir_op), 1);
-       if (!op)
+       if (!load_expression)
+               return;
+       exp_op = load_expression->child;
+       for (;;) {
+               struct ir_load_expression_op *prev_exp_op;
+
+               if (!exp_op)
+                       break;
+               switch (exp_op->type) {
+               case IR_LOAD_EXPRESSION_GET_CONTEXT_ROOT:
+               case IR_LOAD_EXPRESSION_GET_APP_CONTEXT_ROOT:
+               case IR_LOAD_EXPRESSION_GET_PAYLOAD_ROOT:
+               case IR_LOAD_EXPRESSION_GET_INDEX:
+               case IR_LOAD_EXPRESSION_LOAD_FIELD:
+                       break;
+               case IR_LOAD_EXPRESSION_GET_SYMBOL:
+                       free(exp_op->u.symbol);
+                       break;
+               }
+               prev_exp_op = exp_op;
+               exp_op = exp_op->next;
+               free(prev_exp_op);
+       }
+       free(load_expression);
+}
+
+/*
+ * Returns the first node of the chain, after initializing the next
+ * pointers.
+ */
+static
+struct filter_node *load_expression_get_forward_chain(struct filter_node *node)
+{
+       struct filter_node *prev_node;
+
+       for (;;) {
+               assert(node->type == NODE_EXPRESSION);
+               prev_node = node;
+               node = node->u.expression.prev;
+               if (!node) {
+                       break;
+               }
+               node->u.expression.next = prev_node;
+       }
+       return prev_node;
+}
+
+static
+struct ir_load_expression *create_load_expression(struct filter_node *node)
+{
+       struct ir_load_expression *load_exp;
+       struct ir_load_expression_op *load_exp_op, *prev_op;
+       char *str;
+
+       /* Get forward chain. */
+       node = load_expression_get_forward_chain(node);
+       if (!node)
                return NULL;
-       op->op = IR_OP_LOAD;
-       op->data_type = IR_DATA_FIELD_REF;
-       op->signedness = IR_SIGN_DYN;
-       op->side = side;
-       op->u.load.u.ref = strdup(string);
-       if (!op->u.load.u.ref) {
-               free(op);
+       load_exp = calloc(sizeof(struct ir_load_expression), 1);
+       if (!load_exp)
                return NULL;
+
+       /* Root */
+       load_exp_op = calloc(sizeof(struct ir_load_expression_op), 1);
+       if (!load_exp_op)
+               goto error;
+       load_exp->child = load_exp_op;
+       str = node->u.expression.u.string;
+       if (!strcmp(str, "$ctx")) {
+               load_exp_op->type = IR_LOAD_EXPRESSION_GET_CONTEXT_ROOT;
+               node = node->u.expression.next;
+               if (!node) {
+                       fprintf(stderr, "[error] Expecting identifier after \'%s\'\n", str);
+                       goto error;
+               }
+               str = node->u.expression.u.string;
+       } else if (!strcmp(str, "$app")) {
+               load_exp_op->type = IR_LOAD_EXPRESSION_GET_APP_CONTEXT_ROOT;
+               node = node->u.expression.next;
+               if (!node) {
+                       fprintf(stderr, "[error] Expecting identifier after \'%s\'\n", str);
+                       goto error;
+               }
+               str = node->u.expression.u.string;
+       } else if (str[0] == '$') {
+               fprintf(stderr, "[error] Unexpected identifier \'%s\'\n", str);
+               goto error;
+       } else {
+               load_exp_op->type = IR_LOAD_EXPRESSION_GET_PAYLOAD_ROOT;
        }
-       return op;
+
+       for (;;) {
+               struct filter_node *bracket_node;
+
+               prev_op = load_exp_op;
+               load_exp_op = calloc(sizeof(struct ir_load_expression_op), 1);
+               if (!load_exp_op)
+                       goto error;
+               prev_op->next = load_exp_op;
+               load_exp_op->type = IR_LOAD_EXPRESSION_GET_SYMBOL;
+               load_exp_op->u.symbol = strdup(str);
+               if (!load_exp_op->u.symbol)
+                       goto error;
+
+               /* Explore brackets from current node. */
+               for (bracket_node = node->u.expression.next_bracket;
+                               bracket_node != NULL;
+                               bracket_node = bracket_node->u.expression.next_bracket) {
+                       prev_op = load_exp_op;
+                       load_exp_op = calloc(sizeof(struct ir_load_expression_op), 1);
+                       if (!load_exp_op)
+                               goto error;
+                       prev_op->next = load_exp_op;
+                       load_exp_op->type = IR_LOAD_EXPRESSION_GET_INDEX;
+                       load_exp_op->u.index = bracket_node->u.expression.u.constant;
+               }
+               /* Go to next chain element. */
+               node = node->u.expression.next;
+               if (!node)
+                       break;
+               str = node->u.expression.u.string;
+       }
+       /* Add final load field */
+       prev_op = load_exp_op;
+       load_exp_op = calloc(sizeof(struct ir_load_expression_op), 1);
+       if (!load_exp_op)
+               goto error;
+       prev_op->next = load_exp_op;
+       load_exp_op->type = IR_LOAD_EXPRESSION_LOAD_FIELD;
+       return load_exp;
+
+error:
+       free_load_expression(load_exp);
+       return NULL;
 }
 
 static
-struct ir_op *make_op_load_get_context_ref(char *string, enum ir_side side)
+struct ir_op *make_op_load_expression(struct filter_node *node,
+               enum ir_side side)
 {
        struct ir_op *op;
 
@@ -150,15 +281,19 @@ struct ir_op *make_op_load_get_context_ref(char *string, enum ir_side side)
        if (!op)
                return NULL;
        op->op = IR_OP_LOAD;
-       op->data_type = IR_DATA_GET_CONTEXT_REF;
+       op->data_type = IR_DATA_EXPRESSION;
        op->signedness = IR_SIGN_DYN;
        op->side = side;
-       op->u.load.u.ref = strdup(string);
-       if (!op->u.load.u.ref) {
-               free(op);
-               return NULL;
+       op->u.load.u.expression = create_load_expression(node);
+       if (!op->u.load.u.expression) {
+               goto error;
        }
        return op;
+
+error:
+       free_load_expression(op->u.load.u.expression);
+       free(op);
+       return NULL;
 }
 
 static
@@ -213,134 +348,12 @@ struct ir_op *make_op_unary_not(struct ir_op *child, enum ir_side side)
                        child, side);
 }
 
-#if 0
-static
-struct ir_op *make_op_binary_numeric(enum op_type bin_op_type,
-               const char *op_str, struct ir_op *left, struct ir_op *right,
-               enum ir_side side)
-{
-       struct ir_op *op = NULL;
-
-       if (right->data_type == IR_DATA_STRING
-                       || right->data_type == IR_DATA_STRING) {
-               fprintf(stderr, "[error] binary operation '%s' not allowed on string literal\n", op_str);
-               goto error;
-       }
-       if (left->data_type == IR_DATA_UNKNOWN
-               || right->data_type == IR_DATA_UNKNOWN) {
-               fprintf(stderr, "[error] binary operation '%s' has unknown type for both children\n", op_str);
-               goto error;
-
-       }
-
-       op = calloc(sizeof(struct ir_op_binary), 1);
-       if (!op)
-               return NULL;
-       op->op = IR_OP_BINARY;
-       op->u.binary.type = bin_op_type;
-       op->u.binary.left = left;
-       op->u.binary.right = right;
-       op->side = side;
-
-       /*
-        * The field that is not a field ref will select type.
-        */
-       if (left->data_type != IR_DATA_FIELD_REF
-                       && left->data_type != IR_DATA_GET_CONTEXT_REF)
-               op->data_type = left->data_type;
-       else
-               op->data_type = right->data_type;
-
-       if (left->signedness == IR_SIGNED
-                       || right->signedness == IR_SIGNED) {
-               op->signedness = IR_SIGNED;
-       } else if (left->signedness == IR_SIGN_DYN
-                       || right->signedness == IR_SIGN_DYN) {
-               op->signedness = IR_SIGN_DYN;
-       } else if (left->signedness == IR_UNSIGNED
-                       && right->signedness == IR_UNSIGNED) {
-               op->signedness = IR_UNSIGNED;
-       } else {
-               op->signedness = IR_SIGN_UNKNOWN;
-       }
-
-       return op;
-
-error:
-       free(op);
-       return NULL;
-}
-
-static
-struct ir_op *make_op_binary_mul(struct ir_op *left, struct ir_op *right,
-               enum ir_side side)
-{
-       return make_op_binary_numeric(AST_OP_MUL, "*", left, right, side);
-}
-
-static
-struct ir_op *make_op_binary_div(struct ir_op *left, struct ir_op *right,
-               enum ir_side side)
-{
-       return make_op_binary_numeric(AST_OP_DIV, "/", left, right, side);
-}
-
-static
-struct ir_op *make_op_binary_mod(struct ir_op *left, struct ir_op *right,
-               enum ir_side side)
-{
-       return make_op_binary_numeric(AST_OP_MOD, "%", left, right, side);
-}
-
-static
-struct ir_op *make_op_binary_plus(struct ir_op *left, struct ir_op *right,
-               enum ir_side side)
-{
-       return make_op_binary_numeric(AST_OP_PLUS, "+", left, right, side);
-}
-
-static
-struct ir_op *make_op_binary_minus(struct ir_op *left, struct ir_op *right,
-               enum ir_side side)
-{
-       return make_op_binary_numeric(AST_OP_MINUS, "-", left, right, side);
-}
-
-static
-struct ir_op *make_op_binary_rshift(struct ir_op *left, struct ir_op *right,
-               enum ir_side side)
-{
-       return make_op_binary_numeric(AST_OP_RSHIFT, ">>", left, right, side);
-}
-
-static
-struct ir_op *make_op_binary_lshift(struct ir_op *left, struct ir_op *right,
-               enum ir_side side)
-{
-       return make_op_binary_numeric(AST_OP_LSHIFT, "<<", left, right, side);
-}
-
 static
-struct ir_op *make_op_binary_and(struct ir_op *left, struct ir_op *right,
-               enum ir_side side)
+struct ir_op *make_op_unary_bit_not(struct ir_op *child, enum ir_side side)
 {
-       return make_op_binary_numeric(AST_OP_BIN_AND, "&", left, right, side);
-}
-
-static
-struct ir_op *make_op_binary_or(struct ir_op *left, struct ir_op *right,
-               enum ir_side side)
-{
-       return make_op_binary_numeric(AST_OP_BIN_OR, "|", left, right, side);
-}
-
-static
-struct ir_op *make_op_binary_xor(struct ir_op *left, struct ir_op *right,
-               enum ir_side side)
-{
-       return make_op_binary_numeric(AST_OP_BIN_XOR, "^", left, right, side);
+       return make_op_unary(AST_UNARY_BIT_NOT, "~", child->signedness,
+                       child, side);
 }
-#endif //0
 
 static
 struct ir_op *make_op_binary_compare(enum op_type bin_op_type,
@@ -464,6 +477,50 @@ error:
        return NULL;
 }
 
+static
+struct ir_op *make_op_binary_bitwise(enum op_type bin_op_type,
+               const char *op_str, struct ir_op *left, struct ir_op *right,
+               enum ir_side side)
+{
+       struct ir_op *op = NULL;
+
+       if (left->data_type == IR_DATA_UNKNOWN
+               || right->data_type == IR_DATA_UNKNOWN) {
+               fprintf(stderr, "[error] bitwise binary operation '%s' has unknown operand type\n", op_str);
+               goto error;
+
+       }
+       if (left->data_type == IR_DATA_STRING
+               || right->data_type == IR_DATA_STRING) {
+               fprintf(stderr, "[error] bitwise binary operation '%s' cannot have string operand\n", op_str);
+               goto error;
+       }
+       if (left->data_type == IR_DATA_FLOAT
+               || right->data_type == IR_DATA_FLOAT) {
+               fprintf(stderr, "[error] bitwise binary operation '%s' cannot have floating point operand\n", op_str);
+               goto error;
+       }
+
+       op = calloc(sizeof(struct ir_op), 1);
+       if (!op)
+               return NULL;
+       op->op = IR_OP_BINARY;
+       op->u.binary.type = bin_op_type;
+       op->u.binary.left = left;
+       op->u.binary.right = right;
+
+       /* we return a signed numeric */
+       op->data_type = IR_DATA_NUMERIC;
+       op->signedness = IR_SIGNED;
+       op->side = side;
+
+       return op;
+
+error:
+       free(op);
+       return NULL;
+}
+
 static
 struct ir_op *make_op_binary_logical_and(struct ir_op *left, struct ir_op *right,
                enum ir_side side)
@@ -478,6 +535,41 @@ struct ir_op *make_op_binary_logical_or(struct ir_op *left, struct ir_op *right,
        return make_op_binary_logical(AST_OP_OR, "||", left, right, side);
 }
 
+static
+struct ir_op *make_op_binary_bitwise_rshift(struct ir_op *left, struct ir_op *right,
+               enum ir_side side)
+{
+       return make_op_binary_bitwise(AST_OP_BIT_RSHIFT, ">>", left, right, side);
+}
+
+static
+struct ir_op *make_op_binary_bitwise_lshift(struct ir_op *left, struct ir_op *right,
+               enum ir_side side)
+{
+       return make_op_binary_bitwise(AST_OP_BIT_LSHIFT, "<<", left, right, side);
+}
+
+static
+struct ir_op *make_op_binary_bitwise_and(struct ir_op *left, struct ir_op *right,
+               enum ir_side side)
+{
+       return make_op_binary_bitwise(AST_OP_BIT_AND, "&", left, right, side);
+}
+
+static
+struct ir_op *make_op_binary_bitwise_or(struct ir_op *left, struct ir_op *right,
+               enum ir_side side)
+{
+       return make_op_binary_bitwise(AST_OP_BIT_OR, "|", left, right, side);
+}
+
+static
+struct ir_op *make_op_binary_bitwise_xor(struct ir_op *left, struct ir_op *right,
+               enum ir_side side)
+{
+       return make_op_binary_bitwise(AST_OP_BIT_XOR, "^", left, right, side);
+}
+
 static
 void filter_free_ir_recursive(struct ir_op *op)
 {
@@ -495,12 +587,14 @@ void filter_free_ir_recursive(struct ir_op *op)
        case IR_OP_LOAD:
                switch (op->data_type) {
                case IR_DATA_STRING:
-                       free(op->u.load.u.string);
+                       free(op->u.load.u.string.value);
                        break;
                case IR_DATA_FIELD_REF:         /* fall-through */
                case IR_DATA_GET_CONTEXT_REF:
                        free(op->u.load.u.ref);
                        break;
+               case IR_DATA_EXPRESSION:
+                       free_load_expression(op->u.load.u.expression);
                default:
                        break;
                }
@@ -539,46 +633,8 @@ struct ir_op *make_expression(struct filter_parser_ctx *ctx,
                return make_op_load_float(node->u.expression.u.float_constant,
                                        side);
        case AST_EXP_IDENTIFIER:
-               if (node->u.expression.pre_op != AST_LINK_UNKNOWN) {
-                       fprintf(stderr, "[error] %s: dotted and dereferenced identifiers not supported\n", __func__);
-                       return NULL;
-               }
-               return make_op_load_field_ref(node->u.expression.u.identifier,
-                                       side);
        case AST_EXP_GLOBAL_IDENTIFIER:
-       {
-               struct filter_node *next;
-
-               if (node->u.expression.pre_op == AST_LINK_UNKNOWN) {
-                       fprintf(stderr, "[error] %s: global identifiers need chained identifier \n", __func__);
-                       return NULL;
-               }
-               /* We currently only support $ctx (context) identifiers */
-               if (strncmp(node->u.expression.u.identifier,
-                               "$ctx", strlen("$ctx")) != 0) {
-                       fprintf(stderr, "[error] %s: \"%s\" global identifier is unknown. Only \"$ctx\" currently implemented.\n", __func__, node->u.expression.u.identifier);
-                       return NULL;
-               }
-               next = node->u.expression.next;
-               if (!next) {
-                       fprintf(stderr, "[error] %s: Expecting a context name, e.g. \'$ctx.name\'.\n", __func__);
-                       return NULL;
-               }
-               if (next->type != NODE_EXPRESSION) {
-                       fprintf(stderr, "[error] %s: Expecting expression.\n", __func__);
-                       return NULL;
-               }
-               if (next->u.expression.type != AST_EXP_IDENTIFIER) {
-                       fprintf(stderr, "[error] %s: Expecting identifier.\n", __func__);
-                       return NULL;
-               }
-               if (next->u.expression.pre_op != AST_LINK_UNKNOWN) {
-                       fprintf(stderr, "[error] %s: dotted and dereferenced identifiers not supported after identifier\n", __func__);
-                       return NULL;
-               }
-               return make_op_load_get_context_ref(next->u.expression.u.identifier,
-                                       side);
-       }
+               return make_op_load_expression(node, side);
        case AST_EXP_NESTED:
                return generate_ir_recursive(ctx, node->u.expression.u.child,
                                        side);
@@ -599,10 +655,8 @@ struct ir_op *make_op(struct filter_parser_ctx *ctx,
                return NULL;
 
        /*
-        * Binary operators other than comparators and logical and/or
-        * are not supported. If we ever want to support those, we will
-        * need a stack for the general case rather than just 2
-        * registers (see bytecode).
+        * The following binary operators other than comparators and
+        * logical and/or are not supported yet.
         */
        case AST_OP_MUL:
                op_str = "*";
@@ -619,21 +673,21 @@ struct ir_op *make_op(struct filter_parser_ctx *ctx,
        case AST_OP_MINUS:
                op_str = "-";
                goto error_not_supported;
-       case AST_OP_RSHIFT:
-               op_str = ">>";
-               goto error_not_supported;
-       case AST_OP_LSHIFT:
-               op_str = "<<";
-               goto error_not_supported;
-       case AST_OP_BIN_AND:
-               op_str = "&";
-               goto error_not_supported;
-       case AST_OP_BIN_OR:
-               op_str = "|";
-               goto error_not_supported;
-       case AST_OP_BIN_XOR:
-               op_str = "^";
-               goto error_not_supported;
+
+       case AST_OP_BIT_RSHIFT:
+       case AST_OP_BIT_LSHIFT:
+       case AST_OP_BIT_AND:
+       case AST_OP_BIT_OR:
+       case AST_OP_BIT_XOR:
+               lchild = generate_ir_recursive(ctx, node->u.op.lchild, IR_LEFT);
+               if (!lchild)
+                       return NULL;
+               rchild = generate_ir_recursive(ctx, node->u.op.rchild, IR_RIGHT);
+               if (!rchild) {
+                       filter_free_ir_recursive(lchild);
+                       return NULL;
+               }
+               break;
 
        case AST_OP_EQ:
        case AST_OP_NE:
@@ -693,6 +747,21 @@ struct ir_op *make_op(struct filter_parser_ctx *ctx,
        case AST_OP_LE:
                op = make_op_binary_le(lchild, rchild, side);
                break;
+       case AST_OP_BIT_RSHIFT:
+               op = make_op_binary_bitwise_rshift(lchild, rchild, side);
+               break;
+       case AST_OP_BIT_LSHIFT:
+               op = make_op_binary_bitwise_lshift(lchild, rchild, side);
+               break;
+       case AST_OP_BIT_AND:
+               op = make_op_binary_bitwise_and(lchild, rchild, side);
+               break;
+       case AST_OP_BIT_OR:
+               op = make_op_binary_bitwise_or(lchild, rchild, side);
+               break;
+       case AST_OP_BIT_XOR:
+               op = make_op_binary_bitwise_xor(lchild, rchild, side);
+               break;
        default:
                break;
        }
@@ -713,8 +782,6 @@ static
 struct ir_op *make_unary_op(struct filter_parser_ctx *ctx,
                struct filter_node *node, enum ir_side side)
 {
-       const char *op_str = "?";
-
        switch (node->u.unary_op.type) {
        case AST_UNARY_UNKNOWN:
        default:
@@ -766,16 +833,23 @@ struct ir_op *make_unary_op(struct filter_parser_ctx *ctx,
                }
                return op;
        }
-       case AST_UNARY_BIN_NOT:
+       case AST_UNARY_BIT_NOT:
        {
-               op_str = "~";
-               goto error_not_supported;
+               struct ir_op *op, *child;
+
+               child = generate_ir_recursive(ctx, node->u.unary_op.child,
+                                       side);
+               if (!child)
+                       return NULL;
+               op = make_op_unary_bit_not(child, side);
+               if (!op) {
+                       filter_free_ir_recursive(child);
+                       return NULL;
+               }
+               return op;
        }
        }
 
-error_not_supported:
-       fprintf(stderr, "[error] %s: unary operation '%s' not supported\n",
-               __func__, op_str);
        return NULL;
 }
 
This page took 0.031992 seconds and 5 git commands to generate.