lttv/lttv/filter.h

   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/traceset-process.h>
  51 #include <lttv/state.h>
  52 #include <lttv/module.h>
  53
  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;
  65
  66 #ifndef LTTVFILTER_TYPE_DEFINED
  67 typedef struct _LttvFilter LttvFilter;
  68 #define LTTVFILTER_TYPE_DEFINED
  69 #endif
  70
  71 /**
  72  * @enum _LttvStructType
  73  * @brief The lttv structures
  74  *
  75  * the LttvStructType enumerates
  76  * the possible structures for the
  77  * lttv core filter
  78  */
  79 enum _LttvStructType {
  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) */
  85 };
  86
  87 /**
  88  * @enum _LttvFieldType
  89  * @brief Possible fields for the structures
  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 {
  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*) */
 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 */
 116 };
 117
 118 /**
 119  *   @enum _LttvExpressionOp
 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
 126  */
 127 enum _LttvExpressionOp
 128 {
 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 */
 135 };
 136
 137 /**
 138  *  @union _LttvFieldValue
 139  *  @brief Contains possible field values
 140  *
 141  *  This particular union defines the
 142  *  possible set of values taken by the
 143  *  right member of a simple expression.
 144  *  It is used for comparison whithin the
 145  *  'operators' functions
 146  */
 147 union _LttvFieldValue {
 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;
 159 };
 160
 161 /**
 162  * @enum _LttvTreeElement
 163  * @brief element types for the tree nodes
 164  *
 165  * LttvTreeElement defines the possible
 166  * types of nodes which build the LttvFilterTree.
 167  */
 168 enum _LttvTreeElement {
 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 */
 172 };
 173
 174
 175 /**
 176  * @struct _LttvSimpleExpression
 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  */
 187 struct _LttvSimpleExpression
 188 {
 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 */
 193 };
 194
 195 /**
 196  * @enum _LttvLogicalOp
 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  */
 204 enum _LttvLogicalOp {
 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) */
 209 };
 210
 211 /**
 212  *  @struct _LttvFilterTree
 213  *  @brief The filtering tree
 214  *
 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
 219  */
 220 struct _LttvFilterTree {
 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 */
 232 };
 233
 234 /**
 235  * @struct _LttvFilter
 236  * @brief The filter
 237  *
 238  * Contains a binary tree of filtering options along
 239  * with the expression itself.
 240  */
 241 struct _LttvFilter {
 242         char *expression;                 /**< filtering expression string */
 243         LttvFilterTree *head;             /**< tree associated to expression */
 244 };
 245
 246 /*
 247  * Simple Expression
 248  */
 249 LttvSimpleExpression* lttv_simple_expression_new();
 250
 251 gboolean lttv_simple_expression_assign_field(GPtrArray* fp,
 252                 LttvSimpleExpression* se);
 253
 254 gboolean lttv_simple_expression_assign_operator(LttvSimpleExpression* se,
 255                 LttvExpressionOp op);
 256
 257 gboolean lttv_simple_expression_assign_value(LttvSimpleExpression* se,
 258                 char* value);
 259
 260 void lttv_simple_expression_destroy(LttvSimpleExpression* se);
 261
 262
 263 /*
 264  * Logical operators functions
 265  */
 266
 267 gboolean lttv_apply_op_eq_uint(const gpointer v1, LttvFieldValue v2);
 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);
 273 gboolean lttv_apply_op_eq_quark(const gpointer v1, LttvFieldValue v2);
 274 gboolean lttv_apply_op_eq_quarks(const gpointer v1, LttvFieldValue v2);
 275 gboolean lttv_apply_op_eq_ltttime(const gpointer v1, LttvFieldValue v2);
 276
 277 gboolean lttv_apply_op_ne_uint(const gpointer v1, LttvFieldValue v2);
 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);
 283 gboolean lttv_apply_op_ne_quark(const gpointer v1, LttvFieldValue v2);
 284 gboolean lttv_apply_op_ne_quarks(const gpointer v1, LttvFieldValue v2);
 285 gboolean lttv_apply_op_ne_ltttime(const gpointer v1, LttvFieldValue v2);
 286
 287 gboolean lttv_apply_op_lt_uint(const gpointer v1, LttvFieldValue v2);
 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
 294 gboolean lttv_apply_op_le_uint(const gpointer v1, LttvFieldValue v2);
 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
 301 gboolean lttv_apply_op_gt_uint(const gpointer v1, LttvFieldValue v2);
 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
 308 gboolean lttv_apply_op_ge_uint(const gpointer v1, LttvFieldValue v2);
 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);
 314
 315 /*
 316  * Cloning
 317  */
 318
 319 LttvFilterTree* lttv_filter_tree_clone(const LttvFilterTree* tree);
 320
 321 LttvFilter* lttv_filter_clone(const LttvFilter* filter);
 322
 323 /*
 324  * LttvFilter
 325  */
 326 LttvFilter* lttv_filter_new();
 327
 328 gboolean lttv_filter_update(LttvFilter* filter);
 329
 330 void lttv_filter_destroy(LttvFilter* filter);
 331
 332 gboolean lttv_filter_append_expression(LttvFilter* filter,
 333                 const char *expression);
 334
 335 void lttv_filter_clear_expression(LttvFilter* filter);
 336
 337 /*
 338  * LttvFilterTree
 339  */
 340 LttvFilterTree* lttv_filter_tree_new();
 341
 342 void lttv_filter_tree_destroy(LttvFilterTree* tree);
 343 #ifdef BABEL_CLEANUP
 344 gboolean lttv_filter_tree_parse(
 345                 const LttvFilterTree* t,
 346                 const LttEvent* event,
 347                 const LttTracefile* tracefile,
 348                 const LttTrace* trace,
 349                 const LttvProcessState* pstate,
 350                 const LttvTrace* tracev);
 351
 352 gboolean lttv_filter_tree_parse_branch(
 353                 const LttvSimpleExpression* se,
 354                 const LttEvent* event,
 355                 const LttTracefile* tracefile,
 356                 const LttTrace* trace,
 357                 const LttvProcessState* state);
 358 #endif
 359 /*
 360  *  Debug functions
 361  */
 362 void lttv_print_tree(const LttvFilterTree* t, const int count);
 363
 364 #endif // FILTER_H
 365