2 * SPDX-License-Identifier: MIT
4 * Copyright 2015-2017 Philippe Proulx <pproulx@efficios.com>
5 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 * Babeltrace CTF file system Reader Component
13 #include <babeltrace2/babeltrace.h>
15 #include "common/assert.h"
16 #include "common/common.h"
17 #include "common/uuid.h"
18 #include "cpp-common/bt2s/make-unique.hpp"
20 #include "plugins/common/param-validation/param-validation.h"
22 #include "../common/src/metadata/tsdl/ctf-meta-configure-ir-trace.hpp"
23 #include "../common/src/msg-iter/msg-iter.hpp"
24 #include "data-stream-file.hpp"
27 #include "metadata.hpp"
38 static bt_message_iterator_class_next_method_status
39 ctf_fs_iterator_next_one(struct ctf_fs_msg_iter_data
*msg_iter_data
, const bt_message
**out_msg
)
41 bt_message_iterator_class_next_method_status status
;
42 const auto msg_iter_status
=
43 ctf_msg_iter_get_next_message(msg_iter_data
->msg_iter
.get(), out_msg
);
45 switch (msg_iter_status
) {
46 case CTF_MSG_ITER_STATUS_OK
:
47 /* Cool, message has been written to *out_msg. */
48 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
51 case CTF_MSG_ITER_STATUS_EOF
:
52 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END
;
55 case CTF_MSG_ITER_STATUS_AGAIN
:
57 * Should not make it this far as this is
58 * medium-specific; there is nothing for the user to do
59 * and it should have been handled upstream.
63 case CTF_MSG_ITER_STATUS_ERROR
:
64 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
65 "Failed to get next message from CTF message iterator.");
66 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
69 case CTF_MSG_ITER_STATUS_MEMORY_ERROR
:
70 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
71 "Failed to get next message from CTF message iterator.");
72 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
82 bt_message_iterator_class_next_method_status
83 ctf_fs_iterator_next(bt_self_message_iterator
*iterator
, bt_message_array_const msgs
,
84 uint64_t capacity
, uint64_t *count
)
87 bt_message_iterator_class_next_method_status status
;
88 struct ctf_fs_msg_iter_data
*msg_iter_data
=
89 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(iterator
);
92 if (G_UNLIKELY(msg_iter_data
->next_saved_error
)) {
94 * Last time we were called, we hit an error but had some
95 * messages to deliver, so we stashed the error here. Return
98 BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(msg_iter_data
->next_saved_error
);
99 status
= msg_iter_data
->next_saved_status
;
104 status
= ctf_fs_iterator_next_one(msg_iter_data
, &msgs
[i
]);
105 if (status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
) {
108 } while (i
< capacity
&& status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
);
112 * Even if ctf_fs_iterator_next_one() returned something
113 * else than BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK, we
114 * accumulated message objects in the output
115 * message array, so we need to return
116 * BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK so that they are
117 * transferred to downstream. This other status occurs
118 * again the next time muxer_msg_iter_do_next() is
119 * called, possibly without any accumulated
120 * message, in which case we'll return it.
124 * Save this error for the next _next call. Assume that
125 * this component always appends error causes when
126 * returning an error status code, which will cause the
127 * current thread error to be non-NULL.
129 msg_iter_data
->next_saved_error
= bt_current_thread_take_error();
130 BT_ASSERT(msg_iter_data
->next_saved_error
);
131 msg_iter_data
->next_saved_status
= status
;
135 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
141 } catch (const std::bad_alloc
&) {
142 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
143 } catch (const bt2::Error
&) {
144 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
148 bt_message_iterator_class_seek_beginning_method_status
149 ctf_fs_iterator_seek_beginning(bt_self_message_iterator
*it
)
152 struct ctf_fs_msg_iter_data
*msg_iter_data
=
153 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(it
);
155 BT_ASSERT(msg_iter_data
);
157 ctf_msg_iter_reset(msg_iter_data
->msg_iter
.get());
158 ctf_fs_ds_group_medops_data_reset(msg_iter_data
->msg_iter_medops_data
.get());
160 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_OK
;
161 } catch (const std::bad_alloc
&) {
162 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_MEMORY_ERROR
;
163 } catch (const bt2::Error
&) {
164 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_ERROR
;
168 void ctf_fs_iterator_finalize(bt_self_message_iterator
*it
)
170 ctf_fs_msg_iter_data::UP
{
171 (static_cast<ctf_fs_msg_iter_data
*>(bt_self_message_iterator_get_data(it
)))};
174 static bt_message_iterator_class_initialize_method_status
175 ctf_msg_iter_medium_status_to_msg_iter_initialize_status(enum ctf_msg_iter_medium_status status
)
178 case CTF_MSG_ITER_MEDIUM_STATUS_EOF
:
179 case CTF_MSG_ITER_MEDIUM_STATUS_AGAIN
:
180 case CTF_MSG_ITER_MEDIUM_STATUS_ERROR
:
181 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
182 case CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
:
183 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
184 case CTF_MSG_ITER_MEDIUM_STATUS_OK
:
185 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
191 bt_message_iterator_class_initialize_method_status
192 ctf_fs_iterator_init(bt_self_message_iterator
*self_msg_iter
,
193 bt_self_message_iterator_configuration
*config
,
194 bt_self_component_port_output
*self_port
)
197 struct ctf_fs_port_data
*port_data
;
198 bt_message_iterator_class_initialize_method_status status
;
199 enum ctf_msg_iter_medium_status medium_status
;
201 port_data
= (struct ctf_fs_port_data
*) bt_self_component_port_get_data(
202 bt_self_component_port_output_as_self_component_port(self_port
));
203 BT_ASSERT(port_data
);
205 auto msg_iter_data
= bt2s::make_unique
<ctf_fs_msg_iter_data
>(self_msg_iter
);
206 msg_iter_data
->ds_file_group
= port_data
->ds_file_group
;
208 medium_status
= ctf_fs_ds_group_medops_data_create(msg_iter_data
->ds_file_group
,
209 self_msg_iter
, msg_iter_data
->logger
,
210 msg_iter_data
->msg_iter_medops_data
);
211 BT_ASSERT(medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_OK
||
212 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_ERROR
||
213 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
);
214 if (medium_status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
215 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
216 "Failed to create ctf_fs_ds_group_medops");
217 status
= ctf_msg_iter_medium_status_to_msg_iter_initialize_status(medium_status
);
221 msg_iter_data
->msg_iter
= ctf_msg_iter_create(
222 msg_iter_data
->ds_file_group
->ctf_fs_trace
->metadata
->tc
,
223 bt_common_get_page_size(static_cast<int>(msg_iter_data
->logger
.level())) * 8,
224 ctf_fs_ds_group_medops
, msg_iter_data
->msg_iter_medops_data
.get(), self_msg_iter
,
225 msg_iter_data
->logger
);
226 if (!msg_iter_data
->msg_iter
) {
227 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
228 "Cannot create a CTF message iterator.");
229 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
234 * This iterator can seek forward if its stream class has a default
237 if (msg_iter_data
->ds_file_group
->sc
->default_clock_class
) {
238 bt_self_message_iterator_configuration_set_can_seek_forward(config
, true);
241 bt_self_message_iterator_set_data(self_msg_iter
, msg_iter_data
.release());
243 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
247 bt_self_message_iterator_set_data(self_msg_iter
, NULL
);
251 } catch (const std::bad_alloc
&) {
252 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
253 } catch (const bt2::Error
&) {
254 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
258 ctf_fs_component::UP
ctf_fs_component_create(const bt2c::Logger
& parentLogger
)
260 return bt2s::make_unique
<ctf_fs_component
>(parentLogger
);
263 void ctf_fs_finalize(bt_self_component_source
*component
)
265 ctf_fs_component::UP
{static_cast<ctf_fs_component
*>(
266 bt_self_component_get_data(bt_self_component_source_as_self_component(component
)))};
269 bt2c::GCharUP
ctf_fs_make_port_name(struct ctf_fs_ds_file_group
*ds_file_group
)
271 GString
*name
= g_string_new(NULL
);
274 * The unique port name is generated by concatenating unique identifiers
282 /* For the trace, use the uuid if present, else the path. */
283 if (ds_file_group
->ctf_fs_trace
->metadata
->tc
->is_uuid_set
) {
284 char uuid_str
[BT_UUID_STR_LEN
+ 1];
286 bt_uuid_to_str(ds_file_group
->ctf_fs_trace
->metadata
->tc
->uuid
, uuid_str
);
287 g_string_assign(name
, uuid_str
);
289 g_string_assign(name
, ds_file_group
->ctf_fs_trace
->path
.c_str());
293 * For the stream class, use the id if present. We can omit this field
294 * otherwise, as there will only be a single stream class.
296 if (ds_file_group
->sc
->id
!= UINT64_C(-1)) {
297 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->sc
->id
);
300 /* For the stream, use the id if present, else, use the path. */
301 if (ds_file_group
->stream_id
!= UINT64_C(-1)) {
302 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->stream_id
);
304 BT_ASSERT(ds_file_group
->ds_file_infos
.size() == 1);
305 const auto& ds_file_info
= *ds_file_group
->ds_file_infos
[0];
306 g_string_append_printf(name
, " | %s", ds_file_info
.path
.c_str());
309 return bt2c::GCharUP
{g_string_free(name
, FALSE
)};
312 static int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
313 struct ctf_fs_ds_file_group
*ds_file_group
,
314 bt_self_component_source
*self_comp_src
)
317 ctf_fs_port_data::UP port_data
;
319 bt2c::GCharUP port_name
= ctf_fs_make_port_name(ds_file_group
);
324 BT_CPPLOGI_SPEC(ctf_fs
->logger
, "Creating one port named `{}`", port_name
.get());
326 /* Create output port for this file */
327 port_data
= bt2s::make_unique
<ctf_fs_port_data
>();
328 port_data
->ctf_fs
= ctf_fs
;
329 port_data
->ds_file_group
= ds_file_group
;
330 ret
= bt_self_component_source_add_output_port(self_comp_src
, port_name
.get(), port_data
.get(),
336 ctf_fs
->port_data
.emplace_back(std::move(port_data
));
346 static int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
347 struct ctf_fs_trace
*ctf_fs_trace
,
348 bt_self_component_source
*self_comp_src
)
352 /* Create one output port for each stream file group */
353 for (const auto& ds_file_group
: ctf_fs_trace
->ds_file_groups
) {
354 ret
= create_one_port_for_trace(ctf_fs
, ds_file_group
.get(), self_comp_src
);
356 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create output port.");
366 * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right
367 * place to keep it sorted.
370 static void ds_file_group_insert_ds_file_info_sorted(struct ctf_fs_ds_file_group
*ds_file_group
,
371 ctf_fs_ds_file_info::UP ds_file_info
)
373 /* Find the spot where to insert this ds_file_info. */
374 auto it
= ds_file_group
->ds_file_infos
.begin();
376 for (; it
!= ds_file_group
->ds_file_infos
.end(); ++it
) {
377 const ctf_fs_ds_file_info
& other_ds_file_info
= **it
;
379 if (ds_file_info
->begin_ns
< other_ds_file_info
.begin_ns
) {
384 ds_file_group
->ds_file_infos
.insert(it
, std::move(ds_file_info
));
387 static bool ds_index_entries_equal(const struct ctf_fs_ds_index_entry
*left
,
388 const struct ctf_fs_ds_index_entry
*right
)
390 if (left
->packetSize
!= right
->packetSize
) {
394 if (left
->timestamp_begin
!= right
->timestamp_begin
) {
398 if (left
->timestamp_end
!= right
->timestamp_end
) {
402 if (left
->packet_seq_num
!= right
->packet_seq_num
) {
410 * Insert `entry` into `index`, without duplication.
412 * The entry is inserted only if there isn't an identical entry already.
414 * In any case, the ownership of `entry` is transferred to this function. So if
415 * the entry is not inserted, it is freed.
418 static void ds_index_insert_ds_index_entry_sorted(struct ctf_fs_ds_index
*index
,
419 ctf_fs_ds_index_entry::UP entry
)
421 /* Find the spot where to insert this index entry. */
422 auto otherEntry
= index
->entries
.begin();
423 for (; otherEntry
!= index
->entries
.end(); ++otherEntry
) {
424 if (entry
->timestamp_begin_ns
<= (*otherEntry
)->timestamp_begin_ns
) {
430 * Insert the entry only if a duplicate doesn't already exist.
432 * There can be duplicate packets if reading multiple overlapping
433 * snapshots of the same trace. We then want the index to contain
434 * a reference to only one copy of that packet.
436 if (otherEntry
== index
->entries
.end() ||
437 !ds_index_entries_equal(entry
.get(), otherEntry
->get())) {
438 index
->entries
.insert(otherEntry
, std::move(entry
));
442 static void merge_ctf_fs_ds_indexes(struct ctf_fs_ds_index
*dest
, ctf_fs_ds_index::UP src
)
444 for (auto& entry
: src
->entries
) {
445 ds_index_insert_ds_index_entry_sorted(dest
, std::move(entry
));
449 static int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
, const char *path
)
451 int64_t stream_instance_id
= -1;
452 int64_t begin_ns
= -1;
453 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
454 ctf_fs_ds_file_group::UP new_ds_file_group
;
456 ctf_fs_ds_file_info::UP ds_file_info
;
457 ctf_fs_ds_index::UP index
;
458 ctf_msg_iter_up msg_iter
;
459 struct ctf_stream_class
*sc
= NULL
;
460 struct ctf_msg_iter_packet_properties props
;
463 * Create a temporary ds_file to read some properties about the data
467 ctf_fs_ds_file_create(ctf_fs_trace
, bt2::Stream::Shared
{}, path
, ctf_fs_trace
->logger
);
472 /* Create a temporary iterator to read the ds_file. */
473 msg_iter
= ctf_msg_iter_create(
474 ctf_fs_trace
->metadata
->tc
,
475 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
476 ctf_fs_ds_file_medops
, ds_file
.get(), nullptr, ctf_fs_trace
->logger
);
478 BT_CPPLOGE_STR_SPEC(ctf_fs_trace
->logger
, "Cannot create a CTF message iterator.");
482 ctf_msg_iter_set_dry_run(msg_iter
.get(), true);
484 ret
= ctf_msg_iter_get_packet_properties(msg_iter
.get(), &props
);
486 BT_CPPLOGE_APPEND_CAUSE_SPEC(
487 ctf_fs_trace
->logger
,
488 "Cannot get stream file's first packet's header and context fields (`{}`).", path
);
492 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
, props
.stream_class_id
);
494 stream_instance_id
= props
.data_stream_id
;
496 if (props
.snapshots
.beginning_clock
!= UINT64_C(-1)) {
497 BT_ASSERT(sc
->default_clock_class
);
498 ret
= bt_util_clock_cycles_to_ns_from_origin(
499 props
.snapshots
.beginning_clock
, sc
->default_clock_class
->frequency
,
500 sc
->default_clock_class
->offset_seconds
, sc
->default_clock_class
->offset_cycles
,
503 BT_CPPLOGE_APPEND_CAUSE_SPEC(
504 ctf_fs_trace
->logger
,
505 "Cannot convert clock cycles to nanoseconds from origin (`{}`).", path
);
510 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
);
515 index
= ctf_fs_ds_file_build_index(ds_file
.get(), ds_file_info
.get(), msg_iter
.get());
517 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to index CTF stream file \'{}\'",
518 ds_file
->file
->path
);
522 if (begin_ns
== -1) {
524 * No beginning timestamp to sort the stream files
525 * within a stream file group, so consider that this
526 * file must be the only one within its group.
528 stream_instance_id
= -1;
531 if (stream_instance_id
== -1) {
533 * No stream instance ID or no beginning timestamp:
534 * create a unique stream file group for this stream
535 * file because, even if there's a stream instance ID,
536 * there's no timestamp to order the file within its
540 ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, UINT64_C(-1), std::move(index
));
542 if (!new_ds_file_group
) {
546 ds_file_group_insert_ds_file_info_sorted(new_ds_file_group
.get(), std::move(ds_file_info
));
547 ctf_fs_trace
->ds_file_groups
.emplace_back(std::move(new_ds_file_group
));
551 BT_ASSERT(stream_instance_id
!= -1);
552 BT_ASSERT(begin_ns
!= -1);
554 /* Find an existing stream file group with this ID */
555 for (const auto& candidate
: ctf_fs_trace
->ds_file_groups
) {
556 if (candidate
->sc
== sc
&& candidate
->stream_id
== stream_instance_id
) {
557 ds_file_group
= candidate
.get();
562 if (!ds_file_group
) {
564 ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, stream_instance_id
, std::move(index
));
565 if (!new_ds_file_group
) {
569 ds_file_group
= new_ds_file_group
.get();
570 ctf_fs_trace
->ds_file_groups
.emplace_back(std::move(new_ds_file_group
));
572 merge_ctf_fs_ds_indexes(ds_file_group
->index
.get(), std::move(index
));
575 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, std::move(ds_file_info
));
586 static int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
589 const char *basename
;
590 GError
*error
= NULL
;
593 /* Check each file in the path directory, except specific ones */
594 dir
= g_dir_open(ctf_fs_trace
->path
.c_str(), 0, &error
);
596 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
597 "Cannot open directory `{}`: {} (code {})", ctf_fs_trace
->path
,
598 error
->message
, error
->code
);
602 while ((basename
= g_dir_read_name(dir
))) {
603 if (strcmp(basename
, CTF_FS_METADATA_FILENAME
) == 0) {
604 /* Ignore the metadata stream. */
605 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
606 "Ignoring metadata file `{}" G_DIR_SEPARATOR_S
"{}`",
607 ctf_fs_trace
->path
, basename
);
611 if (basename
[0] == '.') {
612 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
613 "Ignoring hidden file `{}" G_DIR_SEPARATOR_S
"{}`", ctf_fs_trace
->path
,
618 /* Create the file. */
619 const auto file
= ctf_fs_file_create(ctf_fs_trace
->logger
);
621 BT_CPPLOGE_APPEND_CAUSE_SPEC(
622 ctf_fs_trace
->logger
,
623 "Cannot create stream file object for file `{}" G_DIR_SEPARATOR_S
"{}`",
624 ctf_fs_trace
->path
, basename
);
628 /* Create full path string. */
629 file
->path
= fmt::format("{}" G_DIR_SEPARATOR_S
"{}", ctf_fs_trace
->path
, basename
);
631 if (!g_file_test(file
->path
.c_str(), G_FILE_TEST_IS_REGULAR
)) {
632 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring non-regular file `{}`", file
->path
);
636 ret
= ctf_fs_file_open(file
.get(), "rb");
638 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Cannot open stream file `{}`",
643 if (file
->size
== 0) {
644 /* Skip empty stream. */
645 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring empty file `{}`", file
->path
);
649 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
, file
->path
.c_str());
651 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
652 "Cannot add stream file `{}` to stream file group",
676 static int set_trace_name(bt_trace
*trace
, const char *name_suffix
, const bt2c::Logger
& logger
)
682 name
= g_string_new(NULL
);
684 BT_CPPLOGE_STR_SPEC(logger
, "Failed to allocate a GString.");
690 * Check if we have a trace environment string value named `hostname`.
691 * If so, use it as the trace name's prefix.
693 val
= bt_trace_borrow_environment_entry_value_by_name_const(trace
, "hostname");
694 if (val
&& bt_value_is_string(val
)) {
695 g_string_append(name
, bt_value_string_get(val
));
698 g_string_append_c(name
, G_DIR_SEPARATOR
);
703 g_string_append(name
, name_suffix
);
706 ret
= bt_trace_set_name(trace
, name
->str
);
715 g_string_free(name
, TRUE
);
721 static ctf_fs_trace::UP
ctf_fs_trace_create(const char *path
, const char *name
,
722 const ctf::src::ClkClsCfg
& clkClsCfg
,
723 bt_self_component
*selfComp
,
724 const bt2c::Logger
& parentLogger
)
727 ctf_fs_trace::UP ctf_fs_trace
{new struct ctf_fs_trace(parentLogger
)};
729 ctf_fs_trace
->path
= path
;
730 ctf_fs_trace
->metadata
= bt2s::make_unique
<ctf_fs_metadata
>();
732 ret
= ctf_fs_metadata_set_trace_class(selfComp
, ctf_fs_trace
.get(), clkClsCfg
);
737 if (ctf_fs_trace
->metadata
->trace_class
) {
738 bt_trace
*trace
= bt_trace_create(ctf_fs_trace
->metadata
->trace_class
->libObjPtr());
743 ctf_fs_trace
->trace
= bt2::Trace::Shared::createWithoutRef(trace
);
746 if (ctf_fs_trace
->trace
) {
747 ret
= ctf_trace_class_configure_ir_trace(ctf_fs_trace
->metadata
->tc
,
748 ctf_fs_trace
->trace
->libObjPtr());
753 ret
= set_trace_name(ctf_fs_trace
->trace
->libObjPtr(), name
, ctf_fs_trace
->logger
);
759 ret
= create_ds_file_groups(ctf_fs_trace
.get());
767 ctf_fs_trace
.reset();
773 static int path_is_ctf_trace(const char *path
)
775 GString
*metadata_path
= g_string_new(NULL
);
778 if (!metadata_path
) {
783 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
785 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
791 g_string_free(metadata_path
, TRUE
);
795 /* Helper for ctf_fs_component_create_ctf_fs_trace, to handle a single path. */
797 static int ctf_fs_component_create_ctf_fs_trace_one_path(struct ctf_fs_component
*ctf_fs
,
798 const char *path_param
,
799 const char *trace_name
,
800 std::vector
<ctf_fs_trace::UP
>& traces
,
801 bt_self_component
*selfComp
)
803 ctf_fs_trace::UP ctf_fs_trace
;
807 norm_path
= bt_common_normalize_path(path_param
, NULL
);
809 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to normalize path: `{}`.", path_param
);
813 ret
= path_is_ctf_trace(norm_path
->str
);
815 BT_CPPLOGE_APPEND_CAUSE_SPEC(
816 ctf_fs
->logger
, "Failed to check if path is a CTF trace: path={}", norm_path
->str
);
818 } else if (ret
== 0) {
819 BT_CPPLOGE_APPEND_CAUSE_SPEC(
820 ctf_fs
->logger
, "Path is not a CTF trace (does not contain a metadata file): `{}`.",
825 // FIXME: Remove or ifdef for __MINGW32__
826 if (strcmp(norm_path
->str
, "/") == 0) {
827 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Opening a trace in `/` is not supported.");
832 ctf_fs_trace
= ctf_fs_trace_create(norm_path
->str
, trace_name
, ctf_fs
->clkClsCfg
, selfComp
,
835 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create trace for `{}`.",
840 traces
.emplace_back(std::move(ctf_fs_trace
));
850 g_string_free(norm_path
, TRUE
);
857 * Count the number of stream and event classes defined by this trace's metadata.
859 * This is used to determine which metadata is the "latest", out of multiple
860 * traces sharing the same UUID. It is assumed that amongst all these metadatas,
861 * a bigger metadata is a superset of a smaller metadata. Therefore, it is
862 * enough to just count the classes.
865 static unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace
*trace
)
867 unsigned int num
= trace
->metadata
->tc
->stream_classes
->len
;
870 for (i
= 0; i
< trace
->metadata
->tc
->stream_classes
->len
; i
++) {
871 struct ctf_stream_class
*sc
=
872 (struct ctf_stream_class
*) trace
->metadata
->tc
->stream_classes
->pdata
[i
];
873 num
+= sc
->event_classes
->len
;
880 * Merge the src ds_file_group into dest. This consists of merging their
881 * ds_file_infos, making sure to keep the result sorted.
884 static void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group
*dest
,
885 ctf_fs_ds_file_group::UP src
)
887 for (auto& ds_file_info
: src
->ds_file_infos
) {
888 ds_file_group_insert_ds_file_info_sorted(dest
, std::move(ds_file_info
));
891 /* Merge both indexes. */
892 merge_ctf_fs_ds_indexes(dest
->index
.get(), std::move(src
->index
));
895 /* Merge src_trace's data stream file groups into dest_trace's. */
897 static int merge_matching_ctf_fs_ds_file_groups(struct ctf_fs_trace
*dest_trace
,
898 ctf_fs_trace::UP src_trace
)
900 std::vector
<ctf_fs_ds_file_group::UP
>& dest
= dest_trace
->ds_file_groups
;
901 std::vector
<ctf_fs_ds_file_group::UP
>& src
= src_trace
->ds_file_groups
;
905 * Save the initial length of dest: we only want to check against the
906 * original elements in the inner loop.
908 size_t dest_len
= dest
.size();
910 for (auto& src_group
: src
) {
911 struct ctf_fs_ds_file_group
*dest_group
= NULL
;
913 /* A stream instance without ID can't match a stream in the other trace. */
914 if (src_group
->stream_id
!= -1) {
915 /* Let's search for a matching ds_file_group in the destination. */
916 for (size_t d_i
= 0; d_i
< dest_len
; ++d_i
) {
917 ctf_fs_ds_file_group
*candidate_dest
= dest
[d_i
].get();
919 /* Can't match a stream instance without ID. */
920 if (candidate_dest
->stream_id
== -1) {
925 * If the two groups have the same stream instance id
926 * and belong to the same stream class (stream instance
927 * ids are per-stream class), they represent the same
930 if (candidate_dest
->stream_id
!= src_group
->stream_id
||
931 candidate_dest
->sc
->id
!= src_group
->sc
->id
) {
935 dest_group
= candidate_dest
;
941 * Didn't find a friend in dest to merge our src_group into?
942 * Create a new empty one. This can happen if a stream was
943 * active in the source trace chunk but not in the destination
947 struct ctf_stream_class
*sc
;
949 sc
= ctf_trace_class_borrow_stream_class_by_id(dest_trace
->metadata
->tc
,
953 auto index
= ctf_fs_ds_index_create();
959 auto new_dest_group
=
960 ctf_fs_ds_file_group_create(dest_trace
, sc
, src_group
->stream_id
, std::move(index
));
962 if (!new_dest_group
) {
967 dest_group
= new_dest_group
.get();
968 dest_trace
->ds_file_groups
.emplace_back(std::move(new_dest_group
));
971 BT_ASSERT(dest_group
);
972 merge_ctf_fs_ds_file_groups(dest_group
, std::move(src_group
));
980 * Collapse the given traces, which must all share the same UUID, in a single
983 * The trace with the most expansive metadata is chosen and all other traces
984 * are merged into that one. On return, the elements of `traces` are nullptr
985 * and the merged trace is placed in `out_trace`.
988 static int merge_ctf_fs_traces(std::vector
<ctf_fs_trace::UP
> traces
, ctf_fs_trace::UP
& out_trace
)
990 unsigned int winner_count
;
991 struct ctf_fs_trace
*winner
;
995 BT_ASSERT(traces
.size() >= 2);
997 winner_count
= metadata_count_stream_and_event_classes(traces
[0].get());
998 winner
= traces
[0].get();
1001 /* Find the trace with the largest metadata. */
1002 for (i
= 1; i
< traces
.size(); i
++) {
1003 ctf_fs_trace
*candidate
= traces
[i
].get();
1004 unsigned int candidate_count
;
1006 /* A bit of sanity check. */
1007 BT_ASSERT(bt_uuid_compare(winner
->metadata
->tc
->uuid
, candidate
->metadata
->tc
->uuid
) == 0);
1009 candidate_count
= metadata_count_stream_and_event_classes(candidate
);
1011 if (candidate_count
> winner_count
) {
1012 winner_count
= candidate_count
;
1018 /* Merge all the other traces in the winning trace. */
1019 for (ctf_fs_trace::UP
& trace
: traces
) {
1020 /* Don't merge the winner into itself. */
1021 if (trace
.get() == winner
) {
1025 /* Merge trace's data stream file groups into winner's. */
1026 ret
= merge_matching_ctf_fs_ds_file_groups(winner
, std::move(trace
));
1033 * Move the winner out of the array, into `*out_trace`.
1035 out_trace
= std::move(traces
[winner_i
]);
1047 static int decode_clock_snapshot_after_event(struct ctf_fs_trace
*ctf_fs_trace
,
1048 struct ctf_clock_class
*default_cc
,
1049 struct ctf_fs_ds_index_entry
*index_entry
,
1050 enum target_event target_event
, uint64_t *cs
,
1053 enum ctf_msg_iter_status iter_status
= CTF_MSG_ITER_STATUS_OK
;
1054 ctf_msg_iter_up msg_iter
;
1057 BT_ASSERT(ctf_fs_trace
);
1058 BT_ASSERT(index_entry
);
1059 BT_ASSERT(index_entry
->path
);
1061 const auto ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, bt2::Stream::Shared
{},
1062 index_entry
->path
, ctf_fs_trace
->logger
);
1064 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to create a ctf_fs_ds_file");
1069 BT_ASSERT(ctf_fs_trace
->metadata
);
1070 BT_ASSERT(ctf_fs_trace
->metadata
->tc
);
1072 msg_iter
= ctf_msg_iter_create(
1073 ctf_fs_trace
->metadata
->tc
,
1074 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
1075 ctf_fs_ds_file_medops
, ds_file
.get(), NULL
, ctf_fs_trace
->logger
);
1077 /* ctf_msg_iter_create() logs errors. */
1083 * Turn on dry run mode to prevent the creation and usage of Babeltrace
1084 * library objects (bt_field, bt_message_*, etc.).
1086 ctf_msg_iter_set_dry_run(msg_iter
.get(), true);
1088 /* Seek to the beginning of the target packet. */
1089 iter_status
= ctf_msg_iter_seek(msg_iter
.get(), index_entry
->offset
.bytes());
1091 /* ctf_msg_iter_seek() logs errors. */
1096 switch (target_event
) {
1099 * Start to decode the packet until we reach the end of
1100 * the first event. To extract the first event's clock
1103 iter_status
= ctf_msg_iter_curr_packet_first_event_clock_snapshot(msg_iter
.get(), cs
);
1106 /* Decode the packet to extract the last event's clock snapshot. */
1107 iter_status
= ctf_msg_iter_curr_packet_last_event_clock_snapshot(msg_iter
.get(), cs
);
1117 /* Convert clock snapshot to timestamp. */
1118 ret
= bt_util_clock_cycles_to_ns_from_origin(
1119 *cs
, default_cc
->frequency
, default_cc
->offset_seconds
, default_cc
->offset_cycles
, ts_ns
);
1121 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1122 "Failed to convert clock snapshot to timestamp");
1130 static int decode_packet_first_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1131 struct ctf_clock_class
*default_cc
,
1132 struct ctf_fs_ds_index_entry
*index_entry
,
1133 uint64_t *cs
, int64_t *ts_ns
)
1135 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, FIRST_EVENT
, cs
,
1139 static int decode_packet_last_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1140 struct ctf_clock_class
*default_cc
,
1141 struct ctf_fs_ds_index_entry
*index_entry
,
1142 uint64_t *cs
, int64_t *ts_ns
)
1144 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, LAST_EVENT
, cs
,
1149 * Fix up packet index entries for lttng's "event-after-packet" bug.
1150 * Some buggy lttng tracer versions may emit events with a timestamp that is
1151 * larger (after) than the timestamp_end of the their packets.
1153 * To fix up this erroneous data we do the following:
1154 * 1. If it's not the stream file's last packet: set the packet index entry's
1155 * end time to the next packet's beginning time.
1156 * 2. If it's the stream file's last packet, set the packet index entry's end
1157 * time to the packet's last event's time, if any, or to the packet's
1158 * beginning time otherwise.
1160 * Known buggy tracer versions:
1161 * - before lttng-ust 2.11.0
1162 * - before lttng-module 2.11.0
1163 * - before lttng-module 2.10.10
1164 * - before lttng-module 2.9.13
1166 static int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace
*trace
)
1170 for (const auto& ds_file_group
: trace
->ds_file_groups
) {
1171 struct ctf_clock_class
*default_cc
;
1173 BT_ASSERT(ds_file_group
);
1174 const auto index
= ds_file_group
->index
.get();
1177 BT_ASSERT(!index
->entries
.empty());
1180 * Iterate over all entries but the last one. The last one is
1181 * fixed differently after.
1183 for (size_t entry_i
= 0; entry_i
< index
->entries
.size() - 1; ++entry_i
) {
1184 ctf_fs_ds_index_entry
*curr_entry
= index
->entries
[entry_i
].get();
1185 ctf_fs_ds_index_entry
*next_entry
= index
->entries
[entry_i
+ 1].get();
1188 * 1. Set the current index entry `end` timestamp to
1189 * the next index entry `begin` timestamp.
1191 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1192 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1196 * 2. Fix the last entry by decoding the last event of the last
1199 const auto last_entry
= index
->entries
.back().get();
1200 BT_ASSERT(last_entry
);
1202 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1203 default_cc
= ds_file_group
->sc
->default_clock_class
;
1206 * Decode packet to read the timestamp of the last event of the
1209 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1210 &last_entry
->timestamp_end
,
1211 &last_entry
->timestamp_end_ns
);
1213 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1215 "Failed to decode stream's last packet to get its last event's clock snapshot.");
1225 * Fix up packet index entries for barectf's "event-before-packet" bug.
1226 * Some buggy barectf tracer versions may emit events with a timestamp that is
1227 * less than the timestamp_begin of the their packets.
1229 * To fix up this erroneous data we do the following:
1230 * 1. Starting at the second index entry, set the timestamp_begin of the
1231 * current entry to the timestamp of the first event of the packet.
1232 * 2. Set the previous entry's timestamp_end to the timestamp_begin of the
1235 * Known buggy tracer versions:
1236 * - before barectf 2.3.1
1238 static int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace
*trace
)
1242 for (const auto& ds_file_group
: trace
->ds_file_groups
) {
1243 struct ctf_clock_class
*default_cc
;
1244 const auto index
= ds_file_group
->index
.get();
1247 BT_ASSERT(!index
->entries
.empty());
1249 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1250 default_cc
= ds_file_group
->sc
->default_clock_class
;
1253 * 1. Iterate over the index, starting from the second entry
1256 for (size_t entry_i
= 1; entry_i
< index
->entries
.size(); ++entry_i
) {
1257 ctf_fs_ds_index_entry
*prev_entry
= index
->entries
[entry_i
- 1].get();
1258 ctf_fs_ds_index_entry
*curr_entry
= index
->entries
[entry_i
].get();
1260 * 2. Set the current entry `begin` timestamp to the
1261 * timestamp of the first event of the current packet.
1263 ret
= decode_packet_first_event_timestamp(trace
, default_cc
, curr_entry
,
1264 &curr_entry
->timestamp_begin
,
1265 &curr_entry
->timestamp_begin_ns
);
1267 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1268 "Failed to decode first event's clock snapshot");
1273 * 3. Set the previous entry `end` timestamp to the
1274 * timestamp of the first event of the current packet.
1276 prev_entry
->timestamp_end
= curr_entry
->timestamp_begin
;
1277 prev_entry
->timestamp_end_ns
= curr_entry
->timestamp_begin_ns
;
1285 * When using the lttng-crash feature it's likely that the last packets of each
1286 * stream have their timestamp_end set to zero. This is caused by the fact that
1287 * the tracer crashed and was not able to properly close the packets.
1289 * To fix up this erroneous data we do the following:
1290 * For each index entry, if the entry's timestamp_end is 0 and the
1291 * timestamp_begin is not 0:
1292 * - If it's the stream file's last packet: set the packet index entry's end
1293 * time to the packet's last event's time, if any, or to the packet's
1294 * beginning time otherwise.
1295 * - If it's not the stream file's last packet: set the packet index
1296 * entry's end time to the next packet's beginning time.
1298 * Affected versions:
1299 * - All current and future lttng-ust and lttng-modules versions.
1301 static int fix_index_lttng_crash_quirk(struct ctf_fs_trace
*trace
)
1305 for (const auto& ds_file_group
: trace
->ds_file_groups
) {
1306 struct ctf_clock_class
*default_cc
;
1308 BT_ASSERT(ds_file_group
);
1309 const auto index
= ds_file_group
->index
.get();
1311 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1312 default_cc
= ds_file_group
->sc
->default_clock_class
;
1315 BT_ASSERT(!index
->entries
.empty());
1317 const auto last_entry
= index
->entries
.back().get();
1318 BT_ASSERT(last_entry
);
1320 /* 1. Fix the last entry first. */
1321 if (last_entry
->timestamp_end
== 0 && last_entry
->timestamp_begin
!= 0) {
1323 * Decode packet to read the timestamp of the
1324 * last event of the stream file.
1326 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1327 &last_entry
->timestamp_end
,
1328 &last_entry
->timestamp_end_ns
);
1330 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1331 "Failed to decode last event's clock snapshot");
1336 /* Iterate over all entries but the last one. */
1337 for (size_t entry_idx
= 0; entry_idx
< index
->entries
.size() - 1; ++entry_idx
) {
1338 ctf_fs_ds_index_entry
*curr_entry
= index
->entries
[entry_idx
].get();
1339 ctf_fs_ds_index_entry
*next_entry
= index
->entries
[entry_idx
+ 1].get();
1341 if (curr_entry
->timestamp_end
== 0 && curr_entry
->timestamp_begin
!= 0) {
1343 * 2. Set the current index entry `end` timestamp to
1344 * the next index entry `begin` timestamp.
1346 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1347 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1357 * Extract the tracer information necessary to compare versions.
1358 * Returns 0 on success, and -1 if the extraction is not successful because the
1359 * necessary fields are absents in the trace metadata.
1361 static int extract_tracer_info(struct ctf_fs_trace
*trace
, struct tracer_info
*current_tracer_info
)
1364 struct ctf_trace_class_env_entry
*entry
;
1366 /* Clear the current_tracer_info struct */
1367 memset(current_tracer_info
, 0, sizeof(*current_tracer_info
));
1370 * To compare 2 tracer versions, at least the tracer name and it's
1371 * major version are needed. If one of these is missing, consider it an
1372 * extraction failure.
1374 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_name");
1375 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR
) {
1376 goto missing_bare_minimum
;
1379 /* Set tracer name. */
1380 current_tracer_info
->name
= entry
->value
.str
->str
;
1382 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_major");
1383 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1384 goto missing_bare_minimum
;
1387 /* Set major version number. */
1388 current_tracer_info
->major
= entry
->value
.i
;
1390 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_minor");
1391 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1395 /* Set minor version number. */
1396 current_tracer_info
->minor
= entry
->value
.i
;
1398 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patch");
1401 * If `tracer_patch` doesn't exist `tracer_patchlevel` might.
1402 * For example, `lttng-modules` uses entry name
1403 * `tracer_patchlevel`.
1405 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patchlevel");
1408 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1412 /* Set patch version number. */
1413 current_tracer_info
->patch
= entry
->value
.i
;
1417 missing_bare_minimum
:
1423 static bool is_tracer_affected_by_lttng_event_after_packet_bug(struct tracer_info
*curr_tracer_info
)
1425 bool is_affected
= false;
1427 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1428 if (curr_tracer_info
->major
< 2) {
1430 } else if (curr_tracer_info
->major
== 2) {
1431 /* fixed in lttng-ust 2.11.0 */
1432 if (curr_tracer_info
->minor
< 11) {
1436 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1437 if (curr_tracer_info
->major
< 2) {
1439 } else if (curr_tracer_info
->major
== 2) {
1440 /* fixed in lttng-modules 2.11.0 */
1441 if (curr_tracer_info
->minor
== 10) {
1442 /* fixed in lttng-modules 2.10.10 */
1443 if (curr_tracer_info
->patch
< 10) {
1446 } else if (curr_tracer_info
->minor
== 9) {
1447 /* fixed in lttng-modules 2.9.13 */
1448 if (curr_tracer_info
->patch
< 13) {
1451 } else if (curr_tracer_info
->minor
< 9) {
1461 is_tracer_affected_by_barectf_event_before_packet_bug(struct tracer_info
*curr_tracer_info
)
1463 bool is_affected
= false;
1465 if (strcmp(curr_tracer_info
->name
, "barectf") == 0) {
1466 if (curr_tracer_info
->major
< 2) {
1468 } else if (curr_tracer_info
->major
== 2) {
1469 if (curr_tracer_info
->minor
< 3) {
1471 } else if (curr_tracer_info
->minor
== 3) {
1472 /* fixed in barectf 2.3.1 */
1473 if (curr_tracer_info
->patch
< 1) {
1483 static bool is_tracer_affected_by_lttng_crash_quirk(struct tracer_info
*curr_tracer_info
)
1485 bool is_affected
= false;
1487 /* All LTTng tracer may be affected by this lttng crash quirk. */
1488 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1490 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1498 * Looks for trace produced by known buggy tracers and fix up the index
1501 static int fix_packet_index_tracer_bugs(ctf_fs_trace
*trace
)
1504 struct tracer_info current_tracer_info
;
1506 ret
= extract_tracer_info(trace
, ¤t_tracer_info
);
1509 * A trace may not have all the necessary environment
1510 * entries to do the tracer version comparison.
1511 * At least, the tracer name and major version number
1512 * are needed. Failing to extract these entries is not
1516 BT_CPPLOGI_STR_SPEC(
1518 "Cannot extract tracer information necessary to compare with buggy versions.");
1522 /* Check if the trace may be affected by old tracer bugs. */
1523 if (is_tracer_affected_by_lttng_event_after_packet_bug(¤t_tracer_info
)) {
1524 BT_CPPLOGI_STR_SPEC(
1526 "Trace may be affected by LTTng tracer packet timestamp bug. Fixing up.");
1527 ret
= fix_index_lttng_event_after_packet_bug(trace
);
1529 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1530 "Failed to fix LTTng event-after-packet bug.");
1533 trace
->metadata
->tc
->quirks
.lttng_event_after_packet
= true;
1536 if (is_tracer_affected_by_barectf_event_before_packet_bug(¤t_tracer_info
)) {
1537 BT_CPPLOGI_STR_SPEC(
1539 "Trace may be affected by barectf tracer packet timestamp bug. Fixing up.");
1540 ret
= fix_index_barectf_event_before_packet_bug(trace
);
1542 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1543 "Failed to fix barectf event-before-packet bug.");
1546 trace
->metadata
->tc
->quirks
.barectf_event_before_packet
= true;
1549 if (is_tracer_affected_by_lttng_crash_quirk(¤t_tracer_info
)) {
1550 ret
= fix_index_lttng_crash_quirk(trace
);
1552 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1553 "Failed to fix lttng-crash timestamp quirks.");
1556 trace
->metadata
->tc
->quirks
.lttng_crash
= true;
1563 static bool compare_ds_file_groups_by_first_path(const ctf_fs_ds_file_group::UP
& ds_file_group_a
,
1564 const ctf_fs_ds_file_group::UP
& ds_file_group_b
)
1566 BT_ASSERT(!ds_file_group_a
->ds_file_infos
.empty());
1567 BT_ASSERT(!ds_file_group_b
->ds_file_infos
.empty());
1569 const auto& first_ds_file_info_a
= *ds_file_group_a
->ds_file_infos
[0];
1570 const auto& first_ds_file_info_b
= *ds_file_group_b
->ds_file_infos
[0];
1572 return first_ds_file_info_a
.path
< first_ds_file_info_b
.path
;
1575 static gint
compare_strings(gconstpointer p_a
, gconstpointer p_b
)
1577 const char *a
= *((const char **) p_a
);
1578 const char *b
= *((const char **) p_b
);
1580 return strcmp(a
, b
);
1583 int ctf_fs_component_create_ctf_fs_trace(struct ctf_fs_component
*ctf_fs
,
1584 const bt_value
*paths_value
,
1585 const bt_value
*trace_name_value
,
1586 bt_self_component
*selfComp
)
1590 GPtrArray
*paths
= NULL
;
1591 std::vector
<ctf_fs_trace::UP
> traces
;
1592 const char *trace_name
;
1594 BT_ASSERT(bt_value_get_type(paths_value
) == BT_VALUE_TYPE_ARRAY
);
1595 BT_ASSERT(!bt_value_array_is_empty(paths_value
));
1597 paths
= g_ptr_array_new_with_free_func(g_free
);
1599 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to allocate a GPtrArray.");
1603 trace_name
= trace_name_value
? bt_value_string_get(trace_name_value
) : NULL
;
1606 * Create a sorted array of the paths, to make the execution of this
1607 * component deterministic.
1609 for (i
= 0; i
< bt_value_array_get_length(paths_value
); i
++) {
1610 const bt_value
*path_value
= bt_value_array_borrow_element_by_index_const(paths_value
, i
);
1611 const char *input
= bt_value_string_get(path_value
);
1614 input_copy
= g_strdup(input
);
1616 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to copy a string.");
1620 g_ptr_array_add(paths
, input_copy
);
1623 g_ptr_array_sort(paths
, compare_strings
);
1625 /* Create a separate ctf_fs_trace object for each path. */
1626 for (i
= 0; i
< paths
->len
; i
++) {
1627 const char *path
= (const char *) g_ptr_array_index(paths
, i
);
1629 ret
= ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs
, path
, trace_name
, traces
,
1636 if (traces
.size() > 1) {
1637 ctf_fs_trace
*first_trace
= traces
[0].get();
1638 const uint8_t *first_trace_uuid
= first_trace
->metadata
->tc
->uuid
;
1641 * We have more than one trace, they must all share the same
1642 * UUID, verify that.
1644 for (i
= 0; i
< traces
.size(); i
++) {
1645 ctf_fs_trace
*this_trace
= traces
[i
].get();
1646 const uint8_t *this_trace_uuid
= this_trace
->metadata
->tc
->uuid
;
1648 if (!this_trace
->metadata
->tc
->is_uuid_set
) {
1649 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1651 "Multiple traces given, but a trace does not have a UUID: path={}",
1656 if (bt_uuid_compare(first_trace_uuid
, this_trace_uuid
) != 0) {
1657 char first_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1658 char this_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1660 bt_uuid_to_str(first_trace_uuid
, first_trace_uuid_str
);
1661 bt_uuid_to_str(this_trace_uuid
, this_trace_uuid_str
);
1663 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1664 "Multiple traces given, but UUIDs don't match: "
1665 "first-trace-uuid={}, first-trace-path={}, "
1666 "trace-uuid={}, trace-path={}",
1667 first_trace_uuid_str
, first_trace
->path
,
1668 this_trace_uuid_str
, this_trace
->path
);
1673 ret
= merge_ctf_fs_traces(std::move(traces
), ctf_fs
->trace
);
1675 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1676 "Failed to merge traces with the same UUID.");
1680 /* Just one trace, it may or may not have a UUID, both are fine. */
1681 ctf_fs
->trace
= std::move(traces
[0]);
1684 ret
= fix_packet_index_tracer_bugs(ctf_fs
->trace
.get());
1686 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to fix packet index tracer bugs.");
1690 * Sort data stream file groups by first data stream file info
1691 * path to get a deterministic order. This order influences the
1692 * order of the output ports. It also influences the order of
1693 * the automatic stream IDs if the trace's packet headers do not
1694 * contain a `stream_instance_id` field, in which case the data
1695 * stream file to stream ID association is always the same,
1696 * whatever the build and the system.
1698 * Having a deterministic order here can help debugging and
1701 std::sort(ctf_fs
->trace
->ds_file_groups
.begin(), ctf_fs
->trace
->ds_file_groups
.end(),
1702 compare_ds_file_groups_by_first_path
);
1709 g_ptr_array_free(paths
, TRUE
);
1715 static GString
*get_stream_instance_unique_name(struct ctf_fs_ds_file_group
*ds_file_group
)
1718 struct ctf_fs_ds_file_info
*ds_file_info
;
1720 name
= g_string_new(NULL
);
1726 * If there's more than one stream file in the stream file
1727 * group, the first (earliest) stream file's path is used as
1728 * the stream's unique name.
1730 BT_ASSERT(!ds_file_group
->ds_file_infos
.empty());
1731 ds_file_info
= ds_file_group
->ds_file_infos
[0].get();
1732 g_string_assign(name
, ds_file_info
->path
.c_str());
1738 /* Create the IR stream objects for ctf_fs_trace. */
1740 static int create_streams_for_trace(struct ctf_fs_trace
*ctf_fs_trace
)
1743 GString
*name
= NULL
;
1745 for (const auto& ds_file_group
: ctf_fs_trace
->ds_file_groups
) {
1746 name
= get_stream_instance_unique_name(ds_file_group
.get());
1752 BT_ASSERT(ds_file_group
->sc
->ir_sc
);
1753 BT_ASSERT(ctf_fs_trace
->trace
);
1757 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
1758 /* No stream ID: use 0 */
1760 bt_stream_create_with_id(ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
->libObjPtr(),
1761 ctf_fs_trace
->next_stream_id
);
1762 ctf_fs_trace
->next_stream_id
++;
1764 /* Specific stream ID */
1766 bt_stream_create_with_id(ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
->libObjPtr(),
1767 (uint64_t) ds_file_group
->stream_id
);
1771 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1772 "Cannot create stream for DS file group: "
1773 "addr={}, stream-name=\"{}\"",
1774 fmt::ptr(ds_file_group
), name
->str
);
1778 ds_file_group
->stream
= bt2::Stream::Shared::createWithoutRef(stream
);
1780 ret
= bt_stream_set_name(ds_file_group
->stream
->libObjPtr(), name
->str
);
1782 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1783 "Cannot set stream's name: "
1784 "addr={}, stream-name=\"{}\"",
1785 fmt::ptr(ds_file_group
->stream
->libObjPtr()), name
->str
);
1789 g_string_free(name
, TRUE
);
1802 g_string_free(name
, TRUE
);
1807 static const bt_param_validation_value_descr inputs_elem_descr
=
1808 bt_param_validation_value_descr::makeString();
1810 static bt_param_validation_map_value_entry_descr fs_params_entries_descr
[] = {
1811 {"inputs", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
1812 bt_param_validation_value_descr::makeArray(1, BT_PARAM_VALIDATION_INFINITE
,
1813 inputs_elem_descr
)},
1814 {"trace-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1815 bt_param_validation_value_descr::makeString()},
1816 {"clock-class-offset-s", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1817 bt_param_validation_value_descr::makeSignedInteger()},
1818 {"clock-class-offset-ns", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1819 bt_param_validation_value_descr::makeSignedInteger()},
1820 {"force-clock-class-origin-unix-epoch", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1821 bt_param_validation_value_descr::makeBool()},
1822 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
1824 bool read_src_fs_parameters(const bt_value
*params
, const bt_value
**inputs
,
1825 const bt_value
**trace_name
, struct ctf_fs_component
*ctf_fs
)
1828 const bt_value
*value
;
1829 enum bt_param_validation_status validate_value_status
;
1830 gchar
*error
= NULL
;
1832 validate_value_status
= bt_param_validation_validate(params
, fs_params_entries_descr
, &error
);
1833 if (validate_value_status
!= BT_PARAM_VALIDATION_STATUS_OK
) {
1834 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "{}", error
);
1839 /* inputs parameter */
1840 *inputs
= bt_value_map_borrow_entry_value_const(params
, "inputs");
1842 /* clock-class-offset-s parameter */
1843 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-s");
1845 ctf_fs
->clkClsCfg
.offsetSec
= bt_value_integer_signed_get(value
);
1848 /* clock-class-offset-ns parameter */
1849 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-ns");
1851 ctf_fs
->clkClsCfg
.offsetNanoSec
= bt_value_integer_signed_get(value
);
1854 /* force-clock-class-origin-unix-epoch parameter */
1855 value
= bt_value_map_borrow_entry_value_const(params
, "force-clock-class-origin-unix-epoch");
1857 ctf_fs
->clkClsCfg
.forceOriginIsUnixEpoch
= bt_value_bool_get(value
);
1860 /* trace-name parameter */
1861 *trace_name
= bt_value_map_borrow_entry_value_const(params
, "trace-name");
1870 static ctf_fs_component::UP
ctf_fs_create(const bt_value
*params
,
1871 bt_self_component_source
*self_comp_src
)
1873 const bt_value
*inputs_value
;
1874 const bt_value
*trace_name_value
;
1875 bt_self_component
*self_comp
= bt_self_component_source_as_self_component(self_comp_src
);
1877 ctf_fs_component::UP ctf_fs
= ctf_fs_component_create(
1878 bt2c::Logger
{bt2::SelfSourceComponent
{self_comp_src
}, "PLUGIN/SRC.CTF.FS/COMP"});
1883 if (!read_src_fs_parameters(params
, &inputs_value
, &trace_name_value
, ctf_fs
.get())) {
1887 if (ctf_fs_component_create_ctf_fs_trace(ctf_fs
.get(), inputs_value
, trace_name_value
,
1892 if (create_streams_for_trace(ctf_fs
->trace
.get())) {
1896 if (create_ports_for_trace(ctf_fs
.get(), ctf_fs
->trace
.get(), self_comp_src
)) {
1903 bt_component_class_initialize_method_status
ctf_fs_init(bt_self_component_source
*self_comp_src
,
1904 bt_self_component_source_configuration
*,
1905 const bt_value
*params
, void *)
1908 bt_component_class_initialize_method_status ret
=
1909 BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
1911 ctf_fs_component::UP ctf_fs
= ctf_fs_create(params
, self_comp_src
);
1913 ret
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1916 bt_self_component_set_data(bt_self_component_source_as_self_component(self_comp_src
),
1919 } catch (const std::bad_alloc
&) {
1920 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1921 } catch (const bt2::Error
&) {
1922 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1926 bt_component_class_query_method_status
ctf_fs_query(bt_self_component_class_source
*comp_class_src
,
1927 bt_private_query_executor
*priv_query_exec
,
1928 const char *object
, const bt_value
*params
,
1929 __attribute__((unused
)) void *method_data
,
1930 const bt_value
**result
)
1933 bt2c::Logger logger
{bt2::SelfComponentClass
{comp_class_src
},
1934 bt2::PrivateQueryExecutor
{priv_query_exec
},
1935 "PLUGIN/SRC.CTF.FS/QUERY"};
1936 bt2::ConstMapValue
paramsObj(params
);
1937 bt2::Value::Shared resultObj
;
1939 if (strcmp(object
, "metadata-info") == 0) {
1940 resultObj
= metadata_info_query(paramsObj
, logger
);
1941 } else if (strcmp(object
, "babeltrace.trace-infos") == 0) {
1942 resultObj
= trace_infos_query(paramsObj
, logger
);
1943 } else if (!strcmp(object
, "babeltrace.support-info")) {
1944 resultObj
= support_info_query(paramsObj
, logger
);
1946 BT_CPPLOGE_SPEC(logger
, "Unknown query object `{}`", object
);
1947 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;
1950 *result
= resultObj
.release().libObjPtr();
1952 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
1953 } catch (const std::bad_alloc
&) {
1954 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
1955 } catch (const bt2::Error
&) {
1956 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;