Commit | Line | Data |
---|---|---|
7a278c8e | 1 | /* |
ea0b4b9e | 2 | * fs.c |
7a278c8e | 3 | * |
ea0b4b9e | 4 | * Babeltrace CTF file system Reader Component |
7a278c8e | 5 | * |
1a9f7075 | 6 | * Copyright 2015-2017 Philippe Proulx <pproulx@efficios.com> |
f3bc2010 | 7 | * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
7a278c8e | 8 | * |
7a278c8e JG |
9 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
10 | * of this software and associated documentation files (the "Software"), to deal | |
11 | * in the Software without restriction, including without limitation the rights | |
12 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
13 | * copies of the Software, and to permit persons to whom the Software is | |
14 | * furnished to do so, subject to the following conditions: | |
15 | * | |
16 | * The above copyright notice and this permission notice shall be included in | |
17 | * all copies or substantial portions of the Software. | |
18 | * | |
19 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
20 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
21 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
22 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
23 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
24 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
25 | * SOFTWARE. | |
26 | */ | |
27 | ||
f67894f9 | 28 | #define BT_COMP_LOG_SELF_COMP self_comp |
3d731ea9 PP |
29 | #define BT_LOG_OUTPUT_LEVEL log_level |
30 | #define BT_LOG_TAG "PLUGIN/SRC.CTF.FS" | |
3fa1b6a3 | 31 | #include "logging/comp-logging.h" |
3d731ea9 | 32 | |
57952005 | 33 | #include "common/common.h" |
71c5da58 | 34 | #include <babeltrace2/babeltrace.h> |
d126826c | 35 | #include "common/uuid.h" |
ea0b4b9e | 36 | #include <glib.h> |
57952005 | 37 | #include "common/assert.h" |
94cf822e | 38 | #include <inttypes.h> |
c55a9f58 | 39 | #include <stdbool.h> |
56a1cced | 40 | #include "fs.h" |
413bc2c4 | 41 | #include "metadata.h" |
94cf822e | 42 | #include "data-stream-file.h" |
e7a4393b | 43 | #include "file.h" |
1e649dff | 44 | #include "../common/metadata/decoder.h" |
cd03c43c | 45 | #include "../common/metadata/ctf-meta-configure-ir-trace.h" |
b09a5592 | 46 | #include "../common/msg-iter/msg-iter.h" |
04c0ba87 | 47 | #include "query.h" |
c423217e | 48 | #include "plugins/common/param-validation/param-validation.h" |
e7a4393b | 49 | |
7b4d28d0 FD |
50 | struct tracer_info { |
51 | const char *name; | |
52 | int64_t major; | |
53 | int64_t minor; | |
54 | int64_t patch; | |
55 | }; | |
56 | ||
94cf822e | 57 | static |
b09a5592 | 58 | int msg_iter_data_set_current_ds_file(struct ctf_fs_msg_iter_data *msg_iter_data) |
94cf822e PP |
59 | { |
60 | struct ctf_fs_ds_file_info *ds_file_info; | |
61 | int ret = 0; | |
62 | ||
b09a5592 PP |
63 | BT_ASSERT(msg_iter_data->ds_file_info_index < |
64 | msg_iter_data->ds_file_group->ds_file_infos->len); | |
94cf822e | 65 | ds_file_info = g_ptr_array_index( |
b09a5592 PP |
66 | msg_iter_data->ds_file_group->ds_file_infos, |
67 | msg_iter_data->ds_file_info_index); | |
68 | ||
69 | ctf_fs_ds_file_destroy(msg_iter_data->ds_file); | |
70 | msg_iter_data->ds_file = ctf_fs_ds_file_create( | |
71 | msg_iter_data->ds_file_group->ctf_fs_trace, | |
72 | msg_iter_data->pc_msg_iter, | |
73 | msg_iter_data->msg_iter, | |
74 | msg_iter_data->ds_file_group->stream, | |
3d731ea9 PP |
75 | ds_file_info->path->str, |
76 | msg_iter_data->log_level); | |
b09a5592 | 77 | if (!msg_iter_data->ds_file) { |
94cf822e PP |
78 | ret = -1; |
79 | } | |
80 | ||
81 | return ret; | |
82 | } | |
83 | ||
84 | static | |
b09a5592 PP |
85 | void ctf_fs_msg_iter_data_destroy( |
86 | struct ctf_fs_msg_iter_data *msg_iter_data) | |
94cf822e | 87 | { |
b09a5592 | 88 | if (!msg_iter_data) { |
94cf822e PP |
89 | return; |
90 | } | |
91 | ||
b09a5592 | 92 | ctf_fs_ds_file_destroy(msg_iter_data->ds_file); |
55fa6491 | 93 | |
b09a5592 PP |
94 | if (msg_iter_data->msg_iter) { |
95 | bt_msg_iter_destroy(msg_iter_data->msg_iter); | |
55fa6491 PP |
96 | } |
97 | ||
b09a5592 | 98 | g_free(msg_iter_data); |
94cf822e PP |
99 | } |
100 | ||
bbbd35bf PP |
101 | static |
102 | void set_msg_iter_emits_stream_beginning_end_messages( | |
103 | struct ctf_fs_msg_iter_data *msg_iter_data) | |
104 | { | |
105 | bt_msg_iter_set_emit_stream_beginning_message( | |
106 | msg_iter_data->ds_file->msg_iter, | |
107 | msg_iter_data->ds_file_info_index == 0); | |
108 | bt_msg_iter_set_emit_stream_end_message( | |
109 | msg_iter_data->ds_file->msg_iter, | |
110 | msg_iter_data->ds_file_info_index == | |
111 | msg_iter_data->ds_file_group->ds_file_infos->len - 1); | |
112 | } | |
113 | ||
3fd7b79d | 114 | static |
fb25b9e3 | 115 | bt_component_class_message_iterator_next_method_status ctf_fs_iterator_next_one( |
b09a5592 | 116 | struct ctf_fs_msg_iter_data *msg_iter_data, |
bbbd35bf | 117 | const bt_message **out_msg) |
ea0b4b9e | 118 | { |
fb25b9e3 | 119 | bt_component_class_message_iterator_next_method_status status; |
94cf822e | 120 | |
ec4a3354 | 121 | BT_ASSERT_DBG(msg_iter_data->ds_file); |
6ff151ad | 122 | |
bbbd35bf PP |
123 | while (true) { |
124 | bt_message *msg; | |
125 | ||
126 | status = ctf_fs_ds_file_next(msg_iter_data->ds_file, &msg); | |
127 | switch (status) { | |
fb25b9e3 | 128 | case BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK: |
bbbd35bf PP |
129 | *out_msg = msg; |
130 | msg = NULL; | |
6ff151ad | 131 | goto end; |
fb25b9e3 | 132 | case BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_END: |
bbbd35bf PP |
133 | { |
134 | int ret; | |
6ff151ad | 135 | |
bbbd35bf PP |
136 | if (msg_iter_data->ds_file_info_index == |
137 | msg_iter_data->ds_file_group->ds_file_infos->len - 1) { | |
138 | /* End of all group's stream files */ | |
139 | goto end; | |
140 | } | |
141 | ||
142 | msg_iter_data->ds_file_info_index++; | |
989925d1 PP |
143 | bt_msg_iter_reset_for_next_stream_file( |
144 | msg_iter_data->msg_iter); | |
bbbd35bf PP |
145 | set_msg_iter_emits_stream_beginning_end_messages( |
146 | msg_iter_data); | |
94cf822e | 147 | |
94cf822e | 148 | /* |
bbbd35bf PP |
149 | * Open and start reading the next stream file |
150 | * within our stream file group. | |
94cf822e | 151 | */ |
bbbd35bf PP |
152 | ret = msg_iter_data_set_current_ds_file(msg_iter_data); |
153 | if (ret) { | |
fb25b9e3 | 154 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR; |
bbbd35bf PP |
155 | goto end; |
156 | } | |
157 | ||
158 | /* Continue the loop to get the next message */ | |
159 | break; | |
94cf822e | 160 | } |
bbbd35bf | 161 | default: |
94cf822e PP |
162 | goto end; |
163 | } | |
94cf822e | 164 | } |
d01e0f33 | 165 | |
94cf822e | 166 | end: |
3fd7b79d PP |
167 | return status; |
168 | } | |
169 | ||
170 | BT_HIDDEN | |
fb25b9e3 | 171 | bt_component_class_message_iterator_next_method_status ctf_fs_iterator_next( |
b09a5592 PP |
172 | bt_self_message_iterator *iterator, |
173 | bt_message_array_const msgs, uint64_t capacity, | |
3fd7b79d PP |
174 | uint64_t *count) |
175 | { | |
fb25b9e3 PP |
176 | bt_component_class_message_iterator_next_method_status status = |
177 | BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK; | |
b09a5592 PP |
178 | struct ctf_fs_msg_iter_data *msg_iter_data = |
179 | bt_self_message_iterator_get_data(iterator); | |
3fd7b79d PP |
180 | uint64_t i = 0; |
181 | ||
fb25b9e3 PP |
182 | while (i < capacity && |
183 | status == BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK) { | |
b09a5592 | 184 | status = ctf_fs_iterator_next_one(msg_iter_data, &msgs[i]); |
fb25b9e3 | 185 | if (status == BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK) { |
3fd7b79d PP |
186 | i++; |
187 | } | |
188 | } | |
189 | ||
190 | if (i > 0) { | |
191 | /* | |
192 | * Even if ctf_fs_iterator_next_one() returned something | |
fb25b9e3 | 193 | * else than BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK, we |
b09a5592 PP |
194 | * accumulated message objects in the output |
195 | * message array, so we need to return | |
fb25b9e3 | 196 | * BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK so that they are |
3fd7b79d | 197 | * transfered to downstream. This other status occurs |
b09a5592 | 198 | * again the next time muxer_msg_iter_do_next() is |
3fd7b79d | 199 | * called, possibly without any accumulated |
b09a5592 | 200 | * message, in which case we'll return it. |
3fd7b79d PP |
201 | */ |
202 | *count = i; | |
fb25b9e3 | 203 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK; |
3fd7b79d PP |
204 | } |
205 | ||
206 | return status; | |
ea0b4b9e | 207 | } |
bfd20a42 | 208 | |
a02839ae PP |
209 | static |
210 | int ctf_fs_iterator_reset(struct ctf_fs_msg_iter_data *msg_iter_data) | |
211 | { | |
212 | int ret; | |
213 | ||
214 | msg_iter_data->ds_file_info_index = 0; | |
215 | ret = msg_iter_data_set_current_ds_file(msg_iter_data); | |
216 | if (ret) { | |
217 | goto end; | |
218 | } | |
219 | ||
220 | bt_msg_iter_reset(msg_iter_data->msg_iter); | |
221 | set_msg_iter_emits_stream_beginning_end_messages(msg_iter_data); | |
222 | ||
223 | end: | |
224 | return ret; | |
225 | } | |
226 | ||
227 | BT_HIDDEN | |
fb25b9e3 PP |
228 | bt_component_class_message_iterator_seek_beginning_method_status |
229 | ctf_fs_iterator_seek_beginning(bt_self_message_iterator *it) | |
a02839ae PP |
230 | { |
231 | struct ctf_fs_msg_iter_data *msg_iter_data = | |
232 | bt_self_message_iterator_get_data(it); | |
fb25b9e3 PP |
233 | bt_component_class_message_iterator_seek_beginning_method_status status = |
234 | BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_OK; | |
a02839ae PP |
235 | |
236 | BT_ASSERT(msg_iter_data); | |
237 | if (ctf_fs_iterator_reset(msg_iter_data)) { | |
fb25b9e3 | 238 | status = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_ERROR; |
a02839ae PP |
239 | } |
240 | ||
241 | return status; | |
242 | } | |
243 | ||
244 | BT_HIDDEN | |
b09a5592 | 245 | void ctf_fs_iterator_finalize(bt_self_message_iterator *it) |
760051fa | 246 | { |
b09a5592 PP |
247 | ctf_fs_msg_iter_data_destroy( |
248 | bt_self_message_iterator_get_data(it)); | |
760051fa JG |
249 | } |
250 | ||
a02839ae | 251 | BT_HIDDEN |
4175c1d5 | 252 | bt_component_class_message_iterator_initialize_method_status ctf_fs_iterator_init( |
b09a5592 | 253 | bt_self_message_iterator *self_msg_iter, |
9415de1c | 254 | bt_self_message_iterator_configuration *config, |
f67894f9 | 255 | bt_self_component_source *self_comp_src, |
8eee8ea2 | 256 | bt_self_component_port_output *self_port) |
4c1456f0 | 257 | { |
4f1f88a6 | 258 | struct ctf_fs_port_data *port_data; |
b09a5592 | 259 | struct ctf_fs_msg_iter_data *msg_iter_data = NULL; |
4175c1d5 FD |
260 | bt_component_class_message_iterator_initialize_method_status ret = |
261 | BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_OK; | |
3d731ea9 | 262 | bt_logging_level log_level; |
5c3441d8 SM |
263 | bt_self_component *self_comp = |
264 | bt_self_component_source_as_self_component(self_comp_src); | |
760051fa | 265 | |
834e9996 | 266 | port_data = bt_self_component_port_get_data( |
bb61965b | 267 | bt_self_component_port_output_as_self_component_port( |
834e9996 PP |
268 | self_port)); |
269 | BT_ASSERT(port_data); | |
3d731ea9 | 270 | log_level = port_data->ctf_fs->log_level; |
b09a5592 PP |
271 | msg_iter_data = g_new0(struct ctf_fs_msg_iter_data, 1); |
272 | if (!msg_iter_data) { | |
4175c1d5 | 273 | ret = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_MEMORY_ERROR; |
94cf822e PP |
274 | goto error; |
275 | } | |
276 | ||
3d731ea9 | 277 | msg_iter_data->log_level = log_level; |
f67894f9 | 278 | msg_iter_data->self_comp = self_comp; |
b09a5592 PP |
279 | msg_iter_data->pc_msg_iter = self_msg_iter; |
280 | msg_iter_data->msg_iter = bt_msg_iter_create( | |
7b33a0e0 | 281 | port_data->ds_file_group->ctf_fs_trace->metadata->tc, |
3d731ea9 | 282 | bt_common_get_page_size(msg_iter_data->log_level) * 8, |
f67894f9 PP |
283 | ctf_fs_ds_file_medops, NULL, msg_iter_data->log_level, |
284 | self_comp); | |
b09a5592 | 285 | if (!msg_iter_data->msg_iter) { |
5c3441d8 | 286 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Cannot create a CTF message iterator."); |
4175c1d5 | 287 | ret = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_MEMORY_ERROR; |
55fa6491 PP |
288 | goto error; |
289 | } | |
290 | ||
b09a5592 | 291 | msg_iter_data->ds_file_group = port_data->ds_file_group; |
a02839ae | 292 | if (ctf_fs_iterator_reset(msg_iter_data)) { |
4175c1d5 | 293 | ret = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_ERROR; |
4f1f88a6 | 294 | goto error; |
760051fa JG |
295 | } |
296 | ||
c49bf79b SM |
297 | /* |
298 | * This iterator can seek forward if its stream class has a default | |
299 | * clock class. | |
300 | */ | |
301 | if (msg_iter_data->ds_file_group->sc->default_clock_class) { | |
302 | bt_self_message_iterator_configuration_set_can_seek_forward( | |
303 | config, true); | |
304 | } | |
305 | ||
b09a5592 PP |
306 | bt_self_message_iterator_set_data(self_msg_iter, |
307 | msg_iter_data); | |
4175c1d5 | 308 | if (ret != BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_OK) { |
4f1f88a6 | 309 | goto error; |
760051fa | 310 | } |
b09a5592 | 311 | msg_iter_data = NULL; |
4f1f88a6 | 312 | goto end; |
5b29e799 | 313 | |
4f1f88a6 | 314 | error: |
b09a5592 | 315 | bt_self_message_iterator_set_data(self_msg_iter, NULL); |
4f1f88a6 | 316 | |
760051fa | 317 | end: |
b09a5592 | 318 | ctf_fs_msg_iter_data_destroy(msg_iter_data); |
760051fa JG |
319 | return ret; |
320 | } | |
321 | ||
aab89afc SM |
322 | static |
323 | void ctf_fs_trace_destroy(struct ctf_fs_trace *ctf_fs_trace) | |
324 | { | |
325 | if (!ctf_fs_trace) { | |
326 | return; | |
327 | } | |
328 | ||
329 | if (ctf_fs_trace->ds_file_groups) { | |
330 | g_ptr_array_free(ctf_fs_trace->ds_file_groups, TRUE); | |
331 | } | |
332 | ||
333 | BT_TRACE_PUT_REF_AND_RESET(ctf_fs_trace->trace); | |
334 | ||
335 | if (ctf_fs_trace->path) { | |
336 | g_string_free(ctf_fs_trace->path, TRUE); | |
337 | } | |
338 | ||
339 | if (ctf_fs_trace->metadata) { | |
340 | ctf_fs_metadata_fini(ctf_fs_trace->metadata); | |
341 | g_free(ctf_fs_trace->metadata); | |
342 | } | |
343 | ||
344 | g_free(ctf_fs_trace); | |
345 | } | |
346 | ||
bf5b7748 | 347 | BT_HIDDEN |
1a9f7075 | 348 | void ctf_fs_destroy(struct ctf_fs_component *ctf_fs) |
760051fa | 349 | { |
4f1f88a6 | 350 | if (!ctf_fs) { |
8fa760ba JG |
351 | return; |
352 | } | |
4f1f88a6 | 353 | |
aab89afc | 354 | ctf_fs_trace_destroy(ctf_fs->trace); |
4f1f88a6 PP |
355 | |
356 | if (ctf_fs->port_data) { | |
357 | g_ptr_array_free(ctf_fs->port_data, TRUE); | |
c14d7e26 | 358 | } |
760051fa | 359 | |
1a9f7075 PP |
360 | g_free(ctf_fs); |
361 | } | |
362 | ||
bf5b7748 SM |
363 | static |
364 | void port_data_destroy(struct ctf_fs_port_data *port_data) | |
365 | { | |
366 | if (!port_data) { | |
367 | return; | |
368 | } | |
369 | ||
370 | g_free(port_data); | |
371 | } | |
372 | ||
373 | static | |
374 | void port_data_destroy_notifier(void *data) { | |
375 | port_data_destroy(data); | |
376 | } | |
377 | ||
97ade20b | 378 | static |
229f76ed | 379 | void ctf_fs_trace_destroy_notifier(void *data) |
97ade20b JG |
380 | { |
381 | struct ctf_fs_trace *trace = data; | |
382 | ctf_fs_trace_destroy(trace); | |
383 | } | |
384 | ||
f67894f9 PP |
385 | struct ctf_fs_component *ctf_fs_component_create(bt_logging_level log_level, |
386 | bt_self_component *self_comp) | |
a4792757 | 387 | { |
bf5b7748 | 388 | struct ctf_fs_component *ctf_fs; |
a4792757 | 389 | |
bf5b7748 SM |
390 | ctf_fs = g_new0(struct ctf_fs_component, 1); |
391 | if (!ctf_fs) { | |
392 | goto error; | |
393 | } | |
4f1f88a6 | 394 | |
3d731ea9 | 395 | ctf_fs->log_level = log_level; |
bf5b7748 SM |
396 | ctf_fs->port_data = |
397 | g_ptr_array_new_with_free_func(port_data_destroy_notifier); | |
398 | if (!ctf_fs->port_data) { | |
399 | goto error; | |
4f1f88a6 PP |
400 | } |
401 | ||
bf5b7748 SM |
402 | goto end; |
403 | ||
404 | error: | |
e1cfefd2 SM |
405 | ctf_fs_destroy(ctf_fs); |
406 | ctf_fs = NULL; | |
bf5b7748 SM |
407 | |
408 | end: | |
409 | return ctf_fs; | |
410 | } | |
411 | ||
412 | void ctf_fs_finalize(bt_self_component_source *component) | |
413 | { | |
414 | ctf_fs_destroy(bt_self_component_get_data( | |
415 | bt_self_component_source_as_self_component(component))); | |
5b29e799 JG |
416 | } |
417 | ||
ddf49b27 | 418 | gchar *ctf_fs_make_port_name(struct ctf_fs_ds_file_group *ds_file_group) |
d09752f8 | 419 | { |
ddf49b27 | 420 | GString *name = g_string_new(NULL); |
d09752f8 | 421 | |
ddf49b27 SM |
422 | /* |
423 | * The unique port name is generated by concatenating unique identifiers | |
424 | * for: | |
425 | * | |
426 | * - the trace | |
427 | * - the stream class | |
428 | * - the stream | |
429 | */ | |
430 | ||
431 | /* For the trace, use the uuid if present, else the path. */ | |
432 | if (ds_file_group->ctf_fs_trace->metadata->tc->is_uuid_set) { | |
d126826c | 433 | char uuid_str[BT_UUID_STR_LEN + 1]; |
ddf49b27 | 434 | |
d126826c | 435 | bt_uuid_to_str(ds_file_group->ctf_fs_trace->metadata->tc->uuid, uuid_str); |
ddf49b27 SM |
436 | g_string_assign(name, uuid_str); |
437 | } else { | |
438 | g_string_assign(name, ds_file_group->ctf_fs_trace->path->str); | |
d09752f8 PP |
439 | } |
440 | ||
441 | /* | |
ddf49b27 SM |
442 | * For the stream class, use the id if present. We can omit this field |
443 | * otherwise, as there will only be a single stream class. | |
d09752f8 | 444 | */ |
ddf49b27 SM |
445 | if (ds_file_group->sc->id != UINT64_C(-1)) { |
446 | g_string_append_printf(name, " | %" PRIu64, ds_file_group->sc->id); | |
447 | } | |
d09752f8 | 448 | |
ddf49b27 SM |
449 | /* For the stream, use the id if present, else, use the path. */ |
450 | if (ds_file_group->stream_id != UINT64_C(-1)) { | |
451 | g_string_append_printf(name, " | %" PRIu64, ds_file_group->stream_id); | |
452 | } else { | |
453 | BT_ASSERT(ds_file_group->ds_file_infos->len == 1); | |
454 | struct ctf_fs_ds_file_info *ds_file_info = | |
455 | g_ptr_array_index(ds_file_group->ds_file_infos, 0); | |
456 | g_string_append_printf(name, " | %s", ds_file_info->path->str); | |
457 | } | |
458 | ||
459 | return g_string_free(name, FALSE); | |
d09752f8 PP |
460 | } |
461 | ||
5b29e799 | 462 | static |
55314f2a JG |
463 | int create_one_port_for_trace(struct ctf_fs_component *ctf_fs, |
464 | struct ctf_fs_trace *ctf_fs_trace, | |
5c3441d8 SM |
465 | struct ctf_fs_ds_file_group *ds_file_group, |
466 | bt_self_component_source *self_comp_src) | |
5b29e799 | 467 | { |
4f1f88a6 | 468 | int ret = 0; |
4f1f88a6 | 469 | struct ctf_fs_port_data *port_data = NULL; |
ddf49b27 | 470 | gchar *port_name; |
3d731ea9 | 471 | bt_logging_level log_level = ctf_fs->log_level; |
5c3441d8 SM |
472 | bt_self_component *self_comp = |
473 | bt_self_component_source_as_self_component(self_comp_src); | |
4f1f88a6 | 474 | |
ddf49b27 | 475 | port_name = ctf_fs_make_port_name(ds_file_group); |
4f1f88a6 PP |
476 | if (!port_name) { |
477 | goto error; | |
478 | } | |
479 | ||
f67894f9 | 480 | BT_COMP_LOGI("Creating one port named `%s`", port_name); |
4f1f88a6 PP |
481 | |
482 | /* Create output port for this file */ | |
4f1f88a6 PP |
483 | port_data = g_new0(struct ctf_fs_port_data, 1); |
484 | if (!port_data) { | |
485 | goto error; | |
486 | } | |
487 | ||
f7c3ac09 | 488 | port_data->ctf_fs = ctf_fs; |
94cf822e | 489 | port_data->ds_file_group = ds_file_group; |
834e9996 | 490 | ret = bt_self_component_source_add_output_port( |
5c3441d8 | 491 | self_comp_src, port_name, port_data, NULL); |
147337a3 | 492 | if (ret) { |
4f1f88a6 PP |
493 | goto error; |
494 | } | |
495 | ||
496 | g_ptr_array_add(ctf_fs->port_data, port_data); | |
497 | port_data = NULL; | |
498 | goto end; | |
499 | ||
500 | error: | |
501 | ret = -1; | |
502 | ||
503 | end: | |
be1b2e7e | 504 | g_free(port_name); |
4f1f88a6 | 505 | |
4f1f88a6 PP |
506 | port_data_destroy(port_data); |
507 | return ret; | |
5b29e799 JG |
508 | } |
509 | ||
510 | static | |
55314f2a | 511 | int create_ports_for_trace(struct ctf_fs_component *ctf_fs, |
5c3441d8 SM |
512 | struct ctf_fs_trace *ctf_fs_trace, |
513 | bt_self_component_source *self_comp_src) | |
94cf822e PP |
514 | { |
515 | int ret = 0; | |
94cf822e | 516 | size_t i; |
3d731ea9 | 517 | bt_logging_level log_level = ctf_fs_trace->log_level; |
5c3441d8 SM |
518 | bt_self_component *self_comp = |
519 | bt_self_component_source_as_self_component(self_comp_src); | |
94cf822e PP |
520 | |
521 | /* Create one output port for each stream file group */ | |
522 | for (i = 0; i < ctf_fs_trace->ds_file_groups->len; i++) { | |
523 | struct ctf_fs_ds_file_group *ds_file_group = | |
524 | g_ptr_array_index(ctf_fs_trace->ds_file_groups, i); | |
525 | ||
55314f2a | 526 | ret = create_one_port_for_trace(ctf_fs, ctf_fs_trace, |
5c3441d8 | 527 | ds_file_group, self_comp_src); |
94cf822e | 528 | if (ret) { |
5c3441d8 | 529 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Cannot create output port."); |
94cf822e PP |
530 | goto end; |
531 | } | |
532 | } | |
533 | ||
534 | end: | |
535 | return ret; | |
536 | } | |
537 | ||
94cf822e PP |
538 | static |
539 | void ctf_fs_ds_file_info_destroy(struct ctf_fs_ds_file_info *ds_file_info) | |
540 | { | |
541 | if (!ds_file_info) { | |
542 | return; | |
543 | } | |
544 | ||
545 | if (ds_file_info->path) { | |
546 | g_string_free(ds_file_info->path, TRUE); | |
547 | } | |
548 | ||
549 | g_free(ds_file_info); | |
550 | } | |
551 | ||
552 | static | |
553 | struct ctf_fs_ds_file_info *ctf_fs_ds_file_info_create(const char *path, | |
779f4a23 | 554 | int64_t begin_ns) |
94cf822e PP |
555 | { |
556 | struct ctf_fs_ds_file_info *ds_file_info; | |
557 | ||
558 | ds_file_info = g_new0(struct ctf_fs_ds_file_info, 1); | |
559 | if (!ds_file_info) { | |
560 | goto end; | |
561 | } | |
562 | ||
563 | ds_file_info->path = g_string_new(path); | |
564 | if (!ds_file_info->path) { | |
565 | ctf_fs_ds_file_info_destroy(ds_file_info); | |
566 | ds_file_info = NULL; | |
567 | goto end; | |
568 | } | |
569 | ||
570 | ds_file_info->begin_ns = begin_ns; | |
571 | ||
572 | end: | |
573 | return ds_file_info; | |
574 | } | |
575 | ||
576 | static | |
577 | void ctf_fs_ds_file_group_destroy(struct ctf_fs_ds_file_group *ds_file_group) | |
578 | { | |
579 | if (!ds_file_group) { | |
580 | return; | |
581 | } | |
582 | ||
583 | if (ds_file_group->ds_file_infos) { | |
584 | g_ptr_array_free(ds_file_group->ds_file_infos, TRUE); | |
585 | } | |
586 | ||
779f4a23 FD |
587 | if (ds_file_group->index) { |
588 | if (ds_file_group->index->entries) { | |
589 | g_ptr_array_free(ds_file_group->index->entries, TRUE); | |
590 | } | |
591 | g_free(ds_file_group->index); | |
592 | } | |
593 | ||
8c6884d9 | 594 | bt_stream_put_ref(ds_file_group->stream); |
94cf822e PP |
595 | g_free(ds_file_group); |
596 | } | |
597 | ||
598 | static | |
599 | struct ctf_fs_ds_file_group *ctf_fs_ds_file_group_create( | |
600 | struct ctf_fs_trace *ctf_fs_trace, | |
28faa416 | 601 | struct ctf_stream_class *sc, |
779f4a23 FD |
602 | uint64_t stream_instance_id, |
603 | struct ctf_fs_ds_index *index) | |
94cf822e PP |
604 | { |
605 | struct ctf_fs_ds_file_group *ds_file_group; | |
606 | ||
94cf822e PP |
607 | ds_file_group = g_new0(struct ctf_fs_ds_file_group, 1); |
608 | if (!ds_file_group) { | |
609 | goto error; | |
610 | } | |
611 | ||
612 | ds_file_group->ds_file_infos = g_ptr_array_new_with_free_func( | |
613 | (GDestroyNotify) ctf_fs_ds_file_info_destroy); | |
614 | if (!ds_file_group->ds_file_infos) { | |
615 | goto error; | |
616 | } | |
617 | ||
779f4a23 FD |
618 | ds_file_group->index = index; |
619 | ||
d09752f8 | 620 | ds_file_group->stream_id = stream_instance_id; |
28faa416 PP |
621 | BT_ASSERT(sc); |
622 | ds_file_group->sc = sc; | |
94cf822e | 623 | ds_file_group->ctf_fs_trace = ctf_fs_trace; |
94cf822e PP |
624 | goto end; |
625 | ||
626 | error: | |
627 | ctf_fs_ds_file_group_destroy(ds_file_group); | |
779f4a23 | 628 | ctf_fs_ds_index_destroy(index); |
94cf822e PP |
629 | ds_file_group = NULL; |
630 | ||
631 | end: | |
632 | return ds_file_group; | |
633 | } | |
634 | ||
2b5f969e MJ |
635 | /* Replace by g_ptr_array_insert when we depend on glib >= 2.40. */ |
636 | static | |
637 | void array_insert(GPtrArray *array, gpointer element, size_t pos) | |
638 | { | |
639 | size_t original_array_len = array->len; | |
640 | ||
641 | /* Allocate an unused element at the end of the array. */ | |
642 | g_ptr_array_add(array, NULL); | |
643 | ||
644 | /* If we are not inserting at the end, move the elements by one. */ | |
645 | if (pos < original_array_len) { | |
646 | memmove(&(array->pdata[pos + 1]), | |
647 | &(array->pdata[pos]), | |
648 | (original_array_len - pos) * sizeof(gpointer)); | |
649 | } | |
650 | ||
9f197a0c | 651 | /* Insert the value. */ |
2b5f969e MJ |
652 | array->pdata[pos] = element; |
653 | } | |
654 | ||
adb623c2 SM |
655 | /* |
656 | * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right | |
657 | * place to keep it sorted. | |
658 | */ | |
659 | ||
660 | static | |
661 | void ds_file_group_insert_ds_file_info_sorted( | |
662 | struct ctf_fs_ds_file_group *ds_file_group, | |
663 | struct ctf_fs_ds_file_info *ds_file_info) | |
664 | { | |
665 | guint i; | |
666 | ||
667 | /* Find the spot where to insert this ds_file_info. */ | |
668 | for (i = 0; i < ds_file_group->ds_file_infos->len; i++) { | |
669 | struct ctf_fs_ds_file_info *other_ds_file_info = | |
670 | g_ptr_array_index(ds_file_group->ds_file_infos, i); | |
671 | ||
672 | if (ds_file_info->begin_ns < other_ds_file_info->begin_ns) { | |
673 | break; | |
674 | } | |
675 | } | |
676 | ||
677 | array_insert(ds_file_group->ds_file_infos, ds_file_info, i); | |
678 | } | |
679 | ||
779f4a23 | 680 | static |
54dbe4d9 SM |
681 | void ds_index_insert_ds_index_entry_sorted( |
682 | struct ctf_fs_ds_index *index, | |
779f4a23 FD |
683 | struct ctf_fs_ds_index_entry *entry) |
684 | { | |
685 | guint i; | |
686 | ||
687 | /* Find the spot where to insert this index entry. */ | |
54dbe4d9 SM |
688 | for (i = 0; i < index->entries->len; i++) { |
689 | struct ctf_fs_ds_index_entry *other_entry = | |
690 | g_ptr_array_index(index->entries, i); | |
779f4a23 FD |
691 | |
692 | if (entry->timestamp_begin_ns < other_entry->timestamp_begin_ns) { | |
693 | break; | |
694 | } | |
695 | } | |
696 | ||
54dbe4d9 SM |
697 | array_insert(index->entries, entry, i); |
698 | } | |
699 | ||
700 | static | |
701 | void merge_ctf_fs_ds_indexes(struct ctf_fs_ds_index *dest, struct ctf_fs_ds_index *src) | |
702 | { | |
703 | guint i; | |
704 | ||
705 | for (i = 0; i < src->entries->len; i++) { | |
706 | struct ctf_fs_ds_index_entry *entry = | |
707 | g_ptr_array_index(src->entries, i); | |
708 | ||
709 | /* | |
710 | * Ownership of the ctf_fs_ds_index_entry is transferred to | |
711 | * dest. | |
712 | */ | |
713 | g_ptr_array_index(src->entries, i) = NULL; | |
714 | ||
715 | ds_index_insert_ds_index_entry_sorted(dest, entry); | |
716 | } | |
779f4a23 FD |
717 | } |
718 | ||
94cf822e PP |
719 | static |
720 | int add_ds_file_to_ds_file_group(struct ctf_fs_trace *ctf_fs_trace, | |
9e550e5f | 721 | const char *path) |
94cf822e | 722 | { |
7b33a0e0 PP |
723 | int64_t stream_instance_id = -1; |
724 | int64_t begin_ns = -1; | |
94cf822e PP |
725 | struct ctf_fs_ds_file_group *ds_file_group = NULL; |
726 | bool add_group = false; | |
727 | int ret; | |
728 | size_t i; | |
55fa6491 | 729 | struct ctf_fs_ds_file *ds_file = NULL; |
13772304 | 730 | struct ctf_fs_ds_file_info *ds_file_info = NULL; |
97ade20b | 731 | struct ctf_fs_ds_index *index = NULL; |
b09a5592 | 732 | struct bt_msg_iter *msg_iter = NULL; |
7b33a0e0 | 733 | struct ctf_stream_class *sc = NULL; |
b09a5592 | 734 | struct bt_msg_iter_packet_properties props; |
3d731ea9 | 735 | bt_logging_level log_level = ctf_fs_trace->log_level; |
f67894f9 | 736 | bt_self_component *self_comp = ctf_fs_trace->self_comp; |
6699263d | 737 | bt_self_component_class *self_comp_class = ctf_fs_trace->self_comp_class; |
94cf822e | 738 | |
b09a5592 | 739 | msg_iter = bt_msg_iter_create(ctf_fs_trace->metadata->tc, |
3d731ea9 | 740 | bt_common_get_page_size(log_level) * 8, |
f67894f9 | 741 | ctf_fs_ds_file_medops, NULL, log_level, self_comp); |
b09a5592 | 742 | if (!msg_iter) { |
f67894f9 | 743 | BT_COMP_LOGE_STR("Cannot create a CTF message iterator."); |
55fa6491 PP |
744 | goto error; |
745 | } | |
746 | ||
b09a5592 | 747 | ds_file = ctf_fs_ds_file_create(ctf_fs_trace, NULL, msg_iter, |
3d731ea9 | 748 | NULL, path, log_level); |
97ade20b JG |
749 | if (!ds_file) { |
750 | goto error; | |
751 | } | |
752 | ||
e5e71bf8 | 753 | ret = bt_msg_iter_get_packet_properties(ds_file->msg_iter, &props); |
94cf822e | 754 | if (ret) { |
6699263d | 755 | BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class, |
5c3441d8 | 756 | "Cannot get stream file's first packet's header and context fields (`%s`).", |
94cf822e PP |
757 | path); |
758 | goto error; | |
759 | } | |
760 | ||
7b33a0e0 PP |
761 | sc = ctf_trace_class_borrow_stream_class_by_id(ds_file->metadata->tc, |
762 | props.stream_class_id); | |
763 | BT_ASSERT(sc); | |
7b33a0e0 PP |
764 | stream_instance_id = props.data_stream_id; |
765 | ||
766 | if (props.snapshots.beginning_clock != UINT64_C(-1)) { | |
767 | BT_ASSERT(sc->default_clock_class); | |
35fa110e PP |
768 | ret = bt_util_clock_cycles_to_ns_from_origin( |
769 | props.snapshots.beginning_clock, | |
770 | sc->default_clock_class->frequency, | |
771 | sc->default_clock_class->offset_seconds, | |
772 | sc->default_clock_class->offset_cycles, &begin_ns); | |
7b33a0e0 | 773 | if (ret) { |
6699263d | 774 | BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class, |
5c3441d8 | 775 | "Cannot convert clock cycles to nanoseconds from origin (`%s`).", |
7b33a0e0 PP |
776 | path); |
777 | goto error; | |
778 | } | |
94cf822e PP |
779 | } |
780 | ||
13772304 FD |
781 | ds_file_info = ctf_fs_ds_file_info_create(path, begin_ns); |
782 | if (!ds_file_info) { | |
783 | goto error; | |
784 | } | |
785 | ||
786 | index = ctf_fs_ds_file_build_index(ds_file, ds_file_info); | |
97ade20b | 787 | if (!index) { |
80022dd5 SM |
788 | BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE( |
789 | self_comp, self_comp_class, | |
790 | "Failed to index CTF stream file \'%s\'", | |
97ade20b | 791 | ds_file->file->path->str); |
80022dd5 | 792 | goto error; |
97ade20b JG |
793 | } |
794 | ||
7b33a0e0 | 795 | if (begin_ns == -1) { |
94cf822e PP |
796 | /* |
797 | * No beggining timestamp to sort the stream files | |
798 | * within a stream file group, so consider that this | |
799 | * file must be the only one within its group. | |
800 | */ | |
7b33a0e0 | 801 | stream_instance_id = -1; |
94cf822e PP |
802 | } |
803 | ||
7b33a0e0 | 804 | if (stream_instance_id == -1) { |
94cf822e PP |
805 | /* |
806 | * No stream instance ID or no beginning timestamp: | |
807 | * create a unique stream file group for this stream | |
808 | * file because, even if there's a stream instance ID, | |
809 | * there's no timestamp to order the file within its | |
810 | * group. | |
811 | */ | |
94cf822e | 812 | ds_file_group = ctf_fs_ds_file_group_create(ctf_fs_trace, |
779f4a23 FD |
813 | sc, UINT64_C(-1), index); |
814 | /* Ownership of index is transferred. */ | |
815 | index = NULL; | |
816 | ||
94cf822e PP |
817 | if (!ds_file_group) { |
818 | goto error; | |
819 | } | |
820 | ||
1281f86d SM |
821 | ds_file_group_insert_ds_file_info_sorted(ds_file_group, |
822 | BT_MOVE_REF(ds_file_info)); | |
94cf822e PP |
823 | |
824 | add_group = true; | |
825 | goto end; | |
826 | } | |
827 | ||
7b33a0e0 PP |
828 | BT_ASSERT(stream_instance_id != -1); |
829 | BT_ASSERT(begin_ns != -1); | |
94cf822e PP |
830 | |
831 | /* Find an existing stream file group with this ID */ | |
832 | for (i = 0; i < ctf_fs_trace->ds_file_groups->len; i++) { | |
94cf822e PP |
833 | ds_file_group = g_ptr_array_index( |
834 | ctf_fs_trace->ds_file_groups, i); | |
94cf822e | 835 | |
28faa416 | 836 | if (ds_file_group->sc == sc && |
d09752f8 PP |
837 | ds_file_group->stream_id == |
838 | stream_instance_id) { | |
94cf822e PP |
839 | break; |
840 | } | |
841 | ||
842 | ds_file_group = NULL; | |
843 | } | |
844 | ||
845 | if (!ds_file_group) { | |
846 | ds_file_group = ctf_fs_ds_file_group_create(ctf_fs_trace, | |
779f4a23 FD |
847 | sc, stream_instance_id, index); |
848 | /* Ownership of index is transferred. */ | |
849 | index = NULL; | |
94cf822e PP |
850 | if (!ds_file_group) { |
851 | goto error; | |
852 | } | |
853 | ||
854 | add_group = true; | |
54dbe4d9 SM |
855 | } else { |
856 | merge_ctf_fs_ds_indexes(ds_file_group->index, index); | |
94cf822e PP |
857 | } |
858 | ||
1281f86d SM |
859 | ds_file_group_insert_ds_file_info_sorted(ds_file_group, |
860 | BT_MOVE_REF(ds_file_info)); | |
94cf822e PP |
861 | |
862 | goto end; | |
863 | ||
864 | error: | |
865 | ctf_fs_ds_file_group_destroy(ds_file_group); | |
41d87c7b | 866 | ds_file_group = NULL; |
94cf822e PP |
867 | ret = -1; |
868 | ||
869 | end: | |
870 | if (add_group && ds_file_group) { | |
871 | g_ptr_array_add(ctf_fs_trace->ds_file_groups, ds_file_group); | |
872 | } | |
d09752f8 | 873 | |
97ade20b | 874 | ctf_fs_ds_file_destroy(ds_file); |
1281f86d | 875 | ctf_fs_ds_file_info_destroy(ds_file_info); |
55fa6491 | 876 | |
b09a5592 PP |
877 | if (msg_iter) { |
878 | bt_msg_iter_destroy(msg_iter); | |
55fa6491 PP |
879 | } |
880 | ||
97ade20b | 881 | ctf_fs_ds_index_destroy(index); |
94cf822e PP |
882 | return ret; |
883 | } | |
884 | ||
885 | static | |
9e550e5f | 886 | int create_ds_file_groups(struct ctf_fs_trace *ctf_fs_trace) |
e7a4393b JG |
887 | { |
888 | int ret = 0; | |
4f1f88a6 | 889 | const char *basename; |
e7a4393b | 890 | GError *error = NULL; |
4f1f88a6 | 891 | GDir *dir = NULL; |
3d731ea9 | 892 | bt_logging_level log_level = ctf_fs_trace->log_level; |
f67894f9 | 893 | bt_self_component *self_comp = ctf_fs_trace->self_comp; |
6699263d | 894 | bt_self_component_class *self_comp_class = ctf_fs_trace->self_comp_class; |
e7a4393b | 895 | |
94cf822e | 896 | /* Check each file in the path directory, except specific ones */ |
1a9f7075 | 897 | dir = g_dir_open(ctf_fs_trace->path->str, 0, &error); |
e7a4393b | 898 | if (!dir) { |
6699263d SM |
899 | BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class, |
900 | "Cannot open directory `%s`: %s (code %d)", | |
1a9f7075 | 901 | ctf_fs_trace->path->str, error->message, |
4f1f88a6 | 902 | error->code); |
e7a4393b JG |
903 | goto error; |
904 | } | |
905 | ||
4f1f88a6 | 906 | while ((basename = g_dir_read_name(dir))) { |
94cf822e PP |
907 | struct ctf_fs_file *file; |
908 | ||
acfa8112 | 909 | if (strcmp(basename, CTF_FS_METADATA_FILENAME) == 0) { |
e7a4393b | 910 | /* Ignore the metadata stream. */ |
f67894f9 | 911 | BT_COMP_LOGI("Ignoring metadata file `%s" G_DIR_SEPARATOR_S "%s`", |
1a9f7075 | 912 | ctf_fs_trace->path->str, basename); |
e7a4393b JG |
913 | continue; |
914 | } | |
915 | ||
4f1f88a6 | 916 | if (basename[0] == '.') { |
f67894f9 | 917 | BT_COMP_LOGI("Ignoring hidden file `%s" G_DIR_SEPARATOR_S "%s`", |
1a9f7075 | 918 | ctf_fs_trace->path->str, basename); |
e7a4393b JG |
919 | continue; |
920 | } | |
921 | ||
922 | /* Create the file. */ | |
f67894f9 | 923 | file = ctf_fs_file_create(log_level, self_comp); |
e7a4393b | 924 | if (!file) { |
6699263d | 925 | BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class, |
5c3441d8 | 926 | "Cannot create stream file object for file `%s" G_DIR_SEPARATOR_S "%s`", |
1a9f7075 | 927 | ctf_fs_trace->path->str, basename); |
e7a4393b JG |
928 | goto error; |
929 | } | |
930 | ||
931 | /* Create full path string. */ | |
2c7bce29 | 932 | g_string_append_printf(file->path, "%s" G_DIR_SEPARATOR_S "%s", |
1a9f7075 | 933 | ctf_fs_trace->path->str, basename); |
e7a4393b | 934 | if (!g_file_test(file->path->str, G_FILE_TEST_IS_REGULAR)) { |
f67894f9 | 935 | BT_COMP_LOGI("Ignoring non-regular file `%s`", |
1a9f7075 | 936 | file->path->str); |
e7a4393b | 937 | ctf_fs_file_destroy(file); |
4f1f88a6 | 938 | file = NULL; |
e7a4393b JG |
939 | continue; |
940 | } | |
941 | ||
55314f2a | 942 | ret = ctf_fs_file_open(file, "rb"); |
4f1f88a6 | 943 | if (ret) { |
6699263d SM |
944 | BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class, |
945 | "Cannot open stream file `%s`", | |
5c3441d8 | 946 | file->path->str); |
e7a4393b JG |
947 | goto error; |
948 | } | |
949 | ||
9fa0891a JG |
950 | if (file->size == 0) { |
951 | /* Skip empty stream. */ | |
f67894f9 | 952 | BT_COMP_LOGI("Ignoring empty file `%s`", file->path->str); |
9fa0891a JG |
953 | ctf_fs_file_destroy(file); |
954 | continue; | |
955 | } | |
956 | ||
9e550e5f | 957 | ret = add_ds_file_to_ds_file_group(ctf_fs_trace, |
94cf822e | 958 | file->path->str); |
4f1f88a6 | 959 | if (ret) { |
6699263d | 960 | BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class, |
5c3441d8 | 961 | "Cannot add stream file `%s` to stream file group", |
1a9f7075 | 962 | file->path->str); |
94cf822e | 963 | ctf_fs_file_destroy(file); |
e7a4393b JG |
964 | goto error; |
965 | } | |
966 | ||
4f1f88a6 | 967 | ctf_fs_file_destroy(file); |
e7a4393b JG |
968 | } |
969 | ||
970 | goto end; | |
4f1f88a6 | 971 | |
e7a4393b JG |
972 | error: |
973 | ret = -1; | |
4f1f88a6 | 974 | |
e7a4393b JG |
975 | end: |
976 | if (dir) { | |
977 | g_dir_close(dir); | |
978 | dir = NULL; | |
979 | } | |
4f1f88a6 | 980 | |
e7a4393b JG |
981 | if (error) { |
982 | g_error_free(error); | |
983 | } | |
5b29e799 | 984 | |
91457551 | 985 | return ret; |
5b29e799 JG |
986 | } |
987 | ||
10b7a2e4 | 988 | static |
3d731ea9 | 989 | int set_trace_name(bt_trace *trace, const char *name_suffix, |
f67894f9 | 990 | bt_logging_level log_level, bt_self_component *self_comp) |
10b7a2e4 PP |
991 | { |
992 | int ret = 0; | |
8eee8ea2 | 993 | const bt_value *val; |
10b7a2e4 PP |
994 | GString *name; |
995 | ||
996 | name = g_string_new(NULL); | |
997 | if (!name) { | |
f67894f9 | 998 | BT_COMP_LOGE_STR("Failed to allocate a GString."); |
10b7a2e4 PP |
999 | ret = -1; |
1000 | goto end; | |
1001 | } | |
1002 | ||
1003 | /* | |
1004 | * Check if we have a trace environment string value named `hostname`. | |
1005 | * If so, use it as the trace name's prefix. | |
1006 | */ | |
cd03c43c PP |
1007 | val = bt_trace_borrow_environment_entry_value_by_name_const( |
1008 | trace, "hostname"); | |
10b7a2e4 PP |
1009 | if (val && bt_value_is_string(val)) { |
1010 | g_string_append(name, bt_value_string_get(val)); | |
1011 | ||
1012 | if (name_suffix) { | |
1013 | g_string_append_c(name, G_DIR_SEPARATOR); | |
1014 | } | |
1015 | } | |
1016 | ||
1017 | if (name_suffix) { | |
1018 | g_string_append(name, name_suffix); | |
1019 | } | |
1020 | ||
1021 | ret = bt_trace_set_name(trace, name->str); | |
1022 | if (ret) { | |
1023 | goto end; | |
1024 | } | |
1025 | ||
1026 | goto end; | |
1027 | ||
1028 | end: | |
1029 | if (name) { | |
1030 | g_string_free(name, TRUE); | |
1031 | } | |
1032 | ||
1033 | return ret; | |
1034 | } | |
1035 | ||
bf5b7748 | 1036 | static |
6699263d SM |
1037 | struct ctf_fs_trace *ctf_fs_trace_create( |
1038 | bt_self_component *self_comp, | |
1039 | bt_self_component_class *self_comp_class, | |
e5e71bf8 | 1040 | const char *path, const char *name, |
3d731ea9 PP |
1041 | struct ctf_fs_metadata_config *metadata_config, |
1042 | bt_logging_level log_level) | |
1a9f7075 PP |
1043 | { |
1044 | struct ctf_fs_trace *ctf_fs_trace; | |
1045 | int ret; | |
1046 | ||
6699263d SM |
1047 | /* Only one of them must be set. */ |
1048 | BT_ASSERT(!self_comp != !self_comp_class); | |
1049 | ||
1a9f7075 PP |
1050 | ctf_fs_trace = g_new0(struct ctf_fs_trace, 1); |
1051 | if (!ctf_fs_trace) { | |
1052 | goto end; | |
1053 | } | |
1054 | ||
3d731ea9 | 1055 | ctf_fs_trace->log_level = log_level; |
f67894f9 | 1056 | ctf_fs_trace->self_comp = self_comp; |
6699263d | 1057 | ctf_fs_trace->self_comp_class = self_comp_class; |
1a9f7075 PP |
1058 | ctf_fs_trace->path = g_string_new(path); |
1059 | if (!ctf_fs_trace->path) { | |
1060 | goto error; | |
1061 | } | |
1062 | ||
1a9f7075 PP |
1063 | ctf_fs_trace->metadata = g_new0(struct ctf_fs_metadata, 1); |
1064 | if (!ctf_fs_trace->metadata) { | |
1065 | goto error; | |
1066 | } | |
1067 | ||
7b33a0e0 | 1068 | ctf_fs_metadata_init(ctf_fs_trace->metadata); |
94cf822e PP |
1069 | ctf_fs_trace->ds_file_groups = g_ptr_array_new_with_free_func( |
1070 | (GDestroyNotify) ctf_fs_ds_file_group_destroy); | |
1071 | if (!ctf_fs_trace->ds_file_groups) { | |
1072 | goto error; | |
1073 | } | |
1074 | ||
f67894f9 PP |
1075 | ret = ctf_fs_metadata_set_trace_class(self_comp, ctf_fs_trace, |
1076 | metadata_config); | |
10b7a2e4 PP |
1077 | if (ret) { |
1078 | goto error; | |
1079 | } | |
1080 | ||
e5e71bf8 PP |
1081 | if (ctf_fs_trace->metadata->trace_class) { |
1082 | ctf_fs_trace->trace = | |
1083 | bt_trace_create(ctf_fs_trace->metadata->trace_class); | |
1084 | if (!ctf_fs_trace->trace) { | |
1085 | goto error; | |
1086 | } | |
10b7a2e4 PP |
1087 | } |
1088 | ||
e5e71bf8 | 1089 | if (ctf_fs_trace->trace) { |
cd03c43c PP |
1090 | ret = ctf_trace_class_configure_ir_trace( |
1091 | ctf_fs_trace->metadata->tc, ctf_fs_trace->trace); | |
1092 | if (ret) { | |
1093 | goto error; | |
1094 | } | |
1095 | ||
f67894f9 PP |
1096 | ret = set_trace_name(ctf_fs_trace->trace, name, log_level, |
1097 | self_comp); | |
e5e71bf8 PP |
1098 | if (ret) { |
1099 | goto error; | |
1100 | } | |
1a9f7075 PP |
1101 | } |
1102 | ||
9e550e5f | 1103 | ret = create_ds_file_groups(ctf_fs_trace); |
94cf822e PP |
1104 | if (ret) { |
1105 | goto error; | |
1106 | } | |
1107 | ||
1a9f7075 PP |
1108 | goto end; |
1109 | ||
1110 | error: | |
1111 | ctf_fs_trace_destroy(ctf_fs_trace); | |
1112 | ctf_fs_trace = NULL; | |
7b33a0e0 | 1113 | |
1a9f7075 PP |
1114 | end: |
1115 | return ctf_fs_trace; | |
1116 | } | |
1117 | ||
1118 | static | |
1119 | int path_is_ctf_trace(const char *path) | |
1120 | { | |
1121 | GString *metadata_path = g_string_new(NULL); | |
1122 | int ret = 0; | |
1123 | ||
1124 | if (!metadata_path) { | |
1125 | ret = -1; | |
1126 | goto end; | |
1127 | } | |
1128 | ||
2c7bce29 | 1129 | g_string_printf(metadata_path, "%s" G_DIR_SEPARATOR_S "%s", path, CTF_FS_METADATA_FILENAME); |
1a9f7075 PP |
1130 | |
1131 | if (g_file_test(metadata_path->str, G_FILE_TEST_IS_REGULAR)) { | |
1132 | ret = 1; | |
1133 | goto end; | |
1134 | } | |
1135 | ||
1136 | end: | |
1137 | g_string_free(metadata_path, TRUE); | |
1138 | return ret; | |
1139 | } | |
1140 | ||
aab89afc | 1141 | /* Helper for ctf_fs_component_create_ctf_fs_trace, to handle a single path. */ |
bf5b7748 | 1142 | |
1a9f7075 | 1143 | static |
aab89afc | 1144 | int ctf_fs_component_create_ctf_fs_trace_one_path( |
e5e71bf8 | 1145 | struct ctf_fs_component *ctf_fs, |
5c3441d8 | 1146 | const char *path_param, |
c77d62f1 | 1147 | const char *trace_name, |
aab89afc | 1148 | GPtrArray *traces, |
5c3441d8 SM |
1149 | bt_self_component *self_comp, |
1150 | bt_self_component_class *self_comp_class) | |
1a9f7075 | 1151 | { |
54e1a1aa SM |
1152 | struct ctf_fs_trace *ctf_fs_trace; |
1153 | int ret; | |
1154 | GString *norm_path; | |
3d731ea9 | 1155 | bt_logging_level log_level = ctf_fs->log_level; |
1a9f7075 | 1156 | |
4bd72b60 PP |
1157 | norm_path = bt_common_normalize_path(path_param, NULL); |
1158 | if (!norm_path) { | |
5c3441d8 | 1159 | BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class, |
6699263d SM |
1160 | "Failed to normalize path: `%s`.", |
1161 | path_param); | |
4bd72b60 PP |
1162 | goto error; |
1163 | } | |
1164 | ||
54e1a1aa SM |
1165 | ret = path_is_ctf_trace(norm_path->str); |
1166 | if (ret < 0) { | |
1167 | BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class, | |
6699263d SM |
1168 | "Failed to check if path is a CTF trace: path=%s", |
1169 | norm_path->str); | |
54e1a1aa SM |
1170 | goto error; |
1171 | } else if (ret == 0) { | |
1172 | BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class, | |
6699263d SM |
1173 | "Path is not a CTF trace (does not contain a metadata file): `%s`.", |
1174 | norm_path->str); | |
1a9f7075 PP |
1175 | goto error; |
1176 | } | |
1177 | ||
54e1a1aa SM |
1178 | // FIXME: Remove or ifdef for __MINGW32__ |
1179 | if (strcmp(norm_path->str, "/") == 0) { | |
5c3441d8 | 1180 | BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class, |
54e1a1aa SM |
1181 | "Opening a trace in `/` is not supported."); |
1182 | ret = -1; | |
1183 | goto end; | |
1a9f7075 PP |
1184 | } |
1185 | ||
6699263d | 1186 | ctf_fs_trace = ctf_fs_trace_create(self_comp, self_comp_class, norm_path->str, |
c77d62f1 | 1187 | trace_name, &ctf_fs->metadata_config, log_level); |
54e1a1aa | 1188 | if (!ctf_fs_trace) { |
6699263d SM |
1189 | BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class, |
1190 | "Cannot create trace for `%s`.", | |
54e1a1aa | 1191 | norm_path->str); |
1a9f7075 PP |
1192 | goto error; |
1193 | } | |
1194 | ||
aab89afc | 1195 | g_ptr_array_add(traces, ctf_fs_trace); |
54e1a1aa | 1196 | ctf_fs_trace = NULL; |
1a9f7075 | 1197 | |
54e1a1aa | 1198 | ret = 0; |
1a9f7075 PP |
1199 | goto end; |
1200 | ||
1201 | error: | |
1202 | ret = -1; | |
1a9f7075 PP |
1203 | |
1204 | end: | |
4bd72b60 PP |
1205 | if (norm_path) { |
1206 | g_string_free(norm_path, TRUE); | |
1207 | } | |
1208 | ||
1a9f7075 PP |
1209 | return ret; |
1210 | } | |
1211 | ||
adb623c2 SM |
1212 | /* |
1213 | * Count the number of stream and event classes defined by this trace's metadata. | |
1214 | * | |
1215 | * This is used to determine which metadata is the "latest", out of multiple | |
1216 | * traces sharing the same UUID. It is assumed that amongst all these metadatas, | |
1217 | * a bigger metadata is a superset of a smaller metadata. Therefore, it is | |
1218 | * enough to just count the classes. | |
1219 | */ | |
1220 | ||
1221 | static | |
1222 | unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace *trace) | |
1223 | { | |
1224 | unsigned int num = trace->metadata->tc->stream_classes->len; | |
1225 | guint i; | |
1226 | ||
1227 | for (i = 0; i < trace->metadata->tc->stream_classes->len; i++) { | |
1228 | struct ctf_stream_class *sc = trace->metadata->tc->stream_classes->pdata[i]; | |
1229 | num += sc->event_classes->len; | |
1230 | } | |
1231 | ||
1232 | return num; | |
1233 | } | |
1234 | ||
1235 | /* | |
1236 | * Merge the src ds_file_group into dest. This consists of merging their | |
1237 | * ds_file_infos, making sure to keep the result sorted. | |
1238 | */ | |
1239 | ||
1240 | static | |
1241 | void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group *dest, struct ctf_fs_ds_file_group *src) | |
1242 | { | |
1243 | guint i; | |
1244 | ||
1245 | for (i = 0; i < src->ds_file_infos->len; i++) { | |
1246 | struct ctf_fs_ds_file_info *ds_file_info = | |
1247 | g_ptr_array_index(src->ds_file_infos, i); | |
1248 | ||
1249 | /* Ownership of the ds_file_info is transferred to dest. */ | |
1250 | g_ptr_array_index(src->ds_file_infos, i) = NULL; | |
1251 | ||
1252 | ds_file_group_insert_ds_file_info_sorted(dest, ds_file_info); | |
1253 | } | |
adb623c2 | 1254 | |
779f4a23 | 1255 | /* Merge both indexes. */ |
54dbe4d9 | 1256 | merge_ctf_fs_ds_indexes(dest->index, src->index); |
779f4a23 | 1257 | } |
adb623c2 SM |
1258 | /* Merge src_trace's data stream file groups into dest_trace's. */ |
1259 | ||
1260 | static | |
f80e9344 | 1261 | int merge_matching_ctf_fs_ds_file_groups( |
adb623c2 SM |
1262 | struct ctf_fs_trace *dest_trace, |
1263 | struct ctf_fs_trace *src_trace) | |
1264 | { | |
1265 | ||
1266 | GPtrArray *dest = dest_trace->ds_file_groups; | |
1267 | GPtrArray *src = src_trace->ds_file_groups; | |
1268 | guint s_i; | |
f80e9344 | 1269 | int ret = 0; |
adb623c2 SM |
1270 | |
1271 | /* | |
1272 | * Save the initial length of dest: we only want to check against the | |
1273 | * original elements in the inner loop. | |
1274 | */ | |
1275 | const guint dest_len = dest->len; | |
1276 | ||
1277 | for (s_i = 0; s_i < src->len; s_i++) { | |
1278 | struct ctf_fs_ds_file_group *src_group = g_ptr_array_index(src, s_i); | |
1279 | struct ctf_fs_ds_file_group *dest_group = NULL; | |
1280 | ||
1281 | /* A stream instance without ID can't match a stream in the other trace. */ | |
1282 | if (src_group->stream_id != -1) { | |
1283 | guint d_i; | |
1284 | ||
1285 | /* Let's search for a matching ds_file_group in the destination. */ | |
1286 | for (d_i = 0; d_i < dest_len; d_i++) { | |
1287 | struct ctf_fs_ds_file_group *candidate_dest = g_ptr_array_index(dest, d_i); | |
1288 | ||
1289 | /* Can't match a stream instance without ID. */ | |
1290 | if (candidate_dest->stream_id == -1) { | |
1291 | continue; | |
1292 | } | |
1293 | ||
1294 | /* | |
1295 | * If the two groups have the same stream instance id | |
1296 | * and belong to the same stream class (stream instance | |
1297 | * ids are per-stream class), they represent the same | |
1298 | * stream instance. | |
1299 | */ | |
1300 | if (candidate_dest->stream_id != src_group->stream_id || | |
1301 | candidate_dest->sc->id != src_group->sc->id) { | |
1302 | continue; | |
1303 | } | |
1304 | ||
1305 | dest_group = candidate_dest; | |
1306 | break; | |
1307 | } | |
1308 | } | |
1309 | ||
1310 | /* | |
1311 | * Didn't find a friend in dest to merge our src_group into? | |
779f4a23 FD |
1312 | * Create a new empty one. This can happen if a stream was |
1313 | * active in the source trace chunk but not in the destination | |
1314 | * trace chunk. | |
adb623c2 SM |
1315 | */ |
1316 | if (!dest_group) { | |
1317 | struct ctf_stream_class *sc; | |
779f4a23 | 1318 | struct ctf_fs_ds_index *index; |
adb623c2 SM |
1319 | |
1320 | sc = ctf_trace_class_borrow_stream_class_by_id( | |
1321 | dest_trace->metadata->tc, src_group->sc->id); | |
1322 | BT_ASSERT(sc); | |
1323 | ||
f67894f9 PP |
1324 | index = ctf_fs_ds_index_create(dest_trace->log_level, |
1325 | dest_trace->self_comp); | |
779f4a23 FD |
1326 | if (!index) { |
1327 | ret = -1; | |
1328 | goto end; | |
1329 | } | |
1330 | ||
adb623c2 | 1331 | dest_group = ctf_fs_ds_file_group_create(dest_trace, sc, |
779f4a23 FD |
1332 | src_group->stream_id, index); |
1333 | /* Ownership of index is transferred. */ | |
1334 | index = NULL; | |
f80e9344 FD |
1335 | if (!dest_group) { |
1336 | ret = -1; | |
1337 | goto end; | |
1338 | } | |
adb623c2 SM |
1339 | |
1340 | g_ptr_array_add(dest_trace->ds_file_groups, dest_group); | |
1341 | } | |
1342 | ||
1343 | BT_ASSERT(dest_group); | |
1344 | merge_ctf_fs_ds_file_groups(dest_group, src_group); | |
1345 | } | |
f80e9344 FD |
1346 | |
1347 | end: | |
1348 | return ret; | |
adb623c2 SM |
1349 | } |
1350 | ||
1351 | /* | |
1352 | * Collapse the given traces, which must all share the same UUID, in a single | |
1353 | * one. | |
1354 | * | |
1355 | * The trace with the most expansive metadata is chosen and all other traces | |
1356 | * are merged into that one. The array slots of all the traces that get merged | |
1357 | * in the chosen one are set to NULL, so only the slot of the chosen trace | |
1358 | * remains non-NULL. | |
1359 | */ | |
1360 | ||
1361 | static | |
aab89afc SM |
1362 | int merge_ctf_fs_traces(struct ctf_fs_trace **traces, unsigned int num_traces, |
1363 | struct ctf_fs_trace **out_trace) | |
adb623c2 SM |
1364 | { |
1365 | unsigned int winner_count; | |
1366 | struct ctf_fs_trace *winner; | |
aab89afc | 1367 | guint i, winner_i; |
f80e9344 | 1368 | int ret = 0; |
adb623c2 SM |
1369 | |
1370 | BT_ASSERT(num_traces >= 2); | |
1371 | ||
1372 | winner_count = metadata_count_stream_and_event_classes(traces[0]); | |
1373 | winner = traces[0]; | |
aab89afc | 1374 | winner_i = 0; |
adb623c2 SM |
1375 | |
1376 | /* Find the trace with the largest metadata. */ | |
1377 | for (i = 1; i < num_traces; i++) { | |
1378 | struct ctf_fs_trace *candidate; | |
1379 | unsigned int candidate_count; | |
1380 | ||
1381 | candidate = traces[i]; | |
1382 | ||
1383 | /* A bit of sanity check. */ | |
1384 | BT_ASSERT(bt_uuid_compare(winner->metadata->tc->uuid, candidate->metadata->tc->uuid) == 0); | |
1385 | ||
1386 | candidate_count = metadata_count_stream_and_event_classes(candidate); | |
1387 | ||
1388 | if (candidate_count > winner_count) { | |
1389 | winner_count = candidate_count; | |
1390 | winner = candidate; | |
aab89afc | 1391 | winner_i = i; |
adb623c2 SM |
1392 | } |
1393 | } | |
1394 | ||
1395 | /* Merge all the other traces in the winning trace. */ | |
1396 | for (i = 0; i < num_traces; i++) { | |
1397 | struct ctf_fs_trace *trace = traces[i]; | |
1398 | ||
1399 | /* Don't merge the winner into itself. */ | |
1400 | if (trace == winner) { | |
1401 | continue; | |
1402 | } | |
1403 | ||
1404 | /* Merge trace's data stream file groups into winner's. */ | |
f80e9344 FD |
1405 | ret = merge_matching_ctf_fs_ds_file_groups(winner, trace); |
1406 | if (ret) { | |
1407 | goto end; | |
1408 | } | |
adb623c2 SM |
1409 | } |
1410 | ||
aab89afc SM |
1411 | /* |
1412 | * Move the winner out of the array, into `*out_trace`. | |
1413 | */ | |
1414 | *out_trace = winner; | |
1415 | traces[winner_i] = NULL; | |
f80e9344 FD |
1416 | |
1417 | end: | |
1418 | return ret; | |
adb623c2 SM |
1419 | } |
1420 | ||
df7002e4 FD |
1421 | enum target_event { |
1422 | FIRST_EVENT, | |
1423 | LAST_EVENT, | |
1424 | }; | |
1425 | ||
1426 | static | |
1427 | int decode_clock_snapshot_after_event(struct ctf_fs_trace *ctf_fs_trace, | |
1428 | struct ctf_clock_class *default_cc, | |
1429 | struct ctf_fs_ds_index_entry *index_entry, | |
1430 | enum target_event target_event, uint64_t *cs, int64_t *ts_ns) | |
1431 | { | |
1432 | enum bt_msg_iter_status iter_status = BT_MSG_ITER_STATUS_OK; | |
1433 | struct ctf_fs_ds_file *ds_file = NULL; | |
1434 | struct bt_msg_iter *msg_iter = NULL; | |
1435 | bt_logging_level log_level = ctf_fs_trace->log_level; | |
1436 | bt_self_component *self_comp = ctf_fs_trace->self_comp; | |
1437 | int ret = 0; | |
1438 | ||
1439 | BT_ASSERT(ctf_fs_trace); | |
1440 | BT_ASSERT(ctf_fs_trace->metadata); | |
1441 | BT_ASSERT(ctf_fs_trace->metadata->tc); | |
1442 | ||
1443 | msg_iter = bt_msg_iter_create(ctf_fs_trace->metadata->tc, | |
1444 | bt_common_get_page_size(log_level) * 8, ctf_fs_ds_file_medops, | |
1445 | NULL, log_level, self_comp); | |
1446 | if (!msg_iter) { | |
1447 | /* bt_msg_iter_create() logs errors. */ | |
1448 | ret = -1; | |
1449 | goto end; | |
1450 | } | |
1451 | ||
1452 | BT_ASSERT(index_entry); | |
1453 | BT_ASSERT(index_entry->path); | |
1454 | ||
1455 | ds_file = ctf_fs_ds_file_create(ctf_fs_trace, NULL, msg_iter, | |
1456 | NULL, index_entry->path, log_level); | |
1457 | if (!ds_file) { | |
5c3441d8 | 1458 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Failed to create a ctf_fs_ds_file"); |
df7002e4 FD |
1459 | ret = -1; |
1460 | goto end; | |
1461 | } | |
1462 | ||
1463 | /* | |
1464 | * Turn on dry run mode to prevent the creation and usage of Babeltrace | |
1465 | * library objects (bt_field, bt_message_*, etc.). | |
1466 | */ | |
1467 | bt_msg_iter_set_dry_run(msg_iter, true); | |
1468 | ||
1469 | /* Seek to the beginning of the target packet. */ | |
1470 | iter_status = bt_msg_iter_seek(ds_file->msg_iter, index_entry->offset); | |
1471 | if (iter_status) { | |
1472 | /* bt_msg_iter_seek() logs errors. */ | |
1473 | ret = -1; | |
1474 | goto end; | |
1475 | } | |
1476 | ||
1477 | switch (target_event) { | |
1478 | case FIRST_EVENT: | |
1479 | /* | |
1480 | * Start to decode the packet until we reach the end of | |
1481 | * the first event. To extract the first event's clock | |
1482 | * snapshot. | |
1483 | */ | |
1484 | iter_status = bt_msg_iter_curr_packet_first_event_clock_snapshot( | |
1485 | ds_file->msg_iter, cs); | |
1486 | break; | |
1487 | case LAST_EVENT: | |
1488 | /* Decode the packet to extract the last event's clock snapshot. */ | |
1489 | iter_status = bt_msg_iter_curr_packet_last_event_clock_snapshot( | |
1490 | ds_file->msg_iter, cs); | |
1491 | break; | |
1492 | default: | |
24847fc7 | 1493 | bt_common_abort(); |
df7002e4 FD |
1494 | } |
1495 | if (iter_status) { | |
1496 | ret = -1; | |
1497 | goto end; | |
1498 | } | |
1499 | ||
1500 | /* Convert clock snapshot to timestamp. */ | |
1501 | ret = bt_util_clock_cycles_to_ns_from_origin(*cs, | |
1502 | default_cc->frequency, default_cc->offset_seconds, | |
1503 | default_cc->offset_cycles, ts_ns); | |
1504 | if (ret) { | |
5c3441d8 SM |
1505 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
1506 | "Failed to convert clock snapshot to timestamp"); | |
df7002e4 FD |
1507 | goto end; |
1508 | } | |
1509 | ||
1510 | end: | |
1511 | if (ds_file) { | |
1512 | ctf_fs_ds_file_destroy(ds_file); | |
1513 | } | |
1514 | if (msg_iter) { | |
1515 | bt_msg_iter_destroy(msg_iter); | |
1516 | } | |
1517 | ||
1518 | return ret; | |
1519 | } | |
1520 | ||
37ea728c FD |
1521 | static |
1522 | int decode_packet_first_event_timestamp(struct ctf_fs_trace *ctf_fs_trace, | |
1523 | struct ctf_clock_class *default_cc, | |
1524 | struct ctf_fs_ds_index_entry *index_entry, uint64_t *cs, int64_t *ts_ns) | |
1525 | { | |
1526 | return decode_clock_snapshot_after_event(ctf_fs_trace, default_cc, | |
1527 | index_entry, FIRST_EVENT, cs, ts_ns); | |
1528 | } | |
1529 | ||
df7002e4 FD |
1530 | static |
1531 | int decode_packet_last_event_timestamp(struct ctf_fs_trace *ctf_fs_trace, | |
1532 | struct ctf_clock_class *default_cc, | |
1533 | struct ctf_fs_ds_index_entry *index_entry, uint64_t *cs, int64_t *ts_ns) | |
1534 | { | |
1535 | return decode_clock_snapshot_after_event(ctf_fs_trace, default_cc, | |
1536 | index_entry, LAST_EVENT, cs, ts_ns); | |
1537 | } | |
1538 | ||
1539 | /* | |
1540 | * Fix up packet index entries for lttng's "event-after-packet" bug. | |
1541 | * Some buggy lttng tracer versions may emit events with a timestamp that is | |
1542 | * larger (after) than the timestamp_end of the their packets. | |
1543 | * | |
1544 | * To fix up this erroneous data we do the following: | |
1545 | * 1. If it's not the stream file's last packet: set the packet index entry's | |
1546 | * end time to the next packet's beginning time. | |
1547 | * 2. If it's the stream file's last packet, set the packet index entry's end | |
1548 | * time to the packet's last event's time, if any, or to the packet's | |
1549 | * beginning time otherwise. | |
1550 | * | |
1551 | * Known buggy tracer versions: | |
1552 | * - before lttng-ust 2.11.0 | |
1553 | * - before lttng-module 2.11.0 | |
1554 | * - before lttng-module 2.10.10 | |
1555 | * - before lttng-module 2.9.13 | |
1556 | */ | |
1557 | static | |
1558 | int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace *trace) | |
1559 | { | |
1560 | int ret = 0; | |
1561 | guint ds_file_group_i; | |
1562 | GPtrArray *ds_file_groups = trace->ds_file_groups; | |
1563 | bt_logging_level log_level = trace->log_level; | |
1564 | ||
1565 | for (ds_file_group_i = 0; ds_file_group_i < ds_file_groups->len; | |
1566 | ds_file_group_i++) { | |
1567 | guint entry_i; | |
1568 | struct ctf_clock_class *default_cc; | |
1569 | struct ctf_fs_ds_index_entry *last_entry; | |
1570 | struct ctf_fs_ds_index *index; | |
1571 | ||
1572 | struct ctf_fs_ds_file_group *ds_file_group = | |
1573 | g_ptr_array_index(ds_file_groups, ds_file_group_i); | |
1574 | ||
1575 | BT_ASSERT(ds_file_group); | |
1576 | index = ds_file_group->index; | |
1577 | ||
1578 | BT_ASSERT(index); | |
1579 | BT_ASSERT(index->entries); | |
1580 | BT_ASSERT(index->entries->len > 0); | |
1581 | ||
1582 | /* | |
1583 | * Iterate over all entries but the last one. The last one is | |
1584 | * fixed differently after. | |
1585 | */ | |
1586 | for (entry_i = 0; entry_i < index->entries->len - 1; | |
1587 | entry_i++) { | |
1588 | struct ctf_fs_ds_index_entry *curr_entry, *next_entry; | |
1589 | ||
1590 | curr_entry = g_ptr_array_index(index->entries, entry_i); | |
1591 | next_entry = g_ptr_array_index(index->entries, entry_i + 1); | |
1592 | ||
1593 | /* | |
1594 | * 1. Set the current index entry `end` timestamp to | |
1595 | * the next index entry `begin` timestamp. | |
1596 | */ | |
1597 | curr_entry->timestamp_end = next_entry->timestamp_begin; | |
1598 | curr_entry->timestamp_end_ns = next_entry->timestamp_begin_ns; | |
1599 | } | |
1600 | ||
1601 | /* | |
1602 | * 2. Fix the last entry by decoding the last event of the last | |
1603 | * packet. | |
1604 | */ | |
1605 | last_entry = g_ptr_array_index(index->entries, | |
1606 | index->entries->len - 1); | |
1607 | BT_ASSERT(last_entry); | |
1608 | ||
1609 | BT_ASSERT(ds_file_group->sc->default_clock_class); | |
1610 | default_cc = ds_file_group->sc->default_clock_class; | |
1611 | ||
1612 | /* | |
1613 | * Decode packet to read the timestamp of the last event of the | |
1614 | * entry. | |
1615 | */ | |
1616 | ret = decode_packet_last_event_timestamp(trace, default_cc, | |
1617 | last_entry, &last_entry->timestamp_end, | |
1618 | &last_entry->timestamp_end_ns); | |
1619 | if (ret) { | |
5c3441d8 SM |
1620 | BT_COMP_LOGE_APPEND_CAUSE(trace->self_comp, |
1621 | "Failed to decode stream's last packet to get its last event's clock snapshot."); | |
df7002e4 FD |
1622 | goto end; |
1623 | } | |
1624 | } | |
1625 | ||
1626 | end: | |
1627 | return ret; | |
1628 | } | |
1629 | ||
37ea728c FD |
1630 | /* |
1631 | * Fix up packet index entries for barectf's "event-before-packet" bug. | |
1632 | * Some buggy barectf tracer versions may emit events with a timestamp that is | |
1633 | * less than the timestamp_begin of the their packets. | |
1634 | * | |
1635 | * To fix up this erroneous data we do the following: | |
1636 | * 1. Starting at the second index entry, set the timestamp_begin of the | |
1637 | * current entry to the timestamp of the first event of the packet. | |
1638 | * 2. Set the previous entry's timestamp_end to the timestamp_begin of the | |
1639 | * current packet. | |
1640 | * | |
1641 | * Known buggy tracer versions: | |
1642 | * - before barectf 2.3.1 | |
1643 | */ | |
1644 | static | |
1645 | int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace *trace) | |
1646 | { | |
1647 | int ret = 0; | |
1648 | guint ds_file_group_i; | |
1649 | GPtrArray *ds_file_groups = trace->ds_file_groups; | |
1650 | bt_logging_level log_level = trace->log_level; | |
1651 | ||
1652 | for (ds_file_group_i = 0; ds_file_group_i < ds_file_groups->len; | |
1653 | ds_file_group_i++) { | |
1654 | guint entry_i; | |
1655 | struct ctf_clock_class *default_cc; | |
1656 | struct ctf_fs_ds_file_group *ds_file_group = | |
1657 | g_ptr_array_index(ds_file_groups, ds_file_group_i); | |
1658 | ||
1659 | struct ctf_fs_ds_index *index = ds_file_group->index; | |
1660 | ||
1661 | BT_ASSERT(index); | |
1662 | BT_ASSERT(index->entries); | |
1663 | BT_ASSERT(index->entries->len > 0); | |
1664 | ||
1665 | BT_ASSERT(ds_file_group->sc->default_clock_class); | |
1666 | default_cc = ds_file_group->sc->default_clock_class; | |
1667 | ||
1668 | /* | |
1669 | * 1. Iterate over the index, starting from the second entry | |
1670 | * (index = 1). | |
1671 | */ | |
1672 | for (entry_i = 1; entry_i < index->entries->len; | |
1673 | entry_i++) { | |
1674 | struct ctf_fs_ds_index_entry *curr_entry, *prev_entry; | |
1675 | prev_entry = g_ptr_array_index(index->entries, entry_i - 1); | |
1676 | curr_entry = g_ptr_array_index(index->entries, entry_i); | |
1677 | /* | |
1678 | * 2. Set the current entry `begin` timestamp to the | |
1679 | * timestamp of the first event of the current packet. | |
1680 | */ | |
1681 | ret = decode_packet_first_event_timestamp(trace, default_cc, | |
1682 | curr_entry, &curr_entry->timestamp_begin, | |
1683 | &curr_entry->timestamp_begin_ns); | |
1684 | if (ret) { | |
5c3441d8 SM |
1685 | BT_COMP_LOGE_APPEND_CAUSE(trace->self_comp, |
1686 | "Failed to decode first event's clock snapshot"); | |
37ea728c FD |
1687 | goto end; |
1688 | } | |
1689 | ||
1690 | /* | |
1691 | * 3. Set the previous entry `end` timestamp to the | |
1692 | * timestamp of the first event of the current packet. | |
1693 | */ | |
1694 | prev_entry->timestamp_end = curr_entry->timestamp_begin; | |
1695 | prev_entry->timestamp_end_ns = curr_entry->timestamp_begin_ns; | |
1696 | } | |
1697 | } | |
1698 | end: | |
1699 | return ret; | |
1700 | } | |
1701 | ||
7645f10f FD |
1702 | /* |
1703 | * When using the lttng-crash feature it's likely that the last packets of each | |
1704 | * stream have their timestamp_end set to zero. This is caused by the fact that | |
1705 | * the tracer crashed and was not able to properly close the packets. | |
1706 | * | |
1707 | * To fix up this erroneous data we do the following: | |
1708 | * For each index entry, if the entry's timestamp_end is 0 and the | |
1709 | * timestamp_begin is not 0: | |
1710 | * - If it's the stream file's last packet: set the packet index entry's end | |
1711 | * time to the packet's last event's time, if any, or to the packet's | |
1712 | * beginning time otherwise. | |
1713 | * - If it's not the stream file's last packet: set the packet index | |
1714 | * entry's end time to the next packet's beginning time. | |
1715 | * | |
1716 | * Affected versions: | |
1717 | * - All current and future lttng-ust and lttng-modules versions. | |
1718 | */ | |
1719 | static | |
1720 | int fix_index_lttng_crash_quirk(struct ctf_fs_trace *trace) | |
1721 | { | |
1722 | int ret = 0; | |
1723 | guint ds_file_group_idx; | |
1724 | GPtrArray *ds_file_groups = trace->ds_file_groups; | |
1725 | bt_logging_level log_level = trace->log_level; | |
1726 | ||
1727 | for (ds_file_group_idx = 0; ds_file_group_idx < ds_file_groups->len; | |
1728 | ds_file_group_idx++) { | |
1729 | guint entry_idx; | |
1730 | struct ctf_clock_class *default_cc; | |
1731 | struct ctf_fs_ds_index_entry *last_entry; | |
1732 | struct ctf_fs_ds_index *index; | |
1733 | ||
1734 | struct ctf_fs_ds_file_group *ds_file_group = | |
1735 | g_ptr_array_index(ds_file_groups, ds_file_group_idx); | |
1736 | ||
1737 | BT_ASSERT(ds_file_group); | |
1738 | index = ds_file_group->index; | |
1739 | ||
1740 | BT_ASSERT(ds_file_group->sc->default_clock_class); | |
1741 | default_cc = ds_file_group->sc->default_clock_class; | |
1742 | ||
1743 | BT_ASSERT(index); | |
1744 | BT_ASSERT(index->entries); | |
1745 | BT_ASSERT(index->entries->len > 0); | |
1746 | ||
1747 | last_entry = g_ptr_array_index(index->entries, | |
1748 | index->entries->len - 1); | |
1749 | BT_ASSERT(last_entry); | |
1750 | ||
1751 | ||
1752 | /* 1. Fix the last entry first. */ | |
1753 | if (last_entry->timestamp_end == 0 && | |
1754 | last_entry->timestamp_begin != 0) { | |
1755 | /* | |
1756 | * Decode packet to read the timestamp of the | |
1757 | * last event of the stream file. | |
1758 | */ | |
1759 | ret = decode_packet_last_event_timestamp(trace, | |
1760 | default_cc, last_entry, | |
1761 | &last_entry->timestamp_end, | |
1762 | &last_entry->timestamp_end_ns); | |
1763 | if (ret) { | |
5c3441d8 SM |
1764 | BT_COMP_LOGE_APPEND_CAUSE(trace->self_comp, |
1765 | "Failed to decode last event's clock snapshot"); | |
7645f10f FD |
1766 | goto end; |
1767 | } | |
1768 | } | |
1769 | ||
1770 | /* Iterate over all entries but the last one. */ | |
1771 | for (entry_idx = 0; entry_idx < index->entries->len - 1; | |
1772 | entry_idx++) { | |
1773 | struct ctf_fs_ds_index_entry *curr_entry, *next_entry; | |
1774 | curr_entry = g_ptr_array_index(index->entries, entry_idx); | |
1775 | next_entry = g_ptr_array_index(index->entries, entry_idx + 1); | |
1776 | ||
1777 | if (curr_entry->timestamp_end == 0 && | |
1778 | curr_entry->timestamp_begin != 0) { | |
1779 | /* | |
1780 | * 2. Set the current index entry `end` timestamp to | |
1781 | * the next index entry `begin` timestamp. | |
1782 | */ | |
1783 | curr_entry->timestamp_end = next_entry->timestamp_begin; | |
1784 | curr_entry->timestamp_end_ns = next_entry->timestamp_begin_ns; | |
1785 | } | |
1786 | } | |
1787 | } | |
1788 | ||
1789 | end: | |
1790 | return ret; | |
1791 | } | |
1792 | ||
7b4d28d0 FD |
1793 | /* |
1794 | * Extract the tracer information necessary to compare versions. | |
1795 | * Returns 0 on success, and -1 if the extraction is not successful because the | |
1796 | * necessary fields are absents in the trace metadata. | |
1797 | */ | |
1798 | static | |
7b4d28d0 FD |
1799 | int extract_tracer_info(struct ctf_fs_trace *trace, |
1800 | struct tracer_info *current_tracer_info) | |
1801 | { | |
1802 | int ret = 0; | |
1803 | struct ctf_trace_class_env_entry *entry; | |
1804 | ||
1805 | /* Clear the current_tracer_info struct */ | |
1806 | memset(current_tracer_info, 0, sizeof(*current_tracer_info)); | |
1807 | ||
1808 | /* | |
1809 | * To compare 2 tracer versions, at least the tracer name and it's | |
1810 | * major version are needed. If one of these is missing, consider it an | |
1811 | * extraction failure. | |
1812 | */ | |
1813 | entry = ctf_trace_class_borrow_env_entry_by_name( | |
1814 | trace->metadata->tc, "tracer_name"); | |
1815 | if (!entry || entry->type != CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR) { | |
1816 | goto missing_bare_minimum; | |
1817 | } | |
1818 | ||
1819 | /* Set tracer name. */ | |
1820 | current_tracer_info->name = entry->value.str->str; | |
1821 | ||
1822 | entry = ctf_trace_class_borrow_env_entry_by_name( | |
1823 | trace->metadata->tc, "tracer_major"); | |
1824 | if (!entry || entry->type != CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT) { | |
1825 | goto missing_bare_minimum; | |
1826 | } | |
1827 | ||
1828 | /* Set major version number. */ | |
1829 | current_tracer_info->major = entry->value.i; | |
1830 | ||
1831 | entry = ctf_trace_class_borrow_env_entry_by_name( | |
1832 | trace->metadata->tc, "tracer_minor"); | |
1833 | if (!entry || entry->type != CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT) { | |
1834 | goto end; | |
1835 | } | |
1836 | ||
1837 | /* Set minor version number. */ | |
1838 | current_tracer_info->minor = entry->value.i; | |
1839 | ||
1840 | entry = ctf_trace_class_borrow_env_entry_by_name( | |
1841 | trace->metadata->tc, "tracer_patch"); | |
1842 | if (!entry) { | |
1843 | /* | |
1844 | * If `tracer_patch` doesn't exist `tracer_patchlevel` might. | |
1845 | * For example, `lttng-modules` uses entry name | |
1846 | * `tracer_patchlevel`. | |
1847 | */ | |
1848 | entry = ctf_trace_class_borrow_env_entry_by_name( | |
1849 | trace->metadata->tc, "tracer_patchlevel"); | |
1850 | } | |
1851 | ||
1852 | if (!entry || entry->type != CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT) { | |
1853 | goto end; | |
1854 | } | |
1855 | ||
1856 | /* Set patch version number. */ | |
1857 | current_tracer_info->patch = entry->value.i; | |
1858 | ||
1859 | goto end; | |
1860 | ||
1861 | missing_bare_minimum: | |
1862 | ret = -1; | |
1863 | end: | |
1864 | return ret; | |
1865 | } | |
1866 | ||
df7002e4 FD |
1867 | static |
1868 | bool is_tracer_affected_by_lttng_event_after_packet_bug( | |
1869 | struct tracer_info *curr_tracer_info) | |
1870 | { | |
1871 | bool is_affected = false; | |
1872 | ||
1873 | if (strcmp(curr_tracer_info->name, "lttng-ust") == 0) { | |
1874 | if (curr_tracer_info->major < 2) { | |
1875 | is_affected = true; | |
1876 | } else if (curr_tracer_info->major == 2) { | |
1877 | /* fixed in lttng-ust 2.11.0 */ | |
1878 | if (curr_tracer_info->minor < 11) { | |
1879 | is_affected = true; | |
1880 | } | |
1881 | } | |
1882 | } else if (strcmp(curr_tracer_info->name, "lttng-modules") == 0) { | |
1883 | if (curr_tracer_info->major < 2) { | |
1884 | is_affected = true; | |
1885 | } else if (curr_tracer_info->major == 2) { | |
1886 | /* fixed in lttng-modules 2.11.0 */ | |
1887 | if (curr_tracer_info->minor == 10) { | |
1888 | /* fixed in lttng-modules 2.10.10 */ | |
1889 | if (curr_tracer_info->patch < 10) { | |
1890 | is_affected = true; | |
1891 | } | |
1892 | } else if (curr_tracer_info->minor == 9) { | |
1893 | /* fixed in lttng-modules 2.9.13 */ | |
1894 | if (curr_tracer_info->patch < 13) { | |
1895 | is_affected = true; | |
1896 | } | |
1897 | } else if (curr_tracer_info->minor < 9) { | |
1898 | is_affected = true; | |
1899 | } | |
1900 | } | |
1901 | } | |
1902 | ||
1903 | return is_affected; | |
1904 | } | |
1905 | ||
37ea728c FD |
1906 | static |
1907 | bool is_tracer_affected_by_barectf_event_before_packet_bug( | |
1908 | struct tracer_info *curr_tracer_info) | |
1909 | { | |
1910 | bool is_affected = false; | |
1911 | ||
1912 | if (strcmp(curr_tracer_info->name, "barectf") == 0) { | |
1913 | if (curr_tracer_info->major < 2) { | |
1914 | is_affected = true; | |
1915 | } else if (curr_tracer_info->major == 2) { | |
1916 | if (curr_tracer_info->minor < 3) { | |
1917 | is_affected = true; | |
1918 | } else if (curr_tracer_info->minor == 3) { | |
1919 | /* fixed in barectf 2.3.1 */ | |
1920 | if (curr_tracer_info->patch < 1) { | |
1921 | is_affected = true; | |
1922 | } | |
1923 | } | |
1924 | } | |
1925 | } | |
1926 | ||
1927 | return is_affected; | |
1928 | } | |
1929 | ||
7645f10f FD |
1930 | static |
1931 | bool is_tracer_affected_by_lttng_crash_quirk( | |
1932 | struct tracer_info *curr_tracer_info) | |
1933 | { | |
1934 | bool is_affected = false; | |
1935 | ||
1936 | /* All LTTng tracer may be affected by this lttng crash quirk. */ | |
1937 | if (strcmp(curr_tracer_info->name, "lttng-ust") == 0) { | |
1938 | is_affected = true; | |
1939 | } else if (strcmp(curr_tracer_info->name, "lttng-modules") == 0) { | |
1940 | is_affected = true; | |
1941 | } | |
1942 | ||
1943 | return is_affected; | |
1944 | } | |
1945 | ||
df7002e4 FD |
1946 | /* |
1947 | * Looks for trace produced by known buggy tracers and fix up the index | |
1948 | * produced earlier. | |
1949 | */ | |
1950 | static | |
5c3441d8 | 1951 | int fix_packet_index_tracer_bugs(struct ctf_fs_component *ctf_fs, |
6699263d SM |
1952 | bt_self_component *self_comp, |
1953 | bt_self_component_class *self_comp_class) | |
df7002e4 FD |
1954 | { |
1955 | int ret = 0; | |
df7002e4 | 1956 | struct tracer_info current_tracer_info; |
df7002e4 FD |
1957 | bt_logging_level log_level = ctf_fs->log_level; |
1958 | ||
aab89afc SM |
1959 | ret = extract_tracer_info(ctf_fs->trace, ¤t_tracer_info); |
1960 | if (ret) { | |
1961 | /* | |
1962 | * A trace may not have all the necessary environment | |
1963 | * entries to do the tracer version comparison. | |
1964 | * At least, the tracer name and major version number | |
1965 | * are needed. Failing to extract these entries is not | |
1966 | * an error. | |
1967 | */ | |
1968 | ret = 0; | |
1969 | BT_LOGI_STR("Cannot extract tracer information necessary to compare with buggy versions."); | |
1970 | goto end;; | |
1971 | } | |
df7002e4 | 1972 | |
aab89afc SM |
1973 | /* Check if the trace may be affected by old tracer bugs. */ |
1974 | if (is_tracer_affected_by_lttng_event_after_packet_bug( | |
1975 | ¤t_tracer_info)) { | |
1976 | BT_LOGI_STR("Trace may be affected by LTTng tracer packet timestamp bug. Fixing up."); | |
1977 | ret = fix_index_lttng_event_after_packet_bug(ctf_fs->trace); | |
df7002e4 | 1978 | if (ret) { |
6699263d SM |
1979 | BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE( |
1980 | self_comp, self_comp_class, | |
aab89afc SM |
1981 | "Failed to fix LTTng event-after-packet bug."); |
1982 | goto end; | |
df7002e4 | 1983 | } |
aab89afc SM |
1984 | ctf_fs->trace->metadata->tc->quirks.lttng_event_after_packet = true; |
1985 | } | |
37ea728c | 1986 | |
aab89afc SM |
1987 | if (is_tracer_affected_by_barectf_event_before_packet_bug( |
1988 | ¤t_tracer_info)) { | |
1989 | BT_LOGI_STR("Trace may be affected by barectf tracer packet timestamp bug. Fixing up."); | |
1990 | ret = fix_index_barectf_event_before_packet_bug(ctf_fs->trace); | |
1991 | if (ret) { | |
6699263d SM |
1992 | BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE( |
1993 | self_comp, self_comp_class, | |
aab89afc SM |
1994 | "Failed to fix barectf event-before-packet bug."); |
1995 | goto end; | |
37ea728c | 1996 | } |
aab89afc SM |
1997 | ctf_fs->trace->metadata->tc->quirks.barectf_event_before_packet = true; |
1998 | } | |
7645f10f | 1999 | |
aab89afc SM |
2000 | if (is_tracer_affected_by_lttng_crash_quirk( |
2001 | ¤t_tracer_info)) { | |
2002 | ret = fix_index_lttng_crash_quirk(ctf_fs->trace); | |
2003 | if (ret) { | |
6699263d SM |
2004 | BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE( |
2005 | self_comp, self_comp_class, | |
aab89afc SM |
2006 | "Failed to fix lttng-crash timestamp quirks."); |
2007 | goto end; | |
7645f10f | 2008 | } |
aab89afc | 2009 | ctf_fs->trace->metadata->tc->quirks.lttng_crash = true; |
df7002e4 | 2010 | } |
aab89afc | 2011 | |
df7002e4 FD |
2012 | end: |
2013 | return ret; | |
2014 | } | |
2015 | ||
562e23c1 PP |
2016 | static |
2017 | gint compare_ds_file_groups_by_first_path(gconstpointer a, gconstpointer b) | |
2018 | { | |
2019 | struct ctf_fs_ds_file_group * const *ds_file_group_a = a; | |
2020 | struct ctf_fs_ds_file_group * const *ds_file_group_b = b; | |
2021 | const struct ctf_fs_ds_file_info *first_ds_file_info_a; | |
2022 | const struct ctf_fs_ds_file_info *first_ds_file_info_b; | |
2023 | ||
2024 | BT_ASSERT((*ds_file_group_a)->ds_file_infos->len > 0); | |
2025 | BT_ASSERT((*ds_file_group_b)->ds_file_infos->len > 0); | |
2026 | first_ds_file_info_a = (*ds_file_group_a)->ds_file_infos->pdata[0]; | |
2027 | first_ds_file_info_b = (*ds_file_group_b)->ds_file_infos->pdata[0]; | |
2028 | return strcmp(first_ds_file_info_a->path->str, | |
2029 | first_ds_file_info_b->path->str); | |
2030 | } | |
2031 | ||
aab89afc | 2032 | int ctf_fs_component_create_ctf_fs_trace( |
bf5b7748 | 2033 | struct ctf_fs_component *ctf_fs, |
5c3441d8 | 2034 | const bt_value *paths_value, |
c77d62f1 | 2035 | const bt_value *trace_name_value, |
5c3441d8 SM |
2036 | bt_self_component *self_comp, |
2037 | bt_self_component_class *self_comp_class) | |
bf5b7748 SM |
2038 | { |
2039 | int ret = 0; | |
2040 | uint64_t i; | |
df7002e4 | 2041 | bt_logging_level log_level = ctf_fs->log_level; |
aab89afc | 2042 | GPtrArray *traces; |
c77d62f1 | 2043 | const char *trace_name; |
bf5b7748 | 2044 | |
aab89afc SM |
2045 | BT_ASSERT(bt_value_get_type(paths_value) == BT_VALUE_TYPE_ARRAY); |
2046 | BT_ASSERT(!bt_value_array_is_empty(paths_value)); | |
2047 | ||
2048 | traces = g_ptr_array_new_with_free_func(ctf_fs_trace_destroy_notifier); | |
2049 | if (!traces) { | |
2050 | BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class, | |
2051 | "Failed to allocate a GPtrArray."); | |
2052 | goto error; | |
2053 | } | |
2054 | ||
c77d62f1 SM |
2055 | trace_name = trace_name_value ? bt_value_string_get(trace_name_value) : NULL; |
2056 | ||
aab89afc | 2057 | /* Start by creating a separate ctf_fs_trace object for each path. */ |
1270d0e9 | 2058 | for (i = 0; i < bt_value_array_get_length(paths_value); i++) { |
bf5b7748 | 2059 | const bt_value *path_value = bt_value_array_borrow_element_by_index_const(paths_value, i); |
a1040187 | 2060 | const char *input = bt_value_string_get(path_value); |
bf5b7748 | 2061 | |
aab89afc | 2062 | ret = ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs, |
c77d62f1 | 2063 | input, trace_name, traces, self_comp, self_comp_class); |
bf5b7748 SM |
2064 | if (ret) { |
2065 | goto end; | |
2066 | } | |
2067 | } | |
2068 | ||
aab89afc SM |
2069 | if (traces->len > 1) { |
2070 | struct ctf_fs_trace *first_trace = (struct ctf_fs_trace *) traces->pdata[0]; | |
2071 | const uint8_t *first_trace_uuid = first_trace->metadata->tc->uuid; | |
2072 | struct ctf_fs_trace *trace; | |
2073 | ||
2074 | /* | |
2075 | * We have more than one trace, they must all share the same | |
2076 | * UUID, verify that. | |
2077 | */ | |
2078 | for (i = 0; i < traces->len; i++) { | |
2079 | struct ctf_fs_trace *this_trace = | |
2080 | (struct ctf_fs_trace *) traces->pdata[i]; | |
2081 | const uint8_t *this_trace_uuid = this_trace->metadata->tc->uuid; | |
2082 | ||
2083 | if (!this_trace->metadata->tc->is_uuid_set) { | |
2084 | BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class, | |
2085 | "Multiple traces given, but a trace does not have a UUID: path=%s", | |
2086 | this_trace->path->str); | |
2087 | goto error; | |
2088 | } | |
2089 | ||
2090 | if (bt_uuid_compare(first_trace_uuid, this_trace_uuid) != 0) { | |
2091 | char first_trace_uuid_str[BT_UUID_STR_LEN + 1]; | |
2092 | char this_trace_uuid_str[BT_UUID_STR_LEN + 1]; | |
2093 | ||
2094 | bt_uuid_to_str(first_trace_uuid, first_trace_uuid_str); | |
2095 | bt_uuid_to_str(this_trace_uuid, this_trace_uuid_str); | |
2096 | ||
2097 | BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class, | |
2098 | "Multiple traces given, but UUIDs don't match: " | |
2099 | "first-trace-uuid=%s, first-trace-path=%s, " | |
2100 | "trace-uuid=%s, trace-path=%s", | |
2101 | first_trace_uuid_str, first_trace->path->str, | |
2102 | this_trace_uuid_str, this_trace->path->str); | |
2103 | goto error; | |
2104 | } | |
2105 | } | |
2106 | ||
2107 | ret = merge_ctf_fs_traces((struct ctf_fs_trace **) traces->pdata, | |
2108 | traces->len, &trace); | |
2109 | if (ret) { | |
2110 | BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class, | |
2111 | "Failed to merge traces with the same UUID."); | |
2112 | goto error; | |
2113 | } | |
2114 | ||
2115 | ctf_fs->trace = trace; | |
2116 | } else { | |
2117 | /* Just one trace, it may or may not have a UUID, both are fine. */ | |
2118 | ctf_fs->trace = traces->pdata[0]; | |
2119 | traces->pdata[0] = NULL; | |
df7002e4 | 2120 | } |
adb623c2 | 2121 | |
6699263d | 2122 | ret = fix_packet_index_tracer_bugs(ctf_fs, self_comp, self_comp_class); |
df7002e4 | 2123 | if (ret) { |
5c3441d8 SM |
2124 | BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class, |
2125 | "Failed to fix packet index tracer bugs."); | |
df7002e4 | 2126 | } |
aab89afc | 2127 | |
562e23c1 PP |
2128 | /* |
2129 | * Sort data stream file groups by first data stream file info | |
2130 | * path to get a deterministic order. This order influences the | |
2131 | * order of the output ports. It also influences the order of | |
2132 | * the automatic stream IDs if the trace's packet headers do not | |
2133 | * contain a `stream_instance_id` field, in which case the data | |
2134 | * stream file to stream ID association is always the same, | |
2135 | * whatever the build and the system. | |
2136 | * | |
2137 | * Having a deterministic order here can help debugging and | |
2138 | * testing. | |
2139 | */ | |
2140 | g_ptr_array_sort(ctf_fs->trace->ds_file_groups, | |
2141 | compare_ds_file_groups_by_first_path); | |
aab89afc SM |
2142 | goto end; |
2143 | error: | |
2144 | ret = -1; | |
2145 | ||
bf5b7748 | 2146 | end: |
aab89afc | 2147 | g_ptr_array_free(traces, TRUE); |
bf5b7748 SM |
2148 | return ret; |
2149 | } | |
2150 | ||
ddf49b27 SM |
2151 | static |
2152 | GString *get_stream_instance_unique_name( | |
2153 | struct ctf_fs_ds_file_group *ds_file_group) | |
2154 | { | |
2155 | GString *name; | |
2156 | struct ctf_fs_ds_file_info *ds_file_info; | |
2157 | ||
2158 | name = g_string_new(NULL); | |
2159 | if (!name) { | |
2160 | goto end; | |
2161 | } | |
2162 | ||
2163 | /* | |
2164 | * If there's more than one stream file in the stream file | |
2165 | * group, the first (earliest) stream file's path is used as | |
2166 | * the stream's unique name. | |
2167 | */ | |
2168 | BT_ASSERT(ds_file_group->ds_file_infos->len > 0); | |
2169 | ds_file_info = g_ptr_array_index(ds_file_group->ds_file_infos, 0); | |
2170 | g_string_assign(name, ds_file_info->path->str); | |
2171 | ||
2172 | end: | |
2173 | return name; | |
2174 | } | |
2175 | ||
bf5b7748 SM |
2176 | /* Create the IR stream objects for ctf_fs_trace. */ |
2177 | ||
2178 | static | |
2179 | int create_streams_for_trace(struct ctf_fs_trace *ctf_fs_trace) | |
2180 | { | |
2181 | int ret; | |
2182 | GString *name = NULL; | |
2183 | guint i; | |
3d731ea9 | 2184 | bt_logging_level log_level = ctf_fs_trace->log_level; |
f67894f9 | 2185 | bt_self_component *self_comp = ctf_fs_trace->self_comp; |
bf5b7748 SM |
2186 | |
2187 | for (i = 0; i < ctf_fs_trace->ds_file_groups->len; i++) { | |
2188 | struct ctf_fs_ds_file_group *ds_file_group = | |
2189 | g_ptr_array_index(ctf_fs_trace->ds_file_groups, i); | |
2190 | name = get_stream_instance_unique_name(ds_file_group); | |
2191 | ||
2192 | if (!name) { | |
2193 | goto error; | |
2194 | } | |
2195 | ||
2196 | if (ds_file_group->sc->ir_sc) { | |
2197 | BT_ASSERT(ctf_fs_trace->trace); | |
2198 | ||
2199 | if (ds_file_group->stream_id == UINT64_C(-1)) { | |
2200 | /* No stream ID: use 0 */ | |
2201 | ds_file_group->stream = bt_stream_create_with_id( | |
2202 | ds_file_group->sc->ir_sc, | |
2203 | ctf_fs_trace->trace, | |
2204 | ctf_fs_trace->next_stream_id); | |
2205 | ctf_fs_trace->next_stream_id++; | |
2206 | } else { | |
2207 | /* Specific stream ID */ | |
2208 | ds_file_group->stream = bt_stream_create_with_id( | |
2209 | ds_file_group->sc->ir_sc, | |
2210 | ctf_fs_trace->trace, | |
2211 | (uint64_t) ds_file_group->stream_id); | |
2212 | } | |
2213 | } else { | |
2214 | ds_file_group->stream = NULL; | |
2215 | } | |
2216 | ||
2217 | if (!ds_file_group->stream) { | |
5c3441d8 SM |
2218 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, |
2219 | "Cannot create stream for DS file group: " | |
bf5b7748 SM |
2220 | "addr=%p, stream-name=\"%s\"", |
2221 | ds_file_group, name->str); | |
2222 | goto error; | |
2223 | } | |
2224 | ||
2225 | ret = bt_stream_set_name(ds_file_group->stream, | |
2226 | name->str); | |
2227 | if (ret) { | |
5c3441d8 | 2228 | BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Cannot set stream's name: " |
bf5b7748 SM |
2229 | "addr=%p, stream-name=\"%s\"", |
2230 | ds_file_group->stream, name->str); | |
2231 | goto error; | |
2232 | } | |
2233 | ||
2234 | g_string_free(name, TRUE); | |
2235 | name = NULL; | |
2236 | } | |
2237 | ||
2238 | ret = 0; | |
2239 | goto end; | |
2240 | ||
2241 | error: | |
2242 | ret = -1; | |
2243 | ||
2244 | end: | |
2245 | ||
2246 | if (name) { | |
2247 | g_string_free(name, TRUE); | |
2248 | } | |
2249 | return ret; | |
2250 | } | |
2251 | ||
c423217e SM |
2252 | static const struct bt_param_validation_value_descr inputs_elem_descr = { |
2253 | .type = BT_VALUE_TYPE_STRING, | |
2254 | }; | |
bf5b7748 | 2255 | |
c423217e SM |
2256 | static const struct bt_param_validation_map_value_entry_descr fs_params_entries_descr[] = { |
2257 | { "inputs", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY, { | |
2258 | BT_VALUE_TYPE_ARRAY, | |
2259 | .array = { | |
2260 | .min_length = 1, | |
2261 | .max_length = BT_PARAM_VALIDATION_INFINITE, | |
2262 | .element_type = &inputs_elem_descr, | |
bf5b7748 | 2263 | } |
c423217e SM |
2264 | }}, |
2265 | { "trace-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_STRING } }, | |
2266 | { "clock-class-offset-s", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_SIGNED_INTEGER } }, | |
2267 | { "clock-class-offset-ns", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_SIGNED_INTEGER } }, | |
2268 | { "force-clock-class-origin-unix-epoch", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_BOOL } }, | |
2269 | BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END | |
2270 | }; | |
bf5b7748 | 2271 | |
bf5b7748 | 2272 | |
c80d4c65 | 2273 | bool read_src_fs_parameters(const bt_value *params, |
c77d62f1 SM |
2274 | const bt_value **inputs, |
2275 | const bt_value **trace_name, | |
2276 | struct ctf_fs_component *ctf_fs, | |
5c3441d8 SM |
2277 | bt_self_component *self_comp, |
2278 | bt_self_component_class *self_comp_class) { | |
c80d4c65 SM |
2279 | bool ret; |
2280 | const bt_value *value; | |
3d731ea9 | 2281 | bt_logging_level log_level = ctf_fs->log_level; |
c423217e SM |
2282 | enum bt_param_validation_status validate_value_status; |
2283 | gchar *error = NULL; | |
2284 | ||
2285 | validate_value_status = bt_param_validation_validate(params, | |
2286 | fs_params_entries_descr, &error); | |
2287 | if (validate_value_status != BT_PARAM_VALIDATION_STATUS_OK) { | |
2288 | BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class, | |
2289 | "%s", error); | |
2290 | ret = false; | |
2291 | goto end; | |
2292 | } | |
c80d4c65 | 2293 | |
a1040187 SM |
2294 | /* inputs parameter */ |
2295 | *inputs = bt_value_map_borrow_entry_value_const(params, "inputs"); | |
c80d4c65 SM |
2296 | |
2297 | /* clock-class-offset-s parameter */ | |
2298 | value = bt_value_map_borrow_entry_value_const(params, | |
2299 | "clock-class-offset-s"); | |
2300 | if (value) { | |
c80d4c65 | 2301 | ctf_fs->metadata_config.clock_class_offset_s = |
60bbfc7c | 2302 | bt_value_integer_signed_get(value); |
c80d4c65 SM |
2303 | } |
2304 | ||
2305 | /* clock-class-offset-ns parameter */ | |
2306 | value = bt_value_map_borrow_entry_value_const(params, | |
2307 | "clock-class-offset-ns"); | |
2308 | if (value) { | |
c80d4c65 | 2309 | ctf_fs->metadata_config.clock_class_offset_ns = |
60bbfc7c | 2310 | bt_value_integer_signed_get(value); |
c80d4c65 SM |
2311 | } |
2312 | ||
1ffc68e8 FD |
2313 | /* force-clock-class-origin-unix-epoch parameter */ |
2314 | value = bt_value_map_borrow_entry_value_const(params, | |
2315 | "force-clock-class-origin-unix-epoch"); | |
2316 | if (value) { | |
1ffc68e8 FD |
2317 | ctf_fs->metadata_config.force_clock_class_origin_unix_epoch = |
2318 | bt_value_bool_get(value); | |
2319 | } | |
2320 | ||
c77d62f1 SM |
2321 | /* trace-name parameter */ |
2322 | *trace_name = bt_value_map_borrow_entry_value_const(params, "trace-name"); | |
c80d4c65 SM |
2323 | |
2324 | ret = true; | |
c80d4c65 SM |
2325 | |
2326 | end: | |
c423217e | 2327 | g_free(error); |
c80d4c65 SM |
2328 | return ret; |
2329 | } | |
2330 | ||
5b29e799 | 2331 | static |
834e9996 | 2332 | struct ctf_fs_component *ctf_fs_create( |
5c3441d8 | 2333 | const bt_value *params, |
6699263d | 2334 | bt_self_component_source *self_comp_src) |
56a1cced | 2335 | { |
bf5b7748 | 2336 | struct ctf_fs_component *ctf_fs = NULL; |
a1040187 | 2337 | const bt_value *inputs_value; |
c77d62f1 | 2338 | const bt_value *trace_name_value; |
3d731ea9 PP |
2339 | bt_self_component *self_comp = |
2340 | bt_self_component_source_as_self_component(self_comp_src); | |
56a1cced | 2341 | |
3d731ea9 | 2342 | ctf_fs = ctf_fs_component_create(bt_component_get_logging_level( |
f67894f9 | 2343 | bt_self_component_as_component(self_comp)), self_comp); |
c80d4c65 | 2344 | if (!ctf_fs) { |
bf5b7748 SM |
2345 | goto error; |
2346 | } | |
2347 | ||
c77d62f1 | 2348 | if (!read_src_fs_parameters(params, &inputs_value, &trace_name_value, |
6699263d | 2349 | ctf_fs, self_comp, NULL)) { |
bf5b7748 | 2350 | goto error; |
56a1cced JG |
2351 | } |
2352 | ||
3d731ea9 | 2353 | bt_self_component_set_data(self_comp, ctf_fs); |
56a1cced | 2354 | |
aab89afc | 2355 | if (ctf_fs_component_create_ctf_fs_trace(ctf_fs, inputs_value, |
6699263d | 2356 | trace_name_value, self_comp, NULL)) { |
4f1f88a6 PP |
2357 | goto error; |
2358 | } | |
2359 | ||
aab89afc SM |
2360 | if (create_streams_for_trace(ctf_fs->trace)) { |
2361 | goto error; | |
2362 | } | |
bf5b7748 | 2363 | |
aab89afc SM |
2364 | if (create_ports_for_trace(ctf_fs, ctf_fs->trace, self_comp_src)) { |
2365 | goto error; | |
4f1f88a6 PP |
2366 | } |
2367 | ||
1ef09eb5 JG |
2368 | goto end; |
2369 | ||
56a1cced | 2370 | error: |
1a9f7075 | 2371 | ctf_fs_destroy(ctf_fs); |
e7a4393b | 2372 | ctf_fs = NULL; |
3d731ea9 | 2373 | bt_self_component_set_data(self_comp, NULL); |
1a9f7075 | 2374 | |
1ef09eb5 | 2375 | end: |
56a1cced JG |
2376 | return ctf_fs; |
2377 | } | |
2378 | ||
ea0b4b9e | 2379 | BT_HIDDEN |
4175c1d5 | 2380 | bt_component_class_initialize_method_status ctf_fs_init( |
5c3441d8 | 2381 | bt_self_component_source *self_comp_src, |
e3250e61 | 2382 | bt_self_component_source_configuration *config, |
f807570c | 2383 | const bt_value *params, __attribute__((unused)) void *init_method_data) |
ea0b4b9e JG |
2384 | { |
2385 | struct ctf_fs_component *ctf_fs; | |
4175c1d5 FD |
2386 | bt_component_class_initialize_method_status ret = |
2387 | BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK; | |
ea0b4b9e | 2388 | |
6699263d | 2389 | ctf_fs = ctf_fs_create(params, self_comp_src); |
ea0b4b9e | 2390 | if (!ctf_fs) { |
4175c1d5 | 2391 | ret = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR; |
ea0b4b9e | 2392 | } |
4c1456f0 | 2393 | |
ea0b4b9e JG |
2394 | return ret; |
2395 | } | |
33f93973 PP |
2396 | |
2397 | BT_HIDDEN | |
fb25b9e3 | 2398 | bt_component_class_query_method_status ctf_fs_query( |
8eee8ea2 | 2399 | bt_self_component_class_source *comp_class, |
bf403eb2 | 2400 | bt_private_query_executor *priv_query_exec, |
8eee8ea2 | 2401 | const char *object, const bt_value *params, |
f6e305ce | 2402 | __attribute__((unused)) void *method_data, |
8eee8ea2 | 2403 | const bt_value **result) |
33f93973 | 2404 | { |
fb25b9e3 PP |
2405 | bt_component_class_query_method_status status = |
2406 | BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK; | |
bf403eb2 PP |
2407 | bt_logging_level log_level = bt_query_executor_get_logging_level( |
2408 | bt_private_query_executor_as_query_executor_const( | |
2409 | priv_query_exec)); | |
33f93973 | 2410 | |
acfa8112 | 2411 | if (strcmp(object, "metadata-info") == 0) { |
3d731ea9 PP |
2412 | status = metadata_info_query(comp_class, params, log_level, |
2413 | result); | |
9db4399f SM |
2414 | } else if (strcmp(object, "babeltrace.trace-infos") == 0) { |
2415 | status = trace_infos_query(comp_class, params, log_level, | |
3d731ea9 | 2416 | result); |
9e534aae | 2417 | } else if (!strcmp(object, "babeltrace.support-info")) { |
a1040187 | 2418 | status = support_info_query(comp_class, params, log_level, result); |
33f93973 | 2419 | } else { |
55314f2a | 2420 | BT_LOGE("Unknown query object `%s`", object); |
7dd3e712 | 2421 | status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT; |
04c0ba87 | 2422 | goto end; |
33f93973 | 2423 | } |
33f93973 | 2424 | end: |
834e9996 | 2425 | return status; |
33f93973 | 2426 | } |