common: move bt_component_class_type_string here, use it more
[babeltrace.git] / src / cli / babeltrace2.c
index ad211fa24f2b47e2d4d794a8b7d60f26f45c5442..bf6c49d53ede25b6e81ef4a7d877b9dedc5aebe4 100644 (file)
@@ -1,25 +1,7 @@
 /*
- * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
- *
- * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
+ * SPDX-License-Identifier: MIT
  *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
+ * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
  */
 
 #define BT_LOG_TAG "CLI"
@@ -46,6 +28,7 @@
 
 #define ENV_BABELTRACE_WARN_COMMAND_NAME_DIRECTORY_CLASH "BABELTRACE_CLI_WARN_COMMAND_NAME_DIRECTORY_CLASH"
 #define NSEC_PER_SEC   1000000000LL
+#define EXIT_INTERRUPTED 2
 
 enum bt_cmd_status {
        BT_CMD_STATUS_OK            = 0,
@@ -146,14 +129,13 @@ const void *find_component_class_from_plugin(const char *plugin_name,
        BT_LOGI("Finding component class: plugin-name=\"%s\", "
                "comp-cls-name=\"%s\"", plugin_name, comp_class_name);
 
-       plugin = find_loaded_plugin(plugin_name);
+       plugin = borrow_loaded_plugin_by_name(plugin_name);
        if (!plugin) {
                goto end;
        }
 
        comp_class = plugin_borrow_comp_cls_func(plugin, comp_class_name);
        bt_object_get_ref(comp_class);
-       BT_PLUGIN_PUT_REF_AND_RESET(plugin);
 
 end:
        if (comp_class) {
@@ -654,10 +636,11 @@ enum bt_cmd_status cmd_query(struct bt_config *cfg)
        if (!comp_cls) {
                BT_CLI_LOGE_APPEND_CAUSE(
                        "Cannot find component class: plugin-name=\"%s\", "
-                       "comp-cls-name=\"%s\", comp-cls-type=%d",
+                       "comp-cls-name=\"%s\", comp-cls-type=%s",
                        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);
+                       bt_common_component_class_type_string(
+                               cfg->cmd_data.query.cfg_component->type));
                goto error;
        }
 
@@ -667,11 +650,12 @@ enum bt_cmd_status cmd_query(struct bt_config *cfg)
        if (ret) {
                BT_CLI_LOGE_APPEND_CAUSE(
                        "Failed to query component class: %s: plugin-name=\"%s\", "
-                       "comp-cls-name=\"%s\", comp-cls-type=%d "
+                       "comp-cls-name=\"%s\", comp-cls-type=%s "
                        "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,
+                       bt_common_component_class_type_string(
+                               cfg->cmd_data.query.cfg_component->type),
                        cfg->cmd_data.query.object->str);
                goto error;
        }
@@ -726,7 +710,7 @@ enum bt_cmd_status cmd_help(struct bt_config *cfg)
        const bt_plugin *plugin = NULL;
        const bt_component_class *needed_comp_cls = NULL;
 
-       plugin = find_loaded_plugin(cfg->cmd_data.help.cfg_component->plugin_name->str);
+       plugin = borrow_loaded_plugin_by_name(cfg->cmd_data.help.cfg_component->plugin_name->str);
        if (!plugin) {
                BT_CLI_LOGE_APPEND_CAUSE(
                        "Cannot find plugin: plugin-name=\"%s\"",
@@ -761,10 +745,11 @@ enum bt_cmd_status cmd_help(struct bt_config *cfg)
        if (!needed_comp_cls) {
                BT_CLI_LOGE_APPEND_CAUSE(
                        "Cannot find component class: plugin-name=\"%s\", "
-                       "comp-cls-name=\"%s\", comp-cls-type=%d",
+                       "comp-cls-name=\"%s\", comp-cls-type=%s",
                        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);
+                       bt_common_component_class_type_string(
+                               cfg->cmd_data.help.cfg_component->type));
                goto error;
        }
 
@@ -780,7 +765,6 @@ error:
 
 end:
        bt_component_class_put_ref(needed_comp_cls);
-       bt_plugin_put_ref(plugin);
        return cmd_status;
 }
 
@@ -854,7 +838,7 @@ enum bt_cmd_status cmd_list_plugins(struct bt_config *cfg)
        }
 
        for (i = 0; i < plugins_count; i++) {
-               const bt_plugin *plugin = borrow_loaded_plugin(i);
+               const bt_plugin *plugin = borrow_loaded_plugin_by_index(i);
 
                component_classes_count +=
                        bt_plugin_get_source_component_class_count(plugin) +
@@ -871,7 +855,7 @@ enum bt_cmd_status cmd_list_plugins(struct bt_config *cfg)
                bt_common_color_reset());
 
        for (i = 0; i < plugins_count; i++) {
-               const bt_plugin *plugin = borrow_loaded_plugin(i);
+               const bt_plugin *plugin = borrow_loaded_plugin_by_index(i);
 
                printf("\n");
                print_plugin_info(plugin);
@@ -923,9 +907,10 @@ enum bt_cmd_status cmd_print_lttng_live_sessions(struct bt_config *cfg)
        if (!comp_cls) {
                BT_CLI_LOGE_APPEND_CAUSE(
                        "Cannot find component class: plugin-name=\"%s\", "
-                       "comp-cls-name=\"%s\", comp-cls-type=%d",
+                       "comp-cls-name=\"%s\", comp-cls-type=%s",
                        plugin_name, comp_cls_name,
-                       BT_COMPONENT_CLASS_TYPE_SOURCE);
+                       bt_common_component_class_type_string(
+                               BT_COMPONENT_CLASS_TYPE_SOURCE));
                goto error;
        }
 
@@ -1062,9 +1047,10 @@ enum bt_cmd_status cmd_print_ctf_metadata(struct bt_config *cfg)
        if (!comp_cls) {
                BT_CLI_LOGE_APPEND_CAUSE(
                        "Cannot find component class: plugin-name=\"%s\", "
-                       "comp-cls-name=\"%s\", comp-cls-type=%d",
+                       "comp-cls-name=\"%s\", comp-cls-type=%s",
                        plugin_name, comp_cls_name,
-                       BT_COMPONENT_CLASS_TYPE_SOURCE);
+                       bt_common_component_class_type_string(
+                               BT_COMPONENT_CLASS_TYPE_SOURCE));
                goto error;
        }
 
