ARCSequenceOpts: Improve debug print

Author: meg-gupta

lib/SILOptimizer/ARC/ARCBBState.cpp

@@ -137,6 +137,34 @@ void ARCBBState::initPredTopDown(ARCBBState &PredBBState) {
   PtrToTopDownState = PredBBState.PtrToTopDownState;
 }
 
+void ARCBBState::dumpBottomUpState() {
+  for (auto state : getBottomupStates()) {
+    if (!state.hasValue())
+      continue;
+    auto elem = state.getValue();
+    if (!elem.first)
+      continue;
+    llvm::dbgs() << "SILValue: ";
+    elem.first->dump();
+    llvm::dbgs() << "RefCountState: ";
+    elem.second.dump();
+  }
+}
+
+void ARCBBState::dumpTopDownState() {
+  for (auto state : getTopDownStates()) {
+    if (!state.hasValue())
+      continue;
+    auto elem = state.getValue();
+    if (!elem.first)
+      continue;
+    llvm::dbgs() << "SILValue: ";
+    elem.first->dump();
+    llvm::dbgs() << "RefCountState: ";
+    elem.second.dump();
+  }
+}
+
 //===----------------------------------------------------------------------===//
 //                               ARCBBStateInfo
 //===----------------------------------------------------------------------===//

lib/SILOptimizer/ARC/ARCBBState.h

