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 gchar
*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 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
;
433 const bt2_common::LogCfg
& logCfg
= ctf_fs
->logCfg
;
435 port_name
= ctf_fs_make_port_name(ds_file_group
);
440 BT_CLOGI("Creating one port named `%s`", port_name
);
442 /* Create output port for this file */
443 port_data
= new ctf_fs_port_data
;
444 port_data
->ctf_fs
= ctf_fs
;
445 port_data
->ds_file_group
= ds_file_group
;
446 ret
= bt_self_component_source_add_output_port(self_comp_src
, port_name
, port_data
, NULL
);
451 g_ptr_array_add(ctf_fs
->port_data
, port_data
);
461 port_data_destroy(port_data
);
465 static int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
466 struct ctf_fs_trace
*ctf_fs_trace
,
467 bt_self_component_source
*self_comp_src
)
471 const bt2_common::LogCfg
& logCfg
= ctf_fs
->logCfg
;
473 /* Create one output port for each stream file group */
474 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
475 struct ctf_fs_ds_file_group
*ds_file_group
=
476 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
478 ret
= create_one_port_for_trace(ctf_fs
, ctf_fs_trace
, ds_file_group
, self_comp_src
);
480 BT_CLOGE_APPEND_CAUSE("Cannot create output port.");
489 static void ctf_fs_ds_file_info_destroy(struct ctf_fs_ds_file_info
*ds_file_info
)
495 if (ds_file_info
->path
) {
496 g_string_free(ds_file_info
->path
, TRUE
);
502 static struct ctf_fs_ds_file_info
*ctf_fs_ds_file_info_create(const char *path
, int64_t begin_ns
)
504 ctf_fs_ds_file_info
*ds_file_info
= new ctf_fs_ds_file_info
;
505 ds_file_info
->path
= g_string_new(path
);
506 if (!ds_file_info
->path
) {
507 ctf_fs_ds_file_info_destroy(ds_file_info
);
512 ds_file_info
->begin_ns
= begin_ns
;
518 static void ctf_fs_ds_file_group_destroy(struct ctf_fs_ds_file_group
*ds_file_group
)
520 if (!ds_file_group
) {
524 if (ds_file_group
->ds_file_infos
) {
525 g_ptr_array_free(ds_file_group
->ds_file_infos
, TRUE
);
528 ctf_fs_ds_index_destroy(ds_file_group
->index
);
530 bt_stream_put_ref(ds_file_group
->stream
);
531 delete ds_file_group
;
534 static struct ctf_fs_ds_file_group
*ctf_fs_ds_file_group_create(struct ctf_fs_trace
*ctf_fs_trace
,
535 struct ctf_stream_class
*sc
,
536 uint64_t stream_instance_id
,
537 struct ctf_fs_ds_index
*index
)
539 ctf_fs_ds_file_group
*ds_file_group
= new ctf_fs_ds_file_group
;
540 ds_file_group
->ds_file_infos
=
541 g_ptr_array_new_with_free_func((GDestroyNotify
) ctf_fs_ds_file_info_destroy
);
542 if (!ds_file_group
->ds_file_infos
) {
546 ds_file_group
->index
= index
;
548 ds_file_group
->stream_id
= stream_instance_id
;
550 ds_file_group
->sc
= sc
;
551 ds_file_group
->ctf_fs_trace
= ctf_fs_trace
;
555 ctf_fs_ds_file_group_destroy(ds_file_group
);
556 ctf_fs_ds_index_destroy(index
);
557 ds_file_group
= NULL
;
560 return ds_file_group
;
563 /* Replace by g_ptr_array_insert when we depend on glib >= 2.40. */
564 static void array_insert(GPtrArray
*array
, gpointer element
, size_t pos
)
566 size_t original_array_len
= array
->len
;
568 /* Allocate an unused element at the end of the array. */
569 g_ptr_array_add(array
, NULL
);
571 /* If we are not inserting at the end, move the elements by one. */
572 if (pos
< original_array_len
) {
573 memmove(&(array
->pdata
[pos
+ 1]), &(array
->pdata
[pos
]),
574 (original_array_len
- pos
) * sizeof(gpointer
));
577 /* Insert the value. */
578 array
->pdata
[pos
] = element
;
582 * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right
583 * place to keep it sorted.
586 static void ds_file_group_insert_ds_file_info_sorted(struct ctf_fs_ds_file_group
*ds_file_group
,
587 struct ctf_fs_ds_file_info
*ds_file_info
)
591 /* Find the spot where to insert this ds_file_info. */
592 for (i
= 0; i
< ds_file_group
->ds_file_infos
->len
; i
++) {
593 struct ctf_fs_ds_file_info
*other_ds_file_info
=
594 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, i
);
596 if (ds_file_info
->begin_ns
< other_ds_file_info
->begin_ns
) {
601 array_insert(ds_file_group
->ds_file_infos
, ds_file_info
, i
);
604 static bool ds_index_entries_equal(const struct ctf_fs_ds_index_entry
*left
,
605 const struct ctf_fs_ds_index_entry
*right
)
607 if (left
->packet_size
!= right
->packet_size
) {
611 if (left
->timestamp_begin
!= right
->timestamp_begin
) {
615 if (left
->timestamp_end
!= right
->timestamp_end
) {
619 if (left
->packet_seq_num
!= right
->packet_seq_num
) {
627 * Insert `entry` into `index`, without duplication.
629 * The entry is inserted only if there isn't an identical entry already.
631 * In any case, the ownership of `entry` is transferred to this function. So if
632 * the entry is not inserted, it is freed.
635 static void ds_index_insert_ds_index_entry_sorted(struct ctf_fs_ds_index
*index
,
636 struct ctf_fs_ds_index_entry
*entry
)
639 struct ctf_fs_ds_index_entry
*other_entry
= NULL
;
641 /* Find the spot where to insert this index entry. */
642 for (i
= 0; i
< index
->entries
->len
; i
++) {
643 other_entry
= (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, i
);
645 if (entry
->timestamp_begin_ns
<= other_entry
->timestamp_begin_ns
) {
651 * Insert the entry only if a duplicate doesn't already exist.
653 * There can be duplicate packets if reading multiple overlapping
654 * snapshots of the same trace. We then want the index to contain
655 * a reference to only one copy of that packet.
657 if (i
== index
->entries
->len
|| !ds_index_entries_equal(entry
, other_entry
)) {
658 array_insert(index
->entries
, entry
, i
);
664 static void merge_ctf_fs_ds_indexes(struct ctf_fs_ds_index
*dest
, struct ctf_fs_ds_index
*src
)
668 for (i
= 0; i
< src
->entries
->len
; i
++) {
669 struct ctf_fs_ds_index_entry
*entry
=
670 (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(src
->entries
, i
);
673 * Ownership of the ctf_fs_ds_index_entry is transferred to
674 * ds_index_insert_ds_index_entry_sorted.
676 g_ptr_array_index(src
->entries
, i
) = NULL
;
677 ds_index_insert_ds_index_entry_sorted(dest
, entry
);
681 static int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
, const char *path
)
683 int64_t stream_instance_id
= -1;
684 int64_t begin_ns
= -1;
685 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
686 bool add_group
= false;
689 struct ctf_fs_ds_file
*ds_file
= NULL
;
690 struct ctf_fs_ds_file_info
*ds_file_info
= NULL
;
691 struct ctf_fs_ds_index
*index
= NULL
;
692 struct ctf_msg_iter
*msg_iter
= NULL
;
693 struct ctf_stream_class
*sc
= NULL
;
694 struct ctf_msg_iter_packet_properties props
;
695 const bt2_common::LogCfg
& logCfg
= ctf_fs_trace
->logCfg
;
698 * Create a temporary ds_file to read some properties about the data
701 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, path
, logCfg
);
706 /* Create a temporary iterator to read the ds_file. */
707 msg_iter
= ctf_msg_iter_create(ctf_fs_trace
->metadata
->tc
,
708 bt_common_get_page_size(logCfg
.logLevel()) * 8,
709 ctf_fs_ds_file_medops
, ds_file
, nullptr, logCfg
);
711 BT_CLOGE_STR("Cannot create a CTF message iterator.");
715 ctf_msg_iter_set_dry_run(msg_iter
, true);
717 ret
= ctf_msg_iter_get_packet_properties(msg_iter
, &props
);
719 BT_CLOGE_APPEND_CAUSE(
720 "Cannot get stream file's first packet's header and context fields (`%s`).", path
);
724 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
, props
.stream_class_id
);
726 stream_instance_id
= props
.data_stream_id
;
728 if (props
.snapshots
.beginning_clock
!= UINT64_C(-1)) {
729 BT_ASSERT(sc
->default_clock_class
);
730 ret
= bt_util_clock_cycles_to_ns_from_origin(
731 props
.snapshots
.beginning_clock
, sc
->default_clock_class
->frequency
,
732 sc
->default_clock_class
->offset_seconds
, sc
->default_clock_class
->offset_cycles
,
735 BT_CLOGE_APPEND_CAUSE("Cannot convert clock cycles to nanoseconds from origin (`%s`).",
741 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
);
746 index
= ctf_fs_ds_file_build_index(ds_file
, ds_file_info
, msg_iter
);
748 BT_CLOGE_APPEND_CAUSE("Failed to index CTF stream file \'%s\'", ds_file
->file
->path
->str
);
752 if (begin_ns
== -1) {
754 * No beginning timestamp to sort the stream files
755 * within a stream file group, so consider that this
756 * file must be the only one within its group.
758 stream_instance_id
= -1;
761 if (stream_instance_id
== -1) {
763 * No stream instance ID or no beginning timestamp:
764 * create a unique stream file group for this stream
765 * file because, even if there's a stream instance ID,
766 * there's no timestamp to order the file within its
769 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, UINT64_C(-1), index
);
770 /* Ownership of index is transferred. */
773 if (!ds_file_group
) {
777 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, BT_MOVE_REF(ds_file_info
));
783 BT_ASSERT(stream_instance_id
!= -1);
784 BT_ASSERT(begin_ns
!= -1);
786 /* Find an existing stream file group with this ID */
787 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
789 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
791 if (ds_file_group
->sc
== sc
&& ds_file_group
->stream_id
== stream_instance_id
) {
795 ds_file_group
= NULL
;
798 if (!ds_file_group
) {
799 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, stream_instance_id
, index
);
800 /* Ownership of index is transferred. */
802 if (!ds_file_group
) {
808 merge_ctf_fs_ds_indexes(ds_file_group
->index
, index
);
811 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, BT_MOVE_REF(ds_file_info
));
816 ctf_fs_ds_file_group_destroy(ds_file_group
);
817 ds_file_group
= NULL
;
821 if (add_group
&& ds_file_group
) {
822 g_ptr_array_add(ctf_fs_trace
->ds_file_groups
, ds_file_group
);
825 ctf_fs_ds_file_destroy(ds_file
);
826 ctf_fs_ds_file_info_destroy(ds_file_info
);
829 ctf_msg_iter_destroy(msg_iter
);
832 ctf_fs_ds_index_destroy(index
);
836 static int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
839 const char *basename
;
840 GError
*error
= NULL
;
842 const bt2_common::LogCfg
& logCfg
= ctf_fs_trace
->logCfg
;
844 /* Check each file in the path directory, except specific ones */
845 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
847 BT_CLOGE_APPEND_CAUSE("Cannot open directory `%s`: %s (code %d)", ctf_fs_trace
->path
->str
,
848 error
->message
, error
->code
);
852 while ((basename
= g_dir_read_name(dir
))) {
853 struct ctf_fs_file
*file
;
855 if (strcmp(basename
, CTF_FS_METADATA_FILENAME
) == 0) {
856 /* Ignore the metadata stream. */
857 BT_CLOGI("Ignoring metadata file `%s" G_DIR_SEPARATOR_S
"%s`", ctf_fs_trace
->path
->str
,
862 if (basename
[0] == '.') {
863 BT_CLOGI("Ignoring hidden file `%s" G_DIR_SEPARATOR_S
"%s`", ctf_fs_trace
->path
->str
,
868 /* Create the file. */
869 file
= ctf_fs_file_create(logCfg
);
871 BT_CLOGE_APPEND_CAUSE("Cannot create stream file object for file `%s" G_DIR_SEPARATOR_S
873 ctf_fs_trace
->path
->str
, basename
);
877 /* Create full path string. */
878 g_string_append_printf(file
->path
, "%s" G_DIR_SEPARATOR_S
"%s", ctf_fs_trace
->path
->str
,
880 if (!g_file_test(file
->path
->str
, G_FILE_TEST_IS_REGULAR
)) {
881 BT_CLOGI("Ignoring non-regular file `%s`", file
->path
->str
);
882 ctf_fs_file_destroy(file
);
887 ret
= ctf_fs_file_open(file
, "rb");
889 BT_CLOGE_APPEND_CAUSE("Cannot open stream file `%s`", file
->path
->str
);
893 if (file
->size
== 0) {
894 /* Skip empty stream. */
895 BT_CLOGI("Ignoring empty file `%s`", file
->path
->str
);
896 ctf_fs_file_destroy(file
);
900 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
, file
->path
->str
);
902 BT_CLOGE_APPEND_CAUSE("Cannot add stream file `%s` to stream file group",
904 ctf_fs_file_destroy(file
);
908 ctf_fs_file_destroy(file
);
929 static int set_trace_name(bt_trace
*trace
, const char *name_suffix
,
930 const bt2_common::LogCfg
& logCfg
)
936 name
= g_string_new(NULL
);
938 BT_CLOGE_STR("Failed to allocate a GString.");
944 * Check if we have a trace environment string value named `hostname`.
945 * If so, use it as the trace name's prefix.
947 val
= bt_trace_borrow_environment_entry_value_by_name_const(trace
, "hostname");
948 if (val
&& bt_value_is_string(val
)) {
949 g_string_append(name
, bt_value_string_get(val
));
952 g_string_append_c(name
, G_DIR_SEPARATOR
);
957 g_string_append(name
, name_suffix
);
960 ret
= bt_trace_set_name(trace
, name
->str
);
969 g_string_free(name
, TRUE
);
975 static struct ctf_fs_trace
*ctf_fs_trace_create(const char *path
, const char *name
,
976 struct ctf_fs_metadata_config
*metadata_config
,
977 bt_self_component
*selfComp
,
978 const bt2_common::LogCfg
& logCfg
)
982 ctf_fs_trace
*ctf_fs_trace
= new struct ctf_fs_trace(logCfg
);
983 ctf_fs_trace
->path
= g_string_new(path
);
984 if (!ctf_fs_trace
->path
) {
988 ctf_fs_trace
->metadata
= new ctf_fs_metadata
;
989 ctf_fs_metadata_init(ctf_fs_trace
->metadata
);
990 ctf_fs_trace
->ds_file_groups
=
991 g_ptr_array_new_with_free_func((GDestroyNotify
) ctf_fs_ds_file_group_destroy
);
992 if (!ctf_fs_trace
->ds_file_groups
) {
996 ret
= ctf_fs_metadata_set_trace_class(ctf_fs_trace
, metadata_config
, selfComp
, logCfg
);
1001 if (ctf_fs_trace
->metadata
->trace_class
) {
1002 ctf_fs_trace
->trace
= bt_trace_create(ctf_fs_trace
->metadata
->trace_class
);
1003 if (!ctf_fs_trace
->trace
) {
1008 if (ctf_fs_trace
->trace
) {
1009 ret
= ctf_trace_class_configure_ir_trace(ctf_fs_trace
->metadata
->tc
, ctf_fs_trace
->trace
);
1014 ret
= set_trace_name(ctf_fs_trace
->trace
, name
, logCfg
);
1020 ret
= create_ds_file_groups(ctf_fs_trace
);
1028 ctf_fs_trace_destroy(ctf_fs_trace
);
1029 ctf_fs_trace
= NULL
;
1032 return ctf_fs_trace
;
1035 static int path_is_ctf_trace(const char *path
)
1037 GString
*metadata_path
= g_string_new(NULL
);
1040 if (!metadata_path
) {
1045 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
1047 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
1053 g_string_free(metadata_path
, TRUE
);
1057 /* Helper for ctf_fs_component_create_ctf_fs_trace, to handle a single path. */
1059 static int ctf_fs_component_create_ctf_fs_trace_one_path(struct ctf_fs_component
*ctf_fs
,
1060 const char *path_param
,
1061 const char *trace_name
, GPtrArray
*traces
,
1062 bt_self_component
*selfComp
)
1064 struct ctf_fs_trace
*ctf_fs_trace
;
1067 const bt2_common::LogCfg
& logCfg
= ctf_fs
->logCfg
;
1069 norm_path
= bt_common_normalize_path(path_param
, NULL
);
1071 BT_CLOGE_APPEND_CAUSE("Failed to normalize path: `%s`.", path_param
);
1075 ret
= path_is_ctf_trace(norm_path
->str
);
1077 BT_CLOGE_APPEND_CAUSE("Failed to check if path is a CTF trace: path=%s", norm_path
->str
);
1079 } else if (ret
== 0) {
1080 BT_CLOGE_APPEND_CAUSE("Path is not a CTF trace (does not contain a metadata file): `%s`.",
1085 // FIXME: Remove or ifdef for __MINGW32__
1086 if (strcmp(norm_path
->str
, "/") == 0) {
1087 BT_CLOGE_APPEND_CAUSE("Opening a trace in `/` is not supported.");
1093 ctf_fs_trace_create(norm_path
->str
, trace_name
, &ctf_fs
->metadata_config
, selfComp
, logCfg
);
1094 if (!ctf_fs_trace
) {
1095 BT_CLOGE_APPEND_CAUSE("Cannot create trace for `%s`.", norm_path
->str
);
1099 g_ptr_array_add(traces
, ctf_fs_trace
);
1100 ctf_fs_trace
= NULL
;
1110 g_string_free(norm_path
, TRUE
);
1117 * Count the number of stream and event classes defined by this trace's metadata.
1119 * This is used to determine which metadata is the "latest", out of multiple
1120 * traces sharing the same UUID. It is assumed that amongst all these metadatas,
1121 * a bigger metadata is a superset of a smaller metadata. Therefore, it is
1122 * enough to just count the classes.
1125 static unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace
*trace
)
1127 unsigned int num
= trace
->metadata
->tc
->stream_classes
->len
;
1130 for (i
= 0; i
< trace
->metadata
->tc
->stream_classes
->len
; i
++) {
1131 struct ctf_stream_class
*sc
=
1132 (struct ctf_stream_class
*) trace
->metadata
->tc
->stream_classes
->pdata
[i
];
1133 num
+= sc
->event_classes
->len
;
1140 * Merge the src ds_file_group into dest. This consists of merging their
1141 * ds_file_infos, making sure to keep the result sorted.
1144 static void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group
*dest
,
1145 struct ctf_fs_ds_file_group
*src
)
1149 for (i
= 0; i
< src
->ds_file_infos
->len
; i
++) {
1150 struct ctf_fs_ds_file_info
*ds_file_info
=
1151 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(src
->ds_file_infos
, i
);
1153 /* Ownership of the ds_file_info is transferred to dest. */
1154 g_ptr_array_index(src
->ds_file_infos
, i
) = NULL
;
1156 ds_file_group_insert_ds_file_info_sorted(dest
, ds_file_info
);
1159 /* Merge both indexes. */
1160 merge_ctf_fs_ds_indexes(dest
->index
, src
->index
);
1162 /* Merge src_trace's data stream file groups into dest_trace's. */
1164 static int merge_matching_ctf_fs_ds_file_groups(struct ctf_fs_trace
*dest_trace
,
1165 struct ctf_fs_trace
*src_trace
)
1167 GPtrArray
*dest
= dest_trace
->ds_file_groups
;
1168 GPtrArray
*src
= src_trace
->ds_file_groups
;
1173 * Save the initial length of dest: we only want to check against the
1174 * original elements in the inner loop.
1176 const guint dest_len
= dest
->len
;
1178 for (s_i
= 0; s_i
< src
->len
; s_i
++) {
1179 struct ctf_fs_ds_file_group
*src_group
=
1180 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(src
, s_i
);
1181 struct ctf_fs_ds_file_group
*dest_group
= NULL
;
1183 /* A stream instance without ID can't match a stream in the other trace. */
1184 if (src_group
->stream_id
!= -1) {
1187 /* Let's search for a matching ds_file_group in the destination. */
1188 for (d_i
= 0; d_i
< dest_len
; d_i
++) {
1189 struct ctf_fs_ds_file_group
*candidate_dest
=
1190 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(dest
, d_i
);
1192 /* Can't match a stream instance without ID. */
1193 if (candidate_dest
->stream_id
== -1) {
1198 * If the two groups have the same stream instance id
1199 * and belong to the same stream class (stream instance
1200 * ids are per-stream class), they represent the same
1203 if (candidate_dest
->stream_id
!= src_group
->stream_id
||
1204 candidate_dest
->sc
->id
!= src_group
->sc
->id
) {
1208 dest_group
= candidate_dest
;
1214 * Didn't find a friend in dest to merge our src_group into?
1215 * Create a new empty one. This can happen if a stream was
1216 * active in the source trace chunk but not in the destination
1220 struct ctf_stream_class
*sc
;
1221 struct ctf_fs_ds_index
*index
;
1223 sc
= ctf_trace_class_borrow_stream_class_by_id(dest_trace
->metadata
->tc
,
1227 index
= ctf_fs_ds_index_create(dest_trace
->logCfg
);
1233 dest_group
= ctf_fs_ds_file_group_create(dest_trace
, sc
, src_group
->stream_id
, index
);
1234 /* Ownership of index is transferred. */
1241 g_ptr_array_add(dest_trace
->ds_file_groups
, dest_group
);
1244 BT_ASSERT(dest_group
);
1245 merge_ctf_fs_ds_file_groups(dest_group
, src_group
);
1253 * Collapse the given traces, which must all share the same UUID, in a single
1256 * The trace with the most expansive metadata is chosen and all other traces
1257 * are merged into that one. The array slots of all the traces that get merged
1258 * in the chosen one are set to NULL, so only the slot of the chosen trace
1262 static int merge_ctf_fs_traces(struct ctf_fs_trace
**traces
, unsigned int num_traces
,
1263 struct ctf_fs_trace
**out_trace
)
1265 unsigned int winner_count
;
1266 struct ctf_fs_trace
*winner
;
1270 BT_ASSERT(num_traces
>= 2);
1272 winner_count
= metadata_count_stream_and_event_classes(traces
[0]);
1276 /* Find the trace with the largest metadata. */
1277 for (i
= 1; i
< num_traces
; i
++) {
1278 struct ctf_fs_trace
*candidate
;
1279 unsigned int candidate_count
;
1281 candidate
= traces
[i
];
1283 /* A bit of sanity check. */
1284 BT_ASSERT(bt_uuid_compare(winner
->metadata
->tc
->uuid
, candidate
->metadata
->tc
->uuid
) == 0);
1286 candidate_count
= metadata_count_stream_and_event_classes(candidate
);
1288 if (candidate_count
> winner_count
) {
1289 winner_count
= candidate_count
;
1295 /* Merge all the other traces in the winning trace. */
1296 for (i
= 0; i
< num_traces
; i
++) {
1297 struct ctf_fs_trace
*trace
= traces
[i
];
1299 /* Don't merge the winner into itself. */
1300 if (trace
== winner
) {
1304 /* Merge trace's data stream file groups into winner's. */
1305 ret
= merge_matching_ctf_fs_ds_file_groups(winner
, trace
);
1312 * Move the winner out of the array, into `*out_trace`.
1314 *out_trace
= winner
;
1315 traces
[winner_i
] = NULL
;
1327 static int decode_clock_snapshot_after_event(struct ctf_fs_trace
*ctf_fs_trace
,
1328 struct ctf_clock_class
*default_cc
,
1329 struct ctf_fs_ds_index_entry
*index_entry
,
1330 enum target_event target_event
, uint64_t *cs
,
1333 enum ctf_msg_iter_status iter_status
= CTF_MSG_ITER_STATUS_OK
;
1334 struct ctf_fs_ds_file
*ds_file
= NULL
;
1335 struct ctf_msg_iter
*msg_iter
= NULL
;
1336 const bt2_common::LogCfg
& logCfg
= ctf_fs_trace
->logCfg
;
1339 BT_ASSERT(ctf_fs_trace
);
1340 BT_ASSERT(index_entry
);
1341 BT_ASSERT(index_entry
->path
);
1343 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, index_entry
->path
, logCfg
);
1345 BT_CLOGE_APPEND_CAUSE("Failed to create a ctf_fs_ds_file");
1350 BT_ASSERT(ctf_fs_trace
->metadata
);
1351 BT_ASSERT(ctf_fs_trace
->metadata
->tc
);
1353 msg_iter
= ctf_msg_iter_create(ctf_fs_trace
->metadata
->tc
,
1354 bt_common_get_page_size(logCfg
.logLevel()) * 8,
1355 ctf_fs_ds_file_medops
, ds_file
, NULL
, logCfg
);
1357 /* ctf_msg_iter_create() logs errors. */
1363 * Turn on dry run mode to prevent the creation and usage of Babeltrace
1364 * library objects (bt_field, bt_message_*, etc.).
1366 ctf_msg_iter_set_dry_run(msg_iter
, true);
1368 /* Seek to the beginning of the target packet. */
1369 iter_status
= ctf_msg_iter_seek(msg_iter
, index_entry
->offset
);
1371 /* ctf_msg_iter_seek() logs errors. */
1376 switch (target_event
) {
1379 * Start to decode the packet until we reach the end of
1380 * the first event. To extract the first event's clock
1383 iter_status
= ctf_msg_iter_curr_packet_first_event_clock_snapshot(msg_iter
, cs
);
1386 /* Decode the packet to extract the last event's clock snapshot. */
1387 iter_status
= ctf_msg_iter_curr_packet_last_event_clock_snapshot(msg_iter
, cs
);
1397 /* Convert clock snapshot to timestamp. */
1398 ret
= bt_util_clock_cycles_to_ns_from_origin(
1399 *cs
, default_cc
->frequency
, default_cc
->offset_seconds
, default_cc
->offset_cycles
, ts_ns
);
1401 BT_CLOGE_APPEND_CAUSE("Failed to convert clock snapshot to timestamp");
1407 ctf_fs_ds_file_destroy(ds_file
);
1410 ctf_msg_iter_destroy(msg_iter
);
1416 static int decode_packet_first_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1417 struct ctf_clock_class
*default_cc
,
1418 struct ctf_fs_ds_index_entry
*index_entry
,
1419 uint64_t *cs
, int64_t *ts_ns
)
1421 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, FIRST_EVENT
, cs
,
1425 static int decode_packet_last_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1426 struct ctf_clock_class
*default_cc
,
1427 struct ctf_fs_ds_index_entry
*index_entry
,
1428 uint64_t *cs
, int64_t *ts_ns
)
1430 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, LAST_EVENT
, cs
,
1435 * Fix up packet index entries for lttng's "event-after-packet" bug.
1436 * Some buggy lttng tracer versions may emit events with a timestamp that is
1437 * larger (after) than the timestamp_end of the their packets.
1439 * To fix up this erroneous data we do the following:
1440 * 1. If it's not the stream file's last packet: set the packet index entry's
1441 * end time to the next packet's beginning time.
1442 * 2. If it's the stream file's last packet, set the packet index entry's end
1443 * time to the packet's last event's time, if any, or to the packet's
1444 * beginning time otherwise.
1446 * Known buggy tracer versions:
1447 * - before lttng-ust 2.11.0
1448 * - before lttng-module 2.11.0
1449 * - before lttng-module 2.10.10
1450 * - before lttng-module 2.9.13
1452 static int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace
*trace
)
1455 guint ds_file_group_i
;
1456 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1457 const bt2_common::LogCfg
& logCfg
= trace
->logCfg
;
1459 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
; ds_file_group_i
++) {
1461 struct ctf_clock_class
*default_cc
;
1462 struct ctf_fs_ds_index_entry
*last_entry
;
1463 struct ctf_fs_ds_index
*index
;
1465 struct ctf_fs_ds_file_group
*ds_file_group
=
1466 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1468 BT_ASSERT(ds_file_group
);
1469 index
= ds_file_group
->index
;
1472 BT_ASSERT(index
->entries
);
1473 BT_ASSERT(index
->entries
->len
> 0);
1476 * Iterate over all entries but the last one. The last one is
1477 * fixed differently after.
1479 for (entry_i
= 0; entry_i
< index
->entries
->len
- 1; entry_i
++) {
1480 struct ctf_fs_ds_index_entry
*curr_entry
, *next_entry
;
1482 curr_entry
= (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
);
1483 next_entry
= (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
+ 1);
1486 * 1. Set the current index entry `end` timestamp to
1487 * the next index entry `begin` timestamp.
1489 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1490 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1494 * 2. Fix the last entry by decoding the last event of the last
1498 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, index
->entries
->len
- 1);
1499 BT_ASSERT(last_entry
);
1501 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1502 default_cc
= ds_file_group
->sc
->default_clock_class
;
1505 * Decode packet to read the timestamp of the last event of the
1508 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1509 &last_entry
->timestamp_end
,
1510 &last_entry
->timestamp_end_ns
);
1512 BT_CLOGE_APPEND_CAUSE(
1513 "Failed to decode stream's last packet to get its last event's clock snapshot.");
1523 * Fix up packet index entries for barectf's "event-before-packet" bug.
1524 * Some buggy barectf tracer versions may emit events with a timestamp that is
1525 * less than the timestamp_begin of the their packets.
1527 * To fix up this erroneous data we do the following:
1528 * 1. Starting at the second index entry, set the timestamp_begin of the
1529 * current entry to the timestamp of the first event of the packet.
1530 * 2. Set the previous entry's timestamp_end to the timestamp_begin of the
1533 * Known buggy tracer versions:
1534 * - before barectf 2.3.1
1536 static int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace
*trace
)
1539 guint ds_file_group_i
;
1540 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1541 const bt2_common::LogCfg
& logCfg
= trace
->logCfg
;
1543 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
; ds_file_group_i
++) {
1545 struct ctf_clock_class
*default_cc
;
1546 ctf_fs_ds_file_group
*ds_file_group
=
1547 (ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1549 struct ctf_fs_ds_index
*index
= ds_file_group
->index
;
1552 BT_ASSERT(index
->entries
);
1553 BT_ASSERT(index
->entries
->len
> 0);
1555 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1556 default_cc
= ds_file_group
->sc
->default_clock_class
;
1559 * 1. Iterate over the index, starting from the second entry
1562 for (entry_i
= 1; entry_i
< index
->entries
->len
; entry_i
++) {
1563 ctf_fs_ds_index_entry
*prev_entry
=
1564 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
- 1);
1565 ctf_fs_ds_index_entry
*curr_entry
=
1566 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
);
1568 * 2. Set the current entry `begin` timestamp to the
1569 * timestamp of the first event of the current packet.
1571 ret
= decode_packet_first_event_timestamp(trace
, default_cc
, curr_entry
,
1572 &curr_entry
->timestamp_begin
,
1573 &curr_entry
->timestamp_begin_ns
);
1575 BT_CLOGE_APPEND_CAUSE("Failed to decode first event's clock snapshot");
1580 * 3. Set the previous entry `end` timestamp to the
1581 * timestamp of the first event of the current packet.
1583 prev_entry
->timestamp_end
= curr_entry
->timestamp_begin
;
1584 prev_entry
->timestamp_end_ns
= curr_entry
->timestamp_begin_ns
;
1592 * When using the lttng-crash feature it's likely that the last packets of each
1593 * stream have their timestamp_end set to zero. This is caused by the fact that
1594 * the tracer crashed and was not able to properly close the packets.
1596 * To fix up this erroneous data we do the following:
1597 * For each index entry, if the entry's timestamp_end is 0 and the
1598 * timestamp_begin is not 0:
1599 * - If it's the stream file's last packet: set the packet index entry's end
1600 * time to the packet's last event's time, if any, or to the packet's
1601 * beginning time otherwise.
1602 * - If it's not the stream file's last packet: set the packet index
1603 * entry's end time to the next packet's beginning time.
1605 * Affected versions:
1606 * - All current and future lttng-ust and lttng-modules versions.
1608 static int fix_index_lttng_crash_quirk(struct ctf_fs_trace
*trace
)
1611 guint ds_file_group_idx
;
1612 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1613 const bt2_common::LogCfg
& logCfg
= trace
->logCfg
;
1615 for (ds_file_group_idx
= 0; ds_file_group_idx
< ds_file_groups
->len
; ds_file_group_idx
++) {
1617 struct ctf_clock_class
*default_cc
;
1618 struct ctf_fs_ds_index
*index
;
1620 ctf_fs_ds_file_group
*ds_file_group
=
1621 (ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_idx
);
1623 BT_ASSERT(ds_file_group
);
1624 index
= ds_file_group
->index
;
1626 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1627 default_cc
= ds_file_group
->sc
->default_clock_class
;
1630 BT_ASSERT(index
->entries
);
1631 BT_ASSERT(index
->entries
->len
> 0);
1633 ctf_fs_ds_index_entry
*last_entry
=
1634 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, index
->entries
->len
- 1);
1635 BT_ASSERT(last_entry
);
1637 /* 1. Fix the last entry first. */
1638 if (last_entry
->timestamp_end
== 0 && last_entry
->timestamp_begin
!= 0) {
1640 * Decode packet to read the timestamp of the
1641 * last event of the stream file.
1643 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1644 &last_entry
->timestamp_end
,
1645 &last_entry
->timestamp_end_ns
);
1647 BT_CLOGE_APPEND_CAUSE("Failed to decode last event's clock snapshot");
1652 /* Iterate over all entries but the last one. */
1653 for (entry_idx
= 0; entry_idx
< index
->entries
->len
- 1; entry_idx
++) {
1654 ctf_fs_ds_index_entry
*curr_entry
=
1655 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_idx
);
1656 ctf_fs_ds_index_entry
*next_entry
=
1657 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_idx
+ 1);
1659 if (curr_entry
->timestamp_end
== 0 && curr_entry
->timestamp_begin
!= 0) {
1661 * 2. Set the current index entry `end` timestamp to
1662 * the next index entry `begin` timestamp.
1664 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1665 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1675 * Extract the tracer information necessary to compare versions.
1676 * Returns 0 on success, and -1 if the extraction is not successful because the
1677 * necessary fields are absents in the trace metadata.
1679 static int extract_tracer_info(struct ctf_fs_trace
*trace
, struct tracer_info
*current_tracer_info
)
1682 struct ctf_trace_class_env_entry
*entry
;
1684 /* Clear the current_tracer_info struct */
1685 memset(current_tracer_info
, 0, sizeof(*current_tracer_info
));
1688 * To compare 2 tracer versions, at least the tracer name and it's
1689 * major version are needed. If one of these is missing, consider it an
1690 * extraction failure.
1692 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_name");
1693 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR
) {
1694 goto missing_bare_minimum
;
1697 /* Set tracer name. */
1698 current_tracer_info
->name
= entry
->value
.str
->str
;
1700 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_major");
1701 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1702 goto missing_bare_minimum
;
1705 /* Set major version number. */
1706 current_tracer_info
->major
= entry
->value
.i
;
1708 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_minor");
1709 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1713 /* Set minor version number. */
1714 current_tracer_info
->minor
= entry
->value
.i
;
1716 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patch");
1719 * If `tracer_patch` doesn't exist `tracer_patchlevel` might.
1720 * For example, `lttng-modules` uses entry name
1721 * `tracer_patchlevel`.
1723 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patchlevel");
1726 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1730 /* Set patch version number. */
1731 current_tracer_info
->patch
= entry
->value
.i
;
1735 missing_bare_minimum
:
1741 static bool is_tracer_affected_by_lttng_event_after_packet_bug(struct tracer_info
*curr_tracer_info
)
1743 bool is_affected
= false;
1745 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1746 if (curr_tracer_info
->major
< 2) {
1748 } else if (curr_tracer_info
->major
== 2) {
1749 /* fixed in lttng-ust 2.11.0 */
1750 if (curr_tracer_info
->minor
< 11) {
1754 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1755 if (curr_tracer_info
->major
< 2) {
1757 } else if (curr_tracer_info
->major
== 2) {
1758 /* fixed in lttng-modules 2.11.0 */
1759 if (curr_tracer_info
->minor
== 10) {
1760 /* fixed in lttng-modules 2.10.10 */
1761 if (curr_tracer_info
->patch
< 10) {
1764 } else if (curr_tracer_info
->minor
== 9) {
1765 /* fixed in lttng-modules 2.9.13 */
1766 if (curr_tracer_info
->patch
< 13) {
1769 } else if (curr_tracer_info
->minor
< 9) {
1779 is_tracer_affected_by_barectf_event_before_packet_bug(struct tracer_info
*curr_tracer_info
)
1781 bool is_affected
= false;
1783 if (strcmp(curr_tracer_info
->name
, "barectf") == 0) {
1784 if (curr_tracer_info
->major
< 2) {
1786 } else if (curr_tracer_info
->major
== 2) {
1787 if (curr_tracer_info
->minor
< 3) {
1789 } else if (curr_tracer_info
->minor
== 3) {
1790 /* fixed in barectf 2.3.1 */
1791 if (curr_tracer_info
->patch
< 1) {
1801 static bool is_tracer_affected_by_lttng_crash_quirk(struct tracer_info
*curr_tracer_info
)
1803 bool is_affected
= false;
1805 /* All LTTng tracer may be affected by this lttng crash quirk. */
1806 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1808 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1816 * Looks for trace produced by known buggy tracers and fix up the index
1819 static int fix_packet_index_tracer_bugs(struct ctf_fs_component
*ctf_fs
)
1822 struct tracer_info current_tracer_info
;
1823 const bt2_common::LogCfg
& logCfg
= ctf_fs
->logCfg
;
1825 ret
= extract_tracer_info(ctf_fs
->trace
, ¤t_tracer_info
);
1828 * A trace may not have all the necessary environment
1829 * entries to do the tracer version comparison.
1830 * At least, the tracer name and major version number
1831 * are needed. Failing to extract these entries is not
1835 BT_LOGI_STR("Cannot extract tracer information necessary to compare with buggy versions.");
1840 /* Check if the trace may be affected by old tracer bugs. */
1841 if (is_tracer_affected_by_lttng_event_after_packet_bug(¤t_tracer_info
)) {
1842 BT_LOGI_STR("Trace may be affected by LTTng tracer packet timestamp bug. Fixing up.");
1843 ret
= fix_index_lttng_event_after_packet_bug(ctf_fs
->trace
);
1845 BT_CLOGE_APPEND_CAUSE("Failed to fix LTTng event-after-packet bug.");
1848 ctf_fs
->trace
->metadata
->tc
->quirks
.lttng_event_after_packet
= true;
1851 if (is_tracer_affected_by_barectf_event_before_packet_bug(¤t_tracer_info
)) {
1852 BT_LOGI_STR("Trace may be affected by barectf tracer packet timestamp bug. Fixing up.");
1853 ret
= fix_index_barectf_event_before_packet_bug(ctf_fs
->trace
);
1855 BT_CLOGE_APPEND_CAUSE("Failed to fix barectf event-before-packet bug.");
1858 ctf_fs
->trace
->metadata
->tc
->quirks
.barectf_event_before_packet
= true;
1861 if (is_tracer_affected_by_lttng_crash_quirk(¤t_tracer_info
)) {
1862 ret
= fix_index_lttng_crash_quirk(ctf_fs
->trace
);
1864 BT_CLOGE_APPEND_CAUSE("Failed to fix lttng-crash timestamp quirks.");
1867 ctf_fs
->trace
->metadata
->tc
->quirks
.lttng_crash
= true;
1874 static gint
compare_ds_file_groups_by_first_path(gconstpointer a
, gconstpointer b
)
1876 ctf_fs_ds_file_group
* const *ds_file_group_a
= (ctf_fs_ds_file_group
**) a
;
1877 ctf_fs_ds_file_group
* const *ds_file_group_b
= (ctf_fs_ds_file_group
**) b
;
1879 BT_ASSERT((*ds_file_group_a
)->ds_file_infos
->len
> 0);
1880 BT_ASSERT((*ds_file_group_b
)->ds_file_infos
->len
> 0);
1882 const ctf_fs_ds_file_info
*first_ds_file_info_a
=
1883 (const ctf_fs_ds_file_info
*) (*ds_file_group_a
)->ds_file_infos
->pdata
[0];
1884 const ctf_fs_ds_file_info
*first_ds_file_info_b
=
1885 (const ctf_fs_ds_file_info
*) (*ds_file_group_b
)->ds_file_infos
->pdata
[0];
1887 return strcmp(first_ds_file_info_a
->path
->str
, first_ds_file_info_b
->path
->str
);
1890 static gint
compare_strings(gconstpointer p_a
, gconstpointer p_b
)
1892 const char *a
= *((const char **) p_a
);
1893 const char *b
= *((const char **) p_b
);
1895 return strcmp(a
, b
);
1898 int ctf_fs_component_create_ctf_fs_trace(struct ctf_fs_component
*ctf_fs
,
1899 const bt_value
*paths_value
,
1900 const bt_value
*trace_name_value
,
1901 bt_self_component
*selfComp
)
1905 const bt2_common::LogCfg
& logCfg
= ctf_fs
->logCfg
;
1906 GPtrArray
*paths
= NULL
;
1908 const char *trace_name
;
1910 BT_ASSERT(bt_value_get_type(paths_value
) == BT_VALUE_TYPE_ARRAY
);
1911 BT_ASSERT(!bt_value_array_is_empty(paths_value
));
1913 traces
= g_ptr_array_new_with_free_func(ctf_fs_trace_destroy_notifier
);
1915 BT_CLOGE_APPEND_CAUSE("Failed to allocate a GPtrArray.");
1919 paths
= g_ptr_array_new_with_free_func(g_free
);
1921 BT_CLOGE_APPEND_CAUSE("Failed to allocate a GPtrArray.");
1925 trace_name
= trace_name_value
? bt_value_string_get(trace_name_value
) : NULL
;
1928 * Create a sorted array of the paths, to make the execution of this
1929 * component deterministic.
1931 for (i
= 0; i
< bt_value_array_get_length(paths_value
); i
++) {
1932 const bt_value
*path_value
= bt_value_array_borrow_element_by_index_const(paths_value
, i
);
1933 const char *input
= bt_value_string_get(path_value
);
1936 input_copy
= g_strdup(input
);
1938 BT_CLOGE_APPEND_CAUSE("Failed to copy a string.");
1942 g_ptr_array_add(paths
, input_copy
);
1945 g_ptr_array_sort(paths
, compare_strings
);
1947 /* Create a separate ctf_fs_trace object for each path. */
1948 for (i
= 0; i
< paths
->len
; i
++) {
1949 const char *path
= (const char *) g_ptr_array_index(paths
, i
);
1951 ret
= ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs
, path
, trace_name
, traces
,
1958 if (traces
->len
> 1) {
1959 struct ctf_fs_trace
*first_trace
= (struct ctf_fs_trace
*) traces
->pdata
[0];
1960 const uint8_t *first_trace_uuid
= first_trace
->metadata
->tc
->uuid
;
1961 struct ctf_fs_trace
*trace
;
1964 * We have more than one trace, they must all share the same
1965 * UUID, verify that.
1967 for (i
= 0; i
< traces
->len
; i
++) {
1968 struct ctf_fs_trace
*this_trace
= (struct ctf_fs_trace
*) traces
->pdata
[i
];
1969 const uint8_t *this_trace_uuid
= this_trace
->metadata
->tc
->uuid
;
1971 if (!this_trace
->metadata
->tc
->is_uuid_set
) {
1972 BT_CLOGE_APPEND_CAUSE(
1973 "Multiple traces given, but a trace does not have a UUID: path=%s",
1974 this_trace
->path
->str
);
1978 if (bt_uuid_compare(first_trace_uuid
, this_trace_uuid
) != 0) {
1979 char first_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1980 char this_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1982 bt_uuid_to_str(first_trace_uuid
, first_trace_uuid_str
);
1983 bt_uuid_to_str(this_trace_uuid
, this_trace_uuid_str
);
1985 BT_CLOGE_APPEND_CAUSE("Multiple traces given, but UUIDs don't match: "
1986 "first-trace-uuid=%s, first-trace-path=%s, "
1987 "trace-uuid=%s, trace-path=%s",
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_CLOGE_APPEND_CAUSE("Failed to merge traces with the same UUID.");
2000 ctf_fs
->trace
= trace
;
2002 /* Just one trace, it may or may not have a UUID, both are fine. */
2003 ctf_fs
->trace
= (ctf_fs_trace
*) traces
->pdata
[0];
2004 traces
->pdata
[0] = NULL
;
2007 ret
= fix_packet_index_tracer_bugs(ctf_fs
);
2009 BT_CLOGE_APPEND_CAUSE("Failed to fix packet index tracer bugs.");
2013 * Sort data stream file groups by first data stream file info
2014 * path to get a deterministic order. This order influences the
2015 * order of the output ports. It also influences the order of
2016 * the automatic stream IDs if the trace's packet headers do not
2017 * contain a `stream_instance_id` field, in which case the data
2018 * stream file to stream ID association is always the same,
2019 * whatever the build and the system.
2021 * Having a deterministic order here can help debugging and
2024 g_ptr_array_sort(ctf_fs
->trace
->ds_file_groups
, compare_ds_file_groups_by_first_path
);
2031 g_ptr_array_free(traces
, TRUE
);
2035 g_ptr_array_free(paths
, TRUE
);
2041 static GString
*get_stream_instance_unique_name(struct ctf_fs_ds_file_group
*ds_file_group
)
2044 struct ctf_fs_ds_file_info
*ds_file_info
;
2046 name
= g_string_new(NULL
);
2052 * If there's more than one stream file in the stream file
2053 * group, the first (earliest) stream file's path is used as
2054 * the stream's unique name.
2056 BT_ASSERT(ds_file_group
->ds_file_infos
->len
> 0);
2057 ds_file_info
= (ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
2058 g_string_assign(name
, ds_file_info
->path
->str
);
2064 /* Create the IR stream objects for ctf_fs_trace. */
2066 static int create_streams_for_trace(struct ctf_fs_trace
*ctf_fs_trace
)
2069 GString
*name
= NULL
;
2071 const bt2_common::LogCfg
& logCfg
= ctf_fs_trace
->logCfg
;
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_CLOGE_APPEND_CAUSE("Cannot create stream for DS file group: "
2102 "addr=%p, stream-name=\"%s\"",
2103 ds_file_group
, name
->str
);
2107 ret
= bt_stream_set_name(ds_file_group
->stream
, name
->str
);
2109 BT_CLOGE_APPEND_CAUSE("Cannot set stream's name: "
2110 "addr=%p, stream-name=\"%s\"",
2111 ds_file_group
->stream
, name
->str
);
2115 g_string_free(name
, TRUE
);
2128 g_string_free(name
, TRUE
);
2133 static const bt_param_validation_value_descr inputs_elem_descr
=
2134 bt_param_validation_value_descr::makeString();
2136 static bt_param_validation_map_value_entry_descr fs_params_entries_descr
[] = {
2137 {"inputs", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
2138 bt_param_validation_value_descr::makeArray(1, BT_PARAM_VALIDATION_INFINITE
,
2139 inputs_elem_descr
)},
2140 {"trace-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2141 bt_param_validation_value_descr::makeString()},
2142 {"clock-class-offset-s", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2143 bt_param_validation_value_descr::makeSignedInteger()},
2144 {"clock-class-offset-ns", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2145 bt_param_validation_value_descr::makeSignedInteger()},
2146 {"force-clock-class-origin-unix-epoch", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2147 bt_param_validation_value_descr::makeBool()},
2148 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
2150 bool read_src_fs_parameters(const bt_value
*params
, const bt_value
**inputs
,
2151 const bt_value
**trace_name
, struct ctf_fs_component
*ctf_fs
)
2154 const bt_value
*value
;
2155 enum bt_param_validation_status validate_value_status
;
2156 gchar
*error
= NULL
;
2157 const bt2_common::LogCfg
& logCfg
= ctf_fs
->logCfg
;
2159 validate_value_status
= bt_param_validation_validate(params
, fs_params_entries_descr
, &error
);
2160 if (validate_value_status
!= BT_PARAM_VALIDATION_STATUS_OK
) {
2161 BT_CLOGE_APPEND_CAUSE("%s", error
);
2166 /* inputs parameter */
2167 *inputs
= bt_value_map_borrow_entry_value_const(params
, "inputs");
2169 /* clock-class-offset-s parameter */
2170 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-s");
2172 ctf_fs
->metadata_config
.clock_class_offset_s
= bt_value_integer_signed_get(value
);
2175 /* clock-class-offset-ns parameter */
2176 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-ns");
2178 ctf_fs
->metadata_config
.clock_class_offset_ns
= bt_value_integer_signed_get(value
);
2181 /* force-clock-class-origin-unix-epoch parameter */
2182 value
= bt_value_map_borrow_entry_value_const(params
, "force-clock-class-origin-unix-epoch");
2184 ctf_fs
->metadata_config
.force_clock_class_origin_unix_epoch
= bt_value_bool_get(value
);
2187 /* trace-name parameter */
2188 *trace_name
= bt_value_map_borrow_entry_value_const(params
, "trace-name");
2197 static ctf_fs_component::UP
ctf_fs_create(const bt_value
*params
,
2198 bt_self_component_source
*self_comp_src
,
2199 const bt2_common::LogCfg
& logCfg
)
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(logCfg
);
2210 if (!read_src_fs_parameters(params
, &inputs_value
, &trace_name_value
, ctf_fs
.get())) {
2214 if (ctf_fs_component_create_ctf_fs_trace(ctf_fs
.get(), inputs_value
, trace_name_value
,
2219 if (create_streams_for_trace(ctf_fs
->trace
)) {
2223 if (create_ports_for_trace(ctf_fs
.get(), ctf_fs
->trace
, self_comp_src
)) {
2231 bt_component_class_initialize_method_status
2232 ctf_fs_init(bt_self_component_source
*self_comp_src
, bt_self_component_source_configuration
*config
,
2233 const bt_value
*params
, __attribute__((unused
)) void *init_method_data
)
2235 bt_self_component
*selfComp
= bt_self_component_source_as_self_component(self_comp_src
);
2236 const bt_component
*comp
= bt_self_component_as_component(selfComp
);
2237 bt_logging_level logLevel
= bt_component_get_logging_level(comp
);
2238 bt2_common::LogCfg
logCfg(logLevel
, *selfComp
);
2241 ctf_fs_component::UP ctf_fs
= ctf_fs_create(params
, self_comp_src
, logCfg
);
2243 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
2246 bt_self_component_set_data(selfComp
, ctf_fs
.release());
2248 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
2249 } catch (const std::bad_alloc
&) {
2250 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
2251 } catch (const bt2_common::Error
&) {
2252 BT_CLOGE_APPEND_CAUSE("Failed to initialize component");
2253 return BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
2258 bt_component_class_query_method_status
ctf_fs_query(bt_self_component_class_source
*comp_class_src
,
2259 bt_private_query_executor
*priv_query_exec
,
2260 const char *object
, const bt_value
*params
,
2261 __attribute__((unused
)) void *method_data
,
2262 const bt_value
**result
)
2264 const bt_query_executor
*query_exec
=
2265 bt_private_query_executor_as_query_executor_const(priv_query_exec
);
2266 bt_logging_level log_level
= bt_query_executor_get_logging_level(query_exec
);
2267 bt_self_component_class
*comp_class
=
2268 bt_self_component_class_source_as_self_component_class(comp_class_src
);
2269 bt2_common::LogCfg
logCfg(log_level
, *comp_class
);
2272 bt_component_class_query_method_status status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
2274 if (strcmp(object
, "metadata-info") == 0) {
2275 status
= metadata_info_query(params
, logCfg
, result
);
2276 } else if (strcmp(object
, "babeltrace.trace-infos") == 0) {
2277 status
= trace_infos_query(params
, logCfg
, result
);
2278 } else if (!strcmp(object
, "babeltrace.support-info")) {
2279 status
= support_info_query(params
, logCfg
, result
);
2281 BT_LOGE("Unknown query object `%s`", object
);
2282 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;
2287 } catch (const std::bad_alloc
&) {
2288 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
2289 } catch (const bt2_common::Error
&) {
2290 BT_CLOGE_APPEND_CAUSE("Failed to execute query: object=%s", object
);
2291 return BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;