create directories branches, tags, trunk
[lttv.git] / ltt / branches / poly / lttv / lttv / filter.h
index dbef886e35268694c4239c794f9dbe0132b6f9a1..49d97981576b0181bc75997934c1af183337d475 100644 (file)
@@ -1,5 +1,5 @@
 /* This file is part of the Linux Trace Toolkit viewer
- * Copyright (C) 2003-2004 Michel Dagenais
+ * Copyright (C) 2003-2005 Michel Dagenais and Simon Bouvier-Zappa
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License Version 2 as
 #ifndef FILTER_H
 #define FILTER_H
 
+/*! \file lttv/lttv/filter.h
+ *  \brief Defines the core filter of application 
+ *
+ *  A filter expression consists in nested AND, OR and NOT expressions
+ *  involving boolean relation (>, >=, =, !=, <, <=) between event fields and 
+ *  specific values. It is compiled into an efficient data structure which
+ *  is used in functions to check if a given event or tracefile satisfies the
+ *  filter.
+ * 
+ *  The grammar for filters is:
+ * 
+ *  filter = expression
+ * 
+ *  expression = "(" expression ")" | "!" expression | 
+ *              expression "&&" expression | expression "||" expression |
+ *              simpleExpression
+ *
+ *  simpleExpression = fieldPath op value
+ *
+ *  fieldPath = fieldComponent [ "." fieldPath ]
+ *
+ *  fieldComponent = name [ "[" integer "]" ]
+ *
+ *  value = integer | double | string 
+ */
+
+
 #include <lttv/traceset.h>
 #include <lttv/tracecontext.h>
 #include <lttv/state.h>
 #include <ltt/time.h>
 #include <ltt/event.h>
 
-
-/* 
-   A filter expression consists in nested AND, OR and NOT expressions
-   involving boolean relation (>, >=, =, !=, <, <=) between event fields and 
-   specific values. It is compiled into an efficient data structure which
-   is used in functions to check if a given event or tracefile satisfies the
-   filter.
-
-   The grammar for filters is:
-
-   filter = expression
-
-   expression = "(" expression ")" | "!" expression | 
-                expression "&&" expression | expression "||" expression |
-                simpleExpression
-
-   simpleExpression = fieldPath op value
-
-   fieldPath = fieldComponent [ "." fieldPath ]
-
-   fieldComponent = name [ "[" integer "]" ]
-
-   value = integer | double | string 
-*/
-
 /* structures prototypes */
 typedef enum _LttvStructType LttvStructType; 
 typedef enum _LttvFieldType LttvFieldType; 
@@ -63,11 +65,14 @@ typedef union _LttvFieldValue LttvFieldValue;
 
 typedef struct _LttvSimpleExpression LttvSimpleExpression;
 typedef struct _LttvFilterTree LttvFilterTree;
-typedef struct _LttvFilter LttvFilter;
 
