Optimizer: create and update borrowed-from instructions in C++ optimizer passes

Author: eeckstein

include/swift/SILOptimizer/Utils/BasicBlockOptUtils.h

@@ -209,6 +209,8 @@ class BasicBlockCloner : public SILCloner<BasicBlockCloner> {
   // If available, the current DeadEndBlocks for incremental update.
   DeadEndBlocks *deBlocks;
 
+  SILPassManager *pm;
+
 public:
   /// An ordered list of old to new available value pairs.
   ///
@@ -217,8 +219,8 @@ class BasicBlockCloner : public SILCloner<BasicBlockCloner> {
   SmallVector<std::pair<SILValue, SILValue>, 16> availVals;
 
   // Clone blocks starting at `origBB`, within the same function.
-  BasicBlockCloner(SILBasicBlock *origBB, DeadEndBlocks *deBlocks = nullptr)
-      : SILCloner(*origBB->getParent()), origBB(origBB), deBlocks(deBlocks) {}
+  BasicBlockCloner(SILBasicBlock *origBB, SILPassManager *pm, DeadEndBlocks *deBlocks = nullptr)
+      : SILCloner(*origBB->getParent()), origBB(origBB), deBlocks(deBlocks), pm(pm) {}
 
   bool canCloneBlock() {
     for (auto &inst : *origBB) {

include/swift/SILOptimizer/Utils/InstOptUtils.h

@@ -231,7 +231,7 @@ SILLinkage getSpecializedLinkage(SILFunction *f, SILLinkage linkage);
 /// Tries to perform jump-threading on all checked_cast_br instruction in
 /// function \p Fn.
 bool tryCheckedCastBrJumpThreading(
-    SILFunction *fn, DominanceInfo *dt, DeadEndBlocks *deBlocks,
+    SILFunction *fn, SILPassManager *pm, DominanceInfo *dt, DeadEndBlocks *deBlocks,
     SmallVectorImpl<SILBasicBlock *> &blocksForWorklist,
     bool EnableOSSARewriteTerminator);
 

lib/SILOptimizer/Mandatory/ClosureLifetimeFixup.cpp

@@ -26,6 +26,7 @@
 #include "swift/SILOptimizer/PassManager/Transforms.h"
 #include "swift/SILOptimizer/Utils/BasicBlockOptUtils.h"
 #include "swift/SILOptimizer/Utils/CFGOptUtils.h"
+#include "swift/SILOptimizer/Utils/OwnershipOptUtils.h"
 #include "swift/SILOptimizer/Utils/InstOptUtils.h"
 #include "swift/SILOptimizer/Utils/SILSSAUpdater.h"
 #include "swift/SILOptimizer/Utils/StackNesting.h"
@@ -1480,6 +1481,7 @@ class ClosureLifetimeFixup : public SILFunctionTransform {
 
     if (fixupClosureLifetimes(*getFunction(), dominanceAnalysis,
                               checkStackNesting, modifiedCFG)) {
+      updateBorrowedFrom(getPassManager(), getFunction());
       if (checkStackNesting){
         modifiedCFG |=
           StackNesting::fixNesting(getFunction()) == StackNesting::Changes::CFG;

lib/SILOptimizer/SemanticARC/Context.h

@@ -31,6 +31,7 @@ namespace semanticarc {
 
 struct LLVM_LIBRARY_VISIBILITY Context {
   SILFunction &fn;
+  SILPassManager *pm = nullptr;
   ARCTransformKind transformKind = ARCTransformKind::All;
   DeadEndBlocks &deadEndBlocks;
   ValueLifetimeAnalysis::Frontier lifetimeFrontier;
@@ -119,9 +120,9 @@ struct LLVM_LIBRARY_VISIBILITY Context {
 
   DeadEndBlocks &getDeadEndBlocks() { return deadEndBlocks; }
 
-  Context(SILFunction &fn, DeadEndBlocks &deBlocks, bool onlyMandatoryOpts,
+  Context(SILFunction &fn, SILPassManager *pm, DeadEndBlocks &deBlocks, bool onlyMandatoryOpts,
           InstModCallbacks callbacks)
-      : fn(fn), deadEndBlocks(deBlocks), lifetimeFrontier(),
+      : fn(fn), pm(pm), deadEndBlocks(deBlocks), lifetimeFrontier(),
         addressToExhaustiveWriteListCache(constructCacheValue),
         onlyMandatoryOpts(onlyMandatoryOpts), instModCallbacks(callbacks) {}
 

lib/SILOptimizer/SemanticARC/OwnedToGuaranteedPhiOpt.cpp

@@ -21,6 +21,7 @@
 #include "Transforms.h"
 #include "swift/Basic/Defer.h"
 #include "swift/Basic/STLExtras.h"
+#include "swift/SILOptimizer/Utils/OwnershipOptUtils.h"
 
 using namespace swift;
 using namespace swift::semanticarc;
@@ -265,5 +266,8 @@ bool swift::semanticarc::tryConvertOwnedPhisToGuaranteedPhis(Context &ctx) {
     ctx.verify();
   }
 
+  if (madeChange)
+    updateBorrowedFrom(ctx.pm, &ctx.fn);
+
   return madeChange;
 }

lib/SILOptimizer/SemanticARC/SemanticARCOptVisitor.h

@@ -49,9 +49,9 @@ struct LLVM_LIBRARY_VISIBILITY SemanticARCOptVisitor
 
   Context ctx;
 
-  explicit SemanticARCOptVisitor(SILFunction &fn, DeadEndBlocks &deBlocks,
+  explicit SemanticARCOptVisitor(SILFunction &fn, SILPassManager *pm, DeadEndBlocks &deBlocks,
                                  bool onlyMandatoryOpts)
-      : ctx(fn, deBlocks, onlyMandatoryOpts,
+      : ctx(fn, pm, deBlocks, onlyMandatoryOpts,
             InstModCallbacks()
                 .onDelete(
                     [this](SILInstruction *inst) { eraseInstruction(inst); })

lib/SILOptimizer/SemanticARC/SemanticARCOpts.cpp

@@ -157,7 +157,7 @@ struct SemanticARCOpts : SILFunctionTransform {
            "verification is enabled");
 
     auto *deBlocksAnalysis = getAnalysis<DeadEndBlocksAnalysis>();
-    SemanticARCOptVisitor visitor(f, *deBlocksAnalysis->get(&f),
+    SemanticARCOptVisitor visitor(f, getPassManager(), *deBlocksAnalysis->get(&f),
                                   mandatoryOptsOnly);
 
 #ifndef NDEBUG

lib/SILOptimizer/Transforms/ConditionForwarding.cpp

@@ -116,6 +116,7 @@ class ConditionForwarding : public SILFunctionTransform {
       }
     }
     if (Changed) {
+      updateBorrowedFrom(getPassManager(), F);
       invalidateAnalysis(SILAnalysis::InvalidationKind::BranchesAndInstructions);
     }
   }

lib/SILOptimizer/Transforms/PerformanceInliner.cpp

@@ -21,6 +21,7 @@
 #include "swift/SILOptimizer/Utils/CFGOptUtils.h"
 #include "swift/SILOptimizer/Utils/Devirtualize.h"
 #include "swift/SILOptimizer/Utils/Generics.h"
+#include "swift/SILOptimizer/Utils/OwnershipOptUtils.h"
 #include "swift/SILOptimizer/Utils/PerformanceInlinerUtils.h"
 #include "swift/SILOptimizer/Utils/SILOptFunctionBuilder.h"
 #include "swift/SILOptimizer/Utils/StackNesting.h"
@@ -1206,6 +1207,7 @@ bool SILPerformanceInliner::inlineCallsIntoFunction(SILFunction *Caller) {
   if (invalidatedStackNesting) {
     StackNesting::fixNesting(Caller);
   }
+  updateBorrowedFrom(pm, Caller);
 
   // If we were asked to verify our caller after inlining all callees we could
   // find into it, do so now. This makes it easier to catch verification bugs in

lib/SILOptimizer/Transforms/SimplifyCFG.cpp

@@ -180,7 +180,7 @@ bool SimplifyCFG::threadEdge(const ThreadInfo &ti) {
                           << " to bb" << ti.Dest->getDebugID() << '\n');
   auto *SrcTerm = cast<BranchInst>(ti.Src->getTerminator());
 
-  BasicBlockCloner Cloner(SrcTerm->getDestBB());
+  BasicBlockCloner Cloner(SrcTerm->getDestBB(), PM);
   if (!Cloner.canCloneBlock())
     return false;
 
@@ -571,7 +571,7 @@ bool SimplifyCFG::dominatorBasedSimplify(DominanceAnalysis *DA) {
     // Do dominator based simplification of terminator condition. This does not
     // and MUST NOT change the CFG without updating the dominator tree to
     // reflect such change.
-    if (tryCheckedCastBrJumpThreading(&Fn, DT, deBlocks, BlocksForWorklist,
+    if (tryCheckedCastBrJumpThreading(&Fn, PM, DT, deBlocks, BlocksForWorklist,
                                       EnableOSSACheckedCastBrJumpThreading)) {
       for (auto BB: BlocksForWorklist)
         addToWorklist(BB);
@@ -1023,7 +1023,7 @@ bool SimplifyCFG::tryJumpThreading(BranchInst *BI) {
   // If it looks potentially interesting, decide whether we *can* do the
   // operation and whether the block is small enough to be worth duplicating.
   int copyCosts = 0;
-  BasicBlockCloner Cloner(DestBB);
+  BasicBlockCloner Cloner(DestBB, PM);
   for (auto &inst : *DestBB) {
     copyCosts += getThreadingCost(&inst);
     if (ThreadingBudget <= copyCosts)
@@ -2985,7 +2985,7 @@ bool SimplifyCFG::tailDuplicateObjCMethodCallSuccessorBlocks() {
     // Okay, it looks like we want to do this and we can.  Duplicate the
     // destination block into this one, rewriting uses of the BBArgs to use the
     // branch arguments as we go.
-    BasicBlockCloner Cloner(DestBB);
+    BasicBlockCloner Cloner(DestBB, PM);
     if (!Cloner.canCloneBlock())
       continue;
 

lib/SILOptimizer/Utils/BasicBlockOptUtils.cpp

@@ -192,6 +192,7 @@ void BasicBlockCloner::updateSSAAfterCloning() {
       ssaUpdater.rewriteUse(*use);
     }
   }
+  updateBorrowedFromPhis(pm, updateSSAPhis);
 }
 
 void BasicBlockCloner::sinkAddressProjections() {

lib/SILOptimizer/Utils/CheckedCastBrJumpThreading.cpp

@@ -50,6 +50,8 @@ class CheckedCastBrJumpThreading {
   // need to be recomputed each time tryCheckedCastBrJumpThreading is called.
   DeadEndBlocks *deBlocks;
 
+  SILPassManager *pm;
+
   // Enable non-trivial terminator rewriting in OSSA.
   bool EnableOSSARewriteTerminator;
 
@@ -141,10 +143,10 @@ class CheckedCastBrJumpThreading {
 
 public:
   CheckedCastBrJumpThreading(
-      SILFunction *Fn, DominanceInfo *DT, DeadEndBlocks *deBlocks,
+      SILFunction *Fn, SILPassManager *pm, DominanceInfo *DT, DeadEndBlocks *deBlocks,
       SmallVectorImpl<SILBasicBlock *> &BlocksForWorklist,
       bool EnableOSSARewriteTerminator)
-      : Fn(Fn), DT(DT), deBlocks(deBlocks),
+      : Fn(Fn), DT(DT), deBlocks(deBlocks), pm(pm),
         EnableOSSARewriteTerminator(EnableOSSARewriteTerminator),
         rauwContext(callbacks, *deBlocks),
         BlocksForWorklist(BlocksForWorklist), BlocksToEdit(Fn),
@@ -772,7 +774,7 @@ void CheckedCastBrJumpThreading::optimizeFunction() {
     if (edit->SuccessArg->isErased())
       continue;
 
-    BasicBlockCloner Cloner(edit->CCBBlock, deBlocks);
+    BasicBlockCloner Cloner(edit->CCBBlock, pm, deBlocks);
     if (!Cloner.canCloneBlock())
       continue;
 
@@ -800,7 +802,7 @@ void CheckedCastBrJumpThreading::optimizeFunction() {
 namespace swift {
 
 bool tryCheckedCastBrJumpThreading(
-    SILFunction *Fn, DominanceInfo *DT, DeadEndBlocks *deBlocks,
+    SILFunction *Fn, SILPassManager *pm, DominanceInfo *DT, DeadEndBlocks *deBlocks,
     SmallVectorImpl<SILBasicBlock *> &BlocksForWorklist,
     bool EnableOSSARewriteTerminator) {
 
@@ -809,7 +811,7 @@ bool tryCheckedCastBrJumpThreading(
     return false;
   }
 
-  CheckedCastBrJumpThreading CCBJumpThreading(Fn, DT, deBlocks,
+  CheckedCastBrJumpThreading CCBJumpThreading(Fn, pm, DT, deBlocks,
                                               BlocksForWorklist,
                                               EnableOSSARewriteTerminator);
   CCBJumpThreading.optimizeFunction();