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"
18 #include "cpp-common/bt2s/make-unique.hpp"
20 #include "plugins/common/param-validation/param-validation.h"
22 #include "../common/src/metadata/tsdl/ctf-meta-configure-ir-trace.hpp"
23 #include "../common/src/msg-iter/msg-iter.hpp"
24 #include "data-stream-file.hpp"
27 #include "metadata.hpp"
38 static bt_message_iterator_class_next_method_status
39 ctf_fs_iterator_next_one(struct ctf_fs_msg_iter_data
*msg_iter_data
, const bt_message
**out_msg
)
41 bt_message_iterator_class_next_method_status status
;
42 const auto msg_iter_status
=
43 ctf_msg_iter_get_next_message(msg_iter_data
->msg_iter
.get(), out_msg
);
45 switch (msg_iter_status
) {
46 case CTF_MSG_ITER_STATUS_OK
:
47 /* Cool, message has been written to *out_msg. */
48 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
51 case CTF_MSG_ITER_STATUS_EOF
:
52 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END
;
55 case CTF_MSG_ITER_STATUS_AGAIN
:
57 * Should not make it this far as this is
58 * medium-specific; there is nothing for the user to do
59 * and it should have been handled upstream.
63 case CTF_MSG_ITER_STATUS_ERROR
:
64 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
65 "Failed to get next message from CTF message iterator.");
66 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
69 case CTF_MSG_ITER_STATUS_MEMORY_ERROR
:
70 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
71 "Failed to get next message from CTF message iterator.");
72 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
82 bt_message_iterator_class_next_method_status
83 ctf_fs_iterator_next(bt_self_message_iterator
*iterator
, bt_message_array_const msgs
,
84 uint64_t capacity
, uint64_t *count
)
87 bt_message_iterator_class_next_method_status status
;
88 struct ctf_fs_msg_iter_data
*msg_iter_data
=
89 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(iterator
);
92 if (G_UNLIKELY(msg_iter_data
->next_saved_error
)) {
94 * Last time we were called, we hit an error but had some
95 * messages to deliver, so we stashed the error here. Return
98 BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(msg_iter_data
->next_saved_error
);
99 status
= msg_iter_data
->next_saved_status
;
104 status
= ctf_fs_iterator_next_one(msg_iter_data
, &msgs
[i
]);
105 if (status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
) {
108 } while (i
< capacity
&& status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
);
112 * Even if ctf_fs_iterator_next_one() returned something
113 * else than BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK, we
114 * accumulated message objects in the output
115 * message array, so we need to return
116 * BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK so that they are
117 * transferred to downstream. This other status occurs
118 * again the next time muxer_msg_iter_do_next() is
119 * called, possibly without any accumulated
120 * message, in which case we'll return it.
124 * Save this error for the next _next call. Assume that
125 * this component always appends error causes when
126 * returning an error status code, which will cause the
127 * current thread error to be non-NULL.
129 msg_iter_data
->next_saved_error
= bt_current_thread_take_error();
130 BT_ASSERT(msg_iter_data
->next_saved_error
);
131 msg_iter_data
->next_saved_status
= status
;
135 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
141 } catch (const std::bad_alloc
&) {
142 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
143 } catch (const bt2::Error
&) {
144 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
148 bt_message_iterator_class_seek_beginning_method_status
149 ctf_fs_iterator_seek_beginning(bt_self_message_iterator
*it
)
152 struct ctf_fs_msg_iter_data
*msg_iter_data
=
153 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(it
);
155 BT_ASSERT(msg_iter_data
);
157 ctf_msg_iter_reset(msg_iter_data
->msg_iter
.get());
158 ctf_fs_ds_group_medops_data_reset(msg_iter_data
->msg_iter_medops_data
.get());
160 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_OK
;
161 } catch (const std::bad_alloc
&) {
162 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_MEMORY_ERROR
;
163 } catch (const bt2::Error
&) {
164 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_ERROR
;
168 void ctf_fs_iterator_finalize(bt_self_message_iterator
*it
)
170 ctf_fs_msg_iter_data::UP
{
171 (static_cast<ctf_fs_msg_iter_data
*>(bt_self_message_iterator_get_data(it
)))};
174 static bt_message_iterator_class_initialize_method_status
175 ctf_msg_iter_medium_status_to_msg_iter_initialize_status(enum ctf_msg_iter_medium_status status
)
178 case CTF_MSG_ITER_MEDIUM_STATUS_EOF
:
179 case CTF_MSG_ITER_MEDIUM_STATUS_AGAIN
:
180 case CTF_MSG_ITER_MEDIUM_STATUS_ERROR
:
181 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
182 case CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
:
183 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
184 case CTF_MSG_ITER_MEDIUM_STATUS_OK
:
185 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
191 bt_message_iterator_class_initialize_method_status
192 ctf_fs_iterator_init(bt_self_message_iterator
*self_msg_iter
,
193 bt_self_message_iterator_configuration
*config
,
194 bt_self_component_port_output
*self_port
)
197 struct ctf_fs_port_data
*port_data
;
198 bt_message_iterator_class_initialize_method_status status
;
199 enum ctf_msg_iter_medium_status medium_status
;
201 port_data
= (struct ctf_fs_port_data
*) bt_self_component_port_get_data(
202 bt_self_component_port_output_as_self_component_port(self_port
));
203 BT_ASSERT(port_data
);
205 auto msg_iter_data
= bt2s::make_unique
<ctf_fs_msg_iter_data
>(self_msg_iter
);
206 msg_iter_data
->ds_file_group
= port_data
->ds_file_group
;
208 medium_status
= ctf_fs_ds_group_medops_data_create(msg_iter_data
->ds_file_group
,
209 self_msg_iter
, msg_iter_data
->logger
,
210 msg_iter_data
->msg_iter_medops_data
);
211 BT_ASSERT(medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_OK
||
212 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_ERROR
||
213 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
);
214 if (medium_status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
215 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
216 "Failed to create ctf_fs_ds_group_medops");
217 status
= ctf_msg_iter_medium_status_to_msg_iter_initialize_status(medium_status
);
221 msg_iter_data
->msg_iter
= ctf_msg_iter_create(
222 msg_iter_data
->ds_file_group
->ctf_fs_trace
->metadata
->tc
,
223 bt_common_get_page_size(static_cast<int>(msg_iter_data
->logger
.level())) * 8,
224 ctf_fs_ds_group_medops
, msg_iter_data
->msg_iter_medops_data
.get(), self_msg_iter
,
225 msg_iter_data
->logger
);
226 if (!msg_iter_data
->msg_iter
) {
227 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
228 "Cannot create a CTF message iterator.");
229 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
234 * This iterator can seek forward if its stream class has a default
237 if (msg_iter_data
->ds_file_group
->sc
->default_clock_class
) {
238 bt_self_message_iterator_configuration_set_can_seek_forward(config
, true);
241 bt_self_message_iterator_set_data(self_msg_iter
, msg_iter_data
.release());
243 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
247 bt_self_message_iterator_set_data(self_msg_iter
, NULL
);
251 } catch (const std::bad_alloc
&) {
252 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
253 } catch (const bt2::Error
&) {
254 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
258 static void ctf_fs_trace_destroy(struct ctf_fs_trace
*ctf_fs_trace
)
264 if (ctf_fs_trace
->path
) {
265 g_string_free(ctf_fs_trace
->path
, TRUE
);
268 if (ctf_fs_trace
->metadata
) {
269 ctf_fs_metadata_fini(ctf_fs_trace
->metadata
);
270 delete ctf_fs_trace
->metadata
;
276 void ctf_fs_trace_deleter::operator()(ctf_fs_trace
* const trace
) noexcept
278 ctf_fs_trace_destroy(trace
);
281 ctf_fs_component::UP
ctf_fs_component_create(const bt2c::Logger
& parentLogger
)
283 return bt2s::make_unique
<ctf_fs_component
>(parentLogger
);
286 void ctf_fs_finalize(bt_self_component_source
*component
)
288 ctf_fs_component::UP
{static_cast<ctf_fs_component
*>(
289 bt_self_component_get_data(bt_self_component_source_as_self_component(component
)))};
292 bt2c::GCharUP
ctf_fs_make_port_name(struct ctf_fs_ds_file_group
*ds_file_group
)
294 GString
*name
= g_string_new(NULL
);
297 * The unique port name is generated by concatenating unique identifiers
305 /* For the trace, use the uuid if present, else the path. */
306 if (ds_file_group
->ctf_fs_trace
->metadata
->tc
->is_uuid_set
) {
307 char uuid_str
[BT_UUID_STR_LEN
+ 1];
309 bt_uuid_to_str(ds_file_group
->ctf_fs_trace
->metadata
->tc
->uuid
, uuid_str
);
310 g_string_assign(name
, uuid_str
);
312 g_string_assign(name
, ds_file_group
->ctf_fs_trace
->path
->str
);
316 * For the stream class, use the id if present. We can omit this field
317 * otherwise, as there will only be a single stream class.
319 if (ds_file_group
->sc
->id
!= UINT64_C(-1)) {
320 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->sc
->id
);
323 /* For the stream, use the id if present, else, use the path. */
324 if (ds_file_group
->stream_id
!= UINT64_C(-1)) {
325 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->stream_id
);
327 BT_ASSERT(ds_file_group
->ds_file_infos
.size() == 1);
328 const auto& ds_file_info
= *ds_file_group
->ds_file_infos
[0];
329 g_string_append_printf(name
, " | %s", ds_file_info
.path
.c_str());
332 return bt2c::GCharUP
{g_string_free(name
, FALSE
)};
335 static int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
336 struct ctf_fs_ds_file_group
*ds_file_group
,
337 bt_self_component_source
*self_comp_src
)
340 ctf_fs_port_data::UP port_data
;
342 bt2c::GCharUP port_name
= ctf_fs_make_port_name(ds_file_group
);
347 BT_CPPLOGI_SPEC(ctf_fs
->logger
, "Creating one port named `{}`", port_name
.get());
349 /* Create output port for this file */
350 port_data
= bt2s::make_unique
<ctf_fs_port_data
>();
351 port_data
->ctf_fs
= ctf_fs
;
352 port_data
->ds_file_group
= ds_file_group
;
353 ret
= bt_self_component_source_add_output_port(self_comp_src
, port_name
.get(), port_data
.get(),
359 ctf_fs
->port_data
.emplace_back(std::move(port_data
));
369 static int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
370 struct ctf_fs_trace
*ctf_fs_trace
,
371 bt_self_component_source
*self_comp_src
)
375 /* Create one output port for each stream file group */
376 for (const auto& ds_file_group
: ctf_fs_trace
->ds_file_groups
) {
377 ret
= create_one_port_for_trace(ctf_fs
, ds_file_group
.get(), self_comp_src
);
379 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create output port.");
389 * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right
390 * place to keep it sorted.
393 static void ds_file_group_insert_ds_file_info_sorted(struct ctf_fs_ds_file_group
*ds_file_group
,
394 ctf_fs_ds_file_info::UP ds_file_info
)
396 /* Find the spot where to insert this ds_file_info. */
397 auto it
= ds_file_group
->ds_file_infos
.begin();
399 for (; it
!= ds_file_group
->ds_file_infos
.end(); ++it
) {
400 const ctf_fs_ds_file_info
& other_ds_file_info
= **it
;
402 if (ds_file_info
->begin_ns
< other_ds_file_info
.begin_ns
) {
407 ds_file_group
->ds_file_infos
.insert(it
, std::move(ds_file_info
));
410 static bool ds_index_entries_equal(const struct ctf_fs_ds_index_entry
*left
,
411 const struct ctf_fs_ds_index_entry
*right
)
413 if (left
->packetSize
!= right
->packetSize
) {
417 if (left
->timestamp_begin
!= right
->timestamp_begin
) {
421 if (left
->timestamp_end
!= right
->timestamp_end
) {
425 if (left
->packet_seq_num
!= right
->packet_seq_num
) {
433 * Insert `entry` into `index`, without duplication.
435 * The entry is inserted only if there isn't an identical entry already.
437 * In any case, the ownership of `entry` is transferred to this function. So if
438 * the entry is not inserted, it is freed.
441 static void ds_index_insert_ds_index_entry_sorted(struct ctf_fs_ds_index
*index
,
442 ctf_fs_ds_index_entry::UP entry
)
444 /* Find the spot where to insert this index entry. */
445 auto otherEntry
= index
->entries
.begin();
446 for (; otherEntry
!= index
->entries
.end(); ++otherEntry
) {
447 if (entry
->timestamp_begin_ns
<= (*otherEntry
)->timestamp_begin_ns
) {
453 * Insert the entry only if a duplicate doesn't already exist.
455 * There can be duplicate packets if reading multiple overlapping
456 * snapshots of the same trace. We then want the index to contain
457 * a reference to only one copy of that packet.
459 if (otherEntry
== index
->entries
.end() ||
460 !ds_index_entries_equal(entry
.get(), otherEntry
->get())) {
461 index
->entries
.insert(otherEntry
, std::move(entry
));
465 static void merge_ctf_fs_ds_indexes(struct ctf_fs_ds_index
*dest
, ctf_fs_ds_index::UP src
)
467 for (auto& entry
: src
->entries
) {
468 ds_index_insert_ds_index_entry_sorted(dest
, std::move(entry
));
472 static int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
, const char *path
)
474 int64_t stream_instance_id
= -1;
475 int64_t begin_ns
= -1;
476 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
477 ctf_fs_ds_file_group::UP new_ds_file_group
;
479 ctf_fs_ds_file_info::UP ds_file_info
;
480 ctf_fs_ds_index::UP index
;
481 ctf_msg_iter_up msg_iter
;
482 struct ctf_stream_class
*sc
= NULL
;
483 struct ctf_msg_iter_packet_properties props
;
486 * Create a temporary ds_file to read some properties about the data
490 ctf_fs_ds_file_create(ctf_fs_trace
, bt2::Stream::Shared
{}, path
, ctf_fs_trace
->logger
);
495 /* Create a temporary iterator to read the ds_file. */
496 msg_iter
= ctf_msg_iter_create(
497 ctf_fs_trace
->metadata
->tc
,
498 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
499 ctf_fs_ds_file_medops
, ds_file
.get(), nullptr, ctf_fs_trace
->logger
);
501 BT_CPPLOGE_STR_SPEC(ctf_fs_trace
->logger
, "Cannot create a CTF message iterator.");
505 ctf_msg_iter_set_dry_run(msg_iter
.get(), true);
507 ret
= ctf_msg_iter_get_packet_properties(msg_iter
.get(), &props
);
509 BT_CPPLOGE_APPEND_CAUSE_SPEC(
510 ctf_fs_trace
->logger
,
511 "Cannot get stream file's first packet's header and context fields (`{}`).", path
);
515 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
, props
.stream_class_id
);
517 stream_instance_id
= props
.data_stream_id
;
519 if (props
.snapshots
.beginning_clock
!= UINT64_C(-1)) {
520 BT_ASSERT(sc
->default_clock_class
);
521 ret
= bt_util_clock_cycles_to_ns_from_origin(
522 props
.snapshots
.beginning_clock
, sc
->default_clock_class
->frequency
,
523 sc
->default_clock_class
->offset_seconds
, sc
->default_clock_class
->offset_cycles
,
526 BT_CPPLOGE_APPEND_CAUSE_SPEC(
527 ctf_fs_trace
->logger
,
528 "Cannot convert clock cycles to nanoseconds from origin (`{}`).", path
);
533 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
);
538 index
= ctf_fs_ds_file_build_index(ds_file
.get(), ds_file_info
.get(), msg_iter
.get());
540 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to index CTF stream file \'{}\'",
541 ds_file
->file
->path
);
545 if (begin_ns
== -1) {
547 * No beginning timestamp to sort the stream files
548 * within a stream file group, so consider that this
549 * file must be the only one within its group.
551 stream_instance_id
= -1;
554 if (stream_instance_id
== -1) {
556 * No stream instance ID or no beginning timestamp:
557 * create a unique stream file group for this stream
558 * file because, even if there's a stream instance ID,
559 * there's no timestamp to order the file within its
563 ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, UINT64_C(-1), std::move(index
));
565 if (!new_ds_file_group
) {
569 ds_file_group_insert_ds_file_info_sorted(new_ds_file_group
.get(), std::move(ds_file_info
));
570 ctf_fs_trace
->ds_file_groups
.emplace_back(std::move(new_ds_file_group
));
574 BT_ASSERT(stream_instance_id
!= -1);
575 BT_ASSERT(begin_ns
!= -1);
577 /* Find an existing stream file group with this ID */
578 for (const auto& candidate
: ctf_fs_trace
->ds_file_groups
) {
579 if (candidate
->sc
== sc
&& candidate
->stream_id
== stream_instance_id
) {
580 ds_file_group
= candidate
.get();
585 if (!ds_file_group
) {
587 ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, stream_instance_id
, std::move(index
));
588 if (!new_ds_file_group
) {
592 ds_file_group
= new_ds_file_group
.get();
593 ctf_fs_trace
->ds_file_groups
.emplace_back(std::move(new_ds_file_group
));
595 merge_ctf_fs_ds_indexes(ds_file_group
->index
.get(), std::move(index
));
598 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, std::move(ds_file_info
));
609 static int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
612 const char *basename
;
613 GError
*error
= NULL
;
616 /* Check each file in the path directory, except specific ones */
617 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
619 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
620 "Cannot open directory `{}`: {} (code {})",
621 ctf_fs_trace
->path
->str
, error
->message
, error
->code
);
625 while ((basename
= g_dir_read_name(dir
))) {
626 if (strcmp(basename
, CTF_FS_METADATA_FILENAME
) == 0) {
627 /* Ignore the metadata stream. */
628 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
629 "Ignoring metadata file `{}" G_DIR_SEPARATOR_S
"{}`",
630 ctf_fs_trace
->path
->str
, basename
);
634 if (basename
[0] == '.') {
635 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
636 "Ignoring hidden file `{}" G_DIR_SEPARATOR_S
"{}`",
637 ctf_fs_trace
->path
->str
, basename
);
641 /* Create the file. */
642 const auto file
= ctf_fs_file_create(ctf_fs_trace
->logger
);
644 BT_CPPLOGE_APPEND_CAUSE_SPEC(
645 ctf_fs_trace
->logger
,
646 "Cannot create stream file object for file `{}" G_DIR_SEPARATOR_S
"{}`",
647 ctf_fs_trace
->path
->str
, basename
);
651 /* Create full path string. */
652 file
->path
= fmt::format("{}" G_DIR_SEPARATOR_S
"{}", ctf_fs_trace
->path
->str
, basename
);
654 if (!g_file_test(file
->path
.c_str(), G_FILE_TEST_IS_REGULAR
)) {
655 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring non-regular file `{}`", file
->path
);
659 ret
= ctf_fs_file_open(file
.get(), "rb");
661 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Cannot open stream file `{}`",
666 if (file
->size
== 0) {
667 /* Skip empty stream. */
668 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring empty file `{}`", file
->path
);
672 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
, file
->path
.c_str());
674 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
675 "Cannot add stream file `{}` to stream file group",
699 static int set_trace_name(bt_trace
*trace
, const char *name_suffix
, const bt2c::Logger
& logger
)
705 name
= g_string_new(NULL
);
707 BT_CPPLOGE_STR_SPEC(logger
, "Failed to allocate a GString.");
713 * Check if we have a trace environment string value named `hostname`.
714 * If so, use it as the trace name's prefix.
716 val
= bt_trace_borrow_environment_entry_value_by_name_const(trace
, "hostname");
717 if (val
&& bt_value_is_string(val
)) {
718 g_string_append(name
, bt_value_string_get(val
));
721 g_string_append_c(name
, G_DIR_SEPARATOR
);
726 g_string_append(name
, name_suffix
);
729 ret
= bt_trace_set_name(trace
, name
->str
);
738 g_string_free(name
, TRUE
);
744 static ctf_fs_trace::UP
ctf_fs_trace_create(const char *path
, const char *name
,
745 const ctf::src::ClkClsCfg
& clkClsCfg
,
746 bt_self_component
*selfComp
,
747 const bt2c::Logger
& parentLogger
)
751 ctf_fs_trace::UP ctf_fs_trace
{new struct ctf_fs_trace(parentLogger
)};
752 ctf_fs_trace
->path
= g_string_new(path
);
753 if (!ctf_fs_trace
->path
) {
757 ctf_fs_trace
->metadata
= new ctf_fs_metadata
;
758 ctf_fs_metadata_init(ctf_fs_trace
->metadata
);
760 ret
= ctf_fs_metadata_set_trace_class(selfComp
, ctf_fs_trace
.get(), clkClsCfg
);
765 if (ctf_fs_trace
->metadata
->trace_class
) {
766 bt_trace
*trace
= bt_trace_create(ctf_fs_trace
->metadata
->trace_class
);
771 ctf_fs_trace
->trace
= bt2::Trace::Shared::createWithoutRef(trace
);
774 if (ctf_fs_trace
->trace
) {
775 ret
= ctf_trace_class_configure_ir_trace(ctf_fs_trace
->metadata
->tc
,
776 ctf_fs_trace
->trace
->libObjPtr());
781 ret
= set_trace_name(ctf_fs_trace
->trace
->libObjPtr(), name
, ctf_fs_trace
->logger
);
787 ret
= create_ds_file_groups(ctf_fs_trace
.get());
795 ctf_fs_trace
.reset();
801 static int path_is_ctf_trace(const char *path
)
803 GString
*metadata_path
= g_string_new(NULL
);
806 if (!metadata_path
) {
811 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
813 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
819 g_string_free(metadata_path
, TRUE
);
823 /* Helper for ctf_fs_component_create_ctf_fs_trace, to handle a single path. */
825 static int ctf_fs_component_create_ctf_fs_trace_one_path(struct ctf_fs_component
*ctf_fs
,
826 const char *path_param
,
827 const char *trace_name
,
828 std::vector
<ctf_fs_trace::UP
>& traces
,
829 bt_self_component
*selfComp
)
831 ctf_fs_trace::UP ctf_fs_trace
;
835 norm_path
= bt_common_normalize_path(path_param
, NULL
);
837 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to normalize path: `{}`.", path_param
);
841 ret
= path_is_ctf_trace(norm_path
->str
);
843 BT_CPPLOGE_APPEND_CAUSE_SPEC(
844 ctf_fs
->logger
, "Failed to check if path is a CTF trace: path={}", norm_path
->str
);
846 } else if (ret
== 0) {
847 BT_CPPLOGE_APPEND_CAUSE_SPEC(
848 ctf_fs
->logger
, "Path is not a CTF trace (does not contain a metadata file): `{}`.",
853 // FIXME: Remove or ifdef for __MINGW32__
854 if (strcmp(norm_path
->str
, "/") == 0) {
855 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Opening a trace in `/` is not supported.");
860 ctf_fs_trace
= ctf_fs_trace_create(norm_path
->str
, trace_name
, ctf_fs
->clkClsCfg
, selfComp
,
863 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create trace for `{}`.",
868 traces
.emplace_back(std::move(ctf_fs_trace
));
878 g_string_free(norm_path
, TRUE
);
885 * Count the number of stream and event classes defined by this trace's metadata.
887 * This is used to determine which metadata is the "latest", out of multiple
888 * traces sharing the same UUID. It is assumed that amongst all these metadatas,
889 * a bigger metadata is a superset of a smaller metadata. Therefore, it is
890 * enough to just count the classes.
893 static unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace
*trace
)
895 unsigned int num
= trace
->metadata
->tc
->stream_classes
->len
;
898 for (i
= 0; i
< trace
->metadata
->tc
->stream_classes
->len
; i
++) {
899 struct ctf_stream_class
*sc
=
900 (struct ctf_stream_class
*) trace
->metadata
->tc
->stream_classes
->pdata
[i
];
901 num
+= sc
->event_classes
->len
;
908 * Merge the src ds_file_group into dest. This consists of merging their
909 * ds_file_infos, making sure to keep the result sorted.
912 static void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group
*dest
,
913 ctf_fs_ds_file_group::UP src
)
915 for (auto& ds_file_info
: src
->ds_file_infos
) {
916 ds_file_group_insert_ds_file_info_sorted(dest
, std::move(ds_file_info
));
919 /* Merge both indexes. */
920 merge_ctf_fs_ds_indexes(dest
->index
.get(), std::move(src
->index
));
923 /* Merge src_trace's data stream file groups into dest_trace's. */
925 static int merge_matching_ctf_fs_ds_file_groups(struct ctf_fs_trace
*dest_trace
,
926 ctf_fs_trace::UP src_trace
)
928 std::vector
<ctf_fs_ds_file_group::UP
>& dest
= dest_trace
->ds_file_groups
;
929 std::vector
<ctf_fs_ds_file_group::UP
>& src
= src_trace
->ds_file_groups
;
933 * Save the initial length of dest: we only want to check against the
934 * original elements in the inner loop.
936 size_t dest_len
= dest
.size();
938 for (auto& src_group
: src
) {
939 struct ctf_fs_ds_file_group
*dest_group
= NULL
;
941 /* A stream instance without ID can't match a stream in the other trace. */
942 if (src_group
->stream_id
!= -1) {
943 /* Let's search for a matching ds_file_group in the destination. */
944 for (size_t d_i
= 0; d_i
< dest_len
; ++d_i
) {
945 ctf_fs_ds_file_group
*candidate_dest
= dest
[d_i
].get();
947 /* Can't match a stream instance without ID. */
948 if (candidate_dest
->stream_id
== -1) {
953 * If the two groups have the same stream instance id
954 * and belong to the same stream class (stream instance
955 * ids are per-stream class), they represent the same
958 if (candidate_dest
->stream_id
!= src_group
->stream_id
||
959 candidate_dest
->sc
->id
!= src_group
->sc
->id
) {
963 dest_group
= candidate_dest
;
969 * Didn't find a friend in dest to merge our src_group into?
970 * Create a new empty one. This can happen if a stream was
971 * active in the source trace chunk but not in the destination
975 struct ctf_stream_class
*sc
;
977 sc
= ctf_trace_class_borrow_stream_class_by_id(dest_trace
->metadata
->tc
,
981 auto index
= ctf_fs_ds_index_create();
987 auto new_dest_group
=
988 ctf_fs_ds_file_group_create(dest_trace
, sc
, src_group
->stream_id
, std::move(index
));
990 if (!new_dest_group
) {
995 dest_group
= new_dest_group
.get();
996 dest_trace
->ds_file_groups
.emplace_back(std::move(new_dest_group
));
999 BT_ASSERT(dest_group
);
1000 merge_ctf_fs_ds_file_groups(dest_group
, std::move(src_group
));
1008 * Collapse the given traces, which must all share the same UUID, in a single
1011 * The trace with the most expansive metadata is chosen and all other traces
1012 * are merged into that one. On return, the elements of `traces` are nullptr
1013 * and the merged trace is placed in `out_trace`.
1016 static int merge_ctf_fs_traces(std::vector
<ctf_fs_trace::UP
> traces
, ctf_fs_trace::UP
& out_trace
)
1018 unsigned int winner_count
;
1019 struct ctf_fs_trace
*winner
;
1023 BT_ASSERT(traces
.size() >= 2);
1025 winner_count
= metadata_count_stream_and_event_classes(traces
[0].get());
1026 winner
= traces
[0].get();
1029 /* Find the trace with the largest metadata. */
1030 for (i
= 1; i
< traces
.size(); i
++) {
1031 ctf_fs_trace
*candidate
= traces
[i
].get();
1032 unsigned int candidate_count
;
1034 /* A bit of sanity check. */
1035 BT_ASSERT(bt_uuid_compare(winner
->metadata
->tc
->uuid
, candidate
->metadata
->tc
->uuid
) == 0);
1037 candidate_count
= metadata_count_stream_and_event_classes(candidate
);
1039 if (candidate_count
> winner_count
) {
1040 winner_count
= candidate_count
;
1046 /* Merge all the other traces in the winning trace. */
1047 for (ctf_fs_trace::UP
& trace
: traces
) {
1048 /* Don't merge the winner into itself. */
1049 if (trace
.get() == winner
) {
1053 /* Merge trace's data stream file groups into winner's. */
1054 ret
= merge_matching_ctf_fs_ds_file_groups(winner
, std::move(trace
));
1061 * Move the winner out of the array, into `*out_trace`.
1063 out_trace
= std::move(traces
[winner_i
]);
1075 static int decode_clock_snapshot_after_event(struct ctf_fs_trace
*ctf_fs_trace
,
1076 struct ctf_clock_class
*default_cc
,
1077 struct ctf_fs_ds_index_entry
*index_entry
,
1078 enum target_event target_event
, uint64_t *cs
,
1081 enum ctf_msg_iter_status iter_status
= CTF_MSG_ITER_STATUS_OK
;
1082 ctf_msg_iter_up msg_iter
;
1085 BT_ASSERT(ctf_fs_trace
);
1086 BT_ASSERT(index_entry
);
1087 BT_ASSERT(index_entry
->path
);
1089 const auto ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, bt2::Stream::Shared
{},
1090 index_entry
->path
, ctf_fs_trace
->logger
);
1092 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to create a ctf_fs_ds_file");
1097 BT_ASSERT(ctf_fs_trace
->metadata
);
1098 BT_ASSERT(ctf_fs_trace
->metadata
->tc
);
1100 msg_iter
= ctf_msg_iter_create(
1101 ctf_fs_trace
->metadata
->tc
,
1102 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
1103 ctf_fs_ds_file_medops
, ds_file
.get(), NULL
, ctf_fs_trace
->logger
);
1105 /* ctf_msg_iter_create() logs errors. */
1111 * Turn on dry run mode to prevent the creation and usage of Babeltrace
1112 * library objects (bt_field, bt_message_*, etc.).
1114 ctf_msg_iter_set_dry_run(msg_iter
.get(), true);
1116 /* Seek to the beginning of the target packet. */
1117 iter_status
= ctf_msg_iter_seek(msg_iter
.get(), index_entry
->offset
.bytes());
1119 /* ctf_msg_iter_seek() logs errors. */
1124 switch (target_event
) {
1127 * Start to decode the packet until we reach the end of
1128 * the first event. To extract the first event's clock
1131 iter_status
= ctf_msg_iter_curr_packet_first_event_clock_snapshot(msg_iter
.get(), cs
);
1134 /* Decode the packet to extract the last event's clock snapshot. */
1135 iter_status
= ctf_msg_iter_curr_packet_last_event_clock_snapshot(msg_iter
.get(), cs
);
1145 /* Convert clock snapshot to timestamp. */
1146 ret
= bt_util_clock_cycles_to_ns_from_origin(
1147 *cs
, default_cc
->frequency
, default_cc
->offset_seconds
, default_cc
->offset_cycles
, ts_ns
);
1149 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1150 "Failed to convert clock snapshot to timestamp");
1158 static int decode_packet_first_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1159 struct ctf_clock_class
*default_cc
,
1160 struct ctf_fs_ds_index_entry
*index_entry
,
1161 uint64_t *cs
, int64_t *ts_ns
)
1163 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, FIRST_EVENT
, cs
,
1167 static int decode_packet_last_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1168 struct ctf_clock_class
*default_cc
,
1169 struct ctf_fs_ds_index_entry
*index_entry
,
1170 uint64_t *cs
, int64_t *ts_ns
)
1172 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, LAST_EVENT
, cs
,
1177 * Fix up packet index entries for lttng's "event-after-packet" bug.
1178 * Some buggy lttng tracer versions may emit events with a timestamp that is
1179 * larger (after) than the timestamp_end of the their packets.
1181 * To fix up this erroneous data we do the following:
1182 * 1. If it's not the stream file's last packet: set the packet index entry's
1183 * end time to the next packet's beginning time.
1184 * 2. If it's the stream file's last packet, set the packet index entry's end
1185 * time to the packet's last event's time, if any, or to the packet's
1186 * beginning time otherwise.
1188 * Known buggy tracer versions:
1189 * - before lttng-ust 2.11.0
1190 * - before lttng-module 2.11.0
1191 * - before lttng-module 2.10.10
1192 * - before lttng-module 2.9.13
1194 static int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace
*trace
)
1198 for (const auto& ds_file_group
: trace
->ds_file_groups
) {
1199 struct ctf_clock_class
*default_cc
;
1201 BT_ASSERT(ds_file_group
);
1202 const auto index
= ds_file_group
->index
.get();
1205 BT_ASSERT(!index
->entries
.empty());
1208 * Iterate over all entries but the last one. The last one is
1209 * fixed differently after.
1211 for (size_t entry_i
= 0; entry_i
< index
->entries
.size() - 1; ++entry_i
) {
1212 ctf_fs_ds_index_entry
*curr_entry
= index
->entries
[entry_i
].get();
1213 ctf_fs_ds_index_entry
*next_entry
= index
->entries
[entry_i
+ 1].get();
1216 * 1. Set the current index entry `end` timestamp to
1217 * the next index entry `begin` timestamp.
1219 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1220 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1224 * 2. Fix the last entry by decoding the last event of the last
1227 const auto last_entry
= index
->entries
.back().get();
1228 BT_ASSERT(last_entry
);
1230 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1231 default_cc
= ds_file_group
->sc
->default_clock_class
;
1234 * Decode packet to read the timestamp of the last event of the
1237 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1238 &last_entry
->timestamp_end
,
1239 &last_entry
->timestamp_end_ns
);
1241 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1243 "Failed to decode stream's last packet to get its last event's clock snapshot.");
1253 * Fix up packet index entries for barectf's "event-before-packet" bug.
1254 * Some buggy barectf tracer versions may emit events with a timestamp that is
1255 * less than the timestamp_begin of the their packets.
1257 * To fix up this erroneous data we do the following:
1258 * 1. Starting at the second index entry, set the timestamp_begin of the
1259 * current entry to the timestamp of the first event of the packet.
1260 * 2. Set the previous entry's timestamp_end to the timestamp_begin of the
1263 * Known buggy tracer versions:
1264 * - before barectf 2.3.1
1266 static int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace
*trace
)
1270 for (const auto& ds_file_group
: trace
->ds_file_groups
) {
1271 struct ctf_clock_class
*default_cc
;
1272 const auto index
= ds_file_group
->index
.get();
1275 BT_ASSERT(!index
->entries
.empty());
1277 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1278 default_cc
= ds_file_group
->sc
->default_clock_class
;
1281 * 1. Iterate over the index, starting from the second entry
1284 for (size_t entry_i
= 1; entry_i
< index
->entries
.size(); ++entry_i
) {
1285 ctf_fs_ds_index_entry
*prev_entry
= index
->entries
[entry_i
- 1].get();
1286 ctf_fs_ds_index_entry
*curr_entry
= index
->entries
[entry_i
].get();
1288 * 2. Set the current entry `begin` timestamp to the
1289 * timestamp of the first event of the current packet.
1291 ret
= decode_packet_first_event_timestamp(trace
, default_cc
, curr_entry
,
1292 &curr_entry
->timestamp_begin
,
1293 &curr_entry
->timestamp_begin_ns
);
1295 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1296 "Failed to decode first event's clock snapshot");
1301 * 3. Set the previous entry `end` timestamp to the
1302 * timestamp of the first event of the current packet.
1304 prev_entry
->timestamp_end
= curr_entry
->timestamp_begin
;
1305 prev_entry
->timestamp_end_ns
= curr_entry
->timestamp_begin_ns
;
1313 * When using the lttng-crash feature it's likely that the last packets of each
1314 * stream have their timestamp_end set to zero. This is caused by the fact that
1315 * the tracer crashed and was not able to properly close the packets.
1317 * To fix up this erroneous data we do the following:
1318 * For each index entry, if the entry's timestamp_end is 0 and the
1319 * timestamp_begin is not 0:
1320 * - If it's the stream file's last packet: set the packet index entry's end
1321 * time to the packet's last event's time, if any, or to the packet's
1322 * beginning time otherwise.
1323 * - If it's not the stream file's last packet: set the packet index
1324 * entry's end time to the next packet's beginning time.
1326 * Affected versions:
1327 * - All current and future lttng-ust and lttng-modules versions.
1329 static int fix_index_lttng_crash_quirk(struct ctf_fs_trace
*trace
)
1333 for (const auto& ds_file_group
: trace
->ds_file_groups
) {
1334 struct ctf_clock_class
*default_cc
;
1336 BT_ASSERT(ds_file_group
);
1337 const auto index
= ds_file_group
->index
.get();
1339 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1340 default_cc
= ds_file_group
->sc
->default_clock_class
;
1343 BT_ASSERT(!index
->entries
.empty());
1345 const auto last_entry
= index
->entries
.back().get();
1346 BT_ASSERT(last_entry
);
1348 /* 1. Fix the last entry first. */
1349 if (last_entry
->timestamp_end
== 0 && last_entry
->timestamp_begin
!= 0) {
1351 * Decode packet to read the timestamp of the
1352 * last event of the stream file.
1354 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1355 &last_entry
->timestamp_end
,
1356 &last_entry
->timestamp_end_ns
);
1358 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1359 "Failed to decode last event's clock snapshot");
1364 /* Iterate over all entries but the last one. */
1365 for (size_t entry_idx
= 0; entry_idx
< index
->entries
.size() - 1; ++entry_idx
) {
1366 ctf_fs_ds_index_entry
*curr_entry
= index
->entries
[entry_idx
].get();
1367 ctf_fs_ds_index_entry
*next_entry
= index
->entries
[entry_idx
+ 1].get();
1369 if (curr_entry
->timestamp_end
== 0 && curr_entry
->timestamp_begin
!= 0) {
1371 * 2. Set the current index entry `end` timestamp to
1372 * the next index entry `begin` timestamp.
1374 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1375 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1385 * Extract the tracer information necessary to compare versions.
1386 * Returns 0 on success, and -1 if the extraction is not successful because the
1387 * necessary fields are absents in the trace metadata.
1389 static int extract_tracer_info(struct ctf_fs_trace
*trace
, struct tracer_info
*current_tracer_info
)
1392 struct ctf_trace_class_env_entry
*entry
;
1394 /* Clear the current_tracer_info struct */
1395 memset(current_tracer_info
, 0, sizeof(*current_tracer_info
));
1398 * To compare 2 tracer versions, at least the tracer name and it's
1399 * major version are needed. If one of these is missing, consider it an
1400 * extraction failure.
1402 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_name");
1403 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR
) {
1404 goto missing_bare_minimum
;
1407 /* Set tracer name. */
1408 current_tracer_info
->name
= entry
->value
.str
->str
;
1410 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_major");
1411 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1412 goto missing_bare_minimum
;
1415 /* Set major version number. */
1416 current_tracer_info
->major
= entry
->value
.i
;
1418 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_minor");
1419 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1423 /* Set minor version number. */
1424 current_tracer_info
->minor
= entry
->value
.i
;
1426 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patch");
1429 * If `tracer_patch` doesn't exist `tracer_patchlevel` might.
1430 * For example, `lttng-modules` uses entry name
1431 * `tracer_patchlevel`.
1433 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patchlevel");
1436 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1440 /* Set patch version number. */
1441 current_tracer_info
->patch
= entry
->value
.i
;
1445 missing_bare_minimum
:
1451 static bool is_tracer_affected_by_lttng_event_after_packet_bug(struct tracer_info
*curr_tracer_info
)
1453 bool is_affected
= false;
1455 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1456 if (curr_tracer_info
->major
< 2) {
1458 } else if (curr_tracer_info
->major
== 2) {
1459 /* fixed in lttng-ust 2.11.0 */
1460 if (curr_tracer_info
->minor
< 11) {
1464 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1465 if (curr_tracer_info
->major
< 2) {
1467 } else if (curr_tracer_info
->major
== 2) {
1468 /* fixed in lttng-modules 2.11.0 */
1469 if (curr_tracer_info
->minor
== 10) {
1470 /* fixed in lttng-modules 2.10.10 */
1471 if (curr_tracer_info
->patch
< 10) {
1474 } else if (curr_tracer_info
->minor
== 9) {
1475 /* fixed in lttng-modules 2.9.13 */
1476 if (curr_tracer_info
->patch
< 13) {
1479 } else if (curr_tracer_info
->minor
< 9) {
1489 is_tracer_affected_by_barectf_event_before_packet_bug(struct tracer_info
*curr_tracer_info
)
1491 bool is_affected
= false;
1493 if (strcmp(curr_tracer_info
->name
, "barectf") == 0) {
1494 if (curr_tracer_info
->major
< 2) {
1496 } else if (curr_tracer_info
->major
== 2) {
1497 if (curr_tracer_info
->minor
< 3) {
1499 } else if (curr_tracer_info
->minor
== 3) {
1500 /* fixed in barectf 2.3.1 */
1501 if (curr_tracer_info
->patch
< 1) {
1511 static bool is_tracer_affected_by_lttng_crash_quirk(struct tracer_info
*curr_tracer_info
)
1513 bool is_affected
= false;
1515 /* All LTTng tracer may be affected by this lttng crash quirk. */
1516 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1518 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1526 * Looks for trace produced by known buggy tracers and fix up the index
1529 static int fix_packet_index_tracer_bugs(ctf_fs_trace
*trace
)
1532 struct tracer_info current_tracer_info
;
1534 ret
= extract_tracer_info(trace
, ¤t_tracer_info
);
1537 * A trace may not have all the necessary environment
1538 * entries to do the tracer version comparison.
1539 * At least, the tracer name and major version number
1540 * are needed. Failing to extract these entries is not
1544 BT_CPPLOGI_STR_SPEC(
1546 "Cannot extract tracer information necessary to compare with buggy versions.");
1550 /* Check if the trace may be affected by old tracer bugs. */
1551 if (is_tracer_affected_by_lttng_event_after_packet_bug(¤t_tracer_info
)) {
1552 BT_CPPLOGI_STR_SPEC(
1554 "Trace may be affected by LTTng tracer packet timestamp bug. Fixing up.");
1555 ret
= fix_index_lttng_event_after_packet_bug(trace
);
1557 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1558 "Failed to fix LTTng event-after-packet bug.");
1561 trace
->metadata
->tc
->quirks
.lttng_event_after_packet
= true;
1564 if (is_tracer_affected_by_barectf_event_before_packet_bug(¤t_tracer_info
)) {
1565 BT_CPPLOGI_STR_SPEC(
1567 "Trace may be affected by barectf tracer packet timestamp bug. Fixing up.");
1568 ret
= fix_index_barectf_event_before_packet_bug(trace
);
1570 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1571 "Failed to fix barectf event-before-packet bug.");
1574 trace
->metadata
->tc
->quirks
.barectf_event_before_packet
= true;
1577 if (is_tracer_affected_by_lttng_crash_quirk(¤t_tracer_info
)) {
1578 ret
= fix_index_lttng_crash_quirk(trace
);
1580 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1581 "Failed to fix lttng-crash timestamp quirks.");
1584 trace
->metadata
->tc
->quirks
.lttng_crash
= true;
1591 static bool compare_ds_file_groups_by_first_path(const ctf_fs_ds_file_group::UP
& ds_file_group_a
,
1592 const ctf_fs_ds_file_group::UP
& ds_file_group_b
)
1594 BT_ASSERT(!ds_file_group_a
->ds_file_infos
.empty());
1595 BT_ASSERT(!ds_file_group_b
->ds_file_infos
.empty());
1597 const auto& first_ds_file_info_a
= *ds_file_group_a
->ds_file_infos
[0];
1598 const auto& first_ds_file_info_b
= *ds_file_group_b
->ds_file_infos
[0];
1600 return first_ds_file_info_a
.path
< first_ds_file_info_b
.path
;
1603 static gint
compare_strings(gconstpointer p_a
, gconstpointer p_b
)
1605 const char *a
= *((const char **) p_a
);
1606 const char *b
= *((const char **) p_b
);
1608 return strcmp(a
, b
);
1611 int ctf_fs_component_create_ctf_fs_trace(struct ctf_fs_component
*ctf_fs
,
1612 const bt_value
*paths_value
,
1613 const bt_value
*trace_name_value
,
1614 bt_self_component
*selfComp
)
1618 GPtrArray
*paths
= NULL
;
1619 std::vector
<ctf_fs_trace::UP
> traces
;
1620 const char *trace_name
;
1622 BT_ASSERT(bt_value_get_type(paths_value
) == BT_VALUE_TYPE_ARRAY
);
1623 BT_ASSERT(!bt_value_array_is_empty(paths_value
));
1625 paths
= g_ptr_array_new_with_free_func(g_free
);
1627 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to allocate a GPtrArray.");
1631 trace_name
= trace_name_value
? bt_value_string_get(trace_name_value
) : NULL
;
1634 * Create a sorted array of the paths, to make the execution of this
1635 * component deterministic.
1637 for (i
= 0; i
< bt_value_array_get_length(paths_value
); i
++) {
1638 const bt_value
*path_value
= bt_value_array_borrow_element_by_index_const(paths_value
, i
);
1639 const char *input
= bt_value_string_get(path_value
);
1642 input_copy
= g_strdup(input
);
1644 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to copy a string.");
1648 g_ptr_array_add(paths
, input_copy
);
1651 g_ptr_array_sort(paths
, compare_strings
);
1653 /* Create a separate ctf_fs_trace object for each path. */
1654 for (i
= 0; i
< paths
->len
; i
++) {
1655 const char *path
= (const char *) g_ptr_array_index(paths
, i
);
1657 ret
= ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs
, path
, trace_name
, traces
,
1664 if (traces
.size() > 1) {
1665 ctf_fs_trace
*first_trace
= traces
[0].get();
1666 const uint8_t *first_trace_uuid
= first_trace
->metadata
->tc
->uuid
;
1669 * We have more than one trace, they must all share the same
1670 * UUID, verify that.
1672 for (i
= 0; i
< traces
.size(); i
++) {
1673 ctf_fs_trace
*this_trace
= traces
[i
].get();
1674 const uint8_t *this_trace_uuid
= this_trace
->metadata
->tc
->uuid
;
1676 if (!this_trace
->metadata
->tc
->is_uuid_set
) {
1677 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1679 "Multiple traces given, but a trace does not have a UUID: path={}",
1680 this_trace
->path
->str
);
1684 if (bt_uuid_compare(first_trace_uuid
, this_trace_uuid
) != 0) {
1685 char first_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1686 char this_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1688 bt_uuid_to_str(first_trace_uuid
, first_trace_uuid_str
);
1689 bt_uuid_to_str(this_trace_uuid
, this_trace_uuid_str
);
1691 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1692 "Multiple traces given, but UUIDs don't match: "
1693 "first-trace-uuid={}, first-trace-path={}, "
1694 "trace-uuid={}, trace-path={}",
1695 first_trace_uuid_str
, first_trace
->path
->str
,
1696 this_trace_uuid_str
, this_trace
->path
->str
);
1701 ret
= merge_ctf_fs_traces(std::move(traces
), ctf_fs
->trace
);
1703 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1704 "Failed to merge traces with the same UUID.");
1708 /* Just one trace, it may or may not have a UUID, both are fine. */
1709 ctf_fs
->trace
= std::move(traces
[0]);
1712 ret
= fix_packet_index_tracer_bugs(ctf_fs
->trace
.get());
1714 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to fix packet index tracer bugs.");
1718 * Sort data stream file groups by first data stream file info
1719 * path to get a deterministic order. This order influences the
1720 * order of the output ports. It also influences the order of
1721 * the automatic stream IDs if the trace's packet headers do not
1722 * contain a `stream_instance_id` field, in which case the data
1723 * stream file to stream ID association is always the same,
1724 * whatever the build and the system.
1726 * Having a deterministic order here can help debugging and
1729 std::sort(ctf_fs
->trace
->ds_file_groups
.begin(), ctf_fs
->trace
->ds_file_groups
.end(),
1730 compare_ds_file_groups_by_first_path
);
1737 g_ptr_array_free(paths
, TRUE
);
1743 static GString
*get_stream_instance_unique_name(struct ctf_fs_ds_file_group
*ds_file_group
)
1746 struct ctf_fs_ds_file_info
*ds_file_info
;
1748 name
= g_string_new(NULL
);
1754 * If there's more than one stream file in the stream file
1755 * group, the first (earliest) stream file's path is used as
1756 * the stream's unique name.
1758 BT_ASSERT(!ds_file_group
->ds_file_infos
.empty());
1759 ds_file_info
= ds_file_group
->ds_file_infos
[0].get();
1760 g_string_assign(name
, ds_file_info
->path
.c_str());
1766 /* Create the IR stream objects for ctf_fs_trace. */
1768 static int create_streams_for_trace(struct ctf_fs_trace
*ctf_fs_trace
)
1771 GString
*name
= NULL
;
1773 for (const auto& ds_file_group
: ctf_fs_trace
->ds_file_groups
) {
1774 name
= get_stream_instance_unique_name(ds_file_group
.get());
1780 BT_ASSERT(ds_file_group
->sc
->ir_sc
);
1781 BT_ASSERT(ctf_fs_trace
->trace
);
1785 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
1786 /* No stream ID: use 0 */
1788 bt_stream_create_with_id(ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
->libObjPtr(),
1789 ctf_fs_trace
->next_stream_id
);
1790 ctf_fs_trace
->next_stream_id
++;
1792 /* Specific stream ID */
1794 bt_stream_create_with_id(ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
->libObjPtr(),
1795 (uint64_t) ds_file_group
->stream_id
);
1799 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1800 "Cannot create stream for DS file group: "
1801 "addr={}, stream-name=\"{}\"",
1802 fmt::ptr(ds_file_group
), name
->str
);
1806 ds_file_group
->stream
= bt2::Stream::Shared::createWithoutRef(stream
);
1808 ret
= bt_stream_set_name(ds_file_group
->stream
->libObjPtr(), name
->str
);
1810 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1811 "Cannot set stream's name: "
1812 "addr={}, stream-name=\"{}\"",
1813 fmt::ptr(ds_file_group
->stream
->libObjPtr()), name
->str
);
1817 g_string_free(name
, TRUE
);
1830 g_string_free(name
, TRUE
);
1835 static const bt_param_validation_value_descr inputs_elem_descr
=
1836 bt_param_validation_value_descr::makeString();
1838 static bt_param_validation_map_value_entry_descr fs_params_entries_descr
[] = {
1839 {"inputs", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
1840 bt_param_validation_value_descr::makeArray(1, BT_PARAM_VALIDATION_INFINITE
,
1841 inputs_elem_descr
)},
1842 {"trace-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1843 bt_param_validation_value_descr::makeString()},
1844 {"clock-class-offset-s", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1845 bt_param_validation_value_descr::makeSignedInteger()},
1846 {"clock-class-offset-ns", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1847 bt_param_validation_value_descr::makeSignedInteger()},
1848 {"force-clock-class-origin-unix-epoch", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1849 bt_param_validation_value_descr::makeBool()},
1850 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
1852 bool read_src_fs_parameters(const bt_value
*params
, const bt_value
**inputs
,
1853 const bt_value
**trace_name
, struct ctf_fs_component
*ctf_fs
)
1856 const bt_value
*value
;
1857 enum bt_param_validation_status validate_value_status
;
1858 gchar
*error
= NULL
;
1860 validate_value_status
= bt_param_validation_validate(params
, fs_params_entries_descr
, &error
);
1861 if (validate_value_status
!= BT_PARAM_VALIDATION_STATUS_OK
) {
1862 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "{}", error
);
1867 /* inputs parameter */
1868 *inputs
= bt_value_map_borrow_entry_value_const(params
, "inputs");
1870 /* clock-class-offset-s parameter */
1871 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-s");
1873 ctf_fs
->clkClsCfg
.offsetSec
= bt_value_integer_signed_get(value
);
1876 /* clock-class-offset-ns parameter */
1877 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-ns");
1879 ctf_fs
->clkClsCfg
.offsetNanoSec
= bt_value_integer_signed_get(value
);
1882 /* force-clock-class-origin-unix-epoch parameter */
1883 value
= bt_value_map_borrow_entry_value_const(params
, "force-clock-class-origin-unix-epoch");
1885 ctf_fs
->clkClsCfg
.forceOriginIsUnixEpoch
= bt_value_bool_get(value
);
1888 /* trace-name parameter */
1889 *trace_name
= bt_value_map_borrow_entry_value_const(params
, "trace-name");
1898 static ctf_fs_component::UP
ctf_fs_create(const bt_value
*params
,
1899 bt_self_component_source
*self_comp_src
)
1901 const bt_value
*inputs_value
;
1902 const bt_value
*trace_name_value
;
1903 bt_self_component
*self_comp
= bt_self_component_source_as_self_component(self_comp_src
);
1905 ctf_fs_component::UP ctf_fs
= ctf_fs_component_create(
1906 bt2c::Logger
{bt2::SelfSourceComponent
{self_comp_src
}, "PLUGIN/SRC.CTF.FS/COMP"});
1911 if (!read_src_fs_parameters(params
, &inputs_value
, &trace_name_value
, ctf_fs
.get())) {
1915 if (ctf_fs_component_create_ctf_fs_trace(ctf_fs
.get(), inputs_value
, trace_name_value
,
1920 if (create_streams_for_trace(ctf_fs
->trace
.get())) {
1924 if (create_ports_for_trace(ctf_fs
.get(), ctf_fs
->trace
.get(), self_comp_src
)) {
1931 bt_component_class_initialize_method_status
ctf_fs_init(bt_self_component_source
*self_comp_src
,
1932 bt_self_component_source_configuration
*,
1933 const bt_value
*params
, void *)
1936 bt_component_class_initialize_method_status ret
=
1937 BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
1939 ctf_fs_component::UP ctf_fs
= ctf_fs_create(params
, self_comp_src
);
1941 ret
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1944 bt_self_component_set_data(bt_self_component_source_as_self_component(self_comp_src
),
1947 } catch (const std::bad_alloc
&) {
1948 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1949 } catch (const bt2::Error
&) {
1950 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1954 bt_component_class_query_method_status
ctf_fs_query(bt_self_component_class_source
*comp_class_src
,
1955 bt_private_query_executor
*priv_query_exec
,
1956 const char *object
, const bt_value
*params
,
1957 __attribute__((unused
)) void *method_data
,
1958 const bt_value
**result
)
1961 bt2c::Logger logger
{bt2::SelfComponentClass
{comp_class_src
},
1962 bt2::PrivateQueryExecutor
{priv_query_exec
},
1963 "PLUGIN/SRC.CTF.FS/QUERY"};
1964 bt2::ConstMapValue
paramsObj(params
);
1965 bt2::Value::Shared resultObj
;
1967 if (strcmp(object
, "metadata-info") == 0) {
1968 resultObj
= metadata_info_query(paramsObj
, logger
);
1969 } else if (strcmp(object
, "babeltrace.trace-infos") == 0) {
1970 resultObj
= trace_infos_query(paramsObj
, logger
);
1971 } else if (!strcmp(object
, "babeltrace.support-info")) {
1972 resultObj
= support_info_query(paramsObj
, logger
);
1974 BT_CPPLOGE_SPEC(logger
, "Unknown query object `{}`", object
);
1975 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;
1978 *result
= resultObj
.release().libObjPtr();
1980 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
1981 } catch (const std::bad_alloc
&) {
1982 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
1983 } catch (const bt2::Error
&) {
1984 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;