ltt/branches/poly/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
  25 extern GQuark LTT_FACILITY_NAME_HEARTBEAT,
  26               LTT_EVENT_NAME_HEARTBEAT,
  27               LTT_EVENT_NAME_HEARTBEAT_FULL;
  28
  29 /* A trace is specified as a pathname to the directory containing all the
  30    associated data (control tracefiles, per cpu tracefiles, event
  31    descriptions...).
  32
  33    When a trace is closed, all the associated facilities, types and fields
  34    are released as well.
  35
  36    return value is NULL if there is an error when opening the trace.
  37
  38    */
  39
  40 LttTrace *ltt_trace_open(const gchar *pathname);
  41
  42 /* copy reopens a trace
  43  *
  44  * return value NULL if error while opening the trace
  45  */
  46 LttTrace *ltt_trace_copy(LttTrace *self);
  47
  48 GQuark ltt_trace_name(const LttTrace *t);
  49
  50 void ltt_trace_close(LttTrace *t);
  51
  52 guint ltt_trace_get_num_cpu(LttTrace *t);
  53
  54 LttSystemDescription *ltt_trace_system_description(LttTrace *t);
  55
  56
  57 /* Functions to discover the facilities in the trace. Once the number
  58    of facilities is known, they may be accessed by position. Multiple
  59    versions of a facility (same name, different checksum) have consecutive
  60    positions. */
  61
  62 unsigned ltt_trace_facility_number(LttTrace *t);
  63
  64 LttFacility *ltt_trace_facility_get(LttTrace *t, unsigned i);
  65
  66 LttFacility * ltt_trace_facility_by_id(LttTrace * trace, guint8 id);
  67
  68 /* Returns an array of indexes (guint) that matches the facility name */
  69 GArray *ltt_trace_facility_get_by_name(LttTrace *t, GQuark name);
  70
  71 /* Functions to discover all the event types in the trace */
  72
  73 unsigned ltt_trace_eventtype_number(LttTrace *t);
  74
  75 LttEventType *ltt_trace_eventtype_get(LttTrace *t, unsigned i);
  76
  77
  78 /* Get the start time and end time of the trace */
  79
  80 void ltt_trace_time_span_get(LttTrace *t, LttTime *start, LttTime *end);
  81
  82
  83 /* Get the name of a tracefile */
  84
  85 GQuark ltt_tracefile_name(const LttTracefile *tf);
  86 GQuark ltt_tracefile_long_name(const LttTracefile *tf);
  87
  88 /* get the cpu number of the tracefile */
  89
  90 guint ltt_tracefile_cpu(LttTracefile *tf);
  91
  92 /* For usertrace */
  93 guint ltt_tracefile_tid(LttTracefile *tf);
  94 guint ltt_tracefile_pgid(LttTracefile *tf);
  95 guint64 ltt_tracefile_creation(LttTracefile *tf);
  96
  97
  98 LttTrace *ltt_tracefile_get_trace(LttTracefile *tf);
  99
 100 /* Get the number of blocks in the tracefile */
 101
 102 unsigned ltt_tracefile_block_number(LttTracefile *tf);
 103
 104
 105 /* Seek to the first event of the trace with time larger or equal to time */
 106
 107 int ltt_tracefile_seek_time(LttTracefile *t, LttTime time);
 108
 109 /* Seek to the first event with position equal or larger to ep */
 110
 111 int ltt_tracefile_seek_position(LttTracefile *t,
 112     const LttEventPosition *ep);
 113
 114 /* Read the next event */
 115
 116 int ltt_tracefile_read(LttTracefile *t);
 117
 118 /* ltt_tracefile_read cut down in pieces */
 119 int ltt_tracefile_read_seek(LttTracefile *t);
 120 int ltt_tracefile_read_update_event(LttTracefile *t);
 121 int ltt_tracefile_read_op(LttTracefile *t);
 122
 123 /* Get the current event of the tracefile : valid until the next read */
 124 LttEvent *ltt_tracefile_get_event(LttTracefile *tf);
 125
 126 /* open tracefile */
 127
 128 gint ltt_tracefile_open(LttTrace *t, gchar * fileName, LttTracefile *tf);
 129
 130 /* get the data type size and endian type of the local machine */
 131
 132 void getDataEndianType(LttArchSize * size, LttArchEndian * endian);
 133
 134 /* get an integer number */
 135 gint64 get_int(gboolean reverse_byte_order, gint size, void *data);
 136
 137 /* get the node name of the system */
 138
 139 gchar * ltt_trace_system_description_node_name (LttSystemDescription * s);
 140
 141
 142 /* get the domain name of the system */
 143
 144 gchar * ltt_trace_system_description_domain_name (LttSystemDescription * s);
 145
 146
 147 /* get the description of the system */
 148
 149 gchar * ltt_trace_system_description_description (LttSystemDescription * s);
 150
 151
 152 /* get the NTP start time of the trace */
 153
 154 LttTime ltt_trace_start_time(LttTrace *t);
 155
 156 /* get the monotonic start time of the trace */
 157
 158 LttTime ltt_trace_start_time_monotonic(LttTrace *t);
 159
 160 /* copy tracefile info over another. Used for sync. */
 161 LttTracefile *ltt_tracefile_new();
 162 void ltt_tracefile_destroy(LttTracefile *tf);
 163 void ltt_tracefile_copy(LttTracefile *dest, const LttTracefile *src);
 164
 165 void get_absolute_pathname(const gchar *pathname, gchar * abs_pathname);
 166
 167 /* May return a NULL tracefile group */
 168 GData **ltt_trace_get_tracefiles_groups(LttTrace *trace);
 169
 170 typedef void (*ForEachTraceFileFunc)(LttTracefile *tf, gpointer func_args);
 171
 172 struct compute_tracefile_group_args {
 173   ForEachTraceFileFunc func;
 174   gpointer func_args;
 175 };
 176
 177
 178 void compute_tracefile_group(GQuark key_id,
 179                              GArray *group,
 180                              struct compute_tracefile_group_args *args);
 181
 182 LttFacility *ltt_trace_get_facility_by_num(LttTrace *t, guint num);
 183
 184
 185 gint check_fields_compatibility(LttEventType *event_type1,
 186     LttEventType *event_type2,
 187     LttField *field1, LttField *field2);
 188
 189 gint64 ltt_get_int(gboolean reverse_byte_order, gint size, void *data);
 190
 191 guint64 ltt_get_uint(gboolean reverse_byte_order, gint size, void *data);
 192
 193 LttTime ltt_interpolate_time_from_tsc(LttTracefile *tf, guint64 tsc);
 194
 195 #endif // TRACE_H