Skip to contentSkip to conversation

tools/lib/subcmd: Don't free the usage string

RFC PATCH In review Aditya Gupta 2 participants 3 messages Jul 17, 2024 – Jul 18, 2024 perf events

lore
Share & tools
lore
#0 lore raw

RFC PATCH 1/1 tools/lib/subcmd: Don't free the usage string

Currently, commands which depend on 'parse_options_subcommand()' don't show the usage string, and instead show '(null)'

    $ ./perf sched
	Usage: (null)
    -D, --dump-raw-trace  dump raw trace in ASCII
    -f, --force           don't complain, do it
    -i, --input <file>    input file name
    -v, --verbose         be more verbose (show symbol address, etc)

'parse_options_subcommand()' is generally expected to initialise the usage string, with information in the passed 'subcommands[]' array

This behaviour was changed in:

commit 230a7a71f9221 ("libsubcmd: Fix parse-options memory leak")

Where the generated usage string is deallocated, and usage[0] string is reassigned as NULL.

As discussed in [1], free the allocated usage string in the main function itself, and don't reset usage string to NULL in parse_options_subcommand

With this change, the behaviour is restored.

    $ ./perf sched
        Usage: perf sched [<options>] {record|latency|map|replay|script|timehist}
           -D, --dump-raw-trace  dump raw trace in ASCII
           -f, --force           don't complain, do it
           -i, --input <file>    input file name
           -v, --verbose         be more verbose (show symbol address, etc)

[1]: https://lore.kernel.org/linux-perf-users/htq5vhx6piet4nuq2mmhk7fs2bhfykv52dbppwxmo3s7du2odf@styd27tioc6e/

Cc Arnaldo Carvalho de Melo <[email protected]>
Cc Jiri Olsa <[email protected]>
Cc Ian Rogers <[email protected]>
Cc Namhyung Kim <[email protected]>
Fixes 230a7a71f922 ("libsubcmd: Fix parse-options memory leak")
---
 tools/lib/subcmd/parse-options.c | 8 +++-----
 tools/perf/builtin-kmem.c        | 2 ++
 tools/perf/builtin-kvm.c         | 3 +++
 tools/perf/builtin-kwork.c       | 3 +++
 tools/perf/builtin-lock.c        | 3 +++
 tools/perf/builtin-mem.c         | 3 +++
 tools/perf/builtin-sched.c       | 3 +++
 7 files changed, 20 insertions(+), 5 deletions(-)
tools/lib/subcmd/parse-options.c +3 -5
index 4b60ec03b0bb..eb896d30545b 100644
@@ -633,10 +633,11 @@ int parse_options_subcommand(int argc, const char **argv, const struct option *o
 			const char *const subcommands[], const char *usagestr[], int flags)
 {
 	struct parse_opt_ctx_t ctx;
-	char *buf = NULL;
 
 	/* build usage string if it's not provided */
 	if (subcommands && !usagestr[0]) {
+		char *buf = NULL;
+
 		astrcatf(&buf, "%s %s [<options>] {", subcmd_config.exec_name, argv[0]);
 
 		for (int i = 0; subcommands[i]; i++) {
@@ -678,10 +679,7 @@ int parse_options_subcommand(int argc, const char **argv, const struct option *o
 			astrcatf(&error_buf, "unknown switch `%c'", *ctx.opt);
 		usage_with_options(usagestr, options);
 	}
-	if (buf) {
-		usagestr[0] = NULL;
-		free(buf);
-	}
+
 	return parse_options_end(&ctx);
 }
 
tools/perf/builtin-kmem.c +2 -0
index 6fd95be5032b..6b88b8b40784 100644
@@ -2058,6 +2058,8 @@ int cmd_kmem(int argc, const char **argv)
 
 out_delete:
 	perf_session__delete(session);
+	/* free usage string allocated by parse_options_subcommand */
+	free((void *)kmem_usage[0]);
 
 	return ret;
 }
tools/perf/builtin-kvm.c +3 -0
index 71165036e4ca..988bef73bd09 100644
@@ -2187,5 +2187,8 @@ int cmd_kvm(int argc, const char **argv)
 	else
 		usage_with_options(kvm_usage, kvm_options);
 
+	/* free usage string allocated by parse_options_subcommand */
+	free((void *)kvm_usage[0]);
+
 	return 0;
 }
