X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=src%2Fcli%2Fbabeltrace2.c;h=bb0411a65fe8f174912ce86003998de9dfe67ae3;hb=b5cd7d6593ad0dba510172268777a521442387d7;hp=4cc4234ee646edc8de6a3db7ed1a8750d4f6cce2;hpb=1376311317cd9d9a390ad758174e6340f3e3f96f;p=babeltrace.git

diff --git a/src/cli/babeltrace2.c b/src/cli/babeltrace2.c
index 4cc4234e..bb0411a6 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;
@@ -334,13 +355,9 @@ void print_value_rec(FILE *fp, const bt_value *value, size_t indent)
 	uint64_t uint_val;
 	double dbl_val;
 	const char *str_val;
-	int size;
-	int i;
 	GPtrArray *map_keys = NULL;
 
-	if (!value) {
-		goto end;
-	}
+	BT_ASSERT(value);
 
 	switch (bt_value_get_type(value)) {
 	case BT_VALUE_TYPE_NULL:
@@ -378,11 +395,9 @@ void print_value_rec(FILE *fp, const bt_value *value, size_t indent)
 			bt_common_color_reset());
 		break;
 	case BT_VALUE_TYPE_ARRAY:
+	{
+		uint64_t i, size;
 		size = bt_value_array_get_length(value);
-		if (size < 0) {
-			goto error;
-		}
-
 		if (size == 0) {
 			print_indent(fp, indent);
 			fprintf(fp, "[ ]\n");
@@ -394,9 +409,6 @@ void print_value_rec(FILE *fp, const bt_value *value, size_t indent)
 				bt_value_array_borrow_element_by_index_const(
 					value, i);
 
-			if (!element) {
-				goto error;
-			}
 			print_indent(fp, indent);
 			fprintf(fp, "- ");
 
@@ -420,6 +432,7 @@ void print_value_rec(FILE *fp, const bt_value *value, size_t indent)
 			print_value_rec(fp, element, indent + 2);
 		}
 		break;
+	}
 	case BT_VALUE_TYPE_MAP:
 	{
 		guint i;
@@ -464,15 +477,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);
@@ -626,7 +635,7 @@ void print_cfg(struct bt_config *cfg)
 		print_cfg_print_lttng_live_sessions(cfg);
 		break;
 	default:
-		abort();
+		bt_common_abort();
 	}
 }
 
@@ -682,9 +691,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;
@@ -700,8 +710,7 @@ 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,
@@ -712,6 +721,7 @@ int cmd_query(struct bt_config *cfg)
 	}
 
 	print_value(stdout, results, 0);
+	cmd_status = BT_CMD_STATUS_OK;
 	goto end;
 
 failed:
@@ -723,12 +733,13 @@ failed:
 		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
@@ -756,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;
 
@@ -767,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);
@@ -787,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;
 	}
 
@@ -801,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 *,
@@ -821,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,
@@ -869,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");
@@ -926,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;
@@ -942,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;
 
@@ -988,7 +1004,6 @@ int cmd_print_lttng_live_sessions(struct bt_config *cfg)
 			fopen(cfg->cmd_data.print_lttng_live_sessions.output_path->str,
 				"w");
 		if (!out_stream) {
-			ret = -1;
 			BT_LOGE_ERRNO("Cannot open file for writing",
 				": path=\"%s\"",
 				cfg->cmd_data.print_lttng_live_sessions.output_path->str);
@@ -996,7 +1011,7 @@ int cmd_print_lttng_live_sessions(struct bt_config *cfg)
 				"Babeltrace CLI",
 				"Cannot open file for writing: path=\"%s\"",
 				cfg->cmd_data.print_lttng_live_sessions.output_path->str);
-			goto end;
+			goto error;
 		}
 	}
 
@@ -1006,10 +1021,6 @@ int cmd_print_lttng_live_sessions(struct bt_config *cfg)
 		int64_t timer_us, streams, clients;
 
 		map = bt_value_array_borrow_element_by_index_const(results, i);
