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 ctf_fs_ds_file_group::UP new_ds_file_group
;
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 new_ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, UINT64_C(-1), index
);
644 /* Ownership of index is transferred. */
647 if (!new_ds_file_group
) {
651 ds_file_group_insert_ds_file_info_sorted(new_ds_file_group
.get(),
652 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
) {
673 ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, stream_instance_id
, index
);
674 /* Ownership of index is transferred. */
676 if (!new_ds_file_group
) {
680 ds_file_group
= new_ds_file_group
.get();
682 merge_ctf_fs_ds_indexes(ds_file_group
->index
, index
);
685 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, BT_MOVE_REF(ds_file_info
));
693 if (new_ds_file_group
) {
694 g_ptr_array_add(ctf_fs_trace
->ds_file_groups
, new_ds_file_group
.release());
697 ctf_fs_ds_file_destroy(ds_file
);
698 ctf_fs_ds_file_info_destroy(ds_file_info
);
701 ctf_msg_iter_destroy(msg_iter
);
704 ctf_fs_ds_index_destroy(index
);
708 static int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
711 const char *basename
;
712 GError
*error
= NULL
;
715 /* Check each file in the path directory, except specific ones */
716 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
718 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
719 "Cannot open directory `{}`: {} (code {})",
720 ctf_fs_trace
->path
->str
, error
->message
, error
->code
);
724 while ((basename
= g_dir_read_name(dir
))) {
725 struct ctf_fs_file
*file
;
727 if (strcmp(basename
, CTF_FS_METADATA_FILENAME
) == 0) {
728 /* Ignore the metadata stream. */
729 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
730 "Ignoring metadata file `{}" G_DIR_SEPARATOR_S
"{}`",
731 ctf_fs_trace
->path
->str
, basename
);
735 if (basename
[0] == '.') {
736 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
737 "Ignoring hidden file `{}" G_DIR_SEPARATOR_S
"{}`",
738 ctf_fs_trace
->path
->str
, basename
);
742 /* Create the file. */
743 file
= ctf_fs_file_create(ctf_fs_trace
->logger
);
745 BT_CPPLOGE_APPEND_CAUSE_SPEC(
746 ctf_fs_trace
->logger
,
747 "Cannot create stream file object for file `{}" G_DIR_SEPARATOR_S
"{}`",
748 ctf_fs_trace
->path
->str
, basename
);
752 /* Create full path string. */
753 g_string_append_printf(file
->path
, "%s" G_DIR_SEPARATOR_S
"%s", ctf_fs_trace
->path
->str
,
755 if (!g_file_test(file
->path
->str
, G_FILE_TEST_IS_REGULAR
)) {
756 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring non-regular file `{}`",
758 ctf_fs_file_destroy(file
);
763 ret
= ctf_fs_file_open(file
, "rb");
765 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Cannot open stream file `{}`",
770 if (file
->size
== 0) {
771 /* Skip empty stream. */
772 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring empty file `{}`", file
->path
->str
);
773 ctf_fs_file_destroy(file
);
777 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
, file
->path
->str
);
779 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
780 "Cannot add stream file `{}` to stream file group",
782 ctf_fs_file_destroy(file
);
786 ctf_fs_file_destroy(file
);
807 static int set_trace_name(bt_trace
*trace
, const char *name_suffix
, const bt2c::Logger
& logger
)
813 name
= g_string_new(NULL
);
815 BT_CPPLOGE_STR_SPEC(logger
, "Failed to allocate a GString.");
821 * Check if we have a trace environment string value named `hostname`.
822 * If so, use it as the trace name's prefix.
824 val
= bt_trace_borrow_environment_entry_value_by_name_const(trace
, "hostname");
825 if (val
&& bt_value_is_string(val
)) {
826 g_string_append(name
, bt_value_string_get(val
));
829 g_string_append_c(name
, G_DIR_SEPARATOR
);
834 g_string_append(name
, name_suffix
);
837 ret
= bt_trace_set_name(trace
, name
->str
);
846 g_string_free(name
, TRUE
);
852 static ctf_fs_trace::UP
ctf_fs_trace_create(const char *path
, const char *name
,
853 const ctf::src::ClkClsCfg
& clkClsCfg
,
854 bt_self_component
*selfComp
,
855 const bt2c::Logger
& parentLogger
)
859 ctf_fs_trace::UP ctf_fs_trace
{new struct ctf_fs_trace(parentLogger
)};
860 ctf_fs_trace
->path
= g_string_new(path
);
861 if (!ctf_fs_trace
->path
) {
865 ctf_fs_trace
->metadata
= new ctf_fs_metadata
;
866 ctf_fs_metadata_init(ctf_fs_trace
->metadata
);
867 ctf_fs_trace
->ds_file_groups
=
868 g_ptr_array_new_with_free_func((GDestroyNotify
) ctf_fs_ds_file_group_destroy
);
869 if (!ctf_fs_trace
->ds_file_groups
) {
873 ret
= ctf_fs_metadata_set_trace_class(selfComp
, ctf_fs_trace
.get(), clkClsCfg
);
878 if (ctf_fs_trace
->metadata
->trace_class
) {
879 ctf_fs_trace
->trace
= bt_trace_create(ctf_fs_trace
->metadata
->trace_class
);
880 if (!ctf_fs_trace
->trace
) {
885 if (ctf_fs_trace
->trace
) {
886 ret
= ctf_trace_class_configure_ir_trace(ctf_fs_trace
->metadata
->tc
, ctf_fs_trace
->trace
);
891 ret
= set_trace_name(ctf_fs_trace
->trace
, name
, ctf_fs_trace
->logger
);
897 ret
= create_ds_file_groups(ctf_fs_trace
.get());
905 ctf_fs_trace
.reset();
911 static int path_is_ctf_trace(const char *path
)
913 GString
*metadata_path
= g_string_new(NULL
);
916 if (!metadata_path
) {
921 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
923 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
929 g_string_free(metadata_path
, TRUE
);
933 /* Helper for ctf_fs_component_create_ctf_fs_trace, to handle a single path. */
935 static int ctf_fs_component_create_ctf_fs_trace_one_path(struct ctf_fs_component
*ctf_fs
,
936 const char *path_param
,
937 const char *trace_name
,
938 std::vector
<ctf_fs_trace::UP
>& traces
,
939 bt_self_component
*selfComp
)
941 ctf_fs_trace::UP ctf_fs_trace
;
945 norm_path
= bt_common_normalize_path(path_param
, NULL
);
947 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to normalize path: `{}`.", path_param
);
951 ret
= path_is_ctf_trace(norm_path
->str
);
953 BT_CPPLOGE_APPEND_CAUSE_SPEC(
954 ctf_fs
->logger
, "Failed to check if path is a CTF trace: path={}", norm_path
->str
);
956 } else if (ret
== 0) {
957 BT_CPPLOGE_APPEND_CAUSE_SPEC(
958 ctf_fs
->logger
, "Path is not a CTF trace (does not contain a metadata file): `{}`.",
963 // FIXME: Remove or ifdef for __MINGW32__
964 if (strcmp(norm_path
->str
, "/") == 0) {
965 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Opening a trace in `/` is not supported.");
970 ctf_fs_trace
= ctf_fs_trace_create(norm_path
->str
, trace_name
, ctf_fs
->clkClsCfg
, selfComp
,
973 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create trace for `{}`.",
978 traces
.emplace_back(std::move(ctf_fs_trace
));
988 g_string_free(norm_path
, TRUE
);
995 * Count the number of stream and event classes defined by this trace's metadata.
997 * This is used to determine which metadata is the "latest", out of multiple
998 * traces sharing the same UUID. It is assumed that amongst all these metadatas,
999 * a bigger metadata is a superset of a smaller metadata. Therefore, it is
1000 * enough to just count the classes.
1003 static unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace
*trace
)
1005 unsigned int num
= trace
->metadata
->tc
->stream_classes
->len
;
1008 for (i
= 0; i
< trace
->metadata
->tc
->stream_classes
->len
; i
++) {
1009 struct ctf_stream_class
*sc
=
1010 (struct ctf_stream_class
*) trace
->metadata
->tc
->stream_classes
->pdata
[i
];
1011 num
+= sc
->event_classes
->len
;
1018 * Merge the src ds_file_group into dest. This consists of merging their
1019 * ds_file_infos, making sure to keep the result sorted.
1022 static void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group
*dest
,
1023 struct ctf_fs_ds_file_group
*src
)
1027 for (i
= 0; i
< src
->ds_file_infos
->len
; i
++) {
1028 struct ctf_fs_ds_file_info
*ds_file_info
=
1029 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(src
->ds_file_infos
, i
);
1031 /* Ownership of the ds_file_info is transferred to dest. */
1032 g_ptr_array_index(src
->ds_file_infos
, i
) = NULL
;
1034 ds_file_group_insert_ds_file_info_sorted(dest
, ds_file_info
);
1037 /* Merge both indexes. */
1038 merge_ctf_fs_ds_indexes(dest
->index
, src
->index
);
1041 /* Merge src_trace's data stream file groups into dest_trace's. */
1043 static int merge_matching_ctf_fs_ds_file_groups(struct ctf_fs_trace
*dest_trace
,
1044 ctf_fs_trace::UP src_trace
)
1046 GPtrArray
*dest
= dest_trace
->ds_file_groups
;
1047 GPtrArray
*src
= src_trace
->ds_file_groups
;
1052 * Save the initial length of dest: we only want to check against the
1053 * original elements in the inner loop.
1055 const guint dest_len
= dest
->len
;
1057 for (s_i
= 0; s_i
< src
->len
; s_i
++) {
1058 struct ctf_fs_ds_file_group
*src_group
=
1059 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(src
, s_i
);
1060 struct ctf_fs_ds_file_group
*dest_group
= NULL
;
1062 /* A stream instance without ID can't match a stream in the other trace. */
1063 if (src_group
->stream_id
!= -1) {
1066 /* Let's search for a matching ds_file_group in the destination. */
1067 for (d_i
= 0; d_i
< dest_len
; d_i
++) {
1068 struct ctf_fs_ds_file_group
*candidate_dest
=
1069 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(dest
, d_i
);
1071 /* Can't match a stream instance without ID. */
1072 if (candidate_dest
->stream_id
== -1) {
1077 * If the two groups have the same stream instance id
1078 * and belong to the same stream class (stream instance
1079 * ids are per-stream class), they represent the same
1082 if (candidate_dest
->stream_id
!= src_group
->stream_id
||
1083 candidate_dest
->sc
->id
!= src_group
->sc
->id
) {
1087 dest_group
= candidate_dest
;
1093 * Didn't find a friend in dest to merge our src_group into?
1094 * Create a new empty one. This can happen if a stream was
1095 * active in the source trace chunk but not in the destination
1099 struct ctf_stream_class
*sc
;
1100 struct ctf_fs_ds_index
*index
;
1102 sc
= ctf_trace_class_borrow_stream_class_by_id(dest_trace
->metadata
->tc
,
1106 index
= ctf_fs_ds_index_create(dest_trace
->logger
);
1112 auto new_dest_group
=
1113 ctf_fs_ds_file_group_create(dest_trace
, sc
, src_group
->stream_id
, index
);
1115 /* Ownership of index is transferred. */
1117 if (!new_dest_group
) {
1122 dest_group
= new_dest_group
.get();
1124 g_ptr_array_add(dest_trace
->ds_file_groups
, new_dest_group
.release());
1127 BT_ASSERT(dest_group
);
1128 merge_ctf_fs_ds_file_groups(dest_group
, src_group
);
1136 * Collapse the given traces, which must all share the same UUID, in a single
1139 * The trace with the most expansive metadata is chosen and all other traces
1140 * are merged into that one. On return, the elements of `traces` are nullptr
1141 * and the merged trace is placed in `out_trace`.
1144 static int merge_ctf_fs_traces(std::vector
<ctf_fs_trace::UP
> traces
, ctf_fs_trace::UP
& out_trace
)
1146 unsigned int winner_count
;
1147 struct ctf_fs_trace
*winner
;
1151 BT_ASSERT(traces
.size() >= 2);
1153 winner_count
= metadata_count_stream_and_event_classes(traces
[0].get());
1154 winner
= traces
[0].get();
1157 /* Find the trace with the largest metadata. */
1158 for (i
= 1; i
< traces
.size(); i
++) {
1159 ctf_fs_trace
*candidate
= traces
[i
].get();
1160 unsigned int candidate_count
;
1162 /* A bit of sanity check. */
1163 BT_ASSERT(bt_uuid_compare(winner
->metadata
->tc
->uuid
, candidate
->metadata
->tc
->uuid
) == 0);
1165 candidate_count
= metadata_count_stream_and_event_classes(candidate
);
1167 if (candidate_count
> winner_count
) {
1168 winner_count
= candidate_count
;
1174 /* Merge all the other traces in the winning trace. */
1175 for (ctf_fs_trace::UP
& trace
: traces
) {
1176 /* Don't merge the winner into itself. */
1177 if (trace
.get() == winner
) {
1181 /* Merge trace's data stream file groups into winner's. */
1182 ret
= merge_matching_ctf_fs_ds_file_groups(winner
, std::move(trace
));
1189 * Move the winner out of the array, into `*out_trace`.
1191 out_trace
= std::move(traces
[winner_i
]);
1203 static int decode_clock_snapshot_after_event(struct ctf_fs_trace
*ctf_fs_trace
,
1204 struct ctf_clock_class
*default_cc
,
1205 struct ctf_fs_ds_index_entry
*index_entry
,
1206 enum target_event target_event
, uint64_t *cs
,
1209 enum ctf_msg_iter_status iter_status
= CTF_MSG_ITER_STATUS_OK
;
1210 struct ctf_fs_ds_file
*ds_file
= NULL
;
1211 struct ctf_msg_iter
*msg_iter
= NULL
;
1214 BT_ASSERT(ctf_fs_trace
);
1215 BT_ASSERT(index_entry
);
1216 BT_ASSERT(index_entry
->path
);
1218 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, index_entry
->path
, ctf_fs_trace
->logger
);
1220 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to create a ctf_fs_ds_file");
1225 BT_ASSERT(ctf_fs_trace
->metadata
);
1226 BT_ASSERT(ctf_fs_trace
->metadata
->tc
);
1228 msg_iter
= ctf_msg_iter_create(
1229 ctf_fs_trace
->metadata
->tc
,
1230 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
1231 ctf_fs_ds_file_medops
, ds_file
, NULL
, ctf_fs_trace
->logger
);
1233 /* ctf_msg_iter_create() logs errors. */
1239 * Turn on dry run mode to prevent the creation and usage of Babeltrace
1240 * library objects (bt_field, bt_message_*, etc.).
1242 ctf_msg_iter_set_dry_run(msg_iter
, true);
1244 /* Seek to the beginning of the target packet. */
1245 iter_status
= ctf_msg_iter_seek(msg_iter
, index_entry
->offset
.bytes());
1247 /* ctf_msg_iter_seek() logs errors. */
1252 switch (target_event
) {
1255 * Start to decode the packet until we reach the end of
1256 * the first event. To extract the first event's clock
1259 iter_status
= ctf_msg_iter_curr_packet_first_event_clock_snapshot(msg_iter
, cs
);
1262 /* Decode the packet to extract the last event's clock snapshot. */
1263 iter_status
= ctf_msg_iter_curr_packet_last_event_clock_snapshot(msg_iter
, cs
);
1273 /* Convert clock snapshot to timestamp. */
1274 ret
= bt_util_clock_cycles_to_ns_from_origin(
1275 *cs
, default_cc
->frequency
, default_cc
->offset_seconds
, default_cc
->offset_cycles
, ts_ns
);
1277 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1278 "Failed to convert clock snapshot to timestamp");
1284 ctf_fs_ds_file_destroy(ds_file
);
1287 ctf_msg_iter_destroy(msg_iter
);
1293 static int decode_packet_first_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1294 struct ctf_clock_class
*default_cc
,
1295 struct ctf_fs_ds_index_entry
*index_entry
,
1296 uint64_t *cs
, int64_t *ts_ns
)
1298 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, FIRST_EVENT
, cs
,
1302 static int decode_packet_last_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1303 struct ctf_clock_class
*default_cc
,
1304 struct ctf_fs_ds_index_entry
*index_entry
,
1305 uint64_t *cs
, int64_t *ts_ns
)
1307 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, LAST_EVENT
, cs
,
1312 * Fix up packet index entries for lttng's "event-after-packet" bug.
1313 * Some buggy lttng tracer versions may emit events with a timestamp that is
1314 * larger (after) than the timestamp_end of the their packets.
1316 * To fix up this erroneous data we do the following:
1317 * 1. If it's not the stream file's last packet: set the packet index entry's
1318 * end time to the next packet's beginning time.
1319 * 2. If it's the stream file's last packet, set the packet index entry's end
1320 * time to the packet's last event's time, if any, or to the packet's
1321 * beginning time otherwise.
1323 * Known buggy tracer versions:
1324 * - before lttng-ust 2.11.0
1325 * - before lttng-module 2.11.0
1326 * - before lttng-module 2.10.10
1327 * - before lttng-module 2.9.13
1329 static int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace
*trace
)
1332 guint ds_file_group_i
;
1333 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1335 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
; ds_file_group_i
++) {
1337 struct ctf_clock_class
*default_cc
;
1338 struct ctf_fs_ds_index_entry
*last_entry
;
1339 struct ctf_fs_ds_index
*index
;
1341 struct ctf_fs_ds_file_group
*ds_file_group
=
1342 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1344 BT_ASSERT(ds_file_group
);
1345 index
= ds_file_group
->index
;
1348 BT_ASSERT(index
->entries
);
1349 BT_ASSERT(index
->entries
->len
> 0);
1352 * Iterate over all entries but the last one. The last one is
1353 * fixed differently after.
1355 for (entry_i
= 0; entry_i
< index
->entries
->len
- 1; entry_i
++) {
1356 struct ctf_fs_ds_index_entry
*curr_entry
, *next_entry
;
1358 curr_entry
= (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
);
1359 next_entry
= (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
+ 1);
1362 * 1. Set the current index entry `end` timestamp to
1363 * the next index entry `begin` timestamp.
1365 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1366 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1370 * 2. Fix the last entry by decoding the last event of the last
1374 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, index
->entries
->len
- 1);
1375 BT_ASSERT(last_entry
);
1377 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1378 default_cc
= ds_file_group
->sc
->default_clock_class
;
1381 * Decode packet to read the timestamp of the last event of the
1384 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1385 &last_entry
->timestamp_end
,
1386 &last_entry
->timestamp_end_ns
);
1388 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1390 "Failed to decode stream's last packet to get its last event's clock snapshot.");
1400 * Fix up packet index entries for barectf's "event-before-packet" bug.
1401 * Some buggy barectf tracer versions may emit events with a timestamp that is
1402 * less than the timestamp_begin of the their packets.
1404 * To fix up this erroneous data we do the following:
1405 * 1. Starting at the second index entry, set the timestamp_begin of the
1406 * current entry to the timestamp of the first event of the packet.
1407 * 2. Set the previous entry's timestamp_end to the timestamp_begin of the
1410 * Known buggy tracer versions:
1411 * - before barectf 2.3.1
1413 static int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace
*trace
)
1416 guint ds_file_group_i
;
1417 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1419 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
; ds_file_group_i
++) {
1421 struct ctf_clock_class
*default_cc
;
1422 ctf_fs_ds_file_group
*ds_file_group
=
1423 (ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1425 struct ctf_fs_ds_index
*index
= ds_file_group
->index
;
1428 BT_ASSERT(index
->entries
);
1429 BT_ASSERT(index
->entries
->len
> 0);
1431 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1432 default_cc
= ds_file_group
->sc
->default_clock_class
;
1435 * 1. Iterate over the index, starting from the second entry
1438 for (entry_i
= 1; entry_i
< index
->entries
->len
; entry_i
++) {
1439 ctf_fs_ds_index_entry
*prev_entry
=
1440 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
- 1);
1441 ctf_fs_ds_index_entry
*curr_entry
=
1442 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
);
1444 * 2. Set the current entry `begin` timestamp to the
1445 * timestamp of the first event of the current packet.
1447 ret
= decode_packet_first_event_timestamp(trace
, default_cc
, curr_entry
,
1448 &curr_entry
->timestamp_begin
,
1449 &curr_entry
->timestamp_begin_ns
);
1451 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1452 "Failed to decode first event's clock snapshot");
1457 * 3. Set the previous entry `end` timestamp to the
1458 * timestamp of the first event of the current packet.
1460 prev_entry
->timestamp_end
= curr_entry
->timestamp_begin
;
1461 prev_entry
->timestamp_end_ns
= curr_entry
->timestamp_begin_ns
;
1469 * When using the lttng-crash feature it's likely that the last packets of each
1470 * stream have their timestamp_end set to zero. This is caused by the fact that
1471 * the tracer crashed and was not able to properly close the packets.
1473 * To fix up this erroneous data we do the following:
1474 * For each index entry, if the entry's timestamp_end is 0 and the
1475 * timestamp_begin is not 0:
1476 * - If it's the stream file's last packet: set the packet index entry's end
1477 * time to the packet's last event's time, if any, or to the packet's
1478 * beginning time otherwise.
1479 * - If it's not the stream file's last packet: set the packet index
1480 * entry's end time to the next packet's beginning time.
1482 * Affected versions:
1483 * - All current and future lttng-ust and lttng-modules versions.
1485 static int fix_index_lttng_crash_quirk(struct ctf_fs_trace
*trace
)
1488 guint ds_file_group_idx
;
1489 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1491 for (ds_file_group_idx
= 0; ds_file_group_idx
< ds_file_groups
->len
; ds_file_group_idx
++) {
1493 struct ctf_clock_class
*default_cc
;
1494 struct ctf_fs_ds_index
*index
;
1496 ctf_fs_ds_file_group
*ds_file_group
=
1497 (ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_idx
);
1499 BT_ASSERT(ds_file_group
);
1500 index
= ds_file_group
->index
;
1502 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1503 default_cc
= ds_file_group
->sc
->default_clock_class
;
1506 BT_ASSERT(index
->entries
);
1507 BT_ASSERT(index
->entries
->len
> 0);
1509 ctf_fs_ds_index_entry
*last_entry
=
1510 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, index
->entries
->len
- 1);
1511 BT_ASSERT(last_entry
);
1513 /* 1. Fix the last entry first. */
1514 if (last_entry
->timestamp_end
== 0 && last_entry
->timestamp_begin
!= 0) {
1516 * Decode packet to read the timestamp of the
1517 * last event of the stream file.
1519 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1520 &last_entry
->timestamp_end
,
1521 &last_entry
->timestamp_end_ns
);
1523 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1524 "Failed to decode last event's clock snapshot");
1529 /* Iterate over all entries but the last one. */
1530 for (entry_idx
= 0; entry_idx
< index
->entries
->len
- 1; entry_idx
++) {
1531 ctf_fs_ds_index_entry
*curr_entry
=
1532 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_idx
);
1533 ctf_fs_ds_index_entry
*next_entry
=
1534 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_idx
+ 1);
1536 if (curr_entry
->timestamp_end
== 0 && curr_entry
->timestamp_begin
!= 0) {
1538 * 2. Set the current index entry `end` timestamp to
1539 * the next index entry `begin` timestamp.
1541 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1542 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1552 * Extract the tracer information necessary to compare versions.
1553 * Returns 0 on success, and -1 if the extraction is not successful because the
1554 * necessary fields are absents in the trace metadata.
1556 static int extract_tracer_info(struct ctf_fs_trace
*trace
, struct tracer_info
*current_tracer_info
)
1559 struct ctf_trace_class_env_entry
*entry
;
1561 /* Clear the current_tracer_info struct */
1562 memset(current_tracer_info
, 0, sizeof(*current_tracer_info
));
1565 * To compare 2 tracer versions, at least the tracer name and it's
1566 * major version are needed. If one of these is missing, consider it an
1567 * extraction failure.
1569 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_name");
1570 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR
) {
1571 goto missing_bare_minimum
;
1574 /* Set tracer name. */
1575 current_tracer_info
->name
= entry
->value
.str
->str
;
1577 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_major");
1578 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1579 goto missing_bare_minimum
;
1582 /* Set major version number. */
1583 current_tracer_info
->major
= entry
->value
.i
;
1585 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_minor");
1586 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1590 /* Set minor version number. */
1591 current_tracer_info
->minor
= entry
->value
.i
;
1593 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patch");
1596 * If `tracer_patch` doesn't exist `tracer_patchlevel` might.
1597 * For example, `lttng-modules` uses entry name
1598 * `tracer_patchlevel`.
1600 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patchlevel");
1603 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1607 /* Set patch version number. */
1608 current_tracer_info
->patch
= entry
->value
.i
;
1612 missing_bare_minimum
:
1618 static bool is_tracer_affected_by_lttng_event_after_packet_bug(struct tracer_info
*curr_tracer_info
)
1620 bool is_affected
= false;
1622 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1623 if (curr_tracer_info
->major
< 2) {
1625 } else if (curr_tracer_info
->major
== 2) {
1626 /* fixed in lttng-ust 2.11.0 */
1627 if (curr_tracer_info
->minor
< 11) {
1631 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1632 if (curr_tracer_info
->major
< 2) {
1634 } else if (curr_tracer_info
->major
== 2) {
1635 /* fixed in lttng-modules 2.11.0 */
1636 if (curr_tracer_info
->minor
== 10) {
1637 /* fixed in lttng-modules 2.10.10 */
1638 if (curr_tracer_info
->patch
< 10) {
1641 } else if (curr_tracer_info
->minor
== 9) {
1642 /* fixed in lttng-modules 2.9.13 */
1643 if (curr_tracer_info
->patch
< 13) {
1646 } else if (curr_tracer_info
->minor
< 9) {
1656 is_tracer_affected_by_barectf_event_before_packet_bug(struct tracer_info
*curr_tracer_info
)
1658 bool is_affected
= false;
1660 if (strcmp(curr_tracer_info
->name
, "barectf") == 0) {
1661 if (curr_tracer_info
->major
< 2) {
1663 } else if (curr_tracer_info
->major
== 2) {
1664 if (curr_tracer_info
->minor
< 3) {
1666 } else if (curr_tracer_info
->minor
== 3) {
1667 /* fixed in barectf 2.3.1 */
1668 if (curr_tracer_info
->patch
< 1) {
1678 static bool is_tracer_affected_by_lttng_crash_quirk(struct tracer_info
*curr_tracer_info
)
1680 bool is_affected
= false;
1682 /* All LTTng tracer may be affected by this lttng crash quirk. */
1683 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1685 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1693 * Looks for trace produced by known buggy tracers and fix up the index
1696 static int fix_packet_index_tracer_bugs(ctf_fs_trace
*trace
)
1699 struct tracer_info current_tracer_info
;
1701 ret
= extract_tracer_info(trace
, ¤t_tracer_info
);
1704 * A trace may not have all the necessary environment
1705 * entries to do the tracer version comparison.
1706 * At least, the tracer name and major version number
1707 * are needed. Failing to extract these entries is not
1711 BT_CPPLOGI_STR_SPEC(
1713 "Cannot extract tracer information necessary to compare with buggy versions.");
1717 /* Check if the trace may be affected by old tracer bugs. */
1718 if (is_tracer_affected_by_lttng_event_after_packet_bug(¤t_tracer_info
)) {
1719 BT_CPPLOGI_STR_SPEC(
1721 "Trace may be affected by LTTng tracer packet timestamp bug. Fixing up.");
1722 ret
= fix_index_lttng_event_after_packet_bug(trace
);
1724 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1725 "Failed to fix LTTng event-after-packet bug.");
1728 trace
->metadata
->tc
->quirks
.lttng_event_after_packet
= true;
1731 if (is_tracer_affected_by_barectf_event_before_packet_bug(¤t_tracer_info
)) {
1732 BT_CPPLOGI_STR_SPEC(
1734 "Trace may be affected by barectf tracer packet timestamp bug. Fixing up.");
1735 ret
= fix_index_barectf_event_before_packet_bug(trace
);
1737 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1738 "Failed to fix barectf event-before-packet bug.");
1741 trace
->metadata
->tc
->quirks
.barectf_event_before_packet
= true;
1744 if (is_tracer_affected_by_lttng_crash_quirk(¤t_tracer_info
)) {
1745 ret
= fix_index_lttng_crash_quirk(trace
);
1747 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1748 "Failed to fix lttng-crash timestamp quirks.");
1751 trace
->metadata
->tc
->quirks
.lttng_crash
= true;
1758 static gint
compare_ds_file_groups_by_first_path(gconstpointer a
, gconstpointer b
)
1760 ctf_fs_ds_file_group
* const *ds_file_group_a
= (ctf_fs_ds_file_group
**) a
;
1761 ctf_fs_ds_file_group
* const *ds_file_group_b
= (ctf_fs_ds_file_group
**) b
;
1763 BT_ASSERT((*ds_file_group_a
)->ds_file_infos
->len
> 0);
1764 BT_ASSERT((*ds_file_group_b
)->ds_file_infos
->len
> 0);
1766 const ctf_fs_ds_file_info
*first_ds_file_info_a
=
1767 (const ctf_fs_ds_file_info
*) (*ds_file_group_a
)->ds_file_infos
->pdata
[0];
1768 const ctf_fs_ds_file_info
*first_ds_file_info_b
=
1769 (const ctf_fs_ds_file_info
*) (*ds_file_group_b
)->ds_file_infos
->pdata
[0];
1771 return strcmp(first_ds_file_info_a
->path
->str
, first_ds_file_info_b
->path
->str
);
1774 static gint
compare_strings(gconstpointer p_a
, gconstpointer p_b
)
1776 const char *a
= *((const char **) p_a
);
1777 const char *b
= *((const char **) p_b
);
1779 return strcmp(a
, b
);
1782 int ctf_fs_component_create_ctf_fs_trace(struct ctf_fs_component
*ctf_fs
,
1783 const bt_value
*paths_value
,
1784 const bt_value
*trace_name_value
,
1785 bt_self_component
*selfComp
)
1789 GPtrArray
*paths
= NULL
;
1790 std::vector
<ctf_fs_trace::UP
> traces
;
1791 const char *trace_name
;
1793 BT_ASSERT(bt_value_get_type(paths_value
) == BT_VALUE_TYPE_ARRAY
);
1794 BT_ASSERT(!bt_value_array_is_empty(paths_value
));
1796 paths
= g_ptr_array_new_with_free_func(g_free
);
1798 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to allocate a GPtrArray.");
1802 trace_name
= trace_name_value
? bt_value_string_get(trace_name_value
) : NULL
;
1805 * Create a sorted array of the paths, to make the execution of this
1806 * component deterministic.
1808 for (i
= 0; i
< bt_value_array_get_length(paths_value
); i
++) {
1809 const bt_value
*path_value
= bt_value_array_borrow_element_by_index_const(paths_value
, i
);
1810 const char *input
= bt_value_string_get(path_value
);
1813 input_copy
= g_strdup(input
);
1815 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to copy a string.");
1819 g_ptr_array_add(paths
, input_copy
);
1822 g_ptr_array_sort(paths
, compare_strings
);
1824 /* Create a separate ctf_fs_trace object for each path. */
1825 for (i
= 0; i
< paths
->len
; i
++) {
1826 const char *path
= (const char *) g_ptr_array_index(paths
, i
);
1828 ret
= ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs
, path
, trace_name
, traces
,
1835 if (traces
.size() > 1) {
1836 ctf_fs_trace
*first_trace
= traces
[0].get();
1837 const uint8_t *first_trace_uuid
= first_trace
->metadata
->tc
->uuid
;
1840 * We have more than one trace, they must all share the same
1841 * UUID, verify that.
1843 for (i
= 0; i
< traces
.size(); i
++) {
1844 ctf_fs_trace
*this_trace
= traces
[i
].get();
1845 const uint8_t *this_trace_uuid
= this_trace
->metadata
->tc
->uuid
;
1847 if (!this_trace
->metadata
->tc
->is_uuid_set
) {
1848 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1850 "Multiple traces given, but a trace does not have a UUID: path={}",
1851 this_trace
->path
->str
);
1855 if (bt_uuid_compare(first_trace_uuid
, this_trace_uuid
) != 0) {
1856 char first_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1857 char this_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1859 bt_uuid_to_str(first_trace_uuid
, first_trace_uuid_str
);
1860 bt_uuid_to_str(this_trace_uuid
, this_trace_uuid_str
);
1862 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1863 "Multiple traces given, but UUIDs don't match: "
1864 "first-trace-uuid={}, first-trace-path={}, "
1865 "trace-uuid={}, trace-path={}",
1866 first_trace_uuid_str
, first_trace
->path
->str
,
1867 this_trace_uuid_str
, this_trace
->path
->str
);
1872 ret
= merge_ctf_fs_traces(std::move(traces
), ctf_fs
->trace
);
1874 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1875 "Failed to merge traces with the same UUID.");
1879 /* Just one trace, it may or may not have a UUID, both are fine. */
1880 ctf_fs
->trace
= std::move(traces
[0]);
1883 ret
= fix_packet_index_tracer_bugs(ctf_fs
->trace
.get());
1885 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to fix packet index tracer bugs.");
1889 * Sort data stream file groups by first data stream file info
1890 * path to get a deterministic order. This order influences the
1891 * order of the output ports. It also influences the order of
1892 * the automatic stream IDs if the trace's packet headers do not
1893 * contain a `stream_instance_id` field, in which case the data
1894 * stream file to stream ID association is always the same,
1895 * whatever the build and the system.
1897 * Having a deterministic order here can help debugging and
1900 g_ptr_array_sort(ctf_fs
->trace
->ds_file_groups
, compare_ds_file_groups_by_first_path
);
1907 g_ptr_array_free(paths
, TRUE
);
1913 static GString
*get_stream_instance_unique_name(struct ctf_fs_ds_file_group
*ds_file_group
)
1916 struct ctf_fs_ds_file_info
*ds_file_info
;
1918 name
= g_string_new(NULL
);
1924 * If there's more than one stream file in the stream file
1925 * group, the first (earliest) stream file's path is used as
1926 * the stream's unique name.
1928 BT_ASSERT(ds_file_group
->ds_file_infos
->len
> 0);
1929 ds_file_info
= (ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
1930 g_string_assign(name
, ds_file_info
->path
->str
);
1936 /* Create the IR stream objects for ctf_fs_trace. */
1938 static int create_streams_for_trace(struct ctf_fs_trace
*ctf_fs_trace
)
1941 GString
*name
= NULL
;
1944 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
1945 ctf_fs_ds_file_group
*ds_file_group
=
1946 (ctf_fs_ds_file_group
*) g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
1947 name
= get_stream_instance_unique_name(ds_file_group
);
1953 BT_ASSERT(ds_file_group
->sc
->ir_sc
);
1954 BT_ASSERT(ctf_fs_trace
->trace
);
1956 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
1957 /* No stream ID: use 0 */
1958 ds_file_group
->stream
= bt_stream_create_with_id(
1959 ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
, ctf_fs_trace
->next_stream_id
);
1960 ctf_fs_trace
->next_stream_id
++;
1962 /* Specific stream ID */
1963 ds_file_group
->stream
= bt_stream_create_with_id(
1964 ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
, (uint64_t) ds_file_group
->stream_id
);
1967 if (!ds_file_group
->stream
) {
1968 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1969 "Cannot create stream for DS file group: "
1970 "addr={}, stream-name=\"{}\"",
1971 fmt::ptr(ds_file_group
), name
->str
);
1975 ret
= bt_stream_set_name(ds_file_group
->stream
, name
->str
);
1977 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1978 "Cannot set stream's name: "
1979 "addr={}, stream-name=\"{}\"",
1980 fmt::ptr(ds_file_group
->stream
), name
->str
);
1984 g_string_free(name
, TRUE
);
1997 g_string_free(name
, TRUE
);
2002 static const bt_param_validation_value_descr inputs_elem_descr
=
2003 bt_param_validation_value_descr::makeString();
2005 static bt_param_validation_map_value_entry_descr fs_params_entries_descr
[] = {
2006 {"inputs", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
2007 bt_param_validation_value_descr::makeArray(1, BT_PARAM_VALIDATION_INFINITE
,
2008 inputs_elem_descr
)},
2009 {"trace-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2010 bt_param_validation_value_descr::makeString()},
2011 {"clock-class-offset-s", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2012 bt_param_validation_value_descr::makeSignedInteger()},
2013 {"clock-class-offset-ns", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2014 bt_param_validation_value_descr::makeSignedInteger()},
2015 {"force-clock-class-origin-unix-epoch", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2016 bt_param_validation_value_descr::makeBool()},
2017 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
2019 bool read_src_fs_parameters(const bt_value
*params
, const bt_value
**inputs
,
2020 const bt_value
**trace_name
, struct ctf_fs_component
*ctf_fs
)
2023 const bt_value
*value
;
2024 enum bt_param_validation_status validate_value_status
;
2025 gchar
*error
= NULL
;
2027 validate_value_status
= bt_param_validation_validate(params
, fs_params_entries_descr
, &error
);
2028 if (validate_value_status
!= BT_PARAM_VALIDATION_STATUS_OK
) {
2029 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "{}", error
);
2034 /* inputs parameter */
2035 *inputs
= bt_value_map_borrow_entry_value_const(params
, "inputs");
2037 /* clock-class-offset-s parameter */
2038 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-s");
2040 ctf_fs
->clkClsCfg
.offsetSec
= bt_value_integer_signed_get(value
);
2043 /* clock-class-offset-ns parameter */
2044 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-ns");
2046 ctf_fs
->clkClsCfg
.offsetNanoSec
= bt_value_integer_signed_get(value
);
2049 /* force-clock-class-origin-unix-epoch parameter */
2050 value
= bt_value_map_borrow_entry_value_const(params
, "force-clock-class-origin-unix-epoch");
2052 ctf_fs
->clkClsCfg
.forceOriginIsUnixEpoch
= bt_value_bool_get(value
);
2055 /* trace-name parameter */
2056 *trace_name
= bt_value_map_borrow_entry_value_const(params
, "trace-name");
2065 static ctf_fs_component::UP
ctf_fs_create(const bt_value
*params
,
2066 bt_self_component_source
*self_comp_src
)
2068 const bt_value
*inputs_value
;
2069 const bt_value
*trace_name_value
;
2070 bt_self_component
*self_comp
= bt_self_component_source_as_self_component(self_comp_src
);
2072 ctf_fs_component::UP ctf_fs
= ctf_fs_component_create(
2073 bt2c::Logger
{bt2::SelfSourceComponent
{self_comp_src
}, "PLUGIN/SRC.CTF.FS/COMP"});
2078 if (!read_src_fs_parameters(params
, &inputs_value
, &trace_name_value
, ctf_fs
.get())) {
2082 if (ctf_fs_component_create_ctf_fs_trace(ctf_fs
.get(), inputs_value
, trace_name_value
,
2087 if (create_streams_for_trace(ctf_fs
->trace
.get())) {
2091 if (create_ports_for_trace(ctf_fs
.get(), ctf_fs
->trace
.get(), self_comp_src
)) {
2098 bt_component_class_initialize_method_status
ctf_fs_init(bt_self_component_source
*self_comp_src
,
2099 bt_self_component_source_configuration
*,
2100 const bt_value
*params
, void *)
2103 bt_component_class_initialize_method_status ret
=
2104 BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
2106 ctf_fs_component::UP ctf_fs
= ctf_fs_create(params
, self_comp_src
);
2108 ret
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
2111 bt_self_component_set_data(bt_self_component_source_as_self_component(self_comp_src
),
2114 } catch (const std::bad_alloc
&) {
2115 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
2116 } catch (const bt2::Error
&) {
2117 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
2121 bt_component_class_query_method_status
ctf_fs_query(bt_self_component_class_source
*comp_class_src
,
2122 bt_private_query_executor
*priv_query_exec
,
2123 const char *object
, const bt_value
*params
,
2124 __attribute__((unused
)) void *method_data
,
2125 const bt_value
**result
)
2128 bt2c::Logger logger
{bt2::SelfComponentClass
{comp_class_src
},
2129 bt2::PrivateQueryExecutor
{priv_query_exec
},
2130 "PLUGIN/SRC.CTF.FS/QUERY"};
2131 bt2::ConstMapValue
paramsObj(params
);
2132 bt2::Value::Shared resultObj
;
2134 if (strcmp(object
, "metadata-info") == 0) {
2135 resultObj
= metadata_info_query(paramsObj
, logger
);
2136 } else if (strcmp(object
, "babeltrace.trace-infos") == 0) {
2137 resultObj
= trace_infos_query(paramsObj
, logger
);
2138 } else if (!strcmp(object
, "babeltrace.support-info")) {
2139 resultObj
= support_info_query(paramsObj
, logger
);
2141 BT_CPPLOGE_SPEC(logger
, "Unknown query object `{}`", object
);
2142 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;
2145 *result
= resultObj
.release().libObjPtr();
2147 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
2148 } catch (const std::bad_alloc
&) {
2149 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
2150 } catch (const bt2::Error
&) {
2151 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;