Cleanup: Dead assignments
[babeltrace.git] / src / cli / babeltrace2.c
index e32e1a0930f63160c3dbff47f2cea5305dd77dbc..378fff8a1c9f2e52da6bb6b04c3fd34450109bb9 100644 (file)
@@ -277,43 +277,55 @@ void print_value(FILE *, const bt_value *, size_t);
 static
 void print_value_rec(FILE *, const bt_value *, size_t);
 
-struct print_map_value_data {
-       size_t indent;
-       FILE *fp;
-};
-
 static
-bt_bool print_map_value(const char *key, const bt_value *object,
-               void *data)
+void print_map_value(const char *key, const bt_value *object, FILE *fp,
+               size_t indent)
 {
-       struct print_map_value_data *print_map_value_data = data;
-
-       print_indent(print_map_value_data->fp, print_map_value_data->indent);
-       fprintf(print_map_value_data->fp, "%s: ", key);
+       print_indent(fp, indent);
+       fprintf(fp, "%s: ", key);
        BT_ASSERT(object);
 
        if (bt_value_is_array(object) &&
                        bt_value_array_is_empty(object)) {
-               fprintf(print_map_value_data->fp, "[ ]\n");
-               return true;
+               fprintf(fp, "[ ]\n");
+               goto end;
        }
 
        if (bt_value_is_map(object) &&
                        bt_value_map_is_empty(object)) {
-               fprintf(print_map_value_data->fp, "{ }\n");
-               return true;
+               fprintf(fp, "{ }\n");
+               goto end;
        }
 
        if (bt_value_is_array(object) ||
                        bt_value_is_map(object)) {
-               fprintf(print_map_value_data->fp, "\n");
+               fprintf(fp, "\n");
        }
 
-       print_value_rec(print_map_value_data->fp, object,
-               print_map_value_data->indent + 2);
+       print_value_rec(fp, object, indent + 2);
+
+end:
+       return;
+}
+
+static
+bt_bool collect_map_keys(const char *key, const bt_value *object, void *data)
+{
+       GPtrArray *map_keys = data;
+
+       g_ptr_array_add(map_keys, (gpointer *) key);
+
        return BT_TRUE;
 }
 
+static
+gint g_ptr_array_sort_strings(gconstpointer a, gconstpointer b) {
+       const char *s1 = *((const char **) a);
+       const char *s2 = *((const char **) b);
+
+       return g_strcmp0(s1, s2);
+}
+
 static
 void print_value_rec(FILE *fp, const bt_value *value, size_t indent)
 {
@@ -324,9 +336,10 @@ void print_value_rec(FILE *fp, const bt_value *value, size_t indent)
        const char *str_val;
        int size;
        int i;
+       GPtrArray *map_keys = NULL;
 
        if (!value) {
-               return;
+               goto end;
        }
 
        switch (bt_value_get_type(value)) {
@@ -409,10 +422,8 @@ void print_value_rec(FILE *fp, const bt_value *value, size_t indent)
                break;
        case BT_VALUE_TYPE_MAP:
        {
-               struct print_map_value_data data = {
-                       .indent = indent,
-                       .fp = fp,
-               };
+               guint i;
+               bt_value_map_foreach_entry_const_status foreach_status;
 
                if (bt_value_map_is_empty(value)) {
                        print_indent(fp, indent);
@@ -420,17 +431,52 @@ void print_value_rec(FILE *fp, const bt_value *value, size_t indent)
                        break;
                }
 
-               bt_value_map_foreach_entry_const(value, print_map_value, &data);
+               map_keys = g_ptr_array_new();
+               if (!map_keys) {
+                       BT_CLI_LOGE_APPEND_CAUSE("Failed to allocated on GPtrArray.");
+                       goto end;
+               }
+
+               /*
+                * We want to print the map entries in a stable order.  Collect
+                * all the map's keys in a GPtrArray, sort it, then print the
+                * entries in that order.
+                */
+               foreach_status = bt_value_map_foreach_entry_const(value,
+                       collect_map_keys, map_keys);
+               if (foreach_status != BT_VALUE_MAP_FOREACH_ENTRY_CONST_STATUS_OK) {
+                       BT_CLI_LOGE_APPEND_CAUSE("Failed to iterator on map value.");
+                       goto end;
+               }
+
+               g_ptr_array_sort(map_keys, g_ptr_array_sort_strings);
+
+               for (i = 0; i < map_keys->len; i++) {
+                       const char *map_key = g_ptr_array_index(map_keys, i);
+                       const bt_value *map_value;
+
+                       map_value = bt_value_map_borrow_entry_value_const(value, map_key);
+                       BT_ASSERT(map_value);
+
+                       print_map_value(map_key, map_value, fp, indent);
+               }
+
                break;
        }
        default:
                abort();
        }
-       return;
+
+       goto end;
 
 error:
        BT_LOGE("Error printing value of type %s.",
                bt_common_value_type_string(bt_value_get_type(value)));
+
+end:
+       if (map_keys) {
+               g_ptr_array_free(map_keys, TRUE);
+       }
 }
 
 static
