[PATCH] rtla: Fix exit status when returning from calls to usage()

[PATCH] rtla: Fix exit status when returning from calls to usage()

[John Kacur]

rtla_usage(), osnoise_usage() and timerlat_usage() all exit with an
error status

However when these are called from help, they should exit with a
non-error status.

Fix this by passing the exit status to the functions

Note, although we remove the subsequent call to exit after calling
usage, we leave it in at the end of a function to supress the compiler
warning "control reaches end of a non-void function"

Signed-off-by: John Kacur <jkacur@redhat.com>
---
 tools/tracing/rtla/src/osnoise.c  |  9 ++++-----
 tools/tracing/rtla/src/rtla.c     | 12 +++++-------
 tools/tracing/rtla/src/timerlat.c |  9 ++++-----
 3 files changed, 13 insertions(+), 17 deletions(-)

diff --git a/tools/tracing/rtla/src/osnoise.c b/tools/tracing/rtla/src/osnoise.c
index b8ec6c15bccb..4dee343909b1 100644
--- a/tools/tracing/rtla/src/osnoise.c
+++ b/tools/tracing/rtla/src/osnoise.c
@@ -903,7 +903,7 @@ struct osnoise_tool *osnoise_init_trace_tool(char *tracer)
 	return NULL;
 }
 
-static void osnoise_usage(void)
+static void osnoise_usage(int err)
 {
 	int i;
 
@@ -923,7 +923,7 @@ static void osnoise_usage(void)
 
 	for (i = 0; msg[i]; i++)
 		fprintf(stderr, "%s\n", msg[i]);
-	exit(1);
+	exit(err);
 }
 
 int osnoise_main(int argc, char *argv[])
@@ -941,8 +941,7 @@ int osnoise_main(int argc, char *argv[])
 	}
 
 	if ((strcmp(argv[1], "-h") == 0) || (strcmp(argv[1], "--help") == 0)) {
-		osnoise_usage();
-		exit(0);
+		osnoise_usage(0);
 	} else if (strncmp(argv[1], "-", 1) == 0) {
 		/* the user skipped the tool, call the default one */
 		osnoise_top_main(argc, argv);
@@ -956,6 +955,6 @@ int osnoise_main(int argc, char *argv[])
 	}
 
 usage:
-	osnoise_usage();
+	osnoise_usage(1);
 	exit(1);
 }
diff --git a/tools/tracing/rtla/src/rtla.c b/tools/tracing/rtla/src/rtla.c
index 09bd21b8af81..52e8f1825281 100644
--- a/tools/tracing/rtla/src/rtla.c
+++ b/tools/tracing/rtla/src/rtla.c
@@ -14,7 +14,7 @@
 /*
  * rtla_usage - print rtla usage
  */
-static void rtla_usage(void)
+static void rtla_usage(int err)
 {
 	int i;
 
@@ -33,7 +33,7 @@ static void rtla_usage(void)
 
 	for (i = 0; msg[i]; i++)
 		fprintf(stderr, "%s\n", msg[i]);
-	exit(1);
+	exit(err);
 }
 
 /*
@@ -70,11 +70,9 @@ int main(int argc, char *argv[])
 		goto usage;
 
 	if (strcmp(argv[1], "-h") == 0) {
-		rtla_usage();
-		exit(0);
+		rtla_usage(0);
 	} else if (strcmp(argv[1], "--help") == 0) {
-		rtla_usage();
-		exit(0);
+		rtla_usage(0);
 	}
 
 	retval = run_command(argc, argv, 1);
@@ -82,6 +80,6 @@ int main(int argc, char *argv[])
 		exit(0);
 
 usage:
-	rtla_usage();
+	rtla_usage(1);
 	exit(1);
 }
diff --git a/tools/tracing/rtla/src/timerlat.c b/tools/tracing/rtla/src/timerlat.c
index 97abbf494fee..21cdcc5c4a29 100644
--- a/tools/tracing/rtla/src/timerlat.c
+++ b/tools/tracing/rtla/src/timerlat.c
@@ -14,7 +14,7 @@
 
 #include "timerlat.h"
 
-static void timerlat_usage(void)
+static void timerlat_usage(int err)
 {
 	int i;
 
@@ -34,7 +34,7 @@ static void timerlat_usage(void)
 
 	for (i = 0; msg[i]; i++)
 		fprintf(stderr, "%s\n", msg[i]);
-	exit(1);
+	exit(err);
 }
 
 int timerlat_main(int argc, char *argv[])
@@ -52,8 +52,7 @@ int timerlat_main(int argc, char *argv[])
 	}
 
 	if ((strcmp(argv[1], "-h") == 0) || (strcmp(argv[1], "--help") == 0)) {
-		timerlat_usage();
-		exit(0);
+		timerlat_usage(0);
 	} else if (strncmp(argv[1], "-", 1) == 0) {
 		/* the user skipped the tool, call the default one */
 		timerlat_top_main(argc, argv);
@@ -67,6 +66,6 @@ int timerlat_main(int argc, char *argv[])
 	}
 
 usage:
-	timerlat_usage();
+	timerlat_usage(1);
 	exit(1);
 }
-- 
2.38.1

Re: [PATCH] rtla: Fix exit status when returning from calls to usage()

[Daniel Bristot de Oliveira]

On 11/3/22 14:57, John Kacur wrote:
> rtla_usage(), osnoise_usage() and timerlat_usage() all exit with an
> error status

missing .

> However when these are called from help, they should exit with a
> non-error status.
> 
> Fix this by passing the exit status to the functions

missing .

> Note, although we remove the subsequent call to exit after calling
> usage, we leave it in at the end of a function to supress the compiler

suppress?

> warning "control reaches end of a non-void function"

missing .

Yep, that is a problem, and agree with the solution (I am already doing it
in the rv cmd line).

-- Daniel

Re: [PATCH] rtla: Fix exit status when returning from calls to usage()

[John Kacur]

On Fri, 4 Nov 2022, Daniel Bristot de Oliveira wrote:

> On 11/3/22 14:57, John Kacur wrote:
> > rtla_usage(), osnoise_usage() and timerlat_usage() all exit with an
> > error status
> 
> missing .
?

> 
> > However when these are called from help, they should exit with a
> > non-error status.
> > 
> > Fix this by passing the exit status to the functions
> 
> missing .
?

> 
> > Note, although we remove the subsequent call to exit after calling
> > usage, we leave it in at the end of a function to supress the compiler
> 
> suppress?
Of course, thanks for the spelling check!

> 
> > warning "control reaches end of a non-void function"
> 
> missing .
?

> 
> Yep, that is a problem, and agree with the solution (I am already doing it
> in the rv cmd line).
cool

> 
> -- Daniel
> 

Re: [PATCH] rtla: Fix exit status when returning from calls to usage()

[Daniel Bristot de Oliveira]

On 11/7/22 14:53, John Kacur wrote:
> 
> On Fri, 4 Nov 2022, Daniel Bristot de Oliveira wrote:
> 
>> On 11/3/22 14:57, John Kacur wrote:
>>> rtla_usage(), osnoise_usage() and timerlat_usage() all exit with an
>>> error status
>> missing .
> ?
> 

rtla_usage(), osnoise_usage() and timerlat_usage() all exit with an
error status.

and so on...

-- Daniel