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_message_iterator_class_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_message_iterator_class_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_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
95 case CTF_MSG_ITER_STATUS_EOF
:
96 status
= BT_MESSAGE_ITERATOR_CLASS_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_MESSAGE_ITERATOR_CLASS_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_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
127 bt_message_iterator_class_next_method_status
ctf_fs_iterator_next(
128 bt_self_message_iterator
*iterator
,
129 bt_message_array_const msgs
, uint64_t capacity
,
132 bt_message_iterator_class_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_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
) {
153 } while (i
< capacity
&&
154 status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
);
158 * Even if ctf_fs_iterator_next_one() returned something
159 * else than BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK, we
160 * accumulated message objects in the output
161 * message array, so we need to return
162 * BT_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_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
189 bt_message_iterator_class_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_MESSAGE_ITERATOR_CLASS_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_message_iterator_class_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
*self_comp
,
215 bt_self_component_port_output
*self_port
)
217 struct ctf_fs_port_data
*port_data
;
218 struct ctf_fs_msg_iter_data
*msg_iter_data
= NULL
;
219 bt_message_iterator_class_initialize_method_status status
;
220 bt_logging_level log_level
;
221 enum ctf_msg_iter_medium_status medium_status
;
223 port_data
= bt_self_component_port_get_data(
224 bt_self_component_port_output_as_self_component_port(
226 BT_ASSERT(port_data
);
227 log_level
= port_data
->ctf_fs
->log_level
;
228 msg_iter_data
= g_new0(struct ctf_fs_msg_iter_data
, 1);
229 if (!msg_iter_data
) {
230 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
234 msg_iter_data
->log_level
= log_level
;
235 msg_iter_data
->self_comp
= self_comp
;
236 msg_iter_data
->self_msg_iter
= self_msg_iter
;
237 msg_iter_data
->ds_file_group
= port_data
->ds_file_group
;
239 medium_status
= ctf_fs_ds_group_medops_data_create(
240 msg_iter_data
->ds_file_group
, self_msg_iter
, log_level
,
241 &msg_iter_data
->msg_iter_medops_data
);
243 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_OK
||
244 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_ERROR
||
245 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
);
246 if (medium_status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
247 BT_MSG_ITER_LOGE_APPEND_CAUSE(self_msg_iter
,
248 "Failed to create ctf_fs_ds_group_medops");
249 status
= (int) medium_status
;
253 msg_iter_data
->msg_iter
= ctf_msg_iter_create(
254 msg_iter_data
->ds_file_group
->ctf_fs_trace
->metadata
->tc
,
255 bt_common_get_page_size(msg_iter_data
->log_level
) * 8,
256 ctf_fs_ds_group_medops
,
257 msg_iter_data
->msg_iter_medops_data
,
258 msg_iter_data
->log_level
,
259 self_comp
, self_msg_iter
);
260 if (!msg_iter_data
->msg_iter
) {
261 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Cannot create a CTF message iterator.");
262 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
267 * This iterator can seek forward if its stream class has a default
270 if (msg_iter_data
->ds_file_group
->sc
->default_clock_class
) {
271 bt_self_message_iterator_configuration_set_can_seek_forward(
275 bt_self_message_iterator_set_data(self_msg_iter
,
277 msg_iter_data
= NULL
;
279 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
283 bt_self_message_iterator_set_data(self_msg_iter
, NULL
);
286 ctf_fs_msg_iter_data_destroy(msg_iter_data
);
291 void ctf_fs_trace_destroy(struct ctf_fs_trace
*ctf_fs_trace
)
297 if (ctf_fs_trace
->ds_file_groups
) {
298 g_ptr_array_free(ctf_fs_trace
->ds_file_groups
, TRUE
);
301 BT_TRACE_PUT_REF_AND_RESET(ctf_fs_trace
->trace
);
303 if (ctf_fs_trace
->path
) {
304 g_string_free(ctf_fs_trace
->path
, TRUE
);
307 if (ctf_fs_trace
->metadata
) {
308 ctf_fs_metadata_fini(ctf_fs_trace
->metadata
);
309 g_free(ctf_fs_trace
->metadata
);
312 g_free(ctf_fs_trace
);
316 void ctf_fs_destroy(struct ctf_fs_component
*ctf_fs
)
322 ctf_fs_trace_destroy(ctf_fs
->trace
);
324 if (ctf_fs
->port_data
) {
325 g_ptr_array_free(ctf_fs
->port_data
, TRUE
);
332 void port_data_destroy(struct ctf_fs_port_data
*port_data
)
342 void port_data_destroy_notifier(void *data
) {
343 port_data_destroy(data
);
347 void ctf_fs_trace_destroy_notifier(void *data
)
349 struct ctf_fs_trace
*trace
= data
;
350 ctf_fs_trace_destroy(trace
);
353 struct ctf_fs_component
*ctf_fs_component_create(bt_logging_level log_level
,
354 bt_self_component
*self_comp
)
356 struct ctf_fs_component
*ctf_fs
;
358 ctf_fs
= g_new0(struct ctf_fs_component
, 1);
363 ctf_fs
->log_level
= log_level
;
365 g_ptr_array_new_with_free_func(port_data_destroy_notifier
);
366 if (!ctf_fs
->port_data
) {
373 ctf_fs_destroy(ctf_fs
);
380 void ctf_fs_finalize(bt_self_component_source
*component
)
382 ctf_fs_destroy(bt_self_component_get_data(
383 bt_self_component_source_as_self_component(component
)));
386 gchar
*ctf_fs_make_port_name(struct ctf_fs_ds_file_group
*ds_file_group
)
388 GString
*name
= g_string_new(NULL
);
391 * The unique port name is generated by concatenating unique identifiers
399 /* For the trace, use the uuid if present, else the path. */
400 if (ds_file_group
->ctf_fs_trace
->metadata
->tc
->is_uuid_set
) {
401 char uuid_str
[BT_UUID_STR_LEN
+ 1];
403 bt_uuid_to_str(ds_file_group
->ctf_fs_trace
->metadata
->tc
->uuid
, uuid_str
);
404 g_string_assign(name
, uuid_str
);
406 g_string_assign(name
, ds_file_group
->ctf_fs_trace
->path
->str
);
410 * For the stream class, use the id if present. We can omit this field
411 * otherwise, as there will only be a single stream class.
413 if (ds_file_group
->sc
->id
!= UINT64_C(-1)) {
414 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->sc
->id
);
417 /* For the stream, use the id if present, else, use the path. */
418 if (ds_file_group
->stream_id
!= UINT64_C(-1)) {
419 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->stream_id
);
421 BT_ASSERT(ds_file_group
->ds_file_infos
->len
== 1);
422 struct ctf_fs_ds_file_info
*ds_file_info
=
423 g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
424 g_string_append_printf(name
, " | %s", ds_file_info
->path
->str
);
427 return g_string_free(name
, FALSE
);
431 int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
432 struct ctf_fs_trace
*ctf_fs_trace
,
433 struct ctf_fs_ds_file_group
*ds_file_group
,
434 bt_self_component_source
*self_comp_src
)
437 struct ctf_fs_port_data
*port_data
= NULL
;
439 bt_logging_level log_level
= ctf_fs
->log_level
;
440 bt_self_component
*self_comp
=
441 bt_self_component_source_as_self_component(self_comp_src
);
443 port_name
= ctf_fs_make_port_name(ds_file_group
);
448 BT_COMP_LOGI("Creating one port named `%s`", port_name
);
450 /* Create output port for this file */
451 port_data
= g_new0(struct ctf_fs_port_data
, 1);
456 port_data
->ctf_fs
= ctf_fs
;
457 port_data
->ds_file_group
= ds_file_group
;
458 ret
= bt_self_component_source_add_output_port(
459 self_comp_src
, port_name
, port_data
, NULL
);
464 g_ptr_array_add(ctf_fs
->port_data
, port_data
);
474 port_data_destroy(port_data
);
479 int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
480 struct ctf_fs_trace
*ctf_fs_trace
,
481 bt_self_component_source
*self_comp_src
)
485 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
486 bt_self_component
*self_comp
=
487 bt_self_component_source_as_self_component(self_comp_src
);
489 /* Create one output port for each stream file group */
490 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
491 struct ctf_fs_ds_file_group
*ds_file_group
=
492 g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
494 ret
= create_one_port_for_trace(ctf_fs
, ctf_fs_trace
,
495 ds_file_group
, self_comp_src
);
497 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Cannot create output port.");
507 void ctf_fs_ds_file_info_destroy(struct ctf_fs_ds_file_info
*ds_file_info
)
513 if (ds_file_info
->path
) {
514 g_string_free(ds_file_info
->path
, TRUE
);
517 g_free(ds_file_info
);
521 struct ctf_fs_ds_file_info
*ctf_fs_ds_file_info_create(const char *path
,
524 struct ctf_fs_ds_file_info
*ds_file_info
;
526 ds_file_info
= g_new0(struct ctf_fs_ds_file_info
, 1);
531 ds_file_info
->path
= g_string_new(path
);
532 if (!ds_file_info
->path
) {
533 ctf_fs_ds_file_info_destroy(ds_file_info
);
538 ds_file_info
->begin_ns
= begin_ns
;
545 void ctf_fs_ds_file_group_destroy(struct ctf_fs_ds_file_group
*ds_file_group
)
547 if (!ds_file_group
) {
551 if (ds_file_group
->ds_file_infos
) {
552 g_ptr_array_free(ds_file_group
->ds_file_infos
, TRUE
);
555 ctf_fs_ds_index_destroy(ds_file_group
->index
);
557 bt_stream_put_ref(ds_file_group
->stream
);
558 g_free(ds_file_group
);
562 struct ctf_fs_ds_file_group
*ctf_fs_ds_file_group_create(
563 struct ctf_fs_trace
*ctf_fs_trace
,
564 struct ctf_stream_class
*sc
,
565 uint64_t stream_instance_id
,
566 struct ctf_fs_ds_index
*index
)
568 struct ctf_fs_ds_file_group
*ds_file_group
;
570 ds_file_group
= g_new0(struct ctf_fs_ds_file_group
, 1);
571 if (!ds_file_group
) {
575 ds_file_group
->ds_file_infos
= g_ptr_array_new_with_free_func(
576 (GDestroyNotify
) ctf_fs_ds_file_info_destroy
);
577 if (!ds_file_group
->ds_file_infos
) {
581 ds_file_group
->index
= index
;
583 ds_file_group
->stream_id
= stream_instance_id
;
585 ds_file_group
->sc
= sc
;
586 ds_file_group
->ctf_fs_trace
= ctf_fs_trace
;
590 ctf_fs_ds_file_group_destroy(ds_file_group
);
591 ctf_fs_ds_index_destroy(index
);
592 ds_file_group
= NULL
;
595 return ds_file_group
;
598 /* Replace by g_ptr_array_insert when we depend on glib >= 2.40. */
600 void array_insert(GPtrArray
*array
, gpointer element
, size_t pos
)
602 size_t original_array_len
= array
->len
;
604 /* Allocate an unused element at the end of the array. */
605 g_ptr_array_add(array
, NULL
);
607 /* If we are not inserting at the end, move the elements by one. */
608 if (pos
< original_array_len
) {
609 memmove(&(array
->pdata
[pos
+ 1]),
610 &(array
->pdata
[pos
]),
611 (original_array_len
- pos
) * sizeof(gpointer
));
614 /* Insert the value. */
615 array
->pdata
[pos
] = element
;
619 * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right
620 * place to keep it sorted.
624 void ds_file_group_insert_ds_file_info_sorted(
625 struct ctf_fs_ds_file_group
*ds_file_group
,
626 struct ctf_fs_ds_file_info
*ds_file_info
)
630 /* Find the spot where to insert this ds_file_info. */
631 for (i
= 0; i
< ds_file_group
->ds_file_infos
->len
; i
++) {
632 struct ctf_fs_ds_file_info
*other_ds_file_info
=
633 g_ptr_array_index(ds_file_group
->ds_file_infos
, i
);
635 if (ds_file_info
->begin_ns
< other_ds_file_info
->begin_ns
) {
640 array_insert(ds_file_group
->ds_file_infos
, ds_file_info
, i
);
644 bool ds_index_entries_equal(
645 const struct ctf_fs_ds_index_entry
*left
,
646 const struct ctf_fs_ds_index_entry
*right
)
648 if (left
->packet_size
!= right
->packet_size
) {
652 if (left
->timestamp_begin
!= right
->timestamp_begin
) {
656 if (left
->timestamp_end
!= right
->timestamp_end
) {
660 if (left
->packet_seq_num
!= right
->packet_seq_num
) {
668 * Insert `entry` into `index`, without duplication.
670 * The entry is inserted only if there isn't an identical entry already.
672 * In any case, the ownership of `entry` is transferred to this function. So if
673 * the entry is not inserted, it is freed.
677 void ds_index_insert_ds_index_entry_sorted(
678 struct ctf_fs_ds_index
*index
,
679 struct ctf_fs_ds_index_entry
*entry
)
682 struct ctf_fs_ds_index_entry
*other_entry
;
684 /* Find the spot where to insert this index entry. */
685 for (i
= 0; i
< index
->entries
->len
; i
++) {
686 other_entry
= g_ptr_array_index(index
->entries
, i
);
688 if (entry
->timestamp_begin_ns
<= other_entry
->timestamp_begin_ns
) {
694 * Insert the entry only if a duplicate doesn't already exist.
696 * There can be duplicate packets if reading multiple overlapping
697 * snapshots of the same trace. We then want the index to contain
698 * a reference to only one copy of that packet.
700 if (i
== index
->entries
->len
||
701 !ds_index_entries_equal(entry
, other_entry
)) {
702 array_insert(index
->entries
, entry
, i
);
709 void merge_ctf_fs_ds_indexes(struct ctf_fs_ds_index
*dest
, struct ctf_fs_ds_index
*src
)
713 for (i
= 0; i
< src
->entries
->len
; i
++) {
714 struct ctf_fs_ds_index_entry
*entry
=
715 g_ptr_array_index(src
->entries
, i
);
718 * Ownership of the ctf_fs_ds_index_entry is transferred to
719 * ds_index_insert_ds_index_entry_sorted.
721 g_ptr_array_index(src
->entries
, i
) = NULL
;
722 ds_index_insert_ds_index_entry_sorted(dest
, entry
);
727 int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
,
730 int64_t stream_instance_id
= -1;
731 int64_t begin_ns
= -1;
732 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
733 bool add_group
= false;
736 struct ctf_fs_ds_file
*ds_file
= NULL
;
737 struct ctf_fs_ds_file_info
*ds_file_info
= NULL
;
738 struct ctf_fs_ds_index
*index
= NULL
;
739 struct ctf_msg_iter
*msg_iter
= NULL
;
740 struct ctf_stream_class
*sc
= NULL
;
741 struct ctf_msg_iter_packet_properties props
;
742 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
743 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
744 bt_self_component_class
*self_comp_class
= ctf_fs_trace
->self_comp_class
;
747 * Create a temporary ds_file to read some properties about the data
750 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, NULL
, path
,
756 /* Create a temporary iterator to read the ds_file. */
757 msg_iter
= ctf_msg_iter_create(ctf_fs_trace
->metadata
->tc
,
758 bt_common_get_page_size(log_level
) * 8,
759 ctf_fs_ds_file_medops
, ds_file
, log_level
, self_comp
, NULL
);
761 BT_COMP_LOGE_STR("Cannot create a CTF message iterator.");
765 ctf_msg_iter_set_dry_run(msg_iter
, true);
767 ret
= ctf_msg_iter_get_packet_properties(msg_iter
, &props
);
769 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
770 "Cannot get stream file's first packet's header and context fields (`%s`).",
775 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
,
776 props
.stream_class_id
);
778 stream_instance_id
= props
.data_stream_id
;
780 if (props
.snapshots
.beginning_clock
!= UINT64_C(-1)) {
781 BT_ASSERT(sc
->default_clock_class
);
782 ret
= bt_util_clock_cycles_to_ns_from_origin(
783 props
.snapshots
.beginning_clock
,
784 sc
->default_clock_class
->frequency
,
785 sc
->default_clock_class
->offset_seconds
,
786 sc
->default_clock_class
->offset_cycles
, &begin_ns
);
788 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
789 "Cannot convert clock cycles to nanoseconds from origin (`%s`).",
795 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
);
800 index
= ctf_fs_ds_file_build_index(ds_file
, ds_file_info
, msg_iter
);
802 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
803 self_comp
, self_comp_class
,
804 "Failed to index CTF stream file \'%s\'",
805 ds_file
->file
->path
->str
);
809 if (begin_ns
== -1) {
811 * No beginning timestamp to sort the stream files
812 * within a stream file group, so consider that this
813 * file must be the only one within its group.
815 stream_instance_id
= -1;
818 if (stream_instance_id
== -1) {
820 * No stream instance ID or no beginning timestamp:
821 * create a unique stream file group for this stream
822 * file because, even if there's a stream instance ID,
823 * there's no timestamp to order the file within its
826 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
,
827 sc
, UINT64_C(-1), index
);
828 /* Ownership of index is transferred. */
831 if (!ds_file_group
) {
835 ds_file_group_insert_ds_file_info_sorted(ds_file_group
,
836 BT_MOVE_REF(ds_file_info
));
842 BT_ASSERT(stream_instance_id
!= -1);
843 BT_ASSERT(begin_ns
!= -1);
845 /* Find an existing stream file group with this ID */
846 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
847 ds_file_group
= g_ptr_array_index(
848 ctf_fs_trace
->ds_file_groups
, i
);
850 if (ds_file_group
->sc
== sc
&&
851 ds_file_group
->stream_id
==
852 stream_instance_id
) {
856 ds_file_group
= NULL
;
859 if (!ds_file_group
) {
860 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
,
861 sc
, stream_instance_id
, index
);
862 /* Ownership of index is transferred. */
864 if (!ds_file_group
) {
870 merge_ctf_fs_ds_indexes(ds_file_group
->index
, index
);
873 ds_file_group_insert_ds_file_info_sorted(ds_file_group
,
874 BT_MOVE_REF(ds_file_info
));
879 ctf_fs_ds_file_group_destroy(ds_file_group
);
880 ds_file_group
= NULL
;
884 if (add_group
&& ds_file_group
) {
885 g_ptr_array_add(ctf_fs_trace
->ds_file_groups
, ds_file_group
);
888 ctf_fs_ds_file_destroy(ds_file
);
889 ctf_fs_ds_file_info_destroy(ds_file_info
);
892 ctf_msg_iter_destroy(msg_iter
);
895 ctf_fs_ds_index_destroy(index
);
900 int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
903 const char *basename
;
904 GError
*error
= NULL
;
906 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
907 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
908 bt_self_component_class
*self_comp_class
= ctf_fs_trace
->self_comp_class
;
910 /* Check each file in the path directory, except specific ones */
911 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
913 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
914 "Cannot open directory `%s`: %s (code %d)",
915 ctf_fs_trace
->path
->str
, error
->message
,
920 while ((basename
= g_dir_read_name(dir
))) {
921 struct ctf_fs_file
*file
;
923 if (strcmp(basename
, CTF_FS_METADATA_FILENAME
) == 0) {
924 /* Ignore the metadata stream. */
925 BT_COMP_LOGI("Ignoring metadata file `%s" G_DIR_SEPARATOR_S
"%s`",
926 ctf_fs_trace
->path
->str
, basename
);
930 if (basename
[0] == '.') {
931 BT_COMP_LOGI("Ignoring hidden file `%s" G_DIR_SEPARATOR_S
"%s`",
932 ctf_fs_trace
->path
->str
, basename
);
936 /* Create the file. */
937 file
= ctf_fs_file_create(log_level
, self_comp
);
939 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
940 "Cannot create stream file object for file `%s" G_DIR_SEPARATOR_S
"%s`",
941 ctf_fs_trace
->path
->str
, basename
);
945 /* Create full path string. */
946 g_string_append_printf(file
->path
, "%s" G_DIR_SEPARATOR_S
"%s",
947 ctf_fs_trace
->path
->str
, basename
);
948 if (!g_file_test(file
->path
->str
, G_FILE_TEST_IS_REGULAR
)) {
949 BT_COMP_LOGI("Ignoring non-regular file `%s`",
951 ctf_fs_file_destroy(file
);
956 ret
= ctf_fs_file_open(file
, "rb");
958 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
959 "Cannot open stream file `%s`",
964 if (file
->size
== 0) {
965 /* Skip empty stream. */
966 BT_COMP_LOGI("Ignoring empty file `%s`", file
->path
->str
);
967 ctf_fs_file_destroy(file
);
971 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
,
974 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
975 "Cannot add stream file `%s` to stream file group",
977 ctf_fs_file_destroy(file
);
981 ctf_fs_file_destroy(file
);
1003 int set_trace_name(bt_trace
*trace
, const char *name_suffix
,
1004 bt_logging_level log_level
, bt_self_component
*self_comp
)
1007 const bt_value
*val
;
1010 name
= g_string_new(NULL
);
1012 BT_COMP_LOGE_STR("Failed to allocate a GString.");
1018 * Check if we have a trace environment string value named `hostname`.
1019 * If so, use it as the trace name's prefix.
1021 val
= bt_trace_borrow_environment_entry_value_by_name_const(
1023 if (val
&& bt_value_is_string(val
)) {
1024 g_string_append(name
, bt_value_string_get(val
));
1027 g_string_append_c(name
, G_DIR_SEPARATOR
);
1032 g_string_append(name
, name_suffix
);
1035 ret
= bt_trace_set_name(trace
, name
->str
);
1044 g_string_free(name
, TRUE
);
1051 struct ctf_fs_trace
*ctf_fs_trace_create(
1052 bt_self_component
*self_comp
,
1053 bt_self_component_class
*self_comp_class
,
1054 const char *path
, const char *name
,
1055 struct ctf_fs_metadata_config
*metadata_config
,
1056 bt_logging_level log_level
)
1058 struct ctf_fs_trace
*ctf_fs_trace
;
1061 /* Only one of them must be set. */
1062 BT_ASSERT(!self_comp
!= !self_comp_class
);
1064 ctf_fs_trace
= g_new0(struct ctf_fs_trace
, 1);
1065 if (!ctf_fs_trace
) {
1069 ctf_fs_trace
->log_level
= log_level
;
1070 ctf_fs_trace
->self_comp
= self_comp
;
1071 ctf_fs_trace
->self_comp_class
= self_comp_class
;
1072 ctf_fs_trace
->path
= g_string_new(path
);
1073 if (!ctf_fs_trace
->path
) {
1077 ctf_fs_trace
->metadata
= g_new0(struct ctf_fs_metadata
, 1);
1078 if (!ctf_fs_trace
->metadata
) {
1082 ctf_fs_metadata_init(ctf_fs_trace
->metadata
);
1083 ctf_fs_trace
->ds_file_groups
= g_ptr_array_new_with_free_func(
1084 (GDestroyNotify
) ctf_fs_ds_file_group_destroy
);
1085 if (!ctf_fs_trace
->ds_file_groups
) {
1089 ret
= ctf_fs_metadata_set_trace_class(self_comp
, ctf_fs_trace
,
1095 if (ctf_fs_trace
->metadata
->trace_class
) {
1096 ctf_fs_trace
->trace
=
1097 bt_trace_create(ctf_fs_trace
->metadata
->trace_class
);
1098 if (!ctf_fs_trace
->trace
) {
1103 if (ctf_fs_trace
->trace
) {
1104 ret
= ctf_trace_class_configure_ir_trace(
1105 ctf_fs_trace
->metadata
->tc
, ctf_fs_trace
->trace
);
1110 ret
= set_trace_name(ctf_fs_trace
->trace
, name
, log_level
,
1117 ret
= create_ds_file_groups(ctf_fs_trace
);
1125 ctf_fs_trace_destroy(ctf_fs_trace
);
1126 ctf_fs_trace
= NULL
;
1129 return ctf_fs_trace
;
1133 int path_is_ctf_trace(const char *path
)
1135 GString
*metadata_path
= g_string_new(NULL
);
1138 if (!metadata_path
) {
1143 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
1145 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
1151 g_string_free(metadata_path
, TRUE
);
1155 /* Helper for ctf_fs_component_create_ctf_fs_trace, to handle a single path. */
1158 int ctf_fs_component_create_ctf_fs_trace_one_path(
1159 struct ctf_fs_component
*ctf_fs
,
1160 const char *path_param
,
1161 const char *trace_name
,
1163 bt_self_component
*self_comp
,
1164 bt_self_component_class
*self_comp_class
)
1166 struct ctf_fs_trace
*ctf_fs_trace
;
1169 bt_logging_level log_level
= ctf_fs
->log_level
;
1171 norm_path
= bt_common_normalize_path(path_param
, NULL
);
1173 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1174 "Failed to normalize path: `%s`.",
1179 ret
= path_is_ctf_trace(norm_path
->str
);
1181 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1182 "Failed to check if path is a CTF trace: path=%s",
1185 } else if (ret
== 0) {
1186 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1187 "Path is not a CTF trace (does not contain a metadata file): `%s`.",
1192 // FIXME: Remove or ifdef for __MINGW32__
1193 if (strcmp(norm_path
->str
, "/") == 0) {
1194 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1195 "Opening a trace in `/` is not supported.");
1200 ctf_fs_trace
= ctf_fs_trace_create(self_comp
, self_comp_class
, norm_path
->str
,
1201 trace_name
, &ctf_fs
->metadata_config
, log_level
);
1202 if (!ctf_fs_trace
) {
1203 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1204 "Cannot create trace for `%s`.",
1209 g_ptr_array_add(traces
, ctf_fs_trace
);
1210 ctf_fs_trace
= NULL
;
1220 g_string_free(norm_path
, TRUE
);
1227 * Count the number of stream and event classes defined by this trace's metadata.
1229 * This is used to determine which metadata is the "latest", out of multiple
1230 * traces sharing the same UUID. It is assumed that amongst all these metadatas,
1231 * a bigger metadata is a superset of a smaller metadata. Therefore, it is
1232 * enough to just count the classes.
1236 unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace
*trace
)
1238 unsigned int num
= trace
->metadata
->tc
->stream_classes
->len
;
1241 for (i
= 0; i
< trace
->metadata
->tc
->stream_classes
->len
; i
++) {
1242 struct ctf_stream_class
*sc
= trace
->metadata
->tc
->stream_classes
->pdata
[i
];
1243 num
+= sc
->event_classes
->len
;
1250 * Merge the src ds_file_group into dest. This consists of merging their
1251 * ds_file_infos, making sure to keep the result sorted.
1255 void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group
*dest
, struct ctf_fs_ds_file_group
*src
)
1259 for (i
= 0; i
< src
->ds_file_infos
->len
; i
++) {
1260 struct ctf_fs_ds_file_info
*ds_file_info
=
1261 g_ptr_array_index(src
->ds_file_infos
, i
);
1263 /* Ownership of the ds_file_info is transferred to dest. */
1264 g_ptr_array_index(src
->ds_file_infos
, i
) = NULL
;
1266 ds_file_group_insert_ds_file_info_sorted(dest
, ds_file_info
);
1269 /* Merge both indexes. */
1270 merge_ctf_fs_ds_indexes(dest
->index
, src
->index
);
1272 /* Merge src_trace's data stream file groups into dest_trace's. */
1275 int merge_matching_ctf_fs_ds_file_groups(
1276 struct ctf_fs_trace
*dest_trace
,
1277 struct ctf_fs_trace
*src_trace
)
1280 GPtrArray
*dest
= dest_trace
->ds_file_groups
;
1281 GPtrArray
*src
= src_trace
->ds_file_groups
;
1286 * Save the initial length of dest: we only want to check against the
1287 * original elements in the inner loop.
1289 const guint dest_len
= dest
->len
;
1291 for (s_i
= 0; s_i
< src
->len
; s_i
++) {
1292 struct ctf_fs_ds_file_group
*src_group
= g_ptr_array_index(src
, s_i
);
1293 struct ctf_fs_ds_file_group
*dest_group
= NULL
;
1295 /* A stream instance without ID can't match a stream in the other trace. */
1296 if (src_group
->stream_id
!= -1) {
1299 /* Let's search for a matching ds_file_group in the destination. */
1300 for (d_i
= 0; d_i
< dest_len
; d_i
++) {
1301 struct ctf_fs_ds_file_group
*candidate_dest
= g_ptr_array_index(dest
, d_i
);
1303 /* Can't match a stream instance without ID. */
1304 if (candidate_dest
->stream_id
== -1) {
1309 * If the two groups have the same stream instance id
1310 * and belong to the same stream class (stream instance
1311 * ids are per-stream class), they represent the same
1314 if (candidate_dest
->stream_id
!= src_group
->stream_id
||
1315 candidate_dest
->sc
->id
!= src_group
->sc
->id
) {
1319 dest_group
= candidate_dest
;
1325 * Didn't find a friend in dest to merge our src_group into?
1326 * Create a new empty one. This can happen if a stream was
1327 * active in the source trace chunk but not in the destination
1331 struct ctf_stream_class
*sc
;
1332 struct ctf_fs_ds_index
*index
;
1334 sc
= ctf_trace_class_borrow_stream_class_by_id(
1335 dest_trace
->metadata
->tc
, src_group
->sc
->id
);
1338 index
= ctf_fs_ds_index_create(dest_trace
->log_level
,
1339 dest_trace
->self_comp
);
1345 dest_group
= ctf_fs_ds_file_group_create(dest_trace
, sc
,
1346 src_group
->stream_id
, index
);
1347 /* Ownership of index is transferred. */
1354 g_ptr_array_add(dest_trace
->ds_file_groups
, dest_group
);
1357 BT_ASSERT(dest_group
);
1358 merge_ctf_fs_ds_file_groups(dest_group
, src_group
);
1366 * Collapse the given traces, which must all share the same UUID, in a single
1369 * The trace with the most expansive metadata is chosen and all other traces
1370 * are merged into that one. The array slots of all the traces that get merged
1371 * in the chosen one are set to NULL, so only the slot of the chosen trace
1376 int merge_ctf_fs_traces(struct ctf_fs_trace
**traces
, unsigned int num_traces
,
1377 struct ctf_fs_trace
**out_trace
)
1379 unsigned int winner_count
;
1380 struct ctf_fs_trace
*winner
;
1384 BT_ASSERT(num_traces
>= 2);
1386 winner_count
= metadata_count_stream_and_event_classes(traces
[0]);
1390 /* Find the trace with the largest metadata. */
1391 for (i
= 1; i
< num_traces
; i
++) {
1392 struct ctf_fs_trace
*candidate
;
1393 unsigned int candidate_count
;
1395 candidate
= traces
[i
];
1397 /* A bit of sanity check. */
1398 BT_ASSERT(bt_uuid_compare(winner
->metadata
->tc
->uuid
, candidate
->metadata
->tc
->uuid
) == 0);
1400 candidate_count
= metadata_count_stream_and_event_classes(candidate
);
1402 if (candidate_count
> winner_count
) {
1403 winner_count
= candidate_count
;
1409 /* Merge all the other traces in the winning trace. */
1410 for (i
= 0; i
< num_traces
; i
++) {
1411 struct ctf_fs_trace
*trace
= traces
[i
];
1413 /* Don't merge the winner into itself. */
1414 if (trace
== winner
) {
1418 /* Merge trace's data stream file groups into winner's. */
1419 ret
= merge_matching_ctf_fs_ds_file_groups(winner
, trace
);
1426 * Move the winner out of the array, into `*out_trace`.
1428 *out_trace
= winner
;
1429 traces
[winner_i
] = NULL
;
1441 int decode_clock_snapshot_after_event(struct ctf_fs_trace
*ctf_fs_trace
,
1442 struct ctf_clock_class
*default_cc
,
1443 struct ctf_fs_ds_index_entry
*index_entry
,
1444 enum target_event target_event
, uint64_t *cs
, int64_t *ts_ns
)
1446 enum ctf_msg_iter_status iter_status
= CTF_MSG_ITER_STATUS_OK
;
1447 struct ctf_fs_ds_file
*ds_file
= NULL
;
1448 struct ctf_msg_iter
*msg_iter
= NULL
;
1449 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
1450 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
1453 BT_ASSERT(ctf_fs_trace
);
1454 BT_ASSERT(index_entry
);
1455 BT_ASSERT(index_entry
->path
);
1457 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
,
1458 NULL
, index_entry
->path
, log_level
);
1460 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Failed to create a ctf_fs_ds_file");
1465 BT_ASSERT(ctf_fs_trace
->metadata
);
1466 BT_ASSERT(ctf_fs_trace
->metadata
->tc
);
1468 msg_iter
= ctf_msg_iter_create(ctf_fs_trace
->metadata
->tc
,
1469 bt_common_get_page_size(log_level
) * 8, ctf_fs_ds_file_medops
,
1470 ds_file
, log_level
, self_comp
, NULL
);
1472 /* ctf_msg_iter_create() logs errors. */
1478 * Turn on dry run mode to prevent the creation and usage of Babeltrace
1479 * library objects (bt_field, bt_message_*, etc.).
1481 ctf_msg_iter_set_dry_run(msg_iter
, true);
1483 /* Seek to the beginning of the target packet. */
1484 iter_status
= ctf_msg_iter_seek(msg_iter
, index_entry
->offset
);
1486 /* ctf_msg_iter_seek() logs errors. */
1491 switch (target_event
) {
1494 * Start to decode the packet until we reach the end of
1495 * the first event. To extract the first event's clock
1498 iter_status
= ctf_msg_iter_curr_packet_first_event_clock_snapshot(
1502 /* Decode the packet to extract the last event's clock snapshot. */
1503 iter_status
= ctf_msg_iter_curr_packet_last_event_clock_snapshot(
1514 /* Convert clock snapshot to timestamp. */
1515 ret
= bt_util_clock_cycles_to_ns_from_origin(*cs
,
1516 default_cc
->frequency
, default_cc
->offset_seconds
,
1517 default_cc
->offset_cycles
, ts_ns
);
1519 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
1520 "Failed to convert clock snapshot to timestamp");
1526 ctf_fs_ds_file_destroy(ds_file
);
1529 ctf_msg_iter_destroy(msg_iter
);
1536 int decode_packet_first_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1537 struct ctf_clock_class
*default_cc
,
1538 struct ctf_fs_ds_index_entry
*index_entry
, uint64_t *cs
, int64_t *ts_ns
)
1540 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
,
1541 index_entry
, FIRST_EVENT
, cs
, ts_ns
);
1545 int decode_packet_last_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1546 struct ctf_clock_class
*default_cc
,
1547 struct ctf_fs_ds_index_entry
*index_entry
, uint64_t *cs
, int64_t *ts_ns
)
1549 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
,
1550 index_entry
, LAST_EVENT
, cs
, ts_ns
);
1554 * Fix up packet index entries for lttng's "event-after-packet" bug.
1555 * Some buggy lttng tracer versions may emit events with a timestamp that is
1556 * larger (after) than the timestamp_end of the their packets.
1558 * To fix up this erroneous data we do the following:
1559 * 1. If it's not the stream file's last packet: set the packet index entry's
1560 * end time to the next packet's beginning time.
1561 * 2. If it's the stream file's last packet, set the packet index entry's end
1562 * time to the packet's last event's time, if any, or to the packet's
1563 * beginning time otherwise.
1565 * Known buggy tracer versions:
1566 * - before lttng-ust 2.11.0
1567 * - before lttng-module 2.11.0
1568 * - before lttng-module 2.10.10
1569 * - before lttng-module 2.9.13
1572 int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace
*trace
)
1575 guint ds_file_group_i
;
1576 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1577 bt_logging_level log_level
= trace
->log_level
;
1579 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
;
1580 ds_file_group_i
++) {
1582 struct ctf_clock_class
*default_cc
;
1583 struct ctf_fs_ds_index_entry
*last_entry
;
1584 struct ctf_fs_ds_index
*index
;
1586 struct ctf_fs_ds_file_group
*ds_file_group
=
1587 g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1589 BT_ASSERT(ds_file_group
);
1590 index
= ds_file_group
->index
;
1593 BT_ASSERT(index
->entries
);
1594 BT_ASSERT(index
->entries
->len
> 0);
1597 * Iterate over all entries but the last one. The last one is
1598 * fixed differently after.
1600 for (entry_i
= 0; entry_i
< index
->entries
->len
- 1;
1602 struct ctf_fs_ds_index_entry
*curr_entry
, *next_entry
;
1604 curr_entry
= g_ptr_array_index(index
->entries
, entry_i
);
1605 next_entry
= g_ptr_array_index(index
->entries
, entry_i
+ 1);
1608 * 1. Set the current index entry `end` timestamp to
1609 * the next index entry `begin` timestamp.
1611 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1612 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1616 * 2. Fix the last entry by decoding the last event of the last
1619 last_entry
= g_ptr_array_index(index
->entries
,
1620 index
->entries
->len
- 1);
1621 BT_ASSERT(last_entry
);
1623 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1624 default_cc
= ds_file_group
->sc
->default_clock_class
;
1627 * Decode packet to read the timestamp of the last event of the
1630 ret
= decode_packet_last_event_timestamp(trace
, default_cc
,
1631 last_entry
, &last_entry
->timestamp_end
,
1632 &last_entry
->timestamp_end_ns
);
1634 BT_COMP_LOGE_APPEND_CAUSE(trace
->self_comp
,
1635 "Failed to decode stream's last packet to get its last event's clock snapshot.");
1645 * Fix up packet index entries for barectf's "event-before-packet" bug.
1646 * Some buggy barectf tracer versions may emit events with a timestamp that is
1647 * less than the timestamp_begin of the their packets.
1649 * To fix up this erroneous data we do the following:
1650 * 1. Starting at the second index entry, set the timestamp_begin of the
1651 * current entry to the timestamp of the first event of the packet.
1652 * 2. Set the previous entry's timestamp_end to the timestamp_begin of the
1655 * Known buggy tracer versions:
1656 * - before barectf 2.3.1
1659 int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace
*trace
)
1662 guint ds_file_group_i
;
1663 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1664 bt_logging_level log_level
= trace
->log_level
;
1666 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
;
1667 ds_file_group_i
++) {
1669 struct ctf_clock_class
*default_cc
;
1670 struct ctf_fs_ds_file_group
*ds_file_group
=
1671 g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1673 struct ctf_fs_ds_index
*index
= ds_file_group
->index
;
1676 BT_ASSERT(index
->entries
);
1677 BT_ASSERT(index
->entries
->len
> 0);
1679 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1680 default_cc
= ds_file_group
->sc
->default_clock_class
;
1683 * 1. Iterate over the index, starting from the second entry
1686 for (entry_i
= 1; entry_i
< index
->entries
->len
;
1688 struct ctf_fs_ds_index_entry
*curr_entry
, *prev_entry
;
1689 prev_entry
= g_ptr_array_index(index
->entries
, entry_i
- 1);
1690 curr_entry
= g_ptr_array_index(index
->entries
, entry_i
);
1692 * 2. Set the current entry `begin` timestamp to the
1693 * timestamp of the first event of the current packet.
1695 ret
= decode_packet_first_event_timestamp(trace
, default_cc
,
1696 curr_entry
, &curr_entry
->timestamp_begin
,
1697 &curr_entry
->timestamp_begin_ns
);
1699 BT_COMP_LOGE_APPEND_CAUSE(trace
->self_comp
,
1700 "Failed to decode first event's clock snapshot");
1705 * 3. Set the previous entry `end` timestamp to the
1706 * timestamp of the first event of the current packet.
1708 prev_entry
->timestamp_end
= curr_entry
->timestamp_begin
;
1709 prev_entry
->timestamp_end_ns
= curr_entry
->timestamp_begin_ns
;
1717 * When using the lttng-crash feature it's likely that the last packets of each
1718 * stream have their timestamp_end set to zero. This is caused by the fact that
1719 * the tracer crashed and was not able to properly close the packets.
1721 * To fix up this erroneous data we do the following:
1722 * For each index entry, if the entry's timestamp_end is 0 and the
1723 * timestamp_begin is not 0:
1724 * - If it's the stream file's last packet: set the packet index entry's end
1725 * time to the packet's last event's time, if any, or to the packet's
1726 * beginning time otherwise.
1727 * - If it's not the stream file's last packet: set the packet index
1728 * entry's end time to the next packet's beginning time.
1730 * Affected versions:
1731 * - All current and future lttng-ust and lttng-modules versions.
1734 int fix_index_lttng_crash_quirk(struct ctf_fs_trace
*trace
)
1737 guint ds_file_group_idx
;
1738 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1739 bt_logging_level log_level
= trace
->log_level
;
1741 for (ds_file_group_idx
= 0; ds_file_group_idx
< ds_file_groups
->len
;
1742 ds_file_group_idx
++) {
1744 struct ctf_clock_class
*default_cc
;
1745 struct ctf_fs_ds_index_entry
*last_entry
;
1746 struct ctf_fs_ds_index
*index
;
1748 struct ctf_fs_ds_file_group
*ds_file_group
=
1749 g_ptr_array_index(ds_file_groups
, ds_file_group_idx
);
1751 BT_ASSERT(ds_file_group
);
1752 index
= ds_file_group
->index
;
1754 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1755 default_cc
= ds_file_group
->sc
->default_clock_class
;
1758 BT_ASSERT(index
->entries
);
1759 BT_ASSERT(index
->entries
->len
> 0);
1761 last_entry
= g_ptr_array_index(index
->entries
,
1762 index
->entries
->len
- 1);
1763 BT_ASSERT(last_entry
);
1766 /* 1. Fix the last entry first. */
1767 if (last_entry
->timestamp_end
== 0 &&
1768 last_entry
->timestamp_begin
!= 0) {
1770 * Decode packet to read the timestamp of the
1771 * last event of the stream file.
1773 ret
= decode_packet_last_event_timestamp(trace
,
1774 default_cc
, last_entry
,
1775 &last_entry
->timestamp_end
,
1776 &last_entry
->timestamp_end_ns
);
1778 BT_COMP_LOGE_APPEND_CAUSE(trace
->self_comp
,
1779 "Failed to decode last event's clock snapshot");
1784 /* Iterate over all entries but the last one. */
1785 for (entry_idx
= 0; entry_idx
< index
->entries
->len
- 1;
1787 struct ctf_fs_ds_index_entry
*curr_entry
, *next_entry
;
1788 curr_entry
= g_ptr_array_index(index
->entries
, entry_idx
);
1789 next_entry
= g_ptr_array_index(index
->entries
, entry_idx
+ 1);
1791 if (curr_entry
->timestamp_end
== 0 &&
1792 curr_entry
->timestamp_begin
!= 0) {
1794 * 2. Set the current index entry `end` timestamp to
1795 * the next index entry `begin` timestamp.
1797 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1798 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1808 * Extract the tracer information necessary to compare versions.
1809 * Returns 0 on success, and -1 if the extraction is not successful because the
1810 * necessary fields are absents in the trace metadata.
1813 int extract_tracer_info(struct ctf_fs_trace
*trace
,
1814 struct tracer_info
*current_tracer_info
)
1817 struct ctf_trace_class_env_entry
*entry
;
1819 /* Clear the current_tracer_info struct */
1820 memset(current_tracer_info
, 0, sizeof(*current_tracer_info
));
1823 * To compare 2 tracer versions, at least the tracer name and it's
1824 * major version are needed. If one of these is missing, consider it an
1825 * extraction failure.
1827 entry
= ctf_trace_class_borrow_env_entry_by_name(
1828 trace
->metadata
->tc
, "tracer_name");
1829 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR
) {
1830 goto missing_bare_minimum
;
1833 /* Set tracer name. */
1834 current_tracer_info
->name
= entry
->value
.str
->str
;
1836 entry
= ctf_trace_class_borrow_env_entry_by_name(
1837 trace
->metadata
->tc
, "tracer_major");
1838 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1839 goto missing_bare_minimum
;
1842 /* Set major version number. */
1843 current_tracer_info
->major
= entry
->value
.i
;
1845 entry
= ctf_trace_class_borrow_env_entry_by_name(
1846 trace
->metadata
->tc
, "tracer_minor");
1847 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1851 /* Set minor version number. */
1852 current_tracer_info
->minor
= entry
->value
.i
;
1854 entry
= ctf_trace_class_borrow_env_entry_by_name(
1855 trace
->metadata
->tc
, "tracer_patch");
1858 * If `tracer_patch` doesn't exist `tracer_patchlevel` might.
1859 * For example, `lttng-modules` uses entry name
1860 * `tracer_patchlevel`.
1862 entry
= ctf_trace_class_borrow_env_entry_by_name(
1863 trace
->metadata
->tc
, "tracer_patchlevel");
1866 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1870 /* Set patch version number. */
1871 current_tracer_info
->patch
= entry
->value
.i
;
1875 missing_bare_minimum
:
1882 bool is_tracer_affected_by_lttng_event_after_packet_bug(
1883 struct tracer_info
*curr_tracer_info
)
1885 bool is_affected
= false;
1887 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1888 if (curr_tracer_info
->major
< 2) {
1890 } else if (curr_tracer_info
->major
== 2) {
1891 /* fixed in lttng-ust 2.11.0 */
1892 if (curr_tracer_info
->minor
< 11) {
1896 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1897 if (curr_tracer_info
->major
< 2) {
1899 } else if (curr_tracer_info
->major
== 2) {
1900 /* fixed in lttng-modules 2.11.0 */
1901 if (curr_tracer_info
->minor
== 10) {
1902 /* fixed in lttng-modules 2.10.10 */
1903 if (curr_tracer_info
->patch
< 10) {
1906 } else if (curr_tracer_info
->minor
== 9) {
1907 /* fixed in lttng-modules 2.9.13 */
1908 if (curr_tracer_info
->patch
< 13) {
1911 } else if (curr_tracer_info
->minor
< 9) {
1921 bool is_tracer_affected_by_barectf_event_before_packet_bug(
1922 struct tracer_info
*curr_tracer_info
)
1924 bool is_affected
= false;
1926 if (strcmp(curr_tracer_info
->name
, "barectf") == 0) {
1927 if (curr_tracer_info
->major
< 2) {
1929 } else if (curr_tracer_info
->major
== 2) {
1930 if (curr_tracer_info
->minor
< 3) {
1932 } else if (curr_tracer_info
->minor
== 3) {
1933 /* fixed in barectf 2.3.1 */
1934 if (curr_tracer_info
->patch
< 1) {
1945 bool is_tracer_affected_by_lttng_crash_quirk(
1946 struct tracer_info
*curr_tracer_info
)
1948 bool is_affected
= false;
1950 /* All LTTng tracer may be affected by this lttng crash quirk. */
1951 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1953 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1961 * Looks for trace produced by known buggy tracers and fix up the index
1965 int fix_packet_index_tracer_bugs(struct ctf_fs_component
*ctf_fs
,
1966 bt_self_component
*self_comp
,
1967 bt_self_component_class
*self_comp_class
)
1970 struct tracer_info current_tracer_info
;
1971 bt_logging_level log_level
= ctf_fs
->log_level
;
1973 ret
= extract_tracer_info(ctf_fs
->trace
, ¤t_tracer_info
);
1976 * A trace may not have all the necessary environment
1977 * entries to do the tracer version comparison.
1978 * At least, the tracer name and major version number
1979 * are needed. Failing to extract these entries is not
1983 BT_LOGI_STR("Cannot extract tracer information necessary to compare with buggy versions.");
1987 /* Check if the trace may be affected by old tracer bugs. */
1988 if (is_tracer_affected_by_lttng_event_after_packet_bug(
1989 ¤t_tracer_info
)) {
1990 BT_LOGI_STR("Trace may be affected by LTTng tracer packet timestamp bug. Fixing up.");
1991 ret
= fix_index_lttng_event_after_packet_bug(ctf_fs
->trace
);
1993 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
1994 self_comp
, self_comp_class
,
1995 "Failed to fix LTTng event-after-packet bug.");
1998 ctf_fs
->trace
->metadata
->tc
->quirks
.lttng_event_after_packet
= true;
2001 if (is_tracer_affected_by_barectf_event_before_packet_bug(
2002 ¤t_tracer_info
)) {
2003 BT_LOGI_STR("Trace may be affected by barectf tracer packet timestamp bug. Fixing up.");
2004 ret
= fix_index_barectf_event_before_packet_bug(ctf_fs
->trace
);
2006 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
2007 self_comp
, self_comp_class
,
2008 "Failed to fix barectf event-before-packet bug.");
2011 ctf_fs
->trace
->metadata
->tc
->quirks
.barectf_event_before_packet
= true;
2014 if (is_tracer_affected_by_lttng_crash_quirk(
2015 ¤t_tracer_info
)) {
2016 ret
= fix_index_lttng_crash_quirk(ctf_fs
->trace
);
2018 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
2019 self_comp
, self_comp_class
,
2020 "Failed to fix lttng-crash timestamp quirks.");
2023 ctf_fs
->trace
->metadata
->tc
->quirks
.lttng_crash
= true;
2031 gint
compare_ds_file_groups_by_first_path(gconstpointer a
, gconstpointer b
)
2033 struct ctf_fs_ds_file_group
* const *ds_file_group_a
= a
;
2034 struct ctf_fs_ds_file_group
* const *ds_file_group_b
= b
;
2035 const struct ctf_fs_ds_file_info
*first_ds_file_info_a
;
2036 const struct ctf_fs_ds_file_info
*first_ds_file_info_b
;
2038 BT_ASSERT((*ds_file_group_a
)->ds_file_infos
->len
> 0);
2039 BT_ASSERT((*ds_file_group_b
)->ds_file_infos
->len
> 0);
2040 first_ds_file_info_a
= (*ds_file_group_a
)->ds_file_infos
->pdata
[0];
2041 first_ds_file_info_b
= (*ds_file_group_b
)->ds_file_infos
->pdata
[0];
2042 return strcmp(first_ds_file_info_a
->path
->str
,
2043 first_ds_file_info_b
->path
->str
);
2047 gint
compare_strings(gconstpointer p_a
, gconstpointer p_b
)
2049 const char *a
= *((const char **) p_a
);
2050 const char *b
= *((const char **) p_b
);
2052 return strcmp(a
, b
);
2055 int ctf_fs_component_create_ctf_fs_trace(
2056 struct ctf_fs_component
*ctf_fs
,
2057 const bt_value
*paths_value
,
2058 const bt_value
*trace_name_value
,
2059 bt_self_component
*self_comp
,
2060 bt_self_component_class
*self_comp_class
)
2064 bt_logging_level log_level
= ctf_fs
->log_level
;
2065 GPtrArray
*paths
= NULL
;
2067 const char *trace_name
;
2069 BT_ASSERT(bt_value_get_type(paths_value
) == BT_VALUE_TYPE_ARRAY
);
2070 BT_ASSERT(!bt_value_array_is_empty(paths_value
));
2072 traces
= g_ptr_array_new_with_free_func(ctf_fs_trace_destroy_notifier
);
2074 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2075 "Failed to allocate a GPtrArray.");
2079 paths
= g_ptr_array_new_with_free_func(g_free
);
2081 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2082 "Failed to allocate a GPtrArray.");
2086 trace_name
= trace_name_value
? bt_value_string_get(trace_name_value
) : NULL
;
2089 * Create a sorted array of the paths, to make the execution of this
2090 * component deterministic.
2092 for (i
= 0; i
< bt_value_array_get_length(paths_value
); i
++) {
2093 const bt_value
*path_value
=
2094 bt_value_array_borrow_element_by_index_const(paths_value
, i
);
2095 const char *input
= bt_value_string_get(path_value
);
2098 input_copy
= g_strdup(input
);
2100 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2101 "Failed to copy a string.");
2105 g_ptr_array_add(paths
, input_copy
);
2108 g_ptr_array_sort(paths
, compare_strings
);
2110 /* Create a separate ctf_fs_trace object for each path. */
2111 for (i
= 0; i
< paths
->len
; i
++) {
2112 const char *path
= g_ptr_array_index(paths
, i
);
2114 ret
= ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs
,
2115 path
, trace_name
, traces
, self_comp
, self_comp_class
);
2121 if (traces
->len
> 1) {
2122 struct ctf_fs_trace
*first_trace
= (struct ctf_fs_trace
*) traces
->pdata
[0];
2123 const uint8_t *first_trace_uuid
= first_trace
->metadata
->tc
->uuid
;
2124 struct ctf_fs_trace
*trace
;
2127 * We have more than one trace, they must all share the same
2128 * UUID, verify that.
2130 for (i
= 0; i
< traces
->len
; i
++) {
2131 struct ctf_fs_trace
*this_trace
=
2132 (struct ctf_fs_trace
*) traces
->pdata
[i
];
2133 const uint8_t *this_trace_uuid
= this_trace
->metadata
->tc
->uuid
;
2135 if (!this_trace
->metadata
->tc
->is_uuid_set
) {
2136 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2137 "Multiple traces given, but a trace does not have a UUID: path=%s",
2138 this_trace
->path
->str
);
2142 if (bt_uuid_compare(first_trace_uuid
, this_trace_uuid
) != 0) {
2143 char first_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
2144 char this_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
2146 bt_uuid_to_str(first_trace_uuid
, first_trace_uuid_str
);
2147 bt_uuid_to_str(this_trace_uuid
, this_trace_uuid_str
);
2149 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2150 "Multiple traces given, but UUIDs don't match: "
2151 "first-trace-uuid=%s, first-trace-path=%s, "
2152 "trace-uuid=%s, trace-path=%s",
2153 first_trace_uuid_str
, first_trace
->path
->str
,
2154 this_trace_uuid_str
, this_trace
->path
->str
);
2159 ret
= merge_ctf_fs_traces((struct ctf_fs_trace
**) traces
->pdata
,
2160 traces
->len
, &trace
);
2162 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2163 "Failed to merge traces with the same UUID.");
2167 ctf_fs
->trace
= trace
;
2169 /* Just one trace, it may or may not have a UUID, both are fine. */
2170 ctf_fs
->trace
= traces
->pdata
[0];
2171 traces
->pdata
[0] = NULL
;
2174 ret
= fix_packet_index_tracer_bugs(ctf_fs
, self_comp
, self_comp_class
);
2176 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2177 "Failed to fix packet index tracer bugs.");
2181 * Sort data stream file groups by first data stream file info
2182 * path to get a deterministic order. This order influences the
2183 * order of the output ports. It also influences the order of
2184 * the automatic stream IDs if the trace's packet headers do not
2185 * contain a `stream_instance_id` field, in which case the data
2186 * stream file to stream ID association is always the same,
2187 * whatever the build and the system.
2189 * Having a deterministic order here can help debugging and
2192 g_ptr_array_sort(ctf_fs
->trace
->ds_file_groups
,
2193 compare_ds_file_groups_by_first_path
);
2200 g_ptr_array_free(traces
, TRUE
);
2204 g_ptr_array_free(paths
, TRUE
);
2211 GString
*get_stream_instance_unique_name(
2212 struct ctf_fs_ds_file_group
*ds_file_group
)
2215 struct ctf_fs_ds_file_info
*ds_file_info
;
2217 name
= g_string_new(NULL
);
2223 * If there's more than one stream file in the stream file
2224 * group, the first (earliest) stream file's path is used as
2225 * the stream's unique name.
2227 BT_ASSERT(ds_file_group
->ds_file_infos
->len
> 0);
2228 ds_file_info
= g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
2229 g_string_assign(name
, ds_file_info
->path
->str
);
2235 /* Create the IR stream objects for ctf_fs_trace. */
2238 int create_streams_for_trace(struct ctf_fs_trace
*ctf_fs_trace
)
2241 GString
*name
= NULL
;
2243 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
2244 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
2246 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
2247 struct ctf_fs_ds_file_group
*ds_file_group
=
2248 g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
2249 name
= get_stream_instance_unique_name(ds_file_group
);
2255 if (ds_file_group
->sc
->ir_sc
) {
2256 BT_ASSERT(ctf_fs_trace
->trace
);
2258 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
2259 /* No stream ID: use 0 */
2260 ds_file_group
->stream
= bt_stream_create_with_id(
2261 ds_file_group
->sc
->ir_sc
,
2262 ctf_fs_trace
->trace
,
2263 ctf_fs_trace
->next_stream_id
);
2264 ctf_fs_trace
->next_stream_id
++;
2266 /* Specific stream ID */
2267 ds_file_group
->stream
= bt_stream_create_with_id(
2268 ds_file_group
->sc
->ir_sc
,
2269 ctf_fs_trace
->trace
,
2270 (uint64_t) ds_file_group
->stream_id
);
2273 ds_file_group
->stream
= NULL
;
2276 if (!ds_file_group
->stream
) {
2277 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2278 "Cannot create stream for DS file group: "
2279 "addr=%p, stream-name=\"%s\"",
2280 ds_file_group
, name
->str
);
2284 ret
= bt_stream_set_name(ds_file_group
->stream
,
2287 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Cannot set stream's name: "
2288 "addr=%p, stream-name=\"%s\"",
2289 ds_file_group
->stream
, name
->str
);
2293 g_string_free(name
, TRUE
);
2306 g_string_free(name
, TRUE
);
2311 static const struct bt_param_validation_value_descr inputs_elem_descr
= {
2312 .type
= BT_VALUE_TYPE_STRING
,
2315 static const struct bt_param_validation_map_value_entry_descr fs_params_entries_descr
[] = {
2316 { "inputs", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
, {
2317 BT_VALUE_TYPE_ARRAY
,
2320 .max_length
= BT_PARAM_VALIDATION_INFINITE
,
2321 .element_type
= &inputs_elem_descr
,
2324 { "trace-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_STRING
} },
2325 { "clock-class-offset-s", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_SIGNED_INTEGER
} },
2326 { "clock-class-offset-ns", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_SIGNED_INTEGER
} },
2327 { "force-clock-class-origin-unix-epoch", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
, { .type
= BT_VALUE_TYPE_BOOL
} },
2328 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
2332 bool read_src_fs_parameters(const bt_value
*params
,
2333 const bt_value
**inputs
,
2334 const bt_value
**trace_name
,
2335 struct ctf_fs_component
*ctf_fs
,
2336 bt_self_component
*self_comp
,
2337 bt_self_component_class
*self_comp_class
) {
2339 const bt_value
*value
;
2340 bt_logging_level log_level
= ctf_fs
->log_level
;
2341 enum bt_param_validation_status validate_value_status
;
2342 gchar
*error
= NULL
;
2344 validate_value_status
= bt_param_validation_validate(params
,
2345 fs_params_entries_descr
, &error
);
2346 if (validate_value_status
!= BT_PARAM_VALIDATION_STATUS_OK
) {
2347 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2353 /* inputs parameter */
2354 *inputs
= bt_value_map_borrow_entry_value_const(params
, "inputs");
2356 /* clock-class-offset-s parameter */
2357 value
= bt_value_map_borrow_entry_value_const(params
,
2358 "clock-class-offset-s");
2360 ctf_fs
->metadata_config
.clock_class_offset_s
=
2361 bt_value_integer_signed_get(value
);
2364 /* clock-class-offset-ns parameter */
2365 value
= bt_value_map_borrow_entry_value_const(params
,
2366 "clock-class-offset-ns");
2368 ctf_fs
->metadata_config
.clock_class_offset_ns
=
2369 bt_value_integer_signed_get(value
);
2372 /* force-clock-class-origin-unix-epoch parameter */
2373 value
= bt_value_map_borrow_entry_value_const(params
,
2374 "force-clock-class-origin-unix-epoch");
2376 ctf_fs
->metadata_config
.force_clock_class_origin_unix_epoch
=
2377 bt_value_bool_get(value
);
2380 /* trace-name parameter */
2381 *trace_name
= bt_value_map_borrow_entry_value_const(params
, "trace-name");
2391 struct ctf_fs_component
*ctf_fs_create(
2392 const bt_value
*params
,
2393 bt_self_component_source
*self_comp_src
)
2395 struct ctf_fs_component
*ctf_fs
= NULL
;
2396 const bt_value
*inputs_value
;
2397 const bt_value
*trace_name_value
;
2398 bt_self_component
*self_comp
=
2399 bt_self_component_source_as_self_component(self_comp_src
);
2401 ctf_fs
= ctf_fs_component_create(bt_component_get_logging_level(
2402 bt_self_component_as_component(self_comp
)), self_comp
);
2407 if (!read_src_fs_parameters(params
, &inputs_value
, &trace_name_value
,
2408 ctf_fs
, self_comp
, NULL
)) {
2412 bt_self_component_set_data(self_comp
, ctf_fs
);
2414 if (ctf_fs_component_create_ctf_fs_trace(ctf_fs
, inputs_value
,
2415 trace_name_value
, self_comp
, NULL
)) {
2419 if (create_streams_for_trace(ctf_fs
->trace
)) {
2423 if (create_ports_for_trace(ctf_fs
, ctf_fs
->trace
, self_comp_src
)) {
2430 ctf_fs_destroy(ctf_fs
);
2432 bt_self_component_set_data(self_comp
, NULL
);
2439 bt_component_class_initialize_method_status
ctf_fs_init(
2440 bt_self_component_source
*self_comp_src
,
2441 bt_self_component_source_configuration
*config
,
2442 const bt_value
*params
, __attribute__((unused
)) void *init_method_data
)
2444 struct ctf_fs_component
*ctf_fs
;
2445 bt_component_class_initialize_method_status ret
=
2446 BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
2448 ctf_fs
= ctf_fs_create(params
, self_comp_src
);
2450 ret
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
2457 bt_component_class_query_method_status
ctf_fs_query(
2458 bt_self_component_class_source
*comp_class
,
2459 bt_private_query_executor
*priv_query_exec
,
2460 const char *object
, const bt_value
*params
,
2461 __attribute__((unused
)) void *method_data
,
2462 const bt_value
**result
)
2464 bt_component_class_query_method_status status
=
2465 BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
2466 bt_logging_level log_level
= bt_query_executor_get_logging_level(
2467 bt_private_query_executor_as_query_executor_const(
2470 if (strcmp(object
, "metadata-info") == 0) {
2471 status
= metadata_info_query(comp_class
, params
, log_level
,
2473 } else if (strcmp(object
, "babeltrace.trace-infos") == 0) {
2474 status
= trace_infos_query(comp_class
, params
, log_level
,
2476 } else if (!strcmp(object
, "babeltrace.support-info")) {
2477 status
= support_info_query(comp_class
, params
, log_level
, result
);
2479 BT_LOGE("Unknown query object `%s`", object
);
2480 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;