lib: make bt_value_map_foreach_entry_{const_}func() return a status code
[babeltrace.git] / src / cli / babeltrace2.c
index eaffebcdb5353e2cafd6cb7036ae789b05357d2a..7dfeedbdb3091252d8c447d312e3e40abe0acb1b 100644 (file)
 #define ENV_BABELTRACE_WARN_COMMAND_NAME_DIRECTORY_CLASH "BABELTRACE_CLI_WARN_COMMAND_NAME_DIRECTORY_CLASH"
 #define NSEC_PER_SEC   1000000000LL
 
+enum bt_cmd_status {
+       BT_CMD_STATUS_OK            = 0,
+       BT_CMD_STATUS_ERROR         = -1,
+       BT_CMD_STATUS_INTERRUPTED   = -2,
+};
+
+static
+const char *bt_cmd_status_string(enum bt_cmd_status cmd_status)
+{
+       switch (cmd_status) {
+       case BT_CMD_STATUS_OK:
+               return "OK";
+       case BT_CMD_STATUS_ERROR:
+               return "ERROR";
+       case BT_CMD_STATUS_INTERRUPTED:
+               return "INTERRUPTED";
+       default:
+               bt_common_abort();
+       }
+}
+
 /* Application's interrupter (owned by this) */
 static bt_interrupter *the_interrupter;
 
@@ -193,7 +214,7 @@ const bt_component_class *find_component_class(const char *plugin_name,
                comp_cls = bt_component_class_sink_as_component_class_const(find_sink_component_class(plugin_name, comp_class_name));
                break;
        default:
-               abort();
+               bt_common_abort();
        }
 
        return comp_cls;
@@ -245,7 +266,7 @@ void print_plugin_comp_cls_opt(FILE *fh, const char *plugin_name,
 
        fprintf(fh, "'%s%s%s%s",
                bt_common_color_bold(),
-               bt_common_color_fg_cyan(),
+               bt_common_color_fg_bright_cyan(),
                component_type_str(type),
                bt_common_color_fg_default());
 
@@ -309,13 +330,14 @@ end:
 }
 
 static
-bt_bool collect_map_keys(const char *key, const bt_value *object, void *data)
+bt_value_map_foreach_entry_const_func_status 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;
+       return BT_VALUE_MAP_FOREACH_ENTRY_CONST_FUNC_STATUS_OK;
 }
 
 static
@@ -336,9 +358,7 @@ void print_value_rec(FILE *fp, const bt_value *value, size_t indent)
        const char *str_val;
        GPtrArray *map_keys = NULL;
 
-       if (!value) {
-               goto end;
-       }
+       BT_ASSERT(value);
 
        switch (bt_value_get_type(value)) {
        case BT_VALUE_TYPE_NULL:
@@ -348,31 +368,31 @@ void print_value_rec(FILE *fp, const bt_value *value, size_t indent)
        case BT_VALUE_TYPE_BOOL:
                bool_val = bt_value_bool_get(value);
                fprintf(fp, "%s%s%s%s\n", bt_common_color_bold(),
-                       bt_common_color_fg_cyan(), bool_val ? "yes" : "no",
+                       bt_common_color_fg_bright_cyan(), bool_val ? "yes" : "no",
                        bt_common_color_reset());
                break;
        case BT_VALUE_TYPE_UNSIGNED_INTEGER:
                uint_val = bt_value_integer_unsigned_get(value);
                fprintf(fp, "%s%s%" PRIu64 "%s\n", bt_common_color_bold(),
-                       bt_common_color_fg_red(), uint_val,
+                       bt_common_color_fg_bright_red(), uint_val,
                        bt_common_color_reset());
                break;
        case BT_VALUE_TYPE_SIGNED_INTEGER:
                int_val = bt_value_integer_signed_get(value);
                fprintf(fp, "%s%s%" PRId64 "%s\n", bt_common_color_bold(),
-                       bt_common_color_fg_red(), int_val,
+                       bt_common_color_fg_bright_red(), int_val,
                        bt_common_color_reset());
                break;
        case BT_VALUE_TYPE_REAL:
                dbl_val = bt_value_real_get(value);
                fprintf(fp, "%s%s%lf%s\n", bt_common_color_bold(),
-                       bt_common_color_fg_red(), dbl_val,
+                       bt_common_color_fg_bright_red(), dbl_val,
                        bt_common_color_reset());
                break;
        case BT_VALUE_TYPE_STRING:
                str_val = bt_value_string_get(value);
                fprintf(fp, "%s%s%s%s\n", bt_common_color_bold(),
-                       bt_common_color_fg_green(), str_val,
+                       bt_common_color_fg_bright_green(), str_val,
                        bt_common_color_reset());
                break;
        case BT_VALUE_TYPE_ARRAY:
@@ -458,7 +478,7 @@ void print_value_rec(FILE *fp, const bt_value *value, size_t indent)
                break;
        }
        default:
