remove event.c and type.c
[lttv.git] / ltt / branches / poly / ltt / ltt-private.h
index 9e263c565b2675bbb5422cb3292eb04a8874b38f..91ee9347b59d97a0e65190e2f0df203bdd3a76bb 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
 #include <ltt/ltt.h>
 #include <endian.h>
 
-
 #ifndef max
 #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
 #define LTT_GET_FLOAT_BO(t) \
   (((t)->float_word_order==__BYTE_ORDER)?0:1)
 
+#define SEQUENCE_AVG_ELEMENTS 1000
+                               
 /* Hardcoded core events */
 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
 };
 
@@ -98,10 +106,11 @@ typedef guint64 uint64_t;
 struct LttFacilityLoad {
   guint32 checksum;
   guint32 id;
+  guint32 int_size;
   guint32 long_size;
   guint32 pointer_size;
   guint32 size_t_size;
-  guint32 alignment;
+  guint32 has_alignment;
 } LTT_PACKED_STRUCT;
 
 struct LttFacilityUnload {
@@ -111,28 +120,30 @@ struct LttFacilityUnload {
 struct LttStateDumpFacilityLoad {
   guint32 checksum;
   guint32 id;
+  guint32 int_size;
   guint32 long_size;
   guint32 pointer_size;
   guint32 size_t_size;
-  guint32 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;
-  unsigned char event_id;
+  uint16_t      event_id;
   uint16_t      event_size;
 } LTT_PACKED_STRUCT;
 
 struct ltt_event_header_nohb {
   uint64_t      timestamp;
-  unsigned char  facility_id;
-  unsigned char event_id;
+  uint16_t      event_id;
   uint16_t      event_size;
 } LTT_PACKED_STRUCT;
 
@@ -150,29 +161,10 @@ struct ltt_trace_header_any {
   uint8_t         flight_recorder;
   uint8_t         has_heartbeat;
   uint8_t         has_alignment;  /* Event header alignment */
-       uint8_t                     has_tsc;
-} LTT_PACKED_STRUCT;
-
-
-/* For version 0.3 */
-
-struct ltt_trace_header_0_3 {
-  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                          has_tsc;
+  uint32_t        freq_scale;
 } LTT_PACKED_STRUCT;
 
-/* For version 0.4 */
-
-struct ltt_trace_header_0_4 {
+struct ltt_trace_header_1_0 {
   uint32_t        magic_number;
   uint32_t        arch_type;
   uint32_t        arch_variant;
@@ -183,22 +175,23 @@ 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;
+  uint8_t         tsc_lsb_truncate;
+  uint8_t         tscbits;
+  uint32_t        freq_scale;
   uint64_t        start_freq;
   uint64_t        start_tsc;
   uint64_t        start_monotonic;
-  struct timespec start_time;
+  uint64_t        start_time_sec;
+  uint64_t        start_time_usec;
 } LTT_PACKED_STRUCT;
 
 
 struct ltt_block_start_header {
   struct { 
-    uint64_t                timestamp;
     uint64_t                cycle_count;
     uint64_t                freq;
   } begin;
   struct {
-    uint64_t                timestamp;
     uint64_t                cycle_count;
     uint64_t                freq;
   } end;
@@ -208,25 +201,37 @@ struct ltt_block_start_header {
 } LTT_PACKED_STRUCT;
 
 
+#if 0
 struct _LttType{
-  GQuark type_name;                //type name if it is a named type
-  GQuark element_name;             //elements name of the struct
+// LTTV does not care about type names. Everything is a field.
+// GQuark type_name;                //type name if it is a named type
   gchar * fmt;
-  unsigned int size;
+  guint size;
   LttTypeEnum type_class;          //which type
-  GQuark * enum_strings;            //for enum labels
-  struct _LttType ** element_type; //for array, sequence and struct
-  unsigned element_number;         //the number of elements 
-                                   //for enum, array, sequence and structure
+  GHashTable *enum_map;                 //maps enum labels to numbers.
+  gint32 highest_value;                        //For enum
+  gint32 lowest_value;                 //For enum
+  GArray *fields;     // Array of LttFields, for array, sequence, union, struct.
+  GData *fields_by_name;
+  guint network;  // Is the type in network byte order ?
+  //part added by gaby for fmt:
+  char *header;
+  char *separator;
+  char *footer;
 };
+#endif //0
 
+#if 0
 struct _LttEventType{
   GQuark name;
   gchar * description;
-  guint index;              //id of the event type within the facility
-  LttFacility * facility; //the facility that contains the event type
-  LttField * root_field;  //root field
+  guint index;            //id of the event type within the facility
+  struct marker_info *info;
+  GArray * fields;        //event's fields (LttField)
+  GData *fields_by_name;
+  int has_compact_data;       //event header contains compact data (first field)
 };
+#endif //0
 
 /* Structure LttEvent and LttEventPosition must begin with the _exact_ same
  * fields in the exact same order. LttEventPosition is a parent of LttEvent. */
@@ -242,13 +247,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 event_id;
+  guint16 event_id;
 
   LttTime event_time;
 
@@ -256,6 +257,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
@@ -273,69 +275,48 @@ struct _LttEventPosition{
 
 enum field_status { FIELD_UNKNOWN, FIELD_VARIABLE, FIELD_FIXED };
 
+#if 0
 struct _LttField{
-  //guint field_pos;           //field position within its parent
-  LttType * field_type;      //field type, if it is root field
-                             //then it must be struct type
-
-  off_t offset_root;         //offset from the root, -1:uninitialized 
-  enum field_status fixed_root;          //offset fixed according to the root
-                             //-1:uninitialized, 0:unfixed, 1:fixed
-  off_t offset_parent;       //offset from the parent,-1:uninitialized
-  enum field_status fixed_parent;        //offset fixed according to its parent
-                             //-1:uninitialized, 0:unfixed, 1:fixed
-  //  void * base_address;       //base address of the field  ????
-  
-  guint field_size;     //      //>0: size of the field, 
-                          //   //0 : uncertain
-                           //  //-1: uninitialize
-  enum field_status fixed_size;
-
-  /* for sequence */
-  gint sequ_number_size;      //the size of unsigned used to save the
-                             //number of elements in the sequence
-
-  gint element_size;          //the element size of the sequence
-  //int field_fixed;           //0: field has string or sequence
-                             //1: field has no string or sequenc
-                             //-1: uninitialize
-
-  struct _LttField * parent;
-  struct _LttField ** child; //for array, sequence, struct and union: 
-                             //list of fields, it may have only one
-                             //field if the element is not a struct or
-                             //union
-  unsigned current_element;  //which element is currently processed
-                             // Used for sequences and arrays.
+  GQuark name;
+  gchar *description;
+  LttType field_type;      //field type
+
+  off_t offset_root;            //offset from the root
+  enum field_status fixed_root; //offset fixed according to the root
+
+  guint field_size;       // size of the field
+                          // Only if field type size is set to 0
+                          // (it's variable), then the field_size should be
+                          // dynamically calculated while reading the trace
+                          // and put here. Otherwise, the field_size always
+                          // 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
+                            // each event for sequences and arrays that
+                            // contain variable length fields.
 };
-
-
+#endif //0
+#if 0
 struct _LttFacility{
   LttTrace  *trace;
-  //gchar * name;               //facility name 
   GQuark name;
   guint32 checksum;      //checksum of the facility 
   guint32  id;          //id of the facility
  
-  guint32 pointer_size;
+  guint32 int_size;
   guint32 long_size;
+  guint32 pointer_size;
   guint32 size_t_size;
   guint32 alignment;
 
-
-  //LttEventType ** events;    //array of event types 
-  //unsigned int event_number;          //number of events in the facility 
-  //LttType ** named_types;
-  //unsigned int named_types_number;
-
   GArray *events;
   GData *events_by_name;
- // GArray *named_types;
-  //GData *named_types_by_name;
-  GData *named_types;
+ // not necessary in LTTV GData *named_types;
   
   unsigned char exists; /* 0 does not exist, 1 exists */
 };
+#endif //0
 
 typedef struct _LttBuffer {
   void * head;
@@ -365,24 +346,36 @@ 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
   //unsigned block_size;               //block_size
-  unsigned int num_blocks;           //number of blocks in the file
+  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.
 
+  guint8    has_heartbeat;
   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
@@ -411,15 +404,18 @@ struct _LttTrace{
   guint8    ltt_major_version;
   guint8    ltt_minor_version;
   guint8    flight_recorder;
-  guint8    has_heartbeat;
-  guint8    has_alignment;
-       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;
+  uint8_t   compact_event_bits;
 
   GData     *tracefiles;                    //tracefiles groups
+  /* Support for markers */
+  GArray    *markers;                       //indexed by marker ID
+  GHashTable *markers_hash;                 //indexed by name hash
 };
 
 /* The characteristics of the system on which the trace was obtained
@@ -453,4 +449,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 alignment = min(has_alignment, size_of_type);
+  
+  if(!has_alignment) return 0;
+  
+  g_assert(size_of_type != 0);
+  return ((alignment - align_drift) & (alignment-1));
+}
+
+
 #endif /* LTT_PRIVATE_H */
This page took 0.027599 seconds and 4 git commands to generate.