filter core:
[lttv.git] / ltt / branches / poly / lttv / lttv / filter.h
index a7b9ee53d78466a3b941eef04cb6652c4f7497ee..827974ccd4ac8f58118cd106c665238325273245 100644 (file)
@@ -27,7 +27,8 @@
 #include <ltt/event.h>
 
 
-/* A filter expression consists in nested AND, OR and NOT expressions
+/* 
+   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
    fieldComponent = name [ "[" integer "]" ]
 
    value = integer | double | string 
-
 */
 
+/**
+ * @enum LttvStructType
+ * @brief The lttv structures
+ *
+ * the LttvStructType enumerates 
+ * the possible structures for the 
+ * lttv core filter
+ */
+enum _LttvStructType {
+  LTTV_FILTER_TRACE,
+  LTTV_FILTER_TRACESET,
+  LTTV_FILTER_TRACEFILE,
+  LTTV_FILTER_EVENT,
+  LTTV_FILTER_STATE
+} LttvStructType;
+
 /**
  * @enum LttvFieldType
- * @brief Structures and their fields
+ * @brief Possible fields for the structures
  *
  * the LttvFieldType enum consists on 
  * all the hardcoded structures and 
  * filters can be applied.
  */
 enum _LttvFieldType {
-  LTTV_FILTER_TRACE,
-  LTTV_FILTER_TRACESET,
-  LTTV_FILTER_TRACEFILE,
-  LTTV_FILTER_STATE,
-  LTTV_FILTER_EVENT,
-  LTTV_FILTER_NAME,
-  LTTV_FILTER_CATEGORY,
-  LTTV_FILTER_TIME,
-  LTTV_FILTER_TSC,
-  LTTV_FILTER_PID,
-  LTTV_FILTER_PPID,
-  LTTV_FILTER_C_TIME,
-  LTTV_FILTER_I_TIME,
-  LTTV_FILTER_P_NAME,
-  LTTV_FILTER_EX_MODE,
-  LTTV_FILTER_EX_SUBMODE,
-  LTTV_FILTER_P_STATUS,
-  LTTV_FILTER_CPU
+  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 */
 } LttvFieldType;
   
 /**
  *     @enum LttvExpressionOp
+ *  @brief Contains possible operators
+ *
+ *  This enumeration defines the 
+ *  possible operator used to compare 
+ *  right and left member in simple 
+ *  expression
  */
 typedef 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 */
 } LttvExpressionOp;
 
+/**
+ *  @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.  
+ *  It is used for comparison whithin the 
+ *  'operators' functions
+ */
+typedef union _LttvFieldValue {
+  guint64 v_uint64;
+  guint32 v_uint32;
+  guint16 v_uint16;
+  double v_double;
+  char* v_string;
+} LttvFieldValue;
+
 /**
  * @enum LttvTreeElement
  * @brief element types for the tree nodes
@@ -102,11 +141,12 @@ typedef enum _LttvExpressionOp
  * types of nodes which build the LttvFilterTree.  
  */
 typedef 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 */
 } LttvTreeElement;
 
+
 /**
  * @enum LttvSimpleExpression
  * @brief simple expression structure
@@ -121,10 +161,11 @@ typedef enum _LttvTreeElement {
  */
 typedef struct _LttvSimpleExpression
 { 
-  char *field_name;
-//  LttvExpressionOp op;
-  gboolean (*op)();
-  char *value;
+  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 */
 } LttvSimpleExpression;
 
 /**
@@ -137,10 +178,10 @@ typedef struct _LttvSimpleExpression
  * AND, OR, XOR or NOT
  */
 typedef enum _LttvLogicalOp {
-    LTTV_LOGICAL_OR = 1,         /* 1 */
-    LTTV_LOGICAL_AND = 1<<1,     /* 2 */
-    LTTV_LOGICAL_NOT = 1<<2,     /* 4 */
-    LTTV_LOGICAL_XOR = 1<<3      /* 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) */
 } LttvLogicalOp;
     
 /**
@@ -155,11 +196,11 @@ typedef struct _LttvFilterTree {
   LttvTreeElement left;
   LttvTreeElement right;
   union {
-    struct LttvFilter* t;
+    struct LttvFilterTree* t;
     LttvSimpleExpression* leaf;
   } l_child;
   union {
-    struct LttvFilter* t;
+    struct LttvFilterTree* t;
     LttvSimpleExpression* leaf;
   } r_child;
 } LttvFilterTree;
@@ -178,49 +219,57 @@ typedef struct _LttvFilter {
  * General Data Handling functions
  */
 
