Add custom event data support
[lttv.git] / ltt / branches / poly / ltt / ltt-private.h
index 03da264e64cd64e97ccbf21ca7c893972b816ce7..a4801c1ca18d61dc090e2357da9af8d071ba8612 100644 (file)
@@ -1,19 +1,20 @@
 /* This file is part of the Linux Trace Toolkit viewer
  * Copyright (C) 2003-2004 Xiangxiu Yang
+ *               2006 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 library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License Version 2.1 as published by the Free Software Foundation.
  *
- * This program is distributed in the hope that it will be useful,
+ * This library 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.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser 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.
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
  */
 
 #ifndef LTT_PRIVATE_H
 #define max(a,b) ((a)>(b)?(a):(b))
 #endif
 
+#ifndef min
+#define min(a,b) ((a)<(b)?(a):(b))
+#endif
+
+
 
 #define LTT_MAGIC_NUMBER 0x00D6B7ED
 #define LTT_REV_MAGIC_NUMBER 0xEDB7D600
@@ -54,6 +60,7 @@ enum ltt_core_events {
     LTT_EVENT_FACILITY_LOAD,
     LTT_EVENT_FACILITY_UNLOAD,
     LTT_EVENT_HEARTBEAT,
+    LTT_EVENT_HEARTBEAT_FULL,
     LTT_EVENT_STATE_DUMP_FACILITY_LOAD
 };
 
