X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=src%2Fcli%2Fbabeltrace2.c;h=eaffebcdb5353e2cafd6cb7036ae789b05357d2a;hb=85e6a1160e1dc8564a7bf86a9099f77f62cace7e;hp=cbbc9bd2d3dec07c5662f33c95fe1ee54d7ba633;hpb=e9d0e8218b63860b79a1fe0182da40b3146dc217;p=babeltrace.git diff --git a/src/cli/babeltrace2.c b/src/cli/babeltrace2.c index cbbc9bd2..eaffebcd 100644 --- a/src/cli/babeltrace2.c +++ b/src/cli/babeltrace2.c @@ -29,7 +29,6 @@ #include "common/common.h" #include #include -#include #include #include #include @@ -39,27 +38,15 @@ #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, -}; - -/* Application's processing graph (weak) */ -static bt_graph *the_graph; -static bt_query_executor *the_query_executor; -static bool canceled = false; - -GPtrArray *loaded_plugins; +/* Application's interrupter (owned by this) */ +static bt_interrupter *the_interrupter; #ifdef __MINGW32__ @@ -67,12 +54,10 @@ GPtrArray *loaded_plugins; static BOOL WINAPI signal_handler(DWORD signal) { - if (the_graph) { - bt_graph_cancel(the_graph); + if (the_interrupter) { + bt_interrupter_set(the_interrupter); } - canceled = true; - return TRUE; } @@ -93,15 +78,9 @@ void signal_handler(int signum) return; } - if (the_graph) { - bt_graph_cancel(the_graph); + if (the_interrupter) { + bt_interrupter_set(the_interrupter); } - - if (the_query_executor) { - bt_query_executor_cancel(the_query_executor); - } - - canceled = true; } static @@ -121,163 +100,13 @@ void set_signal_handler(void) #endif /* __MINGW32__ */ -static -void init_static_data(void) -{ - loaded_plugins = g_ptr_array_new_with_free_func( - (GDestroyNotify) bt_object_put_ref); -} - -static -void fini_static_data(void) -{ - g_ptr_array_free(loaded_plugins, TRUE); -} - -static -int create_the_query_executor(void) -{ - int ret = 0; - - the_query_executor = bt_query_executor_create(); - if (!the_query_executor) { - BT_CLI_LOGE_APPEND_CAUSE("Cannot create a query executor."); - ret = -1; - } - - return ret; -} - -static -void destroy_the_query_executor(void) -{ - BT_QUERY_EXECUTOR_PUT_REF_AND_RESET(the_query_executor); -} - static 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; - *fail_reason = "unknown error"; - int ret = 0; - - BT_ASSERT(fail_reason); - BT_ASSERT(user_result); - ret = create_the_query_executor(); - if (ret) { - /* create_the_query_executor() logs errors */ - goto end; - } - - if (canceled) { - BT_CLI_LOGW_APPEND_CAUSE( - "Canceled by user before executing the query: " - "comp-cls-addr=%p, comp-cls-name=\"%s\", " - "query-obj=\"%s\"", comp_cls, - bt_component_class_get_name(comp_cls), obj); - *fail_reason = "canceled by user"; - goto error; - } - - while (true) { - query_status = bt_query_executor_query( - the_query_executor, 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; - - /* 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_query_executor_is_canceled(the_query_executor)) { - BT_CLI_LOGW_APPEND_CAUSE( - "Query was canceled 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 = "canceled by user"; - goto error; - } - } - - continue; - } - case BT_QUERY_EXECUTOR_QUERY_STATUS_CANCELED: - *fail_reason = "canceled by user"; - goto error; - case BT_QUERY_EXECUTOR_QUERY_STATUS_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_UNSUPPORTED: - *fail_reason = "unsupported action"; - 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: - destroy_the_query_executor(); - bt_value_put_ref(result); - return ret; -} - -static -const bt_plugin *find_plugin(const char *name) -{ - int i; - const bt_plugin *plugin = NULL; - - BT_ASSERT(name); - BT_LOGI("Finding plugin: name=\"%s\"", name); - - for (i = 0; i < loaded_plugins->len; i++) { - plugin = g_ptr_array_index(loaded_plugins, i); - - if (strcmp(name, bt_plugin_get_name(plugin)) == 0) { - break; - } - - plugin = NULL; - } - - if (plugin) { - BT_LOGI("Found plugin: name=\"%s\", plugin-addr=%p", - name, plugin); - } else { - BT_LOGI("Cannot find plugin: name=\"%s\"", name); - } - - bt_plugin_get_ref(plugin); - return plugin; + 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)( @@ -294,7 +123,7 @@ 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_plugin(plugin_name); + plugin = find_loaded_plugin(plugin_name); if (!plugin) { goto end; } @@ -448,43 +277,55 @@ 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); + print_value_rec(fp, object, indent + 2); + +end: + return; +} + +static +bt_bool 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; } +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 void print_value_rec(FILE *fp, const bt_value *value, size_t indent) { @@ -493,11 +334,10 @@ 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; + goto end; } switch (bt_value_get_type(value)) { @@ -512,13 +352,13 @@ void print_value_rec(FILE *fp, const bt_value *value, size_t indent) bt_common_color_reset()); break; case BT_VALUE_TYPE_UNSIGNED_INTEGER: - uint_val = bt_value_unsigned_integer_get(value); + 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_reset()); break; case BT_VALUE_TYPE_SIGNED_INTEGER: - int_val = bt_value_signed_integer_get(value); + 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_reset()); @@ -536,11 +376,9 @@ void print_value_rec(FILE *fp, const bt_value *value, size_t indent) 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"); @@ -552,9 +390,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, "- "); @@ -578,12 +413,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); @@ -591,17 +425,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(); } - 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 @@ -730,8 +595,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: @@ -757,151 +620,6 @@ void print_cfg(struct bt_config *cfg) } } -static -void add_to_loaded_plugins(const bt_plugin_set *plugin_set) -{ - int64_t i; - int64_t count; - - count = bt_plugin_set_get_plugin_count(plugin_set); - BT_ASSERT(count >= 0); - - for (i = 0; i < count; i++) { - const bt_plugin *plugin = - bt_plugin_set_borrow_plugin_by_index_const(plugin_set, i); - const bt_plugin *loaded_plugin = - find_plugin(bt_plugin_get_name(plugin)); - - BT_ASSERT(plugin); - - if (loaded_plugin) { - BT_LOGI("Not using plugin: another one already exists with the same name: " - "plugin-name=\"%s\", plugin-path=\"%s\", " - "existing-plugin-path=\"%s\"", - bt_plugin_get_name(plugin), - bt_plugin_get_path(plugin), - bt_plugin_get_path(loaded_plugin)); - bt_plugin_put_ref(loaded_plugin); - } else { - /* Add to global array. */ - BT_LOGD("Adding plugin to loaded plugins: plugin-path=\"%s\"", - bt_plugin_get_name(plugin)); - bt_plugin_get_ref(plugin); - g_ptr_array_add(loaded_plugins, (void *) plugin); - } - } -} - -static -int load_dynamic_plugins(const bt_value *plugin_paths) -{ - int nr_paths, i, ret = 0; - - nr_paths = bt_value_array_get_size(plugin_paths); - if (nr_paths < 0) { - BT_CLI_LOGE_APPEND_CAUSE( - "Cannot load dynamic plugins: no plugin path."); - ret = -1; - goto end; - } - - BT_LOGI_STR("Loading dynamic plugins."); - - for (i = 0; i < nr_paths; i++) { - const bt_value *plugin_path_value = NULL; - const char *plugin_path; - const bt_plugin_set *plugin_set = NULL; - bt_plugin_find_all_from_dir_status status; - - plugin_path_value = - bt_value_array_borrow_element_by_index_const( - plugin_paths, i); - plugin_path = bt_value_string_get(plugin_path_value); - - /* - * Skip this if the directory does not exist because - * bt_plugin_find_all_from_dir() expects an existing - * directory. - */ - if (!g_file_test(plugin_path, G_FILE_TEST_IS_DIR)) { - BT_LOGI("Skipping nonexistent directory path: " - "path=\"%s\"", plugin_path); - continue; - } - - status = bt_plugin_find_all_from_dir(plugin_path, BT_FALSE, - BT_FALSE, &plugin_set); - if (status < 0) { - BT_CLI_LOGE_APPEND_CAUSE( - "Unable to load dynamic plugins from directory: " - "path=\"%s\"", plugin_path); - ret = -1; - goto end; - } else if (status == - BT_PLUGIN_FIND_ALL_FROM_DIR_STATUS_NOT_FOUND) { - BT_LOGI("No plugins found in directory: path=\"%s\"", - plugin_path); - continue; - } - - BT_ASSERT(status == BT_PLUGIN_FIND_ALL_FROM_DIR_STATUS_OK); - BT_ASSERT(plugin_set); - add_to_loaded_plugins(plugin_set); - bt_plugin_set_put_ref(plugin_set); - } -end: - return ret; -} - -static -int load_static_plugins(void) -{ - int ret = 0; - const bt_plugin_set *plugin_set; - bt_plugin_find_all_from_static_status status; - - BT_LOGI("Loading static plugins."); - status = bt_plugin_find_all_from_static(BT_FALSE, &plugin_set); - if (status < 0) { - BT_CLI_LOGE_APPEND_CAUSE("Unable to load static plugins."); - ret = -1; - goto end; - } else if (status == - BT_PLUGIN_FIND_ALL_FROM_STATIC_STATUS_NOT_FOUND) { - BT_LOGI("No static plugins found."); - goto end; - } - - BT_ASSERT(status == BT_PLUGIN_FIND_ALL_FROM_STATIC_STATUS_OK); - BT_ASSERT(plugin_set); - add_to_loaded_plugins(plugin_set); - bt_plugin_set_put_ref(plugin_set); - -end: - return ret; -} - -static -int load_all_plugins(const bt_value *plugin_paths) -{ - int ret = 0; - - if (load_dynamic_plugins(plugin_paths)) { - ret = -1; - goto end; - } - - if (load_static_plugins()) { - ret = -1; - goto end; - } - - BT_LOGI("Loaded all plugins: count=%u", loaded_plugins->len); - -end: - return ret; -} - static void print_plugin_info(const bt_plugin *plugin) { @@ -1034,7 +752,7 @@ int cmd_help(struct bt_config *cfg) const bt_plugin *plugin = NULL; const bt_component_class *needed_comp_cls = NULL; - plugin = find_plugin(cfg->cmd_data.help.cfg_component->plugin_name->str); + plugin = find_loaded_plugin(cfg->cmd_data.help.cfg_component->plugin_name->str); if (!plugin) { BT_CLI_LOGE_APPEND_CAUSE( "Cannot find plugin: plugin-name=\"%s\"", @@ -1149,14 +867,14 @@ int cmd_list_plugins(struct bt_config *cfg) printf("From the following plugin paths:\n\n"); print_value(stdout, cfg->plugin_paths, 2); printf("\n"); - plugins_count = loaded_plugins->len; + plugins_count = get_loaded_plugins_count(); if (plugins_count == 0) { printf("No plugins found.\n"); goto end; } for (i = 0; i < plugins_count; i++) { - const bt_plugin *plugin = g_ptr_array_index(loaded_plugins, i); + const bt_plugin *plugin = borrow_loaded_plugin(i); component_classes_count += bt_plugin_get_source_component_class_count(plugin) + @@ -1173,7 +891,7 @@ int cmd_list_plugins(struct bt_config *cfg) bt_common_color_reset()); for (i = 0; i < plugins_count; i++) { - const bt_plugin *plugin = g_ptr_array_index(loaded_plugins, i); + const bt_plugin *plugin = borrow_loaded_plugin(i); printf("\n"); print_plugin_info(plugin); @@ -1214,7 +932,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; @@ -1272,16 +990,12 @@ int cmd_print_lttng_live_sessions(struct bt_config *cfg) } } - 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; @@ -1299,7 +1013,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_signed_integer_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) { @@ -1307,7 +1021,7 @@ int cmd_print_lttng_live_sessions(struct bt_config *cfg) "Missing `stream-count` entry."); goto error; } - streams = bt_value_signed_integer_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) { @@ -1315,7 +1029,7 @@ int cmd_print_lttng_live_sessions(struct bt_config *cfg) "Missing `client-count` entry."); goto error; } - clients = bt_value_signed_integer_get(v); + clients = bt_value_integer_unsigned_get(v); fprintf(out_stream, "%" PRIu64 " client(s) connected)\n", clients); } @@ -1483,8 +1197,8 @@ gboolean port_id_equal(gconstpointer v1, gconstpointer v2) const struct port_id *id1 = v1; const struct port_id *id2 = v2; - return !strcmp(id1->instance_name, id2->instance_name) && - !strcmp(id1->port_name, id2->port_name); + return strcmp(id1->instance_name, id2->instance_name) == 0 && + strcmp(id1->port_name, id2->port_name) == 0; } static @@ -1794,9 +1508,6 @@ int cmd_run_ctx_connect_upstream_port_to_downstream_component( switch (connect_ports_status) { case BT_GRAPH_CONNECT_PORTS_STATUS_OK: break; - case BT_GRAPH_CONNECT_PORTS_STATUS_CANCELED: - BT_CLI_LOGW_APPEND_CAUSE("Graph was canceled by user."); - break; default: BT_CLI_LOGE_APPEND_CAUSE( "Cannot create connection: graph refuses to connect ports: " @@ -2016,15 +1727,141 @@ void cmd_run_ctx_destroy(struct cmd_run_ctx *ctx) } BT_GRAPH_PUT_REF_AND_RESET(ctx->graph); - the_graph = NULL; 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; @@ -2055,12 +1892,37 @@ 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; } - the_graph = ctx->graph; + 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, NULL); @@ -2089,6 +1951,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, @@ -2096,110 +2068,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) { + if (!bt_value_is_map(trace_info)) { 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) { - 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_signed_integer_get(intersection_begin); - end = bt_value_signed_integer_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++) { @@ -2210,41 +2167,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)); @@ -2252,29 +2224,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; } @@ -2362,6 +2329,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; } } @@ -2521,9 +2490,9 @@ int cmd_run(struct bt_config *cfg) goto error; } - if (canceled) { + if (bt_interrupter_is_set(the_interrupter)) { BT_CLI_LOGW_APPEND_CAUSE( - "Canceled by user before creating components."); + "Interrupted by user before creating components."); goto error; } @@ -2535,9 +2504,9 @@ int cmd_run(struct bt_config *cfg) goto error; } - if (canceled) { + if (bt_interrupter_is_set(the_interrupter)) { BT_CLI_LOGW_APPEND_CAUSE( - "Canceled by user before connecting components."); + "Interrupted by user before connecting components."); goto error; } @@ -2550,12 +2519,6 @@ int cmd_run(struct bt_config *cfg) goto error; } - if (canceled) { - BT_CLI_LOGW_APPEND_CAUSE( - "Canceled by user before running the graph."); - goto error; - } - BT_LOGI_STR("Running the graph."); /* Run the graph */ @@ -2575,13 +2538,10 @@ int cmd_run(struct bt_config *cfg) switch (run_status) { case BT_GRAPH_RUN_STATUS_OK: break; - case BT_GRAPH_RUN_STATUS_CANCELED: - BT_CLI_LOGW_APPEND_CAUSE("Graph was canceled by user."); - goto error; case BT_GRAPH_RUN_STATUS_AGAIN: - if (bt_graph_is_canceled(ctx.graph)) { + if (bt_interrupter_is_set(the_interrupter)) { BT_CLI_LOGW_APPEND_CAUSE( - "Graph was canceled by user."); + "Graph was interrupted by user."); goto error; } @@ -2591,9 +2551,9 @@ int cmd_run(struct bt_config *cfg) cfg->cmd_data.run.retry_duration_us); if (usleep(cfg->cmd_data.run.retry_duration_us)) { - if (bt_graph_is_canceled(ctx.graph)) { + if (bt_interrupter_is_set(the_interrupter)) { BT_CLI_LOGW_APPEND_CAUSE( - "Graph was canceled by user."); + "Graph was interrupted by user."); goto error; } } @@ -2602,6 +2562,14 @@ int cmd_run(struct bt_config *cfg) 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; + } + BT_CLI_LOGE_APPEND_CAUSE( "Graph failed to complete successfully"); goto error; @@ -2653,87 +2621,6 @@ 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) { @@ -2842,9 +2729,7 @@ void print_error_causes(void) } end: - if (folded) { - g_string_free(folded, TRUE); - } + BT_ASSERT(!folded); if (error) { bt_error_release(error); @@ -2855,12 +2740,22 @@ int main(int argc, const char **argv) { int ret; int retcode; - struct bt_config *cfg; + struct bt_config *cfg = NULL; init_log_level(); set_signal_handler(); - init_static_data(); - cfg = bt_config_cli_args_create_with_default(argc, argv, &retcode); + init_loaded_plugins(); + + 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 */ @@ -2877,16 +2772,15 @@ 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) { - ret = load_all_plugins(cfg->plugin_paths); + ret = require_loaded_plugins(cfg->plugin_paths); if (ret) { BT_CLI_LOGE_APPEND_CAUSE( "Failed to load plugins: ret=%d", ret); @@ -2929,7 +2823,8 @@ int main(int argc, const char **argv) end: BT_OBJECT_PUT_REF_AND_RESET(cfg); - fini_static_data(); + fini_loaded_plugins(); + bt_interrupter_put_ref(the_interrupter); if (retcode != 0) { print_error_causes();