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 const auto msg_iter_status
=
44 ctf_msg_iter_get_next_message(msg_iter_data
->msg_iter
.get(), out_msg
);
45 bt_message_iterator_class_next_method_status status
;
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
);
92 if (G_UNLIKELY(msg_iter_data
->next_saved_error
)) {
94 * Last time we were called, we hit an error but had some
95 * messages to deliver, so we stashed the error here. Return
98 BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(msg_iter_data
->next_saved_error
);
99 return msg_iter_data
->next_saved_status
;
102 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 ctf_fs_port_data
*port_data
= (struct ctf_fs_port_data
*) bt_self_component_port_get_data(
199 bt_self_component_port_output_as_self_component_port(self_port
));
200 BT_ASSERT(port_data
);
202 auto msg_iter_data
= bt2s::make_unique
<ctf_fs_msg_iter_data
>(self_msg_iter
);
203 msg_iter_data
->ds_file_group
= port_data
->ds_file_group
;
205 ctf_msg_iter_medium_status medium_status
= ctf_fs_ds_group_medops_data_create(
206 msg_iter_data
->ds_file_group
, self_msg_iter
, msg_iter_data
->logger
,
207 msg_iter_data
->msg_iter_medops_data
);
208 BT_ASSERT(medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_OK
||
209 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_ERROR
||
210 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
);
211 if (medium_status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
212 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
213 "Failed to create ctf_fs_ds_group_medops");
214 return ctf_msg_iter_medium_status_to_msg_iter_initialize_status(medium_status
);
217 msg_iter_data
->msg_iter
= ctf_msg_iter_create(
218 msg_iter_data
->ds_file_group
->ctf_fs_trace
->metadata
->tc
,
219 bt_common_get_page_size(static_cast<int>(msg_iter_data
->logger
.level())) * 8,
220 ctf_fs_ds_group_medops
, msg_iter_data
->msg_iter_medops_data
.get(), self_msg_iter
,
221 msg_iter_data
->logger
);
222 if (!msg_iter_data
->msg_iter
) {
223 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
224 "Cannot create a CTF message iterator.");
225 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
229 * This iterator can seek forward if its stream class has a default
232 if (msg_iter_data
->ds_file_group
->sc
->default_clock_class
) {
233 bt_self_message_iterator_configuration_set_can_seek_forward(config
, true);
236 bt_self_message_iterator_set_data(self_msg_iter
, msg_iter_data
.release());
238 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
239 } catch (const std::bad_alloc
&) {
240 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
241 } catch (const bt2::Error
&) {
242 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
246 void ctf_fs_finalize(bt_self_component_source
*component
)
248 ctf_fs_component::UP
{static_cast<ctf_fs_component
*>(
249 bt_self_component_get_data(bt_self_component_source_as_self_component(component
)))};
252 std::string
ctf_fs_make_port_name(ctf_fs_ds_file_group
*ds_file_group
)
254 std::stringstream name
;
257 * The unique port name is generated by concatenating unique identifiers
265 /* For the trace, use the uuid if present, else the path. */
266 if (ds_file_group
->ctf_fs_trace
->metadata
->tc
->is_uuid_set
) {
267 char uuid_str
[BT_UUID_STR_LEN
+ 1];
269 bt_uuid_to_str(ds_file_group
->ctf_fs_trace
->metadata
->tc
->uuid
, uuid_str
);
272 name
<< ds_file_group
->ctf_fs_trace
->path
;
276 * For the stream class, use the id if present. We can omit this field
277 * otherwise, as there will only be a single stream class.
279 if (ds_file_group
->sc
->id
!= UINT64_C(-1)) {
280 name
<< " | " << ds_file_group
->sc
->id
;
283 /* For the stream, use the id if present, else, use the path. */
284 if (ds_file_group
->stream_id
!= UINT64_C(-1)) {
285 name
<< " | " << ds_file_group
->stream_id
;
287 BT_ASSERT(ds_file_group
->ds_file_infos
.size() == 1);
288 const auto& ds_file_info
= *ds_file_group
->ds_file_infos
[0];
289 name
<< " | " << ds_file_info
.path
;
295 static int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
296 struct ctf_fs_ds_file_group
*ds_file_group
,
297 bt_self_component_source
*self_comp_src
)
299 const auto port_name
= ctf_fs_make_port_name(ds_file_group
);
300 auto port_data
= bt2s::make_unique
<ctf_fs_port_data
>();
302 BT_CPPLOGI_SPEC(ctf_fs
->logger
, "Creating one port named `{}`", port_name
);
304 port_data
->ctf_fs
= ctf_fs
;
305 port_data
->ds_file_group
= ds_file_group
;
307 int ret
= bt_self_component_source_add_output_port(self_comp_src
, port_name
.c_str(),
308 port_data
.get(), NULL
);
313 ctf_fs
->port_data
.emplace_back(std::move(port_data
));
317 static int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
318 struct ctf_fs_trace
*ctf_fs_trace
,
319 bt_self_component_source
*self_comp_src
)
321 /* Create one output port for each stream file group */
322 for (const auto& ds_file_group
: ctf_fs_trace
->ds_file_groups
) {
323 int ret
= create_one_port_for_trace(ctf_fs
, ds_file_group
.get(), self_comp_src
);
325 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create output port.");
334 * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right
335 * place to keep it sorted.
338 static void ds_file_group_insert_ds_file_info_sorted(struct ctf_fs_ds_file_group
*ds_file_group
,
339 ctf_fs_ds_file_info::UP ds_file_info
)
341 /* Find the spot where to insert this ds_file_info. */
342 auto it
= ds_file_group
->ds_file_infos
.begin();
344 for (; it
!= ds_file_group
->ds_file_infos
.end(); ++it
) {
345 const ctf_fs_ds_file_info
& other_ds_file_info
= **it
;
347 if (ds_file_info
->begin_ns
< other_ds_file_info
.begin_ns
) {
352 ds_file_group
->ds_file_infos
.insert(it
, std::move(ds_file_info
));
355 static bool ds_index_entries_equal(const ctf_fs_ds_index_entry
& left
,
356 const ctf_fs_ds_index_entry
& right
)
358 if (left
.packetSize
!= right
.packetSize
) {
362 if (left
.timestamp_begin
!= right
.timestamp_begin
) {
366 if (left
.timestamp_end
!= right
.timestamp_end
) {
370 if (left
.packet_seq_num
!= right
.packet_seq_num
) {
378 * Insert `entry` into `index`, without duplication.
380 * The entry is inserted only if there isn't an identical entry already.
383 static void ds_index_insert_ds_index_entry_sorted(struct ctf_fs_ds_index
*index
,
384 const ctf_fs_ds_index_entry
& entry
)
386 /* Find the spot where to insert this index entry. */
387 auto otherEntry
= index
->entries
.begin();
388 for (; otherEntry
!= index
->entries
.end(); ++otherEntry
) {
389 if (entry
.timestamp_begin_ns
<= otherEntry
->timestamp_begin_ns
) {
395 * Insert the entry only if a duplicate doesn't already exist.
397 * There can be duplicate packets if reading multiple overlapping
398 * snapshots of the same trace. We then want the index to contain
399 * a reference to only one copy of that packet.
401 if (otherEntry
== index
->entries
.end() || !ds_index_entries_equal(entry
, *otherEntry
)) {
402 index
->entries
.emplace(otherEntry
, entry
);
406 static void merge_ctf_fs_ds_indexes(struct ctf_fs_ds_index
*dest
, const ctf_fs_ds_index
& src
)
408 for (const auto& entry
: src
.entries
) {
409 ds_index_insert_ds_index_entry_sorted(dest
, entry
);
413 static int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
, const char *path
)
416 * Create a temporary ds_file to read some properties about the data
420 ctf_fs_ds_file_create(ctf_fs_trace
, bt2::Stream::Shared
{}, path
, ctf_fs_trace
->logger
);
425 /* Create a temporary iterator to read the ds_file. */
426 ctf_msg_iter_up msg_iter
= ctf_msg_iter_create(
427 ctf_fs_trace
->metadata
->tc
,
428 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
429 ctf_fs_ds_file_medops
, ds_file
.get(), nullptr, ctf_fs_trace
->logger
);
431 BT_CPPLOGE_STR_SPEC(ctf_fs_trace
->logger
, "Cannot create a CTF message iterator.");
435 ctf_msg_iter_set_dry_run(msg_iter
.get(), true);
437 ctf_msg_iter_packet_properties props
;
438 int ret
= ctf_msg_iter_get_packet_properties(msg_iter
.get(), &props
);
440 BT_CPPLOGE_APPEND_CAUSE_SPEC(
441 ctf_fs_trace
->logger
,
442 "Cannot get stream file's first packet's header and context fields (`{}`).", path
);
446 ctf_stream_class
*sc
=
447 ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
, props
.stream_class_id
);
449 int64_t stream_instance_id
= props
.data_stream_id
;
450 int64_t begin_ns
= -1;
452 if (props
.snapshots
.beginning_clock
!= UINT64_C(-1)) {
453 BT_ASSERT(sc
->default_clock_class
);
454 ret
= bt_util_clock_cycles_to_ns_from_origin(
455 props
.snapshots
.beginning_clock
, sc
->default_clock_class
->frequency
,
456 sc
->default_clock_class
->offset_seconds
, sc
->default_clock_class
->offset_cycles
,
459 BT_CPPLOGE_APPEND_CAUSE_SPEC(
460 ctf_fs_trace
->logger
,
461 "Cannot convert clock cycles to nanoseconds from origin (`{}`).", path
);
466 ctf_fs_ds_file_info::UP ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
);
471 auto index
= ctf_fs_ds_file_build_index(ds_file
.get(), ds_file_info
.get(), msg_iter
.get());
473 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to index CTF stream file \'{}\'",
474 ds_file
->file
->path
);
478 if (begin_ns
== -1) {
480 * No beginning timestamp to sort the stream files
481 * within a stream file group, so consider that this
482 * file must be the only one within its group.
484 stream_instance_id
= -1;
487 if (stream_instance_id
== -1) {
489 * No stream instance ID or no beginning timestamp:
490 * create a unique stream file group for this stream
491 * file because, even if there's a stream instance ID,
492 * there's no timestamp to order the file within its
495 auto new_ds_file_group
=
496 ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, UINT64_C(-1), std::move(*index
));
498 if (!new_ds_file_group
) {
502 ds_file_group_insert_ds_file_info_sorted(new_ds_file_group
.get(), std::move(ds_file_info
));
503 ctf_fs_trace
->ds_file_groups
.emplace_back(std::move(new_ds_file_group
));
507 BT_ASSERT(stream_instance_id
!= -1);
508 BT_ASSERT(begin_ns
!= -1);
510 /* Find an existing stream file group with this ID */
511 ctf_fs_ds_file_group
*ds_file_group
= NULL
;
512 for (const auto& candidate
: ctf_fs_trace
->ds_file_groups
) {
513 if (candidate
->sc
== sc
&& candidate
->stream_id
== stream_instance_id
) {
514 ds_file_group
= candidate
.get();
519 ctf_fs_ds_file_group::UP new_ds_file_group
;
521 if (!ds_file_group
) {
523 ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, stream_instance_id
, std::move(*index
));
524 if (!new_ds_file_group
) {
528 ds_file_group
= new_ds_file_group
.get();
529 ctf_fs_trace
->ds_file_groups
.emplace_back(std::move(new_ds_file_group
));
531 merge_ctf_fs_ds_indexes(&ds_file_group
->index
, *index
);
534 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, std::move(ds_file_info
));
539 static int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
541 /* Check each file in the path directory, except specific ones */
542 GError
*error
= NULL
;
543 const bt2c::GDirUP dir
{g_dir_open(ctf_fs_trace
->path
.c_str(), 0, &error
)};
545 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
546 "Cannot open directory `{}`: {} (code {})", ctf_fs_trace
->path
,
547 error
->message
, error
->code
);
554 while (const char *basename
= g_dir_read_name(dir
.get())) {
555 if (strcmp(basename
, CTF_FS_METADATA_FILENAME
) == 0) {
556 /* Ignore the metadata stream. */
557 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
558 "Ignoring metadata file `{}" G_DIR_SEPARATOR_S
"{}`",
559 ctf_fs_trace
->path
, basename
);
563 if (basename
[0] == '.') {
564 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
565 "Ignoring hidden file `{}" G_DIR_SEPARATOR_S
"{}`", ctf_fs_trace
->path
,
570 /* Create the file. */
571 ctf_fs_file file
{ctf_fs_trace
->logger
};
573 /* Create full path string. */
574 file
.path
= fmt::format("{}" G_DIR_SEPARATOR_S
"{}", ctf_fs_trace
->path
, basename
);
576 if (!g_file_test(file
.path
.c_str(), G_FILE_TEST_IS_REGULAR
)) {
577 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring non-regular file `{}`", file
.path
);
581 int ret
= ctf_fs_file_open(&file
, "rb");
583 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Cannot open stream file `{}`",
588 if (file
.size
== 0) {
589 /* Skip empty stream. */
590 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring empty file `{}`", file
.path
);
594 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
, file
.path
.c_str());
596 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
597 "Cannot add stream file `{}` to stream file group",
606 static int set_trace_name(bt_trace
*trace
, const char *name_suffix
)
611 * Check if we have a trace environment string value named `hostname`.
612 * If so, use it as the trace name's prefix.
614 const bt_value
*val
= bt_trace_borrow_environment_entry_value_by_name_const(trace
, "hostname");
615 if (val
&& bt_value_is_string(val
)) {
616 name
+= bt_value_string_get(val
);
619 name
+= G_DIR_SEPARATOR
;
627 return bt_trace_set_name(trace
, name
.c_str());
630 static ctf_fs_trace::UP
ctf_fs_trace_create(const char *path
, const char *name
,
631 const ctf::src::ClkClsCfg
& clkClsCfg
,
632 bt_self_component
*selfComp
,
633 const bt2c::Logger
& parentLogger
)
635 ctf_fs_trace::UP ctf_fs_trace
= bt2s::make_unique
<struct ctf_fs_trace
>(parentLogger
);
636 ctf_fs_trace
->path
= path
;
637 ctf_fs_trace
->metadata
= bt2s::make_unique
<ctf_fs_metadata
>();
639 int ret
= ctf_fs_metadata_set_trace_class(selfComp
, ctf_fs_trace
.get(), clkClsCfg
);
644 if (ctf_fs_trace
->metadata
->trace_class
) {
645 bt_trace
*trace
= bt_trace_create(ctf_fs_trace
->metadata
->trace_class
->libObjPtr());
650 ctf_fs_trace
->trace
= bt2::Trace::Shared::createWithoutRef(trace
);
653 if (ctf_fs_trace
->trace
) {
654 ret
= ctf_trace_class_configure_ir_trace(ctf_fs_trace
->metadata
->tc
,
655 ctf_fs_trace
->trace
->libObjPtr());
660 ret
= set_trace_name(ctf_fs_trace
->trace
->libObjPtr(), name
);
666 ret
= create_ds_file_groups(ctf_fs_trace
.get());
674 static int path_is_ctf_trace(const char *path
)
676 return g_file_test(fmt::format("{}" G_DIR_SEPARATOR_S CTF_FS_METADATA_FILENAME
, path
).c_str(),
677 G_FILE_TEST_IS_REGULAR
);
680 /* Helper for ctf_fs_component_create_ctf_fs_trace, to handle a single path. */
682 static int ctf_fs_component_create_ctf_fs_trace_one_path(struct ctf_fs_component
*ctf_fs
,
683 const char *path_param
,
684 const char *trace_name
,
685 std::vector
<ctf_fs_trace::UP
>& traces
,
686 bt_self_component
*selfComp
)
688 bt2c::GStringUP norm_path
{bt_common_normalize_path(path_param
, NULL
)};
690 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to normalize path: `{}`.", path_param
);
694 int ret
= path_is_ctf_trace(norm_path
->str
);
696 BT_CPPLOGE_APPEND_CAUSE_SPEC(
697 ctf_fs
->logger
, "Failed to check if path is a CTF trace: path={}", norm_path
->str
);
699 } else if (ret
== 0) {
700 BT_CPPLOGE_APPEND_CAUSE_SPEC(
701 ctf_fs
->logger
, "Path is not a CTF trace (does not contain a metadata file): `{}`.",
706 // FIXME: Remove or ifdef for __MINGW32__
707 if (strcmp(norm_path
->str
, "/") == 0) {
708 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Opening a trace in `/` is not supported.");
712 ctf_fs_trace::UP ctf_fs_trace
= ctf_fs_trace_create(
713 norm_path
->str
, trace_name
, ctf_fs
->clkClsCfg
, selfComp
, ctf_fs
->logger
);
715 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create trace for `{}`.",
720 traces
.emplace_back(std::move(ctf_fs_trace
));
726 * Count the number of stream and event classes defined by this trace's metadata.
728 * This is used to determine which metadata is the "latest", out of multiple
729 * traces sharing the same UUID. It is assumed that amongst all these metadatas,
730 * a bigger metadata is a superset of a smaller metadata. Therefore, it is
731 * enough to just count the classes.
734 static unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace
*trace
)
736 unsigned int num
= trace
->metadata
->tc
->stream_classes
->len
;
738 for (guint i
= 0; i
< trace
->metadata
->tc
->stream_classes
->len
; i
++) {
739 struct ctf_stream_class
*sc
=
740 (struct ctf_stream_class
*) trace
->metadata
->tc
->stream_classes
->pdata
[i
];
741 num
+= sc
->event_classes
->len
;
748 * Merge the src ds_file_group into dest. This consists of merging their
749 * ds_file_infos, making sure to keep the result sorted.
752 static void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group
*dest
,
753 ctf_fs_ds_file_group::UP src
)
755 for (auto& ds_file_info
: src
->ds_file_infos
) {
756 ds_file_group_insert_ds_file_info_sorted(dest
, std::move(ds_file_info
));
759 /* Merge both indexes. */
760 merge_ctf_fs_ds_indexes(&dest
->index
, src
->index
);
763 /* Merge src_trace's data stream file groups into dest_trace's. */
765 static int merge_matching_ctf_fs_ds_file_groups(struct ctf_fs_trace
*dest_trace
,
766 ctf_fs_trace::UP src_trace
)
768 std::vector
<ctf_fs_ds_file_group::UP
>& dest
= dest_trace
->ds_file_groups
;
769 std::vector
<ctf_fs_ds_file_group::UP
>& src
= src_trace
->ds_file_groups
;
772 * Save the initial length of dest: we only want to check against the
773 * original elements in the inner loop.
775 size_t dest_len
= dest
.size();
777 for (auto& src_group
: src
) {
778 struct ctf_fs_ds_file_group
*dest_group
= NULL
;
780 /* A stream instance without ID can't match a stream in the other trace. */
781 if (src_group
->stream_id
!= -1) {
782 /* Let's search for a matching ds_file_group in the destination. */
783 for (size_t d_i
= 0; d_i
< dest_len
; ++d_i
) {
784 ctf_fs_ds_file_group
*candidate_dest
= dest
[d_i
].get();
786 /* Can't match a stream instance without ID. */
787 if (candidate_dest
->stream_id
== -1) {
792 * If the two groups have the same stream instance id
793 * and belong to the same stream class (stream instance
794 * ids are per-stream class), they represent the same
797 if (candidate_dest
->stream_id
!= src_group
->stream_id
||
798 candidate_dest
->sc
->id
!= src_group
->sc
->id
) {
802 dest_group
= candidate_dest
;
808 * Didn't find a friend in dest to merge our src_group into?
809 * Create a new empty one. This can happen if a stream was
810 * active in the source trace chunk but not in the destination
814 ctf_stream_class
*sc
= ctf_trace_class_borrow_stream_class_by_id(
815 dest_trace
->metadata
->tc
, src_group
->sc
->id
);
818 auto new_dest_group
=
819 ctf_fs_ds_file_group_create(dest_trace
, sc
, src_group
->stream_id
, {});
821 if (!new_dest_group
) {
825 dest_group
= new_dest_group
.get();
826 dest_trace
->ds_file_groups
.emplace_back(std::move(new_dest_group
));
829 BT_ASSERT(dest_group
);
830 merge_ctf_fs_ds_file_groups(dest_group
, std::move(src_group
));
837 * Collapse the given traces, which must all share the same UUID, in a single
840 * The trace with the most expansive metadata is chosen and all other traces
841 * are merged into that one. On return, the elements of `traces` are nullptr
842 * and the merged trace is placed in `out_trace`.
845 static int merge_ctf_fs_traces(std::vector
<ctf_fs_trace::UP
> traces
, ctf_fs_trace::UP
& out_trace
)
847 BT_ASSERT(traces
.size() >= 2);
849 unsigned int winner_count
= metadata_count_stream_and_event_classes(traces
[0].get());
850 ctf_fs_trace
*winner
= traces
[0].get();
853 /* Find the trace with the largest metadata. */
854 for (guint i
= 1; i
< traces
.size(); i
++) {
855 ctf_fs_trace
*candidate
= traces
[i
].get();
856 unsigned int candidate_count
;
858 /* A bit of sanity check. */
859 BT_ASSERT(bt_uuid_compare(winner
->metadata
->tc
->uuid
, candidate
->metadata
->tc
->uuid
) == 0);
861 candidate_count
= metadata_count_stream_and_event_classes(candidate
);
863 if (candidate_count
> winner_count
) {
864 winner_count
= candidate_count
;
870 /* Merge all the other traces in the winning trace. */
871 for (ctf_fs_trace::UP
& trace
: traces
) {
872 /* Don't merge the winner into itself. */
873 if (trace
.get() == winner
) {
877 /* Merge trace's data stream file groups into winner's. */
878 int ret
= merge_matching_ctf_fs_ds_file_groups(winner
, std::move(trace
));
885 * Move the winner out of the array, into `*out_trace`.
887 out_trace
= std::move(traces
[winner_i
]);
898 static int decode_clock_snapshot_after_event(struct ctf_fs_trace
*ctf_fs_trace
,
899 struct ctf_clock_class
*default_cc
,
900 const ctf_fs_ds_index_entry
& index_entry
,
901 enum target_event target_event
, uint64_t *cs
,
904 BT_ASSERT(ctf_fs_trace
);
905 BT_ASSERT(index_entry
.path
);
907 const auto ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, bt2::Stream::Shared
{},
908 index_entry
.path
, ctf_fs_trace
->logger
);
910 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to create a ctf_fs_ds_file");
914 BT_ASSERT(ctf_fs_trace
->metadata
);
915 BT_ASSERT(ctf_fs_trace
->metadata
->tc
);
917 ctf_msg_iter_up msg_iter
= ctf_msg_iter_create(
918 ctf_fs_trace
->metadata
->tc
,
919 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
921 ctf_fs_ds_file_medops
, ds_file
.get(), NULL
, ctf_fs_trace
->logger
);
923 /* ctf_msg_iter_create() logs errors. */
928 * Turn on dry run mode to prevent the creation and usage of Babeltrace
929 * library objects (bt_field, bt_message_*, etc.).
931 ctf_msg_iter_set_dry_run(msg_iter
.get(), true);
933 /* Seek to the beginning of the target packet. */
934 enum ctf_msg_iter_status iter_status
=
935 ctf_msg_iter_seek(msg_iter
.get(), index_entry
.offset
.bytes());
937 /* ctf_msg_iter_seek() logs errors. */
941 switch (target_event
) {
944 * Start to decode the packet until we reach the end of
945 * the first event. To extract the first event's clock
948 iter_status
= ctf_msg_iter_curr_packet_first_event_clock_snapshot(msg_iter
.get(), cs
);
951 /* Decode the packet to extract the last event's clock snapshot. */
952 iter_status
= ctf_msg_iter_curr_packet_last_event_clock_snapshot(msg_iter
.get(), cs
);
961 /* Convert clock snapshot to timestamp. */
962 int ret
= bt_util_clock_cycles_to_ns_from_origin(
963 *cs
, default_cc
->frequency
, default_cc
->offset_seconds
, default_cc
->offset_cycles
, ts_ns
);
965 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
966 "Failed to convert clock snapshot to timestamp");
973 static int decode_packet_first_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
974 struct ctf_clock_class
*default_cc
,
975 const ctf_fs_ds_index_entry
& index_entry
,
976 uint64_t *cs
, int64_t *ts_ns
)
978 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, FIRST_EVENT
, cs
,
982 static int decode_packet_last_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
983 struct ctf_clock_class
*default_cc
,
984 const ctf_fs_ds_index_entry
& index_entry
,
985 uint64_t *cs
, int64_t *ts_ns
)
987 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, LAST_EVENT
, cs
,
992 * Fix up packet index entries for lttng's "event-after-packet" bug.
993 * Some buggy lttng tracer versions may emit events with a timestamp that is
994 * larger (after) than the timestamp_end of the their packets.
996 * To fix up this erroneous data we do the following:
997 * 1. If it's not the stream file's last packet: set the packet index entry's
998 * end time to the next packet's beginning time.
999 * 2. If it's the stream file's last packet, set the packet index entry's end
1000 * time to the packet's last event's time, if any, or to the packet's
1001 * beginning time otherwise.
1003 * Known buggy tracer versions:
1004 * - before lttng-ust 2.11.0
1005 * - before lttng-module 2.11.0
1006 * - before lttng-module 2.10.10
1007 * - before lttng-module 2.9.13
1009 static int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace
*trace
)
1011 for (const auto& ds_file_group
: trace
->ds_file_groups
) {
1012 BT_ASSERT(ds_file_group
);
1013 auto& index
= ds_file_group
->index
;
1015 BT_ASSERT(!index
.entries
.empty());
1018 * Iterate over all entries but the last one. The last one is
1019 * fixed differently after.
1021 for (size_t entry_i
= 0; entry_i
< index
.entries
.size() - 1; ++entry_i
) {
1022 auto& curr_entry
= index
.entries
[entry_i
];
1023 const auto& next_entry
= index
.entries
[entry_i
+ 1];
1026 * 1. Set the current index entry `end` timestamp to
1027 * the next index entry `begin` timestamp.
1029 curr_entry
.timestamp_end
= next_entry
.timestamp_begin
;
1030 curr_entry
.timestamp_end_ns
= next_entry
.timestamp_begin_ns
;
1034 * 2. Fix the last entry by decoding the last event of the last
1037 auto& last_entry
= index
.entries
.back();
1039 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1040 ctf_clock_class
*default_cc
= ds_file_group
->sc
->default_clock_class
;
1043 * Decode packet to read the timestamp of the last event of the
1046 int ret
= decode_packet_last_event_timestamp(
1047 trace
, default_cc
, last_entry
, &last_entry
.timestamp_end
, &last_entry
.timestamp_end_ns
);
1049 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1051 "Failed to decode stream's last packet to get its last event's clock snapshot.");
1060 * Fix up packet index entries for barectf's "event-before-packet" bug.
1061 * Some buggy barectf tracer versions may emit events with a timestamp that is
1062 * less than the timestamp_begin of the their packets.
1064 * To fix up this erroneous data we do the following:
1065 * 1. Starting at the second index entry, set the timestamp_begin of the
1066 * current entry to the timestamp of the first event of the packet.
1067 * 2. Set the previous entry's timestamp_end to the timestamp_begin of the
1070 * Known buggy tracer versions:
1071 * - before barectf 2.3.1
1073 static int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace
*trace
)
1075 for (const auto& ds_file_group
: trace
->ds_file_groups
) {
1076 auto& index
= ds_file_group
->index
;
1078 BT_ASSERT(!index
.entries
.empty());
1080 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1081 ctf_clock_class
*default_cc
= ds_file_group
->sc
->default_clock_class
;
1084 * 1. Iterate over the index, starting from the second entry
1087 for (size_t entry_i
= 1; entry_i
< index
.entries
.size(); ++entry_i
) {
1088 auto& prev_entry
= index
.entries
[entry_i
- 1];
1089 auto& curr_entry
= index
.entries
[entry_i
];
1091 * 2. Set the current entry `begin` timestamp to the
1092 * timestamp of the first event of the current packet.
1094 int ret
= decode_packet_first_event_timestamp(trace
, default_cc
, curr_entry
,
1095 &curr_entry
.timestamp_begin
,
1096 &curr_entry
.timestamp_begin_ns
);
1098 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1099 "Failed to decode first event's clock snapshot");
1104 * 3. Set the previous entry `end` timestamp to the
1105 * timestamp of the first event of the current packet.
1107 prev_entry
.timestamp_end
= curr_entry
.timestamp_begin
;
1108 prev_entry
.timestamp_end_ns
= curr_entry
.timestamp_begin_ns
;
1116 * When using the lttng-crash feature it's likely that the last packets of each
1117 * stream have their timestamp_end set to zero. This is caused by the fact that
1118 * the tracer crashed and was not able to properly close the packets.
1120 * To fix up this erroneous data we do the following:
1121 * For each index entry, if the entry's timestamp_end is 0 and the
1122 * timestamp_begin is not 0:
1123 * - If it's the stream file's last packet: set the packet index entry's end
1124 * time to the packet's last event's time, if any, or to the packet's
1125 * beginning time otherwise.
1126 * - If it's not the stream file's last packet: set the packet index
1127 * entry's end time to the next packet's beginning time.
1129 * Affected versions:
1130 * - All current and future lttng-ust and lttng-modules versions.
1132 static int fix_index_lttng_crash_quirk(struct ctf_fs_trace
*trace
)
1134 for (const auto& ds_file_group
: trace
->ds_file_groups
) {
1135 struct ctf_clock_class
*default_cc
;
1137 BT_ASSERT(ds_file_group
);
1138 auto& index
= ds_file_group
->index
;
1140 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1141 default_cc
= ds_file_group
->sc
->default_clock_class
;
1143 BT_ASSERT(!index
.entries
.empty());
1145 auto& last_entry
= index
.entries
.back();
1147 /* 1. Fix the last entry first. */
1148 if (last_entry
.timestamp_end
== 0 && last_entry
.timestamp_begin
!= 0) {
1150 * Decode packet to read the timestamp of the
1151 * last event of the stream file.
1153 int ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1154 &last_entry
.timestamp_end
,
1155 &last_entry
.timestamp_end_ns
);
1157 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1158 "Failed to decode last event's clock snapshot");
1163 /* Iterate over all entries but the last one. */
1164 for (size_t entry_idx
= 0; entry_idx
< index
.entries
.size() - 1; ++entry_idx
) {
1165 auto& curr_entry
= index
.entries
[entry_idx
];
1166 const auto& next_entry
= index
.entries
[entry_idx
+ 1];
1168 if (curr_entry
.timestamp_end
== 0 && curr_entry
.timestamp_begin
!= 0) {
1170 * 2. Set the current index entry `end` timestamp to
1171 * the next index entry `begin` timestamp.
1173 curr_entry
.timestamp_end
= next_entry
.timestamp_begin
;
1174 curr_entry
.timestamp_end_ns
= next_entry
.timestamp_begin_ns
;
1183 * Extract the tracer information necessary to compare versions.
1184 * Returns 0 on success, and -1 if the extraction is not successful because the
1185 * necessary fields are absents in the trace metadata.
1187 static int extract_tracer_info(struct ctf_fs_trace
*trace
, struct tracer_info
*current_tracer_info
)
1189 /* Clear the current_tracer_info struct */
1190 memset(current_tracer_info
, 0, sizeof(*current_tracer_info
));
1193 * To compare 2 tracer versions, at least the tracer name and it's
1194 * major version are needed. If one of these is missing, consider it an
1195 * extraction failure.
1197 ctf_trace_class_env_entry
*entry
=
1198 ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_name");
1199 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR
) {
1203 /* Set tracer name. */
1204 current_tracer_info
->name
= entry
->value
.str
->str
;
1206 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_major");
1207 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1211 /* Set major version number. */
1212 current_tracer_info
->major
= entry
->value
.i
;
1214 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_minor");
1215 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1219 /* Set minor version number. */
1220 current_tracer_info
->minor
= entry
->value
.i
;
1222 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patch");
1225 * If `tracer_patch` doesn't exist `tracer_patchlevel` might.
1226 * For example, `lttng-modules` uses entry name
1227 * `tracer_patchlevel`.
1229 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patchlevel");
1232 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1236 /* Set patch version number. */
1237 current_tracer_info
->patch
= entry
->value
.i
;
1242 static bool is_tracer_affected_by_lttng_event_after_packet_bug(struct tracer_info
*curr_tracer_info
)
1244 bool is_affected
= false;
1246 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1247 if (curr_tracer_info
->major
< 2) {
1249 } else if (curr_tracer_info
->major
== 2) {
1250 /* fixed in lttng-ust 2.11.0 */
1251 if (curr_tracer_info
->minor
< 11) {
1255 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1256 if (curr_tracer_info
->major
< 2) {
1258 } else if (curr_tracer_info
->major
== 2) {
1259 /* fixed in lttng-modules 2.11.0 */
1260 if (curr_tracer_info
->minor
== 10) {
1261 /* fixed in lttng-modules 2.10.10 */
1262 if (curr_tracer_info
->patch
< 10) {
1265 } else if (curr_tracer_info
->minor
== 9) {
1266 /* fixed in lttng-modules 2.9.13 */
1267 if (curr_tracer_info
->patch
< 13) {
1270 } else if (curr_tracer_info
->minor
< 9) {
1280 is_tracer_affected_by_barectf_event_before_packet_bug(struct tracer_info
*curr_tracer_info
)
1282 bool is_affected
= false;
1284 if (strcmp(curr_tracer_info
->name
, "barectf") == 0) {
1285 if (curr_tracer_info
->major
< 2) {
1287 } else if (curr_tracer_info
->major
== 2) {
1288 if (curr_tracer_info
->minor
< 3) {
1290 } else if (curr_tracer_info
->minor
== 3) {
1291 /* fixed in barectf 2.3.1 */
1292 if (curr_tracer_info
->patch
< 1) {
1302 static bool is_tracer_affected_by_lttng_crash_quirk(struct tracer_info
*curr_tracer_info
)
1304 bool is_affected
= false;
1306 /* All LTTng tracer may be affected by this lttng crash quirk. */
1307 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1309 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1317 * Looks for trace produced by known buggy tracers and fix up the index
1320 static int fix_packet_index_tracer_bugs(ctf_fs_trace
*trace
)
1322 struct tracer_info current_tracer_info
;
1324 int ret
= extract_tracer_info(trace
, ¤t_tracer_info
);
1327 * A trace may not have all the necessary environment
1328 * entries to do the tracer version comparison.
1329 * At least, the tracer name and major version number
1330 * are needed. Failing to extract these entries is not
1333 BT_CPPLOGI_STR_SPEC(
1335 "Cannot extract tracer information necessary to compare with buggy versions.");
1339 /* Check if the trace may be affected by old tracer bugs. */
1340 if (is_tracer_affected_by_lttng_event_after_packet_bug(¤t_tracer_info
)) {
1341 BT_CPPLOGI_STR_SPEC(
1343 "Trace may be affected by LTTng tracer packet timestamp bug. Fixing up.");
1344 ret
= fix_index_lttng_event_after_packet_bug(trace
);
1346 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1347 "Failed to fix LTTng event-after-packet bug.");
1350 trace
->metadata
->tc
->quirks
.lttng_event_after_packet
= true;
1353 if (is_tracer_affected_by_barectf_event_before_packet_bug(¤t_tracer_info
)) {
1354 BT_CPPLOGI_STR_SPEC(
1356 "Trace may be affected by barectf tracer packet timestamp bug. Fixing up.");
1357 ret
= fix_index_barectf_event_before_packet_bug(trace
);
1359 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1360 "Failed to fix barectf event-before-packet bug.");
1363 trace
->metadata
->tc
->quirks
.barectf_event_before_packet
= true;
1366 if (is_tracer_affected_by_lttng_crash_quirk(¤t_tracer_info
)) {
1367 ret
= fix_index_lttng_crash_quirk(trace
);
1369 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1370 "Failed to fix lttng-crash timestamp quirks.");
1373 trace
->metadata
->tc
->quirks
.lttng_crash
= true;
1379 static bool compare_ds_file_groups_by_first_path(const ctf_fs_ds_file_group::UP
& ds_file_group_a
,
1380 const ctf_fs_ds_file_group::UP
& ds_file_group_b
)
1382 BT_ASSERT(!ds_file_group_a
->ds_file_infos
.empty());
1383 BT_ASSERT(!ds_file_group_b
->ds_file_infos
.empty());
1385 const auto& first_ds_file_info_a
= *ds_file_group_a
->ds_file_infos
[0];
1386 const auto& first_ds_file_info_b
= *ds_file_group_b
->ds_file_infos
[0];
1388 return first_ds_file_info_a
.path
< first_ds_file_info_b
.path
;
1391 int ctf_fs_component_create_ctf_fs_trace(struct ctf_fs_component
*ctf_fs
,
1392 const bt_value
*paths_value
,
1393 const bt_value
*trace_name_value
,
1394 bt_self_component
*selfComp
)
1396 std::vector
<std::string
> paths
;
1398 BT_ASSERT(bt_value_get_type(paths_value
) == BT_VALUE_TYPE_ARRAY
);
1399 BT_ASSERT(!bt_value_array_is_empty(paths_value
));
1401 const char *trace_name
= trace_name_value
? bt_value_string_get(trace_name_value
) : NULL
;
1404 * Create a sorted array of the paths, to make the execution of this
1405 * component deterministic.
1407 for (std::uint64_t i
= 0; i
< bt_value_array_get_length(paths_value
); i
++) {
1408 const bt_value
*path_value
= bt_value_array_borrow_element_by_index_const(paths_value
, i
);
1409 const char *input
= bt_value_string_get(path_value
);
1410 paths
.emplace_back(input
);
1413 std::sort(paths
.begin(), paths
.end());
1415 /* Create a separate ctf_fs_trace object for each path. */
1416 std::vector
<ctf_fs_trace::UP
> traces
;
1417 for (const auto& path
: paths
) {
1418 int ret
= ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs
, path
.c_str(), trace_name
,
1425 if (traces
.size() > 1) {
1426 ctf_fs_trace
*first_trace
= traces
[0].get();
1427 const uint8_t *first_trace_uuid
= first_trace
->metadata
->tc
->uuid
;
1430 * We have more than one trace, they must all share the same
1431 * UUID, verify that.
1433 for (size_t i
= 0; i
< traces
.size(); i
++) {
1434 ctf_fs_trace
*this_trace
= traces
[i
].get();
1435 const uint8_t *this_trace_uuid
= this_trace
->metadata
->tc
->uuid
;
1437 if (!this_trace
->metadata
->tc
->is_uuid_set
) {
1438 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1440 "Multiple traces given, but a trace does not have a UUID: path={}",
1445 if (bt_uuid_compare(first_trace_uuid
, this_trace_uuid
) != 0) {
1446 char first_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1447 char this_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1449 bt_uuid_to_str(first_trace_uuid
, first_trace_uuid_str
);
1450 bt_uuid_to_str(this_trace_uuid
, this_trace_uuid_str
);
1452 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1453 "Multiple traces given, but UUIDs don't match: "
1454 "first-trace-uuid={}, first-trace-path={}, "
1455 "trace-uuid={}, trace-path={}",
1456 first_trace_uuid_str
, first_trace
->path
,
1457 this_trace_uuid_str
, this_trace
->path
);
1462 int ret
= merge_ctf_fs_traces(std::move(traces
), ctf_fs
->trace
);
1464 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1465 "Failed to merge traces with the same UUID.");
1469 /* Just one trace, it may or may not have a UUID, both are fine. */
1470 ctf_fs
->trace
= std::move(traces
[0]);
1473 int ret
= fix_packet_index_tracer_bugs(ctf_fs
->trace
.get());
1475 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to fix packet index tracer bugs.");
1480 * Sort data stream file groups by first data stream file info
1481 * path to get a deterministic order. This order influences the
1482 * order of the output ports. It also influences the order of
1483 * the automatic stream IDs if the trace's packet headers do not
1484 * contain a `stream_instance_id` field, in which case the data
1485 * stream file to stream ID association is always the same,
1486 * whatever the build and the system.
1488 * Having a deterministic order here can help debugging and
1491 std::sort(ctf_fs
->trace
->ds_file_groups
.begin(), ctf_fs
->trace
->ds_file_groups
.end(),
1492 compare_ds_file_groups_by_first_path
);
1497 static const std::string
&
1498 get_stream_instance_unique_name(struct ctf_fs_ds_file_group
*ds_file_group
)
1501 * The first (earliest) stream file's path is used as the stream's unique
1504 BT_ASSERT(!ds_file_group
->ds_file_infos
.empty());
1505 return ds_file_group
->ds_file_infos
[0]->path
;
1508 /* Create the IR stream objects for ctf_fs_trace. */
1510 static int create_streams_for_trace(struct ctf_fs_trace
*ctf_fs_trace
)
1512 for (const auto& ds_file_group
: ctf_fs_trace
->ds_file_groups
) {
1513 const std::string
& name
= get_stream_instance_unique_name(ds_file_group
.get());
1515 BT_ASSERT(ds_file_group
->sc
->ir_sc
);
1516 BT_ASSERT(ctf_fs_trace
->trace
);
1520 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
1521 /* No stream ID: use 0 */
1523 bt_stream_create_with_id(ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
->libObjPtr(),
1524 ctf_fs_trace
->next_stream_id
);
1525 ctf_fs_trace
->next_stream_id
++;
1527 /* Specific stream ID */
1529 bt_stream_create_with_id(ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
->libObjPtr(),
1530 (uint64_t) ds_file_group
->stream_id
);
1534 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1535 "Cannot create stream for DS file group: "
1536 "addr={}, stream-name=\"{}\"",
1537 fmt::ptr(ds_file_group
), name
);
1541 ds_file_group
->stream
= bt2::Stream::Shared::createWithoutRef(stream
);
1543 int ret
= bt_stream_set_name(ds_file_group
->stream
->libObjPtr(), name
.c_str());
1545 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1546 "Cannot set stream's name: "
1547 "addr={}, stream-name=\"{}\"",
1548 fmt::ptr(ds_file_group
->stream
->libObjPtr()), name
);
1556 static const bt_param_validation_value_descr inputs_elem_descr
=
1557 bt_param_validation_value_descr::makeString();
1559 static bt_param_validation_map_value_entry_descr fs_params_entries_descr
[] = {
1560 {"inputs", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
1561 bt_param_validation_value_descr::makeArray(1, BT_PARAM_VALIDATION_INFINITE
,
1562 inputs_elem_descr
)},
1563 {"trace-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1564 bt_param_validation_value_descr::makeString()},
1565 {"clock-class-offset-s", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1566 bt_param_validation_value_descr::makeSignedInteger()},
1567 {"clock-class-offset-ns", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1568 bt_param_validation_value_descr::makeSignedInteger()},
1569 {"force-clock-class-origin-unix-epoch", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1570 bt_param_validation_value_descr::makeBool()},
1571 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
1573 bool read_src_fs_parameters(const bt_value
*params
, const bt_value
**inputs
,
1574 const bt_value
**trace_name
, struct ctf_fs_component
*ctf_fs
)
1576 gchar
*error
= NULL
;
1577 bt_param_validation_status validate_value_status
=
1578 bt_param_validation_validate(params
, fs_params_entries_descr
, &error
);
1579 if (validate_value_status
!= BT_PARAM_VALIDATION_STATUS_OK
) {
1580 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "{}", error
);
1585 /* inputs parameter */
1586 *inputs
= bt_value_map_borrow_entry_value_const(params
, "inputs");
1588 /* clock-class-offset-s parameter */
1589 const bt_value
*value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-s");
1591 ctf_fs
->clkClsCfg
.offsetSec
= bt_value_integer_signed_get(value
);
1594 /* clock-class-offset-ns parameter */
1595 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-ns");
1597 ctf_fs
->clkClsCfg
.offsetNanoSec
= bt_value_integer_signed_get(value
);
1600 /* force-clock-class-origin-unix-epoch parameter */
1601 value
= bt_value_map_borrow_entry_value_const(params
, "force-clock-class-origin-unix-epoch");
1603 ctf_fs
->clkClsCfg
.forceOriginIsUnixEpoch
= bt_value_bool_get(value
);
1606 /* trace-name parameter */
1607 *trace_name
= bt_value_map_borrow_entry_value_const(params
, "trace-name");
1612 static ctf_fs_component::UP
ctf_fs_create(const bt_value
*params
,
1613 bt_self_component_source
*self_comp_src
)
1615 const bt_value
*inputs_value
;
1616 const bt_value
*trace_name_value
;
1617 bt_self_component
*self_comp
= bt_self_component_source_as_self_component(self_comp_src
);
1619 ctf_fs_component::UP ctf_fs
= bt2s::make_unique
<ctf_fs_component
>(
1620 bt2c::Logger
{bt2::SelfSourceComponent
{self_comp_src
}, "PLUGIN/SRC.CTF.FS/COMP"});
1622 if (!read_src_fs_parameters(params
, &inputs_value
, &trace_name_value
, ctf_fs
.get())) {
1626 if (ctf_fs_component_create_ctf_fs_trace(ctf_fs
.get(), inputs_value
, trace_name_value
,
1631 if (create_streams_for_trace(ctf_fs
->trace
.get())) {
1635 if (create_ports_for_trace(ctf_fs
.get(), ctf_fs
->trace
.get(), self_comp_src
)) {
1642 bt_component_class_initialize_method_status
ctf_fs_init(bt_self_component_source
*self_comp_src
,
1643 bt_self_component_source_configuration
*,
1644 const bt_value
*params
, void *)
1647 bt_component_class_initialize_method_status ret
=
1648 BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
1650 ctf_fs_component::UP ctf_fs
= ctf_fs_create(params
, self_comp_src
);
1652 ret
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1655 bt_self_component_set_data(bt_self_component_source_as_self_component(self_comp_src
),
1658 } catch (const std::bad_alloc
&) {
1659 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
1660 } catch (const bt2::Error
&) {
1661 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1665 bt_component_class_query_method_status
ctf_fs_query(bt_self_component_class_source
*comp_class_src
,
1666 bt_private_query_executor
*priv_query_exec
,
1667 const char *object
, const bt_value
*params
,
1668 __attribute__((unused
)) void *method_data
,
1669 const bt_value
**result
)
1672 bt2c::Logger logger
{bt2::SelfComponentClass
{comp_class_src
},
1673 bt2::PrivateQueryExecutor
{priv_query_exec
},
1674 "PLUGIN/SRC.CTF.FS/QUERY"};
1675 bt2::ConstMapValue
paramsObj(params
);
1676 bt2::Value::Shared resultObj
;
1678 if (strcmp(object
, "metadata-info") == 0) {
1679 resultObj
= metadata_info_query(paramsObj
, logger
);
1680 } else if (strcmp(object
, "babeltrace.trace-infos") == 0) {
1681 resultObj
= trace_infos_query(paramsObj
, logger
);
1682 } else if (!strcmp(object
, "babeltrace.support-info")) {
1683 resultObj
= support_info_query(paramsObj
, logger
);
1685 BT_CPPLOGE_SPEC(logger
, "Unknown query object `{}`", object
);
1686 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;
1689 *result
= resultObj
.release().libObjPtr();
1691 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
1692 } catch (const std::bad_alloc
&) {
1693 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
1694 } catch (const bt2::Error
&) {
1695 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;