ltt/branches/poly/ltt/event.c

   1 /* This file is part of the Linux Trace Toolkit viewer
   2  * Copyright (C) 2003-2004 Xiangxiu Yang
   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 #include <stdio.h>
  20 #include <asm/types.h>
  21 #include <linux/byteorder/swab.h>
  22
  23 #include "parser.h"
  24 #include <ltt/ltt.h>
  25 #include "ltt-private.h"
  26 #include <ltt/event.h>
  27 #include <ltt/trace.h>
  28
  29 /*****************************************************************************
  30  *Function name
  31  *    ltt_event_refresh_fields   : refresh fields of an event
  32  *Input params
  33  *    offsetRoot      : offset from the root
  34  *    offsetParent    : offset from the parrent
  35  *    fld             : field
  36  *    evD             : event data
  37  *Return value
  38  *    int             : size of the field
  39  ****************************************************************************/
  40
  41 int ltt_event_refresh_fields(int offsetRoot,int offsetParent,
  42                              LttField * fld, void *evD)
  43 {
  44   int size, size1, element_number, i, offset1, offset2;
  45   LttType * type = fld->field_type;
  46
  47   if(type->type_class != LTT_STRUCT && type->type_class != LTT_ARRAY &&
  48      type->type_class != LTT_SEQUENCE && type->type_class != LTT_STRING){
  49     size = fld->field_size;
  50   }else if(type->type_class == LTT_ARRAY){
  51     element_number = (int) type->element_number;
  52     if(fld->field_fixed == 0){// has string or sequence
  53       size = 0;
  54       for(i=0;i<element_number;i++){
  55         size += ltt_event_refresh_fields(offsetRoot+size,size,
  56                                          fld->child[0], evD+size);
  57       }
  58     }else size = fld->field_size;
  59   }else if(type->type_class == LTT_SEQUENCE){
  60     size1 = fld->sequ_number_size;
  61     element_number = getIntNumber(size1,evD);
  62     type->element_number = element_number;
  63     if(fld->element_size > 0){
  64       size = element_number * fld->element_size;
  65     }else{//sequence has string or sequence
  66       size = 0;
  67       for(i=0;i<element_number;i++){
  68         size += ltt_event_refresh_fields(offsetRoot+size+size1,size+size1,
  69                                          fld->child[0], evD+size+size1);
  70       }
  71       size += size1;
  72     }
  73   }else if(type->type_class == LTT_STRING){
  74     size = strlen((char*)evD) + 1; //include end : '\0'
  75   }else if(type->type_class == LTT_STRUCT){
  76     element_number = (int) type->element_number;
  77     if(fld->field_fixed == 0){
  78       offset1 = offsetRoot;
  79       offset2 = 0;
  80       for(i=0;i<element_number;i++){
  81         size=ltt_event_refresh_fields(offset1,offset2,fld->child[i],evD+offset2);
  82         offset1 += size;
  83         offset2 += size;
  84       }
  85       size = offset2;
  86     }else size = fld->field_size;
  87   }
  88
  89   fld->offset_root     = offsetRoot;
  90   fld->offset_parent   = offsetParent;
  91   fld->fixed_root      = (offsetRoot==-1)   ? 0 : 1;
  92   fld->fixed_parent    = (offsetParent==-1) ? 0 : 1;
  93   fld->field_size      = size;
  94
  95   return size;
  96 }
  97
  98 /*****************************************************************************
  99  *Function name
 100  *    ltt_event_eventtype_id: get event type id
 101  *                            (base id + position of the event)
 102  *Input params
 103  *    e                     : an instance of an event type
 104  *Return value
 105  *    unsigned              : event type id
 106  ****************************************************************************/
 107
 108 unsigned ltt_event_eventtype_id(LttEvent *e)
 109 {
 110   return (unsigned) e->event_id;
 111 }
 112
 113 /*****************************************************************************
 114  *Function name
 115  *    ltt_event_facility : get the facility of the event
 116  *Input params
 117  *    e                  : an instance of an event type
 118  *Return value
 119  *    LttFacility *     : the facility of the event
 120  ****************************************************************************/
 121
 122 LttFacility *ltt_event_facility(LttEvent *e)
 123 {
 124   LttTrace * trace = e->tracefile->trace;
 125   unsigned id = e->event_id;
 126   return ltt_trace_facility_by_id(trace,id);
 127 }
 128
 129 /*****************************************************************************
 130  *Function name
 131  *    ltt_event_eventtype : get the event type of the event
 132  *Input params
 133  *    e                   : an instance of an event type
 134  *Return value
 135  *    LttEventType *     : the event type of the event
 136  ****************************************************************************/
 137
 138 LttEventType *ltt_event_eventtype(LttEvent *e)
 139 {
 140   LttFacility* facility = ltt_event_facility(e);
 141   if(!facility) return NULL;
 142   return facility->events[e->event_id - facility->base_id];
 143 }
 144
 145 /*****************************************************************************
 146  *Function name
 147  *    ltt_event_field : get the root field of the event
 148  *Input params
 149  *    e               : an instance of an event type
 150  *Return value
 151  *    LttField *      : the root field of the event
 152  ****************************************************************************/
 153
 154 LttField *ltt_event_field(LttEvent *e)
 155 {
 156   LttField * field;
 157   LttEventType * event_type = ltt_event_eventtype(e);
 158   if(!event_type) return NULL;
 159   field = event_type->root_field;
 160   if(!field) return NULL;
 161
 162   //check if the field need refresh
 163   if(e->which_block != event_type->latest_block ||
 164      e->which_event != event_type->latest_event){
 165
 166     event_type->latest_block = e->which_block;
 167     event_type->latest_event = e->which_event;
 168
 169     if(field->field_fixed == 1)return field;
 170
 171     //refresh the field
 172     ltt_event_refresh_fields(0, 0, field, e->data);
 173   }
 174   return field;
 175 }
 176
 177 /*****************************************************************************
 178  *Function name
 179  *    ltt_event_time : get the time of the event
 180  *Input params
 181  *    e              : an instance of an event type
 182  *Return value
 183  *    LttTime       : the time of the event
 184  ****************************************************************************/
 185
 186 LttTime ltt_event_time(LttEvent *e)
 187 {
 188   return e->event_time;
 189 }
 190
 191 /*****************************************************************************
 192  *Function name
 193  *    ltt_event_time : get the cycle count of the event
 194  *Input params
 195  *    e              : an instance of an event type
 196  *Return value
 197  *    LttCycleCount  : the cycle count of the event
 198  ****************************************************************************/
 199
 200 LttCycleCount ltt_event_cycle_count(LttEvent *e)
 201 {
 202   return e->event_cycle_count;
 203 }
 204
 205 /*****************************************************************************
 206  *Function name
 207  *    ltt_event_position : get the event's position
 208  *Input params
 209  *    e                  : an instance of an event type
 210  *    ep                 : a pointer to event's position structure
 211  ****************************************************************************/
 212
 213 void ltt_event_position(LttEvent *e, LttEventPosition *ep)
 214 {
 215   ep->block_num         = e->which_block;
 216   ep->event_num         = e->which_event;
 217   ep->event_time        = e->event_time;
 218   ep->event_cycle_count = e->event_cycle_count;
 219   ep->heart_beat_number = e->tracefile->cur_heart_beat_number;
 220   ep->old_position      = FALSE;
 221   ep->event_offset      = e->data - e->tracefile->buffer - EVENT_HEADER_SIZE ;
 222   ep->tf                = e->tracefile;
 223 }
 224
 225 LttEventPosition * ltt_event_position_new()
 226 {
 227   return g_new(LttEventPosition, 1);
 228 }
 229
 230 /*****************************************************************************
 231  *Function name
 232  *    ltt_event_position_get : get the block number and index of the event
 233  *Input params
 234  *    ep                     : a pointer to event's position structure
 235  *    block_number           : the block number of the event
 236  *    index_in_block         : the index of the event within the block
 237  ****************************************************************************/
 238
 239 void ltt_event_position_get(LttEventPosition *ep,
 240     unsigned *block_number, unsigned *index_in_block, LttTracefile ** tf)
 241 {
 242   *block_number   = ep->block_num;
 243   *index_in_block = ep->event_num;
 244   *tf             = ep->tf;
 245 }
 246
 247 /*****************************************************************************
 248  *Function name
 249  *    ltt_event_position_set : set the block number and index of the event
 250  *Input params
 251  *    ep                     : a pointer to event's position structure
 252  *    block_number           : the block number of the event
 253  *    index_in_block         : the index of the event within the block
 254  ****************************************************************************/
 255
 256 void ltt_event_position_set(LttEventPosition *ep,
 257     unsigned block_number, unsigned index_in_block)
 258 {
 259   ep->block_num = block_number;
 260   ep->event_num = index_in_block;
 261 }
 262
 263 /*****************************************************************************
 264  * Function name
 265  *    ltt_event_position_compare : compare two positions
 266  * Input params
 267  *    ep1                    : a pointer to event's position structure
 268  *    ep2                    : a pointer to event's position structure
 269  * Return
 270  *    -1 is ep1 < ep2
 271  *    1 if ep1 > ep2
 272  *    0 if ep1 == ep2
 273  ****************************************************************************/
 274
 275
 276 gint ltt_event_position_compare(const LttEventPosition *ep1,
 277                                 const LttEventPosition *ep2)
 278 {
 279   if(ep1->tf != ep2->tf)
 280     g_error("ltt_event_position_compare on different tracefiles makes no sense");
 281   if(ep1->block_num < ep2->block_num)
 282     return -1;
 283   if(ep1->block_num > ep2->block_num)
 284     return 1;
 285   if(ep1->event_num < ep2->event_num)
 286     return -1;
 287   if(ep1->event_num > ep2->event_num)
 288     return 1;
 289   return 0;
 290 }
 291
 292 /*****************************************************************************
 293  * Function name
 294  *    ltt_event_event_position_compare : compare two positions, one in event,
 295  *    other in position opaque structure.
 296  * Input params
 297  *    event                  : a pointer to event structure
 298  *    ep                     : a pointer to event's position structure
 299  * Return
 300  *    -1 is event < ep
 301  *    1 if event > ep
 302  *    0 if event == ep
 303  ****************************************************************************/
 304
 305 gint ltt_event_event_position_compare(const LttEvent *event,
 306                                       const LttEventPosition *ep)
 307 {
 308   g_assert(event->tracefile == ep->tf);
 309
 310   if(event->which_block < ep->block_num)
 311     return -1;
 312   if(event->which_block > ep->block_num)
 313     return 1;
 314   if(event->which_event < ep->event_num)
 315     return -1;
 316   if(event->which_event > ep->event_num)
 317     return 1;
 318   return 0;
 319 }
 320
 321 /*****************************************************************************
 322  * Function name
 323  *    ltt_event_position_copy : copy position
 324  * Input params
 325  *    src                    : a pointer to event's position structure source
 326  *    dest                   : a pointer to event's position structure dest
 327  * Return
 328  *    void
 329  ****************************************************************************/
 330 void ltt_event_position_copy(LttEventPosition *dest,
 331                              const LttEventPosition *src)
 332 {
 333   *dest = *src;
 334 }
 335
 336
 337 /*****************************************************************************
 338  *Function name
 339  *    ltt_event_cpu_i: get the cpu id where the event happens
 340  *Input params
 341  *    e              : an instance of an event type
 342  *Return value
 343  *    unsigned       : the cpu id
 344  ****************************************************************************/
 345
 346 unsigned ltt_event_cpu_id(LttEvent *e)
 347 {
 348   char * c1, * c2, * c3;
 349   c1 = strrchr(e->tracefile->name,'\\');
 350   c2 = strrchr(e->tracefile->name,'/');
 351   if(c1 == NULL && c2 == NULL){
 352     return (unsigned)atoi(e->tracefile->name);
 353   }else if(c1 == NULL){
 354     c2++;
 355     return (unsigned)atoi(c2);
 356   }else if(c2 == NULL){
 357     c1++;
 358     return (unsigned)atoi(c1);
 359   }else{
 360     c3 = (c1 > c2) ? c1 : c2;
 361     c3++;
 362     return (unsigned)atoi(c3);
 363   }
 364 }
 365
 366 /*****************************************************************************
 367  *Function name
 368  *    ltt_event_data : get the raw data for the event
 369  *Input params
 370  *    e              : an instance of an event type
 371  *Return value
 372  *    void *         : pointer to the raw data for the event
 373  ****************************************************************************/
 374
 375 void *ltt_event_data(LttEvent *e)
 376 {
 377   return e->data;
 378 }
 379
 380 /*****************************************************************************
 381  *Function name
 382  *    ltt_event_field_element_number
 383  *                   : The number of elements in a sequence field is specific
 384  *                     to each event. This function returns the number of
 385  *                     elements for an array or sequence field in an event.
 386  *Input params
 387  *    e              : an instance of an event type
 388  *    f              : a field of the instance
 389  *Return value
 390  *    unsigned       : the number of elements for an array/sequence field
 391  ****************************************************************************/
 392
 393 unsigned ltt_event_field_element_number(LttEvent *e, LttField *f)
 394 {
 395   if(f->field_type->type_class != LTT_ARRAY &&
 396      f->field_type->type_class != LTT_SEQUENCE)
 397     return 0;
 398
 399   if(f->field_type->type_class == LTT_ARRAY)
 400     return f->field_type->element_number;
 401   return (unsigned)  getIntNumber(f->sequ_number_size, e + f->offset_root);
 402 }
 403
 404 /*****************************************************************************
 405  *Function name
 406  *    ltt_event_field_element_select
 407  *                   : Set the currently selected element for a sequence or
 408  *                     array field
 409  *Input params
 410  *    e              : an instance of an event type
 411  *    f              : a field of the instance
 412  *    i              : the ith element
 413  ****************************************************************************/
 414
 415 void ltt_event_field_element_select(LttEvent *e, LttField *f, unsigned i)
 416 {
 417   unsigned element_number;
 418   LttField *fld;
 419   int k, size;
 420   void *evD;
 421
 422   if(f->field_type->type_class != LTT_ARRAY &&
 423      f->field_type->type_class != LTT_SEQUENCE)
 424     return ;
 425
 426   element_number  = ltt_event_field_element_number(e,f);
 427   if((element_number-1) < i || i < 0) return;
 428
 429   fld = f->child[0];
 430
 431   evD = e->data + f->offset_root;
 432   size = 0;
 433   for(k=0;k<i;k++){
 434     size += ltt_event_refresh_fields(f->offset_root+size,size, fld, evD+size);
 435   }
 436
 437   f->current_element = i - 1;
 438 }
 439
 440 /*****************************************************************************
 441  * These functions extract data from an event after architecture specific
 442  * conversions
 443  ****************************************************************************/
 444
 445 unsigned ltt_event_get_unsigned(LttEvent *e, LttField *f)
 446 {
 447   int revFlag = e->tracefile->trace->my_arch_endian ==
 448                 e->tracefile->trace->system_description->endian ? 0:1;
 449   LttTypeEnum t = f->field_type->type_class;
 450
 451   g_assert(t == LTT_UINT || t == LTT_ENUM);
 452
 453   if(f->field_size == 1){
 454     guint8 x = *(guint8 *)(e->data + f->offset_root);
 455     return (unsigned int) x;
 456   }else if(f->field_size == 2){
 457     guint16 x = *(guint16 *)(e->data + f->offset_root);
 458     if(e->tracefile->trace->my_arch_endian == LTT_LITTLE_ENDIAN)
 459       return (unsigned int) (revFlag ? GUINT16_FROM_BE(x): x);
 460     else
 461       return (unsigned int) (revFlag ? GUINT16_FROM_LE(x): x);
 462   }else if(f->field_size == 4){
 463     guint32 x = *(guint32 *)(e->data + f->offset_root);
 464     if(e->tracefile->trace->my_arch_endian == LTT_LITTLE_ENDIAN)
 465       return (unsigned int) (revFlag ? GUINT32_FROM_BE(x): x);
 466     else
 467       return (unsigned int) (revFlag ? GUINT32_FROM_LE(x): x);
 468   }else if(f->field_size == 8){
 469     guint64 x = *(guint64 *)(e->data + f->offset_root);
 470     if(e->tracefile->trace->my_arch_endian == LTT_LITTLE_ENDIAN)
 471       return (unsigned int) (revFlag ? GUINT64_FROM_BE(x): x);
 472     else
 473       return (unsigned int) (revFlag ? GUINT64_FROM_LE(x): x);
 474   }
 475 }
 476
 477 int ltt_event_get_int(LttEvent *e, LttField *f)
 478 {
 479   int revFlag = e->tracefile->trace->my_arch_endian ==
 480                 e->tracefile->trace->system_description->endian ? 0:1;
 481
 482   g_assert(f->field_type->type_class == LTT_INT);
 483
 484   if(f->field_size == 1){
 485     gint8 x = *(gint8 *)(e->data + f->offset_root);
 486     return (int) x;
 487   }else if(f->field_size == 2){
 488     gint16 x = *(gint16 *)(e->data + f->offset_root);
 489     if(e->tracefile->trace->my_arch_endian == LTT_LITTLE_ENDIAN)
 490       return (int) (revFlag ? GINT16_FROM_BE(x): x);
 491     else
 492       return (int) (revFlag ? GINT16_FROM_LE(x): x);
 493   }else if(f->field_size == 4){
 494     gint32 x = *(gint32 *)(e->data + f->offset_root);
 495     if(e->tracefile->trace->my_arch_endian == LTT_LITTLE_ENDIAN)
 496       return (int) (revFlag ? GINT32_FROM_BE(x): x);
 497     else
 498       return (int) (revFlag ? GINT32_FROM_LE(x): x);
 499   }else if(f->field_size == 8){
 500     gint64 x = *(gint64 *)(e->data + f->offset_root);
 501     if(e->tracefile->trace->my_arch_endian == LTT_LITTLE_ENDIAN)
 502       return (int) (revFlag ? GINT64_FROM_BE(x): x);
 503     else
 504       return (int) (revFlag ? GINT64_FROM_LE(x): x);
 505   }
 506 }
 507
 508 unsigned long ltt_event_get_long_unsigned(LttEvent *e, LttField *f)
 509 {
 510   int revFlag = e->tracefile->trace->my_arch_endian ==
 511                 e->tracefile->trace->system_description->endian ? 0:1;
 512   LttTypeEnum t = f->field_type->type_class;
 513
 514   g_assert(t == LTT_UINT || t == LTT_ENUM);
 515
 516   if(f->field_size == 1){
 517     guint8 x = *(guint8 *)(e->data + f->offset_root);
 518     return (unsigned long) x;
 519   }else if(f->field_size == 2){
 520     guint16 x = *(guint16 *)(e->data + f->offset_root);
 521     if(e->tracefile->trace->my_arch_endian == LTT_LITTLE_ENDIAN)
 522       return (unsigned long) (revFlag ? GUINT16_FROM_BE(x): x);
 523     else
 524       return (unsigned long) (revFlag ? GUINT16_FROM_LE(x): x);
 525   }else if(f->field_size == 4){
 526     guint32 x = *(guint32 *)(e->data + f->offset_root);
 527     if(e->tracefile->trace->my_arch_endian == LTT_LITTLE_ENDIAN)
 528       return (unsigned long) (revFlag ? GUINT32_FROM_BE(x): x);
 529     else
 530       return (unsigned long) (revFlag ? GUINT32_FROM_LE(x): x);
 531   }else if(f->field_size == 8){
 532     guint64 x = *(guint64 *)(e->data + f->offset_root);
 533     if(e->tracefile->trace->my_arch_endian == LTT_LITTLE_ENDIAN)
 534       return (unsigned long) (revFlag ? GUINT64_FROM_BE(x): x);
 535     else
 536       return (unsigned long) (revFlag ? GUINT64_FROM_LE(x): x);
 537   }
 538 }
 539
 540 long int ltt_event_get_long_int(LttEvent *e, LttField *f)
 541 {
 542   int revFlag = e->tracefile->trace->my_arch_endian ==
 543                 e->tracefile->trace->system_description->endian ? 0:1;
 544
 545   g_assert( f->field_type->type_class == LTT_INT);
 546
 547   if(f->field_size == 1){
 548     gint8 x = *(gint8 *)(e->data + f->offset_root);
 549     return (long) x;
 550   }else if(f->field_size == 2){
 551     gint16 x = *(gint16 *)(e->data + f->offset_root);
 552     if(e->tracefile->trace->my_arch_endian == LTT_LITTLE_ENDIAN)
 553       return (long) (revFlag ? GINT16_FROM_BE(x): x);
 554     else
 555       return (long) (revFlag ? GINT16_FROM_LE(x): x);
 556   }else if(f->field_size == 4){
 557     gint32 x = *(gint32 *)(e->data + f->offset_root);
 558     if(e->tracefile->trace->my_arch_endian == LTT_LITTLE_ENDIAN)
 559       return (long) (revFlag ? GINT32_FROM_BE(x): x);
 560     else
 561       return (long) (revFlag ? GINT32_FROM_LE(x): x);
 562   }else if(f->field_size == 8){
 563     gint64 x = *(gint64 *)(e->data + f->offset_root);
 564     if(e->tracefile->trace->my_arch_endian == LTT_LITTLE_ENDIAN)
 565       return (long) (revFlag ? GINT64_FROM_BE(x): x);
 566     else
 567       return (long) (revFlag ? GINT64_FROM_LE(x): x);
 568   }
 569 }
 570
 571 float ltt_event_get_float(LttEvent *e, LttField *f)
 572 {
 573   int revFlag = e->tracefile->trace->my_arch_endian ==
 574                 e->tracefile->trace->system_description->endian ? 0:1;
 575
 576   g_assert(f->field_type->type_class == LTT_FLOAT && f->field_size == 4);
 577
 578   if(revFlag == 0) return *(float *)(e->data + f->offset_root);
 579   else{
 580     guint32 aInt;
 581     memcpy((void*)&aInt, e->data + f->offset_root, 4);
 582     aInt = ___swab32(aInt);
 583     return *((float*)&aInt);
 584   }
 585 }
 586
 587 double ltt_event_get_double(LttEvent *e, LttField *f)
 588 {
 589   int revFlag = e->tracefile->trace->my_arch_endian ==
 590                 e->tracefile->trace->system_description->endian ? 0:1;
 591
 592   g_assert(f->field_type->type_class == LTT_FLOAT && f->field_size == 8);
 593
 594   if(revFlag == 0) return *(double *)(e->data + f->offset_root);
 595   else{
 596     guint64 aInt;
 597     memcpy((void*)&aInt, e->data + f->offset_root, 8);
 598     aInt = ___swab64(aInt);
 599     return *((double *)&aInt);
 600   }
 601 }
 602
 603 /*****************************************************************************
 604  * The string obtained is only valid until the next read from
 605  * the same tracefile.
 606  ****************************************************************************/
 607
 608 char *ltt_event_get_string(LttEvent *e, LttField *f)
 609 {
 610   g_assert(f->field_type->type_class == LTT_STRING);
 611
 612   return (char*)g_strdup((char*)(e->data + f->offset_root));
 613 }