filter core:
[lttv.git] / ltt / branches / poly / lttv / lttv / filter.h
index 8a01769019d5067b7781f3eb82da84850eb58ffc..131a585dc01cd751a4a96dab4eb36539641cd1e2 100644 (file)
@@ -26,8 +26,6 @@
 #include <ltt/ltt.h>
 #include <ltt/event.h>
 
-#define AVERAGE_EXPRESSION_LENGTH 6
-#define MAX_FACTOR 1.5
 
 /* A filter expression consists in nested AND, OR and NOT expressions
    involving boolean relation (>, >=, =, !=, <, <=) between event fields and 
 
 */
 
-extern GQuark
+/**
+ * @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_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_STATE
+} LttvStructType;
+
+/**
+ * @enum LttvFieldType
+ * @brief Possible fields for the structures
+ *
+ * the LttvFieldType enum consists on 
+ * all the hardcoded structures and 
+ * their appropriate fields on which 
+ * 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
+//  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
+} LttvFieldType;
   
 /**
- *     @enum lttv_expression_op
+ *     @enum LttvExpressionOp
  */
 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;
 
-/*
- * FIXME: Unused enum ?
+/**
+ * @enum LttvTreeElement
+ * @brief element types for the tree nodes
+ *
+ * LttvTreeElement defines the possible 
+ * types of nodes which build the LttvFilterTree.  
  */
