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_LOG_OUTPUT_LEVEL log_level
29 #define BT_LOG_TAG "PLUGIN/SRC.CTF.FS"
30 #include "logging/log.h"
32 #include "common/common.h"
33 #include <babeltrace2/babeltrace.h>
34 #include "compat/uuid.h"
36 #include "common/assert.h"
41 #include "data-stream-file.h"
43 #include "../common/metadata/decoder.h"
44 #include "../common/msg-iter/msg-iter.h"
48 int msg_iter_data_set_current_ds_file(struct ctf_fs_msg_iter_data
*msg_iter_data
)
50 struct ctf_fs_ds_file_info
*ds_file_info
;
53 BT_ASSERT(msg_iter_data
->ds_file_info_index
<
54 msg_iter_data
->ds_file_group
->ds_file_infos
->len
);
55 ds_file_info
= g_ptr_array_index(
56 msg_iter_data
->ds_file_group
->ds_file_infos
,
57 msg_iter_data
->ds_file_info_index
);
59 ctf_fs_ds_file_destroy(msg_iter_data
->ds_file
);
60 msg_iter_data
->ds_file
= ctf_fs_ds_file_create(
61 msg_iter_data
->ds_file_group
->ctf_fs_trace
,
62 msg_iter_data
->pc_msg_iter
,
63 msg_iter_data
->msg_iter
,
64 msg_iter_data
->ds_file_group
->stream
,
65 ds_file_info
->path
->str
,
66 msg_iter_data
->log_level
);
67 if (!msg_iter_data
->ds_file
) {
75 void ctf_fs_msg_iter_data_destroy(
76 struct ctf_fs_msg_iter_data
*msg_iter_data
)
82 ctf_fs_ds_file_destroy(msg_iter_data
->ds_file
);
84 if (msg_iter_data
->msg_iter
) {
85 bt_msg_iter_destroy(msg_iter_data
->msg_iter
);
88 g_free(msg_iter_data
);
92 void set_msg_iter_emits_stream_beginning_end_messages(
93 struct ctf_fs_msg_iter_data
*msg_iter_data
)
95 bt_msg_iter_set_emit_stream_beginning_message(
96 msg_iter_data
->ds_file
->msg_iter
,
97 msg_iter_data
->ds_file_info_index
== 0);
98 bt_msg_iter_set_emit_stream_end_message(
99 msg_iter_data
->ds_file
->msg_iter
,
100 msg_iter_data
->ds_file_info_index
==
101 msg_iter_data
->ds_file_group
->ds_file_infos
->len
- 1);
105 bt_self_message_iterator_status
ctf_fs_iterator_next_one(
106 struct ctf_fs_msg_iter_data
*msg_iter_data
,
107 const bt_message
**out_msg
)
109 bt_self_message_iterator_status status
;
111 BT_ASSERT(msg_iter_data
->ds_file
);
116 status
= ctf_fs_ds_file_next(msg_iter_data
->ds_file
, &msg
);
118 case BT_SELF_MESSAGE_ITERATOR_STATUS_OK
:
122 case BT_SELF_MESSAGE_ITERATOR_STATUS_END
:
126 if (msg_iter_data
->ds_file_info_index
==
127 msg_iter_data
->ds_file_group
->ds_file_infos
->len
- 1) {
128 /* End of all group's stream files */
132 msg_iter_data
->ds_file_info_index
++;
133 bt_msg_iter_reset_for_next_stream_file(
134 msg_iter_data
->msg_iter
);
135 set_msg_iter_emits_stream_beginning_end_messages(
139 * Open and start reading the next stream file
140 * within our stream file group.
142 ret
= msg_iter_data_set_current_ds_file(msg_iter_data
);
144 status
= BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR
;
148 /* Continue the loop to get the next message */
161 bt_self_message_iterator_status
ctf_fs_iterator_next(
162 bt_self_message_iterator
*iterator
,
163 bt_message_array_const msgs
, uint64_t capacity
,
166 bt_self_message_iterator_status status
=
167 BT_SELF_MESSAGE_ITERATOR_STATUS_OK
;
168 struct ctf_fs_msg_iter_data
*msg_iter_data
=
169 bt_self_message_iterator_get_data(iterator
);
172 while (i
< capacity
&& status
== BT_SELF_MESSAGE_ITERATOR_STATUS_OK
) {
173 status
= ctf_fs_iterator_next_one(msg_iter_data
, &msgs
[i
]);
174 if (status
== BT_SELF_MESSAGE_ITERATOR_STATUS_OK
) {
181 * Even if ctf_fs_iterator_next_one() returned something
182 * else than BT_SELF_MESSAGE_ITERATOR_STATUS_OK, we
183 * accumulated message objects in the output
184 * message array, so we need to return
185 * BT_SELF_MESSAGE_ITERATOR_STATUS_OK so that they are
186 * transfered to downstream. This other status occurs
187 * again the next time muxer_msg_iter_do_next() is
188 * called, possibly without any accumulated
189 * message, in which case we'll return it.
192 status
= BT_SELF_MESSAGE_ITERATOR_STATUS_OK
;
199 int ctf_fs_iterator_reset(struct ctf_fs_msg_iter_data
*msg_iter_data
)
203 msg_iter_data
->ds_file_info_index
= 0;
204 ret
= msg_iter_data_set_current_ds_file(msg_iter_data
);
209 bt_msg_iter_reset(msg_iter_data
->msg_iter
);
210 set_msg_iter_emits_stream_beginning_end_messages(msg_iter_data
);
217 bt_self_message_iterator_status
ctf_fs_iterator_seek_beginning(
218 bt_self_message_iterator
*it
)
220 struct ctf_fs_msg_iter_data
*msg_iter_data
=
221 bt_self_message_iterator_get_data(it
);
222 bt_self_message_iterator_status status
=
223 BT_SELF_MESSAGE_ITERATOR_STATUS_OK
;
225 BT_ASSERT(msg_iter_data
);
226 if (ctf_fs_iterator_reset(msg_iter_data
)) {
227 status
= BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR
;
234 void ctf_fs_iterator_finalize(bt_self_message_iterator
*it
)
236 ctf_fs_msg_iter_data_destroy(
237 bt_self_message_iterator_get_data(it
));
241 bt_self_message_iterator_status
ctf_fs_iterator_init(
242 bt_self_message_iterator
*self_msg_iter
,
243 bt_self_component_source
*self_comp
,
244 bt_self_component_port_output
*self_port
)
246 struct ctf_fs_port_data
*port_data
;
247 struct ctf_fs_msg_iter_data
*msg_iter_data
= NULL
;
248 bt_self_message_iterator_status ret
=
249 BT_SELF_MESSAGE_ITERATOR_STATUS_OK
;
250 bt_logging_level log_level
;
252 port_data
= bt_self_component_port_get_data(
253 bt_self_component_port_output_as_self_component_port(
255 BT_ASSERT(port_data
);
256 log_level
= port_data
->ctf_fs
->log_level
;
257 msg_iter_data
= g_new0(struct ctf_fs_msg_iter_data
, 1);
258 if (!msg_iter_data
) {
259 ret
= BT_SELF_MESSAGE_ITERATOR_STATUS_NOMEM
;
263 msg_iter_data
->log_level
= log_level
;
264 msg_iter_data
->pc_msg_iter
= self_msg_iter
;
265 msg_iter_data
->msg_iter
= bt_msg_iter_create(
266 port_data
->ds_file_group
->ctf_fs_trace
->metadata
->tc
,
267 bt_common_get_page_size(msg_iter_data
->log_level
) * 8,
268 ctf_fs_ds_file_medops
, NULL
, msg_iter_data
->log_level
, NULL
);
269 if (!msg_iter_data
->msg_iter
) {
270 BT_LOGE_STR("Cannot create a CTF message iterator.");
271 ret
= BT_SELF_MESSAGE_ITERATOR_STATUS_NOMEM
;
275 msg_iter_data
->ds_file_group
= port_data
->ds_file_group
;
276 if (ctf_fs_iterator_reset(msg_iter_data
)) {
277 ret
= BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR
;
281 bt_self_message_iterator_set_data(self_msg_iter
,
283 if (ret
!= BT_SELF_MESSAGE_ITERATOR_STATUS_OK
) {
287 msg_iter_data
= NULL
;
291 bt_self_message_iterator_set_data(self_msg_iter
, NULL
);
294 ctf_fs_msg_iter_data_destroy(msg_iter_data
);
299 void ctf_fs_destroy(struct ctf_fs_component
*ctf_fs
)
305 if (ctf_fs
->traces
) {
306 g_ptr_array_free(ctf_fs
->traces
, TRUE
);
309 if (ctf_fs
->port_data
) {
310 g_ptr_array_free(ctf_fs
->port_data
, TRUE
);
317 void port_data_destroy(struct ctf_fs_port_data
*port_data
)
327 void port_data_destroy_notifier(void *data
) {
328 port_data_destroy(data
);
332 void ctf_fs_trace_destroy(struct ctf_fs_trace
*ctf_fs_trace
)
338 if (ctf_fs_trace
->ds_file_groups
) {
339 g_ptr_array_free(ctf_fs_trace
->ds_file_groups
, TRUE
);
342 BT_TRACE_PUT_REF_AND_RESET(ctf_fs_trace
->trace
);
344 if (ctf_fs_trace
->path
) {
345 g_string_free(ctf_fs_trace
->path
, TRUE
);
348 if (ctf_fs_trace
->name
) {
349 g_string_free(ctf_fs_trace
->name
, TRUE
);
352 if (ctf_fs_trace
->metadata
) {
353 ctf_fs_metadata_fini(ctf_fs_trace
->metadata
);
354 g_free(ctf_fs_trace
->metadata
);
357 g_free(ctf_fs_trace
);
361 void ctf_fs_trace_destroy_notifier(void *data
)
363 struct ctf_fs_trace
*trace
= data
;
364 ctf_fs_trace_destroy(trace
);
367 struct ctf_fs_component
*ctf_fs_component_create(bt_logging_level log_level
)
369 struct ctf_fs_component
*ctf_fs
;
371 ctf_fs
= g_new0(struct ctf_fs_component
, 1);
376 ctf_fs
->log_level
= log_level
;
378 g_ptr_array_new_with_free_func(port_data_destroy_notifier
);
379 if (!ctf_fs
->port_data
) {
384 g_ptr_array_new_with_free_func(ctf_fs_trace_destroy_notifier
);
385 if (!ctf_fs
->traces
) {
393 ctf_fs_destroy(ctf_fs
);
400 void ctf_fs_finalize(bt_self_component_source
*component
)
402 ctf_fs_destroy(bt_self_component_get_data(
403 bt_self_component_source_as_self_component(component
)));
406 gchar
*ctf_fs_make_port_name(struct ctf_fs_ds_file_group
*ds_file_group
)
408 GString
*name
= g_string_new(NULL
);
411 * The unique port name is generated by concatenating unique identifiers
419 /* For the trace, use the uuid if present, else the path. */
420 if (ds_file_group
->ctf_fs_trace
->metadata
->tc
->is_uuid_set
) {
421 char uuid_str
[BABELTRACE_UUID_STR_LEN
];
423 bt_uuid_unparse(ds_file_group
->ctf_fs_trace
->metadata
->tc
->uuid
, uuid_str
);
424 g_string_assign(name
, uuid_str
);
426 g_string_assign(name
, ds_file_group
->ctf_fs_trace
->path
->str
);
430 * For the stream class, use the id if present. We can omit this field
431 * otherwise, as there will only be a single stream class.
433 if (ds_file_group
->sc
->id
!= UINT64_C(-1)) {
434 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->sc
->id
);
437 /* For the stream, use the id if present, else, use the path. */
438 if (ds_file_group
->stream_id
!= UINT64_C(-1)) {
439 g_string_append_printf(name
, " | %" PRIu64
, ds_file_group
->stream_id
);
441 BT_ASSERT(ds_file_group
->ds_file_infos
->len
== 1);
442 struct ctf_fs_ds_file_info
*ds_file_info
=
443 g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
444 g_string_append_printf(name
, " | %s", ds_file_info
->path
->str
);
447 return g_string_free(name
, FALSE
);
451 int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
452 struct ctf_fs_trace
*ctf_fs_trace
,
453 struct ctf_fs_ds_file_group
*ds_file_group
)
456 struct ctf_fs_port_data
*port_data
= NULL
;
458 bt_logging_level log_level
= ctf_fs
->log_level
;
460 port_name
= ctf_fs_make_port_name(ds_file_group
);
465 BT_LOGI("Creating one port named `%s`", port_name
);
467 /* Create output port for this file */
468 port_data
= g_new0(struct ctf_fs_port_data
, 1);
473 port_data
->ctf_fs
= ctf_fs
;
474 port_data
->ds_file_group
= ds_file_group
;
475 ret
= bt_self_component_source_add_output_port(
476 ctf_fs
->self_comp
, port_name
, port_data
, NULL
);
481 g_ptr_array_add(ctf_fs
->port_data
, port_data
);
493 port_data_destroy(port_data
);
498 int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
499 struct ctf_fs_trace
*ctf_fs_trace
)
503 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
505 /* Create one output port for each stream file group */
506 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
507 struct ctf_fs_ds_file_group
*ds_file_group
=
508 g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
510 ret
= create_one_port_for_trace(ctf_fs
, ctf_fs_trace
,
513 BT_LOGE("Cannot create output port.");
523 void ctf_fs_ds_file_info_destroy(struct ctf_fs_ds_file_info
*ds_file_info
)
529 if (ds_file_info
->path
) {
530 g_string_free(ds_file_info
->path
, TRUE
);
533 g_free(ds_file_info
);
537 struct ctf_fs_ds_file_info
*ctf_fs_ds_file_info_create(const char *path
,
540 struct ctf_fs_ds_file_info
*ds_file_info
;
542 ds_file_info
= g_new0(struct ctf_fs_ds_file_info
, 1);
547 ds_file_info
->path
= g_string_new(path
);
548 if (!ds_file_info
->path
) {
549 ctf_fs_ds_file_info_destroy(ds_file_info
);
554 ds_file_info
->begin_ns
= begin_ns
;
561 void ctf_fs_ds_file_group_destroy(struct ctf_fs_ds_file_group
*ds_file_group
)
563 if (!ds_file_group
) {
567 if (ds_file_group
->ds_file_infos
) {
568 g_ptr_array_free(ds_file_group
->ds_file_infos
, TRUE
);
571 if (ds_file_group
->index
) {
572 if (ds_file_group
->index
->entries
) {
573 g_ptr_array_free(ds_file_group
->index
->entries
, TRUE
);
575 g_free(ds_file_group
->index
);
578 bt_stream_put_ref(ds_file_group
->stream
);
579 g_free(ds_file_group
);
583 struct ctf_fs_ds_file_group
*ctf_fs_ds_file_group_create(
584 struct ctf_fs_trace
*ctf_fs_trace
,
585 struct ctf_stream_class
*sc
,
586 uint64_t stream_instance_id
,
587 struct ctf_fs_ds_index
*index
)
589 struct ctf_fs_ds_file_group
*ds_file_group
;
591 ds_file_group
= g_new0(struct ctf_fs_ds_file_group
, 1);
592 if (!ds_file_group
) {
596 ds_file_group
->ds_file_infos
= g_ptr_array_new_with_free_func(
597 (GDestroyNotify
) ctf_fs_ds_file_info_destroy
);
598 if (!ds_file_group
->ds_file_infos
) {
602 ds_file_group
->index
= index
;
604 ds_file_group
->stream_id
= stream_instance_id
;
606 ds_file_group
->sc
= sc
;
607 ds_file_group
->ctf_fs_trace
= ctf_fs_trace
;
611 ctf_fs_ds_file_group_destroy(ds_file_group
);
612 ctf_fs_ds_index_destroy(index
);
613 ds_file_group
= NULL
;
616 return ds_file_group
;
619 /* Replace by g_ptr_array_insert when we depend on glib >= 2.40. */
621 void array_insert(GPtrArray
*array
, gpointer element
, size_t pos
)
623 size_t original_array_len
= array
->len
;
625 /* Allocate an unused element at the end of the array. */
626 g_ptr_array_add(array
, NULL
);
628 /* If we are not inserting at the end, move the elements by one. */
629 if (pos
< original_array_len
) {
630 memmove(&(array
->pdata
[pos
+ 1]),
631 &(array
->pdata
[pos
]),
632 (original_array_len
- pos
) * sizeof(gpointer
));
635 /* Insert the value. */
636 array
->pdata
[pos
] = element
;
640 * Insert ds_file_info in ds_file_group's list of ds_file_infos at the right
641 * place to keep it sorted.
645 void ds_file_group_insert_ds_file_info_sorted(
646 struct ctf_fs_ds_file_group
*ds_file_group
,
647 struct ctf_fs_ds_file_info
*ds_file_info
)
651 /* Find the spot where to insert this ds_file_info. */
652 for (i
= 0; i
< ds_file_group
->ds_file_infos
->len
; i
++) {
653 struct ctf_fs_ds_file_info
*other_ds_file_info
=
654 g_ptr_array_index(ds_file_group
->ds_file_infos
, i
);
656 if (ds_file_info
->begin_ns
< other_ds_file_info
->begin_ns
) {
661 array_insert(ds_file_group
->ds_file_infos
, ds_file_info
, i
);
665 void ds_file_group_insert_ds_index_entry_sorted(
666 struct ctf_fs_ds_file_group
*ds_file_group
,
667 struct ctf_fs_ds_index_entry
*entry
)
671 /* Find the spot where to insert this index entry. */
672 for (i
= 0; i
< ds_file_group
->index
->entries
->len
; i
++) {
673 struct ctf_fs_ds_index_entry
*other_entry
= g_ptr_array_index(
674 ds_file_group
->index
->entries
, i
);
676 if (entry
->timestamp_begin_ns
< other_entry
->timestamp_begin_ns
) {
681 array_insert(ds_file_group
->index
->entries
, entry
, i
);
685 * Create a new ds_file_info using the provided path, begin_ns and index, then
686 * add it to ds_file_group's list of ds_file_infos.
690 int ctf_fs_ds_file_group_add_ds_file_info(
691 struct ctf_fs_ds_file_group
*ds_file_group
,
692 const char *path
, int64_t begin_ns
)
694 struct ctf_fs_ds_file_info
*ds_file_info
;
697 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
);
702 ds_file_group_insert_ds_file_info_sorted(ds_file_group
, ds_file_info
);
708 ctf_fs_ds_file_info_destroy(ds_file_info
);
715 int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
,
718 int64_t stream_instance_id
= -1;
719 int64_t begin_ns
= -1;
720 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
721 bool add_group
= false;
724 struct ctf_fs_ds_file
*ds_file
= NULL
;
725 struct ctf_fs_ds_index
*index
= NULL
;
726 struct bt_msg_iter
*msg_iter
= NULL
;
727 struct ctf_stream_class
*sc
= NULL
;
728 struct bt_msg_iter_packet_properties props
;
729 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
731 msg_iter
= bt_msg_iter_create(ctf_fs_trace
->metadata
->tc
,
732 bt_common_get_page_size(log_level
) * 8,
733 ctf_fs_ds_file_medops
, NULL
, log_level
, NULL
);
735 BT_LOGE_STR("Cannot create a CTF message iterator.");
739 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, msg_iter
,
740 NULL
, path
, log_level
);
745 ret
= bt_msg_iter_get_packet_properties(ds_file
->msg_iter
, &props
);
747 BT_LOGE("Cannot get stream file's first packet's header and context fields (`%s`).",
752 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
,
753 props
.stream_class_id
);
755 stream_instance_id
= props
.data_stream_id
;
757 if (props
.snapshots
.beginning_clock
!= UINT64_C(-1)) {
758 BT_ASSERT(sc
->default_clock_class
);
759 ret
= bt_util_clock_cycles_to_ns_from_origin(
760 props
.snapshots
.beginning_clock
,
761 sc
->default_clock_class
->frequency
,
762 sc
->default_clock_class
->offset_seconds
,
763 sc
->default_clock_class
->offset_cycles
, &begin_ns
);
765 BT_LOGE("Cannot convert clock cycles to nanoseconds from origin (`%s`).",
771 index
= ctf_fs_ds_file_build_index(ds_file
);
773 BT_LOGW("Failed to index CTF stream file \'%s\'",
774 ds_file
->file
->path
->str
);
777 if (begin_ns
== -1) {
779 * No beggining timestamp to sort the stream files
780 * within a stream file group, so consider that this
781 * file must be the only one within its group.
783 stream_instance_id
= -1;
786 if (stream_instance_id
== -1) {
788 * No stream instance ID or no beginning timestamp:
789 * create a unique stream file group for this stream
790 * file because, even if there's a stream instance ID,
791 * there's no timestamp to order the file within its
794 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
,
795 sc
, UINT64_C(-1), index
);
796 /* Ownership of index is transferred. */
799 if (!ds_file_group
) {
803 ret
= ctf_fs_ds_file_group_add_ds_file_info(ds_file_group
,
813 BT_ASSERT(stream_instance_id
!= -1);
814 BT_ASSERT(begin_ns
!= -1);
816 /* Find an existing stream file group with this ID */
817 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
818 ds_file_group
= g_ptr_array_index(
819 ctf_fs_trace
->ds_file_groups
, i
);
821 if (ds_file_group
->sc
== sc
&&
822 ds_file_group
->stream_id
==
823 stream_instance_id
) {
827 ds_file_group
= NULL
;
830 if (!ds_file_group
) {
831 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
,
832 sc
, stream_instance_id
, index
);
833 /* Ownership of index is transferred. */
835 if (!ds_file_group
) {
842 ret
= ctf_fs_ds_file_group_add_ds_file_info(ds_file_group
, path
,
851 ctf_fs_ds_file_group_destroy(ds_file_group
);
852 ds_file_group
= NULL
;
856 if (add_group
&& ds_file_group
) {
857 g_ptr_array_add(ctf_fs_trace
->ds_file_groups
, ds_file_group
);
860 ctf_fs_ds_file_destroy(ds_file
);
863 bt_msg_iter_destroy(msg_iter
);
866 ctf_fs_ds_index_destroy(index
);
871 int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
874 const char *basename
;
875 GError
*error
= NULL
;
877 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
879 /* Check each file in the path directory, except specific ones */
880 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
882 BT_LOGE("Cannot open directory `%s`: %s (code %d)",
883 ctf_fs_trace
->path
->str
, error
->message
,
888 while ((basename
= g_dir_read_name(dir
))) {
889 struct ctf_fs_file
*file
;
891 if (!strcmp(basename
, CTF_FS_METADATA_FILENAME
)) {
892 /* Ignore the metadata stream. */
893 BT_LOGI("Ignoring metadata file `%s" G_DIR_SEPARATOR_S
"%s`",
894 ctf_fs_trace
->path
->str
, basename
);
898 if (basename
[0] == '.') {
899 BT_LOGI("Ignoring hidden file `%s" G_DIR_SEPARATOR_S
"%s`",
900 ctf_fs_trace
->path
->str
, basename
);
904 /* Create the file. */
905 file
= ctf_fs_file_create(log_level
);
907 BT_LOGE("Cannot create stream file object for file `%s" G_DIR_SEPARATOR_S
"%s`",
908 ctf_fs_trace
->path
->str
, basename
);
912 /* Create full path string. */
913 g_string_append_printf(file
->path
, "%s" G_DIR_SEPARATOR_S
"%s",
914 ctf_fs_trace
->path
->str
, basename
);
915 if (!g_file_test(file
->path
->str
, G_FILE_TEST_IS_REGULAR
)) {
916 BT_LOGI("Ignoring non-regular file `%s`",
918 ctf_fs_file_destroy(file
);
923 ret
= ctf_fs_file_open(file
, "rb");
925 BT_LOGE("Cannot open stream file `%s`", file
->path
->str
);
929 if (file
->size
== 0) {
930 /* Skip empty stream. */
931 BT_LOGI("Ignoring empty file `%s`", file
->path
->str
);
932 ctf_fs_file_destroy(file
);
936 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
,
939 BT_LOGE("Cannot add stream file `%s` to stream file group",
941 ctf_fs_file_destroy(file
);
945 ctf_fs_file_destroy(file
);
967 int set_trace_name(bt_trace
*trace
, const char *name_suffix
,
968 bt_logging_level log_level
)
971 const bt_trace_class
*tc
= bt_trace_borrow_class_const(trace
);
975 name
= g_string_new(NULL
);
977 BT_LOGE_STR("Failed to allocate a GString.");
983 * Check if we have a trace environment string value named `hostname`.
984 * If so, use it as the trace name's prefix.
986 val
= bt_trace_class_borrow_environment_entry_value_by_name_const(
988 if (val
&& bt_value_is_string(val
)) {
989 g_string_append(name
, bt_value_string_get(val
));
992 g_string_append_c(name
, G_DIR_SEPARATOR
);
997 g_string_append(name
, name_suffix
);
1000 ret
= bt_trace_set_name(trace
, name
->str
);
1009 g_string_free(name
, TRUE
);
1016 struct ctf_fs_trace
*ctf_fs_trace_create(bt_self_component_source
*self_comp
,
1017 const char *path
, const char *name
,
1018 struct ctf_fs_metadata_config
*metadata_config
,
1019 bt_logging_level log_level
)
1021 struct ctf_fs_trace
*ctf_fs_trace
;
1024 ctf_fs_trace
= g_new0(struct ctf_fs_trace
, 1);
1025 if (!ctf_fs_trace
) {
1029 ctf_fs_trace
->log_level
= log_level
;
1030 ctf_fs_trace
->path
= g_string_new(path
);
1031 if (!ctf_fs_trace
->path
) {
1035 ctf_fs_trace
->name
= g_string_new(name
);
1036 if (!ctf_fs_trace
->name
) {
1040 ctf_fs_trace
->metadata
= g_new0(struct ctf_fs_metadata
, 1);
1041 if (!ctf_fs_trace
->metadata
) {
1045 ctf_fs_metadata_init(ctf_fs_trace
->metadata
);
1046 ctf_fs_trace
->ds_file_groups
= g_ptr_array_new_with_free_func(
1047 (GDestroyNotify
) ctf_fs_ds_file_group_destroy
);
1048 if (!ctf_fs_trace
->ds_file_groups
) {
1052 ret
= ctf_fs_metadata_set_trace_class(self_comp
,
1053 ctf_fs_trace
, metadata_config
);
1058 if (ctf_fs_trace
->metadata
->trace_class
) {
1059 ctf_fs_trace
->trace
=
1060 bt_trace_create(ctf_fs_trace
->metadata
->trace_class
);
1061 if (!ctf_fs_trace
->trace
) {
1066 if (ctf_fs_trace
->trace
) {
1067 ret
= set_trace_name(ctf_fs_trace
->trace
, name
, log_level
);
1073 ret
= create_ds_file_groups(ctf_fs_trace
);
1081 ctf_fs_trace_destroy(ctf_fs_trace
);
1082 ctf_fs_trace
= NULL
;
1085 return ctf_fs_trace
;
1089 int path_is_ctf_trace(const char *path
)
1091 GString
*metadata_path
= g_string_new(NULL
);
1094 if (!metadata_path
) {
1099 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
1101 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
1107 g_string_free(metadata_path
, TRUE
);
1112 int add_trace_path(GList
**trace_paths
, const char *path
,
1113 bt_logging_level log_level
)
1115 GString
*norm_path
= NULL
;
1118 norm_path
= bt_common_normalize_path(path
, NULL
);
1120 BT_LOGE("Failed to normalize path `%s`.", path
);
1125 // FIXME: Remove or ifdef for __MINGW32__
1126 if (strcmp(norm_path
->str
, "/") == 0) {
1127 BT_LOGE("Opening a trace in `/` is not supported.");
1132 *trace_paths
= g_list_prepend(*trace_paths
, norm_path
);
1133 BT_ASSERT(*trace_paths
);
1138 g_string_free(norm_path
, TRUE
);
1145 int ctf_fs_find_traces(GList
**trace_paths
, const char *start_path
,
1146 bt_logging_level log_level
)
1149 GError
*error
= NULL
;
1151 const char *basename
= NULL
;
1153 /* Check if the starting path is a CTF trace itself */
1154 ret
= path_is_ctf_trace(start_path
);
1161 * Stop recursion: a CTF trace cannot contain another
1164 ret
= add_trace_path(trace_paths
, start_path
, log_level
);
1168 /* Look for subdirectories */
1169 if (!g_file_test(start_path
, G_FILE_TEST_IS_DIR
)) {
1170 /* Starting path is not a directory: end of recursion */
1174 dir
= g_dir_open(start_path
, 0, &error
);
1176 if (error
->code
== G_FILE_ERROR_ACCES
) {
1177 BT_LOGI("Cannot open directory `%s`: %s (code %d): continuing",
1178 start_path
, error
->message
, error
->code
);
1182 BT_LOGE("Cannot open directory `%s`: %s (code %d)",
1183 start_path
, error
->message
, error
->code
);
1188 while ((basename
= g_dir_read_name(dir
))) {
1189 GString
*sub_path
= g_string_new(NULL
);
1196 g_string_printf(sub_path
, "%s" G_DIR_SEPARATOR_S
"%s", start_path
, basename
);
1197 ret
= ctf_fs_find_traces(trace_paths
, sub_path
->str
,
1199 g_string_free(sub_path
, TRUE
);
1211 g_error_free(error
);
1218 GList
*ctf_fs_create_trace_names(GList
*trace_paths
, const char *base_path
) {
1219 GList
*trace_names
= NULL
;
1221 const char *last_sep
;
1225 * At this point we know that all the trace paths are
1226 * normalized, and so is the base path. This means that
1227 * they are absolute and they don't end with a separator.
1228 * We can simply find the location of the last separator
1229 * in the base path, which gives us the name of the actual
1230 * directory to look into, and use this location as the
1231 * start of each trace name within each trace path.
1235 * Base path: /home/user/my-traces/some-trace
1237 * - /home/user/my-traces/some-trace/host1/trace1
1238 * - /home/user/my-traces/some-trace/host1/trace2
1239 * - /home/user/my-traces/some-trace/host2/trace
1240 * - /home/user/my-traces/some-trace/other-trace
1242 * In this case the trace names are:
1244 * - some-trace/host1/trace1
1245 * - some-trace/host1/trace2
1246 * - some-trace/host2/trace
1247 * - some-trace/other-trace
1249 last_sep
= strrchr(base_path
, G_DIR_SEPARATOR
);
1251 /* We know there's at least one separator */
1252 BT_ASSERT(last_sep
);
1254 /* Distance to base */
1255 base_dist
= last_sep
- base_path
+ 1;
1257 /* Create the trace names */
1258 for (node
= trace_paths
; node
; node
= g_list_next(node
)) {
1259 GString
*trace_name
= g_string_new(NULL
);
1260 GString
*trace_path
= node
->data
;
1262 BT_ASSERT(trace_name
);
1263 g_string_assign(trace_name
, &trace_path
->str
[base_dist
]);
1264 trace_names
= g_list_append(trace_names
, trace_name
);
1270 /* Helper for ctf_fs_component_create_ctf_fs_traces, to handle a single path/root. */
1273 int ctf_fs_component_create_ctf_fs_traces_one_root(bt_self_component_source
*self_comp
,
1274 struct ctf_fs_component
*ctf_fs
,
1275 const char *path_param
)
1277 struct ctf_fs_trace
*ctf_fs_trace
= NULL
;
1279 GString
*norm_path
= NULL
;
1280 GList
*trace_paths
= NULL
;
1281 GList
*trace_names
= NULL
;
1284 bt_logging_level log_level
= ctf_fs
->log_level
;
1286 norm_path
= bt_common_normalize_path(path_param
, NULL
);
1288 BT_LOGE("Failed to normalize path: `%s`.",
1293 ret
= ctf_fs_find_traces(&trace_paths
, norm_path
->str
, log_level
);
1299 BT_LOGE("No CTF traces recursively found in `%s`.",
1304 trace_names
= ctf_fs_create_trace_names(trace_paths
, norm_path
->str
);
1306 BT_LOGE("Cannot create trace names from trace paths.");
1310 for (tp_node
= trace_paths
, tn_node
= trace_names
; tp_node
;
1311 tp_node
= g_list_next(tp_node
),
1312 tn_node
= g_list_next(tn_node
)) {
1313 GString
*trace_path
= tp_node
->data
;
1314 GString
*trace_name
= tn_node
->data
;
1316 ctf_fs_trace
= ctf_fs_trace_create(self_comp
,
1317 trace_path
->str
, trace_name
->str
,
1318 &ctf_fs
->metadata_config
,
1320 if (!ctf_fs_trace
) {
1321 BT_LOGE("Cannot create trace for `%s`.",
1326 g_ptr_array_add(ctf_fs
->traces
, ctf_fs_trace
);
1327 ctf_fs_trace
= NULL
;
1334 ctf_fs_trace_destroy(ctf_fs_trace
);
1337 for (tp_node
= trace_paths
; tp_node
; tp_node
= g_list_next(tp_node
)) {
1338 if (tp_node
->data
) {
1339 g_string_free(tp_node
->data
, TRUE
);
1343 for (tn_node
= trace_names
; tn_node
; tn_node
= g_list_next(tn_node
)) {
1344 if (tn_node
->data
) {
1345 g_string_free(tn_node
->data
, TRUE
);
1350 g_list_free(trace_paths
);
1354 g_list_free(trace_names
);
1358 g_string_free(norm_path
, TRUE
);
1364 /* GCompareFunc to sort traces by UUID. */
1367 gint
sort_traces_by_uuid(gconstpointer a
, gconstpointer b
)
1369 const struct ctf_fs_trace
*trace_a
= *((const struct ctf_fs_trace
**) a
);
1370 const struct ctf_fs_trace
*trace_b
= *((const struct ctf_fs_trace
**) b
);
1372 bool trace_a_has_uuid
= trace_a
->metadata
->tc
->is_uuid_set
;
1373 bool trace_b_has_uuid
= trace_b
->metadata
->tc
->is_uuid_set
;
1376 /* Order traces without uuid first. */
1377 if (!trace_a_has_uuid
&& trace_b_has_uuid
) {
1379 } else if (trace_a_has_uuid
&& !trace_b_has_uuid
) {
1381 } else if (!trace_a_has_uuid
&& !trace_b_has_uuid
) {
1384 ret
= bt_uuid_compare(trace_a
->metadata
->tc
->uuid
, trace_b
->metadata
->tc
->uuid
);
1391 * Count the number of stream and event classes defined by this trace's metadata.
1393 * This is used to determine which metadata is the "latest", out of multiple
1394 * traces sharing the same UUID. It is assumed that amongst all these metadatas,
1395 * a bigger metadata is a superset of a smaller metadata. Therefore, it is
1396 * enough to just count the classes.
1400 unsigned int metadata_count_stream_and_event_classes(struct ctf_fs_trace
*trace
)
1402 unsigned int num
= trace
->metadata
->tc
->stream_classes
->len
;
1405 for (i
= 0; i
< trace
->metadata
->tc
->stream_classes
->len
; i
++) {
1406 struct ctf_stream_class
*sc
= trace
->metadata
->tc
->stream_classes
->pdata
[i
];
1407 num
+= sc
->event_classes
->len
;
1414 * Merge the src ds_file_group into dest. This consists of merging their
1415 * ds_file_infos, making sure to keep the result sorted.
1419 void merge_ctf_fs_ds_file_groups(struct ctf_fs_ds_file_group
*dest
, struct ctf_fs_ds_file_group
*src
)
1423 for (i
= 0; i
< src
->ds_file_infos
->len
; i
++) {
1424 struct ctf_fs_ds_file_info
*ds_file_info
=
1425 g_ptr_array_index(src
->ds_file_infos
, i
);
1427 /* Ownership of the ds_file_info is transferred to dest. */
1428 g_ptr_array_index(src
->ds_file_infos
, i
) = NULL
;
1430 ds_file_group_insert_ds_file_info_sorted(dest
, ds_file_info
);
1433 /* Merge both indexes. */
1434 for (i
= 0; i
< src
->index
->entries
->len
; i
++) {
1435 struct ctf_fs_ds_index_entry
*entry
= g_ptr_array_index(
1436 src
->index
->entries
, i
);
1439 * Ownership of the ctf_fs_ds_index_entry is transferred to
1442 g_ptr_array_index(src
->index
->entries
, i
) = NULL
;
1444 ds_file_group_insert_ds_index_entry_sorted(dest
, entry
);
1447 /* Merge src_trace's data stream file groups into dest_trace's. */
1450 int merge_matching_ctf_fs_ds_file_groups(
1451 struct ctf_fs_trace
*dest_trace
,
1452 struct ctf_fs_trace
*src_trace
)
1455 GPtrArray
*dest
= dest_trace
->ds_file_groups
;
1456 GPtrArray
*src
= src_trace
->ds_file_groups
;
1461 * Save the initial length of dest: we only want to check against the
1462 * original elements in the inner loop.
1464 const guint dest_len
= dest
->len
;
1466 for (s_i
= 0; s_i
< src
->len
; s_i
++) {
1467 struct ctf_fs_ds_file_group
*src_group
= g_ptr_array_index(src
, s_i
);
1468 struct ctf_fs_ds_file_group
*dest_group
= NULL
;
1470 /* A stream instance without ID can't match a stream in the other trace. */
1471 if (src_group
->stream_id
!= -1) {
1474 /* Let's search for a matching ds_file_group in the destination. */
1475 for (d_i
= 0; d_i
< dest_len
; d_i
++) {
1476 struct ctf_fs_ds_file_group
*candidate_dest
= g_ptr_array_index(dest
, d_i
);
1478 /* Can't match a stream instance without ID. */
1479 if (candidate_dest
->stream_id
== -1) {
1484 * If the two groups have the same stream instance id
1485 * and belong to the same stream class (stream instance
1486 * ids are per-stream class), they represent the same
1489 if (candidate_dest
->stream_id
!= src_group
->stream_id
||
1490 candidate_dest
->sc
->id
!= src_group
->sc
->id
) {
1494 dest_group
= candidate_dest
;
1500 * Didn't find a friend in dest to merge our src_group into?
1501 * Create a new empty one. This can happen if a stream was
1502 * active in the source trace chunk but not in the destination
1506 struct ctf_stream_class
*sc
;
1507 struct ctf_fs_ds_index
*index
;
1509 sc
= ctf_trace_class_borrow_stream_class_by_id(
1510 dest_trace
->metadata
->tc
, src_group
->sc
->id
);
1513 index
= ctf_fs_ds_index_create(dest_trace
->log_level
);
1519 dest_group
= ctf_fs_ds_file_group_create(dest_trace
, sc
,
1520 src_group
->stream_id
, index
);
1521 /* Ownership of index is transferred. */
1528 g_ptr_array_add(dest_trace
->ds_file_groups
, dest_group
);
1531 BT_ASSERT(dest_group
);
1532 merge_ctf_fs_ds_file_groups(dest_group
, src_group
);
1540 * Collapse the given traces, which must all share the same UUID, in a single
1543 * The trace with the most expansive metadata is chosen and all other traces
1544 * are merged into that one. The array slots of all the traces that get merged
1545 * in the chosen one are set to NULL, so only the slot of the chosen trace
1550 int merge_ctf_fs_traces(struct ctf_fs_trace
**traces
, unsigned int num_traces
)
1552 unsigned int winner_count
;
1553 struct ctf_fs_trace
*winner
;
1556 char uuid_str
[BABELTRACE_UUID_STR_LEN
];
1558 BT_ASSERT(num_traces
>= 2);
1560 winner_count
= metadata_count_stream_and_event_classes(traces
[0]);
1563 /* Find the trace with the largest metadata. */
1564 for (i
= 1; i
< num_traces
; i
++) {
1565 struct ctf_fs_trace
*candidate
;
1566 unsigned int candidate_count
;
1568 candidate
= traces
[i
];
1570 /* A bit of sanity check. */
1571 BT_ASSERT(bt_uuid_compare(winner
->metadata
->tc
->uuid
, candidate
->metadata
->tc
->uuid
) == 0);
1573 candidate_count
= metadata_count_stream_and_event_classes(candidate
);
1575 if (candidate_count
> winner_count
) {
1576 winner_count
= candidate_count
;
1581 /* Merge all the other traces in the winning trace. */
1582 for (i
= 0; i
< num_traces
; i
++) {
1583 struct ctf_fs_trace
*trace
= traces
[i
];
1585 /* Don't merge the winner into itself. */
1586 if (trace
== winner
) {
1590 /* Merge trace's data stream file groups into winner's. */
1591 ret
= merge_matching_ctf_fs_ds_file_groups(winner
, trace
);
1596 /* Free the trace that got merged into winner, clear the slot in the array. */
1597 ctf_fs_trace_destroy(trace
);
1601 /* Use the string representation of the UUID as the trace name. */
1602 bt_uuid_unparse(winner
->metadata
->tc
->uuid
, uuid_str
);
1603 g_string_printf(winner
->name
, "%s", uuid_str
);
1610 * Merge all traces of `ctf_fs` that share the same UUID in a single trace.
1611 * Traces with no UUID are not merged.
1615 int merge_traces_with_same_uuid(struct ctf_fs_component
*ctf_fs
)
1617 GPtrArray
*traces
= ctf_fs
->traces
;
1618 guint range_start_idx
= 0;
1619 unsigned int num_traces
= 0;
1623 /* Sort the traces by uuid, then collapse traces with the same uuid in a single one. */
1624 g_ptr_array_sort(traces
, sort_traces_by_uuid
);
1626 /* Find ranges of consecutive traces that share the same UUID. */
1627 while (range_start_idx
< traces
->len
) {
1629 struct ctf_fs_trace
*range_start_trace
= g_ptr_array_index(traces
, range_start_idx
);
1631 /* Exclusive end of range. */
1632 guint range_end_exc_idx
= range_start_idx
+ 1;
1634 while (range_end_exc_idx
< traces
->len
) {
1635 struct ctf_fs_trace
*this_trace
= g_ptr_array_index(traces
, range_end_exc_idx
);
1637 if (!range_start_trace
->metadata
->tc
->is_uuid_set
||
1638 (bt_uuid_compare(range_start_trace
->metadata
->tc
->uuid
, this_trace
->metadata
->tc
->uuid
) != 0)) {
1642 range_end_exc_idx
++;
1645 /* If we have two or more traces with matching UUIDs, merge them. */
1646 range_len
= range_end_exc_idx
- range_start_idx
;
1647 if (range_len
> 1) {
1648 struct ctf_fs_trace
**range_start
= (struct ctf_fs_trace
**) &traces
->pdata
[range_start_idx
];
1649 ret
= merge_ctf_fs_traces(range_start
, range_len
);
1656 range_start_idx
= range_end_exc_idx
;
1659 /* Clear any NULL slot (traces that got merged in another one) in the array. */
1660 for (i
= 0; i
< traces
->len
;) {
1661 if (g_ptr_array_index(traces
, i
) == NULL
) {
1662 g_ptr_array_remove_index_fast(traces
, i
);
1668 BT_ASSERT(num_traces
== traces
->len
);
1674 int ctf_fs_component_create_ctf_fs_traces(bt_self_component_source
*self_comp
,
1675 struct ctf_fs_component
*ctf_fs
,
1676 const bt_value
*paths_value
)
1681 for (i
= 0; i
< bt_value_array_get_size(paths_value
); i
++) {
1682 const bt_value
*path_value
= bt_value_array_borrow_element_by_index_const(paths_value
, i
);
1683 const char *path
= bt_value_string_get(path_value
);
1685 ret
= ctf_fs_component_create_ctf_fs_traces_one_root(self_comp
, ctf_fs
, path
);
1691 ret
= merge_traces_with_same_uuid(ctf_fs
);
1698 GString
*get_stream_instance_unique_name(
1699 struct ctf_fs_ds_file_group
*ds_file_group
)
1702 struct ctf_fs_ds_file_info
*ds_file_info
;
1704 name
= g_string_new(NULL
);
1710 * If there's more than one stream file in the stream file
1711 * group, the first (earliest) stream file's path is used as
1712 * the stream's unique name.
1714 BT_ASSERT(ds_file_group
->ds_file_infos
->len
> 0);
1715 ds_file_info
= g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
1716 g_string_assign(name
, ds_file_info
->path
->str
);
1722 /* Create the IR stream objects for ctf_fs_trace. */
1725 int create_streams_for_trace(struct ctf_fs_trace
*ctf_fs_trace
)
1728 GString
*name
= NULL
;
1730 bt_logging_level log_level
= ctf_fs_trace
->log_level
;
1732 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
1733 struct ctf_fs_ds_file_group
*ds_file_group
=
1734 g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
1735 name
= get_stream_instance_unique_name(ds_file_group
);
1741 if (ds_file_group
->sc
->ir_sc
) {
1742 BT_ASSERT(ctf_fs_trace
->trace
);
1744 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
1745 /* No stream ID: use 0 */
1746 ds_file_group
->stream
= bt_stream_create_with_id(
1747 ds_file_group
->sc
->ir_sc
,
1748 ctf_fs_trace
->trace
,
1749 ctf_fs_trace
->next_stream_id
);
1750 ctf_fs_trace
->next_stream_id
++;
1752 /* Specific stream ID */
1753 ds_file_group
->stream
= bt_stream_create_with_id(
1754 ds_file_group
->sc
->ir_sc
,
1755 ctf_fs_trace
->trace
,
1756 (uint64_t) ds_file_group
->stream_id
);
1759 ds_file_group
->stream
= NULL
;
1762 if (!ds_file_group
->stream
) {
1763 BT_LOGE("Cannot create stream for DS file group: "
1764 "addr=%p, stream-name=\"%s\"",
1765 ds_file_group
, name
->str
);
1769 ret
= bt_stream_set_name(ds_file_group
->stream
,
1772 BT_LOGE("Cannot set stream's name: "
1773 "addr=%p, stream-name=\"%s\"",
1774 ds_file_group
->stream
, name
->str
);
1778 g_string_free(name
, TRUE
);
1791 g_string_free(name
, TRUE
);
1797 * Validate the "paths" parameter passed to this component. It must be
1798 * present, and it must be an array of strings.
1802 bool validate_paths_parameter(struct ctf_fs_component
*ctf_fs
,
1803 const bt_value
*paths
)
1808 bt_logging_level log_level
= ctf_fs
->log_level
;
1811 BT_LOGE("missing \"paths\" parameter");
1815 type
= bt_value_get_type(paths
);
1816 if (type
!= BT_VALUE_TYPE_ARRAY
) {
1817 BT_LOGE("`paths` parameter: expecting array value: type=%s",
1818 bt_common_value_type_string(type
));
1822 for (i
= 0; i
< bt_value_array_get_size(paths
); i
++) {
1823 const bt_value
*elem
;
1825 elem
= bt_value_array_borrow_element_by_index_const(paths
, i
);
1826 type
= bt_value_get_type(elem
);
1827 if (type
!= BT_VALUE_TYPE_STRING
) {
1828 BT_LOGE("`paths` parameter: expecting string value: index=%" PRIu64
", type=%s",
1829 i
, bt_common_value_type_string(type
));
1844 bool read_src_fs_parameters(const bt_value
*params
,
1845 const bt_value
**paths
, struct ctf_fs_component
*ctf_fs
) {
1847 const bt_value
*value
;
1848 bt_logging_level log_level
= ctf_fs
->log_level
;
1850 /* paths parameter */
1851 *paths
= bt_value_map_borrow_entry_value_const(params
, "paths");
1852 if (!validate_paths_parameter(ctf_fs
, *paths
)) {
1856 /* clock-class-offset-s parameter */
1857 value
= bt_value_map_borrow_entry_value_const(params
,
1858 "clock-class-offset-s");
1860 if (!bt_value_is_signed_integer(value
)) {
1861 BT_LOGE("clock-class-offset-s must be an integer");
1864 ctf_fs
->metadata_config
.clock_class_offset_s
=
1865 bt_value_signed_integer_get(value
);
1868 /* clock-class-offset-ns parameter */
1869 value
= bt_value_map_borrow_entry_value_const(params
,
1870 "clock-class-offset-ns");
1872 if (!bt_value_is_signed_integer(value
)) {
1873 BT_LOGE("clock-class-offset-ns must be an integer");
1876 ctf_fs
->metadata_config
.clock_class_offset_ns
=
1877 bt_value_signed_integer_get(value
);
1892 struct ctf_fs_component
*ctf_fs_create(
1893 bt_self_component_source
*self_comp_src
,
1894 const bt_value
*params
)
1896 struct ctf_fs_component
*ctf_fs
= NULL
;
1898 const bt_value
*paths_value
;
1899 bt_self_component
*self_comp
=
1900 bt_self_component_source_as_self_component(self_comp_src
);
1902 ctf_fs
= ctf_fs_component_create(bt_component_get_logging_level(
1903 bt_self_component_as_component(self_comp
)));
1908 if (!read_src_fs_parameters(params
, &paths_value
, ctf_fs
)) {
1912 bt_self_component_set_data(self_comp
, ctf_fs
);
1915 * We don't need to get a new reference here because as long as
1916 * our private ctf_fs_component object exists, the containing
1917 * private component should also exist.
1919 ctf_fs
->self_comp
= self_comp_src
;
1921 if (ctf_fs_component_create_ctf_fs_traces(self_comp_src
, ctf_fs
, paths_value
)) {
1925 for (i
= 0; i
< ctf_fs
->traces
->len
; i
++) {
1926 struct ctf_fs_trace
*trace
= g_ptr_array_index(ctf_fs
->traces
, i
);
1928 if (create_streams_for_trace(trace
)) {
1932 if (create_ports_for_trace(ctf_fs
, trace
)) {
1940 ctf_fs_destroy(ctf_fs
);
1942 bt_self_component_set_data(self_comp
, NULL
);
1949 bt_self_component_status
ctf_fs_init(
1950 bt_self_component_source
*self_comp
,
1951 const bt_value
*params
, __attribute__((unused
)) void *init_method_data
)
1953 struct ctf_fs_component
*ctf_fs
;
1954 bt_self_component_status ret
= BT_SELF_COMPONENT_STATUS_OK
;
1956 ctf_fs
= ctf_fs_create(self_comp
, params
);
1958 ret
= BT_SELF_COMPONENT_STATUS_ERROR
;
1965 bt_query_status
ctf_fs_query(
1966 bt_self_component_class_source
*comp_class
,
1967 const bt_query_executor
*query_exec
,
1968 const char *object
, const bt_value
*params
,
1969 bt_logging_level log_level
,
1970 const bt_value
**result
)
1972 bt_query_status status
= BT_QUERY_STATUS_OK
;
1974 if (!strcmp(object
, "metadata-info")) {
1975 status
= metadata_info_query(comp_class
, params
, log_level
,
1977 } else if (!strcmp(object
, "trace-info")) {
1978 status
= trace_info_query(comp_class
, params
, log_level
,
1981 BT_LOGE("Unknown query object `%s`", object
);
1982 status
= BT_QUERY_STATUS_INVALID_OBJECT
;