X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=src%2Fcli%2Fbabeltrace2.c;h=0dfac7a8ec077d8ca42c6da1a45f1a20c1fd0275;hp=a0c6df110e09af00a326906cd404877bdae10b34;hb=13aae0f4f15c5b2e5b02a1392723a66e5895527d;hpb=35d7d893ddfc4cedbf6b625ddad7f4f90681fb78 diff --git a/src/cli/babeltrace2.c b/src/cli/babeltrace2.c index a0c6df11..0dfac7a8 100644 --- a/src/cli/babeltrace2.c +++ b/src/cli/babeltrace2.c @@ -27,9 +27,10 @@ #include #include "common/common.h" +#include "string-format/format-error.h" +#include "string-format/format-plugin-comp-cls-name.h" #include #include -#include #include #include #include @@ -39,22 +40,34 @@ #include "babeltrace2-cfg.h" #include "babeltrace2-cfg-cli-args.h" #include "babeltrace2-cfg-cli-args-default.h" +#include "babeltrace2-log-level.h" #include "babeltrace2-plugins.h" +#include "babeltrace2-query.h" #define ENV_BABELTRACE_WARN_COMMAND_NAME_DIRECTORY_CLASH "BABELTRACE_CLI_WARN_COMMAND_NAME_DIRECTORY_CLASH" -#define ENV_BABELTRACE_CLI_LOG_LEVEL "BABELTRACE_CLI_LOG_LEVEL" #define NSEC_PER_SEC 1000000000LL -/* - * Known environment variable names for the log levels of the project's - * modules. - */ -static const char* log_level_env_var_names[] = { - "BABELTRACE_PLUGIN_CTF_METADATA_LOG_LEVEL", - "BABELTRACE_PYTHON_BT2_LOG_LEVEL", - NULL, +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; @@ -115,96 +128,10 @@ int query(struct bt_config *cfg, const bt_component_class *comp_cls, const char *obj, const bt_value *params, const bt_value **user_result, const char **fail_reason) { - const bt_value *result = NULL; - bt_query_executor_query_status query_status; - bt_query_executor *query_exec; - *fail_reason = "unknown error"; - int ret = 0; - - BT_ASSERT(fail_reason); - BT_ASSERT(user_result); - query_exec = bt_query_executor_create(); - if (!query_exec) { - BT_CLI_LOGE_APPEND_CAUSE("Cannot create a query executor."); - goto error; - } - - bt_query_executor_add_interrupter(query_exec, the_interrupter); - - while (true) { - query_status = bt_query_executor_query( - query_exec, comp_cls, obj, params, - cfg->log_level, &result); - switch (query_status) { - case BT_QUERY_EXECUTOR_QUERY_STATUS_OK: - goto ok; - case BT_QUERY_EXECUTOR_QUERY_STATUS_AGAIN: - { - const uint64_t sleep_time_us = 100000; - - if (bt_interrupter_is_set(the_interrupter)) { - *fail_reason = "interrupted by user"; - goto error; - } - - /* Wait 100 ms and retry */ - BT_LOGD("Got BT_QUERY_EXECUTOR_QUERY_STATUS_AGAIN: sleeping: " - "time-us=%" PRIu64, sleep_time_us); - - if (usleep(sleep_time_us)) { - if (bt_interrupter_is_set(the_interrupter)) { - BT_CLI_LOGW_APPEND_CAUSE( - "Query was interrupted by user: " - "comp-cls-addr=%p, comp-cls-name=\"%s\", " - "query-obj=\"%s\"", comp_cls, - bt_component_class_get_name(comp_cls), - obj); - *fail_reason = "interrupted by user"; - goto error; - } - } - - continue; - } - case BT_QUERY_EXECUTOR_QUERY_STATUS_ERROR: - if (bt_interrupter_is_set(the_interrupter)) { - *fail_reason = "interrupted by user"; - goto error; - } - - goto error; - case BT_QUERY_EXECUTOR_QUERY_STATUS_INVALID_OBJECT: - *fail_reason = "invalid or unknown query object"; - goto error; - case BT_QUERY_EXECUTOR_QUERY_STATUS_INVALID_PARAMS: - *fail_reason = "invalid query parameters"; - goto error; - case BT_QUERY_EXECUTOR_QUERY_STATUS_MEMORY_ERROR: - *fail_reason = "not enough memory"; - goto error; - default: - BT_LOGF("Unknown query status: status=%s", - bt_common_func_status_string(query_status)); - abort(); - } - } - -ok: - *user_result = result; - result = NULL; - goto end; - -error: - ret = -1; - -end: - bt_query_executor_put_ref(query_exec); - bt_value_put_ref(result); - return ret; + return cli_query(comp_cls, obj, params, cfg->log_level, + the_interrupter, user_result, fail_reason); } - - typedef const void *(*plugin_borrow_comp_cls_func_t)( const bt_plugin *, const char *); @@ -219,14 +146,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) { @@ -289,7 +215,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; @@ -305,109 +231,60 @@ 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); static void print_value_rec(FILE *, const bt_value *, size_t); -struct print_map_value_data { - size_t indent; - FILE *fp; -}; - static -bt_bool print_map_value(const char *key, const bt_value *object, - void *data) +void print_map_value(const char *key, const bt_value *object, FILE *fp, + size_t indent) { - struct print_map_value_data *print_map_value_data = data; - - print_indent(print_map_value_data->fp, print_map_value_data->indent); - fprintf(print_map_value_data->fp, "%s: ", key); + print_indent(fp, indent); + fprintf(fp, "%s: ", key); BT_ASSERT(object); if (bt_value_is_array(object) && bt_value_array_is_empty(object)) { - fprintf(print_map_value_data->fp, "[ ]\n"); - return true; + fprintf(fp, "[ ]\n"); + goto end; } if (bt_value_is_map(object) && bt_value_map_is_empty(object)) { - fprintf(print_map_value_data->fp, "{ }\n"); - return true; + fprintf(fp, "{ }\n"); + goto end; } if (bt_value_is_array(object) || bt_value_is_map(object)) { - fprintf(print_map_value_data->fp, "\n"); + fprintf(fp, "\n"); } - print_value_rec(print_map_value_data->fp, object, - print_map_value_data->indent + 2); - return BT_TRUE; + print_value_rec(fp, object, indent + 2); + +end: + return; +} + +static +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_VALUE_MAP_FOREACH_ENTRY_CONST_FUNC_STATUS_OK; +} + +static +gint g_ptr_array_sort_strings(gconstpointer a, gconstpointer b) { + const char *s1 = *((const char **) a); + const char *s2 = *((const char **) b); + + return g_strcmp0(s1, s2); } static @@ -418,12 +295,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) { - return; - } + BT_ASSERT(value); switch (bt_value_get_type(value)) { case BT_VALUE_TYPE_NULL: @@ -433,39 +307,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: - size = bt_value_array_get_size(value); - if (size < 0) { - goto error; - } - + { + uint64_t i, size; + size = bt_value_array_get_length(value); if (size == 0) { print_indent(fp, indent); fprintf(fp, "[ ]\n"); @@ -477,9 +349,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, "- "); @@ -503,12 +372,11 @@ 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: { - struct print_map_value_data data = { - .indent = indent, - .fp = fp, - }; + guint i; + bt_value_map_foreach_entry_const_status foreach_status; if (bt_value_map_is_empty(value)) { print_indent(fp, indent); @@ -516,17 +384,48 @@ void print_value_rec(FILE *fp, const bt_value *value, size_t indent) break; } - bt_value_map_foreach_entry_const(value, print_map_value, &data); + map_keys = g_ptr_array_new(); + if (!map_keys) { + BT_CLI_LOGE_APPEND_CAUSE("Failed to allocated on GPtrArray."); + goto end; + } + + /* + * We want to print the map entries in a stable order. Collect + * all the map's keys in a GPtrArray, sort it, then print the + * entries in that order. + */ + foreach_status = bt_value_map_foreach_entry_const(value, + collect_map_keys, map_keys); + if (foreach_status != BT_VALUE_MAP_FOREACH_ENTRY_CONST_STATUS_OK) { + BT_CLI_LOGE_APPEND_CAUSE("Failed to iterator on map value."); + goto end; + } + + g_ptr_array_sort(map_keys, g_ptr_array_sort_strings); + + for (i = 0; i < map_keys->len; i++) { + const char *map_key = g_ptr_array_index(map_keys, i); + const bt_value *map_value; + + map_value = bt_value_map_borrow_entry_value_const(value, map_key); + BT_ASSERT(map_value); + + print_map_value(map_key, map_value, fp, indent); + } + break; } default: - abort(); + bt_common_abort(); } - return; -error: - BT_LOGE("Error printing value of type %s.", - bt_common_value_type_string(bt_value_get_type(value))); + goto end; + +end: + if (map_keys) { + g_ptr_array_free(map_keys, TRUE); + } } static @@ -542,11 +441,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", @@ -555,6 +459,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 @@ -655,8 +561,6 @@ void print_cfg(struct bt_config *cfg) } BT_LOGI_STR("CLI configuration:"); - BT_LOGI(" Debug mode: %s\n", cfg->debug ? "yes" : "no"); - BT_LOGI(" Verbose mode: %s\n", cfg->verbose ? "yes" : "no"); switch (cfg->command) { case BT_CONFIG_COMMAND_RUN: @@ -678,7 +582,7 @@ void print_cfg(struct bt_config *cfg) print_cfg_print_lttng_live_sessions(cfg); break; default: - abort(); + bt_common_abort(); } } @@ -702,7 +606,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(), @@ -734,9 +638,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; @@ -752,35 +657,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 @@ -795,9 +700,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)"); @@ -805,22 +714,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); @@ -839,6 +749,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; } @@ -853,19 +764,22 @@ 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 *, @@ -873,12 +787,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", @@ -904,10 +820,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); @@ -917,13 +834,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"); @@ -936,7 +852,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) + @@ -953,7 +869,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); @@ -978,13 +894,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; @@ -994,7 +911,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; @@ -1024,7 +941,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); @@ -1040,7 +959,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); @@ -1048,20 +966,16 @@ 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; } } - array_size = bt_value_array_get_size(results); + array_size = bt_value_array_get_length(results); for (i = 0; i < array_size; i++) { const char *url_text; 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; @@ -1079,7 +993,7 @@ int cmd_print_lttng_live_sessions(struct bt_config *cfg) BT_CLI_LOGE_APPEND_CAUSE("Missing `timer-us` entry."); goto error; } - timer_us = bt_value_integer_signed_get(v); + timer_us = bt_value_integer_unsigned_get(v); fprintf(out_stream, " (timer = %" PRIu64 ", ", timer_us); v = bt_value_map_borrow_entry_value_const(map, "stream-count"); if (!v) { @@ -1087,7 +1001,7 @@ int cmd_print_lttng_live_sessions(struct bt_config *cfg) "Missing `stream-count` entry."); goto error; } - streams = bt_value_integer_signed_get(v); + streams = bt_value_integer_unsigned_get(v); fprintf(out_stream, "%" PRIu64 " stream(s), ", streams); v = bt_value_map_borrow_entry_value_const(map, "client-count"); if (!v) { @@ -1095,18 +1009,15 @@ int cmd_print_lttng_live_sessions(struct bt_config *cfg) "Missing `client-count` entry."); goto error; } - clients = bt_value_integer_signed_get(v); + clients = bt_value_integer_unsigned_get(v); 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); @@ -1123,13 +1034,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; @@ -1151,27 +1063,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, @@ -1179,8 +1090,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); @@ -1197,8 +1107,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; } } @@ -1207,16 +1116,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); @@ -1233,7 +1140,7 @@ end: } } - return ret; + return cmd_status; } struct port_id { @@ -1796,11 +1703,138 @@ void cmd_run_ctx_destroy(struct cmd_run_ctx *ctx) ctx->cfg = NULL; } +static +int add_descriptor_to_component_descriptor_set( + bt_component_descriptor_set *comp_descr_set, + const char *plugin_name, const char *comp_cls_name, + bt_component_class_type comp_cls_type, + const bt_value *params) +{ + const bt_component_class *comp_cls; + int status = 0; + + comp_cls = find_component_class(plugin_name, comp_cls_name, + comp_cls_type); + 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); + status = -1; + goto end; + } + + status = bt_component_descriptor_set_add_descriptor( + comp_descr_set, comp_cls, params); + if (status != BT_COMPONENT_DESCRIPTOR_SET_ADD_DESCRIPTOR_STATUS_OK) { + BT_CLI_LOGE_APPEND_CAUSE( + "Cannot append descriptor to component descriptor set: " + "status=%s", bt_common_func_status_string(status)); + goto end; + } + +end: + bt_component_class_put_ref(comp_cls); + return status; +} + +static +int append_descriptors_from_bt_config_component_array( + bt_component_descriptor_set *comp_descr_set, + GPtrArray *component_configs) +{ + int ret = 0; + uint64_t i; + + for (i = 0; i < component_configs->len; i++) { + struct bt_config_component *cfg_comp = + component_configs->pdata[i]; + + ret = add_descriptor_to_component_descriptor_set( + comp_descr_set, + cfg_comp->plugin_name->str, + cfg_comp->comp_cls_name->str, + cfg_comp->type, cfg_comp->params); + if (ret) { + goto end; + } + } + +end: + return ret; +} + +static +bt_get_greatest_operative_mip_version_status get_greatest_operative_mip_version( + struct bt_config *cfg, uint64_t *mip_version) +{ + bt_get_greatest_operative_mip_version_status status = + BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_OK; + bt_component_descriptor_set *comp_descr_set = NULL; + int ret; + + BT_ASSERT(cfg); + BT_ASSERT(mip_version); + comp_descr_set = bt_component_descriptor_set_create(); + if (!comp_descr_set) { + BT_CLI_LOGE_APPEND_CAUSE( + "Failed to create a component descriptor set object."); + status = BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_MEMORY_ERROR; + goto end; + } + + ret = append_descriptors_from_bt_config_component_array( + comp_descr_set, cfg->cmd_data.run.sources); + if (ret) { + status = BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_ERROR; + goto end; + } + + ret = append_descriptors_from_bt_config_component_array( + comp_descr_set, cfg->cmd_data.run.filters); + if (ret) { + status = BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_ERROR; + goto end; + } + + ret = append_descriptors_from_bt_config_component_array( + comp_descr_set, cfg->cmd_data.run.sinks); + if (ret) { + status = BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_ERROR; + goto end; + } + + if (cfg->cmd_data.run.stream_intersection_mode) { + /* + * Stream intersection mode adds `flt.utils.trimmer` + * components; we need to include this type of component + * in the component descriptor set to get the real + * greatest operative MIP version. + */ + ret = add_descriptor_to_component_descriptor_set( + comp_descr_set, "utils", "trimmer", + BT_COMPONENT_CLASS_TYPE_FILTER, NULL); + if (ret) { + status = BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_ERROR; + goto end; + } + } + + status = bt_get_greatest_operative_mip_version(comp_descr_set, + bt_cli_log_level, mip_version); + +end: + bt_component_descriptor_set_put_ref(comp_descr_set); + return status; +} + static int cmd_run_ctx_init(struct cmd_run_ctx *ctx, struct bt_config *cfg) { int ret = 0; bt_graph_add_listener_status add_listener_status; + bt_get_greatest_operative_mip_version_status mip_version_status; + uint64_t mip_version = UINT64_C(-1); ctx->cfg = cfg; ctx->connect_ports = false; @@ -1831,14 +1865,39 @@ int cmd_run_ctx_init(struct cmd_run_ctx *ctx, struct bt_config *cfg) } } - ctx->graph = bt_graph_create(); + /* + * Get the greatest operative MIP version to use to configure + * the graph to create. + */ + mip_version_status = get_greatest_operative_mip_version( + cfg, &mip_version); + if (mip_version_status == BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_NO_MATCH) { + BT_CLI_LOGE_APPEND_CAUSE( + "Failed to find an operative message interchange " + "protocol version to use to create the `run` command's " + "graph (components are not interoperable)."); + goto error; + } else if (mip_version_status < 0) { + BT_CLI_LOGE_APPEND_CAUSE( + "Cannot find an operative message interchange " + "protocol version to use to create the `run` command's " + "graph: status=%s", + bt_common_func_status_string(mip_version_status)); + goto error; + } + + BT_ASSERT(mip_version_status == BT_GET_GREATEST_OPERATIVE_MIP_VERSION_STATUS_OK); + BT_LOGI("Found operative message interchange protocol version to " + "configure the `run` command's graph: mip-version=%" PRIu64, + mip_version); + ctx->graph = bt_graph_create(mip_version); if (!ctx->graph) { goto error; } 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( @@ -1847,7 +1906,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( @@ -1865,6 +1924,116 @@ end: return ret; } +/* + * Compute the intersection of all streams in the array `streams`, write it + * in `range`. + */ + +static +int compute_stream_intersection(const bt_value *streams, + struct trace_range *range) +{ + uint64_t i, stream_count; + int ret; + + BT_ASSERT(bt_value_get_type(streams) == BT_VALUE_TYPE_ARRAY); + + stream_count = bt_value_array_get_length(streams); + + BT_ASSERT(stream_count > 0); + + range->intersection_range_begin_ns = 0; + range->intersection_range_end_ns = UINT64_MAX; + + for (i = 0; i < stream_count; i++) { + int64_t begin_ns, end_ns; + uint64_t begin_ns_u, end_ns_u; + const bt_value *stream_value; + const bt_value *range_ns_value; + const bt_value *begin_value; + const bt_value *end_value; + + stream_value = bt_value_array_borrow_element_by_index_const(streams, i); + if (bt_value_get_type(stream_value) != BT_VALUE_TYPE_MAP) { + BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: " + "expected streams array element to be a map, got %s.", + bt_common_value_type_string(bt_value_get_type(stream_value))); + goto error; + } + + range_ns_value = bt_value_map_borrow_entry_value_const( + stream_value, "range-ns"); + if (!range_ns_value) { + BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: " + "missing expected `range-ns` key in stream map."); + goto error; + } + + if (bt_value_get_type(range_ns_value) != BT_VALUE_TYPE_MAP) { + BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: " + "expected `range-ns` entry value of stream map to be a map, got %s.", + bt_common_value_type_string(bt_value_get_type(range_ns_value))); + goto error; + } + + begin_value = bt_value_map_borrow_entry_value_const(range_ns_value, "begin"); + if (!begin_value) { + BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: " + "missing expected `begin` key in range-ns map."); + goto error; + } + + if (bt_value_get_type(begin_value) != BT_VALUE_TYPE_SIGNED_INTEGER) { + BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: " + "expected `begin` entry value of range-ns map to be a signed integer, got %s.", + bt_common_value_type_string(bt_value_get_type(range_ns_value))); + goto error; + } + + end_value = bt_value_map_borrow_entry_value_const(range_ns_value, "end"); + if (!end_value) { + BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: " + "missing expected `end` key in range-ns map."); + goto error; + } + + if (bt_value_get_type(end_value) != BT_VALUE_TYPE_SIGNED_INTEGER) { + BT_CLI_LOGE_APPEND_CAUSE("Unexpected format of `babeltrace.trace-infos` query result: " + "expected `end` entry value of range-ns map to be a signed integer, got %s.", + bt_common_value_type_string(bt_value_get_type(range_ns_value))); + goto error; + } + + begin_ns = bt_value_integer_signed_get(begin_value); + end_ns = bt_value_integer_signed_get(end_value); + + if (begin_ns < 0 || end_ns < 0 || end_ns < begin_ns) { + BT_CLI_LOGE_APPEND_CAUSE( + "Invalid stream range values: " + "range-ns:begin=%" PRId64 ", " + "range-ns:end=%" PRId64, + begin_ns, end_ns); + goto error; + } + + begin_ns_u = begin_ns; + end_ns_u = end_ns; + + range->intersection_range_begin_ns = + MAX(range->intersection_range_begin_ns, begin_ns_u); + range->intersection_range_end_ns = + MIN(range->intersection_range_end_ns, end_ns_u); + } + + ret = 0; + goto end; +error: + ret = -1; + +end: + return ret; +} + static int set_stream_intersections(struct cmd_run_ctx *ctx, struct bt_config_component *cfg_comp, @@ -1872,110 +2041,95 @@ int set_stream_intersections(struct cmd_run_ctx *ctx, { int ret = 0; uint64_t trace_idx; - int64_t trace_count; - const char *path = NULL; + uint64_t trace_count; const bt_value *query_result = NULL; const bt_value *trace_info = NULL; - const bt_value *intersection_range = NULL; - const bt_value *intersection_begin = NULL; - const bt_value *intersection_end = NULL; const bt_value *stream_infos = NULL; const bt_value *stream_info = NULL; struct port_id *port_id = NULL; - struct trace_range *trace_range = NULL; + struct trace_range *stream_intersection = NULL; const char *fail_reason = NULL; const bt_component_class *comp_cls = bt_component_class_source_as_component_class_const(src_comp_cls); - ret = query(ctx->cfg, comp_cls, "trace-info", + ret = query(ctx->cfg, comp_cls, "babeltrace.trace-infos", cfg_comp->params, &query_result, &fail_reason); if (ret) { - BT_LOGD("Component class does not support the `trace-info` query: %s: " + BT_CLI_LOGE_APPEND_CAUSE("Failed to execute `babeltrace.trace-infos` query: %s: " "comp-class-name=\"%s\"", fail_reason, bt_component_class_get_name(comp_cls)); ret = -1; - goto error; + goto end; } BT_ASSERT(query_result); if (!bt_value_is_array(query_result)) { - BT_LOGD("Unexpected format of \'trace-info\' query result: " - "component-class-name=%s", - bt_component_class_get_name(comp_cls)); + BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: expecting result to be an array: " + "component-class-name=%s, actual-type=%s", + bt_component_class_get_name(comp_cls), + bt_common_value_type_string(bt_value_get_type(query_result))); ret = -1; - goto error; + goto end; } - trace_count = bt_value_array_get_size(query_result); - if (trace_count < 0) { + trace_count = bt_value_array_get_length(query_result); + if (trace_count == 0) { + BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: result is empty: " + "component-class-name=%s", bt_component_class_get_name(comp_cls)); ret = -1; - goto error; + goto end; } for (trace_idx = 0; trace_idx < trace_count; trace_idx++) { - int64_t begin, end; uint64_t stream_idx; int64_t stream_count; + struct trace_range trace_intersection; trace_info = bt_value_array_borrow_element_by_index_const( query_result, trace_idx); - if (!trace_info || !bt_value_is_map(trace_info)) { - ret = -1; - BT_LOGD_STR("Cannot retrieve trace from query result."); - goto error; - } - - intersection_range = bt_value_map_borrow_entry_value_const( - trace_info, "intersection-range-ns"); - if (!intersection_range) { - ret = -1; - BT_LOGD_STR("Cannot retrieve \'intersetion-range-ns\' field from query result."); - goto error; - } - - intersection_begin = bt_value_map_borrow_entry_value_const(intersection_range, - "begin"); - if (!intersection_begin) { + if (!bt_value_is_map(trace_info)) { ret = -1; - BT_LOGD_STR("Cannot retrieve intersection-range-ns \'begin\' field from query result."); - goto error; + BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: expecting element to be a map: " + "component-class-name=%s, actual-type=%s", + bt_component_class_get_name(comp_cls), + bt_common_value_type_string(bt_value_get_type(trace_info))); + goto end; } - intersection_end = bt_value_map_borrow_entry_value_const(intersection_range, - "end"); - if (!intersection_end) { + stream_infos = bt_value_map_borrow_entry_value_const( + trace_info, "stream-infos"); + if (!stream_infos) { ret = -1; - BT_LOGD_STR("Cannot retrieve intersection-range-ns \'end\' field from query result."); - goto error; + BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: missing `streams` key in trace info map: " + "component-class-name=%s", + bt_component_class_get_name(comp_cls)); + goto end; } - begin = bt_value_integer_signed_get(intersection_begin); - end = bt_value_integer_signed_get(intersection_end); - - if (begin < 0 || end < 0 || end < begin) { - BT_CLI_LOGE_APPEND_CAUSE( - "Invalid trace stream intersection values: " - "intersection-range-ns:begin=%" PRId64 - ", intersection-range-ns:end=%" PRId64, - begin, end); + if (!bt_value_is_array(stream_infos)) { ret = -1; - goto error; + BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: expecting `streams` entry of trace info map to be an array: " + "component-class-name=%s, actual-type=%s", + bt_component_class_get_name(comp_cls), + bt_common_value_type_string(bt_value_get_type(stream_infos))); + goto end; } - stream_infos = bt_value_map_borrow_entry_value_const(trace_info, - "streams"); - if (!stream_infos || !bt_value_is_array(stream_infos)) { + stream_count = bt_value_array_get_length(stream_infos); + if (stream_count == 0) { ret = -1; - BT_LOGD_STR("Cannot retrieve stream information from trace in query result."); - goto error; + BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: list of streams is empty: " + "component-class-name=%s", + bt_component_class_get_name(comp_cls)); + goto end; } - stream_count = bt_value_array_get_size(stream_infos); - if (stream_count < 0) { - ret = -1; - goto error; + ret = compute_stream_intersection(stream_infos, &trace_intersection); + if (ret != 0) { + BT_CLI_LOGE_APPEND_CAUSE("Failed to compute trace streams intersection."); + goto end; } for (stream_idx = 0; stream_idx < stream_count; stream_idx++) { @@ -1986,41 +2140,56 @@ int set_stream_intersections(struct cmd_run_ctx *ctx, ret = -1; BT_CLI_LOGE_APPEND_CAUSE( "Cannot allocate memory for port_id structure."); - goto error; + goto end; } port_id->instance_name = strdup(cfg_comp->instance_name->str); if (!port_id->instance_name) { ret = -1; BT_CLI_LOGE_APPEND_CAUSE( "Cannot allocate memory for port_id component instance name."); - goto error; + goto end; } - trace_range = g_new0(struct trace_range, 1); - if (!trace_range) { + stream_intersection = g_new0(struct trace_range, 1); + if (!stream_intersection) { ret = -1; BT_CLI_LOGE_APPEND_CAUSE( "Cannot allocate memory for trace_range structure."); - goto error; + goto end; } - trace_range->intersection_range_begin_ns = begin; - trace_range->intersection_range_end_ns = end; + + *stream_intersection = trace_intersection; stream_info = bt_value_array_borrow_element_by_index_const( stream_infos, stream_idx); - if (!stream_info || !bt_value_is_map(stream_info)) { + if (!bt_value_is_map(stream_info)) { ret = -1; - BT_CLI_LOGE_APPEND_CAUSE( - "Cannot retrieve stream informations from trace in query result."); - goto error; + BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: " + "expecting element of stream list to be a map: " + "component-class-name=%s, actual-type=%s", + bt_component_class_get_name(comp_cls), + bt_common_value_type_string(bt_value_get_type(stream_info))); + goto end; } port_name = bt_value_map_borrow_entry_value_const(stream_info, "port-name"); - if (!port_name || !bt_value_is_string(port_name)) { + if (!port_name) { ret = -1; - BT_CLI_LOGE_APPEND_CAUSE( - "Cannot retrieve port name in query result."); - goto error; + BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: " + "missing `port-name` key in stream info map: " + "component-class-name=%s", + bt_component_class_get_name(comp_cls)); + goto end; + } + + if (!bt_value_is_string(port_name)) { + ret = -1; + BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: " + "expecting `port-name` entry of stream info map to be a string: " + "component-class-name=%s, actual-type=%s", + bt_component_class_get_name(comp_cls), + bt_common_value_type_string(bt_value_get_type(port_name))); + goto end; } port_id->port_name = g_strdup(bt_value_string_get(port_name)); @@ -2028,29 +2197,24 @@ int set_stream_intersections(struct cmd_run_ctx *ctx, ret = -1; BT_CLI_LOGE_APPEND_CAUSE( "Cannot allocate memory for port_id port_name."); - goto error; + goto end; } BT_LOGD("Inserting stream intersection "); - g_hash_table_insert(ctx->intersections, port_id, trace_range); + g_hash_table_insert(ctx->intersections, port_id, stream_intersection); port_id = NULL; - trace_range = NULL; + stream_intersection = NULL; } } - goto end; - -error: - BT_CLI_LOGE_APPEND_CAUSE( - "Cannot determine stream intersection of trace: path=\"%s\"", - path ? path : "(unknown)"); + ret = 0; end: bt_value_put_ref(query_result); g_free(port_id); - g_free(trace_range); + g_free(stream_intersection); return ret; } @@ -2085,7 +2249,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) { @@ -2120,7 +2284,7 @@ int cmd_run_ctx_create_components_from_config_components( (void *) &comp); break; default: - abort(); + bt_common_abort(); } if (ret) { @@ -2138,6 +2302,8 @@ int cmd_run_ctx_create_components_from_config_components( cfg_comp->type == BT_COMPONENT_CLASS_TYPE_SOURCE) { ret = set_stream_intersections(ctx, cfg_comp, comp_cls); if (ret) { + BT_CLI_LOGE_APPEND_CAUSE( + "Cannot determine stream intersection of trace."); goto error; } } @@ -2161,7 +2327,7 @@ int cmd_run_ctx_create_components_from_config_components( GUINT_TO_POINTER(quark), (void *) comp); break; default: - abort(); + bt_common_abort(); } comp = NULL; @@ -2285,9 +2451,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 */ @@ -2344,12 +2510,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) { @@ -2359,22 +2528,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( @@ -2382,17 +2545,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 @@ -2428,98 +2586,16 @@ void init_log_level(void) bt_cli_log_level = bt_log_get_level_from_env(ENV_BABELTRACE_CLI_LOG_LEVEL); } -static -void set_auto_log_levels(struct bt_config *cfg) -{ - const char **env_var_name; - - /* - * Override the configuration's default log level if - * BABELTRACE_VERBOSE or BABELTRACE_DEBUG environment variables - * are found for backward compatibility with legacy Babetrace 1. - */ - if (getenv("BABELTRACE_DEBUG") && - strcmp(getenv("BABELTRACE_DEBUG"), "1") == 0) { - cfg->log_level = BT_LOG_TRACE; - } else if (getenv("BABELTRACE_VERBOSE") && - strcmp(getenv("BABELTRACE_VERBOSE"), "1") == 0) { - cfg->log_level = BT_LOG_INFO; - } - - /* - * Set log levels according to --debug or --verbose. For - * backward compatibility, --debug is more verbose than - * --verbose. So: - * - * --verbose: INFO log level - * --debug: TRACE log level (includes DEBUG, which is - * is less verbose than TRACE in the internal - * logging framework) - */ - if (!getenv("LIBBABELTRACE2_INIT_LOG_LEVEL")) { - if (cfg->verbose) { - bt_logging_set_global_level(BT_LOG_INFO); - } else if (cfg->debug) { - bt_logging_set_global_level(BT_LOG_TRACE); - } else { - /* - * Set library's default log level if not - * explicitly specified. - */ - bt_logging_set_global_level(cfg->log_level); - } - } - - if (!getenv(ENV_BABELTRACE_CLI_LOG_LEVEL)) { - if (cfg->verbose) { - bt_cli_log_level = BT_LOG_INFO; - } else if (cfg->debug) { - bt_cli_log_level = BT_LOG_TRACE; - } else { - /* - * Set CLI's default log level if not explicitly - * specified. - */ - bt_cli_log_level = cfg->log_level; - } - } - - env_var_name = log_level_env_var_names; - - while (*env_var_name) { - if (!getenv(*env_var_name)) { - if (cfg->verbose) { - g_setenv(*env_var_name, "INFO", 1); - } else if (cfg->debug) { - g_setenv(*env_var_name, "TRACE", 1); - } else { - char val[2] = { 0 }; - - /* - * Set module's default log level if not - * explicitly specified. - */ - val[0] = bt_log_get_letter_from_level( - cfg->log_level); - g_setenv(*env_var_name, val, 1); - } - } - - env_var_name++; - } -} - 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; } @@ -2534,108 +2610,42 @@ 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()); + fputc('\n', stderr); - /* 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(); - } + error_str = format_bt_error(error, columns, bt_cli_log_level, + BT_COMMON_COLOR_WHEN_AUTO); + BT_ASSERT(error_str); - /* 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()); - - /* 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: - if (folded) { - g_string_free(folded, TRUE); - } - if (error) { bt_error_release(error); } + + g_free(error_str); } int main(int argc, const char **argv) { - int ret; - int retcode; - struct bt_config *cfg; + int ret, retcode; + enum bt_cmd_status cmd_status; + struct bt_config *cfg = NULL; init_log_level(); set_signal_handler(); init_loaded_plugins(); - cfg = bt_config_cli_args_create_with_default(argc, argv, &retcode); + + BT_ASSERT(!the_interrupter); + the_interrupter = bt_interrupter_create(); + if (!the_interrupter) { + BT_CLI_LOGE_APPEND_CAUSE("Failed to create an interrupter object."); + retcode = 1; + goto end; + } + + cfg = bt_config_cli_args_create_with_default(argc, argv, &retcode, + the_interrupter); if (retcode < 0) { /* Quit without errors; typically usage/version */ @@ -2652,12 +2662,11 @@ int main(int argc, const char **argv) if (!cfg) { BT_CLI_LOGE_APPEND_CAUSE( - "Failed to create a valid Babeltrace configuration."); + "Failed to create a valid Babeltrace CLI configuration."); retcode = 1; goto end; } - set_auto_log_levels(cfg); print_cfg(cfg); if (cfg->command_needs_plugins) { @@ -2670,55 +2679,61 @@ int main(int argc, const char **argv) } } - BT_ASSERT(!the_interrupter); - the_interrupter = bt_interrupter_create(); - if (!the_interrupter) { - BT_CLI_LOGE_APPEND_CAUSE("Failed to create an interrupter object."); - retcode = 1; - goto end; - } - BT_LOGI("Executing command: cmd=%d, command-name=\"%s\"", cfg->command, cfg->command_name); 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; + break; + case BT_CMD_STATUS_INTERRUPTED: + retcode = 2; + break; + default: + BT_LOGF("Invalid command status: cmd-status=%d", cmd_status); + bt_common_abort(); + } end: + if (retcode == 1) { + 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.