Move to kernel style SPDX license identifiers
[babeltrace.git] / src / cli / babeltrace2.c
index 29bd95a9bfa67bf832302839aff635513fb3f0c7..c4b7c29fc1605bc67910bcbdb98608c9c872a309 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"
@@ -27,6 +9,8 @@
 
 #include <babeltrace2/babeltrace.h>
 #include "common/common.h"
+#include "string-format/format-error.h"
+#include "string-format/format-plugin-comp-cls-name.h"
 #include <unistd.h>
 #include <stdlib.h>
 #include <string.h>
@@ -144,14 +128,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) {
@@ -230,68 +213,6 @@ void print_indent(FILE *fp, size_t indent)
        }
 }
 
-static
-const char *component_type_str(bt_component_class_type type)
-{
-       switch (type) {
-       case BT_COMPONENT_CLASS_TYPE_SOURCE:
-               return "source";
-       case BT_COMPONENT_CLASS_TYPE_SINK:
-               return "sink";
-       case BT_COMPONENT_CLASS_TYPE_FILTER:
-               return "filter";
-       default:
-               return "(unknown)";
-       }
-}
-
-static
-void print_plugin_comp_cls_opt(FILE *fh, const char *plugin_name,
-               const char *comp_cls_name, bt_component_class_type type)
-{
-       GString *shell_plugin_name = NULL;
-       GString *shell_comp_cls_name = NULL;
-
-       if (plugin_name) {
-               shell_plugin_name = bt_common_shell_quote(plugin_name, false);
-               if (!shell_plugin_name) {
-                       goto end;
-               }
-       }
-
-       shell_comp_cls_name = bt_common_shell_quote(comp_cls_name, false);
-       if (!shell_comp_cls_name) {
-               goto end;
-       }
-
-       fprintf(fh, "'%s%s%s%s",
-               bt_common_color_bold(),
-               bt_common_color_fg_cyan(),
-               component_type_str(type),
-               bt_common_color_fg_default());
-
-       if (shell_plugin_name) {
-               fprintf(fh, ".%s%s%s",
-                       bt_common_color_fg_blue(),
-                       shell_plugin_name->str,
-                       bt_common_color_fg_default());
-       }
-
-       fprintf(fh, ".%s%s%s'",
-               bt_common_color_fg_yellow(),
-               shell_comp_cls_name->str,
-               bt_common_color_reset());
-
-end:
-       if (shell_plugin_name) {
-               g_string_free(shell_plugin_name, TRUE);
-       }
-
-       if (shell_comp_cls_name) {
-               g_string_free(shell_comp_cls_name, TRUE);
-       }
-}
-
 static
 void print_value(FILE *, const bt_value *, size_t);
 
