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_fs_ds_index::UP index
;
424 ctf_msg_iter_up msg_iter
;
425 struct ctf_stream_class
*sc
= NULL
;
426 struct ctf_msg_iter_packet_properties props
;
429 * Create a temporary ds_file to read some properties about the data
433 ctf_fs_ds_file_create(ctf_fs_trace
, bt2::Stream::Shared
{}, path
, ctf_fs_trace
->logger
);
438 /* Create a temporary iterator to read the ds_file. */
439 msg_iter
= ctf_msg_iter_create(
440 ctf_fs_trace
->metadata
->tc
,
441 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
442 ctf_fs_ds_file_medops
, ds_file
.get(), nullptr, ctf_fs_trace
->logger
);
444 BT_CPPLOGE_STR_SPEC(ctf_fs_trace
->logger
, "Cannot create a CTF message iterator.");
448 ctf_msg_iter_set_dry_run(msg_iter
.get(), true);
450 int ret
= ctf_msg_iter_get_packet_properties(msg_iter
.get(), &props
);
452 BT_CPPLOGE_APPEND_CAUSE_SPEC(
453 ctf_fs_trace
->logger
,
454 "Cannot get stream file's first packet's header and context fields (`{}`).", path
);
458 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
, props
.stream_class_id
);
460 stream_instance_id
= props
.data_stream_id
;
462 if (props
.snapshots
.beginning_clock
!= UINT64_C(-1)) {
463 BT_ASSERT(sc
->default_clock_class
);
464 ret
= bt_util_clock_cycles_to_ns_from_origin(
465 props
.snapshots
.beginning_clock
, sc
->default_clock_class
->frequency
,
466 sc
->default_clock_class
->offset_seconds
, sc
->default_clock_class
->offset_cycles
,
469 BT_CPPLOGE_APPEND_CAUSE_SPEC(
470 ctf_fs_trace
->logger
,
471 "Cannot convert clock cycles to nanoseconds from origin (`{}`).", path
);
476 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
);
481 index
= ctf_fs_ds_file_build_index(ds_file
.get(), ds_file_info
.get(), msg_iter
.get());
483 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to index CTF stream file \'{}\'",
484 ds_file
->file
->path
);
488 if (begin_ns
== -1) {
490 * No beginning timestamp to sort the stream files
491 * within a stream file group, so consider that this
492 * file must be the only one within its group.
494 stream_instance_id
= -1;
497 if (stream_instance_id
== -1) {
499 * No stream instance ID or no beginning timestamp:
500 * create a unique stream file group for this stream
501 * file because, even if there's a stream instance ID,
502 * there's no timestamp to order the file within its
506 ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, UINT64_C(-1), std::move(index
));
508 if (!new_ds_file_group
) {
512 ds_file_group_insert_ds_file_info_sorted(new_ds_file_group
.get(), std::move(ds_file_info
));
513 ctf_fs_trace
->ds_file_groups
.emplace_back(std::move(new_ds_file_group
));
517 BT_ASSERT(stream_instance_id
!= -1);
518 BT_ASSERT(begin_ns
!= -1);
520 /* Find an existing stream file group with this ID */
521 for (const auto& candidate
: ctf_fs_trace
->ds_file_groups
) {
522 if (candidate
->sc
== sc
&& candidate
->stream_id
== stream_instance_id
) {
523 ds_file_group
= candidate
.get();
528 if (!ds_file_group
) {
530 ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, stream_instance_id
, std::move(index
));
531 if (!new_ds_file_group
) {
535 ds_file_group
= new_ds_file_group
.get();
536 ctf_fs_trace
->ds_file_groups
.emplace_back(std::move(new_ds_file_group
));
538 merge_ctf_fs_ds_indexes(ds_file_group
->index
.get(), *index
);
541 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, std::move(ds_file_info
));
546 static int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
548 const char *basename
;
549 GError
*error
= NULL
;
551 /* Check each file in the path directory, except specific ones */
552 const bt2c::GDirUP dir
{g_dir_open(ctf_fs_trace
->path
.c_str(), 0, &error
)};
554 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
555 "Cannot open directory `{}`: {} (code {})", ctf_fs_trace
->path
,
556 error
->message
, error
->code
);
563 while ((basename
= g_dir_read_name(dir
.get()))) {
564 if (strcmp(basename
, CTF_FS_METADATA_FILENAME
) == 0) {
565 /* Ignore the metadata stream. */
566 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
567 "Ignoring metadata file `{}" G_DIR_SEPARATOR_S
"{}`",
568 ctf_fs_trace
->path
, basename
);
572 if (basename
[0] == '.') {
573 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
574 "Ignoring hidden file `{}" G_DIR_SEPARATOR_S
"{}`", ctf_fs_trace
->path
,
579 /* Create the file. */
580 ctf_fs_file file
{ctf_fs_trace
->logger
};
582 /* Create full path string. */
583 file
.path
= fmt::format("{}" G_DIR_SEPARATOR_S
"{}", ctf_fs_trace
->path
, basename
);
585 if (!g_file_test(file
.path
.c_str(), G_FILE_TEST_IS_REGULAR
)) {
586 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring non-regular file `{}`", file
.path
);
590 int ret
= ctf_fs_file_open(&file
, "rb");
592 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Cannot open stream file `{}`",
597 if (file
.size
== 0) {
598 /* Skip empty stream. */
599 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring empty file `{}`", file
.path
);
603 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
, file
.path
.c_str());
605 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
606 "Cannot add stream file `{}` to stream file group",
615 static int set_trace_name(bt_trace
*trace
, const char *name_suffix
)
621 * Check if we have a trace environment string value named `hostname`.
622 * If so, use it as the trace name's prefix.
624 val
= bt_trace_borrow_environment_entry_value_by_name_const(trace
, "hostname");
625 if (val
&& bt_value_is_string(val
)) {
626 name
+= bt_value_string_get(val
);
629 name
+= G_DIR_SEPARATOR
;
637 return bt_trace_set_name(trace
, name
.c_str());
640 static ctf_fs_trace::UP
ctf_fs_trace_create(const char *path
, const char *name
,
641 const ctf::src::ClkClsCfg
& clkClsCfg
,
642 bt_self_component
*selfComp
,
643 const bt2c::Logger
& parentLogger
)
645 ctf_fs_trace::UP ctf_fs_trace
= bt2s::make_unique
<struct ctf_fs_trace
>(parentLogger
);
646 ctf_fs_trace
->path
= path
;
647 ctf_fs_trace
->metadata
= bt2s::make_unique
<ctf_fs_metadata
>();
649 int ret
= ctf_fs_metadata_set_trace_class(selfComp
, ctf_fs_trace
.get(), clkClsCfg
);
654 if (ctf_fs_trace
->metadata
->trace_class
) {
655 bt_trace
*trace
= bt_trace_create(ctf_fs_trace
->metadata
->trace_class
->libObjPtr());
660 ctf_fs_trace
->trace
= bt2::Trace::Shared::createWithoutRef(trace
);
663 if (ctf_fs_trace
->trace
) {
664 ret
= ctf_trace_class_configure_ir_trace(ctf_fs_trace
->metadata
->tc
,
665 ctf_fs_trace
->trace
->libObjPtr());
670 ret
= set_trace_name(ctf_fs_trace
->trace
->libObjPtr(), name
);
676 ret
= create_ds_file_groups(ctf_fs_trace
.get());
684 static int path_is_ctf_trace(const char *path
)
686 return g_file_test(fmt::format("{}" G_DIR_SEPARATOR_S CTF_FS_METADATA_FILENAME
, path
).c_str(),
687 G_FILE_TEST_IS_REGULAR
);
690 /* Helper for ctf_fs_component_create_ctf_fs_trace, to handle a single path. */
692 static int ctf_fs_component_create_ctf_fs_trace_one_path(struct ctf_fs_component
*ctf_fs
,
693 const char *path_param
,
694 const char *trace_name
,
695 std::vector
<ctf_fs_trace::UP
>& traces
,
696 bt_self_component
*selfComp
)
698 ctf_fs_trace::UP ctf_fs_trace
;
701 bt2c::GStringUP norm_path
{bt_common_normalize_path(path_param
, NULL
)};
703 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to normalize path: `{}`.", path_param
);
707 ret
= path_is_ctf_trace(norm_path
->str
);
709 BT_CPPLOGE_APPEND_CAUSE_SPEC(
710 ctf_fs
->logger
, "Failed to check if path is a CTF trace: path={}", norm_path
->str
);
712 } else if (ret
== 0) {
713 BT_CPPLOGE_APPEND_CAUSE_SPEC(
714 ctf_fs
->logger
, "Path is not a CTF trace (does not contain a metadata file): `{}`.",
719 // FIXME: Remove or ifdef for __MINGW32__
720 if (strcmp(norm_path
->str
, "/") == 0) {
721 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Opening a trace in `/` is not supported.");
725 ctf_fs_trace
= ctf_fs_trace_create(norm_path
->str
, trace_name
, ctf_fs
->clkClsCfg
, selfComp
,
728 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create trace for `{}`.",
733 traces
.emplace_back(std::move(ctf_fs_trace
));
739 * Count the number of stream and event classes defined by this trace's metadata.
741 * This is used to determine which metadata is the "latest", out of multiple
742 * traces sharing the same UUID. It is assumed that amongst all these metadatas,
743 * a bigger metadata is a superset of a smaller metadata. Therefore, it is
744 * enough to just count the classes.
747 static unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace
*trace
)
749 unsigned int num
= trace
->metadata
->tc
->stream_classes
->len
;
752 for (i
= 0; i
< trace
->metadata
->tc
->stream_classes
->len
; i
++) {
753 struct ctf_stream_class
*sc
=
754 (struct ctf_stream_class
*) trace
->metadata
->tc
->stream_classes
->pdata
[i
];
755 num
+= sc
->event_classes
->len
;
762 * Merge the src ds_file_group into dest. This consists of merging their
763 * ds_file_infos, making sure to keep the result sorted.
766 static void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group
*dest
,
767 ctf_fs_ds_file_group::UP src
)
769 for (auto& ds_file_info
: src
->ds_file_infos
) {
770 ds_file_group_insert_ds_file_info_sorted(dest
, std::move(ds_file_info
));
773 /* Merge both indexes. */
774 merge_ctf_fs_ds_indexes(dest
->index
.get(), *src
->index
);
777 /* Merge src_trace's data stream file groups into dest_trace's. */
779 static int merge_matching_ctf_fs_ds_file_groups(struct ctf_fs_trace
*dest_trace
,
780 ctf_fs_trace::UP src_trace
)
782 std::vector
<ctf_fs_ds_file_group::UP
>& dest
= dest_trace
->ds_file_groups
;
783 std::vector
<ctf_fs_ds_file_group::UP
>& src
= src_trace
->ds_file_groups
;
786 * Save the initial length of dest: we only want to check against the
787 * original elements in the inner loop.
789 size_t dest_len
= dest
.size();
791 for (auto& src_group
: src
) {
792 struct ctf_fs_ds_file_group
*dest_group
= NULL
;
794 /* A stream instance without ID can't match a stream in the other trace. */
795 if (src_group
->stream_id
!= -1) {
796 /* Let's search for a matching ds_file_group in the destination. */
797 for (size_t d_i
= 0; d_i
< dest_len
; ++d_i
) {
798 ctf_fs_ds_file_group
*candidate_dest
= dest
[d_i
].get();
800 /* Can't match a stream instance without ID. */
801 if (candidate_dest
->stream_id
== -1) {
806 * If the two groups have the same stream instance id
807 * and belong to the same stream class (stream instance
808 * ids are per-stream class), they represent the same
811 if (candidate_dest
->stream_id
!= src_group
->stream_id
||
812 candidate_dest
->sc
->id
!= src_group
->sc
->id
) {
816 dest_group
= candidate_dest
;
822 * Didn't find a friend in dest to merge our src_group into?
823 * Create a new empty one. This can happen if a stream was
824 * active in the source trace chunk but not in the destination
828 struct ctf_stream_class
*sc
;
830 sc
= ctf_trace_class_borrow_stream_class_by_id(dest_trace
->metadata
->tc
,
834 auto new_dest_group
= ctf_fs_ds_file_group_create(dest_trace
, sc
, src_group
->stream_id
,
835 bt2s::make_unique
<ctf_fs_ds_index
>());
837 if (!new_dest_group
) {
841 dest_group
= new_dest_group
.get();
842 dest_trace
->ds_file_groups
.emplace_back(std::move(new_dest_group
));
845 BT_ASSERT(dest_group
);
846 merge_ctf_fs_ds_file_groups(dest_group
, std::move(src_group
));
853 * Collapse the given traces, which must all share the same UUID, in a single
856 * The trace with the most expansive metadata is chosen and all other traces
857 * are merged into that one. On return, the elements of `traces` are nullptr
858 * and the merged trace is placed in `out_trace`.
861 static int merge_ctf_fs_traces(std::vector
<ctf_fs_trace::UP
> traces
, ctf_fs_trace::UP
& out_trace
)
863 unsigned int winner_count
;
864 struct ctf_fs_trace
*winner
;
867 BT_ASSERT(traces
.size() >= 2);
869 winner_count
= metadata_count_stream_and_event_classes(traces
[0].get());
870 winner
= traces
[0].get();
873 /* Find the trace with the largest metadata. */
874 for (i
= 1; i
< traces
.size(); i
++) {
875 ctf_fs_trace
*candidate
= traces
[i
].get();
876 unsigned int candidate_count
;
878 /* A bit of sanity check. */
879 BT_ASSERT(bt_uuid_compare(winner
->metadata
->tc
->uuid
, candidate
->metadata
->tc
->uuid
) == 0);
881 candidate_count
= metadata_count_stream_and_event_classes(candidate
);
883 if (candidate_count
> winner_count
) {
884 winner_count
= candidate_count
;
890 /* Merge all the other traces in the winning trace. */
891 for (ctf_fs_trace::UP
& trace
: traces
) {
892 /* Don't merge the winner into itself. */
893 if (trace
.get() == winner
) {
897 /* Merge trace's data stream file groups into winner's. */
898 int ret
= merge_matching_ctf_fs_ds_file_groups(winner
, std::move(trace
));
905 * Move the winner out of the array, into `*out_trace`.
907 out_trace
= std::move(traces
[winner_i
]);
918 static int decode_clock_snapshot_after_event(struct ctf_fs_trace
*ctf_fs_trace
,
919 struct ctf_clock_class
*default_cc
,
920 const ctf_fs_ds_index_entry
& index_entry
,
921 enum target_event target_event
, uint64_t *cs
,
924 enum ctf_msg_iter_status iter_status
= CTF_MSG_ITER_STATUS_OK
;
925 ctf_msg_iter_up msg_iter
;
927 BT_ASSERT(ctf_fs_trace
);
928 BT_ASSERT(index_entry
.path
);
930 const auto ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, bt2::Stream::Shared
{},
931 index_entry
.path
, ctf_fs_trace
->logger
);
933 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to create a ctf_fs_ds_file");
937 BT_ASSERT(ctf_fs_trace
->metadata
);
938 BT_ASSERT(ctf_fs_trace
->metadata
->tc
);
940 msg_iter
= ctf_msg_iter_create(
941 ctf_fs_trace
->metadata
->tc
,
942 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
943 ctf_fs_ds_file_medops
, ds_file
.get(), NULL
, ctf_fs_trace
->logger
);
945 /* ctf_msg_iter_create() logs errors. */
950 * Turn on dry run mode to prevent the creation and usage of Babeltrace
951 * library objects (bt_field, bt_message_*, etc.).
953 ctf_msg_iter_set_dry_run(msg_iter
.get(), true);
955 /* Seek to the beginning of the target packet. */
956 iter_status
= ctf_msg_iter_seek(msg_iter
.get(), index_entry
.offset
.bytes());
958 /* ctf_msg_iter_seek() logs errors. */
962 switch (target_event
) {
965 * Start to decode the packet until we reach the end of
966 * the first event. To extract the first event's clock
969 iter_status
= ctf_msg_iter_curr_packet_first_event_clock_snapshot(msg_iter
.get(), cs
);
972 /* Decode the packet to extract the last event's clock snapshot. */
973 iter_status
= ctf_msg_iter_curr_packet_last_event_clock_snapshot(msg_iter
.get(), cs
);
982 /* Convert clock snapshot to timestamp. */
983 int ret
= bt_util_clock_cycles_to_ns_from_origin(
984 *cs
, default_cc
->frequency
, default_cc
->offset_seconds
, default_cc
->offset_cycles
, ts_ns
);
986 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
987 "Failed to convert clock snapshot to timestamp");
994 static int decode_packet_first_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
995 struct ctf_clock_class
*default_cc
,
996 const ctf_fs_ds_index_entry
& index_entry
,
997 uint64_t *cs
, int64_t *ts_ns
)
999 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, FIRST_EVENT
, cs
,
1003 static int decode_packet_last_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1004 struct ctf_clock_class
*default_cc
,
1005 const ctf_fs_ds_index_entry
& index_entry
,
1006 uint64_t *cs
, int64_t *ts_ns
)
1008 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, LAST_EVENT
, cs
,
1013 * Fix up packet index entries for lttng's "event-after-packet" bug.
1014 * Some buggy lttng tracer versions may emit events with a timestamp that is
1015 * larger (after) than the timestamp_end of the their packets.
1017 * To fix up this erroneous data we do the following:
1018 * 1. If it's not the stream file's last packet: set the packet index entry's
1019 * end time to the next packet's beginning time.
1020 * 2. If it's the stream file's last packet, set the packet index entry's end
1021 * time to the packet's last event's time, if any, or to the packet's
1022 * beginning time otherwise.
1024 * Known buggy tracer versions:
1025 * - before lttng-ust 2.11.0
1026 * - before lttng-module 2.11.0
1027 * - before lttng-module 2.10.10
1028 * - before lttng-module 2.9.13
1030 static int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace
*trace
)
1032 for (const auto& ds_file_group
: trace
->ds_file_groups
) {
1033 struct ctf_clock_class
*default_cc
;
1035 BT_ASSERT(ds_file_group
);
1036 const auto index
= ds_file_group
->index
.get();
1039 BT_ASSERT(!index
->entries
.empty());
1042 * Iterate over all entries but the last one. The last one is
1043 * fixed differently after.
1045 for (size_t entry_i
= 0; entry_i
< index
->entries
.size() - 1; ++entry_i
) {
1046 auto& curr_entry
= index
->entries
[entry_i
];
1047 const auto& next_entry
= index
->entries
[entry_i
+ 1];
1050 * 1. Set the current index entry `end` timestamp to
1051 * the next index entry `begin` timestamp.
1053 curr_entry
.timestamp_end
= next_entry
.timestamp_begin
;
1054 curr_entry
.timestamp_end_ns
= next_entry
.timestamp_begin_ns
;
1058 * 2. Fix the last entry by decoding the last event of the last
1061 auto& last_entry
= index
->entries
.back();
1063 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1064 default_cc
= ds_file_group
->sc
->default_clock_class
;
1067 * Decode packet to read the timestamp of the last event of the
1070 int ret
= decode_packet_last_event_timestamp(
1071 trace
, default_cc
, last_entry
, &last_entry
.timestamp_end
, &last_entry
.timestamp_end_ns
);
1073 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1075 "Failed to decode stream's last packet to get its last event's clock snapshot.");
1084 * Fix up packet index entries for barectf's "event-before-packet" bug.
1085 * Some buggy barectf tracer versions may emit events with a timestamp that is
1086 * less than the timestamp_begin of the their packets.
1088 * To fix up this erroneous data we do the following:
1089 * 1. Starting at the second index entry, set the timestamp_begin of the
1090 * current entry to the timestamp of the first event of the packet.
1091 * 2. Set the previous entry's timestamp_end to the timestamp_begin of the
1094 * Known buggy tracer versions:
1095 * - before barectf 2.3.1
1097 static int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace
*trace
)
1099 for (const auto& ds_file_group
: trace
->ds_file_groups
) {
1100 struct ctf_clock_class
*default_cc
;
1101 const auto index
= ds_file_group
->index
.get();
1104 BT_ASSERT(!index
->entries
.empty());
1106 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1107 default_cc
= ds_file_group
->sc
->default_clock_class
;
1110 * 1. Iterate over the index, starting from the second entry
1113 for (size_t entry_i
= 1; entry_i
< index
->entries
.size(); ++entry_i
) {
1114 auto& prev_entry
= index
->entries
[entry_i
- 1];
1115 auto& curr_entry
= index
->entries
[entry_i
];
1117 * 2. Set the current entry `begin` timestamp to the
1118 * timestamp of the first event of the current packet.
1120 int ret
= decode_packet_first_event_timestamp(trace
, default_cc
, curr_entry
,
1121 &curr_entry
.timestamp_begin
,
1122 &curr_entry
.timestamp_begin_ns
);
1124 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1125 "Failed to decode first event's clock snapshot");
1130 * 3. Set the previous entry `end` timestamp to the
1131 * timestamp of the first event of the current packet.
1133 prev_entry
.timestamp_end
= curr_entry
.timestamp_begin
;
1134 prev_entry
.timestamp_end_ns
= curr_entry
.timestamp_begin_ns
;
1142 * When using the lttng-crash feature it's likely that the last packets of each
1143 * stream have their timestamp_end set to zero. This is caused by the fact that
1144 * the tracer crashed and was not able to properly close the packets.
1146 * To fix up this erroneous data we do the following:
1147 * For each index entry, if the entry's timestamp_end is 0 and the
1148 * timestamp_begin is not 0:
1149 * - If it's the stream file's last packet: set the packet index entry's end
1150 * time to the packet's last event's time, if any, or to the packet's
1151 * beginning time otherwise.
1152 * - If it's not the stream file's last packet: set the packet index
1153 * entry's end time to the next packet's beginning time.
1155 * Affected versions:
1156 * - All current and future lttng-ust and lttng-modules versions.
1158 static int fix_index_lttng_crash_quirk(struct ctf_fs_trace
*trace
)
1160 for (const auto& ds_file_group
: trace
->ds_file_groups
) {
1161 struct ctf_clock_class
*default_cc
;
1163 BT_ASSERT(ds_file_group
);
1164 const auto index
= ds_file_group
->index
.get();
1166 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1167 default_cc
= ds_file_group
->sc
->default_clock_class
;
1170 BT_ASSERT(!index
->entries
.empty());
1172 auto& last_entry
= index
->entries
.back();
1174 /* 1. Fix the last entry first. */
1175 if (last_entry
.timestamp_end
== 0 && last_entry
.timestamp_begin
!= 0) {
1177 * Decode packet to read the timestamp of the
1178 * last event of the stream file.
1180 int ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1181 &last_entry
.timestamp_end
,
1182 &last_entry
.timestamp_end_ns
);
1184 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1185 "Failed to decode last event's clock snapshot");
1190 /* Iterate over all entries but the last one. */
1191 for (size_t entry_idx
= 0; entry_idx
< index
->entries
.size() - 1; ++entry_idx
) {
1192 auto& curr_entry
= index
->entries
[entry_idx
];
1193 const auto& next_entry
= index
->entries
[entry_idx
+ 1];
1195 if (curr_entry
.timestamp_end
== 0 && curr_entry
.timestamp_begin
!= 0) {
1197 * 2. Set the current index entry `end` timestamp to
1198 * the next index entry `begin` timestamp.
1200 curr_entry
.timestamp_end
= next_entry
.timestamp_begin
;
1201 curr_entry
.timestamp_end_ns
= next_entry
.timestamp_begin_ns
;
1210 * Extract the tracer information necessary to compare versions.
1211 * Returns 0 on success, and -1 if the extraction is not successful because the
1212 * necessary fields are absents in the trace metadata.
1214 static int extract_tracer_info(struct ctf_fs_trace
*trace
, struct tracer_info
*current_tracer_info
)
1216 struct ctf_trace_class_env_entry
*entry
;
1218 /* Clear the current_tracer_info struct */
1219 memset(current_tracer_info
, 0, sizeof(*current_tracer_info
));
1222 * To compare 2 tracer versions, at least the tracer name and it's
1223 * major version are needed. If one of these is missing, consider it an
1224 * extraction failure.
1226 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_name");
1227 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR
) {
1231 /* Set tracer name. */
1232 current_tracer_info
->name
= entry
->value
.str
->str
;
1234 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_major");
1235 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1239 /* Set major version number. */
1240 current_tracer_info
->major
= entry
->value
.i
;
1242 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_minor");
1243 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1247 /* Set minor version number. */
1248 current_tracer_info
->minor
= entry
->value
.i
;
1250 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patch");
1253 * If `tracer_patch` doesn't exist `tracer_patchlevel` might.
1254 * For example, `lttng-modules` uses entry name
1255 * `tracer_patchlevel`.
1257 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patchlevel");
1260 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1264 /* Set patch version number. */
1265 current_tracer_info
->patch
= entry
->value
.i
;
1270 static bool is_tracer_affected_by_lttng_event_after_packet_bug(struct tracer_info
*curr_tracer_info
)
1272 bool is_affected
= false;
1274 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1275 if (curr_tracer_info
->major
< 2) {
1277 } else if (curr_tracer_info
->major
== 2) {
1278 /* fixed in lttng-ust 2.11.0 */
1279 if (curr_tracer_info
->minor
< 11) {
1283 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1284 if (curr_tracer_info
->major
< 2) {
1286 } else if (curr_tracer_info
->major
== 2) {
1287 /* fixed in lttng-modules 2.11.0 */
1288 if (curr_tracer_info
->minor
== 10) {
1289 /* fixed in lttng-modules 2.10.10 */
1290 if (curr_tracer_info
->patch
< 10) {
1293 } else if (curr_tracer_info
->minor
== 9) {
1294 /* fixed in lttng-modules 2.9.13 */
1295 if (curr_tracer_info
->patch
< 13) {
1298 } else if (curr_tracer_info
->minor
< 9) {
1308 is_tracer_affected_by_barectf_event_before_packet_bug(struct tracer_info
*curr_tracer_info
)
1310 bool is_affected
= false;
1312 if (strcmp(curr_tracer_info
->name
, "barectf") == 0) {
1313 if (curr_tracer_info
->major
< 2) {
1315 } else if (curr_tracer_info
->major
== 2) {
1316 if (curr_tracer_info
->minor
< 3) {
1318 } else if (curr_tracer_info
->minor
== 3) {
1319 /* fixed in barectf 2.3.1 */
1320 if (curr_tracer_info
->patch
< 1) {
1330 static bool is_tracer_affected_by_lttng_crash_quirk(struct tracer_info
*curr_tracer_info
)
1332 bool is_affected
= false;
1334 /* All LTTng tracer may be affected by this lttng crash quirk. */
1335 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1337 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1345 * Looks for trace produced by known buggy tracers and fix up the index
1348 static int fix_packet_index_tracer_bugs(ctf_fs_trace
*trace
)
1350 struct tracer_info current_tracer_info
;
1352 int ret
= extract_tracer_info(trace
, ¤t_tracer_info
);
1355 * A trace may not have all the necessary environment
1356 * entries to do the tracer version comparison.
1357 * At least, the tracer name and major version number
1358 * are needed. Failing to extract these entries is not
1361 BT_CPPLOGI_STR_SPEC(
1363 "Cannot extract tracer information necessary to compare with buggy versions.");
1367 /* Check if the trace may be affected by old tracer bugs. */
1368 if (is_tracer_affected_by_lttng_event_after_packet_bug(¤t_tracer_info
)) {
1369 BT_CPPLOGI_STR_SPEC(
1371 "Trace may be affected by LTTng tracer packet timestamp bug. Fixing up.");
1372 ret
= fix_index_lttng_event_after_packet_bug(trace
);
1374 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1375 "Failed to fix LTTng event-after-packet bug.");
1378 trace
->metadata
->tc
->quirks
.lttng_event_after_packet
= true;
1381 if (is_tracer_affected_by_barectf_event_before_packet_bug(¤t_tracer_info
)) {
1382 BT_CPPLOGI_STR_SPEC(
1384 "Trace may be affected by barectf tracer packet timestamp bug. Fixing up.");
1385 ret
= fix_index_barectf_event_before_packet_bug(trace
);
1387 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1388 "Failed to fix barectf event-before-packet bug.");
1391 trace
->metadata
->tc
->quirks
.barectf_event_before_packet
= true;
1394 if (is_tracer_affected_by_lttng_crash_quirk(¤t_tracer_info
)) {
1395 ret
= fix_index_lttng_crash_quirk(trace
);
1397 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1398 "Failed to fix lttng-crash timestamp quirks.");
1401 trace
->metadata
->tc
->quirks
.lttng_crash
= true;
1407 static bool compare_ds_file_groups_by_first_path(const ctf_fs_ds_file_group::UP
& ds_file_group_a
,
1408 const ctf_fs_ds_file_group::UP
& ds_file_group_b
)
1410 BT_ASSERT(!ds_file_group_a
->ds_file_infos
.empty());
1411 BT_ASSERT(!ds_file_group_b
->ds_file_infos
.empty());
1413 const auto& first_ds_file_info_a
= *ds_file_group_a
->ds_file_infos
[0];
1414 const auto& first_ds_file_info_b
= *ds_file_group_b
->ds_file_infos
[0];
1416 return first_ds_file_info_a
.path
< first_ds_file_info_b
.path
;
1419 int ctf_fs_component_create_ctf_fs_trace(struct ctf_fs_component
*ctf_fs
,
1420 const bt_value
*paths_value
,
1421 const bt_value
*trace_name_value
,
1422 bt_self_component
*selfComp
)
1424 std::vector
<std::string
> paths
;
1425 std::vector
<ctf_fs_trace::UP
> traces
;
1426 const char *trace_name
;
1428 BT_ASSERT(bt_value_get_type(paths_value
) == BT_VALUE_TYPE_ARRAY
);
1429 BT_ASSERT(!bt_value_array_is_empty(paths_value
));
1431 trace_name
= trace_name_value
? bt_value_string_get(trace_name_value
) : NULL
;
1434 * Create a sorted array of the paths, to make the execution of this
1435 * component deterministic.
1437 for (std::uint64_t i
= 0; i
< bt_value_array_get_length(paths_value
); i
++) {
1438 const bt_value
*path_value
= bt_value_array_borrow_element_by_index_const(paths_value
, i
);
1439 const char *input
= bt_value_string_get(path_value
);
1440 paths
.emplace_back(input
);
1443 std::sort(paths
.begin(), paths
.end());
1445 /* Create a separate ctf_fs_trace object for each path. */
1446 for (const auto& path
: paths
) {
1447 int ret
= ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs
, path
.c_str(), trace_name
,
1454 if (traces
.size() > 1) {
1455 ctf_fs_trace
*first_trace
= traces
[0].get();
1456 const uint8_t *first_trace_uuid
= first_trace
->metadata
->tc
->uuid
;
1459 * We have more than one trace, they must all share the same
1460 * UUID, verify that.
1462 for (size_t i
= 0; i
< traces
.size(); i
++) {
1463 ctf_fs_trace
*this_trace
= traces
[i
].get();
1464 const uint8_t *this_trace_uuid
= this_trace
->metadata
->tc
->uuid
;
1466 if (!this_trace
->metadata
->tc
->is_uuid_set
) {
1467 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1469 "Multiple traces given, but a trace does not have a UUID: path={}",
1474 if (bt_uuid_compare(first_trace_uuid
, this_trace_uuid
) != 0) {
1475 char first_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1476 char this_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1478 bt_uuid_to_str(first_trace_uuid
, first_trace_uuid_str
);
1479 bt_uuid_to_str(this_trace_uuid
, this_trace_uuid_str
);
1481 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1482 "Multiple traces given, but UUIDs don't match: "
1483 "first-trace-uuid={}, first-trace-path={}, "
1484 "trace-uuid={}, trace-path={}",
1485 first_trace_uuid_str
, first_trace
->path
,
1486 this_trace_uuid_str
, this_trace
->path
);
1491 int ret
= merge_ctf_fs_traces(std::move(traces
), ctf_fs
->trace
);
1493 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1494 "Failed to merge traces with the same UUID.");
1498 /* Just one trace, it may or may not have a UUID, both are fine. */
1499 ctf_fs
->trace
= std::move(traces
[0]);
1502 int ret
= fix_packet_index_tracer_bugs(ctf_fs
->trace
.get());
1504 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to fix packet index tracer bugs.");
1509 * Sort data stream file groups by first data stream file info
1510 * path to get a deterministic order. This order influences the
1511 * order of the output ports. It also influences the order of
1512 * the automatic stream IDs if the trace's packet headers do not
1513 * contain a `stream_instance_id` field, in which case the data
1514 * stream file to stream ID association is always the same,
1515 * whatever the build and the system.
1517 * Having a deterministic order here can help debugging and
1520 std::sort(ctf_fs
->trace
->ds_file_groups
.begin(), ctf_fs
->trace
->ds_file_groups
.end(),
1521 compare_ds_file_groups_by_first_path
);
1526 static const std::string
&
1527 get_stream_instance_unique_name(struct ctf_fs_ds_file_group
*ds_file_group
)
1530 * The first (earliest) stream file's path is used as the stream's unique
1533 BT_ASSERT(!ds_file_group
->ds_file_infos
.empty());
1534 return ds_file_group
->ds_file_infos
[0]->path
;
1537 /* Create the IR stream objects for ctf_fs_trace. */
1539 static int create_streams_for_trace(struct ctf_fs_trace
*ctf_fs_trace
)
1541 for (const auto& ds_file_group
: ctf_fs_trace
->ds_file_groups
) {
1542 const std::string
& name
= get_stream_instance_unique_name(ds_file_group
.get());
1544 BT_ASSERT(ds_file_group
->sc
->ir_sc
);
1545 BT_ASSERT(ctf_fs_trace
->trace
);
1549 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
1550 /* No stream ID: use 0 */
1552 bt_stream_create_with_id(ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
->libObjPtr(),
1553 ctf_fs_trace
->next_stream_id
);
1554 ctf_fs_trace
->next_stream_id
++;
1556 /* Specific stream ID */
1558 bt_stream_create_with_id(ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
->libObjPtr(),
1559 (uint64_t) ds_file_group
->stream_id
);
1563 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1564 "Cannot create stream for DS file group: "
1565 "addr={}, stream-name=\"{}\"",
1566 fmt::ptr(ds_file_group
), name
);
1570 ds_file_group
->stream
= bt2::Stream::Shared::createWithoutRef(stream
);
1572 int ret
= bt_stream_set_name(ds_file_group
->stream
->libObjPtr(), name
.c_str());
1574 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1575 "Cannot set stream's name: "
1576 "addr={}, stream-name=\"{}\"",
1577 fmt::ptr(ds_file_group
->stream
->libObjPtr()), name
);
1585 static const bt_param_validation_value_descr inputs_elem_descr
=
1586 bt_param_validation_value_descr::makeString();
1588 static bt_param_validation_map_value_entry_descr fs_params_entries_descr
[] = {
1589 {"inputs", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
1590 bt_param_validation_value_descr::makeArray(1, BT_PARAM_VALIDATION_INFINITE
,
1591 inputs_elem_descr
)},
1592 {"trace-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1593 bt_param_validation_value_descr::makeString()},
1594 {"clock-class-offset-s", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1595 bt_param_validation_value_descr::makeSignedInteger()},
1596 {"clock-class-offset-ns", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1597 bt_param_validation_value_descr::makeSignedInteger()},
1598 {"force-clock-class-origin-unix-epoch", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1599 bt_param_validation_value_descr::makeBool()},
1600 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
1602 bool read_src_fs_parameters(const bt_value
*params
, const bt_value
**inputs
,
1603 const bt_value
**trace_name
, struct ctf_fs_component
*ctf_fs
)
1605 const bt_value
*value
;
1606 enum bt_param_validation_status validate_value_status
;
1607 gchar
*error
= NULL
;
1609 validate_value_status
= bt_param_validation_validate(params
, fs_params_entries_descr
, &error
);
1610 if (validate_value_status
!= BT_PARAM_VALIDATION_STATUS_OK
) {
1611 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "{}", error
);
1616 /* inputs parameter */
1617 *inputs
= bt_value_map_borrow_entry_value_const(params
, "inputs");
1619 /* clock-class-offset-s parameter */
1620 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-s");
1622 ctf_fs
->clkClsCfg
.offsetSec
= bt_value_integer_signed_get(value
);
1625 /* clock-class-offset-ns parameter */
1626 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-ns");
1628 ctf_fs
->clkClsCfg
.offsetNanoSec
= bt_value_integer_signed_get(value
);
1631 /* force-clock-class-origin-unix-epoch parameter */
1632 value
= bt_value_map_borrow_entry_value_const(params
, "force-clock-class-origin-unix-epoch");
1634 ctf_fs
->clkClsCfg
.forceOriginIsUnixEpoch
= bt_value_bool_get(value
);
1637 /* trace-name parameter */
1638 *trace_name
= bt_value_map_borrow_entry_value_const(params
, "trace-name");
1643 static ctf_fs_component::UP
ctf_fs_create(const bt_value
*params
,
1644 bt_self_component_source
*self_comp_src
)
1646 const bt_value
*inputs_value
;
1647 const bt_value
*trace_name_value
;
1648 bt_self_component
*self_comp
= bt_self_component_source_as_self_component(self_comp_src
);
1650 ctf_fs_component::UP ctf_fs
= bt2s::make_unique
<ctf_fs_component
>(
1651 bt2c::Logger
{bt2::SelfSourceComponent
{self_comp_src
}, "PLUGIN/SRC.CTF.FS/COMP"});
1653 if (!read_src_fs_parameters(params
, &inputs_value
, &trace_name_value
, ctf_fs
.get())) {
1657 if (ctf_fs_component_create_ctf_fs_trace(ctf_fs
.get(), inputs_value
, trace_name_value
,
1662 if (create_streams_for_trace(ctf_fs
->trace
.get())) {
1666 if (create_ports_for_trace(ctf_fs
.get(), ctf_fs
->trace
.get(), self_comp_src
)) {
1673 bt_component_class_initialize_method_status
ctf_fs_init(bt_self_component_source
*self_comp_src
,
1674 bt_self_component_source_configuration
*,
1675 const bt_value
*params
, void *)
1678 bt_component_class_initialize_method_status ret
=
1679 BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
1681 ctf_fs_component::UP ctf_fs
= ctf_fs_create(params
, self_comp_src
);
1683 ret
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1686 bt_self_component_set_data(bt_self_component_source_as_self_component(self_comp_src
),
1689 } catch (const std::bad_alloc
&) {
1690 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1691 } catch (const bt2::Error
&) {
1692 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1696 bt_component_class_query_method_status
ctf_fs_query(bt_self_component_class_source
*comp_class_src
,
1697 bt_private_query_executor
*priv_query_exec
,
1698 const char *object
, const bt_value
*params
,
1699 __attribute__((unused
)) void *method_data
,
1700 const bt_value
**result
)
1703 bt2c::Logger logger
{bt2::SelfComponentClass
{comp_class_src
},
1704 bt2::PrivateQueryExecutor
{priv_query_exec
},
1705 "PLUGIN/SRC.CTF.FS/QUERY"};
1706 bt2::ConstMapValue
paramsObj(params
);
1707 bt2::Value::Shared resultObj
;
1709 if (strcmp(object
, "metadata-info") == 0) {
1710 resultObj
= metadata_info_query(paramsObj
, logger
);
1711 } else if (strcmp(object
, "babeltrace.trace-infos") == 0) {
1712 resultObj
= trace_infos_query(paramsObj
, logger
);
1713 } else if (!strcmp(object
, "babeltrace.support-info")) {
1714 resultObj
= support_info_query(paramsObj
, logger
);
1716 BT_CPPLOGE_SPEC(logger
, "Unknown query object `{}`", object
);
1717 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;
1720 *result
= resultObj
.release().libObjPtr();
1722 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
1723 } catch (const std::bad_alloc
&) {
1724 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
1725 } catch (const bt2::Error
&) {
1726 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;