apply patch by Gabriel Matni to add format string support for event fields

[lttv.git] / ltt / branches / poly / lttv / lttv / print.c

/* This file is part of the Linux Trace Toolkit viewer
 * Copyright (C) 2003-2004 Michel Dagenais
 *               2005 Mathieu Desnoyers
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License Version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, 
 * MA 02111-1307, USA.
 */

/* print.c
 *
 * Event printing routines.
 */

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include <lttv/lttv.h>
#include <lttv/option.h>
#include <lttv/module.h>
#include <lttv/hook.h>
#include <lttv/attribute.h>
#include <lttv/iattribute.h>
#include <lttv/stats.h>
#include <lttv/filter.h>
#include <lttv/print.h>
#include <ltt/ltt.h>
#include <ltt/event.h>
#include <ltt/type.h>
#include <ltt/trace.h>
#include <ltt/facility.h>
#include <stdio.h>
#include <ctype.h>
#include<ltt/ltt-private.h>
#include <string.h>


void lttv_print_field(LttEvent *e, LttField *f, GString *s,
                      gboolean field_names, guint element_index) {

  LttType *type;

  GQuark name;

  int nb, i;

  type = ltt_field_type(f);

  switch(ltt_type_class(type)) {
    case LTT_SHORT:
    case LTT_INT:
    case LTT_LONG:
    case LTT_SSIZE_T:
    case LTT_INT_FIXED:
      if(field_names) {
        name = ltt_field_name(f);
        if(name)
          g_string_append_printf(s, "%s = ", g_quark_to_string(name));
      }

      //g_string_append_printf(s, "%lld", ltt_event_get_long_int(e,f));
       g_string_append_printf(s, type->fmt, ltt_event_get_long_int(e,f));
       break;

    case LTT_USHORT:
    case LTT_UINT:
    case LTT_ULONG:
    case LTT_SIZE_T:
    case LTT_OFF_T:
    case LTT_UINT_FIXED:
      if(field_names) {
        name = ltt_field_name(f);
        if(name)
          g_string_append_printf(s, "%s = ", g_quark_to_string(name));
      }
      // g_string_append_printf(s, "%llu", ltt_event_get_long_unsigned(e,f));
      g_string_append_printf(s, type->fmt, ltt_event_get_long_unsigned(e,f));
      break;
    
    case LTT_CHAR:
    case LTT_UCHAR:
      {
        unsigned car = ltt_event_get_unsigned(e,f);
        if(field_names) {
          name = ltt_field_name(f);
          if(name)
            g_string_append_printf(s, "%s = ", g_quark_to_string(name));
        }
        if(isprint(car)) {
          if(field_names) {
            name = ltt_field_name(f);
            if(name)
              g_string_append_printf(s, "%s = ", g_quark_to_string(name));
          }
          //g_string_append_printf(s, "%c", car);
	  g_string_append_printf(s, type->fmt, car);
        } else {
          g_string_append_printf(s, "\\%x", car);
        }
      }
      break;
    case LTT_FLOAT:
     if(field_names) {
        name = ltt_field_name(f);
        if(name)
          g_string_append_printf(s, "%s = ", g_quark_to_string(name));
      }
     //g_string_append_printf(s, "%g", ltt_event_get_double(e,f));
      g_string_append_printf(s, type->fmt, ltt_event_get_double(e,f));
      break;

    case LTT_POINTER:
      if(field_names) {
        name = ltt_field_name(f);
        if(name)
          g_string_append_printf(s, "%s = ", g_quark_to_string(name));
      }
      // g_string_append_printf(s, "0x%llx", ltt_event_get_long_unsigned(e,f));
      g_string_append_printf(s, type->fmt, ltt_event_get_long_unsigned(e,f));
      break;

    case LTT_STRING:
      if(field_names) {
        name = ltt_field_name(f);
        if(name)
          g_string_append_printf(s, "%s = ", g_quark_to_string(name));
      }
      g_string_append_printf(s, "\"%s\"", ltt_event_get_string(e,f));
      break;

    case LTT_ENUM:
      {
        GQuark value = ltt_enum_string_get(type, ltt_event_get_unsigned(e,f));
        if(field_names) {
          name = ltt_field_name(f);
          if(name)
            g_string_append_printf(s, "%s = ", g_quark_to_string(name));
        }
        if(value)
          g_string_append_printf(s, "%s", g_quark_to_string(value));
        else
          g_string_append_printf(s, "%lld", ltt_event_get_long_int(e,f));
      }
      break;

    case LTT_ARRAY:
    case LTT_SEQUENCE:
      if(field_names) {
        name = ltt_field_name(f);
        if(name)
          g_string_append_printf(s, "%s = ", g_quark_to_string(name));
      }
      // g_string_append_printf(s, "{ ");
      //Insert header
      g_string_append_printf(s, type->header);//tested, works fine.


      nb = ltt_event_field_element_number(e,f);
      for(i = 0 ; i < nb ; i++) {
        LttField *child = ltt_event_field_element_select(e,f,i);
        lttv_print_field(e, child, s, field_names, i);
	if(i<nb-1)
	  g_string_append_printf(s,type->separator);
      }
      //g_string_append_printf(s, " }");
      //Insert footer
      g_string_append_printf(s, type->footer);//tested, works fine.
      break;

    case LTT_STRUCT:
      if(field_names) {
        name = ltt_field_name(f);
        if(name)
          g_string_append_printf(s, "%s = ", g_quark_to_string(name));
      }
      //      g_string_append_printf(s, "{ ");
      //Insert header
      g_string_append_printf(s, type->header);

      nb = ltt_type_member_number(type);
      for(i = 0 ; i < nb ; i++) {
        LttField *element;
        element = ltt_field_member(f,i);
        lttv_print_field(e, element, s, field_names, i);
	if(i < nb-1)
	  g_string_append_printf(s,type->separator);
      }
      //g_string_append_printf(s, " }");
      //Insert footer
      g_string_append_printf(s, type->footer);
      break;

    case LTT_UNION:
      if(field_names) {
        name = ltt_field_name(f);
        if(name)
          g_string_append_printf(s, "%s = ", g_quark_to_string(name));
      }
      //      g_string_append_printf(s, "{ ");
      g_string_append_printf(s, type->header);

      nb = ltt_type_member_number(type);
      for(i = 0 ; i < nb ; i++) {
        LttField *element;
        element = ltt_field_member(f,i);
        lttv_print_field(e, element, s, field_names, i);
	if(i<nb-1)
	  g_string_append_printf(s, type->separator);
      }
      //      g_string_append_printf(s, " }");
      g_string_append_printf(s, type->footer);
      break;
    case LTT_NONE:
      break;
  }
}