+#ifndef LTTVFILTER_TYPE_DEFINED
+typedef struct _LttvFilter LttvFilter;
+#define LTTVFILTER_TYPE_DEFINED
+#endif
 
 /**
- * @enum LttvStructType
+ * @enum _LttvStructType
  * @brief The lttv structures
  *
  * the LttvStructType enumerates 
@@ -75,15 +80,15 @@ typedef struct _LttvFilter LttvFilter;
  * lttv core filter
  */
 enum _LttvStructType {
-  LTTV_FILTER_TRACE,
-  LTTV_FILTER_TRACESET,
-  LTTV_FILTER_TRACEFILE,
-  LTTV_FILTER_EVENT,
-  LTTV_FILTER_STATE
+  LTTV_FILTER_TRACE,                /**< trace (LttTrace) */
+  LTTV_FILTER_TRACESET,             /**< traceset */
+  LTTV_FILTER_TRACEFILE,            /**< tracefile (LttTracefile) */
+  LTTV_FILTER_EVENT,                /**< event (LttEvent) */
+  LTTV_FILTER_STATE                 /**< state (LttvProcessState) */
 };
 
 /**
- * @enum LttvFieldType
+ * @enum _LttvFieldType
  * @brief Possible fields for the structures
  *
  * the LttvFieldType enum consists on 
@@ -92,27 +97,29 @@ enum _LttvStructType {
  * filters can be applied.
  */
 enum _LttvFieldType {
-  LTTV_FILTER_TRACE_NAME,             /** trace.name (char*) */
-  LTTV_FILTER_TRACEFILE_NAME,         /** tracefile.name (char*) */
-  LTTV_FILTER_STATE_PID,              /** state.pid (guint) */
-  LTTV_FILTER_STATE_PPID,             /** state.ppid (guint) */
-  LTTV_FILTER_STATE_CT,               /** state.creation_time (double) */
-  LTTV_FILTER_STATE_IT,               /** state.insertion_time (double) */
-  LTTV_FILTER_STATE_P_NAME,           /** state.process_name (char*) */
-  LTTV_FILTER_STATE_EX_MODE,          /** state.execution_mode (LttvExecutionMode) */
-  LTTV_FILTER_STATE_EX_SUBMODE,       /** state.execution_submode (LttvExecutionSubmode) */
-  LTTV_FILTER_STATE_P_STATUS,         /** state.process_status (LttvProcessStatus) */
-  LTTV_FILTER_STATE_CPU,              /** state.cpu (?last_cpu?) */
-  LTTV_FILTER_EVENT_NAME,             /** event.name (char*) */
-  LTTV_FILTER_EVENT_CATEGORY,         /** FIXME: not implemented */
-  LTTV_FILTER_EVENT_TIME,             /** event.time (double) */
-  LTTV_FILTER_EVENT_TSC,              /** event.tsc (double) */
-  LTTV_FILTER_EVENT_FIELD,           
-  LTTV_FILTER_UNDEFINED               /** undefined field */
+  LTTV_FILTER_TRACE_NAME,             /**< trace.name (char*) */
+  LTTV_FILTER_TRACEFILE_NAME,         /**< tracefile.name (char*) */
+  LTTV_FILTER_STATE_PID,              /**< state.pid (guint) */
+  LTTV_FILTER_STATE_PPID,             /**< state.ppid (guint) */
+  LTTV_FILTER_STATE_CT,               /**< state.creation_time (double) */
+  LTTV_FILTER_STATE_IT,               /**< state.insertion_time (double) */
+  LTTV_FILTER_STATE_P_NAME,           /**< state.process_name (char*) */
+  LTTV_FILTER_STATE_T_BRAND,          /**< state.thread_brand (char*) */
+  LTTV_FILTER_STATE_EX_MODE,          /**< state.execution_mode (LttvExecutionMode) */
+  LTTV_FILTER_STATE_EX_SUBMODE,       /**< state.execution_submode (LttvExecutionSubmode) */
+  LTTV_FILTER_STATE_P_STATUS,         /**< state.process_status (LttvProcessStatus) */
+  LTTV_FILTER_STATE_CPU,              /**< state.cpu (?last_cpu?) */
+  LTTV_FILTER_EVENT_NAME,             /**< event.name (char*) */
+  LTTV_FILTER_EVENT_CATEGORY,         /**< FIXME: not implemented */
+  LTTV_FILTER_EVENT_TIME,             /**< event.time (double) */
+  LTTV_FILTER_EVENT_TSC,              /**< event.tsc (double) */
+  LTTV_FILTER_EVENT_TARGET_PID,       /**< event.target_pid (guint) */
+  LTTV_FILTER_EVENT_FIELD,            /**< dynamic field, specified in facility */
+  LTTV_FILTER_UNDEFINED               /**< undefined field */
 };
   
 /**
- *     @enum LttvExpressionOp
+ *   @enum _LttvExpressionOp
  *  @brief Contains possible operators
  *
  *  This enumeration defines the 
@@ -122,18 +129,18 @@ enum _LttvFieldType {
  */
 enum _LttvExpressionOp
 { 
-  LTTV_FIELD_EQ,                           /** equal */
-  LTTV_FIELD_NE,                           /** not equal */
-  LTTV_FIELD_LT,                           /** lower than */
-  LTTV_FIELD_LE,                           /** lower or equal */
-  LTTV_FIELD_GT,                           /** greater than */
-  LTTV_FIELD_GE                                    /** greater or equal */
+  LTTV_FIELD_EQ,                      /**< equal */
+  LTTV_FIELD_NE,                      /**< not equal */
+  LTTV_FIELD_LT,                      /**< lower than */
+  LTTV_FIELD_LE,                      /**< lower or equal */
+  LTTV_FIELD_GT,                      /**< greater than */
+  LTTV_FIELD_GE                        /**< greater or equal */
 };
 
 /**
- *  @union LttvFieldValue
- *
+ *  @union _LttvFieldValue
  *  @brief Contains possible field values
+ *
  *  This particular union defines the 
  *  possible set of values taken by the 
  *  right member of a simple expression.  
@@ -141,30 +148,32 @@ enum _LttvExpressionOp
  *  'operators' functions
  */
 union _LttvFieldValue {
-  guint64 v_uint64;
-  guint32 v_uint32;
-  guint16 v_uint16;
-  double v_double;
-  char* v_string;
-  LttTime v_ltttime;
+  GQuark  v_quark;                    /**< GQuark */
+  guint64 v_uint64;                   /**< unsigned int of 64 bytes */
+  guint32 v_uint32;                   /**< unsigned int of 32 bytes */
+  guint16 v_uint16;                   /**< unsigned int of 16 bytes */
+  guint16 v_uint;                     /**< unsigned int */
+  double v_double;                    /**< double */
+  char* v_string;                     /**< string */
+  LttTime v_ltttime;                  /**< LttTime */
 };
 
 /**
- * @enum LttvTreeElement
+ * @enum _LttvTreeElement
  * @brief element types for the tree nodes
  *
  * LttvTreeElement defines the possible 
  * types of nodes which build the LttvFilterTree.  
  */
 enum _LttvTreeElement {
-  LTTV_TREE_IDLE,                     /** this node does nothing */
-  LTTV_TREE_NODE,                     /** this node contains a logical operator */
-  LTTV_TREE_LEAF                      /** this node is a leaf and contains a simple expression */
+  LTTV_TREE_IDLE,                     /**< this node does nothing */
+  LTTV_TREE_NODE,                     /**< this node contains a logical operator */
+  LTTV_TREE_LEAF                      /**< this node is a leaf and contains a simple expression */
 };
 
 
 /**
- * @struct LttvSimpleExpression
+ * @struct _LttvSimpleExpression
  * @brief simple expression structure
  *
  * An LttvSimpleExpression is the base 
@@ -177,15 +186,14 @@ enum _LttvTreeElement {
  */
 struct _LttvSimpleExpression
 { 
-  gint field;                               /** left member of simple expression */                  
-  gint offset;                              /** offset used for dynamic fields */
-  gboolean (*op)(gpointer,LttvFieldValue);  /** operator of simple expression */
-//  char *value;                           
-  LttvFieldValue value;                     /** right member of simple expression */
+  gint field;                               /**< left member of simple expression */                  
+  gint offset;                              /**< offset used for dynamic fields */
+  gboolean (*op)(gpointer,LttvFieldValue);  /**< operator of simple expression */
+  LttvFieldValue value;                     /**< right member of simple expression */
 };
 
 /**
- * @enum LttvLogicalOp
+ * @enum _LttvLogicalOp
  * @brief logical operators
  * 
  * Contains the possible values taken 
@@ -194,55 +202,53 @@ struct _LttvSimpleExpression
  * AND, OR, XOR or NOT
  */
 enum _LttvLogicalOp {
-    LTTV_LOGICAL_OR = 1,              /** OR (1) */
-    LTTV_LOGICAL_AND = 1<<1,          /** AND (2) */
-    LTTV_LOGICAL_NOT = 1<<2,          /** NOT (4) */
-    LTTV_LOGICAL_XOR = 1<<3           /** XOR (8) */
+    LTTV_LOGICAL_OR = 1,              /**< OR (1) */
+    LTTV_LOGICAL_AND = 1<<1,          /**< AND (2) */
+    LTTV_LOGICAL_NOT = 1<<2,          /**< NOT (4) */
+    LTTV_LOGICAL_XOR = 1<<3           /**< XOR (8) */
 };
     
 /**
- *  @struct LttvFilterTree
+ *  @struct _LttvFilterTree
+ *  @brief The filtering tree
+ *  
  *  The filtering tree is used to represent the 
  *  expression string in its entire hierarchy 
  *  composed of simple expressions and logical 
  *  operators
  */
 struct _LttvFilterTree {
-  int node;                         /** value of LttvLogicalOp */
-  LttvTreeElement left;
-  LttvTreeElement right;
+  int node;                         /**< value of LttvLogicalOp */
+  LttvTreeElement left;             /**< nature of left branch (node/leaf) */
+  LttvTreeElement right;            /**< nature of right branch (node/leaf) */
   union {
-    LttvFilterTree* t;
-    LttvSimpleExpression* leaf;
-  } l_child;
+    LttvFilterTree* t;              
+    LttvSimpleExpression* leaf;     
+  } l_child;                        /**< left branch of tree */
   union {
-    LttvFilterTree* t;
-    LttvSimpleExpression* leaf;
-  } r_child;
+    LttvFilterTree* t;              
+    LttvSimpleExpression* leaf;     
+  } r_child;                        /**< right branch of tree */
 };
 
 /**
- * @struct lttv_filter
+ * @struct _LttvFilter
+ * @brief The filter
+ * 
  * Contains a binary tree of filtering options along 
  * with the expression itself.
  */
 struct _LttvFilter {
-  char *expression;
-  LttvFilterTree *head;
+  char *expression;                 /**< filtering expression string */
+  LttvFilterTree *head;             /**< tree associated to expression */
 };
 
