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