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 "plugins/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"
50 int msg_iter_data_set_current_ds_file(struct ctf_fs_msg_iter_data
*msg_iter_data
)
52 struct ctf_fs_ds_file_info
*ds_file_info
;
55 BT_ASSERT(msg_iter_data
->ds_file_info_index
<
56 msg_iter_data
->ds_file_group
->ds_file_infos
->len
);
57 ds_file_info
= g_ptr_array_index(
58 msg_iter_data
->ds_file_group
->ds_file_infos
,
59 msg_iter_data
->ds_file_info_index
);
61 ctf_fs_ds_file_destroy(msg_iter_data
->ds_file
);
62 msg_iter_data
->ds_file
= ctf_fs_ds_file_create(
63 msg_iter_data
->ds_file_group
->ctf_fs_trace
,
64 msg_iter_data
->pc_msg_iter
,
65 msg_iter_data
->msg_iter
,
66 msg_iter_data
->ds_file_group
->stream
,
67 ds_file_info
->path
->str
,
68 msg_iter_data
->log_level
);
69 if (!msg_iter_data
->ds_file
) {
77 void ctf_fs_msg_iter_data_destroy(
78 struct ctf_fs_msg_iter_data
*msg_iter_data
)
84 ctf_fs_ds_file_destroy(msg_iter_data
->ds_file
);
86 if (msg_iter_data
->msg_iter
) {
87 bt_msg_iter_destroy(msg_iter_data
->msg_iter
);
90 g_free(msg_iter_data
);
94 void set_msg_iter_emits_stream_beginning_end_messages(
95 struct ctf_fs_msg_iter_data
*msg_iter_data
)
97 bt_msg_iter_set_emit_stream_beginning_message(
98 msg_iter_data
->ds_file
->msg_iter
,
99 msg_iter_data
->ds_file_info_index
== 0);
100 bt_msg_iter_set_emit_stream_end_message(
101 msg_iter_data
->ds_file
->msg_iter
,
102 msg_iter_data
->ds_file_info_index
==
103 msg_iter_data
->ds_file_group
->ds_file_infos
->len
- 1);
107 bt_component_class_message_iterator_next_method_status
ctf_fs_iterator_next_one(
108 struct ctf_fs_msg_iter_data
*msg_iter_data
,
109 const bt_message
**out_msg
)
111 bt_component_class_message_iterator_next_method_status status
;
113 BT_ASSERT(msg_iter_data
->ds_file
);
118 status
= ctf_fs_ds_file_next(msg_iter_data
->ds_file
, &msg
);
120 case BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
:
124 case BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_END
:
128 if (msg_iter_data
->ds_file_info_index
==
129 msg_iter_data
->ds_file_group
->ds_file_infos
->len
- 1) {
130 /* End of all group's stream files */
134 msg_iter_data
->ds_file_info_index
++;
135 bt_msg_iter_reset_for_next_stream_file(
136 msg_iter_data
->msg_iter
);
137 set_msg_iter_emits_stream_beginning_end_messages(
141 * Open and start reading the next stream file
142 * within our stream file group.
144 ret
= msg_iter_data_set_current_ds_file(msg_iter_data
);
146 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_ERROR
;
150 /* Continue the loop to get the next message */
163 bt_component_class_message_iterator_next_method_status
ctf_fs_iterator_next(
164 bt_self_message_iterator
*iterator
,
165 bt_message_array_const msgs
, uint64_t capacity
,
168 bt_component_class_message_iterator_next_method_status status
=
169 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
;
170 struct ctf_fs_msg_iter_data
*msg_iter_data
=
171 bt_self_message_iterator_get_data(iterator
);
174 while (i
< capacity
&&
175 status
== BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
) {
176 status
= ctf_fs_iterator_next_one(msg_iter_data
, &msgs
[i
]);
177 if (status
== BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
) {
184 * Even if ctf_fs_iterator_next_one() returned something
185 * else than BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK, we
186 * accumulated message objects in the output
187 * message array, so we need to return
188 * BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK so that they are
189 * transfered to downstream. This other status occurs
190 * again the next time muxer_msg_iter_do_next() is
191 * called, possibly without any accumulated
192 * message, in which case we'll return it.
195 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_NEXT_METHOD_STATUS_OK
;
202 int ctf_fs_iterator_reset(struct ctf_fs_msg_iter_data
*msg_iter_data
)
206 msg_iter_data
->ds_file_info_index
= 0;
207 ret
= msg_iter_data_set_current_ds_file(msg_iter_data
);
212 bt_msg_iter_reset(msg_iter_data
->msg_iter
);
213 set_msg_iter_emits_stream_beginning_end_messages(msg_iter_data
);
220 bt_component_class_message_iterator_seek_beginning_method_status
221 ctf_fs_iterator_seek_beginning(bt_self_message_iterator
*it
)
223 struct ctf_fs_msg_iter_data
*msg_iter_data
=
224 bt_self_message_iterator_get_data(it
);
225 bt_component_class_message_iterator_seek_beginning_method_status status
=
226 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_OK
;
228 BT_ASSERT(msg_iter_data
);
229 if (ctf_fs_iterator_reset(msg_iter_data
)) {
230 status
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_SEEK_BEGINNING_METHOD_STATUS_ERROR
;
237 void ctf_fs_iterator_finalize(bt_self_message_iterator
*it
)
239 ctf_fs_msg_iter_data_destroy(
240 bt_self_message_iterator_get_data(it
));
244 bt_component_class_message_iterator_init_method_status
ctf_fs_iterator_init(
245 bt_self_message_iterator
*self_msg_iter
,
246 bt_self_component_source
*self_comp_src
,
247 bt_self_component_port_output
*self_port
)
249 struct ctf_fs_port_data
*port_data
;
250 struct ctf_fs_msg_iter_data
*msg_iter_data
= NULL
;
251 bt_component_class_message_iterator_init_method_status ret
=
252 BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_OK
;
253 bt_logging_level log_level
;
254 bt_self_component
*self_comp
;
256 port_data
= bt_self_component_port_get_data(
257 bt_self_component_port_output_as_self_component_port(
259 BT_ASSERT(port_data
);
260 log_level
= port_data
->ctf_fs
->log_level
;
261 self_comp
= port_data
->ctf_fs
->self_comp
;
262 msg_iter_data
= g_new0(struct ctf_fs_msg_iter_data
, 1);
263 if (!msg_iter_data
) {
264 ret
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_MEMORY_ERROR
;
268 msg_iter_data
->log_level
= log_level
;
269 msg_iter_data
->self_comp
= self_comp
;
270 msg_iter_data
->pc_msg_iter
= self_msg_iter
;
271 msg_iter_data
->msg_iter
= bt_msg_iter_create(
272 port_data
->ds_file_group
->ctf_fs_trace
->metadata
->tc
,
273 bt_common_get_page_size(msg_iter_data
->log_level
) * 8,
274 ctf_fs_ds_file_medops
, NULL
, msg_iter_data
->log_level
,
276 if (!msg_iter_data
->msg_iter
) {
277 BT_COMP_LOGE_STR("Cannot create a CTF message iterator.");
278 ret
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_MEMORY_ERROR
;
282 msg_iter_data
->ds_file_group
= port_data
->ds_file_group
;
283 if (ctf_fs_iterator_reset(msg_iter_data
)) {
284 ret
= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_ERROR
;
288 bt_self_message_iterator_set_data(self_msg_iter
,
290 if (ret
!= BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_OK
) {
294 msg_iter_data
= NULL
;
298 bt_self_message_iterator_set_data(self_msg_iter
, NULL
);
301 ctf_fs_msg_iter_data_destroy(msg_iter_data
);
306 void ctf_fs_destroy(struct ctf_fs_component
*ctf_fs
)
312 if (ctf_fs
->traces
) {
313 g_ptr_array_free(ctf_fs
->traces
, TRUE
);
316 if (ctf_fs
->port_data
) {
317 g_ptr_array_free(ctf_fs
->port_data
, TRUE
);
324 void port_data_destroy(struct ctf_fs_port_data
*port_data
)
334 void port_data_destroy_notifier(void *data
) {
335 port_data_destroy(data
);
339 void ctf_fs_trace_destroy(struct ctf_fs_trace
*ctf_fs_trace
)
345 if (ctf_fs_trace
->ds_file_groups
) {
346 g_ptr_array_free(ctf_fs_trace
->ds_file_groups
, TRUE
);
349 BT_TRACE_PUT_REF_AND_RESET(ctf_fs_trace
->trace
);
351 if (ctf_fs_trace
->path
) {
352 g_string_free(ctf_fs_trace
->path
, TRUE
);
355 if (ctf_fs_trace
->name
) {
356 g_string_free(ctf_fs_trace
->name
, TRUE
);
359 if (ctf_fs_trace
->metadata
) {
360 ctf_fs_metadata_fini(ctf_fs_trace
->metadata
);
361 g_free(ctf_fs_trace
->metadata
);
364 g_free(ctf_fs_trace
);
368 void ctf_fs_trace_destroy_notifier(void *data
)
370 struct ctf_fs_trace
*trace
= data
;
371 ctf_fs_trace_destroy(trace
);
374 struct ctf_fs_component
*ctf_fs_component_create(bt_logging_level log_level
,
375 bt_self_component
*self_comp
)
377 struct ctf_fs_component
*ctf_fs
;
379 ctf_fs
= g_new0(struct ctf_fs_component
, 1);
384 ctf_fs
->log_level
= log_level
;
385 ctf_fs
->self_comp
= self_comp
;
387 g_ptr_array_new_with_free_func(port_data_destroy_notifier
);
388 if (!ctf_fs
->port_data
) {
393 g_ptr_array_new_with_free_func(ctf_fs_trace_destroy_notifier
);
394 if (!ctf_fs
->traces
) {
402 ctf_fs_destroy(ctf_fs
);
409 void ctf_fs_finalize(bt_self_component_source
*component
)
411 ctf_fs_destroy(bt_self_component_get_data(
412 bt_self_component_source_as_self_component(component
)));
415 gchar
*ctf_fs_make_port_name(struct ctf_fs_ds_file_group
*ds_file_group
)
417 GString
*name
= g_string_new(NULL
);
420 * The unique port name is generated by concatenating unique identifiers
428 /* For the trace, use the uuid if present, else the path. */
429 if (ds_file_group
->ctf_fs_trace
->metadata
->tc
->is_uuid_set
) {
430 char uuid_str
[BT_UUID_STR_LEN
+ 1];
432 bt_uuid_to_str(ds_file_group
->ctf_fs_trace
->metadata
->tc
->uuid
, uuid_str
);
433 g_string_assign(name
, uuid_str
);
435 g_string_assign(name
, ds_file_group
->ctf_fs_trace
->path
->str
);
439 * For the stream class, use the id if present. We can omit this field
440 * otherwise, as there will only be a single stream class.
442 if (ds_file_group
->sc
->id
!= UINT64_C(-1)) {
443 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->sc
->id
);
446 /* For the stream, use the id if present, else, use the path. */
447 if (ds_file_group
->stream_id
!= UINT64_C(-1)) {
448 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->stream_id
);
450 BT_ASSERT(ds_file_group
->ds_file_infos
->len
== 1);
451 struct ctf_fs_ds_file_info
*ds_file_info
=
452 g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
453 g_string_append_printf(name
, " | %s", ds_file_info
->path
->str
);
456 return g_string_free(name
, FALSE
);
460 int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
461 struct ctf_fs_trace
*ctf_fs_trace
,
462 struct ctf_fs_ds_file_group
*ds_file_group
)
465 struct ctf_fs_port_data
*port_data
= NULL
;
467 bt_logging_level log_level
= ctf_fs
->log_level
;
468 bt_self_component
*self_comp
= ctf_fs
->self_comp
;
470 port_name
= ctf_fs_make_port_name(ds_file_group
);
475 BT_COMP_LOGI("Creating one port named `%s`", port_name
);
477 /* Create output port for this file */
478 port_data
= g_new0(struct ctf_fs_port_data
, 1);
483 port_data
->ctf_fs
= ctf_fs
;
484 port_data
->ds_file_group
= ds_file_group
;
485 ret
= bt_self_component_source_add_output_port(
486 ctf_fs
->self_comp_src
, port_name
, port_data
, NULL
);
491 g_ptr_array_add(ctf_fs
->port_data
, port_data
);
501 port_data_destroy(port_data
);
506 int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
507 struct ctf_fs_trace
*ctf_fs_trace
)
511 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
512 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
514 /* Create one output port for each stream file group */
515 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
516 struct ctf_fs_ds_file_group
*ds_file_group
=
517 g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
519 ret
= create_one_port_for_trace(ctf_fs
, ctf_fs_trace
,
522 BT_COMP_LOGE("Cannot create output port.");
532 void ctf_fs_ds_file_info_destroy(struct ctf_fs_ds_file_info
*ds_file_info
)
538 if (ds_file_info
->path
) {
539 g_string_free(ds_file_info
->path
, TRUE
);
542 g_free(ds_file_info
);
546 struct ctf_fs_ds_file_info
*ctf_fs_ds_file_info_create(const char *path
,
549 struct ctf_fs_ds_file_info
*ds_file_info
;
551 ds_file_info
= g_new0(struct ctf_fs_ds_file_info
, 1);
556 ds_file_info
->path
= g_string_new(path
);
557 if (!ds_file_info
->path
) {
558 ctf_fs_ds_file_info_destroy(ds_file_info
);
563 ds_file_info
->begin_ns
= begin_ns
;
570 void ctf_fs_ds_file_group_destroy(struct ctf_fs_ds_file_group
*ds_file_group
)
572 if (!ds_file_group
) {
576 if (ds_file_group
->ds_file_infos
) {
577 g_ptr_array_free(ds_file_group
->ds_file_infos
, TRUE
);
580 if (ds_file_group
->index
) {
581 if (ds_file_group
->index
->entries
) {
582 g_ptr_array_free(ds_file_group
->index
->entries
, TRUE
);
584 g_free(ds_file_group
->index
);
587 bt_stream_put_ref(ds_file_group
->stream
);
588 g_free(ds_file_group
);
592 struct ctf_fs_ds_file_group
*ctf_fs_ds_file_group_create(
593 struct ctf_fs_trace
*ctf_fs_trace
,
594 struct ctf_stream_class
*sc
,
595 uint64_t stream_instance_id
,
596 struct ctf_fs_ds_index
*index
)
598 struct ctf_fs_ds_file_group
*ds_file_group
;
600 ds_file_group
= g_new0(struct ctf_fs_ds_file_group
, 1);
601 if (!ds_file_group
) {
605 ds_file_group
->ds_file_infos
= g_ptr_array_new_with_free_func(
606 (GDestroyNotify
) ctf_fs_ds_file_info_destroy
);
607 if (!ds_file_group
->ds_file_infos
) {
611 ds_file_group
->index
= index
;
613 ds_file_group
->stream_id
= stream_instance_id
;
615 ds_file_group
->sc
= sc
;
616 ds_file_group
->ctf_fs_trace
= ctf_fs_trace
;
620 ctf_fs_ds_file_group_destroy(ds_file_group
);
621 ctf_fs_ds_index_destroy(index
);
622 ds_file_group
= NULL
;
625 return ds_file_group
;
628 /* Replace by g_ptr_array_insert when we depend on glib >= 2.40. */
630 void array_insert(GPtrArray
*array
, gpointer element
, size_t pos
)
632 size_t original_array_len
= array
->len
;
634 /* Allocate an unused element at the end of the array. */
635 g_ptr_array_add(array
, NULL
);
637 /* If we are not inserting at the end, move the elements by one. */
638 if (pos
< original_array_len
) {
639 memmove(&(array
->pdata
[pos
+ 1]),
640 &(array
->pdata
[pos
]),
641 (original_array_len
- pos
) * sizeof(gpointer
));
644 /* Insert the value. */
645 array
->pdata
[pos
] = element
;
649 * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right
650 * place to keep it sorted.
654 void ds_file_group_insert_ds_file_info_sorted(
655 struct ctf_fs_ds_file_group
*ds_file_group
,
656 struct ctf_fs_ds_file_info
*ds_file_info
)
660 /* Find the spot where to insert this ds_file_info. */
661 for (i
= 0; i
< ds_file_group
->ds_file_infos
->len
; i
++) {
662 struct ctf_fs_ds_file_info
*other_ds_file_info
=
663 g_ptr_array_index(ds_file_group
->ds_file_infos
, i
);
665 if (ds_file_info
->begin_ns
< other_ds_file_info
->begin_ns
) {
670 array_insert(ds_file_group
->ds_file_infos
, ds_file_info
, i
);
674 void ds_file_group_insert_ds_index_entry_sorted(
675 struct ctf_fs_ds_file_group
*ds_file_group
,
676 struct ctf_fs_ds_index_entry
*entry
)
680 /* Find the spot where to insert this index entry. */
681 for (i
= 0; i
< ds_file_group
->index
->entries
->len
; i
++) {
682 struct ctf_fs_ds_index_entry
*other_entry
= g_ptr_array_index(
683 ds_file_group
->index
->entries
, i
);
685 if (entry
->timestamp_begin_ns
< other_entry
->timestamp_begin_ns
) {
690 array_insert(ds_file_group
->index
->entries
, entry
, i
);
694 * Create a new ds_file_info using the provided path, begin_ns and index, then
695 * add it to ds_file_group's list of ds_file_infos.
699 int ctf_fs_ds_file_group_add_ds_file_info(
700 struct ctf_fs_ds_file_group
*ds_file_group
,
701 const char *path
, int64_t begin_ns
)
703 struct ctf_fs_ds_file_info
*ds_file_info
;
706 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
);
711 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, ds_file_info
);
717 ctf_fs_ds_file_info_destroy(ds_file_info
);
724 int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
,
727 int64_t stream_instance_id
= -1;
728 int64_t begin_ns
= -1;
729 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
730 bool add_group
= false;
733 struct ctf_fs_ds_file
*ds_file
= NULL
;
734 struct ctf_fs_ds_index
*index
= NULL
;
735 struct bt_msg_iter
*msg_iter
= NULL
;
736 struct ctf_stream_class
*sc
= NULL
;
737 struct bt_msg_iter_packet_properties props
;
738 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
739 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
741 msg_iter
= bt_msg_iter_create(ctf_fs_trace
->metadata
->tc
,
742 bt_common_get_page_size(log_level
) * 8,
743 ctf_fs_ds_file_medops
, NULL
, log_level
, self_comp
);
745 BT_COMP_LOGE_STR("Cannot create a CTF message iterator.");
749 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, msg_iter
,
750 NULL
, path
, log_level
);
755 ret
= bt_msg_iter_get_packet_properties(ds_file
->msg_iter
, &props
);
757 BT_COMP_LOGE("Cannot get stream file's first packet's header and context fields (`%s`).",
762 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
,
763 props
.stream_class_id
);
765 stream_instance_id
= props
.data_stream_id
;
767 if (props
.snapshots
.beginning_clock
!= UINT64_C(-1)) {
768 BT_ASSERT(sc
->default_clock_class
);
769 ret
= bt_util_clock_cycles_to_ns_from_origin(
770 props
.snapshots
.beginning_clock
,
771 sc
->default_clock_class
->frequency
,
772 sc
->default_clock_class
->offset_seconds
,
773 sc
->default_clock_class
->offset_cycles
, &begin_ns
);
775 BT_COMP_LOGE("Cannot convert clock cycles to nanoseconds from origin (`%s`).",
781 index
= ctf_fs_ds_file_build_index(ds_file
);
783 BT_COMP_LOGW("Failed to index CTF stream file \'%s\'",
784 ds_file
->file
->path
->str
);
787 if (begin_ns
== -1) {
789 * No beggining timestamp to sort the stream files
790 * within a stream file group, so consider that this
791 * file must be the only one within its group.
793 stream_instance_id
= -1;
796 if (stream_instance_id
== -1) {
798 * No stream instance ID or no beginning timestamp:
799 * create a unique stream file group for this stream
800 * file because, even if there's a stream instance ID,
801 * there's no timestamp to order the file within its
804 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
,
805 sc
, UINT64_C(-1), index
);
806 /* Ownership of index is transferred. */
809 if (!ds_file_group
) {
813 ret
= ctf_fs_ds_file_group_add_ds_file_info(ds_file_group
,
823 BT_ASSERT(stream_instance_id
!= -1);
824 BT_ASSERT(begin_ns
!= -1);
826 /* Find an existing stream file group with this ID */
827 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
828 ds_file_group
= g_ptr_array_index(
829 ctf_fs_trace
->ds_file_groups
, i
);
831 if (ds_file_group
->sc
== sc
&&
832 ds_file_group
->stream_id
==
833 stream_instance_id
) {
837 ds_file_group
= NULL
;
840 if (!ds_file_group
) {
841 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
,
842 sc
, stream_instance_id
, index
);
843 /* Ownership of index is transferred. */
845 if (!ds_file_group
) {
852 ret
= ctf_fs_ds_file_group_add_ds_file_info(ds_file_group
, path
,
861 ctf_fs_ds_file_group_destroy(ds_file_group
);
862 ds_file_group
= NULL
;
866 if (add_group
&& ds_file_group
) {
867 g_ptr_array_add(ctf_fs_trace
->ds_file_groups
, ds_file_group
);
870 ctf_fs_ds_file_destroy(ds_file
);
873 bt_msg_iter_destroy(msg_iter
);
876 ctf_fs_ds_index_destroy(index
);
881 int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
884 const char *basename
;
885 GError
*error
= NULL
;
887 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
888 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
890 /* Check each file in the path directory, except specific ones */
891 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
893 BT_COMP_LOGE("Cannot open directory `%s`: %s (code %d)",
894 ctf_fs_trace
->path
->str
, error
->message
,
899 while ((basename
= g_dir_read_name(dir
))) {
900 struct ctf_fs_file
*file
;
902 if (strcmp(basename
, CTF_FS_METADATA_FILENAME
) == 0) {
903 /* Ignore the metadata stream. */
904 BT_COMP_LOGI("Ignoring metadata file `%s" G_DIR_SEPARATOR_S
"%s`",
905 ctf_fs_trace
->path
->str
, basename
);
909 if (basename
[0] == '.') {
910 BT_COMP_LOGI("Ignoring hidden file `%s" G_DIR_SEPARATOR_S
"%s`",
911 ctf_fs_trace
->path
->str
, basename
);
915 /* Create the file. */
916 file
= ctf_fs_file_create(log_level
, self_comp
);
918 BT_COMP_LOGE("Cannot create stream file object for file `%s" G_DIR_SEPARATOR_S
"%s`",
919 ctf_fs_trace
->path
->str
, basename
);
923 /* Create full path string. */
924 g_string_append_printf(file
->path
, "%s" G_DIR_SEPARATOR_S
"%s",
925 ctf_fs_trace
->path
->str
, basename
);
926 if (!g_file_test(file
->path
->str
, G_FILE_TEST_IS_REGULAR
)) {
927 BT_COMP_LOGI("Ignoring non-regular file `%s`",
929 ctf_fs_file_destroy(file
);
934 ret
= ctf_fs_file_open(file
, "rb");
936 BT_COMP_LOGE("Cannot open stream file `%s`", file
->path
->str
);
940 if (file
->size
== 0) {
941 /* Skip empty stream. */
942 BT_COMP_LOGI("Ignoring empty file `%s`", file
->path
->str
);
943 ctf_fs_file_destroy(file
);
947 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
,
950 BT_COMP_LOGE("Cannot add stream file `%s` to stream file group",
952 ctf_fs_file_destroy(file
);
956 ctf_fs_file_destroy(file
);
978 int set_trace_name(bt_trace
*trace
, const char *name_suffix
,
979 bt_logging_level log_level
, bt_self_component
*self_comp
)
985 name
= g_string_new(NULL
);
987 BT_COMP_LOGE_STR("Failed to allocate a GString.");
993 * Check if we have a trace environment string value named `hostname`.
994 * If so, use it as the trace name's prefix.
996 val
= bt_trace_borrow_environment_entry_value_by_name_const(
998 if (val
&& bt_value_is_string(val
)) {
999 g_string_append(name
, bt_value_string_get(val
));
1002 g_string_append_c(name
, G_DIR_SEPARATOR
);
1007 g_string_append(name
, name_suffix
);
1010 ret
= bt_trace_set_name(trace
, name
->str
);
1019 g_string_free(name
, TRUE
);
1026 struct ctf_fs_trace
*ctf_fs_trace_create(bt_self_component
*self_comp
,
1027 const char *path
, const char *name
,
1028 struct ctf_fs_metadata_config
*metadata_config
,
1029 bt_logging_level log_level
)
1031 struct ctf_fs_trace
*ctf_fs_trace
;
1034 ctf_fs_trace
= g_new0(struct ctf_fs_trace
, 1);
1035 if (!ctf_fs_trace
) {
1039 ctf_fs_trace
->log_level
= log_level
;
1040 ctf_fs_trace
->self_comp
= self_comp
;
1041 ctf_fs_trace
->path
= g_string_new(path
);
1042 if (!ctf_fs_trace
->path
) {
1046 ctf_fs_trace
->name
= g_string_new(name
);
1047 if (!ctf_fs_trace
->name
) {
1051 ctf_fs_trace
->metadata
= g_new0(struct ctf_fs_metadata
, 1);
1052 if (!ctf_fs_trace
->metadata
) {
1056 ctf_fs_metadata_init(ctf_fs_trace
->metadata
);
1057 ctf_fs_trace
->ds_file_groups
= g_ptr_array_new_with_free_func(
1058 (GDestroyNotify
) ctf_fs_ds_file_group_destroy
);
1059 if (!ctf_fs_trace
->ds_file_groups
) {
1063 ret
= ctf_fs_metadata_set_trace_class(self_comp
, ctf_fs_trace
,
1069 if (ctf_fs_trace
->metadata
->trace_class
) {
1070 ctf_fs_trace
->trace
=
1071 bt_trace_create(ctf_fs_trace
->metadata
->trace_class
);
1072 if (!ctf_fs_trace
->trace
) {
1077 if (ctf_fs_trace
->trace
) {
1078 ret
= ctf_trace_class_configure_ir_trace(
1079 ctf_fs_trace
->metadata
->tc
, ctf_fs_trace
->trace
);
1084 ret
= set_trace_name(ctf_fs_trace
->trace
, name
, log_level
,
1091 ret
= create_ds_file_groups(ctf_fs_trace
);
1099 ctf_fs_trace_destroy(ctf_fs_trace
);
1100 ctf_fs_trace
= NULL
;
1103 return ctf_fs_trace
;
1107 int path_is_ctf_trace(const char *path
)
1109 GString
*metadata_path
= g_string_new(NULL
);
1112 if (!metadata_path
) {
1117 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
1119 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
1125 g_string_free(metadata_path
, TRUE
);
1130 int add_trace_path(GList
**trace_paths
, const char *path
,
1131 bt_logging_level log_level
, bt_self_component
*self_comp
)
1133 GString
*norm_path
= NULL
;
1136 norm_path
= bt_common_normalize_path(path
, NULL
);
1138 BT_COMP_LOGE("Failed to normalize path `%s`.", path
);
1143 // FIXME: Remove or ifdef for __MINGW32__
1144 if (strcmp(norm_path
->str
, "/") == 0) {
1145 BT_COMP_LOGE("Opening a trace in `/` is not supported.");
1150 *trace_paths
= g_list_prepend(*trace_paths
, norm_path
);
1151 BT_ASSERT(*trace_paths
);
1156 g_string_free(norm_path
, TRUE
);
1163 int ctf_fs_find_traces(GList
**trace_paths
, const char *start_path
,
1164 bt_logging_level log_level
, bt_self_component
*self_comp
)
1167 GError
*error
= NULL
;
1169 const char *basename
= NULL
;
1171 /* Check if the starting path is a CTF trace itself */
1172 ret
= path_is_ctf_trace(start_path
);
1179 * Stop recursion: a CTF trace cannot contain another
1182 ret
= add_trace_path(trace_paths
, start_path
, log_level
,
1187 /* Look for subdirectories */
1188 if (!g_file_test(start_path
, G_FILE_TEST_IS_DIR
)) {
1189 /* Starting path is not a directory: end of recursion */
1193 dir
= g_dir_open(start_path
, 0, &error
);
1195 if (error
->code
== G_FILE_ERROR_ACCES
) {
1196 BT_COMP_LOGI("Cannot open directory `%s`: %s (code %d): continuing",
1197 start_path
, error
->message
, error
->code
);
1201 BT_COMP_LOGE("Cannot open directory `%s`: %s (code %d)",
1202 start_path
, error
->message
, error
->code
);
1207 while ((basename
= g_dir_read_name(dir
))) {
1208 GString
*sub_path
= g_string_new(NULL
);
1215 g_string_printf(sub_path
, "%s" G_DIR_SEPARATOR_S
"%s", start_path
, basename
);
1216 ret
= ctf_fs_find_traces(trace_paths
, sub_path
->str
,
1217 log_level
, self_comp
);
1218 g_string_free(sub_path
, TRUE
);
1230 g_error_free(error
);
1237 GList
*ctf_fs_create_trace_names(GList
*trace_paths
, const char *base_path
) {
1238 GList
*trace_names
= NULL
;
1240 const char *last_sep
;
1244 * At this point we know that all the trace paths are
1245 * normalized, and so is the base path. This means that
1246 * they are absolute and they don't end with a separator.
1247 * We can simply find the location of the last separator
1248 * in the base path, which gives us the name of the actual
1249 * directory to look into, and use this location as the
1250 * start of each trace name within each trace path.
1254 * Base path: /home/user/my-traces/some-trace
1256 * - /home/user/my-traces/some-trace/host1/trace1
1257 * - /home/user/my-traces/some-trace/host1/trace2
1258 * - /home/user/my-traces/some-trace/host2/trace
1259 * - /home/user/my-traces/some-trace/other-trace
1261 * In this case the trace names are:
1263 * - some-trace/host1/trace1
1264 * - some-trace/host1/trace2
1265 * - some-trace/host2/trace
1266 * - some-trace/other-trace
1268 last_sep
= strrchr(base_path
, G_DIR_SEPARATOR
);
1270 /* We know there's at least one separator */
1271 BT_ASSERT(last_sep
);
1273 /* Distance to base */
1274 base_dist
= last_sep
- base_path
+ 1;
1276 /* Create the trace names */
1277 for (node
= trace_paths
; node
; node
= g_list_next(node
)) {
1278 GString
*trace_name
= g_string_new(NULL
);
1279 GString
*trace_path
= node
->data
;
1281 BT_ASSERT(trace_name
);
1282 g_string_assign(trace_name
, &trace_path
->str
[base_dist
]);
1283 trace_names
= g_list_append(trace_names
, trace_name
);
1289 /* Helper for ctf_fs_component_create_ctf_fs_traces, to handle a single path/root. */
1292 int ctf_fs_component_create_ctf_fs_traces_one_root(
1293 struct ctf_fs_component
*ctf_fs
,
1294 const char *path_param
)
1296 struct ctf_fs_trace
*ctf_fs_trace
= NULL
;
1298 GString
*norm_path
= NULL
;
1299 GList
*trace_paths
= NULL
;
1300 GList
*trace_names
= NULL
;
1303 bt_logging_level log_level
= ctf_fs
->log_level
;
1304 bt_self_component
*self_comp
= ctf_fs
->self_comp
;
1306 norm_path
= bt_common_normalize_path(path_param
, NULL
);
1308 BT_COMP_LOGE("Failed to normalize path: `%s`.",
1313 ret
= ctf_fs_find_traces(&trace_paths
, norm_path
->str
, log_level
,
1320 BT_COMP_LOGE("No CTF traces recursively found in `%s`.",
1322 (void) BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_COMPONENT(
1324 "No CTF traces recursively found in `%s`.", path_param
);
1328 trace_names
= ctf_fs_create_trace_names(trace_paths
, norm_path
->str
);
1330 BT_COMP_LOGE("Cannot create trace names from trace paths.");
1334 for (tp_node
= trace_paths
, tn_node
= trace_names
; tp_node
;
1335 tp_node
= g_list_next(tp_node
),
1336 tn_node
= g_list_next(tn_node
)) {
1337 GString
*trace_path
= tp_node
->data
;
1338 GString
*trace_name
= tn_node
->data
;
1340 ctf_fs_trace
= ctf_fs_trace_create(self_comp
,
1341 trace_path
->str
, trace_name
->str
,
1342 &ctf_fs
->metadata_config
,
1344 if (!ctf_fs_trace
) {
1345 BT_COMP_LOGE("Cannot create trace for `%s`.",
1350 g_ptr_array_add(ctf_fs
->traces
, ctf_fs_trace
);
1351 ctf_fs_trace
= NULL
;
1358 ctf_fs_trace_destroy(ctf_fs_trace
);
1361 for (tp_node
= trace_paths
; tp_node
; tp_node
= g_list_next(tp_node
)) {
1362 if (tp_node
->data
) {
1363 g_string_free(tp_node
->data
, TRUE
);
1367 for (tn_node
= trace_names
; tn_node
; tn_node
= g_list_next(tn_node
)) {
1368 if (tn_node
->data
) {
1369 g_string_free(tn_node
->data
, TRUE
);
1374 g_list_free(trace_paths
);
1378 g_list_free(trace_names
);
1382 g_string_free(norm_path
, TRUE
);
1388 /* GCompareFunc to sort traces by UUID. */
1391 gint
sort_traces_by_uuid(gconstpointer a
, gconstpointer b
)
1393 const struct ctf_fs_trace
*trace_a
= *((const struct ctf_fs_trace
**) a
);
1394 const struct ctf_fs_trace
*trace_b
= *((const struct ctf_fs_trace
**) b
);
1396 bool trace_a_has_uuid
= trace_a
->metadata
->tc
->is_uuid_set
;
1397 bool trace_b_has_uuid
= trace_b
->metadata
->tc
->is_uuid_set
;
1400 /* Order traces without uuid first. */
1401 if (!trace_a_has_uuid
&& trace_b_has_uuid
) {
1403 } else if (trace_a_has_uuid
&& !trace_b_has_uuid
) {
1405 } else if (!trace_a_has_uuid
&& !trace_b_has_uuid
) {
1408 ret
= bt_uuid_compare(trace_a
->metadata
->tc
->uuid
, trace_b
->metadata
->tc
->uuid
);
1415 * Count the number of stream and event classes defined by this trace's metadata.
1417 * This is used to determine which metadata is the "latest", out of multiple
1418 * traces sharing the same UUID. It is assumed that amongst all these metadatas,
1419 * a bigger metadata is a superset of a smaller metadata. Therefore, it is
1420 * enough to just count the classes.
1424 unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace
*trace
)
1426 unsigned int num
= trace
->metadata
->tc
->stream_classes
->len
;
1429 for (i
= 0; i
< trace
->metadata
->tc
->stream_classes
->len
; i
++) {
1430 struct ctf_stream_class
*sc
= trace
->metadata
->tc
->stream_classes
->pdata
[i
];
1431 num
+= sc
->event_classes
->len
;
1438 * Merge the src ds_file_group into dest. This consists of merging their
1439 * ds_file_infos, making sure to keep the result sorted.
1443 void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group
*dest
, struct ctf_fs_ds_file_group
*src
)
1447 for (i
= 0; i
< src
->ds_file_infos
->len
; i
++) {
1448 struct ctf_fs_ds_file_info
*ds_file_info
=
1449 g_ptr_array_index(src
->ds_file_infos
, i
);
1451 /* Ownership of the ds_file_info is transferred to dest. */
1452 g_ptr_array_index(src
->ds_file_infos
, i
) = NULL
;
1454 ds_file_group_insert_ds_file_info_sorted(dest
, ds_file_info
);
1457 /* Merge both indexes. */
1458 for (i
= 0; i
< src
->index
->entries
->len
; i
++) {
1459 struct ctf_fs_ds_index_entry
*entry
= g_ptr_array_index(
1460 src
->index
->entries
, i
);
1463 * Ownership of the ctf_fs_ds_index_entry is transferred to
1466 g_ptr_array_index(src
->index
->entries
, i
) = NULL
;
1468 ds_file_group_insert_ds_index_entry_sorted(dest
, entry
);
1471 /* Merge src_trace's data stream file groups into dest_trace's. */
1474 int merge_matching_ctf_fs_ds_file_groups(
1475 struct ctf_fs_trace
*dest_trace
,
1476 struct ctf_fs_trace
*src_trace
)
1479 GPtrArray
*dest
= dest_trace
->ds_file_groups
;
1480 GPtrArray
*src
= src_trace
->ds_file_groups
;
1485 * Save the initial length of dest: we only want to check against the
1486 * original elements in the inner loop.
1488 const guint dest_len
= dest
->len
;
1490 for (s_i
= 0; s_i
< src
->len
; s_i
++) {
1491 struct ctf_fs_ds_file_group
*src_group
= g_ptr_array_index(src
, s_i
);
1492 struct ctf_fs_ds_file_group
*dest_group
= NULL
;
1494 /* A stream instance without ID can't match a stream in the other trace. */
1495 if (src_group
->stream_id
!= -1) {
1498 /* Let's search for a matching ds_file_group in the destination. */
1499 for (d_i
= 0; d_i
< dest_len
; d_i
++) {
1500 struct ctf_fs_ds_file_group
*candidate_dest
= g_ptr_array_index(dest
, d_i
);
1502 /* Can't match a stream instance without ID. */
1503 if (candidate_dest
->stream_id
== -1) {
1508 * If the two groups have the same stream instance id
1509 * and belong to the same stream class (stream instance
1510 * ids are per-stream class), they represent the same
1513 if (candidate_dest
->stream_id
!= src_group
->stream_id
||
1514 candidate_dest
->sc
->id
!= src_group
->sc
->id
) {
1518 dest_group
= candidate_dest
;
1524 * Didn't find a friend in dest to merge our src_group into?
1525 * Create a new empty one. This can happen if a stream was
1526 * active in the source trace chunk but not in the destination
1530 struct ctf_stream_class
*sc
;
1531 struct ctf_fs_ds_index
*index
;
1533 sc
= ctf_trace_class_borrow_stream_class_by_id(
1534 dest_trace
->metadata
->tc
, src_group
->sc
->id
);
1537 index
= ctf_fs_ds_index_create(dest_trace
->log_level
,
1538 dest_trace
->self_comp
);
1544 dest_group
= ctf_fs_ds_file_group_create(dest_trace
, sc
,
1545 src_group
->stream_id
, index
);
1546 /* Ownership of index is transferred. */
1553 g_ptr_array_add(dest_trace
->ds_file_groups
, dest_group
);
1556 BT_ASSERT(dest_group
);
1557 merge_ctf_fs_ds_file_groups(dest_group
, src_group
);
1565 * Collapse the given traces, which must all share the same UUID, in a single
1568 * The trace with the most expansive metadata is chosen and all other traces
1569 * are merged into that one. The array slots of all the traces that get merged
1570 * in the chosen one are set to NULL, so only the slot of the chosen trace
1575 int merge_ctf_fs_traces(struct ctf_fs_trace
**traces
, unsigned int num_traces
)
1577 unsigned int winner_count
;
1578 struct ctf_fs_trace
*winner
;
1581 char uuid_str
[BT_UUID_STR_LEN
+ 1];
1583 BT_ASSERT(num_traces
>= 2);
1585 winner_count
= metadata_count_stream_and_event_classes(traces
[0]);
1588 /* Find the trace with the largest metadata. */
1589 for (i
= 1; i
< num_traces
; i
++) {
1590 struct ctf_fs_trace
*candidate
;
1591 unsigned int candidate_count
;
1593 candidate
= traces
[i
];
1595 /* A bit of sanity check. */
1596 BT_ASSERT(bt_uuid_compare(winner
->metadata
->tc
->uuid
, candidate
->metadata
->tc
->uuid
) == 0);
1598 candidate_count
= metadata_count_stream_and_event_classes(candidate
);
1600 if (candidate_count
> winner_count
) {
1601 winner_count
= candidate_count
;
1606 /* Merge all the other traces in the winning trace. */
1607 for (i
= 0; i
< num_traces
; i
++) {
1608 struct ctf_fs_trace
*trace
= traces
[i
];
1610 /* Don't merge the winner into itself. */
1611 if (trace
== winner
) {
1615 /* Merge trace's data stream file groups into winner's. */
1616 ret
= merge_matching_ctf_fs_ds_file_groups(winner
, trace
);
1621 /* Free the trace that got merged into winner, clear the slot in the array. */
1622 ctf_fs_trace_destroy(trace
);
1626 /* Use the string representation of the UUID as the trace name. */
1627 bt_uuid_to_str(winner
->metadata
->tc
->uuid
, uuid_str
);
1628 g_string_printf(winner
->name
, "%s", uuid_str
);
1635 * Merge all traces of `ctf_fs` that share the same UUID in a single trace.
1636 * Traces with no UUID are not merged.
1640 int merge_traces_with_same_uuid(struct ctf_fs_component
*ctf_fs
)
1642 GPtrArray
*traces
= ctf_fs
->traces
;
1643 guint range_start_idx
= 0;
1644 unsigned int num_traces
= 0;
1648 /* Sort the traces by uuid, then collapse traces with the same uuid in a single one. */
1649 g_ptr_array_sort(traces
, sort_traces_by_uuid
);
1651 /* Find ranges of consecutive traces that share the same UUID. */
1652 while (range_start_idx
< traces
->len
) {
1654 struct ctf_fs_trace
*range_start_trace
= g_ptr_array_index(traces
, range_start_idx
);
1656 /* Exclusive end of range. */
1657 guint range_end_exc_idx
= range_start_idx
+ 1;
1659 while (range_end_exc_idx
< traces
->len
) {
1660 struct ctf_fs_trace
*this_trace
= g_ptr_array_index(traces
, range_end_exc_idx
);
1662 if (!range_start_trace
->metadata
->tc
->is_uuid_set
||
1663 (bt_uuid_compare(range_start_trace
->metadata
->tc
->uuid
, this_trace
->metadata
->tc
->uuid
) != 0)) {
1667 range_end_exc_idx
++;
1670 /* If we have two or more traces with matching UUIDs, merge them. */
1671 range_len
= range_end_exc_idx
- range_start_idx
;
1672 if (range_len
> 1) {
1673 struct ctf_fs_trace
**range_start
= (struct ctf_fs_trace
**) &traces
->pdata
[range_start_idx
];
1674 ret
= merge_ctf_fs_traces(range_start
, range_len
);
1681 range_start_idx
= range_end_exc_idx
;
1684 /* Clear any NULL slot (traces that got merged in another one) in the array. */
1685 for (i
= 0; i
< traces
->len
;) {
1686 if (!g_ptr_array_index(traces
, i
)) {
1687 g_ptr_array_remove_index_fast(traces
, i
);
1693 BT_ASSERT(num_traces
== traces
->len
);
1699 int ctf_fs_component_create_ctf_fs_traces(bt_self_component_source
*self_comp
,
1700 struct ctf_fs_component
*ctf_fs
,
1701 const bt_value
*paths_value
)
1706 for (i
= 0; i
< bt_value_array_get_size(paths_value
); i
++) {
1707 const bt_value
*path_value
= bt_value_array_borrow_element_by_index_const(paths_value
, i
);
1708 const char *input
= bt_value_string_get(path_value
);
1710 ret
= ctf_fs_component_create_ctf_fs_traces_one_root(ctf_fs
,
1717 ret
= merge_traces_with_same_uuid(ctf_fs
);
1724 GString
*get_stream_instance_unique_name(
1725 struct ctf_fs_ds_file_group
*ds_file_group
)
1728 struct ctf_fs_ds_file_info
*ds_file_info
;
1730 name
= g_string_new(NULL
);
1736 * If there's more than one stream file in the stream file
1737 * group, the first (earliest) stream file's path is used as
1738 * the stream's unique name.
1740 BT_ASSERT(ds_file_group
->ds_file_infos
->len
> 0);
1741 ds_file_info
= g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
1742 g_string_assign(name
, ds_file_info
->path
->str
);
1748 /* Create the IR stream objects for ctf_fs_trace. */
1751 int create_streams_for_trace(struct ctf_fs_trace
*ctf_fs_trace
)
1754 GString
*name
= NULL
;
1756 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
1757 bt_self_component
*self_comp
= ctf_fs_trace
->self_comp
;
1759 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
1760 struct ctf_fs_ds_file_group
*ds_file_group
=
1761 g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
1762 name
= get_stream_instance_unique_name(ds_file_group
);
1768 if (ds_file_group
->sc
->ir_sc
) {
1769 BT_ASSERT(ctf_fs_trace
->trace
);
1771 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
1772 /* No stream ID: use 0 */
1773 ds_file_group
->stream
= bt_stream_create_with_id(
1774 ds_file_group
->sc
->ir_sc
,
1775 ctf_fs_trace
->trace
,
1776 ctf_fs_trace
->next_stream_id
);
1777 ctf_fs_trace
->next_stream_id
++;
1779 /* Specific stream ID */
1780 ds_file_group
->stream
= bt_stream_create_with_id(
1781 ds_file_group
->sc
->ir_sc
,
1782 ctf_fs_trace
->trace
,
1783 (uint64_t) ds_file_group
->stream_id
);
1786 ds_file_group
->stream
= NULL
;
1789 if (!ds_file_group
->stream
) {
1790 BT_COMP_LOGE("Cannot create stream for DS file group: "
1791 "addr=%p, stream-name=\"%s\"",
1792 ds_file_group
, name
->str
);
1796 ret
= bt_stream_set_name(ds_file_group
->stream
,
1799 BT_COMP_LOGE("Cannot set stream's name: "
1800 "addr=%p, stream-name=\"%s\"",
1801 ds_file_group
->stream
, name
->str
);
1805 g_string_free(name
, TRUE
);
1818 g_string_free(name
, TRUE
);
1824 * Validate the "paths" parameter passed to this component. It must be
1825 * present, and it must be an array of strings.
1829 bool validate_inputs_parameter(struct ctf_fs_component
*ctf_fs
,
1830 const bt_value
*inputs
)
1835 bt_logging_level log_level
= ctf_fs
->log_level
;
1836 bt_self_component
*self_comp
= ctf_fs
->self_comp
;
1839 BT_COMP_LOGE("missing \"inputs\" parameter");
1843 type
= bt_value_get_type(inputs
);
1844 if (type
!= BT_VALUE_TYPE_ARRAY
) {
1845 BT_COMP_LOGE("`inputs` parameter: expecting array value: type=%s",
1846 bt_common_value_type_string(type
));
1850 for (i
= 0; i
< bt_value_array_get_size(inputs
); i
++) {
1851 const bt_value
*elem
;
1853 elem
= bt_value_array_borrow_element_by_index_const(inputs
, i
);
1854 type
= bt_value_get_type(elem
);
1855 if (type
!= BT_VALUE_TYPE_STRING
) {
1856 BT_COMP_LOGE("`inputs` parameter: expecting string value: index=%" PRIu64
", type=%s",
1857 i
, bt_common_value_type_string(type
));
1872 bool read_src_fs_parameters(const bt_value
*params
,
1873 const bt_value
**inputs
, struct ctf_fs_component
*ctf_fs
) {
1875 const bt_value
*value
;
1876 bt_logging_level log_level
= ctf_fs
->log_level
;
1877 bt_self_component
*self_comp
= ctf_fs
->self_comp
;
1879 /* inputs parameter */
1880 *inputs
= bt_value_map_borrow_entry_value_const(params
, "inputs");
1881 if (!validate_inputs_parameter(ctf_fs
, *inputs
)) {
1885 /* clock-class-offset-s parameter */
1886 value
= bt_value_map_borrow_entry_value_const(params
,
1887 "clock-class-offset-s");
1889 if (!bt_value_is_signed_integer(value
)) {
1890 BT_COMP_LOGE("clock-class-offset-s must be an integer");
1893 ctf_fs
->metadata_config
.clock_class_offset_s
=
1894 bt_value_integer_signed_get(value
);
1897 /* clock-class-offset-ns parameter */
1898 value
= bt_value_map_borrow_entry_value_const(params
,
1899 "clock-class-offset-ns");
1901 if (!bt_value_is_signed_integer(value
)) {
1902 BT_COMP_LOGE("clock-class-offset-ns must be an integer");
1905 ctf_fs
->metadata_config
.clock_class_offset_ns
=
1906 bt_value_integer_signed_get(value
);
1921 struct ctf_fs_component
*ctf_fs_create(
1922 bt_self_component_source
*self_comp_src
,
1923 const bt_value
*params
)
1925 struct ctf_fs_component
*ctf_fs
= NULL
;
1927 const bt_value
*inputs_value
;
1928 bt_self_component
*self_comp
=
1929 bt_self_component_source_as_self_component(self_comp_src
);
1931 ctf_fs
= ctf_fs_component_create(bt_component_get_logging_level(
1932 bt_self_component_as_component(self_comp
)), self_comp
);
1937 if (!read_src_fs_parameters(params
, &inputs_value
, ctf_fs
)) {
1941 bt_self_component_set_data(self_comp
, ctf_fs
);
1942 ctf_fs
->self_comp
= self_comp
;
1943 ctf_fs
->self_comp_src
= self_comp_src
;
1945 if (ctf_fs_component_create_ctf_fs_traces(self_comp_src
, ctf_fs
, inputs_value
)) {
1949 for (i
= 0; i
< ctf_fs
->traces
->len
; i
++) {
1950 struct ctf_fs_trace
*trace
= g_ptr_array_index(ctf_fs
->traces
, i
);
1952 if (create_streams_for_trace(trace
)) {
1956 if (create_ports_for_trace(ctf_fs
, trace
)) {
1964 ctf_fs_destroy(ctf_fs
);
1966 bt_self_component_set_data(self_comp
, NULL
);
1973 bt_component_class_init_method_status
ctf_fs_init(
1974 bt_self_component_source
*self_comp
,
1975 const bt_value
*params
, __attribute__((unused
)) void *init_method_data
)
1977 struct ctf_fs_component
*ctf_fs
;
1978 bt_component_class_init_method_status ret
=
1979 BT_COMPONENT_CLASS_INIT_METHOD_STATUS_OK
;
1981 ctf_fs
= ctf_fs_create(self_comp
, params
);
1983 ret
= BT_COMPONENT_CLASS_INIT_METHOD_STATUS_ERROR
;
1990 bt_component_class_query_method_status
ctf_fs_query(
1991 bt_self_component_class_source
*comp_class
,
1992 const bt_query_executor
*query_exec
,
1993 const char *object
, const bt_value
*params
,
1994 bt_logging_level log_level
,
1995 const bt_value
**result
)
1997 bt_component_class_query_method_status status
=
1998 BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
2000 if (strcmp(object
, "metadata-info") == 0) {
2001 status
= metadata_info_query(comp_class
, params
, log_level
,
2003 } else if (strcmp(object
, "trace-info") == 0) {
2004 status
= trace_info_query(comp_class
, params
, log_level
,
2006 } else if (!strcmp(object
, "support-info")) {
2007 status
= support_info_query(comp_class
, params
, log_level
, result
);
2009 BT_LOGE("Unknown query object `%s`", object
);
2010 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_UNKNOWN_OBJECT
;