src/lib/lttng-ctl/filter/filter-bytecode.h

   1 #ifndef _FILTER_BYTECODE_H
   2 #define _FILTER_BYTECODE_H
   3
   4 /*
   5  * filter-bytecode.h
   6  *
   7  * LTTng filter bytecode
   8  *
   9  * Copyright 2012 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
  10  *
  11  * This library is free software; you can redistribute it and/or modify it
  12  * under the terms of the GNU Lesser General Public License, version 2.1 only,
  13  * as published by the Free Software Foundation.
  14  *
  15  * This library is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public License
  21  * along with this library; if not, write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  23  */
  24
  25 #include <common/sessiond-comm/sessiond-comm.h>
  26 #include <common/macros.h>
  27
  28 #include "filter-ast.h"
  29
  30 /*
  31  * offsets are absolute from start of bytecode.
  32  */
  33
  34 struct field_ref {
  35         /* Initially, symbol offset. After link, field offset. */
  36         uint16_t offset;
  37 } LTTNG_PACKED;
  38
  39 struct get_symbol {
  40         /* Symbol offset. */
  41         uint16_t offset;
  42 } LTTNG_PACKED;
  43
  44 struct get_index_u16 {
  45         uint16_t index;
  46 } LTTNG_PACKED;
  47
  48 struct get_index_u64 {
  49         uint64_t index;
  50 } LTTNG_PACKED;
  51
  52 struct literal_numeric {
  53         int64_t v;
  54 } LTTNG_PACKED;
  55
  56 struct literal_double {
  57         double v;
  58 } LTTNG_PACKED;
  59
  60 struct literal_string {
  61         char string[0];
  62 } LTTNG_PACKED;
  63
  64 enum filter_op {
  65         FILTER_OP_UNKNOWN                       = 0,
  66
  67         FILTER_OP_RETURN                        = 1,
  68
  69         /* binary */
  70         FILTER_OP_MUL                           = 2,
  71         FILTER_OP_DIV                           = 3,
  72         FILTER_OP_MOD                           = 4,
  73         FILTER_OP_PLUS                          = 5,
  74         FILTER_OP_MINUS                         = 6,
  75         FILTER_OP_BIT_RSHIFT                    = 7,
  76         FILTER_OP_BIT_LSHIFT                    = 8,
  77         FILTER_OP_BIT_AND                       = 9,
  78         FILTER_OP_BIT_OR                        = 10,
  79         FILTER_OP_BIT_XOR                       = 11,
  80
  81         /* binary comparators */
  82         FILTER_OP_EQ                            = 12,
  83         FILTER_OP_NE                            = 13,
  84         FILTER_OP_GT                            = 14,
  85         FILTER_OP_LT                            = 15,
  86         FILTER_OP_GE                            = 16,
  87         FILTER_OP_LE                            = 17,
  88
  89         /* string binary comparator: apply to  */
  90         FILTER_OP_EQ_STRING                     = 18,
  91         FILTER_OP_NE_STRING                     = 19,
  92         FILTER_OP_GT_STRING                     = 20,
  93         FILTER_OP_LT_STRING                     = 21,
  94         FILTER_OP_GE_STRING                     = 22,
  95         FILTER_OP_LE_STRING                     = 23,
  96
  97         /* s64 binary comparator */
  98         FILTER_OP_EQ_S64                        = 24,
  99         FILTER_OP_NE_S64                        = 25,
 100         FILTER_OP_GT_S64                        = 26,
 101         FILTER_OP_LT_S64                        = 27,
 102         FILTER_OP_GE_S64                        = 28,
 103         FILTER_OP_LE_S64                        = 29,
 104
 105         /* double binary comparator */
 106         FILTER_OP_EQ_DOUBLE                     = 30,
 107         FILTER_OP_NE_DOUBLE                     = 31,
 108         FILTER_OP_GT_DOUBLE                     = 32,
 109         FILTER_OP_LT_DOUBLE                     = 33,
 110         FILTER_OP_GE_DOUBLE                     = 34,
 111         FILTER_OP_LE_DOUBLE                     = 35,
 112
 113         /* Mixed S64-double binary comparators */
 114         FILTER_OP_EQ_DOUBLE_S64                 = 36,
 115         FILTER_OP_NE_DOUBLE_S64                 = 37,
 116         FILTER_OP_GT_DOUBLE_S64                 = 38,
 117         FILTER_OP_LT_DOUBLE_S64                 = 39,
 118         FILTER_OP_GE_DOUBLE_S64                 = 40,
 119         FILTER_OP_LE_DOUBLE_S64                 = 41,
 120
 121         FILTER_OP_EQ_S64_DOUBLE                 = 42,
 122         FILTER_OP_NE_S64_DOUBLE                 = 43,
 123         FILTER_OP_GT_S64_DOUBLE                 = 44,
 124         FILTER_OP_LT_S64_DOUBLE                 = 45,
 125         FILTER_OP_GE_S64_DOUBLE                 = 46,
 126         FILTER_OP_LE_S64_DOUBLE                 = 47,
 127
 128         /* unary */
 129         FILTER_OP_UNARY_PLUS                    = 48,
 130         FILTER_OP_UNARY_MINUS                   = 49,
 131         FILTER_OP_UNARY_NOT                     = 50,
 132         FILTER_OP_UNARY_PLUS_S64                = 51,
 133         FILTER_OP_UNARY_MINUS_S64               = 52,
 134         FILTER_OP_UNARY_NOT_S64                 = 53,
 135         FILTER_OP_UNARY_PLUS_DOUBLE             = 54,
 136         FILTER_OP_UNARY_MINUS_DOUBLE            = 55,
 137         FILTER_OP_UNARY_NOT_DOUBLE              = 56,
 138
 139         /* logical */
 140         FILTER_OP_AND                           = 57,
 141         FILTER_OP_OR                            = 58,
 142
 143         /* load field ref */
 144         FILTER_OP_LOAD_FIELD_REF                = 59,
 145         FILTER_OP_LOAD_FIELD_REF_STRING         = 60,
 146         FILTER_OP_LOAD_FIELD_REF_SEQUENCE       = 61,
 147         FILTER_OP_LOAD_FIELD_REF_S64            = 62,
 148         FILTER_OP_LOAD_FIELD_REF_DOUBLE         = 63,
 149
 150         /* load immediate from operand */
 151         FILTER_OP_LOAD_STRING                   = 64,
 152         FILTER_OP_LOAD_S64                      = 65,
 153         FILTER_OP_LOAD_DOUBLE                   = 66,
 154
 155         /* cast */
 156         FILTER_OP_CAST_TO_S64                   = 67,
 157         FILTER_OP_CAST_DOUBLE_TO_S64            = 68,
 158         FILTER_OP_CAST_NOP                      = 69,
 159
 160         /* get context ref */
 161         FILTER_OP_GET_CONTEXT_REF               = 70,
 162         FILTER_OP_GET_CONTEXT_REF_STRING        = 71,
 163         FILTER_OP_GET_CONTEXT_REF_S64           = 72,
 164         FILTER_OP_GET_CONTEXT_REF_DOUBLE        = 73,
 165
 166         /* load userspace field ref */
 167         FILTER_OP_LOAD_FIELD_REF_USER_STRING    = 74,
 168         FILTER_OP_LOAD_FIELD_REF_USER_SEQUENCE  = 75,
 169
 170         /*
 171          * load immediate star globbing pattern (literal string)
 172          * from immediate
 173          */
 174         FILTER_OP_LOAD_STAR_GLOB_STRING         = 76,
 175
 176         /* globbing pattern binary operator: apply to */
 177         FILTER_OP_EQ_STAR_GLOB_STRING           = 77,
 178         FILTER_OP_NE_STAR_GLOB_STRING           = 78,
 179
 180         /*
 181          * Instructions for recursive traversal through composed types.
 182          */
 183         FILTER_OP_GET_CONTEXT_ROOT              = 79,
 184         FILTER_OP_GET_APP_CONTEXT_ROOT          = 80,
 185         FILTER_OP_GET_PAYLOAD_ROOT              = 81,
 186
 187         FILTER_OP_GET_SYMBOL                    = 82,
 188         FILTER_OP_GET_SYMBOL_FIELD              = 83,
 189         FILTER_OP_GET_INDEX_U16                 = 84,
 190         FILTER_OP_GET_INDEX_U64                 = 85,
 191
 192         FILTER_OP_LOAD_FIELD                    = 86,
 193         FILTER_OP_LOAD_FIELD_S8                 = 87,
 194         FILTER_OP_LOAD_FIELD_S16                = 88,
 195         FILTER_OP_LOAD_FIELD_S32                = 89,
 196         FILTER_OP_LOAD_FIELD_S64                = 90,
 197         FILTER_OP_LOAD_FIELD_U8                 = 91,
 198         FILTER_OP_LOAD_FIELD_U16                = 92,
 199         FILTER_OP_LOAD_FIELD_U32                = 93,
 200         FILTER_OP_LOAD_FIELD_U64                = 94,
 201         FILTER_OP_LOAD_FIELD_STRING             = 95,
 202         FILTER_OP_LOAD_FIELD_SEQUENCE           = 96,
 203         FILTER_OP_LOAD_FIELD_DOUBLE             = 97,
 204
 205         FILTER_OP_UNARY_BIT_NOT                 = 98,
 206
 207         FILTER_OP_RETURN_S64                    = 99,
 208
 209         NR_FILTER_OPS,
 210 };
 211
 212 typedef uint8_t filter_opcode_t;
 213
 214 struct load_op {
 215         filter_opcode_t op;
 216         char data[0];
 217         /* data to load. Size known by enum filter_opcode and null-term char. */
 218 } LTTNG_PACKED;
 219
 220 struct binary_op {
 221         filter_opcode_t op;
 222 } LTTNG_PACKED;
 223
 224 struct unary_op {
 225         filter_opcode_t op;
 226 } LTTNG_PACKED;
 227
 228 /* skip_offset is absolute from start of bytecode */
 229 struct logical_op {
 230         filter_opcode_t op;
 231         uint16_t skip_offset;   /* bytecode insn, if skip second test */
 232 } LTTNG_PACKED;
 233
 234 struct cast_op {
 235         filter_opcode_t op;
 236 } LTTNG_PACKED;
 237
 238 struct return_op {
 239         filter_opcode_t op;
 240 } LTTNG_PACKED;
 241
 242 struct lttng_filter_bytecode_alloc {
 243         uint32_t alloc_len;
 244         struct lttng_filter_bytecode b;
 245 };
 246
 247 static inline
 248 unsigned int bytecode_get_len(struct lttng_filter_bytecode *bytecode)
 249 {
 250         return bytecode->len;
 251 }
 252
 253 #endif /* _FILTER_BYTECODE_H */