[GISel] Print better error messages for missing Combiner Observer calls

[jroelofs]

llvm/lib/CodeGen/GlobalISel/CSEInfo.cpp

285

The 3rd param was silently useless here, since the format string doesn't have a placeholder for it.

[jroelofs]

clang-format

llvm/lib/CodeGen/GlobalISel/CSEInfo.cpp

void GISelCSEInfo::releaseMemory() {
   CSEOpt.reset();
   MRI = nullptr;
   MF = nullptr;
 #ifndef NDEBUG
   OpcodeHitTable.clear();
 #endif
 }
 
+#ifndef NDEBUG
+static const char *stringify(const MachineInstr *MI, std::string &S) {
+  raw_string_ostream OS(S);
+  OS << *MI;
+  return OS.str().c_str();
+}
+#endif
+
 Error GISelCSEInfo::verify() {
 #ifndef NDEBUG
+  std::string S1, S2;
   handleRecordedInsts();
   // For each instruction in map from MI -> UMI,
   // Profile(MI) and make sure UMI is found for that profile.
   for (auto &It : InstrMapping) {
     FoldingSetNodeID TmpID;
     GISelInstProfileBuilder(TmpID, *MRI).addNodeID(It.first);
     void *InsertPos;
     UniqueMachineInstr *FoundNode =
         CSEMap.FindNodeOrInsertPos(TmpID, InsertPos);
     if (FoundNode != It.second)
       return createStringError(std::errc::not_supported,
                                "CSEMap mismatch, InstrMapping has MIs without "
-                               "corresponding Nodes in CSEMap");
+                               "corresponding Nodes in CSEMap:\n%s",
+                               stringify(It.second->MI, S1));
   }
 
   // For every node in the CSEMap, make sure that the InstrMapping
   // points to it.
   for (const UniqueMachineInstr &UMI : CSEMap) {
     if (!InstrMapping.count(UMI.MI))
       return createStringError(std::errc::not_supported,
-                               "Node in CSE without InstrMapping", UMI.MI);
+                               "Node in CSE without InstrMapping:\n%s",
+                               stringify(UMI.MI, S1));
 
     if (InstrMapping[UMI.MI] != &UMI)
       return createStringError(std::make_error_code(std::errc::not_supported),
-                               "Mismatch in CSE mapping");
+                               "Mismatch in CSE mapping:\n%s\n%s",
+                               stringify(InstrMapping[UMI.MI]->MI, S1),
+                               stringify(UMI.MI, S2));
   }
 #endif
   return Error::success();
 }
 
 void GISelCSEInfo::print() {
   LLVM_DEBUG(for (auto &It
                   : OpcodeHitTable) {

llvm/lib/CodeGen/GlobalISel/Combiner.cpp

while (!WorkList.empty()) {
       MachineInstr *CurrInst = WorkList.pop_back_val();
       LLVM_DEBUG(dbgs() << "\nTry combining " << *CurrInst;);
       Changed |= CInfo.combine(WrapperObserver, *CurrInst, B);
       Observer.reportFullyCreatedInstrs();
     }
     MFChanged |= Changed;
   } while (Changed);
 
-  assert(!CSEInfo || (!errorToBool(CSEInfo->verify()) &&
-                         "CSEInfo is not consistent. Likely missing calls to "
-                         "observer on mutations"));
+#ifndef NDEBUG
+  if (CSEInfo) {
+    if (auto E = CSEInfo->verify()) {
+      errs() << E << '\n';
+      assert(false && "CSEInfo is not consistent. Likely missing calls to "
+                      "observer on mutations.");
+    }
+  }
+#endif
   return MFChanged;
 }