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 void ctf_fs_msg_iter_data_destroy(struct ctf_fs_msg_iter_data
*msg_iter_data
)
44 if (msg_iter_data
->msg_iter
) {
45 ctf_msg_iter_destroy(msg_iter_data
->msg_iter
);
51 static bt_message_iterator_class_next_method_status
52 ctf_fs_iterator_next_one(struct ctf_fs_msg_iter_data
*msg_iter_data
, const bt_message
**out_msg
)
54 bt_message_iterator_class_next_method_status status
;
55 enum ctf_msg_iter_status msg_iter_status
;
57 msg_iter_status
= ctf_msg_iter_get_next_message(msg_iter_data
->msg_iter
, out_msg
);
59 switch (msg_iter_status
) {
60 case CTF_MSG_ITER_STATUS_OK
:
61 /* Cool, message has been written to *out_msg. */
62 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
65 case CTF_MSG_ITER_STATUS_EOF
:
66 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END
;
69 case CTF_MSG_ITER_STATUS_AGAIN
:
71 * Should not make it this far as this is
72 * medium-specific; there is nothing for the user to do
73 * and it should have been handled upstream.
77 case CTF_MSG_ITER_STATUS_ERROR
:
78 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
79 "Failed to get next message from CTF message iterator.");
80 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
83 case CTF_MSG_ITER_STATUS_MEMORY_ERROR
:
84 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
85 "Failed to get next message from CTF message iterator.");
86 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
96 bt_message_iterator_class_next_method_status
97 ctf_fs_iterator_next(bt_self_message_iterator
*iterator
, bt_message_array_const msgs
,
98 uint64_t capacity
, uint64_t *count
)
101 bt_message_iterator_class_next_method_status status
;
102 struct ctf_fs_msg_iter_data
*msg_iter_data
=
103 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(iterator
);
106 if (G_UNLIKELY(msg_iter_data
->next_saved_error
)) {
108 * Last time we were called, we hit an error but had some
109 * messages to deliver, so we stashed the error here. Return
112 BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(msg_iter_data
->next_saved_error
);
113 status
= msg_iter_data
->next_saved_status
;
118 status
= ctf_fs_iterator_next_one(msg_iter_data
, &msgs
[i
]);
119 if (status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
) {
122 } while (i
< capacity
&& status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
);
126 * Even if ctf_fs_iterator_next_one() returned something
127 * else than BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK, we
128 * accumulated message objects in the output
129 * message array, so we need to return
130 * BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK so that they are
131 * transferred to downstream. This other status occurs
132 * again the next time muxer_msg_iter_do_next() is
133 * called, possibly without any accumulated
134 * message, in which case we'll return it.
138 * Save this error for the next _next call. Assume that
139 * this component always appends error causes when
140 * returning an error status code, which will cause the
141 * current thread error to be non-NULL.
143 msg_iter_data
->next_saved_error
= bt_current_thread_take_error();
144 BT_ASSERT(msg_iter_data
->next_saved_error
);
145 msg_iter_data
->next_saved_status
= status
;
149 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
155 } catch (const std::bad_alloc
&) {
156 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
157 } catch (const bt2::Error
&) {
158 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
162 bt_message_iterator_class_seek_beginning_method_status
163 ctf_fs_iterator_seek_beginning(bt_self_message_iterator
*it
)
166 struct ctf_fs_msg_iter_data
*msg_iter_data
=
167 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(it
);
169 BT_ASSERT(msg_iter_data
);
171 ctf_msg_iter_reset(msg_iter_data
->msg_iter
);
172 ctf_fs_ds_group_medops_data_reset(msg_iter_data
->msg_iter_medops_data
.get());
174 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_OK
;
175 } catch (const std::bad_alloc
&) {
176 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_MEMORY_ERROR
;
177 } catch (const bt2::Error
&) {
178 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_ERROR
;
182 void ctf_fs_iterator_finalize(bt_self_message_iterator
*it
)
184 ctf_fs_msg_iter_data_destroy(
185 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(it
));
188 static bt_message_iterator_class_initialize_method_status
189 ctf_msg_iter_medium_status_to_msg_iter_initialize_status(enum ctf_msg_iter_medium_status status
)
192 case CTF_MSG_ITER_MEDIUM_STATUS_EOF
:
193 case CTF_MSG_ITER_MEDIUM_STATUS_AGAIN
:
194 case CTF_MSG_ITER_MEDIUM_STATUS_ERROR
:
195 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
196 case CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
:
197 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
198 case CTF_MSG_ITER_MEDIUM_STATUS_OK
:
199 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
205 bt_message_iterator_class_initialize_method_status
206 ctf_fs_iterator_init(bt_self_message_iterator
*self_msg_iter
,
207 bt_self_message_iterator_configuration
*config
,
208 bt_self_component_port_output
*self_port
)
211 struct ctf_fs_port_data
*port_data
;
212 bt_message_iterator_class_initialize_method_status status
;
213 enum ctf_msg_iter_medium_status medium_status
;
215 port_data
= (struct ctf_fs_port_data
*) bt_self_component_port_get_data(
216 bt_self_component_port_output_as_self_component_port(self_port
));
217 BT_ASSERT(port_data
);
219 ctf_fs_msg_iter_data
*msg_iter_data
= new ctf_fs_msg_iter_data
{self_msg_iter
};
220 msg_iter_data
->ds_file_group
= port_data
->ds_file_group
;
222 medium_status
= ctf_fs_ds_group_medops_data_create(msg_iter_data
->ds_file_group
,
223 self_msg_iter
, msg_iter_data
->logger
,
224 msg_iter_data
->msg_iter_medops_data
);
225 BT_ASSERT(medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_OK
||
226 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_ERROR
||
227 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
);
228 if (medium_status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
229 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
230 "Failed to create ctf_fs_ds_group_medops");
231 status
= ctf_msg_iter_medium_status_to_msg_iter_initialize_status(medium_status
);
235 msg_iter_data
->msg_iter
= ctf_msg_iter_create(
236 msg_iter_data
->ds_file_group
->ctf_fs_trace
->metadata
->tc
,
237 bt_common_get_page_size(static_cast<int>(msg_iter_data
->logger
.level())) * 8,
238 ctf_fs_ds_group_medops
, msg_iter_data
->msg_iter_medops_data
.get(), self_msg_iter
,
239 msg_iter_data
->logger
);
240 if (!msg_iter_data
->msg_iter
) {
241 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
242 "Cannot create a CTF message iterator.");
243 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
248 * This iterator can seek forward if its stream class has a default
251 if (msg_iter_data
->ds_file_group
->sc
->default_clock_class
) {
252 bt_self_message_iterator_configuration_set_can_seek_forward(config
, true);
255 bt_self_message_iterator_set_data(self_msg_iter
, msg_iter_data
);
256 msg_iter_data
= NULL
;
258 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
262 bt_self_message_iterator_set_data(self_msg_iter
, NULL
);
265 ctf_fs_msg_iter_data_destroy(msg_iter_data
);
267 } catch (const std::bad_alloc
&) {
268 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
269 } catch (const bt2::Error
&) {
270 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
274 static void ctf_fs_trace_destroy(struct ctf_fs_trace
*ctf_fs_trace
)
280 BT_TRACE_PUT_REF_AND_RESET(ctf_fs_trace
->trace
);
282 if (ctf_fs_trace
->path
) {
283 g_string_free(ctf_fs_trace
->path
, TRUE
);
286 if (ctf_fs_trace
->metadata
) {
287 ctf_fs_metadata_fini(ctf_fs_trace
->metadata
);
288 delete ctf_fs_trace
->metadata
;
294 void ctf_fs_trace_deleter::operator()(ctf_fs_trace
* const trace
) noexcept
296 ctf_fs_trace_destroy(trace
);
299 ctf_fs_component::UP
ctf_fs_component_create(const bt2c::Logger
& parentLogger
)
301 return bt2s::make_unique
<ctf_fs_component
>(parentLogger
);
304 void ctf_fs_finalize(bt_self_component_source
*component
)
306 ctf_fs_component::UP
{static_cast<ctf_fs_component
*>(
307 bt_self_component_get_data(bt_self_component_source_as_self_component(component
)))};
310 bt2c::GCharUP
ctf_fs_make_port_name(struct ctf_fs_ds_file_group
*ds_file_group
)
312 GString
*name
= g_string_new(NULL
);
315 * The unique port name is generated by concatenating unique identifiers
323 /* For the trace, use the uuid if present, else the path. */
324 if (ds_file_group
->ctf_fs_trace
->metadata
->tc
->is_uuid_set
) {
325 char uuid_str
[BT_UUID_STR_LEN
+ 1];
327 bt_uuid_to_str(ds_file_group
->ctf_fs_trace
->metadata
->tc
->uuid
, uuid_str
);
328 g_string_assign(name
, uuid_str
);
330 g_string_assign(name
, ds_file_group
->ctf_fs_trace
->path
->str
);
334 * For the stream class, use the id if present. We can omit this field
335 * otherwise, as there will only be a single stream class.
337 if (ds_file_group
->sc
->id
!= UINT64_C(-1)) {
338 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->sc
->id
);
341 /* For the stream, use the id if present, else, use the path. */
342 if (ds_file_group
->stream_id
!= UINT64_C(-1)) {
343 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->stream_id
);
345 BT_ASSERT(ds_file_group
->ds_file_infos
.size() == 1);
346 const auto& ds_file_info
= *ds_file_group
->ds_file_infos
[0];
347 g_string_append_printf(name
, " | %s", ds_file_info
.path
.c_str());
350 return bt2c::GCharUP
{g_string_free(name
, FALSE
)};
353 static int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
354 struct ctf_fs_ds_file_group
*ds_file_group
,
355 bt_self_component_source
*self_comp_src
)
358 ctf_fs_port_data::UP port_data
;
360 bt2c::GCharUP port_name
= ctf_fs_make_port_name(ds_file_group
);
365 BT_CPPLOGI_SPEC(ctf_fs
->logger
, "Creating one port named `{}`", port_name
.get());
367 /* Create output port for this file */
368 port_data
= bt2s::make_unique
<ctf_fs_port_data
>();
369 port_data
->ctf_fs
= ctf_fs
;
370 port_data
->ds_file_group
= ds_file_group
;
371 ret
= bt_self_component_source_add_output_port(self_comp_src
, port_name
.get(), port_data
.get(),
377 ctf_fs
->port_data
.emplace_back(std::move(port_data
));
387 static int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
388 struct ctf_fs_trace
*ctf_fs_trace
,
389 bt_self_component_source
*self_comp_src
)
393 /* Create one output port for each stream file group */
394 for (const auto& ds_file_group
: ctf_fs_trace
->ds_file_groups
) {
395 ret
= create_one_port_for_trace(ctf_fs
, ds_file_group
.get(), self_comp_src
);
397 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create output port.");
407 * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right
408 * place to keep it sorted.
411 static void ds_file_group_insert_ds_file_info_sorted(struct ctf_fs_ds_file_group
*ds_file_group
,
412 ctf_fs_ds_file_info::UP ds_file_info
)
414 /* Find the spot where to insert this ds_file_info. */
415 auto it
= ds_file_group
->ds_file_infos
.begin();
417 for (; it
!= ds_file_group
->ds_file_infos
.end(); ++it
) {
418 const ctf_fs_ds_file_info
& other_ds_file_info
= **it
;
420 if (ds_file_info
->begin_ns
< other_ds_file_info
.begin_ns
) {
425 ds_file_group
->ds_file_infos
.insert(it
, std::move(ds_file_info
));
428 static bool ds_index_entries_equal(const struct ctf_fs_ds_index_entry
*left
,
429 const struct ctf_fs_ds_index_entry
*right
)
431 if (left
->packetSize
!= right
->packetSize
) {
435 if (left
->timestamp_begin
!= right
->timestamp_begin
) {
439 if (left
->timestamp_end
!= right
->timestamp_end
) {
443 if (left
->packet_seq_num
!= right
->packet_seq_num
) {
451 * Insert `entry` into `index`, without duplication.
453 * The entry is inserted only if there isn't an identical entry already.
455 * In any case, the ownership of `entry` is transferred to this function. So if
456 * the entry is not inserted, it is freed.
459 static void ds_index_insert_ds_index_entry_sorted(struct ctf_fs_ds_index
*index
,
460 ctf_fs_ds_index_entry::UP entry
)
462 /* Find the spot where to insert this index entry. */
463 auto otherEntry
= index
->entries
.begin();
464 for (; otherEntry
!= index
->entries
.end(); ++otherEntry
) {
465 if (entry
->timestamp_begin_ns
<= (*otherEntry
)->timestamp_begin_ns
) {
471 * Insert the entry only if a duplicate doesn't already exist.
473 * There can be duplicate packets if reading multiple overlapping
474 * snapshots of the same trace. We then want the index to contain
475 * a reference to only one copy of that packet.
477 if (otherEntry
== index
->entries
.end() ||
478 !ds_index_entries_equal(entry
.get(), otherEntry
->get())) {
479 index
->entries
.insert(otherEntry
, std::move(entry
));
483 static void merge_ctf_fs_ds_indexes(struct ctf_fs_ds_index
*dest
, ctf_fs_ds_index::UP src
)
485 for (auto& entry
: src
->entries
) {
486 ds_index_insert_ds_index_entry_sorted(dest
, std::move(entry
));
490 static int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
, const char *path
)
492 int64_t stream_instance_id
= -1;
493 int64_t begin_ns
= -1;
494 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
495 ctf_fs_ds_file_group::UP new_ds_file_group
;
497 ctf_fs_ds_file_info::UP ds_file_info
;
498 ctf_fs_ds_index::UP index
;
499 struct ctf_msg_iter
*msg_iter
= NULL
;
500 struct ctf_stream_class
*sc
= NULL
;
501 struct ctf_msg_iter_packet_properties props
;
504 * Create a temporary ds_file to read some properties about the data
508 ctf_fs_ds_file_create(ctf_fs_trace
, bt2::Stream::Shared
{}, path
, ctf_fs_trace
->logger
);
513 /* Create a temporary iterator to read the ds_file. */
514 msg_iter
= ctf_msg_iter_create(
515 ctf_fs_trace
->metadata
->tc
,
516 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
517 ctf_fs_ds_file_medops
, ds_file
.get(), nullptr, ctf_fs_trace
->logger
);
519 BT_CPPLOGE_STR_SPEC(ctf_fs_trace
->logger
, "Cannot create a CTF message iterator.");
523 ctf_msg_iter_set_dry_run(msg_iter
, true);
525 ret
= ctf_msg_iter_get_packet_properties(msg_iter
, &props
);
527 BT_CPPLOGE_APPEND_CAUSE_SPEC(
528 ctf_fs_trace
->logger
,
529 "Cannot get stream file's first packet's header and context fields (`{}`).", path
);
533 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
, props
.stream_class_id
);
535 stream_instance_id
= props
.data_stream_id
;
537 if (props
.snapshots
.beginning_clock
!= UINT64_C(-1)) {
538 BT_ASSERT(sc
->default_clock_class
);
539 ret
= bt_util_clock_cycles_to_ns_from_origin(
540 props
.snapshots
.beginning_clock
, sc
->default_clock_class
->frequency
,
541 sc
->default_clock_class
->offset_seconds
, sc
->default_clock_class
->offset_cycles
,
544 BT_CPPLOGE_APPEND_CAUSE_SPEC(
545 ctf_fs_trace
->logger
,
546 "Cannot convert clock cycles to nanoseconds from origin (`{}`).", path
);
551 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
);
556 index
= ctf_fs_ds_file_build_index(ds_file
.get(), ds_file_info
.get(), msg_iter
);
558 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to index CTF stream file \'{}\'",
559 ds_file
->file
->path
);
563 if (begin_ns
== -1) {
565 * No beginning timestamp to sort the stream files
566 * within a stream file group, so consider that this
567 * file must be the only one within its group.
569 stream_instance_id
= -1;
572 if (stream_instance_id
== -1) {
574 * No stream instance ID or no beginning timestamp:
575 * create a unique stream file group for this stream
576 * file because, even if there's a stream instance ID,
577 * there's no timestamp to order the file within its
581 ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, UINT64_C(-1), std::move(index
));
583 if (!new_ds_file_group
) {
587 ds_file_group_insert_ds_file_info_sorted(new_ds_file_group
.get(), std::move(ds_file_info
));
588 ctf_fs_trace
->ds_file_groups
.emplace_back(std::move(new_ds_file_group
));
592 BT_ASSERT(stream_instance_id
!= -1);
593 BT_ASSERT(begin_ns
!= -1);
595 /* Find an existing stream file group with this ID */
596 for (const auto& candidate
: ctf_fs_trace
->ds_file_groups
) {
597 if (candidate
->sc
== sc
&& candidate
->stream_id
== stream_instance_id
) {
598 ds_file_group
= candidate
.get();
603 if (!ds_file_group
) {
605 ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, stream_instance_id
, std::move(index
));
606 if (!new_ds_file_group
) {
610 ds_file_group
= new_ds_file_group
.get();
611 ctf_fs_trace
->ds_file_groups
.emplace_back(std::move(new_ds_file_group
));
613 merge_ctf_fs_ds_indexes(ds_file_group
->index
.get(), std::move(index
));
616 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, std::move(ds_file_info
));
625 ctf_msg_iter_destroy(msg_iter
);
631 static int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
634 const char *basename
;
635 GError
*error
= NULL
;
638 /* Check each file in the path directory, except specific ones */
639 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
641 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
642 "Cannot open directory `{}`: {} (code {})",
643 ctf_fs_trace
->path
->str
, error
->message
, error
->code
);
647 while ((basename
= g_dir_read_name(dir
))) {
648 if (strcmp(basename
, CTF_FS_METADATA_FILENAME
) == 0) {
649 /* Ignore the metadata stream. */
650 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
651 "Ignoring metadata file `{}" G_DIR_SEPARATOR_S
"{}`",
652 ctf_fs_trace
->path
->str
, basename
);
656 if (basename
[0] == '.') {
657 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
658 "Ignoring hidden file `{}" G_DIR_SEPARATOR_S
"{}`",
659 ctf_fs_trace
->path
->str
, basename
);
663 /* Create the file. */
664 const auto file
= ctf_fs_file_create(ctf_fs_trace
->logger
);
666 BT_CPPLOGE_APPEND_CAUSE_SPEC(
667 ctf_fs_trace
->logger
,
668 "Cannot create stream file object for file `{}" G_DIR_SEPARATOR_S
"{}`",
669 ctf_fs_trace
->path
->str
, basename
);
673 /* Create full path string. */
674 file
->path
= fmt::format("{}" G_DIR_SEPARATOR_S
"{}", ctf_fs_trace
->path
->str
, basename
);
676 if (!g_file_test(file
->path
.c_str(), G_FILE_TEST_IS_REGULAR
)) {
677 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring non-regular file `{}`", file
->path
);
681 ret
= ctf_fs_file_open(file
.get(), "rb");
683 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Cannot open stream file `{}`",
688 if (file
->size
== 0) {
689 /* Skip empty stream. */
690 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring empty file `{}`", file
->path
);
694 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
, file
->path
.c_str());
696 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
697 "Cannot add stream file `{}` to stream file group",
721 static int set_trace_name(bt_trace
*trace
, const char *name_suffix
, const bt2c::Logger
& logger
)
727 name
= g_string_new(NULL
);
729 BT_CPPLOGE_STR_SPEC(logger
, "Failed to allocate a GString.");
735 * Check if we have a trace environment string value named `hostname`.
736 * If so, use it as the trace name's prefix.
738 val
= bt_trace_borrow_environment_entry_value_by_name_const(trace
, "hostname");
739 if (val
&& bt_value_is_string(val
)) {
740 g_string_append(name
, bt_value_string_get(val
));
743 g_string_append_c(name
, G_DIR_SEPARATOR
);
748 g_string_append(name
, name_suffix
);
751 ret
= bt_trace_set_name(trace
, name
->str
);
760 g_string_free(name
, TRUE
);
766 static ctf_fs_trace::UP
ctf_fs_trace_create(const char *path
, const char *name
,
767 const ctf::src::ClkClsCfg
& clkClsCfg
,
768 bt_self_component
*selfComp
,
769 const bt2c::Logger
& parentLogger
)
773 ctf_fs_trace::UP ctf_fs_trace
{new struct ctf_fs_trace(parentLogger
)};
774 ctf_fs_trace
->path
= g_string_new(path
);
775 if (!ctf_fs_trace
->path
) {
779 ctf_fs_trace
->metadata
= new ctf_fs_metadata
;
780 ctf_fs_metadata_init(ctf_fs_trace
->metadata
);
782 ret
= ctf_fs_metadata_set_trace_class(selfComp
, ctf_fs_trace
.get(), clkClsCfg
);
787 if (ctf_fs_trace
->metadata
->trace_class
) {
788 ctf_fs_trace
->trace
= bt_trace_create(ctf_fs_trace
->metadata
->trace_class
);
789 if (!ctf_fs_trace
->trace
) {
794 if (ctf_fs_trace
->trace
) {
795 ret
= ctf_trace_class_configure_ir_trace(ctf_fs_trace
->metadata
->tc
, ctf_fs_trace
->trace
);
800 ret
= set_trace_name(ctf_fs_trace
->trace
, name
, ctf_fs_trace
->logger
);
806 ret
= create_ds_file_groups(ctf_fs_trace
.get());
814 ctf_fs_trace
.reset();
820 static int path_is_ctf_trace(const char *path
)
822 GString
*metadata_path
= g_string_new(NULL
);
825 if (!metadata_path
) {
830 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
832 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
838 g_string_free(metadata_path
, TRUE
);
842 /* Helper for ctf_fs_component_create_ctf_fs_trace, to handle a single path. */
844 static int ctf_fs_component_create_ctf_fs_trace_one_path(struct ctf_fs_component
*ctf_fs
,
845 const char *path_param
,
846 const char *trace_name
,
847 std::vector
<ctf_fs_trace::UP
>& traces
,
848 bt_self_component
*selfComp
)
850 ctf_fs_trace::UP ctf_fs_trace
;
854 norm_path
= bt_common_normalize_path(path_param
, NULL
);
856 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to normalize path: `{}`.", path_param
);
860 ret
= path_is_ctf_trace(norm_path
->str
);
862 BT_CPPLOGE_APPEND_CAUSE_SPEC(
863 ctf_fs
->logger
, "Failed to check if path is a CTF trace: path={}", norm_path
->str
);
865 } else if (ret
== 0) {
866 BT_CPPLOGE_APPEND_CAUSE_SPEC(
867 ctf_fs
->logger
, "Path is not a CTF trace (does not contain a metadata file): `{}`.",
872 // FIXME: Remove or ifdef for __MINGW32__
873 if (strcmp(norm_path
->str
, "/") == 0) {
874 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Opening a trace in `/` is not supported.");
879 ctf_fs_trace
= ctf_fs_trace_create(norm_path
->str
, trace_name
, ctf_fs
->clkClsCfg
, selfComp
,
882 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create trace for `{}`.",
887 traces
.emplace_back(std::move(ctf_fs_trace
));
897 g_string_free(norm_path
, TRUE
);
904 * Count the number of stream and event classes defined by this trace's metadata.
906 * This is used to determine which metadata is the "latest", out of multiple
907 * traces sharing the same UUID. It is assumed that amongst all these metadatas,
908 * a bigger metadata is a superset of a smaller metadata. Therefore, it is
909 * enough to just count the classes.
912 static unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace
*trace
)
914 unsigned int num
= trace
->metadata
->tc
->stream_classes
->len
;
917 for (i
= 0; i
< trace
->metadata
->tc
->stream_classes
->len
; i
++) {
918 struct ctf_stream_class
*sc
=
919 (struct ctf_stream_class
*) trace
->metadata
->tc
->stream_classes
->pdata
[i
];
920 num
+= sc
->event_classes
->len
;
927 * Merge the src ds_file_group into dest. This consists of merging their
928 * ds_file_infos, making sure to keep the result sorted.
931 static void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group
*dest
,
932 ctf_fs_ds_file_group::UP src
)
934 for (auto& ds_file_info
: src
->ds_file_infos
) {
935 ds_file_group_insert_ds_file_info_sorted(dest
, std::move(ds_file_info
));
938 /* Merge both indexes. */
939 merge_ctf_fs_ds_indexes(dest
->index
.get(), std::move(src
->index
));
942 /* Merge src_trace's data stream file groups into dest_trace's. */
944 static int merge_matching_ctf_fs_ds_file_groups(struct ctf_fs_trace
*dest_trace
,
945 ctf_fs_trace::UP src_trace
)
947 std::vector
<ctf_fs_ds_file_group::UP
>& dest
= dest_trace
->ds_file_groups
;
948 std::vector
<ctf_fs_ds_file_group::UP
>& src
= src_trace
->ds_file_groups
;
952 * Save the initial length of dest: we only want to check against the
953 * original elements in the inner loop.
955 size_t dest_len
= dest
.size();
957 for (auto& src_group
: src
) {
958 struct ctf_fs_ds_file_group
*dest_group
= NULL
;
960 /* A stream instance without ID can't match a stream in the other trace. */
961 if (src_group
->stream_id
!= -1) {
962 /* Let's search for a matching ds_file_group in the destination. */
963 for (size_t d_i
= 0; d_i
< dest_len
; ++d_i
) {
964 ctf_fs_ds_file_group
*candidate_dest
= dest
[d_i
].get();
966 /* Can't match a stream instance without ID. */
967 if (candidate_dest
->stream_id
== -1) {
972 * If the two groups have the same stream instance id
973 * and belong to the same stream class (stream instance
974 * ids are per-stream class), they represent the same
977 if (candidate_dest
->stream_id
!= src_group
->stream_id
||
978 candidate_dest
->sc
->id
!= src_group
->sc
->id
) {
982 dest_group
= candidate_dest
;
988 * Didn't find a friend in dest to merge our src_group into?
989 * Create a new empty one. This can happen if a stream was
990 * active in the source trace chunk but not in the destination
994 struct ctf_stream_class
*sc
;
996 sc
= ctf_trace_class_borrow_stream_class_by_id(dest_trace
->metadata
->tc
,
1000 auto index
= ctf_fs_ds_index_create();
1006 auto new_dest_group
=
1007 ctf_fs_ds_file_group_create(dest_trace
, sc
, src_group
->stream_id
, std::move(index
));
1009 if (!new_dest_group
) {
1014 dest_group
= new_dest_group
.get();
1015 dest_trace
->ds_file_groups
.emplace_back(std::move(new_dest_group
));
1018 BT_ASSERT(dest_group
);
1019 merge_ctf_fs_ds_file_groups(dest_group
, std::move(src_group
));
1027 * Collapse the given traces, which must all share the same UUID, in a single
1030 * The trace with the most expansive metadata is chosen and all other traces
1031 * are merged into that one. On return, the elements of `traces` are nullptr
1032 * and the merged trace is placed in `out_trace`.
1035 static int merge_ctf_fs_traces(std::vector
<ctf_fs_trace::UP
> traces
, ctf_fs_trace::UP
& out_trace
)
1037 unsigned int winner_count
;
1038 struct ctf_fs_trace
*winner
;
1042 BT_ASSERT(traces
.size() >= 2);
1044 winner_count
= metadata_count_stream_and_event_classes(traces
[0].get());
1045 winner
= traces
[0].get();
1048 /* Find the trace with the largest metadata. */
1049 for (i
= 1; i
< traces
.size(); i
++) {
1050 ctf_fs_trace
*candidate
= traces
[i
].get();
1051 unsigned int candidate_count
;
1053 /* A bit of sanity check. */
1054 BT_ASSERT(bt_uuid_compare(winner
->metadata
->tc
->uuid
, candidate
->metadata
->tc
->uuid
) == 0);
1056 candidate_count
= metadata_count_stream_and_event_classes(candidate
);
1058 if (candidate_count
> winner_count
) {
1059 winner_count
= candidate_count
;
1065 /* Merge all the other traces in the winning trace. */
1066 for (ctf_fs_trace::UP
& trace
: traces
) {
1067 /* Don't merge the winner into itself. */
1068 if (trace
.get() == winner
) {
1072 /* Merge trace's data stream file groups into winner's. */
1073 ret
= merge_matching_ctf_fs_ds_file_groups(winner
, std::move(trace
));
1080 * Move the winner out of the array, into `*out_trace`.
1082 out_trace
= std::move(traces
[winner_i
]);
1094 static int decode_clock_snapshot_after_event(struct ctf_fs_trace
*ctf_fs_trace
,
1095 struct ctf_clock_class
*default_cc
,
1096 struct ctf_fs_ds_index_entry
*index_entry
,
1097 enum target_event target_event
, uint64_t *cs
,
1100 enum ctf_msg_iter_status iter_status
= CTF_MSG_ITER_STATUS_OK
;
1101 struct ctf_msg_iter
*msg_iter
= NULL
;
1104 BT_ASSERT(ctf_fs_trace
);
1105 BT_ASSERT(index_entry
);
1106 BT_ASSERT(index_entry
->path
);
1108 const auto ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, bt2::Stream::Shared
{},
1109 index_entry
->path
, ctf_fs_trace
->logger
);
1111 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to create a ctf_fs_ds_file");
1116 BT_ASSERT(ctf_fs_trace
->metadata
);
1117 BT_ASSERT(ctf_fs_trace
->metadata
->tc
);
1119 msg_iter
= ctf_msg_iter_create(
1120 ctf_fs_trace
->metadata
->tc
,
1121 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
1122 ctf_fs_ds_file_medops
, ds_file
.get(), NULL
, ctf_fs_trace
->logger
);
1124 /* ctf_msg_iter_create() logs errors. */
1130 * Turn on dry run mode to prevent the creation and usage of Babeltrace
1131 * library objects (bt_field, bt_message_*, etc.).
1133 ctf_msg_iter_set_dry_run(msg_iter
, true);
1135 /* Seek to the beginning of the target packet. */
1136 iter_status
= ctf_msg_iter_seek(msg_iter
, index_entry
->offset
.bytes());
1138 /* ctf_msg_iter_seek() logs errors. */
1143 switch (target_event
) {
1146 * Start to decode the packet until we reach the end of
1147 * the first event. To extract the first event's clock
1150 iter_status
= ctf_msg_iter_curr_packet_first_event_clock_snapshot(msg_iter
, cs
);
1153 /* Decode the packet to extract the last event's clock snapshot. */
1154 iter_status
= ctf_msg_iter_curr_packet_last_event_clock_snapshot(msg_iter
, cs
);
1164 /* Convert clock snapshot to timestamp. */
1165 ret
= bt_util_clock_cycles_to_ns_from_origin(
1166 *cs
, default_cc
->frequency
, default_cc
->offset_seconds
, default_cc
->offset_cycles
, ts_ns
);
1168 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1169 "Failed to convert clock snapshot to timestamp");
1175 ctf_msg_iter_destroy(msg_iter
);
1181 static int decode_packet_first_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1182 struct ctf_clock_class
*default_cc
,
1183 struct ctf_fs_ds_index_entry
*index_entry
,
1184 uint64_t *cs
, int64_t *ts_ns
)
1186 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, FIRST_EVENT
, cs
,
1190 static int decode_packet_last_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1191 struct ctf_clock_class
*default_cc
,
1192 struct ctf_fs_ds_index_entry
*index_entry
,
1193 uint64_t *cs
, int64_t *ts_ns
)
1195 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, LAST_EVENT
, cs
,
1200 * Fix up packet index entries for lttng's "event-after-packet" bug.
1201 * Some buggy lttng tracer versions may emit events with a timestamp that is
1202 * larger (after) than the timestamp_end of the their packets.
1204 * To fix up this erroneous data we do the following:
1205 * 1. If it's not the stream file's last packet: set the packet index entry's
1206 * end time to the next packet's beginning time.
1207 * 2. If it's the stream file's last packet, set the packet index entry's end
1208 * time to the packet's last event's time, if any, or to the packet's
1209 * beginning time otherwise.
1211 * Known buggy tracer versions:
1212 * - before lttng-ust 2.11.0
1213 * - before lttng-module 2.11.0
1214 * - before lttng-module 2.10.10
1215 * - before lttng-module 2.9.13
1217 static int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace
*trace
)
1221 for (const auto& ds_file_group
: trace
->ds_file_groups
) {
1222 struct ctf_clock_class
*default_cc
;
1224 BT_ASSERT(ds_file_group
);
1225 const auto index
= ds_file_group
->index
.get();
1228 BT_ASSERT(!index
->entries
.empty());
1231 * Iterate over all entries but the last one. The last one is
1232 * fixed differently after.
1234 for (size_t entry_i
= 0; entry_i
< index
->entries
.size() - 1; ++entry_i
) {
1235 ctf_fs_ds_index_entry
*curr_entry
= index
->entries
[entry_i
].get();
1236 ctf_fs_ds_index_entry
*next_entry
= index
->entries
[entry_i
+ 1].get();
1239 * 1. Set the current index entry `end` timestamp to
1240 * the next index entry `begin` timestamp.
1242 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1243 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1247 * 2. Fix the last entry by decoding the last event of the last
1250 const auto last_entry
= index
->entries
.back().get();
1251 BT_ASSERT(last_entry
);
1253 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1254 default_cc
= ds_file_group
->sc
->default_clock_class
;
1257 * Decode packet to read the timestamp of the last event of the
1260 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1261 &last_entry
->timestamp_end
,
1262 &last_entry
->timestamp_end_ns
);
1264 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1266 "Failed to decode stream's last packet to get its last event's clock snapshot.");
1276 * Fix up packet index entries for barectf's "event-before-packet" bug.
1277 * Some buggy barectf tracer versions may emit events with a timestamp that is
1278 * less than the timestamp_begin of the their packets.
1280 * To fix up this erroneous data we do the following:
1281 * 1. Starting at the second index entry, set the timestamp_begin of the
1282 * current entry to the timestamp of the first event of the packet.
1283 * 2. Set the previous entry's timestamp_end to the timestamp_begin of the
1286 * Known buggy tracer versions:
1287 * - before barectf 2.3.1
1289 static int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace
*trace
)
1293 for (const auto& ds_file_group
: trace
->ds_file_groups
) {
1294 struct ctf_clock_class
*default_cc
;
1295 const auto index
= ds_file_group
->index
.get();
1298 BT_ASSERT(!index
->entries
.empty());
1300 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1301 default_cc
= ds_file_group
->sc
->default_clock_class
;
1304 * 1. Iterate over the index, starting from the second entry
1307 for (size_t entry_i
= 1; entry_i
< index
->entries
.size(); ++entry_i
) {
1308 ctf_fs_ds_index_entry
*prev_entry
= index
->entries
[entry_i
- 1].get();
1309 ctf_fs_ds_index_entry
*curr_entry
= index
->entries
[entry_i
].get();
1311 * 2. Set the current entry `begin` timestamp to the
1312 * timestamp of the first event of the current packet.
1314 ret
= decode_packet_first_event_timestamp(trace
, default_cc
, curr_entry
,
1315 &curr_entry
->timestamp_begin
,
1316 &curr_entry
->timestamp_begin_ns
);
1318 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1319 "Failed to decode first event's clock snapshot");
1324 * 3. Set the previous entry `end` timestamp to the
1325 * timestamp of the first event of the current packet.
1327 prev_entry
->timestamp_end
= curr_entry
->timestamp_begin
;
1328 prev_entry
->timestamp_end_ns
= curr_entry
->timestamp_begin_ns
;
1336 * When using the lttng-crash feature it's likely that the last packets of each
1337 * stream have their timestamp_end set to zero. This is caused by the fact that
1338 * the tracer crashed and was not able to properly close the packets.
1340 * To fix up this erroneous data we do the following:
1341 * For each index entry, if the entry's timestamp_end is 0 and the
1342 * timestamp_begin is not 0:
1343 * - If it's the stream file's last packet: set the packet index entry's end
1344 * time to the packet's last event's time, if any, or to the packet's
1345 * beginning time otherwise.
1346 * - If it's not the stream file's last packet: set the packet index
1347 * entry's end time to the next packet's beginning time.
1349 * Affected versions:
1350 * - All current and future lttng-ust and lttng-modules versions.
1352 static int fix_index_lttng_crash_quirk(struct ctf_fs_trace
*trace
)
1356 for (const auto& ds_file_group
: trace
->ds_file_groups
) {
1357 struct ctf_clock_class
*default_cc
;
1359 BT_ASSERT(ds_file_group
);
1360 const auto index
= ds_file_group
->index
.get();
1362 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1363 default_cc
= ds_file_group
->sc
->default_clock_class
;
1366 BT_ASSERT(!index
->entries
.empty());
1368 const auto last_entry
= index
->entries
.back().get();
1369 BT_ASSERT(last_entry
);
1371 /* 1. Fix the last entry first. */
1372 if (last_entry
->timestamp_end
== 0 && last_entry
->timestamp_begin
!= 0) {
1374 * Decode packet to read the timestamp of the
1375 * last event of the stream file.
1377 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1378 &last_entry
->timestamp_end
,
1379 &last_entry
->timestamp_end_ns
);
1381 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1382 "Failed to decode last event's clock snapshot");
1387 /* Iterate over all entries but the last one. */
1388 for (size_t entry_idx
= 0; entry_idx
< index
->entries
.size() - 1; ++entry_idx
) {
1389 ctf_fs_ds_index_entry
*curr_entry
= index
->entries
[entry_idx
].get();
1390 ctf_fs_ds_index_entry
*next_entry
= index
->entries
[entry_idx
+ 1].get();
1392 if (curr_entry
->timestamp_end
== 0 && curr_entry
->timestamp_begin
!= 0) {
1394 * 2. Set the current index entry `end` timestamp to
1395 * the next index entry `begin` timestamp.
1397 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1398 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1408 * Extract the tracer information necessary to compare versions.
1409 * Returns 0 on success, and -1 if the extraction is not successful because the
1410 * necessary fields are absents in the trace metadata.
1412 static int extract_tracer_info(struct ctf_fs_trace
*trace
, struct tracer_info
*current_tracer_info
)
1415 struct ctf_trace_class_env_entry
*entry
;
1417 /* Clear the current_tracer_info struct */
1418 memset(current_tracer_info
, 0, sizeof(*current_tracer_info
));
1421 * To compare 2 tracer versions, at least the tracer name and it's
1422 * major version are needed. If one of these is missing, consider it an
1423 * extraction failure.
1425 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_name");
1426 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR
) {
1427 goto missing_bare_minimum
;
1430 /* Set tracer name. */
1431 current_tracer_info
->name
= entry
->value
.str
->str
;
1433 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_major");
1434 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1435 goto missing_bare_minimum
;
1438 /* Set major version number. */
1439 current_tracer_info
->major
= entry
->value
.i
;
1441 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_minor");
1442 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1446 /* Set minor version number. */
1447 current_tracer_info
->minor
= entry
->value
.i
;
1449 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patch");
1452 * If `tracer_patch` doesn't exist `tracer_patchlevel` might.
1453 * For example, `lttng-modules` uses entry name
1454 * `tracer_patchlevel`.
1456 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patchlevel");
1459 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1463 /* Set patch version number. */
1464 current_tracer_info
->patch
= entry
->value
.i
;
1468 missing_bare_minimum
:
1474 static bool is_tracer_affected_by_lttng_event_after_packet_bug(struct tracer_info
*curr_tracer_info
)
1476 bool is_affected
= false;
1478 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1479 if (curr_tracer_info
->major
< 2) {
1481 } else if (curr_tracer_info
->major
== 2) {
1482 /* fixed in lttng-ust 2.11.0 */
1483 if (curr_tracer_info
->minor
< 11) {
1487 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1488 if (curr_tracer_info
->major
< 2) {
1490 } else if (curr_tracer_info
->major
== 2) {
1491 /* fixed in lttng-modules 2.11.0 */
1492 if (curr_tracer_info
->minor
== 10) {
1493 /* fixed in lttng-modules 2.10.10 */
1494 if (curr_tracer_info
->patch
< 10) {
1497 } else if (curr_tracer_info
->minor
== 9) {
1498 /* fixed in lttng-modules 2.9.13 */
1499 if (curr_tracer_info
->patch
< 13) {
1502 } else if (curr_tracer_info
->minor
< 9) {
1512 is_tracer_affected_by_barectf_event_before_packet_bug(struct tracer_info
*curr_tracer_info
)
1514 bool is_affected
= false;
1516 if (strcmp(curr_tracer_info
->name
, "barectf") == 0) {
1517 if (curr_tracer_info
->major
< 2) {
1519 } else if (curr_tracer_info
->major
== 2) {
1520 if (curr_tracer_info
->minor
< 3) {
1522 } else if (curr_tracer_info
->minor
== 3) {
1523 /* fixed in barectf 2.3.1 */
1524 if (curr_tracer_info
->patch
< 1) {
1534 static bool is_tracer_affected_by_lttng_crash_quirk(struct tracer_info
*curr_tracer_info
)
1536 bool is_affected
= false;
1538 /* All LTTng tracer may be affected by this lttng crash quirk. */
1539 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1541 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1549 * Looks for trace produced by known buggy tracers and fix up the index
1552 static int fix_packet_index_tracer_bugs(ctf_fs_trace
*trace
)
1555 struct tracer_info current_tracer_info
;
1557 ret
= extract_tracer_info(trace
, ¤t_tracer_info
);
1560 * A trace may not have all the necessary environment
1561 * entries to do the tracer version comparison.
1562 * At least, the tracer name and major version number
1563 * are needed. Failing to extract these entries is not
1567 BT_CPPLOGI_STR_SPEC(
1569 "Cannot extract tracer information necessary to compare with buggy versions.");
1573 /* Check if the trace may be affected by old tracer bugs. */
1574 if (is_tracer_affected_by_lttng_event_after_packet_bug(¤t_tracer_info
)) {
1575 BT_CPPLOGI_STR_SPEC(
1577 "Trace may be affected by LTTng tracer packet timestamp bug. Fixing up.");
1578 ret
= fix_index_lttng_event_after_packet_bug(trace
);
1580 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1581 "Failed to fix LTTng event-after-packet bug.");
1584 trace
->metadata
->tc
->quirks
.lttng_event_after_packet
= true;
1587 if (is_tracer_affected_by_barectf_event_before_packet_bug(¤t_tracer_info
)) {
1588 BT_CPPLOGI_STR_SPEC(
1590 "Trace may be affected by barectf tracer packet timestamp bug. Fixing up.");
1591 ret
= fix_index_barectf_event_before_packet_bug(trace
);
1593 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1594 "Failed to fix barectf event-before-packet bug.");
1597 trace
->metadata
->tc
->quirks
.barectf_event_before_packet
= true;
1600 if (is_tracer_affected_by_lttng_crash_quirk(¤t_tracer_info
)) {
1601 ret
= fix_index_lttng_crash_quirk(trace
);
1603 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1604 "Failed to fix lttng-crash timestamp quirks.");
1607 trace
->metadata
->tc
->quirks
.lttng_crash
= true;
1614 static bool compare_ds_file_groups_by_first_path(const ctf_fs_ds_file_group::UP
& ds_file_group_a
,
1615 const ctf_fs_ds_file_group::UP
& ds_file_group_b
)
1617 BT_ASSERT(!ds_file_group_a
->ds_file_infos
.empty());
1618 BT_ASSERT(!ds_file_group_b
->ds_file_infos
.empty());
1620 const auto& first_ds_file_info_a
= *ds_file_group_a
->ds_file_infos
[0];
1621 const auto& first_ds_file_info_b
= *ds_file_group_b
->ds_file_infos
[0];
1623 return first_ds_file_info_a
.path
< first_ds_file_info_b
.path
;
1626 static gint
compare_strings(gconstpointer p_a
, gconstpointer p_b
)
1628 const char *a
= *((const char **) p_a
);
1629 const char *b
= *((const char **) p_b
);
1631 return strcmp(a
, b
);
1634 int ctf_fs_component_create_ctf_fs_trace(struct ctf_fs_component
*ctf_fs
,
1635 const bt_value
*paths_value
,
1636 const bt_value
*trace_name_value
,
1637 bt_self_component
*selfComp
)
1641 GPtrArray
*paths
= NULL
;
1642 std::vector
<ctf_fs_trace::UP
> traces
;
1643 const char *trace_name
;
1645 BT_ASSERT(bt_value_get_type(paths_value
) == BT_VALUE_TYPE_ARRAY
);
1646 BT_ASSERT(!bt_value_array_is_empty(paths_value
));
1648 paths
= g_ptr_array_new_with_free_func(g_free
);
1650 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to allocate a GPtrArray.");
1654 trace_name
= trace_name_value
? bt_value_string_get(trace_name_value
) : NULL
;
1657 * Create a sorted array of the paths, to make the execution of this
1658 * component deterministic.
1660 for (i
= 0; i
< bt_value_array_get_length(paths_value
); i
++) {
1661 const bt_value
*path_value
= bt_value_array_borrow_element_by_index_const(paths_value
, i
);
1662 const char *input
= bt_value_string_get(path_value
);
1665 input_copy
= g_strdup(input
);
1667 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to copy a string.");
1671 g_ptr_array_add(paths
, input_copy
);
1674 g_ptr_array_sort(paths
, compare_strings
);
1676 /* Create a separate ctf_fs_trace object for each path. */
1677 for (i
= 0; i
< paths
->len
; i
++) {
1678 const char *path
= (const char *) g_ptr_array_index(paths
, i
);
1680 ret
= ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs
, path
, trace_name
, traces
,
1687 if (traces
.size() > 1) {
1688 ctf_fs_trace
*first_trace
= traces
[0].get();
1689 const uint8_t *first_trace_uuid
= first_trace
->metadata
->tc
->uuid
;
1692 * We have more than one trace, they must all share the same
1693 * UUID, verify that.
1695 for (i
= 0; i
< traces
.size(); i
++) {
1696 ctf_fs_trace
*this_trace
= traces
[i
].get();
1697 const uint8_t *this_trace_uuid
= this_trace
->metadata
->tc
->uuid
;
1699 if (!this_trace
->metadata
->tc
->is_uuid_set
) {
1700 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1702 "Multiple traces given, but a trace does not have a UUID: path={}",
1703 this_trace
->path
->str
);
1707 if (bt_uuid_compare(first_trace_uuid
, this_trace_uuid
) != 0) {
1708 char first_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1709 char this_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1711 bt_uuid_to_str(first_trace_uuid
, first_trace_uuid_str
);
1712 bt_uuid_to_str(this_trace_uuid
, this_trace_uuid_str
);
1714 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1715 "Multiple traces given, but UUIDs don't match: "
1716 "first-trace-uuid={}, first-trace-path={}, "
1717 "trace-uuid={}, trace-path={}",
1718 first_trace_uuid_str
, first_trace
->path
->str
,
1719 this_trace_uuid_str
, this_trace
->path
->str
);
1724 ret
= merge_ctf_fs_traces(std::move(traces
), ctf_fs
->trace
);
1726 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1727 "Failed to merge traces with the same UUID.");
1731 /* Just one trace, it may or may not have a UUID, both are fine. */
1732 ctf_fs
->trace
= std::move(traces
[0]);
1735 ret
= fix_packet_index_tracer_bugs(ctf_fs
->trace
.get());
1737 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to fix packet index tracer bugs.");
1741 * Sort data stream file groups by first data stream file info
1742 * path to get a deterministic order. This order influences the
1743 * order of the output ports. It also influences the order of
1744 * the automatic stream IDs if the trace's packet headers do not
1745 * contain a `stream_instance_id` field, in which case the data
1746 * stream file to stream ID association is always the same,
1747 * whatever the build and the system.
1749 * Having a deterministic order here can help debugging and
1752 std::sort(ctf_fs
->trace
->ds_file_groups
.begin(), ctf_fs
->trace
->ds_file_groups
.end(),
1753 compare_ds_file_groups_by_first_path
);
1760 g_ptr_array_free(paths
, TRUE
);
1766 static GString
*get_stream_instance_unique_name(struct ctf_fs_ds_file_group
*ds_file_group
)
1769 struct ctf_fs_ds_file_info
*ds_file_info
;
1771 name
= g_string_new(NULL
);
1777 * If there's more than one stream file in the stream file
1778 * group, the first (earliest) stream file's path is used as
1779 * the stream's unique name.
1781 BT_ASSERT(!ds_file_group
->ds_file_infos
.empty());
1782 ds_file_info
= ds_file_group
->ds_file_infos
[0].get();
1783 g_string_assign(name
, ds_file_info
->path
.c_str());
1789 /* Create the IR stream objects for ctf_fs_trace. */
1791 static int create_streams_for_trace(struct ctf_fs_trace
*ctf_fs_trace
)
1794 GString
*name
= NULL
;
1796 for (const auto& ds_file_group
: ctf_fs_trace
->ds_file_groups
) {
1797 name
= get_stream_instance_unique_name(ds_file_group
.get());
1803 BT_ASSERT(ds_file_group
->sc
->ir_sc
);
1804 BT_ASSERT(ctf_fs_trace
->trace
);
1808 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
1809 /* No stream ID: use 0 */
1810 stream
= bt_stream_create_with_id(ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
,
1811 ctf_fs_trace
->next_stream_id
);
1812 ctf_fs_trace
->next_stream_id
++;
1814 /* Specific stream ID */
1815 stream
= bt_stream_create_with_id(ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
,
1816 (uint64_t) ds_file_group
->stream_id
);
1820 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1821 "Cannot create stream for DS file group: "
1822 "addr={}, stream-name=\"{}\"",
1823 fmt::ptr(ds_file_group
), name
->str
);
1827 ds_file_group
->stream
= bt2::Stream::Shared::createWithoutRef(stream
);
1829 ret
= bt_stream_set_name(ds_file_group
->stream
->libObjPtr(), name
->str
);
1831 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1832 "Cannot set stream's name: "
1833 "addr={}, stream-name=\"{}\"",
1834 fmt::ptr(ds_file_group
->stream
->libObjPtr()), name
->str
);
1838 g_string_free(name
, TRUE
);
1851 g_string_free(name
, TRUE
);
1856 static const bt_param_validation_value_descr inputs_elem_descr
=
1857 bt_param_validation_value_descr::makeString();
1859 static bt_param_validation_map_value_entry_descr fs_params_entries_descr
[] = {
1860 {"inputs", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
1861 bt_param_validation_value_descr::makeArray(1, BT_PARAM_VALIDATION_INFINITE
,
1862 inputs_elem_descr
)},
1863 {"trace-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1864 bt_param_validation_value_descr::makeString()},
1865 {"clock-class-offset-s", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1866 bt_param_validation_value_descr::makeSignedInteger()},
1867 {"clock-class-offset-ns", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1868 bt_param_validation_value_descr::makeSignedInteger()},
1869 {"force-clock-class-origin-unix-epoch", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1870 bt_param_validation_value_descr::makeBool()},
1871 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
1873 bool read_src_fs_parameters(const bt_value
*params
, const bt_value
**inputs
,
1874 const bt_value
**trace_name
, struct ctf_fs_component
*ctf_fs
)
1877 const bt_value
*value
;
1878 enum bt_param_validation_status validate_value_status
;
1879 gchar
*error
= NULL
;
1881 validate_value_status
= bt_param_validation_validate(params
, fs_params_entries_descr
, &error
);
1882 if (validate_value_status
!= BT_PARAM_VALIDATION_STATUS_OK
) {
1883 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "{}", error
);
1888 /* inputs parameter */
1889 *inputs
= bt_value_map_borrow_entry_value_const(params
, "inputs");
1891 /* clock-class-offset-s parameter */
1892 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-s");
1894 ctf_fs
->clkClsCfg
.offsetSec
= bt_value_integer_signed_get(value
);
1897 /* clock-class-offset-ns parameter */
1898 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-ns");
1900 ctf_fs
->clkClsCfg
.offsetNanoSec
= bt_value_integer_signed_get(value
);
1903 /* force-clock-class-origin-unix-epoch parameter */
1904 value
= bt_value_map_borrow_entry_value_const(params
, "force-clock-class-origin-unix-epoch");
1906 ctf_fs
->clkClsCfg
.forceOriginIsUnixEpoch
= bt_value_bool_get(value
);
1909 /* trace-name parameter */
1910 *trace_name
= bt_value_map_borrow_entry_value_const(params
, "trace-name");
1919 static ctf_fs_component::UP
ctf_fs_create(const bt_value
*params
,
1920 bt_self_component_source
*self_comp_src
)
1922 const bt_value
*inputs_value
;
1923 const bt_value
*trace_name_value
;
1924 bt_self_component
*self_comp
= bt_self_component_source_as_self_component(self_comp_src
);
1926 ctf_fs_component::UP ctf_fs
= ctf_fs_component_create(
1927 bt2c::Logger
{bt2::SelfSourceComponent
{self_comp_src
}, "PLUGIN/SRC.CTF.FS/COMP"});
1932 if (!read_src_fs_parameters(params
, &inputs_value
, &trace_name_value
, ctf_fs
.get())) {
1936 if (ctf_fs_component_create_ctf_fs_trace(ctf_fs
.get(), inputs_value
, trace_name_value
,
1941 if (create_streams_for_trace(ctf_fs
->trace
.get())) {
1945 if (create_ports_for_trace(ctf_fs
.get(), ctf_fs
->trace
.get(), self_comp_src
)) {
1952 bt_component_class_initialize_method_status
ctf_fs_init(bt_self_component_source
*self_comp_src
,
1953 bt_self_component_source_configuration
*,
1954 const bt_value
*params
, void *)
1957 bt_component_class_initialize_method_status ret
=
1958 BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
1960 ctf_fs_component::UP ctf_fs
= ctf_fs_create(params
, self_comp_src
);
1962 ret
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1965 bt_self_component_set_data(bt_self_component_source_as_self_component(self_comp_src
),
1968 } catch (const std::bad_alloc
&) {
1969 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1970 } catch (const bt2::Error
&) {
1971 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1975 bt_component_class_query_method_status
ctf_fs_query(bt_self_component_class_source
*comp_class_src
,
1976 bt_private_query_executor
*priv_query_exec
,
1977 const char *object
, const bt_value
*params
,
1978 __attribute__((unused
)) void *method_data
,
1979 const bt_value
**result
)
1982 bt2c::Logger logger
{bt2::SelfComponentClass
{comp_class_src
},
1983 bt2::PrivateQueryExecutor
{priv_query_exec
},
1984 "PLUGIN/SRC.CTF.FS/QUERY"};
1985 bt2::ConstMapValue
paramsObj(params
);
1986 bt2::Value::Shared resultObj
;
1988 if (strcmp(object
, "metadata-info") == 0) {
1989 resultObj
= metadata_info_query(paramsObj
, logger
);
1990 } else if (strcmp(object
, "babeltrace.trace-infos") == 0) {
1991 resultObj
= trace_infos_query(paramsObj
, logger
);
1992 } else if (!strcmp(object
, "babeltrace.support-info")) {
1993 resultObj
= support_info_query(paramsObj
, logger
);
1995 BT_CPPLOGE_SPEC(logger
, "Unknown query object `{}`", object
);
1996 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;
1999 *result
= resultObj
.release().libObjPtr();
2001 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
2002 } catch (const std::bad_alloc
&) {
2003 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
2004 } catch (const bt2::Error
&) {
2005 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;