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 #include <endian.h>
  26
  27
  28 #ifndef max
  29 #define max(a,b) ((a)>(b)?(a):(b))
  30 #endif
  31
  32 #ifndef min
  33 #define min(a,b) ((a)<(b)?(a):(b))
  34 #endif
  35
  36
  37
  38 #define LTT_MAGIC_NUMBER 0x00D6B7ED
  39 #define LTT_REV_MAGIC_NUMBER 0xEDB7D600
  40
  41 #define NSEC_PER_USEC 1000
  42
  43 #define LTT_PACKED_STRUCT __attribute__ ((packed))
  44
  45 /* Hardcoded facilities */
  46 #define LTT_FACILITY_CORE 0
  47
  48 /* Byte ordering */
  49 #define LTT_GET_BO(t) ((t)->reverse_bo)
  50
  51 #define LTT_HAS_FLOAT(t) ((t)->float_word_order!=0)
  52 #define LTT_GET_FLOAT_BO(t) \
  53   (((t)->float_word_order==__BYTE_ORDER)?0:1)
  54
  55 #define SEQUENCE_AVG_ELEMENTS 1000
  56
  57 /* Hardcoded core events */
  58 enum ltt_core_events {
  59     LTT_EVENT_FACILITY_LOAD,
  60     LTT_EVENT_FACILITY_UNLOAD,
  61     LTT_EVENT_HEARTBEAT,
  62     LTT_EVENT_STATE_DUMP_FACILITY_LOAD
  63 };
  64
  65
  66 #if 0
  67 /* enumeration definition */
  68
  69 typedef enum _BuildinEvent{
  70   TRACE_FACILITY_LOAD = 0,
  71   TRACE_BLOCK_START   = 17,
  72   TRACE_BLOCK_END     = 18,
  73   TRACE_TIME_HEARTBEAT= 19
  74 } BuildinEvent;
  75
  76
  77 /* structure definition */
  78
  79 typedef struct _FacilityLoad{
  80   gchar * name;
  81   LttChecksum checksum;
  82   guint32     base_code;
  83 } LTT_PACKED_STRUCT FacilityLoad;
  84
  85 typedef struct _BlockStart {
  86   LttTime       time;       //Time stamp of this block
  87   LttCycleCount cycle_count; //cycle count of the event
  88   guint32       block_id;    //block id
  89 } LTT_PACKED_STRUCT BlockStart;
  90
  91 typedef struct _BlockEnd {
  92   LttTime       time;       //Time stamp of this block
  93   LttCycleCount cycle_count; //cycle count of the event
  94   guint32       block_id;    //block id
  95 } LTT_PACKED_STRUCT BlockEnd;
  96 #endif //0
  97
  98
  99 typedef guint8 uint8_t;
 100 typedef guint16 uint16_t;
 101 typedef guint32 uint32_t;
 102 typedef guint64 uint64_t;
 103
 104 /* Hardcoded facility load event : this plus an preceding "name" string */
 105 struct LttFacilityLoad {
 106   guint32 checksum;
 107   guint32 id;
 108         guint32 int_size;
 109   guint32 long_size;
 110   guint32 pointer_size;
 111   guint32 size_t_size;
 112         guint32 has_alignment;
 113 } LTT_PACKED_STRUCT;
 114
 115 struct LttFacilityUnload {
 116   guint32 id;
 117 } LTT_PACKED_STRUCT;
 118
 119 struct LttStateDumpFacilityLoad {
 120   guint32 checksum;
 121   guint32 id;
 122         guint32 int_size;
 123   guint32 long_size;
 124   guint32 pointer_size;
 125   guint32 size_t_size;
 126         guint32 has_alignment;
 127 } LTT_PACKED_STRUCT;
 128
 129 typedef struct _TimeHeartbeat {
 130   LttTime       time;       //Time stamp of this block
 131   uint64_t cycle_count; //cycle count of the event
 132 } LTT_PACKED_STRUCT TimeHeartbeat;
 133
 134 struct ltt_event_header_hb {
 135   uint32_t      timestamp;
 136   unsigned char  facility_id;
 137   unsigned char event_id;
 138   uint16_t      event_size;
 139 } LTT_PACKED_STRUCT;
 140
 141 struct ltt_event_header_nohb {
 142   uint64_t      timestamp;
 143   unsigned char  facility_id;
 144   unsigned char event_id;
 145   uint16_t      event_size;
 146 } LTT_PACKED_STRUCT;
 147
 148
 149 /* Block and trace headers */
 150
 151 struct ltt_trace_header_any {
 152   uint32_t        magic_number;
 153   uint32_t        arch_type;
 154   uint32_t        arch_variant;
 155   uint32_t        float_word_order;
 156   uint8_t         arch_size;
 157   uint8_t         major_version;
 158   uint8_t         minor_version;
 159   uint8_t         flight_recorder;
 160   uint8_t         has_heartbeat;
 161   uint8_t         has_alignment;  /* Event header alignment */
 162         uint8_t                     has_tsc;
 163 } LTT_PACKED_STRUCT;
 164
 165
 166 /* For version 0.3 */
 167
 168 struct ltt_trace_header_0_3 {
 169   uint32_t        magic_number;
 170   uint32_t        arch_type;
 171   uint32_t        arch_variant;
 172   uint32_t        float_word_order;
 173   uint8_t         arch_size;
 174   uint8_t         major_version;
 175   uint8_t         minor_version;
 176   uint8_t         flight_recorder;
 177   uint8_t         has_heartbeat;
 178   uint8_t         has_alignment;  /* Event header alignment */
 179         uint8_t                          has_tsc;
 180 } LTT_PACKED_STRUCT;
 181
 182 /* For version 0.6 */
 183
 184 struct ltt_trace_header_0_6 {
 185   uint32_t        magic_number;
 186   uint32_t        arch_type;
 187   uint32_t        arch_variant;
 188   uint32_t        float_word_order;
 189   uint8_t         arch_size;
 190   uint8_t         major_version;
 191   uint8_t         minor_version;
 192   uint8_t         flight_recorder;
 193   uint8_t         has_heartbeat;
 194   uint8_t         has_alignment;  /* Event header alignment */
 195   uint8_t         has_tsc;
 196   uint64_t        start_freq;
 197   uint64_t        start_tsc;
 198   uint64_t        start_monotonic;
 199   //struct timespec start_time; // not portable
 200   uint64_t        start_time_sec;
 201   uint64_t        start_time_usec;
 202 } LTT_PACKED_STRUCT;
 203
 204
 205 struct ltt_block_start_header {
 206   struct {
 207     //struct timeval          timestamp;
 208     uint64_t                timestamp_sec;
 209     uint64_t                timestamp_usec;
 210     uint64_t                cycle_count;
 211     uint64_t                freq;
 212   } begin;
 213   struct {
 214     //struct timeval          timestamp;
 215     uint64_t                timestamp_sec;
 216     uint64_t                timestamp_usec;
 217     uint64_t                cycle_count;
 218     uint64_t                freq;
 219   } end;
 220   uint32_t                lost_size;  /* Size unused at the end of the buffer */
 221   uint32_t                buf_size;   /* The size of this sub-buffer */
 222   struct ltt_trace_header_any trace[0];
 223 } LTT_PACKED_STRUCT;
 224
 225
 226 struct _LttType{
 227 // LTTV does not care about type names. Everything is a field.
 228 // GQuark type_name;                //type name if it is a named type
 229   gchar * fmt;
 230   guint size;
 231   LttTypeEnum type_class;          //which type
 232   GHashTable *enum_map;                 //maps enum labels to numbers.
 233   GArray *fields;     // Array of LttFields, for array, sequence, union, struct.
 234   GData *fields_by_name;
 235 };
 236
 237 struct _LttEventType{
 238   GQuark name;
 239   gchar * description;
 240   guint index;            //id of the event type within the facility
 241   LttFacility * facility; //the facility that contains the event type
 242   GArray * fields;        //event's fields (LttField)
 243   GData *fields_by_name;
 244 };
 245
 246 /* Structure LttEvent and LttEventPosition must begin with the _exact_ same
 247  * fields in the exact same order. LttEventPosition is a parent of LttEvent. */
 248 struct _LttEvent{
 249
 250   /* Begin of LttEventPosition fields */
 251   LttTracefile  *tracefile;
 252   unsigned int  block;
 253   unsigned int  offset;
 254
 255   /* Timekeeping */
 256   uint64_t                tsc;       /* Current timestamp counter */
 257
 258   /* End of LttEventPosition fields */
 259
 260         union {                                                                                 /* choice by trace has_tsc */
 261           guint32  timestamp;                           /* truncated timestamp */
 262         LttTime  delta;
 263         } time;
 264
 265   unsigned char facility_id;    /* facility ID are never reused. */
 266   unsigned char event_id;
 267
 268   LttTime event_time;
 269
 270   void * data;               //event data
 271   guint  data_size;
 272   guint  event_size;         //event_size field of the header :
 273                              //used to verify data_size from facility.
 274
 275   int      count;                    //the number of overflow of cycle count
 276   gint64 overflow_nsec;              //precalculated nsec for overflows
 277 };
 278
 279 struct _LttEventPosition{
 280   LttTracefile  *tracefile;
 281   unsigned int  block;
 282   unsigned int  offset;
 283
 284   /* Timekeeping */
 285   uint64_t                tsc;       /* Current timestamp counter */
 286 };
 287
 288
 289 enum field_status { FIELD_UNKNOWN, FIELD_VARIABLE, FIELD_FIXED };
 290
 291 struct _LttField{
 292   GQuark name;
 293   gchar *description;
 294   LttType field_type;      //field type
 295
 296   off_t offset_root;            //offset from the root
 297   enum field_status fixed_root; //offset fixed according to the root
 298
 299   guint field_size;       // size of the field
 300                           // Only if field type size is set to 0
 301                           // (it's variable), then the field_size should be
 302                           // dynamically calculated while reading the trace
 303                           // and put here. Otherwise, the field_size always
 304                           // equels the type size.
 305   off_t array_offset;     // offset of the beginning of the array (for array
 306                           // and sequences)
 307   GArray * dynamic_offsets; // array of offsets calculated dynamically at
 308                             // each event for sequences and arrays that
 309                             // contain variable length fields.
 310 };
 311
 312 struct _LttFacility{
 313   LttTrace  *trace;
 314   GQuark name;
 315   guint32 checksum;      //checksum of the facility
 316   guint32  id;          //id of the facility
 317
 318   guint32 int_size;
 319   guint32 long_size;
 320   guint32 pointer_size;
 321   guint32 size_t_size;
 322   guint32 alignment;
 323
 324   GArray *events;
 325   GData *events_by_name;
 326  // not necessary in LTTV GData *named_types;
 327
 328   unsigned char exists; /* 0 does not exist, 1 exists */
 329 };
 330
 331 typedef struct _LttBuffer {
 332   void * head;
 333   unsigned int index;
 334
 335   struct {
 336     LttTime                 timestamp;
 337     uint64_t                cycle_count;
 338     uint64_t                freq; /* Frequency in khz */
 339   } begin;
 340   struct {
 341     LttTime                 timestamp;
 342     uint64_t                cycle_count;
 343     uint64_t                freq; /* Frequency in khz */
 344   } end;
 345   uint32_t                lost_size; /* Size unused at the end of the buffer */
 346
 347   /* Timekeeping */
 348   uint64_t                tsc;       /* Current timestamp counter */
 349   uint64_t                freq; /* Frequency in khz */
 350   //double                  nsecs_per_cycle;  /* Precalculated from freq */
 351   guint32                 cyc2ns_scale;
 352 } LttBuffer;
 353
 354 struct _LttTracefile{
 355   gboolean cpu_online;               //is the cpu online ?
 356   GQuark long_name;                  //tracefile complete filename
 357   GQuark name;                       //tracefile name
 358   guint cpu_num;                     //cpu number of the tracefile
 359   LttTrace * trace;                  //trace containing the tracefile
 360   int fd;                            //file descriptor
 361   off_t file_size;                   //file size
 362   //unsigned block_size;               //block_size
 363   guint num_blocks;           //number of blocks in the file
 364   gboolean  reverse_bo;              //must we reverse byte order ?
 365   gboolean  float_word_order;        //what is the byte order of floats ?
 366         size_t          has_alignment;                                   //alignment of events in the tracefile.
 367                                                                                                                                                  // 0 or the architecture size in bytes.
 368
 369   size_t    buffer_header_size;
 370
 371         /* Current event */
 372   LttEvent event;                    //Event currently accessible in the trace
 373
 374         /* Current block */
 375   LttBuffer buffer;                  //current buffer
 376   guint32 buf_size;                  /* The size of blocks */
 377
 378         /* Time flow */
 379   //unsigned int      count;           //the number of overflow of cycle count
 380   //double nsec_per_cycle;             //Nsec per cycle
 381   //TimeHeartbeat * last_heartbeat;    //last heartbeat
 382
 383   //LttCycleCount cycles_per_nsec_reciprocal; // Optimisation for speed
 384   //void * last_event_pos;
 385
 386   //LttTime prev_block_end_time;       //the end time of previous block
 387   //LttTime prev_event_time;           //the time of the previous event
 388   //LttCycleCount pre_cycle_count;     //previous cycle count of the event
 389 };
 390
 391 struct _LttTrace{
 392   GQuark pathname;                          //the pathname of the trace
 393   //LttSystemDescription * system_description;//system description
 394
 395   GArray *facilities_by_num;            /* fac_id as index in array */
 396   GData *facilities_by_name;            /* fac name (GQuark) as index */
 397                                         /* Points to array of fac_id of all the
 398                                         * facilities that has this name. */
 399   guint     num_cpu;
 400
 401   guint32   arch_type;
 402   guint32   arch_variant;
 403   guint8    arch_size;
 404   guint8    ltt_major_version;
 405   guint8    ltt_minor_version;
 406   guint8    flight_recorder;
 407   guint8    has_heartbeat;
 408         guint8          has_tsc;
 409   uint64_t  start_freq;
 410   uint64_t  start_tsc;
 411   uint64_t  start_monotonic;
 412   LttTime   start_time;
 413   LttTime   start_time_from_tsc;
 414
 415   GData     *tracefiles;                    //tracefiles groups
 416 };
 417
 418 /* The characteristics of the system on which the trace was obtained
 419    is described in a LttSystemDescription structure. */
 420
 421 struct _LttSystemDescription {
 422   gchar *description;
 423   gchar *node_name;
 424   gchar *domain_name;
 425   unsigned nb_cpu;
 426   LttArchSize size;
 427   LttArchEndian endian;
 428   gchar *kernel_name;
 429   gchar *kernel_release;
 430   gchar *kernel_version;
 431   gchar *machine;
 432   gchar *processor;
 433   gchar *hardware_platform;
 434   gchar *operating_system;
 435   LttTime trace_start;
 436   LttTime trace_end;
 437 };
 438
 439 /*****************************************************************************
 440  macro for size of some data types
 441  *****************************************************************************/
 442 // alignment -> dynamic!
 443
 444 //#define TIMESTAMP_SIZE    sizeof(guint32)
 445 //#define EVENT_ID_SIZE     sizeof(guint16)
 446 //#define EVENT_HEADER_SIZE (TIMESTAMP_SIZE + EVENT_ID_SIZE)
 447
 448
 449 /* Calculate the offset needed to align the type.
 450  * If has_alignment is 0, alignment is disactivated.
 451  * else, the function returns the offset needed to
 452  * align align_drift on the has_alignment value (should be
 453  * the size of the architecture). */
 454 static inline unsigned int ltt_align(size_t align_drift,
 455                                                                                                                                                  size_t size_of_type,
 456                                                                                                                                                  size_t has_alignment)
 457 {
 458         size_t alignment = min(has_alignment, size_of_type);
 459
 460         return ((alignment - align_drift) & (alignment-1));
 461 }
 462
 463 off_t field_align(LttTracefile *tf, LttField *field, off_t offset);
 464
 465
 466 #endif /* LTT_PRIVATE_H */