2023-09-23 07:52:39

by Ian Rogers

[permalink] [raw]
Subject: [PATCH v1 03/18] run-clang-tools: Add pass through checks and and header-filter arguments

Add a -checks argument to allow the checks passed to the clang-tool to
be set on the command line.

Add a pass through -header-filter option.

Signed-off-by: Ian Rogers <[email protected]>
---
scripts/clang-tools/run-clang-tools.py | 34 ++++++++++++++++++++------
1 file changed, 27 insertions(+), 7 deletions(-)

diff --git a/scripts/clang-tools/run-clang-tools.py b/scripts/clang-tools/run-clang-tools.py
index 3266708a8658..5dfe03852cb4 100755
--- a/scripts/clang-tools/run-clang-tools.py
+++ b/scripts/clang-tools/run-clang-tools.py
@@ -33,6 +33,11 @@ def parse_arguments():
path_help = "Path to the compilation database to parse"
parser.add_argument("path", type=str, help=path_help)

+ checks_help = "Checks to pass to the analysis"
+ parser.add_argument("-checks", type=str, default=None, help=checks_help)
+ header_filter_help = "Pass the -header-filter value to the tool"
+ parser.add_argument("-header-filter", type=str, default=None, help=header_filter_help)
+
return parser.parse_args()


@@ -45,14 +50,29 @@ def init(l, a):

