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_by_id(LttTrace * trace, guint8 id);
  65
  66 /* Returns an array of indexes (guint) that matches the facility name */
  67 GArray *ltt_trace_facility_get_by_name(LttTrace *t, GQuark name);
  68
  69 /* Functions to discover all the event types in the trace */
  70
  71 unsigned ltt_trace_eventtype_number(LttTrace *t);
  72
  73 LttEventType *ltt_trace_eventtype_get(LttTrace *t, unsigned i);
  74
  75
  76 /* Get the start time and end time of the trace */
  77
  78 void ltt_trace_time_span_get(LttTrace *t, LttTime *start, LttTime *end);
  79
  80
  81 /* Get the name of a tracefile */
  82
  83 GQuark ltt_tracefile_name(const LttTracefile *tf);
  84 GQuark ltt_tracefile_long_name(const LttTracefile *tf);
  85
  86 /* get the cpu number of the tracefile */
  87
  88 guint ltt_tracefile_cpu(LttTracefile *tf);
  89
  90 /* For usertrace */
  91 guint ltt_tracefile_tid(LttTracefile *tf);
  92 guint ltt_tracefile_pgid(LttTracefile *tf);
  93 guint64 ltt_tracefile_creation(LttTracefile *tf);
  94
  95
  96 LttTrace *ltt_tracefile_get_trace(LttTracefile *tf);
  97
  98 /* Get the number of blocks in the tracefile */
  99
 100 unsigned ltt_tracefile_block_number(LttTracefile *tf);
 101
 102
 103 /* Seek to the first event of the trace with time larger or equal to time */
 104
 105 int ltt_tracefile_seek_time(LttTracefile *t, LttTime time);
 106
 107 /* Seek to the first event with position equal or larger to ep */
 108
 109 int ltt_tracefile_seek_position(LttTracefile *t,
 110     const LttEventPosition *ep);
 111
 112 /* Read the next event */
 113
 114 int ltt_tracefile_read(LttTracefile *t);
 115
 116 /* ltt_tracefile_read cut down in pieces */
 117 int ltt_tracefile_read_seek(LttTracefile *t);
 118 int ltt_tracefile_read_update_event(LttTracefile *t);
 119 int ltt_tracefile_read_op(LttTracefile *t);
 120
 121 /* Get the current event of the tracefile : valid until the next read */
 122 LttEvent *ltt_tracefile_get_event(LttTracefile *tf);
 123
 124 /* open tracefile */
 125
 126 gint ltt_tracefile_open(LttTrace *t, gchar * fileName, LttTracefile *tf);
 127
 128 /* get the data type size and endian type of the local machine */
 129
 130 void getDataEndianType(LttArchSize * size, LttArchEndian * endian);
 131
 132 /* get an integer number */
 133 gint64 get_int(gboolean reverse_byte_order, gint size, void *data);
 134
 135 /* get the node name of the system */
 136
 137 gchar * ltt_trace_system_description_node_name (LttSystemDescription * s);
 138
 139
 140 /* get the domain name of the system */
 141
 142 gchar * ltt_trace_system_description_domain_name (LttSystemDescription * s);
 143
 144
 145 /* get the description of the system */
 146
 147 gchar * ltt_trace_system_description_description (LttSystemDescription * s);
 148
 149
 150 /* get the NTP start time of the trace */
 151
 152 LttTime ltt_trace_start_time(LttTrace *t);
 153
 154 /* get the monotonic start time of the trace */
 155
 156 LttTime ltt_trace_start_time_monotonic(LttTrace *t);
 157
 158 /* copy tracefile info over another. Used for sync. */
 159 LttTracefile *ltt_tracefile_new();
 160 void ltt_tracefile_destroy(LttTracefile *tf);
 161 void ltt_tracefile_copy(LttTracefile *dest, const LttTracefile *src);
 162
 163 void get_absolute_pathname(const gchar *pathname, gchar * abs_pathname);
 164
 165 /* May return a NULL tracefile group */
 166 GData **ltt_trace_get_tracefiles_groups(LttTrace *trace);
 167
 168 typedef void (*ForEachTraceFileFunc)(LttTracefile *tf, gpointer func_args);
 169
 170 struct compute_tracefile_group_args {
 171   ForEachTraceFileFunc func;
 172   gpointer func_args;
 173 };
 174
 175
 176 void compute_tracefile_group(GQuark key_id,
 177                              GArray *group,
 178                              struct compute_tracefile_group_args *args);
 179
 180 LttFacility *ltt_trace_get_facility_by_num(LttTrace *t, guint num);
 181
 182
 183 gint check_fields_compatibility(LttEventType *event_type1,
 184     LttEventType *event_type2,
 185     LttField *field1, LttField *field2);
 186
 187 gint64 ltt_get_int(gboolean reverse_byte_order, gint size, void *data);
 188
 189 guint64 ltt_get_uint(gboolean reverse_byte_order, gint size, void *data);
 190
 191 LttTime ltt_interpolate_time_from_tsc(LttTracefile *tf, guint64 tsc);
 192
 193 #endif // TRACE_H