#include <babeltrace2/babeltrace.h>
-#include "../common/src/metadata/tsdl/decoder.hpp"
+#include "cpp-common/bt2/exc.hpp"
+#include "cpp-common/bt2c/file-utils.hpp"
+#include "cpp-common/bt2c/glib-up.hpp"
+
+#include "plugins/common/param-validation/param-validation.h"
+
+#include "../common/src/metadata/metadata-stream-parser-utils.hpp"
+#include "../common/src/metadata/tsdl/metadata-stream-decoder.hpp"
+#include "data-stream-file.hpp"
#include "fs.hpp"
+#include "metadata.hpp"
#include "query.hpp"
#define METADATA_TEXT_SIG "/* CTF 1.8"
bool set = false;
};
-bt_component_class_query_method_status metadata_info_query(const bt_value *params,
- const bt2c::Logger& logger,
- const bt_value **user_result)
-{
- bt_component_class_query_method_status status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK;
- bt_value *result = NULL;
- const bt_value *path_value = NULL;
- FILE *metadata_fp = NULL;
- int ret;
- int bo;
- const char *path;
- bool is_packetized;
- struct ctf_metadata_decoder *decoder = NULL;
- ctf_metadata_decoder_config decoder_cfg {logger};
- enum ctf_metadata_decoder_status decoder_status;
- GString *g_metadata_text = NULL;
- const char *plaintext;
-
- result = bt_value_map_create();
- if (!result) {
- status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR;
- goto error;
- }
-
- BT_ASSERT(params);
-
- if (!bt_value_is_map(params)) {
- BT_CPPLOGE_APPEND_CAUSE_SPEC(logger, "Query parameters is not a map value object.");
- status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
- goto error;
- }
-
- path_value = bt_value_map_borrow_entry_value_const(params, "path");
- if (!path_value) {
- BT_CPPLOGE_APPEND_CAUSE_SPEC(logger, "Mandatory `path` parameter missing");
- status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
- goto error;
- }
-
- if (!bt_value_is_string(path_value)) {
- BT_CPPLOGE_APPEND_CAUSE_SPEC(logger, "`path` parameter is required to be a string value");
- status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
- goto error;
- }
-
- path = bt_value_string_get(path_value);
-
- BT_ASSERT(path);
- metadata_fp = ctf_fs_metadata_open_file(path, logger);
- if (!metadata_fp) {
- BT_CPPLOGE_APPEND_CAUSE_SPEC(logger, "Cannot open trace metadata: path=\"{}\".", path);
- goto error;
- }
-
- ret = ctf_metadata_decoder_is_packetized(metadata_fp, &is_packetized, &bo, logger);
- if (ret) {
- BT_CPPLOGE_APPEND_CAUSE_SPEC(
- logger, "Cannot check whether or not the metadata stream is packetized: path=\"{}\".",
- path);
- goto error;
- }
+static bt_param_validation_map_value_entry_descr metadataInfoQueryParamsDesc[] = {
+ {"path", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY,
+ bt_param_validation_value_descr::makeString()},
+ BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END};
- decoder_cfg.keep_plain_text = true;
- decoder = ctf_metadata_decoder_create(&decoder_cfg);
- if (!decoder) {
- BT_CPPLOGE_APPEND_CAUSE_SPEC(logger, "Cannot create metadata decoder: path=\"{}\".", path);
- goto error;
- }
-
- rewind(metadata_fp);
- decoder_status = ctf_metadata_decoder_append_content(decoder, metadata_fp);
- if (decoder_status) {
- BT_CPPLOGE_APPEND_CAUSE_SPEC(
- logger, "Cannot update metadata decoder's content: path=\"{}\".", path);
- goto error;
- }
-
- plaintext = ctf_metadata_decoder_get_text(decoder);
- g_metadata_text = g_string_new(NULL);
-
- if (!g_metadata_text) {
- goto error;
- }
-
- if (strncmp(plaintext, METADATA_TEXT_SIG, sizeof(METADATA_TEXT_SIG) - 1) != 0) {
- g_string_assign(g_metadata_text, METADATA_TEXT_SIG);
- g_string_append(g_metadata_text, " */\n\n");
- }
-
- g_string_append(g_metadata_text, plaintext);
+bt2::Value::Shared metadata_info_query(const bt2::ConstMapValue params, const bt2c::Logger& logger)
+{
+ gchar *validateError = nullptr;
+ const auto validationStatus = bt_param_validation_validate(
+ params.libObjPtr(), metadataInfoQueryParamsDesc, &validateError);
- ret = bt_value_map_insert_string_entry(result, "text", g_metadata_text->str);
- if (ret) {
- BT_CPPLOGE_APPEND_CAUSE_SPEC(logger, "Cannot insert metadata text into query result.");
- goto error;
- }
+ if (validationStatus == BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR) {
+ throw bt2::MemoryError {};
+ } else if (validationStatus == BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR) {
+ const bt2c::GCharUP deleter {validateError};
- ret = bt_value_map_insert_bool_entry(result, "is-packetized", is_packetized);
- if (ret) {
- BT_CPPLOGE_APPEND_CAUSE_SPEC(
- logger, "Cannot insert \"is-packetized\" attribute into query result.");
- goto error;
+ BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(logger, bt2::Error, "{}", validateError);
}
- goto end;
+ const auto path = params["path"]->asString().value();
-error:
- BT_VALUE_PUT_REF_AND_RESET(result);
- result = NULL;
+ try {
+ const auto buffer = bt2c::dataFromFile(fmt::format("{}/metadata", path), logger, true);
+ ctf::src::MetadataStreamDecoder decoder {logger};
+ auto plainText = decoder.decode(buffer);
+ const auto result = bt2::MapValue::create();
- if (status >= 0) {
- status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
- }
-
-end:
- if (g_metadata_text) {
- g_string_free(g_metadata_text, TRUE);
- }
- ctf_metadata_decoder_destroy(decoder);
-
- if (metadata_fp) {
- ret = fclose(metadata_fp);
- if (ret) {
- BT_CPPLOGE_ERRNO_SPEC(logger, "Cannot close metadata file stream", ": path=\"{}\"",
- path);
+ /*
+ * If the metadata does not already start with the plaintext metadata
+ * signature, prepend it.
+ */
+ if (plainText.rfind(METADATA_TEXT_SIG, 0) != 0) {
+ plainText.insert(0, std::string {METADATA_TEXT_SIG} + " */\n\n");
}
- }
- *user_result = result;
- return status;
+ result->insert("text", plainText.data());
+ result->insert("is-packetized", decoder.pktInfo().has_value());
+ return result;
+ } catch (const bt2c::Error&) {
+ BT_CPPLOGE_APPEND_CAUSE_AND_RETHROW_SPEC(logger, "Error reading metadata file");
+ }
}
-static int add_range(bt_value *info, struct range *range, const char *range_name)
+static void add_range(const bt2::MapValue info, const range& range, const char *range_name)
{
- int ret = 0;
- bt_value_map_insert_entry_status status;
- bt_value *range_map;
-
- if (!range->set) {
+ if (!range.set) {
/* Not an error. */
- goto end;
- }
-
- status = bt_value_map_insert_empty_map_entry(info, range_name, &range_map);
- if (status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
- ret = -1;
- goto end;
+ return;
}
- status = bt_value_map_insert_signed_integer_entry(range_map, "begin", range->begin_ns);
- if (status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
- ret = -1;
- goto end;
- }
-
- status = bt_value_map_insert_signed_integer_entry(range_map, "end", range->end_ns);
- if (status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
- ret = -1;
- goto end;
- }
-
-end:
- return ret;
+ const auto rangeMap = info.insertEmptyMap(range_name);
+ rangeMap.insert("begin", range.begin_ns);
+ rangeMap.insert("end", range.end_ns);
}
-static int populate_stream_info(struct ctf_fs_ds_file_group *group, bt_value *group_info,
- struct range *stream_range)
+static void populate_stream_info(struct ctf_fs_ds_file_group *group, const bt2::MapValue groupInfo)
{
- int ret = 0;
- bt_value_map_insert_entry_status insert_status;
- struct ctf_fs_ds_index_entry *first_ds_index_entry, *last_ds_index_entry;
- bt2c::GCharUP port_name;
-
/*
* Since each `struct ctf_fs_ds_file_group` has a sorted array of
* `struct ctf_fs_ds_index_entry`, we can compute the stream range from
* the timestamp_begin of the first index entry and the timestamp_end
* of the last index entry.
*/
- BT_ASSERT(group->index);
- BT_ASSERT(group->index->entries);
- BT_ASSERT(group->index->entries->len > 0);
+ BT_ASSERT(!group->index.entries.empty());
/* First entry. */
- first_ds_index_entry =
- (struct ctf_fs_ds_index_entry *) g_ptr_array_index(group->index->entries, 0);
+ const auto& first_ds_index_entry = group->index.entries.front();
/* Last entry. */
- last_ds_index_entry = (struct ctf_fs_ds_index_entry *) g_ptr_array_index(
- group->index->entries, group->index->entries->len - 1);
+ const auto& last_ds_index_entry = group->index.entries.back();
- stream_range->begin_ns = first_ds_index_entry->timestamp_begin_ns;
- stream_range->end_ns = last_ds_index_entry->timestamp_end_ns;
+ range stream_range;
+ stream_range.begin_ns = first_ds_index_entry.timestamp_begin_ns;
+ stream_range.end_ns = last_ds_index_entry.timestamp_end_ns;
/*
* If any of the begin and end timestamps is not set it means that
* packets don't include `timestamp_begin` _and_ `timestamp_end` fields
* in their packet context so we can't set the range.
*/
- stream_range->set =
- stream_range->begin_ns != UINT64_C(-1) && stream_range->end_ns != UINT64_C(-1);
+ stream_range.set = stream_range.begin_ns != UINT64_C(-1) && stream_range.end_ns != UINT64_C(-1);
- ret = add_range(group_info, stream_range, "range-ns");
- if (ret) {
- goto end;
- }
-
- port_name = ctf_fs_make_port_name(group);
- if (!port_name) {
- ret = -1;
- goto end;
- }
-
- insert_status = bt_value_map_insert_string_entry(group_info, "port-name", port_name.get());
- if (insert_status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
- ret = -1;
- goto end;
- }
-
-end:
- return ret;
+ add_range(groupInfo, stream_range, "range-ns");
+ groupInfo.insert("port-name", ctf_fs_make_port_name(group));
}
-static int populate_trace_info(const struct ctf_fs_trace *trace, bt_value *trace_info,
- const bt2c::Logger& logger)
+static void populate_trace_info(const struct ctf_fs_trace *trace, const bt2::MapValue traceInfo,
+ const bt2c::Logger& logger)
{
- int ret = 0;
- size_t group_idx;
- bt_value_map_insert_entry_status insert_status;
- bt_value_array_append_element_status append_status;
- bt_value *file_groups = NULL;
-
- BT_ASSERT(trace->ds_file_groups);
/* Add trace range info only if it contains streams. */
- if (trace->ds_file_groups->len == 0) {
- ret = -1;
- BT_CPPLOGE_APPEND_CAUSE_SPEC(logger, "Trace has no streams: trace-path={}",
- trace->path->str);
- goto end;
+ if (trace->ds_file_groups.empty()) {
+ BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(logger, bt2::Error,
+ "Trace has no streams: trace-path={}", trace->path);
}
- insert_status = bt_value_map_insert_empty_array_entry(trace_info, "stream-infos", &file_groups);
- if (insert_status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
- ret = -1;
- goto end;
- }
+ const auto fileGroups = traceInfo.insertEmptyArray("stream-infos");
/* Find range of all stream groups, and of the trace. */
- for (group_idx = 0; group_idx < trace->ds_file_groups->len; group_idx++) {
- bt_value *group_info;
- range group_range;
- ctf_fs_ds_file_group *group =
- (ctf_fs_ds_file_group *) g_ptr_array_index(trace->ds_file_groups, group_idx);
-
- append_status = bt_value_array_append_empty_map_element(file_groups, &group_info);
- if (append_status != BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK) {
- ret = -1;
- goto end;
- }
-
- ret = populate_stream_info(group, group_info, &group_range);
- if (ret) {
- goto end;
- }
+ for (const auto& group : trace->ds_file_groups) {
+ const auto groupInfo = fileGroups.appendEmptyMap();
+ populate_stream_info(group.get(), groupInfo);
}
-
-end:
- return ret;
}
-bt_component_class_query_method_status
-trace_infos_query(const bt_value *params, const bt2c::Logger& logger, const bt_value **user_result)
+bt2::Value::Shared trace_infos_query(const bt2::ConstMapValue params, const bt2c::Logger& logger)
{
- ctf_fs_component::UP ctf_fs;
- bt_component_class_query_method_status status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK;
- bt_value *result = NULL;
- const bt_value *inputs_value = NULL;
- const bt_value *trace_name_value;
- int ret = 0;
- bt_value *trace_info = NULL;
- bt_value_array_append_element_status append_status;
-
- BT_ASSERT(params);
-
- if (!bt_value_is_map(params)) {
- BT_CPPLOGE_APPEND_CAUSE_SPEC(logger, "Query parameters is not a map value object.");
- status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
- goto error;
- }
-
- ctf_fs = ctf_fs_component_create(logger);
- if (!ctf_fs) {
- goto error;
- }
-
- if (!read_src_fs_parameters(params, &inputs_value, &trace_name_value, ctf_fs.get())) {
- status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
- goto error;
- }
+ const auto parameters = read_src_fs_parameters(params, logger);
+ ctf_fs_component ctf_fs {parameters.clkClsCfg, logger};
- if (ctf_fs_component_create_ctf_fs_trace(ctf_fs.get(), inputs_value, trace_name_value, NULL)) {
- goto error;
+ if (ctf_fs_component_create_ctf_fs_trace(
+ &ctf_fs, parameters.inputs,
+ parameters.traceName ? parameters.traceName->c_str() : nullptr, {})) {
+ BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(logger, bt2::Error, "Failed to create trace");
}
- result = bt_value_array_create();
- if (!result) {
- status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR;
- goto error;
- }
-
- append_status = bt_value_array_append_empty_map_element(result, &trace_info);
- if (append_status != BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK) {
- BT_CPPLOGE_APPEND_CAUSE_SPEC(logger, "Failed to create trace info map.");
- goto error;
- }
-
- ret = populate_trace_info(ctf_fs->trace, trace_info, logger);
- if (ret) {
- goto error;
- }
+ const auto result = bt2::ArrayValue::create();
+ const auto traceInfo = result->appendEmptyMap();
+ populate_trace_info(ctf_fs.trace.get(), traceInfo, logger);
- goto end;
-
-error:
- BT_VALUE_PUT_REF_AND_RESET(result);
-
- if (status >= 0) {
- status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
- }
-
-end:
- *user_result = result;
- return status;
+ return result;
}
-bt_component_class_query_method_status
-support_info_query(const bt_value *params, const bt2c::Logger& logger, const bt_value **user_result)
+static bt_param_validation_map_value_entry_descr supportInfoQueryParamsDesc[] = {
+ {"type", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY,
+ bt_param_validation_value_descr::makeString()},
+ {"input", BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY,
+ bt_param_validation_value_descr::makeString()},
+ BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END};
+
+bt2::Value::Shared support_info_query(const bt2::ConstMapValue params, const bt2c::Logger& logger)
{
- const bt_value *input_type_value;
- const char *input_type;
- bt_component_class_query_method_status status;
- bt_value_map_insert_entry_status insert_entry_status;
- double weight = 0;
- gchar *metadata_path = NULL;
- bt_value *result = NULL;
- struct ctf_metadata_decoder *metadata_decoder = NULL;
- FILE *metadata_file = NULL;
- char uuid_str[BT_UUID_STR_LEN + 1];
- bool has_uuid = false;
- const bt_value *input_value;
- const char *input;
-
- input_type_value = bt_value_map_borrow_entry_value_const(params, "type");
- BT_ASSERT(input_type_value);
- BT_ASSERT(bt_value_get_type(input_type_value) == BT_VALUE_TYPE_STRING);
- input_type = bt_value_string_get(input_type_value);
-
- if (strcmp(input_type, "directory") != 0) {
- goto create_result;
- }
+ gchar *validateError = NULL;
+ const auto validationStatus = bt_param_validation_validate(
+ params.libObjPtr(), supportInfoQueryParamsDesc, &validateError);
- input_value = bt_value_map_borrow_entry_value_const(params, "input");
- BT_ASSERT(input_value);
- BT_ASSERT(bt_value_get_type(input_value) == BT_VALUE_TYPE_STRING);
- input = bt_value_string_get(input_value);
+ if (validationStatus == BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR) {
+ throw bt2::MemoryError {};
+ } else if (validationStatus == BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR) {
+ const bt2c::GCharUP deleter {validateError};
- metadata_path = g_build_filename(input, CTF_FS_METADATA_FILENAME, NULL);
- if (!metadata_path) {
- status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR;
- goto end;
+ BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(logger, bt2::Error, "{}", validateError);
}
- metadata_file = g_fopen(metadata_path, "rb");
- if (metadata_file) {
- enum ctf_metadata_decoder_status decoder_status;
- bt_uuid_t uuid;
-
- ctf_metadata_decoder_config metadata_decoder_config {logger};
-
- metadata_decoder = ctf_metadata_decoder_create(&metadata_decoder_config);
- if (!metadata_decoder) {
- status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
- goto end;
- }
-
- decoder_status = ctf_metadata_decoder_append_content(metadata_decoder, metadata_file);
- if (decoder_status != CTF_METADATA_DECODER_STATUS_OK) {
- BT_CPPLOGW_SPEC(logger, "cannot append metadata content: metadata-decoder-status={}",
- decoder_status);
- status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
- goto end;
- }
+ const auto type = params["type"]->asString().value();
+ if (strcmp(type, "directory") != 0) {
/*
- * We were able to parse the metadata file, so we are
- * confident it's a CTF trace.
+ * The input type is not a directory so we are 100% sure it's not a CTF
+ * 1.8 trace as it would need a directory with at least 1 metadata file
+ * and 1 data stream file.
*/
- weight = 0.75;
-
- /* If the trace has a UUID, return the stringified UUID as the group. */
- if (ctf_metadata_decoder_get_trace_class_uuid(metadata_decoder, uuid) == 0) {
- bt_uuid_to_str(uuid, uuid_str);
- has_uuid = true;
- }
+ const auto result = bt2::MapValue::create();
+ result->insert("weight", 0.0f);
+ return result;
}
-create_result:
- result = bt_value_map_create();
- if (!result) {
- status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR;
- goto end;
- }
+ const auto input = params["input"]->asString().value();
- insert_entry_status = bt_value_map_insert_real_entry(result, "weight", weight);
- if (insert_entry_status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
- status = (bt_component_class_query_method_status) insert_entry_status;
- goto end;
- }
+ const auto result = bt2::MapValue::create();
+ try {
+ const auto buffer = bt2c::dataFromFile(fmt::format("{}/metadata", input), logger, false);
+ const auto parseRet = ctf::src::parseMetadataStream({}, {}, buffer, logger);
- /* We are not supposed to have weight == 0 and a UUID. */
- BT_ASSERT(weight > 0 || !has_uuid);
+ BT_ASSERT(parseRet.traceCls);
- if (weight > 0 && has_uuid) {
- insert_entry_status = bt_value_map_insert_string_entry(result, "group", uuid_str);
- if (insert_entry_status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
- status = (bt_component_class_query_method_status) insert_entry_status;
- goto end;
+ /*
+ * We were able to parse the metadata file, so we are confident it's a
+ * CTF trace.
+ */
+ /* ⚠️ TODO: also consider namespace and name */
+ result->insert("weight", 0.75);
+ if (parseRet.traceCls->uid()) {
+ result->insert("group", *parseRet.traceCls->uid());
}
+ } catch (const bt2c::NoSuchFileOrDirectoryError&) {
+ /*
+ * Failing to find the metadata file is not an error, it simply
+ * indicates that the directory is not a trace. Report appropriate
+ * weight of zero.
+ */
+ result->insert("weight", 0.0);
}
- *user_result = result;
- result = NULL;
- status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK;
-
-end:
- g_free(metadata_path);
- bt_value_put_ref(result);
- ctf_metadata_decoder_destroy(metadata_decoder);
-
- return status;
+ return result;
}