-		if (!map) {
-			BT_CLI_LOGE_APPEND_CAUSE("Unexpected empty array entry.");
-			goto error;
-		}
 		if (!bt_value_is_map(map)) {
 			BT_CLI_LOGE_APPEND_CAUSE("Unexpected entry type.");
 			goto error;
@@ -1047,6 +1058,7 @@ 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:
@@ -1054,7 +1066,7 @@ failed:
 		fail_reason);
 
 error:
-	ret = -1;
+	cmd_status = BT_CMD_STATUS_ERROR;
 
 end:
 	bt_value_put_ref(results);
@@ -1071,13 +1083,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;
@@ -1099,21 +1112,18 @@ 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",
@@ -1127,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);
@@ -1145,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;
 		}
 	}
 
@@ -1155,16 +1163,17 @@ int cmd_print_ctf_metadata(struct bt_config *cfg)
 		BT_CLI_LOGE_APPEND_CAUSE(
 			"Cannot write whole metadata text to output stream: "
 			"ret=%d", ret);
-		goto end;
+		goto error;
 	}
 
-	ret = 0;
+	cmd_status = BT_CMD_STATUS_OK;
 	goto end;
 
 failed:
-	ret = -1;
 	BT_CLI_LOGE_APPEND_CAUSE(
 		"Failed to query `metadata-info` object: %s", fail_reason);
+error:
+	cmd_status = BT_CMD_STATUS_ERROR;
 
 end:
 	bt_value_put_ref(results);
@@ -1181,7 +1190,7 @@ end:
 		}
 	}
 
