2 * SPDX-License-Identifier: MIT
4 * Copyright 2015-2017 Philippe Proulx <pproulx@efficios.com>
5 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 * Babeltrace CTF file system Reader Component
13 #include <babeltrace2/babeltrace.h>
15 #include "common/assert.h"
16 #include "common/common.h"
17 #include "common/uuid.h"
18 #include "cpp-common/bt2s/make-unique.hpp"
20 #include "plugins/common/param-validation/param-validation.h"
22 #include "../common/src/metadata/tsdl/ctf-meta-configure-ir-trace.hpp"
23 #include "../common/src/msg-iter/msg-iter.hpp"
24 #include "data-stream-file.hpp"
27 #include "metadata.hpp"
38 static void ctf_fs_msg_iter_data_destroy(struct ctf_fs_msg_iter_data
*msg_iter_data
)
44 if (msg_iter_data
->msg_iter
) {
45 ctf_msg_iter_destroy(msg_iter_data
->msg_iter
);
48 if (msg_iter_data
->msg_iter_medops_data
) {
49 ctf_fs_ds_group_medops_data_destroy(msg_iter_data
->msg_iter_medops_data
);
55 static bt_message_iterator_class_next_method_status
56 ctf_fs_iterator_next_one(struct ctf_fs_msg_iter_data
*msg_iter_data
, const bt_message
**out_msg
)
58 bt_message_iterator_class_next_method_status status
;
59 enum ctf_msg_iter_status msg_iter_status
;
61 msg_iter_status
= ctf_msg_iter_get_next_message(msg_iter_data
->msg_iter
, out_msg
);
63 switch (msg_iter_status
) {
64 case CTF_MSG_ITER_STATUS_OK
:
65 /* Cool, message has been written to *out_msg. */
66 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
69 case CTF_MSG_ITER_STATUS_EOF
:
70 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END
;
73 case CTF_MSG_ITER_STATUS_AGAIN
:
75 * Should not make it this far as this is
76 * medium-specific; there is nothing for the user to do
77 * and it should have been handled upstream.
81 case CTF_MSG_ITER_STATUS_ERROR
:
82 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
83 "Failed to get next message from CTF message iterator.");
84 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
87 case CTF_MSG_ITER_STATUS_MEMORY_ERROR
:
88 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
89 "Failed to get next message from CTF message iterator.");
90 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
100 bt_message_iterator_class_next_method_status
101 ctf_fs_iterator_next(bt_self_message_iterator
*iterator
, bt_message_array_const msgs
,
102 uint64_t capacity
, uint64_t *count
)
105 bt_message_iterator_class_next_method_status status
;
106 struct ctf_fs_msg_iter_data
*msg_iter_data
=
107 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(iterator
);
110 if (G_UNLIKELY(msg_iter_data
->next_saved_error
)) {
112 * Last time we were called, we hit an error but had some
113 * messages to deliver, so we stashed the error here. Return
116 BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(msg_iter_data
->next_saved_error
);
117 status
= msg_iter_data
->next_saved_status
;
122 status
= ctf_fs_iterator_next_one(msg_iter_data
, &msgs
[i
]);
123 if (status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
) {
126 } while (i
< capacity
&& status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
);
130 * Even if ctf_fs_iterator_next_one() returned something
131 * else than BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK, we
132 * accumulated message objects in the output
133 * message array, so we need to return
134 * BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK so that they are
135 * transferred to downstream. This other status occurs
136 * again the next time muxer_msg_iter_do_next() is
137 * called, possibly without any accumulated
138 * message, in which case we'll return it.
142 * Save this error for the next _next call. Assume that
143 * this component always appends error causes when
144 * returning an error status code, which will cause the
145 * current thread error to be non-NULL.
147 msg_iter_data
->next_saved_error
= bt_current_thread_take_error();
148 BT_ASSERT(msg_iter_data
->next_saved_error
);
149 msg_iter_data
->next_saved_status
= status
;
153 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
159 } catch (const std::bad_alloc
&) {
160 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
161 } catch (const bt2::Error
&) {
162 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
166 bt_message_iterator_class_seek_beginning_method_status
167 ctf_fs_iterator_seek_beginning(bt_self_message_iterator
*it
)
170 struct ctf_fs_msg_iter_data
*msg_iter_data
=
171 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(it
);
173 BT_ASSERT(msg_iter_data
);
175 ctf_msg_iter_reset(msg_iter_data
->msg_iter
);
176 ctf_fs_ds_group_medops_data_reset(msg_iter_data
->msg_iter_medops_data
);
178 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_OK
;
179 } catch (const std::bad_alloc
&) {
180 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_MEMORY_ERROR
;
181 } catch (const bt2::Error
&) {
182 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_ERROR
;
186 void ctf_fs_iterator_finalize(bt_self_message_iterator
*it
)
188 ctf_fs_msg_iter_data_destroy(
189 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(it
));
192 static bt_message_iterator_class_initialize_method_status
193 ctf_msg_iter_medium_status_to_msg_iter_initialize_status(enum ctf_msg_iter_medium_status status
)
196 case CTF_MSG_ITER_MEDIUM_STATUS_EOF
:
197 case CTF_MSG_ITER_MEDIUM_STATUS_AGAIN
:
198 case CTF_MSG_ITER_MEDIUM_STATUS_ERROR
:
199 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
200 case CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
:
201 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
202 case CTF_MSG_ITER_MEDIUM_STATUS_OK
:
203 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
209 bt_message_iterator_class_initialize_method_status
210 ctf_fs_iterator_init(bt_self_message_iterator
*self_msg_iter
,
211 bt_self_message_iterator_configuration
*config
,
212 bt_self_component_port_output
*self_port
)
215 struct ctf_fs_port_data
*port_data
;
216 bt_message_iterator_class_initialize_method_status status
;
217 enum ctf_msg_iter_medium_status medium_status
;
219 port_data
= (struct ctf_fs_port_data
*) bt_self_component_port_get_data(
220 bt_self_component_port_output_as_self_component_port(self_port
));
221 BT_ASSERT(port_data
);
223 ctf_fs_msg_iter_data
*msg_iter_data
= new ctf_fs_msg_iter_data
{self_msg_iter
};
224 msg_iter_data
->ds_file_group
= port_data
->ds_file_group
;
226 medium_status
= ctf_fs_ds_group_medops_data_create(msg_iter_data
->ds_file_group
,
227 self_msg_iter
, msg_iter_data
->logger
,
228 &msg_iter_data
->msg_iter_medops_data
);
229 BT_ASSERT(medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_OK
||
230 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_ERROR
||
231 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
);
232 if (medium_status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
233 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
234 "Failed to create ctf_fs_ds_group_medops");
235 status
= ctf_msg_iter_medium_status_to_msg_iter_initialize_status(medium_status
);
239 msg_iter_data
->msg_iter
= ctf_msg_iter_create(
240 msg_iter_data
->ds_file_group
->ctf_fs_trace
->metadata
->tc
,
241 bt_common_get_page_size(static_cast<int>(msg_iter_data
->logger
.level())) * 8,
242 ctf_fs_ds_group_medops
, msg_iter_data
->msg_iter_medops_data
, self_msg_iter
,
243 msg_iter_data
->logger
);
244 if (!msg_iter_data
->msg_iter
) {
245 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
246 "Cannot create a CTF message iterator.");
247 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
252 * This iterator can seek forward if its stream class has a default
255 if (msg_iter_data
->ds_file_group
->sc
->default_clock_class
) {
256 bt_self_message_iterator_configuration_set_can_seek_forward(config
, true);
259 bt_self_message_iterator_set_data(self_msg_iter
, msg_iter_data
);
260 msg_iter_data
= NULL
;
262 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
266 bt_self_message_iterator_set_data(self_msg_iter
, NULL
);
269 ctf_fs_msg_iter_data_destroy(msg_iter_data
);
271 } catch (const std::bad_alloc
&) {
272 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
273 } catch (const bt2::Error
&) {
274 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
278 static void ctf_fs_trace_destroy(struct ctf_fs_trace
*ctf_fs_trace
)
284 BT_TRACE_PUT_REF_AND_RESET(ctf_fs_trace
->trace
);
286 if (ctf_fs_trace
->path
) {
287 g_string_free(ctf_fs_trace
->path
, TRUE
);
290 if (ctf_fs_trace
->metadata
) {
291 ctf_fs_metadata_fini(ctf_fs_trace
->metadata
);
292 delete ctf_fs_trace
->metadata
;
298 void ctf_fs_trace_deleter::operator()(ctf_fs_trace
* const trace
) noexcept
300 ctf_fs_trace_destroy(trace
);
303 void ctf_fs_destroy(struct ctf_fs_component
*ctf_fs
)
312 void ctf_fs_component_deleter::operator()(ctf_fs_component
*comp
)
314 ctf_fs_destroy(comp
);
317 ctf_fs_component::UP
ctf_fs_component_create(const bt2c::Logger
& parentLogger
)
319 return ctf_fs_component::UP
{new ctf_fs_component
{parentLogger
}};
322 void ctf_fs_finalize(bt_self_component_source
*component
)
324 ctf_fs_destroy((struct ctf_fs_component
*) bt_self_component_get_data(
325 bt_self_component_source_as_self_component(component
)));
328 bt2c::GCharUP
ctf_fs_make_port_name(struct ctf_fs_ds_file_group
*ds_file_group
)
330 GString
*name
= g_string_new(NULL
);
333 * The unique port name is generated by concatenating unique identifiers
341 /* For the trace, use the uuid if present, else the path. */
342 if (ds_file_group
->ctf_fs_trace
->metadata
->tc
->is_uuid_set
) {
343 char uuid_str
[BT_UUID_STR_LEN
+ 1];
345 bt_uuid_to_str(ds_file_group
->ctf_fs_trace
->metadata
->tc
->uuid
, uuid_str
);
346 g_string_assign(name
, uuid_str
);
348 g_string_assign(name
, ds_file_group
->ctf_fs_trace
->path
->str
);
352 * For the stream class, use the id if present. We can omit this field
353 * otherwise, as there will only be a single stream class.
355 if (ds_file_group
->sc
->id
!= UINT64_C(-1)) {
356 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->sc
->id
);
359 /* For the stream, use the id if present, else, use the path. */
360 if (ds_file_group
->stream_id
!= UINT64_C(-1)) {
361 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->stream_id
);
363 BT_ASSERT(ds_file_group
->ds_file_infos
.size() == 1);
364 const auto& ds_file_info
= *ds_file_group
->ds_file_infos
[0];
365 g_string_append_printf(name
, " | %s", ds_file_info
.path
.c_str());
368 return bt2c::GCharUP
{g_string_free(name
, FALSE
)};
371 static int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
372 struct ctf_fs_ds_file_group
*ds_file_group
,
373 bt_self_component_source
*self_comp_src
)
376 ctf_fs_port_data::UP port_data
;
378 bt2c::GCharUP port_name
= ctf_fs_make_port_name(ds_file_group
);
383 BT_CPPLOGI_SPEC(ctf_fs
->logger
, "Creating one port named `{}`", port_name
.get());
385 /* Create output port for this file */
386 port_data
= bt2s::make_unique
<ctf_fs_port_data
>();
387 port_data
->ctf_fs
= ctf_fs
;
388 port_data
->ds_file_group
= ds_file_group
;
389 ret
= bt_self_component_source_add_output_port(self_comp_src
, port_name
.get(), port_data
.get(),
395 ctf_fs
->port_data
.emplace_back(std::move(port_data
));
405 static int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
406 struct ctf_fs_trace
*ctf_fs_trace
,
407 bt_self_component_source
*self_comp_src
)
411 /* Create one output port for each stream file group */
412 for (const auto& ds_file_group
: ctf_fs_trace
->ds_file_groups
) {
413 ret
= create_one_port_for_trace(ctf_fs
, ds_file_group
.get(), self_comp_src
);
415 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create output port.");
424 /* Replace by g_ptr_array_insert when we depend on glib >= 2.40. */
425 static void array_insert(GPtrArray
*array
, gpointer element
, size_t pos
)
427 size_t original_array_len
= array
->len
;
429 /* Allocate an unused element at the end of the array. */
430 g_ptr_array_add(array
, NULL
);
432 /* If we are not inserting at the end, move the elements by one. */
433 if (pos
< original_array_len
) {
434 memmove(&(array
->pdata
[pos
+ 1]), &(array
->pdata
[pos
]),
435 (original_array_len
- pos
) * sizeof(gpointer
));
438 /* Insert the value. */
439 array
->pdata
[pos
] = element
;
443 * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right
444 * place to keep it sorted.
447 static void ds_file_group_insert_ds_file_info_sorted(struct ctf_fs_ds_file_group
*ds_file_group
,
448 ctf_fs_ds_file_info::UP ds_file_info
)
450 /* Find the spot where to insert this ds_file_info. */
451 auto it
= ds_file_group
->ds_file_infos
.begin();
453 for (; it
!= ds_file_group
->ds_file_infos
.end(); ++it
) {
454 const ctf_fs_ds_file_info
& other_ds_file_info
= **it
;
456 if (ds_file_info
->begin_ns
< other_ds_file_info
.begin_ns
) {
461 ds_file_group
->ds_file_infos
.insert(it
, std::move(ds_file_info
));
464 static bool ds_index_entries_equal(const struct ctf_fs_ds_index_entry
*left
,
465 const struct ctf_fs_ds_index_entry
*right
)
467 if (left
->packetSize
!= right
->packetSize
) {
471 if (left
->timestamp_begin
!= right
->timestamp_begin
) {
475 if (left
->timestamp_end
!= right
->timestamp_end
) {
479 if (left
->packet_seq_num
!= right
->packet_seq_num
) {
487 * Insert `entry` into `index`, without duplication.
489 * The entry is inserted only if there isn't an identical entry already.
491 * In any case, the ownership of `entry` is transferred to this function. So if
492 * the entry is not inserted, it is freed.
495 static void ds_index_insert_ds_index_entry_sorted(struct ctf_fs_ds_index
*index
,
496 struct ctf_fs_ds_index_entry
*entry
)
499 struct ctf_fs_ds_index_entry
*other_entry
= NULL
;
501 /* Find the spot where to insert this index entry. */
502 for (i
= 0; i
< index
->entries
->len
; i
++) {
503 other_entry
= (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, i
);
505 if (entry
->timestamp_begin_ns
<= other_entry
->timestamp_begin_ns
) {
511 * Insert the entry only if a duplicate doesn't already exist.
513 * There can be duplicate packets if reading multiple overlapping
514 * snapshots of the same trace. We then want the index to contain
515 * a reference to only one copy of that packet.
517 if (i
== index
->entries
->len
|| !ds_index_entries_equal(entry
, other_entry
)) {
518 array_insert(index
->entries
, entry
, i
);
524 static void merge_ctf_fs_ds_indexes(struct ctf_fs_ds_index
*dest
, ctf_fs_ds_index::UP src
)
528 for (i
= 0; i
< src
->entries
->len
; i
++) {
529 struct ctf_fs_ds_index_entry
*entry
=
530 (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(src
->entries
, i
);
533 * Ownership of the ctf_fs_ds_index_entry is transferred to
534 * ds_index_insert_ds_index_entry_sorted.
536 g_ptr_array_index(src
->entries
, i
) = NULL
;
537 ds_index_insert_ds_index_entry_sorted(dest
, entry
);
541 static int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
, const char *path
)
543 int64_t stream_instance_id
= -1;
544 int64_t begin_ns
= -1;
545 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
546 ctf_fs_ds_file_group::UP new_ds_file_group
;
548 struct ctf_fs_ds_file
*ds_file
= NULL
;
549 ctf_fs_ds_file_info::UP ds_file_info
;
550 ctf_fs_ds_index::UP index
;
551 struct ctf_msg_iter
*msg_iter
= NULL
;
552 struct ctf_stream_class
*sc
= NULL
;
553 struct ctf_msg_iter_packet_properties props
;
556 * Create a temporary ds_file to read some properties about the data
559 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, path
, ctf_fs_trace
->logger
);
564 /* Create a temporary iterator to read the ds_file. */
565 msg_iter
= ctf_msg_iter_create(
566 ctf_fs_trace
->metadata
->tc
,
567 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
568 ctf_fs_ds_file_medops
, ds_file
, nullptr, ctf_fs_trace
->logger
);
570 BT_CPPLOGE_STR_SPEC(ctf_fs_trace
->logger
, "Cannot create a CTF message iterator.");
574 ctf_msg_iter_set_dry_run(msg_iter
, true);
576 ret
= ctf_msg_iter_get_packet_properties(msg_iter
, &props
);
578 BT_CPPLOGE_APPEND_CAUSE_SPEC(
579 ctf_fs_trace
->logger
,
580 "Cannot get stream file's first packet's header and context fields (`{}`).", path
);
584 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
, props
.stream_class_id
);
586 stream_instance_id
= props
.data_stream_id
;
588 if (props
.snapshots
.beginning_clock
!= UINT64_C(-1)) {
589 BT_ASSERT(sc
->default_clock_class
);
590 ret
= bt_util_clock_cycles_to_ns_from_origin(
591 props
.snapshots
.beginning_clock
, sc
->default_clock_class
->frequency
,
592 sc
->default_clock_class
->offset_seconds
, sc
->default_clock_class
->offset_cycles
,
595 BT_CPPLOGE_APPEND_CAUSE_SPEC(
596 ctf_fs_trace
->logger
,
597 "Cannot convert clock cycles to nanoseconds from origin (`{}`).", path
);
602 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
);
607 index
= ctf_fs_ds_file_build_index(ds_file
, ds_file_info
.get(), msg_iter
);
609 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to index CTF stream file \'{}\'",
610 ds_file
->file
->path
->str
);
614 if (begin_ns
== -1) {
616 * No beginning timestamp to sort the stream files
617 * within a stream file group, so consider that this
618 * file must be the only one within its group.
620 stream_instance_id
= -1;
623 if (stream_instance_id
== -1) {
625 * No stream instance ID or no beginning timestamp:
626 * create a unique stream file group for this stream
627 * file because, even if there's a stream instance ID,
628 * there's no timestamp to order the file within its
632 ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, UINT64_C(-1), std::move(index
));
634 if (!new_ds_file_group
) {
638 ds_file_group_insert_ds_file_info_sorted(new_ds_file_group
.get(), std::move(ds_file_info
));
639 ctf_fs_trace
->ds_file_groups
.emplace_back(std::move(new_ds_file_group
));
643 BT_ASSERT(stream_instance_id
!= -1);
644 BT_ASSERT(begin_ns
!= -1);
646 /* Find an existing stream file group with this ID */
647 for (const auto& candidate
: ctf_fs_trace
->ds_file_groups
) {
648 if (candidate
->sc
== sc
&& candidate
->stream_id
== stream_instance_id
) {
649 ds_file_group
= candidate
.get();
654 if (!ds_file_group
) {
656 ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, stream_instance_id
, std::move(index
));
657 if (!new_ds_file_group
) {
661 ds_file_group
= new_ds_file_group
.get();
662 ctf_fs_trace
->ds_file_groups
.emplace_back(std::move(new_ds_file_group
));
664 merge_ctf_fs_ds_indexes(ds_file_group
->index
.get(), std::move(index
));
667 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, std::move(ds_file_info
));
675 ctf_fs_ds_file_destroy(ds_file
);
678 ctf_msg_iter_destroy(msg_iter
);
684 static int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
687 const char *basename
;
688 GError
*error
= NULL
;
691 /* Check each file in the path directory, except specific ones */
692 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
694 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
695 "Cannot open directory `{}`: {} (code {})",
696 ctf_fs_trace
->path
->str
, error
->message
, error
->code
);
700 while ((basename
= g_dir_read_name(dir
))) {
701 struct ctf_fs_file
*file
;
703 if (strcmp(basename
, CTF_FS_METADATA_FILENAME
) == 0) {
704 /* Ignore the metadata stream. */
705 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
706 "Ignoring metadata file `{}" G_DIR_SEPARATOR_S
"{}`",
707 ctf_fs_trace
->path
->str
, basename
);
711 if (basename
[0] == '.') {
712 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
713 "Ignoring hidden file `{}" G_DIR_SEPARATOR_S
"{}`",
714 ctf_fs_trace
->path
->str
, basename
);
718 /* Create the file. */
719 file
= ctf_fs_file_create(ctf_fs_trace
->logger
);
721 BT_CPPLOGE_APPEND_CAUSE_SPEC(
722 ctf_fs_trace
->logger
,
723 "Cannot create stream file object for file `{}" G_DIR_SEPARATOR_S
"{}`",
724 ctf_fs_trace
->path
->str
, basename
);
728 /* Create full path string. */
729 g_string_append_printf(file
->path
, "%s" G_DIR_SEPARATOR_S
"%s", ctf_fs_trace
->path
->str
,
731 if (!g_file_test(file
->path
->str
, G_FILE_TEST_IS_REGULAR
)) {
732 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring non-regular file `{}`",
734 ctf_fs_file_destroy(file
);
739 ret
= ctf_fs_file_open(file
, "rb");
741 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Cannot open stream file `{}`",
746 if (file
->size
== 0) {
747 /* Skip empty stream. */
748 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring empty file `{}`", file
->path
->str
);
749 ctf_fs_file_destroy(file
);
753 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
, file
->path
->str
);
755 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
756 "Cannot add stream file `{}` to stream file group",
758 ctf_fs_file_destroy(file
);
762 ctf_fs_file_destroy(file
);
783 static int set_trace_name(bt_trace
*trace
, const char *name_suffix
, const bt2c::Logger
& logger
)
789 name
= g_string_new(NULL
);
791 BT_CPPLOGE_STR_SPEC(logger
, "Failed to allocate a GString.");
797 * Check if we have a trace environment string value named `hostname`.
798 * If so, use it as the trace name's prefix.
800 val
= bt_trace_borrow_environment_entry_value_by_name_const(trace
, "hostname");
801 if (val
&& bt_value_is_string(val
)) {
802 g_string_append(name
, bt_value_string_get(val
));
805 g_string_append_c(name
, G_DIR_SEPARATOR
);
810 g_string_append(name
, name_suffix
);
813 ret
= bt_trace_set_name(trace
, name
->str
);
822 g_string_free(name
, TRUE
);
828 static ctf_fs_trace::UP
ctf_fs_trace_create(const char *path
, const char *name
,
829 const ctf::src::ClkClsCfg
& clkClsCfg
,
830 bt_self_component
*selfComp
,
831 const bt2c::Logger
& parentLogger
)
835 ctf_fs_trace::UP ctf_fs_trace
{new struct ctf_fs_trace(parentLogger
)};
836 ctf_fs_trace
->path
= g_string_new(path
);
837 if (!ctf_fs_trace
->path
) {
841 ctf_fs_trace
->metadata
= new ctf_fs_metadata
;
842 ctf_fs_metadata_init(ctf_fs_trace
->metadata
);
844 ret
= ctf_fs_metadata_set_trace_class(selfComp
, ctf_fs_trace
.get(), clkClsCfg
);
849 if (ctf_fs_trace
->metadata
->trace_class
) {
850 ctf_fs_trace
->trace
= bt_trace_create(ctf_fs_trace
->metadata
->trace_class
);
851 if (!ctf_fs_trace
->trace
) {
856 if (ctf_fs_trace
->trace
) {
857 ret
= ctf_trace_class_configure_ir_trace(ctf_fs_trace
->metadata
->tc
, ctf_fs_trace
->trace
);
862 ret
= set_trace_name(ctf_fs_trace
->trace
, name
, ctf_fs_trace
->logger
);
868 ret
= create_ds_file_groups(ctf_fs_trace
.get());
876 ctf_fs_trace
.reset();
882 static int path_is_ctf_trace(const char *path
)
884 GString
*metadata_path
= g_string_new(NULL
);
887 if (!metadata_path
) {
892 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
894 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
900 g_string_free(metadata_path
, TRUE
);
904 /* Helper for ctf_fs_component_create_ctf_fs_trace, to handle a single path. */
906 static int ctf_fs_component_create_ctf_fs_trace_one_path(struct ctf_fs_component
*ctf_fs
,
907 const char *path_param
,
908 const char *trace_name
,
909 std::vector
<ctf_fs_trace::UP
>& traces
,
910 bt_self_component
*selfComp
)
912 ctf_fs_trace::UP ctf_fs_trace
;
916 norm_path
= bt_common_normalize_path(path_param
, NULL
);
918 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to normalize path: `{}`.", path_param
);
922 ret
= path_is_ctf_trace(norm_path
->str
);
924 BT_CPPLOGE_APPEND_CAUSE_SPEC(
925 ctf_fs
->logger
, "Failed to check if path is a CTF trace: path={}", norm_path
->str
);
927 } else if (ret
== 0) {
928 BT_CPPLOGE_APPEND_CAUSE_SPEC(
929 ctf_fs
->logger
, "Path is not a CTF trace (does not contain a metadata file): `{}`.",
934 // FIXME: Remove or ifdef for __MINGW32__
935 if (strcmp(norm_path
->str
, "/") == 0) {
936 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Opening a trace in `/` is not supported.");
941 ctf_fs_trace
= ctf_fs_trace_create(norm_path
->str
, trace_name
, ctf_fs
->clkClsCfg
, selfComp
,
944 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create trace for `{}`.",
949 traces
.emplace_back(std::move(ctf_fs_trace
));
959 g_string_free(norm_path
, TRUE
);
966 * Count the number of stream and event classes defined by this trace's metadata.
968 * This is used to determine which metadata is the "latest", out of multiple
969 * traces sharing the same UUID. It is assumed that amongst all these metadatas,
970 * a bigger metadata is a superset of a smaller metadata. Therefore, it is
971 * enough to just count the classes.
974 static unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace
*trace
)
976 unsigned int num
= trace
->metadata
->tc
->stream_classes
->len
;
979 for (i
= 0; i
< trace
->metadata
->tc
->stream_classes
->len
; i
++) {
980 struct ctf_stream_class
*sc
=
981 (struct ctf_stream_class
*) trace
->metadata
->tc
->stream_classes
->pdata
[i
];
982 num
+= sc
->event_classes
->len
;
989 * Merge the src ds_file_group into dest. This consists of merging their
990 * ds_file_infos, making sure to keep the result sorted.
993 static void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group
*dest
,
994 ctf_fs_ds_file_group::UP src
)
996 for (auto& ds_file_info
: src
->ds_file_infos
) {
997 ds_file_group_insert_ds_file_info_sorted(dest
, std::move(ds_file_info
));
1000 /* Merge both indexes. */
1001 merge_ctf_fs_ds_indexes(dest
->index
.get(), std::move(src
->index
));
1004 /* Merge src_trace's data stream file groups into dest_trace's. */
1006 static int merge_matching_ctf_fs_ds_file_groups(struct ctf_fs_trace
*dest_trace
,
1007 ctf_fs_trace::UP src_trace
)
1009 std::vector
<ctf_fs_ds_file_group::UP
>& dest
= dest_trace
->ds_file_groups
;
1010 std::vector
<ctf_fs_ds_file_group::UP
>& src
= src_trace
->ds_file_groups
;
1014 * Save the initial length of dest: we only want to check against the
1015 * original elements in the inner loop.
1017 size_t dest_len
= dest
.size();
1019 for (auto& src_group
: src
) {
1020 struct ctf_fs_ds_file_group
*dest_group
= NULL
;
1022 /* A stream instance without ID can't match a stream in the other trace. */
1023 if (src_group
->stream_id
!= -1) {
1024 /* Let's search for a matching ds_file_group in the destination. */
1025 for (size_t d_i
= 0; d_i
< dest_len
; ++d_i
) {
1026 ctf_fs_ds_file_group
*candidate_dest
= dest
[d_i
].get();
1028 /* Can't match a stream instance without ID. */
1029 if (candidate_dest
->stream_id
== -1) {
1034 * If the two groups have the same stream instance id
1035 * and belong to the same stream class (stream instance
1036 * ids are per-stream class), they represent the same
1039 if (candidate_dest
->stream_id
!= src_group
->stream_id
||
1040 candidate_dest
->sc
->id
!= src_group
->sc
->id
) {
1044 dest_group
= candidate_dest
;
1050 * Didn't find a friend in dest to merge our src_group into?
1051 * Create a new empty one. This can happen if a stream was
1052 * active in the source trace chunk but not in the destination
1056 struct ctf_stream_class
*sc
;
1058 sc
= ctf_trace_class_borrow_stream_class_by_id(dest_trace
->metadata
->tc
,
1062 auto index
= ctf_fs_ds_index_create(dest_trace
->logger
);
1068 auto new_dest_group
=
1069 ctf_fs_ds_file_group_create(dest_trace
, sc
, src_group
->stream_id
, std::move(index
));
1071 if (!new_dest_group
) {
1076 dest_group
= new_dest_group
.get();
1077 dest_trace
->ds_file_groups
.emplace_back(std::move(new_dest_group
));
1080 BT_ASSERT(dest_group
);
1081 merge_ctf_fs_ds_file_groups(dest_group
, std::move(src_group
));
1089 * Collapse the given traces, which must all share the same UUID, in a single
1092 * The trace with the most expansive metadata is chosen and all other traces
1093 * are merged into that one. On return, the elements of `traces` are nullptr
1094 * and the merged trace is placed in `out_trace`.
1097 static int merge_ctf_fs_traces(std::vector
<ctf_fs_trace::UP
> traces
, ctf_fs_trace::UP
& out_trace
)
1099 unsigned int winner_count
;
1100 struct ctf_fs_trace
*winner
;
1104 BT_ASSERT(traces
.size() >= 2);
1106 winner_count
= metadata_count_stream_and_event_classes(traces
[0].get());
1107 winner
= traces
[0].get();
1110 /* Find the trace with the largest metadata. */
1111 for (i
= 1; i
< traces
.size(); i
++) {
1112 ctf_fs_trace
*candidate
= traces
[i
].get();
1113 unsigned int candidate_count
;
1115 /* A bit of sanity check. */
1116 BT_ASSERT(bt_uuid_compare(winner
->metadata
->tc
->uuid
, candidate
->metadata
->tc
->uuid
) == 0);
1118 candidate_count
= metadata_count_stream_and_event_classes(candidate
);
1120 if (candidate_count
> winner_count
) {
1121 winner_count
= candidate_count
;
1127 /* Merge all the other traces in the winning trace. */
1128 for (ctf_fs_trace::UP
& trace
: traces
) {
1129 /* Don't merge the winner into itself. */
1130 if (trace
.get() == winner
) {
1134 /* Merge trace's data stream file groups into winner's. */
1135 ret
= merge_matching_ctf_fs_ds_file_groups(winner
, std::move(trace
));
1142 * Move the winner out of the array, into `*out_trace`.
1144 out_trace
= std::move(traces
[winner_i
]);
1156 static int decode_clock_snapshot_after_event(struct ctf_fs_trace
*ctf_fs_trace
,
1157 struct ctf_clock_class
*default_cc
,
1158 struct ctf_fs_ds_index_entry
*index_entry
,
1159 enum target_event target_event
, uint64_t *cs
,
1162 enum ctf_msg_iter_status iter_status
= CTF_MSG_ITER_STATUS_OK
;
1163 struct ctf_fs_ds_file
*ds_file
= NULL
;
1164 struct ctf_msg_iter
*msg_iter
= NULL
;
1167 BT_ASSERT(ctf_fs_trace
);
1168 BT_ASSERT(index_entry
);
1169 BT_ASSERT(index_entry
->path
);
1171 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, index_entry
->path
, ctf_fs_trace
->logger
);
1173 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to create a ctf_fs_ds_file");
1178 BT_ASSERT(ctf_fs_trace
->metadata
);
1179 BT_ASSERT(ctf_fs_trace
->metadata
->tc
);
1181 msg_iter
= ctf_msg_iter_create(
1182 ctf_fs_trace
->metadata
->tc
,
1183 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
1184 ctf_fs_ds_file_medops
, ds_file
, NULL
, ctf_fs_trace
->logger
);
1186 /* ctf_msg_iter_create() logs errors. */
1192 * Turn on dry run mode to prevent the creation and usage of Babeltrace
1193 * library objects (bt_field, bt_message_*, etc.).
1195 ctf_msg_iter_set_dry_run(msg_iter
, true);
1197 /* Seek to the beginning of the target packet. */
1198 iter_status
= ctf_msg_iter_seek(msg_iter
, index_entry
->offset
.bytes());
1200 /* ctf_msg_iter_seek() logs errors. */
1205 switch (target_event
) {
1208 * Start to decode the packet until we reach the end of
1209 * the first event. To extract the first event's clock
1212 iter_status
= ctf_msg_iter_curr_packet_first_event_clock_snapshot(msg_iter
, cs
);
1215 /* Decode the packet to extract the last event's clock snapshot. */
1216 iter_status
= ctf_msg_iter_curr_packet_last_event_clock_snapshot(msg_iter
, cs
);
1226 /* Convert clock snapshot to timestamp. */
1227 ret
= bt_util_clock_cycles_to_ns_from_origin(
1228 *cs
, default_cc
->frequency
, default_cc
->offset_seconds
, default_cc
->offset_cycles
, ts_ns
);
1230 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1231 "Failed to convert clock snapshot to timestamp");
1237 ctf_fs_ds_file_destroy(ds_file
);
1240 ctf_msg_iter_destroy(msg_iter
);
1246 static int decode_packet_first_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1247 struct ctf_clock_class
*default_cc
,
1248 struct ctf_fs_ds_index_entry
*index_entry
,
1249 uint64_t *cs
, int64_t *ts_ns
)
1251 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, FIRST_EVENT
, cs
,
1255 static int decode_packet_last_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1256 struct ctf_clock_class
*default_cc
,
1257 struct ctf_fs_ds_index_entry
*index_entry
,
1258 uint64_t *cs
, int64_t *ts_ns
)
1260 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, LAST_EVENT
, cs
,
1265 * Fix up packet index entries for lttng's "event-after-packet" bug.
1266 * Some buggy lttng tracer versions may emit events with a timestamp that is
1267 * larger (after) than the timestamp_end of the their packets.
1269 * To fix up this erroneous data we do the following:
1270 * 1. If it's not the stream file's last packet: set the packet index entry's
1271 * end time to the next packet's beginning time.
1272 * 2. If it's the stream file's last packet, set the packet index entry's end
1273 * time to the packet's last event's time, if any, or to the packet's
1274 * beginning time otherwise.
1276 * Known buggy tracer versions:
1277 * - before lttng-ust 2.11.0
1278 * - before lttng-module 2.11.0
1279 * - before lttng-module 2.10.10
1280 * - before lttng-module 2.9.13
1282 static int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace
*trace
)
1286 for (const auto& ds_file_group
: trace
->ds_file_groups
) {
1288 struct ctf_clock_class
*default_cc
;
1289 struct ctf_fs_ds_index_entry
*last_entry
;
1291 BT_ASSERT(ds_file_group
);
1292 const auto index
= ds_file_group
->index
.get();
1295 BT_ASSERT(index
->entries
);
1296 BT_ASSERT(index
->entries
->len
> 0);
1299 * Iterate over all entries but the last one. The last one is
1300 * fixed differently after.
1302 for (entry_i
= 0; entry_i
< index
->entries
->len
- 1; entry_i
++) {
1303 struct ctf_fs_ds_index_entry
*curr_entry
, *next_entry
;
1305 curr_entry
= (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
);
1306 next_entry
= (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
+ 1);
1309 * 1. Set the current index entry `end` timestamp to
1310 * the next index entry `begin` timestamp.
1312 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1313 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1317 * 2. Fix the last entry by decoding the last event of the last
1321 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, index
->entries
->len
- 1);
1322 BT_ASSERT(last_entry
);
1324 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1325 default_cc
= ds_file_group
->sc
->default_clock_class
;
1328 * Decode packet to read the timestamp of the last event of the
1331 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1332 &last_entry
->timestamp_end
,
1333 &last_entry
->timestamp_end_ns
);
1335 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1337 "Failed to decode stream's last packet to get its last event's clock snapshot.");
1347 * Fix up packet index entries for barectf's "event-before-packet" bug.
1348 * Some buggy barectf tracer versions may emit events with a timestamp that is
1349 * less than the timestamp_begin of the their packets.
1351 * To fix up this erroneous data we do the following:
1352 * 1. Starting at the second index entry, set the timestamp_begin of the
1353 * current entry to the timestamp of the first event of the packet.
1354 * 2. Set the previous entry's timestamp_end to the timestamp_begin of the
1357 * Known buggy tracer versions:
1358 * - before barectf 2.3.1
1360 static int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace
*trace
)
1364 for (const auto& ds_file_group
: trace
->ds_file_groups
) {
1366 struct ctf_clock_class
*default_cc
;
1367 const auto index
= ds_file_group
->index
.get();
1370 BT_ASSERT(index
->entries
);
1371 BT_ASSERT(index
->entries
->len
> 0);
1373 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1374 default_cc
= ds_file_group
->sc
->default_clock_class
;
1377 * 1. Iterate over the index, starting from the second entry
1380 for (entry_i
= 1; entry_i
< index
->entries
->len
; entry_i
++) {
1381 ctf_fs_ds_index_entry
*prev_entry
=
1382 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
- 1);
1383 ctf_fs_ds_index_entry
*curr_entry
=
1384 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
);
1386 * 2. Set the current entry `begin` timestamp to the
1387 * timestamp of the first event of the current packet.
1389 ret
= decode_packet_first_event_timestamp(trace
, default_cc
, curr_entry
,
1390 &curr_entry
->timestamp_begin
,
1391 &curr_entry
->timestamp_begin_ns
);
1393 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1394 "Failed to decode first event's clock snapshot");
1399 * 3. Set the previous entry `end` timestamp to the
1400 * timestamp of the first event of the current packet.
1402 prev_entry
->timestamp_end
= curr_entry
->timestamp_begin
;
1403 prev_entry
->timestamp_end_ns
= curr_entry
->timestamp_begin_ns
;
1411 * When using the lttng-crash feature it's likely that the last packets of each
1412 * stream have their timestamp_end set to zero. This is caused by the fact that
1413 * the tracer crashed and was not able to properly close the packets.
1415 * To fix up this erroneous data we do the following:
1416 * For each index entry, if the entry's timestamp_end is 0 and the
1417 * timestamp_begin is not 0:
1418 * - If it's the stream file's last packet: set the packet index entry's end
1419 * time to the packet's last event's time, if any, or to the packet's
1420 * beginning time otherwise.
1421 * - If it's not the stream file's last packet: set the packet index
1422 * entry's end time to the next packet's beginning time.
1424 * Affected versions:
1425 * - All current and future lttng-ust and lttng-modules versions.
1427 static int fix_index_lttng_crash_quirk(struct ctf_fs_trace
*trace
)
1431 for (const auto& ds_file_group
: trace
->ds_file_groups
) {
1433 struct ctf_clock_class
*default_cc
;
1435 BT_ASSERT(ds_file_group
);
1436 const auto index
= ds_file_group
->index
.get();
1438 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1439 default_cc
= ds_file_group
->sc
->default_clock_class
;
1442 BT_ASSERT(index
->entries
);
1443 BT_ASSERT(index
->entries
->len
> 0);
1445 ctf_fs_ds_index_entry
*last_entry
=
1446 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, index
->entries
->len
- 1);
1447 BT_ASSERT(last_entry
);
1449 /* 1. Fix the last entry first. */
1450 if (last_entry
->timestamp_end
== 0 && last_entry
->timestamp_begin
!= 0) {
1452 * Decode packet to read the timestamp of the
1453 * last event of the stream file.
1455 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1456 &last_entry
->timestamp_end
,
1457 &last_entry
->timestamp_end_ns
);
1459 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1460 "Failed to decode last event's clock snapshot");
1465 /* Iterate over all entries but the last one. */
1466 for (entry_idx
= 0; entry_idx
< index
->entries
->len
- 1; entry_idx
++) {
1467 ctf_fs_ds_index_entry
*curr_entry
=
1468 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_idx
);
1469 ctf_fs_ds_index_entry
*next_entry
=
1470 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_idx
+ 1);
1472 if (curr_entry
->timestamp_end
== 0 && curr_entry
->timestamp_begin
!= 0) {
1474 * 2. Set the current index entry `end` timestamp to
1475 * the next index entry `begin` timestamp.
1477 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1478 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1488 * Extract the tracer information necessary to compare versions.
1489 * Returns 0 on success, and -1 if the extraction is not successful because the
1490 * necessary fields are absents in the trace metadata.
1492 static int extract_tracer_info(struct ctf_fs_trace
*trace
, struct tracer_info
*current_tracer_info
)
1495 struct ctf_trace_class_env_entry
*entry
;
1497 /* Clear the current_tracer_info struct */
1498 memset(current_tracer_info
, 0, sizeof(*current_tracer_info
));
1501 * To compare 2 tracer versions, at least the tracer name and it's
1502 * major version are needed. If one of these is missing, consider it an
1503 * extraction failure.
1505 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_name");
1506 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR
) {
1507 goto missing_bare_minimum
;
1510 /* Set tracer name. */
1511 current_tracer_info
->name
= entry
->value
.str
->str
;
1513 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_major");
1514 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1515 goto missing_bare_minimum
;
1518 /* Set major version number. */
1519 current_tracer_info
->major
= entry
->value
.i
;
1521 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_minor");
1522 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1526 /* Set minor version number. */
1527 current_tracer_info
->minor
= entry
->value
.i
;
1529 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patch");
1532 * If `tracer_patch` doesn't exist `tracer_patchlevel` might.
1533 * For example, `lttng-modules` uses entry name
1534 * `tracer_patchlevel`.
1536 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patchlevel");
1539 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1543 /* Set patch version number. */
1544 current_tracer_info
->patch
= entry
->value
.i
;
1548 missing_bare_minimum
:
1554 static bool is_tracer_affected_by_lttng_event_after_packet_bug(struct tracer_info
*curr_tracer_info
)
1556 bool is_affected
= false;
1558 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1559 if (curr_tracer_info
->major
< 2) {
1561 } else if (curr_tracer_info
->major
== 2) {
1562 /* fixed in lttng-ust 2.11.0 */
1563 if (curr_tracer_info
->minor
< 11) {
1567 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1568 if (curr_tracer_info
->major
< 2) {
1570 } else if (curr_tracer_info
->major
== 2) {
1571 /* fixed in lttng-modules 2.11.0 */
1572 if (curr_tracer_info
->minor
== 10) {
1573 /* fixed in lttng-modules 2.10.10 */
1574 if (curr_tracer_info
->patch
< 10) {
1577 } else if (curr_tracer_info
->minor
== 9) {
1578 /* fixed in lttng-modules 2.9.13 */
1579 if (curr_tracer_info
->patch
< 13) {
1582 } else if (curr_tracer_info
->minor
< 9) {
1592 is_tracer_affected_by_barectf_event_before_packet_bug(struct tracer_info
*curr_tracer_info
)
1594 bool is_affected
= false;
1596 if (strcmp(curr_tracer_info
->name
, "barectf") == 0) {
1597 if (curr_tracer_info
->major
< 2) {
1599 } else if (curr_tracer_info
->major
== 2) {
1600 if (curr_tracer_info
->minor
< 3) {
1602 } else if (curr_tracer_info
->minor
== 3) {
1603 /* fixed in barectf 2.3.1 */
1604 if (curr_tracer_info
->patch
< 1) {
1614 static bool is_tracer_affected_by_lttng_crash_quirk(struct tracer_info
*curr_tracer_info
)
1616 bool is_affected
= false;
1618 /* All LTTng tracer may be affected by this lttng crash quirk. */
1619 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1621 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1629 * Looks for trace produced by known buggy tracers and fix up the index
1632 static int fix_packet_index_tracer_bugs(ctf_fs_trace
*trace
)
1635 struct tracer_info current_tracer_info
;
1637 ret
= extract_tracer_info(trace
, ¤t_tracer_info
);
1640 * A trace may not have all the necessary environment
1641 * entries to do the tracer version comparison.
1642 * At least, the tracer name and major version number
1643 * are needed. Failing to extract these entries is not
1647 BT_CPPLOGI_STR_SPEC(
1649 "Cannot extract tracer information necessary to compare with buggy versions.");
1653 /* Check if the trace may be affected by old tracer bugs. */
1654 if (is_tracer_affected_by_lttng_event_after_packet_bug(¤t_tracer_info
)) {
1655 BT_CPPLOGI_STR_SPEC(
1657 "Trace may be affected by LTTng tracer packet timestamp bug. Fixing up.");
1658 ret
= fix_index_lttng_event_after_packet_bug(trace
);
1660 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1661 "Failed to fix LTTng event-after-packet bug.");
1664 trace
->metadata
->tc
->quirks
.lttng_event_after_packet
= true;
1667 if (is_tracer_affected_by_barectf_event_before_packet_bug(¤t_tracer_info
)) {
1668 BT_CPPLOGI_STR_SPEC(
1670 "Trace may be affected by barectf tracer packet timestamp bug. Fixing up.");
1671 ret
= fix_index_barectf_event_before_packet_bug(trace
);
1673 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1674 "Failed to fix barectf event-before-packet bug.");
1677 trace
->metadata
->tc
->quirks
.barectf_event_before_packet
= true;
1680 if (is_tracer_affected_by_lttng_crash_quirk(¤t_tracer_info
)) {
1681 ret
= fix_index_lttng_crash_quirk(trace
);
1683 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1684 "Failed to fix lttng-crash timestamp quirks.");
1687 trace
->metadata
->tc
->quirks
.lttng_crash
= true;
1694 static bool compare_ds_file_groups_by_first_path(const ctf_fs_ds_file_group::UP
& ds_file_group_a
,
1695 const ctf_fs_ds_file_group::UP
& ds_file_group_b
)
1697 BT_ASSERT(!ds_file_group_a
->ds_file_infos
.empty());
1698 BT_ASSERT(!ds_file_group_b
->ds_file_infos
.empty());
1700 const auto& first_ds_file_info_a
= *ds_file_group_a
->ds_file_infos
[0];
1701 const auto& first_ds_file_info_b
= *ds_file_group_b
->ds_file_infos
[0];
1703 return first_ds_file_info_a
.path
< first_ds_file_info_b
.path
;
1706 static gint
compare_strings(gconstpointer p_a
, gconstpointer p_b
)
1708 const char *a
= *((const char **) p_a
);
1709 const char *b
= *((const char **) p_b
);
1711 return strcmp(a
, b
);
1714 int ctf_fs_component_create_ctf_fs_trace(struct ctf_fs_component
*ctf_fs
,
1715 const bt_value
*paths_value
,
1716 const bt_value
*trace_name_value
,
1717 bt_self_component
*selfComp
)
1721 GPtrArray
*paths
= NULL
;
1722 std::vector
<ctf_fs_trace::UP
> traces
;
1723 const char *trace_name
;
1725 BT_ASSERT(bt_value_get_type(paths_value
) == BT_VALUE_TYPE_ARRAY
);
1726 BT_ASSERT(!bt_value_array_is_empty(paths_value
));
1728 paths
= g_ptr_array_new_with_free_func(g_free
);
1730 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to allocate a GPtrArray.");
1734 trace_name
= trace_name_value
? bt_value_string_get(trace_name_value
) : NULL
;
1737 * Create a sorted array of the paths, to make the execution of this
1738 * component deterministic.
1740 for (i
= 0; i
< bt_value_array_get_length(paths_value
); i
++) {
1741 const bt_value
*path_value
= bt_value_array_borrow_element_by_index_const(paths_value
, i
);
1742 const char *input
= bt_value_string_get(path_value
);
1745 input_copy
= g_strdup(input
);
1747 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to copy a string.");
1751 g_ptr_array_add(paths
, input_copy
);
1754 g_ptr_array_sort(paths
, compare_strings
);
1756 /* Create a separate ctf_fs_trace object for each path. */
1757 for (i
= 0; i
< paths
->len
; i
++) {
1758 const char *path
= (const char *) g_ptr_array_index(paths
, i
);
1760 ret
= ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs
, path
, trace_name
, traces
,
1767 if (traces
.size() > 1) {
1768 ctf_fs_trace
*first_trace
= traces
[0].get();
1769 const uint8_t *first_trace_uuid
= first_trace
->metadata
->tc
->uuid
;
1772 * We have more than one trace, they must all share the same
1773 * UUID, verify that.
1775 for (i
= 0; i
< traces
.size(); i
++) {
1776 ctf_fs_trace
*this_trace
= traces
[i
].get();
1777 const uint8_t *this_trace_uuid
= this_trace
->metadata
->tc
->uuid
;
1779 if (!this_trace
->metadata
->tc
->is_uuid_set
) {
1780 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1782 "Multiple traces given, but a trace does not have a UUID: path={}",
1783 this_trace
->path
->str
);
1787 if (bt_uuid_compare(first_trace_uuid
, this_trace_uuid
) != 0) {
1788 char first_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1789 char this_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1791 bt_uuid_to_str(first_trace_uuid
, first_trace_uuid_str
);
1792 bt_uuid_to_str(this_trace_uuid
, this_trace_uuid_str
);
1794 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1795 "Multiple traces given, but UUIDs don't match: "
1796 "first-trace-uuid={}, first-trace-path={}, "
1797 "trace-uuid={}, trace-path={}",
1798 first_trace_uuid_str
, first_trace
->path
->str
,
1799 this_trace_uuid_str
, this_trace
->path
->str
);
1804 ret
= merge_ctf_fs_traces(std::move(traces
), ctf_fs
->trace
);
1806 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1807 "Failed to merge traces with the same UUID.");
1811 /* Just one trace, it may or may not have a UUID, both are fine. */
1812 ctf_fs
->trace
= std::move(traces
[0]);
1815 ret
= fix_packet_index_tracer_bugs(ctf_fs
->trace
.get());
1817 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to fix packet index tracer bugs.");
1821 * Sort data stream file groups by first data stream file info
1822 * path to get a deterministic order. This order influences the
1823 * order of the output ports. It also influences the order of
1824 * the automatic stream IDs if the trace's packet headers do not
1825 * contain a `stream_instance_id` field, in which case the data
1826 * stream file to stream ID association is always the same,
1827 * whatever the build and the system.
1829 * Having a deterministic order here can help debugging and
1832 std::sort(ctf_fs
->trace
->ds_file_groups
.begin(), ctf_fs
->trace
->ds_file_groups
.end(),
1833 compare_ds_file_groups_by_first_path
);
1840 g_ptr_array_free(paths
, TRUE
);
1846 static GString
*get_stream_instance_unique_name(struct ctf_fs_ds_file_group
*ds_file_group
)
1849 struct ctf_fs_ds_file_info
*ds_file_info
;
1851 name
= g_string_new(NULL
);
1857 * If there's more than one stream file in the stream file
1858 * group, the first (earliest) stream file's path is used as
1859 * the stream's unique name.
1861 BT_ASSERT(!ds_file_group
->ds_file_infos
.empty());
1862 ds_file_info
= ds_file_group
->ds_file_infos
[0].get();
1863 g_string_assign(name
, ds_file_info
->path
.c_str());
1869 /* Create the IR stream objects for ctf_fs_trace. */
1871 static int create_streams_for_trace(struct ctf_fs_trace
*ctf_fs_trace
)
1874 GString
*name
= NULL
;
1876 for (const auto& ds_file_group
: ctf_fs_trace
->ds_file_groups
) {
1877 name
= get_stream_instance_unique_name(ds_file_group
.get());
1883 BT_ASSERT(ds_file_group
->sc
->ir_sc
);
1884 BT_ASSERT(ctf_fs_trace
->trace
);
1886 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
1887 /* No stream ID: use 0 */
1888 ds_file_group
->stream
= bt_stream_create_with_id(
1889 ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
, ctf_fs_trace
->next_stream_id
);
1890 ctf_fs_trace
->next_stream_id
++;
1892 /* Specific stream ID */
1893 ds_file_group
->stream
= bt_stream_create_with_id(
1894 ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
, (uint64_t) ds_file_group
->stream_id
);
1897 if (!ds_file_group
->stream
) {
1898 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1899 "Cannot create stream for DS file group: "
1900 "addr={}, stream-name=\"{}\"",
1901 fmt::ptr(ds_file_group
), name
->str
);
1905 ret
= bt_stream_set_name(ds_file_group
->stream
, name
->str
);
1907 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1908 "Cannot set stream's name: "
1909 "addr={}, stream-name=\"{}\"",
1910 fmt::ptr(ds_file_group
->stream
), name
->str
);
1914 g_string_free(name
, TRUE
);
1927 g_string_free(name
, TRUE
);
1932 static const bt_param_validation_value_descr inputs_elem_descr
=
1933 bt_param_validation_value_descr::makeString();
1935 static bt_param_validation_map_value_entry_descr fs_params_entries_descr
[] = {
1936 {"inputs", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
1937 bt_param_validation_value_descr::makeArray(1, BT_PARAM_VALIDATION_INFINITE
,
1938 inputs_elem_descr
)},
1939 {"trace-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1940 bt_param_validation_value_descr::makeString()},
1941 {"clock-class-offset-s", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1942 bt_param_validation_value_descr::makeSignedInteger()},
1943 {"clock-class-offset-ns", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1944 bt_param_validation_value_descr::makeSignedInteger()},
1945 {"force-clock-class-origin-unix-epoch", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1946 bt_param_validation_value_descr::makeBool()},
1947 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
1949 bool read_src_fs_parameters(const bt_value
*params
, const bt_value
**inputs
,
1950 const bt_value
**trace_name
, struct ctf_fs_component
*ctf_fs
)
1953 const bt_value
*value
;
1954 enum bt_param_validation_status validate_value_status
;
1955 gchar
*error
= NULL
;
1957 validate_value_status
= bt_param_validation_validate(params
, fs_params_entries_descr
, &error
);
1958 if (validate_value_status
!= BT_PARAM_VALIDATION_STATUS_OK
) {
1959 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "{}", error
);
1964 /* inputs parameter */
1965 *inputs
= bt_value_map_borrow_entry_value_const(params
, "inputs");
1967 /* clock-class-offset-s parameter */
1968 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-s");
1970 ctf_fs
->clkClsCfg
.offsetSec
= bt_value_integer_signed_get(value
);
1973 /* clock-class-offset-ns parameter */
1974 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-ns");
1976 ctf_fs
->clkClsCfg
.offsetNanoSec
= bt_value_integer_signed_get(value
);
1979 /* force-clock-class-origin-unix-epoch parameter */
1980 value
= bt_value_map_borrow_entry_value_const(params
, "force-clock-class-origin-unix-epoch");
1982 ctf_fs
->clkClsCfg
.forceOriginIsUnixEpoch
= bt_value_bool_get(value
);
1985 /* trace-name parameter */
1986 *trace_name
= bt_value_map_borrow_entry_value_const(params
, "trace-name");
1995 static ctf_fs_component::UP
ctf_fs_create(const bt_value
*params
,
1996 bt_self_component_source
*self_comp_src
)
1998 const bt_value
*inputs_value
;
1999 const bt_value
*trace_name_value
;
2000 bt_self_component
*self_comp
= bt_self_component_source_as_self_component(self_comp_src
);
2002 ctf_fs_component::UP ctf_fs
= ctf_fs_component_create(
2003 bt2c::Logger
{bt2::SelfSourceComponent
{self_comp_src
}, "PLUGIN/SRC.CTF.FS/COMP"});
2008 if (!read_src_fs_parameters(params
, &inputs_value
, &trace_name_value
, ctf_fs
.get())) {
2012 if (ctf_fs_component_create_ctf_fs_trace(ctf_fs
.get(), inputs_value
, trace_name_value
,
2017 if (create_streams_for_trace(ctf_fs
->trace
.get())) {
2021 if (create_ports_for_trace(ctf_fs
.get(), ctf_fs
->trace
.get(), self_comp_src
)) {
2028 bt_component_class_initialize_method_status
ctf_fs_init(bt_self_component_source
*self_comp_src
,
2029 bt_self_component_source_configuration
*,
2030 const bt_value
*params
, void *)
2033 bt_component_class_initialize_method_status ret
=
2034 BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
2036 ctf_fs_component::UP ctf_fs
= ctf_fs_create(params
, self_comp_src
);
2038 ret
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
2041 bt_self_component_set_data(bt_self_component_source_as_self_component(self_comp_src
),
2044 } catch (const std::bad_alloc
&) {
2045 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
2046 } catch (const bt2::Error
&) {
2047 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
2051 bt_component_class_query_method_status
ctf_fs_query(bt_self_component_class_source
*comp_class_src
,
2052 bt_private_query_executor
*priv_query_exec
,
2053 const char *object
, const bt_value
*params
,
2054 __attribute__((unused
)) void *method_data
,
2055 const bt_value
**result
)
2058 bt2c::Logger logger
{bt2::SelfComponentClass
{comp_class_src
},
2059 bt2::PrivateQueryExecutor
{priv_query_exec
},
2060 "PLUGIN/SRC.CTF.FS/QUERY"};
2061 bt2::ConstMapValue
paramsObj(params
);
2062 bt2::Value::Shared resultObj
;
2064 if (strcmp(object
, "metadata-info") == 0) {
2065 resultObj
= metadata_info_query(paramsObj
, logger
);
2066 } else if (strcmp(object
, "babeltrace.trace-infos") == 0) {
2067 resultObj
= trace_infos_query(paramsObj
, logger
);
2068 } else if (!strcmp(object
, "babeltrace.support-info")) {
2069 resultObj
= support_info_query(paramsObj
, logger
);
2071 BT_CPPLOGE_SPEC(logger
, "Unknown query object `{}`", object
);
2072 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;
2075 *result
= resultObj
.release().libObjPtr();
2077 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
2078 } catch (const std::bad_alloc
&) {
2079 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
2080 } catch (const bt2::Error
&) {
2081 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;