mbox series

[v3,00/18] clang-tools support in tools

Message ID 20231009183920.200859-1-irogers@google.com (mailing list archive)
Headers show
Series clang-tools support in tools | expand

Message

Ian Rogers Oct. 9, 2023, 6:39 p.m. UTC
Allow the clang-tools scripts to work with builds in tools such as
tools/perf and tools/lib/perf. An example use looks like:

```
$ cd tools/perf
$ make CC=clang CXX=clang++
$ ../../scripts/clang-tools/gen_compile_commands.py
$ ../../scripts/clang-tools/run-clang-tools.py clang-tidy compile_commands.json -checks=-*,readability-named-parameter
Skipping non-C file: 'tools/perf/bench/mem-memcpy-x86-64-asm.S'
Skipping non-C file: 'tools/perf/bench/mem-memset-x86-64-asm.S'
Skipping non-C file: 'tools/perf/arch/x86/tests/regs_load.S'
8 warnings generated.
Suppressed 8 warnings (8 in non-user code).
Use -header-filter=.* to display errors from all non-system headers. Use -system-headers to display errors from system headers as well.
2 warnings generated.
4 warnings generated.
Suppressed 4 warnings (4 in non-user code).
Use -header-filter=.* to display errors from all non-system headers. Use -system-headers to display errors from system headers as well.
2 warnings generated.
4 warnings generated.
Suppressed 4 warnings (4 in non-user code).
Use -header-filter=.* to display errors from all non-system headers. Use -system-headers to display errors from system headers as well.
3 warnings generated.
tools/perf/util/parse-events-flex.c:546:27: warning: all parameters should be named in a function [readability-named-parameter]
void *yyalloc ( yy_size_t , yyscan_t yyscanner );
                          ^
                           /*size*/
...
```

Fix a number of the more serious low-hanging issues in perf found by
clang-tidy.

This support isn't complete, in particular it doesn't support output
directories properly and so fails for tools/lib/bpf, tools/bpf/bpftool
and if an output directory is used.

v3. Add Nick Desaulniers reviewed-by to patch 3. For Namhyung, drop
    "perf hisi-ptt: Fix potential memory leak", split lock change out
    of "perf svghelper: Avoid memory leak" and address comments in
    "perf header: Fix various error path memory leaks".
v2: Address comments by Nick Desaulniers in patch 3, and add their
    Reviewed-by to patches 1 and 2.

Ian Rogers (18):
  gen_compile_commands: Allow the line prefix to still be cmd_
  gen_compile_commands: Sort output compile commands by file name
  run-clang-tools: Add pass through checks and header-filter arguments
  perf bench uprobe: Fix potential use of memory after free
  perf buildid-cache: Fix use of uninitialized value
  perf env: Remove unnecessary NULL tests
  perf jitdump: Avoid memory leak
  perf mem-events: Avoid uninitialized read
  perf dlfilter: Be defensive against potential NULL dereference
  perf hists browser: Reorder variables to reduce padding
  perf hists browser: Avoid potential NULL dereference
  perf svghelper: Avoid memory leak
  perf lock: Fix a memory leak on an error path
  perf parse-events: Fix unlikely memory leak when cloning terms
  tools api: Avoid potential double free
  perf trace-event-info: Avoid passing NULL value to closedir
  perf header: Fix various error path memory leaks
  perf bpf_counter: Fix a few memory leaks

 scripts/clang-tools/gen_compile_commands.py |  8 +--
 scripts/clang-tools/run-clang-tools.py      | 32 ++++++++---
 tools/lib/api/io.h                          |  1 +
 tools/perf/bench/uprobe.c                   |  1 +
 tools/perf/builtin-buildid-cache.c          |  6 ++-
 tools/perf/builtin-lock.c                   |  1 +
 tools/perf/ui/browsers/hists.c              |  6 +--
 tools/perf/util/bpf_counter.c               |  5 +-
 tools/perf/util/dlfilter.c                  |  4 +-
 tools/perf/util/env.c                       |  6 +--
 tools/perf/util/header.c                    | 60 ++++++++++++---------
 tools/perf/util/jitdump.c                   |  1 +
 tools/perf/util/mem-events.c                |  3 +-
 tools/perf/util/parse-events.c              |  4 +-
 tools/perf/util/svghelper.c                 |  5 +-
 tools/perf/util/trace-event-info.c          |  3 +-
 16 files changed, 94 insertions(+), 52 deletions(-)

Comments

