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
->pc_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 bt_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 bt_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 bt_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(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 bt_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 bt_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
->pc_msg_iter
= self_msg_iter
;
280 msg_iter_data
->msg_iter
= bt_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
,
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 bt_msg_iter
*msg_iter
= NULL
;
733 struct ctf_stream_class
*sc
= NULL
;
734 struct bt_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
= bt_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
);
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
= bt_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
, ds_file_info
);
827 BT_ASSERT(stream_instance_id
!= -1);
828 BT_ASSERT(begin_ns
!= -1);
830 /* Find an existing stream file group with this ID */
831 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
832 ds_file_group
= g_ptr_array_index(
833 ctf_fs_trace
->ds_file_groups
, i
);
835 if (ds_file_group
->sc
== sc
&&
836 ds_file_group
->stream_id
==
837 stream_instance_id
) {
841 ds_file_group
= NULL
;
844 if (!ds_file_group
) {
845 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
,
846 sc
, stream_instance_id
, index
);
847 /* Ownership of index is transferred. */
849 if (!ds_file_group
) {
855 merge_ctf_fs_ds_indexes(ds_file_group
->index
, index
);
858 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, ds_file_info
);
863 ctf_fs_ds_file_group_destroy(ds_file_group
);
864 ds_file_group
= NULL
;
868 if (add_group
&& ds_file_group
) {
869 g_ptr_array_add(ctf_fs_trace
->ds_file_groups
, ds_file_group
);
872 ctf_fs_ds_file_destroy(ds_file
);
875 bt_msg_iter_destroy(msg_iter
);
878 ctf_fs_ds_index_destroy(index
);
883 int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
886 const char *basename
;
887 GError
*error
= NULL
;
889 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
890 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
891 bt_self_component_class
*self_comp_class
= ctf_fs_trace
->self_comp_class
;
893 /* Check each file in the path directory, except specific ones */
894 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
896 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
897 "Cannot open directory `%s`: %s (code %d)",
898 ctf_fs_trace
->path
->str
, error
->message
,
903 while ((basename
= g_dir_read_name(dir
))) {
904 struct ctf_fs_file
*file
;
906 if (strcmp(basename
, CTF_FS_METADATA_FILENAME
) == 0) {
907 /* Ignore the metadata stream. */
908 BT_COMP_LOGI("Ignoring metadata file `%s" G_DIR_SEPARATOR_S
"%s`",
909 ctf_fs_trace
->path
->str
, basename
);
913 if (basename
[0] == '.') {
914 BT_COMP_LOGI("Ignoring hidden file `%s" G_DIR_SEPARATOR_S
"%s`",
915 ctf_fs_trace
->path
->str
, basename
);
919 /* Create the file. */
920 file
= ctf_fs_file_create(log_level
, self_comp
);
922 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
923 "Cannot create stream file object for file `%s" G_DIR_SEPARATOR_S
"%s`",
924 ctf_fs_trace
->path
->str
, basename
);
928 /* Create full path string. */
929 g_string_append_printf(file
->path
, "%s" G_DIR_SEPARATOR_S
"%s",
930 ctf_fs_trace
->path
->str
, basename
);
931 if (!g_file_test(file
->path
->str
, G_FILE_TEST_IS_REGULAR
)) {
932 BT_COMP_LOGI("Ignoring non-regular file `%s`",
934 ctf_fs_file_destroy(file
);
939 ret
= ctf_fs_file_open(file
, "rb");
941 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
942 "Cannot open stream file `%s`",
947 if (file
->size
== 0) {
948 /* Skip empty stream. */
949 BT_COMP_LOGI("Ignoring empty file `%s`", file
->path
->str
);
950 ctf_fs_file_destroy(file
);
954 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
,
957 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
958 "Cannot add stream file `%s` to stream file group",
960 ctf_fs_file_destroy(file
);
964 ctf_fs_file_destroy(file
);
986 int set_trace_name(bt_trace
*trace
, const char *name_suffix
,
987 bt_logging_level log_level
, bt_self_component
*self_comp
)
993 name
= g_string_new(NULL
);
995 BT_COMP_LOGE_STR("Failed to allocate a GString.");
1001 * Check if we have a trace environment string value named `hostname`.
1002 * If so, use it as the trace name's prefix.
1004 val
= bt_trace_borrow_environment_entry_value_by_name_const(
1006 if (val
&& bt_value_is_string(val
)) {
1007 g_string_append(name
, bt_value_string_get(val
));
1010 g_string_append_c(name
, G_DIR_SEPARATOR
);
1015 g_string_append(name
, name_suffix
);
1018 ret
= bt_trace_set_name(trace
, name
->str
);
1027 g_string_free(name
, TRUE
);
1034 struct ctf_fs_trace
*ctf_fs_trace_create(
1035 bt_self_component
*self_comp
,
1036 bt_self_component_class
*self_comp_class
,
1037 const char *path
, const char *name
,
1038 struct ctf_fs_metadata_config
*metadata_config
,
1039 bt_logging_level log_level
)
1041 struct ctf_fs_trace
*ctf_fs_trace
;
1044 /* Only one of them must be set. */
1045 BT_ASSERT(!self_comp
!= !self_comp_class
);
1047 ctf_fs_trace
= g_new0(struct ctf_fs_trace
, 1);
1048 if (!ctf_fs_trace
) {
1052 ctf_fs_trace
->log_level
= log_level
;
1053 ctf_fs_trace
->self_comp
= self_comp
;
1054 ctf_fs_trace
->self_comp_class
= self_comp_class
;
1055 ctf_fs_trace
->path
= g_string_new(path
);
1056 if (!ctf_fs_trace
->path
) {
1060 ctf_fs_trace
->metadata
= g_new0(struct ctf_fs_metadata
, 1);
1061 if (!ctf_fs_trace
->metadata
) {
1065 ctf_fs_metadata_init(ctf_fs_trace
->metadata
);
1066 ctf_fs_trace
->ds_file_groups
= g_ptr_array_new_with_free_func(
1067 (GDestroyNotify
) ctf_fs_ds_file_group_destroy
);
1068 if (!ctf_fs_trace
->ds_file_groups
) {
1072 ret
= ctf_fs_metadata_set_trace_class(self_comp
, ctf_fs_trace
,
1078 if (ctf_fs_trace
->metadata
->trace_class
) {
1079 ctf_fs_trace
->trace
=
1080 bt_trace_create(ctf_fs_trace
->metadata
->trace_class
);
1081 if (!ctf_fs_trace
->trace
) {
1086 if (ctf_fs_trace
->trace
) {
1087 ret
= ctf_trace_class_configure_ir_trace(
1088 ctf_fs_trace
->metadata
->tc
, ctf_fs_trace
->trace
);
1093 ret
= set_trace_name(ctf_fs_trace
->trace
, name
, log_level
,
1100 ret
= create_ds_file_groups(ctf_fs_trace
);
1108 ctf_fs_trace_destroy(ctf_fs_trace
);
1109 ctf_fs_trace
= NULL
;
1112 return ctf_fs_trace
;
1116 int path_is_ctf_trace(const char *path
)
1118 GString
*metadata_path
= g_string_new(NULL
);
1121 if (!metadata_path
) {
1126 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
1128 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
1134 g_string_free(metadata_path
, TRUE
);
1138 /* Helper for ctf_fs_component_create_ctf_fs_trace, to handle a single path. */
1141 int ctf_fs_component_create_ctf_fs_trace_one_path(
1142 struct ctf_fs_component
*ctf_fs
,
1143 const char *path_param
,
1144 const char *trace_name
,
1146 bt_self_component
*self_comp
,
1147 bt_self_component_class
*self_comp_class
)
1149 struct ctf_fs_trace
*ctf_fs_trace
;
1152 bt_logging_level log_level
= ctf_fs
->log_level
;
1154 norm_path
= bt_common_normalize_path(path_param
, NULL
);
1156 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1157 "Failed to normalize path: `%s`.",
1162 ret
= path_is_ctf_trace(norm_path
->str
);
1164 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1165 "Failed to check if path is a CTF trace: path=%s",
1168 } else if (ret
== 0) {
1169 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1170 "Path is not a CTF trace (does not contain a metadata file): `%s`.",
1175 // FIXME: Remove or ifdef for __MINGW32__
1176 if (strcmp(norm_path
->str
, "/") == 0) {
1177 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1178 "Opening a trace in `/` is not supported.");
1183 ctf_fs_trace
= ctf_fs_trace_create(self_comp
, self_comp_class
, norm_path
->str
,
1184 trace_name
, &ctf_fs
->metadata_config
, log_level
);
1185 if (!ctf_fs_trace
) {
1186 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1187 "Cannot create trace for `%s`.",
1192 g_ptr_array_add(traces
, ctf_fs_trace
);
1193 ctf_fs_trace
= NULL
;
1203 g_string_free(norm_path
, TRUE
);
1210 * Count the number of stream and event classes defined by this trace's metadata.
1212 * This is used to determine which metadata is the "latest", out of multiple
1213 * traces sharing the same UUID. It is assumed that amongst all these metadatas,
1214 * a bigger metadata is a superset of a smaller metadata. Therefore, it is
1215 * enough to just count the classes.
1219 unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace
*trace
)
1221 unsigned int num
= trace
->metadata
->tc
->stream_classes
->len
;
1224 for (i
= 0; i
< trace
->metadata
->tc
->stream_classes
->len
; i
++) {
1225 struct ctf_stream_class
*sc
= trace
->metadata
->tc
->stream_classes
->pdata
[i
];
1226 num
+= sc
->event_classes
->len
;
1233 * Merge the src ds_file_group into dest. This consists of merging their
1234 * ds_file_infos, making sure to keep the result sorted.
1238 void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group
*dest
, struct ctf_fs_ds_file_group
*src
)
1242 for (i
= 0; i
< src
->ds_file_infos
->len
; i
++) {
1243 struct ctf_fs_ds_file_info
*ds_file_info
=
1244 g_ptr_array_index(src
->ds_file_infos
, i
);
1246 /* Ownership of the ds_file_info is transferred to dest. */
1247 g_ptr_array_index(src
->ds_file_infos
, i
) = NULL
;
1249 ds_file_group_insert_ds_file_info_sorted(dest
, ds_file_info
);
1252 /* Merge both indexes. */
1253 merge_ctf_fs_ds_indexes(dest
->index
, src
->index
);
1255 /* Merge src_trace's data stream file groups into dest_trace's. */
1258 int merge_matching_ctf_fs_ds_file_groups(
1259 struct ctf_fs_trace
*dest_trace
,
1260 struct ctf_fs_trace
*src_trace
)
1263 GPtrArray
*dest
= dest_trace
->ds_file_groups
;
1264 GPtrArray
*src
= src_trace
->ds_file_groups
;
1269 * Save the initial length of dest: we only want to check against the
1270 * original elements in the inner loop.
1272 const guint dest_len
= dest
->len
;
1274 for (s_i
= 0; s_i
< src
->len
; s_i
++) {
1275 struct ctf_fs_ds_file_group
*src_group
= g_ptr_array_index(src
, s_i
);
1276 struct ctf_fs_ds_file_group
*dest_group
= NULL
;
1278 /* A stream instance without ID can't match a stream in the other trace. */
1279 if (src_group
->stream_id
!= -1) {
1282 /* Let's search for a matching ds_file_group in the destination. */
1283 for (d_i
= 0; d_i
< dest_len
; d_i
++) {
1284 struct ctf_fs_ds_file_group
*candidate_dest
= g_ptr_array_index(dest
, d_i
);
1286 /* Can't match a stream instance without ID. */
1287 if (candidate_dest
->stream_id
== -1) {
1292 * If the two groups have the same stream instance id
1293 * and belong to the same stream class (stream instance
1294 * ids are per-stream class), they represent the same
1297 if (candidate_dest
->stream_id
!= src_group
->stream_id
||
1298 candidate_dest
->sc
->id
!= src_group
->sc
->id
) {
1302 dest_group
= candidate_dest
;
1308 * Didn't find a friend in dest to merge our src_group into?
1309 * Create a new empty one. This can happen if a stream was
1310 * active in the source trace chunk but not in the destination
1314 struct ctf_stream_class
*sc
;
1315 struct ctf_fs_ds_index
*index
;
1317 sc
= ctf_trace_class_borrow_stream_class_by_id(
1318 dest_trace
->metadata
->tc
, src_group
->sc
->id
);
1321 index
= ctf_fs_ds_index_create(dest_trace
->log_level
,
1322 dest_trace
->self_comp
);
1328 dest_group
= ctf_fs_ds_file_group_create(dest_trace
, sc
,
1329 src_group
->stream_id
, index
);
1330 /* Ownership of index is transferred. */
1337 g_ptr_array_add(dest_trace
->ds_file_groups
, dest_group
);
1340 BT_ASSERT(dest_group
);
1341 merge_ctf_fs_ds_file_groups(dest_group
, src_group
);
1349 * Collapse the given traces, which must all share the same UUID, in a single
1352 * The trace with the most expansive metadata is chosen and all other traces
1353 * are merged into that one. The array slots of all the traces that get merged
1354 * in the chosen one are set to NULL, so only the slot of the chosen trace
1359 int merge_ctf_fs_traces(struct ctf_fs_trace
**traces
, unsigned int num_traces
,
1360 struct ctf_fs_trace
**out_trace
)
1362 unsigned int winner_count
;
1363 struct ctf_fs_trace
*winner
;
1367 BT_ASSERT(num_traces
>= 2);
1369 winner_count
= metadata_count_stream_and_event_classes(traces
[0]);
1373 /* Find the trace with the largest metadata. */
1374 for (i
= 1; i
< num_traces
; i
++) {
1375 struct ctf_fs_trace
*candidate
;
1376 unsigned int candidate_count
;
1378 candidate
= traces
[i
];
1380 /* A bit of sanity check. */
1381 BT_ASSERT(bt_uuid_compare(winner
->metadata
->tc
->uuid
, candidate
->metadata
->tc
->uuid
) == 0);
1383 candidate_count
= metadata_count_stream_and_event_classes(candidate
);
1385 if (candidate_count
> winner_count
) {
1386 winner_count
= candidate_count
;
1392 /* Merge all the other traces in the winning trace. */
1393 for (i
= 0; i
< num_traces
; i
++) {
1394 struct ctf_fs_trace
*trace
= traces
[i
];
1396 /* Don't merge the winner into itself. */
1397 if (trace
== winner
) {
1401 /* Merge trace's data stream file groups into winner's. */
1402 ret
= merge_matching_ctf_fs_ds_file_groups(winner
, trace
);
1409 * Move the winner out of the array, into `*out_trace`.
1411 *out_trace
= winner
;
1412 traces
[winner_i
] = NULL
;
1424 int decode_clock_snapshot_after_event(struct ctf_fs_trace
*ctf_fs_trace
,
1425 struct ctf_clock_class
*default_cc
,
1426 struct ctf_fs_ds_index_entry
*index_entry
,
1427 enum target_event target_event
, uint64_t *cs
, int64_t *ts_ns
)
1429 enum bt_msg_iter_status iter_status
= BT_MSG_ITER_STATUS_OK
;
1430 struct ctf_fs_ds_file
*ds_file
= NULL
;
1431 struct bt_msg_iter
*msg_iter
= NULL
;
1432 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
1433 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
1436 BT_ASSERT(ctf_fs_trace
);
1437 BT_ASSERT(ctf_fs_trace
->metadata
);
1438 BT_ASSERT(ctf_fs_trace
->metadata
->tc
);
1440 msg_iter
= bt_msg_iter_create(ctf_fs_trace
->metadata
->tc
,
1441 bt_common_get_page_size(log_level
) * 8, ctf_fs_ds_file_medops
,
1442 NULL
, log_level
, self_comp
);
1444 /* bt_msg_iter_create() logs errors. */
1449 BT_ASSERT(index_entry
);
1450 BT_ASSERT(index_entry
->path
);
1452 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, msg_iter
,
1453 NULL
, index_entry
->path
, log_level
);
1455 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Failed to create a ctf_fs_ds_file");
1461 * Turn on dry run mode to prevent the creation and usage of Babeltrace
1462 * library objects (bt_field, bt_message_*, etc.).
1464 bt_msg_iter_set_dry_run(msg_iter
, true);
1466 /* Seek to the beginning of the target packet. */
1467 iter_status
= bt_msg_iter_seek(ds_file
->msg_iter
, index_entry
->offset
);
1469 /* bt_msg_iter_seek() logs errors. */
1474 switch (target_event
) {
1477 * Start to decode the packet until we reach the end of
1478 * the first event. To extract the first event's clock
1481 iter_status
= bt_msg_iter_curr_packet_first_event_clock_snapshot(
1482 ds_file
->msg_iter
, cs
);
1485 /* Decode the packet to extract the last event's clock snapshot. */
1486 iter_status
= bt_msg_iter_curr_packet_last_event_clock_snapshot(
1487 ds_file
->msg_iter
, cs
);
1497 /* Convert clock snapshot to timestamp. */
1498 ret
= bt_util_clock_cycles_to_ns_from_origin(*cs
,
1499 default_cc
->frequency
, default_cc
->offset_seconds
,
1500 default_cc
->offset_cycles
, ts_ns
);
1502 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1503 "Failed to convert clock snapshot to timestamp");
1509 ctf_fs_ds_file_destroy(ds_file
);
1512 bt_msg_iter_destroy(msg_iter
);
1519 int decode_packet_first_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1520 struct ctf_clock_class
*default_cc
,
1521 struct ctf_fs_ds_index_entry
*index_entry
, uint64_t *cs
, int64_t *ts_ns
)
1523 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
,
1524 index_entry
, FIRST_EVENT
, cs
, ts_ns
);
1528 int decode_packet_last_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1529 struct ctf_clock_class
*default_cc
,
1530 struct ctf_fs_ds_index_entry
*index_entry
, uint64_t *cs
, int64_t *ts_ns
)
1532 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
,
1533 index_entry
, LAST_EVENT
, cs
, ts_ns
);
1537 * Fix up packet index entries for lttng's "event-after-packet" bug.
1538 * Some buggy lttng tracer versions may emit events with a timestamp that is
1539 * larger (after) than the timestamp_end of the their packets.
1541 * To fix up this erroneous data we do the following:
1542 * 1. If it's not the stream file's last packet: set the packet index entry's
1543 * end time to the next packet's beginning time.
1544 * 2. If it's the stream file's last packet, set the packet index entry's end
1545 * time to the packet's last event's time, if any, or to the packet's
1546 * beginning time otherwise.
1548 * Known buggy tracer versions:
1549 * - before lttng-ust 2.11.0
1550 * - before lttng-module 2.11.0
1551 * - before lttng-module 2.10.10
1552 * - before lttng-module 2.9.13
1555 int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace
*trace
)
1558 guint ds_file_group_i
;
1559 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1560 bt_logging_level log_level
= trace
->log_level
;
1562 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
;
1563 ds_file_group_i
++) {
1565 struct ctf_clock_class
*default_cc
;
1566 struct ctf_fs_ds_index_entry
*last_entry
;
1567 struct ctf_fs_ds_index
*index
;
1569 struct ctf_fs_ds_file_group
*ds_file_group
=
1570 g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1572 BT_ASSERT(ds_file_group
);
1573 index
= ds_file_group
->index
;
1576 BT_ASSERT(index
->entries
);
1577 BT_ASSERT(index
->entries
->len
> 0);
1580 * Iterate over all entries but the last one. The last one is
1581 * fixed differently after.
1583 for (entry_i
= 0; entry_i
< index
->entries
->len
- 1;
1585 struct ctf_fs_ds_index_entry
*curr_entry
, *next_entry
;
1587 curr_entry
= g_ptr_array_index(index
->entries
, entry_i
);
1588 next_entry
= g_ptr_array_index(index
->entries
, entry_i
+ 1);
1591 * 1. Set the current index entry `end` timestamp to
1592 * the next index entry `begin` timestamp.
1594 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1595 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1599 * 2. Fix the last entry by decoding the last event of the last
1602 last_entry
= g_ptr_array_index(index
->entries
,
1603 index
->entries
->len
- 1);
1604 BT_ASSERT(last_entry
);
1606 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1607 default_cc
= ds_file_group
->sc
->default_clock_class
;
1610 * Decode packet to read the timestamp of the last event of the
1613 ret
= decode_packet_last_event_timestamp(trace
, default_cc
,
1614 last_entry
, &last_entry
->timestamp_end
,
1615 &last_entry
->timestamp_end_ns
);
1617 BT_COMP_LOGE_APPEND_CAUSE(trace
->self_comp
,
1618 "Failed to decode stream's last packet to get its last event's clock snapshot.");
1628 * Fix up packet index entries for barectf's "event-before-packet" bug.
1629 * Some buggy barectf tracer versions may emit events with a timestamp that is
1630 * less than the timestamp_begin of the their packets.
1632 * To fix up this erroneous data we do the following:
1633 * 1. Starting at the second index entry, set the timestamp_begin of the
1634 * current entry to the timestamp of the first event of the packet.
1635 * 2. Set the previous entry's timestamp_end to the timestamp_begin of the
1638 * Known buggy tracer versions:
1639 * - before barectf 2.3.1
1642 int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace
*trace
)
1645 guint ds_file_group_i
;
1646 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1647 bt_logging_level log_level
= trace
->log_level
;
1649 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
;
1650 ds_file_group_i
++) {
1652 struct ctf_clock_class
*default_cc
;
1653 struct ctf_fs_ds_file_group
*ds_file_group
=
1654 g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1656 struct ctf_fs_ds_index
*index
= ds_file_group
->index
;
1659 BT_ASSERT(index
->entries
);
1660 BT_ASSERT(index
->entries
->len
> 0);
1662 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1663 default_cc
= ds_file_group
->sc
->default_clock_class
;
1666 * 1. Iterate over the index, starting from the second entry
1669 for (entry_i
= 1; entry_i
< index
->entries
->len
;
1671 struct ctf_fs_ds_index_entry
*curr_entry
, *prev_entry
;
1672 prev_entry
= g_ptr_array_index(index
->entries
, entry_i
- 1);
1673 curr_entry
= g_ptr_array_index(index
->entries
, entry_i
);
1675 * 2. Set the current entry `begin` timestamp to the
1676 * timestamp of the first event of the current packet.
1678 ret
= decode_packet_first_event_timestamp(trace
, default_cc
,
1679 curr_entry
, &curr_entry
->timestamp_begin
,
1680 &curr_entry
->timestamp_begin_ns
);
1682 BT_COMP_LOGE_APPEND_CAUSE(trace
->self_comp
,
1683 "Failed to decode first event's clock snapshot");
1688 * 3. Set the previous entry `end` timestamp to the
1689 * timestamp of the first event of the current packet.
1691 prev_entry
->timestamp_end
= curr_entry
->timestamp_begin
;
1692 prev_entry
->timestamp_end_ns
= curr_entry
->timestamp_begin_ns
;
1700 * When using the lttng-crash feature it's likely that the last packets of each
1701 * stream have their timestamp_end set to zero. This is caused by the fact that
1702 * the tracer crashed and was not able to properly close the packets.
1704 * To fix up this erroneous data we do the following:
1705 * For each index entry, if the entry's timestamp_end is 0 and the
1706 * timestamp_begin is not 0:
1707 * - If it's the stream file's last packet: set the packet index entry's end
1708 * time to the packet's last event's time, if any, or to the packet's
1709 * beginning time otherwise.
1710 * - If it's not the stream file's last packet: set the packet index
1711 * entry's end time to the next packet's beginning time.
1713 * Affected versions:
1714 * - All current and future lttng-ust and lttng-modules versions.
1717 int fix_index_lttng_crash_quirk(struct ctf_fs_trace
*trace
)
1720 guint ds_file_group_idx
;
1721 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1722 bt_logging_level log_level
= trace
->log_level
;
1724 for (ds_file_group_idx
= 0; ds_file_group_idx
< ds_file_groups
->len
;
1725 ds_file_group_idx
++) {
1727 struct ctf_clock_class
*default_cc
;
1728 struct ctf_fs_ds_index_entry
*last_entry
;
1729 struct ctf_fs_ds_index
*index
;
1731 struct ctf_fs_ds_file_group
*ds_file_group
=
1732 g_ptr_array_index(ds_file_groups
, ds_file_group_idx
);
1734 BT_ASSERT(ds_file_group
);
1735 index
= ds_file_group
->index
;
1737 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1738 default_cc
= ds_file_group
->sc
->default_clock_class
;
1741 BT_ASSERT(index
->entries
);
1742 BT_ASSERT(index
->entries
->len
> 0);
1744 last_entry
= g_ptr_array_index(index
->entries
,
1745 index
->entries
->len
- 1);
1746 BT_ASSERT(last_entry
);
1749 /* 1. Fix the last entry first. */
1750 if (last_entry
->timestamp_end
== 0 &&
1751 last_entry
->timestamp_begin
!= 0) {
1753 * Decode packet to read the timestamp of the
1754 * last event of the stream file.
1756 ret
= decode_packet_last_event_timestamp(trace
,
1757 default_cc
, last_entry
,
1758 &last_entry
->timestamp_end
,
1759 &last_entry
->timestamp_end_ns
);
1761 BT_COMP_LOGE_APPEND_CAUSE(trace
->self_comp
,
1762 "Failed to decode last event's clock snapshot");
1767 /* Iterate over all entries but the last one. */
1768 for (entry_idx
= 0; entry_idx
< index
->entries
->len
- 1;
1770 struct ctf_fs_ds_index_entry
*curr_entry
, *next_entry
;
1771 curr_entry
= g_ptr_array_index(index
->entries
, entry_idx
);
1772 next_entry
= g_ptr_array_index(index
->entries
, entry_idx
+ 1);
1774 if (curr_entry
->timestamp_end
== 0 &&
1775 curr_entry
->timestamp_begin
!= 0) {
1777 * 2. Set the current index entry `end` timestamp to
1778 * the next index entry `begin` timestamp.
1780 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1781 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1791 * Extract the tracer information necessary to compare versions.
1792 * Returns 0 on success, and -1 if the extraction is not successful because the
1793 * necessary fields are absents in the trace metadata.
1796 int extract_tracer_info(struct ctf_fs_trace
*trace
,
1797 struct tracer_info
*current_tracer_info
)
1800 struct ctf_trace_class_env_entry
*entry
;
1802 /* Clear the current_tracer_info struct */
1803 memset(current_tracer_info
, 0, sizeof(*current_tracer_info
));
1806 * To compare 2 tracer versions, at least the tracer name and it's
1807 * major version are needed. If one of these is missing, consider it an
1808 * extraction failure.
1810 entry
= ctf_trace_class_borrow_env_entry_by_name(
1811 trace
->metadata
->tc
, "tracer_name");
1812 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR
) {
1813 goto missing_bare_minimum
;
1816 /* Set tracer name. */
1817 current_tracer_info
->name
= entry
->value
.str
->str
;
1819 entry
= ctf_trace_class_borrow_env_entry_by_name(
1820 trace
->metadata
->tc
, "tracer_major");
1821 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1822 goto missing_bare_minimum
;
1825 /* Set major version number. */
1826 current_tracer_info
->major
= entry
->value
.i
;
1828 entry
= ctf_trace_class_borrow_env_entry_by_name(
1829 trace
->metadata
->tc
, "tracer_minor");
1830 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1834 /* Set minor version number. */
1835 current_tracer_info
->minor
= entry
->value
.i
;
1837 entry
= ctf_trace_class_borrow_env_entry_by_name(
1838 trace
->metadata
->tc
, "tracer_patch");
1841 * If `tracer_patch` doesn't exist `tracer_patchlevel` might.
1842 * For example, `lttng-modules` uses entry name
1843 * `tracer_patchlevel`.
1845 entry
= ctf_trace_class_borrow_env_entry_by_name(
1846 trace
->metadata
->tc
, "tracer_patchlevel");
1849 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1853 /* Set patch version number. */
1854 current_tracer_info
->patch
= entry
->value
.i
;
1858 missing_bare_minimum
:
1865 bool is_tracer_affected_by_lttng_event_after_packet_bug(
1866 struct tracer_info
*curr_tracer_info
)
1868 bool is_affected
= false;
1870 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1871 if (curr_tracer_info
->major
< 2) {
1873 } else if (curr_tracer_info
->major
== 2) {
1874 /* fixed in lttng-ust 2.11.0 */
1875 if (curr_tracer_info
->minor
< 11) {
1879 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1880 if (curr_tracer_info
->major
< 2) {
1882 } else if (curr_tracer_info
->major
== 2) {
1883 /* fixed in lttng-modules 2.11.0 */
1884 if (curr_tracer_info
->minor
== 10) {
1885 /* fixed in lttng-modules 2.10.10 */
1886 if (curr_tracer_info
->patch
< 10) {
1889 } else if (curr_tracer_info
->minor
== 9) {
1890 /* fixed in lttng-modules 2.9.13 */
1891 if (curr_tracer_info
->patch
< 13) {
1894 } else if (curr_tracer_info
->minor
< 9) {
1904 bool is_tracer_affected_by_barectf_event_before_packet_bug(
1905 struct tracer_info
*curr_tracer_info
)
1907 bool is_affected
= false;
1909 if (strcmp(curr_tracer_info
->name
, "barectf") == 0) {
1910 if (curr_tracer_info
->major
< 2) {
1912 } else if (curr_tracer_info
->major
== 2) {
1913 if (curr_tracer_info
->minor
< 3) {
1915 } else if (curr_tracer_info
->minor
== 3) {
1916 /* fixed in barectf 2.3.1 */
1917 if (curr_tracer_info
->patch
< 1) {
1928 bool is_tracer_affected_by_lttng_crash_quirk(
1929 struct tracer_info
*curr_tracer_info
)
1931 bool is_affected
= false;
1933 /* All LTTng tracer may be affected by this lttng crash quirk. */
1934 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1936 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1944 * Looks for trace produced by known buggy tracers and fix up the index
1948 int fix_packet_index_tracer_bugs(struct ctf_fs_component
*ctf_fs
,
1949 bt_self_component
*self_comp
,
1950 bt_self_component_class
*self_comp_class
)
1953 struct tracer_info current_tracer_info
;
1954 bt_logging_level log_level
= ctf_fs
->log_level
;
1956 ret
= extract_tracer_info(ctf_fs
->trace
, ¤t_tracer_info
);
1959 * A trace may not have all the necessary environment
1960 * entries to do the tracer version comparison.
1961 * At least, the tracer name and major version number
1962 * are needed. Failing to extract these entries is not
1966 BT_LOGI_STR("Cannot extract tracer information necessary to compare with buggy versions.");
1970 /* Check if the trace may be affected by old tracer bugs. */
1971 if (is_tracer_affected_by_lttng_event_after_packet_bug(
1972 ¤t_tracer_info
)) {
1973 BT_LOGI_STR("Trace may be affected by LTTng tracer packet timestamp bug. Fixing up.");
1974 ret
= fix_index_lttng_event_after_packet_bug(ctf_fs
->trace
);
1976 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
1977 self_comp
, self_comp_class
,
1978 "Failed to fix LTTng event-after-packet bug.");
1981 ctf_fs
->trace
->metadata
->tc
->quirks
.lttng_event_after_packet
= true;
1984 if (is_tracer_affected_by_barectf_event_before_packet_bug(
1985 ¤t_tracer_info
)) {
1986 BT_LOGI_STR("Trace may be affected by barectf tracer packet timestamp bug. Fixing up.");
1987 ret
= fix_index_barectf_event_before_packet_bug(ctf_fs
->trace
);
1989 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
1990 self_comp
, self_comp_class
,
1991 "Failed to fix barectf event-before-packet bug.");
1994 ctf_fs
->trace
->metadata
->tc
->quirks
.barectf_event_before_packet
= true;
1997 if (is_tracer_affected_by_lttng_crash_quirk(
1998 ¤t_tracer_info
)) {
1999 ret
= fix_index_lttng_crash_quirk(ctf_fs
->trace
);
2001 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
2002 self_comp
, self_comp_class
,
2003 "Failed to fix lttng-crash timestamp quirks.");
2006 ctf_fs
->trace
->metadata
->tc
->quirks
.lttng_crash
= true;
2014 gint
compare_ds_file_groups_by_first_path(gconstpointer a
, gconstpointer b
)
2016 struct ctf_fs_ds_file_group
* const *ds_file_group_a
= a
;
2017 struct ctf_fs_ds_file_group
* const *ds_file_group_b
= b
;
2018 const struct ctf_fs_ds_file_info
*first_ds_file_info_a
;
2019 const struct ctf_fs_ds_file_info
*first_ds_file_info_b
;
2021 BT_ASSERT((*ds_file_group_a
)->ds_file_infos
->len
> 0);
2022 BT_ASSERT((*ds_file_group_b
)->ds_file_infos
->len
> 0);
2023 first_ds_file_info_a
= (*ds_file_group_a
)->ds_file_infos
->pdata
[0];
2024 first_ds_file_info_b
= (*ds_file_group_b
)->ds_file_infos
->pdata
[0];
2025 return strcmp(first_ds_file_info_a
->path
->str
,
2026 first_ds_file_info_b
->path
->str
);
2029 int ctf_fs_component_create_ctf_fs_trace(
2030 struct ctf_fs_component
*ctf_fs
,
2031 const bt_value
*paths_value
,
2032 const bt_value
*trace_name_value
,
2033 bt_self_component
*self_comp
,
2034 bt_self_component_class
*self_comp_class
)
2038 bt_logging_level log_level
= ctf_fs
->log_level
;
2040 const char *trace_name
;
2042 BT_ASSERT(bt_value_get_type(paths_value
) == BT_VALUE_TYPE_ARRAY
);
2043 BT_ASSERT(!bt_value_array_is_empty(paths_value
));
2045 traces
= g_ptr_array_new_with_free_func(ctf_fs_trace_destroy_notifier
);
2047 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2048 "Failed to allocate a GPtrArray.");
2052 trace_name
= trace_name_value
? bt_value_string_get(trace_name_value
) : NULL
;
2054 /* Start by creating a separate ctf_fs_trace object for each path. */
2055 for (i
= 0; i
< bt_value_array_get_length(paths_value
); i
++) {
2056 const bt_value
*path_value
= bt_value_array_borrow_element_by_index_const(paths_value
, i
);
2057 const char *input
= bt_value_string_get(path_value
);
2059 ret
= ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs
,
2060 input
, trace_name
, traces
, self_comp
, self_comp_class
);
2066 if (traces
->len
> 1) {
2067 struct ctf_fs_trace
*first_trace
= (struct ctf_fs_trace
*) traces
->pdata
[0];
2068 const uint8_t *first_trace_uuid
= first_trace
->metadata
->tc
->uuid
;
2069 struct ctf_fs_trace
*trace
;
2072 * We have more than one trace, they must all share the same
2073 * UUID, verify that.
2075 for (i
= 0; i
< traces
->len
; i
++) {
2076 struct ctf_fs_trace
*this_trace
=
2077 (struct ctf_fs_trace
*) traces
->pdata
[i
];
2078 const uint8_t *this_trace_uuid
= this_trace
->metadata
->tc
->uuid
;
2080 if (!this_trace
->metadata
->tc
->is_uuid_set
) {
2081 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2082 "Multiple traces given, but a trace does not have a UUID: path=%s",
2083 this_trace
->path
->str
);
2087 if (bt_uuid_compare(first_trace_uuid
, this_trace_uuid
) != 0) {
2088 char first_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
2089 char this_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
2091 bt_uuid_to_str(first_trace_uuid
, first_trace_uuid_str
);
2092 bt_uuid_to_str(this_trace_uuid
, this_trace_uuid_str
);
2094 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2095 "Multiple traces given, but UUIDs don't match: "
2096 "first-trace-uuid=%s, first-trace-path=%s, "
2097 "trace-uuid=%s, trace-path=%s",
2098 first_trace_uuid_str
, first_trace
->path
->str
,
2099 this_trace_uuid_str
, this_trace
->path
->str
);
2104 ret
= merge_ctf_fs_traces((struct ctf_fs_trace
**) traces
->pdata
,
2105 traces
->len
, &trace
);
2107 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2108 "Failed to merge traces with the same UUID.");
2112 ctf_fs
->trace
= trace
;
2114 /* Just one trace, it may or may not have a UUID, both are fine. */
2115 ctf_fs
->trace
= traces
->pdata
[0];
2116 traces
->pdata
[0] = NULL
;
2119 ret
= fix_packet_index_tracer_bugs(ctf_fs
, self_comp
, self_comp_class
);
2121 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2122 "Failed to fix packet index tracer bugs.");
2126 * Sort data stream file groups by first data stream file info
2127 * path to get a deterministic order. This order influences the
2128 * order of the output ports. It also influences the order of
2129 * the automatic stream IDs if the trace's packet headers do not
2130 * contain a `stream_instance_id` field, in which case the data
2131 * stream file to stream ID association is always the same,
2132 * whatever the build and the system.
2134 * Having a deterministic order here can help debugging and
2137 g_ptr_array_sort(ctf_fs
->trace
->ds_file_groups
,
2138 compare_ds_file_groups_by_first_path
);
2144 g_ptr_array_free(traces
, TRUE
);
2149 GString
*get_stream_instance_unique_name(
2150 struct ctf_fs_ds_file_group
*ds_file_group
)
2153 struct ctf_fs_ds_file_info
*ds_file_info
;
2155 name
= g_string_new(NULL
);
2161 * If there's more than one stream file in the stream file
2162 * group, the first (earliest) stream file's path is used as
2163 * the stream's unique name.
2165 BT_ASSERT(ds_file_group
->ds_file_infos
->len
> 0);
2166 ds_file_info
= g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
2167 g_string_assign(name
, ds_file_info
->path
->str
);
2173 /* Create the IR stream objects for ctf_fs_trace. */
2176 int create_streams_for_trace(struct ctf_fs_trace
*ctf_fs_trace
)
2179 GString
*name
= NULL
;
2181 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
2182 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
2184 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
2185 struct ctf_fs_ds_file_group
*ds_file_group
=
2186 g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
2187 name
= get_stream_instance_unique_name(ds_file_group
);
2193 if (ds_file_group
->sc
->ir_sc
) {
2194 BT_ASSERT(ctf_fs_trace
->trace
);
2196 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
2197 /* No stream ID: use 0 */
2198 ds_file_group
->stream
= bt_stream_create_with_id(
2199 ds_file_group
->sc
->ir_sc
,
2200 ctf_fs_trace
->trace
,
2201 ctf_fs_trace
->next_stream_id
);
2202 ctf_fs_trace
->next_stream_id
++;
2204 /* Specific stream ID */
2205 ds_file_group
->stream
= bt_stream_create_with_id(
2206 ds_file_group
->sc
->ir_sc
,
2207 ctf_fs_trace
->trace
,
2208 (uint64_t) ds_file_group
->stream_id
);
2211 ds_file_group
->stream
= NULL
;
2214 if (!ds_file_group
->stream
) {
2215 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2216 "Cannot create stream for DS file group: "
2217 "addr=%p, stream-name=\"%s\"",
2218 ds_file_group
, name
->str
);
2222 ret
= bt_stream_set_name(ds_file_group
->stream
,
2225 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Cannot set stream's name: "
2226 "addr=%p, stream-name=\"%s\"",
2227 ds_file_group
->stream
, name
->str
);
2231 g_string_free(name
, TRUE
);
2244 g_string_free(name
, TRUE
);
2249 static const struct bt_param_validation_value_descr inputs_elem_descr
= {
2250 .type
= BT_VALUE_TYPE_STRING
,
2253 static const struct bt_param_validation_map_value_entry_descr fs_params_entries_descr
[] = {
2254 { "inputs", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
, {
2255 BT_VALUE_TYPE_ARRAY
,
2258 .max_length
= BT_PARAM_VALIDATION_INFINITE
,
2259 .element_type
= &inputs_elem_descr
,
2262 { "trace-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_STRING
} },
2263 { "clock-class-offset-s", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_SIGNED_INTEGER
} },
2264 { "clock-class-offset-ns", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_SIGNED_INTEGER
} },
2265 { "force-clock-class-origin-unix-epoch", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_BOOL
} },
2266 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
2270 bool read_src_fs_parameters(const bt_value
*params
,
2271 const bt_value
**inputs
,
2272 const bt_value
**trace_name
,
2273 struct ctf_fs_component
*ctf_fs
,
2274 bt_self_component
*self_comp
,
2275 bt_self_component_class
*self_comp_class
) {
2277 const bt_value
*value
;
2278 bt_logging_level log_level
= ctf_fs
->log_level
;
2279 enum bt_param_validation_status validate_value_status
;
2280 gchar
*error
= NULL
;
2282 validate_value_status
= bt_param_validation_validate(params
,
2283 fs_params_entries_descr
, &error
);
2284 if (validate_value_status
!= BT_PARAM_VALIDATION_STATUS_OK
) {
2285 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2291 /* inputs parameter */
2292 *inputs
= bt_value_map_borrow_entry_value_const(params
, "inputs");
2294 /* clock-class-offset-s parameter */
2295 value
= bt_value_map_borrow_entry_value_const(params
,
2296 "clock-class-offset-s");
2298 ctf_fs
->metadata_config
.clock_class_offset_s
=
2299 bt_value_integer_signed_get(value
);
2302 /* clock-class-offset-ns parameter */
2303 value
= bt_value_map_borrow_entry_value_const(params
,
2304 "clock-class-offset-ns");
2306 ctf_fs
->metadata_config
.clock_class_offset_ns
=
2307 bt_value_integer_signed_get(value
);
2310 /* force-clock-class-origin-unix-epoch parameter */
2311 value
= bt_value_map_borrow_entry_value_const(params
,
2312 "force-clock-class-origin-unix-epoch");
2314 ctf_fs
->metadata_config
.force_clock_class_origin_unix_epoch
=
2315 bt_value_bool_get(value
);
2318 /* trace-name parameter */
2319 *trace_name
= bt_value_map_borrow_entry_value_const(params
, "trace-name");
2329 struct ctf_fs_component
*ctf_fs_create(
2330 const bt_value
*params
,
2331 bt_self_component_source
*self_comp_src
)
2333 struct ctf_fs_component
*ctf_fs
= NULL
;
2334 const bt_value
*inputs_value
;
2335 const bt_value
*trace_name_value
;
2336 bt_self_component
*self_comp
=
2337 bt_self_component_source_as_self_component(self_comp_src
);
2339 ctf_fs
= ctf_fs_component_create(bt_component_get_logging_level(
2340 bt_self_component_as_component(self_comp
)), self_comp
);
2345 if (!read_src_fs_parameters(params
, &inputs_value
, &trace_name_value
,
2346 ctf_fs
, self_comp
, NULL
)) {
2350 bt_self_component_set_data(self_comp
, ctf_fs
);
2352 if (ctf_fs_component_create_ctf_fs_trace(ctf_fs
, inputs_value
,
2353 trace_name_value
, self_comp
, NULL
)) {
2357 if (create_streams_for_trace(ctf_fs
->trace
)) {
2361 if (create_ports_for_trace(ctf_fs
, ctf_fs
->trace
, self_comp_src
)) {
2368 ctf_fs_destroy(ctf_fs
);
2370 bt_self_component_set_data(self_comp
, NULL
);
2377 bt_component_class_initialize_method_status
ctf_fs_init(
2378 bt_self_component_source
*self_comp_src
,
2379 bt_self_component_source_configuration
*config
,
2380 const bt_value
*params
, __attribute__((unused
)) void *init_method_data
)
2382 struct ctf_fs_component
*ctf_fs
;
2383 bt_component_class_initialize_method_status ret
=
2384 BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
2386 ctf_fs
= ctf_fs_create(params
, self_comp_src
);
2388 ret
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
2395 bt_component_class_query_method_status
ctf_fs_query(
2396 bt_self_component_class_source
*comp_class
,
2397 bt_private_query_executor
*priv_query_exec
,
2398 const char *object
, const bt_value
*params
,
2399 __attribute__((unused
)) void *method_data
,
2400 const bt_value
**result
)
2402 bt_component_class_query_method_status status
=
2403 BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
2404 bt_logging_level log_level
= bt_query_executor_get_logging_level(
2405 bt_private_query_executor_as_query_executor_const(
2408 if (strcmp(object
, "metadata-info") == 0) {
2409 status
= metadata_info_query(comp_class
, params
, log_level
,
2411 } else if (strcmp(object
, "babeltrace.trace-infos") == 0) {
2412 status
= trace_infos_query(comp_class
, params
, log_level
,
2414 } else if (!strcmp(object
, "babeltrace.support-info")) {
2415 status
= support_info_query(comp_class
, params
, log_level
, result
);
2417 BT_LOGE("Unknown query object `%s`", object
);
2418 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;