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
->graph
,
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
);
90 struct bt_notification_iterator_next_method_return
ctf_fs_iterator_next(
91 struct bt_private_connection_private_notification_iterator
*iterator
)
93 struct bt_notification_iterator_next_method_return next_ret
;
94 struct ctf_fs_notif_iter_data
*notif_iter_data
=
95 bt_private_connection_private_notification_iterator_get_user_data(iterator
);
98 BT_ASSERT(notif_iter_data
->ds_file
);
99 next_ret
= ctf_fs_ds_file_next(notif_iter_data
->ds_file
);
101 if (next_ret
.status
== BT_NOTIFICATION_ITERATOR_STATUS_OK
&&
102 bt_notification_get_type(next_ret
.notification
) ==
103 BT_NOTIFICATION_TYPE_STREAM_BEGIN
) {
104 if (notif_iter_data
->skip_stream_begin_notifs
) {
106 * We already emitted a
107 * BT_NOTIFICATION_TYPE_STREAM_BEGIN
108 * notification: skip this one, get a new one.
110 BT_PUT(next_ret
.notification
);
111 next_ret
= ctf_fs_ds_file_next(notif_iter_data
->ds_file
);
112 BT_ASSERT(next_ret
.status
!= BT_NOTIFICATION_ITERATOR_STATUS_END
);
116 * First BT_NOTIFICATION_TYPE_STREAM_BEGIN
117 * notification: skip all following.
119 notif_iter_data
->skip_stream_begin_notifs
= true;
124 if (next_ret
.status
== BT_NOTIFICATION_ITERATOR_STATUS_OK
&&
125 bt_notification_get_type(next_ret
.notification
) ==
126 BT_NOTIFICATION_TYPE_STREAM_END
) {
127 notif_iter_data
->ds_file_info_index
++;
129 if (notif_iter_data
->ds_file_info_index
==
130 notif_iter_data
->ds_file_group
->ds_file_infos
->len
) {
132 * No more stream files to read: we reached the
133 * real end. Emit this
134 * BT_NOTIFICATION_TYPE_STREAM_END notification.
135 * The next time ctf_fs_iterator_next() is
136 * called for this notification iterator,
137 * ctf_fs_ds_file_next() will return
138 * BT_NOTIFICATION_ITERATOR_STATUS_END().
143 BT_PUT(next_ret
.notification
);
144 bt_notif_iter_reset(notif_iter_data
->notif_iter
);
147 * Open and start reading the next stream file within
148 * our stream file group.
150 ret
= notif_iter_data_set_current_ds_file(notif_iter_data
);
152 next_ret
.status
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
156 next_ret
= ctf_fs_ds_file_next(notif_iter_data
->ds_file
);
159 * If we get a notification, we expect to get a
160 * BT_NOTIFICATION_TYPE_STREAM_BEGIN notification
161 * because the iterator's state machine emits one before
162 * even requesting the first block of data from the
163 * medium. Skip this notification because we're not
164 * really starting a new stream here, and try getting a
165 * new notification (which, if it works, is a
166 * BT_NOTIFICATION_TYPE_PACKET_BEGIN one). We're sure to
167 * get at least one pair of
168 * BT_NOTIFICATION_TYPE_PACKET_BEGIN and
169 * BT_NOTIFICATION_TYPE_PACKET_END notifications in the
170 * case of a single, empty packet. We know there's at
171 * least one packet because the stream file group does
172 * not contain empty stream files.
174 BT_ASSERT(notif_iter_data
->skip_stream_begin_notifs
);
176 if (next_ret
.status
== BT_NOTIFICATION_ITERATOR_STATUS_OK
) {
177 BT_ASSERT(bt_notification_get_type(next_ret
.notification
) ==
178 BT_NOTIFICATION_TYPE_STREAM_BEGIN
);
179 BT_PUT(next_ret
.notification
);
180 next_ret
= ctf_fs_ds_file_next(notif_iter_data
->ds_file
);
181 BT_ASSERT(next_ret
.status
!= BT_NOTIFICATION_ITERATOR_STATUS_END
);
189 void ctf_fs_iterator_finalize(struct bt_private_connection_private_notification_iterator
*it
)
191 void *notif_iter_data
=
192 bt_private_connection_private_notification_iterator_get_user_data(it
);
194 ctf_fs_notif_iter_data_destroy(notif_iter_data
);
197 enum bt_notification_iterator_status
ctf_fs_iterator_init(
198 struct bt_private_connection_private_notification_iterator
*it
,
199 struct bt_private_port
*port
)
201 struct ctf_fs_port_data
*port_data
;
202 struct ctf_fs_notif_iter_data
*notif_iter_data
= NULL
;
203 enum bt_notification_iterator_status ret
=
204 BT_NOTIFICATION_ITERATOR_STATUS_OK
;
207 port_data
= bt_private_port_get_user_data(port
);
209 ret
= BT_NOTIFICATION_ITERATOR_STATUS_INVALID
;
213 notif_iter_data
= g_new0(struct ctf_fs_notif_iter_data
, 1);
214 if (!notif_iter_data
) {
215 ret
= BT_NOTIFICATION_ITERATOR_STATUS_NOMEM
;
219 notif_iter_data
->graph
= bt_component_borrow_graph(
220 bt_component_borrow_from_private(port_data
->ctf_fs
->priv_comp
));
221 notif_iter_data
->notif_iter
= bt_notif_iter_create(
222 port_data
->ds_file_group
->ctf_fs_trace
->metadata
->trace
,
223 bt_common_get_page_size() * 8,
224 ctf_fs_ds_file_medops
, NULL
);
225 if (!notif_iter_data
->notif_iter
) {
226 BT_LOGE_STR("Cannot create a CTF notification iterator.");
227 ret
= BT_NOTIFICATION_ITERATOR_STATUS_NOMEM
;
231 notif_iter_data
->ds_file_group
= port_data
->ds_file_group
;
232 iret
= notif_iter_data_set_current_ds_file(notif_iter_data
);
234 ret
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
238 ret
= bt_private_connection_private_notification_iterator_set_user_data(it
, notif_iter_data
);
239 if (ret
!= BT_NOTIFICATION_ITERATOR_STATUS_OK
) {
243 notif_iter_data
= NULL
;
247 (void) bt_private_connection_private_notification_iterator_set_user_data(it
, NULL
);
250 ctf_fs_notif_iter_data_destroy(notif_iter_data
);
255 void ctf_fs_destroy(struct ctf_fs_component
*ctf_fs
)
261 if (ctf_fs
->traces
) {
262 g_ptr_array_free(ctf_fs
->traces
, TRUE
);
265 if (ctf_fs
->port_data
) {
266 g_ptr_array_free(ctf_fs
->port_data
, TRUE
);
273 void ctf_fs_trace_destroy(struct ctf_fs_trace
*ctf_fs_trace
)
279 if (ctf_fs_trace
->ds_file_groups
) {
280 g_ptr_array_free(ctf_fs_trace
->ds_file_groups
, TRUE
);
283 if (ctf_fs_trace
->path
) {
284 g_string_free(ctf_fs_trace
->path
, TRUE
);
287 if (ctf_fs_trace
->name
) {
288 g_string_free(ctf_fs_trace
->name
, TRUE
);
291 if (ctf_fs_trace
->metadata
) {
292 ctf_fs_metadata_fini(ctf_fs_trace
->metadata
);
293 g_free(ctf_fs_trace
->metadata
);
296 bt_put(ctf_fs_trace
->cc_prio_map
);
297 g_free(ctf_fs_trace
);
301 void ctf_fs_trace_destroy_notifier(void *data
)
303 struct ctf_fs_trace
*trace
= data
;
304 ctf_fs_trace_destroy(trace
);
307 void ctf_fs_finalize(struct bt_private_component
*component
)
309 void *data
= bt_private_component_get_user_data(component
);
311 ctf_fs_destroy(data
);
315 void port_data_destroy(void *data
) {
316 struct ctf_fs_port_data
*port_data
= data
;
326 GString
*get_stream_instance_unique_name(
327 struct ctf_fs_ds_file_group
*ds_file_group
)
330 struct ctf_fs_ds_file_info
*ds_file_info
;
332 name
= g_string_new(NULL
);
338 * If there's more than one stream file in the stream file
339 * group, the first (earliest) stream file's path is used as
340 * the stream's unique name.
342 BT_ASSERT(ds_file_group
->ds_file_infos
->len
> 0);
343 ds_file_info
= g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
344 g_string_assign(name
, ds_file_info
->path
->str
);
351 int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
352 struct ctf_fs_trace
*ctf_fs_trace
,
353 struct ctf_fs_ds_file_group
*ds_file_group
)
356 struct ctf_fs_port_data
*port_data
= NULL
;
357 GString
*port_name
= NULL
;
359 port_name
= get_stream_instance_unique_name(ds_file_group
);
364 BT_LOGD("Creating one port named `%s`", port_name
->str
);
366 /* Create output port for this file */
367 port_data
= g_new0(struct ctf_fs_port_data
, 1);
372 port_data
->ctf_fs
= ctf_fs
;
373 port_data
->ds_file_group
= ds_file_group
;
374 ret
= bt_private_component_source_add_output_private_port(
375 ctf_fs
->priv_comp
, port_name
->str
, port_data
, NULL
);
380 g_ptr_array_add(ctf_fs
->port_data
, port_data
);
389 g_string_free(port_name
, TRUE
);
392 port_data_destroy(port_data
);
397 int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
398 struct ctf_fs_trace
*ctf_fs_trace
)
403 /* Create one output port for each stream file group */
404 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
405 struct ctf_fs_ds_file_group
*ds_file_group
=
406 g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
408 ret
= create_one_port_for_trace(ctf_fs
, ctf_fs_trace
,
411 BT_LOGE("Cannot create output port.");
421 uint64_t get_packet_header_stream_instance_id(struct ctf_fs_trace
*ctf_fs_trace
,
422 struct bt_field
*packet_header_field
)
424 struct bt_field
*stream_instance_id_field
= NULL
;
425 uint64_t stream_instance_id
= -1ULL;
428 if (!packet_header_field
) {
432 stream_instance_id_field
= bt_field_structure_borrow_field_by_name(
433 packet_header_field
, "stream_instance_id");
434 if (!stream_instance_id_field
) {
438 ret
= bt_field_integer_unsigned_get_value(stream_instance_id_field
,
439 &stream_instance_id
);
441 stream_instance_id
= -1ULL;
446 return stream_instance_id
;
449 uint64_t get_packet_context_timestamp_begin_ns(
450 struct ctf_fs_trace
*ctf_fs_trace
,
451 struct bt_field
*packet_context_field
)
454 struct bt_field
*timestamp_begin_field
= NULL
;
455 struct bt_field_type
*timestamp_begin_ft
= NULL
;
456 uint64_t timestamp_begin_raw_value
= -1ULL;
457 uint64_t timestamp_begin_ns
= -1ULL;
458 int64_t timestamp_begin_ns_signed
;
459 struct bt_clock_class
*timestamp_begin_clock_class
= NULL
;
461 if (!packet_context_field
) {
465 timestamp_begin_field
= bt_field_structure_borrow_field_by_name(
466 packet_context_field
, "timestamp_begin");
467 if (!timestamp_begin_field
) {
471 timestamp_begin_ft
= bt_field_borrow_type(timestamp_begin_field
);
472 BT_ASSERT(timestamp_begin_ft
);
473 timestamp_begin_clock_class
=
474 bt_field_type_integer_borrow_mapped_clock_class(timestamp_begin_ft
);
475 if (!timestamp_begin_clock_class
) {
479 ret
= bt_field_integer_unsigned_get_value(timestamp_begin_field
,
480 ×tamp_begin_raw_value
);
485 ret
= bt_clock_class_cycles_to_ns(timestamp_begin_clock_class
,
486 timestamp_begin_raw_value
, ×tamp_begin_ns_signed
);
491 timestamp_begin_ns
= (uint64_t) timestamp_begin_ns_signed
;
494 return timestamp_begin_ns
;
498 void ctf_fs_ds_file_info_destroy(struct ctf_fs_ds_file_info
*ds_file_info
)
504 if (ds_file_info
->path
) {
505 g_string_free(ds_file_info
->path
, TRUE
);
508 ctf_fs_ds_index_destroy(ds_file_info
->index
);
509 g_free(ds_file_info
);
513 struct ctf_fs_ds_file_info
*ctf_fs_ds_file_info_create(const char *path
,
514 uint64_t begin_ns
, struct ctf_fs_ds_index
*index
)
516 struct ctf_fs_ds_file_info
*ds_file_info
;
518 ds_file_info
= g_new0(struct ctf_fs_ds_file_info
, 1);
523 ds_file_info
->path
= g_string_new(path
);
524 if (!ds_file_info
->path
) {
525 ctf_fs_ds_file_info_destroy(ds_file_info
);
530 ds_file_info
->begin_ns
= begin_ns
;
531 ds_file_info
->index
= index
;
535 ctf_fs_ds_index_destroy(index
);
540 void ctf_fs_ds_file_group_destroy(struct ctf_fs_ds_file_group
*ds_file_group
)
542 if (!ds_file_group
) {
546 if (ds_file_group
->ds_file_infos
) {
547 g_ptr_array_free(ds_file_group
->ds_file_infos
, TRUE
);
550 bt_put(ds_file_group
->stream
);
551 bt_put(ds_file_group
->stream_class
);
552 g_free(ds_file_group
);
556 struct ctf_fs_ds_file_group
*ctf_fs_ds_file_group_create(
557 struct ctf_fs_trace
*ctf_fs_trace
,
558 struct bt_stream_class
*stream_class
,
559 uint64_t stream_instance_id
)
561 struct ctf_fs_ds_file_group
*ds_file_group
;
563 ds_file_group
= g_new0(struct ctf_fs_ds_file_group
, 1);
564 if (!ds_file_group
) {
568 ds_file_group
->ds_file_infos
= g_ptr_array_new_with_free_func(
569 (GDestroyNotify
) ctf_fs_ds_file_info_destroy
);
570 if (!ds_file_group
->ds_file_infos
) {
574 ds_file_group
->stream_id
= stream_instance_id
;
575 BT_ASSERT(stream_class
);
576 ds_file_group
->stream_class
= bt_get(stream_class
);
577 ds_file_group
->ctf_fs_trace
= ctf_fs_trace
;
581 ctf_fs_ds_file_group_destroy(ds_file_group
);
582 ds_file_group
= NULL
;
585 return ds_file_group
;
588 /* Replace by g_ptr_array_insert when we depend on glib >= 2.40. */
590 void array_insert(GPtrArray
*array
, gpointer element
, size_t pos
)
592 size_t original_array_len
= array
->len
;
594 /* Allocate an unused element at the end of the array. */
595 g_ptr_array_add(array
, NULL
);
597 /* If we are not inserting at the end, move the elements by one. */
598 if (pos
< original_array_len
) {
599 memmove(&(array
->pdata
[pos
+ 1]),
600 &(array
->pdata
[pos
]),
601 (original_array_len
- pos
) * sizeof(gpointer
));
604 /* Insert the value and bump the array len */
605 array
->pdata
[pos
] = element
;
609 int ctf_fs_ds_file_group_add_ds_file_info(
610 struct ctf_fs_ds_file_group
*ds_file_group
,
611 const char *path
, uint64_t begin_ns
,
612 struct ctf_fs_ds_index
*index
)
614 struct ctf_fs_ds_file_info
*ds_file_info
;
618 /* Onwership of index is transferred. */
619 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
, index
);
625 /* Find a spot to insert this one */
626 for (i
= 0; i
< ds_file_group
->ds_file_infos
->len
; i
++) {
627 struct ctf_fs_ds_file_info
*other_ds_file_info
=
628 g_ptr_array_index(ds_file_group
->ds_file_infos
, i
);
630 if (begin_ns
< other_ds_file_info
->begin_ns
) {
635 array_insert(ds_file_group
->ds_file_infos
, ds_file_info
, i
);
640 ctf_fs_ds_file_info_destroy(ds_file_info
);
641 ctf_fs_ds_index_destroy(index
);
648 int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
,
649 struct bt_graph
*graph
, const char *path
)
651 struct bt_field
*packet_header_field
= NULL
;
652 struct bt_field
*packet_context_field
= NULL
;
653 struct bt_stream_class
*stream_class
= NULL
;
654 uint64_t stream_instance_id
= -1ULL;
655 uint64_t begin_ns
= -1ULL;
656 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
657 bool add_group
= false;
660 struct ctf_fs_ds_file
*ds_file
= NULL
;
661 struct ctf_fs_ds_index
*index
= NULL
;
662 struct bt_notif_iter
*notif_iter
= NULL
;
664 notif_iter
= bt_notif_iter_create(ctf_fs_trace
->metadata
->trace
,
665 bt_common_get_page_size() * 8, ctf_fs_ds_file_medops
, NULL
);
667 BT_LOGE_STR("Cannot create a CTF notification iterator.");
671 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, graph
, notif_iter
,
677 ret
= ctf_fs_ds_file_borrow_packet_header_context_fields(ds_file
,
678 &packet_header_field
, &packet_context_field
);
680 BT_LOGE("Cannot get stream file's first packet's header and context fields (`%s`).",
685 stream_instance_id
= get_packet_header_stream_instance_id(ctf_fs_trace
,
686 packet_header_field
);
687 begin_ns
= get_packet_context_timestamp_begin_ns(ctf_fs_trace
,
688 packet_context_field
);
689 stream_class
= ctf_utils_borrow_stream_class_from_packet_header(
690 ctf_fs_trace
->metadata
->trace
, packet_header_field
);
695 index
= ctf_fs_ds_file_build_index(ds_file
);
697 BT_LOGW("Failed to index CTF stream file \'%s\'",
698 ds_file
->file
->path
->str
);
701 if (begin_ns
== -1ULL) {
703 * No beggining timestamp to sort the stream files
704 * within a stream file group, so consider that this
705 * file must be the only one within its group.
707 stream_instance_id
= -1ULL;
710 if (stream_instance_id
== -1ULL) {
712 * No stream instance ID or no beginning timestamp:
713 * create a unique stream file group for this stream
714 * file because, even if there's a stream instance ID,
715 * there's no timestamp to order the file within its
718 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
,
719 stream_class
, stream_instance_id
);
720 if (!ds_file_group
) {
724 ret
= ctf_fs_ds_file_group_add_ds_file_info(ds_file_group
,
725 path
, begin_ns
, index
);
726 /* Ownership of index is transferred. */
736 BT_ASSERT(stream_instance_id
!= -1ULL);
737 BT_ASSERT(begin_ns
!= -1ULL);
739 /* Find an existing stream file group with this ID */
740 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
741 ds_file_group
= g_ptr_array_index(
742 ctf_fs_trace
->ds_file_groups
, i
);
744 if (ds_file_group
->stream_class
== stream_class
&&
745 ds_file_group
->stream_id
==
746 stream_instance_id
) {
750 ds_file_group
= NULL
;
753 if (!ds_file_group
) {
754 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
,
755 stream_class
, stream_instance_id
);
756 if (!ds_file_group
) {
763 ret
= ctf_fs_ds_file_group_add_ds_file_info(ds_file_group
, path
,
773 ctf_fs_ds_file_group_destroy(ds_file_group
);
777 if (add_group
&& ds_file_group
) {
778 g_ptr_array_add(ctf_fs_trace
->ds_file_groups
, ds_file_group
);
781 ctf_fs_ds_file_destroy(ds_file
);
784 bt_notif_iter_destroy(notif_iter
);
787 ctf_fs_ds_index_destroy(index
);
792 int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
,
793 struct bt_graph
*graph
)
796 const char *basename
;
797 GError
*error
= NULL
;
801 /* Check each file in the path directory, except specific ones */
802 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
804 BT_LOGE("Cannot open directory `%s`: %s (code %d)",
805 ctf_fs_trace
->path
->str
, error
->message
,
810 while ((basename
= g_dir_read_name(dir
))) {
811 struct ctf_fs_file
*file
;
813 if (!strcmp(basename
, CTF_FS_METADATA_FILENAME
)) {
814 /* Ignore the metadata stream. */
815 BT_LOGD("Ignoring metadata file `%s" G_DIR_SEPARATOR_S
"%s`",
816 ctf_fs_trace
->path
->str
, basename
);
820 if (basename
[0] == '.') {
821 BT_LOGD("Ignoring hidden file `%s" G_DIR_SEPARATOR_S
"%s`",
822 ctf_fs_trace
->path
->str
, basename
);
826 /* Create the file. */
827 file
= ctf_fs_file_create();
829 BT_LOGE("Cannot create stream file object for file `%s" G_DIR_SEPARATOR_S
"%s`",
830 ctf_fs_trace
->path
->str
, basename
);
834 /* Create full path string. */
835 g_string_append_printf(file
->path
, "%s" G_DIR_SEPARATOR_S
"%s",
836 ctf_fs_trace
->path
->str
, basename
);
837 if (!g_file_test(file
->path
->str
, G_FILE_TEST_IS_REGULAR
)) {
838 BT_LOGD("Ignoring non-regular file `%s`",
840 ctf_fs_file_destroy(file
);
845 ret
= ctf_fs_file_open(file
, "rb");
847 BT_LOGE("Cannot open stream file `%s`", file
->path
->str
);
851 if (file
->size
== 0) {
852 /* Skip empty stream. */
853 BT_LOGD("Ignoring empty file `%s`", file
->path
->str
);
854 ctf_fs_file_destroy(file
);
858 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
, graph
,
861 BT_LOGE("Cannot add stream file `%s` to stream file group",
863 ctf_fs_file_destroy(file
);
867 ctf_fs_file_destroy(file
);
871 * At this point, DS file groupes are created, but their
872 * associated stream objects do not exist yet. This is because
873 * we need to name the created stream object with the data
874 * stream file's path. We have everything we need here to do
877 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
878 struct ctf_fs_ds_file_group
*ds_file_group
=
879 g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
880 GString
*name
= get_stream_instance_unique_name(ds_file_group
);
886 if (ds_file_group
->stream_id
== -1ULL) {
887 /* No stream ID: use 0 */
888 ds_file_group
->stream
= bt_stream_create(
889 ds_file_group
->stream_class
, name
->str
,
890 ctf_fs_trace
->next_stream_id
);
891 ctf_fs_trace
->next_stream_id
++;
893 /* Specific stream ID */
894 ds_file_group
->stream
= bt_stream_create(
895 ds_file_group
->stream_class
, name
->str
,
896 ds_file_group
->stream_id
);
899 g_string_free(name
, TRUE
);
901 if (!ds_file_group
->stream
) {
902 BT_LOGE("Cannot create stream for DS file group: "
903 "addr=%p, stream-name=\"%s\"",
904 ds_file_group
, name
->str
);
928 int create_cc_prio_map(struct ctf_fs_trace
*ctf_fs_trace
)
934 BT_ASSERT(ctf_fs_trace
);
935 ctf_fs_trace
->cc_prio_map
= bt_clock_class_priority_map_create();
936 if (!ctf_fs_trace
->cc_prio_map
) {
941 count
= bt_trace_get_clock_class_count(
942 ctf_fs_trace
->metadata
->trace
);
943 BT_ASSERT(count
>= 0);
945 for (i
= 0; i
< count
; i
++) {
946 struct bt_clock_class
*clock_class
=
947 bt_trace_borrow_clock_class_by_index(
948 ctf_fs_trace
->metadata
->trace
, i
);
950 BT_ASSERT(clock_class
);
951 ret
= bt_clock_class_priority_map_add_clock_class(
952 ctf_fs_trace
->cc_prio_map
, clock_class
, 0);
964 struct ctf_fs_trace
*ctf_fs_trace_create(const char *path
, const char *name
,
965 struct ctf_fs_metadata_config
*metadata_config
,
966 struct bt_graph
*graph
)
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_trace
->ds_file_groups
= g_ptr_array_new_with_free_func(
992 (GDestroyNotify
) ctf_fs_ds_file_group_destroy
);
993 if (!ctf_fs_trace
->ds_file_groups
) {
997 ret
= ctf_fs_metadata_set_trace(ctf_fs_trace
, metadata_config
);
1002 ret
= create_ds_file_groups(ctf_fs_trace
, graph
);
1007 ret
= create_cc_prio_map(ctf_fs_trace
);
1013 * create_ds_file_groups() created all the streams that this
1014 * trace needs. There won't be any more. Therefore it is safe to
1015 * make this trace static.
1017 (void) bt_trace_set_is_static(ctf_fs_trace
->metadata
->trace
);
1022 ctf_fs_trace_destroy(ctf_fs_trace
);
1023 ctf_fs_trace
= NULL
;
1025 return ctf_fs_trace
;
1029 int path_is_ctf_trace(const char *path
)
1031 GString
*metadata_path
= g_string_new(NULL
);
1034 if (!metadata_path
) {
1039 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
1041 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
1047 g_string_free(metadata_path
, TRUE
);
1052 int add_trace_path(GList
**trace_paths
, const char *path
)
1054 GString
*norm_path
= NULL
;
1057 norm_path
= bt_common_normalize_path(path
, NULL
);
1059 BT_LOGE("Failed to normalize path `%s`.", path
);
1064 // FIXME: Remove or ifdef for __MINGW32__
1065 if (strcmp(norm_path
->str
, "/") == 0) {
1066 BT_LOGE("Opening a trace in `/` is not supported.");
1071 *trace_paths
= g_list_prepend(*trace_paths
, norm_path
);
1072 BT_ASSERT(*trace_paths
);
1077 g_string_free(norm_path
, TRUE
);
1084 int ctf_fs_find_traces(GList
**trace_paths
, const char *start_path
)
1087 GError
*error
= NULL
;
1089 const char *basename
= NULL
;
1091 /* Check if the starting path is a CTF trace itself */
1092 ret
= path_is_ctf_trace(start_path
);
1099 * Stop recursion: a CTF trace cannot contain another
1102 ret
= add_trace_path(trace_paths
, start_path
);
1106 /* Look for subdirectories */
1107 if (!g_file_test(start_path
, G_FILE_TEST_IS_DIR
)) {
1108 /* Starting path is not a directory: end of recursion */
1112 dir
= g_dir_open(start_path
, 0, &error
);
1114 if (error
->code
== G_FILE_ERROR_ACCES
) {
1115 BT_LOGD("Cannot open directory `%s`: %s (code %d): continuing",
1116 start_path
, error
->message
, error
->code
);
1120 BT_LOGE("Cannot open directory `%s`: %s (code %d)",
1121 start_path
, error
->message
, error
->code
);
1126 while ((basename
= g_dir_read_name(dir
))) {
1127 GString
*sub_path
= g_string_new(NULL
);
1134 g_string_printf(sub_path
, "%s" G_DIR_SEPARATOR_S
"%s", start_path
, basename
);
1135 ret
= ctf_fs_find_traces(trace_paths
, sub_path
->str
);
1136 g_string_free(sub_path
, TRUE
);
1148 g_error_free(error
);
1155 GList
*ctf_fs_create_trace_names(GList
*trace_paths
, const char *base_path
) {
1156 GList
*trace_names
= NULL
;
1158 const char *last_sep
;
1162 * At this point we know that all the trace paths are
1163 * normalized, and so is the base path. This means that
1164 * they are absolute and they don't end with a separator.
1165 * We can simply find the location of the last separator
1166 * in the base path, which gives us the name of the actual
1167 * directory to look into, and use this location as the
1168 * start of each trace name within each trace path.
1172 * Base path: /home/user/my-traces/some-trace
1174 * - /home/user/my-traces/some-trace/host1/trace1
1175 * - /home/user/my-traces/some-trace/host1/trace2
1176 * - /home/user/my-traces/some-trace/host2/trace
1177 * - /home/user/my-traces/some-trace/other-trace
1179 * In this case the trace names are:
1181 * - some-trace/host1/trace1
1182 * - some-trace/host1/trace2
1183 * - some-trace/host2/trace
1184 * - some-trace/other-trace
1186 last_sep
= strrchr(base_path
, G_DIR_SEPARATOR
);
1188 /* We know there's at least one separator */
1189 BT_ASSERT(last_sep
);
1191 /* Distance to base */
1192 base_dist
= last_sep
- base_path
+ 1;
1194 /* Create the trace names */
1195 for (node
= trace_paths
; node
; node
= g_list_next(node
)) {
1196 GString
*trace_name
= g_string_new(NULL
);
1197 GString
*trace_path
= node
->data
;
1199 BT_ASSERT(trace_name
);
1200 g_string_assign(trace_name
, &trace_path
->str
[base_dist
]);
1201 trace_names
= g_list_append(trace_names
, trace_name
);
1208 int create_ctf_fs_traces(struct ctf_fs_component
*ctf_fs
,
1209 const char *path_param
)
1211 struct ctf_fs_trace
*ctf_fs_trace
= NULL
;
1213 GString
*norm_path
= NULL
;
1214 GList
*trace_paths
= NULL
;
1215 GList
*trace_names
= NULL
;
1219 norm_path
= bt_common_normalize_path(path_param
, NULL
);
1221 BT_LOGE("Failed to normalize path: `%s`.",
1226 ret
= ctf_fs_find_traces(&trace_paths
, norm_path
->str
);
1232 BT_LOGE("No CTF traces recursively found in `%s`.",
1237 trace_names
= ctf_fs_create_trace_names(trace_paths
, norm_path
->str
);
1239 BT_LOGE("Cannot create trace names from trace paths.");
1243 for (tp_node
= trace_paths
, tn_node
= trace_names
; tp_node
;
1244 tp_node
= g_list_next(tp_node
),
1245 tn_node
= g_list_next(tn_node
)) {
1246 GString
*trace_path
= tp_node
->data
;
1247 GString
*trace_name
= tn_node
->data
;
1248 struct bt_graph
*graph
= bt_component_borrow_graph(
1249 bt_component_borrow_from_private(ctf_fs
->priv_comp
));
1252 ctf_fs_trace
= ctf_fs_trace_create(trace_path
->str
,
1253 trace_name
->str
, &ctf_fs
->metadata_config
,
1255 if (!ctf_fs_trace
) {
1256 BT_LOGE("Cannot create trace for `%s`.",
1261 ret
= create_ports_for_trace(ctf_fs
, ctf_fs_trace
);
1266 g_ptr_array_add(ctf_fs
->traces
, ctf_fs_trace
);
1267 ctf_fs_trace
= NULL
;
1274 ctf_fs_trace_destroy(ctf_fs_trace
);
1277 for (tp_node
= trace_paths
; tp_node
; tp_node
= g_list_next(tp_node
)) {
1278 if (tp_node
->data
) {
1279 g_string_free(tp_node
->data
, TRUE
);
1283 for (tn_node
= trace_names
; tn_node
; tn_node
= g_list_next(tn_node
)) {
1284 if (tn_node
->data
) {
1285 g_string_free(tn_node
->data
, TRUE
);
1290 g_list_free(trace_paths
);
1294 g_list_free(trace_names
);
1298 g_string_free(norm_path
, TRUE
);
1305 struct ctf_fs_component
*ctf_fs_create(struct bt_private_component
*priv_comp
,
1306 struct bt_value
*params
)
1308 struct ctf_fs_component
*ctf_fs
;
1309 struct bt_value
*value
= NULL
;
1310 const char *path_param
;
1311 enum bt_component_status ret
;
1312 enum bt_value_status value_ret
;
1314 ctf_fs
= g_new0(struct ctf_fs_component
, 1);
1319 ret
= bt_private_component_set_user_data(priv_comp
, ctf_fs
);
1320 BT_ASSERT(ret
== BT_COMPONENT_STATUS_OK
);
1323 * We don't need to get a new reference here because as long as
1324 * our private ctf_fs_component object exists, the containing
1325 * private component should also exist.
1327 ctf_fs
->priv_comp
= priv_comp
;
1328 value
= bt_value_map_borrow(params
, "path");
1329 if (value
&& !bt_value_is_string(value
)) {
1333 value_ret
= bt_value_string_get(value
, &path_param
);
1334 BT_ASSERT(value_ret
== BT_VALUE_STATUS_OK
);
1335 value
= bt_value_map_borrow(params
, "clock-class-offset-s");
1337 if (!bt_value_is_integer(value
)) {
1338 BT_LOGE("clock-class-offset-s should be an integer");
1341 value_ret
= bt_value_integer_get(value
,
1342 &ctf_fs
->metadata_config
.clock_class_offset_s
);
1343 BT_ASSERT(value_ret
== BT_VALUE_STATUS_OK
);
1346 value
= bt_value_map_borrow(params
, "clock-class-offset-ns");
1348 if (!bt_value_is_integer(value
)) {
1349 BT_LOGE("clock-class-offset-ns should be an integer");
1352 value_ret
= bt_value_integer_get(value
,
1353 &ctf_fs
->metadata_config
.clock_class_offset_ns
);
1354 BT_ASSERT(value_ret
== BT_VALUE_STATUS_OK
);
1357 ctf_fs
->port_data
= g_ptr_array_new_with_free_func(port_data_destroy
);
1358 if (!ctf_fs
->port_data
) {
1362 ctf_fs
->traces
= g_ptr_array_new_with_free_func(
1363 ctf_fs_trace_destroy_notifier
);
1364 if (!ctf_fs
->traces
) {
1368 if (create_ctf_fs_traces(ctf_fs
, path_param
)) {
1375 ctf_fs_destroy(ctf_fs
);
1377 ret
= bt_private_component_set_user_data(priv_comp
, NULL
);
1378 BT_ASSERT(ret
== BT_COMPONENT_STATUS_OK
);
1385 enum bt_component_status
ctf_fs_init(struct bt_private_component
*priv_comp
,
1386 struct bt_value
*params
, UNUSED_VAR
void *init_method_data
)
1388 struct ctf_fs_component
*ctf_fs
;
1389 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
1391 ctf_fs
= ctf_fs_create(priv_comp
, params
);
1393 ret
= BT_COMPONENT_STATUS_ERROR
;
1400 struct bt_component_class_query_method_return
ctf_fs_query(
1401 struct bt_component_class
*comp_class
,
1402 struct bt_query_executor
*query_exec
,
1403 const char *object
, struct bt_value
*params
)
1405 struct bt_component_class_query_method_return ret
= {
1407 .status
= BT_QUERY_STATUS_OK
,
1410 if (!strcmp(object
, "metadata-info")) {
1411 ret
= metadata_info_query(comp_class
, params
);
1412 } else if (!strcmp(object
, "trace-info")) {
1413 ret
= trace_info_query(comp_class
, params
);
1415 BT_LOGE("Unknown query object `%s`", object
);
1416 ret
.status
= BT_QUERY_STATUS_INVALID_OBJECT
;