Use registration function name fragment as checker family debug name

This fragment is often the same as the class name.

Author: NagyDonat

clang/include/clang/StaticAnalyzer/Core/Checker.h

@@ -551,7 +551,8 @@ class CheckerFamily : public CheckerBackend, public CHECKs... {
 public:
   template <typename CHECKER>
   static void _register(CHECKER *Chk, CheckerManager &Mgr) {
-    Chk->CheckerBackendName = Mgr.getCurrentCheckerName();
+    if (Chk->getDebugName().empty())
+      Chk->CheckerBackendName = Mgr.getCurrentCheckerDebugName();
     (CHECKs::_register(Chk, Mgr), ...);
   }
 

clang/include/clang/StaticAnalyzer/Core/CheckerManager.h

@@ -129,6 +129,7 @@ class CheckerManager {
   const AnalyzerOptions &AOptions;
   const Preprocessor *PP = nullptr;
   CheckerNameRef CurrentCheckerName;
+  CheckerNameRef CurrentCheckerDebugName;
   DiagnosticsEngine &Diags;
   std::unique_ptr<CheckerRegistryData> RegistryData;
 
@@ -159,9 +160,16 @@ class CheckerManager {
 
   ~CheckerManager();
 
-  void setCurrentCheckerName(CheckerNameRef name) { CurrentCheckerName = name; }
+  void setCurrentCheckerName(CheckerNameRef Name) { CurrentCheckerName = Name; }
   CheckerNameRef getCurrentCheckerName() const { return CurrentCheckerName; }
 
+  void setCurrentCheckerDebugName(CheckerNameRef Name) {
+    CurrentCheckerDebugName = Name;
+  }
+  CheckerNameRef getCurrentCheckerDebugName() const {
+    return CurrentCheckerDebugName;
+  }
+
   bool hasPathSensitiveCheckers() const;
 
   const LangOptions &getLangOpts() const { return LangOpts; }

clang/include/clang/StaticAnalyzer/Core/CheckerRegistryData.h

@@ -104,6 +104,7 @@ struct CheckerInfo {
   RegisterCheckerFn Initialize = nullptr;
   ShouldRegisterFunction ShouldRegister = nullptr;
   StringRef FullName;
+  StringRef DebugName;
   StringRef Desc;
   StringRef DocumentationUri;
   CmdLineOptionList CmdLineOptions;
@@ -128,9 +129,9 @@ struct CheckerInfo {
   }
 
   CheckerInfo(RegisterCheckerFn Fn, ShouldRegisterFunction sfn, StringRef Name,
-              StringRef Desc, StringRef DocsUri, bool IsHidden)
-      : Initialize(Fn), ShouldRegister(sfn), FullName(Name), Desc(Desc),
-        DocumentationUri(DocsUri), IsHidden(IsHidden) {}
+              StringRef DName, StringRef Desc, StringRef DocsUri, bool IsHidden)
+      : Initialize(Fn), ShouldRegister(sfn), FullName(Name), DebugName(DName),
+        Desc(Desc), DocumentationUri(DocsUri), IsHidden(IsHidden) {}
 
   // Used for lower_bound.
   explicit CheckerInfo(StringRef FullName) : FullName(FullName) {}

clang/include/clang/StaticAnalyzer/Frontend/CheckerRegistry.h

@@ -50,8 +50,8 @@
 // checker.
 //
 // The clang_registerCheckers function may add any number of checkers to the
-// registry. If any checkers require additional initialization, use the three-
-// argument form of CheckerRegistry::addChecker.
+// registry. If any checkers require additional initialization, use the
+// non-templated form of CheckerRegistry::addChecker.
 //
 // To load a checker plugin, specify the full path to the dynamic library as
 // the argument to the -load option in the cc1 frontend. You can then enable
@@ -115,9 +115,22 @@ class CheckerRegistry {
 public:
   /// Adds a checker to the registry. Use this non-templated overload when your
   /// checker requires custom initialization.
-  void addChecker(RegisterCheckerFn Fn, ShouldRegisterFunction sfn,
+  void addChecker(RegisterCheckerFn Fn, ShouldRegisterFunction Sfn,
+                  StringRef FullName, StringRef DebugName, StringRef Desc,
+                  StringRef DocsUri, bool IsHidden);
+
+  /// Adds a checker to the registry. This overload doesn't take a `DebugName`
+  /// (which usually looks like `DivZeroChecker`), so it uses the user-facing
+  /// `FullName` (which usually looks like ``core.DivideZero`) as a debug name.
+  /// THIS IS DEPRECATED and is only provided to preserve compatibility with
+  /// legacy plugins.
+  /// TODO: Eventually remove this from the codebase.
+  void addChecker(RegisterCheckerFn Fn, ShouldRegisterFunction Sfn,
                   StringRef FullName, StringRef Desc, StringRef DocsUri,
-                  bool IsHidden);
+                  bool IsHidden) {
+    addChecker(Fn, Sfn, FullName, /*DebugName =*/FullName, Desc, DocsUri,
+               IsHidden);
+  }
 
   /// Adds a checker to the registry. Use this templated overload when your
   /// checker does not require any custom initialization.

clang/lib/StaticAnalyzer/Frontend/CheckerRegistry.cpp

@@ -56,8 +56,8 @@ CheckerRegistry::CheckerRegistry(
   // Register builtin checkers.
 #define GET_CHECKERS
 #define CHECKER(FULLNAME, CLASS, HELPTEXT, DOC_URI, IS_HIDDEN)                 \
-  addChecker(register##CLASS, shouldRegister##CLASS, FULLNAME, HELPTEXT,       \
-             DOC_URI, IS_HIDDEN);
+  addChecker(register##CLASS, shouldRegister##CLASS, FULLNAME, #CLASS,         \
+             HELPTEXT, DOC_URI, IS_HIDDEN);
 
 #define GET_PACKAGES
 #define PACKAGE(FULLNAME) addPackage(FULLNAME);
@@ -433,9 +433,10 @@ void CheckerRegistry::addPackageOption(StringRef OptionType,
 
 void CheckerRegistry::addChecker(RegisterCheckerFn Rfn,
                                  ShouldRegisterFunction Sfn, StringRef Name,
-                                 StringRef Desc, StringRef DocsUri,
-                                 bool IsHidden) {
-  Data.Checkers.emplace_back(Rfn, Sfn, Name, Desc, DocsUri, IsHidden);
+                                 StringRef DebugName, StringRef Desc,
+                                 StringRef DocsUri, bool IsHidden) {
+  Data.Checkers.emplace_back(Rfn, Sfn, Name, DebugName, Desc, DocsUri,
+                             IsHidden);
 
   // Record the presence of the checker in its packages.
   StringRef PackageName, LeafName;
@@ -462,6 +463,7 @@ void CheckerRegistry::initializeManager(CheckerManager &CheckerMgr) const {
   // Initialize the CheckerManager with all enabled checkers.
   for (const auto *Checker : Data.EnabledCheckers) {
     CheckerMgr.setCurrentCheckerName(CheckerNameRef(Checker->FullName));
+    CheckerMgr.setCurrentCheckerDebugName(CheckerNameRef(Checker->DebugName));
     Checker->Initialize(CheckerMgr);
   }
 }

clang/test/Analysis/ftime-trace.cpp

@@ -39,7 +39,7 @@
 
 // Finally, each checker call back is also present:
 //
-// CHECK:          "name": "Total Stmt:core.DivideZero",
+// CHECK:          "name": "Total Stmt:DivZeroChecker",
 // CHECK-NEXT:     "args": {
 // CHECK-NEXT:         "count": {{[0-9]+}},
 // CHECK-NEXT:         "avg ms": {{[0-9]+}}