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
)
47 static bt_message_iterator_class_next_method_status
48 ctf_fs_iterator_next_one(struct ctf_fs_msg_iter_data
*msg_iter_data
, const bt_message
**out_msg
)
50 bt_message_iterator_class_next_method_status status
;
51 const auto msg_iter_status
=
52 ctf_msg_iter_get_next_message(msg_iter_data
->msg_iter
.get(), out_msg
);
54 switch (msg_iter_status
) {
55 case CTF_MSG_ITER_STATUS_OK
:
56 /* Cool, message has been written to *out_msg. */
57 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
60 case CTF_MSG_ITER_STATUS_EOF
:
61 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END
;
64 case CTF_MSG_ITER_STATUS_AGAIN
:
66 * Should not make it this far as this is
67 * medium-specific; there is nothing for the user to do
68 * and it should have been handled upstream.
72 case CTF_MSG_ITER_STATUS_ERROR
:
73 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
74 "Failed to get next message from CTF message iterator.");
75 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
78 case CTF_MSG_ITER_STATUS_MEMORY_ERROR
:
79 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
80 "Failed to get next message from CTF message iterator.");
81 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
91 bt_message_iterator_class_next_method_status
92 ctf_fs_iterator_next(bt_self_message_iterator
*iterator
, bt_message_array_const msgs
,
93 uint64_t capacity
, uint64_t *count
)
96 bt_message_iterator_class_next_method_status status
;
97 struct ctf_fs_msg_iter_data
*msg_iter_data
=
98 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(iterator
);
101 if (G_UNLIKELY(msg_iter_data
->next_saved_error
)) {
103 * Last time we were called, we hit an error but had some
104 * messages to deliver, so we stashed the error here. Return
107 BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(msg_iter_data
->next_saved_error
);
108 status
= msg_iter_data
->next_saved_status
;
113 status
= ctf_fs_iterator_next_one(msg_iter_data
, &msgs
[i
]);
114 if (status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
) {
117 } while (i
< capacity
&& status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
);
121 * Even if ctf_fs_iterator_next_one() returned something
122 * else than BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK, we
123 * accumulated message objects in the output
124 * message array, so we need to return
125 * BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK so that they are
126 * transferred to downstream. This other status occurs
127 * again the next time muxer_msg_iter_do_next() is
128 * called, possibly without any accumulated
129 * message, in which case we'll return it.
133 * Save this error for the next _next call. Assume that
134 * this component always appends error causes when
135 * returning an error status code, which will cause the
136 * current thread error to be non-NULL.
138 msg_iter_data
->next_saved_error
= bt_current_thread_take_error();
139 BT_ASSERT(msg_iter_data
->next_saved_error
);
140 msg_iter_data
->next_saved_status
= status
;
144 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
150 } catch (const std::bad_alloc
&) {
151 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
152 } catch (const bt2::Error
&) {
153 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
157 bt_message_iterator_class_seek_beginning_method_status
158 ctf_fs_iterator_seek_beginning(bt_self_message_iterator
*it
)
161 struct ctf_fs_msg_iter_data
*msg_iter_data
=
162 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(it
);
164 BT_ASSERT(msg_iter_data
);
166 ctf_msg_iter_reset(msg_iter_data
->msg_iter
.get());
167 ctf_fs_ds_group_medops_data_reset(msg_iter_data
->msg_iter_medops_data
.get());
169 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_OK
;
170 } catch (const std::bad_alloc
&) {
171 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_MEMORY_ERROR
;
172 } catch (const bt2::Error
&) {
173 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_ERROR
;
177 void ctf_fs_iterator_finalize(bt_self_message_iterator
*it
)
179 ctf_fs_msg_iter_data_destroy(
180 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(it
));
183 static bt_message_iterator_class_initialize_method_status
184 ctf_msg_iter_medium_status_to_msg_iter_initialize_status(enum ctf_msg_iter_medium_status status
)
187 case CTF_MSG_ITER_MEDIUM_STATUS_EOF
:
188 case CTF_MSG_ITER_MEDIUM_STATUS_AGAIN
:
189 case CTF_MSG_ITER_MEDIUM_STATUS_ERROR
:
190 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
191 case CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
:
192 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
193 case CTF_MSG_ITER_MEDIUM_STATUS_OK
:
194 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
200 bt_message_iterator_class_initialize_method_status
201 ctf_fs_iterator_init(bt_self_message_iterator
*self_msg_iter
,
202 bt_self_message_iterator_configuration
*config
,
203 bt_self_component_port_output
*self_port
)
206 struct ctf_fs_port_data
*port_data
;
207 bt_message_iterator_class_initialize_method_status status
;
208 enum ctf_msg_iter_medium_status medium_status
;
210 port_data
= (struct ctf_fs_port_data
*) bt_self_component_port_get_data(
211 bt_self_component_port_output_as_self_component_port(self_port
));
212 BT_ASSERT(port_data
);
214 ctf_fs_msg_iter_data
*msg_iter_data
= new ctf_fs_msg_iter_data
{self_msg_iter
};
215 msg_iter_data
->ds_file_group
= port_data
->ds_file_group
;
217 medium_status
= ctf_fs_ds_group_medops_data_create(msg_iter_data
->ds_file_group
,
218 self_msg_iter
, msg_iter_data
->logger
,
219 msg_iter_data
->msg_iter_medops_data
);
220 BT_ASSERT(medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_OK
||
221 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_ERROR
||
222 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
);
223 if (medium_status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
224 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
225 "Failed to create ctf_fs_ds_group_medops");
226 status
= ctf_msg_iter_medium_status_to_msg_iter_initialize_status(medium_status
);
230 msg_iter_data
->msg_iter
= ctf_msg_iter_create(
231 msg_iter_data
->ds_file_group
->ctf_fs_trace
->metadata
->tc
,
232 bt_common_get_page_size(static_cast<int>(msg_iter_data
->logger
.level())) * 8,
233 ctf_fs_ds_group_medops
, msg_iter_data
->msg_iter_medops_data
.get(), self_msg_iter
,
234 msg_iter_data
->logger
);
235 if (!msg_iter_data
->msg_iter
) {
236 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
237 "Cannot create a CTF message iterator.");
238 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
243 * This iterator can seek forward if its stream class has a default
246 if (msg_iter_data
->ds_file_group
->sc
->default_clock_class
) {
247 bt_self_message_iterator_configuration_set_can_seek_forward(config
, true);
250 bt_self_message_iterator_set_data(self_msg_iter
, msg_iter_data
);
251 msg_iter_data
= NULL
;
253 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
257 bt_self_message_iterator_set_data(self_msg_iter
, NULL
);
260 ctf_fs_msg_iter_data_destroy(msg_iter_data
);
262 } catch (const std::bad_alloc
&) {
263 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
264 } catch (const bt2::Error
&) {
265 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
269 static void ctf_fs_trace_destroy(struct ctf_fs_trace
*ctf_fs_trace
)
275 BT_TRACE_PUT_REF_AND_RESET(ctf_fs_trace
->trace
);
277 if (ctf_fs_trace
->path
) {
278 g_string_free(ctf_fs_trace
->path
, TRUE
);
281 if (ctf_fs_trace
->metadata
) {
282 ctf_fs_metadata_fini(ctf_fs_trace
->metadata
);
283 delete ctf_fs_trace
->metadata
;
289 void ctf_fs_trace_deleter::operator()(ctf_fs_trace
* const trace
) noexcept
291 ctf_fs_trace_destroy(trace
);
294 ctf_fs_component::UP
ctf_fs_component_create(const bt2c::Logger
& parentLogger
)
296 return bt2s::make_unique
<ctf_fs_component
>(parentLogger
);
299 void ctf_fs_finalize(bt_self_component_source
*component
)
301 ctf_fs_component::UP
{static_cast<ctf_fs_component
*>(
302 bt_self_component_get_data(bt_self_component_source_as_self_component(component
)))};
305 bt2c::GCharUP
ctf_fs_make_port_name(struct ctf_fs_ds_file_group
*ds_file_group
)
307 GString
*name
= g_string_new(NULL
);
310 * The unique port name is generated by concatenating unique identifiers
318 /* For the trace, use the uuid if present, else the path. */
319 if (ds_file_group
->ctf_fs_trace
->metadata
->tc
->is_uuid_set
) {
320 char uuid_str
[BT_UUID_STR_LEN
+ 1];
322 bt_uuid_to_str(ds_file_group
->ctf_fs_trace
->metadata
->tc
->uuid
, uuid_str
);
323 g_string_assign(name
, uuid_str
);
325 g_string_assign(name
, ds_file_group
->ctf_fs_trace
->path
->str
);
329 * For the stream class, use the id if present. We can omit this field
330 * otherwise, as there will only be a single stream class.
332 if (ds_file_group
->sc
->id
!= UINT64_C(-1)) {
333 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->sc
->id
);
336 /* For the stream, use the id if present, else, use the path. */
337 if (ds_file_group
->stream_id
!= UINT64_C(-1)) {
338 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->stream_id
);
340 BT_ASSERT(ds_file_group
->ds_file_infos
.size() == 1);
341 const auto& ds_file_info
= *ds_file_group
->ds_file_infos
[0];
342 g_string_append_printf(name
, " | %s", ds_file_info
.path
.c_str());
345 return bt2c::GCharUP
{g_string_free(name
, FALSE
)};
348 static int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
349 struct ctf_fs_ds_file_group
*ds_file_group
,
350 bt_self_component_source
*self_comp_src
)
353 ctf_fs_port_data::UP port_data
;
355 bt2c::GCharUP port_name
= ctf_fs_make_port_name(ds_file_group
);
360 BT_CPPLOGI_SPEC(ctf_fs
->logger
, "Creating one port named `{}`", port_name
.get());
362 /* Create output port for this file */
363 port_data
= bt2s::make_unique
<ctf_fs_port_data
>();
364 port_data
->ctf_fs
= ctf_fs
;
365 port_data
->ds_file_group
= ds_file_group
;
366 ret
= bt_self_component_source_add_output_port(self_comp_src
, port_name
.get(), port_data
.get(),
372 ctf_fs
->port_data
.emplace_back(std::move(port_data
));
382 static int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
383 struct ctf_fs_trace
*ctf_fs_trace
,
384 bt_self_component_source
*self_comp_src
)
388 /* Create one output port for each stream file group */
389 for (const auto& ds_file_group
: ctf_fs_trace
->ds_file_groups
) {
390 ret
= create_one_port_for_trace(ctf_fs
, ds_file_group
.get(), self_comp_src
);
392 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create output port.");
402 * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right
403 * place to keep it sorted.
406 static void ds_file_group_insert_ds_file_info_sorted(struct ctf_fs_ds_file_group
*ds_file_group
,
407 ctf_fs_ds_file_info::UP ds_file_info
)
409 /* Find the spot where to insert this ds_file_info. */
410 auto it
= ds_file_group
->ds_file_infos
.begin();
412 for (; it
!= ds_file_group
->ds_file_infos
.end(); ++it
) {
413 const ctf_fs_ds_file_info
& other_ds_file_info
= **it
;
415 if (ds_file_info
->begin_ns
< other_ds_file_info
.begin_ns
) {
420 ds_file_group
->ds_file_infos
.insert(it
, std::move(ds_file_info
));
423 static bool ds_index_entries_equal(const struct ctf_fs_ds_index_entry
*left
,
424 const struct ctf_fs_ds_index_entry
*right
)
426 if (left
->packetSize
!= right
->packetSize
) {
430 if (left
->timestamp_begin
!= right
->timestamp_begin
) {
434 if (left
->timestamp_end
!= right
->timestamp_end
) {
438 if (left
->packet_seq_num
!= right
->packet_seq_num
) {
446 * Insert `entry` into `index`, without duplication.
448 * The entry is inserted only if there isn't an identical entry already.
450 * In any case, the ownership of `entry` is transferred to this function. So if
451 * the entry is not inserted, it is freed.
454 static void ds_index_insert_ds_index_entry_sorted(struct ctf_fs_ds_index
*index
,
455 ctf_fs_ds_index_entry::UP entry
)
457 /* Find the spot where to insert this index entry. */
458 auto otherEntry
= index
->entries
.begin();
459 for (; otherEntry
!= index
->entries
.end(); ++otherEntry
) {
460 if (entry
->timestamp_begin_ns
<= (*otherEntry
)->timestamp_begin_ns
) {
466 * Insert the entry only if a duplicate doesn't already exist.
468 * There can be duplicate packets if reading multiple overlapping
469 * snapshots of the same trace. We then want the index to contain
470 * a reference to only one copy of that packet.
472 if (otherEntry
== index
->entries
.end() ||
473 !ds_index_entries_equal(entry
.get(), otherEntry
->get())) {
474 index
->entries
.insert(otherEntry
, std::move(entry
));
478 static void merge_ctf_fs_ds_indexes(struct ctf_fs_ds_index
*dest
, ctf_fs_ds_index::UP src
)
480 for (auto& entry
: src
->entries
) {
481 ds_index_insert_ds_index_entry_sorted(dest
, std::move(entry
));
485 static int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
, const char *path
)
487 int64_t stream_instance_id
= -1;
488 int64_t begin_ns
= -1;
489 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
490 ctf_fs_ds_file_group::UP new_ds_file_group
;
492 ctf_fs_ds_file_info::UP ds_file_info
;
493 ctf_fs_ds_index::UP index
;
494 ctf_msg_iter_up msg_iter
;
495 struct ctf_stream_class
*sc
= NULL
;
496 struct ctf_msg_iter_packet_properties props
;
499 * Create a temporary ds_file to read some properties about the data
503 ctf_fs_ds_file_create(ctf_fs_trace
, bt2::Stream::Shared
{}, path
, ctf_fs_trace
->logger
);
508 /* Create a temporary iterator to read the ds_file. */
509 msg_iter
= ctf_msg_iter_create(
510 ctf_fs_trace
->metadata
->tc
,
511 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
512 ctf_fs_ds_file_medops
, ds_file
.get(), nullptr, ctf_fs_trace
->logger
);
514 BT_CPPLOGE_STR_SPEC(ctf_fs_trace
->logger
, "Cannot create a CTF message iterator.");
518 ctf_msg_iter_set_dry_run(msg_iter
.get(), true);
520 ret
= ctf_msg_iter_get_packet_properties(msg_iter
.get(), &props
);
522 BT_CPPLOGE_APPEND_CAUSE_SPEC(
523 ctf_fs_trace
->logger
,
524 "Cannot get stream file's first packet's header and context fields (`{}`).", path
);
528 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
, props
.stream_class_id
);
530 stream_instance_id
= props
.data_stream_id
;
532 if (props
.snapshots
.beginning_clock
!= UINT64_C(-1)) {
533 BT_ASSERT(sc
->default_clock_class
);
534 ret
= bt_util_clock_cycles_to_ns_from_origin(
535 props
.snapshots
.beginning_clock
, sc
->default_clock_class
->frequency
,
536 sc
->default_clock_class
->offset_seconds
, sc
->default_clock_class
->offset_cycles
,
539 BT_CPPLOGE_APPEND_CAUSE_SPEC(
540 ctf_fs_trace
->logger
,
541 "Cannot convert clock cycles to nanoseconds from origin (`{}`).", path
);
546 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
);
551 index
= ctf_fs_ds_file_build_index(ds_file
.get(), ds_file_info
.get(), msg_iter
.get());
553 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to index CTF stream file \'{}\'",
554 ds_file
->file
->path
);
558 if (begin_ns
== -1) {
560 * No beginning timestamp to sort the stream files
561 * within a stream file group, so consider that this
562 * file must be the only one within its group.
564 stream_instance_id
= -1;
567 if (stream_instance_id
== -1) {
569 * No stream instance ID or no beginning timestamp:
570 * create a unique stream file group for this stream
571 * file because, even if there's a stream instance ID,
572 * there's no timestamp to order the file within its
576 ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, UINT64_C(-1), std::move(index
));
578 if (!new_ds_file_group
) {
582 ds_file_group_insert_ds_file_info_sorted(new_ds_file_group
.get(), std::move(ds_file_info
));
583 ctf_fs_trace
->ds_file_groups
.emplace_back(std::move(new_ds_file_group
));
587 BT_ASSERT(stream_instance_id
!= -1);
588 BT_ASSERT(begin_ns
!= -1);
590 /* Find an existing stream file group with this ID */
591 for (const auto& candidate
: ctf_fs_trace
->ds_file_groups
) {
592 if (candidate
->sc
== sc
&& candidate
->stream_id
== stream_instance_id
) {
593 ds_file_group
= candidate
.get();
598 if (!ds_file_group
) {
600 ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, stream_instance_id
, std::move(index
));
601 if (!new_ds_file_group
) {
605 ds_file_group
= new_ds_file_group
.get();
606 ctf_fs_trace
->ds_file_groups
.emplace_back(std::move(new_ds_file_group
));
608 merge_ctf_fs_ds_indexes(ds_file_group
->index
.get(), std::move(index
));
611 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, std::move(ds_file_info
));
622 static int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
625 const char *basename
;
626 GError
*error
= NULL
;
629 /* Check each file in the path directory, except specific ones */
630 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
632 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
633 "Cannot open directory `{}`: {} (code {})",
634 ctf_fs_trace
->path
->str
, error
->message
, error
->code
);
638 while ((basename
= g_dir_read_name(dir
))) {
639 if (strcmp(basename
, CTF_FS_METADATA_FILENAME
) == 0) {
640 /* Ignore the metadata stream. */
641 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
642 "Ignoring metadata file `{}" G_DIR_SEPARATOR_S
"{}`",
643 ctf_fs_trace
->path
->str
, basename
);
647 if (basename
[0] == '.') {
648 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
649 "Ignoring hidden file `{}" G_DIR_SEPARATOR_S
"{}`",
650 ctf_fs_trace
->path
->str
, basename
);
654 /* Create the file. */
655 const auto file
= ctf_fs_file_create(ctf_fs_trace
->logger
);
657 BT_CPPLOGE_APPEND_CAUSE_SPEC(
658 ctf_fs_trace
->logger
,
659 "Cannot create stream file object for file `{}" G_DIR_SEPARATOR_S
"{}`",
660 ctf_fs_trace
->path
->str
, basename
);
664 /* Create full path string. */
665 file
->path
= fmt::format("{}" G_DIR_SEPARATOR_S
"{}", ctf_fs_trace
->path
->str
, basename
);
667 if (!g_file_test(file
->path
.c_str(), G_FILE_TEST_IS_REGULAR
)) {
668 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring non-regular file `{}`", file
->path
);
672 ret
= ctf_fs_file_open(file
.get(), "rb");
674 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Cannot open stream file `{}`",
679 if (file
->size
== 0) {
680 /* Skip empty stream. */
681 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring empty file `{}`", file
->path
);
685 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
, file
->path
.c_str());
687 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
688 "Cannot add stream file `{}` to stream file group",
712 static int set_trace_name(bt_trace
*trace
, const char *name_suffix
, const bt2c::Logger
& logger
)
718 name
= g_string_new(NULL
);
720 BT_CPPLOGE_STR_SPEC(logger
, "Failed to allocate a GString.");
726 * Check if we have a trace environment string value named `hostname`.
727 * If so, use it as the trace name's prefix.
729 val
= bt_trace_borrow_environment_entry_value_by_name_const(trace
, "hostname");
730 if (val
&& bt_value_is_string(val
)) {
731 g_string_append(name
, bt_value_string_get(val
));
734 g_string_append_c(name
, G_DIR_SEPARATOR
);
739 g_string_append(name
, name_suffix
);
742 ret
= bt_trace_set_name(trace
, name
->str
);
751 g_string_free(name
, TRUE
);
757 static ctf_fs_trace::UP
ctf_fs_trace_create(const char *path
, const char *name
,
758 const ctf::src::ClkClsCfg
& clkClsCfg
,
759 bt_self_component
*selfComp
,
760 const bt2c::Logger
& parentLogger
)
764 ctf_fs_trace::UP ctf_fs_trace
{new struct ctf_fs_trace(parentLogger
)};
765 ctf_fs_trace
->path
= g_string_new(path
);
766 if (!ctf_fs_trace
->path
) {
770 ctf_fs_trace
->metadata
= new ctf_fs_metadata
;
771 ctf_fs_metadata_init(ctf_fs_trace
->metadata
);
773 ret
= ctf_fs_metadata_set_trace_class(selfComp
, ctf_fs_trace
.get(), clkClsCfg
);
778 if (ctf_fs_trace
->metadata
->trace_class
) {
779 ctf_fs_trace
->trace
= bt_trace_create(ctf_fs_trace
->metadata
->trace_class
);
780 if (!ctf_fs_trace
->trace
) {
785 if (ctf_fs_trace
->trace
) {
786 ret
= ctf_trace_class_configure_ir_trace(ctf_fs_trace
->metadata
->tc
, ctf_fs_trace
->trace
);
791 ret
= set_trace_name(ctf_fs_trace
->trace
, name
, ctf_fs_trace
->logger
);
797 ret
= create_ds_file_groups(ctf_fs_trace
.get());
805 ctf_fs_trace
.reset();
811 static int path_is_ctf_trace(const char *path
)
813 GString
*metadata_path
= g_string_new(NULL
);
816 if (!metadata_path
) {
821 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
823 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
829 g_string_free(metadata_path
, TRUE
);
833 /* Helper for ctf_fs_component_create_ctf_fs_trace, to handle a single path. */
835 static int ctf_fs_component_create_ctf_fs_trace_one_path(struct ctf_fs_component
*ctf_fs
,
836 const char *path_param
,
837 const char *trace_name
,
838 std::vector
<ctf_fs_trace::UP
>& traces
,
839 bt_self_component
*selfComp
)
841 ctf_fs_trace::UP ctf_fs_trace
;
845 norm_path
= bt_common_normalize_path(path_param
, NULL
);
847 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to normalize path: `{}`.", path_param
);
851 ret
= path_is_ctf_trace(norm_path
->str
);
853 BT_CPPLOGE_APPEND_CAUSE_SPEC(
854 ctf_fs
->logger
, "Failed to check if path is a CTF trace: path={}", norm_path
->str
);
856 } else if (ret
== 0) {
857 BT_CPPLOGE_APPEND_CAUSE_SPEC(
858 ctf_fs
->logger
, "Path is not a CTF trace (does not contain a metadata file): `{}`.",
863 // FIXME: Remove or ifdef for __MINGW32__
864 if (strcmp(norm_path
->str
, "/") == 0) {
865 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Opening a trace in `/` is not supported.");
870 ctf_fs_trace
= ctf_fs_trace_create(norm_path
->str
, trace_name
, ctf_fs
->clkClsCfg
, selfComp
,
873 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create trace for `{}`.",
878 traces
.emplace_back(std::move(ctf_fs_trace
));
888 g_string_free(norm_path
, TRUE
);
895 * Count the number of stream and event classes defined by this trace's metadata.
897 * This is used to determine which metadata is the "latest", out of multiple
898 * traces sharing the same UUID. It is assumed that amongst all these metadatas,
899 * a bigger metadata is a superset of a smaller metadata. Therefore, it is
900 * enough to just count the classes.
903 static unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace
*trace
)
905 unsigned int num
= trace
->metadata
->tc
->stream_classes
->len
;
908 for (i
= 0; i
< trace
->metadata
->tc
->stream_classes
->len
; i
++) {
909 struct ctf_stream_class
*sc
=
910 (struct ctf_stream_class
*) trace
->metadata
->tc
->stream_classes
->pdata
[i
];
911 num
+= sc
->event_classes
->len
;
918 * Merge the src ds_file_group into dest. This consists of merging their
919 * ds_file_infos, making sure to keep the result sorted.
922 static void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group
*dest
,
923 ctf_fs_ds_file_group::UP src
)
925 for (auto& ds_file_info
: src
->ds_file_infos
) {
926 ds_file_group_insert_ds_file_info_sorted(dest
, std::move(ds_file_info
));
929 /* Merge both indexes. */
930 merge_ctf_fs_ds_indexes(dest
->index
.get(), std::move(src
->index
));
933 /* Merge src_trace's data stream file groups into dest_trace's. */
935 static int merge_matching_ctf_fs_ds_file_groups(struct ctf_fs_trace
*dest_trace
,
936 ctf_fs_trace::UP src_trace
)
938 std::vector
<ctf_fs_ds_file_group::UP
>& dest
= dest_trace
->ds_file_groups
;
939 std::vector
<ctf_fs_ds_file_group::UP
>& src
= src_trace
->ds_file_groups
;
943 * Save the initial length of dest: we only want to check against the
944 * original elements in the inner loop.
946 size_t dest_len
= dest
.size();
948 for (auto& src_group
: src
) {
949 struct ctf_fs_ds_file_group
*dest_group
= NULL
;
951 /* A stream instance without ID can't match a stream in the other trace. */
952 if (src_group
->stream_id
!= -1) {
953 /* Let's search for a matching ds_file_group in the destination. */
954 for (size_t d_i
= 0; d_i
< dest_len
; ++d_i
) {
955 ctf_fs_ds_file_group
*candidate_dest
= dest
[d_i
].get();
957 /* Can't match a stream instance without ID. */
958 if (candidate_dest
->stream_id
== -1) {
963 * If the two groups have the same stream instance id
964 * and belong to the same stream class (stream instance
965 * ids are per-stream class), they represent the same
968 if (candidate_dest
->stream_id
!= src_group
->stream_id
||
969 candidate_dest
->sc
->id
!= src_group
->sc
->id
) {
973 dest_group
= candidate_dest
;
979 * Didn't find a friend in dest to merge our src_group into?
980 * Create a new empty one. This can happen if a stream was
981 * active in the source trace chunk but not in the destination
985 struct ctf_stream_class
*sc
;
987 sc
= ctf_trace_class_borrow_stream_class_by_id(dest_trace
->metadata
->tc
,
991 auto index
= ctf_fs_ds_index_create();
997 auto new_dest_group
=
998 ctf_fs_ds_file_group_create(dest_trace
, sc
, src_group
->stream_id
, std::move(index
));
1000 if (!new_dest_group
) {
1005 dest_group
= new_dest_group
.get();
1006 dest_trace
->ds_file_groups
.emplace_back(std::move(new_dest_group
));
1009 BT_ASSERT(dest_group
);
1010 merge_ctf_fs_ds_file_groups(dest_group
, std::move(src_group
));
1018 * Collapse the given traces, which must all share the same UUID, in a single
1021 * The trace with the most expansive metadata is chosen and all other traces
1022 * are merged into that one. On return, the elements of `traces` are nullptr
1023 * and the merged trace is placed in `out_trace`.
1026 static int merge_ctf_fs_traces(std::vector
<ctf_fs_trace::UP
> traces
, ctf_fs_trace::UP
& out_trace
)
1028 unsigned int winner_count
;
1029 struct ctf_fs_trace
*winner
;
1033 BT_ASSERT(traces
.size() >= 2);
1035 winner_count
= metadata_count_stream_and_event_classes(traces
[0].get());
1036 winner
= traces
[0].get();
1039 /* Find the trace with the largest metadata. */
1040 for (i
= 1; i
< traces
.size(); i
++) {
1041 ctf_fs_trace
*candidate
= traces
[i
].get();
1042 unsigned int candidate_count
;
1044 /* A bit of sanity check. */
1045 BT_ASSERT(bt_uuid_compare(winner
->metadata
->tc
->uuid
, candidate
->metadata
->tc
->uuid
) == 0);
1047 candidate_count
= metadata_count_stream_and_event_classes(candidate
);
1049 if (candidate_count
> winner_count
) {
1050 winner_count
= candidate_count
;
1056 /* Merge all the other traces in the winning trace. */
1057 for (ctf_fs_trace::UP
& trace
: traces
) {
1058 /* Don't merge the winner into itself. */
1059 if (trace
.get() == winner
) {
1063 /* Merge trace's data stream file groups into winner's. */
1064 ret
= merge_matching_ctf_fs_ds_file_groups(winner
, std::move(trace
));
1071 * Move the winner out of the array, into `*out_trace`.
1073 out_trace
= std::move(traces
[winner_i
]);
1085 static int decode_clock_snapshot_after_event(struct ctf_fs_trace
*ctf_fs_trace
,
1086 struct ctf_clock_class
*default_cc
,
1087 struct ctf_fs_ds_index_entry
*index_entry
,
1088 enum target_event target_event
, uint64_t *cs
,
1091 enum ctf_msg_iter_status iter_status
= CTF_MSG_ITER_STATUS_OK
;
1092 struct ctf_msg_iter
*msg_iter
= NULL
;
1095 BT_ASSERT(ctf_fs_trace
);
1096 BT_ASSERT(index_entry
);
1097 BT_ASSERT(index_entry
->path
);
1099 const auto ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, bt2::Stream::Shared
{},
1100 index_entry
->path
, ctf_fs_trace
->logger
);
1102 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to create a ctf_fs_ds_file");
1107 BT_ASSERT(ctf_fs_trace
->metadata
);
1108 BT_ASSERT(ctf_fs_trace
->metadata
->tc
);
1110 msg_iter
= ctf_msg_iter_create(
1111 ctf_fs_trace
->metadata
->tc
,
1112 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
1113 ctf_fs_ds_file_medops
, ds_file
.get(), NULL
, ctf_fs_trace
->logger
)
1116 /* ctf_msg_iter_create() logs errors. */
1122 * Turn on dry run mode to prevent the creation and usage of Babeltrace
1123 * library objects (bt_field, bt_message_*, etc.).
1125 ctf_msg_iter_set_dry_run(msg_iter
, true);
1127 /* Seek to the beginning of the target packet. */
1128 iter_status
= ctf_msg_iter_seek(msg_iter
, index_entry
->offset
.bytes());
1130 /* ctf_msg_iter_seek() logs errors. */
1135 switch (target_event
) {
1138 * Start to decode the packet until we reach the end of
1139 * the first event. To extract the first event's clock
1142 iter_status
= ctf_msg_iter_curr_packet_first_event_clock_snapshot(msg_iter
, cs
);
1145 /* Decode the packet to extract the last event's clock snapshot. */
1146 iter_status
= ctf_msg_iter_curr_packet_last_event_clock_snapshot(msg_iter
, cs
);
1156 /* Convert clock snapshot to timestamp. */
1157 ret
= bt_util_clock_cycles_to_ns_from_origin(
1158 *cs
, default_cc
->frequency
, default_cc
->offset_seconds
, default_cc
->offset_cycles
, ts_ns
);
1160 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1161 "Failed to convert clock snapshot to timestamp");
1167 ctf_msg_iter_destroy(msg_iter
);
1173 static int decode_packet_first_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1174 struct ctf_clock_class
*default_cc
,
1175 struct ctf_fs_ds_index_entry
*index_entry
,
1176 uint64_t *cs
, int64_t *ts_ns
)
1178 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, FIRST_EVENT
, cs
,
1182 static int decode_packet_last_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1183 struct ctf_clock_class
*default_cc
,
1184 struct ctf_fs_ds_index_entry
*index_entry
,
1185 uint64_t *cs
, int64_t *ts_ns
)
1187 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, LAST_EVENT
, cs
,
1192 * Fix up packet index entries for lttng's "event-after-packet" bug.
1193 * Some buggy lttng tracer versions may emit events with a timestamp that is
1194 * larger (after) than the timestamp_end of the their packets.
1196 * To fix up this erroneous data we do the following:
1197 * 1. If it's not the stream file's last packet: set the packet index entry's
1198 * end time to the next packet's beginning time.
1199 * 2. If it's the stream file's last packet, set the packet index entry's end
1200 * time to the packet's last event's time, if any, or to the packet's
1201 * beginning time otherwise.
1203 * Known buggy tracer versions:
1204 * - before lttng-ust 2.11.0
1205 * - before lttng-module 2.11.0
1206 * - before lttng-module 2.10.10
1207 * - before lttng-module 2.9.13
1209 static int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace
*trace
)
1213 for (const auto& ds_file_group
: trace
->ds_file_groups
) {
1214 struct ctf_clock_class
*default_cc
;
1216 BT_ASSERT(ds_file_group
);
1217 const auto index
= ds_file_group
->index
.get();
1220 BT_ASSERT(!index
->entries
.empty());
1223 * Iterate over all entries but the last one. The last one is
1224 * fixed differently after.
1226 for (size_t entry_i
= 0; entry_i
< index
->entries
.size() - 1; ++entry_i
) {
1227 ctf_fs_ds_index_entry
*curr_entry
= index
->entries
[entry_i
].get();
1228 ctf_fs_ds_index_entry
*next_entry
= index
->entries
[entry_i
+ 1].get();
1231 * 1. Set the current index entry `end` timestamp to
1232 * the next index entry `begin` timestamp.
1234 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1235 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1239 * 2. Fix the last entry by decoding the last event of the last
1242 const auto last_entry
= index
->entries
.back().get();
1243 BT_ASSERT(last_entry
);
1245 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1246 default_cc
= ds_file_group
->sc
->default_clock_class
;
1249 * Decode packet to read the timestamp of the last event of the
1252 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1253 &last_entry
->timestamp_end
,
1254 &last_entry
->timestamp_end_ns
);
1256 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1258 "Failed to decode stream's last packet to get its last event's clock snapshot.");
1268 * Fix up packet index entries for barectf's "event-before-packet" bug.
1269 * Some buggy barectf tracer versions may emit events with a timestamp that is
1270 * less than the timestamp_begin of the their packets.
1272 * To fix up this erroneous data we do the following:
1273 * 1. Starting at the second index entry, set the timestamp_begin of the
1274 * current entry to the timestamp of the first event of the packet.
1275 * 2. Set the previous entry's timestamp_end to the timestamp_begin of the
1278 * Known buggy tracer versions:
1279 * - before barectf 2.3.1
1281 static int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace
*trace
)
1285 for (const auto& ds_file_group
: trace
->ds_file_groups
) {
1286 struct ctf_clock_class
*default_cc
;
1287 const auto index
= ds_file_group
->index
.get();
1290 BT_ASSERT(!index
->entries
.empty());
1292 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1293 default_cc
= ds_file_group
->sc
->default_clock_class
;
1296 * 1. Iterate over the index, starting from the second entry
1299 for (size_t entry_i
= 1; entry_i
< index
->entries
.size(); ++entry_i
) {
1300 ctf_fs_ds_index_entry
*prev_entry
= index
->entries
[entry_i
- 1].get();
1301 ctf_fs_ds_index_entry
*curr_entry
= index
->entries
[entry_i
].get();
1303 * 2. Set the current entry `begin` timestamp to the
1304 * timestamp of the first event of the current packet.
1306 ret
= decode_packet_first_event_timestamp(trace
, default_cc
, curr_entry
,
1307 &curr_entry
->timestamp_begin
,
1308 &curr_entry
->timestamp_begin_ns
);
1310 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1311 "Failed to decode first event's clock snapshot");
1316 * 3. Set the previous entry `end` timestamp to the
1317 * timestamp of the first event of the current packet.
1319 prev_entry
->timestamp_end
= curr_entry
->timestamp_begin
;
1320 prev_entry
->timestamp_end_ns
= curr_entry
->timestamp_begin_ns
;
1328 * When using the lttng-crash feature it's likely that the last packets of each
1329 * stream have their timestamp_end set to zero. This is caused by the fact that
1330 * the tracer crashed and was not able to properly close the packets.
1332 * To fix up this erroneous data we do the following:
1333 * For each index entry, if the entry's timestamp_end is 0 and the
1334 * timestamp_begin is not 0:
1335 * - If it's the stream file's last packet: set the packet index entry's end
1336 * time to the packet's last event's time, if any, or to the packet's
1337 * beginning time otherwise.
1338 * - If it's not the stream file's last packet: set the packet index
1339 * entry's end time to the next packet's beginning time.
1341 * Affected versions:
1342 * - All current and future lttng-ust and lttng-modules versions.
1344 static int fix_index_lttng_crash_quirk(struct ctf_fs_trace
*trace
)
1348 for (const auto& ds_file_group
: trace
->ds_file_groups
) {
1349 struct ctf_clock_class
*default_cc
;
1351 BT_ASSERT(ds_file_group
);
1352 const auto index
= ds_file_group
->index
.get();
1354 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1355 default_cc
= ds_file_group
->sc
->default_clock_class
;
1358 BT_ASSERT(!index
->entries
.empty());
1360 const auto last_entry
= index
->entries
.back().get();
1361 BT_ASSERT(last_entry
);
1363 /* 1. Fix the last entry first. */
1364 if (last_entry
->timestamp_end
== 0 && last_entry
->timestamp_begin
!= 0) {
1366 * Decode packet to read the timestamp of the
1367 * last event of the stream file.
1369 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1370 &last_entry
->timestamp_end
,
1371 &last_entry
->timestamp_end_ns
);
1373 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1374 "Failed to decode last event's clock snapshot");
1379 /* Iterate over all entries but the last one. */
1380 for (size_t entry_idx
= 0; entry_idx
< index
->entries
.size() - 1; ++entry_idx
) {
1381 ctf_fs_ds_index_entry
*curr_entry
= index
->entries
[entry_idx
].get();
1382 ctf_fs_ds_index_entry
*next_entry
= index
->entries
[entry_idx
+ 1].get();
1384 if (curr_entry
->timestamp_end
== 0 && curr_entry
->timestamp_begin
!= 0) {
1386 * 2. Set the current index entry `end` timestamp to
1387 * the next index entry `begin` timestamp.
1389 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1390 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1400 * Extract the tracer information necessary to compare versions.
1401 * Returns 0 on success, and -1 if the extraction is not successful because the
1402 * necessary fields are absents in the trace metadata.
1404 static int extract_tracer_info(struct ctf_fs_trace
*trace
, struct tracer_info
*current_tracer_info
)
1407 struct ctf_trace_class_env_entry
*entry
;
1409 /* Clear the current_tracer_info struct */
1410 memset(current_tracer_info
, 0, sizeof(*current_tracer_info
));
1413 * To compare 2 tracer versions, at least the tracer name and it's
1414 * major version are needed. If one of these is missing, consider it an
1415 * extraction failure.
1417 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_name");
1418 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR
) {
1419 goto missing_bare_minimum
;
1422 /* Set tracer name. */
1423 current_tracer_info
->name
= entry
->value
.str
->str
;
1425 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_major");
1426 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1427 goto missing_bare_minimum
;
1430 /* Set major version number. */
1431 current_tracer_info
->major
= entry
->value
.i
;
1433 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_minor");
1434 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1438 /* Set minor version number. */
1439 current_tracer_info
->minor
= entry
->value
.i
;
1441 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patch");
1444 * If `tracer_patch` doesn't exist `tracer_patchlevel` might.
1445 * For example, `lttng-modules` uses entry name
1446 * `tracer_patchlevel`.
1448 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patchlevel");
1451 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1455 /* Set patch version number. */
1456 current_tracer_info
->patch
= entry
->value
.i
;
1460 missing_bare_minimum
:
1466 static bool is_tracer_affected_by_lttng_event_after_packet_bug(struct tracer_info
*curr_tracer_info
)
1468 bool is_affected
= false;
1470 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1471 if (curr_tracer_info
->major
< 2) {
1473 } else if (curr_tracer_info
->major
== 2) {
1474 /* fixed in lttng-ust 2.11.0 */
1475 if (curr_tracer_info
->minor
< 11) {
1479 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1480 if (curr_tracer_info
->major
< 2) {
1482 } else if (curr_tracer_info
->major
== 2) {
1483 /* fixed in lttng-modules 2.11.0 */
1484 if (curr_tracer_info
->minor
== 10) {
1485 /* fixed in lttng-modules 2.10.10 */
1486 if (curr_tracer_info
->patch
< 10) {
1489 } else if (curr_tracer_info
->minor
== 9) {
1490 /* fixed in lttng-modules 2.9.13 */
1491 if (curr_tracer_info
->patch
< 13) {
1494 } else if (curr_tracer_info
->minor
< 9) {
1504 is_tracer_affected_by_barectf_event_before_packet_bug(struct tracer_info
*curr_tracer_info
)
1506 bool is_affected
= false;
1508 if (strcmp(curr_tracer_info
->name
, "barectf") == 0) {
1509 if (curr_tracer_info
->major
< 2) {
1511 } else if (curr_tracer_info
->major
== 2) {
1512 if (curr_tracer_info
->minor
< 3) {
1514 } else if (curr_tracer_info
->minor
== 3) {
1515 /* fixed in barectf 2.3.1 */
1516 if (curr_tracer_info
->patch
< 1) {
1526 static bool is_tracer_affected_by_lttng_crash_quirk(struct tracer_info
*curr_tracer_info
)
1528 bool is_affected
= false;
1530 /* All LTTng tracer may be affected by this lttng crash quirk. */
1531 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1533 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1541 * Looks for trace produced by known buggy tracers and fix up the index
1544 static int fix_packet_index_tracer_bugs(ctf_fs_trace
*trace
)
1547 struct tracer_info current_tracer_info
;
1549 ret
= extract_tracer_info(trace
, ¤t_tracer_info
);
1552 * A trace may not have all the necessary environment
1553 * entries to do the tracer version comparison.
1554 * At least, the tracer name and major version number
1555 * are needed. Failing to extract these entries is not
1559 BT_CPPLOGI_STR_SPEC(
1561 "Cannot extract tracer information necessary to compare with buggy versions.");
1565 /* Check if the trace may be affected by old tracer bugs. */
1566 if (is_tracer_affected_by_lttng_event_after_packet_bug(¤t_tracer_info
)) {
1567 BT_CPPLOGI_STR_SPEC(
1569 "Trace may be affected by LTTng tracer packet timestamp bug. Fixing up.");
1570 ret
= fix_index_lttng_event_after_packet_bug(trace
);
1572 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1573 "Failed to fix LTTng event-after-packet bug.");
1576 trace
->metadata
->tc
->quirks
.lttng_event_after_packet
= true;
1579 if (is_tracer_affected_by_barectf_event_before_packet_bug(¤t_tracer_info
)) {
1580 BT_CPPLOGI_STR_SPEC(
1582 "Trace may be affected by barectf tracer packet timestamp bug. Fixing up.");
1583 ret
= fix_index_barectf_event_before_packet_bug(trace
);
1585 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1586 "Failed to fix barectf event-before-packet bug.");
1589 trace
->metadata
->tc
->quirks
.barectf_event_before_packet
= true;
1592 if (is_tracer_affected_by_lttng_crash_quirk(¤t_tracer_info
)) {
1593 ret
= fix_index_lttng_crash_quirk(trace
);
1595 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1596 "Failed to fix lttng-crash timestamp quirks.");
1599 trace
->metadata
->tc
->quirks
.lttng_crash
= true;
1606 static bool compare_ds_file_groups_by_first_path(const ctf_fs_ds_file_group::UP
& ds_file_group_a
,
1607 const ctf_fs_ds_file_group::UP
& ds_file_group_b
)
1609 BT_ASSERT(!ds_file_group_a
->ds_file_infos
.empty());
1610 BT_ASSERT(!ds_file_group_b
->ds_file_infos
.empty());
1612 const auto& first_ds_file_info_a
= *ds_file_group_a
->ds_file_infos
[0];
1613 const auto& first_ds_file_info_b
= *ds_file_group_b
->ds_file_infos
[0];
1615 return first_ds_file_info_a
.path
< first_ds_file_info_b
.path
;
1618 static gint
compare_strings(gconstpointer p_a
, gconstpointer p_b
)
1620 const char *a
= *((const char **) p_a
);
1621 const char *b
= *((const char **) p_b
);
1623 return strcmp(a
, b
);
1626 int ctf_fs_component_create_ctf_fs_trace(struct ctf_fs_component
*ctf_fs
,
1627 const bt_value
*paths_value
,
1628 const bt_value
*trace_name_value
,
1629 bt_self_component
*selfComp
)
1633 GPtrArray
*paths
= NULL
;
1634 std::vector
<ctf_fs_trace::UP
> traces
;
1635 const char *trace_name
;
1637 BT_ASSERT(bt_value_get_type(paths_value
) == BT_VALUE_TYPE_ARRAY
);
1638 BT_ASSERT(!bt_value_array_is_empty(paths_value
));
1640 paths
= g_ptr_array_new_with_free_func(g_free
);
1642 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to allocate a GPtrArray.");
1646 trace_name
= trace_name_value
? bt_value_string_get(trace_name_value
) : NULL
;
1649 * Create a sorted array of the paths, to make the execution of this
1650 * component deterministic.
1652 for (i
= 0; i
< bt_value_array_get_length(paths_value
); i
++) {
1653 const bt_value
*path_value
= bt_value_array_borrow_element_by_index_const(paths_value
, i
);
1654 const char *input
= bt_value_string_get(path_value
);
1657 input_copy
= g_strdup(input
);
1659 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to copy a string.");
1663 g_ptr_array_add(paths
, input_copy
);
1666 g_ptr_array_sort(paths
, compare_strings
);
1668 /* Create a separate ctf_fs_trace object for each path. */
1669 for (i
= 0; i
< paths
->len
; i
++) {
1670 const char *path
= (const char *) g_ptr_array_index(paths
, i
);
1672 ret
= ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs
, path
, trace_name
, traces
,
1679 if (traces
.size() > 1) {
1680 ctf_fs_trace
*first_trace
= traces
[0].get();
1681 const uint8_t *first_trace_uuid
= first_trace
->metadata
->tc
->uuid
;
1684 * We have more than one trace, they must all share the same
1685 * UUID, verify that.
1687 for (i
= 0; i
< traces
.size(); i
++) {
1688 ctf_fs_trace
*this_trace
= traces
[i
].get();
1689 const uint8_t *this_trace_uuid
= this_trace
->metadata
->tc
->uuid
;
1691 if (!this_trace
->metadata
->tc
->is_uuid_set
) {
1692 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1694 "Multiple traces given, but a trace does not have a UUID: path={}",
1695 this_trace
->path
->str
);
1699 if (bt_uuid_compare(first_trace_uuid
, this_trace_uuid
) != 0) {
1700 char first_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1701 char this_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1703 bt_uuid_to_str(first_trace_uuid
, first_trace_uuid_str
);
1704 bt_uuid_to_str(this_trace_uuid
, this_trace_uuid_str
);
1706 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1707 "Multiple traces given, but UUIDs don't match: "
1708 "first-trace-uuid={}, first-trace-path={}, "
1709 "trace-uuid={}, trace-path={}",
1710 first_trace_uuid_str
, first_trace
->path
->str
,
1711 this_trace_uuid_str
, this_trace
->path
->str
);
1716 ret
= merge_ctf_fs_traces(std::move(traces
), ctf_fs
->trace
);
1718 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1719 "Failed to merge traces with the same UUID.");
1723 /* Just one trace, it may or may not have a UUID, both are fine. */
1724 ctf_fs
->trace
= std::move(traces
[0]);
1727 ret
= fix_packet_index_tracer_bugs(ctf_fs
->trace
.get());
1729 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to fix packet index tracer bugs.");
1733 * Sort data stream file groups by first data stream file info
1734 * path to get a deterministic order. This order influences the
1735 * order of the output ports. It also influences the order of
1736 * the automatic stream IDs if the trace's packet headers do not
1737 * contain a `stream_instance_id` field, in which case the data
1738 * stream file to stream ID association is always the same,
1739 * whatever the build and the system.
1741 * Having a deterministic order here can help debugging and
1744 std::sort(ctf_fs
->trace
->ds_file_groups
.begin(), ctf_fs
->trace
->ds_file_groups
.end(),
1745 compare_ds_file_groups_by_first_path
);
1752 g_ptr_array_free(paths
, TRUE
);
1758 static GString
*get_stream_instance_unique_name(struct ctf_fs_ds_file_group
*ds_file_group
)
1761 struct ctf_fs_ds_file_info
*ds_file_info
;
1763 name
= g_string_new(NULL
);
1769 * If there's more than one stream file in the stream file
1770 * group, the first (earliest) stream file's path is used as
1771 * the stream's unique name.
1773 BT_ASSERT(!ds_file_group
->ds_file_infos
.empty());
1774 ds_file_info
= ds_file_group
->ds_file_infos
[0].get();
1775 g_string_assign(name
, ds_file_info
->path
.c_str());
1781 /* Create the IR stream objects for ctf_fs_trace. */
1783 static int create_streams_for_trace(struct ctf_fs_trace
*ctf_fs_trace
)
1786 GString
*name
= NULL
;
1788 for (const auto& ds_file_group
: ctf_fs_trace
->ds_file_groups
) {
1789 name
= get_stream_instance_unique_name(ds_file_group
.get());
1795 BT_ASSERT(ds_file_group
->sc
->ir_sc
);
1796 BT_ASSERT(ctf_fs_trace
->trace
);
1800 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
1801 /* No stream ID: use 0 */
1802 stream
= bt_stream_create_with_id(ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
,
1803 ctf_fs_trace
->next_stream_id
);
1804 ctf_fs_trace
->next_stream_id
++;
1806 /* Specific stream ID */
1807 stream
= bt_stream_create_with_id(ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
,
1808 (uint64_t) ds_file_group
->stream_id
);
1812 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1813 "Cannot create stream for DS file group: "
1814 "addr={}, stream-name=\"{}\"",
1815 fmt::ptr(ds_file_group
), name
->str
);
1819 ds_file_group
->stream
= bt2::Stream::Shared::createWithoutRef(stream
);
1821 ret
= bt_stream_set_name(ds_file_group
->stream
->libObjPtr(), name
->str
);
1823 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1824 "Cannot set stream's name: "
1825 "addr={}, stream-name=\"{}\"",
1826 fmt::ptr(ds_file_group
->stream
->libObjPtr()), name
->str
);
1830 g_string_free(name
, TRUE
);
1843 g_string_free(name
, TRUE
);
1848 static const bt_param_validation_value_descr inputs_elem_descr
=
1849 bt_param_validation_value_descr::makeString();
1851 static bt_param_validation_map_value_entry_descr fs_params_entries_descr
[] = {
1852 {"inputs", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
1853 bt_param_validation_value_descr::makeArray(1, BT_PARAM_VALIDATION_INFINITE
,
1854 inputs_elem_descr
)},
1855 {"trace-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1856 bt_param_validation_value_descr::makeString()},
1857 {"clock-class-offset-s", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1858 bt_param_validation_value_descr::makeSignedInteger()},
1859 {"clock-class-offset-ns", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1860 bt_param_validation_value_descr::makeSignedInteger()},
1861 {"force-clock-class-origin-unix-epoch", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1862 bt_param_validation_value_descr::makeBool()},
1863 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
1865 bool read_src_fs_parameters(const bt_value
*params
, const bt_value
**inputs
,
1866 const bt_value
**trace_name
, struct ctf_fs_component
*ctf_fs
)
1869 const bt_value
*value
;
1870 enum bt_param_validation_status validate_value_status
;
1871 gchar
*error
= NULL
;
1873 validate_value_status
= bt_param_validation_validate(params
, fs_params_entries_descr
, &error
);
1874 if (validate_value_status
!= BT_PARAM_VALIDATION_STATUS_OK
) {
1875 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "{}", error
);
1880 /* inputs parameter */
1881 *inputs
= bt_value_map_borrow_entry_value_const(params
, "inputs");
1883 /* clock-class-offset-s parameter */
1884 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-s");
1886 ctf_fs
->clkClsCfg
.offsetSec
= bt_value_integer_signed_get(value
);
1889 /* clock-class-offset-ns parameter */
1890 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-ns");
1892 ctf_fs
->clkClsCfg
.offsetNanoSec
= bt_value_integer_signed_get(value
);
1895 /* force-clock-class-origin-unix-epoch parameter */
1896 value
= bt_value_map_borrow_entry_value_const(params
, "force-clock-class-origin-unix-epoch");
1898 ctf_fs
->clkClsCfg
.forceOriginIsUnixEpoch
= bt_value_bool_get(value
);
1901 /* trace-name parameter */
1902 *trace_name
= bt_value_map_borrow_entry_value_const(params
, "trace-name");
1911 static ctf_fs_component::UP
ctf_fs_create(const bt_value
*params
,
1912 bt_self_component_source
*self_comp_src
)
1914 const bt_value
*inputs_value
;
1915 const bt_value
*trace_name_value
;
1916 bt_self_component
*self_comp
= bt_self_component_source_as_self_component(self_comp_src
);
1918 ctf_fs_component::UP ctf_fs
= ctf_fs_component_create(
1919 bt2c::Logger
{bt2::SelfSourceComponent
{self_comp_src
}, "PLUGIN/SRC.CTF.FS/COMP"});
1924 if (!read_src_fs_parameters(params
, &inputs_value
, &trace_name_value
, ctf_fs
.get())) {
1928 if (ctf_fs_component_create_ctf_fs_trace(ctf_fs
.get(), inputs_value
, trace_name_value
,
1933 if (create_streams_for_trace(ctf_fs
->trace
.get())) {
1937 if (create_ports_for_trace(ctf_fs
.get(), ctf_fs
->trace
.get(), self_comp_src
)) {
1944 bt_component_class_initialize_method_status
ctf_fs_init(bt_self_component_source
*self_comp_src
,
1945 bt_self_component_source_configuration
*,
1946 const bt_value
*params
, void *)
1949 bt_component_class_initialize_method_status ret
=
1950 BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
1952 ctf_fs_component::UP ctf_fs
= ctf_fs_create(params
, self_comp_src
);
1954 ret
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1957 bt_self_component_set_data(bt_self_component_source_as_self_component(self_comp_src
),
1960 } catch (const std::bad_alloc
&) {
1961 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1962 } catch (const bt2::Error
&) {
1963 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1967 bt_component_class_query_method_status
ctf_fs_query(bt_self_component_class_source
*comp_class_src
,
1968 bt_private_query_executor
*priv_query_exec
,
1969 const char *object
, const bt_value
*params
,
1970 __attribute__((unused
)) void *method_data
,
1971 const bt_value
**result
)
1974 bt2c::Logger logger
{bt2::SelfComponentClass
{comp_class_src
},
1975 bt2::PrivateQueryExecutor
{priv_query_exec
},
1976 "PLUGIN/SRC.CTF.FS/QUERY"};
1977 bt2::ConstMapValue
paramsObj(params
);
1978 bt2::Value::Shared resultObj
;
1980 if (strcmp(object
, "metadata-info") == 0) {
1981 resultObj
= metadata_info_query(paramsObj
, logger
);
1982 } else if (strcmp(object
, "babeltrace.trace-infos") == 0) {
1983 resultObj
= trace_infos_query(paramsObj
, logger
);
1984 } else if (!strcmp(object
, "babeltrace.support-info")) {
1985 resultObj
= support_info_query(paramsObj
, logger
);
1987 BT_CPPLOGE_SPEC(logger
, "Unknown query object `{}`", object
);
1988 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;
1991 *result
= resultObj
.release().libObjPtr();
1993 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
1994 } catch (const std::bad_alloc
&) {
1995 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
1996 } catch (const bt2::Error
&) {
1997 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;