[X86]check that Uses, Defs are same for entries in memory folding table

[XinWang10]

Summary

Add expensive check that Uses, Defs are same for entries in memory folding table.
MemFolding could not change the Uses/Defs.

[craig.topper]

llvm/utils/TableGen/X86FoldTablesEmitter.cpp

115

Variable names should not contain underscores.

123

Can we use operator== for the vectors?

[XinWang10]

• resolve comments

[XinWang10]

llvm/utils/TableGen/X86FoldTablesEmitter.cpp

123

Sure.

[craig.topper]

llvm/utils/TableGen/X86FoldTablesEmitter.cpp

115

Replace LHS with Reg and RHS with Mem.

[XinWang10]

• change variable name

[skan]

llvm/utils/TableGen/X86FoldTablesEmitter.cpp

111

Function name should not capitalize

[XinWang10]

• correct the function name format

[skan]

llvm/utils/TableGen/X86FoldTablesEmitter.cpp

111

Shouldn't we return void and abort (report_fatal_error) if there is sth wrong?

621

Why there is an indent here?

621

The first char of variable names should be capitalized.

[XinWang10]

• adjust format and Use report_fatal_error instead of print msgs

[skan]

llvm/utils/TableGen/X86FoldTablesEmitter.cpp

112

, -> and

This function is about entry only, not about the table. So I suggest
Check that Uses and Defs are same after memory fold

120

Drop llvm::?

619–620

The logic here does not show anything about Uses or Defs. And it's self-explained, we can remove the comments.

[XinWang10]

• update comments

[skan]

LGTM

[skan]

llvm/utils/TableGen/X86FoldTablesEmitter.cpp

120

drop namespace llvm?

[pengfei]

llvm/utils/TableGen/X86FoldTablesEmitter.cpp

120

Given the code for Debug build only, why don't use assert directly?

[skan]

llvm/utils/TableGen/X86FoldTablesEmitter.cpp

120

How to include RegInstRec.getName() and MemInstRec.getName() in assertion message?

[pengfei]

llvm/utils/TableGen/X86FoldTablesEmitter.cpp

120

Right, I missed them :)

[XinWang10]

• remove unneeded namespace

[XinWang10]

Thanks for your review~

llvm/utils/TableGen/X86FoldTablesEmitter.cpp

void print(formatted_raw_ostream &OS) const {
 
       StringRef SimplifiedAttrs = StringRef(Attrs).rtrim("|");
       if (SimplifiedAttrs.empty())
         SimplifiedAttrs = "0";
 
       OS << SimplifiedAttrs << "},\n";
     }
 
+#ifndef NDEBUG
+    // Check that Uses and Defs are same after memory fold.
+    void checkCorrectness() const {
+      auto &RegInstRec = *RegInst->TheDef;
+      auto &MemInstRec = *MemInst->TheDef;
+      auto ListOfUsesReg = RegInstRec.getValueAsListOfDefs("Uses");
+      auto ListOfUsesMem = MemInstRec.getValueAsListOfDefs("Uses");
+      auto ListOfDefsReg = RegInstRec.getValueAsListOfDefs("Defs");
+      auto ListOfDefsMem = MemInstRec.getValueAsListOfDefs("Defs");
+      if (ListOfUsesReg != ListOfUsesMem || ListOfDefsReg != ListOfDefsMem)
+        report_fatal_error("Uses/Defs couldn't be changed after folding " +
+                           RegInstRec.getName() + " to " +
+                           MemInstRec.getName());
+    }
+#endif
   };
 
   // NOTE: We check the fold tables are sorted in X86InstrFoldTables.cpp by the enum of the
   //       instruction, which is computed in CodeGenTarget::ComputeInstrsByEnum. So we should
   //       use the same comparator here.
   // FIXME: Could we share the code with CodeGenTarget::ComputeInstrsByEnum?
   struct CompareInstrsByEnum {
     bool operator()(const CodeGenInstruction *LHS,
void X86FoldTablesEmitter::run(raw_ostream &o) {
   for (const ManualMapEntry &Entry : ManualMapSet) {
     Record *RegInstIter = Records.getDef(Entry.RegInstStr);
     Record *MemInstIter = Records.getDef(Entry.MemInstStr);
 
     updateTables(&(Target.getInstruction(RegInstIter)),
                  &(Target.getInstruction(MemInstIter)), Entry.Strategy, true);
   }
 
+#ifndef NDEBUG
+  auto CheckMemFoldTable = [](const FoldTable &Table) -> void {
+    for (const auto &Record : Table) {
+      auto &FoldEntry = Record.second;
+      FoldEntry.checkCorrectness();
+    }
+  };
+  CheckMemFoldTable(Table2Addr);
+  CheckMemFoldTable(Table0);
+  CheckMemFoldTable(Table1);
+  CheckMemFoldTable(Table2);
+  CheckMemFoldTable(Table3);
+  CheckMemFoldTable(Table4);
+#endif
   // Print all tables.
   printTable(Table2Addr, "Table2Addr", OS);
   printTable(Table0, "Table0", OS);
   printTable(Table1, "Table1", OS);
   printTable(Table2, "Table2", OS);
   printTable(Table3, "Table3", OS);
   printTable(Table4, "Table4", OS);
 }
 
 static TableGen::Emitter::OptClass<X86FoldTablesEmitter>
     X("gen-x86-fold-tables", "Generate X86 fold tables");