-               abort();
+               bt_common_abort();
        }
 
        goto end;
@@ -616,7 +636,7 @@ void print_cfg(struct bt_config *cfg)
                print_cfg_print_lttng_live_sessions(cfg);
                break;
        default:
-               abort();
+               bt_common_abort();
        }
 }
 
@@ -640,7 +660,7 @@ void print_plugin_info(const bt_plugin *plugin)
        version_avail = bt_plugin_get_version(plugin, &major, &minor,
                &patch, &extra);
        printf("%s%s%s%s:\n", bt_common_color_bold(),
-               bt_common_color_fg_blue(), plugin_name,
+               bt_common_color_fg_bright_blue(), plugin_name,
                bt_common_color_reset());
        if (path) {
                printf("  %sPath%s: %s\n", bt_common_color_bold(),
@@ -672,9 +692,10 @@ void print_plugin_info(const bt_plugin *plugin)
 }
 
 static
-int cmd_query(struct bt_config *cfg)
+enum bt_cmd_status cmd_query(struct bt_config *cfg)
 {
        int ret = 0;
+       enum bt_cmd_status cmd_status;
        const bt_component_class *comp_cls = NULL;
        const bt_value *results = NULL;
        const char *fail_reason = NULL;
@@ -690,35 +711,35 @@ int cmd_query(struct bt_config *cfg)
                        cfg->cmd_data.query.cfg_component->plugin_name->str,
                        cfg->cmd_data.query.cfg_component->comp_cls_name->str,
                        cfg->cmd_data.query.cfg_component->type);
-               ret = -1;
-               goto end;
+               goto error;
        }
 
        ret = query(cfg, comp_cls, cfg->cmd_data.query.object->str,
                cfg->cmd_data.query.cfg_component->params,
                &results, &fail_reason);
        if (ret) {
-               goto failed;
+               BT_CLI_LOGE_APPEND_CAUSE(
+                       "Failed to query component class: %s: plugin-name=\"%s\", "
+                       "comp-cls-name=\"%s\", comp-cls-type=%d "
+                       "object=\"%s\"", fail_reason,
+                       cfg->cmd_data.query.cfg_component->plugin_name->str,
+                       cfg->cmd_data.query.cfg_component->comp_cls_name->str,
+                       cfg->cmd_data.query.cfg_component->type,
+                       cfg->cmd_data.query.object->str);
+               goto error;
        }
 
        print_value(stdout, results, 0);
+       cmd_status = BT_CMD_STATUS_OK;
        goto end;
 
-failed:
-       BT_CLI_LOGE_APPEND_CAUSE(
-               "Failed to query component class: %s: plugin-name=\"%s\", "
-               "comp-cls-name=\"%s\", comp-cls-type=%d "
-               "object=\"%s\"", fail_reason,
-               cfg->cmd_data.query.cfg_component->plugin_name->str,
-               cfg->cmd_data.query.cfg_component->comp_cls_name->str,
-               cfg->cmd_data.query.cfg_component->type,
-               cfg->cmd_data.query.object->str);
-       ret = -1;
+error:
+       cmd_status = BT_CMD_STATUS_ERROR;
 
 end:
        bt_component_class_put_ref(comp_cls);
        bt_value_put_ref(results);
-       return ret;
+       return cmd_status;
 }
 
 static
