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.
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(LttTrace
*t
);
49 void ltt_trace_close(LttTrace
*t
);
52 LttSystemDescription
*ltt_trace_system_description(LttTrace
*t
);
55 /* Functions to discover the facilities in the trace. Once the number
56 of facilities is known, they may be accessed by position. Multiple
57 versions of a facility (same name, different checksum) have consecutive
60 unsigned ltt_trace_facility_number(LttTrace
*t
);
62 LttFacility
*ltt_trace_facility_get(LttTrace
*t
, unsigned i
);
64 LttFacility
* ltt_trace_facility_by_id(LttTrace
* trace
, guint8 id
);
66 /* Look for a facility by name. It returns the number of facilities found
67 and sets the position argument to the first found. Returning 0, the named
68 facility is unknown, returning 1, the named facility is at the specified
69 position, returning n, the facilities are from position to
72 unsigned ltt_trace_facility_find(LttTrace
*t
, gchar
*name
, unsigned *position
);
75 /* Functions to discover all the event types in the trace */
77 unsigned ltt_trace_eventtype_number(LttTrace
*t
);
79 LttEventType
*ltt_trace_eventtype_get(LttTrace
*t
, unsigned i
);
82 /* Get the start time and end time of the trace */
84 void ltt_trace_time_span_get(LttTrace
*t
, LttTime
*start
, LttTime
*end
);
87 /* Get the name of a tracefile */
89 GQuark
ltt_tracefile_name(LttTracefile
*tf
);
92 /* Get the number of blocks in the tracefile */
94 unsigned ltt_tracefile_block_number(LttTracefile
*tf
);
97 /* Seek to the first event of the trace with time larger or equal to time */
99 int ltt_tracefile_seek_time(LttTracefile
*t
, LttTime time
);
101 /* Seek to the first event with position equal or larger to ep */
103 int ltt_tracefile_seek_position(LttTracefile
*t
,
104 const LttEventPosition
*ep
);
106 /* Read the next event */
108 int ltt_tracefile_read(LttTracefile
*t
);
110 /* ltt_tracefile_read cut down in pieces */
111 int ltt_tracefile_read_seek(LttTracefile
*t
);
112 int ltt_tracefile_read_update_event(LttTracefile
*t
);
113 int ltt_tracefile_read_op(LttTracefile
*t
);
117 gint
ltt_tracefile_open(LttTrace
*t
, gchar
* fileName
, LttTracefile
*tf
);
119 /* get the data type size and endian type of the local machine */
121 void getDataEndianType(LttArchSize
* size
, LttArchEndian
* endian
);
123 /* get an integer number */
124 gint64
get_int(gboolean reverse_byte_order
, gint size
, void *data
);
126 /* get the node name of the system */
128 gchar
* ltt_trace_system_description_node_name (LttSystemDescription
* s
);
131 /* get the domain name of the system */
133 gchar
* ltt_trace_system_description_domain_name (LttSystemDescription
* s
);
136 /* get the description of the system */
138 gchar
* ltt_trace_system_description_description (LttSystemDescription
* s
);
141 /* get the start time of the trace */
143 LttTime
ltt_trace_system_description_trace_start_time(LttSystemDescription
*s
);
145 /* copy tracefile info over another. Used for sync. */
146 LttTracefile
*ltt_tracefile_new();
147 void ltt_tracefile_destroy(LttTracefile
*tf
);
148 void ltt_tracefile_copy(LttTracefile
*dest
, const LttTracefile
*src
);
150 void get_absolute_pathname(const gchar
*pathname
, gchar
* abs_pathname
);