Author: dsanders Date: Fri Aug 30 13:01:59 2019 New Revision: 370512 URL: http://llvm.org/viewvc/llvm-project?rev=370512&view=rev Log: [clang-tidy] Add llvm-prefer-register-over-unsigned to clang-tidy
Summary: This clang-tidy check is looking for unsigned integer variables whose initializer starts with an implicit cast from llvm::Register and changes the type of the variable to llvm::Register (dropping the llvm:: where possible). Reviewers: arsenm, bogner Subscribers: jholewinski, MatzeB, qcolombet, dschuff, jyknight, dylanmckay, sdardis, nemanjai, jvesely, wdng, nhaehnle, mgorny, sbc100, jgravelle-google, kristof.beyls, hiraditya, aheejin, kbarton, fedor.sergeev, javed.absar, asb, rbar, johnrusso, simoncook, apazos, sabuasal, niosHD, jrtc27, MaskRay, zzheng, edward-jones, atanasyan, rogfer01, MartinMosbeck, brucehoult, the_o, tpr, PkmX, jocewei, jsji, Petar.Avramovic, asbirlea, Jim, s.egerton, cfe-commits, llvm-commits Tags: #clang, #llvm Differential Revision: https://reviews.llvm.org/D65919 Added: clang-tools-extra/trunk/clang-tidy/llvm/PreferRegisterOverUnsignedCheck.cpp clang-tools-extra/trunk/clang-tidy/llvm/PreferRegisterOverUnsignedCheck.h clang-tools-extra/trunk/docs/clang-tidy/checks/llvm-prefer-register-over-unsigned.rst clang-tools-extra/trunk/test/clang-tidy/llvm-prefer-register-over-unsigned.cpp clang-tools-extra/trunk/test/clang-tidy/llvm-prefer-register-over-unsigned2.cpp clang-tools-extra/trunk/test/clang-tidy/llvm-prefer-register-over-unsigned3.cpp Modified: clang-tools-extra/trunk/clang-tidy/llvm/CMakeLists.txt clang-tools-extra/trunk/clang-tidy/llvm/LLVMTidyModule.cpp clang-tools-extra/trunk/docs/ReleaseNotes.rst clang-tools-extra/trunk/docs/clang-tidy/checks/list.rst Modified: clang-tools-extra/trunk/clang-tidy/llvm/CMakeLists.txt URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/clang-tidy/llvm/CMakeLists.txt?rev=370512&r1=370511&r2=370512&view=diff ============================================================================== --- clang-tools-extra/trunk/clang-tidy/llvm/CMakeLists.txt (original) +++ clang-tools-extra/trunk/clang-tidy/llvm/CMakeLists.txt Fri Aug 30 13:01:59 2019 @@ -5,6 +5,7 @@ add_clang_library(clangTidyLLVMModule IncludeOrderCheck.cpp LLVMTidyModule.cpp PreferIsaOrDynCastInConditionalsCheck.cpp + PreferRegisterOverUnsignedCheck.cpp TwineLocalCheck.cpp LINK_LIBS Modified: clang-tools-extra/trunk/clang-tidy/llvm/LLVMTidyModule.cpp URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/clang-tidy/llvm/LLVMTidyModule.cpp?rev=370512&r1=370511&r2=370512&view=diff ============================================================================== --- clang-tools-extra/trunk/clang-tidy/llvm/LLVMTidyModule.cpp (original) +++ clang-tools-extra/trunk/clang-tidy/llvm/LLVMTidyModule.cpp Fri Aug 30 13:01:59 2019 @@ -13,6 +13,7 @@ #include "HeaderGuardCheck.h" #include "IncludeOrderCheck.h" #include "PreferIsaOrDynCastInConditionalsCheck.h" +#include "PreferRegisterOverUnsignedCheck.h" #include "TwineLocalCheck.h" namespace clang { @@ -28,6 +29,8 @@ public: "llvm-namespace-comment"); CheckFactories.registerCheck<PreferIsaOrDynCastInConditionalsCheck>( "llvm-prefer-isa-or-dyn-cast-in-conditionals"); + CheckFactories.registerCheck<PreferRegisterOverUnsignedCheck>( + "llvm-prefer-register-over-unsigned"); CheckFactories.registerCheck<TwineLocalCheck>("llvm-twine-local"); } }; Added: clang-tools-extra/trunk/clang-tidy/llvm/PreferRegisterOverUnsignedCheck.cpp URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/clang-tidy/llvm/PreferRegisterOverUnsignedCheck.cpp?rev=370512&view=auto ============================================================================== --- clang-tools-extra/trunk/clang-tidy/llvm/PreferRegisterOverUnsignedCheck.cpp (added) +++ clang-tools-extra/trunk/clang-tidy/llvm/PreferRegisterOverUnsignedCheck.cpp Fri Aug 30 13:01:59 2019 @@ -0,0 +1,64 @@ +//===--- PreferRegisterOverUnsignedCheck.cpp - clang-tidy -----------------===// +// +// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. +// See https://llvm.org/LICENSE.txt for license information. +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// +//===----------------------------------------------------------------------===// + +#include "PreferRegisterOverUnsignedCheck.h" +#include "clang/AST/ASTContext.h" +#include "clang/ASTMatchers/ASTMatchFinder.h" + +using namespace clang::ast_matchers; + +namespace clang { +namespace tidy { +namespace llvm_check { + +void PreferRegisterOverUnsignedCheck::registerMatchers(MatchFinder *Finder) { + auto RegisterClassMatch = hasType( + cxxRecordDecl(hasName("::llvm::Register")).bind("registerClassDecl")); + + Finder->addMatcher( + valueDecl(allOf( + hasType(qualType(isUnsignedInteger()).bind("varType")), + varDecl(hasInitializer(exprWithCleanups(has(implicitCastExpr(has( + cxxMemberCallExpr(allOf(on(RegisterClassMatch), + has(memberExpr(hasDeclaration( + cxxConversionDecl()))))))))))) + .bind("var"))), + this); +} + +void PreferRegisterOverUnsignedCheck::check( + const MatchFinder::MatchResult &Result) { + const auto *VarType = Result.Nodes.getNodeAs<QualType>("varType"); + const auto *UserVarDecl = Result.Nodes.getNodeAs<VarDecl>("var"); + + StringRef Replacement = "llvm::Register"; + const DeclContext *Context = UserVarDecl->getDeclContext(); + while (Context) { + if (const auto *Namespace = dyn_cast<NamespaceDecl>(Context)) + if (isa<TranslationUnitDecl>(Namespace->getDeclContext()) && + Namespace->getName() == "llvm") + Replacement = "Register"; + for (const auto *UsingDirective : Context->using_directives()) { + const NamespaceDecl *Namespace = UsingDirective->getNominatedNamespace(); + if (isa<TranslationUnitDecl>(Namespace->getDeclContext()) && + Namespace->getName() == "llvm") + Replacement = "Register"; + } + Context = Context->getParent(); + } + diag(UserVarDecl->getLocation(), + "variable %0 declared as %1; use '%2' instead") + << UserVarDecl << *VarType << Replacement + << FixItHint::CreateReplacement( + UserVarDecl->getTypeSourceInfo()->getTypeLoc().getSourceRange(), + Replacement); +} + +} // namespace llvm_check +} // namespace tidy +} // namespace clang Added: clang-tools-extra/trunk/clang-tidy/llvm/PreferRegisterOverUnsignedCheck.h URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/clang-tidy/llvm/PreferRegisterOverUnsignedCheck.h?rev=370512&view=auto ============================================================================== --- clang-tools-extra/trunk/clang-tidy/llvm/PreferRegisterOverUnsignedCheck.h (added) +++ clang-tools-extra/trunk/clang-tidy/llvm/PreferRegisterOverUnsignedCheck.h Fri Aug 30 13:01:59 2019 @@ -0,0 +1,36 @@ +//===--- PreferRegisterOverUnsignedCheck.h - clang-tidy ---------*- C++ -*-===// +// +// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. +// See https://llvm.org/LICENSE.txt for license information. +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// +//===----------------------------------------------------------------------===// + +#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_LLVM_PREFERREGISTEROVERUNSIGNEDCHECK_H +#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_LLVM_PREFERREGISTEROVERUNSIGNEDCHECK_H + +#include "../ClangTidyCheck.h" + +namespace clang { +namespace tidy { +namespace llvm_check { + +/// Historically, LLVM has used `unsigned` to represent registers. Since then +/// a `Register` object has been introduced for improved type-safety and make +/// the code more explicit. +/// +/// For the user-facing documentation see: +/// http://clang.llvm.org/extra/clang-tidy/checks/llvm-prefer-register-over-unsigned.html +class PreferRegisterOverUnsignedCheck : public ClangTidyCheck { +public: + PreferRegisterOverUnsignedCheck(StringRef Name, ClangTidyContext *Context) + : ClangTidyCheck(Name, Context) {} + void registerMatchers(ast_matchers::MatchFinder *Finder) override; + void check(const ast_matchers::MatchFinder::MatchResult &Result) override; +}; + +} // namespace llvm_check +} // namespace tidy +} // namespace clang + +#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_LLVM_PREFERREGISTEROVERUNSIGNEDCHECK_H Modified: clang-tools-extra/trunk/docs/ReleaseNotes.rst URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/docs/ReleaseNotes.rst?rev=370512&r1=370511&r2=370512&view=diff ============================================================================== --- clang-tools-extra/trunk/docs/ReleaseNotes.rst (original) +++ clang-tools-extra/trunk/docs/ReleaseNotes.rst Fri Aug 30 13:01:59 2019 @@ -85,6 +85,13 @@ Improvements to clang-tidy Finds uses of deprecated Googletest APIs with names containing ``case`` and replaces them with equivalent APIs with ``suite``. +- New :doc:`llvm-prefer-register-over-unsigned + <clang-tidy/checks/llvm-prefer-register-over-unsigned>` check. + + Finds historical use of ``unsigned`` to hold vregs and physregs and rewrites + them to use ``Register`` + + Improvements to include-fixer ----------------------------- Modified: clang-tools-extra/trunk/docs/clang-tidy/checks/list.rst URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/docs/clang-tidy/checks/list.rst?rev=370512&r1=370511&r2=370512&view=diff ============================================================================== --- clang-tools-extra/trunk/docs/clang-tidy/checks/list.rst (original) +++ clang-tools-extra/trunk/docs/clang-tidy/checks/list.rst Fri Aug 30 13:01:59 2019 @@ -275,6 +275,7 @@ Clang-Tidy Checks llvm-include-order llvm-namespace-comment llvm-prefer-isa-or-dyn-cast-in-conditionals + llvm-prefer-register-over-unsigned llvm-twine-local misc-definitions-in-headers misc-misplaced-const Added: clang-tools-extra/trunk/docs/clang-tidy/checks/llvm-prefer-register-over-unsigned.rst URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/docs/clang-tidy/checks/llvm-prefer-register-over-unsigned.rst?rev=370512&view=auto ============================================================================== --- clang-tools-extra/trunk/docs/clang-tidy/checks/llvm-prefer-register-over-unsigned.rst (added) +++ clang-tools-extra/trunk/docs/clang-tidy/checks/llvm-prefer-register-over-unsigned.rst Fri Aug 30 13:01:59 2019 @@ -0,0 +1,27 @@ +.. title:: clang-tidy - llvm-prefer-register-over-unsigned + +llvm-prefer-register-over-unsigned +================================== + +Finds historical use of ``unsigned`` to hold vregs and physregs and rewrites +them to use ``Register``. + +Currently this works by finding all variables of unsigned integer type whose +initializer begins with an implicit cast from ``Register`` to ``unsigned``. + +.. code-block:: c++ + + void example(MachineOperand &MO) { + unsigned Reg = MO.getReg(); + ... + } + +becomes: + +.. code-block:: c++ + + void example(MachineOperand &MO) { + Register Reg = MO.getReg(); + ... + } + Added: clang-tools-extra/trunk/test/clang-tidy/llvm-prefer-register-over-unsigned.cpp URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/test/clang-tidy/llvm-prefer-register-over-unsigned.cpp?rev=370512&view=auto ============================================================================== --- clang-tools-extra/trunk/test/clang-tidy/llvm-prefer-register-over-unsigned.cpp (added) +++ clang-tools-extra/trunk/test/clang-tidy/llvm-prefer-register-over-unsigned.cpp Fri Aug 30 13:01:59 2019 @@ -0,0 +1,143 @@ +// RUN: %check_clang_tidy %s llvm-prefer-register-over-unsigned %t + +namespace llvm { +class Register { +public: + operator unsigned(); + + unsigned Reg; +}; + +// This class shouldn't trigger it despite the similarity. +class RegisterLike { +public: + operator unsigned(); + + unsigned Reg; +}; +} // end namespace llvm + +llvm::Register getReg(); +llvm::RegisterLike getRegLike(); + +void apply_1() { + unsigned Reg1 = getReg(); + // CHECK-MESSAGES: :[[@LINE-1]]:12: warning: variable 'Reg1' declared as 'unsigned int'; use 'llvm::Register' instead [llvm-prefer-register-over-unsigned] + // CHECK-FIXES: apply_1() + // CHECK-FIXES-NEXT: llvm::Register Reg1 = getReg(); +} + +void apply_2() { + using namespace llvm; + unsigned Reg2 = getReg(); + // FIXME: Function-scoped UsingDirectiveDecl's don't appear to be in the + // DeclContext for the function so we can't elide the llvm:: in this + // case. Fortunately, it doesn't actually occur in the LLVM code base. + // CHECK-MESSAGES: :[[@LINE-4]]:12: warning: variable 'Reg2' declared as 'unsigned int'; use 'llvm::Register' instead [llvm-prefer-register-over-unsigned] + // CHECK-FIXES: apply_2() + // CHECK-FIXES-NEXT: using namespace llvm; + // CHECK-FIXES-NEXT: llvm::Register Reg2 = getReg(); +} + +namespace llvm { +void apply_3() { + unsigned Reg3 = getReg(); + // CHECK-MESSAGES: :[[@LINE-1]]:12: warning: variable 'Reg3' declared as 'unsigned int'; use 'Register' instead [llvm-prefer-register-over-unsigned] + // CHECK-FIXES: apply_3() + // CHECK-FIXES-NEXT: Register Reg3 = getReg(); +} +} // end namespace llvm + +void done_1() { + llvm::Register Reg1 = getReg(); + // CHECK-FIXES: done_1() + // CHECK-FIXES-NEXT: llvm::Register Reg1 = getReg(); +} + +void done_2() { + using namespace llvm; + Register Reg2 = getReg(); + // CHECK-FIXES: done_2() + // CHECK-FIXES-NEXT: using namespace llvm; + // CHECK-FIXES-NEXT: Register Reg2 = getReg(); +} + +namespace llvm { +void done_3() { + Register Reg3 = getReg(); + // CHECK-FIXES: done_3() + // CHECK-FIXES-NEXT: Register Reg3 = getReg(); +} +} // end namespace llvm + +void do_nothing_1() { + unsigned Reg1 = getRegLike(); + // CHECK-FIXES: do_nothing_1() + // CHECK-FIXES-NEXT: unsigned Reg1 = getRegLike(); +} + +void do_nothing_2() { + using namespace llvm; + unsigned Reg2 = getRegLike(); + // CHECK-FIXES: do_nothing_2() + // CHECK-FIXES-NEXT: using namespace llvm; + // CHECK-FIXES-NEXT: unsigned Reg2 = getRegLike(); +} + +namespace llvm { +void do_nothing_3() { + unsigned Reg3 = getRegLike(); + // CHECK-FIXES: do_nothing_3() + // CHECK-FIXES-NEXT: unsigned Reg3 = getRegLike(); +} +} // end namespace llvm + +void fn1(llvm::Register R); +void do_nothing_4() { + fn1(getReg()); + // CHECK-FIXES: do_nothing_4() + // CHECK-FIXES-NEXT: fn1(getReg()); +} + +void fn2(unsigned R); +void do_nothing_5() { + fn2(getReg()); + // CHECK-FIXES: do_nothing_5() + // CHECK-FIXES-NEXT: fn2(getReg()); +} + +void do_nothing_6() { + using namespace llvm; + Register Reg6{getReg()}; + // CHECK-FIXES: do_nothing_6() + // CHECK-FIXES-NEXT: using namespace llvm; + // CHECK-FIXES-NEXT: Register Reg6{getReg()}; +} + +void do_nothing_7() { + using namespace llvm; + Register Reg7; + Reg7.Reg = getReg(); + // CHECK-FIXES: do_nothing_7() + // CHECK-FIXES-NEXT: using namespace llvm; + // CHECK-FIXES-NEXT: Register Reg7; + // CHECK-FIXES-NEXT: Reg7.Reg = getReg(); +} + +void do_nothing_8() { + using namespace llvm; + RegisterLike Reg8{getReg()}; + // CHECK-FIXES: do_nothing_8() + // CHECK-FIXES-NEXT: using namespace llvm; + // CHECK-FIXES-NEXT: RegisterLike Reg8{getReg()}; +} + +void do_nothing_9() { + using namespace llvm; + RegisterLike Reg9; + Reg9.Reg = getReg(); + // CHECK-FIXES: do_nothing_9() + // CHECK-FIXES-NEXT: using namespace llvm; + // CHECK-FIXES-NEXT: RegisterLike Reg9; + // CHECK-FIXES-NEXT: Reg9.Reg = getReg(); +} Added: clang-tools-extra/trunk/test/clang-tidy/llvm-prefer-register-over-unsigned2.cpp URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/test/clang-tidy/llvm-prefer-register-over-unsigned2.cpp?rev=370512&view=auto ============================================================================== --- clang-tools-extra/trunk/test/clang-tidy/llvm-prefer-register-over-unsigned2.cpp (added) +++ clang-tools-extra/trunk/test/clang-tidy/llvm-prefer-register-over-unsigned2.cpp Fri Aug 30 13:01:59 2019 @@ -0,0 +1,25 @@ +// RUN: %check_clang_tidy %s llvm-prefer-register-over-unsigned %t + +namespace llvm { +class Register { +public: + operator unsigned(); +}; +} // end namespace llvm + +llvm::Register getReg(); + +using namespace llvm; + +void apply_1() { + unsigned Reg = getReg(); + // CHECK-MESSAGES: :[[@LINE-1]]:12: warning: variable 'Reg' declared as 'unsigned int'; use 'Register' instead [llvm-prefer-register-over-unsigned] + // CHECK-FIXES: apply_1() + // CHECK-FIXES-NEXT: Register Reg = getReg(); +} + +void done_1() { + llvm::Register Reg = getReg(); + // CHECK-FIXES: done_1() + // CHECK-FIXES-NEXT: llvm::Register Reg = getReg(); +} Added: clang-tools-extra/trunk/test/clang-tidy/llvm-prefer-register-over-unsigned3.cpp URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/test/clang-tidy/llvm-prefer-register-over-unsigned3.cpp?rev=370512&view=auto ============================================================================== --- clang-tools-extra/trunk/test/clang-tidy/llvm-prefer-register-over-unsigned3.cpp (added) +++ clang-tools-extra/trunk/test/clang-tidy/llvm-prefer-register-over-unsigned3.cpp Fri Aug 30 13:01:59 2019 @@ -0,0 +1,33 @@ +// RUN: %check_clang_tidy %s llvm-prefer-register-over-unsigned %t + +namespace llvm { }; + +// This class shouldn't trigger it despite the similarity as it's not inside the llvm namespace +class Register { +public: + operator unsigned(); +}; + +Register getReg(); + +void do_nothing_1() { + unsigned Reg1 = getReg(); + // CHECK-FIXES: do_nothing_1() + // CHECK-FIXES-NEXT: unsigned Reg1 = getReg(); +} + +void do_nothing_2() { + using namespace llvm; + unsigned Reg2 = getReg(); + // CHECK-FIXES: do_nothing_2() + // CHECK-FIXES-NEXT: using namespace llvm; + // CHECK-FIXES-NEXT: unsigned Reg2 = getReg(); +} + +namespace llvm { +void do_nothing_3() { + unsigned Reg3 = getReg(); + // CHECK-FIXES: do_nothing_3() + // CHECK-FIXES-NEXT: unsigned Reg3 = getReg(); +} +} // end namespace llvm _______________________________________________ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