@@ -100,11 +107,11 @@ typedef guint64 uint64_t;
 struct LttFacilityLoad {
   guint32 checksum;
   guint32 id;
-       guint32 int_size;
+  guint32 int_size;
   guint32 long_size;
   guint32 pointer_size;
   guint32 size_t_size;
-       guint32 has_alignment;
+  guint32 has_alignment;
 } LTT_PACKED_STRUCT;
 
 struct LttFacilityUnload {
@@ -114,18 +121,21 @@ struct LttFacilityUnload {
 struct LttStateDumpFacilityLoad {
   guint32 checksum;
   guint32 id;
-       guint32 int_size;
+  guint32 int_size;
   guint32 long_size;
   guint32 pointer_size;
   guint32 size_t_size;
-       guint32 has_alignment;
+  guint32  has_alignment;
 } LTT_PACKED_STRUCT;
 
+/* Empty event */
 typedef struct _TimeHeartbeat {
-  LttTime       time;       //Time stamp of this block
-  uint64_t cycle_count; //cycle count of the event
 } LTT_PACKED_STRUCT TimeHeartbeat;
 
+typedef struct _TimeHeartbeatFull {
+  guint64 tsc;
+} LTT_PACKED_STRUCT TimeHeartbeatFull;
+
 struct ltt_event_header_hb {
   uint32_t      timestamp;
   unsigned char  facility_id;
@@ -154,7 +164,7 @@ struct ltt_trace_header_any {
   uint8_t         flight_recorder;
   uint8_t         has_heartbeat;
   uint8_t         has_alignment;  /* Event header alignment */
-       uint8_t                     has_tsc;
+  uint32_t        freq_scale;
 } LTT_PACKED_STRUCT;
 
 
@@ -171,12 +181,12 @@ struct ltt_trace_header_0_3 {
   uint8_t         flight_recorder;
   uint8_t         has_heartbeat;
   uint8_t         has_alignment;  /* Event header alignment */
-       uint8_t                          has_tsc;
+  uint32_t        freq_scale;
 } LTT_PACKED_STRUCT;
 
-/* For version 0.4 */
+/* For version 0.7 */
 
-struct ltt_trace_header_0_4 {
+struct ltt_trace_header_0_7 {
   uint32_t        magic_number;
   uint32_t        arch_type;
   uint32_t        arch_variant;
@@ -187,22 +197,44 @@ struct ltt_trace_header_0_4 {
   uint8_t         flight_recorder;
   uint8_t         has_heartbeat;
   uint8_t         has_alignment;  /* Event header alignment */
-       uint8_t         has_tsc;
+  uint32_t        freq_scale;
   uint64_t        start_freq;
   uint64_t        start_tsc;
   uint64_t        start_monotonic;
-  struct timeval       start_time;
+  uint64_t        start_time_sec;
+  uint64_t        start_time_usec;
+} LTT_PACKED_STRUCT;
+
+/* For version 0.8 */
+
+struct ltt_trace_header_0_8 {
+  uint32_t        magic_number;
+  uint32_t        arch_type;
+  uint32_t        arch_variant;
+  uint32_t        float_word_order;
+  uint8_t         arch_size;
+  uint8_t         major_version;
+  uint8_t         minor_version;
+  uint8_t         flight_recorder;
+  uint8_t         has_heartbeat;
+  uint8_t         has_alignment;  /* Event header alignment */
+  uint8_t         tsc_lsb_truncate;
+  uint8_t         tscbits;
+  uint32_t        freq_scale;
+  uint64_t        start_freq;
+  uint64_t        start_tsc;
+  uint64_t        start_monotonic;
+  uint64_t        start_time_sec;
+  uint64_t        start_time_usec;
 } LTT_PACKED_STRUCT;
 
 
 struct ltt_block_start_header {
   struct { 
-    struct timeval          timestamp;
     uint64_t                cycle_count;
     uint64_t                freq;
   } begin;
   struct {
-    struct timeval          timestamp;
     uint64_t                cycle_count;
     uint64_t                freq;
   } end;
@@ -218,9 +250,10 @@ struct _LttType{
   gchar * fmt;
   guint size;
   LttTypeEnum type_class;          //which type
-  GData *enum_map;                 //maps enum labels to numbers.
+  GHashTable *enum_map;                 //maps enum labels to numbers.
   GArray *fields;     // Array of LttFields, for array, sequence, union, struct.
   GData *fields_by_name;
+  guint network;  // Is the type in network byte order ?
 };
 
 struct _LttEventType{
@@ -230,6 +263,7 @@ struct _LttEventType{
   LttFacility * facility; //the facility that contains the event type
   GArray * fields;        //event's fields (LttField)
   GData *fields_by_name;
+  int has_compact_data;       //event header contains compact data (first field)
 };
 
 /* Structure LttEvent and LttEventPosition must begin with the _exact_ same
@@ -246,12 +280,9 @@ struct _LttEvent{
   
   /* End of LttEventPosition fields */
 
-       union {                                                                                 /* choice by trace has_tsc */
-         guint32  timestamp;                           /* truncated timestamp */
-       LttTime  delta;
-       } time;
+  guint32  timestamp;        /* truncated timestamp */
 
-  unsigned char facility_id;   /* facility ID are never reused. */
+  unsigned char facility_id;  /* facility ID are never reused. */
   unsigned char event_id;
 
   LttTime event_time;
@@ -260,6 +291,7 @@ struct _LttEvent{
   guint  data_size;
   guint  event_size;         //event_size field of the header : 
                              //used to verify data_size from facility.
+  uint32_t compact_data;
 
   int      count;                    //the number of overflow of cycle count
   gint64 overflow_nsec;              //precalculated nsec for overflows
@@ -290,7 +322,7 @@ struct _LttField{
                           // (it's variable), then the field_size should be
                           // dynamically calculated while reading the trace
                           // and put here. Otherwise, the field_size always
-                          // equels the type size.
+                          // equals the type size.
   off_t array_offset;     // offset of the beginning of the array (for array
                           // and sequences)
   GArray * dynamic_offsets; // array of offsets calculated dynamically at
@@ -345,6 +377,9 @@ struct _LttTracefile{
   GQuark long_name;                  //tracefile complete filename
   GQuark name;                       //tracefile name
   guint cpu_num;                     //cpu number of the tracefile
+  guint  tid;                         //Usertrace tid, else 0
+  guint pgid;                         //Usertrace pgid, else 0
+  guint64 creation;                   //Usertrace creation, else 0
   LttTrace * trace;                  //trace containing the tracefile
   int fd;                            //file descriptor 
   off_t file_size;                   //file size
@@ -352,19 +387,25 @@ struct _LttTracefile{
   guint num_blocks;           //number of blocks in the file
   gboolean  reverse_bo;              //must we reverse byte order ?
   gboolean  float_word_order;        //what is the byte order of floats ?
-       size_t          has_alignment;                                   //alignment of events in the tracefile.
-                                                                                                                                                // 0 or the architecture size in bytes.
+  size_t    has_alignment;           //alignment of events in the tracefile.
+                                     // 0 or the architecture size in bytes.
 
   size_t    buffer_header_size;
-
-       /* Current event */
+  int       compact;                 //compact tracefile ?
+  uint8_t   tsc_lsb_truncate;
+  uint8_t   tscbits;
+  uint8_t   tsc_msb_cutoff;
+  uint64_t  tsc_mask;
+  uint64_t  tsc_mask_next_bit;       //next MSB after the mask
+
+  /* Current event */
   LttEvent event;                    //Event currently accessible in the trace
 
-       /* Current block */
+  /* Current block */
   LttBuffer buffer;                  //current buffer
   guint32 buf_size;                  /* The size of blocks */
 
-       /* Time flow */
+  /* Time flow */
   //unsigned int      count;           //the number of overflow of cycle count
   //double nsec_per_cycle;             //Nsec per cycle
   //TimeHeartbeat * last_heartbeat;    //last heartbeat
@@ -394,12 +435,14 @@ struct _LttTrace{
   guint8    ltt_minor_version;
   guint8    flight_recorder;
   guint8    has_heartbeat;
-       guint8          has_tsc;
+  guint32    freq_scale;
   uint64_t  start_freq;
   uint64_t  start_tsc;
   uint64_t  start_monotonic;
   LttTime   start_time;
   LttTime   start_time_from_tsc;
+  GArray    *compact_facilities;
+  uint8_t   compact_event_bits;
 
   GData     *tracefiles;                    //tracefiles groups
 };
@@ -435,21 +478,24 @@ struct _LttSystemDescription {
 //#define EVENT_HEADER_SIZE (TIMESTAMP_SIZE + EVENT_ID_SIZE)
 
 
+off_t get_alignment(LttField *field);
+
 /* Calculate the offset needed to align the type.
  * If has_alignment is 0, alignment is disactivated.
  * else, the function returns the offset needed to
  * align align_drift on the has_alignment value (should be
  * the size of the architecture). */
 static inline unsigned int ltt_align(size_t align_drift,
-                                                                                                                                                size_t size_of_type,
-                                                                                                                                                size_t has_alignment)
+          size_t size_of_type,
+          size_t has_alignment)
 {
-       size_t alignment = min(has_alignment, size_of_type);
-
-       return ((alignment - align_drift) & (alignment-1));
+  size_t alignment = min(has_alignment, size_of_type);
+  
+  if(!has_alignment) return 0;
+  
+  g_assert(size_of_type != 0);
+  return ((alignment - align_drift) & (alignment-1));
 }
 
-off_t field_align(LttTracefile *tf, LttField *field, off_t offset);
-
 
 #endif /* LTT_PRIVATE_H */
This page took 0.027628 seconds and 4 git commands to generate.