ltt/branches/poly/ltt/ltt-private.h

   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 #ifndef LTT_PRIVATE_H
  20 #define LTT_PRIVATE_H
  21
  22 #include <glib.h>
  23 #include <sys/types.h>
  24 #include <ltt/ltt.h>
  25
  26 #define LTT_PACKED_STRUCT __attribute__ ((packed))
  27
  28 /* enumeration definition */
  29
  30 typedef enum _BuildinEvent{
  31   TRACE_FACILITY_LOAD = 0,
  32   TRACE_BLOCK_START   = 17,
  33   TRACE_BLOCK_END     = 18,
  34   TRACE_TIME_HEARTBEAT= 19
  35 } BuildinEvent;
  36
  37
  38 /* structure definition */
  39
  40 typedef struct _FacilityLoad{
  41   char * name;
  42   LttChecksum checksum;
  43   guint32     base_code;
  44 } LTT_PACKED_STRUCT FacilityLoad;
  45
  46 typedef struct _BlockStart {
  47   LttTime       time;        //Time stamp of this block
  48   LttCycleCount cycle_count; //cycle count of the event
  49   guint32       block_id;    //block id
  50 } LTT_PACKED_STRUCT BlockStart;
  51
  52 typedef struct _BlockEnd {
  53   LttTime       time;        //Time stamp of this block
  54   LttCycleCount cycle_count; //cycle count of the event
  55   guint32       block_id;    //block id
  56 } LTT_PACKED_STRUCT BlockEnd;
  57
  58 typedef struct _TimeHeartbeat {
  59   LttTime       time;        //Time stamp of this block
  60   LttCycleCount cycle_count; //cycle count of the event
  61 } LTT_PACKED_STRUCT TimeHeartbeat;
  62
  63
  64 struct _LttType{
  65   char * type_name;                //type name if it is a named type
  66   char * element_name;             //elements name of the struct
  67   char * fmt;
  68   unsigned int size;
  69   LttTypeEnum type_class;          //which type
  70   char ** enum_strings;            //for enum labels
  71   struct _LttType ** element_type; //for array, sequence and struct
  72   unsigned element_number;         //the number of elements
  73                                    //for enum, array, sequence and structure
  74 };
  75
  76 struct _LttEventType{
  77   char * name;
  78   char * description;
  79   int index;              //id of the event type within the facility
  80   LttFacility * facility; //the facility that contains the event type
  81   LttField * root_field;  //root field
  82   unsigned int latest_block;       //the latest block using the event type
  83   unsigned int latest_event;       //the latest event using the event type
  84 };
  85
  86 struct _LttEvent{
  87   guint16  event_id;
  88   guint32  time_delta;
  89   LttTime event_time;
  90   LttCycleCount event_cycle_count;
  91   LttTracefile * tracefile;
  92   void * data;               //event data
  93   unsigned int which_block;           //the current block of the event
  94   unsigned int which_event;           //the position of the event
  95   /* This is a workaround for fast position seek */
  96   void * last_event_pos;
  97
  98   LttTime prev_block_end_time;       //the end time of previous block
  99   LttTime prev_event_time;           //the time of the previous event
 100   LttCycleCount pre_cycle_count;     //previous cycle count of the event
 101   int      count;                    //the number of overflow of cycle count
 102   gint64 overflow_nsec;              //precalculated nsec for overflows
 103   /* end of workaround */
 104 };
 105
 106
 107 struct _LttField{
 108   unsigned field_pos;        //field position within its parent
 109   LttType * field_type;      //field type, if it is root field
 110                              //then it must be struct type
 111
 112   off_t offset_root;         //offset from the root, -1:uninitialized
 113   short fixed_root;          //offset fixed according to the root
 114                              //-1:uninitialized, 0:unfixed, 1:fixed
 115   off_t offset_parent;       //offset from the parent,-1:uninitialized
 116   short fixed_parent;        //offset fixed according to its parent
 117                              //-1:uninitialized, 0:unfixed, 1:fixed
 118   //  void * base_address;       //base address of the field  ????
 119
 120   int  field_size;           //>0: size of the field,
 121                              //0 : uncertain
 122                              //-1: uninitialize
 123   int sequ_number_size;      //the size of unsigned used to save the
 124                              //number of elements in the sequence
 125
 126   int element_size;          //the element size of the sequence
 127   int field_fixed;           //0: field has string or sequence
 128                              //1: field has no string or sequenc
 129                              //-1: uninitialize
 130
 131   struct _LttField * parent;
 132   struct _LttField ** child; //for array, sequence and struct:
 133                              //list of fields, it may have only one
 134                              //field if the element is not a struct
 135   unsigned current_element;  //which element is currently processed
 136 };
 137
 138
 139 struct _LttFacility{
 140   char * name;               //facility name
 141   unsigned int event_number;          //number of events in the facility
 142   LttChecksum checksum;      //checksum of the facility
 143   guint32  base_id;          //base id of the facility
 144   LttEventType ** events;    //array of event types
 145   LttType ** named_types;
 146   unsigned int named_types_number;
 147 };
 148
 149 struct _LttTracefile{
 150   char * name;                       //tracefile name
 151   LttTrace * trace;                  //trace containing the tracefile
 152   int fd;                            //file descriptor
 153   off_t file_size;                   //file size
 154   unsigned block_size;               //block_size
 155   unsigned int block_number;         //number of blocks in the file
 156   unsigned int which_block;          //which block the current block is
 157   unsigned int which_event;          //which event of the current block
 158                                      //is currently processed
 159   LttTime current_event_time;        //time of the current event
 160   BlockStart * a_block_start;        //block start of the block
 161   BlockEnd   * a_block_end;          //block end of the block
 162   void * cur_event_pos;              //the position of the current event
 163   void * buffer;                     //the buffer containing the block
 164   double nsec_per_cycle;             //Nsec per cycle
 165   guint64 one_overflow_nsec;         //nsec for one overflow
 166   gint64 overflow_nsec;              //precalculated nsec for overflows
 167                                      //can be negative to include value
 168                                      //of block start cycle count.
 169                                      //incremented at each overflow while
 170                                      //reading.
 171   //LttCycleCount cycles_per_nsec_reciprocal; // Optimisation for speed
 172   unsigned cur_heart_beat_number;    //current number of heart beat in the buf
 173   LttCycleCount cur_cycle_count;     //current cycle count of the event
 174   void * last_event_pos;
 175
 176   LttTime prev_block_end_time;       //the end time of previous block
 177   LttTime prev_event_time;           //the time of the previous event
 178   LttCycleCount pre_cycle_count;     //previous cycle count of the event
 179   unsigned int      count;           //the number of overflow of cycle count
 180 };
 181
 182 struct _LttTrace{
 183   char * pathname;                          //the pathname of the trace
 184   guint facility_number;                    //the number of facilities
 185   guint control_tracefile_number;           //the number of control files
 186   guint per_cpu_tracefile_number;           //the number of per cpu files
 187   LttSystemDescription * system_description;//system description
 188
 189   GPtrArray *control_tracefiles;            //array of control tracefiles
 190   GPtrArray *per_cpu_tracefiles;            //array of per cpu tracefiles
 191   GPtrArray *facilities;                    //array of facilities
 192   LttArchSize my_arch_size;                 //data size of the local machine
 193   LttArchEndian my_arch_endian;             //endian type of the local machine
 194 };
 195
 196 struct _LttEventPosition{
 197   unsigned      block_num;          //block which contains the event
 198   unsigned      event_num;          //event index in the block
 199   unsigned      event_offset;       //event position in the block
 200   LttTime       event_time;         //the time of the event
 201   LttCycleCount event_cycle_count;  //the cycle count of the event
 202   unsigned      heart_beat_number;  //current number of heart beats
 203   LttTracefile *tf;                 //tracefile containing the event
 204   gboolean      old_position;       //flag to show if it is the position
 205                                     //being remembered
 206   /* This is a workaround for fast position seek */
 207   void * last_event_pos;
 208
 209   LttTime prev_block_end_time;       //the end time of previous block
 210   LttTime prev_event_time;           //the time of the previous event
 211   LttCycleCount pre_cycle_count;     //previous cycle count of the event
 212   int      count;                    //the number of overflow of cycle count
 213   gint64 overflow_nsec;              //precalculated nsec for overflows
 214   /* end of workaround */
 215 };
 216
 217 /* The characteristics of the system on which the trace was obtained
 218    is described in a LttSystemDescription structure. */
 219
 220 struct _LttSystemDescription {
 221   char *description;
 222   char *node_name;
 223   char *domain_name;
 224   unsigned nb_cpu;
 225   LttArchSize size;
 226   LttArchEndian endian;
 227   char *kernel_name;
 228   char *kernel_release;
 229   char *kernel_version;
 230   char *machine;
 231   char *processor;
 232   char *hardware_platform;
 233   char *operating_system;
 234   unsigned ltt_major_version;
 235   unsigned ltt_minor_version;
 236   unsigned ltt_block_size;
 237   LttTime trace_start;
 238   LttTime trace_end;
 239 };
 240
 241 /*****************************************************************************
 242  macro for size of some data types
 243  *****************************************************************************/
 244 #define EVENT_ID_SIZE     sizeof(guint16)
 245 #define TIME_DELTA_SIZE   sizeof(guint32)
 246 #define EVENT_HEADER_SIZE (EVENT_ID_SIZE + TIME_DELTA_SIZE)
 247
 248
 249 #endif /* LTT_PRIVATE_H */