def run_analysis(entry):
# Disable all checks, then re-enable the ones we want
- checks = []
- checks.append("-checks=-*")
- if args.type == "clang-tidy":
- checks.append("linuxkernel-*")
+ global args
+ checks = None
+ if args.checks:
+ checks = args.checks.split(',')
else:
- checks.append("clang-analyzer-*")
- checks.append("-clang-analyzer-security.insecureAPI.DeprecatedOrUnsafeBufferHandling")
- p = subprocess.run(["clang-tidy", "-p", args.path, ",".join(checks), entry["file"]],
+ checks = ["-*"]
+ if args.type == "clang-tidy":
+ checks.append("linuxkernel-*")
+ else:
+ checks.append("clang-analyzer-*")
+ checks.append("-clang-analyzer-security.insecureAPI.DeprecatedOrUnsafeBufferHandling")
+ file = entry["file"]
+ if not file.endswith(".c") and not file.endswith(".cpp"):
+ with lock:
+ print(f"Skipping non-C file: '{file}'", file=sys.stderr)
+ return
+ pargs = ["clang-tidy", "-p", args.path]
+ if checks:
+ pargs.append("-checks=" + ",".join(checks))
+ if args.header_filter:
+ pargs.append("-header-filter=" + args.header_filter)
+ pargs.append(file)
+ p = subprocess.run(pargs,
stdout=subprocess.PIPE,
stderr=subprocess.STDOUT,
cwd=entry["directory"])
--
2.42.0.515.g380fc7ccd1-goog


2023-09-25 17:01:08

by Nick Desaulniers

[permalink] [raw]
Subject: Re: [PATCH v1 03/18] run-clang-tools: Add pass through checks and and header-filter arguments

On Fri, Sep 22, 2023 at 10:35 PM Ian Rogers <[email protected]> wrote:
>
> Add a -checks argument to allow the checks passed to the clang-tool to
> be set on the command line.
>
> Add a pass through -header-filter option.
>
> Signed-off-by: Ian Rogers <[email protected]>
> ---
> scripts/clang-tools/run-clang-tools.py | 34 ++++++++++++++++++++------
> 1 file changed, 27 insertions(+), 7 deletions(-)
>
> diff --git a/scripts/clang-tools/run-clang-tools.py b/scripts/clang-tools/run-clang-tools.py
> index 3266708a8658..5dfe03852cb4 100755
> --- a/scripts/clang-tools/run-clang-tools.py
> +++ b/scripts/clang-tools/run-clang-tools.py
> @@ -33,6 +33,11 @@ def parse_arguments():
> path_help = "Path to the compilation database to parse"
> parser.add_argument("path", type=str, help=path_help)
>
> + checks_help = "Checks to pass to the analysis"
> + parser.add_argument("-checks", type=str, default=None, help=checks_help)
> + header_filter_help = "Pass the -header-filter value to the tool"
> + parser.add_argument("-header-filter", type=str, default=None, help=header_filter_help)
> +
> return parser.parse_args()
>
>
> @@ -45,14 +50,29 @@ def init(l, a):
>
> def run_analysis(entry):
> # Disable all checks, then re-enable the ones we want
> - checks = []
> - checks.append("-checks=-*")
> - if args.type == "clang-tidy":
> - checks.append("linuxkernel-*")
> + global args
> + checks = None
> + if args.checks:
> + checks = args.checks.split(',')
> else:
> - checks.append("clang-analyzer-*")
> - checks.append("-clang-analyzer-security.insecureAPI.DeprecatedOrUnsafeBufferHandling")
> - p = subprocess.run(["clang-tidy", "-p", args.path, ",".join(checks), entry["file"]],
> + checks = ["-*"]
> + if args.type == "clang-tidy":
> + checks.append("linuxkernel-*")
> + else:
> + checks.append("clang-analyzer-*")
> + checks.append("-clang-analyzer-security.insecureAPI.DeprecatedOrUnsafeBufferHandling")
> + file = entry["file"]
> + if not file.endswith(".c") and not file.endswith(".cpp"):
> + with lock:
> + print(f"Skipping non-C file: '{file}'", file=sys.stderr)
> + return
> + pargs = ["clang-tidy", "-p", args.path]
> + if checks:

^ can `checks` ever be falsy here? I don't think we need this
conditional check?

> + pargs.append("-checks=" + ",".join(checks))
> + if args.header_filter:
> + pargs.append("-header-filter=" + args.header_filter)
> + pargs.append(file)
> + p = subprocess.run(pargs,
> stdout=subprocess.PIPE,
> stderr=subprocess.STDOUT,
> cwd=entry["directory"])
> --
> 2.42.0.515.g380fc7ccd1-goog
>


--
Thanks,
~Nick Desaulniers

2023-10-05 22:39:21

by Ian Rogers

[permalink] [raw]
Subject: Re: [PATCH v1 03/18] run-clang-tools: Add pass through checks and and header-filter arguments

On Mon, Sep 25, 2023 at 8:44 AM Nick Desaulniers
<[email protected]> wrote:
>
> On Fri, Sep 22, 2023 at 10:35 PM Ian Rogers <[email protected]> wrote:
> >
> > Add a -checks argument to allow the checks passed to the clang-tool to
> > be set on the command line.
> >
> > Add a pass through -header-filter option.
> >
> > Signed-off-by: Ian Rogers <[email protected]>
> > ---
> > scripts/clang-tools/run-clang-tools.py | 34 ++++++++++++++++++++------
> > 1 file changed, 27 insertions(+), 7 deletions(-)
> >
> > diff --git a/scripts/clang-tools/run-clang-tools.py b/scripts/clang-tools/run-clang-tools.py
> > index 3266708a8658..5dfe03852cb4 100755
> > --- a/scripts/clang-tools/run-clang-tools.py
> > +++ b/scripts/clang-tools/run-clang-tools.py
> > @@ -33,6 +33,11 @@ def parse_arguments():
> > path_help = "Path to the compilation database to parse"
> > parser.add_argument("path", type=str, help=path_help)
> >
> > + checks_help = "Checks to pass to the analysis"
> > + parser.add_argument("-checks", type=str, default=None, help=checks_help)
> > + header_filter_help = "Pass the -header-filter value to the tool"
> > + parser.add_argument("-header-filter", type=str, default=None, help=header_filter_help)
> > +
> > return parser.parse_args()
> >
> >
> > @@ -45,14 +50,29 @@ def init(l, a):
> >
> > def run_analysis(entry):
> > # Disable all checks, then re-enable the ones we want
> > - checks = []
> > - checks.append("-checks=-*")
> > - if args.type == "clang-tidy":
> > - checks.append("linuxkernel-*")
> > + global args
> > + checks = None
> > + if args.checks:
> > + checks = args.checks.split(',')
> > else:
> > - checks.append("clang-analyzer-*")
> > - checks.append("-clang-analyzer-security.insecureAPI.DeprecatedOrUnsafeBufferHandling")
> > - p = subprocess.run(["clang-tidy", "-p", args.path, ",".join(checks), entry["file"]],
> > + checks = ["-*"]
> > + if args.type == "clang-tidy":
> > + checks.append("linuxkernel-*")
> > + else:
> > + checks.append("clang-analyzer-*")
> > + checks.append("-clang-analyzer-security.insecureAPI.DeprecatedOrUnsafeBufferHandling")
> > + file = entry["file"]
> > + if not file.endswith(".c") and not file.endswith(".cpp"):
> > + with lock:
> > + print(f"Skipping non-C file: '{file}'", file=sys.stderr)
> > + return
> > + pargs = ["clang-tidy", "-p", args.path]
> > + if checks:
>
> ^ can `checks` ever be falsy here? I don't think we need this
> conditional check?

Agreed, it was for an option that I removed. Will fix in v2.

Thanks,
Ian

> > + pargs.append("-checks=" + ",".join(checks))
> > + if args.header_filter:
> > + pargs.append("-header-filter=" + args.header_filter)
> > + pargs.append(file)
> > + p = subprocess.run(pargs,
> > stdout=subprocess.PIPE,
> > stderr=subprocess.STDOUT,
> > cwd=entry["directory"])
> > --
> > 2.42.0.515.g380fc7ccd1-goog
> >
>
>
> --
> Thanks,
> ~Nick Desaulniers