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
29 #include <babeltrace/assert-internal.h>
31 #include "../common/metadata/decoder.h"
32 #include <babeltrace/common-internal.h>
33 #include <babeltrace/babeltrace-internal.h>
34 #include <babeltrace/babeltrace.h>
37 #define BT_LOG_TAG "PLUGIN-CTF-FS-QUERY-SRC"
40 #define METADATA_TEXT_SIG "/* CTF 1.8"
49 bt_query_status
metadata_info_query(
50 bt_self_component_class_source
*comp_class
,
51 const bt_value
*params
,
52 const bt_value
**user_result
)
54 bt_query_status status
= BT_QUERY_STATUS_OK
;
55 bt_value
*result
= NULL
;
56 const bt_value
*path_value
= NULL
;
57 char *metadata_text
= NULL
;
58 FILE *metadata_fp
= NULL
;
59 GString
*g_metadata_text
= NULL
;
65 result
= bt_value_map_create();
67 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 status
= BT_QUERY_STATUS_INVALID_PARAMS
;
79 path_value
= bt_value_map_borrow_entry_value_const(params
, "path");
80 path
= bt_value_string_get(path_value
);
83 metadata_fp
= ctf_fs_metadata_open_file(path
);
85 BT_LOGE("Cannot open trace metadata: path=\"%s\".", path
);
89 is_packetized
= ctf_metadata_decoder_is_packetized(metadata_fp
,
93 ret
= ctf_metadata_decoder_packetized_file_stream_to_buf(
94 metadata_fp
, &metadata_text
, bo
);
96 BT_LOGE("Cannot decode packetized metadata file: path=\"%s\"",
103 ret
= fseek(metadata_fp
, 0, SEEK_END
);
105 BT_LOGE_ERRNO("Failed to seek to the end of the metadata file",
106 ": path=\"%s\"", path
);
109 filesize
= ftell(metadata_fp
);
111 BT_LOGE_ERRNO("Failed to get the current position in the metadata file",
112 ": path=\"%s\"", path
);
116 metadata_text
= malloc(filesize
+ 1);
117 if (!metadata_text
) {
118 BT_LOGE_STR("Cannot allocate buffer for metadata text.");
122 if (fread(metadata_text
, filesize
, 1, metadata_fp
) != 1) {
123 BT_LOGE_ERRNO("Cannot read metadata file", ": path=\"%s\"",
128 metadata_text
[filesize
] = '\0';
131 g_metadata_text
= g_string_new(NULL
);
132 if (!g_metadata_text
) {
136 if (strncmp(metadata_text
, METADATA_TEXT_SIG
,
137 sizeof(METADATA_TEXT_SIG
) - 1) != 0) {
138 g_string_assign(g_metadata_text
, METADATA_TEXT_SIG
);
139 g_string_append(g_metadata_text
, " */\n\n");
142 g_string_append(g_metadata_text
, metadata_text
);
144 ret
= bt_value_map_insert_string_entry(result
, "text",
145 g_metadata_text
->str
);
147 BT_LOGE_STR("Cannot insert metadata text into query result.");
151 ret
= bt_value_map_insert_bool_entry(result
, "is-packetized",
154 BT_LOGE_STR("Cannot insert \"is-packetized\" attribute into query result.");
161 BT_VALUE_PUT_REF_AND_RESET(result
);
165 status
= BT_QUERY_STATUS_ERROR
;
171 if (g_metadata_text
) {
172 g_string_free(g_metadata_text
, TRUE
);
179 *user_result
= result
;
184 int add_range(bt_value
*info
, struct range
*range
,
185 const char *range_name
)
188 bt_value_status status
;
189 bt_value
*range_map
= NULL
;
196 range_map
= bt_value_map_create();
202 status
= bt_value_map_insert_integer_entry(range_map
, "begin",
204 if (status
!= BT_VALUE_STATUS_OK
) {
209 status
= bt_value_map_insert_integer_entry(range_map
, "end",
211 if (status
!= BT_VALUE_STATUS_OK
) {
216 status
= bt_value_map_insert_entry(info
, range_name
,
218 if (status
!= BT_VALUE_STATUS_OK
) {
224 bt_value_put_ref(range_map
);
229 int add_stream_ids(bt_value
*info
, struct ctf_fs_ds_file_group
*ds_file_group
)
232 bt_value_status status
;
234 if (ds_file_group
->stream_id
!= UINT64_C(-1)) {
235 status
= bt_value_map_insert_integer_entry(info
, "id",
236 (int64_t) ds_file_group
->stream_id
);
237 if (status
!= BT_VALUE_STATUS_OK
) {
243 status
= bt_value_map_insert_integer_entry(info
, "class-id",
244 (int64_t) ds_file_group
->sc
->id
);
245 if (status
!= BT_VALUE_STATUS_OK
) {
255 int populate_stream_info(struct ctf_fs_ds_file_group
*group
,
256 bt_value
*group_info
, struct range
*stream_range
)
260 bt_value_status status
;
261 bt_value
*file_paths
;
263 stream_range
->begin_ns
= INT64_MAX
;
264 stream_range
->end_ns
= 0;
266 file_paths
= bt_value_array_create();
272 for (file_idx
= 0; file_idx
< group
->ds_file_infos
->len
; file_idx
++) {
273 int64_t file_begin_epoch
, file_end_epoch
;
274 struct ctf_fs_ds_file_info
*info
=
275 g_ptr_array_index(group
->ds_file_infos
,
278 if (!info
->index
|| info
->index
->entries
->len
== 0) {
279 BT_LOGW("Cannot determine range of unindexed stream file \'%s\'",
285 status
= bt_value_array_append_string_element(file_paths
,
287 if (status
!= BT_VALUE_STATUS_OK
) {
293 * file range is from timestamp_begin of the first entry to the
294 * timestamp_end of the last entry.
296 file_begin_epoch
= ((struct ctf_fs_ds_index_entry
*) &g_array_index(info
->index
->entries
,
297 struct ctf_fs_ds_index_entry
, 0))->timestamp_begin_ns
;
298 file_end_epoch
= ((struct ctf_fs_ds_index_entry
*) &g_array_index(info
->index
->entries
,
299 struct ctf_fs_ds_index_entry
, info
->index
->entries
->len
- 1))->timestamp_end_ns
;
301 stream_range
->begin_ns
= min(stream_range
->begin_ns
, file_begin_epoch
);
302 stream_range
->end_ns
= max(stream_range
->end_ns
, file_end_epoch
);
303 stream_range
->set
= true;
306 if (stream_range
->set
) {
307 ret
= add_range(group_info
, stream_range
, "range-ns");
313 status
= bt_value_map_insert_entry(group_info
, "paths",
315 if (status
!= BT_VALUE_STATUS_OK
) {
320 ret
= add_stream_ids(group_info
, group
);
325 bt_value_put_ref(file_paths
);
330 int populate_trace_info(const char *trace_path
, const char *trace_name
,
331 bt_value
*trace_info
)
335 struct ctf_fs_trace
*trace
= NULL
;
336 bt_value_status status
;
337 bt_value
*file_groups
;
338 struct range trace_range
= {
339 .begin_ns
= INT64_MAX
,
343 struct range trace_intersection
= {
349 file_groups
= bt_value_array_create();
354 status
= bt_value_map_insert_string_entry(trace_info
, "name",
356 if (status
!= BT_VALUE_STATUS_OK
) {
360 status
= bt_value_map_insert_string_entry(trace_info
, "path",
362 if (status
!= BT_VALUE_STATUS_OK
) {
367 trace
= ctf_fs_trace_create(NULL
, trace_path
, trace_name
, NULL
);
369 BT_LOGE("Failed to create fs trace at \'%s\'", trace_path
);
374 BT_ASSERT(trace
->ds_file_groups
);
375 /* Add trace range info only if it contains streams. */
376 if (trace
->ds_file_groups
->len
== 0) {
381 /* Find range of all stream groups, and of the trace. */
382 for (group_idx
= 0; group_idx
< trace
->ds_file_groups
->len
;
384 bt_value
*group_info
;
385 struct range group_range
= { .set
= false };
386 struct ctf_fs_ds_file_group
*group
= g_ptr_array_index(
387 trace
->ds_file_groups
, group_idx
);
389 group_info
= bt_value_map_create();
395 ret
= populate_stream_info(group
, group_info
, &group_range
);
397 bt_value_put_ref(group_info
);
401 if (group_range
.set
) {
402 trace_range
.begin_ns
= min(trace_range
.begin_ns
,
403 group_range
.begin_ns
);
404 trace_range
.end_ns
= max(trace_range
.end_ns
,
406 trace_range
.set
= true;
408 trace_intersection
.begin_ns
= max(trace_intersection
.begin_ns
,
409 group_range
.begin_ns
);
410 trace_intersection
.end_ns
= min(trace_intersection
.end_ns
,
412 trace_intersection
.set
= true;
413 status
= bt_value_array_append_element(
416 bt_value_put_ref(group_info
);
417 if (status
!= BT_VALUE_STATUS_OK
) {
423 ret
= add_range(trace_info
, &trace_range
, "range-ns");
428 if (trace_intersection
.begin_ns
< trace_intersection
.end_ns
) {
429 ret
= add_range(trace_info
, &trace_intersection
,
430 "intersection-range-ns");
436 status
= bt_value_map_insert_entry(trace_info
, "streams",
438 BT_VALUE_PUT_REF_AND_RESET(file_groups
);
439 if (status
!= BT_VALUE_STATUS_OK
) {
445 bt_value_put_ref(file_groups
);
446 ctf_fs_trace_destroy(trace
);
451 bt_query_status
trace_info_query(
452 bt_self_component_class_source
*comp_class
,
453 const bt_value
*params
,
454 const bt_value
**user_result
)
456 bt_query_status status
= BT_QUERY_STATUS_OK
;
457 bt_value
*result
= NULL
;
458 const bt_value
*path_value
= NULL
;
460 const char *path
= NULL
;
461 GList
*trace_paths
= NULL
;
462 GList
*trace_names
= NULL
;
463 GList
*tp_node
= NULL
;
464 GList
*tn_node
= NULL
;
465 GString
*normalized_path
= NULL
;
469 if (!bt_value_is_map(params
)) {
470 BT_LOGE("Query parameters is not a map value object.");
471 status
= BT_QUERY_STATUS_INVALID_PARAMS
;
475 path_value
= bt_value_map_borrow_entry_value_const(params
, "path");
476 path
= bt_value_string_get(path_value
);
478 normalized_path
= bt_common_normalize_path(path
, NULL
);
479 if (!normalized_path
) {
480 BT_LOGE("Failed to normalize path: `%s`.", path
);
485 ret
= ctf_fs_find_traces(&trace_paths
, normalized_path
->str
);
490 trace_names
= ctf_fs_create_trace_names(trace_paths
,
491 normalized_path
->str
);
493 BT_LOGE("Cannot create trace names from trace paths.");
497 result
= bt_value_array_create();
499 status
= BT_QUERY_STATUS_NOMEM
;
503 /* Iterates over both trace paths and names simultaneously. */
504 for (tp_node
= trace_paths
, tn_node
= trace_names
; tp_node
;
505 tp_node
= g_list_next(tp_node
),
506 tn_node
= g_list_next(tn_node
)) {
507 GString
*trace_path
= tp_node
->data
;
508 GString
*trace_name
= tn_node
->data
;
509 bt_value_status status
;
510 bt_value
*trace_info
;
512 trace_info
= bt_value_map_create();
514 BT_LOGE("Failed to create trace info map.");
518 ret
= populate_trace_info(trace_path
->str
, trace_name
->str
,
521 bt_value_put_ref(trace_info
);
525 status
= bt_value_array_append_element(result
, trace_info
);
526 bt_value_put_ref(trace_info
);
527 if (status
!= BT_VALUE_STATUS_OK
) {
535 BT_VALUE_PUT_REF_AND_RESET(result
);
539 status
= BT_QUERY_STATUS_ERROR
;
543 if (normalized_path
) {
544 g_string_free(normalized_path
, TRUE
);
547 for (tp_node
= trace_paths
; tp_node
; tp_node
= g_list_next(tp_node
)) {
549 g_string_free(tp_node
->data
, TRUE
);
552 g_list_free(trace_paths
);
555 for (tn_node
= trace_names
; tn_node
; tn_node
= g_list_next(tn_node
)) {
557 g_string_free(tn_node
->data
, TRUE
);
560 g_list_free(trace_names
);
563 *user_result
= result
;