2 * SPDX-License-Identifier: MIT
4 * Copyright 2015-2017 Philippe Proulx <pproulx@efficios.com>
5 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 * Babeltrace CTF file system Reader Component
13 #include <babeltrace2/babeltrace.h>
15 #include "common/assert.h"
16 #include "common/common.h"
17 #include "common/uuid.h"
19 #include "plugins/common/param-validation/param-validation.h"
21 #include "../common/src/metadata/tsdl/ctf-meta-configure-ir-trace.hpp"
22 #include "../common/src/msg-iter/msg-iter.hpp"
23 #include "data-stream-file.hpp"
26 #include "metadata.hpp"
37 static void ctf_fs_msg_iter_data_destroy(struct ctf_fs_msg_iter_data
*msg_iter_data
)
43 if (msg_iter_data
->msg_iter
) {
44 ctf_msg_iter_destroy(msg_iter_data
->msg_iter
);
47 if (msg_iter_data
->msg_iter_medops_data
) {
48 ctf_fs_ds_group_medops_data_destroy(msg_iter_data
->msg_iter_medops_data
);
54 static bt_message_iterator_class_next_method_status
55 ctf_fs_iterator_next_one(struct ctf_fs_msg_iter_data
*msg_iter_data
, const bt_message
**out_msg
)
57 bt_message_iterator_class_next_method_status status
;
58 enum ctf_msg_iter_status msg_iter_status
;
60 msg_iter_status
= ctf_msg_iter_get_next_message(msg_iter_data
->msg_iter
, out_msg
);
62 switch (msg_iter_status
) {
63 case CTF_MSG_ITER_STATUS_OK
:
64 /* Cool, message has been written to *out_msg. */
65 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
68 case CTF_MSG_ITER_STATUS_EOF
:
69 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END
;
72 case CTF_MSG_ITER_STATUS_AGAIN
:
74 * Should not make it this far as this is
75 * medium-specific; there is nothing for the user to do
76 * and it should have been handled upstream.
80 case CTF_MSG_ITER_STATUS_ERROR
:
81 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
82 "Failed to get next message from CTF message iterator.");
83 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
86 case CTF_MSG_ITER_STATUS_MEMORY_ERROR
:
87 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
88 "Failed to get next message from CTF message iterator.");
89 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
99 bt_message_iterator_class_next_method_status
100 ctf_fs_iterator_next(bt_self_message_iterator
*iterator
, bt_message_array_const msgs
,
101 uint64_t capacity
, uint64_t *count
)
104 bt_message_iterator_class_next_method_status status
;
105 struct ctf_fs_msg_iter_data
*msg_iter_data
=
106 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(iterator
);
109 if (G_UNLIKELY(msg_iter_data
->next_saved_error
)) {
111 * Last time we were called, we hit an error but had some
112 * messages to deliver, so we stashed the error here. Return
115 BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(msg_iter_data
->next_saved_error
);
116 status
= msg_iter_data
->next_saved_status
;
121 status
= ctf_fs_iterator_next_one(msg_iter_data
, &msgs
[i
]);
122 if (status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
) {
125 } while (i
< capacity
&& status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
);
129 * Even if ctf_fs_iterator_next_one() returned something
130 * else than BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK, we
131 * accumulated message objects in the output
132 * message array, so we need to return
133 * BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK so that they are
134 * transferred to downstream. This other status occurs
135 * again the next time muxer_msg_iter_do_next() is
136 * called, possibly without any accumulated
137 * message, in which case we'll return it.
141 * Save this error for the next _next call. Assume that
142 * this component always appends error causes when
143 * returning an error status code, which will cause the
144 * current thread error to be non-NULL.
146 msg_iter_data
->next_saved_error
= bt_current_thread_take_error();
147 BT_ASSERT(msg_iter_data
->next_saved_error
);
148 msg_iter_data
->next_saved_status
= status
;
152 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
158 } catch (const std::bad_alloc
&) {
159 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
160 } catch (const bt2::Error
&) {
161 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
165 bt_message_iterator_class_seek_beginning_method_status
166 ctf_fs_iterator_seek_beginning(bt_self_message_iterator
*it
)
169 struct ctf_fs_msg_iter_data
*msg_iter_data
=
170 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(it
);
172 BT_ASSERT(msg_iter_data
);
174 ctf_msg_iter_reset(msg_iter_data
->msg_iter
);
175 ctf_fs_ds_group_medops_data_reset(msg_iter_data
->msg_iter_medops_data
);
177 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_OK
;
178 } catch (const std::bad_alloc
&) {
179 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_MEMORY_ERROR
;
180 } catch (const bt2::Error
&) {
181 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_ERROR
;
185 void ctf_fs_iterator_finalize(bt_self_message_iterator
*it
)
187 ctf_fs_msg_iter_data_destroy(
188 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(it
));
191 static bt_message_iterator_class_initialize_method_status
192 ctf_msg_iter_medium_status_to_msg_iter_initialize_status(enum ctf_msg_iter_medium_status status
)
195 case CTF_MSG_ITER_MEDIUM_STATUS_EOF
:
196 case CTF_MSG_ITER_MEDIUM_STATUS_AGAIN
:
197 case CTF_MSG_ITER_MEDIUM_STATUS_ERROR
:
198 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
199 case CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
:
200 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
201 case CTF_MSG_ITER_MEDIUM_STATUS_OK
:
202 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
208 bt_message_iterator_class_initialize_method_status
209 ctf_fs_iterator_init(bt_self_message_iterator
*self_msg_iter
,
210 bt_self_message_iterator_configuration
*config
,
211 bt_self_component_port_output
*self_port
)
214 struct ctf_fs_port_data
*port_data
;
215 bt_message_iterator_class_initialize_method_status status
;
216 enum ctf_msg_iter_medium_status medium_status
;
218 port_data
= (struct ctf_fs_port_data
*) bt_self_component_port_get_data(
219 bt_self_component_port_output_as_self_component_port(self_port
));
220 BT_ASSERT(port_data
);
222 ctf_fs_msg_iter_data
*msg_iter_data
= new ctf_fs_msg_iter_data
{self_msg_iter
};
223 msg_iter_data
->ds_file_group
= port_data
->ds_file_group
;
225 medium_status
= ctf_fs_ds_group_medops_data_create(msg_iter_data
->ds_file_group
,
226 self_msg_iter
, msg_iter_data
->logger
,
227 &msg_iter_data
->msg_iter_medops_data
);
228 BT_ASSERT(medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_OK
||
229 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_ERROR
||
230 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
);
231 if (medium_status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
232 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
233 "Failed to create ctf_fs_ds_group_medops");
234 status
= ctf_msg_iter_medium_status_to_msg_iter_initialize_status(medium_status
);
238 msg_iter_data
->msg_iter
= ctf_msg_iter_create(
239 msg_iter_data
->ds_file_group
->ctf_fs_trace
->metadata
->tc
,
240 bt_common_get_page_size(static_cast<int>(msg_iter_data
->logger
.level())) * 8,
241 ctf_fs_ds_group_medops
, msg_iter_data
->msg_iter_medops_data
, self_msg_iter
,
242 msg_iter_data
->logger
);
243 if (!msg_iter_data
->msg_iter
) {
244 BT_CPPLOGE_APPEND_CAUSE_SPEC(msg_iter_data
->logger
,
245 "Cannot create a CTF message iterator.");
246 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
251 * This iterator can seek forward if its stream class has a default
254 if (msg_iter_data
->ds_file_group
->sc
->default_clock_class
) {
255 bt_self_message_iterator_configuration_set_can_seek_forward(config
, true);
258 bt_self_message_iterator_set_data(self_msg_iter
, msg_iter_data
);
259 msg_iter_data
= NULL
;
261 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
265 bt_self_message_iterator_set_data(self_msg_iter
, NULL
);
268 ctf_fs_msg_iter_data_destroy(msg_iter_data
);
270 } catch (const std::bad_alloc
&) {
271 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
272 } catch (const bt2::Error
&) {
273 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
277 static void ctf_fs_trace_destroy(struct ctf_fs_trace
*ctf_fs_trace
)
283 if (ctf_fs_trace
->ds_file_groups
) {
284 g_ptr_array_free(ctf_fs_trace
->ds_file_groups
, TRUE
);
287 BT_TRACE_PUT_REF_AND_RESET(ctf_fs_trace
->trace
);
289 if (ctf_fs_trace
->path
) {
290 g_string_free(ctf_fs_trace
->path
, TRUE
);
293 if (ctf_fs_trace
->metadata
) {
294 ctf_fs_metadata_fini(ctf_fs_trace
->metadata
);
295 delete ctf_fs_trace
->metadata
;
301 void ctf_fs_destroy(struct ctf_fs_component
*ctf_fs
)
307 ctf_fs_trace_destroy(ctf_fs
->trace
);
309 if (ctf_fs
->port_data
) {
310 g_ptr_array_free(ctf_fs
->port_data
, TRUE
);
316 void ctf_fs_component_deleter::operator()(ctf_fs_component
*comp
)
318 ctf_fs_destroy(comp
);
321 static void port_data_destroy(struct ctf_fs_port_data
*port_data
)
330 static void port_data_destroy_notifier(void *data
)
332 port_data_destroy((struct ctf_fs_port_data
*) data
);
335 static void ctf_fs_trace_destroy_notifier(void *data
)
337 struct ctf_fs_trace
*trace
= (struct ctf_fs_trace
*) data
;
338 ctf_fs_trace_destroy(trace
);
341 ctf_fs_component::UP
ctf_fs_component_create(const bt2c::Logger
& parentLogger
)
343 ctf_fs_component::UP ctf_fs
{new ctf_fs_component
{parentLogger
}};
345 ctf_fs
->port_data
= g_ptr_array_new_with_free_func(port_data_destroy_notifier
);
346 if (!ctf_fs
->port_data
) {
359 void ctf_fs_finalize(bt_self_component_source
*component
)
361 ctf_fs_destroy((struct ctf_fs_component
*) bt_self_component_get_data(
362 bt_self_component_source_as_self_component(component
)));
365 gchar
*ctf_fs_make_port_name(struct ctf_fs_ds_file_group
*ds_file_group
)
367 GString
*name
= g_string_new(NULL
);
370 * The unique port name is generated by concatenating unique identifiers
378 /* For the trace, use the uuid if present, else the path. */
379 if (ds_file_group
->ctf_fs_trace
->metadata
->tc
->is_uuid_set
) {
380 char uuid_str
[BT_UUID_STR_LEN
+ 1];
382 bt_uuid_to_str(ds_file_group
->ctf_fs_trace
->metadata
->tc
->uuid
, uuid_str
);
383 g_string_assign(name
, uuid_str
);
385 g_string_assign(name
, ds_file_group
->ctf_fs_trace
->path
->str
);
389 * For the stream class, use the id if present. We can omit this field
390 * otherwise, as there will only be a single stream class.
392 if (ds_file_group
->sc
->id
!= UINT64_C(-1)) {
393 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->sc
->id
);
396 /* For the stream, use the id if present, else, use the path. */
397 if (ds_file_group
->stream_id
!= UINT64_C(-1)) {
398 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->stream_id
);
400 BT_ASSERT(ds_file_group
->ds_file_infos
->len
== 1);
401 struct ctf_fs_ds_file_info
*ds_file_info
=
402 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
403 g_string_append_printf(name
, " | %s", ds_file_info
->path
->str
);
406 return g_string_free(name
, FALSE
);
409 static int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
410 struct ctf_fs_ds_file_group
*ds_file_group
,
411 bt_self_component_source
*self_comp_src
)
414 struct ctf_fs_port_data
*port_data
= NULL
;
417 port_name
= ctf_fs_make_port_name(ds_file_group
);
422 BT_CPPLOGI_SPEC(ctf_fs
->logger
, "Creating one port named `{}`", port_name
);
424 /* Create output port for this file */
425 port_data
= new ctf_fs_port_data
;
426 port_data
->ctf_fs
= ctf_fs
;
427 port_data
->ds_file_group
= ds_file_group
;
428 ret
= bt_self_component_source_add_output_port(self_comp_src
, port_name
, port_data
, NULL
);
433 g_ptr_array_add(ctf_fs
->port_data
, port_data
);
443 port_data_destroy(port_data
);
447 static int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
448 struct ctf_fs_trace
*ctf_fs_trace
,
449 bt_self_component_source
*self_comp_src
)
454 /* Create one output port for each stream file group */
455 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
456 struct ctf_fs_ds_file_group
*ds_file_group
=
457 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
459 ret
= create_one_port_for_trace(ctf_fs
, ds_file_group
, self_comp_src
);
461 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create output port.");
470 static void ctf_fs_ds_file_info_destroy(struct ctf_fs_ds_file_info
*ds_file_info
)
476 if (ds_file_info
->path
) {
477 g_string_free(ds_file_info
->path
, TRUE
);
483 static struct ctf_fs_ds_file_info
*ctf_fs_ds_file_info_create(const char *path
, int64_t begin_ns
)
485 ctf_fs_ds_file_info
*ds_file_info
= new ctf_fs_ds_file_info
;
486 ds_file_info
->path
= g_string_new(path
);
487 if (!ds_file_info
->path
) {
488 ctf_fs_ds_file_info_destroy(ds_file_info
);
493 ds_file_info
->begin_ns
= begin_ns
;
499 static void ctf_fs_ds_file_group_destroy(struct ctf_fs_ds_file_group
*ds_file_group
)
501 if (!ds_file_group
) {
505 if (ds_file_group
->ds_file_infos
) {
506 g_ptr_array_free(ds_file_group
->ds_file_infos
, TRUE
);
509 ctf_fs_ds_index_destroy(ds_file_group
->index
);
511 bt_stream_put_ref(ds_file_group
->stream
);
512 delete ds_file_group
;
515 static struct ctf_fs_ds_file_group
*ctf_fs_ds_file_group_create(struct ctf_fs_trace
*ctf_fs_trace
,
516 struct ctf_stream_class
*sc
,
517 uint64_t stream_instance_id
,
518 struct ctf_fs_ds_index
*index
)
520 ctf_fs_ds_file_group
*ds_file_group
= new ctf_fs_ds_file_group
;
521 ds_file_group
->ds_file_infos
=
522 g_ptr_array_new_with_free_func((GDestroyNotify
) ctf_fs_ds_file_info_destroy
);
523 if (!ds_file_group
->ds_file_infos
) {
527 ds_file_group
->index
= index
;
529 ds_file_group
->stream_id
= stream_instance_id
;
531 ds_file_group
->sc
= sc
;
532 ds_file_group
->ctf_fs_trace
= ctf_fs_trace
;
536 ctf_fs_ds_file_group_destroy(ds_file_group
);
537 ctf_fs_ds_index_destroy(index
);
538 ds_file_group
= NULL
;
541 return ds_file_group
;
544 /* Replace by g_ptr_array_insert when we depend on glib >= 2.40. */
545 static void array_insert(GPtrArray
*array
, gpointer element
, size_t pos
)
547 size_t original_array_len
= array
->len
;
549 /* Allocate an unused element at the end of the array. */
550 g_ptr_array_add(array
, NULL
);
552 /* If we are not inserting at the end, move the elements by one. */
553 if (pos
< original_array_len
) {
554 memmove(&(array
->pdata
[pos
+ 1]), &(array
->pdata
[pos
]),
555 (original_array_len
- pos
) * sizeof(gpointer
));
558 /* Insert the value. */
559 array
->pdata
[pos
] = element
;
563 * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right
564 * place to keep it sorted.
567 static void ds_file_group_insert_ds_file_info_sorted(struct ctf_fs_ds_file_group
*ds_file_group
,
568 struct ctf_fs_ds_file_info
*ds_file_info
)
572 /* Find the spot where to insert this ds_file_info. */
573 for (i
= 0; i
< ds_file_group
->ds_file_infos
->len
; i
++) {
574 struct ctf_fs_ds_file_info
*other_ds_file_info
=
575 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, i
);
577 if (ds_file_info
->begin_ns
< other_ds_file_info
->begin_ns
) {
582 array_insert(ds_file_group
->ds_file_infos
, ds_file_info
, i
);
585 static bool ds_index_entries_equal(const struct ctf_fs_ds_index_entry
*left
,
586 const struct ctf_fs_ds_index_entry
*right
)
588 if (left
->packet_size
!= right
->packet_size
) {
592 if (left
->timestamp_begin
!= right
->timestamp_begin
) {
596 if (left
->timestamp_end
!= right
->timestamp_end
) {
600 if (left
->packet_seq_num
!= right
->packet_seq_num
) {
608 * Insert `entry` into `index`, without duplication.
610 * The entry is inserted only if there isn't an identical entry already.
612 * In any case, the ownership of `entry` is transferred to this function. So if
613 * the entry is not inserted, it is freed.
616 static void ds_index_insert_ds_index_entry_sorted(struct ctf_fs_ds_index
*index
,
617 struct ctf_fs_ds_index_entry
*entry
)
620 struct ctf_fs_ds_index_entry
*other_entry
= NULL
;
622 /* Find the spot where to insert this index entry. */
623 for (i
= 0; i
< index
->entries
->len
; i
++) {
624 other_entry
= (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, i
);
626 if (entry
->timestamp_begin_ns
<= other_entry
->timestamp_begin_ns
) {
632 * Insert the entry only if a duplicate doesn't already exist.
634 * There can be duplicate packets if reading multiple overlapping
635 * snapshots of the same trace. We then want the index to contain
636 * a reference to only one copy of that packet.
638 if (i
== index
->entries
->len
|| !ds_index_entries_equal(entry
, other_entry
)) {
639 array_insert(index
->entries
, entry
, i
);
645 static void merge_ctf_fs_ds_indexes(struct ctf_fs_ds_index
*dest
, struct ctf_fs_ds_index
*src
)
649 for (i
= 0; i
< src
->entries
->len
; i
++) {
650 struct ctf_fs_ds_index_entry
*entry
=
651 (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(src
->entries
, i
);
654 * Ownership of the ctf_fs_ds_index_entry is transferred to
655 * ds_index_insert_ds_index_entry_sorted.
657 g_ptr_array_index(src
->entries
, i
) = NULL
;
658 ds_index_insert_ds_index_entry_sorted(dest
, entry
);
662 static int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
, const char *path
)
664 int64_t stream_instance_id
= -1;
665 int64_t begin_ns
= -1;
666 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
667 bool add_group
= false;
670 struct ctf_fs_ds_file
*ds_file
= NULL
;
671 struct ctf_fs_ds_file_info
*ds_file_info
= NULL
;
672 struct ctf_fs_ds_index
*index
= NULL
;
673 struct ctf_msg_iter
*msg_iter
= NULL
;
674 struct ctf_stream_class
*sc
= NULL
;
675 struct ctf_msg_iter_packet_properties props
;
678 * Create a temporary ds_file to read some properties about the data
681 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, path
, ctf_fs_trace
->logger
);
686 /* Create a temporary iterator to read the ds_file. */
687 msg_iter
= ctf_msg_iter_create(
688 ctf_fs_trace
->metadata
->tc
,
689 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
690 ctf_fs_ds_file_medops
, ds_file
, nullptr, ctf_fs_trace
->logger
);
692 BT_CPPLOGE_STR_SPEC(ctf_fs_trace
->logger
, "Cannot create a CTF message iterator.");
696 ctf_msg_iter_set_dry_run(msg_iter
, true);
698 ret
= ctf_msg_iter_get_packet_properties(msg_iter
, &props
);
700 BT_CPPLOGE_APPEND_CAUSE_SPEC(
701 ctf_fs_trace
->logger
,
702 "Cannot get stream file's first packet's header and context fields (`{}`).", path
);
706 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
, props
.stream_class_id
);
708 stream_instance_id
= props
.data_stream_id
;
710 if (props
.snapshots
.beginning_clock
!= UINT64_C(-1)) {
711 BT_ASSERT(sc
->default_clock_class
);
712 ret
= bt_util_clock_cycles_to_ns_from_origin(
713 props
.snapshots
.beginning_clock
, sc
->default_clock_class
->frequency
,
714 sc
->default_clock_class
->offset_seconds
, sc
->default_clock_class
->offset_cycles
,
717 BT_CPPLOGE_APPEND_CAUSE_SPEC(
718 ctf_fs_trace
->logger
,
719 "Cannot convert clock cycles to nanoseconds from origin (`{}`).", path
);
724 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
);
729 index
= ctf_fs_ds_file_build_index(ds_file
, ds_file_info
, msg_iter
);
731 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to index CTF stream file \'{}\'",
732 ds_file
->file
->path
->str
);
736 if (begin_ns
== -1) {
738 * No beginning timestamp to sort the stream files
739 * within a stream file group, so consider that this
740 * file must be the only one within its group.
742 stream_instance_id
= -1;
745 if (stream_instance_id
== -1) {
747 * No stream instance ID or no beginning timestamp:
748 * create a unique stream file group for this stream
749 * file because, even if there's a stream instance ID,
750 * there's no timestamp to order the file within its
753 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, UINT64_C(-1), index
);
754 /* Ownership of index is transferred. */
757 if (!ds_file_group
) {
761 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, BT_MOVE_REF(ds_file_info
));
767 BT_ASSERT(stream_instance_id
!= -1);
768 BT_ASSERT(begin_ns
!= -1);
770 /* Find an existing stream file group with this ID */
771 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
773 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
775 if (ds_file_group
->sc
== sc
&& ds_file_group
->stream_id
== stream_instance_id
) {
779 ds_file_group
= NULL
;
782 if (!ds_file_group
) {
783 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, stream_instance_id
, index
);
784 /* Ownership of index is transferred. */
786 if (!ds_file_group
) {
792 merge_ctf_fs_ds_indexes(ds_file_group
->index
, index
);
795 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, BT_MOVE_REF(ds_file_info
));
800 ctf_fs_ds_file_group_destroy(ds_file_group
);
801 ds_file_group
= NULL
;
805 if (add_group
&& ds_file_group
) {
806 g_ptr_array_add(ctf_fs_trace
->ds_file_groups
, ds_file_group
);
809 ctf_fs_ds_file_destroy(ds_file
);
810 ctf_fs_ds_file_info_destroy(ds_file_info
);
813 ctf_msg_iter_destroy(msg_iter
);
816 ctf_fs_ds_index_destroy(index
);
820 static int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
823 const char *basename
;
824 GError
*error
= NULL
;
827 /* Check each file in the path directory, except specific ones */
828 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
830 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
831 "Cannot open directory `{}`: {} (code {})",
832 ctf_fs_trace
->path
->str
, error
->message
, error
->code
);
836 while ((basename
= g_dir_read_name(dir
))) {
837 struct ctf_fs_file
*file
;
839 if (strcmp(basename
, CTF_FS_METADATA_FILENAME
) == 0) {
840 /* Ignore the metadata stream. */
841 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
842 "Ignoring metadata file `{}" G_DIR_SEPARATOR_S
"{}`",
843 ctf_fs_trace
->path
->str
, basename
);
847 if (basename
[0] == '.') {
848 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
,
849 "Ignoring hidden file `{}" G_DIR_SEPARATOR_S
"{}`",
850 ctf_fs_trace
->path
->str
, basename
);
854 /* Create the file. */
855 file
= ctf_fs_file_create(ctf_fs_trace
->logger
);
857 BT_CPPLOGE_APPEND_CAUSE_SPEC(
858 ctf_fs_trace
->logger
,
859 "Cannot create stream file object for file `{}" G_DIR_SEPARATOR_S
"{}`",
860 ctf_fs_trace
->path
->str
, basename
);
864 /* Create full path string. */
865 g_string_append_printf(file
->path
, "%s" G_DIR_SEPARATOR_S
"%s", ctf_fs_trace
->path
->str
,
867 if (!g_file_test(file
->path
->str
, G_FILE_TEST_IS_REGULAR
)) {
868 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring non-regular file `{}`",
870 ctf_fs_file_destroy(file
);
875 ret
= ctf_fs_file_open(file
, "rb");
877 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Cannot open stream file `{}`",
882 if (file
->size
== 0) {
883 /* Skip empty stream. */
884 BT_CPPLOGI_SPEC(ctf_fs_trace
->logger
, "Ignoring empty file `{}`", file
->path
->str
);
885 ctf_fs_file_destroy(file
);
889 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
, file
->path
->str
);
891 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
892 "Cannot add stream file `{}` to stream file group",
894 ctf_fs_file_destroy(file
);
898 ctf_fs_file_destroy(file
);
919 static int set_trace_name(bt_trace
*trace
, const char *name_suffix
, const bt2c::Logger
& logger
)
925 name
= g_string_new(NULL
);
927 BT_CPPLOGE_STR_SPEC(logger
, "Failed to allocate a GString.");
933 * Check if we have a trace environment string value named `hostname`.
934 * If so, use it as the trace name's prefix.
936 val
= bt_trace_borrow_environment_entry_value_by_name_const(trace
, "hostname");
937 if (val
&& bt_value_is_string(val
)) {
938 g_string_append(name
, bt_value_string_get(val
));
941 g_string_append_c(name
, G_DIR_SEPARATOR
);
946 g_string_append(name
, name_suffix
);
949 ret
= bt_trace_set_name(trace
, name
->str
);
958 g_string_free(name
, TRUE
);
964 static struct ctf_fs_trace
*ctf_fs_trace_create(const char *path
, const char *name
,
965 struct ctf_fs_metadata_config
*metadata_config
,
966 bt_self_component
*selfComp
,
967 const bt2c::Logger
& parentLogger
)
971 ctf_fs_trace
*ctf_fs_trace
= new struct ctf_fs_trace(parentLogger
);
972 ctf_fs_trace
->path
= g_string_new(path
);
973 if (!ctf_fs_trace
->path
) {
977 ctf_fs_trace
->metadata
= new ctf_fs_metadata
;
978 ctf_fs_metadata_init(ctf_fs_trace
->metadata
);
979 ctf_fs_trace
->ds_file_groups
=
980 g_ptr_array_new_with_free_func((GDestroyNotify
) ctf_fs_ds_file_group_destroy
);
981 if (!ctf_fs_trace
->ds_file_groups
) {
985 ret
= ctf_fs_metadata_set_trace_class(selfComp
, ctf_fs_trace
, metadata_config
);
990 if (ctf_fs_trace
->metadata
->trace_class
) {
991 ctf_fs_trace
->trace
= bt_trace_create(ctf_fs_trace
->metadata
->trace_class
);
992 if (!ctf_fs_trace
->trace
) {
997 if (ctf_fs_trace
->trace
) {
998 ret
= ctf_trace_class_configure_ir_trace(ctf_fs_trace
->metadata
->tc
, ctf_fs_trace
->trace
);
1003 ret
= set_trace_name(ctf_fs_trace
->trace
, name
, ctf_fs_trace
->logger
);
1009 ret
= create_ds_file_groups(ctf_fs_trace
);
1017 ctf_fs_trace_destroy(ctf_fs_trace
);
1018 ctf_fs_trace
= NULL
;
1021 return ctf_fs_trace
;
1024 static int path_is_ctf_trace(const char *path
)
1026 GString
*metadata_path
= g_string_new(NULL
);
1029 if (!metadata_path
) {
1034 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
1036 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
1042 g_string_free(metadata_path
, TRUE
);
1046 /* Helper for ctf_fs_component_create_ctf_fs_trace, to handle a single path. */
1048 static int ctf_fs_component_create_ctf_fs_trace_one_path(struct ctf_fs_component
*ctf_fs
,
1049 const char *path_param
,
1050 const char *trace_name
, GPtrArray
*traces
,
1051 bt_self_component
*selfComp
)
1053 struct ctf_fs_trace
*ctf_fs_trace
;
1057 norm_path
= bt_common_normalize_path(path_param
, NULL
);
1059 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to normalize path: `{}`.", path_param
);
1063 ret
= path_is_ctf_trace(norm_path
->str
);
1065 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1066 ctf_fs
->logger
, "Failed to check if path is a CTF trace: path={}", norm_path
->str
);
1068 } else if (ret
== 0) {
1069 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1070 ctf_fs
->logger
, "Path is not a CTF trace (does not contain a metadata file): `{}`.",
1075 // FIXME: Remove or ifdef for __MINGW32__
1076 if (strcmp(norm_path
->str
, "/") == 0) {
1077 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Opening a trace in `/` is not supported.");
1082 ctf_fs_trace
= ctf_fs_trace_create(norm_path
->str
, trace_name
, &ctf_fs
->metadata_config
,
1083 selfComp
, ctf_fs
->logger
);
1084 if (!ctf_fs_trace
) {
1085 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Cannot create trace for `{}`.",
1090 g_ptr_array_add(traces
, ctf_fs_trace
);
1091 ctf_fs_trace
= NULL
;
1101 g_string_free(norm_path
, TRUE
);
1108 * Count the number of stream and event classes defined by this trace's metadata.
1110 * This is used to determine which metadata is the "latest", out of multiple
1111 * traces sharing the same UUID. It is assumed that amongst all these metadatas,
1112 * a bigger metadata is a superset of a smaller metadata. Therefore, it is
1113 * enough to just count the classes.
1116 static unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace
*trace
)
1118 unsigned int num
= trace
->metadata
->tc
->stream_classes
->len
;
1121 for (i
= 0; i
< trace
->metadata
->tc
->stream_classes
->len
; i
++) {
1122 struct ctf_stream_class
*sc
=
1123 (struct ctf_stream_class
*) trace
->metadata
->tc
->stream_classes
->pdata
[i
];
1124 num
+= sc
->event_classes
->len
;
1131 * Merge the src ds_file_group into dest. This consists of merging their
1132 * ds_file_infos, making sure to keep the result sorted.
1135 static void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group
*dest
,
1136 struct ctf_fs_ds_file_group
*src
)
1140 for (i
= 0; i
< src
->ds_file_infos
->len
; i
++) {
1141 struct ctf_fs_ds_file_info
*ds_file_info
=
1142 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(src
->ds_file_infos
, i
);
1144 /* Ownership of the ds_file_info is transferred to dest. */
1145 g_ptr_array_index(src
->ds_file_infos
, i
) = NULL
;
1147 ds_file_group_insert_ds_file_info_sorted(dest
, ds_file_info
);
1150 /* Merge both indexes. */
1151 merge_ctf_fs_ds_indexes(dest
->index
, src
->index
);
1153 /* Merge src_trace's data stream file groups into dest_trace's. */
1155 static int merge_matching_ctf_fs_ds_file_groups(struct ctf_fs_trace
*dest_trace
,
1156 struct ctf_fs_trace
*src_trace
)
1158 GPtrArray
*dest
= dest_trace
->ds_file_groups
;
1159 GPtrArray
*src
= src_trace
->ds_file_groups
;
1164 * Save the initial length of dest: we only want to check against the
1165 * original elements in the inner loop.
1167 const guint dest_len
= dest
->len
;
1169 for (s_i
= 0; s_i
< src
->len
; s_i
++) {
1170 struct ctf_fs_ds_file_group
*src_group
=
1171 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(src
, s_i
);
1172 struct ctf_fs_ds_file_group
*dest_group
= NULL
;
1174 /* A stream instance without ID can't match a stream in the other trace. */
1175 if (src_group
->stream_id
!= -1) {
1178 /* Let's search for a matching ds_file_group in the destination. */
1179 for (d_i
= 0; d_i
< dest_len
; d_i
++) {
1180 struct ctf_fs_ds_file_group
*candidate_dest
=
1181 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(dest
, d_i
);
1183 /* Can't match a stream instance without ID. */
1184 if (candidate_dest
->stream_id
== -1) {
1189 * If the two groups have the same stream instance id
1190 * and belong to the same stream class (stream instance
1191 * ids are per-stream class), they represent the same
1194 if (candidate_dest
->stream_id
!= src_group
->stream_id
||
1195 candidate_dest
->sc
->id
!= src_group
->sc
->id
) {
1199 dest_group
= candidate_dest
;
1205 * Didn't find a friend in dest to merge our src_group into?
1206 * Create a new empty one. This can happen if a stream was
1207 * active in the source trace chunk but not in the destination
1211 struct ctf_stream_class
*sc
;
1212 struct ctf_fs_ds_index
*index
;
1214 sc
= ctf_trace_class_borrow_stream_class_by_id(dest_trace
->metadata
->tc
,
1218 index
= ctf_fs_ds_index_create(dest_trace
->logger
);
1224 dest_group
= ctf_fs_ds_file_group_create(dest_trace
, sc
, src_group
->stream_id
, index
);
1225 /* Ownership of index is transferred. */
1232 g_ptr_array_add(dest_trace
->ds_file_groups
, dest_group
);
1235 BT_ASSERT(dest_group
);
1236 merge_ctf_fs_ds_file_groups(dest_group
, src_group
);
1244 * Collapse the given traces, which must all share the same UUID, in a single
1247 * The trace with the most expansive metadata is chosen and all other traces
1248 * are merged into that one. The array slots of all the traces that get merged
1249 * in the chosen one are set to NULL, so only the slot of the chosen trace
1253 static int merge_ctf_fs_traces(struct ctf_fs_trace
**traces
, unsigned int num_traces
,
1254 struct ctf_fs_trace
**out_trace
)
1256 unsigned int winner_count
;
1257 struct ctf_fs_trace
*winner
;
1261 BT_ASSERT(num_traces
>= 2);
1263 winner_count
= metadata_count_stream_and_event_classes(traces
[0]);
1267 /* Find the trace with the largest metadata. */
1268 for (i
= 1; i
< num_traces
; i
++) {
1269 struct ctf_fs_trace
*candidate
;
1270 unsigned int candidate_count
;
1272 candidate
= traces
[i
];
1274 /* A bit of sanity check. */
1275 BT_ASSERT(bt_uuid_compare(winner
->metadata
->tc
->uuid
, candidate
->metadata
->tc
->uuid
) == 0);
1277 candidate_count
= metadata_count_stream_and_event_classes(candidate
);
1279 if (candidate_count
> winner_count
) {
1280 winner_count
= candidate_count
;
1286 /* Merge all the other traces in the winning trace. */
1287 for (i
= 0; i
< num_traces
; i
++) {
1288 struct ctf_fs_trace
*trace
= traces
[i
];
1290 /* Don't merge the winner into itself. */
1291 if (trace
== winner
) {
1295 /* Merge trace's data stream file groups into winner's. */
1296 ret
= merge_matching_ctf_fs_ds_file_groups(winner
, trace
);
1303 * Move the winner out of the array, into `*out_trace`.
1305 *out_trace
= winner
;
1306 traces
[winner_i
] = NULL
;
1318 static int decode_clock_snapshot_after_event(struct ctf_fs_trace
*ctf_fs_trace
,
1319 struct ctf_clock_class
*default_cc
,
1320 struct ctf_fs_ds_index_entry
*index_entry
,
1321 enum target_event target_event
, uint64_t *cs
,
1324 enum ctf_msg_iter_status iter_status
= CTF_MSG_ITER_STATUS_OK
;
1325 struct ctf_fs_ds_file
*ds_file
= NULL
;
1326 struct ctf_msg_iter
*msg_iter
= NULL
;
1329 BT_ASSERT(ctf_fs_trace
);
1330 BT_ASSERT(index_entry
);
1331 BT_ASSERT(index_entry
->path
);
1333 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, index_entry
->path
, ctf_fs_trace
->logger
);
1335 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
, "Failed to create a ctf_fs_ds_file");
1340 BT_ASSERT(ctf_fs_trace
->metadata
);
1341 BT_ASSERT(ctf_fs_trace
->metadata
->tc
);
1343 msg_iter
= ctf_msg_iter_create(
1344 ctf_fs_trace
->metadata
->tc
,
1345 bt_common_get_page_size(static_cast<int>(ctf_fs_trace
->logger
.level())) * 8,
1346 ctf_fs_ds_file_medops
, ds_file
, NULL
, ctf_fs_trace
->logger
);
1348 /* ctf_msg_iter_create() logs errors. */
1354 * Turn on dry run mode to prevent the creation and usage of Babeltrace
1355 * library objects (bt_field, bt_message_*, etc.).
1357 ctf_msg_iter_set_dry_run(msg_iter
, true);
1359 /* Seek to the beginning of the target packet. */
1360 iter_status
= ctf_msg_iter_seek(msg_iter
, index_entry
->offset
);
1362 /* ctf_msg_iter_seek() logs errors. */
1367 switch (target_event
) {
1370 * Start to decode the packet until we reach the end of
1371 * the first event. To extract the first event's clock
1374 iter_status
= ctf_msg_iter_curr_packet_first_event_clock_snapshot(msg_iter
, cs
);
1377 /* Decode the packet to extract the last event's clock snapshot. */
1378 iter_status
= ctf_msg_iter_curr_packet_last_event_clock_snapshot(msg_iter
, cs
);
1388 /* Convert clock snapshot to timestamp. */
1389 ret
= bt_util_clock_cycles_to_ns_from_origin(
1390 *cs
, default_cc
->frequency
, default_cc
->offset_seconds
, default_cc
->offset_cycles
, ts_ns
);
1392 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
1393 "Failed to convert clock snapshot to timestamp");
1399 ctf_fs_ds_file_destroy(ds_file
);
1402 ctf_msg_iter_destroy(msg_iter
);
1408 static int decode_packet_first_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1409 struct ctf_clock_class
*default_cc
,
1410 struct ctf_fs_ds_index_entry
*index_entry
,
1411 uint64_t *cs
, int64_t *ts_ns
)
1413 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, FIRST_EVENT
, cs
,
1417 static int decode_packet_last_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1418 struct ctf_clock_class
*default_cc
,
1419 struct ctf_fs_ds_index_entry
*index_entry
,
1420 uint64_t *cs
, int64_t *ts_ns
)
1422 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, LAST_EVENT
, cs
,
1427 * Fix up packet index entries for lttng's "event-after-packet" bug.
1428 * Some buggy lttng tracer versions may emit events with a timestamp that is
1429 * larger (after) than the timestamp_end of the their packets.
1431 * To fix up this erroneous data we do the following:
1432 * 1. If it's not the stream file's last packet: set the packet index entry's
1433 * end time to the next packet's beginning time.
1434 * 2. If it's the stream file's last packet, set the packet index entry's end
1435 * time to the packet's last event's time, if any, or to the packet's
1436 * beginning time otherwise.
1438 * Known buggy tracer versions:
1439 * - before lttng-ust 2.11.0
1440 * - before lttng-module 2.11.0
1441 * - before lttng-module 2.10.10
1442 * - before lttng-module 2.9.13
1444 static int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace
*trace
)
1447 guint ds_file_group_i
;
1448 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1450 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
; ds_file_group_i
++) {
1452 struct ctf_clock_class
*default_cc
;
1453 struct ctf_fs_ds_index_entry
*last_entry
;
1454 struct ctf_fs_ds_index
*index
;
1456 struct ctf_fs_ds_file_group
*ds_file_group
=
1457 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1459 BT_ASSERT(ds_file_group
);
1460 index
= ds_file_group
->index
;
1463 BT_ASSERT(index
->entries
);
1464 BT_ASSERT(index
->entries
->len
> 0);
1467 * Iterate over all entries but the last one. The last one is
1468 * fixed differently after.
1470 for (entry_i
= 0; entry_i
< index
->entries
->len
- 1; entry_i
++) {
1471 struct ctf_fs_ds_index_entry
*curr_entry
, *next_entry
;
1473 curr_entry
= (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
);
1474 next_entry
= (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
+ 1);
1477 * 1. Set the current index entry `end` timestamp to
1478 * the next index entry `begin` timestamp.
1480 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1481 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1485 * 2. Fix the last entry by decoding the last event of the last
1489 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, index
->entries
->len
- 1);
1490 BT_ASSERT(last_entry
);
1492 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1493 default_cc
= ds_file_group
->sc
->default_clock_class
;
1496 * Decode packet to read the timestamp of the last event of the
1499 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1500 &last_entry
->timestamp_end
,
1501 &last_entry
->timestamp_end_ns
);
1503 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1505 "Failed to decode stream's last packet to get its last event's clock snapshot.");
1515 * Fix up packet index entries for barectf's "event-before-packet" bug.
1516 * Some buggy barectf tracer versions may emit events with a timestamp that is
1517 * less than the timestamp_begin of the their packets.
1519 * To fix up this erroneous data we do the following:
1520 * 1. Starting at the second index entry, set the timestamp_begin of the
1521 * current entry to the timestamp of the first event of the packet.
1522 * 2. Set the previous entry's timestamp_end to the timestamp_begin of the
1525 * Known buggy tracer versions:
1526 * - before barectf 2.3.1
1528 static int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace
*trace
)
1531 guint ds_file_group_i
;
1532 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1534 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
; ds_file_group_i
++) {
1536 struct ctf_clock_class
*default_cc
;
1537 ctf_fs_ds_file_group
*ds_file_group
=
1538 (ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1540 struct ctf_fs_ds_index
*index
= ds_file_group
->index
;
1543 BT_ASSERT(index
->entries
);
1544 BT_ASSERT(index
->entries
->len
> 0);
1546 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1547 default_cc
= ds_file_group
->sc
->default_clock_class
;
1550 * 1. Iterate over the index, starting from the second entry
1553 for (entry_i
= 1; entry_i
< index
->entries
->len
; entry_i
++) {
1554 ctf_fs_ds_index_entry
*prev_entry
=
1555 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
- 1);
1556 ctf_fs_ds_index_entry
*curr_entry
=
1557 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
);
1559 * 2. Set the current entry `begin` timestamp to the
1560 * timestamp of the first event of the current packet.
1562 ret
= decode_packet_first_event_timestamp(trace
, default_cc
, curr_entry
,
1563 &curr_entry
->timestamp_begin
,
1564 &curr_entry
->timestamp_begin_ns
);
1566 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1567 "Failed to decode first event's clock snapshot");
1572 * 3. Set the previous entry `end` timestamp to the
1573 * timestamp of the first event of the current packet.
1575 prev_entry
->timestamp_end
= curr_entry
->timestamp_begin
;
1576 prev_entry
->timestamp_end_ns
= curr_entry
->timestamp_begin_ns
;
1584 * When using the lttng-crash feature it's likely that the last packets of each
1585 * stream have their timestamp_end set to zero. This is caused by the fact that
1586 * the tracer crashed and was not able to properly close the packets.
1588 * To fix up this erroneous data we do the following:
1589 * For each index entry, if the entry's timestamp_end is 0 and the
1590 * timestamp_begin is not 0:
1591 * - If it's the stream file's last packet: set the packet index entry's end
1592 * time to the packet's last event's time, if any, or to the packet's
1593 * beginning time otherwise.
1594 * - If it's not the stream file's last packet: set the packet index
1595 * entry's end time to the next packet's beginning time.
1597 * Affected versions:
1598 * - All current and future lttng-ust and lttng-modules versions.
1600 static int fix_index_lttng_crash_quirk(struct ctf_fs_trace
*trace
)
1603 guint ds_file_group_idx
;
1604 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1606 for (ds_file_group_idx
= 0; ds_file_group_idx
< ds_file_groups
->len
; ds_file_group_idx
++) {
1608 struct ctf_clock_class
*default_cc
;
1609 struct ctf_fs_ds_index
*index
;
1611 ctf_fs_ds_file_group
*ds_file_group
=
1612 (ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_idx
);
1614 BT_ASSERT(ds_file_group
);
1615 index
= ds_file_group
->index
;
1617 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1618 default_cc
= ds_file_group
->sc
->default_clock_class
;
1621 BT_ASSERT(index
->entries
);
1622 BT_ASSERT(index
->entries
->len
> 0);
1624 ctf_fs_ds_index_entry
*last_entry
=
1625 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, index
->entries
->len
- 1);
1626 BT_ASSERT(last_entry
);
1628 /* 1. Fix the last entry first. */
1629 if (last_entry
->timestamp_end
== 0 && last_entry
->timestamp_begin
!= 0) {
1631 * Decode packet to read the timestamp of the
1632 * last event of the stream file.
1634 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1635 &last_entry
->timestamp_end
,
1636 &last_entry
->timestamp_end_ns
);
1638 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1639 "Failed to decode last event's clock snapshot");
1644 /* Iterate over all entries but the last one. */
1645 for (entry_idx
= 0; entry_idx
< index
->entries
->len
- 1; entry_idx
++) {
1646 ctf_fs_ds_index_entry
*curr_entry
=
1647 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_idx
);
1648 ctf_fs_ds_index_entry
*next_entry
=
1649 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_idx
+ 1);
1651 if (curr_entry
->timestamp_end
== 0 && curr_entry
->timestamp_begin
!= 0) {
1653 * 2. Set the current index entry `end` timestamp to
1654 * the next index entry `begin` timestamp.
1656 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1657 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1667 * Extract the tracer information necessary to compare versions.
1668 * Returns 0 on success, and -1 if the extraction is not successful because the
1669 * necessary fields are absents in the trace metadata.
1671 static int extract_tracer_info(struct ctf_fs_trace
*trace
, struct tracer_info
*current_tracer_info
)
1674 struct ctf_trace_class_env_entry
*entry
;
1676 /* Clear the current_tracer_info struct */
1677 memset(current_tracer_info
, 0, sizeof(*current_tracer_info
));
1680 * To compare 2 tracer versions, at least the tracer name and it's
1681 * major version are needed. If one of these is missing, consider it an
1682 * extraction failure.
1684 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_name");
1685 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR
) {
1686 goto missing_bare_minimum
;
1689 /* Set tracer name. */
1690 current_tracer_info
->name
= entry
->value
.str
->str
;
1692 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_major");
1693 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1694 goto missing_bare_minimum
;
1697 /* Set major version number. */
1698 current_tracer_info
->major
= entry
->value
.i
;
1700 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_minor");
1701 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1705 /* Set minor version number. */
1706 current_tracer_info
->minor
= entry
->value
.i
;
1708 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patch");
1711 * If `tracer_patch` doesn't exist `tracer_patchlevel` might.
1712 * For example, `lttng-modules` uses entry name
1713 * `tracer_patchlevel`.
1715 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patchlevel");
1718 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1722 /* Set patch version number. */
1723 current_tracer_info
->patch
= entry
->value
.i
;
1727 missing_bare_minimum
:
1733 static bool is_tracer_affected_by_lttng_event_after_packet_bug(struct tracer_info
*curr_tracer_info
)
1735 bool is_affected
= false;
1737 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1738 if (curr_tracer_info
->major
< 2) {
1740 } else if (curr_tracer_info
->major
== 2) {
1741 /* fixed in lttng-ust 2.11.0 */
1742 if (curr_tracer_info
->minor
< 11) {
1746 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1747 if (curr_tracer_info
->major
< 2) {
1749 } else if (curr_tracer_info
->major
== 2) {
1750 /* fixed in lttng-modules 2.11.0 */
1751 if (curr_tracer_info
->minor
== 10) {
1752 /* fixed in lttng-modules 2.10.10 */
1753 if (curr_tracer_info
->patch
< 10) {
1756 } else if (curr_tracer_info
->minor
== 9) {
1757 /* fixed in lttng-modules 2.9.13 */
1758 if (curr_tracer_info
->patch
< 13) {
1761 } else if (curr_tracer_info
->minor
< 9) {
1771 is_tracer_affected_by_barectf_event_before_packet_bug(struct tracer_info
*curr_tracer_info
)
1773 bool is_affected
= false;
1775 if (strcmp(curr_tracer_info
->name
, "barectf") == 0) {
1776 if (curr_tracer_info
->major
< 2) {
1778 } else if (curr_tracer_info
->major
== 2) {
1779 if (curr_tracer_info
->minor
< 3) {
1781 } else if (curr_tracer_info
->minor
== 3) {
1782 /* fixed in barectf 2.3.1 */
1783 if (curr_tracer_info
->patch
< 1) {
1793 static bool is_tracer_affected_by_lttng_crash_quirk(struct tracer_info
*curr_tracer_info
)
1795 bool is_affected
= false;
1797 /* All LTTng tracer may be affected by this lttng crash quirk. */
1798 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1800 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1808 * Looks for trace produced by known buggy tracers and fix up the index
1811 static int fix_packet_index_tracer_bugs(ctf_fs_trace
*trace
)
1814 struct tracer_info current_tracer_info
;
1816 ret
= extract_tracer_info(trace
, ¤t_tracer_info
);
1819 * A trace may not have all the necessary environment
1820 * entries to do the tracer version comparison.
1821 * At least, the tracer name and major version number
1822 * are needed. Failing to extract these entries is not
1826 BT_CPPLOGI_STR_SPEC(
1828 "Cannot extract tracer information necessary to compare with buggy versions.");
1832 /* Check if the trace may be affected by old tracer bugs. */
1833 if (is_tracer_affected_by_lttng_event_after_packet_bug(¤t_tracer_info
)) {
1834 BT_CPPLOGI_STR_SPEC(
1836 "Trace may be affected by LTTng tracer packet timestamp bug. Fixing up.");
1837 ret
= fix_index_lttng_event_after_packet_bug(trace
);
1839 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1840 "Failed to fix LTTng event-after-packet bug.");
1843 trace
->metadata
->tc
->quirks
.lttng_event_after_packet
= true;
1846 if (is_tracer_affected_by_barectf_event_before_packet_bug(¤t_tracer_info
)) {
1847 BT_CPPLOGI_STR_SPEC(
1849 "Trace may be affected by barectf tracer packet timestamp bug. Fixing up.");
1850 ret
= fix_index_barectf_event_before_packet_bug(trace
);
1852 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1853 "Failed to fix barectf event-before-packet bug.");
1856 trace
->metadata
->tc
->quirks
.barectf_event_before_packet
= true;
1859 if (is_tracer_affected_by_lttng_crash_quirk(¤t_tracer_info
)) {
1860 ret
= fix_index_lttng_crash_quirk(trace
);
1862 BT_CPPLOGE_APPEND_CAUSE_SPEC(trace
->logger
,
1863 "Failed to fix lttng-crash timestamp quirks.");
1866 trace
->metadata
->tc
->quirks
.lttng_crash
= true;
1873 static gint
compare_ds_file_groups_by_first_path(gconstpointer a
, gconstpointer b
)
1875 ctf_fs_ds_file_group
* const *ds_file_group_a
= (ctf_fs_ds_file_group
**) a
;
1876 ctf_fs_ds_file_group
* const *ds_file_group_b
= (ctf_fs_ds_file_group
**) b
;
1878 BT_ASSERT((*ds_file_group_a
)->ds_file_infos
->len
> 0);
1879 BT_ASSERT((*ds_file_group_b
)->ds_file_infos
->len
> 0);
1881 const ctf_fs_ds_file_info
*first_ds_file_info_a
=
1882 (const ctf_fs_ds_file_info
*) (*ds_file_group_a
)->ds_file_infos
->pdata
[0];
1883 const ctf_fs_ds_file_info
*first_ds_file_info_b
=
1884 (const ctf_fs_ds_file_info
*) (*ds_file_group_b
)->ds_file_infos
->pdata
[0];
1886 return strcmp(first_ds_file_info_a
->path
->str
, first_ds_file_info_b
->path
->str
);
1889 static gint
compare_strings(gconstpointer p_a
, gconstpointer p_b
)
1891 const char *a
= *((const char **) p_a
);
1892 const char *b
= *((const char **) p_b
);
1894 return strcmp(a
, b
);
1897 int ctf_fs_component_create_ctf_fs_trace(struct ctf_fs_component
*ctf_fs
,
1898 const bt_value
*paths_value
,
1899 const bt_value
*trace_name_value
,
1900 bt_self_component
*selfComp
)
1904 GPtrArray
*paths
= NULL
;
1906 const char *trace_name
;
1908 BT_ASSERT(bt_value_get_type(paths_value
) == BT_VALUE_TYPE_ARRAY
);
1909 BT_ASSERT(!bt_value_array_is_empty(paths_value
));
1911 traces
= g_ptr_array_new_with_free_func(ctf_fs_trace_destroy_notifier
);
1913 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to allocate a GPtrArray.");
1917 paths
= g_ptr_array_new_with_free_func(g_free
);
1919 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to allocate a GPtrArray.");
1923 trace_name
= trace_name_value
? bt_value_string_get(trace_name_value
) : NULL
;
1926 * Create a sorted array of the paths, to make the execution of this
1927 * component deterministic.
1929 for (i
= 0; i
< bt_value_array_get_length(paths_value
); i
++) {
1930 const bt_value
*path_value
= bt_value_array_borrow_element_by_index_const(paths_value
, i
);
1931 const char *input
= bt_value_string_get(path_value
);
1934 input_copy
= g_strdup(input
);
1936 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to copy a string.");
1940 g_ptr_array_add(paths
, input_copy
);
1943 g_ptr_array_sort(paths
, compare_strings
);
1945 /* Create a separate ctf_fs_trace object for each path. */
1946 for (i
= 0; i
< paths
->len
; i
++) {
1947 const char *path
= (const char *) g_ptr_array_index(paths
, i
);
1949 ret
= ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs
, path
, trace_name
, traces
,
1956 if (traces
->len
> 1) {
1957 struct ctf_fs_trace
*first_trace
= (struct ctf_fs_trace
*) traces
->pdata
[0];
1958 const uint8_t *first_trace_uuid
= first_trace
->metadata
->tc
->uuid
;
1959 struct ctf_fs_trace
*trace
;
1962 * We have more than one trace, they must all share the same
1963 * UUID, verify that.
1965 for (i
= 0; i
< traces
->len
; i
++) {
1966 struct ctf_fs_trace
*this_trace
= (struct ctf_fs_trace
*) traces
->pdata
[i
];
1967 const uint8_t *this_trace_uuid
= this_trace
->metadata
->tc
->uuid
;
1969 if (!this_trace
->metadata
->tc
->is_uuid_set
) {
1970 BT_CPPLOGE_APPEND_CAUSE_SPEC(
1972 "Multiple traces given, but a trace does not have a UUID: path={}",
1973 this_trace
->path
->str
);
1977 if (bt_uuid_compare(first_trace_uuid
, this_trace_uuid
) != 0) {
1978 char first_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1979 char this_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1981 bt_uuid_to_str(first_trace_uuid
, first_trace_uuid_str
);
1982 bt_uuid_to_str(this_trace_uuid
, this_trace_uuid_str
);
1984 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1985 "Multiple traces given, but UUIDs don't match: "
1986 "first-trace-uuid={}, first-trace-path={}, "
1987 "trace-uuid={}, trace-path={}",
1988 first_trace_uuid_str
, first_trace
->path
->str
,
1989 this_trace_uuid_str
, this_trace
->path
->str
);
1994 ret
= merge_ctf_fs_traces((struct ctf_fs_trace
**) traces
->pdata
, traces
->len
, &trace
);
1996 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
,
1997 "Failed to merge traces with the same UUID.");
2001 ctf_fs
->trace
= trace
;
2003 /* Just one trace, it may or may not have a UUID, both are fine. */
2004 ctf_fs
->trace
= (ctf_fs_trace
*) traces
->pdata
[0];
2005 traces
->pdata
[0] = NULL
;
2008 ret
= fix_packet_index_tracer_bugs(ctf_fs
->trace
);
2010 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "Failed to fix packet index tracer bugs.");
2014 * Sort data stream file groups by first data stream file info
2015 * path to get a deterministic order. This order influences the
2016 * order of the output ports. It also influences the order of
2017 * the automatic stream IDs if the trace's packet headers do not
2018 * contain a `stream_instance_id` field, in which case the data
2019 * stream file to stream ID association is always the same,
2020 * whatever the build and the system.
2022 * Having a deterministic order here can help debugging and
2025 g_ptr_array_sort(ctf_fs
->trace
->ds_file_groups
, compare_ds_file_groups_by_first_path
);
2032 g_ptr_array_free(traces
, TRUE
);
2036 g_ptr_array_free(paths
, TRUE
);
2042 static GString
*get_stream_instance_unique_name(struct ctf_fs_ds_file_group
*ds_file_group
)
2045 struct ctf_fs_ds_file_info
*ds_file_info
;
2047 name
= g_string_new(NULL
);
2053 * If there's more than one stream file in the stream file
2054 * group, the first (earliest) stream file's path is used as
2055 * the stream's unique name.
2057 BT_ASSERT(ds_file_group
->ds_file_infos
->len
> 0);
2058 ds_file_info
= (ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
2059 g_string_assign(name
, ds_file_info
->path
->str
);
2065 /* Create the IR stream objects for ctf_fs_trace. */
2067 static int create_streams_for_trace(struct ctf_fs_trace
*ctf_fs_trace
)
2070 GString
*name
= NULL
;
2073 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
2074 ctf_fs_ds_file_group
*ds_file_group
=
2075 (ctf_fs_ds_file_group
*) g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
2076 name
= get_stream_instance_unique_name(ds_file_group
);
2082 if (ds_file_group
->sc
->ir_sc
) {
2083 BT_ASSERT(ctf_fs_trace
->trace
);
2085 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
2086 /* No stream ID: use 0 */
2087 ds_file_group
->stream
= bt_stream_create_with_id(
2088 ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
, ctf_fs_trace
->next_stream_id
);
2089 ctf_fs_trace
->next_stream_id
++;
2091 /* Specific stream ID */
2092 ds_file_group
->stream
=
2093 bt_stream_create_with_id(ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
,
2094 (uint64_t) ds_file_group
->stream_id
);
2097 ds_file_group
->stream
= NULL
;
2100 if (!ds_file_group
->stream
) {
2101 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
2102 "Cannot create stream for DS file group: "
2103 "addr={}, stream-name=\"{}\"",
2104 fmt::ptr(ds_file_group
), name
->str
);
2108 ret
= bt_stream_set_name(ds_file_group
->stream
, name
->str
);
2110 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs_trace
->logger
,
2111 "Cannot set stream's name: "
2112 "addr={}, stream-name=\"{}\"",
2113 fmt::ptr(ds_file_group
->stream
), name
->str
);
2117 g_string_free(name
, TRUE
);
2130 g_string_free(name
, TRUE
);
2135 static const bt_param_validation_value_descr inputs_elem_descr
=
2136 bt_param_validation_value_descr::makeString();
2138 static bt_param_validation_map_value_entry_descr fs_params_entries_descr
[] = {
2139 {"inputs", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
2140 bt_param_validation_value_descr::makeArray(1, BT_PARAM_VALIDATION_INFINITE
,
2141 inputs_elem_descr
)},
2142 {"trace-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2143 bt_param_validation_value_descr::makeString()},
2144 {"clock-class-offset-s", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2145 bt_param_validation_value_descr::makeSignedInteger()},
2146 {"clock-class-offset-ns", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2147 bt_param_validation_value_descr::makeSignedInteger()},
2148 {"force-clock-class-origin-unix-epoch", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2149 bt_param_validation_value_descr::makeBool()},
2150 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
2152 bool read_src_fs_parameters(const bt_value
*params
, const bt_value
**inputs
,
2153 const bt_value
**trace_name
, struct ctf_fs_component
*ctf_fs
)
2156 const bt_value
*value
;
2157 enum bt_param_validation_status validate_value_status
;
2158 gchar
*error
= NULL
;
2160 validate_value_status
= bt_param_validation_validate(params
, fs_params_entries_descr
, &error
);
2161 if (validate_value_status
!= BT_PARAM_VALIDATION_STATUS_OK
) {
2162 BT_CPPLOGE_APPEND_CAUSE_SPEC(ctf_fs
->logger
, "{}", error
);
2167 /* inputs parameter */
2168 *inputs
= bt_value_map_borrow_entry_value_const(params
, "inputs");
2170 /* clock-class-offset-s parameter */
2171 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-s");
2173 ctf_fs
->metadata_config
.clock_class_offset_s
= bt_value_integer_signed_get(value
);
2176 /* clock-class-offset-ns parameter */
2177 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-ns");
2179 ctf_fs
->metadata_config
.clock_class_offset_ns
= bt_value_integer_signed_get(value
);
2182 /* force-clock-class-origin-unix-epoch parameter */
2183 value
= bt_value_map_borrow_entry_value_const(params
, "force-clock-class-origin-unix-epoch");
2185 ctf_fs
->metadata_config
.force_clock_class_origin_unix_epoch
= bt_value_bool_get(value
);
2188 /* trace-name parameter */
2189 *trace_name
= bt_value_map_borrow_entry_value_const(params
, "trace-name");
2198 static ctf_fs_component::UP
ctf_fs_create(const bt_value
*params
,
2199 bt_self_component_source
*self_comp_src
)
2201 const bt_value
*inputs_value
;
2202 const bt_value
*trace_name_value
;
2203 bt_self_component
*self_comp
= bt_self_component_source_as_self_component(self_comp_src
);
2205 ctf_fs_component::UP ctf_fs
= ctf_fs_component_create(
2206 bt2c::Logger
{bt2::SelfSourceComponent
{self_comp_src
}, "PLUGIN/SRC.CTF.FS/COMP"});
2211 if (!read_src_fs_parameters(params
, &inputs_value
, &trace_name_value
, ctf_fs
.get())) {
2215 if (ctf_fs_component_create_ctf_fs_trace(ctf_fs
.get(), inputs_value
, trace_name_value
,
2220 if (create_streams_for_trace(ctf_fs
->trace
)) {
2224 if (create_ports_for_trace(ctf_fs
.get(), ctf_fs
->trace
, self_comp_src
)) {
2231 bt_component_class_initialize_method_status
ctf_fs_init(bt_self_component_source
*self_comp_src
,
2232 bt_self_component_source_configuration
*,
2233 const bt_value
*params
, void *)
2236 bt_component_class_initialize_method_status ret
=
2237 BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
2239 ctf_fs_component::UP ctf_fs
= ctf_fs_create(params
, self_comp_src
);
2241 ret
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
2244 bt_self_component_set_data(bt_self_component_source_as_self_component(self_comp_src
),
2247 } catch (const std::bad_alloc
&) {
2248 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
2249 } catch (const bt2::Error
&) {
2250 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
2254 bt_component_class_query_method_status
ctf_fs_query(bt_self_component_class_source
*comp_class_src
,
2255 bt_private_query_executor
*priv_query_exec
,
2256 const char *object
, const bt_value
*params
,
2257 __attribute__((unused
)) void *method_data
,
2258 const bt_value
**result
)
2261 bt_component_class_query_method_status status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
2262 bt2c::Logger logger
{bt2::SelfComponentClass
{comp_class_src
},
2263 bt2::PrivateQueryExecutor
{priv_query_exec
},
2264 "PLUGIN/SRC.CTF.FS/QUERY"};
2266 if (strcmp(object
, "metadata-info") == 0) {
2267 status
= metadata_info_query(params
, logger
, result
);
2268 } else if (strcmp(object
, "babeltrace.trace-infos") == 0) {
2269 status
= trace_infos_query(params
, logger
, result
);
2270 } else if (!strcmp(object
, "babeltrace.support-info")) {
2271 status
= support_info_query(params
, logger
, result
);
2273 BT_CPPLOGE_SPEC(logger
, "Unknown query object `{}`", object
);
2274 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;
2279 } catch (const std::bad_alloc
&) {
2280 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
2281 } catch (const bt2::Error
&) {
2282 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;