@@ -746,9 +767,9 @@ void print_component_class_help(const char *plugin_name,
 }
 
 static
-int cmd_help(struct bt_config *cfg)
+enum bt_cmd_status cmd_help(struct bt_config *cfg)
 {
-       int ret = 0;
+       enum bt_cmd_status cmd_status;
        const bt_plugin *plugin = NULL;
        const bt_component_class *needed_comp_cls = NULL;
 
@@ -757,8 +778,7 @@ int cmd_help(struct bt_config *cfg)
                BT_CLI_LOGE_APPEND_CAUSE(
                        "Cannot find plugin: plugin-name=\"%s\"",
                        cfg->cmd_data.help.cfg_component->plugin_name->str);
-               ret = -1;
-               goto end;
+               goto error;
        }
 
        print_plugin_info(plugin);
@@ -777,6 +797,7 @@ int cmd_help(struct bt_config *cfg)
 
        if (strlen(cfg->cmd_data.help.cfg_component->comp_cls_name->str) == 0) {
                /* Plugin help only */
+               cmd_status = BT_CMD_STATUS_OK;
                goto end;
        }
 
@@ -791,19 +812,23 @@ int cmd_help(struct bt_config *cfg)
                        cfg->cmd_data.help.cfg_component->plugin_name->str,
                        cfg->cmd_data.help.cfg_component->comp_cls_name->str,
                        cfg->cmd_data.help.cfg_component->type);
-               ret = -1;
-               goto end;
+               goto error;
        }
 
        printf("\n");
        print_component_class_help(
                cfg->cmd_data.help.cfg_component->plugin_name->str,
                needed_comp_cls);
+       cmd_status = BT_CMD_STATUS_OK;
+       goto end;
+
+error:
+       cmd_status = BT_CMD_STATUS_ERROR;
 
 end:
        bt_component_class_put_ref(needed_comp_cls);
        bt_plugin_put_ref(plugin);
-       return ret;
+       return cmd_status;
 }
 
 typedef void *(* plugin_borrow_comp_cls_by_index_func_t)(const bt_plugin *,
@@ -811,6 +836,7 @@ typedef void *(* plugin_borrow_comp_cls_by_index_func_t)(const bt_plugin *,
 typedef const bt_component_class *(* spec_comp_cls_borrow_comp_cls_func_t)(
        void *);
 
+static
 void cmd_list_plugins_print_component_classes(const bt_plugin *plugin,
                const char *cc_type_name, uint64_t count,
                plugin_borrow_comp_cls_by_index_func_t borrow_comp_cls_by_index_func,
@@ -859,9 +885,8 @@ end:
 }
 
 static
-int cmd_list_plugins(struct bt_config *cfg)
+enum bt_cmd_status cmd_list_plugins(struct bt_config *cfg)
 {
-       int ret = 0;
        int plugins_count, component_classes_count = 0, i;
 
        printf("From the following plugin paths:\n\n");
@@ -916,13 +941,14 @@ int cmd_list_plugins(struct bt_config *cfg)
        }
 
 end:
-       return ret;
+       return BT_CMD_STATUS_OK;
 }
 
 static
-int cmd_print_lttng_live_sessions(struct bt_config *cfg)
+enum bt_cmd_status cmd_print_lttng_live_sessions(struct bt_config *cfg)
 {
        int ret = 0;
+       enum bt_cmd_status cmd_status;
        const bt_component_class *comp_cls = NULL;
        const bt_value *results = NULL;
        bt_value *params = NULL;
@@ -962,7 +988,9 @@ int cmd_print_lttng_live_sessions(struct bt_config *cfg)
        ret = query(cfg, comp_cls, "sessions", params,
                    &results, &fail_reason);
        if (ret) {
-               goto failed;
+               BT_CLI_LOGE_APPEND_CAUSE("Failed to query `sessions` object: %s",
+                       fail_reason);
+               goto error;
        }
 
        BT_ASSERT(results);
@@ -978,7 +1006,6 @@ int cmd_print_lttng_live_sessions(struct bt_config *cfg)
                        fopen(cfg->cmd_data.print_lttng_live_sessions.output_path->str,
                                "w");
                if (!out_stream) {
-                       ret = -1;
                        BT_LOGE_ERRNO("Cannot open file for writing",
                                ": path=\"%s\"",
                                cfg->cmd_data.print_lttng_live_sessions.output_path->str);
@@ -986,7 +1013,7 @@ int cmd_print_lttng_live_sessions(struct bt_config *cfg)
                                "Babeltrace CLI",
                                "Cannot open file for writing: path=\"%s\"",
                                cfg->cmd_data.print_lttng_live_sessions.output_path->str);
-                       goto end;
+                       goto error;
                }
        }
 
