2 * SPDX-License-Identifier: MIT
4 * Copyright 2015-2017 Philippe Proulx <pproulx@efficios.com>
5 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 * Babeltrace CTF file system Reader Component
10 #define BT_COMP_LOG_SELF_COMP self_comp
11 #define BT_LOG_OUTPUT_LEVEL log_level
12 #define BT_LOG_TAG "PLUGIN/SRC.CTF.FS"
13 #include "logging/comp-logging.h"
15 #include "common/common.h"
16 #include <babeltrace2/babeltrace.h>
17 #include "common/uuid.h"
19 #include "common/assert.h"
23 #include "metadata.hpp"
24 #include "data-stream-file.hpp"
26 #include "../common/metadata/decoder.hpp"
27 #include "../common/metadata/ctf-meta-configure-ir-trace.hpp"
28 #include "../common/msg-iter/msg-iter.hpp"
30 #include "plugins/common/param-validation/param-validation.h"
40 static void ctf_fs_msg_iter_data_destroy(struct ctf_fs_msg_iter_data
*msg_iter_data
)
46 if (msg_iter_data
->msg_iter
) {
47 ctf_msg_iter_destroy(msg_iter_data
->msg_iter
);
50 if (msg_iter_data
->msg_iter_medops_data
) {
51 ctf_fs_ds_group_medops_data_destroy(msg_iter_data
->msg_iter_medops_data
);
54 g_free(msg_iter_data
);
57 static bt_message_iterator_class_next_method_status
58 ctf_fs_iterator_next_one(struct ctf_fs_msg_iter_data
*msg_iter_data
, const bt_message
**out_msg
)
60 bt_message_iterator_class_next_method_status status
;
61 enum ctf_msg_iter_status msg_iter_status
;
62 bt_logging_level log_level
= msg_iter_data
->log_level
;
64 msg_iter_status
= ctf_msg_iter_get_next_message(msg_iter_data
->msg_iter
, out_msg
);
66 switch (msg_iter_status
) {
67 case CTF_MSG_ITER_STATUS_OK
:
68 /* Cool, message has been written to *out_msg. */
69 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
72 case CTF_MSG_ITER_STATUS_EOF
:
73 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END
;
76 case CTF_MSG_ITER_STATUS_AGAIN
:
78 * Should not make it this far as this is
79 * medium-specific; there is nothing for the user to do
80 * and it should have been handled upstream.
84 case CTF_MSG_ITER_STATUS_ERROR
:
85 BT_MSG_ITER_LOGE_APPEND_CAUSE(msg_iter_data
->self_msg_iter
,
86 "Failed to get next message from CTF message iterator.");
87 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_ERROR
;
90 case CTF_MSG_ITER_STATUS_MEMORY_ERROR
:
91 BT_MSG_ITER_LOGE_APPEND_CAUSE(msg_iter_data
->self_msg_iter
,
92 "Failed to get next message from CTF message iterator.");
93 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_MEMORY_ERROR
;
104 bt_message_iterator_class_next_method_status
105 ctf_fs_iterator_next(bt_self_message_iterator
*iterator
, bt_message_array_const msgs
,
106 uint64_t capacity
, uint64_t *count
)
108 bt_message_iterator_class_next_method_status status
;
109 struct ctf_fs_msg_iter_data
*msg_iter_data
=
110 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(iterator
);
113 if (G_UNLIKELY(msg_iter_data
->next_saved_error
)) {
115 * Last time we were called, we hit an error but had some
116 * messages to deliver, so we stashed the error here. Return
119 BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(msg_iter_data
->next_saved_error
);
120 status
= msg_iter_data
->next_saved_status
;
125 status
= ctf_fs_iterator_next_one(msg_iter_data
, &msgs
[i
]);
126 if (status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
) {
129 } while (i
< capacity
&& status
== BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
);
133 * Even if ctf_fs_iterator_next_one() returned something
134 * else than BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK, we
135 * accumulated message objects in the output
136 * message array, so we need to return
137 * BT_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK so that they are
138 * transfered to downstream. This other status occurs
139 * again the next time muxer_msg_iter_do_next() is
140 * called, possibly without any accumulated
141 * message, in which case we'll return it.
145 * Save this error for the next _next call. Assume that
146 * this component always appends error causes when
147 * returning an error status code, which will cause the
148 * current thread error to be non-NULL.
150 msg_iter_data
->next_saved_error
= bt_current_thread_take_error();
151 BT_ASSERT(msg_iter_data
->next_saved_error
);
152 msg_iter_data
->next_saved_status
= status
;
156 status
= BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK
;
164 bt_message_iterator_class_seek_beginning_method_status
165 ctf_fs_iterator_seek_beginning(bt_self_message_iterator
*it
)
167 struct ctf_fs_msg_iter_data
*msg_iter_data
=
168 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(it
);
170 BT_ASSERT(msg_iter_data
);
172 ctf_msg_iter_reset(msg_iter_data
->msg_iter
);
173 ctf_fs_ds_group_medops_data_reset(msg_iter_data
->msg_iter_medops_data
);
175 return BT_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHOD_STATUS_OK
;
179 void ctf_fs_iterator_finalize(bt_self_message_iterator
*it
)
181 ctf_fs_msg_iter_data_destroy(
182 (struct ctf_fs_msg_iter_data
*) bt_self_message_iterator_get_data(it
));
185 static bt_message_iterator_class_initialize_method_status
186 ctf_msg_iter_medium_status_to_msg_iter_initialize_status(enum ctf_msg_iter_medium_status status
)
189 case CTF_MSG_ITER_MEDIUM_STATUS_EOF
:
190 case CTF_MSG_ITER_MEDIUM_STATUS_AGAIN
:
191 case CTF_MSG_ITER_MEDIUM_STATUS_ERROR
:
192 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
193 case CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
:
194 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
195 case CTF_MSG_ITER_MEDIUM_STATUS_OK
:
196 return BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
203 bt_message_iterator_class_initialize_method_status
204 ctf_fs_iterator_init(bt_self_message_iterator
*self_msg_iter
,
205 bt_self_message_iterator_configuration
*config
,
206 bt_self_component_port_output
*self_port
)
208 struct ctf_fs_port_data
*port_data
;
209 struct ctf_fs_msg_iter_data
*msg_iter_data
= NULL
;
210 bt_message_iterator_class_initialize_method_status status
;
211 bt_logging_level log_level
;
212 enum ctf_msg_iter_medium_status medium_status
;
213 bt_self_component
*self_comp
= bt_self_message_iterator_borrow_component(self_msg_iter
);
215 port_data
= (struct ctf_fs_port_data
*) bt_self_component_port_get_data(
216 bt_self_component_port_output_as_self_component_port(self_port
));
217 BT_ASSERT(port_data
);
218 log_level
= port_data
->ctf_fs
->log_level
;
219 msg_iter_data
= g_new0(struct ctf_fs_msg_iter_data
, 1);
220 if (!msg_iter_data
) {
221 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
225 msg_iter_data
->log_level
= log_level
;
226 msg_iter_data
->self_comp
= self_comp
;
227 msg_iter_data
->self_msg_iter
= self_msg_iter
;
228 msg_iter_data
->ds_file_group
= port_data
->ds_file_group
;
231 ctf_fs_ds_group_medops_data_create(msg_iter_data
->ds_file_group
, self_msg_iter
, log_level
,
232 &msg_iter_data
->msg_iter_medops_data
);
233 BT_ASSERT(medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_OK
||
234 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_ERROR
||
235 medium_status
== CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
);
236 if (medium_status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
237 BT_MSG_ITER_LOGE_APPEND_CAUSE(self_msg_iter
, "Failed to create ctf_fs_ds_group_medops");
238 status
= ctf_msg_iter_medium_status_to_msg_iter_initialize_status(medium_status
);
242 msg_iter_data
->msg_iter
= ctf_msg_iter_create(
243 msg_iter_data
->ds_file_group
->ctf_fs_trace
->metadata
->tc
,
244 bt_common_get_page_size(msg_iter_data
->log_level
) * 8, ctf_fs_ds_group_medops
,
245 msg_iter_data
->msg_iter_medops_data
, msg_iter_data
->log_level
, self_comp
, self_msg_iter
);
246 if (!msg_iter_data
->msg_iter
) {
247 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Cannot create a CTF message iterator.");
248 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR
;
253 * This iterator can seek forward if its stream class has a default
256 if (msg_iter_data
->ds_file_group
->sc
->default_clock_class
) {
257 bt_self_message_iterator_configuration_set_can_seek_forward(config
, true);
260 bt_self_message_iterator_set_data(self_msg_iter
, msg_iter_data
);
261 msg_iter_data
= NULL
;
263 status
= BT_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD_STATUS_OK
;
267 bt_self_message_iterator_set_data(self_msg_iter
, NULL
);
270 ctf_fs_msg_iter_data_destroy(msg_iter_data
);
274 static void ctf_fs_trace_destroy(struct ctf_fs_trace
*ctf_fs_trace
)
280 if (ctf_fs_trace
->ds_file_groups
) {
281 g_ptr_array_free(ctf_fs_trace
->ds_file_groups
, TRUE
);
284 BT_TRACE_PUT_REF_AND_RESET(ctf_fs_trace
->trace
);
286 if (ctf_fs_trace
->path
) {
287 g_string_free(ctf_fs_trace
->path
, TRUE
);
290 if (ctf_fs_trace
->metadata
) {
291 ctf_fs_metadata_fini(ctf_fs_trace
->metadata
);
292 g_free(ctf_fs_trace
->metadata
);
295 g_free(ctf_fs_trace
);
299 void ctf_fs_destroy(struct ctf_fs_component
*ctf_fs
)
305 ctf_fs_trace_destroy(ctf_fs
->trace
);
307 if (ctf_fs
->port_data
) {
308 g_ptr_array_free(ctf_fs
->port_data
, TRUE
);
314 static void port_data_destroy(struct ctf_fs_port_data
*port_data
)
323 static void port_data_destroy_notifier(void *data
)
325 port_data_destroy((struct ctf_fs_port_data
*) data
);
328 static void ctf_fs_trace_destroy_notifier(void *data
)
330 struct ctf_fs_trace
*trace
= (struct ctf_fs_trace
*) data
;
331 ctf_fs_trace_destroy(trace
);
334 struct ctf_fs_component
*ctf_fs_component_create(bt_logging_level log_level
,
335 bt_self_component
*self_comp
)
337 struct ctf_fs_component
*ctf_fs
;
339 ctf_fs
= g_new0(struct ctf_fs_component
, 1);
344 ctf_fs
->log_level
= log_level
;
345 ctf_fs
->port_data
= g_ptr_array_new_with_free_func(port_data_destroy_notifier
);
346 if (!ctf_fs
->port_data
) {
353 ctf_fs_destroy(ctf_fs
);
360 void ctf_fs_finalize(bt_self_component_source
*component
)
362 ctf_fs_destroy((struct ctf_fs_component
*) bt_self_component_get_data(
363 bt_self_component_source_as_self_component(component
)));
366 gchar
*ctf_fs_make_port_name(struct ctf_fs_ds_file_group
*ds_file_group
)
368 GString
*name
= g_string_new(NULL
);
371 * The unique port name is generated by concatenating unique identifiers
379 /* For the trace, use the uuid if present, else the path. */
380 if (ds_file_group
->ctf_fs_trace
->metadata
->tc
->is_uuid_set
) {
381 char uuid_str
[BT_UUID_STR_LEN
+ 1];
383 bt_uuid_to_str(ds_file_group
->ctf_fs_trace
->metadata
->tc
->uuid
, uuid_str
);
384 g_string_assign(name
, uuid_str
);
386 g_string_assign(name
, ds_file_group
->ctf_fs_trace
->path
->str
);
390 * For the stream class, use the id if present. We can omit this field
391 * otherwise, as there will only be a single stream class.
393 if (ds_file_group
->sc
->id
!= UINT64_C(-1)) {
394 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->sc
->id
);
397 /* For the stream, use the id if present, else, use the path. */
398 if (ds_file_group
->stream_id
!= UINT64_C(-1)) {
399 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->stream_id
);
401 BT_ASSERT(ds_file_group
->ds_file_infos
->len
== 1);
402 struct ctf_fs_ds_file_info
*ds_file_info
=
403 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
404 g_string_append_printf(name
, " | %s", ds_file_info
->path
->str
);
407 return g_string_free(name
, FALSE
);
410 static int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
411 struct ctf_fs_trace
*ctf_fs_trace
,
412 struct ctf_fs_ds_file_group
*ds_file_group
,
413 bt_self_component_source
*self_comp_src
)
416 struct ctf_fs_port_data
*port_data
= NULL
;
418 bt_logging_level log_level
= ctf_fs
->log_level
;
419 bt_self_component
*self_comp
= bt_self_component_source_as_self_component(self_comp_src
);
421 port_name
= ctf_fs_make_port_name(ds_file_group
);
426 BT_COMP_LOGI("Creating one port named `%s`", port_name
);
428 /* Create output port for this file */
429 port_data
= g_new0(struct ctf_fs_port_data
, 1);
434 port_data
->ctf_fs
= ctf_fs
;
435 port_data
->ds_file_group
= ds_file_group
;
436 ret
= bt_self_component_source_add_output_port(self_comp_src
, port_name
, port_data
, NULL
);
441 g_ptr_array_add(ctf_fs
->port_data
, port_data
);
451 port_data_destroy(port_data
);
455 static int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
456 struct ctf_fs_trace
*ctf_fs_trace
,
457 bt_self_component_source
*self_comp_src
)
461 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
462 bt_self_component
*self_comp
= bt_self_component_source_as_self_component(self_comp_src
);
464 /* Create one output port for each stream file group */
465 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
466 struct ctf_fs_ds_file_group
*ds_file_group
=
467 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
469 ret
= create_one_port_for_trace(ctf_fs
, ctf_fs_trace
, ds_file_group
, self_comp_src
);
471 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Cannot create output port.");
480 static void ctf_fs_ds_file_info_destroy(struct ctf_fs_ds_file_info
*ds_file_info
)
486 if (ds_file_info
->path
) {
487 g_string_free(ds_file_info
->path
, TRUE
);
490 g_free(ds_file_info
);
493 static struct ctf_fs_ds_file_info
*ctf_fs_ds_file_info_create(const char *path
, int64_t begin_ns
)
495 struct ctf_fs_ds_file_info
*ds_file_info
;
497 ds_file_info
= g_new0(struct ctf_fs_ds_file_info
, 1);
502 ds_file_info
->path
= g_string_new(path
);
503 if (!ds_file_info
->path
) {
504 ctf_fs_ds_file_info_destroy(ds_file_info
);
509 ds_file_info
->begin_ns
= begin_ns
;
515 static void ctf_fs_ds_file_group_destroy(struct ctf_fs_ds_file_group
*ds_file_group
)
517 if (!ds_file_group
) {
521 if (ds_file_group
->ds_file_infos
) {
522 g_ptr_array_free(ds_file_group
->ds_file_infos
, TRUE
);
525 ctf_fs_ds_index_destroy(ds_file_group
->index
);
527 bt_stream_put_ref(ds_file_group
->stream
);
528 g_free(ds_file_group
);
531 static struct ctf_fs_ds_file_group
*ctf_fs_ds_file_group_create(struct ctf_fs_trace
*ctf_fs_trace
,
532 struct ctf_stream_class
*sc
,
533 uint64_t stream_instance_id
,
534 struct ctf_fs_ds_index
*index
)
536 struct ctf_fs_ds_file_group
*ds_file_group
;
538 ds_file_group
= g_new0(struct ctf_fs_ds_file_group
, 1);
539 if (!ds_file_group
) {
543 ds_file_group
->ds_file_infos
=
544 g_ptr_array_new_with_free_func((GDestroyNotify
) ctf_fs_ds_file_info_destroy
);
545 if (!ds_file_group
->ds_file_infos
) {
549 ds_file_group
->index
= index
;
551 ds_file_group
->stream_id
= stream_instance_id
;
553 ds_file_group
->sc
= sc
;
554 ds_file_group
->ctf_fs_trace
= ctf_fs_trace
;
558 ctf_fs_ds_file_group_destroy(ds_file_group
);
559 ctf_fs_ds_index_destroy(index
);
560 ds_file_group
= NULL
;
563 return ds_file_group
;
566 /* Replace by g_ptr_array_insert when we depend on glib >= 2.40. */
567 static void array_insert(GPtrArray
*array
, gpointer element
, size_t pos
)
569 size_t original_array_len
= array
->len
;
571 /* Allocate an unused element at the end of the array. */
572 g_ptr_array_add(array
, NULL
);
574 /* If we are not inserting at the end, move the elements by one. */
575 if (pos
< original_array_len
) {
576 memmove(&(array
->pdata
[pos
+ 1]), &(array
->pdata
[pos
]),
577 (original_array_len
- pos
) * sizeof(gpointer
));
580 /* Insert the value. */
581 array
->pdata
[pos
] = element
;
585 * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right
586 * place to keep it sorted.
589 static void ds_file_group_insert_ds_file_info_sorted(struct ctf_fs_ds_file_group
*ds_file_group
,
590 struct ctf_fs_ds_file_info
*ds_file_info
)
594 /* Find the spot where to insert this ds_file_info. */
595 for (i
= 0; i
< ds_file_group
->ds_file_infos
->len
; i
++) {
596 struct ctf_fs_ds_file_info
*other_ds_file_info
=
597 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, i
);
599 if (ds_file_info
->begin_ns
< other_ds_file_info
->begin_ns
) {
604 array_insert(ds_file_group
->ds_file_infos
, ds_file_info
, i
);
607 static bool ds_index_entries_equal(const struct ctf_fs_ds_index_entry
*left
,
608 const struct ctf_fs_ds_index_entry
*right
)
610 if (left
->packet_size
!= right
->packet_size
) {
614 if (left
->timestamp_begin
!= right
->timestamp_begin
) {
618 if (left
->timestamp_end
!= right
->timestamp_end
) {
622 if (left
->packet_seq_num
!= right
->packet_seq_num
) {
630 * Insert `entry` into `index`, without duplication.
632 * The entry is inserted only if there isn't an identical entry already.
634 * In any case, the ownership of `entry` is transferred to this function. So if
635 * the entry is not inserted, it is freed.
638 static void ds_index_insert_ds_index_entry_sorted(struct ctf_fs_ds_index
*index
,
639 struct ctf_fs_ds_index_entry
*entry
)
642 struct ctf_fs_ds_index_entry
*other_entry
= NULL
;
644 /* Find the spot where to insert this index entry. */
645 for (i
= 0; i
< index
->entries
->len
; i
++) {
646 other_entry
= (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, i
);
648 if (entry
->timestamp_begin_ns
<= other_entry
->timestamp_begin_ns
) {
654 * Insert the entry only if a duplicate doesn't already exist.
656 * There can be duplicate packets if reading multiple overlapping
657 * snapshots of the same trace. We then want the index to contain
658 * a reference to only one copy of that packet.
660 if (i
== index
->entries
->len
|| !ds_index_entries_equal(entry
, other_entry
)) {
661 array_insert(index
->entries
, entry
, i
);
667 static void merge_ctf_fs_ds_indexes(struct ctf_fs_ds_index
*dest
, struct ctf_fs_ds_index
*src
)
671 for (i
= 0; i
< src
->entries
->len
; i
++) {
672 struct ctf_fs_ds_index_entry
*entry
=
673 (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(src
->entries
, i
);
676 * Ownership of the ctf_fs_ds_index_entry is transferred to
677 * ds_index_insert_ds_index_entry_sorted.
679 g_ptr_array_index(src
->entries
, i
) = NULL
;
680 ds_index_insert_ds_index_entry_sorted(dest
, entry
);
684 static int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
, const char *path
)
686 int64_t stream_instance_id
= -1;
687 int64_t begin_ns
= -1;
688 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
689 bool add_group
= false;
692 struct ctf_fs_ds_file
*ds_file
= NULL
;
693 struct ctf_fs_ds_file_info
*ds_file_info
= NULL
;
694 struct ctf_fs_ds_index
*index
= NULL
;
695 struct ctf_msg_iter
*msg_iter
= NULL
;
696 struct ctf_stream_class
*sc
= NULL
;
697 struct ctf_msg_iter_packet_properties props
;
698 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
699 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
700 bt_self_component_class
*self_comp_class
= ctf_fs_trace
->self_comp_class
;
703 * Create a temporary ds_file to read some properties about the data
706 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, path
, log_level
);
711 /* Create a temporary iterator to read the ds_file. */
713 ctf_msg_iter_create(ctf_fs_trace
->metadata
->tc
, bt_common_get_page_size(log_level
) * 8,
714 ctf_fs_ds_file_medops
, ds_file
, log_level
, self_comp
, NULL
);
716 BT_COMP_LOGE_STR("Cannot create a CTF message iterator.");
720 ctf_msg_iter_set_dry_run(msg_iter
, true);
722 ret
= ctf_msg_iter_get_packet_properties(msg_iter
, &props
);
724 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
725 self_comp
, self_comp_class
,
726 "Cannot get stream file's first packet's header and context fields (`%s`).", path
);
730 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
, props
.stream_class_id
);
732 stream_instance_id
= props
.data_stream_id
;
734 if (props
.snapshots
.beginning_clock
!= UINT64_C(-1)) {
735 BT_ASSERT(sc
->default_clock_class
);
736 ret
= bt_util_clock_cycles_to_ns_from_origin(
737 props
.snapshots
.beginning_clock
, sc
->default_clock_class
->frequency
,
738 sc
->default_clock_class
->offset_seconds
, sc
->default_clock_class
->offset_cycles
,
741 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
742 self_comp
, self_comp_class
,
743 "Cannot convert clock cycles to nanoseconds from origin (`%s`).", path
);
748 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
);
753 index
= ctf_fs_ds_file_build_index(ds_file
, ds_file_info
, msg_iter
);
755 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
756 "Failed to index CTF stream file \'%s\'",
757 ds_file
->file
->path
->str
);
761 if (begin_ns
== -1) {
763 * No beginning timestamp to sort the stream files
764 * within a stream file group, so consider that this
765 * file must be the only one within its group.
767 stream_instance_id
= -1;
770 if (stream_instance_id
== -1) {
772 * No stream instance ID or no beginning timestamp:
773 * create a unique stream file group for this stream
774 * file because, even if there's a stream instance ID,
775 * there's no timestamp to order the file within its
778 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, UINT64_C(-1), index
);
779 /* Ownership of index is transferred. */
782 if (!ds_file_group
) {
786 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, BT_MOVE_REF(ds_file_info
));
792 BT_ASSERT(stream_instance_id
!= -1);
793 BT_ASSERT(begin_ns
!= -1);
795 /* Find an existing stream file group with this ID */
796 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
798 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
800 if (ds_file_group
->sc
== sc
&& ds_file_group
->stream_id
== stream_instance_id
) {
804 ds_file_group
= NULL
;
807 if (!ds_file_group
) {
808 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
, sc
, stream_instance_id
, index
);
809 /* Ownership of index is transferred. */
811 if (!ds_file_group
) {
817 merge_ctf_fs_ds_indexes(ds_file_group
->index
, index
);
820 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, BT_MOVE_REF(ds_file_info
));
825 ctf_fs_ds_file_group_destroy(ds_file_group
);
826 ds_file_group
= NULL
;
830 if (add_group
&& ds_file_group
) {
831 g_ptr_array_add(ctf_fs_trace
->ds_file_groups
, ds_file_group
);
834 ctf_fs_ds_file_destroy(ds_file
);
835 ctf_fs_ds_file_info_destroy(ds_file_info
);
838 ctf_msg_iter_destroy(msg_iter
);
841 ctf_fs_ds_index_destroy(index
);
845 static int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
848 const char *basename
;
849 GError
*error
= NULL
;
851 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
852 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
853 bt_self_component_class
*self_comp_class
= ctf_fs_trace
->self_comp_class
;
855 /* Check each file in the path directory, except specific ones */
856 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
858 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
859 self_comp
, self_comp_class
, "Cannot open directory `%s`: %s (code %d)",
860 ctf_fs_trace
->path
->str
, error
->message
, error
->code
);
864 while ((basename
= g_dir_read_name(dir
))) {
865 struct ctf_fs_file
*file
;
867 if (strcmp(basename
, CTF_FS_METADATA_FILENAME
) == 0) {
868 /* Ignore the metadata stream. */
869 BT_COMP_LOGI("Ignoring metadata file `%s" G_DIR_SEPARATOR_S
"%s`",
870 ctf_fs_trace
->path
->str
, basename
);
874 if (basename
[0] == '.') {
875 BT_COMP_LOGI("Ignoring hidden file `%s" G_DIR_SEPARATOR_S
"%s`",
876 ctf_fs_trace
->path
->str
, basename
);
880 /* Create the file. */
881 file
= ctf_fs_file_create(log_level
, self_comp
);
883 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
884 self_comp
, self_comp_class
,
885 "Cannot create stream file object for file `%s" G_DIR_SEPARATOR_S
"%s`",
886 ctf_fs_trace
->path
->str
, basename
);
890 /* Create full path string. */
891 g_string_append_printf(file
->path
, "%s" G_DIR_SEPARATOR_S
"%s", ctf_fs_trace
->path
->str
,
893 if (!g_file_test(file
->path
->str
, G_FILE_TEST_IS_REGULAR
)) {
894 BT_COMP_LOGI("Ignoring non-regular file `%s`", file
->path
->str
);
895 ctf_fs_file_destroy(file
);
900 ret
= ctf_fs_file_open(file
, "rb");
902 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
903 self_comp
, self_comp_class
, "Cannot open stream file `%s`", file
->path
->str
);
907 if (file
->size
== 0) {
908 /* Skip empty stream. */
909 BT_COMP_LOGI("Ignoring empty file `%s`", file
->path
->str
);
910 ctf_fs_file_destroy(file
);
914 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
, file
->path
->str
);
916 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
917 self_comp
, self_comp_class
, "Cannot add stream file `%s` to stream file group",
919 ctf_fs_file_destroy(file
);
923 ctf_fs_file_destroy(file
);
944 static int set_trace_name(bt_trace
*trace
, const char *name_suffix
, bt_logging_level log_level
,
945 bt_self_component
*self_comp
)
951 name
= g_string_new(NULL
);
953 BT_COMP_LOGE_STR("Failed to allocate a GString.");
959 * Check if we have a trace environment string value named `hostname`.
960 * If so, use it as the trace name's prefix.
962 val
= bt_trace_borrow_environment_entry_value_by_name_const(trace
, "hostname");
963 if (val
&& bt_value_is_string(val
)) {
964 g_string_append(name
, bt_value_string_get(val
));
967 g_string_append_c(name
, G_DIR_SEPARATOR
);
972 g_string_append(name
, name_suffix
);
975 ret
= bt_trace_set_name(trace
, name
->str
);
984 g_string_free(name
, TRUE
);
990 static struct ctf_fs_trace
*ctf_fs_trace_create(bt_self_component
*self_comp
,
991 bt_self_component_class
*self_comp_class
,
992 const char *path
, const char *name
,
993 struct ctf_fs_metadata_config
*metadata_config
,
994 bt_logging_level log_level
)
996 struct ctf_fs_trace
*ctf_fs_trace
;
999 /* Only one of them must be set. */
1000 BT_ASSERT(!self_comp
!= !self_comp_class
);
1002 ctf_fs_trace
= g_new0(struct ctf_fs_trace
, 1);
1003 if (!ctf_fs_trace
) {
1007 ctf_fs_trace
->log_level
= log_level
;
1008 ctf_fs_trace
->self_comp
= self_comp
;
1009 ctf_fs_trace
->self_comp_class
= self_comp_class
;
1010 ctf_fs_trace
->path
= g_string_new(path
);
1011 if (!ctf_fs_trace
->path
) {
1015 ctf_fs_trace
->metadata
= g_new0(struct ctf_fs_metadata
, 1);
1016 if (!ctf_fs_trace
->metadata
) {
1020 ctf_fs_metadata_init(ctf_fs_trace
->metadata
);
1021 ctf_fs_trace
->ds_file_groups
=
1022 g_ptr_array_new_with_free_func((GDestroyNotify
) ctf_fs_ds_file_group_destroy
);
1023 if (!ctf_fs_trace
->ds_file_groups
) {
1027 ret
= ctf_fs_metadata_set_trace_class(self_comp
, ctf_fs_trace
, metadata_config
);
1032 if (ctf_fs_trace
->metadata
->trace_class
) {
1033 ctf_fs_trace
->trace
= bt_trace_create(ctf_fs_trace
->metadata
->trace_class
);
1034 if (!ctf_fs_trace
->trace
) {
1039 if (ctf_fs_trace
->trace
) {
1040 ret
= ctf_trace_class_configure_ir_trace(ctf_fs_trace
->metadata
->tc
, ctf_fs_trace
->trace
);
1045 ret
= set_trace_name(ctf_fs_trace
->trace
, name
, log_level
, self_comp
);
1051 ret
= create_ds_file_groups(ctf_fs_trace
);
1059 ctf_fs_trace_destroy(ctf_fs_trace
);
1060 ctf_fs_trace
= NULL
;
1063 return ctf_fs_trace
;
1066 static int path_is_ctf_trace(const char *path
)
1068 GString
*metadata_path
= g_string_new(NULL
);
1071 if (!metadata_path
) {
1076 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
1078 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
1084 g_string_free(metadata_path
, TRUE
);
1088 /* Helper for ctf_fs_component_create_ctf_fs_trace, to handle a single path. */
1090 static int ctf_fs_component_create_ctf_fs_trace_one_path(struct ctf_fs_component
*ctf_fs
,
1091 const char *path_param
,
1092 const char *trace_name
, GPtrArray
*traces
,
1093 bt_self_component
*self_comp
,
1094 bt_self_component_class
*self_comp_class
)
1096 struct ctf_fs_trace
*ctf_fs_trace
;
1099 bt_logging_level log_level
= ctf_fs
->log_level
;
1101 norm_path
= bt_common_normalize_path(path_param
, NULL
);
1103 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1104 "Failed to normalize path: `%s`.", path_param
);
1108 ret
= path_is_ctf_trace(norm_path
->str
);
1110 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1111 "Failed to check if path is a CTF trace: path=%s",
1114 } else if (ret
== 0) {
1115 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
1116 self_comp
, self_comp_class
,
1117 "Path is not a CTF trace (does not contain a metadata file): `%s`.", norm_path
->str
);
1121 // FIXME: Remove or ifdef for __MINGW32__
1122 if (strcmp(norm_path
->str
, "/") == 0) {
1123 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1124 "Opening a trace in `/` is not supported.");
1129 ctf_fs_trace
= ctf_fs_trace_create(self_comp
, self_comp_class
, norm_path
->str
, trace_name
,
1130 &ctf_fs
->metadata_config
, log_level
);
1131 if (!ctf_fs_trace
) {
1132 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1133 "Cannot create trace for `%s`.", norm_path
->str
);
1137 g_ptr_array_add(traces
, ctf_fs_trace
);
1138 ctf_fs_trace
= NULL
;
1148 g_string_free(norm_path
, TRUE
);
1155 * Count the number of stream and event classes defined by this trace's metadata.
1157 * This is used to determine which metadata is the "latest", out of multiple
1158 * traces sharing the same UUID. It is assumed that amongst all these metadatas,
1159 * a bigger metadata is a superset of a smaller metadata. Therefore, it is
1160 * enough to just count the classes.
1163 static unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace
*trace
)
1165 unsigned int num
= trace
->metadata
->tc
->stream_classes
->len
;
1168 for (i
= 0; i
< trace
->metadata
->tc
->stream_classes
->len
; i
++) {
1169 struct ctf_stream_class
*sc
=
1170 (struct ctf_stream_class
*) trace
->metadata
->tc
->stream_classes
->pdata
[i
];
1171 num
+= sc
->event_classes
->len
;
1178 * Merge the src ds_file_group into dest. This consists of merging their
1179 * ds_file_infos, making sure to keep the result sorted.
1182 static void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group
*dest
,
1183 struct ctf_fs_ds_file_group
*src
)
1187 for (i
= 0; i
< src
->ds_file_infos
->len
; i
++) {
1188 struct ctf_fs_ds_file_info
*ds_file_info
=
1189 (struct ctf_fs_ds_file_info
*) g_ptr_array_index(src
->ds_file_infos
, i
);
1191 /* Ownership of the ds_file_info is transferred to dest. */
1192 g_ptr_array_index(src
->ds_file_infos
, i
) = NULL
;
1194 ds_file_group_insert_ds_file_info_sorted(dest
, ds_file_info
);
1197 /* Merge both indexes. */
1198 merge_ctf_fs_ds_indexes(dest
->index
, src
->index
);
1200 /* Merge src_trace's data stream file groups into dest_trace's. */
1202 static int merge_matching_ctf_fs_ds_file_groups(struct ctf_fs_trace
*dest_trace
,
1203 struct ctf_fs_trace
*src_trace
)
1205 GPtrArray
*dest
= dest_trace
->ds_file_groups
;
1206 GPtrArray
*src
= src_trace
->ds_file_groups
;
1211 * Save the initial length of dest: we only want to check against the
1212 * original elements in the inner loop.
1214 const guint dest_len
= dest
->len
;
1216 for (s_i
= 0; s_i
< src
->len
; s_i
++) {
1217 struct ctf_fs_ds_file_group
*src_group
=
1218 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(src
, s_i
);
1219 struct ctf_fs_ds_file_group
*dest_group
= NULL
;
1221 /* A stream instance without ID can't match a stream in the other trace. */
1222 if (src_group
->stream_id
!= -1) {
1225 /* Let's search for a matching ds_file_group in the destination. */
1226 for (d_i
= 0; d_i
< dest_len
; d_i
++) {
1227 struct ctf_fs_ds_file_group
*candidate_dest
=
1228 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(dest
, d_i
);
1230 /* Can't match a stream instance without ID. */
1231 if (candidate_dest
->stream_id
== -1) {
1236 * If the two groups have the same stream instance id
1237 * and belong to the same stream class (stream instance
1238 * ids are per-stream class), they represent the same
1241 if (candidate_dest
->stream_id
!= src_group
->stream_id
||
1242 candidate_dest
->sc
->id
!= src_group
->sc
->id
) {
1246 dest_group
= candidate_dest
;
1252 * Didn't find a friend in dest to merge our src_group into?
1253 * Create a new empty one. This can happen if a stream was
1254 * active in the source trace chunk but not in the destination
1258 struct ctf_stream_class
*sc
;
1259 struct ctf_fs_ds_index
*index
;
1261 sc
= ctf_trace_class_borrow_stream_class_by_id(dest_trace
->metadata
->tc
,
1265 index
= ctf_fs_ds_index_create(dest_trace
->log_level
, dest_trace
->self_comp
);
1271 dest_group
= ctf_fs_ds_file_group_create(dest_trace
, sc
, src_group
->stream_id
, index
);
1272 /* Ownership of index is transferred. */
1279 g_ptr_array_add(dest_trace
->ds_file_groups
, dest_group
);
1282 BT_ASSERT(dest_group
);
1283 merge_ctf_fs_ds_file_groups(dest_group
, src_group
);
1291 * Collapse the given traces, which must all share the same UUID, in a single
1294 * The trace with the most expansive metadata is chosen and all other traces
1295 * are merged into that one. The array slots of all the traces that get merged
1296 * in the chosen one are set to NULL, so only the slot of the chosen trace
1300 static int merge_ctf_fs_traces(struct ctf_fs_trace
**traces
, unsigned int num_traces
,
1301 struct ctf_fs_trace
**out_trace
)
1303 unsigned int winner_count
;
1304 struct ctf_fs_trace
*winner
;
1308 BT_ASSERT(num_traces
>= 2);
1310 winner_count
= metadata_count_stream_and_event_classes(traces
[0]);
1314 /* Find the trace with the largest metadata. */
1315 for (i
= 1; i
< num_traces
; i
++) {
1316 struct ctf_fs_trace
*candidate
;
1317 unsigned int candidate_count
;
1319 candidate
= traces
[i
];
1321 /* A bit of sanity check. */
1322 BT_ASSERT(bt_uuid_compare(winner
->metadata
->tc
->uuid
, candidate
->metadata
->tc
->uuid
) == 0);
1324 candidate_count
= metadata_count_stream_and_event_classes(candidate
);
1326 if (candidate_count
> winner_count
) {
1327 winner_count
= candidate_count
;
1333 /* Merge all the other traces in the winning trace. */
1334 for (i
= 0; i
< num_traces
; i
++) {
1335 struct ctf_fs_trace
*trace
= traces
[i
];
1337 /* Don't merge the winner into itself. */
1338 if (trace
== winner
) {
1342 /* Merge trace's data stream file groups into winner's. */
1343 ret
= merge_matching_ctf_fs_ds_file_groups(winner
, trace
);
1350 * Move the winner out of the array, into `*out_trace`.
1352 *out_trace
= winner
;
1353 traces
[winner_i
] = NULL
;
1365 static int decode_clock_snapshot_after_event(struct ctf_fs_trace
*ctf_fs_trace
,
1366 struct ctf_clock_class
*default_cc
,
1367 struct ctf_fs_ds_index_entry
*index_entry
,
1368 enum target_event target_event
, uint64_t *cs
,
1371 enum ctf_msg_iter_status iter_status
= CTF_MSG_ITER_STATUS_OK
;
1372 struct ctf_fs_ds_file
*ds_file
= NULL
;
1373 struct ctf_msg_iter
*msg_iter
= NULL
;
1374 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
1375 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
1378 BT_ASSERT(ctf_fs_trace
);
1379 BT_ASSERT(index_entry
);
1380 BT_ASSERT(index_entry
->path
);
1382 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, index_entry
->path
, log_level
);
1384 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Failed to create a ctf_fs_ds_file");
1389 BT_ASSERT(ctf_fs_trace
->metadata
);
1390 BT_ASSERT(ctf_fs_trace
->metadata
->tc
);
1393 ctf_msg_iter_create(ctf_fs_trace
->metadata
->tc
, bt_common_get_page_size(log_level
) * 8,
1394 ctf_fs_ds_file_medops
, ds_file
, log_level
, self_comp
, NULL
);
1396 /* ctf_msg_iter_create() logs errors. */
1402 * Turn on dry run mode to prevent the creation and usage of Babeltrace
1403 * library objects (bt_field, bt_message_*, etc.).
1405 ctf_msg_iter_set_dry_run(msg_iter
, true);
1407 /* Seek to the beginning of the target packet. */
1408 iter_status
= ctf_msg_iter_seek(msg_iter
, index_entry
->offset
);
1410 /* ctf_msg_iter_seek() logs errors. */
1415 switch (target_event
) {
1418 * Start to decode the packet until we reach the end of
1419 * the first event. To extract the first event's clock
1422 iter_status
= ctf_msg_iter_curr_packet_first_event_clock_snapshot(msg_iter
, cs
);
1425 /* Decode the packet to extract the last event's clock snapshot. */
1426 iter_status
= ctf_msg_iter_curr_packet_last_event_clock_snapshot(msg_iter
, cs
);
1436 /* Convert clock snapshot to timestamp. */
1437 ret
= bt_util_clock_cycles_to_ns_from_origin(
1438 *cs
, default_cc
->frequency
, default_cc
->offset_seconds
, default_cc
->offset_cycles
, ts_ns
);
1440 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Failed to convert clock snapshot to timestamp");
1446 ctf_fs_ds_file_destroy(ds_file
);
1449 ctf_msg_iter_destroy(msg_iter
);
1455 static int decode_packet_first_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1456 struct ctf_clock_class
*default_cc
,
1457 struct ctf_fs_ds_index_entry
*index_entry
,
1458 uint64_t *cs
, int64_t *ts_ns
)
1460 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, FIRST_EVENT
, cs
,
1464 static int decode_packet_last_event_timestamp(struct ctf_fs_trace
*ctf_fs_trace
,
1465 struct ctf_clock_class
*default_cc
,
1466 struct ctf_fs_ds_index_entry
*index_entry
,
1467 uint64_t *cs
, int64_t *ts_ns
)
1469 return decode_clock_snapshot_after_event(ctf_fs_trace
, default_cc
, index_entry
, LAST_EVENT
, cs
,
1474 * Fix up packet index entries for lttng's "event-after-packet" bug.
1475 * Some buggy lttng tracer versions may emit events with a timestamp that is
1476 * larger (after) than the timestamp_end of the their packets.
1478 * To fix up this erroneous data we do the following:
1479 * 1. If it's not the stream file's last packet: set the packet index entry's
1480 * end time to the next packet's beginning time.
1481 * 2. If it's the stream file's last packet, set the packet index entry's end
1482 * time to the packet's last event's time, if any, or to the packet's
1483 * beginning time otherwise.
1485 * Known buggy tracer versions:
1486 * - before lttng-ust 2.11.0
1487 * - before lttng-module 2.11.0
1488 * - before lttng-module 2.10.10
1489 * - before lttng-module 2.9.13
1491 static int fix_index_lttng_event_after_packet_bug(struct ctf_fs_trace
*trace
)
1494 guint ds_file_group_i
;
1495 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1496 bt_logging_level log_level
= trace
->log_level
;
1498 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
; ds_file_group_i
++) {
1500 struct ctf_clock_class
*default_cc
;
1501 struct ctf_fs_ds_index_entry
*last_entry
;
1502 struct ctf_fs_ds_index
*index
;
1504 struct ctf_fs_ds_file_group
*ds_file_group
=
1505 (struct ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1507 BT_ASSERT(ds_file_group
);
1508 index
= ds_file_group
->index
;
1511 BT_ASSERT(index
->entries
);
1512 BT_ASSERT(index
->entries
->len
> 0);
1515 * Iterate over all entries but the last one. The last one is
1516 * fixed differently after.
1518 for (entry_i
= 0; entry_i
< index
->entries
->len
- 1; entry_i
++) {
1519 struct ctf_fs_ds_index_entry
*curr_entry
, *next_entry
;
1521 curr_entry
= (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
);
1522 next_entry
= (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
+ 1);
1525 * 1. Set the current index entry `end` timestamp to
1526 * the next index entry `begin` timestamp.
1528 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1529 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1533 * 2. Fix the last entry by decoding the last event of the last
1537 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, index
->entries
->len
- 1);
1538 BT_ASSERT(last_entry
);
1540 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1541 default_cc
= ds_file_group
->sc
->default_clock_class
;
1544 * Decode packet to read the timestamp of the last event of the
1547 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1548 &last_entry
->timestamp_end
,
1549 &last_entry
->timestamp_end_ns
);
1551 BT_COMP_LOGE_APPEND_CAUSE(
1553 "Failed to decode stream's last packet to get its last event's clock snapshot.");
1563 * Fix up packet index entries for barectf's "event-before-packet" bug.
1564 * Some buggy barectf tracer versions may emit events with a timestamp that is
1565 * less than the timestamp_begin of the their packets.
1567 * To fix up this erroneous data we do the following:
1568 * 1. Starting at the second index entry, set the timestamp_begin of the
1569 * current entry to the timestamp of the first event of the packet.
1570 * 2. Set the previous entry's timestamp_end to the timestamp_begin of the
1573 * Known buggy tracer versions:
1574 * - before barectf 2.3.1
1576 static int fix_index_barectf_event_before_packet_bug(struct ctf_fs_trace
*trace
)
1579 guint ds_file_group_i
;
1580 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1581 bt_logging_level log_level
= trace
->log_level
;
1583 for (ds_file_group_i
= 0; ds_file_group_i
< ds_file_groups
->len
; ds_file_group_i
++) {
1585 struct ctf_clock_class
*default_cc
;
1586 ctf_fs_ds_file_group
*ds_file_group
=
1587 (ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_i
);
1589 struct ctf_fs_ds_index
*index
= ds_file_group
->index
;
1592 BT_ASSERT(index
->entries
);
1593 BT_ASSERT(index
->entries
->len
> 0);
1595 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1596 default_cc
= ds_file_group
->sc
->default_clock_class
;
1599 * 1. Iterate over the index, starting from the second entry
1602 for (entry_i
= 1; entry_i
< index
->entries
->len
; entry_i
++) {
1603 ctf_fs_ds_index_entry
*prev_entry
=
1604 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
- 1);
1605 ctf_fs_ds_index_entry
*curr_entry
=
1606 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_i
);
1608 * 2. Set the current entry `begin` timestamp to the
1609 * timestamp of the first event of the current packet.
1611 ret
= decode_packet_first_event_timestamp(trace
, default_cc
, curr_entry
,
1612 &curr_entry
->timestamp_begin
,
1613 &curr_entry
->timestamp_begin_ns
);
1615 BT_COMP_LOGE_APPEND_CAUSE(trace
->self_comp
,
1616 "Failed to decode first event's clock snapshot");
1621 * 3. Set the previous entry `end` timestamp to the
1622 * timestamp of the first event of the current packet.
1624 prev_entry
->timestamp_end
= curr_entry
->timestamp_begin
;
1625 prev_entry
->timestamp_end_ns
= curr_entry
->timestamp_begin_ns
;
1633 * When using the lttng-crash feature it's likely that the last packets of each
1634 * stream have their timestamp_end set to zero. This is caused by the fact that
1635 * the tracer crashed and was not able to properly close the packets.
1637 * To fix up this erroneous data we do the following:
1638 * For each index entry, if the entry's timestamp_end is 0 and the
1639 * timestamp_begin is not 0:
1640 * - If it's the stream file's last packet: set the packet index entry's end
1641 * time to the packet's last event's time, if any, or to the packet's
1642 * beginning time otherwise.
1643 * - If it's not the stream file's last packet: set the packet index
1644 * entry's end time to the next packet's beginning time.
1646 * Affected versions:
1647 * - All current and future lttng-ust and lttng-modules versions.
1649 static int fix_index_lttng_crash_quirk(struct ctf_fs_trace
*trace
)
1652 guint ds_file_group_idx
;
1653 GPtrArray
*ds_file_groups
= trace
->ds_file_groups
;
1654 bt_logging_level log_level
= trace
->log_level
;
1656 for (ds_file_group_idx
= 0; ds_file_group_idx
< ds_file_groups
->len
; ds_file_group_idx
++) {
1658 struct ctf_clock_class
*default_cc
;
1659 struct ctf_fs_ds_index
*index
;
1661 ctf_fs_ds_file_group
*ds_file_group
=
1662 (ctf_fs_ds_file_group
*) g_ptr_array_index(ds_file_groups
, ds_file_group_idx
);
1664 BT_ASSERT(ds_file_group
);
1665 index
= ds_file_group
->index
;
1667 BT_ASSERT(ds_file_group
->sc
->default_clock_class
);
1668 default_cc
= ds_file_group
->sc
->default_clock_class
;
1671 BT_ASSERT(index
->entries
);
1672 BT_ASSERT(index
->entries
->len
> 0);
1674 ctf_fs_ds_index_entry
*last_entry
=
1675 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, index
->entries
->len
- 1);
1676 BT_ASSERT(last_entry
);
1678 /* 1. Fix the last entry first. */
1679 if (last_entry
->timestamp_end
== 0 && last_entry
->timestamp_begin
!= 0) {
1681 * Decode packet to read the timestamp of the
1682 * last event of the stream file.
1684 ret
= decode_packet_last_event_timestamp(trace
, default_cc
, last_entry
,
1685 &last_entry
->timestamp_end
,
1686 &last_entry
->timestamp_end_ns
);
1688 BT_COMP_LOGE_APPEND_CAUSE(trace
->self_comp
,
1689 "Failed to decode last event's clock snapshot");
1694 /* Iterate over all entries but the last one. */
1695 for (entry_idx
= 0; entry_idx
< index
->entries
->len
- 1; entry_idx
++) {
1696 ctf_fs_ds_index_entry
*curr_entry
=
1697 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_idx
);
1698 ctf_fs_ds_index_entry
*next_entry
=
1699 (ctf_fs_ds_index_entry
*) g_ptr_array_index(index
->entries
, entry_idx
+ 1);
1701 if (curr_entry
->timestamp_end
== 0 && curr_entry
->timestamp_begin
!= 0) {
1703 * 2. Set the current index entry `end` timestamp to
1704 * the next index entry `begin` timestamp.
1706 curr_entry
->timestamp_end
= next_entry
->timestamp_begin
;
1707 curr_entry
->timestamp_end_ns
= next_entry
->timestamp_begin_ns
;
1717 * Extract the tracer information necessary to compare versions.
1718 * Returns 0 on success, and -1 if the extraction is not successful because the
1719 * necessary fields are absents in the trace metadata.
1721 static int extract_tracer_info(struct ctf_fs_trace
*trace
, struct tracer_info
*current_tracer_info
)
1724 struct ctf_trace_class_env_entry
*entry
;
1726 /* Clear the current_tracer_info struct */
1727 memset(current_tracer_info
, 0, sizeof(*current_tracer_info
));
1730 * To compare 2 tracer versions, at least the tracer name and it's
1731 * major version are needed. If one of these is missing, consider it an
1732 * extraction failure.
1734 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_name");
1735 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_STR
) {
1736 goto missing_bare_minimum
;
1739 /* Set tracer name. */
1740 current_tracer_info
->name
= entry
->value
.str
->str
;
1742 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_major");
1743 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1744 goto missing_bare_minimum
;
1747 /* Set major version number. */
1748 current_tracer_info
->major
= entry
->value
.i
;
1750 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_minor");
1751 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1755 /* Set minor version number. */
1756 current_tracer_info
->minor
= entry
->value
.i
;
1758 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patch");
1761 * If `tracer_patch` doesn't exist `tracer_patchlevel` might.
1762 * For example, `lttng-modules` uses entry name
1763 * `tracer_patchlevel`.
1765 entry
= ctf_trace_class_borrow_env_entry_by_name(trace
->metadata
->tc
, "tracer_patchlevel");
1768 if (!entry
|| entry
->type
!= CTF_TRACE_CLASS_ENV_ENTRY_TYPE_INT
) {
1772 /* Set patch version number. */
1773 current_tracer_info
->patch
= entry
->value
.i
;
1777 missing_bare_minimum
:
1783 static bool is_tracer_affected_by_lttng_event_after_packet_bug(struct tracer_info
*curr_tracer_info
)
1785 bool is_affected
= false;
1787 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1788 if (curr_tracer_info
->major
< 2) {
1790 } else if (curr_tracer_info
->major
== 2) {
1791 /* fixed in lttng-ust 2.11.0 */
1792 if (curr_tracer_info
->minor
< 11) {
1796 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1797 if (curr_tracer_info
->major
< 2) {
1799 } else if (curr_tracer_info
->major
== 2) {
1800 /* fixed in lttng-modules 2.11.0 */
1801 if (curr_tracer_info
->minor
== 10) {
1802 /* fixed in lttng-modules 2.10.10 */
1803 if (curr_tracer_info
->patch
< 10) {
1806 } else if (curr_tracer_info
->minor
== 9) {
1807 /* fixed in lttng-modules 2.9.13 */
1808 if (curr_tracer_info
->patch
< 13) {
1811 } else if (curr_tracer_info
->minor
< 9) {
1821 is_tracer_affected_by_barectf_event_before_packet_bug(struct tracer_info
*curr_tracer_info
)
1823 bool is_affected
= false;
1825 if (strcmp(curr_tracer_info
->name
, "barectf") == 0) {
1826 if (curr_tracer_info
->major
< 2) {
1828 } else if (curr_tracer_info
->major
== 2) {
1829 if (curr_tracer_info
->minor
< 3) {
1831 } else if (curr_tracer_info
->minor
== 3) {
1832 /* fixed in barectf 2.3.1 */
1833 if (curr_tracer_info
->patch
< 1) {
1843 static bool is_tracer_affected_by_lttng_crash_quirk(struct tracer_info
*curr_tracer_info
)
1845 bool is_affected
= false;
1847 /* All LTTng tracer may be affected by this lttng crash quirk. */
1848 if (strcmp(curr_tracer_info
->name
, "lttng-ust") == 0) {
1850 } else if (strcmp(curr_tracer_info
->name
, "lttng-modules") == 0) {
1858 * Looks for trace produced by known buggy tracers and fix up the index
1861 static int fix_packet_index_tracer_bugs(struct ctf_fs_component
*ctf_fs
,
1862 bt_self_component
*self_comp
,
1863 bt_self_component_class
*self_comp_class
)
1866 struct tracer_info current_tracer_info
;
1867 bt_logging_level log_level
= ctf_fs
->log_level
;
1869 ret
= extract_tracer_info(ctf_fs
->trace
, ¤t_tracer_info
);
1872 * A trace may not have all the necessary environment
1873 * entries to do the tracer version comparison.
1874 * At least, the tracer name and major version number
1875 * are needed. Failing to extract these entries is not
1879 BT_LOGI_STR("Cannot extract tracer information necessary to compare with buggy versions.");
1884 /* Check if the trace may be affected by old tracer bugs. */
1885 if (is_tracer_affected_by_lttng_event_after_packet_bug(¤t_tracer_info
)) {
1886 BT_LOGI_STR("Trace may be affected by LTTng tracer packet timestamp bug. Fixing up.");
1887 ret
= fix_index_lttng_event_after_packet_bug(ctf_fs
->trace
);
1889 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1890 "Failed to fix LTTng event-after-packet bug.");
1893 ctf_fs
->trace
->metadata
->tc
->quirks
.lttng_event_after_packet
= true;
1896 if (is_tracer_affected_by_barectf_event_before_packet_bug(¤t_tracer_info
)) {
1897 BT_LOGI_STR("Trace may be affected by barectf tracer packet timestamp bug. Fixing up.");
1898 ret
= fix_index_barectf_event_before_packet_bug(ctf_fs
->trace
);
1900 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
1901 self_comp
, self_comp_class
, "Failed to fix barectf event-before-packet bug.");
1904 ctf_fs
->trace
->metadata
->tc
->quirks
.barectf_event_before_packet
= true;
1907 if (is_tracer_affected_by_lttng_crash_quirk(¤t_tracer_info
)) {
1908 ret
= fix_index_lttng_crash_quirk(ctf_fs
->trace
);
1910 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1911 "Failed to fix lttng-crash timestamp quirks.");
1914 ctf_fs
->trace
->metadata
->tc
->quirks
.lttng_crash
= true;
1921 static gint
compare_ds_file_groups_by_first_path(gconstpointer a
, gconstpointer b
)
1923 ctf_fs_ds_file_group
* const *ds_file_group_a
= (ctf_fs_ds_file_group
**) a
;
1924 ctf_fs_ds_file_group
* const *ds_file_group_b
= (ctf_fs_ds_file_group
**) b
;
1926 BT_ASSERT((*ds_file_group_a
)->ds_file_infos
->len
> 0);
1927 BT_ASSERT((*ds_file_group_b
)->ds_file_infos
->len
> 0);
1929 const ctf_fs_ds_file_info
*first_ds_file_info_a
=
1930 (const ctf_fs_ds_file_info
*) (*ds_file_group_a
)->ds_file_infos
->pdata
[0];
1931 const ctf_fs_ds_file_info
*first_ds_file_info_b
=
1932 (const ctf_fs_ds_file_info
*) (*ds_file_group_b
)->ds_file_infos
->pdata
[0];
1934 return strcmp(first_ds_file_info_a
->path
->str
, first_ds_file_info_b
->path
->str
);
1937 static gint
compare_strings(gconstpointer p_a
, gconstpointer p_b
)
1939 const char *a
= *((const char **) p_a
);
1940 const char *b
= *((const char **) p_b
);
1942 return strcmp(a
, b
);
1945 int ctf_fs_component_create_ctf_fs_trace(struct ctf_fs_component
*ctf_fs
,
1946 const bt_value
*paths_value
,
1947 const bt_value
*trace_name_value
,
1948 bt_self_component
*self_comp
,
1949 bt_self_component_class
*self_comp_class
)
1953 bt_logging_level log_level
= ctf_fs
->log_level
;
1954 GPtrArray
*paths
= NULL
;
1956 const char *trace_name
;
1958 BT_ASSERT(bt_value_get_type(paths_value
) == BT_VALUE_TYPE_ARRAY
);
1959 BT_ASSERT(!bt_value_array_is_empty(paths_value
));
1961 traces
= g_ptr_array_new_with_free_func(ctf_fs_trace_destroy_notifier
);
1963 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1964 "Failed to allocate a GPtrArray.");
1968 paths
= g_ptr_array_new_with_free_func(g_free
);
1970 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1971 "Failed to allocate a GPtrArray.");
1975 trace_name
= trace_name_value
? bt_value_string_get(trace_name_value
) : NULL
;
1978 * Create a sorted array of the paths, to make the execution of this
1979 * component deterministic.
1981 for (i
= 0; i
< bt_value_array_get_length(paths_value
); i
++) {
1982 const bt_value
*path_value
= bt_value_array_borrow_element_by_index_const(paths_value
, i
);
1983 const char *input
= bt_value_string_get(path_value
);
1986 input_copy
= g_strdup(input
);
1988 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
1989 "Failed to copy a string.");
1993 g_ptr_array_add(paths
, input_copy
);
1996 g_ptr_array_sort(paths
, compare_strings
);
1998 /* Create a separate ctf_fs_trace object for each path. */
1999 for (i
= 0; i
< paths
->len
; i
++) {
2000 const char *path
= (const char *) g_ptr_array_index(paths
, i
);
2002 ret
= ctf_fs_component_create_ctf_fs_trace_one_path(ctf_fs
, path
, trace_name
, traces
,
2003 self_comp
, self_comp_class
);
2009 if (traces
->len
> 1) {
2010 struct ctf_fs_trace
*first_trace
= (struct ctf_fs_trace
*) traces
->pdata
[0];
2011 const uint8_t *first_trace_uuid
= first_trace
->metadata
->tc
->uuid
;
2012 struct ctf_fs_trace
*trace
;
2015 * We have more than one trace, they must all share the same
2016 * UUID, verify that.
2018 for (i
= 0; i
< traces
->len
; i
++) {
2019 struct ctf_fs_trace
*this_trace
= (struct ctf_fs_trace
*) traces
->pdata
[i
];
2020 const uint8_t *this_trace_uuid
= this_trace
->metadata
->tc
->uuid
;
2022 if (!this_trace
->metadata
->tc
->is_uuid_set
) {
2023 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
2024 self_comp
, self_comp_class
,
2025 "Multiple traces given, but a trace does not have a UUID: path=%s",
2026 this_trace
->path
->str
);
2030 if (bt_uuid_compare(first_trace_uuid
, this_trace_uuid
) != 0) {
2031 char first_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
2032 char this_trace_uuid_str
[BT_UUID_STR_LEN
+ 1];
2034 bt_uuid_to_str(first_trace_uuid
, first_trace_uuid_str
);
2035 bt_uuid_to_str(this_trace_uuid
, this_trace_uuid_str
);
2037 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
2038 self_comp
, self_comp_class
,
2039 "Multiple traces given, but UUIDs don't match: "
2040 "first-trace-uuid=%s, first-trace-path=%s, "
2041 "trace-uuid=%s, trace-path=%s",
2042 first_trace_uuid_str
, first_trace
->path
->str
, this_trace_uuid_str
,
2043 this_trace
->path
->str
);
2048 ret
= merge_ctf_fs_traces((struct ctf_fs_trace
**) traces
->pdata
, traces
->len
, &trace
);
2050 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2051 "Failed to merge traces with the same UUID.");
2055 ctf_fs
->trace
= trace
;
2057 /* Just one trace, it may or may not have a UUID, both are fine. */
2058 ctf_fs
->trace
= (ctf_fs_trace
*) traces
->pdata
[0];
2059 traces
->pdata
[0] = NULL
;
2062 ret
= fix_packet_index_tracer_bugs(ctf_fs
, self_comp
, self_comp_class
);
2064 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
,
2065 "Failed to fix packet index tracer bugs.");
2069 * Sort data stream file groups by first data stream file info
2070 * path to get a deterministic order. This order influences the
2071 * order of the output ports. It also influences the order of
2072 * the automatic stream IDs if the trace's packet headers do not
2073 * contain a `stream_instance_id` field, in which case the data
2074 * stream file to stream ID association is always the same,
2075 * whatever the build and the system.
2077 * Having a deterministic order here can help debugging and
2080 g_ptr_array_sort(ctf_fs
->trace
->ds_file_groups
, compare_ds_file_groups_by_first_path
);
2087 g_ptr_array_free(traces
, TRUE
);
2091 g_ptr_array_free(paths
, TRUE
);
2097 static GString
*get_stream_instance_unique_name(struct ctf_fs_ds_file_group
*ds_file_group
)
2100 struct ctf_fs_ds_file_info
*ds_file_info
;
2102 name
= g_string_new(NULL
);
2108 * If there's more than one stream file in the stream file
2109 * group, the first (earliest) stream file's path is used as
2110 * the stream's unique name.
2112 BT_ASSERT(ds_file_group
->ds_file_infos
->len
> 0);
2113 ds_file_info
= (ctf_fs_ds_file_info
*) g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
2114 g_string_assign(name
, ds_file_info
->path
->str
);
2120 /* Create the IR stream objects for ctf_fs_trace. */
2122 static int create_streams_for_trace(struct ctf_fs_trace
*ctf_fs_trace
)
2125 GString
*name
= NULL
;
2127 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
2128 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
2130 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
2131 ctf_fs_ds_file_group
*ds_file_group
=
2132 (ctf_fs_ds_file_group
*) g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
2133 name
= get_stream_instance_unique_name(ds_file_group
);
2139 if (ds_file_group
->sc
->ir_sc
) {
2140 BT_ASSERT(ctf_fs_trace
->trace
);
2142 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
2143 /* No stream ID: use 0 */
2144 ds_file_group
->stream
= bt_stream_create_with_id(
2145 ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
, ctf_fs_trace
->next_stream_id
);
2146 ctf_fs_trace
->next_stream_id
++;
2148 /* Specific stream ID */
2149 ds_file_group
->stream
=
2150 bt_stream_create_with_id(ds_file_group
->sc
->ir_sc
, ctf_fs_trace
->trace
,
2151 (uint64_t) ds_file_group
->stream_id
);
2154 ds_file_group
->stream
= NULL
;
2157 if (!ds_file_group
->stream
) {
2158 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2159 "Cannot create stream for DS file group: "
2160 "addr=%p, stream-name=\"%s\"",
2161 ds_file_group
, name
->str
);
2165 ret
= bt_stream_set_name(ds_file_group
->stream
, name
->str
);
2167 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
2168 "Cannot set stream's name: "
2169 "addr=%p, stream-name=\"%s\"",
2170 ds_file_group
->stream
, name
->str
);
2174 g_string_free(name
, TRUE
);
2187 g_string_free(name
, TRUE
);
2192 static const bt_param_validation_value_descr inputs_elem_descr
=
2193 bt_param_validation_value_descr::makeString();
2195 static bt_param_validation_map_value_entry_descr fs_params_entries_descr
[] = {
2196 {"inputs", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY
,
2197 bt_param_validation_value_descr::makeArray(1, BT_PARAM_VALIDATION_INFINITE
,
2198 inputs_elem_descr
)},
2199 {"trace-name", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2200 bt_param_validation_value_descr::makeString()},
2201 {"clock-class-offset-s", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2202 bt_param_validation_value_descr::makeSignedInteger()},
2203 {"clock-class-offset-ns", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2204 bt_param_validation_value_descr::makeSignedInteger()},
2205 {"force-clock-class-origin-unix-epoch", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL
,
2206 bt_param_validation_value_descr::makeBool()},
2207 BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
};
2209 bool read_src_fs_parameters(const bt_value
*params
, const bt_value
**inputs
,
2210 const bt_value
**trace_name
, struct ctf_fs_component
*ctf_fs
,
2211 bt_self_component
*self_comp
, bt_self_component_class
*self_comp_class
)
2214 const bt_value
*value
;
2215 bt_logging_level log_level
= ctf_fs
->log_level
;
2216 enum bt_param_validation_status validate_value_status
;
2217 gchar
*error
= NULL
;
2219 validate_value_status
= bt_param_validation_validate(params
, fs_params_entries_descr
, &error
);
2220 if (validate_value_status
!= BT_PARAM_VALIDATION_STATUS_OK
) {
2221 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp
, self_comp_class
, "%s", error
);
2226 /* inputs parameter */
2227 *inputs
= bt_value_map_borrow_entry_value_const(params
, "inputs");
2229 /* clock-class-offset-s parameter */
2230 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-s");
2232 ctf_fs
->metadata_config
.clock_class_offset_s
= bt_value_integer_signed_get(value
);
2235 /* clock-class-offset-ns parameter */
2236 value
= bt_value_map_borrow_entry_value_const(params
, "clock-class-offset-ns");
2238 ctf_fs
->metadata_config
.clock_class_offset_ns
= bt_value_integer_signed_get(value
);
2241 /* force-clock-class-origin-unix-epoch parameter */
2242 value
= bt_value_map_borrow_entry_value_const(params
, "force-clock-class-origin-unix-epoch");
2244 ctf_fs
->metadata_config
.force_clock_class_origin_unix_epoch
= bt_value_bool_get(value
);
2247 /* trace-name parameter */
2248 *trace_name
= bt_value_map_borrow_entry_value_const(params
, "trace-name");
2257 static struct ctf_fs_component
*ctf_fs_create(const bt_value
*params
,
2258 bt_self_component_source
*self_comp_src
)
2260 struct ctf_fs_component
*ctf_fs
= NULL
;
2261 const bt_value
*inputs_value
;
2262 const bt_value
*trace_name_value
;
2263 bt_self_component
*self_comp
= bt_self_component_source_as_self_component(self_comp_src
);
2265 ctf_fs
= ctf_fs_component_create(
2266 bt_component_get_logging_level(bt_self_component_as_component(self_comp
)), self_comp
);
2271 if (!read_src_fs_parameters(params
, &inputs_value
, &trace_name_value
, ctf_fs
, self_comp
,
2276 bt_self_component_set_data(self_comp
, ctf_fs
);
2278 if (ctf_fs_component_create_ctf_fs_trace(ctf_fs
, inputs_value
, trace_name_value
, self_comp
,
2283 if (create_streams_for_trace(ctf_fs
->trace
)) {
2287 if (create_ports_for_trace(ctf_fs
, ctf_fs
->trace
, self_comp_src
)) {
2294 ctf_fs_destroy(ctf_fs
);
2296 bt_self_component_set_data(self_comp
, NULL
);
2303 bt_component_class_initialize_method_status
2304 ctf_fs_init(bt_self_component_source
*self_comp_src
, bt_self_component_source_configuration
*config
,
2305 const bt_value
*params
, __attribute__((unused
)) void *init_method_data
)
2307 struct ctf_fs_component
*ctf_fs
;
2308 bt_component_class_initialize_method_status ret
=
2309 BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK
;
2311 ctf_fs
= ctf_fs_create(params
, self_comp_src
);
2313 ret
= BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR
;
2320 bt_component_class_query_method_status
ctf_fs_query(bt_self_component_class_source
*comp_class
,
2321 bt_private_query_executor
*priv_query_exec
,
2322 const char *object
, const bt_value
*params
,
2323 __attribute__((unused
)) void *method_data
,
2324 const bt_value
**result
)
2326 bt_component_class_query_method_status status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
2327 bt_logging_level log_level
= bt_query_executor_get_logging_level(
2328 bt_private_query_executor_as_query_executor_const(priv_query_exec
));
2330 if (strcmp(object
, "metadata-info") == 0) {
2331 status
= metadata_info_query(comp_class
, params
, log_level
, result
);
2332 } else if (strcmp(object
, "babeltrace.trace-infos") == 0) {
2333 status
= trace_infos_query(comp_class
, params
, log_level
, result
);
2334 } else if (!strcmp(object
, "babeltrace.support-info")) {
2335 status
= support_info_query(comp_class
, params
, log_level
, result
);
2337 BT_LOGE("Unknown query object `%s`", object
);
2338 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;