X-Git-Url: http://git.lttng.org/?a=blobdiff_plain;f=ltt%2Fbranches%2Fpoly%2Flttv%2Flttv%2Ffilter.h;h=0e7ca9c7c11ed9b1f5e7634bd3a85973b2c31663;hb=728d0c3ea0f5f236770ac2f330dccada59c59366;hp=ab559d038339487eba542051cf9a2af2ed3bc36d;hpb=150f0d33179740736dba89c0a2ac632c54645c55;p=lttv.git diff --git a/ltt/branches/poly/lttv/lttv/filter.h b/ltt/branches/poly/lttv/lttv/filter.h index ab559d03..0e7ca9c7 100644 --- a/ltt/branches/poly/lttv/lttv/filter.h +++ b/ltt/branches/poly/lttv/lttv/filter.h @@ -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 @@ -19,41 +19,74 @@ #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 #include #include #include #include +#include #include +/* structures prototypes */ +typedef enum _LttvStructType LttvStructType; +typedef enum _LttvFieldType LttvFieldType; +typedef enum _LttvExpressionOp LttvExpressionOp; +typedef enum _LttvTreeElement LttvTreeElement; +typedef enum _LttvLogicalOp LttvLogicalOp; -/* 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: +typedef union _LttvFieldValue LttvFieldValue; - filter = expression +typedef struct _LttvSimpleExpression LttvSimpleExpression; +typedef struct _LttvFilterTree LttvFilterTree; +typedef struct _LttvFilter LttvFilter; - expression = "(" expression ")" | "!" expression | - expression "&&" expression | expression "||" expression | - simpleExpression - simpleExpression = fieldPath op value - - fieldPath = fieldComponent [ "." fieldPath ] - - 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, /**< trace (LttTrace) */ + LTTV_FILTER_TRACESET, /**< traceset */ + LTTV_FILTER_TRACEFILE, /**< tracefile (LttTracefile) */ + LTTV_FILTER_EVENT, /**< event (LttEvent) */ + LTTV_FILTER_STATE /**< state (LttvProcessState) */ +}; /** - * @enum LttvFieldType - * @brief Structures and their fields + * @enum _LttvFieldType + * @brief Possible fields for the structures * * the LttvFieldType enum consists on * all the hardcoded structures and @@ -61,54 +94,79 @@ * 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 -} 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, /**< dynamic field, specified in core.xml */ + LTTV_FILTER_UNDEFINED /**< undefined field */ +}; /** - * @enum LttvExpressionOp + * @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 +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 */ -} 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 */ +}; /** - * @enum LttvTreeElement + * @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; /**< unsigned int of 64 bytes */ + guint32 v_uint32; /**< unsigned int of 32 bytes */ + guint16 v_uint16; /**< unsigned int of 16 bytes */ + double v_double; /**< double */ + char* v_string; /**< string */ + LttTime v_ltttime; /**< LttTime */ +}; + +/** + * @enum _LttvTreeElement * @brief element types for the tree nodes * * LttvTreeElement defines the possible * 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 */ -} LttvTreeElement; +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 */ +}; + /** - * @enum LttvSimpleExpression + * @struct _LttvSimpleExpression * @brief simple expression structure * * An LttvSimpleExpression is the base @@ -119,16 +177,16 @@ typedef enum _LttvTreeElement { * field, an operator and a specific * value. */ -typedef struct _LttvSimpleExpression +struct _LttvSimpleExpression { - char *field_name; -// LttvExpressionOp op; - gboolean (*op)(); - char *value; -} LttvSimpleExpression; + 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 @@ -136,110 +194,154 @@ typedef struct _LttvSimpleExpression * simple expression. Values are * 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 */ -} LttvLogicalOp; +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) */ +}; /** - * @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 */ -typedef struct _LttvFilterTree { - int node; /** value of LttvLogicalOp */ - LttvTreeElement left; - LttvTreeElement right; +struct _LttvFilterTree { + int node; /**< value of LttvLogicalOp */ + LttvTreeElement left; /**< nature of left branch (node/leaf) */ + LttvTreeElement right; /**< nature of right branch (node/leaf) */ union { - struct LttvFilter* t; - LttvSimpleExpression* leaf; - } l_child; + LttvFilterTree* t; + LttvSimpleExpression* leaf; + } l_child; /**< left branch of tree */ union { - struct LttvFilter* t; - LttvSimpleExpression* leaf; - } r_child; -} LttvFilterTree; + 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. */ -typedef struct _LttvFilter { - char *expression; - LttvFilterTree *head; -} +struct _LttvFilter { + char *expression; /**< filtering expression string */ + LttvFilterTree *head; /**< tree associated to expression */ +}; /* - * General Data Handling functions + * Simple Expression */ - LttvSimpleExpression* lttv_simple_expression_new(); -void lttv_filter_tree_add_node(GPtrArray* stack, LttvFilter* subtree, LttvLogicalOp op); +gboolean lttv_simple_expression_assign_field(GPtrArray* fp, LttvSimpleExpression* se); + +gboolean lttv_simple_expression_assign_operator(LttvSimpleExpression* se, LttvExpressionOp op); -gboolean parse_field_path(GPtrArray* fp); +gboolean lttv_simple_expression_assign_value(LttvSimpleExpression* se, char* value); + +void lttv_simple_expression_destroy(LttvSimpleExpression* se); -gboolean parse_simple_expression(GString* expression); /* * Logical operators functions */ -gboolean lttv_apply_op_eq(); - -gboolean lttv_apply_op_ne(); - -gboolean lttv_apply_op_lt(); - -gboolean lttv_apply_op_le(); - -gboolean lttv_apply_op_gt(); - -gboolean lttv_apply_op_ge(); +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_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_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); /* * 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); -/* - * 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 */ -LttvFilterTree* lttv_filter_tree_new(); - -void lttv_filter_tree_destroy(LttvFilterTree* tree); +gboolean lttv_filter_append_expression(LttvFilter* filter, const char *expression); +void lttv_filter_clear_expression(LttvFilter* filter); /* - * Hook functions - * - * These hook functions will be the one called when filtering - * an event, a trace, a state, etc. + * LttvFilterTree */ +LttvFilterTree* lttv_filter_tree_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_tracefile(LttvFilter *filter, LttTracefile *tracefile); +void lttv_filter_tree_destroy(LttvFilterTree* tree); -gboolean lttv_filter_tracestate(LttvFilter *filter, LttvTraceState *tracestate); +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); -gboolean lttv_filter_event(LttvFilter *filter, LttEvent *event); +/* + * Debug functions + */ +void lttv_print_tree(const LttvFilterTree* t, const int count); #endif // FILTER_H