X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=src%2Fcli%2Fbabeltrace2.c;h=bf6c49d53ede25b6e81ef4a7d877b9dedc5aebe4;hb=6375b9429f8332f3eacc2ec795aa1924c73d9cc8;hp=4cc4234ee646edc8de6a3db7ed1a8750d4f6cce2;hpb=1376311317cd9d9a390ad758174e6340f3e3f96f;p=babeltrace.git diff --git a/src/cli/babeltrace2.c b/src/cli/babeltrace2.c index 4cc4234e..bf6c49d5 100644 --- a/src/cli/babeltrace2.c +++ b/src/cli/babeltrace2.c @@ -1,25 +1,7 @@ /* - * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation - * - * Author: Mathieu Desnoyers - * - * 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 #include "common/common.h" +#include "string-format/format-error.h" +#include "string-format/format-plugin-comp-cls-name.h" #include #include #include @@ -44,6 +28,28 @@ #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, + 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; @@ -123,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) { @@ -193,7 +198,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; @@ -209,68 +214,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); @@ -309,13 +252,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 @@ -334,13 +278,9 @@ void print_value_rec(FILE *fp, const bt_value *value, size_t indent) uint64_t uint_val; double dbl_val; const char *str_val; - int size; - int i; GPtrArray *map_keys = NULL; - if (!value) { - goto end; - } + BT_ASSERT(value); switch (bt_value_get_type(value)) { case BT_VALUE_TYPE_NULL: @@ -350,39 +290,37 @@ 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: + { + uint64_t i, size; size = bt_value_array_get_length(value); - if (size < 0) { - goto error; - } - if (size == 0) { print_indent(fp, indent); fprintf(fp, "[ ]\n"); @@ -394,9 +332,6 @@ void print_value_rec(FILE *fp, const bt_value *value, size_t indent) bt_value_array_borrow_element_by_index_const( value, i); - if (!element) { - goto error; - } print_indent(fp, indent); fprintf(fp, "- "); @@ -420,6 +355,7 @@ void print_value_rec(FILE *fp, const bt_value *value, size_t indent) print_value_rec(fp, element, indent + 2); } break; + } case BT_VALUE_TYPE_MAP: { guint i; @@ -464,15 +400,11 @@ void print_value_rec(FILE *fp, const bt_value *value, size_t indent) break; } default: - abort(); + bt_common_abort(); } 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); @@ -492,11 +424,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", @@ -505,6 +442,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 @@ -626,7 +565,7 @@ void print_cfg(struct bt_config *cfg) print_cfg_print_lttng_live_sessions(cfg); break; default: - abort(); + bt_common_abort(); } } @@ -650,7 +589,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(), @@ -682,9 +621,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; @@ -696,39 +636,41 @@ int 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); - ret = -1; - goto end; + bt_common_component_class_type_string( + cfg->cmd_data.query.cfg_component->type)); + 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=%s " + "object=\"%s\"", fail_reason, + cfg->cmd_data.query.cfg_component->plugin_name->str, + cfg->cmd_data.query.cfg_component->comp_cls_name->str, + bt_common_component_class_type_string( + 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 @@ -743,9 +685,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)"); @@ -753,22 +699,23 @@ 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 -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; - 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\"", cfg->cmd_data.help.cfg_component->plugin_name->str); - ret = -1; - goto end; + goto error; } print_plugin_info(plugin); @@ -787,6 +734,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; } @@ -797,23 +745,27 @@ int 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); - ret = -1; - goto end; + bt_common_component_class_type_string( + cfg->cmd_data.help.cfg_component->type)); + 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 *, @@ -821,12 +773,14 @@ 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, 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", @@ -852,10 +806,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); @@ -865,13 +820,12 @@ void cmd_list_plugins_print_component_classes(const bt_plugin *plugin, } end: - return; + g_free(comp_cls_str); } 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"); @@ -884,7 +838,7 @@ int 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) + @@ -901,7 +855,7 @@ int 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); @@ -926,13 +880,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; @@ -942,7 +897,7 @@ int cmd_print_lttng_live_sessions(struct bt_config *cfg) static const char * const comp_cls_name = "lttng-live"; static const bt_component_class_type comp_cls_type = BT_COMPONENT_CLASS_TYPE_SOURCE; - int64_t array_size, i; + uint64_t array_size, i; const char *fail_reason = NULL; FILE *out_stream = stdout; @@ -952,9 +907,10 @@ int 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; } @@ -972,7 +928,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); @@ -988,7 +946,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); @@ -996,7 +953,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; } } @@ -1006,10 +963,6 @@ int cmd_print_lttng_live_sessions(struct bt_config *cfg) int64_t timer_us, streams, clients; map = bt_value_array_borrow_element_by_index_const(results, i); - if (!map) { - BT_CLI_LOGE_APPEND_CAUSE("Unexpected empty array entry."); - goto error; - } if (!bt_value_is_map(map)) { BT_CLI_LOGE_APPEND_CAUSE("Unexpected entry type."); goto error; @@ -1047,14 +1000,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); @@ -1071,13 +1021,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; @@ -1096,30 +1047,30 @@ int 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); - ret = -1; - goto end; + bt_common_component_class_type_string( + BT_COMPONENT_CLASS_TYPE_SOURCE)); + 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, @@ -1127,8 +1078,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); @@ -1145,8 +1095,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; } } @@ -1155,16 +1104,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); @@ -1181,7 +1128,7 @@ end: } } - return ret; + return cmd_status; } struct port_id { @@ -1483,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) { @@ -1759,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; } @@ -1938,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( @@ -1947,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( @@ -1974,8 +1923,7 @@ static int compute_stream_intersection(const bt_value *streams, struct trace_range *range) { - unsigned int i; - unsigned int stream_count; + uint64_t i, stream_count; int ret; BT_ASSERT(bt_value_get_type(streams) == BT_VALUE_TYPE_ARRAY); @@ -2055,7 +2003,6 @@ int compute_stream_intersection(const bt_value *streams, "range-ns:begin=%" PRId64 ", " "range-ns:end=%" PRId64, begin_ns, end_ns); - ret = -1; goto error; } @@ -2084,7 +2031,7 @@ int set_stream_intersections(struct cmd_run_ctx *ctx, { int ret = 0; uint64_t trace_idx; - int64_t trace_count; + uint64_t trace_count; const bt_value *query_result = NULL; const bt_value *trace_info = NULL; const bt_value *stream_infos = NULL; @@ -2099,7 +2046,7 @@ int set_stream_intersections(struct cmd_run_ctx *ctx, cfg_comp->params, &query_result, &fail_reason); if (ret) { - BT_CLI_LOGE_APPEND_CAUSE("Component class does not support the `babeltrace.trace-infos` 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; @@ -2118,7 +2065,7 @@ int set_stream_intersections(struct cmd_run_ctx *ctx, } trace_count = bt_value_array_get_length(query_result); - if (trace_count < 0) { + 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; @@ -2132,7 +2079,6 @@ int set_stream_intersections(struct cmd_run_ctx *ctx, trace_info = bt_value_array_borrow_element_by_index_const( query_result, trace_idx); - BT_ASSERT(trace_info); if (!bt_value_is_map(trace_info)) { ret = -1; BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: expecting element to be a map: " @@ -2162,7 +2108,7 @@ int set_stream_intersections(struct cmd_run_ctx *ctx, } stream_count = bt_value_array_get_length(stream_infos); - if (stream_count < 0) { + if (stream_count == 0) { ret = -1; BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: list of streams is empty: " "component-class-name=%s", @@ -2206,7 +2152,6 @@ int set_stream_intersections(struct cmd_run_ctx *ctx, stream_info = bt_value_array_borrow_element_by_index_const( stream_infos, stream_idx); - BT_ASSERT(stream_info); if (!bt_value_is_map(stream_info)) { ret = -1; BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: " @@ -2294,16 +2239,16 @@ int cmd_run_ctx_create_components_from_config_components( cfg_comp->comp_cls_name->str); break; default: - abort(); + bt_common_abort(); } 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; } @@ -2315,31 +2260,35 @@ 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: - abort(); + bt_common_abort(); } 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; } @@ -2372,7 +2321,7 @@ int cmd_run_ctx_create_components_from_config_components( GUINT_TO_POINTER(quark), (void *) comp); break; default: - abort(); + bt_common_abort(); } comp = NULL; @@ -2496,9 +2445,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 */ @@ -2555,12 +2504,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) { @@ -2570,22 +2522,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( @@ -2593,17 +2539,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 @@ -2643,13 +2584,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; } @@ -2664,100 +2604,27 @@ 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: - abort(); - } + fputc('\n', stderr); - /* 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()); + error_str = format_bt_error(error, columns, bt_cli_log_level, + BT_COMMON_COLOR_WHEN_AUTO); + BT_ASSERT(error_str); - /* 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; - } - - 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) { - int ret; int retcode; + enum bt_config_cli_args_status cli_args_status; + enum bt_cmd_status cmd_status; struct bt_config *cfg = NULL; init_log_level(); @@ -2768,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; } } @@ -2812,42 +2676,56 @@ 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 = EXIT_SUCCESS; + break; + case BT_CMD_STATUS_ERROR: + retcode = EXIT_FAILURE; + break; + case BT_CMD_STATUS_INTERRUPTED: + retcode = EXIT_INTERRUPTED; + break; + default: + BT_LOGF("Invalid command status: cmd-status=%d", cmd_status); + bt_common_abort(); + } end: + if (retcode == EXIT_FAILURE) { + print_error_causes(); + } + 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.