lttv/modules/text/textDump.c

   1 /* This file is part of the Linux Trace Toolkit viewer
   2  * Copyright (C) 2003-2004 Michel Dagenais
   3  *               2005 Mathieu Desnoyers
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License Version 2 as
   7  * published by the Free Software Foundation;
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  17  * MA 02111-1307, USA.
  18  */
  19
  20 /* The text dump facility needs to print headers before the trace set and
  21    before each trace, to print each event, and to print statistics
  22    after each trace. */
  23
  24 #ifdef HAVE_CONFIG_H
  25 #include <config.h>
  26 #endif
  27
  28 #include <lttv/lttv.h>
  29 #include <lttv/option.h>
  30 #include <lttv/module.h>
  31 #include <lttv/hook.h>
  32 #include <lttv/attribute.h>
  33 #include <lttv/iattribute.h>
  34 #include <lttv/stats.h>
  35 #include <lttv/filter.h>
  36 #include <lttv/print.h>
  37 #include <ltt/ltt.h>
  38 #include <ltt/event.h>
  39 #include <ltt/trace.h>
  40 #include <stdio.h>
  41 #include <inttypes.h>
  42
  43 static gboolean
  44   a_noevent,
  45   a_no_field_names,
  46   a_state,
  47   a_cpu_stats,
  48   a_process_stats,
  49   a_path_output;
  50
  51 static char
  52   *a_file_name = NULL;
  53
  54 static LttvHooks
  55   *before_traceset,
  56   *after_traceset,
  57   *before_trace,
  58   *event_hook;
  59
  60
  61 static void
  62 print_path_tree(FILE *fp, GString *indent, LttvAttribute *tree)
  63 {
  64   int i, nb, saved_length;
  65
  66   LttvAttribute *subtree;
  67
  68   LttvAttributeName name;
  69
  70   LttvAttributeValue value;
  71
  72   LttvAttributeType type;
  73
  74   gboolean is_named;
  75
  76   saved_length = indent->len;
  77   nb = lttv_attribute_get_number(tree);
  78   for(i = 0 ; i < nb ; i++) {
  79     type = lttv_attribute_get(tree, i, &name, &value, &is_named);
  80     if(is_named) {
  81       g_string_sprintfa(indent, "/%s", g_quark_to_string(name));
  82     } else {
  83             g_string_sprintfa(indent, "/%" PRIu32, (guint32) name);
  84     }
  85
  86     switch(type) {
  87       case LTTV_INT:
  88        fprintf(fp, "%s: %d\n", indent->str, *value.v_int);
  89         break;
  90       case LTTV_UINT:
  91        fprintf(fp, "%s: %d\n", indent->str, *value.v_int);
  92         break;
  93       case LTTV_LONG:
  94        fprintf(fp, "%s: %ld\n", indent->str, *value.v_ulong);
  95         break;
  96       case LTTV_ULONG:
  97        fprintf(fp, "%s: %lu\n", indent->str, *value.v_ulong);
  98         break;
  99       case LTTV_FLOAT:
 100        fprintf(fp, "%s: %f\n", indent->str, (double) *value.v_float);
 101         break;
 102       case LTTV_DOUBLE:
 103         fprintf(fp, "%s: %f\n", indent->str, *value.v_double);
 104         break;
 105       case LTTV_TIME:
 106        fprintf(fp, "%s: %lu.%09lu\n", indent->str, value.v_time->tv_sec, value.v_time->tv_nsec);
 107         break;
 108       case LTTV_POINTER:
 109        fprintf(fp, "%s: POINTER\n", indent->str);
 110         break;
 111       case LTTV_STRING:
 112        fprintf(fp, "%s: %s\n", indent->str, *value.v_string);
 113         break;
 114       case LTTV_GOBJECT:
 115         if(LTTV_IS_ATTRIBUTE(*(value.v_gobject))) {
 116           subtree = (LttvAttribute*) *(value.v_gobject);
 117           print_path_tree(fp, indent, subtree);
 118         } else {
 119          fprintf(fp, "%s: GOBJECT\n", indent->str);
 120        }
 121         break;
 122       case LTTV_NONE:
 123         break;
 124     }
 125     g_string_truncate(indent, saved_length);
 126   }
 127 }
 128
 129 static void
 130 print_tree(FILE *fp, GString *indent, LttvAttribute *tree)
 131 {
 132   int i, nb, saved_length;
 133
 134   LttvAttribute *subtree;
 135
 136   LttvAttributeName name;
 137
 138   LttvAttributeValue value;
 139
 140   LttvAttributeType type;
 141
 142         gboolean is_named;
 143
 144   nb = lttv_attribute_get_number(tree);
 145   for(i = 0 ; i < nb ; i++) {
 146     type = lttv_attribute_get(tree, i, &name, &value, &is_named);
 147                 if(is_named)
 148             fprintf(fp, "%s%s: ", indent->str, g_quark_to_string(name));
 149                 else
 150                         fprintf(fp, "%s%" PRIu32 ": ", indent->str,
 151                                 (guint32) name);
 152
 153     switch(type) {
 154       case LTTV_INT:
 155         fprintf(fp, "%d\n", *value.v_int);
 156         break;
 157       case LTTV_UINT:
 158         fprintf(fp, "%u\n", *value.v_uint);
 159         break;
 160       case LTTV_LONG:
 161         fprintf(fp, "%ld\n", *value.v_long);
 162         break;
 163       case LTTV_ULONG:
 164         fprintf(fp, "%lu\n", *value.v_ulong);
 165         break;
 166       case LTTV_FLOAT:
 167         fprintf(fp, "%f\n", (double)*value.v_float);
 168         break;
 169       case LTTV_DOUBLE:
 170         fprintf(fp, "%f\n", *value.v_double);
 171         break;
 172       case LTTV_TIME:
 173         fprintf(fp, "%10lu.%09lu\n", value.v_time->tv_sec,
 174             value.v_time->tv_nsec);
 175         break;
 176       case LTTV_POINTER:
 177         fprintf(fp, "POINTER\n");
 178         break;
 179       case LTTV_STRING:
 180         fprintf(fp, "%s\n", *value.v_string);
 181         break;
 182       case LTTV_GOBJECT:
 183         if(LTTV_IS_ATTRIBUTE(*(value.v_gobject))) {
 184           fprintf(fp, "\n");
 185           subtree = (LttvAttribute *)*(value.v_gobject);
 186           saved_length = indent->len;
 187           indent = g_string_append(indent, "  ");
 188           print_tree(fp, indent, subtree);
 189           g_string_truncate(indent, saved_length);
 190         }
 191         else fprintf(fp, "GOBJECT\n");
 192         break;
 193       case LTTV_NONE:
 194         break;
 195     }
 196   }
 197 }
 198
 199 static void
 200 print_stats(FILE *fp, LttvTracesetStats *tscs)
 201 {
 202   int i, nb, saved_length;
 203
 204   LttvTraceset *ts;
 205
 206   LttvTraceStats *tcs;
 207
 208   GString *indent;
 209
 210   if(tscs->stats == NULL) return;
 211   indent = g_string_new("");
 212   fprintf(fp, "Traceset statistics:\n\n");
 213   if(a_path_output) {
 214     print_path_tree(fp, indent, tscs->stats);
 215   } else {
 216     print_tree(fp, indent, tscs->stats);
 217   }
 218
 219   ts = tscs->parent.parent.ts;
 220   nb = lttv_traceset_number(ts);
 221
 222   for(i = 0 ; i < nb ; i++) {
 223     tcs = (LttvTraceStats *)(LTTV_TRACESET_CONTEXT(tscs)->traces[i]);
 224 #if 0 //FIXME
 225     LttSystemDescription *desc;
 226     desc = ltt_trace_system_description(tcs->parent.parent.t);
 227     LttTime start_time = ltt_trace_system_description_trace_start_time(desc);
 228     fprintf(fp, "Trace on system %s at time %lu.%09lu :\n",
 229             ltt_trace_system_description_node_name(desc),
 230             start_time.tv_sec,
 231       start_time.tv_nsec);
 232 #endif //FIXME
 233     saved_length = indent->len;
 234     if(a_path_output) {
 235       g_string_sprintfa(indent, "/trace%i", i);
 236       print_path_tree(fp, indent, tcs->stats);
 237     } else {
 238       g_string_append(indent, "  ");
 239       print_tree(fp, indent, tcs->stats);
 240     }
 241     g_string_truncate(indent, saved_length);
 242   }
 243   g_string_free(indent, TRUE);
 244 }
 245
 246 /* Insert the hooks before and after each trace and tracefile, and for each
 247    event. Print a global header. */
 248
 249 static FILE *a_file;
 250
 251 static GString *a_string;
 252
 253 static gboolean write_traceset_header(void *hook_data, void *call_data)
 254 {
 255   LttvTracesetContext *tc = (LttvTracesetContext *)call_data;
 256
 257   g_info("TextDump traceset header");
 258
 259   if(a_file_name == NULL) a_file = stdout;
 260   else a_file = fopen(a_file_name, "w");
 261
 262   if(a_file == NULL) g_error("cannot open file %s", a_file_name);
 263
 264   /* Print the trace set header */
 265   fprintf(a_file,"Trace set contains %d traces\n\n",
 266       lttv_traceset_number(tc->ts));
 267
 268   return FALSE;
 269 }
 270
 271
 272 static gboolean write_traceset_footer(void *hook_data, void *call_data)
 273 {
 274   LttvTracesetContext *tc = (LttvTracesetContext *)call_data;
 275
 276   g_info("TextDump traceset footer");
 277
 278   fprintf(a_file,"End trace set\n\n");
 279
 280   if(LTTV_IS_TRACESET_STATS(tc)) {
 281     lttv_stats_sum_traceset((LttvTracesetStats *)tc, ltt_time_infinite);
 282     print_stats(a_file, (LttvTracesetStats *)tc);
 283   }
 284
 285   if(a_file_name != NULL) fclose(a_file);
 286
 287   return FALSE;
 288 }
 289
 290
 291 static gboolean write_trace_header(void *hook_data, void *call_data)
 292 {
 293 #if 0 //FIXME
 294   LttvTraceContext *tc = (LttvTraceContext *)call_data;
 295   LttSystemDescription *system = ltt_trace_system_description(tc->t);
 296
 297   fprintf(a_file,"  Trace from %s in %s\n%s\n\n",
 298           ltt_trace_system_description_node_name(system),
 299           ltt_trace_system_description_domain_name(system),
 300           ltt_trace_system_description_description(system));
 301 #endif //0
 302   return FALSE;
 303 }
 304
 305
 306 static int write_event_content(void *hook_data, void *call_data)
 307 {
 308   gboolean result;
 309
 310   LttvIAttribute *attributes = LTTV_IATTRIBUTE(lttv_global_attributes());
 311
 312   LttvTracefileContext *tfc = (LttvTracefileContext *)call_data;
 313
 314   LttvTracefileState *tfs = (LttvTracefileState *)call_data;
 315
 316   LttEvent *e;
 317
 318   LttvAttributeValue value_filter;
 319
 320   LttvFilter *filter;
 321
 322   guint cpu = tfs->cpu;
 323   LttvTraceState *ts = (LttvTraceState*)tfc->t_context;
 324   LttvProcessState *process = ts->running_process[cpu];
 325
 326   if (a_noevent)
 327     return FALSE;
 328
 329   e = ltt_tracefile_get_event(tfc->tf);
 330
 331   result = lttv_iattribute_find_by_path(attributes, "filter/lttv_filter",
 332       LTTV_POINTER, &value_filter);
 333   g_assert(result);
 334   filter = (LttvFilter*)*(value_filter.v_pointer);
 335
 336   /*
 337    * call to the filter if available
 338    */
 339   if(filter->head != NULL)
 340     if(!lttv_filter_tree_parse(filter->head,e,tfc->tf,
 341                                tfc->t_context->t,tfc,NULL,NULL))
 342       return FALSE;
 343
 344   lttv_event_to_string(e, a_string, TRUE, !a_no_field_names, tfs);
 345
 346   if(a_state) {
 347     g_string_append_printf(a_string, " %s ",
 348         g_quark_to_string(process->state->s));
 349   }
 350
 351   g_string_append_printf(a_string,"\n");
 352
 353   fputs(a_string->str, a_file);
 354   return FALSE;
 355 }
 356
 357
 358 static void init()
 359 {
 360   gboolean result;
 361
 362   LttvAttributeValue value;
 363
 364   LttvIAttribute *attributes = LTTV_IATTRIBUTE(lttv_global_attributes());
 365
 366   g_info("Init textDump.c");
 367
 368   a_string = g_string_new("");
 369
 370   a_file_name = NULL;
 371   lttv_option_add("output", 'o',
 372       "output file where the text is written",
 373       "file name",
 374       LTTV_OPT_STRING, &a_file_name, NULL, NULL);
 375
 376   a_noevent = FALSE;
 377   lttv_option_add("noevent", 'n',
 378       "disable event printout",
 379       "",
 380       LTTV_OPT_NONE, &a_noevent, NULL, NULL);
 381
 382   a_no_field_names = FALSE;
 383   lttv_option_add("field_names", 's',
 384       "do not write the field names for each event",
 385       "",
 386       LTTV_OPT_NONE, &a_no_field_names, NULL, NULL);
 387
 388   a_state = FALSE;
 389   lttv_option_add("process_state", 'r',
 390       "write the pid and state for each event",
 391       "",
 392       LTTV_OPT_NONE, &a_state, NULL, NULL);
 393
 394   a_cpu_stats = FALSE;
 395   lttv_option_add("cpu_stats", 'c',
 396       "write the per cpu statistics",
 397       "",
 398       LTTV_OPT_NONE, &a_cpu_stats, NULL, NULL);
 399
 400   a_process_stats = FALSE;
 401   lttv_option_add("process_stats", 'p',
 402       "write the per process statistics",
 403       "",
 404       LTTV_OPT_NONE, &a_process_stats, NULL, NULL);
 405
 406   a_path_output = FALSE;
 407   lttv_option_add("path_output", 'a',
 408       "print the process stats in path format, for easy grepping",
 409       "",
 410       LTTV_OPT_NONE, &a_path_output, NULL, NULL);
 411
 412   result = lttv_iattribute_find_by_path(attributes, "hooks/event",
 413       LTTV_POINTER, &value);
 414   g_assert(result);
 415   event_hook = *(value.v_pointer);
 416   g_assert(event_hook);
 417   lttv_hooks_add(event_hook, write_event_content, NULL, LTTV_PRIO_DEFAULT);
 418
 419   result = lttv_iattribute_find_by_path(attributes, "hooks/trace/before",
 420       LTTV_POINTER, &value);
 421   g_assert(result);
 422   before_trace = *(value.v_pointer);
 423   g_assert(before_trace);
 424   lttv_hooks_add(before_trace, write_trace_header, NULL, LTTV_PRIO_DEFAULT);
 425
 426   result = lttv_iattribute_find_by_path(attributes, "hooks/traceset/before",
 427       LTTV_POINTER, &value);
 428   g_assert(result);
 429   before_traceset = *(value.v_pointer);
 430   g_assert(before_traceset);
 431   lttv_hooks_add(before_traceset, write_traceset_header, NULL,
 432       LTTV_PRIO_DEFAULT);
 433
 434   result = lttv_iattribute_find_by_path(attributes, "hooks/traceset/after",
 435       LTTV_POINTER, &value);
 436   g_assert(result);
 437   after_traceset = *(value.v_pointer);
 438   g_assert(after_traceset);
 439   lttv_hooks_add(after_traceset, write_traceset_footer, NULL,
 440       LTTV_PRIO_DEFAULT);
 441 }
 442
 443 static void destroy()
 444 {
 445   g_info("Destroy textDump");
 446
 447   lttv_option_remove("noevent");
 448
 449   lttv_option_remove("output");
 450
 451   lttv_option_remove("field_names");
 452
 453   lttv_option_remove("process_state");
 454
 455   lttv_option_remove("cpu_stats");
 456
 457   lttv_option_remove("process_stats");
 458
 459   lttv_option_remove("path_output");
 460
 461   g_string_free(a_string, TRUE);
 462
 463   lttv_hooks_remove_data(event_hook, write_event_content, NULL);
 464
 465   lttv_hooks_remove_data(before_trace, write_trace_header, NULL);
 466
 467   lttv_hooks_remove_data(before_traceset, write_traceset_header, NULL);
 468
 469   lttv_hooks_remove_data(after_traceset, write_traceset_footer, NULL);
 470 }
 471
 472
 473 LTTV_MODULE("textDump", "Print events in a file", \
 474             "Produce a detailed text printout of a trace", \
 475             init, destroy, "stats", "batchAnalysis", "option", "print")
 476