Commit | Line | Data |
---|---|---|
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> |
7a4bdb54 | 50 | #include <lttv/traceset-process.h> |
a4c292d4 | 51 | #include <lttv/state.h> |
91ad3f0a | 52 | #include <lttv/module.h> |
a4c292d4 | 53 | |
e00d6a24 | 54 | /* structures prototypes */ |
55 | typedef enum _LttvStructType LttvStructType; | |
56 | typedef enum _LttvFieldType LttvFieldType; | |
57 | typedef enum _LttvExpressionOp LttvExpressionOp; | |
58 | typedef enum _LttvTreeElement LttvTreeElement; | |
59 | typedef enum _LttvLogicalOp LttvLogicalOp; | |
60 | ||
61 | typedef union _LttvFieldValue LttvFieldValue; | |
62 | ||
63 | typedef struct _LttvSimpleExpression LttvSimpleExpression; | |
64 | typedef struct _LttvFilterTree LttvFilterTree; | |
e00d6a24 | 65 | |
33e44b82 | 66 | #ifndef LTTVFILTER_TYPE_DEFINED |
67 | typedef struct _LttvFilter LttvFilter; | |
68 | #define LTTVFILTER_TYPE_DEFINED | |
69 | #endif | |
e00d6a24 | 70 | |
80f9611a | 71 | /** |
7e7af7f2 | 72 | * @enum _LttvStructType |
80f9611a | 73 | * @brief The lttv structures |
74 | * | |
75 | * the LttvStructType enumerates | |
76 | * the possible structures for the | |
77 | * lttv core filter | |
78 | */ | |
79 | enum _LttvStructType { | |
90e19f82 AM |
80 | LTTV_FILTER_TRACE, /**< trace (LttTrace) */ |
81 | LTTV_FILTER_TRACESET, /**< traceset */ | |
82 | LTTV_FILTER_TRACEFILE, /**< tracefile (LttTracefile) */ | |
83 | LTTV_FILTER_EVENT, /**< event (LttEvent) */ | |
84 | LTTV_FILTER_STATE /**< state (LttvProcessState) */ | |
e00d6a24 | 85 | }; |
80f9611a | 86 | |
150f0d33 | 87 | /** |
7e7af7f2 | 88 | * @enum _LttvFieldType |
80f9611a | 89 | * @brief Possible fields for the structures |
150f0d33 | 90 | * |
91 | * the LttvFieldType enum consists on | |
92 | * all the hardcoded structures and | |
93 | * their appropriate fields on which | |
94 | * filters can be applied. | |
95 | */ | |
96 | enum _LttvFieldType { | |
90e19f82 AM |
97 | LTTV_FILTER_TRACE_NAME, /**< trace.name (char*) */ |
98 | LTTV_FILTER_TRACEFILE_NAME, /**< tracefile.name (char*) */ | |
99 | LTTV_FILTER_STATE_PID, /**< state.pid (guint) */ | |
100 | LTTV_FILTER_STATE_PPID, /**< state.ppid (guint) */ | |
101 | LTTV_FILTER_STATE_CT, /**< state.creation_time (double) */ | |
102 | LTTV_FILTER_STATE_IT, /**< state.insertion_time (double) */ | |
103 | LTTV_FILTER_STATE_P_NAME, /**< state.process_name (char*) */ | |
90e19f82 AM |
104 | LTTV_FILTER_STATE_EX_MODE, /**< state.execution_mode (LttvExecutionMode) */ |
105 | LTTV_FILTER_STATE_EX_SUBMODE, /**< state.execution_submode (LttvExecutionSubmode) */ | |
106 | LTTV_FILTER_STATE_P_STATUS, /**< state.process_status (LttvProcessStatus) */ | |
107 | LTTV_FILTER_STATE_CPU, /**< state.cpu (?last_cpu?) */ | |
108 | LTTV_FILTER_EVENT_NAME, /**< event.name (char*) */ | |
109 | LTTV_FILTER_EVENT_SUBNAME, /**< event.subname (char*) */ | |
110 | LTTV_FILTER_EVENT_CATEGORY, /**< FIXME: not implemented */ | |
111 | LTTV_FILTER_EVENT_TIME, /**< event.time (double) */ | |
112 | LTTV_FILTER_EVENT_TSC, /**< event.tsc (double) */ | |
113 | LTTV_FILTER_EVENT_TARGET_PID, /**< event.target_pid (guint) */ | |
114 | LTTV_FILTER_EVENT_FIELD, /**< dynamic field, specified in facility */ | |
115 | LTTV_FILTER_UNDEFINED /**< undefined field */ | |
e00d6a24 | 116 | }; |
90e19f82 | 117 | |
84a333d6 | 118 | /** |
571ef1ed | 119 | * @enum _LttvExpressionOp |
56e29124 | 120 | * @brief Contains possible operators |
121 | * | |
122 | * This enumeration defines the | |
123 | * possible operator used to compare | |
124 | * right and left member in simple | |
125 | * expression | |
84a333d6 | 126 | */ |
e00d6a24 | 127 | enum _LttvExpressionOp |
84a333d6 | 128 | { |
90e19f82 AM |
129 | LTTV_FIELD_EQ, /**< equal */ |
130 | LTTV_FIELD_NE, /**< not equal */ | |
131 | LTTV_FIELD_LT, /**< lower than */ | |
132 | LTTV_FIELD_LE, /**< lower or equal */ | |
133 | LTTV_FIELD_GT, /**< greater than */ | |
134 | LTTV_FIELD_GE /**< greater or equal */ | |
e00d6a24 | 135 | }; |
84a333d6 | 136 | |
56e29124 | 137 | /** |
7e7af7f2 | 138 | * @union _LttvFieldValue |
56e29124 | 139 | * @brief Contains possible field values |
7e7af7f2 | 140 | * |
56e29124 | 141 | * This particular union defines the |
142 | * possible set of values taken by the | |
90e19f82 | 143 | * right member of a simple expression. |
56e29124 | 144 | * It is used for comparison whithin the |
145 | * 'operators' functions | |
146 | */ | |
e00d6a24 | 147 | union _LttvFieldValue { |
90e19f82 AM |
148 | GQuark v_quark; /**< GQuark */ |
149 | guint64 v_uint64; /**< unsigned int of 64 bytes */ | |
150 | guint32 v_uint32; /**< unsigned int of 32 bytes */ | |
151 | guint16 v_uint16; /**< unsigned int of 16 bytes */ | |
152 | guint16 v_uint; /**< unsigned int */ | |
153 | double v_double; /**< double */ | |
154 | char* v_string; /**< string */ | |
155 | LttTime v_ltttime; /**< LttTime */ | |
156 | struct { | |
157 | GQuark q[2]; | |
158 | } v_quarks; | |
e00d6a24 | 159 | }; |
56e29124 | 160 | |
150f0d33 | 161 | /** |
7e7af7f2 | 162 | * @enum _LttvTreeElement |
150f0d33 | 163 | * @brief element types for the tree nodes |
164 | * | |
165 | * LttvTreeElement defines the possible | |
90e19f82 | 166 | * types of nodes which build the LttvFilterTree. |
2ea36caf | 167 | */ |
e00d6a24 | 168 | enum _LttvTreeElement { |
90e19f82 AM |
169 | LTTV_TREE_IDLE, /**< this node does nothing */ |
170 | LTTV_TREE_NODE, /**< this node contains a logical operator */ | |
171 | LTTV_TREE_LEAF /**< this node is a leaf and contains a simple expression */ | |
e00d6a24 | 172 | }; |
f4e9dd16 | 173 | |
56e29124 | 174 | |
150f0d33 | 175 | /** |
7e7af7f2 | 176 | * @struct _LttvSimpleExpression |
150f0d33 | 177 | * @brief simple expression structure |
178 | * | |
179 | * An LttvSimpleExpression is the base | |
180 | * of all filtering operations. It also | |
181 | * populates the leaves of the | |
182 | * LttvFilterTree. Each expression | |
183 | * consists basically in a structure | |
184 | * field, an operator and a specific | |
185 | * value. | |
186 | */ | |
e00d6a24 | 187 | struct _LttvSimpleExpression |
84a333d6 | 188 | { |
90e19f82 AM |
189 | gint field; /**< left member of simple expression */ |
190 | gint offset; /**< offset used for dynamic fields */ | |
191 | gboolean (*op)(gpointer,LttvFieldValue); /**< operator of simple expression */ | |
192 | LttvFieldValue value; /**< right member of simple expression */ | |
e00d6a24 | 193 | }; |
84a333d6 | 194 | |
150f0d33 | 195 | /** |
7e7af7f2 | 196 | * @enum _LttvLogicalOp |
150f0d33 | 197 | * @brief logical operators |
198 | * | |
199 | * Contains the possible values taken | |
200 | * by logical operator used to link | |
201 | * simple expression. Values are | |
202 | * AND, OR, XOR or NOT | |
203 | */ | |
e00d6a24 | 204 | enum _LttvLogicalOp { |
90e19f82 AM |
205 | LTTV_LOGICAL_OR = 1, /**< OR (1) */ |
206 | LTTV_LOGICAL_AND = 1<<1, /**< AND (2) */ | |
207 | LTTV_LOGICAL_NOT = 1<<2, /**< NOT (4) */ | |
208 | LTTV_LOGICAL_XOR = 1<<3 /**< XOR (8) */ | |
e00d6a24 | 209 | }; |
1a7fa682 | 210 | |
150f0d33 | 211 | /** |
7e7af7f2 | 212 | * @struct _LttvFilterTree |
213 | * @brief The filtering tree | |
214 | * | |
150f0d33 | 215 | * The filtering tree is used to represent the |
216 | * expression string in its entire hierarchy | |
217 | * composed of simple expressions and logical | |
218 | * operators | |
2ea36caf | 219 | */ |
e00d6a24 | 220 | struct _LttvFilterTree { |
90e19f82 AM |
221 | int node; /**< value of LttvLogicalOp */ |
222 | LttvTreeElement left; /**< nature of left branch (node/leaf) */ | |
223 | LttvTreeElement right; /**< nature of right branch (node/leaf) */ | |
224 | union { | |
225 | LttvFilterTree* t; | |
226 | LttvSimpleExpression* leaf; | |
227 | } l_child; /**< left branch of tree */ | |
228 | union { | |
229 | LttvFilterTree* t; | |
230 | LttvSimpleExpression* leaf; | |
231 | } r_child; /**< right branch of tree */ | |
e00d6a24 | 232 | }; |
84a333d6 | 233 | |
31452f49 | 234 | /** |
7e7af7f2 | 235 | * @struct _LttvFilter |
236 | * @brief The filter | |
237 | * | |
150f0d33 | 238 | * Contains a binary tree of filtering options along |
239 | * with the expression itself. | |
31452f49 | 240 | */ |
e00d6a24 | 241 | struct _LttvFilter { |
90e19f82 AM |
242 | char *expression; /**< filtering expression string */ |
243 | LttvFilterTree *head; /**< tree associated to expression */ | |
e00d6a24 | 244 | }; |
84a333d6 | 245 | |
56e29124 | 246 | /* |
247 | * Simple Expression | |
248 | */ | |
249 | LttvSimpleExpression* lttv_simple_expression_new(); | |
250 | ||
90e19f82 AM |
251 | gboolean lttv_simple_expression_assign_field(GPtrArray* fp, |
252 | LttvSimpleExpression* se); | |
91ad3f0a | 253 | |
90e19f82 AM |
254 | gboolean lttv_simple_expression_assign_operator(LttvSimpleExpression* se, |
255 | LttvExpressionOp op); | |
bb87caa7 | 256 | |
90e19f82 AM |
257 | gboolean lttv_simple_expression_assign_value(LttvSimpleExpression* se, |
258 | char* value); | |
9ab5ebd7 | 259 | |
56e29124 | 260 | void lttv_simple_expression_destroy(LttvSimpleExpression* se); |
5f185a2b | 261 | |
5f185a2b | 262 | |
150f0d33 | 263 | /* |
264 | * Logical operators functions | |
265 | */ | |
266 | ||
2ec11087 | 267 | gboolean lttv_apply_op_eq_uint(const gpointer v1, LttvFieldValue v2); |
4d9ff942 | 268 | gboolean lttv_apply_op_eq_uint64(const gpointer v1, LttvFieldValue v2); |
269 | gboolean lttv_apply_op_eq_uint32(const gpointer v1, LttvFieldValue v2); | |
270 | gboolean lttv_apply_op_eq_uint16(const gpointer v1, LttvFieldValue v2); | |
271 | gboolean lttv_apply_op_eq_double(const gpointer v1, LttvFieldValue v2); | |
272 | gboolean lttv_apply_op_eq_string(const gpointer v1, LttvFieldValue v2); | |
c6832b57 | 273 | gboolean lttv_apply_op_eq_quark(const gpointer v1, LttvFieldValue v2); |
6471e71f | 274 | gboolean lttv_apply_op_eq_quarks(const gpointer v1, LttvFieldValue v2); |
4d9ff942 | 275 | gboolean lttv_apply_op_eq_ltttime(const gpointer v1, LttvFieldValue v2); |
276 | ||
2ec11087 | 277 | gboolean lttv_apply_op_ne_uint(const gpointer v1, LttvFieldValue v2); |
4d9ff942 | 278 | gboolean lttv_apply_op_ne_uint64(const gpointer v1, LttvFieldValue v2); |
279 | gboolean lttv_apply_op_ne_uint32(const gpointer v1, LttvFieldValue v2); | |
280 | gboolean lttv_apply_op_ne_uint16(const gpointer v1, LttvFieldValue v2); | |
281 | gboolean lttv_apply_op_ne_double(const gpointer v1, LttvFieldValue v2); | |
282 | gboolean lttv_apply_op_ne_string(const gpointer v1, LttvFieldValue v2); | |
c6832b57 | 283 | gboolean lttv_apply_op_ne_quark(const gpointer v1, LttvFieldValue v2); |
6471e71f | 284 | gboolean lttv_apply_op_ne_quarks(const gpointer v1, LttvFieldValue v2); |
4d9ff942 | 285 | gboolean lttv_apply_op_ne_ltttime(const gpointer v1, LttvFieldValue v2); |
286 | ||
2ec11087 | 287 | gboolean lttv_apply_op_lt_uint(const gpointer v1, LttvFieldValue v2); |
4d9ff942 | 288 | gboolean lttv_apply_op_lt_uint64(const gpointer v1, LttvFieldValue v2); |
289 | gboolean lttv_apply_op_lt_uint32(const gpointer v1, LttvFieldValue v2); | |
290 | gboolean lttv_apply_op_lt_uint16(const gpointer v1, LttvFieldValue v2); | |
291 | gboolean lttv_apply_op_lt_double(const gpointer v1, LttvFieldValue v2); | |
292 | gboolean lttv_apply_op_lt_ltttime(const gpointer v1, LttvFieldValue v2); | |
293 | ||
2ec11087 | 294 | gboolean lttv_apply_op_le_uint(const gpointer v1, LttvFieldValue v2); |
4d9ff942 | 295 | gboolean lttv_apply_op_le_uint64(const gpointer v1, LttvFieldValue v2); |
296 | gboolean lttv_apply_op_le_uint32(const gpointer v1, LttvFieldValue v2); | |
297 | gboolean lttv_apply_op_le_uint16(const gpointer v1, LttvFieldValue v2); | |
298 | gboolean lttv_apply_op_le_double(const gpointer v1, LttvFieldValue v2); | |
299 | gboolean lttv_apply_op_le_ltttime(const gpointer v1, LttvFieldValue v2); | |
300 | ||
2ec11087 | 301 | gboolean lttv_apply_op_gt_uint(const gpointer v1, LttvFieldValue v2); |
4d9ff942 | 302 | gboolean lttv_apply_op_gt_uint64(const gpointer v1, LttvFieldValue v2); |
303 | gboolean lttv_apply_op_gt_uint32(const gpointer v1, LttvFieldValue v2); | |
304 | gboolean lttv_apply_op_gt_uint16(const gpointer v1, LttvFieldValue v2); | |
305 | gboolean lttv_apply_op_gt_double(const gpointer v1, LttvFieldValue v2); | |
306 | gboolean lttv_apply_op_gt_ltttime(const gpointer v1, LttvFieldValue v2); | |
307 | ||
2ec11087 | 308 | gboolean lttv_apply_op_ge_uint(const gpointer v1, LttvFieldValue v2); |
4d9ff942 | 309 | gboolean lttv_apply_op_ge_uint64(const gpointer v1, LttvFieldValue v2); |
310 | gboolean lttv_apply_op_ge_uint32(const gpointer v1, LttvFieldValue v2); | |
311 | gboolean lttv_apply_op_ge_uint16(const gpointer v1, LttvFieldValue v2); | |
312 | gboolean lttv_apply_op_ge_double(const gpointer v1, LttvFieldValue v2); | |
313 | gboolean lttv_apply_op_ge_ltttime(const gpointer v1, LttvFieldValue v2); | |
150f0d33 | 314 | |
315 | /* | |
316 | * Cloning | |
317 | */ | |
318 | ||
4d9ff942 | 319 | LttvFilterTree* lttv_filter_tree_clone(const LttvFilterTree* tree); |
150f0d33 | 320 | |
4d9ff942 | 321 | LttvFilter* lttv_filter_clone(const LttvFilter* filter); |
150f0d33 | 322 | |
56e29124 | 323 | /* |
324 | * LttvFilter | |
150f0d33 | 325 | */ |
90e19f82 | 326 | LttvFilter* lttv_filter_new(); |
5f185a2b | 327 | |
328 | gboolean lttv_filter_update(LttvFilter* filter); | |
48f6f3c2 | 329 | |
2ea36caf | 330 | void lttv_filter_destroy(LttvFilter* filter); |
1da1525d | 331 | |
90e19f82 AM |
332 | gboolean lttv_filter_append_expression(LttvFilter* filter, |
333 | const char *expression); | |
80f9611a | 334 | |
335 | void lttv_filter_clear_expression(LttvFilter* filter); | |
336 | ||
56e29124 | 337 | /* |
338 | * LttvFilterTree | |
339 | */ | |
150f0d33 | 340 | LttvFilterTree* lttv_filter_tree_new(); |
341 | ||
342 | void lttv_filter_tree_destroy(LttvFilterTree* tree); | |
190724cd | 343 | #ifdef BABEL_CLEANUP |
80f9611a | 344 | gboolean lttv_filter_tree_parse( |
90e19f82 AM |
345 | const LttvFilterTree* t, |
346 | const LttEvent* event, | |
347 | const LttTracefile* tracefile, | |
348 | const LttTrace* trace, | |
90e19f82 | 349 | const LttvProcessState* pstate, |
451aaf27 | 350 | const LttvTrace* tracev); |
4d9ff942 | 351 | |
352 | gboolean lttv_filter_tree_parse_branch( | |
90e19f82 AM |
353 | const LttvSimpleExpression* se, |
354 | const LttEvent* event, | |
355 | const LttTracefile* tracefile, | |
356 | const LttTrace* trace, | |
451aaf27 | 357 | const LttvProcessState* state); |
190724cd | 358 | #endif |
80f9611a | 359 | /* |
360 | * Debug functions | |
361 | */ | |
72911c5d | 362 | void lttv_print_tree(const LttvFilterTree* t, const int count); |
80f9611a | 363 | |
48f6f3c2 | 364 | #endif // FILTER_H |
365 |