1 /* This file is part of the Linux Trace Toolkit trace reading library
2 * Copyright (C) 2003-2004 Michel Dagenais
3 * 2005 Mathieu Desnoyers
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.
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.
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.
28 GQuark pathname
; //the pathname of the trace
29 //LttSystemDescription * system_description;//system description
36 guint8 ltt_major_version
;
37 guint8 ltt_minor_version
;
38 guint8 flight_recorder
;
42 uint64_t start_monotonic
;
44 LttTime start_time_from_tsc
;
46 GData
*tracefiles
; //tracefiles groups
47 /* Support for markers */
48 GArray
*markers
; //indexed by marker ID
49 GHashTable
*markers_hash
; //indexed by name hash
54 extern GQuark LTT_FACILITY_NAME_HEARTBEAT
,
55 LTT_EVENT_NAME_HEARTBEAT
,
56 LTT_EVENT_NAME_HEARTBEAT_FULL
;
58 /* A trace is specified as a pathname to the directory containing all the
59 associated data (control tracefiles, per cpu tracefiles, event
62 When a trace is closed, all the associated facilities, types and fields
65 return value is NULL if there is an error when opening the trace.
69 LttTrace
*ltt_trace_open(const gchar
*pathname
);
71 /* copy reopens a trace
73 * return value NULL if error while opening the trace
75 LttTrace
*ltt_trace_copy(LttTrace
*self
);
77 GQuark
ltt_trace_name(const LttTrace
*t
);
79 void ltt_trace_close(LttTrace
*t
);
81 guint
ltt_trace_get_num_cpu(LttTrace
*t
);
83 LttSystemDescription
*ltt_trace_system_description(LttTrace
*t
);
86 /* Functions to discover the facilities in the trace. Once the number
87 of facilities is known, they may be accessed by position. Multiple
88 versions of a facility (same name, different checksum) have consecutive
91 //unsigned ltt_trace_facility_number(LttTrace *t);
93 //LttFacility * ltt_trace_facility_by_id(LttTrace * trace, guint8 id);
95 /* Returns an array of indexes (guint) that matches the facility name */
96 //GArray *ltt_trace_facility_get_by_name(LttTrace *t, GQuark name);
98 /* Functions to discover all the event types in the trace */
100 //unsigned ltt_trace_eventtype_number(LttTrace *t);
102 //LttEventType *ltt_trace_eventtype_get(LttTrace *t, unsigned i);
105 /* Get the start time and end time of the trace */
107 void ltt_trace_time_span_get(LttTrace
*t
, LttTime
*start
, LttTime
*end
);
110 /* Get the name of a tracefile */
112 GQuark
ltt_tracefile_name(const LttTracefile
*tf
);
113 GQuark
ltt_tracefile_long_name(const LttTracefile
*tf
);
115 /* get the cpu number of the tracefile */
117 guint
ltt_tracefile_cpu(LttTracefile
*tf
);
120 guint
ltt_tracefile_tid(LttTracefile
*tf
);
121 guint
ltt_tracefile_pgid(LttTracefile
*tf
);
122 guint64
ltt_tracefile_creation(LttTracefile
*tf
);
125 LttTrace
*ltt_tracefile_get_trace(LttTracefile
*tf
);
127 /* Get the number of blocks in the tracefile */
129 unsigned ltt_tracefile_block_number(LttTracefile
*tf
);
132 /* Seek to the first event of the trace with time larger or equal to time */
134 int ltt_tracefile_seek_time(LttTracefile
*t
, LttTime time
);
136 /* Seek to the first event with position equal or larger to ep */
138 int ltt_tracefile_seek_position(LttTracefile
*t
,
139 const LttEventPosition
*ep
);
141 /* Read the next event */
143 int ltt_tracefile_read(LttTracefile
*t
);
145 /* ltt_tracefile_read cut down in pieces */
146 int ltt_tracefile_read_seek(LttTracefile
*t
);
147 int ltt_tracefile_read_update_event(LttTracefile
*t
);
148 int ltt_tracefile_read_op(LttTracefile
*t
);
150 /* Get the current event of the tracefile : valid until the next read */
151 LttEvent
*ltt_tracefile_get_event(LttTracefile
*tf
);
155 gint
ltt_tracefile_open(LttTrace
*t
, gchar
* fileName
, LttTracefile
*tf
);
157 /* get the data type size and endian type of the local machine */
159 void getDataEndianType(LttArchSize
* size
, LttArchEndian
* endian
);
161 /* get an integer number */
162 gint64
get_int(gboolean reverse_byte_order
, gint size
, void *data
);
164 /* get the node name of the system */
166 gchar
* ltt_trace_system_description_node_name (LttSystemDescription
* s
);
169 /* get the domain name of the system */
171 gchar
* ltt_trace_system_description_domain_name (LttSystemDescription
* s
);
174 /* get the description of the system */
176 gchar
* ltt_trace_system_description_description (LttSystemDescription
* s
);
179 /* get the NTP start time of the trace */
181 LttTime
ltt_trace_start_time(LttTrace
*t
);
183 /* get the monotonic start time of the trace */
185 LttTime
ltt_trace_start_time_monotonic(LttTrace
*t
);
187 /* copy tracefile info over another. Used for sync. */
188 LttTracefile
*ltt_tracefile_new();
189 void ltt_tracefile_destroy(LttTracefile
*tf
);
190 void ltt_tracefile_copy(LttTracefile
*dest
, const LttTracefile
*src
);
192 void get_absolute_pathname(const gchar
*pathname
, gchar
* abs_pathname
);
194 /* May return a NULL tracefile group */
195 GData
**ltt_trace_get_tracefiles_groups(LttTrace
*trace
);
197 typedef void (*ForEachTraceFileFunc
)(LttTracefile
*tf
, gpointer func_args
);
199 struct compute_tracefile_group_args
{
200 ForEachTraceFileFunc func
;
205 void compute_tracefile_group(GQuark key_id
,
207 struct compute_tracefile_group_args
*args
);
209 //LttFacility *ltt_trace_get_facility_by_num(LttTrace *t, guint num);
212 //gint check_fields_compatibility(LttEventType *event_type1,
213 // LttEventType *event_type2,
214 // LttField *field1, LttField *field2);
216 gint64
ltt_get_int(gboolean reverse_byte_order
, gint size
, void *data
);
218 guint64
ltt_get_uint(gboolean reverse_byte_order
, gint size
, void *data
);
220 LttTime
ltt_interpolate_time_from_tsc(LttTracefile
*tf
, guint64 tsc
);
222 /* Set to enable event debugging output */
223 void ltt_event_debug(int state
);