From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-25.6 required=3.0 tests=BAYES_00,DKIMWL_WL_MED, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_PATCH,MAILING_LIST_MULTI,MENTIONS_GIT_HOSTING,SIGNED_OFF_BY, SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_GIT,USER_IN_DEF_DKIM_WL autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id C5444C433DF for ; Fri, 24 Jul 2020 19:38:55 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 9DF7F206F6 for ; Fri, 24 Jul 2020 19:38:55 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="bs6DKgfC" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726689AbgGXTiy (ORCPT ); Fri, 24 Jul 2020 15:38:54 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:39248 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726455AbgGXTix (ORCPT ); Fri, 24 Jul 2020 15:38:53 -0400 Received: from mail-il1-x149.google.com (mail-il1-x149.google.com [IPv6:2607:f8b0:4864:20::149]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 7E11CC0619E5 for ; Fri, 24 Jul 2020 12:38:53 -0700 (PDT) Received: by mail-il1-x149.google.com with SMTP id o17so6375412ilt.19 for ; Fri, 24 Jul 2020 12:38:53 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20161025; h=date:in-reply-to:message-id:mime-version:references:subject:from:to :cc; bh=Cag1ZM+/G+EzkwVW+TvczGhDnD9T00FBkMW8L2Yy0Fo=; b=bs6DKgfCH69EJPnwnMTjxieor1UktNHbPrfEhVniGeWvdWT9PtCI17L+GqPkTDQOLu BA97cRTKcB0KxKX38uGRpVjfh7QRKGUxCV/FH2vpSOCbs5CLg6lUaCiNeo4LWVPo7A+Q rOYNreHALZlJT0bd2cNkHzsV6Wjy3bXws8Uw0xAxbASsjthUXHJT21vqcQJcrMb//kP+ GwBsHLQWcEZb3BeG51jrldWAp5qIDomi18OfPvQPlhFlYQE2BGcObQ47kng+p3uBNR2R VLAvTHD7YTypCCG9RzwJ1/UG+4hMhp8H8++dUMtpkJ5EPUmA55B6xccRyL99JCwsHhrq KYMw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:in-reply-to:message-id:mime-version :references:subject:from:to:cc; bh=Cag1ZM+/G+EzkwVW+TvczGhDnD9T00FBkMW8L2Yy0Fo=; b=gPR+ysZV2SGnc9WKHS34j6XhdMsllou3NcRwd3ijqqByXoQornoMrKG7v7/O9BVVIs dukfeT1qeVVabdcjE06KeN0GI1+k1eiULrmar9n/UeY99c2klOKpZ1KqMX5Bn72f9Z6/ L6XfAnF7A6fKsufLLhI4eLV3HwNNStjqgPoTRhS6bhyhqJQL7yt0x+bWNeRlV3iyGzOJ kHc9fKBPth2Gw66ypU8hUikCy+9O3BZryG5hvAR7m1CUUkYJT84poS2l5Bpk41Y5Tekg BkHJNucCbpmpnZqdIqAKxpGqhLCxVgv4xK4QoxT87zqFKygpyCC9ou+s7olpCaK05SWD 0HbA== X-Gm-Message-State: AOAM531dzCpqeMqcloBVbYVtOtvsZ01SS0gTb9Cetzxu0Xr60h2tZ3kX z3AWfWHxedRfR+T6eXqoQogJe/mQbg== X-Google-Smtp-Source: ABdhPJy3zIQfqr8MEgOKanOroLoquQ8BmPrwZznF3KDc3rGYbWF7mJkT6e5wzKjB4hLZRVuaXmraaZDIQA== X-Received: by 2002:a6b:6d07:: with SMTP id a7mr5210991iod.166.1595619532420; Fri, 24 Jul 2020 12:38:52 -0700 (PDT) Date: Fri, 24 Jul 2020 19:35:51 +0000 In-Reply-To: Message-Id: <20200724193551.2158677-1-nhuck@google.com> Mime-Version: 1.0 References: X-Mailer: git-send-email 2.28.0.rc0.142.g3c755180ce-goog Subject: [PATCH v6] Makefile: Add clang-tidy and static analyzer support to makefile From: Nathan Huckleberry To: masahiroy@kernel.org, michal.lkml@markovi.net Cc: linux-kbuild@vger.kernel.org, linux-kernel@vger.kernel.org, clang-built-linux@googlegroups.com, pirama@google.com, morbo@google.com, Nathan Huckleberry Content-Type: text/plain; charset="UTF-8" Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org This patch adds clang-tidy and the clang static-analyzer as make targets. The goal of this patch is to make static analysis tools usable and extendable by any developer or researcher who is familiar with basic c++. The current static analysis tools require intimate knowledge of the internal workings of the static analysis. Clang-tidy and the clang static analyzers expose an easy to use api and allow users unfamiliar with clang to write new checks with relative ease. ===Clang-tidy=== Clang-tidy is an easily extendable 'linter' that runs on the AST. Clang-tidy checks are easy to write and understand. A check consists of two parts, a matcher and a checker. The matcher is created using a domain specific language that acts on the AST (https://clang.llvm.org/docs/LibASTMatchersReference.html). When AST nodes are found by the matcher a callback is made to the checker. The checker can then execute additional checks and issue warnings. Here is an example clang-tidy check to report functions that have calls to local_irq_disable without calls to local_irq_enable and vice-versa. Functions flagged with __attribute((annotation("ignore_irq_balancing"))) are ignored for analysis. (https://reviews.llvm.org/D65828) ===Clang static analyzer=== The clang static analyzer is a more powerful static analysis tool that uses symbolic execution to find bugs. Currently there is a check that looks for potential security bugs from invalid uses of kmalloc and kfree. There are several more general purpose checks that are useful for the kernel. The clang static analyzer is well documented and designed to be extensible. (https://clang-analyzer.llvm.org/checker_dev_manual.html) (https://github.com/haoNoQ/clang-analyzer-guide/releases/download/v0.1/clang-analyzer-guide-v0.1.pdf) The main draw of the clang tools is how accessible they are. The clang documentation is very nice and these tools are built specifically to be easily extendable by any developer. They provide an accessible method of bug-finding and research to people who are not overly familiar with the kernel codebase. Signed-off-by: Nathan Huckleberry --- Changes v5->v6 * Minor style fixes MAINTAINERS | 1 + Makefile | 3 + scripts/clang-tools/Makefile.clang-tools | 23 ++++++ .../{ => clang-tools}/gen_compile_commands.py | 0 scripts/clang-tools/run-clang-tools.py | 77 +++++++++++++++++++ 5 files changed, 104 insertions(+) create mode 100644 scripts/clang-tools/Makefile.clang-tools rename scripts/{ => clang-tools}/gen_compile_commands.py (100%) create mode 100755 scripts/clang-tools/run-clang-tools.py diff --git a/MAINTAINERS b/MAINTAINERS index 1d4aa7f942de..a444564e5572 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -4198,6 +4198,7 @@ W: https://clangbuiltlinux.github.io/ B: https://github.com/ClangBuiltLinux/linux/issues C: irc://chat.freenode.net/clangbuiltlinux F: Documentation/kbuild/llvm.rst +F: scripts/clang-tools/ K: \b(?i:clang|llvm)\b CLEANCACHE API diff --git a/Makefile b/Makefile index fe0164a654c7..3e2df010b342 100644 --- a/Makefile +++ b/Makefile @@ -747,6 +747,7 @@ KBUILD_CFLAGS += $(call cc-option,-fno-allow-store-data-races) include scripts/Makefile.kcov include scripts/Makefile.gcc-plugins +include scripts/clang-tools/Makefile.clang-tools ifdef CONFIG_READABLE_ASM # Disable optimizations that make assembler listings hard to read. @@ -1543,6 +1544,8 @@ help: @echo ' export_report - List the usages of all exported symbols' @echo ' headerdep - Detect inclusion cycles in headers' @echo ' coccicheck - Check with Coccinelle' + @echo ' clang-analyzer - Check with clang static analyzer' + @echo ' clang-tidy - Check with clang-tidy' @echo '' @echo 'Tools:' @echo ' nsdeps - Generate missing symbol namespace dependencies' diff --git a/scripts/clang-tools/Makefile.clang-tools b/scripts/clang-tools/Makefile.clang-tools new file mode 100644 index 000000000000..5c9d76f77595 --- /dev/null +++ b/scripts/clang-tools/Makefile.clang-tools @@ -0,0 +1,23 @@ +# SPDX-License-Identifier: GPL-2.0 +# +# Copyright (C) Google LLC, 2020 +# +# Author: Nathan Huckleberry +# +PHONY += clang-tidy +clang-tidy: +ifdef CONFIG_CC_IS_CLANG + $(PYTHON3) scripts/clang-tools/gen_compile_commands.py + $(PYTHON3) scripts/clang-tools/run-clang-tools.py clang-tidy compile_commands.json +else + $(error clang-tidy requires CC=clang) +endif + +PHONY += clang-analyzer +clang-analyzer: +ifdef CONFIG_CC_IS_CLANG + $(PYTHON3) scripts/clang-tools/gen_compile_commands.py + $(PYTHON3) scripts/clang-tools/run-clang-tools.py clang-analyzer compile_commands.json +else + $(error clang-analyzer requires CC=clang) +endif diff --git a/scripts/gen_compile_commands.py b/scripts/clang-tools/gen_compile_commands.py similarity index 100% rename from scripts/gen_compile_commands.py rename to scripts/clang-tools/gen_compile_commands.py diff --git a/scripts/clang-tools/run-clang-tools.py b/scripts/clang-tools/run-clang-tools.py new file mode 100755 index 000000000000..1f4cd706ec01 --- /dev/null +++ b/scripts/clang-tools/run-clang-tools.py @@ -0,0 +1,77 @@ +#!/usr/bin/env python +# SPDX-License-Identifier: GPL-2.0 +# +# Copyright (C) Google LLC, 2020 +# +# Author: Nathan Huckleberry +# +"""A helper routine run clang-tidy and the clang static-analyzer on +compile_commands.json. +""" + +import argparse +import json +import logging +import multiprocessing +import os +import subprocess +import sys + + +def parse_arguments(): + """Set up and parses command-line arguments. + Returns: + args: Dict of parsed args + Has keys: [file, type] + """ + usage = """Run clang-tidy or the clang static-analyzer on a + compilation database.""" + parser = argparse.ArgumentParser(description=usage) + + type_help = "Type of analysis to be performed" + parser.add_argument("type", + choices=["clang-tidy", "clang-analyzer"], + help=type_help) + file_path_help = "Path to the compilation database to parse" + parser.add_argument("file", type=str, help=file_path_help) + + return parser.parse_args() + + +def init(l, t): + global lock + global analysis_type + lock = l + analysis_type = t + + +def run_analysis(entry): + filename = entry["file"] + # Disable all checks, then re-enable the ones we want + checks = "-checks=-*," + if analysis_type == "clang-tidy": + checks += "linuxkernel-*" + else: + checks += "clang-analyzer-*" + p = subprocess.run( + ["clang-tidy", "-p", os.getcwd(), checks, filename], + stdout=subprocess.PIPE, + stderr=subprocess.STDOUT) + with lock: + sys.stderr.buffer.write(p.stdout) + + +def main(): + args = parse_arguments() + filename = args.file + + lock = multiprocessing.Lock() + pool = multiprocessing.Pool(initializer=init, initargs=(lock, args.type)) + # Read JSON data into the datastore variable + with open(filename, "r") as f: + datastore = json.load(f) + pool.map(run_analysis, datastore) + + +if __name__ == "__main__": + main() -- 2.28.0.rc0.142.g3c755180ce-goog