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_self_notification_iterator_status
ctf_fs_iterator_next_one(
92 struct ctf_fs_notif_iter_data
*notif_iter_data
,
93 const struct bt_notification
**notif
)
95 enum bt_self_notification_iterator_status status
;
96 struct bt_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
);
103 if (status
== BT_SELF_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
,
116 BT_ASSERT(status
!= BT_SELF_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_SELF_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_SELF_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_SELF_NOTIFICATION_ITERATOR_STATUS_ERROR
;
160 status
= ctf_fs_ds_file_next(notif_iter_data
->ds_file
, &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_SELF_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
,
188 BT_ASSERT(status
!= BT_SELF_NOTIFICATION_ITERATOR_STATUS_END
);
197 enum bt_self_notification_iterator_status
ctf_fs_iterator_next(
198 struct bt_self_notification_iterator
*iterator
,
199 bt_notification_array_const notifs
, uint64_t capacity
,
202 enum bt_self_notification_iterator_status status
=
203 BT_SELF_NOTIFICATION_ITERATOR_STATUS_OK
;
204 struct ctf_fs_notif_iter_data
*notif_iter_data
=
205 bt_self_notification_iterator_get_data(iterator
);
208 while (i
< capacity
&& status
== BT_SELF_NOTIFICATION_ITERATOR_STATUS_OK
) {
209 status
= ctf_fs_iterator_next_one(notif_iter_data
, ¬ifs
[i
]);
210 if (status
== BT_SELF_NOTIFICATION_ITERATOR_STATUS_OK
) {
217 * Even if ctf_fs_iterator_next_one() returned something
218 * else than BT_SELF_NOTIFICATION_ITERATOR_STATUS_OK, we
219 * accumulated notification objects in the output
220 * notification array, so we need to return
221 * BT_SELF_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_SELF_NOTIFICATION_ITERATOR_STATUS_OK
;
234 void ctf_fs_iterator_finalize(struct bt_self_notification_iterator
*it
)
236 ctf_fs_notif_iter_data_destroy(
237 bt_self_notification_iterator_get_data(it
));
240 enum bt_self_notification_iterator_status
ctf_fs_iterator_init(
241 struct bt_self_notification_iterator
*self_notif_iter
,
242 struct bt_self_component_source
*self_comp
,
243 struct bt_self_component_port_output
*self_port
)
245 struct ctf_fs_port_data
*port_data
;
246 struct ctf_fs_notif_iter_data
*notif_iter_data
= NULL
;
247 enum bt_self_notification_iterator_status ret
=
248 BT_SELF_NOTIFICATION_ITERATOR_STATUS_OK
;
251 port_data
= bt_self_component_port_get_data(
252 bt_self_component_port_output_as_self_component_port(
254 BT_ASSERT(port_data
);
255 notif_iter_data
= g_new0(struct ctf_fs_notif_iter_data
, 1);
256 if (!notif_iter_data
) {
257 ret
= BT_SELF_NOTIFICATION_ITERATOR_STATUS_NOMEM
;
261 notif_iter_data
->pc_notif_iter
= self_notif_iter
;
262 notif_iter_data
->notif_iter
= bt_notif_iter_create(
263 port_data
->ds_file_group
->ctf_fs_trace
->metadata
->tc
,
264 bt_common_get_page_size() * 8,
265 ctf_fs_ds_file_medops
, NULL
);
266 if (!notif_iter_data
->notif_iter
) {
267 BT_LOGE_STR("Cannot create a CTF notification iterator.");
268 ret
= BT_SELF_NOTIFICATION_ITERATOR_STATUS_NOMEM
;
272 notif_iter_data
->ds_file_group
= port_data
->ds_file_group
;
273 iret
= notif_iter_data_set_current_ds_file(notif_iter_data
);
275 ret
= BT_SELF_NOTIFICATION_ITERATOR_STATUS_ERROR
;
279 bt_self_notification_iterator_set_data(self_notif_iter
,
281 if (ret
!= BT_SELF_NOTIFICATION_ITERATOR_STATUS_OK
) {
285 notif_iter_data
= NULL
;
289 bt_self_notification_iterator_set_data(self_notif_iter
, NULL
);
292 ctf_fs_notif_iter_data_destroy(notif_iter_data
);
297 void ctf_fs_destroy(struct ctf_fs_component
*ctf_fs
)
303 if (ctf_fs
->traces
) {
304 g_ptr_array_free(ctf_fs
->traces
, TRUE
);
307 if (ctf_fs
->port_data
) {
308 g_ptr_array_free(ctf_fs
->port_data
, TRUE
);
315 void ctf_fs_trace_destroy(struct ctf_fs_trace
*ctf_fs_trace
)
321 if (ctf_fs_trace
->ds_file_groups
) {
322 g_ptr_array_free(ctf_fs_trace
->ds_file_groups
, TRUE
);
325 BT_OBJECT_PUT_REF_AND_RESET(ctf_fs_trace
->trace
);
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_self_component_source
*component
)
352 ctf_fs_destroy(bt_self_component_get_data(
353 bt_self_component_source_as_self_component(component
)));
357 void port_data_destroy(void *data
) {
358 struct ctf_fs_port_data
*port_data
= data
;
368 GString
*get_stream_instance_unique_name(
369 struct ctf_fs_ds_file_group
*ds_file_group
)
372 struct ctf_fs_ds_file_info
*ds_file_info
;
374 name
= g_string_new(NULL
);
380 * If there's more than one stream file in the stream file
381 * group, the first (earliest) stream file's path is used as
382 * the stream's unique name.
384 BT_ASSERT(ds_file_group
->ds_file_infos
->len
> 0);
385 ds_file_info
= g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
386 g_string_assign(name
, ds_file_info
->path
->str
);
393 int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
394 struct ctf_fs_trace
*ctf_fs_trace
,
395 struct ctf_fs_ds_file_group
*ds_file_group
)
398 struct ctf_fs_port_data
*port_data
= NULL
;
399 GString
*port_name
= NULL
;
401 port_name
= get_stream_instance_unique_name(ds_file_group
);
406 BT_LOGD("Creating one port named `%s`", port_name
->str
);
408 /* Create output port for this file */
409 port_data
= g_new0(struct ctf_fs_port_data
, 1);
414 port_data
->ctf_fs
= ctf_fs
;
415 port_data
->ds_file_group
= ds_file_group
;
416 ret
= bt_self_component_source_add_output_port(
417 ctf_fs
->self_comp
, port_name
->str
, port_data
, NULL
);
422 g_ptr_array_add(ctf_fs
->port_data
, port_data
);
431 g_string_free(port_name
, TRUE
);
434 port_data_destroy(port_data
);
439 int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
440 struct ctf_fs_trace
*ctf_fs_trace
)
445 /* Create one output port for each stream file group */
446 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
447 struct ctf_fs_ds_file_group
*ds_file_group
=
448 g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
450 ret
= create_one_port_for_trace(ctf_fs
, ctf_fs_trace
,
453 BT_LOGE("Cannot create output port.");
463 void ctf_fs_ds_file_info_destroy(struct ctf_fs_ds_file_info
*ds_file_info
)
469 if (ds_file_info
->path
) {
470 g_string_free(ds_file_info
->path
, TRUE
);
473 ctf_fs_ds_index_destroy(ds_file_info
->index
);
474 g_free(ds_file_info
);
478 struct ctf_fs_ds_file_info
*ctf_fs_ds_file_info_create(const char *path
,
479 int64_t begin_ns
, struct ctf_fs_ds_index
*index
)
481 struct ctf_fs_ds_file_info
*ds_file_info
;
483 ds_file_info
= g_new0(struct ctf_fs_ds_file_info
, 1);
488 ds_file_info
->path
= g_string_new(path
);
489 if (!ds_file_info
->path
) {
490 ctf_fs_ds_file_info_destroy(ds_file_info
);
495 ds_file_info
->begin_ns
= begin_ns
;
496 ds_file_info
->index
= index
;
500 ctf_fs_ds_index_destroy(index
);
505 void ctf_fs_ds_file_group_destroy(struct ctf_fs_ds_file_group
*ds_file_group
)
507 if (!ds_file_group
) {
511 if (ds_file_group
->ds_file_infos
) {
512 g_ptr_array_free(ds_file_group
->ds_file_infos
, TRUE
);
515 bt_object_put_ref(ds_file_group
->stream
);
516 bt_object_put_ref(ds_file_group
->stream_class
);
517 g_free(ds_file_group
);
521 struct ctf_fs_ds_file_group
*ctf_fs_ds_file_group_create(
522 struct ctf_fs_trace
*ctf_fs_trace
,
523 struct bt_stream_class
*stream_class
,
524 uint64_t stream_instance_id
)
526 struct ctf_fs_ds_file_group
*ds_file_group
;
528 ds_file_group
= g_new0(struct ctf_fs_ds_file_group
, 1);
529 if (!ds_file_group
) {
533 ds_file_group
->ds_file_infos
= g_ptr_array_new_with_free_func(
534 (GDestroyNotify
) ctf_fs_ds_file_info_destroy
);
535 if (!ds_file_group
->ds_file_infos
) {
539 ds_file_group
->stream_id
= stream_instance_id
;
540 BT_ASSERT(stream_class
);
541 ds_file_group
->stream_class
= stream_class
;
542 bt_object_get_ref(ds_file_group
->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_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 sc
->default_clock_class
,
664 props
.snapshots
.beginning_clock
, &begin_ns
);
666 BT_LOGE("Cannot convert clock cycles to nanoseconds from origin (`%s`).",
672 index
= ctf_fs_ds_file_build_index(ds_file
);
674 BT_LOGW("Failed to index CTF stream file \'%s\'",
675 ds_file
->file
->path
->str
);
678 if (begin_ns
== -1) {
680 * No beggining timestamp to sort the stream files
681 * within a stream file group, so consider that this
682 * file must be the only one within its group.
684 stream_instance_id
= -1;
687 if (stream_instance_id
== -1) {
689 * No stream instance ID or no beginning timestamp:
690 * create a unique stream file group for this stream
691 * file because, even if there's a stream instance ID,
692 * there's no timestamp to order the file within its
695 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
,
696 stream_class
, stream_instance_id
);
697 if (!ds_file_group
) {
701 ret
= ctf_fs_ds_file_group_add_ds_file_info(ds_file_group
,
702 path
, begin_ns
, index
);
703 /* Ownership of index is transferred. */
713 BT_ASSERT(stream_instance_id
!= -1);
714 BT_ASSERT(begin_ns
!= -1);
716 /* Find an existing stream file group with this ID */
717 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
718 ds_file_group
= g_ptr_array_index(
719 ctf_fs_trace
->ds_file_groups
, i
);
721 if (ds_file_group
->stream_class
== stream_class
&&
722 ds_file_group
->stream_id
==
723 stream_instance_id
) {
727 ds_file_group
= NULL
;
730 if (!ds_file_group
) {
731 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
,
732 stream_class
, stream_instance_id
);
733 if (!ds_file_group
) {
740 ret
= ctf_fs_ds_file_group_add_ds_file_info(ds_file_group
, path
,
750 ctf_fs_ds_file_group_destroy(ds_file_group
);
754 if (add_group
&& ds_file_group
) {
755 g_ptr_array_add(ctf_fs_trace
->ds_file_groups
, ds_file_group
);
758 ctf_fs_ds_file_destroy(ds_file
);
761 bt_notif_iter_destroy(notif_iter
);
764 ctf_fs_ds_index_destroy(index
);
769 int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
772 const char *basename
;
773 GError
*error
= NULL
;
777 /* Check each file in the path directory, except specific ones */
778 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
780 BT_LOGE("Cannot open directory `%s`: %s (code %d)",
781 ctf_fs_trace
->path
->str
, error
->message
,
786 while ((basename
= g_dir_read_name(dir
))) {
787 struct ctf_fs_file
*file
;
789 if (!strcmp(basename
, CTF_FS_METADATA_FILENAME
)) {
790 /* Ignore the metadata stream. */
791 BT_LOGD("Ignoring metadata file `%s" G_DIR_SEPARATOR_S
"%s`",
792 ctf_fs_trace
->path
->str
, basename
);
796 if (basename
[0] == '.') {
797 BT_LOGD("Ignoring hidden file `%s" G_DIR_SEPARATOR_S
"%s`",
798 ctf_fs_trace
->path
->str
, basename
);
802 /* Create the file. */
803 file
= ctf_fs_file_create();
805 BT_LOGE("Cannot create stream file object for file `%s" G_DIR_SEPARATOR_S
"%s`",
806 ctf_fs_trace
->path
->str
, basename
);
810 /* Create full path string. */
811 g_string_append_printf(file
->path
, "%s" G_DIR_SEPARATOR_S
"%s",
812 ctf_fs_trace
->path
->str
, basename
);
813 if (!g_file_test(file
->path
->str
, G_FILE_TEST_IS_REGULAR
)) {
814 BT_LOGD("Ignoring non-regular file `%s`",
816 ctf_fs_file_destroy(file
);
821 ret
= ctf_fs_file_open(file
, "rb");
823 BT_LOGE("Cannot open stream file `%s`", file
->path
->str
);
827 if (file
->size
== 0) {
828 /* Skip empty stream. */
829 BT_LOGD("Ignoring empty file `%s`", file
->path
->str
);
830 ctf_fs_file_destroy(file
);
834 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
,
837 BT_LOGE("Cannot add stream file `%s` to stream file group",
839 ctf_fs_file_destroy(file
);
843 ctf_fs_file_destroy(file
);
847 * At this point, DS file groupes are created, but their
848 * associated stream objects do not exist yet. This is because
849 * we need to name the created stream object with the data
850 * stream file's path. We have everything we need here to do
853 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
854 struct ctf_fs_ds_file_group
*ds_file_group
=
855 g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
856 GString
*name
= get_stream_instance_unique_name(ds_file_group
);
862 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
863 /* No stream ID: use 0 */
864 ds_file_group
->stream
= bt_stream_create_with_id(
865 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_stream_create_with_id(
872 ds_file_group
->stream_class
,
874 (uint64_t) ds_file_group
->stream_id
);
877 if (!ds_file_group
->stream
) {
878 BT_LOGE("Cannot create stream for DS file group: "
879 "addr=%p, stream-name=\"%s\"",
880 ds_file_group
, name
->str
);
881 g_string_free(name
, TRUE
);
885 ret
= bt_stream_set_name(ds_file_group
->stream
,
888 BT_LOGE("Cannot set stream's name: "
889 "addr=%p, stream-name=\"%s\"",
890 ds_file_group
->stream
, name
->str
);
891 g_string_free(name
, TRUE
);
895 g_string_free(name
, TRUE
);
917 int set_trace_name(struct bt_trace
*trace
, const char *name_suffix
)
920 const struct bt_trace_class
*tc
= bt_trace_borrow_class_const(trace
);
921 const struct bt_value
*val
;
924 name
= g_string_new(NULL
);
926 BT_LOGE_STR("Failed to allocate a GString.");
932 * Check if we have a trace environment string value named `hostname`.
933 * If so, use it as the trace name's prefix.
935 val
= bt_trace_class_borrow_environment_entry_value_by_name_const(
937 if (val
&& bt_value_is_string(val
)) {
938 g_string_append(name
, bt_value_string_get(val
));
941 g_string_append_c(name
, G_DIR_SEPARATOR
);
946 g_string_append(name
, name_suffix
);
949 ret
= bt_trace_set_name(trace
, name
->str
);
958 g_string_free(name
, TRUE
);
965 struct ctf_fs_trace
*ctf_fs_trace_create(const char *path
, const char *name
,
966 struct ctf_fs_metadata_config
*metadata_config
)
968 struct ctf_fs_trace
*ctf_fs_trace
;
971 ctf_fs_trace
= g_new0(struct ctf_fs_trace
, 1);
976 ctf_fs_trace
->path
= g_string_new(path
);
977 if (!ctf_fs_trace
->path
) {
981 ctf_fs_trace
->name
= g_string_new(name
);
982 if (!ctf_fs_trace
->name
) {
986 ctf_fs_trace
->metadata
= g_new0(struct ctf_fs_metadata
, 1);
987 if (!ctf_fs_trace
->metadata
) {
991 ctf_fs_metadata_init(ctf_fs_trace
->metadata
);
992 ctf_fs_trace
->ds_file_groups
= g_ptr_array_new_with_free_func(
993 (GDestroyNotify
) ctf_fs_ds_file_group_destroy
);
994 if (!ctf_fs_trace
->ds_file_groups
) {
998 ret
= ctf_fs_metadata_set_trace_class(ctf_fs_trace
, metadata_config
);
1003 ctf_fs_trace
->trace
=
1004 bt_trace_create(ctf_fs_trace
->metadata
->trace_class
);
1005 if (!ctf_fs_trace
->trace
) {
1009 ret
= set_trace_name(ctf_fs_trace
->trace
, name
);
1014 ret
= create_ds_file_groups(ctf_fs_trace
);
1020 * create_ds_file_groups() created all the streams that this
1021 * trace needs. There won't be any more. Therefore it is safe to
1022 * make this trace static.
1024 (void) bt_trace_make_static(ctf_fs_trace
->trace
);
1029 ctf_fs_trace_destroy(ctf_fs_trace
);
1030 ctf_fs_trace
= NULL
;
1033 return ctf_fs_trace
;
1037 int path_is_ctf_trace(const char *path
)
1039 GString
*metadata_path
= g_string_new(NULL
);
1042 if (!metadata_path
) {
1047 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
1049 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
1055 g_string_free(metadata_path
, TRUE
);
1060 int add_trace_path(GList
**trace_paths
, const char *path
)
1062 GString
*norm_path
= NULL
;
1065 norm_path
= bt_common_normalize_path(path
, NULL
);
1067 BT_LOGE("Failed to normalize path `%s`.", path
);
1072 // FIXME: Remove or ifdef for __MINGW32__
1073 if (strcmp(norm_path
->str
, "/") == 0) {
1074 BT_LOGE("Opening a trace in `/` is not supported.");
1079 *trace_paths
= g_list_prepend(*trace_paths
, norm_path
);
1080 BT_ASSERT(*trace_paths
);
1085 g_string_free(norm_path
, TRUE
);
1092 int ctf_fs_find_traces(GList
**trace_paths
, const char *start_path
)
1095 GError
*error
= NULL
;
1097 const char *basename
= NULL
;
1099 /* Check if the starting path is a CTF trace itself */
1100 ret
= path_is_ctf_trace(start_path
);
1107 * Stop recursion: a CTF trace cannot contain another
1110 ret
= add_trace_path(trace_paths
, start_path
);
1114 /* Look for subdirectories */
1115 if (!g_file_test(start_path
, G_FILE_TEST_IS_DIR
)) {
1116 /* Starting path is not a directory: end of recursion */
1120 dir
= g_dir_open(start_path
, 0, &error
);
1122 if (error
->code
== G_FILE_ERROR_ACCES
) {
1123 BT_LOGD("Cannot open directory `%s`: %s (code %d): continuing",
1124 start_path
, error
->message
, error
->code
);
1128 BT_LOGE("Cannot open directory `%s`: %s (code %d)",
1129 start_path
, error
->message
, error
->code
);
1134 while ((basename
= g_dir_read_name(dir
))) {
1135 GString
*sub_path
= g_string_new(NULL
);
1142 g_string_printf(sub_path
, "%s" G_DIR_SEPARATOR_S
"%s", start_path
, basename
);
1143 ret
= ctf_fs_find_traces(trace_paths
, sub_path
->str
);
1144 g_string_free(sub_path
, TRUE
);
1156 g_error_free(error
);
1163 GList
*ctf_fs_create_trace_names(GList
*trace_paths
, const char *base_path
) {
1164 GList
*trace_names
= NULL
;
1166 const char *last_sep
;
1170 * At this point we know that all the trace paths are
1171 * normalized, and so is the base path. This means that
1172 * they are absolute and they don't end with a separator.
1173 * We can simply find the location of the last separator
1174 * in the base path, which gives us the name of the actual
1175 * directory to look into, and use this location as the
1176 * start of each trace name within each trace path.
1180 * Base path: /home/user/my-traces/some-trace
1182 * - /home/user/my-traces/some-trace/host1/trace1
1183 * - /home/user/my-traces/some-trace/host1/trace2
1184 * - /home/user/my-traces/some-trace/host2/trace
1185 * - /home/user/my-traces/some-trace/other-trace
1187 * In this case the trace names are:
1189 * - some-trace/host1/trace1
1190 * - some-trace/host1/trace2
1191 * - some-trace/host2/trace
1192 * - some-trace/other-trace
1194 last_sep
= strrchr(base_path
, G_DIR_SEPARATOR
);
1196 /* We know there's at least one separator */
1197 BT_ASSERT(last_sep
);
1199 /* Distance to base */
1200 base_dist
= last_sep
- base_path
+ 1;
1202 /* Create the trace names */
1203 for (node
= trace_paths
; node
; node
= g_list_next(node
)) {
1204 GString
*trace_name
= g_string_new(NULL
);
1205 GString
*trace_path
= node
->data
;
1207 BT_ASSERT(trace_name
);
1208 g_string_assign(trace_name
, &trace_path
->str
[base_dist
]);
1209 trace_names
= g_list_append(trace_names
, trace_name
);
1216 int create_ctf_fs_traces(struct ctf_fs_component
*ctf_fs
,
1217 const char *path_param
)
1219 struct ctf_fs_trace
*ctf_fs_trace
= NULL
;
1221 GString
*norm_path
= NULL
;
1222 GList
*trace_paths
= NULL
;
1223 GList
*trace_names
= NULL
;
1227 norm_path
= bt_common_normalize_path(path_param
, NULL
);
1229 BT_LOGE("Failed to normalize path: `%s`.",
1234 ret
= ctf_fs_find_traces(&trace_paths
, norm_path
->str
);
1240 BT_LOGE("No CTF traces recursively found in `%s`.",
1245 trace_names
= ctf_fs_create_trace_names(trace_paths
, norm_path
->str
);
1247 BT_LOGE("Cannot create trace names from trace paths.");
1251 for (tp_node
= trace_paths
, tn_node
= trace_names
; tp_node
;
1252 tp_node
= g_list_next(tp_node
),
1253 tn_node
= g_list_next(tn_node
)) {
1254 GString
*trace_path
= tp_node
->data
;
1255 GString
*trace_name
= tn_node
->data
;
1257 ctf_fs_trace
= ctf_fs_trace_create(trace_path
->str
,
1258 trace_name
->str
, &ctf_fs
->metadata_config
);
1259 if (!ctf_fs_trace
) {
1260 BT_LOGE("Cannot create trace for `%s`.",
1265 ret
= create_ports_for_trace(ctf_fs
, ctf_fs_trace
);
1270 g_ptr_array_add(ctf_fs
->traces
, ctf_fs_trace
);
1271 ctf_fs_trace
= NULL
;
1278 ctf_fs_trace_destroy(ctf_fs_trace
);
1281 for (tp_node
= trace_paths
; tp_node
; tp_node
= g_list_next(tp_node
)) {
1282 if (tp_node
->data
) {
1283 g_string_free(tp_node
->data
, TRUE
);
1287 for (tn_node
= trace_names
; tn_node
; tn_node
= g_list_next(tn_node
)) {
1288 if (tn_node
->data
) {
1289 g_string_free(tn_node
->data
, TRUE
);
1294 g_list_free(trace_paths
);
1298 g_list_free(trace_names
);
1302 g_string_free(norm_path
, TRUE
);
1309 struct ctf_fs_component
*ctf_fs_create(
1310 struct bt_self_component_source
*self_comp
,
1311 const struct bt_value
*params
)
1313 struct ctf_fs_component
*ctf_fs
;
1314 const struct bt_value
*value
= NULL
;
1315 const char *path_param
;
1317 ctf_fs
= g_new0(struct ctf_fs_component
, 1);
1322 bt_self_component_set_data(
1323 bt_self_component_source_as_self_component(self_comp
),
1327 * We don't need to get a new reference here because as long as
1328 * our private ctf_fs_component object exists, the containing
1329 * private component should also exist.
1331 ctf_fs
->self_comp
= self_comp
;
1332 value
= bt_value_map_borrow_entry_value_const(params
, "path");
1333 if (value
&& !bt_value_is_string(value
)) {
1337 path_param
= bt_value_string_get(value
);
1338 value
= bt_value_map_borrow_entry_value_const(params
,
1339 "clock-class-offset-s");
1341 if (!bt_value_is_integer(value
)) {
1342 BT_LOGE("clock-class-offset-s should be an integer");
1345 ctf_fs
->metadata_config
.clock_class_offset_s
= bt_value_integer_get(value
);
1348 value
= bt_value_map_borrow_entry_value_const(params
,
1349 "clock-class-offset-ns");
1351 if (!bt_value_is_integer(value
)) {
1352 BT_LOGE("clock-class-offset-ns should be an integer");
1355 ctf_fs
->metadata_config
.clock_class_offset_ns
= bt_value_integer_get(value
);
1358 ctf_fs
->port_data
= g_ptr_array_new_with_free_func(port_data_destroy
);
1359 if (!ctf_fs
->port_data
) {
1363 ctf_fs
->traces
= g_ptr_array_new_with_free_func(
1364 ctf_fs_trace_destroy_notifier
);
1365 if (!ctf_fs
->traces
) {
1369 if (create_ctf_fs_traces(ctf_fs
, path_param
)) {
1376 ctf_fs_destroy(ctf_fs
);
1378 bt_self_component_set_data(
1379 bt_self_component_source_as_self_component(self_comp
),
1387 enum bt_self_component_status
ctf_fs_init(
1388 struct bt_self_component_source
*self_comp
,
1389 const struct bt_value
*params
, UNUSED_VAR
void *init_method_data
)
1391 struct ctf_fs_component
*ctf_fs
;
1392 enum bt_self_component_status ret
= BT_SELF_COMPONENT_STATUS_OK
;
1394 ctf_fs
= ctf_fs_create(self_comp
, params
);
1396 ret
= BT_SELF_COMPONENT_STATUS_ERROR
;
1403 enum bt_query_status
ctf_fs_query(
1404 struct bt_self_component_class_source
*comp_class
,
1405 const struct bt_query_executor
*query_exec
,
1406 const char *object
, const struct bt_value
*params
,
1407 const struct bt_value
**result
)
1409 enum bt_query_status status
= BT_QUERY_STATUS_OK
;
1411 if (!strcmp(object
, "metadata-info")) {
1412 status
= metadata_info_query(comp_class
, params
, result
);
1413 } else if (!strcmp(object
, "trace-info")) {
1414 status
= trace_info_query(comp_class
, params
, result
);
1416 BT_LOGE("Unknown query object `%s`", object
);
1417 status
= BT_QUERY_STATUS_INVALID_OBJECT
;