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
->notif_iter
,
63 notif_iter_data
->ds_file_group
->stream
,
64 ds_file_info
->path
->str
);
65 if (!notif_iter_data
->ds_file
) {
73 void ctf_fs_notif_iter_data_destroy(
74 struct ctf_fs_notif_iter_data
*notif_iter_data
)
76 if (!notif_iter_data
) {
80 ctf_fs_ds_file_destroy(notif_iter_data
->ds_file
);
82 if (notif_iter_data
->notif_iter
) {
83 bt_notif_iter_destroy(notif_iter_data
->notif_iter
);
86 g_free(notif_iter_data
);
89 struct bt_notification_iterator_next_method_return
ctf_fs_iterator_next(
90 struct bt_private_connection_private_notification_iterator
*iterator
)
92 struct bt_notification_iterator_next_method_return next_ret
;
93 struct ctf_fs_notif_iter_data
*notif_iter_data
=
94 bt_private_connection_private_notification_iterator_get_user_data(iterator
);
97 BT_ASSERT(notif_iter_data
->ds_file
);
98 next_ret
= ctf_fs_ds_file_next(notif_iter_data
->ds_file
);
100 if (next_ret
.status
== BT_NOTIFICATION_ITERATOR_STATUS_OK
&&
101 bt_notification_get_type(next_ret
.notification
) ==
102 BT_NOTIFICATION_TYPE_STREAM_BEGIN
) {
103 if (notif_iter_data
->skip_stream_begin_notifs
) {
105 * We already emitted a
106 * BT_NOTIFICATION_TYPE_STREAM_BEGIN
107 * notification: skip this one, get a new one.
109 BT_PUT(next_ret
.notification
);
110 next_ret
= ctf_fs_ds_file_next(notif_iter_data
->ds_file
);
111 BT_ASSERT(next_ret
.status
!= BT_NOTIFICATION_ITERATOR_STATUS_END
);
115 * First BT_NOTIFICATION_TYPE_STREAM_BEGIN
116 * notification: skip all following.
118 notif_iter_data
->skip_stream_begin_notifs
= true;
123 if (next_ret
.status
== BT_NOTIFICATION_ITERATOR_STATUS_OK
&&
124 bt_notification_get_type(next_ret
.notification
) ==
125 BT_NOTIFICATION_TYPE_STREAM_END
) {
126 notif_iter_data
->ds_file_info_index
++;
128 if (notif_iter_data
->ds_file_info_index
==
129 notif_iter_data
->ds_file_group
->ds_file_infos
->len
) {
131 * No more stream files to read: we reached the
132 * real end. Emit this
133 * BT_NOTIFICATION_TYPE_STREAM_END notification.
134 * The next time ctf_fs_iterator_next() is
135 * called for this notification iterator,
136 * ctf_fs_ds_file_next() will return
137 * BT_NOTIFICATION_ITERATOR_STATUS_END().
142 BT_PUT(next_ret
.notification
);
143 bt_notif_iter_reset(notif_iter_data
->notif_iter
);
146 * Open and start reading the next stream file within
147 * our stream file group.
149 ret
= notif_iter_data_set_current_ds_file(notif_iter_data
);
151 next_ret
.status
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
155 next_ret
= ctf_fs_ds_file_next(notif_iter_data
->ds_file
);
158 * If we get a notification, we expect to get a
159 * BT_NOTIFICATION_TYPE_STREAM_BEGIN notification
160 * because the iterator's state machine emits one before
161 * even requesting the first block of data from the
162 * medium. Skip this notification because we're not
163 * really starting a new stream here, and try getting a
164 * new notification (which, if it works, is a
165 * BT_NOTIFICATION_TYPE_PACKET_BEGIN one). We're sure to
166 * get at least one pair of
167 * BT_NOTIFICATION_TYPE_PACKET_BEGIN and
168 * BT_NOTIFICATION_TYPE_PACKET_END notifications in the
169 * case of a single, empty packet. We know there's at
170 * least one packet because the stream file group does
171 * not contain empty stream files.
173 BT_ASSERT(notif_iter_data
->skip_stream_begin_notifs
);
175 if (next_ret
.status
== BT_NOTIFICATION_ITERATOR_STATUS_OK
) {
176 BT_ASSERT(bt_notification_get_type(next_ret
.notification
) ==
177 BT_NOTIFICATION_TYPE_STREAM_BEGIN
);
178 BT_PUT(next_ret
.notification
);
179 next_ret
= ctf_fs_ds_file_next(notif_iter_data
->ds_file
);
180 BT_ASSERT(next_ret
.status
!= BT_NOTIFICATION_ITERATOR_STATUS_END
);
188 void ctf_fs_iterator_finalize(struct bt_private_connection_private_notification_iterator
*it
)
190 void *notif_iter_data
=
191 bt_private_connection_private_notification_iterator_get_user_data(it
);
193 ctf_fs_notif_iter_data_destroy(notif_iter_data
);
196 enum bt_notification_iterator_status
ctf_fs_iterator_init(
197 struct bt_private_connection_private_notification_iterator
*it
,
198 struct bt_private_port
*port
)
200 struct ctf_fs_port_data
*port_data
;
201 struct ctf_fs_notif_iter_data
*notif_iter_data
= NULL
;
202 enum bt_notification_iterator_status ret
=
203 BT_NOTIFICATION_ITERATOR_STATUS_OK
;
206 port_data
= bt_private_port_get_user_data(port
);
208 ret
= BT_NOTIFICATION_ITERATOR_STATUS_INVALID
;
212 notif_iter_data
= g_new0(struct ctf_fs_notif_iter_data
, 1);
213 if (!notif_iter_data
) {
214 ret
= BT_NOTIFICATION_ITERATOR_STATUS_NOMEM
;
218 notif_iter_data
->notif_iter
= bt_notif_iter_create(
219 port_data
->ds_file_group
->ctf_fs_trace
->metadata
->trace
,
220 bt_common_get_page_size() * 8,
221 ctf_fs_ds_file_medops
, NULL
);
222 if (!notif_iter_data
->notif_iter
) {
223 BT_LOGE_STR("Cannot create a CTF notification iterator.");
224 ret
= BT_NOTIFICATION_ITERATOR_STATUS_NOMEM
;
228 notif_iter_data
->ds_file_group
= port_data
->ds_file_group
;
229 iret
= notif_iter_data_set_current_ds_file(notif_iter_data
);
231 ret
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
235 ret
= bt_private_connection_private_notification_iterator_set_user_data(it
, notif_iter_data
);
236 if (ret
!= BT_NOTIFICATION_ITERATOR_STATUS_OK
) {
240 notif_iter_data
= NULL
;
244 (void) bt_private_connection_private_notification_iterator_set_user_data(it
, NULL
);
247 ctf_fs_notif_iter_data_destroy(notif_iter_data
);
252 void ctf_fs_destroy(struct ctf_fs_component
*ctf_fs
)
258 if (ctf_fs
->traces
) {
259 g_ptr_array_free(ctf_fs
->traces
, TRUE
);
262 if (ctf_fs
->port_data
) {
263 g_ptr_array_free(ctf_fs
->port_data
, TRUE
);
270 void ctf_fs_trace_destroy(struct ctf_fs_trace
*ctf_fs_trace
)
276 if (ctf_fs_trace
->ds_file_groups
) {
277 g_ptr_array_free(ctf_fs_trace
->ds_file_groups
, TRUE
);
280 if (ctf_fs_trace
->path
) {
281 g_string_free(ctf_fs_trace
->path
, TRUE
);
284 if (ctf_fs_trace
->name
) {
285 g_string_free(ctf_fs_trace
->name
, TRUE
);
288 if (ctf_fs_trace
->metadata
) {
289 ctf_fs_metadata_fini(ctf_fs_trace
->metadata
);
290 g_free(ctf_fs_trace
->metadata
);
293 bt_put(ctf_fs_trace
->cc_prio_map
);
294 g_free(ctf_fs_trace
);
298 void ctf_fs_trace_destroy_notifier(void *data
)
300 struct ctf_fs_trace
*trace
= data
;
301 ctf_fs_trace_destroy(trace
);
304 void ctf_fs_finalize(struct bt_private_component
*component
)
306 void *data
= bt_private_component_get_user_data(component
);
308 ctf_fs_destroy(data
);
312 void port_data_destroy(void *data
) {
313 struct ctf_fs_port_data
*port_data
= data
;
323 GString
*get_stream_instance_unique_name(
324 struct ctf_fs_ds_file_group
*ds_file_group
)
327 struct ctf_fs_ds_file_info
*ds_file_info
;
329 name
= g_string_new(NULL
);
335 * If there's more than one stream file in the stream file
336 * group, the first (earliest) stream file's path is used as
337 * the stream's unique name.
339 BT_ASSERT(ds_file_group
->ds_file_infos
->len
> 0);
340 ds_file_info
= g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
341 g_string_assign(name
, ds_file_info
->path
->str
);
348 int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
349 struct ctf_fs_trace
*ctf_fs_trace
,
350 struct ctf_fs_ds_file_group
*ds_file_group
)
353 struct ctf_fs_port_data
*port_data
= NULL
;
354 GString
*port_name
= NULL
;
356 port_name
= get_stream_instance_unique_name(ds_file_group
);
361 BT_LOGD("Creating one port named `%s`", port_name
->str
);
363 /* Create output port for this file */
364 port_data
= g_new0(struct ctf_fs_port_data
, 1);
369 port_data
->ds_file_group
= ds_file_group
;
370 ret
= bt_private_component_source_add_output_private_port(
371 ctf_fs
->priv_comp
, port_name
->str
, port_data
, NULL
);
376 g_ptr_array_add(ctf_fs
->port_data
, port_data
);
385 g_string_free(port_name
, TRUE
);
388 port_data_destroy(port_data
);
393 int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
394 struct ctf_fs_trace
*ctf_fs_trace
)
399 /* Create one output port for each stream file group */
400 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
401 struct ctf_fs_ds_file_group
*ds_file_group
=
402 g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
404 ret
= create_one_port_for_trace(ctf_fs
, ctf_fs_trace
,
407 BT_LOGE("Cannot create output port.");
417 uint64_t get_packet_header_stream_instance_id(struct ctf_fs_trace
*ctf_fs_trace
,
418 struct bt_field
*packet_header_field
)
420 struct bt_field
*stream_instance_id_field
= NULL
;
421 uint64_t stream_instance_id
= -1ULL;
424 if (!packet_header_field
) {
428 stream_instance_id_field
= bt_field_structure_get_field_by_name(
429 packet_header_field
, "stream_instance_id");
430 if (!stream_instance_id_field
) {
434 ret
= bt_field_integer_unsigned_get_value(stream_instance_id_field
,
435 &stream_instance_id
);
437 stream_instance_id
= -1ULL;
442 bt_put(stream_instance_id_field
);
443 return stream_instance_id
;
446 uint64_t get_packet_context_timestamp_begin_ns(
447 struct ctf_fs_trace
*ctf_fs_trace
,
448 struct bt_field
*packet_context_field
)
451 struct bt_field
*timestamp_begin_field
= NULL
;
452 struct bt_field_type
*timestamp_begin_ft
= NULL
;
453 uint64_t timestamp_begin_raw_value
= -1ULL;
454 uint64_t timestamp_begin_ns
= -1ULL;
455 int64_t timestamp_begin_ns_signed
;
456 struct bt_clock_class
*timestamp_begin_clock_class
= NULL
;
457 struct bt_clock_value
*clock_value
= NULL
;
459 if (!packet_context_field
) {
463 timestamp_begin_field
= bt_field_structure_get_field_by_name(
464 packet_context_field
, "timestamp_begin");
465 if (!timestamp_begin_field
) {
469 timestamp_begin_ft
= bt_field_get_type(timestamp_begin_field
);
470 BT_ASSERT(timestamp_begin_ft
);
471 timestamp_begin_clock_class
=
472 bt_field_type_integer_get_mapped_clock_class(timestamp_begin_ft
);
473 if (!timestamp_begin_clock_class
) {
477 ret
= bt_field_integer_unsigned_get_value(timestamp_begin_field
,
478 ×tamp_begin_raw_value
);
483 clock_value
= bt_clock_value_create(timestamp_begin_clock_class
,
484 timestamp_begin_raw_value
);
489 ret
= bt_clock_value_get_value_ns_from_epoch(clock_value
,
490 ×tamp_begin_ns_signed
);
495 timestamp_begin_ns
= (uint64_t) timestamp_begin_ns_signed
;
498 bt_put(timestamp_begin_field
);
499 bt_put(timestamp_begin_ft
);
500 bt_put(timestamp_begin_clock_class
);
502 return timestamp_begin_ns
;
506 void ctf_fs_ds_file_info_destroy(struct ctf_fs_ds_file_info
*ds_file_info
)
512 if (ds_file_info
->path
) {
513 g_string_free(ds_file_info
->path
, TRUE
);
516 ctf_fs_ds_index_destroy(ds_file_info
->index
);
517 g_free(ds_file_info
);
521 struct ctf_fs_ds_file_info
*ctf_fs_ds_file_info_create(const char *path
,
522 uint64_t begin_ns
, struct ctf_fs_ds_index
*index
)
524 struct ctf_fs_ds_file_info
*ds_file_info
;
526 ds_file_info
= g_new0(struct ctf_fs_ds_file_info
, 1);
531 ds_file_info
->path
= g_string_new(path
);
532 if (!ds_file_info
->path
) {
533 ctf_fs_ds_file_info_destroy(ds_file_info
);
538 ds_file_info
->begin_ns
= begin_ns
;
539 ds_file_info
->index
= index
;
543 ctf_fs_ds_index_destroy(index
);
548 void ctf_fs_ds_file_group_destroy(struct ctf_fs_ds_file_group
*ds_file_group
)
550 if (!ds_file_group
) {
554 if (ds_file_group
->ds_file_infos
) {
555 g_ptr_array_free(ds_file_group
->ds_file_infos
, TRUE
);
558 bt_put(ds_file_group
->stream
);
559 bt_put(ds_file_group
->stream_class
);
560 g_free(ds_file_group
);
564 struct ctf_fs_ds_file_group
*ctf_fs_ds_file_group_create(
565 struct ctf_fs_trace
*ctf_fs_trace
,
566 struct bt_stream_class
*stream_class
,
567 uint64_t stream_instance_id
)
569 struct ctf_fs_ds_file_group
*ds_file_group
;
571 ds_file_group
= g_new0(struct ctf_fs_ds_file_group
, 1);
572 if (!ds_file_group
) {
576 ds_file_group
->ds_file_infos
= g_ptr_array_new_with_free_func(
577 (GDestroyNotify
) ctf_fs_ds_file_info_destroy
);
578 if (!ds_file_group
->ds_file_infos
) {
582 ds_file_group
->stream_id
= stream_instance_id
;
583 BT_ASSERT(stream_class
);
584 ds_file_group
->stream_class
= bt_get(stream_class
);
585 ds_file_group
->ctf_fs_trace
= ctf_fs_trace
;
589 ctf_fs_ds_file_group_destroy(ds_file_group
);
590 ds_file_group
= NULL
;
593 return ds_file_group
;
596 /* Replace by g_ptr_array_insert when we depend on glib >= 2.40. */
598 void array_insert(GPtrArray
*array
, gpointer element
, size_t pos
)
600 size_t original_array_len
= array
->len
;
602 /* Allocate an unused element at the end of the array. */
603 g_ptr_array_add(array
, NULL
);
605 /* If we are not inserting at the end, move the elements by one. */
606 if (pos
< original_array_len
) {
607 memmove(&(array
->pdata
[pos
+ 1]),
608 &(array
->pdata
[pos
]),
609 (original_array_len
- pos
) * sizeof(gpointer
));
612 /* Insert the value and bump the array len */
613 array
->pdata
[pos
] = element
;
617 int ctf_fs_ds_file_group_add_ds_file_info(
618 struct ctf_fs_ds_file_group
*ds_file_group
,
619 const char *path
, uint64_t begin_ns
,
620 struct ctf_fs_ds_index
*index
)
622 struct ctf_fs_ds_file_info
*ds_file_info
;
626 /* Onwership of index is transferred. */
627 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
, index
);
633 /* Find a spot to insert this one */
634 for (i
= 0; i
< ds_file_group
->ds_file_infos
->len
; i
++) {
635 struct ctf_fs_ds_file_info
*other_ds_file_info
=
636 g_ptr_array_index(ds_file_group
->ds_file_infos
, i
);
638 if (begin_ns
< other_ds_file_info
->begin_ns
) {
643 array_insert(ds_file_group
->ds_file_infos
, ds_file_info
, i
);
648 ctf_fs_ds_file_info_destroy(ds_file_info
);
649 ctf_fs_ds_index_destroy(index
);
656 int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
,
659 struct bt_field
*packet_header_field
= NULL
;
660 struct bt_field
*packet_context_field
= NULL
;
661 struct bt_stream_class
*stream_class
= NULL
;
662 uint64_t stream_instance_id
= -1ULL;
663 uint64_t begin_ns
= -1ULL;
664 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
665 bool add_group
= false;
668 struct ctf_fs_ds_file
*ds_file
= NULL
;
669 struct ctf_fs_ds_index
*index
= NULL
;
670 struct bt_notif_iter
*notif_iter
= NULL
;
672 notif_iter
= bt_notif_iter_create(ctf_fs_trace
->metadata
->trace
,
673 bt_common_get_page_size() * 8, ctf_fs_ds_file_medops
, NULL
);
675 BT_LOGE_STR("Cannot create a CTF notification iterator.");
679 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, notif_iter
, NULL
, path
);
684 ret
= ctf_fs_ds_file_get_packet_header_context_fields(ds_file
,
685 &packet_header_field
, &packet_context_field
);
687 BT_LOGE("Cannot get stream file's first packet's header and context fields (`%s`).",
692 stream_instance_id
= get_packet_header_stream_instance_id(ctf_fs_trace
,
693 packet_header_field
);
694 begin_ns
= get_packet_context_timestamp_begin_ns(ctf_fs_trace
,
695 packet_context_field
);
696 stream_class
= ctf_utils_stream_class_from_packet_header(
697 ctf_fs_trace
->metadata
->trace
, packet_header_field
);
702 index
= ctf_fs_ds_file_build_index(ds_file
);
704 BT_LOGW("Failed to index CTF stream file \'%s\'",
705 ds_file
->file
->path
->str
);
708 if (begin_ns
== -1ULL) {
710 * No beggining timestamp to sort the stream files
711 * within a stream file group, so consider that this
712 * file must be the only one within its group.
714 stream_instance_id
= -1ULL;
717 if (stream_instance_id
== -1ULL) {
719 * No stream instance ID or no beginning timestamp:
720 * create a unique stream file group for this stream
721 * file because, even if there's a stream instance ID,
722 * there's no timestamp to order the file within its
725 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
,
726 stream_class
, stream_instance_id
);
727 if (!ds_file_group
) {
731 ret
= ctf_fs_ds_file_group_add_ds_file_info(ds_file_group
,
732 path
, begin_ns
, index
);
733 /* Ownership of index is transferred. */
743 BT_ASSERT(stream_instance_id
!= -1ULL);
744 BT_ASSERT(begin_ns
!= -1ULL);
746 /* Find an existing stream file group with this ID */
747 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
748 ds_file_group
= g_ptr_array_index(
749 ctf_fs_trace
->ds_file_groups
, i
);
751 if (ds_file_group
->stream_class
== stream_class
&&
752 ds_file_group
->stream_id
==
753 stream_instance_id
) {
757 ds_file_group
= NULL
;
760 if (!ds_file_group
) {
761 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
,
762 stream_class
, stream_instance_id
);
763 if (!ds_file_group
) {
770 ret
= ctf_fs_ds_file_group_add_ds_file_info(ds_file_group
, path
,
780 ctf_fs_ds_file_group_destroy(ds_file_group
);
784 if (add_group
&& ds_file_group
) {
785 g_ptr_array_add(ctf_fs_trace
->ds_file_groups
, ds_file_group
);
788 ctf_fs_ds_file_destroy(ds_file
);
791 bt_notif_iter_destroy(notif_iter
);
794 ctf_fs_ds_index_destroy(index
);
795 bt_put(packet_header_field
);
796 bt_put(packet_context_field
);
797 bt_put(stream_class
);
802 int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
805 const char *basename
;
806 GError
*error
= NULL
;
810 /* Check each file in the path directory, except specific ones */
811 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
813 BT_LOGE("Cannot open directory `%s`: %s (code %d)",
814 ctf_fs_trace
->path
->str
, error
->message
,
819 while ((basename
= g_dir_read_name(dir
))) {
820 struct ctf_fs_file
*file
;
822 if (!strcmp(basename
, CTF_FS_METADATA_FILENAME
)) {
823 /* Ignore the metadata stream. */
824 BT_LOGD("Ignoring metadata file `%s" G_DIR_SEPARATOR_S
"%s`",
825 ctf_fs_trace
->path
->str
, basename
);
829 if (basename
[0] == '.') {
830 BT_LOGD("Ignoring hidden file `%s" G_DIR_SEPARATOR_S
"%s`",
831 ctf_fs_trace
->path
->str
, basename
);
835 /* Create the file. */
836 file
= ctf_fs_file_create();
838 BT_LOGE("Cannot create stream file object for file `%s" G_DIR_SEPARATOR_S
"%s`",
839 ctf_fs_trace
->path
->str
, basename
);
843 /* Create full path string. */
844 g_string_append_printf(file
->path
, "%s" G_DIR_SEPARATOR_S
"%s",
845 ctf_fs_trace
->path
->str
, basename
);
846 if (!g_file_test(file
->path
->str
, G_FILE_TEST_IS_REGULAR
)) {
847 BT_LOGD("Ignoring non-regular file `%s`",
849 ctf_fs_file_destroy(file
);
854 ret
= ctf_fs_file_open(file
, "rb");
856 BT_LOGE("Cannot open stream file `%s`", file
->path
->str
);
860 if (file
->size
== 0) {
861 /* Skip empty stream. */
862 BT_LOGD("Ignoring empty file `%s`", file
->path
->str
);
863 ctf_fs_file_destroy(file
);
867 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
,
870 BT_LOGE("Cannot add stream file `%s` to stream file group",
872 ctf_fs_file_destroy(file
);
876 ctf_fs_file_destroy(file
);
880 * At this point, DS file groupes are created, but their
881 * associated stream objects do not exist yet. This is because
882 * we need to name the created stream object with the data
883 * stream file's path. We have everything we need here to do
886 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
887 struct ctf_fs_ds_file_group
*ds_file_group
=
888 g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
889 GString
*name
= get_stream_instance_unique_name(ds_file_group
);
895 if (ds_file_group
->stream_id
== -1ULL) {
896 /* No stream ID: use 0 */
897 ds_file_group
->stream
= bt_stream_create(
898 ds_file_group
->stream_class
, name
->str
,
899 ctf_fs_trace
->next_stream_id
);
900 ctf_fs_trace
->next_stream_id
++;
902 /* Specific stream ID */
903 ds_file_group
->stream
= bt_stream_create(
904 ds_file_group
->stream_class
, name
->str
,
905 ds_file_group
->stream_id
);
908 g_string_free(name
, TRUE
);
910 if (!ds_file_group
->stream
) {
911 BT_LOGE("Cannot create stream for DS file group: "
912 "addr=%p, stream-name=\"%s\"",
913 ds_file_group
, name
->str
);
937 int create_cc_prio_map(struct ctf_fs_trace
*ctf_fs_trace
)
943 BT_ASSERT(ctf_fs_trace
);
944 ctf_fs_trace
->cc_prio_map
= bt_clock_class_priority_map_create();
945 if (!ctf_fs_trace
->cc_prio_map
) {
950 count
= bt_trace_get_clock_class_count(
951 ctf_fs_trace
->metadata
->trace
);
952 BT_ASSERT(count
>= 0);
954 for (i
= 0; i
< count
; i
++) {
955 struct bt_clock_class
*clock_class
=
956 bt_trace_get_clock_class_by_index(
957 ctf_fs_trace
->metadata
->trace
, i
);
959 BT_ASSERT(clock_class
);
960 ret
= bt_clock_class_priority_map_add_clock_class(
961 ctf_fs_trace
->cc_prio_map
, clock_class
, 0);
974 struct ctf_fs_trace
*ctf_fs_trace_create(const char *path
, const char *name
,
975 struct ctf_fs_metadata_config
*metadata_config
)
977 struct ctf_fs_trace
*ctf_fs_trace
;
980 ctf_fs_trace
= g_new0(struct ctf_fs_trace
, 1);
985 ctf_fs_trace
->path
= g_string_new(path
);
986 if (!ctf_fs_trace
->path
) {
990 ctf_fs_trace
->name
= g_string_new(name
);
991 if (!ctf_fs_trace
->name
) {
995 ctf_fs_trace
->metadata
= g_new0(struct ctf_fs_metadata
, 1);
996 if (!ctf_fs_trace
->metadata
) {
1000 ctf_fs_trace
->ds_file_groups
= g_ptr_array_new_with_free_func(
1001 (GDestroyNotify
) ctf_fs_ds_file_group_destroy
);
1002 if (!ctf_fs_trace
->ds_file_groups
) {
1006 ret
= ctf_fs_metadata_set_trace(ctf_fs_trace
, metadata_config
);
1011 ret
= create_ds_file_groups(ctf_fs_trace
);
1016 ret
= create_cc_prio_map(ctf_fs_trace
);
1022 * create_ds_file_groups() created all the streams that this
1023 * trace needs. There won't be any more. Therefore it is safe to
1024 * make this trace static.
1026 (void) bt_trace_set_is_static(ctf_fs_trace
->metadata
->trace
);
1031 ctf_fs_trace_destroy(ctf_fs_trace
);
1032 ctf_fs_trace
= NULL
;
1034 return ctf_fs_trace
;
1038 int path_is_ctf_trace(const char *path
)
1040 GString
*metadata_path
= g_string_new(NULL
);
1043 if (!metadata_path
) {
1048 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
1050 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
1056 g_string_free(metadata_path
, TRUE
);
1061 int add_trace_path(GList
**trace_paths
, const char *path
)
1063 GString
*norm_path
= NULL
;
1066 norm_path
= bt_common_normalize_path(path
, NULL
);
1068 BT_LOGE("Failed to normalize path `%s`.", path
);
1073 // FIXME: Remove or ifdef for __MINGW32__
1074 if (strcmp(norm_path
->str
, "/") == 0) {
1075 BT_LOGE("Opening a trace in `/` is not supported.");
1080 *trace_paths
= g_list_prepend(*trace_paths
, norm_path
);
1081 BT_ASSERT(*trace_paths
);
1086 g_string_free(norm_path
, TRUE
);
1093 int ctf_fs_find_traces(GList
**trace_paths
, const char *start_path
)
1096 GError
*error
= NULL
;
1098 const char *basename
= NULL
;
1100 /* Check if the starting path is a CTF trace itself */
1101 ret
= path_is_ctf_trace(start_path
);
1108 * Stop recursion: a CTF trace cannot contain another
1111 ret
= add_trace_path(trace_paths
, start_path
);
1115 /* Look for subdirectories */
1116 if (!g_file_test(start_path
, G_FILE_TEST_IS_DIR
)) {
1117 /* Starting path is not a directory: end of recursion */
1121 dir
= g_dir_open(start_path
, 0, &error
);
1123 if (error
->code
== G_FILE_ERROR_ACCES
) {
1124 BT_LOGD("Cannot open directory `%s`: %s (code %d): continuing",
1125 start_path
, error
->message
, error
->code
);
1129 BT_LOGE("Cannot open directory `%s`: %s (code %d)",
1130 start_path
, error
->message
, error
->code
);
1135 while ((basename
= g_dir_read_name(dir
))) {
1136 GString
*sub_path
= g_string_new(NULL
);
1143 g_string_printf(sub_path
, "%s" G_DIR_SEPARATOR_S
"%s", start_path
, basename
);
1144 ret
= ctf_fs_find_traces(trace_paths
, sub_path
->str
);
1145 g_string_free(sub_path
, TRUE
);
1157 g_error_free(error
);
1164 GList
*ctf_fs_create_trace_names(GList
*trace_paths
, const char *base_path
) {
1165 GList
*trace_names
= NULL
;
1167 const char *last_sep
;
1171 * At this point we know that all the trace paths are
1172 * normalized, and so is the base path. This means that
1173 * they are absolute and they don't end with a separator.
1174 * We can simply find the location of the last separator
1175 * in the base path, which gives us the name of the actual
1176 * directory to look into, and use this location as the
1177 * start of each trace name within each trace path.
1181 * Base path: /home/user/my-traces/some-trace
1183 * - /home/user/my-traces/some-trace/host1/trace1
1184 * - /home/user/my-traces/some-trace/host1/trace2
1185 * - /home/user/my-traces/some-trace/host2/trace
1186 * - /home/user/my-traces/some-trace/other-trace
1188 * In this case the trace names are:
1190 * - some-trace/host1/trace1
1191 * - some-trace/host1/trace2
1192 * - some-trace/host2/trace
1193 * - some-trace/other-trace
1195 last_sep
= strrchr(base_path
, G_DIR_SEPARATOR
);
1197 /* We know there's at least one separator */
1198 BT_ASSERT(last_sep
);
1200 /* Distance to base */
1201 base_dist
= last_sep
- base_path
+ 1;
1203 /* Create the trace names */
1204 for (node
= trace_paths
; node
; node
= g_list_next(node
)) {
1205 GString
*trace_name
= g_string_new(NULL
);
1206 GString
*trace_path
= node
->data
;
1208 BT_ASSERT(trace_name
);
1209 g_string_assign(trace_name
, &trace_path
->str
[base_dist
]);
1210 trace_names
= g_list_append(trace_names
, trace_name
);
1217 int create_ctf_fs_traces(struct ctf_fs_component
*ctf_fs
,
1218 const char *path_param
)
1220 struct ctf_fs_trace
*ctf_fs_trace
= NULL
;
1222 GString
*norm_path
= NULL
;
1223 GList
*trace_paths
= NULL
;
1224 GList
*trace_names
= NULL
;
1228 norm_path
= bt_common_normalize_path(path_param
, NULL
);
1230 BT_LOGE("Failed to normalize path: `%s`.",
1235 ret
= ctf_fs_find_traces(&trace_paths
, norm_path
->str
);
1241 BT_LOGE("No CTF traces recursively found in `%s`.",
1246 trace_names
= ctf_fs_create_trace_names(trace_paths
, norm_path
->str
);
1248 BT_LOGE("Cannot create trace names from trace paths.");
1252 for (tp_node
= trace_paths
, tn_node
= trace_names
; tp_node
;
1253 tp_node
= g_list_next(tp_node
),
1254 tn_node
= g_list_next(tn_node
)) {
1255 GString
*trace_path
= tp_node
->data
;
1256 GString
*trace_name
= tn_node
->data
;
1258 ctf_fs_trace
= ctf_fs_trace_create(trace_path
->str
,
1259 trace_name
->str
, &ctf_fs
->metadata_config
);
1260 if (!ctf_fs_trace
) {
1261 BT_LOGE("Cannot create trace for `%s`.",
1266 ret
= create_ports_for_trace(ctf_fs
, ctf_fs_trace
);
1271 g_ptr_array_add(ctf_fs
->traces
, ctf_fs_trace
);
1272 ctf_fs_trace
= NULL
;
1279 ctf_fs_trace_destroy(ctf_fs_trace
);
1282 for (tp_node
= trace_paths
; tp_node
; tp_node
= g_list_next(tp_node
)) {
1283 if (tp_node
->data
) {
1284 g_string_free(tp_node
->data
, TRUE
);
1288 for (tn_node
= trace_names
; tn_node
; tn_node
= g_list_next(tn_node
)) {
1289 if (tn_node
->data
) {
1290 g_string_free(tn_node
->data
, TRUE
);
1295 g_list_free(trace_paths
);
1299 g_list_free(trace_names
);
1303 g_string_free(norm_path
, TRUE
);
1310 struct ctf_fs_component
*ctf_fs_create(struct bt_private_component
*priv_comp
,
1311 struct bt_value
*params
)
1313 struct ctf_fs_component
*ctf_fs
;
1314 struct bt_value
*value
= NULL
;
1315 const char *path_param
;
1316 enum bt_component_status ret
;
1317 enum bt_value_status value_ret
;
1319 ctf_fs
= g_new0(struct ctf_fs_component
, 1);
1324 ret
= bt_private_component_set_user_data(priv_comp
, ctf_fs
);
1325 BT_ASSERT(ret
== BT_COMPONENT_STATUS_OK
);
1328 * We don't need to get a new reference here because as long as
1329 * our private ctf_fs_component object exists, the containing
1330 * private component should also exist.
1332 ctf_fs
->priv_comp
= priv_comp
;
1333 value
= bt_value_map_get(params
, "path");
1334 if (value
&& !bt_value_is_string(value
)) {
1338 value_ret
= bt_value_string_get(value
, &path_param
);
1339 BT_ASSERT(value_ret
== BT_VALUE_STATUS_OK
);
1341 value
= bt_value_map_get(params
, "clock-class-offset-s");
1343 if (!bt_value_is_integer(value
)) {
1344 BT_LOGE("clock-class-offset-s should be an integer");
1347 value_ret
= bt_value_integer_get(value
,
1348 &ctf_fs
->metadata_config
.clock_class_offset_s
);
1349 BT_ASSERT(value_ret
== BT_VALUE_STATUS_OK
);
1353 value
= bt_value_map_get(params
, "clock-class-offset-ns");
1355 if (!bt_value_is_integer(value
)) {
1356 BT_LOGE("clock-class-offset-ns should be an integer");
1359 value_ret
= bt_value_integer_get(value
,
1360 &ctf_fs
->metadata_config
.clock_class_offset_ns
);
1361 BT_ASSERT(value_ret
== BT_VALUE_STATUS_OK
);
1365 ctf_fs
->port_data
= g_ptr_array_new_with_free_func(port_data_destroy
);
1366 if (!ctf_fs
->port_data
) {
1370 ctf_fs
->traces
= g_ptr_array_new_with_free_func(
1371 ctf_fs_trace_destroy_notifier
);
1372 if (!ctf_fs
->traces
) {
1376 if (create_ctf_fs_traces(ctf_fs
, path_param
)) {
1383 ctf_fs_destroy(ctf_fs
);
1385 ret
= bt_private_component_set_user_data(priv_comp
, NULL
);
1386 BT_ASSERT(ret
== BT_COMPONENT_STATUS_OK
);
1394 enum bt_component_status
ctf_fs_init(struct bt_private_component
*priv_comp
,
1395 struct bt_value
*params
, UNUSED_VAR
void *init_method_data
)
1397 struct ctf_fs_component
*ctf_fs
;
1398 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
1400 ctf_fs
= ctf_fs_create(priv_comp
, params
);
1402 ret
= BT_COMPONENT_STATUS_ERROR
;
1409 struct bt_component_class_query_method_return
ctf_fs_query(
1410 struct bt_component_class
*comp_class
,
1411 struct bt_query_executor
*query_exec
,
1412 const char *object
, struct bt_value
*params
)
1414 struct bt_component_class_query_method_return ret
= {
1416 .status
= BT_QUERY_STATUS_OK
,
1419 if (!strcmp(object
, "metadata-info")) {
1420 ret
= metadata_info_query(comp_class
, params
);
1421 } else if (!strcmp(object
, "trace-info")) {
1422 ret
= trace_info_query(comp_class
, params
);
1424 BT_LOGE("Unknown query object `%s`", object
);
1425 ret
.status
= BT_QUERY_STATUS_INVALID_OBJECT
;