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_trace_deleter::operator()(ctf_fs_trace
* const trace
) noexcept
303 ctf_fs_trace_destroy(trace
);
306 void ctf_fs_destroy(struct ctf_fs_component
*ctf_fs
)
312 if (ctf_fs
->port_data
) {
313 g_ptr_array_free(ctf_fs
->port_data
, TRUE
);
319 void ctf_fs_component_deleter::operator()(ctf_fs_component
*comp
)
321 ctf_fs_destroy(comp
);
324 static void port_data_destroy(struct ctf_fs_port_data
*port_data
)
333 static void port_data_destroy_notifier(void *data
)
335 port_data_destroy((struct ctf_fs_port_data
*) data
);
338 ctf_fs_component::UP
ctf_fs_component_create(const bt2c::Logger
& parentLogger
)
340 ctf_fs_component::UP ctf_fs
{new ctf_fs_component
{parentLogger
}};
342 ctf_fs
->port_data
= g_ptr_array_new_with_free_func(port_data_destroy_notifier
);
343 if (!ctf_fs
->port_data
) {
356 void ctf_fs_finalize(bt_self_component_source
*component
)
358 ctf_fs_destroy((struct ctf_fs_component
*) bt_self_component_get_data(
359 bt_self_component_source_as_self_component(component
)));
362 bt2c::GCharUP
ctf_fs_make_port_name(struct ctf_fs_ds_file_group
*ds_file_group
)
364 GString
*name
= g_string_new(NULL
);
367 * The unique port name is generated by concatenating unique identifiers
375 /* For the trace, use the uuid if present, else the path. */
376 if (ds_file_group
->ctf_fs_trace
->metadata
->tc
->is_uuid_set
) {
377 char uuid_str
[BT_UUID_STR_LEN
+ 1];
379 bt_uuid_to_str(ds_file_group
->ctf_fs_trace
->metadata
->tc
->uuid
, uuid_str
);
380 g_string_assign(name
, uuid_str
);
382 g_string_assign(name
, ds_file_group
->ctf_fs_trace
->path
->str
);
386 * For the stream class, use the id if present. We can omit this field
387 * otherwise, as there will only be a single stream class.
389 if (ds_file_group
->sc
->id
!= UINT64_C(-1)) {
390 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->sc
->id
);
393 /* For the stream, use the id if present, else, use the path. */
394 if (ds_file_group
->stream_id
!= UINT64_C(-1)) {
395 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->stream_id
);
397 BT_ASSERT(ds_file_group
->ds_file_infos
->len
== 1);
398 struct ctf_fs_ds_file_info
*ds_file_info
=
399 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
400 g_string_append_printf(name
, " | %s", ds_file_info
->path
->str
);
403 return bt2c::GCharUP
{g_string_free(name
, FALSE
)};
406 static int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
407 struct ctf_fs_ds_file_group
*ds_file_group
,
408 bt_self_component_source
*self_comp_src
)
411 struct ctf_fs_port_data
*port_data
= NULL
;
413 bt2c::GCharUP port_name
= ctf_fs_make_port_name(ds_file_group
);
418 BT_CPPLOGI_SPEC(ctf_fs
->logger
, "Creating one port named `{}`", port_name
.get());
420 /* Create output port for this file */
421 port_data
= new ctf_fs_port_data
;
422 port_data
->ctf_fs
= ctf_fs
;
423 port_data
->ds_file_group
= ds_file_group
;
424 ret
= bt_self_component_source_add_output_port(self_comp_src
, port_name
.get(), port_data
, NULL
);
429 g_ptr_array_add(ctf_fs
->port_data
, port_data
);
437 port_data_destroy(port_data
);
441 static int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
442 struct ctf_fs_trace
*ctf_fs_trace
,
443 bt_self_component_source
*self_comp_src
)
448 /* Create one output port for each stream file group */
449 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
450 struct ctf_fs_ds_file_group
*ds_file_group
=
451 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
453 ret
= create_one_port_for_trace(ctf_fs
, ds_file_group
, self_comp_src
);
455 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create output port.");
464 static void ctf_fs_ds_file_info_destroy(struct ctf_fs_ds_file_info
*ds_file_info
)
470 if (ds_file_info
->path
) {
471 g_string_free(ds_file_info
->path
, TRUE
);
477 static struct ctf_fs_ds_file_info
*ctf_fs_ds_file_info_create(const char *path
, int64_t begin_ns
)
479 ctf_fs_ds_file_info
*ds_file_info
= new ctf_fs_ds_file_info
;
480 ds_file_info
->path
= g_string_new(path
);
481 if (!ds_file_info
->path
) {
482 ctf_fs_ds_file_info_destroy(ds_file_info
);
487 ds_file_info
->begin_ns
= begin_ns
;
493 static void ctf_fs_ds_file_group_destroy(struct ctf_fs_ds_file_group
*ds_file_group
)
495 if (!ds_file_group
) {
499 if (ds_file_group
->ds_file_infos
) {
500 g_ptr_array_free(ds_file_group
->ds_file_infos
, TRUE
);
503 ctf_fs_ds_index_destroy(ds_file_group
->index
);
505 bt_stream_put_ref(ds_file_group
->stream
);
506 delete ds_file_group
;
509 static struct ctf_fs_ds_file_group
*ctf_fs_ds_file_group_create(struct ctf_fs_trace
*ctf_fs_trace
,
510 struct ctf_stream_class
*sc
,
511 uint64_t stream_instance_id
,
512 struct ctf_fs_ds_index
*index
)
514 ctf_fs_ds_file_group
*ds_file_group
= new ctf_fs_ds_file_group
;
515 ds_file_group
->ds_file_infos
=
516 g_ptr_array_new_with_free_func((GDestroyNotify
) ctf_fs_ds_file_info_destroy
);
517 if (!ds_file_group
->ds_file_infos
) {
521 ds_file_group
->index
= index
;
523 ds_file_group
->stream_id
= stream_instance_id
;
525 ds_file_group
->sc
= sc
;
526 ds_file_group
->ctf_fs_trace
= ctf_fs_trace
;
530 ctf_fs_ds_file_group_destroy(ds_file_group
);
531 ctf_fs_ds_index_destroy(index
);
532 ds_file_group
= NULL
;
535 return ds_file_group
;
538 /* Replace by g_ptr_array_insert when we depend on glib >= 2.40. */
539 static void array_insert(GPtrArray
*array
, gpointer element
, size_t pos
)
541 size_t original_array_len
= array
->len
;
543 /* Allocate an unused element at the end of the array. */
544 g_ptr_array_add(array
, NULL
);
546 /* If we are not inserting at the end, move the elements by one. */
547 if (pos
< original_array_len
) {
548 memmove(&(array
->pdata
[pos
+ 1]), &(array
->pdata
[pos
]),
549 (original_array_len
- pos
) * sizeof(gpointer
));
552 /* Insert the value. */
553 array
->pdata
[pos
] = element
;
557 * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right
558 * place to keep it sorted.
561 static void ds_file_group_insert_ds_file_info_sorted(struct ctf_fs_ds_file_group
*ds_file_group
,
562 struct ctf_fs_ds_file_info
*ds_file_info
)
566 /* Find the spot where to insert this ds_file_info. */
567 for (i
= 0; i
< ds_file_group
->ds_file_infos
->len
; i
++) {
568 struct ctf_fs_ds_file_info
*other_ds_file_info
=
569 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, i
);
571 if (ds_file_info
->begin_ns
< other_ds_file_info
->begin_ns
) {
576 array_insert(ds_file_group
->ds_file_infos
, ds_file_info
, i
);
579 static bool ds_index_entries_equal(const struct ctf_fs_ds_index_entry
*left
,
580 const struct ctf_fs_ds_index_entry
*right
)
582 if (left
->packetSize
!= right
->packetSize
) {
586 if (left
->timestamp_begin
!= right
->timestamp_begin
) {
590 if (left
->timestamp_end
!= right
->timestamp_end
) {
594 if (left
->packet_seq_num
!= right
->packet_seq_num
) {
602 * Insert `entry` into `index`, without duplication.
604 * The entry is inserted only if there isn't an identical entry already.
606 * In any case, the ownership of `entry` is transferred to this function. So if
607 * the entry is not inserted, it is freed.
610 static void ds_index_insert_ds_index_entry_sorted(struct ctf_fs_ds_index
*index
,
611 struct ctf_fs_ds_index_entry
*entry
)
614 struct ctf_fs_ds_index_entry
*other_entry
= NULL
;
616 /* Find the spot where to insert this index entry. */
617 for (i
= 0; i
< index
->entries
->len
; i
++) {
618 other_entry
= (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, i
);
620 if (entry
->timestamp_begin_ns
<= other_entry
->timestamp_begin_ns
) {
626 * Insert the entry only if a duplicate doesn't already exist.
628 * There can be duplicate packets if reading multiple overlapping
629 * snapshots of the same trace. We then want the index to contain
630 * a reference to only one copy of that packet.
632 if (i
== index
->entries
->len
|| !ds_index_entries_equal(entry
, other_entry
)) {
633 array_insert(index
->entries
, entry
, i
);
639 static void merge_ctf_fs_ds_indexes(struct ctf_fs_ds_index
*dest
, struct ctf_fs_ds_index
*src
)
643 for (i
= 0; i
< src
->entries
->len
; i
++) {
644 struct ctf_fs_ds_index_entry
*entry
=
645 (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(src
->entries
, i
);
648 * Ownership of the ctf_fs_ds_index_entry is transferred to
649 * ds_index_insert_ds_index_entry_sorted.
651 g_ptr_array_index(src
->entries
, i
) = NULL
;
652 ds_index_insert_ds_index_entry_sorted(dest
, entry
);
656 static int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
, const char *path
)
658 int64_t stream_instance_id
= -1;
659 int64_t begin_ns
= -1;
660 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
661 bool add_group
= false;
664 struct ctf_fs_ds_file
*ds_file
= NULL
;
665 struct ctf_fs_ds_file_info
*ds_file_info
= NULL
;
666 struct ctf_fs_ds_index
*index
= NULL
;
667 struct ctf_msg_iter
*msg_iter
= NULL
;
668 struct ctf_stream_class
*sc
= NULL
;
669 struct ctf_msg_iter_packet_properties props
;
672 * Create a temporary ds_file to read some properties about the data
675 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, path
, ctf_fs_trace
->logger
);
680 /* Create a temporary iterator to read the ds_file. */
681 msg_iter
= ctf_msg_iter_create(
682 ctf_fs_trace
->metadata
->tc
,
683 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
684 ctf_fs_ds_file_medops
, ds_file
, nullptr, ctf_fs_trace
->logger
);
686 BT_CPPLOGE_STR_SPEC(ctf_fs_trace
->logger
, "Cannot create a CTF message iterator.");
690 ctf_msg_iter_set_dry_run(msg_iter
, true);
692 ret
= ctf_msg_iter_get_packet_properties(msg_iter
, &props
);
694 BT_CPPLOGE_APPEND_CAUSE_SPEC(
695 ctf_fs_trace
->logger
,
696 "Cannot get stream file's first packet's header and context fields (`{}`).", path
);
700 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
, props
.stream_class_id
);
702 stream_instance_id
= props
.data_stream_id
;
704 if (props
.snapshots
.beginning_clock
!= UINT64_C(-1)) {
705 BT_ASSERT(sc
->default_clock_class
);
706 ret
= bt_util_clock_cycles_to_ns_from_origin(
707 props
.snapshots
.beginning_clock
, sc
->default_clock_class
->frequency
,
708 sc
->default_clock_class
->offset_seconds
, sc
->default_clock_class
->offset_cycles
,
711 BT_CPPLOGE_APPEND_CAUSE_SPEC(
712 ctf_fs_trace
->logger
,
713 "Cannot convert clock cycles to nanoseconds from origin (`{}`).", path
);
718 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
);
723 index
= ctf_fs_ds_file_build_index(ds_file
, ds_file_info
, msg_iter
);
725 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to index CTF stream file \'{}\'",
726 ds_file
->file
->path
->str
);
730 if (begin_ns
== -1) {
732 * No beginning timestamp to sort the stream files
733 * within a stream file group, so consider that this
734 * file must be the only one within its group.
736 stream_instance_id
= -1;
739 if (stream_instance_id
== -1) {
741 * No stream instance ID or no beginning timestamp:
742 * create a unique stream file group for this stream
743 * file because, even if there's a stream instance ID,
744 * there's no timestamp to order the file within its
747 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, UINT64_C(-1), index
);
748 /* Ownership of index is transferred. */
751 if (!ds_file_group
) {
755 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, BT_MOVE_REF(ds_file_info
));
761 BT_ASSERT(stream_instance_id
!= -1);
762 BT_ASSERT(begin_ns
!= -1);
764 /* Find an existing stream file group with this ID */
765 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
767 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
769 if (ds_file_group
->sc
== sc
&& ds_file_group
->stream_id
== stream_instance_id
) {
773 ds_file_group
= NULL
;
776 if (!ds_file_group
) {
777 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, stream_instance_id
, index
);
778 /* Ownership of index is transferred. */
780 if (!ds_file_group
) {
786 merge_ctf_fs_ds_indexes(ds_file_group
->index
, index
);
789 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, BT_MOVE_REF(ds_file_info
));
794 ctf_fs_ds_file_group_destroy(ds_file_group
);
795 ds_file_group
= NULL
;
799 if (add_group
&& ds_file_group
) {
800 g_ptr_array_add(ctf_fs_trace
->ds_file_groups
, ds_file_group
);
803 ctf_fs_ds_file_destroy(ds_file
);
804 ctf_fs_ds_file_info_destroy(ds_file_info
);
807 ctf_msg_iter_destroy(msg_iter
);
810 ctf_fs_ds_index_destroy(index
);
814 static int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
817 const char *basename
;
818 GError
*error
= NULL
;
821 /* Check each file in the path directory, except specific ones */
822 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
824 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
825 "Cannot open directory `{}`: {} (code {})",
826 ctf_fs_trace
->path
->str
, error
->message
, error
->code
);
830 while ((basename
= g_dir_read_name(dir
))) {
831 struct ctf_fs_file
*file
;
833 if (strcmp(basename
, CTF_FS_METADATA_FILENAME
) == 0) {
834 /* Ignore the metadata stream. */
835 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
836 "Ignoring metadata file `{}" G_DIR_SEPARATOR_S
"{}`",
837 ctf_fs_trace
->path
->str
, basename
);
841 if (basename
[0] == '.') {
842 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
843 "Ignoring hidden file `{}" G_DIR_SEPARATOR_S
"{}`",
844 ctf_fs_trace
->path
->str
, basename
);
848 /* Create the file. */
849 file
= ctf_fs_file_create(ctf_fs_trace
->logger
);
851 BT_CPPLOGE_APPEND_CAUSE_SPEC(
852 ctf_fs_trace
->logger
,
853 "Cannot create stream file object for file `{}" G_DIR_SEPARATOR_S
"{}`",
854 ctf_fs_trace
->path
->str
, basename
);
858 /* Create full path string. */
859 g_string_append_printf(file
->path
, "%s" G_DIR_SEPARATOR_S
"%s", ctf_fs_trace
->path
->str
,
861 if (!g_file_test(file
->path
->str
, G_FILE_TEST_IS_REGULAR
)) {
862 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring non-regular file `{}`",
864 ctf_fs_file_destroy(file
);
869 ret
= ctf_fs_file_open(file
, "rb");
871 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Cannot open stream file `{}`",
876 if (file
->size
== 0) {
877 /* Skip empty stream. */
878 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring empty file `{}`", file
->path
->str
);
879 ctf_fs_file_destroy(file
);
883 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
, file
->path
->str
);
885 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
886 "Cannot add stream file `{}` to stream file group",
888 ctf_fs_file_destroy(file
);
892 ctf_fs_file_destroy(file
);
913 static int set_trace_name(bt_trace
*trace
, const char *name_suffix
, const bt2c::Logger
& logger
)
919 name
= g_string_new(NULL
);
921 BT_CPPLOGE_STR_SPEC(logger
, "Failed to allocate a GString.");
927 * Check if we have a trace environment string value named `hostname`.
928 * If so, use it as the trace name's prefix.
930 val
= bt_trace_borrow_environment_entry_value_by_name_const(trace
, "hostname");
931 if (val
&& bt_value_is_string(val
)) {
932 g_string_append(name
, bt_value_string_get(val
));
935 g_string_append_c(name
, G_DIR_SEPARATOR
);
940 g_string_append(name
, name_suffix
);
943 ret
= bt_trace_set_name(trace
, name
->str
);
952 g_string_free(name
, TRUE
);
958 static ctf_fs_trace::UP
ctf_fs_trace_create(const char *path
, const char *name
,
959 const ctf::src::ClkClsCfg
& clkClsCfg
,
960 bt_self_component
*selfComp
,
961 const bt2c::Logger
& parentLogger
)
965 ctf_fs_trace::UP ctf_fs_trace
{new struct ctf_fs_trace(parentLogger
)};
966 ctf_fs_trace
->path
= g_string_new(path
);
967 if (!ctf_fs_trace
->path
) {
971 ctf_fs_trace
->metadata
= new ctf_fs_metadata
;
972 ctf_fs_metadata_init(ctf_fs_trace
->metadata
);
973 ctf_fs_trace
->ds_file_groups
=
974 g_ptr_array_new_with_free_func((GDestroyNotify
) ctf_fs_ds_file_group_destroy
);
975 if (!ctf_fs_trace
->ds_file_groups
) {
979 ret
= ctf_fs_metadata_set_trace_class(selfComp
, ctf_fs_trace
.get(), clkClsCfg
);
984 if (ctf_fs_trace
->metadata
->trace_class
) {
985 ctf_fs_trace
->trace
= bt_trace_create(ctf_fs_trace
->metadata
->trace_class
);
986 if (!ctf_fs_trace
->trace
) {
991 if (ctf_fs_trace
->trace
) {
992 ret
= ctf_trace_class_configure_ir_trace(ctf_fs_trace
->metadata
->tc
, ctf_fs_trace
->trace
);
997 ret
= set_trace_name(ctf_fs_trace
->trace
, name
, ctf_fs_trace
->logger
);
1003 ret
= create_ds_file_groups(ctf_fs_trace
.get());
1011 ctf_fs_trace
.reset();
1014 return ctf_fs_trace
;
1017 static int path_is_ctf_trace(const char *path
)
1019 GString
*metadata_path
= g_string_new(NULL
);
1022 if (!metadata_path
) {
1027 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
1029 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
1035 g_string_free(metadata_path
, TRUE
);
1039 /* Helper for ctf_fs_component_create_ctf_fs_trace, to handle a single path. */
1041 static int ctf_fs_component_create_ctf_fs_trace_one_path(struct ctf_fs_component
*ctf_fs
,
1042 const char *path_param
,
1043 const char *trace_name
,
1044 std::vector
<ctf_fs_trace::UP
>& traces
,
1045 bt_self_component
*selfComp
)
1047 ctf_fs_trace::UP ctf_fs_trace
;
1051 norm_path
= bt_common_normalize_path(path_param
, NULL
);
1053 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to normalize path: `{}`.", path_param
);
1057 ret
= path_is_ctf_trace(norm_path
->str
);
1059 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1060 ctf_fs
->logger
, "Failed to check if path is a CTF trace: path={}", norm_path
->str
);
1062 } else if (ret
== 0) {
1063 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1064 ctf_fs
->logger
, "Path is not a CTF trace (does not contain a metadata file): `{}`.",
1069 // FIXME: Remove or ifdef for __MINGW32__
1070 if (strcmp(norm_path
->str
, "/") == 0) {
1071 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Opening a trace in `/` is not supported.");
1076 ctf_fs_trace
= ctf_fs_trace_create(norm_path
->str
, trace_name
, ctf_fs
->clkClsCfg
, selfComp
,
1078 if (!ctf_fs_trace
) {
1079 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create trace for `{}`.",
1084 traces
.emplace_back(std::move(ctf_fs_trace
));
1094 g_string_free(norm_path
, TRUE
);
1101 * Count the number of stream and event classes defined by this trace's metadata.
1103 * This is used to determine which metadata is the "latest", out of multiple
1104 * traces sharing the same UUID. It is assumed that amongst all these metadatas,
1105 * a bigger metadata is a superset of a smaller metadata. Therefore, it is
1106 * enough to just count the classes.
1109 static unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace
*trace
)
1111 unsigned int num
= trace
->metadata
->tc
->stream_classes
->len
;
1114 for (i
= 0; i
< trace
->metadata
->tc
->stream_classes
->len
; i
++) {
1115 struct ctf_stream_class
*sc
=
1116 (struct ctf_stream_class
*) trace
->metadata
->tc
->stream_classes
->pdata
[i
];
1117 num
+= sc
->event_classes
->len
;
1124 * Merge the src ds_file_group into dest. This consists of merging their
1125 * ds_file_infos, making sure to keep the result sorted.
1128 static void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group
*dest
,
1129 struct ctf_fs_ds_file_group
*src
)
1133 for (i
= 0; i
< src
->ds_file_infos
->len
; i
++) {
1134 struct ctf_fs_ds_file_info
*ds_file_info
=
1135 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(src
->ds_file_infos
, i
);
1137 /* Ownership of the ds_file_info is transferred to dest. */
1138 g_ptr_array_index(src
->ds_file_infos
, i
) = NULL
;
1140 ds_file_group_insert_ds_file_info_sorted(dest
, ds_file_info
);
1143 /* Merge both indexes. */
1144 merge_ctf_fs_ds_indexes(dest
->index
, src
->index
);
1147 /* Merge src_trace's data stream file groups into dest_trace's. */
1149 static int merge_matching_ctf_fs_ds_file_groups(struct ctf_fs_trace
*dest_trace
,
1150 ctf_fs_trace::UP src_trace
)
1152 GPtrArray
*dest
= dest_trace
->ds_file_groups
;
1153 GPtrArray
*src
= src_trace
->ds_file_groups
;
1158 * Save the initial length of dest: we only want to check against the
1159 * original elements in the inner loop.
1161 const guint dest_len
= dest
->len
;
1163 for (s_i
= 0; s_i
< src
->len
; s_i
++) {
1164 struct ctf_fs_ds_file_group
*src_group
=
1165 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(src
, s_i
);
1166 struct ctf_fs_ds_file_group
*dest_group
= NULL
;
1168 /* A stream instance without ID can't match a stream in the other trace. */
1169 if (src_group
->stream_id
!= -1) {
1172 /* Let's search for a matching ds_file_group in the destination. */
1173 for (d_i
= 0; d_i
< dest_len
; d_i
++) {
1174 struct ctf_fs_ds_file_group
*candidate_dest
=
1175 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(dest
, d_i
);
1177 /* Can't match a stream instance without ID. */
1178 if (candidate_dest
->stream_id
== -1) {
1183 * If the two groups have the same stream instance id
1184 * and belong to the same stream class (stream instance
1185 * ids are per-stream class), they represent the same
1188 if (candidate_dest
->stream_id
!= src_group
->stream_id
||
1189 candidate_dest
->sc
->id
!= src_group
->sc
->id
) {
1193 dest_group
= candidate_dest
;
1199 * Didn't find a friend in dest to merge our src_group into?
1200 * Create a new empty one. This can happen if a stream was
1201 * active in the source trace chunk but not in the destination
1205 struct ctf_stream_class
*sc
;
1206 struct ctf_fs_ds_index
*index
;
1208 sc
= ctf_trace_class_borrow_stream_class_by_id(dest_trace
->metadata
->tc
,
1212 index
= ctf_fs_ds_index_create(dest_trace
->logger
);
1218 dest_group
= ctf_fs_ds_file_group_create(dest_trace
, sc
, src_group
->stream_id
, index
);
1219 /* Ownership of index is transferred. */
1226 g_ptr_array_add(dest_trace
->ds_file_groups
, dest_group
);
1229 BT_ASSERT(dest_group
);
1230 merge_ctf_fs_ds_file_groups(dest_group
, src_group
);
1238 * Collapse the given traces, which must all share the same UUID, in a single
1241 * The trace with the most expansive metadata is chosen and all other traces
1242 * are merged into that one. On return, the elements of `traces` are nullptr
1243 * and the merged trace is placed in `out_trace`.
1246 static int merge_ctf_fs_traces(std::vector
<ctf_fs_trace::UP
> traces
, ctf_fs_trace::UP
& out_trace
)
1248 unsigned int winner_count
;
1249 struct ctf_fs_trace
*winner
;
1253 BT_ASSERT(traces
.size() >= 2);
1255 winner_count
= metadata_count_stream_and_event_classes(traces
[0].get());
1256 winner
= traces
[0].get();
1259 /* Find the trace with the largest metadata. */
1260 for (i
= 1; i
< traces
.size(); i
++) {
1261 ctf_fs_trace
*candidate
= traces
[i
].get();
1262 unsigned int candidate_count
;
1264 /* A bit of sanity check. */
1265 BT_ASSERT(bt_uuid_compare(winner
->metadata
->tc
->uuid
, candidate
->metadata
->tc
->uuid
) == 0);
1267 candidate_count
= metadata_count_stream_and_event_classes(candidate
);
1269 if (candidate_count
> winner_count
) {
1270 winner_count
= candidate_count
;
1276 /* Merge all the other traces in the winning trace. */
1277 for (ctf_fs_trace::UP
& trace
: traces
) {
1278 /* Don't merge the winner into itself. */
1279 if (trace
.get() == winner
) {
1283 /* Merge trace's data stream file groups into winner's. */
1284 ret
= merge_matching_ctf_fs_ds_file_groups(winner
, std::move(trace
));
1291 * Move the winner out of the array, into `*out_trace`.
1293 out_trace
= std::move(traces
[winner_i
]);
1305 static int decode_clock_snapshot_after_event(struct ctf_fs_trace
*ctf_fs_trace
,
1306 struct ctf_clock_class
*default_cc
,
1307 struct ctf_fs_ds_index_entry
*index_entry
,
1308 enum target_event target_event
, uint64_t *cs
,
1311 enum ctf_msg_iter_status iter_status
= CTF_MSG_ITER_STATUS_OK
;
1312 struct ctf_fs_ds_file
*ds_file
= NULL
;
1313 struct ctf_msg_iter
*msg_iter
= NULL
;
1316 BT_ASSERT(ctf_fs_trace
);
1317 BT_ASSERT(index_entry
);
1318 BT_ASSERT(index_entry
->path
);
1320 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, index_entry
->path
, ctf_fs_trace
->logger
);
1322 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to create a ctf_fs_ds_file");
1327 BT_ASSERT(ctf_fs_trace
->metadata
);
1328 BT_ASSERT(ctf_fs_trace
->metadata
->tc
);
1330 msg_iter
= ctf_msg_iter_create(
1331 ctf_fs_trace
->metadata
->tc
,
1332 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
1333 ctf_fs_ds_file_medops
, ds_file
, NULL
, ctf_fs_trace
->logger
);
1335 /* ctf_msg_iter_create() logs errors. */
1341 * Turn on dry run mode to prevent the creation and usage of Babeltrace
1342 * library objects (bt_field, bt_message_*, etc.).
1344 ctf_msg_iter_set_dry_run(msg_iter
, true);
1346 /* Seek to the beginning of the target packet. */
1347 iter_status
= ctf_msg_iter_seek(msg_iter
, index_entry
->offset
.bytes());
1349 /* ctf_msg_iter_seek() logs errors. */
1354 switch (target_event
) {
1357 * Start to decode the packet until we reach the end of
1358 * the first event. To extract the first event's clock
1361 iter_status
= ctf_msg_iter_curr_packet_first_event_clock_snapshot(msg_iter
, cs
);
1364 /* Decode the packet to extract the last event's clock snapshot. */
1365 iter_status
= ctf_msg_iter_curr_packet_last_event_clock_snapshot(msg_iter
, cs
);
1375 /* Convert clock snapshot to timestamp. */
1376 ret
= bt_util_clock_cycles_to_ns_from_origin(
1377 *cs
, default_cc
->frequency
, default_cc
->offset_seconds
, default_cc
->offset_cycles
, ts_ns
);
1379 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1380 "Failed to convert clock snapshot to timestamp");
1386 ctf_fs_ds_file_destroy(ds_file
);
1389 ctf_msg_iter_destroy(msg_iter
);
1395 static int decode_packet_first_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1396 struct ctf_clock_class
*default_cc
,
1397 struct ctf_fs_ds_index_entry
*index_entry
,
1398 uint64_t *cs
, int64_t *ts_ns
)
1400 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, FIRST_EVENT
, cs
,
1404 static int decode_packet_last_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1405 struct ctf_clock_class
*default_cc
,
1406 struct ctf_fs_ds_index_entry
*index_entry
,
1407 uint64_t *cs
, int64_t *ts_ns
)
1409 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, LAST_EVENT
, cs
,
1414 * Fix up packet index entries for lttng's "event-after-packet" bug.
1415 * Some buggy lttng tracer versions may emit events with a timestamp that is
1416 * larger (after) than the timestamp_end of the their packets.
1418 * To fix up this erroneous data we do the following:
1419 * 1. If it's not the stream file's last packet: set the packet index entry's
1420 * end time to the next packet's beginning time.
1421 * 2. If it's the stream file's last packet, set the packet index entry's end
1422 * time to the packet's last event's time, if any, or to the packet's
1423 * beginning time otherwise.
1425 * Known buggy tracer versions:
1426 * - before lttng-ust 2.11.0
1427 * - before lttng-module 2.11.0
1428 * - before lttng-module 2.10.10
1429 * - before lttng-module 2.9.13
1431 static int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace
*trace
)
1434 guint ds_file_group_i
;
1435 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1437 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
; ds_file_group_i
++) {
1439 struct ctf_clock_class
*default_cc
;
1440 struct ctf_fs_ds_index_entry
*last_entry
;
1441 struct ctf_fs_ds_index
*index
;
1443 struct ctf_fs_ds_file_group
*ds_file_group
=
1444 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1446 BT_ASSERT(ds_file_group
);
1447 index
= ds_file_group
->index
;
1450 BT_ASSERT(index
->entries
);
1451 BT_ASSERT(index
->entries
->len
> 0);
1454 * Iterate over all entries but the last one. The last one is
1455 * fixed differently after.
1457 for (entry_i
= 0; entry_i
< index
->entries
->len
- 1; entry_i
++) {
1458 struct ctf_fs_ds_index_entry
*curr_entry
, *next_entry
;
1460 curr_entry
= (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
);
1461 next_entry
= (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
+ 1);
1464 * 1. Set the current index entry `end` timestamp to
1465 * the next index entry `begin` timestamp.
1467 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1468 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1472 * 2. Fix the last entry by decoding the last event of the last
1476 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, index
->entries
->len
- 1);
1477 BT_ASSERT(last_entry
);
1479 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1480 default_cc
= ds_file_group
->sc
->default_clock_class
;
1483 * Decode packet to read the timestamp of the last event of the
1486 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1487 &last_entry
->timestamp_end
,
1488 &last_entry
->timestamp_end_ns
);
1490 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1492 "Failed to decode stream's last packet to get its last event's clock snapshot.");
1502 * Fix up packet index entries for barectf's "event-before-packet" bug.
1503 * Some buggy barectf tracer versions may emit events with a timestamp that is
1504 * less than the timestamp_begin of the their packets.
1506 * To fix up this erroneous data we do the following:
1507 * 1. Starting at the second index entry, set the timestamp_begin of the
1508 * current entry to the timestamp of the first event of the packet.
1509 * 2. Set the previous entry's timestamp_end to the timestamp_begin of the
1512 * Known buggy tracer versions:
1513 * - before barectf 2.3.1
1515 static int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace
*trace
)
1518 guint ds_file_group_i
;
1519 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1521 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
; ds_file_group_i
++) {
1523 struct ctf_clock_class
*default_cc
;
1524 ctf_fs_ds_file_group
*ds_file_group
=
1525 (ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1527 struct ctf_fs_ds_index
*index
= ds_file_group
->index
;
1530 BT_ASSERT(index
->entries
);
1531 BT_ASSERT(index
->entries
->len
> 0);
1533 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1534 default_cc
= ds_file_group
->sc
->default_clock_class
;
1537 * 1. Iterate over the index, starting from the second entry
1540 for (entry_i
= 1; entry_i
< index
->entries
->len
; entry_i
++) {
1541 ctf_fs_ds_index_entry
*prev_entry
=
1542 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
- 1);
1543 ctf_fs_ds_index_entry
*curr_entry
=
1544 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
);
1546 * 2. Set the current entry `begin` timestamp to the
1547 * timestamp of the first event of the current packet.
1549 ret
= decode_packet_first_event_timestamp(trace
, default_cc
, curr_entry
,
1550 &curr_entry
->timestamp_begin
,
1551 &curr_entry
->timestamp_begin_ns
);
1553 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1554 "Failed to decode first event's clock snapshot");
1559 * 3. Set the previous entry `end` timestamp to the
1560 * timestamp of the first event of the current packet.
1562 prev_entry
->timestamp_end
= curr_entry
->timestamp_begin
;
1563 prev_entry
->timestamp_end_ns
= curr_entry
->timestamp_begin_ns
;
1571 * When using the lttng-crash feature it's likely that the last packets of each
1572 * stream have their timestamp_end set to zero. This is caused by the fact that
1573 * the tracer crashed and was not able to properly close the packets.
1575 * To fix up this erroneous data we do the following:
1576 * For each index entry, if the entry's timestamp_end is 0 and the
1577 * timestamp_begin is not 0:
1578 * - If it's the stream file's last packet: set the packet index entry's end
1579 * time to the packet's last event's time, if any, or to the packet's
1580 * beginning time otherwise.
1581 * - If it's not the stream file's last packet: set the packet index
1582 * entry's end time to the next packet's beginning time.
1584 * Affected versions:
1585 * - All current and future lttng-ust and lttng-modules versions.
1587 static int fix_index_lttng_crash_quirk(struct ctf_fs_trace
*trace
)
1590 guint ds_file_group_idx
;
1591 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1593 for (ds_file_group_idx
= 0; ds_file_group_idx
< ds_file_groups
->len
; ds_file_group_idx
++) {
1595 struct ctf_clock_class
*default_cc
;
1596 struct ctf_fs_ds_index
*index
;
1598 ctf_fs_ds_file_group
*ds_file_group
=
1599 (ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_idx
);
1601 BT_ASSERT(ds_file_group
);
1602 index
= ds_file_group
->index
;
1604 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1605 default_cc
= ds_file_group
->sc
->default_clock_class
;
1608 BT_ASSERT(index
->entries
);
1609 BT_ASSERT(index
->entries
->len
> 0);
1611 ctf_fs_ds_index_entry
*last_entry
=
1612 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, index
->entries
->len
- 1);
1613 BT_ASSERT(last_entry
);
1615 /* 1. Fix the last entry first. */
1616 if (last_entry
->timestamp_end
== 0 && last_entry
->timestamp_begin
!= 0) {
1618 * Decode packet to read the timestamp of the
1619 * last event of the stream file.
1621 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1622 &last_entry
->timestamp_end
,
1623 &last_entry
->timestamp_end_ns
);
1625 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1626 "Failed to decode last event's clock snapshot");
1631 /* Iterate over all entries but the last one. */
1632 for (entry_idx
= 0; entry_idx
< index
->entries
->len
- 1; entry_idx
++) {
1633 ctf_fs_ds_index_entry
*curr_entry
=
1634 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_idx
);
1635 ctf_fs_ds_index_entry
*next_entry
=
1636 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_idx
+ 1);
1638 if (curr_entry
->timestamp_end
== 0 && curr_entry
->timestamp_begin
!= 0) {
1640 * 2. Set the current index entry `end` timestamp to
1641 * the next index entry `begin` timestamp.
1643 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1644 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1654 * Extract the tracer information necessary to compare versions.
1655 * Returns 0 on success, and -1 if the extraction is not successful because the
1656 * necessary fields are absents in the trace metadata.
1658 static int extract_tracer_info(struct ctf_fs_trace
*trace
, struct tracer_info
*current_tracer_info
)
1661 struct ctf_trace_class_env_entry
*entry
;
1663 /* Clear the current_tracer_info struct */
1664 memset(current_tracer_info
, 0, sizeof(*current_tracer_info
));
1667 * To compare 2 tracer versions, at least the tracer name and it's
1668 * major version are needed. If one of these is missing, consider it an
1669 * extraction failure.
1671 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_name");
1672 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR
) {
1673 goto missing_bare_minimum
;
1676 /* Set tracer name. */
1677 current_tracer_info
->name
= entry
->value
.str
->str
;
1679 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_major");
1680 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1681 goto missing_bare_minimum
;
1684 /* Set major version number. */
1685 current_tracer_info
->major
= entry
->value
.i
;
1687 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_minor");
1688 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1692 /* Set minor version number. */
1693 current_tracer_info
->minor
= entry
->value
.i
;
1695 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patch");
1698 * If `tracer_patch` doesn't exist `tracer_patchlevel` might.
1699 * For example, `lttng-modules` uses entry name
1700 * `tracer_patchlevel`.
1702 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patchlevel");
1705 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1709 /* Set patch version number. */
1710 current_tracer_info
->patch
= entry
->value
.i
;
1714 missing_bare_minimum
:
1720 static bool is_tracer_affected_by_lttng_event_after_packet_bug(struct tracer_info
*curr_tracer_info
)
1722 bool is_affected
= false;
1724 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1725 if (curr_tracer_info
->major
< 2) {
1727 } else if (curr_tracer_info
->major
== 2) {
1728 /* fixed in lttng-ust 2.11.0 */
1729 if (curr_tracer_info
->minor
< 11) {
1733 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1734 if (curr_tracer_info
->major
< 2) {
1736 } else if (curr_tracer_info
->major
== 2) {
1737 /* fixed in lttng-modules 2.11.0 */
1738 if (curr_tracer_info
->minor
== 10) {
1739 /* fixed in lttng-modules 2.10.10 */
1740 if (curr_tracer_info
->patch
< 10) {
1743 } else if (curr_tracer_info
->minor
== 9) {
1744 /* fixed in lttng-modules 2.9.13 */
1745 if (curr_tracer_info
->patch
< 13) {
1748 } else if (curr_tracer_info
->minor
< 9) {
1758 is_tracer_affected_by_barectf_event_before_packet_bug(struct tracer_info
*curr_tracer_info
)
1760 bool is_affected
= false;
1762 if (strcmp(curr_tracer_info
->name
, "barectf") == 0) {
1763 if (curr_tracer_info
->major
< 2) {
1765 } else if (curr_tracer_info
->major
== 2) {
1766 if (curr_tracer_info
->minor
< 3) {
1768 } else if (curr_tracer_info
->minor
== 3) {
1769 /* fixed in barectf 2.3.1 */
1770 if (curr_tracer_info
->patch
< 1) {
1780 static bool is_tracer_affected_by_lttng_crash_quirk(struct tracer_info
*curr_tracer_info
)
1782 bool is_affected
= false;
1784 /* All LTTng tracer may be affected by this lttng crash quirk. */
1785 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1787 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1795 * Looks for trace produced by known buggy tracers and fix up the index
1798 static int fix_packet_index_tracer_bugs(ctf_fs_trace
*trace
)
1801 struct tracer_info current_tracer_info
;
1803 ret
= extract_tracer_info(trace
, ¤t_tracer_info
);
1806 * A trace may not have all the necessary environment
1807 * entries to do the tracer version comparison.
1808 * At least, the tracer name and major version number
1809 * are needed. Failing to extract these entries is not
1813 BT_CPPLOGI_STR_SPEC(
1815 "Cannot extract tracer information necessary to compare with buggy versions.");
1819 /* Check if the trace may be affected by old tracer bugs. */
1820 if (is_tracer_affected_by_lttng_event_after_packet_bug(¤t_tracer_info
)) {
1821 BT_CPPLOGI_STR_SPEC(
1823 "Trace may be affected by LTTng tracer packet timestamp bug. Fixing up.");
1824 ret
= fix_index_lttng_event_after_packet_bug(trace
);
1826 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1827 "Failed to fix LTTng event-after-packet bug.");
1830 trace
->metadata
->tc
->quirks
.lttng_event_after_packet
= true;
1833 if (is_tracer_affected_by_barectf_event_before_packet_bug(¤t_tracer_info
)) {
1834 BT_CPPLOGI_STR_SPEC(
1836 "Trace may be affected by barectf tracer packet timestamp bug. Fixing up.");
1837 ret
= fix_index_barectf_event_before_packet_bug(trace
);
1839 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1840 "Failed to fix barectf event-before-packet bug.");
1843 trace
->metadata
->tc
->quirks
.barectf_event_before_packet
= true;
1846 if (is_tracer_affected_by_lttng_crash_quirk(¤t_tracer_info
)) {
1847 ret
= fix_index_lttng_crash_quirk(trace
);
1849 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1850 "Failed to fix lttng-crash timestamp quirks.");
1853 trace
->metadata
->tc
->quirks
.lttng_crash
= true;
1860 static gint
compare_ds_file_groups_by_first_path(gconstpointer a
, gconstpointer b
)
1862 ctf_fs_ds_file_group
* const *ds_file_group_a
= (ctf_fs_ds_file_group
**) a
;
1863 ctf_fs_ds_file_group
* const *ds_file_group_b
= (ctf_fs_ds_file_group
**) b
;
1865 BT_ASSERT((*ds_file_group_a
)->ds_file_infos
->len
> 0);
1866 BT_ASSERT((*ds_file_group_b
)->ds_file_infos
->len
> 0);
1868 const ctf_fs_ds_file_info
*first_ds_file_info_a
=
1869 (const ctf_fs_ds_file_info
*) (*ds_file_group_a
)->ds_file_infos
->pdata
[0];
1870 const ctf_fs_ds_file_info
*first_ds_file_info_b
=
1871 (const ctf_fs_ds_file_info
*) (*ds_file_group_b
)->ds_file_infos
->pdata
[0];
1873 return strcmp(first_ds_file_info_a
->path
->str
, first_ds_file_info_b
->path
->str
);
1876 static gint
compare_strings(gconstpointer p_a
, gconstpointer p_b
)
1878 const char *a
= *((const char **) p_a
);
1879 const char *b
= *((const char **) p_b
);
1881 return strcmp(a
, b
);
1884 int ctf_fs_component_create_ctf_fs_trace(struct ctf_fs_component
*ctf_fs
,
1885 const bt_value
*paths_value
,
1886 const bt_value
*trace_name_value
,
1887 bt_self_component
*selfComp
)
1891 GPtrArray
*paths
= NULL
;
1892 std::vector
<ctf_fs_trace::UP
> traces
;
1893 const char *trace_name
;
1895 BT_ASSERT(bt_value_get_type(paths_value
) == BT_VALUE_TYPE_ARRAY
);
1896 BT_ASSERT(!bt_value_array_is_empty(paths_value
));
1898 paths
= g_ptr_array_new_with_free_func(g_free
);
1900 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to allocate a GPtrArray.");
1904 trace_name
= trace_name_value
? bt_value_string_get(trace_name_value
) : NULL
;
1907 * Create a sorted array of the paths, to make the execution of this
1908 * component deterministic.
1910 for (i
= 0; i
< bt_value_array_get_length(paths_value
); i
++) {
1911 const bt_value
*path_value
= bt_value_array_borrow_element_by_index_const(paths_value
, i
);
1912 const char *input
= bt_value_string_get(path_value
);
1915 input_copy
= g_strdup(input
);
1917 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to copy a string.");
1921 g_ptr_array_add(paths
, input_copy
);
1924 g_ptr_array_sort(paths
, compare_strings
);
1926 /* Create a separate ctf_fs_trace object for each path. */
1927 for (i
= 0; i
< paths
->len
; i
++) {
1928 const char *path
= (const char *) g_ptr_array_index(paths
, i
);
1930 ret
= ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs
, path
, trace_name
, traces
,
1937 if (traces
.size() > 1) {
1938 ctf_fs_trace
*first_trace
= traces
[0].get();
1939 const uint8_t *first_trace_uuid
= first_trace
->metadata
->tc
->uuid
;
1942 * We have more than one trace, they must all share the same
1943 * UUID, verify that.
1945 for (i
= 0; i
< traces
.size(); i
++) {
1946 ctf_fs_trace
*this_trace
= traces
[i
].get();
1947 const uint8_t *this_trace_uuid
= this_trace
->metadata
->tc
->uuid
;
1949 if (!this_trace
->metadata
->tc
->is_uuid_set
) {
1950 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1952 "Multiple traces given, but a trace does not have a UUID: path={}",
1953 this_trace
->path
->str
);
1957 if (bt_uuid_compare(first_trace_uuid
, this_trace_uuid
) != 0) {
1958 char first_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1959 char this_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1961 bt_uuid_to_str(first_trace_uuid
, first_trace_uuid_str
);
1962 bt_uuid_to_str(this_trace_uuid
, this_trace_uuid_str
);
1964 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1965 "Multiple traces given, but UUIDs don't match: "
1966 "first-trace-uuid={}, first-trace-path={}, "
1967 "trace-uuid={}, trace-path={}",
1968 first_trace_uuid_str
, first_trace
->path
->str
,
1969 this_trace_uuid_str
, this_trace
->path
->str
);
1974 ret
= merge_ctf_fs_traces(std::move(traces
), ctf_fs
->trace
);
1976 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1977 "Failed to merge traces with the same UUID.");
1981 /* Just one trace, it may or may not have a UUID, both are fine. */
1982 ctf_fs
->trace
= std::move(traces
[0]);
1985 ret
= fix_packet_index_tracer_bugs(ctf_fs
->trace
.get());
1987 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to fix packet index tracer bugs.");
1991 * Sort data stream file groups by first data stream file info
1992 * path to get a deterministic order. This order influences the
1993 * order of the output ports. It also influences the order of
1994 * the automatic stream IDs if the trace's packet headers do not
1995 * contain a `stream_instance_id` field, in which case the data
1996 * stream file to stream ID association is always the same,
1997 * whatever the build and the system.
1999 * Having a deterministic order here can help debugging and
2002 g_ptr_array_sort(ctf_fs
->trace
->ds_file_groups
, compare_ds_file_groups_by_first_path
);
2009 g_ptr_array_free(paths
, TRUE
);
2015 static GString
*get_stream_instance_unique_name(struct ctf_fs_ds_file_group
*ds_file_group
)
2018 struct ctf_fs_ds_file_info
*ds_file_info
;
2020 name
= g_string_new(NULL
);
2026 * If there's more than one stream file in the stream file
2027 * group, the first (earliest) stream file's path is used as
2028 * the stream's unique name.
2030 BT_ASSERT(ds_file_group
->ds_file_infos
->len
> 0);
2031 ds_file_info
= (ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
2032 g_string_assign(name
, ds_file_info
->path
->str
);
2038 /* Create the IR stream objects for ctf_fs_trace. */
2040 static int create_streams_for_trace(struct ctf_fs_trace
*ctf_fs_trace
)
2043 GString
*name
= NULL
;
2046 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
2047 ctf_fs_ds_file_group
*ds_file_group
=
2048 (ctf_fs_ds_file_group
*) g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
2049 name
= get_stream_instance_unique_name(ds_file_group
);
2055 BT_ASSERT(ds_file_group
->sc
->ir_sc
);
2056 BT_ASSERT(ctf_fs_trace
->trace
);
2058 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
2059 /* No stream ID: use 0 */
2060 ds_file_group
->stream
= bt_stream_create_with_id(
2061 ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
, ctf_fs_trace
->next_stream_id
);
2062 ctf_fs_trace
->next_stream_id
++;
2064 /* Specific stream ID */
2065 ds_file_group
->stream
= bt_stream_create_with_id(
2066 ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
, (uint64_t) ds_file_group
->stream_id
);
2069 if (!ds_file_group
->stream
) {
2070 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
2071 "Cannot create stream for DS file group: "
2072 "addr={}, stream-name=\"{}\"",
2073 fmt::ptr(ds_file_group
), name
->str
);
2077 ret
= bt_stream_set_name(ds_file_group
->stream
, name
->str
);
2079 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
2080 "Cannot set stream's name: "
2081 "addr={}, stream-name=\"{}\"",
2082 fmt::ptr(ds_file_group
->stream
), name
->str
);
2086 g_string_free(name
, TRUE
);
2099 g_string_free(name
, TRUE
);
2104 static const bt_param_validation_value_descr inputs_elem_descr
=
2105 bt_param_validation_value_descr::makeString();
2107 static bt_param_validation_map_value_entry_descr fs_params_entries_descr
[] = {
2108 {"inputs", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
2109 bt_param_validation_value_descr::makeArray(1, BT_PARAM_VALIDATION_INFINITE
,
2110 inputs_elem_descr
)},
2111 {"trace-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2112 bt_param_validation_value_descr::makeString()},
2113 {"clock-class-offset-s", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2114 bt_param_validation_value_descr::makeSignedInteger()},
2115 {"clock-class-offset-ns", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2116 bt_param_validation_value_descr::makeSignedInteger()},
2117 {"force-clock-class-origin-unix-epoch", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2118 bt_param_validation_value_descr::makeBool()},
2119 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
2121 bool read_src_fs_parameters(const bt_value
*params
, const bt_value
**inputs
,
2122 const bt_value
**trace_name
, struct ctf_fs_component
*ctf_fs
)
2125 const bt_value
*value
;
2126 enum bt_param_validation_status validate_value_status
;
2127 gchar
*error
= NULL
;
2129 validate_value_status
= bt_param_validation_validate(params
, fs_params_entries_descr
, &error
);
2130 if (validate_value_status
!= BT_PARAM_VALIDATION_STATUS_OK
) {
2131 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "{}", error
);
2136 /* inputs parameter */
2137 *inputs
= bt_value_map_borrow_entry_value_const(params
, "inputs");
2139 /* clock-class-offset-s parameter */
2140 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-s");
2142 ctf_fs
->clkClsCfg
.offsetSec
= bt_value_integer_signed_get(value
);
2145 /* clock-class-offset-ns parameter */
2146 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-ns");
2148 ctf_fs
->clkClsCfg
.offsetNanoSec
= bt_value_integer_signed_get(value
);
2151 /* force-clock-class-origin-unix-epoch parameter */
2152 value
= bt_value_map_borrow_entry_value_const(params
, "force-clock-class-origin-unix-epoch");
2154 ctf_fs
->clkClsCfg
.forceOriginIsUnixEpoch
= bt_value_bool_get(value
);
2157 /* trace-name parameter */
2158 *trace_name
= bt_value_map_borrow_entry_value_const(params
, "trace-name");
2167 static ctf_fs_component::UP
ctf_fs_create(const bt_value
*params
,
2168 bt_self_component_source
*self_comp_src
)
2170 const bt_value
*inputs_value
;
2171 const bt_value
*trace_name_value
;
2172 bt_self_component
*self_comp
= bt_self_component_source_as_self_component(self_comp_src
);
2174 ctf_fs_component::UP ctf_fs
= ctf_fs_component_create(
2175 bt2c::Logger
{bt2::SelfSourceComponent
{self_comp_src
}, "PLUGIN/SRC.CTF.FS/COMP"});
2180 if (!read_src_fs_parameters(params
, &inputs_value
, &trace_name_value
, ctf_fs
.get())) {
2184 if (ctf_fs_component_create_ctf_fs_trace(ctf_fs
.get(), inputs_value
, trace_name_value
,
2189 if (create_streams_for_trace(ctf_fs
->trace
.get())) {
2193 if (create_ports_for_trace(ctf_fs
.get(), ctf_fs
->trace
.get(), self_comp_src
)) {
2200 bt_component_class_initialize_method_status
ctf_fs_init(bt_self_component_source
*self_comp_src
,
2201 bt_self_component_source_configuration
*,
2202 const bt_value
*params
, void *)
2205 bt_component_class_initialize_method_status ret
=
2206 BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
2208 ctf_fs_component::UP ctf_fs
= ctf_fs_create(params
, self_comp_src
);
2210 ret
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
2213 bt_self_component_set_data(bt_self_component_source_as_self_component(self_comp_src
),
2216 } catch (const std::bad_alloc
&) {
2217 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
2218 } catch (const bt2::Error
&) {
2219 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
2223 bt_component_class_query_method_status
ctf_fs_query(bt_self_component_class_source
*comp_class_src
,
2224 bt_private_query_executor
*priv_query_exec
,
2225 const char *object
, const bt_value
*params
,
2226 __attribute__((unused
)) void *method_data
,
2227 const bt_value
**result
)
2230 bt2c::Logger logger
{bt2::SelfComponentClass
{comp_class_src
},
2231 bt2::PrivateQueryExecutor
{priv_query_exec
},
2232 "PLUGIN/SRC.CTF.FS/QUERY"};
2233 bt2::ConstMapValue
paramsObj(params
);
2234 bt2::Value::Shared resultObj
;
2236 if (strcmp(object
, "metadata-info") == 0) {
2237 resultObj
= metadata_info_query(paramsObj
, logger
);
2238 } else if (strcmp(object
, "babeltrace.trace-infos") == 0) {
2239 resultObj
= trace_infos_query(paramsObj
, logger
);
2240 } else if (!strcmp(object
, "babeltrace.support-info")) {
2241 resultObj
= support_info_query(paramsObj
, logger
);
2243 BT_CPPLOGE_SPEC(logger
, "Unknown query object `{}`", object
);
2244 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;
2247 *result
= resultObj
.release().libObjPtr();
2249 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
2250 } catch (const std::bad_alloc
&) {
2251 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
2252 } catch (const bt2::Error
&) {
2253 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;