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 void ctf_fs_msg_iter_data_destroy(
59 struct ctf_fs_msg_iter_data
*msg_iter_data
)
65 if (msg_iter_data
->msg_iter
) {
66 ctf_msg_iter_destroy(msg_iter_data
->msg_iter
);
69 if (msg_iter_data
->msg_iter_medops_data
) {
70 ctf_fs_ds_group_medops_data_destroy(
71 msg_iter_data
->msg_iter_medops_data
);
74 g_free(msg_iter_data
);
78 bt_component_class_message_iterator_next_method_status
ctf_fs_iterator_next_one(
79 struct ctf_fs_msg_iter_data
*msg_iter_data
,
80 const bt_message
**out_msg
)
82 bt_component_class_message_iterator_next_method_status status
;
83 enum ctf_msg_iter_status msg_iter_status
;
84 bt_logging_level log_level
= msg_iter_data
->log_level
;
86 msg_iter_status
= ctf_msg_iter_get_next_message(
87 msg_iter_data
->msg_iter
, out_msg
);
89 switch (msg_iter_status
) {
90 case CTF_MSG_ITER_STATUS_OK
:
91 /* Cool, message has been written to *out_msg. */
92 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
;
95 case CTF_MSG_ITER_STATUS_EOF
:
96 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_END
;
99 case CTF_MSG_ITER_STATUS_AGAIN
:
101 * Should not make it this far as this is
102 * medium-specific; there is nothing for the user to do
103 * and it should have been handled upstream.
107 case CTF_MSG_ITER_MEDIUM_STATUS_ERROR
:
108 BT_MSG_ITER_LOGE_APPEND_CAUSE(msg_iter_data
->self_msg_iter
,
109 "Failed to get next message from CTF message iterator.");
110 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR
;
113 case CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
:
114 BT_MSG_ITER_LOGE_APPEND_CAUSE(msg_iter_data
->self_msg_iter
,
115 "Failed to get next message from CTF message iterator.");
116 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_MEMORY_ERROR
;
127 bt_component_class_message_iterator_next_method_status
ctf_fs_iterator_next(
128 bt_self_message_iterator
*iterator
,
129 bt_message_array_const msgs
, uint64_t capacity
,
132 bt_component_class_message_iterator_next_method_status status
;
133 struct ctf_fs_msg_iter_data
*msg_iter_data
=
134 bt_self_message_iterator_get_data(iterator
);
137 if (G_UNLIKELY(msg_iter_data
->next_saved_error
)) {
139 * Last time we were called, we hit an error but had some
140 * messages to deliver, so we stashed the error here. Return
143 BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(msg_iter_data
->next_saved_error
);
144 status
= msg_iter_data
->next_saved_status
;
149 status
= ctf_fs_iterator_next_one(msg_iter_data
, &msgs
[i
]);
150 if (status
== BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
) {
153 } while (i
< capacity
&&
154 status
== BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
);
158 * Even if ctf_fs_iterator_next_one() returned something
159 * else than BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK, we
160 * accumulated message objects in the output
161 * message array, so we need to return
162 * BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK so that they are
163 * transfered to downstream. This other status occurs
164 * again the next time muxer_msg_iter_do_next() is
165 * called, possibly without any accumulated
166 * message, in which case we'll return it.
170 * Save this error for the next _next call. Assume that
171 * this component always appends error causes when
172 * returning an error status code, which will cause the
173 * current thread error to be non-NULL.
175 msg_iter_data
->next_saved_error
= bt_current_thread_take_error();
176 BT_ASSERT(msg_iter_data
->next_saved_error
);
177 msg_iter_data
->next_saved_status
= status
;
181 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
;
189 bt_component_class_message_iterator_seek_beginning_method_status
190 ctf_fs_iterator_seek_beginning(bt_self_message_iterator
*it
)
192 struct ctf_fs_msg_iter_data
*msg_iter_data
=
193 bt_self_message_iterator_get_data(it
);
195 BT_ASSERT(msg_iter_data
);
197 ctf_msg_iter_reset(msg_iter_data
->msg_iter
);
198 ctf_fs_ds_group_medops_data_reset(msg_iter_data
->msg_iter_medops_data
);
200 return BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_OK
;
204 void ctf_fs_iterator_finalize(bt_self_message_iterator
*it
)
206 ctf_fs_msg_iter_data_destroy(
207 bt_self_message_iterator_get_data(it
));
211 bt_component_class_message_iterator_initialize_method_status
ctf_fs_iterator_init(
212 bt_self_message_iterator
*self_msg_iter
,
213 bt_self_message_iterator_configuration
*config
,
214 bt_self_component_source
*self_comp_src
,
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_component_class_message_iterator_initialize_method_status status
;
220 bt_logging_level log_level
;
221 bt_self_component
*self_comp
=
222 bt_self_component_source_as_self_component(self_comp_src
);
223 enum ctf_msg_iter_medium_status medium_status
;
225 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_COMPONENT_CLASS_MESSAGE_ITERATOR_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
= (int) 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_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
268 /* FIXME: This is temporary, those functions will be removed. */
269 ctf_msg_iter_set_emit_stream_end_message(
270 msg_iter_data
->msg_iter
, true);
271 ctf_msg_iter_set_emit_stream_beginning_message(
272 msg_iter_data
->msg_iter
, true);
275 * This iterator can seek forward if its stream class has a default
278 if (msg_iter_data
->ds_file_group
->sc
->default_clock_class
) {
279 bt_self_message_iterator_configuration_set_can_seek_forward(
283 bt_self_message_iterator_set_data(self_msg_iter
,
285 msg_iter_data
= NULL
;
287 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_OK
;
291 bt_self_message_iterator_set_data(self_msg_iter
, NULL
);
294 ctf_fs_msg_iter_data_destroy(msg_iter_data
);
299 void ctf_fs_trace_destroy(struct ctf_fs_trace
*ctf_fs_trace
)
305 if (ctf_fs_trace
->ds_file_groups
) {
306 g_ptr_array_free(ctf_fs_trace
->ds_file_groups
, TRUE
);
309 BT_TRACE_PUT_REF_AND_RESET(ctf_fs_trace
->trace
);
311 if (ctf_fs_trace
->path
) {
312 g_string_free(ctf_fs_trace
->path
, TRUE
);
315 if (ctf_fs_trace
->metadata
) {
316 ctf_fs_metadata_fini(ctf_fs_trace
->metadata
);
317 g_free(ctf_fs_trace
->metadata
);
320 g_free(ctf_fs_trace
);
324 void ctf_fs_destroy(struct ctf_fs_component
*ctf_fs
)
330 ctf_fs_trace_destroy(ctf_fs
->trace
);
332 if (ctf_fs
->port_data
) {
333 g_ptr_array_free(ctf_fs
->port_data
, TRUE
);
340 void port_data_destroy(struct ctf_fs_port_data
*port_data
)
350 void port_data_destroy_notifier(void *data
) {
351 port_data_destroy(data
);
355 void ctf_fs_trace_destroy_notifier(void *data
)
357 struct ctf_fs_trace
*trace
= data
;
358 ctf_fs_trace_destroy(trace
);
361 struct ctf_fs_component
*ctf_fs_component_create(bt_logging_level log_level
,
362 bt_self_component
*self_comp
)
364 struct ctf_fs_component
*ctf_fs
;
366 ctf_fs
= g_new0(struct ctf_fs_component
, 1);
371 ctf_fs
->log_level
= log_level
;
373 g_ptr_array_new_with_free_func(port_data_destroy_notifier
);
374 if (!ctf_fs
->port_data
) {
381 ctf_fs_destroy(ctf_fs
);
388 void ctf_fs_finalize(bt_self_component_source
*component
)
390 ctf_fs_destroy(bt_self_component_get_data(
391 bt_self_component_source_as_self_component(component
)));
394 gchar
*ctf_fs_make_port_name(struct ctf_fs_ds_file_group
*ds_file_group
)
396 GString
*name
= g_string_new(NULL
);
399 * The unique port name is generated by concatenating unique identifiers
407 /* For the trace, use the uuid if present, else the path. */
408 if (ds_file_group
->ctf_fs_trace
->metadata
->tc
->is_uuid_set
) {
409 char uuid_str
[BT_UUID_STR_LEN
+ 1];
411 bt_uuid_to_str(ds_file_group
->ctf_fs_trace
->metadata
->tc
->uuid
, uuid_str
);
412 g_string_assign(name
, uuid_str
);
414 g_string_assign(name
, ds_file_group
->ctf_fs_trace
->path
->str
);
418 * For the stream class, use the id if present. We can omit this field
419 * otherwise, as there will only be a single stream class.
421 if (ds_file_group
->sc
->id
!= UINT64_C(-1)) {
422 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->sc
->id
);
425 /* For the stream, use the id if present, else, use the path. */
426 if (ds_file_group
->stream_id
!= UINT64_C(-1)) {
427 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->stream_id
);
429 BT_ASSERT(ds_file_group
->ds_file_infos
->len
== 1);
430 struct ctf_fs_ds_file_info
*ds_file_info
=
431 g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
432 g_string_append_printf(name
, " | %s", ds_file_info
->path
->str
);
435 return g_string_free(name
, FALSE
);
439 int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
440 struct ctf_fs_trace
*ctf_fs_trace
,
441 struct ctf_fs_ds_file_group
*ds_file_group
,
442 bt_self_component_source
*self_comp_src
)
445 struct ctf_fs_port_data
*port_data
= NULL
;
447 bt_logging_level log_level
= ctf_fs
->log_level
;
448 bt_self_component
*self_comp
=
449 bt_self_component_source_as_self_component(self_comp_src
);
451 port_name
= ctf_fs_make_port_name(ds_file_group
);
456 BT_COMP_LOGI("Creating one port named `%s`", port_name
);
458 /* Create output port for this file */
459 port_data
= g_new0(struct ctf_fs_port_data
, 1);
464 port_data
->ctf_fs
= ctf_fs
;
465 port_data
->ds_file_group
= ds_file_group
;
466 ret
= bt_self_component_source_add_output_port(
467 self_comp_src
, port_name
, port_data
, NULL
);
472 g_ptr_array_add(ctf_fs
->port_data
, port_data
);
482 port_data_destroy(port_data
);
487 int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
488 struct ctf_fs_trace
*ctf_fs_trace
,
489 bt_self_component_source
*self_comp_src
)
493 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
494 bt_self_component
*self_comp
=
495 bt_self_component_source_as_self_component(self_comp_src
);
497 /* Create one output port for each stream file group */
498 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
499 struct ctf_fs_ds_file_group
*ds_file_group
=
500 g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
502 ret
= create_one_port_for_trace(ctf_fs
, ctf_fs_trace
,
503 ds_file_group
, self_comp_src
);
505 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Cannot create output port.");
515 void ctf_fs_ds_file_info_destroy(struct ctf_fs_ds_file_info
*ds_file_info
)
521 if (ds_file_info
->path
) {
522 g_string_free(ds_file_info
->path
, TRUE
);
525 g_free(ds_file_info
);
529 struct ctf_fs_ds_file_info
*ctf_fs_ds_file_info_create(const char *path
,
532 struct ctf_fs_ds_file_info
*ds_file_info
;
534 ds_file_info
= g_new0(struct ctf_fs_ds_file_info
, 1);
539 ds_file_info
->path
= g_string_new(path
);
540 if (!ds_file_info
->path
) {
541 ctf_fs_ds_file_info_destroy(ds_file_info
);
546 ds_file_info
->begin_ns
= begin_ns
;
553 void ctf_fs_ds_file_group_destroy(struct ctf_fs_ds_file_group
*ds_file_group
)
555 if (!ds_file_group
) {
559 if (ds_file_group
->ds_file_infos
) {
560 g_ptr_array_free(ds_file_group
->ds_file_infos
, TRUE
);
563 if (ds_file_group
->index
) {
564 if (ds_file_group
->index
->entries
) {
565 g_ptr_array_free(ds_file_group
->index
->entries
, TRUE
);
567 g_free(ds_file_group
->index
);
570 bt_stream_put_ref(ds_file_group
->stream
);
571 g_free(ds_file_group
);
575 struct ctf_fs_ds_file_group
*ctf_fs_ds_file_group_create(
576 struct ctf_fs_trace
*ctf_fs_trace
,
577 struct ctf_stream_class
*sc
,
578 uint64_t stream_instance_id
,
579 struct ctf_fs_ds_index
*index
)
581 struct ctf_fs_ds_file_group
*ds_file_group
;
583 ds_file_group
= g_new0(struct ctf_fs_ds_file_group
, 1);
584 if (!ds_file_group
) {
588 ds_file_group
->ds_file_infos
= g_ptr_array_new_with_free_func(
589 (GDestroyNotify
) ctf_fs_ds_file_info_destroy
);
590 if (!ds_file_group
->ds_file_infos
) {
594 ds_file_group
->index
= index
;
596 ds_file_group
->stream_id
= stream_instance_id
;
598 ds_file_group
->sc
= sc
;
599 ds_file_group
->ctf_fs_trace
= ctf_fs_trace
;
603 ctf_fs_ds_file_group_destroy(ds_file_group
);
604 ctf_fs_ds_index_destroy(index
);
605 ds_file_group
= NULL
;
608 return ds_file_group
;
611 /* Replace by g_ptr_array_insert when we depend on glib >= 2.40. */
613 void array_insert(GPtrArray
*array
, gpointer element
, size_t pos
)
615 size_t original_array_len
= array
->len
;
617 /* Allocate an unused element at the end of the array. */
618 g_ptr_array_add(array
, NULL
);
620 /* If we are not inserting at the end, move the elements by one. */
621 if (pos
< original_array_len
) {
622 memmove(&(array
->pdata
[pos
+ 1]),
623 &(array
->pdata
[pos
]),
624 (original_array_len
- pos
) * sizeof(gpointer
));
627 /* Insert the value. */
628 array
->pdata
[pos
] = element
;
632 * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right
633 * place to keep it sorted.
637 void ds_file_group_insert_ds_file_info_sorted(
638 struct ctf_fs_ds_file_group
*ds_file_group
,
639 struct ctf_fs_ds_file_info
*ds_file_info
)
643 /* Find the spot where to insert this ds_file_info. */
644 for (i
= 0; i
< ds_file_group
->ds_file_infos
->len
; i
++) {
645 struct ctf_fs_ds_file_info
*other_ds_file_info
=
646 g_ptr_array_index(ds_file_group
->ds_file_infos
, i
);
648 if (ds_file_info
->begin_ns
< other_ds_file_info
->begin_ns
) {
653 array_insert(ds_file_group
->ds_file_infos
, ds_file_info
, i
);
657 bool ds_index_entries_equal(
658 const struct ctf_fs_ds_index_entry
*left
,
659 const struct ctf_fs_ds_index_entry
*right
)
661 if (left
->packet_size
!= right
->packet_size
) {
665 if (left
->timestamp_begin
!= right
->timestamp_begin
) {
669 if (left
->timestamp_end
!= right
->timestamp_end
) {
673 if (left
->packet_seq_num
!= right
->packet_seq_num
) {
681 * Insert `entry` into `index`, without duplication.
683 * The entry is inserted only if there isn't an identical entry already.
685 * In any case, the ownership of `entry` is transferred to this function. So if
686 * the entry is not inserted, it is freed.
690 void ds_index_insert_ds_index_entry_sorted(
691 struct ctf_fs_ds_index
*index
,
692 struct ctf_fs_ds_index_entry
*entry
)
695 struct ctf_fs_ds_index_entry
*other_entry
;
697 /* Find the spot where to insert this index entry. */
698 for (i
= 0; i
< index
->entries
->len
; i
++) {
699 other_entry
= g_ptr_array_index(index
->entries
, i
);
701 if (entry
->timestamp_begin_ns
<= other_entry
->timestamp_begin_ns
) {
707 * Insert the entry only if a duplicate doesn't already exist.
709 * There can be duplicate packets if reading multiple overlapping
710 * snapshots of the same trace. We then want the index to contain
711 * a reference to only one copy of that packet.
713 if (i
== index
->entries
->len
||
714 !ds_index_entries_equal(entry
, other_entry
)) {
715 array_insert(index
->entries
, entry
, i
);
722 void merge_ctf_fs_ds_indexes(struct ctf_fs_ds_index
*dest
, struct ctf_fs_ds_index
*src
)
726 for (i
= 0; i
< src
->entries
->len
; i
++) {
727 struct ctf_fs_ds_index_entry
*entry
=
728 g_ptr_array_index(src
->entries
, i
);
731 * Ownership of the ctf_fs_ds_index_entry is transferred to
732 * ds_index_insert_ds_index_entry_sorted.
734 g_ptr_array_index(src
->entries
, i
) = NULL
;
735 ds_index_insert_ds_index_entry_sorted(dest
, entry
);
740 int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
,
743 int64_t stream_instance_id
= -1;
744 int64_t begin_ns
= -1;
745 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
746 bool add_group
= false;
749 struct ctf_fs_ds_file
*ds_file
= NULL
;
750 struct ctf_fs_ds_file_info
*ds_file_info
= NULL
;
751 struct ctf_fs_ds_index
*index
= NULL
;
752 struct ctf_msg_iter
*msg_iter
= NULL
;
753 struct ctf_stream_class
*sc
= NULL
;
754 struct ctf_msg_iter_packet_properties props
;
755 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
756 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
757 bt_self_component_class
*self_comp_class
= ctf_fs_trace
->self_comp_class
;
760 * Create a temporary ds_file to read some properties about the data
763 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, NULL
, path
,
769 /* Create a temporary iterator to read the ds_file. */
770 msg_iter
= ctf_msg_iter_create(ctf_fs_trace
->metadata
->tc
,
771 bt_common_get_page_size(log_level
) * 8,
772 ctf_fs_ds_file_medops
, ds_file
, log_level
, self_comp
, NULL
);
774 BT_COMP_LOGE_STR("Cannot create a CTF message iterator.");
778 ret
= ctf_msg_iter_get_packet_properties(msg_iter
, &props
);
780 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
781 "Cannot get stream file's first packet's header and context fields (`%s`).",
786 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
,
787 props
.stream_class_id
);
789 stream_instance_id
= props
.data_stream_id
;
791 if (props
.snapshots
.beginning_clock
!= UINT64_C(-1)) {
792 BT_ASSERT(sc
->default_clock_class
);
793 ret
= bt_util_clock_cycles_to_ns_from_origin(
794 props
.snapshots
.beginning_clock
,
795 sc
->default_clock_class
->frequency
,
796 sc
->default_clock_class
->offset_seconds
,
797 sc
->default_clock_class
->offset_cycles
, &begin_ns
);
799 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
800 "Cannot convert clock cycles to nanoseconds from origin (`%s`).",
806 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
);
811 index
= ctf_fs_ds_file_build_index(ds_file
, ds_file_info
, msg_iter
);
813 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
814 self_comp
, self_comp_class
,
815 "Failed to index CTF stream file \'%s\'",
816 ds_file
->file
->path
->str
);
820 if (begin_ns
== -1) {
822 * No beggining timestamp to sort the stream files
823 * within a stream file group, so consider that this
824 * file must be the only one within its group.
826 stream_instance_id
= -1;
829 if (stream_instance_id
== -1) {
831 * No stream instance ID or no beginning timestamp:
832 * create a unique stream file group for this stream
833 * file because, even if there's a stream instance ID,
834 * there's no timestamp to order the file within its
837 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
,
838 sc
, UINT64_C(-1), index
);
839 /* Ownership of index is transferred. */
842 if (!ds_file_group
) {
846 ds_file_group_insert_ds_file_info_sorted(ds_file_group
,
847 BT_MOVE_REF(ds_file_info
));
853 BT_ASSERT(stream_instance_id
!= -1);
854 BT_ASSERT(begin_ns
!= -1);
856 /* Find an existing stream file group with this ID */
857 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
858 ds_file_group
= g_ptr_array_index(
859 ctf_fs_trace
->ds_file_groups
, i
);
861 if (ds_file_group
->sc
== sc
&&
862 ds_file_group
->stream_id
==
863 stream_instance_id
) {
867 ds_file_group
= NULL
;
870 if (!ds_file_group
) {
871 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
,
872 sc
, stream_instance_id
, index
);
873 /* Ownership of index is transferred. */
875 if (!ds_file_group
) {
881 merge_ctf_fs_ds_indexes(ds_file_group
->index
, index
);
884 ds_file_group_insert_ds_file_info_sorted(ds_file_group
,
885 BT_MOVE_REF(ds_file_info
));
890 ctf_fs_ds_file_group_destroy(ds_file_group
);
891 ds_file_group
= NULL
;
895 if (add_group
&& ds_file_group
) {
896 g_ptr_array_add(ctf_fs_trace
->ds_file_groups
, ds_file_group
);
899 ctf_fs_ds_file_destroy(ds_file
);
900 ctf_fs_ds_file_info_destroy(ds_file_info
);
903 ctf_msg_iter_destroy(msg_iter
);
906 ctf_fs_ds_index_destroy(index
);
911 int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
914 const char *basename
;
915 GError
*error
= NULL
;
917 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
918 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
919 bt_self_component_class
*self_comp_class
= ctf_fs_trace
->self_comp_class
;
921 /* Check each file in the path directory, except specific ones */
922 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
924 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
925 "Cannot open directory `%s`: %s (code %d)",
926 ctf_fs_trace
->path
->str
, error
->message
,
931 while ((basename
= g_dir_read_name(dir
))) {
932 struct ctf_fs_file
*file
;
934 if (strcmp(basename
, CTF_FS_METADATA_FILENAME
) == 0) {
935 /* Ignore the metadata stream. */
936 BT_COMP_LOGI("Ignoring metadata file `%s" G_DIR_SEPARATOR_S
"%s`",
937 ctf_fs_trace
->path
->str
, basename
);
941 if (basename
[0] == '.') {
942 BT_COMP_LOGI("Ignoring hidden file `%s" G_DIR_SEPARATOR_S
"%s`",
943 ctf_fs_trace
->path
->str
, basename
);
947 /* Create the file. */
948 file
= ctf_fs_file_create(log_level
, self_comp
);
950 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
951 "Cannot create stream file object for file `%s" G_DIR_SEPARATOR_S
"%s`",
952 ctf_fs_trace
->path
->str
, basename
);
956 /* Create full path string. */
957 g_string_append_printf(file
->path
, "%s" G_DIR_SEPARATOR_S
"%s",
958 ctf_fs_trace
->path
->str
, basename
);
959 if (!g_file_test(file
->path
->str
, G_FILE_TEST_IS_REGULAR
)) {
960 BT_COMP_LOGI("Ignoring non-regular file `%s`",
962 ctf_fs_file_destroy(file
);
967 ret
= ctf_fs_file_open(file
, "rb");
969 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
970 "Cannot open stream file `%s`",
975 if (file
->size
== 0) {
976 /* Skip empty stream. */
977 BT_COMP_LOGI("Ignoring empty file `%s`", file
->path
->str
);
978 ctf_fs_file_destroy(file
);
982 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
,
985 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
986 "Cannot add stream file `%s` to stream file group",
988 ctf_fs_file_destroy(file
);
992 ctf_fs_file_destroy(file
);
1007 g_error_free(error
);
1014 int set_trace_name(bt_trace
*trace
, const char *name_suffix
,
1015 bt_logging_level log_level
, bt_self_component
*self_comp
)
1018 const bt_value
*val
;
1021 name
= g_string_new(NULL
);
1023 BT_COMP_LOGE_STR("Failed to allocate a GString.");
1029 * Check if we have a trace environment string value named `hostname`.
1030 * If so, use it as the trace name's prefix.
1032 val
= bt_trace_borrow_environment_entry_value_by_name_const(
1034 if (val
&& bt_value_is_string(val
)) {
1035 g_string_append(name
, bt_value_string_get(val
));
1038 g_string_append_c(name
, G_DIR_SEPARATOR
);
1043 g_string_append(name
, name_suffix
);
1046 ret
= bt_trace_set_name(trace
, name
->str
);
1055 g_string_free(name
, TRUE
);
1062 struct ctf_fs_trace
*ctf_fs_trace_create(
1063 bt_self_component
*self_comp
,
1064 bt_self_component_class
*self_comp_class
,
1065 const char *path
, const char *name
,
1066 struct ctf_fs_metadata_config
*metadata_config
,
1067 bt_logging_level log_level
)
1069 struct ctf_fs_trace
*ctf_fs_trace
;
1072 /* Only one of them must be set. */
1073 BT_ASSERT(!self_comp
!= !self_comp_class
);
1075 ctf_fs_trace
= g_new0(struct ctf_fs_trace
, 1);
1076 if (!ctf_fs_trace
) {
1080 ctf_fs_trace
->log_level
= log_level
;
1081 ctf_fs_trace
->self_comp
= self_comp
;
1082 ctf_fs_trace
->self_comp_class
= self_comp_class
;
1083 ctf_fs_trace
->path
= g_string_new(path
);
1084 if (!ctf_fs_trace
->path
) {
1088 ctf_fs_trace
->metadata
= g_new0(struct ctf_fs_metadata
, 1);
1089 if (!ctf_fs_trace
->metadata
) {
1093 ctf_fs_metadata_init(ctf_fs_trace
->metadata
);
1094 ctf_fs_trace
->ds_file_groups
= g_ptr_array_new_with_free_func(
1095 (GDestroyNotify
) ctf_fs_ds_file_group_destroy
);
1096 if (!ctf_fs_trace
->ds_file_groups
) {
1100 ret
= ctf_fs_metadata_set_trace_class(self_comp
, ctf_fs_trace
,
1106 if (ctf_fs_trace
->metadata
->trace_class
) {
1107 ctf_fs_trace
->trace
=
1108 bt_trace_create(ctf_fs_trace
->metadata
->trace_class
);
1109 if (!ctf_fs_trace
->trace
) {
1114 if (ctf_fs_trace
->trace
) {
1115 ret
= ctf_trace_class_configure_ir_trace(
1116 ctf_fs_trace
->metadata
->tc
, ctf_fs_trace
->trace
);
1121 ret
= set_trace_name(ctf_fs_trace
->trace
, name
, log_level
,
1128 ret
= create_ds_file_groups(ctf_fs_trace
);
1136 ctf_fs_trace_destroy(ctf_fs_trace
);
1137 ctf_fs_trace
= NULL
;
1140 return ctf_fs_trace
;
1144 int path_is_ctf_trace(const char *path
)
1146 GString
*metadata_path
= g_string_new(NULL
);
1149 if (!metadata_path
) {
1154 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
1156 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
1162 g_string_free(metadata_path
, TRUE
);
1166 /* Helper for ctf_fs_component_create_ctf_fs_trace, to handle a single path. */
1169 int ctf_fs_component_create_ctf_fs_trace_one_path(
1170 struct ctf_fs_component
*ctf_fs
,
1171 const char *path_param
,
1172 const char *trace_name
,
1174 bt_self_component
*self_comp
,
1175 bt_self_component_class
*self_comp_class
)
1177 struct ctf_fs_trace
*ctf_fs_trace
;
1180 bt_logging_level log_level
= ctf_fs
->log_level
;
1182 norm_path
= bt_common_normalize_path(path_param
, NULL
);
1184 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1185 "Failed to normalize path: `%s`.",
1190 ret
= path_is_ctf_trace(norm_path
->str
);
1192 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1193 "Failed to check if path is a CTF trace: path=%s",
1196 } else if (ret
== 0) {
1197 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1198 "Path is not a CTF trace (does not contain a metadata file): `%s`.",
1203 // FIXME: Remove or ifdef for __MINGW32__
1204 if (strcmp(norm_path
->str
, "/") == 0) {
1205 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1206 "Opening a trace in `/` is not supported.");
1211 ctf_fs_trace
= ctf_fs_trace_create(self_comp
, self_comp_class
, norm_path
->str
,
1212 trace_name
, &ctf_fs
->metadata_config
, log_level
);
1213 if (!ctf_fs_trace
) {
1214 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1215 "Cannot create trace for `%s`.",
1220 g_ptr_array_add(traces
, ctf_fs_trace
);
1221 ctf_fs_trace
= NULL
;
1231 g_string_free(norm_path
, TRUE
);
1238 * Count the number of stream and event classes defined by this trace's metadata.
1240 * This is used to determine which metadata is the "latest", out of multiple
1241 * traces sharing the same UUID. It is assumed that amongst all these metadatas,
1242 * a bigger metadata is a superset of a smaller metadata. Therefore, it is
1243 * enough to just count the classes.
1247 unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace
*trace
)
1249 unsigned int num
= trace
->metadata
->tc
->stream_classes
->len
;
1252 for (i
= 0; i
< trace
->metadata
->tc
->stream_classes
->len
; i
++) {
1253 struct ctf_stream_class
*sc
= trace
->metadata
->tc
->stream_classes
->pdata
[i
];
1254 num
+= sc
->event_classes
->len
;
1261 * Merge the src ds_file_group into dest. This consists of merging their
1262 * ds_file_infos, making sure to keep the result sorted.
1266 void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group
*dest
, struct ctf_fs_ds_file_group
*src
)
1270 for (i
= 0; i
< src
->ds_file_infos
->len
; i
++) {
1271 struct ctf_fs_ds_file_info
*ds_file_info
=
1272 g_ptr_array_index(src
->ds_file_infos
, i
);
1274 /* Ownership of the ds_file_info is transferred to dest. */
1275 g_ptr_array_index(src
->ds_file_infos
, i
) = NULL
;
1277 ds_file_group_insert_ds_file_info_sorted(dest
, ds_file_info
);
1280 /* Merge both indexes. */
1281 merge_ctf_fs_ds_indexes(dest
->index
, src
->index
);
1283 /* Merge src_trace's data stream file groups into dest_trace's. */
1286 int merge_matching_ctf_fs_ds_file_groups(
1287 struct ctf_fs_trace
*dest_trace
,
1288 struct ctf_fs_trace
*src_trace
)
1291 GPtrArray
*dest
= dest_trace
->ds_file_groups
;
1292 GPtrArray
*src
= src_trace
->ds_file_groups
;
1297 * Save the initial length of dest: we only want to check against the
1298 * original elements in the inner loop.
1300 const guint dest_len
= dest
->len
;
1302 for (s_i
= 0; s_i
< src
->len
; s_i
++) {
1303 struct ctf_fs_ds_file_group
*src_group
= g_ptr_array_index(src
, s_i
);
1304 struct ctf_fs_ds_file_group
*dest_group
= NULL
;
1306 /* A stream instance without ID can't match a stream in the other trace. */
1307 if (src_group
->stream_id
!= -1) {
1310 /* Let's search for a matching ds_file_group in the destination. */
1311 for (d_i
= 0; d_i
< dest_len
; d_i
++) {
1312 struct ctf_fs_ds_file_group
*candidate_dest
= g_ptr_array_index(dest
, d_i
);
1314 /* Can't match a stream instance without ID. */
1315 if (candidate_dest
->stream_id
== -1) {
1320 * If the two groups have the same stream instance id
1321 * and belong to the same stream class (stream instance
1322 * ids are per-stream class), they represent the same
1325 if (candidate_dest
->stream_id
!= src_group
->stream_id
||
1326 candidate_dest
->sc
->id
!= src_group
->sc
->id
) {
1330 dest_group
= candidate_dest
;
1336 * Didn't find a friend in dest to merge our src_group into?
1337 * Create a new empty one. This can happen if a stream was
1338 * active in the source trace chunk but not in the destination
1342 struct ctf_stream_class
*sc
;
1343 struct ctf_fs_ds_index
*index
;
1345 sc
= ctf_trace_class_borrow_stream_class_by_id(
1346 dest_trace
->metadata
->tc
, src_group
->sc
->id
);
1349 index
= ctf_fs_ds_index_create(dest_trace
->log_level
,
1350 dest_trace
->self_comp
);
1356 dest_group
= ctf_fs_ds_file_group_create(dest_trace
, sc
,
1357 src_group
->stream_id
, index
);
1358 /* Ownership of index is transferred. */
1365 g_ptr_array_add(dest_trace
->ds_file_groups
, dest_group
);
1368 BT_ASSERT(dest_group
);
1369 merge_ctf_fs_ds_file_groups(dest_group
, src_group
);
1377 * Collapse the given traces, which must all share the same UUID, in a single
1380 * The trace with the most expansive metadata is chosen and all other traces
1381 * are merged into that one. The array slots of all the traces that get merged
1382 * in the chosen one are set to NULL, so only the slot of the chosen trace
1387 int merge_ctf_fs_traces(struct ctf_fs_trace
**traces
, unsigned int num_traces
,
1388 struct ctf_fs_trace
**out_trace
)
1390 unsigned int winner_count
;
1391 struct ctf_fs_trace
*winner
;
1395 BT_ASSERT(num_traces
>= 2);
1397 winner_count
= metadata_count_stream_and_event_classes(traces
[0]);
1401 /* Find the trace with the largest metadata. */
1402 for (i
= 1; i
< num_traces
; i
++) {
1403 struct ctf_fs_trace
*candidate
;
1404 unsigned int candidate_count
;
1406 candidate
= traces
[i
];
1408 /* A bit of sanity check. */
1409 BT_ASSERT(bt_uuid_compare(winner
->metadata
->tc
->uuid
, candidate
->metadata
->tc
->uuid
) == 0);
1411 candidate_count
= metadata_count_stream_and_event_classes(candidate
);
1413 if (candidate_count
> winner_count
) {
1414 winner_count
= candidate_count
;
1420 /* Merge all the other traces in the winning trace. */
1421 for (i
= 0; i
< num_traces
; i
++) {
1422 struct ctf_fs_trace
*trace
= traces
[i
];
1424 /* Don't merge the winner into itself. */
1425 if (trace
== winner
) {
1429 /* Merge trace's data stream file groups into winner's. */
1430 ret
= merge_matching_ctf_fs_ds_file_groups(winner
, trace
);
1437 * Move the winner out of the array, into `*out_trace`.
1439 *out_trace
= winner
;
1440 traces
[winner_i
] = NULL
;
1452 int decode_clock_snapshot_after_event(struct ctf_fs_trace
*ctf_fs_trace
,
1453 struct ctf_clock_class
*default_cc
,
1454 struct ctf_fs_ds_index_entry
*index_entry
,
1455 enum target_event target_event
, uint64_t *cs
, int64_t *ts_ns
)
1457 enum ctf_msg_iter_status iter_status
= CTF_MSG_ITER_STATUS_OK
;
1458 struct ctf_fs_ds_file
*ds_file
= NULL
;
1459 struct ctf_msg_iter
*msg_iter
= NULL
;
1460 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
1461 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
1464 BT_ASSERT(ctf_fs_trace
);
1465 BT_ASSERT(index_entry
);
1466 BT_ASSERT(index_entry
->path
);
1468 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
,
1469 NULL
, index_entry
->path
, log_level
);
1471 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Failed to create a ctf_fs_ds_file");
1476 BT_ASSERT(ctf_fs_trace
->metadata
);
1477 BT_ASSERT(ctf_fs_trace
->metadata
->tc
);
1479 msg_iter
= ctf_msg_iter_create(ctf_fs_trace
->metadata
->tc
,
1480 bt_common_get_page_size(log_level
) * 8, ctf_fs_ds_file_medops
,
1481 ds_file
, log_level
, self_comp
, NULL
);
1483 /* ctf_msg_iter_create() logs errors. */
1489 * Turn on dry run mode to prevent the creation and usage of Babeltrace
1490 * library objects (bt_field, bt_message_*, etc.).
1492 ctf_msg_iter_set_dry_run(msg_iter
, true);
1494 /* Seek to the beginning of the target packet. */
1495 iter_status
= ctf_msg_iter_seek(msg_iter
, index_entry
->offset
);
1497 /* ctf_msg_iter_seek() logs errors. */
1502 switch (target_event
) {
1505 * Start to decode the packet until we reach the end of
1506 * the first event. To extract the first event's clock
1509 iter_status
= ctf_msg_iter_curr_packet_first_event_clock_snapshot(
1513 /* Decode the packet to extract the last event's clock snapshot. */
1514 iter_status
= ctf_msg_iter_curr_packet_last_event_clock_snapshot(
1525 /* Convert clock snapshot to timestamp. */
1526 ret
= bt_util_clock_cycles_to_ns_from_origin(*cs
,
1527 default_cc
->frequency
, default_cc
->offset_seconds
,
1528 default_cc
->offset_cycles
, ts_ns
);
1530 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1531 "Failed to convert clock snapshot to timestamp");
1537 ctf_fs_ds_file_destroy(ds_file
);
1540 ctf_msg_iter_destroy(msg_iter
);
1547 int decode_packet_first_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1548 struct ctf_clock_class
*default_cc
,
1549 struct ctf_fs_ds_index_entry
*index_entry
, uint64_t *cs
, int64_t *ts_ns
)
1551 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
,
1552 index_entry
, FIRST_EVENT
, cs
, ts_ns
);
1556 int decode_packet_last_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1557 struct ctf_clock_class
*default_cc
,
1558 struct ctf_fs_ds_index_entry
*index_entry
, uint64_t *cs
, int64_t *ts_ns
)
1560 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
,
1561 index_entry
, LAST_EVENT
, cs
, ts_ns
);
1565 * Fix up packet index entries for lttng's "event-after-packet" bug.
1566 * Some buggy lttng tracer versions may emit events with a timestamp that is
1567 * larger (after) than the timestamp_end of the their packets.
1569 * To fix up this erroneous data we do the following:
1570 * 1. If it's not the stream file's last packet: set the packet index entry's
1571 * end time to the next packet's beginning time.
1572 * 2. If it's the stream file's last packet, set the packet index entry's end
1573 * time to the packet's last event's time, if any, or to the packet's
1574 * beginning time otherwise.
1576 * Known buggy tracer versions:
1577 * - before lttng-ust 2.11.0
1578 * - before lttng-module 2.11.0
1579 * - before lttng-module 2.10.10
1580 * - before lttng-module 2.9.13
1583 int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace
*trace
)
1586 guint ds_file_group_i
;
1587 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1588 bt_logging_level log_level
= trace
->log_level
;
1590 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
;
1591 ds_file_group_i
++) {
1593 struct ctf_clock_class
*default_cc
;
1594 struct ctf_fs_ds_index_entry
*last_entry
;
1595 struct ctf_fs_ds_index
*index
;
1597 struct ctf_fs_ds_file_group
*ds_file_group
=
1598 g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1600 BT_ASSERT(ds_file_group
);
1601 index
= ds_file_group
->index
;
1604 BT_ASSERT(index
->entries
);
1605 BT_ASSERT(index
->entries
->len
> 0);
1608 * Iterate over all entries but the last one. The last one is
1609 * fixed differently after.
1611 for (entry_i
= 0; entry_i
< index
->entries
->len
- 1;
1613 struct ctf_fs_ds_index_entry
*curr_entry
, *next_entry
;
1615 curr_entry
= g_ptr_array_index(index
->entries
, entry_i
);
1616 next_entry
= g_ptr_array_index(index
->entries
, entry_i
+ 1);
1619 * 1. Set the current index entry `end` timestamp to
1620 * the next index entry `begin` timestamp.
1622 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1623 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1627 * 2. Fix the last entry by decoding the last event of the last
1630 last_entry
= g_ptr_array_index(index
->entries
,
1631 index
->entries
->len
- 1);
1632 BT_ASSERT(last_entry
);
1634 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1635 default_cc
= ds_file_group
->sc
->default_clock_class
;
1638 * Decode packet to read the timestamp of the last event of the
1641 ret
= decode_packet_last_event_timestamp(trace
, default_cc
,
1642 last_entry
, &last_entry
->timestamp_end
,
1643 &last_entry
->timestamp_end_ns
);
1645 BT_COMP_LOGE_APPEND_CAUSE(trace
->self_comp
,
1646 "Failed to decode stream's last packet to get its last event's clock snapshot.");
1656 * Fix up packet index entries for barectf's "event-before-packet" bug.
1657 * Some buggy barectf tracer versions may emit events with a timestamp that is
1658 * less than the timestamp_begin of the their packets.
1660 * To fix up this erroneous data we do the following:
1661 * 1. Starting at the second index entry, set the timestamp_begin of the
1662 * current entry to the timestamp of the first event of the packet.
1663 * 2. Set the previous entry's timestamp_end to the timestamp_begin of the
1666 * Known buggy tracer versions:
1667 * - before barectf 2.3.1
1670 int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace
*trace
)
1673 guint ds_file_group_i
;
1674 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1675 bt_logging_level log_level
= trace
->log_level
;
1677 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
;
1678 ds_file_group_i
++) {
1680 struct ctf_clock_class
*default_cc
;
1681 struct ctf_fs_ds_file_group
*ds_file_group
=
1682 g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1684 struct ctf_fs_ds_index
*index
= ds_file_group
->index
;
1687 BT_ASSERT(index
->entries
);
1688 BT_ASSERT(index
->entries
->len
> 0);
1690 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1691 default_cc
= ds_file_group
->sc
->default_clock_class
;
1694 * 1. Iterate over the index, starting from the second entry
1697 for (entry_i
= 1; entry_i
< index
->entries
->len
;
1699 struct ctf_fs_ds_index_entry
*curr_entry
, *prev_entry
;
1700 prev_entry
= g_ptr_array_index(index
->entries
, entry_i
- 1);
1701 curr_entry
= g_ptr_array_index(index
->entries
, entry_i
);
1703 * 2. Set the current entry `begin` timestamp to the
1704 * timestamp of the first event of the current packet.
1706 ret
= decode_packet_first_event_timestamp(trace
, default_cc
,
1707 curr_entry
, &curr_entry
->timestamp_begin
,
1708 &curr_entry
->timestamp_begin_ns
);
1710 BT_COMP_LOGE_APPEND_CAUSE(trace
->self_comp
,
1711 "Failed to decode first event's clock snapshot");
1716 * 3. Set the previous entry `end` timestamp to the
1717 * timestamp of the first event of the current packet.
1719 prev_entry
->timestamp_end
= curr_entry
->timestamp_begin
;
1720 prev_entry
->timestamp_end_ns
= curr_entry
->timestamp_begin_ns
;
1728 * When using the lttng-crash feature it's likely that the last packets of each
1729 * stream have their timestamp_end set to zero. This is caused by the fact that
1730 * the tracer crashed and was not able to properly close the packets.
1732 * To fix up this erroneous data we do the following:
1733 * For each index entry, if the entry's timestamp_end is 0 and the
1734 * timestamp_begin is not 0:
1735 * - If it's the stream file's last packet: set the packet index entry's end
1736 * time to the packet's last event's time, if any, or to the packet's
1737 * beginning time otherwise.
1738 * - If it's not the stream file's last packet: set the packet index
1739 * entry's end time to the next packet's beginning time.
1741 * Affected versions:
1742 * - All current and future lttng-ust and lttng-modules versions.
1745 int fix_index_lttng_crash_quirk(struct ctf_fs_trace
*trace
)
1748 guint ds_file_group_idx
;
1749 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1750 bt_logging_level log_level
= trace
->log_level
;
1752 for (ds_file_group_idx
= 0; ds_file_group_idx
< ds_file_groups
->len
;
1753 ds_file_group_idx
++) {
1755 struct ctf_clock_class
*default_cc
;
1756 struct ctf_fs_ds_index_entry
*last_entry
;
1757 struct ctf_fs_ds_index
*index
;
1759 struct ctf_fs_ds_file_group
*ds_file_group
=
1760 g_ptr_array_index(ds_file_groups
, ds_file_group_idx
);
1762 BT_ASSERT(ds_file_group
);
1763 index
= ds_file_group
->index
;
1765 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1766 default_cc
= ds_file_group
->sc
->default_clock_class
;
1769 BT_ASSERT(index
->entries
);
1770 BT_ASSERT(index
->entries
->len
> 0);
1772 last_entry
= g_ptr_array_index(index
->entries
,
1773 index
->entries
->len
- 1);
1774 BT_ASSERT(last_entry
);
1777 /* 1. Fix the last entry first. */
1778 if (last_entry
->timestamp_end
== 0 &&
1779 last_entry
->timestamp_begin
!= 0) {
1781 * Decode packet to read the timestamp of the
1782 * last event of the stream file.
1784 ret
= decode_packet_last_event_timestamp(trace
,
1785 default_cc
, last_entry
,
1786 &last_entry
->timestamp_end
,
1787 &last_entry
->timestamp_end_ns
);
1789 BT_COMP_LOGE_APPEND_CAUSE(trace
->self_comp
,
1790 "Failed to decode last event's clock snapshot");
1795 /* Iterate over all entries but the last one. */
1796 for (entry_idx
= 0; entry_idx
< index
->entries
->len
- 1;
1798 struct ctf_fs_ds_index_entry
*curr_entry
, *next_entry
;
1799 curr_entry
= g_ptr_array_index(index
->entries
, entry_idx
);
1800 next_entry
= g_ptr_array_index(index
->entries
, entry_idx
+ 1);
1802 if (curr_entry
->timestamp_end
== 0 &&
1803 curr_entry
->timestamp_begin
!= 0) {
1805 * 2. Set the current index entry `end` timestamp to
1806 * the next index entry `begin` timestamp.
1808 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1809 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1819 * Extract the tracer information necessary to compare versions.
1820 * Returns 0 on success, and -1 if the extraction is not successful because the
1821 * necessary fields are absents in the trace metadata.
1824 int extract_tracer_info(struct ctf_fs_trace
*trace
,
1825 struct tracer_info
*current_tracer_info
)
1828 struct ctf_trace_class_env_entry
*entry
;
1830 /* Clear the current_tracer_info struct */
1831 memset(current_tracer_info
, 0, sizeof(*current_tracer_info
));
1834 * To compare 2 tracer versions, at least the tracer name and it's
1835 * major version are needed. If one of these is missing, consider it an
1836 * extraction failure.
1838 entry
= ctf_trace_class_borrow_env_entry_by_name(
1839 trace
->metadata
->tc
, "tracer_name");
1840 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR
) {
1841 goto missing_bare_minimum
;
1844 /* Set tracer name. */
1845 current_tracer_info
->name
= entry
->value
.str
->str
;
1847 entry
= ctf_trace_class_borrow_env_entry_by_name(
1848 trace
->metadata
->tc
, "tracer_major");
1849 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1850 goto missing_bare_minimum
;
1853 /* Set major version number. */
1854 current_tracer_info
->major
= entry
->value
.i
;
1856 entry
= ctf_trace_class_borrow_env_entry_by_name(
1857 trace
->metadata
->tc
, "tracer_minor");
1858 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1862 /* Set minor version number. */
1863 current_tracer_info
->minor
= entry
->value
.i
;
1865 entry
= ctf_trace_class_borrow_env_entry_by_name(
1866 trace
->metadata
->tc
, "tracer_patch");
1869 * If `tracer_patch` doesn't exist `tracer_patchlevel` might.
1870 * For example, `lttng-modules` uses entry name
1871 * `tracer_patchlevel`.
1873 entry
= ctf_trace_class_borrow_env_entry_by_name(
1874 trace
->metadata
->tc
, "tracer_patchlevel");
1877 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1881 /* Set patch version number. */
1882 current_tracer_info
->patch
= entry
->value
.i
;
1886 missing_bare_minimum
:
1893 bool is_tracer_affected_by_lttng_event_after_packet_bug(
1894 struct tracer_info
*curr_tracer_info
)
1896 bool is_affected
= false;
1898 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1899 if (curr_tracer_info
->major
< 2) {
1901 } else if (curr_tracer_info
->major
== 2) {
1902 /* fixed in lttng-ust 2.11.0 */
1903 if (curr_tracer_info
->minor
< 11) {
1907 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1908 if (curr_tracer_info
->major
< 2) {
1910 } else if (curr_tracer_info
->major
== 2) {
1911 /* fixed in lttng-modules 2.11.0 */
1912 if (curr_tracer_info
->minor
== 10) {
1913 /* fixed in lttng-modules 2.10.10 */
1914 if (curr_tracer_info
->patch
< 10) {
1917 } else if (curr_tracer_info
->minor
== 9) {
1918 /* fixed in lttng-modules 2.9.13 */
1919 if (curr_tracer_info
->patch
< 13) {
1922 } else if (curr_tracer_info
->minor
< 9) {
1932 bool is_tracer_affected_by_barectf_event_before_packet_bug(
1933 struct tracer_info
*curr_tracer_info
)
1935 bool is_affected
= false;
1937 if (strcmp(curr_tracer_info
->name
, "barectf") == 0) {
1938 if (curr_tracer_info
->major
< 2) {
1940 } else if (curr_tracer_info
->major
== 2) {
1941 if (curr_tracer_info
->minor
< 3) {
1943 } else if (curr_tracer_info
->minor
== 3) {
1944 /* fixed in barectf 2.3.1 */
1945 if (curr_tracer_info
->patch
< 1) {
1956 bool is_tracer_affected_by_lttng_crash_quirk(
1957 struct tracer_info
*curr_tracer_info
)
1959 bool is_affected
= false;
1961 /* All LTTng tracer may be affected by this lttng crash quirk. */
1962 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1964 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1972 * Looks for trace produced by known buggy tracers and fix up the index
1976 int fix_packet_index_tracer_bugs(struct ctf_fs_component
*ctf_fs
,
1977 bt_self_component
*self_comp
,
1978 bt_self_component_class
*self_comp_class
)
1981 struct tracer_info current_tracer_info
;
1982 bt_logging_level log_level
= ctf_fs
->log_level
;
1984 ret
= extract_tracer_info(ctf_fs
->trace
, ¤t_tracer_info
);
1987 * A trace may not have all the necessary environment
1988 * entries to do the tracer version comparison.
1989 * At least, the tracer name and major version number
1990 * are needed. Failing to extract these entries is not
1994 BT_LOGI_STR("Cannot extract tracer information necessary to compare with buggy versions.");
1998 /* Check if the trace may be affected by old tracer bugs. */
1999 if (is_tracer_affected_by_lttng_event_after_packet_bug(
2000 ¤t_tracer_info
)) {
2001 BT_LOGI_STR("Trace may be affected by LTTng tracer packet timestamp bug. Fixing up.");
2002 ret
= fix_index_lttng_event_after_packet_bug(ctf_fs
->trace
);
2004 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
2005 self_comp
, self_comp_class
,
2006 "Failed to fix LTTng event-after-packet bug.");
2009 ctf_fs
->trace
->metadata
->tc
->quirks
.lttng_event_after_packet
= true;
2012 if (is_tracer_affected_by_barectf_event_before_packet_bug(
2013 ¤t_tracer_info
)) {
2014 BT_LOGI_STR("Trace may be affected by barectf tracer packet timestamp bug. Fixing up.");
2015 ret
= fix_index_barectf_event_before_packet_bug(ctf_fs
->trace
);
2017 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
2018 self_comp
, self_comp_class
,
2019 "Failed to fix barectf event-before-packet bug.");
2022 ctf_fs
->trace
->metadata
->tc
->quirks
.barectf_event_before_packet
= true;
2025 if (is_tracer_affected_by_lttng_crash_quirk(
2026 ¤t_tracer_info
)) {
2027 ret
= fix_index_lttng_crash_quirk(ctf_fs
->trace
);
2029 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
2030 self_comp
, self_comp_class
,
2031 "Failed to fix lttng-crash timestamp quirks.");
2034 ctf_fs
->trace
->metadata
->tc
->quirks
.lttng_crash
= true;
2042 gint
compare_ds_file_groups_by_first_path(gconstpointer a
, gconstpointer b
)
2044 struct ctf_fs_ds_file_group
* const *ds_file_group_a
= a
;
2045 struct ctf_fs_ds_file_group
* const *ds_file_group_b
= b
;
2046 const struct ctf_fs_ds_file_info
*first_ds_file_info_a
;
2047 const struct ctf_fs_ds_file_info
*first_ds_file_info_b
;
2049 BT_ASSERT((*ds_file_group_a
)->ds_file_infos
->len
> 0);
2050 BT_ASSERT((*ds_file_group_b
)->ds_file_infos
->len
> 0);
2051 first_ds_file_info_a
= (*ds_file_group_a
)->ds_file_infos
->pdata
[0];
2052 first_ds_file_info_b
= (*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
);
2057 int ctf_fs_component_create_ctf_fs_trace(
2058 struct ctf_fs_component
*ctf_fs
,
2059 const bt_value
*paths_value
,
2060 const bt_value
*trace_name_value
,
2061 bt_self_component
*self_comp
,
2062 bt_self_component_class
*self_comp_class
)
2066 bt_logging_level log_level
= ctf_fs
->log_level
;
2068 const char *trace_name
;
2070 BT_ASSERT(bt_value_get_type(paths_value
) == BT_VALUE_TYPE_ARRAY
);
2071 BT_ASSERT(!bt_value_array_is_empty(paths_value
));
2073 traces
= g_ptr_array_new_with_free_func(ctf_fs_trace_destroy_notifier
);
2075 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2076 "Failed to allocate a GPtrArray.");
2080 trace_name
= trace_name_value
? bt_value_string_get(trace_name_value
) : NULL
;
2082 /* Start by creating a separate ctf_fs_trace object for each path. */
2083 for (i
= 0; i
< bt_value_array_get_length(paths_value
); i
++) {
2084 const bt_value
*path_value
= bt_value_array_borrow_element_by_index_const(paths_value
, i
);
2085 const char *input
= bt_value_string_get(path_value
);
2087 ret
= ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs
,
2088 input
, trace_name
, traces
, self_comp
, self_comp_class
);
2094 if (traces
->len
> 1) {
2095 struct ctf_fs_trace
*first_trace
= (struct ctf_fs_trace
*) traces
->pdata
[0];
2096 const uint8_t *first_trace_uuid
= first_trace
->metadata
->tc
->uuid
;
2097 struct ctf_fs_trace
*trace
;
2100 * We have more than one trace, they must all share the same
2101 * UUID, verify that.
2103 for (i
= 0; i
< traces
->len
; i
++) {
2104 struct ctf_fs_trace
*this_trace
=
2105 (struct ctf_fs_trace
*) traces
->pdata
[i
];
2106 const uint8_t *this_trace_uuid
= this_trace
->metadata
->tc
->uuid
;
2108 if (!this_trace
->metadata
->tc
->is_uuid_set
) {
2109 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2110 "Multiple traces given, but a trace does not have a UUID: path=%s",
2111 this_trace
->path
->str
);
2115 if (bt_uuid_compare(first_trace_uuid
, this_trace_uuid
) != 0) {
2116 char first_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
2117 char this_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
2119 bt_uuid_to_str(first_trace_uuid
, first_trace_uuid_str
);
2120 bt_uuid_to_str(this_trace_uuid
, this_trace_uuid_str
);
2122 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2123 "Multiple traces given, but UUIDs don't match: "
2124 "first-trace-uuid=%s, first-trace-path=%s, "
2125 "trace-uuid=%s, trace-path=%s",
2126 first_trace_uuid_str
, first_trace
->path
->str
,
2127 this_trace_uuid_str
, this_trace
->path
->str
);
2132 ret
= merge_ctf_fs_traces((struct ctf_fs_trace
**) traces
->pdata
,
2133 traces
->len
, &trace
);
2135 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2136 "Failed to merge traces with the same UUID.");
2140 ctf_fs
->trace
= trace
;
2142 /* Just one trace, it may or may not have a UUID, both are fine. */
2143 ctf_fs
->trace
= traces
->pdata
[0];
2144 traces
->pdata
[0] = NULL
;
2147 ret
= fix_packet_index_tracer_bugs(ctf_fs
, self_comp
, self_comp_class
);
2149 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2150 "Failed to fix packet index tracer bugs.");
2154 * Sort data stream file groups by first data stream file info
2155 * path to get a deterministic order. This order influences the
2156 * order of the output ports. It also influences the order of
2157 * the automatic stream IDs if the trace's packet headers do not
2158 * contain a `stream_instance_id` field, in which case the data
2159 * stream file to stream ID association is always the same,
2160 * whatever the build and the system.
2162 * Having a deterministic order here can help debugging and
2165 g_ptr_array_sort(ctf_fs
->trace
->ds_file_groups
,
2166 compare_ds_file_groups_by_first_path
);
2172 g_ptr_array_free(traces
, TRUE
);
2177 GString
*get_stream_instance_unique_name(
2178 struct ctf_fs_ds_file_group
*ds_file_group
)
2181 struct ctf_fs_ds_file_info
*ds_file_info
;
2183 name
= g_string_new(NULL
);
2189 * If there's more than one stream file in the stream file
2190 * group, the first (earliest) stream file's path is used as
2191 * the stream's unique name.
2193 BT_ASSERT(ds_file_group
->ds_file_infos
->len
> 0);
2194 ds_file_info
= g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
2195 g_string_assign(name
, ds_file_info
->path
->str
);
2201 /* Create the IR stream objects for ctf_fs_trace. */
2204 int create_streams_for_trace(struct ctf_fs_trace
*ctf_fs_trace
)
2207 GString
*name
= NULL
;
2209 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
2210 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
2212 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
2213 struct ctf_fs_ds_file_group
*ds_file_group
=
2214 g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
2215 name
= get_stream_instance_unique_name(ds_file_group
);
2221 if (ds_file_group
->sc
->ir_sc
) {
2222 BT_ASSERT(ctf_fs_trace
->trace
);
2224 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
2225 /* No stream ID: use 0 */
2226 ds_file_group
->stream
= bt_stream_create_with_id(
2227 ds_file_group
->sc
->ir_sc
,
2228 ctf_fs_trace
->trace
,
2229 ctf_fs_trace
->next_stream_id
);
2230 ctf_fs_trace
->next_stream_id
++;
2232 /* Specific stream ID */
2233 ds_file_group
->stream
= bt_stream_create_with_id(
2234 ds_file_group
->sc
->ir_sc
,
2235 ctf_fs_trace
->trace
,
2236 (uint64_t) ds_file_group
->stream_id
);
2239 ds_file_group
->stream
= NULL
;
2242 if (!ds_file_group
->stream
) {
2243 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2244 "Cannot create stream for DS file group: "
2245 "addr=%p, stream-name=\"%s\"",
2246 ds_file_group
, name
->str
);
2250 ret
= bt_stream_set_name(ds_file_group
->stream
,
2253 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Cannot set stream's name: "
2254 "addr=%p, stream-name=\"%s\"",
2255 ds_file_group
->stream
, name
->str
);
2259 g_string_free(name
, TRUE
);
2272 g_string_free(name
, TRUE
);
2277 static const struct bt_param_validation_value_descr inputs_elem_descr
= {
2278 .type
= BT_VALUE_TYPE_STRING
,
2281 static const struct bt_param_validation_map_value_entry_descr fs_params_entries_descr
[] = {
2282 { "inputs", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
, {
2283 BT_VALUE_TYPE_ARRAY
,
2286 .max_length
= BT_PARAM_VALIDATION_INFINITE
,
2287 .element_type
= &inputs_elem_descr
,
2290 { "trace-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_STRING
} },
2291 { "clock-class-offset-s", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_SIGNED_INTEGER
} },
2292 { "clock-class-offset-ns", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_SIGNED_INTEGER
} },
2293 { "force-clock-class-origin-unix-epoch", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_BOOL
} },
2294 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
2298 bool read_src_fs_parameters(const bt_value
*params
,
2299 const bt_value
**inputs
,
2300 const bt_value
**trace_name
,
2301 struct ctf_fs_component
*ctf_fs
,
2302 bt_self_component
*self_comp
,
2303 bt_self_component_class
*self_comp_class
) {
2305 const bt_value
*value
;
2306 bt_logging_level log_level
= ctf_fs
->log_level
;
2307 enum bt_param_validation_status validate_value_status
;
2308 gchar
*error
= NULL
;
2310 validate_value_status
= bt_param_validation_validate(params
,
2311 fs_params_entries_descr
, &error
);
2312 if (validate_value_status
!= BT_PARAM_VALIDATION_STATUS_OK
) {
2313 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2319 /* inputs parameter */
2320 *inputs
= bt_value_map_borrow_entry_value_const(params
, "inputs");
2322 /* clock-class-offset-s parameter */
2323 value
= bt_value_map_borrow_entry_value_const(params
,
2324 "clock-class-offset-s");
2326 ctf_fs
->metadata_config
.clock_class_offset_s
=
2327 bt_value_integer_signed_get(value
);
2330 /* clock-class-offset-ns parameter */
2331 value
= bt_value_map_borrow_entry_value_const(params
,
2332 "clock-class-offset-ns");
2334 ctf_fs
->metadata_config
.clock_class_offset_ns
=
2335 bt_value_integer_signed_get(value
);
2338 /* force-clock-class-origin-unix-epoch parameter */
2339 value
= bt_value_map_borrow_entry_value_const(params
,
2340 "force-clock-class-origin-unix-epoch");
2342 ctf_fs
->metadata_config
.force_clock_class_origin_unix_epoch
=
2343 bt_value_bool_get(value
);
2346 /* trace-name parameter */
2347 *trace_name
= bt_value_map_borrow_entry_value_const(params
, "trace-name");
2357 struct ctf_fs_component
*ctf_fs_create(
2358 const bt_value
*params
,
2359 bt_self_component_source
*self_comp_src
)
2361 struct ctf_fs_component
*ctf_fs
= NULL
;
2362 const bt_value
*inputs_value
;
2363 const bt_value
*trace_name_value
;
2364 bt_self_component
*self_comp
=
2365 bt_self_component_source_as_self_component(self_comp_src
);
2367 ctf_fs
= ctf_fs_component_create(bt_component_get_logging_level(
2368 bt_self_component_as_component(self_comp
)), self_comp
);
2373 if (!read_src_fs_parameters(params
, &inputs_value
, &trace_name_value
,
2374 ctf_fs
, self_comp
, NULL
)) {
2378 bt_self_component_set_data(self_comp
, ctf_fs
);
2380 if (ctf_fs_component_create_ctf_fs_trace(ctf_fs
, inputs_value
,
2381 trace_name_value
, self_comp
, NULL
)) {
2385 if (create_streams_for_trace(ctf_fs
->trace
)) {
2389 if (create_ports_for_trace(ctf_fs
, ctf_fs
->trace
, self_comp_src
)) {
2396 ctf_fs_destroy(ctf_fs
);
2398 bt_self_component_set_data(self_comp
, NULL
);
2405 bt_component_class_initialize_method_status
ctf_fs_init(
2406 bt_self_component_source
*self_comp_src
,
2407 bt_self_component_source_configuration
*config
,
2408 const bt_value
*params
, __attribute__((unused
)) void *init_method_data
)
2410 struct ctf_fs_component
*ctf_fs
;
2411 bt_component_class_initialize_method_status ret
=
2412 BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
2414 ctf_fs
= ctf_fs_create(params
, self_comp_src
);
2416 ret
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
2423 bt_component_class_query_method_status
ctf_fs_query(
2424 bt_self_component_class_source
*comp_class
,
2425 bt_private_query_executor
*priv_query_exec
,
2426 const char *object
, const bt_value
*params
,
2427 __attribute__((unused
)) void *method_data
,
2428 const bt_value
**result
)
2430 bt_component_class_query_method_status status
=
2431 BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
2432 bt_logging_level log_level
= bt_query_executor_get_logging_level(
2433 bt_private_query_executor_as_query_executor_const(
2436 if (strcmp(object
, "metadata-info") == 0) {
2437 status
= metadata_info_query(comp_class
, params
, log_level
,
2439 } else if (strcmp(object
, "babeltrace.trace-infos") == 0) {
2440 status
= trace_infos_query(comp_class
, params
, log_level
,
2442 } else if (!strcmp(object
, "babeltrace.support-info")) {
2443 status
= support_info_query(comp_class
, params
, log_level
, result
);
2445 BT_LOGE("Unknown query object `%s`", object
);
2446 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;