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
27 #define BT_LOG_OUTPUT_LEVEL log_level
28 #define BT_LOG_TAG "PLUGIN/SRC.CTF.FS/QUERY"
29 #include "logging/log.h"
33 #include "common/assert.h"
35 #include "../common/metadata/decoder.h"
36 #include "common/common.h"
37 #include "common/macros.h"
38 #include <babeltrace2/babeltrace.h>
41 #define METADATA_TEXT_SIG "/* CTF 1.8"
50 bt_query_status
metadata_info_query(
51 bt_self_component_class_source
*comp_class
,
52 const bt_value
*params
, bt_logging_level log_level
,
53 const bt_value
**user_result
)
55 bt_query_status status
= BT_QUERY_STATUS_OK
;
56 bt_value
*result
= NULL
;
57 const bt_value
*path_value
= NULL
;
58 char *metadata_text
= NULL
;
59 FILE *metadata_fp
= NULL
;
60 GString
*g_metadata_text
= NULL
;
66 result
= bt_value_map_create();
68 status
= BT_QUERY_STATUS_NOMEM
;
74 if (!bt_value_is_map(params
)) {
75 BT_LOGE_STR("Query parameters is not a map value object.");
76 status
= BT_QUERY_STATUS_INVALID_PARAMS
;
80 path_value
= bt_value_map_borrow_entry_value_const(params
, "path");
82 BT_LOGE_STR("Mandatory `path` parameter missing");
83 status
= BT_QUERY_STATUS_INVALID_PARAMS
;
87 if (!bt_value_is_string(path_value
)) {
88 BT_LOGE_STR("`path` parameter is required to be a string value");
89 status
= BT_QUERY_STATUS_INVALID_PARAMS
;
93 path
= bt_value_string_get(path_value
);
96 metadata_fp
= ctf_fs_metadata_open_file(path
);
98 BT_LOGE("Cannot open trace metadata: path=\"%s\".", path
);
102 is_packetized
= ctf_metadata_decoder_is_packetized(metadata_fp
,
103 &bo
, log_level
, NULL
);
106 ret
= ctf_metadata_decoder_packetized_file_stream_to_buf(
107 metadata_fp
, &metadata_text
, bo
, log_level
, NULL
);
109 BT_LOGE("Cannot decode packetized metadata file: path=\"%s\"",
116 ret
= fseek(metadata_fp
, 0, SEEK_END
);
118 BT_LOGE_ERRNO("Failed to seek to the end of the metadata file",
119 ": path=\"%s\"", path
);
122 filesize
= ftell(metadata_fp
);
124 BT_LOGE_ERRNO("Failed to get the current position in the metadata file",
125 ": path=\"%s\"", path
);
129 metadata_text
= malloc(filesize
+ 1);
130 if (!metadata_text
) {
131 BT_LOGE_STR("Cannot allocate buffer for metadata text.");
135 if (fread(metadata_text
, filesize
, 1, metadata_fp
) != 1) {
136 BT_LOGE_ERRNO("Cannot read metadata file", ": path=\"%s\"",
141 metadata_text
[filesize
] = '\0';
144 g_metadata_text
= g_string_new(NULL
);
145 if (!g_metadata_text
) {
149 if (strncmp(metadata_text
, METADATA_TEXT_SIG
,
150 sizeof(METADATA_TEXT_SIG
) - 1) != 0) {
151 g_string_assign(g_metadata_text
, METADATA_TEXT_SIG
);
152 g_string_append(g_metadata_text
, " */\n\n");
155 g_string_append(g_metadata_text
, metadata_text
);
157 ret
= bt_value_map_insert_string_entry(result
, "text",
158 g_metadata_text
->str
);
160 BT_LOGE_STR("Cannot insert metadata text into query result.");
164 ret
= bt_value_map_insert_bool_entry(result
, "is-packetized",
167 BT_LOGE_STR("Cannot insert \"is-packetized\" attribute into query result.");
174 BT_VALUE_PUT_REF_AND_RESET(result
);
178 status
= BT_QUERY_STATUS_ERROR
;
184 if (g_metadata_text
) {
185 g_string_free(g_metadata_text
, TRUE
);
192 *user_result
= result
;
197 int add_range(bt_value
*info
, struct range
*range
,
198 const char *range_name
)
201 bt_value_status status
;
202 bt_value
*range_map
= NULL
;
209 range_map
= bt_value_map_create();
215 status
= bt_value_map_insert_signed_integer_entry(range_map
, "begin",
217 if (status
!= BT_VALUE_STATUS_OK
) {
222 status
= bt_value_map_insert_signed_integer_entry(range_map
, "end",
224 if (status
!= BT_VALUE_STATUS_OK
) {
229 status
= bt_value_map_insert_entry(info
, range_name
,
231 if (status
!= BT_VALUE_STATUS_OK
) {
237 bt_value_put_ref(range_map
);
242 int add_stream_ids(bt_value
*info
, struct ctf_fs_ds_file_group
*ds_file_group
)
245 bt_value_status status
;
247 if (ds_file_group
->stream_id
!= UINT64_C(-1)) {
248 status
= bt_value_map_insert_unsigned_integer_entry(info
, "id",
249 ds_file_group
->stream_id
);
250 if (status
!= BT_VALUE_STATUS_OK
) {
256 status
= bt_value_map_insert_unsigned_integer_entry(info
, "class-id",
257 ds_file_group
->sc
->id
);
258 if (status
!= BT_VALUE_STATUS_OK
) {
268 int populate_stream_info(struct ctf_fs_ds_file_group
*group
,
269 bt_value
*group_info
, struct range
*stream_range
)
273 bt_value_status status
;
274 bt_value
*file_paths
;
275 struct ctf_fs_ds_index_entry
*first_ds_index_entry
, *last_ds_index_entry
;
276 gchar
*port_name
= NULL
;
278 file_paths
= bt_value_array_create();
284 for (file_idx
= 0; file_idx
< group
->ds_file_infos
->len
; file_idx
++) {
285 struct ctf_fs_ds_file_info
*info
=
286 g_ptr_array_index(group
->ds_file_infos
,
289 status
= bt_value_array_append_string_element(file_paths
,
291 if (status
!= BT_VALUE_STATUS_OK
) {
298 * Since each `struct ctf_fs_ds_file_group` has a sorted array of
299 * `struct ctf_fs_ds_index_entry`, we can compute the stream range from
300 * the timestamp_begin of the first index entry and the timestamp_end
301 * of the last index entry.
303 BT_ASSERT(group
->index
);
304 BT_ASSERT(group
->index
->entries
);
305 BT_ASSERT(group
->index
->entries
->len
> 0);
308 first_ds_index_entry
= (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(
309 group
->index
->entries
, 0);
312 last_ds_index_entry
= (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(
313 group
->index
->entries
, group
->index
->entries
->len
- 1);
315 stream_range
->begin_ns
= first_ds_index_entry
->timestamp_begin_ns
;
316 stream_range
->end_ns
= last_ds_index_entry
->timestamp_end_ns
;
319 * If any of the begin and end timestamps is not set it means that
320 * packets don't include `timestamp_begin` _and_ `timestamp_end` fields
321 * in their packet context so we can't set the range.
323 stream_range
->set
= stream_range
->begin_ns
!= UINT64_C(-1) &&
324 stream_range
->end_ns
!= UINT64_C(-1);
326 ret
= add_range(group_info
, stream_range
, "range-ns");
331 status
= bt_value_map_insert_entry(group_info
, "paths",
333 if (status
!= BT_VALUE_STATUS_OK
) {
338 ret
= add_stream_ids(group_info
, group
);
343 port_name
= ctf_fs_make_port_name(group
);
349 status
= bt_value_map_insert_string_entry(group_info
, "port-name",
351 if (status
!= BT_VALUE_STATUS_OK
) {
357 bt_value_put_ref(file_paths
);
362 int populate_trace_info(const struct ctf_fs_trace
*trace
, bt_value
*trace_info
)
366 bt_value_status status
;
367 bt_value
*file_groups
= NULL
;
368 struct range trace_range
= {
369 .begin_ns
= INT64_MAX
,
373 struct range trace_intersection
= {
379 BT_ASSERT(trace
->ds_file_groups
);
380 /* Add trace range info only if it contains streams. */
381 if (trace
->ds_file_groups
->len
== 0) {
386 file_groups
= bt_value_array_create();
391 status
= bt_value_map_insert_string_entry(trace_info
, "name",
393 if (status
!= BT_VALUE_STATUS_OK
) {
397 status
= bt_value_map_insert_string_entry(trace_info
, "path",
399 if (status
!= BT_VALUE_STATUS_OK
) {
404 /* Find range of all stream groups, and of the trace. */
405 for (group_idx
= 0; group_idx
< trace
->ds_file_groups
->len
;
407 bt_value
*group_info
;
408 struct range group_range
= { .set
= false };
409 struct ctf_fs_ds_file_group
*group
= g_ptr_array_index(
410 trace
->ds_file_groups
, group_idx
);
412 group_info
= bt_value_map_create();
418 ret
= populate_stream_info(group
, group_info
, &group_range
);
420 bt_value_put_ref(group_info
);
424 status
= bt_value_array_append_element(file_groups
, group_info
);
425 bt_value_put_ref(group_info
);
426 if (status
!= BT_VALUE_STATUS_OK
) {
430 if (group_range
.set
) {
431 trace_range
.begin_ns
= MIN(trace_range
.begin_ns
,
432 group_range
.begin_ns
);
433 trace_range
.end_ns
= MAX(trace_range
.end_ns
,
435 trace_range
.set
= true;
437 trace_intersection
.begin_ns
= MAX(trace_intersection
.begin_ns
,
438 group_range
.begin_ns
);
439 trace_intersection
.end_ns
= MIN(trace_intersection
.end_ns
,
441 trace_intersection
.set
= true;
445 ret
= add_range(trace_info
, &trace_range
, "range-ns");
450 if (trace_intersection
.begin_ns
< trace_intersection
.end_ns
) {
451 ret
= add_range(trace_info
, &trace_intersection
,
452 "intersection-range-ns");
458 status
= bt_value_map_insert_entry(trace_info
, "streams",
460 BT_VALUE_PUT_REF_AND_RESET(file_groups
);
461 if (status
!= BT_VALUE_STATUS_OK
) {
467 bt_value_put_ref(file_groups
);
472 bt_query_status
trace_info_query(
473 bt_self_component_class_source
*comp_class
,
474 const bt_value
*params
, bt_logging_level log_level
,
475 const bt_value
**user_result
)
477 struct ctf_fs_component
*ctf_fs
= NULL
;
478 bt_query_status status
= BT_QUERY_STATUS_OK
;
479 bt_value
*result
= NULL
;
480 const bt_value
*paths_value
= NULL
;
486 if (!bt_value_is_map(params
)) {
487 BT_LOGE("Query parameters is not a map value object.");
488 status
= BT_QUERY_STATUS_INVALID_PARAMS
;
492 ctf_fs
= ctf_fs_component_create(log_level
, NULL
);
497 if (!read_src_fs_parameters(params
, &paths_value
, ctf_fs
)) {
498 status
= BT_QUERY_STATUS_INVALID_PARAMS
;
502 if (ctf_fs_component_create_ctf_fs_traces(NULL
, ctf_fs
, paths_value
)) {
506 result
= bt_value_array_create();
508 status
= BT_QUERY_STATUS_NOMEM
;
512 for (i
= 0; i
< ctf_fs
->traces
->len
; i
++) {
513 struct ctf_fs_trace
*trace
;
514 bt_value
*trace_info
;
515 bt_value_status status
;
517 trace
= g_ptr_array_index(ctf_fs
->traces
, i
);
520 trace_info
= bt_value_map_create();
522 BT_LOGE("Failed to create trace info map.");
526 ret
= populate_trace_info(trace
, trace_info
);
528 bt_value_put_ref(trace_info
);
532 status
= bt_value_array_append_element(result
, trace_info
);
533 bt_value_put_ref(trace_info
);
534 if (status
!= BT_VALUE_STATUS_OK
) {
542 BT_VALUE_PUT_REF_AND_RESET(result
);
546 status
= BT_QUERY_STATUS_ERROR
;
551 ctf_fs_destroy(ctf_fs
);
555 *user_result
= result
;