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
);
48 if (msg_iter_data
->msg_iter_medops_data
) {
49 ctf_fs_ds_group_medops_data_destroy(msg_iter_data
->msg_iter_medops_data
);
55 static bt_message_iterator_class_next_method_status
56 ctf_fs_iterator_next_one(struct ctf_fs_msg_iter_data
*msg_iter_data
, const bt_message
**out_msg
)
58 bt_message_iterator_class_next_method_status status
;
59 enum ctf_msg_iter_status msg_iter_status
;
61 msg_iter_status
= ctf_msg_iter_get_next_message(msg_iter_data
->msg_iter
, out_msg
);
63 switch (msg_iter_status
) {
64 case CTF_MSG_ITER_STATUS_OK
:
65 /* Cool, message has been written to *out_msg. */
66 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
69 case CTF_MSG_ITER_STATUS_EOF
:
70 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END
;
73 case CTF_MSG_ITER_STATUS_AGAIN
:
75 * Should not make it this far as this is
76 * medium-specific; there is nothing for the user to do
77 * and it should have been handled upstream.
81 case CTF_MSG_ITER_STATUS_ERROR
:
82 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
83 "Failed to get next message from CTF message iterator.");
84 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
87 case CTF_MSG_ITER_STATUS_MEMORY_ERROR
:
88 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
89 "Failed to get next message from CTF message iterator.");
90 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
100 bt_message_iterator_class_next_method_status
101 ctf_fs_iterator_next(bt_self_message_iterator
*iterator
, bt_message_array_const msgs
,
102 uint64_t capacity
, uint64_t *count
)
105 bt_message_iterator_class_next_method_status status
;
106 struct ctf_fs_msg_iter_data
*msg_iter_data
=
107 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(iterator
);
110 if (G_UNLIKELY(msg_iter_data
->next_saved_error
)) {
112 * Last time we were called, we hit an error but had some
113 * messages to deliver, so we stashed the error here. Return
116 BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(msg_iter_data
->next_saved_error
);
117 status
= msg_iter_data
->next_saved_status
;
122 status
= ctf_fs_iterator_next_one(msg_iter_data
, &msgs
[i
]);
123 if (status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
) {
126 } while (i
< capacity
&& status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
);
130 * Even if ctf_fs_iterator_next_one() returned something
131 * else than BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK, we
132 * accumulated message objects in the output
133 * message array, so we need to return
134 * BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK so that they are
135 * transferred to downstream. This other status occurs
136 * again the next time muxer_msg_iter_do_next() is
137 * called, possibly without any accumulated
138 * message, in which case we'll return it.
142 * Save this error for the next _next call. Assume that
143 * this component always appends error causes when
144 * returning an error status code, which will cause the
145 * current thread error to be non-NULL.
147 msg_iter_data
->next_saved_error
= bt_current_thread_take_error();
148 BT_ASSERT(msg_iter_data
->next_saved_error
);
149 msg_iter_data
->next_saved_status
= status
;
153 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
159 } catch (const std::bad_alloc
&) {
160 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
161 } catch (const bt2::Error
&) {
162 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
166 bt_message_iterator_class_seek_beginning_method_status
167 ctf_fs_iterator_seek_beginning(bt_self_message_iterator
*it
)
170 struct ctf_fs_msg_iter_data
*msg_iter_data
=
171 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(it
);
173 BT_ASSERT(msg_iter_data
);
175 ctf_msg_iter_reset(msg_iter_data
->msg_iter
);
176 ctf_fs_ds_group_medops_data_reset(msg_iter_data
->msg_iter_medops_data
);
178 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_OK
;
179 } catch (const std::bad_alloc
&) {
180 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_MEMORY_ERROR
;
181 } catch (const bt2::Error
&) {
182 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_ERROR
;
186 void ctf_fs_iterator_finalize(bt_self_message_iterator
*it
)
188 ctf_fs_msg_iter_data_destroy(
189 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(it
));
192 static bt_message_iterator_class_initialize_method_status
193 ctf_msg_iter_medium_status_to_msg_iter_initialize_status(enum ctf_msg_iter_medium_status status
)
196 case CTF_MSG_ITER_MEDIUM_STATUS_EOF
:
197 case CTF_MSG_ITER_MEDIUM_STATUS_AGAIN
:
198 case CTF_MSG_ITER_MEDIUM_STATUS_ERROR
:
199 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
200 case CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
:
201 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
202 case CTF_MSG_ITER_MEDIUM_STATUS_OK
:
203 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
209 bt_message_iterator_class_initialize_method_status
210 ctf_fs_iterator_init(bt_self_message_iterator
*self_msg_iter
,
211 bt_self_message_iterator_configuration
*config
,
212 bt_self_component_port_output
*self_port
)
215 struct ctf_fs_port_data
*port_data
;
216 bt_message_iterator_class_initialize_method_status status
;
217 enum ctf_msg_iter_medium_status medium_status
;
219 port_data
= (struct ctf_fs_port_data
*) bt_self_component_port_get_data(
220 bt_self_component_port_output_as_self_component_port(self_port
));
221 BT_ASSERT(port_data
);
223 ctf_fs_msg_iter_data
*msg_iter_data
= new ctf_fs_msg_iter_data
{self_msg_iter
};
224 msg_iter_data
->ds_file_group
= port_data
->ds_file_group
;
226 medium_status
= ctf_fs_ds_group_medops_data_create(msg_iter_data
->ds_file_group
,
227 self_msg_iter
, msg_iter_data
->logger
,
228 &msg_iter_data
->msg_iter_medops_data
);
229 BT_ASSERT(medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_OK
||
230 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_ERROR
||
231 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
);
232 if (medium_status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
233 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
234 "Failed to create ctf_fs_ds_group_medops");
235 status
= ctf_msg_iter_medium_status_to_msg_iter_initialize_status(medium_status
);
239 msg_iter_data
->msg_iter
= ctf_msg_iter_create(
240 msg_iter_data
->ds_file_group
->ctf_fs_trace
->metadata
->tc
,
241 bt_common_get_page_size(static_cast<int>(msg_iter_data
->logger
.level())) * 8,
242 ctf_fs_ds_group_medops
, msg_iter_data
->msg_iter_medops_data
, self_msg_iter
,
243 msg_iter_data
->logger
);
244 if (!msg_iter_data
->msg_iter
) {
245 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
246 "Cannot create a CTF message iterator.");
247 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
252 * This iterator can seek forward if its stream class has a default
255 if (msg_iter_data
->ds_file_group
->sc
->default_clock_class
) {
256 bt_self_message_iterator_configuration_set_can_seek_forward(config
, true);
259 bt_self_message_iterator_set_data(self_msg_iter
, msg_iter_data
);
260 msg_iter_data
= NULL
;
262 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
266 bt_self_message_iterator_set_data(self_msg_iter
, NULL
);
269 ctf_fs_msg_iter_data_destroy(msg_iter_data
);
271 } catch (const std::bad_alloc
&) {
272 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
273 } catch (const bt2::Error
&) {
274 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
278 static void ctf_fs_trace_destroy(struct ctf_fs_trace
*ctf_fs_trace
)
284 BT_TRACE_PUT_REF_AND_RESET(ctf_fs_trace
->trace
);
286 if (ctf_fs_trace
->path
) {
287 g_string_free(ctf_fs_trace
->path
, TRUE
);
290 if (ctf_fs_trace
->metadata
) {
291 ctf_fs_metadata_fini(ctf_fs_trace
->metadata
);
292 delete ctf_fs_trace
->metadata
;
298 void ctf_fs_trace_deleter::operator()(ctf_fs_trace
* const trace
) noexcept
300 ctf_fs_trace_destroy(trace
);
303 void ctf_fs_destroy(struct ctf_fs_component
*ctf_fs
)
312 void ctf_fs_component_deleter::operator()(ctf_fs_component
*comp
)
314 ctf_fs_destroy(comp
);
317 ctf_fs_component::UP
ctf_fs_component_create(const bt2c::Logger
& parentLogger
)
319 return ctf_fs_component::UP
{new ctf_fs_component
{parentLogger
}};
322 void ctf_fs_finalize(bt_self_component_source
*component
)
324 ctf_fs_destroy((struct ctf_fs_component
*) bt_self_component_get_data(
325 bt_self_component_source_as_self_component(component
)));
328 bt2c::GCharUP
ctf_fs_make_port_name(struct ctf_fs_ds_file_group
*ds_file_group
)
330 GString
*name
= g_string_new(NULL
);
333 * The unique port name is generated by concatenating unique identifiers
341 /* For the trace, use the uuid if present, else the path. */
342 if (ds_file_group
->ctf_fs_trace
->metadata
->tc
->is_uuid_set
) {
343 char uuid_str
[BT_UUID_STR_LEN
+ 1];
345 bt_uuid_to_str(ds_file_group
->ctf_fs_trace
->metadata
->tc
->uuid
, uuid_str
);
346 g_string_assign(name
, uuid_str
);
348 g_string_assign(name
, ds_file_group
->ctf_fs_trace
->path
->str
);
352 * For the stream class, use the id if present. We can omit this field
353 * otherwise, as there will only be a single stream class.
355 if (ds_file_group
->sc
->id
!= UINT64_C(-1)) {
356 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->sc
->id
);
359 /* For the stream, use the id if present, else, use the path. */
360 if (ds_file_group
->stream_id
!= UINT64_C(-1)) {
361 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->stream_id
);
363 BT_ASSERT(ds_file_group
->ds_file_infos
.size() == 1);
364 const auto& ds_file_info
= *ds_file_group
->ds_file_infos
[0];
365 g_string_append_printf(name
, " | %s", ds_file_info
.path
.c_str());
368 return bt2c::GCharUP
{g_string_free(name
, FALSE
)};
371 static int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
372 struct ctf_fs_ds_file_group
*ds_file_group
,
373 bt_self_component_source
*self_comp_src
)
376 ctf_fs_port_data::UP port_data
;
378 bt2c::GCharUP port_name
= ctf_fs_make_port_name(ds_file_group
);
383 BT_CPPLOGI_SPEC(ctf_fs
->logger
, "Creating one port named `{}`", port_name
.get());
385 /* Create output port for this file */
386 port_data
= bt2s::make_unique
<ctf_fs_port_data
>();
387 port_data
->ctf_fs
= ctf_fs
;
388 port_data
->ds_file_group
= ds_file_group
;
389 ret
= bt_self_component_source_add_output_port(self_comp_src
, port_name
.get(), port_data
.get(),
395 ctf_fs
->port_data
.emplace_back(std::move(port_data
));
405 static int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
406 struct ctf_fs_trace
*ctf_fs_trace
,
407 bt_self_component_source
*self_comp_src
)
411 /* Create one output port for each stream file group */
412 for (const auto& ds_file_group
: ctf_fs_trace
->ds_file_groups
) {
413 ret
= create_one_port_for_trace(ctf_fs
, ds_file_group
.get(), self_comp_src
);
415 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create output port.");
425 * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right
426 * place to keep it sorted.
429 static void ds_file_group_insert_ds_file_info_sorted(struct ctf_fs_ds_file_group
*ds_file_group
,
430 ctf_fs_ds_file_info::UP ds_file_info
)
432 /* Find the spot where to insert this ds_file_info. */
433 auto it
= ds_file_group
->ds_file_infos
.begin();
435 for (; it
!= ds_file_group
->ds_file_infos
.end(); ++it
) {
436 const ctf_fs_ds_file_info
& other_ds_file_info
= **it
;
438 if (ds_file_info
->begin_ns
< other_ds_file_info
.begin_ns
) {
443 ds_file_group
->ds_file_infos
.insert(it
, std::move(ds_file_info
));
446 static bool ds_index_entries_equal(const struct ctf_fs_ds_index_entry
*left
,
447 const struct ctf_fs_ds_index_entry
*right
)
449 if (left
->packetSize
!= right
->packetSize
) {
453 if (left
->timestamp_begin
!= right
->timestamp_begin
) {
457 if (left
->timestamp_end
!= right
->timestamp_end
) {
461 if (left
->packet_seq_num
!= right
->packet_seq_num
) {
469 * Insert `entry` into `index`, without duplication.
471 * The entry is inserted only if there isn't an identical entry already.
473 * In any case, the ownership of `entry` is transferred to this function. So if
474 * the entry is not inserted, it is freed.
477 static void ds_index_insert_ds_index_entry_sorted(struct ctf_fs_ds_index
*index
,
478 ctf_fs_ds_index_entry::UP entry
)
480 /* Find the spot where to insert this index entry. */
481 auto otherEntry
= index
->entries
.begin();
482 for (; otherEntry
!= index
->entries
.end(); ++otherEntry
) {
483 if (entry
->timestamp_begin_ns
<= (*otherEntry
)->timestamp_begin_ns
) {
489 * Insert the entry only if a duplicate doesn't already exist.
491 * There can be duplicate packets if reading multiple overlapping
492 * snapshots of the same trace. We then want the index to contain
493 * a reference to only one copy of that packet.
495 if (otherEntry
== index
->entries
.end() ||
496 !ds_index_entries_equal(entry
.get(), otherEntry
->get())) {
497 index
->entries
.insert(otherEntry
, std::move(entry
));
501 static void merge_ctf_fs_ds_indexes(struct ctf_fs_ds_index
*dest
, ctf_fs_ds_index::UP src
)
503 for (auto& entry
: src
->entries
) {
504 ds_index_insert_ds_index_entry_sorted(dest
, std::move(entry
));
508 static int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
, const char *path
)
510 int64_t stream_instance_id
= -1;
511 int64_t begin_ns
= -1;
512 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
513 ctf_fs_ds_file_group::UP new_ds_file_group
;
515 ctf_fs_ds_file_info::UP ds_file_info
;
516 ctf_fs_ds_index::UP index
;
517 struct ctf_msg_iter
*msg_iter
= NULL
;
518 struct ctf_stream_class
*sc
= NULL
;
519 struct ctf_msg_iter_packet_properties props
;
522 * Create a temporary ds_file to read some properties about the data
526 ctf_fs_ds_file_create(ctf_fs_trace
, bt2::Stream::Shared
{}, path
, ctf_fs_trace
->logger
);
531 /* Create a temporary iterator to read the ds_file. */
532 msg_iter
= ctf_msg_iter_create(
533 ctf_fs_trace
->metadata
->tc
,
534 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
535 ctf_fs_ds_file_medops
, ds_file
.get(), nullptr, ctf_fs_trace
->logger
);
537 BT_CPPLOGE_STR_SPEC(ctf_fs_trace
->logger
, "Cannot create a CTF message iterator.");
541 ctf_msg_iter_set_dry_run(msg_iter
, true);
543 ret
= ctf_msg_iter_get_packet_properties(msg_iter
, &props
);
545 BT_CPPLOGE_APPEND_CAUSE_SPEC(
546 ctf_fs_trace
->logger
,
547 "Cannot get stream file's first packet's header and context fields (`{}`).", path
);
551 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
, props
.stream_class_id
);
553 stream_instance_id
= props
.data_stream_id
;
555 if (props
.snapshots
.beginning_clock
!= UINT64_C(-1)) {
556 BT_ASSERT(sc
->default_clock_class
);
557 ret
= bt_util_clock_cycles_to_ns_from_origin(
558 props
.snapshots
.beginning_clock
, sc
->default_clock_class
->frequency
,
559 sc
->default_clock_class
->offset_seconds
, sc
->default_clock_class
->offset_cycles
,
562 BT_CPPLOGE_APPEND_CAUSE_SPEC(
563 ctf_fs_trace
->logger
,
564 "Cannot convert clock cycles to nanoseconds from origin (`{}`).", path
);
569 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
);
574 index
= ctf_fs_ds_file_build_index(ds_file
.get(), ds_file_info
.get(), msg_iter
);
576 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to index CTF stream file \'{}\'",
577 ds_file
->file
->path
);
581 if (begin_ns
== -1) {
583 * No beginning timestamp to sort the stream files
584 * within a stream file group, so consider that this
585 * file must be the only one within its group.
587 stream_instance_id
= -1;
590 if (stream_instance_id
== -1) {
592 * No stream instance ID or no beginning timestamp:
593 * create a unique stream file group for this stream
594 * file because, even if there's a stream instance ID,
595 * there's no timestamp to order the file within its
599 ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, UINT64_C(-1), std::move(index
));
601 if (!new_ds_file_group
) {
605 ds_file_group_insert_ds_file_info_sorted(new_ds_file_group
.get(), std::move(ds_file_info
));
606 ctf_fs_trace
->ds_file_groups
.emplace_back(std::move(new_ds_file_group
));
610 BT_ASSERT(stream_instance_id
!= -1);
611 BT_ASSERT(begin_ns
!= -1);
613 /* Find an existing stream file group with this ID */
614 for (const auto& candidate
: ctf_fs_trace
->ds_file_groups
) {
615 if (candidate
->sc
== sc
&& candidate
->stream_id
== stream_instance_id
) {
616 ds_file_group
= candidate
.get();
621 if (!ds_file_group
) {
623 ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, stream_instance_id
, std::move(index
));
624 if (!new_ds_file_group
) {
628 ds_file_group
= new_ds_file_group
.get();
629 ctf_fs_trace
->ds_file_groups
.emplace_back(std::move(new_ds_file_group
));
631 merge_ctf_fs_ds_indexes(ds_file_group
->index
.get(), std::move(index
));
634 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, std::move(ds_file_info
));
643 ctf_msg_iter_destroy(msg_iter
);
649 static int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
652 const char *basename
;
653 GError
*error
= NULL
;
656 /* Check each file in the path directory, except specific ones */
657 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
659 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
660 "Cannot open directory `{}`: {} (code {})",
661 ctf_fs_trace
->path
->str
, error
->message
, error
->code
);
665 while ((basename
= g_dir_read_name(dir
))) {
666 if (strcmp(basename
, CTF_FS_METADATA_FILENAME
) == 0) {
667 /* Ignore the metadata stream. */
668 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
669 "Ignoring metadata file `{}" G_DIR_SEPARATOR_S
"{}`",
670 ctf_fs_trace
->path
->str
, basename
);
674 if (basename
[0] == '.') {
675 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
676 "Ignoring hidden file `{}" G_DIR_SEPARATOR_S
"{}`",
677 ctf_fs_trace
->path
->str
, basename
);
681 /* Create the file. */
682 const auto file
= ctf_fs_file_create(ctf_fs_trace
->logger
);
684 BT_CPPLOGE_APPEND_CAUSE_SPEC(
685 ctf_fs_trace
->logger
,
686 "Cannot create stream file object for file `{}" G_DIR_SEPARATOR_S
"{}`",
687 ctf_fs_trace
->path
->str
, basename
);
691 /* Create full path string. */
692 file
->path
= fmt::format("{}" G_DIR_SEPARATOR_S
"{}", ctf_fs_trace
->path
->str
, basename
);
694 if (!g_file_test(file
->path
.c_str(), G_FILE_TEST_IS_REGULAR
)) {
695 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring non-regular file `{}`", file
->path
);
699 ret
= ctf_fs_file_open(file
.get(), "rb");
701 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Cannot open stream file `{}`",
706 if (file
->size
== 0) {
707 /* Skip empty stream. */
708 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring empty file `{}`", file
->path
);
712 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
, file
->path
.c_str());
714 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
715 "Cannot add stream file `{}` to stream file group",
739 static int set_trace_name(bt_trace
*trace
, const char *name_suffix
, const bt2c::Logger
& logger
)
745 name
= g_string_new(NULL
);
747 BT_CPPLOGE_STR_SPEC(logger
, "Failed to allocate a GString.");
753 * Check if we have a trace environment string value named `hostname`.
754 * If so, use it as the trace name's prefix.
756 val
= bt_trace_borrow_environment_entry_value_by_name_const(trace
, "hostname");
757 if (val
&& bt_value_is_string(val
)) {
758 g_string_append(name
, bt_value_string_get(val
));
761 g_string_append_c(name
, G_DIR_SEPARATOR
);
766 g_string_append(name
, name_suffix
);
769 ret
= bt_trace_set_name(trace
, name
->str
);
778 g_string_free(name
, TRUE
);
784 static ctf_fs_trace::UP
ctf_fs_trace_create(const char *path
, const char *name
,
785 const ctf::src::ClkClsCfg
& clkClsCfg
,
786 bt_self_component
*selfComp
,
787 const bt2c::Logger
& parentLogger
)
791 ctf_fs_trace::UP ctf_fs_trace
{new struct ctf_fs_trace(parentLogger
)};
792 ctf_fs_trace
->path
= g_string_new(path
);
793 if (!ctf_fs_trace
->path
) {
797 ctf_fs_trace
->metadata
= new ctf_fs_metadata
;
798 ctf_fs_metadata_init(ctf_fs_trace
->metadata
);
800 ret
= ctf_fs_metadata_set_trace_class(selfComp
, ctf_fs_trace
.get(), clkClsCfg
);
805 if (ctf_fs_trace
->metadata
->trace_class
) {
806 ctf_fs_trace
->trace
= bt_trace_create(ctf_fs_trace
->metadata
->trace_class
);
807 if (!ctf_fs_trace
->trace
) {
812 if (ctf_fs_trace
->trace
) {
813 ret
= ctf_trace_class_configure_ir_trace(ctf_fs_trace
->metadata
->tc
, ctf_fs_trace
->trace
);
818 ret
= set_trace_name(ctf_fs_trace
->trace
, name
, ctf_fs_trace
->logger
);
824 ret
= create_ds_file_groups(ctf_fs_trace
.get());
832 ctf_fs_trace
.reset();
838 static int path_is_ctf_trace(const char *path
)
840 GString
*metadata_path
= g_string_new(NULL
);
843 if (!metadata_path
) {
848 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
850 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
856 g_string_free(metadata_path
, TRUE
);
860 /* Helper for ctf_fs_component_create_ctf_fs_trace, to handle a single path. */
862 static int ctf_fs_component_create_ctf_fs_trace_one_path(struct ctf_fs_component
*ctf_fs
,
863 const char *path_param
,
864 const char *trace_name
,
865 std::vector
<ctf_fs_trace::UP
>& traces
,
866 bt_self_component
*selfComp
)
868 ctf_fs_trace::UP ctf_fs_trace
;
872 norm_path
= bt_common_normalize_path(path_param
, NULL
);
874 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to normalize path: `{}`.", path_param
);
878 ret
= path_is_ctf_trace(norm_path
->str
);
880 BT_CPPLOGE_APPEND_CAUSE_SPEC(
881 ctf_fs
->logger
, "Failed to check if path is a CTF trace: path={}", norm_path
->str
);
883 } else if (ret
== 0) {
884 BT_CPPLOGE_APPEND_CAUSE_SPEC(
885 ctf_fs
->logger
, "Path is not a CTF trace (does not contain a metadata file): `{}`.",
890 // FIXME: Remove or ifdef for __MINGW32__
891 if (strcmp(norm_path
->str
, "/") == 0) {
892 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Opening a trace in `/` is not supported.");
897 ctf_fs_trace
= ctf_fs_trace_create(norm_path
->str
, trace_name
, ctf_fs
->clkClsCfg
, selfComp
,
900 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create trace for `{}`.",
905 traces
.emplace_back(std::move(ctf_fs_trace
));
915 g_string_free(norm_path
, TRUE
);
922 * Count the number of stream and event classes defined by this trace's metadata.
924 * This is used to determine which metadata is the "latest", out of multiple
925 * traces sharing the same UUID. It is assumed that amongst all these metadatas,
926 * a bigger metadata is a superset of a smaller metadata. Therefore, it is
927 * enough to just count the classes.
930 static unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace
*trace
)
932 unsigned int num
= trace
->metadata
->tc
->stream_classes
->len
;
935 for (i
= 0; i
< trace
->metadata
->tc
->stream_classes
->len
; i
++) {
936 struct ctf_stream_class
*sc
=
937 (struct ctf_stream_class
*) trace
->metadata
->tc
->stream_classes
->pdata
[i
];
938 num
+= sc
->event_classes
->len
;
945 * Merge the src ds_file_group into dest. This consists of merging their
946 * ds_file_infos, making sure to keep the result sorted.
949 static void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group
*dest
,
950 ctf_fs_ds_file_group::UP src
)
952 for (auto& ds_file_info
: src
->ds_file_infos
) {
953 ds_file_group_insert_ds_file_info_sorted(dest
, std::move(ds_file_info
));
956 /* Merge both indexes. */
957 merge_ctf_fs_ds_indexes(dest
->index
.get(), std::move(src
->index
));
960 /* Merge src_trace's data stream file groups into dest_trace's. */
962 static int merge_matching_ctf_fs_ds_file_groups(struct ctf_fs_trace
*dest_trace
,
963 ctf_fs_trace::UP src_trace
)
965 std::vector
<ctf_fs_ds_file_group::UP
>& dest
= dest_trace
->ds_file_groups
;
966 std::vector
<ctf_fs_ds_file_group::UP
>& src
= src_trace
->ds_file_groups
;
970 * Save the initial length of dest: we only want to check against the
971 * original elements in the inner loop.
973 size_t dest_len
= dest
.size();
975 for (auto& src_group
: src
) {
976 struct ctf_fs_ds_file_group
*dest_group
= NULL
;
978 /* A stream instance without ID can't match a stream in the other trace. */
979 if (src_group
->stream_id
!= -1) {
980 /* Let's search for a matching ds_file_group in the destination. */
981 for (size_t d_i
= 0; d_i
< dest_len
; ++d_i
) {
982 ctf_fs_ds_file_group
*candidate_dest
= dest
[d_i
].get();
984 /* Can't match a stream instance without ID. */
985 if (candidate_dest
->stream_id
== -1) {
990 * If the two groups have the same stream instance id
991 * and belong to the same stream class (stream instance
992 * ids are per-stream class), they represent the same
995 if (candidate_dest
->stream_id
!= src_group
->stream_id
||
996 candidate_dest
->sc
->id
!= src_group
->sc
->id
) {
1000 dest_group
= candidate_dest
;
1006 * Didn't find a friend in dest to merge our src_group into?
1007 * Create a new empty one. This can happen if a stream was
1008 * active in the source trace chunk but not in the destination
1012 struct ctf_stream_class
*sc
;
1014 sc
= ctf_trace_class_borrow_stream_class_by_id(dest_trace
->metadata
->tc
,
1018 auto index
= ctf_fs_ds_index_create();
1024 auto new_dest_group
=
1025 ctf_fs_ds_file_group_create(dest_trace
, sc
, src_group
->stream_id
, std::move(index
));
1027 if (!new_dest_group
) {
1032 dest_group
= new_dest_group
.get();
1033 dest_trace
->ds_file_groups
.emplace_back(std::move(new_dest_group
));
1036 BT_ASSERT(dest_group
);
1037 merge_ctf_fs_ds_file_groups(dest_group
, std::move(src_group
));
1045 * Collapse the given traces, which must all share the same UUID, in a single
1048 * The trace with the most expansive metadata is chosen and all other traces
1049 * are merged into that one. On return, the elements of `traces` are nullptr
1050 * and the merged trace is placed in `out_trace`.
1053 static int merge_ctf_fs_traces(std::vector
<ctf_fs_trace::UP
> traces
, ctf_fs_trace::UP
& out_trace
)
1055 unsigned int winner_count
;
1056 struct ctf_fs_trace
*winner
;
1060 BT_ASSERT(traces
.size() >= 2);
1062 winner_count
= metadata_count_stream_and_event_classes(traces
[0].get());
1063 winner
= traces
[0].get();
1066 /* Find the trace with the largest metadata. */
1067 for (i
= 1; i
< traces
.size(); i
++) {
1068 ctf_fs_trace
*candidate
= traces
[i
].get();
1069 unsigned int candidate_count
;
1071 /* A bit of sanity check. */
1072 BT_ASSERT(bt_uuid_compare(winner
->metadata
->tc
->uuid
, candidate
->metadata
->tc
->uuid
) == 0);
1074 candidate_count
= metadata_count_stream_and_event_classes(candidate
);
1076 if (candidate_count
> winner_count
) {
1077 winner_count
= candidate_count
;
1083 /* Merge all the other traces in the winning trace. */
1084 for (ctf_fs_trace::UP
& trace
: traces
) {
1085 /* Don't merge the winner into itself. */
1086 if (trace
.get() == winner
) {
1090 /* Merge trace's data stream file groups into winner's. */
1091 ret
= merge_matching_ctf_fs_ds_file_groups(winner
, std::move(trace
));
1098 * Move the winner out of the array, into `*out_trace`.
1100 out_trace
= std::move(traces
[winner_i
]);
1112 static int decode_clock_snapshot_after_event(struct ctf_fs_trace
*ctf_fs_trace
,
1113 struct ctf_clock_class
*default_cc
,
1114 struct ctf_fs_ds_index_entry
*index_entry
,
1115 enum target_event target_event
, uint64_t *cs
,
1118 enum ctf_msg_iter_status iter_status
= CTF_MSG_ITER_STATUS_OK
;
1119 struct ctf_msg_iter
*msg_iter
= NULL
;
1122 BT_ASSERT(ctf_fs_trace
);
1123 BT_ASSERT(index_entry
);
1124 BT_ASSERT(index_entry
->path
);
1126 const auto ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, bt2::Stream::Shared
{},
1127 index_entry
->path
, ctf_fs_trace
->logger
);
1129 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to create a ctf_fs_ds_file");
1134 BT_ASSERT(ctf_fs_trace
->metadata
);
1135 BT_ASSERT(ctf_fs_trace
->metadata
->tc
);
1137 msg_iter
= ctf_msg_iter_create(
1138 ctf_fs_trace
->metadata
->tc
,
1139 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
1140 ctf_fs_ds_file_medops
, ds_file
.get(), NULL
, ctf_fs_trace
->logger
);
1142 /* ctf_msg_iter_create() logs errors. */
1148 * Turn on dry run mode to prevent the creation and usage of Babeltrace
1149 * library objects (bt_field, bt_message_*, etc.).
1151 ctf_msg_iter_set_dry_run(msg_iter
, true);
1153 /* Seek to the beginning of the target packet. */
1154 iter_status
= ctf_msg_iter_seek(msg_iter
, index_entry
->offset
.bytes());
1156 /* ctf_msg_iter_seek() logs errors. */
1161 switch (target_event
) {
1164 * Start to decode the packet until we reach the end of
1165 * the first event. To extract the first event's clock
1168 iter_status
= ctf_msg_iter_curr_packet_first_event_clock_snapshot(msg_iter
, cs
);
1171 /* Decode the packet to extract the last event's clock snapshot. */
1172 iter_status
= ctf_msg_iter_curr_packet_last_event_clock_snapshot(msg_iter
, cs
);
1182 /* Convert clock snapshot to timestamp. */
1183 ret
= bt_util_clock_cycles_to_ns_from_origin(
1184 *cs
, default_cc
->frequency
, default_cc
->offset_seconds
, default_cc
->offset_cycles
, ts_ns
);
1186 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1187 "Failed to convert clock snapshot to timestamp");
1193 ctf_msg_iter_destroy(msg_iter
);
1199 static int decode_packet_first_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1200 struct ctf_clock_class
*default_cc
,
1201 struct ctf_fs_ds_index_entry
*index_entry
,
1202 uint64_t *cs
, int64_t *ts_ns
)
1204 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, FIRST_EVENT
, cs
,
1208 static int decode_packet_last_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1209 struct ctf_clock_class
*default_cc
,
1210 struct ctf_fs_ds_index_entry
*index_entry
,
1211 uint64_t *cs
, int64_t *ts_ns
)
1213 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, LAST_EVENT
, cs
,
1218 * Fix up packet index entries for lttng's "event-after-packet" bug.
1219 * Some buggy lttng tracer versions may emit events with a timestamp that is
1220 * larger (after) than the timestamp_end of the their packets.
1222 * To fix up this erroneous data we do the following:
1223 * 1. If it's not the stream file's last packet: set the packet index entry's
1224 * end time to the next packet's beginning time.
1225 * 2. If it's the stream file's last packet, set the packet index entry's end
1226 * time to the packet's last event's time, if any, or to the packet's
1227 * beginning time otherwise.
1229 * Known buggy tracer versions:
1230 * - before lttng-ust 2.11.0
1231 * - before lttng-module 2.11.0
1232 * - before lttng-module 2.10.10
1233 * - before lttng-module 2.9.13
1235 static int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace
*trace
)
1239 for (const auto& ds_file_group
: trace
->ds_file_groups
) {
1240 struct ctf_clock_class
*default_cc
;
1242 BT_ASSERT(ds_file_group
);
1243 const auto index
= ds_file_group
->index
.get();
1246 BT_ASSERT(!index
->entries
.empty());
1249 * Iterate over all entries but the last one. The last one is
1250 * fixed differently after.
1252 for (size_t entry_i
= 0; entry_i
< index
->entries
.size() - 1; ++entry_i
) {
1253 ctf_fs_ds_index_entry
*curr_entry
= index
->entries
[entry_i
].get();
1254 ctf_fs_ds_index_entry
*next_entry
= index
->entries
[entry_i
+ 1].get();
1257 * 1. Set the current index entry `end` timestamp to
1258 * the next index entry `begin` timestamp.
1260 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1261 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1265 * 2. Fix the last entry by decoding the last event of the last
1268 const auto last_entry
= index
->entries
.back().get();
1269 BT_ASSERT(last_entry
);
1271 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1272 default_cc
= ds_file_group
->sc
->default_clock_class
;
1275 * Decode packet to read the timestamp of the last event of the
1278 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1279 &last_entry
->timestamp_end
,
1280 &last_entry
->timestamp_end_ns
);
1282 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1284 "Failed to decode stream's last packet to get its last event's clock snapshot.");
1294 * Fix up packet index entries for barectf's "event-before-packet" bug.
1295 * Some buggy barectf tracer versions may emit events with a timestamp that is
1296 * less than the timestamp_begin of the their packets.
1298 * To fix up this erroneous data we do the following:
1299 * 1. Starting at the second index entry, set the timestamp_begin of the
1300 * current entry to the timestamp of the first event of the packet.
1301 * 2. Set the previous entry's timestamp_end to the timestamp_begin of the
1304 * Known buggy tracer versions:
1305 * - before barectf 2.3.1
1307 static int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace
*trace
)
1311 for (const auto& ds_file_group
: trace
->ds_file_groups
) {
1312 struct ctf_clock_class
*default_cc
;
1313 const auto index
= ds_file_group
->index
.get();
1316 BT_ASSERT(!index
->entries
.empty());
1318 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1319 default_cc
= ds_file_group
->sc
->default_clock_class
;
1322 * 1. Iterate over the index, starting from the second entry
1325 for (size_t entry_i
= 1; entry_i
< index
->entries
.size(); ++entry_i
) {
1326 ctf_fs_ds_index_entry
*prev_entry
= index
->entries
[entry_i
- 1].get();
1327 ctf_fs_ds_index_entry
*curr_entry
= index
->entries
[entry_i
].get();
1329 * 2. Set the current entry `begin` timestamp to the
1330 * timestamp of the first event of the current packet.
1332 ret
= decode_packet_first_event_timestamp(trace
, default_cc
, curr_entry
,
1333 &curr_entry
->timestamp_begin
,
1334 &curr_entry
->timestamp_begin_ns
);
1336 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1337 "Failed to decode first event's clock snapshot");
1342 * 3. Set the previous entry `end` timestamp to the
1343 * timestamp of the first event of the current packet.
1345 prev_entry
->timestamp_end
= curr_entry
->timestamp_begin
;
1346 prev_entry
->timestamp_end_ns
= curr_entry
->timestamp_begin_ns
;
1354 * When using the lttng-crash feature it's likely that the last packets of each
1355 * stream have their timestamp_end set to zero. This is caused by the fact that
1356 * the tracer crashed and was not able to properly close the packets.
1358 * To fix up this erroneous data we do the following:
1359 * For each index entry, if the entry's timestamp_end is 0 and the
1360 * timestamp_begin is not 0:
1361 * - If it's the stream file's last packet: set the packet index entry's end
1362 * time to the packet's last event's time, if any, or to the packet's
1363 * beginning time otherwise.
1364 * - If it's not the stream file's last packet: set the packet index
1365 * entry's end time to the next packet's beginning time.
1367 * Affected versions:
1368 * - All current and future lttng-ust and lttng-modules versions.
1370 static int fix_index_lttng_crash_quirk(struct ctf_fs_trace
*trace
)
1374 for (const auto& ds_file_group
: trace
->ds_file_groups
) {
1375 struct ctf_clock_class
*default_cc
;
1377 BT_ASSERT(ds_file_group
);
1378 const auto index
= ds_file_group
->index
.get();
1380 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1381 default_cc
= ds_file_group
->sc
->default_clock_class
;
1384 BT_ASSERT(!index
->entries
.empty());
1386 const auto last_entry
= index
->entries
.back().get();
1387 BT_ASSERT(last_entry
);
1389 /* 1. Fix the last entry first. */
1390 if (last_entry
->timestamp_end
== 0 && last_entry
->timestamp_begin
!= 0) {
1392 * Decode packet to read the timestamp of the
1393 * last event of the stream file.
1395 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1396 &last_entry
->timestamp_end
,
1397 &last_entry
->timestamp_end_ns
);
1399 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1400 "Failed to decode last event's clock snapshot");
1405 /* Iterate over all entries but the last one. */
1406 for (size_t entry_idx
= 0; entry_idx
< index
->entries
.size() - 1; ++entry_idx
) {
1407 ctf_fs_ds_index_entry
*curr_entry
= index
->entries
[entry_idx
].get();
1408 ctf_fs_ds_index_entry
*next_entry
= index
->entries
[entry_idx
+ 1].get();
1410 if (curr_entry
->timestamp_end
== 0 && curr_entry
->timestamp_begin
!= 0) {
1412 * 2. Set the current index entry `end` timestamp to
1413 * the next index entry `begin` timestamp.
1415 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1416 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1426 * Extract the tracer information necessary to compare versions.
1427 * Returns 0 on success, and -1 if the extraction is not successful because the
1428 * necessary fields are absents in the trace metadata.
1430 static int extract_tracer_info(struct ctf_fs_trace
*trace
, struct tracer_info
*current_tracer_info
)
1433 struct ctf_trace_class_env_entry
*entry
;
1435 /* Clear the current_tracer_info struct */
1436 memset(current_tracer_info
, 0, sizeof(*current_tracer_info
));
1439 * To compare 2 tracer versions, at least the tracer name and it's
1440 * major version are needed. If one of these is missing, consider it an
1441 * extraction failure.
1443 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_name");
1444 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR
) {
1445 goto missing_bare_minimum
;
1448 /* Set tracer name. */
1449 current_tracer_info
->name
= entry
->value
.str
->str
;
1451 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_major");
1452 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1453 goto missing_bare_minimum
;
1456 /* Set major version number. */
1457 current_tracer_info
->major
= entry
->value
.i
;
1459 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_minor");
1460 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1464 /* Set minor version number. */
1465 current_tracer_info
->minor
= entry
->value
.i
;
1467 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patch");
1470 * If `tracer_patch` doesn't exist `tracer_patchlevel` might.
1471 * For example, `lttng-modules` uses entry name
1472 * `tracer_patchlevel`.
1474 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patchlevel");
1477 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1481 /* Set patch version number. */
1482 current_tracer_info
->patch
= entry
->value
.i
;
1486 missing_bare_minimum
:
1492 static bool is_tracer_affected_by_lttng_event_after_packet_bug(struct tracer_info
*curr_tracer_info
)
1494 bool is_affected
= false;
1496 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1497 if (curr_tracer_info
->major
< 2) {
1499 } else if (curr_tracer_info
->major
== 2) {
1500 /* fixed in lttng-ust 2.11.0 */
1501 if (curr_tracer_info
->minor
< 11) {
1505 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1506 if (curr_tracer_info
->major
< 2) {
1508 } else if (curr_tracer_info
->major
== 2) {
1509 /* fixed in lttng-modules 2.11.0 */
1510 if (curr_tracer_info
->minor
== 10) {
1511 /* fixed in lttng-modules 2.10.10 */
1512 if (curr_tracer_info
->patch
< 10) {
1515 } else if (curr_tracer_info
->minor
== 9) {
1516 /* fixed in lttng-modules 2.9.13 */
1517 if (curr_tracer_info
->patch
< 13) {
1520 } else if (curr_tracer_info
->minor
< 9) {
1530 is_tracer_affected_by_barectf_event_before_packet_bug(struct tracer_info
*curr_tracer_info
)
1532 bool is_affected
= false;
1534 if (strcmp(curr_tracer_info
->name
, "barectf") == 0) {
1535 if (curr_tracer_info
->major
< 2) {
1537 } else if (curr_tracer_info
->major
== 2) {
1538 if (curr_tracer_info
->minor
< 3) {
1540 } else if (curr_tracer_info
->minor
== 3) {
1541 /* fixed in barectf 2.3.1 */
1542 if (curr_tracer_info
->patch
< 1) {
1552 static bool is_tracer_affected_by_lttng_crash_quirk(struct tracer_info
*curr_tracer_info
)
1554 bool is_affected
= false;
1556 /* All LTTng tracer may be affected by this lttng crash quirk. */
1557 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1559 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1567 * Looks for trace produced by known buggy tracers and fix up the index
1570 static int fix_packet_index_tracer_bugs(ctf_fs_trace
*trace
)
1573 struct tracer_info current_tracer_info
;
1575 ret
= extract_tracer_info(trace
, ¤t_tracer_info
);
1578 * A trace may not have all the necessary environment
1579 * entries to do the tracer version comparison.
1580 * At least, the tracer name and major version number
1581 * are needed. Failing to extract these entries is not
1585 BT_CPPLOGI_STR_SPEC(
1587 "Cannot extract tracer information necessary to compare with buggy versions.");
1591 /* Check if the trace may be affected by old tracer bugs. */
1592 if (is_tracer_affected_by_lttng_event_after_packet_bug(¤t_tracer_info
)) {
1593 BT_CPPLOGI_STR_SPEC(
1595 "Trace may be affected by LTTng tracer packet timestamp bug. Fixing up.");
1596 ret
= fix_index_lttng_event_after_packet_bug(trace
);
1598 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1599 "Failed to fix LTTng event-after-packet bug.");
1602 trace
->metadata
->tc
->quirks
.lttng_event_after_packet
= true;
1605 if (is_tracer_affected_by_barectf_event_before_packet_bug(¤t_tracer_info
)) {
1606 BT_CPPLOGI_STR_SPEC(
1608 "Trace may be affected by barectf tracer packet timestamp bug. Fixing up.");
1609 ret
= fix_index_barectf_event_before_packet_bug(trace
);
1611 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1612 "Failed to fix barectf event-before-packet bug.");
1615 trace
->metadata
->tc
->quirks
.barectf_event_before_packet
= true;
1618 if (is_tracer_affected_by_lttng_crash_quirk(¤t_tracer_info
)) {
1619 ret
= fix_index_lttng_crash_quirk(trace
);
1621 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1622 "Failed to fix lttng-crash timestamp quirks.");
1625 trace
->metadata
->tc
->quirks
.lttng_crash
= true;
1632 static bool compare_ds_file_groups_by_first_path(const ctf_fs_ds_file_group::UP
& ds_file_group_a
,
1633 const ctf_fs_ds_file_group::UP
& ds_file_group_b
)
1635 BT_ASSERT(!ds_file_group_a
->ds_file_infos
.empty());
1636 BT_ASSERT(!ds_file_group_b
->ds_file_infos
.empty());
1638 const auto& first_ds_file_info_a
= *ds_file_group_a
->ds_file_infos
[0];
1639 const auto& first_ds_file_info_b
= *ds_file_group_b
->ds_file_infos
[0];
1641 return first_ds_file_info_a
.path
< first_ds_file_info_b
.path
;
1644 static gint
compare_strings(gconstpointer p_a
, gconstpointer p_b
)
1646 const char *a
= *((const char **) p_a
);
1647 const char *b
= *((const char **) p_b
);
1649 return strcmp(a
, b
);
1652 int ctf_fs_component_create_ctf_fs_trace(struct ctf_fs_component
*ctf_fs
,
1653 const bt_value
*paths_value
,
1654 const bt_value
*trace_name_value
,
1655 bt_self_component
*selfComp
)
1659 GPtrArray
*paths
= NULL
;
1660 std::vector
<ctf_fs_trace::UP
> traces
;
1661 const char *trace_name
;
1663 BT_ASSERT(bt_value_get_type(paths_value
) == BT_VALUE_TYPE_ARRAY
);
1664 BT_ASSERT(!bt_value_array_is_empty(paths_value
));
1666 paths
= g_ptr_array_new_with_free_func(g_free
);
1668 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to allocate a GPtrArray.");
1672 trace_name
= trace_name_value
? bt_value_string_get(trace_name_value
) : NULL
;
1675 * Create a sorted array of the paths, to make the execution of this
1676 * component deterministic.
1678 for (i
= 0; i
< bt_value_array_get_length(paths_value
); i
++) {
1679 const bt_value
*path_value
= bt_value_array_borrow_element_by_index_const(paths_value
, i
);
1680 const char *input
= bt_value_string_get(path_value
);
1683 input_copy
= g_strdup(input
);
1685 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to copy a string.");
1689 g_ptr_array_add(paths
, input_copy
);
1692 g_ptr_array_sort(paths
, compare_strings
);
1694 /* Create a separate ctf_fs_trace object for each path. */
1695 for (i
= 0; i
< paths
->len
; i
++) {
1696 const char *path
= (const char *) g_ptr_array_index(paths
, i
);
1698 ret
= ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs
, path
, trace_name
, traces
,
1705 if (traces
.size() > 1) {
1706 ctf_fs_trace
*first_trace
= traces
[0].get();
1707 const uint8_t *first_trace_uuid
= first_trace
->metadata
->tc
->uuid
;
1710 * We have more than one trace, they must all share the same
1711 * UUID, verify that.
1713 for (i
= 0; i
< traces
.size(); i
++) {
1714 ctf_fs_trace
*this_trace
= traces
[i
].get();
1715 const uint8_t *this_trace_uuid
= this_trace
->metadata
->tc
->uuid
;
1717 if (!this_trace
->metadata
->tc
->is_uuid_set
) {
1718 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1720 "Multiple traces given, but a trace does not have a UUID: path={}",
1721 this_trace
->path
->str
);
1725 if (bt_uuid_compare(first_trace_uuid
, this_trace_uuid
) != 0) {
1726 char first_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1727 char this_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1729 bt_uuid_to_str(first_trace_uuid
, first_trace_uuid_str
);
1730 bt_uuid_to_str(this_trace_uuid
, this_trace_uuid_str
);
1732 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1733 "Multiple traces given, but UUIDs don't match: "
1734 "first-trace-uuid={}, first-trace-path={}, "
1735 "trace-uuid={}, trace-path={}",
1736 first_trace_uuid_str
, first_trace
->path
->str
,
1737 this_trace_uuid_str
, this_trace
->path
->str
);
1742 ret
= merge_ctf_fs_traces(std::move(traces
), ctf_fs
->trace
);
1744 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1745 "Failed to merge traces with the same UUID.");
1749 /* Just one trace, it may or may not have a UUID, both are fine. */
1750 ctf_fs
->trace
= std::move(traces
[0]);
1753 ret
= fix_packet_index_tracer_bugs(ctf_fs
->trace
.get());
1755 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to fix packet index tracer bugs.");
1759 * Sort data stream file groups by first data stream file info
1760 * path to get a deterministic order. This order influences the
1761 * order of the output ports. It also influences the order of
1762 * the automatic stream IDs if the trace's packet headers do not
1763 * contain a `stream_instance_id` field, in which case the data
1764 * stream file to stream ID association is always the same,
1765 * whatever the build and the system.
1767 * Having a deterministic order here can help debugging and
1770 std::sort(ctf_fs
->trace
->ds_file_groups
.begin(), ctf_fs
->trace
->ds_file_groups
.end(),
1771 compare_ds_file_groups_by_first_path
);
1778 g_ptr_array_free(paths
, TRUE
);
1784 static GString
*get_stream_instance_unique_name(struct ctf_fs_ds_file_group
*ds_file_group
)
1787 struct ctf_fs_ds_file_info
*ds_file_info
;
1789 name
= g_string_new(NULL
);
1795 * If there's more than one stream file in the stream file
1796 * group, the first (earliest) stream file's path is used as
1797 * the stream's unique name.
1799 BT_ASSERT(!ds_file_group
->ds_file_infos
.empty());
1800 ds_file_info
= ds_file_group
->ds_file_infos
[0].get();
1801 g_string_assign(name
, ds_file_info
->path
.c_str());
1807 /* Create the IR stream objects for ctf_fs_trace. */
1809 static int create_streams_for_trace(struct ctf_fs_trace
*ctf_fs_trace
)
1812 GString
*name
= NULL
;
1814 for (const auto& ds_file_group
: ctf_fs_trace
->ds_file_groups
) {
1815 name
= get_stream_instance_unique_name(ds_file_group
.get());
1821 BT_ASSERT(ds_file_group
->sc
->ir_sc
);
1822 BT_ASSERT(ctf_fs_trace
->trace
);
1826 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
1827 /* No stream ID: use 0 */
1828 stream
= bt_stream_create_with_id(ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
,
1829 ctf_fs_trace
->next_stream_id
);
1830 ctf_fs_trace
->next_stream_id
++;
1832 /* Specific stream ID */
1833 stream
= bt_stream_create_with_id(ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
,
1834 (uint64_t) ds_file_group
->stream_id
);
1838 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1839 "Cannot create stream for DS file group: "
1840 "addr={}, stream-name=\"{}\"",
1841 fmt::ptr(ds_file_group
), name
->str
);
1845 ds_file_group
->stream
= bt2::Stream::Shared::createWithoutRef(stream
);
1847 ret
= bt_stream_set_name(ds_file_group
->stream
->libObjPtr(), name
->str
);
1849 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1850 "Cannot set stream's name: "
1851 "addr={}, stream-name=\"{}\"",
1852 fmt::ptr(ds_file_group
->stream
->libObjPtr()), name
->str
);
1856 g_string_free(name
, TRUE
);
1869 g_string_free(name
, TRUE
);
1874 static const bt_param_validation_value_descr inputs_elem_descr
=
1875 bt_param_validation_value_descr::makeString();
1877 static bt_param_validation_map_value_entry_descr fs_params_entries_descr
[] = {
1878 {"inputs", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
1879 bt_param_validation_value_descr::makeArray(1, BT_PARAM_VALIDATION_INFINITE
,
1880 inputs_elem_descr
)},
1881 {"trace-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1882 bt_param_validation_value_descr::makeString()},
1883 {"clock-class-offset-s", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1884 bt_param_validation_value_descr::makeSignedInteger()},
1885 {"clock-class-offset-ns", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1886 bt_param_validation_value_descr::makeSignedInteger()},
1887 {"force-clock-class-origin-unix-epoch", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1888 bt_param_validation_value_descr::makeBool()},
1889 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
1891 bool read_src_fs_parameters(const bt_value
*params
, const bt_value
**inputs
,
1892 const bt_value
**trace_name
, struct ctf_fs_component
*ctf_fs
)
1895 const bt_value
*value
;
1896 enum bt_param_validation_status validate_value_status
;
1897 gchar
*error
= NULL
;
1899 validate_value_status
= bt_param_validation_validate(params
, fs_params_entries_descr
, &error
);
1900 if (validate_value_status
!= BT_PARAM_VALIDATION_STATUS_OK
) {
1901 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "{}", error
);
1906 /* inputs parameter */
1907 *inputs
= bt_value_map_borrow_entry_value_const(params
, "inputs");
1909 /* clock-class-offset-s parameter */
1910 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-s");
1912 ctf_fs
->clkClsCfg
.offsetSec
= bt_value_integer_signed_get(value
);
1915 /* clock-class-offset-ns parameter */
1916 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-ns");
1918 ctf_fs
->clkClsCfg
.offsetNanoSec
= bt_value_integer_signed_get(value
);
1921 /* force-clock-class-origin-unix-epoch parameter */
1922 value
= bt_value_map_borrow_entry_value_const(params
, "force-clock-class-origin-unix-epoch");
1924 ctf_fs
->clkClsCfg
.forceOriginIsUnixEpoch
= bt_value_bool_get(value
);
1927 /* trace-name parameter */
1928 *trace_name
= bt_value_map_borrow_entry_value_const(params
, "trace-name");
1937 static ctf_fs_component::UP
ctf_fs_create(const bt_value
*params
,
1938 bt_self_component_source
*self_comp_src
)
1940 const bt_value
*inputs_value
;
1941 const bt_value
*trace_name_value
;
1942 bt_self_component
*self_comp
= bt_self_component_source_as_self_component(self_comp_src
);
1944 ctf_fs_component::UP ctf_fs
= ctf_fs_component_create(
1945 bt2c::Logger
{bt2::SelfSourceComponent
{self_comp_src
}, "PLUGIN/SRC.CTF.FS/COMP"});
1950 if (!read_src_fs_parameters(params
, &inputs_value
, &trace_name_value
, ctf_fs
.get())) {
1954 if (ctf_fs_component_create_ctf_fs_trace(ctf_fs
.get(), inputs_value
, trace_name_value
,
1959 if (create_streams_for_trace(ctf_fs
->trace
.get())) {
1963 if (create_ports_for_trace(ctf_fs
.get(), ctf_fs
->trace
.get(), self_comp_src
)) {
1970 bt_component_class_initialize_method_status
ctf_fs_init(bt_self_component_source
*self_comp_src
,
1971 bt_self_component_source_configuration
*,
1972 const bt_value
*params
, void *)
1975 bt_component_class_initialize_method_status ret
=
1976 BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
1978 ctf_fs_component::UP ctf_fs
= ctf_fs_create(params
, self_comp_src
);
1980 ret
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1983 bt_self_component_set_data(bt_self_component_source_as_self_component(self_comp_src
),
1986 } catch (const std::bad_alloc
&) {
1987 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1988 } catch (const bt2::Error
&) {
1989 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1993 bt_component_class_query_method_status
ctf_fs_query(bt_self_component_class_source
*comp_class_src
,
1994 bt_private_query_executor
*priv_query_exec
,
1995 const char *object
, const bt_value
*params
,
1996 __attribute__((unused
)) void *method_data
,
1997 const bt_value
**result
)
2000 bt2c::Logger logger
{bt2::SelfComponentClass
{comp_class_src
},
2001 bt2::PrivateQueryExecutor
{priv_query_exec
},
2002 "PLUGIN/SRC.CTF.FS/QUERY"};
2003 bt2::ConstMapValue
paramsObj(params
);
2004 bt2::Value::Shared resultObj
;
2006 if (strcmp(object
, "metadata-info") == 0) {
2007 resultObj
= metadata_info_query(paramsObj
, logger
);
2008 } else if (strcmp(object
, "babeltrace.trace-infos") == 0) {
2009 resultObj
= trace_infos_query(paramsObj
, logger
);
2010 } else if (!strcmp(object
, "babeltrace.support-info")) {
2011 resultObj
= support_info_query(paramsObj
, logger
);
2013 BT_CPPLOGE_SPEC(logger
, "Unknown query object `{}`", object
);
2014 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;
2017 *result
= resultObj
.release().libObjPtr();
2019 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
2020 } catch (const std::bad_alloc
&) {
2021 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
2022 } catch (const bt2::Error
&) {
2023 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;