tools/perf/builtin-kwork.c +3 -0
index 56e3f3a5e03a..fd53838b5a78 100644
@@ -2520,5 +2520,8 @@ int cmd_kwork(int argc, const char **argv)
 	} else
 		usage_with_options(kwork_usage, kwork_options);
 
+	/* free usage string allocated by parse_options_subcommand */
+	free((void *)kwork_usage[0]);
+
 	return 0;
 }
tools/perf/builtin-lock.c +3 -0
index 0253184b3b58..b25d50716e63 100644
@@ -2713,6 +2713,9 @@ int cmd_lock(int argc, const char **argv)
 		usage_with_options(lock_usage, lock_options);
 	}
 
+	/* free usage string allocated by parse_options_subcommand */
+	free((void *)lock_usage[0]);
+
 	zfree(&lockhash_table);
 	return rc;
 }
tools/perf/builtin-mem.c +3 -0
index 863fcd735dae..b7c1cf6d0e5a 100644
@@ -517,5 +517,8 @@ int cmd_mem(int argc, const char **argv)
 	else
 		usage_with_options(mem_usage, mem_options);
 
+	/* free usage string allocated by parse_options_subcommand */
+	free((void *)mem_usage[0]);
+
 	return 0;
 }
tools/perf/builtin-sched.c +3 -0
index 8750b5f2d49b..d6acc53ae89e 100644
@@ -3805,5 +3805,8 @@ int cmd_sched(int argc, const char **argv)
 		usage_with_options(sched_usage, sched_options);
 	}
 
+	/* free usage string allocated by parse_options_subcommand */
+	free((void *)sched_usage[0]);
+
 	return 0;
 }
Signature · 1 line
2.45.2
maintainer Acked-by on v1 1/1
#1 lore raw
Quoted 36 lines · Aditya Gupta

Currently, commands which depend on 'parse_options_subcommand()' don't show the usage string, and instead show '(null)'

    $ ./perf sched
	Usage: (null)
    -D, --dump-raw-trace  dump raw trace in ASCII
    -f, --force           don't complain, do it
    -i, --input <file>    input file name
    -v, --verbose         be more verbose (show symbol address, etc)

'parse_options_subcommand()' is generally expected to initialise the usage string, with information in the passed 'subcommands[]' array

This behaviour was changed in:

commit 230a7a71f9221 ("libsubcmd: Fix parse-options memory leak")

Where the generated usage string is deallocated, and usage[0] string is reassigned as NULL.

As discussed in [1], free the allocated usage string in the main function itself, and don't reset usage string to NULL in parse_options_subcommand

With this change, the behaviour is restored.

    $ ./perf sched
        Usage: perf sched [<options>] {record|latency|map|replay|script|timehist}
           -D, --dump-raw-trace  dump raw trace in ASCII
           -f, --force           don't complain, do it
           -i, --input <file>    input file name
           -v, --verbose         be more verbose (show symbol address, etc)

[1]: https://lore.kernel.org/linux-perf-users/htq5vhx6piet4nuq2mmhk7fs2bhfykv52dbppwxmo3s7du2odf@styd27tioc6e/

Quoted 7 lines
Cc Arnaldo Carvalho de Melo <[email protected]>
Cc Jiri Olsa <[email protected]>
Cc Ian Rogers <[email protected]>
Cc Namhyung Kim <[email protected]>
Fixes 230a7a71f922 ("libsubcmd: Fix parse-options memory leak")

Thanks,
Namhyung

Quoted 121 lines
---
 tools/lib/subcmd/parse-options.c | 8 +++-----
 tools/perf/builtin-kmem.c        | 2 ++
 tools/perf/builtin-kvm.c         | 3 +++
 tools/perf/builtin-kwork.c       | 3 +++
 tools/perf/builtin-lock.c        | 3 +++
 tools/perf/builtin-mem.c         | 3 +++
 tools/perf/builtin-sched.c       | 3 +++
 7 files changed, 20 insertions(+), 5 deletions(-)
