2 * SPDX-License-Identifier: MIT
4 * Copyright 2015-2017 Philippe Proulx <pproulx@efficios.com>
5 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 * Babeltrace CTF file system Reader Component
10 #define BT_CLOG_CFG logCfg
11 #define BT_LOG_TAG "PLUGIN/SRC.CTF.FS"
13 #include "common/common.h"
14 #include <babeltrace2/babeltrace.h>
15 #include "common/uuid.h"
17 #include "common/assert.h"
21 #include "metadata.hpp"
22 #include "data-stream-file.hpp"
24 #include "../common/src/metadata/tsdl/decoder.hpp"
25 #include "../common/src/metadata/tsdl/ctf-meta-configure-ir-trace.hpp"
26 #include "../common/src/msg-iter/msg-iter.hpp"
28 #include "plugins/common/param-validation/param-validation.h"
29 #include "cpp-common/cfg-logging.hpp"
30 #include "cpp-common/cfg-logging-error-reporting.hpp"
31 #include "cpp-common/exc.hpp"
32 #include "cpp-common/make-unique.hpp"
42 static void ctf_fs_msg_iter_data_destroy(struct ctf_fs_msg_iter_data
*msg_iter_data
)
48 if (msg_iter_data
->msg_iter
) {
49 ctf_msg_iter_destroy(msg_iter_data
->msg_iter
);
52 if (msg_iter_data
->msg_iter_medops_data
) {
53 ctf_fs_ds_group_medops_data_destroy(msg_iter_data
->msg_iter_medops_data
);
59 static bt_message_iterator_class_next_method_status
60 ctf_fs_iterator_next_one(struct ctf_fs_msg_iter_data
*msg_iter_data
, const bt_message
**out_msg
)
62 bt_message_iterator_class_next_method_status status
;
63 enum ctf_msg_iter_status msg_iter_status
;
64 const bt2_common::LogCfg
& logCfg
= msg_iter_data
->logCfg
;
66 msg_iter_status
= ctf_msg_iter_get_next_message(msg_iter_data
->msg_iter
, out_msg
);
68 switch (msg_iter_status
) {
69 case CTF_MSG_ITER_STATUS_OK
:
70 /* Cool, message has been written to *out_msg. */
71 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
74 case CTF_MSG_ITER_STATUS_EOF
:
75 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END
;
78 case CTF_MSG_ITER_STATUS_AGAIN
:
80 * Should not make it this far as this is
81 * medium-specific; there is nothing for the user to do
82 * and it should have been handled upstream.
86 case CTF_MSG_ITER_STATUS_ERROR
:
87 BT_CLOGE_APPEND_CAUSE("Failed to get next message from CTF message iterator.");
88 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
91 case CTF_MSG_ITER_STATUS_MEMORY_ERROR
:
92 BT_CLOGE_APPEND_CAUSE("Failed to get next message from CTF message iterator.");
93 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
104 bt_message_iterator_class_next_method_status
105 ctf_fs_iterator_next(bt_self_message_iterator
*iterator
, bt_message_array_const msgs
,
106 uint64_t capacity
, uint64_t *count
)
108 struct ctf_fs_msg_iter_data
*msg_iter_data
=
109 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(iterator
);
110 const bt2_common::LogCfg
& logCfg
= msg_iter_data
->logCfg
;
113 bt_message_iterator_class_next_method_status status
;
116 if (G_UNLIKELY(msg_iter_data
->next_saved_error
)) {
118 * Last time we were called, we hit an error but had some
119 * messages to deliver, so we stashed the error here. Return
122 BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(msg_iter_data
->next_saved_error
);
123 status
= msg_iter_data
->next_saved_status
;
128 status
= ctf_fs_iterator_next_one(msg_iter_data
, &msgs
[i
]);
129 if (status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
) {
132 } while (i
< capacity
&& status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
);
136 * Even if ctf_fs_iterator_next_one() returned something
137 * else than BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK, we
138 * accumulated message objects in the output
139 * message array, so we need to return
140 * BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK so that they are
141 * transfered to downstream. This other status occurs
142 * again the next time muxer_msg_iter_do_next() is
143 * called, possibly without any accumulated
144 * message, in which case we'll return it.
148 * Save this error for the next _next call. Assume that
149 * this component always appends error causes when
150 * returning an error status code, which will cause the
151 * current thread error to be non-NULL.
153 msg_iter_data
->next_saved_error
= bt_current_thread_take_error();
154 BT_ASSERT(msg_iter_data
->next_saved_error
);
155 msg_iter_data
->next_saved_status
= status
;
159 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
164 } catch (const std::bad_alloc
&) {
165 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
166 } catch (const bt2_common::Error
&) {
167 BT_CLOGE_APPEND_CAUSE("Failed to fetch next messages");
168 return BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
173 bt_message_iterator_class_seek_beginning_method_status
174 ctf_fs_iterator_seek_beginning(bt_self_message_iterator
*it
)
176 struct ctf_fs_msg_iter_data
*msg_iter_data
=
177 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(it
);
179 BT_ASSERT(msg_iter_data
);
181 const bt2_common::LogCfg
& logCfg
= msg_iter_data
->logCfg
;
184 ctf_msg_iter_reset(msg_iter_data
->msg_iter
);
185 ctf_fs_ds_group_medops_data_reset(msg_iter_data
->msg_iter_medops_data
);
187 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_OK
;
188 } catch (const std::bad_alloc
&) {
189 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_MEMORY_ERROR
;
190 } catch (const bt2_common::Error
&) {
191 BT_CLOGE_APPEND_CAUSE("Failed to seek beginning");
192 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_ERROR
;
197 void ctf_fs_iterator_finalize(bt_self_message_iterator
*it
)
199 ctf_fs_msg_iter_data_destroy(
200 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(it
));
203 static bt_message_iterator_class_initialize_method_status
204 ctf_msg_iter_medium_status_to_msg_iter_initialize_status(enum ctf_msg_iter_medium_status status
)
207 case CTF_MSG_ITER_MEDIUM_STATUS_EOF
:
208 case CTF_MSG_ITER_MEDIUM_STATUS_AGAIN
:
209 case CTF_MSG_ITER_MEDIUM_STATUS_ERROR
:
210 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
211 case CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
:
212 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
213 case CTF_MSG_ITER_MEDIUM_STATUS_OK
:
214 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
221 bt_message_iterator_class_initialize_method_status
222 ctf_fs_iterator_init(bt_self_message_iterator
*self_msg_iter
,
223 bt_self_message_iterator_configuration
*config
,
224 bt_self_component_port_output
*self_port
)
226 bt_self_component_port
*self_comp_port
=
227 bt_self_component_port_output_as_self_component_port(self_port
);
228 ctf_fs_port_data
*port_data
=
229 (ctf_fs_port_data
*) bt_self_component_port_get_data(self_comp_port
);
230 BT_ASSERT(port_data
);
232 bt2_common::LogCfg logCfg
{port_data
->ctf_fs
->logCfg
.logLevel(), *self_msg_iter
};
235 bt_message_iterator_class_initialize_method_status status
;
236 enum ctf_msg_iter_medium_status medium_status
;
238 ctf_fs_msg_iter_data
*msg_iter_data
= new ctf_fs_msg_iter_data
{logCfg
};
240 msg_iter_data
->self_msg_iter
= self_msg_iter
;
241 msg_iter_data
->ds_file_group
= port_data
->ds_file_group
;
244 ctf_fs_ds_group_medops_data_create(msg_iter_data
->ds_file_group
, self_msg_iter
, logCfg
,
245 &msg_iter_data
->msg_iter_medops_data
);
246 BT_ASSERT(medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_OK
||
247 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_ERROR
||
248 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
);
249 if (medium_status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
250 BT_CLOGE_APPEND_CAUSE("Failed to create ctf_fs_ds_group_medops");
251 status
= ctf_msg_iter_medium_status_to_msg_iter_initialize_status(medium_status
);
255 msg_iter_data
->msg_iter
= ctf_msg_iter_create(
256 msg_iter_data
->ds_file_group
->ctf_fs_trace
->metadata
->tc
,
257 bt_common_get_page_size(logCfg
.logLevel()) * 8, ctf_fs_ds_group_medops
,
258 msg_iter_data
->msg_iter_medops_data
, self_msg_iter
, logCfg
);
259 if (!msg_iter_data
->msg_iter
) {
260 BT_CLOGE_APPEND_CAUSE("Cannot create a CTF message iterator.");
261 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
266 * This iterator can seek forward if its stream class has a default
269 if (msg_iter_data
->ds_file_group
->sc
->default_clock_class
) {
270 bt_self_message_iterator_configuration_set_can_seek_forward(config
, true);
273 bt_self_message_iterator_set_data(self_msg_iter
, msg_iter_data
);
274 msg_iter_data
= NULL
;
276 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
280 bt_self_message_iterator_set_data(self_msg_iter
, NULL
);
283 ctf_fs_msg_iter_data_destroy(msg_iter_data
);
285 } catch (const std::bad_alloc
&) {
286 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
287 } catch (const bt2_common::Error
&) {
288 BT_CLOGE_APPEND_CAUSE("Failed to initialize iterator");
289 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
293 static void ctf_fs_trace_destroy(struct ctf_fs_trace
*ctf_fs_trace
)
299 if (ctf_fs_trace
->ds_file_groups
) {
300 g_ptr_array_free(ctf_fs_trace
->ds_file_groups
, TRUE
);
303 BT_TRACE_PUT_REF_AND_RESET(ctf_fs_trace
->trace
);
305 if (ctf_fs_trace
->path
) {
306 g_string_free(ctf_fs_trace
->path
, TRUE
);
309 if (ctf_fs_trace
->metadata
) {
310 ctf_fs_metadata_fini(ctf_fs_trace
->metadata
);
311 delete ctf_fs_trace
->metadata
;
318 void ctf_fs_destroy(struct ctf_fs_component
*ctf_fs
)
324 ctf_fs_trace_destroy(ctf_fs
->trace
);
326 if (ctf_fs
->port_data
) {
327 g_ptr_array_free(ctf_fs
->port_data
, TRUE
);
333 void ctf_fs_component_deleter::operator()(ctf_fs_component
*comp
)
335 ctf_fs_destroy(comp
);
338 static void port_data_destroy(struct ctf_fs_port_data
*port_data
)
347 static void port_data_destroy_notifier(void *data
)
349 port_data_destroy((struct ctf_fs_port_data
*) data
);
352 static void ctf_fs_trace_destroy_notifier(void *data
)
354 struct ctf_fs_trace
*trace
= (struct ctf_fs_trace
*) data
;
355 ctf_fs_trace_destroy(trace
);
358 ctf_fs_component::UP
ctf_fs_component_create(const bt2_common::LogCfg
& logCfg
)
360 ctf_fs_component::UP ctf_fs
{new ctf_fs_component
{logCfg
}};
361 ctf_fs
->port_data
= g_ptr_array_new_with_free_func(port_data_destroy_notifier
);
362 if (!ctf_fs
->port_data
) {
375 void ctf_fs_finalize(bt_self_component_source
*component
)
377 ctf_fs_destroy((struct ctf_fs_component
*) bt_self_component_get_data(
378 bt_self_component_source_as_self_component(component
)));
381 bt2_common::GCharUP
ctf_fs_make_port_name(struct ctf_fs_ds_file_group
*ds_file_group
)
383 GString
*name
= g_string_new(NULL
);
386 * The unique port name is generated by concatenating unique identifiers
394 /* For the trace, use the uuid if present, else the path. */
395 if (ds_file_group
->ctf_fs_trace
->metadata
->tc
->is_uuid_set
) {
396 char uuid_str
[BT_UUID_STR_LEN
+ 1];
398 bt_uuid_to_str(ds_file_group
->ctf_fs_trace
->metadata
->tc
->uuid
, uuid_str
);
399 g_string_assign(name
, uuid_str
);
401 g_string_assign(name
, ds_file_group
->ctf_fs_trace
->path
->str
);
405 * For the stream class, use the id if present. We can omit this field
406 * otherwise, as there will only be a single stream class.
408 if (ds_file_group
->sc
->id
!= UINT64_C(-1)) {
409 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->sc
->id
);
412 /* For the stream, use the id if present, else, use the path. */
413 if (ds_file_group
->stream_id
!= UINT64_C(-1)) {
414 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->stream_id
);
416 BT_ASSERT(ds_file_group
->ds_file_infos
->len
== 1);
417 struct ctf_fs_ds_file_info
*ds_file_info
=
418 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
419 g_string_append_printf(name
, " | %s", ds_file_info
->path
->str
);
422 return bt2_common::GCharUP
{g_string_free(name
, FALSE
)};
425 static int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
426 struct ctf_fs_trace
*ctf_fs_trace
,
427 struct ctf_fs_ds_file_group
*ds_file_group
,
428 bt_self_component_source
*self_comp_src
)
431 struct ctf_fs_port_data
*port_data
= NULL
;
432 const bt2_common::LogCfg
& logCfg
= ctf_fs
->logCfg
;
434 bt2_common::GCharUP port_name
= ctf_fs_make_port_name(ds_file_group
);
439 BT_CLOGI("Creating one port named `%s`", port_name
.get());
441 /* Create output port for this file */
442 port_data
= new ctf_fs_port_data
;
443 port_data
->ctf_fs
= ctf_fs
;
444 port_data
->ds_file_group
= ds_file_group
;
445 ret
= bt_self_component_source_add_output_port(self_comp_src
, port_name
.get(), port_data
, NULL
);
450 g_ptr_array_add(ctf_fs
->port_data
, port_data
);
458 port_data_destroy(port_data
);
462 static int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
463 struct ctf_fs_trace
*ctf_fs_trace
,
464 bt_self_component_source
*self_comp_src
)
468 const bt2_common::LogCfg
& logCfg
= ctf_fs
->logCfg
;
470 /* Create one output port for each stream file group */
471 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
472 struct ctf_fs_ds_file_group
*ds_file_group
=
473 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
475 ret
= create_one_port_for_trace(ctf_fs
, ctf_fs_trace
, ds_file_group
, self_comp_src
);
477 BT_CLOGE_APPEND_CAUSE("Cannot create output port.");
486 static void ctf_fs_ds_file_info_destroy(struct ctf_fs_ds_file_info
*ds_file_info
)
492 if (ds_file_info
->path
) {
493 g_string_free(ds_file_info
->path
, TRUE
);
499 static struct ctf_fs_ds_file_info
*ctf_fs_ds_file_info_create(const char *path
, int64_t begin_ns
)
501 ctf_fs_ds_file_info
*ds_file_info
= new ctf_fs_ds_file_info
;
502 ds_file_info
->path
= g_string_new(path
);
503 if (!ds_file_info
->path
) {
504 ctf_fs_ds_file_info_destroy(ds_file_info
);
509 ds_file_info
->begin_ns
= begin_ns
;
515 static void ctf_fs_ds_file_group_destroy(struct ctf_fs_ds_file_group
*ds_file_group
)
517 if (!ds_file_group
) {
521 if (ds_file_group
->ds_file_infos
) {
522 g_ptr_array_free(ds_file_group
->ds_file_infos
, TRUE
);
525 ctf_fs_ds_index_destroy(ds_file_group
->index
);
527 bt_stream_put_ref(ds_file_group
->stream
);
528 delete ds_file_group
;
531 static struct ctf_fs_ds_file_group
*ctf_fs_ds_file_group_create(struct ctf_fs_trace
*ctf_fs_trace
,
532 struct ctf_stream_class
*sc
,
533 uint64_t stream_instance_id
,
534 struct ctf_fs_ds_index
*index
)
536 ctf_fs_ds_file_group
*ds_file_group
= new ctf_fs_ds_file_group
;
537 ds_file_group
->ds_file_infos
=
538 g_ptr_array_new_with_free_func((GDestroyNotify
) ctf_fs_ds_file_info_destroy
);
539 if (!ds_file_group
->ds_file_infos
) {
543 ds_file_group
->index
= index
;
545 ds_file_group
->stream_id
= stream_instance_id
;
547 ds_file_group
->sc
= sc
;
548 ds_file_group
->ctf_fs_trace
= ctf_fs_trace
;
552 ctf_fs_ds_file_group_destroy(ds_file_group
);
553 ctf_fs_ds_index_destroy(index
);
554 ds_file_group
= NULL
;
557 return ds_file_group
;
560 /* Replace by g_ptr_array_insert when we depend on glib >= 2.40. */
561 static void array_insert(GPtrArray
*array
, gpointer element
, size_t pos
)
563 size_t original_array_len
= array
->len
;
565 /* Allocate an unused element at the end of the array. */
566 g_ptr_array_add(array
, NULL
);
568 /* If we are not inserting at the end, move the elements by one. */
569 if (pos
< original_array_len
) {
570 memmove(&(array
->pdata
[pos
+ 1]), &(array
->pdata
[pos
]),
571 (original_array_len
- pos
) * sizeof(gpointer
));
574 /* Insert the value. */
575 array
->pdata
[pos
] = element
;
579 * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right
580 * place to keep it sorted.
583 static void ds_file_group_insert_ds_file_info_sorted(struct ctf_fs_ds_file_group
*ds_file_group
,
584 struct ctf_fs_ds_file_info
*ds_file_info
)
588 /* Find the spot where to insert this ds_file_info. */
589 for (i
= 0; i
< ds_file_group
->ds_file_infos
->len
; i
++) {
590 struct ctf_fs_ds_file_info
*other_ds_file_info
=
591 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, i
);
593 if (ds_file_info
->begin_ns
< other_ds_file_info
->begin_ns
) {
598 array_insert(ds_file_group
->ds_file_infos
, ds_file_info
, i
);
601 static bool ds_index_entries_equal(const struct ctf_fs_ds_index_entry
*left
,
602 const struct ctf_fs_ds_index_entry
*right
)
604 if (left
->packet_size
!= right
->packet_size
) {
608 if (left
->timestamp_begin
!= right
->timestamp_begin
) {
612 if (left
->timestamp_end
!= right
->timestamp_end
) {
616 if (left
->packet_seq_num
!= right
->packet_seq_num
) {
624 * Insert `entry` into `index`, without duplication.
626 * The entry is inserted only if there isn't an identical entry already.
628 * In any case, the ownership of `entry` is transferred to this function. So if
629 * the entry is not inserted, it is freed.
632 static void ds_index_insert_ds_index_entry_sorted(struct ctf_fs_ds_index
*index
,
633 struct ctf_fs_ds_index_entry
*entry
)
636 struct ctf_fs_ds_index_entry
*other_entry
= NULL
;
638 /* Find the spot where to insert this index entry. */
639 for (i
= 0; i
< index
->entries
->len
; i
++) {
640 other_entry
= (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, i
);
642 if (entry
->timestamp_begin_ns
<= other_entry
->timestamp_begin_ns
) {
648 * Insert the entry only if a duplicate doesn't already exist.
650 * There can be duplicate packets if reading multiple overlapping
651 * snapshots of the same trace. We then want the index to contain
652 * a reference to only one copy of that packet.
654 if (i
== index
->entries
->len
|| !ds_index_entries_equal(entry
, other_entry
)) {
655 array_insert(index
->entries
, entry
, i
);
661 static void merge_ctf_fs_ds_indexes(struct ctf_fs_ds_index
*dest
, struct ctf_fs_ds_index
*src
)
665 for (i
= 0; i
< src
->entries
->len
; i
++) {
666 struct ctf_fs_ds_index_entry
*entry
=
667 (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(src
->entries
, i
);
670 * Ownership of the ctf_fs_ds_index_entry is transferred to
671 * ds_index_insert_ds_index_entry_sorted.
673 g_ptr_array_index(src
->entries
, i
) = NULL
;
674 ds_index_insert_ds_index_entry_sorted(dest
, entry
);
678 static int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
, const char *path
)
680 int64_t stream_instance_id
= -1;
681 int64_t begin_ns
= -1;
682 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
683 bool add_group
= false;
686 struct ctf_fs_ds_file
*ds_file
= NULL
;
687 struct ctf_fs_ds_file_info
*ds_file_info
= NULL
;
688 struct ctf_fs_ds_index
*index
= NULL
;
689 struct ctf_msg_iter
*msg_iter
= NULL
;
690 struct ctf_stream_class
*sc
= NULL
;
691 struct ctf_msg_iter_packet_properties props
;
692 const bt2_common::LogCfg
& logCfg
= ctf_fs_trace
->logCfg
;
695 * Create a temporary ds_file to read some properties about the data
698 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, path
, logCfg
);
703 /* Create a temporary iterator to read the ds_file. */
704 msg_iter
= ctf_msg_iter_create(ctf_fs_trace
->metadata
->tc
,
705 bt_common_get_page_size(logCfg
.logLevel()) * 8,
706 ctf_fs_ds_file_medops
, ds_file
, nullptr, logCfg
);
708 BT_CLOGE_STR("Cannot create a CTF message iterator.");
712 ctf_msg_iter_set_dry_run(msg_iter
, true);
714 ret
= ctf_msg_iter_get_packet_properties(msg_iter
, &props
);
716 BT_CLOGE_APPEND_CAUSE(
717 "Cannot get stream file's first packet's header and context fields (`%s`).", path
);
721 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
, props
.stream_class_id
);
723 stream_instance_id
= props
.data_stream_id
;
725 if (props
.snapshots
.beginning_clock
!= UINT64_C(-1)) {
726 BT_ASSERT(sc
->default_clock_class
);
727 ret
= bt_util_clock_cycles_to_ns_from_origin(
728 props
.snapshots
.beginning_clock
, sc
->default_clock_class
->frequency
,
729 sc
->default_clock_class
->offset_seconds
, sc
->default_clock_class
->offset_cycles
,
732 BT_CLOGE_APPEND_CAUSE("Cannot convert clock cycles to nanoseconds from origin (`%s`).",
738 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
);
743 index
= ctf_fs_ds_file_build_index(ds_file
, ds_file_info
, msg_iter
);
745 BT_CLOGE_APPEND_CAUSE("Failed to index CTF stream file \'%s\'", ds_file
->file
->path
->str
);
749 if (begin_ns
== -1) {
751 * No beginning timestamp to sort the stream files
752 * within a stream file group, so consider that this
753 * file must be the only one within its group.
755 stream_instance_id
= -1;
758 if (stream_instance_id
== -1) {
760 * No stream instance ID or no beginning timestamp:
761 * create a unique stream file group for this stream
762 * file because, even if there's a stream instance ID,
763 * there's no timestamp to order the file within its
766 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, UINT64_C(-1), index
);
767 /* Ownership of index is transferred. */
770 if (!ds_file_group
) {
774 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, BT_MOVE_REF(ds_file_info
));
780 BT_ASSERT(stream_instance_id
!= -1);
781 BT_ASSERT(begin_ns
!= -1);
783 /* Find an existing stream file group with this ID */
784 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
786 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
788 if (ds_file_group
->sc
== sc
&& ds_file_group
->stream_id
== stream_instance_id
) {
792 ds_file_group
= NULL
;
795 if (!ds_file_group
) {
796 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, stream_instance_id
, index
);
797 /* Ownership of index is transferred. */
799 if (!ds_file_group
) {
805 merge_ctf_fs_ds_indexes(ds_file_group
->index
, index
);
808 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, BT_MOVE_REF(ds_file_info
));
813 ctf_fs_ds_file_group_destroy(ds_file_group
);
814 ds_file_group
= NULL
;
818 if (add_group
&& ds_file_group
) {
819 g_ptr_array_add(ctf_fs_trace
->ds_file_groups
, ds_file_group
);
822 ctf_fs_ds_file_destroy(ds_file
);
823 ctf_fs_ds_file_info_destroy(ds_file_info
);
826 ctf_msg_iter_destroy(msg_iter
);
829 ctf_fs_ds_index_destroy(index
);
833 static int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
836 const char *basename
;
837 GError
*error
= NULL
;
839 const bt2_common::LogCfg
& logCfg
= ctf_fs_trace
->logCfg
;
841 /* Check each file in the path directory, except specific ones */
842 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
844 BT_CLOGE_APPEND_CAUSE("Cannot open directory `%s`: %s (code %d)", ctf_fs_trace
->path
->str
,
845 error
->message
, error
->code
);
849 while ((basename
= g_dir_read_name(dir
))) {
850 struct ctf_fs_file
*file
;
852 if (strcmp(basename
, CTF_FS_METADATA_FILENAME
) == 0) {
853 /* Ignore the metadata stream. */
854 BT_CLOGI("Ignoring metadata file `%s" G_DIR_SEPARATOR_S
"%s`", ctf_fs_trace
->path
->str
,
859 if (basename
[0] == '.') {
860 BT_CLOGI("Ignoring hidden file `%s" G_DIR_SEPARATOR_S
"%s`", ctf_fs_trace
->path
->str
,
865 /* Create the file. */
866 file
= ctf_fs_file_create(logCfg
);
868 BT_CLOGE_APPEND_CAUSE("Cannot create stream file object for file `%s" G_DIR_SEPARATOR_S
870 ctf_fs_trace
->path
->str
, basename
);
874 /* Create full path string. */
875 g_string_append_printf(file
->path
, "%s" G_DIR_SEPARATOR_S
"%s", ctf_fs_trace
->path
->str
,
877 if (!g_file_test(file
->path
->str
, G_FILE_TEST_IS_REGULAR
)) {
878 BT_CLOGI("Ignoring non-regular file `%s`", file
->path
->str
);
879 ctf_fs_file_destroy(file
);
884 ret
= ctf_fs_file_open(file
, "rb");
886 BT_CLOGE_APPEND_CAUSE("Cannot open stream file `%s`", file
->path
->str
);
890 if (file
->size
== 0) {
891 /* Skip empty stream. */
892 BT_CLOGI("Ignoring empty file `%s`", file
->path
->str
);
893 ctf_fs_file_destroy(file
);
897 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
, file
->path
->str
);
899 BT_CLOGE_APPEND_CAUSE("Cannot add stream file `%s` to stream file group",
901 ctf_fs_file_destroy(file
);
905 ctf_fs_file_destroy(file
);
926 static int set_trace_name(bt_trace
*trace
, const char *name_suffix
,
927 const bt2_common::LogCfg
& logCfg
)
933 name
= g_string_new(NULL
);
935 BT_CLOGE_STR("Failed to allocate a GString.");
941 * Check if we have a trace environment string value named `hostname`.
942 * If so, use it as the trace name's prefix.
944 val
= bt_trace_borrow_environment_entry_value_by_name_const(trace
, "hostname");
945 if (val
&& bt_value_is_string(val
)) {
946 g_string_append(name
, bt_value_string_get(val
));
949 g_string_append_c(name
, G_DIR_SEPARATOR
);
954 g_string_append(name
, name_suffix
);
957 ret
= bt_trace_set_name(trace
, name
->str
);
966 g_string_free(name
, TRUE
);
972 static struct ctf_fs_trace
*ctf_fs_trace_create(const char *path
, const char *name
,
973 struct ctf_fs_metadata_config
*metadata_config
,
974 bt_self_component
*selfComp
,
975 const bt2_common::LogCfg
& logCfg
)
979 ctf_fs_trace
*ctf_fs_trace
= new struct ctf_fs_trace(logCfg
);
980 ctf_fs_trace
->path
= g_string_new(path
);
981 if (!ctf_fs_trace
->path
) {
985 ctf_fs_trace
->metadata
= new ctf_fs_metadata
;
986 ctf_fs_metadata_init(ctf_fs_trace
->metadata
);
987 ctf_fs_trace
->ds_file_groups
=
988 g_ptr_array_new_with_free_func((GDestroyNotify
) ctf_fs_ds_file_group_destroy
);
989 if (!ctf_fs_trace
->ds_file_groups
) {
993 ret
= ctf_fs_metadata_set_trace_class(ctf_fs_trace
, metadata_config
, selfComp
, logCfg
);
998 if (ctf_fs_trace
->metadata
->trace_class
) {
999 ctf_fs_trace
->trace
= bt_trace_create(ctf_fs_trace
->metadata
->trace_class
);
1000 if (!ctf_fs_trace
->trace
) {
1005 if (ctf_fs_trace
->trace
) {
1006 ret
= ctf_trace_class_configure_ir_trace(ctf_fs_trace
->metadata
->tc
, ctf_fs_trace
->trace
);
1011 ret
= set_trace_name(ctf_fs_trace
->trace
, name
, logCfg
);
1017 ret
= create_ds_file_groups(ctf_fs_trace
);
1025 ctf_fs_trace_destroy(ctf_fs_trace
);
1026 ctf_fs_trace
= NULL
;
1029 return ctf_fs_trace
;
1032 static int path_is_ctf_trace(const char *path
)
1034 GString
*metadata_path
= g_string_new(NULL
);
1037 if (!metadata_path
) {
1042 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
1044 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
1050 g_string_free(metadata_path
, TRUE
);
1054 /* Helper for ctf_fs_component_create_ctf_fs_trace, to handle a single path. */
1056 static int ctf_fs_component_create_ctf_fs_trace_one_path(struct ctf_fs_component
*ctf_fs
,
1057 const char *path_param
,
1058 const char *trace_name
, GPtrArray
*traces
,
1059 bt_self_component
*selfComp
)
1061 struct ctf_fs_trace
*ctf_fs_trace
;
1064 const bt2_common::LogCfg
& logCfg
= ctf_fs
->logCfg
;
1066 norm_path
= bt_common_normalize_path(path_param
, NULL
);
1068 BT_CLOGE_APPEND_CAUSE("Failed to normalize path: `%s`.", path_param
);
1072 ret
= path_is_ctf_trace(norm_path
->str
);
1074 BT_CLOGE_APPEND_CAUSE("Failed to check if path is a CTF trace: path=%s", norm_path
->str
);
1076 } else if (ret
== 0) {
1077 BT_CLOGE_APPEND_CAUSE("Path is not a CTF trace (does not contain a metadata file): `%s`.",
1082 // FIXME: Remove or ifdef for __MINGW32__
1083 if (strcmp(norm_path
->str
, "/") == 0) {
1084 BT_CLOGE_APPEND_CAUSE("Opening a trace in `/` is not supported.");
1090 ctf_fs_trace_create(norm_path
->str
, trace_name
, &ctf_fs
->metadata_config
, selfComp
, logCfg
);
1091 if (!ctf_fs_trace
) {
1092 BT_CLOGE_APPEND_CAUSE("Cannot create trace for `%s`.", norm_path
->str
);
1096 g_ptr_array_add(traces
, ctf_fs_trace
);
1097 ctf_fs_trace
= NULL
;
1107 g_string_free(norm_path
, TRUE
);
1114 * Count the number of stream and event classes defined by this trace's metadata.
1116 * This is used to determine which metadata is the "latest", out of multiple
1117 * traces sharing the same UUID. It is assumed that amongst all these metadatas,
1118 * a bigger metadata is a superset of a smaller metadata. Therefore, it is
1119 * enough to just count the classes.
1122 static unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace
*trace
)
1124 unsigned int num
= trace
->metadata
->tc
->stream_classes
->len
;
1127 for (i
= 0; i
< trace
->metadata
->tc
->stream_classes
->len
; i
++) {
1128 struct ctf_stream_class
*sc
=
1129 (struct ctf_stream_class
*) trace
->metadata
->tc
->stream_classes
->pdata
[i
];
1130 num
+= sc
->event_classes
->len
;
1137 * Merge the src ds_file_group into dest. This consists of merging their
1138 * ds_file_infos, making sure to keep the result sorted.
1141 static void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group
*dest
,
1142 struct ctf_fs_ds_file_group
*src
)
1146 for (i
= 0; i
< src
->ds_file_infos
->len
; i
++) {
1147 struct ctf_fs_ds_file_info
*ds_file_info
=
1148 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(src
->ds_file_infos
, i
);
1150 /* Ownership of the ds_file_info is transferred to dest. */
1151 g_ptr_array_index(src
->ds_file_infos
, i
) = NULL
;
1153 ds_file_group_insert_ds_file_info_sorted(dest
, ds_file_info
);
1156 /* Merge both indexes. */
1157 merge_ctf_fs_ds_indexes(dest
->index
, src
->index
);
1159 /* Merge src_trace's data stream file groups into dest_trace's. */
1161 static int merge_matching_ctf_fs_ds_file_groups(struct ctf_fs_trace
*dest_trace
,
1162 struct ctf_fs_trace
*src_trace
)
1164 GPtrArray
*dest
= dest_trace
->ds_file_groups
;
1165 GPtrArray
*src
= src_trace
->ds_file_groups
;
1170 * Save the initial length of dest: we only want to check against the
1171 * original elements in the inner loop.
1173 const guint dest_len
= dest
->len
;
1175 for (s_i
= 0; s_i
< src
->len
; s_i
++) {
1176 struct ctf_fs_ds_file_group
*src_group
=
1177 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(src
, s_i
);
1178 struct ctf_fs_ds_file_group
*dest_group
= NULL
;
1180 /* A stream instance without ID can't match a stream in the other trace. */
1181 if (src_group
->stream_id
!= -1) {
1184 /* Let's search for a matching ds_file_group in the destination. */
1185 for (d_i
= 0; d_i
< dest_len
; d_i
++) {
1186 struct ctf_fs_ds_file_group
*candidate_dest
=
1187 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(dest
, d_i
);
1189 /* Can't match a stream instance without ID. */
1190 if (candidate_dest
->stream_id
== -1) {
1195 * If the two groups have the same stream instance id
1196 * and belong to the same stream class (stream instance
1197 * ids are per-stream class), they represent the same
1200 if (candidate_dest
->stream_id
!= src_group
->stream_id
||
1201 candidate_dest
->sc
->id
!= src_group
->sc
->id
) {
1205 dest_group
= candidate_dest
;
1211 * Didn't find a friend in dest to merge our src_group into?
1212 * Create a new empty one. This can happen if a stream was
1213 * active in the source trace chunk but not in the destination
1217 struct ctf_stream_class
*sc
;
1218 struct ctf_fs_ds_index
*index
;
1220 sc
= ctf_trace_class_borrow_stream_class_by_id(dest_trace
->metadata
->tc
,
1224 index
= ctf_fs_ds_index_create(dest_trace
->logCfg
);
1230 dest_group
= ctf_fs_ds_file_group_create(dest_trace
, sc
, src_group
->stream_id
, index
);
1231 /* Ownership of index is transferred. */
1238 g_ptr_array_add(dest_trace
->ds_file_groups
, dest_group
);
1241 BT_ASSERT(dest_group
);
1242 merge_ctf_fs_ds_file_groups(dest_group
, src_group
);
1250 * Collapse the given traces, which must all share the same UUID, in a single
1253 * The trace with the most expansive metadata is chosen and all other traces
1254 * are merged into that one. The array slots of all the traces that get merged
1255 * in the chosen one are set to NULL, so only the slot of the chosen trace
1259 static int merge_ctf_fs_traces(struct ctf_fs_trace
**traces
, unsigned int num_traces
,
1260 struct ctf_fs_trace
**out_trace
)
1262 unsigned int winner_count
;
1263 struct ctf_fs_trace
*winner
;
1267 BT_ASSERT(num_traces
>= 2);
1269 winner_count
= metadata_count_stream_and_event_classes(traces
[0]);
1273 /* Find the trace with the largest metadata. */
1274 for (i
= 1; i
< num_traces
; i
++) {
1275 struct ctf_fs_trace
*candidate
;
1276 unsigned int candidate_count
;
1278 candidate
= traces
[i
];
1280 /* A bit of sanity check. */
1281 BT_ASSERT(bt_uuid_compare(winner
->metadata
->tc
->uuid
, candidate
->metadata
->tc
->uuid
) == 0);
1283 candidate_count
= metadata_count_stream_and_event_classes(candidate
);
1285 if (candidate_count
> winner_count
) {
1286 winner_count
= candidate_count
;
1292 /* Merge all the other traces in the winning trace. */
1293 for (i
= 0; i
< num_traces
; i
++) {
1294 struct ctf_fs_trace
*trace
= traces
[i
];
1296 /* Don't merge the winner into itself. */
1297 if (trace
== winner
) {
1301 /* Merge trace's data stream file groups into winner's. */
1302 ret
= merge_matching_ctf_fs_ds_file_groups(winner
, trace
);
1309 * Move the winner out of the array, into `*out_trace`.
1311 *out_trace
= winner
;
1312 traces
[winner_i
] = NULL
;
1324 static int decode_clock_snapshot_after_event(struct ctf_fs_trace
*ctf_fs_trace
,
1325 struct ctf_clock_class
*default_cc
,
1326 struct ctf_fs_ds_index_entry
*index_entry
,
1327 enum target_event target_event
, uint64_t *cs
,
1330 enum ctf_msg_iter_status iter_status
= CTF_MSG_ITER_STATUS_OK
;
1331 struct ctf_fs_ds_file
*ds_file
= NULL
;
1332 struct ctf_msg_iter
*msg_iter
= NULL
;
1333 const bt2_common::LogCfg
& logCfg
= ctf_fs_trace
->logCfg
;
1336 BT_ASSERT(ctf_fs_trace
);
1337 BT_ASSERT(index_entry
);
1338 BT_ASSERT(index_entry
->path
);
1340 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, index_entry
->path
, logCfg
);
1342 BT_CLOGE_APPEND_CAUSE("Failed to create a ctf_fs_ds_file");
1347 BT_ASSERT(ctf_fs_trace
->metadata
);
1348 BT_ASSERT(ctf_fs_trace
->metadata
->tc
);
1350 msg_iter
= ctf_msg_iter_create(ctf_fs_trace
->metadata
->tc
,
1351 bt_common_get_page_size(logCfg
.logLevel()) * 8,
1352 ctf_fs_ds_file_medops
, ds_file
, NULL
, logCfg
);
1354 /* ctf_msg_iter_create() logs errors. */
1360 * Turn on dry run mode to prevent the creation and usage of Babeltrace
1361 * library objects (bt_field, bt_message_*, etc.).
1363 ctf_msg_iter_set_dry_run(msg_iter
, true);
1365 /* Seek to the beginning of the target packet. */
1366 iter_status
= ctf_msg_iter_seek(msg_iter
, index_entry
->offset
);
1368 /* ctf_msg_iter_seek() logs errors. */
1373 switch (target_event
) {
1376 * Start to decode the packet until we reach the end of
1377 * the first event. To extract the first event's clock
1380 iter_status
= ctf_msg_iter_curr_packet_first_event_clock_snapshot(msg_iter
, cs
);
1383 /* Decode the packet to extract the last event's clock snapshot. */
1384 iter_status
= ctf_msg_iter_curr_packet_last_event_clock_snapshot(msg_iter
, cs
);
1394 /* Convert clock snapshot to timestamp. */
1395 ret
= bt_util_clock_cycles_to_ns_from_origin(
1396 *cs
, default_cc
->frequency
, default_cc
->offset_seconds
, default_cc
->offset_cycles
, ts_ns
);
1398 BT_CLOGE_APPEND_CAUSE("Failed to convert clock snapshot to timestamp");
1404 ctf_fs_ds_file_destroy(ds_file
);
1407 ctf_msg_iter_destroy(msg_iter
);
1413 static int decode_packet_first_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1414 struct ctf_clock_class
*default_cc
,
1415 struct ctf_fs_ds_index_entry
*index_entry
,
1416 uint64_t *cs
, int64_t *ts_ns
)
1418 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, FIRST_EVENT
, cs
,
1422 static int decode_packet_last_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1423 struct ctf_clock_class
*default_cc
,
1424 struct ctf_fs_ds_index_entry
*index_entry
,
1425 uint64_t *cs
, int64_t *ts_ns
)
1427 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, LAST_EVENT
, cs
,
1432 * Fix up packet index entries for lttng's "event-after-packet" bug.
1433 * Some buggy lttng tracer versions may emit events with a timestamp that is
1434 * larger (after) than the timestamp_end of the their packets.
1436 * To fix up this erroneous data we do the following:
1437 * 1. If it's not the stream file's last packet: set the packet index entry's
1438 * end time to the next packet's beginning time.
1439 * 2. If it's the stream file's last packet, set the packet index entry's end
1440 * time to the packet's last event's time, if any, or to the packet's
1441 * beginning time otherwise.
1443 * Known buggy tracer versions:
1444 * - before lttng-ust 2.11.0
1445 * - before lttng-module 2.11.0
1446 * - before lttng-module 2.10.10
1447 * - before lttng-module 2.9.13
1449 static int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace
*trace
)
1452 guint ds_file_group_i
;
1453 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1454 const bt2_common::LogCfg
& logCfg
= trace
->logCfg
;
1456 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
; ds_file_group_i
++) {
1458 struct ctf_clock_class
*default_cc
;
1459 struct ctf_fs_ds_index_entry
*last_entry
;
1460 struct ctf_fs_ds_index
*index
;
1462 struct ctf_fs_ds_file_group
*ds_file_group
=
1463 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1465 BT_ASSERT(ds_file_group
);
1466 index
= ds_file_group
->index
;
1469 BT_ASSERT(index
->entries
);
1470 BT_ASSERT(index
->entries
->len
> 0);
1473 * Iterate over all entries but the last one. The last one is
1474 * fixed differently after.
1476 for (entry_i
= 0; entry_i
< index
->entries
->len
- 1; entry_i
++) {
1477 struct ctf_fs_ds_index_entry
*curr_entry
, *next_entry
;
1479 curr_entry
= (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
);
1480 next_entry
= (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
+ 1);
1483 * 1. Set the current index entry `end` timestamp to
1484 * the next index entry `begin` timestamp.
1486 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1487 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1491 * 2. Fix the last entry by decoding the last event of the last
1495 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, index
->entries
->len
- 1);
1496 BT_ASSERT(last_entry
);
1498 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1499 default_cc
= ds_file_group
->sc
->default_clock_class
;
1502 * Decode packet to read the timestamp of the last event of the
1505 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1506 &last_entry
->timestamp_end
,
1507 &last_entry
->timestamp_end_ns
);
1509 BT_CLOGE_APPEND_CAUSE(
1510 "Failed to decode stream's last packet to get its last event's clock snapshot.");
1520 * Fix up packet index entries for barectf's "event-before-packet" bug.
1521 * Some buggy barectf tracer versions may emit events with a timestamp that is
1522 * less than the timestamp_begin of the their packets.
1524 * To fix up this erroneous data we do the following:
1525 * 1. Starting at the second index entry, set the timestamp_begin of the
1526 * current entry to the timestamp of the first event of the packet.
1527 * 2. Set the previous entry's timestamp_end to the timestamp_begin of the
1530 * Known buggy tracer versions:
1531 * - before barectf 2.3.1
1533 static int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace
*trace
)
1536 guint ds_file_group_i
;
1537 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1538 const bt2_common::LogCfg
& logCfg
= trace
->logCfg
;
1540 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
; ds_file_group_i
++) {
1542 struct ctf_clock_class
*default_cc
;
1543 ctf_fs_ds_file_group
*ds_file_group
=
1544 (ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1546 struct ctf_fs_ds_index
*index
= ds_file_group
->index
;
1549 BT_ASSERT(index
->entries
);
1550 BT_ASSERT(index
->entries
->len
> 0);
1552 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1553 default_cc
= ds_file_group
->sc
->default_clock_class
;
1556 * 1. Iterate over the index, starting from the second entry
1559 for (entry_i
= 1; entry_i
< index
->entries
->len
; entry_i
++) {
1560 ctf_fs_ds_index_entry
*prev_entry
=
1561 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
- 1);
1562 ctf_fs_ds_index_entry
*curr_entry
=
1563 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
);
1565 * 2. Set the current entry `begin` timestamp to the
1566 * timestamp of the first event of the current packet.
1568 ret
= decode_packet_first_event_timestamp(trace
, default_cc
, curr_entry
,
1569 &curr_entry
->timestamp_begin
,
1570 &curr_entry
->timestamp_begin_ns
);
1572 BT_CLOGE_APPEND_CAUSE("Failed to decode first event's clock snapshot");
1577 * 3. Set the previous entry `end` timestamp to the
1578 * timestamp of the first event of the current packet.
1580 prev_entry
->timestamp_end
= curr_entry
->timestamp_begin
;
1581 prev_entry
->timestamp_end_ns
= curr_entry
->timestamp_begin_ns
;
1589 * When using the lttng-crash feature it's likely that the last packets of each
1590 * stream have their timestamp_end set to zero. This is caused by the fact that
1591 * the tracer crashed and was not able to properly close the packets.
1593 * To fix up this erroneous data we do the following:
1594 * For each index entry, if the entry's timestamp_end is 0 and the
1595 * timestamp_begin is not 0:
1596 * - If it's the stream file's last packet: set the packet index entry's end
1597 * time to the packet's last event's time, if any, or to the packet's
1598 * beginning time otherwise.
1599 * - If it's not the stream file's last packet: set the packet index
1600 * entry's end time to the next packet's beginning time.
1602 * Affected versions:
1603 * - All current and future lttng-ust and lttng-modules versions.
1605 static int fix_index_lttng_crash_quirk(struct ctf_fs_trace
*trace
)
1608 guint ds_file_group_idx
;
1609 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1610 const bt2_common::LogCfg
& logCfg
= trace
->logCfg
;
1612 for (ds_file_group_idx
= 0; ds_file_group_idx
< ds_file_groups
->len
; ds_file_group_idx
++) {
1614 struct ctf_clock_class
*default_cc
;
1615 struct ctf_fs_ds_index
*index
;
1617 ctf_fs_ds_file_group
*ds_file_group
=
1618 (ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_idx
);
1620 BT_ASSERT(ds_file_group
);
1621 index
= ds_file_group
->index
;
1623 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1624 default_cc
= ds_file_group
->sc
->default_clock_class
;
1627 BT_ASSERT(index
->entries
);
1628 BT_ASSERT(index
->entries
->len
> 0);
1630 ctf_fs_ds_index_entry
*last_entry
=
1631 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, index
->entries
->len
- 1);
1632 BT_ASSERT(last_entry
);
1634 /* 1. Fix the last entry first. */
1635 if (last_entry
->timestamp_end
== 0 && last_entry
->timestamp_begin
!= 0) {
1637 * Decode packet to read the timestamp of the
1638 * last event of the stream file.
1640 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1641 &last_entry
->timestamp_end
,
1642 &last_entry
->timestamp_end_ns
);
1644 BT_CLOGE_APPEND_CAUSE("Failed to decode last event's clock snapshot");
1649 /* Iterate over all entries but the last one. */
1650 for (entry_idx
= 0; entry_idx
< index
->entries
->len
- 1; entry_idx
++) {
1651 ctf_fs_ds_index_entry
*curr_entry
=
1652 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_idx
);
1653 ctf_fs_ds_index_entry
*next_entry
=
1654 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_idx
+ 1);
1656 if (curr_entry
->timestamp_end
== 0 && curr_entry
->timestamp_begin
!= 0) {
1658 * 2. Set the current index entry `end` timestamp to
1659 * the next index entry `begin` timestamp.
1661 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1662 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1672 * Extract the tracer information necessary to compare versions.
1673 * Returns 0 on success, and -1 if the extraction is not successful because the
1674 * necessary fields are absents in the trace metadata.
1676 static int extract_tracer_info(struct ctf_fs_trace
*trace
, struct tracer_info
*current_tracer_info
)
1679 struct ctf_trace_class_env_entry
*entry
;
1681 /* Clear the current_tracer_info struct */
1682 memset(current_tracer_info
, 0, sizeof(*current_tracer_info
));
1685 * To compare 2 tracer versions, at least the tracer name and it's
1686 * major version are needed. If one of these is missing, consider it an
1687 * extraction failure.
1689 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_name");
1690 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR
) {
1691 goto missing_bare_minimum
;
1694 /* Set tracer name. */
1695 current_tracer_info
->name
= entry
->value
.str
->str
;
1697 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_major");
1698 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1699 goto missing_bare_minimum
;
1702 /* Set major version number. */
1703 current_tracer_info
->major
= entry
->value
.i
;
1705 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_minor");
1706 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1710 /* Set minor version number. */
1711 current_tracer_info
->minor
= entry
->value
.i
;
1713 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patch");
1716 * If `tracer_patch` doesn't exist `tracer_patchlevel` might.
1717 * For example, `lttng-modules` uses entry name
1718 * `tracer_patchlevel`.
1720 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patchlevel");
1723 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1727 /* Set patch version number. */
1728 current_tracer_info
->patch
= entry
->value
.i
;
1732 missing_bare_minimum
:
1738 static bool is_tracer_affected_by_lttng_event_after_packet_bug(struct tracer_info
*curr_tracer_info
)
1740 bool is_affected
= false;
1742 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1743 if (curr_tracer_info
->major
< 2) {
1745 } else if (curr_tracer_info
->major
== 2) {
1746 /* fixed in lttng-ust 2.11.0 */
1747 if (curr_tracer_info
->minor
< 11) {
1751 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1752 if (curr_tracer_info
->major
< 2) {
1754 } else if (curr_tracer_info
->major
== 2) {
1755 /* fixed in lttng-modules 2.11.0 */
1756 if (curr_tracer_info
->minor
== 10) {
1757 /* fixed in lttng-modules 2.10.10 */
1758 if (curr_tracer_info
->patch
< 10) {
1761 } else if (curr_tracer_info
->minor
== 9) {
1762 /* fixed in lttng-modules 2.9.13 */
1763 if (curr_tracer_info
->patch
< 13) {
1766 } else if (curr_tracer_info
->minor
< 9) {
1776 is_tracer_affected_by_barectf_event_before_packet_bug(struct tracer_info
*curr_tracer_info
)
1778 bool is_affected
= false;
1780 if (strcmp(curr_tracer_info
->name
, "barectf") == 0) {
1781 if (curr_tracer_info
->major
< 2) {
1783 } else if (curr_tracer_info
->major
== 2) {
1784 if (curr_tracer_info
->minor
< 3) {
1786 } else if (curr_tracer_info
->minor
== 3) {
1787 /* fixed in barectf 2.3.1 */
1788 if (curr_tracer_info
->patch
< 1) {
1798 static bool is_tracer_affected_by_lttng_crash_quirk(struct tracer_info
*curr_tracer_info
)
1800 bool is_affected
= false;
1802 /* All LTTng tracer may be affected by this lttng crash quirk. */
1803 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1805 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1813 * Looks for trace produced by known buggy tracers and fix up the index
1816 static int fix_packet_index_tracer_bugs(struct ctf_fs_component
*ctf_fs
)
1819 struct tracer_info current_tracer_info
;
1820 const bt2_common::LogCfg
& logCfg
= ctf_fs
->logCfg
;
1822 ret
= extract_tracer_info(ctf_fs
->trace
, ¤t_tracer_info
);
1825 * A trace may not have all the necessary environment
1826 * entries to do the tracer version comparison.
1827 * At least, the tracer name and major version number
1828 * are needed. Failing to extract these entries is not
1832 BT_LOGI_STR("Cannot extract tracer information necessary to compare with buggy versions.");
1837 /* Check if the trace may be affected by old tracer bugs. */
1838 if (is_tracer_affected_by_lttng_event_after_packet_bug(¤t_tracer_info
)) {
1839 BT_LOGI_STR("Trace may be affected by LTTng tracer packet timestamp bug. Fixing up.");
1840 ret
= fix_index_lttng_event_after_packet_bug(ctf_fs
->trace
);
1842 BT_CLOGE_APPEND_CAUSE("Failed to fix LTTng event-after-packet bug.");
1845 ctf_fs
->trace
->metadata
->tc
->quirks
.lttng_event_after_packet
= true;
1848 if (is_tracer_affected_by_barectf_event_before_packet_bug(¤t_tracer_info
)) {
1849 BT_LOGI_STR("Trace may be affected by barectf tracer packet timestamp bug. Fixing up.");
1850 ret
= fix_index_barectf_event_before_packet_bug(ctf_fs
->trace
);
1852 BT_CLOGE_APPEND_CAUSE("Failed to fix barectf event-before-packet bug.");
1855 ctf_fs
->trace
->metadata
->tc
->quirks
.barectf_event_before_packet
= true;
1858 if (is_tracer_affected_by_lttng_crash_quirk(¤t_tracer_info
)) {
1859 ret
= fix_index_lttng_crash_quirk(ctf_fs
->trace
);
1861 BT_CLOGE_APPEND_CAUSE("Failed to fix lttng-crash timestamp quirks.");
1864 ctf_fs
->trace
->metadata
->tc
->quirks
.lttng_crash
= true;
1871 static gint
compare_ds_file_groups_by_first_path(gconstpointer a
, gconstpointer b
)
1873 ctf_fs_ds_file_group
* const *ds_file_group_a
= (ctf_fs_ds_file_group
**) a
;
1874 ctf_fs_ds_file_group
* const *ds_file_group_b
= (ctf_fs_ds_file_group
**) b
;
1876 BT_ASSERT((*ds_file_group_a
)->ds_file_infos
->len
> 0);
1877 BT_ASSERT((*ds_file_group_b
)->ds_file_infos
->len
> 0);
1879 const ctf_fs_ds_file_info
*first_ds_file_info_a
=
1880 (const ctf_fs_ds_file_info
*) (*ds_file_group_a
)->ds_file_infos
->pdata
[0];
1881 const ctf_fs_ds_file_info
*first_ds_file_info_b
=
1882 (const ctf_fs_ds_file_info
*) (*ds_file_group_b
)->ds_file_infos
->pdata
[0];
1884 return strcmp(first_ds_file_info_a
->path
->str
, first_ds_file_info_b
->path
->str
);
1887 static gint
compare_strings(gconstpointer p_a
, gconstpointer p_b
)
1889 const char *a
= *((const char **) p_a
);
1890 const char *b
= *((const char **) p_b
);
1892 return strcmp(a
, b
);
1895 int ctf_fs_component_create_ctf_fs_trace(struct ctf_fs_component
*ctf_fs
,
1896 const bt_value
*paths_value
,
1897 const bt_value
*trace_name_value
,
1898 bt_self_component
*selfComp
)
1902 const bt2_common::LogCfg
& logCfg
= ctf_fs
->logCfg
;
1903 GPtrArray
*paths
= NULL
;
1905 const char *trace_name
;
1907 BT_ASSERT(bt_value_get_type(paths_value
) == BT_VALUE_TYPE_ARRAY
);
1908 BT_ASSERT(!bt_value_array_is_empty(paths_value
));
1910 traces
= g_ptr_array_new_with_free_func(ctf_fs_trace_destroy_notifier
);
1912 BT_CLOGE_APPEND_CAUSE("Failed to allocate a GPtrArray.");
1916 paths
= g_ptr_array_new_with_free_func(g_free
);
1918 BT_CLOGE_APPEND_CAUSE("Failed to allocate a GPtrArray.");
1922 trace_name
= trace_name_value
? bt_value_string_get(trace_name_value
) : NULL
;
1925 * Create a sorted array of the paths, to make the execution of this
1926 * component deterministic.
1928 for (i
= 0; i
< bt_value_array_get_length(paths_value
); i
++) {
1929 const bt_value
*path_value
= bt_value_array_borrow_element_by_index_const(paths_value
, i
);
1930 const char *input
= bt_value_string_get(path_value
);
1933 input_copy
= g_strdup(input
);
1935 BT_CLOGE_APPEND_CAUSE("Failed to copy a string.");
1939 g_ptr_array_add(paths
, input_copy
);
1942 g_ptr_array_sort(paths
, compare_strings
);
1944 /* Create a separate ctf_fs_trace object for each path. */
1945 for (i
= 0; i
< paths
->len
; i
++) {
1946 const char *path
= (const char *) g_ptr_array_index(paths
, i
);
1948 ret
= ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs
, path
, trace_name
, traces
,
1955 if (traces
->len
> 1) {
1956 struct ctf_fs_trace
*first_trace
= (struct ctf_fs_trace
*) traces
->pdata
[0];
1957 const uint8_t *first_trace_uuid
= first_trace
->metadata
->tc
->uuid
;
1958 struct ctf_fs_trace
*trace
;
1961 * We have more than one trace, they must all share the same
1962 * UUID, verify that.
1964 for (i
= 0; i
< traces
->len
; i
++) {
1965 struct ctf_fs_trace
*this_trace
= (struct ctf_fs_trace
*) traces
->pdata
[i
];
1966 const uint8_t *this_trace_uuid
= this_trace
->metadata
->tc
->uuid
;
1968 if (!this_trace
->metadata
->tc
->is_uuid_set
) {
1969 BT_CLOGE_APPEND_CAUSE(
1970 "Multiple traces given, but a trace does not have a UUID: path=%s",
1971 this_trace
->path
->str
);
1975 if (bt_uuid_compare(first_trace_uuid
, this_trace_uuid
) != 0) {
1976 char first_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1977 char this_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1979 bt_uuid_to_str(first_trace_uuid
, first_trace_uuid_str
);
1980 bt_uuid_to_str(this_trace_uuid
, this_trace_uuid_str
);
1982 BT_CLOGE_APPEND_CAUSE("Multiple traces given, but UUIDs don't match: "
1983 "first-trace-uuid=%s, first-trace-path=%s, "
1984 "trace-uuid=%s, trace-path=%s",
1985 first_trace_uuid_str
, first_trace
->path
->str
,
1986 this_trace_uuid_str
, this_trace
->path
->str
);
1991 ret
= merge_ctf_fs_traces((struct ctf_fs_trace
**) traces
->pdata
, traces
->len
, &trace
);
1993 BT_CLOGE_APPEND_CAUSE("Failed to merge traces with the same UUID.");
1997 ctf_fs
->trace
= trace
;
1999 /* Just one trace, it may or may not have a UUID, both are fine. */
2000 ctf_fs
->trace
= (ctf_fs_trace
*) traces
->pdata
[0];
2001 traces
->pdata
[0] = NULL
;
2004 ret
= fix_packet_index_tracer_bugs(ctf_fs
);
2006 BT_CLOGE_APPEND_CAUSE("Failed to fix packet index tracer bugs.");
2010 * Sort data stream file groups by first data stream file info
2011 * path to get a deterministic order. This order influences the
2012 * order of the output ports. It also influences the order of
2013 * the automatic stream IDs if the trace's packet headers do not
2014 * contain a `stream_instance_id` field, in which case the data
2015 * stream file to stream ID association is always the same,
2016 * whatever the build and the system.
2018 * Having a deterministic order here can help debugging and
2021 g_ptr_array_sort(ctf_fs
->trace
->ds_file_groups
, compare_ds_file_groups_by_first_path
);
2028 g_ptr_array_free(traces
, TRUE
);
2032 g_ptr_array_free(paths
, TRUE
);
2038 static GString
*get_stream_instance_unique_name(struct ctf_fs_ds_file_group
*ds_file_group
)
2041 struct ctf_fs_ds_file_info
*ds_file_info
;
2043 name
= g_string_new(NULL
);
2049 * If there's more than one stream file in the stream file
2050 * group, the first (earliest) stream file's path is used as
2051 * the stream's unique name.
2053 BT_ASSERT(ds_file_group
->ds_file_infos
->len
> 0);
2054 ds_file_info
= (ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
2055 g_string_assign(name
, ds_file_info
->path
->str
);
2061 /* Create the IR stream objects for ctf_fs_trace. */
2063 static int create_streams_for_trace(struct ctf_fs_trace
*ctf_fs_trace
)
2066 GString
*name
= NULL
;
2068 const bt2_common::LogCfg
& logCfg
= ctf_fs_trace
->logCfg
;
2070 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
2071 ctf_fs_ds_file_group
*ds_file_group
=
2072 (ctf_fs_ds_file_group
*) g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
2073 name
= get_stream_instance_unique_name(ds_file_group
);
2079 BT_ASSERT(ds_file_group
->sc
->ir_sc
);
2080 BT_ASSERT(ctf_fs_trace
->trace
);
2082 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
2083 /* No stream ID: use 0 */
2084 ds_file_group
->stream
= bt_stream_create_with_id(
2085 ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
, ctf_fs_trace
->next_stream_id
);
2086 ctf_fs_trace
->next_stream_id
++;
2088 /* Specific stream ID */
2089 ds_file_group
->stream
= bt_stream_create_with_id(
2090 ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
, (uint64_t) ds_file_group
->stream_id
);
2093 if (!ds_file_group
->stream
) {
2094 BT_CLOGE_APPEND_CAUSE("Cannot create stream for DS file group: "
2095 "addr=%p, stream-name=\"%s\"",
2096 ds_file_group
, name
->str
);
2100 ret
= bt_stream_set_name(ds_file_group
->stream
, name
->str
);
2102 BT_CLOGE_APPEND_CAUSE("Cannot set stream's name: "
2103 "addr=%p, stream-name=\"%s\"",
2104 ds_file_group
->stream
, name
->str
);
2108 g_string_free(name
, TRUE
);
2121 g_string_free(name
, TRUE
);
2126 static const bt_param_validation_value_descr inputs_elem_descr
=
2127 bt_param_validation_value_descr::makeString();
2129 static bt_param_validation_map_value_entry_descr fs_params_entries_descr
[] = {
2130 {"inputs", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
2131 bt_param_validation_value_descr::makeArray(1, BT_PARAM_VALIDATION_INFINITE
,
2132 inputs_elem_descr
)},
2133 {"trace-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2134 bt_param_validation_value_descr::makeString()},
2135 {"clock-class-offset-s", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2136 bt_param_validation_value_descr::makeSignedInteger()},
2137 {"clock-class-offset-ns", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2138 bt_param_validation_value_descr::makeSignedInteger()},
2139 {"force-clock-class-origin-unix-epoch", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2140 bt_param_validation_value_descr::makeBool()},
2141 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
2143 bool read_src_fs_parameters(const bt_value
*params
, const bt_value
**inputs
,
2144 const bt_value
**trace_name
, struct ctf_fs_component
*ctf_fs
)
2147 const bt_value
*value
;
2148 enum bt_param_validation_status validate_value_status
;
2149 gchar
*error
= NULL
;
2150 const bt2_common::LogCfg
& logCfg
= ctf_fs
->logCfg
;
2152 validate_value_status
= bt_param_validation_validate(params
, fs_params_entries_descr
, &error
);
2153 if (validate_value_status
!= BT_PARAM_VALIDATION_STATUS_OK
) {
2154 BT_CLOGE_APPEND_CAUSE("%s", error
);
2159 /* inputs parameter */
2160 *inputs
= bt_value_map_borrow_entry_value_const(params
, "inputs");
2162 /* clock-class-offset-s parameter */
2163 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-s");
2165 ctf_fs
->metadata_config
.clock_class_offset_s
= bt_value_integer_signed_get(value
);
2168 /* clock-class-offset-ns parameter */
2169 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-ns");
2171 ctf_fs
->metadata_config
.clock_class_offset_ns
= bt_value_integer_signed_get(value
);
2174 /* force-clock-class-origin-unix-epoch parameter */
2175 value
= bt_value_map_borrow_entry_value_const(params
, "force-clock-class-origin-unix-epoch");
2177 ctf_fs
->metadata_config
.force_clock_class_origin_unix_epoch
= bt_value_bool_get(value
);
2180 /* trace-name parameter */
2181 *trace_name
= bt_value_map_borrow_entry_value_const(params
, "trace-name");
2190 static ctf_fs_component::UP
ctf_fs_create(const bt_value
*params
,
2191 bt_self_component_source
*self_comp_src
,
2192 const bt2_common::LogCfg
& logCfg
)
2194 const bt_value
*inputs_value
;
2195 const bt_value
*trace_name_value
;
2196 bt_self_component
*self_comp
= bt_self_component_source_as_self_component(self_comp_src
);
2198 ctf_fs_component::UP ctf_fs
= ctf_fs_component_create(logCfg
);
2203 if (!read_src_fs_parameters(params
, &inputs_value
, &trace_name_value
, ctf_fs
.get())) {
2207 if (ctf_fs_component_create_ctf_fs_trace(ctf_fs
.get(), inputs_value
, trace_name_value
,
2212 if (create_streams_for_trace(ctf_fs
->trace
)) {
2216 if (create_ports_for_trace(ctf_fs
.get(), ctf_fs
->trace
, self_comp_src
)) {
2224 bt_component_class_initialize_method_status
2225 ctf_fs_init(bt_self_component_source
*self_comp_src
, bt_self_component_source_configuration
*config
,
2226 const bt_value
*params
, __attribute__((unused
)) void *init_method_data
)
2228 bt_self_component
*selfComp
= bt_self_component_source_as_self_component(self_comp_src
);
2229 const bt_component
*comp
= bt_self_component_as_component(selfComp
);
2230 bt_logging_level logLevel
= bt_component_get_logging_level(comp
);
2231 bt2_common::LogCfg
logCfg(logLevel
, *selfComp
);
2234 ctf_fs_component::UP ctf_fs
= ctf_fs_create(params
, self_comp_src
, logCfg
);
2236 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
2239 bt_self_component_set_data(selfComp
, ctf_fs
.release());
2241 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
2242 } catch (const std::bad_alloc
&) {
2243 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
2244 } catch (const bt2_common::Error
&) {
2245 BT_CLOGE_APPEND_CAUSE("Failed to initialize component");
2246 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
2251 bt_component_class_query_method_status
ctf_fs_query(bt_self_component_class_source
*comp_class_src
,
2252 bt_private_query_executor
*priv_query_exec
,
2253 const char *object
, const bt_value
*params
,
2254 __attribute__((unused
)) void *method_data
,
2255 const bt_value
**result
)
2257 const bt_query_executor
*query_exec
=
2258 bt_private_query_executor_as_query_executor_const(priv_query_exec
);
2259 bt_logging_level log_level
= bt_query_executor_get_logging_level(query_exec
);
2260 bt_self_component_class
*comp_class
=
2261 bt_self_component_class_source_as_self_component_class(comp_class_src
);
2262 bt2_common::LogCfg
logCfg(log_level
, *comp_class
);
2265 bt2::ConstMapValue
paramsObj(params
);
2266 nonstd::optional
<bt2::Value::Shared
> resultObj
;
2268 if (strcmp(object
, "metadata-info") == 0) {
2269 resultObj
= metadata_info_query(paramsObj
, logCfg
);
2270 } else if (strcmp(object
, "babeltrace.trace-infos") == 0) {
2271 resultObj
= trace_infos_query(paramsObj
, logCfg
);
2272 } else if (!strcmp(object
, "babeltrace.support-info")) {
2273 resultObj
= support_info_query(paramsObj
, logCfg
);
2275 BT_LOGE("Unknown query object `%s`", object
);
2276 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;
2279 *result
= resultObj
->release().libObjPtr();
2281 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
2282 } catch (const std::bad_alloc
&) {
2283 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
2284 } catch (const bt2_common::Error
&) {
2285 BT_CLOGE_APPEND_CAUSE("Failed to execute query: object=%s", object
);
2286 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;