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"
19 #include "plugins/common/param-validation/param-validation.h"
21 #include "../common/src/metadata/tsdl/ctf-meta-configure-ir-trace.hpp"
22 #include "../common/src/msg-iter/msg-iter.hpp"
23 #include "data-stream-file.hpp"
26 #include "metadata.hpp"
37 static void ctf_fs_msg_iter_data_destroy(struct ctf_fs_msg_iter_data
*msg_iter_data
)
43 if (msg_iter_data
->msg_iter
) {
44 ctf_msg_iter_destroy(msg_iter_data
->msg_iter
);
47 if (msg_iter_data
->msg_iter_medops_data
) {
48 ctf_fs_ds_group_medops_data_destroy(msg_iter_data
->msg_iter_medops_data
);
54 static bt_message_iterator_class_next_method_status
55 ctf_fs_iterator_next_one(struct ctf_fs_msg_iter_data
*msg_iter_data
, const bt_message
**out_msg
)
57 bt_message_iterator_class_next_method_status status
;
58 enum ctf_msg_iter_status msg_iter_status
;
60 msg_iter_status
= ctf_msg_iter_get_next_message(msg_iter_data
->msg_iter
, out_msg
);
62 switch (msg_iter_status
) {
63 case CTF_MSG_ITER_STATUS_OK
:
64 /* Cool, message has been written to *out_msg. */
65 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
68 case CTF_MSG_ITER_STATUS_EOF
:
69 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END
;
72 case CTF_MSG_ITER_STATUS_AGAIN
:
74 * Should not make it this far as this is
75 * medium-specific; there is nothing for the user to do
76 * and it should have been handled upstream.
80 case CTF_MSG_ITER_STATUS_ERROR
:
81 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
82 "Failed to get next message from CTF message iterator.");
83 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
86 case CTF_MSG_ITER_STATUS_MEMORY_ERROR
:
87 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
88 "Failed to get next message from CTF message iterator.");
89 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
99 bt_message_iterator_class_next_method_status
100 ctf_fs_iterator_next(bt_self_message_iterator
*iterator
, bt_message_array_const msgs
,
101 uint64_t capacity
, uint64_t *count
)
104 bt_message_iterator_class_next_method_status status
;
105 struct ctf_fs_msg_iter_data
*msg_iter_data
=
106 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(iterator
);
109 if (G_UNLIKELY(msg_iter_data
->next_saved_error
)) {
111 * Last time we were called, we hit an error but had some
112 * messages to deliver, so we stashed the error here. Return
115 BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(msg_iter_data
->next_saved_error
);
116 status
= msg_iter_data
->next_saved_status
;
121 status
= ctf_fs_iterator_next_one(msg_iter_data
, &msgs
[i
]);
122 if (status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
) {
125 } while (i
< capacity
&& status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
);
129 * Even if ctf_fs_iterator_next_one() returned something
130 * else than BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK, we
131 * accumulated message objects in the output
132 * message array, so we need to return
133 * BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK so that they are
134 * transferred to downstream. This other status occurs
135 * again the next time muxer_msg_iter_do_next() is
136 * called, possibly without any accumulated
137 * message, in which case we'll return it.
141 * Save this error for the next _next call. Assume that
142 * this component always appends error causes when
143 * returning an error status code, which will cause the
144 * current thread error to be non-NULL.
146 msg_iter_data
->next_saved_error
= bt_current_thread_take_error();
147 BT_ASSERT(msg_iter_data
->next_saved_error
);
148 msg_iter_data
->next_saved_status
= status
;
152 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
158 } catch (const std::bad_alloc
&) {
159 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
160 } catch (const bt2::Error
&) {
161 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
165 bt_message_iterator_class_seek_beginning_method_status
166 ctf_fs_iterator_seek_beginning(bt_self_message_iterator
*it
)
169 struct ctf_fs_msg_iter_data
*msg_iter_data
=
170 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(it
);
172 BT_ASSERT(msg_iter_data
);
174 ctf_msg_iter_reset(msg_iter_data
->msg_iter
);
175 ctf_fs_ds_group_medops_data_reset(msg_iter_data
->msg_iter_medops_data
);
177 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_OK
;
178 } catch (const std::bad_alloc
&) {
179 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_MEMORY_ERROR
;
180 } catch (const bt2::Error
&) {
181 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_ERROR
;
185 void ctf_fs_iterator_finalize(bt_self_message_iterator
*it
)
187 ctf_fs_msg_iter_data_destroy(
188 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(it
));
191 static bt_message_iterator_class_initialize_method_status
192 ctf_msg_iter_medium_status_to_msg_iter_initialize_status(enum ctf_msg_iter_medium_status status
)
195 case CTF_MSG_ITER_MEDIUM_STATUS_EOF
:
196 case CTF_MSG_ITER_MEDIUM_STATUS_AGAIN
:
197 case CTF_MSG_ITER_MEDIUM_STATUS_ERROR
:
198 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
199 case CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
:
200 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
201 case CTF_MSG_ITER_MEDIUM_STATUS_OK
:
202 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
208 bt_message_iterator_class_initialize_method_status
209 ctf_fs_iterator_init(bt_self_message_iterator
*self_msg_iter
,
210 bt_self_message_iterator_configuration
*config
,
211 bt_self_component_port_output
*self_port
)
214 struct ctf_fs_port_data
*port_data
;
215 bt_message_iterator_class_initialize_method_status status
;
216 enum ctf_msg_iter_medium_status medium_status
;
218 port_data
= (struct ctf_fs_port_data
*) bt_self_component_port_get_data(
219 bt_self_component_port_output_as_self_component_port(self_port
));
220 BT_ASSERT(port_data
);
222 ctf_fs_msg_iter_data
*msg_iter_data
= new ctf_fs_msg_iter_data
{self_msg_iter
};
223 msg_iter_data
->ds_file_group
= port_data
->ds_file_group
;
225 medium_status
= ctf_fs_ds_group_medops_data_create(msg_iter_data
->ds_file_group
,
226 self_msg_iter
, msg_iter_data
->logger
,
227 &msg_iter_data
->msg_iter_medops_data
);
228 BT_ASSERT(medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_OK
||
229 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_ERROR
||
230 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
);
231 if (medium_status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
232 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
233 "Failed to create ctf_fs_ds_group_medops");
234 status
= ctf_msg_iter_medium_status_to_msg_iter_initialize_status(medium_status
);
238 msg_iter_data
->msg_iter
= ctf_msg_iter_create(
239 msg_iter_data
->ds_file_group
->ctf_fs_trace
->metadata
->tc
,
240 bt_common_get_page_size(static_cast<int>(msg_iter_data
->logger
.level())) * 8,
241 ctf_fs_ds_group_medops
, msg_iter_data
->msg_iter_medops_data
, self_msg_iter
,
242 msg_iter_data
->logger
);
243 if (!msg_iter_data
->msg_iter
) {
244 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
245 "Cannot create a CTF message iterator.");
246 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
251 * This iterator can seek forward if its stream class has a default
254 if (msg_iter_data
->ds_file_group
->sc
->default_clock_class
) {
255 bt_self_message_iterator_configuration_set_can_seek_forward(config
, true);
258 bt_self_message_iterator_set_data(self_msg_iter
, msg_iter_data
);
259 msg_iter_data
= NULL
;
261 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
265 bt_self_message_iterator_set_data(self_msg_iter
, NULL
);
268 ctf_fs_msg_iter_data_destroy(msg_iter_data
);
270 } catch (const std::bad_alloc
&) {
271 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
272 } catch (const bt2::Error
&) {
273 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
277 static void ctf_fs_trace_destroy(struct ctf_fs_trace
*ctf_fs_trace
)
283 if (ctf_fs_trace
->ds_file_groups
) {
284 g_ptr_array_free(ctf_fs_trace
->ds_file_groups
, TRUE
);
287 BT_TRACE_PUT_REF_AND_RESET(ctf_fs_trace
->trace
);
289 if (ctf_fs_trace
->path
) {
290 g_string_free(ctf_fs_trace
->path
, TRUE
);
293 if (ctf_fs_trace
->metadata
) {
294 ctf_fs_metadata_fini(ctf_fs_trace
->metadata
);
295 delete ctf_fs_trace
->metadata
;
301 void ctf_fs_destroy(struct ctf_fs_component
*ctf_fs
)
307 ctf_fs_trace_destroy(ctf_fs
->trace
);
309 if (ctf_fs
->port_data
) {
310 g_ptr_array_free(ctf_fs
->port_data
, TRUE
);
316 void ctf_fs_component_deleter::operator()(ctf_fs_component
*comp
)
318 ctf_fs_destroy(comp
);
321 static void port_data_destroy(struct ctf_fs_port_data
*port_data
)
330 static void port_data_destroy_notifier(void *data
)
332 port_data_destroy((struct ctf_fs_port_data
*) data
);
335 static void ctf_fs_trace_destroy_notifier(void *data
)
337 struct ctf_fs_trace
*trace
= (struct ctf_fs_trace
*) data
;
338 ctf_fs_trace_destroy(trace
);
341 ctf_fs_component::UP
ctf_fs_component_create(const bt2c::Logger
& parentLogger
)
343 ctf_fs_component::UP ctf_fs
{new ctf_fs_component
{parentLogger
}};
345 ctf_fs
->port_data
= g_ptr_array_new_with_free_func(port_data_destroy_notifier
);
346 if (!ctf_fs
->port_data
) {
359 void ctf_fs_finalize(bt_self_component_source
*component
)
361 ctf_fs_destroy((struct ctf_fs_component
*) bt_self_component_get_data(
362 bt_self_component_source_as_self_component(component
)));
365 bt2c::GCharUP
ctf_fs_make_port_name(struct ctf_fs_ds_file_group
*ds_file_group
)
367 GString
*name
= g_string_new(NULL
);
370 * The unique port name is generated by concatenating unique identifiers
378 /* For the trace, use the uuid if present, else the path. */
379 if (ds_file_group
->ctf_fs_trace
->metadata
->tc
->is_uuid_set
) {
380 char uuid_str
[BT_UUID_STR_LEN
+ 1];
382 bt_uuid_to_str(ds_file_group
->ctf_fs_trace
->metadata
->tc
->uuid
, uuid_str
);
383 g_string_assign(name
, uuid_str
);
385 g_string_assign(name
, ds_file_group
->ctf_fs_trace
->path
->str
);
389 * For the stream class, use the id if present. We can omit this field
390 * otherwise, as there will only be a single stream class.
392 if (ds_file_group
->sc
->id
!= UINT64_C(-1)) {
393 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->sc
->id
);
396 /* For the stream, use the id if present, else, use the path. */
397 if (ds_file_group
->stream_id
!= UINT64_C(-1)) {
398 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->stream_id
);
400 BT_ASSERT(ds_file_group
->ds_file_infos
->len
== 1);
401 struct ctf_fs_ds_file_info
*ds_file_info
=
402 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
403 g_string_append_printf(name
, " | %s", ds_file_info
->path
->str
);
406 return bt2c::GCharUP
{g_string_free(name
, FALSE
)};
409 static int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
410 struct ctf_fs_ds_file_group
*ds_file_group
,
411 bt_self_component_source
*self_comp_src
)
414 struct ctf_fs_port_data
*port_data
= NULL
;
416 bt2c::GCharUP port_name
= ctf_fs_make_port_name(ds_file_group
);
421 BT_CPPLOGI_SPEC(ctf_fs
->logger
, "Creating one port named `{}`", port_name
.get());
423 /* Create output port for this file */
424 port_data
= new ctf_fs_port_data
;
425 port_data
->ctf_fs
= ctf_fs
;
426 port_data
->ds_file_group
= ds_file_group
;
427 ret
= bt_self_component_source_add_output_port(self_comp_src
, port_name
.get(), port_data
, NULL
);
432 g_ptr_array_add(ctf_fs
->port_data
, port_data
);
440 port_data_destroy(port_data
);
444 static int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
445 struct ctf_fs_trace
*ctf_fs_trace
,
446 bt_self_component_source
*self_comp_src
)
451 /* Create one output port for each stream file group */
452 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
453 struct ctf_fs_ds_file_group
*ds_file_group
=
454 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
456 ret
= create_one_port_for_trace(ctf_fs
, ds_file_group
, self_comp_src
);
458 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create output port.");
467 static void ctf_fs_ds_file_info_destroy(struct ctf_fs_ds_file_info
*ds_file_info
)
473 if (ds_file_info
->path
) {
474 g_string_free(ds_file_info
->path
, TRUE
);
480 static struct ctf_fs_ds_file_info
*ctf_fs_ds_file_info_create(const char *path
, int64_t begin_ns
)
482 ctf_fs_ds_file_info
*ds_file_info
= new ctf_fs_ds_file_info
;
483 ds_file_info
->path
= g_string_new(path
);
484 if (!ds_file_info
->path
) {
485 ctf_fs_ds_file_info_destroy(ds_file_info
);
490 ds_file_info
->begin_ns
= begin_ns
;
496 static void ctf_fs_ds_file_group_destroy(struct ctf_fs_ds_file_group
*ds_file_group
)
498 if (!ds_file_group
) {
502 if (ds_file_group
->ds_file_infos
) {
503 g_ptr_array_free(ds_file_group
->ds_file_infos
, TRUE
);
506 ctf_fs_ds_index_destroy(ds_file_group
->index
);
508 bt_stream_put_ref(ds_file_group
->stream
);
509 delete ds_file_group
;
512 static struct ctf_fs_ds_file_group
*ctf_fs_ds_file_group_create(struct ctf_fs_trace
*ctf_fs_trace
,
513 struct ctf_stream_class
*sc
,
514 uint64_t stream_instance_id
,
515 struct ctf_fs_ds_index
*index
)
517 ctf_fs_ds_file_group
*ds_file_group
= new ctf_fs_ds_file_group
;
518 ds_file_group
->ds_file_infos
=
519 g_ptr_array_new_with_free_func((GDestroyNotify
) ctf_fs_ds_file_info_destroy
);
520 if (!ds_file_group
->ds_file_infos
) {
524 ds_file_group
->index
= index
;
526 ds_file_group
->stream_id
= stream_instance_id
;
528 ds_file_group
->sc
= sc
;
529 ds_file_group
->ctf_fs_trace
= ctf_fs_trace
;
533 ctf_fs_ds_file_group_destroy(ds_file_group
);
534 ctf_fs_ds_index_destroy(index
);
535 ds_file_group
= NULL
;
538 return ds_file_group
;
541 /* Replace by g_ptr_array_insert when we depend on glib >= 2.40. */
542 static void array_insert(GPtrArray
*array
, gpointer element
, size_t pos
)
544 size_t original_array_len
= array
->len
;
546 /* Allocate an unused element at the end of the array. */
547 g_ptr_array_add(array
, NULL
);
549 /* If we are not inserting at the end, move the elements by one. */
550 if (pos
< original_array_len
) {
551 memmove(&(array
->pdata
[pos
+ 1]), &(array
->pdata
[pos
]),
552 (original_array_len
- pos
) * sizeof(gpointer
));
555 /* Insert the value. */
556 array
->pdata
[pos
] = element
;
560 * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right
561 * place to keep it sorted.
564 static void ds_file_group_insert_ds_file_info_sorted(struct ctf_fs_ds_file_group
*ds_file_group
,
565 struct ctf_fs_ds_file_info
*ds_file_info
)
569 /* Find the spot where to insert this ds_file_info. */
570 for (i
= 0; i
< ds_file_group
->ds_file_infos
->len
; i
++) {
571 struct ctf_fs_ds_file_info
*other_ds_file_info
=
572 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, i
);
574 if (ds_file_info
->begin_ns
< other_ds_file_info
->begin_ns
) {
579 array_insert(ds_file_group
->ds_file_infos
, ds_file_info
, i
);
582 static bool ds_index_entries_equal(const struct ctf_fs_ds_index_entry
*left
,
583 const struct ctf_fs_ds_index_entry
*right
)
585 if (left
->packet_size
!= right
->packet_size
) {
589 if (left
->timestamp_begin
!= right
->timestamp_begin
) {
593 if (left
->timestamp_end
!= right
->timestamp_end
) {
597 if (left
->packet_seq_num
!= right
->packet_seq_num
) {
605 * Insert `entry` into `index`, without duplication.
607 * The entry is inserted only if there isn't an identical entry already.
609 * In any case, the ownership of `entry` is transferred to this function. So if
610 * the entry is not inserted, it is freed.
613 static void ds_index_insert_ds_index_entry_sorted(struct ctf_fs_ds_index
*index
,
614 struct ctf_fs_ds_index_entry
*entry
)
617 struct ctf_fs_ds_index_entry
*other_entry
= NULL
;
619 /* Find the spot where to insert this index entry. */
620 for (i
= 0; i
< index
->entries
->len
; i
++) {
621 other_entry
= (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, i
);
623 if (entry
->timestamp_begin_ns
<= other_entry
->timestamp_begin_ns
) {
629 * Insert the entry only if a duplicate doesn't already exist.
631 * There can be duplicate packets if reading multiple overlapping
632 * snapshots of the same trace. We then want the index to contain
633 * a reference to only one copy of that packet.
635 if (i
== index
->entries
->len
|| !ds_index_entries_equal(entry
, other_entry
)) {
636 array_insert(index
->entries
, entry
, i
);
642 static void merge_ctf_fs_ds_indexes(struct ctf_fs_ds_index
*dest
, struct ctf_fs_ds_index
*src
)
646 for (i
= 0; i
< src
->entries
->len
; i
++) {
647 struct ctf_fs_ds_index_entry
*entry
=
648 (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(src
->entries
, i
);
651 * Ownership of the ctf_fs_ds_index_entry is transferred to
652 * ds_index_insert_ds_index_entry_sorted.
654 g_ptr_array_index(src
->entries
, i
) = NULL
;
655 ds_index_insert_ds_index_entry_sorted(dest
, entry
);
659 static int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
, const char *path
)
661 int64_t stream_instance_id
= -1;
662 int64_t begin_ns
= -1;
663 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
664 bool add_group
= false;
667 struct ctf_fs_ds_file
*ds_file
= NULL
;
668 struct ctf_fs_ds_file_info
*ds_file_info
= NULL
;
669 struct ctf_fs_ds_index
*index
= NULL
;
670 struct ctf_msg_iter
*msg_iter
= NULL
;
671 struct ctf_stream_class
*sc
= NULL
;
672 struct ctf_msg_iter_packet_properties props
;
675 * Create a temporary ds_file to read some properties about the data
678 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, path
, ctf_fs_trace
->logger
);
683 /* Create a temporary iterator to read the ds_file. */
684 msg_iter
= ctf_msg_iter_create(
685 ctf_fs_trace
->metadata
->tc
,
686 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
687 ctf_fs_ds_file_medops
, ds_file
, nullptr, ctf_fs_trace
->logger
);
689 BT_CPPLOGE_STR_SPEC(ctf_fs_trace
->logger
, "Cannot create a CTF message iterator.");
693 ctf_msg_iter_set_dry_run(msg_iter
, true);
695 ret
= ctf_msg_iter_get_packet_properties(msg_iter
, &props
);
697 BT_CPPLOGE_APPEND_CAUSE_SPEC(
698 ctf_fs_trace
->logger
,
699 "Cannot get stream file's first packet's header and context fields (`{}`).", path
);
703 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
, props
.stream_class_id
);
705 stream_instance_id
= props
.data_stream_id
;
707 if (props
.snapshots
.beginning_clock
!= UINT64_C(-1)) {
708 BT_ASSERT(sc
->default_clock_class
);
709 ret
= bt_util_clock_cycles_to_ns_from_origin(
710 props
.snapshots
.beginning_clock
, sc
->default_clock_class
->frequency
,
711 sc
->default_clock_class
->offset_seconds
, sc
->default_clock_class
->offset_cycles
,
714 BT_CPPLOGE_APPEND_CAUSE_SPEC(
715 ctf_fs_trace
->logger
,
716 "Cannot convert clock cycles to nanoseconds from origin (`{}`).", path
);
721 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
);
726 index
= ctf_fs_ds_file_build_index(ds_file
, ds_file_info
, msg_iter
);
728 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to index CTF stream file \'{}\'",
729 ds_file
->file
->path
->str
);
733 if (begin_ns
== -1) {
735 * No beginning timestamp to sort the stream files
736 * within a stream file group, so consider that this
737 * file must be the only one within its group.
739 stream_instance_id
= -1;
742 if (stream_instance_id
== -1) {
744 * No stream instance ID or no beginning timestamp:
745 * create a unique stream file group for this stream
746 * file because, even if there's a stream instance ID,
747 * there's no timestamp to order the file within its
750 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, UINT64_C(-1), index
);
751 /* Ownership of index is transferred. */
754 if (!ds_file_group
) {
758 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, BT_MOVE_REF(ds_file_info
));
764 BT_ASSERT(stream_instance_id
!= -1);
765 BT_ASSERT(begin_ns
!= -1);
767 /* Find an existing stream file group with this ID */
768 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
770 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
772 if (ds_file_group
->sc
== sc
&& ds_file_group
->stream_id
== stream_instance_id
) {
776 ds_file_group
= NULL
;
779 if (!ds_file_group
) {
780 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, stream_instance_id
, index
);
781 /* Ownership of index is transferred. */
783 if (!ds_file_group
) {
789 merge_ctf_fs_ds_indexes(ds_file_group
->index
, index
);
792 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, BT_MOVE_REF(ds_file_info
));
797 ctf_fs_ds_file_group_destroy(ds_file_group
);
798 ds_file_group
= NULL
;
802 if (add_group
&& ds_file_group
) {
803 g_ptr_array_add(ctf_fs_trace
->ds_file_groups
, ds_file_group
);
806 ctf_fs_ds_file_destroy(ds_file
);
807 ctf_fs_ds_file_info_destroy(ds_file_info
);
810 ctf_msg_iter_destroy(msg_iter
);
813 ctf_fs_ds_index_destroy(index
);
817 static int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
820 const char *basename
;
821 GError
*error
= NULL
;
824 /* Check each file in the path directory, except specific ones */
825 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
827 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
828 "Cannot open directory `{}`: {} (code {})",
829 ctf_fs_trace
->path
->str
, error
->message
, error
->code
);
833 while ((basename
= g_dir_read_name(dir
))) {
834 struct ctf_fs_file
*file
;
836 if (strcmp(basename
, CTF_FS_METADATA_FILENAME
) == 0) {
837 /* Ignore the metadata stream. */
838 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
839 "Ignoring metadata file `{}" G_DIR_SEPARATOR_S
"{}`",
840 ctf_fs_trace
->path
->str
, basename
);
844 if (basename
[0] == '.') {
845 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
846 "Ignoring hidden file `{}" G_DIR_SEPARATOR_S
"{}`",
847 ctf_fs_trace
->path
->str
, basename
);
851 /* Create the file. */
852 file
= ctf_fs_file_create(ctf_fs_trace
->logger
);
854 BT_CPPLOGE_APPEND_CAUSE_SPEC(
855 ctf_fs_trace
->logger
,
856 "Cannot create stream file object for file `{}" G_DIR_SEPARATOR_S
"{}`",
857 ctf_fs_trace
->path
->str
, basename
);
861 /* Create full path string. */
862 g_string_append_printf(file
->path
, "%s" G_DIR_SEPARATOR_S
"%s", ctf_fs_trace
->path
->str
,
864 if (!g_file_test(file
->path
->str
, G_FILE_TEST_IS_REGULAR
)) {
865 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring non-regular file `{}`",
867 ctf_fs_file_destroy(file
);
872 ret
= ctf_fs_file_open(file
, "rb");
874 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Cannot open stream file `{}`",
879 if (file
->size
== 0) {
880 /* Skip empty stream. */
881 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring empty file `{}`", file
->path
->str
);
882 ctf_fs_file_destroy(file
);
886 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
, file
->path
->str
);
888 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
889 "Cannot add stream file `{}` to stream file group",
891 ctf_fs_file_destroy(file
);
895 ctf_fs_file_destroy(file
);
916 static int set_trace_name(bt_trace
*trace
, const char *name_suffix
, const bt2c::Logger
& logger
)
922 name
= g_string_new(NULL
);
924 BT_CPPLOGE_STR_SPEC(logger
, "Failed to allocate a GString.");
930 * Check if we have a trace environment string value named `hostname`.
931 * If so, use it as the trace name's prefix.
933 val
= bt_trace_borrow_environment_entry_value_by_name_const(trace
, "hostname");
934 if (val
&& bt_value_is_string(val
)) {
935 g_string_append(name
, bt_value_string_get(val
));
938 g_string_append_c(name
, G_DIR_SEPARATOR
);
943 g_string_append(name
, name_suffix
);
946 ret
= bt_trace_set_name(trace
, name
->str
);
955 g_string_free(name
, TRUE
);
961 static struct ctf_fs_trace
*ctf_fs_trace_create(const char *path
, const char *name
,
962 struct ctf_fs_metadata_config
*metadata_config
,
963 bt_self_component
*selfComp
,
964 const bt2c::Logger
& parentLogger
)
968 ctf_fs_trace
*ctf_fs_trace
= new struct ctf_fs_trace(parentLogger
);
969 ctf_fs_trace
->path
= g_string_new(path
);
970 if (!ctf_fs_trace
->path
) {
974 ctf_fs_trace
->metadata
= new ctf_fs_metadata
;
975 ctf_fs_metadata_init(ctf_fs_trace
->metadata
);
976 ctf_fs_trace
->ds_file_groups
=
977 g_ptr_array_new_with_free_func((GDestroyNotify
) ctf_fs_ds_file_group_destroy
);
978 if (!ctf_fs_trace
->ds_file_groups
) {
982 ret
= ctf_fs_metadata_set_trace_class(selfComp
, ctf_fs_trace
, metadata_config
);
987 if (ctf_fs_trace
->metadata
->trace_class
) {
988 ctf_fs_trace
->trace
= bt_trace_create(ctf_fs_trace
->metadata
->trace_class
);
989 if (!ctf_fs_trace
->trace
) {
994 if (ctf_fs_trace
->trace
) {
995 ret
= ctf_trace_class_configure_ir_trace(ctf_fs_trace
->metadata
->tc
, ctf_fs_trace
->trace
);
1000 ret
= set_trace_name(ctf_fs_trace
->trace
, name
, ctf_fs_trace
->logger
);
1006 ret
= create_ds_file_groups(ctf_fs_trace
);
1014 ctf_fs_trace_destroy(ctf_fs_trace
);
1015 ctf_fs_trace
= NULL
;
1018 return ctf_fs_trace
;
1021 static int path_is_ctf_trace(const char *path
)
1023 GString
*metadata_path
= g_string_new(NULL
);
1026 if (!metadata_path
) {
1031 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
1033 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
1039 g_string_free(metadata_path
, TRUE
);
1043 /* Helper for ctf_fs_component_create_ctf_fs_trace, to handle a single path. */
1045 static int ctf_fs_component_create_ctf_fs_trace_one_path(struct ctf_fs_component
*ctf_fs
,
1046 const char *path_param
,
1047 const char *trace_name
, GPtrArray
*traces
,
1048 bt_self_component
*selfComp
)
1050 struct ctf_fs_trace
*ctf_fs_trace
;
1054 norm_path
= bt_common_normalize_path(path_param
, NULL
);
1056 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to normalize path: `{}`.", path_param
);
1060 ret
= path_is_ctf_trace(norm_path
->str
);
1062 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1063 ctf_fs
->logger
, "Failed to check if path is a CTF trace: path={}", norm_path
->str
);
1065 } else if (ret
== 0) {
1066 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1067 ctf_fs
->logger
, "Path is not a CTF trace (does not contain a metadata file): `{}`.",
1072 // FIXME: Remove or ifdef for __MINGW32__
1073 if (strcmp(norm_path
->str
, "/") == 0) {
1074 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Opening a trace in `/` is not supported.");
1079 ctf_fs_trace
= ctf_fs_trace_create(norm_path
->str
, trace_name
, &ctf_fs
->metadata_config
,
1080 selfComp
, ctf_fs
->logger
);
1081 if (!ctf_fs_trace
) {
1082 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create trace for `{}`.",
1087 g_ptr_array_add(traces
, ctf_fs_trace
);
1088 ctf_fs_trace
= NULL
;
1098 g_string_free(norm_path
, TRUE
);
1105 * Count the number of stream and event classes defined by this trace's metadata.
1107 * This is used to determine which metadata is the "latest", out of multiple
1108 * traces sharing the same UUID. It is assumed that amongst all these metadatas,
1109 * a bigger metadata is a superset of a smaller metadata. Therefore, it is
1110 * enough to just count the classes.
1113 static unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace
*trace
)
1115 unsigned int num
= trace
->metadata
->tc
->stream_classes
->len
;
1118 for (i
= 0; i
< trace
->metadata
->tc
->stream_classes
->len
; i
++) {
1119 struct ctf_stream_class
*sc
=
1120 (struct ctf_stream_class
*) trace
->metadata
->tc
->stream_classes
->pdata
[i
];
1121 num
+= sc
->event_classes
->len
;
1128 * Merge the src ds_file_group into dest. This consists of merging their
1129 * ds_file_infos, making sure to keep the result sorted.
1132 static void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group
*dest
,
1133 struct ctf_fs_ds_file_group
*src
)
1137 for (i
= 0; i
< src
->ds_file_infos
->len
; i
++) {
1138 struct ctf_fs_ds_file_info
*ds_file_info
=
1139 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(src
->ds_file_infos
, i
);
1141 /* Ownership of the ds_file_info is transferred to dest. */
1142 g_ptr_array_index(src
->ds_file_infos
, i
) = NULL
;
1144 ds_file_group_insert_ds_file_info_sorted(dest
, ds_file_info
);
1147 /* Merge both indexes. */
1148 merge_ctf_fs_ds_indexes(dest
->index
, src
->index
);
1150 /* Merge src_trace's data stream file groups into dest_trace's. */
1152 static int merge_matching_ctf_fs_ds_file_groups(struct ctf_fs_trace
*dest_trace
,
1153 struct ctf_fs_trace
*src_trace
)
1155 GPtrArray
*dest
= dest_trace
->ds_file_groups
;
1156 GPtrArray
*src
= src_trace
->ds_file_groups
;
1161 * Save the initial length of dest: we only want to check against the
1162 * original elements in the inner loop.
1164 const guint dest_len
= dest
->len
;
1166 for (s_i
= 0; s_i
< src
->len
; s_i
++) {
1167 struct ctf_fs_ds_file_group
*src_group
=
1168 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(src
, s_i
);
1169 struct ctf_fs_ds_file_group
*dest_group
= NULL
;
1171 /* A stream instance without ID can't match a stream in the other trace. */
1172 if (src_group
->stream_id
!= -1) {
1175 /* Let's search for a matching ds_file_group in the destination. */
1176 for (d_i
= 0; d_i
< dest_len
; d_i
++) {
1177 struct ctf_fs_ds_file_group
*candidate_dest
=
1178 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(dest
, d_i
);
1180 /* Can't match a stream instance without ID. */
1181 if (candidate_dest
->stream_id
== -1) {
1186 * If the two groups have the same stream instance id
1187 * and belong to the same stream class (stream instance
1188 * ids are per-stream class), they represent the same
1191 if (candidate_dest
->stream_id
!= src_group
->stream_id
||
1192 candidate_dest
->sc
->id
!= src_group
->sc
->id
) {
1196 dest_group
= candidate_dest
;
1202 * Didn't find a friend in dest to merge our src_group into?
1203 * Create a new empty one. This can happen if a stream was
1204 * active in the source trace chunk but not in the destination
1208 struct ctf_stream_class
*sc
;
1209 struct ctf_fs_ds_index
*index
;
1211 sc
= ctf_trace_class_borrow_stream_class_by_id(dest_trace
->metadata
->tc
,
1215 index
= ctf_fs_ds_index_create(dest_trace
->logger
);
1221 dest_group
= ctf_fs_ds_file_group_create(dest_trace
, sc
, src_group
->stream_id
, index
);
1222 /* Ownership of index is transferred. */
1229 g_ptr_array_add(dest_trace
->ds_file_groups
, dest_group
);
1232 BT_ASSERT(dest_group
);
1233 merge_ctf_fs_ds_file_groups(dest_group
, src_group
);
1241 * Collapse the given traces, which must all share the same UUID, in a single
1244 * The trace with the most expansive metadata is chosen and all other traces
1245 * are merged into that one. The array slots of all the traces that get merged
1246 * in the chosen one are set to NULL, so only the slot of the chosen trace
1250 static int merge_ctf_fs_traces(struct ctf_fs_trace
**traces
, unsigned int num_traces
,
1251 struct ctf_fs_trace
**out_trace
)
1253 unsigned int winner_count
;
1254 struct ctf_fs_trace
*winner
;
1258 BT_ASSERT(num_traces
>= 2);
1260 winner_count
= metadata_count_stream_and_event_classes(traces
[0]);
1264 /* Find the trace with the largest metadata. */
1265 for (i
= 1; i
< num_traces
; i
++) {
1266 struct ctf_fs_trace
*candidate
;
1267 unsigned int candidate_count
;
1269 candidate
= traces
[i
];
1271 /* A bit of sanity check. */
1272 BT_ASSERT(bt_uuid_compare(winner
->metadata
->tc
->uuid
, candidate
->metadata
->tc
->uuid
) == 0);
1274 candidate_count
= metadata_count_stream_and_event_classes(candidate
);
1276 if (candidate_count
> winner_count
) {
1277 winner_count
= candidate_count
;
1283 /* Merge all the other traces in the winning trace. */
1284 for (i
= 0; i
< num_traces
; i
++) {
1285 struct ctf_fs_trace
*trace
= traces
[i
];
1287 /* Don't merge the winner into itself. */
1288 if (trace
== winner
) {
1292 /* Merge trace's data stream file groups into winner's. */
1293 ret
= merge_matching_ctf_fs_ds_file_groups(winner
, trace
);
1300 * Move the winner out of the array, into `*out_trace`.
1302 *out_trace
= winner
;
1303 traces
[winner_i
] = NULL
;
1315 static int decode_clock_snapshot_after_event(struct ctf_fs_trace
*ctf_fs_trace
,
1316 struct ctf_clock_class
*default_cc
,
1317 struct ctf_fs_ds_index_entry
*index_entry
,
1318 enum target_event target_event
, uint64_t *cs
,
1321 enum ctf_msg_iter_status iter_status
= CTF_MSG_ITER_STATUS_OK
;
1322 struct ctf_fs_ds_file
*ds_file
= NULL
;
1323 struct ctf_msg_iter
*msg_iter
= NULL
;
1326 BT_ASSERT(ctf_fs_trace
);
1327 BT_ASSERT(index_entry
);
1328 BT_ASSERT(index_entry
->path
);
1330 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, index_entry
->path
, ctf_fs_trace
->logger
);
1332 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to create a ctf_fs_ds_file");
1337 BT_ASSERT(ctf_fs_trace
->metadata
);
1338 BT_ASSERT(ctf_fs_trace
->metadata
->tc
);
1340 msg_iter
= ctf_msg_iter_create(
1341 ctf_fs_trace
->metadata
->tc
,
1342 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
1343 ctf_fs_ds_file_medops
, ds_file
, NULL
, ctf_fs_trace
->logger
);
1345 /* ctf_msg_iter_create() logs errors. */
1351 * Turn on dry run mode to prevent the creation and usage of Babeltrace
1352 * library objects (bt_field, bt_message_*, etc.).
1354 ctf_msg_iter_set_dry_run(msg_iter
, true);
1356 /* Seek to the beginning of the target packet. */
1357 iter_status
= ctf_msg_iter_seek(msg_iter
, index_entry
->offset
);
1359 /* ctf_msg_iter_seek() logs errors. */
1364 switch (target_event
) {
1367 * Start to decode the packet until we reach the end of
1368 * the first event. To extract the first event's clock
1371 iter_status
= ctf_msg_iter_curr_packet_first_event_clock_snapshot(msg_iter
, cs
);
1374 /* Decode the packet to extract the last event's clock snapshot. */
1375 iter_status
= ctf_msg_iter_curr_packet_last_event_clock_snapshot(msg_iter
, cs
);
1385 /* Convert clock snapshot to timestamp. */
1386 ret
= bt_util_clock_cycles_to_ns_from_origin(
1387 *cs
, default_cc
->frequency
, default_cc
->offset_seconds
, default_cc
->offset_cycles
, ts_ns
);
1389 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1390 "Failed to convert clock snapshot to timestamp");
1396 ctf_fs_ds_file_destroy(ds_file
);
1399 ctf_msg_iter_destroy(msg_iter
);
1405 static int decode_packet_first_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1406 struct ctf_clock_class
*default_cc
,
1407 struct ctf_fs_ds_index_entry
*index_entry
,
1408 uint64_t *cs
, int64_t *ts_ns
)
1410 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, FIRST_EVENT
, cs
,
1414 static int decode_packet_last_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1415 struct ctf_clock_class
*default_cc
,
1416 struct ctf_fs_ds_index_entry
*index_entry
,
1417 uint64_t *cs
, int64_t *ts_ns
)
1419 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, LAST_EVENT
, cs
,
1424 * Fix up packet index entries for lttng's "event-after-packet" bug.
1425 * Some buggy lttng tracer versions may emit events with a timestamp that is
1426 * larger (after) than the timestamp_end of the their packets.
1428 * To fix up this erroneous data we do the following:
1429 * 1. If it's not the stream file's last packet: set the packet index entry's
1430 * end time to the next packet's beginning time.
1431 * 2. If it's the stream file's last packet, set the packet index entry's end
1432 * time to the packet's last event's time, if any, or to the packet's
1433 * beginning time otherwise.
1435 * Known buggy tracer versions:
1436 * - before lttng-ust 2.11.0
1437 * - before lttng-module 2.11.0
1438 * - before lttng-module 2.10.10
1439 * - before lttng-module 2.9.13
1441 static int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace
*trace
)
1444 guint ds_file_group_i
;
1445 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1447 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
; ds_file_group_i
++) {
1449 struct ctf_clock_class
*default_cc
;
1450 struct ctf_fs_ds_index_entry
*last_entry
;
1451 struct ctf_fs_ds_index
*index
;
1453 struct ctf_fs_ds_file_group
*ds_file_group
=
1454 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1456 BT_ASSERT(ds_file_group
);
1457 index
= ds_file_group
->index
;
1460 BT_ASSERT(index
->entries
);
1461 BT_ASSERT(index
->entries
->len
> 0);
1464 * Iterate over all entries but the last one. The last one is
1465 * fixed differently after.
1467 for (entry_i
= 0; entry_i
< index
->entries
->len
- 1; entry_i
++) {
1468 struct ctf_fs_ds_index_entry
*curr_entry
, *next_entry
;
1470 curr_entry
= (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
);
1471 next_entry
= (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
+ 1);
1474 * 1. Set the current index entry `end` timestamp to
1475 * the next index entry `begin` timestamp.
1477 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1478 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1482 * 2. Fix the last entry by decoding the last event of the last
1486 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, index
->entries
->len
- 1);
1487 BT_ASSERT(last_entry
);
1489 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1490 default_cc
= ds_file_group
->sc
->default_clock_class
;
1493 * Decode packet to read the timestamp of the last event of the
1496 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1497 &last_entry
->timestamp_end
,
1498 &last_entry
->timestamp_end_ns
);
1500 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1502 "Failed to decode stream's last packet to get its last event's clock snapshot.");
1512 * Fix up packet index entries for barectf's "event-before-packet" bug.
1513 * Some buggy barectf tracer versions may emit events with a timestamp that is
1514 * less than the timestamp_begin of the their packets.
1516 * To fix up this erroneous data we do the following:
1517 * 1. Starting at the second index entry, set the timestamp_begin of the
1518 * current entry to the timestamp of the first event of the packet.
1519 * 2. Set the previous entry's timestamp_end to the timestamp_begin of the
1522 * Known buggy tracer versions:
1523 * - before barectf 2.3.1
1525 static int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace
*trace
)
1528 guint ds_file_group_i
;
1529 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1531 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
; ds_file_group_i
++) {
1533 struct ctf_clock_class
*default_cc
;
1534 ctf_fs_ds_file_group
*ds_file_group
=
1535 (ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1537 struct ctf_fs_ds_index
*index
= ds_file_group
->index
;
1540 BT_ASSERT(index
->entries
);
1541 BT_ASSERT(index
->entries
->len
> 0);
1543 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1544 default_cc
= ds_file_group
->sc
->default_clock_class
;
1547 * 1. Iterate over the index, starting from the second entry
1550 for (entry_i
= 1; entry_i
< index
->entries
->len
; entry_i
++) {
1551 ctf_fs_ds_index_entry
*prev_entry
=
1552 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
- 1);
1553 ctf_fs_ds_index_entry
*curr_entry
=
1554 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
);
1556 * 2. Set the current entry `begin` timestamp to the
1557 * timestamp of the first event of the current packet.
1559 ret
= decode_packet_first_event_timestamp(trace
, default_cc
, curr_entry
,
1560 &curr_entry
->timestamp_begin
,
1561 &curr_entry
->timestamp_begin_ns
);
1563 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1564 "Failed to decode first event's clock snapshot");
1569 * 3. Set the previous entry `end` timestamp to the
1570 * timestamp of the first event of the current packet.
1572 prev_entry
->timestamp_end
= curr_entry
->timestamp_begin
;
1573 prev_entry
->timestamp_end_ns
= curr_entry
->timestamp_begin_ns
;
1581 * When using the lttng-crash feature it's likely that the last packets of each
1582 * stream have their timestamp_end set to zero. This is caused by the fact that
1583 * the tracer crashed and was not able to properly close the packets.
1585 * To fix up this erroneous data we do the following:
1586 * For each index entry, if the entry's timestamp_end is 0 and the
1587 * timestamp_begin is not 0:
1588 * - If it's the stream file's last packet: set the packet index entry's end
1589 * time to the packet's last event's time, if any, or to the packet's
1590 * beginning time otherwise.
1591 * - If it's not the stream file's last packet: set the packet index
1592 * entry's end time to the next packet's beginning time.
1594 * Affected versions:
1595 * - All current and future lttng-ust and lttng-modules versions.
1597 static int fix_index_lttng_crash_quirk(struct ctf_fs_trace
*trace
)
1600 guint ds_file_group_idx
;
1601 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1603 for (ds_file_group_idx
= 0; ds_file_group_idx
< ds_file_groups
->len
; ds_file_group_idx
++) {
1605 struct ctf_clock_class
*default_cc
;
1606 struct ctf_fs_ds_index
*index
;
1608 ctf_fs_ds_file_group
*ds_file_group
=
1609 (ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_idx
);
1611 BT_ASSERT(ds_file_group
);
1612 index
= ds_file_group
->index
;
1614 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1615 default_cc
= ds_file_group
->sc
->default_clock_class
;
1618 BT_ASSERT(index
->entries
);
1619 BT_ASSERT(index
->entries
->len
> 0);
1621 ctf_fs_ds_index_entry
*last_entry
=
1622 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, index
->entries
->len
- 1);
1623 BT_ASSERT(last_entry
);
1625 /* 1. Fix the last entry first. */
1626 if (last_entry
->timestamp_end
== 0 && last_entry
->timestamp_begin
!= 0) {
1628 * Decode packet to read the timestamp of the
1629 * last event of the stream file.
1631 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1632 &last_entry
->timestamp_end
,
1633 &last_entry
->timestamp_end_ns
);
1635 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1636 "Failed to decode last event's clock snapshot");
1641 /* Iterate over all entries but the last one. */
1642 for (entry_idx
= 0; entry_idx
< index
->entries
->len
- 1; entry_idx
++) {
1643 ctf_fs_ds_index_entry
*curr_entry
=
1644 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_idx
);
1645 ctf_fs_ds_index_entry
*next_entry
=
1646 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_idx
+ 1);
1648 if (curr_entry
->timestamp_end
== 0 && curr_entry
->timestamp_begin
!= 0) {
1650 * 2. Set the current index entry `end` timestamp to
1651 * the next index entry `begin` timestamp.
1653 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1654 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1664 * Extract the tracer information necessary to compare versions.
1665 * Returns 0 on success, and -1 if the extraction is not successful because the
1666 * necessary fields are absents in the trace metadata.
1668 static int extract_tracer_info(struct ctf_fs_trace
*trace
, struct tracer_info
*current_tracer_info
)
1671 struct ctf_trace_class_env_entry
*entry
;
1673 /* Clear the current_tracer_info struct */
1674 memset(current_tracer_info
, 0, sizeof(*current_tracer_info
));
1677 * To compare 2 tracer versions, at least the tracer name and it's
1678 * major version are needed. If one of these is missing, consider it an
1679 * extraction failure.
1681 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_name");
1682 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR
) {
1683 goto missing_bare_minimum
;
1686 /* Set tracer name. */
1687 current_tracer_info
->name
= entry
->value
.str
->str
;
1689 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_major");
1690 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1691 goto missing_bare_minimum
;
1694 /* Set major version number. */
1695 current_tracer_info
->major
= entry
->value
.i
;
1697 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_minor");
1698 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1702 /* Set minor version number. */
1703 current_tracer_info
->minor
= entry
->value
.i
;
1705 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patch");
1708 * If `tracer_patch` doesn't exist `tracer_patchlevel` might.
1709 * For example, `lttng-modules` uses entry name
1710 * `tracer_patchlevel`.
1712 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patchlevel");
1715 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1719 /* Set patch version number. */
1720 current_tracer_info
->patch
= entry
->value
.i
;
1724 missing_bare_minimum
:
1730 static bool is_tracer_affected_by_lttng_event_after_packet_bug(struct tracer_info
*curr_tracer_info
)
1732 bool is_affected
= false;
1734 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1735 if (curr_tracer_info
->major
< 2) {
1737 } else if (curr_tracer_info
->major
== 2) {
1738 /* fixed in lttng-ust 2.11.0 */
1739 if (curr_tracer_info
->minor
< 11) {
1743 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1744 if (curr_tracer_info
->major
< 2) {
1746 } else if (curr_tracer_info
->major
== 2) {
1747 /* fixed in lttng-modules 2.11.0 */
1748 if (curr_tracer_info
->minor
== 10) {
1749 /* fixed in lttng-modules 2.10.10 */
1750 if (curr_tracer_info
->patch
< 10) {
1753 } else if (curr_tracer_info
->minor
== 9) {
1754 /* fixed in lttng-modules 2.9.13 */
1755 if (curr_tracer_info
->patch
< 13) {
1758 } else if (curr_tracer_info
->minor
< 9) {
1768 is_tracer_affected_by_barectf_event_before_packet_bug(struct tracer_info
*curr_tracer_info
)
1770 bool is_affected
= false;
1772 if (strcmp(curr_tracer_info
->name
, "barectf") == 0) {
1773 if (curr_tracer_info
->major
< 2) {
1775 } else if (curr_tracer_info
->major
== 2) {
1776 if (curr_tracer_info
->minor
< 3) {
1778 } else if (curr_tracer_info
->minor
== 3) {
1779 /* fixed in barectf 2.3.1 */
1780 if (curr_tracer_info
->patch
< 1) {
1790 static bool is_tracer_affected_by_lttng_crash_quirk(struct tracer_info
*curr_tracer_info
)
1792 bool is_affected
= false;
1794 /* All LTTng tracer may be affected by this lttng crash quirk. */
1795 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1797 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1805 * Looks for trace produced by known buggy tracers and fix up the index
1808 static int fix_packet_index_tracer_bugs(ctf_fs_trace
*trace
)
1811 struct tracer_info current_tracer_info
;
1813 ret
= extract_tracer_info(trace
, ¤t_tracer_info
);
1816 * A trace may not have all the necessary environment
1817 * entries to do the tracer version comparison.
1818 * At least, the tracer name and major version number
1819 * are needed. Failing to extract these entries is not
1823 BT_CPPLOGI_STR_SPEC(
1825 "Cannot extract tracer information necessary to compare with buggy versions.");
1829 /* Check if the trace may be affected by old tracer bugs. */
1830 if (is_tracer_affected_by_lttng_event_after_packet_bug(¤t_tracer_info
)) {
1831 BT_CPPLOGI_STR_SPEC(
1833 "Trace may be affected by LTTng tracer packet timestamp bug. Fixing up.");
1834 ret
= fix_index_lttng_event_after_packet_bug(trace
);
1836 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1837 "Failed to fix LTTng event-after-packet bug.");
1840 trace
->metadata
->tc
->quirks
.lttng_event_after_packet
= true;
1843 if (is_tracer_affected_by_barectf_event_before_packet_bug(¤t_tracer_info
)) {
1844 BT_CPPLOGI_STR_SPEC(
1846 "Trace may be affected by barectf tracer packet timestamp bug. Fixing up.");
1847 ret
= fix_index_barectf_event_before_packet_bug(trace
);
1849 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1850 "Failed to fix barectf event-before-packet bug.");
1853 trace
->metadata
->tc
->quirks
.barectf_event_before_packet
= true;
1856 if (is_tracer_affected_by_lttng_crash_quirk(¤t_tracer_info
)) {
1857 ret
= fix_index_lttng_crash_quirk(trace
);
1859 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1860 "Failed to fix lttng-crash timestamp quirks.");
1863 trace
->metadata
->tc
->quirks
.lttng_crash
= true;
1870 static gint
compare_ds_file_groups_by_first_path(gconstpointer a
, gconstpointer b
)
1872 ctf_fs_ds_file_group
* const *ds_file_group_a
= (ctf_fs_ds_file_group
**) a
;
1873 ctf_fs_ds_file_group
* const *ds_file_group_b
= (ctf_fs_ds_file_group
**) b
;
1875 BT_ASSERT((*ds_file_group_a
)->ds_file_infos
->len
> 0);
1876 BT_ASSERT((*ds_file_group_b
)->ds_file_infos
->len
> 0);
1878 const ctf_fs_ds_file_info
*first_ds_file_info_a
=
1879 (const ctf_fs_ds_file_info
*) (*ds_file_group_a
)->ds_file_infos
->pdata
[0];
1880 const ctf_fs_ds_file_info
*first_ds_file_info_b
=
1881 (const ctf_fs_ds_file_info
*) (*ds_file_group_b
)->ds_file_infos
->pdata
[0];
1883 return strcmp(first_ds_file_info_a
->path
->str
, first_ds_file_info_b
->path
->str
);
1886 static gint
compare_strings(gconstpointer p_a
, gconstpointer p_b
)
1888 const char *a
= *((const char **) p_a
);
1889 const char *b
= *((const char **) p_b
);
1891 return strcmp(a
, b
);
1894 int ctf_fs_component_create_ctf_fs_trace(struct ctf_fs_component
*ctf_fs
,
1895 const bt_value
*paths_value
,
1896 const bt_value
*trace_name_value
,
1897 bt_self_component
*selfComp
)
1901 GPtrArray
*paths
= NULL
;
1903 const char *trace_name
;
1905 BT_ASSERT(bt_value_get_type(paths_value
) == BT_VALUE_TYPE_ARRAY
);
1906 BT_ASSERT(!bt_value_array_is_empty(paths_value
));
1908 traces
= g_ptr_array_new_with_free_func(ctf_fs_trace_destroy_notifier
);
1910 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to allocate a GPtrArray.");
1914 paths
= g_ptr_array_new_with_free_func(g_free
);
1916 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to allocate a GPtrArray.");
1920 trace_name
= trace_name_value
? bt_value_string_get(trace_name_value
) : NULL
;
1923 * Create a sorted array of the paths, to make the execution of this
1924 * component deterministic.
1926 for (i
= 0; i
< bt_value_array_get_length(paths_value
); i
++) {
1927 const bt_value
*path_value
= bt_value_array_borrow_element_by_index_const(paths_value
, i
);
1928 const char *input
= bt_value_string_get(path_value
);
1931 input_copy
= g_strdup(input
);
1933 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to copy a string.");
1937 g_ptr_array_add(paths
, input_copy
);
1940 g_ptr_array_sort(paths
, compare_strings
);
1942 /* Create a separate ctf_fs_trace object for each path. */
1943 for (i
= 0; i
< paths
->len
; i
++) {
1944 const char *path
= (const char *) g_ptr_array_index(paths
, i
);
1946 ret
= ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs
, path
, trace_name
, traces
,
1953 if (traces
->len
> 1) {
1954 struct ctf_fs_trace
*first_trace
= (struct ctf_fs_trace
*) traces
->pdata
[0];
1955 const uint8_t *first_trace_uuid
= first_trace
->metadata
->tc
->uuid
;
1956 struct ctf_fs_trace
*trace
;
1959 * We have more than one trace, they must all share the same
1960 * UUID, verify that.
1962 for (i
= 0; i
< traces
->len
; i
++) {
1963 struct ctf_fs_trace
*this_trace
= (struct ctf_fs_trace
*) traces
->pdata
[i
];
1964 const uint8_t *this_trace_uuid
= this_trace
->metadata
->tc
->uuid
;
1966 if (!this_trace
->metadata
->tc
->is_uuid_set
) {
1967 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1969 "Multiple traces given, but a trace does not have a UUID: path={}",
1970 this_trace
->path
->str
);
1974 if (bt_uuid_compare(first_trace_uuid
, this_trace_uuid
) != 0) {
1975 char first_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1976 char this_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1978 bt_uuid_to_str(first_trace_uuid
, first_trace_uuid_str
);
1979 bt_uuid_to_str(this_trace_uuid
, this_trace_uuid_str
);
1981 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1982 "Multiple traces given, but UUIDs don't match: "
1983 "first-trace-uuid={}, first-trace-path={}, "
1984 "trace-uuid={}, trace-path={}",
1985 first_trace_uuid_str
, first_trace
->path
->str
,
1986 this_trace_uuid_str
, this_trace
->path
->str
);
1991 ret
= merge_ctf_fs_traces((struct ctf_fs_trace
**) traces
->pdata
, traces
->len
, &trace
);
1993 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1994 "Failed to merge traces with the same UUID.");
1998 ctf_fs
->trace
= trace
;
2000 /* Just one trace, it may or may not have a UUID, both are fine. */
2001 ctf_fs
->trace
= (ctf_fs_trace
*) traces
->pdata
[0];
2002 traces
->pdata
[0] = NULL
;
2005 ret
= fix_packet_index_tracer_bugs(ctf_fs
->trace
);
2007 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to fix packet index tracer bugs.");
2011 * Sort data stream file groups by first data stream file info
2012 * path to get a deterministic order. This order influences the
2013 * order of the output ports. It also influences the order of
2014 * the automatic stream IDs if the trace's packet headers do not
2015 * contain a `stream_instance_id` field, in which case the data
2016 * stream file to stream ID association is always the same,
2017 * whatever the build and the system.
2019 * Having a deterministic order here can help debugging and
2022 g_ptr_array_sort(ctf_fs
->trace
->ds_file_groups
, compare_ds_file_groups_by_first_path
);
2029 g_ptr_array_free(traces
, TRUE
);
2033 g_ptr_array_free(paths
, TRUE
);
2039 static GString
*get_stream_instance_unique_name(struct ctf_fs_ds_file_group
*ds_file_group
)
2042 struct ctf_fs_ds_file_info
*ds_file_info
;
2044 name
= g_string_new(NULL
);
2050 * If there's more than one stream file in the stream file
2051 * group, the first (earliest) stream file's path is used as
2052 * the stream's unique name.
2054 BT_ASSERT(ds_file_group
->ds_file_infos
->len
> 0);
2055 ds_file_info
= (ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
2056 g_string_assign(name
, ds_file_info
->path
->str
);
2062 /* Create the IR stream objects for ctf_fs_trace. */
2064 static int create_streams_for_trace(struct ctf_fs_trace
*ctf_fs_trace
)
2067 GString
*name
= NULL
;
2070 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
2071 ctf_fs_ds_file_group
*ds_file_group
=
2072 (ctf_fs_ds_file_group
*) g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
2073 name
= get_stream_instance_unique_name(ds_file_group
);
2079 if (ds_file_group
->sc
->ir_sc
) {
2080 BT_ASSERT(ctf_fs_trace
->trace
);
2082 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
2083 /* No stream ID: use 0 */
2084 ds_file_group
->stream
= bt_stream_create_with_id(
2085 ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
, ctf_fs_trace
->next_stream_id
);
2086 ctf_fs_trace
->next_stream_id
++;
2088 /* Specific stream ID */
2089 ds_file_group
->stream
=
2090 bt_stream_create_with_id(ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
,
2091 (uint64_t) ds_file_group
->stream_id
);
2094 ds_file_group
->stream
= NULL
;
2097 if (!ds_file_group
->stream
) {
2098 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
2099 "Cannot create stream for DS file group: "
2100 "addr={}, stream-name=\"{}\"",
2101 fmt::ptr(ds_file_group
), name
->str
);
2105 ret
= bt_stream_set_name(ds_file_group
->stream
, name
->str
);
2107 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
2108 "Cannot set stream's name: "
2109 "addr={}, stream-name=\"{}\"",
2110 fmt::ptr(ds_file_group
->stream
), name
->str
);
2114 g_string_free(name
, TRUE
);
2127 g_string_free(name
, TRUE
);
2132 static const bt_param_validation_value_descr inputs_elem_descr
=
2133 bt_param_validation_value_descr::makeString();
2135 static bt_param_validation_map_value_entry_descr fs_params_entries_descr
[] = {
2136 {"inputs", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
2137 bt_param_validation_value_descr::makeArray(1, BT_PARAM_VALIDATION_INFINITE
,
2138 inputs_elem_descr
)},
2139 {"trace-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2140 bt_param_validation_value_descr::makeString()},
2141 {"clock-class-offset-s", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2142 bt_param_validation_value_descr::makeSignedInteger()},
2143 {"clock-class-offset-ns", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2144 bt_param_validation_value_descr::makeSignedInteger()},
2145 {"force-clock-class-origin-unix-epoch", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2146 bt_param_validation_value_descr::makeBool()},
2147 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
2149 bool read_src_fs_parameters(const bt_value
*params
, const bt_value
**inputs
,
2150 const bt_value
**trace_name
, struct ctf_fs_component
*ctf_fs
)
2153 const bt_value
*value
;
2154 enum bt_param_validation_status validate_value_status
;
2155 gchar
*error
= NULL
;
2157 validate_value_status
= bt_param_validation_validate(params
, fs_params_entries_descr
, &error
);
2158 if (validate_value_status
!= BT_PARAM_VALIDATION_STATUS_OK
) {
2159 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "{}", error
);
2164 /* inputs parameter */
2165 *inputs
= bt_value_map_borrow_entry_value_const(params
, "inputs");
2167 /* clock-class-offset-s parameter */
2168 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-s");
2170 ctf_fs
->metadata_config
.clock_class_offset_s
= bt_value_integer_signed_get(value
);
2173 /* clock-class-offset-ns parameter */
2174 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-ns");
2176 ctf_fs
->metadata_config
.clock_class_offset_ns
= bt_value_integer_signed_get(value
);
2179 /* force-clock-class-origin-unix-epoch parameter */
2180 value
= bt_value_map_borrow_entry_value_const(params
, "force-clock-class-origin-unix-epoch");
2182 ctf_fs
->metadata_config
.force_clock_class_origin_unix_epoch
= bt_value_bool_get(value
);
2185 /* trace-name parameter */
2186 *trace_name
= bt_value_map_borrow_entry_value_const(params
, "trace-name");
2195 static ctf_fs_component::UP
ctf_fs_create(const bt_value
*params
,
2196 bt_self_component_source
*self_comp_src
)
2198 const bt_value
*inputs_value
;
2199 const bt_value
*trace_name_value
;
2200 bt_self_component
*self_comp
= bt_self_component_source_as_self_component(self_comp_src
);
2202 ctf_fs_component::UP ctf_fs
= ctf_fs_component_create(
2203 bt2c::Logger
{bt2::SelfSourceComponent
{self_comp_src
}, "PLUGIN/SRC.CTF.FS/COMP"});
2208 if (!read_src_fs_parameters(params
, &inputs_value
, &trace_name_value
, ctf_fs
.get())) {
2212 if (ctf_fs_component_create_ctf_fs_trace(ctf_fs
.get(), inputs_value
, trace_name_value
,
2217 if (create_streams_for_trace(ctf_fs
->trace
)) {
2221 if (create_ports_for_trace(ctf_fs
.get(), ctf_fs
->trace
, self_comp_src
)) {
2228 bt_component_class_initialize_method_status
ctf_fs_init(bt_self_component_source
*self_comp_src
,
2229 bt_self_component_source_configuration
*,
2230 const bt_value
*params
, void *)
2233 bt_component_class_initialize_method_status ret
=
2234 BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
2236 ctf_fs_component::UP ctf_fs
= ctf_fs_create(params
, self_comp_src
);
2238 ret
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
2241 bt_self_component_set_data(bt_self_component_source_as_self_component(self_comp_src
),
2244 } catch (const std::bad_alloc
&) {
2245 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
2246 } catch (const bt2::Error
&) {
2247 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
2251 bt_component_class_query_method_status
ctf_fs_query(bt_self_component_class_source
*comp_class_src
,
2252 bt_private_query_executor
*priv_query_exec
,
2253 const char *object
, const bt_value
*params
,
2254 __attribute__((unused
)) void *method_data
,
2255 const bt_value
**result
)
2258 bt2c::Logger logger
{bt2::SelfComponentClass
{comp_class_src
},
2259 bt2::PrivateQueryExecutor
{priv_query_exec
},
2260 "PLUGIN/SRC.CTF.FS/QUERY"};
2261 bt2::ConstMapValue
paramsObj(params
);
2262 bt2::Value::Shared resultObj
;
2264 if (strcmp(object
, "metadata-info") == 0) {
2265 resultObj
= metadata_info_query(paramsObj
, logger
);
2266 } else if (strcmp(object
, "babeltrace.trace-infos") == 0) {
2267 resultObj
= trace_infos_query(paramsObj
, logger
);
2268 } else if (!strcmp(object
, "babeltrace.support-info")) {
2269 resultObj
= support_info_query(paramsObj
, logger
);
2271 BT_CPPLOGE_SPEC(logger
, "Unknown query object `{}`", object
);
2272 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;
2275 *result
= resultObj
.release().libObjPtr();
2277 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
2278 } catch (const std::bad_alloc
&) {
2279 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
2280 } catch (const bt2::Error
&) {
2281 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;