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
10 #define BT_CLOG_CFG logCfg
11 #define BT_LOG_TAG "PLUGIN/SRC.CTF.FS"
13 #include "common/common.h"
14 #include <babeltrace2/babeltrace.h>
15 #include "common/uuid.h"
17 #include "common/assert.h"
21 #include "metadata.hpp"
22 #include "data-stream-file.hpp"
24 #include "../common/src/metadata/tsdl/decoder.hpp"
25 #include "../common/src/metadata/tsdl/ctf-meta-configure-ir-trace.hpp"
26 #include "../common/src/msg-iter/msg-iter.hpp"
28 #include "plugins/common/param-validation/param-validation.h"
29 #include "cpp-common/cfg-logging.hpp"
30 #include "cpp-common/cfg-logging-error-reporting.hpp"
31 #include "cpp-common/exc.hpp"
32 #include "cpp-common/make-unique.hpp"
43 static void ctf_fs_msg_iter_data_destroy(struct ctf_fs_msg_iter_data
*msg_iter_data
)
49 if (msg_iter_data
->msg_iter
) {
50 ctf_msg_iter_destroy(msg_iter_data
->msg_iter
);
53 if (msg_iter_data
->msg_iter_medops_data
) {
54 ctf_fs_ds_group_medops_data_destroy(msg_iter_data
->msg_iter_medops_data
);
60 static bt_message_iterator_class_next_method_status
61 ctf_fs_iterator_next_one(struct ctf_fs_msg_iter_data
*msg_iter_data
, const bt_message
**out_msg
)
63 bt_message_iterator_class_next_method_status status
;
64 enum ctf_msg_iter_status msg_iter_status
;
65 const bt2_common::LogCfg
& logCfg
= msg_iter_data
->logCfg
;
67 msg_iter_status
= ctf_msg_iter_get_next_message(msg_iter_data
->msg_iter
, out_msg
);
69 switch (msg_iter_status
) {
70 case CTF_MSG_ITER_STATUS_OK
:
71 /* Cool, message has been written to *out_msg. */
72 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
75 case CTF_MSG_ITER_STATUS_EOF
:
76 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END
;
79 case CTF_MSG_ITER_STATUS_AGAIN
:
81 * Should not make it this far as this is
82 * medium-specific; there is nothing for the user to do
83 * and it should have been handled upstream.
87 case CTF_MSG_ITER_STATUS_ERROR
:
88 BT_CLOGE_APPEND_CAUSE("Failed to get next message from CTF message iterator.");
89 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
92 case CTF_MSG_ITER_STATUS_MEMORY_ERROR
:
93 BT_CLOGE_APPEND_CAUSE("Failed to get next message from CTF message iterator.");
94 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
105 bt_message_iterator_class_next_method_status
106 ctf_fs_iterator_next(bt_self_message_iterator
*iterator
, bt_message_array_const msgs
,
107 uint64_t capacity
, uint64_t *count
)
109 struct ctf_fs_msg_iter_data
*msg_iter_data
=
110 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(iterator
);
111 const bt2_common::LogCfg
& logCfg
= msg_iter_data
->logCfg
;
114 bt_message_iterator_class_next_method_status status
;
117 if (G_UNLIKELY(msg_iter_data
->next_saved_error
)) {
119 * Last time we were called, we hit an error but had some
120 * messages to deliver, so we stashed the error here. Return
123 BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(msg_iter_data
->next_saved_error
);
124 status
= msg_iter_data
->next_saved_status
;
129 status
= ctf_fs_iterator_next_one(msg_iter_data
, &msgs
[i
]);
130 if (status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
) {
133 } while (i
< capacity
&& status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
);
137 * Even if ctf_fs_iterator_next_one() returned something
138 * else than BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK, we
139 * accumulated message objects in the output
140 * message array, so we need to return
141 * BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK so that they are
142 * transfered to downstream. This other status occurs
143 * again the next time muxer_msg_iter_do_next() is
144 * called, possibly without any accumulated
145 * message, in which case we'll return it.
149 * Save this error for the next _next call. Assume that
150 * this component always appends error causes when
151 * returning an error status code, which will cause the
152 * current thread error to be non-NULL.
154 msg_iter_data
->next_saved_error
= bt_current_thread_take_error();
155 BT_ASSERT(msg_iter_data
->next_saved_error
);
156 msg_iter_data
->next_saved_status
= status
;
160 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
165 } catch (const std::bad_alloc
&) {
166 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
167 } catch (const bt2_common::Error
&) {
168 BT_CLOGE_APPEND_CAUSE("Failed to fetch next messages");
169 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
174 bt_message_iterator_class_seek_beginning_method_status
175 ctf_fs_iterator_seek_beginning(bt_self_message_iterator
*it
)
177 struct ctf_fs_msg_iter_data
*msg_iter_data
=
178 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(it
);
180 BT_ASSERT(msg_iter_data
);
182 const bt2_common::LogCfg
& logCfg
= msg_iter_data
->logCfg
;
185 ctf_msg_iter_reset(msg_iter_data
->msg_iter
);
186 ctf_fs_ds_group_medops_data_reset(msg_iter_data
->msg_iter_medops_data
);
188 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_OK
;
189 } catch (const std::bad_alloc
&) {
190 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_MEMORY_ERROR
;
191 } catch (const bt2_common::Error
&) {
192 BT_CLOGE_APPEND_CAUSE("Failed to seek beginning");
193 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_ERROR
;
198 void ctf_fs_iterator_finalize(bt_self_message_iterator
*it
)
200 ctf_fs_msg_iter_data_destroy(
201 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(it
));
204 static bt_message_iterator_class_initialize_method_status
205 ctf_msg_iter_medium_status_to_msg_iter_initialize_status(enum ctf_msg_iter_medium_status status
)
208 case CTF_MSG_ITER_MEDIUM_STATUS_EOF
:
209 case CTF_MSG_ITER_MEDIUM_STATUS_AGAIN
:
210 case CTF_MSG_ITER_MEDIUM_STATUS_ERROR
:
211 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
212 case CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
:
213 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
214 case CTF_MSG_ITER_MEDIUM_STATUS_OK
:
215 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
222 bt_message_iterator_class_initialize_method_status
223 ctf_fs_iterator_init(bt_self_message_iterator
*self_msg_iter
,
224 bt_self_message_iterator_configuration
*config
,
225 bt_self_component_port_output
*self_port
)
227 bt_self_component_port
*self_comp_port
=
228 bt_self_component_port_output_as_self_component_port(self_port
);
229 ctf_fs_port_data
*port_data
=
230 (ctf_fs_port_data
*) bt_self_component_port_get_data(self_comp_port
);
231 BT_ASSERT(port_data
);
233 bt2_common::LogCfg logCfg
{port_data
->ctf_fs
->logCfg
.logLevel(), *self_msg_iter
};
236 bt_message_iterator_class_initialize_method_status status
;
237 enum ctf_msg_iter_medium_status medium_status
;
239 ctf_fs_msg_iter_data
*msg_iter_data
= new ctf_fs_msg_iter_data
{logCfg
};
241 msg_iter_data
->self_msg_iter
= self_msg_iter
;
242 msg_iter_data
->ds_file_group
= port_data
->ds_file_group
;
245 ctf_fs_ds_group_medops_data_create(msg_iter_data
->ds_file_group
, self_msg_iter
, logCfg
,
246 &msg_iter_data
->msg_iter_medops_data
);
247 BT_ASSERT(medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_OK
||
248 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_ERROR
||
249 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
);
250 if (medium_status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
251 BT_CLOGE_APPEND_CAUSE("Failed to create ctf_fs_ds_group_medops");
252 status
= ctf_msg_iter_medium_status_to_msg_iter_initialize_status(medium_status
);
256 msg_iter_data
->msg_iter
= ctf_msg_iter_create(
257 msg_iter_data
->ds_file_group
->ctf_fs_trace
->metadata
->tc
,
258 bt_common_get_page_size(logCfg
.logLevel()) * 8, ctf_fs_ds_group_medops
,
259 msg_iter_data
->msg_iter_medops_data
, self_msg_iter
, logCfg
);
260 if (!msg_iter_data
->msg_iter
) {
261 BT_CLOGE_APPEND_CAUSE("Cannot create a CTF message iterator.");
262 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
267 * This iterator can seek forward if its stream class has a default
270 if (msg_iter_data
->ds_file_group
->sc
->default_clock_class
) {
271 bt_self_message_iterator_configuration_set_can_seek_forward(config
, true);
274 bt_self_message_iterator_set_data(self_msg_iter
, msg_iter_data
);
275 msg_iter_data
= NULL
;
277 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
281 bt_self_message_iterator_set_data(self_msg_iter
, NULL
);
284 ctf_fs_msg_iter_data_destroy(msg_iter_data
);
286 } catch (const std::bad_alloc
&) {
287 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
288 } catch (const bt2_common::Error
&) {
289 BT_CLOGE_APPEND_CAUSE("Failed to initialize iterator");
290 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
294 static void ctf_fs_trace_destroy(struct ctf_fs_trace
*ctf_fs_trace
)
300 BT_TRACE_PUT_REF_AND_RESET(ctf_fs_trace
->trace
);
302 if (ctf_fs_trace
->path
) {
303 g_string_free(ctf_fs_trace
->path
, TRUE
);
306 if (ctf_fs_trace
->metadata
) {
307 ctf_fs_metadata_fini(ctf_fs_trace
->metadata
);
308 delete ctf_fs_trace
->metadata
;
314 void ctf_fs_trace_deleter::operator()(ctf_fs_trace
*trace
)
316 ctf_fs_trace_destroy(trace
);
320 void ctf_fs_destroy(struct ctf_fs_component
*ctf_fs
)
329 void ctf_fs_component_deleter::operator()(ctf_fs_component
*comp
)
331 ctf_fs_destroy(comp
);
334 ctf_fs_component::UP
ctf_fs_component_create(const bt2_common::LogCfg
& logCfg
)
336 return ctf_fs_component::UP
{new ctf_fs_component
{logCfg
}};
339 void ctf_fs_finalize(bt_self_component_source
*component
)
341 ctf_fs_destroy((struct ctf_fs_component
*) bt_self_component_get_data(
342 bt_self_component_source_as_self_component(component
)));
345 bt2_common::GCharUP
ctf_fs_make_port_name(struct ctf_fs_ds_file_group
*ds_file_group
)
347 GString
*name
= g_string_new(NULL
);
350 * The unique port name is generated by concatenating unique identifiers
358 /* For the trace, use the uuid if present, else the path. */
359 if (ds_file_group
->ctf_fs_trace
->metadata
->tc
->is_uuid_set
) {
360 char uuid_str
[BT_UUID_STR_LEN
+ 1];
362 bt_uuid_to_str(ds_file_group
->ctf_fs_trace
->metadata
->tc
->uuid
, uuid_str
);
363 g_string_assign(name
, uuid_str
);
365 g_string_assign(name
, ds_file_group
->ctf_fs_trace
->path
->str
);
369 * For the stream class, use the id if present. We can omit this field
370 * otherwise, as there will only be a single stream class.
372 if (ds_file_group
->sc
->id
!= UINT64_C(-1)) {
373 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->sc
->id
);
376 /* For the stream, use the id if present, else, use the path. */
377 if (ds_file_group
->stream_id
!= UINT64_C(-1)) {
378 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->stream_id
);
380 BT_ASSERT(ds_file_group
->ds_file_infos
.size() == 1);
381 const ctf_fs_ds_file_info
& ds_file_info
= *ds_file_group
->ds_file_infos
[0];
382 g_string_append_printf(name
, " | %s", ds_file_info
.path
.c_str());
385 return bt2_common::GCharUP
{g_string_free(name
, FALSE
)};
388 static int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
389 struct ctf_fs_trace
*ctf_fs_trace
,
390 struct ctf_fs_ds_file_group
*ds_file_group
,
391 bt_self_component_source
*self_comp_src
)
394 ctf_fs_port_data::UP port_data
;
395 const bt2_common::LogCfg
& logCfg
= ctf_fs
->logCfg
;
397 bt2_common::GCharUP port_name
= ctf_fs_make_port_name(ds_file_group
);
402 BT_CLOGI("Creating one port named `%s`", port_name
.get());
404 /* Create output port for this file */
405 port_data
= bt2_common::makeUnique
<ctf_fs_port_data
>();
406 port_data
->ctf_fs
= ctf_fs
;
407 port_data
->ds_file_group
= ds_file_group
;
408 ret
= bt_self_component_source_add_output_port(self_comp_src
, port_name
.get(), port_data
.get(),
414 ctf_fs
->port_data
.emplace_back(std::move(port_data
));
424 static int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
425 struct ctf_fs_trace
*ctf_fs_trace
,
426 bt_self_component_source
*self_comp_src
)
429 const bt2_common::LogCfg
& logCfg
= ctf_fs
->logCfg
;
431 /* Create one output port for each stream file group */
432 for (ctf_fs_ds_file_group::UP
& ds_file_group
: ctf_fs_trace
->ds_file_groups
) {
433 ret
= create_one_port_for_trace(ctf_fs
, ctf_fs_trace
, ds_file_group
.get(), self_comp_src
);
435 BT_CLOGE_APPEND_CAUSE("Cannot create output port.");
445 * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right
446 * place to keep it sorted.
449 static void ds_file_group_insert_ds_file_info_sorted(struct ctf_fs_ds_file_group
*ds_file_group
,
450 ctf_fs_ds_file_info::UP ds_file_info
)
452 /* Find the spot where to insert this ds_file_info. */
453 auto it
= ds_file_group
->ds_file_infos
.begin();
455 for (; it
!= ds_file_group
->ds_file_infos
.end(); ++it
) {
456 const ctf_fs_ds_file_info
& other_ds_file_info
= **it
;
458 if (ds_file_info
->begin_ns
< other_ds_file_info
.begin_ns
) {
463 ds_file_group
->ds_file_infos
.insert(it
, std::move(ds_file_info
));
466 static bool ds_index_entries_equal(const struct ctf_fs_ds_index_entry
*left
,
467 const struct ctf_fs_ds_index_entry
*right
)
469 if (left
->packetSize
!= right
->packetSize
) {
473 if (left
->timestamp_begin
!= right
->timestamp_begin
) {
477 if (left
->timestamp_end
!= right
->timestamp_end
) {
481 if (left
->packet_seq_num
!= right
->packet_seq_num
) {
489 * Insert `entry` into `index`, without duplication.
491 * The entry is inserted only if there isn't an identical entry already.
493 * In any case, the ownership of `entry` is transferred to this function. So if
494 * the entry is not inserted, it is freed.
497 static void ds_index_insert_ds_index_entry_sorted(struct ctf_fs_ds_index
*index
,
498 ctf_fs_ds_index_entry::UP entry
)
500 /* Find the spot where to insert this index entry. */
501 auto otherEntry
= index
->entries
.begin();
502 for (; otherEntry
!= index
->entries
.end(); ++otherEntry
) {
503 if (entry
->timestamp_begin_ns
<= (*otherEntry
)->timestamp_begin_ns
) {
509 * Insert the entry only if a duplicate doesn't already exist.
511 * There can be duplicate packets if reading multiple overlapping
512 * snapshots of the same trace. We then want the index to contain
513 * a reference to only one copy of that packet.
515 if (otherEntry
== index
->entries
.end() ||
516 !ds_index_entries_equal(entry
.get(), otherEntry
->get())) {
517 index
->entries
.insert(otherEntry
, std::move(entry
));
521 static void merge_ctf_fs_ds_indexes(struct ctf_fs_ds_index
*dest
, ctf_fs_ds_index::UP src
)
523 for (ctf_fs_ds_index_entry::UP
& entry
: src
->entries
) {
524 ds_index_insert_ds_index_entry_sorted(dest
, std::move(entry
));
528 static int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
, const char *path
)
530 int64_t stream_instance_id
= -1;
531 int64_t begin_ns
= -1;
532 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
533 ctf_fs_ds_file_group::UP new_ds_file_group
;
535 struct ctf_fs_ds_file
*ds_file
= NULL
;
536 ctf_fs_ds_file_info::UP ds_file_info
;
537 ctf_fs_ds_index::UP index
;
538 struct ctf_msg_iter
*msg_iter
= NULL
;
539 struct ctf_stream_class
*sc
= NULL
;
540 struct ctf_msg_iter_packet_properties props
;
541 const bt2_common::LogCfg
& logCfg
= ctf_fs_trace
->logCfg
;
544 * Create a temporary ds_file to read some properties about the data
547 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, nonstd::nullopt
, path
, logCfg
);
552 /* Create a temporary iterator to read the ds_file. */
553 msg_iter
= ctf_msg_iter_create(ctf_fs_trace
->metadata
->tc
,
554 bt_common_get_page_size(logCfg
.logLevel()) * 8,
555 ctf_fs_ds_file_medops
, ds_file
, nullptr, logCfg
);
557 BT_CLOGE_STR("Cannot create a CTF message iterator.");
561 ctf_msg_iter_set_dry_run(msg_iter
, true);
563 ret
= ctf_msg_iter_get_packet_properties(msg_iter
, &props
);
565 BT_CLOGE_APPEND_CAUSE(
566 "Cannot get stream file's first packet's header and context fields (`%s`).", path
);
570 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
, props
.stream_class_id
);
572 stream_instance_id
= props
.data_stream_id
;
574 if (props
.snapshots
.beginning_clock
!= UINT64_C(-1)) {
575 BT_ASSERT(sc
->default_clock_class
);
576 ret
= bt_util_clock_cycles_to_ns_from_origin(
577 props
.snapshots
.beginning_clock
, sc
->default_clock_class
->frequency
,
578 sc
->default_clock_class
->offset_seconds
, sc
->default_clock_class
->offset_cycles
,
581 BT_CLOGE_APPEND_CAUSE("Cannot convert clock cycles to nanoseconds from origin (`%s`).",
587 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
);
592 index
= ctf_fs_ds_file_build_index(ds_file
, ds_file_info
.get(), msg_iter
);
594 BT_CLOGE_APPEND_CAUSE("Failed to index CTF stream file \'%s\'", ds_file
->file
->path
->str
);
598 if (begin_ns
== -1) {
600 * No beginning timestamp to sort the stream files
601 * within a stream file group, so consider that this
602 * file must be the only one within its group.
604 stream_instance_id
= -1;
607 if (stream_instance_id
== -1) {
609 * No stream instance ID or no beginning timestamp:
610 * create a unique stream file group for this stream
611 * file because, even if there's a stream instance ID,
612 * there's no timestamp to order the file within its
616 ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, UINT64_C(-1), std::move(index
));
618 if (!new_ds_file_group
) {
622 ds_file_group_insert_ds_file_info_sorted(new_ds_file_group
.get(), std::move(ds_file_info
));
623 ctf_fs_trace
->ds_file_groups
.emplace_back(std::move(new_ds_file_group
));
627 BT_ASSERT(stream_instance_id
!= -1);
628 BT_ASSERT(begin_ns
!= -1);
630 /* Find an existing stream file group with this ID */
631 for (ctf_fs_ds_file_group::UP
& candidate
: ctf_fs_trace
->ds_file_groups
) {
632 if (candidate
->sc
== sc
&& candidate
->stream_id
== stream_instance_id
) {
633 ds_file_group
= candidate
.get();
638 if (!ds_file_group
) {
640 ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, stream_instance_id
, std::move(index
));
641 if (!new_ds_file_group
) {
645 ds_file_group
= new_ds_file_group
.get();
646 ctf_fs_trace
->ds_file_groups
.emplace_back(std::move(new_ds_file_group
));
648 merge_ctf_fs_ds_indexes(ds_file_group
->index
.get(), std::move(index
));
651 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, std::move(ds_file_info
));
659 ctf_fs_ds_file_destroy(ds_file
);
662 ctf_msg_iter_destroy(msg_iter
);
668 static int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
671 const char *basename
;
672 GError
*error
= NULL
;
674 const bt2_common::LogCfg
& logCfg
= ctf_fs_trace
->logCfg
;
676 /* Check each file in the path directory, except specific ones */
677 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
679 BT_CLOGE_APPEND_CAUSE("Cannot open directory `%s`: %s (code %d)", ctf_fs_trace
->path
->str
,
680 error
->message
, error
->code
);
684 while ((basename
= g_dir_read_name(dir
))) {
685 if (strcmp(basename
, CTF_FS_METADATA_FILENAME
) == 0) {
686 /* Ignore the metadata stream. */
687 BT_CLOGI("Ignoring metadata file `%s" G_DIR_SEPARATOR_S
"%s`", ctf_fs_trace
->path
->str
,
692 if (basename
[0] == '.') {
693 BT_CLOGI("Ignoring hidden file `%s" G_DIR_SEPARATOR_S
"%s`", ctf_fs_trace
->path
->str
,
698 /* Create the file. */
699 ctf_fs_file::UP file
= ctf_fs_file_create(logCfg
);
701 BT_CLOGE_APPEND_CAUSE("Cannot create stream file object for file `%s" G_DIR_SEPARATOR_S
703 ctf_fs_trace
->path
->str
, basename
);
707 /* Create full path string. */
708 g_string_append_printf(file
->path
, "%s" G_DIR_SEPARATOR_S
"%s", ctf_fs_trace
->path
->str
,
710 if (!g_file_test(file
->path
->str
, G_FILE_TEST_IS_REGULAR
)) {
711 BT_CLOGI("Ignoring non-regular file `%s`", file
->path
->str
);
715 ret
= ctf_fs_file_open(file
.get(), "rb");
717 BT_CLOGE_APPEND_CAUSE("Cannot open stream file `%s`", file
->path
->str
);
721 if (file
->size
== 0) {
722 /* Skip empty stream. */
723 BT_CLOGI("Ignoring empty file `%s`", file
->path
->str
);
727 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
, file
->path
->str
);
729 BT_CLOGE_APPEND_CAUSE("Cannot add stream file `%s` to stream file group",
753 static int set_trace_name(bt_trace
*trace
, const char *name_suffix
,
754 const bt2_common::LogCfg
& logCfg
)
760 name
= g_string_new(NULL
);
762 BT_CLOGE_STR("Failed to allocate a GString.");
768 * Check if we have a trace environment string value named `hostname`.
769 * If so, use it as the trace name's prefix.
771 val
= bt_trace_borrow_environment_entry_value_by_name_const(trace
, "hostname");
772 if (val
&& bt_value_is_string(val
)) {
773 g_string_append(name
, bt_value_string_get(val
));
776 g_string_append_c(name
, G_DIR_SEPARATOR
);
781 g_string_append(name
, name_suffix
);
784 ret
= bt_trace_set_name(trace
, name
->str
);
793 g_string_free(name
, TRUE
);
799 static ctf_fs_trace::UP
ctf_fs_trace_create(const char *path
, const char *name
,
800 ctf::src::ClkClsCfg clkClsCfg
,
801 bt_self_component
*selfComp
,
802 const bt2_common::LogCfg
& logCfg
)
806 ctf_fs_trace::UP ctf_fs_trace
{new struct ctf_fs_trace(logCfg
)};
807 ctf_fs_trace
->path
= g_string_new(path
);
808 if (!ctf_fs_trace
->path
) {
812 ctf_fs_trace
->metadata
= new ctf_fs_metadata
;
813 ctf_fs_metadata_init(ctf_fs_trace
->metadata
);
815 ret
= ctf_fs_metadata_set_trace_class(ctf_fs_trace
.get(), clkClsCfg
, selfComp
, logCfg
);
820 if (ctf_fs_trace
->metadata
->trace_class
) {
821 ctf_fs_trace
->trace
= bt_trace_create(ctf_fs_trace
->metadata
->trace_class
);
822 if (!ctf_fs_trace
->trace
) {
827 if (ctf_fs_trace
->trace
) {
828 ret
= ctf_trace_class_configure_ir_trace(ctf_fs_trace
->metadata
->tc
, ctf_fs_trace
->trace
);
833 ret
= set_trace_name(ctf_fs_trace
->trace
, name
, logCfg
);
839 ret
= create_ds_file_groups(ctf_fs_trace
.get());
847 ctf_fs_trace
.reset();
853 static int path_is_ctf_trace(const char *path
)
855 GString
*metadata_path
= g_string_new(NULL
);
858 if (!metadata_path
) {
863 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
865 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
871 g_string_free(metadata_path
, TRUE
);
875 /* Helper for ctf_fs_component_create_ctf_fs_trace, to handle a single path. */
877 static int ctf_fs_component_create_ctf_fs_trace_one_path(struct ctf_fs_component
*ctf_fs
,
878 const char *path_param
,
879 const char *trace_name
,
880 std::vector
<ctf_fs_trace::UP
>& traces
,
881 bt_self_component
*selfComp
)
883 ctf_fs_trace::UP ctf_fs_trace
;
886 const bt2_common::LogCfg
& logCfg
= ctf_fs
->logCfg
;
888 norm_path
= bt_common_normalize_path(path_param
, NULL
);
890 BT_CLOGE_APPEND_CAUSE("Failed to normalize path: `%s`.", path_param
);
894 ret
= path_is_ctf_trace(norm_path
->str
);
896 BT_CLOGE_APPEND_CAUSE("Failed to check if path is a CTF trace: path=%s", norm_path
->str
);
898 } else if (ret
== 0) {
899 BT_CLOGE_APPEND_CAUSE("Path is not a CTF trace (does not contain a metadata file): `%s`.",
904 // FIXME: Remove or ifdef for __MINGW32__
905 if (strcmp(norm_path
->str
, "/") == 0) {
906 BT_CLOGE_APPEND_CAUSE("Opening a trace in `/` is not supported.");
912 ctf_fs_trace_create(norm_path
->str
, trace_name
, ctf_fs
->clkClsCfg
, selfComp
, logCfg
);
914 BT_CLOGE_APPEND_CAUSE("Cannot create trace for `%s`.", norm_path
->str
);
918 traces
.emplace_back(std::move(ctf_fs_trace
));
928 g_string_free(norm_path
, TRUE
);
935 * Count the number of stream and event classes defined by this trace's metadata.
937 * This is used to determine which metadata is the "latest", out of multiple
938 * traces sharing the same UUID. It is assumed that amongst all these metadatas,
939 * a bigger metadata is a superset of a smaller metadata. Therefore, it is
940 * enough to just count the classes.
943 static unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace
*trace
)
945 unsigned int num
= trace
->metadata
->tc
->stream_classes
->len
;
948 for (i
= 0; i
< trace
->metadata
->tc
->stream_classes
->len
; i
++) {
949 struct ctf_stream_class
*sc
=
950 (struct ctf_stream_class
*) trace
->metadata
->tc
->stream_classes
->pdata
[i
];
951 num
+= sc
->event_classes
->len
;
958 * Merge the src ds_file_group into dest. This consists of merging their
959 * ds_file_infos, making sure to keep the result sorted.
962 static void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group
*dest
,
963 ctf_fs_ds_file_group::UP src
)
965 for (ctf_fs_ds_file_info::UP
& ds_file_info
: src
->ds_file_infos
) {
966 ds_file_group_insert_ds_file_info_sorted(dest
, std::move(ds_file_info
));
969 /* Merge both indexes. */
970 merge_ctf_fs_ds_indexes(dest
->index
.get(), std::move(src
->index
));
973 /* Merge src_trace's data stream file groups into dest_trace's. */
975 static int merge_matching_ctf_fs_ds_file_groups(struct ctf_fs_trace
*dest_trace
,
976 ctf_fs_trace::UP src_trace
)
978 std::vector
<ctf_fs_ds_file_group::UP
>& dest
= dest_trace
->ds_file_groups
;
979 std::vector
<ctf_fs_ds_file_group::UP
>& src
= src_trace
->ds_file_groups
;
983 * Save the initial length of dest: we only want to check against the
984 * original elements in the inner loop.
986 size_t dest_len
= dest
.size();
988 for (ctf_fs_ds_file_group::UP
& src_group
: src
) {
989 struct ctf_fs_ds_file_group
*dest_group
= NULL
;
991 /* A stream instance without ID can't match a stream in the other trace. */
992 if (src_group
->stream_id
!= -1) {
993 /* Let's search for a matching ds_file_group in the destination. */
994 for (size_t d_i
= 0; d_i
< dest_len
; ++d_i
) {
995 ctf_fs_ds_file_group
*candidate_dest
= dest
[d_i
].get();
997 /* Can't match a stream instance without ID. */
998 if (candidate_dest
->stream_id
== -1) {
1003 * If the two groups have the same stream instance id
1004 * and belong to the same stream class (stream instance
1005 * ids are per-stream class), they represent the same
1008 if (candidate_dest
->stream_id
!= src_group
->stream_id
||
1009 candidate_dest
->sc
->id
!= src_group
->sc
->id
) {
1013 dest_group
= candidate_dest
;
1019 * Didn't find a friend in dest to merge our src_group into?
1020 * Create a new empty one. This can happen if a stream was
1021 * active in the source trace chunk but not in the destination
1025 struct ctf_stream_class
*sc
;
1027 sc
= ctf_trace_class_borrow_stream_class_by_id(dest_trace
->metadata
->tc
,
1031 ctf_fs_ds_index::UP index
= ctf_fs_ds_index_create(dest_trace
->logCfg
);
1037 ctf_fs_ds_file_group::UP new_dest_group
=
1038 ctf_fs_ds_file_group_create(dest_trace
, sc
, src_group
->stream_id
, std::move(index
));
1039 /* Ownership of index is transferred. */
1041 if (!new_dest_group
) {
1046 dest_group
= new_dest_group
.get();
1047 dest_trace
->ds_file_groups
.emplace_back(std::move(new_dest_group
));
1050 BT_ASSERT(dest_group
);
1051 merge_ctf_fs_ds_file_groups(dest_group
, std::move(src_group
));
1059 * Collapse the given traces, which must all share the same UUID, in a single
1062 * The trace with the most expansive metadata is chosen and all other traces
1063 * are merged into that one. On return, the elements of `traces` are nullptr
1064 * and the merged trace is placed in `out_trace`.
1067 static int merge_ctf_fs_traces(std::vector
<ctf_fs_trace::UP
> traces
, ctf_fs_trace::UP
& out_trace
)
1069 unsigned int winner_count
;
1070 struct ctf_fs_trace
*winner
;
1074 BT_ASSERT(traces
.size() >= 2);
1076 winner_count
= metadata_count_stream_and_event_classes(traces
[0].get());
1077 winner
= traces
[0].get();
1080 /* Find the trace with the largest metadata. */
1081 for (i
= 1; i
< traces
.size(); i
++) {
1082 ctf_fs_trace
*candidate
= traces
[i
].get();
1083 unsigned int candidate_count
;
1085 /* A bit of sanity check. */
1086 BT_ASSERT(bt_uuid_compare(winner
->metadata
->tc
->uuid
, candidate
->metadata
->tc
->uuid
) == 0);
1088 candidate_count
= metadata_count_stream_and_event_classes(candidate
);
1090 if (candidate_count
> winner_count
) {
1091 winner_count
= candidate_count
;
1097 /* Merge all the other traces in the winning trace. */
1098 for (ctf_fs_trace::UP
& trace
: traces
) {
1099 /* Don't merge the winner into itself. */
1100 if (trace
.get() == winner
) {
1104 /* Merge trace's data stream file groups into winner's. */
1105 ret
= merge_matching_ctf_fs_ds_file_groups(winner
, std::move(trace
));
1112 * Move the winner out of the array, into `*out_trace`.
1114 out_trace
= std::move(traces
[winner_i
]);
1126 static int decode_clock_snapshot_after_event(struct ctf_fs_trace
*ctf_fs_trace
,
1127 struct ctf_clock_class
*default_cc
,
1128 struct ctf_fs_ds_index_entry
*index_entry
,
1129 enum target_event target_event
, uint64_t *cs
,
1132 enum ctf_msg_iter_status iter_status
= CTF_MSG_ITER_STATUS_OK
;
1133 struct ctf_fs_ds_file
*ds_file
= NULL
;
1134 struct ctf_msg_iter
*msg_iter
= NULL
;
1135 const bt2_common::LogCfg
& logCfg
= ctf_fs_trace
->logCfg
;
1138 BT_ASSERT(ctf_fs_trace
);
1139 BT_ASSERT(index_entry
);
1140 BT_ASSERT(index_entry
->path
);
1142 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, nonstd::nullopt
, index_entry
->path
, logCfg
);
1144 BT_CLOGE_APPEND_CAUSE("Failed to create a ctf_fs_ds_file");
1149 BT_ASSERT(ctf_fs_trace
->metadata
);
1150 BT_ASSERT(ctf_fs_trace
->metadata
->tc
);
1152 msg_iter
= ctf_msg_iter_create(ctf_fs_trace
->metadata
->tc
,
1153 bt_common_get_page_size(logCfg
.logLevel()) * 8,
1154 ctf_fs_ds_file_medops
, ds_file
, NULL
, logCfg
);
1156 /* ctf_msg_iter_create() logs errors. */
1162 * Turn on dry run mode to prevent the creation and usage of Babeltrace
1163 * library objects (bt_field, bt_message_*, etc.).
1165 ctf_msg_iter_set_dry_run(msg_iter
, true);
1167 /* Seek to the beginning of the target packet. */
1168 iter_status
= ctf_msg_iter_seek(msg_iter
, index_entry
->offset
.bytes());
1170 /* ctf_msg_iter_seek() logs errors. */
1175 switch (target_event
) {
1178 * Start to decode the packet until we reach the end of
1179 * the first event. To extract the first event's clock
1182 iter_status
= ctf_msg_iter_curr_packet_first_event_clock_snapshot(msg_iter
, cs
);
1185 /* Decode the packet to extract the last event's clock snapshot. */
1186 iter_status
= ctf_msg_iter_curr_packet_last_event_clock_snapshot(msg_iter
, cs
);
1196 /* Convert clock snapshot to timestamp. */
1197 ret
= bt_util_clock_cycles_to_ns_from_origin(
1198 *cs
, default_cc
->frequency
, default_cc
->offset_seconds
, default_cc
->offset_cycles
, ts_ns
);
1200 BT_CLOGE_APPEND_CAUSE("Failed to convert clock snapshot to timestamp");
1206 ctf_fs_ds_file_destroy(ds_file
);
1209 ctf_msg_iter_destroy(msg_iter
);
1215 static int decode_packet_first_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1216 struct ctf_clock_class
*default_cc
,
1217 struct ctf_fs_ds_index_entry
*index_entry
,
1218 uint64_t *cs
, int64_t *ts_ns
)
1220 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, FIRST_EVENT
, cs
,
1224 static int decode_packet_last_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1225 struct ctf_clock_class
*default_cc
,
1226 struct ctf_fs_ds_index_entry
*index_entry
,
1227 uint64_t *cs
, int64_t *ts_ns
)
1229 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, LAST_EVENT
, cs
,
1234 * Fix up packet index entries for lttng's "event-after-packet" bug.
1235 * Some buggy lttng tracer versions may emit events with a timestamp that is
1236 * larger (after) than the timestamp_end of the their packets.
1238 * To fix up this erroneous data we do the following:
1239 * 1. If it's not the stream file's last packet: set the packet index entry's
1240 * end time to the next packet's beginning time.
1241 * 2. If it's the stream file's last packet, set the packet index entry's end
1242 * time to the packet's last event's time, if any, or to the packet's
1243 * beginning time otherwise.
1245 * Known buggy tracer versions:
1246 * - before lttng-ust 2.11.0
1247 * - before lttng-module 2.11.0
1248 * - before lttng-module 2.10.10
1249 * - before lttng-module 2.9.13
1251 static int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace
*trace
)
1254 const bt2_common::LogCfg
& logCfg
= trace
->logCfg
;
1256 for (ctf_fs_ds_file_group::UP
& ds_file_group
: trace
->ds_file_groups
) {
1257 struct ctf_clock_class
*default_cc
;
1258 struct ctf_fs_ds_index
*index
;
1260 BT_ASSERT(ds_file_group
);
1261 index
= ds_file_group
->index
.get();
1264 BT_ASSERT(!index
->entries
.empty());
1267 * Iterate over all entries but the last one. The last one is
1268 * fixed differently after.
1270 for (size_t entry_i
= 0; entry_i
< index
->entries
.size() - 1; ++entry_i
) {
1271 ctf_fs_ds_index_entry
*curr_entry
= index
->entries
[entry_i
].get();
1272 ctf_fs_ds_index_entry
*next_entry
= index
->entries
[entry_i
+ 1].get();
1275 * 1. Set the current index entry `end` timestamp to
1276 * the next index entry `begin` timestamp.
1278 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1279 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1283 * 2. Fix the last entry by decoding the last event of the last
1286 ctf_fs_ds_index_entry
*last_entry
= index
->entries
.back().get();
1287 BT_ASSERT(last_entry
);
1289 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1290 default_cc
= ds_file_group
->sc
->default_clock_class
;
1293 * Decode packet to read the timestamp of the last event of the
1296 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1297 &last_entry
->timestamp_end
,
1298 &last_entry
->timestamp_end_ns
);
1300 BT_CLOGE_APPEND_CAUSE(
1301 "Failed to decode stream's last packet to get its last event's clock snapshot.");
1311 * Fix up packet index entries for barectf's "event-before-packet" bug.
1312 * Some buggy barectf tracer versions may emit events with a timestamp that is
1313 * less than the timestamp_begin of the their packets.
1315 * To fix up this erroneous data we do the following:
1316 * 1. Starting at the second index entry, set the timestamp_begin of the
1317 * current entry to the timestamp of the first event of the packet.
1318 * 2. Set the previous entry's timestamp_end to the timestamp_begin of the
1321 * Known buggy tracer versions:
1322 * - before barectf 2.3.1
1324 static int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace
*trace
)
1327 const bt2_common::LogCfg
& logCfg
= trace
->logCfg
;
1329 for (ctf_fs_ds_file_group::UP
& ds_file_group
: trace
->ds_file_groups
) {
1330 struct ctf_clock_class
*default_cc
;
1331 struct ctf_fs_ds_index
*index
= ds_file_group
->index
.get();
1334 BT_ASSERT(!index
->entries
.empty());
1336 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1337 default_cc
= ds_file_group
->sc
->default_clock_class
;
1340 * 1. Iterate over the index, starting from the second entry
1343 for (size_t entry_i
= 1; entry_i
< index
->entries
.size(); ++entry_i
) {
1344 ctf_fs_ds_index_entry
*prev_entry
= index
->entries
[entry_i
- 1].get();
1345 ctf_fs_ds_index_entry
*curr_entry
= index
->entries
[entry_i
].get();
1347 * 2. Set the current entry `begin` timestamp to the
1348 * timestamp of the first event of the current packet.
1350 ret
= decode_packet_first_event_timestamp(trace
, default_cc
, curr_entry
,
1351 &curr_entry
->timestamp_begin
,
1352 &curr_entry
->timestamp_begin_ns
);
1354 BT_CLOGE_APPEND_CAUSE("Failed to decode first event's clock snapshot");
1359 * 3. Set the previous entry `end` timestamp to the
1360 * timestamp of the first event of the current packet.
1362 prev_entry
->timestamp_end
= curr_entry
->timestamp_begin
;
1363 prev_entry
->timestamp_end_ns
= curr_entry
->timestamp_begin_ns
;
1371 * When using the lttng-crash feature it's likely that the last packets of each
1372 * stream have their timestamp_end set to zero. This is caused by the fact that
1373 * the tracer crashed and was not able to properly close the packets.
1375 * To fix up this erroneous data we do the following:
1376 * For each index entry, if the entry's timestamp_end is 0 and the
1377 * timestamp_begin is not 0:
1378 * - If it's the stream file's last packet: set the packet index entry's end
1379 * time to the packet's last event's time, if any, or to the packet's
1380 * beginning time otherwise.
1381 * - If it's not the stream file's last packet: set the packet index
1382 * entry's end time to the next packet's beginning time.
1384 * Affected versions:
1385 * - All current and future lttng-ust and lttng-modules versions.
1387 static int fix_index_lttng_crash_quirk(struct ctf_fs_trace
*trace
)
1390 const bt2_common::LogCfg
& logCfg
= trace
->logCfg
;
1392 for (ctf_fs_ds_file_group::UP
& ds_file_group
: trace
->ds_file_groups
) {
1393 struct ctf_clock_class
*default_cc
;
1394 struct ctf_fs_ds_index
*index
;
1396 BT_ASSERT(ds_file_group
);
1397 index
= ds_file_group
->index
.get();
1399 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1400 default_cc
= ds_file_group
->sc
->default_clock_class
;
1403 BT_ASSERT(!index
->entries
.empty());
1405 ctf_fs_ds_index_entry
*last_entry
= index
->entries
.back().get();
1406 BT_ASSERT(last_entry
);
1408 /* 1. Fix the last entry first. */
1409 if (last_entry
->timestamp_end
== 0 && last_entry
->timestamp_begin
!= 0) {
1411 * Decode packet to read the timestamp of the
1412 * last event of the stream file.
1414 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1415 &last_entry
->timestamp_end
,
1416 &last_entry
->timestamp_end_ns
);
1418 BT_CLOGE_APPEND_CAUSE("Failed to decode last event's clock snapshot");
1423 /* Iterate over all entries but the last one. */
1424 for (size_t entry_idx
= 0; entry_idx
< index
->entries
.size() - 1; ++entry_idx
) {
1425 ctf_fs_ds_index_entry
*curr_entry
= index
->entries
[entry_idx
].get();
1426 ctf_fs_ds_index_entry
*next_entry
= index
->entries
[entry_idx
+ 1].get();
1428 if (curr_entry
->timestamp_end
== 0 && curr_entry
->timestamp_begin
!= 0) {
1430 * 2. Set the current index entry `end` timestamp to
1431 * the next index entry `begin` timestamp.
1433 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1434 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1444 * Extract the tracer information necessary to compare versions.
1445 * Returns 0 on success, and -1 if the extraction is not successful because the
1446 * necessary fields are absents in the trace metadata.
1448 static int extract_tracer_info(struct ctf_fs_trace
*trace
, struct tracer_info
*current_tracer_info
)
1451 struct ctf_trace_class_env_entry
*entry
;
1453 /* Clear the current_tracer_info struct */
1454 memset(current_tracer_info
, 0, sizeof(*current_tracer_info
));
1457 * To compare 2 tracer versions, at least the tracer name and it's
1458 * major version are needed. If one of these is missing, consider it an
1459 * extraction failure.
1461 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_name");
1462 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR
) {
1463 goto missing_bare_minimum
;
1466 /* Set tracer name. */
1467 current_tracer_info
->name
= entry
->value
.str
->str
;
1469 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_major");
1470 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1471 goto missing_bare_minimum
;
1474 /* Set major version number. */
1475 current_tracer_info
->major
= entry
->value
.i
;
1477 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_minor");
1478 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1482 /* Set minor version number. */
1483 current_tracer_info
->minor
= entry
->value
.i
;
1485 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patch");
1488 * If `tracer_patch` doesn't exist `tracer_patchlevel` might.
1489 * For example, `lttng-modules` uses entry name
1490 * `tracer_patchlevel`.
1492 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patchlevel");
1495 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1499 /* Set patch version number. */
1500 current_tracer_info
->patch
= entry
->value
.i
;
1504 missing_bare_minimum
:
1510 static bool is_tracer_affected_by_lttng_event_after_packet_bug(struct tracer_info
*curr_tracer_info
)
1512 bool is_affected
= false;
1514 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1515 if (curr_tracer_info
->major
< 2) {
1517 } else if (curr_tracer_info
->major
== 2) {
1518 /* fixed in lttng-ust 2.11.0 */
1519 if (curr_tracer_info
->minor
< 11) {
1523 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1524 if (curr_tracer_info
->major
< 2) {
1526 } else if (curr_tracer_info
->major
== 2) {
1527 /* fixed in lttng-modules 2.11.0 */
1528 if (curr_tracer_info
->minor
== 10) {
1529 /* fixed in lttng-modules 2.10.10 */
1530 if (curr_tracer_info
->patch
< 10) {
1533 } else if (curr_tracer_info
->minor
== 9) {
1534 /* fixed in lttng-modules 2.9.13 */
1535 if (curr_tracer_info
->patch
< 13) {
1538 } else if (curr_tracer_info
->minor
< 9) {
1548 is_tracer_affected_by_barectf_event_before_packet_bug(struct tracer_info
*curr_tracer_info
)
1550 bool is_affected
= false;
1552 if (strcmp(curr_tracer_info
->name
, "barectf") == 0) {
1553 if (curr_tracer_info
->major
< 2) {
1555 } else if (curr_tracer_info
->major
== 2) {
1556 if (curr_tracer_info
->minor
< 3) {
1558 } else if (curr_tracer_info
->minor
== 3) {
1559 /* fixed in barectf 2.3.1 */
1560 if (curr_tracer_info
->patch
< 1) {
1570 static bool is_tracer_affected_by_lttng_crash_quirk(struct tracer_info
*curr_tracer_info
)
1572 bool is_affected
= false;
1574 /* All LTTng tracer may be affected by this lttng crash quirk. */
1575 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1577 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1585 * Looks for trace produced by known buggy tracers and fix up the index
1588 static int fix_packet_index_tracer_bugs(struct ctf_fs_component
*ctf_fs
)
1591 struct tracer_info current_tracer_info
;
1592 const bt2_common::LogCfg
& logCfg
= ctf_fs
->logCfg
;
1594 ret
= extract_tracer_info(ctf_fs
->trace
.get(), ¤t_tracer_info
);
1597 * A trace may not have all the necessary environment
1598 * entries to do the tracer version comparison.
1599 * At least, the tracer name and major version number
1600 * are needed. Failing to extract these entries is not
1604 BT_LOGI_STR("Cannot extract tracer information necessary to compare with buggy versions.");
1609 /* Check if the trace may be affected by old tracer bugs. */
1610 if (is_tracer_affected_by_lttng_event_after_packet_bug(¤t_tracer_info
)) {
1611 BT_LOGI_STR("Trace may be affected by LTTng tracer packet timestamp bug. Fixing up.");
1612 ret
= fix_index_lttng_event_after_packet_bug(ctf_fs
->trace
.get());
1614 BT_CLOGE_APPEND_CAUSE("Failed to fix LTTng event-after-packet bug.");
1617 ctf_fs
->trace
->metadata
->tc
->quirks
.lttng_event_after_packet
= true;
1620 if (is_tracer_affected_by_barectf_event_before_packet_bug(¤t_tracer_info
)) {
1621 BT_LOGI_STR("Trace may be affected by barectf tracer packet timestamp bug. Fixing up.");
1622 ret
= fix_index_barectf_event_before_packet_bug(ctf_fs
->trace
.get());
1624 BT_CLOGE_APPEND_CAUSE("Failed to fix barectf event-before-packet bug.");
1627 ctf_fs
->trace
->metadata
->tc
->quirks
.barectf_event_before_packet
= true;
1630 if (is_tracer_affected_by_lttng_crash_quirk(¤t_tracer_info
)) {
1631 ret
= fix_index_lttng_crash_quirk(ctf_fs
->trace
.get());
1633 BT_CLOGE_APPEND_CAUSE("Failed to fix lttng-crash timestamp quirks.");
1636 ctf_fs
->trace
->metadata
->tc
->quirks
.lttng_crash
= true;
1643 static bool compare_ds_file_groups_by_first_path(const ctf_fs_ds_file_group::UP
& ds_file_group_a
,
1644 const ctf_fs_ds_file_group::UP
& ds_file_group_b
)
1646 BT_ASSERT(!ds_file_group_a
->ds_file_infos
.empty());
1647 BT_ASSERT(!ds_file_group_b
->ds_file_infos
.empty());
1649 const ctf_fs_ds_file_info
& first_ds_file_info_a
= *ds_file_group_a
->ds_file_infos
[0];
1650 const ctf_fs_ds_file_info
& first_ds_file_info_b
= *ds_file_group_b
->ds_file_infos
[0];
1652 return first_ds_file_info_a
.path
< first_ds_file_info_b
.path
;
1655 static gint
compare_strings(gconstpointer p_a
, gconstpointer p_b
)
1657 const char *a
= *((const char **) p_a
);
1658 const char *b
= *((const char **) p_b
);
1660 return strcmp(a
, b
);
1663 int ctf_fs_component_create_ctf_fs_trace(struct ctf_fs_component
*ctf_fs
,
1664 const bt_value
*paths_value
,
1665 const bt_value
*trace_name_value
,
1666 bt_self_component
*selfComp
)
1670 const bt2_common::LogCfg
& logCfg
= ctf_fs
->logCfg
;
1671 GPtrArray
*paths
= NULL
;
1672 std::vector
<ctf_fs_trace::UP
> traces
;
1673 const char *trace_name
;
1675 BT_ASSERT(bt_value_get_type(paths_value
) == BT_VALUE_TYPE_ARRAY
);
1676 BT_ASSERT(!bt_value_array_is_empty(paths_value
));
1678 paths
= g_ptr_array_new_with_free_func(g_free
);
1680 BT_CLOGE_APPEND_CAUSE("Failed to allocate a GPtrArray.");
1684 trace_name
= trace_name_value
? bt_value_string_get(trace_name_value
) : NULL
;
1687 * Create a sorted array of the paths, to make the execution of this
1688 * component deterministic.
1690 for (i
= 0; i
< bt_value_array_get_length(paths_value
); i
++) {
1691 const bt_value
*path_value
= bt_value_array_borrow_element_by_index_const(paths_value
, i
);
1692 const char *input
= bt_value_string_get(path_value
);
1695 input_copy
= g_strdup(input
);
1697 BT_CLOGE_APPEND_CAUSE("Failed to copy a string.");
1701 g_ptr_array_add(paths
, input_copy
);
1704 g_ptr_array_sort(paths
, compare_strings
);
1706 /* Create a separate ctf_fs_trace object for each path. */
1707 for (i
= 0; i
< paths
->len
; i
++) {
1708 const char *path
= (const char *) g_ptr_array_index(paths
, i
);
1710 ret
= ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs
, path
, trace_name
, traces
,
1717 if (traces
.size() > 1) {
1718 ctf_fs_trace
*first_trace
= traces
[0].get();
1719 const uint8_t *first_trace_uuid
= first_trace
->metadata
->tc
->uuid
;
1722 * We have more than one trace, they must all share the same
1723 * UUID, verify that.
1725 for (i
= 0; i
< traces
.size(); i
++) {
1726 ctf_fs_trace
*this_trace
= traces
[i
].get();
1727 const uint8_t *this_trace_uuid
= this_trace
->metadata
->tc
->uuid
;
1729 if (!this_trace
->metadata
->tc
->is_uuid_set
) {
1730 BT_CLOGE_APPEND_CAUSE(
1731 "Multiple traces given, but a trace does not have a UUID: path=%s",
1732 this_trace
->path
->str
);
1736 if (bt_uuid_compare(first_trace_uuid
, this_trace_uuid
) != 0) {
1737 char first_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1738 char this_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1740 bt_uuid_to_str(first_trace_uuid
, first_trace_uuid_str
);
1741 bt_uuid_to_str(this_trace_uuid
, this_trace_uuid_str
);
1743 BT_CLOGE_APPEND_CAUSE("Multiple traces given, but UUIDs don't match: "
1744 "first-trace-uuid=%s, first-trace-path=%s, "
1745 "trace-uuid=%s, trace-path=%s",
1746 first_trace_uuid_str
, first_trace
->path
->str
,
1747 this_trace_uuid_str
, this_trace
->path
->str
);
1752 ret
= merge_ctf_fs_traces(std::move(traces
), ctf_fs
->trace
);
1754 BT_CLOGE_APPEND_CAUSE("Failed to merge traces with the same UUID.");
1758 /* Just one trace, it may or may not have a UUID, both are fine. */
1759 ctf_fs
->trace
= std::move(traces
[0]);
1762 ret
= fix_packet_index_tracer_bugs(ctf_fs
);
1764 BT_CLOGE_APPEND_CAUSE("Failed to fix packet index tracer bugs.");
1768 * Sort data stream file groups by first data stream file info
1769 * path to get a deterministic order. This order influences the
1770 * order of the output ports. It also influences the order of
1771 * the automatic stream IDs if the trace's packet headers do not
1772 * contain a `stream_instance_id` field, in which case the data
1773 * stream file to stream ID association is always the same,
1774 * whatever the build and the system.
1776 * Having a deterministic order here can help debugging and
1779 std::sort(ctf_fs
->trace
->ds_file_groups
.begin(), ctf_fs
->trace
->ds_file_groups
.end(),
1780 compare_ds_file_groups_by_first_path
);
1787 g_ptr_array_free(paths
, TRUE
);
1793 static GString
*get_stream_instance_unique_name(struct ctf_fs_ds_file_group
*ds_file_group
)
1796 struct ctf_fs_ds_file_info
*ds_file_info
;
1798 name
= g_string_new(NULL
);
1804 * If there's more than one stream file in the stream file
1805 * group, the first (earliest) stream file's path is used as
1806 * the stream's unique name.
1808 BT_ASSERT(!ds_file_group
->ds_file_infos
.empty());
1809 ds_file_info
= ds_file_group
->ds_file_infos
[0].get();
1810 g_string_assign(name
, ds_file_info
->path
.c_str());
1816 /* Create the IR stream objects for ctf_fs_trace. */
1818 static int create_streams_for_trace(struct ctf_fs_trace
*ctf_fs_trace
)
1821 GString
*name
= NULL
;
1822 const bt2_common::LogCfg
& logCfg
= ctf_fs_trace
->logCfg
;
1824 for (ctf_fs_ds_file_group::UP
& ds_file_group
: ctf_fs_trace
->ds_file_groups
) {
1825 name
= get_stream_instance_unique_name(ds_file_group
.get());
1831 BT_ASSERT(ds_file_group
->sc
->ir_sc
);
1832 BT_ASSERT(ctf_fs_trace
->trace
);
1836 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
1837 /* No stream ID: use 0 */
1838 stream
= bt_stream_create_with_id(ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
,
1839 ctf_fs_trace
->next_stream_id
);
1840 ctf_fs_trace
->next_stream_id
++;
1842 /* Specific stream ID */
1843 stream
= bt_stream_create_with_id(ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
,
1844 (uint64_t) ds_file_group
->stream_id
);
1848 BT_CLOGE_APPEND_CAUSE("Cannot create stream for DS file group: "
1849 "addr=%p, stream-name=\"%s\"",
1850 ds_file_group
.get(), name
->str
);
1854 ds_file_group
->stream
= bt2::Stream::Shared::createWithoutRef(stream
);
1856 ret
= bt_stream_set_name((*ds_file_group
->stream
)->libObjPtr(), name
->str
);
1858 BT_CLOGE_APPEND_CAUSE("Cannot set stream's name: "
1859 "addr=%p, stream-name=\"%s\"",
1860 (*ds_file_group
->stream
)->libObjPtr(), name
->str
);
1864 g_string_free(name
, TRUE
);
1877 g_string_free(name
, TRUE
);
1882 static const bt_param_validation_value_descr inputs_elem_descr
=
1883 bt_param_validation_value_descr::makeString();
1885 static bt_param_validation_map_value_entry_descr fs_params_entries_descr
[] = {
1886 {"inputs", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
1887 bt_param_validation_value_descr::makeArray(1, BT_PARAM_VALIDATION_INFINITE
,
1888 inputs_elem_descr
)},
1889 {"trace-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1890 bt_param_validation_value_descr::makeString()},
1891 {"clock-class-offset-s", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1892 bt_param_validation_value_descr::makeSignedInteger()},
1893 {"clock-class-offset-ns", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1894 bt_param_validation_value_descr::makeSignedInteger()},
1895 {"force-clock-class-origin-unix-epoch", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
1896 bt_param_validation_value_descr::makeBool()},
1897 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
1899 bool read_src_fs_parameters(const bt_value
*params
, const bt_value
**inputs
,
1900 const bt_value
**trace_name
, struct ctf_fs_component
*ctf_fs
)
1903 const bt_value
*value
;
1904 enum bt_param_validation_status validate_value_status
;
1905 gchar
*error
= NULL
;
1906 const bt2_common::LogCfg
& logCfg
= ctf_fs
->logCfg
;
1908 validate_value_status
= bt_param_validation_validate(params
, fs_params_entries_descr
, &error
);
1909 if (validate_value_status
!= BT_PARAM_VALIDATION_STATUS_OK
) {
1910 BT_CLOGE_APPEND_CAUSE("%s", error
);
1915 /* inputs parameter */
1916 *inputs
= bt_value_map_borrow_entry_value_const(params
, "inputs");
1918 /* clock-class-offset-s parameter */
1919 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-s");
1921 ctf_fs
->clkClsCfg
.offsetSec
= bt_value_integer_signed_get(value
);
1924 /* clock-class-offset-ns parameter */
1925 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-ns");
1927 ctf_fs
->clkClsCfg
.offsetNanoSec
= bt_value_integer_signed_get(value
);
1930 /* force-clock-class-origin-unix-epoch parameter */
1931 value
= bt_value_map_borrow_entry_value_const(params
, "force-clock-class-origin-unix-epoch");
1933 ctf_fs
->clkClsCfg
.forceOriginIsUnixEpoch
= bt_value_bool_get(value
);
1936 /* trace-name parameter */
1937 *trace_name
= bt_value_map_borrow_entry_value_const(params
, "trace-name");
1946 static ctf_fs_component::UP
ctf_fs_create(const bt_value
*params
,
1947 bt_self_component_source
*self_comp_src
,
1948 const bt2_common::LogCfg
& logCfg
)
1950 const bt_value
*inputs_value
;
1951 const bt_value
*trace_name_value
;
1952 bt_self_component
*self_comp
= bt_self_component_source_as_self_component(self_comp_src
);
1954 ctf_fs_component::UP ctf_fs
= ctf_fs_component_create(logCfg
);
1959 if (!read_src_fs_parameters(params
, &inputs_value
, &trace_name_value
, ctf_fs
.get())) {
1963 if (ctf_fs_component_create_ctf_fs_trace(ctf_fs
.get(), inputs_value
, trace_name_value
,
1968 if (create_streams_for_trace(ctf_fs
->trace
.get())) {
1972 if (create_ports_for_trace(ctf_fs
.get(), ctf_fs
->trace
.get(), self_comp_src
)) {
1980 bt_component_class_initialize_method_status
1981 ctf_fs_init(bt_self_component_source
*self_comp_src
, bt_self_component_source_configuration
*config
,
1982 const bt_value
*params
, __attribute__((unused
)) void *init_method_data
)
1984 bt_self_component
*selfComp
= bt_self_component_source_as_self_component(self_comp_src
);
1985 const bt_component
*comp
= bt_self_component_as_component(selfComp
);
1986 bt_logging_level logLevel
= bt_component_get_logging_level(comp
);
1987 bt2_common::LogCfg
logCfg(logLevel
, *selfComp
);
1990 ctf_fs_component::UP ctf_fs
= ctf_fs_create(params
, self_comp_src
, logCfg
);
1992 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
1995 bt_self_component_set_data(selfComp
, ctf_fs
.release());
1997 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
1998 } catch (const std::bad_alloc
&) {
1999 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
2000 } catch (const bt2_common::Error
&) {
2001 BT_CLOGE_APPEND_CAUSE("Failed to initialize component");
2002 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
2007 bt_component_class_query_method_status
ctf_fs_query(bt_self_component_class_source
*comp_class_src
,
2008 bt_private_query_executor
*priv_query_exec
,
2009 const char *object
, const bt_value
*params
,
2010 __attribute__((unused
)) void *method_data
,
2011 const bt_value
**result
)
2013 const bt_query_executor
*query_exec
=
2014 bt_private_query_executor_as_query_executor_const(priv_query_exec
);
2015 bt_logging_level log_level
= bt_query_executor_get_logging_level(query_exec
);
2016 bt_self_component_class
*comp_class
=
2017 bt_self_component_class_source_as_self_component_class(comp_class_src
);
2018 bt2_common::LogCfg
logCfg(log_level
, *comp_class
);
2021 bt2::ConstMapValue
paramsObj(params
);
2022 nonstd::optional
<bt2::Value::Shared
> resultObj
;
2024 if (strcmp(object
, "metadata-info") == 0) {
2025 resultObj
= metadata_info_query(paramsObj
, logCfg
);
2026 } else if (strcmp(object
, "babeltrace.trace-infos") == 0) {
2027 resultObj
= trace_infos_query(paramsObj
, logCfg
);
2028 } else if (!strcmp(object
, "babeltrace.support-info")) {
2029 resultObj
= support_info_query(paramsObj
, logCfg
);
2031 BT_LOGE("Unknown query object `%s`", object
);
2032 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;
2035 *result
= resultObj
->release().libObjPtr();
2037 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
2038 } catch (const std::bad_alloc
&) {
2039 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
2040 } catch (const bt2_common::Error
&) {
2041 BT_CLOGE_APPEND_CAUSE("Failed to execute query: object=%s", object
);
2042 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;