+void lttv_filter_tree_add_node(GPtrArray* stack, LttvFilterTree* subtree, LttvLogicalOp op);
+
+/*
+ * Simple Expression
+ */
 LttvSimpleExpression* lttv_simple_expression_new();
 
-void lttv_filter_tree_add_node(GPtrArray* stack, LttvFilterTree* subtree, LttvLogicalOp op);
+gboolean lttv_simple_expression_add_field(GPtrArray* fp, LttvSimpleExpression* se);
+
+gboolean lttv_simple_expression_assign_operator(LttvSimpleExpression* se, LttvExpressionOp op);
+
+gboolean lttv_simple_expression_assign_value(LttvSimpleExpression* se, char* value);
 
-gboolean parse_field_path(GPtrArray* fp);
+void lttv_simple_expression_destroy(LttvSimpleExpression* se);
 
-gboolean parse_simple_expression(GString* expression);
 
 /*
  * Logical operators functions
  */
 
-gboolean lttv_apply_op_eq_uint64();
-gboolean lttv_apply_op_eq_uint32();
-gboolean lttv_apply_op_eq_uint16();
-gboolean lttv_apply_op_eq_double();
-gboolean lttv_apply_op_eq_string();
-
-gboolean lttv_apply_op_ne_uint64();
-gboolean lttv_apply_op_ne_uint32();
-gboolean lttv_apply_op_ne_uint16();
-gboolean lttv_apply_op_ne_double();
-gboolean lttv_apply_op_ne_string();
-
-gboolean lttv_apply_op_lt_uint64();
-gboolean lttv_apply_op_lt_uint32();
-gboolean lttv_apply_op_lt_uint16();
-gboolean lttv_apply_op_lt_double();
-
-gboolean lttv_apply_op_le_uint64();
-gboolean lttv_apply_op_le_uint32();
-gboolean lttv_apply_op_le_uint16();
-gboolean lttv_apply_op_le_double();
-
-gboolean lttv_apply_op_gt_uint64();
-gboolean lttv_apply_op_gt_uint32();
-gboolean lttv_apply_op_gt_uint16();
-gboolean lttv_apply_op_gt_double();
-
-gboolean lttv_apply_op_ge_uint64();
-gboolean lttv_apply_op_ge_uint32();
-gboolean lttv_apply_op_ge_uint16();
-gboolean lttv_apply_op_ge_double();
+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_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_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_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_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_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);
 
 /*
  * Cloning
@@ -230,20 +279,32 @@ LttvFilterTree* lttv_filter_tree_clone(LttvFilterTree* tree);
 
 LttvFilter* lttv_filter_clone(LttvFilter* filter);
 
-/*
- * Constructors/Destructors
+/* 
+ * LttvFilter 
  */
+LttvFilter *lttv_filter_new();
 
-/* LttvFilter */
-LttvFilter *lttv_filter_new(char *expression, LttvTraceState *tfs);
+gboolean lttv_filter_update(LttvFilter* filter);
 
 void lttv_filter_destroy(LttvFilter* filter);
 
-/* LttvFilterTree */
+gboolean lttv_filter_append_expression(LttvFilter* filter, char *expression);
+
+void lttv_filter_clear_expression(LttvFilter* filter);
+
+/*
+ * LttvFilterTree 
+ */
 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);
 
 /*
  *  Hook functions
@@ -261,5 +322,10 @@ gboolean lttv_filter_tracestate(LttvFilter *filter, LttvTraceState *tracestate);
 
 gboolean lttv_filter_event(LttvFilter *filter, LttEvent *event);
 
+/*
+ *  Debug functions
+ */
+void lttv_print_tree(LttvFilterTree* t);
+
 #endif // FILTER_H
 
This page took 0.026388 seconds and 4 git commands to generate.