[PATCH] D18529: Add a dump method to MachineFunctionProperties for better error messages

[Derek Schuff via llvm-commits]

dschuff created this revision.
dschuff added a reviewer: qcolombet.
dschuff added a subscriber: llvm-commits.

This makes check failures much easier to understand.
Make it empty (but leave it in the class) for NDEBUG builds.

http://reviews.llvm.org/D18529

Files:
  include/llvm/CodeGen/MachineFunction.h
  lib/CodeGen/MachineFunction.cpp
  lib/CodeGen/MachineFunctionPass.cpp

Index: lib/CodeGen/MachineFunctionPass.cpp
===================================================================
--- lib/CodeGen/MachineFunctionPass.cpp
+++ lib/CodeGen/MachineFunctionPass.cpp
@@ -44,8 +44,18 @@
   MachineFunction &MF = getAnalysis<MachineFunctionAnalysis>().getMF();
   MachineFunctionProperties &MFProps = MF.getProperties();
 
-  assert(MFProps.verifyRequiredProperties(RequiredProperties) &&
-         "Properties required by the pass are not met by the function");
+#ifndef NDEBUG
+  if (!MFProps.verifyRequiredProperties(RequiredProperties)) {
+    errs() << "MachineFunctionProperties required by " << getPassName()
+           << " pass are not met by function " << F.getName() << ".\n"
+           << "Required properties: ";
+    RequiredProperties.dump(errs());
+    errs() << "\nCurrent properties: ";
+    MFProps.dump(errs());
+    errs() << "\n";
+    llvm_unreachable("MachineFunctionProperties check failed");
+  }
+#endif
 
   bool RV = runOnMachineFunction(MF);
 
Index: lib/CodeGen/MachineFunction.cpp
===================================================================
--- lib/CodeGen/MachineFunction.cpp
+++ lib/CodeGen/MachineFunction.cpp
@@ -54,6 +54,28 @@
 
 void MachineFunctionInitializer::anchor() {}
 
+void MachineFunctionProperties::dump(raw_ostream &ROS) const {
+  // Leave this function even in NDEBUG as an out-of-line anchor.
+#ifndef NDEBUG
+  if (!Properties.any()) {
+    ROS << "(empty)";
+    return;
+  }
+  for (BitVector::size_type i = 0; i < Properties.size(); ++i) {
+    if (Properties[i]) {
+      switch(static_cast<Property>(i)) {
+        case Property::AllVRegsAllocated:
+          ROS << "AllVRegsAllocated ";
+          break;
+        default:
+          // TODO: Implement IsSSA/TracksLiveness when we make them properties.
+          llvm_unreachable("Unexpected value for property enum");
+      }
+    }
+  }
+#endif
+}
+
 //===----------------------------------------------------------------------===//
 // MachineFunction implementation
 //===----------------------------------------------------------------------===//
Index: include/llvm/CodeGen/MachineFunction.h
===================================================================
--- include/llvm/CodeGen/MachineFunction.h
+++ include/llvm/CodeGen/MachineFunction.h
@@ -143,6 +143,8 @@
     return !V.Properties.test(Properties);
   }
 
+  void dump(raw_ostream &ROS) const;
+
 private:
   BitVector Properties =
       BitVector(static_cast<unsigned>(Property::LastProperty));


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D18529.51849.patch
Type: text/x-patch
Size: 2508 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20160328/640c18ca/attachment.bin>