-/*
- * General Data Handling functions
- */
-
-void lttv_filter_tree_add_node(GPtrArray* stack, LttvFilterTree* subtree, LttvLogicalOp op);
-
 /*
  * Simple Expression
  */
 LttvSimpleExpression* lttv_simple_expression_new();
 
-gboolean lttv_simple_expression_add_field(GPtrArray* fp, LttvSimpleExpression* se);
+gboolean lttv_simple_expression_assign_field(GPtrArray* fp, LttvSimpleExpression* se);
 
 gboolean lttv_simple_expression_assign_operator(LttvSimpleExpression* se, LttvExpressionOp op);
 
@@ -255,51 +261,59 @@ void lttv_simple_expression_destroy(LttvSimpleExpression* se);
  * Logical operators functions
  */
 
-gboolean lttv_apply_op_eq_uint64(gpointer v1, LttvFieldValue v2);
-gboolean lttv_apply_op_eq_uint32(gpointer v1, LttvFieldValue v2);
-gboolean lttv_apply_op_eq_uint16(gpointer v1, LttvFieldValue v2);
-gboolean lttv_apply_op_eq_double(gpointer v1, LttvFieldValue v2);
-gboolean lttv_apply_op_eq_string(gpointer v1, LttvFieldValue v2);
-gboolean lttv_apply_op_eq_ltttime(gpointer v1, LttvFieldValue v2);
-
-gboolean lttv_apply_op_ne_uint64(gpointer v1, LttvFieldValue v2);
-gboolean lttv_apply_op_ne_uint32(gpointer v1, LttvFieldValue v2);
-gboolean lttv_apply_op_ne_uint16(gpointer v1, LttvFieldValue v2);
-gboolean lttv_apply_op_ne_double(gpointer v1, LttvFieldValue v2);
-gboolean lttv_apply_op_ne_string(gpointer v1, LttvFieldValue v2);
-gboolean lttv_apply_op_ne_ltttime(gpointer v1, LttvFieldValue v2);
-
-gboolean lttv_apply_op_lt_uint64(gpointer v1, LttvFieldValue v2);
-gboolean lttv_apply_op_lt_uint32(gpointer v1, LttvFieldValue v2);
-gboolean lttv_apply_op_lt_uint16(gpointer v1, LttvFieldValue v2);
-gboolean lttv_apply_op_lt_double(gpointer v1, LttvFieldValue v2);
-gboolean lttv_apply_op_lt_ltttime(gpointer v1, LttvFieldValue v2);
-
-gboolean lttv_apply_op_le_uint64(gpointer v1, LttvFieldValue v2);
-gboolean lttv_apply_op_le_uint32(gpointer v1, LttvFieldValue v2);
-gboolean lttv_apply_op_le_uint16(gpointer v1, LttvFieldValue v2);
-gboolean lttv_apply_op_le_double(gpointer v1, LttvFieldValue v2);
-gboolean lttv_apply_op_le_ltttime(gpointer v1, LttvFieldValue v2);
-
-gboolean lttv_apply_op_gt_uint64(gpointer v1, LttvFieldValue v2);
-gboolean lttv_apply_op_gt_uint32(gpointer v1, LttvFieldValue v2);
-gboolean lttv_apply_op_gt_uint16(gpointer v1, LttvFieldValue v2);
-gboolean lttv_apply_op_gt_double(gpointer v1, LttvFieldValue v2);
-gboolean lttv_apply_op_gt_ltttime(gpointer v1, LttvFieldValue v2);
-
-gboolean lttv_apply_op_ge_uint64(gpointer v1, LttvFieldValue v2);
-gboolean lttv_apply_op_ge_uint32(gpointer v1, LttvFieldValue v2);
-gboolean lttv_apply_op_ge_uint16(gpointer v1, LttvFieldValue v2);
-gboolean lttv_apply_op_ge_double(gpointer v1, LttvFieldValue v2);
-gboolean lttv_apply_op_ge_ltttime(gpointer v1, LttvFieldValue v2);
+gboolean lttv_apply_op_eq_uint(const gpointer v1, LttvFieldValue v2);
+gboolean lttv_apply_op_eq_uint64(const gpointer v1, LttvFieldValue v2);
+gboolean lttv_apply_op_eq_uint32(const gpointer v1, LttvFieldValue v2);
+gboolean lttv_apply_op_eq_uint16(const gpointer v1, LttvFieldValue v2);
+gboolean lttv_apply_op_eq_double(const gpointer v1, LttvFieldValue v2);
+gboolean lttv_apply_op_eq_string(const gpointer v1, LttvFieldValue v2);
+gboolean lttv_apply_op_eq_quark(const gpointer v1, LttvFieldValue v2);
+gboolean lttv_apply_op_eq_ltttime(const gpointer v1, LttvFieldValue v2);
+
+gboolean lttv_apply_op_ne_uint(const gpointer v1, LttvFieldValue v2);
+gboolean lttv_apply_op_ne_uint64(const gpointer v1, LttvFieldValue v2);
+gboolean lttv_apply_op_ne_uint32(const gpointer v1, LttvFieldValue v2);
+gboolean lttv_apply_op_ne_uint16(const gpointer v1, LttvFieldValue v2);
+gboolean lttv_apply_op_ne_double(const gpointer v1, LttvFieldValue v2);
+gboolean lttv_apply_op_ne_string(const gpointer v1, LttvFieldValue v2);
+gboolean lttv_apply_op_ne_quark(const gpointer v1, LttvFieldValue v2);
+gboolean lttv_apply_op_ne_ltttime(const gpointer v1, LttvFieldValue v2);
+
+gboolean lttv_apply_op_lt_uint(const gpointer v1, LttvFieldValue v2);
+gboolean lttv_apply_op_lt_uint64(const gpointer v1, LttvFieldValue v2);
+gboolean lttv_apply_op_lt_uint32(const gpointer v1, LttvFieldValue v2);
+gboolean lttv_apply_op_lt_uint16(const gpointer v1, LttvFieldValue v2);
+gboolean lttv_apply_op_lt_double(const gpointer v1, LttvFieldValue v2);
+gboolean lttv_apply_op_lt_ltttime(const gpointer v1, LttvFieldValue v2);
+
+gboolean lttv_apply_op_le_uint(const gpointer v1, LttvFieldValue v2);
+gboolean lttv_apply_op_le_uint64(const gpointer v1, LttvFieldValue v2);
+gboolean lttv_apply_op_le_uint32(const gpointer v1, LttvFieldValue v2);
+gboolean lttv_apply_op_le_uint16(const gpointer v1, LttvFieldValue v2);
+gboolean lttv_apply_op_le_double(const gpointer v1, LttvFieldValue v2);
+gboolean lttv_apply_op_le_ltttime(const gpointer v1, LttvFieldValue v2);
+
+gboolean lttv_apply_op_gt_uint(const gpointer v1, LttvFieldValue v2);
+gboolean lttv_apply_op_gt_uint64(const gpointer v1, LttvFieldValue v2);
+gboolean lttv_apply_op_gt_uint32(const gpointer v1, LttvFieldValue v2);
+gboolean lttv_apply_op_gt_uint16(const gpointer v1, LttvFieldValue v2);
+gboolean lttv_apply_op_gt_double(const gpointer v1, LttvFieldValue v2);
+gboolean lttv_apply_op_gt_ltttime(const gpointer v1, LttvFieldValue v2);
+
+gboolean lttv_apply_op_ge_uint(const gpointer v1, LttvFieldValue v2);
+gboolean lttv_apply_op_ge_uint64(const gpointer v1, LttvFieldValue v2);
+gboolean lttv_apply_op_ge_uint32(const gpointer v1, LttvFieldValue v2);
+gboolean lttv_apply_op_ge_uint16(const gpointer v1, LttvFieldValue v2);
+gboolean lttv_apply_op_ge_double(const gpointer v1, LttvFieldValue v2);
+gboolean lttv_apply_op_ge_ltttime(const gpointer v1, LttvFieldValue v2);
 
 /*
  * Cloning
  */
 
