2 * SPDX-License-Identifier: MIT
4 * Copyright 2015-2017 Philippe Proulx <pproulx@efficios.com>
5 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 * Babeltrace CTF file system Reader Component
13 #include <babeltrace2/babeltrace.h>
15 #include "common/assert.h"
16 #include "common/common.h"
17 #include "common/uuid.h"
19 #include "plugins/common/param-validation/param-validation.h"
21 #include "../common/src/metadata/tsdl/ctf-meta-configure-ir-trace.hpp"
22 #include "../common/src/msg-iter/msg-iter.hpp"
23 #include "data-stream-file.hpp"
26 #include "metadata.hpp"
37 static void ctf_fs_msg_iter_data_destroy(struct ctf_fs_msg_iter_data
*msg_iter_data
)
43 if (msg_iter_data
->msg_iter
) {
44 ctf_msg_iter_destroy(msg_iter_data
->msg_iter
);
47 if (msg_iter_data
->msg_iter_medops_data
) {
48 ctf_fs_ds_group_medops_data_destroy(msg_iter_data
->msg_iter_medops_data
);
54 static bt_message_iterator_class_next_method_status
55 ctf_fs_iterator_next_one(struct ctf_fs_msg_iter_data
*msg_iter_data
, const bt_message
**out_msg
)
57 bt_message_iterator_class_next_method_status status
;
58 enum ctf_msg_iter_status msg_iter_status
;
60 msg_iter_status
= ctf_msg_iter_get_next_message(msg_iter_data
->msg_iter
, out_msg
);
62 switch (msg_iter_status
) {
63 case CTF_MSG_ITER_STATUS_OK
:
64 /* Cool, message has been written to *out_msg. */
65 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
68 case CTF_MSG_ITER_STATUS_EOF
:
69 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END
;
72 case CTF_MSG_ITER_STATUS_AGAIN
:
74 * Should not make it this far as this is
75 * medium-specific; there is nothing for the user to do
76 * and it should have been handled upstream.
80 case CTF_MSG_ITER_STATUS_ERROR
:
81 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
82 "Failed to get next message from CTF message iterator.");
83 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
86 case CTF_MSG_ITER_STATUS_MEMORY_ERROR
:
87 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
88 "Failed to get next message from CTF message iterator.");
89 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
99 bt_message_iterator_class_next_method_status
100 ctf_fs_iterator_next(bt_self_message_iterator
*iterator
, bt_message_array_const msgs
,
101 uint64_t capacity
, uint64_t *count
)
103 bt_message_iterator_class_next_method_status status
;
104 struct ctf_fs_msg_iter_data
*msg_iter_data
=
105 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(iterator
);
108 if (G_UNLIKELY(msg_iter_data
->next_saved_error
)) {
110 * Last time we were called, we hit an error but had some
111 * messages to deliver, so we stashed the error here. Return
114 BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(msg_iter_data
->next_saved_error
);
115 status
= msg_iter_data
->next_saved_status
;
120 status
= ctf_fs_iterator_next_one(msg_iter_data
, &msgs
[i
]);
121 if (status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
) {
124 } while (i
< capacity
&& status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
);
128 * Even if ctf_fs_iterator_next_one() returned something
129 * else than BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK, we
130 * accumulated message objects in the output
131 * message array, so we need to return
132 * BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK so that they are
133 * transferred to downstream. This other status occurs
134 * again the next time muxer_msg_iter_do_next() is
135 * called, possibly without any accumulated
136 * message, in which case we'll return it.
140 * Save this error for the next _next call. Assume that
141 * this component always appends error causes when
142 * returning an error status code, which will cause the
143 * current thread error to be non-NULL.
145 msg_iter_data
->next_saved_error
= bt_current_thread_take_error();
146 BT_ASSERT(msg_iter_data
->next_saved_error
);
147 msg_iter_data
->next_saved_status
= status
;
151 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
158 bt_message_iterator_class_seek_beginning_method_status
159 ctf_fs_iterator_seek_beginning(bt_self_message_iterator
*it
)
161 struct ctf_fs_msg_iter_data
*msg_iter_data
=
162 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(it
);
164 BT_ASSERT(msg_iter_data
);
166 ctf_msg_iter_reset(msg_iter_data
->msg_iter
);
167 ctf_fs_ds_group_medops_data_reset(msg_iter_data
->msg_iter_medops_data
);
169 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_OK
;
172 void ctf_fs_iterator_finalize(bt_self_message_iterator
*it
)
174 ctf_fs_msg_iter_data_destroy(
175 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(it
));
178 static bt_message_iterator_class_initialize_method_status
179 ctf_msg_iter_medium_status_to_msg_iter_initialize_status(enum ctf_msg_iter_medium_status status
)
182 case CTF_MSG_ITER_MEDIUM_STATUS_EOF
:
183 case CTF_MSG_ITER_MEDIUM_STATUS_AGAIN
:
184 case CTF_MSG_ITER_MEDIUM_STATUS_ERROR
:
185 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
186 case CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
:
187 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
188 case CTF_MSG_ITER_MEDIUM_STATUS_OK
:
189 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
195 bt_message_iterator_class_initialize_method_status
196 ctf_fs_iterator_init(bt_self_message_iterator
*self_msg_iter
,
197 bt_self_message_iterator_configuration
*config
,
198 bt_self_component_port_output
*self_port
)
200 struct ctf_fs_port_data
*port_data
;
201 bt_message_iterator_class_initialize_method_status status
;
202 enum ctf_msg_iter_medium_status medium_status
;
204 port_data
= (struct ctf_fs_port_data
*) bt_self_component_port_get_data(
205 bt_self_component_port_output_as_self_component_port(self_port
));
206 BT_ASSERT(port_data
);
208 ctf_fs_msg_iter_data
*msg_iter_data
= new ctf_fs_msg_iter_data
{self_msg_iter
};
209 msg_iter_data
->ds_file_group
= port_data
->ds_file_group
;
211 medium_status
= ctf_fs_ds_group_medops_data_create(msg_iter_data
->ds_file_group
, self_msg_iter
,
212 msg_iter_data
->logger
,
213 &msg_iter_data
->msg_iter_medops_data
);
214 BT_ASSERT(medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_OK
||
215 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_ERROR
||
216 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
);
217 if (medium_status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
218 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
219 "Failed to create ctf_fs_ds_group_medops");
220 status
= ctf_msg_iter_medium_status_to_msg_iter_initialize_status(medium_status
);
224 msg_iter_data
->msg_iter
= ctf_msg_iter_create(
225 msg_iter_data
->ds_file_group
->ctf_fs_trace
->metadata
->tc
,
226 bt_common_get_page_size(static_cast<int>(msg_iter_data
->logger
.level())) * 8,
227 ctf_fs_ds_group_medops
, msg_iter_data
->msg_iter_medops_data
, self_msg_iter
,
228 msg_iter_data
->logger
);
229 if (!msg_iter_data
->msg_iter
) {
230 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
231 "Cannot create a CTF message iterator.");
232 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
237 * This iterator can seek forward if its stream class has a default
240 if (msg_iter_data
->ds_file_group
->sc
->default_clock_class
) {
241 bt_self_message_iterator_configuration_set_can_seek_forward(config
, true);
244 bt_self_message_iterator_set_data(self_msg_iter
, msg_iter_data
);
245 msg_iter_data
= NULL
;
247 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
251 bt_self_message_iterator_set_data(self_msg_iter
, NULL
);
254 ctf_fs_msg_iter_data_destroy(msg_iter_data
);
258 static void ctf_fs_trace_destroy(struct ctf_fs_trace
*ctf_fs_trace
)
264 if (ctf_fs_trace
->ds_file_groups
) {
265 g_ptr_array_free(ctf_fs_trace
->ds_file_groups
, TRUE
);
268 BT_TRACE_PUT_REF_AND_RESET(ctf_fs_trace
->trace
);
270 if (ctf_fs_trace
->path
) {
271 g_string_free(ctf_fs_trace
->path
, TRUE
);
274 if (ctf_fs_trace
->metadata
) {
275 ctf_fs_metadata_fini(ctf_fs_trace
->metadata
);
276 delete ctf_fs_trace
->metadata
;
282 void ctf_fs_destroy(struct ctf_fs_component
*ctf_fs
)
288 ctf_fs_trace_destroy(ctf_fs
->trace
);
290 if (ctf_fs
->port_data
) {
291 g_ptr_array_free(ctf_fs
->port_data
, TRUE
);
297 static void port_data_destroy(struct ctf_fs_port_data
*port_data
)
306 static void port_data_destroy_notifier(void *data
)
308 port_data_destroy((struct ctf_fs_port_data
*) data
);
311 static void ctf_fs_trace_destroy_notifier(void *data
)
313 struct ctf_fs_trace
*trace
= (struct ctf_fs_trace
*) data
;
314 ctf_fs_trace_destroy(trace
);
317 ctf_fs_component
*ctf_fs_component_create(const bt2c::Logger
& parentLogger
)
319 ctf_fs_component
*ctf_fs
= new ctf_fs_component
{parentLogger
};
320 ctf_fs
->port_data
= g_ptr_array_new_with_free_func(port_data_destroy_notifier
);
321 if (!ctf_fs
->port_data
) {
328 ctf_fs_destroy(ctf_fs
);
335 void ctf_fs_finalize(bt_self_component_source
*component
)
337 ctf_fs_destroy((struct ctf_fs_component
*) bt_self_component_get_data(
338 bt_self_component_source_as_self_component(component
)));
341 gchar
*ctf_fs_make_port_name(struct ctf_fs_ds_file_group
*ds_file_group
)
343 GString
*name
= g_string_new(NULL
);
346 * The unique port name is generated by concatenating unique identifiers
354 /* For the trace, use the uuid if present, else the path. */
355 if (ds_file_group
->ctf_fs_trace
->metadata
->tc
->is_uuid_set
) {
356 char uuid_str
[BT_UUID_STR_LEN
+ 1];
358 bt_uuid_to_str(ds_file_group
->ctf_fs_trace
->metadata
->tc
->uuid
, uuid_str
);
359 g_string_assign(name
, uuid_str
);
361 g_string_assign(name
, ds_file_group
->ctf_fs_trace
->path
->str
);
365 * For the stream class, use the id if present. We can omit this field
366 * otherwise, as there will only be a single stream class.
368 if (ds_file_group
->sc
->id
!= UINT64_C(-1)) {
369 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->sc
->id
);
372 /* For the stream, use the id if present, else, use the path. */
373 if (ds_file_group
->stream_id
!= UINT64_C(-1)) {
374 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->stream_id
);
376 BT_ASSERT(ds_file_group
->ds_file_infos
->len
== 1);
377 struct ctf_fs_ds_file_info
*ds_file_info
=
378 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
379 g_string_append_printf(name
, " | %s", ds_file_info
->path
->str
);
382 return g_string_free(name
, FALSE
);
385 static int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
386 struct ctf_fs_ds_file_group
*ds_file_group
,
387 bt_self_component_source
*self_comp_src
)
390 struct ctf_fs_port_data
*port_data
= NULL
;
393 port_name
= ctf_fs_make_port_name(ds_file_group
);
398 BT_CPPLOGI_SPEC(ctf_fs
->logger
, "Creating one port named `{}`", port_name
);
400 /* Create output port for this file */
401 port_data
= new ctf_fs_port_data
;
402 port_data
->ctf_fs
= ctf_fs
;
403 port_data
->ds_file_group
= ds_file_group
;
404 ret
= bt_self_component_source_add_output_port(self_comp_src
, port_name
, port_data
, NULL
);
409 g_ptr_array_add(ctf_fs
->port_data
, port_data
);
419 port_data_destroy(port_data
);
423 static int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
424 struct ctf_fs_trace
*ctf_fs_trace
,
425 bt_self_component_source
*self_comp_src
)
430 /* Create one output port for each stream file group */
431 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
432 struct ctf_fs_ds_file_group
*ds_file_group
=
433 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
435 ret
= create_one_port_for_trace(ctf_fs
, ds_file_group
, self_comp_src
);
437 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create output port.");
446 static void ctf_fs_ds_file_info_destroy(struct ctf_fs_ds_file_info
*ds_file_info
)
452 if (ds_file_info
->path
) {
453 g_string_free(ds_file_info
->path
, TRUE
);
459 static struct ctf_fs_ds_file_info
*ctf_fs_ds_file_info_create(const char *path
, int64_t begin_ns
)
461 ctf_fs_ds_file_info
*ds_file_info
= new ctf_fs_ds_file_info
;
462 ds_file_info
->path
= g_string_new(path
);
463 if (!ds_file_info
->path
) {
464 ctf_fs_ds_file_info_destroy(ds_file_info
);
469 ds_file_info
->begin_ns
= begin_ns
;
475 static void ctf_fs_ds_file_group_destroy(struct ctf_fs_ds_file_group
*ds_file_group
)
477 if (!ds_file_group
) {
481 if (ds_file_group
->ds_file_infos
) {
482 g_ptr_array_free(ds_file_group
->ds_file_infos
, TRUE
);
485 ctf_fs_ds_index_destroy(ds_file_group
->index
);
487 bt_stream_put_ref(ds_file_group
->stream
);
488 delete ds_file_group
;
491 static struct ctf_fs_ds_file_group
*ctf_fs_ds_file_group_create(struct ctf_fs_trace
*ctf_fs_trace
,
492 struct ctf_stream_class
*sc
,
493 uint64_t stream_instance_id
,
494 struct ctf_fs_ds_index
*index
)
496 ctf_fs_ds_file_group
*ds_file_group
= new ctf_fs_ds_file_group
;
497 ds_file_group
->ds_file_infos
=
498 g_ptr_array_new_with_free_func((GDestroyNotify
) ctf_fs_ds_file_info_destroy
);
499 if (!ds_file_group
->ds_file_infos
) {
503 ds_file_group
->index
= index
;
505 ds_file_group
->stream_id
= stream_instance_id
;
507 ds_file_group
->sc
= sc
;
508 ds_file_group
->ctf_fs_trace
= ctf_fs_trace
;
512 ctf_fs_ds_file_group_destroy(ds_file_group
);
513 ctf_fs_ds_index_destroy(index
);
514 ds_file_group
= NULL
;
517 return ds_file_group
;
520 /* Replace by g_ptr_array_insert when we depend on glib >= 2.40. */
521 static void array_insert(GPtrArray
*array
, gpointer element
, size_t pos
)
523 size_t original_array_len
= array
->len
;
525 /* Allocate an unused element at the end of the array. */
526 g_ptr_array_add(array
, NULL
);
528 /* If we are not inserting at the end, move the elements by one. */
529 if (pos
< original_array_len
) {
530 memmove(&(array
->pdata
[pos
+ 1]), &(array
->pdata
[pos
]),
531 (original_array_len
- pos
) * sizeof(gpointer
));
534 /* Insert the value. */
535 array
->pdata
[pos
] = element
;
539 * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right
540 * place to keep it sorted.
543 static void ds_file_group_insert_ds_file_info_sorted(struct ctf_fs_ds_file_group
*ds_file_group
,
544 struct ctf_fs_ds_file_info
*ds_file_info
)
548 /* Find the spot where to insert this ds_file_info. */
549 for (i
= 0; i
< ds_file_group
->ds_file_infos
->len
; i
++) {
550 struct ctf_fs_ds_file_info
*other_ds_file_info
=
551 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, i
);
553 if (ds_file_info
->begin_ns
< other_ds_file_info
->begin_ns
) {
558 array_insert(ds_file_group
->ds_file_infos
, ds_file_info
, i
);
561 static bool ds_index_entries_equal(const struct ctf_fs_ds_index_entry
*left
,
562 const struct ctf_fs_ds_index_entry
*right
)
564 if (left
->packet_size
!= right
->packet_size
) {
568 if (left
->timestamp_begin
!= right
->timestamp_begin
) {
572 if (left
->timestamp_end
!= right
->timestamp_end
) {
576 if (left
->packet_seq_num
!= right
->packet_seq_num
) {
584 * Insert `entry` into `index`, without duplication.
586 * The entry is inserted only if there isn't an identical entry already.
588 * In any case, the ownership of `entry` is transferred to this function. So if
589 * the entry is not inserted, it is freed.
592 static void ds_index_insert_ds_index_entry_sorted(struct ctf_fs_ds_index
*index
,
593 struct ctf_fs_ds_index_entry
*entry
)
596 struct ctf_fs_ds_index_entry
*other_entry
= NULL
;
598 /* Find the spot where to insert this index entry. */
599 for (i
= 0; i
< index
->entries
->len
; i
++) {
600 other_entry
= (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, i
);
602 if (entry
->timestamp_begin_ns
<= other_entry
->timestamp_begin_ns
) {
608 * Insert the entry only if a duplicate doesn't already exist.
610 * There can be duplicate packets if reading multiple overlapping
611 * snapshots of the same trace. We then want the index to contain
612 * a reference to only one copy of that packet.
614 if (i
== index
->entries
->len
|| !ds_index_entries_equal(entry
, other_entry
)) {
615 array_insert(index
->entries
, entry
, i
);
621 static void merge_ctf_fs_ds_indexes(struct ctf_fs_ds_index
*dest
, struct ctf_fs_ds_index
*src
)
625 for (i
= 0; i
< src
->entries
->len
; i
++) {
626 struct ctf_fs_ds_index_entry
*entry
=
627 (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(src
->entries
, i
);
630 * Ownership of the ctf_fs_ds_index_entry is transferred to
631 * ds_index_insert_ds_index_entry_sorted.
633 g_ptr_array_index(src
->entries
, i
) = NULL
;
634 ds_index_insert_ds_index_entry_sorted(dest
, entry
);
638 static int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
, const char *path
)
640 int64_t stream_instance_id
= -1;
641 int64_t begin_ns
= -1;
642 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
643 bool add_group
= false;
646 struct ctf_fs_ds_file
*ds_file
= NULL
;
647 struct ctf_fs_ds_file_info
*ds_file_info
= NULL
;
648 struct ctf_fs_ds_index
*index
= NULL
;
649 struct ctf_msg_iter
*msg_iter
= NULL
;
650 struct ctf_stream_class
*sc
= NULL
;
651 struct ctf_msg_iter_packet_properties props
;
654 * Create a temporary ds_file to read some properties about the data
657 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, path
, ctf_fs_trace
->logger
);
662 /* Create a temporary iterator to read the ds_file. */
663 msg_iter
= ctf_msg_iter_create(
664 ctf_fs_trace
->metadata
->tc
,
665 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
666 ctf_fs_ds_file_medops
, ds_file
, nullptr, ctf_fs_trace
->logger
);
668 BT_CPPLOGE_STR_SPEC(ctf_fs_trace
->logger
, "Cannot create a CTF message iterator.");
672 ctf_msg_iter_set_dry_run(msg_iter
, true);
674 ret
= ctf_msg_iter_get_packet_properties(msg_iter
, &props
);
676 BT_CPPLOGE_APPEND_CAUSE_SPEC(
677 ctf_fs_trace
->logger
,
678 "Cannot get stream file's first packet's header and context fields (`{}`).", path
);
682 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
, props
.stream_class_id
);
684 stream_instance_id
= props
.data_stream_id
;
686 if (props
.snapshots
.beginning_clock
!= UINT64_C(-1)) {
687 BT_ASSERT(sc
->default_clock_class
);
688 ret
= bt_util_clock_cycles_to_ns_from_origin(
689 props
.snapshots
.beginning_clock
, sc
->default_clock_class
->frequency
,
690 sc
->default_clock_class
->offset_seconds
, sc
->default_clock_class
->offset_cycles
,
693 BT_CPPLOGE_APPEND_CAUSE_SPEC(
694 ctf_fs_trace
->logger
,
695 "Cannot convert clock cycles to nanoseconds from origin (`{}`).", path
);
700 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
);
705 index
= ctf_fs_ds_file_build_index(ds_file
, ds_file_info
, msg_iter
);
707 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to index CTF stream file \'{}\'",
708 ds_file
->file
->path
->str
);
712 if (begin_ns
== -1) {
714 * No beginning timestamp to sort the stream files
715 * within a stream file group, so consider that this
716 * file must be the only one within its group.
718 stream_instance_id
= -1;
721 if (stream_instance_id
== -1) {
723 * No stream instance ID or no beginning timestamp:
724 * create a unique stream file group for this stream
725 * file because, even if there's a stream instance ID,
726 * there's no timestamp to order the file within its
729 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, UINT64_C(-1), index
);
730 /* Ownership of index is transferred. */
733 if (!ds_file_group
) {
737 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, BT_MOVE_REF(ds_file_info
));
743 BT_ASSERT(stream_instance_id
!= -1);
744 BT_ASSERT(begin_ns
!= -1);
746 /* Find an existing stream file group with this ID */
747 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
749 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
751 if (ds_file_group
->sc
== sc
&& ds_file_group
->stream_id
== stream_instance_id
) {
755 ds_file_group
= NULL
;
758 if (!ds_file_group
) {
759 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, stream_instance_id
, index
);
760 /* Ownership of index is transferred. */
762 if (!ds_file_group
) {
768 merge_ctf_fs_ds_indexes(ds_file_group
->index
, index
);
771 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, BT_MOVE_REF(ds_file_info
));
776 ctf_fs_ds_file_group_destroy(ds_file_group
);
777 ds_file_group
= NULL
;
781 if (add_group
&& ds_file_group
) {
782 g_ptr_array_add(ctf_fs_trace
->ds_file_groups
, ds_file_group
);
785 ctf_fs_ds_file_destroy(ds_file
);
786 ctf_fs_ds_file_info_destroy(ds_file_info
);
789 ctf_msg_iter_destroy(msg_iter
);
792 ctf_fs_ds_index_destroy(index
);
796 static int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
799 const char *basename
;
800 GError
*error
= NULL
;
803 /* Check each file in the path directory, except specific ones */
804 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
806 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
807 "Cannot open directory `{}`: {} (code {})",
808 ctf_fs_trace
->path
->str
, error
->message
, error
->code
);
812 while ((basename
= g_dir_read_name(dir
))) {
813 struct ctf_fs_file
*file
;
815 if (strcmp(basename
, CTF_FS_METADATA_FILENAME
) == 0) {
816 /* Ignore the metadata stream. */
817 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
818 "Ignoring metadata file `{}" G_DIR_SEPARATOR_S
"{}`",
819 ctf_fs_trace
->path
->str
, basename
);
823 if (basename
[0] == '.') {
824 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
825 "Ignoring hidden file `{}" G_DIR_SEPARATOR_S
"{}`",
826 ctf_fs_trace
->path
->str
, basename
);
830 /* Create the file. */
831 file
= ctf_fs_file_create(ctf_fs_trace
->logger
);
833 BT_CPPLOGE_APPEND_CAUSE_SPEC(
834 ctf_fs_trace
->logger
,
835 "Cannot create stream file object for file `{}" G_DIR_SEPARATOR_S
"{}`",
836 ctf_fs_trace
->path
->str
, basename
);
840 /* Create full path string. */
841 g_string_append_printf(file
->path
, "%s" G_DIR_SEPARATOR_S
"%s", ctf_fs_trace
->path
->str
,
843 if (!g_file_test(file
->path
->str
, G_FILE_TEST_IS_REGULAR
)) {
844 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring non-regular file `{}`",
846 ctf_fs_file_destroy(file
);
851 ret
= ctf_fs_file_open(file
, "rb");
853 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Cannot open stream file `{}`",
858 if (file
->size
== 0) {
859 /* Skip empty stream. */
860 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring empty file `{}`", file
->path
->str
);
861 ctf_fs_file_destroy(file
);
865 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
, file
->path
->str
);
867 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
868 "Cannot add stream file `{}` to stream file group",
870 ctf_fs_file_destroy(file
);
874 ctf_fs_file_destroy(file
);
895 static int set_trace_name(bt_trace
*trace
, const char *name_suffix
, const bt2c::Logger
& logger
)
901 name
= g_string_new(NULL
);
903 BT_CPPLOGE_STR_SPEC(logger
, "Failed to allocate a GString.");
909 * Check if we have a trace environment string value named `hostname`.
910 * If so, use it as the trace name's prefix.
912 val
= bt_trace_borrow_environment_entry_value_by_name_const(trace
, "hostname");
913 if (val
&& bt_value_is_string(val
)) {
914 g_string_append(name
, bt_value_string_get(val
));
917 g_string_append_c(name
, G_DIR_SEPARATOR
);
922 g_string_append(name
, name_suffix
);
925 ret
= bt_trace_set_name(trace
, name
->str
);
934 g_string_free(name
, TRUE
);
940 static struct ctf_fs_trace
*ctf_fs_trace_create(const char *path
, const char *name
,
941 struct ctf_fs_metadata_config
*metadata_config
,
942 bt_self_component
*selfComp
,
943 const bt2c::Logger
& parentLogger
)
947 ctf_fs_trace
*ctf_fs_trace
= new struct ctf_fs_trace(parentLogger
);
948 ctf_fs_trace
->path
= g_string_new(path
);
949 if (!ctf_fs_trace
->path
) {
953 ctf_fs_trace
->metadata
= new ctf_fs_metadata
;
954 ctf_fs_metadata_init(ctf_fs_trace
->metadata
);
955 ctf_fs_trace
->ds_file_groups
=
956 g_ptr_array_new_with_free_func((GDestroyNotify
) ctf_fs_ds_file_group_destroy
);
957 if (!ctf_fs_trace
->ds_file_groups
) {
961 ret
= ctf_fs_metadata_set_trace_class(selfComp
, ctf_fs_trace
, metadata_config
);
966 if (ctf_fs_trace
->metadata
->trace_class
) {
967 ctf_fs_trace
->trace
= bt_trace_create(ctf_fs_trace
->metadata
->trace_class
);
968 if (!ctf_fs_trace
->trace
) {
973 if (ctf_fs_trace
->trace
) {
974 ret
= ctf_trace_class_configure_ir_trace(ctf_fs_trace
->metadata
->tc
, ctf_fs_trace
->trace
);
979 ret
= set_trace_name(ctf_fs_trace
->trace
, name
, ctf_fs_trace
->logger
);
985 ret
= create_ds_file_groups(ctf_fs_trace
);
993 ctf_fs_trace_destroy(ctf_fs_trace
);
1000 static int path_is_ctf_trace(const char *path
)
1002 GString
*metadata_path
= g_string_new(NULL
);
1005 if (!metadata_path
) {
1010 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
1012 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
1018 g_string_free(metadata_path
, TRUE
);
1022 /* Helper for ctf_fs_component_create_ctf_fs_trace, to handle a single path. */
1024 static int ctf_fs_component_create_ctf_fs_trace_one_path(struct ctf_fs_component
*ctf_fs
,
1025 const char *path_param
,
1026 const char *trace_name
, GPtrArray
*traces
,
1027 bt_self_component
*selfComp
)
1029 struct ctf_fs_trace
*ctf_fs_trace
;
1033 norm_path
= bt_common_normalize_path(path_param
, NULL
);
1035 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to normalize path: `{}`.", path_param
);
1039 ret
= path_is_ctf_trace(norm_path
->str
);
1041 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1042 ctf_fs
->logger
, "Failed to check if path is a CTF trace: path={}", norm_path
->str
);
1044 } else if (ret
== 0) {
1045 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1046 ctf_fs
->logger
, "Path is not a CTF trace (does not contain a metadata file): `{}`.",
1051 // FIXME: Remove or ifdef for __MINGW32__
1052 if (strcmp(norm_path
->str
, "/") == 0) {
1053 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Opening a trace in `/` is not supported.");
1058 ctf_fs_trace
= ctf_fs_trace_create(norm_path
->str
, trace_name
, &ctf_fs
->metadata_config
,
1059 selfComp
, ctf_fs
->logger
);
1060 if (!ctf_fs_trace
) {
1061 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create trace for `{}`.",
1066 g_ptr_array_add(traces
, ctf_fs_trace
);
1067 ctf_fs_trace
= NULL
;
1077 g_string_free(norm_path
, TRUE
);
1084 * Count the number of stream and event classes defined by this trace's metadata.
1086 * This is used to determine which metadata is the "latest", out of multiple
1087 * traces sharing the same UUID. It is assumed that amongst all these metadatas,
1088 * a bigger metadata is a superset of a smaller metadata. Therefore, it is
1089 * enough to just count the classes.
1092 static unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace
*trace
)
1094 unsigned int num
= trace
->metadata
->tc
->stream_classes
->len
;
1097 for (i
= 0; i
< trace
->metadata
->tc
->stream_classes
->len
; i
++) {
1098 struct ctf_stream_class
*sc
=
1099 (struct ctf_stream_class
*) trace
->metadata
->tc
->stream_classes
->pdata
[i
];
1100 num
+= sc
->event_classes
->len
;
1107 * Merge the src ds_file_group into dest. This consists of merging their
1108 * ds_file_infos, making sure to keep the result sorted.
1111 static void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group
*dest
,
1112 struct ctf_fs_ds_file_group
*src
)
1116 for (i
= 0; i
< src
->ds_file_infos
->len
; i
++) {
1117 struct ctf_fs_ds_file_info
*ds_file_info
=
1118 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(src
->ds_file_infos
, i
);
1120 /* Ownership of the ds_file_info is transferred to dest. */
1121 g_ptr_array_index(src
->ds_file_infos
, i
) = NULL
;
1123 ds_file_group_insert_ds_file_info_sorted(dest
, ds_file_info
);
1126 /* Merge both indexes. */
1127 merge_ctf_fs_ds_indexes(dest
->index
, src
->index
);
1129 /* Merge src_trace's data stream file groups into dest_trace's. */
1131 static int merge_matching_ctf_fs_ds_file_groups(struct ctf_fs_trace
*dest_trace
,
1132 struct ctf_fs_trace
*src_trace
)
1134 GPtrArray
*dest
= dest_trace
->ds_file_groups
;
1135 GPtrArray
*src
= src_trace
->ds_file_groups
;
1140 * Save the initial length of dest: we only want to check against the
1141 * original elements in the inner loop.
1143 const guint dest_len
= dest
->len
;
1145 for (s_i
= 0; s_i
< src
->len
; s_i
++) {
1146 struct ctf_fs_ds_file_group
*src_group
=
1147 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(src
, s_i
);
1148 struct ctf_fs_ds_file_group
*dest_group
= NULL
;
1150 /* A stream instance without ID can't match a stream in the other trace. */
1151 if (src_group
->stream_id
!= -1) {
1154 /* Let's search for a matching ds_file_group in the destination. */
1155 for (d_i
= 0; d_i
< dest_len
; d_i
++) {
1156 struct ctf_fs_ds_file_group
*candidate_dest
=
1157 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(dest
, d_i
);
1159 /* Can't match a stream instance without ID. */
1160 if (candidate_dest
->stream_id
== -1) {
1165 * If the two groups have the same stream instance id
1166 * and belong to the same stream class (stream instance
1167 * ids are per-stream class), they represent the same
1170 if (candidate_dest
->stream_id
!= src_group
->stream_id
||
1171 candidate_dest
->sc
->id
!= src_group
->sc
->id
) {
1175 dest_group
= candidate_dest
;
1181 * Didn't find a friend in dest to merge our src_group into?
1182 * Create a new empty one. This can happen if a stream was
1183 * active in the source trace chunk but not in the destination
1187 struct ctf_stream_class
*sc
;
1188 struct ctf_fs_ds_index
*index
;
1190 sc
= ctf_trace_class_borrow_stream_class_by_id(dest_trace
->metadata
->tc
,
1194 index
= ctf_fs_ds_index_create(dest_trace
->logger
);
1200 dest_group
= ctf_fs_ds_file_group_create(dest_trace
, sc
, src_group
->stream_id
, index
);
1201 /* Ownership of index is transferred. */
1208 g_ptr_array_add(dest_trace
->ds_file_groups
, dest_group
);
1211 BT_ASSERT(dest_group
);
1212 merge_ctf_fs_ds_file_groups(dest_group
, src_group
);
1220 * Collapse the given traces, which must all share the same UUID, in a single
1223 * The trace with the most expansive metadata is chosen and all other traces
1224 * are merged into that one. The array slots of all the traces that get merged
1225 * in the chosen one are set to NULL, so only the slot of the chosen trace
1229 static int merge_ctf_fs_traces(struct ctf_fs_trace
**traces
, unsigned int num_traces
,
1230 struct ctf_fs_trace
**out_trace
)
1232 unsigned int winner_count
;
1233 struct ctf_fs_trace
*winner
;
1237 BT_ASSERT(num_traces
>= 2);
1239 winner_count
= metadata_count_stream_and_event_classes(traces
[0]);
1243 /* Find the trace with the largest metadata. */
1244 for (i
= 1; i
< num_traces
; i
++) {
1245 struct ctf_fs_trace
*candidate
;
1246 unsigned int candidate_count
;
1248 candidate
= traces
[i
];
1250 /* A bit of sanity check. */
1251 BT_ASSERT(bt_uuid_compare(winner
->metadata
->tc
->uuid
, candidate
->metadata
->tc
->uuid
) == 0);
1253 candidate_count
= metadata_count_stream_and_event_classes(candidate
);
1255 if (candidate_count
> winner_count
) {
1256 winner_count
= candidate_count
;
1262 /* Merge all the other traces in the winning trace. */
1263 for (i
= 0; i
< num_traces
; i
++) {
1264 struct ctf_fs_trace
*trace
= traces
[i
];
1266 /* Don't merge the winner into itself. */
1267 if (trace
== winner
) {
1271 /* Merge trace's data stream file groups into winner's. */
1272 ret
= merge_matching_ctf_fs_ds_file_groups(winner
, trace
);
1279 * Move the winner out of the array, into `*out_trace`.
1281 *out_trace
= winner
;
1282 traces
[winner_i
] = NULL
;
1294 static int decode_clock_snapshot_after_event(struct ctf_fs_trace
*ctf_fs_trace
,
1295 struct ctf_clock_class
*default_cc
,
1296 struct ctf_fs_ds_index_entry
*index_entry
,
1297 enum target_event target_event
, uint64_t *cs
,
1300 enum ctf_msg_iter_status iter_status
= CTF_MSG_ITER_STATUS_OK
;
1301 struct ctf_fs_ds_file
*ds_file
= NULL
;
1302 struct ctf_msg_iter
*msg_iter
= NULL
;
1305 BT_ASSERT(ctf_fs_trace
);
1306 BT_ASSERT(index_entry
);
1307 BT_ASSERT(index_entry
->path
);
1309 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, index_entry
->path
, ctf_fs_trace
->logger
);
1311 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to create a ctf_fs_ds_file");
1316 BT_ASSERT(ctf_fs_trace
->metadata
);
1317 BT_ASSERT(ctf_fs_trace
->metadata
->tc
);
1319 msg_iter
= ctf_msg_iter_create(
1320 ctf_fs_trace
->metadata
->tc
,
1321 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
1322 ctf_fs_ds_file_medops
, ds_file
, NULL
, ctf_fs_trace
->logger
);
1324 /* ctf_msg_iter_create() logs errors. */
1330 * Turn on dry run mode to prevent the creation and usage of Babeltrace
1331 * library objects (bt_field, bt_message_*, etc.).
1333 ctf_msg_iter_set_dry_run(msg_iter
, true);
1335 /* Seek to the beginning of the target packet. */
1336 iter_status
= ctf_msg_iter_seek(msg_iter
, index_entry
->offset
);
1338 /* ctf_msg_iter_seek() logs errors. */
1343 switch (target_event
) {
1346 * Start to decode the packet until we reach the end of
1347 * the first event. To extract the first event's clock
1350 iter_status
= ctf_msg_iter_curr_packet_first_event_clock_snapshot(msg_iter
, cs
);
1353 /* Decode the packet to extract the last event's clock snapshot. */
1354 iter_status
= ctf_msg_iter_curr_packet_last_event_clock_snapshot(msg_iter
, cs
);
1364 /* Convert clock snapshot to timestamp. */
1365 ret
= bt_util_clock_cycles_to_ns_from_origin(
1366 *cs
, default_cc
->frequency
, default_cc
->offset_seconds
, default_cc
->offset_cycles
, ts_ns
);
1368 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1369 "Failed to convert clock snapshot to timestamp");
1375 ctf_fs_ds_file_destroy(ds_file
);
1378 ctf_msg_iter_destroy(msg_iter
);
1384 static int decode_packet_first_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1385 struct ctf_clock_class
*default_cc
,
1386 struct ctf_fs_ds_index_entry
*index_entry
,
1387 uint64_t *cs
, int64_t *ts_ns
)
1389 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, FIRST_EVENT
, cs
,
1393 static int decode_packet_last_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1394 struct ctf_clock_class
*default_cc
,
1395 struct ctf_fs_ds_index_entry
*index_entry
,
1396 uint64_t *cs
, int64_t *ts_ns
)
1398 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, LAST_EVENT
, cs
,
1403 * Fix up packet index entries for lttng's "event-after-packet" bug.
1404 * Some buggy lttng tracer versions may emit events with a timestamp that is
1405 * larger (after) than the timestamp_end of the their packets.
1407 * To fix up this erroneous data we do the following:
1408 * 1. If it's not the stream file's last packet: set the packet index entry's
1409 * end time to the next packet's beginning time.
1410 * 2. If it's the stream file's last packet, set the packet index entry's end
1411 * time to the packet's last event's time, if any, or to the packet's
1412 * beginning time otherwise.
1414 * Known buggy tracer versions:
1415 * - before lttng-ust 2.11.0
1416 * - before lttng-module 2.11.0
1417 * - before lttng-module 2.10.10
1418 * - before lttng-module 2.9.13
1420 static int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace
*trace
)
1423 guint ds_file_group_i
;
1424 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1426 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
; ds_file_group_i
++) {
1428 struct ctf_clock_class
*default_cc
;
1429 struct ctf_fs_ds_index_entry
*last_entry
;
1430 struct ctf_fs_ds_index
*index
;
1432 struct ctf_fs_ds_file_group
*ds_file_group
=
1433 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1435 BT_ASSERT(ds_file_group
);
1436 index
= ds_file_group
->index
;
1439 BT_ASSERT(index
->entries
);
1440 BT_ASSERT(index
->entries
->len
> 0);
1443 * Iterate over all entries but the last one. The last one is
1444 * fixed differently after.
1446 for (entry_i
= 0; entry_i
< index
->entries
->len
- 1; entry_i
++) {
1447 struct ctf_fs_ds_index_entry
*curr_entry
, *next_entry
;
1449 curr_entry
= (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
);
1450 next_entry
= (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
+ 1);
1453 * 1. Set the current index entry `end` timestamp to
1454 * the next index entry `begin` timestamp.
1456 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1457 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1461 * 2. Fix the last entry by decoding the last event of the last
1465 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, index
->entries
->len
- 1);
1466 BT_ASSERT(last_entry
);
1468 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1469 default_cc
= ds_file_group
->sc
->default_clock_class
;
1472 * Decode packet to read the timestamp of the last event of the
1475 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1476 &last_entry
->timestamp_end
,
1477 &last_entry
->timestamp_end_ns
);
1479 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1481 "Failed to decode stream's last packet to get its last event's clock snapshot.");
1491 * Fix up packet index entries for barectf's "event-before-packet" bug.
1492 * Some buggy barectf tracer versions may emit events with a timestamp that is
1493 * less than the timestamp_begin of the their packets.
1495 * To fix up this erroneous data we do the following:
1496 * 1. Starting at the second index entry, set the timestamp_begin of the
1497 * current entry to the timestamp of the first event of the packet.
1498 * 2. Set the previous entry's timestamp_end to the timestamp_begin of the
1501 * Known buggy tracer versions:
1502 * - before barectf 2.3.1
1504 static int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace
*trace
)
1507 guint ds_file_group_i
;
1508 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1510 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
; ds_file_group_i
++) {
1512 struct ctf_clock_class
*default_cc
;
1513 ctf_fs_ds_file_group
*ds_file_group
=
1514 (ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1516 struct ctf_fs_ds_index
*index
= ds_file_group
->index
;
1519 BT_ASSERT(index
->entries
);
1520 BT_ASSERT(index
->entries
->len
> 0);
1522 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1523 default_cc
= ds_file_group
->sc
->default_clock_class
;
1526 * 1. Iterate over the index, starting from the second entry
1529 for (entry_i
= 1; entry_i
< index
->entries
->len
; entry_i
++) {
1530 ctf_fs_ds_index_entry
*prev_entry
=
1531 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
- 1);
1532 ctf_fs_ds_index_entry
*curr_entry
=
1533 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
);
1535 * 2. Set the current entry `begin` timestamp to the
1536 * timestamp of the first event of the current packet.
1538 ret
= decode_packet_first_event_timestamp(trace
, default_cc
, curr_entry
,
1539 &curr_entry
->timestamp_begin
,
1540 &curr_entry
->timestamp_begin_ns
);
1542 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1543 "Failed to decode first event's clock snapshot");
1548 * 3. Set the previous entry `end` timestamp to the
1549 * timestamp of the first event of the current packet.
1551 prev_entry
->timestamp_end
= curr_entry
->timestamp_begin
;
1552 prev_entry
->timestamp_end_ns
= curr_entry
->timestamp_begin_ns
;
1560 * When using the lttng-crash feature it's likely that the last packets of each
1561 * stream have their timestamp_end set to zero. This is caused by the fact that
1562 * the tracer crashed and was not able to properly close the packets.
1564 * To fix up this erroneous data we do the following:
1565 * For each index entry, if the entry's timestamp_end is 0 and the
1566 * timestamp_begin is not 0:
1567 * - If it's the stream file's last packet: set the packet index entry's end
1568 * time to the packet's last event's time, if any, or to the packet's
1569 * beginning time otherwise.
1570 * - If it's not the stream file's last packet: set the packet index
1571 * entry's end time to the next packet's beginning time.
1573 * Affected versions:
1574 * - All current and future lttng-ust and lttng-modules versions.
1576 static int fix_index_lttng_crash_quirk(struct ctf_fs_trace
*trace
)
1579 guint ds_file_group_idx
;
1580 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1582 for (ds_file_group_idx
= 0; ds_file_group_idx
< ds_file_groups
->len
; ds_file_group_idx
++) {
1584 struct ctf_clock_class
*default_cc
;
1585 struct ctf_fs_ds_index
*index
;
1587 ctf_fs_ds_file_group
*ds_file_group
=
1588 (ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_idx
);
1590 BT_ASSERT(ds_file_group
);
1591 index
= ds_file_group
->index
;
1593 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1594 default_cc
= ds_file_group
->sc
->default_clock_class
;
1597 BT_ASSERT(index
->entries
);
1598 BT_ASSERT(index
->entries
->len
> 0);
1600 ctf_fs_ds_index_entry
*last_entry
=
1601 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, index
->entries
->len
- 1);
1602 BT_ASSERT(last_entry
);
1604 /* 1. Fix the last entry first. */
1605 if (last_entry
->timestamp_end
== 0 && last_entry
->timestamp_begin
!= 0) {
1607 * Decode packet to read the timestamp of the
1608 * last event of the stream file.
1610 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1611 &last_entry
->timestamp_end
,
1612 &last_entry
->timestamp_end_ns
);
1614 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1615 "Failed to decode last event's clock snapshot");
1620 /* Iterate over all entries but the last one. */
1621 for (entry_idx
= 0; entry_idx
< index
->entries
->len
- 1; entry_idx
++) {
1622 ctf_fs_ds_index_entry
*curr_entry
=
1623 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_idx
);
1624 ctf_fs_ds_index_entry
*next_entry
=
1625 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_idx
+ 1);
1627 if (curr_entry
->timestamp_end
== 0 && curr_entry
->timestamp_begin
!= 0) {
1629 * 2. Set the current index entry `end` timestamp to
1630 * the next index entry `begin` timestamp.
1632 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1633 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1643 * Extract the tracer information necessary to compare versions.
1644 * Returns 0 on success, and -1 if the extraction is not successful because the
1645 * necessary fields are absents in the trace metadata.
1647 static int extract_tracer_info(struct ctf_fs_trace
*trace
, struct tracer_info
*current_tracer_info
)
1650 struct ctf_trace_class_env_entry
*entry
;
1652 /* Clear the current_tracer_info struct */
1653 memset(current_tracer_info
, 0, sizeof(*current_tracer_info
));
1656 * To compare 2 tracer versions, at least the tracer name and it's
1657 * major version are needed. If one of these is missing, consider it an
1658 * extraction failure.
1660 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_name");
1661 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR
) {
1662 goto missing_bare_minimum
;
1665 /* Set tracer name. */
1666 current_tracer_info
->name
= entry
->value
.str
->str
;
1668 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_major");
1669 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1670 goto missing_bare_minimum
;
1673 /* Set major version number. */
1674 current_tracer_info
->major
= entry
->value
.i
;
1676 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_minor");
1677 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1681 /* Set minor version number. */
1682 current_tracer_info
->minor
= entry
->value
.i
;
1684 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patch");
1687 * If `tracer_patch` doesn't exist `tracer_patchlevel` might.
1688 * For example, `lttng-modules` uses entry name
1689 * `tracer_patchlevel`.
1691 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patchlevel");
1694 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1698 /* Set patch version number. */
1699 current_tracer_info
->patch
= entry
->value
.i
;
1703 missing_bare_minimum
:
1709 static bool is_tracer_affected_by_lttng_event_after_packet_bug(struct tracer_info
*curr_tracer_info
)
1711 bool is_affected
= false;
1713 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1714 if (curr_tracer_info
->major
< 2) {
1716 } else if (curr_tracer_info
->major
== 2) {
1717 /* fixed in lttng-ust 2.11.0 */
1718 if (curr_tracer_info
->minor
< 11) {
1722 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1723 if (curr_tracer_info
->major
< 2) {
1725 } else if (curr_tracer_info
->major
== 2) {
1726 /* fixed in lttng-modules 2.11.0 */
1727 if (curr_tracer_info
->minor
== 10) {
1728 /* fixed in lttng-modules 2.10.10 */
1729 if (curr_tracer_info
->patch
< 10) {
1732 } else if (curr_tracer_info
->minor
== 9) {
1733 /* fixed in lttng-modules 2.9.13 */
1734 if (curr_tracer_info
->patch
< 13) {
1737 } else if (curr_tracer_info
->minor
< 9) {
1747 is_tracer_affected_by_barectf_event_before_packet_bug(struct tracer_info
*curr_tracer_info
)
1749 bool is_affected
= false;
1751 if (strcmp(curr_tracer_info
->name
, "barectf") == 0) {
1752 if (curr_tracer_info
->major
< 2) {
1754 } else if (curr_tracer_info
->major
== 2) {
1755 if (curr_tracer_info
->minor
< 3) {
1757 } else if (curr_tracer_info
->minor
== 3) {
1758 /* fixed in barectf 2.3.1 */
1759 if (curr_tracer_info
->patch
< 1) {
1769 static bool is_tracer_affected_by_lttng_crash_quirk(struct tracer_info
*curr_tracer_info
)
1771 bool is_affected
= false;
1773 /* All LTTng tracer may be affected by this lttng crash quirk. */
1774 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1776 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1784 * Looks for trace produced by known buggy tracers and fix up the index
1787 static int fix_packet_index_tracer_bugs(ctf_fs_trace
*trace
)
1790 struct tracer_info current_tracer_info
;
1792 ret
= extract_tracer_info(trace
, ¤t_tracer_info
);
1795 * A trace may not have all the necessary environment
1796 * entries to do the tracer version comparison.
1797 * At least, the tracer name and major version number
1798 * are needed. Failing to extract these entries is not
1802 BT_CPPLOGI_STR_SPEC(
1804 "Cannot extract tracer information necessary to compare with buggy versions.");
1808 /* Check if the trace may be affected by old tracer bugs. */
1809 if (is_tracer_affected_by_lttng_event_after_packet_bug(¤t_tracer_info
)) {
1810 BT_CPPLOGI_STR_SPEC(
1812 "Trace may be affected by LTTng tracer packet timestamp bug. Fixing up.");
1813 ret
= fix_index_lttng_event_after_packet_bug(trace
);
1815 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1816 "Failed to fix LTTng event-after-packet bug.");
1819 trace
->metadata
->tc
->quirks
.lttng_event_after_packet
= true;
1822 if (is_tracer_affected_by_barectf_event_before_packet_bug(¤t_tracer_info
)) {
1823 BT_CPPLOGI_STR_SPEC(
1825 "Trace may be affected by barectf tracer packet timestamp bug. Fixing up.");
1826 ret
= fix_index_barectf_event_before_packet_bug(trace
);
1828 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1829 "Failed to fix barectf event-before-packet bug.");
1832 trace
->metadata
->tc
->quirks
.barectf_event_before_packet
= true;
1835 if (is_tracer_affected_by_lttng_crash_quirk(¤t_tracer_info
)) {
1836 ret
= fix_index_lttng_crash_quirk(trace
);
1838 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1839 "Failed to fix lttng-crash timestamp quirks.");
1842 trace
->metadata
->tc
->quirks
.lttng_crash
= true;
1849 static gint
compare_ds_file_groups_by_first_path(gconstpointer a
, gconstpointer b
)
1851 ctf_fs_ds_file_group
* const *ds_file_group_a
= (ctf_fs_ds_file_group
**) a
;
1852 ctf_fs_ds_file_group
* const *ds_file_group_b
= (ctf_fs_ds_file_group
**) b
;
1854 BT_ASSERT((*ds_file_group_a
)->ds_file_infos
->len
> 0);
1855 BT_ASSERT((*ds_file_group_b
)->ds_file_infos
->len
> 0);
1857 const ctf_fs_ds_file_info
*first_ds_file_info_a
=
1858 (const ctf_fs_ds_file_info
*) (*ds_file_group_a
)->ds_file_infos
->pdata
[0];
1859 const ctf_fs_ds_file_info
*first_ds_file_info_b
=
1860 (const ctf_fs_ds_file_info
*) (*ds_file_group_b
)->ds_file_infos
->pdata
[0];
1862 return strcmp(first_ds_file_info_a
->path
->str
, first_ds_file_info_b
->path
->str
);
1865 static gint
compare_strings(gconstpointer p_a
, gconstpointer p_b
)
1867 const char *a
= *((const char **) p_a
);
1868 const char *b
= *((const char **) p_b
);
1870 return strcmp(a
, b
);
1873 int ctf_fs_component_create_ctf_fs_trace(struct ctf_fs_component
*ctf_fs
,
1874 const bt_value
*paths_value
,
1875 const bt_value
*trace_name_value
,
1876 bt_self_component
*selfComp
)
1880 GPtrArray
*paths
= NULL
;
1882 const char *trace_name
;
1884 BT_ASSERT(bt_value_get_type(paths_value
) == BT_VALUE_TYPE_ARRAY
);
1885 BT_ASSERT(!bt_value_array_is_empty(paths_value
));
1887 traces
= g_ptr_array_new_with_free_func(ctf_fs_trace_destroy_notifier
);
1889 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to allocate a GPtrArray.");
1893 paths
= g_ptr_array_new_with_free_func(g_free
);
1895 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to allocate a GPtrArray.");
1899 trace_name
= trace_name_value
? bt_value_string_get(trace_name_value
) : NULL
;
1902 * Create a sorted array of the paths, to make the execution of this
1903 * component deterministic.
1905 for (i
= 0; i
< bt_value_array_get_length(paths_value
); i
++) {
1906 const bt_value
*path_value
= bt_value_array_borrow_element_by_index_const(paths_value
, i
);
1907 const char *input
= bt_value_string_get(path_value
);
1910 input_copy
= g_strdup(input
);
1912 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to copy a string.");
1916 g_ptr_array_add(paths
, input_copy
);
1919 g_ptr_array_sort(paths
, compare_strings
);
1921 /* Create a separate ctf_fs_trace object for each path. */
1922 for (i
= 0; i
< paths
->len
; i
++) {
1923 const char *path
= (const char *) g_ptr_array_index(paths
, i
);
1925 ret
= ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs
, path
, trace_name
, traces
,
1932 if (traces
->len
> 1) {
1933 struct ctf_fs_trace
*first_trace
= (struct ctf_fs_trace
*) traces
->pdata
[0];
1934 const uint8_t *first_trace_uuid
= first_trace
->metadata
->tc
->uuid
;
1935 struct ctf_fs_trace
*trace
;
1938 * We have more than one trace, they must all share the same
1939 * UUID, verify that.
1941 for (i
= 0; i
< traces
->len
; i
++) {
1942 struct ctf_fs_trace
*this_trace
= (struct ctf_fs_trace
*) traces
->pdata
[i
];
1943 const uint8_t *this_trace_uuid
= this_trace
->metadata
->tc
->uuid
;
1945 if (!this_trace
->metadata
->tc
->is_uuid_set
) {
1946 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1948 "Multiple traces given, but a trace does not have a UUID: path={}",
1949 this_trace
->path
->str
);
1953 if (bt_uuid_compare(first_trace_uuid
, this_trace_uuid
) != 0) {
1954 char first_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1955 char this_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1957 bt_uuid_to_str(first_trace_uuid
, first_trace_uuid_str
);
1958 bt_uuid_to_str(this_trace_uuid
, this_trace_uuid_str
);
1960 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1961 "Multiple traces given, but UUIDs don't match: "
1962 "first-trace-uuid={}, first-trace-path={}, "
1963 "trace-uuid={}, trace-path={}",
1964 first_trace_uuid_str
, first_trace
->path
->str
,
1965 this_trace_uuid_str
, this_trace
->path
->str
);
1970 ret
= merge_ctf_fs_traces((struct ctf_fs_trace
**) traces
->pdata
, traces
->len
, &trace
);
1972 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1973 "Failed to merge traces with the same UUID.");
1977 ctf_fs
->trace
= trace
;
1979 /* Just one trace, it may or may not have a UUID, both are fine. */
1980 ctf_fs
->trace
= (ctf_fs_trace
*) traces
->pdata
[0];
1981 traces
->pdata
[0] = NULL
;
1984 ret
= fix_packet_index_tracer_bugs(ctf_fs
->trace
);
1986 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to fix packet index tracer bugs.");
1990 * Sort data stream file groups by first data stream file info
1991 * path to get a deterministic order. This order influences the
1992 * order of the output ports. It also influences the order of
1993 * the automatic stream IDs if the trace's packet headers do not
1994 * contain a `stream_instance_id` field, in which case the data
1995 * stream file to stream ID association is always the same,
1996 * whatever the build and the system.
1998 * Having a deterministic order here can help debugging and
2001 g_ptr_array_sort(ctf_fs
->trace
->ds_file_groups
, compare_ds_file_groups_by_first_path
);
2008 g_ptr_array_free(traces
, TRUE
);
2012 g_ptr_array_free(paths
, TRUE
);
2018 static GString
*get_stream_instance_unique_name(struct ctf_fs_ds_file_group
*ds_file_group
)
2021 struct ctf_fs_ds_file_info
*ds_file_info
;
2023 name
= g_string_new(NULL
);
2029 * If there's more than one stream file in the stream file
2030 * group, the first (earliest) stream file's path is used as
2031 * the stream's unique name.
2033 BT_ASSERT(ds_file_group
->ds_file_infos
->len
> 0);
2034 ds_file_info
= (ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
2035 g_string_assign(name
, ds_file_info
->path
->str
);
2041 /* Create the IR stream objects for ctf_fs_trace. */
2043 static int create_streams_for_trace(struct ctf_fs_trace
*ctf_fs_trace
)
2046 GString
*name
= NULL
;
2049 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
2050 ctf_fs_ds_file_group
*ds_file_group
=
2051 (ctf_fs_ds_file_group
*) g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
2052 name
= get_stream_instance_unique_name(ds_file_group
);
2058 if (ds_file_group
->sc
->ir_sc
) {
2059 BT_ASSERT(ctf_fs_trace
->trace
);
2061 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
2062 /* No stream ID: use 0 */
2063 ds_file_group
->stream
= bt_stream_create_with_id(
2064 ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
, ctf_fs_trace
->next_stream_id
);
2065 ctf_fs_trace
->next_stream_id
++;
2067 /* Specific stream ID */
2068 ds_file_group
->stream
=
2069 bt_stream_create_with_id(ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
,
2070 (uint64_t) ds_file_group
->stream_id
);
2073 ds_file_group
->stream
= NULL
;
2076 if (!ds_file_group
->stream
) {
2077 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
2078 "Cannot create stream for DS file group: "
2079 "addr={}, stream-name=\"{}\"",
2080 fmt::ptr(ds_file_group
), name
->str
);
2084 ret
= bt_stream_set_name(ds_file_group
->stream
, name
->str
);
2086 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
2087 "Cannot set stream's name: "
2088 "addr={}, stream-name=\"{}\"",
2089 fmt::ptr(ds_file_group
->stream
), name
->str
);
2093 g_string_free(name
, TRUE
);
2106 g_string_free(name
, TRUE
);
2111 static const bt_param_validation_value_descr inputs_elem_descr
=
2112 bt_param_validation_value_descr::makeString();
2114 static bt_param_validation_map_value_entry_descr fs_params_entries_descr
[] = {
2115 {"inputs", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
2116 bt_param_validation_value_descr::makeArray(1, BT_PARAM_VALIDATION_INFINITE
,
2117 inputs_elem_descr
)},
2118 {"trace-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2119 bt_param_validation_value_descr::makeString()},
2120 {"clock-class-offset-s", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2121 bt_param_validation_value_descr::makeSignedInteger()},
2122 {"clock-class-offset-ns", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2123 bt_param_validation_value_descr::makeSignedInteger()},
2124 {"force-clock-class-origin-unix-epoch", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2125 bt_param_validation_value_descr::makeBool()},
2126 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
2128 bool read_src_fs_parameters(const bt_value
*params
, const bt_value
**inputs
,
2129 const bt_value
**trace_name
, struct ctf_fs_component
*ctf_fs
)
2132 const bt_value
*value
;
2133 enum bt_param_validation_status validate_value_status
;
2134 gchar
*error
= NULL
;
2136 validate_value_status
= bt_param_validation_validate(params
, fs_params_entries_descr
, &error
);
2137 if (validate_value_status
!= BT_PARAM_VALIDATION_STATUS_OK
) {
2138 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "{}", error
);
2143 /* inputs parameter */
2144 *inputs
= bt_value_map_borrow_entry_value_const(params
, "inputs");
2146 /* clock-class-offset-s parameter */
2147 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-s");
2149 ctf_fs
->metadata_config
.clock_class_offset_s
= bt_value_integer_signed_get(value
);
2152 /* clock-class-offset-ns parameter */
2153 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-ns");
2155 ctf_fs
->metadata_config
.clock_class_offset_ns
= bt_value_integer_signed_get(value
);
2158 /* force-clock-class-origin-unix-epoch parameter */
2159 value
= bt_value_map_borrow_entry_value_const(params
, "force-clock-class-origin-unix-epoch");
2161 ctf_fs
->metadata_config
.force_clock_class_origin_unix_epoch
= bt_value_bool_get(value
);
2164 /* trace-name parameter */
2165 *trace_name
= bt_value_map_borrow_entry_value_const(params
, "trace-name");
2174 static struct ctf_fs_component
*ctf_fs_create(const bt_value
*params
,
2175 bt_self_component_source
*self_comp_src
)
2177 struct ctf_fs_component
*ctf_fs
= NULL
;
2178 const bt_value
*inputs_value
;
2179 const bt_value
*trace_name_value
;
2180 bt_self_component
*self_comp
= bt_self_component_source_as_self_component(self_comp_src
);
2182 ctf_fs
= ctf_fs_component_create(
2183 bt2c::Logger
{bt2::SelfSourceComponent
{self_comp_src
}, "PLUGIN/SRC.CTF.FS/COMP"});
2188 if (!read_src_fs_parameters(params
, &inputs_value
, &trace_name_value
, ctf_fs
)) {
2192 bt_self_component_set_data(self_comp
, ctf_fs
);
2194 if (ctf_fs_component_create_ctf_fs_trace(ctf_fs
, inputs_value
, trace_name_value
, self_comp
)) {
2198 if (create_streams_for_trace(ctf_fs
->trace
)) {
2202 if (create_ports_for_trace(ctf_fs
, ctf_fs
->trace
, self_comp_src
)) {
2209 ctf_fs_destroy(ctf_fs
);
2211 bt_self_component_set_data(self_comp
, NULL
);
2217 bt_component_class_initialize_method_status
ctf_fs_init(bt_self_component_source
*self_comp_src
,
2218 bt_self_component_source_configuration
*,
2219 const bt_value
*params
, void *)
2221 struct ctf_fs_component
*ctf_fs
;
2222 bt_component_class_initialize_method_status ret
=
2223 BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
2225 ctf_fs
= ctf_fs_create(params
, self_comp_src
);
2227 ret
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
2233 bt_component_class_query_method_status
ctf_fs_query(bt_self_component_class_source
*comp_class_src
,
2234 bt_private_query_executor
*priv_query_exec
,
2235 const char *object
, const bt_value
*params
,
2236 __attribute__((unused
)) void *method_data
,
2237 const bt_value
**result
)
2239 bt_component_class_query_method_status status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
2241 bt2c::Logger logger
{bt2::SelfComponentClass
{comp_class_src
},
2242 bt2::PrivateQueryExecutor
{priv_query_exec
}, "PLUGIN/SRC.CTF.FS/QUERY"};
2244 if (strcmp(object
, "metadata-info") == 0) {
2245 status
= metadata_info_query(params
, logger
, result
);
2246 } else if (strcmp(object
, "babeltrace.trace-infos") == 0) {
2247 status
= trace_infos_query(params
, logger
, result
);
2248 } else if (!strcmp(object
, "babeltrace.support-info")) {
2249 status
= support_info_query(params
, logger
, result
);
2251 BT_CPPLOGE_SPEC(logger
, "Unknown query object `{}`", object
);
2252 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;