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 struct ctf_fs_msg_iter_data
*msg_iter_data
=
90 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(iterator
);
93 if (G_UNLIKELY(msg_iter_data
->next_saved_error
)) {
95 * Last time we were called, we hit an error but had some
96 * messages to deliver, so we stashed the error here. Return
99 BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(msg_iter_data
->next_saved_error
);
100 return msg_iter_data
->next_saved_status
;
103 bt_message_iterator_class_next_method_status 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
;
142 } catch (const std::bad_alloc
&) {
143 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
144 } catch (const bt2::Error
&) {
145 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
149 bt_message_iterator_class_seek_beginning_method_status
150 ctf_fs_iterator_seek_beginning(bt_self_message_iterator
*it
)
153 struct ctf_fs_msg_iter_data
*msg_iter_data
=
154 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(it
);
156 BT_ASSERT(msg_iter_data
);
158 ctf_msg_iter_reset(msg_iter_data
->msg_iter
.get());
159 ctf_fs_ds_group_medops_data_reset(msg_iter_data
->msg_iter_medops_data
.get());
161 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_OK
;
162 } catch (const std::bad_alloc
&) {
163 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_MEMORY_ERROR
;
164 } catch (const bt2::Error
&) {
165 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_ERROR
;
169 void ctf_fs_iterator_finalize(bt_self_message_iterator
*it
)
171 ctf_fs_msg_iter_data::UP
{
172 (static_cast<ctf_fs_msg_iter_data
*>(bt_self_message_iterator_get_data(it
)))};
175 static bt_message_iterator_class_initialize_method_status
176 ctf_msg_iter_medium_status_to_msg_iter_initialize_status(enum ctf_msg_iter_medium_status status
)
179 case CTF_MSG_ITER_MEDIUM_STATUS_EOF
:
180 case CTF_MSG_ITER_MEDIUM_STATUS_AGAIN
:
181 case CTF_MSG_ITER_MEDIUM_STATUS_ERROR
:
182 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
183 case CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
:
184 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
185 case CTF_MSG_ITER_MEDIUM_STATUS_OK
:
186 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
192 bt_message_iterator_class_initialize_method_status
193 ctf_fs_iterator_init(bt_self_message_iterator
*self_msg_iter
,
194 bt_self_message_iterator_configuration
*config
,
195 bt_self_component_port_output
*self_port
)
198 struct ctf_fs_port_data
*port_data
;
199 enum ctf_msg_iter_medium_status medium_status
;
201 port_data
= (struct ctf_fs_port_data
*) bt_self_component_port_get_data(
202 bt_self_component_port_output_as_self_component_port(self_port
));
203 BT_ASSERT(port_data
);
205 auto msg_iter_data
= bt2s::make_unique
<ctf_fs_msg_iter_data
>(self_msg_iter
);
206 msg_iter_data
->ds_file_group
= port_data
->ds_file_group
;
208 medium_status
= ctf_fs_ds_group_medops_data_create(msg_iter_data
->ds_file_group
,
209 self_msg_iter
, msg_iter_data
->logger
,
210 msg_iter_data
->msg_iter_medops_data
);
211 BT_ASSERT(medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_OK
||
212 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_ERROR
||
213 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
);
214 if (medium_status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
215 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
216 "Failed to create ctf_fs_ds_group_medops");
217 return ctf_msg_iter_medium_status_to_msg_iter_initialize_status(medium_status
);
220 msg_iter_data
->msg_iter
= ctf_msg_iter_create(
221 msg_iter_data
->ds_file_group
->ctf_fs_trace
->metadata
->tc
,
222 bt_common_get_page_size(static_cast<int>(msg_iter_data
->logger
.level())) * 8,
223 ctf_fs_ds_group_medops
, msg_iter_data
->msg_iter_medops_data
.get(), self_msg_iter
,
224 msg_iter_data
->logger
);
225 if (!msg_iter_data
->msg_iter
) {
226 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
227 "Cannot create a CTF message iterator.");
228 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
232 * This iterator can seek forward if its stream class has a default
235 if (msg_iter_data
->ds_file_group
->sc
->default_clock_class
) {
236 bt_self_message_iterator_configuration_set_can_seek_forward(config
, true);
239 bt_self_message_iterator_set_data(self_msg_iter
, msg_iter_data
.release());
241 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
242 } catch (const std::bad_alloc
&) {
243 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
244 } catch (const bt2::Error
&) {
245 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
249 void ctf_fs_finalize(bt_self_component_source
*component
)
251 ctf_fs_component::UP
{static_cast<ctf_fs_component
*>(
252 bt_self_component_get_data(bt_self_component_source_as_self_component(component
)))};
255 std::string
ctf_fs_make_port_name(ctf_fs_ds_file_group
*ds_file_group
)
257 std::stringstream name
;
260 * The unique port name is generated by concatenating unique identifiers
268 /* For the trace, use the uuid if present, else the path. */
269 if (ds_file_group
->ctf_fs_trace
->metadata
->tc
->is_uuid_set
) {
270 char uuid_str
[BT_UUID_STR_LEN
+ 1];
272 bt_uuid_to_str(ds_file_group
->ctf_fs_trace
->metadata
->tc
->uuid
, uuid_str
);
275 name
<< ds_file_group
->ctf_fs_trace
->path
;
279 * For the stream class, use the id if present. We can omit this field
280 * otherwise, as there will only be a single stream class.
282 if (ds_file_group
->sc
->id
!= UINT64_C(-1)) {
283 name
<< " | " << ds_file_group
->sc
->id
;
286 /* For the stream, use the id if present, else, use the path. */
287 if (ds_file_group
->stream_id
!= UINT64_C(-1)) {
288 name
<< " | " << ds_file_group
->stream_id
;
290 BT_ASSERT(ds_file_group
->ds_file_infos
.size() == 1);
291 const auto& ds_file_info
= *ds_file_group
->ds_file_infos
[0];
292 name
<< " | " << ds_file_info
.path
;
298 static int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
299 struct ctf_fs_ds_file_group
*ds_file_group
,
300 bt_self_component_source
*self_comp_src
)
302 const auto port_name
= ctf_fs_make_port_name(ds_file_group
);
303 auto port_data
= bt2s::make_unique
<ctf_fs_port_data
>();
305 BT_CPPLOGI_SPEC(ctf_fs
->logger
, "Creating one port named `{}`", port_name
);
307 port_data
->ctf_fs
= ctf_fs
;
308 port_data
->ds_file_group
= ds_file_group
;
310 int ret
= bt_self_component_source_add_output_port(self_comp_src
, port_name
.c_str(),
311 port_data
.get(), NULL
);
316 ctf_fs
->port_data
.emplace_back(std::move(port_data
));
320 static int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
321 struct ctf_fs_trace
*ctf_fs_trace
,
322 bt_self_component_source
*self_comp_src
)
324 /* Create one output port for each stream file group */
325 for (const auto& ds_file_group
: ctf_fs_trace
->ds_file_groups
) {
326 int ret
= create_one_port_for_trace(ctf_fs
, ds_file_group
.get(), self_comp_src
);
328 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create output port.");
337 * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right
338 * place to keep it sorted.
341 static void ds_file_group_insert_ds_file_info_sorted(struct ctf_fs_ds_file_group
*ds_file_group
,
342 ctf_fs_ds_file_info::UP ds_file_info
)
344 /* Find the spot where to insert this ds_file_info. */
345 auto it
= ds_file_group
->ds_file_infos
.begin();
347 for (; it
!= ds_file_group
->ds_file_infos
.end(); ++it
) {
348 const ctf_fs_ds_file_info
& other_ds_file_info
= **it
;
350 if (ds_file_info
->begin_ns
< other_ds_file_info
.begin_ns
) {
355 ds_file_group
->ds_file_infos
.insert(it
, std::move(ds_file_info
));
358 static bool ds_index_entries_equal(const ctf_fs_ds_index_entry
& left
,
359 const ctf_fs_ds_index_entry
& right
)
361 if (left
.packetSize
!= right
.packetSize
) {
365 if (left
.timestamp_begin
!= right
.timestamp_begin
) {
369 if (left
.timestamp_end
!= right
.timestamp_end
) {
373 if (left
.packet_seq_num
!= right
.packet_seq_num
) {
381 * Insert `entry` into `index`, without duplication.
383 * The entry is inserted only if there isn't an identical entry already.
386 static void ds_index_insert_ds_index_entry_sorted(struct ctf_fs_ds_index
*index
,
387 const ctf_fs_ds_index_entry
& entry
)
389 /* Find the spot where to insert this index entry. */
390 auto otherEntry
= index
->entries
.begin();
391 for (; otherEntry
!= index
->entries
.end(); ++otherEntry
) {
392 if (entry
.timestamp_begin_ns
<= otherEntry
->timestamp_begin_ns
) {
398 * Insert the entry only if a duplicate doesn't already exist.
400 * There can be duplicate packets if reading multiple overlapping
401 * snapshots of the same trace. We then want the index to contain
402 * a reference to only one copy of that packet.
404 if (otherEntry
== index
->entries
.end() || !ds_index_entries_equal(entry
, *otherEntry
)) {
405 index
->entries
.emplace(otherEntry
, entry
);
409 static void merge_ctf_fs_ds_indexes(struct ctf_fs_ds_index
*dest
, const ctf_fs_ds_index
& src
)
411 for (const auto& entry
: src
.entries
) {
412 ds_index_insert_ds_index_entry_sorted(dest
, entry
);
416 static int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
, const char *path
)
418 int64_t stream_instance_id
= -1;
419 int64_t begin_ns
= -1;
420 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
421 ctf_fs_ds_file_group::UP new_ds_file_group
;
422 ctf_fs_ds_file_info::UP ds_file_info
;
423 ctf_msg_iter_up msg_iter
;
424 struct ctf_stream_class
*sc
= NULL
;
425 struct ctf_msg_iter_packet_properties props
;
428 * Create a temporary ds_file to read some properties about the data
432 ctf_fs_ds_file_create(ctf_fs_trace
, bt2::Stream::Shared
{}, path
, ctf_fs_trace
->logger
);
437 /* Create a temporary iterator to read the ds_file. */
438 msg_iter
= ctf_msg_iter_create(
439 ctf_fs_trace
->metadata
->tc
,
440 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
441 ctf_fs_ds_file_medops
, ds_file
.get(), nullptr, ctf_fs_trace
->logger
);
443 BT_CPPLOGE_STR_SPEC(ctf_fs_trace
->logger
, "Cannot create a CTF message iterator.");
447 ctf_msg_iter_set_dry_run(msg_iter
.get(), true);
449 int ret
= ctf_msg_iter_get_packet_properties(msg_iter
.get(), &props
);
451 BT_CPPLOGE_APPEND_CAUSE_SPEC(
452 ctf_fs_trace
->logger
,
453 "Cannot get stream file's first packet's header and context fields (`{}`).", path
);
457 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
, props
.stream_class_id
);
459 stream_instance_id
= props
.data_stream_id
;
461 if (props
.snapshots
.beginning_clock
!= UINT64_C(-1)) {
462 BT_ASSERT(sc
->default_clock_class
);
463 ret
= bt_util_clock_cycles_to_ns_from_origin(
464 props
.snapshots
.beginning_clock
, sc
->default_clock_class
->frequency
,
465 sc
->default_clock_class
->offset_seconds
, sc
->default_clock_class
->offset_cycles
,
468 BT_CPPLOGE_APPEND_CAUSE_SPEC(
469 ctf_fs_trace
->logger
,
470 "Cannot convert clock cycles to nanoseconds from origin (`{}`).", path
);
475 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
);
480 auto index
= ctf_fs_ds_file_build_index(ds_file
.get(), ds_file_info
.get(), msg_iter
.get());
482 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to index CTF stream file \'{}\'",
483 ds_file
->file
->path
);
487 if (begin_ns
== -1) {
489 * No beginning timestamp to sort the stream files
490 * within a stream file group, so consider that this
491 * file must be the only one within its group.
493 stream_instance_id
= -1;
496 if (stream_instance_id
== -1) {
498 * No stream instance ID or no beginning timestamp:
499 * create a unique stream file group for this stream
500 * file because, even if there's a stream instance ID,
501 * there's no timestamp to order the file within its
505 ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, UINT64_C(-1), std::move(*index
));
507 if (!new_ds_file_group
) {
511 ds_file_group_insert_ds_file_info_sorted(new_ds_file_group
.get(), std::move(ds_file_info
));
512 ctf_fs_trace
->ds_file_groups
.emplace_back(std::move(new_ds_file_group
));
516 BT_ASSERT(stream_instance_id
!= -1);
517 BT_ASSERT(begin_ns
!= -1);
519 /* Find an existing stream file group with this ID */
520 for (const auto& candidate
: ctf_fs_trace
->ds_file_groups
) {
521 if (candidate
->sc
== sc
&& candidate
->stream_id
== stream_instance_id
) {
522 ds_file_group
= candidate
.get();
527 if (!ds_file_group
) {
529 ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, stream_instance_id
, std::move(*index
));
530 if (!new_ds_file_group
) {
534 ds_file_group
= new_ds_file_group
.get();
535 ctf_fs_trace
->ds_file_groups
.emplace_back(std::move(new_ds_file_group
));
537 merge_ctf_fs_ds_indexes(&ds_file_group
->index
, *index
);
540 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, std::move(ds_file_info
));
545 static int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
547 const char *basename
;
548 GError
*error
= NULL
;
550 /* Check each file in the path directory, except specific ones */
551 const bt2c::GDirUP dir
{g_dir_open(ctf_fs_trace
->path
.c_str(), 0, &error
)};
553 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
554 "Cannot open directory `{}`: {} (code {})", ctf_fs_trace
->path
,
555 error
->message
, error
->code
);
562 while ((basename
= g_dir_read_name(dir
.get()))) {
563 if (strcmp(basename
, CTF_FS_METADATA_FILENAME
) == 0) {
564 /* Ignore the metadata stream. */
565 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
566 "Ignoring metadata file `{}" G_DIR_SEPARATOR_S
"{}`",
567 ctf_fs_trace
->path
, basename
);
571 if (basename
[0] == '.') {
572 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
573 "Ignoring hidden file `{}" G_DIR_SEPARATOR_S
"{}`", ctf_fs_trace
->path
,
578 /* Create the file. */
579 ctf_fs_file file
{ctf_fs_trace
->logger
};
581 /* Create full path string. */
582 file
.path
= fmt::format("{}" G_DIR_SEPARATOR_S
"{}", ctf_fs_trace
->path
, basename
);
584 if (!g_file_test(file
.path
.c_str(), G_FILE_TEST_IS_REGULAR
)) {
585 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring non-regular file `{}`", file
.path
);
589 int ret
= ctf_fs_file_open(&file
, "rb");
591 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Cannot open stream file `{}`",
596 if (file
.size
== 0) {
597 /* Skip empty stream. */
598 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring empty file `{}`", file
.path
);
602 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
, file
.path
.c_str());
604 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
605 "Cannot add stream file `{}` to stream file group",
614 static int set_trace_name(bt_trace
*trace
, const char *name_suffix
)
620 * Check if we have a trace environment string value named `hostname`.
621 * If so, use it as the trace name's prefix.
623 val
= bt_trace_borrow_environment_entry_value_by_name_const(trace
, "hostname");
624 if (val
&& bt_value_is_string(val
)) {
625 name
+= bt_value_string_get(val
);
628 name
+= G_DIR_SEPARATOR
;
636 return bt_trace_set_name(trace
, name
.c_str());
639 static ctf_fs_trace::UP
ctf_fs_trace_create(const char *path
, const char *name
,
640 const ctf::src::ClkClsCfg
& clkClsCfg
,
641 bt_self_component
*selfComp
,
642 const bt2c::Logger
& parentLogger
)
644 ctf_fs_trace::UP ctf_fs_trace
= bt2s::make_unique
<struct ctf_fs_trace
>(parentLogger
);
645 ctf_fs_trace
->path
= path
;
646 ctf_fs_trace
->metadata
= bt2s::make_unique
<ctf_fs_metadata
>();
648 int ret
= ctf_fs_metadata_set_trace_class(selfComp
, ctf_fs_trace
.get(), clkClsCfg
);
653 if (ctf_fs_trace
->metadata
->trace_class
) {
654 bt_trace
*trace
= bt_trace_create(ctf_fs_trace
->metadata
->trace_class
->libObjPtr());
659 ctf_fs_trace
->trace
= bt2::Trace::Shared::createWithoutRef(trace
);
662 if (ctf_fs_trace
->trace
) {
663 ret
= ctf_trace_class_configure_ir_trace(ctf_fs_trace
->metadata
->tc
,
664 ctf_fs_trace
->trace
->libObjPtr());
669 ret
= set_trace_name(ctf_fs_trace
->trace
->libObjPtr(), name
);
675 ret
= create_ds_file_groups(ctf_fs_trace
.get());
683 static int path_is_ctf_trace(const char *path
)
685 return g_file_test(fmt::format("{}" G_DIR_SEPARATOR_S CTF_FS_METADATA_FILENAME
, path
).c_str(),
686 G_FILE_TEST_IS_REGULAR
);
689 /* Helper for ctf_fs_component_create_ctf_fs_trace, to handle a single path. */
691 static int ctf_fs_component_create_ctf_fs_trace_one_path(struct ctf_fs_component
*ctf_fs
,
692 const char *path_param
,
693 const char *trace_name
,
694 std::vector
<ctf_fs_trace::UP
>& traces
,
695 bt_self_component
*selfComp
)
697 ctf_fs_trace::UP ctf_fs_trace
;
700 bt2c::GStringUP norm_path
{bt_common_normalize_path(path_param
, NULL
)};
702 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to normalize path: `{}`.", path_param
);
706 ret
= path_is_ctf_trace(norm_path
->str
);
708 BT_CPPLOGE_APPEND_CAUSE_SPEC(
709 ctf_fs
->logger
, "Failed to check if path is a CTF trace: path={}", norm_path
->str
);
711 } else if (ret
== 0) {
712 BT_CPPLOGE_APPEND_CAUSE_SPEC(
713 ctf_fs
->logger
, "Path is not a CTF trace (does not contain a metadata file): `{}`.",
718 // FIXME: Remove or ifdef for __MINGW32__
719 if (strcmp(norm_path
->str
, "/") == 0) {
720 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Opening a trace in `/` is not supported.");
724 ctf_fs_trace
= ctf_fs_trace_create(norm_path
->str
, trace_name
, ctf_fs
->clkClsCfg
, selfComp
,
727 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create trace for `{}`.",
732 traces
.emplace_back(std::move(ctf_fs_trace
));
738 * Count the number of stream and event classes defined by this trace's metadata.
740 * This is used to determine which metadata is the "latest", out of multiple
741 * traces sharing the same UUID. It is assumed that amongst all these metadatas,
742 * a bigger metadata is a superset of a smaller metadata. Therefore, it is
743 * enough to just count the classes.
746 static unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace
*trace
)
748 unsigned int num
= trace
->metadata
->tc
->stream_classes
->len
;
751 for (i
= 0; i
< trace
->metadata
->tc
->stream_classes
->len
; i
++) {
752 struct ctf_stream_class
*sc
=
753 (struct ctf_stream_class
*) trace
->metadata
->tc
->stream_classes
->pdata
[i
];
754 num
+= sc
->event_classes
->len
;
761 * Merge the src ds_file_group into dest. This consists of merging their
762 * ds_file_infos, making sure to keep the result sorted.
765 static void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group
*dest
,
766 ctf_fs_ds_file_group::UP src
)
768 for (auto& ds_file_info
: src
->ds_file_infos
) {
769 ds_file_group_insert_ds_file_info_sorted(dest
, std::move(ds_file_info
));
772 /* Merge both indexes. */
773 merge_ctf_fs_ds_indexes(&dest
->index
, src
->index
);
776 /* Merge src_trace's data stream file groups into dest_trace's. */
778 static int merge_matching_ctf_fs_ds_file_groups(struct ctf_fs_trace
*dest_trace
,
779 ctf_fs_trace::UP src_trace
)
781 std::vector
<ctf_fs_ds_file_group::UP
>& dest
= dest_trace
->ds_file_groups
;
782 std::vector
<ctf_fs_ds_file_group::UP
>& src
= src_trace
->ds_file_groups
;
785 * Save the initial length of dest: we only want to check against the
786 * original elements in the inner loop.
788 size_t dest_len
= dest
.size();
790 for (auto& src_group
: src
) {
791 struct ctf_fs_ds_file_group
*dest_group
= NULL
;
793 /* A stream instance without ID can't match a stream in the other trace. */
794 if (src_group
->stream_id
!= -1) {
795 /* Let's search for a matching ds_file_group in the destination. */
796 for (size_t d_i
= 0; d_i
< dest_len
; ++d_i
) {
797 ctf_fs_ds_file_group
*candidate_dest
= dest
[d_i
].get();
799 /* Can't match a stream instance without ID. */
800 if (candidate_dest
->stream_id
== -1) {
805 * If the two groups have the same stream instance id
806 * and belong to the same stream class (stream instance
807 * ids are per-stream class), they represent the same
810 if (candidate_dest
->stream_id
!= src_group
->stream_id
||
811 candidate_dest
->sc
->id
!= src_group
->sc
->id
) {
815 dest_group
= candidate_dest
;
821 * Didn't find a friend in dest to merge our src_group into?
822 * Create a new empty one. This can happen if a stream was
823 * active in the source trace chunk but not in the destination
827 struct ctf_stream_class
*sc
;
829 sc
= ctf_trace_class_borrow_stream_class_by_id(dest_trace
->metadata
->tc
,
833 auto new_dest_group
=
834 ctf_fs_ds_file_group_create(dest_trace
, sc
, src_group
->stream_id
, {});
836 if (!new_dest_group
) {
840 dest_group
= new_dest_group
.get();
841 dest_trace
->ds_file_groups
.emplace_back(std::move(new_dest_group
));
844 BT_ASSERT(dest_group
);
845 merge_ctf_fs_ds_file_groups(dest_group
, std::move(src_group
));
852 * Collapse the given traces, which must all share the same UUID, in a single
855 * The trace with the most expansive metadata is chosen and all other traces
856 * are merged into that one. On return, the elements of `traces` are nullptr
857 * and the merged trace is placed in `out_trace`.
860 static int merge_ctf_fs_traces(std::vector
<ctf_fs_trace::UP
> traces
, ctf_fs_trace::UP
& out_trace
)
862 unsigned int winner_count
;
863 struct ctf_fs_trace
*winner
;
866 BT_ASSERT(traces
.size() >= 2);
868 winner_count
= metadata_count_stream_and_event_classes(traces
[0].get());
869 winner
= traces
[0].get();
872 /* Find the trace with the largest metadata. */
873 for (i
= 1; i
< traces
.size(); i
++) {
874 ctf_fs_trace
*candidate
= traces
[i
].get();
875 unsigned int candidate_count
;
877 /* A bit of sanity check. */
878 BT_ASSERT(bt_uuid_compare(winner
->metadata
->tc
->uuid
, candidate
->metadata
->tc
->uuid
) == 0);
880 candidate_count
= metadata_count_stream_and_event_classes(candidate
);
882 if (candidate_count
> winner_count
) {
883 winner_count
= candidate_count
;
889 /* Merge all the other traces in the winning trace. */
890 for (ctf_fs_trace::UP
& trace
: traces
) {
891 /* Don't merge the winner into itself. */
892 if (trace
.get() == winner
) {
896 /* Merge trace's data stream file groups into winner's. */
897 int ret
= merge_matching_ctf_fs_ds_file_groups(winner
, std::move(trace
));
904 * Move the winner out of the array, into `*out_trace`.
906 out_trace
= std::move(traces
[winner_i
]);
917 static int decode_clock_snapshot_after_event(struct ctf_fs_trace
*ctf_fs_trace
,
918 struct ctf_clock_class
*default_cc
,
919 const ctf_fs_ds_index_entry
& index_entry
,
920 enum target_event target_event
, uint64_t *cs
,
923 enum ctf_msg_iter_status iter_status
= CTF_MSG_ITER_STATUS_OK
;
924 ctf_msg_iter_up msg_iter
;
926 BT_ASSERT(ctf_fs_trace
);
927 BT_ASSERT(index_entry
.path
);
929 const auto ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, bt2::Stream::Shared
{},
930 index_entry
.path
, ctf_fs_trace
->logger
);
932 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to create a ctf_fs_ds_file");
936 BT_ASSERT(ctf_fs_trace
->metadata
);
937 BT_ASSERT(ctf_fs_trace
->metadata
->tc
);
939 msg_iter
= ctf_msg_iter_create(
940 ctf_fs_trace
->metadata
->tc
,
941 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
942 ctf_fs_ds_file_medops
, ds_file
.get(), NULL
, ctf_fs_trace
->logger
);
944 /* ctf_msg_iter_create() logs errors. */
949 * Turn on dry run mode to prevent the creation and usage of Babeltrace
950 * library objects (bt_field, bt_message_*, etc.).
952 ctf_msg_iter_set_dry_run(msg_iter
.get(), true);
954 /* Seek to the beginning of the target packet. */
955 iter_status
= ctf_msg_iter_seek(msg_iter
.get(), index_entry
.offset
.bytes());
957 /* ctf_msg_iter_seek() logs errors. */
961 switch (target_event
) {
964 * Start to decode the packet until we reach the end of
965 * the first event. To extract the first event's clock
968 iter_status
= ctf_msg_iter_curr_packet_first_event_clock_snapshot(msg_iter
.get(), cs
);
971 /* Decode the packet to extract the last event's clock snapshot. */
972 iter_status
= ctf_msg_iter_curr_packet_last_event_clock_snapshot(msg_iter
.get(), cs
);
981 /* Convert clock snapshot to timestamp. */
982 int ret
= bt_util_clock_cycles_to_ns_from_origin(
983 *cs
, default_cc
->frequency
, default_cc
->offset_seconds
, default_cc
->offset_cycles
, ts_ns
);
985 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
986 "Failed to convert clock snapshot to timestamp");
993 static int decode_packet_first_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
994 struct ctf_clock_class
*default_cc
,
995 const ctf_fs_ds_index_entry
& index_entry
,
996 uint64_t *cs
, int64_t *ts_ns
)
998 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, FIRST_EVENT
, cs
,
1002 static int decode_packet_last_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1003 struct ctf_clock_class
*default_cc
,
1004 const ctf_fs_ds_index_entry
& index_entry
,
1005 uint64_t *cs
, int64_t *ts_ns
)
1007 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, LAST_EVENT
, cs
,
1012 * Fix up packet index entries for lttng's "event-after-packet" bug.
1013 * Some buggy lttng tracer versions may emit events with a timestamp that is
1014 * larger (after) than the timestamp_end of the their packets.
1016 * To fix up this erroneous data we do the following:
1017 * 1. If it's not the stream file's last packet: set the packet index entry's
1018 * end time to the next packet's beginning time.
1019 * 2. If it's the stream file's last packet, set the packet index entry's end
1020 * time to the packet's last event's time, if any, or to the packet's
1021 * beginning time otherwise.
1023 * Known buggy tracer versions:
1024 * - before lttng-ust 2.11.0
1025 * - before lttng-module 2.11.0
1026 * - before lttng-module 2.10.10
1027 * - before lttng-module 2.9.13
1029 static int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace
*trace
)
1031 for (const auto& ds_file_group
: trace
->ds_file_groups
) {
1032 struct ctf_clock_class
*default_cc
;
1034 BT_ASSERT(ds_file_group
);
1035 auto& index
= ds_file_group
->index
;
1037 BT_ASSERT(!index
.entries
.empty());
1040 * Iterate over all entries but the last one. The last one is
1041 * fixed differently after.
1043 for (size_t entry_i
= 0; entry_i
< index
.entries
.size() - 1; ++entry_i
) {
1044 auto& curr_entry
= index
.entries
[entry_i
];
1045 const auto& next_entry
= index
.entries
[entry_i
+ 1];
1048 * 1. Set the current index entry `end` timestamp to
1049 * the next index entry `begin` timestamp.
1051 curr_entry
.timestamp_end
= next_entry
.timestamp_begin
;
1052 curr_entry
.timestamp_end_ns
= next_entry
.timestamp_begin_ns
;
1056 * 2. Fix the last entry by decoding the last event of the last
1059 auto& last_entry
= index
.entries
.back();
1061 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1062 default_cc
= ds_file_group
->sc
->default_clock_class
;
1065 * Decode packet to read the timestamp of the last event of the
1068 int ret
= decode_packet_last_event_timestamp(
1069 trace
, default_cc
, last_entry
, &last_entry
.timestamp_end
, &last_entry
.timestamp_end_ns
);
1071 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1073 "Failed to decode stream's last packet to get its last event's clock snapshot.");
1082 * Fix up packet index entries for barectf's "event-before-packet" bug.
1083 * Some buggy barectf tracer versions may emit events with a timestamp that is
1084 * less than the timestamp_begin of the their packets.
1086 * To fix up this erroneous data we do the following:
1087 * 1. Starting at the second index entry, set the timestamp_begin of the
1088 * current entry to the timestamp of the first event of the packet.
1089 * 2. Set the previous entry's timestamp_end to the timestamp_begin of the
1092 * Known buggy tracer versions:
1093 * - before barectf 2.3.1
1095 static int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace
*trace
)
1097 for (const auto& ds_file_group
: trace
->ds_file_groups
) {
1098 struct ctf_clock_class
*default_cc
;
1099 auto& index
= ds_file_group
->index
;
1101 BT_ASSERT(!index
.entries
.empty());
1103 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1104 default_cc
= ds_file_group
->sc
->default_clock_class
;
1107 * 1. Iterate over the index, starting from the second entry
1110 for (size_t entry_i
= 1; entry_i
< index
.entries
.size(); ++entry_i
) {
1111 auto& prev_entry
= index
.entries
[entry_i
- 1];
1112 auto& curr_entry
= index
.entries
[entry_i
];
1114 * 2. Set the current entry `begin` timestamp to the
1115 * timestamp of the first event of the current packet.
1117 int ret
= decode_packet_first_event_timestamp(trace
, default_cc
, curr_entry
,
1118 &curr_entry
.timestamp_begin
,
1119 &curr_entry
.timestamp_begin_ns
);
1121 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1122 "Failed to decode first event's clock snapshot");
1127 * 3. Set the previous entry `end` timestamp to the
1128 * timestamp of the first event of the current packet.
1130 prev_entry
.timestamp_end
= curr_entry
.timestamp_begin
;
1131 prev_entry
.timestamp_end_ns
= curr_entry
.timestamp_begin_ns
;
1139 * When using the lttng-crash feature it's likely that the last packets of each
1140 * stream have their timestamp_end set to zero. This is caused by the fact that
1141 * the tracer crashed and was not able to properly close the packets.
1143 * To fix up this erroneous data we do the following:
1144 * For each index entry, if the entry's timestamp_end is 0 and the
1145 * timestamp_begin is not 0:
1146 * - If it's the stream file's last packet: set the packet index entry's end
1147 * time to the packet's last event's time, if any, or to the packet's
1148 * beginning time otherwise.
1149 * - If it's not the stream file's last packet: set the packet index
1150 * entry's end time to the next packet's beginning time.
1152 * Affected versions:
1153 * - All current and future lttng-ust and lttng-modules versions.
1155 static int fix_index_lttng_crash_quirk(struct ctf_fs_trace
*trace
)
1157 for (const auto& ds_file_group
: trace
->ds_file_groups
) {
1158 struct ctf_clock_class
*default_cc
;
1160 BT_ASSERT(ds_file_group
);
1161 auto& index
= ds_file_group
->index
;
1163 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1164 default_cc
= ds_file_group
->sc
->default_clock_class
;
1166 BT_ASSERT(!index
.entries
.empty());
1168 auto& last_entry
= index
.entries
.back();
1170 /* 1. Fix the last entry first. */
1171 if (last_entry
.timestamp_end
== 0 && last_entry
.timestamp_begin
!= 0) {
1173 * Decode packet to read the timestamp of the
1174 * last event of the stream file.
1176 int ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1177 &last_entry
.timestamp_end
,
1178 &last_entry
.timestamp_end_ns
);
1180 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1181 "Failed to decode last event's clock snapshot");
1186 /* Iterate over all entries but the last one. */
1187 for (size_t entry_idx
= 0; entry_idx
< index
.entries
.size() - 1; ++entry_idx
) {
1188 auto& curr_entry
= index
.entries
[entry_idx
];
1189 const auto& next_entry
= index
.entries
[entry_idx
+ 1];
1191 if (curr_entry
.timestamp_end
== 0 && curr_entry
.timestamp_begin
!= 0) {
1193 * 2. Set the current index entry `end` timestamp to
1194 * the next index entry `begin` timestamp.
1196 curr_entry
.timestamp_end
= next_entry
.timestamp_begin
;
1197 curr_entry
.timestamp_end_ns
= next_entry
.timestamp_begin_ns
;
1206 * Extract the tracer information necessary to compare versions.
1207 * Returns 0 on success, and -1 if the extraction is not successful because the
1208 * necessary fields are absents in the trace metadata.
1210 static int extract_tracer_info(struct ctf_fs_trace
*trace
, struct tracer_info
*current_tracer_info
)
1212 struct ctf_trace_class_env_entry
*entry
;
1214 /* Clear the current_tracer_info struct */
1215 memset(current_tracer_info
, 0, sizeof(*current_tracer_info
));
1218 * To compare 2 tracer versions, at least the tracer name and it's
1219 * major version are needed. If one of these is missing, consider it an
1220 * extraction failure.
1222 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_name");
1223 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR
) {
1227 /* Set tracer name. */
1228 current_tracer_info
->name
= entry
->value
.str
->str
;
1230 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_major");
1231 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1235 /* Set major version number. */
1236 current_tracer_info
->major
= entry
->value
.i
;
1238 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_minor");
1239 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1243 /* Set minor version number. */
1244 current_tracer_info
->minor
= entry
->value
.i
;
1246 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patch");
1249 * If `tracer_patch` doesn't exist `tracer_patchlevel` might.
1250 * For example, `lttng-modules` uses entry name
1251 * `tracer_patchlevel`.
1253 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patchlevel");
1256 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1260 /* Set patch version number. */
1261 current_tracer_info
->patch
= entry
->value
.i
;
1266 static bool is_tracer_affected_by_lttng_event_after_packet_bug(struct tracer_info
*curr_tracer_info
)
1268 bool is_affected
= false;
1270 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1271 if (curr_tracer_info
->major
< 2) {
1273 } else if (curr_tracer_info
->major
== 2) {
1274 /* fixed in lttng-ust 2.11.0 */
1275 if (curr_tracer_info
->minor
< 11) {
1279 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1280 if (curr_tracer_info
->major
< 2) {
1282 } else if (curr_tracer_info
->major
== 2) {
1283 /* fixed in lttng-modules 2.11.0 */
1284 if (curr_tracer_info
->minor
== 10) {
1285 /* fixed in lttng-modules 2.10.10 */
1286 if (curr_tracer_info
->patch
< 10) {
1289 } else if (curr_tracer_info
->minor
== 9) {
1290 /* fixed in lttng-modules 2.9.13 */
1291 if (curr_tracer_info
->patch
< 13) {
1294 } else if (curr_tracer_info
->minor
< 9) {
1304 is_tracer_affected_by_barectf_event_before_packet_bug(struct tracer_info
*curr_tracer_info
)
1306 bool is_affected
= false;
1308 if (strcmp(curr_tracer_info
->name
, "barectf") == 0) {
1309 if (curr_tracer_info
->major
< 2) {
1311 } else if (curr_tracer_info
->major
== 2) {
1312 if (curr_tracer_info
->minor
< 3) {
1314 } else if (curr_tracer_info
->minor
== 3) {
1315 /* fixed in barectf 2.3.1 */
1316 if (curr_tracer_info
->patch
< 1) {
1326 static bool is_tracer_affected_by_lttng_crash_quirk(struct tracer_info
*curr_tracer_info
)
1328 bool is_affected
= false;
1330 /* All LTTng tracer may be affected by this lttng crash quirk. */
1331 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1333 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1341 * Looks for trace produced by known buggy tracers and fix up the index
1344 static int fix_packet_index_tracer_bugs(ctf_fs_trace
*trace
)
1346 struct tracer_info current_tracer_info
;
1348 int ret
= extract_tracer_info(trace
, ¤t_tracer_info
);
1351 * A trace may not have all the necessary environment
1352 * entries to do the tracer version comparison.
1353 * At least, the tracer name and major version number
1354 * are needed. Failing to extract these entries is not
1357 BT_CPPLOGI_STR_SPEC(
1359 "Cannot extract tracer information necessary to compare with buggy versions.");
1363 /* Check if the trace may be affected by old tracer bugs. */
1364 if (is_tracer_affected_by_lttng_event_after_packet_bug(¤t_tracer_info
)) {
1365 BT_CPPLOGI_STR_SPEC(
1367 "Trace may be affected by LTTng tracer packet timestamp bug. Fixing up.");
1368 ret
= fix_index_lttng_event_after_packet_bug(trace
);
1370 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1371 "Failed to fix LTTng event-after-packet bug.");
1374 trace
->metadata
->tc
->quirks
.lttng_event_after_packet
= true;
1377 if (is_tracer_affected_by_barectf_event_before_packet_bug(¤t_tracer_info
)) {
1378 BT_CPPLOGI_STR_SPEC(
1380 "Trace may be affected by barectf tracer packet timestamp bug. Fixing up.");
1381 ret
= fix_index_barectf_event_before_packet_bug(trace
);
1383 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1384 "Failed to fix barectf event-before-packet bug.");
1387 trace
->metadata
->tc
->quirks
.barectf_event_before_packet
= true;
1390 if (is_tracer_affected_by_lttng_crash_quirk(¤t_tracer_info
)) {
1391 ret
= fix_index_lttng_crash_quirk(trace
);
1393 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1394 "Failed to fix lttng-crash timestamp quirks.");
1397 trace
->metadata
->tc
->quirks
.lttng_crash
= true;
1403 static bool compare_ds_file_groups_by_first_path(const ctf_fs_ds_file_group::UP
& ds_file_group_a
,
1404 const ctf_fs_ds_file_group::UP
& ds_file_group_b
)
1406 BT_ASSERT(!ds_file_group_a
->ds_file_infos
.empty());
1407 BT_ASSERT(!ds_file_group_b
->ds_file_infos
.empty());
1409 const auto& first_ds_file_info_a
= *ds_file_group_a
->ds_file_infos
[0];
1410 const auto& first_ds_file_info_b
= *ds_file_group_b
->ds_file_infos
[0];
1412 return first_ds_file_info_a
.path
< first_ds_file_info_b
.path
;
1415 int ctf_fs_component_create_ctf_fs_trace(struct ctf_fs_component
*ctf_fs
,
1416 const bt_value
*paths_value
,
1417 const bt_value
*trace_name_value
,
1418 bt_self_component
*selfComp
)
1420 std::vector
<std::string
> paths
;
1421 std::vector
<ctf_fs_trace::UP
> traces
;
1422 const char *trace_name
;
1424 BT_ASSERT(bt_value_get_type(paths_value
) == BT_VALUE_TYPE_ARRAY
);
1425 BT_ASSERT(!bt_value_array_is_empty(paths_value
));
1427 trace_name
= trace_name_value
? bt_value_string_get(trace_name_value
) : NULL
;
1430 * Create a sorted array of the paths, to make the execution of this
1431 * component deterministic.
1433 for (std::uint64_t i
= 0; i
< bt_value_array_get_length(paths_value
); i
++) {
1434 const bt_value
*path_value
= bt_value_array_borrow_element_by_index_const(paths_value
, i
);
1435 const char *input
= bt_value_string_get(path_value
);
1436 paths
.emplace_back(input
);
1439 std::sort(paths
.begin(), paths
.end());
1441 /* Create a separate ctf_fs_trace object for each path. */
1442 for (const auto& path
: paths
) {
1443 int ret
= ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs
, path
.c_str(), trace_name
,
1450 if (traces
.size() > 1) {
1451 ctf_fs_trace
*first_trace
= traces
[0].get();
1452 const uint8_t *first_trace_uuid
= first_trace
->metadata
->tc
->uuid
;
1455 * We have more than one trace, they must all share the same
1456 * UUID, verify that.
1458 for (size_t i
= 0; i
< traces
.size(); i
++) {
1459 ctf_fs_trace
*this_trace
= traces
[i
].get();
1460 const uint8_t *this_trace_uuid
= this_trace
->metadata
->tc
->uuid
;
1462 if (!this_trace
->metadata
->tc
->is_uuid_set
) {
1463 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1465 "Multiple traces given, but a trace does not have a UUID: path={}",
1470 if (bt_uuid_compare(first_trace_uuid
, this_trace_uuid
) != 0) {
1471 char first_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1472 char this_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1474 bt_uuid_to_str(first_trace_uuid
, first_trace_uuid_str
);
1475 bt_uuid_to_str(this_trace_uuid
, this_trace_uuid_str
);
1477 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1478 "Multiple traces given, but UUIDs don't match: "
1479 "first-trace-uuid={}, first-trace-path={}, "
1480 "trace-uuid={}, trace-path={}",
1481 first_trace_uuid_str
, first_trace
->path
,
1482 this_trace_uuid_str
, this_trace
->path
);
1487 int ret
= merge_ctf_fs_traces(std::move(traces
), ctf_fs
->trace
);
1489 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1490 "Failed to merge traces with the same UUID.");
1494 /* Just one trace, it may or may not have a UUID, both are fine. */
1495 ctf_fs
->trace
= std::move(traces
[0]);
1498 int ret
= fix_packet_index_tracer_bugs(ctf_fs
->trace
.get());
1500 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to fix packet index tracer bugs.");
1505 * Sort data stream file groups by first data stream file info
1506 * path to get a deterministic order. This order influences the
1507 * order of the output ports. It also influences the order of
1508 * the automatic stream IDs if the trace's packet headers do not
1509 * contain a `stream_instance_id` field, in which case the data
1510 * stream file to stream ID association is always the same,
1511 * whatever the build and the system.
1513 * Having a deterministic order here can help debugging and
1516 std::sort(ctf_fs
->trace
->ds_file_groups
.begin(), ctf_fs
->trace
->ds_file_groups
.end(),
1517 compare_ds_file_groups_by_first_path
);
1522 static const std::string
&
1523 get_stream_instance_unique_name(struct ctf_fs_ds_file_group
*ds_file_group
)
1526 * The first (earliest) stream file's path is used as the stream's unique
1529 BT_ASSERT(!ds_file_group
->ds_file_infos
.empty());
1530 return ds_file_group
->ds_file_infos
[0]->path
;
1533 /* Create the IR stream objects for ctf_fs_trace. */
1535 static int create_streams_for_trace(struct ctf_fs_trace
*ctf_fs_trace
)
1537 for (const auto& ds_file_group
: ctf_fs_trace
->ds_file_groups
) {
1538 const std::string
& name
= get_stream_instance_unique_name(ds_file_group
.get());
1540 BT_ASSERT(ds_file_group
->sc
->ir_sc
);
1541 BT_ASSERT(ctf_fs_trace
->trace
);
1545 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
1546 /* No stream ID: use 0 */
1548 bt_stream_create_with_id(ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
->libObjPtr(),
1549 ctf_fs_trace
->next_stream_id
);
1550 ctf_fs_trace
->next_stream_id
++;
1552 /* Specific stream ID */
1554 bt_stream_create_with_id(ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
->libObjPtr(),
1555 (uint64_t) ds_file_group
->stream_id
);
1559 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1560 "Cannot create stream for DS file group: "
1561 "addr={}, stream-name=\"{}\"",
1562 fmt::ptr(ds_file_group
), name
);
1566 ds_file_group
->stream
= bt2::Stream::Shared::createWithoutRef(stream
);
1568 int ret
= bt_stream_set_name(ds_file_group
->stream
->libObjPtr(), name
.c_str());
1570 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1571 "Cannot set stream's name: "
1572 "addr={}, stream-name=\"{}\"",
1573 fmt::ptr(ds_file_group
->stream
->libObjPtr()), name
);
1581 static const bt_param_validation_value_descr inputs_elem_descr
=
1582 bt_param_validation_value_descr::makeString();
1584 static bt_param_validation_map_value_entry_descr fs_params_entries_descr
[] = {
1585 {"inputs", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
1586 bt_param_validation_value_descr::makeArray(1, BT_PARAM_VALIDATION_INFINITE
,
1587 inputs_elem_descr
)},
1588 {"trace-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1589 bt_param_validation_value_descr::makeString()},
1590 {"clock-class-offset-s", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1591 bt_param_validation_value_descr::makeSignedInteger()},
1592 {"clock-class-offset-ns", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1593 bt_param_validation_value_descr::makeSignedInteger()},
1594 {"force-clock-class-origin-unix-epoch", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1595 bt_param_validation_value_descr::makeBool()},
1596 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
1598 bool read_src_fs_parameters(const bt_value
*params
, const bt_value
**inputs
,
1599 const bt_value
**trace_name
, struct ctf_fs_component
*ctf_fs
)
1601 const bt_value
*value
;
1602 enum bt_param_validation_status validate_value_status
;
1603 gchar
*error
= NULL
;
1605 validate_value_status
= bt_param_validation_validate(params
, fs_params_entries_descr
, &error
);
1606 if (validate_value_status
!= BT_PARAM_VALIDATION_STATUS_OK
) {
1607 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "{}", error
);
1612 /* inputs parameter */
1613 *inputs
= bt_value_map_borrow_entry_value_const(params
, "inputs");
1615 /* clock-class-offset-s parameter */
1616 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-s");
1618 ctf_fs
->clkClsCfg
.offsetSec
= bt_value_integer_signed_get(value
);
1621 /* clock-class-offset-ns parameter */
1622 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-ns");
1624 ctf_fs
->clkClsCfg
.offsetNanoSec
= bt_value_integer_signed_get(value
);
1627 /* force-clock-class-origin-unix-epoch parameter */
1628 value
= bt_value_map_borrow_entry_value_const(params
, "force-clock-class-origin-unix-epoch");
1630 ctf_fs
->clkClsCfg
.forceOriginIsUnixEpoch
= bt_value_bool_get(value
);
1633 /* trace-name parameter */
1634 *trace_name
= bt_value_map_borrow_entry_value_const(params
, "trace-name");
1639 static ctf_fs_component::UP
ctf_fs_create(const bt_value
*params
,
1640 bt_self_component_source
*self_comp_src
)
1642 const bt_value
*inputs_value
;
1643 const bt_value
*trace_name_value
;
1644 bt_self_component
*self_comp
= bt_self_component_source_as_self_component(self_comp_src
);
1646 ctf_fs_component::UP ctf_fs
= bt2s::make_unique
<ctf_fs_component
>(
1647 bt2c::Logger
{bt2::SelfSourceComponent
{self_comp_src
}, "PLUGIN/SRC.CTF.FS/COMP"});
1649 if (!read_src_fs_parameters(params
, &inputs_value
, &trace_name_value
, ctf_fs
.get())) {
1653 if (ctf_fs_component_create_ctf_fs_trace(ctf_fs
.get(), inputs_value
, trace_name_value
,
1658 if (create_streams_for_trace(ctf_fs
->trace
.get())) {
1662 if (create_ports_for_trace(ctf_fs
.get(), ctf_fs
->trace
.get(), self_comp_src
)) {
1669 bt_component_class_initialize_method_status
ctf_fs_init(bt_self_component_source
*self_comp_src
,
1670 bt_self_component_source_configuration
*,
1671 const bt_value
*params
, void *)
1674 bt_component_class_initialize_method_status ret
=
1675 BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
1677 ctf_fs_component::UP ctf_fs
= ctf_fs_create(params
, self_comp_src
);
1679 ret
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1682 bt_self_component_set_data(bt_self_component_source_as_self_component(self_comp_src
),
1685 } catch (const std::bad_alloc
&) {
1686 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1687 } catch (const bt2::Error
&) {
1688 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1692 bt_component_class_query_method_status
ctf_fs_query(bt_self_component_class_source
*comp_class_src
,
1693 bt_private_query_executor
*priv_query_exec
,
1694 const char *object
, const bt_value
*params
,
1695 __attribute__((unused
)) void *method_data
,
1696 const bt_value
**result
)
1699 bt2c::Logger logger
{bt2::SelfComponentClass
{comp_class_src
},
1700 bt2::PrivateQueryExecutor
{priv_query_exec
},
1701 "PLUGIN/SRC.CTF.FS/QUERY"};
1702 bt2::ConstMapValue
paramsObj(params
);
1703 bt2::Value::Shared resultObj
;
1705 if (strcmp(object
, "metadata-info") == 0) {
1706 resultObj
= metadata_info_query(paramsObj
, logger
);
1707 } else if (strcmp(object
, "babeltrace.trace-infos") == 0) {
1708 resultObj
= trace_infos_query(paramsObj
, logger
);
1709 } else if (!strcmp(object
, "babeltrace.support-info")) {
1710 resultObj
= support_info_query(paramsObj
, logger
);
1712 BT_CPPLOGE_SPEC(logger
, "Unknown query object `{}`", object
);
1713 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;
1716 *result
= resultObj
.release().libObjPtr();
1718 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
1719 } catch (const std::bad_alloc
&) {
1720 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
1721 } catch (const bt2::Error
&) {
1722 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;