9c312311 |
1 | /* This file is part of the Linux Trace Toolkit trace reading library |
2 | * Copyright (C) 2003-2004 Michel Dagenais |
1b44b0b5 |
3 | * 2005 Mathieu Desnoyers |
9c312311 |
4 | * |
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. |
8 | * |
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. |
13 | * |
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. |
18 | */ |
19 | |
963b5f2d |
20 | #ifndef TRACE_H |
21 | #define TRACE_H |
1b82f325 |
22 | |
23 | #include <ltt/ltt.h> |
29af7cfd |
24 | #include <stdint.h> |
25 | #include <glib.h> |
26 | |
27 | struct LttTrace { |
28 | GQuark pathname; //the pathname of the trace |
29 | //LttSystemDescription * system_description;//system description |
30 | |
29af7cfd |
31 | guint num_cpu; |
32 | |
33 | guint32 arch_type; |
34 | guint32 arch_variant; |
35 | guint8 arch_size; |
36 | guint8 ltt_major_version; |
37 | guint8 ltt_minor_version; |
38 | guint8 flight_recorder; |
39 | guint32 freq_scale; |
40 | uint64_t start_freq; |
41 | uint64_t start_tsc; |
42 | uint64_t start_monotonic; |
43 | LttTime start_time; |
44 | LttTime start_time_from_tsc; |
29af7cfd |
45 | |
46 | GData *tracefiles; //tracefiles groups |
47 | /* Support for markers */ |
48 | GArray *markers; //indexed by marker ID |
49 | GHashTable *markers_hash; //indexed by name hash |
c09a11e9 |
50 | GHashTable *markers_format_hash; //indexed by name hash |
29af7cfd |
51 | }; |
52 | |
53 | |
1b82f325 |
54 | |
3aee1200 |
55 | extern GQuark LTT_FACILITY_NAME_HEARTBEAT, |
d1bb700c |
56 | LTT_EVENT_NAME_HEARTBEAT, |
57 | LTT_EVENT_NAME_HEARTBEAT_FULL; |
3aee1200 |
58 | |
1b82f325 |
59 | /* A trace is specified as a pathname to the directory containing all the |
290dfc8c |
60 | associated data (control tracefiles, per cpu tracefiles, event |
1b82f325 |
61 | descriptions...). |
62 | |
63 | When a trace is closed, all the associated facilities, types and fields |
2a74fbf4 |
64 | are released as well. |
65 | |
66 | return value is NULL if there is an error when opening the trace. |
67 | |
68 | */ |
1b82f325 |
69 | |
45e14832 |
70 | LttTrace *ltt_trace_open(const gchar *pathname); |
f7afe191 |
71 | |
2a74fbf4 |
72 | /* copy reopens a trace |
73 | * |
74 | * return value NULL if error while opening the trace |
75 | */ |
f7afe191 |
76 | LttTrace *ltt_trace_copy(LttTrace *self); |
1b82f325 |
77 | |
826f1ab2 |
78 | GQuark ltt_trace_name(const LttTrace *t); |
49bf71b5 |
79 | |
290dfc8c |
80 | void ltt_trace_close(LttTrace *t); |
1b82f325 |
81 | |
b56dcdf2 |
82 | guint ltt_trace_get_num_cpu(LttTrace *t); |
1b82f325 |
83 | |
963b5f2d |
84 | LttSystemDescription *ltt_trace_system_description(LttTrace *t); |
1b82f325 |
85 | |
1b82f325 |
86 | |
290dfc8c |
87 | /* Functions to discover the facilities in the trace. Once the number |
88 | of facilities is known, they may be accessed by position. Multiple |
89 | versions of a facility (same name, different checksum) have consecutive |
90 | positions. */ |
1b82f325 |
91 | |
29af7cfd |
92 | //unsigned ltt_trace_facility_number(LttTrace *t); |
1b82f325 |
93 | |
29af7cfd |
94 | //LttFacility * ltt_trace_facility_by_id(LttTrace * trace, guint8 id); |
1b82f325 |
95 | |
77175651 |
96 | /* Returns an array of indexes (guint) that matches the facility name */ |
29af7cfd |
97 | //GArray *ltt_trace_facility_get_by_name(LttTrace *t, GQuark name); |
1b82f325 |
98 | |
290dfc8c |
99 | /* Functions to discover all the event types in the trace */ |
1b82f325 |
100 | |
29af7cfd |
101 | //unsigned ltt_trace_eventtype_number(LttTrace *t); |
1b82f325 |
102 | |
29af7cfd |
103 | //LttEventType *ltt_trace_eventtype_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 | |
348c6ba8 |
113 | GQuark ltt_tracefile_name(const LttTracefile *tf); |
114 | GQuark ltt_tracefile_long_name(const LttTracefile *tf); |
1b82f325 |
115 | |
d3d34f49 |
116 | /* get the cpu number of the tracefile */ |
117 | |
ae3d0f50 |
118 | guint ltt_tracefile_cpu(LttTracefile *tf); |
119 | |
120 | /* For usertrace */ |
121 | guint ltt_tracefile_tid(LttTracefile *tf); |
122 | guint ltt_tracefile_pgid(LttTracefile *tf); |
123 | guint64 ltt_tracefile_creation(LttTracefile *tf); |
124 | |
d3d34f49 |
125 | |
126 | LttTrace *ltt_tracefile_get_trace(LttTracefile *tf); |
1b82f325 |
127 | |
80da81ad |
128 | /* Get the number of blocks in the tracefile */ |
129 | |
130 | unsigned ltt_tracefile_block_number(LttTracefile *tf); |
131 | |
132 | |
1b82f325 |
133 | /* Seek to the first event of the trace with time larger or equal to time */ |
134 | |
3aee1200 |
135 | int ltt_tracefile_seek_time(LttTracefile *t, LttTime time); |
1b82f325 |
136 | |
80da81ad |
137 | /* Seek to the first event with position equal or larger to ep */ |
138 | |
3aee1200 |
139 | int ltt_tracefile_seek_position(LttTracefile *t, |
04b44e05 |
140 | const LttEventPosition *ep); |
1b82f325 |
141 | |
142 | /* Read the next event */ |
143 | |
3aee1200 |
144 | int ltt_tracefile_read(LttTracefile *t); |
a5dcde2f |
145 | |
3aee1200 |
146 | /* ltt_tracefile_read cut down in pieces */ |
147 | int ltt_tracefile_read_seek(LttTracefile *t); |
148 | int ltt_tracefile_read_update_event(LttTracefile *t); |
149 | int ltt_tracefile_read_op(LttTracefile *t); |
a5dcde2f |
150 | |
eed2ef37 |
151 | /* Get the current event of the tracefile : valid until the next read */ |
152 | LttEvent *ltt_tracefile_get_event(LttTracefile *tf); |
153 | |
3aee1200 |
154 | /* open tracefile */ |
a5dcde2f |
155 | |
3aee1200 |
156 | gint ltt_tracefile_open(LttTrace *t, gchar * fileName, LttTracefile *tf); |
a5dcde2f |
157 | |
a5dcde2f |
158 | /* get the data type size and endian type of the local machine */ |
159 | |
160 | void getDataEndianType(LttArchSize * size, LttArchEndian * endian); |
161 | |
162 | /* get an integer number */ |
3aee1200 |
163 | gint64 get_int(gboolean reverse_byte_order, gint size, void *data); |
a5dcde2f |
164 | |
165 | /* get the node name of the system */ |
166 | |
45e14832 |
167 | gchar * ltt_trace_system_description_node_name (LttSystemDescription * s); |
a5dcde2f |
168 | |
169 | |
170 | /* get the domain name of the system */ |
171 | |
45e14832 |
172 | gchar * ltt_trace_system_description_domain_name (LttSystemDescription * s); |
a5dcde2f |
173 | |
174 | |
175 | /* get the description of the system */ |
176 | |
45e14832 |
177 | gchar * ltt_trace_system_description_description (LttSystemDescription * s); |
a5dcde2f |
178 | |
179 | |
bf33dd50 |
180 | /* get the NTP start time of the trace */ |
a5dcde2f |
181 | |
7bd563ec |
182 | LttTime ltt_trace_start_time(LttTrace *t); |
a5dcde2f |
183 | |
bf33dd50 |
184 | /* get the monotonic start time of the trace */ |
185 | |
186 | LttTime ltt_trace_start_time_monotonic(LttTrace *t); |
187 | |
18206708 |
188 | /* copy tracefile info over another. Used for sync. */ |
189 | LttTracefile *ltt_tracefile_new(); |
190 | void ltt_tracefile_destroy(LttTracefile *tf); |
191 | void ltt_tracefile_copy(LttTracefile *dest, const LttTracefile *src); |
192 | |
45e14832 |
193 | void get_absolute_pathname(const gchar *pathname, gchar * abs_pathname); |
18206708 |
194 | |
e45551ac |
195 | /* May return a NULL tracefile group */ |
3865ea09 |
196 | GData **ltt_trace_get_tracefiles_groups(LttTrace *trace); |
77175651 |
197 | |
198 | typedef void (*ForEachTraceFileFunc)(LttTracefile *tf, gpointer func_args); |
199 | |
200 | struct compute_tracefile_group_args { |
201 | ForEachTraceFileFunc func; |
202 | gpointer func_args; |
203 | }; |
204 | |
3865ea09 |
205 | |
206 | void compute_tracefile_group(GQuark key_id, |
207 | GArray *group, |
208 | struct compute_tracefile_group_args *args); |
77175651 |
209 | |
29af7cfd |
210 | //LttFacility *ltt_trace_get_facility_by_num(LttTrace *t, guint num); |
77175651 |
211 | |
3aee1200 |
212 | |
29af7cfd |
213 | //gint check_fields_compatibility(LttEventType *event_type1, |
214 | // LttEventType *event_type2, |
215 | // LttField *field1, LttField *field2); |
3aee1200 |
216 | |
a0c1f622 |
217 | gint64 ltt_get_int(gboolean reverse_byte_order, gint size, void *data); |
218 | |
219 | guint64 ltt_get_uint(gboolean reverse_byte_order, gint size, void *data); |
220 | |
ae3d0f50 |
221 | LttTime ltt_interpolate_time_from_tsc(LttTracefile *tf, guint64 tsc); |
222 | |
91f8d488 |
223 | /* Set to enable event debugging output */ |
224 | void ltt_event_debug(int state); |
225 | |
1b82f325 |
226 | #endif // TRACE_H |