1 /* This file is part of the Linux Trace Toolkit viewer
2 * Copyright (C) 2003-2005 Michel Dagenais and Simon Bouvier-Zappa
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;
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.
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,
22 /*! \file lttv/lttv/filter.h
23 * \brief Defines the core filter of application
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
31 * The grammar for filters is:
35 * expression = "(" expression ")" | "!" expression |
36 * expression "&&" expression | expression "||" expression |
39 * simpleExpression = fieldPath op value
41 * fieldPath = fieldComponent [ "." fieldPath ]
43 * fieldComponent = name [ "[" integer "]" ]
45 * value = integer | double | string
49 #include <lttv/traceset.h>
50 #include <lttv/tracecontext.h>
51 #include <lttv/state.h>
52 #include <lttv/module.h>
55 #include <ltt/event.h>
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
;
64 typedef union _LttvFieldValue LttvFieldValue
;
66 typedef struct _LttvSimpleExpression LttvSimpleExpression
;
67 typedef struct _LttvFilterTree LttvFilterTree
;
69 #ifndef LTTVFILTER_TYPE_DEFINED
70 typedef struct _LttvFilter LttvFilter
;
71 #define LTTVFILTER_TYPE_DEFINED
75 * @enum _LttvStructType
76 * @brief The lttv structures
78 * the LttvStructType enumerates
79 * the possible structures for the
82 enum _LttvStructType
{
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) */
91 * @enum _LttvFieldType
92 * @brief Possible fields for the structures
94 * the LttvFieldType enum consists on
95 * all the hardcoded structures and
96 * their appropriate fields on which
97 * filters can be applied.
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_T_BRAND
, /**< state.thread_brand (char*) */
108 LTTV_FILTER_STATE_EX_MODE
, /**< state.execution_mode (LttvExecutionMode) */
109 LTTV_FILTER_STATE_EX_SUBMODE
, /**< state.execution_submode (LttvExecutionSubmode) */
110 LTTV_FILTER_STATE_P_STATUS
, /**< state.process_status (LttvProcessStatus) */
111 LTTV_FILTER_STATE_CPU
, /**< state.cpu (?last_cpu?) */
112 LTTV_FILTER_EVENT_NAME
, /**< event.name (char*) */
113 LTTV_FILTER_EVENT_SUBNAME
, /**< event.subname (char*) */
114 LTTV_FILTER_EVENT_CATEGORY
, /**< FIXME: not implemented */
115 LTTV_FILTER_EVENT_TIME
, /**< event.time (double) */
116 LTTV_FILTER_EVENT_TSC
, /**< event.tsc (double) */
117 LTTV_FILTER_EVENT_TARGET_PID
, /**< event.target_pid (guint) */
118 LTTV_FILTER_EVENT_FIELD
, /**< dynamic field, specified in facility */
119 LTTV_FILTER_UNDEFINED
/**< undefined field */
123 * @enum _LttvExpressionOp
124 * @brief Contains possible operators
126 * This enumeration defines the
127 * possible operator used to compare
128 * right and left member in simple
131 enum _LttvExpressionOp
133 LTTV_FIELD_EQ
, /**< equal */
134 LTTV_FIELD_NE
, /**< not equal */
135 LTTV_FIELD_LT
, /**< lower than */
136 LTTV_FIELD_LE
, /**< lower or equal */
137 LTTV_FIELD_GT
, /**< greater than */
138 LTTV_FIELD_GE
/**< greater or equal */
142 * @union _LttvFieldValue
143 * @brief Contains possible field values
145 * This particular union defines the
146 * possible set of values taken by the
147 * right member of a simple expression.
148 * It is used for comparison whithin the
149 * 'operators' functions
151 union _LttvFieldValue
{
152 GQuark v_quark
; /**< GQuark */
153 guint64 v_uint64
; /**< unsigned int of 64 bytes */
154 guint32 v_uint32
; /**< unsigned int of 32 bytes */
155 guint16 v_uint16
; /**< unsigned int of 16 bytes */
156 guint16 v_uint
; /**< unsigned int */
157 double v_double
; /**< double */
158 char* v_string
; /**< string */
159 LttTime v_ltttime
; /**< LttTime */
166 * @enum _LttvTreeElement
167 * @brief element types for the tree nodes
169 * LttvTreeElement defines the possible
170 * types of nodes which build the LttvFilterTree.
172 enum _LttvTreeElement
{
173 LTTV_TREE_IDLE
, /**< this node does nothing */
174 LTTV_TREE_NODE
, /**< this node contains a logical operator */
175 LTTV_TREE_LEAF
/**< this node is a leaf and contains a simple expression */
180 * @struct _LttvSimpleExpression
181 * @brief simple expression structure
183 * An LttvSimpleExpression is the base
184 * of all filtering operations. It also
185 * populates the leaves of the
186 * LttvFilterTree. Each expression
187 * consists basically in a structure
188 * field, an operator and a specific
191 struct _LttvSimpleExpression
193 gint field
; /**< left member of simple expression */
194 gint offset
; /**< offset used for dynamic fields */
195 gboolean (*op
)(gpointer
,LttvFieldValue
); /**< operator of simple expression */
196 LttvFieldValue value
; /**< right member of simple expression */
200 * @enum _LttvLogicalOp
201 * @brief logical operators
203 * Contains the possible values taken
204 * by logical operator used to link
205 * simple expression. Values are
206 * AND, OR, XOR or NOT
208 enum _LttvLogicalOp
{
209 LTTV_LOGICAL_OR
= 1, /**< OR (1) */
210 LTTV_LOGICAL_AND
= 1<<1, /**< AND (2) */
211 LTTV_LOGICAL_NOT
= 1<<2, /**< NOT (4) */
212 LTTV_LOGICAL_XOR
= 1<<3 /**< XOR (8) */
216 * @struct _LttvFilterTree
217 * @brief The filtering tree
219 * The filtering tree is used to represent the
220 * expression string in its entire hierarchy
221 * composed of simple expressions and logical
224 struct _LttvFilterTree
{
225 int node
; /**< value of LttvLogicalOp */
226 LttvTreeElement left
; /**< nature of left branch (node/leaf) */
227 LttvTreeElement right
; /**< nature of right branch (node/leaf) */
230 LttvSimpleExpression
* leaf
;
231 } l_child
; /**< left branch of tree */
234 LttvSimpleExpression
* leaf
;
235 } r_child
; /**< right branch of tree */
239 * @struct _LttvFilter
242 * Contains a binary tree of filtering options along
243 * with the expression itself.
246 char *expression
; /**< filtering expression string */
247 LttvFilterTree
*head
; /**< tree associated to expression */
253 LttvSimpleExpression
* lttv_simple_expression_new();
255 gboolean
lttv_simple_expression_assign_field(GPtrArray
* fp
,
256 LttvSimpleExpression
* se
);
258 gboolean
lttv_simple_expression_assign_operator(LttvSimpleExpression
* se
,
259 LttvExpressionOp op
);
261 gboolean
lttv_simple_expression_assign_value(LttvSimpleExpression
* se
,
264 void lttv_simple_expression_destroy(LttvSimpleExpression
* se
);
268 * Logical operators functions
271 gboolean
lttv_apply_op_eq_uint(const gpointer v1
, LttvFieldValue v2
);
272 gboolean
lttv_apply_op_eq_uint64(const gpointer v1
, LttvFieldValue v2
);
273 gboolean
lttv_apply_op_eq_uint32(const gpointer v1
, LttvFieldValue v2
);
274 gboolean
lttv_apply_op_eq_uint16(const gpointer v1
, LttvFieldValue v2
);
275 gboolean
lttv_apply_op_eq_double(const gpointer v1
, LttvFieldValue v2
);
276 gboolean
lttv_apply_op_eq_string(const gpointer v1
, LttvFieldValue v2
);
277 gboolean
lttv_apply_op_eq_quark(const gpointer v1
, LttvFieldValue v2
);
278 gboolean
lttv_apply_op_eq_quarks(const gpointer v1
, LttvFieldValue v2
);
279 gboolean
lttv_apply_op_eq_ltttime(const gpointer v1
, LttvFieldValue v2
);
281 gboolean
lttv_apply_op_ne_uint(const gpointer v1
, LttvFieldValue v2
);
282 gboolean
lttv_apply_op_ne_uint64(const gpointer v1
, LttvFieldValue v2
);
283 gboolean
lttv_apply_op_ne_uint32(const gpointer v1
, LttvFieldValue v2
);
284 gboolean
lttv_apply_op_ne_uint16(const gpointer v1
, LttvFieldValue v2
);
285 gboolean
lttv_apply_op_ne_double(const gpointer v1
, LttvFieldValue v2
);
286 gboolean
lttv_apply_op_ne_string(const gpointer v1
, LttvFieldValue v2
);
287 gboolean
lttv_apply_op_ne_quark(const gpointer v1
, LttvFieldValue v2
);
288 gboolean
lttv_apply_op_ne_quarks(const gpointer v1
, LttvFieldValue v2
);
289 gboolean
lttv_apply_op_ne_ltttime(const gpointer v1
, LttvFieldValue v2
);
291 gboolean
lttv_apply_op_lt_uint(const gpointer v1
, LttvFieldValue v2
);
292 gboolean
lttv_apply_op_lt_uint64(const gpointer v1
, LttvFieldValue v2
);
293 gboolean
lttv_apply_op_lt_uint32(const gpointer v1
, LttvFieldValue v2
);
294 gboolean
lttv_apply_op_lt_uint16(const gpointer v1
, LttvFieldValue v2
);
295 gboolean
lttv_apply_op_lt_double(const gpointer v1
, LttvFieldValue v2
);
296 gboolean
lttv_apply_op_lt_ltttime(const gpointer v1
, LttvFieldValue v2
);
298 gboolean
lttv_apply_op_le_uint(const gpointer v1
, LttvFieldValue v2
);
299 gboolean
lttv_apply_op_le_uint64(const gpointer v1
, LttvFieldValue v2
);
300 gboolean
lttv_apply_op_le_uint32(const gpointer v1
, LttvFieldValue v2
);
301 gboolean
lttv_apply_op_le_uint16(const gpointer v1
, LttvFieldValue v2
);
302 gboolean
lttv_apply_op_le_double(const gpointer v1
, LttvFieldValue v2
);
303 gboolean
lttv_apply_op_le_ltttime(const gpointer v1
, LttvFieldValue v2
);
305 gboolean
lttv_apply_op_gt_uint(const gpointer v1
, LttvFieldValue v2
);
306 gboolean
lttv_apply_op_gt_uint64(const gpointer v1
, LttvFieldValue v2
);
307 gboolean
lttv_apply_op_gt_uint32(const gpointer v1
, LttvFieldValue v2
);
308 gboolean
lttv_apply_op_gt_uint16(const gpointer v1
, LttvFieldValue v2
);
309 gboolean
lttv_apply_op_gt_double(const gpointer v1
, LttvFieldValue v2
);
310 gboolean
lttv_apply_op_gt_ltttime(const gpointer v1
, LttvFieldValue v2
);
312 gboolean
lttv_apply_op_ge_uint(const gpointer v1
, LttvFieldValue v2
);
313 gboolean
lttv_apply_op_ge_uint64(const gpointer v1
, LttvFieldValue v2
);
314 gboolean
lttv_apply_op_ge_uint32(const gpointer v1
, LttvFieldValue v2
);
315 gboolean
lttv_apply_op_ge_uint16(const gpointer v1
, LttvFieldValue v2
);
316 gboolean
lttv_apply_op_ge_double(const gpointer v1
, LttvFieldValue v2
);
317 gboolean
lttv_apply_op_ge_ltttime(const gpointer v1
, LttvFieldValue v2
);
323 LttvFilterTree
* lttv_filter_tree_clone(const LttvFilterTree
* tree
);
325 LttvFilter
* lttv_filter_clone(const LttvFilter
* filter
);
330 LttvFilter
* lttv_filter_new();
332 gboolean
lttv_filter_update(LttvFilter
* filter
);
334 void lttv_filter_destroy(LttvFilter
* filter
);
336 gboolean
lttv_filter_append_expression(LttvFilter
* filter
,
337 const char *expression
);
339 void lttv_filter_clear_expression(LttvFilter
* filter
);
344 LttvFilterTree
* lttv_filter_tree_new();
346 void lttv_filter_tree_destroy(LttvFilterTree
* tree
);
348 gboolean
lttv_filter_tree_parse(
349 const LttvFilterTree
* t
,
350 const LttEvent
* event
,
351 const LttTracefile
* tracefile
,
352 const LttTrace
* trace
,
353 const LttvTracefileContext
* context
,
354 const LttvProcessState
* pstate
,
355 const LttvTraceContext
* tc
);
357 gboolean
lttv_filter_tree_parse_branch(
358 const LttvSimpleExpression
* se
,
359 const LttEvent
* event
,
360 const LttTracefile
* tracefile
,
361 const LttTrace
* trace
,
362 const LttvProcessState
* state
,
363 const LttvTracefileContext
* context
);
368 void lttv_print_tree(const LttvFilterTree
* t
, const int count
);