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 ctf_fs_ds_index_destroy(ds_file_group
->index
);
565 bt_stream_put_ref(ds_file_group
->stream
);
566 g_free(ds_file_group
);
570 struct ctf_fs_ds_file_group
*ctf_fs_ds_file_group_create(
571 struct ctf_fs_trace
*ctf_fs_trace
,
572 struct ctf_stream_class
*sc
,
573 uint64_t stream_instance_id
,
574 struct ctf_fs_ds_index
*index
)
576 struct ctf_fs_ds_file_group
*ds_file_group
;
578 ds_file_group
= g_new0(struct ctf_fs_ds_file_group
, 1);
579 if (!ds_file_group
) {
583 ds_file_group
->ds_file_infos
= g_ptr_array_new_with_free_func(
584 (GDestroyNotify
) ctf_fs_ds_file_info_destroy
);
585 if (!ds_file_group
->ds_file_infos
) {
589 ds_file_group
->index
= index
;
591 ds_file_group
->stream_id
= stream_instance_id
;
593 ds_file_group
->sc
= sc
;
594 ds_file_group
->ctf_fs_trace
= ctf_fs_trace
;
598 ctf_fs_ds_file_group_destroy(ds_file_group
);
599 ctf_fs_ds_index_destroy(index
);
600 ds_file_group
= NULL
;
603 return ds_file_group
;
606 /* Replace by g_ptr_array_insert when we depend on glib >= 2.40. */
608 void array_insert(GPtrArray
*array
, gpointer element
, size_t pos
)
610 size_t original_array_len
= array
->len
;
612 /* Allocate an unused element at the end of the array. */
613 g_ptr_array_add(array
, NULL
);
615 /* If we are not inserting at the end, move the elements by one. */
616 if (pos
< original_array_len
) {
617 memmove(&(array
->pdata
[pos
+ 1]),
618 &(array
->pdata
[pos
]),
619 (original_array_len
- pos
) * sizeof(gpointer
));
622 /* Insert the value. */
623 array
->pdata
[pos
] = element
;
627 * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right
628 * place to keep it sorted.
632 void ds_file_group_insert_ds_file_info_sorted(
633 struct ctf_fs_ds_file_group
*ds_file_group
,
634 struct ctf_fs_ds_file_info
*ds_file_info
)
638 /* Find the spot where to insert this ds_file_info. */
639 for (i
= 0; i
< ds_file_group
->ds_file_infos
->len
; i
++) {
640 struct ctf_fs_ds_file_info
*other_ds_file_info
=
641 g_ptr_array_index(ds_file_group
->ds_file_infos
, i
);
643 if (ds_file_info
->begin_ns
< other_ds_file_info
->begin_ns
) {
648 array_insert(ds_file_group
->ds_file_infos
, ds_file_info
, i
);
652 bool ds_index_entries_equal(
653 const struct ctf_fs_ds_index_entry
*left
,
654 const struct ctf_fs_ds_index_entry
*right
)
656 if (left
->packet_size
!= right
->packet_size
) {
660 if (left
->timestamp_begin
!= right
->timestamp_begin
) {
664 if (left
->timestamp_end
!= right
->timestamp_end
) {
668 if (left
->packet_seq_num
!= right
->packet_seq_num
) {
676 * Insert `entry` into `index`, without duplication.
678 * The entry is inserted only if there isn't an identical entry already.
680 * In any case, the ownership of `entry` is transferred to this function. So if
681 * the entry is not inserted, it is freed.
685 void ds_index_insert_ds_index_entry_sorted(
686 struct ctf_fs_ds_index
*index
,
687 struct ctf_fs_ds_index_entry
*entry
)
690 struct ctf_fs_ds_index_entry
*other_entry
;
692 /* Find the spot where to insert this index entry. */
693 for (i
= 0; i
< index
->entries
->len
; i
++) {
694 other_entry
= g_ptr_array_index(index
->entries
, i
);
696 if (entry
->timestamp_begin_ns
<= other_entry
->timestamp_begin_ns
) {
702 * Insert the entry only if a duplicate doesn't already exist.
704 * There can be duplicate packets if reading multiple overlapping
705 * snapshots of the same trace. We then want the index to contain
706 * a reference to only one copy of that packet.
708 if (i
== index
->entries
->len
||
709 !ds_index_entries_equal(entry
, other_entry
)) {
710 array_insert(index
->entries
, entry
, i
);
717 void merge_ctf_fs_ds_indexes(struct ctf_fs_ds_index
*dest
, struct ctf_fs_ds_index
*src
)
721 for (i
= 0; i
< src
->entries
->len
; i
++) {
722 struct ctf_fs_ds_index_entry
*entry
=
723 g_ptr_array_index(src
->entries
, i
);
726 * Ownership of the ctf_fs_ds_index_entry is transferred to
727 * ds_index_insert_ds_index_entry_sorted.
729 g_ptr_array_index(src
->entries
, i
) = NULL
;
730 ds_index_insert_ds_index_entry_sorted(dest
, entry
);
735 int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
,
738 int64_t stream_instance_id
= -1;
739 int64_t begin_ns
= -1;
740 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
741 bool add_group
= false;
744 struct ctf_fs_ds_file
*ds_file
= NULL
;
745 struct ctf_fs_ds_file_info
*ds_file_info
= NULL
;
746 struct ctf_fs_ds_index
*index
= NULL
;
747 struct ctf_msg_iter
*msg_iter
= NULL
;
748 struct ctf_stream_class
*sc
= NULL
;
749 struct ctf_msg_iter_packet_properties props
;
750 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
751 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
752 bt_self_component_class
*self_comp_class
= ctf_fs_trace
->self_comp_class
;
755 * Create a temporary ds_file to read some properties about the data
758 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, NULL
, path
,
764 /* Create a temporary iterator to read the ds_file. */
765 msg_iter
= ctf_msg_iter_create(ctf_fs_trace
->metadata
->tc
,
766 bt_common_get_page_size(log_level
) * 8,
767 ctf_fs_ds_file_medops
, ds_file
, log_level
, self_comp
, NULL
);
769 BT_COMP_LOGE_STR("Cannot create a CTF message iterator.");
773 ret
= ctf_msg_iter_get_packet_properties(msg_iter
, &props
);
775 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
776 "Cannot get stream file's first packet's header and context fields (`%s`).",
781 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
,
782 props
.stream_class_id
);
784 stream_instance_id
= props
.data_stream_id
;
786 if (props
.snapshots
.beginning_clock
!= UINT64_C(-1)) {
787 BT_ASSERT(sc
->default_clock_class
);
788 ret
= bt_util_clock_cycles_to_ns_from_origin(
789 props
.snapshots
.beginning_clock
,
790 sc
->default_clock_class
->frequency
,
791 sc
->default_clock_class
->offset_seconds
,
792 sc
->default_clock_class
->offset_cycles
, &begin_ns
);
794 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
795 "Cannot convert clock cycles to nanoseconds from origin (`%s`).",
801 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
);
806 index
= ctf_fs_ds_file_build_index(ds_file
, ds_file_info
, msg_iter
);
808 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
809 self_comp
, self_comp_class
,
810 "Failed to index CTF stream file \'%s\'",
811 ds_file
->file
->path
->str
);
815 if (begin_ns
== -1) {
817 * No beggining timestamp to sort the stream files
818 * within a stream file group, so consider that this
819 * file must be the only one within its group.
821 stream_instance_id
= -1;
824 if (stream_instance_id
== -1) {
826 * No stream instance ID or no beginning timestamp:
827 * create a unique stream file group for this stream
828 * file because, even if there's a stream instance ID,
829 * there's no timestamp to order the file within its
832 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
,
833 sc
, UINT64_C(-1), index
);
834 /* Ownership of index is transferred. */
837 if (!ds_file_group
) {
841 ds_file_group_insert_ds_file_info_sorted(ds_file_group
,
842 BT_MOVE_REF(ds_file_info
));
848 BT_ASSERT(stream_instance_id
!= -1);
849 BT_ASSERT(begin_ns
!= -1);
851 /* Find an existing stream file group with this ID */
852 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
853 ds_file_group
= g_ptr_array_index(
854 ctf_fs_trace
->ds_file_groups
, i
);
856 if (ds_file_group
->sc
== sc
&&
857 ds_file_group
->stream_id
==
858 stream_instance_id
) {
862 ds_file_group
= NULL
;
865 if (!ds_file_group
) {
866 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
,
867 sc
, stream_instance_id
, index
);
868 /* Ownership of index is transferred. */
870 if (!ds_file_group
) {
876 merge_ctf_fs_ds_indexes(ds_file_group
->index
, index
);
879 ds_file_group_insert_ds_file_info_sorted(ds_file_group
,
880 BT_MOVE_REF(ds_file_info
));
885 ctf_fs_ds_file_group_destroy(ds_file_group
);
886 ds_file_group
= NULL
;
890 if (add_group
&& ds_file_group
) {
891 g_ptr_array_add(ctf_fs_trace
->ds_file_groups
, ds_file_group
);
894 ctf_fs_ds_file_destroy(ds_file
);
895 ctf_fs_ds_file_info_destroy(ds_file_info
);
898 ctf_msg_iter_destroy(msg_iter
);
901 ctf_fs_ds_index_destroy(index
);
906 int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
909 const char *basename
;
910 GError
*error
= NULL
;
912 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
913 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
914 bt_self_component_class
*self_comp_class
= ctf_fs_trace
->self_comp_class
;
916 /* Check each file in the path directory, except specific ones */
917 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
919 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
920 "Cannot open directory `%s`: %s (code %d)",
921 ctf_fs_trace
->path
->str
, error
->message
,
926 while ((basename
= g_dir_read_name(dir
))) {
927 struct ctf_fs_file
*file
;
929 if (strcmp(basename
, CTF_FS_METADATA_FILENAME
) == 0) {
930 /* Ignore the metadata stream. */
931 BT_COMP_LOGI("Ignoring metadata file `%s" G_DIR_SEPARATOR_S
"%s`",
932 ctf_fs_trace
->path
->str
, basename
);
936 if (basename
[0] == '.') {
937 BT_COMP_LOGI("Ignoring hidden file `%s" G_DIR_SEPARATOR_S
"%s`",
938 ctf_fs_trace
->path
->str
, basename
);
942 /* Create the file. */
943 file
= ctf_fs_file_create(log_level
, self_comp
);
945 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
946 "Cannot create stream file object for file `%s" G_DIR_SEPARATOR_S
"%s`",
947 ctf_fs_trace
->path
->str
, basename
);
951 /* Create full path string. */
952 g_string_append_printf(file
->path
, "%s" G_DIR_SEPARATOR_S
"%s",
953 ctf_fs_trace
->path
->str
, basename
);
954 if (!g_file_test(file
->path
->str
, G_FILE_TEST_IS_REGULAR
)) {
955 BT_COMP_LOGI("Ignoring non-regular file `%s`",
957 ctf_fs_file_destroy(file
);
962 ret
= ctf_fs_file_open(file
, "rb");
964 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
965 "Cannot open stream file `%s`",
970 if (file
->size
== 0) {
971 /* Skip empty stream. */
972 BT_COMP_LOGI("Ignoring empty file `%s`", file
->path
->str
);
973 ctf_fs_file_destroy(file
);
977 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
,
980 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
981 "Cannot add stream file `%s` to stream file group",
983 ctf_fs_file_destroy(file
);
987 ctf_fs_file_destroy(file
);
1002 g_error_free(error
);
1009 int set_trace_name(bt_trace
*trace
, const char *name_suffix
,
1010 bt_logging_level log_level
, bt_self_component
*self_comp
)
1013 const bt_value
*val
;
1016 name
= g_string_new(NULL
);
1018 BT_COMP_LOGE_STR("Failed to allocate a GString.");
1024 * Check if we have a trace environment string value named `hostname`.
1025 * If so, use it as the trace name's prefix.
1027 val
= bt_trace_borrow_environment_entry_value_by_name_const(
1029 if (val
&& bt_value_is_string(val
)) {
1030 g_string_append(name
, bt_value_string_get(val
));
1033 g_string_append_c(name
, G_DIR_SEPARATOR
);
1038 g_string_append(name
, name_suffix
);
1041 ret
= bt_trace_set_name(trace
, name
->str
);
1050 g_string_free(name
, TRUE
);
1057 struct ctf_fs_trace
*ctf_fs_trace_create(
1058 bt_self_component
*self_comp
,
1059 bt_self_component_class
*self_comp_class
,
1060 const char *path
, const char *name
,
1061 struct ctf_fs_metadata_config
*metadata_config
,
1062 bt_logging_level log_level
)
1064 struct ctf_fs_trace
*ctf_fs_trace
;
1067 /* Only one of them must be set. */
1068 BT_ASSERT(!self_comp
!= !self_comp_class
);
1070 ctf_fs_trace
= g_new0(struct ctf_fs_trace
, 1);
1071 if (!ctf_fs_trace
) {
1075 ctf_fs_trace
->log_level
= log_level
;
1076 ctf_fs_trace
->self_comp
= self_comp
;
1077 ctf_fs_trace
->self_comp_class
= self_comp_class
;
1078 ctf_fs_trace
->path
= g_string_new(path
);
1079 if (!ctf_fs_trace
->path
) {
1083 ctf_fs_trace
->metadata
= g_new0(struct ctf_fs_metadata
, 1);
1084 if (!ctf_fs_trace
->metadata
) {
1088 ctf_fs_metadata_init(ctf_fs_trace
->metadata
);
1089 ctf_fs_trace
->ds_file_groups
= g_ptr_array_new_with_free_func(
1090 (GDestroyNotify
) ctf_fs_ds_file_group_destroy
);
1091 if (!ctf_fs_trace
->ds_file_groups
) {
1095 ret
= ctf_fs_metadata_set_trace_class(self_comp
, ctf_fs_trace
,
1101 if (ctf_fs_trace
->metadata
->trace_class
) {
1102 ctf_fs_trace
->trace
=
1103 bt_trace_create(ctf_fs_trace
->metadata
->trace_class
);
1104 if (!ctf_fs_trace
->trace
) {
1109 if (ctf_fs_trace
->trace
) {
1110 ret
= ctf_trace_class_configure_ir_trace(
1111 ctf_fs_trace
->metadata
->tc
, ctf_fs_trace
->trace
);
1116 ret
= set_trace_name(ctf_fs_trace
->trace
, name
, log_level
,
1123 ret
= create_ds_file_groups(ctf_fs_trace
);
1131 ctf_fs_trace_destroy(ctf_fs_trace
);
1132 ctf_fs_trace
= NULL
;
1135 return ctf_fs_trace
;
1139 int path_is_ctf_trace(const char *path
)
1141 GString
*metadata_path
= g_string_new(NULL
);
1144 if (!metadata_path
) {
1149 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
1151 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
1157 g_string_free(metadata_path
, TRUE
);
1161 /* Helper for ctf_fs_component_create_ctf_fs_trace, to handle a single path. */
1164 int ctf_fs_component_create_ctf_fs_trace_one_path(
1165 struct ctf_fs_component
*ctf_fs
,
1166 const char *path_param
,
1167 const char *trace_name
,
1169 bt_self_component
*self_comp
,
1170 bt_self_component_class
*self_comp_class
)
1172 struct ctf_fs_trace
*ctf_fs_trace
;
1175 bt_logging_level log_level
= ctf_fs
->log_level
;
1177 norm_path
= bt_common_normalize_path(path_param
, NULL
);
1179 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1180 "Failed to normalize path: `%s`.",
1185 ret
= path_is_ctf_trace(norm_path
->str
);
1187 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1188 "Failed to check if path is a CTF trace: path=%s",
1191 } else if (ret
== 0) {
1192 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1193 "Path is not a CTF trace (does not contain a metadata file): `%s`.",
1198 // FIXME: Remove or ifdef for __MINGW32__
1199 if (strcmp(norm_path
->str
, "/") == 0) {
1200 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1201 "Opening a trace in `/` is not supported.");
1206 ctf_fs_trace
= ctf_fs_trace_create(self_comp
, self_comp_class
, norm_path
->str
,
1207 trace_name
, &ctf_fs
->metadata_config
, log_level
);
1208 if (!ctf_fs_trace
) {
1209 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1210 "Cannot create trace for `%s`.",
1215 g_ptr_array_add(traces
, ctf_fs_trace
);
1216 ctf_fs_trace
= NULL
;
1226 g_string_free(norm_path
, TRUE
);
1233 * Count the number of stream and event classes defined by this trace's metadata.
1235 * This is used to determine which metadata is the "latest", out of multiple
1236 * traces sharing the same UUID. It is assumed that amongst all these metadatas,
1237 * a bigger metadata is a superset of a smaller metadata. Therefore, it is
1238 * enough to just count the classes.
1242 unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace
*trace
)
1244 unsigned int num
= trace
->metadata
->tc
->stream_classes
->len
;
1247 for (i
= 0; i
< trace
->metadata
->tc
->stream_classes
->len
; i
++) {
1248 struct ctf_stream_class
*sc
= trace
->metadata
->tc
->stream_classes
->pdata
[i
];
1249 num
+= sc
->event_classes
->len
;
1256 * Merge the src ds_file_group into dest. This consists of merging their
1257 * ds_file_infos, making sure to keep the result sorted.
1261 void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group
*dest
, struct ctf_fs_ds_file_group
*src
)
1265 for (i
= 0; i
< src
->ds_file_infos
->len
; i
++) {
1266 struct ctf_fs_ds_file_info
*ds_file_info
=
1267 g_ptr_array_index(src
->ds_file_infos
, i
);
1269 /* Ownership of the ds_file_info is transferred to dest. */
1270 g_ptr_array_index(src
->ds_file_infos
, i
) = NULL
;
1272 ds_file_group_insert_ds_file_info_sorted(dest
, ds_file_info
);
1275 /* Merge both indexes. */
1276 merge_ctf_fs_ds_indexes(dest
->index
, src
->index
);
1278 /* Merge src_trace's data stream file groups into dest_trace's. */
1281 int merge_matching_ctf_fs_ds_file_groups(
1282 struct ctf_fs_trace
*dest_trace
,
1283 struct ctf_fs_trace
*src_trace
)
1286 GPtrArray
*dest
= dest_trace
->ds_file_groups
;
1287 GPtrArray
*src
= src_trace
->ds_file_groups
;
1292 * Save the initial length of dest: we only want to check against the
1293 * original elements in the inner loop.
1295 const guint dest_len
= dest
->len
;
1297 for (s_i
= 0; s_i
< src
->len
; s_i
++) {
1298 struct ctf_fs_ds_file_group
*src_group
= g_ptr_array_index(src
, s_i
);
1299 struct ctf_fs_ds_file_group
*dest_group
= NULL
;
1301 /* A stream instance without ID can't match a stream in the other trace. */
1302 if (src_group
->stream_id
!= -1) {
1305 /* Let's search for a matching ds_file_group in the destination. */
1306 for (d_i
= 0; d_i
< dest_len
; d_i
++) {
1307 struct ctf_fs_ds_file_group
*candidate_dest
= g_ptr_array_index(dest
, d_i
);
1309 /* Can't match a stream instance without ID. */
1310 if (candidate_dest
->stream_id
== -1) {
1315 * If the two groups have the same stream instance id
1316 * and belong to the same stream class (stream instance
1317 * ids are per-stream class), they represent the same
1320 if (candidate_dest
->stream_id
!= src_group
->stream_id
||
1321 candidate_dest
->sc
->id
!= src_group
->sc
->id
) {
1325 dest_group
= candidate_dest
;
1331 * Didn't find a friend in dest to merge our src_group into?
1332 * Create a new empty one. This can happen if a stream was
1333 * active in the source trace chunk but not in the destination
1337 struct ctf_stream_class
*sc
;
1338 struct ctf_fs_ds_index
*index
;
1340 sc
= ctf_trace_class_borrow_stream_class_by_id(
1341 dest_trace
->metadata
->tc
, src_group
->sc
->id
);
1344 index
= ctf_fs_ds_index_create(dest_trace
->log_level
,
1345 dest_trace
->self_comp
);
1351 dest_group
= ctf_fs_ds_file_group_create(dest_trace
, sc
,
1352 src_group
->stream_id
, index
);
1353 /* Ownership of index is transferred. */
1360 g_ptr_array_add(dest_trace
->ds_file_groups
, dest_group
);
1363 BT_ASSERT(dest_group
);
1364 merge_ctf_fs_ds_file_groups(dest_group
, src_group
);
1372 * Collapse the given traces, which must all share the same UUID, in a single
1375 * The trace with the most expansive metadata is chosen and all other traces
1376 * are merged into that one. The array slots of all the traces that get merged
1377 * in the chosen one are set to NULL, so only the slot of the chosen trace
1382 int merge_ctf_fs_traces(struct ctf_fs_trace
**traces
, unsigned int num_traces
,
1383 struct ctf_fs_trace
**out_trace
)
1385 unsigned int winner_count
;
1386 struct ctf_fs_trace
*winner
;
1390 BT_ASSERT(num_traces
>= 2);
1392 winner_count
= metadata_count_stream_and_event_classes(traces
[0]);
1396 /* Find the trace with the largest metadata. */
1397 for (i
= 1; i
< num_traces
; i
++) {
1398 struct ctf_fs_trace
*candidate
;
1399 unsigned int candidate_count
;
1401 candidate
= traces
[i
];
1403 /* A bit of sanity check. */
1404 BT_ASSERT(bt_uuid_compare(winner
->metadata
->tc
->uuid
, candidate
->metadata
->tc
->uuid
) == 0);
1406 candidate_count
= metadata_count_stream_and_event_classes(candidate
);
1408 if (candidate_count
> winner_count
) {
1409 winner_count
= candidate_count
;
1415 /* Merge all the other traces in the winning trace. */
1416 for (i
= 0; i
< num_traces
; i
++) {
1417 struct ctf_fs_trace
*trace
= traces
[i
];
1419 /* Don't merge the winner into itself. */
1420 if (trace
== winner
) {
1424 /* Merge trace's data stream file groups into winner's. */
1425 ret
= merge_matching_ctf_fs_ds_file_groups(winner
, trace
);
1432 * Move the winner out of the array, into `*out_trace`.
1434 *out_trace
= winner
;
1435 traces
[winner_i
] = NULL
;
1447 int decode_clock_snapshot_after_event(struct ctf_fs_trace
*ctf_fs_trace
,
1448 struct ctf_clock_class
*default_cc
,
1449 struct ctf_fs_ds_index_entry
*index_entry
,
1450 enum target_event target_event
, uint64_t *cs
, int64_t *ts_ns
)
1452 enum ctf_msg_iter_status iter_status
= CTF_MSG_ITER_STATUS_OK
;
1453 struct ctf_fs_ds_file
*ds_file
= NULL
;
1454 struct ctf_msg_iter
*msg_iter
= NULL
;
1455 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
1456 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
1459 BT_ASSERT(ctf_fs_trace
);
1460 BT_ASSERT(index_entry
);
1461 BT_ASSERT(index_entry
->path
);
1463 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
,
1464 NULL
, index_entry
->path
, log_level
);
1466 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Failed to create a ctf_fs_ds_file");
1471 BT_ASSERT(ctf_fs_trace
->metadata
);
1472 BT_ASSERT(ctf_fs_trace
->metadata
->tc
);
1474 msg_iter
= ctf_msg_iter_create(ctf_fs_trace
->metadata
->tc
,
1475 bt_common_get_page_size(log_level
) * 8, ctf_fs_ds_file_medops
,
1476 ds_file
, log_level
, self_comp
, NULL
);
1478 /* ctf_msg_iter_create() logs errors. */
1484 * Turn on dry run mode to prevent the creation and usage of Babeltrace
1485 * library objects (bt_field, bt_message_*, etc.).
1487 ctf_msg_iter_set_dry_run(msg_iter
, true);
1489 /* Seek to the beginning of the target packet. */
1490 iter_status
= ctf_msg_iter_seek(msg_iter
, index_entry
->offset
);
1492 /* ctf_msg_iter_seek() logs errors. */
1497 switch (target_event
) {
1500 * Start to decode the packet until we reach the end of
1501 * the first event. To extract the first event's clock
1504 iter_status
= ctf_msg_iter_curr_packet_first_event_clock_snapshot(
1508 /* Decode the packet to extract the last event's clock snapshot. */
1509 iter_status
= ctf_msg_iter_curr_packet_last_event_clock_snapshot(
1520 /* Convert clock snapshot to timestamp. */
1521 ret
= bt_util_clock_cycles_to_ns_from_origin(*cs
,
1522 default_cc
->frequency
, default_cc
->offset_seconds
,
1523 default_cc
->offset_cycles
, ts_ns
);
1525 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1526 "Failed to convert clock snapshot to timestamp");
1532 ctf_fs_ds_file_destroy(ds_file
);
1535 ctf_msg_iter_destroy(msg_iter
);
1542 int decode_packet_first_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1543 struct ctf_clock_class
*default_cc
,
1544 struct ctf_fs_ds_index_entry
*index_entry
, uint64_t *cs
, int64_t *ts_ns
)
1546 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
,
1547 index_entry
, FIRST_EVENT
, cs
, ts_ns
);
1551 int decode_packet_last_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1552 struct ctf_clock_class
*default_cc
,
1553 struct ctf_fs_ds_index_entry
*index_entry
, uint64_t *cs
, int64_t *ts_ns
)
1555 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
,
1556 index_entry
, LAST_EVENT
, cs
, ts_ns
);
1560 * Fix up packet index entries for lttng's "event-after-packet" bug.
1561 * Some buggy lttng tracer versions may emit events with a timestamp that is
1562 * larger (after) than the timestamp_end of the their packets.
1564 * To fix up this erroneous data we do the following:
1565 * 1. If it's not the stream file's last packet: set the packet index entry's
1566 * end time to the next packet's beginning time.
1567 * 2. If it's the stream file's last packet, set the packet index entry's end
1568 * time to the packet's last event's time, if any, or to the packet's
1569 * beginning time otherwise.
1571 * Known buggy tracer versions:
1572 * - before lttng-ust 2.11.0
1573 * - before lttng-module 2.11.0
1574 * - before lttng-module 2.10.10
1575 * - before lttng-module 2.9.13
1578 int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace
*trace
)
1581 guint ds_file_group_i
;
1582 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1583 bt_logging_level log_level
= trace
->log_level
;
1585 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
;
1586 ds_file_group_i
++) {
1588 struct ctf_clock_class
*default_cc
;
1589 struct ctf_fs_ds_index_entry
*last_entry
;
1590 struct ctf_fs_ds_index
*index
;
1592 struct ctf_fs_ds_file_group
*ds_file_group
=
1593 g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1595 BT_ASSERT(ds_file_group
);
1596 index
= ds_file_group
->index
;
1599 BT_ASSERT(index
->entries
);
1600 BT_ASSERT(index
->entries
->len
> 0);
1603 * Iterate over all entries but the last one. The last one is
1604 * fixed differently after.
1606 for (entry_i
= 0; entry_i
< index
->entries
->len
- 1;
1608 struct ctf_fs_ds_index_entry
*curr_entry
, *next_entry
;
1610 curr_entry
= g_ptr_array_index(index
->entries
, entry_i
);
1611 next_entry
= g_ptr_array_index(index
->entries
, entry_i
+ 1);
1614 * 1. Set the current index entry `end` timestamp to
1615 * the next index entry `begin` timestamp.
1617 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1618 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1622 * 2. Fix the last entry by decoding the last event of the last
1625 last_entry
= g_ptr_array_index(index
->entries
,
1626 index
->entries
->len
- 1);
1627 BT_ASSERT(last_entry
);
1629 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1630 default_cc
= ds_file_group
->sc
->default_clock_class
;
1633 * Decode packet to read the timestamp of the last event of the
1636 ret
= decode_packet_last_event_timestamp(trace
, default_cc
,
1637 last_entry
, &last_entry
->timestamp_end
,
1638 &last_entry
->timestamp_end_ns
);
1640 BT_COMP_LOGE_APPEND_CAUSE(trace
->self_comp
,
1641 "Failed to decode stream's last packet to get its last event's clock snapshot.");
1651 * Fix up packet index entries for barectf's "event-before-packet" bug.
1652 * Some buggy barectf tracer versions may emit events with a timestamp that is
1653 * less than the timestamp_begin of the their packets.
1655 * To fix up this erroneous data we do the following:
1656 * 1. Starting at the second index entry, set the timestamp_begin of the
1657 * current entry to the timestamp of the first event of the packet.
1658 * 2. Set the previous entry's timestamp_end to the timestamp_begin of the
1661 * Known buggy tracer versions:
1662 * - before barectf 2.3.1
1665 int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace
*trace
)
1668 guint ds_file_group_i
;
1669 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1670 bt_logging_level log_level
= trace
->log_level
;
1672 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
;
1673 ds_file_group_i
++) {
1675 struct ctf_clock_class
*default_cc
;
1676 struct ctf_fs_ds_file_group
*ds_file_group
=
1677 g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1679 struct ctf_fs_ds_index
*index
= ds_file_group
->index
;
1682 BT_ASSERT(index
->entries
);
1683 BT_ASSERT(index
->entries
->len
> 0);
1685 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1686 default_cc
= ds_file_group
->sc
->default_clock_class
;
1689 * 1. Iterate over the index, starting from the second entry
1692 for (entry_i
= 1; entry_i
< index
->entries
->len
;
1694 struct ctf_fs_ds_index_entry
*curr_entry
, *prev_entry
;
1695 prev_entry
= g_ptr_array_index(index
->entries
, entry_i
- 1);
1696 curr_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_entry
*last_entry
;
1752 struct ctf_fs_ds_index
*index
;
1754 struct ctf_fs_ds_file_group
*ds_file_group
=
1755 g_ptr_array_index(ds_file_groups
, ds_file_group_idx
);
1757 BT_ASSERT(ds_file_group
);
1758 index
= ds_file_group
->index
;
1760 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1761 default_cc
= ds_file_group
->sc
->default_clock_class
;
1764 BT_ASSERT(index
->entries
);
1765 BT_ASSERT(index
->entries
->len
> 0);
1767 last_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 struct ctf_fs_ds_index_entry
*curr_entry
, *next_entry
;
1794 curr_entry
= g_ptr_array_index(index
->entries
, entry_idx
);
1795 next_entry
= g_ptr_array_index(index
->entries
, entry_idx
+ 1);
1797 if (curr_entry
->timestamp_end
== 0 &&
1798 curr_entry
->timestamp_begin
!= 0) {
1800 * 2. Set the current index entry `end` timestamp to
1801 * the next index entry `begin` timestamp.
1803 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1804 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1814 * Extract the tracer information necessary to compare versions.
1815 * Returns 0 on success, and -1 if the extraction is not successful because the
1816 * necessary fields are absents in the trace metadata.
1819 int extract_tracer_info(struct ctf_fs_trace
*trace
,
1820 struct tracer_info
*current_tracer_info
)
1823 struct ctf_trace_class_env_entry
*entry
;
1825 /* Clear the current_tracer_info struct */
1826 memset(current_tracer_info
, 0, sizeof(*current_tracer_info
));
1829 * To compare 2 tracer versions, at least the tracer name and it's
1830 * major version are needed. If one of these is missing, consider it an
1831 * extraction failure.
1833 entry
= ctf_trace_class_borrow_env_entry_by_name(
1834 trace
->metadata
->tc
, "tracer_name");
1835 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR
) {
1836 goto missing_bare_minimum
;
1839 /* Set tracer name. */
1840 current_tracer_info
->name
= entry
->value
.str
->str
;
1842 entry
= ctf_trace_class_borrow_env_entry_by_name(
1843 trace
->metadata
->tc
, "tracer_major");
1844 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1845 goto missing_bare_minimum
;
1848 /* Set major version number. */
1849 current_tracer_info
->major
= entry
->value
.i
;
1851 entry
= ctf_trace_class_borrow_env_entry_by_name(
1852 trace
->metadata
->tc
, "tracer_minor");
1853 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1857 /* Set minor version number. */
1858 current_tracer_info
->minor
= entry
->value
.i
;
1860 entry
= ctf_trace_class_borrow_env_entry_by_name(
1861 trace
->metadata
->tc
, "tracer_patch");
1864 * If `tracer_patch` doesn't exist `tracer_patchlevel` might.
1865 * For example, `lttng-modules` uses entry name
1866 * `tracer_patchlevel`.
1868 entry
= ctf_trace_class_borrow_env_entry_by_name(
1869 trace
->metadata
->tc
, "tracer_patchlevel");
1872 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1876 /* Set patch version number. */
1877 current_tracer_info
->patch
= entry
->value
.i
;
1881 missing_bare_minimum
:
1888 bool is_tracer_affected_by_lttng_event_after_packet_bug(
1889 struct tracer_info
*curr_tracer_info
)
1891 bool is_affected
= false;
1893 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1894 if (curr_tracer_info
->major
< 2) {
1896 } else if (curr_tracer_info
->major
== 2) {
1897 /* fixed in lttng-ust 2.11.0 */
1898 if (curr_tracer_info
->minor
< 11) {
1902 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1903 if (curr_tracer_info
->major
< 2) {
1905 } else if (curr_tracer_info
->major
== 2) {
1906 /* fixed in lttng-modules 2.11.0 */
1907 if (curr_tracer_info
->minor
== 10) {
1908 /* fixed in lttng-modules 2.10.10 */
1909 if (curr_tracer_info
->patch
< 10) {
1912 } else if (curr_tracer_info
->minor
== 9) {
1913 /* fixed in lttng-modules 2.9.13 */
1914 if (curr_tracer_info
->patch
< 13) {
1917 } else if (curr_tracer_info
->minor
< 9) {
1927 bool is_tracer_affected_by_barectf_event_before_packet_bug(
1928 struct tracer_info
*curr_tracer_info
)
1930 bool is_affected
= false;
1932 if (strcmp(curr_tracer_info
->name
, "barectf") == 0) {
1933 if (curr_tracer_info
->major
< 2) {
1935 } else if (curr_tracer_info
->major
== 2) {
1936 if (curr_tracer_info
->minor
< 3) {
1938 } else if (curr_tracer_info
->minor
== 3) {
1939 /* fixed in barectf 2.3.1 */
1940 if (curr_tracer_info
->patch
< 1) {
1951 bool is_tracer_affected_by_lttng_crash_quirk(
1952 struct tracer_info
*curr_tracer_info
)
1954 bool is_affected
= false;
1956 /* All LTTng tracer may be affected by this lttng crash quirk. */
1957 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1959 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1967 * Looks for trace produced by known buggy tracers and fix up the index
1971 int fix_packet_index_tracer_bugs(struct ctf_fs_component
*ctf_fs
,
1972 bt_self_component
*self_comp
,
1973 bt_self_component_class
*self_comp_class
)
1976 struct tracer_info current_tracer_info
;
1977 bt_logging_level log_level
= ctf_fs
->log_level
;
1979 ret
= extract_tracer_info(ctf_fs
->trace
, ¤t_tracer_info
);
1982 * A trace may not have all the necessary environment
1983 * entries to do the tracer version comparison.
1984 * At least, the tracer name and major version number
1985 * are needed. Failing to extract these entries is not
1989 BT_LOGI_STR("Cannot extract tracer information necessary to compare with buggy versions.");
1993 /* Check if the trace may be affected by old tracer bugs. */
1994 if (is_tracer_affected_by_lttng_event_after_packet_bug(
1995 ¤t_tracer_info
)) {
1996 BT_LOGI_STR("Trace may be affected by LTTng tracer packet timestamp bug. Fixing up.");
1997 ret
= fix_index_lttng_event_after_packet_bug(ctf_fs
->trace
);
1999 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
2000 self_comp
, self_comp_class
,
2001 "Failed to fix LTTng event-after-packet bug.");
2004 ctf_fs
->trace
->metadata
->tc
->quirks
.lttng_event_after_packet
= true;
2007 if (is_tracer_affected_by_barectf_event_before_packet_bug(
2008 ¤t_tracer_info
)) {
2009 BT_LOGI_STR("Trace may be affected by barectf tracer packet timestamp bug. Fixing up.");
2010 ret
= fix_index_barectf_event_before_packet_bug(ctf_fs
->trace
);
2012 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
2013 self_comp
, self_comp_class
,
2014 "Failed to fix barectf event-before-packet bug.");
2017 ctf_fs
->trace
->metadata
->tc
->quirks
.barectf_event_before_packet
= true;
2020 if (is_tracer_affected_by_lttng_crash_quirk(
2021 ¤t_tracer_info
)) {
2022 ret
= fix_index_lttng_crash_quirk(ctf_fs
->trace
);
2024 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
2025 self_comp
, self_comp_class
,
2026 "Failed to fix lttng-crash timestamp quirks.");
2029 ctf_fs
->trace
->metadata
->tc
->quirks
.lttng_crash
= true;
2037 gint
compare_ds_file_groups_by_first_path(gconstpointer a
, gconstpointer b
)
2039 struct ctf_fs_ds_file_group
* const *ds_file_group_a
= a
;
2040 struct ctf_fs_ds_file_group
* const *ds_file_group_b
= b
;
2041 const struct ctf_fs_ds_file_info
*first_ds_file_info_a
;
2042 const struct ctf_fs_ds_file_info
*first_ds_file_info_b
;
2044 BT_ASSERT((*ds_file_group_a
)->ds_file_infos
->len
> 0);
2045 BT_ASSERT((*ds_file_group_b
)->ds_file_infos
->len
> 0);
2046 first_ds_file_info_a
= (*ds_file_group_a
)->ds_file_infos
->pdata
[0];
2047 first_ds_file_info_b
= (*ds_file_group_b
)->ds_file_infos
->pdata
[0];
2048 return strcmp(first_ds_file_info_a
->path
->str
,
2049 first_ds_file_info_b
->path
->str
);
2052 int ctf_fs_component_create_ctf_fs_trace(
2053 struct ctf_fs_component
*ctf_fs
,
2054 const bt_value
*paths_value
,
2055 const bt_value
*trace_name_value
,
2056 bt_self_component
*self_comp
,
2057 bt_self_component_class
*self_comp_class
)
2061 bt_logging_level log_level
= ctf_fs
->log_level
;
2063 const char *trace_name
;
2065 BT_ASSERT(bt_value_get_type(paths_value
) == BT_VALUE_TYPE_ARRAY
);
2066 BT_ASSERT(!bt_value_array_is_empty(paths_value
));
2068 traces
= g_ptr_array_new_with_free_func(ctf_fs_trace_destroy_notifier
);
2070 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2071 "Failed to allocate a GPtrArray.");
2075 trace_name
= trace_name_value
? bt_value_string_get(trace_name_value
) : NULL
;
2077 /* Start by creating a separate ctf_fs_trace object for each path. */
2078 for (i
= 0; i
< bt_value_array_get_length(paths_value
); i
++) {
2079 const bt_value
*path_value
= bt_value_array_borrow_element_by_index_const(paths_value
, i
);
2080 const char *input
= bt_value_string_get(path_value
);
2082 ret
= ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs
,
2083 input
, trace_name
, traces
, self_comp
, self_comp_class
);
2089 if (traces
->len
> 1) {
2090 struct ctf_fs_trace
*first_trace
= (struct ctf_fs_trace
*) traces
->pdata
[0];
2091 const uint8_t *first_trace_uuid
= first_trace
->metadata
->tc
->uuid
;
2092 struct ctf_fs_trace
*trace
;
2095 * We have more than one trace, they must all share the same
2096 * UUID, verify that.
2098 for (i
= 0; i
< traces
->len
; i
++) {
2099 struct ctf_fs_trace
*this_trace
=
2100 (struct ctf_fs_trace
*) traces
->pdata
[i
];
2101 const uint8_t *this_trace_uuid
= this_trace
->metadata
->tc
->uuid
;
2103 if (!this_trace
->metadata
->tc
->is_uuid_set
) {
2104 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2105 "Multiple traces given, but a trace does not have a UUID: path=%s",
2106 this_trace
->path
->str
);
2110 if (bt_uuid_compare(first_trace_uuid
, this_trace_uuid
) != 0) {
2111 char first_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
2112 char this_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
2114 bt_uuid_to_str(first_trace_uuid
, first_trace_uuid_str
);
2115 bt_uuid_to_str(this_trace_uuid
, this_trace_uuid_str
);
2117 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2118 "Multiple traces given, but UUIDs don't match: "
2119 "first-trace-uuid=%s, first-trace-path=%s, "
2120 "trace-uuid=%s, trace-path=%s",
2121 first_trace_uuid_str
, first_trace
->path
->str
,
2122 this_trace_uuid_str
, this_trace
->path
->str
);
2127 ret
= merge_ctf_fs_traces((struct ctf_fs_trace
**) traces
->pdata
,
2128 traces
->len
, &trace
);
2130 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2131 "Failed to merge traces with the same UUID.");
2135 ctf_fs
->trace
= trace
;
2137 /* Just one trace, it may or may not have a UUID, both are fine. */
2138 ctf_fs
->trace
= traces
->pdata
[0];
2139 traces
->pdata
[0] = NULL
;
2142 ret
= fix_packet_index_tracer_bugs(ctf_fs
, self_comp
, self_comp_class
);
2144 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2145 "Failed to fix packet index tracer bugs.");
2149 * Sort data stream file groups by first data stream file info
2150 * path to get a deterministic order. This order influences the
2151 * order of the output ports. It also influences the order of
2152 * the automatic stream IDs if the trace's packet headers do not
2153 * contain a `stream_instance_id` field, in which case the data
2154 * stream file to stream ID association is always the same,
2155 * whatever the build and the system.
2157 * Having a deterministic order here can help debugging and
2160 g_ptr_array_sort(ctf_fs
->trace
->ds_file_groups
,
2161 compare_ds_file_groups_by_first_path
);
2167 g_ptr_array_free(traces
, TRUE
);
2172 GString
*get_stream_instance_unique_name(
2173 struct ctf_fs_ds_file_group
*ds_file_group
)
2176 struct ctf_fs_ds_file_info
*ds_file_info
;
2178 name
= g_string_new(NULL
);
2184 * If there's more than one stream file in the stream file
2185 * group, the first (earliest) stream file's path is used as
2186 * the stream's unique name.
2188 BT_ASSERT(ds_file_group
->ds_file_infos
->len
> 0);
2189 ds_file_info
= g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
2190 g_string_assign(name
, ds_file_info
->path
->str
);
2196 /* Create the IR stream objects for ctf_fs_trace. */
2199 int create_streams_for_trace(struct ctf_fs_trace
*ctf_fs_trace
)
2202 GString
*name
= NULL
;
2204 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
2205 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
2207 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
2208 struct ctf_fs_ds_file_group
*ds_file_group
=
2209 g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
2210 name
= get_stream_instance_unique_name(ds_file_group
);
2216 if (ds_file_group
->sc
->ir_sc
) {
2217 BT_ASSERT(ctf_fs_trace
->trace
);
2219 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
2220 /* No stream ID: use 0 */
2221 ds_file_group
->stream
= bt_stream_create_with_id(
2222 ds_file_group
->sc
->ir_sc
,
2223 ctf_fs_trace
->trace
,
2224 ctf_fs_trace
->next_stream_id
);
2225 ctf_fs_trace
->next_stream_id
++;
2227 /* Specific stream ID */
2228 ds_file_group
->stream
= bt_stream_create_with_id(
2229 ds_file_group
->sc
->ir_sc
,
2230 ctf_fs_trace
->trace
,
2231 (uint64_t) ds_file_group
->stream_id
);
2234 ds_file_group
->stream
= NULL
;
2237 if (!ds_file_group
->stream
) {
2238 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2239 "Cannot create stream for DS file group: "
2240 "addr=%p, stream-name=\"%s\"",
2241 ds_file_group
, name
->str
);
2245 ret
= bt_stream_set_name(ds_file_group
->stream
,
2248 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Cannot set stream's name: "
2249 "addr=%p, stream-name=\"%s\"",
2250 ds_file_group
->stream
, name
->str
);
2254 g_string_free(name
, TRUE
);
2267 g_string_free(name
, TRUE
);
2272 static const struct bt_param_validation_value_descr inputs_elem_descr
= {
2273 .type
= BT_VALUE_TYPE_STRING
,
2276 static const struct bt_param_validation_map_value_entry_descr fs_params_entries_descr
[] = {
2277 { "inputs", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
, {
2278 BT_VALUE_TYPE_ARRAY
,
2281 .max_length
= BT_PARAM_VALIDATION_INFINITE
,
2282 .element_type
= &inputs_elem_descr
,
2285 { "trace-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_STRING
} },
2286 { "clock-class-offset-s", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_SIGNED_INTEGER
} },
2287 { "clock-class-offset-ns", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_SIGNED_INTEGER
} },
2288 { "force-clock-class-origin-unix-epoch", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_BOOL
} },
2289 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
2293 bool read_src_fs_parameters(const bt_value
*params
,
2294 const bt_value
**inputs
,
2295 const bt_value
**trace_name
,
2296 struct ctf_fs_component
*ctf_fs
,
2297 bt_self_component
*self_comp
,
2298 bt_self_component_class
*self_comp_class
) {
2300 const bt_value
*value
;
2301 bt_logging_level log_level
= ctf_fs
->log_level
;
2302 enum bt_param_validation_status validate_value_status
;
2303 gchar
*error
= NULL
;
2305 validate_value_status
= bt_param_validation_validate(params
,
2306 fs_params_entries_descr
, &error
);
2307 if (validate_value_status
!= BT_PARAM_VALIDATION_STATUS_OK
) {
2308 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2314 /* inputs parameter */
2315 *inputs
= bt_value_map_borrow_entry_value_const(params
, "inputs");
2317 /* clock-class-offset-s parameter */
2318 value
= bt_value_map_borrow_entry_value_const(params
,
2319 "clock-class-offset-s");
2321 ctf_fs
->metadata_config
.clock_class_offset_s
=
2322 bt_value_integer_signed_get(value
);
2325 /* clock-class-offset-ns parameter */
2326 value
= bt_value_map_borrow_entry_value_const(params
,
2327 "clock-class-offset-ns");
2329 ctf_fs
->metadata_config
.clock_class_offset_ns
=
2330 bt_value_integer_signed_get(value
);
2333 /* force-clock-class-origin-unix-epoch parameter */
2334 value
= bt_value_map_borrow_entry_value_const(params
,
2335 "force-clock-class-origin-unix-epoch");
2337 ctf_fs
->metadata_config
.force_clock_class_origin_unix_epoch
=
2338 bt_value_bool_get(value
);
2341 /* trace-name parameter */
2342 *trace_name
= bt_value_map_borrow_entry_value_const(params
, "trace-name");
2352 struct ctf_fs_component
*ctf_fs_create(
2353 const bt_value
*params
,
2354 bt_self_component_source
*self_comp_src
)
2356 struct ctf_fs_component
*ctf_fs
= NULL
;
2357 const bt_value
*inputs_value
;
2358 const bt_value
*trace_name_value
;
2359 bt_self_component
*self_comp
=
2360 bt_self_component_source_as_self_component(self_comp_src
);
2362 ctf_fs
= ctf_fs_component_create(bt_component_get_logging_level(
2363 bt_self_component_as_component(self_comp
)), self_comp
);
2368 if (!read_src_fs_parameters(params
, &inputs_value
, &trace_name_value
,
2369 ctf_fs
, self_comp
, NULL
)) {
2373 bt_self_component_set_data(self_comp
, ctf_fs
);
2375 if (ctf_fs_component_create_ctf_fs_trace(ctf_fs
, inputs_value
,
2376 trace_name_value
, self_comp
, NULL
)) {
2380 if (create_streams_for_trace(ctf_fs
->trace
)) {
2384 if (create_ports_for_trace(ctf_fs
, ctf_fs
->trace
, self_comp_src
)) {
2391 ctf_fs_destroy(ctf_fs
);
2393 bt_self_component_set_data(self_comp
, NULL
);
2400 bt_component_class_initialize_method_status
ctf_fs_init(
2401 bt_self_component_source
*self_comp_src
,
2402 bt_self_component_source_configuration
*config
,
2403 const bt_value
*params
, __attribute__((unused
)) void *init_method_data
)
2405 struct ctf_fs_component
*ctf_fs
;
2406 bt_component_class_initialize_method_status ret
=
2407 BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
2409 ctf_fs
= ctf_fs_create(params
, self_comp_src
);
2411 ret
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
2418 bt_component_class_query_method_status
ctf_fs_query(
2419 bt_self_component_class_source
*comp_class
,
2420 bt_private_query_executor
*priv_query_exec
,
2421 const char *object
, const bt_value
*params
,
2422 __attribute__((unused
)) void *method_data
,
2423 const bt_value
**result
)
2425 bt_component_class_query_method_status status
=
2426 BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
2427 bt_logging_level log_level
= bt_query_executor_get_logging_level(
2428 bt_private_query_executor_as_query_executor_const(
2431 if (strcmp(object
, "metadata-info") == 0) {
2432 status
= metadata_info_query(comp_class
, params
, log_level
,
2434 } else if (strcmp(object
, "babeltrace.trace-infos") == 0) {
2435 status
= trace_infos_query(comp_class
, params
, log_level
,
2437 } else if (!strcmp(object
, "babeltrace.support-info")) {
2438 status
= support_info_query(comp_class
, params
, log_level
, result
);
2440 BT_LOGE("Unknown query object `%s`", object
);
2441 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;