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 <ltt/ltt-private.h>
  25 #include <stdint.h>
  26 #include <glib.h>
  27
  28 struct LttTrace {
  29   GQuark pathname;                          //the pathname of the trace
  30   //LttSystemDescription * system_description;//system description
  31
  32   guint     num_cpu;
  33
  34   guint32   arch_type;
  35   guint32   arch_variant;
  36   guint8    arch_size;
  37   guint8    ltt_major_version;
  38   guint8    ltt_minor_version;
  39   guint8    flight_recorder;
  40   guint32   freq_scale;
  41   uint64_t  start_freq;
  42   uint64_t  start_tsc;
  43   uint64_t  start_monotonic;
  44   double    drift;
  45   double    offset;
  46   LttTime   start_time;
  47   LttTime   start_time_from_tsc;
  48
  49   GData     *tracefiles;                    //tracefiles groups
  50 };
  51
  52 static inline guint ltt_trace_get_num_cpu(LttTrace *t)
  53 {
  54   return t->num_cpu;
  55 }
  56
  57 /* A trace is specified as a pathname to the directory containing all the
  58    associated data (control tracefiles, per cpu tracefiles, event
  59    descriptions...).
  60
  61    When a trace is closed, all the associated facilities, types and fields
  62    are released as well.
  63
  64    return value is NULL if there is an error when opening the trace.
  65
  66    */
  67
  68 LttTrace *ltt_trace_open(const gchar *pathname);
  69
  70 /* copy reopens a trace
  71  *
  72  * return value NULL if error while opening the trace
  73  */
  74 LttTrace *ltt_trace_copy(LttTrace *self);
  75
  76 static inline GQuark ltt_trace_name(const LttTrace *t)
  77 {
  78   return t->pathname;
  79 }
  80
  81
  82 void ltt_trace_close(LttTrace *t);
  83
  84 LttSystemDescription *ltt_trace_system_description(LttTrace *t);
  85
  86
  87 /* Get the start time and end time of the trace */
  88
  89 void ltt_trace_time_span_get(LttTrace *t, LttTime *start, LttTime *end);
  90
  91
  92 /* Get the name of a tracefile */
  93
  94 static inline GQuark ltt_tracefile_name(const LttTracefile *tf)
  95 {
  96   return tf->name;
  97 }
  98
  99 static inline GQuark ltt_tracefile_long_name(const LttTracefile *tf)
 100 {
 101   return tf->long_name;
 102 }
 103
 104 /* get the cpu number of the tracefile */
 105
 106 static inline guint ltt_tracefile_cpu(LttTracefile *tf)
 107 {
 108   return tf->cpu_num;
 109 }
 110
 111 /* For usertrace */
 112 static inline guint ltt_tracefile_tid(LttTracefile *tf)
 113 {
 114   return tf->tid;
 115 }
 116
 117 static inline guint ltt_tracefile_pgid(LttTracefile *tf)
 118 {
 119   return tf->pgid;
 120 }
 121
 122 static inline guint64 ltt_tracefile_creation(LttTracefile *tf)
 123 {
 124   return tf->creation;
 125 }
 126
 127 static inline LttTrace *ltt_tracefile_get_trace(LttTracefile *tf)
 128 {
 129   return tf->trace;
 130 }
 131
 132 /* Get the number of blocks in the tracefile */
 133
 134 static inline guint ltt_tracefile_block_number(LttTracefile *tf)
 135 {
 136   return tf->num_blocks;
 137 }
 138
 139
 140 /* Seek to the first event of the trace with time larger or equal to time */
 141
 142 int ltt_tracefile_seek_time(LttTracefile *t, LttTime time);
 143
 144 /* Seek to the first event with position equal or larger to ep */
 145
 146 int ltt_tracefile_seek_position(LttTracefile *t,
 147     const LttEventPosition *ep);
 148
 149 /* Read the next event */
 150
 151 int ltt_tracefile_read(LttTracefile *t);
 152
 153 /* ltt_tracefile_read cut down in pieces */
 154 int ltt_tracefile_read_seek(LttTracefile *t);
 155 int ltt_tracefile_read_update_event(LttTracefile *t);
 156 int ltt_tracefile_read_op(LttTracefile *t);
 157
 158 /* Get the current event of the tracefile : valid until the next read */
 159 LttEvent *ltt_tracefile_get_event(LttTracefile *tf);
 160
 161 /* get the data type size and endian type of the local machine */
 162
 163 void getDataEndianType(LttArchSize * size, LttArchEndian * endian);
 164
 165 /* get an integer number */
 166 gint64 get_int(gboolean reverse_byte_order, gint size, void *data);
 167
 168 /* get the node name of the system */
 169
 170 gchar * ltt_trace_system_description_node_name (LttSystemDescription * s);
 171
 172
 173 /* get the domain name of the system */
 174
 175 gchar * ltt_trace_system_description_domain_name (LttSystemDescription * s);
 176
 177
 178 /* get the description of the system */
 179
 180 gchar * ltt_trace_system_description_description (LttSystemDescription * s);
 181
 182
 183 /* get the NTP start time of the trace */
 184
 185 LttTime ltt_trace_start_time(LttTrace *t);
 186
 187 /* get the monotonic start time of the trace */
 188
 189 LttTime ltt_trace_start_time_monotonic(LttTrace *t);
 190
 191 void get_absolute_pathname(const gchar *pathname, gchar * abs_pathname);
 192
 193 /* May return a NULL tracefile group */
 194 GData **ltt_trace_get_tracefiles_groups(LttTrace *trace);
 195
 196 typedef void (*ForEachTraceFileFunc)(LttTracefile *tf, gpointer func_args);
 197
 198 struct compute_tracefile_group_args {
 199   ForEachTraceFileFunc func;
 200   gpointer func_args;
 201 };
 202
 203 void compute_tracefile_group(GQuark key_id,
 204                              GArray *group,
 205                              struct compute_tracefile_group_args *args);
 206
 207
 208 gint64 ltt_get_int(gboolean reverse_byte_order, gint size, void *data);
 209
 210 guint64 ltt_get_uint(gboolean reverse_byte_order, gint size, void *data);
 211
 212 guint64 tsc_to_uint64(guint32 freq_scale, uint64_t start_freq, guint64 tsc);
 213
 214 LttTime ltt_interpolate_time_from_tsc(LttTracefile *tf, guint64 tsc);
 215
 216 /* Set to enable event debugging output */
 217 void ltt_event_debug(int state);
 218
 219 #endif // TRACE_H