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 | |
3aee1200 |
24 | extern GQuark LTT_FACILITY_NAME_HEARTBEAT, |
25 | LTT_EVENT_NAME_HEARTBEAT; |
26 | |
1b82f325 |
27 | /* A trace is specified as a pathname to the directory containing all the |
290dfc8c |
28 | associated data (control tracefiles, per cpu tracefiles, event |
1b82f325 |
29 | descriptions...). |
30 | |
31 | When a trace is closed, all the associated facilities, types and fields |
2a74fbf4 |
32 | are released as well. |
33 | |
34 | return value is NULL if there is an error when opening the trace. |
35 | |
36 | */ |
1b82f325 |
37 | |
45e14832 |
38 | LttTrace *ltt_trace_open(const gchar *pathname); |
f7afe191 |
39 | |
2a74fbf4 |
40 | /* copy reopens a trace |
41 | * |
42 | * return value NULL if error while opening the trace |
43 | */ |
f7afe191 |
44 | LttTrace *ltt_trace_copy(LttTrace *self); |
1b82f325 |
45 | |
826f1ab2 |
46 | GQuark ltt_trace_name(const LttTrace *t); |
49bf71b5 |
47 | |
290dfc8c |
48 | void ltt_trace_close(LttTrace *t); |
1b82f325 |
49 | |
b56dcdf2 |
50 | guint ltt_trace_get_num_cpu(LttTrace *t); |
1b82f325 |
51 | |
963b5f2d |
52 | LttSystemDescription *ltt_trace_system_description(LttTrace *t); |
1b82f325 |
53 | |
1b82f325 |
54 | |
290dfc8c |
55 | /* Functions to discover the facilities in the trace. Once the number |
56 | of facilities is known, they may be accessed by position. Multiple |
57 | versions of a facility (same name, different checksum) have consecutive |
58 | positions. */ |
1b82f325 |
59 | |
290dfc8c |
60 | unsigned ltt_trace_facility_number(LttTrace *t); |
1b82f325 |
61 | |
290dfc8c |
62 | LttFacility *ltt_trace_facility_get(LttTrace *t, unsigned i); |
1b82f325 |
63 | |
3aee1200 |
64 | LttFacility * ltt_trace_facility_by_id(LttTrace * trace, guint8 id); |
1b82f325 |
65 | |
77175651 |
66 | /* Returns an array of indexes (guint) that matches the facility name */ |
67 | GArray *ltt_trace_facility_get_by_name(LttTrace *t, GQuark name); |
1b82f325 |
68 | |
290dfc8c |
69 | /* Functions to discover all the event types in the trace */ |
1b82f325 |
70 | |
290dfc8c |
71 | unsigned ltt_trace_eventtype_number(LttTrace *t); |
1b82f325 |
72 | |
290dfc8c |
73 | LttEventType *ltt_trace_eventtype_get(LttTrace *t, unsigned i); |
1b82f325 |
74 | |
1b82f325 |
75 | |
487ad181 |
76 | /* Get the start time and end time of the trace */ |
77 | |
78 | void ltt_trace_time_span_get(LttTrace *t, LttTime *start, LttTime *end); |
79 | |
80 | |
290dfc8c |
81 | /* Get the name of a tracefile */ |
1b82f325 |
82 | |
348c6ba8 |
83 | GQuark ltt_tracefile_name(const LttTracefile *tf); |
84 | GQuark ltt_tracefile_long_name(const LttTracefile *tf); |
1b82f325 |
85 | |
d3d34f49 |
86 | /* get the cpu number of the tracefile */ |
87 | |
88 | guint ltt_tracefile_num(LttTracefile *tf); |
89 | |
90 | LttTrace *ltt_tracefile_get_trace(LttTracefile *tf); |
1b82f325 |
91 | |
80da81ad |
92 | /* Get the number of blocks in the tracefile */ |
93 | |
94 | unsigned ltt_tracefile_block_number(LttTracefile *tf); |
95 | |
96 | |
1b82f325 |
97 | /* Seek to the first event of the trace with time larger or equal to time */ |
98 | |
3aee1200 |
99 | int ltt_tracefile_seek_time(LttTracefile *t, LttTime time); |
1b82f325 |
100 | |
80da81ad |
101 | /* Seek to the first event with position equal or larger to ep */ |
102 | |
3aee1200 |
103 | int ltt_tracefile_seek_position(LttTracefile *t, |
04b44e05 |
104 | const LttEventPosition *ep); |
1b82f325 |
105 | |
106 | /* Read the next event */ |
107 | |
3aee1200 |
108 | int ltt_tracefile_read(LttTracefile *t); |
a5dcde2f |
109 | |
3aee1200 |
110 | /* ltt_tracefile_read cut down in pieces */ |
111 | int ltt_tracefile_read_seek(LttTracefile *t); |
112 | int ltt_tracefile_read_update_event(LttTracefile *t); |
113 | int ltt_tracefile_read_op(LttTracefile *t); |
a5dcde2f |
114 | |
eed2ef37 |
115 | /* Get the current event of the tracefile : valid until the next read */ |
116 | LttEvent *ltt_tracefile_get_event(LttTracefile *tf); |
117 | |
3aee1200 |
118 | /* open tracefile */ |
a5dcde2f |
119 | |
3aee1200 |
120 | gint ltt_tracefile_open(LttTrace *t, gchar * fileName, LttTracefile *tf); |
a5dcde2f |
121 | |
a5dcde2f |
122 | /* get the data type size and endian type of the local machine */ |
123 | |
124 | void getDataEndianType(LttArchSize * size, LttArchEndian * endian); |
125 | |
126 | /* get an integer number */ |
3aee1200 |
127 | gint64 get_int(gboolean reverse_byte_order, gint size, void *data); |
a5dcde2f |
128 | |
129 | /* get the node name of the system */ |
130 | |
45e14832 |
131 | gchar * ltt_trace_system_description_node_name (LttSystemDescription * s); |
a5dcde2f |
132 | |
133 | |
134 | /* get the domain name of the system */ |
135 | |
45e14832 |
136 | gchar * ltt_trace_system_description_domain_name (LttSystemDescription * s); |
a5dcde2f |
137 | |
138 | |
139 | /* get the description of the system */ |
140 | |
45e14832 |
141 | gchar * ltt_trace_system_description_description (LttSystemDescription * s); |
a5dcde2f |
142 | |
143 | |
bf33dd50 |
144 | /* get the NTP start time of the trace */ |
a5dcde2f |
145 | |
7bd563ec |
146 | LttTime ltt_trace_start_time(LttTrace *t); |
a5dcde2f |
147 | |
bf33dd50 |
148 | /* get the monotonic start time of the trace */ |
149 | |
150 | LttTime ltt_trace_start_time_monotonic(LttTrace *t); |
151 | |
18206708 |
152 | /* copy tracefile info over another. Used for sync. */ |
153 | LttTracefile *ltt_tracefile_new(); |
154 | void ltt_tracefile_destroy(LttTracefile *tf); |
155 | void ltt_tracefile_copy(LttTracefile *dest, const LttTracefile *src); |
156 | |
45e14832 |
157 | void get_absolute_pathname(const gchar *pathname, gchar * abs_pathname); |
18206708 |
158 | |
e45551ac |
159 | /* May return a NULL tracefile group */ |
3865ea09 |
160 | GData **ltt_trace_get_tracefiles_groups(LttTrace *trace); |
77175651 |
161 | |
162 | typedef void (*ForEachTraceFileFunc)(LttTracefile *tf, gpointer func_args); |
163 | |
164 | struct compute_tracefile_group_args { |
165 | ForEachTraceFileFunc func; |
166 | gpointer func_args; |
167 | }; |
168 | |
3865ea09 |
169 | |
170 | void compute_tracefile_group(GQuark key_id, |
171 | GArray *group, |
172 | struct compute_tracefile_group_args *args); |
77175651 |
173 | |
174 | LttFacility *ltt_trace_get_facility_by_num(LttTrace *t, guint num); |
175 | |
3aee1200 |
176 | |
77175651 |
177 | gint check_fields_compatibility(LttEventType *event_type1, |
178 | LttEventType *event_type2, |
179 | LttField *field1, LttField *field2); |
3aee1200 |
180 | |
a0c1f622 |
181 | gint64 ltt_get_int(gboolean reverse_byte_order, gint size, void *data); |
182 | |
183 | guint64 ltt_get_uint(gboolean reverse_byte_order, gint size, void *data); |
184 | |
1b82f325 |
185 | #endif // TRACE_H |