2 * SPDX-License-Identifier: MIT
4 * Copyright 2015-2017 Philippe Proulx <pproulx@efficios.com>
5 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 * Babeltrace CTF file system Reader Component
13 #include <babeltrace2/babeltrace.h>
15 #include "common/assert.h"
16 #include "common/common.h"
17 #include "common/uuid.h"
18 #include "cpp-common/bt2s/make-unique.hpp"
20 #include "plugins/common/param-validation/param-validation.h"
22 #include "../common/src/metadata/tsdl/ctf-meta-configure-ir-trace.hpp"
23 #include "../common/src/msg-iter/msg-iter.hpp"
24 #include "data-stream-file.hpp"
27 #include "metadata.hpp"
38 static void ctf_fs_msg_iter_data_destroy(struct ctf_fs_msg_iter_data
*msg_iter_data
)
44 if (msg_iter_data
->msg_iter
) {
45 ctf_msg_iter_destroy(msg_iter_data
->msg_iter
);
48 if (msg_iter_data
->msg_iter_medops_data
) {
49 ctf_fs_ds_group_medops_data_destroy(msg_iter_data
->msg_iter_medops_data
);
55 static bt_message_iterator_class_next_method_status
56 ctf_fs_iterator_next_one(struct ctf_fs_msg_iter_data
*msg_iter_data
, const bt_message
**out_msg
)
58 bt_message_iterator_class_next_method_status status
;
59 enum ctf_msg_iter_status msg_iter_status
;
61 msg_iter_status
= ctf_msg_iter_get_next_message(msg_iter_data
->msg_iter
, out_msg
);
63 switch (msg_iter_status
) {
64 case CTF_MSG_ITER_STATUS_OK
:
65 /* Cool, message has been written to *out_msg. */
66 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
69 case CTF_MSG_ITER_STATUS_EOF
:
70 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END
;
73 case CTF_MSG_ITER_STATUS_AGAIN
:
75 * Should not make it this far as this is
76 * medium-specific; there is nothing for the user to do
77 * and it should have been handled upstream.
81 case CTF_MSG_ITER_STATUS_ERROR
:
82 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
83 "Failed to get next message from CTF message iterator.");
84 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
87 case CTF_MSG_ITER_STATUS_MEMORY_ERROR
:
88 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
89 "Failed to get next message from CTF message iterator.");
90 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
100 bt_message_iterator_class_next_method_status
101 ctf_fs_iterator_next(bt_self_message_iterator
*iterator
, bt_message_array_const msgs
,
102 uint64_t capacity
, uint64_t *count
)
105 bt_message_iterator_class_next_method_status status
;
106 struct ctf_fs_msg_iter_data
*msg_iter_data
=
107 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(iterator
);
110 if (G_UNLIKELY(msg_iter_data
->next_saved_error
)) {
112 * Last time we were called, we hit an error but had some
113 * messages to deliver, so we stashed the error here. Return
116 BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(msg_iter_data
->next_saved_error
);
117 status
= msg_iter_data
->next_saved_status
;
122 status
= ctf_fs_iterator_next_one(msg_iter_data
, &msgs
[i
]);
123 if (status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
) {
126 } while (i
< capacity
&& status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
);
130 * Even if ctf_fs_iterator_next_one() returned something
131 * else than BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK, we
132 * accumulated message objects in the output
133 * message array, so we need to return
134 * BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK so that they are
135 * transferred to downstream. This other status occurs
136 * again the next time muxer_msg_iter_do_next() is
137 * called, possibly without any accumulated
138 * message, in which case we'll return it.
142 * Save this error for the next _next call. Assume that
143 * this component always appends error causes when
144 * returning an error status code, which will cause the
145 * current thread error to be non-NULL.
147 msg_iter_data
->next_saved_error
= bt_current_thread_take_error();
148 BT_ASSERT(msg_iter_data
->next_saved_error
);
149 msg_iter_data
->next_saved_status
= status
;
153 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
159 } catch (const std::bad_alloc
&) {
160 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
161 } catch (const bt2::Error
&) {
162 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
166 bt_message_iterator_class_seek_beginning_method_status
167 ctf_fs_iterator_seek_beginning(bt_self_message_iterator
*it
)
170 struct ctf_fs_msg_iter_data
*msg_iter_data
=
171 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(it
);
173 BT_ASSERT(msg_iter_data
);
175 ctf_msg_iter_reset(msg_iter_data
->msg_iter
);
176 ctf_fs_ds_group_medops_data_reset(msg_iter_data
->msg_iter_medops_data
);
178 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_OK
;
179 } catch (const std::bad_alloc
&) {
180 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_MEMORY_ERROR
;
181 } catch (const bt2::Error
&) {
182 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_ERROR
;
186 void ctf_fs_iterator_finalize(bt_self_message_iterator
*it
)
188 ctf_fs_msg_iter_data_destroy(
189 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(it
));
192 static bt_message_iterator_class_initialize_method_status
193 ctf_msg_iter_medium_status_to_msg_iter_initialize_status(enum ctf_msg_iter_medium_status status
)
196 case CTF_MSG_ITER_MEDIUM_STATUS_EOF
:
197 case CTF_MSG_ITER_MEDIUM_STATUS_AGAIN
:
198 case CTF_MSG_ITER_MEDIUM_STATUS_ERROR
:
199 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
200 case CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
:
201 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
202 case CTF_MSG_ITER_MEDIUM_STATUS_OK
:
203 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
209 bt_message_iterator_class_initialize_method_status
210 ctf_fs_iterator_init(bt_self_message_iterator
*self_msg_iter
,
211 bt_self_message_iterator_configuration
*config
,
212 bt_self_component_port_output
*self_port
)
215 struct ctf_fs_port_data
*port_data
;
216 bt_message_iterator_class_initialize_method_status status
;
217 enum ctf_msg_iter_medium_status medium_status
;
219 port_data
= (struct ctf_fs_port_data
*) bt_self_component_port_get_data(
220 bt_self_component_port_output_as_self_component_port(self_port
));
221 BT_ASSERT(port_data
);
223 ctf_fs_msg_iter_data
*msg_iter_data
= new ctf_fs_msg_iter_data
{self_msg_iter
};
224 msg_iter_data
->ds_file_group
= port_data
->ds_file_group
;
226 medium_status
= ctf_fs_ds_group_medops_data_create(msg_iter_data
->ds_file_group
,
227 self_msg_iter
, msg_iter_data
->logger
,
228 &msg_iter_data
->msg_iter_medops_data
);
229 BT_ASSERT(medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_OK
||
230 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_ERROR
||
231 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
);
232 if (medium_status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
233 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
234 "Failed to create ctf_fs_ds_group_medops");
235 status
= ctf_msg_iter_medium_status_to_msg_iter_initialize_status(medium_status
);
239 msg_iter_data
->msg_iter
= ctf_msg_iter_create(
240 msg_iter_data
->ds_file_group
->ctf_fs_trace
->metadata
->tc
,
241 bt_common_get_page_size(static_cast<int>(msg_iter_data
->logger
.level())) * 8,
242 ctf_fs_ds_group_medops
, msg_iter_data
->msg_iter_medops_data
, self_msg_iter
,
243 msg_iter_data
->logger
);
244 if (!msg_iter_data
->msg_iter
) {
245 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
246 "Cannot create a CTF message iterator.");
247 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
252 * This iterator can seek forward if its stream class has a default
255 if (msg_iter_data
->ds_file_group
->sc
->default_clock_class
) {
256 bt_self_message_iterator_configuration_set_can_seek_forward(config
, true);
259 bt_self_message_iterator_set_data(self_msg_iter
, msg_iter_data
);
260 msg_iter_data
= NULL
;
262 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
266 bt_self_message_iterator_set_data(self_msg_iter
, NULL
);
269 ctf_fs_msg_iter_data_destroy(msg_iter_data
);
271 } catch (const std::bad_alloc
&) {
272 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
273 } catch (const bt2::Error
&) {
274 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
278 static void ctf_fs_trace_destroy(struct ctf_fs_trace
*ctf_fs_trace
)
284 BT_TRACE_PUT_REF_AND_RESET(ctf_fs_trace
->trace
);
286 if (ctf_fs_trace
->path
) {
287 g_string_free(ctf_fs_trace
->path
, TRUE
);
290 if (ctf_fs_trace
->metadata
) {
291 ctf_fs_metadata_fini(ctf_fs_trace
->metadata
);
292 delete ctf_fs_trace
->metadata
;
298 void ctf_fs_trace_deleter::operator()(ctf_fs_trace
* const trace
) noexcept
300 ctf_fs_trace_destroy(trace
);
303 void ctf_fs_destroy(struct ctf_fs_component
*ctf_fs
)
312 void ctf_fs_component_deleter::operator()(ctf_fs_component
*comp
)
314 ctf_fs_destroy(comp
);
317 ctf_fs_component::UP
ctf_fs_component_create(const bt2c::Logger
& parentLogger
)
319 return ctf_fs_component::UP
{new ctf_fs_component
{parentLogger
}};
322 void ctf_fs_finalize(bt_self_component_source
*component
)
324 ctf_fs_destroy((struct ctf_fs_component
*) bt_self_component_get_data(
325 bt_self_component_source_as_self_component(component
)));
328 bt2c::GCharUP
ctf_fs_make_port_name(struct ctf_fs_ds_file_group
*ds_file_group
)
330 GString
*name
= g_string_new(NULL
);
333 * The unique port name is generated by concatenating unique identifiers
341 /* For the trace, use the uuid if present, else the path. */
342 if (ds_file_group
->ctf_fs_trace
->metadata
->tc
->is_uuid_set
) {
343 char uuid_str
[BT_UUID_STR_LEN
+ 1];
345 bt_uuid_to_str(ds_file_group
->ctf_fs_trace
->metadata
->tc
->uuid
, uuid_str
);
346 g_string_assign(name
, uuid_str
);
348 g_string_assign(name
, ds_file_group
->ctf_fs_trace
->path
->str
);
352 * For the stream class, use the id if present. We can omit this field
353 * otherwise, as there will only be a single stream class.
355 if (ds_file_group
->sc
->id
!= UINT64_C(-1)) {
356 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->sc
->id
);
359 /* For the stream, use the id if present, else, use the path. */
360 if (ds_file_group
->stream_id
!= UINT64_C(-1)) {
361 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->stream_id
);
363 BT_ASSERT(ds_file_group
->ds_file_infos
.size() == 1);
364 const auto& ds_file_info
= *ds_file_group
->ds_file_infos
[0];
365 g_string_append_printf(name
, " | %s", ds_file_info
.path
.c_str());
368 return bt2c::GCharUP
{g_string_free(name
, FALSE
)};
371 static int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
372 struct ctf_fs_ds_file_group
*ds_file_group
,
373 bt_self_component_source
*self_comp_src
)
376 ctf_fs_port_data::UP port_data
;
378 bt2c::GCharUP port_name
= ctf_fs_make_port_name(ds_file_group
);
383 BT_CPPLOGI_SPEC(ctf_fs
->logger
, "Creating one port named `{}`", port_name
.get());
385 /* Create output port for this file */
386 port_data
= bt2s::make_unique
<ctf_fs_port_data
>();
387 port_data
->ctf_fs
= ctf_fs
;
388 port_data
->ds_file_group
= ds_file_group
;
389 ret
= bt_self_component_source_add_output_port(self_comp_src
, port_name
.get(), port_data
.get(),
395 ctf_fs
->port_data
.emplace_back(std::move(port_data
));
405 static int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
406 struct ctf_fs_trace
*ctf_fs_trace
,
407 bt_self_component_source
*self_comp_src
)
411 /* Create one output port for each stream file group */
412 for (const auto& ds_file_group
: ctf_fs_trace
->ds_file_groups
) {
413 ret
= create_one_port_for_trace(ctf_fs
, ds_file_group
.get(), self_comp_src
);
415 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create output port.");
425 * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right
426 * place to keep it sorted.
429 static void ds_file_group_insert_ds_file_info_sorted(struct ctf_fs_ds_file_group
*ds_file_group
,
430 ctf_fs_ds_file_info::UP ds_file_info
)
432 /* Find the spot where to insert this ds_file_info. */
433 auto it
= ds_file_group
->ds_file_infos
.begin();
435 for (; it
!= ds_file_group
->ds_file_infos
.end(); ++it
) {
436 const ctf_fs_ds_file_info
& other_ds_file_info
= **it
;
438 if (ds_file_info
->begin_ns
< other_ds_file_info
.begin_ns
) {
443 ds_file_group
->ds_file_infos
.insert(it
, std::move(ds_file_info
));
446 static bool ds_index_entries_equal(const struct ctf_fs_ds_index_entry
*left
,
447 const struct ctf_fs_ds_index_entry
*right
)
449 if (left
->packetSize
!= right
->packetSize
) {
453 if (left
->timestamp_begin
!= right
->timestamp_begin
) {
457 if (left
->timestamp_end
!= right
->timestamp_end
) {
461 if (left
->packet_seq_num
!= right
->packet_seq_num
) {
469 * Insert `entry` into `index`, without duplication.
471 * The entry is inserted only if there isn't an identical entry already.
473 * In any case, the ownership of `entry` is transferred to this function. So if
474 * the entry is not inserted, it is freed.
477 static void ds_index_insert_ds_index_entry_sorted(struct ctf_fs_ds_index
*index
,
478 ctf_fs_ds_index_entry::UP entry
)
480 /* Find the spot where to insert this index entry. */
481 auto otherEntry
= index
->entries
.begin();
482 for (; otherEntry
!= index
->entries
.end(); ++otherEntry
) {
483 if (entry
->timestamp_begin_ns
<= (*otherEntry
)->timestamp_begin_ns
) {
489 * Insert the entry only if a duplicate doesn't already exist.
491 * There can be duplicate packets if reading multiple overlapping
492 * snapshots of the same trace. We then want the index to contain
493 * a reference to only one copy of that packet.
495 if (otherEntry
== index
->entries
.end() ||
496 !ds_index_entries_equal(entry
.get(), otherEntry
->get())) {
497 index
->entries
.insert(otherEntry
, std::move(entry
));
501 static void merge_ctf_fs_ds_indexes(struct ctf_fs_ds_index
*dest
, ctf_fs_ds_index::UP src
)
503 for (auto& entry
: src
->entries
) {
504 ds_index_insert_ds_index_entry_sorted(dest
, std::move(entry
));
508 static int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
, const char *path
)
510 int64_t stream_instance_id
= -1;
511 int64_t begin_ns
= -1;
512 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
513 ctf_fs_ds_file_group::UP new_ds_file_group
;
515 struct ctf_fs_ds_file
*ds_file
= NULL
;
516 ctf_fs_ds_file_info::UP ds_file_info
;
517 ctf_fs_ds_index::UP index
;
518 struct ctf_msg_iter
*msg_iter
= NULL
;
519 struct ctf_stream_class
*sc
= NULL
;
520 struct ctf_msg_iter_packet_properties props
;
523 * Create a temporary ds_file to read some properties about the data
527 ctf_fs_ds_file_create(ctf_fs_trace
, bt2::Stream::Shared
{}, path
, ctf_fs_trace
->logger
);
532 /* Create a temporary iterator to read the ds_file. */
533 msg_iter
= ctf_msg_iter_create(
534 ctf_fs_trace
->metadata
->tc
,
535 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
536 ctf_fs_ds_file_medops
, ds_file
, nullptr, ctf_fs_trace
->logger
);
538 BT_CPPLOGE_STR_SPEC(ctf_fs_trace
->logger
, "Cannot create a CTF message iterator.");
542 ctf_msg_iter_set_dry_run(msg_iter
, true);
544 ret
= ctf_msg_iter_get_packet_properties(msg_iter
, &props
);
546 BT_CPPLOGE_APPEND_CAUSE_SPEC(
547 ctf_fs_trace
->logger
,
548 "Cannot get stream file's first packet's header and context fields (`{}`).", path
);
552 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
, props
.stream_class_id
);
554 stream_instance_id
= props
.data_stream_id
;
556 if (props
.snapshots
.beginning_clock
!= UINT64_C(-1)) {
557 BT_ASSERT(sc
->default_clock_class
);
558 ret
= bt_util_clock_cycles_to_ns_from_origin(
559 props
.snapshots
.beginning_clock
, sc
->default_clock_class
->frequency
,
560 sc
->default_clock_class
->offset_seconds
, sc
->default_clock_class
->offset_cycles
,
563 BT_CPPLOGE_APPEND_CAUSE_SPEC(
564 ctf_fs_trace
->logger
,
565 "Cannot convert clock cycles to nanoseconds from origin (`{}`).", path
);
570 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
);
575 index
= ctf_fs_ds_file_build_index(ds_file
, ds_file_info
.get(), msg_iter
);
577 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to index CTF stream file \'{}\'",
578 ds_file
->file
->path
);
582 if (begin_ns
== -1) {
584 * No beginning timestamp to sort the stream files
585 * within a stream file group, so consider that this
586 * file must be the only one within its group.
588 stream_instance_id
= -1;
591 if (stream_instance_id
== -1) {
593 * No stream instance ID or no beginning timestamp:
594 * create a unique stream file group for this stream
595 * file because, even if there's a stream instance ID,
596 * there's no timestamp to order the file within its
600 ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, UINT64_C(-1), std::move(index
));
602 if (!new_ds_file_group
) {
606 ds_file_group_insert_ds_file_info_sorted(new_ds_file_group
.get(), std::move(ds_file_info
));
607 ctf_fs_trace
->ds_file_groups
.emplace_back(std::move(new_ds_file_group
));
611 BT_ASSERT(stream_instance_id
!= -1);
612 BT_ASSERT(begin_ns
!= -1);
614 /* Find an existing stream file group with this ID */
615 for (const auto& candidate
: ctf_fs_trace
->ds_file_groups
) {
616 if (candidate
->sc
== sc
&& candidate
->stream_id
== stream_instance_id
) {
617 ds_file_group
= candidate
.get();
622 if (!ds_file_group
) {
624 ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, stream_instance_id
, std::move(index
));
625 if (!new_ds_file_group
) {
629 ds_file_group
= new_ds_file_group
.get();
630 ctf_fs_trace
->ds_file_groups
.emplace_back(std::move(new_ds_file_group
));
632 merge_ctf_fs_ds_indexes(ds_file_group
->index
.get(), std::move(index
));
635 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, std::move(ds_file_info
));
643 ctf_fs_ds_file_destroy(ds_file
);
646 ctf_msg_iter_destroy(msg_iter
);
652 static int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
655 const char *basename
;
656 GError
*error
= NULL
;
659 /* Check each file in the path directory, except specific ones */
660 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
662 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
663 "Cannot open directory `{}`: {} (code {})",
664 ctf_fs_trace
->path
->str
, error
->message
, error
->code
);
668 while ((basename
= g_dir_read_name(dir
))) {
669 if (strcmp(basename
, CTF_FS_METADATA_FILENAME
) == 0) {
670 /* Ignore the metadata stream. */
671 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
672 "Ignoring metadata file `{}" G_DIR_SEPARATOR_S
"{}`",
673 ctf_fs_trace
->path
->str
, basename
);
677 if (basename
[0] == '.') {
678 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
679 "Ignoring hidden file `{}" G_DIR_SEPARATOR_S
"{}`",
680 ctf_fs_trace
->path
->str
, basename
);
684 /* Create the file. */
685 const auto file
= ctf_fs_file_create(ctf_fs_trace
->logger
);
687 BT_CPPLOGE_APPEND_CAUSE_SPEC(
688 ctf_fs_trace
->logger
,
689 "Cannot create stream file object for file `{}" G_DIR_SEPARATOR_S
"{}`",
690 ctf_fs_trace
->path
->str
, basename
);
694 /* Create full path string. */
695 file
->path
= fmt::format("{}" G_DIR_SEPARATOR_S
"{}", ctf_fs_trace
->path
->str
, basename
);
697 if (!g_file_test(file
->path
.c_str(), G_FILE_TEST_IS_REGULAR
)) {
698 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring non-regular file `{}`", file
->path
);
702 ret
= ctf_fs_file_open(file
.get(), "rb");
704 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Cannot open stream file `{}`",
709 if (file
->size
== 0) {
710 /* Skip empty stream. */
711 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring empty file `{}`", file
->path
);
715 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
, file
->path
.c_str());
717 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
718 "Cannot add stream file `{}` to stream file group",
742 static int set_trace_name(bt_trace
*trace
, const char *name_suffix
, const bt2c::Logger
& logger
)
748 name
= g_string_new(NULL
);
750 BT_CPPLOGE_STR_SPEC(logger
, "Failed to allocate a GString.");
756 * Check if we have a trace environment string value named `hostname`.
757 * If so, use it as the trace name's prefix.
759 val
= bt_trace_borrow_environment_entry_value_by_name_const(trace
, "hostname");
760 if (val
&& bt_value_is_string(val
)) {
761 g_string_append(name
, bt_value_string_get(val
));
764 g_string_append_c(name
, G_DIR_SEPARATOR
);
769 g_string_append(name
, name_suffix
);
772 ret
= bt_trace_set_name(trace
, name
->str
);
781 g_string_free(name
, TRUE
);
787 static ctf_fs_trace::UP
ctf_fs_trace_create(const char *path
, const char *name
,
788 const ctf::src::ClkClsCfg
& clkClsCfg
,
789 bt_self_component
*selfComp
,
790 const bt2c::Logger
& parentLogger
)
794 ctf_fs_trace::UP ctf_fs_trace
{new struct ctf_fs_trace(parentLogger
)};
795 ctf_fs_trace
->path
= g_string_new(path
);
796 if (!ctf_fs_trace
->path
) {
800 ctf_fs_trace
->metadata
= new ctf_fs_metadata
;
801 ctf_fs_metadata_init(ctf_fs_trace
->metadata
);
803 ret
= ctf_fs_metadata_set_trace_class(selfComp
, ctf_fs_trace
.get(), clkClsCfg
);
808 if (ctf_fs_trace
->metadata
->trace_class
) {
809 ctf_fs_trace
->trace
= bt_trace_create(ctf_fs_trace
->metadata
->trace_class
);
810 if (!ctf_fs_trace
->trace
) {
815 if (ctf_fs_trace
->trace
) {
816 ret
= ctf_trace_class_configure_ir_trace(ctf_fs_trace
->metadata
->tc
, ctf_fs_trace
->trace
);
821 ret
= set_trace_name(ctf_fs_trace
->trace
, name
, ctf_fs_trace
->logger
);
827 ret
= create_ds_file_groups(ctf_fs_trace
.get());
835 ctf_fs_trace
.reset();
841 static int path_is_ctf_trace(const char *path
)
843 GString
*metadata_path
= g_string_new(NULL
);
846 if (!metadata_path
) {
851 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
853 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
859 g_string_free(metadata_path
, TRUE
);
863 /* Helper for ctf_fs_component_create_ctf_fs_trace, to handle a single path. */
865 static int ctf_fs_component_create_ctf_fs_trace_one_path(struct ctf_fs_component
*ctf_fs
,
866 const char *path_param
,
867 const char *trace_name
,
868 std::vector
<ctf_fs_trace::UP
>& traces
,
869 bt_self_component
*selfComp
)
871 ctf_fs_trace::UP ctf_fs_trace
;
875 norm_path
= bt_common_normalize_path(path_param
, NULL
);
877 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to normalize path: `{}`.", path_param
);
881 ret
= path_is_ctf_trace(norm_path
->str
);
883 BT_CPPLOGE_APPEND_CAUSE_SPEC(
884 ctf_fs
->logger
, "Failed to check if path is a CTF trace: path={}", norm_path
->str
);
886 } else if (ret
== 0) {
887 BT_CPPLOGE_APPEND_CAUSE_SPEC(
888 ctf_fs
->logger
, "Path is not a CTF trace (does not contain a metadata file): `{}`.",
893 // FIXME: Remove or ifdef for __MINGW32__
894 if (strcmp(norm_path
->str
, "/") == 0) {
895 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Opening a trace in `/` is not supported.");
900 ctf_fs_trace
= ctf_fs_trace_create(norm_path
->str
, trace_name
, ctf_fs
->clkClsCfg
, selfComp
,
903 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create trace for `{}`.",
908 traces
.emplace_back(std::move(ctf_fs_trace
));
918 g_string_free(norm_path
, TRUE
);
925 * Count the number of stream and event classes defined by this trace's metadata.
927 * This is used to determine which metadata is the "latest", out of multiple
928 * traces sharing the same UUID. It is assumed that amongst all these metadatas,
929 * a bigger metadata is a superset of a smaller metadata. Therefore, it is
930 * enough to just count the classes.
933 static unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace
*trace
)
935 unsigned int num
= trace
->metadata
->tc
->stream_classes
->len
;
938 for (i
= 0; i
< trace
->metadata
->tc
->stream_classes
->len
; i
++) {
939 struct ctf_stream_class
*sc
=
940 (struct ctf_stream_class
*) trace
->metadata
->tc
->stream_classes
->pdata
[i
];
941 num
+= sc
->event_classes
->len
;
948 * Merge the src ds_file_group into dest. This consists of merging their
949 * ds_file_infos, making sure to keep the result sorted.
952 static void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group
*dest
,
953 ctf_fs_ds_file_group::UP src
)
955 for (auto& ds_file_info
: src
->ds_file_infos
) {
956 ds_file_group_insert_ds_file_info_sorted(dest
, std::move(ds_file_info
));
959 /* Merge both indexes. */
960 merge_ctf_fs_ds_indexes(dest
->index
.get(), std::move(src
->index
));
963 /* Merge src_trace's data stream file groups into dest_trace's. */
965 static int merge_matching_ctf_fs_ds_file_groups(struct ctf_fs_trace
*dest_trace
,
966 ctf_fs_trace::UP src_trace
)
968 std::vector
<ctf_fs_ds_file_group::UP
>& dest
= dest_trace
->ds_file_groups
;
969 std::vector
<ctf_fs_ds_file_group::UP
>& src
= src_trace
->ds_file_groups
;
973 * Save the initial length of dest: we only want to check against the
974 * original elements in the inner loop.
976 size_t dest_len
= dest
.size();
978 for (auto& src_group
: src
) {
979 struct ctf_fs_ds_file_group
*dest_group
= NULL
;
981 /* A stream instance without ID can't match a stream in the other trace. */
982 if (src_group
->stream_id
!= -1) {
983 /* Let's search for a matching ds_file_group in the destination. */
984 for (size_t d_i
= 0; d_i
< dest_len
; ++d_i
) {
985 ctf_fs_ds_file_group
*candidate_dest
= dest
[d_i
].get();
987 /* Can't match a stream instance without ID. */
988 if (candidate_dest
->stream_id
== -1) {
993 * If the two groups have the same stream instance id
994 * and belong to the same stream class (stream instance
995 * ids are per-stream class), they represent the same
998 if (candidate_dest
->stream_id
!= src_group
->stream_id
||
999 candidate_dest
->sc
->id
!= src_group
->sc
->id
) {
1003 dest_group
= candidate_dest
;
1009 * Didn't find a friend in dest to merge our src_group into?
1010 * Create a new empty one. This can happen if a stream was
1011 * active in the source trace chunk but not in the destination
1015 struct ctf_stream_class
*sc
;
1017 sc
= ctf_trace_class_borrow_stream_class_by_id(dest_trace
->metadata
->tc
,
1021 auto index
= ctf_fs_ds_index_create();
1027 auto new_dest_group
=
1028 ctf_fs_ds_file_group_create(dest_trace
, sc
, src_group
->stream_id
, std::move(index
));
1030 if (!new_dest_group
) {
1035 dest_group
= new_dest_group
.get();
1036 dest_trace
->ds_file_groups
.emplace_back(std::move(new_dest_group
));
1039 BT_ASSERT(dest_group
);
1040 merge_ctf_fs_ds_file_groups(dest_group
, std::move(src_group
));
1048 * Collapse the given traces, which must all share the same UUID, in a single
1051 * The trace with the most expansive metadata is chosen and all other traces
1052 * are merged into that one. On return, the elements of `traces` are nullptr
1053 * and the merged trace is placed in `out_trace`.
1056 static int merge_ctf_fs_traces(std::vector
<ctf_fs_trace::UP
> traces
, ctf_fs_trace::UP
& out_trace
)
1058 unsigned int winner_count
;
1059 struct ctf_fs_trace
*winner
;
1063 BT_ASSERT(traces
.size() >= 2);
1065 winner_count
= metadata_count_stream_and_event_classes(traces
[0].get());
1066 winner
= traces
[0].get();
1069 /* Find the trace with the largest metadata. */
1070 for (i
= 1; i
< traces
.size(); i
++) {
1071 ctf_fs_trace
*candidate
= traces
[i
].get();
1072 unsigned int candidate_count
;
1074 /* A bit of sanity check. */
1075 BT_ASSERT(bt_uuid_compare(winner
->metadata
->tc
->uuid
, candidate
->metadata
->tc
->uuid
) == 0);
1077 candidate_count
= metadata_count_stream_and_event_classes(candidate
);
1079 if (candidate_count
> winner_count
) {
1080 winner_count
= candidate_count
;
1086 /* Merge all the other traces in the winning trace. */
1087 for (ctf_fs_trace::UP
& trace
: traces
) {
1088 /* Don't merge the winner into itself. */
1089 if (trace
.get() == winner
) {
1093 /* Merge trace's data stream file groups into winner's. */
1094 ret
= merge_matching_ctf_fs_ds_file_groups(winner
, std::move(trace
));
1101 * Move the winner out of the array, into `*out_trace`.
1103 out_trace
= std::move(traces
[winner_i
]);
1115 static int decode_clock_snapshot_after_event(struct ctf_fs_trace
*ctf_fs_trace
,
1116 struct ctf_clock_class
*default_cc
,
1117 struct ctf_fs_ds_index_entry
*index_entry
,
1118 enum target_event target_event
, uint64_t *cs
,
1121 enum ctf_msg_iter_status iter_status
= CTF_MSG_ITER_STATUS_OK
;
1122 struct ctf_fs_ds_file
*ds_file
= NULL
;
1123 struct ctf_msg_iter
*msg_iter
= NULL
;
1126 BT_ASSERT(ctf_fs_trace
);
1127 BT_ASSERT(index_entry
);
1128 BT_ASSERT(index_entry
->path
);
1130 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, bt2::Stream::Shared
{}, index_entry
->path
,
1131 ctf_fs_trace
->logger
);
1133 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to create a ctf_fs_ds_file");
1138 BT_ASSERT(ctf_fs_trace
->metadata
);
1139 BT_ASSERT(ctf_fs_trace
->metadata
->tc
);
1141 msg_iter
= ctf_msg_iter_create(
1142 ctf_fs_trace
->metadata
->tc
,
1143 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
1144 ctf_fs_ds_file_medops
, ds_file
, NULL
, ctf_fs_trace
->logger
);
1146 /* ctf_msg_iter_create() logs errors. */
1152 * Turn on dry run mode to prevent the creation and usage of Babeltrace
1153 * library objects (bt_field, bt_message_*, etc.).
1155 ctf_msg_iter_set_dry_run(msg_iter
, true);
1157 /* Seek to the beginning of the target packet. */
1158 iter_status
= ctf_msg_iter_seek(msg_iter
, index_entry
->offset
.bytes());
1160 /* ctf_msg_iter_seek() logs errors. */
1165 switch (target_event
) {
1168 * Start to decode the packet until we reach the end of
1169 * the first event. To extract the first event's clock
1172 iter_status
= ctf_msg_iter_curr_packet_first_event_clock_snapshot(msg_iter
, cs
);
1175 /* Decode the packet to extract the last event's clock snapshot. */
1176 iter_status
= ctf_msg_iter_curr_packet_last_event_clock_snapshot(msg_iter
, cs
);
1186 /* Convert clock snapshot to timestamp. */
1187 ret
= bt_util_clock_cycles_to_ns_from_origin(
1188 *cs
, default_cc
->frequency
, default_cc
->offset_seconds
, default_cc
->offset_cycles
, ts_ns
);
1190 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1191 "Failed to convert clock snapshot to timestamp");
1197 ctf_fs_ds_file_destroy(ds_file
);
1200 ctf_msg_iter_destroy(msg_iter
);
1206 static int decode_packet_first_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1207 struct ctf_clock_class
*default_cc
,
1208 struct ctf_fs_ds_index_entry
*index_entry
,
1209 uint64_t *cs
, int64_t *ts_ns
)
1211 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, FIRST_EVENT
, cs
,
1215 static int decode_packet_last_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1216 struct ctf_clock_class
*default_cc
,
1217 struct ctf_fs_ds_index_entry
*index_entry
,
1218 uint64_t *cs
, int64_t *ts_ns
)
1220 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, LAST_EVENT
, cs
,
1225 * Fix up packet index entries for lttng's "event-after-packet" bug.
1226 * Some buggy lttng tracer versions may emit events with a timestamp that is
1227 * larger (after) than the timestamp_end of the their packets.
1229 * To fix up this erroneous data we do the following:
1230 * 1. If it's not the stream file's last packet: set the packet index entry's
1231 * end time to the next packet's beginning time.
1232 * 2. If it's the stream file's last packet, set the packet index entry's end
1233 * time to the packet's last event's time, if any, or to the packet's
1234 * beginning time otherwise.
1236 * Known buggy tracer versions:
1237 * - before lttng-ust 2.11.0
1238 * - before lttng-module 2.11.0
1239 * - before lttng-module 2.10.10
1240 * - before lttng-module 2.9.13
1242 static int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace
*trace
)
1246 for (const auto& ds_file_group
: trace
->ds_file_groups
) {
1247 struct ctf_clock_class
*default_cc
;
1249 BT_ASSERT(ds_file_group
);
1250 const auto index
= ds_file_group
->index
.get();
1253 BT_ASSERT(!index
->entries
.empty());
1256 * Iterate over all entries but the last one. The last one is
1257 * fixed differently after.
1259 for (size_t entry_i
= 0; entry_i
< index
->entries
.size() - 1; ++entry_i
) {
1260 ctf_fs_ds_index_entry
*curr_entry
= index
->entries
[entry_i
].get();
1261 ctf_fs_ds_index_entry
*next_entry
= index
->entries
[entry_i
+ 1].get();
1264 * 1. Set the current index entry `end` timestamp to
1265 * the next index entry `begin` timestamp.
1267 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1268 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1272 * 2. Fix the last entry by decoding the last event of the last
1275 const auto last_entry
= index
->entries
.back().get();
1276 BT_ASSERT(last_entry
);
1278 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1279 default_cc
= ds_file_group
->sc
->default_clock_class
;
1282 * Decode packet to read the timestamp of the last event of the
1285 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1286 &last_entry
->timestamp_end
,
1287 &last_entry
->timestamp_end_ns
);
1289 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1291 "Failed to decode stream's last packet to get its last event's clock snapshot.");
1301 * Fix up packet index entries for barectf's "event-before-packet" bug.
1302 * Some buggy barectf tracer versions may emit events with a timestamp that is
1303 * less than the timestamp_begin of the their packets.
1305 * To fix up this erroneous data we do the following:
1306 * 1. Starting at the second index entry, set the timestamp_begin of the
1307 * current entry to the timestamp of the first event of the packet.
1308 * 2. Set the previous entry's timestamp_end to the timestamp_begin of the
1311 * Known buggy tracer versions:
1312 * - before barectf 2.3.1
1314 static int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace
*trace
)
1318 for (const auto& ds_file_group
: trace
->ds_file_groups
) {
1319 struct ctf_clock_class
*default_cc
;
1320 const auto index
= ds_file_group
->index
.get();
1323 BT_ASSERT(!index
->entries
.empty());
1325 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1326 default_cc
= ds_file_group
->sc
->default_clock_class
;
1329 * 1. Iterate over the index, starting from the second entry
1332 for (size_t entry_i
= 1; entry_i
< index
->entries
.size(); ++entry_i
) {
1333 ctf_fs_ds_index_entry
*prev_entry
= index
->entries
[entry_i
- 1].get();
1334 ctf_fs_ds_index_entry
*curr_entry
= index
->entries
[entry_i
].get();
1336 * 2. Set the current entry `begin` timestamp to the
1337 * timestamp of the first event of the current packet.
1339 ret
= decode_packet_first_event_timestamp(trace
, default_cc
, curr_entry
,
1340 &curr_entry
->timestamp_begin
,
1341 &curr_entry
->timestamp_begin_ns
);
1343 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1344 "Failed to decode first event's clock snapshot");
1349 * 3. Set the previous entry `end` timestamp to the
1350 * timestamp of the first event of the current packet.
1352 prev_entry
->timestamp_end
= curr_entry
->timestamp_begin
;
1353 prev_entry
->timestamp_end_ns
= curr_entry
->timestamp_begin_ns
;
1361 * When using the lttng-crash feature it's likely that the last packets of each
1362 * stream have their timestamp_end set to zero. This is caused by the fact that
1363 * the tracer crashed and was not able to properly close the packets.
1365 * To fix up this erroneous data we do the following:
1366 * For each index entry, if the entry's timestamp_end is 0 and the
1367 * timestamp_begin is not 0:
1368 * - If it's the stream file's last packet: set the packet index entry's end
1369 * time to the packet's last event's time, if any, or to the packet's
1370 * beginning time otherwise.
1371 * - If it's not the stream file's last packet: set the packet index
1372 * entry's end time to the next packet's beginning time.
1374 * Affected versions:
1375 * - All current and future lttng-ust and lttng-modules versions.
1377 static int fix_index_lttng_crash_quirk(struct ctf_fs_trace
*trace
)
1381 for (const auto& ds_file_group
: trace
->ds_file_groups
) {
1382 struct ctf_clock_class
*default_cc
;
1384 BT_ASSERT(ds_file_group
);
1385 const auto index
= ds_file_group
->index
.get();
1387 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1388 default_cc
= ds_file_group
->sc
->default_clock_class
;
1391 BT_ASSERT(!index
->entries
.empty());
1393 const auto last_entry
= index
->entries
.back().get();
1394 BT_ASSERT(last_entry
);
1396 /* 1. Fix the last entry first. */
1397 if (last_entry
->timestamp_end
== 0 && last_entry
->timestamp_begin
!= 0) {
1399 * Decode packet to read the timestamp of the
1400 * last event of the stream file.
1402 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1403 &last_entry
->timestamp_end
,
1404 &last_entry
->timestamp_end_ns
);
1406 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1407 "Failed to decode last event's clock snapshot");
1412 /* Iterate over all entries but the last one. */
1413 for (size_t entry_idx
= 0; entry_idx
< index
->entries
.size() - 1; ++entry_idx
) {
1414 ctf_fs_ds_index_entry
*curr_entry
= index
->entries
[entry_idx
].get();
1415 ctf_fs_ds_index_entry
*next_entry
= index
->entries
[entry_idx
+ 1].get();
1417 if (curr_entry
->timestamp_end
== 0 && curr_entry
->timestamp_begin
!= 0) {
1419 * 2. Set the current index entry `end` timestamp to
1420 * the next index entry `begin` timestamp.
1422 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1423 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1433 * Extract the tracer information necessary to compare versions.
1434 * Returns 0 on success, and -1 if the extraction is not successful because the
1435 * necessary fields are absents in the trace metadata.
1437 static int extract_tracer_info(struct ctf_fs_trace
*trace
, struct tracer_info
*current_tracer_info
)
1440 struct ctf_trace_class_env_entry
*entry
;
1442 /* Clear the current_tracer_info struct */
1443 memset(current_tracer_info
, 0, sizeof(*current_tracer_info
));
1446 * To compare 2 tracer versions, at least the tracer name and it's
1447 * major version are needed. If one of these is missing, consider it an
1448 * extraction failure.
1450 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_name");
1451 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR
) {
1452 goto missing_bare_minimum
;
1455 /* Set tracer name. */
1456 current_tracer_info
->name
= entry
->value
.str
->str
;
1458 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_major");
1459 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1460 goto missing_bare_minimum
;
1463 /* Set major version number. */
1464 current_tracer_info
->major
= entry
->value
.i
;
1466 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_minor");
1467 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1471 /* Set minor version number. */
1472 current_tracer_info
->minor
= entry
->value
.i
;
1474 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patch");
1477 * If `tracer_patch` doesn't exist `tracer_patchlevel` might.
1478 * For example, `lttng-modules` uses entry name
1479 * `tracer_patchlevel`.
1481 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patchlevel");
1484 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1488 /* Set patch version number. */
1489 current_tracer_info
->patch
= entry
->value
.i
;
1493 missing_bare_minimum
:
1499 static bool is_tracer_affected_by_lttng_event_after_packet_bug(struct tracer_info
*curr_tracer_info
)
1501 bool is_affected
= false;
1503 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1504 if (curr_tracer_info
->major
< 2) {
1506 } else if (curr_tracer_info
->major
== 2) {
1507 /* fixed in lttng-ust 2.11.0 */
1508 if (curr_tracer_info
->minor
< 11) {
1512 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1513 if (curr_tracer_info
->major
< 2) {
1515 } else if (curr_tracer_info
->major
== 2) {
1516 /* fixed in lttng-modules 2.11.0 */
1517 if (curr_tracer_info
->minor
== 10) {
1518 /* fixed in lttng-modules 2.10.10 */
1519 if (curr_tracer_info
->patch
< 10) {
1522 } else if (curr_tracer_info
->minor
== 9) {
1523 /* fixed in lttng-modules 2.9.13 */
1524 if (curr_tracer_info
->patch
< 13) {
1527 } else if (curr_tracer_info
->minor
< 9) {
1537 is_tracer_affected_by_barectf_event_before_packet_bug(struct tracer_info
*curr_tracer_info
)
1539 bool is_affected
= false;
1541 if (strcmp(curr_tracer_info
->name
, "barectf") == 0) {
1542 if (curr_tracer_info
->major
< 2) {
1544 } else if (curr_tracer_info
->major
== 2) {
1545 if (curr_tracer_info
->minor
< 3) {
1547 } else if (curr_tracer_info
->minor
== 3) {
1548 /* fixed in barectf 2.3.1 */
1549 if (curr_tracer_info
->patch
< 1) {
1559 static bool is_tracer_affected_by_lttng_crash_quirk(struct tracer_info
*curr_tracer_info
)
1561 bool is_affected
= false;
1563 /* All LTTng tracer may be affected by this lttng crash quirk. */
1564 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1566 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1574 * Looks for trace produced by known buggy tracers and fix up the index
1577 static int fix_packet_index_tracer_bugs(ctf_fs_trace
*trace
)
1580 struct tracer_info current_tracer_info
;
1582 ret
= extract_tracer_info(trace
, ¤t_tracer_info
);
1585 * A trace may not have all the necessary environment
1586 * entries to do the tracer version comparison.
1587 * At least, the tracer name and major version number
1588 * are needed. Failing to extract these entries is not
1592 BT_CPPLOGI_STR_SPEC(
1594 "Cannot extract tracer information necessary to compare with buggy versions.");
1598 /* Check if the trace may be affected by old tracer bugs. */
1599 if (is_tracer_affected_by_lttng_event_after_packet_bug(¤t_tracer_info
)) {
1600 BT_CPPLOGI_STR_SPEC(
1602 "Trace may be affected by LTTng tracer packet timestamp bug. Fixing up.");
1603 ret
= fix_index_lttng_event_after_packet_bug(trace
);
1605 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1606 "Failed to fix LTTng event-after-packet bug.");
1609 trace
->metadata
->tc
->quirks
.lttng_event_after_packet
= true;
1612 if (is_tracer_affected_by_barectf_event_before_packet_bug(¤t_tracer_info
)) {
1613 BT_CPPLOGI_STR_SPEC(
1615 "Trace may be affected by barectf tracer packet timestamp bug. Fixing up.");
1616 ret
= fix_index_barectf_event_before_packet_bug(trace
);
1618 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1619 "Failed to fix barectf event-before-packet bug.");
1622 trace
->metadata
->tc
->quirks
.barectf_event_before_packet
= true;
1625 if (is_tracer_affected_by_lttng_crash_quirk(¤t_tracer_info
)) {
1626 ret
= fix_index_lttng_crash_quirk(trace
);
1628 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1629 "Failed to fix lttng-crash timestamp quirks.");
1632 trace
->metadata
->tc
->quirks
.lttng_crash
= true;
1639 static bool compare_ds_file_groups_by_first_path(const ctf_fs_ds_file_group::UP
& ds_file_group_a
,
1640 const ctf_fs_ds_file_group::UP
& ds_file_group_b
)
1642 BT_ASSERT(!ds_file_group_a
->ds_file_infos
.empty());
1643 BT_ASSERT(!ds_file_group_b
->ds_file_infos
.empty());
1645 const auto& first_ds_file_info_a
= *ds_file_group_a
->ds_file_infos
[0];
1646 const auto& first_ds_file_info_b
= *ds_file_group_b
->ds_file_infos
[0];
1648 return first_ds_file_info_a
.path
< first_ds_file_info_b
.path
;
1651 static gint
compare_strings(gconstpointer p_a
, gconstpointer p_b
)
1653 const char *a
= *((const char **) p_a
);
1654 const char *b
= *((const char **) p_b
);
1656 return strcmp(a
, b
);
1659 int ctf_fs_component_create_ctf_fs_trace(struct ctf_fs_component
*ctf_fs
,
1660 const bt_value
*paths_value
,
1661 const bt_value
*trace_name_value
,
1662 bt_self_component
*selfComp
)
1666 GPtrArray
*paths
= NULL
;
1667 std::vector
<ctf_fs_trace::UP
> traces
;
1668 const char *trace_name
;
1670 BT_ASSERT(bt_value_get_type(paths_value
) == BT_VALUE_TYPE_ARRAY
);
1671 BT_ASSERT(!bt_value_array_is_empty(paths_value
));
1673 paths
= g_ptr_array_new_with_free_func(g_free
);
1675 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to allocate a GPtrArray.");
1679 trace_name
= trace_name_value
? bt_value_string_get(trace_name_value
) : NULL
;
1682 * Create a sorted array of the paths, to make the execution of this
1683 * component deterministic.
1685 for (i
= 0; i
< bt_value_array_get_length(paths_value
); i
++) {
1686 const bt_value
*path_value
= bt_value_array_borrow_element_by_index_const(paths_value
, i
);
1687 const char *input
= bt_value_string_get(path_value
);
1690 input_copy
= g_strdup(input
);
1692 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to copy a string.");
1696 g_ptr_array_add(paths
, input_copy
);
1699 g_ptr_array_sort(paths
, compare_strings
);
1701 /* Create a separate ctf_fs_trace object for each path. */
1702 for (i
= 0; i
< paths
->len
; i
++) {
1703 const char *path
= (const char *) g_ptr_array_index(paths
, i
);
1705 ret
= ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs
, path
, trace_name
, traces
,
1712 if (traces
.size() > 1) {
1713 ctf_fs_trace
*first_trace
= traces
[0].get();
1714 const uint8_t *first_trace_uuid
= first_trace
->metadata
->tc
->uuid
;
1717 * We have more than one trace, they must all share the same
1718 * UUID, verify that.
1720 for (i
= 0; i
< traces
.size(); i
++) {
1721 ctf_fs_trace
*this_trace
= traces
[i
].get();
1722 const uint8_t *this_trace_uuid
= this_trace
->metadata
->tc
->uuid
;
1724 if (!this_trace
->metadata
->tc
->is_uuid_set
) {
1725 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1727 "Multiple traces given, but a trace does not have a UUID: path={}",
1728 this_trace
->path
->str
);
1732 if (bt_uuid_compare(first_trace_uuid
, this_trace_uuid
) != 0) {
1733 char first_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1734 char this_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1736 bt_uuid_to_str(first_trace_uuid
, first_trace_uuid_str
);
1737 bt_uuid_to_str(this_trace_uuid
, this_trace_uuid_str
);
1739 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1740 "Multiple traces given, but UUIDs don't match: "
1741 "first-trace-uuid={}, first-trace-path={}, "
1742 "trace-uuid={}, trace-path={}",
1743 first_trace_uuid_str
, first_trace
->path
->str
,
1744 this_trace_uuid_str
, this_trace
->path
->str
);
1749 ret
= merge_ctf_fs_traces(std::move(traces
), ctf_fs
->trace
);
1751 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1752 "Failed to merge traces with the same UUID.");
1756 /* Just one trace, it may or may not have a UUID, both are fine. */
1757 ctf_fs
->trace
= std::move(traces
[0]);
1760 ret
= fix_packet_index_tracer_bugs(ctf_fs
->trace
.get());
1762 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to fix packet index tracer bugs.");
1766 * Sort data stream file groups by first data stream file info
1767 * path to get a deterministic order. This order influences the
1768 * order of the output ports. It also influences the order of
1769 * the automatic stream IDs if the trace's packet headers do not
1770 * contain a `stream_instance_id` field, in which case the data
1771 * stream file to stream ID association is always the same,
1772 * whatever the build and the system.
1774 * Having a deterministic order here can help debugging and
1777 std::sort(ctf_fs
->trace
->ds_file_groups
.begin(), ctf_fs
->trace
->ds_file_groups
.end(),
1778 compare_ds_file_groups_by_first_path
);
1785 g_ptr_array_free(paths
, TRUE
);
1791 static GString
*get_stream_instance_unique_name(struct ctf_fs_ds_file_group
*ds_file_group
)
1794 struct ctf_fs_ds_file_info
*ds_file_info
;
1796 name
= g_string_new(NULL
);
1802 * If there's more than one stream file in the stream file
1803 * group, the first (earliest) stream file's path is used as
1804 * the stream's unique name.
1806 BT_ASSERT(!ds_file_group
->ds_file_infos
.empty());
1807 ds_file_info
= ds_file_group
->ds_file_infos
[0].get();
1808 g_string_assign(name
, ds_file_info
->path
.c_str());
1814 /* Create the IR stream objects for ctf_fs_trace. */
1816 static int create_streams_for_trace(struct ctf_fs_trace
*ctf_fs_trace
)
1819 GString
*name
= NULL
;
1821 for (const auto& ds_file_group
: ctf_fs_trace
->ds_file_groups
) {
1822 name
= get_stream_instance_unique_name(ds_file_group
.get());
1828 BT_ASSERT(ds_file_group
->sc
->ir_sc
);
1829 BT_ASSERT(ctf_fs_trace
->trace
);
1833 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
1834 /* No stream ID: use 0 */
1835 stream
= bt_stream_create_with_id(ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
,
1836 ctf_fs_trace
->next_stream_id
);
1837 ctf_fs_trace
->next_stream_id
++;
1839 /* Specific stream ID */
1840 stream
= bt_stream_create_with_id(ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
,
1841 (uint64_t) ds_file_group
->stream_id
);
1845 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1846 "Cannot create stream for DS file group: "
1847 "addr={}, stream-name=\"{}\"",
1848 fmt::ptr(ds_file_group
), name
->str
);
1852 ds_file_group
->stream
= bt2::Stream::Shared::createWithoutRef(stream
);
1854 ret
= bt_stream_set_name(ds_file_group
->stream
->libObjPtr(), name
->str
);
1856 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1857 "Cannot set stream's name: "
1858 "addr={}, stream-name=\"{}\"",
1859 fmt::ptr(ds_file_group
->stream
->libObjPtr()), name
->str
);
1863 g_string_free(name
, TRUE
);
1876 g_string_free(name
, TRUE
);
1881 static const bt_param_validation_value_descr inputs_elem_descr
=
1882 bt_param_validation_value_descr::makeString();
1884 static bt_param_validation_map_value_entry_descr fs_params_entries_descr
[] = {
1885 {"inputs", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
1886 bt_param_validation_value_descr::makeArray(1, BT_PARAM_VALIDATION_INFINITE
,
1887 inputs_elem_descr
)},
1888 {"trace-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1889 bt_param_validation_value_descr::makeString()},
1890 {"clock-class-offset-s", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1891 bt_param_validation_value_descr::makeSignedInteger()},
1892 {"clock-class-offset-ns", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1893 bt_param_validation_value_descr::makeSignedInteger()},
1894 {"force-clock-class-origin-unix-epoch", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1895 bt_param_validation_value_descr::makeBool()},
1896 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
1898 bool read_src_fs_parameters(const bt_value
*params
, const bt_value
**inputs
,
1899 const bt_value
**trace_name
, struct ctf_fs_component
*ctf_fs
)
1902 const bt_value
*value
;
1903 enum bt_param_validation_status validate_value_status
;
1904 gchar
*error
= NULL
;
1906 validate_value_status
= bt_param_validation_validate(params
, fs_params_entries_descr
, &error
);
1907 if (validate_value_status
!= BT_PARAM_VALIDATION_STATUS_OK
) {
1908 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "{}", error
);
1913 /* inputs parameter */
1914 *inputs
= bt_value_map_borrow_entry_value_const(params
, "inputs");
1916 /* clock-class-offset-s parameter */
1917 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-s");
1919 ctf_fs
->clkClsCfg
.offsetSec
= bt_value_integer_signed_get(value
);
1922 /* clock-class-offset-ns parameter */
1923 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-ns");
1925 ctf_fs
->clkClsCfg
.offsetNanoSec
= bt_value_integer_signed_get(value
);
1928 /* force-clock-class-origin-unix-epoch parameter */
1929 value
= bt_value_map_borrow_entry_value_const(params
, "force-clock-class-origin-unix-epoch");
1931 ctf_fs
->clkClsCfg
.forceOriginIsUnixEpoch
= bt_value_bool_get(value
);
1934 /* trace-name parameter */
1935 *trace_name
= bt_value_map_borrow_entry_value_const(params
, "trace-name");
1944 static ctf_fs_component::UP
ctf_fs_create(const bt_value
*params
,
1945 bt_self_component_source
*self_comp_src
)
1947 const bt_value
*inputs_value
;
1948 const bt_value
*trace_name_value
;
1949 bt_self_component
*self_comp
= bt_self_component_source_as_self_component(self_comp_src
);
1951 ctf_fs_component::UP ctf_fs
= ctf_fs_component_create(
1952 bt2c::Logger
{bt2::SelfSourceComponent
{self_comp_src
}, "PLUGIN/SRC.CTF.FS/COMP"});
1957 if (!read_src_fs_parameters(params
, &inputs_value
, &trace_name_value
, ctf_fs
.get())) {
1961 if (ctf_fs_component_create_ctf_fs_trace(ctf_fs
.get(), inputs_value
, trace_name_value
,
1966 if (create_streams_for_trace(ctf_fs
->trace
.get())) {
1970 if (create_ports_for_trace(ctf_fs
.get(), ctf_fs
->trace
.get(), self_comp_src
)) {
1977 bt_component_class_initialize_method_status
ctf_fs_init(bt_self_component_source
*self_comp_src
,
1978 bt_self_component_source_configuration
*,
1979 const bt_value
*params
, void *)
1982 bt_component_class_initialize_method_status ret
=
1983 BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
1985 ctf_fs_component::UP ctf_fs
= ctf_fs_create(params
, self_comp_src
);
1987 ret
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1990 bt_self_component_set_data(bt_self_component_source_as_self_component(self_comp_src
),
1993 } catch (const std::bad_alloc
&) {
1994 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1995 } catch (const bt2::Error
&) {
1996 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
2000 bt_component_class_query_method_status
ctf_fs_query(bt_self_component_class_source
*comp_class_src
,
2001 bt_private_query_executor
*priv_query_exec
,
2002 const char *object
, const bt_value
*params
,
2003 __attribute__((unused
)) void *method_data
,
2004 const bt_value
**result
)
2007 bt2c::Logger logger
{bt2::SelfComponentClass
{comp_class_src
},
2008 bt2::PrivateQueryExecutor
{priv_query_exec
},
2009 "PLUGIN/SRC.CTF.FS/QUERY"};
2010 bt2::ConstMapValue
paramsObj(params
);
2011 bt2::Value::Shared resultObj
;
2013 if (strcmp(object
, "metadata-info") == 0) {
2014 resultObj
= metadata_info_query(paramsObj
, logger
);
2015 } else if (strcmp(object
, "babeltrace.trace-infos") == 0) {
2016 resultObj
= trace_infos_query(paramsObj
, logger
);
2017 } else if (!strcmp(object
, "babeltrace.support-info")) {
2018 resultObj
= support_info_query(paramsObj
, logger
);
2020 BT_CPPLOGE_SPEC(logger
, "Unknown query object `{}`", object
);
2021 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;
2024 *result
= resultObj
.release().libObjPtr();
2026 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
2027 } catch (const std::bad_alloc
&) {
2028 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
2029 } catch (const bt2::Error
&) {
2030 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;