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
14 #include <babeltrace2/babeltrace.h>
16 #include "common/assert.h"
17 #include "common/common.h"
18 #include "common/uuid.h"
19 #include "cpp-common/bt2c/glib-up.hpp"
20 #include "cpp-common/bt2s/make-unique.hpp"
22 #include "plugins/common/param-validation/param-validation.h"
24 #include "../common/src/metadata/tsdl/ctf-meta-configure-ir-trace.hpp"
25 #include "../common/src/msg-iter/msg-iter.hpp"
26 #include "data-stream-file.hpp"
29 #include "metadata.hpp"
40 static bt_message_iterator_class_next_method_status
41 ctf_fs_iterator_next_one(struct ctf_fs_msg_iter_data
*msg_iter_data
, const bt_message
**out_msg
)
43 bt_message_iterator_class_next_method_status status
;
44 const auto msg_iter_status
=
45 ctf_msg_iter_get_next_message(msg_iter_data
->msg_iter
.get(), out_msg
);
47 switch (msg_iter_status
) {
48 case CTF_MSG_ITER_STATUS_OK
:
49 /* Cool, message has been written to *out_msg. */
50 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
53 case CTF_MSG_ITER_STATUS_EOF
:
54 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END
;
57 case CTF_MSG_ITER_STATUS_AGAIN
:
59 * Should not make it this far as this is
60 * medium-specific; there is nothing for the user to do
61 * and it should have been handled upstream.
65 case CTF_MSG_ITER_STATUS_ERROR
:
66 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
67 "Failed to get next message from CTF message iterator.");
68 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
71 case CTF_MSG_ITER_STATUS_MEMORY_ERROR
:
72 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
73 "Failed to get next message from CTF message iterator.");
74 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
84 bt_message_iterator_class_next_method_status
85 ctf_fs_iterator_next(bt_self_message_iterator
*iterator
, bt_message_array_const msgs
,
86 uint64_t capacity
, uint64_t *count
)
89 bt_message_iterator_class_next_method_status status
;
90 struct ctf_fs_msg_iter_data
*msg_iter_data
=
91 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(iterator
);
94 if (G_UNLIKELY(msg_iter_data
->next_saved_error
)) {
96 * Last time we were called, we hit an error but had some
97 * messages to deliver, so we stashed the error here. Return
100 BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(msg_iter_data
->next_saved_error
);
101 status
= msg_iter_data
->next_saved_status
;
106 status
= ctf_fs_iterator_next_one(msg_iter_data
, &msgs
[i
]);
107 if (status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
) {
110 } while (i
< capacity
&& status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
);
114 * Even if ctf_fs_iterator_next_one() returned something
115 * else than BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK, we
116 * accumulated message objects in the output
117 * message array, so we need to return
118 * BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK so that they are
119 * transferred to downstream. This other status occurs
120 * again the next time muxer_msg_iter_do_next() is
121 * called, possibly without any accumulated
122 * message, in which case we'll return it.
126 * Save this error for the next _next call. Assume that
127 * this component always appends error causes when
128 * returning an error status code, which will cause the
129 * current thread error to be non-NULL.
131 msg_iter_data
->next_saved_error
= bt_current_thread_take_error();
132 BT_ASSERT(msg_iter_data
->next_saved_error
);
133 msg_iter_data
->next_saved_status
= status
;
137 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
143 } catch (const std::bad_alloc
&) {
144 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
145 } catch (const bt2::Error
&) {
146 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
150 bt_message_iterator_class_seek_beginning_method_status
151 ctf_fs_iterator_seek_beginning(bt_self_message_iterator
*it
)
154 struct ctf_fs_msg_iter_data
*msg_iter_data
=
155 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(it
);
157 BT_ASSERT(msg_iter_data
);
159 ctf_msg_iter_reset(msg_iter_data
->msg_iter
.get());
160 ctf_fs_ds_group_medops_data_reset(msg_iter_data
->msg_iter_medops_data
.get());
162 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_OK
;
163 } catch (const std::bad_alloc
&) {
164 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_MEMORY_ERROR
;
165 } catch (const bt2::Error
&) {
166 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_ERROR
;
170 void ctf_fs_iterator_finalize(bt_self_message_iterator
*it
)
172 ctf_fs_msg_iter_data::UP
{
173 (static_cast<ctf_fs_msg_iter_data
*>(bt_self_message_iterator_get_data(it
)))};
176 static bt_message_iterator_class_initialize_method_status
177 ctf_msg_iter_medium_status_to_msg_iter_initialize_status(enum ctf_msg_iter_medium_status status
)
180 case CTF_MSG_ITER_MEDIUM_STATUS_EOF
:
181 case CTF_MSG_ITER_MEDIUM_STATUS_AGAIN
:
182 case CTF_MSG_ITER_MEDIUM_STATUS_ERROR
:
183 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
184 case CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
:
185 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
186 case CTF_MSG_ITER_MEDIUM_STATUS_OK
:
187 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
193 bt_message_iterator_class_initialize_method_status
194 ctf_fs_iterator_init(bt_self_message_iterator
*self_msg_iter
,
195 bt_self_message_iterator_configuration
*config
,
196 bt_self_component_port_output
*self_port
)
199 struct ctf_fs_port_data
*port_data
;
200 bt_message_iterator_class_initialize_method_status status
;
201 enum ctf_msg_iter_medium_status medium_status
;
203 port_data
= (struct ctf_fs_port_data
*) bt_self_component_port_get_data(
204 bt_self_component_port_output_as_self_component_port(self_port
));
205 BT_ASSERT(port_data
);
207 auto msg_iter_data
= bt2s::make_unique
<ctf_fs_msg_iter_data
>(self_msg_iter
);
208 msg_iter_data
->ds_file_group
= port_data
->ds_file_group
;
210 medium_status
= ctf_fs_ds_group_medops_data_create(msg_iter_data
->ds_file_group
,
211 self_msg_iter
, msg_iter_data
->logger
,
212 msg_iter_data
->msg_iter_medops_data
);
213 BT_ASSERT(medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_OK
||
214 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_ERROR
||
215 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
);
216 if (medium_status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
217 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
218 "Failed to create ctf_fs_ds_group_medops");
219 status
= ctf_msg_iter_medium_status_to_msg_iter_initialize_status(medium_status
);
223 msg_iter_data
->msg_iter
= ctf_msg_iter_create(
224 msg_iter_data
->ds_file_group
->ctf_fs_trace
->metadata
->tc
,
225 bt_common_get_page_size(static_cast<int>(msg_iter_data
->logger
.level())) * 8,
226 ctf_fs_ds_group_medops
, msg_iter_data
->msg_iter_medops_data
.get(), self_msg_iter
,
227 msg_iter_data
->logger
);
228 if (!msg_iter_data
->msg_iter
) {
229 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
230 "Cannot create a CTF message iterator.");
231 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
236 * This iterator can seek forward if its stream class has a default
239 if (msg_iter_data
->ds_file_group
->sc
->default_clock_class
) {
240 bt_self_message_iterator_configuration_set_can_seek_forward(config
, true);
243 bt_self_message_iterator_set_data(self_msg_iter
, msg_iter_data
.release());
245 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
249 bt_self_message_iterator_set_data(self_msg_iter
, NULL
);
253 } catch (const std::bad_alloc
&) {
254 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
255 } catch (const bt2::Error
&) {
256 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
260 ctf_fs_component::UP
ctf_fs_component_create(const bt2c::Logger
& parentLogger
)
262 return bt2s::make_unique
<ctf_fs_component
>(parentLogger
);
265 void ctf_fs_finalize(bt_self_component_source
*component
)
267 ctf_fs_component::UP
{static_cast<ctf_fs_component
*>(
268 bt_self_component_get_data(bt_self_component_source_as_self_component(component
)))};
271 std::string
ctf_fs_make_port_name(ctf_fs_ds_file_group
*ds_file_group
)
273 std::stringstream name
;
276 * The unique port name is generated by concatenating unique identifiers
284 /* For the trace, use the uuid if present, else the path. */
285 if (ds_file_group
->ctf_fs_trace
->metadata
->tc
->is_uuid_set
) {
286 char uuid_str
[BT_UUID_STR_LEN
+ 1];
288 bt_uuid_to_str(ds_file_group
->ctf_fs_trace
->metadata
->tc
->uuid
, uuid_str
);
291 name
<< ds_file_group
->ctf_fs_trace
->path
;
295 * For the stream class, use the id if present. We can omit this field
296 * otherwise, as there will only be a single stream class.
298 if (ds_file_group
->sc
->id
!= UINT64_C(-1)) {
299 name
<< " | " << ds_file_group
->sc
->id
;
302 /* For the stream, use the id if present, else, use the path. */
303 if (ds_file_group
->stream_id
!= UINT64_C(-1)) {
304 name
<< " | " << ds_file_group
->stream_id
;
306 BT_ASSERT(ds_file_group
->ds_file_infos
.size() == 1);
307 const auto& ds_file_info
= *ds_file_group
->ds_file_infos
[0];
308 name
<< " | " << ds_file_info
.path
;
314 static int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
315 struct ctf_fs_ds_file_group
*ds_file_group
,
316 bt_self_component_source
*self_comp_src
)
319 ctf_fs_port_data::UP port_data
;
321 const auto port_name
= ctf_fs_make_port_name(ds_file_group
);
322 BT_CPPLOGI_SPEC(ctf_fs
->logger
, "Creating one port named `{}`", port_name
);
324 /* Create output port for this file */
325 port_data
= bt2s::make_unique
<ctf_fs_port_data
>();
326 port_data
->ctf_fs
= ctf_fs
;
327 port_data
->ds_file_group
= ds_file_group
;
328 ret
= bt_self_component_source_add_output_port(self_comp_src
, port_name
.c_str(),
329 port_data
.get(), NULL
);
334 ctf_fs
->port_data
.emplace_back(std::move(port_data
));
344 static int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
345 struct ctf_fs_trace
*ctf_fs_trace
,
346 bt_self_component_source
*self_comp_src
)
350 /* Create one output port for each stream file group */
351 for (const auto& ds_file_group
: ctf_fs_trace
->ds_file_groups
) {
352 ret
= create_one_port_for_trace(ctf_fs
, ds_file_group
.get(), self_comp_src
);
354 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create output port.");
364 * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right
365 * place to keep it sorted.
368 static void ds_file_group_insert_ds_file_info_sorted(struct ctf_fs_ds_file_group
*ds_file_group
,
369 ctf_fs_ds_file_info::UP ds_file_info
)
371 /* Find the spot where to insert this ds_file_info. */
372 auto it
= ds_file_group
->ds_file_infos
.begin();
374 for (; it
!= ds_file_group
->ds_file_infos
.end(); ++it
) {
375 const ctf_fs_ds_file_info
& other_ds_file_info
= **it
;
377 if (ds_file_info
->begin_ns
< other_ds_file_info
.begin_ns
) {
382 ds_file_group
->ds_file_infos
.insert(it
, std::move(ds_file_info
));
385 static bool ds_index_entries_equal(const struct ctf_fs_ds_index_entry
*left
,
386 const struct ctf_fs_ds_index_entry
*right
)
388 if (left
->packetSize
!= right
->packetSize
) {
392 if (left
->timestamp_begin
!= right
->timestamp_begin
) {
396 if (left
->timestamp_end
!= right
->timestamp_end
) {
400 if (left
->packet_seq_num
!= right
->packet_seq_num
) {
408 * Insert `entry` into `index`, without duplication.
410 * The entry is inserted only if there isn't an identical entry already.
412 * In any case, the ownership of `entry` is transferred to this function. So if
413 * the entry is not inserted, it is freed.
416 static void ds_index_insert_ds_index_entry_sorted(struct ctf_fs_ds_index
*index
,
417 ctf_fs_ds_index_entry::UP entry
)
419 /* Find the spot where to insert this index entry. */
420 auto otherEntry
= index
->entries
.begin();
421 for (; otherEntry
!= index
->entries
.end(); ++otherEntry
) {
422 if (entry
->timestamp_begin_ns
<= (*otherEntry
)->timestamp_begin_ns
) {
428 * Insert the entry only if a duplicate doesn't already exist.
430 * There can be duplicate packets if reading multiple overlapping
431 * snapshots of the same trace. We then want the index to contain
432 * a reference to only one copy of that packet.
434 if (otherEntry
== index
->entries
.end() ||
435 !ds_index_entries_equal(entry
.get(), otherEntry
->get())) {
436 index
->entries
.insert(otherEntry
, std::move(entry
));
440 static void merge_ctf_fs_ds_indexes(struct ctf_fs_ds_index
*dest
, ctf_fs_ds_index::UP src
)
442 for (auto& entry
: src
->entries
) {
443 ds_index_insert_ds_index_entry_sorted(dest
, std::move(entry
));
447 static int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
, const char *path
)
449 int64_t stream_instance_id
= -1;
450 int64_t begin_ns
= -1;
451 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
452 ctf_fs_ds_file_group::UP new_ds_file_group
;
454 ctf_fs_ds_file_info::UP ds_file_info
;
455 ctf_fs_ds_index::UP index
;
456 ctf_msg_iter_up msg_iter
;
457 struct ctf_stream_class
*sc
= NULL
;
458 struct ctf_msg_iter_packet_properties props
;
461 * Create a temporary ds_file to read some properties about the data
465 ctf_fs_ds_file_create(ctf_fs_trace
, bt2::Stream::Shared
{}, path
, ctf_fs_trace
->logger
);
470 /* Create a temporary iterator to read the ds_file. */
471 msg_iter
= ctf_msg_iter_create(
472 ctf_fs_trace
->metadata
->tc
,
473 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
474 ctf_fs_ds_file_medops
, ds_file
.get(), nullptr, ctf_fs_trace
->logger
);
476 BT_CPPLOGE_STR_SPEC(ctf_fs_trace
->logger
, "Cannot create a CTF message iterator.");
480 ctf_msg_iter_set_dry_run(msg_iter
.get(), true);
482 ret
= ctf_msg_iter_get_packet_properties(msg_iter
.get(), &props
);
484 BT_CPPLOGE_APPEND_CAUSE_SPEC(
485 ctf_fs_trace
->logger
,
486 "Cannot get stream file's first packet's header and context fields (`{}`).", path
);
490 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
, props
.stream_class_id
);
492 stream_instance_id
= props
.data_stream_id
;
494 if (props
.snapshots
.beginning_clock
!= UINT64_C(-1)) {
495 BT_ASSERT(sc
->default_clock_class
);
496 ret
= bt_util_clock_cycles_to_ns_from_origin(
497 props
.snapshots
.beginning_clock
, sc
->default_clock_class
->frequency
,
498 sc
->default_clock_class
->offset_seconds
, sc
->default_clock_class
->offset_cycles
,
501 BT_CPPLOGE_APPEND_CAUSE_SPEC(
502 ctf_fs_trace
->logger
,
503 "Cannot convert clock cycles to nanoseconds from origin (`{}`).", path
);
508 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
);
513 index
= ctf_fs_ds_file_build_index(ds_file
.get(), ds_file_info
.get(), msg_iter
.get());
515 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to index CTF stream file \'{}\'",
516 ds_file
->file
->path
);
520 if (begin_ns
== -1) {
522 * No beginning timestamp to sort the stream files
523 * within a stream file group, so consider that this
524 * file must be the only one within its group.
526 stream_instance_id
= -1;
529 if (stream_instance_id
== -1) {
531 * No stream instance ID or no beginning timestamp:
532 * create a unique stream file group for this stream
533 * file because, even if there's a stream instance ID,
534 * there's no timestamp to order the file within its
538 ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, UINT64_C(-1), std::move(index
));
540 if (!new_ds_file_group
) {
544 ds_file_group_insert_ds_file_info_sorted(new_ds_file_group
.get(), std::move(ds_file_info
));
545 ctf_fs_trace
->ds_file_groups
.emplace_back(std::move(new_ds_file_group
));
549 BT_ASSERT(stream_instance_id
!= -1);
550 BT_ASSERT(begin_ns
!= -1);
552 /* Find an existing stream file group with this ID */
553 for (const auto& candidate
: ctf_fs_trace
->ds_file_groups
) {
554 if (candidate
->sc
== sc
&& candidate
->stream_id
== stream_instance_id
) {
555 ds_file_group
= candidate
.get();
560 if (!ds_file_group
) {
562 ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, stream_instance_id
, std::move(index
));
563 if (!new_ds_file_group
) {
567 ds_file_group
= new_ds_file_group
.get();
568 ctf_fs_trace
->ds_file_groups
.emplace_back(std::move(new_ds_file_group
));
570 merge_ctf_fs_ds_indexes(ds_file_group
->index
.get(), std::move(index
));
573 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, std::move(ds_file_info
));
584 static int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
587 const char *basename
;
588 GError
*error
= NULL
;
590 /* Check each file in the path directory, except specific ones */
591 const bt2c::GDirUP dir
{g_dir_open(ctf_fs_trace
->path
.c_str(), 0, &error
)};
593 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
594 "Cannot open directory `{}`: {} (code {})", ctf_fs_trace
->path
,
595 error
->message
, error
->code
);
599 while ((basename
= g_dir_read_name(dir
.get()))) {
600 if (strcmp(basename
, CTF_FS_METADATA_FILENAME
) == 0) {
601 /* Ignore the metadata stream. */
602 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
603 "Ignoring metadata file `{}" G_DIR_SEPARATOR_S
"{}`",
604 ctf_fs_trace
->path
, basename
);
608 if (basename
[0] == '.') {
609 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
610 "Ignoring hidden file `{}" G_DIR_SEPARATOR_S
"{}`", ctf_fs_trace
->path
,
615 /* Create the file. */
616 const auto file
= ctf_fs_file_create(ctf_fs_trace
->logger
);
618 BT_CPPLOGE_APPEND_CAUSE_SPEC(
619 ctf_fs_trace
->logger
,
620 "Cannot create stream file object for file `{}" G_DIR_SEPARATOR_S
"{}`",
621 ctf_fs_trace
->path
, basename
);
625 /* Create full path string. */
626 file
->path
= fmt::format("{}" G_DIR_SEPARATOR_S
"{}", ctf_fs_trace
->path
, basename
);
628 if (!g_file_test(file
->path
.c_str(), G_FILE_TEST_IS_REGULAR
)) {
629 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring non-regular file `{}`", file
->path
);
633 ret
= ctf_fs_file_open(file
.get(), "rb");
635 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Cannot open stream file `{}`",
640 if (file
->size
== 0) {
641 /* Skip empty stream. */
642 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring empty file `{}`", file
->path
);
646 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
, file
->path
.c_str());
648 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
649 "Cannot add stream file `{}` to stream file group",
668 static int set_trace_name(bt_trace
*trace
, const char *name_suffix
)
675 * Check if we have a trace environment string value named `hostname`.
676 * If so, use it as the trace name's prefix.
678 val
= bt_trace_borrow_environment_entry_value_by_name_const(trace
, "hostname");
679 if (val
&& bt_value_is_string(val
)) {
680 name
+= bt_value_string_get(val
);
683 name
+= G_DIR_SEPARATOR
;
691 ret
= bt_trace_set_name(trace
, name
.c_str());
702 static ctf_fs_trace::UP
ctf_fs_trace_create(const char *path
, const char *name
,
703 const ctf::src::ClkClsCfg
& clkClsCfg
,
704 bt_self_component
*selfComp
,
705 const bt2c::Logger
& parentLogger
)
708 ctf_fs_trace::UP ctf_fs_trace
{new struct ctf_fs_trace(parentLogger
)};
710 ctf_fs_trace
->path
= path
;
711 ctf_fs_trace
->metadata
= bt2s::make_unique
<ctf_fs_metadata
>();
713 ret
= ctf_fs_metadata_set_trace_class(selfComp
, ctf_fs_trace
.get(), clkClsCfg
);
718 if (ctf_fs_trace
->metadata
->trace_class
) {
719 bt_trace
*trace
= bt_trace_create(ctf_fs_trace
->metadata
->trace_class
->libObjPtr());
724 ctf_fs_trace
->trace
= bt2::Trace::Shared::createWithoutRef(trace
);
727 if (ctf_fs_trace
->trace
) {
728 ret
= ctf_trace_class_configure_ir_trace(ctf_fs_trace
->metadata
->tc
,
729 ctf_fs_trace
->trace
->libObjPtr());
734 ret
= set_trace_name(ctf_fs_trace
->trace
->libObjPtr(), name
);
740 ret
= create_ds_file_groups(ctf_fs_trace
.get());
748 ctf_fs_trace
.reset();
754 static int path_is_ctf_trace(const char *path
)
756 return g_file_test(fmt::format("{}" G_DIR_SEPARATOR_S CTF_FS_METADATA_FILENAME
, path
).c_str(),
757 G_FILE_TEST_IS_REGULAR
);
760 /* Helper for ctf_fs_component_create_ctf_fs_trace, to handle a single path. */
762 static int ctf_fs_component_create_ctf_fs_trace_one_path(struct ctf_fs_component
*ctf_fs
,
763 const char *path_param
,
764 const char *trace_name
,
765 std::vector
<ctf_fs_trace::UP
>& traces
,
766 bt_self_component
*selfComp
)
768 ctf_fs_trace::UP ctf_fs_trace
;
771 bt2c::GStringUP norm_path
{bt_common_normalize_path(path_param
, NULL
)};
773 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to normalize path: `{}`.", path_param
);
777 ret
= path_is_ctf_trace(norm_path
->str
);
779 BT_CPPLOGE_APPEND_CAUSE_SPEC(
780 ctf_fs
->logger
, "Failed to check if path is a CTF trace: path={}", norm_path
->str
);
782 } else if (ret
== 0) {
783 BT_CPPLOGE_APPEND_CAUSE_SPEC(
784 ctf_fs
->logger
, "Path is not a CTF trace (does not contain a metadata file): `{}`.",
789 // FIXME: Remove or ifdef for __MINGW32__
790 if (strcmp(norm_path
->str
, "/") == 0) {
791 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Opening a trace in `/` is not supported.");
796 ctf_fs_trace
= ctf_fs_trace_create(norm_path
->str
, trace_name
, ctf_fs
->clkClsCfg
, selfComp
,
799 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create trace for `{}`.",
804 traces
.emplace_back(std::move(ctf_fs_trace
));
817 * Count the number of stream and event classes defined by this trace's metadata.
819 * This is used to determine which metadata is the "latest", out of multiple
820 * traces sharing the same UUID. It is assumed that amongst all these metadatas,
821 * a bigger metadata is a superset of a smaller metadata. Therefore, it is
822 * enough to just count the classes.
825 static unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace
*trace
)
827 unsigned int num
= trace
->metadata
->tc
->stream_classes
->len
;
830 for (i
= 0; i
< trace
->metadata
->tc
->stream_classes
->len
; i
++) {
831 struct ctf_stream_class
*sc
=
832 (struct ctf_stream_class
*) trace
->metadata
->tc
->stream_classes
->pdata
[i
];
833 num
+= sc
->event_classes
->len
;
840 * Merge the src ds_file_group into dest. This consists of merging their
841 * ds_file_infos, making sure to keep the result sorted.
844 static void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group
*dest
,
845 ctf_fs_ds_file_group::UP src
)
847 for (auto& ds_file_info
: src
->ds_file_infos
) {
848 ds_file_group_insert_ds_file_info_sorted(dest
, std::move(ds_file_info
));
851 /* Merge both indexes. */
852 merge_ctf_fs_ds_indexes(dest
->index
.get(), std::move(src
->index
));
855 /* Merge src_trace's data stream file groups into dest_trace's. */
857 static int merge_matching_ctf_fs_ds_file_groups(struct ctf_fs_trace
*dest_trace
,
858 ctf_fs_trace::UP src_trace
)
860 std::vector
<ctf_fs_ds_file_group::UP
>& dest
= dest_trace
->ds_file_groups
;
861 std::vector
<ctf_fs_ds_file_group::UP
>& src
= src_trace
->ds_file_groups
;
865 * Save the initial length of dest: we only want to check against the
866 * original elements in the inner loop.
868 size_t dest_len
= dest
.size();
870 for (auto& src_group
: src
) {
871 struct ctf_fs_ds_file_group
*dest_group
= NULL
;
873 /* A stream instance without ID can't match a stream in the other trace. */
874 if (src_group
->stream_id
!= -1) {
875 /* Let's search for a matching ds_file_group in the destination. */
876 for (size_t d_i
= 0; d_i
< dest_len
; ++d_i
) {
877 ctf_fs_ds_file_group
*candidate_dest
= dest
[d_i
].get();
879 /* Can't match a stream instance without ID. */
880 if (candidate_dest
->stream_id
== -1) {
885 * If the two groups have the same stream instance id
886 * and belong to the same stream class (stream instance
887 * ids are per-stream class), they represent the same
890 if (candidate_dest
->stream_id
!= src_group
->stream_id
||
891 candidate_dest
->sc
->id
!= src_group
->sc
->id
) {
895 dest_group
= candidate_dest
;
901 * Didn't find a friend in dest to merge our src_group into?
902 * Create a new empty one. This can happen if a stream was
903 * active in the source trace chunk but not in the destination
907 struct ctf_stream_class
*sc
;
909 sc
= ctf_trace_class_borrow_stream_class_by_id(dest_trace
->metadata
->tc
,
913 auto index
= ctf_fs_ds_index_create();
919 auto new_dest_group
=
920 ctf_fs_ds_file_group_create(dest_trace
, sc
, src_group
->stream_id
, std::move(index
));
922 if (!new_dest_group
) {
927 dest_group
= new_dest_group
.get();
928 dest_trace
->ds_file_groups
.emplace_back(std::move(new_dest_group
));
931 BT_ASSERT(dest_group
);
932 merge_ctf_fs_ds_file_groups(dest_group
, std::move(src_group
));
940 * Collapse the given traces, which must all share the same UUID, in a single
943 * The trace with the most expansive metadata is chosen and all other traces
944 * are merged into that one. On return, the elements of `traces` are nullptr
945 * and the merged trace is placed in `out_trace`.
948 static int merge_ctf_fs_traces(std::vector
<ctf_fs_trace::UP
> traces
, ctf_fs_trace::UP
& out_trace
)
950 unsigned int winner_count
;
951 struct ctf_fs_trace
*winner
;
955 BT_ASSERT(traces
.size() >= 2);
957 winner_count
= metadata_count_stream_and_event_classes(traces
[0].get());
958 winner
= traces
[0].get();
961 /* Find the trace with the largest metadata. */
962 for (i
= 1; i
< traces
.size(); i
++) {
963 ctf_fs_trace
*candidate
= traces
[i
].get();
964 unsigned int candidate_count
;
966 /* A bit of sanity check. */
967 BT_ASSERT(bt_uuid_compare(winner
->metadata
->tc
->uuid
, candidate
->metadata
->tc
->uuid
) == 0);
969 candidate_count
= metadata_count_stream_and_event_classes(candidate
);
971 if (candidate_count
> winner_count
) {
972 winner_count
= candidate_count
;
978 /* Merge all the other traces in the winning trace. */
979 for (ctf_fs_trace::UP
& trace
: traces
) {
980 /* Don't merge the winner into itself. */
981 if (trace
.get() == winner
) {
985 /* Merge trace's data stream file groups into winner's. */
986 ret
= merge_matching_ctf_fs_ds_file_groups(winner
, std::move(trace
));
993 * Move the winner out of the array, into `*out_trace`.
995 out_trace
= std::move(traces
[winner_i
]);
1007 static int decode_clock_snapshot_after_event(struct ctf_fs_trace
*ctf_fs_trace
,
1008 struct ctf_clock_class
*default_cc
,
1009 struct ctf_fs_ds_index_entry
*index_entry
,
1010 enum target_event target_event
, uint64_t *cs
,
1013 enum ctf_msg_iter_status iter_status
= CTF_MSG_ITER_STATUS_OK
;
1014 ctf_msg_iter_up msg_iter
;
1017 BT_ASSERT(ctf_fs_trace
);
1018 BT_ASSERT(index_entry
);
1019 BT_ASSERT(index_entry
->path
);
1021 const auto ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, bt2::Stream::Shared
{},
1022 index_entry
->path
, ctf_fs_trace
->logger
);
1024 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to create a ctf_fs_ds_file");
1029 BT_ASSERT(ctf_fs_trace
->metadata
);
1030 BT_ASSERT(ctf_fs_trace
->metadata
->tc
);
1032 msg_iter
= ctf_msg_iter_create(
1033 ctf_fs_trace
->metadata
->tc
,
1034 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
1035 ctf_fs_ds_file_medops
, ds_file
.get(), NULL
, ctf_fs_trace
->logger
);
1037 /* ctf_msg_iter_create() logs errors. */
1043 * Turn on dry run mode to prevent the creation and usage of Babeltrace
1044 * library objects (bt_field, bt_message_*, etc.).
1046 ctf_msg_iter_set_dry_run(msg_iter
.get(), true);
1048 /* Seek to the beginning of the target packet. */
1049 iter_status
= ctf_msg_iter_seek(msg_iter
.get(), index_entry
->offset
.bytes());
1051 /* ctf_msg_iter_seek() logs errors. */
1056 switch (target_event
) {
1059 * Start to decode the packet until we reach the end of
1060 * the first event. To extract the first event's clock
1063 iter_status
= ctf_msg_iter_curr_packet_first_event_clock_snapshot(msg_iter
.get(), cs
);
1066 /* Decode the packet to extract the last event's clock snapshot. */
1067 iter_status
= ctf_msg_iter_curr_packet_last_event_clock_snapshot(msg_iter
.get(), cs
);
1077 /* Convert clock snapshot to timestamp. */
1078 ret
= bt_util_clock_cycles_to_ns_from_origin(
1079 *cs
, default_cc
->frequency
, default_cc
->offset_seconds
, default_cc
->offset_cycles
, ts_ns
);
1081 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1082 "Failed to convert clock snapshot to timestamp");
1090 static int decode_packet_first_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1091 struct ctf_clock_class
*default_cc
,
1092 struct ctf_fs_ds_index_entry
*index_entry
,
1093 uint64_t *cs
, int64_t *ts_ns
)
1095 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, FIRST_EVENT
, cs
,
1099 static int decode_packet_last_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1100 struct ctf_clock_class
*default_cc
,
1101 struct ctf_fs_ds_index_entry
*index_entry
,
1102 uint64_t *cs
, int64_t *ts_ns
)
1104 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, LAST_EVENT
, cs
,
1109 * Fix up packet index entries for lttng's "event-after-packet" bug.
1110 * Some buggy lttng tracer versions may emit events with a timestamp that is
1111 * larger (after) than the timestamp_end of the their packets.
1113 * To fix up this erroneous data we do the following:
1114 * 1. If it's not the stream file's last packet: set the packet index entry's
1115 * end time to the next packet's beginning time.
1116 * 2. If it's the stream file's last packet, set the packet index entry's end
1117 * time to the packet's last event's time, if any, or to the packet's
1118 * beginning time otherwise.
1120 * Known buggy tracer versions:
1121 * - before lttng-ust 2.11.0
1122 * - before lttng-module 2.11.0
1123 * - before lttng-module 2.10.10
1124 * - before lttng-module 2.9.13
1126 static int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace
*trace
)
1130 for (const auto& ds_file_group
: trace
->ds_file_groups
) {
1131 struct ctf_clock_class
*default_cc
;
1133 BT_ASSERT(ds_file_group
);
1134 const auto index
= ds_file_group
->index
.get();
1137 BT_ASSERT(!index
->entries
.empty());
1140 * Iterate over all entries but the last one. The last one is
1141 * fixed differently after.
1143 for (size_t entry_i
= 0; entry_i
< index
->entries
.size() - 1; ++entry_i
) {
1144 ctf_fs_ds_index_entry
*curr_entry
= index
->entries
[entry_i
].get();
1145 ctf_fs_ds_index_entry
*next_entry
= index
->entries
[entry_i
+ 1].get();
1148 * 1. Set the current index entry `end` timestamp to
1149 * the next index entry `begin` timestamp.
1151 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1152 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1156 * 2. Fix the last entry by decoding the last event of the last
1159 const auto last_entry
= index
->entries
.back().get();
1160 BT_ASSERT(last_entry
);
1162 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1163 default_cc
= ds_file_group
->sc
->default_clock_class
;
1166 * Decode packet to read the timestamp of the last event of the
1169 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1170 &last_entry
->timestamp_end
,
1171 &last_entry
->timestamp_end_ns
);
1173 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1175 "Failed to decode stream's last packet to get its last event's clock snapshot.");
1185 * Fix up packet index entries for barectf's "event-before-packet" bug.
1186 * Some buggy barectf tracer versions may emit events with a timestamp that is
1187 * less than the timestamp_begin of the their packets.
1189 * To fix up this erroneous data we do the following:
1190 * 1. Starting at the second index entry, set the timestamp_begin of the
1191 * current entry to the timestamp of the first event of the packet.
1192 * 2. Set the previous entry's timestamp_end to the timestamp_begin of the
1195 * Known buggy tracer versions:
1196 * - before barectf 2.3.1
1198 static int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace
*trace
)
1202 for (const auto& ds_file_group
: trace
->ds_file_groups
) {
1203 struct ctf_clock_class
*default_cc
;
1204 const auto index
= ds_file_group
->index
.get();
1207 BT_ASSERT(!index
->entries
.empty());
1209 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1210 default_cc
= ds_file_group
->sc
->default_clock_class
;
1213 * 1. Iterate over the index, starting from the second entry
1216 for (size_t entry_i
= 1; entry_i
< index
->entries
.size(); ++entry_i
) {
1217 ctf_fs_ds_index_entry
*prev_entry
= index
->entries
[entry_i
- 1].get();
1218 ctf_fs_ds_index_entry
*curr_entry
= index
->entries
[entry_i
].get();
1220 * 2. Set the current entry `begin` timestamp to the
1221 * timestamp of the first event of the current packet.
1223 ret
= decode_packet_first_event_timestamp(trace
, default_cc
, curr_entry
,
1224 &curr_entry
->timestamp_begin
,
1225 &curr_entry
->timestamp_begin_ns
);
1227 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1228 "Failed to decode first event's clock snapshot");
1233 * 3. Set the previous entry `end` timestamp to the
1234 * timestamp of the first event of the current packet.
1236 prev_entry
->timestamp_end
= curr_entry
->timestamp_begin
;
1237 prev_entry
->timestamp_end_ns
= curr_entry
->timestamp_begin_ns
;
1245 * When using the lttng-crash feature it's likely that the last packets of each
1246 * stream have their timestamp_end set to zero. This is caused by the fact that
1247 * the tracer crashed and was not able to properly close the packets.
1249 * To fix up this erroneous data we do the following:
1250 * For each index entry, if the entry's timestamp_end is 0 and the
1251 * timestamp_begin is not 0:
1252 * - If it's the stream file's last packet: set the packet index entry's end
1253 * time to the packet's last event's time, if any, or to the packet's
1254 * beginning time otherwise.
1255 * - If it's not the stream file's last packet: set the packet index
1256 * entry's end time to the next packet's beginning time.
1258 * Affected versions:
1259 * - All current and future lttng-ust and lttng-modules versions.
1261 static int fix_index_lttng_crash_quirk(struct ctf_fs_trace
*trace
)
1265 for (const auto& ds_file_group
: trace
->ds_file_groups
) {
1266 struct ctf_clock_class
*default_cc
;
1268 BT_ASSERT(ds_file_group
);
1269 const auto index
= ds_file_group
->index
.get();
1271 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1272 default_cc
= ds_file_group
->sc
->default_clock_class
;
1275 BT_ASSERT(!index
->entries
.empty());
1277 const auto last_entry
= index
->entries
.back().get();
1278 BT_ASSERT(last_entry
);
1280 /* 1. Fix the last entry first. */
1281 if (last_entry
->timestamp_end
== 0 && last_entry
->timestamp_begin
!= 0) {
1283 * Decode packet to read the timestamp of the
1284 * last event of the stream file.
1286 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1287 &last_entry
->timestamp_end
,
1288 &last_entry
->timestamp_end_ns
);
1290 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1291 "Failed to decode last event's clock snapshot");
1296 /* Iterate over all entries but the last one. */
1297 for (size_t entry_idx
= 0; entry_idx
< index
->entries
.size() - 1; ++entry_idx
) {
1298 ctf_fs_ds_index_entry
*curr_entry
= index
->entries
[entry_idx
].get();
1299 ctf_fs_ds_index_entry
*next_entry
= index
->entries
[entry_idx
+ 1].get();
1301 if (curr_entry
->timestamp_end
== 0 && curr_entry
->timestamp_begin
!= 0) {
1303 * 2. Set the current index entry `end` timestamp to
1304 * the next index entry `begin` timestamp.
1306 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1307 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1317 * Extract the tracer information necessary to compare versions.
1318 * Returns 0 on success, and -1 if the extraction is not successful because the
1319 * necessary fields are absents in the trace metadata.
1321 static int extract_tracer_info(struct ctf_fs_trace
*trace
, struct tracer_info
*current_tracer_info
)
1324 struct ctf_trace_class_env_entry
*entry
;
1326 /* Clear the current_tracer_info struct */
1327 memset(current_tracer_info
, 0, sizeof(*current_tracer_info
));
1330 * To compare 2 tracer versions, at least the tracer name and it's
1331 * major version are needed. If one of these is missing, consider it an
1332 * extraction failure.
1334 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_name");
1335 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR
) {
1336 goto missing_bare_minimum
;
1339 /* Set tracer name. */
1340 current_tracer_info
->name
= entry
->value
.str
->str
;
1342 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_major");
1343 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1344 goto missing_bare_minimum
;
1347 /* Set major version number. */
1348 current_tracer_info
->major
= entry
->value
.i
;
1350 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_minor");
1351 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1355 /* Set minor version number. */
1356 current_tracer_info
->minor
= entry
->value
.i
;
1358 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patch");
1361 * If `tracer_patch` doesn't exist `tracer_patchlevel` might.
1362 * For example, `lttng-modules` uses entry name
1363 * `tracer_patchlevel`.
1365 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patchlevel");
1368 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1372 /* Set patch version number. */
1373 current_tracer_info
->patch
= entry
->value
.i
;
1377 missing_bare_minimum
:
1383 static bool is_tracer_affected_by_lttng_event_after_packet_bug(struct tracer_info
*curr_tracer_info
)
1385 bool is_affected
= false;
1387 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1388 if (curr_tracer_info
->major
< 2) {
1390 } else if (curr_tracer_info
->major
== 2) {
1391 /* fixed in lttng-ust 2.11.0 */
1392 if (curr_tracer_info
->minor
< 11) {
1396 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1397 if (curr_tracer_info
->major
< 2) {
1399 } else if (curr_tracer_info
->major
== 2) {
1400 /* fixed in lttng-modules 2.11.0 */
1401 if (curr_tracer_info
->minor
== 10) {
1402 /* fixed in lttng-modules 2.10.10 */
1403 if (curr_tracer_info
->patch
< 10) {
1406 } else if (curr_tracer_info
->minor
== 9) {
1407 /* fixed in lttng-modules 2.9.13 */
1408 if (curr_tracer_info
->patch
< 13) {
1411 } else if (curr_tracer_info
->minor
< 9) {
1421 is_tracer_affected_by_barectf_event_before_packet_bug(struct tracer_info
*curr_tracer_info
)
1423 bool is_affected
= false;
1425 if (strcmp(curr_tracer_info
->name
, "barectf") == 0) {
1426 if (curr_tracer_info
->major
< 2) {
1428 } else if (curr_tracer_info
->major
== 2) {
1429 if (curr_tracer_info
->minor
< 3) {
1431 } else if (curr_tracer_info
->minor
== 3) {
1432 /* fixed in barectf 2.3.1 */
1433 if (curr_tracer_info
->patch
< 1) {
1443 static bool is_tracer_affected_by_lttng_crash_quirk(struct tracer_info
*curr_tracer_info
)
1445 bool is_affected
= false;
1447 /* All LTTng tracer may be affected by this lttng crash quirk. */
1448 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1450 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1458 * Looks for trace produced by known buggy tracers and fix up the index
1461 static int fix_packet_index_tracer_bugs(ctf_fs_trace
*trace
)
1464 struct tracer_info current_tracer_info
;
1466 ret
= extract_tracer_info(trace
, ¤t_tracer_info
);
1469 * A trace may not have all the necessary environment
1470 * entries to do the tracer version comparison.
1471 * At least, the tracer name and major version number
1472 * are needed. Failing to extract these entries is not
1476 BT_CPPLOGI_STR_SPEC(
1478 "Cannot extract tracer information necessary to compare with buggy versions.");
1482 /* Check if the trace may be affected by old tracer bugs. */
1483 if (is_tracer_affected_by_lttng_event_after_packet_bug(¤t_tracer_info
)) {
1484 BT_CPPLOGI_STR_SPEC(
1486 "Trace may be affected by LTTng tracer packet timestamp bug. Fixing up.");
1487 ret
= fix_index_lttng_event_after_packet_bug(trace
);
1489 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1490 "Failed to fix LTTng event-after-packet bug.");
1493 trace
->metadata
->tc
->quirks
.lttng_event_after_packet
= true;
1496 if (is_tracer_affected_by_barectf_event_before_packet_bug(¤t_tracer_info
)) {
1497 BT_CPPLOGI_STR_SPEC(
1499 "Trace may be affected by barectf tracer packet timestamp bug. Fixing up.");
1500 ret
= fix_index_barectf_event_before_packet_bug(trace
);
1502 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1503 "Failed to fix barectf event-before-packet bug.");
1506 trace
->metadata
->tc
->quirks
.barectf_event_before_packet
= true;
1509 if (is_tracer_affected_by_lttng_crash_quirk(¤t_tracer_info
)) {
1510 ret
= fix_index_lttng_crash_quirk(trace
);
1512 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1513 "Failed to fix lttng-crash timestamp quirks.");
1516 trace
->metadata
->tc
->quirks
.lttng_crash
= true;
1523 static bool compare_ds_file_groups_by_first_path(const ctf_fs_ds_file_group::UP
& ds_file_group_a
,
1524 const ctf_fs_ds_file_group::UP
& ds_file_group_b
)
1526 BT_ASSERT(!ds_file_group_a
->ds_file_infos
.empty());
1527 BT_ASSERT(!ds_file_group_b
->ds_file_infos
.empty());
1529 const auto& first_ds_file_info_a
= *ds_file_group_a
->ds_file_infos
[0];
1530 const auto& first_ds_file_info_b
= *ds_file_group_b
->ds_file_infos
[0];
1532 return first_ds_file_info_a
.path
< first_ds_file_info_b
.path
;
1535 int ctf_fs_component_create_ctf_fs_trace(struct ctf_fs_component
*ctf_fs
,
1536 const bt_value
*paths_value
,
1537 const bt_value
*trace_name_value
,
1538 bt_self_component
*selfComp
)
1541 std::vector
<std::string
> paths
;
1542 std::vector
<ctf_fs_trace::UP
> traces
;
1543 const char *trace_name
;
1545 BT_ASSERT(bt_value_get_type(paths_value
) == BT_VALUE_TYPE_ARRAY
);
1546 BT_ASSERT(!bt_value_array_is_empty(paths_value
));
1548 trace_name
= trace_name_value
? bt_value_string_get(trace_name_value
) : NULL
;
1551 * Create a sorted array of the paths, to make the execution of this
1552 * component deterministic.
1554 for (std::uint64_t i
= 0; i
< bt_value_array_get_length(paths_value
); i
++) {
1555 const bt_value
*path_value
= bt_value_array_borrow_element_by_index_const(paths_value
, i
);
1556 const char *input
= bt_value_string_get(path_value
);
1557 paths
.emplace_back(input
);
1560 std::sort(paths
.begin(), paths
.end());
1562 /* Create a separate ctf_fs_trace object for each path. */
1563 for (const auto& path
: paths
) {
1564 ret
= ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs
, path
.c_str(), trace_name
,
1571 if (traces
.size() > 1) {
1572 ctf_fs_trace
*first_trace
= traces
[0].get();
1573 const uint8_t *first_trace_uuid
= first_trace
->metadata
->tc
->uuid
;
1576 * We have more than one trace, they must all share the same
1577 * UUID, verify that.
1579 for (size_t i
= 0; i
< traces
.size(); i
++) {
1580 ctf_fs_trace
*this_trace
= traces
[i
].get();
1581 const uint8_t *this_trace_uuid
= this_trace
->metadata
->tc
->uuid
;
1583 if (!this_trace
->metadata
->tc
->is_uuid_set
) {
1584 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1586 "Multiple traces given, but a trace does not have a UUID: path={}",
1591 if (bt_uuid_compare(first_trace_uuid
, this_trace_uuid
) != 0) {
1592 char first_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1593 char this_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1595 bt_uuid_to_str(first_trace_uuid
, first_trace_uuid_str
);
1596 bt_uuid_to_str(this_trace_uuid
, this_trace_uuid_str
);
1598 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1599 "Multiple traces given, but UUIDs don't match: "
1600 "first-trace-uuid={}, first-trace-path={}, "
1601 "trace-uuid={}, trace-path={}",
1602 first_trace_uuid_str
, first_trace
->path
,
1603 this_trace_uuid_str
, this_trace
->path
);
1608 ret
= merge_ctf_fs_traces(std::move(traces
), ctf_fs
->trace
);
1610 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1611 "Failed to merge traces with the same UUID.");
1615 /* Just one trace, it may or may not have a UUID, both are fine. */
1616 ctf_fs
->trace
= std::move(traces
[0]);
1619 ret
= fix_packet_index_tracer_bugs(ctf_fs
->trace
.get());
1621 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to fix packet index tracer bugs.");
1625 * Sort data stream file groups by first data stream file info
1626 * path to get a deterministic order. This order influences the
1627 * order of the output ports. It also influences the order of
1628 * the automatic stream IDs if the trace's packet headers do not
1629 * contain a `stream_instance_id` field, in which case the data
1630 * stream file to stream ID association is always the same,
1631 * whatever the build and the system.
1633 * Having a deterministic order here can help debugging and
1636 std::sort(ctf_fs
->trace
->ds_file_groups
.begin(), ctf_fs
->trace
->ds_file_groups
.end(),
1637 compare_ds_file_groups_by_first_path
);
1647 static const std::string
&
1648 get_stream_instance_unique_name(struct ctf_fs_ds_file_group
*ds_file_group
)
1651 * The first (earliest) stream file's path is used as the stream's unique
1654 BT_ASSERT(!ds_file_group
->ds_file_infos
.empty());
1655 return ds_file_group
->ds_file_infos
[0]->path
;
1658 /* Create the IR stream objects for ctf_fs_trace. */
1660 static int create_streams_for_trace(struct ctf_fs_trace
*ctf_fs_trace
)
1664 for (const auto& ds_file_group
: ctf_fs_trace
->ds_file_groups
) {
1665 const std::string
& name
= get_stream_instance_unique_name(ds_file_group
.get());
1667 BT_ASSERT(ds_file_group
->sc
->ir_sc
);
1668 BT_ASSERT(ctf_fs_trace
->trace
);
1672 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
1673 /* No stream ID: use 0 */
1675 bt_stream_create_with_id(ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
->libObjPtr(),
1676 ctf_fs_trace
->next_stream_id
);
1677 ctf_fs_trace
->next_stream_id
++;
1679 /* Specific stream ID */
1681 bt_stream_create_with_id(ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
->libObjPtr(),
1682 (uint64_t) ds_file_group
->stream_id
);
1686 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1687 "Cannot create stream for DS file group: "
1688 "addr={}, stream-name=\"{}\"",
1689 fmt::ptr(ds_file_group
), name
);
1693 ds_file_group
->stream
= bt2::Stream::Shared::createWithoutRef(stream
);
1695 ret
= bt_stream_set_name(ds_file_group
->stream
->libObjPtr(), name
.c_str());
1697 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1698 "Cannot set stream's name: "
1699 "addr={}, stream-name=\"{}\"",
1700 fmt::ptr(ds_file_group
->stream
->libObjPtr()), name
);
1715 static const bt_param_validation_value_descr inputs_elem_descr
=
1716 bt_param_validation_value_descr::makeString();
1718 static bt_param_validation_map_value_entry_descr fs_params_entries_descr
[] = {
1719 {"inputs", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
1720 bt_param_validation_value_descr::makeArray(1, BT_PARAM_VALIDATION_INFINITE
,
1721 inputs_elem_descr
)},
1722 {"trace-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1723 bt_param_validation_value_descr::makeString()},
1724 {"clock-class-offset-s", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1725 bt_param_validation_value_descr::makeSignedInteger()},
1726 {"clock-class-offset-ns", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1727 bt_param_validation_value_descr::makeSignedInteger()},
1728 {"force-clock-class-origin-unix-epoch", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1729 bt_param_validation_value_descr::makeBool()},
1730 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
1732 bool read_src_fs_parameters(const bt_value
*params
, const bt_value
**inputs
,
1733 const bt_value
**trace_name
, struct ctf_fs_component
*ctf_fs
)
1736 const bt_value
*value
;
1737 enum bt_param_validation_status validate_value_status
;
1738 gchar
*error
= NULL
;
1740 validate_value_status
= bt_param_validation_validate(params
, fs_params_entries_descr
, &error
);
1741 if (validate_value_status
!= BT_PARAM_VALIDATION_STATUS_OK
) {
1742 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "{}", error
);
1747 /* inputs parameter */
1748 *inputs
= bt_value_map_borrow_entry_value_const(params
, "inputs");
1750 /* clock-class-offset-s parameter */
1751 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-s");
1753 ctf_fs
->clkClsCfg
.offsetSec
= bt_value_integer_signed_get(value
);
1756 /* clock-class-offset-ns parameter */
1757 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-ns");
1759 ctf_fs
->clkClsCfg
.offsetNanoSec
= bt_value_integer_signed_get(value
);
1762 /* force-clock-class-origin-unix-epoch parameter */
1763 value
= bt_value_map_borrow_entry_value_const(params
, "force-clock-class-origin-unix-epoch");
1765 ctf_fs
->clkClsCfg
.forceOriginIsUnixEpoch
= bt_value_bool_get(value
);
1768 /* trace-name parameter */
1769 *trace_name
= bt_value_map_borrow_entry_value_const(params
, "trace-name");
1778 static ctf_fs_component::UP
ctf_fs_create(const bt_value
*params
,
1779 bt_self_component_source
*self_comp_src
)
1781 const bt_value
*inputs_value
;
1782 const bt_value
*trace_name_value
;
1783 bt_self_component
*self_comp
= bt_self_component_source_as_self_component(self_comp_src
);
1785 ctf_fs_component::UP ctf_fs
= ctf_fs_component_create(
1786 bt2c::Logger
{bt2::SelfSourceComponent
{self_comp_src
}, "PLUGIN/SRC.CTF.FS/COMP"});
1791 if (!read_src_fs_parameters(params
, &inputs_value
, &trace_name_value
, ctf_fs
.get())) {
1795 if (ctf_fs_component_create_ctf_fs_trace(ctf_fs
.get(), inputs_value
, trace_name_value
,
1800 if (create_streams_for_trace(ctf_fs
->trace
.get())) {
1804 if (create_ports_for_trace(ctf_fs
.get(), ctf_fs
->trace
.get(), self_comp_src
)) {
1811 bt_component_class_initialize_method_status
ctf_fs_init(bt_self_component_source
*self_comp_src
,
1812 bt_self_component_source_configuration
*,
1813 const bt_value
*params
, void *)
1816 bt_component_class_initialize_method_status ret
=
1817 BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
1819 ctf_fs_component::UP ctf_fs
= ctf_fs_create(params
, self_comp_src
);
1821 ret
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1824 bt_self_component_set_data(bt_self_component_source_as_self_component(self_comp_src
),
1827 } catch (const std::bad_alloc
&) {
1828 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1829 } catch (const bt2::Error
&) {
1830 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1834 bt_component_class_query_method_status
ctf_fs_query(bt_self_component_class_source
*comp_class_src
,
1835 bt_private_query_executor
*priv_query_exec
,
1836 const char *object
, const bt_value
*params
,
1837 __attribute__((unused
)) void *method_data
,
1838 const bt_value
**result
)
1841 bt2c::Logger logger
{bt2::SelfComponentClass
{comp_class_src
},
1842 bt2::PrivateQueryExecutor
{priv_query_exec
},
1843 "PLUGIN/SRC.CTF.FS/QUERY"};
1844 bt2::ConstMapValue
paramsObj(params
);
1845 bt2::Value::Shared resultObj
;
1847 if (strcmp(object
, "metadata-info") == 0) {
1848 resultObj
= metadata_info_query(paramsObj
, logger
);
1849 } else if (strcmp(object
, "babeltrace.trace-infos") == 0) {
1850 resultObj
= trace_infos_query(paramsObj
, logger
);
1851 } else if (!strcmp(object
, "babeltrace.support-info")) {
1852 resultObj
= support_info_query(paramsObj
, logger
);
1854 BT_CPPLOGE_SPEC(logger
, "Unknown query object `{}`", object
);
1855 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;
1858 *result
= resultObj
.release().libObjPtr();
1860 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
1861 } catch (const std::bad_alloc
&) {
1862 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
1863 } catch (const bt2::Error
&) {
1864 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;