Skip to contentSkip to conversation

tools lib subcmd: Show parent options in help

PATCH Superseded Namhyung Kim 2 participants 4 messages May 25, 2023 – Jun 23, 2023

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 tools lib subcmd: Show parent options in help

I've just realized that help message in a subcommand didn't show one in the parent command. Since the option parser understands the parent, display code should do the same. For example, perf ftrace latency -h should show options in the perf ftrace command too.

Before:

  $ perf ftrace latency -h

Usage: perf ftrace [<options>] [<command>]

      or: perf ftrace [<options>] -- [<command>] [<options>]
      or: perf ftrace {trace|latency} [<options>] [<command>]
      or: perf ftrace {trace|latency} [<options>] -- [<command>] [<options>]

      -b, --use-bpf         Use BPF to measure function latency
      -n, --use-nsec        Use nano-second histogram
      -T, --trace-funcs <func>
                            Show latency of given function

After:

  $ perf ftrace latency -h

Usage: perf ftrace [<options>] [<command>]
or: perf ftrace [<options>] -- [<command>] [<options>]
or: perf ftrace {trace|latency} [<options>] [<command>]
or: perf ftrace {trace|latency} [<options>] -- [<command>] [<options>]

-a, --all-cpus System-wide collection from all CPUs
-b, --use-bpf Use BPF to measure function latency
-C, --cpu <cpu> List of cpus to monitor
-n, --use-nsec Use nano-second histogram
-p, --pid <pid> Trace on existing process id
-T, --trace-funcs <func>
Show latency of given function
-v, --verbose Be more verbose
--tid <tid> Trace on existing thread id (exclusive to --pid)

---
 tools/lib/subcmd/parse-options.c | 26 ++++++++++++++++++--------
 1 file changed, 18 insertions(+), 8 deletions(-)
