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
->len
== 1);
364 struct ctf_fs_ds_file_info
*ds_file_info
=
365 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
366 g_string_append_printf(name
, " | %s", ds_file_info
->path
.c_str());
369 return bt2c::GCharUP
{g_string_free(name
, FALSE
)};
372 static int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
373 struct ctf_fs_ds_file_group
*ds_file_group
,
374 bt_self_component_source
*self_comp_src
)
377 ctf_fs_port_data::UP port_data
;
379 bt2c::GCharUP port_name
= ctf_fs_make_port_name(ds_file_group
);
384 BT_CPPLOGI_SPEC(ctf_fs
->logger
, "Creating one port named `{}`", port_name
.get());
386 /* Create output port for this file */
387 port_data
= bt2s::make_unique
<ctf_fs_port_data
>();
388 port_data
->ctf_fs
= ctf_fs
;
389 port_data
->ds_file_group
= ds_file_group
;
390 ret
= bt_self_component_source_add_output_port(self_comp_src
, port_name
.get(), port_data
.get(),
396 ctf_fs
->port_data
.emplace_back(std::move(port_data
));
406 static int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
407 struct ctf_fs_trace
*ctf_fs_trace
,
408 bt_self_component_source
*self_comp_src
)
412 /* Create one output port for each stream file group */
413 for (const auto& ds_file_group
: ctf_fs_trace
->ds_file_groups
) {
414 ret
= create_one_port_for_trace(ctf_fs
, ds_file_group
.get(), self_comp_src
);
416 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create output port.");
425 /* Replace by g_ptr_array_insert when we depend on glib >= 2.40. */
426 static void array_insert(GPtrArray
*array
, gpointer element
, size_t pos
)
428 size_t original_array_len
= array
->len
;
430 /* Allocate an unused element at the end of the array. */
431 g_ptr_array_add(array
, NULL
);
433 /* If we are not inserting at the end, move the elements by one. */
434 if (pos
< original_array_len
) {
435 memmove(&(array
->pdata
[pos
+ 1]), &(array
->pdata
[pos
]),
436 (original_array_len
- pos
) * sizeof(gpointer
));
439 /* Insert the value. */
440 array
->pdata
[pos
] = element
;
444 * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right
445 * place to keep it sorted.
448 static void ds_file_group_insert_ds_file_info_sorted(struct ctf_fs_ds_file_group
*ds_file_group
,
449 struct ctf_fs_ds_file_info
*ds_file_info
)
453 /* Find the spot where to insert this ds_file_info. */
454 for (i
= 0; i
< ds_file_group
->ds_file_infos
->len
; i
++) {
455 struct ctf_fs_ds_file_info
*other_ds_file_info
=
456 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, i
);
458 if (ds_file_info
->begin_ns
< other_ds_file_info
->begin_ns
) {
463 array_insert(ds_file_group
->ds_file_infos
, ds_file_info
, i
);
466 static bool ds_index_entries_equal(const struct ctf_fs_ds_index_entry
*left
,
467 const struct ctf_fs_ds_index_entry
*right
)
469 if (left
->packetSize
!= right
->packetSize
) {
473 if (left
->timestamp_begin
!= right
->timestamp_begin
) {
477 if (left
->timestamp_end
!= right
->timestamp_end
) {
481 if (left
->packet_seq_num
!= right
->packet_seq_num
) {
489 * Insert `entry` into `index`, without duplication.
491 * The entry is inserted only if there isn't an identical entry already.
493 * In any case, the ownership of `entry` is transferred to this function. So if
494 * the entry is not inserted, it is freed.
497 static void ds_index_insert_ds_index_entry_sorted(struct ctf_fs_ds_index
*index
,
498 struct ctf_fs_ds_index_entry
*entry
)
501 struct ctf_fs_ds_index_entry
*other_entry
= NULL
;
503 /* Find the spot where to insert this index entry. */
504 for (i
= 0; i
< index
->entries
->len
; i
++) {
505 other_entry
= (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, i
);
507 if (entry
->timestamp_begin_ns
<= other_entry
->timestamp_begin_ns
) {
513 * Insert the entry only if a duplicate doesn't already exist.
515 * There can be duplicate packets if reading multiple overlapping
516 * snapshots of the same trace. We then want the index to contain
517 * a reference to only one copy of that packet.
519 if (i
== index
->entries
->len
|| !ds_index_entries_equal(entry
, other_entry
)) {
520 array_insert(index
->entries
, entry
, i
);
526 static void merge_ctf_fs_ds_indexes(struct ctf_fs_ds_index
*dest
, struct ctf_fs_ds_index
*src
)
530 for (i
= 0; i
< src
->entries
->len
; i
++) {
531 struct ctf_fs_ds_index_entry
*entry
=
532 (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(src
->entries
, i
);
535 * Ownership of the ctf_fs_ds_index_entry is transferred to
536 * ds_index_insert_ds_index_entry_sorted.
538 g_ptr_array_index(src
->entries
, i
) = NULL
;
539 ds_index_insert_ds_index_entry_sorted(dest
, entry
);
543 static int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
, const char *path
)
545 int64_t stream_instance_id
= -1;
546 int64_t begin_ns
= -1;
547 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
548 ctf_fs_ds_file_group::UP new_ds_file_group
;
550 struct ctf_fs_ds_file
*ds_file
= NULL
;
551 struct ctf_fs_ds_file_info
*ds_file_info
= NULL
;
552 struct ctf_fs_ds_index
*index
= NULL
;
553 struct ctf_msg_iter
*msg_iter
= NULL
;
554 struct ctf_stream_class
*sc
= NULL
;
555 struct ctf_msg_iter_packet_properties props
;
558 * Create a temporary ds_file to read some properties about the data
561 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, path
, ctf_fs_trace
->logger
);
566 /* Create a temporary iterator to read the ds_file. */
567 msg_iter
= ctf_msg_iter_create(
568 ctf_fs_trace
->metadata
->tc
,
569 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
570 ctf_fs_ds_file_medops
, ds_file
, nullptr, ctf_fs_trace
->logger
);
572 BT_CPPLOGE_STR_SPEC(ctf_fs_trace
->logger
, "Cannot create a CTF message iterator.");
576 ctf_msg_iter_set_dry_run(msg_iter
, true);
578 ret
= ctf_msg_iter_get_packet_properties(msg_iter
, &props
);
580 BT_CPPLOGE_APPEND_CAUSE_SPEC(
581 ctf_fs_trace
->logger
,
582 "Cannot get stream file's first packet's header and context fields (`{}`).", path
);
586 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
, props
.stream_class_id
);
588 stream_instance_id
= props
.data_stream_id
;
590 if (props
.snapshots
.beginning_clock
!= UINT64_C(-1)) {
591 BT_ASSERT(sc
->default_clock_class
);
592 ret
= bt_util_clock_cycles_to_ns_from_origin(
593 props
.snapshots
.beginning_clock
, sc
->default_clock_class
->frequency
,
594 sc
->default_clock_class
->offset_seconds
, sc
->default_clock_class
->offset_cycles
,
597 BT_CPPLOGE_APPEND_CAUSE_SPEC(
598 ctf_fs_trace
->logger
,
599 "Cannot convert clock cycles to nanoseconds from origin (`{}`).", path
);
604 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
);
609 index
= ctf_fs_ds_file_build_index(ds_file
, ds_file_info
, msg_iter
);
611 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to index CTF stream file \'{}\'",
612 ds_file
->file
->path
->str
);
616 if (begin_ns
== -1) {
618 * No beginning timestamp to sort the stream files
619 * within a stream file group, so consider that this
620 * file must be the only one within its group.
622 stream_instance_id
= -1;
625 if (stream_instance_id
== -1) {
627 * No stream instance ID or no beginning timestamp:
628 * create a unique stream file group for this stream
629 * file because, even if there's a stream instance ID,
630 * there's no timestamp to order the file within its
633 new_ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, UINT64_C(-1), index
);
635 /* Ownership of index is transferred. */
638 if (!new_ds_file_group
) {
642 ds_file_group_insert_ds_file_info_sorted(new_ds_file_group
.get(),
643 BT_MOVE_REF(ds_file_info
));
644 ctf_fs_trace
->ds_file_groups
.emplace_back(std::move(new_ds_file_group
));
648 BT_ASSERT(stream_instance_id
!= -1);
649 BT_ASSERT(begin_ns
!= -1);
651 /* Find an existing stream file group with this ID */
652 for (const auto& candidate
: ctf_fs_trace
->ds_file_groups
) {
653 if (candidate
->sc
== sc
&& candidate
->stream_id
== stream_instance_id
) {
654 ds_file_group
= candidate
.get();
659 if (!ds_file_group
) {
661 ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, stream_instance_id
, index
);
662 /* Ownership of index is transferred. */
664 if (!new_ds_file_group
) {
668 ds_file_group
= new_ds_file_group
.get();
669 ctf_fs_trace
->ds_file_groups
.emplace_back(std::move(new_ds_file_group
));
671 merge_ctf_fs_ds_indexes(ds_file_group
->index
, index
);
674 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, BT_MOVE_REF(ds_file_info
));
682 ctf_fs_ds_file_destroy(ds_file
);
683 ctf_fs_ds_file_info_destroy(ds_file_info
);
686 ctf_msg_iter_destroy(msg_iter
);
689 ctf_fs_ds_index_destroy(index
);
693 static int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
696 const char *basename
;
697 GError
*error
= NULL
;
700 /* Check each file in the path directory, except specific ones */
701 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
703 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
704 "Cannot open directory `{}`: {} (code {})",
705 ctf_fs_trace
->path
->str
, error
->message
, error
->code
);
709 while ((basename
= g_dir_read_name(dir
))) {
710 struct ctf_fs_file
*file
;
712 if (strcmp(basename
, CTF_FS_METADATA_FILENAME
) == 0) {
713 /* Ignore the metadata stream. */
714 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
715 "Ignoring metadata file `{}" G_DIR_SEPARATOR_S
"{}`",
716 ctf_fs_trace
->path
->str
, basename
);
720 if (basename
[0] == '.') {
721 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
722 "Ignoring hidden file `{}" G_DIR_SEPARATOR_S
"{}`",
723 ctf_fs_trace
->path
->str
, basename
);
727 /* Create the file. */
728 file
= ctf_fs_file_create(ctf_fs_trace
->logger
);
730 BT_CPPLOGE_APPEND_CAUSE_SPEC(
731 ctf_fs_trace
->logger
,
732 "Cannot create stream file object for file `{}" G_DIR_SEPARATOR_S
"{}`",
733 ctf_fs_trace
->path
->str
, basename
);
737 /* Create full path string. */
738 g_string_append_printf(file
->path
, "%s" G_DIR_SEPARATOR_S
"%s", ctf_fs_trace
->path
->str
,
740 if (!g_file_test(file
->path
->str
, G_FILE_TEST_IS_REGULAR
)) {
741 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring non-regular file `{}`",
743 ctf_fs_file_destroy(file
);
748 ret
= ctf_fs_file_open(file
, "rb");
750 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Cannot open stream file `{}`",
755 if (file
->size
== 0) {
756 /* Skip empty stream. */
757 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring empty file `{}`", file
->path
->str
);
758 ctf_fs_file_destroy(file
);
762 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
, file
->path
->str
);
764 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
765 "Cannot add stream file `{}` to stream file group",
767 ctf_fs_file_destroy(file
);
771 ctf_fs_file_destroy(file
);
792 static int set_trace_name(bt_trace
*trace
, const char *name_suffix
, const bt2c::Logger
& logger
)
798 name
= g_string_new(NULL
);
800 BT_CPPLOGE_STR_SPEC(logger
, "Failed to allocate a GString.");
806 * Check if we have a trace environment string value named `hostname`.
807 * If so, use it as the trace name's prefix.
809 val
= bt_trace_borrow_environment_entry_value_by_name_const(trace
, "hostname");
810 if (val
&& bt_value_is_string(val
)) {
811 g_string_append(name
, bt_value_string_get(val
));
814 g_string_append_c(name
, G_DIR_SEPARATOR
);
819 g_string_append(name
, name_suffix
);
822 ret
= bt_trace_set_name(trace
, name
->str
);
831 g_string_free(name
, TRUE
);
837 static ctf_fs_trace::UP
ctf_fs_trace_create(const char *path
, const char *name
,
838 const ctf::src::ClkClsCfg
& clkClsCfg
,
839 bt_self_component
*selfComp
,
840 const bt2c::Logger
& parentLogger
)
844 ctf_fs_trace::UP ctf_fs_trace
{new struct ctf_fs_trace(parentLogger
)};
845 ctf_fs_trace
->path
= g_string_new(path
);
846 if (!ctf_fs_trace
->path
) {
850 ctf_fs_trace
->metadata
= new ctf_fs_metadata
;
851 ctf_fs_metadata_init(ctf_fs_trace
->metadata
);
853 ret
= ctf_fs_metadata_set_trace_class(selfComp
, ctf_fs_trace
.get(), clkClsCfg
);
858 if (ctf_fs_trace
->metadata
->trace_class
) {
859 ctf_fs_trace
->trace
= bt_trace_create(ctf_fs_trace
->metadata
->trace_class
);
860 if (!ctf_fs_trace
->trace
) {
865 if (ctf_fs_trace
->trace
) {
866 ret
= ctf_trace_class_configure_ir_trace(ctf_fs_trace
->metadata
->tc
, ctf_fs_trace
->trace
);
871 ret
= set_trace_name(ctf_fs_trace
->trace
, name
, ctf_fs_trace
->logger
);
877 ret
= create_ds_file_groups(ctf_fs_trace
.get());
885 ctf_fs_trace
.reset();
891 static int path_is_ctf_trace(const char *path
)
893 GString
*metadata_path
= g_string_new(NULL
);
896 if (!metadata_path
) {
901 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
903 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
909 g_string_free(metadata_path
, TRUE
);
913 /* Helper for ctf_fs_component_create_ctf_fs_trace, to handle a single path. */
915 static int ctf_fs_component_create_ctf_fs_trace_one_path(struct ctf_fs_component
*ctf_fs
,
916 const char *path_param
,
917 const char *trace_name
,
918 std::vector
<ctf_fs_trace::UP
>& traces
,
919 bt_self_component
*selfComp
)
921 ctf_fs_trace::UP ctf_fs_trace
;
925 norm_path
= bt_common_normalize_path(path_param
, NULL
);
927 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to normalize path: `{}`.", path_param
);
931 ret
= path_is_ctf_trace(norm_path
->str
);
933 BT_CPPLOGE_APPEND_CAUSE_SPEC(
934 ctf_fs
->logger
, "Failed to check if path is a CTF trace: path={}", norm_path
->str
);
936 } else if (ret
== 0) {
937 BT_CPPLOGE_APPEND_CAUSE_SPEC(
938 ctf_fs
->logger
, "Path is not a CTF trace (does not contain a metadata file): `{}`.",
943 // FIXME: Remove or ifdef for __MINGW32__
944 if (strcmp(norm_path
->str
, "/") == 0) {
945 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Opening a trace in `/` is not supported.");
950 ctf_fs_trace
= ctf_fs_trace_create(norm_path
->str
, trace_name
, ctf_fs
->clkClsCfg
, selfComp
,
953 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create trace for `{}`.",
958 traces
.emplace_back(std::move(ctf_fs_trace
));
968 g_string_free(norm_path
, TRUE
);
975 * Count the number of stream and event classes defined by this trace's metadata.
977 * This is used to determine which metadata is the "latest", out of multiple
978 * traces sharing the same UUID. It is assumed that amongst all these metadatas,
979 * a bigger metadata is a superset of a smaller metadata. Therefore, it is
980 * enough to just count the classes.
983 static unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace
*trace
)
985 unsigned int num
= trace
->metadata
->tc
->stream_classes
->len
;
988 for (i
= 0; i
< trace
->metadata
->tc
->stream_classes
->len
; i
++) {
989 struct ctf_stream_class
*sc
=
990 (struct ctf_stream_class
*) trace
->metadata
->tc
->stream_classes
->pdata
[i
];
991 num
+= sc
->event_classes
->len
;
998 * Merge the src ds_file_group into dest. This consists of merging their
999 * ds_file_infos, making sure to keep the result sorted.
1002 static void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group
*dest
,
1003 ctf_fs_ds_file_group::UP src
)
1007 for (i
= 0; i
< src
->ds_file_infos
->len
; i
++) {
1008 struct ctf_fs_ds_file_info
*ds_file_info
=
1009 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(src
->ds_file_infos
, i
);
1011 /* Ownership of the ds_file_info is transferred to dest. */
1012 g_ptr_array_index(src
->ds_file_infos
, i
) = NULL
;
1014 ds_file_group_insert_ds_file_info_sorted(dest
, ds_file_info
);
1017 /* Merge both indexes. */
1018 merge_ctf_fs_ds_indexes(dest
->index
, src
->index
);
1021 /* Merge src_trace's data stream file groups into dest_trace's. */
1023 static int merge_matching_ctf_fs_ds_file_groups(struct ctf_fs_trace
*dest_trace
,
1024 ctf_fs_trace::UP src_trace
)
1026 std::vector
<ctf_fs_ds_file_group::UP
>& dest
= dest_trace
->ds_file_groups
;
1027 std::vector
<ctf_fs_ds_file_group::UP
>& src
= src_trace
->ds_file_groups
;
1031 * Save the initial length of dest: we only want to check against the
1032 * original elements in the inner loop.
1034 size_t dest_len
= dest
.size();
1036 for (auto& src_group
: src
) {
1037 struct ctf_fs_ds_file_group
*dest_group
= NULL
;
1039 /* A stream instance without ID can't match a stream in the other trace. */
1040 if (src_group
->stream_id
!= -1) {
1041 /* Let's search for a matching ds_file_group in the destination. */
1042 for (size_t d_i
= 0; d_i
< dest_len
; ++d_i
) {
1043 ctf_fs_ds_file_group
*candidate_dest
= dest
[d_i
].get();
1045 /* Can't match a stream instance without ID. */
1046 if (candidate_dest
->stream_id
== -1) {
1051 * If the two groups have the same stream instance id
1052 * and belong to the same stream class (stream instance
1053 * ids are per-stream class), they represent the same
1056 if (candidate_dest
->stream_id
!= src_group
->stream_id
||
1057 candidate_dest
->sc
->id
!= src_group
->sc
->id
) {
1061 dest_group
= candidate_dest
;
1067 * Didn't find a friend in dest to merge our src_group into?
1068 * Create a new empty one. This can happen if a stream was
1069 * active in the source trace chunk but not in the destination
1073 struct ctf_stream_class
*sc
;
1074 struct ctf_fs_ds_index
*index
;
1076 sc
= ctf_trace_class_borrow_stream_class_by_id(dest_trace
->metadata
->tc
,
1080 index
= ctf_fs_ds_index_create(dest_trace
->logger
);
1086 auto new_dest_group
=
1087 ctf_fs_ds_file_group_create(dest_trace
, sc
, src_group
->stream_id
, index
);
1089 /* Ownership of index is transferred. */
1091 if (!new_dest_group
) {
1096 dest_group
= new_dest_group
.get();
1097 dest_trace
->ds_file_groups
.emplace_back(std::move(new_dest_group
));
1100 BT_ASSERT(dest_group
);
1101 merge_ctf_fs_ds_file_groups(dest_group
, std::move(src_group
));
1109 * Collapse the given traces, which must all share the same UUID, in a single
1112 * The trace with the most expansive metadata is chosen and all other traces
1113 * are merged into that one. On return, the elements of `traces` are nullptr
1114 * and the merged trace is placed in `out_trace`.
1117 static int merge_ctf_fs_traces(std::vector
<ctf_fs_trace::UP
> traces
, ctf_fs_trace::UP
& out_trace
)
1119 unsigned int winner_count
;
1120 struct ctf_fs_trace
*winner
;
1124 BT_ASSERT(traces
.size() >= 2);
1126 winner_count
= metadata_count_stream_and_event_classes(traces
[0].get());
1127 winner
= traces
[0].get();
1130 /* Find the trace with the largest metadata. */
1131 for (i
= 1; i
< traces
.size(); i
++) {
1132 ctf_fs_trace
*candidate
= traces
[i
].get();
1133 unsigned int candidate_count
;
1135 /* A bit of sanity check. */
1136 BT_ASSERT(bt_uuid_compare(winner
->metadata
->tc
->uuid
, candidate
->metadata
->tc
->uuid
) == 0);
1138 candidate_count
= metadata_count_stream_and_event_classes(candidate
);
1140 if (candidate_count
> winner_count
) {
1141 winner_count
= candidate_count
;
1147 /* Merge all the other traces in the winning trace. */
1148 for (ctf_fs_trace::UP
& trace
: traces
) {
1149 /* Don't merge the winner into itself. */
1150 if (trace
.get() == winner
) {
1154 /* Merge trace's data stream file groups into winner's. */
1155 ret
= merge_matching_ctf_fs_ds_file_groups(winner
, std::move(trace
));
1162 * Move the winner out of the array, into `*out_trace`.
1164 out_trace
= std::move(traces
[winner_i
]);
1176 static int decode_clock_snapshot_after_event(struct ctf_fs_trace
*ctf_fs_trace
,
1177 struct ctf_clock_class
*default_cc
,
1178 struct ctf_fs_ds_index_entry
*index_entry
,
1179 enum target_event target_event
, uint64_t *cs
,
1182 enum ctf_msg_iter_status iter_status
= CTF_MSG_ITER_STATUS_OK
;
1183 struct ctf_fs_ds_file
*ds_file
= NULL
;
1184 struct ctf_msg_iter
*msg_iter
= NULL
;
1187 BT_ASSERT(ctf_fs_trace
);
1188 BT_ASSERT(index_entry
);
1189 BT_ASSERT(index_entry
->path
);
1191 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, index_entry
->path
, ctf_fs_trace
->logger
);
1193 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to create a ctf_fs_ds_file");
1198 BT_ASSERT(ctf_fs_trace
->metadata
);
1199 BT_ASSERT(ctf_fs_trace
->metadata
->tc
);
1201 msg_iter
= ctf_msg_iter_create(
1202 ctf_fs_trace
->metadata
->tc
,
1203 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
1204 ctf_fs_ds_file_medops
, ds_file
, NULL
, ctf_fs_trace
->logger
);
1206 /* ctf_msg_iter_create() logs errors. */
1212 * Turn on dry run mode to prevent the creation and usage of Babeltrace
1213 * library objects (bt_field, bt_message_*, etc.).
1215 ctf_msg_iter_set_dry_run(msg_iter
, true);
1217 /* Seek to the beginning of the target packet. */
1218 iter_status
= ctf_msg_iter_seek(msg_iter
, index_entry
->offset
.bytes());
1220 /* ctf_msg_iter_seek() logs errors. */
1225 switch (target_event
) {
1228 * Start to decode the packet until we reach the end of
1229 * the first event. To extract the first event's clock
1232 iter_status
= ctf_msg_iter_curr_packet_first_event_clock_snapshot(msg_iter
, cs
);
1235 /* Decode the packet to extract the last event's clock snapshot. */
1236 iter_status
= ctf_msg_iter_curr_packet_last_event_clock_snapshot(msg_iter
, cs
);
1246 /* Convert clock snapshot to timestamp. */
1247 ret
= bt_util_clock_cycles_to_ns_from_origin(
1248 *cs
, default_cc
->frequency
, default_cc
->offset_seconds
, default_cc
->offset_cycles
, ts_ns
);
1250 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1251 "Failed to convert clock snapshot to timestamp");
1257 ctf_fs_ds_file_destroy(ds_file
);
1260 ctf_msg_iter_destroy(msg_iter
);
1266 static int decode_packet_first_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1267 struct ctf_clock_class
*default_cc
,
1268 struct ctf_fs_ds_index_entry
*index_entry
,
1269 uint64_t *cs
, int64_t *ts_ns
)
1271 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, FIRST_EVENT
, cs
,
1275 static int decode_packet_last_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1276 struct ctf_clock_class
*default_cc
,
1277 struct ctf_fs_ds_index_entry
*index_entry
,
1278 uint64_t *cs
, int64_t *ts_ns
)
1280 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, LAST_EVENT
, cs
,
1285 * Fix up packet index entries for lttng's "event-after-packet" bug.
1286 * Some buggy lttng tracer versions may emit events with a timestamp that is
1287 * larger (after) than the timestamp_end of the their packets.
1289 * To fix up this erroneous data we do the following:
1290 * 1. If it's not the stream file's last packet: set the packet index entry's
1291 * end time to the next packet's beginning time.
1292 * 2. If it's the stream file's last packet, set the packet index entry's end
1293 * time to the packet's last event's time, if any, or to the packet's
1294 * beginning time otherwise.
1296 * Known buggy tracer versions:
1297 * - before lttng-ust 2.11.0
1298 * - before lttng-module 2.11.0
1299 * - before lttng-module 2.10.10
1300 * - before lttng-module 2.9.13
1302 static int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace
*trace
)
1306 for (const auto& ds_file_group
: trace
->ds_file_groups
) {
1308 struct ctf_clock_class
*default_cc
;
1309 struct ctf_fs_ds_index_entry
*last_entry
;
1310 struct ctf_fs_ds_index
*index
;
1312 BT_ASSERT(ds_file_group
);
1313 index
= ds_file_group
->index
;
1316 BT_ASSERT(index
->entries
);
1317 BT_ASSERT(index
->entries
->len
> 0);
1320 * Iterate over all entries but the last one. The last one is
1321 * fixed differently after.
1323 for (entry_i
= 0; entry_i
< index
->entries
->len
- 1; entry_i
++) {
1324 struct ctf_fs_ds_index_entry
*curr_entry
, *next_entry
;
1326 curr_entry
= (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
);
1327 next_entry
= (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
+ 1);
1330 * 1. Set the current index entry `end` timestamp to
1331 * the next index entry `begin` timestamp.
1333 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1334 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1338 * 2. Fix the last entry by decoding the last event of the last
1342 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, index
->entries
->len
- 1);
1343 BT_ASSERT(last_entry
);
1345 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1346 default_cc
= ds_file_group
->sc
->default_clock_class
;
1349 * Decode packet to read the timestamp of the last event of the
1352 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1353 &last_entry
->timestamp_end
,
1354 &last_entry
->timestamp_end_ns
);
1356 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1358 "Failed to decode stream's last packet to get its last event's clock snapshot.");
1368 * Fix up packet index entries for barectf's "event-before-packet" bug.
1369 * Some buggy barectf tracer versions may emit events with a timestamp that is
1370 * less than the timestamp_begin of the their packets.
1372 * To fix up this erroneous data we do the following:
1373 * 1. Starting at the second index entry, set the timestamp_begin of the
1374 * current entry to the timestamp of the first event of the packet.
1375 * 2. Set the previous entry's timestamp_end to the timestamp_begin of the
1378 * Known buggy tracer versions:
1379 * - before barectf 2.3.1
1381 static int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace
*trace
)
1385 for (const auto& ds_file_group
: trace
->ds_file_groups
) {
1387 struct ctf_clock_class
*default_cc
;
1388 struct ctf_fs_ds_index
*index
= ds_file_group
->index
;
1391 BT_ASSERT(index
->entries
);
1392 BT_ASSERT(index
->entries
->len
> 0);
1394 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1395 default_cc
= ds_file_group
->sc
->default_clock_class
;
1398 * 1. Iterate over the index, starting from the second entry
1401 for (entry_i
= 1; entry_i
< index
->entries
->len
; entry_i
++) {
1402 ctf_fs_ds_index_entry
*prev_entry
=
1403 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
- 1);
1404 ctf_fs_ds_index_entry
*curr_entry
=
1405 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
);
1407 * 2. Set the current entry `begin` timestamp to the
1408 * timestamp of the first event of the current packet.
1410 ret
= decode_packet_first_event_timestamp(trace
, default_cc
, curr_entry
,
1411 &curr_entry
->timestamp_begin
,
1412 &curr_entry
->timestamp_begin_ns
);
1414 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1415 "Failed to decode first event's clock snapshot");
1420 * 3. Set the previous entry `end` timestamp to the
1421 * timestamp of the first event of the current packet.
1423 prev_entry
->timestamp_end
= curr_entry
->timestamp_begin
;
1424 prev_entry
->timestamp_end_ns
= curr_entry
->timestamp_begin_ns
;
1432 * When using the lttng-crash feature it's likely that the last packets of each
1433 * stream have their timestamp_end set to zero. This is caused by the fact that
1434 * the tracer crashed and was not able to properly close the packets.
1436 * To fix up this erroneous data we do the following:
1437 * For each index entry, if the entry's timestamp_end is 0 and the
1438 * timestamp_begin is not 0:
1439 * - If it's the stream file's last packet: set the packet index entry's end
1440 * time to the packet's last event's time, if any, or to the packet's
1441 * beginning time otherwise.
1442 * - If it's not the stream file's last packet: set the packet index
1443 * entry's end time to the next packet's beginning time.
1445 * Affected versions:
1446 * - All current and future lttng-ust and lttng-modules versions.
1448 static int fix_index_lttng_crash_quirk(struct ctf_fs_trace
*trace
)
1452 for (const auto& ds_file_group
: trace
->ds_file_groups
) {
1454 struct ctf_clock_class
*default_cc
;
1455 struct ctf_fs_ds_index
*index
;
1457 BT_ASSERT(ds_file_group
);
1458 index
= ds_file_group
->index
;
1460 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1461 default_cc
= ds_file_group
->sc
->default_clock_class
;
1464 BT_ASSERT(index
->entries
);
1465 BT_ASSERT(index
->entries
->len
> 0);
1467 ctf_fs_ds_index_entry
*last_entry
=
1468 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, index
->entries
->len
- 1);
1469 BT_ASSERT(last_entry
);
1471 /* 1. Fix the last entry first. */
1472 if (last_entry
->timestamp_end
== 0 && last_entry
->timestamp_begin
!= 0) {
1474 * Decode packet to read the timestamp of the
1475 * last event of the stream file.
1477 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1478 &last_entry
->timestamp_end
,
1479 &last_entry
->timestamp_end_ns
);
1481 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1482 "Failed to decode last event's clock snapshot");
1487 /* Iterate over all entries but the last one. */
1488 for (entry_idx
= 0; entry_idx
< index
->entries
->len
- 1; entry_idx
++) {
1489 ctf_fs_ds_index_entry
*curr_entry
=
1490 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_idx
);
1491 ctf_fs_ds_index_entry
*next_entry
=
1492 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_idx
+ 1);
1494 if (curr_entry
->timestamp_end
== 0 && curr_entry
->timestamp_begin
!= 0) {
1496 * 2. Set the current index entry `end` timestamp to
1497 * the next index entry `begin` timestamp.
1499 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1500 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1510 * Extract the tracer information necessary to compare versions.
1511 * Returns 0 on success, and -1 if the extraction is not successful because the
1512 * necessary fields are absents in the trace metadata.
1514 static int extract_tracer_info(struct ctf_fs_trace
*trace
, struct tracer_info
*current_tracer_info
)
1517 struct ctf_trace_class_env_entry
*entry
;
1519 /* Clear the current_tracer_info struct */
1520 memset(current_tracer_info
, 0, sizeof(*current_tracer_info
));
1523 * To compare 2 tracer versions, at least the tracer name and it's
1524 * major version are needed. If one of these is missing, consider it an
1525 * extraction failure.
1527 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_name");
1528 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR
) {
1529 goto missing_bare_minimum
;
1532 /* Set tracer name. */
1533 current_tracer_info
->name
= entry
->value
.str
->str
;
1535 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_major");
1536 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1537 goto missing_bare_minimum
;
1540 /* Set major version number. */
1541 current_tracer_info
->major
= entry
->value
.i
;
1543 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_minor");
1544 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1548 /* Set minor version number. */
1549 current_tracer_info
->minor
= entry
->value
.i
;
1551 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patch");
1554 * If `tracer_patch` doesn't exist `tracer_patchlevel` might.
1555 * For example, `lttng-modules` uses entry name
1556 * `tracer_patchlevel`.
1558 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patchlevel");
1561 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1565 /* Set patch version number. */
1566 current_tracer_info
->patch
= entry
->value
.i
;
1570 missing_bare_minimum
:
1576 static bool is_tracer_affected_by_lttng_event_after_packet_bug(struct tracer_info
*curr_tracer_info
)
1578 bool is_affected
= false;
1580 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1581 if (curr_tracer_info
->major
< 2) {
1583 } else if (curr_tracer_info
->major
== 2) {
1584 /* fixed in lttng-ust 2.11.0 */
1585 if (curr_tracer_info
->minor
< 11) {
1589 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1590 if (curr_tracer_info
->major
< 2) {
1592 } else if (curr_tracer_info
->major
== 2) {
1593 /* fixed in lttng-modules 2.11.0 */
1594 if (curr_tracer_info
->minor
== 10) {
1595 /* fixed in lttng-modules 2.10.10 */
1596 if (curr_tracer_info
->patch
< 10) {
1599 } else if (curr_tracer_info
->minor
== 9) {
1600 /* fixed in lttng-modules 2.9.13 */
1601 if (curr_tracer_info
->patch
< 13) {
1604 } else if (curr_tracer_info
->minor
< 9) {
1614 is_tracer_affected_by_barectf_event_before_packet_bug(struct tracer_info
*curr_tracer_info
)
1616 bool is_affected
= false;
1618 if (strcmp(curr_tracer_info
->name
, "barectf") == 0) {
1619 if (curr_tracer_info
->major
< 2) {
1621 } else if (curr_tracer_info
->major
== 2) {
1622 if (curr_tracer_info
->minor
< 3) {
1624 } else if (curr_tracer_info
->minor
== 3) {
1625 /* fixed in barectf 2.3.1 */
1626 if (curr_tracer_info
->patch
< 1) {
1636 static bool is_tracer_affected_by_lttng_crash_quirk(struct tracer_info
*curr_tracer_info
)
1638 bool is_affected
= false;
1640 /* All LTTng tracer may be affected by this lttng crash quirk. */
1641 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1643 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1651 * Looks for trace produced by known buggy tracers and fix up the index
1654 static int fix_packet_index_tracer_bugs(ctf_fs_trace
*trace
)
1657 struct tracer_info current_tracer_info
;
1659 ret
= extract_tracer_info(trace
, ¤t_tracer_info
);
1662 * A trace may not have all the necessary environment
1663 * entries to do the tracer version comparison.
1664 * At least, the tracer name and major version number
1665 * are needed. Failing to extract these entries is not
1669 BT_CPPLOGI_STR_SPEC(
1671 "Cannot extract tracer information necessary to compare with buggy versions.");
1675 /* Check if the trace may be affected by old tracer bugs. */
1676 if (is_tracer_affected_by_lttng_event_after_packet_bug(¤t_tracer_info
)) {
1677 BT_CPPLOGI_STR_SPEC(
1679 "Trace may be affected by LTTng tracer packet timestamp bug. Fixing up.");
1680 ret
= fix_index_lttng_event_after_packet_bug(trace
);
1682 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1683 "Failed to fix LTTng event-after-packet bug.");
1686 trace
->metadata
->tc
->quirks
.lttng_event_after_packet
= true;
1689 if (is_tracer_affected_by_barectf_event_before_packet_bug(¤t_tracer_info
)) {
1690 BT_CPPLOGI_STR_SPEC(
1692 "Trace may be affected by barectf tracer packet timestamp bug. Fixing up.");
1693 ret
= fix_index_barectf_event_before_packet_bug(trace
);
1695 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1696 "Failed to fix barectf event-before-packet bug.");
1699 trace
->metadata
->tc
->quirks
.barectf_event_before_packet
= true;
1702 if (is_tracer_affected_by_lttng_crash_quirk(¤t_tracer_info
)) {
1703 ret
= fix_index_lttng_crash_quirk(trace
);
1705 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1706 "Failed to fix lttng-crash timestamp quirks.");
1709 trace
->metadata
->tc
->quirks
.lttng_crash
= true;
1716 static bool compare_ds_file_groups_by_first_path(const ctf_fs_ds_file_group::UP
& ds_file_group_a
,
1717 const ctf_fs_ds_file_group::UP
& ds_file_group_b
)
1719 BT_ASSERT(ds_file_group_a
->ds_file_infos
->len
> 0);
1720 BT_ASSERT(ds_file_group_b
->ds_file_infos
->len
> 0);
1722 const ctf_fs_ds_file_info
*first_ds_file_info_a
=
1723 (const ctf_fs_ds_file_info
*) ds_file_group_a
->ds_file_infos
->pdata
[0];
1724 const ctf_fs_ds_file_info
*first_ds_file_info_b
=
1725 (const ctf_fs_ds_file_info
*) ds_file_group_b
->ds_file_infos
->pdata
[0];
1727 return first_ds_file_info_a
->path
< first_ds_file_info_b
->path
;
1730 static gint
compare_strings(gconstpointer p_a
, gconstpointer p_b
)
1732 const char *a
= *((const char **) p_a
);
1733 const char *b
= *((const char **) p_b
);
1735 return strcmp(a
, b
);
1738 int ctf_fs_component_create_ctf_fs_trace(struct ctf_fs_component
*ctf_fs
,
1739 const bt_value
*paths_value
,
1740 const bt_value
*trace_name_value
,
1741 bt_self_component
*selfComp
)
1745 GPtrArray
*paths
= NULL
;
1746 std::vector
<ctf_fs_trace::UP
> traces
;
1747 const char *trace_name
;
1749 BT_ASSERT(bt_value_get_type(paths_value
) == BT_VALUE_TYPE_ARRAY
);
1750 BT_ASSERT(!bt_value_array_is_empty(paths_value
));
1752 paths
= g_ptr_array_new_with_free_func(g_free
);
1754 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to allocate a GPtrArray.");
1758 trace_name
= trace_name_value
? bt_value_string_get(trace_name_value
) : NULL
;
1761 * Create a sorted array of the paths, to make the execution of this
1762 * component deterministic.
1764 for (i
= 0; i
< bt_value_array_get_length(paths_value
); i
++) {
1765 const bt_value
*path_value
= bt_value_array_borrow_element_by_index_const(paths_value
, i
);
1766 const char *input
= bt_value_string_get(path_value
);
1769 input_copy
= g_strdup(input
);
1771 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to copy a string.");
1775 g_ptr_array_add(paths
, input_copy
);
1778 g_ptr_array_sort(paths
, compare_strings
);
1780 /* Create a separate ctf_fs_trace object for each path. */
1781 for (i
= 0; i
< paths
->len
; i
++) {
1782 const char *path
= (const char *) g_ptr_array_index(paths
, i
);
1784 ret
= ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs
, path
, trace_name
, traces
,
1791 if (traces
.size() > 1) {
1792 ctf_fs_trace
*first_trace
= traces
[0].get();
1793 const uint8_t *first_trace_uuid
= first_trace
->metadata
->tc
->uuid
;
1796 * We have more than one trace, they must all share the same
1797 * UUID, verify that.
1799 for (i
= 0; i
< traces
.size(); i
++) {
1800 ctf_fs_trace
*this_trace
= traces
[i
].get();
1801 const uint8_t *this_trace_uuid
= this_trace
->metadata
->tc
->uuid
;
1803 if (!this_trace
->metadata
->tc
->is_uuid_set
) {
1804 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1806 "Multiple traces given, but a trace does not have a UUID: path={}",
1807 this_trace
->path
->str
);
1811 if (bt_uuid_compare(first_trace_uuid
, this_trace_uuid
) != 0) {
1812 char first_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1813 char this_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1815 bt_uuid_to_str(first_trace_uuid
, first_trace_uuid_str
);
1816 bt_uuid_to_str(this_trace_uuid
, this_trace_uuid_str
);
1818 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1819 "Multiple traces given, but UUIDs don't match: "
1820 "first-trace-uuid={}, first-trace-path={}, "
1821 "trace-uuid={}, trace-path={}",
1822 first_trace_uuid_str
, first_trace
->path
->str
,
1823 this_trace_uuid_str
, this_trace
->path
->str
);
1828 ret
= merge_ctf_fs_traces(std::move(traces
), ctf_fs
->trace
);
1830 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1831 "Failed to merge traces with the same UUID.");
1835 /* Just one trace, it may or may not have a UUID, both are fine. */
1836 ctf_fs
->trace
= std::move(traces
[0]);
1839 ret
= fix_packet_index_tracer_bugs(ctf_fs
->trace
.get());
1841 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to fix packet index tracer bugs.");
1845 * Sort data stream file groups by first data stream file info
1846 * path to get a deterministic order. This order influences the
1847 * order of the output ports. It also influences the order of
1848 * the automatic stream IDs if the trace's packet headers do not
1849 * contain a `stream_instance_id` field, in which case the data
1850 * stream file to stream ID association is always the same,
1851 * whatever the build and the system.
1853 * Having a deterministic order here can help debugging and
1856 std::sort(ctf_fs
->trace
->ds_file_groups
.begin(), ctf_fs
->trace
->ds_file_groups
.end(),
1857 compare_ds_file_groups_by_first_path
);
1864 g_ptr_array_free(paths
, TRUE
);
1870 static GString
*get_stream_instance_unique_name(struct ctf_fs_ds_file_group
*ds_file_group
)
1873 struct ctf_fs_ds_file_info
*ds_file_info
;
1875 name
= g_string_new(NULL
);
1881 * If there's more than one stream file in the stream file
1882 * group, the first (earliest) stream file's path is used as
1883 * the stream's unique name.
1885 BT_ASSERT(ds_file_group
->ds_file_infos
->len
> 0);
1886 ds_file_info
= (ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
1887 g_string_assign(name
, ds_file_info
->path
.c_str());
1893 /* Create the IR stream objects for ctf_fs_trace. */
1895 static int create_streams_for_trace(struct ctf_fs_trace
*ctf_fs_trace
)
1898 GString
*name
= NULL
;
1900 for (const auto& ds_file_group
: ctf_fs_trace
->ds_file_groups
) {
1901 name
= get_stream_instance_unique_name(ds_file_group
.get());
1907 BT_ASSERT(ds_file_group
->sc
->ir_sc
);
1908 BT_ASSERT(ctf_fs_trace
->trace
);
1910 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
1911 /* No stream ID: use 0 */
1912 ds_file_group
->stream
= bt_stream_create_with_id(
1913 ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
, ctf_fs_trace
->next_stream_id
);
1914 ctf_fs_trace
->next_stream_id
++;
1916 /* Specific stream ID */
1917 ds_file_group
->stream
= bt_stream_create_with_id(
1918 ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
, (uint64_t) ds_file_group
->stream_id
);
1921 if (!ds_file_group
->stream
) {
1922 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1923 "Cannot create stream for DS file group: "
1924 "addr={}, stream-name=\"{}\"",
1925 fmt::ptr(ds_file_group
), name
->str
);
1929 ret
= bt_stream_set_name(ds_file_group
->stream
, name
->str
);
1931 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1932 "Cannot set stream's name: "
1933 "addr={}, stream-name=\"{}\"",
1934 fmt::ptr(ds_file_group
->stream
), name
->str
);
1938 g_string_free(name
, TRUE
);
1951 g_string_free(name
, TRUE
);
1956 static const bt_param_validation_value_descr inputs_elem_descr
=
1957 bt_param_validation_value_descr::makeString();
1959 static bt_param_validation_map_value_entry_descr fs_params_entries_descr
[] = {
1960 {"inputs", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
1961 bt_param_validation_value_descr::makeArray(1, BT_PARAM_VALIDATION_INFINITE
,
1962 inputs_elem_descr
)},
1963 {"trace-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1964 bt_param_validation_value_descr::makeString()},
1965 {"clock-class-offset-s", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1966 bt_param_validation_value_descr::makeSignedInteger()},
1967 {"clock-class-offset-ns", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1968 bt_param_validation_value_descr::makeSignedInteger()},
1969 {"force-clock-class-origin-unix-epoch", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1970 bt_param_validation_value_descr::makeBool()},
1971 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
1973 bool read_src_fs_parameters(const bt_value
*params
, const bt_value
**inputs
,
1974 const bt_value
**trace_name
, struct ctf_fs_component
*ctf_fs
)
1977 const bt_value
*value
;
1978 enum bt_param_validation_status validate_value_status
;
1979 gchar
*error
= NULL
;
1981 validate_value_status
= bt_param_validation_validate(params
, fs_params_entries_descr
, &error
);
1982 if (validate_value_status
!= BT_PARAM_VALIDATION_STATUS_OK
) {
1983 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "{}", error
);
1988 /* inputs parameter */
1989 *inputs
= bt_value_map_borrow_entry_value_const(params
, "inputs");
1991 /* clock-class-offset-s parameter */
1992 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-s");
1994 ctf_fs
->clkClsCfg
.offsetSec
= bt_value_integer_signed_get(value
);
1997 /* clock-class-offset-ns parameter */
1998 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-ns");
2000 ctf_fs
->clkClsCfg
.offsetNanoSec
= bt_value_integer_signed_get(value
);
2003 /* force-clock-class-origin-unix-epoch parameter */
2004 value
= bt_value_map_borrow_entry_value_const(params
, "force-clock-class-origin-unix-epoch");
2006 ctf_fs
->clkClsCfg
.forceOriginIsUnixEpoch
= bt_value_bool_get(value
);
2009 /* trace-name parameter */
2010 *trace_name
= bt_value_map_borrow_entry_value_const(params
, "trace-name");
2019 static ctf_fs_component::UP
ctf_fs_create(const bt_value
*params
,
2020 bt_self_component_source
*self_comp_src
)
2022 const bt_value
*inputs_value
;
2023 const bt_value
*trace_name_value
;
2024 bt_self_component
*self_comp
= bt_self_component_source_as_self_component(self_comp_src
);
2026 ctf_fs_component::UP ctf_fs
= ctf_fs_component_create(
2027 bt2c::Logger
{bt2::SelfSourceComponent
{self_comp_src
}, "PLUGIN/SRC.CTF.FS/COMP"});
2032 if (!read_src_fs_parameters(params
, &inputs_value
, &trace_name_value
, ctf_fs
.get())) {
2036 if (ctf_fs_component_create_ctf_fs_trace(ctf_fs
.get(), inputs_value
, trace_name_value
,
2041 if (create_streams_for_trace(ctf_fs
->trace
.get())) {
2045 if (create_ports_for_trace(ctf_fs
.get(), ctf_fs
->trace
.get(), self_comp_src
)) {
2052 bt_component_class_initialize_method_status
ctf_fs_init(bt_self_component_source
*self_comp_src
,
2053 bt_self_component_source_configuration
*,
2054 const bt_value
*params
, void *)
2057 bt_component_class_initialize_method_status ret
=
2058 BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
2060 ctf_fs_component::UP ctf_fs
= ctf_fs_create(params
, self_comp_src
);
2062 ret
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
2065 bt_self_component_set_data(bt_self_component_source_as_self_component(self_comp_src
),
2068 } catch (const std::bad_alloc
&) {
2069 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
2070 } catch (const bt2::Error
&) {
2071 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
2075 bt_component_class_query_method_status
ctf_fs_query(bt_self_component_class_source
*comp_class_src
,
2076 bt_private_query_executor
*priv_query_exec
,
2077 const char *object
, const bt_value
*params
,
2078 __attribute__((unused
)) void *method_data
,
2079 const bt_value
**result
)
2082 bt2c::Logger logger
{bt2::SelfComponentClass
{comp_class_src
},
2083 bt2::PrivateQueryExecutor
{priv_query_exec
},
2084 "PLUGIN/SRC.CTF.FS/QUERY"};
2085 bt2::ConstMapValue
paramsObj(params
);
2086 bt2::Value::Shared resultObj
;
2088 if (strcmp(object
, "metadata-info") == 0) {
2089 resultObj
= metadata_info_query(paramsObj
, logger
);
2090 } else if (strcmp(object
, "babeltrace.trace-infos") == 0) {
2091 resultObj
= trace_infos_query(paramsObj
, logger
);
2092 } else if (!strcmp(object
, "babeltrace.support-info")) {
2093 resultObj
= support_info_query(paramsObj
, logger
);
2095 BT_CPPLOGE_SPEC(logger
, "Unknown query object `{}`", object
);
2096 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;
2099 *result
= resultObj
.release().libObjPtr();
2101 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
2102 } catch (const std::bad_alloc
&) {
2103 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
2104 } catch (const bt2::Error
&) {
2105 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;