-LttvFilterTree* lttv_filter_tree_clone(LttvFilterTree* tree);
+LttvFilterTree* lttv_filter_tree_clone(const LttvFilterTree* tree);
 
-LttvFilter* lttv_filter_clone(LttvFilter* filter);
+LttvFilter* lttv_filter_clone(const LttvFilter* filter);
 
 /* 
  * LttvFilter 
@@ -310,7 +324,7 @@ gboolean lttv_filter_update(LttvFilter* filter);
 
 void lttv_filter_destroy(LttvFilter* filter);
 
-gboolean lttv_filter_append_expression(LttvFilter* filter, char *expression);
+gboolean lttv_filter_append_expression(LttvFilter* filter, const char *expression);
 
 void lttv_filter_clear_expression(LttvFilter* filter);
 
@@ -322,33 +336,26 @@ LttvFilterTree* lttv_filter_tree_new();
 void lttv_filter_tree_destroy(LttvFilterTree* tree);
 
 gboolean lttv_filter_tree_parse(
-        LttvFilterTree* t,
-        LttEvent* event,
-        LttTracefile* tracefile,
-        LttTrace* trace,
-        LttvProcessState* state,
-        LttvTracefileContext* context);
-
-/*
- *  Hook functions
- *  
- *  These hook functions will be the one called when filtering 
- *  an event, a trace, a state, etc.
- */
-
-/* Check if the tracefile or event satisfies the filter. The arguments are
-   declared as void * to allow these functions to be used as hooks. */
-
-gboolean lttv_filter_tracefile(LttvFilter *filter, LttTracefile *tracefile);
-
-gboolean lttv_filter_tracestate(LttvFilter *filter, LttvTraceState *tracestate);
-
-gboolean lttv_filter_event(LttvFilter *filter, LttEvent *event);
+        const LttvFilterTree* t,
+        const LttEvent* event,
+        const LttTracefile* tracefile,
+        const LttTrace* trace,
+        const LttvTracefileContext* context,
+       const LttvProcessState* pstate,
+       const LttvTraceContext* tc);
+
+gboolean lttv_filter_tree_parse_branch(
+        const LttvSimpleExpression* se,
+        const LttEvent* event,
+        const LttTracefile* tracefile,
+        const LttTrace* trace,
+        const LttvProcessState* state,
+        const LttvTracefileContext* context);
 
 /*
  *  Debug functions
  */
-void lttv_print_tree(LttvFilterTree* t);
+void lttv_print_tree(const LttvFilterTree* t, const int count);
 
 #endif // FILTER_H
 
This page took 0.028539 seconds and 4 git commands to generate.