ctf: remove unused fields from `babeltrace.trace-info` query
[babeltrace.git] / src / plugins / ctf / fs-src / query.c
index 0a89084df7744d24df7de4f4f435c5a5f4bb9c1b..40adf8825b5a03dc87b2232f6765a5e79d7a9c0a 100644 (file)
  * SOFTWARE.
  */
 
+#define BT_LOG_OUTPUT_LEVEL log_level
+#define BT_LOG_TAG "PLUGIN/SRC.CTF.FS/QUERY"
+#include "logging/log.h"
+
 #include "query.h"
 #include <stdbool.h>
 #include "common/assert.h"
@@ -33,9 +37,7 @@
 #include "common/macros.h"
 #include <babeltrace2/babeltrace.h>
 #include "fs.h"
-
-#define BT_LOG_TAG "PLUGIN/SRC.CTF.FS/QUERY"
-#include "logging.h"
+#include "logging/comp-logging.h"
 
 #define METADATA_TEXT_SIG      "/* CTF 1.8"
 
@@ -46,12 +48,15 @@ struct range {
 };
 
 BT_HIDDEN
-bt_query_status metadata_info_query(
-               bt_self_component_class_source *comp_class,
-               const bt_value *params,
+bt_component_class_query_method_status metadata_info_query(
+               bt_self_component_class_source *self_comp_class_src,
+               const bt_value *params, bt_logging_level log_level,
                const bt_value **user_result)
 {
-       bt_query_status status = BT_QUERY_STATUS_OK;
+       bt_component_class_query_method_status status =
+               BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK;
+       bt_self_component_class *self_comp_class =
+               bt_self_component_class_source_as_self_component_class(self_comp_class_src);
        bt_value *result = NULL;
        const bt_value *path_value = NULL;
        char *metadata_text = NULL;
@@ -64,28 +69,31 @@ bt_query_status metadata_info_query(
 
        result = bt_value_map_create();
        if (!result) {
-               status = BT_QUERY_STATUS_NOMEM;
+               status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR;
                goto error;
        }
 
        BT_ASSERT(params);
 
        if (!bt_value_is_map(params)) {
-               BT_LOGE_STR("Query parameters is not a map value object.");
-               status = BT_QUERY_STATUS_INVALID_PARAMS;
+               BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
+                       "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_LOGE_STR("Mandatory `path` parameter missing");
-               status = BT_QUERY_STATUS_INVALID_PARAMS;
+               BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
+                       "Mandatory `path` parameter missing");
+               status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
                goto error;
        }
 
        if (!bt_value_is_string(path_value)) {
-               BT_LOGE_STR("`path` parameter is required to be a string value");
-               status = BT_QUERY_STATUS_INVALID_PARAMS;
+               BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
+                       "`path` parameter is required to be a string value");
+               status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
                goto error;
        }
 
@@ -94,19 +102,21 @@ bt_query_status metadata_info_query(
        BT_ASSERT(path);
        metadata_fp = ctf_fs_metadata_open_file(path);
        if (!metadata_fp) {
-               BT_LOGE("Cannot open trace metadata: path=\"%s\".", path);
+               BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
+                       "Cannot open trace metadata: path=\"%s\".", path);
                goto error;
        }
 
        is_packetized = ctf_metadata_decoder_is_packetized(metadata_fp,
-               &bo, BT_LOG_OUTPUT_LEVEL);
+               &bo, log_level, NULL);
 
        if (is_packetized) {
                ret = ctf_metadata_decoder_packetized_file_stream_to_buf(
-                       metadata_fp, &metadata_text, bo,
-                       BT_LOG_OUTPUT_LEVEL);
+                       metadata_fp, &metadata_text, bo, NULL, NULL,
+                       log_level, NULL);
                if (ret) {
-                       BT_LOGE("Cannot decode packetized metadata file: path=\"%s\"",
+                       BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
+                               "Cannot decode packetized metadata file: path=\"%s\"",
                                path);
                        goto error;
                }
