2 * SPDX-License-Identifier: MIT
4 * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 * Babeltrace CTF file system Reader Component queries
11 #include <glib/gstdio.h>
13 #include <sys/types.h>
15 #include <babeltrace2/babeltrace.h>
17 #define BT_LOG_OUTPUT_LEVEL log_level
18 #define BT_LOG_TAG "PLUGIN/SRC.CTF.FS/QUERY"
19 #include "logging/comp-logging.h"
20 #include "logging/log.h"
22 #include "common/assert.h"
23 #include "common/common.h"
24 #include "common/macros.h"
26 #include "../common/metadata/decoder.hpp"
28 #include "metadata.hpp"
31 #define METADATA_TEXT_SIG "/* CTF 1.8"
40 bt_component_class_query_method_status
41 metadata_info_query(bt_self_component_class_source
*self_comp_class_src
, const bt_value
*params
,
42 bt_logging_level log_level
, const bt_value
**user_result
)
44 bt_component_class_query_method_status status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
45 bt_self_component_class
*self_comp_class
=
46 bt_self_component_class_source_as_self_component_class(self_comp_class_src
);
47 bt_value
*result
= NULL
;
48 const bt_value
*path_value
= NULL
;
49 FILE *metadata_fp
= NULL
;
54 struct ctf_metadata_decoder
*decoder
= NULL
;
55 ctf_metadata_decoder_config decoder_cfg
{};
56 enum ctf_metadata_decoder_status decoder_status
;
57 GString
*g_metadata_text
= NULL
;
58 const char *plaintext
;
60 result
= bt_value_map_create();
62 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
68 if (!bt_value_is_map(params
)) {
69 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class
,
70 "Query parameters is not a map value object.");
71 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
75 path_value
= bt_value_map_borrow_entry_value_const(params
, "path");
77 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class
, "Mandatory `path` parameter missing");
78 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
82 if (!bt_value_is_string(path_value
)) {
83 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class
,
84 "`path` parameter is required to be a string value");
85 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
89 path
= bt_value_string_get(path_value
);
92 metadata_fp
= ctf_fs_metadata_open_file(path
, log_level
, self_comp_class
);
94 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class
, "Cannot open trace metadata: path=\"%s\".",
99 ret
= ctf_metadata_decoder_is_packetized(metadata_fp
, &is_packetized
, &bo
, log_level
, NULL
);
101 BT_COMP_CLASS_LOGE_APPEND_CAUSE(
103 "Cannot check whether or not the metadata stream is packetized: path=\"%s\".", path
);
107 decoder_cfg
.log_level
= log_level
;
108 decoder_cfg
.self_comp_class
= self_comp_class
;
109 decoder_cfg
.keep_plain_text
= true;
110 decoder
= ctf_metadata_decoder_create(&decoder_cfg
);
112 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class
,
113 "Cannot create metadata decoder: path=\"%s\".", path
);
118 decoder_status
= ctf_metadata_decoder_append_content(decoder
, metadata_fp
);
119 if (decoder_status
) {
120 BT_COMP_CLASS_LOGE_APPEND_CAUSE(
121 self_comp_class
, "Cannot update metadata decoder's content: path=\"%s\".", path
);
125 plaintext
= ctf_metadata_decoder_get_text(decoder
);
126 g_metadata_text
= g_string_new(NULL
);
128 if (!g_metadata_text
) {
132 if (strncmp(plaintext
, METADATA_TEXT_SIG
, sizeof(METADATA_TEXT_SIG
) - 1) != 0) {
133 g_string_assign(g_metadata_text
, METADATA_TEXT_SIG
);
134 g_string_append(g_metadata_text
, " */\n\n");
137 g_string_append(g_metadata_text
, plaintext
);
139 ret
= bt_value_map_insert_string_entry(result
, "text", g_metadata_text
->str
);
141 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class
,
142 "Cannot insert metadata text into query result.");
146 ret
= bt_value_map_insert_bool_entry(result
, "is-packetized", is_packetized
);
148 BT_COMP_CLASS_LOGE_APPEND_CAUSE(
149 self_comp_class
, "Cannot insert \"is-packetized\" attribute into query result.");
156 BT_VALUE_PUT_REF_AND_RESET(result
);
160 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
164 if (g_metadata_text
) {
165 g_string_free(g_metadata_text
, TRUE
);
167 ctf_metadata_decoder_destroy(decoder
);
170 ret
= fclose(metadata_fp
);
172 BT_LOGE_ERRNO("Cannot close metatada file stream", ": path=\"%s\"", path
);
176 *user_result
= result
;
180 static int add_range(bt_value
*info
, struct range
*range
, const char *range_name
)
183 bt_value_map_insert_entry_status status
;
191 status
= bt_value_map_insert_empty_map_entry(info
, range_name
, &range_map
);
192 if (status
!= BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK
) {
197 status
= bt_value_map_insert_signed_integer_entry(range_map
, "begin", range
->begin_ns
);
198 if (status
!= BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK
) {
203 status
= bt_value_map_insert_signed_integer_entry(range_map
, "end", range
->end_ns
);
204 if (status
!= BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK
) {
213 static int populate_stream_info(struct ctf_fs_ds_file_group
*group
, bt_value
*group_info
,
214 struct range
*stream_range
)
217 bt_value_map_insert_entry_status insert_status
;
218 struct ctf_fs_ds_index_entry
*first_ds_index_entry
, *last_ds_index_entry
;
219 gchar
*port_name
= NULL
;
222 * Since each `struct ctf_fs_ds_file_group` has a sorted array of
223 * `struct ctf_fs_ds_index_entry`, we can compute the stream range from
224 * the timestamp_begin of the first index entry and the timestamp_end
225 * of the last index entry.
227 BT_ASSERT(group
->index
);
228 BT_ASSERT(group
->index
->entries
);
229 BT_ASSERT(group
->index
->entries
->len
> 0);
232 first_ds_index_entry
=
233 (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(group
->index
->entries
, 0);
236 last_ds_index_entry
= (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(
237 group
->index
->entries
, group
->index
->entries
->len
- 1);
239 stream_range
->begin_ns
= first_ds_index_entry
->timestamp_begin_ns
;
240 stream_range
->end_ns
= last_ds_index_entry
->timestamp_end_ns
;
243 * If any of the begin and end timestamps is not set it means that
244 * packets don't include `timestamp_begin` _and_ `timestamp_end` fields
245 * in their packet context so we can't set the range.
248 stream_range
->begin_ns
!= UINT64_C(-1) && stream_range
->end_ns
!= UINT64_C(-1);
250 ret
= add_range(group_info
, stream_range
, "range-ns");
255 port_name
= ctf_fs_make_port_name(group
);
261 insert_status
= bt_value_map_insert_string_entry(group_info
, "port-name", port_name
);
262 if (insert_status
!= BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK
) {
272 static int populate_trace_info(const struct ctf_fs_trace
*trace
, bt_value
*trace_info
,
273 bt_logging_level log_level
, bt_self_component_class
*self_comp_class
)
277 bt_value_map_insert_entry_status insert_status
;
278 bt_value_array_append_element_status append_status
;
279 bt_value
*file_groups
= NULL
;
281 BT_ASSERT(trace
->ds_file_groups
);
282 /* Add trace range info only if it contains streams. */
283 if (trace
->ds_file_groups
->len
== 0) {
285 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class
, "Trace has no streams: trace-path=%s",
290 insert_status
= bt_value_map_insert_empty_array_entry(trace_info
, "stream-infos", &file_groups
);
291 if (insert_status
!= BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK
) {
296 /* Find range of all stream groups, and of the trace. */
297 for (group_idx
= 0; group_idx
< trace
->ds_file_groups
->len
; group_idx
++) {
298 bt_value
*group_info
;
300 ctf_fs_ds_file_group
*group
=
301 (ctf_fs_ds_file_group
*) g_ptr_array_index(trace
->ds_file_groups
, group_idx
);
303 append_status
= bt_value_array_append_empty_map_element(file_groups
, &group_info
);
304 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
309 ret
= populate_stream_info(group
, group_info
, &group_range
);
319 bt_component_class_query_method_status
320 trace_infos_query(bt_self_component_class_source
*self_comp_class_src
, const bt_value
*params
,
321 bt_logging_level log_level
, const bt_value
**user_result
)
323 struct ctf_fs_component
*ctf_fs
= NULL
;
324 bt_component_class_query_method_status status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
325 bt_self_component_class
*self_comp_class
=
326 bt_self_component_class_source_as_self_component_class(self_comp_class_src
);
327 bt_value
*result
= NULL
;
328 const bt_value
*inputs_value
= NULL
;
329 const bt_value
*trace_name_value
;
331 bt_value
*trace_info
= NULL
;
332 bt_value_array_append_element_status append_status
;
336 if (!bt_value_is_map(params
)) {
337 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class
,
338 "Query parameters is not a map value object.");
339 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
343 ctf_fs
= ctf_fs_component_create(log_level
);
348 if (!read_src_fs_parameters(params
, &inputs_value
, &trace_name_value
, ctf_fs
, NULL
,
350 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
354 if (ctf_fs_component_create_ctf_fs_trace(ctf_fs
, inputs_value
, trace_name_value
, NULL
,
359 result
= bt_value_array_create();
361 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
365 append_status
= bt_value_array_append_empty_map_element(result
, &trace_info
);
366 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
367 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class
, "Failed to create trace info map.");
371 ret
= populate_trace_info(ctf_fs
->trace
, trace_info
, log_level
, self_comp_class
);
379 BT_VALUE_PUT_REF_AND_RESET(result
);
382 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
387 ctf_fs_destroy(ctf_fs
);
391 *user_result
= result
;
395 bt_component_class_query_method_status
396 support_info_query(bt_self_component_class_source
*comp_class
, const bt_value
*params
,
397 bt_logging_level log_level
, const bt_value
**user_result
)
399 const bt_value
*input_type_value
;
400 const char *input_type
;
401 bt_component_class_query_method_status status
;
402 bt_value_map_insert_entry_status insert_entry_status
;
404 gchar
*metadata_path
= NULL
;
405 bt_value
*result
= NULL
;
406 struct ctf_metadata_decoder
*metadata_decoder
= NULL
;
407 FILE *metadata_file
= NULL
;
408 char uuid_str
[BT_UUID_STR_LEN
+ 1];
409 bool has_uuid
= false;
410 const bt_value
*input_value
;
413 input_type_value
= bt_value_map_borrow_entry_value_const(params
, "type");
414 BT_ASSERT(input_type_value
);
415 BT_ASSERT(bt_value_get_type(input_type_value
) == BT_VALUE_TYPE_STRING
);
416 input_type
= bt_value_string_get(input_type_value
);
418 if (strcmp(input_type
, "directory") != 0) {
422 input_value
= bt_value_map_borrow_entry_value_const(params
, "input");
423 BT_ASSERT(input_value
);
424 BT_ASSERT(bt_value_get_type(input_value
) == BT_VALUE_TYPE_STRING
);
425 input
= bt_value_string_get(input_value
);
427 metadata_path
= g_build_filename(input
, CTF_FS_METADATA_FILENAME
, NULL
);
428 if (!metadata_path
) {
429 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
433 metadata_file
= g_fopen(metadata_path
, "rb");
435 ctf_metadata_decoder_config metadata_decoder_config
{};
436 enum ctf_metadata_decoder_status decoder_status
;
439 metadata_decoder_config
.log_level
= log_level
;
440 metadata_decoder_config
.self_comp_class
=
441 bt_self_component_class_source_as_self_component_class(comp_class
);
443 metadata_decoder
= ctf_metadata_decoder_create(&metadata_decoder_config
);
444 if (!metadata_decoder
) {
445 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
449 decoder_status
= ctf_metadata_decoder_append_content(metadata_decoder
, metadata_file
);
450 if (decoder_status
!= CTF_METADATA_DECODER_STATUS_OK
) {
451 BT_LOGW("cannot append metadata content: metadata-decoder-status=%d", decoder_status
);
452 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
457 * We were able to parse the metadata file, so we are
458 * confident it's a CTF trace.
462 /* If the trace has a UUID, return the stringified UUID as the group. */
463 if (ctf_metadata_decoder_get_trace_class_uuid(metadata_decoder
, uuid
) == 0) {
464 bt_uuid_to_str(uuid
, uuid_str
);
470 result
= bt_value_map_create();
472 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
476 insert_entry_status
= bt_value_map_insert_real_entry(result
, "weight", weight
);
477 if (insert_entry_status
!= BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK
) {
478 status
= (bt_component_class_query_method_status
) insert_entry_status
;
482 /* We are not supposed to have weight == 0 and a UUID. */
483 BT_ASSERT(weight
> 0 || !has_uuid
);
485 if (weight
> 0 && has_uuid
) {
486 insert_entry_status
= bt_value_map_insert_string_entry(result
, "group", uuid_str
);
487 if (insert_entry_status
!= BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK
) {
488 status
= (bt_component_class_query_method_status
) insert_entry_status
;
493 *user_result
= result
;
495 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
498 g_free(metadata_path
);
499 bt_value_put_ref(result
);
500 ctf_metadata_decoder_destroy(metadata_decoder
);