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
10 #define BT_CLOG_CFG logCfg
11 #define BT_LOG_TAG "PLUGIN/SRC.CTF.FS"
13 #include "common/common.h"
14 #include <babeltrace2/babeltrace.h>
15 #include "common/uuid.h"
17 #include "common/assert.h"
21 #include "metadata.hpp"
22 #include "data-stream-file.hpp"
24 #include "../common/src/metadata/tsdl/decoder.hpp"
25 #include "../common/src/metadata/tsdl/ctf-meta-configure-ir-trace.hpp"
26 #include "../common/src/msg-iter/msg-iter.hpp"
28 #include "plugins/common/param-validation/param-validation.h"
29 #include "cpp-common/cfg-logging.hpp"
30 #include "cpp-common/cfg-logging-error-reporting.hpp"
31 #include "cpp-common/exc.hpp"
32 #include "cpp-common/make-unique.hpp"
43 static void ctf_fs_msg_iter_data_destroy(struct ctf_fs_msg_iter_data
*msg_iter_data
)
49 if (msg_iter_data
->msg_iter
) {
50 ctf_msg_iter_destroy(msg_iter_data
->msg_iter
);
53 if (msg_iter_data
->msg_iter_medops_data
) {
54 ctf_fs_ds_group_medops_data_destroy(msg_iter_data
->msg_iter_medops_data
);
60 static bt_message_iterator_class_next_method_status
61 ctf_fs_iterator_next_one(struct ctf_fs_msg_iter_data
*msg_iter_data
, const bt_message
**out_msg
)
63 bt_message_iterator_class_next_method_status status
;
64 enum ctf_msg_iter_status msg_iter_status
;
65 const bt2_common::LogCfg
& logCfg
= msg_iter_data
->logCfg
;
67 msg_iter_status
= ctf_msg_iter_get_next_message(msg_iter_data
->msg_iter
, out_msg
);
69 switch (msg_iter_status
) {
70 case CTF_MSG_ITER_STATUS_OK
:
71 /* Cool, message has been written to *out_msg. */
72 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
75 case CTF_MSG_ITER_STATUS_EOF
:
76 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END
;
79 case CTF_MSG_ITER_STATUS_AGAIN
:
81 * Should not make it this far as this is
82 * medium-specific; there is nothing for the user to do
83 * and it should have been handled upstream.
87 case CTF_MSG_ITER_STATUS_ERROR
:
88 BT_CLOGE_APPEND_CAUSE("Failed to get next message from CTF message iterator.");
89 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
92 case CTF_MSG_ITER_STATUS_MEMORY_ERROR
:
93 BT_CLOGE_APPEND_CAUSE("Failed to get next message from CTF message iterator.");
94 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
105 bt_message_iterator_class_next_method_status
106 ctf_fs_iterator_next(bt_self_message_iterator
*iterator
, bt_message_array_const msgs
,
107 uint64_t capacity
, uint64_t *count
)
109 struct ctf_fs_msg_iter_data
*msg_iter_data
=
110 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(iterator
);
111 const bt2_common::LogCfg
& logCfg
= msg_iter_data
->logCfg
;
114 bt_message_iterator_class_next_method_status status
;
117 if (G_UNLIKELY(msg_iter_data
->next_saved_error
)) {
119 * Last time we were called, we hit an error but had some
120 * messages to deliver, so we stashed the error here. Return
123 BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(msg_iter_data
->next_saved_error
);
124 status
= msg_iter_data
->next_saved_status
;
129 status
= ctf_fs_iterator_next_one(msg_iter_data
, &msgs
[i
]);
130 if (status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
) {
133 } while (i
< capacity
&& status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
);
137 * Even if ctf_fs_iterator_next_one() returned something
138 * else than BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK, we
139 * accumulated message objects in the output
140 * message array, so we need to return
141 * BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK so that they are
142 * transfered to downstream. This other status occurs
143 * again the next time muxer_msg_iter_do_next() is
144 * called, possibly without any accumulated
145 * message, in which case we'll return it.
149 * Save this error for the next _next call. Assume that
150 * this component always appends error causes when
151 * returning an error status code, which will cause the
152 * current thread error to be non-NULL.
154 msg_iter_data
->next_saved_error
= bt_current_thread_take_error();
155 BT_ASSERT(msg_iter_data
->next_saved_error
);
156 msg_iter_data
->next_saved_status
= status
;
160 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
165 } catch (const std::bad_alloc
&) {
166 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
167 } catch (const bt2_common::Error
&) {
168 BT_CLOGE_APPEND_CAUSE("Failed to fetch next messages");
169 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
174 bt_message_iterator_class_seek_beginning_method_status
175 ctf_fs_iterator_seek_beginning(bt_self_message_iterator
*it
)
177 struct ctf_fs_msg_iter_data
*msg_iter_data
=
178 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(it
);
180 BT_ASSERT(msg_iter_data
);
182 const bt2_common::LogCfg
& logCfg
= msg_iter_data
->logCfg
;
185 ctf_msg_iter_reset(msg_iter_data
->msg_iter
);
186 ctf_fs_ds_group_medops_data_reset(msg_iter_data
->msg_iter_medops_data
);
188 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_OK
;
189 } catch (const std::bad_alloc
&) {
190 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_MEMORY_ERROR
;
191 } catch (const bt2_common::Error
&) {
192 BT_CLOGE_APPEND_CAUSE("Failed to seek beginning");
193 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_ERROR
;
198 void ctf_fs_iterator_finalize(bt_self_message_iterator
*it
)
200 ctf_fs_msg_iter_data_destroy(
201 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(it
));
204 static bt_message_iterator_class_initialize_method_status
205 ctf_msg_iter_medium_status_to_msg_iter_initialize_status(enum ctf_msg_iter_medium_status status
)
208 case CTF_MSG_ITER_MEDIUM_STATUS_EOF
:
209 case CTF_MSG_ITER_MEDIUM_STATUS_AGAIN
:
210 case CTF_MSG_ITER_MEDIUM_STATUS_ERROR
:
211 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
212 case CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
:
213 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
214 case CTF_MSG_ITER_MEDIUM_STATUS_OK
:
215 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
222 bt_message_iterator_class_initialize_method_status
223 ctf_fs_iterator_init(bt_self_message_iterator
*self_msg_iter
,
224 bt_self_message_iterator_configuration
*config
,
225 bt_self_component_port_output
*self_port
)
227 bt_self_component_port
*self_comp_port
=
228 bt_self_component_port_output_as_self_component_port(self_port
);
229 ctf_fs_port_data
*port_data
=
230 (ctf_fs_port_data
*) bt_self_component_port_get_data(self_comp_port
);
231 BT_ASSERT(port_data
);
233 bt2_common::LogCfg logCfg
{port_data
->ctf_fs
->logCfg
.logLevel(), *self_msg_iter
};
236 bt_message_iterator_class_initialize_method_status status
;
237 enum ctf_msg_iter_medium_status medium_status
;
239 ctf_fs_msg_iter_data
*msg_iter_data
= new ctf_fs_msg_iter_data
{logCfg
};
241 msg_iter_data
->self_msg_iter
= self_msg_iter
;
242 msg_iter_data
->ds_file_group
= port_data
->ds_file_group
;
245 ctf_fs_ds_group_medops_data_create(msg_iter_data
->ds_file_group
, self_msg_iter
, logCfg
,
246 &msg_iter_data
->msg_iter_medops_data
);
247 BT_ASSERT(medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_OK
||
248 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_ERROR
||
249 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
);
250 if (medium_status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
251 BT_CLOGE_APPEND_CAUSE("Failed to create ctf_fs_ds_group_medops");
252 status
= ctf_msg_iter_medium_status_to_msg_iter_initialize_status(medium_status
);
256 msg_iter_data
->msg_iter
= ctf_msg_iter_create(
257 msg_iter_data
->ds_file_group
->ctf_fs_trace
->metadata
->tc
,
258 bt_common_get_page_size(logCfg
.logLevel()) * 8, ctf_fs_ds_group_medops
,
259 msg_iter_data
->msg_iter_medops_data
, self_msg_iter
, logCfg
);
260 if (!msg_iter_data
->msg_iter
) {
261 BT_CLOGE_APPEND_CAUSE("Cannot create a CTF message iterator.");
262 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
267 * This iterator can seek forward if its stream class has a default
270 if (msg_iter_data
->ds_file_group
->sc
->default_clock_class
) {
271 bt_self_message_iterator_configuration_set_can_seek_forward(config
, true);
274 bt_self_message_iterator_set_data(self_msg_iter
, msg_iter_data
);
275 msg_iter_data
= NULL
;
277 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
281 bt_self_message_iterator_set_data(self_msg_iter
, NULL
);
284 ctf_fs_msg_iter_data_destroy(msg_iter_data
);
286 } catch (const std::bad_alloc
&) {
287 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
288 } catch (const bt2_common::Error
&) {
289 BT_CLOGE_APPEND_CAUSE("Failed to initialize iterator");
290 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
294 static void ctf_fs_trace_destroy(struct ctf_fs_trace
*ctf_fs_trace
)
300 if (ctf_fs_trace
->ds_file_groups
) {
301 g_ptr_array_free(ctf_fs_trace
->ds_file_groups
, TRUE
);
304 BT_TRACE_PUT_REF_AND_RESET(ctf_fs_trace
->trace
);
306 if (ctf_fs_trace
->path
) {
307 g_string_free(ctf_fs_trace
->path
, TRUE
);
310 if (ctf_fs_trace
->metadata
) {
311 ctf_fs_metadata_fini(ctf_fs_trace
->metadata
);
312 delete ctf_fs_trace
->metadata
;
318 void ctf_fs_trace_deleter::operator()(ctf_fs_trace
*trace
)
320 ctf_fs_trace_destroy(trace
);
324 void ctf_fs_destroy(struct ctf_fs_component
*ctf_fs
)
333 void ctf_fs_component_deleter::operator()(ctf_fs_component
*comp
)
335 ctf_fs_destroy(comp
);
338 ctf_fs_component::UP
ctf_fs_component_create(const bt2_common::LogCfg
& logCfg
)
340 return ctf_fs_component::UP
{new ctf_fs_component
{logCfg
}};
343 void ctf_fs_finalize(bt_self_component_source
*component
)
345 ctf_fs_destroy((struct ctf_fs_component
*) bt_self_component_get_data(
346 bt_self_component_source_as_self_component(component
)));
349 bt2_common::GCharUP
ctf_fs_make_port_name(struct ctf_fs_ds_file_group
*ds_file_group
)
351 GString
*name
= g_string_new(NULL
);
354 * The unique port name is generated by concatenating unique identifiers
362 /* For the trace, use the uuid if present, else the path. */
363 if (ds_file_group
->ctf_fs_trace
->metadata
->tc
->is_uuid_set
) {
364 char uuid_str
[BT_UUID_STR_LEN
+ 1];
366 bt_uuid_to_str(ds_file_group
->ctf_fs_trace
->metadata
->tc
->uuid
, uuid_str
);
367 g_string_assign(name
, uuid_str
);
369 g_string_assign(name
, ds_file_group
->ctf_fs_trace
->path
->str
);
373 * For the stream class, use the id if present. We can omit this field
374 * otherwise, as there will only be a single stream class.
376 if (ds_file_group
->sc
->id
!= UINT64_C(-1)) {
377 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->sc
->id
);
380 /* For the stream, use the id if present, else, use the path. */
381 if (ds_file_group
->stream_id
!= UINT64_C(-1)) {
382 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->stream_id
);
384 BT_ASSERT(ds_file_group
->ds_file_infos
->len
== 1);
385 struct ctf_fs_ds_file_info
*ds_file_info
=
386 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
387 g_string_append_printf(name
, " | %s", ds_file_info
->path
->str
);
390 return bt2_common::GCharUP
{g_string_free(name
, FALSE
)};
393 static int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
394 struct ctf_fs_trace
*ctf_fs_trace
,
395 struct ctf_fs_ds_file_group
*ds_file_group
,
396 bt_self_component_source
*self_comp_src
)
399 ctf_fs_port_data::UP port_data
;
400 const bt2_common::LogCfg
& logCfg
= ctf_fs
->logCfg
;
402 bt2_common::GCharUP port_name
= ctf_fs_make_port_name(ds_file_group
);
407 BT_CLOGI("Creating one port named `%s`", port_name
.get());
409 /* Create output port for this file */
410 port_data
= bt2_common::makeUnique
<ctf_fs_port_data
>();
411 port_data
->ctf_fs
= ctf_fs
;
412 port_data
->ds_file_group
= ds_file_group
;
413 ret
= bt_self_component_source_add_output_port(self_comp_src
, port_name
.get(), port_data
.get(),
419 ctf_fs
->port_data
.emplace_back(std::move(port_data
));
429 static int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
430 struct ctf_fs_trace
*ctf_fs_trace
,
431 bt_self_component_source
*self_comp_src
)
435 const bt2_common::LogCfg
& logCfg
= ctf_fs
->logCfg
;
437 /* Create one output port for each stream file group */
438 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
439 struct ctf_fs_ds_file_group
*ds_file_group
=
440 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
442 ret
= create_one_port_for_trace(ctf_fs
, ctf_fs_trace
, ds_file_group
, self_comp_src
);
444 BT_CLOGE_APPEND_CAUSE("Cannot create output port.");
453 /* Replace by g_ptr_array_insert when we depend on glib >= 2.40. */
454 static void array_insert(GPtrArray
*array
, gpointer element
, size_t pos
)
456 size_t original_array_len
= array
->len
;
458 /* Allocate an unused element at the end of the array. */
459 g_ptr_array_add(array
, NULL
);
461 /* If we are not inserting at the end, move the elements by one. */
462 if (pos
< original_array_len
) {
463 memmove(&(array
->pdata
[pos
+ 1]), &(array
->pdata
[pos
]),
464 (original_array_len
- pos
) * sizeof(gpointer
));
467 /* Insert the value. */
468 array
->pdata
[pos
] = element
;
472 * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right
473 * place to keep it sorted.
476 static void ds_file_group_insert_ds_file_info_sorted(struct ctf_fs_ds_file_group
*ds_file_group
,
477 struct ctf_fs_ds_file_info
*ds_file_info
)
481 /* Find the spot where to insert this ds_file_info. */
482 for (i
= 0; i
< ds_file_group
->ds_file_infos
->len
; i
++) {
483 struct ctf_fs_ds_file_info
*other_ds_file_info
=
484 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, i
);
486 if (ds_file_info
->begin_ns
< other_ds_file_info
->begin_ns
) {
491 array_insert(ds_file_group
->ds_file_infos
, ds_file_info
, i
);
494 static bool ds_index_entries_equal(const struct ctf_fs_ds_index_entry
*left
,
495 const struct ctf_fs_ds_index_entry
*right
)
497 if (left
->packetSize
!= right
->packetSize
) {
501 if (left
->timestamp_begin
!= right
->timestamp_begin
) {
505 if (left
->timestamp_end
!= right
->timestamp_end
) {
509 if (left
->packet_seq_num
!= right
->packet_seq_num
) {
517 * Insert `entry` into `index`, without duplication.
519 * The entry is inserted only if there isn't an identical entry already.
521 * In any case, the ownership of `entry` is transferred to this function. So if
522 * the entry is not inserted, it is freed.
525 static void ds_index_insert_ds_index_entry_sorted(struct ctf_fs_ds_index
*index
,
526 struct ctf_fs_ds_index_entry
*entry
)
529 struct ctf_fs_ds_index_entry
*other_entry
= NULL
;
531 /* Find the spot where to insert this index entry. */
532 for (i
= 0; i
< index
->entries
->len
; i
++) {
533 other_entry
= (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, i
);
535 if (entry
->timestamp_begin_ns
<= other_entry
->timestamp_begin_ns
) {
541 * Insert the entry only if a duplicate doesn't already exist.
543 * There can be duplicate packets if reading multiple overlapping
544 * snapshots of the same trace. We then want the index to contain
545 * a reference to only one copy of that packet.
547 if (i
== index
->entries
->len
|| !ds_index_entries_equal(entry
, other_entry
)) {
548 array_insert(index
->entries
, entry
, i
);
554 static void merge_ctf_fs_ds_indexes(struct ctf_fs_ds_index
*dest
, struct ctf_fs_ds_index
*src
)
558 for (i
= 0; i
< src
->entries
->len
; i
++) {
559 struct ctf_fs_ds_index_entry
*entry
=
560 (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(src
->entries
, i
);
563 * Ownership of the ctf_fs_ds_index_entry is transferred to
564 * ds_index_insert_ds_index_entry_sorted.
566 g_ptr_array_index(src
->entries
, i
) = NULL
;
567 ds_index_insert_ds_index_entry_sorted(dest
, entry
);
571 static int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
, const char *path
)
573 int64_t stream_instance_id
= -1;
574 int64_t begin_ns
= -1;
575 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
576 bool add_group
= false;
579 struct ctf_fs_ds_file
*ds_file
= NULL
;
580 struct ctf_fs_ds_file_info
*ds_file_info
= NULL
;
581 struct ctf_fs_ds_index
*index
= NULL
;
582 struct ctf_msg_iter
*msg_iter
= NULL
;
583 struct ctf_stream_class
*sc
= NULL
;
584 struct ctf_msg_iter_packet_properties props
;
585 const bt2_common::LogCfg
& logCfg
= ctf_fs_trace
->logCfg
;
588 * Create a temporary ds_file to read some properties about the data
591 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, path
, logCfg
);
596 /* Create a temporary iterator to read the ds_file. */
597 msg_iter
= ctf_msg_iter_create(ctf_fs_trace
->metadata
->tc
,
598 bt_common_get_page_size(logCfg
.logLevel()) * 8,
599 ctf_fs_ds_file_medops
, ds_file
, nullptr, logCfg
);
601 BT_CLOGE_STR("Cannot create a CTF message iterator.");
605 ctf_msg_iter_set_dry_run(msg_iter
, true);
607 ret
= ctf_msg_iter_get_packet_properties(msg_iter
, &props
);
609 BT_CLOGE_APPEND_CAUSE(
610 "Cannot get stream file's first packet's header and context fields (`%s`).", path
);
614 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
, props
.stream_class_id
);
616 stream_instance_id
= props
.data_stream_id
;
618 if (props
.snapshots
.beginning_clock
!= UINT64_C(-1)) {
619 BT_ASSERT(sc
->default_clock_class
);
620 ret
= bt_util_clock_cycles_to_ns_from_origin(
621 props
.snapshots
.beginning_clock
, sc
->default_clock_class
->frequency
,
622 sc
->default_clock_class
->offset_seconds
, sc
->default_clock_class
->offset_cycles
,
625 BT_CLOGE_APPEND_CAUSE("Cannot convert clock cycles to nanoseconds from origin (`%s`).",
631 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
);
636 index
= ctf_fs_ds_file_build_index(ds_file
, ds_file_info
, msg_iter
);
638 BT_CLOGE_APPEND_CAUSE("Failed to index CTF stream file \'%s\'", ds_file
->file
->path
->str
);
642 if (begin_ns
== -1) {
644 * No beginning timestamp to sort the stream files
645 * within a stream file group, so consider that this
646 * file must be the only one within its group.
648 stream_instance_id
= -1;
651 if (stream_instance_id
== -1) {
653 * No stream instance ID or no beginning timestamp:
654 * create a unique stream file group for this stream
655 * file because, even if there's a stream instance ID,
656 * there's no timestamp to order the file within its
659 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, UINT64_C(-1), index
);
660 /* Ownership of index is transferred. */
663 if (!ds_file_group
) {
667 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, BT_MOVE_REF(ds_file_info
));
673 BT_ASSERT(stream_instance_id
!= -1);
674 BT_ASSERT(begin_ns
!= -1);
676 /* Find an existing stream file group with this ID */
677 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
679 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
681 if (ds_file_group
->sc
== sc
&& ds_file_group
->stream_id
== stream_instance_id
) {
685 ds_file_group
= NULL
;
688 if (!ds_file_group
) {
689 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, stream_instance_id
, index
);
690 /* Ownership of index is transferred. */
692 if (!ds_file_group
) {
698 merge_ctf_fs_ds_indexes(ds_file_group
->index
, index
);
701 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, BT_MOVE_REF(ds_file_info
));
706 ctf_fs_ds_file_group_destroy(ds_file_group
);
707 ds_file_group
= NULL
;
711 if (add_group
&& ds_file_group
) {
712 g_ptr_array_add(ctf_fs_trace
->ds_file_groups
, ds_file_group
);
715 ctf_fs_ds_file_destroy(ds_file
);
716 ctf_fs_ds_file_info_destroy(ds_file_info
);
719 ctf_msg_iter_destroy(msg_iter
);
722 ctf_fs_ds_index_destroy(index
);
726 static int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
729 const char *basename
;
730 GError
*error
= NULL
;
732 const bt2_common::LogCfg
& logCfg
= ctf_fs_trace
->logCfg
;
734 /* Check each file in the path directory, except specific ones */
735 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
737 BT_CLOGE_APPEND_CAUSE("Cannot open directory `%s`: %s (code %d)", ctf_fs_trace
->path
->str
,
738 error
->message
, error
->code
);
742 while ((basename
= g_dir_read_name(dir
))) {
743 struct ctf_fs_file
*file
;
745 if (strcmp(basename
, CTF_FS_METADATA_FILENAME
) == 0) {
746 /* Ignore the metadata stream. */
747 BT_CLOGI("Ignoring metadata file `%s" G_DIR_SEPARATOR_S
"%s`", ctf_fs_trace
->path
->str
,
752 if (basename
[0] == '.') {
753 BT_CLOGI("Ignoring hidden file `%s" G_DIR_SEPARATOR_S
"%s`", ctf_fs_trace
->path
->str
,
758 /* Create the file. */
759 file
= ctf_fs_file_create(logCfg
);
761 BT_CLOGE_APPEND_CAUSE("Cannot create stream file object for file `%s" G_DIR_SEPARATOR_S
763 ctf_fs_trace
->path
->str
, basename
);
767 /* Create full path string. */
768 g_string_append_printf(file
->path
, "%s" G_DIR_SEPARATOR_S
"%s", ctf_fs_trace
->path
->str
,
770 if (!g_file_test(file
->path
->str
, G_FILE_TEST_IS_REGULAR
)) {
771 BT_CLOGI("Ignoring non-regular file `%s`", file
->path
->str
);
772 ctf_fs_file_destroy(file
);
777 ret
= ctf_fs_file_open(file
, "rb");
779 BT_CLOGE_APPEND_CAUSE("Cannot open stream file `%s`", file
->path
->str
);
783 if (file
->size
== 0) {
784 /* Skip empty stream. */
785 BT_CLOGI("Ignoring empty file `%s`", file
->path
->str
);
786 ctf_fs_file_destroy(file
);
790 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
, file
->path
->str
);
792 BT_CLOGE_APPEND_CAUSE("Cannot add stream file `%s` to stream file group",
794 ctf_fs_file_destroy(file
);
798 ctf_fs_file_destroy(file
);
819 static int set_trace_name(bt_trace
*trace
, const char *name_suffix
,
820 const bt2_common::LogCfg
& logCfg
)
826 name
= g_string_new(NULL
);
828 BT_CLOGE_STR("Failed to allocate a GString.");
834 * Check if we have a trace environment string value named `hostname`.
835 * If so, use it as the trace name's prefix.
837 val
= bt_trace_borrow_environment_entry_value_by_name_const(trace
, "hostname");
838 if (val
&& bt_value_is_string(val
)) {
839 g_string_append(name
, bt_value_string_get(val
));
842 g_string_append_c(name
, G_DIR_SEPARATOR
);
847 g_string_append(name
, name_suffix
);
850 ret
= bt_trace_set_name(trace
, name
->str
);
859 g_string_free(name
, TRUE
);
865 static ctf_fs_trace::UP
ctf_fs_trace_create(const char *path
, const char *name
,
866 ctf::src::ClkClsCfg clkClsCfg
,
867 bt_self_component
*selfComp
,
868 const bt2_common::LogCfg
& logCfg
)
872 ctf_fs_trace::UP ctf_fs_trace
{new struct ctf_fs_trace(logCfg
)};
873 ctf_fs_trace
->path
= g_string_new(path
);
874 if (!ctf_fs_trace
->path
) {
878 ctf_fs_trace
->metadata
= new ctf_fs_metadata
;
879 ctf_fs_metadata_init(ctf_fs_trace
->metadata
);
880 ctf_fs_trace
->ds_file_groups
=
881 g_ptr_array_new_with_free_func((GDestroyNotify
) ctf_fs_ds_file_group_destroy
);
882 if (!ctf_fs_trace
->ds_file_groups
) {
886 ret
= ctf_fs_metadata_set_trace_class(ctf_fs_trace
.get(), clkClsCfg
, selfComp
, logCfg
);
891 if (ctf_fs_trace
->metadata
->trace_class
) {
892 ctf_fs_trace
->trace
= bt_trace_create(ctf_fs_trace
->metadata
->trace_class
);
893 if (!ctf_fs_trace
->trace
) {
898 if (ctf_fs_trace
->trace
) {
899 ret
= ctf_trace_class_configure_ir_trace(ctf_fs_trace
->metadata
->tc
, ctf_fs_trace
->trace
);
904 ret
= set_trace_name(ctf_fs_trace
->trace
, name
, logCfg
);
910 ret
= create_ds_file_groups(ctf_fs_trace
.get());
918 ctf_fs_trace
.reset();
924 static int path_is_ctf_trace(const char *path
)
926 GString
*metadata_path
= g_string_new(NULL
);
929 if (!metadata_path
) {
934 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
936 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
942 g_string_free(metadata_path
, TRUE
);
946 /* Helper for ctf_fs_component_create_ctf_fs_trace, to handle a single path. */
948 static int ctf_fs_component_create_ctf_fs_trace_one_path(struct ctf_fs_component
*ctf_fs
,
949 const char *path_param
,
950 const char *trace_name
,
951 std::vector
<ctf_fs_trace::UP
>& traces
,
952 bt_self_component
*selfComp
)
954 ctf_fs_trace::UP ctf_fs_trace
;
957 const bt2_common::LogCfg
& logCfg
= ctf_fs
->logCfg
;
959 norm_path
= bt_common_normalize_path(path_param
, NULL
);
961 BT_CLOGE_APPEND_CAUSE("Failed to normalize path: `%s`.", path_param
);
965 ret
= path_is_ctf_trace(norm_path
->str
);
967 BT_CLOGE_APPEND_CAUSE("Failed to check if path is a CTF trace: path=%s", norm_path
->str
);
969 } else if (ret
== 0) {
970 BT_CLOGE_APPEND_CAUSE("Path is not a CTF trace (does not contain a metadata file): `%s`.",
975 // FIXME: Remove or ifdef for __MINGW32__
976 if (strcmp(norm_path
->str
, "/") == 0) {
977 BT_CLOGE_APPEND_CAUSE("Opening a trace in `/` is not supported.");
983 ctf_fs_trace_create(norm_path
->str
, trace_name
, ctf_fs
->clkClsCfg
, selfComp
, logCfg
);
985 BT_CLOGE_APPEND_CAUSE("Cannot create trace for `%s`.", norm_path
->str
);
989 traces
.emplace_back(std::move(ctf_fs_trace
));
999 g_string_free(norm_path
, TRUE
);
1006 * Count the number of stream and event classes defined by this trace's metadata.
1008 * This is used to determine which metadata is the "latest", out of multiple
1009 * traces sharing the same UUID. It is assumed that amongst all these metadatas,
1010 * a bigger metadata is a superset of a smaller metadata. Therefore, it is
1011 * enough to just count the classes.
1014 static unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace
*trace
)
1016 unsigned int num
= trace
->metadata
->tc
->stream_classes
->len
;
1019 for (i
= 0; i
< trace
->metadata
->tc
->stream_classes
->len
; i
++) {
1020 struct ctf_stream_class
*sc
=
1021 (struct ctf_stream_class
*) trace
->metadata
->tc
->stream_classes
->pdata
[i
];
1022 num
+= sc
->event_classes
->len
;
1029 * Merge the src ds_file_group into dest. This consists of merging their
1030 * ds_file_infos, making sure to keep the result sorted.
1033 static void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group
*dest
,
1034 struct ctf_fs_ds_file_group
*src
)
1038 for (i
= 0; i
< src
->ds_file_infos
->len
; i
++) {
1039 struct ctf_fs_ds_file_info
*ds_file_info
=
1040 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(src
->ds_file_infos
, i
);
1042 /* Ownership of the ds_file_info is transferred to dest. */
1043 g_ptr_array_index(src
->ds_file_infos
, i
) = NULL
;
1045 ds_file_group_insert_ds_file_info_sorted(dest
, ds_file_info
);
1048 /* Merge both indexes. */
1049 merge_ctf_fs_ds_indexes(dest
->index
, src
->index
);
1052 /* Merge src_trace's data stream file groups into dest_trace's. */
1054 static int merge_matching_ctf_fs_ds_file_groups(struct ctf_fs_trace
*dest_trace
,
1055 ctf_fs_trace::UP src_trace
)
1057 GPtrArray
*dest
= dest_trace
->ds_file_groups
;
1058 GPtrArray
*src
= src_trace
->ds_file_groups
;
1063 * Save the initial length of dest: we only want to check against the
1064 * original elements in the inner loop.
1066 const guint dest_len
= dest
->len
;
1068 for (s_i
= 0; s_i
< src
->len
; s_i
++) {
1069 struct ctf_fs_ds_file_group
*src_group
=
1070 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(src
, s_i
);
1071 struct ctf_fs_ds_file_group
*dest_group
= NULL
;
1073 /* A stream instance without ID can't match a stream in the other trace. */
1074 if (src_group
->stream_id
!= -1) {
1077 /* Let's search for a matching ds_file_group in the destination. */
1078 for (d_i
= 0; d_i
< dest_len
; d_i
++) {
1079 struct ctf_fs_ds_file_group
*candidate_dest
=
1080 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(dest
, d_i
);
1082 /* Can't match a stream instance without ID. */
1083 if (candidate_dest
->stream_id
== -1) {
1088 * If the two groups have the same stream instance id
1089 * and belong to the same stream class (stream instance
1090 * ids are per-stream class), they represent the same
1093 if (candidate_dest
->stream_id
!= src_group
->stream_id
||
1094 candidate_dest
->sc
->id
!= src_group
->sc
->id
) {
1098 dest_group
= candidate_dest
;
1104 * Didn't find a friend in dest to merge our src_group into?
1105 * Create a new empty one. This can happen if a stream was
1106 * active in the source trace chunk but not in the destination
1110 struct ctf_stream_class
*sc
;
1111 struct ctf_fs_ds_index
*index
;
1113 sc
= ctf_trace_class_borrow_stream_class_by_id(dest_trace
->metadata
->tc
,
1117 index
= ctf_fs_ds_index_create(dest_trace
->logCfg
);
1123 dest_group
= ctf_fs_ds_file_group_create(dest_trace
, sc
, src_group
->stream_id
, index
);
1124 /* Ownership of index is transferred. */
1131 g_ptr_array_add(dest_trace
->ds_file_groups
, dest_group
);
1134 BT_ASSERT(dest_group
);
1135 merge_ctf_fs_ds_file_groups(dest_group
, src_group
);
1143 * Collapse the given traces, which must all share the same UUID, in a single
1146 * The trace with the most expansive metadata is chosen and all other traces
1147 * are merged into that one. On return, the elements of `traces` are nullptr
1148 * and the merged trace is placed in `out_trace`.
1151 static int merge_ctf_fs_traces(std::vector
<ctf_fs_trace::UP
> traces
, ctf_fs_trace::UP
& out_trace
)
1153 unsigned int winner_count
;
1154 struct ctf_fs_trace
*winner
;
1158 BT_ASSERT(traces
.size() >= 2);
1160 winner_count
= metadata_count_stream_and_event_classes(traces
[0].get());
1161 winner
= traces
[0].get();
1164 /* Find the trace with the largest metadata. */
1165 for (i
= 1; i
< traces
.size(); i
++) {
1166 ctf_fs_trace
*candidate
= traces
[i
].get();
1167 unsigned int candidate_count
;
1169 /* A bit of sanity check. */
1170 BT_ASSERT(bt_uuid_compare(winner
->metadata
->tc
->uuid
, candidate
->metadata
->tc
->uuid
) == 0);
1172 candidate_count
= metadata_count_stream_and_event_classes(candidate
);
1174 if (candidate_count
> winner_count
) {
1175 winner_count
= candidate_count
;
1181 /* Merge all the other traces in the winning trace. */
1182 for (ctf_fs_trace::UP
& trace
: traces
) {
1183 /* Don't merge the winner into itself. */
1184 if (trace
.get() == winner
) {
1188 /* Merge trace's data stream file groups into winner's. */
1189 ret
= merge_matching_ctf_fs_ds_file_groups(winner
, std::move(trace
));
1196 * Move the winner out of the array, into `*out_trace`.
1198 out_trace
= std::move(traces
[winner_i
]);
1210 static int decode_clock_snapshot_after_event(struct ctf_fs_trace
*ctf_fs_trace
,
1211 struct ctf_clock_class
*default_cc
,
1212 struct ctf_fs_ds_index_entry
*index_entry
,
1213 enum target_event target_event
, uint64_t *cs
,
1216 enum ctf_msg_iter_status iter_status
= CTF_MSG_ITER_STATUS_OK
;
1217 struct ctf_fs_ds_file
*ds_file
= NULL
;
1218 struct ctf_msg_iter
*msg_iter
= NULL
;
1219 const bt2_common::LogCfg
& logCfg
= ctf_fs_trace
->logCfg
;
1222 BT_ASSERT(ctf_fs_trace
);
1223 BT_ASSERT(index_entry
);
1224 BT_ASSERT(index_entry
->path
);
1226 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, index_entry
->path
, logCfg
);
1228 BT_CLOGE_APPEND_CAUSE("Failed to create a ctf_fs_ds_file");
1233 BT_ASSERT(ctf_fs_trace
->metadata
);
1234 BT_ASSERT(ctf_fs_trace
->metadata
->tc
);
1236 msg_iter
= ctf_msg_iter_create(ctf_fs_trace
->metadata
->tc
,
1237 bt_common_get_page_size(logCfg
.logLevel()) * 8,
1238 ctf_fs_ds_file_medops
, ds_file
, NULL
, logCfg
);
1240 /* ctf_msg_iter_create() logs errors. */
1246 * Turn on dry run mode to prevent the creation and usage of Babeltrace
1247 * library objects (bt_field, bt_message_*, etc.).
1249 ctf_msg_iter_set_dry_run(msg_iter
, true);
1251 /* Seek to the beginning of the target packet. */
1252 iter_status
= ctf_msg_iter_seek(msg_iter
, index_entry
->offset
.bytes());
1254 /* ctf_msg_iter_seek() logs errors. */
1259 switch (target_event
) {
1262 * Start to decode the packet until we reach the end of
1263 * the first event. To extract the first event's clock
1266 iter_status
= ctf_msg_iter_curr_packet_first_event_clock_snapshot(msg_iter
, cs
);
1269 /* Decode the packet to extract the last event's clock snapshot. */
1270 iter_status
= ctf_msg_iter_curr_packet_last_event_clock_snapshot(msg_iter
, cs
);
1280 /* Convert clock snapshot to timestamp. */
1281 ret
= bt_util_clock_cycles_to_ns_from_origin(
1282 *cs
, default_cc
->frequency
, default_cc
->offset_seconds
, default_cc
->offset_cycles
, ts_ns
);
1284 BT_CLOGE_APPEND_CAUSE("Failed to convert clock snapshot to timestamp");
1290 ctf_fs_ds_file_destroy(ds_file
);
1293 ctf_msg_iter_destroy(msg_iter
);
1299 static int decode_packet_first_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1300 struct ctf_clock_class
*default_cc
,
1301 struct ctf_fs_ds_index_entry
*index_entry
,
1302 uint64_t *cs
, int64_t *ts_ns
)
1304 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, FIRST_EVENT
, cs
,
1308 static int decode_packet_last_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1309 struct ctf_clock_class
*default_cc
,
1310 struct ctf_fs_ds_index_entry
*index_entry
,
1311 uint64_t *cs
, int64_t *ts_ns
)
1313 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, LAST_EVENT
, cs
,
1318 * Fix up packet index entries for lttng's "event-after-packet" bug.
1319 * Some buggy lttng tracer versions may emit events with a timestamp that is
1320 * larger (after) than the timestamp_end of the their packets.
1322 * To fix up this erroneous data we do the following:
1323 * 1. If it's not the stream file's last packet: set the packet index entry's
1324 * end time to the next packet's beginning time.
1325 * 2. If it's the stream file's last packet, set the packet index entry's end
1326 * time to the packet's last event's time, if any, or to the packet's
1327 * beginning time otherwise.
1329 * Known buggy tracer versions:
1330 * - before lttng-ust 2.11.0
1331 * - before lttng-module 2.11.0
1332 * - before lttng-module 2.10.10
1333 * - before lttng-module 2.9.13
1335 static int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace
*trace
)
1338 guint ds_file_group_i
;
1339 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1340 const bt2_common::LogCfg
& logCfg
= trace
->logCfg
;
1342 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
; ds_file_group_i
++) {
1344 struct ctf_clock_class
*default_cc
;
1345 struct ctf_fs_ds_index_entry
*last_entry
;
1346 struct ctf_fs_ds_index
*index
;
1348 struct ctf_fs_ds_file_group
*ds_file_group
=
1349 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1351 BT_ASSERT(ds_file_group
);
1352 index
= ds_file_group
->index
;
1355 BT_ASSERT(index
->entries
);
1356 BT_ASSERT(index
->entries
->len
> 0);
1359 * Iterate over all entries but the last one. The last one is
1360 * fixed differently after.
1362 for (entry_i
= 0; entry_i
< index
->entries
->len
- 1; entry_i
++) {
1363 struct ctf_fs_ds_index_entry
*curr_entry
, *next_entry
;
1365 curr_entry
= (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
);
1366 next_entry
= (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
+ 1);
1369 * 1. Set the current index entry `end` timestamp to
1370 * the next index entry `begin` timestamp.
1372 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1373 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1377 * 2. Fix the last entry by decoding the last event of the last
1381 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, index
->entries
->len
- 1);
1382 BT_ASSERT(last_entry
);
1384 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1385 default_cc
= ds_file_group
->sc
->default_clock_class
;
1388 * Decode packet to read the timestamp of the last event of the
1391 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1392 &last_entry
->timestamp_end
,
1393 &last_entry
->timestamp_end_ns
);
1395 BT_CLOGE_APPEND_CAUSE(
1396 "Failed to decode stream's last packet to get its last event's clock snapshot.");
1406 * Fix up packet index entries for barectf's "event-before-packet" bug.
1407 * Some buggy barectf tracer versions may emit events with a timestamp that is
1408 * less than the timestamp_begin of the their packets.
1410 * To fix up this erroneous data we do the following:
1411 * 1. Starting at the second index entry, set the timestamp_begin of the
1412 * current entry to the timestamp of the first event of the packet.
1413 * 2. Set the previous entry's timestamp_end to the timestamp_begin of the
1416 * Known buggy tracer versions:
1417 * - before barectf 2.3.1
1419 static int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace
*trace
)
1422 guint ds_file_group_i
;
1423 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1424 const bt2_common::LogCfg
& logCfg
= trace
->logCfg
;
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 ctf_fs_ds_file_group
*ds_file_group
=
1430 (ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1432 struct ctf_fs_ds_index
*index
= ds_file_group
->index
;
1435 BT_ASSERT(index
->entries
);
1436 BT_ASSERT(index
->entries
->len
> 0);
1438 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1439 default_cc
= ds_file_group
->sc
->default_clock_class
;
1442 * 1. Iterate over the index, starting from the second entry
1445 for (entry_i
= 1; entry_i
< index
->entries
->len
; entry_i
++) {
1446 ctf_fs_ds_index_entry
*prev_entry
=
1447 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
- 1);
1448 ctf_fs_ds_index_entry
*curr_entry
=
1449 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
);
1451 * 2. Set the current entry `begin` timestamp to the
1452 * timestamp of the first event of the current packet.
1454 ret
= decode_packet_first_event_timestamp(trace
, default_cc
, curr_entry
,
1455 &curr_entry
->timestamp_begin
,
1456 &curr_entry
->timestamp_begin_ns
);
1458 BT_CLOGE_APPEND_CAUSE("Failed to decode first event's clock snapshot");
1463 * 3. Set the previous entry `end` timestamp to the
1464 * timestamp of the first event of the current packet.
1466 prev_entry
->timestamp_end
= curr_entry
->timestamp_begin
;
1467 prev_entry
->timestamp_end_ns
= curr_entry
->timestamp_begin_ns
;
1475 * When using the lttng-crash feature it's likely that the last packets of each
1476 * stream have their timestamp_end set to zero. This is caused by the fact that
1477 * the tracer crashed and was not able to properly close the packets.
1479 * To fix up this erroneous data we do the following:
1480 * For each index entry, if the entry's timestamp_end is 0 and the
1481 * timestamp_begin is not 0:
1482 * - If it's the stream file's last packet: set the packet index entry's end
1483 * time to the packet's last event's time, if any, or to the packet's
1484 * beginning time otherwise.
1485 * - If it's not the stream file's last packet: set the packet index
1486 * entry's end time to the next packet's beginning time.
1488 * Affected versions:
1489 * - All current and future lttng-ust and lttng-modules versions.
1491 static int fix_index_lttng_crash_quirk(struct ctf_fs_trace
*trace
)
1494 guint ds_file_group_idx
;
1495 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1496 const bt2_common::LogCfg
& logCfg
= trace
->logCfg
;
1498 for (ds_file_group_idx
= 0; ds_file_group_idx
< ds_file_groups
->len
; ds_file_group_idx
++) {
1500 struct ctf_clock_class
*default_cc
;
1501 struct ctf_fs_ds_index
*index
;
1503 ctf_fs_ds_file_group
*ds_file_group
=
1504 (ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_idx
);
1506 BT_ASSERT(ds_file_group
);
1507 index
= ds_file_group
->index
;
1509 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1510 default_cc
= ds_file_group
->sc
->default_clock_class
;
1513 BT_ASSERT(index
->entries
);
1514 BT_ASSERT(index
->entries
->len
> 0);
1516 ctf_fs_ds_index_entry
*last_entry
=
1517 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, index
->entries
->len
- 1);
1518 BT_ASSERT(last_entry
);
1520 /* 1. Fix the last entry first. */
1521 if (last_entry
->timestamp_end
== 0 && last_entry
->timestamp_begin
!= 0) {
1523 * Decode packet to read the timestamp of the
1524 * last event of the stream file.
1526 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1527 &last_entry
->timestamp_end
,
1528 &last_entry
->timestamp_end_ns
);
1530 BT_CLOGE_APPEND_CAUSE("Failed to decode last event's clock snapshot");
1535 /* Iterate over all entries but the last one. */
1536 for (entry_idx
= 0; entry_idx
< index
->entries
->len
- 1; entry_idx
++) {
1537 ctf_fs_ds_index_entry
*curr_entry
=
1538 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_idx
);
1539 ctf_fs_ds_index_entry
*next_entry
=
1540 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_idx
+ 1);
1542 if (curr_entry
->timestamp_end
== 0 && curr_entry
->timestamp_begin
!= 0) {
1544 * 2. Set the current index entry `end` timestamp to
1545 * the next index entry `begin` timestamp.
1547 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1548 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1558 * Extract the tracer information necessary to compare versions.
1559 * Returns 0 on success, and -1 if the extraction is not successful because the
1560 * necessary fields are absents in the trace metadata.
1562 static int extract_tracer_info(struct ctf_fs_trace
*trace
, struct tracer_info
*current_tracer_info
)
1565 struct ctf_trace_class_env_entry
*entry
;
1567 /* Clear the current_tracer_info struct */
1568 memset(current_tracer_info
, 0, sizeof(*current_tracer_info
));
1571 * To compare 2 tracer versions, at least the tracer name and it's
1572 * major version are needed. If one of these is missing, consider it an
1573 * extraction failure.
1575 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_name");
1576 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR
) {
1577 goto missing_bare_minimum
;
1580 /* Set tracer name. */
1581 current_tracer_info
->name
= entry
->value
.str
->str
;
1583 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_major");
1584 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1585 goto missing_bare_minimum
;
1588 /* Set major version number. */
1589 current_tracer_info
->major
= entry
->value
.i
;
1591 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_minor");
1592 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1596 /* Set minor version number. */
1597 current_tracer_info
->minor
= entry
->value
.i
;
1599 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patch");
1602 * If `tracer_patch` doesn't exist `tracer_patchlevel` might.
1603 * For example, `lttng-modules` uses entry name
1604 * `tracer_patchlevel`.
1606 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patchlevel");
1609 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1613 /* Set patch version number. */
1614 current_tracer_info
->patch
= entry
->value
.i
;
1618 missing_bare_minimum
:
1624 static bool is_tracer_affected_by_lttng_event_after_packet_bug(struct tracer_info
*curr_tracer_info
)
1626 bool is_affected
= false;
1628 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1629 if (curr_tracer_info
->major
< 2) {
1631 } else if (curr_tracer_info
->major
== 2) {
1632 /* fixed in lttng-ust 2.11.0 */
1633 if (curr_tracer_info
->minor
< 11) {
1637 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1638 if (curr_tracer_info
->major
< 2) {
1640 } else if (curr_tracer_info
->major
== 2) {
1641 /* fixed in lttng-modules 2.11.0 */
1642 if (curr_tracer_info
->minor
== 10) {
1643 /* fixed in lttng-modules 2.10.10 */
1644 if (curr_tracer_info
->patch
< 10) {
1647 } else if (curr_tracer_info
->minor
== 9) {
1648 /* fixed in lttng-modules 2.9.13 */
1649 if (curr_tracer_info
->patch
< 13) {
1652 } else if (curr_tracer_info
->minor
< 9) {
1662 is_tracer_affected_by_barectf_event_before_packet_bug(struct tracer_info
*curr_tracer_info
)
1664 bool is_affected
= false;
1666 if (strcmp(curr_tracer_info
->name
, "barectf") == 0) {
1667 if (curr_tracer_info
->major
< 2) {
1669 } else if (curr_tracer_info
->major
== 2) {
1670 if (curr_tracer_info
->minor
< 3) {
1672 } else if (curr_tracer_info
->minor
== 3) {
1673 /* fixed in barectf 2.3.1 */
1674 if (curr_tracer_info
->patch
< 1) {
1684 static bool is_tracer_affected_by_lttng_crash_quirk(struct tracer_info
*curr_tracer_info
)
1686 bool is_affected
= false;
1688 /* All LTTng tracer may be affected by this lttng crash quirk. */
1689 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1691 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1699 * Looks for trace produced by known buggy tracers and fix up the index
1702 static int fix_packet_index_tracer_bugs(struct ctf_fs_component
*ctf_fs
)
1705 struct tracer_info current_tracer_info
;
1706 const bt2_common::LogCfg
& logCfg
= ctf_fs
->logCfg
;
1708 ret
= extract_tracer_info(ctf_fs
->trace
.get(), ¤t_tracer_info
);
1711 * A trace may not have all the necessary environment
1712 * entries to do the tracer version comparison.
1713 * At least, the tracer name and major version number
1714 * are needed. Failing to extract these entries is not
1718 BT_LOGI_STR("Cannot extract tracer information necessary to compare with buggy versions.");
1723 /* Check if the trace may be affected by old tracer bugs. */
1724 if (is_tracer_affected_by_lttng_event_after_packet_bug(¤t_tracer_info
)) {
1725 BT_LOGI_STR("Trace may be affected by LTTng tracer packet timestamp bug. Fixing up.");
1726 ret
= fix_index_lttng_event_after_packet_bug(ctf_fs
->trace
.get());
1728 BT_CLOGE_APPEND_CAUSE("Failed to fix LTTng event-after-packet bug.");
1731 ctf_fs
->trace
->metadata
->tc
->quirks
.lttng_event_after_packet
= true;
1734 if (is_tracer_affected_by_barectf_event_before_packet_bug(¤t_tracer_info
)) {
1735 BT_LOGI_STR("Trace may be affected by barectf tracer packet timestamp bug. Fixing up.");
1736 ret
= fix_index_barectf_event_before_packet_bug(ctf_fs
->trace
.get());
1738 BT_CLOGE_APPEND_CAUSE("Failed to fix barectf event-before-packet bug.");
1741 ctf_fs
->trace
->metadata
->tc
->quirks
.barectf_event_before_packet
= true;
1744 if (is_tracer_affected_by_lttng_crash_quirk(¤t_tracer_info
)) {
1745 ret
= fix_index_lttng_crash_quirk(ctf_fs
->trace
.get());
1747 BT_CLOGE_APPEND_CAUSE("Failed to fix lttng-crash timestamp quirks.");
1750 ctf_fs
->trace
->metadata
->tc
->quirks
.lttng_crash
= true;
1757 static gint
compare_ds_file_groups_by_first_path(gconstpointer a
, gconstpointer b
)
1759 ctf_fs_ds_file_group
* const *ds_file_group_a
= (ctf_fs_ds_file_group
**) a
;
1760 ctf_fs_ds_file_group
* const *ds_file_group_b
= (ctf_fs_ds_file_group
**) b
;
1762 BT_ASSERT((*ds_file_group_a
)->ds_file_infos
->len
> 0);
1763 BT_ASSERT((*ds_file_group_b
)->ds_file_infos
->len
> 0);
1765 const ctf_fs_ds_file_info
*first_ds_file_info_a
=
1766 (const ctf_fs_ds_file_info
*) (*ds_file_group_a
)->ds_file_infos
->pdata
[0];
1767 const ctf_fs_ds_file_info
*first_ds_file_info_b
=
1768 (const ctf_fs_ds_file_info
*) (*ds_file_group_b
)->ds_file_infos
->pdata
[0];
1770 return strcmp(first_ds_file_info_a
->path
->str
, first_ds_file_info_b
->path
->str
);
1773 static gint
compare_strings(gconstpointer p_a
, gconstpointer p_b
)
1775 const char *a
= *((const char **) p_a
);
1776 const char *b
= *((const char **) p_b
);
1778 return strcmp(a
, b
);
1781 int ctf_fs_component_create_ctf_fs_trace(struct ctf_fs_component
*ctf_fs
,
1782 const bt_value
*paths_value
,
1783 const bt_value
*trace_name_value
,
1784 bt_self_component
*selfComp
)
1788 const bt2_common::LogCfg
& logCfg
= ctf_fs
->logCfg
;
1789 GPtrArray
*paths
= NULL
;
1790 std::vector
<ctf_fs_trace::UP
> traces
;
1791 const char *trace_name
;
1793 BT_ASSERT(bt_value_get_type(paths_value
) == BT_VALUE_TYPE_ARRAY
);
1794 BT_ASSERT(!bt_value_array_is_empty(paths_value
));
1796 paths
= g_ptr_array_new_with_free_func(g_free
);
1798 BT_CLOGE_APPEND_CAUSE("Failed to allocate a GPtrArray.");
1802 trace_name
= trace_name_value
? bt_value_string_get(trace_name_value
) : NULL
;
1805 * Create a sorted array of the paths, to make the execution of this
1806 * component deterministic.
1808 for (i
= 0; i
< bt_value_array_get_length(paths_value
); i
++) {
1809 const bt_value
*path_value
= bt_value_array_borrow_element_by_index_const(paths_value
, i
);
1810 const char *input
= bt_value_string_get(path_value
);
1813 input_copy
= g_strdup(input
);
1815 BT_CLOGE_APPEND_CAUSE("Failed to copy a string.");
1819 g_ptr_array_add(paths
, input_copy
);
1822 g_ptr_array_sort(paths
, compare_strings
);
1824 /* Create a separate ctf_fs_trace object for each path. */
1825 for (i
= 0; i
< paths
->len
; i
++) {
1826 const char *path
= (const char *) g_ptr_array_index(paths
, i
);
1828 ret
= ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs
, path
, trace_name
, traces
,
1835 if (traces
.size() > 1) {
1836 ctf_fs_trace
*first_trace
= traces
[0].get();
1837 const uint8_t *first_trace_uuid
= first_trace
->metadata
->tc
->uuid
;
1840 * We have more than one trace, they must all share the same
1841 * UUID, verify that.
1843 for (i
= 0; i
< traces
.size(); i
++) {
1844 ctf_fs_trace
*this_trace
= traces
[i
].get();
1845 const uint8_t *this_trace_uuid
= this_trace
->metadata
->tc
->uuid
;
1847 if (!this_trace
->metadata
->tc
->is_uuid_set
) {
1848 BT_CLOGE_APPEND_CAUSE(
1849 "Multiple traces given, but a trace does not have a UUID: path=%s",
1850 this_trace
->path
->str
);
1854 if (bt_uuid_compare(first_trace_uuid
, this_trace_uuid
) != 0) {
1855 char first_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1856 char this_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1858 bt_uuid_to_str(first_trace_uuid
, first_trace_uuid_str
);
1859 bt_uuid_to_str(this_trace_uuid
, this_trace_uuid_str
);
1861 BT_CLOGE_APPEND_CAUSE("Multiple traces given, but UUIDs don't match: "
1862 "first-trace-uuid=%s, first-trace-path=%s, "
1863 "trace-uuid=%s, trace-path=%s",
1864 first_trace_uuid_str
, first_trace
->path
->str
,
1865 this_trace_uuid_str
, this_trace
->path
->str
);
1870 ret
= merge_ctf_fs_traces(std::move(traces
), ctf_fs
->trace
);
1872 BT_CLOGE_APPEND_CAUSE("Failed to merge traces with the same UUID.");
1876 /* Just one trace, it may or may not have a UUID, both are fine. */
1877 ctf_fs
->trace
= std::move(traces
[0]);
1880 ret
= fix_packet_index_tracer_bugs(ctf_fs
);
1882 BT_CLOGE_APPEND_CAUSE("Failed to fix packet index tracer bugs.");
1886 * Sort data stream file groups by first data stream file info
1887 * path to get a deterministic order. This order influences the
1888 * order of the output ports. It also influences the order of
1889 * the automatic stream IDs if the trace's packet headers do not
1890 * contain a `stream_instance_id` field, in which case the data
1891 * stream file to stream ID association is always the same,
1892 * whatever the build and the system.
1894 * Having a deterministic order here can help debugging and
1897 g_ptr_array_sort(ctf_fs
->trace
->ds_file_groups
, compare_ds_file_groups_by_first_path
);
1904 g_ptr_array_free(paths
, TRUE
);
1910 static GString
*get_stream_instance_unique_name(struct ctf_fs_ds_file_group
*ds_file_group
)
1913 struct ctf_fs_ds_file_info
*ds_file_info
;
1915 name
= g_string_new(NULL
);
1921 * If there's more than one stream file in the stream file
1922 * group, the first (earliest) stream file's path is used as
1923 * the stream's unique name.
1925 BT_ASSERT(ds_file_group
->ds_file_infos
->len
> 0);
1926 ds_file_info
= (ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
1927 g_string_assign(name
, ds_file_info
->path
->str
);
1933 /* Create the IR stream objects for ctf_fs_trace. */
1935 static int create_streams_for_trace(struct ctf_fs_trace
*ctf_fs_trace
)
1938 GString
*name
= NULL
;
1940 const bt2_common::LogCfg
& logCfg
= ctf_fs_trace
->logCfg
;
1942 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
1943 ctf_fs_ds_file_group
*ds_file_group
=
1944 (ctf_fs_ds_file_group
*) g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
1945 name
= get_stream_instance_unique_name(ds_file_group
);
1951 BT_ASSERT(ds_file_group
->sc
->ir_sc
);
1952 BT_ASSERT(ctf_fs_trace
->trace
);
1954 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
1955 /* No stream ID: use 0 */
1956 ds_file_group
->stream
= bt_stream_create_with_id(
1957 ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
, ctf_fs_trace
->next_stream_id
);
1958 ctf_fs_trace
->next_stream_id
++;
1960 /* Specific stream ID */
1961 ds_file_group
->stream
= bt_stream_create_with_id(
1962 ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
, (uint64_t) ds_file_group
->stream_id
);
1965 if (!ds_file_group
->stream
) {
1966 BT_CLOGE_APPEND_CAUSE("Cannot create stream for DS file group: "
1967 "addr=%p, stream-name=\"%s\"",
1968 ds_file_group
, name
->str
);
1972 ret
= bt_stream_set_name(ds_file_group
->stream
, name
->str
);
1974 BT_CLOGE_APPEND_CAUSE("Cannot set stream's name: "
1975 "addr=%p, stream-name=\"%s\"",
1976 ds_file_group
->stream
, name
->str
);
1980 g_string_free(name
, TRUE
);
1993 g_string_free(name
, TRUE
);
1998 static const bt_param_validation_value_descr inputs_elem_descr
=
1999 bt_param_validation_value_descr::makeString();
2001 static bt_param_validation_map_value_entry_descr fs_params_entries_descr
[] = {
2002 {"inputs", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
2003 bt_param_validation_value_descr::makeArray(1, BT_PARAM_VALIDATION_INFINITE
,
2004 inputs_elem_descr
)},
2005 {"trace-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2006 bt_param_validation_value_descr::makeString()},
2007 {"clock-class-offset-s", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2008 bt_param_validation_value_descr::makeSignedInteger()},
2009 {"clock-class-offset-ns", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2010 bt_param_validation_value_descr::makeSignedInteger()},
2011 {"force-clock-class-origin-unix-epoch", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2012 bt_param_validation_value_descr::makeBool()},
2013 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
2015 bool read_src_fs_parameters(const bt_value
*params
, const bt_value
**inputs
,
2016 const bt_value
**trace_name
, struct ctf_fs_component
*ctf_fs
)
2019 const bt_value
*value
;
2020 enum bt_param_validation_status validate_value_status
;
2021 gchar
*error
= NULL
;
2022 const bt2_common::LogCfg
& logCfg
= ctf_fs
->logCfg
;
2024 validate_value_status
= bt_param_validation_validate(params
, fs_params_entries_descr
, &error
);
2025 if (validate_value_status
!= BT_PARAM_VALIDATION_STATUS_OK
) {
2026 BT_CLOGE_APPEND_CAUSE("%s", error
);
2031 /* inputs parameter */
2032 *inputs
= bt_value_map_borrow_entry_value_const(params
, "inputs");
2034 /* clock-class-offset-s parameter */
2035 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-s");
2037 ctf_fs
->clkClsCfg
.offsetSec
= bt_value_integer_signed_get(value
);
2040 /* clock-class-offset-ns parameter */
2041 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-ns");
2043 ctf_fs
->clkClsCfg
.offsetNanoSec
= bt_value_integer_signed_get(value
);
2046 /* force-clock-class-origin-unix-epoch parameter */
2047 value
= bt_value_map_borrow_entry_value_const(params
, "force-clock-class-origin-unix-epoch");
2049 ctf_fs
->clkClsCfg
.forceOriginIsUnixEpoch
= bt_value_bool_get(value
);
2052 /* trace-name parameter */
2053 *trace_name
= bt_value_map_borrow_entry_value_const(params
, "trace-name");
2062 static ctf_fs_component::UP
ctf_fs_create(const bt_value
*params
,
2063 bt_self_component_source
*self_comp_src
,
2064 const bt2_common::LogCfg
& logCfg
)
2066 const bt_value
*inputs_value
;
2067 const bt_value
*trace_name_value
;
2068 bt_self_component
*self_comp
= bt_self_component_source_as_self_component(self_comp_src
);
2070 ctf_fs_component::UP ctf_fs
= ctf_fs_component_create(logCfg
);
2075 if (!read_src_fs_parameters(params
, &inputs_value
, &trace_name_value
, ctf_fs
.get())) {
2079 if (ctf_fs_component_create_ctf_fs_trace(ctf_fs
.get(), inputs_value
, trace_name_value
,
2084 if (create_streams_for_trace(ctf_fs
->trace
.get())) {
2088 if (create_ports_for_trace(ctf_fs
.get(), ctf_fs
->trace
.get(), self_comp_src
)) {
2096 bt_component_class_initialize_method_status
2097 ctf_fs_init(bt_self_component_source
*self_comp_src
, bt_self_component_source_configuration
*config
,
2098 const bt_value
*params
, __attribute__((unused
)) void *init_method_data
)
2100 bt_self_component
*selfComp
= bt_self_component_source_as_self_component(self_comp_src
);
2101 const bt_component
*comp
= bt_self_component_as_component(selfComp
);
2102 bt_logging_level logLevel
= bt_component_get_logging_level(comp
);
2103 bt2_common::LogCfg
logCfg(logLevel
, *selfComp
);
2106 ctf_fs_component::UP ctf_fs
= ctf_fs_create(params
, self_comp_src
, logCfg
);
2108 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
2111 bt_self_component_set_data(selfComp
, ctf_fs
.release());
2113 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
2114 } catch (const std::bad_alloc
&) {
2115 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
2116 } catch (const bt2_common::Error
&) {
2117 BT_CLOGE_APPEND_CAUSE("Failed to initialize component");
2118 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
2123 bt_component_class_query_method_status
ctf_fs_query(bt_self_component_class_source
*comp_class_src
,
2124 bt_private_query_executor
*priv_query_exec
,
2125 const char *object
, const bt_value
*params
,
2126 __attribute__((unused
)) void *method_data
,
2127 const bt_value
**result
)
2129 const bt_query_executor
*query_exec
=
2130 bt_private_query_executor_as_query_executor_const(priv_query_exec
);
2131 bt_logging_level log_level
= bt_query_executor_get_logging_level(query_exec
);
2132 bt_self_component_class
*comp_class
=
2133 bt_self_component_class_source_as_self_component_class(comp_class_src
);
2134 bt2_common::LogCfg
logCfg(log_level
, *comp_class
);
2137 bt2::ConstMapValue
paramsObj(params
);
2138 nonstd::optional
<bt2::Value::Shared
> resultObj
;
2140 if (strcmp(object
, "metadata-info") == 0) {
2141 resultObj
= metadata_info_query(paramsObj
, logCfg
);
2142 } else if (strcmp(object
, "babeltrace.trace-infos") == 0) {
2143 resultObj
= trace_infos_query(paramsObj
, logCfg
);
2144 } else if (!strcmp(object
, "babeltrace.support-info")) {
2145 resultObj
= support_info_query(paramsObj
, logCfg
);
2147 BT_LOGE("Unknown query object `%s`", object
);
2148 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;
2151 *result
= resultObj
->release().libObjPtr();
2153 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
2154 } catch (const std::bad_alloc
&) {
2155 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
2156 } catch (const bt2_common::Error
&) {
2157 BT_CLOGE_APPEND_CAUSE("Failed to execute query: object=%s", object
);
2158 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;