tools/lib/subcmd/parse-options.c +3 -5
index 4b60ec03b0bb..eb896d30545b 100644
@@ -633,10 +633,11 @@ int parse_options_subcommand(int argc, const char **argv, const struct option *o
 			const char *const subcommands[], const char *usagestr[], int flags)
 {
 	struct parse_opt_ctx_t ctx;
-	char *buf = NULL;
 
 	/* build usage string if it's not provided */
 	if (subcommands && !usagestr[0]) {
+		char *buf = NULL;
+
 		astrcatf(&buf, "%s %s [<options>] {", subcmd_config.exec_name, argv[0]);
 
 		for (int i = 0; subcommands[i]; i++) {
@@ -678,10 +679,7 @@ int parse_options_subcommand(int argc, const char **argv, const struct option *o
 			astrcatf(&error_buf, "unknown switch `%c'", *ctx.opt);
 		usage_with_options(usagestr, options);
 	}
-	if (buf) {
-		usagestr[0] = NULL;
-		free(buf);
-	}
+
 	return parse_options_end(&ctx);
 }
 
tools/perf/builtin-kmem.c +2 -0
index 6fd95be5032b..6b88b8b40784 100644
@@ -2058,6 +2058,8 @@ int cmd_kmem(int argc, const char **argv)
 
 out_delete:
 	perf_session__delete(session);
+	/* free usage string allocated by parse_options_subcommand */
+	free((void *)kmem_usage[0]);
 
 	return ret;
 }
tools/perf/builtin-kvm.c +3 -0
index 71165036e4ca..988bef73bd09 100644
@@ -2187,5 +2187,8 @@ int cmd_kvm(int argc, const char **argv)
 	else
 		usage_with_options(kvm_usage, kvm_options);
 
+	/* free usage string allocated by parse_options_subcommand */
+	free((void *)kvm_usage[0]);
+
 	return 0;
 }
tools/perf/builtin-kwork.c +3 -0
index 56e3f3a5e03a..fd53838b5a78 100644
@@ -2520,5 +2520,8 @@ int cmd_kwork(int argc, const char **argv)
 	} else
 		usage_with_options(kwork_usage, kwork_options);
 
+	/* free usage string allocated by parse_options_subcommand */
+	free((void *)kwork_usage[0]);
+
 	return 0;
 }
tools/perf/builtin-lock.c +3 -0
index 0253184b3b58..b25d50716e63 100644
@@ -2713,6 +2713,9 @@ int cmd_lock(int argc, const char **argv)
 		usage_with_options(lock_usage, lock_options);
 	}
 
+	/* free usage string allocated by parse_options_subcommand */
+	free((void *)lock_usage[0]);
+
 	zfree(&lockhash_table);
 	return rc;
 }
tools/perf/builtin-mem.c +3 -0
index 863fcd735dae..b7c1cf6d0e5a 100644
@@ -517,5 +517,8 @@ int cmd_mem(int argc, const char **argv)
 	else
 		usage_with_options(mem_usage, mem_options);
 
+	/* free usage string allocated by parse_options_subcommand */
+	free((void *)mem_usage[0]);
+
 	return 0;
 }
tools/perf/builtin-sched.c +3 -0
index 8750b5f2d49b..d6acc53ae89e 100644
@@ -3805,5 +3805,8 @@ int cmd_sched(int argc, const char **argv)
 		usage_with_options(sched_usage, sched_options);
 	}
 
+	/* free usage string allocated by parse_options_subcommand */
+	free((void *)sched_usage[0]);
+
 	return 0;
 }
Signature · 1 line
2.45.2
#2 lore raw
Quoted 2 lines

<...snip...>

Thanks for the Ack, Namhyung !

- Aditya Gupta

Quoted 124 lines

Thanks,
Namhyung