void lttv_event_to_string(LttEvent *e, GString *s,
    gboolean mandatory_fields, gboolean field_names, LttvTracefileState *tfs)
{ 
  LttFacility *facility;

  LttEventType *event_type;

  LttField *field;

  LttTime time;

  guint cpu = tfs->cpu;
  LttvTraceState *ts = (LttvTraceState*)tfs->parent.t_context;
  LttvProcessState *process = ts->running_process[cpu];

  GQuark name;

  guint i, num_fields;

  s = g_string_set_size(s,0);

  facility = ltt_event_facility(e);
  event_type = ltt_event_eventtype(e);

  if(mandatory_fields) {
    time = ltt_event_time(e);
    g_string_append_printf(s,"%s.%s: %ld.%09ld (%s%s_%u)",
        g_quark_to_string(ltt_facility_name(facility)),
        g_quark_to_string(ltt_eventtype_name(event_type)),
        (long)time.tv_sec, time.tv_nsec,
	g_quark_to_string(
		ltt_trace_name(ltt_tracefile_get_trace(tfs->parent.tf))),
        g_quark_to_string(ltt_tracefile_name(tfs->parent.tf)),
        cpu);
    /* Print the process id and the state/interrupt type of the process */
    g_string_append_printf(s,", %u, %u, %s, %s, %u, 0x%llX, %s", process->pid,
        process->tgid,
        g_quark_to_string(process->name),
        g_quark_to_string(process->brand),
        process->ppid, process->current_function,
        g_quark_to_string(process->state->t));
  }
  event_type = ltt_event_eventtype(e);
  
  num_fields = ltt_eventtype_num_fields(event_type);
  if(num_fields == 0) return;
  g_string_append_printf(s, " ");
  g_string_append_printf(s, "{ ");
  for(i=0; i<num_fields; i++) {
    field = ltt_eventtype_field(event_type, i);
    lttv_print_field(e, field, s, field_names, i);
    //should add ',' here
    if(i<num_fields-1)
      g_string_append_printf(s,", ");//tested: works fine
  }
  g_string_append_printf(s, " }");
} 

static void init()
{
}

static void destroy()
{
}

LTTV_MODULE("print", "Print events", \
      "Produce a detailed text printout of events", \
      init, destroy)