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 static char
  48   *a_file_name = NULL,
  49   *a_string = NULL;
  50
  51 static GString
  52   *a_filter_string = NULL;
  53
  54
  55 static LttvHooks
  56   *before_traceset,
  57   *event_hook;
  58
  59 static FILE *a_file;
  60
  61
  62 /**
  63  * filters the file input from user
  64  * @param hook_data the hook data
  65  * @return success/failure of operation
  66  */
  67 void filter_analyze_file(void *hook_data) {
  68
  69   g_print("textFilter::filter_analyze_file\n");
  70
  71   /*
  72          *      User may specify filtering options through static file
  73          *      and/or command line string.  From these sources, an
  74          *      option string is rebuilded and sent to the filter core
  75          */
  76         a_file = fopen(a_file_name, "r");
  77         if(a_file == NULL) {
  78                 g_warning("file %s does not exist", a_file_name);
  79     return;
  80   }
  81
  82   char* tmp;
  83   fscanf(a_file,"%s",tmp);
  84
  85   if(!a_filter_string->len) {
  86     g_string_append(a_filter_string,tmp);
  87   }
  88   else {
  89     g_string_append(a_filter_string,"&"); /*conjonction between expression*/
  90     g_string_append(a_filter_string,tmp);
  91   }
  92
  93   fclose(a_file);
  94 }
  95
  96 /**
  97  * filters the string input from user
  98  * @param hook_data the hook data
  99  * @return success/failure of operation
 100  */
 101 void filter_analyze_string(void *hook_data) {
 102
 103   g_print("textFilter::filter_analyze_string\n");
 104
 105   /*
 106          *      User may specify filtering options through static file
 107          *      and/or command line string.  From these sources, an
 108          *      option string is rebuilded and sent to the filter core
 109          */
 110   if(!a_filter_string->len) {
 111     g_string_append(a_filter_string,a_string);
 112     lttv_filter_new(a_filter_string,NULL);
 113   }
 114   else {
 115     g_string_append(a_filter_string,"&"); /*conjonction between expression*/
 116     g_string_append(a_filter_string,a_string);
 117   }
 118
 119 }
 120
 121 /**
 122  * filter to current event depending on the
 123  * filter options tree
 124  * @param hook_data the hook data
 125  * @param call_data the call data
 126  * @return success/error of operation
 127  */
 128 static gboolean filter_event_content(void *hook_data, void *call_data) {
 129
 130         g_print("textFilter::filter_event_content\n");  /* debug */
 131 }
 132
 133 /**
 134  *      initialize the new module
 135  */
 136 static void init() {
 137
 138   g_print("textFilter::init()\n");      /* debug */
 139
 140   a_filter_string = g_string_new("");
 141
 142   LttvAttributeValue value;
 143
 144   LttvIAttribute *attributes = LTTV_IATTRIBUTE(lttv_global_attributes());
 145
 146   g_info("Init textFilter.c");
 147
 148   a_string = NULL;
 149   lttv_option_add("string", 's',
 150       "filters a string issued by the user on the command line",
 151       "string",
 152       LTTV_OPT_STRING, &a_string, filter_analyze_string, NULL);
 153   // add function to call for option
 154
 155   a_file_name = NULL;
 156   lttv_option_add("filename", 'f',
 157       "browse the filter options contained in specified file",
 158       "file name",
 159       LTTV_OPT_STRING, &a_file_name, filter_analyze_file, NULL);
 160
 161   /*
 162    *    Note to myself !
 163    *    LttvAttributeValue::v_pointer is a gpointer* --> void**
 164    *    see union LttvAttributeValue for more info
 165    */
 166   g_assert(lttv_iattribute_find_by_path(attributes, "hooks/event",
 167       LTTV_POINTER, &value));
 168   g_assert((event_hook = *(value.v_pointer)) != NULL);
 169   lttv_hooks_add(event_hook, filter_event_content, NULL, LTTV_PRIO_DEFAULT);
 170
 171 //  g_assert(lttv_iattribute_find_by_path(attributes,"hooks/trace/before",
 172 //      LTTV_POINTER, &value));
 173 //  g_assert((before_traceset = *(value.v_pointer)) != NULL);
 174 //  lttv_hooks_add(before_traceset, parse_filter_options, NULL, LTTV_PRIO_DEFAULT);
 175
 176
 177 }
 178
 179 /**
 180  *      Destroy the current module
 181  */
 182 static void destroy() {
 183   g_info("Destroy textFilter");
 184
 185   lttv_option_remove("string");
 186
 187   lttv_option_remove("filename");
 188
 189   lttv_hooks_remove_data(event_hook, filter_event_content, NULL);
 190
 191 //  lttv_hooks_remove_data(before_traceset, parse_filter_options, NULL);
 192
 193 }
 194
 195
 196 LTTV_MODULE("textFilter", "Filters traces", \
 197             "Filter the trace following commands issued by user input", \
 198             init, destroy, "batchAnalysis", "option")
 199