@@ -1444,6 +1430,7 @@ int cmd_run_ctx_connect_upstream_port_to_downstream_component(
                                ctx->graph, trimmer_class, trimmer_name,
                                trimmer_params, ctx->cfg->log_level,
                                &trimmer);
+                       bt_component_filter_get_ref(trimmer);
                        free(trimmer_name);
                        if (add_comp_status !=
                                        BT_GRAPH_ADD_COMPONENT_STATUS_OK) {
@@ -1720,8 +1707,9 @@ int add_descriptor_to_component_descriptor_set(
        if (!comp_cls) {
                BT_CLI_LOGE_APPEND_CAUSE(
                        "Cannot find component class: plugin-name=\"%s\", "
-                       "comp-cls-name=\"%s\", comp-cls-type=%d",
-                       plugin_name, comp_cls_name, comp_cls_type);
+                       "comp-cls-name=\"%s\", comp-cls-type=%s",
+                       plugin_name, comp_cls_name,
+                       bt_common_component_class_type_string(comp_cls_type));
                status = -1;
                goto end;
        }
@@ -1899,7 +1887,7 @@ int cmd_run_ctx_init(struct cmd_run_ctx *ctx, struct bt_config *cfg)
 
        bt_graph_add_interrupter(ctx->graph, the_interrupter);
        add_listener_status = bt_graph_add_source_component_output_port_added_listener(
-               ctx->graph, graph_source_output_port_added_listener, NULL, ctx,
+               ctx->graph, graph_source_output_port_added_listener, ctx,
                NULL);
        if (add_listener_status != BT_GRAPH_ADD_LISTENER_STATUS_OK) {
                BT_CLI_LOGE_APPEND_CAUSE(
@@ -1908,7 +1896,7 @@ int cmd_run_ctx_init(struct cmd_run_ctx *ctx, struct bt_config *cfg)
        }
 
        add_listener_status = bt_graph_add_filter_component_output_port_added_listener(
-               ctx->graph, graph_filter_output_port_added_listener, NULL, ctx,
+               ctx->graph, graph_filter_output_port_added_listener, ctx,
                NULL);
        if (add_listener_status != BT_GRAPH_ADD_LISTENER_STATUS_OK) {
                BT_CLI_LOGE_APPEND_CAUSE(
@@ -2257,10 +2245,10 @@ int cmd_run_ctx_create_components_from_config_components(
                if (!comp_cls) {
                        BT_CLI_LOGE_APPEND_CAUSE(
                                "Cannot find component class: plugin-name=\"%s\", "
-                               "comp-cls-name=\"%s\", comp-cls-type=%d",
+                               "comp-cls-name=\"%s\", comp-cls-type=%s",
                                cfg_comp->plugin_name->str,
                                cfg_comp->comp_cls_name->str,
-                               cfg_comp->type);
+                               bt_common_component_class_type_string(cfg_comp->type));
                        goto error;
                }
 
@@ -2272,18 +2260,21 @@ int cmd_run_ctx_create_components_from_config_components(
                                comp_cls, cfg_comp->instance_name->str,
                                cfg_comp->params, cfg_comp->log_level,
                                (void *) &comp);
+                       bt_component_source_get_ref(comp);
                        break;
                case BT_COMPONENT_CLASS_TYPE_FILTER:
                        ret = bt_graph_add_filter_component(ctx->graph,
                                comp_cls, cfg_comp->instance_name->str,
                                cfg_comp->params, cfg_comp->log_level,
                                (void *) &comp);
+                       bt_component_filter_get_ref(comp);
                        break;
                case BT_COMPONENT_CLASS_TYPE_SINK:
                        ret = bt_graph_add_sink_component(ctx->graph,
                                comp_cls, cfg_comp->instance_name->str,
                                cfg_comp->params, cfg_comp->log_level,
                                (void *) &comp);
+                       bt_component_sink_get_ref(comp);
                        break;
                default:
                        bt_common_abort();
@@ -2292,11 +2283,12 @@ int cmd_run_ctx_create_components_from_config_components(
                if (ret) {
                        BT_CLI_LOGE_APPEND_CAUSE(
                                "Cannot create component: plugin-name=\"%s\", "
-                               "comp-cls-name=\"%s\", comp-cls-type=%d, "
+                               "comp-cls-name=\"%s\", comp-cls-type=%s, "
                                "comp-name=\"%s\"",
                                cfg_comp->plugin_name->str,
                                cfg_comp->comp_cls_name->str,
-                               cfg_comp->type, cfg_comp->instance_name->str);
+                               bt_common_component_class_type_string(cfg_comp->type),
+                               cfg_comp->instance_name->str);
                        goto error;
                }
 
@@ -2630,7 +2622,8 @@ end:
 
 int main(int argc, const char **argv)
 {
-       int ret, retcode;
+       int retcode;
+       enum bt_config_cli_args_status cli_args_status;
        enum bt_cmd_status cmd_status;
        struct bt_config *cfg = NULL;
 
@@ -2642,41 +2635,38 @@ int main(int argc, const char **argv)
        the_interrupter = bt_interrupter_create();
        if (!the_interrupter) {
                BT_CLI_LOGE_APPEND_CAUSE("Failed to create an interrupter object.");
-               retcode = 1;
+               retcode = EXIT_FAILURE;
                goto end;
        }
 
-       cfg = bt_config_cli_args_create_with_default(argc, argv, &retcode,
+       cli_args_status = bt_config_cli_args_create_with_default(argc, argv, &cfg,
                the_interrupter);
-
-       if (retcode < 0) {
+       if (cli_args_status == BT_CONFIG_CLI_ARGS_STATUS_INFO_ONLY) {
                /* Quit without errors; typically usage/version */
-               retcode = 0;
+               retcode = EXIT_SUCCESS;
                BT_LOGI_STR("Quitting without errors.");
                goto end;
        }
 
-       if (retcode > 0) {
+       if (cli_args_status == BT_CONFIG_CLI_ARGS_STATUS_ERROR) {
+               retcode = EXIT_FAILURE;
                BT_CLI_LOGE_APPEND_CAUSE(
                        "Command-line error: retcode=%d", retcode);
                goto end;
        }
 
-       if (!cfg) {
-               BT_CLI_LOGE_APPEND_CAUSE(
-                       "Failed to create a valid Babeltrace CLI configuration.");
-               retcode = 1;
-               goto end;
-       }
+       BT_ASSERT(cli_args_status == BT_CONFIG_CLI_ARGS_STATUS_OK);
+       BT_ASSERT(cfg);
 
        print_cfg(cfg);
 
        if (cfg->command_needs_plugins) {
-               ret = require_loaded_plugins(cfg->plugin_paths);
+               int ret = require_loaded_plugins(cfg->plugin_paths);
+
                if (ret) {
                        BT_CLI_LOGE_APPEND_CAUSE(
                                "Failed to load plugins: ret=%d", ret);
-                       retcode = 1;
+                       retcode = EXIT_FAILURE;
                        goto end;
                }
        }
@@ -2714,13 +2704,13 @@ int main(int argc, const char **argv)
 
        switch (cmd_status) {
        case BT_CMD_STATUS_OK:
-               retcode = 0;
+               retcode = EXIT_SUCCESS;
                break;
        case BT_CMD_STATUS_ERROR:
-               retcode = 1;
+               retcode = EXIT_FAILURE;
                break;
        case BT_CMD_STATUS_INTERRUPTED:
-               retcode = 2;
+               retcode = EXIT_INTERRUPTED;
                break;
        default:
                BT_LOGF("Invalid command status: cmd-status=%d", cmd_status);
@@ -2728,7 +2718,7 @@ int main(int argc, const char **argv)
        }
 
 end:
-       if (retcode == 1) {
+       if (retcode == EXIT_FAILURE) {
                print_error_causes();
        }
 
This page took 0.029735 seconds and 4 git commands to generate.