X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=src%2Fcli%2Fbabeltrace2.c;h=0339426dc4e7c8f33f037679ead7eb2cc6520ba8;hb=927c069356ec0754daf592601145313155e9ce94;hp=80082d07d78e95e25c2e14ab2e839fd92476fc52;hpb=502332367236f0cc3bf05dc3c2c34ca48f3e2a2f;p=babeltrace.git diff --git a/src/cli/babeltrace2.c b/src/cli/babeltrace2.c index 80082d07..0339426d 100644 --- a/src/cli/babeltrace2.c +++ b/src/cli/babeltrace2.c @@ -45,6 +45,27 @@ #define ENV_BABELTRACE_WARN_COMMAND_NAME_DIRECTORY_CLASH "BABELTRACE_CLI_WARN_COMMAND_NAME_DIRECTORY_CLASH" #define NSEC_PER_SEC 1000000000LL +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; @@ -193,7 +214,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; @@ -245,7 +266,7 @@ void print_plugin_comp_cls_opt(FILE *fh, const char *plugin_name, fprintf(fh, "'%s%s%s%s", bt_common_color_bold(), - bt_common_color_fg_cyan(), + bt_common_color_fg_bright_cyan(), component_type_str(type), bt_common_color_fg_default()); @@ -309,13 +330,14 @@ end: } static -bt_bool collect_map_keys(const char *key, const bt_value *object, void *data) +bt_value_map_foreach_entry_const_func_status collect_map_keys( + const char *key, const bt_value *object, void *data) { GPtrArray *map_keys = data; g_ptr_array_add(map_keys, (gpointer *) key); - return BT_TRUE; + return BT_VALUE_MAP_FOREACH_ENTRY_CONST_FUNC_STATUS_OK; } static @@ -334,12 +356,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; GPtrArray *map_keys = NULL; - if (!value) { - goto end; - } + BT_ASSERT(value); switch (bt_value_get_type(value)) { case BT_VALUE_TYPE_NULL: @@ -349,41 +368,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: { - guint i; + uint64_t i, size; size = bt_value_array_get_length(value); - if (size < 0) { - goto error; - } - if (size == 0) { print_indent(fp, indent); fprintf(fp, "[ ]\n"); @@ -395,9 +410,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, "- "); @@ -466,15 +478,11 @@ void print_value_rec(FILE *fp, const bt_value *value, size_t indent) break; } default: - abort(); + bt_common_abort(); } goto end; -error: - BT_LOGE("Error printing value of type %s.", - bt_common_value_type_string(bt_value_get_type(value))); - end: if (map_keys) { g_ptr_array_free(map_keys, TRUE); @@ -628,7 +636,7 @@ void print_cfg(struct bt_config *cfg) print_cfg_print_lttng_live_sessions(cfg); break; default: - abort(); + bt_common_abort(); } } @@ -652,7 +660,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(), @@ -684,9 +692,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; @@ -702,35 +711,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 @@ -758,9 +767,9 @@ void print_component_class_help(const char *plugin_name, } 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; @@ -769,8 +778,7 @@ int cmd_help(struct bt_config *cfg) 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); @@ -789,6 +797,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; } @@ -803,19 +812,23 @@ 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 *, @@ -823,6 +836,7 @@ 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, @@ -871,9 +885,8 @@ end: } 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"); @@ -928,13 +941,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; @@ -944,7 +958,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; @@ -974,7 +988,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); @@ -990,7 +1006,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); @@ -998,7 +1013,7 @@ int cmd_print_lttng_live_sessions(struct bt_config *cfg) "Babeltrace CLI", "Cannot open file for writing: path=\"%s\"", cfg->cmd_data.print_lttng_live_sessions.output_path->str); - goto end; + goto error; } } @@ -1008,10 +1023,6 @@ int cmd_print_lttng_live_sessions(struct bt_config *cfg) int64_t timer_us, streams, clients; map = bt_value_array_borrow_element_by_index_const(results, i); - if (!map) { - BT_CLI_LOGE_APPEND_CAUSE("Unexpected empty array entry."); - goto error; - } if (!bt_value_is_map(map)) { BT_CLI_LOGE_APPEND_CAUSE("Unexpected entry type."); goto error; @@ -1049,14 +1060,11 @@ int cmd_print_lttng_live_sessions(struct bt_config *cfg) fprintf(out_stream, "%" PRIu64 " client(s) connected)\n", clients); } + cmd_status = BT_CMD_STATUS_OK; goto end; -failed: - BT_CLI_LOGE_APPEND_CAUSE("Failed to query `sessions` object: %s", - fail_reason); - error: - ret = -1; + cmd_status = BT_CMD_STATUS_ERROR; end: bt_value_put_ref(results); @@ -1073,13 +1081,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; @@ -1101,27 +1110,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, @@ -1129,8 +1137,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); @@ -1147,8 +1154,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; } } @@ -1157,16 +1163,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); @@ -1183,7 +1187,7 @@ end: } } - return ret; + return cmd_status; } struct port_id { @@ -1976,8 +1980,7 @@ static int compute_stream_intersection(const bt_value *streams, struct trace_range *range) { - unsigned int i; - unsigned int stream_count; + uint64_t i, stream_count; int ret; BT_ASSERT(bt_value_get_type(streams) == BT_VALUE_TYPE_ARRAY); @@ -2085,7 +2088,7 @@ int set_stream_intersections(struct cmd_run_ctx *ctx, { int ret = 0; uint64_t trace_idx; - int64_t trace_count; + uint64_t trace_count; const bt_value *query_result = NULL; const bt_value *trace_info = NULL; const bt_value *stream_infos = NULL; @@ -2119,7 +2122,7 @@ int set_stream_intersections(struct cmd_run_ctx *ctx, } trace_count = bt_value_array_get_length(query_result); - if (trace_count < 0) { + if (trace_count == 0) { BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: result is empty: " "component-class-name=%s", bt_component_class_get_name(comp_cls)); ret = -1; @@ -2133,7 +2136,6 @@ int set_stream_intersections(struct cmd_run_ctx *ctx, trace_info = bt_value_array_borrow_element_by_index_const( query_result, trace_idx); - BT_ASSERT(trace_info); if (!bt_value_is_map(trace_info)) { ret = -1; BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: expecting element to be a map: " @@ -2163,7 +2165,7 @@ int set_stream_intersections(struct cmd_run_ctx *ctx, } stream_count = bt_value_array_get_length(stream_infos); - if (stream_count < 0) { + if (stream_count == 0) { ret = -1; BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: list of streams is empty: " "component-class-name=%s", @@ -2207,7 +2209,6 @@ int set_stream_intersections(struct cmd_run_ctx *ctx, stream_info = bt_value_array_borrow_element_by_index_const( stream_infos, stream_idx); - BT_ASSERT(stream_info); if (!bt_value_is_map(stream_info)) { ret = -1; BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: " @@ -2295,7 +2296,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) { @@ -2330,7 +2331,7 @@ int cmd_run_ctx_create_components_from_config_components( (void *) &comp); break; default: - abort(); + bt_common_abort(); } if (ret) { @@ -2373,7 +2374,7 @@ int cmd_run_ctx_create_components_from_config_components( GUINT_TO_POINTER(quark), (void *) comp); break; default: - abort(); + bt_common_abort(); } comp = NULL; @@ -2497,9 +2498,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 */ @@ -2556,12 +2557,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) { @@ -2571,22 +2575,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( @@ -2594,17 +2592,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 @@ -2650,7 +2643,7 @@ void print_error_causes(void) 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; } @@ -2677,7 +2670,7 @@ void print_error_causes(void) /* Print prefix */ fprintf(stderr, prefix_fmt, - bt_common_color_bold(), bt_common_color_fg_red(), + bt_common_color_bold(), bt_common_color_fg_bright_red(), bt_common_color_reset()); /* Print actor name */ @@ -2719,13 +2712,13 @@ void print_error_causes(void) bt_error_cause_message_iterator_actor_get_component_class_type(cause)); break; default: - abort(); + bt_common_abort(); } /* Print file name and line number */ fprintf(stderr, "] (%s%s%s%s:%s%" PRIu64 "%s)\n", bt_common_color_bold(), - bt_common_color_fg_magenta(), + bt_common_color_fg_bright_magenta(), bt_error_cause_get_file_name(cause), bt_common_color_reset(), bt_common_color_fg_green(), @@ -2757,8 +2750,8 @@ end: int main(int argc, const char **argv) { - int ret; - int retcode; + int ret, retcode; + enum bt_cmd_status cmd_status; struct bt_config *cfg = NULL; init_log_level(); @@ -2813,42 +2806,56 @@ int main(int argc, const char **argv) switch (cfg->command) { case BT_CONFIG_COMMAND_RUN: - ret = cmd_run(cfg); + cmd_status = cmd_run(cfg); break; case BT_CONFIG_COMMAND_LIST_PLUGINS: - ret = cmd_list_plugins(cfg); + cmd_status = cmd_list_plugins(cfg); break; case BT_CONFIG_COMMAND_HELP: - ret = cmd_help(cfg); + cmd_status = cmd_help(cfg); break; case BT_CONFIG_COMMAND_QUERY: - ret = cmd_query(cfg); + cmd_status = cmd_query(cfg); break; case BT_CONFIG_COMMAND_PRINT_CTF_METADATA: - ret = cmd_print_ctf_metadata(cfg); + cmd_status = cmd_print_ctf_metadata(cfg); break; case BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS: - ret = cmd_print_lttng_live_sessions(cfg); + cmd_status = cmd_print_lttng_live_sessions(cfg); break; default: BT_LOGF("Invalid/unknown command: cmd=%d", cfg->command); - abort(); + bt_common_abort(); } - BT_LOGI("Command completed: cmd=%d, command-name=\"%s\", ret=%d", - cfg->command, cfg->command_name, ret); + BT_LOGI("Command completed: cmd=%d, command-name=\"%s\", command-status=\"%s\"", + cfg->command, cfg->command_name, bt_cmd_status_string(cmd_status)); warn_command_name_and_directory_clash(cfg); - retcode = ret ? 1 : 0; + + switch (cmd_status) { + case BT_CMD_STATUS_OK: + retcode = 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.