4 * Babeltrace CTF file system Reader Component
6 * Copyright 2015-2017 Philippe Proulx <pproulx@efficios.com>
7 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
9 * Permission is hereby granted, free of charge, to any person obtaining a copy
10 * of this software and associated documentation files (the "Software"), to deal
11 * in the Software without restriction, including without limitation the rights
12 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 * copies of the Software, and to permit persons to whom the Software is
14 * furnished to do so, subject to the following conditions:
16 * The above copyright notice and this permission notice shall be included in
17 * all copies or substantial portions of the Software.
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
28 #define BT_COMP_LOG_SELF_COMP self_comp
29 #define BT_LOG_OUTPUT_LEVEL log_level
30 #define BT_LOG_TAG "PLUGIN/SRC.CTF.FS"
31 #include "logging/comp-logging.h"
33 #include "common/common.h"
34 #include <babeltrace2/babeltrace.h>
35 #include "common/uuid.h"
37 #include "common/assert.h"
42 #include "data-stream-file.h"
44 #include "../common/metadata/decoder.h"
45 #include "../common/metadata/ctf-meta-configure-ir-trace.h"
46 #include "../common/msg-iter/msg-iter.h"
48 #include "plugins/common/param-validation/param-validation.h"
58 int msg_iter_data_set_current_ds_file(struct ctf_fs_msg_iter_data
*msg_iter_data
)
60 struct ctf_fs_ds_file_info
*ds_file_info
;
63 BT_ASSERT(msg_iter_data
->ds_file_info_index
<
64 msg_iter_data
->ds_file_group
->ds_file_infos
->len
);
65 ds_file_info
= g_ptr_array_index(
66 msg_iter_data
->ds_file_group
->ds_file_infos
,
67 msg_iter_data
->ds_file_info_index
);
69 ctf_fs_ds_file_destroy(msg_iter_data
->ds_file
);
70 msg_iter_data
->ds_file
= ctf_fs_ds_file_create(
71 msg_iter_data
->ds_file_group
->ctf_fs_trace
,
72 msg_iter_data
->self_msg_iter
,
73 msg_iter_data
->msg_iter
,
74 msg_iter_data
->ds_file_group
->stream
,
75 ds_file_info
->path
->str
,
76 msg_iter_data
->log_level
);
77 if (!msg_iter_data
->ds_file
) {
85 void ctf_fs_msg_iter_data_destroy(
86 struct ctf_fs_msg_iter_data
*msg_iter_data
)
92 ctf_fs_ds_file_destroy(msg_iter_data
->ds_file
);
94 if (msg_iter_data
->msg_iter
) {
95 ctf_msg_iter_destroy(msg_iter_data
->msg_iter
);
98 g_free(msg_iter_data
);
102 void set_msg_iter_emits_stream_beginning_end_messages(
103 struct ctf_fs_msg_iter_data
*msg_iter_data
)
105 ctf_msg_iter_set_emit_stream_beginning_message(
106 msg_iter_data
->ds_file
->msg_iter
,
107 msg_iter_data
->ds_file_info_index
== 0);
108 ctf_msg_iter_set_emit_stream_end_message(
109 msg_iter_data
->ds_file
->msg_iter
,
110 msg_iter_data
->ds_file_info_index
==
111 msg_iter_data
->ds_file_group
->ds_file_infos
->len
- 1);
115 bt_component_class_message_iterator_next_method_status
ctf_fs_iterator_next_one(
116 struct ctf_fs_msg_iter_data
*msg_iter_data
,
117 const bt_message
**out_msg
)
119 bt_component_class_message_iterator_next_method_status status
;
121 BT_ASSERT_DBG(msg_iter_data
->ds_file
);
126 status
= ctf_fs_ds_file_next(msg_iter_data
->ds_file
, &msg
);
128 case BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
:
132 case BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_END
:
136 if (msg_iter_data
->ds_file_info_index
==
137 msg_iter_data
->ds_file_group
->ds_file_infos
->len
- 1) {
138 /* End of all group's stream files */
142 msg_iter_data
->ds_file_info_index
++;
143 ctf_msg_iter_reset_for_next_stream_file(
144 msg_iter_data
->msg_iter
);
145 set_msg_iter_emits_stream_beginning_end_messages(
149 * Open and start reading the next stream file
150 * within our stream file group.
152 ret
= msg_iter_data_set_current_ds_file(msg_iter_data
);
154 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR
;
158 /* Continue the loop to get the next message */
171 bt_component_class_message_iterator_next_method_status
ctf_fs_iterator_next(
172 bt_self_message_iterator
*iterator
,
173 bt_message_array_const msgs
, uint64_t capacity
,
176 bt_component_class_message_iterator_next_method_status status
=
177 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
;
178 struct ctf_fs_msg_iter_data
*msg_iter_data
=
179 bt_self_message_iterator_get_data(iterator
);
182 while (i
< capacity
&&
183 status
== BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
) {
184 status
= ctf_fs_iterator_next_one(msg_iter_data
, &msgs
[i
]);
185 if (status
== BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
) {
192 * Even if ctf_fs_iterator_next_one() returned something
193 * else than BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK, we
194 * accumulated message objects in the output
195 * message array, so we need to return
196 * BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK so that they are
197 * transfered to downstream. This other status occurs
198 * again the next time muxer_msg_iter_do_next() is
199 * called, possibly without any accumulated
200 * message, in which case we'll return it.
203 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
;
210 int ctf_fs_iterator_reset(struct ctf_fs_msg_iter_data
*msg_iter_data
)
214 msg_iter_data
->ds_file_info_index
= 0;
215 ret
= msg_iter_data_set_current_ds_file(msg_iter_data
);
220 ctf_msg_iter_reset(msg_iter_data
->msg_iter
);
221 set_msg_iter_emits_stream_beginning_end_messages(msg_iter_data
);
228 bt_component_class_message_iterator_seek_beginning_method_status
229 ctf_fs_iterator_seek_beginning(bt_self_message_iterator
*it
)
231 struct ctf_fs_msg_iter_data
*msg_iter_data
=
232 bt_self_message_iterator_get_data(it
);
233 bt_component_class_message_iterator_seek_beginning_method_status status
=
234 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_OK
;
236 BT_ASSERT(msg_iter_data
);
237 if (ctf_fs_iterator_reset(msg_iter_data
)) {
238 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_ERROR
;
245 void ctf_fs_iterator_finalize(bt_self_message_iterator
*it
)
247 ctf_fs_msg_iter_data_destroy(
248 bt_self_message_iterator_get_data(it
));
252 bt_component_class_message_iterator_initialize_method_status
ctf_fs_iterator_init(
253 bt_self_message_iterator
*self_msg_iter
,
254 bt_self_message_iterator_configuration
*config
,
255 bt_self_component_source
*self_comp_src
,
256 bt_self_component_port_output
*self_port
)
258 struct ctf_fs_port_data
*port_data
;
259 struct ctf_fs_msg_iter_data
*msg_iter_data
= NULL
;
260 bt_component_class_message_iterator_initialize_method_status ret
=
261 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_OK
;
262 bt_logging_level log_level
;
263 bt_self_component
*self_comp
=
264 bt_self_component_source_as_self_component(self_comp_src
);
266 port_data
= bt_self_component_port_get_data(
267 bt_self_component_port_output_as_self_component_port(
269 BT_ASSERT(port_data
);
270 log_level
= port_data
->ctf_fs
->log_level
;
271 msg_iter_data
= g_new0(struct ctf_fs_msg_iter_data
, 1);
272 if (!msg_iter_data
) {
273 ret
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
277 msg_iter_data
->log_level
= log_level
;
278 msg_iter_data
->self_comp
= self_comp
;
279 msg_iter_data
->self_msg_iter
= self_msg_iter
;
280 msg_iter_data
->msg_iter
= ctf_msg_iter_create(
281 port_data
->ds_file_group
->ctf_fs_trace
->metadata
->tc
,
282 bt_common_get_page_size(msg_iter_data
->log_level
) * 8,
283 ctf_fs_ds_file_medops
, NULL
, msg_iter_data
->log_level
,
284 self_comp
, self_msg_iter
);
285 if (!msg_iter_data
->msg_iter
) {
286 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Cannot create a CTF message iterator.");
287 ret
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
291 msg_iter_data
->ds_file_group
= port_data
->ds_file_group
;
292 if (ctf_fs_iterator_reset(msg_iter_data
)) {
293 ret
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_ERROR
;
298 * This iterator can seek forward if its stream class has a default
301 if (msg_iter_data
->ds_file_group
->sc
->default_clock_class
) {
302 bt_self_message_iterator_configuration_set_can_seek_forward(
306 bt_self_message_iterator_set_data(self_msg_iter
,
308 if (ret
!= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_OK
) {
311 msg_iter_data
= NULL
;
315 bt_self_message_iterator_set_data(self_msg_iter
, NULL
);
318 ctf_fs_msg_iter_data_destroy(msg_iter_data
);
323 void ctf_fs_trace_destroy(struct ctf_fs_trace
*ctf_fs_trace
)
329 if (ctf_fs_trace
->ds_file_groups
) {
330 g_ptr_array_free(ctf_fs_trace
->ds_file_groups
, TRUE
);
333 BT_TRACE_PUT_REF_AND_RESET(ctf_fs_trace
->trace
);
335 if (ctf_fs_trace
->path
) {
336 g_string_free(ctf_fs_trace
->path
, TRUE
);
339 if (ctf_fs_trace
->metadata
) {
340 ctf_fs_metadata_fini(ctf_fs_trace
->metadata
);
341 g_free(ctf_fs_trace
->metadata
);
344 g_free(ctf_fs_trace
);
348 void ctf_fs_destroy(struct ctf_fs_component
*ctf_fs
)
354 ctf_fs_trace_destroy(ctf_fs
->trace
);
356 if (ctf_fs
->port_data
) {
357 g_ptr_array_free(ctf_fs
->port_data
, TRUE
);
364 void port_data_destroy(struct ctf_fs_port_data
*port_data
)
374 void port_data_destroy_notifier(void *data
) {
375 port_data_destroy(data
);
379 void ctf_fs_trace_destroy_notifier(void *data
)
381 struct ctf_fs_trace
*trace
= data
;
382 ctf_fs_trace_destroy(trace
);
385 struct ctf_fs_component
*ctf_fs_component_create(bt_logging_level log_level
,
386 bt_self_component
*self_comp
)
388 struct ctf_fs_component
*ctf_fs
;
390 ctf_fs
= g_new0(struct ctf_fs_component
, 1);
395 ctf_fs
->log_level
= log_level
;
397 g_ptr_array_new_with_free_func(port_data_destroy_notifier
);
398 if (!ctf_fs
->port_data
) {
405 ctf_fs_destroy(ctf_fs
);
412 void ctf_fs_finalize(bt_self_component_source
*component
)
414 ctf_fs_destroy(bt_self_component_get_data(
415 bt_self_component_source_as_self_component(component
)));
418 gchar
*ctf_fs_make_port_name(struct ctf_fs_ds_file_group
*ds_file_group
)
420 GString
*name
= g_string_new(NULL
);
423 * The unique port name is generated by concatenating unique identifiers
431 /* For the trace, use the uuid if present, else the path. */
432 if (ds_file_group
->ctf_fs_trace
->metadata
->tc
->is_uuid_set
) {
433 char uuid_str
[BT_UUID_STR_LEN
+ 1];
435 bt_uuid_to_str(ds_file_group
->ctf_fs_trace
->metadata
->tc
->uuid
, uuid_str
);
436 g_string_assign(name
, uuid_str
);
438 g_string_assign(name
, ds_file_group
->ctf_fs_trace
->path
->str
);
442 * For the stream class, use the id if present. We can omit this field
443 * otherwise, as there will only be a single stream class.
445 if (ds_file_group
->sc
->id
!= UINT64_C(-1)) {
446 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->sc
->id
);
449 /* For the stream, use the id if present, else, use the path. */
450 if (ds_file_group
->stream_id
!= UINT64_C(-1)) {
451 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->stream_id
);
453 BT_ASSERT(ds_file_group
->ds_file_infos
->len
== 1);
454 struct ctf_fs_ds_file_info
*ds_file_info
=
455 g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
456 g_string_append_printf(name
, " | %s", ds_file_info
->path
->str
);
459 return g_string_free(name
, FALSE
);
463 int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
464 struct ctf_fs_trace
*ctf_fs_trace
,
465 struct ctf_fs_ds_file_group
*ds_file_group
,
466 bt_self_component_source
*self_comp_src
)
469 struct ctf_fs_port_data
*port_data
= NULL
;
471 bt_logging_level log_level
= ctf_fs
->log_level
;
472 bt_self_component
*self_comp
=
473 bt_self_component_source_as_self_component(self_comp_src
);
475 port_name
= ctf_fs_make_port_name(ds_file_group
);
480 BT_COMP_LOGI("Creating one port named `%s`", port_name
);
482 /* Create output port for this file */
483 port_data
= g_new0(struct ctf_fs_port_data
, 1);
488 port_data
->ctf_fs
= ctf_fs
;
489 port_data
->ds_file_group
= ds_file_group
;
490 ret
= bt_self_component_source_add_output_port(
491 self_comp_src
, port_name
, port_data
, NULL
);
496 g_ptr_array_add(ctf_fs
->port_data
, port_data
);
506 port_data_destroy(port_data
);
511 int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
512 struct ctf_fs_trace
*ctf_fs_trace
,
513 bt_self_component_source
*self_comp_src
)
517 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
518 bt_self_component
*self_comp
=
519 bt_self_component_source_as_self_component(self_comp_src
);
521 /* Create one output port for each stream file group */
522 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
523 struct ctf_fs_ds_file_group
*ds_file_group
=
524 g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
526 ret
= create_one_port_for_trace(ctf_fs
, ctf_fs_trace
,
527 ds_file_group
, self_comp_src
);
529 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Cannot create output port.");
539 void ctf_fs_ds_file_info_destroy(struct ctf_fs_ds_file_info
*ds_file_info
)
545 if (ds_file_info
->path
) {
546 g_string_free(ds_file_info
->path
, TRUE
);
549 g_free(ds_file_info
);
553 struct ctf_fs_ds_file_info
*ctf_fs_ds_file_info_create(const char *path
,
556 struct ctf_fs_ds_file_info
*ds_file_info
;
558 ds_file_info
= g_new0(struct ctf_fs_ds_file_info
, 1);
563 ds_file_info
->path
= g_string_new(path
);
564 if (!ds_file_info
->path
) {
565 ctf_fs_ds_file_info_destroy(ds_file_info
);
570 ds_file_info
->begin_ns
= begin_ns
;
577 void ctf_fs_ds_file_group_destroy(struct ctf_fs_ds_file_group
*ds_file_group
)
579 if (!ds_file_group
) {
583 if (ds_file_group
->ds_file_infos
) {
584 g_ptr_array_free(ds_file_group
->ds_file_infos
, TRUE
);
587 if (ds_file_group
->index
) {
588 if (ds_file_group
->index
->entries
) {
589 g_ptr_array_free(ds_file_group
->index
->entries
, TRUE
);
591 g_free(ds_file_group
->index
);
594 bt_stream_put_ref(ds_file_group
->stream
);
595 g_free(ds_file_group
);
599 struct ctf_fs_ds_file_group
*ctf_fs_ds_file_group_create(
600 struct ctf_fs_trace
*ctf_fs_trace
,
601 struct ctf_stream_class
*sc
,
602 uint64_t stream_instance_id
,
603 struct ctf_fs_ds_index
*index
)
605 struct ctf_fs_ds_file_group
*ds_file_group
;
607 ds_file_group
= g_new0(struct ctf_fs_ds_file_group
, 1);
608 if (!ds_file_group
) {
612 ds_file_group
->ds_file_infos
= g_ptr_array_new_with_free_func(
613 (GDestroyNotify
) ctf_fs_ds_file_info_destroy
);
614 if (!ds_file_group
->ds_file_infos
) {
618 ds_file_group
->index
= index
;
620 ds_file_group
->stream_id
= stream_instance_id
;
622 ds_file_group
->sc
= sc
;
623 ds_file_group
->ctf_fs_trace
= ctf_fs_trace
;
627 ctf_fs_ds_file_group_destroy(ds_file_group
);
628 ctf_fs_ds_index_destroy(index
);
629 ds_file_group
= NULL
;
632 return ds_file_group
;
635 /* Replace by g_ptr_array_insert when we depend on glib >= 2.40. */
637 void array_insert(GPtrArray
*array
, gpointer element
, size_t pos
)
639 size_t original_array_len
= array
->len
;
641 /* Allocate an unused element at the end of the array. */
642 g_ptr_array_add(array
, NULL
);
644 /* If we are not inserting at the end, move the elements by one. */
645 if (pos
< original_array_len
) {
646 memmove(&(array
->pdata
[pos
+ 1]),
647 &(array
->pdata
[pos
]),
648 (original_array_len
- pos
) * sizeof(gpointer
));
651 /* Insert the value. */
652 array
->pdata
[pos
] = element
;
656 * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right
657 * place to keep it sorted.
661 void ds_file_group_insert_ds_file_info_sorted(
662 struct ctf_fs_ds_file_group
*ds_file_group
,
663 struct ctf_fs_ds_file_info
*ds_file_info
)
667 /* Find the spot where to insert this ds_file_info. */
668 for (i
= 0; i
< ds_file_group
->ds_file_infos
->len
; i
++) {
669 struct ctf_fs_ds_file_info
*other_ds_file_info
=
670 g_ptr_array_index(ds_file_group
->ds_file_infos
, i
);
672 if (ds_file_info
->begin_ns
< other_ds_file_info
->begin_ns
) {
677 array_insert(ds_file_group
->ds_file_infos
, ds_file_info
, i
);
681 void ds_index_insert_ds_index_entry_sorted(
682 struct ctf_fs_ds_index
*index
,
683 struct ctf_fs_ds_index_entry
*entry
)
687 /* Find the spot where to insert this index entry. */
688 for (i
= 0; i
< index
->entries
->len
; i
++) {
689 struct ctf_fs_ds_index_entry
*other_entry
=
690 g_ptr_array_index(index
->entries
, i
);
692 if (entry
->timestamp_begin_ns
< other_entry
->timestamp_begin_ns
) {
697 array_insert(index
->entries
, entry
, i
);
701 void merge_ctf_fs_ds_indexes(struct ctf_fs_ds_index
*dest
, struct ctf_fs_ds_index
*src
)
705 for (i
= 0; i
< src
->entries
->len
; i
++) {
706 struct ctf_fs_ds_index_entry
*entry
=
707 g_ptr_array_index(src
->entries
, i
);
710 * Ownership of the ctf_fs_ds_index_entry is transferred to
713 g_ptr_array_index(src
->entries
, i
) = NULL
;
715 ds_index_insert_ds_index_entry_sorted(dest
, entry
);
720 int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
,
723 int64_t stream_instance_id
= -1;
724 int64_t begin_ns
= -1;
725 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
726 bool add_group
= false;
729 struct ctf_fs_ds_file
*ds_file
= NULL
;
730 struct ctf_fs_ds_file_info
*ds_file_info
= NULL
;
731 struct ctf_fs_ds_index
*index
= NULL
;
732 struct ctf_msg_iter
*msg_iter
= NULL
;
733 struct ctf_stream_class
*sc
= NULL
;
734 struct ctf_msg_iter_packet_properties props
;
735 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
736 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
737 bt_self_component_class
*self_comp_class
= ctf_fs_trace
->self_comp_class
;
739 msg_iter
= ctf_msg_iter_create(ctf_fs_trace
->metadata
->tc
,
740 bt_common_get_page_size(log_level
) * 8,
741 ctf_fs_ds_file_medops
, NULL
, log_level
, self_comp
, NULL
);
743 BT_COMP_LOGE_STR("Cannot create a CTF message iterator.");
747 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, msg_iter
,
748 NULL
, path
, log_level
);
753 ret
= ctf_msg_iter_get_packet_properties(ds_file
->msg_iter
, &props
);
755 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
756 "Cannot get stream file's first packet's header and context fields (`%s`).",
761 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
,
762 props
.stream_class_id
);
764 stream_instance_id
= props
.data_stream_id
;
766 if (props
.snapshots
.beginning_clock
!= UINT64_C(-1)) {
767 BT_ASSERT(sc
->default_clock_class
);
768 ret
= bt_util_clock_cycles_to_ns_from_origin(
769 props
.snapshots
.beginning_clock
,
770 sc
->default_clock_class
->frequency
,
771 sc
->default_clock_class
->offset_seconds
,
772 sc
->default_clock_class
->offset_cycles
, &begin_ns
);
774 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
775 "Cannot convert clock cycles to nanoseconds from origin (`%s`).",
781 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
);
786 index
= ctf_fs_ds_file_build_index(ds_file
, ds_file_info
);
788 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
789 self_comp
, self_comp_class
,
790 "Failed to index CTF stream file \'%s\'",
791 ds_file
->file
->path
->str
);
795 if (begin_ns
== -1) {
797 * No beggining timestamp to sort the stream files
798 * within a stream file group, so consider that this
799 * file must be the only one within its group.
801 stream_instance_id
= -1;
804 if (stream_instance_id
== -1) {
806 * No stream instance ID or no beginning timestamp:
807 * create a unique stream file group for this stream
808 * file because, even if there's a stream instance ID,
809 * there's no timestamp to order the file within its
812 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
,
813 sc
, UINT64_C(-1), index
);
814 /* Ownership of index is transferred. */
817 if (!ds_file_group
) {
821 ds_file_group_insert_ds_file_info_sorted(ds_file_group
,
822 BT_MOVE_REF(ds_file_info
));
828 BT_ASSERT(stream_instance_id
!= -1);
829 BT_ASSERT(begin_ns
!= -1);
831 /* Find an existing stream file group with this ID */
832 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
833 ds_file_group
= g_ptr_array_index(
834 ctf_fs_trace
->ds_file_groups
, i
);
836 if (ds_file_group
->sc
== sc
&&
837 ds_file_group
->stream_id
==
838 stream_instance_id
) {
842 ds_file_group
= NULL
;
845 if (!ds_file_group
) {
846 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
,
847 sc
, stream_instance_id
, index
);
848 /* Ownership of index is transferred. */
850 if (!ds_file_group
) {
856 merge_ctf_fs_ds_indexes(ds_file_group
->index
, index
);
859 ds_file_group_insert_ds_file_info_sorted(ds_file_group
,
860 BT_MOVE_REF(ds_file_info
));
865 ctf_fs_ds_file_group_destroy(ds_file_group
);
866 ds_file_group
= NULL
;
870 if (add_group
&& ds_file_group
) {
871 g_ptr_array_add(ctf_fs_trace
->ds_file_groups
, ds_file_group
);
874 ctf_fs_ds_file_destroy(ds_file
);
875 ctf_fs_ds_file_info_destroy(ds_file_info
);
878 ctf_msg_iter_destroy(msg_iter
);
881 ctf_fs_ds_index_destroy(index
);
886 int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
889 const char *basename
;
890 GError
*error
= NULL
;
892 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
893 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
894 bt_self_component_class
*self_comp_class
= ctf_fs_trace
->self_comp_class
;
896 /* Check each file in the path directory, except specific ones */
897 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
899 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
900 "Cannot open directory `%s`: %s (code %d)",
901 ctf_fs_trace
->path
->str
, error
->message
,
906 while ((basename
= g_dir_read_name(dir
))) {
907 struct ctf_fs_file
*file
;
909 if (strcmp(basename
, CTF_FS_METADATA_FILENAME
) == 0) {
910 /* Ignore the metadata stream. */
911 BT_COMP_LOGI("Ignoring metadata file `%s" G_DIR_SEPARATOR_S
"%s`",
912 ctf_fs_trace
->path
->str
, basename
);
916 if (basename
[0] == '.') {
917 BT_COMP_LOGI("Ignoring hidden file `%s" G_DIR_SEPARATOR_S
"%s`",
918 ctf_fs_trace
->path
->str
, basename
);
922 /* Create the file. */
923 file
= ctf_fs_file_create(log_level
, self_comp
);
925 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
926 "Cannot create stream file object for file `%s" G_DIR_SEPARATOR_S
"%s`",
927 ctf_fs_trace
->path
->str
, basename
);
931 /* Create full path string. */
932 g_string_append_printf(file
->path
, "%s" G_DIR_SEPARATOR_S
"%s",
933 ctf_fs_trace
->path
->str
, basename
);
934 if (!g_file_test(file
->path
->str
, G_FILE_TEST_IS_REGULAR
)) {
935 BT_COMP_LOGI("Ignoring non-regular file `%s`",
937 ctf_fs_file_destroy(file
);
942 ret
= ctf_fs_file_open(file
, "rb");
944 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
945 "Cannot open stream file `%s`",
950 if (file
->size
== 0) {
951 /* Skip empty stream. */
952 BT_COMP_LOGI("Ignoring empty file `%s`", file
->path
->str
);
953 ctf_fs_file_destroy(file
);
957 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
,
960 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
961 "Cannot add stream file `%s` to stream file group",
963 ctf_fs_file_destroy(file
);
967 ctf_fs_file_destroy(file
);
989 int set_trace_name(bt_trace
*trace
, const char *name_suffix
,
990 bt_logging_level log_level
, bt_self_component
*self_comp
)
996 name
= g_string_new(NULL
);
998 BT_COMP_LOGE_STR("Failed to allocate a GString.");
1004 * Check if we have a trace environment string value named `hostname`.
1005 * If so, use it as the trace name's prefix.
1007 val
= bt_trace_borrow_environment_entry_value_by_name_const(
1009 if (val
&& bt_value_is_string(val
)) {
1010 g_string_append(name
, bt_value_string_get(val
));
1013 g_string_append_c(name
, G_DIR_SEPARATOR
);
1018 g_string_append(name
, name_suffix
);
1021 ret
= bt_trace_set_name(trace
, name
->str
);
1030 g_string_free(name
, TRUE
);
1037 struct ctf_fs_trace
*ctf_fs_trace_create(
1038 bt_self_component
*self_comp
,
1039 bt_self_component_class
*self_comp_class
,
1040 const char *path
, const char *name
,
1041 struct ctf_fs_metadata_config
*metadata_config
,
1042 bt_logging_level log_level
)
1044 struct ctf_fs_trace
*ctf_fs_trace
;
1047 /* Only one of them must be set. */
1048 BT_ASSERT(!self_comp
!= !self_comp_class
);
1050 ctf_fs_trace
= g_new0(struct ctf_fs_trace
, 1);
1051 if (!ctf_fs_trace
) {
1055 ctf_fs_trace
->log_level
= log_level
;
1056 ctf_fs_trace
->self_comp
= self_comp
;
1057 ctf_fs_trace
->self_comp_class
= self_comp_class
;
1058 ctf_fs_trace
->path
= g_string_new(path
);
1059 if (!ctf_fs_trace
->path
) {
1063 ctf_fs_trace
->metadata
= g_new0(struct ctf_fs_metadata
, 1);
1064 if (!ctf_fs_trace
->metadata
) {
1068 ctf_fs_metadata_init(ctf_fs_trace
->metadata
);
1069 ctf_fs_trace
->ds_file_groups
= g_ptr_array_new_with_free_func(
1070 (GDestroyNotify
) ctf_fs_ds_file_group_destroy
);
1071 if (!ctf_fs_trace
->ds_file_groups
) {
1075 ret
= ctf_fs_metadata_set_trace_class(self_comp
, ctf_fs_trace
,
1081 if (ctf_fs_trace
->metadata
->trace_class
) {
1082 ctf_fs_trace
->trace
=
1083 bt_trace_create(ctf_fs_trace
->metadata
->trace_class
);
1084 if (!ctf_fs_trace
->trace
) {
1089 if (ctf_fs_trace
->trace
) {
1090 ret
= ctf_trace_class_configure_ir_trace(
1091 ctf_fs_trace
->metadata
->tc
, ctf_fs_trace
->trace
);
1096 ret
= set_trace_name(ctf_fs_trace
->trace
, name
, log_level
,
1103 ret
= create_ds_file_groups(ctf_fs_trace
);
1111 ctf_fs_trace_destroy(ctf_fs_trace
);
1112 ctf_fs_trace
= NULL
;
1115 return ctf_fs_trace
;
1119 int path_is_ctf_trace(const char *path
)
1121 GString
*metadata_path
= g_string_new(NULL
);
1124 if (!metadata_path
) {
1129 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
1131 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
1137 g_string_free(metadata_path
, TRUE
);
1141 /* Helper for ctf_fs_component_create_ctf_fs_trace, to handle a single path. */
1144 int ctf_fs_component_create_ctf_fs_trace_one_path(
1145 struct ctf_fs_component
*ctf_fs
,
1146 const char *path_param
,
1147 const char *trace_name
,
1149 bt_self_component
*self_comp
,
1150 bt_self_component_class
*self_comp_class
)
1152 struct ctf_fs_trace
*ctf_fs_trace
;
1155 bt_logging_level log_level
= ctf_fs
->log_level
;
1157 norm_path
= bt_common_normalize_path(path_param
, NULL
);
1159 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1160 "Failed to normalize path: `%s`.",
1165 ret
= path_is_ctf_trace(norm_path
->str
);
1167 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1168 "Failed to check if path is a CTF trace: path=%s",
1171 } else if (ret
== 0) {
1172 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1173 "Path is not a CTF trace (does not contain a metadata file): `%s`.",
1178 // FIXME: Remove or ifdef for __MINGW32__
1179 if (strcmp(norm_path
->str
, "/") == 0) {
1180 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1181 "Opening a trace in `/` is not supported.");
1186 ctf_fs_trace
= ctf_fs_trace_create(self_comp
, self_comp_class
, norm_path
->str
,
1187 trace_name
, &ctf_fs
->metadata_config
, log_level
);
1188 if (!ctf_fs_trace
) {
1189 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1190 "Cannot create trace for `%s`.",
1195 g_ptr_array_add(traces
, ctf_fs_trace
);
1196 ctf_fs_trace
= NULL
;
1206 g_string_free(norm_path
, TRUE
);
1213 * Count the number of stream and event classes defined by this trace's metadata.
1215 * This is used to determine which metadata is the "latest", out of multiple
1216 * traces sharing the same UUID. It is assumed that amongst all these metadatas,
1217 * a bigger metadata is a superset of a smaller metadata. Therefore, it is
1218 * enough to just count the classes.
1222 unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace
*trace
)
1224 unsigned int num
= trace
->metadata
->tc
->stream_classes
->len
;
1227 for (i
= 0; i
< trace
->metadata
->tc
->stream_classes
->len
; i
++) {
1228 struct ctf_stream_class
*sc
= trace
->metadata
->tc
->stream_classes
->pdata
[i
];
1229 num
+= sc
->event_classes
->len
;
1236 * Merge the src ds_file_group into dest. This consists of merging their
1237 * ds_file_infos, making sure to keep the result sorted.
1241 void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group
*dest
, struct ctf_fs_ds_file_group
*src
)
1245 for (i
= 0; i
< src
->ds_file_infos
->len
; i
++) {
1246 struct ctf_fs_ds_file_info
*ds_file_info
=
1247 g_ptr_array_index(src
->ds_file_infos
, i
);
1249 /* Ownership of the ds_file_info is transferred to dest. */
1250 g_ptr_array_index(src
->ds_file_infos
, i
) = NULL
;
1252 ds_file_group_insert_ds_file_info_sorted(dest
, ds_file_info
);
1255 /* Merge both indexes. */
1256 merge_ctf_fs_ds_indexes(dest
->index
, src
->index
);
1258 /* Merge src_trace's data stream file groups into dest_trace's. */
1261 int merge_matching_ctf_fs_ds_file_groups(
1262 struct ctf_fs_trace
*dest_trace
,
1263 struct ctf_fs_trace
*src_trace
)
1266 GPtrArray
*dest
= dest_trace
->ds_file_groups
;
1267 GPtrArray
*src
= src_trace
->ds_file_groups
;
1272 * Save the initial length of dest: we only want to check against the
1273 * original elements in the inner loop.
1275 const guint dest_len
= dest
->len
;
1277 for (s_i
= 0; s_i
< src
->len
; s_i
++) {
1278 struct ctf_fs_ds_file_group
*src_group
= g_ptr_array_index(src
, s_i
);
1279 struct ctf_fs_ds_file_group
*dest_group
= NULL
;
1281 /* A stream instance without ID can't match a stream in the other trace. */
1282 if (src_group
->stream_id
!= -1) {
1285 /* Let's search for a matching ds_file_group in the destination. */
1286 for (d_i
= 0; d_i
< dest_len
; d_i
++) {
1287 struct ctf_fs_ds_file_group
*candidate_dest
= g_ptr_array_index(dest
, d_i
);
1289 /* Can't match a stream instance without ID. */
1290 if (candidate_dest
->stream_id
== -1) {
1295 * If the two groups have the same stream instance id
1296 * and belong to the same stream class (stream instance
1297 * ids are per-stream class), they represent the same
1300 if (candidate_dest
->stream_id
!= src_group
->stream_id
||
1301 candidate_dest
->sc
->id
!= src_group
->sc
->id
) {
1305 dest_group
= candidate_dest
;
1311 * Didn't find a friend in dest to merge our src_group into?
1312 * Create a new empty one. This can happen if a stream was
1313 * active in the source trace chunk but not in the destination
1317 struct ctf_stream_class
*sc
;
1318 struct ctf_fs_ds_index
*index
;
1320 sc
= ctf_trace_class_borrow_stream_class_by_id(
1321 dest_trace
->metadata
->tc
, src_group
->sc
->id
);
1324 index
= ctf_fs_ds_index_create(dest_trace
->log_level
,
1325 dest_trace
->self_comp
);
1331 dest_group
= ctf_fs_ds_file_group_create(dest_trace
, sc
,
1332 src_group
->stream_id
, index
);
1333 /* Ownership of index is transferred. */
1340 g_ptr_array_add(dest_trace
->ds_file_groups
, dest_group
);
1343 BT_ASSERT(dest_group
);
1344 merge_ctf_fs_ds_file_groups(dest_group
, src_group
);
1352 * Collapse the given traces, which must all share the same UUID, in a single
1355 * The trace with the most expansive metadata is chosen and all other traces
1356 * are merged into that one. The array slots of all the traces that get merged
1357 * in the chosen one are set to NULL, so only the slot of the chosen trace
1362 int merge_ctf_fs_traces(struct ctf_fs_trace
**traces
, unsigned int num_traces
,
1363 struct ctf_fs_trace
**out_trace
)
1365 unsigned int winner_count
;
1366 struct ctf_fs_trace
*winner
;
1370 BT_ASSERT(num_traces
>= 2);
1372 winner_count
= metadata_count_stream_and_event_classes(traces
[0]);
1376 /* Find the trace with the largest metadata. */
1377 for (i
= 1; i
< num_traces
; i
++) {
1378 struct ctf_fs_trace
*candidate
;
1379 unsigned int candidate_count
;
1381 candidate
= traces
[i
];
1383 /* A bit of sanity check. */
1384 BT_ASSERT(bt_uuid_compare(winner
->metadata
->tc
->uuid
, candidate
->metadata
->tc
->uuid
) == 0);
1386 candidate_count
= metadata_count_stream_and_event_classes(candidate
);
1388 if (candidate_count
> winner_count
) {
1389 winner_count
= candidate_count
;
1395 /* Merge all the other traces in the winning trace. */
1396 for (i
= 0; i
< num_traces
; i
++) {
1397 struct ctf_fs_trace
*trace
= traces
[i
];
1399 /* Don't merge the winner into itself. */
1400 if (trace
== winner
) {
1404 /* Merge trace's data stream file groups into winner's. */
1405 ret
= merge_matching_ctf_fs_ds_file_groups(winner
, trace
);
1412 * Move the winner out of the array, into `*out_trace`.
1414 *out_trace
= winner
;
1415 traces
[winner_i
] = NULL
;
1427 int decode_clock_snapshot_after_event(struct ctf_fs_trace
*ctf_fs_trace
,
1428 struct ctf_clock_class
*default_cc
,
1429 struct ctf_fs_ds_index_entry
*index_entry
,
1430 enum target_event target_event
, uint64_t *cs
, int64_t *ts_ns
)
1432 enum ctf_msg_iter_status iter_status
= CTF_MSG_ITER_STATUS_OK
;
1433 struct ctf_fs_ds_file
*ds_file
= NULL
;
1434 struct ctf_msg_iter
*msg_iter
= NULL
;
1435 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
1436 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
1439 BT_ASSERT(ctf_fs_trace
);
1440 BT_ASSERT(ctf_fs_trace
->metadata
);
1441 BT_ASSERT(ctf_fs_trace
->metadata
->tc
);
1443 msg_iter
= ctf_msg_iter_create(ctf_fs_trace
->metadata
->tc
,
1444 bt_common_get_page_size(log_level
) * 8, ctf_fs_ds_file_medops
,
1445 NULL
, log_level
, self_comp
, NULL
);
1447 /* ctf_msg_iter_create() logs errors. */
1452 BT_ASSERT(index_entry
);
1453 BT_ASSERT(index_entry
->path
);
1455 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, msg_iter
,
1456 NULL
, index_entry
->path
, log_level
);
1458 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Failed to create a ctf_fs_ds_file");
1464 * Turn on dry run mode to prevent the creation and usage of Babeltrace
1465 * library objects (bt_field, bt_message_*, etc.).
1467 ctf_msg_iter_set_dry_run(msg_iter
, true);
1469 /* Seek to the beginning of the target packet. */
1470 iter_status
= ctf_msg_iter_seek(ds_file
->msg_iter
, index_entry
->offset
);
1472 /* ctf_msg_iter_seek() logs errors. */
1477 switch (target_event
) {
1480 * Start to decode the packet until we reach the end of
1481 * the first event. To extract the first event's clock
1484 iter_status
= ctf_msg_iter_curr_packet_first_event_clock_snapshot(
1485 ds_file
->msg_iter
, cs
);
1488 /* Decode the packet to extract the last event's clock snapshot. */
1489 iter_status
= ctf_msg_iter_curr_packet_last_event_clock_snapshot(
1490 ds_file
->msg_iter
, cs
);
1500 /* Convert clock snapshot to timestamp. */
1501 ret
= bt_util_clock_cycles_to_ns_from_origin(*cs
,
1502 default_cc
->frequency
, default_cc
->offset_seconds
,
1503 default_cc
->offset_cycles
, ts_ns
);
1505 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1506 "Failed to convert clock snapshot to timestamp");
1512 ctf_fs_ds_file_destroy(ds_file
);
1515 ctf_msg_iter_destroy(msg_iter
);
1522 int decode_packet_first_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1523 struct ctf_clock_class
*default_cc
,
1524 struct ctf_fs_ds_index_entry
*index_entry
, uint64_t *cs
, int64_t *ts_ns
)
1526 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
,
1527 index_entry
, FIRST_EVENT
, cs
, ts_ns
);
1531 int decode_packet_last_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1532 struct ctf_clock_class
*default_cc
,
1533 struct ctf_fs_ds_index_entry
*index_entry
, uint64_t *cs
, int64_t *ts_ns
)
1535 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
,
1536 index_entry
, LAST_EVENT
, cs
, ts_ns
);
1540 * Fix up packet index entries for lttng's "event-after-packet" bug.
1541 * Some buggy lttng tracer versions may emit events with a timestamp that is
1542 * larger (after) than the timestamp_end of the their packets.
1544 * To fix up this erroneous data we do the following:
1545 * 1. If it's not the stream file's last packet: set the packet index entry's
1546 * end time to the next packet's beginning time.
1547 * 2. If it's the stream file's last packet, set the packet index entry's end
1548 * time to the packet's last event's time, if any, or to the packet's
1549 * beginning time otherwise.
1551 * Known buggy tracer versions:
1552 * - before lttng-ust 2.11.0
1553 * - before lttng-module 2.11.0
1554 * - before lttng-module 2.10.10
1555 * - before lttng-module 2.9.13
1558 int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace
*trace
)
1561 guint ds_file_group_i
;
1562 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1563 bt_logging_level log_level
= trace
->log_level
;
1565 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
;
1566 ds_file_group_i
++) {
1568 struct ctf_clock_class
*default_cc
;
1569 struct ctf_fs_ds_index_entry
*last_entry
;
1570 struct ctf_fs_ds_index
*index
;
1572 struct ctf_fs_ds_file_group
*ds_file_group
=
1573 g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1575 BT_ASSERT(ds_file_group
);
1576 index
= ds_file_group
->index
;
1579 BT_ASSERT(index
->entries
);
1580 BT_ASSERT(index
->entries
->len
> 0);
1583 * Iterate over all entries but the last one. The last one is
1584 * fixed differently after.
1586 for (entry_i
= 0; entry_i
< index
->entries
->len
- 1;
1588 struct ctf_fs_ds_index_entry
*curr_entry
, *next_entry
;
1590 curr_entry
= g_ptr_array_index(index
->entries
, entry_i
);
1591 next_entry
= g_ptr_array_index(index
->entries
, entry_i
+ 1);
1594 * 1. Set the current index entry `end` timestamp to
1595 * the next index entry `begin` timestamp.
1597 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1598 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1602 * 2. Fix the last entry by decoding the last event of the last
1605 last_entry
= g_ptr_array_index(index
->entries
,
1606 index
->entries
->len
- 1);
1607 BT_ASSERT(last_entry
);
1609 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1610 default_cc
= ds_file_group
->sc
->default_clock_class
;
1613 * Decode packet to read the timestamp of the last event of the
1616 ret
= decode_packet_last_event_timestamp(trace
, default_cc
,
1617 last_entry
, &last_entry
->timestamp_end
,
1618 &last_entry
->timestamp_end_ns
);
1620 BT_COMP_LOGE_APPEND_CAUSE(trace
->self_comp
,
1621 "Failed to decode stream's last packet to get its last event's clock snapshot.");
1631 * Fix up packet index entries for barectf's "event-before-packet" bug.
1632 * Some buggy barectf tracer versions may emit events with a timestamp that is
1633 * less than the timestamp_begin of the their packets.
1635 * To fix up this erroneous data we do the following:
1636 * 1. Starting at the second index entry, set the timestamp_begin of the
1637 * current entry to the timestamp of the first event of the packet.
1638 * 2. Set the previous entry's timestamp_end to the timestamp_begin of the
1641 * Known buggy tracer versions:
1642 * - before barectf 2.3.1
1645 int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace
*trace
)
1648 guint ds_file_group_i
;
1649 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1650 bt_logging_level log_level
= trace
->log_level
;
1652 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
;
1653 ds_file_group_i
++) {
1655 struct ctf_clock_class
*default_cc
;
1656 struct ctf_fs_ds_file_group
*ds_file_group
=
1657 g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1659 struct ctf_fs_ds_index
*index
= ds_file_group
->index
;
1662 BT_ASSERT(index
->entries
);
1663 BT_ASSERT(index
->entries
->len
> 0);
1665 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1666 default_cc
= ds_file_group
->sc
->default_clock_class
;
1669 * 1. Iterate over the index, starting from the second entry
1672 for (entry_i
= 1; entry_i
< index
->entries
->len
;
1674 struct ctf_fs_ds_index_entry
*curr_entry
, *prev_entry
;
1675 prev_entry
= g_ptr_array_index(index
->entries
, entry_i
- 1);
1676 curr_entry
= g_ptr_array_index(index
->entries
, entry_i
);
1678 * 2. Set the current entry `begin` timestamp to the
1679 * timestamp of the first event of the current packet.
1681 ret
= decode_packet_first_event_timestamp(trace
, default_cc
,
1682 curr_entry
, &curr_entry
->timestamp_begin
,
1683 &curr_entry
->timestamp_begin_ns
);
1685 BT_COMP_LOGE_APPEND_CAUSE(trace
->self_comp
,
1686 "Failed to decode first event's clock snapshot");
1691 * 3. Set the previous entry `end` timestamp to the
1692 * timestamp of the first event of the current packet.
1694 prev_entry
->timestamp_end
= curr_entry
->timestamp_begin
;
1695 prev_entry
->timestamp_end_ns
= curr_entry
->timestamp_begin_ns
;
1703 * When using the lttng-crash feature it's likely that the last packets of each
1704 * stream have their timestamp_end set to zero. This is caused by the fact that
1705 * the tracer crashed and was not able to properly close the packets.
1707 * To fix up this erroneous data we do the following:
1708 * For each index entry, if the entry's timestamp_end is 0 and the
1709 * timestamp_begin is not 0:
1710 * - If it's the stream file's last packet: set the packet index entry's end
1711 * time to the packet's last event's time, if any, or to the packet's
1712 * beginning time otherwise.
1713 * - If it's not the stream file's last packet: set the packet index
1714 * entry's end time to the next packet's beginning time.
1716 * Affected versions:
1717 * - All current and future lttng-ust and lttng-modules versions.
1720 int fix_index_lttng_crash_quirk(struct ctf_fs_trace
*trace
)
1723 guint ds_file_group_idx
;
1724 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1725 bt_logging_level log_level
= trace
->log_level
;
1727 for (ds_file_group_idx
= 0; ds_file_group_idx
< ds_file_groups
->len
;
1728 ds_file_group_idx
++) {
1730 struct ctf_clock_class
*default_cc
;
1731 struct ctf_fs_ds_index_entry
*last_entry
;
1732 struct ctf_fs_ds_index
*index
;
1734 struct ctf_fs_ds_file_group
*ds_file_group
=
1735 g_ptr_array_index(ds_file_groups
, ds_file_group_idx
);
1737 BT_ASSERT(ds_file_group
);
1738 index
= ds_file_group
->index
;
1740 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1741 default_cc
= ds_file_group
->sc
->default_clock_class
;
1744 BT_ASSERT(index
->entries
);
1745 BT_ASSERT(index
->entries
->len
> 0);
1747 last_entry
= g_ptr_array_index(index
->entries
,
1748 index
->entries
->len
- 1);
1749 BT_ASSERT(last_entry
);
1752 /* 1. Fix the last entry first. */
1753 if (last_entry
->timestamp_end
== 0 &&
1754 last_entry
->timestamp_begin
!= 0) {
1756 * Decode packet to read the timestamp of the
1757 * last event of the stream file.
1759 ret
= decode_packet_last_event_timestamp(trace
,
1760 default_cc
, last_entry
,
1761 &last_entry
->timestamp_end
,
1762 &last_entry
->timestamp_end_ns
);
1764 BT_COMP_LOGE_APPEND_CAUSE(trace
->self_comp
,
1765 "Failed to decode last event's clock snapshot");
1770 /* Iterate over all entries but the last one. */
1771 for (entry_idx
= 0; entry_idx
< index
->entries
->len
- 1;
1773 struct ctf_fs_ds_index_entry
*curr_entry
, *next_entry
;
1774 curr_entry
= g_ptr_array_index(index
->entries
, entry_idx
);
1775 next_entry
= g_ptr_array_index(index
->entries
, entry_idx
+ 1);
1777 if (curr_entry
->timestamp_end
== 0 &&
1778 curr_entry
->timestamp_begin
!= 0) {
1780 * 2. Set the current index entry `end` timestamp to
1781 * the next index entry `begin` timestamp.
1783 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1784 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1794 * Extract the tracer information necessary to compare versions.
1795 * Returns 0 on success, and -1 if the extraction is not successful because the
1796 * necessary fields are absents in the trace metadata.
1799 int extract_tracer_info(struct ctf_fs_trace
*trace
,
1800 struct tracer_info
*current_tracer_info
)
1803 struct ctf_trace_class_env_entry
*entry
;
1805 /* Clear the current_tracer_info struct */
1806 memset(current_tracer_info
, 0, sizeof(*current_tracer_info
));
1809 * To compare 2 tracer versions, at least the tracer name and it's
1810 * major version are needed. If one of these is missing, consider it an
1811 * extraction failure.
1813 entry
= ctf_trace_class_borrow_env_entry_by_name(
1814 trace
->metadata
->tc
, "tracer_name");
1815 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR
) {
1816 goto missing_bare_minimum
;
1819 /* Set tracer name. */
1820 current_tracer_info
->name
= entry
->value
.str
->str
;
1822 entry
= ctf_trace_class_borrow_env_entry_by_name(
1823 trace
->metadata
->tc
, "tracer_major");
1824 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1825 goto missing_bare_minimum
;
1828 /* Set major version number. */
1829 current_tracer_info
->major
= entry
->value
.i
;
1831 entry
= ctf_trace_class_borrow_env_entry_by_name(
1832 trace
->metadata
->tc
, "tracer_minor");
1833 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1837 /* Set minor version number. */
1838 current_tracer_info
->minor
= entry
->value
.i
;
1840 entry
= ctf_trace_class_borrow_env_entry_by_name(
1841 trace
->metadata
->tc
, "tracer_patch");
1844 * If `tracer_patch` doesn't exist `tracer_patchlevel` might.
1845 * For example, `lttng-modules` uses entry name
1846 * `tracer_patchlevel`.
1848 entry
= ctf_trace_class_borrow_env_entry_by_name(
1849 trace
->metadata
->tc
, "tracer_patchlevel");
1852 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1856 /* Set patch version number. */
1857 current_tracer_info
->patch
= entry
->value
.i
;
1861 missing_bare_minimum
:
1868 bool is_tracer_affected_by_lttng_event_after_packet_bug(
1869 struct tracer_info
*curr_tracer_info
)
1871 bool is_affected
= false;
1873 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1874 if (curr_tracer_info
->major
< 2) {
1876 } else if (curr_tracer_info
->major
== 2) {
1877 /* fixed in lttng-ust 2.11.0 */
1878 if (curr_tracer_info
->minor
< 11) {
1882 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1883 if (curr_tracer_info
->major
< 2) {
1885 } else if (curr_tracer_info
->major
== 2) {
1886 /* fixed in lttng-modules 2.11.0 */
1887 if (curr_tracer_info
->minor
== 10) {
1888 /* fixed in lttng-modules 2.10.10 */
1889 if (curr_tracer_info
->patch
< 10) {
1892 } else if (curr_tracer_info
->minor
== 9) {
1893 /* fixed in lttng-modules 2.9.13 */
1894 if (curr_tracer_info
->patch
< 13) {
1897 } else if (curr_tracer_info
->minor
< 9) {
1907 bool is_tracer_affected_by_barectf_event_before_packet_bug(
1908 struct tracer_info
*curr_tracer_info
)
1910 bool is_affected
= false;
1912 if (strcmp(curr_tracer_info
->name
, "barectf") == 0) {
1913 if (curr_tracer_info
->major
< 2) {
1915 } else if (curr_tracer_info
->major
== 2) {
1916 if (curr_tracer_info
->minor
< 3) {
1918 } else if (curr_tracer_info
->minor
== 3) {
1919 /* fixed in barectf 2.3.1 */
1920 if (curr_tracer_info
->patch
< 1) {
1931 bool is_tracer_affected_by_lttng_crash_quirk(
1932 struct tracer_info
*curr_tracer_info
)
1934 bool is_affected
= false;
1936 /* All LTTng tracer may be affected by this lttng crash quirk. */
1937 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1939 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1947 * Looks for trace produced by known buggy tracers and fix up the index
1951 int fix_packet_index_tracer_bugs(struct ctf_fs_component
*ctf_fs
,
1952 bt_self_component
*self_comp
,
1953 bt_self_component_class
*self_comp_class
)
1956 struct tracer_info current_tracer_info
;
1957 bt_logging_level log_level
= ctf_fs
->log_level
;
1959 ret
= extract_tracer_info(ctf_fs
->trace
, ¤t_tracer_info
);
1962 * A trace may not have all the necessary environment
1963 * entries to do the tracer version comparison.
1964 * At least, the tracer name and major version number
1965 * are needed. Failing to extract these entries is not
1969 BT_LOGI_STR("Cannot extract tracer information necessary to compare with buggy versions.");
1973 /* Check if the trace may be affected by old tracer bugs. */
1974 if (is_tracer_affected_by_lttng_event_after_packet_bug(
1975 ¤t_tracer_info
)) {
1976 BT_LOGI_STR("Trace may be affected by LTTng tracer packet timestamp bug. Fixing up.");
1977 ret
= fix_index_lttng_event_after_packet_bug(ctf_fs
->trace
);
1979 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
1980 self_comp
, self_comp_class
,
1981 "Failed to fix LTTng event-after-packet bug.");
1984 ctf_fs
->trace
->metadata
->tc
->quirks
.lttng_event_after_packet
= true;
1987 if (is_tracer_affected_by_barectf_event_before_packet_bug(
1988 ¤t_tracer_info
)) {
1989 BT_LOGI_STR("Trace may be affected by barectf tracer packet timestamp bug. Fixing up.");
1990 ret
= fix_index_barectf_event_before_packet_bug(ctf_fs
->trace
);
1992 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
1993 self_comp
, self_comp_class
,
1994 "Failed to fix barectf event-before-packet bug.");
1997 ctf_fs
->trace
->metadata
->tc
->quirks
.barectf_event_before_packet
= true;
2000 if (is_tracer_affected_by_lttng_crash_quirk(
2001 ¤t_tracer_info
)) {
2002 ret
= fix_index_lttng_crash_quirk(ctf_fs
->trace
);
2004 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
2005 self_comp
, self_comp_class
,
2006 "Failed to fix lttng-crash timestamp quirks.");
2009 ctf_fs
->trace
->metadata
->tc
->quirks
.lttng_crash
= true;
2017 gint
compare_ds_file_groups_by_first_path(gconstpointer a
, gconstpointer b
)
2019 struct ctf_fs_ds_file_group
* const *ds_file_group_a
= a
;
2020 struct ctf_fs_ds_file_group
* const *ds_file_group_b
= b
;
2021 const struct ctf_fs_ds_file_info
*first_ds_file_info_a
;
2022 const struct ctf_fs_ds_file_info
*first_ds_file_info_b
;
2024 BT_ASSERT((*ds_file_group_a
)->ds_file_infos
->len
> 0);
2025 BT_ASSERT((*ds_file_group_b
)->ds_file_infos
->len
> 0);
2026 first_ds_file_info_a
= (*ds_file_group_a
)->ds_file_infos
->pdata
[0];
2027 first_ds_file_info_b
= (*ds_file_group_b
)->ds_file_infos
->pdata
[0];
2028 return strcmp(first_ds_file_info_a
->path
->str
,
2029 first_ds_file_info_b
->path
->str
);
2032 int ctf_fs_component_create_ctf_fs_trace(
2033 struct ctf_fs_component
*ctf_fs
,
2034 const bt_value
*paths_value
,
2035 const bt_value
*trace_name_value
,
2036 bt_self_component
*self_comp
,
2037 bt_self_component_class
*self_comp_class
)
2041 bt_logging_level log_level
= ctf_fs
->log_level
;
2043 const char *trace_name
;
2045 BT_ASSERT(bt_value_get_type(paths_value
) == BT_VALUE_TYPE_ARRAY
);
2046 BT_ASSERT(!bt_value_array_is_empty(paths_value
));
2048 traces
= g_ptr_array_new_with_free_func(ctf_fs_trace_destroy_notifier
);
2050 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2051 "Failed to allocate a GPtrArray.");
2055 trace_name
= trace_name_value
? bt_value_string_get(trace_name_value
) : NULL
;
2057 /* Start by creating a separate ctf_fs_trace object for each path. */
2058 for (i
= 0; i
< bt_value_array_get_length(paths_value
); i
++) {
2059 const bt_value
*path_value
= bt_value_array_borrow_element_by_index_const(paths_value
, i
);
2060 const char *input
= bt_value_string_get(path_value
);
2062 ret
= ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs
,
2063 input
, trace_name
, traces
, self_comp
, self_comp_class
);
2069 if (traces
->len
> 1) {
2070 struct ctf_fs_trace
*first_trace
= (struct ctf_fs_trace
*) traces
->pdata
[0];
2071 const uint8_t *first_trace_uuid
= first_trace
->metadata
->tc
->uuid
;
2072 struct ctf_fs_trace
*trace
;
2075 * We have more than one trace, they must all share the same
2076 * UUID, verify that.
2078 for (i
= 0; i
< traces
->len
; i
++) {
2079 struct ctf_fs_trace
*this_trace
=
2080 (struct ctf_fs_trace
*) traces
->pdata
[i
];
2081 const uint8_t *this_trace_uuid
= this_trace
->metadata
->tc
->uuid
;
2083 if (!this_trace
->metadata
->tc
->is_uuid_set
) {
2084 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2085 "Multiple traces given, but a trace does not have a UUID: path=%s",
2086 this_trace
->path
->str
);
2090 if (bt_uuid_compare(first_trace_uuid
, this_trace_uuid
) != 0) {
2091 char first_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
2092 char this_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
2094 bt_uuid_to_str(first_trace_uuid
, first_trace_uuid_str
);
2095 bt_uuid_to_str(this_trace_uuid
, this_trace_uuid_str
);
2097 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2098 "Multiple traces given, but UUIDs don't match: "
2099 "first-trace-uuid=%s, first-trace-path=%s, "
2100 "trace-uuid=%s, trace-path=%s",
2101 first_trace_uuid_str
, first_trace
->path
->str
,
2102 this_trace_uuid_str
, this_trace
->path
->str
);
2107 ret
= merge_ctf_fs_traces((struct ctf_fs_trace
**) traces
->pdata
,
2108 traces
->len
, &trace
);
2110 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2111 "Failed to merge traces with the same UUID.");
2115 ctf_fs
->trace
= trace
;
2117 /* Just one trace, it may or may not have a UUID, both are fine. */
2118 ctf_fs
->trace
= traces
->pdata
[0];
2119 traces
->pdata
[0] = NULL
;
2122 ret
= fix_packet_index_tracer_bugs(ctf_fs
, self_comp
, self_comp_class
);
2124 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2125 "Failed to fix packet index tracer bugs.");
2129 * Sort data stream file groups by first data stream file info
2130 * path to get a deterministic order. This order influences the
2131 * order of the output ports. It also influences the order of
2132 * the automatic stream IDs if the trace's packet headers do not
2133 * contain a `stream_instance_id` field, in which case the data
2134 * stream file to stream ID association is always the same,
2135 * whatever the build and the system.
2137 * Having a deterministic order here can help debugging and
2140 g_ptr_array_sort(ctf_fs
->trace
->ds_file_groups
,
2141 compare_ds_file_groups_by_first_path
);
2147 g_ptr_array_free(traces
, TRUE
);
2152 GString
*get_stream_instance_unique_name(
2153 struct ctf_fs_ds_file_group
*ds_file_group
)
2156 struct ctf_fs_ds_file_info
*ds_file_info
;
2158 name
= g_string_new(NULL
);
2164 * If there's more than one stream file in the stream file
2165 * group, the first (earliest) stream file's path is used as
2166 * the stream's unique name.
2168 BT_ASSERT(ds_file_group
->ds_file_infos
->len
> 0);
2169 ds_file_info
= g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
2170 g_string_assign(name
, ds_file_info
->path
->str
);
2176 /* Create the IR stream objects for ctf_fs_trace. */
2179 int create_streams_for_trace(struct ctf_fs_trace
*ctf_fs_trace
)
2182 GString
*name
= NULL
;
2184 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
2185 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
2187 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
2188 struct ctf_fs_ds_file_group
*ds_file_group
=
2189 g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
2190 name
= get_stream_instance_unique_name(ds_file_group
);
2196 if (ds_file_group
->sc
->ir_sc
) {
2197 BT_ASSERT(ctf_fs_trace
->trace
);
2199 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
2200 /* No stream ID: use 0 */
2201 ds_file_group
->stream
= bt_stream_create_with_id(
2202 ds_file_group
->sc
->ir_sc
,
2203 ctf_fs_trace
->trace
,
2204 ctf_fs_trace
->next_stream_id
);
2205 ctf_fs_trace
->next_stream_id
++;
2207 /* Specific stream ID */
2208 ds_file_group
->stream
= bt_stream_create_with_id(
2209 ds_file_group
->sc
->ir_sc
,
2210 ctf_fs_trace
->trace
,
2211 (uint64_t) ds_file_group
->stream_id
);
2214 ds_file_group
->stream
= NULL
;
2217 if (!ds_file_group
->stream
) {
2218 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2219 "Cannot create stream for DS file group: "
2220 "addr=%p, stream-name=\"%s\"",
2221 ds_file_group
, name
->str
);
2225 ret
= bt_stream_set_name(ds_file_group
->stream
,
2228 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Cannot set stream's name: "
2229 "addr=%p, stream-name=\"%s\"",
2230 ds_file_group
->stream
, name
->str
);
2234 g_string_free(name
, TRUE
);
2247 g_string_free(name
, TRUE
);
2252 static const struct bt_param_validation_value_descr inputs_elem_descr
= {
2253 .type
= BT_VALUE_TYPE_STRING
,
2256 static const struct bt_param_validation_map_value_entry_descr fs_params_entries_descr
[] = {
2257 { "inputs", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
, {
2258 BT_VALUE_TYPE_ARRAY
,
2261 .max_length
= BT_PARAM_VALIDATION_INFINITE
,
2262 .element_type
= &inputs_elem_descr
,
2265 { "trace-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_STRING
} },
2266 { "clock-class-offset-s", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_SIGNED_INTEGER
} },
2267 { "clock-class-offset-ns", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_SIGNED_INTEGER
} },
2268 { "force-clock-class-origin-unix-epoch", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_BOOL
} },
2269 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
2273 bool read_src_fs_parameters(const bt_value
*params
,
2274 const bt_value
**inputs
,
2275 const bt_value
**trace_name
,
2276 struct ctf_fs_component
*ctf_fs
,
2277 bt_self_component
*self_comp
,
2278 bt_self_component_class
*self_comp_class
) {
2280 const bt_value
*value
;
2281 bt_logging_level log_level
= ctf_fs
->log_level
;
2282 enum bt_param_validation_status validate_value_status
;
2283 gchar
*error
= NULL
;
2285 validate_value_status
= bt_param_validation_validate(params
,
2286 fs_params_entries_descr
, &error
);
2287 if (validate_value_status
!= BT_PARAM_VALIDATION_STATUS_OK
) {
2288 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2294 /* inputs parameter */
2295 *inputs
= bt_value_map_borrow_entry_value_const(params
, "inputs");
2297 /* clock-class-offset-s parameter */
2298 value
= bt_value_map_borrow_entry_value_const(params
,
2299 "clock-class-offset-s");
2301 ctf_fs
->metadata_config
.clock_class_offset_s
=
2302 bt_value_integer_signed_get(value
);
2305 /* clock-class-offset-ns parameter */
2306 value
= bt_value_map_borrow_entry_value_const(params
,
2307 "clock-class-offset-ns");
2309 ctf_fs
->metadata_config
.clock_class_offset_ns
=
2310 bt_value_integer_signed_get(value
);
2313 /* force-clock-class-origin-unix-epoch parameter */
2314 value
= bt_value_map_borrow_entry_value_const(params
,
2315 "force-clock-class-origin-unix-epoch");
2317 ctf_fs
->metadata_config
.force_clock_class_origin_unix_epoch
=
2318 bt_value_bool_get(value
);
2321 /* trace-name parameter */
2322 *trace_name
= bt_value_map_borrow_entry_value_const(params
, "trace-name");
2332 struct ctf_fs_component
*ctf_fs_create(
2333 const bt_value
*params
,
2334 bt_self_component_source
*self_comp_src
)
2336 struct ctf_fs_component
*ctf_fs
= NULL
;
2337 const bt_value
*inputs_value
;
2338 const bt_value
*trace_name_value
;
2339 bt_self_component
*self_comp
=
2340 bt_self_component_source_as_self_component(self_comp_src
);
2342 ctf_fs
= ctf_fs_component_create(bt_component_get_logging_level(
2343 bt_self_component_as_component(self_comp
)), self_comp
);
2348 if (!read_src_fs_parameters(params
, &inputs_value
, &trace_name_value
,
2349 ctf_fs
, self_comp
, NULL
)) {
2353 bt_self_component_set_data(self_comp
, ctf_fs
);
2355 if (ctf_fs_component_create_ctf_fs_trace(ctf_fs
, inputs_value
,
2356 trace_name_value
, self_comp
, NULL
)) {
2360 if (create_streams_for_trace(ctf_fs
->trace
)) {
2364 if (create_ports_for_trace(ctf_fs
, ctf_fs
->trace
, self_comp_src
)) {
2371 ctf_fs_destroy(ctf_fs
);
2373 bt_self_component_set_data(self_comp
, NULL
);
2380 bt_component_class_initialize_method_status
ctf_fs_init(
2381 bt_self_component_source
*self_comp_src
,
2382 bt_self_component_source_configuration
*config
,
2383 const bt_value
*params
, __attribute__((unused
)) void *init_method_data
)
2385 struct ctf_fs_component
*ctf_fs
;
2386 bt_component_class_initialize_method_status ret
=
2387 BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
2389 ctf_fs
= ctf_fs_create(params
, self_comp_src
);
2391 ret
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
2398 bt_component_class_query_method_status
ctf_fs_query(
2399 bt_self_component_class_source
*comp_class
,
2400 bt_private_query_executor
*priv_query_exec
,
2401 const char *object
, const bt_value
*params
,
2402 __attribute__((unused
)) void *method_data
,
2403 const bt_value
**result
)
2405 bt_component_class_query_method_status status
=
2406 BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
2407 bt_logging_level log_level
= bt_query_executor_get_logging_level(
2408 bt_private_query_executor_as_query_executor_const(
2411 if (strcmp(object
, "metadata-info") == 0) {
2412 status
= metadata_info_query(comp_class
, params
, log_level
,
2414 } else if (strcmp(object
, "babeltrace.trace-infos") == 0) {
2415 status
= trace_infos_query(comp_class
, params
, log_level
,
2417 } else if (!strcmp(object
, "babeltrace.support-info")) {
2418 status
= support_info_query(comp_class
, params
, log_level
, result
);
2420 BT_LOGE("Unknown query object `%s`", object
);
2421 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;