2 * SPDX-License-Identifier: MIT
4 * Copyright 2015-2017 Philippe Proulx <pproulx@efficios.com>
5 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 * Babeltrace CTF file system Reader Component
10 #define BT_COMP_LOG_SELF_COMP self_comp
11 #define BT_LOG_OUTPUT_LEVEL log_level
12 #define BT_LOG_TAG "PLUGIN/SRC.CTF.FS"
13 #include "logging/comp-logging.h"
15 #include "common/common.h"
16 #include <babeltrace2/babeltrace.h>
17 #include "common/uuid.h"
19 #include "common/assert.h"
23 #include "metadata.hpp"
24 #include "data-stream-file.hpp"
26 #include "../common/metadata/decoder.hpp"
27 #include "../common/metadata/ctf-meta-configure-ir-trace.hpp"
28 #include "../common/msg-iter/msg-iter.hpp"
30 #include "plugins/common/param-validation/param-validation.h"
40 void ctf_fs_msg_iter_data_destroy(
41 struct ctf_fs_msg_iter_data
*msg_iter_data
)
47 if (msg_iter_data
->msg_iter
) {
48 ctf_msg_iter_destroy(msg_iter_data
->msg_iter
);
51 if (msg_iter_data
->msg_iter_medops_data
) {
52 ctf_fs_ds_group_medops_data_destroy(
53 msg_iter_data
->msg_iter_medops_data
);
56 g_free(msg_iter_data
);
60 bt_message_iterator_class_next_method_status
ctf_fs_iterator_next_one(
61 struct ctf_fs_msg_iter_data
*msg_iter_data
,
62 const bt_message
**out_msg
)
64 bt_message_iterator_class_next_method_status status
;
65 enum ctf_msg_iter_status msg_iter_status
;
66 bt_logging_level log_level
= msg_iter_data
->log_level
;
68 msg_iter_status
= ctf_msg_iter_get_next_message(
69 msg_iter_data
->msg_iter
, out_msg
);
71 switch (msg_iter_status
) {
72 case CTF_MSG_ITER_STATUS_OK
:
73 /* Cool, message has been written to *out_msg. */
74 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
77 case CTF_MSG_ITER_STATUS_EOF
:
78 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END
;
81 case CTF_MSG_ITER_STATUS_AGAIN
:
83 * Should not make it this far as this is
84 * medium-specific; there is nothing for the user to do
85 * and it should have been handled upstream.
89 case CTF_MSG_ITER_STATUS_ERROR
:
90 BT_MSG_ITER_LOGE_APPEND_CAUSE(msg_iter_data
->self_msg_iter
,
91 "Failed to get next message from CTF message iterator.");
92 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
95 case CTF_MSG_ITER_STATUS_MEMORY_ERROR
:
96 BT_MSG_ITER_LOGE_APPEND_CAUSE(msg_iter_data
->self_msg_iter
,
97 "Failed to get next message from CTF message iterator.");
98 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
109 bt_message_iterator_class_next_method_status
ctf_fs_iterator_next(
110 bt_self_message_iterator
*iterator
,
111 bt_message_array_const msgs
, uint64_t capacity
,
114 bt_message_iterator_class_next_method_status status
;
115 struct ctf_fs_msg_iter_data
*msg_iter_data
=
116 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(iterator
);
119 if (G_UNLIKELY(msg_iter_data
->next_saved_error
)) {
121 * Last time we were called, we hit an error but had some
122 * messages to deliver, so we stashed the error here. Return
125 BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(msg_iter_data
->next_saved_error
);
126 status
= msg_iter_data
->next_saved_status
;
131 status
= ctf_fs_iterator_next_one(msg_iter_data
, &msgs
[i
]);
132 if (status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
) {
135 } while (i
< capacity
&&
136 status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
);
140 * Even if ctf_fs_iterator_next_one() returned something
141 * else than BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK, we
142 * accumulated message objects in the output
143 * message array, so we need to return
144 * BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK so that they are
145 * transfered to downstream. This other status occurs
146 * again the next time muxer_msg_iter_do_next() is
147 * called, possibly without any accumulated
148 * message, in which case we'll return it.
152 * Save this error for the next _next call. Assume that
153 * this component always appends error causes when
154 * returning an error status code, which will cause the
155 * current thread error to be non-NULL.
157 msg_iter_data
->next_saved_error
= bt_current_thread_take_error();
158 BT_ASSERT(msg_iter_data
->next_saved_error
);
159 msg_iter_data
->next_saved_status
= status
;
163 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
171 bt_message_iterator_class_seek_beginning_method_status
172 ctf_fs_iterator_seek_beginning(bt_self_message_iterator
*it
)
174 struct ctf_fs_msg_iter_data
*msg_iter_data
=
175 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(it
);
177 BT_ASSERT(msg_iter_data
);
179 ctf_msg_iter_reset(msg_iter_data
->msg_iter
);
180 ctf_fs_ds_group_medops_data_reset(msg_iter_data
->msg_iter_medops_data
);
182 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_OK
;
186 void ctf_fs_iterator_finalize(bt_self_message_iterator
*it
)
188 ctf_fs_msg_iter_data_destroy(
189 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(it
));
193 bt_message_iterator_class_initialize_method_status
194 ctf_msg_iter_medium_status_to_msg_iter_initialize_status
195 (enum ctf_msg_iter_medium_status status
)
198 case CTF_MSG_ITER_MEDIUM_STATUS_EOF
:
199 case CTF_MSG_ITER_MEDIUM_STATUS_AGAIN
:
200 case CTF_MSG_ITER_MEDIUM_STATUS_ERROR
:
201 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
202 case CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
:
203 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
204 case CTF_MSG_ITER_MEDIUM_STATUS_OK
:
205 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
212 bt_message_iterator_class_initialize_method_status
ctf_fs_iterator_init(
213 bt_self_message_iterator
*self_msg_iter
,
214 bt_self_message_iterator_configuration
*config
,
215 bt_self_component_port_output
*self_port
)
217 struct ctf_fs_port_data
*port_data
;
218 struct ctf_fs_msg_iter_data
*msg_iter_data
= NULL
;
219 bt_message_iterator_class_initialize_method_status status
;
220 bt_logging_level log_level
;
221 enum ctf_msg_iter_medium_status medium_status
;
222 bt_self_component
*self_comp
=
223 bt_self_message_iterator_borrow_component(self_msg_iter
);
225 port_data
= (struct ctf_fs_port_data
*) bt_self_component_port_get_data(
226 bt_self_component_port_output_as_self_component_port(
228 BT_ASSERT(port_data
);
229 log_level
= port_data
->ctf_fs
->log_level
;
230 msg_iter_data
= g_new0(struct ctf_fs_msg_iter_data
, 1);
231 if (!msg_iter_data
) {
232 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
236 msg_iter_data
->log_level
= log_level
;
237 msg_iter_data
->self_comp
= self_comp
;
238 msg_iter_data
->self_msg_iter
= self_msg_iter
;
239 msg_iter_data
->ds_file_group
= port_data
->ds_file_group
;
241 medium_status
= ctf_fs_ds_group_medops_data_create(
242 msg_iter_data
->ds_file_group
, self_msg_iter
, log_level
,
243 &msg_iter_data
->msg_iter_medops_data
);
245 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_OK
||
246 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_ERROR
||
247 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
);
248 if (medium_status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
249 BT_MSG_ITER_LOGE_APPEND_CAUSE(self_msg_iter
,
250 "Failed to create ctf_fs_ds_group_medops");
251 status
= ctf_msg_iter_medium_status_to_msg_iter_initialize_status(medium_status
);
255 msg_iter_data
->msg_iter
= ctf_msg_iter_create(
256 msg_iter_data
->ds_file_group
->ctf_fs_trace
->metadata
->tc
,
257 bt_common_get_page_size(msg_iter_data
->log_level
) * 8,
258 ctf_fs_ds_group_medops
,
259 msg_iter_data
->msg_iter_medops_data
,
260 msg_iter_data
->log_level
,
261 self_comp
, self_msg_iter
);
262 if (!msg_iter_data
->msg_iter
) {
263 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Cannot create a CTF message iterator.");
264 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
269 * This iterator can seek forward if its stream class has a default
272 if (msg_iter_data
->ds_file_group
->sc
->default_clock_class
) {
273 bt_self_message_iterator_configuration_set_can_seek_forward(
277 bt_self_message_iterator_set_data(self_msg_iter
,
279 msg_iter_data
= NULL
;
281 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
285 bt_self_message_iterator_set_data(self_msg_iter
, NULL
);
288 ctf_fs_msg_iter_data_destroy(msg_iter_data
);
293 void ctf_fs_trace_destroy(struct ctf_fs_trace
*ctf_fs_trace
)
299 if (ctf_fs_trace
->ds_file_groups
) {
300 g_ptr_array_free(ctf_fs_trace
->ds_file_groups
, TRUE
);
303 BT_TRACE_PUT_REF_AND_RESET(ctf_fs_trace
->trace
);
305 if (ctf_fs_trace
->path
) {
306 g_string_free(ctf_fs_trace
->path
, TRUE
);
309 if (ctf_fs_trace
->metadata
) {
310 ctf_fs_metadata_fini(ctf_fs_trace
->metadata
);
311 g_free(ctf_fs_trace
->metadata
);
314 g_free(ctf_fs_trace
);
318 void ctf_fs_destroy(struct ctf_fs_component
*ctf_fs
)
324 ctf_fs_trace_destroy(ctf_fs
->trace
);
326 if (ctf_fs
->port_data
) {
327 g_ptr_array_free(ctf_fs
->port_data
, TRUE
);
334 void port_data_destroy(struct ctf_fs_port_data
*port_data
)
344 void port_data_destroy_notifier(void *data
) {
345 port_data_destroy((struct ctf_fs_port_data
*) data
);
349 void ctf_fs_trace_destroy_notifier(void *data
)
351 struct ctf_fs_trace
*trace
= (struct ctf_fs_trace
*) data
;
352 ctf_fs_trace_destroy(trace
);
355 struct ctf_fs_component
*ctf_fs_component_create(bt_logging_level log_level
,
356 bt_self_component
*self_comp
)
358 struct ctf_fs_component
*ctf_fs
;
360 ctf_fs
= g_new0(struct ctf_fs_component
, 1);
365 ctf_fs
->log_level
= log_level
;
367 g_ptr_array_new_with_free_func(port_data_destroy_notifier
);
368 if (!ctf_fs
->port_data
) {
375 ctf_fs_destroy(ctf_fs
);
382 void ctf_fs_finalize(bt_self_component_source
*component
)
384 ctf_fs_destroy((struct ctf_fs_component
*) bt_self_component_get_data(
385 bt_self_component_source_as_self_component(component
)));
388 gchar
*ctf_fs_make_port_name(struct ctf_fs_ds_file_group
*ds_file_group
)
390 GString
*name
= g_string_new(NULL
);
393 * The unique port name is generated by concatenating unique identifiers
401 /* For the trace, use the uuid if present, else the path. */
402 if (ds_file_group
->ctf_fs_trace
->metadata
->tc
->is_uuid_set
) {
403 char uuid_str
[BT_UUID_STR_LEN
+ 1];
405 bt_uuid_to_str(ds_file_group
->ctf_fs_trace
->metadata
->tc
->uuid
, uuid_str
);
406 g_string_assign(name
, uuid_str
);
408 g_string_assign(name
, ds_file_group
->ctf_fs_trace
->path
->str
);
412 * For the stream class, use the id if present. We can omit this field
413 * otherwise, as there will only be a single stream class.
415 if (ds_file_group
->sc
->id
!= UINT64_C(-1)) {
416 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->sc
->id
);
419 /* For the stream, use the id if present, else, use the path. */
420 if (ds_file_group
->stream_id
!= UINT64_C(-1)) {
421 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->stream_id
);
423 BT_ASSERT(ds_file_group
->ds_file_infos
->len
== 1);
424 struct ctf_fs_ds_file_info
*ds_file_info
=
425 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
426 g_string_append_printf(name
, " | %s", ds_file_info
->path
->str
);
429 return g_string_free(name
, FALSE
);
433 int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
434 struct ctf_fs_trace
*ctf_fs_trace
,
435 struct ctf_fs_ds_file_group
*ds_file_group
,
436 bt_self_component_source
*self_comp_src
)
439 struct ctf_fs_port_data
*port_data
= NULL
;
441 bt_logging_level log_level
= ctf_fs
->log_level
;
442 bt_self_component
*self_comp
=
443 bt_self_component_source_as_self_component(self_comp_src
);
445 port_name
= ctf_fs_make_port_name(ds_file_group
);
450 BT_COMP_LOGI("Creating one port named `%s`", port_name
);
452 /* Create output port for this file */
453 port_data
= g_new0(struct ctf_fs_port_data
, 1);
458 port_data
->ctf_fs
= ctf_fs
;
459 port_data
->ds_file_group
= ds_file_group
;
460 ret
= bt_self_component_source_add_output_port(
461 self_comp_src
, port_name
, port_data
, NULL
);
466 g_ptr_array_add(ctf_fs
->port_data
, port_data
);
476 port_data_destroy(port_data
);
481 int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
482 struct ctf_fs_trace
*ctf_fs_trace
,
483 bt_self_component_source
*self_comp_src
)
487 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
488 bt_self_component
*self_comp
=
489 bt_self_component_source_as_self_component(self_comp_src
);
491 /* Create one output port for each stream file group */
492 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
493 struct ctf_fs_ds_file_group
*ds_file_group
=
494 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
496 ret
= create_one_port_for_trace(ctf_fs
, ctf_fs_trace
,
497 ds_file_group
, self_comp_src
);
499 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Cannot create output port.");
509 void ctf_fs_ds_file_info_destroy(struct ctf_fs_ds_file_info
*ds_file_info
)
515 if (ds_file_info
->path
) {
516 g_string_free(ds_file_info
->path
, TRUE
);
519 g_free(ds_file_info
);
523 struct ctf_fs_ds_file_info
*ctf_fs_ds_file_info_create(const char *path
,
526 struct ctf_fs_ds_file_info
*ds_file_info
;
528 ds_file_info
= g_new0(struct ctf_fs_ds_file_info
, 1);
533 ds_file_info
->path
= g_string_new(path
);
534 if (!ds_file_info
->path
) {
535 ctf_fs_ds_file_info_destroy(ds_file_info
);
540 ds_file_info
->begin_ns
= begin_ns
;
547 void ctf_fs_ds_file_group_destroy(struct ctf_fs_ds_file_group
*ds_file_group
)
549 if (!ds_file_group
) {
553 if (ds_file_group
->ds_file_infos
) {
554 g_ptr_array_free(ds_file_group
->ds_file_infos
, TRUE
);
557 ctf_fs_ds_index_destroy(ds_file_group
->index
);
559 bt_stream_put_ref(ds_file_group
->stream
);
560 g_free(ds_file_group
);
564 struct ctf_fs_ds_file_group
*ctf_fs_ds_file_group_create(
565 struct ctf_fs_trace
*ctf_fs_trace
,
566 struct ctf_stream_class
*sc
,
567 uint64_t stream_instance_id
,
568 struct ctf_fs_ds_index
*index
)
570 struct ctf_fs_ds_file_group
*ds_file_group
;
572 ds_file_group
= g_new0(struct ctf_fs_ds_file_group
, 1);
573 if (!ds_file_group
) {
577 ds_file_group
->ds_file_infos
= g_ptr_array_new_with_free_func(
578 (GDestroyNotify
) ctf_fs_ds_file_info_destroy
);
579 if (!ds_file_group
->ds_file_infos
) {
583 ds_file_group
->index
= index
;
585 ds_file_group
->stream_id
= stream_instance_id
;
587 ds_file_group
->sc
= sc
;
588 ds_file_group
->ctf_fs_trace
= ctf_fs_trace
;
592 ctf_fs_ds_file_group_destroy(ds_file_group
);
593 ctf_fs_ds_index_destroy(index
);
594 ds_file_group
= NULL
;
597 return ds_file_group
;
600 /* Replace by g_ptr_array_insert when we depend on glib >= 2.40. */
602 void array_insert(GPtrArray
*array
, gpointer element
, size_t pos
)
604 size_t original_array_len
= array
->len
;
606 /* Allocate an unused element at the end of the array. */
607 g_ptr_array_add(array
, NULL
);
609 /* If we are not inserting at the end, move the elements by one. */
610 if (pos
< original_array_len
) {
611 memmove(&(array
->pdata
[pos
+ 1]),
612 &(array
->pdata
[pos
]),
613 (original_array_len
- pos
) * sizeof(gpointer
));
616 /* Insert the value. */
617 array
->pdata
[pos
] = element
;
621 * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right
622 * place to keep it sorted.
626 void ds_file_group_insert_ds_file_info_sorted(
627 struct ctf_fs_ds_file_group
*ds_file_group
,
628 struct ctf_fs_ds_file_info
*ds_file_info
)
632 /* Find the spot where to insert this ds_file_info. */
633 for (i
= 0; i
< ds_file_group
->ds_file_infos
->len
; i
++) {
634 struct ctf_fs_ds_file_info
*other_ds_file_info
=
635 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, i
);
637 if (ds_file_info
->begin_ns
< other_ds_file_info
->begin_ns
) {
642 array_insert(ds_file_group
->ds_file_infos
, ds_file_info
, i
);
646 bool ds_index_entries_equal(
647 const struct ctf_fs_ds_index_entry
*left
,
648 const struct ctf_fs_ds_index_entry
*right
)
650 if (left
->packet_size
!= right
->packet_size
) {
654 if (left
->timestamp_begin
!= right
->timestamp_begin
) {
658 if (left
->timestamp_end
!= right
->timestamp_end
) {
662 if (left
->packet_seq_num
!= right
->packet_seq_num
) {
670 * Insert `entry` into `index`, without duplication.
672 * The entry is inserted only if there isn't an identical entry already.
674 * In any case, the ownership of `entry` is transferred to this function. So if
675 * the entry is not inserted, it is freed.
679 void ds_index_insert_ds_index_entry_sorted(
680 struct ctf_fs_ds_index
*index
,
681 struct ctf_fs_ds_index_entry
*entry
)
684 struct ctf_fs_ds_index_entry
*other_entry
= NULL
;
686 /* Find the spot where to insert this index entry. */
687 for (i
= 0; i
< index
->entries
->len
; i
++) {
688 other_entry
= (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, i
);
690 if (entry
->timestamp_begin_ns
<= other_entry
->timestamp_begin_ns
) {
696 * Insert the entry only if a duplicate doesn't already exist.
698 * There can be duplicate packets if reading multiple overlapping
699 * snapshots of the same trace. We then want the index to contain
700 * a reference to only one copy of that packet.
702 if (i
== index
->entries
->len
||
703 !ds_index_entries_equal(entry
, other_entry
)) {
704 array_insert(index
->entries
, entry
, i
);
711 void merge_ctf_fs_ds_indexes(struct ctf_fs_ds_index
*dest
, struct ctf_fs_ds_index
*src
)
715 for (i
= 0; i
< src
->entries
->len
; i
++) {
716 struct ctf_fs_ds_index_entry
*entry
=
717 (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(src
->entries
, i
);
720 * Ownership of the ctf_fs_ds_index_entry is transferred to
721 * ds_index_insert_ds_index_entry_sorted.
723 g_ptr_array_index(src
->entries
, i
) = NULL
;
724 ds_index_insert_ds_index_entry_sorted(dest
, entry
);
729 int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
,
732 int64_t stream_instance_id
= -1;
733 int64_t begin_ns
= -1;
734 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
735 bool add_group
= false;
738 struct ctf_fs_ds_file
*ds_file
= NULL
;
739 struct ctf_fs_ds_file_info
*ds_file_info
= NULL
;
740 struct ctf_fs_ds_index
*index
= NULL
;
741 struct ctf_msg_iter
*msg_iter
= NULL
;
742 struct ctf_stream_class
*sc
= NULL
;
743 struct ctf_msg_iter_packet_properties props
;
744 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
745 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
746 bt_self_component_class
*self_comp_class
= ctf_fs_trace
->self_comp_class
;
749 * Create a temporary ds_file to read some properties about the data
752 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, NULL
, path
,
758 /* Create a temporary iterator to read the ds_file. */
759 msg_iter
= ctf_msg_iter_create(ctf_fs_trace
->metadata
->tc
,
760 bt_common_get_page_size(log_level
) * 8,
761 ctf_fs_ds_file_medops
, ds_file
, log_level
, self_comp
, NULL
);
763 BT_COMP_LOGE_STR("Cannot create a CTF message iterator.");
767 ctf_msg_iter_set_dry_run(msg_iter
, true);
769 ret
= ctf_msg_iter_get_packet_properties(msg_iter
, &props
);
771 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
772 "Cannot get stream file's first packet's header and context fields (`%s`).",
777 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
,
778 props
.stream_class_id
);
780 stream_instance_id
= props
.data_stream_id
;
782 if (props
.snapshots
.beginning_clock
!= UINT64_C(-1)) {
783 BT_ASSERT(sc
->default_clock_class
);
784 ret
= bt_util_clock_cycles_to_ns_from_origin(
785 props
.snapshots
.beginning_clock
,
786 sc
->default_clock_class
->frequency
,
787 sc
->default_clock_class
->offset_seconds
,
788 sc
->default_clock_class
->offset_cycles
, &begin_ns
);
790 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
791 "Cannot convert clock cycles to nanoseconds from origin (`%s`).",
797 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
);
802 index
= ctf_fs_ds_file_build_index(ds_file
, ds_file_info
, msg_iter
);
804 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
805 self_comp
, self_comp_class
,
806 "Failed to index CTF stream file \'%s\'",
807 ds_file
->file
->path
->str
);
811 if (begin_ns
== -1) {
813 * No beginning timestamp to sort the stream files
814 * within a stream file group, so consider that this
815 * file must be the only one within its group.
817 stream_instance_id
= -1;
820 if (stream_instance_id
== -1) {
822 * No stream instance ID or no beginning timestamp:
823 * create a unique stream file group for this stream
824 * file because, even if there's a stream instance ID,
825 * there's no timestamp to order the file within its
828 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
,
829 sc
, UINT64_C(-1), index
);
830 /* Ownership of index is transferred. */
833 if (!ds_file_group
) {
837 ds_file_group_insert_ds_file_info_sorted(ds_file_group
,
838 BT_MOVE_REF(ds_file_info
));
844 BT_ASSERT(stream_instance_id
!= -1);
845 BT_ASSERT(begin_ns
!= -1);
847 /* Find an existing stream file group with this ID */
848 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
849 ds_file_group
= (struct ctf_fs_ds_file_group
*) g_ptr_array_index(
850 ctf_fs_trace
->ds_file_groups
, i
);
852 if (ds_file_group
->sc
== sc
&&
853 ds_file_group
->stream_id
==
854 stream_instance_id
) {
858 ds_file_group
= NULL
;
861 if (!ds_file_group
) {
862 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
,
863 sc
, stream_instance_id
, index
);
864 /* Ownership of index is transferred. */
866 if (!ds_file_group
) {
872 merge_ctf_fs_ds_indexes(ds_file_group
->index
, index
);
875 ds_file_group_insert_ds_file_info_sorted(ds_file_group
,
876 BT_MOVE_REF(ds_file_info
));
881 ctf_fs_ds_file_group_destroy(ds_file_group
);
882 ds_file_group
= NULL
;
886 if (add_group
&& ds_file_group
) {
887 g_ptr_array_add(ctf_fs_trace
->ds_file_groups
, ds_file_group
);
890 ctf_fs_ds_file_destroy(ds_file
);
891 ctf_fs_ds_file_info_destroy(ds_file_info
);
894 ctf_msg_iter_destroy(msg_iter
);
897 ctf_fs_ds_index_destroy(index
);
902 int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
905 const char *basename
;
906 GError
*error
= NULL
;
908 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
909 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
910 bt_self_component_class
*self_comp_class
= ctf_fs_trace
->self_comp_class
;
912 /* Check each file in the path directory, except specific ones */
913 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
915 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
916 "Cannot open directory `%s`: %s (code %d)",
917 ctf_fs_trace
->path
->str
, error
->message
,
922 while ((basename
= g_dir_read_name(dir
))) {
923 struct ctf_fs_file
*file
;
925 if (strcmp(basename
, CTF_FS_METADATA_FILENAME
) == 0) {
926 /* Ignore the metadata stream. */
927 BT_COMP_LOGI("Ignoring metadata file `%s" G_DIR_SEPARATOR_S
"%s`",
928 ctf_fs_trace
->path
->str
, basename
);
932 if (basename
[0] == '.') {
933 BT_COMP_LOGI("Ignoring hidden file `%s" G_DIR_SEPARATOR_S
"%s`",
934 ctf_fs_trace
->path
->str
, basename
);
938 /* Create the file. */
939 file
= ctf_fs_file_create(log_level
, self_comp
);
941 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
942 "Cannot create stream file object for file `%s" G_DIR_SEPARATOR_S
"%s`",
943 ctf_fs_trace
->path
->str
, basename
);
947 /* Create full path string. */
948 g_string_append_printf(file
->path
, "%s" G_DIR_SEPARATOR_S
"%s",
949 ctf_fs_trace
->path
->str
, basename
);
950 if (!g_file_test(file
->path
->str
, G_FILE_TEST_IS_REGULAR
)) {
951 BT_COMP_LOGI("Ignoring non-regular file `%s`",
953 ctf_fs_file_destroy(file
);
958 ret
= ctf_fs_file_open(file
, "rb");
960 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
961 "Cannot open stream file `%s`",
966 if (file
->size
== 0) {
967 /* Skip empty stream. */
968 BT_COMP_LOGI("Ignoring empty file `%s`", file
->path
->str
);
969 ctf_fs_file_destroy(file
);
973 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
,
976 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
977 "Cannot add stream file `%s` to stream file group",
979 ctf_fs_file_destroy(file
);
983 ctf_fs_file_destroy(file
);
1005 int set_trace_name(bt_trace
*trace
, const char *name_suffix
,
1006 bt_logging_level log_level
, bt_self_component
*self_comp
)
1009 const bt_value
*val
;
1012 name
= g_string_new(NULL
);
1014 BT_COMP_LOGE_STR("Failed to allocate a GString.");
1020 * Check if we have a trace environment string value named `hostname`.
1021 * If so, use it as the trace name's prefix.
1023 val
= bt_trace_borrow_environment_entry_value_by_name_const(
1025 if (val
&& bt_value_is_string(val
)) {
1026 g_string_append(name
, bt_value_string_get(val
));
1029 g_string_append_c(name
, G_DIR_SEPARATOR
);
1034 g_string_append(name
, name_suffix
);
1037 ret
= bt_trace_set_name(trace
, name
->str
);
1046 g_string_free(name
, TRUE
);
1053 struct ctf_fs_trace
*ctf_fs_trace_create(
1054 bt_self_component
*self_comp
,
1055 bt_self_component_class
*self_comp_class
,
1056 const char *path
, const char *name
,
1057 struct ctf_fs_metadata_config
*metadata_config
,
1058 bt_logging_level log_level
)
1060 struct ctf_fs_trace
*ctf_fs_trace
;
1063 /* Only one of them must be set. */
1064 BT_ASSERT(!self_comp
!= !self_comp_class
);
1066 ctf_fs_trace
= g_new0(struct ctf_fs_trace
, 1);
1067 if (!ctf_fs_trace
) {
1071 ctf_fs_trace
->log_level
= log_level
;
1072 ctf_fs_trace
->self_comp
= self_comp
;
1073 ctf_fs_trace
->self_comp_class
= self_comp_class
;
1074 ctf_fs_trace
->path
= g_string_new(path
);
1075 if (!ctf_fs_trace
->path
) {
1079 ctf_fs_trace
->metadata
= g_new0(struct ctf_fs_metadata
, 1);
1080 if (!ctf_fs_trace
->metadata
) {
1084 ctf_fs_metadata_init(ctf_fs_trace
->metadata
);
1085 ctf_fs_trace
->ds_file_groups
= g_ptr_array_new_with_free_func(
1086 (GDestroyNotify
) ctf_fs_ds_file_group_destroy
);
1087 if (!ctf_fs_trace
->ds_file_groups
) {
1091 ret
= ctf_fs_metadata_set_trace_class(self_comp
, ctf_fs_trace
,
1097 if (ctf_fs_trace
->metadata
->trace_class
) {
1098 ctf_fs_trace
->trace
=
1099 bt_trace_create(ctf_fs_trace
->metadata
->trace_class
);
1100 if (!ctf_fs_trace
->trace
) {
1105 if (ctf_fs_trace
->trace
) {
1106 ret
= ctf_trace_class_configure_ir_trace(
1107 ctf_fs_trace
->metadata
->tc
, ctf_fs_trace
->trace
);
1112 ret
= set_trace_name(ctf_fs_trace
->trace
, name
, log_level
,
1119 ret
= create_ds_file_groups(ctf_fs_trace
);
1127 ctf_fs_trace_destroy(ctf_fs_trace
);
1128 ctf_fs_trace
= NULL
;
1131 return ctf_fs_trace
;
1135 int path_is_ctf_trace(const char *path
)
1137 GString
*metadata_path
= g_string_new(NULL
);
1140 if (!metadata_path
) {
1145 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
1147 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
1153 g_string_free(metadata_path
, TRUE
);
1157 /* Helper for ctf_fs_component_create_ctf_fs_trace, to handle a single path. */
1160 int ctf_fs_component_create_ctf_fs_trace_one_path(
1161 struct ctf_fs_component
*ctf_fs
,
1162 const char *path_param
,
1163 const char *trace_name
,
1165 bt_self_component
*self_comp
,
1166 bt_self_component_class
*self_comp_class
)
1168 struct ctf_fs_trace
*ctf_fs_trace
;
1171 bt_logging_level log_level
= ctf_fs
->log_level
;
1173 norm_path
= bt_common_normalize_path(path_param
, NULL
);
1175 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1176 "Failed to normalize path: `%s`.",
1181 ret
= path_is_ctf_trace(norm_path
->str
);
1183 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1184 "Failed to check if path is a CTF trace: path=%s",
1187 } else if (ret
== 0) {
1188 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1189 "Path is not a CTF trace (does not contain a metadata file): `%s`.",
1194 // FIXME: Remove or ifdef for __MINGW32__
1195 if (strcmp(norm_path
->str
, "/") == 0) {
1196 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1197 "Opening a trace in `/` is not supported.");
1202 ctf_fs_trace
= ctf_fs_trace_create(self_comp
, self_comp_class
, norm_path
->str
,
1203 trace_name
, &ctf_fs
->metadata_config
, log_level
);
1204 if (!ctf_fs_trace
) {
1205 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1206 "Cannot create trace for `%s`.",
1211 g_ptr_array_add(traces
, ctf_fs_trace
);
1212 ctf_fs_trace
= NULL
;
1222 g_string_free(norm_path
, TRUE
);
1229 * Count the number of stream and event classes defined by this trace's metadata.
1231 * This is used to determine which metadata is the "latest", out of multiple
1232 * traces sharing the same UUID. It is assumed that amongst all these metadatas,
1233 * a bigger metadata is a superset of a smaller metadata. Therefore, it is
1234 * enough to just count the classes.
1238 unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace
*trace
)
1240 unsigned int num
= trace
->metadata
->tc
->stream_classes
->len
;
1243 for (i
= 0; i
< trace
->metadata
->tc
->stream_classes
->len
; i
++) {
1244 struct ctf_stream_class
*sc
=
1245 (struct ctf_stream_class
*) trace
->metadata
->tc
->stream_classes
->pdata
[i
];
1246 num
+= sc
->event_classes
->len
;
1253 * Merge the src ds_file_group into dest. This consists of merging their
1254 * ds_file_infos, making sure to keep the result sorted.
1258 void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group
*dest
, struct ctf_fs_ds_file_group
*src
)
1262 for (i
= 0; i
< src
->ds_file_infos
->len
; i
++) {
1263 struct ctf_fs_ds_file_info
*ds_file_info
=
1264 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(src
->ds_file_infos
, i
);
1266 /* Ownership of the ds_file_info is transferred to dest. */
1267 g_ptr_array_index(src
->ds_file_infos
, i
) = NULL
;
1269 ds_file_group_insert_ds_file_info_sorted(dest
, ds_file_info
);
1272 /* Merge both indexes. */
1273 merge_ctf_fs_ds_indexes(dest
->index
, src
->index
);
1275 /* Merge src_trace's data stream file groups into dest_trace's. */
1278 int merge_matching_ctf_fs_ds_file_groups(
1279 struct ctf_fs_trace
*dest_trace
,
1280 struct ctf_fs_trace
*src_trace
)
1283 GPtrArray
*dest
= dest_trace
->ds_file_groups
;
1284 GPtrArray
*src
= src_trace
->ds_file_groups
;
1289 * Save the initial length of dest: we only want to check against the
1290 * original elements in the inner loop.
1292 const guint dest_len
= dest
->len
;
1294 for (s_i
= 0; s_i
< src
->len
; s_i
++) {
1295 struct ctf_fs_ds_file_group
*src_group
=
1296 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(src
, s_i
);
1297 struct ctf_fs_ds_file_group
*dest_group
= NULL
;
1299 /* A stream instance without ID can't match a stream in the other trace. */
1300 if (src_group
->stream_id
!= -1) {
1303 /* Let's search for a matching ds_file_group in the destination. */
1304 for (d_i
= 0; d_i
< dest_len
; d_i
++) {
1305 struct ctf_fs_ds_file_group
*candidate_dest
=
1306 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(dest
, d_i
);
1308 /* Can't match a stream instance without ID. */
1309 if (candidate_dest
->stream_id
== -1) {
1314 * If the two groups have the same stream instance id
1315 * and belong to the same stream class (stream instance
1316 * ids are per-stream class), they represent the same
1319 if (candidate_dest
->stream_id
!= src_group
->stream_id
||
1320 candidate_dest
->sc
->id
!= src_group
->sc
->id
) {
1324 dest_group
= candidate_dest
;
1330 * Didn't find a friend in dest to merge our src_group into?
1331 * Create a new empty one. This can happen if a stream was
1332 * active in the source trace chunk but not in the destination
1336 struct ctf_stream_class
*sc
;
1337 struct ctf_fs_ds_index
*index
;
1339 sc
= ctf_trace_class_borrow_stream_class_by_id(
1340 dest_trace
->metadata
->tc
, src_group
->sc
->id
);
1343 index
= ctf_fs_ds_index_create(dest_trace
->log_level
,
1344 dest_trace
->self_comp
);
1350 dest_group
= ctf_fs_ds_file_group_create(dest_trace
, sc
,
1351 src_group
->stream_id
, index
);
1352 /* Ownership of index is transferred. */
1359 g_ptr_array_add(dest_trace
->ds_file_groups
, dest_group
);
1362 BT_ASSERT(dest_group
);
1363 merge_ctf_fs_ds_file_groups(dest_group
, src_group
);
1371 * Collapse the given traces, which must all share the same UUID, in a single
1374 * The trace with the most expansive metadata is chosen and all other traces
1375 * are merged into that one. The array slots of all the traces that get merged
1376 * in the chosen one are set to NULL, so only the slot of the chosen trace
1381 int merge_ctf_fs_traces(struct ctf_fs_trace
**traces
, unsigned int num_traces
,
1382 struct ctf_fs_trace
**out_trace
)
1384 unsigned int winner_count
;
1385 struct ctf_fs_trace
*winner
;
1389 BT_ASSERT(num_traces
>= 2);
1391 winner_count
= metadata_count_stream_and_event_classes(traces
[0]);
1395 /* Find the trace with the largest metadata. */
1396 for (i
= 1; i
< num_traces
; i
++) {
1397 struct ctf_fs_trace
*candidate
;
1398 unsigned int candidate_count
;
1400 candidate
= traces
[i
];
1402 /* A bit of sanity check. */
1403 BT_ASSERT(bt_uuid_compare(winner
->metadata
->tc
->uuid
, candidate
->metadata
->tc
->uuid
) == 0);
1405 candidate_count
= metadata_count_stream_and_event_classes(candidate
);
1407 if (candidate_count
> winner_count
) {
1408 winner_count
= candidate_count
;
1414 /* Merge all the other traces in the winning trace. */
1415 for (i
= 0; i
< num_traces
; i
++) {
1416 struct ctf_fs_trace
*trace
= traces
[i
];
1418 /* Don't merge the winner into itself. */
1419 if (trace
== winner
) {
1423 /* Merge trace's data stream file groups into winner's. */
1424 ret
= merge_matching_ctf_fs_ds_file_groups(winner
, trace
);
1431 * Move the winner out of the array, into `*out_trace`.
1433 *out_trace
= winner
;
1434 traces
[winner_i
] = NULL
;
1446 int decode_clock_snapshot_after_event(struct ctf_fs_trace
*ctf_fs_trace
,
1447 struct ctf_clock_class
*default_cc
,
1448 struct ctf_fs_ds_index_entry
*index_entry
,
1449 enum target_event target_event
, uint64_t *cs
, int64_t *ts_ns
)
1451 enum ctf_msg_iter_status iter_status
= CTF_MSG_ITER_STATUS_OK
;
1452 struct ctf_fs_ds_file
*ds_file
= NULL
;
1453 struct ctf_msg_iter
*msg_iter
= NULL
;
1454 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
1455 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
1458 BT_ASSERT(ctf_fs_trace
);
1459 BT_ASSERT(index_entry
);
1460 BT_ASSERT(index_entry
->path
);
1462 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
,
1463 NULL
, index_entry
->path
, log_level
);
1465 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Failed to create a ctf_fs_ds_file");
1470 BT_ASSERT(ctf_fs_trace
->metadata
);
1471 BT_ASSERT(ctf_fs_trace
->metadata
->tc
);
1473 msg_iter
= ctf_msg_iter_create(ctf_fs_trace
->metadata
->tc
,
1474 bt_common_get_page_size(log_level
) * 8, ctf_fs_ds_file_medops
,
1475 ds_file
, log_level
, self_comp
, NULL
);
1477 /* ctf_msg_iter_create() logs errors. */
1483 * Turn on dry run mode to prevent the creation and usage of Babeltrace
1484 * library objects (bt_field, bt_message_*, etc.).
1486 ctf_msg_iter_set_dry_run(msg_iter
, true);
1488 /* Seek to the beginning of the target packet. */
1489 iter_status
= ctf_msg_iter_seek(msg_iter
, index_entry
->offset
);
1491 /* ctf_msg_iter_seek() logs errors. */
1496 switch (target_event
) {
1499 * Start to decode the packet until we reach the end of
1500 * the first event. To extract the first event's clock
1503 iter_status
= ctf_msg_iter_curr_packet_first_event_clock_snapshot(
1507 /* Decode the packet to extract the last event's clock snapshot. */
1508 iter_status
= ctf_msg_iter_curr_packet_last_event_clock_snapshot(
1519 /* Convert clock snapshot to timestamp. */
1520 ret
= bt_util_clock_cycles_to_ns_from_origin(*cs
,
1521 default_cc
->frequency
, default_cc
->offset_seconds
,
1522 default_cc
->offset_cycles
, ts_ns
);
1524 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1525 "Failed to convert clock snapshot to timestamp");
1531 ctf_fs_ds_file_destroy(ds_file
);
1534 ctf_msg_iter_destroy(msg_iter
);
1541 int decode_packet_first_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1542 struct ctf_clock_class
*default_cc
,
1543 struct ctf_fs_ds_index_entry
*index_entry
, uint64_t *cs
, int64_t *ts_ns
)
1545 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
,
1546 index_entry
, FIRST_EVENT
, cs
, ts_ns
);
1550 int decode_packet_last_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1551 struct ctf_clock_class
*default_cc
,
1552 struct ctf_fs_ds_index_entry
*index_entry
, uint64_t *cs
, int64_t *ts_ns
)
1554 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
,
1555 index_entry
, LAST_EVENT
, cs
, ts_ns
);
1559 * Fix up packet index entries for lttng's "event-after-packet" bug.
1560 * Some buggy lttng tracer versions may emit events with a timestamp that is
1561 * larger (after) than the timestamp_end of the their packets.
1563 * To fix up this erroneous data we do the following:
1564 * 1. If it's not the stream file's last packet: set the packet index entry's
1565 * end time to the next packet's beginning time.
1566 * 2. If it's the stream file's last packet, set the packet index entry's end
1567 * time to the packet's last event's time, if any, or to the packet's
1568 * beginning time otherwise.
1570 * Known buggy tracer versions:
1571 * - before lttng-ust 2.11.0
1572 * - before lttng-module 2.11.0
1573 * - before lttng-module 2.10.10
1574 * - before lttng-module 2.9.13
1577 int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace
*trace
)
1580 guint ds_file_group_i
;
1581 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1582 bt_logging_level log_level
= trace
->log_level
;
1584 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
;
1585 ds_file_group_i
++) {
1587 struct ctf_clock_class
*default_cc
;
1588 struct ctf_fs_ds_index_entry
*last_entry
;
1589 struct ctf_fs_ds_index
*index
;
1591 struct ctf_fs_ds_file_group
*ds_file_group
=
1592 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1594 BT_ASSERT(ds_file_group
);
1595 index
= ds_file_group
->index
;
1598 BT_ASSERT(index
->entries
);
1599 BT_ASSERT(index
->entries
->len
> 0);
1602 * Iterate over all entries but the last one. The last one is
1603 * fixed differently after.
1605 for (entry_i
= 0; entry_i
< index
->entries
->len
- 1;
1607 struct ctf_fs_ds_index_entry
*curr_entry
, *next_entry
;
1609 curr_entry
= (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
);
1610 next_entry
= (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
+ 1);
1613 * 1. Set the current index entry `end` timestamp to
1614 * the next index entry `begin` timestamp.
1616 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1617 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1621 * 2. Fix the last entry by decoding the last event of the last
1624 last_entry
= (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
,
1625 index
->entries
->len
- 1);
1626 BT_ASSERT(last_entry
);
1628 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1629 default_cc
= ds_file_group
->sc
->default_clock_class
;
1632 * Decode packet to read the timestamp of the last event of the
1635 ret
= decode_packet_last_event_timestamp(trace
, default_cc
,
1636 last_entry
, &last_entry
->timestamp_end
,
1637 &last_entry
->timestamp_end_ns
);
1639 BT_COMP_LOGE_APPEND_CAUSE(trace
->self_comp
,
1640 "Failed to decode stream's last packet to get its last event's clock snapshot.");
1650 * Fix up packet index entries for barectf's "event-before-packet" bug.
1651 * Some buggy barectf tracer versions may emit events with a timestamp that is
1652 * less than the timestamp_begin of the their packets.
1654 * To fix up this erroneous data we do the following:
1655 * 1. Starting at the second index entry, set the timestamp_begin of the
1656 * current entry to the timestamp of the first event of the packet.
1657 * 2. Set the previous entry's timestamp_end to the timestamp_begin of the
1660 * Known buggy tracer versions:
1661 * - before barectf 2.3.1
1664 int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace
*trace
)
1667 guint ds_file_group_i
;
1668 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1669 bt_logging_level log_level
= trace
->log_level
;
1671 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
;
1672 ds_file_group_i
++) {
1674 struct ctf_clock_class
*default_cc
;
1675 ctf_fs_ds_file_group
*ds_file_group
=
1676 (ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1678 struct ctf_fs_ds_index
*index
= ds_file_group
->index
;
1681 BT_ASSERT(index
->entries
);
1682 BT_ASSERT(index
->entries
->len
> 0);
1684 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1685 default_cc
= ds_file_group
->sc
->default_clock_class
;
1688 * 1. Iterate over the index, starting from the second entry
1691 for (entry_i
= 1; entry_i
< index
->entries
->len
;
1693 ctf_fs_ds_index_entry
*prev_entry
=
1694 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
- 1);
1695 ctf_fs_ds_index_entry
*curr_entry
=
1696 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
);
1698 * 2. Set the current entry `begin` timestamp to the
1699 * timestamp of the first event of the current packet.
1701 ret
= decode_packet_first_event_timestamp(trace
, default_cc
,
1702 curr_entry
, &curr_entry
->timestamp_begin
,
1703 &curr_entry
->timestamp_begin_ns
);
1705 BT_COMP_LOGE_APPEND_CAUSE(trace
->self_comp
,
1706 "Failed to decode first event's clock snapshot");
1711 * 3. Set the previous entry `end` timestamp to the
1712 * timestamp of the first event of the current packet.
1714 prev_entry
->timestamp_end
= curr_entry
->timestamp_begin
;
1715 prev_entry
->timestamp_end_ns
= curr_entry
->timestamp_begin_ns
;
1723 * When using the lttng-crash feature it's likely that the last packets of each
1724 * stream have their timestamp_end set to zero. This is caused by the fact that
1725 * the tracer crashed and was not able to properly close the packets.
1727 * To fix up this erroneous data we do the following:
1728 * For each index entry, if the entry's timestamp_end is 0 and the
1729 * timestamp_begin is not 0:
1730 * - If it's the stream file's last packet: set the packet index entry's end
1731 * time to the packet's last event's time, if any, or to the packet's
1732 * beginning time otherwise.
1733 * - If it's not the stream file's last packet: set the packet index
1734 * entry's end time to the next packet's beginning time.
1736 * Affected versions:
1737 * - All current and future lttng-ust and lttng-modules versions.
1740 int fix_index_lttng_crash_quirk(struct ctf_fs_trace
*trace
)
1743 guint ds_file_group_idx
;
1744 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1745 bt_logging_level log_level
= trace
->log_level
;
1747 for (ds_file_group_idx
= 0; ds_file_group_idx
< ds_file_groups
->len
;
1748 ds_file_group_idx
++) {
1750 struct ctf_clock_class
*default_cc
;
1751 struct ctf_fs_ds_index
*index
;
1753 ctf_fs_ds_file_group
*ds_file_group
=
1754 (ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_idx
);
1756 BT_ASSERT(ds_file_group
);
1757 index
= ds_file_group
->index
;
1759 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1760 default_cc
= ds_file_group
->sc
->default_clock_class
;
1763 BT_ASSERT(index
->entries
);
1764 BT_ASSERT(index
->entries
->len
> 0);
1766 ctf_fs_ds_index_entry
*last_entry
=
1767 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
,
1768 index
->entries
->len
- 1);
1769 BT_ASSERT(last_entry
);
1772 /* 1. Fix the last entry first. */
1773 if (last_entry
->timestamp_end
== 0 &&
1774 last_entry
->timestamp_begin
!= 0) {
1776 * Decode packet to read the timestamp of the
1777 * last event of the stream file.
1779 ret
= decode_packet_last_event_timestamp(trace
,
1780 default_cc
, last_entry
,
1781 &last_entry
->timestamp_end
,
1782 &last_entry
->timestamp_end_ns
);
1784 BT_COMP_LOGE_APPEND_CAUSE(trace
->self_comp
,
1785 "Failed to decode last event's clock snapshot");
1790 /* Iterate over all entries but the last one. */
1791 for (entry_idx
= 0; entry_idx
< index
->entries
->len
- 1;
1793 ctf_fs_ds_index_entry
*curr_entry
=
1794 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_idx
);
1795 ctf_fs_ds_index_entry
*next_entry
=
1796 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_idx
+ 1);
1798 if (curr_entry
->timestamp_end
== 0 &&
1799 curr_entry
->timestamp_begin
!= 0) {
1801 * 2. Set the current index entry `end` timestamp to
1802 * the next index entry `begin` timestamp.
1804 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1805 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1815 * Extract the tracer information necessary to compare versions.
1816 * Returns 0 on success, and -1 if the extraction is not successful because the
1817 * necessary fields are absents in the trace metadata.
1820 int extract_tracer_info(struct ctf_fs_trace
*trace
,
1821 struct tracer_info
*current_tracer_info
)
1824 struct ctf_trace_class_env_entry
*entry
;
1826 /* Clear the current_tracer_info struct */
1827 memset(current_tracer_info
, 0, sizeof(*current_tracer_info
));
1830 * To compare 2 tracer versions, at least the tracer name and it's
1831 * major version are needed. If one of these is missing, consider it an
1832 * extraction failure.
1834 entry
= ctf_trace_class_borrow_env_entry_by_name(
1835 trace
->metadata
->tc
, "tracer_name");
1836 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR
) {
1837 goto missing_bare_minimum
;
1840 /* Set tracer name. */
1841 current_tracer_info
->name
= entry
->value
.str
->str
;
1843 entry
= ctf_trace_class_borrow_env_entry_by_name(
1844 trace
->metadata
->tc
, "tracer_major");
1845 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1846 goto missing_bare_minimum
;
1849 /* Set major version number. */
1850 current_tracer_info
->major
= entry
->value
.i
;
1852 entry
= ctf_trace_class_borrow_env_entry_by_name(
1853 trace
->metadata
->tc
, "tracer_minor");
1854 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1858 /* Set minor version number. */
1859 current_tracer_info
->minor
= entry
->value
.i
;
1861 entry
= ctf_trace_class_borrow_env_entry_by_name(
1862 trace
->metadata
->tc
, "tracer_patch");
1865 * If `tracer_patch` doesn't exist `tracer_patchlevel` might.
1866 * For example, `lttng-modules` uses entry name
1867 * `tracer_patchlevel`.
1869 entry
= ctf_trace_class_borrow_env_entry_by_name(
1870 trace
->metadata
->tc
, "tracer_patchlevel");
1873 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1877 /* Set patch version number. */
1878 current_tracer_info
->patch
= entry
->value
.i
;
1882 missing_bare_minimum
:
1889 bool is_tracer_affected_by_lttng_event_after_packet_bug(
1890 struct tracer_info
*curr_tracer_info
)
1892 bool is_affected
= false;
1894 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1895 if (curr_tracer_info
->major
< 2) {
1897 } else if (curr_tracer_info
->major
== 2) {
1898 /* fixed in lttng-ust 2.11.0 */
1899 if (curr_tracer_info
->minor
< 11) {
1903 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1904 if (curr_tracer_info
->major
< 2) {
1906 } else if (curr_tracer_info
->major
== 2) {
1907 /* fixed in lttng-modules 2.11.0 */
1908 if (curr_tracer_info
->minor
== 10) {
1909 /* fixed in lttng-modules 2.10.10 */
1910 if (curr_tracer_info
->patch
< 10) {
1913 } else if (curr_tracer_info
->minor
== 9) {
1914 /* fixed in lttng-modules 2.9.13 */
1915 if (curr_tracer_info
->patch
< 13) {
1918 } else if (curr_tracer_info
->minor
< 9) {
1928 bool is_tracer_affected_by_barectf_event_before_packet_bug(
1929 struct tracer_info
*curr_tracer_info
)
1931 bool is_affected
= false;
1933 if (strcmp(curr_tracer_info
->name
, "barectf") == 0) {
1934 if (curr_tracer_info
->major
< 2) {
1936 } else if (curr_tracer_info
->major
== 2) {
1937 if (curr_tracer_info
->minor
< 3) {
1939 } else if (curr_tracer_info
->minor
== 3) {
1940 /* fixed in barectf 2.3.1 */
1941 if (curr_tracer_info
->patch
< 1) {
1952 bool is_tracer_affected_by_lttng_crash_quirk(
1953 struct tracer_info
*curr_tracer_info
)
1955 bool is_affected
= false;
1957 /* All LTTng tracer may be affected by this lttng crash quirk. */
1958 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1960 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1968 * Looks for trace produced by known buggy tracers and fix up the index
1972 int fix_packet_index_tracer_bugs(struct ctf_fs_component
*ctf_fs
,
1973 bt_self_component
*self_comp
,
1974 bt_self_component_class
*self_comp_class
)
1977 struct tracer_info current_tracer_info
;
1978 bt_logging_level log_level
= ctf_fs
->log_level
;
1980 ret
= extract_tracer_info(ctf_fs
->trace
, ¤t_tracer_info
);
1983 * A trace may not have all the necessary environment
1984 * entries to do the tracer version comparison.
1985 * At least, the tracer name and major version number
1986 * are needed. Failing to extract these entries is not
1990 BT_LOGI_STR("Cannot extract tracer information necessary to compare with buggy versions.");
1994 /* Check if the trace may be affected by old tracer bugs. */
1995 if (is_tracer_affected_by_lttng_event_after_packet_bug(
1996 ¤t_tracer_info
)) {
1997 BT_LOGI_STR("Trace may be affected by LTTng tracer packet timestamp bug. Fixing up.");
1998 ret
= fix_index_lttng_event_after_packet_bug(ctf_fs
->trace
);
2000 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
2001 self_comp
, self_comp_class
,
2002 "Failed to fix LTTng event-after-packet bug.");
2005 ctf_fs
->trace
->metadata
->tc
->quirks
.lttng_event_after_packet
= true;
2008 if (is_tracer_affected_by_barectf_event_before_packet_bug(
2009 ¤t_tracer_info
)) {
2010 BT_LOGI_STR("Trace may be affected by barectf tracer packet timestamp bug. Fixing up.");
2011 ret
= fix_index_barectf_event_before_packet_bug(ctf_fs
->trace
);
2013 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
2014 self_comp
, self_comp_class
,
2015 "Failed to fix barectf event-before-packet bug.");
2018 ctf_fs
->trace
->metadata
->tc
->quirks
.barectf_event_before_packet
= true;
2021 if (is_tracer_affected_by_lttng_crash_quirk(
2022 ¤t_tracer_info
)) {
2023 ret
= fix_index_lttng_crash_quirk(ctf_fs
->trace
);
2025 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
2026 self_comp
, self_comp_class
,
2027 "Failed to fix lttng-crash timestamp quirks.");
2030 ctf_fs
->trace
->metadata
->tc
->quirks
.lttng_crash
= true;
2038 gint
compare_ds_file_groups_by_first_path(gconstpointer a
, gconstpointer b
)
2040 ctf_fs_ds_file_group
* const *ds_file_group_a
=
2041 (ctf_fs_ds_file_group
**) a
;
2042 ctf_fs_ds_file_group
* const *ds_file_group_b
=
2043 (ctf_fs_ds_file_group
**) b
;
2045 BT_ASSERT((*ds_file_group_a
)->ds_file_infos
->len
> 0);
2046 BT_ASSERT((*ds_file_group_b
)->ds_file_infos
->len
> 0);
2048 const ctf_fs_ds_file_info
*first_ds_file_info_a
=
2049 (const ctf_fs_ds_file_info
*) (*ds_file_group_a
)->ds_file_infos
->pdata
[0];
2050 const ctf_fs_ds_file_info
*first_ds_file_info_b
=
2051 (const ctf_fs_ds_file_info
*) (*ds_file_group_b
)->ds_file_infos
->pdata
[0];
2053 return strcmp(first_ds_file_info_a
->path
->str
,
2054 first_ds_file_info_b
->path
->str
);
2058 gint
compare_strings(gconstpointer p_a
, gconstpointer p_b
)
2060 const char *a
= *((const char **) p_a
);
2061 const char *b
= *((const char **) p_b
);
2063 return strcmp(a
, b
);
2066 int ctf_fs_component_create_ctf_fs_trace(
2067 struct ctf_fs_component
*ctf_fs
,
2068 const bt_value
*paths_value
,
2069 const bt_value
*trace_name_value
,
2070 bt_self_component
*self_comp
,
2071 bt_self_component_class
*self_comp_class
)
2075 bt_logging_level log_level
= ctf_fs
->log_level
;
2076 GPtrArray
*paths
= NULL
;
2078 const char *trace_name
;
2080 BT_ASSERT(bt_value_get_type(paths_value
) == BT_VALUE_TYPE_ARRAY
);
2081 BT_ASSERT(!bt_value_array_is_empty(paths_value
));
2083 traces
= g_ptr_array_new_with_free_func(ctf_fs_trace_destroy_notifier
);
2085 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2086 "Failed to allocate a GPtrArray.");
2090 paths
= g_ptr_array_new_with_free_func(g_free
);
2092 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2093 "Failed to allocate a GPtrArray.");
2097 trace_name
= trace_name_value
? bt_value_string_get(trace_name_value
) : NULL
;
2100 * Create a sorted array of the paths, to make the execution of this
2101 * component deterministic.
2103 for (i
= 0; i
< bt_value_array_get_length(paths_value
); i
++) {
2104 const bt_value
*path_value
=
2105 bt_value_array_borrow_element_by_index_const(paths_value
, i
);
2106 const char *input
= bt_value_string_get(path_value
);
2109 input_copy
= g_strdup(input
);
2111 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2112 "Failed to copy a string.");
2116 g_ptr_array_add(paths
, input_copy
);
2119 g_ptr_array_sort(paths
, compare_strings
);
2121 /* Create a separate ctf_fs_trace object for each path. */
2122 for (i
= 0; i
< paths
->len
; i
++) {
2123 const char *path
= (const char *) g_ptr_array_index(paths
, i
);
2125 ret
= ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs
,
2126 path
, trace_name
, traces
, self_comp
, self_comp_class
);
2132 if (traces
->len
> 1) {
2133 struct ctf_fs_trace
*first_trace
= (struct ctf_fs_trace
*) traces
->pdata
[0];
2134 const uint8_t *first_trace_uuid
= first_trace
->metadata
->tc
->uuid
;
2135 struct ctf_fs_trace
*trace
;
2138 * We have more than one trace, they must all share the same
2139 * UUID, verify that.
2141 for (i
= 0; i
< traces
->len
; i
++) {
2142 struct ctf_fs_trace
*this_trace
=
2143 (struct ctf_fs_trace
*) traces
->pdata
[i
];
2144 const uint8_t *this_trace_uuid
= this_trace
->metadata
->tc
->uuid
;
2146 if (!this_trace
->metadata
->tc
->is_uuid_set
) {
2147 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2148 "Multiple traces given, but a trace does not have a UUID: path=%s",
2149 this_trace
->path
->str
);
2153 if (bt_uuid_compare(first_trace_uuid
, this_trace_uuid
) != 0) {
2154 char first_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
2155 char this_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
2157 bt_uuid_to_str(first_trace_uuid
, first_trace_uuid_str
);
2158 bt_uuid_to_str(this_trace_uuid
, this_trace_uuid_str
);
2160 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2161 "Multiple traces given, but UUIDs don't match: "
2162 "first-trace-uuid=%s, first-trace-path=%s, "
2163 "trace-uuid=%s, trace-path=%s",
2164 first_trace_uuid_str
, first_trace
->path
->str
,
2165 this_trace_uuid_str
, this_trace
->path
->str
);
2170 ret
= merge_ctf_fs_traces((struct ctf_fs_trace
**) traces
->pdata
,
2171 traces
->len
, &trace
);
2173 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2174 "Failed to merge traces with the same UUID.");
2178 ctf_fs
->trace
= trace
;
2180 /* Just one trace, it may or may not have a UUID, both are fine. */
2181 ctf_fs
->trace
= (ctf_fs_trace
*) traces
->pdata
[0];
2182 traces
->pdata
[0] = NULL
;
2185 ret
= fix_packet_index_tracer_bugs(ctf_fs
, self_comp
, self_comp_class
);
2187 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2188 "Failed to fix packet index tracer bugs.");
2192 * Sort data stream file groups by first data stream file info
2193 * path to get a deterministic order. This order influences the
2194 * order of the output ports. It also influences the order of
2195 * the automatic stream IDs if the trace's packet headers do not
2196 * contain a `stream_instance_id` field, in which case the data
2197 * stream file to stream ID association is always the same,
2198 * whatever the build and the system.
2200 * Having a deterministic order here can help debugging and
2203 g_ptr_array_sort(ctf_fs
->trace
->ds_file_groups
,
2204 compare_ds_file_groups_by_first_path
);
2211 g_ptr_array_free(traces
, TRUE
);
2215 g_ptr_array_free(paths
, TRUE
);
2222 GString
*get_stream_instance_unique_name(
2223 struct ctf_fs_ds_file_group
*ds_file_group
)
2226 struct ctf_fs_ds_file_info
*ds_file_info
;
2228 name
= g_string_new(NULL
);
2234 * If there's more than one stream file in the stream file
2235 * group, the first (earliest) stream file's path is used as
2236 * the stream's unique name.
2238 BT_ASSERT(ds_file_group
->ds_file_infos
->len
> 0);
2239 ds_file_info
= (ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
2240 g_string_assign(name
, ds_file_info
->path
->str
);
2246 /* Create the IR stream objects for ctf_fs_trace. */
2249 int create_streams_for_trace(struct ctf_fs_trace
*ctf_fs_trace
)
2252 GString
*name
= NULL
;
2254 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
2255 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
2257 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
2258 ctf_fs_ds_file_group
*ds_file_group
=
2259 (ctf_fs_ds_file_group
*) g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
2260 name
= get_stream_instance_unique_name(ds_file_group
);
2266 if (ds_file_group
->sc
->ir_sc
) {
2267 BT_ASSERT(ctf_fs_trace
->trace
);
2269 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
2270 /* No stream ID: use 0 */
2271 ds_file_group
->stream
= bt_stream_create_with_id(
2272 ds_file_group
->sc
->ir_sc
,
2273 ctf_fs_trace
->trace
,
2274 ctf_fs_trace
->next_stream_id
);
2275 ctf_fs_trace
->next_stream_id
++;
2277 /* Specific stream ID */
2278 ds_file_group
->stream
= bt_stream_create_with_id(
2279 ds_file_group
->sc
->ir_sc
,
2280 ctf_fs_trace
->trace
,
2281 (uint64_t) ds_file_group
->stream_id
);
2284 ds_file_group
->stream
= NULL
;
2287 if (!ds_file_group
->stream
) {
2288 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2289 "Cannot create stream for DS file group: "
2290 "addr=%p, stream-name=\"%s\"",
2291 ds_file_group
, name
->str
);
2295 ret
= bt_stream_set_name(ds_file_group
->stream
,
2298 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Cannot set stream's name: "
2299 "addr=%p, stream-name=\"%s\"",
2300 ds_file_group
->stream
, name
->str
);
2304 g_string_free(name
, TRUE
);
2317 g_string_free(name
, TRUE
);
2322 static const bt_param_validation_value_descr inputs_elem_descr
{
2323 bt_param_validation_value_descr::string_t
2327 static bt_param_validation_map_value_entry_descr fs_params_entries_descr
[] = {
2328 {"inputs", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
2329 {bt_param_validation_value_descr::array_t
, 1,
2330 BT_PARAM_VALIDATION_INFINITE
, inputs_elem_descr
}},
2331 {"trace-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2332 {bt_param_validation_value_descr::string_t
}},
2333 { "clock-class-offset-s", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2334 { bt_param_validation_value_descr::signed_integer_t
}},
2335 { "clock-class-offset-ns", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2336 { bt_param_validation_value_descr::signed_integer_t
}},
2337 { "force-clock-class-origin-unix-epoch", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2338 { bt_param_validation_value_descr::bool_t
}},
2339 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
2343 bool read_src_fs_parameters(const bt_value
*params
,
2344 const bt_value
**inputs
,
2345 const bt_value
**trace_name
,
2346 struct ctf_fs_component
*ctf_fs
,
2347 bt_self_component
*self_comp
,
2348 bt_self_component_class
*self_comp_class
) {
2350 const bt_value
*value
;
2351 bt_logging_level log_level
= ctf_fs
->log_level
;
2352 enum bt_param_validation_status validate_value_status
;
2353 gchar
*error
= NULL
;
2355 validate_value_status
= bt_param_validation_validate(params
,
2356 fs_params_entries_descr
, &error
);
2357 if (validate_value_status
!= BT_PARAM_VALIDATION_STATUS_OK
) {
2358 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2364 /* inputs parameter */
2365 *inputs
= bt_value_map_borrow_entry_value_const(params
, "inputs");
2367 /* clock-class-offset-s parameter */
2368 value
= bt_value_map_borrow_entry_value_const(params
,
2369 "clock-class-offset-s");
2371 ctf_fs
->metadata_config
.clock_class_offset_s
=
2372 bt_value_integer_signed_get(value
);
2375 /* clock-class-offset-ns parameter */
2376 value
= bt_value_map_borrow_entry_value_const(params
,
2377 "clock-class-offset-ns");
2379 ctf_fs
->metadata_config
.clock_class_offset_ns
=
2380 bt_value_integer_signed_get(value
);
2383 /* force-clock-class-origin-unix-epoch parameter */
2384 value
= bt_value_map_borrow_entry_value_const(params
,
2385 "force-clock-class-origin-unix-epoch");
2387 ctf_fs
->metadata_config
.force_clock_class_origin_unix_epoch
=
2388 bt_value_bool_get(value
);
2391 /* trace-name parameter */
2392 *trace_name
= bt_value_map_borrow_entry_value_const(params
, "trace-name");
2402 struct ctf_fs_component
*ctf_fs_create(
2403 const bt_value
*params
,
2404 bt_self_component_source
*self_comp_src
)
2406 struct ctf_fs_component
*ctf_fs
= NULL
;
2407 const bt_value
*inputs_value
;
2408 const bt_value
*trace_name_value
;
2409 bt_self_component
*self_comp
=
2410 bt_self_component_source_as_self_component(self_comp_src
);
2412 ctf_fs
= ctf_fs_component_create(bt_component_get_logging_level(
2413 bt_self_component_as_component(self_comp
)), self_comp
);
2418 if (!read_src_fs_parameters(params
, &inputs_value
, &trace_name_value
,
2419 ctf_fs
, self_comp
, NULL
)) {
2423 bt_self_component_set_data(self_comp
, ctf_fs
);
2425 if (ctf_fs_component_create_ctf_fs_trace(ctf_fs
, inputs_value
,
2426 trace_name_value
, self_comp
, NULL
)) {
2430 if (create_streams_for_trace(ctf_fs
->trace
)) {
2434 if (create_ports_for_trace(ctf_fs
, ctf_fs
->trace
, self_comp_src
)) {
2441 ctf_fs_destroy(ctf_fs
);
2443 bt_self_component_set_data(self_comp
, NULL
);
2450 bt_component_class_initialize_method_status
ctf_fs_init(
2451 bt_self_component_source
*self_comp_src
,
2452 bt_self_component_source_configuration
*config
,
2453 const bt_value
*params
, __attribute__((unused
)) void *init_method_data
)
2455 struct ctf_fs_component
*ctf_fs
;
2456 bt_component_class_initialize_method_status ret
=
2457 BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
2459 ctf_fs
= ctf_fs_create(params
, self_comp_src
);
2461 ret
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
2468 bt_component_class_query_method_status
ctf_fs_query(
2469 bt_self_component_class_source
*comp_class
,
2470 bt_private_query_executor
*priv_query_exec
,
2471 const char *object
, const bt_value
*params
,
2472 __attribute__((unused
)) void *method_data
,
2473 const bt_value
**result
)
2475 bt_component_class_query_method_status status
=
2476 BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
2477 bt_logging_level log_level
= bt_query_executor_get_logging_level(
2478 bt_private_query_executor_as_query_executor_const(
2481 if (strcmp(object
, "metadata-info") == 0) {
2482 status
= metadata_info_query(comp_class
, params
, log_level
,
2484 } else if (strcmp(object
, "babeltrace.trace-infos") == 0) {
2485 status
= trace_infos_query(comp_class
, params
, log_level
,
2487 } else if (!strcmp(object
, "babeltrace.support-info")) {
2488 status
= support_info_query(comp_class
, params
, log_level
, result
);
2490 BT_LOGE("Unknown query object `%s`", object
);
2491 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;