9c312311 |
1 | /* This file is part of the Linux Trace Toolkit trace reading library |
2 | * Copyright (C) 2003-2004 Michel Dagenais |
3 | * |
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. |
7 | * |
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. |
12 | * |
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. |
17 | */ |
18 | |
963b5f2d |
19 | #ifndef TRACE_H |
20 | #define TRACE_H |
1b82f325 |
21 | |
22 | #include <ltt/ltt.h> |
23 | |
24 | /* A trace is specified as a pathname to the directory containing all the |
290dfc8c |
25 | associated data (control tracefiles, per cpu tracefiles, event |
1b82f325 |
26 | descriptions...). |
27 | |
28 | When a trace is closed, all the associated facilities, types and fields |
2a74fbf4 |
29 | are released as well. |
30 | |
31 | return value is NULL if there is an error when opening the trace. |
32 | |
33 | */ |
1b82f325 |
34 | |
f7afe191 |
35 | LttTrace *ltt_trace_open(const char *pathname); |
36 | |
2a74fbf4 |
37 | /* copy reopens a trace |
38 | * |
39 | * return value NULL if error while opening the trace |
40 | */ |
f7afe191 |
41 | LttTrace *ltt_trace_copy(LttTrace *self); |
1b82f325 |
42 | |
49bf71b5 |
43 | char * ltt_trace_name(LttTrace *t); |
44 | |
290dfc8c |
45 | void ltt_trace_close(LttTrace *t); |
1b82f325 |
46 | |
47 | |
963b5f2d |
48 | LttSystemDescription *ltt_trace_system_description(LttTrace *t); |
1b82f325 |
49 | |
1b82f325 |
50 | |
290dfc8c |
51 | /* Functions to discover the facilities in the trace. Once the number |
52 | of facilities is known, they may be accessed by position. Multiple |
53 | versions of a facility (same name, different checksum) have consecutive |
54 | positions. */ |
1b82f325 |
55 | |
290dfc8c |
56 | unsigned ltt_trace_facility_number(LttTrace *t); |
1b82f325 |
57 | |
290dfc8c |
58 | LttFacility *ltt_trace_facility_get(LttTrace *t, unsigned i); |
1b82f325 |
59 | |
a5dcde2f |
60 | LttFacility * ltt_trace_facility_by_id(LttTrace * trace, unsigned id); |
1b82f325 |
61 | |
290dfc8c |
62 | /* Look for a facility by name. It returns the number of facilities found |
63 | and sets the position argument to the first found. Returning 0, the named |
64 | facility is unknown, returning 1, the named facility is at the specified |
65 | position, returning n, the facilities are from position to |
66 | position + n - 1. */ |
1b82f325 |
67 | |
290dfc8c |
68 | unsigned ltt_trace_facility_find(LttTrace *t, char *name, unsigned *position); |
1b82f325 |
69 | |
70 | |
290dfc8c |
71 | /* Functions to discover all the event types in the trace */ |
1b82f325 |
72 | |
290dfc8c |
73 | unsigned ltt_trace_eventtype_number(LttTrace *t); |
1b82f325 |
74 | |
290dfc8c |
75 | LttEventType *ltt_trace_eventtype_get(LttTrace *t, unsigned i); |
1b82f325 |
76 | |
1b82f325 |
77 | |
290dfc8c |
78 | /* There is one "per cpu" tracefile for each CPU, numbered from 0 to |
79 | the maximum number of CPU in the system. When the number of CPU installed |
80 | is less than the maximum, some positions are unused. There are also a |
81 | number of "control" tracefiles (facilities, interrupts...). */ |
1b82f325 |
82 | |
290dfc8c |
83 | unsigned ltt_trace_control_tracefile_number(LttTrace *t); |
1b82f325 |
84 | |
290dfc8c |
85 | unsigned ltt_trace_per_cpu_tracefile_number(LttTrace *t); |
1b82f325 |
86 | |
1b82f325 |
87 | |
8d1e6362 |
88 | /* It is possible to search for the tracefiles by name or by CPU tracefile |
89 | * name. |
90 | * The index within the tracefiles of the same type is returned if found |
91 | * and a negative value otherwise. |
92 | */ |
1b82f325 |
93 | |
8d1e6362 |
94 | int ltt_trace_control_tracefile_find(LttTrace *t, const gchar *name); |
1b82f325 |
95 | |
8d1e6362 |
96 | int ltt_trace_per_cpu_tracefile_find(LttTrace *t, const gchar *name); |
1b82f325 |
97 | |
1b82f325 |
98 | |
290dfc8c |
99 | /* Get a specific tracefile */ |
1b82f325 |
100 | |
290dfc8c |
101 | LttTracefile *ltt_trace_control_tracefile_get(LttTrace *t, unsigned i); |
1b82f325 |
102 | |
290dfc8c |
103 | LttTracefile *ltt_trace_per_cpu_tracefile_get(LttTrace *t, unsigned i); |
1b82f325 |
104 | |
1b82f325 |
105 | |
487ad181 |
106 | /* Get the start time and end time of the trace */ |
107 | |
108 | void ltt_trace_time_span_get(LttTrace *t, LttTime *start, LttTime *end); |
109 | |
110 | |
290dfc8c |
111 | /* Get the name of a tracefile */ |
1b82f325 |
112 | |
290dfc8c |
113 | char *ltt_tracefile_name(LttTracefile *tf); |
1b82f325 |
114 | |
115 | |
80da81ad |
116 | /* Get the number of blocks in the tracefile */ |
117 | |
118 | unsigned ltt_tracefile_block_number(LttTracefile *tf); |
119 | |
120 | |
1b82f325 |
121 | /* Seek to the first event of the trace with time larger or equal to time */ |
122 | |
290dfc8c |
123 | void ltt_tracefile_seek_time(LttTracefile *t, LttTime time); |
1b82f325 |
124 | |
80da81ad |
125 | /* Seek to the first event with position equal or larger to ep */ |
126 | |
127 | void ltt_tracefile_seek_position(LttTracefile *t, |
04b44e05 |
128 | const LttEventPosition *ep); |
1b82f325 |
129 | |
130 | /* Read the next event */ |
131 | |
c02ea99f |
132 | LttEvent *ltt_tracefile_read(LttTracefile *t, LttEvent *event); |
1b82f325 |
133 | |
a5dcde2f |
134 | /* open tracefile */ |
135 | |
136 | LttTracefile * ltt_tracefile_open(LttTrace *t, char * tracefile_name); |
137 | |
138 | void ltt_tracefile_open_cpu(LttTrace *t, char * tracefile_name); |
139 | |
2a74fbf4 |
140 | gint ltt_tracefile_open_control(LttTrace *t, char * control_name); |
a5dcde2f |
141 | |
142 | |
143 | /* obtain the time of an event */ |
144 | |
145 | LttTime getEventTime(LttTracefile * tf); |
146 | |
147 | |
148 | /* get the data type size and endian type of the local machine */ |
149 | |
150 | void getDataEndianType(LttArchSize * size, LttArchEndian * endian); |
151 | |
152 | /* get an integer number */ |
153 | |
cf74a6f1 |
154 | gint64 getIntNumber(int size1, void *evD); |
a5dcde2f |
155 | |
156 | |
157 | /* get the node name of the system */ |
158 | |
159 | char * ltt_trace_system_description_node_name (LttSystemDescription * s); |
160 | |
161 | |
162 | /* get the domain name of the system */ |
163 | |
164 | char * ltt_trace_system_description_domain_name (LttSystemDescription * s); |
165 | |
166 | |
167 | /* get the description of the system */ |
168 | |
169 | char * ltt_trace_system_description_description (LttSystemDescription * s); |
170 | |
171 | |
172 | /* get the start time of the trace */ |
173 | |
174 | LttTime ltt_trace_system_description_trace_start_time(LttSystemDescription *s); |
175 | |
18206708 |
176 | /* copy tracefile info over another. Used for sync. */ |
177 | LttTracefile *ltt_tracefile_new(); |
178 | void ltt_tracefile_destroy(LttTracefile *tf); |
179 | void ltt_tracefile_copy(LttTracefile *dest, const LttTracefile *src); |
180 | |
181 | |
1b82f325 |
182 | #endif // TRACE_H |