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