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/msg-iter/msg-iter.h"
41 #include "../common/utils/utils.h"
44 #define BT_LOG_TAG "PLUGIN-CTF-FS-SRC"
48 int msg_iter_data_set_current_ds_file(struct ctf_fs_msg_iter_data
*msg_iter_data
)
50 struct ctf_fs_ds_file_info
*ds_file_info
;
53 BT_ASSERT(msg_iter_data
->ds_file_info_index
<
54 msg_iter_data
->ds_file_group
->ds_file_infos
->len
);
55 ds_file_info
= g_ptr_array_index(
56 msg_iter_data
->ds_file_group
->ds_file_infos
,
57 msg_iter_data
->ds_file_info_index
);
59 ctf_fs_ds_file_destroy(msg_iter_data
->ds_file
);
60 msg_iter_data
->ds_file
= ctf_fs_ds_file_create(
61 msg_iter_data
->ds_file_group
->ctf_fs_trace
,
62 msg_iter_data
->pc_msg_iter
,
63 msg_iter_data
->msg_iter
,
64 msg_iter_data
->ds_file_group
->stream
,
65 ds_file_info
->path
->str
);
66 if (!msg_iter_data
->ds_file
) {
74 void ctf_fs_msg_iter_data_destroy(
75 struct ctf_fs_msg_iter_data
*msg_iter_data
)
81 ctf_fs_ds_file_destroy(msg_iter_data
->ds_file
);
83 if (msg_iter_data
->msg_iter
) {
84 bt_msg_iter_destroy(msg_iter_data
->msg_iter
);
87 g_free(msg_iter_data
);
91 void set_msg_iter_emits_stream_beginning_end_messages(
92 struct ctf_fs_msg_iter_data
*msg_iter_data
)
94 bt_msg_iter_set_emit_stream_beginning_message(
95 msg_iter_data
->ds_file
->msg_iter
,
96 msg_iter_data
->ds_file_info_index
== 0);
97 bt_msg_iter_set_emit_stream_end_message(
98 msg_iter_data
->ds_file
->msg_iter
,
99 msg_iter_data
->ds_file_info_index
==
100 msg_iter_data
->ds_file_group
->ds_file_infos
->len
- 1);
104 bt_self_message_iterator_status
ctf_fs_iterator_next_one(
105 struct ctf_fs_msg_iter_data
*msg_iter_data
,
106 const bt_message
**out_msg
)
108 bt_self_message_iterator_status status
;
110 BT_ASSERT(msg_iter_data
->ds_file
);
115 status
= ctf_fs_ds_file_next(msg_iter_data
->ds_file
, &msg
);
117 case BT_SELF_MESSAGE_ITERATOR_STATUS_OK
:
121 case BT_SELF_MESSAGE_ITERATOR_STATUS_END
:
125 if (msg_iter_data
->ds_file_info_index
==
126 msg_iter_data
->ds_file_group
->ds_file_infos
->len
- 1) {
127 /* End of all group's stream files */
131 msg_iter_data
->ds_file_info_index
++;
132 bt_msg_iter_reset_for_next_stream_file(
133 msg_iter_data
->msg_iter
);
134 set_msg_iter_emits_stream_beginning_end_messages(
138 * Open and start reading the next stream file
139 * within our stream file group.
141 ret
= msg_iter_data_set_current_ds_file(msg_iter_data
);
143 status
= BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR
;
147 /* Continue the loop to get the next message */
160 bt_self_message_iterator_status
ctf_fs_iterator_next(
161 bt_self_message_iterator
*iterator
,
162 bt_message_array_const msgs
, uint64_t capacity
,
165 bt_self_message_iterator_status status
=
166 BT_SELF_MESSAGE_ITERATOR_STATUS_OK
;
167 struct ctf_fs_msg_iter_data
*msg_iter_data
=
168 bt_self_message_iterator_get_data(iterator
);
171 while (i
< capacity
&& status
== BT_SELF_MESSAGE_ITERATOR_STATUS_OK
) {
172 status
= ctf_fs_iterator_next_one(msg_iter_data
, &msgs
[i
]);
173 if (status
== BT_SELF_MESSAGE_ITERATOR_STATUS_OK
) {
180 * Even if ctf_fs_iterator_next_one() returned something
181 * else than BT_SELF_MESSAGE_ITERATOR_STATUS_OK, we
182 * accumulated message objects in the output
183 * message array, so we need to return
184 * BT_SELF_MESSAGE_ITERATOR_STATUS_OK so that they are
185 * transfered to downstream. This other status occurs
186 * again the next time muxer_msg_iter_do_next() is
187 * called, possibly without any accumulated
188 * message, in which case we'll return it.
191 status
= BT_SELF_MESSAGE_ITERATOR_STATUS_OK
;
197 void ctf_fs_iterator_finalize(bt_self_message_iterator
*it
)
199 ctf_fs_msg_iter_data_destroy(
200 bt_self_message_iterator_get_data(it
));
203 bt_self_message_iterator_status
ctf_fs_iterator_init(
204 bt_self_message_iterator
*self_msg_iter
,
205 bt_self_component_source
*self_comp
,
206 bt_self_component_port_output
*self_port
)
208 struct ctf_fs_port_data
*port_data
;
209 struct ctf_fs_msg_iter_data
*msg_iter_data
= NULL
;
210 bt_self_message_iterator_status ret
=
211 BT_SELF_MESSAGE_ITERATOR_STATUS_OK
;
214 port_data
= bt_self_component_port_get_data(
215 bt_self_component_port_output_as_self_component_port(
217 BT_ASSERT(port_data
);
218 msg_iter_data
= g_new0(struct ctf_fs_msg_iter_data
, 1);
219 if (!msg_iter_data
) {
220 ret
= BT_SELF_MESSAGE_ITERATOR_STATUS_NOMEM
;
224 msg_iter_data
->pc_msg_iter
= self_msg_iter
;
225 msg_iter_data
->msg_iter
= bt_msg_iter_create(
226 port_data
->ds_file_group
->ctf_fs_trace
->metadata
->tc
,
227 bt_common_get_page_size() * 8,
228 ctf_fs_ds_file_medops
, NULL
);
229 if (!msg_iter_data
->msg_iter
) {
230 BT_LOGE_STR("Cannot create a CTF message iterator.");
231 ret
= BT_SELF_MESSAGE_ITERATOR_STATUS_NOMEM
;
235 msg_iter_data
->ds_file_group
= port_data
->ds_file_group
;
236 iret
= msg_iter_data_set_current_ds_file(msg_iter_data
);
238 ret
= BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR
;
242 set_msg_iter_emits_stream_beginning_end_messages(msg_iter_data
);
243 bt_self_message_iterator_set_data(self_msg_iter
,
245 if (ret
!= BT_SELF_MESSAGE_ITERATOR_STATUS_OK
) {
249 msg_iter_data
= NULL
;
253 bt_self_message_iterator_set_data(self_msg_iter
, NULL
);
256 ctf_fs_msg_iter_data_destroy(msg_iter_data
);
261 void ctf_fs_destroy(struct ctf_fs_component
*ctf_fs
)
267 if (ctf_fs
->traces
) {
268 g_ptr_array_free(ctf_fs
->traces
, TRUE
);
271 if (ctf_fs
->port_data
) {
272 g_ptr_array_free(ctf_fs
->port_data
, TRUE
);
279 void ctf_fs_trace_destroy(struct ctf_fs_trace
*ctf_fs_trace
)
285 if (ctf_fs_trace
->ds_file_groups
) {
286 g_ptr_array_free(ctf_fs_trace
->ds_file_groups
, TRUE
);
289 BT_TRACE_PUT_REF_AND_RESET(ctf_fs_trace
->trace
);
291 if (ctf_fs_trace
->path
) {
292 g_string_free(ctf_fs_trace
->path
, TRUE
);
295 if (ctf_fs_trace
->name
) {
296 g_string_free(ctf_fs_trace
->name
, TRUE
);
299 if (ctf_fs_trace
->metadata
) {
300 ctf_fs_metadata_fini(ctf_fs_trace
->metadata
);
301 g_free(ctf_fs_trace
->metadata
);
304 g_free(ctf_fs_trace
);
308 void ctf_fs_trace_destroy_notifier(void *data
)
310 struct ctf_fs_trace
*trace
= data
;
311 ctf_fs_trace_destroy(trace
);
314 void ctf_fs_finalize(bt_self_component_source
*component
)
316 ctf_fs_destroy(bt_self_component_get_data(
317 bt_self_component_source_as_self_component(component
)));
321 void port_data_destroy(void *data
) {
322 struct ctf_fs_port_data
*port_data
= data
;
332 GString
*get_stream_instance_unique_name(
333 struct ctf_fs_ds_file_group
*ds_file_group
)
336 struct ctf_fs_ds_file_info
*ds_file_info
;
338 name
= g_string_new(NULL
);
344 * If there's more than one stream file in the stream file
345 * group, the first (earliest) stream file's path is used as
346 * the stream's unique name.
348 BT_ASSERT(ds_file_group
->ds_file_infos
->len
> 0);
349 ds_file_info
= g_ptr_array_index(ds_file_group
->ds_file_infos
, 0);
350 g_string_assign(name
, ds_file_info
->path
->str
);
357 int create_one_port_for_trace(struct ctf_fs_component
*ctf_fs
,
358 struct ctf_fs_trace
*ctf_fs_trace
,
359 struct ctf_fs_ds_file_group
*ds_file_group
)
362 struct ctf_fs_port_data
*port_data
= NULL
;
363 GString
*port_name
= NULL
;
365 port_name
= get_stream_instance_unique_name(ds_file_group
);
370 BT_LOGD("Creating one port named `%s`", port_name
->str
);
372 /* Create output port for this file */
373 port_data
= g_new0(struct ctf_fs_port_data
, 1);
378 port_data
->ctf_fs
= ctf_fs
;
379 port_data
->ds_file_group
= ds_file_group
;
380 ret
= bt_self_component_source_add_output_port(
381 ctf_fs
->self_comp
, port_name
->str
, port_data
, NULL
);
386 g_ptr_array_add(ctf_fs
->port_data
, port_data
);
395 g_string_free(port_name
, TRUE
);
398 port_data_destroy(port_data
);
403 int create_ports_for_trace(struct ctf_fs_component
*ctf_fs
,
404 struct ctf_fs_trace
*ctf_fs_trace
)
409 /* Create one output port for each stream file group */
410 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
411 struct ctf_fs_ds_file_group
*ds_file_group
=
412 g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
414 ret
= create_one_port_for_trace(ctf_fs
, ctf_fs_trace
,
417 BT_LOGE("Cannot create output port.");
427 void ctf_fs_ds_file_info_destroy(struct ctf_fs_ds_file_info
*ds_file_info
)
433 if (ds_file_info
->path
) {
434 g_string_free(ds_file_info
->path
, TRUE
);
437 ctf_fs_ds_index_destroy(ds_file_info
->index
);
438 g_free(ds_file_info
);
442 struct ctf_fs_ds_file_info
*ctf_fs_ds_file_info_create(const char *path
,
443 int64_t begin_ns
, struct ctf_fs_ds_index
*index
)
445 struct ctf_fs_ds_file_info
*ds_file_info
;
447 ds_file_info
= g_new0(struct ctf_fs_ds_file_info
, 1);
452 ds_file_info
->path
= g_string_new(path
);
453 if (!ds_file_info
->path
) {
454 ctf_fs_ds_file_info_destroy(ds_file_info
);
459 ds_file_info
->begin_ns
= begin_ns
;
460 ds_file_info
->index
= index
;
464 ctf_fs_ds_index_destroy(index
);
469 void ctf_fs_ds_file_group_destroy(struct ctf_fs_ds_file_group
*ds_file_group
)
471 if (!ds_file_group
) {
475 if (ds_file_group
->ds_file_infos
) {
476 g_ptr_array_free(ds_file_group
->ds_file_infos
, TRUE
);
479 bt_stream_put_ref(ds_file_group
->stream
);
480 bt_stream_class_put_ref(ds_file_group
->stream_class
);
481 g_free(ds_file_group
);
485 struct ctf_fs_ds_file_group
*ctf_fs_ds_file_group_create(
486 struct ctf_fs_trace
*ctf_fs_trace
,
487 bt_stream_class
*stream_class
,
488 uint64_t stream_instance_id
)
490 struct ctf_fs_ds_file_group
*ds_file_group
;
492 ds_file_group
= g_new0(struct ctf_fs_ds_file_group
, 1);
493 if (!ds_file_group
) {
497 ds_file_group
->ds_file_infos
= g_ptr_array_new_with_free_func(
498 (GDestroyNotify
) ctf_fs_ds_file_info_destroy
);
499 if (!ds_file_group
->ds_file_infos
) {
503 ds_file_group
->stream_id
= stream_instance_id
;
504 BT_ASSERT(stream_class
);
505 ds_file_group
->stream_class
= stream_class
;
506 bt_stream_class_get_ref(ds_file_group
->stream_class
);
507 ds_file_group
->ctf_fs_trace
= ctf_fs_trace
;
511 ctf_fs_ds_file_group_destroy(ds_file_group
);
512 ds_file_group
= NULL
;
515 return ds_file_group
;
518 /* Replace by g_ptr_array_insert when we depend on glib >= 2.40. */
520 void array_insert(GPtrArray
*array
, gpointer element
, size_t pos
)
522 size_t original_array_len
= array
->len
;
524 /* Allocate an unused element at the end of the array. */
525 g_ptr_array_add(array
, NULL
);
527 /* If we are not inserting at the end, move the elements by one. */
528 if (pos
< original_array_len
) {
529 memmove(&(array
->pdata
[pos
+ 1]),
530 &(array
->pdata
[pos
]),
531 (original_array_len
- pos
) * sizeof(gpointer
));
534 /* Insert the value and bump the array len */
535 array
->pdata
[pos
] = element
;
539 int ctf_fs_ds_file_group_add_ds_file_info(
540 struct ctf_fs_ds_file_group
*ds_file_group
,
541 const char *path
, int64_t begin_ns
,
542 struct ctf_fs_ds_index
*index
)
544 struct ctf_fs_ds_file_info
*ds_file_info
;
548 /* Onwership of index is transferred. */
549 ds_file_info
= ctf_fs_ds_file_info_create(path
, begin_ns
, index
);
555 /* Find a spot to insert this one */
556 for (i
= 0; i
< ds_file_group
->ds_file_infos
->len
; i
++) {
557 struct ctf_fs_ds_file_info
*other_ds_file_info
=
558 g_ptr_array_index(ds_file_group
->ds_file_infos
, i
);
560 if (begin_ns
< other_ds_file_info
->begin_ns
) {
565 array_insert(ds_file_group
->ds_file_infos
, ds_file_info
, i
);
570 ctf_fs_ds_file_info_destroy(ds_file_info
);
571 ctf_fs_ds_index_destroy(index
);
578 int add_ds_file_to_ds_file_group(struct ctf_fs_trace
*ctf_fs_trace
,
581 bt_stream_class
*stream_class
= NULL
;
582 int64_t stream_instance_id
= -1;
583 int64_t begin_ns
= -1;
584 struct ctf_fs_ds_file_group
*ds_file_group
= NULL
;
585 bool add_group
= false;
588 struct ctf_fs_ds_file
*ds_file
= NULL
;
589 struct ctf_fs_ds_index
*index
= NULL
;
590 struct bt_msg_iter
*msg_iter
= NULL
;
591 struct ctf_stream_class
*sc
= NULL
;
592 struct bt_msg_iter_packet_properties props
;
594 msg_iter
= bt_msg_iter_create(ctf_fs_trace
->metadata
->tc
,
595 bt_common_get_page_size() * 8, ctf_fs_ds_file_medops
, NULL
);
597 BT_LOGE_STR("Cannot create a CTF message iterator.");
601 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, msg_iter
,
607 ret
= bt_msg_iter_get_packet_properties(ds_file
->msg_iter
, &props
);
609 BT_LOGE("Cannot get stream file's first packet's header and context fields (`%s`).",
614 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
,
615 props
.stream_class_id
);
617 stream_class
= sc
->ir_sc
;
618 BT_ASSERT(stream_class
);
619 stream_instance_id
= props
.data_stream_id
;
621 if (props
.snapshots
.beginning_clock
!= UINT64_C(-1)) {
622 BT_ASSERT(sc
->default_clock_class
);
623 ret
= bt_util_clock_cycles_to_ns_from_origin(
624 props
.snapshots
.beginning_clock
,
625 sc
->default_clock_class
->frequency
,
626 sc
->default_clock_class
->offset_seconds
,
627 sc
->default_clock_class
->offset_cycles
, &begin_ns
);
629 BT_LOGE("Cannot convert clock cycles to nanoseconds from origin (`%s`).",
635 index
= ctf_fs_ds_file_build_index(ds_file
);
637 BT_LOGW("Failed to index CTF stream file \'%s\'",
638 ds_file
->file
->path
->str
);
641 if (begin_ns
== -1) {
643 * No beggining timestamp to sort the stream files
644 * within a stream file group, so consider that this
645 * file must be the only one within its group.
647 stream_instance_id
= -1;
650 if (stream_instance_id
== -1) {
652 * No stream instance ID or no beginning timestamp:
653 * create a unique stream file group for this stream
654 * file because, even if there's a stream instance ID,
655 * there's no timestamp to order the file within its
658 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
,
659 stream_class
, stream_instance_id
);
660 if (!ds_file_group
) {
664 ret
= ctf_fs_ds_file_group_add_ds_file_info(ds_file_group
,
665 path
, begin_ns
, index
);
666 /* Ownership of index is transferred. */
676 BT_ASSERT(stream_instance_id
!= -1);
677 BT_ASSERT(begin_ns
!= -1);
679 /* Find an existing stream file group with this ID */
680 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
681 ds_file_group
= g_ptr_array_index(
682 ctf_fs_trace
->ds_file_groups
, i
);
684 if (ds_file_group
->stream_class
== stream_class
&&
685 ds_file_group
->stream_id
==
686 stream_instance_id
) {
690 ds_file_group
= NULL
;
693 if (!ds_file_group
) {
694 ds_file_group
= ctf_fs_ds_file_group_create(ctf_fs_trace
,
695 stream_class
, stream_instance_id
);
696 if (!ds_file_group
) {
703 ret
= ctf_fs_ds_file_group_add_ds_file_info(ds_file_group
, path
,
713 ctf_fs_ds_file_group_destroy(ds_file_group
);
717 if (add_group
&& ds_file_group
) {
718 g_ptr_array_add(ctf_fs_trace
->ds_file_groups
, ds_file_group
);
721 ctf_fs_ds_file_destroy(ds_file
);
724 bt_msg_iter_destroy(msg_iter
);
727 ctf_fs_ds_index_destroy(index
);
732 int create_ds_file_groups(struct ctf_fs_trace
*ctf_fs_trace
)
735 const char *basename
;
736 GError
*error
= NULL
;
740 /* Check each file in the path directory, except specific ones */
741 dir
= g_dir_open(ctf_fs_trace
->path
->str
, 0, &error
);
743 BT_LOGE("Cannot open directory `%s`: %s (code %d)",
744 ctf_fs_trace
->path
->str
, error
->message
,
749 while ((basename
= g_dir_read_name(dir
))) {
750 struct ctf_fs_file
*file
;
752 if (!strcmp(basename
, CTF_FS_METADATA_FILENAME
)) {
753 /* Ignore the metadata stream. */
754 BT_LOGD("Ignoring metadata file `%s" G_DIR_SEPARATOR_S
"%s`",
755 ctf_fs_trace
->path
->str
, basename
);
759 if (basename
[0] == '.') {
760 BT_LOGD("Ignoring hidden file `%s" G_DIR_SEPARATOR_S
"%s`",
761 ctf_fs_trace
->path
->str
, basename
);
765 /* Create the file. */
766 file
= ctf_fs_file_create();
768 BT_LOGE("Cannot create stream file object for file `%s" G_DIR_SEPARATOR_S
"%s`",
769 ctf_fs_trace
->path
->str
, basename
);
773 /* Create full path string. */
774 g_string_append_printf(file
->path
, "%s" G_DIR_SEPARATOR_S
"%s",
775 ctf_fs_trace
->path
->str
, basename
);
776 if (!g_file_test(file
->path
->str
, G_FILE_TEST_IS_REGULAR
)) {
777 BT_LOGD("Ignoring non-regular file `%s`",
779 ctf_fs_file_destroy(file
);
784 ret
= ctf_fs_file_open(file
, "rb");
786 BT_LOGE("Cannot open stream file `%s`", file
->path
->str
);
790 if (file
->size
== 0) {
791 /* Skip empty stream. */
792 BT_LOGD("Ignoring empty file `%s`", file
->path
->str
);
793 ctf_fs_file_destroy(file
);
797 ret
= add_ds_file_to_ds_file_group(ctf_fs_trace
,
800 BT_LOGE("Cannot add stream file `%s` to stream file group",
802 ctf_fs_file_destroy(file
);
806 ctf_fs_file_destroy(file
);
809 if (!ctf_fs_trace
->trace
) {
814 * At this point, DS file groupes are created, but their
815 * associated stream objects do not exist yet. This is because
816 * we need to name the created stream object with the data
817 * stream file's path. We have everything we need here to do
820 for (i
= 0; i
< ctf_fs_trace
->ds_file_groups
->len
; i
++) {
821 struct ctf_fs_ds_file_group
*ds_file_group
=
822 g_ptr_array_index(ctf_fs_trace
->ds_file_groups
, i
);
823 GString
*name
= get_stream_instance_unique_name(ds_file_group
);
829 if (ds_file_group
->stream_id
== UINT64_C(-1)) {
830 /* No stream ID: use 0 */
831 ds_file_group
->stream
= bt_stream_create_with_id(
832 ds_file_group
->stream_class
,
834 ctf_fs_trace
->next_stream_id
);
835 ctf_fs_trace
->next_stream_id
++;
837 /* Specific stream ID */
838 ds_file_group
->stream
= bt_stream_create_with_id(
839 ds_file_group
->stream_class
,
841 (uint64_t) ds_file_group
->stream_id
);
844 if (!ds_file_group
->stream
) {
845 BT_LOGE("Cannot create stream for DS file group: "
846 "addr=%p, stream-name=\"%s\"",
847 ds_file_group
, name
->str
);
848 g_string_free(name
, TRUE
);
852 ret
= bt_stream_set_name(ds_file_group
->stream
,
855 BT_LOGE("Cannot set stream's name: "
856 "addr=%p, stream-name=\"%s\"",
857 ds_file_group
->stream
, name
->str
);
858 g_string_free(name
, TRUE
);
862 g_string_free(name
, TRUE
);
884 int set_trace_name(bt_trace
*trace
, const char *name_suffix
)
887 const bt_trace_class
*tc
= bt_trace_borrow_class_const(trace
);
891 name
= g_string_new(NULL
);
893 BT_LOGE_STR("Failed to allocate a GString.");
899 * Check if we have a trace environment string value named `hostname`.
900 * If so, use it as the trace name's prefix.
902 val
= bt_trace_class_borrow_environment_entry_value_by_name_const(
904 if (val
&& bt_value_is_string(val
)) {
905 g_string_append(name
, bt_value_string_get(val
));
908 g_string_append_c(name
, G_DIR_SEPARATOR
);
913 g_string_append(name
, name_suffix
);
916 ret
= bt_trace_set_name(trace
, name
->str
);
925 g_string_free(name
, TRUE
);
932 struct ctf_fs_trace
*ctf_fs_trace_create(bt_self_component_source
*self_comp
,
933 const char *path
, const char *name
,
934 struct ctf_fs_metadata_config
*metadata_config
)
936 struct ctf_fs_trace
*ctf_fs_trace
;
939 ctf_fs_trace
= g_new0(struct ctf_fs_trace
, 1);
944 ctf_fs_trace
->path
= g_string_new(path
);
945 if (!ctf_fs_trace
->path
) {
949 ctf_fs_trace
->name
= g_string_new(name
);
950 if (!ctf_fs_trace
->name
) {
954 ctf_fs_trace
->metadata
= g_new0(struct ctf_fs_metadata
, 1);
955 if (!ctf_fs_trace
->metadata
) {
959 ctf_fs_metadata_init(ctf_fs_trace
->metadata
);
960 ctf_fs_trace
->ds_file_groups
= g_ptr_array_new_with_free_func(
961 (GDestroyNotify
) ctf_fs_ds_file_group_destroy
);
962 if (!ctf_fs_trace
->ds_file_groups
) {
966 ret
= ctf_fs_metadata_set_trace_class(self_comp
,
967 ctf_fs_trace
, metadata_config
);
972 if (ctf_fs_trace
->metadata
->trace_class
) {
973 ctf_fs_trace
->trace
=
974 bt_trace_create(ctf_fs_trace
->metadata
->trace_class
);
975 if (!ctf_fs_trace
->trace
) {
980 if (ctf_fs_trace
->trace
) {
981 ret
= set_trace_name(ctf_fs_trace
->trace
, name
);
987 ret
= create_ds_file_groups(ctf_fs_trace
);
993 * create_ds_file_groups() created all the streams that this
994 * trace needs. There won't be any more. Therefore it is safe to
995 * make this trace static.
997 if (ctf_fs_trace
->trace
) {
998 (void) bt_trace_make_static(ctf_fs_trace
->trace
);
1004 ctf_fs_trace_destroy(ctf_fs_trace
);
1005 ctf_fs_trace
= NULL
;
1008 return ctf_fs_trace
;
1012 int path_is_ctf_trace(const char *path
)
1014 GString
*metadata_path
= g_string_new(NULL
);
1017 if (!metadata_path
) {
1022 g_string_printf(metadata_path
, "%s" G_DIR_SEPARATOR_S
"%s", path
, CTF_FS_METADATA_FILENAME
);
1024 if (g_file_test(metadata_path
->str
, G_FILE_TEST_IS_REGULAR
)) {
1030 g_string_free(metadata_path
, TRUE
);
1035 int add_trace_path(GList
**trace_paths
, const char *path
)
1037 GString
*norm_path
= NULL
;
1040 norm_path
= bt_common_normalize_path(path
, NULL
);
1042 BT_LOGE("Failed to normalize path `%s`.", path
);
1047 // FIXME: Remove or ifdef for __MINGW32__
1048 if (strcmp(norm_path
->str
, "/") == 0) {
1049 BT_LOGE("Opening a trace in `/` is not supported.");
1054 *trace_paths
= g_list_prepend(*trace_paths
, norm_path
);
1055 BT_ASSERT(*trace_paths
);
1060 g_string_free(norm_path
, TRUE
);
1067 int ctf_fs_find_traces(GList
**trace_paths
, const char *start_path
)
1070 GError
*error
= NULL
;
1072 const char *basename
= NULL
;
1074 /* Check if the starting path is a CTF trace itself */
1075 ret
= path_is_ctf_trace(start_path
);
1082 * Stop recursion: a CTF trace cannot contain another
1085 ret
= add_trace_path(trace_paths
, start_path
);
1089 /* Look for subdirectories */
1090 if (!g_file_test(start_path
, G_FILE_TEST_IS_DIR
)) {
1091 /* Starting path is not a directory: end of recursion */
1095 dir
= g_dir_open(start_path
, 0, &error
);
1097 if (error
->code
== G_FILE_ERROR_ACCES
) {
1098 BT_LOGD("Cannot open directory `%s`: %s (code %d): continuing",
1099 start_path
, error
->message
, error
->code
);
1103 BT_LOGE("Cannot open directory `%s`: %s (code %d)",
1104 start_path
, error
->message
, error
->code
);
1109 while ((basename
= g_dir_read_name(dir
))) {
1110 GString
*sub_path
= g_string_new(NULL
);
1117 g_string_printf(sub_path
, "%s" G_DIR_SEPARATOR_S
"%s", start_path
, basename
);
1118 ret
= ctf_fs_find_traces(trace_paths
, sub_path
->str
);
1119 g_string_free(sub_path
, TRUE
);
1131 g_error_free(error
);
1138 GList
*ctf_fs_create_trace_names(GList
*trace_paths
, const char *base_path
) {
1139 GList
*trace_names
= NULL
;
1141 const char *last_sep
;
1145 * At this point we know that all the trace paths are
1146 * normalized, and so is the base path. This means that
1147 * they are absolute and they don't end with a separator.
1148 * We can simply find the location of the last separator
1149 * in the base path, which gives us the name of the actual
1150 * directory to look into, and use this location as the
1151 * start of each trace name within each trace path.
1155 * Base path: /home/user/my-traces/some-trace
1157 * - /home/user/my-traces/some-trace/host1/trace1
1158 * - /home/user/my-traces/some-trace/host1/trace2
1159 * - /home/user/my-traces/some-trace/host2/trace
1160 * - /home/user/my-traces/some-trace/other-trace
1162 * In this case the trace names are:
1164 * - some-trace/host1/trace1
1165 * - some-trace/host1/trace2
1166 * - some-trace/host2/trace
1167 * - some-trace/other-trace
1169 last_sep
= strrchr(base_path
, G_DIR_SEPARATOR
);
1171 /* We know there's at least one separator */
1172 BT_ASSERT(last_sep
);
1174 /* Distance to base */
1175 base_dist
= last_sep
- base_path
+ 1;
1177 /* Create the trace names */
1178 for (node
= trace_paths
; node
; node
= g_list_next(node
)) {
1179 GString
*trace_name
= g_string_new(NULL
);
1180 GString
*trace_path
= node
->data
;
1182 BT_ASSERT(trace_name
);
1183 g_string_assign(trace_name
, &trace_path
->str
[base_dist
]);
1184 trace_names
= g_list_append(trace_names
, trace_name
);
1191 int create_ctf_fs_traces(bt_self_component_source
*self_comp
,
1192 struct ctf_fs_component
*ctf_fs
,
1193 const char *path_param
)
1195 struct ctf_fs_trace
*ctf_fs_trace
= NULL
;
1197 GString
*norm_path
= NULL
;
1198 GList
*trace_paths
= NULL
;
1199 GList
*trace_names
= NULL
;
1203 norm_path
= bt_common_normalize_path(path_param
, NULL
);
1205 BT_LOGE("Failed to normalize path: `%s`.",
1210 ret
= ctf_fs_find_traces(&trace_paths
, norm_path
->str
);
1216 BT_LOGE("No CTF traces recursively found in `%s`.",
1221 trace_names
= ctf_fs_create_trace_names(trace_paths
, norm_path
->str
);
1223 BT_LOGE("Cannot create trace names from trace paths.");
1227 for (tp_node
= trace_paths
, tn_node
= trace_names
; tp_node
;
1228 tp_node
= g_list_next(tp_node
),
1229 tn_node
= g_list_next(tn_node
)) {
1230 GString
*trace_path
= tp_node
->data
;
1231 GString
*trace_name
= tn_node
->data
;
1233 ctf_fs_trace
= ctf_fs_trace_create(self_comp
,
1234 trace_path
->str
, trace_name
->str
,
1235 &ctf_fs
->metadata_config
);
1236 if (!ctf_fs_trace
) {
1237 BT_LOGE("Cannot create trace for `%s`.",
1242 ret
= create_ports_for_trace(ctf_fs
, ctf_fs_trace
);
1247 g_ptr_array_add(ctf_fs
->traces
, ctf_fs_trace
);
1248 ctf_fs_trace
= NULL
;
1255 ctf_fs_trace_destroy(ctf_fs_trace
);
1258 for (tp_node
= trace_paths
; tp_node
; tp_node
= g_list_next(tp_node
)) {
1259 if (tp_node
->data
) {
1260 g_string_free(tp_node
->data
, TRUE
);
1264 for (tn_node
= trace_names
; tn_node
; tn_node
= g_list_next(tn_node
)) {
1265 if (tn_node
->data
) {
1266 g_string_free(tn_node
->data
, TRUE
);
1271 g_list_free(trace_paths
);
1275 g_list_free(trace_names
);
1279 g_string_free(norm_path
, TRUE
);
1286 struct ctf_fs_component
*ctf_fs_create(
1287 bt_self_component_source
*self_comp
,
1288 const bt_value
*params
)
1290 struct ctf_fs_component
*ctf_fs
;
1291 const bt_value
*value
= NULL
;
1292 const char *path_param
;
1294 ctf_fs
= g_new0(struct ctf_fs_component
, 1);
1299 bt_self_component_set_data(
1300 bt_self_component_source_as_self_component(self_comp
),
1304 * We don't need to get a new reference here because as long as
1305 * our private ctf_fs_component object exists, the containing
1306 * private component should also exist.
1308 ctf_fs
->self_comp
= self_comp
;
1309 value
= bt_value_map_borrow_entry_value_const(params
, "path");
1310 if (value
&& !bt_value_is_string(value
)) {
1314 path_param
= bt_value_string_get(value
);
1315 value
= bt_value_map_borrow_entry_value_const(params
,
1316 "clock-class-offset-s");
1318 if (!bt_value_is_integer(value
)) {
1319 BT_LOGE("clock-class-offset-s should be an integer");
1322 ctf_fs
->metadata_config
.clock_class_offset_s
= bt_value_integer_get(value
);
1325 value
= bt_value_map_borrow_entry_value_const(params
,
1326 "clock-class-offset-ns");
1328 if (!bt_value_is_integer(value
)) {
1329 BT_LOGE("clock-class-offset-ns should be an integer");
1332 ctf_fs
->metadata_config
.clock_class_offset_ns
= bt_value_integer_get(value
);
1335 ctf_fs
->port_data
= g_ptr_array_new_with_free_func(port_data_destroy
);
1336 if (!ctf_fs
->port_data
) {
1340 ctf_fs
->traces
= g_ptr_array_new_with_free_func(
1341 ctf_fs_trace_destroy_notifier
);
1342 if (!ctf_fs
->traces
) {
1346 if (create_ctf_fs_traces(self_comp
, ctf_fs
, path_param
)) {
1353 ctf_fs_destroy(ctf_fs
);
1355 bt_self_component_set_data(
1356 bt_self_component_source_as_self_component(self_comp
),
1364 bt_self_component_status
ctf_fs_init(
1365 bt_self_component_source
*self_comp
,
1366 const bt_value
*params
, UNUSED_VAR
void *init_method_data
)
1368 struct ctf_fs_component
*ctf_fs
;
1369 bt_self_component_status ret
= BT_SELF_COMPONENT_STATUS_OK
;
1371 ctf_fs
= ctf_fs_create(self_comp
, params
);
1373 ret
= BT_SELF_COMPONENT_STATUS_ERROR
;
1380 bt_query_status
ctf_fs_query(
1381 bt_self_component_class_source
*comp_class
,
1382 const bt_query_executor
*query_exec
,
1383 const char *object
, const bt_value
*params
,
1384 const bt_value
**result
)
1386 bt_query_status status
= BT_QUERY_STATUS_OK
;
1388 if (!strcmp(object
, "metadata-info")) {
1389 status
= metadata_info_query(comp_class
, params
, result
);
1390 } else if (!strcmp(object
, "trace-info")) {
1391 status
= trace_info_query(comp_class
, params
, result
);
1393 BT_LOGE("Unknown query object `%s`", object
);
1394 status
= BT_QUERY_STATUS_INVALID_OBJECT
;