liblttng-ust/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 <lttng/ust-abi.h>
  26
  27 /*
  28  * offsets are absolute from start of bytecode.
  29  */
  30
  31 enum filter_register {
  32         REG_R0 = 0,
  33         REG_R1 = 1,
  34         REG_ERROR,
  35 };
  36
  37 struct field_ref {
  38         /* Initially, symbol offset. After link, field offset. */
  39         uint16_t offset;
  40 } __attribute__((packed));
  41
  42 struct literal_numeric {
  43         int64_t v;
  44 } __attribute__((packed));
  45
  46 struct literal_double {
  47         double v;
  48 } __attribute__((packed));
  49
  50 struct literal_string {
  51         char string[0];
  52 } __attribute__((packed));
  53
  54 enum filter_op {
  55         FILTER_OP_UNKNOWN = 0,
  56
  57         FILTER_OP_RETURN,
  58
  59         /* binary */
  60         FILTER_OP_MUL,
  61         FILTER_OP_DIV,
  62         FILTER_OP_MOD,
  63         FILTER_OP_PLUS,
  64         FILTER_OP_MINUS,
  65         FILTER_OP_RSHIFT,
  66         FILTER_OP_LSHIFT,
  67         FILTER_OP_BIN_AND,
  68         FILTER_OP_BIN_OR,
  69         FILTER_OP_BIN_XOR,
  70
  71         /* binary comparators */
  72         FILTER_OP_EQ,
  73         FILTER_OP_NE,
  74         FILTER_OP_GT,
  75         FILTER_OP_LT,
  76         FILTER_OP_GE,
  77         FILTER_OP_LE,
  78
  79         /* string binary comparator */
  80         FILTER_OP_EQ_STRING,
  81         FILTER_OP_NE_STRING,
  82         FILTER_OP_GT_STRING,
  83         FILTER_OP_LT_STRING,
  84         FILTER_OP_GE_STRING,
  85         FILTER_OP_LE_STRING,
  86
  87         /* s64 binary comparator */
  88         FILTER_OP_EQ_S64,
  89         FILTER_OP_NE_S64,
  90         FILTER_OP_GT_S64,
  91         FILTER_OP_LT_S64,
  92         FILTER_OP_GE_S64,
  93         FILTER_OP_LE_S64,
  94
  95         /* double binary comparator */
  96         FILTER_OP_EQ_DOUBLE,
  97         FILTER_OP_NE_DOUBLE,
  98         FILTER_OP_GT_DOUBLE,
  99         FILTER_OP_LT_DOUBLE,
 100         FILTER_OP_GE_DOUBLE,
 101         FILTER_OP_LE_DOUBLE,
 102
 103         /* unary */
 104         FILTER_OP_UNARY_PLUS,
 105         FILTER_OP_UNARY_MINUS,
 106         FILTER_OP_UNARY_NOT,
 107         FILTER_OP_UNARY_PLUS_S64,
 108         FILTER_OP_UNARY_MINUS_S64,
 109         FILTER_OP_UNARY_NOT_S64,
 110         FILTER_OP_UNARY_PLUS_DOUBLE,
 111         FILTER_OP_UNARY_MINUS_DOUBLE,
 112         FILTER_OP_UNARY_NOT_DOUBLE,
 113
 114         /* logical */
 115         FILTER_OP_AND,
 116         FILTER_OP_OR,
 117
 118         /* load */
 119         FILTER_OP_LOAD_FIELD_REF,
 120         FILTER_OP_LOAD_FIELD_REF_STRING,
 121         FILTER_OP_LOAD_FIELD_REF_SEQUENCE,
 122         FILTER_OP_LOAD_FIELD_REF_S64,
 123         FILTER_OP_LOAD_FIELD_REF_DOUBLE,
 124
 125         FILTER_OP_LOAD_STRING,
 126         FILTER_OP_LOAD_S64,
 127         FILTER_OP_LOAD_DOUBLE,
 128
 129         /* cast */
 130         FILTER_OP_CAST_TO_S64,
 131         FILTER_OP_CAST_DOUBLE_TO_S64,
 132         FILTER_OP_CAST_NOP,
 133
 134         NR_FILTER_OPS,
 135 };
 136
 137 typedef uint8_t filter_opcode_t;
 138
 139 struct load_op {
 140         filter_opcode_t op;
 141         uint8_t reg;            /* enum filter_register */
 142         char data[0];
 143         /* data to load. Size known by enum filter_opcode and null-term char. */
 144 } __attribute__((packed));
 145
 146 struct binary_op {
 147         filter_opcode_t op;
 148 } __attribute__((packed));
 149
 150 struct unary_op {
 151         filter_opcode_t op;
 152         uint8_t reg;            /* enum filter_register */
 153 } __attribute__((packed));
 154
 155 /* skip_offset is absolute from start of bytecode */
 156 struct logical_op {
 157         filter_opcode_t op;
 158         uint16_t skip_offset;   /* bytecode insn, if skip second test */
 159 } __attribute__((packed));
 160
 161 struct cast_op {
 162         filter_opcode_t op;
 163         uint8_t reg;            /* enum filter_register */
 164 } __attribute__((packed));
 165
 166 struct return_op {
 167         filter_opcode_t op;
 168 } __attribute__((packed));
 169
 170 #endif /* _FILTER_BYTECODE_H */