PrunedLiveness: add a SILFunction argument

atrick · atrick · commit 15796e3ff952 · 2023-03-22T01:36:48.000-07:00
So that liveness can migrate to using a SILBitfield.
diff --git a/include/swift/SIL/OwnershipLiveness.h b/include/swift/SIL/OwnershipLiveness.h
@@ -178,7 +178,8 @@ class OSSALiveness {
   OSSALiveness &operator=(const OSSALiveness &) = delete;
 
 public:
-  OSSALiveness(SILValue def): ownershipDef(def), liveness(&discoveredBlocks) {}
+  OSSALiveness(SILValue def): ownershipDef(def),
+                              liveness(def->getFunction(), &discoveredBlocks) {}
 
   const SSAPrunedLiveness &getLiveness() const { return liveness; }
 
diff --git a/include/swift/SIL/PrunedLiveness.h b/include/swift/SIL/PrunedLiveness.h
@@ -479,8 +479,9 @@ class PrunedLiveness {
   llvm::SmallMapVector<SILInstruction *, bool, 8> users;
 
 public:
-  PrunedLiveness(SmallVectorImpl<SILBasicBlock *> *discoveredBlocks = nullptr)
-      : liveBlocks(1 /*num bits*/, discoveredBlocks) {}
+  PrunedLiveness(SILFunction *function,
+                 SmallVectorImpl<SILBasicBlock *> *discoveredBlocks = nullptr)
+      : liveBlocks(function, discoveredBlocks) {}
 
   bool empty() const {
     assert(!liveBlocks.empty() || users.empty());
@@ -745,8 +746,9 @@ class SSAPrunedLiveness : public PrunedLiveRange<SSAPrunedLiveness> {
 
 public:
   SSAPrunedLiveness(
+      SILFunction *function,
       SmallVectorImpl<SILBasicBlock *> *discoveredBlocks = nullptr)
-      : PrunedLiveRange(discoveredBlocks) {}
+      : PrunedLiveRange(function, discoveredBlocks) {}
 
   SILValue getDef() const { return def; }
 
@@ -815,8 +817,8 @@ class MultiDefPrunedLiveness : public PrunedLiveRange<MultiDefPrunedLiveness> {
   MultiDefPrunedLiveness(
       SILFunction *function,
       SmallVectorImpl<SILBasicBlock *> *discoveredBlocks = nullptr)
-      : PrunedLiveRange(discoveredBlocks), defs(function), defBlocks(function) {
-  }
+      : PrunedLiveRange(function, discoveredBlocks), defs(function),
+        defBlocks(function) {}
 
   void clear() {
     llvm_unreachable("multi-def liveness cannot be reused");
@@ -886,10 +888,11 @@ class DiagnosticPrunedLiveness : public SSAPrunedLiveness {
 
 public:
   DiagnosticPrunedLiveness(
+      SILFunction *function,
       SmallVectorImpl<SILBasicBlock *> *discoveredBlocks = nullptr,
       SmallSetVector<SILInstruction *, 8> *nonLifetimeEndingUsesInLiveOut =
           nullptr)
-      : SSAPrunedLiveness(discoveredBlocks),
+      : SSAPrunedLiveness(function, discoveredBlocks),
         nonLifetimeEndingUsesInLiveOut(nonLifetimeEndingUsesInLiveOut) {}
 
   void clear() {
diff --git a/include/swift/SILOptimizer/Utils/CanonicalizeBorrowScope.h b/include/swift/SILOptimizer/Utils/CanonicalizeBorrowScope.h
@@ -85,7 +85,8 @@ class CanonicalizeBorrowScope {
   llvm::SmallDenseMap<SILBasicBlock *, CopyValueInst *, 4> persistentCopies;
 
 public:
-  CanonicalizeBorrowScope(InstructionDeleter &deleter) : deleter(deleter) {}
+  CanonicalizeBorrowScope(SILFunction *function, InstructionDeleter &deleter)
+    : liveness(function), deleter(deleter) {}
 
   BorrowedValue getBorrowedValue() const { return borrowedValue; }
 
diff --git a/include/swift/SILOptimizer/Utils/CanonicalizeOSSALifetime.h b/include/swift/SILOptimizer/Utils/CanonicalizeOSSALifetime.h
@@ -281,12 +281,13 @@ class CanonicalizeOSSALifetime final {
   }
 
   CanonicalizeOSSALifetime(bool pruneDebugMode, bool maximizeLifetime,
+                           SILFunction *function,
                            NonLocalAccessBlockAnalysis *accessBlockAnalysis,
                            DominanceInfo *domTree, InstructionDeleter &deleter)
       : pruneDebugMode(pruneDebugMode), maximizeLifetime(maximizeLifetime),
         accessBlockAnalysis(accessBlockAnalysis), domTree(domTree),
         deleter(deleter),
-        liveness(maximizeLifetime ? &discoveredBlocks : nullptr) {}
+        liveness(function, maximizeLifetime ? &discoveredBlocks : nullptr) {}
 
   SILValue getCurrentDef() const { return liveness.getDef(); }
 
diff --git a/include/swift/SILOptimizer/Utils/OwnershipOptUtils.h b/include/swift/SILOptimizer/Utils/OwnershipOptUtils.h
@@ -113,7 +113,7 @@ class GuaranteedOwnershipExtension {
   GuaranteedOwnershipExtension(InstructionDeleter &deleter,
                                DeadEndBlocks &deBlocks, SILFunction *function)
     : deleter(deleter), deBlocks(deBlocks),
-      guaranteedLiveness(function) {}
+      guaranteedLiveness(function), ownedLifetime(function) {}
 
   void clear() {
     guaranteedLiveness.clear();
diff --git a/lib/SIL/Utils/OwnershipUtils.cpp b/lib/SIL/Utils/OwnershipUtils.cpp
@@ -1213,7 +1213,7 @@ bool AddressOwnership::areUsesWithinLifetime(
   // --- A reference with no borrow scope! Currently happens for project_box.
 
   // Compute the reference value's liveness.
-  SSAPrunedLiveness liveness;
+  SSAPrunedLiveness liveness(root->getFunction());
   liveness.initializeDef(root);
   LiveRangeSummary summary = liveness.computeSimple();
   // Conservatively ignore InnerBorrowKind::Reborrowed and
diff --git a/lib/SIL/Verifier/SILVerifier.cpp b/lib/SIL/Verifier/SILVerifier.cpp
@@ -2545,7 +2545,7 @@ class SILVerifier : public SILVerifierBase<SILVerifier> {
                     SI->getSrc()->getType(),
                     "Store operand type and dest type mismatch");
 
-    SSAPrunedLiveness scopedAddressLiveness;
+    SSAPrunedLiveness scopedAddressLiveness(SI->getFunction());
     ScopedAddressValue scopedAddress(SI);
     // FIXME: Reenable @test_load_borrow_store_borrow_nested in
     // store_borrow_verify_errors once computeLivess can successfully handle a
diff --git a/lib/SILOptimizer/Mandatory/AddressLowering.cpp b/lib/SILOptimizer/Mandatory/AddressLowering.cpp
@@ -352,7 +352,7 @@ static bool isStoreCopy(SILValue value) {
   if (!storeInst)
     return false;
 
-  SSAPrunedLiveness liveness;
+  SSAPrunedLiveness liveness(copyInst->getFunction());
   auto isStoreOutOfRange = [&liveness, storeInst](SILValue root) {
     liveness.initializeDef(root);
     auto summary = liveness.computeSimple();
@@ -3366,7 +3366,7 @@ static void emitEndBorrows(SILValue value, AddressLoweringState &pass) {
   findInnerTransitiveGuaranteedUses(value, &usePoints);
 
   SmallVector<SILBasicBlock *, 4> discoveredBlocks;
-  SSAPrunedLiveness liveness(&discoveredBlocks);
+  SSAPrunedLiveness liveness(value->getFunction(), &discoveredBlocks);
   liveness.initializeDef(value);
   for (auto *use : usePoints) {
     assert(!use->isLifetimeEnding() || isa<EndBorrowInst>(use->getUser()));
diff --git a/lib/SILOptimizer/Mandatory/ConsumeOperatorCopyableValuesChecker.cpp b/lib/SILOptimizer/Mandatory/ConsumeOperatorCopyableValuesChecker.cpp
@@ -60,9 +60,9 @@ struct CheckerLivenessInfo {
   SmallVector<Operand *, 8> interiorPointerTransitiveUses;
   DiagnosticPrunedLiveness liveness;
 
-  CheckerLivenessInfo()
+  CheckerLivenessInfo(SILFunction *fn)
       : nonLifetimeEndingUsesInLiveOut(),
-        liveness(nullptr, &nonLifetimeEndingUsesInLiveOut) {}
+        liveness(fn, nullptr, &nonLifetimeEndingUsesInLiveOut) {}
 
   void initDef(SILValue def) {
     liveness.initializeDef(def);
@@ -220,7 +220,7 @@ struct ConsumeOperatorCopyableValuesChecker {
   SILLoopInfo *loopInfoToUpdate;
 
   ConsumeOperatorCopyableValuesChecker(SILFunction *fn)
-      : fn(fn), livenessInfo(), dominanceToUpdate(nullptr),
+      : fn(fn), livenessInfo(fn), dominanceToUpdate(nullptr),
         loopInfoToUpdate(nullptr) {}
 
   void setDominanceToUpdate(DominanceInfo *newDFI) {
diff --git a/lib/SILOptimizer/Mandatory/DiagnoseLifetimeIssues.cpp b/lib/SILOptimizer/Mandatory/DiagnoseLifetimeIssues.cpp
@@ -63,6 +63,8 @@ class DiagnoseLifetimeIssues {
   /// callgraphs, with pass down references.
   static constexpr int maxCallDepth = 8;
 
+  SILFunction *function = nullptr;
+
   /// The liveness of the object in question, computed in visitUses.
   SSAPrunedLiveness liveness;
 
@@ -84,9 +86,10 @@ class DiagnoseLifetimeIssues {
   void reportDeadStore(SILInstruction *allocationInst);
 
 public:
-  DiagnoseLifetimeIssues() {}
+  DiagnoseLifetimeIssues(SILFunction *function)
+    : function(function), liveness(function) {}
 
-  void diagnose(SILFunction *function);
+  void diagnose();
 };
 
 /// Returns true if def is an owned value resulting from an object allocation.
@@ -352,7 +355,7 @@ void DiagnoseLifetimeIssues::reportDeadStore(SILInstruction *allocationInst) {
 }
 
 /// Prints warnings for dead weak stores in \p function.
-void DiagnoseLifetimeIssues::diagnose(SILFunction *function) {
+void DiagnoseLifetimeIssues::diagnose() {
   for (SILBasicBlock &block : *function) {
     for (SILInstruction &inst : block) {
       // Only for allocations we know that a destroy will actually deallocate
diff --git a/lib/SILOptimizer/Mandatory/MoveOnlyAddressCheckerUtils.cpp b/lib/SILOptimizer/Mandatory/MoveOnlyAddressCheckerUtils.cpp
@@ -2289,7 +2289,7 @@ bool MoveOnlyAddressCheckerPImpl::performSingleCheck(
   // to categorize the uses of this address into their ownership behavior (e.x.:
   // init, reinit, take, destroy, etc.).
   SmallVector<SILBasicBlock *, 32> gatherUsesDiscoveredBlocks;
-  SSAPrunedLiveness gatherUsesLiveness(&gatherUsesDiscoveredBlocks);
+  SSAPrunedLiveness gatherUsesLiveness(fn, &gatherUsesDiscoveredBlocks);
   GatherUsesVisitor visitor(*this, addressUseState, markedAddress,
                             diagnosticEmitter, gatherUsesLiveness);
   SWIFT_DEFER { visitor.clear(); };
diff --git a/lib/SILOptimizer/Mandatory/MoveOnlyBorrowToDestructureUtils.cpp b/lib/SILOptimizer/Mandatory/MoveOnlyBorrowToDestructureUtils.cpp
@@ -1507,7 +1507,7 @@ void Implementation::cleanup() {
   // not actually completely consume.
   auto *fn = getMarkedValue()->getFunction();
   SmallVector<SILBasicBlock *, 8> discoveredBlocks;
-  SSAPrunedLiveness liveness(&discoveredBlocks);
+  SSAPrunedLiveness liveness(fn, &discoveredBlocks);
   PrunedLivenessBoundary boundary;
   while (!interface.createdDestructures.empty()) {
     auto *inst = interface.createdDestructures.pop_back_val();
@@ -1868,7 +1868,7 @@ bool BorrowToDestructureTransform::transform() {
       // copy_value in each destination block that we originally inserted.
       {
         SmallVector<SILBasicBlock *, 8> discoveredBlocks;
-        SSAPrunedLiveness liveness(&discoveredBlocks);
+        SSAPrunedLiveness liveness(fn, &discoveredBlocks);
         PrunedLivenessBoundary boundary;
 
         SILBuilderWithScope builder(s);
diff --git a/lib/SILOptimizer/Mandatory/ReferenceBindingTransform.cpp b/lib/SILOptimizer/Mandatory/ReferenceBindingTransform.cpp
@@ -164,7 +164,7 @@ static bool runTransform(SILFunction *fn) {
     // Ok, we have our initialization. Now gather our destroys of our value and
     // initialize an SSAPrunedLiveness, using our initInst as our def.
     SmallVector<SILBasicBlock *, 8> discoveredBlocks;
-    SSAPrunedLiveness liveness(&discoveredBlocks);
+    SSAPrunedLiveness liveness(fn, &discoveredBlocks);
     StackList<DestroyValueInst *> destroyValueInst(fn);
     liveness.initializeDef(mark);
     for (auto *consume : mark->getConsumingUses()) {
diff --git a/lib/SILOptimizer/SILCombiner/SILCombine.cpp b/lib/SILOptimizer/SILCombiner/SILCombine.cpp
@@ -353,8 +353,9 @@ void SILCombiner::canonicalizeOSSALifetimes(SILInstruction *currentInst) {
   CanonicalizeOSSALifetime canonicalizer(
       false /*prune debug*/,
       !parentTransform->getFunction()->shouldOptimize() /*maximize lifetime*/,
-      NLABA, domTree, deleter);
-  CanonicalizeBorrowScope borrowCanonicalizer(deleter);
+      parentTransform->getFunction(), NLABA, domTree, deleter);
+  CanonicalizeBorrowScope borrowCanonicalizer(parentTransform->getFunction(),
+                                              deleter);
 
   while (!defsToCanonicalize.empty()) {
     SILValue def = defsToCanonicalize.pop_back_val();
diff --git a/lib/SILOptimizer/Transforms/CopyPropagation.cpp b/lib/SILOptimizer/Transforms/CopyPropagation.cpp
@@ -472,7 +472,7 @@ void CopyPropagation::run() {
   // don't need to explicitly check for changes.
   CanonicalizeOSSALifetime canonicalizer(
       pruneDebug, /*maximizeLifetime=*/!getFunction()->shouldOptimize(),
-      accessBlockAnalysis, domTree, deleter);
+      getFunction(), accessBlockAnalysis, domTree, deleter);
   auto *calleeAnalysis = getAnalysis<BasicCalleeAnalysis>();
 
   // NOTE: We assume that the function is in reverse post order so visiting the
@@ -536,7 +536,7 @@ void CopyPropagation::run() {
   }
   // borrowCanonicalizer performs all modifications through deleter's
   // callbacks, so we don't need to explicitly check for changes.
-  CanonicalizeBorrowScope borrowCanonicalizer(deleter);
+  CanonicalizeBorrowScope borrowCanonicalizer(f, deleter);
   // The utilities in this loop cannot delete borrows before they are popped
   // from the worklist.
   while (true) {
diff --git a/lib/SILOptimizer/UtilityPasses/UnitTestRunner.cpp b/lib/SILOptimizer/UtilityPasses/UnitTestRunner.cpp
@@ -319,7 +319,7 @@ struct SSALivenessTest : UnitTest {
     llvm::outs() << "SSA lifetime analysis: " << value;
 
     SmallVector<SILBasicBlock *, 8> discoveredBlocks;
-    SSAPrunedLiveness liveness(&discoveredBlocks);
+    SSAPrunedLiveness liveness(value->getFunction(), &discoveredBlocks);
     liveness.initializeDef(value);
     LiveRangeSummary summary = liveness.computeSimple();
     if (summary.innerBorrowKind == InnerBorrowKind::Reborrowed)
@@ -354,7 +354,7 @@ struct ScopedAddressLivenessTest : UnitTest {
     assert(scopedAddress);
 
     SmallVector<SILBasicBlock *, 8> discoveredBlocks;
-    SSAPrunedLiveness liveness(&discoveredBlocks);
+    SSAPrunedLiveness liveness(value->getFunction(), &discoveredBlocks);
     scopedAddress.computeTransitiveLiveness(liveness);
     liveness.print(llvm::outs());
 
@@ -410,7 +410,7 @@ struct CanonicalizeOSSALifetimeTest : UnitTest {
     auto respectAccessScopes = arguments.takeBool();
     InstructionDeleter deleter;
     CanonicalizeOSSALifetime canonicalizer(
-        pruneDebug, maximizeLifetimes,
+        pruneDebug, maximizeLifetimes, getFunction(),
         respectAccessScopes ? accessBlockAnalysis : nullptr, domTree, deleter);
     auto value = arguments.takeValue();
     canonicalizer.canonicalizeValueLifetime(value);
@@ -429,7 +429,7 @@ struct CanonicalizeBorrowScopeTest : UnitTest {
     auto borrowedValue = BorrowedValue(value);
     assert(borrowedValue && "specified value isn't a BorrowedValue!?");
     InstructionDeleter deleter;
-    CanonicalizeBorrowScope canonicalizer(deleter);
+    CanonicalizeBorrowScope canonicalizer(value->getFunction(), deleter);
     canonicalizer.canonicalizeBorrowScope(borrowedValue);
     getFunction()->dump();
   }
diff --git a/lib/SILOptimizer/Utils/GenericCloner.cpp b/lib/SILOptimizer/Utils/GenericCloner.cpp
@@ -248,7 +248,7 @@ void GenericCloner::postFixUp(SILFunction *f) {
     // FIXME: Call OSSA lifetime fixup on all values used within the unreachable
     // code. This will recursively fixup nested scopes from the inside out so
     // that transitive liveness is not required.
-    SSAPrunedLiveness storeBorrowLiveness(&discoveredBlocks);
+    SSAPrunedLiveness storeBorrowLiveness(getCloned(), &discoveredBlocks);
     AddressUseKind useKind =
         scopedAddress.computeTransitiveLiveness(storeBorrowLiveness);
     if (useKind == AddressUseKind::NonEscaping) {
diff --git a/lib/SILOptimizer/Utils/OwnershipOptUtils.cpp b/lib/SILOptimizer/Utils/OwnershipOptUtils.cpp
@@ -141,7 +141,7 @@ bool swift::computeGuaranteedBoundary(SILValue value,
   bool noEscape = findInnerTransitiveGuaranteedUses(value, &usePoints);
 
   SmallVector<SILBasicBlock *, 4> discoveredBlocks;
-  SSAPrunedLiveness liveness(&discoveredBlocks);
+  SSAPrunedLiveness liveness(value->getFunction(), &discoveredBlocks);
   liveness.initializeDef(value);
   for (auto *use : usePoints) {
     assert(!use->isLifetimeEnding());
@@ -1857,7 +1857,7 @@ bool swift::extendStoreBorrow(StoreBorrowInst *sbi,
   ScopedAddressValue scopedAddress(sbi);
 
   SmallVector<SILBasicBlock *, 4> discoveredBlocks;
-  SSAPrunedLiveness storeBorrowLiveness(&discoveredBlocks);
+  SSAPrunedLiveness storeBorrowLiveness(sbi->getFunction(), &discoveredBlocks);
 
   // FIXME: if OSSA lifetimes are complete, then we don't need transitive
   // liveness here.
