A few final touches before tests

Author: Kevin Frei

llvm/include/llvm/DebugInfo/DWARF/DWARFVerifier.h

@@ -33,14 +33,15 @@ struct DWARFSection;
 class OutputCategoryAggregator {
 private:
   std::map<std::string, unsigned> Aggregation;
-  bool CallDetail;
+  bool IncludeDetail;
 
 public:
-  OutputCategoryAggregator(bool callDetail = false) : CallDetail(callDetail) {}
-  void EnableDetail() { CallDetail = true; }
-  void DisableDetail() { CallDetail = false; }
+  OutputCategoryAggregator(bool includeDetail = false)
+      : IncludeDetail(includeDetail) {}
+  void EnableDetail() { IncludeDetail = true; }
+  void DisableDetail() { IncludeDetail = false; }
   void Report(StringRef s, std::function<void()> detailCallback);
-  void HandleAggregate(std::function<void(StringRef, unsigned)> handleCounts);
+  void EnumerateResults(std::function<void(StringRef, unsigned)> handleCounts);
 };
 
 /// A class that verifies DWARF debug information given a DWARF Context.
@@ -89,11 +90,12 @@ class DWARFVerifier {
     bool intersects(const DieRangeInfo &RHS) const;
   };
 
+private:
   raw_ostream &OS;
   DWARFContext &DCtx;
-  OutputCategoryAggregator ErrorCategory;
   DIDumpOptions DumpOpts;
   uint32_t NumDebugLineErrors = 0;
+  OutputCategoryAggregator ErrorCategory;
   // Used to relax some checks that do not currently work portably
   bool IsObjectFile;
   bool IsMachOObject;
@@ -362,8 +364,8 @@ class DWARFVerifier {
       StringRef SectionName, const DWARFSection &Section, StringRef StrData,
       void (DWARFObject::*)(function_ref<void(const DWARFSection &)>) const);
 
-  /// Emits any aggregate information collection, depending on the dump options
-  void finish(bool Success);
+  /// Emits any aggregate information collected, depending on the dump options
+  void summarize(bool Success);
 };
 
 static inline bool operator<(const DWARFVerifier::DieRangeInfo &LHS,

llvm/lib/DebugInfo/DWARF/DWARFContext.cpp

@@ -1408,7 +1408,7 @@ bool DWARFContext::verify(raw_ostream &OS, DIDumpOptions DumpOpts) {
   if (DumpOpts.DumpType & DIDT_DebugStrOffsets)
     Success &= verifier.handleDebugStrOffsets();
   Success &= verifier.handleAccelTables();
-  verifier.finish(Success);
+  verifier.summarize(Success);
   return Success;
 }
 

llvm/lib/DebugInfo/DWARF/DWARFVerifier.cpp

@@ -307,7 +307,7 @@ unsigned DWARFVerifier::verifyDebugInfoCallSite(const DWARFDie &Die) {
 
   if (!Curr.isValid()) {
     ErrorCategory.Report(
-        "Call site entry not nexted within valid subprogram", [&]() {
+        "Call site entry not nested within valid subprogram", [&]() {
           error() << "Call site entry not nested within a valid subprogram:";
           Die.dump(OS);
         });
@@ -339,9 +339,9 @@ unsigned DWARFVerifier::verifyAbbrevSection(const DWARFDebugAbbrev *Abbrev) {
   Expected<const DWARFAbbreviationDeclarationSet *> AbbrDeclsOrErr =
       Abbrev->getAbbreviationDeclarationSet(0);
   if (!AbbrDeclsOrErr) {
-    ErrorCategory.Report("Abbreviation Declaration error", [&]() {
-      error() << toString(AbbrDeclsOrErr.takeError()) << "\n";
-    });
+    std::string ErrMsg = toString(AbbrDeclsOrErr.takeError());
+    ErrorCategory.Report("Abbreviation Declaration error",
+                         [&]() { error() << ErrMsg << "\n"; });
     return 1;
   }
 
@@ -863,8 +863,9 @@ unsigned DWARFVerifier::verifyDebugInfoForm(const DWARFDie &Die,
   case DW_FORM_line_strp: {
     if (Error E = AttrValue.Value.getAsCString().takeError()) {
       ++NumErrors;
+      std::string ErrMsg = toString(std::move(E));
       ErrorCategory.Report("Invalid DW_FORM attribute", [&]() {
-        error() << toString(std::move(E)) << ":\n";
+        error() << ErrMsg << ":\n";
         dump(Die) << '\n';
       });
     }
@@ -916,7 +917,7 @@ void DWARFVerifier::verifyDebugLineStmtOffsets() {
     if (LineTableOffset < DCtx.getDWARFObj().getLineSection().Data.size()) {
       if (!LineTable) {
         ++NumDebugLineErrors;
-        ErrorCategory.Report("Unparseable .debug_line entry", [&]() {
+        ErrorCategory.Report("Unparsable .debug_line entry", [&]() {
           error() << ".debug_line[" << format("0x%08" PRIx64, LineTableOffset)
                   << "] was not able to be parsed for CU:\n";
           dump(Die) << '\n';
@@ -1584,7 +1585,7 @@ unsigned DWARFVerifier::verifyNameIndexEntries(
     uint64_t DIEOffset = CUOffset + *EntryOr->getDIEUnitOffset();
     DWARFDie DIE = DCtx.getDIEForOffset(DIEOffset);
     if (!DIE) {
-      ErrorCategory.Report("NameIndex references nonexisten DIE", [&]() {
+      ErrorCategory.Report("NameIndex references nonexistent DIE", [&]() {
         error() << formatv("Name Index @ {0:x}: Entry @ {1:x} references a "
                            "non-existing DIE @ {2:x}.\n",
                            NI.getUnitOffset(), EntryID, DIEOffset);
@@ -1986,21 +1987,21 @@ bool DWARFVerifier::verifyDebugStrOffsets(
 void OutputCategoryAggregator::Report(
     StringRef s, std::function<void(void)> detailCallback) {
   Aggregation[std::string(s)]++;
-  if (CallDetail)
+  if (IncludeDetail)
     detailCallback();
 }
 
-void OutputCategoryAggregator::HandleAggregate(
+void OutputCategoryAggregator::EnumerateResults(
     std::function<void(StringRef, unsigned)> handleCounts) {
   for (auto &&[name, count] : Aggregation) {
     handleCounts(name, count);
   }
 }
 
-void DWARFVerifier::finish(bool Success) {
+void DWARFVerifier::summarize(bool Success) {
   if (!Success && DumpOpts.ShowAggregateErrors) {
     error() << "Aggregated error category counts:\n";
-    ErrorCategory.HandleAggregate([&](StringRef s, unsigned count) {
+    ErrorCategory.EnumerateResults([&](StringRef s, unsigned count) {
       error() << "Error category '" << s << "' occurred " << count
               << " time(s).\n";
     });