@@ -1033,14 +1060,11 @@ int cmd_print_lttng_live_sessions(struct bt_config *cfg)
                fprintf(out_stream, "%" PRIu64 " client(s) connected)\n", clients);
        }
 
+       cmd_status = BT_CMD_STATUS_OK;
        goto end;
 
-failed:
-       BT_CLI_LOGE_APPEND_CAUSE("Failed to query `sessions` object: %s",
-               fail_reason);
-
 error:
-       ret = -1;
+       cmd_status = BT_CMD_STATUS_ERROR;
 
 end:
        bt_value_put_ref(results);
@@ -1057,13 +1081,14 @@ end:
                }
        }
 
-       return ret;
+       return cmd_status;
 }
 
 static
-int cmd_print_ctf_metadata(struct bt_config *cfg)
+enum bt_cmd_status cmd_print_ctf_metadata(struct bt_config *cfg)
 {
        int ret = 0;
+       enum bt_cmd_status cmd_status;
        const bt_component_class *comp_cls = NULL;
        const bt_value *results = NULL;
        bt_value *params = NULL;
@@ -1085,27 +1110,26 @@ int cmd_print_ctf_metadata(struct bt_config *cfg)
                        "comp-cls-name=\"%s\", comp-cls-type=%d",
                        plugin_name, comp_cls_name,
                        BT_COMPONENT_CLASS_TYPE_SOURCE);
-               ret = -1;
-               goto end;
+               goto error;
        }
 
        params = bt_value_map_create();
        if (!params) {
-               ret = -1;
-               goto end;
+               goto error;
        }
 
        ret = bt_value_map_insert_string_entry(params, "path",
                cfg->cmd_data.print_ctf_metadata.path->str);
        if (ret) {
-               ret = -1;
-               goto end;
+               goto error;
        }
 
        ret = query(cfg, comp_cls, "metadata-info",
                params, &results, &fail_reason);
        if (ret) {
-               goto failed;
+               BT_CLI_LOGE_APPEND_CAUSE(
+                       "Failed to query `metadata-info` object: %s", fail_reason);
+               goto error;
        }
 
        metadata_text_value = bt_value_map_borrow_entry_value_const(results,
@@ -1113,8 +1137,7 @@ int cmd_print_ctf_metadata(struct bt_config *cfg)
        if (!metadata_text_value) {
                BT_CLI_LOGE_APPEND_CAUSE(
                        "Cannot find `text` string value in the resulting metadata info object.");
-               ret = -1;
-               goto end;
+               goto error;
        }
 
        metadata_text = bt_value_string_get(metadata_text_value);
@@ -1131,8 +1154,7 @@ int cmd_print_ctf_metadata(struct bt_config *cfg)
                                "Babeltrace CLI",
                                "Cannot open file for writing: path=\"%s\"",
                                cfg->cmd_data.print_ctf_metadata.output_path->str);
-                       ret = -1;
-                       goto end;
+                       goto error;
                }
        }
 
@@ -1141,16 +1163,14 @@ int cmd_print_ctf_metadata(struct bt_config *cfg)
                BT_CLI_LOGE_APPEND_CAUSE(
                        "Cannot write whole metadata text to output stream: "
                        "ret=%d", ret);
-               goto end;
+               goto error;
        }
 
-       ret = 0;
+       cmd_status = BT_CMD_STATUS_OK;
        goto end;
 
