1 /* This file is part of the Linux Trace Toolkit trace reading library
2 * Copyright (C) 2003-2004 Michel Dagenais
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.
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.
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.
24 extern GQuark LTT_FACILITY_NAME_HEARTBEAT
,
25 LTT_EVENT_NAME_HEARTBEAT
;
27 /* A trace is specified as a pathname to the directory containing all the
28 associated data (control tracefiles, per cpu tracefiles, event
31 When a trace is closed, all the associated facilities, types and fields
34 return value is NULL if there is an error when opening the trace.
38 LttTrace
*ltt_trace_open(const gchar
*pathname
);
40 /* copy reopens a trace
42 * return value NULL if error while opening the trace
44 LttTrace
*ltt_trace_copy(LttTrace
*self
);
46 GQuark
ltt_trace_name(LttTrace
*t
);
48 void ltt_trace_close(LttTrace
*t
);
51 LttSystemDescription
*ltt_trace_system_description(LttTrace
*t
);
54 /* Functions to discover the facilities in the trace. Once the number
55 of facilities is known, they may be accessed by position. Multiple
56 versions of a facility (same name, different checksum) have consecutive
59 unsigned ltt_trace_facility_number(LttTrace
*t
);
61 LttFacility
*ltt_trace_facility_get(LttTrace
*t
, unsigned i
);
63 LttFacility
* ltt_trace_facility_by_id(LttTrace
* trace
, guint8 id
);
65 /* Returns an array of indexes (guint) that matches the facility name */
66 GArray
*ltt_trace_facility_get_by_name(LttTrace
*t
, GQuark name
);
68 /* Functions to discover all the event types in the trace */
70 unsigned ltt_trace_eventtype_number(LttTrace
*t
);
72 LttEventType
*ltt_trace_eventtype_get(LttTrace
*t
, unsigned i
);
75 /* Get the start time and end time of the trace */
77 void ltt_trace_time_span_get(LttTrace
*t
, LttTime
*start
, LttTime
*end
);
80 /* Get the name of a tracefile */
82 GQuark
ltt_tracefile_name(LttTracefile
*tf
);
84 /* get the cpu number of the tracefile */
86 guint
ltt_tracefile_num(LttTracefile
*tf
);
88 LttTrace
*ltt_tracefile_get_trace(LttTracefile
*tf
);
90 /* Get the number of blocks in the tracefile */
92 unsigned ltt_tracefile_block_number(LttTracefile
*tf
);
95 /* Seek to the first event of the trace with time larger or equal to time */
97 int ltt_tracefile_seek_time(LttTracefile
*t
, LttTime time
);
99 /* Seek to the first event with position equal or larger to ep */
101 int ltt_tracefile_seek_position(LttTracefile
*t
,
102 const LttEventPosition
*ep
);
104 /* Read the next event */
106 int ltt_tracefile_read(LttTracefile
*t
);
108 /* ltt_tracefile_read cut down in pieces */
109 int ltt_tracefile_read_seek(LttTracefile
*t
);
110 int ltt_tracefile_read_update_event(LttTracefile
*t
);
111 int ltt_tracefile_read_op(LttTracefile
*t
);
113 /* Get the current event of the tracefile : valid until the next read */
114 LttEvent
*ltt_tracefile_get_event(LttTracefile
*tf
);
118 gint
ltt_tracefile_open(LttTrace
*t
, gchar
* fileName
, LttTracefile
*tf
);
120 /* get the data type size and endian type of the local machine */
122 void getDataEndianType(LttArchSize
* size
, LttArchEndian
* endian
);
124 /* get an integer number */
125 gint64
get_int(gboolean reverse_byte_order
, gint size
, void *data
);
127 /* get the node name of the system */
129 gchar
* ltt_trace_system_description_node_name (LttSystemDescription
* s
);
132 /* get the domain name of the system */
134 gchar
* ltt_trace_system_description_domain_name (LttSystemDescription
* s
);
137 /* get the description of the system */
139 gchar
* ltt_trace_system_description_description (LttSystemDescription
* s
);
142 /* get the start time of the trace */
144 LttTime
ltt_trace_system_description_trace_start_time(LttSystemDescription
*s
);
146 /* copy tracefile info over another. Used for sync. */
147 LttTracefile
*ltt_tracefile_new();
148 void ltt_tracefile_destroy(LttTracefile
*tf
);
149 void ltt_tracefile_copy(LttTracefile
*dest
, const LttTracefile
*src
);
151 void get_absolute_pathname(const gchar
*pathname
, gchar
* abs_pathname
);
153 /* May return a NULL tracefile group */
154 GData
**ltt_trace_get_tracefiles_groups(LttTrace
*trace
);
156 typedef void (*ForEachTraceFileFunc
)(LttTracefile
*tf
, gpointer func_args
);
158 struct compute_tracefile_group_args
{
159 ForEachTraceFileFunc func
;
164 void compute_tracefile_group(GQuark key_id
,
166 struct compute_tracefile_group_args
*args
);
168 LttFacility
*ltt_trace_get_facility_by_num(LttTrace
*t
, guint num
);
171 gint
check_fields_compatibility(LttEventType
*event_type1
,
172 LttEventType
*event_type2
,
173 LttField
*field1
, LttField
*field2
);
175 gint64
ltt_get_int(gboolean reverse_byte_order
, gint size
, void *data
);
177 guint64
ltt_get_uint(gboolean reverse_byte_order
, gint size
, void *data
);