2 * SPDX-License-Identifier: MIT
4 * Copyright 2015-2017 Philippe Proulx <pproulx@efficios.com>
5 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 * Babeltrace CTF file system Reader Component
13 #include <babeltrace2/babeltrace.h>
15 #include "common/assert.h"
16 #include "common/common.h"
17 #include "common/uuid.h"
18 #include "cpp-common/bt2s/make-unique.hpp"
20 #include "plugins/common/param-validation/param-validation.h"
22 #include "../common/src/metadata/tsdl/ctf-meta-configure-ir-trace.hpp"
23 #include "../common/src/msg-iter/msg-iter.hpp"
24 #include "data-stream-file.hpp"
27 #include "metadata.hpp"
38 static void ctf_fs_msg_iter_data_destroy(struct ctf_fs_msg_iter_data
*msg_iter_data
)
44 if (msg_iter_data
->msg_iter
) {
45 ctf_msg_iter_destroy(msg_iter_data
->msg_iter
);
51 static bt_message_iterator_class_next_method_status
52 ctf_fs_iterator_next_one(struct ctf_fs_msg_iter_data
*msg_iter_data
, const bt_message
**out_msg
)
54 bt_message_iterator_class_next_method_status status
;
55 enum ctf_msg_iter_status msg_iter_status
;
57 msg_iter_status
= ctf_msg_iter_get_next_message(msg_iter_data
->msg_iter
, out_msg
);
59 switch (msg_iter_status
) {
60 case CTF_MSG_ITER_STATUS_OK
:
61 /* Cool, message has been written to *out_msg. */
62 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
65 case CTF_MSG_ITER_STATUS_EOF
:
66 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END
;
69 case CTF_MSG_ITER_STATUS_AGAIN
:
71 * Should not make it this far as this is
72 * medium-specific; there is nothing for the user to do
73 * and it should have been handled upstream.
77 case CTF_MSG_ITER_STATUS_ERROR
:
78 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
79 "Failed to get next message from CTF message iterator.");
80 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
83 case CTF_MSG_ITER_STATUS_MEMORY_ERROR
:
84 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
85 "Failed to get next message from CTF message iterator.");
86 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
96 bt_message_iterator_class_next_method_status
97 ctf_fs_iterator_next(bt_self_message_iterator
*iterator
, bt_message_array_const msgs
,
98 uint64_t capacity
, uint64_t *count
)
101 bt_message_iterator_class_next_method_status status
;
102 struct ctf_fs_msg_iter_data
*msg_iter_data
=
103 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(iterator
);
106 if (G_UNLIKELY(msg_iter_data
->next_saved_error
)) {
108 * Last time we were called, we hit an error but had some
109 * messages to deliver, so we stashed the error here. Return
112 BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(msg_iter_data
->next_saved_error
);
113 status
= msg_iter_data
->next_saved_status
;
118 status
= ctf_fs_iterator_next_one(msg_iter_data
, &msgs
[i
]);
119 if (status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
) {
122 } while (i
< capacity
&& status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
);
126 * Even if ctf_fs_iterator_next_one() returned something
127 * else than BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK, we
128 * accumulated message objects in the output
129 * message array, so we need to return
130 * BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK so that they are
131 * transferred to downstream. This other status occurs
132 * again the next time muxer_msg_iter_do_next() is
133 * called, possibly without any accumulated
134 * message, in which case we'll return it.
138 * Save this error for the next _next call. Assume that
139 * this component always appends error causes when
140 * returning an error status code, which will cause the
141 * current thread error to be non-NULL.
143 msg_iter_data
->next_saved_error
= bt_current_thread_take_error();
144 BT_ASSERT(msg_iter_data
->next_saved_error
);
145 msg_iter_data
->next_saved_status
= status
;
149 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
155 } catch (const std::bad_alloc
&) {
156 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
157 } catch (const bt2::Error
&) {
158 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
162 bt_message_iterator_class_seek_beginning_method_status
163 ctf_fs_iterator_seek_beginning(bt_self_message_iterator
*it
)
166 struct ctf_fs_msg_iter_data
*msg_iter_data
=
167 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(it
);
169 BT_ASSERT(msg_iter_data
);
171 ctf_msg_iter_reset(msg_iter_data
->msg_iter
);
172 ctf_fs_ds_group_medops_data_reset(msg_iter_data
->msg_iter_medops_data
.get());
174 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_OK
;
175 } catch (const std::bad_alloc
&) {
176 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_MEMORY_ERROR
;
177 } catch (const bt2::Error
&) {
178 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_ERROR
;
182 void ctf_fs_iterator_finalize(bt_self_message_iterator
*it
)
184 ctf_fs_msg_iter_data_destroy(
185 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(it
));
188 static bt_message_iterator_class_initialize_method_status
189 ctf_msg_iter_medium_status_to_msg_iter_initialize_status(enum ctf_msg_iter_medium_status status
)
192 case CTF_MSG_ITER_MEDIUM_STATUS_EOF
:
193 case CTF_MSG_ITER_MEDIUM_STATUS_AGAIN
:
194 case CTF_MSG_ITER_MEDIUM_STATUS_ERROR
:
195 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
196 case CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
:
197 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
198 case CTF_MSG_ITER_MEDIUM_STATUS_OK
:
199 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
205 bt_message_iterator_class_initialize_method_status
206 ctf_fs_iterator_init(bt_self_message_iterator
*self_msg_iter
,
207 bt_self_message_iterator_configuration
*config
,
208 bt_self_component_port_output
*self_port
)
211 struct ctf_fs_port_data
*port_data
;
212 bt_message_iterator_class_initialize_method_status status
;
213 enum ctf_msg_iter_medium_status medium_status
;
215 port_data
= (struct ctf_fs_port_data
*) bt_self_component_port_get_data(
216 bt_self_component_port_output_as_self_component_port(self_port
));
217 BT_ASSERT(port_data
);
219 ctf_fs_msg_iter_data
*msg_iter_data
= new ctf_fs_msg_iter_data
{self_msg_iter
};
220 msg_iter_data
->ds_file_group
= port_data
->ds_file_group
;
222 medium_status
= ctf_fs_ds_group_medops_data_create(msg_iter_data
->ds_file_group
,
223 self_msg_iter
, msg_iter_data
->logger
,
224 msg_iter_data
->msg_iter_medops_data
);
225 BT_ASSERT(medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_OK
||
226 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_ERROR
||
227 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
);
228 if (medium_status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
229 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
230 "Failed to create ctf_fs_ds_group_medops");
231 status
= ctf_msg_iter_medium_status_to_msg_iter_initialize_status(medium_status
);
235 msg_iter_data
->msg_iter
= ctf_msg_iter_create(
236 msg_iter_data
->ds_file_group
->ctf_fs_trace
->metadata
->tc
,
237 bt_common_get_page_size(static_cast<int>(msg_iter_data
->logger
.level())) * 8,
238 ctf_fs_ds_group_medops
, msg_iter_data
->msg_iter_medops_data
.get(), self_msg_iter
,
239 msg_iter_data
->logger
);
240 if (!msg_iter_data
->msg_iter
) {
241 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
242 "Cannot create a CTF message iterator.");
243 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
248 * This iterator can seek forward if its stream class has a default
251 if (msg_iter_data
->ds_file_group
->sc
->default_clock_class
) {
252 bt_self_message_iterator_configuration_set_can_seek_forward(config
, true);
255 bt_self_message_iterator_set_data(self_msg_iter
, msg_iter_data
);
256 msg_iter_data
= NULL
;
258 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
262 bt_self_message_iterator_set_data(self_msg_iter
, NULL
);
265 ctf_fs_msg_iter_data_destroy(msg_iter_data
);
267 } catch (const std::bad_alloc
&) {
268 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
269 } catch (const bt2::Error
&) {
270 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
274 static void ctf_fs_trace_destroy(struct ctf_fs_trace
*ctf_fs_trace
)
280 BT_TRACE_PUT_REF_AND_RESET(ctf_fs_trace
->trace
);
282 if (ctf_fs_trace
->path
) {
283 g_string_free(ctf_fs_trace
->path
, TRUE
);
286 if (ctf_fs_trace
->metadata
) {
287 ctf_fs_metadata_fini(ctf_fs_trace
->metadata
);
288 delete ctf_fs_trace
->metadata
;
294 void ctf_fs_trace_deleter::operator()(ctf_fs_trace
* const trace
) noexcept
296 ctf_fs_trace_destroy(trace
);
299 void ctf_fs_destroy(struct ctf_fs_component
*ctf_fs
)
308 void ctf_fs_component_deleter::operator()(ctf_fs_component
*comp
)
310 ctf_fs_destroy(comp
);
313 ctf_fs_component::UP
ctf_fs_component_create(const bt2c::Logger
& parentLogger
)
315 return ctf_fs_component::UP
{new ctf_fs_component
{parentLogger
}};
318 void ctf_fs_finalize(bt_self_component_source
*component
)
320 ctf_fs_destroy((struct ctf_fs_component
*) bt_self_component_get_data(
321 bt_self_component_source_as_self_component(component
)));
324 bt2c::GCharUP
ctf_fs_make_port_name(struct ctf_fs_ds_file_group
*ds_file_group
)
326 GString
*name
= g_string_new(NULL
);
329 * The unique port name is generated by concatenating unique identifiers
337 /* For the trace, use the uuid if present, else the path. */
338 if (ds_file_group
->ctf_fs_trace
->metadata
->tc
->is_uuid_set
) {
339 char uuid_str
[BT_UUID_STR_LEN
+ 1];
341 bt_uuid_to_str(ds_file_group
->ctf_fs_trace
->metadata
->tc
->uuid
, uuid_str
);
342 g_string_assign(name
, uuid_str
);
344 g_string_assign(name
, ds_file_group
->ctf_fs_trace
->path
->str
);
348 * For the stream class, use the id if present. We can omit this field
349 * otherwise, as there will only be a single stream class.
351 if (ds_file_group
->sc
->id
!= UINT64_C(-1)) {
352 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->sc
->id
);
355 /* For the stream, use the id if present, else, use the path. */
356 if (ds_file_group
->stream_id
!= UINT64_C(-1)) {
357 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->stream_id
);
359 BT_ASSERT(ds_file_group
->ds_file_infos
.size() == 1);
360 const auto& ds_file_info
= *ds_file_group
->ds_file_infos
[0];
361 g_string_append_printf(name
, " | %s", ds_file_info
.path
.c_str());
364 return bt2c::GCharUP
{g_string_free(name
, FALSE
)};
367 static int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
368 struct ctf_fs_ds_file_group
*ds_file_group
,
369 bt_self_component_source
*self_comp_src
)
372 ctf_fs_port_data::UP port_data
;
374 bt2c::GCharUP port_name
= ctf_fs_make_port_name(ds_file_group
);
379 BT_CPPLOGI_SPEC(ctf_fs
->logger
, "Creating one port named `{}`", port_name
.get());
381 /* Create output port for this file */
382 port_data
= bt2s::make_unique
<ctf_fs_port_data
>();
383 port_data
->ctf_fs
= ctf_fs
;
384 port_data
->ds_file_group
= ds_file_group
;
385 ret
= bt_self_component_source_add_output_port(self_comp_src
, port_name
.get(), port_data
.get(),
391 ctf_fs
->port_data
.emplace_back(std::move(port_data
));
401 static int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
402 struct ctf_fs_trace
*ctf_fs_trace
,
403 bt_self_component_source
*self_comp_src
)
407 /* Create one output port for each stream file group */
408 for (const auto& ds_file_group
: ctf_fs_trace
->ds_file_groups
) {
409 ret
= create_one_port_for_trace(ctf_fs
, ds_file_group
.get(), self_comp_src
);
411 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create output port.");
421 * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right
422 * place to keep it sorted.
425 static void ds_file_group_insert_ds_file_info_sorted(struct ctf_fs_ds_file_group
*ds_file_group
,
426 ctf_fs_ds_file_info::UP ds_file_info
)
428 /* Find the spot where to insert this ds_file_info. */
429 auto it
= ds_file_group
->ds_file_infos
.begin();
431 for (; it
!= ds_file_group
->ds_file_infos
.end(); ++it
) {
432 const ctf_fs_ds_file_info
& other_ds_file_info
= **it
;
434 if (ds_file_info
->begin_ns
< other_ds_file_info
.begin_ns
) {
439 ds_file_group
->ds_file_infos
.insert(it
, std::move(ds_file_info
));
442 static bool ds_index_entries_equal(const struct ctf_fs_ds_index_entry
*left
,
443 const struct ctf_fs_ds_index_entry
*right
)
445 if (left
->packetSize
!= right
->packetSize
) {
449 if (left
->timestamp_begin
!= right
->timestamp_begin
) {
453 if (left
->timestamp_end
!= right
->timestamp_end
) {
457 if (left
->packet_seq_num
!= right
->packet_seq_num
) {
465 * Insert `entry` into `index`, without duplication.
467 * The entry is inserted only if there isn't an identical entry already.
469 * In any case, the ownership of `entry` is transferred to this function. So if
470 * the entry is not inserted, it is freed.
473 static void ds_index_insert_ds_index_entry_sorted(struct ctf_fs_ds_index
*index
,
474 ctf_fs_ds_index_entry::UP entry
)
476 /* Find the spot where to insert this index entry. */
477 auto otherEntry
= index
->entries
.begin();
478 for (; otherEntry
!= index
->entries
.end(); ++otherEntry
) {
479 if (entry
->timestamp_begin_ns
<= (*otherEntry
)->timestamp_begin_ns
) {
485 * Insert the entry only if a duplicate doesn't already exist.
487 * There can be duplicate packets if reading multiple overlapping
488 * snapshots of the same trace. We then want the index to contain
489 * a reference to only one copy of that packet.
491 if (otherEntry
== index
->entries
.end() ||
492 !ds_index_entries_equal(entry
.get(), otherEntry
->get())) {
493 index
->entries
.insert(otherEntry
, std::move(entry
));
497 static void merge_ctf_fs_ds_indexes(struct ctf_fs_ds_index
*dest
, ctf_fs_ds_index::UP src
)
499 for (auto& entry
: src
->entries
) {
500 ds_index_insert_ds_index_entry_sorted(dest
, std::move(entry
));
504 static int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
, const char *path
)
506 int64_t stream_instance_id
= -1;
507 int64_t begin_ns
= -1;
508 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
509 ctf_fs_ds_file_group::UP new_ds_file_group
;
511 ctf_fs_ds_file_info::UP ds_file_info
;
512 ctf_fs_ds_index::UP index
;
513 struct ctf_msg_iter
*msg_iter
= NULL
;
514 struct ctf_stream_class
*sc
= NULL
;
515 struct ctf_msg_iter_packet_properties props
;
518 * Create a temporary ds_file to read some properties about the data
522 ctf_fs_ds_file_create(ctf_fs_trace
, bt2::Stream::Shared
{}, path
, ctf_fs_trace
->logger
);
527 /* Create a temporary iterator to read the ds_file. */
528 msg_iter
= ctf_msg_iter_create(
529 ctf_fs_trace
->metadata
->tc
,
530 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
531 ctf_fs_ds_file_medops
, ds_file
.get(), nullptr, ctf_fs_trace
->logger
);
533 BT_CPPLOGE_STR_SPEC(ctf_fs_trace
->logger
, "Cannot create a CTF message iterator.");
537 ctf_msg_iter_set_dry_run(msg_iter
, true);
539 ret
= ctf_msg_iter_get_packet_properties(msg_iter
, &props
);
541 BT_CPPLOGE_APPEND_CAUSE_SPEC(
542 ctf_fs_trace
->logger
,
543 "Cannot get stream file's first packet's header and context fields (`{}`).", path
);
547 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
, props
.stream_class_id
);
549 stream_instance_id
= props
.data_stream_id
;
551 if (props
.snapshots
.beginning_clock
!= UINT64_C(-1)) {
552 BT_ASSERT(sc
->default_clock_class
);
553 ret
= bt_util_clock_cycles_to_ns_from_origin(
554 props
.snapshots
.beginning_clock
, sc
->default_clock_class
->frequency
,
555 sc
->default_clock_class
->offset_seconds
, sc
->default_clock_class
->offset_cycles
,
558 BT_CPPLOGE_APPEND_CAUSE_SPEC(
559 ctf_fs_trace
->logger
,
560 "Cannot convert clock cycles to nanoseconds from origin (`{}`).", path
);
565 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
);
570 index
= ctf_fs_ds_file_build_index(ds_file
.get(), ds_file_info
.get(), msg_iter
);
572 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to index CTF stream file \'{}\'",
573 ds_file
->file
->path
);
577 if (begin_ns
== -1) {
579 * No beginning timestamp to sort the stream files
580 * within a stream file group, so consider that this
581 * file must be the only one within its group.
583 stream_instance_id
= -1;
586 if (stream_instance_id
== -1) {
588 * No stream instance ID or no beginning timestamp:
589 * create a unique stream file group for this stream
590 * file because, even if there's a stream instance ID,
591 * there's no timestamp to order the file within its
595 ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, UINT64_C(-1), std::move(index
));
597 if (!new_ds_file_group
) {
601 ds_file_group_insert_ds_file_info_sorted(new_ds_file_group
.get(), std::move(ds_file_info
));
602 ctf_fs_trace
->ds_file_groups
.emplace_back(std::move(new_ds_file_group
));
606 BT_ASSERT(stream_instance_id
!= -1);
607 BT_ASSERT(begin_ns
!= -1);
609 /* Find an existing stream file group with this ID */
610 for (const auto& candidate
: ctf_fs_trace
->ds_file_groups
) {
611 if (candidate
->sc
== sc
&& candidate
->stream_id
== stream_instance_id
) {
612 ds_file_group
= candidate
.get();
617 if (!ds_file_group
) {
619 ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, stream_instance_id
, std::move(index
));
620 if (!new_ds_file_group
) {
624 ds_file_group
= new_ds_file_group
.get();
625 ctf_fs_trace
->ds_file_groups
.emplace_back(std::move(new_ds_file_group
));
627 merge_ctf_fs_ds_indexes(ds_file_group
->index
.get(), std::move(index
));
630 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, std::move(ds_file_info
));
639 ctf_msg_iter_destroy(msg_iter
);
645 static int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
648 const char *basename
;
649 GError
*error
= NULL
;
652 /* Check each file in the path directory, except specific ones */
653 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
655 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
656 "Cannot open directory `{}`: {} (code {})",
657 ctf_fs_trace
->path
->str
, error
->message
, error
->code
);
661 while ((basename
= g_dir_read_name(dir
))) {
662 if (strcmp(basename
, CTF_FS_METADATA_FILENAME
) == 0) {
663 /* Ignore the metadata stream. */
664 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
665 "Ignoring metadata file `{}" G_DIR_SEPARATOR_S
"{}`",
666 ctf_fs_trace
->path
->str
, basename
);
670 if (basename
[0] == '.') {
671 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
672 "Ignoring hidden file `{}" G_DIR_SEPARATOR_S
"{}`",
673 ctf_fs_trace
->path
->str
, basename
);
677 /* Create the file. */
678 const auto file
= ctf_fs_file_create(ctf_fs_trace
->logger
);
680 BT_CPPLOGE_APPEND_CAUSE_SPEC(
681 ctf_fs_trace
->logger
,
682 "Cannot create stream file object for file `{}" G_DIR_SEPARATOR_S
"{}`",
683 ctf_fs_trace
->path
->str
, basename
);
687 /* Create full path string. */
688 file
->path
= fmt::format("{}" G_DIR_SEPARATOR_S
"{}", ctf_fs_trace
->path
->str
, basename
);
690 if (!g_file_test(file
->path
.c_str(), G_FILE_TEST_IS_REGULAR
)) {
691 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring non-regular file `{}`", file
->path
);
695 ret
= ctf_fs_file_open(file
.get(), "rb");
697 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Cannot open stream file `{}`",
702 if (file
->size
== 0) {
703 /* Skip empty stream. */
704 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring empty file `{}`", file
->path
);
708 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
, file
->path
.c_str());
710 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
711 "Cannot add stream file `{}` to stream file group",
735 static int set_trace_name(bt_trace
*trace
, const char *name_suffix
, const bt2c::Logger
& logger
)
741 name
= g_string_new(NULL
);
743 BT_CPPLOGE_STR_SPEC(logger
, "Failed to allocate a GString.");
749 * Check if we have a trace environment string value named `hostname`.
750 * If so, use it as the trace name's prefix.
752 val
= bt_trace_borrow_environment_entry_value_by_name_const(trace
, "hostname");
753 if (val
&& bt_value_is_string(val
)) {
754 g_string_append(name
, bt_value_string_get(val
));
757 g_string_append_c(name
, G_DIR_SEPARATOR
);
762 g_string_append(name
, name_suffix
);
765 ret
= bt_trace_set_name(trace
, name
->str
);
774 g_string_free(name
, TRUE
);
780 static ctf_fs_trace::UP
ctf_fs_trace_create(const char *path
, const char *name
,
781 const ctf::src::ClkClsCfg
& clkClsCfg
,
782 bt_self_component
*selfComp
,
783 const bt2c::Logger
& parentLogger
)
787 ctf_fs_trace::UP ctf_fs_trace
{new struct ctf_fs_trace(parentLogger
)};
788 ctf_fs_trace
->path
= g_string_new(path
);
789 if (!ctf_fs_trace
->path
) {
793 ctf_fs_trace
->metadata
= new ctf_fs_metadata
;
794 ctf_fs_metadata_init(ctf_fs_trace
->metadata
);
796 ret
= ctf_fs_metadata_set_trace_class(selfComp
, ctf_fs_trace
.get(), clkClsCfg
);
801 if (ctf_fs_trace
->metadata
->trace_class
) {
802 ctf_fs_trace
->trace
= bt_trace_create(ctf_fs_trace
->metadata
->trace_class
);
803 if (!ctf_fs_trace
->trace
) {
808 if (ctf_fs_trace
->trace
) {
809 ret
= ctf_trace_class_configure_ir_trace(ctf_fs_trace
->metadata
->tc
, ctf_fs_trace
->trace
);
814 ret
= set_trace_name(ctf_fs_trace
->trace
, name
, ctf_fs_trace
->logger
);
820 ret
= create_ds_file_groups(ctf_fs_trace
.get());
828 ctf_fs_trace
.reset();
834 static int path_is_ctf_trace(const char *path
)
836 GString
*metadata_path
= g_string_new(NULL
);
839 if (!metadata_path
) {
844 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
846 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
852 g_string_free(metadata_path
, TRUE
);
856 /* Helper for ctf_fs_component_create_ctf_fs_trace, to handle a single path. */
858 static int ctf_fs_component_create_ctf_fs_trace_one_path(struct ctf_fs_component
*ctf_fs
,
859 const char *path_param
,
860 const char *trace_name
,
861 std::vector
<ctf_fs_trace::UP
>& traces
,
862 bt_self_component
*selfComp
)
864 ctf_fs_trace::UP ctf_fs_trace
;
868 norm_path
= bt_common_normalize_path(path_param
, NULL
);
870 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to normalize path: `{}`.", path_param
);
874 ret
= path_is_ctf_trace(norm_path
->str
);
876 BT_CPPLOGE_APPEND_CAUSE_SPEC(
877 ctf_fs
->logger
, "Failed to check if path is a CTF trace: path={}", norm_path
->str
);
879 } else if (ret
== 0) {
880 BT_CPPLOGE_APPEND_CAUSE_SPEC(
881 ctf_fs
->logger
, "Path is not a CTF trace (does not contain a metadata file): `{}`.",
886 // FIXME: Remove or ifdef for __MINGW32__
887 if (strcmp(norm_path
->str
, "/") == 0) {
888 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Opening a trace in `/` is not supported.");
893 ctf_fs_trace
= ctf_fs_trace_create(norm_path
->str
, trace_name
, ctf_fs
->clkClsCfg
, selfComp
,
896 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create trace for `{}`.",
901 traces
.emplace_back(std::move(ctf_fs_trace
));
911 g_string_free(norm_path
, TRUE
);
918 * Count the number of stream and event classes defined by this trace's metadata.
920 * This is used to determine which metadata is the "latest", out of multiple
921 * traces sharing the same UUID. It is assumed that amongst all these metadatas,
922 * a bigger metadata is a superset of a smaller metadata. Therefore, it is
923 * enough to just count the classes.
926 static unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace
*trace
)
928 unsigned int num
= trace
->metadata
->tc
->stream_classes
->len
;
931 for (i
= 0; i
< trace
->metadata
->tc
->stream_classes
->len
; i
++) {
932 struct ctf_stream_class
*sc
=
933 (struct ctf_stream_class
*) trace
->metadata
->tc
->stream_classes
->pdata
[i
];
934 num
+= sc
->event_classes
->len
;
941 * Merge the src ds_file_group into dest. This consists of merging their
942 * ds_file_infos, making sure to keep the result sorted.
945 static void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group
*dest
,
946 ctf_fs_ds_file_group::UP src
)
948 for (auto& ds_file_info
: src
->ds_file_infos
) {
949 ds_file_group_insert_ds_file_info_sorted(dest
, std::move(ds_file_info
));
952 /* Merge both indexes. */
953 merge_ctf_fs_ds_indexes(dest
->index
.get(), std::move(src
->index
));
956 /* Merge src_trace's data stream file groups into dest_trace's. */
958 static int merge_matching_ctf_fs_ds_file_groups(struct ctf_fs_trace
*dest_trace
,
959 ctf_fs_trace::UP src_trace
)
961 std::vector
<ctf_fs_ds_file_group::UP
>& dest
= dest_trace
->ds_file_groups
;
962 std::vector
<ctf_fs_ds_file_group::UP
>& src
= src_trace
->ds_file_groups
;
966 * Save the initial length of dest: we only want to check against the
967 * original elements in the inner loop.
969 size_t dest_len
= dest
.size();
971 for (auto& src_group
: src
) {
972 struct ctf_fs_ds_file_group
*dest_group
= NULL
;
974 /* A stream instance without ID can't match a stream in the other trace. */
975 if (src_group
->stream_id
!= -1) {
976 /* Let's search for a matching ds_file_group in the destination. */
977 for (size_t d_i
= 0; d_i
< dest_len
; ++d_i
) {
978 ctf_fs_ds_file_group
*candidate_dest
= dest
[d_i
].get();
980 /* Can't match a stream instance without ID. */
981 if (candidate_dest
->stream_id
== -1) {
986 * If the two groups have the same stream instance id
987 * and belong to the same stream class (stream instance
988 * ids are per-stream class), they represent the same
991 if (candidate_dest
->stream_id
!= src_group
->stream_id
||
992 candidate_dest
->sc
->id
!= src_group
->sc
->id
) {
996 dest_group
= candidate_dest
;
1002 * Didn't find a friend in dest to merge our src_group into?
1003 * Create a new empty one. This can happen if a stream was
1004 * active in the source trace chunk but not in the destination
1008 struct ctf_stream_class
*sc
;
1010 sc
= ctf_trace_class_borrow_stream_class_by_id(dest_trace
->metadata
->tc
,
1014 auto index
= ctf_fs_ds_index_create();
1020 auto new_dest_group
=
1021 ctf_fs_ds_file_group_create(dest_trace
, sc
, src_group
->stream_id
, std::move(index
));
1023 if (!new_dest_group
) {
1028 dest_group
= new_dest_group
.get();
1029 dest_trace
->ds_file_groups
.emplace_back(std::move(new_dest_group
));
1032 BT_ASSERT(dest_group
);
1033 merge_ctf_fs_ds_file_groups(dest_group
, std::move(src_group
));
1041 * Collapse the given traces, which must all share the same UUID, in a single
1044 * The trace with the most expansive metadata is chosen and all other traces
1045 * are merged into that one. On return, the elements of `traces` are nullptr
1046 * and the merged trace is placed in `out_trace`.
1049 static int merge_ctf_fs_traces(std::vector
<ctf_fs_trace::UP
> traces
, ctf_fs_trace::UP
& out_trace
)
1051 unsigned int winner_count
;
1052 struct ctf_fs_trace
*winner
;
1056 BT_ASSERT(traces
.size() >= 2);
1058 winner_count
= metadata_count_stream_and_event_classes(traces
[0].get());
1059 winner
= traces
[0].get();
1062 /* Find the trace with the largest metadata. */
1063 for (i
= 1; i
< traces
.size(); i
++) {
1064 ctf_fs_trace
*candidate
= traces
[i
].get();
1065 unsigned int candidate_count
;
1067 /* A bit of sanity check. */
1068 BT_ASSERT(bt_uuid_compare(winner
->metadata
->tc
->uuid
, candidate
->metadata
->tc
->uuid
) == 0);
1070 candidate_count
= metadata_count_stream_and_event_classes(candidate
);
1072 if (candidate_count
> winner_count
) {
1073 winner_count
= candidate_count
;
1079 /* Merge all the other traces in the winning trace. */
1080 for (ctf_fs_trace::UP
& trace
: traces
) {
1081 /* Don't merge the winner into itself. */
1082 if (trace
.get() == winner
) {
1086 /* Merge trace's data stream file groups into winner's. */
1087 ret
= merge_matching_ctf_fs_ds_file_groups(winner
, std::move(trace
));
1094 * Move the winner out of the array, into `*out_trace`.
1096 out_trace
= std::move(traces
[winner_i
]);
1108 static int decode_clock_snapshot_after_event(struct ctf_fs_trace
*ctf_fs_trace
,
1109 struct ctf_clock_class
*default_cc
,
1110 struct ctf_fs_ds_index_entry
*index_entry
,
1111 enum target_event target_event
, uint64_t *cs
,
1114 enum ctf_msg_iter_status iter_status
= CTF_MSG_ITER_STATUS_OK
;
1115 struct ctf_msg_iter
*msg_iter
= NULL
;
1118 BT_ASSERT(ctf_fs_trace
);
1119 BT_ASSERT(index_entry
);
1120 BT_ASSERT(index_entry
->path
);
1122 const auto ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, bt2::Stream::Shared
{},
1123 index_entry
->path
, ctf_fs_trace
->logger
);
1125 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to create a ctf_fs_ds_file");
1130 BT_ASSERT(ctf_fs_trace
->metadata
);
1131 BT_ASSERT(ctf_fs_trace
->metadata
->tc
);
1133 msg_iter
= ctf_msg_iter_create(
1134 ctf_fs_trace
->metadata
->tc
,
1135 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
1136 ctf_fs_ds_file_medops
, ds_file
.get(), NULL
, ctf_fs_trace
->logger
);
1138 /* ctf_msg_iter_create() logs errors. */
1144 * Turn on dry run mode to prevent the creation and usage of Babeltrace
1145 * library objects (bt_field, bt_message_*, etc.).
1147 ctf_msg_iter_set_dry_run(msg_iter
, true);
1149 /* Seek to the beginning of the target packet. */
1150 iter_status
= ctf_msg_iter_seek(msg_iter
, index_entry
->offset
.bytes());
1152 /* ctf_msg_iter_seek() logs errors. */
1157 switch (target_event
) {
1160 * Start to decode the packet until we reach the end of
1161 * the first event. To extract the first event's clock
1164 iter_status
= ctf_msg_iter_curr_packet_first_event_clock_snapshot(msg_iter
, cs
);
1167 /* Decode the packet to extract the last event's clock snapshot. */
1168 iter_status
= ctf_msg_iter_curr_packet_last_event_clock_snapshot(msg_iter
, cs
);
1178 /* Convert clock snapshot to timestamp. */
1179 ret
= bt_util_clock_cycles_to_ns_from_origin(
1180 *cs
, default_cc
->frequency
, default_cc
->offset_seconds
, default_cc
->offset_cycles
, ts_ns
);
1182 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1183 "Failed to convert clock snapshot to timestamp");
1189 ctf_msg_iter_destroy(msg_iter
);
1195 static int decode_packet_first_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1196 struct ctf_clock_class
*default_cc
,
1197 struct ctf_fs_ds_index_entry
*index_entry
,
1198 uint64_t *cs
, int64_t *ts_ns
)
1200 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, FIRST_EVENT
, cs
,
1204 static int decode_packet_last_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1205 struct ctf_clock_class
*default_cc
,
1206 struct ctf_fs_ds_index_entry
*index_entry
,
1207 uint64_t *cs
, int64_t *ts_ns
)
1209 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, LAST_EVENT
, cs
,
1214 * Fix up packet index entries for lttng's "event-after-packet" bug.
1215 * Some buggy lttng tracer versions may emit events with a timestamp that is
1216 * larger (after) than the timestamp_end of the their packets.
1218 * To fix up this erroneous data we do the following:
1219 * 1. If it's not the stream file's last packet: set the packet index entry's
1220 * end time to the next packet's beginning time.
1221 * 2. If it's the stream file's last packet, set the packet index entry's end
1222 * time to the packet's last event's time, if any, or to the packet's
1223 * beginning time otherwise.
1225 * Known buggy tracer versions:
1226 * - before lttng-ust 2.11.0
1227 * - before lttng-module 2.11.0
1228 * - before lttng-module 2.10.10
1229 * - before lttng-module 2.9.13
1231 static int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace
*trace
)
1235 for (const auto& ds_file_group
: trace
->ds_file_groups
) {
1236 struct ctf_clock_class
*default_cc
;
1238 BT_ASSERT(ds_file_group
);
1239 const auto index
= ds_file_group
->index
.get();
1242 BT_ASSERT(!index
->entries
.empty());
1245 * Iterate over all entries but the last one. The last one is
1246 * fixed differently after.
1248 for (size_t entry_i
= 0; entry_i
< index
->entries
.size() - 1; ++entry_i
) {
1249 ctf_fs_ds_index_entry
*curr_entry
= index
->entries
[entry_i
].get();
1250 ctf_fs_ds_index_entry
*next_entry
= index
->entries
[entry_i
+ 1].get();
1253 * 1. Set the current index entry `end` timestamp to
1254 * the next index entry `begin` timestamp.
1256 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1257 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1261 * 2. Fix the last entry by decoding the last event of the last
1264 const auto last_entry
= index
->entries
.back().get();
1265 BT_ASSERT(last_entry
);
1267 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1268 default_cc
= ds_file_group
->sc
->default_clock_class
;
1271 * Decode packet to read the timestamp of the last event of the
1274 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1275 &last_entry
->timestamp_end
,
1276 &last_entry
->timestamp_end_ns
);
1278 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1280 "Failed to decode stream's last packet to get its last event's clock snapshot.");
1290 * Fix up packet index entries for barectf's "event-before-packet" bug.
1291 * Some buggy barectf tracer versions may emit events with a timestamp that is
1292 * less than the timestamp_begin of the their packets.
1294 * To fix up this erroneous data we do the following:
1295 * 1. Starting at the second index entry, set the timestamp_begin of the
1296 * current entry to the timestamp of the first event of the packet.
1297 * 2. Set the previous entry's timestamp_end to the timestamp_begin of the
1300 * Known buggy tracer versions:
1301 * - before barectf 2.3.1
1303 static int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace
*trace
)
1307 for (const auto& ds_file_group
: trace
->ds_file_groups
) {
1308 struct ctf_clock_class
*default_cc
;
1309 const auto index
= ds_file_group
->index
.get();
1312 BT_ASSERT(!index
->entries
.empty());
1314 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1315 default_cc
= ds_file_group
->sc
->default_clock_class
;
1318 * 1. Iterate over the index, starting from the second entry
1321 for (size_t entry_i
= 1; entry_i
< index
->entries
.size(); ++entry_i
) {
1322 ctf_fs_ds_index_entry
*prev_entry
= index
->entries
[entry_i
- 1].get();
1323 ctf_fs_ds_index_entry
*curr_entry
= index
->entries
[entry_i
].get();
1325 * 2. Set the current entry `begin` timestamp to the
1326 * timestamp of the first event of the current packet.
1328 ret
= decode_packet_first_event_timestamp(trace
, default_cc
, curr_entry
,
1329 &curr_entry
->timestamp_begin
,
1330 &curr_entry
->timestamp_begin_ns
);
1332 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1333 "Failed to decode first event's clock snapshot");
1338 * 3. Set the previous entry `end` timestamp to the
1339 * timestamp of the first event of the current packet.
1341 prev_entry
->timestamp_end
= curr_entry
->timestamp_begin
;
1342 prev_entry
->timestamp_end_ns
= curr_entry
->timestamp_begin_ns
;
1350 * When using the lttng-crash feature it's likely that the last packets of each
1351 * stream have their timestamp_end set to zero. This is caused by the fact that
1352 * the tracer crashed and was not able to properly close the packets.
1354 * To fix up this erroneous data we do the following:
1355 * For each index entry, if the entry's timestamp_end is 0 and the
1356 * timestamp_begin is not 0:
1357 * - If it's the stream file's last packet: set the packet index entry's end
1358 * time to the packet's last event's time, if any, or to the packet's
1359 * beginning time otherwise.
1360 * - If it's not the stream file's last packet: set the packet index
1361 * entry's end time to the next packet's beginning time.
1363 * Affected versions:
1364 * - All current and future lttng-ust and lttng-modules versions.
1366 static int fix_index_lttng_crash_quirk(struct ctf_fs_trace
*trace
)
1370 for (const auto& ds_file_group
: trace
->ds_file_groups
) {
1371 struct ctf_clock_class
*default_cc
;
1373 BT_ASSERT(ds_file_group
);
1374 const auto index
= ds_file_group
->index
.get();
1376 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1377 default_cc
= ds_file_group
->sc
->default_clock_class
;
1380 BT_ASSERT(!index
->entries
.empty());
1382 const auto last_entry
= index
->entries
.back().get();
1383 BT_ASSERT(last_entry
);
1385 /* 1. Fix the last entry first. */
1386 if (last_entry
->timestamp_end
== 0 && last_entry
->timestamp_begin
!= 0) {
1388 * Decode packet to read the timestamp of the
1389 * last event of the stream file.
1391 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1392 &last_entry
->timestamp_end
,
1393 &last_entry
->timestamp_end_ns
);
1395 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1396 "Failed to decode last event's clock snapshot");
1401 /* Iterate over all entries but the last one. */
1402 for (size_t entry_idx
= 0; entry_idx
< index
->entries
.size() - 1; ++entry_idx
) {
1403 ctf_fs_ds_index_entry
*curr_entry
= index
->entries
[entry_idx
].get();
1404 ctf_fs_ds_index_entry
*next_entry
= index
->entries
[entry_idx
+ 1].get();
1406 if (curr_entry
->timestamp_end
== 0 && curr_entry
->timestamp_begin
!= 0) {
1408 * 2. Set the current index entry `end` timestamp to
1409 * the next index entry `begin` timestamp.
1411 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1412 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1422 * Extract the tracer information necessary to compare versions.
1423 * Returns 0 on success, and -1 if the extraction is not successful because the
1424 * necessary fields are absents in the trace metadata.
1426 static int extract_tracer_info(struct ctf_fs_trace
*trace
, struct tracer_info
*current_tracer_info
)
1429 struct ctf_trace_class_env_entry
*entry
;
1431 /* Clear the current_tracer_info struct */
1432 memset(current_tracer_info
, 0, sizeof(*current_tracer_info
));
1435 * To compare 2 tracer versions, at least the tracer name and it's
1436 * major version are needed. If one of these is missing, consider it an
1437 * extraction failure.
1439 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_name");
1440 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR
) {
1441 goto missing_bare_minimum
;
1444 /* Set tracer name. */
1445 current_tracer_info
->name
= entry
->value
.str
->str
;
1447 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_major");
1448 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1449 goto missing_bare_minimum
;
1452 /* Set major version number. */
1453 current_tracer_info
->major
= entry
->value
.i
;
1455 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_minor");
1456 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1460 /* Set minor version number. */
1461 current_tracer_info
->minor
= entry
->value
.i
;
1463 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patch");
1466 * If `tracer_patch` doesn't exist `tracer_patchlevel` might.
1467 * For example, `lttng-modules` uses entry name
1468 * `tracer_patchlevel`.
1470 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patchlevel");
1473 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1477 /* Set patch version number. */
1478 current_tracer_info
->patch
= entry
->value
.i
;
1482 missing_bare_minimum
:
1488 static bool is_tracer_affected_by_lttng_event_after_packet_bug(struct tracer_info
*curr_tracer_info
)
1490 bool is_affected
= false;
1492 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1493 if (curr_tracer_info
->major
< 2) {
1495 } else if (curr_tracer_info
->major
== 2) {
1496 /* fixed in lttng-ust 2.11.0 */
1497 if (curr_tracer_info
->minor
< 11) {
1501 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1502 if (curr_tracer_info
->major
< 2) {
1504 } else if (curr_tracer_info
->major
== 2) {
1505 /* fixed in lttng-modules 2.11.0 */
1506 if (curr_tracer_info
->minor
== 10) {
1507 /* fixed in lttng-modules 2.10.10 */
1508 if (curr_tracer_info
->patch
< 10) {
1511 } else if (curr_tracer_info
->minor
== 9) {
1512 /* fixed in lttng-modules 2.9.13 */
1513 if (curr_tracer_info
->patch
< 13) {
1516 } else if (curr_tracer_info
->minor
< 9) {
1526 is_tracer_affected_by_barectf_event_before_packet_bug(struct tracer_info
*curr_tracer_info
)
1528 bool is_affected
= false;
1530 if (strcmp(curr_tracer_info
->name
, "barectf") == 0) {
1531 if (curr_tracer_info
->major
< 2) {
1533 } else if (curr_tracer_info
->major
== 2) {
1534 if (curr_tracer_info
->minor
< 3) {
1536 } else if (curr_tracer_info
->minor
== 3) {
1537 /* fixed in barectf 2.3.1 */
1538 if (curr_tracer_info
->patch
< 1) {
1548 static bool is_tracer_affected_by_lttng_crash_quirk(struct tracer_info
*curr_tracer_info
)
1550 bool is_affected
= false;
1552 /* All LTTng tracer may be affected by this lttng crash quirk. */
1553 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1555 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1563 * Looks for trace produced by known buggy tracers and fix up the index
1566 static int fix_packet_index_tracer_bugs(ctf_fs_trace
*trace
)
1569 struct tracer_info current_tracer_info
;
1571 ret
= extract_tracer_info(trace
, ¤t_tracer_info
);
1574 * A trace may not have all the necessary environment
1575 * entries to do the tracer version comparison.
1576 * At least, the tracer name and major version number
1577 * are needed. Failing to extract these entries is not
1581 BT_CPPLOGI_STR_SPEC(
1583 "Cannot extract tracer information necessary to compare with buggy versions.");
1587 /* Check if the trace may be affected by old tracer bugs. */
1588 if (is_tracer_affected_by_lttng_event_after_packet_bug(¤t_tracer_info
)) {
1589 BT_CPPLOGI_STR_SPEC(
1591 "Trace may be affected by LTTng tracer packet timestamp bug. Fixing up.");
1592 ret
= fix_index_lttng_event_after_packet_bug(trace
);
1594 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1595 "Failed to fix LTTng event-after-packet bug.");
1598 trace
->metadata
->tc
->quirks
.lttng_event_after_packet
= true;
1601 if (is_tracer_affected_by_barectf_event_before_packet_bug(¤t_tracer_info
)) {
1602 BT_CPPLOGI_STR_SPEC(
1604 "Trace may be affected by barectf tracer packet timestamp bug. Fixing up.");
1605 ret
= fix_index_barectf_event_before_packet_bug(trace
);
1607 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1608 "Failed to fix barectf event-before-packet bug.");
1611 trace
->metadata
->tc
->quirks
.barectf_event_before_packet
= true;
1614 if (is_tracer_affected_by_lttng_crash_quirk(¤t_tracer_info
)) {
1615 ret
= fix_index_lttng_crash_quirk(trace
);
1617 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1618 "Failed to fix lttng-crash timestamp quirks.");
1621 trace
->metadata
->tc
->quirks
.lttng_crash
= true;
1628 static bool compare_ds_file_groups_by_first_path(const ctf_fs_ds_file_group::UP
& ds_file_group_a
,
1629 const ctf_fs_ds_file_group::UP
& ds_file_group_b
)
1631 BT_ASSERT(!ds_file_group_a
->ds_file_infos
.empty());
1632 BT_ASSERT(!ds_file_group_b
->ds_file_infos
.empty());
1634 const auto& first_ds_file_info_a
= *ds_file_group_a
->ds_file_infos
[0];
1635 const auto& first_ds_file_info_b
= *ds_file_group_b
->ds_file_infos
[0];
1637 return first_ds_file_info_a
.path
< first_ds_file_info_b
.path
;
1640 static gint
compare_strings(gconstpointer p_a
, gconstpointer p_b
)
1642 const char *a
= *((const char **) p_a
);
1643 const char *b
= *((const char **) p_b
);
1645 return strcmp(a
, b
);
1648 int ctf_fs_component_create_ctf_fs_trace(struct ctf_fs_component
*ctf_fs
,
1649 const bt_value
*paths_value
,
1650 const bt_value
*trace_name_value
,
1651 bt_self_component
*selfComp
)
1655 GPtrArray
*paths
= NULL
;
1656 std::vector
<ctf_fs_trace::UP
> traces
;
1657 const char *trace_name
;
1659 BT_ASSERT(bt_value_get_type(paths_value
) == BT_VALUE_TYPE_ARRAY
);
1660 BT_ASSERT(!bt_value_array_is_empty(paths_value
));
1662 paths
= g_ptr_array_new_with_free_func(g_free
);
1664 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to allocate a GPtrArray.");
1668 trace_name
= trace_name_value
? bt_value_string_get(trace_name_value
) : NULL
;
1671 * Create a sorted array of the paths, to make the execution of this
1672 * component deterministic.
1674 for (i
= 0; i
< bt_value_array_get_length(paths_value
); i
++) {
1675 const bt_value
*path_value
= bt_value_array_borrow_element_by_index_const(paths_value
, i
);
1676 const char *input
= bt_value_string_get(path_value
);
1679 input_copy
= g_strdup(input
);
1681 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to copy a string.");
1685 g_ptr_array_add(paths
, input_copy
);
1688 g_ptr_array_sort(paths
, compare_strings
);
1690 /* Create a separate ctf_fs_trace object for each path. */
1691 for (i
= 0; i
< paths
->len
; i
++) {
1692 const char *path
= (const char *) g_ptr_array_index(paths
, i
);
1694 ret
= ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs
, path
, trace_name
, traces
,
1701 if (traces
.size() > 1) {
1702 ctf_fs_trace
*first_trace
= traces
[0].get();
1703 const uint8_t *first_trace_uuid
= first_trace
->metadata
->tc
->uuid
;
1706 * We have more than one trace, they must all share the same
1707 * UUID, verify that.
1709 for (i
= 0; i
< traces
.size(); i
++) {
1710 ctf_fs_trace
*this_trace
= traces
[i
].get();
1711 const uint8_t *this_trace_uuid
= this_trace
->metadata
->tc
->uuid
;
1713 if (!this_trace
->metadata
->tc
->is_uuid_set
) {
1714 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1716 "Multiple traces given, but a trace does not have a UUID: path={}",
1717 this_trace
->path
->str
);
1721 if (bt_uuid_compare(first_trace_uuid
, this_trace_uuid
) != 0) {
1722 char first_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1723 char this_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1725 bt_uuid_to_str(first_trace_uuid
, first_trace_uuid_str
);
1726 bt_uuid_to_str(this_trace_uuid
, this_trace_uuid_str
);
1728 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1729 "Multiple traces given, but UUIDs don't match: "
1730 "first-trace-uuid={}, first-trace-path={}, "
1731 "trace-uuid={}, trace-path={}",
1732 first_trace_uuid_str
, first_trace
->path
->str
,
1733 this_trace_uuid_str
, this_trace
->path
->str
);
1738 ret
= merge_ctf_fs_traces(std::move(traces
), ctf_fs
->trace
);
1740 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1741 "Failed to merge traces with the same UUID.");
1745 /* Just one trace, it may or may not have a UUID, both are fine. */
1746 ctf_fs
->trace
= std::move(traces
[0]);
1749 ret
= fix_packet_index_tracer_bugs(ctf_fs
->trace
.get());
1751 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to fix packet index tracer bugs.");
1755 * Sort data stream file groups by first data stream file info
1756 * path to get a deterministic order. This order influences the
1757 * order of the output ports. It also influences the order of
1758 * the automatic stream IDs if the trace's packet headers do not
1759 * contain a `stream_instance_id` field, in which case the data
1760 * stream file to stream ID association is always the same,
1761 * whatever the build and the system.
1763 * Having a deterministic order here can help debugging and
1766 std::sort(ctf_fs
->trace
->ds_file_groups
.begin(), ctf_fs
->trace
->ds_file_groups
.end(),
1767 compare_ds_file_groups_by_first_path
);
1774 g_ptr_array_free(paths
, TRUE
);
1780 static GString
*get_stream_instance_unique_name(struct ctf_fs_ds_file_group
*ds_file_group
)
1783 struct ctf_fs_ds_file_info
*ds_file_info
;
1785 name
= g_string_new(NULL
);
1791 * If there's more than one stream file in the stream file
1792 * group, the first (earliest) stream file's path is used as
1793 * the stream's unique name.
1795 BT_ASSERT(!ds_file_group
->ds_file_infos
.empty());
1796 ds_file_info
= ds_file_group
->ds_file_infos
[0].get();
1797 g_string_assign(name
, ds_file_info
->path
.c_str());
1803 /* Create the IR stream objects for ctf_fs_trace. */
1805 static int create_streams_for_trace(struct ctf_fs_trace
*ctf_fs_trace
)
1808 GString
*name
= NULL
;
1810 for (const auto& ds_file_group
: ctf_fs_trace
->ds_file_groups
) {
1811 name
= get_stream_instance_unique_name(ds_file_group
.get());
1817 BT_ASSERT(ds_file_group
->sc
->ir_sc
);
1818 BT_ASSERT(ctf_fs_trace
->trace
);
1822 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
1823 /* No stream ID: use 0 */
1824 stream
= bt_stream_create_with_id(ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
,
1825 ctf_fs_trace
->next_stream_id
);
1826 ctf_fs_trace
->next_stream_id
++;
1828 /* Specific stream ID */
1829 stream
= bt_stream_create_with_id(ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
,
1830 (uint64_t) ds_file_group
->stream_id
);
1834 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1835 "Cannot create stream for DS file group: "
1836 "addr={}, stream-name=\"{}\"",
1837 fmt::ptr(ds_file_group
), name
->str
);
1841 ds_file_group
->stream
= bt2::Stream::Shared::createWithoutRef(stream
);
1843 ret
= bt_stream_set_name(ds_file_group
->stream
->libObjPtr(), name
->str
);
1845 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1846 "Cannot set stream's name: "
1847 "addr={}, stream-name=\"{}\"",
1848 fmt::ptr(ds_file_group
->stream
->libObjPtr()), name
->str
);
1852 g_string_free(name
, TRUE
);
1865 g_string_free(name
, TRUE
);
1870 static const bt_param_validation_value_descr inputs_elem_descr
=
1871 bt_param_validation_value_descr::makeString();
1873 static bt_param_validation_map_value_entry_descr fs_params_entries_descr
[] = {
1874 {"inputs", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
1875 bt_param_validation_value_descr::makeArray(1, BT_PARAM_VALIDATION_INFINITE
,
1876 inputs_elem_descr
)},
1877 {"trace-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1878 bt_param_validation_value_descr::makeString()},
1879 {"clock-class-offset-s", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1880 bt_param_validation_value_descr::makeSignedInteger()},
1881 {"clock-class-offset-ns", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1882 bt_param_validation_value_descr::makeSignedInteger()},
1883 {"force-clock-class-origin-unix-epoch", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1884 bt_param_validation_value_descr::makeBool()},
1885 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
1887 bool read_src_fs_parameters(const bt_value
*params
, const bt_value
**inputs
,
1888 const bt_value
**trace_name
, struct ctf_fs_component
*ctf_fs
)
1891 const bt_value
*value
;
1892 enum bt_param_validation_status validate_value_status
;
1893 gchar
*error
= NULL
;
1895 validate_value_status
= bt_param_validation_validate(params
, fs_params_entries_descr
, &error
);
1896 if (validate_value_status
!= BT_PARAM_VALIDATION_STATUS_OK
) {
1897 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "{}", error
);
1902 /* inputs parameter */
1903 *inputs
= bt_value_map_borrow_entry_value_const(params
, "inputs");
1905 /* clock-class-offset-s parameter */
1906 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-s");
1908 ctf_fs
->clkClsCfg
.offsetSec
= bt_value_integer_signed_get(value
);
1911 /* clock-class-offset-ns parameter */
1912 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-ns");
1914 ctf_fs
->clkClsCfg
.offsetNanoSec
= bt_value_integer_signed_get(value
);
1917 /* force-clock-class-origin-unix-epoch parameter */
1918 value
= bt_value_map_borrow_entry_value_const(params
, "force-clock-class-origin-unix-epoch");
1920 ctf_fs
->clkClsCfg
.forceOriginIsUnixEpoch
= bt_value_bool_get(value
);
1923 /* trace-name parameter */
1924 *trace_name
= bt_value_map_borrow_entry_value_const(params
, "trace-name");
1933 static ctf_fs_component::UP
ctf_fs_create(const bt_value
*params
,
1934 bt_self_component_source
*self_comp_src
)
1936 const bt_value
*inputs_value
;
1937 const bt_value
*trace_name_value
;
1938 bt_self_component
*self_comp
= bt_self_component_source_as_self_component(self_comp_src
);
1940 ctf_fs_component::UP ctf_fs
= ctf_fs_component_create(
1941 bt2c::Logger
{bt2::SelfSourceComponent
{self_comp_src
}, "PLUGIN/SRC.CTF.FS/COMP"});
1946 if (!read_src_fs_parameters(params
, &inputs_value
, &trace_name_value
, ctf_fs
.get())) {
1950 if (ctf_fs_component_create_ctf_fs_trace(ctf_fs
.get(), inputs_value
, trace_name_value
,
1955 if (create_streams_for_trace(ctf_fs
->trace
.get())) {
1959 if (create_ports_for_trace(ctf_fs
.get(), ctf_fs
->trace
.get(), self_comp_src
)) {
1966 bt_component_class_initialize_method_status
ctf_fs_init(bt_self_component_source
*self_comp_src
,
1967 bt_self_component_source_configuration
*,
1968 const bt_value
*params
, void *)
1971 bt_component_class_initialize_method_status ret
=
1972 BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
1974 ctf_fs_component::UP ctf_fs
= ctf_fs_create(params
, self_comp_src
);
1976 ret
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1979 bt_self_component_set_data(bt_self_component_source_as_self_component(self_comp_src
),
1982 } catch (const std::bad_alloc
&) {
1983 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1984 } catch (const bt2::Error
&) {
1985 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1989 bt_component_class_query_method_status
ctf_fs_query(bt_self_component_class_source
*comp_class_src
,
1990 bt_private_query_executor
*priv_query_exec
,
1991 const char *object
, const bt_value
*params
,
1992 __attribute__((unused
)) void *method_data
,
1993 const bt_value
**result
)
1996 bt2c::Logger logger
{bt2::SelfComponentClass
{comp_class_src
},
1997 bt2::PrivateQueryExecutor
{priv_query_exec
},
1998 "PLUGIN/SRC.CTF.FS/QUERY"};
1999 bt2::ConstMapValue
paramsObj(params
);
2000 bt2::Value::Shared resultObj
;
2002 if (strcmp(object
, "metadata-info") == 0) {
2003 resultObj
= metadata_info_query(paramsObj
, logger
);
2004 } else if (strcmp(object
, "babeltrace.trace-infos") == 0) {
2005 resultObj
= trace_infos_query(paramsObj
, logger
);
2006 } else if (!strcmp(object
, "babeltrace.support-info")) {
2007 resultObj
= support_info_query(paramsObj
, logger
);
2009 BT_CPPLOGE_SPEC(logger
, "Unknown query object `{}`", object
);
2010 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;
2013 *result
= resultObj
.release().libObjPtr();
2015 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
2016 } catch (const std::bad_alloc
&) {
2017 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
2018 } catch (const bt2::Error
&) {
2019 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;