@@ -137,6 +137,9 @@ class ARCSequenceDataflowEvaluator::ARCBBState {
   /// BB. Used to create an initial state before we merge in other
   /// predecessors. This is currently a stub.
   void initPredTopDown(ARCBBState &PredBB);
+
+  void dumpBottomUpState();
+  void dumpTopDownState();
 };
 
 class ARCSequenceDataflowEvaluator::ARCBBStateInfoHandle {

lib/SILOptimizer/ARC/GlobalARCSequenceDataflow.cpp

@@ -363,9 +363,36 @@ ARCSequenceDataflowEvaluator::ARCSequenceDataflowEvaluator(
 bool ARCSequenceDataflowEvaluator::run(bool FreezeOwnedReleases) {
   bool NestingDetected = processBottomUp(FreezeOwnedReleases);
   NestingDetected |= processTopDown();
+
+  LLVM_DEBUG(
+      llvm::dbgs() << "*** Bottom-Up and Top-Down analysis results ***\n");
+  LLVM_DEBUG(dumpDataflowResults());
+
   return NestingDetected;
 }
 
+void ARCSequenceDataflowEvaluator::dumpDataflowResults() {
+  llvm::dbgs() << "IncToDecStateMap:\n";
+  for (auto it : IncToDecStateMap) {
+    if (!it.hasValue())
+      continue;
+    auto instAndState = it.getValue();
+    llvm::dbgs() << "Increment: ";
+    instAndState.first->dump();
+    instAndState.second.dump();
+  }
+
+  llvm::dbgs() << "DecToIncStateMap:\n";
+  for (auto it : DecToIncStateMap) {
+    if (!it.hasValue())
+      continue;
+    auto instAndState = it.getValue();
+    llvm::dbgs() << "Decrement: ";
+    instAndState.first->dump();
+    instAndState.second.dump();
+  }
+}
+
 // We put the destructor here so we don't need to expose the type of
 // BBStateInfo to the outside world.
 ARCSequenceDataflowEvaluator::~ARCSequenceDataflowEvaluator() = default;

lib/SILOptimizer/ARC/GlobalARCSequenceDataflow.h

@@ -108,6 +108,8 @@ class ARCSequenceDataflowEvaluator {
 
   llvm::Optional<ARCBBStateInfoHandle> getBottomUpBBState(SILBasicBlock *BB);
   llvm::Optional<ARCBBStateInfoHandle> getTopDownBBState(SILBasicBlock *BB);
+
+  void dumpDataflowResults();
 };
 
 } // end swift namespace

lib/SILOptimizer/ARC/GlobalLoopARCSequenceDataflow.cpp

@@ -252,11 +252,38 @@ LoopARCSequenceDataflowEvaluator::~LoopARCSequenceDataflowEvaluator() {
 bool LoopARCSequenceDataflowEvaluator::runOnLoop(
     const LoopRegion *R, bool FreezeOwnedArgEpilogueReleases,
     bool RecomputePostDomReleases) {
+  LLVM_DEBUG(llvm::dbgs() << "Run on region:\n");
+  LLVM_DEBUG(R->dump(true));
   bool NestingDetected = processLoopBottomUp(R, FreezeOwnedArgEpilogueReleases);
   NestingDetected |= processLoopTopDown(R);
+  LLVM_DEBUG(
+      llvm::dbgs() << "*** Bottom-Up and Top-Down analysis results ***\n");
+  LLVM_DEBUG(dumpDataflowResults());
   return NestingDetected;
 }
 
+void LoopARCSequenceDataflowEvaluator::dumpDataflowResults() {
+  llvm::dbgs() << "IncToDecStateMap:\n";
+  for (auto it : IncToDecStateMap) {
+    if (!it.hasValue())
+      continue;
+    auto instAndState = it.getValue();
+    llvm::dbgs() << "Increment: ";
+    instAndState.first->dump();
+    instAndState.second.dump();
+  }
+
+  llvm::dbgs() << "DecToIncStateMap:\n";
+  for (auto it : DecToIncStateMap) {
+    if (!it.hasValue())
+      continue;
+    auto instAndState = it.getValue();
+    llvm::dbgs() << "Decrement: ";
+    instAndState.first->dump();
+    instAndState.second.dump();
+  }
+}
+
 void LoopARCSequenceDataflowEvaluator::summarizeLoop(
     const LoopRegion *R) {
   RegionStateInfo[R]->summarize(LRFI, RegionStateInfo);

lib/SILOptimizer/ARC/GlobalLoopARCSequenceDataflow.h

@@ -134,6 +134,8 @@ class LoopARCSequenceDataflowEvaluator {
   bool processLoopTopDown(const LoopRegion *R);
   bool processLoopBottomUp(const LoopRegion *R,
                            bool FreezeOwnedArgEpilogueReleases);
+
+  void dumpDataflowResults();
 };
 
 } // end swift namespace

lib/SILOptimizer/ARC/RCStateTransition.h

@@ -126,7 +126,6 @@ class RCStateTransition {
   /// Returns a Range of Mutators. Asserts if this transition is not a mutator
   /// transition.
   mutator_range getMutators() const {
-    assert(isMutator() && "This should never be called given mutators");
     return {Mutators->begin(), Mutators->end()};
   }
 

lib/SILOptimizer/ARC/RefCountState.cpp

@@ -903,6 +903,27 @@ void TopDownRefCountState::updateForDifferentLoopInst(
 //                             Printing Utilities
 //===----------------------------------------------------------------------===//
 
+void BottomUpRefCountState::dump() {
+  llvm::dbgs() << LatState << " "
+               << (isKnownSafe() ? "KnownSafe" : "NotKnownSafe") << " "
+               << (isCodeMotionSafe() ? "CodeMotionSafe" : "NotCodeMotionSafe")
+               << "\n";
+  llvm::dbgs() << "Matching Instructions:\n";
+  for (auto it : getInstructions()) {
+    it->dump();
+  }
+}
+void TopDownRefCountState::dump() {
+  llvm::dbgs() << LatState << " "
+               << (isKnownSafe() ? "KnownSafe" : "NotKnownSafe") << " "
+               << (isCodeMotionSafe() ? "CodeMotionSafe" : "NotCodeMotionSafe")
+               << "\n";
+  llvm::dbgs() << "Matching Instructions:\n";
+  for (auto it : getInstructions()) {
+    it->dump();
+  }
+}
+
 namespace llvm {
 
 raw_ostream &operator<<(raw_ostream &OS,
@@ -938,5 +959,4 @@ llvm::raw_ostream &operator<<(llvm::raw_ostream &OS,
 
   llvm_unreachable("Unhandled LatticeState in switch.");
 }
-
 } // end namespace llvm

lib/SILOptimizer/ARC/RefCountState.h

@@ -212,6 +212,8 @@ class BottomUpRefCountState : public RefCountState {
   /// Uninitialize the current state.
   void clear();
 
+  void dump();
+
 private:
   /// Return true if we *might* remove this instruction.
   ///
@@ -354,6 +356,8 @@ class TopDownRefCountState : public RefCountState {
   /// succeed and false otherwise.
   bool merge(const TopDownRefCountState &Other);
 
+  void dump();
+
 private:
   /// Can we guarantee that the given reference counted value has been modified?
   bool isRefCountStateModified() const;