4 * Babeltrace CTF file system Reader Component queries
6 * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
31 #include "../common/metadata/decoder.h"
32 #include <babeltrace/common-internal.h>
33 #include <babeltrace/babeltrace-internal.h>
34 #include <babeltrace/ctf-ir/stream.h>
37 #define BT_LOG_TAG "PLUGIN-CTF-FS-QUERY-SRC"
40 #define METADATA_TEXT_SIG "/* CTF 1.8"
49 struct bt_component_class_query_method_return
metadata_info_query(
50 struct bt_component_class
*comp_class
,
51 struct bt_value
*params
)
53 struct bt_component_class_query_method_return query_ret
= {
55 .status
= BT_QUERY_STATUS_OK
,
58 struct bt_value
*path_value
= NULL
;
59 char *metadata_text
= NULL
;
60 FILE *metadata_fp
= NULL
;
61 GString
*g_metadata_text
= NULL
;
67 query_ret
.result
= bt_value_map_create();
68 if (!query_ret
.result
) {
69 query_ret
.status
= BT_QUERY_STATUS_NOMEM
;
73 if (!bt_value_is_map(params
)) {
74 BT_LOGE_STR("Query parameters is not a map value object.");
75 query_ret
.status
= BT_QUERY_STATUS_INVALID_PARAMS
;
79 path_value
= bt_value_map_get(params
, "path");
80 ret
= bt_value_string_get(path_value
, &path
);
82 BT_LOGE_STR("Cannot get `path` string parameter.");
83 query_ret
.status
= BT_QUERY_STATUS_INVALID_PARAMS
;
88 metadata_fp
= ctf_fs_metadata_open_file(path
);
90 BT_LOGE("Cannot open trace metadata: path=\"%s\".", path
);
94 is_packetized
= ctf_metadata_decoder_is_packetized(metadata_fp
,
98 ret
= ctf_metadata_decoder_packetized_file_stream_to_buf(
99 metadata_fp
, &metadata_text
, bo
);
101 BT_LOGE("Cannot decode packetized metadata file: path=\"%s\"",
108 ret
= fseek(metadata_fp
, 0, SEEK_END
);
110 BT_LOGE_ERRNO("Failed to seek to the end of the metadata file",
111 ": path=\"%s\"", path
);
114 filesize
= ftell(metadata_fp
);
116 BT_LOGE_ERRNO("Failed to get the current position in the metadata file",
117 ": path=\"%s\"", path
);
121 metadata_text
= malloc(filesize
+ 1);
122 if (!metadata_text
) {
123 BT_LOGE_STR("Cannot allocate buffer for metadata text.");
127 if (fread(metadata_text
, filesize
, 1, metadata_fp
) != 1) {
128 BT_LOGE_ERRNO("Cannot read metadata file", ": path=\"%s\"",
133 metadata_text
[filesize
] = '\0';
136 g_metadata_text
= g_string_new(NULL
);
137 if (!g_metadata_text
) {
141 if (strncmp(metadata_text
, METADATA_TEXT_SIG
,
142 sizeof(METADATA_TEXT_SIG
) - 1) != 0) {
143 g_string_assign(g_metadata_text
, METADATA_TEXT_SIG
);
144 g_string_append(g_metadata_text
, " */\n\n");
147 g_string_append(g_metadata_text
, metadata_text
);
149 ret
= bt_value_map_insert_string(query_ret
.result
, "text",
150 g_metadata_text
->str
);
152 BT_LOGE_STR("Cannot insert metadata text into query result.");
156 ret
= bt_value_map_insert_bool(query_ret
.result
, "is-packetized",
159 BT_LOGE_STR("Cannot insert \"is-packetized\" attribute into query result.");
166 BT_PUT(query_ret
.result
);
168 if (query_ret
.status
>= 0) {
169 query_ret
.status
= BT_QUERY_STATUS_ERROR
;
176 if (g_metadata_text
) {
177 g_string_free(g_metadata_text
, TRUE
);
188 int add_range(struct bt_value
*info
, struct range
*range
,
189 const char *range_name
)
192 enum bt_value_status status
;
193 struct bt_value
*range_map
= NULL
;
200 range_map
= bt_value_map_create();
206 status
= bt_value_map_insert_integer(range_map
, "begin",
208 if (status
!= BT_VALUE_STATUS_OK
) {
213 status
= bt_value_map_insert_integer(range_map
, "end",
215 if (status
!= BT_VALUE_STATUS_OK
) {
220 status
= bt_value_map_insert(info
, range_name
, range_map
);
221 if (status
!= BT_VALUE_STATUS_OK
) {
231 int add_stream_ids(struct bt_value
*info
, struct bt_ctf_stream
*stream
)
234 int64_t stream_class_id
, stream_instance_id
;
235 enum bt_value_status status
;
236 struct bt_ctf_stream_class
*stream_class
= NULL
;
238 stream_instance_id
= bt_ctf_stream_get_id(stream
);
239 if (stream_instance_id
!= -1) {
240 status
= bt_value_map_insert_integer(info
, "id",
242 if (status
!= BT_VALUE_STATUS_OK
) {
248 stream_class
= bt_ctf_stream_get_class(stream
);
254 stream_class_id
= bt_ctf_stream_class_get_id(stream_class
);
255 if (stream_class_id
== -1) {
260 status
= bt_value_map_insert_integer(info
, "class-id", stream_class_id
);
261 if (status
!= BT_VALUE_STATUS_OK
) {
266 bt_put(stream_class
);
271 int populate_stream_info(struct ctf_fs_ds_file_group
*group
,
272 struct bt_value
*group_info
,
273 struct range
*stream_range
)
277 enum bt_value_status status
;
278 struct bt_value
*file_paths
;
280 stream_range
->begin_ns
= INT64_MAX
;
281 stream_range
->end_ns
= 0;
283 file_paths
= bt_value_array_create();
289 for (file_idx
= 0; file_idx
< group
->ds_file_infos
->len
; file_idx
++) {
290 int64_t file_begin_epoch
, file_end_epoch
;
291 struct ctf_fs_ds_file_info
*info
=
292 g_ptr_array_index(group
->ds_file_infos
,
295 if (!info
->index
|| info
->index
->entries
->len
== 0) {
296 BT_LOGW("Cannot determine range of unindexed stream file \'%s\'",
302 status
= bt_value_array_append_string(file_paths
,
304 if (status
!= BT_VALUE_STATUS_OK
) {
310 * file range is from timestamp_begin of the first entry to the
311 * timestamp_end of the last entry.
313 file_begin_epoch
= ((struct ctf_fs_ds_index_entry
*) &g_array_index(info
->index
->entries
,
314 struct ctf_fs_ds_index_entry
, 0))->timestamp_begin_ns
;
315 file_end_epoch
= ((struct ctf_fs_ds_index_entry
*) &g_array_index(info
->index
->entries
,
316 struct ctf_fs_ds_index_entry
, info
->index
->entries
->len
- 1))->timestamp_end_ns
;
318 stream_range
->begin_ns
= min(stream_range
->begin_ns
, file_begin_epoch
);
319 stream_range
->end_ns
= max(stream_range
->end_ns
, file_end_epoch
);
320 stream_range
->set
= true;
323 if (stream_range
->set
) {
324 ret
= add_range(group_info
, stream_range
, "range-ns");
330 status
= bt_value_map_insert(group_info
, "paths", file_paths
);
331 if (status
!= BT_VALUE_STATUS_OK
) {
336 ret
= add_stream_ids(group_info
, group
->stream
);
346 int populate_trace_info(const char *trace_path
, const char *trace_name
,
347 struct bt_value
*trace_info
)
351 struct ctf_fs_trace
*trace
= NULL
;
352 enum bt_value_status status
;
353 struct bt_value
*file_groups
;
354 struct range trace_range
= {
355 .begin_ns
= INT64_MAX
,
359 struct range trace_intersection
= {
365 file_groups
= bt_value_array_create();
370 status
= bt_value_map_insert_string(trace_info
, "name",
372 if (status
!= BT_VALUE_STATUS_OK
) {
376 status
= bt_value_map_insert_string(trace_info
, "path",
378 if (status
!= BT_VALUE_STATUS_OK
) {
383 trace
= ctf_fs_trace_create(trace_path
, trace_name
, NULL
);
385 BT_LOGE("Failed to create fs trace at \'%s\'", trace_path
);
390 assert(trace
->ds_file_groups
);
391 /* Add trace range info only if it contains streams. */
392 if (trace
->ds_file_groups
->len
== 0) {
397 /* Find range of all stream groups, and of the trace. */
398 for (group_idx
= 0; group_idx
< trace
->ds_file_groups
->len
;
400 struct bt_value
*group_info
;
401 struct range group_range
= { .set
= false };
402 struct ctf_fs_ds_file_group
*group
= g_ptr_array_index(
403 trace
->ds_file_groups
, group_idx
);
405 group_info
= bt_value_map_create();
411 ret
= populate_stream_info(group
, group_info
, &group_range
);
417 if (group_range
.set
) {
418 trace_range
.begin_ns
= min(trace_range
.begin_ns
,
419 group_range
.begin_ns
);
420 trace_range
.end_ns
= max(trace_range
.end_ns
,
422 trace_range
.set
= true;
424 trace_intersection
.begin_ns
= max(trace_intersection
.begin_ns
,
425 group_range
.begin_ns
);
426 trace_intersection
.end_ns
= min(trace_intersection
.end_ns
,
428 trace_intersection
.set
= true;
429 status
= bt_value_array_append(file_groups
, group_info
);
431 if (status
!= BT_VALUE_STATUS_OK
) {
437 ret
= add_range(trace_info
, &trace_range
, "range-ns");
441 ret
= add_range(trace_info
, &trace_intersection
,
442 "intersection-range-ns");
447 status
= bt_value_map_insert(trace_info
, "streams", file_groups
);
449 if (status
!= BT_VALUE_STATUS_OK
) {
456 ctf_fs_trace_destroy(trace
);
461 struct bt_component_class_query_method_return
trace_info_query(
462 struct bt_component_class
*comp_class
,
463 struct bt_value
*params
)
465 struct bt_component_class_query_method_return query_ret
= {
467 .status
= BT_QUERY_STATUS_OK
,
470 struct bt_value
*path_value
= NULL
;
472 const char *path
= NULL
;
473 GList
*trace_paths
= NULL
;
474 GList
*trace_names
= NULL
;
475 GList
*tp_node
= NULL
;
476 GList
*tn_node
= NULL
;
477 GString
*normalized_path
= NULL
;
479 if (!bt_value_is_map(params
)) {
480 BT_LOGE("Query parameters is not a map value object.");
481 query_ret
.status
= BT_QUERY_STATUS_INVALID_PARAMS
;
485 path_value
= bt_value_map_get(params
, "path");
486 ret
= bt_value_string_get(path_value
, &path
);
488 BT_LOGE("Cannot get `path` string parameter.");
489 query_ret
.status
= BT_QUERY_STATUS_INVALID_PARAMS
;
493 normalized_path
= bt_common_normalize_path(path
, NULL
);
494 if (!normalized_path
) {
495 BT_LOGE("Failed to normalize path: `%s`.", path
);
500 ret
= ctf_fs_find_traces(&trace_paths
, normalized_path
->str
);
505 trace_names
= ctf_fs_create_trace_names(trace_paths
,
506 normalized_path
->str
);
508 BT_LOGE("Cannot create trace names from trace paths.");
512 query_ret
.result
= bt_value_array_create();
513 if (!query_ret
.result
) {
514 query_ret
.status
= BT_QUERY_STATUS_NOMEM
;
518 /* Iterates over both trace paths and names simultaneously. */
519 for (tp_node
= trace_paths
, tn_node
= trace_names
; tp_node
;
520 tp_node
= g_list_next(tp_node
),
521 tn_node
= g_list_next(tn_node
)) {
522 GString
*trace_path
= tp_node
->data
;
523 GString
*trace_name
= tn_node
->data
;
524 enum bt_value_status status
;
525 struct bt_value
*trace_info
;
527 trace_info
= bt_value_map_create();
529 BT_LOGE("Failed to create trace info map.");
533 ret
= populate_trace_info(trace_path
->str
, trace_name
->str
,
540 status
= bt_value_array_append(query_ret
.result
, trace_info
);
542 if (status
!= BT_VALUE_STATUS_OK
) {
550 BT_PUT(query_ret
.result
);
552 if (query_ret
.status
>= 0) {
553 query_ret
.status
= BT_QUERY_STATUS_ERROR
;
557 if (normalized_path
) {
558 g_string_free(normalized_path
, TRUE
);
561 for (tp_node
= trace_paths
; tp_node
; tp_node
= g_list_next(tp_node
)) {
563 g_string_free(tp_node
->data
, TRUE
);
566 g_list_free(trace_paths
);
569 for (tn_node
= trace_names
; tn_node
; tn_node
= g_list_next(tn_node
)) {
571 g_string_free(tn_node
->data
, TRUE
);
574 g_list_free(trace_names
);
576 /* "path" becomes invalid with the release of path_value. */