projects / lttv.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
convert from svn repository: remove tags directory
[lttv.git] / trunk / lttng-xenomai / LinuxTraceToolkitViewer-0.8.61-xenoltt / lttv / lttv / filter.h
CommitLineData
03d7fdf3 1/* This file is part of the Linux Trace Toolkit viewer
2 * Copyright (C) 2003-2005 Michel Dagenais and Simon Bouvier-Zappa
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
19#ifndef FILTER_H
20#define FILTER_H
21
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
49#include <lttv/traceset.h>
50#include <lttv/tracecontext.h>
51#include <lttv/state.h>
52#include <lttv/module.h>
53#include <ltt/ltt.h>
54#include <ltt/time.h>
55#include <ltt/event.h>
56
57/* structures prototypes */
58typedef enum _LttvStructType LttvStructType;
59typedef enum _LttvFieldType LttvFieldType;
60typedef enum _LttvExpressionOp LttvExpressionOp;
61typedef enum _LttvTreeElement LttvTreeElement;
62typedef enum _LttvLogicalOp LttvLogicalOp;
63
64typedef union _LttvFieldValue LttvFieldValue;
65
66typedef struct _LttvSimpleExpression LttvSimpleExpression;
67typedef struct _LttvFilterTree LttvFilterTree;
68
69#ifndef LTTVFILTER_TYPE_DEFINED
70typedef struct _LttvFilter LttvFilter;
71#define LTTVFILTER_TYPE_DEFINED
72#endif
73
74/**
75 * @enum _LttvStructType
76 * @brief The lttv structures
77 *
78 * the LttvStructType enumerates
79 * the possible structures for the
80 * lttv core filter
81 */
82enum _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) */
88};
89
90/**
91 * @enum _LttvFieldType
92 * @brief Possible fields for the structures
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 */
99enum _LttvFieldType {
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_FACILITY, /**< event.facility (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 */
120};
121
122/**
123 * @enum _LttvExpressionOp
124 * @brief Contains possible operators
125 *
126 * This enumeration defines the
127 * possible operator used to compare
128 * right and left member in simple
129 * expression
130 */
131enum _LttvExpressionOp
132{
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 */
139};
140
141/**
142 * @union _LttvFieldValue
143 * @brief Contains possible field values
144 *
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
150 */
151union _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 */
160};
161
162/**
163 * @enum _LttvTreeElement
164 * @brief element types for the tree nodes
165 *
166 * LttvTreeElement defines the possible
167 * types of nodes which build the LttvFilterTree.
168 */
169enum _LttvTreeElement {
170 LTTV_TREE_IDLE, /**< this node does nothing */
171 LTTV_TREE_NODE, /**< this node contains a logical operator */
172 LTTV_TREE_LEAF /**< this node is a leaf and contains a simple expression */
173};
174
175
176/**
177 * @struct _LttvSimpleExpression
178 * @brief simple expression structure
179 *
180 * An LttvSimpleExpression is the base
181 * of all filtering operations. It also
182 * populates the leaves of the
183 * LttvFilterTree. Each expression
184 * consists basically in a structure
185 * field, an operator and a specific
186 * value.
187 */
188struct _LttvSimpleExpression
189{
190 gint field; /**< left member of simple expression */
191 gint offset; /**< offset used for dynamic fields */
192 gboolean (*op)(gpointer,LttvFieldValue); /**< operator of simple expression */
193 LttvFieldValue value; /**< right member of simple expression */
194};
195
196/**
197 * @enum _LttvLogicalOp
198 * @brief logical operators
199 *
200 * Contains the possible values taken
201 * by logical operator used to link
202 * simple expression. Values are
203 * AND, OR, XOR or NOT
204 */
205enum _LttvLogicalOp {
206 LTTV_LOGICAL_OR = 1, /**< OR (1) */
207 LTTV_LOGICAL_AND = 1<<1, /**< AND (2) */
208 LTTV_LOGICAL_NOT = 1<<2, /**< NOT (4) */
209 LTTV_LOGICAL_XOR = 1<<3 /**< XOR (8) */
210};
211
212/**
213 * @struct _LttvFilterTree
214 * @brief The filtering tree
215 *
216 * The filtering tree is used to represent the
217 * expression string in its entire hierarchy
218 * composed of simple expressions and logical
219 * operators
220 */
221struct _LttvFilterTree {
222 int node; /**< value of LttvLogicalOp */
223 LttvTreeElement left; /**< nature of left branch (node/leaf) */
224 LttvTreeElement right; /**< nature of right branch (node/leaf) */
225 union {
226 LttvFilterTree* t;
227 LttvSimpleExpression* leaf;
228 } l_child; /**< left branch of tree */
229 union {
230 LttvFilterTree* t;
231 LttvSimpleExpression* leaf;
232 } r_child; /**< right branch of tree */
233};
234
235/**
236 * @struct _LttvFilter
237 * @brief The filter
238 *
239 * Contains a binary tree of filtering options along
240 * with the expression itself.
241 */
242struct _LttvFilter {
243 char *expression; /**< filtering expression string */
244 LttvFilterTree *head; /**< tree associated to expression */
245};
246
247/*
248 * Simple Expression
249 */
250LttvSimpleExpression* lttv_simple_expression_new();
251
252gboolean lttv_simple_expression_assign_field(GPtrArray* fp, LttvSimpleExpression* se);
253
254gboolean lttv_simple_expression_assign_operator(LttvSimpleExpression* se, LttvExpressionOp op);
255
256gboolean lttv_simple_expression_assign_value(LttvSimpleExpression* se, char* value);
257
258void lttv_simple_expression_destroy(LttvSimpleExpression* se);
259
260
261/*
262 * Logical operators functions
263 */
264
265gboolean lttv_apply_op_eq_uint(const gpointer v1, LttvFieldValue v2);
266gboolean lttv_apply_op_eq_uint64(const gpointer v1, LttvFieldValue v2);
267gboolean lttv_apply_op_eq_uint32(const gpointer v1, LttvFieldValue v2);
268gboolean lttv_apply_op_eq_uint16(const gpointer v1, LttvFieldValue v2);
269gboolean lttv_apply_op_eq_double(const gpointer v1, LttvFieldValue v2);
270gboolean lttv_apply_op_eq_string(const gpointer v1, LttvFieldValue v2);
271gboolean lttv_apply_op_eq_quark(const gpointer v1, LttvFieldValue v2);
272gboolean lttv_apply_op_eq_ltttime(const gpointer v1, LttvFieldValue v2);
273
274gboolean lttv_apply_op_ne_uint(const gpointer v1, LttvFieldValue v2);
275gboolean lttv_apply_op_ne_uint64(const gpointer v1, LttvFieldValue v2);
276gboolean lttv_apply_op_ne_uint32(const gpointer v1, LttvFieldValue v2);
277gboolean lttv_apply_op_ne_uint16(const gpointer v1, LttvFieldValue v2);
278gboolean lttv_apply_op_ne_double(const gpointer v1, LttvFieldValue v2);
279gboolean lttv_apply_op_ne_string(const gpointer v1, LttvFieldValue v2);
280gboolean lttv_apply_op_ne_quark(const gpointer v1, LttvFieldValue v2);
281gboolean lttv_apply_op_ne_ltttime(const gpointer v1, LttvFieldValue v2);
282
283gboolean lttv_apply_op_lt_uint(const gpointer v1, LttvFieldValue v2);
284gboolean lttv_apply_op_lt_uint64(const gpointer v1, LttvFieldValue v2);
285gboolean lttv_apply_op_lt_uint32(const gpointer v1, LttvFieldValue v2);
286gboolean lttv_apply_op_lt_uint16(const gpointer v1, LttvFieldValue v2);
287gboolean lttv_apply_op_lt_double(const gpointer v1, LttvFieldValue v2);
288gboolean lttv_apply_op_lt_ltttime(const gpointer v1, LttvFieldValue v2);
289
290gboolean lttv_apply_op_le_uint(const gpointer v1, LttvFieldValue v2);
291gboolean lttv_apply_op_le_uint64(const gpointer v1, LttvFieldValue v2);
292gboolean lttv_apply_op_le_uint32(const gpointer v1, LttvFieldValue v2);
293gboolean lttv_apply_op_le_uint16(const gpointer v1, LttvFieldValue v2);
294gboolean lttv_apply_op_le_double(const gpointer v1, LttvFieldValue v2);
295gboolean lttv_apply_op_le_ltttime(const gpointer v1, LttvFieldValue v2);
296
297gboolean lttv_apply_op_gt_uint(const gpointer v1, LttvFieldValue v2);
298gboolean lttv_apply_op_gt_uint64(const gpointer v1, LttvFieldValue v2);
299gboolean lttv_apply_op_gt_uint32(const gpointer v1, LttvFieldValue v2);
300gboolean lttv_apply_op_gt_uint16(const gpointer v1, LttvFieldValue v2);
301gboolean lttv_apply_op_gt_double(const gpointer v1, LttvFieldValue v2);
302gboolean lttv_apply_op_gt_ltttime(const gpointer v1, LttvFieldValue v2);
303
304gboolean lttv_apply_op_ge_uint(const gpointer v1, LttvFieldValue v2);
305gboolean lttv_apply_op_ge_uint64(const gpointer v1, LttvFieldValue v2);
306gboolean lttv_apply_op_ge_uint32(const gpointer v1, LttvFieldValue v2);
307gboolean lttv_apply_op_ge_uint16(const gpointer v1, LttvFieldValue v2);
308gboolean lttv_apply_op_ge_double(const gpointer v1, LttvFieldValue v2);
309gboolean lttv_apply_op_ge_ltttime(const gpointer v1, LttvFieldValue v2);
310
311/*
312 * Cloning
313 */
314
315LttvFilterTree* lttv_filter_tree_clone(const LttvFilterTree* tree);
316
317LttvFilter* lttv_filter_clone(const LttvFilter* filter);
318
319/*
320 * LttvFilter
321 */
322LttvFilter *lttv_filter_new();
323
324gboolean lttv_filter_update(LttvFilter* filter);
325
326void lttv_filter_destroy(LttvFilter* filter);
327
328gboolean lttv_filter_append_expression(LttvFilter* filter, const char *expression);
329
330void lttv_filter_clear_expression(LttvFilter* filter);
331
332/*
333 * LttvFilterTree
334 */
335LttvFilterTree* lttv_filter_tree_new();
336
337void lttv_filter_tree_destroy(LttvFilterTree* tree);
338
339gboolean lttv_filter_tree_parse(
340 const LttvFilterTree* t,
341 const LttEvent* event,
342 const LttTracefile* tracefile,
343 const LttTrace* trace,
344 const LttvTracefileContext* context);
345
346gboolean lttv_filter_tree_parse_branch(
347 const LttvSimpleExpression* se,
348 const LttEvent* event,
349 const LttTracefile* tracefile,
350 const LttTrace* trace,
351 const LttvProcessState* state,
352 const LttvTracefileContext* context);
353
354/*
355 * Debug functions
356 */
357void lttv_print_tree(const LttvFilterTree* t, const int count);
358
359#endif // FILTER_H
360
LTTng 2.x Viewer (LTTV)
This page took 0.040993 seconds and 4 git commands to generate.