-failed:
-       ret = -1;
-       BT_CLI_LOGE_APPEND_CAUSE(
-               "Failed to query `metadata-info` object: %s", fail_reason);
+error:
+       cmd_status = BT_CMD_STATUS_ERROR;
 
 end:
        bt_value_put_ref(results);
@@ -1167,7 +1187,7 @@ end:
                }
        }
 
-       return ret;
+       return cmd_status;
 }
 
 struct port_id {
@@ -2276,7 +2296,7 @@ int cmd_run_ctx_create_components_from_config_components(
                                cfg_comp->comp_cls_name->str);
                        break;
                default:
-                       abort();
+                       bt_common_abort();
                }
 
                if (!comp_cls) {
@@ -2311,7 +2331,7 @@ int cmd_run_ctx_create_components_from_config_components(
                                (void *) &comp);
                        break;
                default:
-                       abort();
+                       bt_common_abort();
                }
 
                if (ret) {
@@ -2354,7 +2374,7 @@ int cmd_run_ctx_create_components_from_config_components(
                                GUINT_TO_POINTER(quark), (void *) comp);
                        break;
                default:
-                       abort();
+                       bt_common_abort();
                }
 
                comp = NULL;
@@ -2478,9 +2498,9 @@ end:
 }
 
 static
-int cmd_run(struct bt_config *cfg)
+enum bt_cmd_status cmd_run(struct bt_config *cfg)
 {
-       int ret = 0;
+       enum bt_cmd_status cmd_status;
        struct cmd_run_ctx ctx = { 0 };
 
        /* Initialize the command's context and the graph object */
@@ -2537,12 +2557,15 @@ int cmd_run(struct bt_config *cfg)
 
                switch (run_status) {
                case BT_GRAPH_RUN_STATUS_OK:
-                       break;
+                       cmd_status = BT_CMD_STATUS_OK;
+                       goto end;
                case BT_GRAPH_RUN_STATUS_AGAIN:
                        if (bt_interrupter_is_set(the_interrupter)) {
-                               BT_CLI_LOGW_APPEND_CAUSE(
-                                       "Graph was interrupted by user.");
-                               goto error;
+                               /*
+                                * The graph was interrupted by a SIGINT.
+                                */
+                               cmd_status = BT_CMD_STATUS_INTERRUPTED;
+                               goto end;
                        }
 
                        if (cfg->cmd_data.run.retry_duration_us > 0) {
@@ -2552,22 +2575,16 @@ int cmd_run(struct bt_config *cfg)
 
                                if (usleep(cfg->cmd_data.run.retry_duration_us)) {
                                        if (bt_interrupter_is_set(the_interrupter)) {
-                                               BT_CLI_LOGW_APPEND_CAUSE(
-                                                       "Graph was interrupted by user.");
-                                               goto error;
+                                               cmd_status = BT_CMD_STATUS_INTERRUPTED;
+                                               goto end;
                                        }
                                }
                        }
                        break;
-               case BT_GRAPH_RUN_STATUS_END:
-                       goto end;
                default:
                        if (bt_interrupter_is_set(the_interrupter)) {
-                               BT_CLI_LOGW_APPEND_CAUSE(
-                                       "Graph was interrupted by user and failed: "
-                                       "status=%s",
-                                       bt_common_func_status_string(run_status));
-                               goto error;
+                               cmd_status = BT_CMD_STATUS_INTERRUPTED;
+                               goto end;
                        }
 
                        BT_CLI_LOGE_APPEND_CAUSE(
@@ -2575,17 +2592,12 @@ int cmd_run(struct bt_config *cfg)
                        goto error;
                }
        }
-
-       goto end;
-
 error:
-       if (ret == 0) {
-               ret = -1;
-       }
+       cmd_status = BT_CMD_STATUS_ERROR;
 
 end:
        cmd_run_ctx_destroy(&ctx);
-       return ret;
+       return cmd_status;
 }
 
 static
@@ -2631,7 +2643,7 @@ void print_error_causes(void)
 
        if (!error || bt_error_get_cause_count(error) == 0) {
                fprintf(stderr, "%s%sUnknown command-line error.%s\n",
-                       bt_common_color_bold(), bt_common_color_fg_red(),
+                       bt_common_color_bold(), bt_common_color_fg_bright_red(),
                        bt_common_color_reset());
                goto end;
        }
