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
)
104 bt_message_iterator_class_next_method_status status
;
105 struct ctf_fs_msg_iter_data
*msg_iter_data
=
106 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(iterator
);
109 if (G_UNLIKELY(msg_iter_data
->next_saved_error
)) {
111 * Last time we were called, we hit an error but had some
112 * messages to deliver, so we stashed the error here. Return
115 BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(msg_iter_data
->next_saved_error
);
116 status
= msg_iter_data
->next_saved_status
;
121 status
= ctf_fs_iterator_next_one(msg_iter_data
, &msgs
[i
]);
122 if (status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
) {
125 } while (i
< capacity
&& status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
);
129 * Even if ctf_fs_iterator_next_one() returned something
130 * else than BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK, we
131 * accumulated message objects in the output
132 * message array, so we need to return
133 * BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK so that they are
134 * transferred to downstream. This other status occurs
135 * again the next time muxer_msg_iter_do_next() is
136 * called, possibly without any accumulated
137 * message, in which case we'll return it.
141 * Save this error for the next _next call. Assume that
142 * this component always appends error causes when
143 * returning an error status code, which will cause the
144 * current thread error to be non-NULL.
146 msg_iter_data
->next_saved_error
= bt_current_thread_take_error();
147 BT_ASSERT(msg_iter_data
->next_saved_error
);
148 msg_iter_data
->next_saved_status
= status
;
152 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
158 } catch (const std::bad_alloc
&) {
159 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
160 } catch (const bt2::Error
&) {
161 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
165 bt_message_iterator_class_seek_beginning_method_status
166 ctf_fs_iterator_seek_beginning(bt_self_message_iterator
*it
)
169 struct ctf_fs_msg_iter_data
*msg_iter_data
=
170 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(it
);
172 BT_ASSERT(msg_iter_data
);
174 ctf_msg_iter_reset(msg_iter_data
->msg_iter
);
175 ctf_fs_ds_group_medops_data_reset(msg_iter_data
->msg_iter_medops_data
);
177 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_OK
;
178 } catch (const std::bad_alloc
&) {
179 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_MEMORY_ERROR
;
180 } catch (const bt2::Error
&) {
181 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_ERROR
;
185 void ctf_fs_iterator_finalize(bt_self_message_iterator
*it
)
187 ctf_fs_msg_iter_data_destroy(
188 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(it
));
191 static bt_message_iterator_class_initialize_method_status
192 ctf_msg_iter_medium_status_to_msg_iter_initialize_status(enum ctf_msg_iter_medium_status status
)
195 case CTF_MSG_ITER_MEDIUM_STATUS_EOF
:
196 case CTF_MSG_ITER_MEDIUM_STATUS_AGAIN
:
197 case CTF_MSG_ITER_MEDIUM_STATUS_ERROR
:
198 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
199 case CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
:
200 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
201 case CTF_MSG_ITER_MEDIUM_STATUS_OK
:
202 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
208 bt_message_iterator_class_initialize_method_status
209 ctf_fs_iterator_init(bt_self_message_iterator
*self_msg_iter
,
210 bt_self_message_iterator_configuration
*config
,
211 bt_self_component_port_output
*self_port
)
214 struct ctf_fs_port_data
*port_data
;
215 bt_message_iterator_class_initialize_method_status status
;
216 enum ctf_msg_iter_medium_status medium_status
;
218 port_data
= (struct ctf_fs_port_data
*) bt_self_component_port_get_data(
219 bt_self_component_port_output_as_self_component_port(self_port
));
220 BT_ASSERT(port_data
);
222 ctf_fs_msg_iter_data
*msg_iter_data
= new ctf_fs_msg_iter_data
{self_msg_iter
};
223 msg_iter_data
->ds_file_group
= port_data
->ds_file_group
;
225 medium_status
= ctf_fs_ds_group_medops_data_create(msg_iter_data
->ds_file_group
,
226 self_msg_iter
, msg_iter_data
->logger
,
227 &msg_iter_data
->msg_iter_medops_data
);
228 BT_ASSERT(medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_OK
||
229 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_ERROR
||
230 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
);
231 if (medium_status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
232 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
233 "Failed to create ctf_fs_ds_group_medops");
234 status
= ctf_msg_iter_medium_status_to_msg_iter_initialize_status(medium_status
);
238 msg_iter_data
->msg_iter
= ctf_msg_iter_create(
239 msg_iter_data
->ds_file_group
->ctf_fs_trace
->metadata
->tc
,
240 bt_common_get_page_size(static_cast<int>(msg_iter_data
->logger
.level())) * 8,
241 ctf_fs_ds_group_medops
, msg_iter_data
->msg_iter_medops_data
, self_msg_iter
,
242 msg_iter_data
->logger
);
243 if (!msg_iter_data
->msg_iter
) {
244 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
245 "Cannot create a CTF message iterator.");
246 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
251 * This iterator can seek forward if its stream class has a default
254 if (msg_iter_data
->ds_file_group
->sc
->default_clock_class
) {
255 bt_self_message_iterator_configuration_set_can_seek_forward(config
, true);
258 bt_self_message_iterator_set_data(self_msg_iter
, msg_iter_data
);
259 msg_iter_data
= NULL
;
261 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
265 bt_self_message_iterator_set_data(self_msg_iter
, NULL
);
268 ctf_fs_msg_iter_data_destroy(msg_iter_data
);
270 } catch (const std::bad_alloc
&) {
271 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
272 } catch (const bt2::Error
&) {
273 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
277 static void ctf_fs_trace_destroy(struct ctf_fs_trace
*ctf_fs_trace
)
283 if (ctf_fs_trace
->ds_file_groups
) {
284 g_ptr_array_free(ctf_fs_trace
->ds_file_groups
, TRUE
);
287 BT_TRACE_PUT_REF_AND_RESET(ctf_fs_trace
->trace
);
289 if (ctf_fs_trace
->path
) {
290 g_string_free(ctf_fs_trace
->path
, TRUE
);
293 if (ctf_fs_trace
->metadata
) {
294 ctf_fs_metadata_fini(ctf_fs_trace
->metadata
);
295 delete ctf_fs_trace
->metadata
;
301 void ctf_fs_trace_deleter::operator()(ctf_fs_trace
* const trace
) noexcept
303 ctf_fs_trace_destroy(trace
);
306 void ctf_fs_destroy(struct ctf_fs_component
*ctf_fs
)
312 if (ctf_fs
->port_data
) {
313 g_ptr_array_free(ctf_fs
->port_data
, TRUE
);
319 void ctf_fs_component_deleter::operator()(ctf_fs_component
*comp
)
321 ctf_fs_destroy(comp
);
324 static void port_data_destroy(struct ctf_fs_port_data
*port_data
)
333 static void port_data_destroy_notifier(void *data
)
335 port_data_destroy((struct ctf_fs_port_data
*) data
);
338 ctf_fs_component::UP
ctf_fs_component_create(const bt2c::Logger
& parentLogger
)
340 ctf_fs_component::UP ctf_fs
{new ctf_fs_component
{parentLogger
}};
342 ctf_fs
->port_data
= g_ptr_array_new_with_free_func(port_data_destroy_notifier
);
343 if (!ctf_fs
->port_data
) {
356 void ctf_fs_finalize(bt_self_component_source
*component
)
358 ctf_fs_destroy((struct ctf_fs_component
*) bt_self_component_get_data(
359 bt_self_component_source_as_self_component(component
)));
362 bt2c::GCharUP
ctf_fs_make_port_name(struct ctf_fs_ds_file_group
*ds_file_group
)
364 GString
*name
= g_string_new(NULL
);
367 * The unique port name is generated by concatenating unique identifiers
375 /* For the trace, use the uuid if present, else the path. */
376 if (ds_file_group
->ctf_fs_trace
->metadata
->tc
->is_uuid_set
) {
377 char uuid_str
[BT_UUID_STR_LEN
+ 1];
379 bt_uuid_to_str(ds_file_group
->ctf_fs_trace
->metadata
->tc
->uuid
, uuid_str
);
380 g_string_assign(name
, uuid_str
);
382 g_string_assign(name
, ds_file_group
->ctf_fs_trace
->path
->str
);
386 * For the stream class, use the id if present. We can omit this field
387 * otherwise, as there will only be a single stream class.
389 if (ds_file_group
->sc
->id
!= UINT64_C(-1)) {
390 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->sc
->id
);
393 /* For the stream, use the id if present, else, use the path. */
394 if (ds_file_group
->stream_id
!= UINT64_C(-1)) {
395 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->stream_id
);
397 BT_ASSERT(ds_file_group
->ds_file_infos
->len
== 1);
398 struct ctf_fs_ds_file_info
*ds_file_info
=
399 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
400 g_string_append_printf(name
, " | %s", ds_file_info
->path
->str
);
403 return bt2c::GCharUP
{g_string_free(name
, FALSE
)};
406 static int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
407 struct ctf_fs_ds_file_group
*ds_file_group
,
408 bt_self_component_source
*self_comp_src
)
411 struct ctf_fs_port_data
*port_data
= NULL
;
413 bt2c::GCharUP port_name
= ctf_fs_make_port_name(ds_file_group
);
418 BT_CPPLOGI_SPEC(ctf_fs
->logger
, "Creating one port named `{}`", port_name
.get());
420 /* Create output port for this file */
421 port_data
= new ctf_fs_port_data
;
422 port_data
->ctf_fs
= ctf_fs
;
423 port_data
->ds_file_group
= ds_file_group
;
424 ret
= bt_self_component_source_add_output_port(self_comp_src
, port_name
.get(), port_data
, NULL
);
429 g_ptr_array_add(ctf_fs
->port_data
, port_data
);
437 port_data_destroy(port_data
);
441 static int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
442 struct ctf_fs_trace
*ctf_fs_trace
,
443 bt_self_component_source
*self_comp_src
)
448 /* Create one output port for each stream file group */
449 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
450 struct ctf_fs_ds_file_group
*ds_file_group
=
451 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
453 ret
= create_one_port_for_trace(ctf_fs
, ds_file_group
, self_comp_src
);
455 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create output port.");
464 /* Replace by g_ptr_array_insert when we depend on glib >= 2.40. */
465 static void array_insert(GPtrArray
*array
, gpointer element
, size_t pos
)
467 size_t original_array_len
= array
->len
;
469 /* Allocate an unused element at the end of the array. */
470 g_ptr_array_add(array
, NULL
);
472 /* If we are not inserting at the end, move the elements by one. */
473 if (pos
< original_array_len
) {
474 memmove(&(array
->pdata
[pos
+ 1]), &(array
->pdata
[pos
]),
475 (original_array_len
- pos
) * sizeof(gpointer
));
478 /* Insert the value. */
479 array
->pdata
[pos
] = element
;
483 * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right
484 * place to keep it sorted.
487 static void ds_file_group_insert_ds_file_info_sorted(struct ctf_fs_ds_file_group
*ds_file_group
,
488 struct ctf_fs_ds_file_info
*ds_file_info
)
492 /* Find the spot where to insert this ds_file_info. */
493 for (i
= 0; i
< ds_file_group
->ds_file_infos
->len
; i
++) {
494 struct ctf_fs_ds_file_info
*other_ds_file_info
=
495 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, i
);
497 if (ds_file_info
->begin_ns
< other_ds_file_info
->begin_ns
) {
502 array_insert(ds_file_group
->ds_file_infos
, ds_file_info
, i
);
505 static bool ds_index_entries_equal(const struct ctf_fs_ds_index_entry
*left
,
506 const struct ctf_fs_ds_index_entry
*right
)
508 if (left
->packetSize
!= right
->packetSize
) {
512 if (left
->timestamp_begin
!= right
->timestamp_begin
) {
516 if (left
->timestamp_end
!= right
->timestamp_end
) {
520 if (left
->packet_seq_num
!= right
->packet_seq_num
) {
528 * Insert `entry` into `index`, without duplication.
530 * The entry is inserted only if there isn't an identical entry already.
532 * In any case, the ownership of `entry` is transferred to this function. So if
533 * the entry is not inserted, it is freed.
536 static void ds_index_insert_ds_index_entry_sorted(struct ctf_fs_ds_index
*index
,
537 struct ctf_fs_ds_index_entry
*entry
)
540 struct ctf_fs_ds_index_entry
*other_entry
= NULL
;
542 /* Find the spot where to insert this index entry. */
543 for (i
= 0; i
< index
->entries
->len
; i
++) {
544 other_entry
= (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, i
);
546 if (entry
->timestamp_begin_ns
<= other_entry
->timestamp_begin_ns
) {
552 * Insert the entry only if a duplicate doesn't already exist.
554 * There can be duplicate packets if reading multiple overlapping
555 * snapshots of the same trace. We then want the index to contain
556 * a reference to only one copy of that packet.
558 if (i
== index
->entries
->len
|| !ds_index_entries_equal(entry
, other_entry
)) {
559 array_insert(index
->entries
, entry
, i
);
565 static void merge_ctf_fs_ds_indexes(struct ctf_fs_ds_index
*dest
, struct ctf_fs_ds_index
*src
)
569 for (i
= 0; i
< src
->entries
->len
; i
++) {
570 struct ctf_fs_ds_index_entry
*entry
=
571 (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(src
->entries
, i
);
574 * Ownership of the ctf_fs_ds_index_entry is transferred to
575 * ds_index_insert_ds_index_entry_sorted.
577 g_ptr_array_index(src
->entries
, i
) = NULL
;
578 ds_index_insert_ds_index_entry_sorted(dest
, entry
);
582 static int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
, const char *path
)
584 int64_t stream_instance_id
= -1;
585 int64_t begin_ns
= -1;
586 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
587 bool add_group
= false;
590 struct ctf_fs_ds_file
*ds_file
= NULL
;
591 struct ctf_fs_ds_file_info
*ds_file_info
= NULL
;
592 struct ctf_fs_ds_index
*index
= NULL
;
593 struct ctf_msg_iter
*msg_iter
= NULL
;
594 struct ctf_stream_class
*sc
= NULL
;
595 struct ctf_msg_iter_packet_properties props
;
598 * Create a temporary ds_file to read some properties about the data
601 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, path
, ctf_fs_trace
->logger
);
606 /* Create a temporary iterator to read the ds_file. */
607 msg_iter
= ctf_msg_iter_create(
608 ctf_fs_trace
->metadata
->tc
,
609 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
610 ctf_fs_ds_file_medops
, ds_file
, nullptr, ctf_fs_trace
->logger
);
612 BT_CPPLOGE_STR_SPEC(ctf_fs_trace
->logger
, "Cannot create a CTF message iterator.");
616 ctf_msg_iter_set_dry_run(msg_iter
, true);
618 ret
= ctf_msg_iter_get_packet_properties(msg_iter
, &props
);
620 BT_CPPLOGE_APPEND_CAUSE_SPEC(
621 ctf_fs_trace
->logger
,
622 "Cannot get stream file's first packet's header and context fields (`{}`).", path
);
626 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
, props
.stream_class_id
);
628 stream_instance_id
= props
.data_stream_id
;
630 if (props
.snapshots
.beginning_clock
!= UINT64_C(-1)) {
631 BT_ASSERT(sc
->default_clock_class
);
632 ret
= bt_util_clock_cycles_to_ns_from_origin(
633 props
.snapshots
.beginning_clock
, sc
->default_clock_class
->frequency
,
634 sc
->default_clock_class
->offset_seconds
, sc
->default_clock_class
->offset_cycles
,
637 BT_CPPLOGE_APPEND_CAUSE_SPEC(
638 ctf_fs_trace
->logger
,
639 "Cannot convert clock cycles to nanoseconds from origin (`{}`).", path
);
644 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
);
649 index
= ctf_fs_ds_file_build_index(ds_file
, ds_file_info
, msg_iter
);
651 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to index CTF stream file \'{}\'",
652 ds_file
->file
->path
->str
);
656 if (begin_ns
== -1) {
658 * No beginning timestamp to sort the stream files
659 * within a stream file group, so consider that this
660 * file must be the only one within its group.
662 stream_instance_id
= -1;
665 if (stream_instance_id
== -1) {
667 * No stream instance ID or no beginning timestamp:
668 * create a unique stream file group for this stream
669 * file because, even if there's a stream instance ID,
670 * there's no timestamp to order the file within its
673 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, UINT64_C(-1), index
);
674 /* Ownership of index is transferred. */
677 if (!ds_file_group
) {
681 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, BT_MOVE_REF(ds_file_info
));
687 BT_ASSERT(stream_instance_id
!= -1);
688 BT_ASSERT(begin_ns
!= -1);
690 /* Find an existing stream file group with this ID */
691 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
693 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
695 if (ds_file_group
->sc
== sc
&& ds_file_group
->stream_id
== stream_instance_id
) {
699 ds_file_group
= NULL
;
702 if (!ds_file_group
) {
703 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, stream_instance_id
, index
);
704 /* Ownership of index is transferred. */
706 if (!ds_file_group
) {
712 merge_ctf_fs_ds_indexes(ds_file_group
->index
, index
);
715 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, BT_MOVE_REF(ds_file_info
));
720 ctf_fs_ds_file_group_destroy(ds_file_group
);
721 ds_file_group
= NULL
;
725 if (add_group
&& ds_file_group
) {
726 g_ptr_array_add(ctf_fs_trace
->ds_file_groups
, ds_file_group
);
729 ctf_fs_ds_file_destroy(ds_file
);
730 ctf_fs_ds_file_info_destroy(ds_file_info
);
733 ctf_msg_iter_destroy(msg_iter
);
736 ctf_fs_ds_index_destroy(index
);
740 static int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
743 const char *basename
;
744 GError
*error
= NULL
;
747 /* Check each file in the path directory, except specific ones */
748 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
750 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
751 "Cannot open directory `{}`: {} (code {})",
752 ctf_fs_trace
->path
->str
, error
->message
, error
->code
);
756 while ((basename
= g_dir_read_name(dir
))) {
757 struct ctf_fs_file
*file
;
759 if (strcmp(basename
, CTF_FS_METADATA_FILENAME
) == 0) {
760 /* Ignore the metadata stream. */
761 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
762 "Ignoring metadata file `{}" G_DIR_SEPARATOR_S
"{}`",
763 ctf_fs_trace
->path
->str
, basename
);
767 if (basename
[0] == '.') {
768 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
769 "Ignoring hidden file `{}" G_DIR_SEPARATOR_S
"{}`",
770 ctf_fs_trace
->path
->str
, basename
);
774 /* Create the file. */
775 file
= ctf_fs_file_create(ctf_fs_trace
->logger
);
777 BT_CPPLOGE_APPEND_CAUSE_SPEC(
778 ctf_fs_trace
->logger
,
779 "Cannot create stream file object for file `{}" G_DIR_SEPARATOR_S
"{}`",
780 ctf_fs_trace
->path
->str
, basename
);
784 /* Create full path string. */
785 g_string_append_printf(file
->path
, "%s" G_DIR_SEPARATOR_S
"%s", ctf_fs_trace
->path
->str
,
787 if (!g_file_test(file
->path
->str
, G_FILE_TEST_IS_REGULAR
)) {
788 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring non-regular file `{}`",
790 ctf_fs_file_destroy(file
);
795 ret
= ctf_fs_file_open(file
, "rb");
797 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Cannot open stream file `{}`",
802 if (file
->size
== 0) {
803 /* Skip empty stream. */
804 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring empty file `{}`", file
->path
->str
);
805 ctf_fs_file_destroy(file
);
809 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
, file
->path
->str
);
811 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
812 "Cannot add stream file `{}` to stream file group",
814 ctf_fs_file_destroy(file
);
818 ctf_fs_file_destroy(file
);
839 static int set_trace_name(bt_trace
*trace
, const char *name_suffix
, const bt2c::Logger
& logger
)
845 name
= g_string_new(NULL
);
847 BT_CPPLOGE_STR_SPEC(logger
, "Failed to allocate a GString.");
853 * Check if we have a trace environment string value named `hostname`.
854 * If so, use it as the trace name's prefix.
856 val
= bt_trace_borrow_environment_entry_value_by_name_const(trace
, "hostname");
857 if (val
&& bt_value_is_string(val
)) {
858 g_string_append(name
, bt_value_string_get(val
));
861 g_string_append_c(name
, G_DIR_SEPARATOR
);
866 g_string_append(name
, name_suffix
);
869 ret
= bt_trace_set_name(trace
, name
->str
);
878 g_string_free(name
, TRUE
);
884 static ctf_fs_trace::UP
ctf_fs_trace_create(const char *path
, const char *name
,
885 const ctf::src::ClkClsCfg
& clkClsCfg
,
886 bt_self_component
*selfComp
,
887 const bt2c::Logger
& parentLogger
)
891 ctf_fs_trace::UP ctf_fs_trace
{new struct ctf_fs_trace(parentLogger
)};
892 ctf_fs_trace
->path
= g_string_new(path
);
893 if (!ctf_fs_trace
->path
) {
897 ctf_fs_trace
->metadata
= new ctf_fs_metadata
;
898 ctf_fs_metadata_init(ctf_fs_trace
->metadata
);
899 ctf_fs_trace
->ds_file_groups
=
900 g_ptr_array_new_with_free_func((GDestroyNotify
) ctf_fs_ds_file_group_destroy
);
901 if (!ctf_fs_trace
->ds_file_groups
) {
905 ret
= ctf_fs_metadata_set_trace_class(selfComp
, ctf_fs_trace
.get(), clkClsCfg
);
910 if (ctf_fs_trace
->metadata
->trace_class
) {
911 ctf_fs_trace
->trace
= bt_trace_create(ctf_fs_trace
->metadata
->trace_class
);
912 if (!ctf_fs_trace
->trace
) {
917 if (ctf_fs_trace
->trace
) {
918 ret
= ctf_trace_class_configure_ir_trace(ctf_fs_trace
->metadata
->tc
, ctf_fs_trace
->trace
);
923 ret
= set_trace_name(ctf_fs_trace
->trace
, name
, ctf_fs_trace
->logger
);
929 ret
= create_ds_file_groups(ctf_fs_trace
.get());
937 ctf_fs_trace
.reset();
943 static int path_is_ctf_trace(const char *path
)
945 GString
*metadata_path
= g_string_new(NULL
);
948 if (!metadata_path
) {
953 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
955 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
961 g_string_free(metadata_path
, TRUE
);
965 /* Helper for ctf_fs_component_create_ctf_fs_trace, to handle a single path. */
967 static int ctf_fs_component_create_ctf_fs_trace_one_path(struct ctf_fs_component
*ctf_fs
,
968 const char *path_param
,
969 const char *trace_name
,
970 std::vector
<ctf_fs_trace::UP
>& traces
,
971 bt_self_component
*selfComp
)
973 ctf_fs_trace::UP ctf_fs_trace
;
977 norm_path
= bt_common_normalize_path(path_param
, NULL
);
979 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to normalize path: `{}`.", path_param
);
983 ret
= path_is_ctf_trace(norm_path
->str
);
985 BT_CPPLOGE_APPEND_CAUSE_SPEC(
986 ctf_fs
->logger
, "Failed to check if path is a CTF trace: path={}", norm_path
->str
);
988 } else if (ret
== 0) {
989 BT_CPPLOGE_APPEND_CAUSE_SPEC(
990 ctf_fs
->logger
, "Path is not a CTF trace (does not contain a metadata file): `{}`.",
995 // FIXME: Remove or ifdef for __MINGW32__
996 if (strcmp(norm_path
->str
, "/") == 0) {
997 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Opening a trace in `/` is not supported.");
1002 ctf_fs_trace
= ctf_fs_trace_create(norm_path
->str
, trace_name
, ctf_fs
->clkClsCfg
, selfComp
,
1004 if (!ctf_fs_trace
) {
1005 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create trace for `{}`.",
1010 traces
.emplace_back(std::move(ctf_fs_trace
));
1020 g_string_free(norm_path
, TRUE
);
1027 * Count the number of stream and event classes defined by this trace's metadata.
1029 * This is used to determine which metadata is the "latest", out of multiple
1030 * traces sharing the same UUID. It is assumed that amongst all these metadatas,
1031 * a bigger metadata is a superset of a smaller metadata. Therefore, it is
1032 * enough to just count the classes.
1035 static unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace
*trace
)
1037 unsigned int num
= trace
->metadata
->tc
->stream_classes
->len
;
1040 for (i
= 0; i
< trace
->metadata
->tc
->stream_classes
->len
; i
++) {
1041 struct ctf_stream_class
*sc
=
1042 (struct ctf_stream_class
*) trace
->metadata
->tc
->stream_classes
->pdata
[i
];
1043 num
+= sc
->event_classes
->len
;
1050 * Merge the src ds_file_group into dest. This consists of merging their
1051 * ds_file_infos, making sure to keep the result sorted.
1054 static void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group
*dest
,
1055 struct ctf_fs_ds_file_group
*src
)
1059 for (i
= 0; i
< src
->ds_file_infos
->len
; i
++) {
1060 struct ctf_fs_ds_file_info
*ds_file_info
=
1061 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(src
->ds_file_infos
, i
);
1063 /* Ownership of the ds_file_info is transferred to dest. */
1064 g_ptr_array_index(src
->ds_file_infos
, i
) = NULL
;
1066 ds_file_group_insert_ds_file_info_sorted(dest
, ds_file_info
);
1069 /* Merge both indexes. */
1070 merge_ctf_fs_ds_indexes(dest
->index
, src
->index
);
1073 /* Merge src_trace's data stream file groups into dest_trace's. */
1075 static int merge_matching_ctf_fs_ds_file_groups(struct ctf_fs_trace
*dest_trace
,
1076 ctf_fs_trace::UP src_trace
)
1078 GPtrArray
*dest
= dest_trace
->ds_file_groups
;
1079 GPtrArray
*src
= src_trace
->ds_file_groups
;
1084 * Save the initial length of dest: we only want to check against the
1085 * original elements in the inner loop.
1087 const guint dest_len
= dest
->len
;
1089 for (s_i
= 0; s_i
< src
->len
; s_i
++) {
1090 struct ctf_fs_ds_file_group
*src_group
=
1091 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(src
, s_i
);
1092 struct ctf_fs_ds_file_group
*dest_group
= NULL
;
1094 /* A stream instance without ID can't match a stream in the other trace. */
1095 if (src_group
->stream_id
!= -1) {
1098 /* Let's search for a matching ds_file_group in the destination. */
1099 for (d_i
= 0; d_i
< dest_len
; d_i
++) {
1100 struct ctf_fs_ds_file_group
*candidate_dest
=
1101 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(dest
, d_i
);
1103 /* Can't match a stream instance without ID. */
1104 if (candidate_dest
->stream_id
== -1) {
1109 * If the two groups have the same stream instance id
1110 * and belong to the same stream class (stream instance
1111 * ids are per-stream class), they represent the same
1114 if (candidate_dest
->stream_id
!= src_group
->stream_id
||
1115 candidate_dest
->sc
->id
!= src_group
->sc
->id
) {
1119 dest_group
= candidate_dest
;
1125 * Didn't find a friend in dest to merge our src_group into?
1126 * Create a new empty one. This can happen if a stream was
1127 * active in the source trace chunk but not in the destination
1131 struct ctf_stream_class
*sc
;
1132 struct ctf_fs_ds_index
*index
;
1134 sc
= ctf_trace_class_borrow_stream_class_by_id(dest_trace
->metadata
->tc
,
1138 index
= ctf_fs_ds_index_create(dest_trace
->logger
);
1144 dest_group
= ctf_fs_ds_file_group_create(dest_trace
, sc
, src_group
->stream_id
, index
);
1145 /* Ownership of index is transferred. */
1152 g_ptr_array_add(dest_trace
->ds_file_groups
, dest_group
);
1155 BT_ASSERT(dest_group
);
1156 merge_ctf_fs_ds_file_groups(dest_group
, src_group
);
1164 * Collapse the given traces, which must all share the same UUID, in a single
1167 * The trace with the most expansive metadata is chosen and all other traces
1168 * are merged into that one. On return, the elements of `traces` are nullptr
1169 * and the merged trace is placed in `out_trace`.
1172 static int merge_ctf_fs_traces(std::vector
<ctf_fs_trace::UP
> traces
, ctf_fs_trace::UP
& out_trace
)
1174 unsigned int winner_count
;
1175 struct ctf_fs_trace
*winner
;
1179 BT_ASSERT(traces
.size() >= 2);
1181 winner_count
= metadata_count_stream_and_event_classes(traces
[0].get());
1182 winner
= traces
[0].get();
1185 /* Find the trace with the largest metadata. */
1186 for (i
= 1; i
< traces
.size(); i
++) {
1187 ctf_fs_trace
*candidate
= traces
[i
].get();
1188 unsigned int candidate_count
;
1190 /* A bit of sanity check. */
1191 BT_ASSERT(bt_uuid_compare(winner
->metadata
->tc
->uuid
, candidate
->metadata
->tc
->uuid
) == 0);
1193 candidate_count
= metadata_count_stream_and_event_classes(candidate
);
1195 if (candidate_count
> winner_count
) {
1196 winner_count
= candidate_count
;
1202 /* Merge all the other traces in the winning trace. */
1203 for (ctf_fs_trace::UP
& trace
: traces
) {
1204 /* Don't merge the winner into itself. */
1205 if (trace
.get() == winner
) {
1209 /* Merge trace's data stream file groups into winner's. */
1210 ret
= merge_matching_ctf_fs_ds_file_groups(winner
, std::move(trace
));
1217 * Move the winner out of the array, into `*out_trace`.
1219 out_trace
= std::move(traces
[winner_i
]);
1231 static int decode_clock_snapshot_after_event(struct ctf_fs_trace
*ctf_fs_trace
,
1232 struct ctf_clock_class
*default_cc
,
1233 struct ctf_fs_ds_index_entry
*index_entry
,
1234 enum target_event target_event
, uint64_t *cs
,
1237 enum ctf_msg_iter_status iter_status
= CTF_MSG_ITER_STATUS_OK
;
1238 struct ctf_fs_ds_file
*ds_file
= NULL
;
1239 struct ctf_msg_iter
*msg_iter
= NULL
;
1242 BT_ASSERT(ctf_fs_trace
);
1243 BT_ASSERT(index_entry
);
1244 BT_ASSERT(index_entry
->path
);
1246 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, index_entry
->path
, ctf_fs_trace
->logger
);
1248 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to create a ctf_fs_ds_file");
1253 BT_ASSERT(ctf_fs_trace
->metadata
);
1254 BT_ASSERT(ctf_fs_trace
->metadata
->tc
);
1256 msg_iter
= ctf_msg_iter_create(
1257 ctf_fs_trace
->metadata
->tc
,
1258 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
1259 ctf_fs_ds_file_medops
, ds_file
, NULL
, ctf_fs_trace
->logger
);
1261 /* ctf_msg_iter_create() logs errors. */
1267 * Turn on dry run mode to prevent the creation and usage of Babeltrace
1268 * library objects (bt_field, bt_message_*, etc.).
1270 ctf_msg_iter_set_dry_run(msg_iter
, true);
1272 /* Seek to the beginning of the target packet. */
1273 iter_status
= ctf_msg_iter_seek(msg_iter
, index_entry
->offset
.bytes());
1275 /* ctf_msg_iter_seek() logs errors. */
1280 switch (target_event
) {
1283 * Start to decode the packet until we reach the end of
1284 * the first event. To extract the first event's clock
1287 iter_status
= ctf_msg_iter_curr_packet_first_event_clock_snapshot(msg_iter
, cs
);
1290 /* Decode the packet to extract the last event's clock snapshot. */
1291 iter_status
= ctf_msg_iter_curr_packet_last_event_clock_snapshot(msg_iter
, cs
);
1301 /* Convert clock snapshot to timestamp. */
1302 ret
= bt_util_clock_cycles_to_ns_from_origin(
1303 *cs
, default_cc
->frequency
, default_cc
->offset_seconds
, default_cc
->offset_cycles
, ts_ns
);
1305 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1306 "Failed to convert clock snapshot to timestamp");
1312 ctf_fs_ds_file_destroy(ds_file
);
1315 ctf_msg_iter_destroy(msg_iter
);
1321 static int decode_packet_first_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1322 struct ctf_clock_class
*default_cc
,
1323 struct ctf_fs_ds_index_entry
*index_entry
,
1324 uint64_t *cs
, int64_t *ts_ns
)
1326 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, FIRST_EVENT
, cs
,
1330 static int decode_packet_last_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1331 struct ctf_clock_class
*default_cc
,
1332 struct ctf_fs_ds_index_entry
*index_entry
,
1333 uint64_t *cs
, int64_t *ts_ns
)
1335 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, LAST_EVENT
, cs
,
1340 * Fix up packet index entries for lttng's "event-after-packet" bug.
1341 * Some buggy lttng tracer versions may emit events with a timestamp that is
1342 * larger (after) than the timestamp_end of the their packets.
1344 * To fix up this erroneous data we do the following:
1345 * 1. If it's not the stream file's last packet: set the packet index entry's
1346 * end time to the next packet's beginning time.
1347 * 2. If it's the stream file's last packet, set the packet index entry's end
1348 * time to the packet's last event's time, if any, or to the packet's
1349 * beginning time otherwise.
1351 * Known buggy tracer versions:
1352 * - before lttng-ust 2.11.0
1353 * - before lttng-module 2.11.0
1354 * - before lttng-module 2.10.10
1355 * - before lttng-module 2.9.13
1357 static int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace
*trace
)
1360 guint ds_file_group_i
;
1361 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1363 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
; ds_file_group_i
++) {
1365 struct ctf_clock_class
*default_cc
;
1366 struct ctf_fs_ds_index_entry
*last_entry
;
1367 struct ctf_fs_ds_index
*index
;
1369 struct ctf_fs_ds_file_group
*ds_file_group
=
1370 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1372 BT_ASSERT(ds_file_group
);
1373 index
= ds_file_group
->index
;
1376 BT_ASSERT(index
->entries
);
1377 BT_ASSERT(index
->entries
->len
> 0);
1380 * Iterate over all entries but the last one. The last one is
1381 * fixed differently after.
1383 for (entry_i
= 0; entry_i
< index
->entries
->len
- 1; entry_i
++) {
1384 struct ctf_fs_ds_index_entry
*curr_entry
, *next_entry
;
1386 curr_entry
= (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
);
1387 next_entry
= (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
+ 1);
1390 * 1. Set the current index entry `end` timestamp to
1391 * the next index entry `begin` timestamp.
1393 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1394 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1398 * 2. Fix the last entry by decoding the last event of the last
1402 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, index
->entries
->len
- 1);
1403 BT_ASSERT(last_entry
);
1405 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1406 default_cc
= ds_file_group
->sc
->default_clock_class
;
1409 * Decode packet to read the timestamp of the last event of the
1412 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1413 &last_entry
->timestamp_end
,
1414 &last_entry
->timestamp_end_ns
);
1416 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1418 "Failed to decode stream's last packet to get its last event's clock snapshot.");
1428 * Fix up packet index entries for barectf's "event-before-packet" bug.
1429 * Some buggy barectf tracer versions may emit events with a timestamp that is
1430 * less than the timestamp_begin of the their packets.
1432 * To fix up this erroneous data we do the following:
1433 * 1. Starting at the second index entry, set the timestamp_begin of the
1434 * current entry to the timestamp of the first event of the packet.
1435 * 2. Set the previous entry's timestamp_end to the timestamp_begin of the
1438 * Known buggy tracer versions:
1439 * - before barectf 2.3.1
1441 static int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace
*trace
)
1444 guint ds_file_group_i
;
1445 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1447 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
; ds_file_group_i
++) {
1449 struct ctf_clock_class
*default_cc
;
1450 ctf_fs_ds_file_group
*ds_file_group
=
1451 (ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1453 struct ctf_fs_ds_index
*index
= ds_file_group
->index
;
1456 BT_ASSERT(index
->entries
);
1457 BT_ASSERT(index
->entries
->len
> 0);
1459 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1460 default_cc
= ds_file_group
->sc
->default_clock_class
;
1463 * 1. Iterate over the index, starting from the second entry
1466 for (entry_i
= 1; entry_i
< index
->entries
->len
; entry_i
++) {
1467 ctf_fs_ds_index_entry
*prev_entry
=
1468 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
- 1);
1469 ctf_fs_ds_index_entry
*curr_entry
=
1470 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
);
1472 * 2. Set the current entry `begin` timestamp to the
1473 * timestamp of the first event of the current packet.
1475 ret
= decode_packet_first_event_timestamp(trace
, default_cc
, curr_entry
,
1476 &curr_entry
->timestamp_begin
,
1477 &curr_entry
->timestamp_begin_ns
);
1479 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1480 "Failed to decode first event's clock snapshot");
1485 * 3. Set the previous entry `end` timestamp to the
1486 * timestamp of the first event of the current packet.
1488 prev_entry
->timestamp_end
= curr_entry
->timestamp_begin
;
1489 prev_entry
->timestamp_end_ns
= curr_entry
->timestamp_begin_ns
;
1497 * When using the lttng-crash feature it's likely that the last packets of each
1498 * stream have their timestamp_end set to zero. This is caused by the fact that
1499 * the tracer crashed and was not able to properly close the packets.
1501 * To fix up this erroneous data we do the following:
1502 * For each index entry, if the entry's timestamp_end is 0 and the
1503 * timestamp_begin is not 0:
1504 * - If it's the stream file's last packet: set the packet index entry's end
1505 * time to the packet's last event's time, if any, or to the packet's
1506 * beginning time otherwise.
1507 * - If it's not the stream file's last packet: set the packet index
1508 * entry's end time to the next packet's beginning time.
1510 * Affected versions:
1511 * - All current and future lttng-ust and lttng-modules versions.
1513 static int fix_index_lttng_crash_quirk(struct ctf_fs_trace
*trace
)
1516 guint ds_file_group_idx
;
1517 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1519 for (ds_file_group_idx
= 0; ds_file_group_idx
< ds_file_groups
->len
; ds_file_group_idx
++) {
1521 struct ctf_clock_class
*default_cc
;
1522 struct ctf_fs_ds_index
*index
;
1524 ctf_fs_ds_file_group
*ds_file_group
=
1525 (ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_idx
);
1527 BT_ASSERT(ds_file_group
);
1528 index
= ds_file_group
->index
;
1530 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1531 default_cc
= ds_file_group
->sc
->default_clock_class
;
1534 BT_ASSERT(index
->entries
);
1535 BT_ASSERT(index
->entries
->len
> 0);
1537 ctf_fs_ds_index_entry
*last_entry
=
1538 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, index
->entries
->len
- 1);
1539 BT_ASSERT(last_entry
);
1541 /* 1. Fix the last entry first. */
1542 if (last_entry
->timestamp_end
== 0 && last_entry
->timestamp_begin
!= 0) {
1544 * Decode packet to read the timestamp of the
1545 * last event of the stream file.
1547 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1548 &last_entry
->timestamp_end
,
1549 &last_entry
->timestamp_end_ns
);
1551 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1552 "Failed to decode last event's clock snapshot");
1557 /* Iterate over all entries but the last one. */
1558 for (entry_idx
= 0; entry_idx
< index
->entries
->len
- 1; entry_idx
++) {
1559 ctf_fs_ds_index_entry
*curr_entry
=
1560 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_idx
);
1561 ctf_fs_ds_index_entry
*next_entry
=
1562 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_idx
+ 1);
1564 if (curr_entry
->timestamp_end
== 0 && curr_entry
->timestamp_begin
!= 0) {
1566 * 2. Set the current index entry `end` timestamp to
1567 * the next index entry `begin` timestamp.
1569 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1570 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1580 * Extract the tracer information necessary to compare versions.
1581 * Returns 0 on success, and -1 if the extraction is not successful because the
1582 * necessary fields are absents in the trace metadata.
1584 static int extract_tracer_info(struct ctf_fs_trace
*trace
, struct tracer_info
*current_tracer_info
)
1587 struct ctf_trace_class_env_entry
*entry
;
1589 /* Clear the current_tracer_info struct */
1590 memset(current_tracer_info
, 0, sizeof(*current_tracer_info
));
1593 * To compare 2 tracer versions, at least the tracer name and it's
1594 * major version are needed. If one of these is missing, consider it an
1595 * extraction failure.
1597 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_name");
1598 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR
) {
1599 goto missing_bare_minimum
;
1602 /* Set tracer name. */
1603 current_tracer_info
->name
= entry
->value
.str
->str
;
1605 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_major");
1606 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1607 goto missing_bare_minimum
;
1610 /* Set major version number. */
1611 current_tracer_info
->major
= entry
->value
.i
;
1613 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_minor");
1614 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1618 /* Set minor version number. */
1619 current_tracer_info
->minor
= entry
->value
.i
;
1621 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patch");
1624 * If `tracer_patch` doesn't exist `tracer_patchlevel` might.
1625 * For example, `lttng-modules` uses entry name
1626 * `tracer_patchlevel`.
1628 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patchlevel");
1631 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1635 /* Set patch version number. */
1636 current_tracer_info
->patch
= entry
->value
.i
;
1640 missing_bare_minimum
:
1646 static bool is_tracer_affected_by_lttng_event_after_packet_bug(struct tracer_info
*curr_tracer_info
)
1648 bool is_affected
= false;
1650 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1651 if (curr_tracer_info
->major
< 2) {
1653 } else if (curr_tracer_info
->major
== 2) {
1654 /* fixed in lttng-ust 2.11.0 */
1655 if (curr_tracer_info
->minor
< 11) {
1659 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1660 if (curr_tracer_info
->major
< 2) {
1662 } else if (curr_tracer_info
->major
== 2) {
1663 /* fixed in lttng-modules 2.11.0 */
1664 if (curr_tracer_info
->minor
== 10) {
1665 /* fixed in lttng-modules 2.10.10 */
1666 if (curr_tracer_info
->patch
< 10) {
1669 } else if (curr_tracer_info
->minor
== 9) {
1670 /* fixed in lttng-modules 2.9.13 */
1671 if (curr_tracer_info
->patch
< 13) {
1674 } else if (curr_tracer_info
->minor
< 9) {
1684 is_tracer_affected_by_barectf_event_before_packet_bug(struct tracer_info
*curr_tracer_info
)
1686 bool is_affected
= false;
1688 if (strcmp(curr_tracer_info
->name
, "barectf") == 0) {
1689 if (curr_tracer_info
->major
< 2) {
1691 } else if (curr_tracer_info
->major
== 2) {
1692 if (curr_tracer_info
->minor
< 3) {
1694 } else if (curr_tracer_info
->minor
== 3) {
1695 /* fixed in barectf 2.3.1 */
1696 if (curr_tracer_info
->patch
< 1) {
1706 static bool is_tracer_affected_by_lttng_crash_quirk(struct tracer_info
*curr_tracer_info
)
1708 bool is_affected
= false;
1710 /* All LTTng tracer may be affected by this lttng crash quirk. */
1711 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1713 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1721 * Looks for trace produced by known buggy tracers and fix up the index
1724 static int fix_packet_index_tracer_bugs(ctf_fs_trace
*trace
)
1727 struct tracer_info current_tracer_info
;
1729 ret
= extract_tracer_info(trace
, ¤t_tracer_info
);
1732 * A trace may not have all the necessary environment
1733 * entries to do the tracer version comparison.
1734 * At least, the tracer name and major version number
1735 * are needed. Failing to extract these entries is not
1739 BT_CPPLOGI_STR_SPEC(
1741 "Cannot extract tracer information necessary to compare with buggy versions.");
1745 /* Check if the trace may be affected by old tracer bugs. */
1746 if (is_tracer_affected_by_lttng_event_after_packet_bug(¤t_tracer_info
)) {
1747 BT_CPPLOGI_STR_SPEC(
1749 "Trace may be affected by LTTng tracer packet timestamp bug. Fixing up.");
1750 ret
= fix_index_lttng_event_after_packet_bug(trace
);
1752 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1753 "Failed to fix LTTng event-after-packet bug.");
1756 trace
->metadata
->tc
->quirks
.lttng_event_after_packet
= true;
1759 if (is_tracer_affected_by_barectf_event_before_packet_bug(¤t_tracer_info
)) {
1760 BT_CPPLOGI_STR_SPEC(
1762 "Trace may be affected by barectf tracer packet timestamp bug. Fixing up.");
1763 ret
= fix_index_barectf_event_before_packet_bug(trace
);
1765 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1766 "Failed to fix barectf event-before-packet bug.");
1769 trace
->metadata
->tc
->quirks
.barectf_event_before_packet
= true;
1772 if (is_tracer_affected_by_lttng_crash_quirk(¤t_tracer_info
)) {
1773 ret
= fix_index_lttng_crash_quirk(trace
);
1775 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1776 "Failed to fix lttng-crash timestamp quirks.");
1779 trace
->metadata
->tc
->quirks
.lttng_crash
= true;
1786 static gint
compare_ds_file_groups_by_first_path(gconstpointer a
, gconstpointer b
)
1788 ctf_fs_ds_file_group
* const *ds_file_group_a
= (ctf_fs_ds_file_group
**) a
;
1789 ctf_fs_ds_file_group
* const *ds_file_group_b
= (ctf_fs_ds_file_group
**) b
;
1791 BT_ASSERT((*ds_file_group_a
)->ds_file_infos
->len
> 0);
1792 BT_ASSERT((*ds_file_group_b
)->ds_file_infos
->len
> 0);
1794 const ctf_fs_ds_file_info
*first_ds_file_info_a
=
1795 (const ctf_fs_ds_file_info
*) (*ds_file_group_a
)->ds_file_infos
->pdata
[0];
1796 const ctf_fs_ds_file_info
*first_ds_file_info_b
=
1797 (const ctf_fs_ds_file_info
*) (*ds_file_group_b
)->ds_file_infos
->pdata
[0];
1799 return strcmp(first_ds_file_info_a
->path
->str
, first_ds_file_info_b
->path
->str
);
1802 static gint
compare_strings(gconstpointer p_a
, gconstpointer p_b
)
1804 const char *a
= *((const char **) p_a
);
1805 const char *b
= *((const char **) p_b
);
1807 return strcmp(a
, b
);
1810 int ctf_fs_component_create_ctf_fs_trace(struct ctf_fs_component
*ctf_fs
,
1811 const bt_value
*paths_value
,
1812 const bt_value
*trace_name_value
,
1813 bt_self_component
*selfComp
)
1817 GPtrArray
*paths
= NULL
;
1818 std::vector
<ctf_fs_trace::UP
> traces
;
1819 const char *trace_name
;
1821 BT_ASSERT(bt_value_get_type(paths_value
) == BT_VALUE_TYPE_ARRAY
);
1822 BT_ASSERT(!bt_value_array_is_empty(paths_value
));
1824 paths
= g_ptr_array_new_with_free_func(g_free
);
1826 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to allocate a GPtrArray.");
1830 trace_name
= trace_name_value
? bt_value_string_get(trace_name_value
) : NULL
;
1833 * Create a sorted array of the paths, to make the execution of this
1834 * component deterministic.
1836 for (i
= 0; i
< bt_value_array_get_length(paths_value
); i
++) {
1837 const bt_value
*path_value
= bt_value_array_borrow_element_by_index_const(paths_value
, i
);
1838 const char *input
= bt_value_string_get(path_value
);
1841 input_copy
= g_strdup(input
);
1843 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to copy a string.");
1847 g_ptr_array_add(paths
, input_copy
);
1850 g_ptr_array_sort(paths
, compare_strings
);
1852 /* Create a separate ctf_fs_trace object for each path. */
1853 for (i
= 0; i
< paths
->len
; i
++) {
1854 const char *path
= (const char *) g_ptr_array_index(paths
, i
);
1856 ret
= ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs
, path
, trace_name
, traces
,
1863 if (traces
.size() > 1) {
1864 ctf_fs_trace
*first_trace
= traces
[0].get();
1865 const uint8_t *first_trace_uuid
= first_trace
->metadata
->tc
->uuid
;
1868 * We have more than one trace, they must all share the same
1869 * UUID, verify that.
1871 for (i
= 0; i
< traces
.size(); i
++) {
1872 ctf_fs_trace
*this_trace
= traces
[i
].get();
1873 const uint8_t *this_trace_uuid
= this_trace
->metadata
->tc
->uuid
;
1875 if (!this_trace
->metadata
->tc
->is_uuid_set
) {
1876 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1878 "Multiple traces given, but a trace does not have a UUID: path={}",
1879 this_trace
->path
->str
);
1883 if (bt_uuid_compare(first_trace_uuid
, this_trace_uuid
) != 0) {
1884 char first_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1885 char this_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1887 bt_uuid_to_str(first_trace_uuid
, first_trace_uuid_str
);
1888 bt_uuid_to_str(this_trace_uuid
, this_trace_uuid_str
);
1890 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1891 "Multiple traces given, but UUIDs don't match: "
1892 "first-trace-uuid={}, first-trace-path={}, "
1893 "trace-uuid={}, trace-path={}",
1894 first_trace_uuid_str
, first_trace
->path
->str
,
1895 this_trace_uuid_str
, this_trace
->path
->str
);
1900 ret
= merge_ctf_fs_traces(std::move(traces
), ctf_fs
->trace
);
1902 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1903 "Failed to merge traces with the same UUID.");
1907 /* Just one trace, it may or may not have a UUID, both are fine. */
1908 ctf_fs
->trace
= std::move(traces
[0]);
1911 ret
= fix_packet_index_tracer_bugs(ctf_fs
->trace
.get());
1913 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to fix packet index tracer bugs.");
1917 * Sort data stream file groups by first data stream file info
1918 * path to get a deterministic order. This order influences the
1919 * order of the output ports. It also influences the order of
1920 * the automatic stream IDs if the trace's packet headers do not
1921 * contain a `stream_instance_id` field, in which case the data
1922 * stream file to stream ID association is always the same,
1923 * whatever the build and the system.
1925 * Having a deterministic order here can help debugging and
1928 g_ptr_array_sort(ctf_fs
->trace
->ds_file_groups
, compare_ds_file_groups_by_first_path
);
1935 g_ptr_array_free(paths
, TRUE
);
1941 static GString
*get_stream_instance_unique_name(struct ctf_fs_ds_file_group
*ds_file_group
)
1944 struct ctf_fs_ds_file_info
*ds_file_info
;
1946 name
= g_string_new(NULL
);
1952 * If there's more than one stream file in the stream file
1953 * group, the first (earliest) stream file's path is used as
1954 * the stream's unique name.
1956 BT_ASSERT(ds_file_group
->ds_file_infos
->len
> 0);
1957 ds_file_info
= (ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
1958 g_string_assign(name
, ds_file_info
->path
->str
);
1964 /* Create the IR stream objects for ctf_fs_trace. */
1966 static int create_streams_for_trace(struct ctf_fs_trace
*ctf_fs_trace
)
1969 GString
*name
= NULL
;
1972 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
1973 ctf_fs_ds_file_group
*ds_file_group
=
1974 (ctf_fs_ds_file_group
*) g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
1975 name
= get_stream_instance_unique_name(ds_file_group
);
1981 BT_ASSERT(ds_file_group
->sc
->ir_sc
);
1982 BT_ASSERT(ctf_fs_trace
->trace
);
1984 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
1985 /* No stream ID: use 0 */
1986 ds_file_group
->stream
= bt_stream_create_with_id(
1987 ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
, ctf_fs_trace
->next_stream_id
);
1988 ctf_fs_trace
->next_stream_id
++;
1990 /* Specific stream ID */
1991 ds_file_group
->stream
= bt_stream_create_with_id(
1992 ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
, (uint64_t) ds_file_group
->stream_id
);
1995 if (!ds_file_group
->stream
) {
1996 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1997 "Cannot create stream for DS file group: "
1998 "addr={}, stream-name=\"{}\"",
1999 fmt::ptr(ds_file_group
), name
->str
);
2003 ret
= bt_stream_set_name(ds_file_group
->stream
, name
->str
);
2005 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
2006 "Cannot set stream's name: "
2007 "addr={}, stream-name=\"{}\"",
2008 fmt::ptr(ds_file_group
->stream
), name
->str
);
2012 g_string_free(name
, TRUE
);
2025 g_string_free(name
, TRUE
);
2030 static const bt_param_validation_value_descr inputs_elem_descr
=
2031 bt_param_validation_value_descr::makeString();
2033 static bt_param_validation_map_value_entry_descr fs_params_entries_descr
[] = {
2034 {"inputs", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
2035 bt_param_validation_value_descr::makeArray(1, BT_PARAM_VALIDATION_INFINITE
,
2036 inputs_elem_descr
)},
2037 {"trace-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2038 bt_param_validation_value_descr::makeString()},
2039 {"clock-class-offset-s", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2040 bt_param_validation_value_descr::makeSignedInteger()},
2041 {"clock-class-offset-ns", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2042 bt_param_validation_value_descr::makeSignedInteger()},
2043 {"force-clock-class-origin-unix-epoch", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2044 bt_param_validation_value_descr::makeBool()},
2045 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
2047 bool read_src_fs_parameters(const bt_value
*params
, const bt_value
**inputs
,
2048 const bt_value
**trace_name
, struct ctf_fs_component
*ctf_fs
)
2051 const bt_value
*value
;
2052 enum bt_param_validation_status validate_value_status
;
2053 gchar
*error
= NULL
;
2055 validate_value_status
= bt_param_validation_validate(params
, fs_params_entries_descr
, &error
);
2056 if (validate_value_status
!= BT_PARAM_VALIDATION_STATUS_OK
) {
2057 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "{}", error
);
2062 /* inputs parameter */
2063 *inputs
= bt_value_map_borrow_entry_value_const(params
, "inputs");
2065 /* clock-class-offset-s parameter */
2066 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-s");
2068 ctf_fs
->clkClsCfg
.offsetSec
= bt_value_integer_signed_get(value
);
2071 /* clock-class-offset-ns parameter */
2072 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-ns");
2074 ctf_fs
->clkClsCfg
.offsetNanoSec
= bt_value_integer_signed_get(value
);
2077 /* force-clock-class-origin-unix-epoch parameter */
2078 value
= bt_value_map_borrow_entry_value_const(params
, "force-clock-class-origin-unix-epoch");
2080 ctf_fs
->clkClsCfg
.forceOriginIsUnixEpoch
= bt_value_bool_get(value
);
2083 /* trace-name parameter */
2084 *trace_name
= bt_value_map_borrow_entry_value_const(params
, "trace-name");
2093 static ctf_fs_component::UP
ctf_fs_create(const bt_value
*params
,
2094 bt_self_component_source
*self_comp_src
)
2096 const bt_value
*inputs_value
;
2097 const bt_value
*trace_name_value
;
2098 bt_self_component
*self_comp
= bt_self_component_source_as_self_component(self_comp_src
);
2100 ctf_fs_component::UP ctf_fs
= ctf_fs_component_create(
2101 bt2c::Logger
{bt2::SelfSourceComponent
{self_comp_src
}, "PLUGIN/SRC.CTF.FS/COMP"});
2106 if (!read_src_fs_parameters(params
, &inputs_value
, &trace_name_value
, ctf_fs
.get())) {
2110 if (ctf_fs_component_create_ctf_fs_trace(ctf_fs
.get(), inputs_value
, trace_name_value
,
2115 if (create_streams_for_trace(ctf_fs
->trace
.get())) {
2119 if (create_ports_for_trace(ctf_fs
.get(), ctf_fs
->trace
.get(), self_comp_src
)) {
2126 bt_component_class_initialize_method_status
ctf_fs_init(bt_self_component_source
*self_comp_src
,
2127 bt_self_component_source_configuration
*,
2128 const bt_value
*params
, void *)
2131 bt_component_class_initialize_method_status ret
=
2132 BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
2134 ctf_fs_component::UP ctf_fs
= ctf_fs_create(params
, self_comp_src
);
2136 ret
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
2139 bt_self_component_set_data(bt_self_component_source_as_self_component(self_comp_src
),
2142 } catch (const std::bad_alloc
&) {
2143 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
2144 } catch (const bt2::Error
&) {
2145 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
2149 bt_component_class_query_method_status
ctf_fs_query(bt_self_component_class_source
*comp_class_src
,
2150 bt_private_query_executor
*priv_query_exec
,
2151 const char *object
, const bt_value
*params
,
2152 __attribute__((unused
)) void *method_data
,
2153 const bt_value
**result
)
2156 bt2c::Logger logger
{bt2::SelfComponentClass
{comp_class_src
},
2157 bt2::PrivateQueryExecutor
{priv_query_exec
},
2158 "PLUGIN/SRC.CTF.FS/QUERY"};
2159 bt2::ConstMapValue
paramsObj(params
);
2160 bt2::Value::Shared resultObj
;
2162 if (strcmp(object
, "metadata-info") == 0) {
2163 resultObj
= metadata_info_query(paramsObj
, logger
);
2164 } else if (strcmp(object
, "babeltrace.trace-infos") == 0) {
2165 resultObj
= trace_infos_query(paramsObj
, logger
);
2166 } else if (!strcmp(object
, "babeltrace.support-info")) {
2167 resultObj
= support_info_query(paramsObj
, logger
);
2169 BT_CPPLOGE_SPEC(logger
, "Unknown query object `{}`", object
);
2170 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;
2173 *result
= resultObj
.release().libObjPtr();
2175 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
2176 } catch (const std::bad_alloc
&) {
2177 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
2178 } catch (const bt2::Error
&) {
2179 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;