projects / babeltrace.git / blob
? search:


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