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
->pc_notif_iter
,
63 notif_iter_data
->notif_iter
,
64 notif_iter_data
->ds_file_group
->stream
,
65 ds_file_info
->path
->str
);
66 if (!notif_iter_data
->ds_file
) {
74 void ctf_fs_notif_iter_data_destroy(
75 struct ctf_fs_notif_iter_data
*notif_iter_data
)
77 if (!notif_iter_data
) {
81 ctf_fs_ds_file_destroy(notif_iter_data
->ds_file
);
83 if (notif_iter_data
->notif_iter
) {
84 bt_notif_iter_destroy(notif_iter_data
->notif_iter
);
87 g_free(notif_iter_data
);
91 enum bt_notification_iterator_status
ctf_fs_iterator_next_one(
92 struct ctf_fs_notif_iter_data
*notif_iter_data
,
93 struct bt_notification
**notif
)
95 enum bt_notification_iterator_status status
;
98 BT_ASSERT(notif_iter_data
->ds_file
);
99 status
= ctf_fs_ds_file_next(notif_iter_data
->ds_file
, notif
);
101 if (status
== BT_NOTIFICATION_ITERATOR_STATUS_OK
&&
102 bt_notification_get_type(*notif
) ==
103 BT_NOTIFICATION_TYPE_STREAM_BEGIN
) {
104 if (notif_iter_data
->skip_stream_begin_notifs
) {
106 * We already emitted a
107 * BT_NOTIFICATION_TYPE_STREAM_BEGIN
108 * notification: skip this one, get a new one.
111 status
= ctf_fs_ds_file_next(notif_iter_data
->ds_file
,
113 BT_ASSERT(status
!= BT_NOTIFICATION_ITERATOR_STATUS_END
);
117 * First BT_NOTIFICATION_TYPE_STREAM_BEGIN
118 * notification: skip all following.
120 notif_iter_data
->skip_stream_begin_notifs
= true;
125 if (status
== BT_NOTIFICATION_ITERATOR_STATUS_OK
&&
126 bt_notification_get_type(*notif
) ==
127 BT_NOTIFICATION_TYPE_STREAM_END
) {
128 notif_iter_data
->ds_file_info_index
++;
130 if (notif_iter_data
->ds_file_info_index
==
131 notif_iter_data
->ds_file_group
->ds_file_infos
->len
) {
133 * No more stream files to read: we reached the
134 * real end. Emit this
135 * BT_NOTIFICATION_TYPE_STREAM_END notification.
136 * The next time ctf_fs_iterator_next() is
137 * called for this notification iterator,
138 * ctf_fs_ds_file_next() will return
139 * BT_NOTIFICATION_ITERATOR_STATUS_END().
145 bt_notif_iter_reset(notif_iter_data
->notif_iter
);
148 * Open and start reading the next stream file within
149 * our stream file group.
151 ret
= notif_iter_data_set_current_ds_file(notif_iter_data
);
153 status
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
157 status
= ctf_fs_ds_file_next(notif_iter_data
->ds_file
, notif
);
160 * If we get a notification, we expect to get a
161 * BT_NOTIFICATION_TYPE_STREAM_BEGIN notification
162 * because the iterator's state machine emits one before
163 * even requesting the first block of data from the
164 * medium. Skip this notification because we're not
165 * really starting a new stream here, and try getting a
166 * new notification (which, if it works, is a
167 * BT_NOTIFICATION_TYPE_PACKET_BEGIN one). We're sure to
168 * get at least one pair of
169 * BT_NOTIFICATION_TYPE_PACKET_BEGIN and
170 * BT_NOTIFICATION_TYPE_PACKET_END notifications in the
171 * case of a single, empty packet. We know there's at
172 * least one packet because the stream file group does
173 * not contain empty stream files.
175 BT_ASSERT(notif_iter_data
->skip_stream_begin_notifs
);
177 if (status
== BT_NOTIFICATION_ITERATOR_STATUS_OK
) {
178 BT_ASSERT(bt_notification_get_type(*notif
) ==
179 BT_NOTIFICATION_TYPE_STREAM_BEGIN
);
181 status
= ctf_fs_ds_file_next(notif_iter_data
->ds_file
,
183 BT_ASSERT(status
!= BT_NOTIFICATION_ITERATOR_STATUS_END
);
192 enum bt_notification_iterator_status
ctf_fs_iterator_next(
193 struct bt_private_connection_private_notification_iterator
*iterator
,
194 bt_notification_array notifs
, uint64_t capacity
,
197 enum bt_notification_iterator_status status
=
198 BT_NOTIFICATION_ITERATOR_STATUS_OK
;
199 struct ctf_fs_notif_iter_data
*notif_iter_data
=
200 bt_private_connection_private_notification_iterator_get_user_data(iterator
);
203 while (i
< capacity
&& status
== BT_NOTIFICATION_ITERATOR_STATUS_OK
) {
204 status
= ctf_fs_iterator_next_one(notif_iter_data
, ¬ifs
[i
]);
205 if (status
== BT_NOTIFICATION_ITERATOR_STATUS_OK
) {
212 * Even if ctf_fs_iterator_next_one() returned something
213 * else than BT_NOTIFICATION_ITERATOR_STATUS_OK, we
214 * accumulated notification objects in the output
215 * notification array, so we need to return
216 * BT_NOTIFICATION_ITERATOR_STATUS_OK so that they are
217 * transfered to downstream. This other status occurs
218 * again the next time muxer_notif_iter_do_next() is
219 * called, possibly without any accumulated
220 * notification, in which case we'll return it.
223 status
= BT_NOTIFICATION_ITERATOR_STATUS_OK
;
229 void ctf_fs_iterator_finalize(struct bt_private_connection_private_notification_iterator
*it
)
231 void *notif_iter_data
=
232 bt_private_connection_private_notification_iterator_get_user_data(it
);
234 ctf_fs_notif_iter_data_destroy(notif_iter_data
);
237 enum bt_notification_iterator_status
ctf_fs_iterator_init(
238 struct bt_private_connection_private_notification_iterator
*it
,
239 struct bt_private_port
*port
)
241 struct ctf_fs_port_data
*port_data
;
242 struct ctf_fs_notif_iter_data
*notif_iter_data
= NULL
;
243 enum bt_notification_iterator_status ret
=
244 BT_NOTIFICATION_ITERATOR_STATUS_OK
;
247 port_data
= bt_private_port_get_user_data(port
);
249 ret
= BT_NOTIFICATION_ITERATOR_STATUS_INVALID
;
253 notif_iter_data
= g_new0(struct ctf_fs_notif_iter_data
, 1);
254 if (!notif_iter_data
) {
255 ret
= BT_NOTIFICATION_ITERATOR_STATUS_NOMEM
;
259 notif_iter_data
->pc_notif_iter
= it
;
260 notif_iter_data
->notif_iter
= bt_notif_iter_create(
261 port_data
->ds_file_group
->ctf_fs_trace
->metadata
->trace
,
262 bt_common_get_page_size() * 8,
263 ctf_fs_ds_file_medops
, NULL
);
264 if (!notif_iter_data
->notif_iter
) {
265 BT_LOGE_STR("Cannot create a CTF notification iterator.");
266 ret
= BT_NOTIFICATION_ITERATOR_STATUS_NOMEM
;
270 notif_iter_data
->ds_file_group
= port_data
->ds_file_group
;
271 iret
= notif_iter_data_set_current_ds_file(notif_iter_data
);
273 ret
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
277 ret
= bt_private_connection_private_notification_iterator_set_user_data(it
, notif_iter_data
);
278 if (ret
!= BT_NOTIFICATION_ITERATOR_STATUS_OK
) {
282 notif_iter_data
= NULL
;
286 (void) bt_private_connection_private_notification_iterator_set_user_data(it
, NULL
);
289 ctf_fs_notif_iter_data_destroy(notif_iter_data
);
294 void ctf_fs_destroy(struct ctf_fs_component
*ctf_fs
)
300 if (ctf_fs
->traces
) {
301 g_ptr_array_free(ctf_fs
->traces
, TRUE
);
304 if (ctf_fs
->port_data
) {
305 g_ptr_array_free(ctf_fs
->port_data
, TRUE
);
312 void ctf_fs_trace_destroy(struct ctf_fs_trace
*ctf_fs_trace
)
318 if (ctf_fs_trace
->ds_file_groups
) {
319 g_ptr_array_free(ctf_fs_trace
->ds_file_groups
, TRUE
);
322 if (ctf_fs_trace
->path
) {
323 g_string_free(ctf_fs_trace
->path
, TRUE
);
326 if (ctf_fs_trace
->name
) {
327 g_string_free(ctf_fs_trace
->name
, TRUE
);
330 if (ctf_fs_trace
->metadata
) {
331 ctf_fs_metadata_fini(ctf_fs_trace
->metadata
);
332 g_free(ctf_fs_trace
->metadata
);
335 bt_put(ctf_fs_trace
->cc_prio_map
);
336 g_free(ctf_fs_trace
);
340 void ctf_fs_trace_destroy_notifier(void *data
)
342 struct ctf_fs_trace
*trace
= data
;
343 ctf_fs_trace_destroy(trace
);
346 void ctf_fs_finalize(struct bt_private_component
*component
)
348 void *data
= bt_private_component_get_user_data(component
);
350 ctf_fs_destroy(data
);
354 void port_data_destroy(void *data
) {
355 struct ctf_fs_port_data
*port_data
= data
;
365 GString
*get_stream_instance_unique_name(
366 struct ctf_fs_ds_file_group
*ds_file_group
)
369 struct ctf_fs_ds_file_info
*ds_file_info
;
371 name
= g_string_new(NULL
);
377 * If there's more than one stream file in the stream file
378 * group, the first (earliest) stream file's path is used as
379 * the stream's unique name.
381 BT_ASSERT(ds_file_group
->ds_file_infos
->len
> 0);
382 ds_file_info
= g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
383 g_string_assign(name
, ds_file_info
->path
->str
);
390 int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
391 struct ctf_fs_trace
*ctf_fs_trace
,
392 struct ctf_fs_ds_file_group
*ds_file_group
)
395 struct ctf_fs_port_data
*port_data
= NULL
;
396 GString
*port_name
= NULL
;
398 port_name
= get_stream_instance_unique_name(ds_file_group
);
403 BT_LOGD("Creating one port named `%s`", port_name
->str
);
405 /* Create output port for this file */
406 port_data
= g_new0(struct ctf_fs_port_data
, 1);
411 port_data
->ctf_fs
= ctf_fs
;
412 port_data
->ds_file_group
= ds_file_group
;
413 ret
= bt_private_component_source_add_output_private_port(
414 ctf_fs
->priv_comp
, port_name
->str
, port_data
, NULL
);
419 g_ptr_array_add(ctf_fs
->port_data
, port_data
);
428 g_string_free(port_name
, TRUE
);
431 port_data_destroy(port_data
);
436 int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
437 struct ctf_fs_trace
*ctf_fs_trace
)
442 /* Create one output port for each stream file group */
443 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
444 struct ctf_fs_ds_file_group
*ds_file_group
=
445 g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
447 ret
= create_one_port_for_trace(ctf_fs
, ctf_fs_trace
,
450 BT_LOGE("Cannot create output port.");
460 uint64_t get_packet_header_stream_instance_id(struct ctf_fs_trace
*ctf_fs_trace
,
461 struct bt_field
*packet_header_field
)
463 struct bt_field
*stream_instance_id_field
= NULL
;
464 uint64_t stream_instance_id
= -1ULL;
467 if (!packet_header_field
) {
471 stream_instance_id_field
= bt_field_structure_borrow_field_by_name(
472 packet_header_field
, "stream_instance_id");
473 if (!stream_instance_id_field
) {
477 ret
= bt_field_integer_unsigned_get_value(stream_instance_id_field
,
478 &stream_instance_id
);
480 stream_instance_id
= -1ULL;
485 return stream_instance_id
;
488 uint64_t get_packet_context_timestamp_begin_ns(
489 struct ctf_fs_trace
*ctf_fs_trace
,
490 struct bt_field
*packet_context_field
)
493 struct bt_field
*timestamp_begin_field
= NULL
;
494 struct bt_field_type
*timestamp_begin_ft
= NULL
;
495 uint64_t timestamp_begin_raw_value
= -1ULL;
496 uint64_t timestamp_begin_ns
= -1ULL;
497 int64_t timestamp_begin_ns_signed
;
498 struct bt_clock_class
*timestamp_begin_clock_class
= NULL
;
500 if (!packet_context_field
) {
504 timestamp_begin_field
= bt_field_structure_borrow_field_by_name(
505 packet_context_field
, "timestamp_begin");
506 if (!timestamp_begin_field
) {
510 timestamp_begin_ft
= bt_field_borrow_type(timestamp_begin_field
);
511 BT_ASSERT(timestamp_begin_ft
);
512 timestamp_begin_clock_class
=
513 bt_field_type_integer_borrow_mapped_clock_class(timestamp_begin_ft
);
514 if (!timestamp_begin_clock_class
) {
518 ret
= bt_field_integer_unsigned_get_value(timestamp_begin_field
,
519 ×tamp_begin_raw_value
);
524 ret
= bt_clock_class_cycles_to_ns(timestamp_begin_clock_class
,
525 timestamp_begin_raw_value
, ×tamp_begin_ns_signed
);
530 timestamp_begin_ns
= (uint64_t) timestamp_begin_ns_signed
;
533 return timestamp_begin_ns
;
537 void ctf_fs_ds_file_info_destroy(struct ctf_fs_ds_file_info
*ds_file_info
)
543 if (ds_file_info
->path
) {
544 g_string_free(ds_file_info
->path
, TRUE
);
547 ctf_fs_ds_index_destroy(ds_file_info
->index
);
548 g_free(ds_file_info
);
552 struct ctf_fs_ds_file_info
*ctf_fs_ds_file_info_create(const char *path
,
553 uint64_t begin_ns
, struct ctf_fs_ds_index
*index
)
555 struct ctf_fs_ds_file_info
*ds_file_info
;
557 ds_file_info
= g_new0(struct ctf_fs_ds_file_info
, 1);
562 ds_file_info
->path
= g_string_new(path
);
563 if (!ds_file_info
->path
) {
564 ctf_fs_ds_file_info_destroy(ds_file_info
);
569 ds_file_info
->begin_ns
= begin_ns
;
570 ds_file_info
->index
= index
;
574 ctf_fs_ds_index_destroy(index
);
579 void ctf_fs_ds_file_group_destroy(struct ctf_fs_ds_file_group
*ds_file_group
)
581 if (!ds_file_group
) {
585 if (ds_file_group
->ds_file_infos
) {
586 g_ptr_array_free(ds_file_group
->ds_file_infos
, TRUE
);
589 bt_put(ds_file_group
->stream
);
590 bt_put(ds_file_group
->stream_class
);
591 g_free(ds_file_group
);
595 struct ctf_fs_ds_file_group
*ctf_fs_ds_file_group_create(
596 struct ctf_fs_trace
*ctf_fs_trace
,
597 struct bt_stream_class
*stream_class
,
598 uint64_t stream_instance_id
)
600 struct ctf_fs_ds_file_group
*ds_file_group
;
602 ds_file_group
= g_new0(struct ctf_fs_ds_file_group
, 1);
603 if (!ds_file_group
) {
607 ds_file_group
->ds_file_infos
= g_ptr_array_new_with_free_func(
608 (GDestroyNotify
) ctf_fs_ds_file_info_destroy
);
609 if (!ds_file_group
->ds_file_infos
) {
613 ds_file_group
->stream_id
= stream_instance_id
;
614 BT_ASSERT(stream_class
);
615 ds_file_group
->stream_class
= bt_get(stream_class
);
616 ds_file_group
->ctf_fs_trace
= ctf_fs_trace
;
620 ctf_fs_ds_file_group_destroy(ds_file_group
);
621 ds_file_group
= NULL
;
624 return ds_file_group
;
627 /* Replace by g_ptr_array_insert when we depend on glib >= 2.40. */
629 void array_insert(GPtrArray
*array
, gpointer element
, size_t pos
)
631 size_t original_array_len
= array
->len
;
633 /* Allocate an unused element at the end of the array. */
634 g_ptr_array_add(array
, NULL
);
636 /* If we are not inserting at the end, move the elements by one. */
637 if (pos
< original_array_len
) {
638 memmove(&(array
->pdata
[pos
+ 1]),
639 &(array
->pdata
[pos
]),
640 (original_array_len
- pos
) * sizeof(gpointer
));
643 /* Insert the value and bump the array len */
644 array
->pdata
[pos
] = element
;
648 int ctf_fs_ds_file_group_add_ds_file_info(
649 struct ctf_fs_ds_file_group
*ds_file_group
,
650 const char *path
, uint64_t begin_ns
,
651 struct ctf_fs_ds_index
*index
)
653 struct ctf_fs_ds_file_info
*ds_file_info
;
657 /* Onwership of index is transferred. */
658 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
, index
);
664 /* Find a spot to insert this one */
665 for (i
= 0; i
< ds_file_group
->ds_file_infos
->len
; i
++) {
666 struct ctf_fs_ds_file_info
*other_ds_file_info
=
667 g_ptr_array_index(ds_file_group
->ds_file_infos
, i
);
669 if (begin_ns
< other_ds_file_info
->begin_ns
) {
674 array_insert(ds_file_group
->ds_file_infos
, ds_file_info
, i
);
679 ctf_fs_ds_file_info_destroy(ds_file_info
);
680 ctf_fs_ds_index_destroy(index
);
687 int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
,
688 struct bt_graph
*graph
, const char *path
)
690 struct bt_field
*packet_header_field
= NULL
;
691 struct bt_field
*packet_context_field
= NULL
;
692 struct bt_stream_class
*stream_class
= NULL
;
693 uint64_t stream_instance_id
= -1ULL;
694 uint64_t begin_ns
= -1ULL;
695 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
696 bool add_group
= false;
699 struct ctf_fs_ds_file
*ds_file
= NULL
;
700 struct ctf_fs_ds_index
*index
= NULL
;
701 struct bt_notif_iter
*notif_iter
= NULL
;
703 notif_iter
= bt_notif_iter_create(ctf_fs_trace
->metadata
->trace
,
704 bt_common_get_page_size() * 8, ctf_fs_ds_file_medops
, NULL
);
706 BT_LOGE_STR("Cannot create a CTF notification iterator.");
710 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, notif_iter
,
716 ret
= ctf_fs_ds_file_borrow_packet_header_context_fields(ds_file
,
717 &packet_header_field
, &packet_context_field
);
719 BT_LOGE("Cannot get stream file's first packet's header and context fields (`%s`).",
724 stream_instance_id
= get_packet_header_stream_instance_id(ctf_fs_trace
,
725 packet_header_field
);
726 begin_ns
= get_packet_context_timestamp_begin_ns(ctf_fs_trace
,
727 packet_context_field
);
728 stream_class
= ctf_utils_borrow_stream_class_from_packet_header(
729 ctf_fs_trace
->metadata
->trace
, packet_header_field
);
734 index
= ctf_fs_ds_file_build_index(ds_file
);
736 BT_LOGW("Failed to index CTF stream file \'%s\'",
737 ds_file
->file
->path
->str
);
740 if (begin_ns
== -1ULL) {
742 * No beggining timestamp to sort the stream files
743 * within a stream file group, so consider that this
744 * file must be the only one within its group.
746 stream_instance_id
= -1ULL;
749 if (stream_instance_id
== -1ULL) {
751 * No stream instance ID or no beginning timestamp:
752 * create a unique stream file group for this stream
753 * file because, even if there's a stream instance ID,
754 * there's no timestamp to order the file within its
757 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
,
758 stream_class
, stream_instance_id
);
759 if (!ds_file_group
) {
763 ret
= ctf_fs_ds_file_group_add_ds_file_info(ds_file_group
,
764 path
, begin_ns
, index
);
765 /* Ownership of index is transferred. */
775 BT_ASSERT(stream_instance_id
!= -1ULL);
776 BT_ASSERT(begin_ns
!= -1ULL);
778 /* Find an existing stream file group with this ID */
779 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
780 ds_file_group
= g_ptr_array_index(
781 ctf_fs_trace
->ds_file_groups
, i
);
783 if (ds_file_group
->stream_class
== stream_class
&&
784 ds_file_group
->stream_id
==
785 stream_instance_id
) {
789 ds_file_group
= NULL
;
792 if (!ds_file_group
) {
793 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
,
794 stream_class
, stream_instance_id
);
795 if (!ds_file_group
) {
802 ret
= ctf_fs_ds_file_group_add_ds_file_info(ds_file_group
, path
,
812 ctf_fs_ds_file_group_destroy(ds_file_group
);
816 if (add_group
&& ds_file_group
) {
817 g_ptr_array_add(ctf_fs_trace
->ds_file_groups
, ds_file_group
);
820 ctf_fs_ds_file_destroy(ds_file
);
823 bt_notif_iter_destroy(notif_iter
);
826 ctf_fs_ds_index_destroy(index
);
831 int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
,
832 struct bt_graph
*graph
)
835 const char *basename
;
836 GError
*error
= NULL
;
840 /* Check each file in the path directory, except specific ones */
841 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
843 BT_LOGE("Cannot open directory `%s`: %s (code %d)",
844 ctf_fs_trace
->path
->str
, error
->message
,
849 while ((basename
= g_dir_read_name(dir
))) {
850 struct ctf_fs_file
*file
;
852 if (!strcmp(basename
, CTF_FS_METADATA_FILENAME
)) {
853 /* Ignore the metadata stream. */
854 BT_LOGD("Ignoring metadata file `%s" G_DIR_SEPARATOR_S
"%s`",
855 ctf_fs_trace
->path
->str
, basename
);
859 if (basename
[0] == '.') {
860 BT_LOGD("Ignoring hidden file `%s" G_DIR_SEPARATOR_S
"%s`",
861 ctf_fs_trace
->path
->str
, basename
);
865 /* Create the file. */
866 file
= ctf_fs_file_create();
868 BT_LOGE("Cannot create stream file object for file `%s" G_DIR_SEPARATOR_S
"%s`",
869 ctf_fs_trace
->path
->str
, basename
);
873 /* Create full path string. */
874 g_string_append_printf(file
->path
, "%s" G_DIR_SEPARATOR_S
"%s",
875 ctf_fs_trace
->path
->str
, basename
);
876 if (!g_file_test(file
->path
->str
, G_FILE_TEST_IS_REGULAR
)) {
877 BT_LOGD("Ignoring non-regular file `%s`",
879 ctf_fs_file_destroy(file
);
884 ret
= ctf_fs_file_open(file
, "rb");
886 BT_LOGE("Cannot open stream file `%s`", file
->path
->str
);
890 if (file
->size
== 0) {
891 /* Skip empty stream. */
892 BT_LOGD("Ignoring empty file `%s`", file
->path
->str
);
893 ctf_fs_file_destroy(file
);
897 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
, graph
,
900 BT_LOGE("Cannot add stream file `%s` to stream file group",
902 ctf_fs_file_destroy(file
);
906 ctf_fs_file_destroy(file
);
910 * At this point, DS file groupes are created, but their
911 * associated stream objects do not exist yet. This is because
912 * we need to name the created stream object with the data
913 * stream file's path. We have everything we need here to do
916 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
917 struct ctf_fs_ds_file_group
*ds_file_group
=
918 g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
919 GString
*name
= get_stream_instance_unique_name(ds_file_group
);
925 if (ds_file_group
->stream_id
== -1ULL) {
926 /* No stream ID: use 0 */
927 ds_file_group
->stream
= bt_stream_create(
928 ds_file_group
->stream_class
, name
->str
,
929 ctf_fs_trace
->next_stream_id
);
930 ctf_fs_trace
->next_stream_id
++;
932 /* Specific stream ID */
933 ds_file_group
->stream
= bt_stream_create(
934 ds_file_group
->stream_class
, name
->str
,
935 ds_file_group
->stream_id
);
938 g_string_free(name
, TRUE
);
940 if (!ds_file_group
->stream
) {
941 BT_LOGE("Cannot create stream for DS file group: "
942 "addr=%p, stream-name=\"%s\"",
943 ds_file_group
, name
->str
);
967 struct ctf_fs_trace
*ctf_fs_trace_create(const char *path
, const char *name
,
968 struct ctf_fs_metadata_config
*metadata_config
,
969 struct bt_graph
*graph
)
971 struct ctf_fs_trace
*ctf_fs_trace
;
974 ctf_fs_trace
= g_new0(struct ctf_fs_trace
, 1);
979 ctf_fs_trace
->path
= g_string_new(path
);
980 if (!ctf_fs_trace
->path
) {
984 ctf_fs_trace
->name
= g_string_new(name
);
985 if (!ctf_fs_trace
->name
) {
989 ctf_fs_trace
->metadata
= g_new0(struct ctf_fs_metadata
, 1);
990 if (!ctf_fs_trace
->metadata
) {
994 ctf_fs_trace
->ds_file_groups
= g_ptr_array_new_with_free_func(
995 (GDestroyNotify
) ctf_fs_ds_file_group_destroy
);
996 if (!ctf_fs_trace
->ds_file_groups
) {
1000 ret
= ctf_fs_metadata_set_trace(ctf_fs_trace
, metadata_config
);
1005 ret
= create_ds_file_groups(ctf_fs_trace
, graph
);
1011 * create_ds_file_groups() created all the streams that this
1012 * trace needs. There won't be any more. Therefore it is safe to
1013 * make this trace static.
1015 (void) bt_trace_set_is_static(ctf_fs_trace
->metadata
->trace
);
1020 ctf_fs_trace_destroy(ctf_fs_trace
);
1021 ctf_fs_trace
= NULL
;
1023 return ctf_fs_trace
;
1027 int path_is_ctf_trace(const char *path
)
1029 GString
*metadata_path
= g_string_new(NULL
);
1032 if (!metadata_path
) {
1037 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
1039 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
1045 g_string_free(metadata_path
, TRUE
);
1050 int add_trace_path(GList
**trace_paths
, const char *path
)
1052 GString
*norm_path
= NULL
;
1055 norm_path
= bt_common_normalize_path(path
, NULL
);
1057 BT_LOGE("Failed to normalize path `%s`.", path
);
1062 // FIXME: Remove or ifdef for __MINGW32__
1063 if (strcmp(norm_path
->str
, "/") == 0) {
1064 BT_LOGE("Opening a trace in `/` is not supported.");
1069 *trace_paths
= g_list_prepend(*trace_paths
, norm_path
);
1070 BT_ASSERT(*trace_paths
);
1075 g_string_free(norm_path
, TRUE
);
1082 int ctf_fs_find_traces(GList
**trace_paths
, const char *start_path
)
1085 GError
*error
= NULL
;
1087 const char *basename
= NULL
;
1089 /* Check if the starting path is a CTF trace itself */
1090 ret
= path_is_ctf_trace(start_path
);
1097 * Stop recursion: a CTF trace cannot contain another
1100 ret
= add_trace_path(trace_paths
, start_path
);
1104 /* Look for subdirectories */
1105 if (!g_file_test(start_path
, G_FILE_TEST_IS_DIR
)) {
1106 /* Starting path is not a directory: end of recursion */
1110 dir
= g_dir_open(start_path
, 0, &error
);
1112 if (error
->code
== G_FILE_ERROR_ACCES
) {
1113 BT_LOGD("Cannot open directory `%s`: %s (code %d): continuing",
1114 start_path
, error
->message
, error
->code
);
1118 BT_LOGE("Cannot open directory `%s`: %s (code %d)",
1119 start_path
, error
->message
, error
->code
);
1124 while ((basename
= g_dir_read_name(dir
))) {
1125 GString
*sub_path
= g_string_new(NULL
);
1132 g_string_printf(sub_path
, "%s" G_DIR_SEPARATOR_S
"%s", start_path
, basename
);
1133 ret
= ctf_fs_find_traces(trace_paths
, sub_path
->str
);
1134 g_string_free(sub_path
, TRUE
);
1146 g_error_free(error
);
1153 GList
*ctf_fs_create_trace_names(GList
*trace_paths
, const char *base_path
) {
1154 GList
*trace_names
= NULL
;
1156 const char *last_sep
;
1160 * At this point we know that all the trace paths are
1161 * normalized, and so is the base path. This means that
1162 * they are absolute and they don't end with a separator.
1163 * We can simply find the location of the last separator
1164 * in the base path, which gives us the name of the actual
1165 * directory to look into, and use this location as the
1166 * start of each trace name within each trace path.
1170 * Base path: /home/user/my-traces/some-trace
1172 * - /home/user/my-traces/some-trace/host1/trace1
1173 * - /home/user/my-traces/some-trace/host1/trace2
1174 * - /home/user/my-traces/some-trace/host2/trace
1175 * - /home/user/my-traces/some-trace/other-trace
1177 * In this case the trace names are:
1179 * - some-trace/host1/trace1
1180 * - some-trace/host1/trace2
1181 * - some-trace/host2/trace
1182 * - some-trace/other-trace
1184 last_sep
= strrchr(base_path
, G_DIR_SEPARATOR
);
1186 /* We know there's at least one separator */
1187 BT_ASSERT(last_sep
);
1189 /* Distance to base */
1190 base_dist
= last_sep
- base_path
+ 1;
1192 /* Create the trace names */
1193 for (node
= trace_paths
; node
; node
= g_list_next(node
)) {
1194 GString
*trace_name
= g_string_new(NULL
);
1195 GString
*trace_path
= node
->data
;
1197 BT_ASSERT(trace_name
);
1198 g_string_assign(trace_name
, &trace_path
->str
[base_dist
]);
1199 trace_names
= g_list_append(trace_names
, trace_name
);
1206 int create_ctf_fs_traces(struct ctf_fs_component
*ctf_fs
,
1207 const char *path_param
)
1209 struct ctf_fs_trace
*ctf_fs_trace
= NULL
;
1211 GString
*norm_path
= NULL
;
1212 GList
*trace_paths
= NULL
;
1213 GList
*trace_names
= NULL
;
1217 norm_path
= bt_common_normalize_path(path_param
, NULL
);
1219 BT_LOGE("Failed to normalize path: `%s`.",
1224 ret
= ctf_fs_find_traces(&trace_paths
, norm_path
->str
);
1230 BT_LOGE("No CTF traces recursively found in `%s`.",
1235 trace_names
= ctf_fs_create_trace_names(trace_paths
, norm_path
->str
);
1237 BT_LOGE("Cannot create trace names from trace paths.");
1241 for (tp_node
= trace_paths
, tn_node
= trace_names
; tp_node
;
1242 tp_node
= g_list_next(tp_node
),
1243 tn_node
= g_list_next(tn_node
)) {
1244 GString
*trace_path
= tp_node
->data
;
1245 GString
*trace_name
= tn_node
->data
;
1246 struct bt_graph
*graph
= bt_component_borrow_graph(
1247 bt_component_borrow_from_private(ctf_fs
->priv_comp
));
1250 ctf_fs_trace
= ctf_fs_trace_create(trace_path
->str
,
1251 trace_name
->str
, &ctf_fs
->metadata_config
,
1253 if (!ctf_fs_trace
) {
1254 BT_LOGE("Cannot create trace for `%s`.",
1259 ret
= create_ports_for_trace(ctf_fs
, ctf_fs_trace
);
1264 g_ptr_array_add(ctf_fs
->traces
, ctf_fs_trace
);
1265 ctf_fs_trace
= NULL
;
1272 ctf_fs_trace_destroy(ctf_fs_trace
);
1275 for (tp_node
= trace_paths
; tp_node
; tp_node
= g_list_next(tp_node
)) {
1276 if (tp_node
->data
) {
1277 g_string_free(tp_node
->data
, TRUE
);
1281 for (tn_node
= trace_names
; tn_node
; tn_node
= g_list_next(tn_node
)) {
1282 if (tn_node
->data
) {
1283 g_string_free(tn_node
->data
, TRUE
);
1288 g_list_free(trace_paths
);
1292 g_list_free(trace_names
);
1296 g_string_free(norm_path
, TRUE
);
1303 struct ctf_fs_component
*ctf_fs_create(struct bt_private_component
*priv_comp
,
1304 struct bt_value
*params
)
1306 struct ctf_fs_component
*ctf_fs
;
1307 struct bt_value
*value
= NULL
;
1308 const char *path_param
;
1309 enum bt_component_status ret
;
1310 enum bt_value_status value_ret
;
1312 ctf_fs
= g_new0(struct ctf_fs_component
, 1);
1317 ret
= bt_private_component_set_user_data(priv_comp
, ctf_fs
);
1318 BT_ASSERT(ret
== BT_COMPONENT_STATUS_OK
);
1321 * We don't need to get a new reference here because as long as
1322 * our private ctf_fs_component object exists, the containing
1323 * private component should also exist.
1325 ctf_fs
->priv_comp
= priv_comp
;
1326 value
= bt_value_map_borrow(params
, "path");
1327 if (value
&& !bt_value_is_string(value
)) {
1331 value_ret
= bt_value_string_get(value
, &path_param
);
1332 BT_ASSERT(value_ret
== BT_VALUE_STATUS_OK
);
1333 value
= bt_value_map_borrow(params
, "clock-class-offset-s");
1335 if (!bt_value_is_integer(value
)) {
1336 BT_LOGE("clock-class-offset-s should be an integer");
1339 value_ret
= bt_value_integer_get(value
,
1340 &ctf_fs
->metadata_config
.clock_class_offset_s
);
1341 BT_ASSERT(value_ret
== BT_VALUE_STATUS_OK
);
1344 value
= bt_value_map_borrow(params
, "clock-class-offset-ns");
1346 if (!bt_value_is_integer(value
)) {
1347 BT_LOGE("clock-class-offset-ns should be an integer");
1350 value_ret
= bt_value_integer_get(value
,
1351 &ctf_fs
->metadata_config
.clock_class_offset_ns
);
1352 BT_ASSERT(value_ret
== BT_VALUE_STATUS_OK
);
1355 ctf_fs
->port_data
= g_ptr_array_new_with_free_func(port_data_destroy
);
1356 if (!ctf_fs
->port_data
) {
1360 ctf_fs
->traces
= g_ptr_array_new_with_free_func(
1361 ctf_fs_trace_destroy_notifier
);
1362 if (!ctf_fs
->traces
) {
1366 if (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
);
1376 BT_ASSERT(ret
== BT_COMPONENT_STATUS_OK
);
1383 enum bt_component_status
ctf_fs_init(struct bt_private_component
*priv_comp
,
1384 struct bt_value
*params
, UNUSED_VAR
void *init_method_data
)
1386 struct ctf_fs_component
*ctf_fs
;
1387 enum bt_component_status ret
= BT_COMPONENT_STATUS_OK
;
1389 ctf_fs
= ctf_fs_create(priv_comp
, params
);
1391 ret
= BT_COMPONENT_STATUS_ERROR
;
1398 struct bt_component_class_query_method_return
ctf_fs_query(
1399 struct bt_component_class
*comp_class
,
1400 struct bt_query_executor
*query_exec
,
1401 const char *object
, struct bt_value
*params
)
1403 struct bt_component_class_query_method_return ret
= {
1405 .status
= BT_QUERY_STATUS_OK
,
1408 if (!strcmp(object
, "metadata-info")) {
1409 ret
= metadata_info_query(comp_class
, params
);
1410 } else if (!strcmp(object
, "trace-info")) {
1411 ret
= trace_info_query(comp_class
, params
);
1413 BT_LOGE("Unknown query object `%s`", object
);
1414 ret
.status
= BT_QUERY_STATUS_INVALID_OBJECT
;