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 if (ctf_fs_trace
->ds_file_groups
) {
285 g_ptr_array_free(ctf_fs_trace
->ds_file_groups
, TRUE
);
288 BT_TRACE_PUT_REF_AND_RESET(ctf_fs_trace
->trace
);
290 if (ctf_fs_trace
->path
) {
291 g_string_free(ctf_fs_trace
->path
, TRUE
);
294 if (ctf_fs_trace
->metadata
) {
295 ctf_fs_metadata_fini(ctf_fs_trace
->metadata
);
296 delete ctf_fs_trace
->metadata
;
302 void ctf_fs_trace_deleter::operator()(ctf_fs_trace
* const trace
) noexcept
304 ctf_fs_trace_destroy(trace
);
307 void ctf_fs_destroy(struct ctf_fs_component
*ctf_fs
)
316 void ctf_fs_component_deleter::operator()(ctf_fs_component
*comp
)
318 ctf_fs_destroy(comp
);
321 ctf_fs_component::UP
ctf_fs_component_create(const bt2c::Logger
& parentLogger
)
323 return ctf_fs_component::UP
{new ctf_fs_component
{parentLogger
}};
326 void ctf_fs_finalize(bt_self_component_source
*component
)
328 ctf_fs_destroy((struct ctf_fs_component
*) bt_self_component_get_data(
329 bt_self_component_source_as_self_component(component
)));
332 bt2c::GCharUP
ctf_fs_make_port_name(struct ctf_fs_ds_file_group
*ds_file_group
)
334 GString
*name
= g_string_new(NULL
);
337 * The unique port name is generated by concatenating unique identifiers
345 /* For the trace, use the uuid if present, else the path. */
346 if (ds_file_group
->ctf_fs_trace
->metadata
->tc
->is_uuid_set
) {
347 char uuid_str
[BT_UUID_STR_LEN
+ 1];
349 bt_uuid_to_str(ds_file_group
->ctf_fs_trace
->metadata
->tc
->uuid
, uuid_str
);
350 g_string_assign(name
, uuid_str
);
352 g_string_assign(name
, ds_file_group
->ctf_fs_trace
->path
->str
);
356 * For the stream class, use the id if present. We can omit this field
357 * otherwise, as there will only be a single stream class.
359 if (ds_file_group
->sc
->id
!= UINT64_C(-1)) {
360 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->sc
->id
);
363 /* For the stream, use the id if present, else, use the path. */
364 if (ds_file_group
->stream_id
!= UINT64_C(-1)) {
365 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->stream_id
);
367 BT_ASSERT(ds_file_group
->ds_file_infos
->len
== 1);
368 struct ctf_fs_ds_file_info
*ds_file_info
=
369 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
370 g_string_append_printf(name
, " | %s", ds_file_info
->path
->str
);
373 return bt2c::GCharUP
{g_string_free(name
, FALSE
)};
376 static int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
377 struct ctf_fs_ds_file_group
*ds_file_group
,
378 bt_self_component_source
*self_comp_src
)
381 ctf_fs_port_data::UP port_data
;
383 bt2c::GCharUP port_name
= ctf_fs_make_port_name(ds_file_group
);
388 BT_CPPLOGI_SPEC(ctf_fs
->logger
, "Creating one port named `{}`", port_name
.get());
390 /* Create output port for this file */
391 port_data
= bt2s::make_unique
<ctf_fs_port_data
>();
392 port_data
->ctf_fs
= ctf_fs
;
393 port_data
->ds_file_group
= ds_file_group
;
394 ret
= bt_self_component_source_add_output_port(self_comp_src
, port_name
.get(), port_data
.get(),
400 ctf_fs
->port_data
.emplace_back(std::move(port_data
));
410 static int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
411 struct ctf_fs_trace
*ctf_fs_trace
,
412 bt_self_component_source
*self_comp_src
)
417 /* Create one output port for each stream file group */
418 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
419 struct ctf_fs_ds_file_group
*ds_file_group
=
420 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
422 ret
= create_one_port_for_trace(ctf_fs
, ds_file_group
, self_comp_src
);
424 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create output port.");
433 /* Replace by g_ptr_array_insert when we depend on glib >= 2.40. */
434 static void array_insert(GPtrArray
*array
, gpointer element
, size_t pos
)
436 size_t original_array_len
= array
->len
;
438 /* Allocate an unused element at the end of the array. */
439 g_ptr_array_add(array
, NULL
);
441 /* If we are not inserting at the end, move the elements by one. */
442 if (pos
< original_array_len
) {
443 memmove(&(array
->pdata
[pos
+ 1]), &(array
->pdata
[pos
]),
444 (original_array_len
- pos
) * sizeof(gpointer
));
447 /* Insert the value. */
448 array
->pdata
[pos
] = element
;
452 * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right
453 * place to keep it sorted.
456 static void ds_file_group_insert_ds_file_info_sorted(struct ctf_fs_ds_file_group
*ds_file_group
,
457 struct ctf_fs_ds_file_info
*ds_file_info
)
461 /* Find the spot where to insert this ds_file_info. */
462 for (i
= 0; i
< ds_file_group
->ds_file_infos
->len
; i
++) {
463 struct ctf_fs_ds_file_info
*other_ds_file_info
=
464 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, i
);
466 if (ds_file_info
->begin_ns
< other_ds_file_info
->begin_ns
) {
471 array_insert(ds_file_group
->ds_file_infos
, ds_file_info
, i
);
474 static bool ds_index_entries_equal(const struct ctf_fs_ds_index_entry
*left
,
475 const struct ctf_fs_ds_index_entry
*right
)
477 if (left
->packetSize
!= right
->packetSize
) {
481 if (left
->timestamp_begin
!= right
->timestamp_begin
) {
485 if (left
->timestamp_end
!= right
->timestamp_end
) {
489 if (left
->packet_seq_num
!= right
->packet_seq_num
) {
497 * Insert `entry` into `index`, without duplication.
499 * The entry is inserted only if there isn't an identical entry already.
501 * In any case, the ownership of `entry` is transferred to this function. So if
502 * the entry is not inserted, it is freed.
505 static void ds_index_insert_ds_index_entry_sorted(struct ctf_fs_ds_index
*index
,
506 struct ctf_fs_ds_index_entry
*entry
)
509 struct ctf_fs_ds_index_entry
*other_entry
= NULL
;
511 /* Find the spot where to insert this index entry. */
512 for (i
= 0; i
< index
->entries
->len
; i
++) {
513 other_entry
= (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, i
);
515 if (entry
->timestamp_begin_ns
<= other_entry
->timestamp_begin_ns
) {
521 * Insert the entry only if a duplicate doesn't already exist.
523 * There can be duplicate packets if reading multiple overlapping
524 * snapshots of the same trace. We then want the index to contain
525 * a reference to only one copy of that packet.
527 if (i
== index
->entries
->len
|| !ds_index_entries_equal(entry
, other_entry
)) {
528 array_insert(index
->entries
, entry
, i
);
534 static void merge_ctf_fs_ds_indexes(struct ctf_fs_ds_index
*dest
, struct ctf_fs_ds_index
*src
)
538 for (i
= 0; i
< src
->entries
->len
; i
++) {
539 struct ctf_fs_ds_index_entry
*entry
=
540 (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(src
->entries
, i
);
543 * Ownership of the ctf_fs_ds_index_entry is transferred to
544 * ds_index_insert_ds_index_entry_sorted.
546 g_ptr_array_index(src
->entries
, i
) = NULL
;
547 ds_index_insert_ds_index_entry_sorted(dest
, entry
);
551 static int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
, const char *path
)
553 int64_t stream_instance_id
= -1;
554 int64_t begin_ns
= -1;
555 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
556 bool add_group
= false;
559 struct ctf_fs_ds_file
*ds_file
= NULL
;
560 struct ctf_fs_ds_file_info
*ds_file_info
= NULL
;
561 struct ctf_fs_ds_index
*index
= NULL
;
562 struct ctf_msg_iter
*msg_iter
= NULL
;
563 struct ctf_stream_class
*sc
= NULL
;
564 struct ctf_msg_iter_packet_properties props
;
567 * Create a temporary ds_file to read some properties about the data
570 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, path
, ctf_fs_trace
->logger
);
575 /* Create a temporary iterator to read the ds_file. */
576 msg_iter
= ctf_msg_iter_create(
577 ctf_fs_trace
->metadata
->tc
,
578 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
579 ctf_fs_ds_file_medops
, ds_file
, nullptr, ctf_fs_trace
->logger
);
581 BT_CPPLOGE_STR_SPEC(ctf_fs_trace
->logger
, "Cannot create a CTF message iterator.");
585 ctf_msg_iter_set_dry_run(msg_iter
, true);
587 ret
= ctf_msg_iter_get_packet_properties(msg_iter
, &props
);
589 BT_CPPLOGE_APPEND_CAUSE_SPEC(
590 ctf_fs_trace
->logger
,
591 "Cannot get stream file's first packet's header and context fields (`{}`).", path
);
595 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
, props
.stream_class_id
);
597 stream_instance_id
= props
.data_stream_id
;
599 if (props
.snapshots
.beginning_clock
!= UINT64_C(-1)) {
600 BT_ASSERT(sc
->default_clock_class
);
601 ret
= bt_util_clock_cycles_to_ns_from_origin(
602 props
.snapshots
.beginning_clock
, sc
->default_clock_class
->frequency
,
603 sc
->default_clock_class
->offset_seconds
, sc
->default_clock_class
->offset_cycles
,
606 BT_CPPLOGE_APPEND_CAUSE_SPEC(
607 ctf_fs_trace
->logger
,
608 "Cannot convert clock cycles to nanoseconds from origin (`{}`).", path
);
613 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
);
618 index
= ctf_fs_ds_file_build_index(ds_file
, ds_file_info
, msg_iter
);
620 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to index CTF stream file \'{}\'",
621 ds_file
->file
->path
->str
);
625 if (begin_ns
== -1) {
627 * No beginning timestamp to sort the stream files
628 * within a stream file group, so consider that this
629 * file must be the only one within its group.
631 stream_instance_id
= -1;
634 if (stream_instance_id
== -1) {
636 * No stream instance ID or no beginning timestamp:
637 * create a unique stream file group for this stream
638 * file because, even if there's a stream instance ID,
639 * there's no timestamp to order the file within its
642 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, UINT64_C(-1), index
);
643 /* Ownership of index is transferred. */
646 if (!ds_file_group
) {
650 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, BT_MOVE_REF(ds_file_info
));
656 BT_ASSERT(stream_instance_id
!= -1);
657 BT_ASSERT(begin_ns
!= -1);
659 /* Find an existing stream file group with this ID */
660 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
662 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
664 if (ds_file_group
->sc
== sc
&& ds_file_group
->stream_id
== stream_instance_id
) {
668 ds_file_group
= NULL
;
671 if (!ds_file_group
) {
672 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, stream_instance_id
, index
);
673 /* Ownership of index is transferred. */
675 if (!ds_file_group
) {
681 merge_ctf_fs_ds_indexes(ds_file_group
->index
, index
);
684 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, BT_MOVE_REF(ds_file_info
));
689 ctf_fs_ds_file_group_destroy(ds_file_group
);
690 ds_file_group
= NULL
;
694 if (add_group
&& ds_file_group
) {
695 g_ptr_array_add(ctf_fs_trace
->ds_file_groups
, ds_file_group
);
698 ctf_fs_ds_file_destroy(ds_file
);
699 ctf_fs_ds_file_info_destroy(ds_file_info
);
702 ctf_msg_iter_destroy(msg_iter
);
705 ctf_fs_ds_index_destroy(index
);
709 static int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
712 const char *basename
;
713 GError
*error
= NULL
;
716 /* Check each file in the path directory, except specific ones */
717 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
719 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
720 "Cannot open directory `{}`: {} (code {})",
721 ctf_fs_trace
->path
->str
, error
->message
, error
->code
);
725 while ((basename
= g_dir_read_name(dir
))) {
726 struct ctf_fs_file
*file
;
728 if (strcmp(basename
, CTF_FS_METADATA_FILENAME
) == 0) {
729 /* Ignore the metadata stream. */
730 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
731 "Ignoring metadata file `{}" G_DIR_SEPARATOR_S
"{}`",
732 ctf_fs_trace
->path
->str
, basename
);
736 if (basename
[0] == '.') {
737 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
738 "Ignoring hidden file `{}" G_DIR_SEPARATOR_S
"{}`",
739 ctf_fs_trace
->path
->str
, basename
);
743 /* Create the file. */
744 file
= ctf_fs_file_create(ctf_fs_trace
->logger
);
746 BT_CPPLOGE_APPEND_CAUSE_SPEC(
747 ctf_fs_trace
->logger
,
748 "Cannot create stream file object for file `{}" G_DIR_SEPARATOR_S
"{}`",
749 ctf_fs_trace
->path
->str
, basename
);
753 /* Create full path string. */
754 g_string_append_printf(file
->path
, "%s" G_DIR_SEPARATOR_S
"%s", ctf_fs_trace
->path
->str
,
756 if (!g_file_test(file
->path
->str
, G_FILE_TEST_IS_REGULAR
)) {
757 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring non-regular file `{}`",
759 ctf_fs_file_destroy(file
);
764 ret
= ctf_fs_file_open(file
, "rb");
766 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Cannot open stream file `{}`",
771 if (file
->size
== 0) {
772 /* Skip empty stream. */
773 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring empty file `{}`", file
->path
->str
);
774 ctf_fs_file_destroy(file
);
778 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
, file
->path
->str
);
780 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
781 "Cannot add stream file `{}` to stream file group",
783 ctf_fs_file_destroy(file
);
787 ctf_fs_file_destroy(file
);
808 static int set_trace_name(bt_trace
*trace
, const char *name_suffix
, const bt2c::Logger
& logger
)
814 name
= g_string_new(NULL
);
816 BT_CPPLOGE_STR_SPEC(logger
, "Failed to allocate a GString.");
822 * Check if we have a trace environment string value named `hostname`.
823 * If so, use it as the trace name's prefix.
825 val
= bt_trace_borrow_environment_entry_value_by_name_const(trace
, "hostname");
826 if (val
&& bt_value_is_string(val
)) {
827 g_string_append(name
, bt_value_string_get(val
));
830 g_string_append_c(name
, G_DIR_SEPARATOR
);
835 g_string_append(name
, name_suffix
);
838 ret
= bt_trace_set_name(trace
, name
->str
);
847 g_string_free(name
, TRUE
);
853 static ctf_fs_trace::UP
ctf_fs_trace_create(const char *path
, const char *name
,
854 const ctf::src::ClkClsCfg
& clkClsCfg
,
855 bt_self_component
*selfComp
,
856 const bt2c::Logger
& parentLogger
)
860 ctf_fs_trace::UP ctf_fs_trace
{new struct ctf_fs_trace(parentLogger
)};
861 ctf_fs_trace
->path
= g_string_new(path
);
862 if (!ctf_fs_trace
->path
) {
866 ctf_fs_trace
->metadata
= new ctf_fs_metadata
;
867 ctf_fs_metadata_init(ctf_fs_trace
->metadata
);
868 ctf_fs_trace
->ds_file_groups
=
869 g_ptr_array_new_with_free_func((GDestroyNotify
) ctf_fs_ds_file_group_destroy
);
870 if (!ctf_fs_trace
->ds_file_groups
) {
874 ret
= ctf_fs_metadata_set_trace_class(selfComp
, ctf_fs_trace
.get(), clkClsCfg
);
879 if (ctf_fs_trace
->metadata
->trace_class
) {
880 ctf_fs_trace
->trace
= bt_trace_create(ctf_fs_trace
->metadata
->trace_class
);
881 if (!ctf_fs_trace
->trace
) {
886 if (ctf_fs_trace
->trace
) {
887 ret
= ctf_trace_class_configure_ir_trace(ctf_fs_trace
->metadata
->tc
, ctf_fs_trace
->trace
);
892 ret
= set_trace_name(ctf_fs_trace
->trace
, name
, ctf_fs_trace
->logger
);
898 ret
= create_ds_file_groups(ctf_fs_trace
.get());
906 ctf_fs_trace
.reset();
912 static int path_is_ctf_trace(const char *path
)
914 GString
*metadata_path
= g_string_new(NULL
);
917 if (!metadata_path
) {
922 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
924 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
930 g_string_free(metadata_path
, TRUE
);
934 /* Helper for ctf_fs_component_create_ctf_fs_trace, to handle a single path. */
936 static int ctf_fs_component_create_ctf_fs_trace_one_path(struct ctf_fs_component
*ctf_fs
,
937 const char *path_param
,
938 const char *trace_name
,
939 std::vector
<ctf_fs_trace::UP
>& traces
,
940 bt_self_component
*selfComp
)
942 ctf_fs_trace::UP ctf_fs_trace
;
946 norm_path
= bt_common_normalize_path(path_param
, NULL
);
948 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to normalize path: `{}`.", path_param
);
952 ret
= path_is_ctf_trace(norm_path
->str
);
954 BT_CPPLOGE_APPEND_CAUSE_SPEC(
955 ctf_fs
->logger
, "Failed to check if path is a CTF trace: path={}", norm_path
->str
);
957 } else if (ret
== 0) {
958 BT_CPPLOGE_APPEND_CAUSE_SPEC(
959 ctf_fs
->logger
, "Path is not a CTF trace (does not contain a metadata file): `{}`.",
964 // FIXME: Remove or ifdef for __MINGW32__
965 if (strcmp(norm_path
->str
, "/") == 0) {
966 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Opening a trace in `/` is not supported.");
971 ctf_fs_trace
= ctf_fs_trace_create(norm_path
->str
, trace_name
, ctf_fs
->clkClsCfg
, selfComp
,
974 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create trace for `{}`.",
979 traces
.emplace_back(std::move(ctf_fs_trace
));
989 g_string_free(norm_path
, TRUE
);
996 * Count the number of stream and event classes defined by this trace's metadata.
998 * This is used to determine which metadata is the "latest", out of multiple
999 * traces sharing the same UUID. It is assumed that amongst all these metadatas,
1000 * a bigger metadata is a superset of a smaller metadata. Therefore, it is
1001 * enough to just count the classes.
1004 static unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace
*trace
)
1006 unsigned int num
= trace
->metadata
->tc
->stream_classes
->len
;
1009 for (i
= 0; i
< trace
->metadata
->tc
->stream_classes
->len
; i
++) {
1010 struct ctf_stream_class
*sc
=
1011 (struct ctf_stream_class
*) trace
->metadata
->tc
->stream_classes
->pdata
[i
];
1012 num
+= sc
->event_classes
->len
;
1019 * Merge the src ds_file_group into dest. This consists of merging their
1020 * ds_file_infos, making sure to keep the result sorted.
1023 static void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group
*dest
,
1024 struct ctf_fs_ds_file_group
*src
)
1028 for (i
= 0; i
< src
->ds_file_infos
->len
; i
++) {
1029 struct ctf_fs_ds_file_info
*ds_file_info
=
1030 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(src
->ds_file_infos
, i
);
1032 /* Ownership of the ds_file_info is transferred to dest. */
1033 g_ptr_array_index(src
->ds_file_infos
, i
) = NULL
;
1035 ds_file_group_insert_ds_file_info_sorted(dest
, ds_file_info
);
1038 /* Merge both indexes. */
1039 merge_ctf_fs_ds_indexes(dest
->index
, src
->index
);
1042 /* Merge src_trace's data stream file groups into dest_trace's. */
1044 static int merge_matching_ctf_fs_ds_file_groups(struct ctf_fs_trace
*dest_trace
,
1045 ctf_fs_trace::UP src_trace
)
1047 GPtrArray
*dest
= dest_trace
->ds_file_groups
;
1048 GPtrArray
*src
= src_trace
->ds_file_groups
;
1053 * Save the initial length of dest: we only want to check against the
1054 * original elements in the inner loop.
1056 const guint dest_len
= dest
->len
;
1058 for (s_i
= 0; s_i
< src
->len
; s_i
++) {
1059 struct ctf_fs_ds_file_group
*src_group
=
1060 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(src
, s_i
);
1061 struct ctf_fs_ds_file_group
*dest_group
= NULL
;
1063 /* A stream instance without ID can't match a stream in the other trace. */
1064 if (src_group
->stream_id
!= -1) {
1067 /* Let's search for a matching ds_file_group in the destination. */
1068 for (d_i
= 0; d_i
< dest_len
; d_i
++) {
1069 struct ctf_fs_ds_file_group
*candidate_dest
=
1070 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(dest
, d_i
);
1072 /* Can't match a stream instance without ID. */
1073 if (candidate_dest
->stream_id
== -1) {
1078 * If the two groups have the same stream instance id
1079 * and belong to the same stream class (stream instance
1080 * ids are per-stream class), they represent the same
1083 if (candidate_dest
->stream_id
!= src_group
->stream_id
||
1084 candidate_dest
->sc
->id
!= src_group
->sc
->id
) {
1088 dest_group
= candidate_dest
;
1094 * Didn't find a friend in dest to merge our src_group into?
1095 * Create a new empty one. This can happen if a stream was
1096 * active in the source trace chunk but not in the destination
1100 struct ctf_stream_class
*sc
;
1101 struct ctf_fs_ds_index
*index
;
1103 sc
= ctf_trace_class_borrow_stream_class_by_id(dest_trace
->metadata
->tc
,
1107 index
= ctf_fs_ds_index_create(dest_trace
->logger
);
1113 dest_group
= ctf_fs_ds_file_group_create(dest_trace
, sc
, src_group
->stream_id
, index
);
1114 /* Ownership of index is transferred. */
1121 g_ptr_array_add(dest_trace
->ds_file_groups
, dest_group
);
1124 BT_ASSERT(dest_group
);
1125 merge_ctf_fs_ds_file_groups(dest_group
, src_group
);
1133 * Collapse the given traces, which must all share the same UUID, in a single
1136 * The trace with the most expansive metadata is chosen and all other traces
1137 * are merged into that one. On return, the elements of `traces` are nullptr
1138 * and the merged trace is placed in `out_trace`.
1141 static int merge_ctf_fs_traces(std::vector
<ctf_fs_trace::UP
> traces
, ctf_fs_trace::UP
& out_trace
)
1143 unsigned int winner_count
;
1144 struct ctf_fs_trace
*winner
;
1148 BT_ASSERT(traces
.size() >= 2);
1150 winner_count
= metadata_count_stream_and_event_classes(traces
[0].get());
1151 winner
= traces
[0].get();
1154 /* Find the trace with the largest metadata. */
1155 for (i
= 1; i
< traces
.size(); i
++) {
1156 ctf_fs_trace
*candidate
= traces
[i
].get();
1157 unsigned int candidate_count
;
1159 /* A bit of sanity check. */
1160 BT_ASSERT(bt_uuid_compare(winner
->metadata
->tc
->uuid
, candidate
->metadata
->tc
->uuid
) == 0);
1162 candidate_count
= metadata_count_stream_and_event_classes(candidate
);
1164 if (candidate_count
> winner_count
) {
1165 winner_count
= candidate_count
;
1171 /* Merge all the other traces in the winning trace. */
1172 for (ctf_fs_trace::UP
& trace
: traces
) {
1173 /* Don't merge the winner into itself. */
1174 if (trace
.get() == winner
) {
1178 /* Merge trace's data stream file groups into winner's. */
1179 ret
= merge_matching_ctf_fs_ds_file_groups(winner
, std::move(trace
));
1186 * Move the winner out of the array, into `*out_trace`.
1188 out_trace
= std::move(traces
[winner_i
]);
1200 static int decode_clock_snapshot_after_event(struct ctf_fs_trace
*ctf_fs_trace
,
1201 struct ctf_clock_class
*default_cc
,
1202 struct ctf_fs_ds_index_entry
*index_entry
,
1203 enum target_event target_event
, uint64_t *cs
,
1206 enum ctf_msg_iter_status iter_status
= CTF_MSG_ITER_STATUS_OK
;
1207 struct ctf_fs_ds_file
*ds_file
= NULL
;
1208 struct ctf_msg_iter
*msg_iter
= NULL
;
1211 BT_ASSERT(ctf_fs_trace
);
1212 BT_ASSERT(index_entry
);
1213 BT_ASSERT(index_entry
->path
);
1215 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, index_entry
->path
, ctf_fs_trace
->logger
);
1217 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to create a ctf_fs_ds_file");
1222 BT_ASSERT(ctf_fs_trace
->metadata
);
1223 BT_ASSERT(ctf_fs_trace
->metadata
->tc
);
1225 msg_iter
= ctf_msg_iter_create(
1226 ctf_fs_trace
->metadata
->tc
,
1227 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
1228 ctf_fs_ds_file_medops
, ds_file
, NULL
, ctf_fs_trace
->logger
);
1230 /* ctf_msg_iter_create() logs errors. */
1236 * Turn on dry run mode to prevent the creation and usage of Babeltrace
1237 * library objects (bt_field, bt_message_*, etc.).
1239 ctf_msg_iter_set_dry_run(msg_iter
, true);
1241 /* Seek to the beginning of the target packet. */
1242 iter_status
= ctf_msg_iter_seek(msg_iter
, index_entry
->offset
.bytes());
1244 /* ctf_msg_iter_seek() logs errors. */
1249 switch (target_event
) {
1252 * Start to decode the packet until we reach the end of
1253 * the first event. To extract the first event's clock
1256 iter_status
= ctf_msg_iter_curr_packet_first_event_clock_snapshot(msg_iter
, cs
);
1259 /* Decode the packet to extract the last event's clock snapshot. */
1260 iter_status
= ctf_msg_iter_curr_packet_last_event_clock_snapshot(msg_iter
, cs
);
1270 /* Convert clock snapshot to timestamp. */
1271 ret
= bt_util_clock_cycles_to_ns_from_origin(
1272 *cs
, default_cc
->frequency
, default_cc
->offset_seconds
, default_cc
->offset_cycles
, ts_ns
);
1274 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1275 "Failed to convert clock snapshot to timestamp");
1281 ctf_fs_ds_file_destroy(ds_file
);
1284 ctf_msg_iter_destroy(msg_iter
);
1290 static int decode_packet_first_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1291 struct ctf_clock_class
*default_cc
,
1292 struct ctf_fs_ds_index_entry
*index_entry
,
1293 uint64_t *cs
, int64_t *ts_ns
)
1295 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, FIRST_EVENT
, cs
,
1299 static int decode_packet_last_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1300 struct ctf_clock_class
*default_cc
,
1301 struct ctf_fs_ds_index_entry
*index_entry
,
1302 uint64_t *cs
, int64_t *ts_ns
)
1304 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, LAST_EVENT
, cs
,
1309 * Fix up packet index entries for lttng's "event-after-packet" bug.
1310 * Some buggy lttng tracer versions may emit events with a timestamp that is
1311 * larger (after) than the timestamp_end of the their packets.
1313 * To fix up this erroneous data we do the following:
1314 * 1. If it's not the stream file's last packet: set the packet index entry's
1315 * end time to the next packet's beginning time.
1316 * 2. If it's the stream file's last packet, set the packet index entry's end
1317 * time to the packet's last event's time, if any, or to the packet's
1318 * beginning time otherwise.
1320 * Known buggy tracer versions:
1321 * - before lttng-ust 2.11.0
1322 * - before lttng-module 2.11.0
1323 * - before lttng-module 2.10.10
1324 * - before lttng-module 2.9.13
1326 static int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace
*trace
)
1329 guint ds_file_group_i
;
1330 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1332 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
; ds_file_group_i
++) {
1334 struct ctf_clock_class
*default_cc
;
1335 struct ctf_fs_ds_index_entry
*last_entry
;
1336 struct ctf_fs_ds_index
*index
;
1338 struct ctf_fs_ds_file_group
*ds_file_group
=
1339 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1341 BT_ASSERT(ds_file_group
);
1342 index
= ds_file_group
->index
;
1345 BT_ASSERT(index
->entries
);
1346 BT_ASSERT(index
->entries
->len
> 0);
1349 * Iterate over all entries but the last one. The last one is
1350 * fixed differently after.
1352 for (entry_i
= 0; entry_i
< index
->entries
->len
- 1; entry_i
++) {
1353 struct ctf_fs_ds_index_entry
*curr_entry
, *next_entry
;
1355 curr_entry
= (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
);
1356 next_entry
= (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
+ 1);
1359 * 1. Set the current index entry `end` timestamp to
1360 * the next index entry `begin` timestamp.
1362 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1363 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1367 * 2. Fix the last entry by decoding the last event of the last
1371 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, index
->entries
->len
- 1);
1372 BT_ASSERT(last_entry
);
1374 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1375 default_cc
= ds_file_group
->sc
->default_clock_class
;
1378 * Decode packet to read the timestamp of the last event of the
1381 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1382 &last_entry
->timestamp_end
,
1383 &last_entry
->timestamp_end_ns
);
1385 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1387 "Failed to decode stream's last packet to get its last event's clock snapshot.");
1397 * Fix up packet index entries for barectf's "event-before-packet" bug.
1398 * Some buggy barectf tracer versions may emit events with a timestamp that is
1399 * less than the timestamp_begin of the their packets.
1401 * To fix up this erroneous data we do the following:
1402 * 1. Starting at the second index entry, set the timestamp_begin of the
1403 * current entry to the timestamp of the first event of the packet.
1404 * 2. Set the previous entry's timestamp_end to the timestamp_begin of the
1407 * Known buggy tracer versions:
1408 * - before barectf 2.3.1
1410 static int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace
*trace
)
1413 guint ds_file_group_i
;
1414 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1416 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
; ds_file_group_i
++) {
1418 struct ctf_clock_class
*default_cc
;
1419 ctf_fs_ds_file_group
*ds_file_group
=
1420 (ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1422 struct ctf_fs_ds_index
*index
= ds_file_group
->index
;
1425 BT_ASSERT(index
->entries
);
1426 BT_ASSERT(index
->entries
->len
> 0);
1428 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1429 default_cc
= ds_file_group
->sc
->default_clock_class
;
1432 * 1. Iterate over the index, starting from the second entry
1435 for (entry_i
= 1; entry_i
< index
->entries
->len
; entry_i
++) {
1436 ctf_fs_ds_index_entry
*prev_entry
=
1437 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
- 1);
1438 ctf_fs_ds_index_entry
*curr_entry
=
1439 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
);
1441 * 2. Set the current entry `begin` timestamp to the
1442 * timestamp of the first event of the current packet.
1444 ret
= decode_packet_first_event_timestamp(trace
, default_cc
, curr_entry
,
1445 &curr_entry
->timestamp_begin
,
1446 &curr_entry
->timestamp_begin_ns
);
1448 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1449 "Failed to decode first event's clock snapshot");
1454 * 3. Set the previous entry `end` timestamp to the
1455 * timestamp of the first event of the current packet.
1457 prev_entry
->timestamp_end
= curr_entry
->timestamp_begin
;
1458 prev_entry
->timestamp_end_ns
= curr_entry
->timestamp_begin_ns
;
1466 * When using the lttng-crash feature it's likely that the last packets of each
1467 * stream have their timestamp_end set to zero. This is caused by the fact that
1468 * the tracer crashed and was not able to properly close the packets.
1470 * To fix up this erroneous data we do the following:
1471 * For each index entry, if the entry's timestamp_end is 0 and the
1472 * timestamp_begin is not 0:
1473 * - If it's the stream file's last packet: set the packet index entry's end
1474 * time to the packet's last event's time, if any, or to the packet's
1475 * beginning time otherwise.
1476 * - If it's not the stream file's last packet: set the packet index
1477 * entry's end time to the next packet's beginning time.
1479 * Affected versions:
1480 * - All current and future lttng-ust and lttng-modules versions.
1482 static int fix_index_lttng_crash_quirk(struct ctf_fs_trace
*trace
)
1485 guint ds_file_group_idx
;
1486 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1488 for (ds_file_group_idx
= 0; ds_file_group_idx
< ds_file_groups
->len
; ds_file_group_idx
++) {
1490 struct ctf_clock_class
*default_cc
;
1491 struct ctf_fs_ds_index
*index
;
1493 ctf_fs_ds_file_group
*ds_file_group
=
1494 (ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_idx
);
1496 BT_ASSERT(ds_file_group
);
1497 index
= ds_file_group
->index
;
1499 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1500 default_cc
= ds_file_group
->sc
->default_clock_class
;
1503 BT_ASSERT(index
->entries
);
1504 BT_ASSERT(index
->entries
->len
> 0);
1506 ctf_fs_ds_index_entry
*last_entry
=
1507 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, index
->entries
->len
- 1);
1508 BT_ASSERT(last_entry
);
1510 /* 1. Fix the last entry first. */
1511 if (last_entry
->timestamp_end
== 0 && last_entry
->timestamp_begin
!= 0) {
1513 * Decode packet to read the timestamp of the
1514 * last event of the stream file.
1516 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1517 &last_entry
->timestamp_end
,
1518 &last_entry
->timestamp_end_ns
);
1520 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1521 "Failed to decode last event's clock snapshot");
1526 /* Iterate over all entries but the last one. */
1527 for (entry_idx
= 0; entry_idx
< index
->entries
->len
- 1; entry_idx
++) {
1528 ctf_fs_ds_index_entry
*curr_entry
=
1529 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_idx
);
1530 ctf_fs_ds_index_entry
*next_entry
=
1531 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_idx
+ 1);
1533 if (curr_entry
->timestamp_end
== 0 && curr_entry
->timestamp_begin
!= 0) {
1535 * 2. Set the current index entry `end` timestamp to
1536 * the next index entry `begin` timestamp.
1538 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1539 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1549 * Extract the tracer information necessary to compare versions.
1550 * Returns 0 on success, and -1 if the extraction is not successful because the
1551 * necessary fields are absents in the trace metadata.
1553 static int extract_tracer_info(struct ctf_fs_trace
*trace
, struct tracer_info
*current_tracer_info
)
1556 struct ctf_trace_class_env_entry
*entry
;
1558 /* Clear the current_tracer_info struct */
1559 memset(current_tracer_info
, 0, sizeof(*current_tracer_info
));
1562 * To compare 2 tracer versions, at least the tracer name and it's
1563 * major version are needed. If one of these is missing, consider it an
1564 * extraction failure.
1566 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_name");
1567 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR
) {
1568 goto missing_bare_minimum
;
1571 /* Set tracer name. */
1572 current_tracer_info
->name
= entry
->value
.str
->str
;
1574 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_major");
1575 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1576 goto missing_bare_minimum
;
1579 /* Set major version number. */
1580 current_tracer_info
->major
= entry
->value
.i
;
1582 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_minor");
1583 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1587 /* Set minor version number. */
1588 current_tracer_info
->minor
= entry
->value
.i
;
1590 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patch");
1593 * If `tracer_patch` doesn't exist `tracer_patchlevel` might.
1594 * For example, `lttng-modules` uses entry name
1595 * `tracer_patchlevel`.
1597 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patchlevel");
1600 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1604 /* Set patch version number. */
1605 current_tracer_info
->patch
= entry
->value
.i
;
1609 missing_bare_minimum
:
1615 static bool is_tracer_affected_by_lttng_event_after_packet_bug(struct tracer_info
*curr_tracer_info
)
1617 bool is_affected
= false;
1619 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1620 if (curr_tracer_info
->major
< 2) {
1622 } else if (curr_tracer_info
->major
== 2) {
1623 /* fixed in lttng-ust 2.11.0 */
1624 if (curr_tracer_info
->minor
< 11) {
1628 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1629 if (curr_tracer_info
->major
< 2) {
1631 } else if (curr_tracer_info
->major
== 2) {
1632 /* fixed in lttng-modules 2.11.0 */
1633 if (curr_tracer_info
->minor
== 10) {
1634 /* fixed in lttng-modules 2.10.10 */
1635 if (curr_tracer_info
->patch
< 10) {
1638 } else if (curr_tracer_info
->minor
== 9) {
1639 /* fixed in lttng-modules 2.9.13 */
1640 if (curr_tracer_info
->patch
< 13) {
1643 } else if (curr_tracer_info
->minor
< 9) {
1653 is_tracer_affected_by_barectf_event_before_packet_bug(struct tracer_info
*curr_tracer_info
)
1655 bool is_affected
= false;
1657 if (strcmp(curr_tracer_info
->name
, "barectf") == 0) {
1658 if (curr_tracer_info
->major
< 2) {
1660 } else if (curr_tracer_info
->major
== 2) {
1661 if (curr_tracer_info
->minor
< 3) {
1663 } else if (curr_tracer_info
->minor
== 3) {
1664 /* fixed in barectf 2.3.1 */
1665 if (curr_tracer_info
->patch
< 1) {
1675 static bool is_tracer_affected_by_lttng_crash_quirk(struct tracer_info
*curr_tracer_info
)
1677 bool is_affected
= false;
1679 /* All LTTng tracer may be affected by this lttng crash quirk. */
1680 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1682 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1690 * Looks for trace produced by known buggy tracers and fix up the index
1693 static int fix_packet_index_tracer_bugs(ctf_fs_trace
*trace
)
1696 struct tracer_info current_tracer_info
;
1698 ret
= extract_tracer_info(trace
, ¤t_tracer_info
);
1701 * A trace may not have all the necessary environment
1702 * entries to do the tracer version comparison.
1703 * At least, the tracer name and major version number
1704 * are needed. Failing to extract these entries is not
1708 BT_CPPLOGI_STR_SPEC(
1710 "Cannot extract tracer information necessary to compare with buggy versions.");
1714 /* Check if the trace may be affected by old tracer bugs. */
1715 if (is_tracer_affected_by_lttng_event_after_packet_bug(¤t_tracer_info
)) {
1716 BT_CPPLOGI_STR_SPEC(
1718 "Trace may be affected by LTTng tracer packet timestamp bug. Fixing up.");
1719 ret
= fix_index_lttng_event_after_packet_bug(trace
);
1721 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1722 "Failed to fix LTTng event-after-packet bug.");
1725 trace
->metadata
->tc
->quirks
.lttng_event_after_packet
= true;
1728 if (is_tracer_affected_by_barectf_event_before_packet_bug(¤t_tracer_info
)) {
1729 BT_CPPLOGI_STR_SPEC(
1731 "Trace may be affected by barectf tracer packet timestamp bug. Fixing up.");
1732 ret
= fix_index_barectf_event_before_packet_bug(trace
);
1734 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1735 "Failed to fix barectf event-before-packet bug.");
1738 trace
->metadata
->tc
->quirks
.barectf_event_before_packet
= true;
1741 if (is_tracer_affected_by_lttng_crash_quirk(¤t_tracer_info
)) {
1742 ret
= fix_index_lttng_crash_quirk(trace
);
1744 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1745 "Failed to fix lttng-crash timestamp quirks.");
1748 trace
->metadata
->tc
->quirks
.lttng_crash
= true;
1755 static gint
compare_ds_file_groups_by_first_path(gconstpointer a
, gconstpointer b
)
1757 ctf_fs_ds_file_group
* const *ds_file_group_a
= (ctf_fs_ds_file_group
**) a
;
1758 ctf_fs_ds_file_group
* const *ds_file_group_b
= (ctf_fs_ds_file_group
**) b
;
1760 BT_ASSERT((*ds_file_group_a
)->ds_file_infos
->len
> 0);
1761 BT_ASSERT((*ds_file_group_b
)->ds_file_infos
->len
> 0);
1763 const ctf_fs_ds_file_info
*first_ds_file_info_a
=
1764 (const ctf_fs_ds_file_info
*) (*ds_file_group_a
)->ds_file_infos
->pdata
[0];
1765 const ctf_fs_ds_file_info
*first_ds_file_info_b
=
1766 (const ctf_fs_ds_file_info
*) (*ds_file_group_b
)->ds_file_infos
->pdata
[0];
1768 return strcmp(first_ds_file_info_a
->path
->str
, first_ds_file_info_b
->path
->str
);
1771 static gint
compare_strings(gconstpointer p_a
, gconstpointer p_b
)
1773 const char *a
= *((const char **) p_a
);
1774 const char *b
= *((const char **) p_b
);
1776 return strcmp(a
, b
);
1779 int ctf_fs_component_create_ctf_fs_trace(struct ctf_fs_component
*ctf_fs
,
1780 const bt_value
*paths_value
,
1781 const bt_value
*trace_name_value
,
1782 bt_self_component
*selfComp
)
1786 GPtrArray
*paths
= NULL
;
1787 std::vector
<ctf_fs_trace::UP
> traces
;
1788 const char *trace_name
;
1790 BT_ASSERT(bt_value_get_type(paths_value
) == BT_VALUE_TYPE_ARRAY
);
1791 BT_ASSERT(!bt_value_array_is_empty(paths_value
));
1793 paths
= g_ptr_array_new_with_free_func(g_free
);
1795 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to allocate a GPtrArray.");
1799 trace_name
= trace_name_value
? bt_value_string_get(trace_name_value
) : NULL
;
1802 * Create a sorted array of the paths, to make the execution of this
1803 * component deterministic.
1805 for (i
= 0; i
< bt_value_array_get_length(paths_value
); i
++) {
1806 const bt_value
*path_value
= bt_value_array_borrow_element_by_index_const(paths_value
, i
);
1807 const char *input
= bt_value_string_get(path_value
);
1810 input_copy
= g_strdup(input
);
1812 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to copy a string.");
1816 g_ptr_array_add(paths
, input_copy
);
1819 g_ptr_array_sort(paths
, compare_strings
);
1821 /* Create a separate ctf_fs_trace object for each path. */
1822 for (i
= 0; i
< paths
->len
; i
++) {
1823 const char *path
= (const char *) g_ptr_array_index(paths
, i
);
1825 ret
= ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs
, path
, trace_name
, traces
,
1832 if (traces
.size() > 1) {
1833 ctf_fs_trace
*first_trace
= traces
[0].get();
1834 const uint8_t *first_trace_uuid
= first_trace
->metadata
->tc
->uuid
;
1837 * We have more than one trace, they must all share the same
1838 * UUID, verify that.
1840 for (i
= 0; i
< traces
.size(); i
++) {
1841 ctf_fs_trace
*this_trace
= traces
[i
].get();
1842 const uint8_t *this_trace_uuid
= this_trace
->metadata
->tc
->uuid
;
1844 if (!this_trace
->metadata
->tc
->is_uuid_set
) {
1845 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1847 "Multiple traces given, but a trace does not have a UUID: path={}",
1848 this_trace
->path
->str
);
1852 if (bt_uuid_compare(first_trace_uuid
, this_trace_uuid
) != 0) {
1853 char first_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1854 char this_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1856 bt_uuid_to_str(first_trace_uuid
, first_trace_uuid_str
);
1857 bt_uuid_to_str(this_trace_uuid
, this_trace_uuid_str
);
1859 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1860 "Multiple traces given, but UUIDs don't match: "
1861 "first-trace-uuid={}, first-trace-path={}, "
1862 "trace-uuid={}, trace-path={}",
1863 first_trace_uuid_str
, first_trace
->path
->str
,
1864 this_trace_uuid_str
, this_trace
->path
->str
);
1869 ret
= merge_ctf_fs_traces(std::move(traces
), ctf_fs
->trace
);
1871 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1872 "Failed to merge traces with the same UUID.");
1876 /* Just one trace, it may or may not have a UUID, both are fine. */
1877 ctf_fs
->trace
= std::move(traces
[0]);
1880 ret
= fix_packet_index_tracer_bugs(ctf_fs
->trace
.get());
1882 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to fix packet index tracer bugs.");
1886 * Sort data stream file groups by first data stream file info
1887 * path to get a deterministic order. This order influences the
1888 * order of the output ports. It also influences the order of
1889 * the automatic stream IDs if the trace's packet headers do not
1890 * contain a `stream_instance_id` field, in which case the data
1891 * stream file to stream ID association is always the same,
1892 * whatever the build and the system.
1894 * Having a deterministic order here can help debugging and
1897 g_ptr_array_sort(ctf_fs
->trace
->ds_file_groups
, compare_ds_file_groups_by_first_path
);
1904 g_ptr_array_free(paths
, TRUE
);
1910 static GString
*get_stream_instance_unique_name(struct ctf_fs_ds_file_group
*ds_file_group
)
1913 struct ctf_fs_ds_file_info
*ds_file_info
;
1915 name
= g_string_new(NULL
);
1921 * If there's more than one stream file in the stream file
1922 * group, the first (earliest) stream file's path is used as
1923 * the stream's unique name.
1925 BT_ASSERT(ds_file_group
->ds_file_infos
->len
> 0);
1926 ds_file_info
= (ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
1927 g_string_assign(name
, ds_file_info
->path
->str
);
1933 /* Create the IR stream objects for ctf_fs_trace. */
1935 static int create_streams_for_trace(struct ctf_fs_trace
*ctf_fs_trace
)
1938 GString
*name
= NULL
;
1941 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
1942 ctf_fs_ds_file_group
*ds_file_group
=
1943 (ctf_fs_ds_file_group
*) g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
1944 name
= get_stream_instance_unique_name(ds_file_group
);
1950 BT_ASSERT(ds_file_group
->sc
->ir_sc
);
1951 BT_ASSERT(ctf_fs_trace
->trace
);
1953 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
1954 /* No stream ID: use 0 */
1955 ds_file_group
->stream
= bt_stream_create_with_id(
1956 ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
, ctf_fs_trace
->next_stream_id
);
1957 ctf_fs_trace
->next_stream_id
++;
1959 /* Specific stream ID */
1960 ds_file_group
->stream
= bt_stream_create_with_id(
1961 ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
, (uint64_t) ds_file_group
->stream_id
);
1964 if (!ds_file_group
->stream
) {
1965 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1966 "Cannot create stream for DS file group: "
1967 "addr={}, stream-name=\"{}\"",
1968 fmt::ptr(ds_file_group
), name
->str
);
1972 ret
= bt_stream_set_name(ds_file_group
->stream
, name
->str
);
1974 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1975 "Cannot set stream's name: "
1976 "addr={}, stream-name=\"{}\"",
1977 fmt::ptr(ds_file_group
->stream
), name
->str
);
1981 g_string_free(name
, TRUE
);
1994 g_string_free(name
, TRUE
);
1999 static const bt_param_validation_value_descr inputs_elem_descr
=
2000 bt_param_validation_value_descr::makeString();
2002 static bt_param_validation_map_value_entry_descr fs_params_entries_descr
[] = {
2003 {"inputs", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
2004 bt_param_validation_value_descr::makeArray(1, BT_PARAM_VALIDATION_INFINITE
,
2005 inputs_elem_descr
)},
2006 {"trace-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2007 bt_param_validation_value_descr::makeString()},
2008 {"clock-class-offset-s", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2009 bt_param_validation_value_descr::makeSignedInteger()},
2010 {"clock-class-offset-ns", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2011 bt_param_validation_value_descr::makeSignedInteger()},
2012 {"force-clock-class-origin-unix-epoch", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2013 bt_param_validation_value_descr::makeBool()},
2014 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
2016 bool read_src_fs_parameters(const bt_value
*params
, const bt_value
**inputs
,
2017 const bt_value
**trace_name
, struct ctf_fs_component
*ctf_fs
)
2020 const bt_value
*value
;
2021 enum bt_param_validation_status validate_value_status
;
2022 gchar
*error
= NULL
;
2024 validate_value_status
= bt_param_validation_validate(params
, fs_params_entries_descr
, &error
);
2025 if (validate_value_status
!= BT_PARAM_VALIDATION_STATUS_OK
) {
2026 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "{}", error
);
2031 /* inputs parameter */
2032 *inputs
= bt_value_map_borrow_entry_value_const(params
, "inputs");
2034 /* clock-class-offset-s parameter */
2035 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-s");
2037 ctf_fs
->clkClsCfg
.offsetSec
= bt_value_integer_signed_get(value
);
2040 /* clock-class-offset-ns parameter */
2041 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-ns");
2043 ctf_fs
->clkClsCfg
.offsetNanoSec
= bt_value_integer_signed_get(value
);
2046 /* force-clock-class-origin-unix-epoch parameter */
2047 value
= bt_value_map_borrow_entry_value_const(params
, "force-clock-class-origin-unix-epoch");
2049 ctf_fs
->clkClsCfg
.forceOriginIsUnixEpoch
= bt_value_bool_get(value
);
2052 /* trace-name parameter */
2053 *trace_name
= bt_value_map_borrow_entry_value_const(params
, "trace-name");
2062 static ctf_fs_component::UP
ctf_fs_create(const bt_value
*params
,
2063 bt_self_component_source
*self_comp_src
)
2065 const bt_value
*inputs_value
;
2066 const bt_value
*trace_name_value
;
2067 bt_self_component
*self_comp
= bt_self_component_source_as_self_component(self_comp_src
);
2069 ctf_fs_component::UP ctf_fs
= ctf_fs_component_create(
2070 bt2c::Logger
{bt2::SelfSourceComponent
{self_comp_src
}, "PLUGIN/SRC.CTF.FS/COMP"});
2075 if (!read_src_fs_parameters(params
, &inputs_value
, &trace_name_value
, ctf_fs
.get())) {
2079 if (ctf_fs_component_create_ctf_fs_trace(ctf_fs
.get(), inputs_value
, trace_name_value
,
2084 if (create_streams_for_trace(ctf_fs
->trace
.get())) {
2088 if (create_ports_for_trace(ctf_fs
.get(), ctf_fs
->trace
.get(), self_comp_src
)) {
2095 bt_component_class_initialize_method_status
ctf_fs_init(bt_self_component_source
*self_comp_src
,
2096 bt_self_component_source_configuration
*,
2097 const bt_value
*params
, void *)
2100 bt_component_class_initialize_method_status ret
=
2101 BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
2103 ctf_fs_component::UP ctf_fs
= ctf_fs_create(params
, self_comp_src
);
2105 ret
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
2108 bt_self_component_set_data(bt_self_component_source_as_self_component(self_comp_src
),
2111 } catch (const std::bad_alloc
&) {
2112 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
2113 } catch (const bt2::Error
&) {
2114 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
2118 bt_component_class_query_method_status
ctf_fs_query(bt_self_component_class_source
*comp_class_src
,
2119 bt_private_query_executor
*priv_query_exec
,
2120 const char *object
, const bt_value
*params
,
2121 __attribute__((unused
)) void *method_data
,
2122 const bt_value
**result
)
2125 bt2c::Logger logger
{bt2::SelfComponentClass
{comp_class_src
},
2126 bt2::PrivateQueryExecutor
{priv_query_exec
},
2127 "PLUGIN/SRC.CTF.FS/QUERY"};
2128 bt2::ConstMapValue
paramsObj(params
);
2129 bt2::Value::Shared resultObj
;
2131 if (strcmp(object
, "metadata-info") == 0) {
2132 resultObj
= metadata_info_query(paramsObj
, logger
);
2133 } else if (strcmp(object
, "babeltrace.trace-infos") == 0) {
2134 resultObj
= trace_infos_query(paramsObj
, logger
);
2135 } else if (!strcmp(object
, "babeltrace.support-info")) {
2136 resultObj
= support_info_query(paramsObj
, logger
);
2138 BT_CPPLOGE_SPEC(logger
, "Unknown query object `{}`", object
);
2139 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;
2142 *result
= resultObj
.release().libObjPtr();
2144 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
2145 } catch (const std::bad_alloc
&) {
2146 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
2147 } catch (const bt2::Error
&) {
2148 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;