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
;
28 /* A trace is specified as a pathname to the directory containing all the
29 associated data (control tracefiles, per cpu tracefiles, event
32 When a trace is closed, all the associated facilities, types and fields
35 return value is NULL if there is an error when opening the trace.
39 LttTrace
*ltt_trace_open(const gchar
*pathname
);
41 /* copy reopens a trace
43 * return value NULL if error while opening the trace
45 LttTrace
*ltt_trace_copy(LttTrace
*self
);
47 GQuark
ltt_trace_name(const LttTrace
*t
);
49 void ltt_trace_close(LttTrace
*t
);
51 guint
ltt_trace_get_num_cpu(LttTrace
*t
);
53 LttSystemDescription
*ltt_trace_system_description(LttTrace
*t
);
56 /* Functions to discover the facilities in the trace. Once the number
57 of facilities is known, they may be accessed by position. Multiple
58 versions of a facility (same name, different checksum) have consecutive
61 unsigned ltt_trace_facility_number(LttTrace
*t
);
63 LttFacility
*ltt_trace_facility_get(LttTrace
*t
, unsigned i
);
65 LttFacility
* ltt_trace_facility_by_id(LttTrace
* trace
, guint8 id
);
67 /* Returns an array of indexes (guint) that matches the facility name */
68 GArray
*ltt_trace_facility_get_by_name(LttTrace
*t
, GQuark name
);
70 /* Functions to discover all the event types in the trace */
72 unsigned ltt_trace_eventtype_number(LttTrace
*t
);
74 LttEventType
*ltt_trace_eventtype_get(LttTrace
*t
, unsigned i
);
77 /* Get the start time and end time of the trace */
79 void ltt_trace_time_span_get(LttTrace
*t
, LttTime
*start
, LttTime
*end
);
82 /* Get the name of a tracefile */
84 GQuark
ltt_tracefile_name(const LttTracefile
*tf
);
85 GQuark
ltt_tracefile_long_name(const LttTracefile
*tf
);
87 /* get the cpu number of the tracefile */
89 guint
ltt_tracefile_cpu(LttTracefile
*tf
);
92 guint
ltt_tracefile_tid(LttTracefile
*tf
);
93 guint
ltt_tracefile_pgid(LttTracefile
*tf
);
94 guint64
ltt_tracefile_creation(LttTracefile
*tf
);
97 LttTrace
*ltt_tracefile_get_trace(LttTracefile
*tf
);
99 /* Get the number of blocks in the tracefile */
101 unsigned ltt_tracefile_block_number(LttTracefile
*tf
);
104 /* Seek to the first event of the trace with time larger or equal to time */
106 int ltt_tracefile_seek_time(LttTracefile
*t
, LttTime time
);
108 /* Seek to the first event with position equal or larger to ep */
110 int ltt_tracefile_seek_position(LttTracefile
*t
,
111 const LttEventPosition
*ep
);
113 /* Read the next event */
115 int ltt_tracefile_read(LttTracefile
*t
);
117 /* ltt_tracefile_read cut down in pieces */
118 int ltt_tracefile_read_seek(LttTracefile
*t
);
119 int ltt_tracefile_read_update_event(LttTracefile
*t
);
120 int ltt_tracefile_read_op(LttTracefile
*t
);
122 /* Get the current event of the tracefile : valid until the next read */
123 LttEvent
*ltt_tracefile_get_event(LttTracefile
*tf
);
127 gint
ltt_tracefile_open(LttTrace
*t
, gchar
* fileName
, LttTracefile
*tf
);
129 /* get the data type size and endian type of the local machine */
131 void getDataEndianType(LttArchSize
* size
, LttArchEndian
* endian
);
133 /* get an integer number */
134 gint64
get_int(gboolean reverse_byte_order
, gint size
, void *data
);
136 /* get the node name of the system */
138 gchar
* ltt_trace_system_description_node_name (LttSystemDescription
* s
);
141 /* get the domain name of the system */
143 gchar
* ltt_trace_system_description_domain_name (LttSystemDescription
* s
);
146 /* get the description of the system */
148 gchar
* ltt_trace_system_description_description (LttSystemDescription
* s
);
151 /* get the NTP start time of the trace */
153 LttTime
ltt_trace_start_time(LttTrace
*t
);
155 /* get the monotonic start time of the trace */
157 LttTime
ltt_trace_start_time_monotonic(LttTrace
*t
);
159 /* copy tracefile info over another. Used for sync. */
160 LttTracefile
*ltt_tracefile_new();
161 void ltt_tracefile_destroy(LttTracefile
*tf
);
162 void ltt_tracefile_copy(LttTracefile
*dest
, const LttTracefile
*src
);
164 void get_absolute_pathname(const gchar
*pathname
, gchar
* abs_pathname
);
166 /* May return a NULL tracefile group */
167 GData
**ltt_trace_get_tracefiles_groups(LttTrace
*trace
);
169 typedef void (*ForEachTraceFileFunc
)(LttTracefile
*tf
, gpointer func_args
);
171 struct compute_tracefile_group_args
{
172 ForEachTraceFileFunc func
;
177 void compute_tracefile_group(GQuark key_id
,
179 struct compute_tracefile_group_args
*args
);
181 LttFacility
*ltt_trace_get_facility_by_num(LttTrace
*t
, guint num
);
184 gint
check_fields_compatibility(LttEventType
*event_type1
,
185 LttEventType
*event_type2
,
186 LttField
*field1
, LttField
*field2
);
188 gint64
ltt_get_int(gboolean reverse_byte_order
, gint size
, void *data
);
190 guint64
ltt_get_uint(gboolean reverse_byte_order
, gint size
, void *data
);
192 LttTime
ltt_interpolate_time_from_tsc(LttTracefile
*tf
, guint64 tsc
);