[lttv.git] / ltt / branches / poly / lttv / lttv / filter.h

/* This file is part of the Linux Trace Toolkit viewer
 * Copyright (C) 2003-2004 Michel Dagenais
 *
 * 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
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, 
 * MA 02111-1307, USA.
 */

#ifndef FILTER_H
#define FILTER_H

#include <lttv/traceset.h>
#include <lttv/tracecontext.h>
#include <lttv/state.h>
#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 
   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 

*/

static GQuark
  LTTV_FILTER_TRACE,
  LTTV_FILTER_TRACESET,
  LTTV_FILTER_TRACEFILE,
  LTTV_FILTER_STATE,
  LTTV_FILTER_EVENT;

/**
 * 	@enum lttv_expression_op
 */
typedef enum _lttv_expression_op
{ 
  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_type;

typedef struct _lttv_simple_expression
{ 
  lttv_expression_op op;
  char *field_name;
  char *value;
} lttv_simple_expression;


//typedef union _tmp {
//  struct lttv_expression *e;
//  lttv_field_relation *se;
//} tmp;
/*
typedef struct _lttv_expression 
{ 
  gboolean or;
  gboolean not;
  gboolean and;
  gboolean xor;
  gboolean simple_expression;
//  tmp e;
} lttv_expression;
*/

typedef union _lttv_expression {
  lttv_simple_expression se;
  
} lttv_expression;

typedef struct _lttv_filter_tree {
	lttv_expression* node;
	struct lttv_filter_tree* r_child;
	struct lttv_filter_tree* l_child;
} lttv_filter_tree;

/**
 * @struct lttv_filter
 * ( will later contain a binary tree of filtering options )
 */
typedef struct _lttv_filter {
	lttv_filter_tree* tree;	
} lttv_filter;

gboolean parse_field_path(GList* fp);

gboolean parse_simple_expression(GString* expression);

/* Compile the filter expression into an efficient data structure */
lttv_filter *lttv_filter_new(char *expression, LttvTraceState *tfs);


/* 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(lttv_filter *filter, LttTracefile *tracefile);

gboolean lttv_filter_event(lttv_filter *filter, LttEvent *event);

#endif // FILTER_H
Commit	Line	Data
9c312311	1	/* This file is part of the Linux Trace Toolkit viewer
	2	* Copyright (C) 2003-2004 Michel Dagenais
	3	*
	4	* This program is free software; you can redistribute it and/or modify
	5	* it under the terms of the GNU General Public License Version 2 as
	6	* published by the Free Software Foundation;
	7	*
	8	* This program is distributed in the hope that it will be useful,
	9	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	10	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	11	* GNU General Public License for more details.
	12	*
	13	* You should have received a copy of the GNU General Public License
	14	* along with this program; if not, write to the Free Software
	15	* Foundation, Inc., 59 Temple Place - Suite 330, Boston,
	16	* MA 02111-1307, USA.
	17	*/
	18
48f6f3c2	19	#ifndef FILTER_H
	20	#define FILTER_H
	21
31452f49	22	#include <lttv/traceset.h>
a4c292d4	23	#include <lttv/tracecontext.h>
	24	#include <lttv/state.h>
	25	#include <ltt/ltt.h>
	26	#include <ltt/event.h>
	27
	28	#define AVERAGE_EXPRESSION_LENGTH 6
	29	#define MAX_FACTOR 1.5
31452f49	30
48f6f3c2	31	/* A filter expression consists in nested AND, OR and NOT expressions
	32	involving boolean relation (>, >=, =, !=, <, <=) between event fields and
	33	specific values. It is compiled into an efficient data structure which
	34	is used in functions to check if a given event or tracefile satisfies the
	35	filter.
	36
	37	The grammar for filters is:
	38
	39	filter = expression
	40
	41	expression = "(" expression ")" \| "!" expression \|
	42	expression "&&" expression \| expression "\|\|" expression \|
	43	simpleExpression
	44
	45	simpleExpression = fieldPath op value
	46
	47	fieldPath = fieldComponent [ "." fieldPath ]
	48
	49	fieldComponent = name [ "[" integer "]" ]
	50
	51	value = integer \| double \| string
	52
	53	*/
	54
0769c82f	55	static GQuark
	56	LTTV_FILTER_TRACE,
	57	LTTV_FILTER_TRACESET,
	58	LTTV_FILTER_TRACEFILE,
	59	LTTV_FILTER_STATE,
	60	LTTV_FILTER_EVENT;
	61
84a333d6	62	/**
	63	* @enum lttv_expression_op
	64	*/
	65	typedef enum _lttv_expression_op
	66	{
	67	LTTV_FIELD_EQ, /** equal */
	68	LTTV_FIELD_NE, /** not equal */
	69	LTTV_FIELD_LT, /** lower than */
	70	LTTV_FIELD_LE, /** lower or equal */
	71	LTTV_FIELD_GT, /** greater than */
	72	LTTV_FIELD_GE /** greater or equal */
	73	} lttv_expression_op;
	74
	75	typedef enum _lttv_expression_type
	76	{
	77	LTTV_EXPRESSION,
	78	LTTV_SIMPLE_EXPRESSION
	79	} lttv_expression_type;
	80
	81	typedef struct _lttv_simple_expression
	82	{
	83	lttv_expression_op op;
	84	char *field_name;
	85	char *value;
	86	} lttv_simple_expression;
	87
a4c292d4	88
	89	//typedef union _tmp {
	90	// struct lttv_expression *e;
	91	// lttv_field_relation *se;
	92	//} tmp;
	93	/*
84a333d6	94	typedef struct _lttv_expression
	95	{
	96	gboolean or;
	97	gboolean not;
	98	gboolean and;
	99	gboolean xor;
	100	gboolean simple_expression;
a4c292d4	101	// tmp e;
	102	} lttv_expression;
	103	*/
	104
	105	typedef union _lttv_expression {
	106	lttv_simple_expression se;
	107
84a333d6	108	} lttv_expression;
	109
	110	typedef struct _lttv_filter_tree {
	111	lttv_expression* node;
	112	struct lttv_filter_tree* r_child;
	113	struct lttv_filter_tree* l_child;
	114	} lttv_filter_tree;
	115
31452f49	116	/**
	117	* @struct lttv_filter
	118	* ( will later contain a binary tree of filtering options )
	119	*/
84a333d6	120	typedef struct _lttv_filter {
	121	lttv_filter_tree* tree;
	122	} lttv_filter;
	123
0769c82f	124	gboolean parse_field_path(GList* fp);
0769c82f	125
84a333d6	126	gboolean parse_simple_expression(GString* expression);
48f6f3c2	127
48f6f3c2	128	/* Compile the filter expression into an efficient data structure */
a4c292d4	129	lttv_filter lttv_filter_new(char expression, LttvTraceState *tfs);
48f6f3c2	130
	131
	132	/* Check if the tracefile or event satisfies the filter. The arguments are
	133	declared as void * to allow these functions to be used as hooks. */
	134
0769c82f	135	gboolean lttv_filter_tracefile(lttv_filter filter, LttTracefile tracefile);
48f6f3c2	136
a4c292d4	137	gboolean lttv_filter_event(lttv_filter filter, LttEvent event);
48f6f3c2	138
	139	#endif // FILTER_H
	140