Values API: standardize parameters and return values
[babeltrace.git] / plugins / ctf / fs-src / query.c
index ca7c3560b78e80b31d0b33f026842c7c408374a7..2a587d7b97715790059b8d5da855241f7c68e9c7 100644 (file)
 
 #include "query.h"
 #include <stdbool.h>
-#include <assert.h>
+#include <babeltrace/assert-internal.h>
 #include "metadata.h"
 #include "../common/metadata/decoder.h"
 #include <babeltrace/common-internal.h>
 #include <babeltrace/babeltrace-internal.h>
-#include <babeltrace/ctf-ir/stream.h>
+#include <babeltrace/babeltrace.h>
 #include "fs.h"
 
 #define BT_LOG_TAG "PLUGIN-CTF-FS-QUERY-SRC"
@@ -46,10 +46,16 @@ struct range {
 };
 
 BT_HIDDEN
-struct bt_value *metadata_info_query(struct bt_component_class *comp_class,
+struct bt_component_class_query_method_return metadata_info_query(
+               struct bt_component_class *comp_class,
                struct bt_value *params)
 {
-       struct bt_value *result = NULL;
+       struct bt_component_class_query_method_return query_ret = {
+               .result = NULL,
+               .status = BT_QUERY_STATUS_OK,
+       };
+
+       struct bt_private_value *result = NULL;
        struct bt_value *path_value = NULL;
        char *metadata_text = NULL;
        FILE *metadata_fp = NULL;
@@ -59,24 +65,25 @@ struct bt_value *metadata_info_query(struct bt_component_class *comp_class,
        const char *path;
        bool is_packetized;
 
-       result = bt_value_map_create();
+       result = bt_private_value_map_create();
        if (!result) {
+               query_ret.status = BT_QUERY_STATUS_NOMEM;
                goto error;
        }
 
+       query_ret.result = bt_value_borrow_from_private(result);
+       BT_ASSERT(params);
+
        if (!bt_value_is_map(params)) {
                BT_LOGE_STR("Query parameters is not a map value object.");
+               query_ret.status = BT_QUERY_STATUS_INVALID_PARAMS;
                goto error;
        }
 
-       path_value = bt_value_map_get(params, "path");
-       ret = bt_value_string_get(path_value, &path);
-       if (ret) {
-               BT_LOGE_STR("Cannot get `path` string parameter.");
-               goto error;
-       }
+       path_value = bt_value_map_borrow_entry_value(params, "path");
+       path = bt_value_string_get(path_value);
 
-       assert(path);
+       BT_ASSERT(path);
        metadata_fp = ctf_fs_metadata_open_file(path);
        if (!metadata_fp) {
                BT_LOGE("Cannot open trace metadata: path=\"%s\".", path);
@@ -138,14 +145,14 @@ struct bt_value *metadata_info_query(struct bt_component_class *comp_class,
 
        g_string_append(g_metadata_text, metadata_text);
 
-       ret = bt_value_map_insert_string(result, "text",
+       ret = bt_private_value_map_insert_string_entry(result, "text",
                g_metadata_text->str);
        if (ret) {
                BT_LOGE_STR("Cannot insert metadata text into query result.");
                goto error;
        }
 
-       ret = bt_value_map_insert_bool(result, "is-packetized",
+       ret = bt_private_value_map_insert_bool_entry(result, "is-packetized",
                is_packetized);
        if (ret) {
                BT_LOGE_STR("Cannot insert \"is-packetized\" attribute into query result.");
@@ -155,10 +162,14 @@ struct bt_value *metadata_info_query(struct bt_component_class *comp_class,
        goto end;
 
 error:
-       BT_PUT(result);
+       BT_OBJECT_PUT_REF_AND_RESET(result);
+       query_ret.result = NULL;
+
+       if (query_ret.status >= 0) {
+               query_ret.status = BT_QUERY_STATUS_ERROR;
+       }
 
 end:
-       bt_put(path_value);
        free(metadata_text);
 
        if (g_metadata_text) {
@@ -168,62 +179,66 @@ end:
        if (metadata_fp) {
                fclose(metadata_fp);
        }
-       return result;
+
+       return query_ret;
 }
+
 static
-int add_range(struct bt_value *info, struct range *range,
+int add_range(struct bt_private_value *info, struct range *range,
                const char *range_name)
 {
        int ret = 0;
        enum bt_value_status status;
-       struct bt_value *range_map = NULL;
+       struct bt_private_value *range_map = NULL;
 
        if (!range->set) {
                /* Not an error. */
                goto end;
        }
 
-       range_map = bt_value_map_create();
+       range_map = bt_private_value_map_create();
        if (!range_map) {
                ret = -1;
                goto end;
        }
 
-       status = bt_value_map_insert_integer(range_map, "begin",
+       status = bt_private_value_map_insert_integer_entry(range_map, "begin",
                        range->begin_ns);
        if (status != BT_VALUE_STATUS_OK) {
                ret = -1;
                goto end;
        }
 
-       status = bt_value_map_insert_integer(range_map, "end",
+       status = bt_private_value_map_insert_integer_entry(range_map, "end",
                        range->end_ns);
        if (status != BT_VALUE_STATUS_OK) {
                ret = -1;
                goto end;
        }
 
-       status = bt_value_map_insert(info, range_name, range_map);
+       status = bt_private_value_map_insert_entry(info, range_name,
+               bt_value_borrow_from_private(range_map));
        if (status != BT_VALUE_STATUS_OK) {
                ret = -1;
                goto end;
        }
+
 end:
-       bt_put(range_map);
+       bt_object_put_ref(range_map);
        return ret;
 }
 
 static
-int add_stream_ids(struct bt_value *info, struct bt_ctf_stream *stream)
+int add_stream_ids(struct bt_private_value *info, struct bt_stream *stream)
 {
        int ret = 0;
        int64_t stream_class_id, stream_instance_id;
        enum bt_value_status status;
-       struct bt_ctf_stream_class *stream_class = NULL;
+       struct bt_stream_class *stream_class = NULL;
 
-       stream_instance_id = bt_ctf_stream_get_id(stream);
+       stream_instance_id = bt_stream_get_id(stream);
        if (stream_instance_id != -1) {
-               status = bt_value_map_insert_integer(info, "id",
+               status = bt_private_value_map_insert_integer_entry(info, "id",
                                stream_instance_id);
                if (status != BT_VALUE_STATUS_OK) {
                        ret = -1;
@@ -231,42 +246,42 @@ int add_stream_ids(struct bt_value *info, struct bt_ctf_stream *stream)
                }
        }
 
-       stream_class = bt_ctf_stream_get_class(stream);
+       stream_class = bt_stream_borrow_class(stream);
        if (!stream_class) {
                ret = -1;
                goto end;
        }
 
-       stream_class_id = bt_ctf_stream_class_get_id(stream_class);
+       stream_class_id = bt_stream_class_get_id(stream_class);
        if (stream_class_id == -1) {
                ret = -1;
                goto end;
        }
 
-       status = bt_value_map_insert_integer(info, "class-id", stream_class_id);
+       status = bt_private_value_map_insert_integer_entry(info, "class-id", stream_class_id);
        if (status != BT_VALUE_STATUS_OK) {
                ret = -1;
                goto end;
        }
+
 end:
-       bt_put(stream_class);
        return ret;
 }
 
 static
 int populate_stream_info(struct ctf_fs_ds_file_group *group,
-               struct bt_value *group_info,
+               struct bt_private_value *group_info,
                struct range *stream_range)
 {
        int ret = 0;
        size_t file_idx;
        enum bt_value_status status;
-       struct bt_value *file_paths;
+       struct bt_private_value *file_paths;
 
        stream_range->begin_ns = INT64_MAX;
        stream_range->end_ns = 0;
 
-       file_paths = bt_value_array_create();
+       file_paths = bt_private_value_array_create();
        if (!file_paths) {
                ret = -1;
                goto end;
@@ -285,7 +300,7 @@ int populate_stream_info(struct ctf_fs_ds_file_group *group,
                        goto end;
                }
 
-               status = bt_value_array_append_string(file_paths,
+               status = bt_private_value_array_append_string_element(file_paths,
                                info->path->str);
                if (status != BT_VALUE_STATUS_OK) {
                        ret = -1;
@@ -313,7 +328,8 @@ int populate_stream_info(struct ctf_fs_ds_file_group *group,
                }
        }
 
-       status = bt_value_map_insert(group_info, "paths", file_paths);
+       status = bt_private_value_map_insert_entry(group_info, "paths",
+               bt_value_borrow_from_private(file_paths));
        if (status != BT_VALUE_STATUS_OK) {
                ret = -1;
                goto end;
@@ -324,19 +340,19 @@ int populate_stream_info(struct ctf_fs_ds_file_group *group,
                goto end;
        }
 end:
-       bt_put(file_paths);
+       bt_object_put_ref(file_paths);
        return ret;
 }
 
 static
 int populate_trace_info(const char *trace_path, const char *trace_name,
-               struct bt_value *trace_info)
+               struct bt_private_value *trace_info)
 {
        int ret = 0;
        size_t group_idx;
        struct ctf_fs_trace *trace = NULL;
        enum bt_value_status status;
-       struct bt_value *file_groups;
+       struct bt_private_value *file_groups;
        struct range trace_range = {
                .begin_ns = INT64_MAX,
                .end_ns = 0,
@@ -348,32 +364,32 @@ int populate_trace_info(const char *trace_path, const char *trace_name,
                .set = false,
        };
 
-       file_groups = bt_value_array_create();
+       file_groups = bt_private_value_array_create();
        if (!file_groups) {
                goto end;
        }
 
-       status = bt_value_map_insert_string(trace_info, "name",
-                       trace_name);
+       status = bt_private_value_map_insert_string_entry(trace_info, "name",
+               trace_name);
        if (status != BT_VALUE_STATUS_OK) {
                ret = -1;
                goto end;
        }
-       status = bt_value_map_insert_string(trace_info, "path",
+       status = bt_private_value_map_insert_string_entry(trace_info, "path",
                        trace_path);
        if (status != BT_VALUE_STATUS_OK) {
                ret = -1;
                goto end;
        }
 
-       trace = ctf_fs_trace_create(trace_path, trace_name, NULL);
+       trace = ctf_fs_trace_create(trace_path, trace_name, NULL, NULL);
        if (!trace) {
                BT_LOGE("Failed to create fs trace at \'%s\'", trace_path);
                ret = -1;
                goto end;
        }
 
-       assert(trace->ds_file_groups);
+       BT_ASSERT(trace->ds_file_groups);
        /* Add trace range info only if it contains streams. */
        if (trace->ds_file_groups->len == 0) {
                ret = -1;
@@ -383,12 +399,12 @@ int populate_trace_info(const char *trace_path, const char *trace_name,
        /* Find range of all stream groups, and of the trace. */
        for (group_idx = 0; group_idx < trace->ds_file_groups->len;
                        group_idx++) {
-               struct bt_value *group_info;
+               struct bt_private_value *group_info;
                struct range group_range = { .set = false };
                struct ctf_fs_ds_file_group *group = g_ptr_array_index(
                                trace->ds_file_groups, group_idx);
 
-               group_info = bt_value_map_create();
+               group_info = bt_private_value_map_create();
                if (!group_info) {
                        ret = -1;
                        goto end;
@@ -396,7 +412,7 @@ int populate_trace_info(const char *trace_path, const char *trace_name,
 
                ret = populate_stream_info(group, group_info, &group_range);
                if (ret) {
-                       bt_put(group_info);
+                       bt_object_put_ref(group_info);
                        goto end;
                }
 
@@ -412,8 +428,10 @@ int populate_trace_info(const char *trace_path, const char *trace_name,
                        trace_intersection.end_ns = min(trace_intersection.end_ns,
                                        group_range.end_ns);
                        trace_intersection.set = true;
-                       status = bt_value_array_append(file_groups, group_info);
-                       bt_put(group_info);
+                       status = bt_private_value_array_append_element(
+                               file_groups,
+                               bt_value_borrow_from_private(group_info));
+                       bt_object_put_ref(group_info);
                        if (status != BT_VALUE_STATUS_OK) {
                                goto end;
                        }
@@ -424,30 +442,40 @@ int populate_trace_info(const char *trace_path, const char *trace_name,
        if (ret) {
                goto end;
        }
-       ret = add_range(trace_info, &trace_intersection,
-                       "intersection-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");
+               if (ret) {
+                       goto end;
+               }
        }
 
-       status = bt_value_map_insert(trace_info, "streams", file_groups);
-       BT_PUT(file_groups);
+       status = bt_private_value_map_insert_entry(trace_info, "streams",
+               bt_value_borrow_from_private(file_groups));
+       BT_OBJECT_PUT_REF_AND_RESET(file_groups);
        if (status != BT_VALUE_STATUS_OK) {
                ret = -1;
                goto end;
        }
 
 end:
-       bt_put(file_groups);
+       bt_object_put_ref(file_groups);
        ctf_fs_trace_destroy(trace);
        return ret;
 }
 
 BT_HIDDEN
-struct bt_value *trace_info_query(struct bt_component_class *comp_class,
+struct bt_component_class_query_method_return trace_info_query(
+               struct bt_component_class *comp_class,
                struct bt_value *params)
 {
-       struct bt_value *trace_infos = NULL;
+       struct bt_component_class_query_method_return query_ret = {
+               .result = NULL,
+               .status = BT_QUERY_STATUS_OK,
+       };
+
+       struct bt_private_value *result = NULL;
        struct bt_value *path_value = NULL;
        int ret = 0;
        const char *path = NULL;
@@ -457,24 +485,23 @@ struct bt_value *trace_info_query(struct bt_component_class *comp_class,
        GList *tn_node = NULL;
        GString *normalized_path = NULL;
 
+       BT_ASSERT(params);
+
        if (!bt_value_is_map(params)) {
                BT_LOGE("Query parameters is not a map value object.");
+               query_ret.status = BT_QUERY_STATUS_INVALID_PARAMS;
                goto error;
        }
 
-       path_value = bt_value_map_get(params, "path");
-       ret = bt_value_string_get(path_value, &path);
-       if (ret) {
-               BT_LOGE("Cannot get `path` string parameter.");
-               goto error;
-       }
+       path_value = bt_value_map_borrow_entry_value(params, "path");
+       path = bt_value_string_get(path_value);
 
        normalized_path = bt_common_normalize_path(path, NULL);
        if (!normalized_path) {
                BT_LOGE("Failed to normalize path: `%s`.", path);
                goto error;
        }
-       assert(path);
+       BT_ASSERT(path);
 
        ret = ctf_fs_find_traces(&trace_paths, normalized_path->str);
        if (ret) {
@@ -488,11 +515,14 @@ struct bt_value *trace_info_query(struct bt_component_class *comp_class,
                goto error;
        }
 
-       trace_infos = bt_value_array_create();
-       if (!trace_infos) {
+       result = bt_private_value_array_create();
+       if (!result) {
+               query_ret.status = BT_QUERY_STATUS_NOMEM;
                goto error;
        }
 
+       query_ret.result = bt_value_borrow_from_private(result);
+
        /* Iterates over both trace paths and names simultaneously. */
        for (tp_node = trace_paths, tn_node = trace_names; tp_node;
                        tp_node = g_list_next(tp_node),
@@ -500,9 +530,9 @@ struct bt_value *trace_info_query(struct bt_component_class *comp_class,
                GString *trace_path = tp_node->data;
                GString *trace_name = tn_node->data;
                enum bt_value_status status;
-               struct bt_value *trace_info;
+               struct bt_private_value *trace_info;
 
-               trace_info = bt_value_map_create();
+               trace_info = bt_private_value_map_create();
                if (!trace_info) {
                        BT_LOGE("Failed to create trace info map.");
                        goto error;
@@ -511,12 +541,13 @@ struct bt_value *trace_info_query(struct bt_component_class *comp_class,
                ret = populate_trace_info(trace_path->str, trace_name->str,
                        trace_info);
                if (ret) {
-                       bt_put(trace_info);
+                       bt_object_put_ref(trace_info);
                        goto error;
                }
 
-               status = bt_value_array_append(trace_infos, trace_info);
-               bt_put(trace_info);
+               status = bt_private_value_array_append_element(result,
+                       bt_value_borrow_from_private(trace_info));
+               bt_object_put_ref(trace_info);
                if (status != BT_VALUE_STATUS_OK) {
                        goto error;
                }
@@ -525,7 +556,13 @@ struct bt_value *trace_info_query(struct bt_component_class *comp_class,
        goto end;
 
 error:
-       BT_PUT(trace_infos);
+       BT_OBJECT_PUT_REF_AND_RESET(result);
+       query_ret.result = NULL;
+
+       if (query_ret.status >= 0) {
+               query_ret.status = BT_QUERY_STATUS_ERROR;
+       }
+
 end:
        if (normalized_path) {
                g_string_free(normalized_path, TRUE);
@@ -547,6 +584,5 @@ end:
                g_list_free(trace_names);
        }
        /* "path" becomes invalid with the release of path_value. */
-       bt_put(path_value);
-       return trace_infos;
+       return query_ret;
 }
This page took 0.030012 seconds and 4 git commands to generate.