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 | |
8655430b |
53 | static inline guint ltt_trace_get_num_cpu(LttTrace *t) |
54 | { |
55 | return t->num_cpu; |
56 | } |
29af7cfd |
57 | |
1b82f325 |
58 | |
3aee1200 |
59 | extern GQuark LTT_FACILITY_NAME_HEARTBEAT, |
d1bb700c |
60 | LTT_EVENT_NAME_HEARTBEAT, |
61 | LTT_EVENT_NAME_HEARTBEAT_FULL; |
3aee1200 |
62 | |
1b82f325 |
63 | /* A trace is specified as a pathname to the directory containing all the |
290dfc8c |
64 | associated data (control tracefiles, per cpu tracefiles, event |
1b82f325 |
65 | descriptions...). |
66 | |
67 | When a trace is closed, all the associated facilities, types and fields |
2a74fbf4 |
68 | are released as well. |
69 | |
70 | return value is NULL if there is an error when opening the trace. |
71 | |
72 | */ |
1b82f325 |
73 | |
45e14832 |
74 | LttTrace *ltt_trace_open(const gchar *pathname); |
f7afe191 |
75 | |
2a74fbf4 |
76 | /* copy reopens a trace |
77 | * |
78 | * return value NULL if error while opening the trace |
79 | */ |
f7afe191 |
80 | LttTrace *ltt_trace_copy(LttTrace *self); |
1b82f325 |
81 | |
8655430b |
82 | static inline GQuark ltt_trace_name(const LttTrace *t) |
83 | { |
84 | return t->pathname; |
85 | } |
49bf71b5 |
86 | |
1b82f325 |
87 | |
8655430b |
88 | void ltt_trace_close(LttTrace *t); |
1b82f325 |
89 | |
963b5f2d |
90 | LttSystemDescription *ltt_trace_system_description(LttTrace *t); |
1b82f325 |
91 | |
1b82f325 |
92 | |
487ad181 |
93 | /* Get the start time and end time of the trace */ |
94 | |
95 | void ltt_trace_time_span_get(LttTrace *t, LttTime *start, LttTime *end); |
96 | |
97 | |
290dfc8c |
98 | /* Get the name of a tracefile */ |
1b82f325 |
99 | |
8655430b |
100 | static inline GQuark ltt_tracefile_name(const LttTracefile *tf) |
101 | { |
102 | return tf->name; |
103 | } |
104 | |
105 | static inline GQuark ltt_tracefile_long_name(const LttTracefile *tf) |
106 | { |
107 | return tf->long_name; |
108 | } |
1b82f325 |
109 | |
d3d34f49 |
110 | /* get the cpu number of the tracefile */ |
111 | |
8655430b |
112 | static inline guint ltt_tracefile_cpu(LttTracefile *tf) |
113 | { |
114 | return tf->cpu_num; |
115 | } |
ae3d0f50 |
116 | |
117 | /* For usertrace */ |
8655430b |
118 | static inline guint ltt_tracefile_tid(LttTracefile *tf) |
119 | { |
120 | return tf->tid; |
121 | } |
122 | |
123 | static inline guint ltt_tracefile_pgid(LttTracefile *tf) |
124 | { |
125 | return tf->pgid; |
126 | } |
127 | |
128 | static inline guint64 ltt_tracefile_creation(LttTracefile *tf) |
129 | { |
130 | return tf->creation; |
131 | } |
132 | |
133 | static inline LttTrace *ltt_tracefile_get_trace(LttTracefile *tf) |
134 | { |
135 | return tf->trace; |
136 | } |
1b82f325 |
137 | |
80da81ad |
138 | /* Get the number of blocks in the tracefile */ |
139 | |
8655430b |
140 | static inline guint ltt_tracefile_block_number(LttTracefile *tf) |
141 | { |
142 | return tf->num_blocks; |
143 | } |
80da81ad |
144 | |
145 | |
1b82f325 |
146 | /* Seek to the first event of the trace with time larger or equal to time */ |
147 | |
3aee1200 |
148 | int ltt_tracefile_seek_time(LttTracefile *t, LttTime time); |
1b82f325 |
149 | |
80da81ad |
150 | /* Seek to the first event with position equal or larger to ep */ |
151 | |
3aee1200 |
152 | int ltt_tracefile_seek_position(LttTracefile *t, |
04b44e05 |
153 | const LttEventPosition *ep); |
1b82f325 |
154 | |
155 | /* Read the next event */ |
156 | |
3aee1200 |
157 | int ltt_tracefile_read(LttTracefile *t); |
a5dcde2f |
158 | |
3aee1200 |
159 | /* ltt_tracefile_read cut down in pieces */ |
160 | int ltt_tracefile_read_seek(LttTracefile *t); |
161 | int ltt_tracefile_read_update_event(LttTracefile *t); |
162 | int ltt_tracefile_read_op(LttTracefile *t); |
a5dcde2f |
163 | |
eed2ef37 |
164 | /* Get the current event of the tracefile : valid until the next read */ |
165 | LttEvent *ltt_tracefile_get_event(LttTracefile *tf); |
166 | |
a5dcde2f |
167 | /* get the data type size and endian type of the local machine */ |
168 | |
169 | void getDataEndianType(LttArchSize * size, LttArchEndian * endian); |
170 | |
171 | /* get an integer number */ |
3aee1200 |
172 | gint64 get_int(gboolean reverse_byte_order, gint size, void *data); |
a5dcde2f |
173 | |
174 | /* get the node name of the system */ |
175 | |
45e14832 |
176 | gchar * ltt_trace_system_description_node_name (LttSystemDescription * s); |
a5dcde2f |
177 | |
178 | |
179 | /* get the domain name of the system */ |
180 | |
45e14832 |
181 | gchar * ltt_trace_system_description_domain_name (LttSystemDescription * s); |
a5dcde2f |
182 | |
183 | |
184 | /* get the description of the system */ |
185 | |
45e14832 |
186 | gchar * ltt_trace_system_description_description (LttSystemDescription * s); |
a5dcde2f |
187 | |
188 | |
bf33dd50 |
189 | /* get the NTP start time of the trace */ |
a5dcde2f |
190 | |
7bd563ec |
191 | LttTime ltt_trace_start_time(LttTrace *t); |
a5dcde2f |
192 | |
bf33dd50 |
193 | /* get the monotonic start time of the trace */ |
194 | |
195 | LttTime ltt_trace_start_time_monotonic(LttTrace *t); |
196 | |
45e14832 |
197 | void get_absolute_pathname(const gchar *pathname, gchar * abs_pathname); |
18206708 |
198 | |
e45551ac |
199 | /* May return a NULL tracefile group */ |
3865ea09 |
200 | GData **ltt_trace_get_tracefiles_groups(LttTrace *trace); |
77175651 |
201 | |
202 | typedef void (*ForEachTraceFileFunc)(LttTracefile *tf, gpointer func_args); |
203 | |
204 | struct compute_tracefile_group_args { |
205 | ForEachTraceFileFunc func; |
206 | gpointer func_args; |
207 | }; |
208 | |
3865ea09 |
209 | void compute_tracefile_group(GQuark key_id, |
210 | GArray *group, |
211 | struct compute_tracefile_group_args *args); |
77175651 |
212 | |
3aee1200 |
213 | |
a0c1f622 |
214 | gint64 ltt_get_int(gboolean reverse_byte_order, gint size, void *data); |
215 | |
216 | guint64 ltt_get_uint(gboolean reverse_byte_order, gint size, void *data); |
217 | |
ae3d0f50 |
218 | LttTime ltt_interpolate_time_from_tsc(LttTracefile *tf, guint64 tsc); |
219 | |
91f8d488 |
220 | /* Set to enable event debugging output */ |
221 | void ltt_event_debug(int state); |
222 | |
1b82f325 |
223 | #endif // TRACE_H |