Cleanup: missing empty line between functions
[babeltrace.git] / plugins / ctf / fs-src / query.c
index 60ec42e1036817b30e06675cdf6e1d8c3dd85f30..b037f609b7c57c6371e14e77d08697dd0a38744e 100644 (file)
 #include <assert.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 "fs.h"
+
+#define BT_LOG_TAG "PLUGIN-CTF-FS-QUERY-SRC"
+#include "logging.h"
 
 #define METADATA_TEXT_SIG      "/* CTF 1.8"
 
+struct range {
+       int64_t begin_ns;
+       int64_t end_ns;
+       bool set;
+};
+
 BT_HIDDEN
 struct bt_value *metadata_info_query(struct bt_component_class *comp_class,
                struct bt_value *params)
 {
-       struct bt_value *results = NULL;
+       struct bt_value *result = NULL;
        struct bt_value *path_value = NULL;
        char *metadata_text = NULL;
        FILE *metadata_fp = NULL;
@@ -46,30 +59,27 @@ struct bt_value *metadata_info_query(struct bt_component_class *comp_class,
        const char *path;
        bool is_packetized;
 
-       results = bt_value_map_create();
-       if (!results) {
+       result = bt_value_map_create();
+       if (!result) {
                goto error;
        }
 
        if (!bt_value_is_map(params)) {
-               fprintf(stderr,
-                       "Query parameters is not a map value object\n");
+               BT_LOGE_STR("Query parameters is not a map value object.");
                goto error;
        }
 
        path_value = bt_value_map_get(params, "path");
        ret = bt_value_string_get(path_value, &path);
        if (ret) {
-               fprintf(stderr,
-                       "Cannot get `path` string parameter\n");
+               BT_LOGE_STR("Cannot get `path` string parameter.");
                goto error;
        }
 
        assert(path);
        metadata_fp = ctf_fs_metadata_open_file(path);
        if (!metadata_fp) {
-               fprintf(stderr,
-                       "Cannot open trace at path `%s`\n", path);
+               BT_LOGE("Cannot open trace metadata: path=\"%s\".", path);
                goto error;
        }
 
@@ -80,26 +90,35 @@ struct bt_value *metadata_info_query(struct bt_component_class *comp_class,
                ret = ctf_metadata_decoder_packetized_file_stream_to_buf(
                        metadata_fp, &metadata_text, bo);
                if (ret) {
-                       fprintf(stderr,
-                               "Cannot decode packetized metadata file\n");
+                       BT_LOGE("Cannot decode packetized metadata file: path=\"%s\"",
+                               path);
                        goto error;
                }
        } else {
                long filesize;
 
-               fseek(metadata_fp, 0, SEEK_END);
+               ret = fseek(metadata_fp, 0, SEEK_END);
+               if (ret) {
+                       BT_LOGE_ERRNO("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",
+                               ": path=\"%s\"", path);
+                       goto error;
+               }
                rewind(metadata_fp);
                metadata_text = malloc(filesize + 1);
                if (!metadata_text) {
-                       fprintf(stderr,
-                               "Cannot allocate buffer for metadata text\n");
+                       BT_LOGE_STR("Cannot allocate buffer for metadata text.");
                        goto error;
                }
 
                if (fread(metadata_text, filesize, 1, metadata_fp) != 1) {
-                       fprintf(stderr,
-                               "Cannot read metadata file\n");
+                       BT_LOGE_ERRNO("Cannot read metadata file", ": path=\"%s\"",
+                               path);
                        goto error;
                }
 
@@ -119,24 +138,24 @@ 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(results, "text",
+       ret = bt_value_map_insert_string(result, "text",
                g_metadata_text->str);
        if (ret) {
-               fprintf(stderr, "Cannot insert metadata text into results\n");
+               BT_LOGE_STR("Cannot insert metadata text into query result.");
                goto error;
        }
 
-       ret = bt_value_map_insert_bool(results, "is-packetized",
+       ret = bt_value_map_insert_bool(result, "is-packetized",
                is_packetized);
        if (ret) {
-               fprintf(stderr, "Cannot insert is packetized into results\n");
+               BT_LOGE_STR("Cannot insert \"is-packetized\" attribute into query result.");
                goto error;
        }
 
        goto end;
 
 error:
-       BT_PUT(results);
+       BT_PUT(result);
 
 end:
        bt_put(path_value);
@@ -149,5 +168,386 @@ end:
        if (metadata_fp) {
                fclose(metadata_fp);
        }
-       return results;
+       return result;
+}
+
+static
+int add_range(struct bt_value *info, struct range *range,
+               const char *range_name)
+{
+       int ret = 0;
+       enum bt_value_status status;
+       struct bt_value *range_map = NULL;
+
+       if (!range->set) {
+               /* Not an error. */
+               goto end;
+       }
+
+       range_map = bt_value_map_create();
+       if (!range_map) {
+               ret = -1;
+               goto end;
+       }
+
+       status = bt_value_map_insert_integer(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",
+                       range->end_ns);
+       if (status != BT_VALUE_STATUS_OK) {
+               ret = -1;
+               goto end;
+       }
+
+       status = bt_value_map_insert(info, range_name, range_map);
+       if (status != BT_VALUE_STATUS_OK) {
+               ret = -1;
+               goto end;
+       }
+end:
+       bt_put(range_map);
+       return ret;
+}
+
+static
+int add_stream_ids(struct bt_value *info, struct bt_ctf_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;
+
+       stream_instance_id = bt_ctf_stream_get_id(stream);
+       if (stream_instance_id != -1) {
+               status = bt_value_map_insert_integer(info, "id",
+                               stream_instance_id);
+               if (status != BT_VALUE_STATUS_OK) {
+                       ret = -1;
+                       goto end;
+               }
+       }
+
+       stream_class = bt_ctf_stream_get_class(stream);
+       if (!stream_class) {
+               ret = -1;
+               goto end;
+       }
+
+       stream_class_id = bt_ctf_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);
+       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 range *stream_range)
+{
+       int ret = 0;
+       size_t file_idx;
+       enum bt_value_status status;
+       struct bt_value *file_paths;
+
+       stream_range->begin_ns = INT64_MAX;
+       stream_range->end_ns = 0;
+
+       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++) {
+               int64_t file_begin_epoch, file_end_epoch;
+               struct ctf_fs_ds_file_info *info =
+                               g_ptr_array_index(group->ds_file_infos,
+                                       file_idx);
+
+               if (!info->index || info->index->entries->len == 0) {
+                       BT_LOGW("Cannot determine range of unindexed stream file \'%s\'",
+                               info->path->str);
+                       ret = -1;
+                       goto end;
+               }
+
+               status = bt_value_array_append_string(file_paths,
+                               info->path->str);
+               if (status != BT_VALUE_STATUS_OK) {
+                       ret = -1;
+                       goto end;
+               }
+
+               /*
+                * file range is from timestamp_begin of the first entry to the
+                * timestamp_end of the last entry.
+                */
+               file_begin_epoch = ((struct ctf_fs_ds_index_entry *) &g_array_index(info->index->entries,
+                               struct ctf_fs_ds_index_entry, 0))->timestamp_begin_ns;
+               file_end_epoch = ((struct ctf_fs_ds_index_entry *) &g_array_index(info->index->entries,
+                               struct ctf_fs_ds_index_entry, info->index->entries->len - 1))->timestamp_end_ns;
+
+               stream_range->begin_ns = min(stream_range->begin_ns, file_begin_epoch);
+               stream_range->end_ns = max(stream_range->end_ns, file_end_epoch);
+               stream_range->set = true;
+       }
+
+       if (stream_range->set) {
+               ret = add_range(group_info, stream_range, "range-ns");
+               if (ret) {
+                       goto end;
+               }
+       }
+
+       status = bt_value_map_insert(group_info, "paths", file_paths);
+       if (status != BT_VALUE_STATUS_OK) {
+               ret = -1;
+               goto end;
+       }
+
+       ret = add_stream_ids(group_info, group->stream);
+       if (ret) {
+               goto end;
+       }
+end:
+       bt_put(file_paths);
+       return ret;
+}
+
+static
+int populate_trace_info(const char *trace_path, const char *trace_name,
+               struct bt_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 range trace_range = {
+               .begin_ns = INT64_MAX,
+               .end_ns = 0,
+               .set = false,
+       };
+       struct range trace_intersection = {
+               .begin_ns = 0,
+               .end_ns = INT64_MAX,
+               .set = false,
+       };
+
+       file_groups = bt_value_array_create();
+       if (!file_groups) {
+               goto end;
+       }
+
+       status = bt_value_map_insert_string(trace_info, "name",
+                       trace_name);
+       if (status != BT_VALUE_STATUS_OK) {
+               ret = -1;
+               goto end;
+       }
+       status = bt_value_map_insert_string(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);
+       if (!trace) {
+               BT_LOGE("Failed to create fs trace at \'%s\'", trace_path);
+               ret = -1;
+               goto end;
+       }
+
+       assert(trace->ds_file_groups);
+       /* Add trace range info only if it contains streams. */
+       if (trace->ds_file_groups->len == 0) {
+               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++) {
+               struct bt_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();
+               if (!group_info) {
+                       ret = -1;
+                       goto end;
+               }
+
+               ret = populate_stream_info(group, group_info, &group_range);
+               if (ret) {
+                       bt_put(group_info);
+                       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,
+                                       group_range.end_ns);
+                       trace_intersection.set = true;
+                       status = bt_value_array_append(file_groups, group_info);
+                       bt_put(group_info);
+                       if (status != BT_VALUE_STATUS_OK) {
+                               goto end;
+                       }
+               }
+       }
+
+       ret = add_range(trace_info, &trace_range, "range-ns");
+       if (ret) {
+               goto end;
+       }
+       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);
+       if (status != BT_VALUE_STATUS_OK) {
+               ret = -1;
+               goto end;
+       }
+
+end:
+       bt_put(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_value *params)
+{
+       struct bt_value *trace_infos = NULL;
+       struct bt_value *path_value = NULL;
+       int ret = 0;
+       const char *path = NULL;
+       GList *trace_paths = NULL;
+       GList *trace_names = NULL;
+       GList *tp_node = NULL;
+       GList *tn_node = NULL;
+       GString *normalized_path = NULL;
+
+       if (!bt_value_is_map(params)) {
+               BT_LOGE("Query parameters is not a map value object.");
+               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;
+       }
+
+       normalized_path = bt_common_normalize_path(path, NULL);
+       if (!normalized_path) {
+               BT_LOGE("Failed to normalize path: `%s`.", path);
+               goto error;
+       }
+       assert(path);
+
+       ret = ctf_fs_find_traces(&trace_paths, normalized_path->str);
+       if (ret) {
+               goto error;
+       }
+
+       trace_names = ctf_fs_create_trace_names(trace_paths,
+               normalized_path->str);
+       if (!trace_names) {
+               BT_LOGE("Cannot create trace names from trace paths.");
+               goto error;
+       }
+
+       trace_infos = bt_value_array_create();
+       if (!trace_infos) {
+               goto error;
+       }
+
+       /* 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),
+                       tn_node = g_list_next(tn_node)) {
+               GString *trace_path = tp_node->data;
+               GString *trace_name = tn_node->data;
+               enum bt_value_status status;
+               struct bt_value *trace_info;
+
+               trace_info = bt_value_map_create();
+               if (!trace_info) {
+                       BT_LOGE("Failed to create trace info map.");
+                       goto error;
+               }
+
+               ret = populate_trace_info(trace_path->str, trace_name->str,
+                       trace_info);
+               if (ret) {
+                       bt_put(trace_info);
+                       goto error;
+               }
+
+               status = bt_value_array_append(trace_infos, trace_info);
+               bt_put(trace_info);
+               if (status != BT_VALUE_STATUS_OK) {
+                       goto error;
+               }
+       }
+
+       goto end;
+
+error:
+       BT_PUT(trace_infos);
+end:
+       if (normalized_path) {
+               g_string_free(normalized_path, TRUE);
+       }
+       if (trace_paths) {
+               for (tp_node = trace_paths; tp_node; tp_node = g_list_next(tp_node)) {
+                       if (tp_node->data) {
+                               g_string_free(tp_node->data, TRUE);
+                       }
+               }
+               g_list_free(trace_paths);
+       }
+       if (trace_names) {
+               for (tn_node = trace_names; tn_node; tn_node = g_list_next(tn_node)) {
+                       if (tn_node->data) {
+                               g_string_free(tn_node->data, TRUE);
+                       }
+               }
+               g_list_free(trace_names);
+       }
+       /* "path" becomes invalid with the release of path_value. */
+       bt_put(path_value);
+       return trace_infos;
 }
This page took 0.030695 seconds and 4 git commands to generate.