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  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License Version 2.1 as published by the Free Software Foundation.
   7  *
   8  * This library is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11  * Lesser General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU Lesser General Public
  14  * License along with this library; if not, write to the
  15  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  16  * Boston, MA 02111-1307, USA.
  17  */
  18
  19 #ifndef TRACE_H
  20 #define TRACE_H
  21
  22 #include <ltt/ltt.h>
  23
  24 extern GQuark LTT_FACILITY_NAME_HEARTBEAT,
  25               LTT_EVENT_NAME_HEARTBEAT;
  26
  27 /* A trace is specified as a pathname to the directory containing all the
  28    associated data (control tracefiles, per cpu tracefiles, event
  29    descriptions...).
  30
  31    When a trace is closed, all the associated facilities, types and fields
  32    are released as well.
  33
  34    return value is NULL if there is an error when opening the trace.
  35
  36    */
  37
  38 LttTrace *ltt_trace_open(const gchar *pathname);
  39
  40 /* copy reopens a trace
  41  *
  42  * return value NULL if error while opening the trace
  43  */
  44 LttTrace *ltt_trace_copy(LttTrace *self);
  45
  46 GQuark ltt_trace_name(const LttTrace *t);
  47
  48 void ltt_trace_close(LttTrace *t);
  49
  50 guint ltt_trace_get_num_cpu(LttTrace *t);
  51
  52 LttSystemDescription *ltt_trace_system_description(LttTrace *t);
  53
  54
  55 /* Functions to discover the facilities in the trace. Once the number
  56    of facilities is known, they may be accessed by position. Multiple
  57    versions of a facility (same name, different checksum) have consecutive
  58    positions. */
  59
  60 unsigned ltt_trace_facility_number(LttTrace *t);
  61
  62 LttFacility *ltt_trace_facility_get(LttTrace *t, unsigned i);
  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(LttTracefile *tf);
  84
  85 /* get the cpu number of the tracefile */
  86
  87 guint ltt_tracefile_num(LttTracefile *tf);
  88
  89 LttTrace *ltt_tracefile_get_trace(LttTracefile *tf);
  90
  91 /* Get the number of blocks in the tracefile */
  92
  93 unsigned ltt_tracefile_block_number(LttTracefile *tf);
  94
  95
  96 /* Seek to the first event of the trace with time larger or equal to time */
  97
  98 int ltt_tracefile_seek_time(LttTracefile *t, LttTime time);
  99
 100 /* Seek to the first event with position equal or larger to ep */
 101
 102 int ltt_tracefile_seek_position(LttTracefile *t,
 103     const LttEventPosition *ep);
 104
 105 /* Read the next event */
 106
 107 int ltt_tracefile_read(LttTracefile *t);
 108
 109 /* ltt_tracefile_read cut down in pieces */
 110 int ltt_tracefile_read_seek(LttTracefile *t);
 111 int ltt_tracefile_read_update_event(LttTracefile *t);
 112 int ltt_tracefile_read_op(LttTracefile *t);
 113
 114 /* Get the current event of the tracefile : valid until the next read */
 115 LttEvent *ltt_tracefile_get_event(LttTracefile *tf);
 116
 117 /* open tracefile */
 118
 119 gint ltt_tracefile_open(LttTrace *t, gchar * fileName, LttTracefile *tf);
 120
 121 /* get the data type size and endian type of the local machine */
 122
 123 void getDataEndianType(LttArchSize * size, LttArchEndian * endian);
 124
 125 /* get an integer number */
 126 gint64 get_int(gboolean reverse_byte_order, gint size, void *data);
 127
 128 /* get the node name of the system */
 129
 130 gchar * ltt_trace_system_description_node_name (LttSystemDescription * s);
 131
 132
 133 /* get the domain name of the system */
 134
 135 gchar * ltt_trace_system_description_domain_name (LttSystemDescription * s);
 136
 137
 138 /* get the description of the system */
 139
 140 gchar * ltt_trace_system_description_description (LttSystemDescription * s);
 141
 142
 143 /* get the start time of the trace */
 144
 145 LttTime ltt_trace_system_description_trace_start_time(LttSystemDescription *s);
 146
 147 /* copy tracefile info over another. Used for sync. */
 148 LttTracefile *ltt_tracefile_new();
 149 void ltt_tracefile_destroy(LttTracefile *tf);
 150 void ltt_tracefile_copy(LttTracefile *dest, const LttTracefile *src);
 151
 152 void get_absolute_pathname(const gchar *pathname, gchar * abs_pathname);
 153
 154 /* May return a NULL tracefile group */
 155 GData **ltt_trace_get_tracefiles_groups(LttTrace *trace);
 156
 157 typedef void (*ForEachTraceFileFunc)(LttTracefile *tf, gpointer func_args);
 158
 159 struct compute_tracefile_group_args {
 160   ForEachTraceFileFunc func;
 161   gpointer func_args;
 162 };
 163
 164
 165 void compute_tracefile_group(GQuark key_id,
 166                              GArray *group,
 167                              struct compute_tracefile_group_args *args);
 168
 169 LttFacility *ltt_trace_get_facility_by_num(LttTrace *t, guint num);
 170
 171
 172 gint check_fields_compatibility(LttEventType *event_type1,
 173     LttEventType *event_type2,
 174     LttField *field1, LttField *field2);
 175
 176 gint64 ltt_get_int(gboolean reverse_byte_order, gint size, void *data);
 177
 178 guint64 ltt_get_uint(gboolean reverse_byte_order, gint size, void *data);
 179
 180 #endif // TRACE_H