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/ctf-ir/packet.h>
30 #include <babeltrace/ctf-ir/clock-class.h>
31 #include <babeltrace/ctf-ir/stream.h>
32 #include <babeltrace/ctf-ir/fields.h>
33 #include <babeltrace/graph/private-port.h>
34 #include <babeltrace/graph/private-component.h>
35 #include <babeltrace/graph/private-component-source.h>
36 #include <babeltrace/graph/private-notification-iterator.h>
37 #include <babeltrace/graph/component.h>
38 #include <babeltrace/graph/notification-iterator.h>
39 #include <babeltrace/graph/clock-class-priority-map.h>
40 #include <plugins-common.h>
47 #include "data-stream-file.h"
49 #include "../common/metadata/decoder.h"
50 #include "../common/notif-iter/notif-iter.h"
53 #define BT_LOG_TAG "PLUGIN-CTF-FS-SRC"
57 int notif_iter_data_set_current_ds_file(struct ctf_fs_notif_iter_data
*notif_iter_data
)
59 struct ctf_fs_ds_file_info
*ds_file_info
;
62 assert(notif_iter_data
->ds_file_info_index
<
63 notif_iter_data
->ds_file_group
->ds_file_infos
->len
);
64 ds_file_info
= g_ptr_array_index(
65 notif_iter_data
->ds_file_group
->ds_file_infos
,
66 notif_iter_data
->ds_file_info_index
);
68 ctf_fs_ds_file_destroy(notif_iter_data
->ds_file
);
69 notif_iter_data
->ds_file
= ctf_fs_ds_file_create(
70 notif_iter_data
->ds_file_group
->ctf_fs_trace
,
71 notif_iter_data
->notif_iter
,
72 notif_iter_data
->ds_file_group
->stream
,
73 ds_file_info
->path
->str
);
74 if (!notif_iter_data
->ds_file
) {
82 void ctf_fs_notif_iter_data_destroy(
83 struct ctf_fs_notif_iter_data
*notif_iter_data
)
85 if (!notif_iter_data
) {
89 ctf_fs_ds_file_destroy(notif_iter_data
->ds_file
);
91 if (notif_iter_data
->notif_iter
) {
92 bt_ctf_notif_iter_destroy(notif_iter_data
->notif_iter
);
95 g_free(notif_iter_data
);
98 struct bt_notification_iterator_next_return
ctf_fs_iterator_next(
99 struct bt_private_notification_iterator
*iterator
)
101 struct bt_notification_iterator_next_return next_ret
;
102 struct ctf_fs_notif_iter_data
*notif_iter_data
=
103 bt_private_notification_iterator_get_user_data(iterator
);
106 assert(notif_iter_data
->ds_file
);
107 next_ret
= ctf_fs_ds_file_next(notif_iter_data
->ds_file
);
108 if (next_ret
.status
== BT_NOTIFICATION_ITERATOR_STATUS_END
) {
109 assert(!next_ret
.notification
);
110 notif_iter_data
->ds_file_info_index
++;
112 if (notif_iter_data
->ds_file_info_index
==
113 notif_iter_data
->ds_file_group
->ds_file_infos
->len
) {
115 * No more stream files to read: we reached the
122 * Open and start reading the next stream file within
123 * our stream file group.
125 ret
= notif_iter_data_set_current_ds_file(notif_iter_data
);
127 next_ret
.status
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
131 next_ret
= ctf_fs_ds_file_next(notif_iter_data
->ds_file
);
134 * We should not get BT_NOTIFICATION_ITERATOR_STATUS_END
135 * with a brand new stream file because empty stream
136 * files are not even part of stream file groups, which
137 * means we're sure to get at least one pair of "packet
138 * begin" and "packet end" notifications in the case of
139 * a single, empty packet.
141 assert(next_ret
.status
!= BT_NOTIFICATION_ITERATOR_STATUS_END
);
148 void ctf_fs_iterator_finalize(struct bt_private_notification_iterator
*it
)
150 void *notif_iter_data
=
151 bt_private_notification_iterator_get_user_data(it
);
153 ctf_fs_notif_iter_data_destroy(notif_iter_data
);
156 enum bt_notification_iterator_status
ctf_fs_iterator_init(
157 struct bt_private_notification_iterator
*it
,
158 struct bt_private_port
*port
)
160 struct ctf_fs_port_data
*port_data
;
161 struct ctf_fs_notif_iter_data
*notif_iter_data
= NULL
;
162 enum bt_notification_iterator_status ret
=
163 BT_NOTIFICATION_ITERATOR_STATUS_OK
;
166 port_data
= bt_private_port_get_user_data(port
);
168 ret
= BT_NOTIFICATION_ITERATOR_STATUS_INVALID
;
172 notif_iter_data
= g_new0(struct ctf_fs_notif_iter_data
, 1);
173 if (!notif_iter_data
) {
174 ret
= BT_NOTIFICATION_ITERATOR_STATUS_NOMEM
;
178 notif_iter_data
->notif_iter
= bt_ctf_notif_iter_create(
179 port_data
->ds_file_group
->ctf_fs_trace
->metadata
->trace
,
180 bt_common_get_page_size() * 8,
181 ctf_fs_ds_file_medops
, NULL
);
182 if (!notif_iter_data
->notif_iter
) {
183 BT_LOGE_STR("Cannot create a CTF notification iterator.");
184 ret
= BT_NOTIFICATION_ITERATOR_STATUS_NOMEM
;
188 notif_iter_data
->ds_file_group
= port_data
->ds_file_group
;
189 iret
= notif_iter_data_set_current_ds_file(notif_iter_data
);
191 ret
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
195 ret
= bt_private_notification_iterator_set_user_data(it
, notif_iter_data
);
200 notif_iter_data
= NULL
;
204 (void) bt_private_notification_iterator_set_user_data(it
, NULL
);
206 if (ret
== BT_NOTIFICATION_ITERATOR_STATUS_OK
) {
207 ret
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
211 ctf_fs_notif_iter_data_destroy(notif_iter_data
);
216 void ctf_fs_destroy(struct ctf_fs_component
*ctf_fs
)
222 if (ctf_fs
->traces
) {
223 g_ptr_array_free(ctf_fs
->traces
, TRUE
);
226 if (ctf_fs
->port_data
) {
227 g_ptr_array_free(ctf_fs
->port_data
, TRUE
);
234 void ctf_fs_trace_destroy(struct ctf_fs_trace
*ctf_fs_trace
)
240 if (ctf_fs_trace
->ds_file_groups
) {
241 g_ptr_array_free(ctf_fs_trace
->ds_file_groups
, TRUE
);
244 if (ctf_fs_trace
->path
) {
245 g_string_free(ctf_fs_trace
->path
, TRUE
);
248 if (ctf_fs_trace
->name
) {
249 g_string_free(ctf_fs_trace
->name
, TRUE
);
252 if (ctf_fs_trace
->metadata
) {
253 ctf_fs_metadata_fini(ctf_fs_trace
->metadata
);
254 g_free(ctf_fs_trace
->metadata
);
257 bt_put(ctf_fs_trace
->cc_prio_map
);
258 g_free(ctf_fs_trace
);
262 void ctf_fs_trace_destroy_notifier(void *data
)
264 struct ctf_fs_trace
*trace
= data
;
265 ctf_fs_trace_destroy(trace
);
268 void ctf_fs_finalize(struct bt_private_component
*component
)
270 void *data
= bt_private_component_get_user_data(component
);
272 ctf_fs_destroy(data
);
276 void port_data_destroy(void *data
) {
277 struct ctf_fs_port_data
*port_data
= data
;
287 int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
288 struct ctf_fs_trace
*ctf_fs_trace
,
289 struct ctf_fs_ds_file_group
*ds_file_group
)
292 struct ctf_fs_port_data
*port_data
= NULL
;
293 GString
*port_name
= NULL
;
294 struct ctf_fs_ds_file_info
*ds_file_info
=
295 g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
297 port_name
= g_string_new(NULL
);
303 * Assign the name for the new output port. If there's more than
304 * one stream file in the stream file group, the first
305 * (earliest) stream file's path is used.
307 assert(ds_file_group
->ds_file_infos
->len
> 0);
308 ds_file_info
= g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
309 g_string_assign(port_name
, ds_file_info
->path
->str
);
310 BT_LOGD("Creating one port named `%s`", port_name
->str
);
312 /* Create output port for this file */
313 port_data
= g_new0(struct ctf_fs_port_data
, 1);
318 port_data
->ds_file_group
= ds_file_group
;
319 ret
= bt_private_component_source_add_output_private_port(
320 ctf_fs
->priv_comp
, port_name
->str
, port_data
, NULL
);
325 g_ptr_array_add(ctf_fs
->port_data
, port_data
);
334 g_string_free(port_name
, TRUE
);
337 port_data_destroy(port_data
);
342 int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
343 struct ctf_fs_trace
*ctf_fs_trace
)
348 /* Create one output port for each stream file group */
349 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
350 struct ctf_fs_ds_file_group
*ds_file_group
=
351 g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
353 ret
= create_one_port_for_trace(ctf_fs
, ctf_fs_trace
,
356 BT_LOGE("Cannot create output port.");
365 uint64_t get_packet_header_stream_instance_id(struct ctf_fs_trace
*ctf_fs_trace
,
366 struct bt_ctf_field
*packet_header_field
)
368 struct bt_ctf_field
*stream_instance_id_field
= NULL
;
369 uint64_t stream_instance_id
= -1ULL;
372 if (!packet_header_field
) {
376 stream_instance_id_field
= bt_ctf_field_structure_get_field_by_name(
377 packet_header_field
, "stream_instance_id");
378 if (!stream_instance_id_field
) {
382 ret
= bt_ctf_field_unsigned_integer_get_value(stream_instance_id_field
,
383 &stream_instance_id
);
385 stream_instance_id
= -1ULL;
390 bt_put(stream_instance_id_field
);
391 return stream_instance_id
;
394 struct bt_ctf_stream_class
*stream_class_from_packet_header(
395 struct ctf_fs_trace
*ctf_fs_trace
,
396 struct bt_ctf_field
*packet_header_field
)
398 struct bt_ctf_field
*stream_id_field
= NULL
;
399 struct bt_ctf_stream_class
*stream_class
= NULL
;
400 uint64_t stream_id
= -1ULL;
403 if (!packet_header_field
) {
404 goto single_stream_class
;
407 stream_id_field
= bt_ctf_field_structure_get_field_by_name(
408 packet_header_field
, "stream_id");
409 if (!stream_id_field
) {
410 goto single_stream_class
;
413 ret
= bt_ctf_field_unsigned_integer_get_value(stream_id_field
,
419 if (stream_id
== -1ULL) {
421 /* Single stream class */
422 if (bt_ctf_trace_get_stream_class_count(
423 ctf_fs_trace
->metadata
->trace
) == 0) {
427 stream_class
= bt_ctf_trace_get_stream_class_by_index(
428 ctf_fs_trace
->metadata
->trace
, 0);
430 stream_class
= bt_ctf_trace_get_stream_class_by_id(
431 ctf_fs_trace
->metadata
->trace
, stream_id
);
435 bt_put(stream_id_field
);
439 uint64_t get_packet_context_timestamp_begin_ns(
440 struct ctf_fs_trace
*ctf_fs_trace
,
441 struct bt_ctf_field
*packet_context_field
)
444 struct bt_ctf_field
*timestamp_begin_field
= NULL
;
445 struct bt_ctf_field_type
*timestamp_begin_ft
= NULL
;
446 uint64_t timestamp_begin_raw_value
= -1ULL;
447 uint64_t timestamp_begin_ns
= -1ULL;
448 int64_t timestamp_begin_ns_signed
;
449 struct bt_ctf_clock_class
*timestamp_begin_clock_class
= NULL
;
450 struct bt_ctf_clock_value
*clock_value
= NULL
;
452 if (!packet_context_field
) {
456 timestamp_begin_field
= bt_ctf_field_structure_get_field_by_name(
457 packet_context_field
, "timestamp_begin");
458 if (!timestamp_begin_field
) {
462 timestamp_begin_ft
= bt_ctf_field_get_type(timestamp_begin_field
);
463 assert(timestamp_begin_ft
);
464 timestamp_begin_clock_class
=
465 bt_ctf_field_type_integer_get_mapped_clock_class(timestamp_begin_ft
);
466 if (!timestamp_begin_clock_class
) {
470 ret
= bt_ctf_field_unsigned_integer_get_value(timestamp_begin_field
,
471 ×tamp_begin_raw_value
);
476 clock_value
= bt_ctf_clock_value_create(timestamp_begin_clock_class
,
477 timestamp_begin_raw_value
);
482 ret
= bt_ctf_clock_value_get_value_ns_from_epoch(clock_value
,
483 ×tamp_begin_ns_signed
);
488 timestamp_begin_ns
= (uint64_t) timestamp_begin_ns_signed
;
491 bt_put(timestamp_begin_field
);
492 bt_put(timestamp_begin_ft
);
493 bt_put(timestamp_begin_clock_class
);
495 return timestamp_begin_ns
;
499 void ctf_fs_ds_file_info_destroy(struct ctf_fs_ds_file_info
*ds_file_info
)
505 if (ds_file_info
->path
) {
506 g_string_free(ds_file_info
->path
, TRUE
);
509 ctf_fs_ds_index_destroy(ds_file_info
->index
);
510 g_free(ds_file_info
);
514 struct ctf_fs_ds_file_info
*ctf_fs_ds_file_info_create(const char *path
,
515 uint64_t begin_ns
, struct ctf_fs_ds_index
*index
)
517 struct ctf_fs_ds_file_info
*ds_file_info
;
519 ds_file_info
= g_new0(struct ctf_fs_ds_file_info
, 1);
524 ds_file_info
->path
= g_string_new(path
);
525 if (!ds_file_info
->path
) {
526 ctf_fs_ds_file_info_destroy(ds_file_info
);
531 ds_file_info
->begin_ns
= begin_ns
;
532 ds_file_info
->index
= index
;
536 ctf_fs_ds_index_destroy(index
);
541 void ctf_fs_ds_file_group_destroy(struct ctf_fs_ds_file_group
*ds_file_group
)
543 if (!ds_file_group
) {
547 if (ds_file_group
->ds_file_infos
) {
548 g_ptr_array_free(ds_file_group
->ds_file_infos
, TRUE
);
551 bt_put(ds_file_group
->stream
);
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_ctf_stream_class
*stream_class
,
559 uint64_t stream_instance_id
)
561 struct ctf_fs_ds_file_group
*ds_file_group
;
563 assert(stream_class
);
564 ds_file_group
= g_new0(struct ctf_fs_ds_file_group
, 1);
565 if (!ds_file_group
) {
569 ds_file_group
->ds_file_infos
= g_ptr_array_new_with_free_func(
570 (GDestroyNotify
) ctf_fs_ds_file_info_destroy
);
571 if (!ds_file_group
->ds_file_infos
) {
575 if (stream_instance_id
== -1ULL) {
576 ds_file_group
->stream
= bt_ctf_stream_create(
579 ds_file_group
->stream
= bt_ctf_stream_create_with_id(
580 stream_class
, NULL
, stream_instance_id
);
583 if (!ds_file_group
->stream
) {
587 ds_file_group
->ctf_fs_trace
= ctf_fs_trace
;
592 ctf_fs_ds_file_group_destroy(ds_file_group
);
593 ds_file_group
= NULL
;
596 return ds_file_group
;
600 int ctf_fs_ds_file_group_add_ds_file_info(
601 struct ctf_fs_ds_file_group
*ds_file_group
,
602 const char *path
, uint64_t begin_ns
,
603 struct ctf_fs_ds_index
*index
)
605 struct ctf_fs_ds_file_info
*ds_file_info
;
609 /* Onwership of index is transferred. */
610 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
, index
);
616 /* Find a spot to insert this one */
617 for (i
= 0; i
< ds_file_group
->ds_file_infos
->len
; i
++) {
618 struct ctf_fs_ds_file_info
*other_ds_file_info
=
619 g_ptr_array_index(ds_file_group
->ds_file_infos
, i
);
621 if (begin_ns
< other_ds_file_info
->begin_ns
) {
626 if (i
== ds_file_group
->ds_file_infos
->len
) {
631 g_ptr_array_insert(ds_file_group
->ds_file_infos
, i
, ds_file_info
);
636 ctf_fs_ds_file_info_destroy(ds_file_info
);
637 ctf_fs_ds_index_destroy(index
);
644 int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
,
647 struct bt_ctf_field
*packet_header_field
= NULL
;
648 struct bt_ctf_field
*packet_context_field
= NULL
;
649 struct bt_ctf_stream_class
*stream_class
= NULL
;
650 uint64_t stream_instance_id
= -1ULL;
651 uint64_t begin_ns
= -1ULL;
652 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
653 bool add_group
= false;
656 struct ctf_fs_ds_file
*ds_file
= NULL
;
657 struct ctf_fs_ds_index
*index
= NULL
;
658 struct bt_ctf_notif_iter
*notif_iter
= NULL
;
660 notif_iter
= bt_ctf_notif_iter_create(ctf_fs_trace
->metadata
->trace
,
661 bt_common_get_page_size() * 8, ctf_fs_ds_file_medops
, NULL
);
663 BT_LOGE_STR("Cannot create a CTF notification iterator.");
667 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, notif_iter
, NULL
, path
);
672 ret
= ctf_fs_ds_file_get_packet_header_context_fields(ds_file
,
673 &packet_header_field
, &packet_context_field
);
675 BT_LOGE("Cannot get stream file's first packet's header and context fields (`%s`).",
680 stream_instance_id
= get_packet_header_stream_instance_id(ctf_fs_trace
,
681 packet_header_field
);
682 begin_ns
= get_packet_context_timestamp_begin_ns(ctf_fs_trace
,
683 packet_context_field
);
684 stream_class
= stream_class_from_packet_header(ctf_fs_trace
,
685 packet_header_field
);
690 index
= ctf_fs_ds_file_build_index(ds_file
);
692 BT_LOGW("Failed to index CTF stream file \'%s\'",
693 ds_file
->file
->path
->str
);
696 if (begin_ns
== -1ULL) {
698 * No beggining timestamp to sort the stream files
699 * within a stream file group, so consider that this
700 * file must be the only one within its group.
702 stream_instance_id
= -1ULL;
705 if (stream_instance_id
== -1ULL) {
707 * No stream instance ID or no beginning timestamp:
708 * create a unique stream file group for this stream
709 * file because, even if there's a stream instance ID,
710 * there's no timestamp to order the file within its
714 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
,
715 stream_class
, stream_instance_id
);
716 if (!ds_file_group
) {
720 ret
= ctf_fs_ds_file_group_add_ds_file_info(ds_file_group
,
721 path
, begin_ns
, index
);
722 /* Ownership of index is transferred. */
732 assert(stream_instance_id
!= -1ULL);
733 assert(begin_ns
!= -1ULL);
735 /* Find an existing stream file group with this ID */
736 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
738 struct bt_ctf_stream_class
*cand_stream_class
;
740 ds_file_group
= g_ptr_array_index(
741 ctf_fs_trace
->ds_file_groups
, i
);
742 id
= bt_ctf_stream_get_id(ds_file_group
->stream
);
743 cand_stream_class
= bt_ctf_stream_get_class(
744 ds_file_group
->stream
);
746 assert(cand_stream_class
);
747 bt_put(cand_stream_class
);
749 if (cand_stream_class
== stream_class
&&
750 (uint64_t) id
== stream_instance_id
) {
754 ds_file_group
= NULL
;
757 if (!ds_file_group
) {
758 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
,
759 stream_class
, stream_instance_id
);
760 if (!ds_file_group
) {
767 ret
= ctf_fs_ds_file_group_add_ds_file_info(ds_file_group
,
768 path
, begin_ns
, index
);
777 ctf_fs_ds_file_group_destroy(ds_file_group
);
781 if (add_group
&& ds_file_group
) {
782 g_ptr_array_add(ctf_fs_trace
->ds_file_groups
, ds_file_group
);
784 ctf_fs_ds_file_destroy(ds_file
);
787 bt_ctf_notif_iter_destroy(notif_iter
);
790 ctf_fs_ds_index_destroy(index
);
791 bt_put(packet_header_field
);
792 bt_put(packet_context_field
);
793 bt_put(stream_class
);
798 int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
801 const char *basename
;
802 GError
*error
= NULL
;
805 /* Check each file in the path directory, except specific ones */
806 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
808 BT_LOGE("Cannot open directory `%s`: %s (code %d)",
809 ctf_fs_trace
->path
->str
, error
->message
,
814 while ((basename
= g_dir_read_name(dir
))) {
815 struct ctf_fs_file
*file
;
817 if (!strcmp(basename
, CTF_FS_METADATA_FILENAME
)) {
818 /* Ignore the metadata stream. */
819 BT_LOGD("Ignoring metadata file `%s/%s`",
820 ctf_fs_trace
->path
->str
, basename
);
824 if (basename
[0] == '.') {
825 BT_LOGD("Ignoring hidden file `%s/%s`",
826 ctf_fs_trace
->path
->str
, basename
);
830 /* Create the file. */
831 file
= ctf_fs_file_create();
833 BT_LOGE("Cannot create stream file object for file `%s/%s`",
834 ctf_fs_trace
->path
->str
, basename
);
838 /* Create full path string. */
839 g_string_append_printf(file
->path
, "%s/%s",
840 ctf_fs_trace
->path
->str
, basename
);
841 if (!g_file_test(file
->path
->str
, G_FILE_TEST_IS_REGULAR
)) {
842 BT_LOGD("Ignoring non-regular file `%s`",
844 ctf_fs_file_destroy(file
);
849 ret
= ctf_fs_file_open(file
, "rb");
851 BT_LOGE("Cannot open stream file `%s`", file
->path
->str
);
855 if (file
->size
== 0) {
856 /* Skip empty stream. */
857 BT_LOGD("Ignoring empty file `%s`", file
->path
->str
);
858 ctf_fs_file_destroy(file
);
862 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
,
865 BT_LOGE("Cannot add stream file `%s` to stream file group",
867 ctf_fs_file_destroy(file
);
871 ctf_fs_file_destroy(file
);
893 int create_cc_prio_map(struct ctf_fs_trace
*ctf_fs_trace
)
899 assert(ctf_fs_trace
);
900 ctf_fs_trace
->cc_prio_map
= bt_clock_class_priority_map_create();
901 if (!ctf_fs_trace
->cc_prio_map
) {
906 count
= bt_ctf_trace_get_clock_class_count(
907 ctf_fs_trace
->metadata
->trace
);
910 for (i
= 0; i
< count
; i
++) {
911 struct bt_ctf_clock_class
*clock_class
=
912 bt_ctf_trace_get_clock_class_by_index(
913 ctf_fs_trace
->metadata
->trace
, i
);
916 ret
= bt_clock_class_priority_map_add_clock_class(
917 ctf_fs_trace
->cc_prio_map
, clock_class
, 0);
930 struct ctf_fs_trace
*ctf_fs_trace_create(const char *path
, const char *name
,
931 struct ctf_fs_metadata_config
*metadata_config
)
933 struct ctf_fs_trace
*ctf_fs_trace
;
936 ctf_fs_trace
= g_new0(struct ctf_fs_trace
, 1);
941 ctf_fs_trace
->path
= g_string_new(path
);
942 if (!ctf_fs_trace
->path
) {
946 ctf_fs_trace
->name
= g_string_new(name
);
947 if (!ctf_fs_trace
->name
) {
951 ctf_fs_trace
->metadata
= g_new0(struct ctf_fs_metadata
, 1);
952 if (!ctf_fs_trace
->metadata
) {
956 ctf_fs_trace
->ds_file_groups
= g_ptr_array_new_with_free_func(
957 (GDestroyNotify
) ctf_fs_ds_file_group_destroy
);
958 if (!ctf_fs_trace
->ds_file_groups
) {
962 ret
= ctf_fs_metadata_set_trace(ctf_fs_trace
, metadata_config
);
967 ret
= create_ds_file_groups(ctf_fs_trace
);
972 ret
= create_cc_prio_map(ctf_fs_trace
);
978 * create_ds_file_groups() created all the streams that this
979 * trace needs. There won't be any more. Therefore it is safe to
980 * make this trace static.
982 (void) bt_ctf_trace_set_is_static(ctf_fs_trace
->metadata
->trace
);
987 ctf_fs_trace_destroy(ctf_fs_trace
);
994 int path_is_ctf_trace(const char *path
)
996 GString
*metadata_path
= g_string_new(NULL
);
999 if (!metadata_path
) {
1004 g_string_printf(metadata_path
, "%s/%s", path
, CTF_FS_METADATA_FILENAME
);
1006 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
1012 g_string_free(metadata_path
, TRUE
);
1017 int add_trace_path(GList
**trace_paths
, const char *path
)
1019 GString
*norm_path
= NULL
;
1022 norm_path
= bt_common_normalize_path(path
, NULL
);
1024 BT_LOGE("Failed to normalize path `%s`.", path
);
1029 if (strcmp(norm_path
->str
, "/") == 0) {
1030 BT_LOGE("Opening a trace in `/` is not supported.");
1035 *trace_paths
= g_list_prepend(*trace_paths
, norm_path
);
1036 assert(*trace_paths
);
1041 g_string_free(norm_path
, TRUE
);
1048 int ctf_fs_find_traces(GList
**trace_paths
, const char *start_path
)
1051 GError
*error
= NULL
;
1053 const char *basename
= NULL
;
1055 /* Check if the starting path is a CTF trace itself */
1056 ret
= path_is_ctf_trace(start_path
);
1063 * Stop recursion: a CTF trace cannot contain another
1066 ret
= add_trace_path(trace_paths
, start_path
);
1070 /* Look for subdirectories */
1071 if (!g_file_test(start_path
, G_FILE_TEST_IS_DIR
)) {
1072 /* Starting path is not a directory: end of recursion */
1076 dir
= g_dir_open(start_path
, 0, &error
);
1078 if (error
->code
== G_FILE_ERROR_ACCES
) {
1079 BT_LOGD("Cannot open directory `%s`: %s (code %d): continuing",
1080 start_path
, error
->message
, error
->code
);
1084 BT_LOGE("Cannot open directory `%s`: %s (code %d)",
1085 start_path
, error
->message
, error
->code
);
1090 while ((basename
= g_dir_read_name(dir
))) {
1091 GString
*sub_path
= g_string_new(NULL
);
1098 g_string_printf(sub_path
, "%s/%s", start_path
, basename
);
1099 ret
= ctf_fs_find_traces(trace_paths
, sub_path
->str
);
1100 g_string_free(sub_path
, TRUE
);
1112 g_error_free(error
);
1119 GList
*ctf_fs_create_trace_names(GList
*trace_paths
, const char *base_path
) {
1120 GList
*trace_names
= NULL
;
1122 const char *last_sep
;
1126 * At this point we know that all the trace paths are
1127 * normalized, and so is the base path. This means that
1128 * they are absolute and they don't end with a separator.
1129 * We can simply find the location of the last separator
1130 * in the base path, which gives us the name of the actual
1131 * directory to look into, and use this location as the
1132 * start of each trace name within each trace path.
1136 * Base path: /home/user/my-traces/some-trace
1138 * - /home/user/my-traces/some-trace/host1/trace1
1139 * - /home/user/my-traces/some-trace/host1/trace2
1140 * - /home/user/my-traces/some-trace/host2/trace
1141 * - /home/user/my-traces/some-trace/other-trace
1143 * In this case the trace names are:
1145 * - some-trace/host1/trace1
1146 * - some-trace/host1/trace2
1147 * - some-trace/host2/trace
1148 * - some-trace/other-trace
1150 last_sep
= strrchr(base_path
, G_DIR_SEPARATOR
);
1152 /* We know there's at least one separator */
1155 /* Distance to base */
1156 base_dist
= last_sep
- base_path
+ 1;
1158 /* Create the trace names */
1159 for (node
= trace_paths
; node
; node
= g_list_next(node
)) {
1160 GString
*trace_name
= g_string_new(NULL
);
1161 GString
*trace_path
= node
->data
;
1164 g_string_assign(trace_name
, &trace_path
->str
[base_dist
]);
1165 trace_names
= g_list_append(trace_names
, trace_name
);
1172 int create_ctf_fs_traces(struct ctf_fs_component
*ctf_fs
,
1173 const char *path_param
)
1175 struct ctf_fs_trace
*ctf_fs_trace
= NULL
;
1177 GString
*norm_path
= NULL
;
1178 GList
*trace_paths
= NULL
;
1179 GList
*trace_names
= NULL
;
1183 norm_path
= bt_common_normalize_path(path_param
, NULL
);
1185 BT_LOGE("Failed to normalize path: `%s`.",
1190 ret
= ctf_fs_find_traces(&trace_paths
, norm_path
->str
);
1196 BT_LOGE("No CTF traces recursively found in `%s`.",
1201 trace_names
= ctf_fs_create_trace_names(trace_paths
, norm_path
->str
);
1203 BT_LOGE("Cannot create trace names from trace paths.");
1207 for (tp_node
= trace_paths
, tn_node
= trace_names
; tp_node
;
1208 tp_node
= g_list_next(tp_node
),
1209 tn_node
= g_list_next(tn_node
)) {
1210 GString
*trace_path
= tp_node
->data
;
1211 GString
*trace_name
= tn_node
->data
;
1213 ctf_fs_trace
= ctf_fs_trace_create(trace_path
->str
,
1214 trace_name
->str
, &ctf_fs
->metadata_config
);
1215 if (!ctf_fs_trace
) {
1216 BT_LOGE("Cannot create trace for `%s`.",
1221 ret
= create_ports_for_trace(ctf_fs
, ctf_fs_trace
);
1226 g_ptr_array_add(ctf_fs
->traces
, ctf_fs_trace
);
1227 ctf_fs_trace
= NULL
;
1234 ctf_fs_trace_destroy(ctf_fs_trace
);
1237 for (tp_node
= trace_paths
; tp_node
; tp_node
= g_list_next(tp_node
)) {
1238 if (tp_node
->data
) {
1239 g_string_free(tp_node
->data
, TRUE
);
1243 for (tn_node
= trace_names
; tn_node
; tn_node
= g_list_next(tn_node
)) {
1244 if (tn_node
->data
) {
1245 g_string_free(tn_node
->data
, TRUE
);
1250 g_list_free(trace_paths
);
1254 g_list_free(trace_names
);
1258 g_string_free(norm_path
, TRUE
);
1265 struct ctf_fs_component
*ctf_fs_create(struct bt_private_component
*priv_comp
,
1266 struct bt_value
*params
)
1268 struct ctf_fs_component
*ctf_fs
;
1269 struct bt_value
*value
= NULL
;
1270 const char *path_param
;
1273 ctf_fs
= g_new0(struct ctf_fs_component
, 1);
1278 ret
= bt_private_component_set_user_data(priv_comp
, ctf_fs
);
1282 * We don't need to get a new reference here because as long as
1283 * our private ctf_fs_component object exists, the containing
1284 * private component should also exist.
1286 ctf_fs
->priv_comp
= priv_comp
;
1287 value
= bt_value_map_get(params
, "path");
1288 if (!bt_value_is_string(value
)) {
1292 ret
= bt_value_string_get(value
, &path_param
);
1295 value
= bt_value_map_get(params
, "clock-class-offset-s");
1297 if (!bt_value_is_integer(value
)) {
1298 BT_LOGE("clock-class-offset-s should be an integer");
1301 ret
= bt_value_integer_get(value
,
1302 &ctf_fs
->metadata_config
.clock_class_offset_s
);
1307 value
= bt_value_map_get(params
, "clock-class-offset-ns");
1309 if (!bt_value_is_integer(value
)) {
1310 BT_LOGE("clock-class-offset-ns should be an integer");
1313 ret
= bt_value_integer_get(value
,
1314 &ctf_fs
->metadata_config
.clock_class_offset_ns
);
1319 ctf_fs
->port_data
= g_ptr_array_new_with_free_func(port_data_destroy
);
1320 if (!ctf_fs
->port_data
) {
1324 ctf_fs
->traces
= g_ptr_array_new_with_free_func(
1325 ctf_fs_trace_destroy_notifier
);
1326 if (!ctf_fs
->traces
) {
1330 ret
= create_ctf_fs_traces(ctf_fs
, path_param
);
1338 ctf_fs_destroy(ctf_fs
);
1340 ret
= bt_private_component_set_user_data(priv_comp
, NULL
);
1349 enum bt_component_status
ctf_fs_init(struct bt_private_component
*priv_comp
,
1350 struct bt_value
*params
, UNUSED_VAR
void *init_method_data
)
1352 struct ctf_fs_component
*ctf_fs
;
1353 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
1355 ctf_fs
= ctf_fs_create(priv_comp
, params
);
1357 ret
= BT_COMPONENT_STATUS_ERROR
;
1364 struct bt_value
*ctf_fs_query(struct bt_component_class
*comp_class
,
1365 const char *object
, struct bt_value
*params
)
1367 struct bt_value
*result
= NULL
;
1369 if (!strcmp(object
, "metadata-info")) {
1370 result
= metadata_info_query(comp_class
, params
);
1371 } else if (!strcmp(object
, "trace-info")) {
1372 result
= trace_info_query(comp_class
, params
);
1374 BT_LOGE("Unknown query object `%s`", object
);