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 GString
*get_stream_instance_unique_name(
288 struct ctf_fs_ds_file_group
*ds_file_group
)
291 struct ctf_fs_ds_file_info
*ds_file_info
;
293 name
= g_string_new(NULL
);
299 * If there's more than one stream file in the stream file
300 * group, the first (earliest) stream file's path is used as
301 * the stream's unique name.
303 assert(ds_file_group
->ds_file_infos
->len
> 0);
304 ds_file_info
= g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
305 g_string_assign(name
, ds_file_info
->path
->str
);
312 int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
313 struct ctf_fs_trace
*ctf_fs_trace
,
314 struct ctf_fs_ds_file_group
*ds_file_group
)
317 struct ctf_fs_port_data
*port_data
= NULL
;
318 GString
*port_name
= NULL
;
320 port_name
= get_stream_instance_unique_name(ds_file_group
);
325 BT_LOGD("Creating one port named `%s`", port_name
->str
);
327 /* Create output port for this file */
328 port_data
= g_new0(struct ctf_fs_port_data
, 1);
333 port_data
->ds_file_group
= ds_file_group
;
334 ret
= bt_private_component_source_add_output_private_port(
335 ctf_fs
->priv_comp
, port_name
->str
, port_data
, NULL
);
340 g_ptr_array_add(ctf_fs
->port_data
, port_data
);
349 g_string_free(port_name
, TRUE
);
352 port_data_destroy(port_data
);
357 int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
358 struct ctf_fs_trace
*ctf_fs_trace
)
363 /* Create one output port for each stream file group */
364 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
365 struct ctf_fs_ds_file_group
*ds_file_group
=
366 g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
368 ret
= create_one_port_for_trace(ctf_fs
, ctf_fs_trace
,
371 BT_LOGE("Cannot create output port.");
380 uint64_t get_packet_header_stream_instance_id(struct ctf_fs_trace
*ctf_fs_trace
,
381 struct bt_ctf_field
*packet_header_field
)
383 struct bt_ctf_field
*stream_instance_id_field
= NULL
;
384 uint64_t stream_instance_id
= -1ULL;
387 if (!packet_header_field
) {
391 stream_instance_id_field
= bt_ctf_field_structure_get_field_by_name(
392 packet_header_field
, "stream_instance_id");
393 if (!stream_instance_id_field
) {
397 ret
= bt_ctf_field_unsigned_integer_get_value(stream_instance_id_field
,
398 &stream_instance_id
);
400 stream_instance_id
= -1ULL;
405 bt_put(stream_instance_id_field
);
406 return stream_instance_id
;
409 struct bt_ctf_stream_class
*stream_class_from_packet_header(
410 struct ctf_fs_trace
*ctf_fs_trace
,
411 struct bt_ctf_field
*packet_header_field
)
413 struct bt_ctf_field
*stream_id_field
= NULL
;
414 struct bt_ctf_stream_class
*stream_class
= NULL
;
415 uint64_t stream_id
= -1ULL;
418 if (!packet_header_field
) {
419 goto single_stream_class
;
422 stream_id_field
= bt_ctf_field_structure_get_field_by_name(
423 packet_header_field
, "stream_id");
424 if (!stream_id_field
) {
425 goto single_stream_class
;
428 ret
= bt_ctf_field_unsigned_integer_get_value(stream_id_field
,
434 if (stream_id
== -1ULL) {
436 /* Single stream class */
437 if (bt_ctf_trace_get_stream_class_count(
438 ctf_fs_trace
->metadata
->trace
) == 0) {
442 stream_class
= bt_ctf_trace_get_stream_class_by_index(
443 ctf_fs_trace
->metadata
->trace
, 0);
445 stream_class
= bt_ctf_trace_get_stream_class_by_id(
446 ctf_fs_trace
->metadata
->trace
, stream_id
);
450 bt_put(stream_id_field
);
454 uint64_t get_packet_context_timestamp_begin_ns(
455 struct ctf_fs_trace
*ctf_fs_trace
,
456 struct bt_ctf_field
*packet_context_field
)
459 struct bt_ctf_field
*timestamp_begin_field
= NULL
;
460 struct bt_ctf_field_type
*timestamp_begin_ft
= NULL
;
461 uint64_t timestamp_begin_raw_value
= -1ULL;
462 uint64_t timestamp_begin_ns
= -1ULL;
463 int64_t timestamp_begin_ns_signed
;
464 struct bt_ctf_clock_class
*timestamp_begin_clock_class
= NULL
;
465 struct bt_ctf_clock_value
*clock_value
= NULL
;
467 if (!packet_context_field
) {
471 timestamp_begin_field
= bt_ctf_field_structure_get_field_by_name(
472 packet_context_field
, "timestamp_begin");
473 if (!timestamp_begin_field
) {
477 timestamp_begin_ft
= bt_ctf_field_get_type(timestamp_begin_field
);
478 assert(timestamp_begin_ft
);
479 timestamp_begin_clock_class
=
480 bt_ctf_field_type_integer_get_mapped_clock_class(timestamp_begin_ft
);
481 if (!timestamp_begin_clock_class
) {
485 ret
= bt_ctf_field_unsigned_integer_get_value(timestamp_begin_field
,
486 ×tamp_begin_raw_value
);
491 clock_value
= bt_ctf_clock_value_create(timestamp_begin_clock_class
,
492 timestamp_begin_raw_value
);
497 ret
= bt_ctf_clock_value_get_value_ns_from_epoch(clock_value
,
498 ×tamp_begin_ns_signed
);
503 timestamp_begin_ns
= (uint64_t) timestamp_begin_ns_signed
;
506 bt_put(timestamp_begin_field
);
507 bt_put(timestamp_begin_ft
);
508 bt_put(timestamp_begin_clock_class
);
510 return timestamp_begin_ns
;
514 void ctf_fs_ds_file_info_destroy(struct ctf_fs_ds_file_info
*ds_file_info
)
520 if (ds_file_info
->path
) {
521 g_string_free(ds_file_info
->path
, TRUE
);
524 ctf_fs_ds_index_destroy(ds_file_info
->index
);
525 g_free(ds_file_info
);
529 struct ctf_fs_ds_file_info
*ctf_fs_ds_file_info_create(const char *path
,
530 uint64_t begin_ns
, struct ctf_fs_ds_index
*index
)
532 struct ctf_fs_ds_file_info
*ds_file_info
;
534 ds_file_info
= g_new0(struct ctf_fs_ds_file_info
, 1);
539 ds_file_info
->path
= g_string_new(path
);
540 if (!ds_file_info
->path
) {
541 ctf_fs_ds_file_info_destroy(ds_file_info
);
546 ds_file_info
->begin_ns
= begin_ns
;
547 ds_file_info
->index
= index
;
551 ctf_fs_ds_index_destroy(index
);
556 void ctf_fs_ds_file_group_destroy(struct ctf_fs_ds_file_group
*ds_file_group
)
558 if (!ds_file_group
) {
562 if (ds_file_group
->ds_file_infos
) {
563 g_ptr_array_free(ds_file_group
->ds_file_infos
, TRUE
);
566 bt_put(ds_file_group
->stream
);
567 bt_put(ds_file_group
->stream_class
);
568 g_free(ds_file_group
);
572 struct ctf_fs_ds_file_group
*ctf_fs_ds_file_group_create(
573 struct ctf_fs_trace
*ctf_fs_trace
,
574 struct bt_ctf_stream_class
*stream_class
,
575 uint64_t stream_instance_id
)
577 struct ctf_fs_ds_file_group
*ds_file_group
;
579 ds_file_group
= g_new0(struct ctf_fs_ds_file_group
, 1);
580 if (!ds_file_group
) {
584 ds_file_group
->ds_file_infos
= g_ptr_array_new_with_free_func(
585 (GDestroyNotify
) ctf_fs_ds_file_info_destroy
);
586 if (!ds_file_group
->ds_file_infos
) {
590 ds_file_group
->stream_id
= stream_instance_id
;
591 assert(stream_class
);
592 ds_file_group
->stream_class
= bt_get(stream_class
);
593 ds_file_group
->ctf_fs_trace
= ctf_fs_trace
;
597 ctf_fs_ds_file_group_destroy(ds_file_group
);
598 ds_file_group
= NULL
;
601 return ds_file_group
;
605 int ctf_fs_ds_file_group_add_ds_file_info(
606 struct ctf_fs_ds_file_group
*ds_file_group
,
607 const char *path
, uint64_t begin_ns
,
608 struct ctf_fs_ds_index
*index
)
610 struct ctf_fs_ds_file_info
*ds_file_info
;
614 /* Onwership of index is transferred. */
615 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
, index
);
621 /* Find a spot to insert this one */
622 for (i
= 0; i
< ds_file_group
->ds_file_infos
->len
; i
++) {
623 struct ctf_fs_ds_file_info
*other_ds_file_info
=
624 g_ptr_array_index(ds_file_group
->ds_file_infos
, i
);
626 if (begin_ns
< other_ds_file_info
->begin_ns
) {
631 if (i
== ds_file_group
->ds_file_infos
->len
) {
636 g_ptr_array_insert(ds_file_group
->ds_file_infos
, i
, ds_file_info
);
641 ctf_fs_ds_file_info_destroy(ds_file_info
);
642 ctf_fs_ds_index_destroy(index
);
649 int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
,
652 struct bt_ctf_field
*packet_header_field
= NULL
;
653 struct bt_ctf_field
*packet_context_field
= NULL
;
654 struct bt_ctf_stream_class
*stream_class
= NULL
;
655 uint64_t stream_instance_id
= -1ULL;
656 uint64_t begin_ns
= -1ULL;
657 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
658 bool add_group
= false;
661 struct ctf_fs_ds_file
*ds_file
= NULL
;
662 struct ctf_fs_ds_index
*index
= NULL
;
663 struct bt_ctf_notif_iter
*notif_iter
= NULL
;
665 notif_iter
= bt_ctf_notif_iter_create(ctf_fs_trace
->metadata
->trace
,
666 bt_common_get_page_size() * 8, ctf_fs_ds_file_medops
, NULL
);
668 BT_LOGE_STR("Cannot create a CTF notification iterator.");
672 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, notif_iter
, NULL
, path
);
677 ret
= ctf_fs_ds_file_get_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
= stream_class_from_packet_header(ctf_fs_trace
,
690 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 assert(stream_instance_id
!= -1ULL);
737 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_ctf_notif_iter_destroy(notif_iter
);
787 ctf_fs_ds_index_destroy(index
);
788 bt_put(packet_header_field
);
789 bt_put(packet_context_field
);
790 bt_put(stream_class
);
795 int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
798 const char *basename
;
799 GError
*error
= NULL
;
803 /* Check each file in the path directory, except specific ones */
804 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
806 BT_LOGE("Cannot open directory `%s`: %s (code %d)",
807 ctf_fs_trace
->path
->str
, error
->message
,
812 while ((basename
= g_dir_read_name(dir
))) {
813 struct ctf_fs_file
*file
;
815 if (!strcmp(basename
, CTF_FS_METADATA_FILENAME
)) {
816 /* Ignore the metadata stream. */
817 BT_LOGD("Ignoring metadata file `%s/%s`",
818 ctf_fs_trace
->path
->str
, basename
);
822 if (basename
[0] == '.') {
823 BT_LOGD("Ignoring hidden file `%s/%s`",
824 ctf_fs_trace
->path
->str
, basename
);
828 /* Create the file. */
829 file
= ctf_fs_file_create();
831 BT_LOGE("Cannot create stream file object for file `%s/%s`",
832 ctf_fs_trace
->path
->str
, basename
);
836 /* Create full path string. */
837 g_string_append_printf(file
->path
, "%s/%s",
838 ctf_fs_trace
->path
->str
, basename
);
839 if (!g_file_test(file
->path
->str
, G_FILE_TEST_IS_REGULAR
)) {
840 BT_LOGD("Ignoring non-regular file `%s`",
842 ctf_fs_file_destroy(file
);
847 ret
= ctf_fs_file_open(file
, "rb");
849 BT_LOGE("Cannot open stream file `%s`", file
->path
->str
);
853 if (file
->size
== 0) {
854 /* Skip empty stream. */
855 BT_LOGD("Ignoring empty file `%s`", file
->path
->str
);
856 ctf_fs_file_destroy(file
);
860 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
,
863 BT_LOGE("Cannot add stream file `%s` to stream file group",
865 ctf_fs_file_destroy(file
);
869 ctf_fs_file_destroy(file
);
873 * At this point, DS file groupes are created, but their
874 * associated stream objects do not exist yet. This is because
875 * we need to name the created stream object with the data
876 * stream file's path. We have everything we need here to do
879 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
880 struct ctf_fs_ds_file_group
*ds_file_group
=
881 g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
882 GString
*name
= get_stream_instance_unique_name(ds_file_group
);
888 if (ds_file_group
->stream_id
== -1ULL) {
890 ds_file_group
->stream
= bt_ctf_stream_create(
891 ds_file_group
->stream_class
, name
->str
);
893 /* Specific stream ID */
894 ds_file_group
->stream
= bt_ctf_stream_create_with_id(
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
) {
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 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_ctf_trace_get_clock_class_count(
942 ctf_fs_trace
->metadata
->trace
);
945 for (i
= 0; i
< count
; i
++) {
946 struct bt_ctf_clock_class
*clock_class
=
947 bt_ctf_trace_get_clock_class_by_index(
948 ctf_fs_trace
->metadata
->trace
, i
);
951 ret
= bt_clock_class_priority_map_add_clock_class(
952 ctf_fs_trace
->cc_prio_map
, clock_class
, 0);
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_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
);
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_ctf_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/%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 if (strcmp(norm_path
->str
, "/") == 0) {
1065 BT_LOGE("Opening a trace in `/` is not supported.");
1070 *trace_paths
= g_list_prepend(*trace_paths
, norm_path
);
1071 assert(*trace_paths
);
1076 g_string_free(norm_path
, TRUE
);
1083 int ctf_fs_find_traces(GList
**trace_paths
, const char *start_path
)
1086 GError
*error
= NULL
;
1088 const char *basename
= NULL
;
1090 /* Check if the starting path is a CTF trace itself */
1091 ret
= path_is_ctf_trace(start_path
);
1098 * Stop recursion: a CTF trace cannot contain another
1101 ret
= add_trace_path(trace_paths
, start_path
);
1105 /* Look for subdirectories */
1106 if (!g_file_test(start_path
, G_FILE_TEST_IS_DIR
)) {
1107 /* Starting path is not a directory: end of recursion */
1111 dir
= g_dir_open(start_path
, 0, &error
);
1113 if (error
->code
== G_FILE_ERROR_ACCES
) {
1114 BT_LOGD("Cannot open directory `%s`: %s (code %d): continuing",
1115 start_path
, error
->message
, error
->code
);
1119 BT_LOGE("Cannot open directory `%s`: %s (code %d)",
1120 start_path
, error
->message
, error
->code
);
1125 while ((basename
= g_dir_read_name(dir
))) {
1126 GString
*sub_path
= g_string_new(NULL
);
1133 g_string_printf(sub_path
, "%s/%s", start_path
, basename
);
1134 ret
= ctf_fs_find_traces(trace_paths
, sub_path
->str
);
1135 g_string_free(sub_path
, TRUE
);
1147 g_error_free(error
);
1154 GList
*ctf_fs_create_trace_names(GList
*trace_paths
, const char *base_path
) {
1155 GList
*trace_names
= NULL
;
1157 const char *last_sep
;
1161 * At this point we know that all the trace paths are
1162 * normalized, and so is the base path. This means that
1163 * they are absolute and they don't end with a separator.
1164 * We can simply find the location of the last separator
1165 * in the base path, which gives us the name of the actual
1166 * directory to look into, and use this location as the
1167 * start of each trace name within each trace path.
1171 * Base path: /home/user/my-traces/some-trace
1173 * - /home/user/my-traces/some-trace/host1/trace1
1174 * - /home/user/my-traces/some-trace/host1/trace2
1175 * - /home/user/my-traces/some-trace/host2/trace
1176 * - /home/user/my-traces/some-trace/other-trace
1178 * In this case the trace names are:
1180 * - some-trace/host1/trace1
1181 * - some-trace/host1/trace2
1182 * - some-trace/host2/trace
1183 * - some-trace/other-trace
1185 last_sep
= strrchr(base_path
, G_DIR_SEPARATOR
);
1187 /* We know there's at least one separator */
1190 /* Distance to base */
1191 base_dist
= last_sep
- base_path
+ 1;
1193 /* Create the trace names */
1194 for (node
= trace_paths
; node
; node
= g_list_next(node
)) {
1195 GString
*trace_name
= g_string_new(NULL
);
1196 GString
*trace_path
= node
->data
;
1199 g_string_assign(trace_name
, &trace_path
->str
[base_dist
]);
1200 trace_names
= g_list_append(trace_names
, trace_name
);
1207 int create_ctf_fs_traces(struct ctf_fs_component
*ctf_fs
,
1208 const char *path_param
)
1210 struct ctf_fs_trace
*ctf_fs_trace
= NULL
;
1212 GString
*norm_path
= NULL
;
1213 GList
*trace_paths
= NULL
;
1214 GList
*trace_names
= NULL
;
1218 norm_path
= bt_common_normalize_path(path_param
, NULL
);
1220 BT_LOGE("Failed to normalize path: `%s`.",
1225 ret
= ctf_fs_find_traces(&trace_paths
, norm_path
->str
);
1231 BT_LOGE("No CTF traces recursively found in `%s`.",
1236 trace_names
= ctf_fs_create_trace_names(trace_paths
, norm_path
->str
);
1238 BT_LOGE("Cannot create trace names from trace paths.");
1242 for (tp_node
= trace_paths
, tn_node
= trace_names
; tp_node
;
1243 tp_node
= g_list_next(tp_node
),
1244 tn_node
= g_list_next(tn_node
)) {
1245 GString
*trace_path
= tp_node
->data
;
1246 GString
*trace_name
= tn_node
->data
;
1248 ctf_fs_trace
= ctf_fs_trace_create(trace_path
->str
,
1249 trace_name
->str
, &ctf_fs
->metadata_config
);
1250 if (!ctf_fs_trace
) {
1251 BT_LOGE("Cannot create trace for `%s`.",
1256 ret
= create_ports_for_trace(ctf_fs
, ctf_fs_trace
);
1261 g_ptr_array_add(ctf_fs
->traces
, ctf_fs_trace
);
1262 ctf_fs_trace
= NULL
;
1269 ctf_fs_trace_destroy(ctf_fs_trace
);
1272 for (tp_node
= trace_paths
; tp_node
; tp_node
= g_list_next(tp_node
)) {
1273 if (tp_node
->data
) {
1274 g_string_free(tp_node
->data
, TRUE
);
1278 for (tn_node
= trace_names
; tn_node
; tn_node
= g_list_next(tn_node
)) {
1279 if (tn_node
->data
) {
1280 g_string_free(tn_node
->data
, TRUE
);
1285 g_list_free(trace_paths
);
1289 g_list_free(trace_names
);
1293 g_string_free(norm_path
, TRUE
);
1300 struct ctf_fs_component
*ctf_fs_create(struct bt_private_component
*priv_comp
,
1301 struct bt_value
*params
)
1303 struct ctf_fs_component
*ctf_fs
;
1304 struct bt_value
*value
= NULL
;
1305 const char *path_param
;
1308 ctf_fs
= g_new0(struct ctf_fs_component
, 1);
1313 ret
= bt_private_component_set_user_data(priv_comp
, ctf_fs
);
1317 * We don't need to get a new reference here because as long as
1318 * our private ctf_fs_component object exists, the containing
1319 * private component should also exist.
1321 ctf_fs
->priv_comp
= priv_comp
;
1322 value
= bt_value_map_get(params
, "path");
1323 if (!bt_value_is_string(value
)) {
1327 ret
= bt_value_string_get(value
, &path_param
);
1330 value
= bt_value_map_get(params
, "clock-class-offset-s");
1332 if (!bt_value_is_integer(value
)) {
1333 BT_LOGE("clock-class-offset-s should be an integer");
1336 ret
= bt_value_integer_get(value
,
1337 &ctf_fs
->metadata_config
.clock_class_offset_s
);
1342 value
= bt_value_map_get(params
, "clock-class-offset-ns");
1344 if (!bt_value_is_integer(value
)) {
1345 BT_LOGE("clock-class-offset-ns should be an integer");
1348 ret
= bt_value_integer_get(value
,
1349 &ctf_fs
->metadata_config
.clock_class_offset_ns
);
1354 ctf_fs
->port_data
= g_ptr_array_new_with_free_func(port_data_destroy
);
1355 if (!ctf_fs
->port_data
) {
1359 ctf_fs
->traces
= g_ptr_array_new_with_free_func(
1360 ctf_fs_trace_destroy_notifier
);
1361 if (!ctf_fs
->traces
) {
1365 ret
= create_ctf_fs_traces(ctf_fs
, path_param
);
1373 ctf_fs_destroy(ctf_fs
);
1375 ret
= bt_private_component_set_user_data(priv_comp
, NULL
);
1384 enum bt_component_status
ctf_fs_init(struct bt_private_component
*priv_comp
,
1385 struct bt_value
*params
, UNUSED_VAR
void *init_method_data
)
1387 struct ctf_fs_component
*ctf_fs
;
1388 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
1390 ctf_fs
= ctf_fs_create(priv_comp
, params
);
1392 ret
= BT_COMPONENT_STATUS_ERROR
;
1399 struct bt_value
*ctf_fs_query(struct bt_component_class
*comp_class
,
1400 const char *object
, struct bt_value
*params
)
1402 struct bt_value
*result
= NULL
;
1404 if (!strcmp(object
, "metadata-info")) {
1405 result
= metadata_info_query(comp_class
, params
);
1406 } else if (!strcmp(object
, "trace-info")) {
1407 result
= trace_info_query(comp_class
, params
);
1409 BT_LOGE("Unknown query object `%s`", object
);