-typedef enum _LttvExpressionType
-{ 
-  LTTV_EXPRESSION,
-  LTTV_SIMPLE_EXPRESSION,
-  LTTV_EXPRESSION_OP,
-  LTTV_UNDEFINED_EXPRESSION
-} LttvExpressionType;
-
 typedef enum _LttvTreeElement {
-  LTTV_TREE_IDLE,
-  LTTV_TREE_NODE,
-  LTTV_TREE_LEAF
+  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
+ *
+ * An LttvSimpleExpression is the base 
+ * of all filtering operations.  It also 
+ * populates the leaves of the
+ * LttvFilterTree.  Each expression 
+ * consists basically in a structure 
+ * field, an operator and a specific 
+ * value.
+ */
 typedef struct _LttvSimpleExpression
 { 
-  char *field_name;
-  LttvExpressionOp op;
+//  char *field_name;
+  gint field;
+  gint offset;
+//  LttvExpressionOp op;
+  gboolean (*op)(gpointer,char*);
   char *value;
 } LttvSimpleExpression;
 
+/**
+ * @enum LttvLogicalOp
+ * @brief logical operators
+ * 
+ * Contains the possible values taken 
+ * by logical operator used to link 
+ * simple expression.  Values are 
+ * AND, OR, XOR or NOT
+ */
 typedef enum _LttvLogicalOp {
     LTTV_LOGICAL_OR = 1,         /* 1 */
     LTTV_LOGICAL_AND = 1<<1,     /* 2 */
@@ -117,33 +172,14 @@ typedef enum _LttvLogicalOp {
     LTTV_LOGICAL_XOR = 1<<3      /* 8 */
 } LttvLogicalOp;
     
-/*
- * Ah .. that's my tree
- */
-//typedef struct _lttv_expression 
-//{ 
-//  gboolean simple_expression;
-//  int op;
-//  lttv_expression_type type;
-//  union {
-//    struct lttv_expression *e;
- //   lttv_field_relation *se;  /* --> simple expression */
-//  } e;
-//} lttv_expression;
-
-/*
- * FIXME: Unused struct
+/**
+ *  @struct LttvFilterTree
+ *  The filtering tree is used to represent the 
+ *  expression string in its entire hierarchy 
+ *  composed of simple expressions and logical 
+ *  operators
  */
-typedef struct _LttvExpression {
-  LttvExpressionType type;
-  union {
-    LttvSimpleExpression *se;
-    int op;
-  } e;
-} LttvExpression;
-
-typedef struct _LttvFilter {
-//     lttv_expression* node;
+typedef struct _LttvFilterTree {
   int node;                         /** value of LttvLogicalOp */
   LttvTreeElement left;
   LttvTreeElement right;
@@ -155,37 +191,110 @@ typedef struct _LttvFilter {
     struct LttvFilter* t;
     LttvSimpleExpression* leaf;
   } r_child;
-} LttvFilter;
+} LttvFilterTree;
 
 /**
  * @struct lttv_filter
- * ( will later contain a binary tree of filtering options )
+ * Contains a binary tree of filtering options along 
+ * with the expression itself.
  */
-//typedef struct _lttv_filter_t {
-//     lttv_filter_tree* tree; 
-//} lttv_filter_t;
+typedef struct _LttvFilter {
+  char *expression;
+  LttvFilterTree *head;
+} LttvFilter;
 
+/*
+ * General Data Handling functions
+ */
 
 LttvSimpleExpression* lttv_simple_expression_new();
 
-LttvFilter* lttv_filter_tree_new();
+void lttv_filter_tree_add_node(GPtrArray* stack, LttvFilterTree* subtree, LttvLogicalOp op);
+
+gboolean parse_field_path(GPtrArray* fp, LttvSimpleExpression* se);
+
+gboolean assign_operator(LttvSimpleExpression* se, LttvExpressionOp op);
+
+
 
-void lttv_filter_tree_destroy(LttvFilter* tree);
+/*
+ * Logical operators functions
+ */
+
+gboolean lttv_apply_op_eq_uint64(gpointer v1, char* v2);
+gboolean lttv_apply_op_eq_uint32(gpointer v1, char* v2);
+gboolean lttv_apply_op_eq_uint16(gpointer v1, char* v2);
+gboolean lttv_apply_op_eq_double(gpointer v1, char* v2);
+gboolean lttv_apply_op_eq_string(gpointer v1, char* v2);
+
+gboolean lttv_apply_op_ne_uint64(gpointer v1, char* v2);
+gboolean lttv_apply_op_ne_uint32(gpointer v1, char* v2);
+gboolean lttv_apply_op_ne_uint16(gpointer v1, char* v2);
+gboolean lttv_apply_op_ne_double(gpointer v1, char* v2);
+gboolean lttv_apply_op_ne_string(gpointer v1, char* v2);
+
+gboolean lttv_apply_op_lt_uint64(gpointer v1, char* v2);
+gboolean lttv_apply_op_lt_uint32(gpointer v1, char* v2);
+gboolean lttv_apply_op_lt_uint16(gpointer v1, char* v2);
+gboolean lttv_apply_op_lt_double(gpointer v1, char* v2);
+
+gboolean lttv_apply_op_le_uint64(gpointer v1, char* v2);
+gboolean lttv_apply_op_le_uint32(gpointer v1, char* v2);
+gboolean lttv_apply_op_le_uint16(gpointer v1, char* v2);
+gboolean lttv_apply_op_le_double(gpointer v1, char* v2);
+
+gboolean lttv_apply_op_gt_uint64(gpointer v1, char* v2);
+gboolean lttv_apply_op_gt_uint32(gpointer v1, char* v2);
+gboolean lttv_apply_op_gt_uint16(gpointer v1, char* v2);
+gboolean lttv_apply_op_gt_double(gpointer v1, char* v2);
+
+gboolean lttv_apply_op_ge_uint64(gpointer v1, char* v2);
+gboolean lttv_apply_op_ge_uint32(gpointer v1, char* v2);
+gboolean lttv_apply_op_ge_uint16(gpointer v1, char* v2);
+gboolean lttv_apply_op_ge_double(gpointer v1, char* v2);
+
+/*
+ * Cloning
+ */
 
-LttvFilter* lttv_filter_clone(LttvFilter* tree);
+LttvFilterTree* lttv_filter_tree_clone(LttvFilterTree* tree);
 
-void lttv_filter_tree_add_node(GPtrArray* stack, LttvFilter* subtree, LttvLogicalOp op);
+LttvFilter* lttv_filter_clone(LttvFilter* filter);
 
-/* Parse field path contained in list */
-gboolean parse_field_path(GPtrArray* fp);
+/*
+ * Constructors/Destructors
+ */
 
-gboolean parse_simple_expression(GString* expression);
+/* LttvFilter */
+LttvFilter *lttv_filter_new();
 
-/* Compile the filter expression into an efficient data structure */
-LttvFilter *lttv_filter_new(char *expression, LttvTraceState *tfs);
+gboolean lttv_filter_update(LttvFilter* filter);
 
 void lttv_filter_destroy(LttvFilter* filter);
 
+void 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
+ *  
+ *  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. */
 
@@ -195,5 +304,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.042594 seconds and 4 git commands to generate.