@@ -115,25 +125,29 @@ bt_query_status metadata_info_query(
 
                ret = fseek(metadata_fp, 0, SEEK_END);
                if (ret) {
-                       BT_LOGE_ERRNO("Failed to seek to the end of the metadata file",
+                       BT_COMP_CLASS_LOGE_APPEND_CAUSE_ERRNO(self_comp_class,
+                               "Failed to seek to the end of the metadata file",
                                ": path=\"%s\"", path);
                        goto error;
                }
                filesize = ftell(metadata_fp);
                if (filesize < 0) {
-                       BT_LOGE_ERRNO("Failed to get the current position in the metadata file",
+                       BT_COMP_CLASS_LOGE_APPEND_CAUSE_ERRNO(self_comp_class,
+                               "Failed to get the current position in the metadata file",
                                ": path=\"%s\"", path);
                        goto error;
                }
                rewind(metadata_fp);
                metadata_text = malloc(filesize + 1);
                if (!metadata_text) {
-                       BT_LOGE_STR("Cannot allocate buffer for metadata text.");
+                       BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
+                               "Cannot allocate buffer for metadata text.");
                        goto error;
                }
 
                if (fread(metadata_text, filesize, 1, metadata_fp) != 1) {
-                       BT_LOGE_ERRNO("Cannot read metadata file", ": path=\"%s\"",
+                       BT_COMP_CLASS_LOGE_APPEND_CAUSE_ERRNO(self_comp_class,
+                               "Cannot read metadata file", ": path=\"%s\"",
                                path);
                        goto error;
                }
@@ -157,14 +171,16 @@ bt_query_status metadata_info_query(
        ret = bt_value_map_insert_string_entry(result, "text",
                g_metadata_text->str);
        if (ret) {
-               BT_LOGE_STR("Cannot insert metadata text into query result.");
+               BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
+                       "Cannot insert metadata text into query result.");
                goto error;
        }
 
        ret = bt_value_map_insert_bool_entry(result, "is-packetized",
                is_packetized);
        if (ret) {
-               BT_LOGE_STR("Cannot insert \"is-packetized\" attribute into query result.");
+               BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
+                       "Cannot insert \"is-packetized\" attribute into query result.");
                goto error;
        }
 
@@ -175,7 +191,7 @@ error:
        result = NULL;
 
        if (status >= 0) {
-               status = BT_QUERY_STATUS_ERROR;
+               status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
        }
 
 end:
@@ -198,7 +214,7 @@ int add_range(bt_value *info, struct range *range,
                const char *range_name)
 {
        int ret = 0;
-       bt_value_status status;
+       bt_value_map_insert_entry_status status;
        bt_value *range_map = NULL;
 
        if (!range->set) {
@@ -214,21 +230,21 @@ int add_range(bt_value *info, struct range *range,
 
        status = bt_value_map_insert_signed_integer_entry(range_map, "begin",
                        range->begin_ns);
-       if (status != BT_VALUE_STATUS_OK) {
+       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_STATUS_OK) {
+       if (status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
                ret = -1;
                goto end;
        }
 
        status = bt_value_map_insert_entry(info, range_name,
                range_map);
-       if (status != BT_VALUE_STATUS_OK) {
+       if (status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
                ret = -1;
                goto end;
        }
@@ -238,62 +254,15 @@ end:
        return ret;
 }
 
-static
-int add_stream_ids(bt_value *info, struct ctf_fs_ds_file_group *ds_file_group)
-{
-       int ret = 0;
-       bt_value_status status;
-
-       if (ds_file_group->stream_id != UINT64_C(-1)) {
-               status = bt_value_map_insert_unsigned_integer_entry(info, "id",
-                       ds_file_group->stream_id);
-               if (status != BT_VALUE_STATUS_OK) {
-                       ret = -1;
-                       goto end;
-               }
-       }
-
-       status = bt_value_map_insert_unsigned_integer_entry(info, "class-id",
-               ds_file_group->sc->id);
-       if (status != BT_VALUE_STATUS_OK) {
-               ret = -1;
-               goto end;
-       }
-
-end:
-       return ret;
-}
-
 static
 int populate_stream_info(struct ctf_fs_ds_file_group *group,
                bt_value *group_info, struct range *stream_range)
 {
        int ret = 0;
-       size_t file_idx;
-       bt_value_status status;
-       bt_value *file_paths;
+       bt_value_map_insert_entry_status insert_status;
        struct ctf_fs_ds_index_entry *first_ds_index_entry, *last_ds_index_entry;
        gchar *port_name = NULL;
 
-       file_paths = bt_value_array_create();
-       if (!file_paths) {
-               ret = -1;
-               goto end;
-       }
-
-       for (file_idx = 0; file_idx < group->ds_file_infos->len; file_idx++) {
-               struct ctf_fs_ds_file_info *info =
-                       g_ptr_array_index(group->ds_file_infos,
-                               file_idx);
-
-               status = bt_value_array_append_string_element(file_paths,
-                               info->path->str);
-               if (status != BT_VALUE_STATUS_OK) {
-                       ret = -1;
-                       goto end;
-               }
-       }
-
        /*
         * 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
@@ -328,33 +297,21 @@ int populate_stream_info(struct ctf_fs_ds_file_group *group,
                goto end;
        }
 
-       status = bt_value_map_insert_entry(group_info, "paths",
-               file_paths);
-       if (status != BT_VALUE_STATUS_OK) {
-               ret = -1;
-               goto end;
-       }
-
-       ret = add_stream_ids(group_info, group);
-       if (ret) {
-               goto end;
-       }
-
        port_name = ctf_fs_make_port_name(group);
        if (!port_name) {
                ret = -1;
                goto end;
        }
 
-       status = bt_value_map_insert_string_entry(group_info, "port-name",
-               port_name);
-       if (status != BT_VALUE_STATUS_OK) {
+       insert_status = bt_value_map_insert_string_entry(group_info,
+               "port-name", port_name);
+       if (insert_status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
                ret = -1;
                goto end;
        }
 
 end:
-       bt_value_put_ref(file_paths);
+       g_free(port_name);
        return ret;
 }
 
@@ -363,13 +320,9 @@ int populate_trace_info(const struct ctf_fs_trace *trace, bt_value *trace_info)
 {
        int ret = 0;
        size_t group_idx;
-       bt_value_status status;
+       bt_value_map_insert_entry_status insert_status;
+       bt_value_array_append_element_status append_status;
        bt_value *file_groups = NULL;
-       struct range trace_range = {
-               .begin_ns = INT64_MAX,
-               .end_ns = 0,
-               .set = false,
-       };
        struct range trace_intersection = {
                .begin_ns = 0,
                .end_ns = INT64_MAX,
@@ -388,19 +341,6 @@ int populate_trace_info(const struct ctf_fs_trace *trace, bt_value *trace_info)
                goto end;
        }
 
-       status = bt_value_map_insert_string_entry(trace_info, "name",
-               trace->name->str);
-       if (status != BT_VALUE_STATUS_OK) {
-               ret = -1;
-               goto end;
-       }
-       status = bt_value_map_insert_string_entry(trace_info, "path",
-               trace->path->str);
-       if (status != BT_VALUE_STATUS_OK) {
-               ret = -1;
-               goto end;
-       }
-
        /* Find range of all stream groups, and of the trace. */
        for (group_idx = 0; group_idx < trace->ds_file_groups->len;
                        group_idx++) {
@@ -421,19 +361,14 @@ int populate_trace_info(const struct ctf_fs_trace *trace, bt_value *trace_info)
                        goto end;
                }
 
-               status = bt_value_array_append_element(file_groups, group_info);
+               append_status = bt_value_array_append_element(file_groups,
+                       group_info);
                bt_value_put_ref(group_info);
-               if (status != BT_VALUE_STATUS_OK) {
+               if (append_status != BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK) {
                        goto end;
                }
 
                if (group_range.set) {
-                       trace_range.begin_ns = MIN(trace_range.begin_ns,
-                                       group_range.begin_ns);
-                       trace_range.end_ns = MAX(trace_range.end_ns,
-                                       group_range.end_ns);
-                       trace_range.set = true;
-
                        trace_intersection.begin_ns = MAX(trace_intersection.begin_ns,
                                        group_range.begin_ns);
                        trace_intersection.end_ns = MIN(trace_intersection.end_ns,
@@ -442,11 +377,6 @@ int populate_trace_info(const struct ctf_fs_trace *trace, bt_value *trace_info)
                }
        }
 
-       ret = add_range(trace_info, &trace_range, "range-ns");
-       if (ret) {
-               goto end;
-       }
-
        if (trace_intersection.begin_ns < trace_intersection.end_ns) {
                ret = add_range(trace_info, &trace_intersection,
                                "intersection-range-ns");
@@ -455,10 +385,10 @@ int populate_trace_info(const struct ctf_fs_trace *trace, bt_value *trace_info)
                }
        }
 
-       status = bt_value_map_insert_entry(trace_info, "streams",
+       insert_status = bt_value_map_insert_entry(trace_info, "streams",
                file_groups);
        BT_VALUE_PUT_REF_AND_RESET(file_groups);
-       if (status != BT_VALUE_STATUS_OK) {
+       if (insert_status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
                ret = -1;
                goto end;
        }
@@ -469,57 +399,65 @@ end:
 }
 
 BT_HIDDEN
-bt_query_status trace_info_query(
-               bt_self_component_class_source *comp_class,
-               const bt_value *params,
+bt_component_class_query_method_status trace_info_query(
+               bt_self_component_class_source *self_comp_class_src,
+               const bt_value *params, bt_logging_level log_level,
                const bt_value **user_result)
 {
        struct ctf_fs_component *ctf_fs = NULL;
-       bt_query_status status = BT_QUERY_STATUS_OK;
+       bt_component_class_query_method_status status =
+               BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK;
+       bt_self_component_class *self_comp_class =
+               bt_self_component_class_source_as_self_component_class(
+                       self_comp_class_src);
        bt_value *result = NULL;
-       const bt_value *paths_value = NULL;
+       const bt_value *inputs_value = NULL;
        int ret = 0;
        guint i;
 
        BT_ASSERT(params);
 
        if (!bt_value_is_map(params)) {
-               BT_LOGE("Query parameters is not a map value object.");
-               status = BT_QUERY_STATUS_INVALID_PARAMS;
+               BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
+                       "Query parameters is not a map value object.");
+               status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
                goto error;
        }
 
-       ctf_fs = ctf_fs_component_create();
+       ctf_fs = ctf_fs_component_create(log_level, NULL);
        if (!ctf_fs) {
                goto error;
        }
 
-       if (!read_src_fs_parameters(params, &paths_value, ctf_fs)) {
-               status = BT_QUERY_STATUS_INVALID_PARAMS;
+       if (!read_src_fs_parameters(params, &inputs_value, ctf_fs, NULL,
+                       self_comp_class)) {
+               status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
                goto error;
        }
 
-       if (ctf_fs_component_create_ctf_fs_traces(NULL, ctf_fs, paths_value)) {
+       if (ctf_fs_component_create_ctf_fs_traces(ctf_fs, inputs_value, NULL,
+                       self_comp_class)) {
                goto error;
        }
 
        result = bt_value_array_create();
        if (!result) {
-               status = BT_QUERY_STATUS_NOMEM;
+               status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR;
                goto error;
        }
 
        for (i = 0; i < ctf_fs->traces->len; i++) {
                struct ctf_fs_trace *trace;
                bt_value *trace_info;
-               bt_value_status status;
+               bt_value_array_append_element_status append_status;
 
                trace = g_ptr_array_index(ctf_fs->traces, i);
                BT_ASSERT(trace);
 
                trace_info = bt_value_map_create();
                if (!trace_info) {
-                       BT_LOGE("Failed to create trace info map.");
+                       BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
+                               "Failed to create trace info map.");
                        goto error;
                }
 
@@ -529,9 +467,10 @@ bt_query_status trace_info_query(
                        goto error;
                }
 
-               status = bt_value_array_append_element(result, trace_info);
+               append_status = bt_value_array_append_element(result,
+                       trace_info);
                bt_value_put_ref(trace_info);
-               if (status != BT_VALUE_STATUS_OK) {
+               if (append_status != BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK) {
                        goto error;
                }
        }
@@ -543,7 +482,7 @@ error:
        result = NULL;
 
        if (status >= 0) {
-               status = BT_QUERY_STATUS_ERROR;
+               status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
        }
 
 end:
@@ -555,3 +494,76 @@ end:
        *user_result = result;
        return status;
 }
+
+BT_HIDDEN
+bt_component_class_query_method_status support_info_query(
+               bt_self_component_class_source *comp_class,
+               const bt_value *params, bt_logging_level log_level,
+               const bt_value **user_result)
+{
+       const bt_value *input_type_value;
+       const char *input_type;
+       bt_component_class_query_method_status status;
+       double weight = 0;
+       gchar *metadata_path = NULL;
+       bt_value *result = NULL;
+
+       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);
+
+       result = bt_value_map_create();
+       if (!result) {
+               status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR;
+               goto end;
+       }
+
+       if (strcmp(input_type, "directory") == 0) {
+               const bt_value *input_value;
+               const char *path;
+
+               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);
+               path = bt_value_string_get(input_value);
+
+               metadata_path = g_build_filename(path, CTF_FS_METADATA_FILENAME, NULL);
+               if (!metadata_path) {
+                       status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR;
+                       goto end;
+               }
+
+               /*
+                * If the metadata file exists in this directory, consider it to
+                * be a CTF trace.
+                */
+               if (g_file_test(metadata_path, G_FILE_TEST_EXISTS)) {
+                       weight = 0.5;
+               }
+       }
+
+       if (bt_value_map_insert_real_entry(result, "weight", weight) != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
+               status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR;
+               goto end;
+       }
+
+       /*
+        * Use the arbitrary constant string "ctf" as the group, such that all
+        * found ctf traces are passed to the same instance of src.ctf.fs.
+        */
+       if (bt_value_map_insert_string_entry(result, "group", "ctf") != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
+               status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR;
+               goto end;
+       }
+
+       *user_result = result;
+       result = NULL;
+       status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK;
+
+end:
+       g_free(metadata_path);
+       bt_value_put_ref(result);
+
+       return status;
+}
This page took 0.031683 seconds and 4 git commands to generate.