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_value
*metadata_info_query(struct bt_component_class
*comp_class
,
50 struct bt_value
*params
)
52 struct bt_value
*result
= NULL
;
53 struct bt_value
*path_value
= NULL
;
54 char *metadata_text
= NULL
;
55 FILE *metadata_fp
= NULL
;
56 GString
*g_metadata_text
= NULL
;
62 result
= bt_value_map_create();
67 if (!bt_value_is_map(params
)) {
68 BT_LOGE_STR("Query parameters is not a map value object.");
72 path_value
= bt_value_map_get(params
, "path");
73 ret
= bt_value_string_get(path_value
, &path
);
75 BT_LOGE_STR("Cannot get `path` string parameter.");
80 metadata_fp
= ctf_fs_metadata_open_file(path
);
82 BT_LOGE("Cannot open trace metadata: path=\"%s\".", path
);
86 is_packetized
= ctf_metadata_decoder_is_packetized(metadata_fp
,
90 ret
= ctf_metadata_decoder_packetized_file_stream_to_buf(
91 metadata_fp
, &metadata_text
, bo
);
93 BT_LOGE("Cannot decode packetized metadata file: path=\"%s\"",
100 ret
= fseek(metadata_fp
, 0, SEEK_END
);
102 BT_LOGE_ERRNO("Failed to seek to the end of the metadata file",
103 ": path=\"%s\"", path
);
106 filesize
= ftell(metadata_fp
);
108 BT_LOGE_ERRNO("Failed to get the current position in the metadata file",
109 ": path=\"%s\"", path
);
113 metadata_text
= malloc(filesize
+ 1);
114 if (!metadata_text
) {
115 BT_LOGE_STR("Cannot allocate buffer for metadata text.");
119 if (fread(metadata_text
, filesize
, 1, metadata_fp
) != 1) {
120 BT_LOGE_ERRNO("Cannot read metadata file", ": path=\"%s\"",
125 metadata_text
[filesize
] = '\0';
128 g_metadata_text
= g_string_new(NULL
);
129 if (!g_metadata_text
) {
133 if (strncmp(metadata_text
, METADATA_TEXT_SIG
,
134 sizeof(METADATA_TEXT_SIG
) - 1) != 0) {
135 g_string_assign(g_metadata_text
, METADATA_TEXT_SIG
);
136 g_string_append(g_metadata_text
, " */\n\n");
139 g_string_append(g_metadata_text
, metadata_text
);
141 ret
= bt_value_map_insert_string(result
, "text",
142 g_metadata_text
->str
);
144 BT_LOGE_STR("Cannot insert metadata text into query result.");
148 ret
= bt_value_map_insert_bool(result
, "is-packetized",
151 BT_LOGE_STR("Cannot insert \"is-packetized\" attribute into query result.");
164 if (g_metadata_text
) {
165 g_string_free(g_metadata_text
, TRUE
);
175 int add_range(struct bt_value
*info
, struct range
*range
,
176 const char *range_name
)
179 enum bt_value_status status
;
180 struct bt_value
*range_map
= NULL
;
187 range_map
= bt_value_map_create();
193 status
= bt_value_map_insert_integer(range_map
, "begin",
195 if (status
!= BT_VALUE_STATUS_OK
) {
200 status
= bt_value_map_insert_integer(range_map
, "end",
202 if (status
!= BT_VALUE_STATUS_OK
) {
207 status
= bt_value_map_insert(info
, range_name
, range_map
);
208 if (status
!= BT_VALUE_STATUS_OK
) {
218 int add_stream_ids(struct bt_value
*info
, struct bt_ctf_stream
*stream
)
221 int64_t stream_class_id
, stream_instance_id
;
222 enum bt_value_status status
;
223 struct bt_ctf_stream_class
*stream_class
= NULL
;
225 stream_instance_id
= bt_ctf_stream_get_id(stream
);
226 if (stream_instance_id
!= -1) {
227 status
= bt_value_map_insert_integer(info
, "id",
229 if (status
!= BT_VALUE_STATUS_OK
) {
235 stream_class
= bt_ctf_stream_get_class(stream
);
241 stream_class_id
= bt_ctf_stream_class_get_id(stream_class
);
242 if (stream_class_id
== -1) {
247 status
= bt_value_map_insert_integer(info
, "class-id", stream_class_id
);
248 if (status
!= BT_VALUE_STATUS_OK
) {
253 bt_put(stream_class
);
258 int populate_stream_info(struct ctf_fs_ds_file_group
*group
,
259 struct bt_value
*group_info
,
260 struct range
*stream_range
)
264 enum bt_value_status status
;
265 struct bt_value
*file_paths
;
267 stream_range
->begin_ns
= INT64_MAX
;
268 stream_range
->end_ns
= 0;
270 file_paths
= bt_value_array_create();
276 for (file_idx
= 0; file_idx
< group
->ds_file_infos
->len
; file_idx
++) {
277 int64_t file_begin_epoch
, file_end_epoch
;
278 struct ctf_fs_ds_file_info
*info
=
279 g_ptr_array_index(group
->ds_file_infos
,
282 if (!info
->index
|| info
->index
->entries
->len
== 0) {
283 BT_LOGW("Cannot determine range of unindexed stream file \'%s\'",
289 status
= bt_value_array_append_string(file_paths
,
291 if (status
!= BT_VALUE_STATUS_OK
) {
297 * file range is from timestamp_begin of the first entry to the
298 * timestamp_end of the last entry.
300 file_begin_epoch
= ((struct ctf_fs_ds_index_entry
*) &g_array_index(info
->index
->entries
,
301 struct ctf_fs_ds_index_entry
, 0))->timestamp_begin_ns
;
302 file_end_epoch
= ((struct ctf_fs_ds_index_entry
*) &g_array_index(info
->index
->entries
,
303 struct ctf_fs_ds_index_entry
, info
->index
->entries
->len
- 1))->timestamp_end_ns
;
305 stream_range
->begin_ns
= min(stream_range
->begin_ns
, file_begin_epoch
);
306 stream_range
->end_ns
= max(stream_range
->end_ns
, file_end_epoch
);
307 stream_range
->set
= true;
310 if (stream_range
->set
) {
311 ret
= add_range(group_info
, stream_range
, "range-ns");
317 status
= bt_value_map_insert(group_info
, "paths", file_paths
);
318 if (status
!= BT_VALUE_STATUS_OK
) {
323 ret
= add_stream_ids(group_info
, group
->stream
);
333 int populate_trace_info(const char *trace_path
, const char *trace_name
,
334 struct bt_value
*trace_info
)
338 struct ctf_fs_trace
*trace
= NULL
;
339 enum bt_value_status status
;
340 struct bt_value
*file_groups
;
341 struct range trace_range
= {
342 .begin_ns
= INT64_MAX
,
346 struct range trace_intersection
= {
352 file_groups
= bt_value_array_create();
357 status
= bt_value_map_insert_string(trace_info
, "name",
359 if (status
!= BT_VALUE_STATUS_OK
) {
363 status
= bt_value_map_insert_string(trace_info
, "path",
365 if (status
!= BT_VALUE_STATUS_OK
) {
370 trace
= ctf_fs_trace_create(trace_path
, trace_name
, NULL
);
372 BT_LOGE("Failed to create fs trace at \'%s\'", trace_path
);
377 assert(trace
->ds_file_groups
);
378 /* Add trace range info only if it contains streams. */
379 if (trace
->ds_file_groups
->len
== 0) {
384 /* Find range of all stream groups, and of the trace. */
385 for (group_idx
= 0; group_idx
< trace
->ds_file_groups
->len
;
387 struct bt_value
*group_info
;
388 struct range group_range
= { .set
= false };
389 struct ctf_fs_ds_file_group
*group
= g_ptr_array_index(
390 trace
->ds_file_groups
, group_idx
);
392 group_info
= bt_value_map_create();
398 ret
= populate_stream_info(group
, group_info
, &group_range
);
404 if (group_range
.set
) {
405 trace_range
.begin_ns
= min(trace_range
.begin_ns
,
406 group_range
.begin_ns
);
407 trace_range
.end_ns
= max(trace_range
.end_ns
,
409 trace_range
.set
= true;
411 trace_intersection
.begin_ns
= max(trace_intersection
.begin_ns
,
412 group_range
.begin_ns
);
413 trace_intersection
.end_ns
= min(trace_intersection
.end_ns
,
415 trace_intersection
.set
= true;
416 status
= bt_value_array_append(file_groups
, group_info
);
418 if (status
!= BT_VALUE_STATUS_OK
) {
424 ret
= add_range(trace_info
, &trace_range
, "range-ns");
428 ret
= add_range(trace_info
, &trace_intersection
,
429 "intersection-range-ns");
434 status
= bt_value_map_insert(trace_info
, "streams", file_groups
);
436 if (status
!= BT_VALUE_STATUS_OK
) {
443 ctf_fs_trace_destroy(trace
);
448 struct bt_value
*trace_info_query(struct bt_component_class
*comp_class
,
449 struct bt_value
*params
)
451 struct bt_value
*trace_infos
= NULL
;
452 struct bt_value
*path_value
= NULL
;
454 const char *path
= NULL
;
455 GList
*trace_paths
= NULL
;
456 GList
*trace_names
= NULL
;
457 GList
*tp_node
= NULL
;
458 GList
*tn_node
= NULL
;
459 GString
*normalized_path
= NULL
;
461 if (!bt_value_is_map(params
)) {
462 BT_LOGE("Query parameters is not a map value object.");
466 path_value
= bt_value_map_get(params
, "path");
467 ret
= bt_value_string_get(path_value
, &path
);
469 BT_LOGE("Cannot get `path` string parameter.");
473 normalized_path
= bt_common_normalize_path(path
, NULL
);
474 if (!normalized_path
) {
475 BT_LOGE("Failed to normalize path: `%s`.", path
);
480 ret
= ctf_fs_find_traces(&trace_paths
, normalized_path
->str
);
485 trace_names
= ctf_fs_create_trace_names(trace_paths
,
486 normalized_path
->str
);
488 BT_LOGE("Cannot create trace names from trace paths.");
492 trace_infos
= bt_value_array_create();
497 /* Iterates over both trace paths and names simultaneously. */
498 for (tp_node
= trace_paths
, tn_node
= trace_names
; tp_node
;
499 tp_node
= g_list_next(tp_node
),
500 tn_node
= g_list_next(tn_node
)) {
501 GString
*trace_path
= tp_node
->data
;
502 GString
*trace_name
= tn_node
->data
;
503 enum bt_value_status status
;
504 struct bt_value
*trace_info
;
506 trace_info
= bt_value_map_create();
508 BT_LOGE("Failed to create trace info map.");
512 ret
= populate_trace_info(trace_path
->str
, trace_name
->str
,
519 status
= bt_value_array_append(trace_infos
, trace_info
);
521 if (status
!= BT_VALUE_STATUS_OK
) {
531 if (normalized_path
) {
532 g_string_free(normalized_path
, TRUE
);
535 for (tp_node
= trace_paths
; tp_node
; tp_node
= g_list_next(tp_node
)) {
537 g_string_free(tp_node
->data
, TRUE
);
540 g_list_free(trace_paths
);
543 for (tn_node
= trace_names
; tn_node
; tn_node
= g_list_next(tn_node
)) {
545 g_string_free(tn_node
->data
, TRUE
);
548 g_list_free(trace_names
);
550 /* "path" becomes invalid with the release of path_value. */
This page took 0.039874 seconds and 4 git commands to generate.