@@ -2658,7 +2670,7 @@ void print_error_causes(void)
 
                /* Print prefix */
                fprintf(stderr, prefix_fmt,
-                       bt_common_color_bold(), bt_common_color_fg_red(),
+                       bt_common_color_bold(), bt_common_color_fg_bright_red(),
                        bt_common_color_reset());
 
                /* Print actor name */
@@ -2700,13 +2712,13 @@ void print_error_causes(void)
                                bt_error_cause_message_iterator_actor_get_component_class_type(cause));
                        break;
                default:
-                       abort();
+                       bt_common_abort();
                }
 
                /* Print file name and line number */
                fprintf(stderr, "] (%s%s%s%s:%s%" PRIu64 "%s)\n",
                        bt_common_color_bold(),
-                       bt_common_color_fg_magenta(),
+                       bt_common_color_fg_bright_magenta(),
                        bt_error_cause_get_file_name(cause),
                        bt_common_color_reset(),
                        bt_common_color_fg_green(),
@@ -2738,8 +2750,8 @@ end:
 
 int main(int argc, const char **argv)
 {
-       int ret;
-       int retcode;
+       int ret, retcode;
+       enum bt_cmd_status cmd_status;
        struct bt_config *cfg = NULL;
 
        init_log_level();
@@ -2794,42 +2806,53 @@ int main(int argc, const char **argv)
 
        switch (cfg->command) {
        case BT_CONFIG_COMMAND_RUN:
-               ret = cmd_run(cfg);
+               cmd_status = cmd_run(cfg);
                break;
        case BT_CONFIG_COMMAND_LIST_PLUGINS:
-               ret = cmd_list_plugins(cfg);
+               cmd_status = cmd_list_plugins(cfg);
                break;
        case BT_CONFIG_COMMAND_HELP:
-               ret = cmd_help(cfg);
+               cmd_status = cmd_help(cfg);
                break;
        case BT_CONFIG_COMMAND_QUERY:
-               ret = cmd_query(cfg);
+               cmd_status = cmd_query(cfg);
                break;
        case BT_CONFIG_COMMAND_PRINT_CTF_METADATA:
-               ret = cmd_print_ctf_metadata(cfg);
+               cmd_status = cmd_print_ctf_metadata(cfg);
                break;
        case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS:
-               ret = cmd_print_lttng_live_sessions(cfg);
+               cmd_status = cmd_print_lttng_live_sessions(cfg);
                break;
        default:
                BT_LOGF("Invalid/unknown command: cmd=%d", cfg->command);
-               abort();
+               bt_common_abort();
        }
 
-       BT_LOGI("Command completed: cmd=%d, command-name=\"%s\", ret=%d",
-               cfg->command, cfg->command_name, ret);
+       BT_LOGI("Command completed: cmd=%d, command-name=\"%s\", command-status=\"%s\"",
+               cfg->command, cfg->command_name, bt_cmd_status_string(cmd_status));
        warn_command_name_and_directory_clash(cfg);
-       retcode = ret ? 1 : 0;
+
+       switch (cmd_status) {
+       case BT_CMD_STATUS_OK:
+               retcode = 0;
+               break;
+       case BT_CMD_STATUS_ERROR:
+               retcode = 1;
+               print_error_causes();
+               break;
+       case BT_CMD_STATUS_INTERRUPTED:
+               retcode = 2;
+               break;
+       default:
+               BT_LOGF("Invalid command status: cmd-status=%d", cmd_status);
+               bt_common_abort();
+       }
 
 end:
        BT_OBJECT_PUT_REF_AND_RESET(cfg);
        fini_loaded_plugins();
        bt_interrupter_put_ref(the_interrupter);
 
-       if (retcode != 0) {
-               print_error_causes();
-       }
-
        /*
         * Clear current thread's error in case there is one to avoid a
         * memory leak.
This page took 0.032813 seconds and 4 git commands to generate.