X-Git-Url: http://git.lttng.org./?a=blobdiff_plain;ds=sidebyside;f=ltt%2Fbranches%2Fpoly%2Flttv%2Flttv%2Ffilter.h;h=162577fc41b43a5d876d25384d59460534492432;hb=4d9ff9421ad51cef878f7a2e70faacf96001768e;hp=a108fa8bccb90af45e622400c93a130f73f2b066;hpb=1da1525dc4a987ee97bd025f96d2ee75804d2012;p=lttv.git diff --git a/ltt/branches/poly/lttv/lttv/filter.h b/ltt/branches/poly/lttv/lttv/filter.h index a108fa8b..162577fc 100644 --- a/ltt/branches/poly/lttv/lttv/filter.h +++ b/ltt/branches/poly/lttv/lttv/filter.h @@ -24,12 +24,12 @@ #include #include #include +#include #include -#define AVERAGE_EXPRESSION_LENGTH 6 -#define MAX_FACTOR 1.5 -/* 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 @@ -50,142 +50,291 @@ fieldComponent = name [ "[" integer "]" ] value = integer | double | string - */ -extern GQuark +/* structures prototypes */ +typedef enum _LttvStructType LttvStructType; +typedef enum _LttvFieldType LttvFieldType; +typedef enum _LttvExpressionOp LttvExpressionOp; +typedef enum _LttvTreeElement LttvTreeElement; +typedef enum _LttvLogicalOp LttvLogicalOp; + +typedef union _LttvFieldValue LttvFieldValue; + +typedef struct _LttvSimpleExpression LttvSimpleExpression; +typedef struct _LttvFilterTree LttvFilterTree; +typedef struct _LttvFilter LttvFilter; + + +/** + * @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 +}; + +/** + * @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 /** undefined field */ +}; /** - * @enum lttv_expression_op + * @enum LttvExpressionOp + * @brief Contains possible operators + * + * This enumeration defines the + * possible operator used to compare + * right and left member in simple + * expression */ -typedef enum _lttv_expression_op +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_expression_op; - -typedef enum _lttv_expression_type -{ - LTTV_EXPRESSION, - LTTV_SIMPLE_EXPRESSION, - LTTV_EXPRESSION_OP, - LTTV_UNDEFINED_EXPRESSION -} lttv_expression_type; - -typedef enum _lttv_tree_element { - LTTV_TREE_IDLE, - LTTV_TREE_NODE, - LTTV_TREE_LEAF -} lttv_tree_element; - -typedef struct _lttv_simple_expression + 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 + * + * @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 + */ +union _LttvFieldValue { + guint64 v_uint64; + guint32 v_uint32; + guint16 v_uint16; + double v_double; + char* v_string; + LttTime v_ltttime; +}; + +/** + * @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 */ +}; + + +/** + * @struct 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. + */ +struct _LttvSimpleExpression { - char *field_name; - lttv_expression_op op; - char *value; -} lttv_simple_expression; - -typedef enum _lttv_logical_op { - 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_op; + 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 */ +}; + +/** + * @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 + */ +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) */ +}; -/* - * 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; - -typedef struct _lttv_expression { - lttv_expression_type type; - union { - lttv_simple_expression *se; - int op; - } e; -} lttv_expression; - -typedef struct _lttv_filter_tree { -// lttv_expression* node; - int node; - lttv_tree_element left; - lttv_tree_element right; +/** + * @struct LttvFilterTree + * 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; union { - struct lttv_filter_tree* t; - lttv_simple_expression* leaf; + LttvFilterTree* t; + LttvSimpleExpression* leaf; } l_child; union { - struct lttv_filter_tree* t; - lttv_simple_expression* leaf; + LttvFilterTree* t; + LttvSimpleExpression* leaf; } r_child; -} lttv_filter_tree; +}; /** * @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; +struct _LttvFilter { + char *expression; + LttvFilterTree *head; +}; +/* + * Simple Expression + */ +LttvSimpleExpression* lttv_simple_expression_new(); -lttv_simple_expression* lttv_simple_expression_new(); +gboolean lttv_simple_expression_add_field(GPtrArray* fp, LttvSimpleExpression* se); -lttv_filter_tree* lttv_filter_tree_new(); +gboolean lttv_simple_expression_assign_operator(LttvSimpleExpression* se, LttvExpressionOp op); -void lttv_filter_tree_destroy(lttv_filter_tree* tree); +gboolean lttv_simple_expression_assign_value(LttvSimpleExpression* se, char* value); -void lttv_filter_tree_add_node(GPtrArray* stack, lttv_filter_tree* subtree, lttv_logical_op op); +void lttv_simple_expression_destroy(LttvSimpleExpression* se); -/* Parse field path contained in list */ -gboolean parse_field_path(GPtrArray* fp); -gboolean parse_simple_expression(GString* expression); +/* + * Logical operators functions + */ -/* Compile the filter expression into an efficient data structure */ -lttv_filter_tree *lttv_filter_new(char *expression, LttvTraceState *tfs); +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_ltttime(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_ltttime(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_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_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_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); -void lttv_filter_destroy(lttv_filter* filter); +/* + * Cloning + */ + +LttvFilterTree* lttv_filter_tree_clone(const LttvFilterTree* tree); + +LttvFilter* lttv_filter_clone(const LttvFilter* filter); + +/* + * LttvFilter + */ +LttvFilter *lttv_filter_new(); -/* 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_update(LttvFilter* filter); -gboolean lttv_filter_tracefile(lttv_filter_tree *filter, LttTracefile *tracefile); +void lttv_filter_destroy(LttvFilter* filter); -gboolean lttv_filter_tracestate(lttv_filter_t *filter, LttvTraceState *tracestate); +gboolean lttv_filter_append_expression(LttvFilter* filter, char *expression); -gboolean lttv_filter_event(lttv_filter_t *filter, LttEvent *event); +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( + const LttvFilterTree* t, + const LttEvent* event, + const LttTracefile* tracefile, + const LttTrace* trace, + const LttvProcessState* state, + const LttvTracefileContext* context); + +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(const LttvFilterTree* t); #endif // FILTER_H