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/notif-iter/notif-iter.h"
41 #include "../common/utils/utils.h"
44 #define BT_LOG_TAG "PLUGIN-CTF-FS-SRC"
48 int notif_iter_data_set_current_ds_file(struct ctf_fs_notif_iter_data
*notif_iter_data
)
50 struct ctf_fs_ds_file_info
*ds_file_info
;
53 BT_ASSERT(notif_iter_data
->ds_file_info_index
<
54 notif_iter_data
->ds_file_group
->ds_file_infos
->len
);
55 ds_file_info
= g_ptr_array_index(
56 notif_iter_data
->ds_file_group
->ds_file_infos
,
57 notif_iter_data
->ds_file_info_index
);
59 ctf_fs_ds_file_destroy(notif_iter_data
->ds_file
);
60 notif_iter_data
->ds_file
= ctf_fs_ds_file_create(
61 notif_iter_data
->ds_file_group
->ctf_fs_trace
,
62 notif_iter_data
->pc_notif_iter
,
63 notif_iter_data
->notif_iter
,
64 notif_iter_data
->ds_file_group
->stream
,
65 ds_file_info
->path
->str
);
66 if (!notif_iter_data
->ds_file
) {
74 void ctf_fs_notif_iter_data_destroy(
75 struct ctf_fs_notif_iter_data
*notif_iter_data
)
77 if (!notif_iter_data
) {
81 ctf_fs_ds_file_destroy(notif_iter_data
->ds_file
);
83 if (notif_iter_data
->notif_iter
) {
84 bt_notif_iter_destroy(notif_iter_data
->notif_iter
);
87 g_free(notif_iter_data
);
91 enum bt_notification_iterator_status
ctf_fs_iterator_next_one(
92 struct ctf_fs_notif_iter_data
*notif_iter_data
,
93 struct bt_notification
**notif
)
95 enum bt_notification_iterator_status status
;
96 struct bt_private_notification
*priv_notif
;
99 BT_ASSERT(notif_iter_data
->ds_file
);
100 status
= ctf_fs_ds_file_next(notif_iter_data
->ds_file
, &priv_notif
);
101 *notif
= bt_notification_borrow_from_private(priv_notif
);
103 if (status
== BT_NOTIFICATION_ITERATOR_STATUS_OK
&&
104 bt_notification_get_type(*notif
) ==
105 BT_NOTIFICATION_TYPE_STREAM_BEGIN
) {
106 if (notif_iter_data
->skip_stream_begin_notifs
) {
108 * We already emitted a
109 * BT_NOTIFICATION_TYPE_STREAM_BEGIN
110 * notification: skip this one, get a new one.
112 BT_OBJECT_PUT_REF_AND_RESET(*notif
);
113 status
= ctf_fs_ds_file_next(notif_iter_data
->ds_file
,
115 *notif
= bt_notification_borrow_from_private(priv_notif
);
116 BT_ASSERT(status
!= BT_NOTIFICATION_ITERATOR_STATUS_END
);
120 * First BT_NOTIFICATION_TYPE_STREAM_BEGIN
121 * notification: skip all following.
123 notif_iter_data
->skip_stream_begin_notifs
= true;
128 if (status
== BT_NOTIFICATION_ITERATOR_STATUS_OK
&&
129 bt_notification_get_type(*notif
) ==
130 BT_NOTIFICATION_TYPE_STREAM_END
) {
131 notif_iter_data
->ds_file_info_index
++;
133 if (notif_iter_data
->ds_file_info_index
==
134 notif_iter_data
->ds_file_group
->ds_file_infos
->len
) {
136 * No more stream files to read: we reached the
137 * real end. Emit this
138 * BT_NOTIFICATION_TYPE_STREAM_END notification.
139 * The next time ctf_fs_iterator_next() is
140 * called for this notification iterator,
141 * ctf_fs_ds_file_next() will return
142 * BT_NOTIFICATION_ITERATOR_STATUS_END().
147 BT_OBJECT_PUT_REF_AND_RESET(*notif
);
148 bt_notif_iter_reset(notif_iter_data
->notif_iter
);
151 * Open and start reading the next stream file within
152 * our stream file group.
154 ret
= notif_iter_data_set_current_ds_file(notif_iter_data
);
156 status
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
160 status
= ctf_fs_ds_file_next(notif_iter_data
->ds_file
, &priv_notif
);
161 *notif
= bt_notification_borrow_from_private(priv_notif
);
164 * If we get a notification, we expect to get a
165 * BT_NOTIFICATION_TYPE_STREAM_BEGIN notification
166 * because the iterator's state machine emits one before
167 * even requesting the first block of data from the
168 * medium. Skip this notification because we're not
169 * really starting a new stream here, and try getting a
170 * new notification (which, if it works, is a
171 * BT_NOTIFICATION_TYPE_PACKET_BEGIN one). We're sure to
172 * get at least one pair of
173 * BT_NOTIFICATION_TYPE_PACKET_BEGIN and
174 * BT_NOTIFICATION_TYPE_PACKET_END notifications in the
175 * case of a single, empty packet. We know there's at
176 * least one packet because the stream file group does
177 * not contain empty stream files.
179 BT_ASSERT(notif_iter_data
->skip_stream_begin_notifs
);
181 if (status
== BT_NOTIFICATION_ITERATOR_STATUS_OK
) {
182 BT_ASSERT(bt_notification_get_type(*notif
) ==
183 BT_NOTIFICATION_TYPE_STREAM_BEGIN
);
184 BT_OBJECT_PUT_REF_AND_RESET(*notif
);
185 status
= ctf_fs_ds_file_next(notif_iter_data
->ds_file
,
187 *notif
= bt_notification_borrow_from_private(priv_notif
);
188 BT_ASSERT(status
!= BT_NOTIFICATION_ITERATOR_STATUS_END
);
197 enum bt_notification_iterator_status
ctf_fs_iterator_next(
198 struct bt_private_connection_private_notification_iterator
*iterator
,
199 bt_notification_array notifs
, uint64_t capacity
,
202 enum bt_notification_iterator_status status
=
203 BT_NOTIFICATION_ITERATOR_STATUS_OK
;
204 struct ctf_fs_notif_iter_data
*notif_iter_data
=
205 bt_private_connection_private_notification_iterator_get_user_data(iterator
);
208 while (i
< capacity
&& status
== BT_NOTIFICATION_ITERATOR_STATUS_OK
) {
209 status
= ctf_fs_iterator_next_one(notif_iter_data
, ¬ifs
[i
]);
210 if (status
== BT_NOTIFICATION_ITERATOR_STATUS_OK
) {
217 * Even if ctf_fs_iterator_next_one() returned something
218 * else than BT_NOTIFICATION_ITERATOR_STATUS_OK, we
219 * accumulated notification objects in the output
220 * notification array, so we need to return
221 * BT_NOTIFICATION_ITERATOR_STATUS_OK so that they are
222 * transfered to downstream. This other status occurs
223 * again the next time muxer_notif_iter_do_next() is
224 * called, possibly without any accumulated
225 * notification, in which case we'll return it.
228 status
= BT_NOTIFICATION_ITERATOR_STATUS_OK
;
234 void ctf_fs_iterator_finalize(struct bt_private_connection_private_notification_iterator
*it
)
236 void *notif_iter_data
=
237 bt_private_connection_private_notification_iterator_get_user_data(it
);
239 ctf_fs_notif_iter_data_destroy(notif_iter_data
);
242 enum bt_notification_iterator_status
ctf_fs_iterator_init(
243 struct bt_private_connection_private_notification_iterator
*it
,
244 struct bt_private_port
*port
)
246 struct ctf_fs_port_data
*port_data
;
247 struct ctf_fs_notif_iter_data
*notif_iter_data
= NULL
;
248 enum bt_notification_iterator_status ret
=
249 BT_NOTIFICATION_ITERATOR_STATUS_OK
;
252 port_data
= bt_private_port_get_user_data(port
);
254 ret
= BT_NOTIFICATION_ITERATOR_STATUS_INVALID
;
258 notif_iter_data
= g_new0(struct ctf_fs_notif_iter_data
, 1);
259 if (!notif_iter_data
) {
260 ret
= BT_NOTIFICATION_ITERATOR_STATUS_NOMEM
;
264 notif_iter_data
->pc_notif_iter
= it
;
265 notif_iter_data
->notif_iter
= bt_notif_iter_create(
266 port_data
->ds_file_group
->ctf_fs_trace
->metadata
->tc
,
267 bt_common_get_page_size() * 8,
268 ctf_fs_ds_file_medops
, NULL
);
269 if (!notif_iter_data
->notif_iter
) {
270 BT_LOGE_STR("Cannot create a CTF notification iterator.");
271 ret
= BT_NOTIFICATION_ITERATOR_STATUS_NOMEM
;
275 notif_iter_data
->ds_file_group
= port_data
->ds_file_group
;
276 iret
= notif_iter_data_set_current_ds_file(notif_iter_data
);
278 ret
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
282 ret
= bt_private_connection_private_notification_iterator_set_user_data(it
, notif_iter_data
);
283 if (ret
!= BT_NOTIFICATION_ITERATOR_STATUS_OK
) {
287 notif_iter_data
= NULL
;
291 (void) bt_private_connection_private_notification_iterator_set_user_data(it
, NULL
);
294 ctf_fs_notif_iter_data_destroy(notif_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 ctf_fs_trace_destroy(struct ctf_fs_trace
*ctf_fs_trace
)
323 if (ctf_fs_trace
->ds_file_groups
) {
324 g_ptr_array_free(ctf_fs_trace
->ds_file_groups
, TRUE
);
327 if (ctf_fs_trace
->path
) {
328 g_string_free(ctf_fs_trace
->path
, TRUE
);
331 if (ctf_fs_trace
->name
) {
332 g_string_free(ctf_fs_trace
->name
, TRUE
);
335 if (ctf_fs_trace
->metadata
) {
336 ctf_fs_metadata_fini(ctf_fs_trace
->metadata
);
337 g_free(ctf_fs_trace
->metadata
);
340 g_free(ctf_fs_trace
);
344 void ctf_fs_trace_destroy_notifier(void *data
)
346 struct ctf_fs_trace
*trace
= data
;
347 ctf_fs_trace_destroy(trace
);
350 void ctf_fs_finalize(struct bt_private_component
*component
)
352 void *data
= bt_private_component_get_user_data(component
);
354 ctf_fs_destroy(data
);
358 void port_data_destroy(void *data
) {
359 struct ctf_fs_port_data
*port_data
= data
;
369 GString
*get_stream_instance_unique_name(
370 struct ctf_fs_ds_file_group
*ds_file_group
)
373 struct ctf_fs_ds_file_info
*ds_file_info
;
375 name
= g_string_new(NULL
);
381 * If there's more than one stream file in the stream file
382 * group, the first (earliest) stream file's path is used as
383 * the stream's unique name.
385 BT_ASSERT(ds_file_group
->ds_file_infos
->len
> 0);
386 ds_file_info
= g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
387 g_string_assign(name
, ds_file_info
->path
->str
);
394 int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
395 struct ctf_fs_trace
*ctf_fs_trace
,
396 struct ctf_fs_ds_file_group
*ds_file_group
)
399 struct ctf_fs_port_data
*port_data
= NULL
;
400 GString
*port_name
= NULL
;
402 port_name
= get_stream_instance_unique_name(ds_file_group
);
407 BT_LOGD("Creating one port named `%s`", port_name
->str
);
409 /* Create output port for this file */
410 port_data
= g_new0(struct ctf_fs_port_data
, 1);
415 port_data
->ctf_fs
= ctf_fs
;
416 port_data
->ds_file_group
= ds_file_group
;
417 ret
= bt_private_component_source_add_output_private_port(
418 ctf_fs
->priv_comp
, port_name
->str
, port_data
, NULL
);
423 g_ptr_array_add(ctf_fs
->port_data
, port_data
);
432 g_string_free(port_name
, TRUE
);
435 port_data_destroy(port_data
);
440 int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
441 struct ctf_fs_trace
*ctf_fs_trace
)
446 /* Create one output port for each stream file group */
447 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
448 struct ctf_fs_ds_file_group
*ds_file_group
=
449 g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
451 ret
= create_one_port_for_trace(ctf_fs
, ctf_fs_trace
,
454 BT_LOGE("Cannot create output port.");
464 void ctf_fs_ds_file_info_destroy(struct ctf_fs_ds_file_info
*ds_file_info
)
470 if (ds_file_info
->path
) {
471 g_string_free(ds_file_info
->path
, TRUE
);
474 ctf_fs_ds_index_destroy(ds_file_info
->index
);
475 g_free(ds_file_info
);
479 struct ctf_fs_ds_file_info
*ctf_fs_ds_file_info_create(const char *path
,
480 int64_t begin_ns
, struct ctf_fs_ds_index
*index
)
482 struct ctf_fs_ds_file_info
*ds_file_info
;
484 ds_file_info
= g_new0(struct ctf_fs_ds_file_info
, 1);
489 ds_file_info
->path
= g_string_new(path
);
490 if (!ds_file_info
->path
) {
491 ctf_fs_ds_file_info_destroy(ds_file_info
);
496 ds_file_info
->begin_ns
= begin_ns
;
497 ds_file_info
->index
= index
;
501 ctf_fs_ds_index_destroy(index
);
506 void ctf_fs_ds_file_group_destroy(struct ctf_fs_ds_file_group
*ds_file_group
)
508 if (!ds_file_group
) {
512 if (ds_file_group
->ds_file_infos
) {
513 g_ptr_array_free(ds_file_group
->ds_file_infos
, TRUE
);
516 bt_object_put_ref(ds_file_group
->stream
);
517 bt_object_put_ref(ds_file_group
->stream_class
);
518 g_free(ds_file_group
);
522 struct ctf_fs_ds_file_group
*ctf_fs_ds_file_group_create(
523 struct ctf_fs_trace
*ctf_fs_trace
,
524 struct bt_private_stream_class
*stream_class
,
525 uint64_t stream_instance_id
)
527 struct ctf_fs_ds_file_group
*ds_file_group
;
529 ds_file_group
= g_new0(struct ctf_fs_ds_file_group
, 1);
530 if (!ds_file_group
) {
534 ds_file_group
->ds_file_infos
= g_ptr_array_new_with_free_func(
535 (GDestroyNotify
) ctf_fs_ds_file_info_destroy
);
536 if (!ds_file_group
->ds_file_infos
) {
540 ds_file_group
->stream_id
= stream_instance_id
;
541 BT_ASSERT(stream_class
);
542 ds_file_group
->stream_class
= bt_object_get_ref(stream_class
);
543 ds_file_group
->ctf_fs_trace
= ctf_fs_trace
;
547 ctf_fs_ds_file_group_destroy(ds_file_group
);
548 ds_file_group
= NULL
;
551 return ds_file_group
;
554 /* Replace by g_ptr_array_insert when we depend on glib >= 2.40. */
556 void array_insert(GPtrArray
*array
, gpointer element
, size_t pos
)
558 size_t original_array_len
= array
->len
;
560 /* Allocate an unused element at the end of the array. */
561 g_ptr_array_add(array
, NULL
);
563 /* If we are not inserting at the end, move the elements by one. */
564 if (pos
< original_array_len
) {
565 memmove(&(array
->pdata
[pos
+ 1]),
566 &(array
->pdata
[pos
]),
567 (original_array_len
- pos
) * sizeof(gpointer
));
570 /* Insert the value and bump the array len */
571 array
->pdata
[pos
] = element
;
575 int ctf_fs_ds_file_group_add_ds_file_info(
576 struct ctf_fs_ds_file_group
*ds_file_group
,
577 const char *path
, int64_t begin_ns
,
578 struct ctf_fs_ds_index
*index
)
580 struct ctf_fs_ds_file_info
*ds_file_info
;
584 /* Onwership of index is transferred. */
585 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
, index
);
591 /* Find a spot to insert this one */
592 for (i
= 0; i
< ds_file_group
->ds_file_infos
->len
; i
++) {
593 struct ctf_fs_ds_file_info
*other_ds_file_info
=
594 g_ptr_array_index(ds_file_group
->ds_file_infos
, i
);
596 if (begin_ns
< other_ds_file_info
->begin_ns
) {
601 array_insert(ds_file_group
->ds_file_infos
, ds_file_info
, i
);
606 ctf_fs_ds_file_info_destroy(ds_file_info
);
607 ctf_fs_ds_index_destroy(index
);
614 int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
,
617 struct bt_private_stream_class
*stream_class
= NULL
;
618 int64_t stream_instance_id
= -1;
619 int64_t begin_ns
= -1;
620 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
621 bool add_group
= false;
624 struct ctf_fs_ds_file
*ds_file
= NULL
;
625 struct ctf_fs_ds_index
*index
= NULL
;
626 struct bt_notif_iter
*notif_iter
= NULL
;
627 struct ctf_stream_class
*sc
= NULL
;
628 struct bt_notif_iter_packet_properties props
;
630 notif_iter
= bt_notif_iter_create(ctf_fs_trace
->metadata
->tc
,
631 bt_common_get_page_size() * 8, ctf_fs_ds_file_medops
, NULL
);
633 BT_LOGE_STR("Cannot create a CTF notification iterator.");
637 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, notif_iter
,
643 ret
= ctf_fs_ds_file_borrow_packet_header_context_fields(ds_file
,
646 BT_LOGE("Cannot get stream file's first packet's header and context fields (`%s`).",
651 ret
= bt_notif_iter_get_packet_properties(ds_file
->notif_iter
, &props
);
653 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
,
654 props
.stream_class_id
);
656 stream_class
= sc
->ir_sc
;
657 BT_ASSERT(stream_class
);
658 stream_instance_id
= props
.data_stream_id
;
660 if (props
.snapshots
.beginning_clock
!= UINT64_C(-1)) {
661 BT_ASSERT(sc
->default_clock_class
);
662 ret
= bt_clock_class_cycles_to_ns_from_origin(
663 bt_clock_class_borrow_from_private(
664 sc
->default_clock_class
),
665 props
.snapshots
.beginning_clock
, &begin_ns
);
667 BT_LOGE("Cannot convert clock cycles to nanoseconds from origin (`%s`).",
673 index
= ctf_fs_ds_file_build_index(ds_file
);
675 BT_LOGW("Failed to index CTF stream file \'%s\'",
676 ds_file
->file
->path
->str
);
679 if (begin_ns
== -1) {
681 * No beggining timestamp to sort the stream files
682 * within a stream file group, so consider that this
683 * file must be the only one within its group.
685 stream_instance_id
= -1;
688 if (stream_instance_id
== -1) {
690 * No stream instance ID or no beginning timestamp:
691 * create a unique stream file group for this stream
692 * file because, even if there's a stream instance ID,
693 * there's no timestamp to order the file within its
696 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
,
697 stream_class
, stream_instance_id
);
698 if (!ds_file_group
) {
702 ret
= ctf_fs_ds_file_group_add_ds_file_info(ds_file_group
,
703 path
, begin_ns
, index
);
704 /* Ownership of index is transferred. */
714 BT_ASSERT(stream_instance_id
!= -1);
715 BT_ASSERT(begin_ns
!= -1);
717 /* Find an existing stream file group with this ID */
718 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
719 ds_file_group
= g_ptr_array_index(
720 ctf_fs_trace
->ds_file_groups
, i
);
722 if (ds_file_group
->stream_class
== stream_class
&&
723 ds_file_group
->stream_id
==
724 stream_instance_id
) {
728 ds_file_group
= NULL
;
731 if (!ds_file_group
) {
732 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
,
733 stream_class
, stream_instance_id
);
734 if (!ds_file_group
) {
741 ret
= ctf_fs_ds_file_group_add_ds_file_info(ds_file_group
, path
,
751 ctf_fs_ds_file_group_destroy(ds_file_group
);
755 if (add_group
&& ds_file_group
) {
756 g_ptr_array_add(ctf_fs_trace
->ds_file_groups
, ds_file_group
);
759 ctf_fs_ds_file_destroy(ds_file
);
762 bt_notif_iter_destroy(notif_iter
);
765 ctf_fs_ds_index_destroy(index
);
770 int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
773 const char *basename
;
774 GError
*error
= NULL
;
778 /* Check each file in the path directory, except specific ones */
779 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
781 BT_LOGE("Cannot open directory `%s`: %s (code %d)",
782 ctf_fs_trace
->path
->str
, error
->message
,
787 while ((basename
= g_dir_read_name(dir
))) {
788 struct ctf_fs_file
*file
;
790 if (!strcmp(basename
, CTF_FS_METADATA_FILENAME
)) {
791 /* Ignore the metadata stream. */
792 BT_LOGD("Ignoring metadata file `%s" G_DIR_SEPARATOR_S
"%s`",
793 ctf_fs_trace
->path
->str
, basename
);
797 if (basename
[0] == '.') {
798 BT_LOGD("Ignoring hidden file `%s" G_DIR_SEPARATOR_S
"%s`",
799 ctf_fs_trace
->path
->str
, basename
);
803 /* Create the file. */
804 file
= ctf_fs_file_create();
806 BT_LOGE("Cannot create stream file object for file `%s" G_DIR_SEPARATOR_S
"%s`",
807 ctf_fs_trace
->path
->str
, basename
);
811 /* Create full path string. */
812 g_string_append_printf(file
->path
, "%s" G_DIR_SEPARATOR_S
"%s",
813 ctf_fs_trace
->path
->str
, basename
);
814 if (!g_file_test(file
->path
->str
, G_FILE_TEST_IS_REGULAR
)) {
815 BT_LOGD("Ignoring non-regular file `%s`",
817 ctf_fs_file_destroy(file
);
822 ret
= ctf_fs_file_open(file
, "rb");
824 BT_LOGE("Cannot open stream file `%s`", file
->path
->str
);
828 if (file
->size
== 0) {
829 /* Skip empty stream. */
830 BT_LOGD("Ignoring empty file `%s`", file
->path
->str
);
831 ctf_fs_file_destroy(file
);
835 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
,
838 BT_LOGE("Cannot add stream file `%s` to stream file group",
840 ctf_fs_file_destroy(file
);
844 ctf_fs_file_destroy(file
);
848 * At this point, DS file groupes are created, but their
849 * associated stream objects do not exist yet. This is because
850 * we need to name the created stream object with the data
851 * stream file's path. We have everything we need here to do
854 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
855 struct ctf_fs_ds_file_group
*ds_file_group
=
856 g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
857 GString
*name
= get_stream_instance_unique_name(ds_file_group
);
863 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
864 /* No stream ID: use 0 */
865 ds_file_group
->stream
= bt_private_stream_create_with_id(
866 ds_file_group
->stream_class
,
867 ctf_fs_trace
->next_stream_id
);
868 ctf_fs_trace
->next_stream_id
++;
870 /* Specific stream ID */
871 ds_file_group
->stream
= bt_private_stream_create_with_id(
872 ds_file_group
->stream_class
,
873 (uint64_t) ds_file_group
->stream_id
);
876 if (!ds_file_group
->stream
) {
877 BT_LOGE("Cannot create stream for DS file group: "
878 "addr=%p, stream-name=\"%s\"",
879 ds_file_group
, name
->str
);
880 g_string_free(name
, TRUE
);
884 ret
= bt_private_stream_set_name(ds_file_group
->stream
,
887 BT_LOGE("Cannot set stream's name: "
888 "addr=%p, stream-name=\"%s\"",
889 ds_file_group
->stream
, name
->str
);
890 g_string_free(name
, TRUE
);
894 g_string_free(name
, TRUE
);
916 struct ctf_fs_trace
*ctf_fs_trace_create(const char *path
, const char *name
,
917 struct ctf_fs_metadata_config
*metadata_config
)
919 struct ctf_fs_trace
*ctf_fs_trace
;
922 ctf_fs_trace
= g_new0(struct ctf_fs_trace
, 1);
927 ctf_fs_trace
->path
= g_string_new(path
);
928 if (!ctf_fs_trace
->path
) {
932 ctf_fs_trace
->name
= g_string_new(name
);
933 if (!ctf_fs_trace
->name
) {
937 ctf_fs_trace
->metadata
= g_new0(struct ctf_fs_metadata
, 1);
938 if (!ctf_fs_trace
->metadata
) {
942 ctf_fs_metadata_init(ctf_fs_trace
->metadata
);
943 ctf_fs_trace
->ds_file_groups
= g_ptr_array_new_with_free_func(
944 (GDestroyNotify
) ctf_fs_ds_file_group_destroy
);
945 if (!ctf_fs_trace
->ds_file_groups
) {
949 ret
= ctf_fs_metadata_set_trace(ctf_fs_trace
, metadata_config
);
954 ret
= create_ds_file_groups(ctf_fs_trace
);
960 * create_ds_file_groups() created all the streams that this
961 * trace needs. There won't be any more. Therefore it is safe to
962 * make this trace static.
964 (void) bt_private_trace_make_static(ctf_fs_trace
->metadata
->trace
);
969 ctf_fs_trace_destroy(ctf_fs_trace
);
977 int path_is_ctf_trace(const char *path
)
979 GString
*metadata_path
= g_string_new(NULL
);
982 if (!metadata_path
) {
987 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
989 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
995 g_string_free(metadata_path
, TRUE
);
1000 int add_trace_path(GList
**trace_paths
, const char *path
)
1002 GString
*norm_path
= NULL
;
1005 norm_path
= bt_common_normalize_path(path
, NULL
);
1007 BT_LOGE("Failed to normalize path `%s`.", path
);
1012 // FIXME: Remove or ifdef for __MINGW32__
1013 if (strcmp(norm_path
->str
, "/") == 0) {
1014 BT_LOGE("Opening a trace in `/` is not supported.");
1019 *trace_paths
= g_list_prepend(*trace_paths
, norm_path
);
1020 BT_ASSERT(*trace_paths
);
1025 g_string_free(norm_path
, TRUE
);
1032 int ctf_fs_find_traces(GList
**trace_paths
, const char *start_path
)
1035 GError
*error
= NULL
;
1037 const char *basename
= NULL
;
1039 /* Check if the starting path is a CTF trace itself */
1040 ret
= path_is_ctf_trace(start_path
);
1047 * Stop recursion: a CTF trace cannot contain another
1050 ret
= add_trace_path(trace_paths
, start_path
);
1054 /* Look for subdirectories */
1055 if (!g_file_test(start_path
, G_FILE_TEST_IS_DIR
)) {
1056 /* Starting path is not a directory: end of recursion */
1060 dir
= g_dir_open(start_path
, 0, &error
);
1062 if (error
->code
== G_FILE_ERROR_ACCES
) {
1063 BT_LOGD("Cannot open directory `%s`: %s (code %d): continuing",
1064 start_path
, error
->message
, error
->code
);
1068 BT_LOGE("Cannot open directory `%s`: %s (code %d)",
1069 start_path
, error
->message
, error
->code
);
1074 while ((basename
= g_dir_read_name(dir
))) {
1075 GString
*sub_path
= g_string_new(NULL
);
1082 g_string_printf(sub_path
, "%s" G_DIR_SEPARATOR_S
"%s", start_path
, basename
);
1083 ret
= ctf_fs_find_traces(trace_paths
, sub_path
->str
);
1084 g_string_free(sub_path
, TRUE
);
1096 g_error_free(error
);
1103 GList
*ctf_fs_create_trace_names(GList
*trace_paths
, const char *base_path
) {
1104 GList
*trace_names
= NULL
;
1106 const char *last_sep
;
1110 * At this point we know that all the trace paths are
1111 * normalized, and so is the base path. This means that
1112 * they are absolute and they don't end with a separator.
1113 * We can simply find the location of the last separator
1114 * in the base path, which gives us the name of the actual
1115 * directory to look into, and use this location as the
1116 * start of each trace name within each trace path.
1120 * Base path: /home/user/my-traces/some-trace
1122 * - /home/user/my-traces/some-trace/host1/trace1
1123 * - /home/user/my-traces/some-trace/host1/trace2
1124 * - /home/user/my-traces/some-trace/host2/trace
1125 * - /home/user/my-traces/some-trace/other-trace
1127 * In this case the trace names are:
1129 * - some-trace/host1/trace1
1130 * - some-trace/host1/trace2
1131 * - some-trace/host2/trace
1132 * - some-trace/other-trace
1134 last_sep
= strrchr(base_path
, G_DIR_SEPARATOR
);
1136 /* We know there's at least one separator */
1137 BT_ASSERT(last_sep
);
1139 /* Distance to base */
1140 base_dist
= last_sep
- base_path
+ 1;
1142 /* Create the trace names */
1143 for (node
= trace_paths
; node
; node
= g_list_next(node
)) {
1144 GString
*trace_name
= g_string_new(NULL
);
1145 GString
*trace_path
= node
->data
;
1147 BT_ASSERT(trace_name
);
1148 g_string_assign(trace_name
, &trace_path
->str
[base_dist
]);
1149 trace_names
= g_list_append(trace_names
, trace_name
);
1156 int create_ctf_fs_traces(struct ctf_fs_component
*ctf_fs
,
1157 const char *path_param
)
1159 struct ctf_fs_trace
*ctf_fs_trace
= NULL
;
1161 GString
*norm_path
= NULL
;
1162 GList
*trace_paths
= NULL
;
1163 GList
*trace_names
= NULL
;
1167 norm_path
= bt_common_normalize_path(path_param
, NULL
);
1169 BT_LOGE("Failed to normalize path: `%s`.",
1174 ret
= ctf_fs_find_traces(&trace_paths
, norm_path
->str
);
1180 BT_LOGE("No CTF traces recursively found in `%s`.",
1185 trace_names
= ctf_fs_create_trace_names(trace_paths
, norm_path
->str
);
1187 BT_LOGE("Cannot create trace names from trace paths.");
1191 for (tp_node
= trace_paths
, tn_node
= trace_names
; tp_node
;
1192 tp_node
= g_list_next(tp_node
),
1193 tn_node
= g_list_next(tn_node
)) {
1194 GString
*trace_path
= tp_node
->data
;
1195 GString
*trace_name
= tn_node
->data
;
1197 ctf_fs_trace
= ctf_fs_trace_create(trace_path
->str
,
1198 trace_name
->str
, &ctf_fs
->metadata_config
);
1199 if (!ctf_fs_trace
) {
1200 BT_LOGE("Cannot create trace for `%s`.",
1205 ret
= create_ports_for_trace(ctf_fs
, ctf_fs_trace
);
1210 g_ptr_array_add(ctf_fs
->traces
, ctf_fs_trace
);
1211 ctf_fs_trace
= NULL
;
1218 ctf_fs_trace_destroy(ctf_fs_trace
);
1221 for (tp_node
= trace_paths
; tp_node
; tp_node
= g_list_next(tp_node
)) {
1222 if (tp_node
->data
) {
1223 g_string_free(tp_node
->data
, TRUE
);
1227 for (tn_node
= trace_names
; tn_node
; tn_node
= g_list_next(tn_node
)) {
1228 if (tn_node
->data
) {
1229 g_string_free(tn_node
->data
, TRUE
);
1234 g_list_free(trace_paths
);
1238 g_list_free(trace_names
);
1242 g_string_free(norm_path
, TRUE
);
1249 struct ctf_fs_component
*ctf_fs_create(struct bt_private_component
*priv_comp
,
1250 struct bt_value
*params
)
1252 struct ctf_fs_component
*ctf_fs
;
1253 struct bt_value
*value
= NULL
;
1254 const char *path_param
;
1255 enum bt_component_status ret
;
1257 ctf_fs
= g_new0(struct ctf_fs_component
, 1);
1262 ret
= bt_private_component_set_user_data(priv_comp
, ctf_fs
);
1263 BT_ASSERT(ret
== BT_COMPONENT_STATUS_OK
);
1266 * We don't need to get a new reference here because as long as
1267 * our private ctf_fs_component object exists, the containing
1268 * private component should also exist.
1270 ctf_fs
->priv_comp
= priv_comp
;
1271 value
= bt_value_map_borrow_entry_value(params
, "path");
1272 if (value
&& !bt_value_is_string(value
)) {
1276 path_param
= bt_value_string_get(value
);
1277 value
= bt_value_map_borrow_entry_value(params
, "clock-class-offset-s");
1279 if (!bt_value_is_integer(value
)) {
1280 BT_LOGE("clock-class-offset-s should be an integer");
1283 ctf_fs
->metadata_config
.clock_class_offset_s
= bt_value_integer_get(value
);
1286 value
= bt_value_map_borrow_entry_value(params
, "clock-class-offset-ns");
1288 if (!bt_value_is_integer(value
)) {
1289 BT_LOGE("clock-class-offset-ns should be an integer");
1292 ctf_fs
->metadata_config
.clock_class_offset_ns
= bt_value_integer_get(value
);
1295 ctf_fs
->port_data
= g_ptr_array_new_with_free_func(port_data_destroy
);
1296 if (!ctf_fs
->port_data
) {
1300 ctf_fs
->traces
= g_ptr_array_new_with_free_func(
1301 ctf_fs_trace_destroy_notifier
);
1302 if (!ctf_fs
->traces
) {
1306 if (create_ctf_fs_traces(ctf_fs
, path_param
)) {
1313 ctf_fs_destroy(ctf_fs
);
1315 ret
= bt_private_component_set_user_data(priv_comp
, NULL
);
1316 BT_ASSERT(ret
== BT_COMPONENT_STATUS_OK
);
1323 enum bt_component_status
ctf_fs_init(struct bt_private_component
*priv_comp
,
1324 struct bt_value
*params
, UNUSED_VAR
void *init_method_data
)
1326 struct ctf_fs_component
*ctf_fs
;
1327 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
1329 ctf_fs
= ctf_fs_create(priv_comp
, params
);
1331 ret
= BT_COMPONENT_STATUS_ERROR
;
1338 struct bt_component_class_query_method_return
ctf_fs_query(
1339 struct bt_component_class
*comp_class
,
1340 struct bt_query_executor
*query_exec
,
1341 const char *object
, struct bt_value
*params
)
1343 struct bt_component_class_query_method_return ret
= {
1345 .status
= BT_QUERY_STATUS_OK
,
1348 if (!strcmp(object
, "metadata-info")) {
1349 ret
= metadata_info_query(comp_class
, params
);
1350 } else if (!strcmp(object
, "trace-info")) {
1351 ret
= trace_info_query(comp_class
, params
);
1353 BT_LOGE("Unknown query object `%s`", object
);
1354 ret
.status
= BT_QUERY_STATUS_INVALID_OBJECT
;