ltt/branches/poly/lttv/modules/text/textFilter.c

   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
  19 /*
  20  * The text filter facility will prompt for user filter option
  21  * and transmit them to the lttv core
  22  */
  23
  24 #include <lttv/lttv.h>
  25 #include <lttv/option.h>
  26 #include <lttv/module.h>
  27 #include <lttv/hook.h>
  28 #include <lttv/attribute.h>
  29 #include <lttv/iattribute.h>
  30 #include <lttv/stats.h>
  31 #include <lttv/filter.h>
  32 #include <ltt/ltt.h>
  33 #include <ltt/event.h>
  34 #include <ltt/type.h>
  35 #include <ltt/trace.h>
  36 #include <ltt/facility.h>
  37 #include <stdio.h>
  38
  39 /* Insert the hooks before and after each trace and tracefile, and for each
  40    event. Print a global header. */
  41
  42 /*
  43  *  YET TO BE ANSWERED !
  44  *  - why does this module need dependency with batchAnalysis ?
  45  */
  46
  47 /*
  48  *  TODO
  49  *  - specify wich hook function will be used to call the core filter
  50  */
  51
  52 static char
  53   *a_file_name = NULL,
  54   *a_string = NULL;
  55
  56 GString
  57   *a_filter_string = NULL;
  58
  59
  60 static LttvHooks
  61   *before_traceset,
  62   *event_hook;
  63
  64 static FILE *a_file;
  65
  66
  67 /**
  68  * filters the file input from user
  69  * @param hook_data the hook data
  70  * @return success/failure of operation
  71  */
  72 void filter_analyze_file(void *hook_data) {
  73
  74   g_print("textFilter::filter_analyze_file\n");
  75
  76   /*
  77          *      User may specify filtering options through static file
  78          *      and/or command line string.  From these sources, an
  79          *      option string is rebuilded and sent to the filter core
  80          */
  81         a_file = fopen(a_file_name, "r");
  82         if(a_file == NULL) {
  83                 g_warning("file %s does not exist", a_file_name);
  84     return;
  85   }
  86
  87   char* line = NULL;
  88   size_t len = 0;
  89
  90   if(a_filter_string == NULL) {
  91     a_filter_string = g_string_new("");
  92   }
  93   else {
  94     g_string_append(a_filter_string,"&"); /*conjonction between expression*/
  95   }
  96
  97   while(!feof(a_file)) {
  98     getline(&line,&len,a_file);
  99     g_string_append(a_filter_string,line);
 100     line = NULL;
 101   }
 102
 103   fclose(a_file);
 104 }
 105
 106 /**
 107  * filters the string input from user
 108  * @param hook_data the hook data
 109  * @return success/failure of operation
 110  */
 111 void filter_analyze_string(void *hook_data) {
 112
 113   g_print("textFilter::filter_analyze_string\n");
 114
 115   /*
 116          *      User may specify filtering options through static file
 117          *      and/or command line string.  From these sources, an
 118          *      option string is rebuilded and sent to the filter core
 119          */
 120   if(a_filter_string==NULL) {
 121     a_filter_string = g_string_new("");
 122     g_string_append(a_filter_string,a_string);
 123   }
 124   else {
 125     g_string_append(a_filter_string,"&"); /*conjonction between expression*/
 126     g_string_append(a_filter_string,a_string);
 127   }
 128
 129 }
 130
 131 /**
 132  * filter to current event depending on the
 133  * filter options tree
 134  * @param hook_data the hook data
 135  * @param call_data the call data
 136  * @return success/error of operation
 137  */
 138 static gboolean filter_event_content(void *hook_data, void *call_data) {
 139
 140         g_print("textFilter::filter_event_content\n");  /* debug */
 141 }
 142
 143 /**
 144  *      initialize the new module
 145  */
 146 static void init() {
 147
 148   g_print("textFilter::init()\n");      /* debug */
 149
 150   LttvAttributeValue value;
 151
 152   LttvIAttribute *attributes = LTTV_IATTRIBUTE(lttv_global_attributes());
 153
 154   g_info("Init textFilter.c");
 155
 156   a_string = NULL;
 157   lttv_option_add("string", 's',
 158       "filters a string issued by the user on the command line",
 159       "string",
 160       LTTV_OPT_STRING, &a_string, filter_analyze_string, NULL);
 161   // add function to call for option
 162
 163   a_file_name = NULL;
 164   lttv_option_add("filename", 'f',
 165       "browse the filter options contained in specified file",
 166       "file name",
 167       LTTV_OPT_STRING, &a_file_name, filter_analyze_file, NULL);
 168
 169   /*
 170    *    Note to myself !
 171    *    LttvAttributeValue::v_pointer is a gpointer* --> void**
 172    *    see union LttvAttributeValue for more info
 173    */
 174   g_assert(lttv_iattribute_find_by_path(attributes, "hooks/event",
 175       LTTV_POINTER, &value));
 176   g_assert((event_hook = *(value.v_pointer)) != NULL);
 177   lttv_hooks_add(event_hook, filter_event_content, NULL, LTTV_PRIO_DEFAULT);
 178
 179 //  g_assert(lttv_iattribute_find_by_path(attributes,"hooks/trace/before",
 180 //      LTTV_POINTER, &value));
 181 //  g_assert((before_traceset = *(value.v_pointer)) != NULL);
 182 //  lttv_hooks_add(before_traceset, parse_filter_options, NULL, LTTV_PRIO_DEFAULT);
 183
 184 }
 185
 186 /**
 187  *      Destroy the current module
 188  */
 189 static void destroy() {
 190   g_info("Destroy textFilter");
 191
 192   lttv_option_remove("string");
 193
 194   lttv_option_remove("filename");
 195
 196   lttv_hooks_remove_data(event_hook, filter_event_content, NULL);
 197
 198 //  lttv_hooks_remove_data(before_traceset, parse_filter_options, NULL);
 199
 200 }
 201
 202
 203 LTTV_MODULE("textFilter", "Filters traces", \
 204             "Filter the trace following commands issued by user input", \
 205             init, destroy, "batchAnalysis", "option")
 206