Merge pull request llvm#39567 from atrick/new-sil-utils

Author: swift-ci

include/swift/SIL/BasicBlockUtils.h

@@ -148,6 +148,10 @@ void findJointPostDominatingSet(
     function_ref<void(SILBasicBlock *)> foundJointPostDomSetCompletionBlocks,
     function_ref<void(SILBasicBlock *)> inputBlocksInJointPostDomSet = {});
 
+#ifndef NDEBUG
+bool checkDominates(SILBasicBlock *sourceBlock, SILBasicBlock *destBlock);
+#endif
+
 } // namespace swift
 
 #endif

include/swift/SIL/SILInstruction.h

@@ -8771,10 +8771,13 @@ template <typename BaseTy> class CastBranchInstBase : public BaseTy {
 
   TermInst::SuccessorListTy getSuccessors() { return DestBBs; }
 
-  SILBasicBlock *getSuccessBB() { return DestBBs[0]; }
-  const SILBasicBlock *getSuccessBB() const { return DestBBs[0]; }
-  SILBasicBlock *getFailureBB() { return DestBBs[1]; }
-  const SILBasicBlock *getFailureBB() const { return DestBBs[1]; }
+  // Enumerate the successor indices
+  enum SuccessorPath { SuccessIdx = 0, FailIdx = 1};
+
+  SILBasicBlock *getSuccessBB() { return DestBBs[SuccessIdx]; }
+  const SILBasicBlock *getSuccessBB() const { return DestBBs[SuccessIdx]; }
+  SILBasicBlock *getFailureBB() { return DestBBs[FailIdx]; }
+  const SILBasicBlock *getFailureBB() const { return DestBBs[FailIdx]; }
 
   /// The number of times the True branch was executed
   ProfileCounter getTrueBBCount() const { return DestBBs[0].getCount(); }

lib/SIL/Utils/BasicBlockUtils.cpp

@@ -11,6 +11,7 @@
 //===----------------------------------------------------------------------===//
 
 #include "swift/SIL/BasicBlockUtils.h"
+#include "swift/SIL/BasicBlockDatastructures.h"
 #include "swift/Basic/Defer.h"
 #include "swift/Basic/STLExtras.h"
 #include "swift/SIL/Dominance.h"
@@ -521,3 +522,38 @@ void swift::findJointPostDominatingSet(
     }
   }
 }
+
+//===----------------------------------------------------------------------===//
+//                          checkReachingBlockDominance
+//===----------------------------------------------------------------------===//
+
+#ifndef NDEBUG
+/// Check that \p sourceBlock dominates \p destBlock.
+///
+/// Useful for *temporary* assertions when Dominance is unavailable. This is
+/// worst case O(numberOfBlocksInFunction). It should only be used when \p
+/// sourceBlock is expected to be "close to" \p destBlock in almost all
+/// cases. Because of the potential for quadratic behavior, it should only be
+/// used during feature development, never as a permanent check.  If a dominance
+/// check is required for correctness, then DominanceInfo should be passed down
+/// to the utility function that needs this check.
+bool
+swift::checkDominates(SILBasicBlock *sourceBlock, SILBasicBlock *destBlock) {
+  SILBasicBlock *entryBlock = sourceBlock->getParent()->getEntryBlock();
+  BasicBlockWorklist worklist(destBlock);
+  bool reaches = false;
+  while (SILBasicBlock *block = worklist.pop()) {
+    if (block == sourceBlock) {
+      reaches = true;
+      continue;
+    }
+    if (block == entryBlock) {
+      return false; // does not dominate
+    }
+    for (auto *predBlock : block->getPredecessorBlocks()) {
+      worklist.pushIfNotVisited(predBlock);
+    }
+  }
+  return reaches;
+}
+#endif