Received-SPF: pass (google.com: domain of linux-kernel+bounces-163304-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.48.161 as permitted sender) client-ip=147.75.48.161;
Precedence: bulk
MIME-Version: 1.0
References: <20240429233707.1511175-1-namhyung@kernel.org>
In-Reply-To: <20240429233707.1511175-1-namhyung@kernel.org>
From: Ian Rogers <irogers@google.com>
Date: Mon, 29 Apr 2024 20:36:38 -0700
Message-ID: <CAP-5=fWWML91BsOfF1wvJcDFPG4=S_b3cTe_gza6GDQyWYjksA@mail.gmail.com>
Subject: Re: [PATCH v2] tools lib subcmd: Show parent options in help
To: Namhyung Kim <namhyung@kernel.org>
Cc: Arnaldo Carvalho de Melo <acme@kernel.org>, Kan Liang <kan.liang@linux.intel.com>, 
	Jiri Olsa <jolsa@kernel.org>, Adrian Hunter <adrian.hunter@intel.com>, 
	Peter Zijlstra <peterz@infradead.org>, Ingo Molnar <mingo@kernel.org>, 
	LKML <linux-kernel@vger.kernel.org>, linux-perf-users@vger.kernel.org
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable

On Mon, Apr 29, 2024 at 4:37=E2=80=AFPM Namhyung Kim <namhyung@kernel.org> =
wrote:
>
> 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>] [<option=
s>]
>
>       -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>] [<option=
s>]
>
>       -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 --p=
id)
>
> Signed-off-by: Namhyung Kim <namhyung@kernel.org>

Reviewed-by: Ian Rogers <irogers@google.com>

Thanks,
Ian

> ---
> *v2: remove goto and add comments  (Ian)
>
>  tools/lib/subcmd/parse-options.c | 36 +++++++++++++++++++++-----------
>  1 file changed, 24 insertions(+), 12 deletions(-)
>
> diff --git a/tools/lib/subcmd/parse-options.c b/tools/lib/subcmd/parse-op=
tions.c
> index 9fa75943f2ed..eb896d30545b 100644
> --- a/tools/lib/subcmd/parse-options.c
> +++ b/tools/lib/subcmd/parse-options.c
> @@ -806,18 +806,30 @@ static int option__cmp(const void *va, const void *=
vb)
>
>  static struct option *options__order(const struct option *opts)
>  {
> -       int nr_opts =3D 0, nr_group =3D 0, len;
> -       const struct option *o =3D opts;
> -       struct option *opt, *ordered, *group;
> -
> -       for (o =3D opts; o->type !=3D OPTION_END; o++)
> -               ++nr_opts;
> -
> -       len =3D sizeof(*o) * (nr_opts + 1);
> -       ordered =3D malloc(len);
> -       if (!ordered)
> -               goto out;
> -       memcpy(ordered, opts, len);
> +       int nr_opts =3D 0, nr_group =3D 0, nr_parent =3D 0, len;
> +       const struct option *o, *p =3D opts;
> +       struct option *opt, *ordered =3D NULL, *group;
> +
> +       /* flatten the options that have parents */
> +       for (p =3D opts; p !=3D NULL; p =3D o->parent) {
> +               for (o =3D p; o->type !=3D OPTION_END; o++)
> +                       ++nr_opts;
> +
> +               /*
> +                * the length is given by the number of options plus a nu=
ll
> +                * terminator for the last loop iteration.
> +                */
> +               len =3D sizeof(*o) * (nr_opts + !o->parent);
> +               group =3D realloc(ordered, len);
> +               if (!group)
> +                       goto out;
> +               ordered =3D group;
> +               memcpy(&ordered[nr_parent], p, sizeof(*o) * (nr_opts - nr=
_parent));
> +
> +               nr_parent =3D nr_opts;
> +       }
> +       /* copy the last OPTION_END */
> +       memcpy(&ordered[nr_opts], o, sizeof(*o));
>
>         /* sort each option group individually */
>         for (opt =3D group =3D ordered; opt->type !=3D OPTION_END; opt++)=
 {
> --
> 2.44.0.769.g3c40516874-goog
>