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 /* A trace is specified as a pathname to the directory containing all the
25 associated data (control tracefiles, per cpu tracefiles, event
28 When a trace is closed, all the associated facilities, types and fields
29 are released as well. */
31 LttTrace
*ltt_trace_open(const char *pathname
);
33 /* copy reopens a trace */
34 LttTrace
*ltt_trace_copy(LttTrace
*self
);
36 char * ltt_trace_name(LttTrace
*t
);
38 void ltt_trace_close(LttTrace
*t
);
41 LttSystemDescription
*ltt_trace_system_description(LttTrace
*t
);
44 /* Functions to discover the facilities in the trace. Once the number
45 of facilities is known, they may be accessed by position. Multiple
46 versions of a facility (same name, different checksum) have consecutive
49 unsigned ltt_trace_facility_number(LttTrace
*t
);
51 LttFacility
*ltt_trace_facility_get(LttTrace
*t
, unsigned i
);
53 LttFacility
* ltt_trace_facility_by_id(LttTrace
* trace
, unsigned id
);
55 /* Look for a facility by name. It returns the number of facilities found
56 and sets the position argument to the first found. Returning 0, the named
57 facility is unknown, returning 1, the named facility is at the specified
58 position, returning n, the facilities are from position to
61 unsigned ltt_trace_facility_find(LttTrace
*t
, char *name
, unsigned *position
);
64 /* Functions to discover all the event types in the trace */
66 unsigned ltt_trace_eventtype_number(LttTrace
*t
);
68 LttEventType
*ltt_trace_eventtype_get(LttTrace
*t
, unsigned i
);
71 /* There is one "per cpu" tracefile for each CPU, numbered from 0 to
72 the maximum number of CPU in the system. When the number of CPU installed
73 is less than the maximum, some positions are unused. There are also a
74 number of "control" tracefiles (facilities, interrupts...). */
76 unsigned ltt_trace_control_tracefile_number(LttTrace
*t
);
78 unsigned ltt_trace_per_cpu_tracefile_number(LttTrace
*t
);
81 /* It is possible to search for the tracefiles by name or by CPU position.
82 The index within the tracefiles of the same type is returned if found
83 and a negative value otherwise. */
85 int ltt_trace_control_tracefile_find(LttTrace
*t
, char *name
);
87 int ltt_trace_per_cpu_tracefile_find(LttTrace
*t
, unsigned i
);
90 /* Get a specific tracefile */
92 LttTracefile
*ltt_trace_control_tracefile_get(LttTrace
*t
, unsigned i
);
94 LttTracefile
*ltt_trace_per_cpu_tracefile_get(LttTrace
*t
, unsigned i
);
97 /* Get the start time and end time of the trace */
99 void ltt_trace_time_span_get(LttTrace
*t
, LttTime
*start
, LttTime
*end
);
102 /* Get the name of a tracefile */
104 char *ltt_tracefile_name(LttTracefile
*tf
);
107 /* Get the number of blocks in the tracefile */
109 unsigned ltt_tracefile_block_number(LttTracefile
*tf
);
112 /* Seek to the first event of the trace with time larger or equal to time */
114 void ltt_tracefile_seek_time(LttTracefile
*t
, LttTime time
);
116 /* Seek to the first event with position equal or larger to ep */
118 void ltt_tracefile_seek_position(LttTracefile
*t
,
119 LttEventPosition
*ep
);
121 /* Read the next event */
123 LttEvent
*ltt_tracefile_read(LttTracefile
*t
);
127 LttTracefile
* ltt_tracefile_open(LttTrace
*t
, char * tracefile_name
);
129 void ltt_tracefile_open_cpu(LttTrace
*t
, char * tracefile_name
);
131 void ltt_tracefile_open_control(LttTrace
*t
, char * control_name
);
134 /* obtain the time of an event */
136 LttTime
getEventTime(LttTracefile
* tf
);
139 /* get the data type size and endian type of the local machine */
141 void getDataEndianType(LttArchSize
* size
, LttArchEndian
* endian
);
143 /* get an integer number */
145 int getIntNumber(int size1
, void *evD
);
148 /* get the node name of the system */
150 char * ltt_trace_system_description_node_name (LttSystemDescription
* s
);
153 /* get the domain name of the system */
155 char * ltt_trace_system_description_domain_name (LttSystemDescription
* s
);
158 /* get the description of the system */
160 char * ltt_trace_system_description_description (LttSystemDescription
* s
);
163 /* get the start time of the trace */
165 LttTime
ltt_trace_system_description_trace_start_time(LttSystemDescription
*s
);
This page took 0.031624 seconds and 4 git commands to generate.