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 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_private_value
*result
= NULL
;
59 struct bt_value
*path_value
= NULL
;
60 char *metadata_text
= NULL
;
61 FILE *metadata_fp
= NULL
;
62 GString
*g_metadata_text
= NULL
;
68 result
= bt_private_value_map_create();
70 query_ret
.status
= BT_QUERY_STATUS_NOMEM
;
74 query_ret
.result
= bt_value_borrow_from_private(result
);
77 if (!bt_value_is_map(params
)) {
78 BT_LOGE_STR("Query parameters is not a map value object.");
79 query_ret
.status
= BT_QUERY_STATUS_INVALID_PARAMS
;
83 path_value
= bt_value_map_borrow_entry_value(params
, "path");
84 ret
= bt_value_string_get(path_value
, &path
);
86 BT_LOGE_STR("Cannot get `path` string parameter.");
87 query_ret
.status
= BT_QUERY_STATUS_INVALID_PARAMS
;
92 metadata_fp
= ctf_fs_metadata_open_file(path
);
94 BT_LOGE("Cannot open trace metadata: path=\"%s\".", path
);
98 is_packetized
= ctf_metadata_decoder_is_packetized(metadata_fp
,
102 ret
= ctf_metadata_decoder_packetized_file_stream_to_buf(
103 metadata_fp
, &metadata_text
, bo
);
105 BT_LOGE("Cannot decode packetized metadata file: path=\"%s\"",
112 ret
= fseek(metadata_fp
, 0, SEEK_END
);
114 BT_LOGE_ERRNO("Failed to seek to the end of the metadata file",
115 ": path=\"%s\"", path
);
118 filesize
= ftell(metadata_fp
);
120 BT_LOGE_ERRNO("Failed to get the current position in the metadata file",
121 ": path=\"%s\"", path
);
125 metadata_text
= malloc(filesize
+ 1);
126 if (!metadata_text
) {
127 BT_LOGE_STR("Cannot allocate buffer for metadata text.");
131 if (fread(metadata_text
, filesize
, 1, metadata_fp
) != 1) {
132 BT_LOGE_ERRNO("Cannot read metadata file", ": path=\"%s\"",
137 metadata_text
[filesize
] = '\0';
140 g_metadata_text
= g_string_new(NULL
);
141 if (!g_metadata_text
) {
145 if (strncmp(metadata_text
, METADATA_TEXT_SIG
,
146 sizeof(METADATA_TEXT_SIG
) - 1) != 0) {
147 g_string_assign(g_metadata_text
, METADATA_TEXT_SIG
);
148 g_string_append(g_metadata_text
, " */\n\n");
151 g_string_append(g_metadata_text
, metadata_text
);
153 ret
= bt_private_value_map_insert_string_entry(result
, "text",
154 g_metadata_text
->str
);
156 BT_LOGE_STR("Cannot insert metadata text into query result.");
160 ret
= bt_private_value_map_insert_bool_entry(result
, "is-packetized",
163 BT_LOGE_STR("Cannot insert \"is-packetized\" attribute into query result.");
170 BT_OBJECT_PUT_REF_AND_RESET(result
);
171 query_ret
.result
= NULL
;
173 if (query_ret
.status
>= 0) {
174 query_ret
.status
= BT_QUERY_STATUS_ERROR
;
180 if (g_metadata_text
) {
181 g_string_free(g_metadata_text
, TRUE
);
192 int add_range(struct bt_private_value
*info
, struct range
*range
,
193 const char *range_name
)
196 enum bt_value_status status
;
197 struct bt_private_value
*range_map
= NULL
;
204 range_map
= bt_private_value_map_create();
210 status
= bt_private_value_map_insert_integer_entry(range_map
, "begin",
212 if (status
!= BT_VALUE_STATUS_OK
) {
217 status
= bt_private_value_map_insert_integer_entry(range_map
, "end",
219 if (status
!= BT_VALUE_STATUS_OK
) {
224 status
= bt_private_value_map_insert_entry(info
, range_name
,
225 bt_value_borrow_from_private(range_map
));
226 if (status
!= BT_VALUE_STATUS_OK
) {
232 bt_object_put_ref(range_map
);
237 int add_stream_ids(struct bt_private_value
*info
, struct bt_stream
*stream
)
240 int64_t stream_class_id
, stream_instance_id
;
241 enum bt_value_status status
;
242 struct bt_stream_class
*stream_class
= NULL
;
244 stream_instance_id
= bt_stream_get_id(stream
);
245 if (stream_instance_id
!= -1) {
246 status
= bt_private_value_map_insert_integer_entry(info
, "id",
248 if (status
!= BT_VALUE_STATUS_OK
) {
254 stream_class
= bt_stream_borrow_class(stream
);
260 stream_class_id
= bt_stream_class_get_id(stream_class
);
261 if (stream_class_id
== -1) {
266 status
= bt_private_value_map_insert_integer_entry(info
, "class-id", stream_class_id
);
267 if (status
!= BT_VALUE_STATUS_OK
) {
277 int populate_stream_info(struct ctf_fs_ds_file_group
*group
,
278 struct bt_private_value
*group_info
,
279 struct range
*stream_range
)
283 enum bt_value_status status
;
284 struct bt_private_value
*file_paths
;
286 stream_range
->begin_ns
= INT64_MAX
;
287 stream_range
->end_ns
= 0;
289 file_paths
= bt_private_value_array_create();
295 for (file_idx
= 0; file_idx
< group
->ds_file_infos
->len
; file_idx
++) {
296 int64_t file_begin_epoch
, file_end_epoch
;
297 struct ctf_fs_ds_file_info
*info
=
298 g_ptr_array_index(group
->ds_file_infos
,
301 if (!info
->index
|| info
->index
->entries
->len
== 0) {
302 BT_LOGW("Cannot determine range of unindexed stream file \'%s\'",
308 status
= bt_private_value_array_append_string_element(file_paths
,
310 if (status
!= BT_VALUE_STATUS_OK
) {
316 * file range is from timestamp_begin of the first entry to the
317 * timestamp_end of the last entry.
319 file_begin_epoch
= ((struct ctf_fs_ds_index_entry
*) &g_array_index(info
->index
->entries
,
320 struct ctf_fs_ds_index_entry
, 0))->timestamp_begin_ns
;
321 file_end_epoch
= ((struct ctf_fs_ds_index_entry
*) &g_array_index(info
->index
->entries
,
322 struct ctf_fs_ds_index_entry
, info
->index
->entries
->len
- 1))->timestamp_end_ns
;
324 stream_range
->begin_ns
= min(stream_range
->begin_ns
, file_begin_epoch
);
325 stream_range
->end_ns
= max(stream_range
->end_ns
, file_end_epoch
);
326 stream_range
->set
= true;
329 if (stream_range
->set
) {
330 ret
= add_range(group_info
, stream_range
, "range-ns");
336 status
= bt_private_value_map_insert_entry(group_info
, "paths",
337 bt_value_borrow_from_private(file_paths
));
338 if (status
!= BT_VALUE_STATUS_OK
) {
343 ret
= add_stream_ids(group_info
, group
->stream
);
348 bt_object_put_ref(file_paths
);
353 int populate_trace_info(const char *trace_path
, const char *trace_name
,
354 struct bt_private_value
*trace_info
)
358 struct ctf_fs_trace
*trace
= NULL
;
359 enum bt_value_status status
;
360 struct bt_private_value
*file_groups
;
361 struct range trace_range
= {
362 .begin_ns
= INT64_MAX
,
366 struct range trace_intersection
= {
372 file_groups
= bt_private_value_array_create();
377 status
= bt_private_value_map_insert_string_entry(trace_info
, "name",
379 if (status
!= BT_VALUE_STATUS_OK
) {
383 status
= bt_private_value_map_insert_string_entry(trace_info
, "path",
385 if (status
!= BT_VALUE_STATUS_OK
) {
390 trace
= ctf_fs_trace_create(trace_path
, trace_name
, NULL
, NULL
);
392 BT_LOGE("Failed to create fs trace at \'%s\'", trace_path
);
397 BT_ASSERT(trace
->ds_file_groups
);
398 /* Add trace range info only if it contains streams. */
399 if (trace
->ds_file_groups
->len
== 0) {
404 /* Find range of all stream groups, and of the trace. */
405 for (group_idx
= 0; group_idx
< trace
->ds_file_groups
->len
;
407 struct bt_private_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_private_value_map_create();
418 ret
= populate_stream_info(group
, group_info
, &group_range
);
420 bt_object_put_ref(group_info
);
424 if (group_range
.set
) {
425 trace_range
.begin_ns
= min(trace_range
.begin_ns
,
426 group_range
.begin_ns
);
427 trace_range
.end_ns
= max(trace_range
.end_ns
,
429 trace_range
.set
= true;
431 trace_intersection
.begin_ns
= max(trace_intersection
.begin_ns
,
432 group_range
.begin_ns
);
433 trace_intersection
.end_ns
= min(trace_intersection
.end_ns
,
435 trace_intersection
.set
= true;
436 status
= bt_private_value_array_append_element(
438 bt_value_borrow_from_private(group_info
));
439 bt_object_put_ref(group_info
);
440 if (status
!= BT_VALUE_STATUS_OK
) {
446 ret
= add_range(trace_info
, &trace_range
, "range-ns");
451 if (trace_intersection
.begin_ns
< trace_intersection
.end_ns
) {
452 ret
= add_range(trace_info
, &trace_intersection
,
453 "intersection-range-ns");
459 status
= bt_private_value_map_insert_entry(trace_info
, "streams",
460 bt_value_borrow_from_private(file_groups
));
461 BT_OBJECT_PUT_REF_AND_RESET(file_groups
);
462 if (status
!= BT_VALUE_STATUS_OK
) {
468 bt_object_put_ref(file_groups
);
469 ctf_fs_trace_destroy(trace
);
474 struct bt_component_class_query_method_return
trace_info_query(
475 struct bt_component_class
*comp_class
,
476 struct bt_value
*params
)
478 struct bt_component_class_query_method_return query_ret
= {
480 .status
= BT_QUERY_STATUS_OK
,
483 struct bt_private_value
*result
= NULL
;
484 struct bt_value
*path_value
= NULL
;
486 const char *path
= NULL
;
487 GList
*trace_paths
= NULL
;
488 GList
*trace_names
= NULL
;
489 GList
*tp_node
= NULL
;
490 GList
*tn_node
= NULL
;
491 GString
*normalized_path
= NULL
;
495 if (!bt_value_is_map(params
)) {
496 BT_LOGE("Query parameters is not a map value object.");
497 query_ret
.status
= BT_QUERY_STATUS_INVALID_PARAMS
;
501 path_value
= bt_value_map_borrow_entry_value(params
, "path");
502 ret
= bt_value_string_get(path_value
, &path
);
504 BT_LOGE("Cannot get `path` string parameter.");
505 query_ret
.status
= BT_QUERY_STATUS_INVALID_PARAMS
;
509 normalized_path
= bt_common_normalize_path(path
, NULL
);
510 if (!normalized_path
) {
511 BT_LOGE("Failed to normalize path: `%s`.", path
);
516 ret
= ctf_fs_find_traces(&trace_paths
, normalized_path
->str
);
521 trace_names
= ctf_fs_create_trace_names(trace_paths
,
522 normalized_path
->str
);
524 BT_LOGE("Cannot create trace names from trace paths.");
528 result
= bt_private_value_array_create();
530 query_ret
.status
= BT_QUERY_STATUS_NOMEM
;
534 query_ret
.result
= bt_value_borrow_from_private(result
);
536 /* Iterates over both trace paths and names simultaneously. */
537 for (tp_node
= trace_paths
, tn_node
= trace_names
; tp_node
;
538 tp_node
= g_list_next(tp_node
),
539 tn_node
= g_list_next(tn_node
)) {
540 GString
*trace_path
= tp_node
->data
;
541 GString
*trace_name
= tn_node
->data
;
542 enum bt_value_status status
;
543 struct bt_private_value
*trace_info
;
545 trace_info
= bt_private_value_map_create();
547 BT_LOGE("Failed to create trace info map.");
551 ret
= populate_trace_info(trace_path
->str
, trace_name
->str
,
554 bt_object_put_ref(trace_info
);
558 status
= bt_private_value_array_append_element(result
,
559 bt_value_borrow_from_private(trace_info
));
560 bt_object_put_ref(trace_info
);
561 if (status
!= BT_VALUE_STATUS_OK
) {
569 BT_OBJECT_PUT_REF_AND_RESET(result
);
570 query_ret
.result
= NULL
;
572 if (query_ret
.status
>= 0) {
573 query_ret
.status
= BT_QUERY_STATUS_ERROR
;
577 if (normalized_path
) {
578 g_string_free(normalized_path
, TRUE
);
581 for (tp_node
= trace_paths
; tp_node
; tp_node
= g_list_next(tp_node
)) {
583 g_string_free(tp_node
->data
, TRUE
);
586 g_list_free(trace_paths
);
589 for (tn_node
= trace_names
; tn_node
; tn_node
= g_list_next(tn_node
)) {
591 g_string_free(tn_node
->data
, TRUE
);
594 g_list_free(trace_names
);
596 /* "path" becomes invalid with the release of path_value. */