Quoted 121 lines
---
  tools/lib/subcmd/parse-options.c | 8 +++-----
  tools/perf/builtin-kmem.c        | 2 ++
  tools/perf/builtin-kvm.c         | 3 +++
  tools/perf/builtin-kwork.c       | 3 +++
  tools/perf/builtin-lock.c        | 3 +++
  tools/perf/builtin-mem.c         | 3 +++
  tools/perf/builtin-sched.c       | 3 +++
  7 files changed, 20 insertions(+), 5 deletions(-)
tools/lib/subcmd/parse-options.c +3 -5
index 4b60ec03b0bb..eb896d30545b 100644
@@ -633,10 +633,11 @@ int parse_options_subcommand(int argc, const char **argv, const struct option *o
  			const char *const subcommands[], const char *usagestr[], int flags)
  {
  	struct parse_opt_ctx_t ctx;
-	char *buf = NULL;
 
  	/* build usage string if it's not provided */
  	if (subcommands && !usagestr[0]) {
+		char *buf = NULL;
+
  		astrcatf(&buf, "%s %s [<options>] {", subcmd_config.exec_name, argv[0]);
 
  		for (int i = 0; subcommands[i]; i++) {
@@ -678,10 +679,7 @@ int parse_options_subcommand(int argc, const char **argv, const struct option *o
  			astrcatf(&error_buf, "unknown switch `%c'", *ctx.opt);
  		usage_with_options(usagestr, options);
  	}
-	if (buf) {
-		usagestr[0] = NULL;
-		free(buf);
-	}
+
  	return parse_options_end(&ctx);
  }
 
tools/perf/builtin-kmem.c +2 -0
index 6fd95be5032b..6b88b8b40784 100644
@@ -2058,6 +2058,8 @@ int cmd_kmem(int argc, const char **argv)
 
  out_delete:
  	perf_session__delete(session);
+	/* free usage string allocated by parse_options_subcommand */
+	free((void *)kmem_usage[0]);
 
  	return ret;
  }
tools/perf/builtin-kvm.c +3 -0
index 71165036e4ca..988bef73bd09 100644
@@ -2187,5 +2187,8 @@ int cmd_kvm(int argc, const char **argv)
  	else
  		usage_with_options(kvm_usage, kvm_options);
 
+	/* free usage string allocated by parse_options_subcommand */
+	free((void *)kvm_usage[0]);
+
  	return 0;
  }
tools/perf/builtin-kwork.c +3 -0
index 56e3f3a5e03a..fd53838b5a78 100644
@@ -2520,5 +2520,8 @@ int cmd_kwork(int argc, const char **argv)
  	} else
  		usage_with_options(kwork_usage, kwork_options);
 
+	/* free usage string allocated by parse_options_subcommand */
+	free((void *)kwork_usage[0]);
+
  	return 0;
  }
tools/perf/builtin-lock.c +3 -0
index 0253184b3b58..b25d50716e63 100644
@@ -2713,6 +2713,9 @@ int cmd_lock(int argc, const char **argv)
  		usage_with_options(lock_usage, lock_options);
  	}
 
+	/* free usage string allocated by parse_options_subcommand */
+	free((void *)lock_usage[0]);
+
  	zfree(&lockhash_table);
  	return rc;
  }
tools/perf/builtin-mem.c +3 -0
index 863fcd735dae..b7c1cf6d0e5a 100644
@@ -517,5 +517,8 @@ int cmd_mem(int argc, const char **argv)
  	else
  		usage_with_options(mem_usage, mem_options);
 
+	/* free usage string allocated by parse_options_subcommand */
+	free((void *)mem_usage[0]);
+
  	return 0;
  }
tools/perf/builtin-sched.c +3 -0
index 8750b5f2d49b..d6acc53ae89e 100644
@@ -3805,5 +3805,8 @@ int cmd_sched(int argc, const char **argv)
  		usage_with_options(sched_usage, sched_options);
  	}
 
+	/* free usage string allocated by parse_options_subcommand */
+	free((void *)sched_usage[0]);
+
  	return 0;
  }
Signature · 1 line
2.45.2