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 static void port_data_destroy(struct ctf_fs_port_data
*port_data
)
325 static void port_data_destroy_notifier(void *data
)
327 port_data_destroy((struct ctf_fs_port_data
*) data
);
330 static void ctf_fs_trace_destroy_notifier(void *data
)
332 struct ctf_fs_trace
*trace
= (struct ctf_fs_trace
*) data
;
333 ctf_fs_trace_destroy(trace
);
336 ctf_fs_component
*ctf_fs_component_create(const bt2c::Logger
& parentLogger
)
338 ctf_fs_component
*ctf_fs
= new ctf_fs_component
{parentLogger
};
339 ctf_fs
->port_data
= g_ptr_array_new_with_free_func(port_data_destroy_notifier
);
340 if (!ctf_fs
->port_data
) {
347 ctf_fs_destroy(ctf_fs
);
354 void ctf_fs_finalize(bt_self_component_source
*component
)
356 ctf_fs_destroy((struct ctf_fs_component
*) bt_self_component_get_data(
357 bt_self_component_source_as_self_component(component
)));
360 gchar
*ctf_fs_make_port_name(struct ctf_fs_ds_file_group
*ds_file_group
)
362 GString
*name
= g_string_new(NULL
);
365 * The unique port name is generated by concatenating unique identifiers
373 /* For the trace, use the uuid if present, else the path. */
374 if (ds_file_group
->ctf_fs_trace
->metadata
->tc
->is_uuid_set
) {
375 char uuid_str
[BT_UUID_STR_LEN
+ 1];
377 bt_uuid_to_str(ds_file_group
->ctf_fs_trace
->metadata
->tc
->uuid
, uuid_str
);
378 g_string_assign(name
, uuid_str
);
380 g_string_assign(name
, ds_file_group
->ctf_fs_trace
->path
->str
);
384 * For the stream class, use the id if present. We can omit this field
385 * otherwise, as there will only be a single stream class.
387 if (ds_file_group
->sc
->id
!= UINT64_C(-1)) {
388 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->sc
->id
);
391 /* For the stream, use the id if present, else, use the path. */
392 if (ds_file_group
->stream_id
!= UINT64_C(-1)) {
393 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->stream_id
);
395 BT_ASSERT(ds_file_group
->ds_file_infos
->len
== 1);
396 struct ctf_fs_ds_file_info
*ds_file_info
=
397 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
398 g_string_append_printf(name
, " | %s", ds_file_info
->path
->str
);
401 return g_string_free(name
, FALSE
);
404 static int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
405 struct ctf_fs_ds_file_group
*ds_file_group
,
406 bt_self_component_source
*self_comp_src
)
409 struct ctf_fs_port_data
*port_data
= NULL
;
412 port_name
= ctf_fs_make_port_name(ds_file_group
);
417 BT_CPPLOGI_SPEC(ctf_fs
->logger
, "Creating one port named `{}`", port_name
);
419 /* Create output port for this file */
420 port_data
= new ctf_fs_port_data
;
421 port_data
->ctf_fs
= ctf_fs
;
422 port_data
->ds_file_group
= ds_file_group
;
423 ret
= bt_self_component_source_add_output_port(self_comp_src
, port_name
, port_data
, NULL
);
428 g_ptr_array_add(ctf_fs
->port_data
, port_data
);
438 port_data_destroy(port_data
);
442 static int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
443 struct ctf_fs_trace
*ctf_fs_trace
,
444 bt_self_component_source
*self_comp_src
)
449 /* Create one output port for each stream file group */
450 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
451 struct ctf_fs_ds_file_group
*ds_file_group
=
452 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
454 ret
= create_one_port_for_trace(ctf_fs
, ds_file_group
, self_comp_src
);
456 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create output port.");
465 static void ctf_fs_ds_file_info_destroy(struct ctf_fs_ds_file_info
*ds_file_info
)
471 if (ds_file_info
->path
) {
472 g_string_free(ds_file_info
->path
, TRUE
);
478 static struct ctf_fs_ds_file_info
*ctf_fs_ds_file_info_create(const char *path
, int64_t begin_ns
)
480 ctf_fs_ds_file_info
*ds_file_info
= new ctf_fs_ds_file_info
;
481 ds_file_info
->path
= g_string_new(path
);
482 if (!ds_file_info
->path
) {
483 ctf_fs_ds_file_info_destroy(ds_file_info
);
488 ds_file_info
->begin_ns
= begin_ns
;
494 static void ctf_fs_ds_file_group_destroy(struct ctf_fs_ds_file_group
*ds_file_group
)
496 if (!ds_file_group
) {
500 if (ds_file_group
->ds_file_infos
) {
501 g_ptr_array_free(ds_file_group
->ds_file_infos
, TRUE
);
504 ctf_fs_ds_index_destroy(ds_file_group
->index
);
506 bt_stream_put_ref(ds_file_group
->stream
);
507 delete ds_file_group
;
510 static struct ctf_fs_ds_file_group
*ctf_fs_ds_file_group_create(struct ctf_fs_trace
*ctf_fs_trace
,
511 struct ctf_stream_class
*sc
,
512 uint64_t stream_instance_id
,
513 struct ctf_fs_ds_index
*index
)
515 ctf_fs_ds_file_group
*ds_file_group
= new ctf_fs_ds_file_group
;
516 ds_file_group
->ds_file_infos
=
517 g_ptr_array_new_with_free_func((GDestroyNotify
) ctf_fs_ds_file_info_destroy
);
518 if (!ds_file_group
->ds_file_infos
) {
522 ds_file_group
->index
= index
;
524 ds_file_group
->stream_id
= stream_instance_id
;
526 ds_file_group
->sc
= sc
;
527 ds_file_group
->ctf_fs_trace
= ctf_fs_trace
;
531 ctf_fs_ds_file_group_destroy(ds_file_group
);
532 ctf_fs_ds_index_destroy(index
);
533 ds_file_group
= NULL
;
536 return ds_file_group
;
539 /* Replace by g_ptr_array_insert when we depend on glib >= 2.40. */
540 static void array_insert(GPtrArray
*array
, gpointer element
, size_t pos
)
542 size_t original_array_len
= array
->len
;
544 /* Allocate an unused element at the end of the array. */
545 g_ptr_array_add(array
, NULL
);
547 /* If we are not inserting at the end, move the elements by one. */
548 if (pos
< original_array_len
) {
549 memmove(&(array
->pdata
[pos
+ 1]), &(array
->pdata
[pos
]),
550 (original_array_len
- pos
) * sizeof(gpointer
));
553 /* Insert the value. */
554 array
->pdata
[pos
] = element
;
558 * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right
559 * place to keep it sorted.
562 static void ds_file_group_insert_ds_file_info_sorted(struct ctf_fs_ds_file_group
*ds_file_group
,
563 struct ctf_fs_ds_file_info
*ds_file_info
)
567 /* Find the spot where to insert this ds_file_info. */
568 for (i
= 0; i
< ds_file_group
->ds_file_infos
->len
; i
++) {
569 struct ctf_fs_ds_file_info
*other_ds_file_info
=
570 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, i
);
572 if (ds_file_info
->begin_ns
< other_ds_file_info
->begin_ns
) {
577 array_insert(ds_file_group
->ds_file_infos
, ds_file_info
, i
);
580 static bool ds_index_entries_equal(const struct ctf_fs_ds_index_entry
*left
,
581 const struct ctf_fs_ds_index_entry
*right
)
583 if (left
->packet_size
!= right
->packet_size
) {
587 if (left
->timestamp_begin
!= right
->timestamp_begin
) {
591 if (left
->timestamp_end
!= right
->timestamp_end
) {
595 if (left
->packet_seq_num
!= right
->packet_seq_num
) {
603 * Insert `entry` into `index`, without duplication.
605 * The entry is inserted only if there isn't an identical entry already.
607 * In any case, the ownership of `entry` is transferred to this function. So if
608 * the entry is not inserted, it is freed.
611 static void ds_index_insert_ds_index_entry_sorted(struct ctf_fs_ds_index
*index
,
612 struct ctf_fs_ds_index_entry
*entry
)
615 struct ctf_fs_ds_index_entry
*other_entry
= NULL
;
617 /* Find the spot where to insert this index entry. */
618 for (i
= 0; i
< index
->entries
->len
; i
++) {
619 other_entry
= (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, i
);
621 if (entry
->timestamp_begin_ns
<= other_entry
->timestamp_begin_ns
) {
627 * Insert the entry only if a duplicate doesn't already exist.
629 * There can be duplicate packets if reading multiple overlapping
630 * snapshots of the same trace. We then want the index to contain
631 * a reference to only one copy of that packet.
633 if (i
== index
->entries
->len
|| !ds_index_entries_equal(entry
, other_entry
)) {
634 array_insert(index
->entries
, entry
, i
);
640 static void merge_ctf_fs_ds_indexes(struct ctf_fs_ds_index
*dest
, struct ctf_fs_ds_index
*src
)
644 for (i
= 0; i
< src
->entries
->len
; i
++) {
645 struct ctf_fs_ds_index_entry
*entry
=
646 (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(src
->entries
, i
);
649 * Ownership of the ctf_fs_ds_index_entry is transferred to
650 * ds_index_insert_ds_index_entry_sorted.
652 g_ptr_array_index(src
->entries
, i
) = NULL
;
653 ds_index_insert_ds_index_entry_sorted(dest
, entry
);
657 static int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
, const char *path
)
659 int64_t stream_instance_id
= -1;
660 int64_t begin_ns
= -1;
661 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
662 bool add_group
= false;
665 struct ctf_fs_ds_file
*ds_file
= NULL
;
666 struct ctf_fs_ds_file_info
*ds_file_info
= NULL
;
667 struct ctf_fs_ds_index
*index
= NULL
;
668 struct ctf_msg_iter
*msg_iter
= NULL
;
669 struct ctf_stream_class
*sc
= NULL
;
670 struct ctf_msg_iter_packet_properties props
;
673 * Create a temporary ds_file to read some properties about the data
676 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, path
, ctf_fs_trace
->logger
);
681 /* Create a temporary iterator to read the ds_file. */
682 msg_iter
= ctf_msg_iter_create(
683 ctf_fs_trace
->metadata
->tc
,
684 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
685 ctf_fs_ds_file_medops
, ds_file
, nullptr, ctf_fs_trace
->logger
);
687 BT_CPPLOGE_STR_SPEC(ctf_fs_trace
->logger
, "Cannot create a CTF message iterator.");
691 ctf_msg_iter_set_dry_run(msg_iter
, true);
693 ret
= ctf_msg_iter_get_packet_properties(msg_iter
, &props
);
695 BT_CPPLOGE_APPEND_CAUSE_SPEC(
696 ctf_fs_trace
->logger
,
697 "Cannot get stream file's first packet's header and context fields (`{}`).", path
);
701 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
, props
.stream_class_id
);
703 stream_instance_id
= props
.data_stream_id
;
705 if (props
.snapshots
.beginning_clock
!= UINT64_C(-1)) {
706 BT_ASSERT(sc
->default_clock_class
);
707 ret
= bt_util_clock_cycles_to_ns_from_origin(
708 props
.snapshots
.beginning_clock
, sc
->default_clock_class
->frequency
,
709 sc
->default_clock_class
->offset_seconds
, sc
->default_clock_class
->offset_cycles
,
712 BT_CPPLOGE_APPEND_CAUSE_SPEC(
713 ctf_fs_trace
->logger
,
714 "Cannot convert clock cycles to nanoseconds from origin (`{}`).", path
);
719 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
);
724 index
= ctf_fs_ds_file_build_index(ds_file
, ds_file_info
, msg_iter
);
726 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to index CTF stream file \'{}\'",
727 ds_file
->file
->path
->str
);
731 if (begin_ns
== -1) {
733 * No beginning timestamp to sort the stream files
734 * within a stream file group, so consider that this
735 * file must be the only one within its group.
737 stream_instance_id
= -1;
740 if (stream_instance_id
== -1) {
742 * No stream instance ID or no beginning timestamp:
743 * create a unique stream file group for this stream
744 * file because, even if there's a stream instance ID,
745 * there's no timestamp to order the file within its
748 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, UINT64_C(-1), index
);
749 /* Ownership of index is transferred. */
752 if (!ds_file_group
) {
756 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, BT_MOVE_REF(ds_file_info
));
762 BT_ASSERT(stream_instance_id
!= -1);
763 BT_ASSERT(begin_ns
!= -1);
765 /* Find an existing stream file group with this ID */
766 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
768 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
770 if (ds_file_group
->sc
== sc
&& ds_file_group
->stream_id
== stream_instance_id
) {
774 ds_file_group
= NULL
;
777 if (!ds_file_group
) {
778 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, stream_instance_id
, index
);
779 /* Ownership of index is transferred. */
781 if (!ds_file_group
) {
787 merge_ctf_fs_ds_indexes(ds_file_group
->index
, index
);
790 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, BT_MOVE_REF(ds_file_info
));
795 ctf_fs_ds_file_group_destroy(ds_file_group
);
796 ds_file_group
= NULL
;
800 if (add_group
&& ds_file_group
) {
801 g_ptr_array_add(ctf_fs_trace
->ds_file_groups
, ds_file_group
);
804 ctf_fs_ds_file_destroy(ds_file
);
805 ctf_fs_ds_file_info_destroy(ds_file_info
);
808 ctf_msg_iter_destroy(msg_iter
);
811 ctf_fs_ds_index_destroy(index
);
815 static int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
818 const char *basename
;
819 GError
*error
= NULL
;
822 /* Check each file in the path directory, except specific ones */
823 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
825 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
826 "Cannot open directory `{}`: {} (code {})",
827 ctf_fs_trace
->path
->str
, error
->message
, error
->code
);
831 while ((basename
= g_dir_read_name(dir
))) {
832 struct ctf_fs_file
*file
;
834 if (strcmp(basename
, CTF_FS_METADATA_FILENAME
) == 0) {
835 /* Ignore the metadata stream. */
836 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
837 "Ignoring metadata file `{}" G_DIR_SEPARATOR_S
"{}`",
838 ctf_fs_trace
->path
->str
, basename
);
842 if (basename
[0] == '.') {
843 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
844 "Ignoring hidden file `{}" G_DIR_SEPARATOR_S
"{}`",
845 ctf_fs_trace
->path
->str
, basename
);
849 /* Create the file. */
850 file
= ctf_fs_file_create(ctf_fs_trace
->logger
);
852 BT_CPPLOGE_APPEND_CAUSE_SPEC(
853 ctf_fs_trace
->logger
,
854 "Cannot create stream file object for file `{}" G_DIR_SEPARATOR_S
"{}`",
855 ctf_fs_trace
->path
->str
, basename
);
859 /* Create full path string. */
860 g_string_append_printf(file
->path
, "%s" G_DIR_SEPARATOR_S
"%s", ctf_fs_trace
->path
->str
,
862 if (!g_file_test(file
->path
->str
, G_FILE_TEST_IS_REGULAR
)) {
863 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring non-regular file `{}`",
865 ctf_fs_file_destroy(file
);
870 ret
= ctf_fs_file_open(file
, "rb");
872 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Cannot open stream file `{}`",
877 if (file
->size
== 0) {
878 /* Skip empty stream. */
879 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring empty file `{}`", file
->path
->str
);
880 ctf_fs_file_destroy(file
);
884 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
, file
->path
->str
);
886 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
887 "Cannot add stream file `{}` to stream file group",
889 ctf_fs_file_destroy(file
);
893 ctf_fs_file_destroy(file
);
914 static int set_trace_name(bt_trace
*trace
, const char *name_suffix
, const bt2c::Logger
& logger
)
920 name
= g_string_new(NULL
);
922 BT_CPPLOGE_STR_SPEC(logger
, "Failed to allocate a GString.");
928 * Check if we have a trace environment string value named `hostname`.
929 * If so, use it as the trace name's prefix.
931 val
= bt_trace_borrow_environment_entry_value_by_name_const(trace
, "hostname");
932 if (val
&& bt_value_is_string(val
)) {
933 g_string_append(name
, bt_value_string_get(val
));
936 g_string_append_c(name
, G_DIR_SEPARATOR
);
941 g_string_append(name
, name_suffix
);
944 ret
= bt_trace_set_name(trace
, name
->str
);
953 g_string_free(name
, TRUE
);
959 static struct ctf_fs_trace
*ctf_fs_trace_create(const char *path
, const char *name
,
960 struct ctf_fs_metadata_config
*metadata_config
,
961 bt_self_component
*selfComp
,
962 const bt2c::Logger
& parentLogger
)
966 ctf_fs_trace
*ctf_fs_trace
= new struct ctf_fs_trace(parentLogger
);
967 ctf_fs_trace
->path
= g_string_new(path
);
968 if (!ctf_fs_trace
->path
) {
972 ctf_fs_trace
->metadata
= new ctf_fs_metadata
;
973 ctf_fs_metadata_init(ctf_fs_trace
->metadata
);
974 ctf_fs_trace
->ds_file_groups
=
975 g_ptr_array_new_with_free_func((GDestroyNotify
) ctf_fs_ds_file_group_destroy
);
976 if (!ctf_fs_trace
->ds_file_groups
) {
980 ret
= ctf_fs_metadata_set_trace_class(selfComp
, ctf_fs_trace
, metadata_config
);
985 if (ctf_fs_trace
->metadata
->trace_class
) {
986 ctf_fs_trace
->trace
= bt_trace_create(ctf_fs_trace
->metadata
->trace_class
);
987 if (!ctf_fs_trace
->trace
) {
992 if (ctf_fs_trace
->trace
) {
993 ret
= ctf_trace_class_configure_ir_trace(ctf_fs_trace
->metadata
->tc
, ctf_fs_trace
->trace
);
998 ret
= set_trace_name(ctf_fs_trace
->trace
, name
, ctf_fs_trace
->logger
);
1004 ret
= create_ds_file_groups(ctf_fs_trace
);
1012 ctf_fs_trace_destroy(ctf_fs_trace
);
1013 ctf_fs_trace
= NULL
;
1016 return ctf_fs_trace
;
1019 static int path_is_ctf_trace(const char *path
)
1021 GString
*metadata_path
= g_string_new(NULL
);
1024 if (!metadata_path
) {
1029 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
1031 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
1037 g_string_free(metadata_path
, TRUE
);
1041 /* Helper for ctf_fs_component_create_ctf_fs_trace, to handle a single path. */
1043 static int ctf_fs_component_create_ctf_fs_trace_one_path(struct ctf_fs_component
*ctf_fs
,
1044 const char *path_param
,
1045 const char *trace_name
, GPtrArray
*traces
,
1046 bt_self_component
*selfComp
)
1048 struct ctf_fs_trace
*ctf_fs_trace
;
1052 norm_path
= bt_common_normalize_path(path_param
, NULL
);
1054 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to normalize path: `{}`.", path_param
);
1058 ret
= path_is_ctf_trace(norm_path
->str
);
1060 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1061 ctf_fs
->logger
, "Failed to check if path is a CTF trace: path={}", norm_path
->str
);
1063 } else if (ret
== 0) {
1064 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1065 ctf_fs
->logger
, "Path is not a CTF trace (does not contain a metadata file): `{}`.",
1070 // FIXME: Remove or ifdef for __MINGW32__
1071 if (strcmp(norm_path
->str
, "/") == 0) {
1072 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Opening a trace in `/` is not supported.");
1077 ctf_fs_trace
= ctf_fs_trace_create(norm_path
->str
, trace_name
, &ctf_fs
->metadata_config
,
1078 selfComp
, ctf_fs
->logger
);
1079 if (!ctf_fs_trace
) {
1080 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create trace for `{}`.",
1085 g_ptr_array_add(traces
, ctf_fs_trace
);
1086 ctf_fs_trace
= NULL
;
1096 g_string_free(norm_path
, TRUE
);
1103 * Count the number of stream and event classes defined by this trace's metadata.
1105 * This is used to determine which metadata is the "latest", out of multiple
1106 * traces sharing the same UUID. It is assumed that amongst all these metadatas,
1107 * a bigger metadata is a superset of a smaller metadata. Therefore, it is
1108 * enough to just count the classes.
1111 static unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace
*trace
)
1113 unsigned int num
= trace
->metadata
->tc
->stream_classes
->len
;
1116 for (i
= 0; i
< trace
->metadata
->tc
->stream_classes
->len
; i
++) {
1117 struct ctf_stream_class
*sc
=
1118 (struct ctf_stream_class
*) trace
->metadata
->tc
->stream_classes
->pdata
[i
];
1119 num
+= sc
->event_classes
->len
;
1126 * Merge the src ds_file_group into dest. This consists of merging their
1127 * ds_file_infos, making sure to keep the result sorted.
1130 static void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group
*dest
,
1131 struct ctf_fs_ds_file_group
*src
)
1135 for (i
= 0; i
< src
->ds_file_infos
->len
; i
++) {
1136 struct ctf_fs_ds_file_info
*ds_file_info
=
1137 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(src
->ds_file_infos
, i
);
1139 /* Ownership of the ds_file_info is transferred to dest. */
1140 g_ptr_array_index(src
->ds_file_infos
, i
) = NULL
;
1142 ds_file_group_insert_ds_file_info_sorted(dest
, ds_file_info
);
1145 /* Merge both indexes. */
1146 merge_ctf_fs_ds_indexes(dest
->index
, src
->index
);
1148 /* Merge src_trace's data stream file groups into dest_trace's. */
1150 static int merge_matching_ctf_fs_ds_file_groups(struct ctf_fs_trace
*dest_trace
,
1151 struct ctf_fs_trace
*src_trace
)
1153 GPtrArray
*dest
= dest_trace
->ds_file_groups
;
1154 GPtrArray
*src
= src_trace
->ds_file_groups
;
1159 * Save the initial length of dest: we only want to check against the
1160 * original elements in the inner loop.
1162 const guint dest_len
= dest
->len
;
1164 for (s_i
= 0; s_i
< src
->len
; s_i
++) {
1165 struct ctf_fs_ds_file_group
*src_group
=
1166 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(src
, s_i
);
1167 struct ctf_fs_ds_file_group
*dest_group
= NULL
;
1169 /* A stream instance without ID can't match a stream in the other trace. */
1170 if (src_group
->stream_id
!= -1) {
1173 /* Let's search for a matching ds_file_group in the destination. */
1174 for (d_i
= 0; d_i
< dest_len
; d_i
++) {
1175 struct ctf_fs_ds_file_group
*candidate_dest
=
1176 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(dest
, d_i
);
1178 /* Can't match a stream instance without ID. */
1179 if (candidate_dest
->stream_id
== -1) {
1184 * If the two groups have the same stream instance id
1185 * and belong to the same stream class (stream instance
1186 * ids are per-stream class), they represent the same
1189 if (candidate_dest
->stream_id
!= src_group
->stream_id
||
1190 candidate_dest
->sc
->id
!= src_group
->sc
->id
) {
1194 dest_group
= candidate_dest
;
1200 * Didn't find a friend in dest to merge our src_group into?
1201 * Create a new empty one. This can happen if a stream was
1202 * active in the source trace chunk but not in the destination
1206 struct ctf_stream_class
*sc
;
1207 struct ctf_fs_ds_index
*index
;
1209 sc
= ctf_trace_class_borrow_stream_class_by_id(dest_trace
->metadata
->tc
,
1213 index
= ctf_fs_ds_index_create(dest_trace
->logger
);
1219 dest_group
= ctf_fs_ds_file_group_create(dest_trace
, sc
, src_group
->stream_id
, index
);
1220 /* Ownership of index is transferred. */
1227 g_ptr_array_add(dest_trace
->ds_file_groups
, dest_group
);
1230 BT_ASSERT(dest_group
);
1231 merge_ctf_fs_ds_file_groups(dest_group
, src_group
);
1239 * Collapse the given traces, which must all share the same UUID, in a single
1242 * The trace with the most expansive metadata is chosen and all other traces
1243 * are merged into that one. The array slots of all the traces that get merged
1244 * in the chosen one are set to NULL, so only the slot of the chosen trace
1248 static int merge_ctf_fs_traces(struct ctf_fs_trace
**traces
, unsigned int num_traces
,
1249 struct ctf_fs_trace
**out_trace
)
1251 unsigned int winner_count
;
1252 struct ctf_fs_trace
*winner
;
1256 BT_ASSERT(num_traces
>= 2);
1258 winner_count
= metadata_count_stream_and_event_classes(traces
[0]);
1262 /* Find the trace with the largest metadata. */
1263 for (i
= 1; i
< num_traces
; i
++) {
1264 struct ctf_fs_trace
*candidate
;
1265 unsigned int candidate_count
;
1267 candidate
= traces
[i
];
1269 /* A bit of sanity check. */
1270 BT_ASSERT(bt_uuid_compare(winner
->metadata
->tc
->uuid
, candidate
->metadata
->tc
->uuid
) == 0);
1272 candidate_count
= metadata_count_stream_and_event_classes(candidate
);
1274 if (candidate_count
> winner_count
) {
1275 winner_count
= candidate_count
;
1281 /* Merge all the other traces in the winning trace. */
1282 for (i
= 0; i
< num_traces
; i
++) {
1283 struct ctf_fs_trace
*trace
= traces
[i
];
1285 /* Don't merge the winner into itself. */
1286 if (trace
== winner
) {
1290 /* Merge trace's data stream file groups into winner's. */
1291 ret
= merge_matching_ctf_fs_ds_file_groups(winner
, trace
);
1298 * Move the winner out of the array, into `*out_trace`.
1300 *out_trace
= winner
;
1301 traces
[winner_i
] = NULL
;
1313 static int decode_clock_snapshot_after_event(struct ctf_fs_trace
*ctf_fs_trace
,
1314 struct ctf_clock_class
*default_cc
,
1315 struct ctf_fs_ds_index_entry
*index_entry
,
1316 enum target_event target_event
, uint64_t *cs
,
1319 enum ctf_msg_iter_status iter_status
= CTF_MSG_ITER_STATUS_OK
;
1320 struct ctf_fs_ds_file
*ds_file
= NULL
;
1321 struct ctf_msg_iter
*msg_iter
= NULL
;
1324 BT_ASSERT(ctf_fs_trace
);
1325 BT_ASSERT(index_entry
);
1326 BT_ASSERT(index_entry
->path
);
1328 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, index_entry
->path
, ctf_fs_trace
->logger
);
1330 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to create a ctf_fs_ds_file");
1335 BT_ASSERT(ctf_fs_trace
->metadata
);
1336 BT_ASSERT(ctf_fs_trace
->metadata
->tc
);
1338 msg_iter
= ctf_msg_iter_create(
1339 ctf_fs_trace
->metadata
->tc
,
1340 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
1341 ctf_fs_ds_file_medops
, ds_file
, NULL
, ctf_fs_trace
->logger
);
1343 /* ctf_msg_iter_create() logs errors. */
1349 * Turn on dry run mode to prevent the creation and usage of Babeltrace
1350 * library objects (bt_field, bt_message_*, etc.).
1352 ctf_msg_iter_set_dry_run(msg_iter
, true);
1354 /* Seek to the beginning of the target packet. */
1355 iter_status
= ctf_msg_iter_seek(msg_iter
, index_entry
->offset
);
1357 /* ctf_msg_iter_seek() logs errors. */
1362 switch (target_event
) {
1365 * Start to decode the packet until we reach the end of
1366 * the first event. To extract the first event's clock
1369 iter_status
= ctf_msg_iter_curr_packet_first_event_clock_snapshot(msg_iter
, cs
);
1372 /* Decode the packet to extract the last event's clock snapshot. */
1373 iter_status
= ctf_msg_iter_curr_packet_last_event_clock_snapshot(msg_iter
, cs
);
1383 /* Convert clock snapshot to timestamp. */
1384 ret
= bt_util_clock_cycles_to_ns_from_origin(
1385 *cs
, default_cc
->frequency
, default_cc
->offset_seconds
, default_cc
->offset_cycles
, ts_ns
);
1387 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1388 "Failed to convert clock snapshot to timestamp");
1394 ctf_fs_ds_file_destroy(ds_file
);
1397 ctf_msg_iter_destroy(msg_iter
);
1403 static int decode_packet_first_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1404 struct ctf_clock_class
*default_cc
,
1405 struct ctf_fs_ds_index_entry
*index_entry
,
1406 uint64_t *cs
, int64_t *ts_ns
)
1408 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, FIRST_EVENT
, cs
,
1412 static int decode_packet_last_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1413 struct ctf_clock_class
*default_cc
,
1414 struct ctf_fs_ds_index_entry
*index_entry
,
1415 uint64_t *cs
, int64_t *ts_ns
)
1417 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, LAST_EVENT
, cs
,
1422 * Fix up packet index entries for lttng's "event-after-packet" bug.
1423 * Some buggy lttng tracer versions may emit events with a timestamp that is
1424 * larger (after) than the timestamp_end of the their packets.
1426 * To fix up this erroneous data we do the following:
1427 * 1. If it's not the stream file's last packet: set the packet index entry's
1428 * end time to the next packet's beginning time.
1429 * 2. If it's the stream file's last packet, set the packet index entry's end
1430 * time to the packet's last event's time, if any, or to the packet's
1431 * beginning time otherwise.
1433 * Known buggy tracer versions:
1434 * - before lttng-ust 2.11.0
1435 * - before lttng-module 2.11.0
1436 * - before lttng-module 2.10.10
1437 * - before lttng-module 2.9.13
1439 static int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace
*trace
)
1442 guint ds_file_group_i
;
1443 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1445 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
; ds_file_group_i
++) {
1447 struct ctf_clock_class
*default_cc
;
1448 struct ctf_fs_ds_index_entry
*last_entry
;
1449 struct ctf_fs_ds_index
*index
;
1451 struct ctf_fs_ds_file_group
*ds_file_group
=
1452 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1454 BT_ASSERT(ds_file_group
);
1455 index
= ds_file_group
->index
;
1458 BT_ASSERT(index
->entries
);
1459 BT_ASSERT(index
->entries
->len
> 0);
1462 * Iterate over all entries but the last one. The last one is
1463 * fixed differently after.
1465 for (entry_i
= 0; entry_i
< index
->entries
->len
- 1; entry_i
++) {
1466 struct ctf_fs_ds_index_entry
*curr_entry
, *next_entry
;
1468 curr_entry
= (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
);
1469 next_entry
= (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
+ 1);
1472 * 1. Set the current index entry `end` timestamp to
1473 * the next index entry `begin` timestamp.
1475 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1476 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1480 * 2. Fix the last entry by decoding the last event of the last
1484 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, index
->entries
->len
- 1);
1485 BT_ASSERT(last_entry
);
1487 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1488 default_cc
= ds_file_group
->sc
->default_clock_class
;
1491 * Decode packet to read the timestamp of the last event of the
1494 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1495 &last_entry
->timestamp_end
,
1496 &last_entry
->timestamp_end_ns
);
1498 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1500 "Failed to decode stream's last packet to get its last event's clock snapshot.");
1510 * Fix up packet index entries for barectf's "event-before-packet" bug.
1511 * Some buggy barectf tracer versions may emit events with a timestamp that is
1512 * less than the timestamp_begin of the their packets.
1514 * To fix up this erroneous data we do the following:
1515 * 1. Starting at the second index entry, set the timestamp_begin of the
1516 * current entry to the timestamp of the first event of the packet.
1517 * 2. Set the previous entry's timestamp_end to the timestamp_begin of the
1520 * Known buggy tracer versions:
1521 * - before barectf 2.3.1
1523 static int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace
*trace
)
1526 guint ds_file_group_i
;
1527 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1529 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
; ds_file_group_i
++) {
1531 struct ctf_clock_class
*default_cc
;
1532 ctf_fs_ds_file_group
*ds_file_group
=
1533 (ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1535 struct ctf_fs_ds_index
*index
= ds_file_group
->index
;
1538 BT_ASSERT(index
->entries
);
1539 BT_ASSERT(index
->entries
->len
> 0);
1541 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1542 default_cc
= ds_file_group
->sc
->default_clock_class
;
1545 * 1. Iterate over the index, starting from the second entry
1548 for (entry_i
= 1; entry_i
< index
->entries
->len
; entry_i
++) {
1549 ctf_fs_ds_index_entry
*prev_entry
=
1550 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
- 1);
1551 ctf_fs_ds_index_entry
*curr_entry
=
1552 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
);
1554 * 2. Set the current entry `begin` timestamp to the
1555 * timestamp of the first event of the current packet.
1557 ret
= decode_packet_first_event_timestamp(trace
, default_cc
, curr_entry
,
1558 &curr_entry
->timestamp_begin
,
1559 &curr_entry
->timestamp_begin_ns
);
1561 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1562 "Failed to decode first event's clock snapshot");
1567 * 3. Set the previous entry `end` timestamp to the
1568 * timestamp of the first event of the current packet.
1570 prev_entry
->timestamp_end
= curr_entry
->timestamp_begin
;
1571 prev_entry
->timestamp_end_ns
= curr_entry
->timestamp_begin_ns
;
1579 * When using the lttng-crash feature it's likely that the last packets of each
1580 * stream have their timestamp_end set to zero. This is caused by the fact that
1581 * the tracer crashed and was not able to properly close the packets.
1583 * To fix up this erroneous data we do the following:
1584 * For each index entry, if the entry's timestamp_end is 0 and the
1585 * timestamp_begin is not 0:
1586 * - If it's the stream file's last packet: set the packet index entry's end
1587 * time to the packet's last event's time, if any, or to the packet's
1588 * beginning time otherwise.
1589 * - If it's not the stream file's last packet: set the packet index
1590 * entry's end time to the next packet's beginning time.
1592 * Affected versions:
1593 * - All current and future lttng-ust and lttng-modules versions.
1595 static int fix_index_lttng_crash_quirk(struct ctf_fs_trace
*trace
)
1598 guint ds_file_group_idx
;
1599 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1601 for (ds_file_group_idx
= 0; ds_file_group_idx
< ds_file_groups
->len
; ds_file_group_idx
++) {
1603 struct ctf_clock_class
*default_cc
;
1604 struct ctf_fs_ds_index
*index
;
1606 ctf_fs_ds_file_group
*ds_file_group
=
1607 (ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_idx
);
1609 BT_ASSERT(ds_file_group
);
1610 index
= ds_file_group
->index
;
1612 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1613 default_cc
= ds_file_group
->sc
->default_clock_class
;
1616 BT_ASSERT(index
->entries
);
1617 BT_ASSERT(index
->entries
->len
> 0);
1619 ctf_fs_ds_index_entry
*last_entry
=
1620 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, index
->entries
->len
- 1);
1621 BT_ASSERT(last_entry
);
1623 /* 1. Fix the last entry first. */
1624 if (last_entry
->timestamp_end
== 0 && last_entry
->timestamp_begin
!= 0) {
1626 * Decode packet to read the timestamp of the
1627 * last event of the stream file.
1629 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1630 &last_entry
->timestamp_end
,
1631 &last_entry
->timestamp_end_ns
);
1633 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1634 "Failed to decode last event's clock snapshot");
1639 /* Iterate over all entries but the last one. */
1640 for (entry_idx
= 0; entry_idx
< index
->entries
->len
- 1; entry_idx
++) {
1641 ctf_fs_ds_index_entry
*curr_entry
=
1642 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_idx
);
1643 ctf_fs_ds_index_entry
*next_entry
=
1644 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_idx
+ 1);
1646 if (curr_entry
->timestamp_end
== 0 && curr_entry
->timestamp_begin
!= 0) {
1648 * 2. Set the current index entry `end` timestamp to
1649 * the next index entry `begin` timestamp.
1651 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1652 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1662 * Extract the tracer information necessary to compare versions.
1663 * Returns 0 on success, and -1 if the extraction is not successful because the
1664 * necessary fields are absents in the trace metadata.
1666 static int extract_tracer_info(struct ctf_fs_trace
*trace
, struct tracer_info
*current_tracer_info
)
1669 struct ctf_trace_class_env_entry
*entry
;
1671 /* Clear the current_tracer_info struct */
1672 memset(current_tracer_info
, 0, sizeof(*current_tracer_info
));
1675 * To compare 2 tracer versions, at least the tracer name and it's
1676 * major version are needed. If one of these is missing, consider it an
1677 * extraction failure.
1679 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_name");
1680 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR
) {
1681 goto missing_bare_minimum
;
1684 /* Set tracer name. */
1685 current_tracer_info
->name
= entry
->value
.str
->str
;
1687 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_major");
1688 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1689 goto missing_bare_minimum
;
1692 /* Set major version number. */
1693 current_tracer_info
->major
= entry
->value
.i
;
1695 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_minor");
1696 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1700 /* Set minor version number. */
1701 current_tracer_info
->minor
= entry
->value
.i
;
1703 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patch");
1706 * If `tracer_patch` doesn't exist `tracer_patchlevel` might.
1707 * For example, `lttng-modules` uses entry name
1708 * `tracer_patchlevel`.
1710 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patchlevel");
1713 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1717 /* Set patch version number. */
1718 current_tracer_info
->patch
= entry
->value
.i
;
1722 missing_bare_minimum
:
1728 static bool is_tracer_affected_by_lttng_event_after_packet_bug(struct tracer_info
*curr_tracer_info
)
1730 bool is_affected
= false;
1732 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1733 if (curr_tracer_info
->major
< 2) {
1735 } else if (curr_tracer_info
->major
== 2) {
1736 /* fixed in lttng-ust 2.11.0 */
1737 if (curr_tracer_info
->minor
< 11) {
1741 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1742 if (curr_tracer_info
->major
< 2) {
1744 } else if (curr_tracer_info
->major
== 2) {
1745 /* fixed in lttng-modules 2.11.0 */
1746 if (curr_tracer_info
->minor
== 10) {
1747 /* fixed in lttng-modules 2.10.10 */
1748 if (curr_tracer_info
->patch
< 10) {
1751 } else if (curr_tracer_info
->minor
== 9) {
1752 /* fixed in lttng-modules 2.9.13 */
1753 if (curr_tracer_info
->patch
< 13) {
1756 } else if (curr_tracer_info
->minor
< 9) {
1766 is_tracer_affected_by_barectf_event_before_packet_bug(struct tracer_info
*curr_tracer_info
)
1768 bool is_affected
= false;
1770 if (strcmp(curr_tracer_info
->name
, "barectf") == 0) {
1771 if (curr_tracer_info
->major
< 2) {
1773 } else if (curr_tracer_info
->major
== 2) {
1774 if (curr_tracer_info
->minor
< 3) {
1776 } else if (curr_tracer_info
->minor
== 3) {
1777 /* fixed in barectf 2.3.1 */
1778 if (curr_tracer_info
->patch
< 1) {
1788 static bool is_tracer_affected_by_lttng_crash_quirk(struct tracer_info
*curr_tracer_info
)
1790 bool is_affected
= false;
1792 /* All LTTng tracer may be affected by this lttng crash quirk. */
1793 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1795 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1803 * Looks for trace produced by known buggy tracers and fix up the index
1806 static int fix_packet_index_tracer_bugs(ctf_fs_trace
*trace
)
1809 struct tracer_info current_tracer_info
;
1811 ret
= extract_tracer_info(trace
, ¤t_tracer_info
);
1814 * A trace may not have all the necessary environment
1815 * entries to do the tracer version comparison.
1816 * At least, the tracer name and major version number
1817 * are needed. Failing to extract these entries is not
1821 BT_CPPLOGI_STR_SPEC(
1823 "Cannot extract tracer information necessary to compare with buggy versions.");
1827 /* Check if the trace may be affected by old tracer bugs. */
1828 if (is_tracer_affected_by_lttng_event_after_packet_bug(¤t_tracer_info
)) {
1829 BT_CPPLOGI_STR_SPEC(
1831 "Trace may be affected by LTTng tracer packet timestamp bug. Fixing up.");
1832 ret
= fix_index_lttng_event_after_packet_bug(trace
);
1834 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1835 "Failed to fix LTTng event-after-packet bug.");
1838 trace
->metadata
->tc
->quirks
.lttng_event_after_packet
= true;
1841 if (is_tracer_affected_by_barectf_event_before_packet_bug(¤t_tracer_info
)) {
1842 BT_CPPLOGI_STR_SPEC(
1844 "Trace may be affected by barectf tracer packet timestamp bug. Fixing up.");
1845 ret
= fix_index_barectf_event_before_packet_bug(trace
);
1847 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1848 "Failed to fix barectf event-before-packet bug.");
1851 trace
->metadata
->tc
->quirks
.barectf_event_before_packet
= true;
1854 if (is_tracer_affected_by_lttng_crash_quirk(¤t_tracer_info
)) {
1855 ret
= fix_index_lttng_crash_quirk(trace
);
1857 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1858 "Failed to fix lttng-crash timestamp quirks.");
1861 trace
->metadata
->tc
->quirks
.lttng_crash
= true;
1868 static gint
compare_ds_file_groups_by_first_path(gconstpointer a
, gconstpointer b
)
1870 ctf_fs_ds_file_group
* const *ds_file_group_a
= (ctf_fs_ds_file_group
**) a
;
1871 ctf_fs_ds_file_group
* const *ds_file_group_b
= (ctf_fs_ds_file_group
**) b
;
1873 BT_ASSERT((*ds_file_group_a
)->ds_file_infos
->len
> 0);
1874 BT_ASSERT((*ds_file_group_b
)->ds_file_infos
->len
> 0);
1876 const ctf_fs_ds_file_info
*first_ds_file_info_a
=
1877 (const ctf_fs_ds_file_info
*) (*ds_file_group_a
)->ds_file_infos
->pdata
[0];
1878 const ctf_fs_ds_file_info
*first_ds_file_info_b
=
1879 (const ctf_fs_ds_file_info
*) (*ds_file_group_b
)->ds_file_infos
->pdata
[0];
1881 return strcmp(first_ds_file_info_a
->path
->str
, first_ds_file_info_b
->path
->str
);
1884 static gint
compare_strings(gconstpointer p_a
, gconstpointer p_b
)
1886 const char *a
= *((const char **) p_a
);
1887 const char *b
= *((const char **) p_b
);
1889 return strcmp(a
, b
);
1892 int ctf_fs_component_create_ctf_fs_trace(struct ctf_fs_component
*ctf_fs
,
1893 const bt_value
*paths_value
,
1894 const bt_value
*trace_name_value
,
1895 bt_self_component
*selfComp
)
1899 GPtrArray
*paths
= NULL
;
1901 const char *trace_name
;
1903 BT_ASSERT(bt_value_get_type(paths_value
) == BT_VALUE_TYPE_ARRAY
);
1904 BT_ASSERT(!bt_value_array_is_empty(paths_value
));
1906 traces
= g_ptr_array_new_with_free_func(ctf_fs_trace_destroy_notifier
);
1908 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to allocate a GPtrArray.");
1912 paths
= g_ptr_array_new_with_free_func(g_free
);
1914 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to allocate a GPtrArray.");
1918 trace_name
= trace_name_value
? bt_value_string_get(trace_name_value
) : NULL
;
1921 * Create a sorted array of the paths, to make the execution of this
1922 * component deterministic.
1924 for (i
= 0; i
< bt_value_array_get_length(paths_value
); i
++) {
1925 const bt_value
*path_value
= bt_value_array_borrow_element_by_index_const(paths_value
, i
);
1926 const char *input
= bt_value_string_get(path_value
);
1929 input_copy
= g_strdup(input
);
1931 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to copy a string.");
1935 g_ptr_array_add(paths
, input_copy
);
1938 g_ptr_array_sort(paths
, compare_strings
);
1940 /* Create a separate ctf_fs_trace object for each path. */
1941 for (i
= 0; i
< paths
->len
; i
++) {
1942 const char *path
= (const char *) g_ptr_array_index(paths
, i
);
1944 ret
= ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs
, path
, trace_name
, traces
,
1951 if (traces
->len
> 1) {
1952 struct ctf_fs_trace
*first_trace
= (struct ctf_fs_trace
*) traces
->pdata
[0];
1953 const uint8_t *first_trace_uuid
= first_trace
->metadata
->tc
->uuid
;
1954 struct ctf_fs_trace
*trace
;
1957 * We have more than one trace, they must all share the same
1958 * UUID, verify that.
1960 for (i
= 0; i
< traces
->len
; i
++) {
1961 struct ctf_fs_trace
*this_trace
= (struct ctf_fs_trace
*) traces
->pdata
[i
];
1962 const uint8_t *this_trace_uuid
= this_trace
->metadata
->tc
->uuid
;
1964 if (!this_trace
->metadata
->tc
->is_uuid_set
) {
1965 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1967 "Multiple traces given, but a trace does not have a UUID: path={}",
1968 this_trace
->path
->str
);
1972 if (bt_uuid_compare(first_trace_uuid
, this_trace_uuid
) != 0) {
1973 char first_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1974 char this_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1976 bt_uuid_to_str(first_trace_uuid
, first_trace_uuid_str
);
1977 bt_uuid_to_str(this_trace_uuid
, this_trace_uuid_str
);
1979 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1980 "Multiple traces given, but UUIDs don't match: "
1981 "first-trace-uuid={}, first-trace-path={}, "
1982 "trace-uuid={}, trace-path={}",
1983 first_trace_uuid_str
, first_trace
->path
->str
,
1984 this_trace_uuid_str
, this_trace
->path
->str
);
1989 ret
= merge_ctf_fs_traces((struct ctf_fs_trace
**) traces
->pdata
, traces
->len
, &trace
);
1991 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1992 "Failed to merge traces with the same UUID.");
1996 ctf_fs
->trace
= trace
;
1998 /* Just one trace, it may or may not have a UUID, both are fine. */
1999 ctf_fs
->trace
= (ctf_fs_trace
*) traces
->pdata
[0];
2000 traces
->pdata
[0] = NULL
;
2003 ret
= fix_packet_index_tracer_bugs(ctf_fs
->trace
);
2005 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to fix packet index tracer bugs.");
2009 * Sort data stream file groups by first data stream file info
2010 * path to get a deterministic order. This order influences the
2011 * order of the output ports. It also influences the order of
2012 * the automatic stream IDs if the trace's packet headers do not
2013 * contain a `stream_instance_id` field, in which case the data
2014 * stream file to stream ID association is always the same,
2015 * whatever the build and the system.
2017 * Having a deterministic order here can help debugging and
2020 g_ptr_array_sort(ctf_fs
->trace
->ds_file_groups
, compare_ds_file_groups_by_first_path
);
2027 g_ptr_array_free(traces
, TRUE
);
2031 g_ptr_array_free(paths
, TRUE
);
2037 static GString
*get_stream_instance_unique_name(struct ctf_fs_ds_file_group
*ds_file_group
)
2040 struct ctf_fs_ds_file_info
*ds_file_info
;
2042 name
= g_string_new(NULL
);
2048 * If there's more than one stream file in the stream file
2049 * group, the first (earliest) stream file's path is used as
2050 * the stream's unique name.
2052 BT_ASSERT(ds_file_group
->ds_file_infos
->len
> 0);
2053 ds_file_info
= (ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
2054 g_string_assign(name
, ds_file_info
->path
->str
);
2060 /* Create the IR stream objects for ctf_fs_trace. */
2062 static int create_streams_for_trace(struct ctf_fs_trace
*ctf_fs_trace
)
2065 GString
*name
= NULL
;
2068 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
2069 ctf_fs_ds_file_group
*ds_file_group
=
2070 (ctf_fs_ds_file_group
*) g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
2071 name
= get_stream_instance_unique_name(ds_file_group
);
2077 if (ds_file_group
->sc
->ir_sc
) {
2078 BT_ASSERT(ctf_fs_trace
->trace
);
2080 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
2081 /* No stream ID: use 0 */
2082 ds_file_group
->stream
= bt_stream_create_with_id(
2083 ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
, ctf_fs_trace
->next_stream_id
);
2084 ctf_fs_trace
->next_stream_id
++;
2086 /* Specific stream ID */
2087 ds_file_group
->stream
=
2088 bt_stream_create_with_id(ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
,
2089 (uint64_t) ds_file_group
->stream_id
);
2092 ds_file_group
->stream
= NULL
;
2095 if (!ds_file_group
->stream
) {
2096 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
2097 "Cannot create stream for DS file group: "
2098 "addr={}, stream-name=\"{}\"",
2099 fmt::ptr(ds_file_group
), name
->str
);
2103 ret
= bt_stream_set_name(ds_file_group
->stream
, name
->str
);
2105 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
2106 "Cannot set stream's name: "
2107 "addr={}, stream-name=\"{}\"",
2108 fmt::ptr(ds_file_group
->stream
), name
->str
);
2112 g_string_free(name
, TRUE
);
2125 g_string_free(name
, TRUE
);
2130 static const bt_param_validation_value_descr inputs_elem_descr
=
2131 bt_param_validation_value_descr::makeString();
2133 static bt_param_validation_map_value_entry_descr fs_params_entries_descr
[] = {
2134 {"inputs", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
2135 bt_param_validation_value_descr::makeArray(1, BT_PARAM_VALIDATION_INFINITE
,
2136 inputs_elem_descr
)},
2137 {"trace-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2138 bt_param_validation_value_descr::makeString()},
2139 {"clock-class-offset-s", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2140 bt_param_validation_value_descr::makeSignedInteger()},
2141 {"clock-class-offset-ns", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2142 bt_param_validation_value_descr::makeSignedInteger()},
2143 {"force-clock-class-origin-unix-epoch", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2144 bt_param_validation_value_descr::makeBool()},
2145 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
2147 bool read_src_fs_parameters(const bt_value
*params
, const bt_value
**inputs
,
2148 const bt_value
**trace_name
, struct ctf_fs_component
*ctf_fs
)
2151 const bt_value
*value
;
2152 enum bt_param_validation_status validate_value_status
;
2153 gchar
*error
= NULL
;
2155 validate_value_status
= bt_param_validation_validate(params
, fs_params_entries_descr
, &error
);
2156 if (validate_value_status
!= BT_PARAM_VALIDATION_STATUS_OK
) {
2157 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "{}", error
);
2162 /* inputs parameter */
2163 *inputs
= bt_value_map_borrow_entry_value_const(params
, "inputs");
2165 /* clock-class-offset-s parameter */
2166 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-s");
2168 ctf_fs
->metadata_config
.clock_class_offset_s
= bt_value_integer_signed_get(value
);
2171 /* clock-class-offset-ns parameter */
2172 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-ns");
2174 ctf_fs
->metadata_config
.clock_class_offset_ns
= bt_value_integer_signed_get(value
);
2177 /* force-clock-class-origin-unix-epoch parameter */
2178 value
= bt_value_map_borrow_entry_value_const(params
, "force-clock-class-origin-unix-epoch");
2180 ctf_fs
->metadata_config
.force_clock_class_origin_unix_epoch
= bt_value_bool_get(value
);
2183 /* trace-name parameter */
2184 *trace_name
= bt_value_map_borrow_entry_value_const(params
, "trace-name");
2193 static struct ctf_fs_component
*ctf_fs_create(const bt_value
*params
,
2194 bt_self_component_source
*self_comp_src
)
2196 struct ctf_fs_component
*ctf_fs
= NULL
;
2197 const bt_value
*inputs_value
;
2198 const bt_value
*trace_name_value
;
2199 bt_self_component
*self_comp
= bt_self_component_source_as_self_component(self_comp_src
);
2201 ctf_fs
= ctf_fs_component_create(
2202 bt2c::Logger
{bt2::SelfSourceComponent
{self_comp_src
}, "PLUGIN/SRC.CTF.FS/COMP"});
2207 if (!read_src_fs_parameters(params
, &inputs_value
, &trace_name_value
, ctf_fs
)) {
2211 bt_self_component_set_data(self_comp
, ctf_fs
);
2213 if (ctf_fs_component_create_ctf_fs_trace(ctf_fs
, inputs_value
, trace_name_value
, self_comp
)) {
2217 if (create_streams_for_trace(ctf_fs
->trace
)) {
2221 if (create_ports_for_trace(ctf_fs
, ctf_fs
->trace
, self_comp_src
)) {
2228 ctf_fs_destroy(ctf_fs
);
2230 bt_self_component_set_data(self_comp
, NULL
);
2236 bt_component_class_initialize_method_status
ctf_fs_init(bt_self_component_source
*self_comp_src
,
2237 bt_self_component_source_configuration
*,
2238 const bt_value
*params
, void *)
2241 struct ctf_fs_component
*ctf_fs
;
2242 bt_component_class_initialize_method_status ret
=
2243 BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
2245 ctf_fs
= ctf_fs_create(params
, self_comp_src
);
2247 ret
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
2251 } catch (const std::bad_alloc
&) {
2252 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
2253 } catch (const bt2::Error
&) {
2254 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
2258 bt_component_class_query_method_status
ctf_fs_query(bt_self_component_class_source
*comp_class_src
,
2259 bt_private_query_executor
*priv_query_exec
,
2260 const char *object
, const bt_value
*params
,
2261 __attribute__((unused
)) void *method_data
,
2262 const bt_value
**result
)
2265 bt_component_class_query_method_status status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
2266 bt2c::Logger logger
{bt2::SelfComponentClass
{comp_class_src
},
2267 bt2::PrivateQueryExecutor
{priv_query_exec
},
2268 "PLUGIN/SRC.CTF.FS/QUERY"};
2270 if (strcmp(object
, "metadata-info") == 0) {
2271 status
= metadata_info_query(params
, logger
, result
);
2272 } else if (strcmp(object
, "babeltrace.trace-infos") == 0) {
2273 status
= trace_infos_query(params
, logger
, result
);
2274 } else if (!strcmp(object
, "babeltrace.support-info")) {
2275 status
= support_info_query(params
, logger
, result
);
2277 BT_CPPLOGE_SPEC(logger
, "Unknown query object `{}`", object
);
2278 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;
2283 } catch (const std::bad_alloc
&) {
2284 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
2285 } catch (const bt2::Error
&) {
2286 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;