-	return ret;
+	return cmd_status;
 }
 
 struct port_id {
@@ -1974,8 +1983,7 @@ static
 int compute_stream_intersection(const bt_value *streams,
 		struct trace_range *range)
 {
-	unsigned int i;
-	unsigned int stream_count;
+	uint64_t i, stream_count;
 	int ret;
 
 	BT_ASSERT(bt_value_get_type(streams) == BT_VALUE_TYPE_ARRAY);
@@ -2055,7 +2063,6 @@ int compute_stream_intersection(const bt_value *streams,
 				"range-ns:begin=%" PRId64 ", "
 				"range-ns:end=%" PRId64,
 				begin_ns, end_ns);
-			ret = -1;
 			goto error;
 		}
 
@@ -2084,7 +2091,7 @@ int set_stream_intersections(struct cmd_run_ctx *ctx,
 {
 	int ret = 0;
 	uint64_t trace_idx;
-	int64_t trace_count;
+	uint64_t trace_count;
 	const bt_value *query_result = NULL;
 	const bt_value *trace_info = NULL;
 	const bt_value *stream_infos = NULL;
@@ -2099,7 +2106,7 @@ int set_stream_intersections(struct cmd_run_ctx *ctx,
 		cfg_comp->params, &query_result,
 		&fail_reason);
 	if (ret) {
-		BT_CLI_LOGE_APPEND_CAUSE("Component class does not support the `babeltrace.trace-infos` query: %s: "
+		BT_CLI_LOGE_APPEND_CAUSE("Failed to execute `babeltrace.trace-infos` query: %s: "
 			"comp-class-name=\"%s\"", fail_reason,
 			bt_component_class_get_name(comp_cls));
 		ret = -1;
@@ -2118,7 +2125,7 @@ int set_stream_intersections(struct cmd_run_ctx *ctx,
 	}
 
 	trace_count = bt_value_array_get_length(query_result);
-	if (trace_count < 0) {
+	if (trace_count == 0) {
 		BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: result is empty: "
 			"component-class-name=%s", bt_component_class_get_name(comp_cls));
 		ret = -1;
@@ -2132,7 +2139,6 @@ int set_stream_intersections(struct cmd_run_ctx *ctx,
 
 		trace_info = bt_value_array_borrow_element_by_index_const(
 			query_result, trace_idx);
-		BT_ASSERT(trace_info);
 		if (!bt_value_is_map(trace_info)) {
 			ret = -1;
 			BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: expecting element to be a map: "
@@ -2162,7 +2168,7 @@ int set_stream_intersections(struct cmd_run_ctx *ctx,
 		}
 
 		stream_count = bt_value_array_get_length(stream_infos);
-		if (stream_count < 0) {
+		if (stream_count == 0) {
 			ret = -1;
 			BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: list of streams is empty: "
 				"component-class-name=%s",
@@ -2206,7 +2212,6 @@ int set_stream_intersections(struct cmd_run_ctx *ctx,
 
 			stream_info = bt_value_array_borrow_element_by_index_const(
 				stream_infos, stream_idx);
-			BT_ASSERT(stream_info);
 			if (!bt_value_is_map(stream_info)) {
 				ret = -1;
 				BT_CLI_LOGE_APPEND_CAUSE("`babeltrace.trace-infos` query: "
@@ -2294,7 +2299,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) {
@@ -2329,7 +2334,7 @@ int cmd_run_ctx_create_components_from_config_components(
 				(void *) &comp);
 			break;
 		default:
-			abort();
+			bt_common_abort();
 		}
 
 		if (ret) {
@@ -2372,7 +2377,7 @@ int cmd_run_ctx_create_components_from_config_components(
 				GUINT_TO_POINTER(quark), (void *) comp);
 			break;
 		default:
-			abort();
+			bt_common_abort();
 		}
 
 		comp = NULL;
@@ -2496,9 +2501,9 @@ end:
 }
 
 static
-int cmd_run(struct bt_config *cfg)
+enum bt_cmd_status cmd_run(struct bt_config *cfg)
 {
-	int ret = 0;
+	enum bt_cmd_status cmd_status;
 	struct cmd_run_ctx ctx = { 0 };
 
 	/* Initialize the command's context and the graph object */
@@ -2555,12 +2560,15 @@ int cmd_run(struct bt_config *cfg)
 
 		switch (run_status) {
 		case BT_GRAPH_RUN_STATUS_OK:
-			break;
+			cmd_status = BT_CMD_STATUS_OK;
+			goto end;
 		case BT_GRAPH_RUN_STATUS_AGAIN:
 			if (bt_interrupter_is_set(the_interrupter)) {
-				BT_CLI_LOGW_APPEND_CAUSE(
-					"Graph was interrupted by user.");
-				goto error;
+				/*
+				 * The graph was interrupted by a SIGINT.
+				 */
+				cmd_status = BT_CMD_STATUS_INTERRUPTED;
+				goto end;
 			}
 
 			if (cfg->cmd_data.run.retry_duration_us > 0) {
@@ -2570,22 +2578,16 @@ int cmd_run(struct bt_config *cfg)
 
 				if (usleep(cfg->cmd_data.run.retry_duration_us)) {
 					if (bt_interrupter_is_set(the_interrupter)) {
-						BT_CLI_LOGW_APPEND_CAUSE(
-							"Graph was interrupted by user.");
-						goto error;
+						cmd_status = BT_CMD_STATUS_INTERRUPTED;
+						goto end;
 					}
 				}
 			}
 			break;
-		case BT_GRAPH_RUN_STATUS_END:
-			goto end;
 		default:
 			if (bt_interrupter_is_set(the_interrupter)) {
-				BT_CLI_LOGW_APPEND_CAUSE(
-					"Graph was interrupted by user and failed: "
-					"status=%s",
-					bt_common_func_status_string(run_status));
-				goto error;
+				cmd_status = BT_CMD_STATUS_INTERRUPTED;
+				goto end;
 			}
 
 			BT_CLI_LOGE_APPEND_CAUSE(
@@ -2593,17 +2595,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
@@ -2718,7 +2715,7 @@ 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 */
@@ -2756,8 +2753,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();
@@ -2812,42 +2809,53 @@ 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;
+		print_error_causes();
+		break;
+	case BT_CMD_STATUS_INTERRUPTED:
+		retcode = 2;
+		break;
+	default:
+		BT_LOGF("Invalid command status: cmd-status=%d", cmd_status);
+		bt_common_abort();
+	}
 
 end:
 	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.