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 #include <babeltrace/common-internal.h>
29 #include <babeltrace/babeltrace.h>
30 #include <plugins-common.h>
32 #include <babeltrace/assert-internal.h>
37 #include "data-stream-file.h"
39 #include "../common/metadata/decoder.h"
40 #include "../common/msg-iter/msg-iter.h"
41 #include "../common/utils/utils.h"
44 #define BT_LOG_TAG "PLUGIN-CTF-FS-SRC"
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 if (!msg_iter_data
->ds_file
) {
74 void ctf_fs_msg_iter_data_destroy(
75 struct ctf_fs_msg_iter_data
*msg_iter_data
)
81 ctf_fs_ds_file_destroy(msg_iter_data
->ds_file
);
83 if (msg_iter_data
->msg_iter
) {
84 bt_msg_iter_destroy(msg_iter_data
->msg_iter
);
87 g_free(msg_iter_data
);
91 void set_msg_iter_emits_stream_beginning_end_messages(
92 struct ctf_fs_msg_iter_data
*msg_iter_data
)
94 bt_msg_iter_set_emit_stream_beginning_message(
95 msg_iter_data
->ds_file
->msg_iter
,
96 msg_iter_data
->ds_file_info_index
== 0);
97 bt_msg_iter_set_emit_stream_end_message(
98 msg_iter_data
->ds_file
->msg_iter
,
99 msg_iter_data
->ds_file_info_index
==
100 msg_iter_data
->ds_file_group
->ds_file_infos
->len
- 1);
104 bt_self_message_iterator_status
ctf_fs_iterator_next_one(
105 struct ctf_fs_msg_iter_data
*msg_iter_data
,
106 const bt_message
**out_msg
)
108 bt_self_message_iterator_status status
;
110 BT_ASSERT(msg_iter_data
->ds_file
);
115 status
= ctf_fs_ds_file_next(msg_iter_data
->ds_file
, &msg
);
117 case BT_SELF_MESSAGE_ITERATOR_STATUS_OK
:
121 case BT_SELF_MESSAGE_ITERATOR_STATUS_END
:
125 if (msg_iter_data
->ds_file_info_index
==
126 msg_iter_data
->ds_file_group
->ds_file_infos
->len
- 1) {
127 /* End of all group's stream files */
131 msg_iter_data
->ds_file_info_index
++;
132 bt_msg_iter_reset_for_next_stream_file(
133 msg_iter_data
->msg_iter
);
134 set_msg_iter_emits_stream_beginning_end_messages(
138 * Open and start reading the next stream file
139 * within our stream file group.
141 ret
= msg_iter_data_set_current_ds_file(msg_iter_data
);
143 status
= BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR
;
147 /* Continue the loop to get the next message */
160 bt_self_message_iterator_status
ctf_fs_iterator_next(
161 bt_self_message_iterator
*iterator
,
162 bt_message_array_const msgs
, uint64_t capacity
,
165 bt_self_message_iterator_status status
=
166 BT_SELF_MESSAGE_ITERATOR_STATUS_OK
;
167 struct ctf_fs_msg_iter_data
*msg_iter_data
=
168 bt_self_message_iterator_get_data(iterator
);
171 while (i
< capacity
&& status
== BT_SELF_MESSAGE_ITERATOR_STATUS_OK
) {
172 status
= ctf_fs_iterator_next_one(msg_iter_data
, &msgs
[i
]);
173 if (status
== BT_SELF_MESSAGE_ITERATOR_STATUS_OK
) {
180 * Even if ctf_fs_iterator_next_one() returned something
181 * else than BT_SELF_MESSAGE_ITERATOR_STATUS_OK, we
182 * accumulated message objects in the output
183 * message array, so we need to return
184 * BT_SELF_MESSAGE_ITERATOR_STATUS_OK so that they are
185 * transfered to downstream. This other status occurs
186 * again the next time muxer_msg_iter_do_next() is
187 * called, possibly without any accumulated
188 * message, in which case we'll return it.
191 status
= BT_SELF_MESSAGE_ITERATOR_STATUS_OK
;
198 int ctf_fs_iterator_reset(struct ctf_fs_msg_iter_data
*msg_iter_data
)
202 msg_iter_data
->ds_file_info_index
= 0;
203 ret
= msg_iter_data_set_current_ds_file(msg_iter_data
);
208 bt_msg_iter_reset(msg_iter_data
->msg_iter
);
209 set_msg_iter_emits_stream_beginning_end_messages(msg_iter_data
);
216 bt_self_message_iterator_status
ctf_fs_iterator_seek_beginning(
217 bt_self_message_iterator
*it
)
219 struct ctf_fs_msg_iter_data
*msg_iter_data
=
220 bt_self_message_iterator_get_data(it
);
221 bt_self_message_iterator_status status
=
222 BT_SELF_MESSAGE_ITERATOR_STATUS_OK
;
224 BT_ASSERT(msg_iter_data
);
225 if (ctf_fs_iterator_reset(msg_iter_data
)) {
226 status
= BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR
;
233 void ctf_fs_iterator_finalize(bt_self_message_iterator
*it
)
235 ctf_fs_msg_iter_data_destroy(
236 bt_self_message_iterator_get_data(it
));
240 bt_self_message_iterator_status
ctf_fs_iterator_init(
241 bt_self_message_iterator
*self_msg_iter
,
242 bt_self_component_source
*self_comp
,
243 bt_self_component_port_output
*self_port
)
245 struct ctf_fs_port_data
*port_data
;
246 struct ctf_fs_msg_iter_data
*msg_iter_data
= NULL
;
247 bt_self_message_iterator_status ret
=
248 BT_SELF_MESSAGE_ITERATOR_STATUS_OK
;
250 port_data
= bt_self_component_port_get_data(
251 bt_self_component_port_output_as_self_component_port(
253 BT_ASSERT(port_data
);
254 msg_iter_data
= g_new0(struct ctf_fs_msg_iter_data
, 1);
255 if (!msg_iter_data
) {
256 ret
= BT_SELF_MESSAGE_ITERATOR_STATUS_NOMEM
;
260 msg_iter_data
->pc_msg_iter
= self_msg_iter
;
261 msg_iter_data
->msg_iter
= bt_msg_iter_create(
262 port_data
->ds_file_group
->ctf_fs_trace
->metadata
->tc
,
263 bt_common_get_page_size() * 8,
264 ctf_fs_ds_file_medops
, NULL
);
265 if (!msg_iter_data
->msg_iter
) {
266 BT_LOGE_STR("Cannot create a CTF message iterator.");
267 ret
= BT_SELF_MESSAGE_ITERATOR_STATUS_NOMEM
;
271 msg_iter_data
->ds_file_group
= port_data
->ds_file_group
;
272 if (ctf_fs_iterator_reset(msg_iter_data
)) {
273 ret
= BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR
;
277 bt_self_message_iterator_set_data(self_msg_iter
,
279 if (ret
!= BT_SELF_MESSAGE_ITERATOR_STATUS_OK
) {
283 msg_iter_data
= NULL
;
287 bt_self_message_iterator_set_data(self_msg_iter
, NULL
);
290 ctf_fs_msg_iter_data_destroy(msg_iter_data
);
295 void ctf_fs_destroy(struct ctf_fs_component
*ctf_fs
)
301 if (ctf_fs
->traces
) {
302 g_ptr_array_free(ctf_fs
->traces
, TRUE
);
305 if (ctf_fs
->port_data
) {
306 g_ptr_array_free(ctf_fs
->port_data
, TRUE
);
313 void port_data_destroy(struct ctf_fs_port_data
*port_data
)
323 void port_data_destroy_notifier(void *data
) {
324 port_data_destroy(data
);
328 void ctf_fs_trace_destroy(struct ctf_fs_trace
*ctf_fs_trace
)
334 if (ctf_fs_trace
->ds_file_groups
) {
335 g_ptr_array_free(ctf_fs_trace
->ds_file_groups
, TRUE
);
338 BT_TRACE_PUT_REF_AND_RESET(ctf_fs_trace
->trace
);
340 if (ctf_fs_trace
->path
) {
341 g_string_free(ctf_fs_trace
->path
, TRUE
);
344 if (ctf_fs_trace
->name
) {
345 g_string_free(ctf_fs_trace
->name
, TRUE
);
348 if (ctf_fs_trace
->metadata
) {
349 ctf_fs_metadata_fini(ctf_fs_trace
->metadata
);
350 g_free(ctf_fs_trace
->metadata
);
353 g_free(ctf_fs_trace
);
357 void ctf_fs_trace_destroy_notifier(void *data
)
359 struct ctf_fs_trace
*trace
= data
;
360 ctf_fs_trace_destroy(trace
);
363 struct ctf_fs_component
*ctf_fs_component_create(void)
365 struct ctf_fs_component
*ctf_fs
;
367 ctf_fs
= g_new0(struct ctf_fs_component
, 1);
373 g_ptr_array_new_with_free_func(port_data_destroy_notifier
);
374 if (!ctf_fs
->port_data
) {
379 g_ptr_array_new_with_free_func(ctf_fs_trace_destroy_notifier
);
380 if (!ctf_fs
->traces
) {
388 ctf_fs_destroy(ctf_fs
);
395 void ctf_fs_finalize(bt_self_component_source
*component
)
397 ctf_fs_destroy(bt_self_component_get_data(
398 bt_self_component_source_as_self_component(component
)));
402 GString
*get_stream_instance_unique_name(
403 struct ctf_fs_ds_file_group
*ds_file_group
)
406 struct ctf_fs_ds_file_info
*ds_file_info
;
408 name
= g_string_new(NULL
);
414 * If there's more than one stream file in the stream file
415 * group, the first (earliest) stream file's path is used as
416 * the stream's unique name.
418 BT_ASSERT(ds_file_group
->ds_file_infos
->len
> 0);
419 ds_file_info
= g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
420 g_string_assign(name
, ds_file_info
->path
->str
);
427 int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
428 struct ctf_fs_trace
*ctf_fs_trace
,
429 struct ctf_fs_ds_file_group
*ds_file_group
)
432 struct ctf_fs_port_data
*port_data
= NULL
;
433 GString
*port_name
= NULL
;
435 port_name
= get_stream_instance_unique_name(ds_file_group
);
440 BT_LOGD("Creating one port named `%s`", port_name
->str
);
442 /* Create output port for this file */
443 port_data
= g_new0(struct ctf_fs_port_data
, 1);
448 port_data
->ctf_fs
= ctf_fs
;
449 port_data
->ds_file_group
= ds_file_group
;
450 ret
= bt_self_component_source_add_output_port(
451 ctf_fs
->self_comp
, port_name
->str
, port_data
, NULL
);
456 g_ptr_array_add(ctf_fs
->port_data
, port_data
);
465 g_string_free(port_name
, TRUE
);
468 port_data_destroy(port_data
);
473 int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
474 struct ctf_fs_trace
*ctf_fs_trace
)
479 /* Create one output port for each stream file group */
480 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
481 struct ctf_fs_ds_file_group
*ds_file_group
=
482 g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
484 ret
= create_one_port_for_trace(ctf_fs
, ctf_fs_trace
,
487 BT_LOGE("Cannot create output port.");
497 void ctf_fs_ds_file_info_destroy(struct ctf_fs_ds_file_info
*ds_file_info
)
503 if (ds_file_info
->path
) {
504 g_string_free(ds_file_info
->path
, TRUE
);
507 ctf_fs_ds_index_destroy(ds_file_info
->index
);
508 g_free(ds_file_info
);
512 struct ctf_fs_ds_file_info
*ctf_fs_ds_file_info_create(const char *path
,
513 int64_t begin_ns
, struct ctf_fs_ds_index
*index
)
515 struct ctf_fs_ds_file_info
*ds_file_info
;
517 ds_file_info
= g_new0(struct ctf_fs_ds_file_info
, 1);
522 ds_file_info
->path
= g_string_new(path
);
523 if (!ds_file_info
->path
) {
524 ctf_fs_ds_file_info_destroy(ds_file_info
);
529 ds_file_info
->begin_ns
= begin_ns
;
530 ds_file_info
->index
= index
;
534 ctf_fs_ds_index_destroy(index
);
539 void ctf_fs_ds_file_group_destroy(struct ctf_fs_ds_file_group
*ds_file_group
)
541 if (!ds_file_group
) {
545 if (ds_file_group
->ds_file_infos
) {
546 g_ptr_array_free(ds_file_group
->ds_file_infos
, TRUE
);
549 bt_stream_put_ref(ds_file_group
->stream
);
550 g_free(ds_file_group
);
554 struct ctf_fs_ds_file_group
*ctf_fs_ds_file_group_create(
555 struct ctf_fs_trace
*ctf_fs_trace
,
556 struct ctf_stream_class
*sc
,
557 uint64_t stream_instance_id
)
559 struct ctf_fs_ds_file_group
*ds_file_group
;
561 ds_file_group
= g_new0(struct ctf_fs_ds_file_group
, 1);
562 if (!ds_file_group
) {
566 ds_file_group
->ds_file_infos
= g_ptr_array_new_with_free_func(
567 (GDestroyNotify
) ctf_fs_ds_file_info_destroy
);
568 if (!ds_file_group
->ds_file_infos
) {
572 ds_file_group
->stream_id
= stream_instance_id
;
574 ds_file_group
->sc
= sc
;
575 ds_file_group
->ctf_fs_trace
= ctf_fs_trace
;
579 ctf_fs_ds_file_group_destroy(ds_file_group
);
580 ds_file_group
= NULL
;
583 return ds_file_group
;
586 /* Replace by g_ptr_array_insert when we depend on glib >= 2.40. */
588 void array_insert(GPtrArray
*array
, gpointer element
, size_t pos
)
590 size_t original_array_len
= array
->len
;
592 /* Allocate an unused element at the end of the array. */
593 g_ptr_array_add(array
, NULL
);
595 /* If we are not inserting at the end, move the elements by one. */
596 if (pos
< original_array_len
) {
597 memmove(&(array
->pdata
[pos
+ 1]),
598 &(array
->pdata
[pos
]),
599 (original_array_len
- pos
) * sizeof(gpointer
));
602 /* Insert the value and bump the array len */
603 array
->pdata
[pos
] = element
;
607 int ctf_fs_ds_file_group_add_ds_file_info(
608 struct ctf_fs_ds_file_group
*ds_file_group
,
609 const char *path
, int64_t begin_ns
,
610 struct ctf_fs_ds_index
*index
)
612 struct ctf_fs_ds_file_info
*ds_file_info
;
616 /* Onwership of index is transferred. */
617 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
, index
);
623 /* Find a spot to insert this one */
624 for (i
= 0; i
< ds_file_group
->ds_file_infos
->len
; i
++) {
625 struct ctf_fs_ds_file_info
*other_ds_file_info
=
626 g_ptr_array_index(ds_file_group
->ds_file_infos
, i
);
628 if (begin_ns
< other_ds_file_info
->begin_ns
) {
633 array_insert(ds_file_group
->ds_file_infos
, ds_file_info
, i
);
638 ctf_fs_ds_file_info_destroy(ds_file_info
);
639 ctf_fs_ds_index_destroy(index
);
646 int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
,
649 int64_t stream_instance_id
= -1;
650 int64_t begin_ns
= -1;
651 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
652 bool add_group
= false;
655 struct ctf_fs_ds_file
*ds_file
= NULL
;
656 struct ctf_fs_ds_index
*index
= NULL
;
657 struct bt_msg_iter
*msg_iter
= NULL
;
658 struct ctf_stream_class
*sc
= NULL
;
659 struct bt_msg_iter_packet_properties props
;
661 msg_iter
= bt_msg_iter_create(ctf_fs_trace
->metadata
->tc
,
662 bt_common_get_page_size() * 8, ctf_fs_ds_file_medops
, NULL
);
664 BT_LOGE_STR("Cannot create a CTF message iterator.");
668 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, msg_iter
,
674 ret
= bt_msg_iter_get_packet_properties(ds_file
->msg_iter
, &props
);
676 BT_LOGE("Cannot get stream file's first packet's header and context fields (`%s`).",
681 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
,
682 props
.stream_class_id
);
684 stream_instance_id
= props
.data_stream_id
;
686 if (props
.snapshots
.beginning_clock
!= UINT64_C(-1)) {
687 BT_ASSERT(sc
->default_clock_class
);
688 ret
= bt_util_clock_cycles_to_ns_from_origin(
689 props
.snapshots
.beginning_clock
,
690 sc
->default_clock_class
->frequency
,
691 sc
->default_clock_class
->offset_seconds
,
692 sc
->default_clock_class
->offset_cycles
, &begin_ns
);
694 BT_LOGE("Cannot convert clock cycles to nanoseconds from origin (`%s`).",
700 index
= ctf_fs_ds_file_build_index(ds_file
);
702 BT_LOGW("Failed to index CTF stream file \'%s\'",
703 ds_file
->file
->path
->str
);
706 if (begin_ns
== -1) {
708 * No beggining timestamp to sort the stream files
709 * within a stream file group, so consider that this
710 * file must be the only one within its group.
712 stream_instance_id
= -1;
715 if (stream_instance_id
== -1) {
717 * No stream instance ID or no beginning timestamp:
718 * create a unique stream file group for this stream
719 * file because, even if there's a stream instance ID,
720 * there's no timestamp to order the file within its
723 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
,
725 if (!ds_file_group
) {
729 ret
= ctf_fs_ds_file_group_add_ds_file_info(ds_file_group
,
730 path
, begin_ns
, index
);
731 /* Ownership of index is transferred. */
741 BT_ASSERT(stream_instance_id
!= -1);
742 BT_ASSERT(begin_ns
!= -1);
744 /* Find an existing stream file group with this ID */
745 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
746 ds_file_group
= g_ptr_array_index(
747 ctf_fs_trace
->ds_file_groups
, i
);
749 if (ds_file_group
->sc
== sc
&&
750 ds_file_group
->stream_id
==
751 stream_instance_id
) {
755 ds_file_group
= NULL
;
758 if (!ds_file_group
) {
759 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
,
760 sc
, stream_instance_id
);
761 if (!ds_file_group
) {
768 ret
= ctf_fs_ds_file_group_add_ds_file_info(ds_file_group
, path
,
778 ctf_fs_ds_file_group_destroy(ds_file_group
);
782 if (add_group
&& ds_file_group
) {
783 g_ptr_array_add(ctf_fs_trace
->ds_file_groups
, ds_file_group
);
786 ctf_fs_ds_file_destroy(ds_file
);
789 bt_msg_iter_destroy(msg_iter
);
792 ctf_fs_ds_index_destroy(index
);
797 int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
800 const char *basename
;
801 GError
*error
= NULL
;
804 /* Check each file in the path directory, except specific ones */
805 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
807 BT_LOGE("Cannot open directory `%s`: %s (code %d)",
808 ctf_fs_trace
->path
->str
, error
->message
,
813 while ((basename
= g_dir_read_name(dir
))) {
814 struct ctf_fs_file
*file
;
816 if (!strcmp(basename
, CTF_FS_METADATA_FILENAME
)) {
817 /* Ignore the metadata stream. */
818 BT_LOGD("Ignoring metadata file `%s" G_DIR_SEPARATOR_S
"%s`",
819 ctf_fs_trace
->path
->str
, basename
);
823 if (basename
[0] == '.') {
824 BT_LOGD("Ignoring hidden file `%s" G_DIR_SEPARATOR_S
"%s`",
825 ctf_fs_trace
->path
->str
, basename
);
829 /* Create the file. */
830 file
= ctf_fs_file_create();
832 BT_LOGE("Cannot create stream file object for file `%s" G_DIR_SEPARATOR_S
"%s`",
833 ctf_fs_trace
->path
->str
, basename
);
837 /* Create full path string. */
838 g_string_append_printf(file
->path
, "%s" G_DIR_SEPARATOR_S
"%s",
839 ctf_fs_trace
->path
->str
, basename
);
840 if (!g_file_test(file
->path
->str
, G_FILE_TEST_IS_REGULAR
)) {
841 BT_LOGD("Ignoring non-regular file `%s`",
843 ctf_fs_file_destroy(file
);
848 ret
= ctf_fs_file_open(file
, "rb");
850 BT_LOGE("Cannot open stream file `%s`", file
->path
->str
);
854 if (file
->size
== 0) {
855 /* Skip empty stream. */
856 BT_LOGD("Ignoring empty file `%s`", file
->path
->str
);
857 ctf_fs_file_destroy(file
);
861 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
,
864 BT_LOGE("Cannot add stream file `%s` to stream file group",
866 ctf_fs_file_destroy(file
);
870 ctf_fs_file_destroy(file
);
892 int set_trace_name(bt_trace
*trace
, const char *name_suffix
)
895 const bt_trace_class
*tc
= bt_trace_borrow_class_const(trace
);
899 name
= g_string_new(NULL
);
901 BT_LOGE_STR("Failed to allocate a GString.");
907 * Check if we have a trace environment string value named `hostname`.
908 * If so, use it as the trace name's prefix.
910 val
= bt_trace_class_borrow_environment_entry_value_by_name_const(
912 if (val
&& bt_value_is_string(val
)) {
913 g_string_append(name
, bt_value_string_get(val
));
916 g_string_append_c(name
, G_DIR_SEPARATOR
);
921 g_string_append(name
, name_suffix
);
924 ret
= bt_trace_set_name(trace
, name
->str
);
933 g_string_free(name
, TRUE
);
940 struct ctf_fs_trace
*ctf_fs_trace_create(bt_self_component_source
*self_comp
,
941 const char *path
, const char *name
,
942 struct ctf_fs_metadata_config
*metadata_config
)
944 struct ctf_fs_trace
*ctf_fs_trace
;
947 ctf_fs_trace
= g_new0(struct ctf_fs_trace
, 1);
952 ctf_fs_trace
->path
= g_string_new(path
);
953 if (!ctf_fs_trace
->path
) {
957 ctf_fs_trace
->name
= g_string_new(name
);
958 if (!ctf_fs_trace
->name
) {
962 ctf_fs_trace
->metadata
= g_new0(struct ctf_fs_metadata
, 1);
963 if (!ctf_fs_trace
->metadata
) {
967 ctf_fs_metadata_init(ctf_fs_trace
->metadata
);
968 ctf_fs_trace
->ds_file_groups
= g_ptr_array_new_with_free_func(
969 (GDestroyNotify
) ctf_fs_ds_file_group_destroy
);
970 if (!ctf_fs_trace
->ds_file_groups
) {
974 ret
= ctf_fs_metadata_set_trace_class(self_comp
,
975 ctf_fs_trace
, metadata_config
);
980 if (ctf_fs_trace
->metadata
->trace_class
) {
981 ctf_fs_trace
->trace
=
982 bt_trace_create(ctf_fs_trace
->metadata
->trace_class
);
983 if (!ctf_fs_trace
->trace
) {
988 if (ctf_fs_trace
->trace
) {
989 ret
= set_trace_name(ctf_fs_trace
->trace
, name
);
995 ret
= create_ds_file_groups(ctf_fs_trace
);
1003 ctf_fs_trace_destroy(ctf_fs_trace
);
1004 ctf_fs_trace
= NULL
;
1007 return ctf_fs_trace
;
1011 int path_is_ctf_trace(const char *path
)
1013 GString
*metadata_path
= g_string_new(NULL
);
1016 if (!metadata_path
) {
1021 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
1023 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
1029 g_string_free(metadata_path
, TRUE
);
1034 int add_trace_path(GList
**trace_paths
, const char *path
)
1036 GString
*norm_path
= NULL
;
1039 norm_path
= bt_common_normalize_path(path
, NULL
);
1041 BT_LOGE("Failed to normalize path `%s`.", path
);
1046 // FIXME: Remove or ifdef for __MINGW32__
1047 if (strcmp(norm_path
->str
, "/") == 0) {
1048 BT_LOGE("Opening a trace in `/` is not supported.");
1053 *trace_paths
= g_list_prepend(*trace_paths
, norm_path
);
1054 BT_ASSERT(*trace_paths
);
1059 g_string_free(norm_path
, TRUE
);
1066 int ctf_fs_find_traces(GList
**trace_paths
, const char *start_path
)
1069 GError
*error
= NULL
;
1071 const char *basename
= NULL
;
1073 /* Check if the starting path is a CTF trace itself */
1074 ret
= path_is_ctf_trace(start_path
);
1081 * Stop recursion: a CTF trace cannot contain another
1084 ret
= add_trace_path(trace_paths
, start_path
);
1088 /* Look for subdirectories */
1089 if (!g_file_test(start_path
, G_FILE_TEST_IS_DIR
)) {
1090 /* Starting path is not a directory: end of recursion */
1094 dir
= g_dir_open(start_path
, 0, &error
);
1096 if (error
->code
== G_FILE_ERROR_ACCES
) {
1097 BT_LOGD("Cannot open directory `%s`: %s (code %d): continuing",
1098 start_path
, error
->message
, error
->code
);
1102 BT_LOGE("Cannot open directory `%s`: %s (code %d)",
1103 start_path
, error
->message
, error
->code
);
1108 while ((basename
= g_dir_read_name(dir
))) {
1109 GString
*sub_path
= g_string_new(NULL
);
1116 g_string_printf(sub_path
, "%s" G_DIR_SEPARATOR_S
"%s", start_path
, basename
);
1117 ret
= ctf_fs_find_traces(trace_paths
, sub_path
->str
);
1118 g_string_free(sub_path
, TRUE
);
1130 g_error_free(error
);
1137 GList
*ctf_fs_create_trace_names(GList
*trace_paths
, const char *base_path
) {
1138 GList
*trace_names
= NULL
;
1140 const char *last_sep
;
1144 * At this point we know that all the trace paths are
1145 * normalized, and so is the base path. This means that
1146 * they are absolute and they don't end with a separator.
1147 * We can simply find the location of the last separator
1148 * in the base path, which gives us the name of the actual
1149 * directory to look into, and use this location as the
1150 * start of each trace name within each trace path.
1154 * Base path: /home/user/my-traces/some-trace
1156 * - /home/user/my-traces/some-trace/host1/trace1
1157 * - /home/user/my-traces/some-trace/host1/trace2
1158 * - /home/user/my-traces/some-trace/host2/trace
1159 * - /home/user/my-traces/some-trace/other-trace
1161 * In this case the trace names are:
1163 * - some-trace/host1/trace1
1164 * - some-trace/host1/trace2
1165 * - some-trace/host2/trace
1166 * - some-trace/other-trace
1168 last_sep
= strrchr(base_path
, G_DIR_SEPARATOR
);
1170 /* We know there's at least one separator */
1171 BT_ASSERT(last_sep
);
1173 /* Distance to base */
1174 base_dist
= last_sep
- base_path
+ 1;
1176 /* Create the trace names */
1177 for (node
= trace_paths
; node
; node
= g_list_next(node
)) {
1178 GString
*trace_name
= g_string_new(NULL
);
1179 GString
*trace_path
= node
->data
;
1181 BT_ASSERT(trace_name
);
1182 g_string_assign(trace_name
, &trace_path
->str
[base_dist
]);
1183 trace_names
= g_list_append(trace_names
, trace_name
);
1189 /* Helper for ctf_fs_component_create_ctf_fs_traces, to handle a single path/root. */
1192 int ctf_fs_component_create_ctf_fs_traces_one_root(bt_self_component_source
*self_comp
,
1193 struct ctf_fs_component
*ctf_fs
,
1194 const char *path_param
)
1196 struct ctf_fs_trace
*ctf_fs_trace
= NULL
;
1198 GString
*norm_path
= NULL
;
1199 GList
*trace_paths
= NULL
;
1200 GList
*trace_names
= NULL
;
1204 norm_path
= bt_common_normalize_path(path_param
, NULL
);
1206 BT_LOGE("Failed to normalize path: `%s`.",
1211 ret
= ctf_fs_find_traces(&trace_paths
, norm_path
->str
);
1217 BT_LOGE("No CTF traces recursively found in `%s`.",
1222 trace_names
= ctf_fs_create_trace_names(trace_paths
, norm_path
->str
);
1224 BT_LOGE("Cannot create trace names from trace paths.");
1228 for (tp_node
= trace_paths
, tn_node
= trace_names
; tp_node
;
1229 tp_node
= g_list_next(tp_node
),
1230 tn_node
= g_list_next(tn_node
)) {
1231 GString
*trace_path
= tp_node
->data
;
1232 GString
*trace_name
= tn_node
->data
;
1234 ctf_fs_trace
= ctf_fs_trace_create(self_comp
,
1235 trace_path
->str
, trace_name
->str
,
1236 &ctf_fs
->metadata_config
);
1237 if (!ctf_fs_trace
) {
1238 BT_LOGE("Cannot create trace for `%s`.",
1243 g_ptr_array_add(ctf_fs
->traces
, ctf_fs_trace
);
1244 ctf_fs_trace
= NULL
;
1251 ctf_fs_trace_destroy(ctf_fs_trace
);
1254 for (tp_node
= trace_paths
; tp_node
; tp_node
= g_list_next(tp_node
)) {
1255 if (tp_node
->data
) {
1256 g_string_free(tp_node
->data
, TRUE
);
1260 for (tn_node
= trace_names
; tn_node
; tn_node
= g_list_next(tn_node
)) {
1261 if (tn_node
->data
) {
1262 g_string_free(tn_node
->data
, TRUE
);
1267 g_list_free(trace_paths
);
1271 g_list_free(trace_names
);
1275 g_string_free(norm_path
, TRUE
);
1281 int ctf_fs_component_create_ctf_fs_traces(bt_self_component_source
*self_comp
,
1282 struct ctf_fs_component
*ctf_fs
,
1283 const bt_value
*paths_value
)
1288 for (i
= 0; i
< bt_value_array_get_size(paths_value
); i
++) {
1289 const bt_value
*path_value
= bt_value_array_borrow_element_by_index_const(paths_value
, i
);
1290 const char *path
= bt_value_string_get(path_value
);
1292 ret
= ctf_fs_component_create_ctf_fs_traces_one_root(self_comp
, ctf_fs
, path
);
1302 /* Create the IR stream objects for ctf_fs_trace. */
1305 int create_streams_for_trace(struct ctf_fs_trace
*ctf_fs_trace
)
1308 GString
*name
= NULL
;
1311 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
1312 struct ctf_fs_ds_file_group
*ds_file_group
=
1313 g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
1314 name
= get_stream_instance_unique_name(ds_file_group
);
1320 if (ds_file_group
->sc
->ir_sc
) {
1321 BT_ASSERT(ctf_fs_trace
->trace
);
1323 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
1324 /* No stream ID: use 0 */
1325 ds_file_group
->stream
= bt_stream_create_with_id(
1326 ds_file_group
->sc
->ir_sc
,
1327 ctf_fs_trace
->trace
,
1328 ctf_fs_trace
->next_stream_id
);
1329 ctf_fs_trace
->next_stream_id
++;
1331 /* Specific stream ID */
1332 ds_file_group
->stream
= bt_stream_create_with_id(
1333 ds_file_group
->sc
->ir_sc
,
1334 ctf_fs_trace
->trace
,
1335 (uint64_t) ds_file_group
->stream_id
);
1338 ds_file_group
->stream
= NULL
;
1341 if (!ds_file_group
->stream
) {
1342 BT_LOGE("Cannot create stream for DS file group: "
1343 "addr=%p, stream-name=\"%s\"",
1344 ds_file_group
, name
->str
);
1348 ret
= bt_stream_set_name(ds_file_group
->stream
,
1351 BT_LOGE("Cannot set stream's name: "
1352 "addr=%p, stream-name=\"%s\"",
1353 ds_file_group
->stream
, name
->str
);
1357 g_string_free(name
, TRUE
);
1370 g_string_free(name
, TRUE
);
1375 bool validate_paths_parameter(const bt_value
*paths
)
1382 BT_LOGE("missing \"paths\" parameter");
1386 type
= bt_value_get_type(paths
);
1387 if (type
!= BT_VALUE_TYPE_ARRAY
) {
1388 BT_LOGE("`paths` parameter: expecting array value: type=%s",
1389 bt_common_value_type_string(type
));
1393 for (i
= 0; i
< bt_value_array_get_size(paths
); i
++) {
1394 const bt_value
*elem
;
1396 elem
= bt_value_array_borrow_element_by_index_const(paths
, i
);
1397 type
= bt_value_get_type(elem
);
1398 if (type
!= BT_VALUE_TYPE_STRING
) {
1399 BT_LOGE("`paths` parameter: expecting string value: index=%" PRIu64
", type=%s",
1400 i
, bt_common_value_type_string(type
));
1416 struct ctf_fs_component
*ctf_fs_create(
1417 bt_self_component_source
*self_comp
,
1418 const bt_value
*params
)
1420 struct ctf_fs_component
*ctf_fs
= NULL
;
1421 const bt_value
*value
= NULL
;
1423 const bt_value
*paths_value
;
1425 paths_value
= bt_value_map_borrow_entry_value_const(params
, "paths");
1426 if (!validate_paths_parameter(paths_value
)) {
1430 ctf_fs
= ctf_fs_component_create();
1435 bt_self_component_set_data(
1436 bt_self_component_source_as_self_component(self_comp
),
1440 * We don't need to get a new reference here because as long as
1441 * our private ctf_fs_component object exists, the containing
1442 * private component should also exist.
1444 ctf_fs
->self_comp
= self_comp
;
1446 value
= bt_value_map_borrow_entry_value_const(params
,
1447 "clock-class-offset-s");
1449 if (!bt_value_is_integer(value
)) {
1450 BT_LOGE("clock-class-offset-s should be an integer");
1453 ctf_fs
->metadata_config
.clock_class_offset_s
= bt_value_integer_get(value
);
1456 value
= bt_value_map_borrow_entry_value_const(params
,
1457 "clock-class-offset-ns");
1459 if (!bt_value_is_integer(value
)) {
1460 BT_LOGE("clock-class-offset-ns should be an integer");
1463 ctf_fs
->metadata_config
.clock_class_offset_ns
= bt_value_integer_get(value
);
1466 if (ctf_fs_component_create_ctf_fs_traces(self_comp
, ctf_fs
, paths_value
)) {
1470 for (i
= 0; i
< ctf_fs
->traces
->len
; i
++) {
1471 struct ctf_fs_trace
*trace
= g_ptr_array_index(ctf_fs
->traces
, i
);
1473 if (create_streams_for_trace(trace
)) {
1477 if (create_ports_for_trace(ctf_fs
, trace
)) {
1485 ctf_fs_destroy(ctf_fs
);
1487 bt_self_component_set_data(
1488 bt_self_component_source_as_self_component(self_comp
),
1496 bt_self_component_status
ctf_fs_init(
1497 bt_self_component_source
*self_comp
,
1498 const bt_value
*params
, UNUSED_VAR
void *init_method_data
)
1500 struct ctf_fs_component
*ctf_fs
;
1501 bt_self_component_status ret
= BT_SELF_COMPONENT_STATUS_OK
;
1503 ctf_fs
= ctf_fs_create(self_comp
, params
);
1505 ret
= BT_SELF_COMPONENT_STATUS_ERROR
;
1512 bt_query_status
ctf_fs_query(
1513 bt_self_component_class_source
*comp_class
,
1514 const bt_query_executor
*query_exec
,
1515 const char *object
, const bt_value
*params
,
1516 const bt_value
**result
)
1518 bt_query_status status
= BT_QUERY_STATUS_OK
;
1520 if (!strcmp(object
, "metadata-info")) {
1521 status
= metadata_info_query(comp_class
, params
, result
);
1522 } else if (!strcmp(object
, "trace-info")) {
1523 status
= trace_info_query(comp_class
, params
, result
);
1525 BT_LOGE("Unknown query object `%s`", object
);
1526 status
= BT_QUERY_STATUS_INVALID_OBJECT
;