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
50 GHashTable
*markers_format_hash
; //indexed by name hash
53 static inline guint
ltt_trace_get_num_cpu(LttTrace
*t
)
59 extern GQuark LTT_FACILITY_NAME_HEARTBEAT
,
60 LTT_EVENT_NAME_HEARTBEAT
,
61 LTT_EVENT_NAME_HEARTBEAT_FULL
;
63 /* A trace is specified as a pathname to the directory containing all the
64 associated data (control tracefiles, per cpu tracefiles, event
67 When a trace is closed, all the associated facilities, types and fields
70 return value is NULL if there is an error when opening the trace.
74 LttTrace
*ltt_trace_open(const gchar
*pathname
);
76 /* copy reopens a trace
78 * return value NULL if error while opening the trace
80 LttTrace
*ltt_trace_copy(LttTrace
*self
);
82 static inline GQuark
ltt_trace_name(const LttTrace
*t
)
88 void ltt_trace_close(LttTrace
*t
);
90 LttSystemDescription
*ltt_trace_system_description(LttTrace
*t
);
93 /* Get the start time and end time of the trace */
95 void ltt_trace_time_span_get(LttTrace
*t
, LttTime
*start
, LttTime
*end
);
98 /* Get the name of a tracefile */
100 static inline GQuark
ltt_tracefile_name(const LttTracefile
*tf
)
105 static inline GQuark
ltt_tracefile_long_name(const LttTracefile
*tf
)
107 return tf
->long_name
;
110 /* get the cpu number of the tracefile */
112 static inline guint
ltt_tracefile_cpu(LttTracefile
*tf
)
118 static inline guint
ltt_tracefile_tid(LttTracefile
*tf
)
123 static inline guint
ltt_tracefile_pgid(LttTracefile
*tf
)
128 static inline guint64
ltt_tracefile_creation(LttTracefile
*tf
)
133 static inline LttTrace
*ltt_tracefile_get_trace(LttTracefile
*tf
)
138 /* Get the number of blocks in the tracefile */
140 static inline guint
ltt_tracefile_block_number(LttTracefile
*tf
)
142 return tf
->num_blocks
;
146 /* Seek to the first event of the trace with time larger or equal to time */
148 int ltt_tracefile_seek_time(LttTracefile
*t
, LttTime time
);
150 /* Seek to the first event with position equal or larger to ep */
152 int ltt_tracefile_seek_position(LttTracefile
*t
,
153 const LttEventPosition
*ep
);
155 /* Read the next event */
157 int ltt_tracefile_read(LttTracefile
*t
);
159 /* ltt_tracefile_read cut down in pieces */
160 int ltt_tracefile_read_seek(LttTracefile
*t
);
161 int ltt_tracefile_read_update_event(LttTracefile
*t
);
162 int ltt_tracefile_read_op(LttTracefile
*t
);
164 /* Get the current event of the tracefile : valid until the next read */
165 LttEvent
*ltt_tracefile_get_event(LttTracefile
*tf
);
167 /* get the data type size and endian type of the local machine */
169 void getDataEndianType(LttArchSize
* size
, LttArchEndian
* endian
);
171 /* get an integer number */
172 gint64
get_int(gboolean reverse_byte_order
, gint size
, void *data
);
174 /* get the node name of the system */
176 gchar
* ltt_trace_system_description_node_name (LttSystemDescription
* s
);
179 /* get the domain name of the system */
181 gchar
* ltt_trace_system_description_domain_name (LttSystemDescription
* s
);
184 /* get the description of the system */
186 gchar
* ltt_trace_system_description_description (LttSystemDescription
* s
);
189 /* get the NTP start time of the trace */
191 LttTime
ltt_trace_start_time(LttTrace
*t
);
193 /* get the monotonic start time of the trace */
195 LttTime
ltt_trace_start_time_monotonic(LttTrace
*t
);
197 void get_absolute_pathname(const gchar
*pathname
, gchar
* abs_pathname
);
199 /* May return a NULL tracefile group */
200 GData
**ltt_trace_get_tracefiles_groups(LttTrace
*trace
);
202 typedef void (*ForEachTraceFileFunc
)(LttTracefile
*tf
, gpointer func_args
);
204 struct compute_tracefile_group_args
{
205 ForEachTraceFileFunc func
;
209 void compute_tracefile_group(GQuark key_id
,
211 struct compute_tracefile_group_args
*args
);
214 gint64
ltt_get_int(gboolean reverse_byte_order
, gint size
, void *data
);
216 guint64
ltt_get_uint(gboolean reverse_byte_order
, gint size
, void *data
);
218 LttTime
ltt_interpolate_time_from_tsc(LttTracefile
*tf
, guint64 tsc
);
220 /* Set to enable event debugging output */
221 void ltt_event_debug(int state
);