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>
14 #include <sys/types.h>
16 #include <babeltrace2/babeltrace.h>
18 #define BT_LOG_OUTPUT_LEVEL log_level
19 #define BT_LOG_TAG "PLUGIN/SRC.CTF.FS/QUERY"
20 #include "logging/comp-logging.h"
21 #include "logging/log.h"
23 #include "common/assert.h"
24 #include "common/common.h"
25 #include "common/macros.h"
27 #include "../common/metadata/decoder.hpp"
29 #include "metadata.hpp"
32 #define METADATA_TEXT_SIG "/* CTF 1.8"
41 bt_component_class_query_method_status
42 metadata_info_query(bt_self_component_class_source
*self_comp_class_src
, const bt_value
*params
,
43 bt_logging_level log_level
, const bt_value
**user_result
)
45 bt_component_class_query_method_status status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
46 bt_self_component_class
*self_comp_class
=
47 bt_self_component_class_source_as_self_component_class(self_comp_class_src
);
48 bt_value
*result
= NULL
;
49 const bt_value
*path_value
= NULL
;
50 FILE *metadata_fp
= NULL
;
55 struct ctf_metadata_decoder
*decoder
= NULL
;
56 ctf_metadata_decoder_config decoder_cfg
{};
57 enum ctf_metadata_decoder_status decoder_status
;
58 GString
*g_metadata_text
= NULL
;
59 const char *plaintext
;
61 result
= bt_value_map_create();
63 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
69 if (!bt_value_is_map(params
)) {
70 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class
,
71 "Query parameters is not a map value object.");
72 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
76 path_value
= bt_value_map_borrow_entry_value_const(params
, "path");
78 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class
, "Mandatory `path` parameter missing");
79 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
83 if (!bt_value_is_string(path_value
)) {
84 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class
,
85 "`path` parameter is required to be a string value");
86 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
90 path
= bt_value_string_get(path_value
);
93 metadata_fp
= ctf_fs_metadata_open_file(path
, log_level
, self_comp_class
);
95 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class
, "Cannot open trace metadata: path=\"%s\".",
100 ret
= ctf_metadata_decoder_is_packetized(metadata_fp
, &is_packetized
, &bo
, log_level
, NULL
);
102 BT_COMP_CLASS_LOGE_APPEND_CAUSE(
104 "Cannot check whether or not the metadata stream is packetized: path=\"%s\".", path
);
108 decoder_cfg
.log_level
= log_level
;
109 decoder_cfg
.self_comp_class
= self_comp_class
;
110 decoder_cfg
.keep_plain_text
= true;
111 decoder
= ctf_metadata_decoder_create(&decoder_cfg
);
113 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class
,
114 "Cannot create metadata decoder: path=\"%s\".", path
);
119 decoder_status
= ctf_metadata_decoder_append_content(decoder
, metadata_fp
);
120 if (decoder_status
) {
121 BT_COMP_CLASS_LOGE_APPEND_CAUSE(
122 self_comp_class
, "Cannot update metadata decoder's content: path=\"%s\".", path
);
126 plaintext
= ctf_metadata_decoder_get_text(decoder
);
127 g_metadata_text
= g_string_new(NULL
);
129 if (!g_metadata_text
) {
133 if (strncmp(plaintext
, METADATA_TEXT_SIG
, sizeof(METADATA_TEXT_SIG
) - 1) != 0) {
134 g_string_assign(g_metadata_text
, METADATA_TEXT_SIG
);
135 g_string_append(g_metadata_text
, " */\n\n");
138 g_string_append(g_metadata_text
, plaintext
);
140 ret
= bt_value_map_insert_string_entry(result
, "text", g_metadata_text
->str
);
142 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class
,
143 "Cannot insert metadata text into query result.");
147 ret
= bt_value_map_insert_bool_entry(result
, "is-packetized", is_packetized
);
149 BT_COMP_CLASS_LOGE_APPEND_CAUSE(
150 self_comp_class
, "Cannot insert \"is-packetized\" attribute into query result.");
157 BT_VALUE_PUT_REF_AND_RESET(result
);
161 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
165 if (g_metadata_text
) {
166 g_string_free(g_metadata_text
, TRUE
);
168 ctf_metadata_decoder_destroy(decoder
);
171 ret
= fclose(metadata_fp
);
173 BT_LOGE_ERRNO("Cannot close metatada file stream", ": path=\"%s\"", path
);
177 *user_result
= result
;
181 static int add_range(bt_value
*info
, struct range
*range
, const char *range_name
)
184 bt_value_map_insert_entry_status status
;
192 status
= bt_value_map_insert_empty_map_entry(info
, range_name
, &range_map
);
193 if (status
!= BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK
) {
198 status
= bt_value_map_insert_signed_integer_entry(range_map
, "begin", range
->begin_ns
);
199 if (status
!= BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK
) {
204 status
= bt_value_map_insert_signed_integer_entry(range_map
, "end", range
->end_ns
);
205 if (status
!= BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK
) {
214 static int populate_stream_info(struct ctf_fs_ds_file_group
*group
, bt_value
*group_info
,
215 struct range
*stream_range
)
218 bt_value_map_insert_entry_status insert_status
;
219 struct ctf_fs_ds_index_entry
*first_ds_index_entry
, *last_ds_index_entry
;
220 gchar
*port_name
= NULL
;
223 * Since each `struct ctf_fs_ds_file_group` has a sorted array of
224 * `struct ctf_fs_ds_index_entry`, we can compute the stream range from
225 * the timestamp_begin of the first index entry and the timestamp_end
226 * of the last index entry.
228 BT_ASSERT(group
->index
);
229 BT_ASSERT(group
->index
->entries
);
230 BT_ASSERT(group
->index
->entries
->len
> 0);
233 first_ds_index_entry
=
234 (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(group
->index
->entries
, 0);
237 last_ds_index_entry
= (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(
238 group
->index
->entries
, group
->index
->entries
->len
- 1);
240 stream_range
->begin_ns
= first_ds_index_entry
->timestamp_begin_ns
;
241 stream_range
->end_ns
= last_ds_index_entry
->timestamp_end_ns
;
244 * If any of the begin and end timestamps is not set it means that
245 * packets don't include `timestamp_begin` _and_ `timestamp_end` fields
246 * in their packet context so we can't set the range.
249 stream_range
->begin_ns
!= UINT64_C(-1) && stream_range
->end_ns
!= UINT64_C(-1);
251 ret
= add_range(group_info
, stream_range
, "range-ns");
256 port_name
= ctf_fs_make_port_name(group
);
262 insert_status
= bt_value_map_insert_string_entry(group_info
, "port-name", port_name
);
263 if (insert_status
!= BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK
) {
273 static int populate_trace_info(const struct ctf_fs_trace
*trace
, bt_value
*trace_info
,
274 bt_logging_level log_level
, bt_self_component_class
*self_comp_class
)
278 bt_value_map_insert_entry_status insert_status
;
279 bt_value_array_append_element_status append_status
;
280 bt_value
*file_groups
= NULL
;
282 BT_ASSERT(trace
->ds_file_groups
);
283 /* Add trace range info only if it contains streams. */
284 if (trace
->ds_file_groups
->len
== 0) {
286 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class
, "Trace has no streams: trace-path=%s",
291 insert_status
= bt_value_map_insert_empty_array_entry(trace_info
, "stream-infos", &file_groups
);
292 if (insert_status
!= BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK
) {
297 /* Find range of all stream groups, and of the trace. */
298 for (group_idx
= 0; group_idx
< trace
->ds_file_groups
->len
; group_idx
++) {
299 bt_value
*group_info
;
301 ctf_fs_ds_file_group
*group
=
302 (ctf_fs_ds_file_group
*) g_ptr_array_index(trace
->ds_file_groups
, group_idx
);
304 append_status
= bt_value_array_append_empty_map_element(file_groups
, &group_info
);
305 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
310 ret
= populate_stream_info(group
, group_info
, &group_range
);
320 bt_component_class_query_method_status
321 trace_infos_query(bt_self_component_class_source
*self_comp_class_src
, const bt_value
*params
,
322 bt_logging_level log_level
, const bt_value
**user_result
)
324 struct ctf_fs_component
*ctf_fs
= NULL
;
325 bt_component_class_query_method_status status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
326 bt_self_component_class
*self_comp_class
=
327 bt_self_component_class_source_as_self_component_class(self_comp_class_src
);
328 bt_value
*result
= NULL
;
329 const bt_value
*inputs_value
= NULL
;
330 const bt_value
*trace_name_value
;
332 bt_value
*trace_info
= NULL
;
333 bt_value_array_append_element_status append_status
;
337 if (!bt_value_is_map(params
)) {
338 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class
,
339 "Query parameters is not a map value object.");
340 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
344 ctf_fs
= ctf_fs_component_create(log_level
);
349 if (!read_src_fs_parameters(params
, &inputs_value
, &trace_name_value
, ctf_fs
, NULL
,
351 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
355 if (ctf_fs_component_create_ctf_fs_trace(ctf_fs
, inputs_value
, trace_name_value
, NULL
,
360 result
= bt_value_array_create();
362 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
366 append_status
= bt_value_array_append_empty_map_element(result
, &trace_info
);
367 if (append_status
!= BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
) {
368 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class
, "Failed to create trace info map.");
372 ret
= populate_trace_info(ctf_fs
->trace
, trace_info
, log_level
, self_comp_class
);
380 BT_VALUE_PUT_REF_AND_RESET(result
);
383 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
388 ctf_fs_destroy(ctf_fs
);
392 *user_result
= result
;
396 bt_component_class_query_method_status
397 support_info_query(bt_self_component_class_source
*comp_class
, const bt_value
*params
,
398 bt_logging_level log_level
, const bt_value
**user_result
)
400 const bt_value
*input_type_value
;
401 const char *input_type
;
402 bt_component_class_query_method_status status
;
403 bt_value_map_insert_entry_status insert_entry_status
;
405 gchar
*metadata_path
= NULL
;
406 bt_value
*result
= NULL
;
407 struct ctf_metadata_decoder
*metadata_decoder
= NULL
;
408 FILE *metadata_file
= NULL
;
409 char uuid_str
[BT_UUID_STR_LEN
+ 1];
410 bool has_uuid
= false;
411 const bt_value
*input_value
;
414 input_type_value
= bt_value_map_borrow_entry_value_const(params
, "type");
415 BT_ASSERT(input_type_value
);
416 BT_ASSERT(bt_value_get_type(input_type_value
) == BT_VALUE_TYPE_STRING
);
417 input_type
= bt_value_string_get(input_type_value
);
419 if (strcmp(input_type
, "directory") != 0) {
423 input_value
= bt_value_map_borrow_entry_value_const(params
, "input");
424 BT_ASSERT(input_value
);
425 BT_ASSERT(bt_value_get_type(input_value
) == BT_VALUE_TYPE_STRING
);
426 input
= bt_value_string_get(input_value
);
428 metadata_path
= g_build_filename(input
, CTF_FS_METADATA_FILENAME
, NULL
);
429 if (!metadata_path
) {
430 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
434 metadata_file
= g_fopen(metadata_path
, "rb");
436 ctf_metadata_decoder_config metadata_decoder_config
{};
437 enum ctf_metadata_decoder_status decoder_status
;
440 metadata_decoder_config
.log_level
= log_level
;
441 metadata_decoder_config
.self_comp_class
=
442 bt_self_component_class_source_as_self_component_class(comp_class
);
444 metadata_decoder
= ctf_metadata_decoder_create(&metadata_decoder_config
);
445 if (!metadata_decoder
) {
446 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
450 decoder_status
= ctf_metadata_decoder_append_content(metadata_decoder
, metadata_file
);
451 if (decoder_status
!= CTF_METADATA_DECODER_STATUS_OK
) {
452 BT_LOGW("cannot append metadata content: metadata-decoder-status=%d", decoder_status
);
453 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR
;
458 * We were able to parse the metadata file, so we are
459 * confident it's a CTF trace.
463 /* If the trace has a UUID, return the stringified UUID as the group. */
464 if (ctf_metadata_decoder_get_trace_class_uuid(metadata_decoder
, uuid
) == 0) {
465 bt_uuid_to_str(uuid
, uuid_str
);
471 result
= bt_value_map_create();
473 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR
;
477 insert_entry_status
= bt_value_map_insert_real_entry(result
, "weight", weight
);
478 if (insert_entry_status
!= BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK
) {
479 status
= (bt_component_class_query_method_status
) insert_entry_status
;
483 /* We are not supposed to have weight == 0 and a UUID. */
484 BT_ASSERT(weight
> 0 || !has_uuid
);
486 if (weight
> 0 && has_uuid
) {
487 insert_entry_status
= bt_value_map_insert_string_entry(result
, "group", uuid_str
);
488 if (insert_entry_status
!= BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK
) {
489 status
= (bt_component_class_query_method_status
) insert_entry_status
;
494 *user_result
= result
;
496 status
= BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK
;
499 g_free(metadata_path
);
500 bt_value_put_ref(result
);
501 ctf_metadata_decoder_destroy(metadata_decoder
);