tags/LinuxTraceToolkitViewer-0.10.0-pre-115102007/ltt/trace.h

   1 /* This file is part of the Linux Trace Toolkit trace reading library
   2  * Copyright (C) 2003-2004 Michel Dagenais
   3  *               2005 Mathieu Desnoyers
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License Version 2.1 as published by the Free Software Foundation.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 #ifndef TRACE_H
  21 #define TRACE_H
  22
  23 #include <ltt/ltt.h>
  24 #include <stdint.h>
  25 #include <glib.h>
  26
  27 struct LttTrace {
  28   GQuark pathname;                          //the pathname of the trace
  29   //LttSystemDescription * system_description;//system description
  30
  31   guint     num_cpu;
  32
  33   guint32   arch_type;
  34   guint32   arch_variant;
  35   guint8    arch_size;
  36   guint8    ltt_major_version;
  37   guint8    ltt_minor_version;
  38   guint8    flight_recorder;
  39   guint32   freq_scale;
  40   uint64_t  start_freq;
  41   uint64_t  start_tsc;
  42   uint64_t  start_monotonic;
  43   LttTime   start_time;
  44   LttTime   start_time_from_tsc;
  45
  46   GData     *tracefiles;                    //tracefiles groups
  47   /* Support for markers */
  48   GArray    *markers;                       //indexed by marker ID
  49   GHashTable *markers_hash;                 //indexed by name hash
  50 };
  51
  52
  53
  54 extern GQuark LTT_FACILITY_NAME_HEARTBEAT,
  55               LTT_EVENT_NAME_HEARTBEAT,
  56               LTT_EVENT_NAME_HEARTBEAT_FULL;
  57
  58 /* A trace is specified as a pathname to the directory containing all the
  59    associated data (control tracefiles, per cpu tracefiles, event
  60    descriptions...).
  61
  62    When a trace is closed, all the associated facilities, types and fields
  63    are released as well.
  64
  65    return value is NULL if there is an error when opening the trace.
  66
  67    */
  68
  69 LttTrace *ltt_trace_open(const gchar *pathname);
  70
  71 /* copy reopens a trace
  72  *
  73  * return value NULL if error while opening the trace
  74  */
  75 LttTrace *ltt_trace_copy(LttTrace *self);
  76
  77 GQuark ltt_trace_name(const LttTrace *t);
  78
  79 void ltt_trace_close(LttTrace *t);
  80
  81 guint ltt_trace_get_num_cpu(LttTrace *t);
  82
  83 LttSystemDescription *ltt_trace_system_description(LttTrace *t);
  84
  85
  86 /* Functions to discover the facilities in the trace. Once the number
  87    of facilities is known, they may be accessed by position. Multiple
  88    versions of a facility (same name, different checksum) have consecutive
  89    positions. */
  90
  91 //unsigned ltt_trace_facility_number(LttTrace *t);
  92
  93 //LttFacility * ltt_trace_facility_by_id(LttTrace * trace, guint8 id);
  94
  95 /* Returns an array of indexes (guint) that matches the facility name */
  96 //GArray *ltt_trace_facility_get_by_name(LttTrace *t, GQuark name);
  97
  98 /* Functions to discover all the event types in the trace */
  99
 100 //unsigned ltt_trace_eventtype_number(LttTrace *t);
 101
 102 //LttEventType *ltt_trace_eventtype_get(LttTrace *t, unsigned i);
 103
 104
 105 /* Get the start time and end time of the trace */
 106
 107 void ltt_trace_time_span_get(LttTrace *t, LttTime *start, LttTime *end);
 108
 109
 110 /* Get the name of a tracefile */
 111
 112 GQuark ltt_tracefile_name(const LttTracefile *tf);
 113 GQuark ltt_tracefile_long_name(const LttTracefile *tf);
 114
 115 /* get the cpu number of the tracefile */
 116
 117 guint ltt_tracefile_cpu(LttTracefile *tf);
 118
 119 /* For usertrace */
 120 guint ltt_tracefile_tid(LttTracefile *tf);
 121 guint ltt_tracefile_pgid(LttTracefile *tf);
 122 guint64 ltt_tracefile_creation(LttTracefile *tf);
 123
 124
 125 LttTrace *ltt_tracefile_get_trace(LttTracefile *tf);
 126
 127 /* Get the number of blocks in the tracefile */
 128
 129 unsigned ltt_tracefile_block_number(LttTracefile *tf);
 130
 131
 132 /* Seek to the first event of the trace with time larger or equal to time */
 133
 134 int ltt_tracefile_seek_time(LttTracefile *t, LttTime time);
 135
 136 /* Seek to the first event with position equal or larger to ep */
 137
 138 int ltt_tracefile_seek_position(LttTracefile *t,
 139     const LttEventPosition *ep);
 140
 141 /* Read the next event */
 142
 143 int ltt_tracefile_read(LttTracefile *t);
 144
 145 /* ltt_tracefile_read cut down in pieces */
 146 int ltt_tracefile_read_seek(LttTracefile *t);
 147 int ltt_tracefile_read_update_event(LttTracefile *t);
 148 int ltt_tracefile_read_op(LttTracefile *t);
 149
 150 /* Get the current event of the tracefile : valid until the next read */
 151 LttEvent *ltt_tracefile_get_event(LttTracefile *tf);
 152
 153 /* open tracefile */
 154
 155 gint ltt_tracefile_open(LttTrace *t, gchar * fileName, LttTracefile *tf);
 156
 157 /* get the data type size and endian type of the local machine */
 158
 159 void getDataEndianType(LttArchSize * size, LttArchEndian * endian);
 160
 161 /* get an integer number */
 162 gint64 get_int(gboolean reverse_byte_order, gint size, void *data);
 163
 164 /* get the node name of the system */
 165
 166 gchar * ltt_trace_system_description_node_name (LttSystemDescription * s);
 167
 168
 169 /* get the domain name of the system */
 170
 171 gchar * ltt_trace_system_description_domain_name (LttSystemDescription * s);
 172
 173
 174 /* get the description of the system */
 175
 176 gchar * ltt_trace_system_description_description (LttSystemDescription * s);
 177
 178
 179 /* get the NTP start time of the trace */
 180
 181 LttTime ltt_trace_start_time(LttTrace *t);
 182
 183 /* get the monotonic start time of the trace */
 184
 185 LttTime ltt_trace_start_time_monotonic(LttTrace *t);
 186
 187 /* copy tracefile info over another. Used for sync. */
 188 LttTracefile *ltt_tracefile_new();
 189 void ltt_tracefile_destroy(LttTracefile *tf);
 190 void ltt_tracefile_copy(LttTracefile *dest, const LttTracefile *src);
 191
 192 void get_absolute_pathname(const gchar *pathname, gchar * abs_pathname);
 193
 194 /* May return a NULL tracefile group */
 195 GData **ltt_trace_get_tracefiles_groups(LttTrace *trace);
 196
 197 typedef void (*ForEachTraceFileFunc)(LttTracefile *tf, gpointer func_args);
 198
 199 struct compute_tracefile_group_args {
 200   ForEachTraceFileFunc func;
 201   gpointer func_args;
 202 };
 203
 204
 205 void compute_tracefile_group(GQuark key_id,
 206                              GArray *group,
 207                              struct compute_tracefile_group_args *args);
 208
 209 //LttFacility *ltt_trace_get_facility_by_num(LttTrace *t, guint num);
 210
 211
 212 //gint check_fields_compatibility(LttEventType *event_type1,
 213 //    LttEventType *event_type2,
 214 //    LttField *field1, LttField *field2);
 215
 216 gint64 ltt_get_int(gboolean reverse_byte_order, gint size, void *data);
 217
 218 guint64 ltt_get_uint(gboolean reverse_byte_order, gint size, void *data);
 219
 220 LttTime ltt_interpolate_time_from_tsc(LttTracefile *tf, guint64 tsc);
 221
 222 /* Set to enable event debugging output */
 223 void ltt_event_debug(int state);
 224
 225 #endif // TRACE_H