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.");
381 uint64_t get_packet_header_stream_instance_id(struct ctf_fs_trace
*ctf_fs_trace
,
382 struct bt_ctf_field
*packet_header_field
)
384 struct bt_ctf_field
*stream_instance_id_field
= NULL
;
385 uint64_t stream_instance_id
= -1ULL;
388 if (!packet_header_field
) {
392 stream_instance_id_field
= bt_ctf_field_structure_get_field_by_name(
393 packet_header_field
, "stream_instance_id");
394 if (!stream_instance_id_field
) {
398 ret
= bt_ctf_field_unsigned_integer_get_value(stream_instance_id_field
,
399 &stream_instance_id
);
401 stream_instance_id
= -1ULL;
406 bt_put(stream_instance_id_field
);
407 return stream_instance_id
;
410 struct bt_ctf_stream_class
*stream_class_from_packet_header(
411 struct ctf_fs_trace
*ctf_fs_trace
,
412 struct bt_ctf_field
*packet_header_field
)
414 struct bt_ctf_field
*stream_id_field
= NULL
;
415 struct bt_ctf_stream_class
*stream_class
= NULL
;
416 uint64_t stream_id
= -1ULL;
419 if (!packet_header_field
) {
420 goto single_stream_class
;
423 stream_id_field
= bt_ctf_field_structure_get_field_by_name(
424 packet_header_field
, "stream_id");
425 if (!stream_id_field
) {
426 goto single_stream_class
;
429 ret
= bt_ctf_field_unsigned_integer_get_value(stream_id_field
,
435 if (stream_id
== -1ULL) {
437 /* Single stream class */
438 if (bt_ctf_trace_get_stream_class_count(
439 ctf_fs_trace
->metadata
->trace
) == 0) {
443 stream_class
= bt_ctf_trace_get_stream_class_by_index(
444 ctf_fs_trace
->metadata
->trace
, 0);
446 stream_class
= bt_ctf_trace_get_stream_class_by_id(
447 ctf_fs_trace
->metadata
->trace
, stream_id
);
451 bt_put(stream_id_field
);
455 uint64_t get_packet_context_timestamp_begin_ns(
456 struct ctf_fs_trace
*ctf_fs_trace
,
457 struct bt_ctf_field
*packet_context_field
)
460 struct bt_ctf_field
*timestamp_begin_field
= NULL
;
461 struct bt_ctf_field_type
*timestamp_begin_ft
= NULL
;
462 uint64_t timestamp_begin_raw_value
= -1ULL;
463 uint64_t timestamp_begin_ns
= -1ULL;
464 int64_t timestamp_begin_ns_signed
;
465 struct bt_ctf_clock_class
*timestamp_begin_clock_class
= NULL
;
466 struct bt_ctf_clock_value
*clock_value
= NULL
;
468 if (!packet_context_field
) {
472 timestamp_begin_field
= bt_ctf_field_structure_get_field_by_name(
473 packet_context_field
, "timestamp_begin");
474 if (!timestamp_begin_field
) {
478 timestamp_begin_ft
= bt_ctf_field_get_type(timestamp_begin_field
);
479 assert(timestamp_begin_ft
);
480 timestamp_begin_clock_class
=
481 bt_ctf_field_type_integer_get_mapped_clock_class(timestamp_begin_ft
);
482 if (!timestamp_begin_clock_class
) {
486 ret
= bt_ctf_field_unsigned_integer_get_value(timestamp_begin_field
,
487 ×tamp_begin_raw_value
);
492 clock_value
= bt_ctf_clock_value_create(timestamp_begin_clock_class
,
493 timestamp_begin_raw_value
);
498 ret
= bt_ctf_clock_value_get_value_ns_from_epoch(clock_value
,
499 ×tamp_begin_ns_signed
);
504 timestamp_begin_ns
= (uint64_t) timestamp_begin_ns_signed
;
507 bt_put(timestamp_begin_field
);
508 bt_put(timestamp_begin_ft
);
509 bt_put(timestamp_begin_clock_class
);
511 return timestamp_begin_ns
;
515 void ctf_fs_ds_file_info_destroy(struct ctf_fs_ds_file_info
*ds_file_info
)
521 if (ds_file_info
->path
) {
522 g_string_free(ds_file_info
->path
, TRUE
);
525 ctf_fs_ds_index_destroy(ds_file_info
->index
);
526 g_free(ds_file_info
);
530 struct ctf_fs_ds_file_info
*ctf_fs_ds_file_info_create(const char *path
,
531 uint64_t begin_ns
, struct ctf_fs_ds_index
*index
)
533 struct ctf_fs_ds_file_info
*ds_file_info
;
535 ds_file_info
= g_new0(struct ctf_fs_ds_file_info
, 1);
540 ds_file_info
->path
= g_string_new(path
);
541 if (!ds_file_info
->path
) {
542 ctf_fs_ds_file_info_destroy(ds_file_info
);
547 ds_file_info
->begin_ns
= begin_ns
;
548 ds_file_info
->index
= index
;
552 ctf_fs_ds_index_destroy(index
);
557 void ctf_fs_ds_file_group_destroy(struct ctf_fs_ds_file_group
*ds_file_group
)
559 if (!ds_file_group
) {
563 if (ds_file_group
->ds_file_infos
) {
564 g_ptr_array_free(ds_file_group
->ds_file_infos
, TRUE
);
567 bt_put(ds_file_group
->stream
);
568 bt_put(ds_file_group
->stream_class
);
569 g_free(ds_file_group
);
573 struct ctf_fs_ds_file_group
*ctf_fs_ds_file_group_create(
574 struct ctf_fs_trace
*ctf_fs_trace
,
575 struct bt_ctf_stream_class
*stream_class
,
576 uint64_t stream_instance_id
)
578 struct ctf_fs_ds_file_group
*ds_file_group
;
580 ds_file_group
= g_new0(struct ctf_fs_ds_file_group
, 1);
581 if (!ds_file_group
) {
585 ds_file_group
->ds_file_infos
= g_ptr_array_new_with_free_func(
586 (GDestroyNotify
) ctf_fs_ds_file_info_destroy
);
587 if (!ds_file_group
->ds_file_infos
) {
591 ds_file_group
->stream_id
= stream_instance_id
;
592 assert(stream_class
);
593 ds_file_group
->stream_class
= bt_get(stream_class
);
594 ds_file_group
->ctf_fs_trace
= ctf_fs_trace
;
598 ctf_fs_ds_file_group_destroy(ds_file_group
);
599 ds_file_group
= NULL
;
602 return ds_file_group
;
605 /* Replace by g_ptr_array_insert when we depend on glib >= 2.40. */
607 void array_insert(GPtrArray
*array
, gpointer element
, size_t pos
)
609 size_t original_array_len
= array
->len
;
611 /* Allocate an unused element at the end of the array. */
612 g_ptr_array_add(array
, NULL
);
614 /* If we are not inserting at the end, move the elements by one. */
615 if (pos
< original_array_len
) {
616 memmove(&(array
->pdata
[pos
+ 1]),
617 &(array
->pdata
[pos
]),
618 (original_array_len
- pos
) * sizeof(gpointer
));
621 /* Insert the value and bump the array len */
622 array
->pdata
[pos
] = element
;
626 int ctf_fs_ds_file_group_add_ds_file_info(
627 struct ctf_fs_ds_file_group
*ds_file_group
,
628 const char *path
, uint64_t begin_ns
,
629 struct ctf_fs_ds_index
*index
)
631 struct ctf_fs_ds_file_info
*ds_file_info
;
635 /* Onwership of index is transferred. */
636 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
, index
);
642 /* Find a spot to insert this one */
643 for (i
= 0; i
< ds_file_group
->ds_file_infos
->len
; i
++) {
644 struct ctf_fs_ds_file_info
*other_ds_file_info
=
645 g_ptr_array_index(ds_file_group
->ds_file_infos
, i
);
647 if (begin_ns
< other_ds_file_info
->begin_ns
) {
652 array_insert(ds_file_group
->ds_file_infos
, ds_file_info
, i
);
657 ctf_fs_ds_file_info_destroy(ds_file_info
);
658 ctf_fs_ds_index_destroy(index
);
665 int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
,
668 struct bt_ctf_field
*packet_header_field
= NULL
;
669 struct bt_ctf_field
*packet_context_field
= NULL
;
670 struct bt_ctf_stream_class
*stream_class
= NULL
;
671 uint64_t stream_instance_id
= -1ULL;
672 uint64_t begin_ns
= -1ULL;
673 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
674 bool add_group
= false;
677 struct ctf_fs_ds_file
*ds_file
= NULL
;
678 struct ctf_fs_ds_index
*index
= NULL
;
679 struct bt_ctf_notif_iter
*notif_iter
= NULL
;
681 notif_iter
= bt_ctf_notif_iter_create(ctf_fs_trace
->metadata
->trace
,
682 bt_common_get_page_size() * 8, ctf_fs_ds_file_medops
, NULL
);
684 BT_LOGE_STR("Cannot create a CTF notification iterator.");
688 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, notif_iter
, NULL
, path
);
693 ret
= ctf_fs_ds_file_get_packet_header_context_fields(ds_file
,
694 &packet_header_field
, &packet_context_field
);
696 BT_LOGE("Cannot get stream file's first packet's header and context fields (`%s`).",
701 stream_instance_id
= get_packet_header_stream_instance_id(ctf_fs_trace
,
702 packet_header_field
);
703 begin_ns
= get_packet_context_timestamp_begin_ns(ctf_fs_trace
,
704 packet_context_field
);
705 stream_class
= stream_class_from_packet_header(ctf_fs_trace
,
706 packet_header_field
);
711 index
= ctf_fs_ds_file_build_index(ds_file
);
713 BT_LOGW("Failed to index CTF stream file \'%s\'",
714 ds_file
->file
->path
->str
);
717 if (begin_ns
== -1ULL) {
719 * No beggining timestamp to sort the stream files
720 * within a stream file group, so consider that this
721 * file must be the only one within its group.
723 stream_instance_id
= -1ULL;
726 if (stream_instance_id
== -1ULL) {
728 * No stream instance ID or no beginning timestamp:
729 * create a unique stream file group for this stream
730 * file because, even if there's a stream instance ID,
731 * there's no timestamp to order the file within its
734 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
,
735 stream_class
, stream_instance_id
);
736 if (!ds_file_group
) {
740 ret
= ctf_fs_ds_file_group_add_ds_file_info(ds_file_group
,
741 path
, begin_ns
, index
);
742 /* Ownership of index is transferred. */
752 assert(stream_instance_id
!= -1ULL);
753 assert(begin_ns
!= -1ULL);
755 /* Find an existing stream file group with this ID */
756 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
757 ds_file_group
= g_ptr_array_index(
758 ctf_fs_trace
->ds_file_groups
, i
);
760 if (ds_file_group
->stream_class
== stream_class
&&
761 ds_file_group
->stream_id
==
762 stream_instance_id
) {
766 ds_file_group
= NULL
;
769 if (!ds_file_group
) {
770 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
,
771 stream_class
, stream_instance_id
);
772 if (!ds_file_group
) {
779 ret
= ctf_fs_ds_file_group_add_ds_file_info(ds_file_group
, path
,
789 ctf_fs_ds_file_group_destroy(ds_file_group
);
793 if (add_group
&& ds_file_group
) {
794 g_ptr_array_add(ctf_fs_trace
->ds_file_groups
, ds_file_group
);
797 ctf_fs_ds_file_destroy(ds_file
);
800 bt_ctf_notif_iter_destroy(notif_iter
);
803 ctf_fs_ds_index_destroy(index
);
804 bt_put(packet_header_field
);
805 bt_put(packet_context_field
);
806 bt_put(stream_class
);
811 int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
814 const char *basename
;
815 GError
*error
= NULL
;
819 /* Check each file in the path directory, except specific ones */
820 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
822 BT_LOGE("Cannot open directory `%s`: %s (code %d)",
823 ctf_fs_trace
->path
->str
, error
->message
,
828 while ((basename
= g_dir_read_name(dir
))) {
829 struct ctf_fs_file
*file
;
831 if (!strcmp(basename
, CTF_FS_METADATA_FILENAME
)) {
832 /* Ignore the metadata stream. */
833 BT_LOGD("Ignoring metadata file `%s/%s`",
834 ctf_fs_trace
->path
->str
, basename
);
838 if (basename
[0] == '.') {
839 BT_LOGD("Ignoring hidden file `%s/%s`",
840 ctf_fs_trace
->path
->str
, basename
);
844 /* Create the file. */
845 file
= ctf_fs_file_create();
847 BT_LOGE("Cannot create stream file object for file `%s/%s`",
848 ctf_fs_trace
->path
->str
, basename
);
852 /* Create full path string. */
853 g_string_append_printf(file
->path
, "%s/%s",
854 ctf_fs_trace
->path
->str
, basename
);
855 if (!g_file_test(file
->path
->str
, G_FILE_TEST_IS_REGULAR
)) {
856 BT_LOGD("Ignoring non-regular file `%s`",
858 ctf_fs_file_destroy(file
);
863 ret
= ctf_fs_file_open(file
, "rb");
865 BT_LOGE("Cannot open stream file `%s`", file
->path
->str
);
869 if (file
->size
== 0) {
870 /* Skip empty stream. */
871 BT_LOGD("Ignoring empty file `%s`", file
->path
->str
);
872 ctf_fs_file_destroy(file
);
876 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
,
879 BT_LOGE("Cannot add stream file `%s` to stream file group",
881 ctf_fs_file_destroy(file
);
885 ctf_fs_file_destroy(file
);
889 * At this point, DS file groupes are created, but their
890 * associated stream objects do not exist yet. This is because
891 * we need to name the created stream object with the data
892 * stream file's path. We have everything we need here to do
895 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
896 struct ctf_fs_ds_file_group
*ds_file_group
=
897 g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
898 GString
*name
= get_stream_instance_unique_name(ds_file_group
);
904 if (ds_file_group
->stream_id
== -1ULL) {
906 ds_file_group
->stream
= bt_ctf_stream_create(
907 ds_file_group
->stream_class
, name
->str
);
909 /* Specific stream ID */
910 ds_file_group
->stream
= bt_ctf_stream_create_with_id(
911 ds_file_group
->stream_class
, name
->str
,
912 ds_file_group
->stream_id
);
915 g_string_free(name
, TRUE
);
917 if (!ds_file_group
->stream
) {
918 BT_LOGE("Cannot create stream for DS file group: "
919 "addr=%p, stream-name=\"%s\"",
920 ds_file_group
, name
->str
);
944 int create_cc_prio_map(struct ctf_fs_trace
*ctf_fs_trace
)
950 assert(ctf_fs_trace
);
951 ctf_fs_trace
->cc_prio_map
= bt_clock_class_priority_map_create();
952 if (!ctf_fs_trace
->cc_prio_map
) {
957 count
= bt_ctf_trace_get_clock_class_count(
958 ctf_fs_trace
->metadata
->trace
);
961 for (i
= 0; i
< count
; i
++) {
962 struct bt_ctf_clock_class
*clock_class
=
963 bt_ctf_trace_get_clock_class_by_index(
964 ctf_fs_trace
->metadata
->trace
, i
);
967 ret
= bt_clock_class_priority_map_add_clock_class(
968 ctf_fs_trace
->cc_prio_map
, clock_class
, 0);
981 struct ctf_fs_trace
*ctf_fs_trace_create(const char *path
, const char *name
,
982 struct ctf_fs_metadata_config
*metadata_config
)
984 struct ctf_fs_trace
*ctf_fs_trace
;
987 ctf_fs_trace
= g_new0(struct ctf_fs_trace
, 1);
992 ctf_fs_trace
->path
= g_string_new(path
);
993 if (!ctf_fs_trace
->path
) {
997 ctf_fs_trace
->name
= g_string_new(name
);
998 if (!ctf_fs_trace
->name
) {
1002 ctf_fs_trace
->metadata
= g_new0(struct ctf_fs_metadata
, 1);
1003 if (!ctf_fs_trace
->metadata
) {
1007 ctf_fs_trace
->ds_file_groups
= g_ptr_array_new_with_free_func(
1008 (GDestroyNotify
) ctf_fs_ds_file_group_destroy
);
1009 if (!ctf_fs_trace
->ds_file_groups
) {
1013 ret
= ctf_fs_metadata_set_trace(ctf_fs_trace
, metadata_config
);
1018 ret
= create_ds_file_groups(ctf_fs_trace
);
1023 ret
= create_cc_prio_map(ctf_fs_trace
);
1029 * create_ds_file_groups() created all the streams that this
1030 * trace needs. There won't be any more. Therefore it is safe to
1031 * make this trace static.
1033 (void) bt_ctf_trace_set_is_static(ctf_fs_trace
->metadata
->trace
);
1038 ctf_fs_trace_destroy(ctf_fs_trace
);
1039 ctf_fs_trace
= NULL
;
1041 return ctf_fs_trace
;
1045 int path_is_ctf_trace(const char *path
)
1047 GString
*metadata_path
= g_string_new(NULL
);
1050 if (!metadata_path
) {
1055 g_string_printf(metadata_path
, "%s/%s", path
, CTF_FS_METADATA_FILENAME
);
1057 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
1063 g_string_free(metadata_path
, TRUE
);
1068 int add_trace_path(GList
**trace_paths
, const char *path
)
1070 GString
*norm_path
= NULL
;
1073 norm_path
= bt_common_normalize_path(path
, NULL
);
1075 BT_LOGE("Failed to normalize path `%s`.", path
);
1080 if (strcmp(norm_path
->str
, "/") == 0) {
1081 BT_LOGE("Opening a trace in `/` is not supported.");
1086 *trace_paths
= g_list_prepend(*trace_paths
, norm_path
);
1087 assert(*trace_paths
);
1092 g_string_free(norm_path
, TRUE
);
1099 int ctf_fs_find_traces(GList
**trace_paths
, const char *start_path
)
1102 GError
*error
= NULL
;
1104 const char *basename
= NULL
;
1106 /* Check if the starting path is a CTF trace itself */
1107 ret
= path_is_ctf_trace(start_path
);
1114 * Stop recursion: a CTF trace cannot contain another
1117 ret
= add_trace_path(trace_paths
, start_path
);
1121 /* Look for subdirectories */
1122 if (!g_file_test(start_path
, G_FILE_TEST_IS_DIR
)) {
1123 /* Starting path is not a directory: end of recursion */
1127 dir
= g_dir_open(start_path
, 0, &error
);
1129 if (error
->code
== G_FILE_ERROR_ACCES
) {
1130 BT_LOGD("Cannot open directory `%s`: %s (code %d): continuing",
1131 start_path
, error
->message
, error
->code
);
1135 BT_LOGE("Cannot open directory `%s`: %s (code %d)",
1136 start_path
, error
->message
, error
->code
);
1141 while ((basename
= g_dir_read_name(dir
))) {
1142 GString
*sub_path
= g_string_new(NULL
);
1149 g_string_printf(sub_path
, "%s/%s", start_path
, basename
);
1150 ret
= ctf_fs_find_traces(trace_paths
, sub_path
->str
);
1151 g_string_free(sub_path
, TRUE
);
1163 g_error_free(error
);
1170 GList
*ctf_fs_create_trace_names(GList
*trace_paths
, const char *base_path
) {
1171 GList
*trace_names
= NULL
;
1173 const char *last_sep
;
1177 * At this point we know that all the trace paths are
1178 * normalized, and so is the base path. This means that
1179 * they are absolute and they don't end with a separator.
1180 * We can simply find the location of the last separator
1181 * in the base path, which gives us the name of the actual
1182 * directory to look into, and use this location as the
1183 * start of each trace name within each trace path.
1187 * Base path: /home/user/my-traces/some-trace
1189 * - /home/user/my-traces/some-trace/host1/trace1
1190 * - /home/user/my-traces/some-trace/host1/trace2
1191 * - /home/user/my-traces/some-trace/host2/trace
1192 * - /home/user/my-traces/some-trace/other-trace
1194 * In this case the trace names are:
1196 * - some-trace/host1/trace1
1197 * - some-trace/host1/trace2
1198 * - some-trace/host2/trace
1199 * - some-trace/other-trace
1201 last_sep
= strrchr(base_path
, G_DIR_SEPARATOR
);
1203 /* We know there's at least one separator */
1206 /* Distance to base */
1207 base_dist
= last_sep
- base_path
+ 1;
1209 /* Create the trace names */
1210 for (node
= trace_paths
; node
; node
= g_list_next(node
)) {
1211 GString
*trace_name
= g_string_new(NULL
);
1212 GString
*trace_path
= node
->data
;
1215 g_string_assign(trace_name
, &trace_path
->str
[base_dist
]);
1216 trace_names
= g_list_append(trace_names
, trace_name
);
1223 int create_ctf_fs_traces(struct ctf_fs_component
*ctf_fs
,
1224 const char *path_param
)
1226 struct ctf_fs_trace
*ctf_fs_trace
= NULL
;
1228 GString
*norm_path
= NULL
;
1229 GList
*trace_paths
= NULL
;
1230 GList
*trace_names
= NULL
;
1234 norm_path
= bt_common_normalize_path(path_param
, NULL
);
1236 BT_LOGE("Failed to normalize path: `%s`.",
1241 ret
= ctf_fs_find_traces(&trace_paths
, norm_path
->str
);
1247 BT_LOGE("No CTF traces recursively found in `%s`.",
1252 trace_names
= ctf_fs_create_trace_names(trace_paths
, norm_path
->str
);
1254 BT_LOGE("Cannot create trace names from trace paths.");
1258 for (tp_node
= trace_paths
, tn_node
= trace_names
; tp_node
;
1259 tp_node
= g_list_next(tp_node
),
1260 tn_node
= g_list_next(tn_node
)) {
1261 GString
*trace_path
= tp_node
->data
;
1262 GString
*trace_name
= tn_node
->data
;
1264 ctf_fs_trace
= ctf_fs_trace_create(trace_path
->str
,
1265 trace_name
->str
, &ctf_fs
->metadata_config
);
1266 if (!ctf_fs_trace
) {
1267 BT_LOGE("Cannot create trace for `%s`.",
1272 ret
= create_ports_for_trace(ctf_fs
, ctf_fs_trace
);
1277 g_ptr_array_add(ctf_fs
->traces
, ctf_fs_trace
);
1278 ctf_fs_trace
= NULL
;
1285 ctf_fs_trace_destroy(ctf_fs_trace
);
1288 for (tp_node
= trace_paths
; tp_node
; tp_node
= g_list_next(tp_node
)) {
1289 if (tp_node
->data
) {
1290 g_string_free(tp_node
->data
, TRUE
);
1294 for (tn_node
= trace_names
; tn_node
; tn_node
= g_list_next(tn_node
)) {
1295 if (tn_node
->data
) {
1296 g_string_free(tn_node
->data
, TRUE
);
1301 g_list_free(trace_paths
);
1305 g_list_free(trace_names
);
1309 g_string_free(norm_path
, TRUE
);
1316 struct ctf_fs_component
*ctf_fs_create(struct bt_private_component
*priv_comp
,
1317 struct bt_value
*params
)
1319 struct ctf_fs_component
*ctf_fs
;
1320 struct bt_value
*value
= NULL
;
1321 const char *path_param
;
1324 ctf_fs
= g_new0(struct ctf_fs_component
, 1);
1329 ret
= bt_private_component_set_user_data(priv_comp
, ctf_fs
);
1333 * We don't need to get a new reference here because as long as
1334 * our private ctf_fs_component object exists, the containing
1335 * private component should also exist.
1337 ctf_fs
->priv_comp
= priv_comp
;
1338 value
= bt_value_map_get(params
, "path");
1339 if (!bt_value_is_string(value
)) {
1343 ret
= bt_value_string_get(value
, &path_param
);
1346 value
= bt_value_map_get(params
, "clock-class-offset-s");
1348 if (!bt_value_is_integer(value
)) {
1349 BT_LOGE("clock-class-offset-s should be an integer");
1352 ret
= bt_value_integer_get(value
,
1353 &ctf_fs
->metadata_config
.clock_class_offset_s
);
1358 value
= bt_value_map_get(params
, "clock-class-offset-ns");
1360 if (!bt_value_is_integer(value
)) {
1361 BT_LOGE("clock-class-offset-ns should be an integer");
1364 ret
= bt_value_integer_get(value
,
1365 &ctf_fs
->metadata_config
.clock_class_offset_ns
);
1370 ctf_fs
->port_data
= g_ptr_array_new_with_free_func(port_data_destroy
);
1371 if (!ctf_fs
->port_data
) {
1375 ctf_fs
->traces
= g_ptr_array_new_with_free_func(
1376 ctf_fs_trace_destroy_notifier
);
1377 if (!ctf_fs
->traces
) {
1381 ret
= create_ctf_fs_traces(ctf_fs
, path_param
);
1389 ctf_fs_destroy(ctf_fs
);
1391 ret
= bt_private_component_set_user_data(priv_comp
, NULL
);
1400 enum bt_component_status
ctf_fs_init(struct bt_private_component
*priv_comp
,
1401 struct bt_value
*params
, UNUSED_VAR
void *init_method_data
)
1403 struct ctf_fs_component
*ctf_fs
;
1404 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
1406 ctf_fs
= ctf_fs_create(priv_comp
, params
);
1408 ret
= BT_COMPONENT_STATUS_ERROR
;
1415 struct bt_value
*ctf_fs_query(struct bt_component_class
*comp_class
,
1416 const char *object
, struct bt_value
*params
)
1418 struct bt_value
*result
= NULL
;
1420 if (!strcmp(object
, "metadata-info")) {
1421 result
= metadata_info_query(comp_class
, params
);
1422 } else if (!strcmp(object
, "trace-info")) {
1423 result
= trace_info_query(comp_class
, params
);
1425 BT_LOGE("Unknown query object `%s`", object
);