@@ -1919,6 +1965,117 @@ end:
        return ret;
 }
 
+/*
+ * Compute the intersection of all streams in the array `streams`, write it
+ * in `range`.
+ */
+
+static
+int compute_stream_intersection(const bt_value *streams,
+               struct trace_range *range)
+{
+       unsigned int i;
+       unsigned int stream_count;
+       int ret;
+
+       BT_ASSERT(bt_value_get_type(streams) == BT_VALUE_TYPE_ARRAY);
+
+       stream_count = bt_value_array_get_length(streams);
+
+       BT_ASSERT(stream_count > 0);
+
+       range->intersection_range_begin_ns = 0;
+       range->intersection_range_end_ns = UINT64_MAX;
+
+       for (i = 0; i < stream_count; i++) {
+               int64_t begin_ns, end_ns;
+               uint64_t begin_ns_u, end_ns_u;
+               const bt_value *stream_value;
+               const bt_value *range_ns_value;
+               const bt_value *begin_value;
+               const bt_value *end_value;
+
+               stream_value = bt_value_array_borrow_element_by_index_const(streams, i);
+               if (bt_value_get_type(stream_value) != BT_VALUE_TYPE_MAP) {
+                       BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
+                               "expected streams array element to be a map, got %s.",
+                               bt_common_value_type_string(bt_value_get_type(stream_value)));
+                       goto error;
+               }
+
+               range_ns_value = bt_value_map_borrow_entry_value_const(
+                       stream_value, "range-ns");
+               if (!range_ns_value) {
+                       BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
+                               "missing expected `range-ns` key in stream map.");
+                       goto error;
+               }
+
+               if (bt_value_get_type(range_ns_value) != BT_VALUE_TYPE_MAP) {
+                       BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
+                               "expected `range-ns` entry value of stream map to be a map, got %s.",
+                               bt_common_value_type_string(bt_value_get_type(range_ns_value)));
+                       goto error;
+               }
+
+               begin_value = bt_value_map_borrow_entry_value_const(range_ns_value, "begin");
+               if (!begin_value) {
+                       BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
+                               "missing expected `begin` key in range-ns map.");
+                       goto error;
+               }
+
+               if (bt_value_get_type(begin_value) != BT_VALUE_TYPE_SIGNED_INTEGER) {
+                       BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
+                               "expected `begin` entry value of range-ns map to be a signed integer, got %s.",
+                               bt_common_value_type_string(bt_value_get_type(range_ns_value)));
+                       goto error;
+               }
+
+               end_value = bt_value_map_borrow_entry_value_const(range_ns_value, "end");
+               if (!end_value) {
+                       BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
+                               "missing expected `end` key in range-ns map.");
+                       goto error;
+               }
+
+               if (bt_value_get_type(end_value) != BT_VALUE_TYPE_SIGNED_INTEGER) {
+                       BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: "
+                               "expected `end` entry value of range-ns map to be a signed integer, got %s.",
+                               bt_common_value_type_string(bt_value_get_type(range_ns_value)));
+                       goto error;
+               }
+
+               begin_ns = bt_value_integer_signed_get(begin_value);
+               end_ns = bt_value_integer_signed_get(end_value);
+
+               if (begin_ns < 0 || end_ns < 0 || end_ns < begin_ns) {
+                       BT_CLI_LOGE_APPEND_CAUSE(
+                               "Invalid stream range values: "
+                               "range-ns:begin=%" PRId64 ", "
+                               "range-ns:end=%" PRId64,
+                               begin_ns, end_ns);
+                       goto error;
+               }
+
+               begin_ns_u = begin_ns;
+               end_ns_u = end_ns;
+
+               range->intersection_range_begin_ns =
+                       MAX(range->intersection_range_begin_ns, begin_ns_u);
+               range->intersection_range_end_ns =
+                       MIN(range->intersection_range_end_ns, end_ns_u);
+       }
+
+       ret = 0;
+       goto end;
+error:
+       ret = -1;
+
+end:
+       return ret;
+}
+
 static
 int set_stream_intersections(struct cmd_run_ctx *ctx,
                struct bt_config_component *cfg_comp,
@@ -1927,109 +2084,95 @@ int set_stream_intersections(struct cmd_run_ctx *ctx,
        int ret = 0;
        uint64_t trace_idx;
        int64_t trace_count;
-       const char *path = NULL;
        const bt_value *query_result = NULL;
        const bt_value *trace_info = NULL;
-       const bt_value *intersection_range = NULL;
-       const bt_value *intersection_begin = NULL;
-       const bt_value *intersection_end = NULL;
        const bt_value *stream_infos = NULL;
        const bt_value *stream_info = NULL;
        struct port_id *port_id = NULL;
-       struct trace_range *trace_range = NULL;
+       struct trace_range *stream_intersection = NULL;
        const char *fail_reason = NULL;
        const bt_component_class *comp_cls =
                bt_component_class_source_as_component_class_const(src_comp_cls);
 
-       ret = query(ctx->cfg, comp_cls, "babeltrace.trace-info",
+       ret = query(ctx->cfg, comp_cls, "babeltrace.trace-infos",
                cfg_comp->params, &query_result,
                &fail_reason);
        if (ret) {
-               BT_LOGD("Component class does not support the `babeltrace.trace-info` query: %s: "
+               BT_CLI_LOGE_APPEND_CAUSE("Failed to execute `babeltrace.trace-infos` query: %s: "
                        "comp-class-name=\"%s\"", fail_reason,
                        bt_component_class_get_name(comp_cls));
                ret = -1;
-               goto error;
+               goto end;
        }
 
        BT_ASSERT(query_result);
 
        if (!bt_value_is_array(query_result)) {
-               BT_LOGD("Unexpected format of `babeltrace.trace-info` query result: "
-                       "component-class-name=%s",
-                       bt_component_class_get_name(comp_cls));
+               BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: expecting result to be an array: "
+                       "component-class-name=%s, actual-type=%s",
+                       bt_component_class_get_name(comp_cls),
+                       bt_common_value_type_string(bt_value_get_type(query_result)));
                ret = -1;
-               goto error;
+               goto end;
        }
 
        trace_count = bt_value_array_get_length(query_result);
        if (trace_count < 0) {
+               BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: result is empty: "
+                       "component-class-name=%s", bt_component_class_get_name(comp_cls));
                ret = -1;
-               goto error;
+               goto end;
        }
 
        for (trace_idx = 0; trace_idx < trace_count; trace_idx++) {
-               int64_t begin, end;
                uint64_t stream_idx;
                int64_t stream_count;
+               struct trace_range trace_intersection;
 
                trace_info = bt_value_array_borrow_element_by_index_const(
                        query_result, trace_idx);
-               if (!trace_info || !bt_value_is_map(trace_info)) {
-                       ret = -1;
-                       BT_LOGD_STR("Cannot retrieve trace from query result.");
-                       goto error;
-               }
-
-               intersection_range = bt_value_map_borrow_entry_value_const(
-                       trace_info, "intersection-range-ns");
-               if (!intersection_range) {
-                       ret = -1;
-                       BT_LOGD_STR("Cannot retrieve \'intersetion-range-ns\' field from query result.");
-                       goto error;
-               }
-
-               intersection_begin = bt_value_map_borrow_entry_value_const(intersection_range,
-                                                                          "begin");
-               if (!intersection_begin) {
-                       ret = -1;
-                       BT_LOGD_STR("Cannot retrieve intersection-range-ns \'begin\' field from query result.");
-                       goto error;
-               }
-
-               intersection_end = bt_value_map_borrow_entry_value_const(intersection_range,
-                                                                        "end");
-               if (!intersection_end) {
+               BT_ASSERT(trace_info);
+               if (!bt_value_is_map(trace_info)) {
                        ret = -1;
-                       BT_LOGD_STR("Cannot retrieve intersection-range-ns \'end\' field from query result.");
-                       goto error;
+                       BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: expecting element to be a map: "
+                               "component-class-name=%s, actual-type=%s",
+                               bt_component_class_get_name(comp_cls),
+                               bt_common_value_type_string(bt_value_get_type(trace_info)));
+                       goto end;
                }
 
-               begin = bt_value_integer_signed_get(intersection_begin);
-               end = bt_value_integer_signed_get(intersection_end);
-
-               if (begin < 0 || end < 0 || end < begin) {
-                       BT_CLI_LOGE_APPEND_CAUSE(
-                               "Invalid trace stream intersection values: "
-                               "intersection-range-ns:begin=%" PRId64
-                               ", intersection-range-ns:end=%" PRId64,
-                               begin, end);
+               stream_infos = bt_value_map_borrow_entry_value_const(
+                       trace_info, "stream-infos");
+               if (!stream_infos) {
                        ret = -1;
-                       goto error;
+                       BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: missing `streams` key in trace info map: "
+                               "component-class-name=%s",
+                               bt_component_class_get_name(comp_cls));
+                       goto end;
                }
 
-               stream_infos = bt_value_map_borrow_entry_value_const(trace_info,
-                                                                    "streams");
-               if (!stream_infos || !bt_value_is_array(stream_infos)) {
+               if (!bt_value_is_array(stream_infos)) {
                        ret = -1;
-                       BT_LOGD_STR("Cannot retrieve stream information from trace in query result.");
-                       goto error;
+                       BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: expecting `streams` entry of trace info map to be an array: "
+                               "component-class-name=%s, actual-type=%s",
+                               bt_component_class_get_name(comp_cls),
+                               bt_common_value_type_string(bt_value_get_type(stream_infos)));
+                       goto end;
                }
 
                stream_count = bt_value_array_get_length(stream_infos);
                if (stream_count < 0) {
                        ret = -1;
-                       goto error;
+                       BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: list of streams is empty: "
+                               "component-class-name=%s",
+                               bt_component_class_get_name(comp_cls));
+                       goto end;
+               }
+
+               ret = compute_stream_intersection(stream_infos, &trace_intersection);
+               if (ret != 0) {
+                       BT_CLI_LOGE_APPEND_CAUSE("Failed to compute trace streams intersection.");
+                       goto end;
                }
 
                for (stream_idx = 0; stream_idx < stream_count; stream_idx++) {
@@ -2040,41 +2183,57 @@ int set_stream_intersections(struct cmd_run_ctx *ctx,
                                ret = -1;
                                BT_CLI_LOGE_APPEND_CAUSE(
                                        "Cannot allocate memory for port_id structure.");
-                               goto error;
+                               goto end;
                        }
                        port_id->instance_name = strdup(cfg_comp->instance_name->str);
                        if (!port_id->instance_name) {
                                ret = -1;
                                BT_CLI_LOGE_APPEND_CAUSE(
                                        "Cannot allocate memory for port_id component instance name.");
-                               goto error;
+                               goto end;
                        }
 
-                       trace_range = g_new0(struct trace_range, 1);
-                       if (!trace_range) {
+                       stream_intersection = g_new0(struct trace_range, 1);
+                       if (!stream_intersection) {
                                ret = -1;
                                BT_CLI_LOGE_APPEND_CAUSE(
                                        "Cannot allocate memory for trace_range structure.");
-                               goto error;
+                               goto end;
                        }
-                       trace_range->intersection_range_begin_ns = begin;
-                       trace_range->intersection_range_end_ns = end;
+
+                       *stream_intersection = trace_intersection;
 
                        stream_info = bt_value_array_borrow_element_by_index_const(
                                stream_infos, stream_idx);
-                       if (!stream_info || !bt_value_is_map(stream_info)) {
+                       BT_ASSERT(stream_info);
+                       if (!bt_value_is_map(stream_info)) {
                                ret = -1;
-                               BT_CLI_LOGE_APPEND_CAUSE(
-                                       "Cannot retrieve stream informations from trace in query result.");
-                               goto error;
+                               BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: "
+                                       "expecting element of stream list to be a map: "
+                                       "component-class-name=%s, actual-type=%s",
+                                       bt_component_class_get_name(comp_cls),
+                                       bt_common_value_type_string(bt_value_get_type(stream_info)));
+                               goto end;
                        }
 
                        port_name = bt_value_map_borrow_entry_value_const(stream_info, "port-name");
-                       if (!port_name || !bt_value_is_string(port_name)) {
+                       if (!port_name) {
                                ret = -1;
-                               BT_CLI_LOGE_APPEND_CAUSE(
-                                       "Cannot retrieve port name in query result.");
-                               goto error;
+                               BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: "
+                                       "missing `port-name` key in stream info map: "
+                                       "component-class-name=%s",
+                                       bt_component_class_get_name(comp_cls));
+                               goto end;
+                       }
+
+                       if (!bt_value_is_string(port_name)) {
+                               ret = -1;
+                               BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: "
+                                       "expecting `port-name` entry of stream info map to be a string: "
+                                       "component-class-name=%s, actual-type=%s",
+                                       bt_component_class_get_name(comp_cls),
+                                       bt_common_value_type_string(bt_value_get_type(port_name)));
+                               goto end;
                        }
 
                        port_id->port_name = g_strdup(bt_value_string_get(port_name));
@@ -2082,29 +2241,24 @@ int set_stream_intersections(struct cmd_run_ctx *ctx,
                                ret = -1;
                                BT_CLI_LOGE_APPEND_CAUSE(
                                        "Cannot allocate memory for port_id port_name.");
-                               goto error;
+                               goto end;
                        }
 
                        BT_LOGD("Inserting stream intersection ");
 
-                       g_hash_table_insert(ctx->intersections, port_id, trace_range);
+                       g_hash_table_insert(ctx->intersections, port_id, stream_intersection);
 
                        port_id = NULL;
-                       trace_range = NULL;
+                       stream_intersection = NULL;
                }
        }
 
-       goto end;
-
-error:
-       BT_CLI_LOGE_APPEND_CAUSE(
-               "Cannot determine stream intersection of trace: path=\"%s\"",
-               path ? path : "(unknown)");
+       ret = 0;
 
 end:
        bt_value_put_ref(query_result);
        g_free(port_id);
-       g_free(trace_range);
+       g_free(stream_intersection);
        return ret;
 }
 
