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 /* Destroy the previous ds file. */
70 ctf_fs_ds_file_destroy(msg_iter_data
->ds_file
);
72 /* Create the new ds file. */
73 msg_iter_data
->ds_file
= ctf_fs_ds_file_create(
74 msg_iter_data
->ds_file_group
->ctf_fs_trace
,
75 msg_iter_data
->self_msg_iter
,
76 msg_iter_data
->ds_file_group
->stream
,
77 ds_file_info
->path
->str
,
78 msg_iter_data
->log_level
);
79 if (!msg_iter_data
->ds_file
) {
83 /* Tell the ctf message iterator to iterate on the new ds file. */
84 ctf_msg_iter_set_medops_data(msg_iter_data
->msg_iter
,
85 msg_iter_data
->ds_file
);
91 void ctf_fs_msg_iter_data_destroy(
92 struct ctf_fs_msg_iter_data
*msg_iter_data
)
98 ctf_fs_ds_file_destroy(msg_iter_data
->ds_file
);
100 if (msg_iter_data
->msg_iter
) {
101 ctf_msg_iter_destroy(msg_iter_data
->msg_iter
);
104 g_free(msg_iter_data
);
108 void set_msg_iter_emits_stream_beginning_end_messages(
109 struct ctf_fs_msg_iter_data
*msg_iter_data
)
111 ctf_msg_iter_set_emit_stream_beginning_message(
112 msg_iter_data
->msg_iter
,
113 msg_iter_data
->ds_file_info_index
== 0);
114 ctf_msg_iter_set_emit_stream_end_message(
115 msg_iter_data
->msg_iter
,
116 msg_iter_data
->ds_file_info_index
==
117 msg_iter_data
->ds_file_group
->ds_file_infos
->len
- 1);
121 bt_component_class_message_iterator_next_method_status
ctf_fs_iterator_next_one(
122 struct ctf_fs_msg_iter_data
*msg_iter_data
,
123 const bt_message
**out_msg
)
125 bt_component_class_message_iterator_next_method_status status
;
127 BT_ASSERT_DBG(msg_iter_data
->ds_file
);
130 status
= ctf_fs_ds_file_next(msg_iter_data
->msg_iter
, out_msg
);
132 case BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
:
134 case BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_END
:
138 if (msg_iter_data
->ds_file_info_index
==
139 msg_iter_data
->ds_file_group
->ds_file_infos
->len
- 1) {
140 /* End of all group's stream files */
144 msg_iter_data
->ds_file_info_index
++;
145 ctf_msg_iter_reset_for_next_stream_file(
146 msg_iter_data
->msg_iter
);
147 set_msg_iter_emits_stream_beginning_end_messages(
151 * Open and start reading the next stream file
152 * within our stream file group.
154 ret
= msg_iter_data_set_current_ds_file(msg_iter_data
);
156 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR
;
160 /* Continue the loop to get the next message */
173 bt_component_class_message_iterator_next_method_status
ctf_fs_iterator_next(
174 bt_self_message_iterator
*iterator
,
175 bt_message_array_const msgs
, uint64_t capacity
,
178 bt_component_class_message_iterator_next_method_status status
;
179 struct ctf_fs_msg_iter_data
*msg_iter_data
=
180 bt_self_message_iterator_get_data(iterator
);
183 if (G_UNLIKELY(msg_iter_data
->next_saved_error
)) {
185 * Last time we were called, we hit an error but had some
186 * messages to deliver, so we stashed the error here. Return
189 BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(msg_iter_data
->next_saved_error
);
190 status
= msg_iter_data
->next_saved_status
;
195 status
= ctf_fs_iterator_next_one(msg_iter_data
, &msgs
[i
]);
196 if (status
== BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
) {
199 } while (i
< capacity
&&
200 status
== BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
);
204 * Even if ctf_fs_iterator_next_one() returned something
205 * else than BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK, we
206 * accumulated message objects in the output
207 * message array, so we need to return
208 * BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK so that they are
209 * transfered to downstream. This other status occurs
210 * again the next time muxer_msg_iter_do_next() is
211 * called, possibly without any accumulated
212 * message, in which case we'll return it.
216 * Save this error for the next _next call. Assume that
217 * this component always appends error causes when
218 * returning an error status code, which will cause the
219 * current thread error to be non-NULL.
221 msg_iter_data
->next_saved_error
= bt_current_thread_take_error();
222 BT_ASSERT(msg_iter_data
->next_saved_error
);
223 msg_iter_data
->next_saved_status
= status
;
227 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
;
235 int ctf_fs_iterator_reset(struct ctf_fs_msg_iter_data
*msg_iter_data
)
239 msg_iter_data
->ds_file_info_index
= 0;
240 ret
= msg_iter_data_set_current_ds_file(msg_iter_data
);
245 ctf_msg_iter_reset(msg_iter_data
->msg_iter
);
246 set_msg_iter_emits_stream_beginning_end_messages(msg_iter_data
);
253 bt_component_class_message_iterator_seek_beginning_method_status
254 ctf_fs_iterator_seek_beginning(bt_self_message_iterator
*it
)
256 struct ctf_fs_msg_iter_data
*msg_iter_data
=
257 bt_self_message_iterator_get_data(it
);
258 bt_component_class_message_iterator_seek_beginning_method_status status
=
259 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_OK
;
261 BT_ASSERT(msg_iter_data
);
262 if (ctf_fs_iterator_reset(msg_iter_data
)) {
263 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_ERROR
;
270 void ctf_fs_iterator_finalize(bt_self_message_iterator
*it
)
272 ctf_fs_msg_iter_data_destroy(
273 bt_self_message_iterator_get_data(it
));
277 bt_component_class_message_iterator_initialize_method_status
ctf_fs_iterator_init(
278 bt_self_message_iterator
*self_msg_iter
,
279 bt_self_message_iterator_configuration
*config
,
280 bt_self_component_source
*self_comp_src
,
281 bt_self_component_port_output
*self_port
)
283 struct ctf_fs_port_data
*port_data
;
284 struct ctf_fs_msg_iter_data
*msg_iter_data
= NULL
;
285 bt_component_class_message_iterator_initialize_method_status ret
=
286 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_OK
;
287 bt_logging_level log_level
;
288 bt_self_component
*self_comp
=
289 bt_self_component_source_as_self_component(self_comp_src
);
291 port_data
= bt_self_component_port_get_data(
292 bt_self_component_port_output_as_self_component_port(
294 BT_ASSERT(port_data
);
295 log_level
= port_data
->ctf_fs
->log_level
;
296 msg_iter_data
= g_new0(struct ctf_fs_msg_iter_data
, 1);
297 if (!msg_iter_data
) {
298 ret
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
302 msg_iter_data
->log_level
= log_level
;
303 msg_iter_data
->self_comp
= self_comp
;
304 msg_iter_data
->self_msg_iter
= self_msg_iter
;
305 msg_iter_data
->msg_iter
= ctf_msg_iter_create(
306 port_data
->ds_file_group
->ctf_fs_trace
->metadata
->tc
,
307 bt_common_get_page_size(msg_iter_data
->log_level
) * 8,
308 ctf_fs_ds_file_medops
, NULL
, msg_iter_data
->log_level
,
309 self_comp
, self_msg_iter
);
310 if (!msg_iter_data
->msg_iter
) {
311 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Cannot create a CTF message iterator.");
312 ret
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
316 msg_iter_data
->ds_file_group
= port_data
->ds_file_group
;
317 if (ctf_fs_iterator_reset(msg_iter_data
)) {
318 ret
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_ERROR
;
323 * This iterator can seek forward if its stream class has a default
326 if (msg_iter_data
->ds_file_group
->sc
->default_clock_class
) {
327 bt_self_message_iterator_configuration_set_can_seek_forward(
331 bt_self_message_iterator_set_data(self_msg_iter
,
333 if (ret
!= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_OK
) {
336 msg_iter_data
= NULL
;
340 bt_self_message_iterator_set_data(self_msg_iter
, NULL
);
343 ctf_fs_msg_iter_data_destroy(msg_iter_data
);
348 void ctf_fs_trace_destroy(struct ctf_fs_trace
*ctf_fs_trace
)
354 if (ctf_fs_trace
->ds_file_groups
) {
355 g_ptr_array_free(ctf_fs_trace
->ds_file_groups
, TRUE
);
358 BT_TRACE_PUT_REF_AND_RESET(ctf_fs_trace
->trace
);
360 if (ctf_fs_trace
->path
) {
361 g_string_free(ctf_fs_trace
->path
, TRUE
);
364 if (ctf_fs_trace
->metadata
) {
365 ctf_fs_metadata_fini(ctf_fs_trace
->metadata
);
366 g_free(ctf_fs_trace
->metadata
);
369 g_free(ctf_fs_trace
);
373 void ctf_fs_destroy(struct ctf_fs_component
*ctf_fs
)
379 ctf_fs_trace_destroy(ctf_fs
->trace
);
381 if (ctf_fs
->port_data
) {
382 g_ptr_array_free(ctf_fs
->port_data
, TRUE
);
389 void port_data_destroy(struct ctf_fs_port_data
*port_data
)
399 void port_data_destroy_notifier(void *data
) {
400 port_data_destroy(data
);
404 void ctf_fs_trace_destroy_notifier(void *data
)
406 struct ctf_fs_trace
*trace
= data
;
407 ctf_fs_trace_destroy(trace
);
410 struct ctf_fs_component
*ctf_fs_component_create(bt_logging_level log_level
,
411 bt_self_component
*self_comp
)
413 struct ctf_fs_component
*ctf_fs
;
415 ctf_fs
= g_new0(struct ctf_fs_component
, 1);
420 ctf_fs
->log_level
= log_level
;
422 g_ptr_array_new_with_free_func(port_data_destroy_notifier
);
423 if (!ctf_fs
->port_data
) {
430 ctf_fs_destroy(ctf_fs
);
437 void ctf_fs_finalize(bt_self_component_source
*component
)
439 ctf_fs_destroy(bt_self_component_get_data(
440 bt_self_component_source_as_self_component(component
)));
443 gchar
*ctf_fs_make_port_name(struct ctf_fs_ds_file_group
*ds_file_group
)
445 GString
*name
= g_string_new(NULL
);
448 * The unique port name is generated by concatenating unique identifiers
456 /* For the trace, use the uuid if present, else the path. */
457 if (ds_file_group
->ctf_fs_trace
->metadata
->tc
->is_uuid_set
) {
458 char uuid_str
[BT_UUID_STR_LEN
+ 1];
460 bt_uuid_to_str(ds_file_group
->ctf_fs_trace
->metadata
->tc
->uuid
, uuid_str
);
461 g_string_assign(name
, uuid_str
);
463 g_string_assign(name
, ds_file_group
->ctf_fs_trace
->path
->str
);
467 * For the stream class, use the id if present. We can omit this field
468 * otherwise, as there will only be a single stream class.
470 if (ds_file_group
->sc
->id
!= UINT64_C(-1)) {
471 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->sc
->id
);
474 /* For the stream, use the id if present, else, use the path. */
475 if (ds_file_group
->stream_id
!= UINT64_C(-1)) {
476 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->stream_id
);
478 BT_ASSERT(ds_file_group
->ds_file_infos
->len
== 1);
479 struct ctf_fs_ds_file_info
*ds_file_info
=
480 g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
481 g_string_append_printf(name
, " | %s", ds_file_info
->path
->str
);
484 return g_string_free(name
, FALSE
);
488 int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
489 struct ctf_fs_trace
*ctf_fs_trace
,
490 struct ctf_fs_ds_file_group
*ds_file_group
,
491 bt_self_component_source
*self_comp_src
)
494 struct ctf_fs_port_data
*port_data
= NULL
;
496 bt_logging_level log_level
= ctf_fs
->log_level
;
497 bt_self_component
*self_comp
=
498 bt_self_component_source_as_self_component(self_comp_src
);
500 port_name
= ctf_fs_make_port_name(ds_file_group
);
505 BT_COMP_LOGI("Creating one port named `%s`", port_name
);
507 /* Create output port for this file */
508 port_data
= g_new0(struct ctf_fs_port_data
, 1);
513 port_data
->ctf_fs
= ctf_fs
;
514 port_data
->ds_file_group
= ds_file_group
;
515 ret
= bt_self_component_source_add_output_port(
516 self_comp_src
, port_name
, port_data
, NULL
);
521 g_ptr_array_add(ctf_fs
->port_data
, port_data
);
531 port_data_destroy(port_data
);
536 int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
537 struct ctf_fs_trace
*ctf_fs_trace
,
538 bt_self_component_source
*self_comp_src
)
542 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
543 bt_self_component
*self_comp
=
544 bt_self_component_source_as_self_component(self_comp_src
);
546 /* Create one output port for each stream file group */
547 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
548 struct ctf_fs_ds_file_group
*ds_file_group
=
549 g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
551 ret
= create_one_port_for_trace(ctf_fs
, ctf_fs_trace
,
552 ds_file_group
, self_comp_src
);
554 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Cannot create output port.");
564 void ctf_fs_ds_file_info_destroy(struct ctf_fs_ds_file_info
*ds_file_info
)
570 if (ds_file_info
->path
) {
571 g_string_free(ds_file_info
->path
, TRUE
);
574 g_free(ds_file_info
);
578 struct ctf_fs_ds_file_info
*ctf_fs_ds_file_info_create(const char *path
,
581 struct ctf_fs_ds_file_info
*ds_file_info
;
583 ds_file_info
= g_new0(struct ctf_fs_ds_file_info
, 1);
588 ds_file_info
->path
= g_string_new(path
);
589 if (!ds_file_info
->path
) {
590 ctf_fs_ds_file_info_destroy(ds_file_info
);
595 ds_file_info
->begin_ns
= begin_ns
;
602 void ctf_fs_ds_file_group_destroy(struct ctf_fs_ds_file_group
*ds_file_group
)
604 if (!ds_file_group
) {
608 if (ds_file_group
->ds_file_infos
) {
609 g_ptr_array_free(ds_file_group
->ds_file_infos
, TRUE
);
612 if (ds_file_group
->index
) {
613 if (ds_file_group
->index
->entries
) {
614 g_ptr_array_free(ds_file_group
->index
->entries
, TRUE
);
616 g_free(ds_file_group
->index
);
619 bt_stream_put_ref(ds_file_group
->stream
);
620 g_free(ds_file_group
);
624 struct ctf_fs_ds_file_group
*ctf_fs_ds_file_group_create(
625 struct ctf_fs_trace
*ctf_fs_trace
,
626 struct ctf_stream_class
*sc
,
627 uint64_t stream_instance_id
,
628 struct ctf_fs_ds_index
*index
)
630 struct ctf_fs_ds_file_group
*ds_file_group
;
632 ds_file_group
= g_new0(struct ctf_fs_ds_file_group
, 1);
633 if (!ds_file_group
) {
637 ds_file_group
->ds_file_infos
= g_ptr_array_new_with_free_func(
638 (GDestroyNotify
) ctf_fs_ds_file_info_destroy
);
639 if (!ds_file_group
->ds_file_infos
) {
643 ds_file_group
->index
= index
;
645 ds_file_group
->stream_id
= stream_instance_id
;
647 ds_file_group
->sc
= sc
;
648 ds_file_group
->ctf_fs_trace
= ctf_fs_trace
;
652 ctf_fs_ds_file_group_destroy(ds_file_group
);
653 ctf_fs_ds_index_destroy(index
);
654 ds_file_group
= NULL
;
657 return ds_file_group
;
660 /* Replace by g_ptr_array_insert when we depend on glib >= 2.40. */
662 void array_insert(GPtrArray
*array
, gpointer element
, size_t pos
)
664 size_t original_array_len
= array
->len
;
666 /* Allocate an unused element at the end of the array. */
667 g_ptr_array_add(array
, NULL
);
669 /* If we are not inserting at the end, move the elements by one. */
670 if (pos
< original_array_len
) {
671 memmove(&(array
->pdata
[pos
+ 1]),
672 &(array
->pdata
[pos
]),
673 (original_array_len
- pos
) * sizeof(gpointer
));
676 /* Insert the value. */
677 array
->pdata
[pos
] = element
;
681 * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right
682 * place to keep it sorted.
686 void ds_file_group_insert_ds_file_info_sorted(
687 struct ctf_fs_ds_file_group
*ds_file_group
,
688 struct ctf_fs_ds_file_info
*ds_file_info
)
692 /* Find the spot where to insert this ds_file_info. */
693 for (i
= 0; i
< ds_file_group
->ds_file_infos
->len
; i
++) {
694 struct ctf_fs_ds_file_info
*other_ds_file_info
=
695 g_ptr_array_index(ds_file_group
->ds_file_infos
, i
);
697 if (ds_file_info
->begin_ns
< other_ds_file_info
->begin_ns
) {
702 array_insert(ds_file_group
->ds_file_infos
, ds_file_info
, i
);
706 bool ds_index_entries_equal(
707 const struct ctf_fs_ds_index_entry
*left
,
708 const struct ctf_fs_ds_index_entry
*right
)
710 if (left
->packet_size
!= right
->packet_size
) {
714 if (left
->timestamp_begin
!= right
->timestamp_begin
) {
718 if (left
->timestamp_end
!= right
->timestamp_end
) {
722 if (left
->packet_seq_num
!= right
->packet_seq_num
) {
730 * Insert `entry` into `index`, without duplication.
732 * The entry is inserted only if there isn't an identical entry already.
734 * In any case, the ownership of `entry` is transferred to this function. So if
735 * the entry is not inserted, it is freed.
739 void ds_index_insert_ds_index_entry_sorted(
740 struct ctf_fs_ds_index
*index
,
741 struct ctf_fs_ds_index_entry
*entry
)
744 struct ctf_fs_ds_index_entry
*other_entry
;
746 /* Find the spot where to insert this index entry. */
747 for (i
= 0; i
< index
->entries
->len
; i
++) {
748 other_entry
= g_ptr_array_index(index
->entries
, i
);
750 if (entry
->timestamp_begin_ns
<= other_entry
->timestamp_begin_ns
) {
756 * Insert the entry only if a duplicate doesn't already exist.
758 * There can be duplicate packets if reading multiple overlapping
759 * snapshots of the same trace. We then want the index to contain
760 * a reference to only one copy of that packet.
762 if (i
== index
->entries
->len
||
763 !ds_index_entries_equal(entry
, other_entry
)) {
764 array_insert(index
->entries
, entry
, i
);
771 void merge_ctf_fs_ds_indexes(struct ctf_fs_ds_index
*dest
, struct ctf_fs_ds_index
*src
)
775 for (i
= 0; i
< src
->entries
->len
; i
++) {
776 struct ctf_fs_ds_index_entry
*entry
=
777 g_ptr_array_index(src
->entries
, i
);
780 * Ownership of the ctf_fs_ds_index_entry is transferred to
781 * ds_index_insert_ds_index_entry_sorted.
783 g_ptr_array_index(src
->entries
, i
) = NULL
;
784 ds_index_insert_ds_index_entry_sorted(dest
, entry
);
789 int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
,
792 int64_t stream_instance_id
= -1;
793 int64_t begin_ns
= -1;
794 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
795 bool add_group
= false;
798 struct ctf_fs_ds_file
*ds_file
= NULL
;
799 struct ctf_fs_ds_file_info
*ds_file_info
= NULL
;
800 struct ctf_fs_ds_index
*index
= NULL
;
801 struct ctf_msg_iter
*msg_iter
= NULL
;
802 struct ctf_stream_class
*sc
= NULL
;
803 struct ctf_msg_iter_packet_properties props
;
804 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
805 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
806 bt_self_component_class
*self_comp_class
= ctf_fs_trace
->self_comp_class
;
809 * Create a temporary ds_file to read some properties about the data
812 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, NULL
, path
,
818 /* Create a temporary iterator to read the ds_file. */
819 msg_iter
= ctf_msg_iter_create(ctf_fs_trace
->metadata
->tc
,
820 bt_common_get_page_size(log_level
) * 8,
821 ctf_fs_ds_file_medops
, ds_file
, log_level
, self_comp
, NULL
);
823 BT_COMP_LOGE_STR("Cannot create a CTF message iterator.");
827 ret
= ctf_msg_iter_get_packet_properties(msg_iter
, &props
);
829 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
830 "Cannot get stream file's first packet's header and context fields (`%s`).",
835 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
,
836 props
.stream_class_id
);
838 stream_instance_id
= props
.data_stream_id
;
840 if (props
.snapshots
.beginning_clock
!= UINT64_C(-1)) {
841 BT_ASSERT(sc
->default_clock_class
);
842 ret
= bt_util_clock_cycles_to_ns_from_origin(
843 props
.snapshots
.beginning_clock
,
844 sc
->default_clock_class
->frequency
,
845 sc
->default_clock_class
->offset_seconds
,
846 sc
->default_clock_class
->offset_cycles
, &begin_ns
);
848 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
849 "Cannot convert clock cycles to nanoseconds from origin (`%s`).",
855 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
);
860 index
= ctf_fs_ds_file_build_index(ds_file
, ds_file_info
, msg_iter
);
862 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
863 self_comp
, self_comp_class
,
864 "Failed to index CTF stream file \'%s\'",
865 ds_file
->file
->path
->str
);
869 if (begin_ns
== -1) {
871 * No beggining timestamp to sort the stream files
872 * within a stream file group, so consider that this
873 * file must be the only one within its group.
875 stream_instance_id
= -1;
878 if (stream_instance_id
== -1) {
880 * No stream instance ID or no beginning timestamp:
881 * create a unique stream file group for this stream
882 * file because, even if there's a stream instance ID,
883 * there's no timestamp to order the file within its
886 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
,
887 sc
, UINT64_C(-1), index
);
888 /* Ownership of index is transferred. */
891 if (!ds_file_group
) {
895 ds_file_group_insert_ds_file_info_sorted(ds_file_group
,
896 BT_MOVE_REF(ds_file_info
));
902 BT_ASSERT(stream_instance_id
!= -1);
903 BT_ASSERT(begin_ns
!= -1);
905 /* Find an existing stream file group with this ID */
906 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
907 ds_file_group
= g_ptr_array_index(
908 ctf_fs_trace
->ds_file_groups
, i
);
910 if (ds_file_group
->sc
== sc
&&
911 ds_file_group
->stream_id
==
912 stream_instance_id
) {
916 ds_file_group
= NULL
;
919 if (!ds_file_group
) {
920 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
,
921 sc
, stream_instance_id
, index
);
922 /* Ownership of index is transferred. */
924 if (!ds_file_group
) {
930 merge_ctf_fs_ds_indexes(ds_file_group
->index
, index
);
933 ds_file_group_insert_ds_file_info_sorted(ds_file_group
,
934 BT_MOVE_REF(ds_file_info
));
939 ctf_fs_ds_file_group_destroy(ds_file_group
);
940 ds_file_group
= NULL
;
944 if (add_group
&& ds_file_group
) {
945 g_ptr_array_add(ctf_fs_trace
->ds_file_groups
, ds_file_group
);
948 ctf_fs_ds_file_destroy(ds_file
);
949 ctf_fs_ds_file_info_destroy(ds_file_info
);
952 ctf_msg_iter_destroy(msg_iter
);
955 ctf_fs_ds_index_destroy(index
);
960 int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
963 const char *basename
;
964 GError
*error
= NULL
;
966 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
967 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
968 bt_self_component_class
*self_comp_class
= ctf_fs_trace
->self_comp_class
;
970 /* Check each file in the path directory, except specific ones */
971 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
973 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
974 "Cannot open directory `%s`: %s (code %d)",
975 ctf_fs_trace
->path
->str
, error
->message
,
980 while ((basename
= g_dir_read_name(dir
))) {
981 struct ctf_fs_file
*file
;
983 if (strcmp(basename
, CTF_FS_METADATA_FILENAME
) == 0) {
984 /* Ignore the metadata stream. */
985 BT_COMP_LOGI("Ignoring metadata file `%s" G_DIR_SEPARATOR_S
"%s`",
986 ctf_fs_trace
->path
->str
, basename
);
990 if (basename
[0] == '.') {
991 BT_COMP_LOGI("Ignoring hidden file `%s" G_DIR_SEPARATOR_S
"%s`",
992 ctf_fs_trace
->path
->str
, basename
);
996 /* Create the file. */
997 file
= ctf_fs_file_create(log_level
, self_comp
);
999 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1000 "Cannot create stream file object for file `%s" G_DIR_SEPARATOR_S
"%s`",
1001 ctf_fs_trace
->path
->str
, basename
);
1005 /* Create full path string. */
1006 g_string_append_printf(file
->path
, "%s" G_DIR_SEPARATOR_S
"%s",
1007 ctf_fs_trace
->path
->str
, basename
);
1008 if (!g_file_test(file
->path
->str
, G_FILE_TEST_IS_REGULAR
)) {
1009 BT_COMP_LOGI("Ignoring non-regular file `%s`",
1011 ctf_fs_file_destroy(file
);
1016 ret
= ctf_fs_file_open(file
, "rb");
1018 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1019 "Cannot open stream file `%s`",
1024 if (file
->size
== 0) {
1025 /* Skip empty stream. */
1026 BT_COMP_LOGI("Ignoring empty file `%s`", file
->path
->str
);
1027 ctf_fs_file_destroy(file
);
1031 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
,
1034 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1035 "Cannot add stream file `%s` to stream file group",
1037 ctf_fs_file_destroy(file
);
1041 ctf_fs_file_destroy(file
);
1056 g_error_free(error
);
1063 int set_trace_name(bt_trace
*trace
, const char *name_suffix
,
1064 bt_logging_level log_level
, bt_self_component
*self_comp
)
1067 const bt_value
*val
;
1070 name
= g_string_new(NULL
);
1072 BT_COMP_LOGE_STR("Failed to allocate a GString.");
1078 * Check if we have a trace environment string value named `hostname`.
1079 * If so, use it as the trace name's prefix.
1081 val
= bt_trace_borrow_environment_entry_value_by_name_const(
1083 if (val
&& bt_value_is_string(val
)) {
1084 g_string_append(name
, bt_value_string_get(val
));
1087 g_string_append_c(name
, G_DIR_SEPARATOR
);
1092 g_string_append(name
, name_suffix
);
1095 ret
= bt_trace_set_name(trace
, name
->str
);
1104 g_string_free(name
, TRUE
);
1111 struct ctf_fs_trace
*ctf_fs_trace_create(
1112 bt_self_component
*self_comp
,
1113 bt_self_component_class
*self_comp_class
,
1114 const char *path
, const char *name
,
1115 struct ctf_fs_metadata_config
*metadata_config
,
1116 bt_logging_level log_level
)
1118 struct ctf_fs_trace
*ctf_fs_trace
;
1121 /* Only one of them must be set. */
1122 BT_ASSERT(!self_comp
!= !self_comp_class
);
1124 ctf_fs_trace
= g_new0(struct ctf_fs_trace
, 1);
1125 if (!ctf_fs_trace
) {
1129 ctf_fs_trace
->log_level
= log_level
;
1130 ctf_fs_trace
->self_comp
= self_comp
;
1131 ctf_fs_trace
->self_comp_class
= self_comp_class
;
1132 ctf_fs_trace
->path
= g_string_new(path
);
1133 if (!ctf_fs_trace
->path
) {
1137 ctf_fs_trace
->metadata
= g_new0(struct ctf_fs_metadata
, 1);
1138 if (!ctf_fs_trace
->metadata
) {
1142 ctf_fs_metadata_init(ctf_fs_trace
->metadata
);
1143 ctf_fs_trace
->ds_file_groups
= g_ptr_array_new_with_free_func(
1144 (GDestroyNotify
) ctf_fs_ds_file_group_destroy
);
1145 if (!ctf_fs_trace
->ds_file_groups
) {
1149 ret
= ctf_fs_metadata_set_trace_class(self_comp
, ctf_fs_trace
,
1155 if (ctf_fs_trace
->metadata
->trace_class
) {
1156 ctf_fs_trace
->trace
=
1157 bt_trace_create(ctf_fs_trace
->metadata
->trace_class
);
1158 if (!ctf_fs_trace
->trace
) {
1163 if (ctf_fs_trace
->trace
) {
1164 ret
= ctf_trace_class_configure_ir_trace(
1165 ctf_fs_trace
->metadata
->tc
, ctf_fs_trace
->trace
);
1170 ret
= set_trace_name(ctf_fs_trace
->trace
, name
, log_level
,
1177 ret
= create_ds_file_groups(ctf_fs_trace
);
1185 ctf_fs_trace_destroy(ctf_fs_trace
);
1186 ctf_fs_trace
= NULL
;
1189 return ctf_fs_trace
;
1193 int path_is_ctf_trace(const char *path
)
1195 GString
*metadata_path
= g_string_new(NULL
);
1198 if (!metadata_path
) {
1203 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
1205 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
1211 g_string_free(metadata_path
, TRUE
);
1215 /* Helper for ctf_fs_component_create_ctf_fs_trace, to handle a single path. */
1218 int ctf_fs_component_create_ctf_fs_trace_one_path(
1219 struct ctf_fs_component
*ctf_fs
,
1220 const char *path_param
,
1221 const char *trace_name
,
1223 bt_self_component
*self_comp
,
1224 bt_self_component_class
*self_comp_class
)
1226 struct ctf_fs_trace
*ctf_fs_trace
;
1229 bt_logging_level log_level
= ctf_fs
->log_level
;
1231 norm_path
= bt_common_normalize_path(path_param
, NULL
);
1233 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1234 "Failed to normalize path: `%s`.",
1239 ret
= path_is_ctf_trace(norm_path
->str
);
1241 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1242 "Failed to check if path is a CTF trace: path=%s",
1245 } else if (ret
== 0) {
1246 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1247 "Path is not a CTF trace (does not contain a metadata file): `%s`.",
1252 // FIXME: Remove or ifdef for __MINGW32__
1253 if (strcmp(norm_path
->str
, "/") == 0) {
1254 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1255 "Opening a trace in `/` is not supported.");
1260 ctf_fs_trace
= ctf_fs_trace_create(self_comp
, self_comp_class
, norm_path
->str
,
1261 trace_name
, &ctf_fs
->metadata_config
, log_level
);
1262 if (!ctf_fs_trace
) {
1263 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1264 "Cannot create trace for `%s`.",
1269 g_ptr_array_add(traces
, ctf_fs_trace
);
1270 ctf_fs_trace
= NULL
;
1280 g_string_free(norm_path
, TRUE
);
1287 * Count the number of stream and event classes defined by this trace's metadata.
1289 * This is used to determine which metadata is the "latest", out of multiple
1290 * traces sharing the same UUID. It is assumed that amongst all these metadatas,
1291 * a bigger metadata is a superset of a smaller metadata. Therefore, it is
1292 * enough to just count the classes.
1296 unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace
*trace
)
1298 unsigned int num
= trace
->metadata
->tc
->stream_classes
->len
;
1301 for (i
= 0; i
< trace
->metadata
->tc
->stream_classes
->len
; i
++) {
1302 struct ctf_stream_class
*sc
= trace
->metadata
->tc
->stream_classes
->pdata
[i
];
1303 num
+= sc
->event_classes
->len
;
1310 * Merge the src ds_file_group into dest. This consists of merging their
1311 * ds_file_infos, making sure to keep the result sorted.
1315 void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group
*dest
, struct ctf_fs_ds_file_group
*src
)
1319 for (i
= 0; i
< src
->ds_file_infos
->len
; i
++) {
1320 struct ctf_fs_ds_file_info
*ds_file_info
=
1321 g_ptr_array_index(src
->ds_file_infos
, i
);
1323 /* Ownership of the ds_file_info is transferred to dest. */
1324 g_ptr_array_index(src
->ds_file_infos
, i
) = NULL
;
1326 ds_file_group_insert_ds_file_info_sorted(dest
, ds_file_info
);
1329 /* Merge both indexes. */
1330 merge_ctf_fs_ds_indexes(dest
->index
, src
->index
);
1332 /* Merge src_trace's data stream file groups into dest_trace's. */
1335 int merge_matching_ctf_fs_ds_file_groups(
1336 struct ctf_fs_trace
*dest_trace
,
1337 struct ctf_fs_trace
*src_trace
)
1340 GPtrArray
*dest
= dest_trace
->ds_file_groups
;
1341 GPtrArray
*src
= src_trace
->ds_file_groups
;
1346 * Save the initial length of dest: we only want to check against the
1347 * original elements in the inner loop.
1349 const guint dest_len
= dest
->len
;
1351 for (s_i
= 0; s_i
< src
->len
; s_i
++) {
1352 struct ctf_fs_ds_file_group
*src_group
= g_ptr_array_index(src
, s_i
);
1353 struct ctf_fs_ds_file_group
*dest_group
= NULL
;
1355 /* A stream instance without ID can't match a stream in the other trace. */
1356 if (src_group
->stream_id
!= -1) {
1359 /* Let's search for a matching ds_file_group in the destination. */
1360 for (d_i
= 0; d_i
< dest_len
; d_i
++) {
1361 struct ctf_fs_ds_file_group
*candidate_dest
= g_ptr_array_index(dest
, d_i
);
1363 /* Can't match a stream instance without ID. */
1364 if (candidate_dest
->stream_id
== -1) {
1369 * If the two groups have the same stream instance id
1370 * and belong to the same stream class (stream instance
1371 * ids are per-stream class), they represent the same
1374 if (candidate_dest
->stream_id
!= src_group
->stream_id
||
1375 candidate_dest
->sc
->id
!= src_group
->sc
->id
) {
1379 dest_group
= candidate_dest
;
1385 * Didn't find a friend in dest to merge our src_group into?
1386 * Create a new empty one. This can happen if a stream was
1387 * active in the source trace chunk but not in the destination
1391 struct ctf_stream_class
*sc
;
1392 struct ctf_fs_ds_index
*index
;
1394 sc
= ctf_trace_class_borrow_stream_class_by_id(
1395 dest_trace
->metadata
->tc
, src_group
->sc
->id
);
1398 index
= ctf_fs_ds_index_create(dest_trace
->log_level
,
1399 dest_trace
->self_comp
);
1405 dest_group
= ctf_fs_ds_file_group_create(dest_trace
, sc
,
1406 src_group
->stream_id
, index
);
1407 /* Ownership of index is transferred. */
1414 g_ptr_array_add(dest_trace
->ds_file_groups
, dest_group
);
1417 BT_ASSERT(dest_group
);
1418 merge_ctf_fs_ds_file_groups(dest_group
, src_group
);
1426 * Collapse the given traces, which must all share the same UUID, in a single
1429 * The trace with the most expansive metadata is chosen and all other traces
1430 * are merged into that one. The array slots of all the traces that get merged
1431 * in the chosen one are set to NULL, so only the slot of the chosen trace
1436 int merge_ctf_fs_traces(struct ctf_fs_trace
**traces
, unsigned int num_traces
,
1437 struct ctf_fs_trace
**out_trace
)
1439 unsigned int winner_count
;
1440 struct ctf_fs_trace
*winner
;
1444 BT_ASSERT(num_traces
>= 2);
1446 winner_count
= metadata_count_stream_and_event_classes(traces
[0]);
1450 /* Find the trace with the largest metadata. */
1451 for (i
= 1; i
< num_traces
; i
++) {
1452 struct ctf_fs_trace
*candidate
;
1453 unsigned int candidate_count
;
1455 candidate
= traces
[i
];
1457 /* A bit of sanity check. */
1458 BT_ASSERT(bt_uuid_compare(winner
->metadata
->tc
->uuid
, candidate
->metadata
->tc
->uuid
) == 0);
1460 candidate_count
= metadata_count_stream_and_event_classes(candidate
);
1462 if (candidate_count
> winner_count
) {
1463 winner_count
= candidate_count
;
1469 /* Merge all the other traces in the winning trace. */
1470 for (i
= 0; i
< num_traces
; i
++) {
1471 struct ctf_fs_trace
*trace
= traces
[i
];
1473 /* Don't merge the winner into itself. */
1474 if (trace
== winner
) {
1478 /* Merge trace's data stream file groups into winner's. */
1479 ret
= merge_matching_ctf_fs_ds_file_groups(winner
, trace
);
1486 * Move the winner out of the array, into `*out_trace`.
1488 *out_trace
= winner
;
1489 traces
[winner_i
] = NULL
;
1501 int decode_clock_snapshot_after_event(struct ctf_fs_trace
*ctf_fs_trace
,
1502 struct ctf_clock_class
*default_cc
,
1503 struct ctf_fs_ds_index_entry
*index_entry
,
1504 enum target_event target_event
, uint64_t *cs
, int64_t *ts_ns
)
1506 enum ctf_msg_iter_status iter_status
= CTF_MSG_ITER_STATUS_OK
;
1507 struct ctf_fs_ds_file
*ds_file
= NULL
;
1508 struct ctf_msg_iter
*msg_iter
= NULL
;
1509 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
1510 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
1513 BT_ASSERT(ctf_fs_trace
);
1514 BT_ASSERT(index_entry
);
1515 BT_ASSERT(index_entry
->path
);
1517 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
,
1518 NULL
, index_entry
->path
, log_level
);
1520 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Failed to create a ctf_fs_ds_file");
1525 BT_ASSERT(ctf_fs_trace
->metadata
);
1526 BT_ASSERT(ctf_fs_trace
->metadata
->tc
);
1528 msg_iter
= ctf_msg_iter_create(ctf_fs_trace
->metadata
->tc
,
1529 bt_common_get_page_size(log_level
) * 8, ctf_fs_ds_file_medops
,
1530 ds_file
, log_level
, self_comp
, NULL
);
1532 /* ctf_msg_iter_create() logs errors. */
1538 * Turn on dry run mode to prevent the creation and usage of Babeltrace
1539 * library objects (bt_field, bt_message_*, etc.).
1541 ctf_msg_iter_set_dry_run(msg_iter
, true);
1543 /* Seek to the beginning of the target packet. */
1544 iter_status
= ctf_msg_iter_seek(msg_iter
, index_entry
->offset
);
1546 /* ctf_msg_iter_seek() logs errors. */
1551 switch (target_event
) {
1554 * Start to decode the packet until we reach the end of
1555 * the first event. To extract the first event's clock
1558 iter_status
= ctf_msg_iter_curr_packet_first_event_clock_snapshot(
1562 /* Decode the packet to extract the last event's clock snapshot. */
1563 iter_status
= ctf_msg_iter_curr_packet_last_event_clock_snapshot(
1574 /* Convert clock snapshot to timestamp. */
1575 ret
= bt_util_clock_cycles_to_ns_from_origin(*cs
,
1576 default_cc
->frequency
, default_cc
->offset_seconds
,
1577 default_cc
->offset_cycles
, ts_ns
);
1579 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1580 "Failed to convert clock snapshot to timestamp");
1586 ctf_fs_ds_file_destroy(ds_file
);
1589 ctf_msg_iter_destroy(msg_iter
);
1596 int decode_packet_first_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1597 struct ctf_clock_class
*default_cc
,
1598 struct ctf_fs_ds_index_entry
*index_entry
, uint64_t *cs
, int64_t *ts_ns
)
1600 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
,
1601 index_entry
, FIRST_EVENT
, cs
, ts_ns
);
1605 int decode_packet_last_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1606 struct ctf_clock_class
*default_cc
,
1607 struct ctf_fs_ds_index_entry
*index_entry
, uint64_t *cs
, int64_t *ts_ns
)
1609 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
,
1610 index_entry
, LAST_EVENT
, cs
, ts_ns
);
1614 * Fix up packet index entries for lttng's "event-after-packet" bug.
1615 * Some buggy lttng tracer versions may emit events with a timestamp that is
1616 * larger (after) than the timestamp_end of the their packets.
1618 * To fix up this erroneous data we do the following:
1619 * 1. If it's not the stream file's last packet: set the packet index entry's
1620 * end time to the next packet's beginning time.
1621 * 2. If it's the stream file's last packet, set the packet index entry's end
1622 * time to the packet's last event's time, if any, or to the packet's
1623 * beginning time otherwise.
1625 * Known buggy tracer versions:
1626 * - before lttng-ust 2.11.0
1627 * - before lttng-module 2.11.0
1628 * - before lttng-module 2.10.10
1629 * - before lttng-module 2.9.13
1632 int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace
*trace
)
1635 guint ds_file_group_i
;
1636 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1637 bt_logging_level log_level
= trace
->log_level
;
1639 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
;
1640 ds_file_group_i
++) {
1642 struct ctf_clock_class
*default_cc
;
1643 struct ctf_fs_ds_index_entry
*last_entry
;
1644 struct ctf_fs_ds_index
*index
;
1646 struct ctf_fs_ds_file_group
*ds_file_group
=
1647 g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1649 BT_ASSERT(ds_file_group
);
1650 index
= ds_file_group
->index
;
1653 BT_ASSERT(index
->entries
);
1654 BT_ASSERT(index
->entries
->len
> 0);
1657 * Iterate over all entries but the last one. The last one is
1658 * fixed differently after.
1660 for (entry_i
= 0; entry_i
< index
->entries
->len
- 1;
1662 struct ctf_fs_ds_index_entry
*curr_entry
, *next_entry
;
1664 curr_entry
= g_ptr_array_index(index
->entries
, entry_i
);
1665 next_entry
= g_ptr_array_index(index
->entries
, entry_i
+ 1);
1668 * 1. Set the current index entry `end` timestamp to
1669 * the next index entry `begin` timestamp.
1671 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1672 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1676 * 2. Fix the last entry by decoding the last event of the last
1679 last_entry
= g_ptr_array_index(index
->entries
,
1680 index
->entries
->len
- 1);
1681 BT_ASSERT(last_entry
);
1683 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1684 default_cc
= ds_file_group
->sc
->default_clock_class
;
1687 * Decode packet to read the timestamp of the last event of the
1690 ret
= decode_packet_last_event_timestamp(trace
, default_cc
,
1691 last_entry
, &last_entry
->timestamp_end
,
1692 &last_entry
->timestamp_end_ns
);
1694 BT_COMP_LOGE_APPEND_CAUSE(trace
->self_comp
,
1695 "Failed to decode stream's last packet to get its last event's clock snapshot.");
1705 * Fix up packet index entries for barectf's "event-before-packet" bug.
1706 * Some buggy barectf tracer versions may emit events with a timestamp that is
1707 * less than the timestamp_begin of the their packets.
1709 * To fix up this erroneous data we do the following:
1710 * 1. Starting at the second index entry, set the timestamp_begin of the
1711 * current entry to the timestamp of the first event of the packet.
1712 * 2. Set the previous entry's timestamp_end to the timestamp_begin of the
1715 * Known buggy tracer versions:
1716 * - before barectf 2.3.1
1719 int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace
*trace
)
1722 guint ds_file_group_i
;
1723 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1724 bt_logging_level log_level
= trace
->log_level
;
1726 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
;
1727 ds_file_group_i
++) {
1729 struct ctf_clock_class
*default_cc
;
1730 struct ctf_fs_ds_file_group
*ds_file_group
=
1731 g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1733 struct ctf_fs_ds_index
*index
= ds_file_group
->index
;
1736 BT_ASSERT(index
->entries
);
1737 BT_ASSERT(index
->entries
->len
> 0);
1739 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1740 default_cc
= ds_file_group
->sc
->default_clock_class
;
1743 * 1. Iterate over the index, starting from the second entry
1746 for (entry_i
= 1; entry_i
< index
->entries
->len
;
1748 struct ctf_fs_ds_index_entry
*curr_entry
, *prev_entry
;
1749 prev_entry
= g_ptr_array_index(index
->entries
, entry_i
- 1);
1750 curr_entry
= g_ptr_array_index(index
->entries
, entry_i
);
1752 * 2. Set the current entry `begin` timestamp to the
1753 * timestamp of the first event of the current packet.
1755 ret
= decode_packet_first_event_timestamp(trace
, default_cc
,
1756 curr_entry
, &curr_entry
->timestamp_begin
,
1757 &curr_entry
->timestamp_begin_ns
);
1759 BT_COMP_LOGE_APPEND_CAUSE(trace
->self_comp
,
1760 "Failed to decode first event's clock snapshot");
1765 * 3. Set the previous entry `end` timestamp to the
1766 * timestamp of the first event of the current packet.
1768 prev_entry
->timestamp_end
= curr_entry
->timestamp_begin
;
1769 prev_entry
->timestamp_end_ns
= curr_entry
->timestamp_begin_ns
;
1777 * When using the lttng-crash feature it's likely that the last packets of each
1778 * stream have their timestamp_end set to zero. This is caused by the fact that
1779 * the tracer crashed and was not able to properly close the packets.
1781 * To fix up this erroneous data we do the following:
1782 * For each index entry, if the entry's timestamp_end is 0 and the
1783 * timestamp_begin is not 0:
1784 * - If it's the stream file's last packet: set the packet index entry's end
1785 * time to the packet's last event's time, if any, or to the packet's
1786 * beginning time otherwise.
1787 * - If it's not the stream file's last packet: set the packet index
1788 * entry's end time to the next packet's beginning time.
1790 * Affected versions:
1791 * - All current and future lttng-ust and lttng-modules versions.
1794 int fix_index_lttng_crash_quirk(struct ctf_fs_trace
*trace
)
1797 guint ds_file_group_idx
;
1798 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1799 bt_logging_level log_level
= trace
->log_level
;
1801 for (ds_file_group_idx
= 0; ds_file_group_idx
< ds_file_groups
->len
;
1802 ds_file_group_idx
++) {
1804 struct ctf_clock_class
*default_cc
;
1805 struct ctf_fs_ds_index_entry
*last_entry
;
1806 struct ctf_fs_ds_index
*index
;
1808 struct ctf_fs_ds_file_group
*ds_file_group
=
1809 g_ptr_array_index(ds_file_groups
, ds_file_group_idx
);
1811 BT_ASSERT(ds_file_group
);
1812 index
= ds_file_group
->index
;
1814 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1815 default_cc
= ds_file_group
->sc
->default_clock_class
;
1818 BT_ASSERT(index
->entries
);
1819 BT_ASSERT(index
->entries
->len
> 0);
1821 last_entry
= g_ptr_array_index(index
->entries
,
1822 index
->entries
->len
- 1);
1823 BT_ASSERT(last_entry
);
1826 /* 1. Fix the last entry first. */
1827 if (last_entry
->timestamp_end
== 0 &&
1828 last_entry
->timestamp_begin
!= 0) {
1830 * Decode packet to read the timestamp of the
1831 * last event of the stream file.
1833 ret
= decode_packet_last_event_timestamp(trace
,
1834 default_cc
, last_entry
,
1835 &last_entry
->timestamp_end
,
1836 &last_entry
->timestamp_end_ns
);
1838 BT_COMP_LOGE_APPEND_CAUSE(trace
->self_comp
,
1839 "Failed to decode last event's clock snapshot");
1844 /* Iterate over all entries but the last one. */
1845 for (entry_idx
= 0; entry_idx
< index
->entries
->len
- 1;
1847 struct ctf_fs_ds_index_entry
*curr_entry
, *next_entry
;
1848 curr_entry
= g_ptr_array_index(index
->entries
, entry_idx
);
1849 next_entry
= g_ptr_array_index(index
->entries
, entry_idx
+ 1);
1851 if (curr_entry
->timestamp_end
== 0 &&
1852 curr_entry
->timestamp_begin
!= 0) {
1854 * 2. Set the current index entry `end` timestamp to
1855 * the next index entry `begin` timestamp.
1857 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1858 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1868 * Extract the tracer information necessary to compare versions.
1869 * Returns 0 on success, and -1 if the extraction is not successful because the
1870 * necessary fields are absents in the trace metadata.
1873 int extract_tracer_info(struct ctf_fs_trace
*trace
,
1874 struct tracer_info
*current_tracer_info
)
1877 struct ctf_trace_class_env_entry
*entry
;
1879 /* Clear the current_tracer_info struct */
1880 memset(current_tracer_info
, 0, sizeof(*current_tracer_info
));
1883 * To compare 2 tracer versions, at least the tracer name and it's
1884 * major version are needed. If one of these is missing, consider it an
1885 * extraction failure.
1887 entry
= ctf_trace_class_borrow_env_entry_by_name(
1888 trace
->metadata
->tc
, "tracer_name");
1889 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR
) {
1890 goto missing_bare_minimum
;
1893 /* Set tracer name. */
1894 current_tracer_info
->name
= entry
->value
.str
->str
;
1896 entry
= ctf_trace_class_borrow_env_entry_by_name(
1897 trace
->metadata
->tc
, "tracer_major");
1898 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1899 goto missing_bare_minimum
;
1902 /* Set major version number. */
1903 current_tracer_info
->major
= entry
->value
.i
;
1905 entry
= ctf_trace_class_borrow_env_entry_by_name(
1906 trace
->metadata
->tc
, "tracer_minor");
1907 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1911 /* Set minor version number. */
1912 current_tracer_info
->minor
= entry
->value
.i
;
1914 entry
= ctf_trace_class_borrow_env_entry_by_name(
1915 trace
->metadata
->tc
, "tracer_patch");
1918 * If `tracer_patch` doesn't exist `tracer_patchlevel` might.
1919 * For example, `lttng-modules` uses entry name
1920 * `tracer_patchlevel`.
1922 entry
= ctf_trace_class_borrow_env_entry_by_name(
1923 trace
->metadata
->tc
, "tracer_patchlevel");
1926 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1930 /* Set patch version number. */
1931 current_tracer_info
->patch
= entry
->value
.i
;
1935 missing_bare_minimum
:
1942 bool is_tracer_affected_by_lttng_event_after_packet_bug(
1943 struct tracer_info
*curr_tracer_info
)
1945 bool is_affected
= false;
1947 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1948 if (curr_tracer_info
->major
< 2) {
1950 } else if (curr_tracer_info
->major
== 2) {
1951 /* fixed in lttng-ust 2.11.0 */
1952 if (curr_tracer_info
->minor
< 11) {
1956 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1957 if (curr_tracer_info
->major
< 2) {
1959 } else if (curr_tracer_info
->major
== 2) {
1960 /* fixed in lttng-modules 2.11.0 */
1961 if (curr_tracer_info
->minor
== 10) {
1962 /* fixed in lttng-modules 2.10.10 */
1963 if (curr_tracer_info
->patch
< 10) {
1966 } else if (curr_tracer_info
->minor
== 9) {
1967 /* fixed in lttng-modules 2.9.13 */
1968 if (curr_tracer_info
->patch
< 13) {
1971 } else if (curr_tracer_info
->minor
< 9) {
1981 bool is_tracer_affected_by_barectf_event_before_packet_bug(
1982 struct tracer_info
*curr_tracer_info
)
1984 bool is_affected
= false;
1986 if (strcmp(curr_tracer_info
->name
, "barectf") == 0) {
1987 if (curr_tracer_info
->major
< 2) {
1989 } else if (curr_tracer_info
->major
== 2) {
1990 if (curr_tracer_info
->minor
< 3) {
1992 } else if (curr_tracer_info
->minor
== 3) {
1993 /* fixed in barectf 2.3.1 */
1994 if (curr_tracer_info
->patch
< 1) {
2005 bool is_tracer_affected_by_lttng_crash_quirk(
2006 struct tracer_info
*curr_tracer_info
)
2008 bool is_affected
= false;
2010 /* All LTTng tracer may be affected by this lttng crash quirk. */
2011 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
2013 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
2021 * Looks for trace produced by known buggy tracers and fix up the index
2025 int fix_packet_index_tracer_bugs(struct ctf_fs_component
*ctf_fs
,
2026 bt_self_component
*self_comp
,
2027 bt_self_component_class
*self_comp_class
)
2030 struct tracer_info current_tracer_info
;
2031 bt_logging_level log_level
= ctf_fs
->log_level
;
2033 ret
= extract_tracer_info(ctf_fs
->trace
, ¤t_tracer_info
);
2036 * A trace may not have all the necessary environment
2037 * entries to do the tracer version comparison.
2038 * At least, the tracer name and major version number
2039 * are needed. Failing to extract these entries is not
2043 BT_LOGI_STR("Cannot extract tracer information necessary to compare with buggy versions.");
2047 /* Check if the trace may be affected by old tracer bugs. */
2048 if (is_tracer_affected_by_lttng_event_after_packet_bug(
2049 ¤t_tracer_info
)) {
2050 BT_LOGI_STR("Trace may be affected by LTTng tracer packet timestamp bug. Fixing up.");
2051 ret
= fix_index_lttng_event_after_packet_bug(ctf_fs
->trace
);
2053 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
2054 self_comp
, self_comp_class
,
2055 "Failed to fix LTTng event-after-packet bug.");
2058 ctf_fs
->trace
->metadata
->tc
->quirks
.lttng_event_after_packet
= true;
2061 if (is_tracer_affected_by_barectf_event_before_packet_bug(
2062 ¤t_tracer_info
)) {
2063 BT_LOGI_STR("Trace may be affected by barectf tracer packet timestamp bug. Fixing up.");
2064 ret
= fix_index_barectf_event_before_packet_bug(ctf_fs
->trace
);
2066 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
2067 self_comp
, self_comp_class
,
2068 "Failed to fix barectf event-before-packet bug.");
2071 ctf_fs
->trace
->metadata
->tc
->quirks
.barectf_event_before_packet
= true;
2074 if (is_tracer_affected_by_lttng_crash_quirk(
2075 ¤t_tracer_info
)) {
2076 ret
= fix_index_lttng_crash_quirk(ctf_fs
->trace
);
2078 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
2079 self_comp
, self_comp_class
,
2080 "Failed to fix lttng-crash timestamp quirks.");
2083 ctf_fs
->trace
->metadata
->tc
->quirks
.lttng_crash
= true;
2091 gint
compare_ds_file_groups_by_first_path(gconstpointer a
, gconstpointer b
)
2093 struct ctf_fs_ds_file_group
* const *ds_file_group_a
= a
;
2094 struct ctf_fs_ds_file_group
* const *ds_file_group_b
= b
;
2095 const struct ctf_fs_ds_file_info
*first_ds_file_info_a
;
2096 const struct ctf_fs_ds_file_info
*first_ds_file_info_b
;
2098 BT_ASSERT((*ds_file_group_a
)->ds_file_infos
->len
> 0);
2099 BT_ASSERT((*ds_file_group_b
)->ds_file_infos
->len
> 0);
2100 first_ds_file_info_a
= (*ds_file_group_a
)->ds_file_infos
->pdata
[0];
2101 first_ds_file_info_b
= (*ds_file_group_b
)->ds_file_infos
->pdata
[0];
2102 return strcmp(first_ds_file_info_a
->path
->str
,
2103 first_ds_file_info_b
->path
->str
);
2106 int ctf_fs_component_create_ctf_fs_trace(
2107 struct ctf_fs_component
*ctf_fs
,
2108 const bt_value
*paths_value
,
2109 const bt_value
*trace_name_value
,
2110 bt_self_component
*self_comp
,
2111 bt_self_component_class
*self_comp_class
)
2115 bt_logging_level log_level
= ctf_fs
->log_level
;
2117 const char *trace_name
;
2119 BT_ASSERT(bt_value_get_type(paths_value
) == BT_VALUE_TYPE_ARRAY
);
2120 BT_ASSERT(!bt_value_array_is_empty(paths_value
));
2122 traces
= g_ptr_array_new_with_free_func(ctf_fs_trace_destroy_notifier
);
2124 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2125 "Failed to allocate a GPtrArray.");
2129 trace_name
= trace_name_value
? bt_value_string_get(trace_name_value
) : NULL
;
2131 /* Start by creating a separate ctf_fs_trace object for each path. */
2132 for (i
= 0; i
< bt_value_array_get_length(paths_value
); i
++) {
2133 const bt_value
*path_value
= bt_value_array_borrow_element_by_index_const(paths_value
, i
);
2134 const char *input
= bt_value_string_get(path_value
);
2136 ret
= ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs
,
2137 input
, trace_name
, traces
, self_comp
, self_comp_class
);
2143 if (traces
->len
> 1) {
2144 struct ctf_fs_trace
*first_trace
= (struct ctf_fs_trace
*) traces
->pdata
[0];
2145 const uint8_t *first_trace_uuid
= first_trace
->metadata
->tc
->uuid
;
2146 struct ctf_fs_trace
*trace
;
2149 * We have more than one trace, they must all share the same
2150 * UUID, verify that.
2152 for (i
= 0; i
< traces
->len
; i
++) {
2153 struct ctf_fs_trace
*this_trace
=
2154 (struct ctf_fs_trace
*) traces
->pdata
[i
];
2155 const uint8_t *this_trace_uuid
= this_trace
->metadata
->tc
->uuid
;
2157 if (!this_trace
->metadata
->tc
->is_uuid_set
) {
2158 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2159 "Multiple traces given, but a trace does not have a UUID: path=%s",
2160 this_trace
->path
->str
);
2164 if (bt_uuid_compare(first_trace_uuid
, this_trace_uuid
) != 0) {
2165 char first_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
2166 char this_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
2168 bt_uuid_to_str(first_trace_uuid
, first_trace_uuid_str
);
2169 bt_uuid_to_str(this_trace_uuid
, this_trace_uuid_str
);
2171 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2172 "Multiple traces given, but UUIDs don't match: "
2173 "first-trace-uuid=%s, first-trace-path=%s, "
2174 "trace-uuid=%s, trace-path=%s",
2175 first_trace_uuid_str
, first_trace
->path
->str
,
2176 this_trace_uuid_str
, this_trace
->path
->str
);
2181 ret
= merge_ctf_fs_traces((struct ctf_fs_trace
**) traces
->pdata
,
2182 traces
->len
, &trace
);
2184 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2185 "Failed to merge traces with the same UUID.");
2189 ctf_fs
->trace
= trace
;
2191 /* Just one trace, it may or may not have a UUID, both are fine. */
2192 ctf_fs
->trace
= traces
->pdata
[0];
2193 traces
->pdata
[0] = NULL
;
2196 ret
= fix_packet_index_tracer_bugs(ctf_fs
, self_comp
, self_comp_class
);
2198 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2199 "Failed to fix packet index tracer bugs.");
2203 * Sort data stream file groups by first data stream file info
2204 * path to get a deterministic order. This order influences the
2205 * order of the output ports. It also influences the order of
2206 * the automatic stream IDs if the trace's packet headers do not
2207 * contain a `stream_instance_id` field, in which case the data
2208 * stream file to stream ID association is always the same,
2209 * whatever the build and the system.
2211 * Having a deterministic order here can help debugging and
2214 g_ptr_array_sort(ctf_fs
->trace
->ds_file_groups
,
2215 compare_ds_file_groups_by_first_path
);
2221 g_ptr_array_free(traces
, TRUE
);
2226 GString
*get_stream_instance_unique_name(
2227 struct ctf_fs_ds_file_group
*ds_file_group
)
2230 struct ctf_fs_ds_file_info
*ds_file_info
;
2232 name
= g_string_new(NULL
);
2238 * If there's more than one stream file in the stream file
2239 * group, the first (earliest) stream file's path is used as
2240 * the stream's unique name.
2242 BT_ASSERT(ds_file_group
->ds_file_infos
->len
> 0);
2243 ds_file_info
= g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
2244 g_string_assign(name
, ds_file_info
->path
->str
);
2250 /* Create the IR stream objects for ctf_fs_trace. */
2253 int create_streams_for_trace(struct ctf_fs_trace
*ctf_fs_trace
)
2256 GString
*name
= NULL
;
2258 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
2259 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
2261 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
2262 struct ctf_fs_ds_file_group
*ds_file_group
=
2263 g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
2264 name
= get_stream_instance_unique_name(ds_file_group
);
2270 if (ds_file_group
->sc
->ir_sc
) {
2271 BT_ASSERT(ctf_fs_trace
->trace
);
2273 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
2274 /* No stream ID: use 0 */
2275 ds_file_group
->stream
= bt_stream_create_with_id(
2276 ds_file_group
->sc
->ir_sc
,
2277 ctf_fs_trace
->trace
,
2278 ctf_fs_trace
->next_stream_id
);
2279 ctf_fs_trace
->next_stream_id
++;
2281 /* Specific stream ID */
2282 ds_file_group
->stream
= bt_stream_create_with_id(
2283 ds_file_group
->sc
->ir_sc
,
2284 ctf_fs_trace
->trace
,
2285 (uint64_t) ds_file_group
->stream_id
);
2288 ds_file_group
->stream
= NULL
;
2291 if (!ds_file_group
->stream
) {
2292 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2293 "Cannot create stream for DS file group: "
2294 "addr=%p, stream-name=\"%s\"",
2295 ds_file_group
, name
->str
);
2299 ret
= bt_stream_set_name(ds_file_group
->stream
,
2302 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Cannot set stream's name: "
2303 "addr=%p, stream-name=\"%s\"",
2304 ds_file_group
->stream
, name
->str
);
2308 g_string_free(name
, TRUE
);
2321 g_string_free(name
, TRUE
);
2326 static const struct bt_param_validation_value_descr inputs_elem_descr
= {
2327 .type
= BT_VALUE_TYPE_STRING
,
2330 static const struct bt_param_validation_map_value_entry_descr fs_params_entries_descr
[] = {
2331 { "inputs", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
, {
2332 BT_VALUE_TYPE_ARRAY
,
2335 .max_length
= BT_PARAM_VALIDATION_INFINITE
,
2336 .element_type
= &inputs_elem_descr
,
2339 { "trace-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_STRING
} },
2340 { "clock-class-offset-s", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_SIGNED_INTEGER
} },
2341 { "clock-class-offset-ns", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_SIGNED_INTEGER
} },
2342 { "force-clock-class-origin-unix-epoch", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_BOOL
} },
2343 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
2347 bool read_src_fs_parameters(const bt_value
*params
,
2348 const bt_value
**inputs
,
2349 const bt_value
**trace_name
,
2350 struct ctf_fs_component
*ctf_fs
,
2351 bt_self_component
*self_comp
,
2352 bt_self_component_class
*self_comp_class
) {
2354 const bt_value
*value
;
2355 bt_logging_level log_level
= ctf_fs
->log_level
;
2356 enum bt_param_validation_status validate_value_status
;
2357 gchar
*error
= NULL
;
2359 validate_value_status
= bt_param_validation_validate(params
,
2360 fs_params_entries_descr
, &error
);
2361 if (validate_value_status
!= BT_PARAM_VALIDATION_STATUS_OK
) {
2362 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2368 /* inputs parameter */
2369 *inputs
= bt_value_map_borrow_entry_value_const(params
, "inputs");
2371 /* clock-class-offset-s parameter */
2372 value
= bt_value_map_borrow_entry_value_const(params
,
2373 "clock-class-offset-s");
2375 ctf_fs
->metadata_config
.clock_class_offset_s
=
2376 bt_value_integer_signed_get(value
);
2379 /* clock-class-offset-ns parameter */
2380 value
= bt_value_map_borrow_entry_value_const(params
,
2381 "clock-class-offset-ns");
2383 ctf_fs
->metadata_config
.clock_class_offset_ns
=
2384 bt_value_integer_signed_get(value
);
2387 /* force-clock-class-origin-unix-epoch parameter */
2388 value
= bt_value_map_borrow_entry_value_const(params
,
2389 "force-clock-class-origin-unix-epoch");
2391 ctf_fs
->metadata_config
.force_clock_class_origin_unix_epoch
=
2392 bt_value_bool_get(value
);
2395 /* trace-name parameter */
2396 *trace_name
= bt_value_map_borrow_entry_value_const(params
, "trace-name");
2406 struct ctf_fs_component
*ctf_fs_create(
2407 const bt_value
*params
,
2408 bt_self_component_source
*self_comp_src
)
2410 struct ctf_fs_component
*ctf_fs
= NULL
;
2411 const bt_value
*inputs_value
;
2412 const bt_value
*trace_name_value
;
2413 bt_self_component
*self_comp
=
2414 bt_self_component_source_as_self_component(self_comp_src
);
2416 ctf_fs
= ctf_fs_component_create(bt_component_get_logging_level(
2417 bt_self_component_as_component(self_comp
)), self_comp
);
2422 if (!read_src_fs_parameters(params
, &inputs_value
, &trace_name_value
,
2423 ctf_fs
, self_comp
, NULL
)) {
2427 bt_self_component_set_data(self_comp
, ctf_fs
);
2429 if (ctf_fs_component_create_ctf_fs_trace(ctf_fs
, inputs_value
,
2430 trace_name_value
, self_comp
, NULL
)) {
2434 if (create_streams_for_trace(ctf_fs
->trace
)) {
2438 if (create_ports_for_trace(ctf_fs
, ctf_fs
->trace
, self_comp_src
)) {
2445 ctf_fs_destroy(ctf_fs
);
2447 bt_self_component_set_data(self_comp
, NULL
);
2454 bt_component_class_initialize_method_status
ctf_fs_init(
2455 bt_self_component_source
*self_comp_src
,
2456 bt_self_component_source_configuration
*config
,
2457 const bt_value
*params
, __attribute__((unused
)) void *init_method_data
)
2459 struct ctf_fs_component
*ctf_fs
;
2460 bt_component_class_initialize_method_status ret
=
2461 BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
2463 ctf_fs
= ctf_fs_create(params
, self_comp_src
);
2465 ret
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
2472 bt_component_class_query_method_status
ctf_fs_query(
2473 bt_self_component_class_source
*comp_class
,
2474 bt_private_query_executor
*priv_query_exec
,
2475 const char *object
, const bt_value
*params
,
2476 __attribute__((unused
)) void *method_data
,
2477 const bt_value
**result
)
2479 bt_component_class_query_method_status status
=
2480 BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
2481 bt_logging_level log_level
= bt_query_executor_get_logging_level(
2482 bt_private_query_executor_as_query_executor_const(
2485 if (strcmp(object
, "metadata-info") == 0) {
2486 status
= metadata_info_query(comp_class
, params
, log_level
,
2488 } else if (strcmp(object
, "babeltrace.trace-infos") == 0) {
2489 status
= trace_infos_query(comp_class
, params
, log_level
,
2491 } else if (!strcmp(object
, "babeltrace.support-info")) {
2492 status
= support_info_query(comp_class
, params
, log_level
, result
);
2494 BT_LOGE("Unknown query object `%s`", object
);
2495 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;