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.
25 extern GQuark LTT_FACILITY_NAME_HEARTBEAT
,
26 LTT_EVENT_NAME_HEARTBEAT
,
27 LTT_EVENT_NAME_HEARTBEAT_FULL
;
29 /* A trace is specified as a pathname to the directory containing all the
30 associated data (control tracefiles, per cpu tracefiles, event
33 When a trace is closed, all the associated facilities, types and fields
36 return value is NULL if there is an error when opening the trace.
40 LttTrace
*ltt_trace_open(const gchar
*pathname
);
42 /* copy reopens a trace
44 * return value NULL if error while opening the trace
46 LttTrace
*ltt_trace_copy(LttTrace
*self
);
48 GQuark
ltt_trace_name(const LttTrace
*t
);
50 void ltt_trace_close(LttTrace
*t
);
52 guint
ltt_trace_get_num_cpu(LttTrace
*t
);
54 LttSystemDescription
*ltt_trace_system_description(LttTrace
*t
);
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
62 unsigned ltt_trace_facility_number(LttTrace
*t
);
64 LttFacility
*ltt_trace_facility_get(LttTrace
*t
, unsigned i
);
66 LttFacility
* ltt_trace_facility_by_id(LttTrace
* trace
, guint8 id
);
68 /* Returns an array of indexes (guint) that matches the facility name */
69 GArray
*ltt_trace_facility_get_by_name(LttTrace
*t
, GQuark name
);
71 /* Functions to discover all the event types in the trace */
73 unsigned ltt_trace_eventtype_number(LttTrace
*t
);
75 LttEventType
*ltt_trace_eventtype_get(LttTrace
*t
, unsigned i
);
78 /* Get the start time and end time of the trace */
80 void ltt_trace_time_span_get(LttTrace
*t
, LttTime
*start
, LttTime
*end
);
83 /* Get the name of a tracefile */
85 GQuark
ltt_tracefile_name(const LttTracefile
*tf
);
86 GQuark
ltt_tracefile_long_name(const LttTracefile
*tf
);
88 /* get the cpu number of the tracefile */
90 guint
ltt_tracefile_cpu(LttTracefile
*tf
);
93 guint
ltt_tracefile_tid(LttTracefile
*tf
);
94 guint
ltt_tracefile_pgid(LttTracefile
*tf
);
95 guint64
ltt_tracefile_creation(LttTracefile
*tf
);
98 LttTrace
*ltt_tracefile_get_trace(LttTracefile
*tf
);
100 /* Get the number of blocks in the tracefile */
102 unsigned ltt_tracefile_block_number(LttTracefile
*tf
);
105 /* Seek to the first event of the trace with time larger or equal to time */
107 int ltt_tracefile_seek_time(LttTracefile
*t
, LttTime time
);
109 /* Seek to the first event with position equal or larger to ep */
111 int ltt_tracefile_seek_position(LttTracefile
*t
,
112 const LttEventPosition
*ep
);
114 /* Read the next event */
116 int ltt_tracefile_read(LttTracefile
*t
);
118 /* ltt_tracefile_read cut down in pieces */
119 int ltt_tracefile_read_seek(LttTracefile
*t
);
120 int ltt_tracefile_read_update_event(LttTracefile
*t
);
121 int ltt_tracefile_read_op(LttTracefile
*t
);
123 /* Get the current event of the tracefile : valid until the next read */
124 LttEvent
*ltt_tracefile_get_event(LttTracefile
*tf
);
128 gint
ltt_tracefile_open(LttTrace
*t
, gchar
* fileName
, LttTracefile
*tf
);
130 /* get the data type size and endian type of the local machine */
132 void getDataEndianType(LttArchSize
* size
, LttArchEndian
* endian
);
134 /* get an integer number */
135 gint64
get_int(gboolean reverse_byte_order
, gint size
, void *data
);
137 /* get the node name of the system */
139 gchar
* ltt_trace_system_description_node_name (LttSystemDescription
* s
);
142 /* get the domain name of the system */
144 gchar
* ltt_trace_system_description_domain_name (LttSystemDescription
* s
);
147 /* get the description of the system */
149 gchar
* ltt_trace_system_description_description (LttSystemDescription
* s
);
152 /* get the NTP start time of the trace */
154 LttTime
ltt_trace_start_time(LttTrace
*t
);
156 /* get the monotonic start time of the trace */
158 LttTime
ltt_trace_start_time_monotonic(LttTrace
*t
);
160 /* copy tracefile info over another. Used for sync. */
161 LttTracefile
*ltt_tracefile_new();
162 void ltt_tracefile_destroy(LttTracefile
*tf
);
163 void ltt_tracefile_copy(LttTracefile
*dest
, const LttTracefile
*src
);
165 void get_absolute_pathname(const gchar
*pathname
, gchar
* abs_pathname
);
167 /* May return a NULL tracefile group */
168 GData
**ltt_trace_get_tracefiles_groups(LttTrace
*trace
);
170 typedef void (*ForEachTraceFileFunc
)(LttTracefile
*tf
, gpointer func_args
);
172 struct compute_tracefile_group_args
{
173 ForEachTraceFileFunc func
;
178 void compute_tracefile_group(GQuark key_id
,
180 struct compute_tracefile_group_args
*args
);
182 LttFacility
*ltt_trace_get_facility_by_num(LttTrace
*t
, guint num
);
185 gint
check_fields_compatibility(LttEventType
*event_type1
,
186 LttEventType
*event_type2
,
187 LttField
*field1
, LttField
*field2
);
189 gint64
ltt_get_int(gboolean reverse_byte_order
, gint size
, void *data
);
191 guint64
ltt_get_uint(gboolean reverse_byte_order
, gint size
, void *data
);
193 LttTime
ltt_interpolate_time_from_tsc(LttTracefile
*tf
, guint64 tsc
);