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

   1 /* This file is part of the Linux Trace Toolkit viewer
   2  * Copyright (C) 2005 Simon Bouvier-Zappa
   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 /*! \file lttv/modules/text/textFilter.c
  20  *  \brief Textual prompt for user filtering expression.
  21  *
  22  *  The text filter facility will prompt for user filter option
  23  *  and transmit them to the lttv core.  User can either specify
  24  *  a filtering string with the command line or/and specify a
  25  *  file containing filtering expressions.
  26  */
  27
  28 #ifdef HAVE_CONFIG_H
  29 #include <config.h>
  30 #endif
  31
  32 #include <lttv/lttv.h>
  33 #include <lttv/option.h>
  34 #include <lttv/module.h>
  35 #include <lttv/hook.h>
  36 #include <lttv/attribute.h>
  37 #include <lttv/iattribute.h>
  38 #include <lttv/stats.h>
  39 #include <lttv/filter.h>
  40 #include <ltt/ltt.h>
  41 #include <ltt/event.h>
  42 #include <ltt/type.h>
  43 #include <ltt/trace.h>
  44 #include <ltt/facility.h>
  45 #include <stdio.h>
  46
  47 /* Insert the hooks before and after each trace and tracefile, and for each
  48    event. Print a global header. */
  49
  50 /*
  51  *  YET TO BE ANSWERED !
  52  *  - why does this module need dependency with batchAnalysis ?
  53  */
  54
  55 /*
  56  *  TODO
  57  *  - specify wich hook function will be used to call the core filter
  58  */
  59
  60 static char
  61   *a_file_name = NULL,
  62   *a_string = NULL;
  63
  64 static LttvHooks
  65   *before_traceset,
  66   *event_hook;
  67
  68 /**
  69  * filters the file input from user
  70  * @param hook_data the hook data, unused
  71  */
  72 void filter_analyze_file(void *hook_data) {
  73
  74   LttvAttributeValue value;
  75
  76   LttvIAttribute *attributes = LTTV_IATTRIBUTE(lttv_global_attributes());
  77
  78   /*
  79          *      User may specify filtering options through static file
  80          *      and/or command line string.  From these sources, an
  81          *      option string is rebuilded and sent to the filter core
  82          */
  83   if(!g_file_test(a_file_name,G_FILE_TEST_EXISTS)) {
  84     g_warning("file %s does not exist", a_file_name);
  85     return;
  86   }
  87
  88   char* a_file_content = NULL;
  89
  90   g_file_get_contents(a_file_name,&a_file_content,NULL,NULL);
  91
  92   g_assert(lttv_iattribute_find_by_path(attributes, "filter/expression",
  93       LTTV_POINTER, &value));
  94
  95   if(((GString*)*(value.v_pointer))->len != 0) g_string_append_c((GString*)*(value.v_pointer),'&');
  96   g_string_append_c((GString*)*(value.v_pointer),'(');
  97   g_string_append((GString*)*(value.v_pointer),a_file_content);
  98   g_string_append_c((GString*)*(value.v_pointer),')');
  99
 100 }
 101
 102 /**
 103  * filters the string input from user
 104  * @param hook_data the hook data, unused
 105  */
 106 void filter_analyze_string(void *hook_data) {
 107
 108   LttvAttributeValue value;
 109
 110   LttvIAttribute *attributes = LTTV_IATTRIBUTE(lttv_global_attributes());
 111
 112   /*
 113          *      User may specify filtering options through static file
 114          *      and/or command line string.  From these sources, an
 115          *      option string is rebuilded and sent to the filter core
 116          */
 117   g_assert(lttv_iattribute_find_by_path(attributes, "filter/expression",
 118       LTTV_POINTER, &value));
 119
 120   if(((GString*)*(value.v_pointer))->len != 0) g_string_append_c((GString*)*(value.v_pointer),'&');
 121   g_string_append_c((GString*)*(value.v_pointer),'(');
 122   g_string_append((GString*)*(value.v_pointer),a_string);
 123   g_string_append_c((GString*)*(value.v_pointer),')');
 124
 125 }
 126
 127 /**
 128  * Output all filter commands on console
 129  * @param hook_data the hook data
 130  */
 131 void filter_list_commands(void *hook_data) {
 132
 133   g_print("[field] [op] [value]\n\n");
 134
 135   g_print("*** Possible fields ***\n");
 136   g_print("event.name (string)\n");
 137   g_print("event.category (string)\n");
 138   g_print("event.time (double)\n");
 139   g_print("event.tsc (integer)\n");
 140   g_print("tracefile.name (string)\n");
 141   g_print("trace.name (string)\n");
 142   g_print("state.pid (integer)\n");
 143   g_print("state.ppid (integer)\n");
 144   g_print("state.creation_time (double)\n");
 145   g_print("trace.insertion_time (double)\n");
 146   g_print("trace.process_name (string)\n");
 147   g_print("trace.execution_mode (string)\n");
 148   g_print("trace.execution_submode (string)\n");
 149   g_print("trace.process_status (string)\n");
 150   g_print("trace.cpu (string)\n\n");
 151
 152   g_print("*** Possible operators ***\n");
 153   g_print("equal '='\n");
 154   g_print("not equal '!='\n");
 155   g_print("greater '>'\n");
 156   g_print("greater or equal '>='\n");
 157   g_print("lower '<'\n");
 158   g_print("lower or equal '<='\n");
 159
 160   g_print("*** Possible values ***\n");
 161   g_print("string, integer, double");
 162 }
 163
 164 /**
 165  *      initialize the new module
 166  */
 167 static void init() {
 168
 169   LttvAttributeValue value;
 170
 171   LttvIAttribute *attributes = LTTV_IATTRIBUTE(lttv_global_attributes());
 172
 173   g_assert(lttv_iattribute_find_by_path(attributes, "filter/expression",
 174       LTTV_POINTER, &value));
 175
 176   *(value.v_pointer) = g_string_new("");
 177
 178   g_info("Init textFilter.c");
 179
 180   a_string = NULL;
 181   lttv_option_add("expression", 'e',
 182       "filters a string issued by the user on the command line",
 183       "string",
 184       LTTV_OPT_STRING, &a_string, filter_analyze_string, NULL);
 185   // add function to call for option
 186
 187   a_file_name = NULL;
 188   lttv_option_add("filename", 'f',
 189       "browse the filter options contained in specified file",
 190       "file name",
 191       LTTV_OPT_STRING, &a_file_name, filter_analyze_file, NULL);
 192
 193   lttv_option_add("list", 'l',
 194       "list all possible filter commands for module",
 195       "list commands",
 196       LTTV_OPT_NONE, NULL, filter_list_commands, NULL);
 197
 198 }
 199
 200 /**
 201  *      Destroy the current module
 202  */
 203 static void destroy() {
 204   g_info("Destroy textFilter");
 205
 206   lttv_option_remove("expression");
 207
 208   lttv_option_remove("filename");
 209
 210   lttv_option_remove("list");
 211
 212   LttvAttributeValue value;
 213
 214   LttvIAttribute *attributes = LTTV_IATTRIBUTE(lttv_global_attributes());
 215
 216   g_assert(lttv_iattribute_find_by_path(attributes, "filter/expression",
 217       LTTV_POINTER, &value));
 218
 219   g_string_free((GString*)*(value.v_pointer),TRUE);
 220
 221 }
 222
 223
 224 LTTV_MODULE("textFilter", "Filters traces", \
 225             "Filter the trace following commands issued by user input", \
 226             init, destroy, "option")
 227