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