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
  25 extern GQuark LTT_FACILITY_NAME_HEARTBEAT,
  26               LTT_EVENT_NAME_HEARTBEAT;
  27
  28 /* A trace is specified as a pathname to the directory containing all the
  29    associated data (control tracefiles, per cpu tracefiles, event
  30    descriptions...).
  31
  32    When a trace is closed, all the associated facilities, types and fields
  33    are released as well.
  34
  35    return value is NULL if there is an error when opening the trace.
  36
  37    */
  38
  39 LttTrace *ltt_trace_open(const gchar *pathname);
  40
  41 /* copy reopens a trace
  42  *
  43  * return value NULL if error while opening the trace
  44  */
  45 LttTrace *ltt_trace_copy(LttTrace *self);
  46
  47 GQuark ltt_trace_name(LttTrace *t);
  48
  49 void ltt_trace_close(LttTrace *t);
  50
  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
  86 /* Get the number of blocks in the tracefile */
  87
  88 unsigned ltt_tracefile_block_number(LttTracefile *tf);
  89
  90
  91 /* Seek to the first event of the trace with time larger or equal to time */
  92
  93 int ltt_tracefile_seek_time(LttTracefile *t, LttTime time);
  94
  95 /* Seek to the first event with position equal or larger to ep */
  96
  97 int ltt_tracefile_seek_position(LttTracefile *t,
  98     const LttEventPosition *ep);
  99
 100 /* Read the next event */
 101
 102 int ltt_tracefile_read(LttTracefile *t);
 103
 104 /* ltt_tracefile_read cut down in pieces */
 105 int ltt_tracefile_read_seek(LttTracefile *t);
 106 int ltt_tracefile_read_update_event(LttTracefile *t);
 107 int ltt_tracefile_read_op(LttTracefile *t);
 108
 109 /* open tracefile */
 110
 111 gint ltt_tracefile_open(LttTrace *t, gchar * fileName, LttTracefile *tf);
 112
 113 /* get the data type size and endian type of the local machine */
 114
 115 void getDataEndianType(LttArchSize * size, LttArchEndian * endian);
 116
 117 /* get an integer number */
 118 gint64 get_int(gboolean reverse_byte_order, gint size, void *data);
 119
 120 /* get the node name of the system */
 121
 122 gchar * ltt_trace_system_description_node_name (LttSystemDescription * s);
 123
 124
 125 /* get the domain name of the system */
 126
 127 gchar * ltt_trace_system_description_domain_name (LttSystemDescription * s);
 128
 129
 130 /* get the description of the system */
 131
 132 gchar * ltt_trace_system_description_description (LttSystemDescription * s);
 133
 134
 135 /* get the start time of the trace */
 136
 137 LttTime ltt_trace_system_description_trace_start_time(LttSystemDescription *s);
 138
 139 /* copy tracefile info over another. Used for sync. */
 140 LttTracefile *ltt_tracefile_new();
 141 void ltt_tracefile_destroy(LttTracefile *tf);
 142 void ltt_tracefile_copy(LttTracefile *dest, const LttTracefile *src);
 143
 144 void get_absolute_pathname(const gchar *pathname, gchar * abs_pathname);
 145
 146 GData *ltt_trace_get_tracefiles_groups(LttTrace *trace);
 147
 148 typedef void (*ForEachTraceFileFunc)(LttTracefile *tf, gpointer func_args);
 149
 150 struct compute_tracefile_group_args {
 151   ForEachTraceFileFunc func;
 152   gpointer func_args;
 153 };
 154
 155 void compute_tracefile_group(GArray *group,
 156                              struct compute_tracefile_group_args args);
 157
 158 LttFacility *ltt_trace_get_facility_by_num(LttTrace *t, guint num);
 159
 160
 161 gint check_fields_compatibility(LttEventType *event_type1,
 162     LttEventType *event_type2,
 163     LttField *field1, LttField *field2);
 164
 165 #endif // TRACE_H