4 * Babeltrace CTF file system Reader Component
6 * Copyright 2015-2017 Philippe Proulx <pproulx@efficios.com>
7 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
9 * Permission is hereby granted, free of charge, to any person obtaining a copy
10 * of this software and associated documentation files (the "Software"), to deal
11 * in the Software without restriction, including without limitation the rights
12 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 * copies of the Software, and to permit persons to whom the Software is
14 * furnished to do so, subject to the following conditions:
16 * The above copyright notice and this permission notice shall be included in
17 * all copies or substantial portions of the Software.
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
28 #define BT_COMP_LOG_SELF_COMP self_comp
29 #define BT_LOG_OUTPUT_LEVEL log_level
30 #define BT_LOG_TAG "PLUGIN/SRC.CTF.FS"
31 #include "logging/comp-logging.h"
33 #include "common/common.h"
34 #include <babeltrace2/babeltrace.h>
35 #include "common/uuid.h"
37 #include "common/assert.h"
42 #include "data-stream-file.h"
44 #include "../common/metadata/decoder.h"
45 #include "../common/metadata/ctf-meta-configure-ir-trace.h"
46 #include "../common/msg-iter/msg-iter.h"
48 #include "plugins/common/param-validation/param-validation.h"
58 int msg_iter_data_set_current_ds_file(struct ctf_fs_msg_iter_data
*msg_iter_data
)
60 struct ctf_fs_ds_file_info
*ds_file_info
;
63 BT_ASSERT(msg_iter_data
->ds_file_info_index
<
64 msg_iter_data
->ds_file_group
->ds_file_infos
->len
);
65 ds_file_info
= g_ptr_array_index(
66 msg_iter_data
->ds_file_group
->ds_file_infos
,
67 msg_iter_data
->ds_file_info_index
);
69 /* Destroy the previous ds file. */
70 ctf_fs_ds_file_destroy(msg_iter_data
->ds_file
);
72 /* Create the new ds file. */
73 msg_iter_data
->ds_file
= ctf_fs_ds_file_create(
74 msg_iter_data
->ds_file_group
->ctf_fs_trace
,
75 msg_iter_data
->self_msg_iter
,
76 msg_iter_data
->ds_file_group
->stream
,
77 ds_file_info
->path
->str
,
78 msg_iter_data
->log_level
);
79 if (!msg_iter_data
->ds_file
) {
83 /* Tell the ctf message iterator to iterate on the new ds file. */
84 ctf_msg_iter_set_medops_data(msg_iter_data
->msg_iter
,
85 msg_iter_data
->ds_file
);
91 void ctf_fs_msg_iter_data_destroy(
92 struct ctf_fs_msg_iter_data
*msg_iter_data
)
98 ctf_fs_ds_file_destroy(msg_iter_data
->ds_file
);
100 if (msg_iter_data
->msg_iter
) {
101 ctf_msg_iter_destroy(msg_iter_data
->msg_iter
);
104 g_free(msg_iter_data
);
108 void set_msg_iter_emits_stream_beginning_end_messages(
109 struct ctf_fs_msg_iter_data
*msg_iter_data
)
111 ctf_msg_iter_set_emit_stream_beginning_message(
112 msg_iter_data
->msg_iter
,
113 msg_iter_data
->ds_file_info_index
== 0);
114 ctf_msg_iter_set_emit_stream_end_message(
115 msg_iter_data
->msg_iter
,
116 msg_iter_data
->ds_file_info_index
==
117 msg_iter_data
->ds_file_group
->ds_file_infos
->len
- 1);
121 bt_component_class_message_iterator_next_method_status
ctf_fs_iterator_next_one(
122 struct ctf_fs_msg_iter_data
*msg_iter_data
,
123 const bt_message
**out_msg
)
125 bt_component_class_message_iterator_next_method_status status
;
127 BT_ASSERT_DBG(msg_iter_data
->ds_file
);
130 enum ctf_msg_iter_status msg_iter_status
;
133 msg_iter_status
= ctf_msg_iter_get_next_message(
134 msg_iter_data
->msg_iter
, out_msg
);
136 switch (msg_iter_status
) {
137 case CTF_MSG_ITER_STATUS_OK
:
138 /* Cool, message has been written to *out_msg. */
139 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
;
142 case CTF_MSG_ITER_STATUS_EOF
:
143 if (msg_iter_data
->ds_file_info_index
==
144 msg_iter_data
->ds_file_group
->ds_file_infos
->len
- 1) {
145 /* End of all group's stream files */
146 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_END
;
150 msg_iter_data
->ds_file_info_index
++;
151 ctf_msg_iter_reset_for_next_stream_file(
152 msg_iter_data
->msg_iter
);
153 set_msg_iter_emits_stream_beginning_end_messages(
157 * Open and start reading the next stream file
158 * within our stream file group.
160 ret
= msg_iter_data_set_current_ds_file(msg_iter_data
);
162 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR
;
166 /* Continue the loop to get the next message. */
169 case CTF_MSG_ITER_STATUS_AGAIN
:
171 * Should not make it this far as this is
172 * medium-specific; there is nothing for the user to do
173 * and it should have been handled upstream.
178 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR
;
188 bt_component_class_message_iterator_next_method_status
ctf_fs_iterator_next(
189 bt_self_message_iterator
*iterator
,
190 bt_message_array_const msgs
, uint64_t capacity
,
193 bt_component_class_message_iterator_next_method_status status
;
194 struct ctf_fs_msg_iter_data
*msg_iter_data
=
195 bt_self_message_iterator_get_data(iterator
);
198 if (G_UNLIKELY(msg_iter_data
->next_saved_error
)) {
200 * Last time we were called, we hit an error but had some
201 * messages to deliver, so we stashed the error here. Return
204 BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(msg_iter_data
->next_saved_error
);
205 status
= msg_iter_data
->next_saved_status
;
210 status
= ctf_fs_iterator_next_one(msg_iter_data
, &msgs
[i
]);
211 if (status
== BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
) {
214 } while (i
< capacity
&&
215 status
== BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
);
219 * Even if ctf_fs_iterator_next_one() returned something
220 * else than BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK, we
221 * accumulated message objects in the output
222 * message array, so we need to return
223 * BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK so that they are
224 * transfered to downstream. This other status occurs
225 * again the next time muxer_msg_iter_do_next() is
226 * called, possibly without any accumulated
227 * message, in which case we'll return it.
231 * Save this error for the next _next call. Assume that
232 * this component always appends error causes when
233 * returning an error status code, which will cause the
234 * current thread error to be non-NULL.
236 msg_iter_data
->next_saved_error
= bt_current_thread_take_error();
237 BT_ASSERT(msg_iter_data
->next_saved_error
);
238 msg_iter_data
->next_saved_status
= status
;
242 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
;
250 int ctf_fs_iterator_reset(struct ctf_fs_msg_iter_data
*msg_iter_data
)
254 msg_iter_data
->ds_file_info_index
= 0;
255 ret
= msg_iter_data_set_current_ds_file(msg_iter_data
);
260 ctf_msg_iter_reset(msg_iter_data
->msg_iter
);
261 set_msg_iter_emits_stream_beginning_end_messages(msg_iter_data
);
268 bt_component_class_message_iterator_seek_beginning_method_status
269 ctf_fs_iterator_seek_beginning(bt_self_message_iterator
*it
)
271 struct ctf_fs_msg_iter_data
*msg_iter_data
=
272 bt_self_message_iterator_get_data(it
);
273 bt_component_class_message_iterator_seek_beginning_method_status status
=
274 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_OK
;
276 BT_ASSERT(msg_iter_data
);
277 if (ctf_fs_iterator_reset(msg_iter_data
)) {
278 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_ERROR
;
285 void ctf_fs_iterator_finalize(bt_self_message_iterator
*it
)
287 ctf_fs_msg_iter_data_destroy(
288 bt_self_message_iterator_get_data(it
));
292 bt_component_class_message_iterator_initialize_method_status
ctf_fs_iterator_init(
293 bt_self_message_iterator
*self_msg_iter
,
294 bt_self_message_iterator_configuration
*config
,
295 bt_self_component_source
*self_comp_src
,
296 bt_self_component_port_output
*self_port
)
298 struct ctf_fs_port_data
*port_data
;
299 struct ctf_fs_msg_iter_data
*msg_iter_data
= NULL
;
300 bt_component_class_message_iterator_initialize_method_status ret
=
301 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_OK
;
302 bt_logging_level log_level
;
303 bt_self_component
*self_comp
=
304 bt_self_component_source_as_self_component(self_comp_src
);
306 port_data
= bt_self_component_port_get_data(
307 bt_self_component_port_output_as_self_component_port(
309 BT_ASSERT(port_data
);
310 log_level
= port_data
->ctf_fs
->log_level
;
311 msg_iter_data
= g_new0(struct ctf_fs_msg_iter_data
, 1);
312 if (!msg_iter_data
) {
313 ret
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
317 msg_iter_data
->log_level
= log_level
;
318 msg_iter_data
->self_comp
= self_comp
;
319 msg_iter_data
->self_msg_iter
= self_msg_iter
;
320 msg_iter_data
->msg_iter
= ctf_msg_iter_create(
321 port_data
->ds_file_group
->ctf_fs_trace
->metadata
->tc
,
322 bt_common_get_page_size(msg_iter_data
->log_level
) * 8,
323 ctf_fs_ds_file_medops
, NULL
, msg_iter_data
->log_level
,
324 self_comp
, self_msg_iter
);
325 if (!msg_iter_data
->msg_iter
) {
326 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Cannot create a CTF message iterator.");
327 ret
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
331 msg_iter_data
->ds_file_group
= port_data
->ds_file_group
;
332 if (ctf_fs_iterator_reset(msg_iter_data
)) {
333 ret
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_ERROR
;
338 * This iterator can seek forward if its stream class has a default
341 if (msg_iter_data
->ds_file_group
->sc
->default_clock_class
) {
342 bt_self_message_iterator_configuration_set_can_seek_forward(
346 bt_self_message_iterator_set_data(self_msg_iter
,
348 if (ret
!= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_OK
) {
351 msg_iter_data
= NULL
;
355 bt_self_message_iterator_set_data(self_msg_iter
, NULL
);
358 ctf_fs_msg_iter_data_destroy(msg_iter_data
);
363 void ctf_fs_trace_destroy(struct ctf_fs_trace
*ctf_fs_trace
)
369 if (ctf_fs_trace
->ds_file_groups
) {
370 g_ptr_array_free(ctf_fs_trace
->ds_file_groups
, TRUE
);
373 BT_TRACE_PUT_REF_AND_RESET(ctf_fs_trace
->trace
);
375 if (ctf_fs_trace
->path
) {
376 g_string_free(ctf_fs_trace
->path
, TRUE
);
379 if (ctf_fs_trace
->metadata
) {
380 ctf_fs_metadata_fini(ctf_fs_trace
->metadata
);
381 g_free(ctf_fs_trace
->metadata
);
384 g_free(ctf_fs_trace
);
388 void ctf_fs_destroy(struct ctf_fs_component
*ctf_fs
)
394 ctf_fs_trace_destroy(ctf_fs
->trace
);
396 if (ctf_fs
->port_data
) {
397 g_ptr_array_free(ctf_fs
->port_data
, TRUE
);
404 void port_data_destroy(struct ctf_fs_port_data
*port_data
)
414 void port_data_destroy_notifier(void *data
) {
415 port_data_destroy(data
);
419 void ctf_fs_trace_destroy_notifier(void *data
)
421 struct ctf_fs_trace
*trace
= data
;
422 ctf_fs_trace_destroy(trace
);
425 struct ctf_fs_component
*ctf_fs_component_create(bt_logging_level log_level
,
426 bt_self_component
*self_comp
)
428 struct ctf_fs_component
*ctf_fs
;
430 ctf_fs
= g_new0(struct ctf_fs_component
, 1);
435 ctf_fs
->log_level
= log_level
;
437 g_ptr_array_new_with_free_func(port_data_destroy_notifier
);
438 if (!ctf_fs
->port_data
) {
445 ctf_fs_destroy(ctf_fs
);
452 void ctf_fs_finalize(bt_self_component_source
*component
)
454 ctf_fs_destroy(bt_self_component_get_data(
455 bt_self_component_source_as_self_component(component
)));
458 gchar
*ctf_fs_make_port_name(struct ctf_fs_ds_file_group
*ds_file_group
)
460 GString
*name
= g_string_new(NULL
);
463 * The unique port name is generated by concatenating unique identifiers
471 /* For the trace, use the uuid if present, else the path. */
472 if (ds_file_group
->ctf_fs_trace
->metadata
->tc
->is_uuid_set
) {
473 char uuid_str
[BT_UUID_STR_LEN
+ 1];
475 bt_uuid_to_str(ds_file_group
->ctf_fs_trace
->metadata
->tc
->uuid
, uuid_str
);
476 g_string_assign(name
, uuid_str
);
478 g_string_assign(name
, ds_file_group
->ctf_fs_trace
->path
->str
);
482 * For the stream class, use the id if present. We can omit this field
483 * otherwise, as there will only be a single stream class.
485 if (ds_file_group
->sc
->id
!= UINT64_C(-1)) {
486 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->sc
->id
);
489 /* For the stream, use the id if present, else, use the path. */
490 if (ds_file_group
->stream_id
!= UINT64_C(-1)) {
491 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->stream_id
);
493 BT_ASSERT(ds_file_group
->ds_file_infos
->len
== 1);
494 struct ctf_fs_ds_file_info
*ds_file_info
=
495 g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
496 g_string_append_printf(name
, " | %s", ds_file_info
->path
->str
);
499 return g_string_free(name
, FALSE
);
503 int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
504 struct ctf_fs_trace
*ctf_fs_trace
,
505 struct ctf_fs_ds_file_group
*ds_file_group
,
506 bt_self_component_source
*self_comp_src
)
509 struct ctf_fs_port_data
*port_data
= NULL
;
511 bt_logging_level log_level
= ctf_fs
->log_level
;
512 bt_self_component
*self_comp
=
513 bt_self_component_source_as_self_component(self_comp_src
);
515 port_name
= ctf_fs_make_port_name(ds_file_group
);
520 BT_COMP_LOGI("Creating one port named `%s`", port_name
);
522 /* Create output port for this file */
523 port_data
= g_new0(struct ctf_fs_port_data
, 1);
528 port_data
->ctf_fs
= ctf_fs
;
529 port_data
->ds_file_group
= ds_file_group
;
530 ret
= bt_self_component_source_add_output_port(
531 self_comp_src
, port_name
, port_data
, NULL
);
536 g_ptr_array_add(ctf_fs
->port_data
, port_data
);
546 port_data_destroy(port_data
);
551 int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
552 struct ctf_fs_trace
*ctf_fs_trace
,
553 bt_self_component_source
*self_comp_src
)
557 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
558 bt_self_component
*self_comp
=
559 bt_self_component_source_as_self_component(self_comp_src
);
561 /* Create one output port for each stream file group */
562 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
563 struct ctf_fs_ds_file_group
*ds_file_group
=
564 g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
566 ret
= create_one_port_for_trace(ctf_fs
, ctf_fs_trace
,
567 ds_file_group
, self_comp_src
);
569 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Cannot create output port.");
579 void ctf_fs_ds_file_info_destroy(struct ctf_fs_ds_file_info
*ds_file_info
)
585 if (ds_file_info
->path
) {
586 g_string_free(ds_file_info
->path
, TRUE
);
589 g_free(ds_file_info
);
593 struct ctf_fs_ds_file_info
*ctf_fs_ds_file_info_create(const char *path
,
596 struct ctf_fs_ds_file_info
*ds_file_info
;
598 ds_file_info
= g_new0(struct ctf_fs_ds_file_info
, 1);
603 ds_file_info
->path
= g_string_new(path
);
604 if (!ds_file_info
->path
) {
605 ctf_fs_ds_file_info_destroy(ds_file_info
);
610 ds_file_info
->begin_ns
= begin_ns
;
617 void ctf_fs_ds_file_group_destroy(struct ctf_fs_ds_file_group
*ds_file_group
)
619 if (!ds_file_group
) {
623 if (ds_file_group
->ds_file_infos
) {
624 g_ptr_array_free(ds_file_group
->ds_file_infos
, TRUE
);
627 if (ds_file_group
->index
) {
628 if (ds_file_group
->index
->entries
) {
629 g_ptr_array_free(ds_file_group
->index
->entries
, TRUE
);
631 g_free(ds_file_group
->index
);
634 bt_stream_put_ref(ds_file_group
->stream
);
635 g_free(ds_file_group
);
639 struct ctf_fs_ds_file_group
*ctf_fs_ds_file_group_create(
640 struct ctf_fs_trace
*ctf_fs_trace
,
641 struct ctf_stream_class
*sc
,
642 uint64_t stream_instance_id
,
643 struct ctf_fs_ds_index
*index
)
645 struct ctf_fs_ds_file_group
*ds_file_group
;
647 ds_file_group
= g_new0(struct ctf_fs_ds_file_group
, 1);
648 if (!ds_file_group
) {
652 ds_file_group
->ds_file_infos
= g_ptr_array_new_with_free_func(
653 (GDestroyNotify
) ctf_fs_ds_file_info_destroy
);
654 if (!ds_file_group
->ds_file_infos
) {
658 ds_file_group
->index
= index
;
660 ds_file_group
->stream_id
= stream_instance_id
;
662 ds_file_group
->sc
= sc
;
663 ds_file_group
->ctf_fs_trace
= ctf_fs_trace
;
667 ctf_fs_ds_file_group_destroy(ds_file_group
);
668 ctf_fs_ds_index_destroy(index
);
669 ds_file_group
= NULL
;
672 return ds_file_group
;
675 /* Replace by g_ptr_array_insert when we depend on glib >= 2.40. */
677 void array_insert(GPtrArray
*array
, gpointer element
, size_t pos
)
679 size_t original_array_len
= array
->len
;
681 /* Allocate an unused element at the end of the array. */
682 g_ptr_array_add(array
, NULL
);
684 /* If we are not inserting at the end, move the elements by one. */
685 if (pos
< original_array_len
) {
686 memmove(&(array
->pdata
[pos
+ 1]),
687 &(array
->pdata
[pos
]),
688 (original_array_len
- pos
) * sizeof(gpointer
));
691 /* Insert the value. */
692 array
->pdata
[pos
] = element
;
696 * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right
697 * place to keep it sorted.
701 void ds_file_group_insert_ds_file_info_sorted(
702 struct ctf_fs_ds_file_group
*ds_file_group
,
703 struct ctf_fs_ds_file_info
*ds_file_info
)
707 /* Find the spot where to insert this ds_file_info. */
708 for (i
= 0; i
< ds_file_group
->ds_file_infos
->len
; i
++) {
709 struct ctf_fs_ds_file_info
*other_ds_file_info
=
710 g_ptr_array_index(ds_file_group
->ds_file_infos
, i
);
712 if (ds_file_info
->begin_ns
< other_ds_file_info
->begin_ns
) {
717 array_insert(ds_file_group
->ds_file_infos
, ds_file_info
, i
);
721 bool ds_index_entries_equal(
722 const struct ctf_fs_ds_index_entry
*left
,
723 const struct ctf_fs_ds_index_entry
*right
)
725 if (left
->packet_size
!= right
->packet_size
) {
729 if (left
->timestamp_begin
!= right
->timestamp_begin
) {
733 if (left
->timestamp_end
!= right
->timestamp_end
) {
737 if (left
->packet_seq_num
!= right
->packet_seq_num
) {
745 * Insert `entry` into `index`, without duplication.
747 * The entry is inserted only if there isn't an identical entry already.
749 * In any case, the ownership of `entry` is transferred to this function. So if
750 * the entry is not inserted, it is freed.
754 void ds_index_insert_ds_index_entry_sorted(
755 struct ctf_fs_ds_index
*index
,
756 struct ctf_fs_ds_index_entry
*entry
)
759 struct ctf_fs_ds_index_entry
*other_entry
;
761 /* Find the spot where to insert this index entry. */
762 for (i
= 0; i
< index
->entries
->len
; i
++) {
763 other_entry
= g_ptr_array_index(index
->entries
, i
);
765 if (entry
->timestamp_begin_ns
<= other_entry
->timestamp_begin_ns
) {
771 * Insert the entry only if a duplicate doesn't already exist.
773 * There can be duplicate packets if reading multiple overlapping
774 * snapshots of the same trace. We then want the index to contain
775 * a reference to only one copy of that packet.
777 if (i
== index
->entries
->len
||
778 !ds_index_entries_equal(entry
, other_entry
)) {
779 array_insert(index
->entries
, entry
, i
);
786 void merge_ctf_fs_ds_indexes(struct ctf_fs_ds_index
*dest
, struct ctf_fs_ds_index
*src
)
790 for (i
= 0; i
< src
->entries
->len
; i
++) {
791 struct ctf_fs_ds_index_entry
*entry
=
792 g_ptr_array_index(src
->entries
, i
);
795 * Ownership of the ctf_fs_ds_index_entry is transferred to
796 * ds_index_insert_ds_index_entry_sorted.
798 g_ptr_array_index(src
->entries
, i
) = NULL
;
799 ds_index_insert_ds_index_entry_sorted(dest
, entry
);
804 int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
,
807 int64_t stream_instance_id
= -1;
808 int64_t begin_ns
= -1;
809 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
810 bool add_group
= false;
813 struct ctf_fs_ds_file
*ds_file
= NULL
;
814 struct ctf_fs_ds_file_info
*ds_file_info
= NULL
;
815 struct ctf_fs_ds_index
*index
= NULL
;
816 struct ctf_msg_iter
*msg_iter
= NULL
;
817 struct ctf_stream_class
*sc
= NULL
;
818 struct ctf_msg_iter_packet_properties props
;
819 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
820 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
821 bt_self_component_class
*self_comp_class
= ctf_fs_trace
->self_comp_class
;
824 * Create a temporary ds_file to read some properties about the data
827 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, NULL
, path
,
833 /* Create a temporary iterator to read the ds_file. */
834 msg_iter
= ctf_msg_iter_create(ctf_fs_trace
->metadata
->tc
,
835 bt_common_get_page_size(log_level
) * 8,
836 ctf_fs_ds_file_medops
, ds_file
, log_level
, self_comp
, NULL
);
838 BT_COMP_LOGE_STR("Cannot create a CTF message iterator.");
842 ret
= ctf_msg_iter_get_packet_properties(msg_iter
, &props
);
844 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
845 "Cannot get stream file's first packet's header and context fields (`%s`).",
850 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
,
851 props
.stream_class_id
);
853 stream_instance_id
= props
.data_stream_id
;
855 if (props
.snapshots
.beginning_clock
!= UINT64_C(-1)) {
856 BT_ASSERT(sc
->default_clock_class
);
857 ret
= bt_util_clock_cycles_to_ns_from_origin(
858 props
.snapshots
.beginning_clock
,
859 sc
->default_clock_class
->frequency
,
860 sc
->default_clock_class
->offset_seconds
,
861 sc
->default_clock_class
->offset_cycles
, &begin_ns
);
863 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
864 "Cannot convert clock cycles to nanoseconds from origin (`%s`).",
870 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
);
875 index
= ctf_fs_ds_file_build_index(ds_file
, ds_file_info
, msg_iter
);
877 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
878 self_comp
, self_comp_class
,
879 "Failed to index CTF stream file \'%s\'",
880 ds_file
->file
->path
->str
);
884 if (begin_ns
== -1) {
886 * No beggining timestamp to sort the stream files
887 * within a stream file group, so consider that this
888 * file must be the only one within its group.
890 stream_instance_id
= -1;
893 if (stream_instance_id
== -1) {
895 * No stream instance ID or no beginning timestamp:
896 * create a unique stream file group for this stream
897 * file because, even if there's a stream instance ID,
898 * there's no timestamp to order the file within its
901 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
,
902 sc
, UINT64_C(-1), index
);
903 /* Ownership of index is transferred. */
906 if (!ds_file_group
) {
910 ds_file_group_insert_ds_file_info_sorted(ds_file_group
,
911 BT_MOVE_REF(ds_file_info
));
917 BT_ASSERT(stream_instance_id
!= -1);
918 BT_ASSERT(begin_ns
!= -1);
920 /* Find an existing stream file group with this ID */
921 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
922 ds_file_group
= g_ptr_array_index(
923 ctf_fs_trace
->ds_file_groups
, i
);
925 if (ds_file_group
->sc
== sc
&&
926 ds_file_group
->stream_id
==
927 stream_instance_id
) {
931 ds_file_group
= NULL
;
934 if (!ds_file_group
) {
935 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
,
936 sc
, stream_instance_id
, index
);
937 /* Ownership of index is transferred. */
939 if (!ds_file_group
) {
945 merge_ctf_fs_ds_indexes(ds_file_group
->index
, index
);
948 ds_file_group_insert_ds_file_info_sorted(ds_file_group
,
949 BT_MOVE_REF(ds_file_info
));
954 ctf_fs_ds_file_group_destroy(ds_file_group
);
955 ds_file_group
= NULL
;
959 if (add_group
&& ds_file_group
) {
960 g_ptr_array_add(ctf_fs_trace
->ds_file_groups
, ds_file_group
);
963 ctf_fs_ds_file_destroy(ds_file
);
964 ctf_fs_ds_file_info_destroy(ds_file_info
);
967 ctf_msg_iter_destroy(msg_iter
);
970 ctf_fs_ds_index_destroy(index
);
975 int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
978 const char *basename
;
979 GError
*error
= NULL
;
981 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
982 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
983 bt_self_component_class
*self_comp_class
= ctf_fs_trace
->self_comp_class
;
985 /* Check each file in the path directory, except specific ones */
986 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
988 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
989 "Cannot open directory `%s`: %s (code %d)",
990 ctf_fs_trace
->path
->str
, error
->message
,
995 while ((basename
= g_dir_read_name(dir
))) {
996 struct ctf_fs_file
*file
;
998 if (strcmp(basename
, CTF_FS_METADATA_FILENAME
) == 0) {
999 /* Ignore the metadata stream. */
1000 BT_COMP_LOGI("Ignoring metadata file `%s" G_DIR_SEPARATOR_S
"%s`",
1001 ctf_fs_trace
->path
->str
, basename
);
1005 if (basename
[0] == '.') {
1006 BT_COMP_LOGI("Ignoring hidden file `%s" G_DIR_SEPARATOR_S
"%s`",
1007 ctf_fs_trace
->path
->str
, basename
);
1011 /* Create the file. */
1012 file
= ctf_fs_file_create(log_level
, self_comp
);
1014 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1015 "Cannot create stream file object for file `%s" G_DIR_SEPARATOR_S
"%s`",
1016 ctf_fs_trace
->path
->str
, basename
);
1020 /* Create full path string. */
1021 g_string_append_printf(file
->path
, "%s" G_DIR_SEPARATOR_S
"%s",
1022 ctf_fs_trace
->path
->str
, basename
);
1023 if (!g_file_test(file
->path
->str
, G_FILE_TEST_IS_REGULAR
)) {
1024 BT_COMP_LOGI("Ignoring non-regular file `%s`",
1026 ctf_fs_file_destroy(file
);
1031 ret
= ctf_fs_file_open(file
, "rb");
1033 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1034 "Cannot open stream file `%s`",
1039 if (file
->size
== 0) {
1040 /* Skip empty stream. */
1041 BT_COMP_LOGI("Ignoring empty file `%s`", file
->path
->str
);
1042 ctf_fs_file_destroy(file
);
1046 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
,
1049 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1050 "Cannot add stream file `%s` to stream file group",
1052 ctf_fs_file_destroy(file
);
1056 ctf_fs_file_destroy(file
);
1071 g_error_free(error
);
1078 int set_trace_name(bt_trace
*trace
, const char *name_suffix
,
1079 bt_logging_level log_level
, bt_self_component
*self_comp
)
1082 const bt_value
*val
;
1085 name
= g_string_new(NULL
);
1087 BT_COMP_LOGE_STR("Failed to allocate a GString.");
1093 * Check if we have a trace environment string value named `hostname`.
1094 * If so, use it as the trace name's prefix.
1096 val
= bt_trace_borrow_environment_entry_value_by_name_const(
1098 if (val
&& bt_value_is_string(val
)) {
1099 g_string_append(name
, bt_value_string_get(val
));
1102 g_string_append_c(name
, G_DIR_SEPARATOR
);
1107 g_string_append(name
, name_suffix
);
1110 ret
= bt_trace_set_name(trace
, name
->str
);
1119 g_string_free(name
, TRUE
);
1126 struct ctf_fs_trace
*ctf_fs_trace_create(
1127 bt_self_component
*self_comp
,
1128 bt_self_component_class
*self_comp_class
,
1129 const char *path
, const char *name
,
1130 struct ctf_fs_metadata_config
*metadata_config
,
1131 bt_logging_level log_level
)
1133 struct ctf_fs_trace
*ctf_fs_trace
;
1136 /* Only one of them must be set. */
1137 BT_ASSERT(!self_comp
!= !self_comp_class
);
1139 ctf_fs_trace
= g_new0(struct ctf_fs_trace
, 1);
1140 if (!ctf_fs_trace
) {
1144 ctf_fs_trace
->log_level
= log_level
;
1145 ctf_fs_trace
->self_comp
= self_comp
;
1146 ctf_fs_trace
->self_comp_class
= self_comp_class
;
1147 ctf_fs_trace
->path
= g_string_new(path
);
1148 if (!ctf_fs_trace
->path
) {
1152 ctf_fs_trace
->metadata
= g_new0(struct ctf_fs_metadata
, 1);
1153 if (!ctf_fs_trace
->metadata
) {
1157 ctf_fs_metadata_init(ctf_fs_trace
->metadata
);
1158 ctf_fs_trace
->ds_file_groups
= g_ptr_array_new_with_free_func(
1159 (GDestroyNotify
) ctf_fs_ds_file_group_destroy
);
1160 if (!ctf_fs_trace
->ds_file_groups
) {
1164 ret
= ctf_fs_metadata_set_trace_class(self_comp
, ctf_fs_trace
,
1170 if (ctf_fs_trace
->metadata
->trace_class
) {
1171 ctf_fs_trace
->trace
=
1172 bt_trace_create(ctf_fs_trace
->metadata
->trace_class
);
1173 if (!ctf_fs_trace
->trace
) {
1178 if (ctf_fs_trace
->trace
) {
1179 ret
= ctf_trace_class_configure_ir_trace(
1180 ctf_fs_trace
->metadata
->tc
, ctf_fs_trace
->trace
);
1185 ret
= set_trace_name(ctf_fs_trace
->trace
, name
, log_level
,
1192 ret
= create_ds_file_groups(ctf_fs_trace
);
1200 ctf_fs_trace_destroy(ctf_fs_trace
);
1201 ctf_fs_trace
= NULL
;
1204 return ctf_fs_trace
;
1208 int path_is_ctf_trace(const char *path
)
1210 GString
*metadata_path
= g_string_new(NULL
);
1213 if (!metadata_path
) {
1218 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
1220 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
1226 g_string_free(metadata_path
, TRUE
);
1230 /* Helper for ctf_fs_component_create_ctf_fs_trace, to handle a single path. */
1233 int ctf_fs_component_create_ctf_fs_trace_one_path(
1234 struct ctf_fs_component
*ctf_fs
,
1235 const char *path_param
,
1236 const char *trace_name
,
1238 bt_self_component
*self_comp
,
1239 bt_self_component_class
*self_comp_class
)
1241 struct ctf_fs_trace
*ctf_fs_trace
;
1244 bt_logging_level log_level
= ctf_fs
->log_level
;
1246 norm_path
= bt_common_normalize_path(path_param
, NULL
);
1248 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1249 "Failed to normalize path: `%s`.",
1254 ret
= path_is_ctf_trace(norm_path
->str
);
1256 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1257 "Failed to check if path is a CTF trace: path=%s",
1260 } else if (ret
== 0) {
1261 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1262 "Path is not a CTF trace (does not contain a metadata file): `%s`.",
1267 // FIXME: Remove or ifdef for __MINGW32__
1268 if (strcmp(norm_path
->str
, "/") == 0) {
1269 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1270 "Opening a trace in `/` is not supported.");
1275 ctf_fs_trace
= ctf_fs_trace_create(self_comp
, self_comp_class
, norm_path
->str
,
1276 trace_name
, &ctf_fs
->metadata_config
, log_level
);
1277 if (!ctf_fs_trace
) {
1278 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1279 "Cannot create trace for `%s`.",
1284 g_ptr_array_add(traces
, ctf_fs_trace
);
1285 ctf_fs_trace
= NULL
;
1295 g_string_free(norm_path
, TRUE
);
1302 * Count the number of stream and event classes defined by this trace's metadata.
1304 * This is used to determine which metadata is the "latest", out of multiple
1305 * traces sharing the same UUID. It is assumed that amongst all these metadatas,
1306 * a bigger metadata is a superset of a smaller metadata. Therefore, it is
1307 * enough to just count the classes.
1311 unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace
*trace
)
1313 unsigned int num
= trace
->metadata
->tc
->stream_classes
->len
;
1316 for (i
= 0; i
< trace
->metadata
->tc
->stream_classes
->len
; i
++) {
1317 struct ctf_stream_class
*sc
= trace
->metadata
->tc
->stream_classes
->pdata
[i
];
1318 num
+= sc
->event_classes
->len
;
1325 * Merge the src ds_file_group into dest. This consists of merging their
1326 * ds_file_infos, making sure to keep the result sorted.
1330 void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group
*dest
, struct ctf_fs_ds_file_group
*src
)
1334 for (i
= 0; i
< src
->ds_file_infos
->len
; i
++) {
1335 struct ctf_fs_ds_file_info
*ds_file_info
=
1336 g_ptr_array_index(src
->ds_file_infos
, i
);
1338 /* Ownership of the ds_file_info is transferred to dest. */
1339 g_ptr_array_index(src
->ds_file_infos
, i
) = NULL
;
1341 ds_file_group_insert_ds_file_info_sorted(dest
, ds_file_info
);
1344 /* Merge both indexes. */
1345 merge_ctf_fs_ds_indexes(dest
->index
, src
->index
);
1347 /* Merge src_trace's data stream file groups into dest_trace's. */
1350 int merge_matching_ctf_fs_ds_file_groups(
1351 struct ctf_fs_trace
*dest_trace
,
1352 struct ctf_fs_trace
*src_trace
)
1355 GPtrArray
*dest
= dest_trace
->ds_file_groups
;
1356 GPtrArray
*src
= src_trace
->ds_file_groups
;
1361 * Save the initial length of dest: we only want to check against the
1362 * original elements in the inner loop.
1364 const guint dest_len
= dest
->len
;
1366 for (s_i
= 0; s_i
< src
->len
; s_i
++) {
1367 struct ctf_fs_ds_file_group
*src_group
= g_ptr_array_index(src
, s_i
);
1368 struct ctf_fs_ds_file_group
*dest_group
= NULL
;
1370 /* A stream instance without ID can't match a stream in the other trace. */
1371 if (src_group
->stream_id
!= -1) {
1374 /* Let's search for a matching ds_file_group in the destination. */
1375 for (d_i
= 0; d_i
< dest_len
; d_i
++) {
1376 struct ctf_fs_ds_file_group
*candidate_dest
= g_ptr_array_index(dest
, d_i
);
1378 /* Can't match a stream instance without ID. */
1379 if (candidate_dest
->stream_id
== -1) {
1384 * If the two groups have the same stream instance id
1385 * and belong to the same stream class (stream instance
1386 * ids are per-stream class), they represent the same
1389 if (candidate_dest
->stream_id
!= src_group
->stream_id
||
1390 candidate_dest
->sc
->id
!= src_group
->sc
->id
) {
1394 dest_group
= candidate_dest
;
1400 * Didn't find a friend in dest to merge our src_group into?
1401 * Create a new empty one. This can happen if a stream was
1402 * active in the source trace chunk but not in the destination
1406 struct ctf_stream_class
*sc
;
1407 struct ctf_fs_ds_index
*index
;
1409 sc
= ctf_trace_class_borrow_stream_class_by_id(
1410 dest_trace
->metadata
->tc
, src_group
->sc
->id
);
1413 index
= ctf_fs_ds_index_create(dest_trace
->log_level
,
1414 dest_trace
->self_comp
);
1420 dest_group
= ctf_fs_ds_file_group_create(dest_trace
, sc
,
1421 src_group
->stream_id
, index
);
1422 /* Ownership of index is transferred. */
1429 g_ptr_array_add(dest_trace
->ds_file_groups
, dest_group
);
1432 BT_ASSERT(dest_group
);
1433 merge_ctf_fs_ds_file_groups(dest_group
, src_group
);
1441 * Collapse the given traces, which must all share the same UUID, in a single
1444 * The trace with the most expansive metadata is chosen and all other traces
1445 * are merged into that one. The array slots of all the traces that get merged
1446 * in the chosen one are set to NULL, so only the slot of the chosen trace
1451 int merge_ctf_fs_traces(struct ctf_fs_trace
**traces
, unsigned int num_traces
,
1452 struct ctf_fs_trace
**out_trace
)
1454 unsigned int winner_count
;
1455 struct ctf_fs_trace
*winner
;
1459 BT_ASSERT(num_traces
>= 2);
1461 winner_count
= metadata_count_stream_and_event_classes(traces
[0]);
1465 /* Find the trace with the largest metadata. */
1466 for (i
= 1; i
< num_traces
; i
++) {
1467 struct ctf_fs_trace
*candidate
;
1468 unsigned int candidate_count
;
1470 candidate
= traces
[i
];
1472 /* A bit of sanity check. */
1473 BT_ASSERT(bt_uuid_compare(winner
->metadata
->tc
->uuid
, candidate
->metadata
->tc
->uuid
) == 0);
1475 candidate_count
= metadata_count_stream_and_event_classes(candidate
);
1477 if (candidate_count
> winner_count
) {
1478 winner_count
= candidate_count
;
1484 /* Merge all the other traces in the winning trace. */
1485 for (i
= 0; i
< num_traces
; i
++) {
1486 struct ctf_fs_trace
*trace
= traces
[i
];
1488 /* Don't merge the winner into itself. */
1489 if (trace
== winner
) {
1493 /* Merge trace's data stream file groups into winner's. */
1494 ret
= merge_matching_ctf_fs_ds_file_groups(winner
, trace
);
1501 * Move the winner out of the array, into `*out_trace`.
1503 *out_trace
= winner
;
1504 traces
[winner_i
] = NULL
;
1516 int decode_clock_snapshot_after_event(struct ctf_fs_trace
*ctf_fs_trace
,
1517 struct ctf_clock_class
*default_cc
,
1518 struct ctf_fs_ds_index_entry
*index_entry
,
1519 enum target_event target_event
, uint64_t *cs
, int64_t *ts_ns
)
1521 enum ctf_msg_iter_status iter_status
= CTF_MSG_ITER_STATUS_OK
;
1522 struct ctf_fs_ds_file
*ds_file
= NULL
;
1523 struct ctf_msg_iter
*msg_iter
= NULL
;
1524 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
1525 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
1528 BT_ASSERT(ctf_fs_trace
);
1529 BT_ASSERT(index_entry
);
1530 BT_ASSERT(index_entry
->path
);
1532 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
,
1533 NULL
, index_entry
->path
, log_level
);
1535 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Failed to create a ctf_fs_ds_file");
1540 BT_ASSERT(ctf_fs_trace
->metadata
);
1541 BT_ASSERT(ctf_fs_trace
->metadata
->tc
);
1543 msg_iter
= ctf_msg_iter_create(ctf_fs_trace
->metadata
->tc
,
1544 bt_common_get_page_size(log_level
) * 8, ctf_fs_ds_file_medops
,
1545 ds_file
, log_level
, self_comp
, NULL
);
1547 /* ctf_msg_iter_create() logs errors. */
1553 * Turn on dry run mode to prevent the creation and usage of Babeltrace
1554 * library objects (bt_field, bt_message_*, etc.).
1556 ctf_msg_iter_set_dry_run(msg_iter
, true);
1558 /* Seek to the beginning of the target packet. */
1559 iter_status
= ctf_msg_iter_seek(msg_iter
, index_entry
->offset
);
1561 /* ctf_msg_iter_seek() logs errors. */
1566 switch (target_event
) {
1569 * Start to decode the packet until we reach the end of
1570 * the first event. To extract the first event's clock
1573 iter_status
= ctf_msg_iter_curr_packet_first_event_clock_snapshot(
1577 /* Decode the packet to extract the last event's clock snapshot. */
1578 iter_status
= ctf_msg_iter_curr_packet_last_event_clock_snapshot(
1589 /* Convert clock snapshot to timestamp. */
1590 ret
= bt_util_clock_cycles_to_ns_from_origin(*cs
,
1591 default_cc
->frequency
, default_cc
->offset_seconds
,
1592 default_cc
->offset_cycles
, ts_ns
);
1594 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1595 "Failed to convert clock snapshot to timestamp");
1601 ctf_fs_ds_file_destroy(ds_file
);
1604 ctf_msg_iter_destroy(msg_iter
);
1611 int decode_packet_first_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1612 struct ctf_clock_class
*default_cc
,
1613 struct ctf_fs_ds_index_entry
*index_entry
, uint64_t *cs
, int64_t *ts_ns
)
1615 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
,
1616 index_entry
, FIRST_EVENT
, cs
, ts_ns
);
1620 int decode_packet_last_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1621 struct ctf_clock_class
*default_cc
,
1622 struct ctf_fs_ds_index_entry
*index_entry
, uint64_t *cs
, int64_t *ts_ns
)
1624 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
,
1625 index_entry
, LAST_EVENT
, cs
, ts_ns
);
1629 * Fix up packet index entries for lttng's "event-after-packet" bug.
1630 * Some buggy lttng tracer versions may emit events with a timestamp that is
1631 * larger (after) than the timestamp_end of the their packets.
1633 * To fix up this erroneous data we do the following:
1634 * 1. If it's not the stream file's last packet: set the packet index entry's
1635 * end time to the next packet's beginning time.
1636 * 2. If it's the stream file's last packet, set the packet index entry's end
1637 * time to the packet's last event's time, if any, or to the packet's
1638 * beginning time otherwise.
1640 * Known buggy tracer versions:
1641 * - before lttng-ust 2.11.0
1642 * - before lttng-module 2.11.0
1643 * - before lttng-module 2.10.10
1644 * - before lttng-module 2.9.13
1647 int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace
*trace
)
1650 guint ds_file_group_i
;
1651 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1652 bt_logging_level log_level
= trace
->log_level
;
1654 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
;
1655 ds_file_group_i
++) {
1657 struct ctf_clock_class
*default_cc
;
1658 struct ctf_fs_ds_index_entry
*last_entry
;
1659 struct ctf_fs_ds_index
*index
;
1661 struct ctf_fs_ds_file_group
*ds_file_group
=
1662 g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1664 BT_ASSERT(ds_file_group
);
1665 index
= ds_file_group
->index
;
1668 BT_ASSERT(index
->entries
);
1669 BT_ASSERT(index
->entries
->len
> 0);
1672 * Iterate over all entries but the last one. The last one is
1673 * fixed differently after.
1675 for (entry_i
= 0; entry_i
< index
->entries
->len
- 1;
1677 struct ctf_fs_ds_index_entry
*curr_entry
, *next_entry
;
1679 curr_entry
= g_ptr_array_index(index
->entries
, entry_i
);
1680 next_entry
= g_ptr_array_index(index
->entries
, entry_i
+ 1);
1683 * 1. Set the current index entry `end` timestamp to
1684 * the next index entry `begin` timestamp.
1686 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1687 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1691 * 2. Fix the last entry by decoding the last event of the last
1694 last_entry
= g_ptr_array_index(index
->entries
,
1695 index
->entries
->len
- 1);
1696 BT_ASSERT(last_entry
);
1698 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1699 default_cc
= ds_file_group
->sc
->default_clock_class
;
1702 * Decode packet to read the timestamp of the last event of the
1705 ret
= decode_packet_last_event_timestamp(trace
, default_cc
,
1706 last_entry
, &last_entry
->timestamp_end
,
1707 &last_entry
->timestamp_end_ns
);
1709 BT_COMP_LOGE_APPEND_CAUSE(trace
->self_comp
,
1710 "Failed to decode stream's last packet to get its last event's clock snapshot.");
1720 * Fix up packet index entries for barectf's "event-before-packet" bug.
1721 * Some buggy barectf tracer versions may emit events with a timestamp that is
1722 * less than the timestamp_begin of the their packets.
1724 * To fix up this erroneous data we do the following:
1725 * 1. Starting at the second index entry, set the timestamp_begin of the
1726 * current entry to the timestamp of the first event of the packet.
1727 * 2. Set the previous entry's timestamp_end to the timestamp_begin of the
1730 * Known buggy tracer versions:
1731 * - before barectf 2.3.1
1734 int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace
*trace
)
1737 guint ds_file_group_i
;
1738 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1739 bt_logging_level log_level
= trace
->log_level
;
1741 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
;
1742 ds_file_group_i
++) {
1744 struct ctf_clock_class
*default_cc
;
1745 struct ctf_fs_ds_file_group
*ds_file_group
=
1746 g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1748 struct ctf_fs_ds_index
*index
= ds_file_group
->index
;
1751 BT_ASSERT(index
->entries
);
1752 BT_ASSERT(index
->entries
->len
> 0);
1754 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1755 default_cc
= ds_file_group
->sc
->default_clock_class
;
1758 * 1. Iterate over the index, starting from the second entry
1761 for (entry_i
= 1; entry_i
< index
->entries
->len
;
1763 struct ctf_fs_ds_index_entry
*curr_entry
, *prev_entry
;
1764 prev_entry
= g_ptr_array_index(index
->entries
, entry_i
- 1);
1765 curr_entry
= g_ptr_array_index(index
->entries
, entry_i
);
1767 * 2. Set the current entry `begin` timestamp to the
1768 * timestamp of the first event of the current packet.
1770 ret
= decode_packet_first_event_timestamp(trace
, default_cc
,
1771 curr_entry
, &curr_entry
->timestamp_begin
,
1772 &curr_entry
->timestamp_begin_ns
);
1774 BT_COMP_LOGE_APPEND_CAUSE(trace
->self_comp
,
1775 "Failed to decode first event's clock snapshot");
1780 * 3. Set the previous entry `end` timestamp to the
1781 * timestamp of the first event of the current packet.
1783 prev_entry
->timestamp_end
= curr_entry
->timestamp_begin
;
1784 prev_entry
->timestamp_end_ns
= curr_entry
->timestamp_begin_ns
;
1792 * When using the lttng-crash feature it's likely that the last packets of each
1793 * stream have their timestamp_end set to zero. This is caused by the fact that
1794 * the tracer crashed and was not able to properly close the packets.
1796 * To fix up this erroneous data we do the following:
1797 * For each index entry, if the entry's timestamp_end is 0 and the
1798 * timestamp_begin is not 0:
1799 * - If it's the stream file's last packet: set the packet index entry's end
1800 * time to the packet's last event's time, if any, or to the packet's
1801 * beginning time otherwise.
1802 * - If it's not the stream file's last packet: set the packet index
1803 * entry's end time to the next packet's beginning time.
1805 * Affected versions:
1806 * - All current and future lttng-ust and lttng-modules versions.
1809 int fix_index_lttng_crash_quirk(struct ctf_fs_trace
*trace
)
1812 guint ds_file_group_idx
;
1813 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1814 bt_logging_level log_level
= trace
->log_level
;
1816 for (ds_file_group_idx
= 0; ds_file_group_idx
< ds_file_groups
->len
;
1817 ds_file_group_idx
++) {
1819 struct ctf_clock_class
*default_cc
;
1820 struct ctf_fs_ds_index_entry
*last_entry
;
1821 struct ctf_fs_ds_index
*index
;
1823 struct ctf_fs_ds_file_group
*ds_file_group
=
1824 g_ptr_array_index(ds_file_groups
, ds_file_group_idx
);
1826 BT_ASSERT(ds_file_group
);
1827 index
= ds_file_group
->index
;
1829 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1830 default_cc
= ds_file_group
->sc
->default_clock_class
;
1833 BT_ASSERT(index
->entries
);
1834 BT_ASSERT(index
->entries
->len
> 0);
1836 last_entry
= g_ptr_array_index(index
->entries
,
1837 index
->entries
->len
- 1);
1838 BT_ASSERT(last_entry
);
1841 /* 1. Fix the last entry first. */
1842 if (last_entry
->timestamp_end
== 0 &&
1843 last_entry
->timestamp_begin
!= 0) {
1845 * Decode packet to read the timestamp of the
1846 * last event of the stream file.
1848 ret
= decode_packet_last_event_timestamp(trace
,
1849 default_cc
, last_entry
,
1850 &last_entry
->timestamp_end
,
1851 &last_entry
->timestamp_end_ns
);
1853 BT_COMP_LOGE_APPEND_CAUSE(trace
->self_comp
,
1854 "Failed to decode last event's clock snapshot");
1859 /* Iterate over all entries but the last one. */
1860 for (entry_idx
= 0; entry_idx
< index
->entries
->len
- 1;
1862 struct ctf_fs_ds_index_entry
*curr_entry
, *next_entry
;
1863 curr_entry
= g_ptr_array_index(index
->entries
, entry_idx
);
1864 next_entry
= g_ptr_array_index(index
->entries
, entry_idx
+ 1);
1866 if (curr_entry
->timestamp_end
== 0 &&
1867 curr_entry
->timestamp_begin
!= 0) {
1869 * 2. Set the current index entry `end` timestamp to
1870 * the next index entry `begin` timestamp.
1872 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1873 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1883 * Extract the tracer information necessary to compare versions.
1884 * Returns 0 on success, and -1 if the extraction is not successful because the
1885 * necessary fields are absents in the trace metadata.
1888 int extract_tracer_info(struct ctf_fs_trace
*trace
,
1889 struct tracer_info
*current_tracer_info
)
1892 struct ctf_trace_class_env_entry
*entry
;
1894 /* Clear the current_tracer_info struct */
1895 memset(current_tracer_info
, 0, sizeof(*current_tracer_info
));
1898 * To compare 2 tracer versions, at least the tracer name and it's
1899 * major version are needed. If one of these is missing, consider it an
1900 * extraction failure.
1902 entry
= ctf_trace_class_borrow_env_entry_by_name(
1903 trace
->metadata
->tc
, "tracer_name");
1904 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR
) {
1905 goto missing_bare_minimum
;
1908 /* Set tracer name. */
1909 current_tracer_info
->name
= entry
->value
.str
->str
;
1911 entry
= ctf_trace_class_borrow_env_entry_by_name(
1912 trace
->metadata
->tc
, "tracer_major");
1913 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1914 goto missing_bare_minimum
;
1917 /* Set major version number. */
1918 current_tracer_info
->major
= entry
->value
.i
;
1920 entry
= ctf_trace_class_borrow_env_entry_by_name(
1921 trace
->metadata
->tc
, "tracer_minor");
1922 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1926 /* Set minor version number. */
1927 current_tracer_info
->minor
= entry
->value
.i
;
1929 entry
= ctf_trace_class_borrow_env_entry_by_name(
1930 trace
->metadata
->tc
, "tracer_patch");
1933 * If `tracer_patch` doesn't exist `tracer_patchlevel` might.
1934 * For example, `lttng-modules` uses entry name
1935 * `tracer_patchlevel`.
1937 entry
= ctf_trace_class_borrow_env_entry_by_name(
1938 trace
->metadata
->tc
, "tracer_patchlevel");
1941 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1945 /* Set patch version number. */
1946 current_tracer_info
->patch
= entry
->value
.i
;
1950 missing_bare_minimum
:
1957 bool is_tracer_affected_by_lttng_event_after_packet_bug(
1958 struct tracer_info
*curr_tracer_info
)
1960 bool is_affected
= false;
1962 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1963 if (curr_tracer_info
->major
< 2) {
1965 } else if (curr_tracer_info
->major
== 2) {
1966 /* fixed in lttng-ust 2.11.0 */
1967 if (curr_tracer_info
->minor
< 11) {
1971 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1972 if (curr_tracer_info
->major
< 2) {
1974 } else if (curr_tracer_info
->major
== 2) {
1975 /* fixed in lttng-modules 2.11.0 */
1976 if (curr_tracer_info
->minor
== 10) {
1977 /* fixed in lttng-modules 2.10.10 */
1978 if (curr_tracer_info
->patch
< 10) {
1981 } else if (curr_tracer_info
->minor
== 9) {
1982 /* fixed in lttng-modules 2.9.13 */
1983 if (curr_tracer_info
->patch
< 13) {
1986 } else if (curr_tracer_info
->minor
< 9) {
1996 bool is_tracer_affected_by_barectf_event_before_packet_bug(
1997 struct tracer_info
*curr_tracer_info
)
1999 bool is_affected
= false;
2001 if (strcmp(curr_tracer_info
->name
, "barectf") == 0) {
2002 if (curr_tracer_info
->major
< 2) {
2004 } else if (curr_tracer_info
->major
== 2) {
2005 if (curr_tracer_info
->minor
< 3) {
2007 } else if (curr_tracer_info
->minor
== 3) {
2008 /* fixed in barectf 2.3.1 */
2009 if (curr_tracer_info
->patch
< 1) {
2020 bool is_tracer_affected_by_lttng_crash_quirk(
2021 struct tracer_info
*curr_tracer_info
)
2023 bool is_affected
= false;
2025 /* All LTTng tracer may be affected by this lttng crash quirk. */
2026 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
2028 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
2036 * Looks for trace produced by known buggy tracers and fix up the index
2040 int fix_packet_index_tracer_bugs(struct ctf_fs_component
*ctf_fs
,
2041 bt_self_component
*self_comp
,
2042 bt_self_component_class
*self_comp_class
)
2045 struct tracer_info current_tracer_info
;
2046 bt_logging_level log_level
= ctf_fs
->log_level
;
2048 ret
= extract_tracer_info(ctf_fs
->trace
, ¤t_tracer_info
);
2051 * A trace may not have all the necessary environment
2052 * entries to do the tracer version comparison.
2053 * At least, the tracer name and major version number
2054 * are needed. Failing to extract these entries is not
2058 BT_LOGI_STR("Cannot extract tracer information necessary to compare with buggy versions.");
2062 /* Check if the trace may be affected by old tracer bugs. */
2063 if (is_tracer_affected_by_lttng_event_after_packet_bug(
2064 ¤t_tracer_info
)) {
2065 BT_LOGI_STR("Trace may be affected by LTTng tracer packet timestamp bug. Fixing up.");
2066 ret
= fix_index_lttng_event_after_packet_bug(ctf_fs
->trace
);
2068 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
2069 self_comp
, self_comp_class
,
2070 "Failed to fix LTTng event-after-packet bug.");
2073 ctf_fs
->trace
->metadata
->tc
->quirks
.lttng_event_after_packet
= true;
2076 if (is_tracer_affected_by_barectf_event_before_packet_bug(
2077 ¤t_tracer_info
)) {
2078 BT_LOGI_STR("Trace may be affected by barectf tracer packet timestamp bug. Fixing up.");
2079 ret
= fix_index_barectf_event_before_packet_bug(ctf_fs
->trace
);
2081 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
2082 self_comp
, self_comp_class
,
2083 "Failed to fix barectf event-before-packet bug.");
2086 ctf_fs
->trace
->metadata
->tc
->quirks
.barectf_event_before_packet
= true;
2089 if (is_tracer_affected_by_lttng_crash_quirk(
2090 ¤t_tracer_info
)) {
2091 ret
= fix_index_lttng_crash_quirk(ctf_fs
->trace
);
2093 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
2094 self_comp
, self_comp_class
,
2095 "Failed to fix lttng-crash timestamp quirks.");
2098 ctf_fs
->trace
->metadata
->tc
->quirks
.lttng_crash
= true;
2106 gint
compare_ds_file_groups_by_first_path(gconstpointer a
, gconstpointer b
)
2108 struct ctf_fs_ds_file_group
* const *ds_file_group_a
= a
;
2109 struct ctf_fs_ds_file_group
* const *ds_file_group_b
= b
;
2110 const struct ctf_fs_ds_file_info
*first_ds_file_info_a
;
2111 const struct ctf_fs_ds_file_info
*first_ds_file_info_b
;
2113 BT_ASSERT((*ds_file_group_a
)->ds_file_infos
->len
> 0);
2114 BT_ASSERT((*ds_file_group_b
)->ds_file_infos
->len
> 0);
2115 first_ds_file_info_a
= (*ds_file_group_a
)->ds_file_infos
->pdata
[0];
2116 first_ds_file_info_b
= (*ds_file_group_b
)->ds_file_infos
->pdata
[0];
2117 return strcmp(first_ds_file_info_a
->path
->str
,
2118 first_ds_file_info_b
->path
->str
);
2121 int ctf_fs_component_create_ctf_fs_trace(
2122 struct ctf_fs_component
*ctf_fs
,
2123 const bt_value
*paths_value
,
2124 const bt_value
*trace_name_value
,
2125 bt_self_component
*self_comp
,
2126 bt_self_component_class
*self_comp_class
)
2130 bt_logging_level log_level
= ctf_fs
->log_level
;
2132 const char *trace_name
;
2134 BT_ASSERT(bt_value_get_type(paths_value
) == BT_VALUE_TYPE_ARRAY
);
2135 BT_ASSERT(!bt_value_array_is_empty(paths_value
));
2137 traces
= g_ptr_array_new_with_free_func(ctf_fs_trace_destroy_notifier
);
2139 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2140 "Failed to allocate a GPtrArray.");
2144 trace_name
= trace_name_value
? bt_value_string_get(trace_name_value
) : NULL
;
2146 /* Start by creating a separate ctf_fs_trace object for each path. */
2147 for (i
= 0; i
< bt_value_array_get_length(paths_value
); i
++) {
2148 const bt_value
*path_value
= bt_value_array_borrow_element_by_index_const(paths_value
, i
);
2149 const char *input
= bt_value_string_get(path_value
);
2151 ret
= ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs
,
2152 input
, trace_name
, traces
, self_comp
, self_comp_class
);
2158 if (traces
->len
> 1) {
2159 struct ctf_fs_trace
*first_trace
= (struct ctf_fs_trace
*) traces
->pdata
[0];
2160 const uint8_t *first_trace_uuid
= first_trace
->metadata
->tc
->uuid
;
2161 struct ctf_fs_trace
*trace
;
2164 * We have more than one trace, they must all share the same
2165 * UUID, verify that.
2167 for (i
= 0; i
< traces
->len
; i
++) {
2168 struct ctf_fs_trace
*this_trace
=
2169 (struct ctf_fs_trace
*) traces
->pdata
[i
];
2170 const uint8_t *this_trace_uuid
= this_trace
->metadata
->tc
->uuid
;
2172 if (!this_trace
->metadata
->tc
->is_uuid_set
) {
2173 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2174 "Multiple traces given, but a trace does not have a UUID: path=%s",
2175 this_trace
->path
->str
);
2179 if (bt_uuid_compare(first_trace_uuid
, this_trace_uuid
) != 0) {
2180 char first_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
2181 char this_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
2183 bt_uuid_to_str(first_trace_uuid
, first_trace_uuid_str
);
2184 bt_uuid_to_str(this_trace_uuid
, this_trace_uuid_str
);
2186 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2187 "Multiple traces given, but UUIDs don't match: "
2188 "first-trace-uuid=%s, first-trace-path=%s, "
2189 "trace-uuid=%s, trace-path=%s",
2190 first_trace_uuid_str
, first_trace
->path
->str
,
2191 this_trace_uuid_str
, this_trace
->path
->str
);
2196 ret
= merge_ctf_fs_traces((struct ctf_fs_trace
**) traces
->pdata
,
2197 traces
->len
, &trace
);
2199 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2200 "Failed to merge traces with the same UUID.");
2204 ctf_fs
->trace
= trace
;
2206 /* Just one trace, it may or may not have a UUID, both are fine. */
2207 ctf_fs
->trace
= traces
->pdata
[0];
2208 traces
->pdata
[0] = NULL
;
2211 ret
= fix_packet_index_tracer_bugs(ctf_fs
, self_comp
, self_comp_class
);
2213 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2214 "Failed to fix packet index tracer bugs.");
2218 * Sort data stream file groups by first data stream file info
2219 * path to get a deterministic order. This order influences the
2220 * order of the output ports. It also influences the order of
2221 * the automatic stream IDs if the trace's packet headers do not
2222 * contain a `stream_instance_id` field, in which case the data
2223 * stream file to stream ID association is always the same,
2224 * whatever the build and the system.
2226 * Having a deterministic order here can help debugging and
2229 g_ptr_array_sort(ctf_fs
->trace
->ds_file_groups
,
2230 compare_ds_file_groups_by_first_path
);
2236 g_ptr_array_free(traces
, TRUE
);
2241 GString
*get_stream_instance_unique_name(
2242 struct ctf_fs_ds_file_group
*ds_file_group
)
2245 struct ctf_fs_ds_file_info
*ds_file_info
;
2247 name
= g_string_new(NULL
);
2253 * If there's more than one stream file in the stream file
2254 * group, the first (earliest) stream file's path is used as
2255 * the stream's unique name.
2257 BT_ASSERT(ds_file_group
->ds_file_infos
->len
> 0);
2258 ds_file_info
= g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
2259 g_string_assign(name
, ds_file_info
->path
->str
);
2265 /* Create the IR stream objects for ctf_fs_trace. */
2268 int create_streams_for_trace(struct ctf_fs_trace
*ctf_fs_trace
)
2271 GString
*name
= NULL
;
2273 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
2274 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
2276 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
2277 struct ctf_fs_ds_file_group
*ds_file_group
=
2278 g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
2279 name
= get_stream_instance_unique_name(ds_file_group
);
2285 if (ds_file_group
->sc
->ir_sc
) {
2286 BT_ASSERT(ctf_fs_trace
->trace
);
2288 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
2289 /* No stream ID: use 0 */
2290 ds_file_group
->stream
= bt_stream_create_with_id(
2291 ds_file_group
->sc
->ir_sc
,
2292 ctf_fs_trace
->trace
,
2293 ctf_fs_trace
->next_stream_id
);
2294 ctf_fs_trace
->next_stream_id
++;
2296 /* Specific stream ID */
2297 ds_file_group
->stream
= bt_stream_create_with_id(
2298 ds_file_group
->sc
->ir_sc
,
2299 ctf_fs_trace
->trace
,
2300 (uint64_t) ds_file_group
->stream_id
);
2303 ds_file_group
->stream
= NULL
;
2306 if (!ds_file_group
->stream
) {
2307 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2308 "Cannot create stream for DS file group: "
2309 "addr=%p, stream-name=\"%s\"",
2310 ds_file_group
, name
->str
);
2314 ret
= bt_stream_set_name(ds_file_group
->stream
,
2317 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Cannot set stream's name: "
2318 "addr=%p, stream-name=\"%s\"",
2319 ds_file_group
->stream
, name
->str
);
2323 g_string_free(name
, TRUE
);
2336 g_string_free(name
, TRUE
);
2341 static const struct bt_param_validation_value_descr inputs_elem_descr
= {
2342 .type
= BT_VALUE_TYPE_STRING
,
2345 static const struct bt_param_validation_map_value_entry_descr fs_params_entries_descr
[] = {
2346 { "inputs", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
, {
2347 BT_VALUE_TYPE_ARRAY
,
2350 .max_length
= BT_PARAM_VALIDATION_INFINITE
,
2351 .element_type
= &inputs_elem_descr
,
2354 { "trace-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_STRING
} },
2355 { "clock-class-offset-s", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_SIGNED_INTEGER
} },
2356 { "clock-class-offset-ns", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_SIGNED_INTEGER
} },
2357 { "force-clock-class-origin-unix-epoch", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_BOOL
} },
2358 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
2362 bool read_src_fs_parameters(const bt_value
*params
,
2363 const bt_value
**inputs
,
2364 const bt_value
**trace_name
,
2365 struct ctf_fs_component
*ctf_fs
,
2366 bt_self_component
*self_comp
,
2367 bt_self_component_class
*self_comp_class
) {
2369 const bt_value
*value
;
2370 bt_logging_level log_level
= ctf_fs
->log_level
;
2371 enum bt_param_validation_status validate_value_status
;
2372 gchar
*error
= NULL
;
2374 validate_value_status
= bt_param_validation_validate(params
,
2375 fs_params_entries_descr
, &error
);
2376 if (validate_value_status
!= BT_PARAM_VALIDATION_STATUS_OK
) {
2377 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2383 /* inputs parameter */
2384 *inputs
= bt_value_map_borrow_entry_value_const(params
, "inputs");
2386 /* clock-class-offset-s parameter */
2387 value
= bt_value_map_borrow_entry_value_const(params
,
2388 "clock-class-offset-s");
2390 ctf_fs
->metadata_config
.clock_class_offset_s
=
2391 bt_value_integer_signed_get(value
);
2394 /* clock-class-offset-ns parameter */
2395 value
= bt_value_map_borrow_entry_value_const(params
,
2396 "clock-class-offset-ns");
2398 ctf_fs
->metadata_config
.clock_class_offset_ns
=
2399 bt_value_integer_signed_get(value
);
2402 /* force-clock-class-origin-unix-epoch parameter */
2403 value
= bt_value_map_borrow_entry_value_const(params
,
2404 "force-clock-class-origin-unix-epoch");
2406 ctf_fs
->metadata_config
.force_clock_class_origin_unix_epoch
=
2407 bt_value_bool_get(value
);
2410 /* trace-name parameter */
2411 *trace_name
= bt_value_map_borrow_entry_value_const(params
, "trace-name");
2421 struct ctf_fs_component
*ctf_fs_create(
2422 const bt_value
*params
,
2423 bt_self_component_source
*self_comp_src
)
2425 struct ctf_fs_component
*ctf_fs
= NULL
;
2426 const bt_value
*inputs_value
;
2427 const bt_value
*trace_name_value
;
2428 bt_self_component
*self_comp
=
2429 bt_self_component_source_as_self_component(self_comp_src
);
2431 ctf_fs
= ctf_fs_component_create(bt_component_get_logging_level(
2432 bt_self_component_as_component(self_comp
)), self_comp
);
2437 if (!read_src_fs_parameters(params
, &inputs_value
, &trace_name_value
,
2438 ctf_fs
, self_comp
, NULL
)) {
2442 bt_self_component_set_data(self_comp
, ctf_fs
);
2444 if (ctf_fs_component_create_ctf_fs_trace(ctf_fs
, inputs_value
,
2445 trace_name_value
, self_comp
, NULL
)) {
2449 if (create_streams_for_trace(ctf_fs
->trace
)) {
2453 if (create_ports_for_trace(ctf_fs
, ctf_fs
->trace
, self_comp_src
)) {
2460 ctf_fs_destroy(ctf_fs
);
2462 bt_self_component_set_data(self_comp
, NULL
);
2469 bt_component_class_initialize_method_status
ctf_fs_init(
2470 bt_self_component_source
*self_comp_src
,
2471 bt_self_component_source_configuration
*config
,
2472 const bt_value
*params
, __attribute__((unused
)) void *init_method_data
)
2474 struct ctf_fs_component
*ctf_fs
;
2475 bt_component_class_initialize_method_status ret
=
2476 BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
2478 ctf_fs
= ctf_fs_create(params
, self_comp_src
);
2480 ret
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
2487 bt_component_class_query_method_status
ctf_fs_query(
2488 bt_self_component_class_source
*comp_class
,
2489 bt_private_query_executor
*priv_query_exec
,
2490 const char *object
, const bt_value
*params
,
2491 __attribute__((unused
)) void *method_data
,
2492 const bt_value
**result
)
2494 bt_component_class_query_method_status status
=
2495 BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
2496 bt_logging_level log_level
= bt_query_executor_get_logging_level(
2497 bt_private_query_executor_as_query_executor_const(
2500 if (strcmp(object
, "metadata-info") == 0) {
2501 status
= metadata_info_query(comp_class
, params
, log_level
,
2503 } else if (strcmp(object
, "babeltrace.trace-infos") == 0) {
2504 status
= trace_infos_query(comp_class
, params
, log_level
,
2506 } else if (!strcmp(object
, "babeltrace.support-info")) {
2507 status
= support_info_query(comp_class
, params
, log_level
, result
);
2509 BT_LOGE("Unknown query object `%s`", object
);
2510 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;