src.ctf.fs: modernize read_src_fs_parameters
[babeltrace.git] / src / plugins / ctf / fs-src / query.cpp
index ce4619ef9a10a7bd538d943b478afa405691b789..a7225dda262f013fecb2aa24fdb6a591a759ba11 100644 (file)
 #include <babeltrace2/babeltrace.h>
 
 #include "cpp-common/bt2/exc.hpp"
+#include "cpp-common/bt2c/glib-up.hpp"
 #include "cpp-common/bt2c/libc-up.hpp"
 
+#include "plugins/common/param-validation/param-validation.h"
+
 #include "../common/src/metadata/tsdl/decoder.hpp"
+#include "data-stream-file.hpp"
 #include "fs.hpp"
+#include "metadata.hpp"
 #include "query.hpp"
 
 #define METADATA_TEXT_SIG "/* CTF 1.8"
@@ -28,20 +33,26 @@ struct range
     bool set = false;
 };
 
+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};
+
 bt2::Value::Shared metadata_info_query(const bt2::ConstMapValue params, const bt2c::Logger& logger)
 {
-    const auto pathValue = params["path"];
-    if (!pathValue) {
-        BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(logger, bt2::Error,
-                                               "Mandatory `path` parameter missing");
-    }
+    gchar *validateError = nullptr;
+    const auto validationStatus = bt_param_validation_validate(
+        params.libObjPtr(), metadataInfoQueryParamsDesc, &validateError);
 
-    if (!pathValue->isString()) {
-        BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(logger, bt2::Error,
-                                               "`path` parameter is required to be a string 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};
+
+        BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(logger, bt2::Error, "{}", validateError);
     }
 
-    const auto path = pathValue->asString().value();
+    const auto path = params["path"]->asString().value();
     bt2c::FileUP metadataFp {ctf_fs_metadata_open_file(path, logger)};
     if (!metadataFp) {
         BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(logger, bt2::Error,
@@ -104,7 +115,7 @@ static void add_range(const bt2::MapValue info, struct range *range, const char
 }
 
 static void populate_stream_info(struct ctf_fs_ds_file_group *group, const bt2::MapValue groupInfo,
-                                 struct range *stream_range, const bt2c::Logger& logger)
+                                 struct range *stream_range)
 {
     /*
      * Since each `struct ctf_fs_ds_file_group` has a sorted array of
@@ -112,20 +123,16 @@ static void populate_stream_info(struct ctf_fs_ds_file_group *group, const bt2::
      * 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. */
-    ctf_fs_ds_index_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. */
-    ctf_fs_ds_index_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;
+    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
@@ -136,82 +143,83 @@ static void populate_stream_info(struct ctf_fs_ds_file_group *group, const bt2::
         stream_range->begin_ns != UINT64_C(-1) && stream_range->end_ns != UINT64_C(-1);
 
     add_range(groupInfo, stream_range, "range-ns");
-
-    bt2c::GCharUP portName = ctf_fs_make_port_name(group);
-    if (!portName) {
-        BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(logger, bt2::Error, "Failed to make port name");
-    }
-
-    groupInfo.insert("port-name", portName.get());
+    groupInfo.insert("port-name", ctf_fs_make_port_name(group));
 }
 
 static void populate_trace_info(const struct ctf_fs_trace *trace, const bt2::MapValue traceInfo,
                                 const bt2c::Logger& logger)
 {
-    BT_ASSERT(trace->ds_file_groups);
     /* Add trace range info only if it contains streams. */
-    if (trace->ds_file_groups->len == 0) {
-        BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(
-            logger, bt2::Error, "Trace has no streams: trace-path={}", trace->path->str);
+    if (trace->ds_file_groups.empty()) {
+        BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(logger, bt2::Error,
+                                               "Trace has no streams: trace-path={}", trace->path);
     }
 
     const auto fileGroups = traceInfo.insertEmptyArray("stream-infos");
 
     /* Find range of all stream groups, and of the trace. */
-    for (size_t group_idx = 0; group_idx < trace->ds_file_groups->len; group_idx++) {
+    for (const auto& group : trace->ds_file_groups) {
         range group_range;
-        ctf_fs_ds_file_group *group =
-            (ctf_fs_ds_file_group *) g_ptr_array_index(trace->ds_file_groups, group_idx);
-
         const auto groupInfo = fileGroups.appendEmptyMap();
-        populate_stream_info(group, groupInfo, &group_range, logger);
+        populate_stream_info(group.get(), groupInfo, &group_range);
     }
 }
 
 bt2::Value::Shared trace_infos_query(const bt2::ConstMapValue params, const bt2c::Logger& logger)
 {
-    ctf_fs_component::UP ctf_fs = ctf_fs_component_create(logger);
-    if (!ctf_fs) {
-        BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(logger, bt2::Error,
-                                               "Cannot create ctf_fs_component");
-    }
-
-    const bt_value *inputs_value = NULL;
-    const bt_value *trace_name_value;
+    ctf_fs_component ctf_fs {logger};
+    const auto parameters = read_src_fs_parameters(params, logger);
 
-    if (!read_src_fs_parameters(params.libObjPtr(), &inputs_value, &trace_name_value,
-                                ctf_fs.get())) {
-        BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(logger, bt2::Error, "Failed to read parameters");
-    }
+    ctf_fs.clkClsCfg = parameters.clkClsCfg;
 
-    if (ctf_fs_component_create_ctf_fs_trace(ctf_fs.get(), inputs_value, trace_name_value, NULL)) {
+    if (ctf_fs_component_create_ctf_fs_trace(
+            &ctf_fs, parameters.inputs,
+            parameters.traceName ? parameters.traceName->c_str() : nullptr, nullptr)) {
         BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(logger, bt2::Error, "Failed to create trace");
     }
 
     const auto result = bt2::ArrayValue::create();
     const auto traceInfo = result->appendEmptyMap();
-    populate_trace_info(ctf_fs->trace, traceInfo, logger);
+    populate_trace_info(ctf_fs.trace.get(), traceInfo, logger);
 
     return 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 auto typeValue = params["type"];
-    BT_ASSERT(typeValue);
-    BT_ASSERT(typeValue->isString());
-    const auto type = typeValue->asString().value();
+    gchar *validateError = NULL;
+    const auto validationStatus = bt_param_validation_validate(
+        params.libObjPtr(), supportInfoQueryParamsDesc, &validateError);
+
+    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};
+
+        BT_CPPLOGE_APPEND_CAUSE_AND_THROW_SPEC(logger, bt2::Error, "{}", validateError);
+    }
+
+    const auto type = params["type"]->asString().value();
 
     if (strcmp(type, "directory") != 0) {
+        /*
+         * 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.
+         */
         const auto result = bt2::MapValue::create();
         result->insert("weight", 0.0f);
         return result;
     }
 
-    const auto inputValue = params["input"];
-    BT_ASSERT(inputValue);
-    BT_ASSERT(inputValue->isString());
-    const auto input = inputValue->asString().value();
+    const auto input = params["input"]->asString().value();
 
     bt2c::GCharUP metadataPath {g_build_filename(input, CTF_FS_METADATA_FILENAME, NULL)};
     if (!metadataPath) {
This page took 0.026338 seconds and 4 git commands to generate.