2 * SPDX-License-Identifier: MIT
4 * Copyright 2015-2017 Philippe Proulx <pproulx@efficios.com>
5 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 * Babeltrace CTF file system Reader Component
13 #include <babeltrace2/babeltrace.h>
15 #define BT_COMP_LOG_SELF_COMP self_comp
16 #define BT_LOG_OUTPUT_LEVEL ((enum bt_log_level) log_level)
17 #define BT_LOG_TAG "PLUGIN/SRC.CTF.FS"
18 #include "logging/comp-logging.h"
20 #include "common/assert.h"
21 #include "common/common.h"
22 #include "common/uuid.h"
24 #include "plugins/common/param-validation/param-validation.h"
26 #include "../common/src/metadata/tsdl/ctf-meta-configure-ir-trace.hpp"
27 #include "../common/src/msg-iter/msg-iter.hpp"
28 #include "data-stream-file.hpp"
31 #include "metadata.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 bt_logging_level log_level
= msg_iter_data
->log_level
;
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_MSG_ITER_LOGE_APPEND_CAUSE(msg_iter_data
->self_msg_iter
,
88 "Failed to get next message from CTF message iterator.");
89 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
92 case CTF_MSG_ITER_STATUS_MEMORY_ERROR
:
93 BT_MSG_ITER_LOGE_APPEND_CAUSE(msg_iter_data
->self_msg_iter
,
94 "Failed to get next message from CTF message iterator.");
95 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
105 bt_message_iterator_class_next_method_status
106 ctf_fs_iterator_next(bt_self_message_iterator
*iterator
, bt_message_array_const msgs
,
107 uint64_t capacity
, uint64_t *count
)
109 bt_message_iterator_class_next_method_status status
;
110 struct ctf_fs_msg_iter_data
*msg_iter_data
=
111 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(iterator
);
114 if (G_UNLIKELY(msg_iter_data
->next_saved_error
)) {
116 * Last time we were called, we hit an error but had some
117 * messages to deliver, so we stashed the error here. Return
120 BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(msg_iter_data
->next_saved_error
);
121 status
= msg_iter_data
->next_saved_status
;
126 status
= ctf_fs_iterator_next_one(msg_iter_data
, &msgs
[i
]);
127 if (status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
) {
130 } while (i
< capacity
&& status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
);
134 * Even if ctf_fs_iterator_next_one() returned something
135 * else than BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK, we
136 * accumulated message objects in the output
137 * message array, so we need to return
138 * BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK so that they are
139 * transferred to downstream. This other status occurs
140 * again the next time muxer_msg_iter_do_next() is
141 * called, possibly without any accumulated
142 * message, in which case we'll return it.
146 * Save this error for the next _next call. Assume that
147 * this component always appends error causes when
148 * returning an error status code, which will cause the
149 * current thread error to be non-NULL.
151 msg_iter_data
->next_saved_error
= bt_current_thread_take_error();
152 BT_ASSERT(msg_iter_data
->next_saved_error
);
153 msg_iter_data
->next_saved_status
= status
;
157 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
164 bt_message_iterator_class_seek_beginning_method_status
165 ctf_fs_iterator_seek_beginning(bt_self_message_iterator
*it
)
167 struct ctf_fs_msg_iter_data
*msg_iter_data
=
168 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(it
);
170 BT_ASSERT(msg_iter_data
);
172 ctf_msg_iter_reset(msg_iter_data
->msg_iter
);
173 ctf_fs_ds_group_medops_data_reset(msg_iter_data
->msg_iter_medops_data
);
175 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_OK
;
178 void ctf_fs_iterator_finalize(bt_self_message_iterator
*it
)
180 ctf_fs_msg_iter_data_destroy(
181 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(it
));
184 static bt_message_iterator_class_initialize_method_status
185 ctf_msg_iter_medium_status_to_msg_iter_initialize_status(enum ctf_msg_iter_medium_status status
)
188 case CTF_MSG_ITER_MEDIUM_STATUS_EOF
:
189 case CTF_MSG_ITER_MEDIUM_STATUS_AGAIN
:
190 case CTF_MSG_ITER_MEDIUM_STATUS_ERROR
:
191 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
192 case CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
:
193 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
194 case CTF_MSG_ITER_MEDIUM_STATUS_OK
:
195 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
201 bt_message_iterator_class_initialize_method_status
202 ctf_fs_iterator_init(bt_self_message_iterator
*self_msg_iter
,
203 bt_self_message_iterator_configuration
*config
,
204 bt_self_component_port_output
*self_port
)
206 struct ctf_fs_port_data
*port_data
;
207 bt_message_iterator_class_initialize_method_status status
;
208 bt_logging_level log_level
;
209 enum ctf_msg_iter_medium_status medium_status
;
210 bt_self_component
*self_comp
= bt_self_message_iterator_borrow_component(self_msg_iter
);
212 port_data
= (struct ctf_fs_port_data
*) bt_self_component_port_get_data(
213 bt_self_component_port_output_as_self_component_port(self_port
));
214 BT_ASSERT(port_data
);
215 log_level
= port_data
->ctf_fs
->log_level
;
217 ctf_fs_msg_iter_data
*msg_iter_data
= new ctf_fs_msg_iter_data
;
218 msg_iter_data
->log_level
= log_level
;
219 msg_iter_data
->self_comp
= self_comp
;
220 msg_iter_data
->self_msg_iter
= self_msg_iter
;
221 msg_iter_data
->ds_file_group
= port_data
->ds_file_group
;
224 ctf_fs_ds_group_medops_data_create(msg_iter_data
->ds_file_group
, self_msg_iter
, log_level
,
225 &msg_iter_data
->msg_iter_medops_data
);
226 BT_ASSERT(medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_OK
||
227 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_ERROR
||
228 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
);
229 if (medium_status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
230 BT_MSG_ITER_LOGE_APPEND_CAUSE(self_msg_iter
, "Failed to create ctf_fs_ds_group_medops");
231 status
= ctf_msg_iter_medium_status_to_msg_iter_initialize_status(medium_status
);
235 msg_iter_data
->msg_iter
= ctf_msg_iter_create(
236 msg_iter_data
->ds_file_group
->ctf_fs_trace
->metadata
->tc
,
237 bt_common_get_page_size(msg_iter_data
->log_level
) * 8, ctf_fs_ds_group_medops
,
238 msg_iter_data
->msg_iter_medops_data
, msg_iter_data
->log_level
, self_comp
, self_msg_iter
);
239 if (!msg_iter_data
->msg_iter
) {
240 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Cannot create a CTF message iterator.");
241 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
246 * This iterator can seek forward if its stream class has a default
249 if (msg_iter_data
->ds_file_group
->sc
->default_clock_class
) {
250 bt_self_message_iterator_configuration_set_can_seek_forward(config
, true);
253 bt_self_message_iterator_set_data(self_msg_iter
, msg_iter_data
);
254 msg_iter_data
= NULL
;
256 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
260 bt_self_message_iterator_set_data(self_msg_iter
, NULL
);
263 ctf_fs_msg_iter_data_destroy(msg_iter_data
);
267 static void ctf_fs_trace_destroy(struct ctf_fs_trace
*ctf_fs_trace
)
273 if (ctf_fs_trace
->ds_file_groups
) {
274 g_ptr_array_free(ctf_fs_trace
->ds_file_groups
, TRUE
);
277 BT_TRACE_PUT_REF_AND_RESET(ctf_fs_trace
->trace
);
279 if (ctf_fs_trace
->path
) {
280 g_string_free(ctf_fs_trace
->path
, TRUE
);
283 if (ctf_fs_trace
->metadata
) {
284 ctf_fs_metadata_fini(ctf_fs_trace
->metadata
);
285 delete ctf_fs_trace
->metadata
;
291 void ctf_fs_destroy(struct ctf_fs_component
*ctf_fs
)
297 ctf_fs_trace_destroy(ctf_fs
->trace
);
299 if (ctf_fs
->port_data
) {
300 g_ptr_array_free(ctf_fs
->port_data
, TRUE
);
306 static void port_data_destroy(struct ctf_fs_port_data
*port_data
)
315 static void port_data_destroy_notifier(void *data
)
317 port_data_destroy((struct ctf_fs_port_data
*) data
);
320 static void ctf_fs_trace_destroy_notifier(void *data
)
322 struct ctf_fs_trace
*trace
= (struct ctf_fs_trace
*) data
;
323 ctf_fs_trace_destroy(trace
);
326 struct ctf_fs_component
*ctf_fs_component_create(bt_logging_level log_level
)
328 ctf_fs_component
*ctf_fs
= new ctf_fs_component
;
329 ctf_fs
->log_level
= log_level
;
330 ctf_fs
->port_data
= g_ptr_array_new_with_free_func(port_data_destroy_notifier
);
331 if (!ctf_fs
->port_data
) {
338 ctf_fs_destroy(ctf_fs
);
345 void ctf_fs_finalize(bt_self_component_source
*component
)
347 ctf_fs_destroy((struct ctf_fs_component
*) bt_self_component_get_data(
348 bt_self_component_source_as_self_component(component
)));
351 gchar
*ctf_fs_make_port_name(struct ctf_fs_ds_file_group
*ds_file_group
)
353 GString
*name
= g_string_new(NULL
);
356 * The unique port name is generated by concatenating unique identifiers
364 /* For the trace, use the uuid if present, else the path. */
365 if (ds_file_group
->ctf_fs_trace
->metadata
->tc
->is_uuid_set
) {
366 char uuid_str
[BT_UUID_STR_LEN
+ 1];
368 bt_uuid_to_str(ds_file_group
->ctf_fs_trace
->metadata
->tc
->uuid
, uuid_str
);
369 g_string_assign(name
, uuid_str
);
371 g_string_assign(name
, ds_file_group
->ctf_fs_trace
->path
->str
);
375 * For the stream class, use the id if present. We can omit this field
376 * otherwise, as there will only be a single stream class.
378 if (ds_file_group
->sc
->id
!= UINT64_C(-1)) {
379 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->sc
->id
);
382 /* For the stream, use the id if present, else, use the path. */
383 if (ds_file_group
->stream_id
!= UINT64_C(-1)) {
384 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->stream_id
);
386 BT_ASSERT(ds_file_group
->ds_file_infos
->len
== 1);
387 struct ctf_fs_ds_file_info
*ds_file_info
=
388 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
389 g_string_append_printf(name
, " | %s", ds_file_info
->path
->str
);
392 return g_string_free(name
, FALSE
);
395 static int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
396 struct ctf_fs_ds_file_group
*ds_file_group
,
397 bt_self_component_source
*self_comp_src
)
400 struct ctf_fs_port_data
*port_data
= NULL
;
402 bt_logging_level log_level
= ctf_fs
->log_level
;
403 bt_self_component
*self_comp
= bt_self_component_source_as_self_component(self_comp_src
);
405 port_name
= ctf_fs_make_port_name(ds_file_group
);
410 BT_COMP_LOGI("Creating one port named `%s`", port_name
);
412 /* Create output port for this file */
413 port_data
= new ctf_fs_port_data
;
414 port_data
->ctf_fs
= ctf_fs
;
415 port_data
->ds_file_group
= ds_file_group
;
416 ret
= bt_self_component_source_add_output_port(self_comp_src
, port_name
, port_data
, NULL
);
421 g_ptr_array_add(ctf_fs
->port_data
, port_data
);
431 port_data_destroy(port_data
);
435 static int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
436 struct ctf_fs_trace
*ctf_fs_trace
,
437 bt_self_component_source
*self_comp_src
)
441 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
442 bt_self_component
*self_comp
= bt_self_component_source_as_self_component(self_comp_src
);
444 /* Create one output port for each stream file group */
445 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
446 struct ctf_fs_ds_file_group
*ds_file_group
=
447 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
449 ret
= create_one_port_for_trace(ctf_fs
, ds_file_group
, self_comp_src
);
451 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Cannot create output port.");
460 static void ctf_fs_ds_file_info_destroy(struct ctf_fs_ds_file_info
*ds_file_info
)
466 if (ds_file_info
->path
) {
467 g_string_free(ds_file_info
->path
, TRUE
);
473 static struct ctf_fs_ds_file_info
*ctf_fs_ds_file_info_create(const char *path
, int64_t begin_ns
)
475 ctf_fs_ds_file_info
*ds_file_info
= new ctf_fs_ds_file_info
;
476 ds_file_info
->path
= g_string_new(path
);
477 if (!ds_file_info
->path
) {
478 ctf_fs_ds_file_info_destroy(ds_file_info
);
483 ds_file_info
->begin_ns
= begin_ns
;
489 static void ctf_fs_ds_file_group_destroy(struct ctf_fs_ds_file_group
*ds_file_group
)
491 if (!ds_file_group
) {
495 if (ds_file_group
->ds_file_infos
) {
496 g_ptr_array_free(ds_file_group
->ds_file_infos
, TRUE
);
499 ctf_fs_ds_index_destroy(ds_file_group
->index
);
501 bt_stream_put_ref(ds_file_group
->stream
);
502 delete ds_file_group
;
505 static struct ctf_fs_ds_file_group
*ctf_fs_ds_file_group_create(struct ctf_fs_trace
*ctf_fs_trace
,
506 struct ctf_stream_class
*sc
,
507 uint64_t stream_instance_id
,
508 struct ctf_fs_ds_index
*index
)
510 ctf_fs_ds_file_group
*ds_file_group
= new ctf_fs_ds_file_group
;
511 ds_file_group
->ds_file_infos
=
512 g_ptr_array_new_with_free_func((GDestroyNotify
) ctf_fs_ds_file_info_destroy
);
513 if (!ds_file_group
->ds_file_infos
) {
517 ds_file_group
->index
= index
;
519 ds_file_group
->stream_id
= stream_instance_id
;
521 ds_file_group
->sc
= sc
;
522 ds_file_group
->ctf_fs_trace
= ctf_fs_trace
;
526 ctf_fs_ds_file_group_destroy(ds_file_group
);
527 ctf_fs_ds_index_destroy(index
);
528 ds_file_group
= NULL
;
531 return ds_file_group
;
534 /* Replace by g_ptr_array_insert when we depend on glib >= 2.40. */
535 static void array_insert(GPtrArray
*array
, gpointer element
, size_t pos
)
537 size_t original_array_len
= array
->len
;
539 /* Allocate an unused element at the end of the array. */
540 g_ptr_array_add(array
, NULL
);
542 /* If we are not inserting at the end, move the elements by one. */
543 if (pos
< original_array_len
) {
544 memmove(&(array
->pdata
[pos
+ 1]), &(array
->pdata
[pos
]),
545 (original_array_len
- pos
) * sizeof(gpointer
));
548 /* Insert the value. */
549 array
->pdata
[pos
] = element
;
553 * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right
554 * place to keep it sorted.
557 static void ds_file_group_insert_ds_file_info_sorted(struct ctf_fs_ds_file_group
*ds_file_group
,
558 struct ctf_fs_ds_file_info
*ds_file_info
)
562 /* Find the spot where to insert this ds_file_info. */
563 for (i
= 0; i
< ds_file_group
->ds_file_infos
->len
; i
++) {
564 struct ctf_fs_ds_file_info
*other_ds_file_info
=
565 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, i
);
567 if (ds_file_info
->begin_ns
< other_ds_file_info
->begin_ns
) {
572 array_insert(ds_file_group
->ds_file_infos
, ds_file_info
, i
);
575 static bool ds_index_entries_equal(const struct ctf_fs_ds_index_entry
*left
,
576 const struct ctf_fs_ds_index_entry
*right
)
578 if (left
->packet_size
!= right
->packet_size
) {
582 if (left
->timestamp_begin
!= right
->timestamp_begin
) {
586 if (left
->timestamp_end
!= right
->timestamp_end
) {
590 if (left
->packet_seq_num
!= right
->packet_seq_num
) {
598 * Insert `entry` into `index`, without duplication.
600 * The entry is inserted only if there isn't an identical entry already.
602 * In any case, the ownership of `entry` is transferred to this function. So if
603 * the entry is not inserted, it is freed.
606 static void ds_index_insert_ds_index_entry_sorted(struct ctf_fs_ds_index
*index
,
607 struct ctf_fs_ds_index_entry
*entry
)
610 struct ctf_fs_ds_index_entry
*other_entry
= NULL
;
612 /* Find the spot where to insert this index entry. */
613 for (i
= 0; i
< index
->entries
->len
; i
++) {
614 other_entry
= (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, i
);
616 if (entry
->timestamp_begin_ns
<= other_entry
->timestamp_begin_ns
) {
622 * Insert the entry only if a duplicate doesn't already exist.
624 * There can be duplicate packets if reading multiple overlapping
625 * snapshots of the same trace. We then want the index to contain
626 * a reference to only one copy of that packet.
628 if (i
== index
->entries
->len
|| !ds_index_entries_equal(entry
, other_entry
)) {
629 array_insert(index
->entries
, entry
, i
);
635 static void merge_ctf_fs_ds_indexes(struct ctf_fs_ds_index
*dest
, struct ctf_fs_ds_index
*src
)
639 for (i
= 0; i
< src
->entries
->len
; i
++) {
640 struct ctf_fs_ds_index_entry
*entry
=
641 (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(src
->entries
, i
);
644 * Ownership of the ctf_fs_ds_index_entry is transferred to
645 * ds_index_insert_ds_index_entry_sorted.
647 g_ptr_array_index(src
->entries
, i
) = NULL
;
648 ds_index_insert_ds_index_entry_sorted(dest
, entry
);
652 static int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
, const char *path
)
654 int64_t stream_instance_id
= -1;
655 int64_t begin_ns
= -1;
656 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
657 bool add_group
= false;
660 struct ctf_fs_ds_file
*ds_file
= NULL
;
661 struct ctf_fs_ds_file_info
*ds_file_info
= NULL
;
662 struct ctf_fs_ds_index
*index
= NULL
;
663 struct ctf_msg_iter
*msg_iter
= NULL
;
664 struct ctf_stream_class
*sc
= NULL
;
665 struct ctf_msg_iter_packet_properties props
;
666 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
667 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
668 bt_self_component_class
*self_comp_class
= ctf_fs_trace
->self_comp_class
;
671 * Create a temporary ds_file to read some properties about the data
674 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, path
, log_level
);
679 /* Create a temporary iterator to read the ds_file. */
681 ctf_msg_iter_create(ctf_fs_trace
->metadata
->tc
, bt_common_get_page_size(log_level
) * 8,
682 ctf_fs_ds_file_medops
, ds_file
, log_level
, self_comp
, NULL
);
684 BT_COMP_LOGE_STR("Cannot create a CTF message iterator.");
688 ctf_msg_iter_set_dry_run(msg_iter
, true);
690 ret
= ctf_msg_iter_get_packet_properties(msg_iter
, &props
);
692 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
693 self_comp
, self_comp_class
,
694 "Cannot get stream file's first packet's header and context fields (`%s`).", path
);
698 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
, props
.stream_class_id
);
700 stream_instance_id
= props
.data_stream_id
;
702 if (props
.snapshots
.beginning_clock
!= UINT64_C(-1)) {
703 BT_ASSERT(sc
->default_clock_class
);
704 ret
= bt_util_clock_cycles_to_ns_from_origin(
705 props
.snapshots
.beginning_clock
, sc
->default_clock_class
->frequency
,
706 sc
->default_clock_class
->offset_seconds
, sc
->default_clock_class
->offset_cycles
,
709 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
710 self_comp
, self_comp_class
,
711 "Cannot convert clock cycles to nanoseconds from origin (`%s`).", path
);
716 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
);
721 index
= ctf_fs_ds_file_build_index(ds_file
, ds_file_info
, msg_iter
);
723 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
724 "Failed to index CTF stream file \'%s\'",
725 ds_file
->file
->path
->str
);
729 if (begin_ns
== -1) {
731 * No beginning timestamp to sort the stream files
732 * within a stream file group, so consider that this
733 * file must be the only one within its group.
735 stream_instance_id
= -1;
738 if (stream_instance_id
== -1) {
740 * No stream instance ID or no beginning timestamp:
741 * create a unique stream file group for this stream
742 * file because, even if there's a stream instance ID,
743 * there's no timestamp to order the file within its
746 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, UINT64_C(-1), index
);
747 /* Ownership of index is transferred. */
750 if (!ds_file_group
) {
754 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, BT_MOVE_REF(ds_file_info
));
760 BT_ASSERT(stream_instance_id
!= -1);
761 BT_ASSERT(begin_ns
!= -1);
763 /* Find an existing stream file group with this ID */
764 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
766 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
768 if (ds_file_group
->sc
== sc
&& ds_file_group
->stream_id
== stream_instance_id
) {
772 ds_file_group
= NULL
;
775 if (!ds_file_group
) {
776 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, stream_instance_id
, index
);
777 /* Ownership of index is transferred. */
779 if (!ds_file_group
) {
785 merge_ctf_fs_ds_indexes(ds_file_group
->index
, index
);
788 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, BT_MOVE_REF(ds_file_info
));
793 ctf_fs_ds_file_group_destroy(ds_file_group
);
794 ds_file_group
= NULL
;
798 if (add_group
&& ds_file_group
) {
799 g_ptr_array_add(ctf_fs_trace
->ds_file_groups
, ds_file_group
);
802 ctf_fs_ds_file_destroy(ds_file
);
803 ctf_fs_ds_file_info_destroy(ds_file_info
);
806 ctf_msg_iter_destroy(msg_iter
);
809 ctf_fs_ds_index_destroy(index
);
813 static int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
816 const char *basename
;
817 GError
*error
= NULL
;
819 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
820 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
821 bt_self_component_class
*self_comp_class
= ctf_fs_trace
->self_comp_class
;
823 /* Check each file in the path directory, except specific ones */
824 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
826 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
827 self_comp
, self_comp_class
, "Cannot open directory `%s`: %s (code %d)",
828 ctf_fs_trace
->path
->str
, error
->message
, error
->code
);
832 while ((basename
= g_dir_read_name(dir
))) {
833 struct ctf_fs_file
*file
;
835 if (strcmp(basename
, CTF_FS_METADATA_FILENAME
) == 0) {
836 /* Ignore the metadata stream. */
837 BT_COMP_LOGI("Ignoring metadata file `%s" G_DIR_SEPARATOR_S
"%s`",
838 ctf_fs_trace
->path
->str
, basename
);
842 if (basename
[0] == '.') {
843 BT_COMP_LOGI("Ignoring hidden file `%s" G_DIR_SEPARATOR_S
"%s`",
844 ctf_fs_trace
->path
->str
, basename
);
848 /* Create the file. */
849 file
= ctf_fs_file_create(log_level
, self_comp
);
851 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
852 self_comp
, self_comp_class
,
853 "Cannot create stream file object for file `%s" G_DIR_SEPARATOR_S
"%s`",
854 ctf_fs_trace
->path
->str
, basename
);
858 /* Create full path string. */
859 g_string_append_printf(file
->path
, "%s" G_DIR_SEPARATOR_S
"%s", ctf_fs_trace
->path
->str
,
861 if (!g_file_test(file
->path
->str
, G_FILE_TEST_IS_REGULAR
)) {
862 BT_COMP_LOGI("Ignoring non-regular file `%s`", file
->path
->str
);
863 ctf_fs_file_destroy(file
);
868 ret
= ctf_fs_file_open(file
, "rb");
870 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
871 self_comp
, self_comp_class
, "Cannot open stream file `%s`", file
->path
->str
);
875 if (file
->size
== 0) {
876 /* Skip empty stream. */
877 BT_COMP_LOGI("Ignoring empty file `%s`", file
->path
->str
);
878 ctf_fs_file_destroy(file
);
882 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
, file
->path
->str
);
884 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
885 self_comp
, self_comp_class
, "Cannot add stream file `%s` to stream file group",
887 ctf_fs_file_destroy(file
);
891 ctf_fs_file_destroy(file
);
912 static int set_trace_name(bt_trace
*trace
, const char *name_suffix
, bt_logging_level log_level
,
913 bt_self_component
*self_comp
)
919 name
= g_string_new(NULL
);
921 BT_COMP_LOGE_STR("Failed to allocate a GString.");
927 * Check if we have a trace environment string value named `hostname`.
928 * If so, use it as the trace name's prefix.
930 val
= bt_trace_borrow_environment_entry_value_by_name_const(trace
, "hostname");
931 if (val
&& bt_value_is_string(val
)) {
932 g_string_append(name
, bt_value_string_get(val
));
935 g_string_append_c(name
, G_DIR_SEPARATOR
);
940 g_string_append(name
, name_suffix
);
943 ret
= bt_trace_set_name(trace
, name
->str
);
952 g_string_free(name
, TRUE
);
958 static struct ctf_fs_trace
*ctf_fs_trace_create(bt_self_component
*self_comp
,
959 bt_self_component_class
*self_comp_class
,
960 const char *path
, const char *name
,
961 struct ctf_fs_metadata_config
*metadata_config
,
962 bt_logging_level log_level
)
966 /* Only one of them must be set. */
967 BT_ASSERT(!self_comp
!= !self_comp_class
);
969 ctf_fs_trace
*ctf_fs_trace
= new struct ctf_fs_trace
;
970 ctf_fs_trace
->log_level
= log_level
;
971 ctf_fs_trace
->self_comp
= self_comp
;
972 ctf_fs_trace
->self_comp_class
= self_comp_class
;
973 ctf_fs_trace
->path
= g_string_new(path
);
974 if (!ctf_fs_trace
->path
) {
978 ctf_fs_trace
->metadata
= new ctf_fs_metadata
;
979 ctf_fs_metadata_init(ctf_fs_trace
->metadata
);
980 ctf_fs_trace
->ds_file_groups
=
981 g_ptr_array_new_with_free_func((GDestroyNotify
) ctf_fs_ds_file_group_destroy
);
982 if (!ctf_fs_trace
->ds_file_groups
) {
986 ret
= ctf_fs_metadata_set_trace_class(self_comp
, ctf_fs_trace
, metadata_config
);
991 if (ctf_fs_trace
->metadata
->trace_class
) {
992 ctf_fs_trace
->trace
= bt_trace_create(ctf_fs_trace
->metadata
->trace_class
);
993 if (!ctf_fs_trace
->trace
) {
998 if (ctf_fs_trace
->trace
) {
999 ret
= ctf_trace_class_configure_ir_trace(ctf_fs_trace
->metadata
->tc
, ctf_fs_trace
->trace
);
1004 ret
= set_trace_name(ctf_fs_trace
->trace
, name
, log_level
, self_comp
);
1010 ret
= create_ds_file_groups(ctf_fs_trace
);
1018 ctf_fs_trace_destroy(ctf_fs_trace
);
1019 ctf_fs_trace
= NULL
;
1022 return ctf_fs_trace
;
1025 static int path_is_ctf_trace(const char *path
)
1027 GString
*metadata_path
= g_string_new(NULL
);
1030 if (!metadata_path
) {
1035 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
1037 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
1043 g_string_free(metadata_path
, TRUE
);
1047 /* Helper for ctf_fs_component_create_ctf_fs_trace, to handle a single path. */
1049 static int ctf_fs_component_create_ctf_fs_trace_one_path(struct ctf_fs_component
*ctf_fs
,
1050 const char *path_param
,
1051 const char *trace_name
, GPtrArray
*traces
,
1052 bt_self_component
*self_comp
,
1053 bt_self_component_class
*self_comp_class
)
1055 struct ctf_fs_trace
*ctf_fs_trace
;
1058 bt_logging_level log_level
= ctf_fs
->log_level
;
1060 norm_path
= bt_common_normalize_path(path_param
, NULL
);
1062 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1063 "Failed to normalize path: `%s`.", path_param
);
1067 ret
= path_is_ctf_trace(norm_path
->str
);
1069 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1070 "Failed to check if path is a CTF trace: path=%s",
1073 } else if (ret
== 0) {
1074 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
1075 self_comp
, self_comp_class
,
1076 "Path is not a CTF trace (does not contain a metadata file): `%s`.", norm_path
->str
);
1080 // FIXME: Remove or ifdef for __MINGW32__
1081 if (strcmp(norm_path
->str
, "/") == 0) {
1082 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1083 "Opening a trace in `/` is not supported.");
1088 ctf_fs_trace
= ctf_fs_trace_create(self_comp
, self_comp_class
, norm_path
->str
, trace_name
,
1089 &ctf_fs
->metadata_config
, log_level
);
1090 if (!ctf_fs_trace
) {
1091 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1092 "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
->log_level
, dest_trace
->self_comp
);
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 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
1334 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
1337 BT_ASSERT(ctf_fs_trace
);
1338 BT_ASSERT(index_entry
);
1339 BT_ASSERT(index_entry
->path
);
1341 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, index_entry
->path
, log_level
);
1343 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Failed to create a ctf_fs_ds_file");
1348 BT_ASSERT(ctf_fs_trace
->metadata
);
1349 BT_ASSERT(ctf_fs_trace
->metadata
->tc
);
1352 ctf_msg_iter_create(ctf_fs_trace
->metadata
->tc
, bt_common_get_page_size(log_level
) * 8,
1353 ctf_fs_ds_file_medops
, ds_file
, log_level
, self_comp
, NULL
);
1355 /* ctf_msg_iter_create() logs errors. */
1361 * Turn on dry run mode to prevent the creation and usage of Babeltrace
1362 * library objects (bt_field, bt_message_*, etc.).
1364 ctf_msg_iter_set_dry_run(msg_iter
, true);
1366 /* Seek to the beginning of the target packet. */
1367 iter_status
= ctf_msg_iter_seek(msg_iter
, index_entry
->offset
);
1369 /* ctf_msg_iter_seek() logs errors. */
1374 switch (target_event
) {
1377 * Start to decode the packet until we reach the end of
1378 * the first event. To extract the first event's clock
1381 iter_status
= ctf_msg_iter_curr_packet_first_event_clock_snapshot(msg_iter
, cs
);
1384 /* Decode the packet to extract the last event's clock snapshot. */
1385 iter_status
= ctf_msg_iter_curr_packet_last_event_clock_snapshot(msg_iter
, cs
);
1395 /* Convert clock snapshot to timestamp. */
1396 ret
= bt_util_clock_cycles_to_ns_from_origin(
1397 *cs
, default_cc
->frequency
, default_cc
->offset_seconds
, default_cc
->offset_cycles
, ts_ns
);
1399 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Failed to convert clock snapshot to timestamp");
1405 ctf_fs_ds_file_destroy(ds_file
);
1408 ctf_msg_iter_destroy(msg_iter
);
1414 static int decode_packet_first_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1415 struct ctf_clock_class
*default_cc
,
1416 struct ctf_fs_ds_index_entry
*index_entry
,
1417 uint64_t *cs
, int64_t *ts_ns
)
1419 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, FIRST_EVENT
, cs
,
1423 static int decode_packet_last_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1424 struct ctf_clock_class
*default_cc
,
1425 struct ctf_fs_ds_index_entry
*index_entry
,
1426 uint64_t *cs
, int64_t *ts_ns
)
1428 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, LAST_EVENT
, cs
,
1433 * Fix up packet index entries for lttng's "event-after-packet" bug.
1434 * Some buggy lttng tracer versions may emit events with a timestamp that is
1435 * larger (after) than the timestamp_end of the their packets.
1437 * To fix up this erroneous data we do the following:
1438 * 1. If it's not the stream file's last packet: set the packet index entry's
1439 * end time to the next packet's beginning time.
1440 * 2. If it's the stream file's last packet, set the packet index entry's end
1441 * time to the packet's last event's time, if any, or to the packet's
1442 * beginning time otherwise.
1444 * Known buggy tracer versions:
1445 * - before lttng-ust 2.11.0
1446 * - before lttng-module 2.11.0
1447 * - before lttng-module 2.10.10
1448 * - before lttng-module 2.9.13
1450 static int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace
*trace
)
1453 guint ds_file_group_i
;
1454 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1455 bt_logging_level log_level
= trace
->log_level
;
1457 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
; ds_file_group_i
++) {
1459 struct ctf_clock_class
*default_cc
;
1460 struct ctf_fs_ds_index_entry
*last_entry
;
1461 struct ctf_fs_ds_index
*index
;
1463 struct ctf_fs_ds_file_group
*ds_file_group
=
1464 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1466 BT_ASSERT(ds_file_group
);
1467 index
= ds_file_group
->index
;
1470 BT_ASSERT(index
->entries
);
1471 BT_ASSERT(index
->entries
->len
> 0);
1474 * Iterate over all entries but the last one. The last one is
1475 * fixed differently after.
1477 for (entry_i
= 0; entry_i
< index
->entries
->len
- 1; entry_i
++) {
1478 struct ctf_fs_ds_index_entry
*curr_entry
, *next_entry
;
1480 curr_entry
= (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
);
1481 next_entry
= (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
+ 1);
1484 * 1. Set the current index entry `end` timestamp to
1485 * the next index entry `begin` timestamp.
1487 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1488 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1492 * 2. Fix the last entry by decoding the last event of the last
1496 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, index
->entries
->len
- 1);
1497 BT_ASSERT(last_entry
);
1499 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1500 default_cc
= ds_file_group
->sc
->default_clock_class
;
1503 * Decode packet to read the timestamp of the last event of the
1506 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1507 &last_entry
->timestamp_end
,
1508 &last_entry
->timestamp_end_ns
);
1510 BT_COMP_LOGE_APPEND_CAUSE(
1512 "Failed to decode stream's last packet to get its last event's clock snapshot.");
1522 * Fix up packet index entries for barectf's "event-before-packet" bug.
1523 * Some buggy barectf tracer versions may emit events with a timestamp that is
1524 * less than the timestamp_begin of the their packets.
1526 * To fix up this erroneous data we do the following:
1527 * 1. Starting at the second index entry, set the timestamp_begin of the
1528 * current entry to the timestamp of the first event of the packet.
1529 * 2. Set the previous entry's timestamp_end to the timestamp_begin of the
1532 * Known buggy tracer versions:
1533 * - before barectf 2.3.1
1535 static int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace
*trace
)
1538 guint ds_file_group_i
;
1539 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1540 bt_logging_level log_level
= trace
->log_level
;
1542 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
; ds_file_group_i
++) {
1544 struct ctf_clock_class
*default_cc
;
1545 ctf_fs_ds_file_group
*ds_file_group
=
1546 (ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1548 struct ctf_fs_ds_index
*index
= ds_file_group
->index
;
1551 BT_ASSERT(index
->entries
);
1552 BT_ASSERT(index
->entries
->len
> 0);
1554 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1555 default_cc
= ds_file_group
->sc
->default_clock_class
;
1558 * 1. Iterate over the index, starting from the second entry
1561 for (entry_i
= 1; entry_i
< index
->entries
->len
; entry_i
++) {
1562 ctf_fs_ds_index_entry
*prev_entry
=
1563 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
- 1);
1564 ctf_fs_ds_index_entry
*curr_entry
=
1565 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
);
1567 * 2. Set the current entry `begin` timestamp to the
1568 * timestamp of the first event of the current packet.
1570 ret
= decode_packet_first_event_timestamp(trace
, default_cc
, curr_entry
,
1571 &curr_entry
->timestamp_begin
,
1572 &curr_entry
->timestamp_begin_ns
);
1574 BT_COMP_LOGE_APPEND_CAUSE(trace
->self_comp
,
1575 "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 bt_logging_level log_level
= trace
->log_level
;
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_COMP_LOGE_APPEND_CAUSE(trace
->self_comp
,
1648 "Failed to decode last event's clock snapshot");
1653 /* Iterate over all entries but the last one. */
1654 for (entry_idx
= 0; entry_idx
< index
->entries
->len
- 1; entry_idx
++) {
1655 ctf_fs_ds_index_entry
*curr_entry
=
1656 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_idx
);
1657 ctf_fs_ds_index_entry
*next_entry
=
1658 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_idx
+ 1);
1660 if (curr_entry
->timestamp_end
== 0 && curr_entry
->timestamp_begin
!= 0) {
1662 * 2. Set the current index entry `end` timestamp to
1663 * the next index entry `begin` timestamp.
1665 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1666 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1676 * Extract the tracer information necessary to compare versions.
1677 * Returns 0 on success, and -1 if the extraction is not successful because the
1678 * necessary fields are absents in the trace metadata.
1680 static int extract_tracer_info(struct ctf_fs_trace
*trace
, struct tracer_info
*current_tracer_info
)
1683 struct ctf_trace_class_env_entry
*entry
;
1685 /* Clear the current_tracer_info struct */
1686 memset(current_tracer_info
, 0, sizeof(*current_tracer_info
));
1689 * To compare 2 tracer versions, at least the tracer name and it's
1690 * major version are needed. If one of these is missing, consider it an
1691 * extraction failure.
1693 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_name");
1694 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR
) {
1695 goto missing_bare_minimum
;
1698 /* Set tracer name. */
1699 current_tracer_info
->name
= entry
->value
.str
->str
;
1701 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_major");
1702 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1703 goto missing_bare_minimum
;
1706 /* Set major version number. */
1707 current_tracer_info
->major
= entry
->value
.i
;
1709 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_minor");
1710 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1714 /* Set minor version number. */
1715 current_tracer_info
->minor
= entry
->value
.i
;
1717 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patch");
1720 * If `tracer_patch` doesn't exist `tracer_patchlevel` might.
1721 * For example, `lttng-modules` uses entry name
1722 * `tracer_patchlevel`.
1724 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patchlevel");
1727 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1731 /* Set patch version number. */
1732 current_tracer_info
->patch
= entry
->value
.i
;
1736 missing_bare_minimum
:
1742 static bool is_tracer_affected_by_lttng_event_after_packet_bug(struct tracer_info
*curr_tracer_info
)
1744 bool is_affected
= false;
1746 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1747 if (curr_tracer_info
->major
< 2) {
1749 } else if (curr_tracer_info
->major
== 2) {
1750 /* fixed in lttng-ust 2.11.0 */
1751 if (curr_tracer_info
->minor
< 11) {
1755 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1756 if (curr_tracer_info
->major
< 2) {
1758 } else if (curr_tracer_info
->major
== 2) {
1759 /* fixed in lttng-modules 2.11.0 */
1760 if (curr_tracer_info
->minor
== 10) {
1761 /* fixed in lttng-modules 2.10.10 */
1762 if (curr_tracer_info
->patch
< 10) {
1765 } else if (curr_tracer_info
->minor
== 9) {
1766 /* fixed in lttng-modules 2.9.13 */
1767 if (curr_tracer_info
->patch
< 13) {
1770 } else if (curr_tracer_info
->minor
< 9) {
1780 is_tracer_affected_by_barectf_event_before_packet_bug(struct tracer_info
*curr_tracer_info
)
1782 bool is_affected
= false;
1784 if (strcmp(curr_tracer_info
->name
, "barectf") == 0) {
1785 if (curr_tracer_info
->major
< 2) {
1787 } else if (curr_tracer_info
->major
== 2) {
1788 if (curr_tracer_info
->minor
< 3) {
1790 } else if (curr_tracer_info
->minor
== 3) {
1791 /* fixed in barectf 2.3.1 */
1792 if (curr_tracer_info
->patch
< 1) {
1802 static bool is_tracer_affected_by_lttng_crash_quirk(struct tracer_info
*curr_tracer_info
)
1804 bool is_affected
= false;
1806 /* All LTTng tracer may be affected by this lttng crash quirk. */
1807 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1809 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1817 * Looks for trace produced by known buggy tracers and fix up the index
1820 static int fix_packet_index_tracer_bugs(struct ctf_fs_component
*ctf_fs
,
1821 bt_self_component
*self_comp
,
1822 bt_self_component_class
*self_comp_class
)
1825 struct tracer_info current_tracer_info
;
1826 bt_logging_level log_level
= ctf_fs
->log_level
;
1828 ret
= extract_tracer_info(ctf_fs
->trace
, ¤t_tracer_info
);
1831 * A trace may not have all the necessary environment
1832 * entries to do the tracer version comparison.
1833 * At least, the tracer name and major version number
1834 * are needed. Failing to extract these entries is not
1838 BT_LOGI_STR("Cannot extract tracer information necessary to compare with buggy versions.");
1843 /* Check if the trace may be affected by old tracer bugs. */
1844 if (is_tracer_affected_by_lttng_event_after_packet_bug(¤t_tracer_info
)) {
1845 BT_LOGI_STR("Trace may be affected by LTTng tracer packet timestamp bug. Fixing up.");
1846 ret
= fix_index_lttng_event_after_packet_bug(ctf_fs
->trace
);
1848 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1849 "Failed to fix LTTng event-after-packet bug.");
1852 ctf_fs
->trace
->metadata
->tc
->quirks
.lttng_event_after_packet
= true;
1855 if (is_tracer_affected_by_barectf_event_before_packet_bug(¤t_tracer_info
)) {
1856 BT_LOGI_STR("Trace may be affected by barectf tracer packet timestamp bug. Fixing up.");
1857 ret
= fix_index_barectf_event_before_packet_bug(ctf_fs
->trace
);
1859 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
1860 self_comp
, self_comp_class
, "Failed to fix barectf event-before-packet bug.");
1863 ctf_fs
->trace
->metadata
->tc
->quirks
.barectf_event_before_packet
= true;
1866 if (is_tracer_affected_by_lttng_crash_quirk(¤t_tracer_info
)) {
1867 ret
= fix_index_lttng_crash_quirk(ctf_fs
->trace
);
1869 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1870 "Failed to fix lttng-crash timestamp quirks.");
1873 ctf_fs
->trace
->metadata
->tc
->quirks
.lttng_crash
= true;
1880 static gint
compare_ds_file_groups_by_first_path(gconstpointer a
, gconstpointer b
)
1882 ctf_fs_ds_file_group
* const *ds_file_group_a
= (ctf_fs_ds_file_group
**) a
;
1883 ctf_fs_ds_file_group
* const *ds_file_group_b
= (ctf_fs_ds_file_group
**) b
;
1885 BT_ASSERT((*ds_file_group_a
)->ds_file_infos
->len
> 0);
1886 BT_ASSERT((*ds_file_group_b
)->ds_file_infos
->len
> 0);
1888 const ctf_fs_ds_file_info
*first_ds_file_info_a
=
1889 (const ctf_fs_ds_file_info
*) (*ds_file_group_a
)->ds_file_infos
->pdata
[0];
1890 const ctf_fs_ds_file_info
*first_ds_file_info_b
=
1891 (const ctf_fs_ds_file_info
*) (*ds_file_group_b
)->ds_file_infos
->pdata
[0];
1893 return strcmp(first_ds_file_info_a
->path
->str
, first_ds_file_info_b
->path
->str
);
1896 static gint
compare_strings(gconstpointer p_a
, gconstpointer p_b
)
1898 const char *a
= *((const char **) p_a
);
1899 const char *b
= *((const char **) p_b
);
1901 return strcmp(a
, b
);
1904 int ctf_fs_component_create_ctf_fs_trace(struct ctf_fs_component
*ctf_fs
,
1905 const bt_value
*paths_value
,
1906 const bt_value
*trace_name_value
,
1907 bt_self_component
*self_comp
,
1908 bt_self_component_class
*self_comp_class
)
1912 bt_logging_level log_level
= ctf_fs
->log_level
;
1913 GPtrArray
*paths
= NULL
;
1915 const char *trace_name
;
1917 BT_ASSERT(bt_value_get_type(paths_value
) == BT_VALUE_TYPE_ARRAY
);
1918 BT_ASSERT(!bt_value_array_is_empty(paths_value
));
1920 traces
= g_ptr_array_new_with_free_func(ctf_fs_trace_destroy_notifier
);
1922 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1923 "Failed to allocate a GPtrArray.");
1927 paths
= g_ptr_array_new_with_free_func(g_free
);
1929 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1930 "Failed to allocate a GPtrArray.");
1934 trace_name
= trace_name_value
? bt_value_string_get(trace_name_value
) : NULL
;
1937 * Create a sorted array of the paths, to make the execution of this
1938 * component deterministic.
1940 for (i
= 0; i
< bt_value_array_get_length(paths_value
); i
++) {
1941 const bt_value
*path_value
= bt_value_array_borrow_element_by_index_const(paths_value
, i
);
1942 const char *input
= bt_value_string_get(path_value
);
1945 input_copy
= g_strdup(input
);
1947 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1948 "Failed to copy a string.");
1952 g_ptr_array_add(paths
, input_copy
);
1955 g_ptr_array_sort(paths
, compare_strings
);
1957 /* Create a separate ctf_fs_trace object for each path. */
1958 for (i
= 0; i
< paths
->len
; i
++) {
1959 const char *path
= (const char *) g_ptr_array_index(paths
, i
);
1961 ret
= ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs
, path
, trace_name
, traces
,
1962 self_comp
, self_comp_class
);
1968 if (traces
->len
> 1) {
1969 struct ctf_fs_trace
*first_trace
= (struct ctf_fs_trace
*) traces
->pdata
[0];
1970 const uint8_t *first_trace_uuid
= first_trace
->metadata
->tc
->uuid
;
1971 struct ctf_fs_trace
*trace
;
1974 * We have more than one trace, they must all share the same
1975 * UUID, verify that.
1977 for (i
= 0; i
< traces
->len
; i
++) {
1978 struct ctf_fs_trace
*this_trace
= (struct ctf_fs_trace
*) traces
->pdata
[i
];
1979 const uint8_t *this_trace_uuid
= this_trace
->metadata
->tc
->uuid
;
1981 if (!this_trace
->metadata
->tc
->is_uuid_set
) {
1982 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
1983 self_comp
, self_comp_class
,
1984 "Multiple traces given, but a trace does not have a UUID: path=%s",
1985 this_trace
->path
->str
);
1989 if (bt_uuid_compare(first_trace_uuid
, this_trace_uuid
) != 0) {
1990 char first_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1991 char this_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
1993 bt_uuid_to_str(first_trace_uuid
, first_trace_uuid_str
);
1994 bt_uuid_to_str(this_trace_uuid
, this_trace_uuid_str
);
1996 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
1997 self_comp
, self_comp_class
,
1998 "Multiple traces given, but UUIDs don't match: "
1999 "first-trace-uuid=%s, first-trace-path=%s, "
2000 "trace-uuid=%s, trace-path=%s",
2001 first_trace_uuid_str
, first_trace
->path
->str
, this_trace_uuid_str
,
2002 this_trace
->path
->str
);
2007 ret
= merge_ctf_fs_traces((struct ctf_fs_trace
**) traces
->pdata
, traces
->len
, &trace
);
2009 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2010 "Failed to merge traces with the same UUID.");
2014 ctf_fs
->trace
= trace
;
2016 /* Just one trace, it may or may not have a UUID, both are fine. */
2017 ctf_fs
->trace
= (ctf_fs_trace
*) traces
->pdata
[0];
2018 traces
->pdata
[0] = NULL
;
2021 ret
= fix_packet_index_tracer_bugs(ctf_fs
, self_comp
, self_comp_class
);
2023 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2024 "Failed to fix packet index tracer bugs.");
2028 * Sort data stream file groups by first data stream file info
2029 * path to get a deterministic order. This order influences the
2030 * order of the output ports. It also influences the order of
2031 * the automatic stream IDs if the trace's packet headers do not
2032 * contain a `stream_instance_id` field, in which case the data
2033 * stream file to stream ID association is always the same,
2034 * whatever the build and the system.
2036 * Having a deterministic order here can help debugging and
2039 g_ptr_array_sort(ctf_fs
->trace
->ds_file_groups
, compare_ds_file_groups_by_first_path
);
2046 g_ptr_array_free(traces
, TRUE
);
2050 g_ptr_array_free(paths
, TRUE
);
2056 static GString
*get_stream_instance_unique_name(struct ctf_fs_ds_file_group
*ds_file_group
)
2059 struct ctf_fs_ds_file_info
*ds_file_info
;
2061 name
= g_string_new(NULL
);
2067 * If there's more than one stream file in the stream file
2068 * group, the first (earliest) stream file's path is used as
2069 * the stream's unique name.
2071 BT_ASSERT(ds_file_group
->ds_file_infos
->len
> 0);
2072 ds_file_info
= (ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
2073 g_string_assign(name
, ds_file_info
->path
->str
);
2079 /* Create the IR stream objects for ctf_fs_trace. */
2081 static int create_streams_for_trace(struct ctf_fs_trace
*ctf_fs_trace
)
2084 GString
*name
= NULL
;
2086 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
2087 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
2089 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
2090 ctf_fs_ds_file_group
*ds_file_group
=
2091 (ctf_fs_ds_file_group
*) g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
2092 name
= get_stream_instance_unique_name(ds_file_group
);
2098 if (ds_file_group
->sc
->ir_sc
) {
2099 BT_ASSERT(ctf_fs_trace
->trace
);
2101 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
2102 /* No stream ID: use 0 */
2103 ds_file_group
->stream
= bt_stream_create_with_id(
2104 ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
, ctf_fs_trace
->next_stream_id
);
2105 ctf_fs_trace
->next_stream_id
++;
2107 /* Specific stream ID */
2108 ds_file_group
->stream
=
2109 bt_stream_create_with_id(ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
,
2110 (uint64_t) ds_file_group
->stream_id
);
2113 ds_file_group
->stream
= NULL
;
2116 if (!ds_file_group
->stream
) {
2117 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2118 "Cannot create stream for DS file group: "
2119 "addr=%p, stream-name=\"%s\"",
2120 ds_file_group
, name
->str
);
2124 ret
= bt_stream_set_name(ds_file_group
->stream
, name
->str
);
2126 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2127 "Cannot set stream's name: "
2128 "addr=%p, stream-name=\"%s\"",
2129 ds_file_group
->stream
, name
->str
);
2133 g_string_free(name
, TRUE
);
2146 g_string_free(name
, TRUE
);
2151 static const bt_param_validation_value_descr inputs_elem_descr
=
2152 bt_param_validation_value_descr::makeString();
2154 static bt_param_validation_map_value_entry_descr fs_params_entries_descr
[] = {
2155 {"inputs", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
2156 bt_param_validation_value_descr::makeArray(1, BT_PARAM_VALIDATION_INFINITE
,
2157 inputs_elem_descr
)},
2158 {"trace-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2159 bt_param_validation_value_descr::makeString()},
2160 {"clock-class-offset-s", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2161 bt_param_validation_value_descr::makeSignedInteger()},
2162 {"clock-class-offset-ns", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2163 bt_param_validation_value_descr::makeSignedInteger()},
2164 {"force-clock-class-origin-unix-epoch", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2165 bt_param_validation_value_descr::makeBool()},
2166 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
2168 bool read_src_fs_parameters(const bt_value
*params
, const bt_value
**inputs
,
2169 const bt_value
**trace_name
, struct ctf_fs_component
*ctf_fs
,
2170 bt_self_component
*self_comp
, bt_self_component_class
*self_comp_class
)
2173 const bt_value
*value
;
2174 bt_logging_level log_level
= ctf_fs
->log_level
;
2175 enum bt_param_validation_status validate_value_status
;
2176 gchar
*error
= NULL
;
2178 validate_value_status
= bt_param_validation_validate(params
, fs_params_entries_descr
, &error
);
2179 if (validate_value_status
!= BT_PARAM_VALIDATION_STATUS_OK
) {
2180 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
, "%s", error
);
2185 /* inputs parameter */
2186 *inputs
= bt_value_map_borrow_entry_value_const(params
, "inputs");
2188 /* clock-class-offset-s parameter */
2189 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-s");
2191 ctf_fs
->metadata_config
.clock_class_offset_s
= bt_value_integer_signed_get(value
);
2194 /* clock-class-offset-ns parameter */
2195 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-ns");
2197 ctf_fs
->metadata_config
.clock_class_offset_ns
= bt_value_integer_signed_get(value
);
2200 /* force-clock-class-origin-unix-epoch parameter */
2201 value
= bt_value_map_borrow_entry_value_const(params
, "force-clock-class-origin-unix-epoch");
2203 ctf_fs
->metadata_config
.force_clock_class_origin_unix_epoch
= bt_value_bool_get(value
);
2206 /* trace-name parameter */
2207 *trace_name
= bt_value_map_borrow_entry_value_const(params
, "trace-name");
2216 static struct ctf_fs_component
*ctf_fs_create(const bt_value
*params
,
2217 bt_self_component_source
*self_comp_src
)
2219 struct ctf_fs_component
*ctf_fs
= NULL
;
2220 const bt_value
*inputs_value
;
2221 const bt_value
*trace_name_value
;
2222 bt_self_component
*self_comp
= bt_self_component_source_as_self_component(self_comp_src
);
2224 ctf_fs
= ctf_fs_component_create(
2225 bt_component_get_logging_level(bt_self_component_as_component(self_comp
)));
2230 if (!read_src_fs_parameters(params
, &inputs_value
, &trace_name_value
, ctf_fs
, self_comp
,
2235 bt_self_component_set_data(self_comp
, ctf_fs
);
2237 if (ctf_fs_component_create_ctf_fs_trace(ctf_fs
, inputs_value
, trace_name_value
, self_comp
,
2242 if (create_streams_for_trace(ctf_fs
->trace
)) {
2246 if (create_ports_for_trace(ctf_fs
, ctf_fs
->trace
, self_comp_src
)) {
2253 ctf_fs_destroy(ctf_fs
);
2255 bt_self_component_set_data(self_comp
, NULL
);
2261 bt_component_class_initialize_method_status
ctf_fs_init(bt_self_component_source
*self_comp_src
,
2262 bt_self_component_source_configuration
*,
2263 const bt_value
*params
, void *)
2265 struct ctf_fs_component
*ctf_fs
;
2266 bt_component_class_initialize_method_status ret
=
2267 BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
2269 ctf_fs
= ctf_fs_create(params
, self_comp_src
);
2271 ret
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
2277 bt_component_class_query_method_status
ctf_fs_query(bt_self_component_class_source
*comp_class
,
2278 bt_private_query_executor
*priv_query_exec
,
2279 const char *object
, const bt_value
*params
,
2280 __attribute__((unused
)) void *method_data
,
2281 const bt_value
**result
)
2283 bt_component_class_query_method_status status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
2284 bt_logging_level log_level
= bt_query_executor_get_logging_level(
2285 bt_private_query_executor_as_query_executor_const(priv_query_exec
));
2287 if (strcmp(object
, "metadata-info") == 0) {
2288 status
= metadata_info_query(comp_class
, params
, log_level
, result
);
2289 } else if (strcmp(object
, "babeltrace.trace-infos") == 0) {
2290 status
= trace_infos_query(comp_class
, params
, log_level
, result
);
2291 } else if (!strcmp(object
, "babeltrace.support-info")) {
2292 status
= support_info_query(comp_class
, params
, log_level
, result
);
2294 BT_LOGE("Unknown query object `%s`", object
);
2295 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;