Commit | Line | Data |
---|---|---|
9f36eaed MJ |
1 | /* SPDX-License-Identifier: MIT |
2 | * | |
07dfc1d0 MD |
3 | * filter-bytecode.h |
4 | * | |
5 | * LTTng filter bytecode | |
6 | * | |
bbf3aef5 | 7 | * Copyright 2012-2016 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com> |
07dfc1d0 MD |
8 | */ |
9 | ||
9f36eaed MJ |
10 | #ifndef _FILTER_BYTECODE_H |
11 | #define _FILTER_BYTECODE_H | |
12 | ||
07dfc1d0 MD |
13 | /* |
14 | * offsets are absolute from start of bytecode. | |
15 | */ | |
16 | ||
17 | struct field_ref { | |
18 | /* Initially, symbol offset. After link, field offset. */ | |
19 | uint16_t offset; | |
20 | } __attribute__((packed)); | |
21 | ||
3834b99f MD |
22 | struct get_symbol { |
23 | /* Symbol offset. */ | |
24 | uint16_t offset; | |
25 | } __attribute__((packed)); | |
26 | ||
27 | struct get_index_u16 { | |
28 | uint16_t index; | |
29 | } __attribute__((packed)); | |
30 | ||
31 | struct get_index_u64 { | |
32 | uint64_t index; | |
33 | } __attribute__((packed)); | |
34 | ||
07dfc1d0 MD |
35 | struct literal_numeric { |
36 | int64_t v; | |
37 | } __attribute__((packed)); | |
38 | ||
39 | struct literal_double { | |
40 | double v; | |
41 | } __attribute__((packed)); | |
42 | ||
07dfc1d0 | 43 | enum filter_op { |
02aca193 | 44 | FILTER_OP_UNKNOWN = 0, |
07dfc1d0 | 45 | |
02aca193 | 46 | FILTER_OP_RETURN = 1, |
07dfc1d0 MD |
47 | |
48 | /* binary */ | |
02aca193 PP |
49 | FILTER_OP_MUL = 2, |
50 | FILTER_OP_DIV = 3, | |
51 | FILTER_OP_MOD = 4, | |
52 | FILTER_OP_PLUS = 5, | |
53 | FILTER_OP_MINUS = 6, | |
e16c054b MD |
54 | FILTER_OP_BIT_RSHIFT = 7, |
55 | FILTER_OP_BIT_LSHIFT = 8, | |
3834b99f MD |
56 | FILTER_OP_BIT_AND = 9, |
57 | FILTER_OP_BIT_OR = 10, | |
58 | FILTER_OP_BIT_XOR = 11, | |
07dfc1d0 MD |
59 | |
60 | /* binary comparators */ | |
02aca193 PP |
61 | FILTER_OP_EQ = 12, |
62 | FILTER_OP_NE = 13, | |
63 | FILTER_OP_GT = 14, | |
64 | FILTER_OP_LT = 15, | |
65 | FILTER_OP_GE = 16, | |
66 | FILTER_OP_LE = 17, | |
67 | ||
68 | /* string binary comparator: apply to */ | |
69 | FILTER_OP_EQ_STRING = 18, | |
70 | FILTER_OP_NE_STRING = 19, | |
71 | FILTER_OP_GT_STRING = 20, | |
72 | FILTER_OP_LT_STRING = 21, | |
73 | FILTER_OP_GE_STRING = 22, | |
74 | FILTER_OP_LE_STRING = 23, | |
07dfc1d0 MD |
75 | |
76 | /* s64 binary comparator */ | |
02aca193 PP |
77 | FILTER_OP_EQ_S64 = 24, |
78 | FILTER_OP_NE_S64 = 25, | |
79 | FILTER_OP_GT_S64 = 26, | |
80 | FILTER_OP_LT_S64 = 27, | |
81 | FILTER_OP_GE_S64 = 28, | |
82 | FILTER_OP_LE_S64 = 29, | |
07dfc1d0 MD |
83 | |
84 | /* double binary comparator */ | |
02aca193 PP |
85 | FILTER_OP_EQ_DOUBLE = 30, |
86 | FILTER_OP_NE_DOUBLE = 31, | |
87 | FILTER_OP_GT_DOUBLE = 32, | |
88 | FILTER_OP_LT_DOUBLE = 33, | |
89 | FILTER_OP_GE_DOUBLE = 34, | |
90 | FILTER_OP_LE_DOUBLE = 35, | |
07dfc1d0 MD |
91 | |
92 | /* Mixed S64-double binary comparators */ | |
02aca193 PP |
93 | FILTER_OP_EQ_DOUBLE_S64 = 36, |
94 | FILTER_OP_NE_DOUBLE_S64 = 37, | |
95 | FILTER_OP_GT_DOUBLE_S64 = 38, | |
96 | FILTER_OP_LT_DOUBLE_S64 = 39, | |
97 | FILTER_OP_GE_DOUBLE_S64 = 40, | |
98 | FILTER_OP_LE_DOUBLE_S64 = 41, | |
99 | ||
100 | FILTER_OP_EQ_S64_DOUBLE = 42, | |
101 | FILTER_OP_NE_S64_DOUBLE = 43, | |
102 | FILTER_OP_GT_S64_DOUBLE = 44, | |
103 | FILTER_OP_LT_S64_DOUBLE = 45, | |
104 | FILTER_OP_GE_S64_DOUBLE = 46, | |
105 | FILTER_OP_LE_S64_DOUBLE = 47, | |
07dfc1d0 MD |
106 | |
107 | /* unary */ | |
02aca193 PP |
108 | FILTER_OP_UNARY_PLUS = 48, |
109 | FILTER_OP_UNARY_MINUS = 49, | |
110 | FILTER_OP_UNARY_NOT = 50, | |
111 | FILTER_OP_UNARY_PLUS_S64 = 51, | |
112 | FILTER_OP_UNARY_MINUS_S64 = 52, | |
113 | FILTER_OP_UNARY_NOT_S64 = 53, | |
114 | FILTER_OP_UNARY_PLUS_DOUBLE = 54, | |
115 | FILTER_OP_UNARY_MINUS_DOUBLE = 55, | |
116 | FILTER_OP_UNARY_NOT_DOUBLE = 56, | |
07dfc1d0 MD |
117 | |
118 | /* logical */ | |
02aca193 PP |
119 | FILTER_OP_AND = 57, |
120 | FILTER_OP_OR = 58, | |
07dfc1d0 MD |
121 | |
122 | /* load field ref */ | |
02aca193 PP |
123 | FILTER_OP_LOAD_FIELD_REF = 59, |
124 | FILTER_OP_LOAD_FIELD_REF_STRING = 60, | |
125 | FILTER_OP_LOAD_FIELD_REF_SEQUENCE = 61, | |
126 | FILTER_OP_LOAD_FIELD_REF_S64 = 62, | |
127 | FILTER_OP_LOAD_FIELD_REF_DOUBLE = 63, | |
07dfc1d0 MD |
128 | |
129 | /* load immediate from operand */ | |
02aca193 PP |
130 | FILTER_OP_LOAD_STRING = 64, |
131 | FILTER_OP_LOAD_S64 = 65, | |
132 | FILTER_OP_LOAD_DOUBLE = 66, | |
07dfc1d0 MD |
133 | |
134 | /* cast */ | |
02aca193 PP |
135 | FILTER_OP_CAST_TO_S64 = 67, |
136 | FILTER_OP_CAST_DOUBLE_TO_S64 = 68, | |
137 | FILTER_OP_CAST_NOP = 69, | |
07dfc1d0 MD |
138 | |
139 | /* get context ref */ | |
02aca193 PP |
140 | FILTER_OP_GET_CONTEXT_REF = 70, |
141 | FILTER_OP_GET_CONTEXT_REF_STRING = 71, | |
142 | FILTER_OP_GET_CONTEXT_REF_S64 = 72, | |
143 | FILTER_OP_GET_CONTEXT_REF_DOUBLE = 73, | |
07dfc1d0 | 144 | |
f127e61e | 145 | /* load userspace field ref */ |
02aca193 PP |
146 | FILTER_OP_LOAD_FIELD_REF_USER_STRING = 74, |
147 | FILTER_OP_LOAD_FIELD_REF_USER_SEQUENCE = 75, | |
148 | ||
149 | /* | |
150 | * load immediate star globbing pattern (literal string) | |
151 | * from immediate | |
152 | */ | |
153 | FILTER_OP_LOAD_STAR_GLOB_STRING = 76, | |
154 | ||
155 | /* globbing pattern binary operator: apply to */ | |
156 | FILTER_OP_EQ_STAR_GLOB_STRING = 77, | |
157 | FILTER_OP_NE_STAR_GLOB_STRING = 78, | |
f127e61e | 158 | |
3834b99f MD |
159 | /* |
160 | * Instructions for recursive traversal through composed types. | |
161 | */ | |
162 | FILTER_OP_GET_CONTEXT_ROOT = 79, | |
163 | FILTER_OP_GET_APP_CONTEXT_ROOT = 80, | |
164 | FILTER_OP_GET_PAYLOAD_ROOT = 81, | |
165 | ||
166 | FILTER_OP_GET_SYMBOL = 82, | |
167 | FILTER_OP_GET_SYMBOL_FIELD = 83, | |
168 | FILTER_OP_GET_INDEX_U16 = 84, | |
169 | FILTER_OP_GET_INDEX_U64 = 85, | |
170 | ||
171 | FILTER_OP_LOAD_FIELD = 86, | |
172 | FILTER_OP_LOAD_FIELD_S8 = 87, | |
173 | FILTER_OP_LOAD_FIELD_S16 = 88, | |
174 | FILTER_OP_LOAD_FIELD_S32 = 89, | |
175 | FILTER_OP_LOAD_FIELD_S64 = 90, | |
176 | FILTER_OP_LOAD_FIELD_U8 = 91, | |
177 | FILTER_OP_LOAD_FIELD_U16 = 92, | |
178 | FILTER_OP_LOAD_FIELD_U32 = 93, | |
179 | FILTER_OP_LOAD_FIELD_U64 = 94, | |
180 | FILTER_OP_LOAD_FIELD_STRING = 95, | |
181 | FILTER_OP_LOAD_FIELD_SEQUENCE = 96, | |
182 | FILTER_OP_LOAD_FIELD_DOUBLE = 97, | |
183 | ||
e16c054b MD |
184 | FILTER_OP_UNARY_BIT_NOT = 98, |
185 | ||
57ba4b41 MD |
186 | FILTER_OP_RETURN_S64 = 99, |
187 | ||
07dfc1d0 MD |
188 | NR_FILTER_OPS, |
189 | }; | |
190 | ||
191 | typedef uint8_t filter_opcode_t; | |
192 | ||
193 | struct load_op { | |
194 | filter_opcode_t op; | |
ad48a5c0 | 195 | char data[]; |
07dfc1d0 MD |
196 | /* data to load. Size known by enum filter_opcode and null-term char. */ |
197 | } __attribute__((packed)); | |
198 | ||
199 | struct binary_op { | |
200 | filter_opcode_t op; | |
201 | } __attribute__((packed)); | |
202 | ||
203 | struct unary_op { | |
204 | filter_opcode_t op; | |
205 | } __attribute__((packed)); | |
206 | ||
207 | /* skip_offset is absolute from start of bytecode */ | |
208 | struct logical_op { | |
209 | filter_opcode_t op; | |
210 | uint16_t skip_offset; /* bytecode insn, if skip second test */ | |
211 | } __attribute__((packed)); | |
212 | ||
213 | struct cast_op { | |
214 | filter_opcode_t op; | |
215 | } __attribute__((packed)); | |
216 | ||
217 | struct return_op { | |
218 | filter_opcode_t op; | |
219 | } __attribute__((packed)); | |
220 | ||
221 | #endif /* _FILTER_BYTECODE_H */ |