Namhyung Kim Oct. 10, 2023, 5:31 a.m. UTC | #1
Hi Ian,

On Mon, Oct 9, 2023 at 11:39 AM Ian Rogers <irogers@google.com> wrote:
>
> Allow the clang-tools scripts to work with builds in tools such as
> tools/perf and tools/lib/perf. An example use looks like:
>
> ```
> $ cd tools/perf
> $ make CC=clang CXX=clang++
> $ ../../scripts/clang-tools/gen_compile_commands.py
> $ ../../scripts/clang-tools/run-clang-tools.py clang-tidy compile_commands.json -checks=-*,readability-named-parameter
> Skipping non-C file: 'tools/perf/bench/mem-memcpy-x86-64-asm.S'
> Skipping non-C file: 'tools/perf/bench/mem-memset-x86-64-asm.S'
> Skipping non-C file: 'tools/perf/arch/x86/tests/regs_load.S'
> 8 warnings generated.
> Suppressed 8 warnings (8 in non-user code).
> Use -header-filter=.* to display errors from all non-system headers. Use -system-headers to display errors from system headers as well.
> 2 warnings generated.
> 4 warnings generated.
> Suppressed 4 warnings (4 in non-user code).
> Use -header-filter=.* to display errors from all non-system headers. Use -system-headers to display errors from system headers as well.
> 2 warnings generated.
> 4 warnings generated.
> Suppressed 4 warnings (4 in non-user code).
> Use -header-filter=.* to display errors from all non-system headers. Use -system-headers to display errors from system headers as well.
> 3 warnings generated.
> tools/perf/util/parse-events-flex.c:546:27: warning: all parameters should be named in a function [readability-named-parameter]
> void *yyalloc ( yy_size_t , yyscan_t yyscanner );
>                           ^
>                            /*size*/
> ...
> ```
>
> Fix a number of the more serious low-hanging issues in perf found by
> clang-tidy.
>
> This support isn't complete, in particular it doesn't support output
> directories properly and so fails for tools/lib/bpf, tools/bpf/bpftool
> and if an output directory is used.
>
> v3. Add Nick Desaulniers reviewed-by to patch 3. For Namhyung, drop
>     "perf hisi-ptt: Fix potential memory leak", split lock change out
>     of "perf svghelper: Avoid memory leak" and address comments in
>     "perf header: Fix various error path memory leaks".
> v2: Address comments by Nick Desaulniers in patch 3, and add their
>     Reviewed-by to patches 1 and 2.
>
> Ian Rogers (18):
>   gen_compile_commands: Allow the line prefix to still be cmd_
>   gen_compile_commands: Sort output compile commands by file name
>   run-clang-tools: Add pass through checks and header-filter arguments
>   perf bench uprobe: Fix potential use of memory after free
>   perf buildid-cache: Fix use of uninitialized value
>   perf env: Remove unnecessary NULL tests
>   perf jitdump: Avoid memory leak
>   perf mem-events: Avoid uninitialized read
>   perf dlfilter: Be defensive against potential NULL dereference
>   perf hists browser: Reorder variables to reduce padding
>   perf hists browser: Avoid potential NULL dereference
>   perf svghelper: Avoid memory leak
>   perf lock: Fix a memory leak on an error path
>   perf parse-events: Fix unlikely memory leak when cloning terms
>   tools api: Avoid potential double free
>   perf trace-event-info: Avoid passing NULL value to closedir
>   perf header: Fix various error path memory leaks
>   perf bpf_counter: Fix a few memory leaks

I agree with your comment on v2 that it needs more work
to clean the code up.  Anyway I'm ok with v3 now.

For ther perf part (patch 4 to 18),
Acked-by: Namhyung Kim <namhyung@kernel.org>

Thanks,
Namhyung

