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=-9.9 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_GIT 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 CAD0BC55178 for ; Tue, 27 Oct 2020 16:43:29 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 873D220727 for ; Tue, 27 Oct 2020 16:43:29 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b="iMWK/9ud" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1811903AbgJ0Qn2 (ORCPT ); Tue, 27 Oct 2020 12:43:28 -0400 Received: from us-smtp-delivery-124.mimecast.com ([216.205.24.124]:55659 "EHLO us-smtp-delivery-124.mimecast.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1811880AbgJ0QnU (ORCPT ); Tue, 27 Oct 2020 12:43:20 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1603816997; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc; bh=mj6uaiHROCag3uZJ/gHJroorYDnXKuN4EyYRFIYPu8Y=; b=iMWK/9udZzW6xrAGHscjJXdgSKzRvPSDOpFhpewEulwue0luZDWR/Ryv1JtcRbdtckAno/ 8gCre/qcu5loxPOISVxTx/Px6r/O5Yh9WbP8UDElywsNUWAGOrXct/LtPnIVtJFCBwfPv0 dL2+ox3hVo2/V3PWm26kL+Qs4OpFesk= Received: from mail-ot1-f72.google.com (mail-ot1-f72.google.com [209.85.210.72]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-405-v41__4QCPaqsU2sdZPGsNQ-1; Tue, 27 Oct 2020 12:43:15 -0400 X-MC-Unique: v41__4QCPaqsU2sdZPGsNQ-1 Received: by mail-ot1-f72.google.com with SMTP id v7so596966ots.19 for ; Tue, 27 Oct 2020 09:43:14 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=mj6uaiHROCag3uZJ/gHJroorYDnXKuN4EyYRFIYPu8Y=; b=FQeHEg4PO2pez1RxvECkkiBtXiBzLb/3yT1TE1KU1e3avJ1xCkorf6lQZ5x0zSUHra s6ETFia4jvJooWmAPNp3zPLuWH6x0e1pcHMzMVCq9mII9HuJygMMCRHYxOy1N4qI43IU NkR/xmypDEgWWtLYq5hAaWy6G8RbXFVBmnVyW5o0USyo5rxK1B0hmj7WrqaVpLqyNskQ A8YbtO8/kNb4M1B/cweEZfSPnBLQmqMFKHW5lZtWzYdrSHeg47uheP14iWT5aogy8Zvo s2Y33VeSM5Wcs3BTRvWY7glp3tJwxg0Kb8UHc7R67wmVbd3h18QP9+lt7VXowG6U6Jxp txnQ== X-Gm-Message-State: AOAM531znfZ0cgtN/mXyuqWlqeNGGoPcGaNip223epKUXidtHjfp3zdF TesQCSHEmJIHyK8AbD+77lXeKPRGI+CdaBGntJZgdA2A0EEaRhtDrwAmPS518oXwJAdc/McH8+b BCc5INUkEeT+JgeV10Jeu1VtK X-Received: by 2002:aca:ef03:: with SMTP id n3mr2048470oih.67.1603816993832; Tue, 27 Oct 2020 09:43:13 -0700 (PDT) X-Google-Smtp-Source: ABdhPJw7y1eCX7WfRNi9tkZnfLpiDio1qtG9FKTpwYlLMD9SlPYp6FIE57BquNUx5oTk2cs+UUc+WA== X-Received: by 2002:aca:ef03:: with SMTP id n3mr2048435oih.67.1603816993577; Tue, 27 Oct 2020 09:43:13 -0700 (PDT) Received: from trix.remote.csb (075-142-250-213.res.spectrum.com. [75.142.250.213]) by smtp.gmail.com with ESMTPSA id l89sm90968otc.6.2020.10.27.09.43.10 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 27 Oct 2020 09:43:12 -0700 (PDT) From: trix@redhat.com To: linux-kernel@vger.kernel.org, clang-built-linux@googlegroups.com Cc: linux-pm@vger.kernel.org, linux-crypto@vger.kernel.org, qat-linux@intel.com, amd-gfx@lists.freedesktop.org, dri-devel@lists.freedesktop.org, linux-iio@vger.kernel.org, linux-rdma@vger.kernel.org, linux-mmc@vger.kernel.org, netdev@vger.kernel.org, linux-mediatek@lists.infradead.org, linux-amlogic@lists.infradead.org, linux-stm32@st-md-mailman.stormreply.com, linux-rtc@vger.kernel.org, linux-scsi@vger.kernel.org, linux-aspeed@lists.ozlabs.org, linux-samsung-soc@vger.kernel.org, linux-btrfs@vger.kernel.org, linux-nfs@vger.kernel.org, tipc-discussion@lists.sourceforge.net, alsa-devel@alsa-project.org, linux-rpi-kernel@lists.infradead.org, linux-tegra@vger.kernel.org, =?UTF-8?q?=EF=BB=BFFrom=20=3A=20Tom=20Rix?= Subject: Subject: [RFC] clang tooling cleanups Date: Tue, 27 Oct 2020 09:42:55 -0700 Message-Id: <20201027164255.1573301-1-trix@redhat.com> X-Mailer: git-send-email 2.18.1 Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org This rfc will describe An upcoming treewide cleanup. How clang tooling was used to programatically do the clean up. Solicit opinions on how to generally use clang tooling. The clang warning -Wextra-semi-stmt produces about 10k warnings. Reviewing these, a subset of semicolon after a switch looks safe to fix all the time. An example problem void foo(int a) { switch(a) { case 1: ... }; <--- extra semicolon } Treewide, there are about 100 problems in 50 files for x86_64 allyesconfig. These fixes will be the upcoming cleanup. clang already supports fixing this problem. Add to your command line clang -c -Wextra-semi-stmt -Xclang -fixit foo.c foo.c:8:3: warning: empty expression statement has no effect; remove unnecessary ';' to silence this warning [-Wextra-semi-stmt] }; ^ foo.c:8:3: note: FIX-IT applied suggested code changes 1 warning generated. The big problem is using this treewide is it will fix all 10k problems. 10k changes to analyze and upstream is not practical. Another problem is the generic fixer only removes the semicolon. So empty lines with some tabs need to be manually cleaned. What is needed is a more precise fixer. Enter clang-tidy. https://clang.llvm.org/extra/clang-tidy/ Already part of the static checker infrastructure, invoke on the clang build with make clang-tidy It is only a matter of coding up a specific checker for the cleanup. Upstream this is review is happening here https://reviews.llvm.org/D90180 The development of a checker/fixer is Start with a reproducer void foo (int a) { switch (a) {}; } Generate the abstract syntax tree (AST) clang -Xclang -ast-dump foo.c `-FunctionDecl |-ParmVarDecl `-CompoundStmt |-SwitchStmt | |-ImplicitCastExpr | | `-DeclRefExpr | `-CompoundStmt `-NullStmt Write a matcher to get you most of the way void SwitchSemiCheck::registerMatchers(MatchFinder *Finder) { Finder->addMatcher( compoundStmt(has(switchStmt().bind("switch"))).bind("comp"), this); } The 'bind' method is important, it allows a string to be associated with a node in the AST. In this case these are `-FunctionDecl |-ParmVarDecl `-CompoundStmt <-------- comp |-SwitchStmt <-------- switch | |-ImplicitCastExpr | | `-DeclRefExpr | `-CompoundStmt `-NullStmt When a match is made the 'check' method will be called. void SwitchSemiCheck::check(const MatchFinder::MatchResult &Result) { auto *C = Result.Nodes.getNodeAs("comp"); auto *S = Result.Nodes.getNodeAs("switch"); This is where the string in the bind calls are changed to nodes `-FunctionDecl |-ParmVarDecl `-CompoundStmt <-------- comp, C |-SwitchStmt <-------- switch, S | |-ImplicitCastExpr | | `-DeclRefExpr | `-CompoundStmt `-NullStmt <---------- looking for N And then more logic to find the NullStmt auto Current = C->body_begin(); auto Next = Current; Next++; while (Next != C->body_end()) { if (*Current == S) { if (const auto *N = dyn_cast(*Next)) { When it is found, a warning is printed and a FixItHint is proposed. auto H = FixItHint::CreateReplacement( SourceRange(S->getBody()->getEndLoc(), N->getSemiLoc()), "}"); diag(N->getSemiLoc(), "unneeded semicolon") << H; This fixit replaces from the end of switch to the semicolon with a '}'. Because the end of the switch is '}' this has the effect of removing all the whitespace as well as the semicolon. Because of the checker's placement in clang-tidy existing linuxkernel checkers, all that was needed to fix the tree was to add a '-fix'to the build's clang-tidy call. I am looking for opinions on what we want to do specifically with cleanups and generally about other source-to-source programmatic changes to the code base. For cleanups, I think we need a new toplevel target clang-tidy-fix And an explicit list of fixers that have a very high (100%?) fix rate. Ideally a bot should make the changes, but a bot could also nag folks. Is there interest in a bot making the changes? Does one already exist? The general source-to-source is a bit blue sky. Ex/ could automagicly refactor api, outline similar cut-n-pasted functions etc. Anything on someone's wishlist you want to try out ? Signed-off-by: Tom Rix