@@ -330,13 +251,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
@@ -367,31 +289,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:
@@ -501,11 +423,16 @@ void print_value(FILE *fp, const bt_value *value, size_t indent)
 static
 void print_bt_config_component(struct bt_config_component *bt_config_component)
 {
-       fprintf(stderr, "    ");
-       print_plugin_comp_cls_opt(stderr, bt_config_component->plugin_name->str,
+       gchar *comp_cls_str;
+
+       comp_cls_str = format_plugin_comp_cls_opt(
+               bt_config_component->plugin_name->str,
                bt_config_component->comp_cls_name->str,
-               bt_config_component->type);
-       fprintf(stderr, ":\n");
+               bt_config_component->type,
+               BT_COMMON_COLOR_WHEN_AUTO);
+       BT_ASSERT(comp_cls_str);
+
+       fprintf(stderr, "    %s:\n", comp_cls_str);
 
        if (bt_config_component->instance_name->len > 0) {
                fprintf(stderr, "      Name: %s\n",
@@ -514,6 +441,8 @@ void print_bt_config_component(struct bt_config_component *bt_config_component)
 
        fprintf(stderr, "      Parameters:\n");
        print_value(stderr, bt_config_component->params, 8);
+
+       g_free(comp_cls_str);
 }
 
 static
@@ -659,7 +588,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(),
@@ -753,9 +682,13 @@ void print_component_class_help(const char *plugin_name,
                bt_component_class_get_help(comp_cls);
        bt_component_class_type type =
                bt_component_class_get_type(comp_cls);
+       gchar *comp_cls_str;
 
-       print_plugin_comp_cls_opt(stdout, plugin_name, comp_class_name, type);
-       printf("\n");
+       comp_cls_str = format_plugin_comp_cls_opt(plugin_name, comp_class_name,
+               type, BT_COMMON_COLOR_WHEN_AUTO);
+       BT_ASSERT(comp_cls_str);
+
+       printf("%s\n", comp_cls_str);
        printf("  %sDescription%s: %s\n", bt_common_color_bold(),
                bt_common_color_reset(),
                comp_class_description ? comp_class_description : "(None)");
@@ -763,6 +696,8 @@ void print_component_class_help(const char *plugin_name,
        if (comp_class_help) {
                printf("\n%s\n", comp_class_help);
        }
+
+       g_free(comp_cls_str);
 }
 
 static
@@ -772,7 +707,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\"",
@@ -826,7 +761,6 @@ error:
 
 end:
        bt_component_class_put_ref(needed_comp_cls);
-       bt_plugin_put_ref(plugin);
        return cmd_status;
 }
 
@@ -842,6 +776,7 @@ void cmd_list_plugins_print_component_classes(const bt_plugin *plugin,
                spec_comp_cls_borrow_comp_cls_func_t spec_comp_cls_borrow_comp_cls_func)
 {
        uint64_t i;
+       gchar *comp_cls_str = NULL;
 
        if (count == 0) {
                printf("  %s%s component classes%s: (none)\n",
@@ -867,10 +802,11 @@ void cmd_list_plugins_print_component_classes(const bt_plugin *plugin,
                bt_component_class_type type =
                        bt_component_class_get_type(comp_class);
 
-               printf("    ");
-               print_plugin_comp_cls_opt(stdout,
-                       bt_plugin_get_name(plugin), comp_class_name,
-                       type);
+               g_free(comp_cls_str);
+               comp_cls_str = format_plugin_comp_cls_opt(
+                       bt_plugin_get_name(plugin), comp_class_name, type,
+                       BT_COMMON_COLOR_WHEN_AUTO);
+               printf("    %s", comp_cls_str);
 
                if (comp_class_description) {
                        printf(": %s", comp_class_description);
@@ -880,7 +816,7 @@ void cmd_list_plugins_print_component_classes(const bt_plugin *plugin,
        }
 
 end:
-       return;
+       g_free(comp_cls_str);
 }
 
 static
@@ -898,7 +834,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) +
@@ -915,7 +851,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);
@@ -1488,6 +1424,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) {
@@ -1943,7 +1880,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(
@@ -1952,7 +1889,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(
@@ -2316,18 +2253,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();
@@ -2636,13 +2576,12 @@ static
 void print_error_causes(void)
 {
        const bt_error *error = bt_current_thread_take_error();
-       int64_t i;
-       GString *folded = NULL;
        unsigned int columns;
+       gchar *error_str = NULL;
 
        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;
        }
@@ -2657,94 +2596,20 @@ void print_error_causes(void)
         * This helps visually separate the error causes from the last
         * logging statement.
         */
-       fprintf(stderr, "\n");
-
-       /* Reverse order: deepest (root) cause printed at the end */
-       for (i = bt_error_get_cause_count(error) - 1; i >= 0; i--) {
-               const bt_error_cause *cause =
-                       bt_error_borrow_cause_by_index(error, (uint64_t) i);
-               const char *prefix_fmt =
-                       i == bt_error_get_cause_count(error) - 1 ?
-                               "%s%sERROR%s:    " : "%s%sCAUSED BY%s ";
-
-               /* Print prefix */
-               fprintf(stderr, prefix_fmt,
-                       bt_common_color_bold(), bt_common_color_fg_red(),
-                       bt_common_color_reset());
-
-               /* Print actor name */
-               fprintf(stderr, "[");
-               switch (bt_error_cause_get_actor_type(cause)) {
-               case BT_ERROR_CAUSE_ACTOR_TYPE_UNKNOWN:
-                       fprintf(stderr, "%s%s%s",
-                               bt_common_color_bold(),
-                               bt_error_cause_get_module_name(cause),
-                               bt_common_color_reset());
-                       break;
-               case BT_ERROR_CAUSE_ACTOR_TYPE_COMPONENT:
-                       fprintf(stderr, "%s%s%s: ",
-                               bt_common_color_bold(),
-                               bt_error_cause_component_actor_get_component_name(cause),
-                               bt_common_color_reset());
-                       print_plugin_comp_cls_opt(stderr,
-                               bt_error_cause_component_actor_get_plugin_name(cause),
-                               bt_error_cause_component_actor_get_component_class_name(cause),
-                               bt_error_cause_component_actor_get_component_class_type(cause));
-                       break;
-               case BT_ERROR_CAUSE_ACTOR_TYPE_COMPONENT_CLASS:
-                       print_plugin_comp_cls_opt(stderr,
-                               bt_error_cause_component_class_actor_get_plugin_name(cause),
-                               bt_error_cause_component_class_actor_get_component_class_name(cause),
-                               bt_error_cause_component_class_actor_get_component_class_type(cause));
-                       break;
-               case BT_ERROR_CAUSE_ACTOR_TYPE_MESSAGE_ITERATOR:
-                       fprintf(stderr, "%s%s%s (%s%s%s): ",
-                               bt_common_color_bold(),
-                               bt_error_cause_message_iterator_actor_get_component_name(cause),
-                               bt_common_color_reset(),
-                               bt_common_color_bold(),
-                               bt_error_cause_message_iterator_actor_get_component_output_port_name(cause),
-                               bt_common_color_reset());
-                       print_plugin_comp_cls_opt(stderr,
-                               bt_error_cause_message_iterator_actor_get_plugin_name(cause),
-                               bt_error_cause_message_iterator_actor_get_component_class_name(cause),
-                               bt_error_cause_message_iterator_actor_get_component_class_type(cause));
-                       break;
-               default:
-                       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_error_cause_get_file_name(cause),
-                       bt_common_color_reset(),
-                       bt_common_color_fg_green(),
-                       bt_error_cause_get_line_number(cause),
-                       bt_common_color_reset());
+       fputc('\n',  stderr);
 
-               /* Print message */
-               folded = bt_common_fold(bt_error_cause_get_message(cause),
-                       columns, 2);
-               if (!folded) {
-                       BT_LOGE_STR("Could not fold string.");
-                       fprintf(stderr, "%s\n",
-                               bt_error_cause_get_message(cause));
-                       continue;
-               }
+       error_str = format_bt_error(error, columns, bt_cli_log_level,
+               BT_COMMON_COLOR_WHEN_AUTO);
+       BT_ASSERT(error_str);
 
-               fprintf(stderr, "%s\n", folded->str);
-               g_string_free(folded, TRUE);
-               folded = NULL;
-       }
+       fprintf(stderr, "%s\n", error_str);
 
 end:
-       BT_ASSERT(!folded);
-
        if (error) {
                bt_error_release(error);
        }
+
+       g_free(error_str);
 }
 
 int main(int argc, const char **argv)
@@ -2837,7 +2702,6 @@ int main(int argc, const char **argv)
                break;
        case BT_CMD_STATUS_ERROR:
                retcode = 1;
-               print_error_causes();
                break;
        case BT_CMD_STATUS_INTERRUPTED:
                retcode = 2;
@@ -2848,6 +2712,10 @@ int main(int argc, const char **argv)
        }
 
 end:
+       if (retcode == 1) {
+               print_error_causes();
+       }
+
        BT_OBJECT_PUT_REF_AND_RESET(cfg);
        fini_loaded_plugins();
        bt_interrupter_put_ref(the_interrupter);
This page took 0.029367 seconds and 4 git commands to generate.