>
>  scripts/clang-tools/gen_compile_commands.py |  8 +--
>  scripts/clang-tools/run-clang-tools.py      | 32 ++++++++---
>  tools/lib/api/io.h                          |  1 +
>  tools/perf/bench/uprobe.c                   |  1 +
>  tools/perf/builtin-buildid-cache.c          |  6 ++-
>  tools/perf/builtin-lock.c                   |  1 +
>  tools/perf/ui/browsers/hists.c              |  6 +--
>  tools/perf/util/bpf_counter.c               |  5 +-
>  tools/perf/util/dlfilter.c                  |  4 +-
>  tools/perf/util/env.c                       |  6 +--
>  tools/perf/util/header.c                    | 60 ++++++++++++---------
>  tools/perf/util/jitdump.c                   |  1 +
>  tools/perf/util/mem-events.c                |  3 +-
>  tools/perf/util/parse-events.c              |  4 +-
>  tools/perf/util/svghelper.c                 |  5 +-
>  tools/perf/util/trace-event-info.c          |  3 +-
>  16 files changed, 94 insertions(+), 52 deletions(-)
>
> --
> 2.42.0.609.gbb76f46606-goog
>
Namhyung Kim Oct. 12, 2023, 5:23 p.m. UTC | #2
On Mon, Oct 9, 2023 at 10:31 PM Namhyung Kim <namhyung@kernel.org> wrote:
>
> Hi Ian,
>
> On Mon, Oct 9, 2023 at 11:39 AM Ian Rogers <irogers@google.com> wrote:
> >
> > Allow the clang-tools scripts to work with builds in tools such as
> > tools/perf and tools/lib/perf. An example use looks like:
> >
> > ```
> > $ cd tools/perf
> > $ make CC=clang CXX=clang++
> > $ ../../scripts/clang-tools/gen_compile_commands.py
> > $ ../../scripts/clang-tools/run-clang-tools.py clang-tidy compile_commands.json -checks=-*,readability-named-parameter
> > Skipping non-C file: 'tools/perf/bench/mem-memcpy-x86-64-asm.S'
> > Skipping non-C file: 'tools/perf/bench/mem-memset-x86-64-asm.S'
> > Skipping non-C file: 'tools/perf/arch/x86/tests/regs_load.S'
> > 8 warnings generated.
> > Suppressed 8 warnings (8 in non-user code).
> > Use -header-filter=.* to display errors from all non-system headers. Use -system-headers to display errors from system headers as well.
> > 2 warnings generated.
> > 4 warnings generated.
> > Suppressed 4 warnings (4 in non-user code).
> > Use -header-filter=.* to display errors from all non-system headers. Use -system-headers to display errors from system headers as well.
> > 2 warnings generated.
> > 4 warnings generated.
> > Suppressed 4 warnings (4 in non-user code).
> > Use -header-filter=.* to display errors from all non-system headers. Use -system-headers to display errors from system headers as well.
> > 3 warnings generated.
> > tools/perf/util/parse-events-flex.c:546:27: warning: all parameters should be named in a function [readability-named-parameter]
> > void *yyalloc ( yy_size_t , yyscan_t yyscanner );
> >                           ^
> >                            /*size*/
> > ...
> > ```
> >
> > Fix a number of the more serious low-hanging issues in perf found by
> > clang-tidy.
> >
> > This support isn't complete, in particular it doesn't support output
> > directories properly and so fails for tools/lib/bpf, tools/bpf/bpftool
> > and if an output directory is used.
> >
> > v3. Add Nick Desaulniers reviewed-by to patch 3. For Namhyung, drop
> >     "perf hisi-ptt: Fix potential memory leak", split lock change out
> >     of "perf svghelper: Avoid memory leak" and address comments in
> >     "perf header: Fix various error path memory leaks".
> > v2: Address comments by Nick Desaulniers in patch 3, and add their
> >     Reviewed-by to patches 1 and 2.
> >
> > Ian Rogers (18):
> >   gen_compile_commands: Allow the line prefix to still be cmd_
> >   gen_compile_commands: Sort output compile commands by file name
> >   run-clang-tools: Add pass through checks and header-filter arguments
> >   perf bench uprobe: Fix potential use of memory after free
> >   perf buildid-cache: Fix use of uninitialized value
> >   perf env: Remove unnecessary NULL tests
> >   perf jitdump: Avoid memory leak
> >   perf mem-events: Avoid uninitialized read
> >   perf dlfilter: Be defensive against potential NULL dereference
> >   perf hists browser: Reorder variables to reduce padding
> >   perf hists browser: Avoid potential NULL dereference
> >   perf svghelper: Avoid memory leak
> >   perf lock: Fix a memory leak on an error path
> >   perf parse-events: Fix unlikely memory leak when cloning terms
> >   tools api: Avoid potential double free
> >   perf trace-event-info: Avoid passing NULL value to closedir
> >   perf header: Fix various error path memory leaks
> >   perf bpf_counter: Fix a few memory leaks
>
> I agree with your comment on v2 that it needs more work
> to clean the code up.  Anyway I'm ok with v3 now.
>
> For ther perf part (patch 4 to 18),
> Acked-by: Namhyung Kim <namhyung@kernel.org>

Applied to perf-tools-next, thanks!