Commit | Line | Data |
---|---|---|
07dfc1d0 MD |
1 | #ifndef _FILTER_BYTECODE_H |
2 | #define _FILTER_BYTECODE_H | |
3 | ||
4 | /* | |
5 | * filter-bytecode.h | |
6 | * | |
7 | * LTTng filter bytecode | |
8 | * | |
bbf3aef5 | 9 | * Copyright 2012-2016 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com> |
07dfc1d0 | 10 | * |
bbf3aef5 MD |
11 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
12 | * of this software and associated documentation files (the "Software"), to deal | |
13 | * in the Software without restriction, including without limitation the rights | |
14 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
15 | * copies of the Software, and to permit persons to whom the Software is | |
16 | * furnished to do so, subject to the following conditions: | |
07dfc1d0 | 17 | * |
bbf3aef5 MD |
18 | * The above copyright notice and this permission notice shall be included in |
19 | * all copies or substantial portions of the Software. | |
07dfc1d0 | 20 | * |
bbf3aef5 MD |
21 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
22 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
23 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
24 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
25 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
26 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
27 | * SOFTWARE. | |
07dfc1d0 MD |
28 | */ |
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 | } __attribute__((packed)); | |
38 | ||
3834b99f MD |
39 | struct get_symbol { |
40 | /* Symbol offset. */ | |
41 | uint16_t offset; | |
42 | } __attribute__((packed)); | |
43 | ||
44 | struct get_index_u16 { | |
45 | uint16_t index; | |
46 | } __attribute__((packed)); | |
47 | ||
48 | struct get_index_u64 { | |
49 | uint64_t index; | |
50 | } __attribute__((packed)); | |
51 | ||
07dfc1d0 MD |
52 | struct literal_numeric { |
53 | int64_t v; | |
54 | } __attribute__((packed)); | |
55 | ||
56 | struct literal_double { | |
57 | double v; | |
58 | } __attribute__((packed)); | |
59 | ||
60 | struct literal_string { | |
61 | char string[0]; | |
62 | } __attribute__((packed)); | |
63 | ||
64 | enum filter_op { | |
02aca193 | 65 | FILTER_OP_UNKNOWN = 0, |
07dfc1d0 | 66 | |
02aca193 | 67 | FILTER_OP_RETURN = 1, |
07dfc1d0 MD |
68 | |
69 | /* binary */ | |
02aca193 PP |
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, | |
e16c054b MD |
75 | FILTER_OP_BIT_RSHIFT = 7, |
76 | FILTER_OP_BIT_LSHIFT = 8, | |
3834b99f MD |
77 | FILTER_OP_BIT_AND = 9, |
78 | FILTER_OP_BIT_OR = 10, | |
79 | FILTER_OP_BIT_XOR = 11, | |
07dfc1d0 MD |
80 | |
81 | /* binary comparators */ | |
02aca193 PP |
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, | |
07dfc1d0 MD |
96 | |
97 | /* s64 binary comparator */ | |
02aca193 PP |
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, | |
07dfc1d0 MD |
104 | |
105 | /* double binary comparator */ | |
02aca193 PP |
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, | |
07dfc1d0 MD |
112 | |
113 | /* Mixed S64-double binary comparators */ | |
02aca193 PP |
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, | |
07dfc1d0 MD |
127 | |
128 | /* unary */ | |
02aca193 PP |
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, | |
07dfc1d0 MD |
138 | |
139 | /* logical */ | |
02aca193 PP |
140 | FILTER_OP_AND = 57, |
141 | FILTER_OP_OR = 58, | |
07dfc1d0 MD |
142 | |
143 | /* load field ref */ | |
02aca193 PP |
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, | |
07dfc1d0 MD |
149 | |
150 | /* load immediate from operand */ | |
02aca193 PP |
151 | FILTER_OP_LOAD_STRING = 64, |
152 | FILTER_OP_LOAD_S64 = 65, | |
153 | FILTER_OP_LOAD_DOUBLE = 66, | |
07dfc1d0 MD |
154 | |
155 | /* cast */ | |
02aca193 PP |
156 | FILTER_OP_CAST_TO_S64 = 67, |
157 | FILTER_OP_CAST_DOUBLE_TO_S64 = 68, | |
158 | FILTER_OP_CAST_NOP = 69, | |
07dfc1d0 MD |
159 | |
160 | /* get context ref */ | |
02aca193 PP |
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, | |
07dfc1d0 | 165 | |
f127e61e | 166 | /* load userspace field ref */ |
02aca193 PP |
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, | |
f127e61e | 179 | |
3834b99f MD |
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 | ||
e16c054b MD |
205 | FILTER_OP_UNARY_BIT_NOT = 98, |
206 | ||
57ba4b41 MD |
207 | FILTER_OP_RETURN_S64 = 99, |
208 | ||
07dfc1d0 MD |
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 | } __attribute__((packed)); | |
219 | ||
220 | struct binary_op { | |
221 | filter_opcode_t op; | |
222 | } __attribute__((packed)); | |
223 | ||
224 | struct unary_op { | |
225 | filter_opcode_t op; | |
226 | } __attribute__((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 | } __attribute__((packed)); | |
233 | ||
234 | struct cast_op { | |
235 | filter_opcode_t op; | |
236 | } __attribute__((packed)); | |
237 | ||
238 | struct return_op { | |
239 | filter_opcode_t op; | |
240 | } __attribute__((packed)); | |
241 | ||
242 | #endif /* _FILTER_BYTECODE_H */ |