1#!/usr/bin/env python3
2# SPDX-License-Identifier: GPL-2.0
3#
4# Copyright (C) Google LLC, 2020
5#
6# Author: Nathan Huckleberry <nhuck@google.com>
7#
8"""A helper routine run clang-tidy and the clang static-analyzer on
9compile_commands.json.
10"""
11
12import argparse
13import json
14import multiprocessing
15import subprocess
16import sys
17
18
19def parse_arguments():
20    """Set up and parses command-line arguments.
21    Returns:
22        args: Dict of parsed args
23        Has keys: [path, type]
24    """
25    usage = """Run clang-tidy or the clang static-analyzer on a
26        compilation database."""
27    parser = argparse.ArgumentParser(description=usage)
28
29    type_help = "Type of analysis to be performed"
30    parser.add_argument("type",
31                        choices=["clang-tidy", "clang-analyzer"],
32                        help=type_help)
33    path_help = "Path to the compilation database to parse"
34    parser.add_argument("path", type=str, help=path_help)
35
36    return parser.parse_args()
37
38
39def init(l, a):
40    global lock
41    global args
42    lock = l
43    args = a
44
45
46def run_analysis(entry):
47    # Disable all checks, then re-enable the ones we want
48    checks = "-checks=-*,"
49    if args.type == "clang-tidy":
50        checks += "linuxkernel-*"
51    else:
52        checks += "clang-analyzer-*"
53        checks += ",-clang-analyzer-security.insecureAPI.DeprecatedOrUnsafeBufferHandling"
54    p = subprocess.run(["clang-tidy", "-p", args.path, checks, entry["file"]],
55                       stdout=subprocess.PIPE,
56                       stderr=subprocess.STDOUT,
57                       cwd=entry["directory"])
58    with lock:
59        sys.stderr.buffer.write(p.stdout)
60
61
62def main():
63    args = parse_arguments()
64
65    lock = multiprocessing.Lock()
66    pool = multiprocessing.Pool(initializer=init, initargs=(lock, args))
67    # Read JSON data into the datastore variable
68    with open(args.path, "r") as f:
69        datastore = json.load(f)
70        pool.map(run_analysis, datastore)
71
72
73if __name__ == "__main__":
74    main()
75