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

From: Nick Desaulniers
Date: Fri Oct 06 2023 - 17:23:00 EST


On Thu, Oct 5, 2023 at 4:09 PM Ian Rogers <irogers@xxxxxxxxxx> 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.
>
> Don't run analysis on non-C or CPP files.

Three distinct changes; I wouldn't have minded that as three distinct patches.

>
> Signed-off-by: Ian Rogers <irogers@xxxxxxxxxx>
> ---
> scripts/clang-tools/run-clang-tools.py | 32 ++++++++++++++++++++------
> 1 file changed, 25 insertions(+), 7 deletions(-)
>
> diff --git a/scripts/clang-tools/run-clang-tools.py b/scripts/clang-tools/run-clang-tools.py
> index 3266708a8658..f31ffd09e1ea 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,27 @@ 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

^ perhaps worth returning earlier if this guard fails? i.e.

rather than do a bunch of work, then do a guard that may return early
that doesn't depend on the earlier work, instead guard first then do
all work.

I don't mind that as a follow up rather than a whole v3 for the series.

Reviewed-by: Nick Desaulniers <ndesaulniers@xxxxxxxxxx>

> + pargs = ["clang-tidy", "-p", args.path, "-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.609.gbb76f46606-goog
>


--
Thanks,
~Nick Desaulniers