9c312311 |
1 | /* This file is part of the Linux Trace Toolkit viewer |
852f16bb |
2 | * Copyright (C) 2003-2005 Michel Dagenais and Simon Bouvier-Zappa |
9c312311 |
3 | * |
4 | * This program is free software; you can redistribute it and/or modify |
5 | * it under the terms of the GNU General Public License Version 2 as |
6 | * published by the Free Software Foundation; |
7 | * |
8 | * This program is distributed in the hope that it will be useful, |
9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
11 | * GNU General Public License for more details. |
12 | * |
13 | * You should have received a copy of the GNU General Public License |
14 | * along with this program; if not, write to the Free Software |
15 | * Foundation, Inc., 59 Temple Place - Suite 330, Boston, |
16 | * MA 02111-1307, USA. |
17 | */ |
18 | |
48f6f3c2 |
19 | #ifndef FILTER_H |
20 | #define FILTER_H |
21 | |
7e7af7f2 |
22 | /*! \file lttv/lttv/filter.h |
23 | * \brief Defines the core filter of application |
24 | * |
25 | * A filter expression consists in nested AND, OR and NOT expressions |
26 | * involving boolean relation (>, >=, =, !=, <, <=) between event fields and |
27 | * specific values. It is compiled into an efficient data structure which |
28 | * is used in functions to check if a given event or tracefile satisfies the |
29 | * filter. |
30 | * |
31 | * The grammar for filters is: |
32 | * |
33 | * filter = expression |
34 | * |
35 | * expression = "(" expression ")" | "!" expression | |
36 | * expression "&&" expression | expression "||" expression | |
37 | * simpleExpression |
38 | * |
39 | * simpleExpression = fieldPath op value |
40 | * |
41 | * fieldPath = fieldComponent [ "." fieldPath ] |
42 | * |
43 | * fieldComponent = name [ "[" integer "]" ] |
44 | * |
45 | * value = integer | double | string |
46 | */ |
47 | |
48 | |
31452f49 |
49 | #include <lttv/traceset.h> |
a4c292d4 |
50 | #include <lttv/tracecontext.h> |
51 | #include <lttv/state.h> |
91ad3f0a |
52 | #include <lttv/module.h> |
a4c292d4 |
53 | #include <ltt/ltt.h> |
7145a073 |
54 | #include <ltt/time.h> |
a4c292d4 |
55 | #include <ltt/event.h> |
56 | |
e00d6a24 |
57 | /* structures prototypes */ |
58 | typedef enum _LttvStructType LttvStructType; |
59 | typedef enum _LttvFieldType LttvFieldType; |
60 | typedef enum _LttvExpressionOp LttvExpressionOp; |
61 | typedef enum _LttvTreeElement LttvTreeElement; |
62 | typedef enum _LttvLogicalOp LttvLogicalOp; |
63 | |
64 | typedef union _LttvFieldValue LttvFieldValue; |
65 | |
66 | typedef struct _LttvSimpleExpression LttvSimpleExpression; |
67 | typedef struct _LttvFilterTree LttvFilterTree; |
e00d6a24 |
68 | |
33e44b82 |
69 | #ifndef LTTVFILTER_TYPE_DEFINED |
70 | typedef struct _LttvFilter LttvFilter; |
71 | #define LTTVFILTER_TYPE_DEFINED |
72 | #endif |
e00d6a24 |
73 | |
80f9611a |
74 | /** |
7e7af7f2 |
75 | * @enum _LttvStructType |
80f9611a |
76 | * @brief The lttv structures |
77 | * |
78 | * the LttvStructType enumerates |
79 | * the possible structures for the |
80 | * lttv core filter |
81 | */ |
82 | enum _LttvStructType { |
7e7af7f2 |
83 | LTTV_FILTER_TRACE, /**< trace (LttTrace) */ |
84 | LTTV_FILTER_TRACESET, /**< traceset */ |
85 | LTTV_FILTER_TRACEFILE, /**< tracefile (LttTracefile) */ |
86 | LTTV_FILTER_EVENT, /**< event (LttEvent) */ |
87 | LTTV_FILTER_STATE /**< state (LttvProcessState) */ |
e00d6a24 |
88 | }; |
80f9611a |
89 | |
150f0d33 |
90 | /** |
7e7af7f2 |
91 | * @enum _LttvFieldType |
80f9611a |
92 | * @brief Possible fields for the structures |
150f0d33 |
93 | * |
94 | * the LttvFieldType enum consists on |
95 | * all the hardcoded structures and |
96 | * their appropriate fields on which |
97 | * filters can be applied. |
98 | */ |
99 | enum _LttvFieldType { |
7e7af7f2 |
100 | LTTV_FILTER_TRACE_NAME, /**< trace.name (char*) */ |
101 | LTTV_FILTER_TRACEFILE_NAME, /**< tracefile.name (char*) */ |
102 | LTTV_FILTER_STATE_PID, /**< state.pid (guint) */ |
103 | LTTV_FILTER_STATE_PPID, /**< state.ppid (guint) */ |
104 | LTTV_FILTER_STATE_CT, /**< state.creation_time (double) */ |
105 | LTTV_FILTER_STATE_IT, /**< state.insertion_time (double) */ |
106 | LTTV_FILTER_STATE_P_NAME, /**< state.process_name (char*) */ |
107 | LTTV_FILTER_STATE_EX_MODE, /**< state.execution_mode (LttvExecutionMode) */ |
108 | LTTV_FILTER_STATE_EX_SUBMODE, /**< state.execution_submode (LttvExecutionSubmode) */ |
109 | LTTV_FILTER_STATE_P_STATUS, /**< state.process_status (LttvProcessStatus) */ |
110 | LTTV_FILTER_STATE_CPU, /**< state.cpu (?last_cpu?) */ |
111 | LTTV_FILTER_EVENT_NAME, /**< event.name (char*) */ |
ffd088ef |
112 | LTTV_FILTER_EVENT_FACILITY, /**< event.facility (char*) */ |
7e7af7f2 |
113 | LTTV_FILTER_EVENT_CATEGORY, /**< FIXME: not implemented */ |
114 | LTTV_FILTER_EVENT_TIME, /**< event.time (double) */ |
115 | LTTV_FILTER_EVENT_TSC, /**< event.tsc (double) */ |
116 | LTTV_FILTER_EVENT_FIELD, /**< dynamic field, specified in core.xml */ |
117 | LTTV_FILTER_UNDEFINED /**< undefined field */ |
e00d6a24 |
118 | }; |
91ad3f0a |
119 | |
84a333d6 |
120 | /** |
7e7af7f2 |
121 | * @enum _LttvExpressionOp |
56e29124 |
122 | * @brief Contains possible operators |
123 | * |
124 | * This enumeration defines the |
125 | * possible operator used to compare |
126 | * right and left member in simple |
127 | * expression |
84a333d6 |
128 | */ |
e00d6a24 |
129 | enum _LttvExpressionOp |
84a333d6 |
130 | { |
7e7af7f2 |
131 | LTTV_FIELD_EQ, /**< equal */ |
132 | LTTV_FIELD_NE, /**< not equal */ |
133 | LTTV_FIELD_LT, /**< lower than */ |
134 | LTTV_FIELD_LE, /**< lower or equal */ |
135 | LTTV_FIELD_GT, /**< greater than */ |
136 | LTTV_FIELD_GE /**< greater or equal */ |
e00d6a24 |
137 | }; |
84a333d6 |
138 | |
56e29124 |
139 | /** |
7e7af7f2 |
140 | * @union _LttvFieldValue |
56e29124 |
141 | * @brief Contains possible field values |
7e7af7f2 |
142 | * |
56e29124 |
143 | * This particular union defines the |
144 | * possible set of values taken by the |
145 | * right member of a simple expression. |
146 | * It is used for comparison whithin the |
147 | * 'operators' functions |
148 | */ |
e00d6a24 |
149 | union _LttvFieldValue { |
7e7af7f2 |
150 | guint64 v_uint64; /**< unsigned int of 64 bytes */ |
151 | guint32 v_uint32; /**< unsigned int of 32 bytes */ |
152 | guint16 v_uint16; /**< unsigned int of 16 bytes */ |
2ec11087 |
153 | guint16 v_uint; /**< unsigned int */ |
7e7af7f2 |
154 | double v_double; /**< double */ |
155 | char* v_string; /**< string */ |
156 | LttTime v_ltttime; /**< LttTime */ |
e00d6a24 |
157 | }; |
56e29124 |
158 | |
150f0d33 |
159 | /** |
7e7af7f2 |
160 | * @enum _LttvTreeElement |
150f0d33 |
161 | * @brief element types for the tree nodes |
162 | * |
163 | * LttvTreeElement defines the possible |
164 | * types of nodes which build the LttvFilterTree. |
2ea36caf |
165 | */ |
e00d6a24 |
166 | enum _LttvTreeElement { |
7e7af7f2 |
167 | LTTV_TREE_IDLE, /**< this node does nothing */ |
168 | LTTV_TREE_NODE, /**< this node contains a logical operator */ |
169 | LTTV_TREE_LEAF /**< this node is a leaf and contains a simple expression */ |
e00d6a24 |
170 | }; |
f4e9dd16 |
171 | |
56e29124 |
172 | |
150f0d33 |
173 | /** |
7e7af7f2 |
174 | * @struct _LttvSimpleExpression |
150f0d33 |
175 | * @brief simple expression structure |
176 | * |
177 | * An LttvSimpleExpression is the base |
178 | * of all filtering operations. It also |
179 | * populates the leaves of the |
180 | * LttvFilterTree. Each expression |
181 | * consists basically in a structure |
182 | * field, an operator and a specific |
183 | * value. |
184 | */ |
e00d6a24 |
185 | struct _LttvSimpleExpression |
84a333d6 |
186 | { |
7e7af7f2 |
187 | gint field; /**< left member of simple expression */ |
188 | gint offset; /**< offset used for dynamic fields */ |
189 | gboolean (*op)(gpointer,LttvFieldValue); /**< operator of simple expression */ |
190 | LttvFieldValue value; /**< right member of simple expression */ |
e00d6a24 |
191 | }; |
84a333d6 |
192 | |
150f0d33 |
193 | /** |
7e7af7f2 |
194 | * @enum _LttvLogicalOp |
150f0d33 |
195 | * @brief logical operators |
196 | * |
197 | * Contains the possible values taken |
198 | * by logical operator used to link |
199 | * simple expression. Values are |
200 | * AND, OR, XOR or NOT |
201 | */ |
e00d6a24 |
202 | enum _LttvLogicalOp { |
7e7af7f2 |
203 | LTTV_LOGICAL_OR = 1, /**< OR (1) */ |
204 | LTTV_LOGICAL_AND = 1<<1, /**< AND (2) */ |
205 | LTTV_LOGICAL_NOT = 1<<2, /**< NOT (4) */ |
206 | LTTV_LOGICAL_XOR = 1<<3 /**< XOR (8) */ |
e00d6a24 |
207 | }; |
1a7fa682 |
208 | |
150f0d33 |
209 | /** |
7e7af7f2 |
210 | * @struct _LttvFilterTree |
211 | * @brief The filtering tree |
212 | * |
150f0d33 |
213 | * The filtering tree is used to represent the |
214 | * expression string in its entire hierarchy |
215 | * composed of simple expressions and logical |
216 | * operators |
2ea36caf |
217 | */ |
e00d6a24 |
218 | struct _LttvFilterTree { |
7e7af7f2 |
219 | int node; /**< value of LttvLogicalOp */ |
220 | LttvTreeElement left; /**< nature of left branch (node/leaf) */ |
221 | LttvTreeElement right; /**< nature of right branch (node/leaf) */ |
f4e9dd16 |
222 | union { |
7e7af7f2 |
223 | LttvFilterTree* t; |
224 | LttvSimpleExpression* leaf; |
225 | } l_child; /**< left branch of tree */ |
f4e9dd16 |
226 | union { |
7e7af7f2 |
227 | LttvFilterTree* t; |
228 | LttvSimpleExpression* leaf; |
229 | } r_child; /**< right branch of tree */ |
e00d6a24 |
230 | }; |
84a333d6 |
231 | |
31452f49 |
232 | /** |
7e7af7f2 |
233 | * @struct _LttvFilter |
234 | * @brief The filter |
235 | * |
150f0d33 |
236 | * Contains a binary tree of filtering options along |
237 | * with the expression itself. |
31452f49 |
238 | */ |
e00d6a24 |
239 | struct _LttvFilter { |
7e7af7f2 |
240 | char *expression; /**< filtering expression string */ |
241 | LttvFilterTree *head; /**< tree associated to expression */ |
e00d6a24 |
242 | }; |
84a333d6 |
243 | |
56e29124 |
244 | /* |
245 | * Simple Expression |
246 | */ |
247 | LttvSimpleExpression* lttv_simple_expression_new(); |
248 | |
7e7af7f2 |
249 | gboolean lttv_simple_expression_assign_field(GPtrArray* fp, LttvSimpleExpression* se); |
91ad3f0a |
250 | |
56e29124 |
251 | gboolean lttv_simple_expression_assign_operator(LttvSimpleExpression* se, LttvExpressionOp op); |
bb87caa7 |
252 | |
9ab5ebd7 |
253 | gboolean lttv_simple_expression_assign_value(LttvSimpleExpression* se, char* value); |
254 | |
56e29124 |
255 | void lttv_simple_expression_destroy(LttvSimpleExpression* se); |
5f185a2b |
256 | |
5f185a2b |
257 | |
150f0d33 |
258 | /* |
259 | * Logical operators functions |
260 | */ |
261 | |
2ec11087 |
262 | gboolean lttv_apply_op_eq_uint(const gpointer v1, LttvFieldValue v2); |
4d9ff942 |
263 | gboolean lttv_apply_op_eq_uint64(const gpointer v1, LttvFieldValue v2); |
264 | gboolean lttv_apply_op_eq_uint32(const gpointer v1, LttvFieldValue v2); |
265 | gboolean lttv_apply_op_eq_uint16(const gpointer v1, LttvFieldValue v2); |
266 | gboolean lttv_apply_op_eq_double(const gpointer v1, LttvFieldValue v2); |
267 | gboolean lttv_apply_op_eq_string(const gpointer v1, LttvFieldValue v2); |
c6832b57 |
268 | gboolean lttv_apply_op_eq_quark(const gpointer v1, LttvFieldValue v2); |
4d9ff942 |
269 | gboolean lttv_apply_op_eq_ltttime(const gpointer v1, LttvFieldValue v2); |
270 | |
2ec11087 |
271 | gboolean lttv_apply_op_ne_uint(const gpointer v1, LttvFieldValue v2); |
4d9ff942 |
272 | gboolean lttv_apply_op_ne_uint64(const gpointer v1, LttvFieldValue v2); |
273 | gboolean lttv_apply_op_ne_uint32(const gpointer v1, LttvFieldValue v2); |
274 | gboolean lttv_apply_op_ne_uint16(const gpointer v1, LttvFieldValue v2); |
275 | gboolean lttv_apply_op_ne_double(const gpointer v1, LttvFieldValue v2); |
276 | gboolean lttv_apply_op_ne_string(const gpointer v1, LttvFieldValue v2); |
c6832b57 |
277 | gboolean lttv_apply_op_ne_quark(const gpointer v1, LttvFieldValue v2); |
4d9ff942 |
278 | gboolean lttv_apply_op_ne_ltttime(const gpointer v1, LttvFieldValue v2); |
279 | |
2ec11087 |
280 | gboolean lttv_apply_op_lt_uint(const gpointer v1, LttvFieldValue v2); |
4d9ff942 |
281 | gboolean lttv_apply_op_lt_uint64(const gpointer v1, LttvFieldValue v2); |
282 | gboolean lttv_apply_op_lt_uint32(const gpointer v1, LttvFieldValue v2); |
283 | gboolean lttv_apply_op_lt_uint16(const gpointer v1, LttvFieldValue v2); |
284 | gboolean lttv_apply_op_lt_double(const gpointer v1, LttvFieldValue v2); |
285 | gboolean lttv_apply_op_lt_ltttime(const gpointer v1, LttvFieldValue v2); |
286 | |
2ec11087 |
287 | gboolean lttv_apply_op_le_uint(const gpointer v1, LttvFieldValue v2); |
4d9ff942 |
288 | gboolean lttv_apply_op_le_uint64(const gpointer v1, LttvFieldValue v2); |
289 | gboolean lttv_apply_op_le_uint32(const gpointer v1, LttvFieldValue v2); |
290 | gboolean lttv_apply_op_le_uint16(const gpointer v1, LttvFieldValue v2); |
291 | gboolean lttv_apply_op_le_double(const gpointer v1, LttvFieldValue v2); |
292 | gboolean lttv_apply_op_le_ltttime(const gpointer v1, LttvFieldValue v2); |
293 | |
2ec11087 |
294 | gboolean lttv_apply_op_gt_uint(const gpointer v1, LttvFieldValue v2); |
4d9ff942 |
295 | gboolean lttv_apply_op_gt_uint64(const gpointer v1, LttvFieldValue v2); |
296 | gboolean lttv_apply_op_gt_uint32(const gpointer v1, LttvFieldValue v2); |
297 | gboolean lttv_apply_op_gt_uint16(const gpointer v1, LttvFieldValue v2); |
298 | gboolean lttv_apply_op_gt_double(const gpointer v1, LttvFieldValue v2); |
299 | gboolean lttv_apply_op_gt_ltttime(const gpointer v1, LttvFieldValue v2); |
300 | |
2ec11087 |
301 | gboolean lttv_apply_op_ge_uint(const gpointer v1, LttvFieldValue v2); |
4d9ff942 |
302 | gboolean lttv_apply_op_ge_uint64(const gpointer v1, LttvFieldValue v2); |
303 | gboolean lttv_apply_op_ge_uint32(const gpointer v1, LttvFieldValue v2); |
304 | gboolean lttv_apply_op_ge_uint16(const gpointer v1, LttvFieldValue v2); |
305 | gboolean lttv_apply_op_ge_double(const gpointer v1, LttvFieldValue v2); |
306 | gboolean lttv_apply_op_ge_ltttime(const gpointer v1, LttvFieldValue v2); |
150f0d33 |
307 | |
308 | /* |
309 | * Cloning |
310 | */ |
311 | |
4d9ff942 |
312 | LttvFilterTree* lttv_filter_tree_clone(const LttvFilterTree* tree); |
150f0d33 |
313 | |
4d9ff942 |
314 | LttvFilter* lttv_filter_clone(const LttvFilter* filter); |
150f0d33 |
315 | |
56e29124 |
316 | /* |
317 | * LttvFilter |
150f0d33 |
318 | */ |
5f185a2b |
319 | LttvFilter *lttv_filter_new(); |
320 | |
321 | gboolean lttv_filter_update(LttvFilter* filter); |
48f6f3c2 |
322 | |
2ea36caf |
323 | void lttv_filter_destroy(LttvFilter* filter); |
1da1525d |
324 | |
da2e1bfb |
325 | gboolean lttv_filter_append_expression(LttvFilter* filter, const char *expression); |
80f9611a |
326 | |
327 | void lttv_filter_clear_expression(LttvFilter* filter); |
328 | |
56e29124 |
329 | /* |
330 | * LttvFilterTree |
331 | */ |
150f0d33 |
332 | LttvFilterTree* lttv_filter_tree_new(); |
333 | |
334 | void lttv_filter_tree_destroy(LttvFilterTree* tree); |
335 | |
80f9611a |
336 | gboolean lttv_filter_tree_parse( |
4d9ff942 |
337 | const LttvFilterTree* t, |
338 | const LttEvent* event, |
339 | const LttTracefile* tracefile, |
340 | const LttTrace* trace, |
4d9ff942 |
341 | const LttvTracefileContext* context); |
342 | |
343 | gboolean lttv_filter_tree_parse_branch( |
344 | const LttvSimpleExpression* se, |
345 | const LttEvent* event, |
346 | const LttTracefile* tracefile, |
347 | const LttTrace* trace, |
348 | const LttvProcessState* state, |
349 | const LttvTracefileContext* context); |
48f6f3c2 |
350 | |
80f9611a |
351 | /* |
352 | * Debug functions |
353 | */ |
72911c5d |
354 | void lttv_print_tree(const LttvFilterTree* t, const int count); |
80f9611a |
355 | |
48f6f3c2 |
356 | #endif // FILTER_H |
357 | |