@@ -2192,6 +2346,8 @@ int cmd_run_ctx_create_components_from_config_components(
                                cfg_comp->type == BT_COMPONENT_CLASS_TYPE_SOURCE) {
                        ret = set_stream_intersections(ctx, cfg_comp, comp_cls);
                        if (ret) {
+                               BT_CLI_LOGE_APPEND_CAUSE(
+                                       "Cannot determine stream intersection of trace.");
                                goto error;
                        }
                }
@@ -2601,12 +2757,22 @@ int main(int argc, const char **argv)
 {
        int ret;
        int retcode;
-       struct bt_config *cfg;
+       struct bt_config *cfg = NULL;
 
        init_log_level();
        set_signal_handler();
        init_loaded_plugins();
-       cfg = bt_config_cli_args_create_with_default(argc, argv, &retcode);
+
+       BT_ASSERT(!the_interrupter);
+       the_interrupter = bt_interrupter_create();
+       if (!the_interrupter) {
+               BT_CLI_LOGE_APPEND_CAUSE("Failed to create an interrupter object.");
+               retcode = 1;
+               goto end;
+       }
+
+       cfg = bt_config_cli_args_create_with_default(argc, argv, &retcode,
+               the_interrupter);
 
        if (retcode < 0) {
                /* Quit without errors; typically usage/version */
@@ -2640,14 +2806,6 @@ int main(int argc, const char **argv)
                }
        }
 
-       BT_ASSERT(!the_interrupter);
-       the_interrupter = bt_interrupter_create();
-       if (!the_interrupter) {
-               BT_CLI_LOGE_APPEND_CAUSE("Failed to create an interrupter object.");
-               retcode = 1;
-               goto end;
-       }
-
        BT_LOGI("Executing command: cmd=%d, command-name=\"%s\"",
                cfg->command, cfg->command_name);
 
This page took 0.030717 seconds and 4 git commands to generate.