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