tools/lib/subcmd/parse-options.c +18 -8
index 9fa75943f2ed..41de97671c72 100644
@@ -806,18 +806,28 @@ static int option__cmp(const void *va, const void *vb)
 
 static struct option *options__order(const struct option *opts)
 {
-	int nr_opts = 0, nr_group = 0, len;
-	const struct option *o = opts;
-	struct option *opt, *ordered, *group;
+	int nr_opts = 0, nr_group = 0, nr_parent = 0, len;
+	const struct option *o, *p = opts;
+	struct option *opt, *ordered = NULL, *group;
 
-	for (o = opts; o->type != OPTION_END; o++)
+retry:
+	for (o = p; o->type != OPTION_END; o++)
 		++nr_opts;
 
-	len = sizeof(*o) * (nr_opts + 1);
-	ordered = malloc(len);
-	if (!ordered)
+	len = sizeof(*o) * (nr_opts + !o->parent);
+	group = realloc(ordered, len);
+	if (!group)
 		goto out;
-	memcpy(ordered, opts, len);
+	ordered = group;
+	memcpy(&ordered[nr_parent], p, sizeof(*o) * (nr_opts - nr_parent));
+
+	if (o->parent) {
+		p = o->parent;
+		nr_parent = nr_opts;
+		goto retry;
+	}
+	/* copy the last OPTION_END */
+	memcpy(&ordered[nr_opts], o, sizeof(*o));
 
 	/* sort each option group individually */
 	for (opt = group = ordered; opt->type != OPTION_END; opt++) {
Signature · 1 line
2.41.0.rc0.172.g3f132b7071-goog
#1 lore raw
Quoted 51 lines · Namhyung Kim

I've just realized that help message in a subcommand didn't show one in the parent command. Since the option parser understands the parent, display code should do the same. For example, perf ftrace latency -h should show options in the perf ftrace command too.

Before:

  $ perf ftrace latency -h

Usage: perf ftrace [<options>] [<command>]

      or: perf ftrace [<options>] -- [<command>] [<options>]
      or: perf ftrace {trace|latency} [<options>] [<command>]
      or: perf ftrace {trace|latency} [<options>] -- [<command>] [<options>]

      -b, --use-bpf         Use BPF to measure function latency
      -n, --use-nsec        Use nano-second histogram
      -T, --trace-funcs <func>
                            Show latency of given function

After:

  $ perf ftrace latency -h

Usage: perf ftrace [<options>] [<command>]
or: perf ftrace [<options>] -- [<command>] [<options>]
or: perf ftrace {trace|latency} [<options>] [<command>]
or: perf ftrace {trace|latency} [<options>] -- [<command>] [<options>]

-a, --all-cpus System-wide collection from all CPUs
-b, --use-bpf Use BPF to measure function latency
-C, --cpu <cpu> List of cpus to monitor
-n, --use-nsec Use nano-second histogram
-p, --pid <pid> Trace on existing process id
-T, --trace-funcs <func>
Show latency of given function
-v, --verbose Be more verbose
--tid <tid> Trace on existing thread id (exclusive to --pid)

---
 tools/lib/subcmd/parse-options.c | 26 ++++++++++++++++++--------
 1 file changed, 18 insertions(+), 8 deletions(-)
tools/lib/subcmd/parse-options.c +0 -0
index 9fa75943f2ed..41de97671c72 100644
@@ -806,18 +806,28 @@ static int option__cmp(const void *va, const void *vb)
 
 static struct option *options__order(const struct option *opts)

tools/lib/subcmd/parse-options.c static int option__cmp(const void *va, const void *vb) · line 813

Quoted 10 lines
tools/lib/subcmd/parse-options.c +4 -4
 {
-       int nr_opts = 0, nr_group = 0, len;
-       const struct option *o = opts;
-       struct option *opt, *ordered, *group;
+       int nr_opts = 0, nr_group = 0, nr_parent = 0, len;
+       const struct option *o, *p = opts;
+       struct option *opt, *ordered = NULL, *group;
 
-       for (o = opts; o->type != OPTION_END; o++)
+retry:

Why use "goto retry" and not compute the size with the parent upfront?

tools/lib/subcmd/parse-options.c static int option__cmp(const void *va, const void *vb) · line 817

Quoted 7 lines
tools/lib/subcmd/parse-options.c +2 -3
+       for (o = p; o->type != OPTION_END; o++)
                ++nr_opts;
 
-       len = sizeof(*o) * (nr_opts + 1);
-       ordered = malloc(len);
-       if (!ordered)
+       len = sizeof(*o) * (nr_opts + !o->parent);

It'd be nice to comment on why the "!o->parent" here.

Thanks,
Ian

Quoted 20 lines
tools/lib/subcmd/parse-options.c +12 -2
+       group = realloc(ordered, len);
+       if (!group)
                goto out;
-       memcpy(ordered, opts, len);
+       ordered = group;
+       memcpy(&ordered[nr_parent], p, sizeof(*o) * (nr_opts - nr_parent));
+
+       if (o->parent) {
+               p = o->parent;
+               nr_parent = nr_opts;
+               goto retry;
+       }
+       /* copy the last OPTION_END */
+       memcpy(&ordered[nr_opts], o, sizeof(*o));
 
        /* sort each option group individually */
        for (opt = group = ordered; opt->type != OPTION_END; opt++) {
--

2.41.0.rc0.172.g3f132b7071-goog

#2 lore raw
Quoted 61 lines · Ian Rogers
Quoted 59 lines · Namhyung Kim

I've just realized that help message in a subcommand didn't show one in the parent command. Since the option parser understands the parent, display code should do the same. For example, perf ftrace latency -h should show options in the perf ftrace command too.

Before:

  $ perf ftrace latency -h

Usage: perf ftrace [<options>] [<command>]

      or: perf ftrace [<options>] -- [<command>] [<options>]
      or: perf ftrace {trace|latency} [<options>] [<command>]
      or: perf ftrace {trace|latency} [<options>] -- [<command>] [<options>]

      -b, --use-bpf         Use BPF to measure function latency
      -n, --use-nsec        Use nano-second histogram
      -T, --trace-funcs <func>
                            Show latency of given function

After:

  $ perf ftrace latency -h

Usage: perf ftrace [<options>] [<command>]
or: perf ftrace [<options>] -- [<command>] [<options>]
or: perf ftrace {trace|latency} [<options>] [<command>]
or: perf ftrace {trace|latency} [<options>] -- [<command>] [<options>]

-a, --all-cpus System-wide collection from all CPUs
-b, --use-bpf Use BPF to measure function latency
-C, --cpu <cpu> List of cpus to monitor
-n, --use-nsec Use nano-second histogram
-p, --pid <pid> Trace on existing process id
-T, --trace-funcs <func>
Show latency of given function
-v, --verbose Be more verbose
--tid <tid> Trace on existing thread id (exclusive to --pid)

---
 tools/lib/subcmd/parse-options.c | 26 ++++++++++++++++++--------
 1 file changed, 18 insertions(+), 8 deletions(-)
tools/lib/subcmd/parse-options.c +3 -3
index 9fa75943f2ed..41de97671c72 100644
@@ -806,18 +806,28 @@ static int option__cmp(const void *va, const void *vb)
 
 static struct option *options__order(const struct option *opts)
 {
-       int nr_opts = 0, nr_group = 0, len;
-       const struct option *o = opts;
-       struct option *opt, *ordered, *group;
+       int nr_opts = 0, nr_group = 0, nr_parent = 0, len;
+       const struct option *o, *p = opts;
+       struct option *opt, *ordered = NULL, *group;
 
Quoted 4 lines

tools/lib/subcmd/parse-options.c static int option__cmp(const void *va, const void *vb) · line 813

Quoted 2 lines
tools/lib/subcmd/parse-options.c +1 -1
-       for (o = opts; o->type != OPTION_END; o++)
+retry:

Why use "goto retry" and not compute the size with the parent upfront?

No specific reason, just followed the same pattern as in parse_{short,long}_opt(). :)

Quoted 10 lines

tools/lib/subcmd/parse-options.c static int option__cmp(const void *va, const void *vb) · line 817

Quoted 8 lines
tools/lib/subcmd/parse-options.c +2 -3
+       for (o = p; o->type != OPTION_END; o++)
                ++nr_opts;
 
-       len = sizeof(*o) * (nr_opts + 1);
-       ordered = malloc(len);
-       if (!ordered)
+       len = sizeof(*o) * (nr_opts + !o->parent);

It'd be nice to comment on why the "!o->parent" here.

What about this?

/* It needs a terminating NULL entry when there's no parent */

Thanks,
Namhyung

Quoted 24 lines

Thanks,
Ian

Quoted 20 lines
tools/lib/subcmd/parse-options.c +12 -2
+       group = realloc(ordered, len);
+       if (!group)
                goto out;
-       memcpy(ordered, opts, len);
+       ordered = group;
+       memcpy(&ordered[nr_parent], p, sizeof(*o) * (nr_opts - nr_parent));
+
+       if (o->parent) {
+               p = o->parent;
+               nr_parent = nr_opts;
+               goto retry;
+       }
+       /* copy the last OPTION_END */
+       memcpy(&ordered[nr_opts], o, sizeof(*o));
 
        /* sort each option group individually */
        for (opt = group = ordered; opt->type != OPTION_END; opt++) {
--

2.41.0.rc0.172.g3f132b7071-goog

#3 lore raw
Quoted 63 lines · Namhyung Kim
Quoted 61 lines · Ian Rogers
Quoted 59 lines · Namhyung Kim

I've just realized that help message in a subcommand didn't show one in the parent command. Since the option parser understands the parent, display code should do the same. For example, perf ftrace latency -h should show options in the perf ftrace command too.

Before:

  $ perf ftrace latency -h

Usage: perf ftrace [<options>] [<command>]

      or: perf ftrace [<options>] -- [<command>] [<options>]
      or: perf ftrace {trace|latency} [<options>] [<command>]
      or: perf ftrace {trace|latency} [<options>] -- [<command>] [<options>]

      -b, --use-bpf         Use BPF to measure function latency
      -n, --use-nsec        Use nano-second histogram
      -T, --trace-funcs <func>
                            Show latency of given function

After:

  $ perf ftrace latency -h

Usage: perf ftrace [<options>] [<command>]
or: perf ftrace [<options>] -- [<command>] [<options>]
or: perf ftrace {trace|latency} [<options>] [<command>]
or: perf ftrace {trace|latency} [<options>] -- [<command>] [<options>]

-a, --all-cpus System-wide collection from all CPUs
-b, --use-bpf Use BPF to measure function latency
-C, --cpu <cpu> List of cpus to monitor
-n, --use-nsec Use nano-second histogram
-p, --pid <pid> Trace on existing process id
-T, --trace-funcs <func>
Show latency of given function
-v, --verbose Be more verbose
--tid <tid> Trace on existing thread id (exclusive to --pid)

---
 tools/lib/subcmd/parse-options.c | 26 ++++++++++++++++++--------
 1 file changed, 18 insertions(+), 8 deletions(-)
tools/lib/subcmd/parse-options.c +3 -3
index 9fa75943f2ed..41de97671c72 100644
@@ -806,18 +806,28 @@ static int option__cmp(const void *va, const void *vb)
 
 static struct option *options__order(const struct option *opts)
 {
-       int nr_opts = 0, nr_group = 0, len;
-       const struct option *o = opts;
-       struct option *opt, *ordered, *group;
+       int nr_opts = 0, nr_group = 0, nr_parent = 0, len;
+       const struct option *o, *p = opts;
+       struct option *opt, *ordered = NULL, *group;
 
Quoted 7 lines
Quoted 4 lines

tools/lib/subcmd/parse-options.c static int option__cmp(const void *va, const void *vb) · line 813

Quoted 2 lines
tools/lib/subcmd/parse-options.c +1 -1
-       for (o = opts; o->type != OPTION_END; o++)
+retry:

Why use "goto retry" and not compute the size with the parent upfront?

No specific reason, just followed the same pattern as in parse_{short,long}_opt(). :)

:-) Could those loops not be:

for (; options; options = options->parent) {
...
}

rather than using a goto?

Quoted 9 lines
Quoted 9 lines
Quoted 8 lines
tools/lib/subcmd/parse-options.c +2 -3
+       for (o = p; o->type != OPTION_END; o++)
                ++nr_opts;
 
-       len = sizeof(*o) * (nr_opts + 1);
-       ordered = malloc(len);
-       if (!ordered)
+       len = sizeof(*o) * (nr_opts + !o->parent);
Quoted 5 lines
Quoted 1 line

It'd be nice to comment on why the "!o->parent" here.

What about this?

/* It needs a terminating NULL entry when there's no parent */

Perhaps:
the length is given by the number of options plus a null terminator for the last loop iteration.

It may be cleaner to just compute this after nr_opts settles. perhaps something along the lines of:

for (p = .. ; p; p = p->parent)
for (o = p; o->type != OPTION_END; o++)

                 ++nr_opts;

len = sizeof(*o) * (nr_opts + 1); /* +1 for terminator */

Thanks,
Ian

Quoted 28 lines

Thanks,
Namhyung

Quoted 24 lines

Thanks,
Ian

Quoted 20 lines
tools/lib/subcmd/parse-options.c +12 -2
+       group = realloc(ordered, len);
+       if (!group)
                goto out;
-       memcpy(ordered, opts, len);
+       ordered = group;
+       memcpy(&ordered[nr_parent], p, sizeof(*o) * (nr_opts - nr_parent));
+
+       if (o->parent) {
+               p = o->parent;
+               nr_parent = nr_opts;
+               goto retry;
+       }
+       /* copy the last OPTION_END */
+       memcpy(&ordered[nr_opts], o, sizeof(*o));
 
        /* sort each option group individually */
        for (opt = group = ordered; opt->type != OPTION_END; opt++) {
--

2.41.0.rc0.172.g3f132b7071-goog