Optimizer: rename BorrowArgumentsUpdater -> GuaranteedPhiUpdater

eeckstein · eeckstein · commit 51e3e5ed80e6 · 2024-11-12T09:26:59.000+01:00
NFC
diff --git a/SwiftCompilerSources/Sources/Optimizer/PassManager/PassRegistration.swift b/SwiftCompilerSources/Sources/Optimizer/PassManager/PassRegistration.swift
@@ -136,5 +136,5 @@ private func registerSwiftAnalyses() {
 
 private func registerUtilities() {
   registerVerifier()
-  registerBorrowArgumentsUpdater()
+  registerGuaranteedPhiUpdater()
 }
diff --git a/SwiftCompilerSources/Sources/Optimizer/Utilities/CMakeLists.txt b/SwiftCompilerSources/Sources/Optimizer/Utilities/CMakeLists.txt
@@ -9,7 +9,7 @@
 swift_compiler_sources(Optimizer
   AccessUtilsTest.swift
   AddressUtils.swift
-  BorrowArgumentsUpdater.swift
+  GuaranteedPhiUpdater.swift
   BorrowUtils.swift
   SpecializationCloner.swift
   DiagnosticEngine.swift
diff --git a/SwiftCompilerSources/Sources/Optimizer/Utilities/GuaranteedPhiUpdater.swift b/SwiftCompilerSources/Sources/Optimizer/Utilities/GuaranteedPhiUpdater.swift
@@ -1,4 +1,4 @@
-//===--- BorrowArgumentsUpdater.swift -------------------------------------===//
+//===--- GuaranteedPhiUpdater.swift ---------------------------------------===//
 //
 // This source file is part of the Swift.org open source project
 //
@@ -14,13 +14,13 @@ import SIL
 import OptimizerBridging
 
 /// Updates the reborrow flags and the borrowed-from instructions for all guaranteed phis in `function`.
-func updateBorrowArguments(in function: Function, _ context: some MutatingContext) {
+func updateGuaranteedPhis(in function: Function, _ context: some MutatingContext) {
   updateReborrowFlags(in: function, context)
   updateBorrowedFrom(in: function, context)
 }
 
 /// Updates the reborrow flags and the borrowed-from instructions for all `phis`.
-func updateBorrowArguments(for phis: some Sequence<Phi>, _ context: some MutatingContext) {
+func updateGuaranteedPhis(phis: some Sequence<Phi>, _ context: some MutatingContext) {
   updateReborrowFlags(for: phis, context)
   updateBorrowedFrom(for: phis, context)
 }
@@ -151,12 +151,12 @@ private func addEnclosingValues(
   return true
 }
 
-func registerBorrowArgumentsUpdater() {
-  BridgedUtilities.registerBorrowArgumentsUpdater(
+func registerGuaranteedPhiUpdater() {
+  BridgedUtilities.registerGuaranteedPhiUpdater(
     { (bridgedCtxt: BridgedPassContext, bridgedFunction: BridgedFunction) in
       let context = FunctionPassContext(_bridged: bridgedCtxt)
       let function = bridgedFunction.function;
-      updateBorrowArguments(in: function, context)
+      updateGuaranteedPhis(in: function, context)
     },
     { (bridgedCtxt: BridgedPassContext, bridgedPhiArray: BridgedArrayRef) in
       let context = FunctionPassContext(_bridged: bridgedCtxt)
@@ -170,7 +170,7 @@ func registerBorrowArgumentsUpdater() {
           }
         }
       }
-      updateBorrowArguments(for: guaranteedPhis, context)
+      updateGuaranteedPhis(phis: guaranteedPhis, context)
     }
   )
 }
diff --git a/include/swift/SILOptimizer/OptimizerBridging.h b/include/swift/SILOptimizer/OptimizerBridging.h
@@ -134,8 +134,8 @@ struct BridgedUtilities {
   typedef void (* _Nonnull UpdatePhisFn)(BridgedPassContext, BridgedArrayRef);
 
   static void registerVerifier(VerifyFunctionFn verifyFunctionFn);
-  static void registerBorrowArgumentsUpdater(UpdateFunctionFn updateBorrowedFromFn,
-                                             UpdatePhisFn updateBorrowedFromPhisFn);
+  static void registerGuaranteedPhiUpdater(UpdateFunctionFn updateBorrowedFromFn,
+                                           UpdatePhisFn updateBorrowedFromPhisFn);
 };
 
 struct BridgedBasicBlockSet {
diff --git a/include/swift/SILOptimizer/Utils/OwnershipOptUtils.h b/include/swift/SILOptimizer/Utils/OwnershipOptUtils.h
@@ -359,10 +359,10 @@ bool extendStoreBorrow(StoreBorrowInst *sbi,
 
 /// Updates the reborrow flags and the borrowed-from instructions for all
 /// guaranteed phis in function `f`.
-void updateAllBorrowArguments(SILPassManager *pm, SILFunction *f);
+void updateAllGuaranteedPhis(SILPassManager *pm, SILFunction *f);
 
 /// Updates the reborrow flags and the borrowed-from instructions for all `phis`.
-void updateBorrowArguments(SILPassManager *pm, ArrayRef<SILPhiArgument *> phis);
+void updateGuaranteedPhis(SILPassManager *pm, ArrayRef<SILPhiArgument *> phis);
 
 } // namespace swift
 
diff --git a/lib/SILOptimizer/LoopTransforms/ArrayPropertyOpt.cpp b/lib/SILOptimizer/LoopTransforms/ArrayPropertyOpt.cpp
@@ -837,7 +837,7 @@ class SwiftArrayPropertyOptPass : public SILFunctionTransform {
       if (getFunction()->getModule().getOptions().VerifyAll)
         getFunction()->verifyCriticalEdges();
 
-      updateAllBorrowArguments(getPassManager(), Fn);
+      updateAllGuaranteedPhis(getPassManager(), Fn);
 
       // We preserve the dominator tree. Let's invalidate everything
       // else.
diff --git a/lib/SILOptimizer/LoopTransforms/LoopRotate.cpp b/lib/SILOptimizer/LoopTransforms/LoopRotate.cpp
@@ -506,7 +506,7 @@ class LoopRotation : public SILFunctionTransform {
     }
 
     if (changed) {
-      updateAllBorrowArguments(PM, f);
+      updateAllGuaranteedPhis(PM, f);
       // We preserve loop info and the dominator tree.
       domAnalysis->lockInvalidation();
       loopAnalysis->lockInvalidation();
diff --git a/lib/SILOptimizer/Mandatory/ClosureLifetimeFixup.cpp b/lib/SILOptimizer/Mandatory/ClosureLifetimeFixup.cpp
@@ -1529,7 +1529,7 @@ class ClosureLifetimeFixup : public SILFunctionTransform {
     if (fixupClosureLifetimes(*getFunction(), dominanceAnalysis,
                               deadEndBlocksAnalysis, checkStackNesting,
                               modifiedCFG)) {
-      updateAllBorrowArguments(getPassManager(), getFunction());
+      updateAllGuaranteedPhis(getPassManager(), getFunction());
       if (checkStackNesting){
         modifiedCFG |=
           StackNesting::fixNesting(getFunction()) == StackNesting::Changes::CFG;
diff --git a/lib/SILOptimizer/SILCombiner/SILCombine.cpp b/lib/SILOptimizer/SILCombiner/SILCombine.cpp
@@ -620,7 +620,7 @@ class SILCombine : public SILFunctionTransform {
     bool Changed = Combiner.runOnFunction(*getFunction());
 
     if (Changed) {
-      updateAllBorrowArguments(getPassManager(), getFunction());
+      updateAllGuaranteedPhis(getPassManager(), getFunction());
       // Invalidate everything.
       invalidateAnalysis(SILAnalysis::InvalidationKind::FunctionBody);
     }
diff --git a/lib/SILOptimizer/SemanticARC/OwnedToGuaranteedPhiOpt.cpp b/lib/SILOptimizer/SemanticARC/OwnedToGuaranteedPhiOpt.cpp
@@ -268,7 +268,7 @@ bool swift::semanticarc::tryConvertOwnedPhisToGuaranteedPhis(Context &ctx) {
   }
 
   if (madeChange)
-    updateAllBorrowArguments(ctx.pm, &ctx.fn);
+    updateAllGuaranteedPhis(ctx.pm, &ctx.fn);
 
   return madeChange;
 }
diff --git a/lib/SILOptimizer/SemanticARC/SemanticARCOpts.cpp b/lib/SILOptimizer/SemanticARC/SemanticARCOpts.cpp
@@ -177,7 +177,7 @@ struct SemanticARCOpts : SILFunctionTransform {
     // converted to guaranteed, ignoring the phi, try convert those phis to be
     // guaranteed.
     if (tryConvertOwnedPhisToGuaranteedPhis(visitor.ctx)) {
-      updateAllBorrowArguments(getPassManager(), &f);
+      updateAllGuaranteedPhis(getPassManager(), &f);
 
       // We return here early to save a little compile time so we do not
       // invalidate analyses redundantly.
@@ -187,7 +187,7 @@ struct SemanticARCOpts : SILFunctionTransform {
 
     // Otherwise, we only deleted instructions and did not touch phis.
     if (didEliminateARCInsts) {
-      updateAllBorrowArguments(getPassManager(), &f);
+      updateAllGuaranteedPhis(getPassManager(), &f);
       invalidateAnalysis(SILAnalysis::InvalidationKind::Instructions);
     }
   }
diff --git a/lib/SILOptimizer/Transforms/ConditionForwarding.cpp b/lib/SILOptimizer/Transforms/ConditionForwarding.cpp
@@ -117,7 +117,7 @@ class ConditionForwarding : public SILFunctionTransform {
       }
     }
     if (Changed) {
-      updateAllBorrowArguments(getPassManager(), F);
+      updateAllGuaranteedPhis(getPassManager(), F);
       invalidateAnalysis(SILAnalysis::InvalidationKind::BranchesAndInstructions);
     }
   }
diff --git a/lib/SILOptimizer/Transforms/CopyPropagation.cpp b/lib/SILOptimizer/Transforms/CopyPropagation.cpp
@@ -635,7 +635,7 @@ void CopyPropagation::run() {
 
   // Invalidate analyses.
   if (changed || deleter.hadCallbackInvocation()) {
-    updateAllBorrowArguments(getPassManager(), getFunction());
+    updateAllGuaranteedPhis(getPassManager(), getFunction());
     // Preserves NonLocalAccessBlockAnalysis.
     accessBlockAnalysis->lockInvalidation();
     invalidateAnalysis(SILAnalysis::InvalidationKind::Instructions);
diff --git a/lib/SILOptimizer/Transforms/PerformanceInliner.cpp b/lib/SILOptimizer/Transforms/PerformanceInliner.cpp
@@ -1286,7 +1286,7 @@ bool SILPerformanceInliner::inlineCallsIntoFunction(SILFunction *Caller) {
   if (invalidatedStackNesting) {
     StackNesting::fixNesting(Caller);
   }
-  updateAllBorrowArguments(pm, Caller);
+  updateAllGuaranteedPhis(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
diff --git a/lib/SILOptimizer/Transforms/SILMem2Reg.cpp b/lib/SILOptimizer/Transforms/SILMem2Reg.cpp
@@ -2297,7 +2297,7 @@ class SILMem2Reg : public SILFunctionTransform {
                                         accessBlockAnalysis, calleeAnalysis)
                           .run();
     if (madeChange) {
-      updateAllBorrowArguments(getPassManager(), f);
+      updateAllGuaranteedPhis(getPassManager(), f);
       invalidateAnalysis(SILAnalysis::InvalidationKind::Instructions);
     }
   }
diff --git a/lib/SILOptimizer/Transforms/SimplifyCFG.cpp b/lib/SILOptimizer/Transforms/SimplifyCFG.cpp
@@ -2189,7 +2189,7 @@ bool SimplifyCFG::simplifySwitchEnumBlock(SwitchEnumInst *SEI) {
     }
     Builder.createBranch(loc, LiveBlock, PayLoad);
     SEI->eraseFromParent();
-    updateBorrowArguments(PM, { cast<SILPhiArgument>(LiveBlock->getArgument(0)) });
+    updateGuaranteedPhis(PM, { cast<SILPhiArgument>(LiveBlock->getArgument(0)) });
   } else {
     if (SEI->getOperand()->getOwnershipKind() == OwnershipKind::Owned) {
       Builder.createDestroyValue(loc, SEI->getOperand());
@@ -3784,7 +3784,7 @@ bool SimplifyCFG::simplifyArgument(SILBasicBlock *BB, unsigned i) {
 
   proj->eraseFromParent();
 
-  updateBorrowArguments(PM, { NewArg });
+  updateGuaranteedPhis(PM, { NewArg });
 
   return true;
 }
diff --git a/lib/SILOptimizer/Utils/BasicBlockOptUtils.cpp b/lib/SILOptimizer/Utils/BasicBlockOptUtils.cpp
@@ -169,7 +169,7 @@ void BasicBlockCloner::updateSSAAfterCloning() {
       }
     }
   }
-  updateBorrowArguments(pm, updateSSAPhis);
+  updateGuaranteedPhis(pm, updateSSAPhis);
 }
 
 void BasicBlockCloner::sinkAddressProjections() {
diff --git a/lib/SILOptimizer/Utils/InstOptUtils.cpp b/lib/SILOptimizer/Utils/InstOptUtils.cpp
@@ -687,7 +687,7 @@ swift::castValueToABICompatibleType(SILBuilder *builder, SILPassManager *pm,
     builder->createBranch(loc, contBB, {noneValue});
     builder->setInsertionPoint(contBB->begin());
 
-    updateBorrowArguments(pm, { phi });
+    updateGuaranteedPhis(pm, { phi });
 
     return {lookThroughBorrowedFromUser(phi), true};
   }
diff --git a/lib/SILOptimizer/Utils/OwnershipOptUtils.cpp b/lib/SILOptimizer/Utils/OwnershipOptUtils.cpp
@@ -1913,27 +1913,27 @@ bool swift::extendStoreBorrow(StoreBorrowInst *sbi,
 //                            Swift Bridging
 //===----------------------------------------------------------------------===//
 
-static BridgedUtilities::UpdateFunctionFn updateAllBorrowArgumentsFunction;
-static BridgedUtilities::UpdatePhisFn updateBorrowArgumentsFunction;
+static BridgedUtilities::UpdateFunctionFn updateAllGuaranteedPhisFunction;
+static BridgedUtilities::UpdatePhisFn updateGuaranteedPhisFunction;
 
-void BridgedUtilities::registerBorrowArgumentsUpdater(UpdateFunctionFn updateAllBorrowArgumentsFn,
-                                                      UpdatePhisFn updateBorrowArgumentsFn) {
-  updateAllBorrowArgumentsFunction = updateAllBorrowArgumentsFn;
-  updateBorrowArgumentsFunction = updateBorrowArgumentsFn;
+void BridgedUtilities::registerGuaranteedPhiUpdater(UpdateFunctionFn updateAllGuaranteedPhisFn,
+                                                    UpdatePhisFn updateGuaranteedPhisFn) {
+  updateAllGuaranteedPhisFunction = updateAllGuaranteedPhisFn;
+  updateGuaranteedPhisFunction = updateGuaranteedPhisFn;
 }
 
-void swift::updateAllBorrowArguments(SILPassManager *pm, SILFunction *f) {
-  if (updateAllBorrowArgumentsFunction)
-    updateAllBorrowArgumentsFunction({pm->getSwiftPassInvocation()}, {f});
+void swift::updateAllGuaranteedPhis(SILPassManager *pm, SILFunction *f) {
+  if (updateAllGuaranteedPhisFunction)
+    updateAllGuaranteedPhisFunction({pm->getSwiftPassInvocation()}, {f});
 }
 
-void swift::updateBorrowArguments(SILPassManager *pm, ArrayRef<SILPhiArgument *> phis) {
-  if (!updateBorrowArgumentsFunction)
+void swift::updateGuaranteedPhis(SILPassManager *pm, ArrayRef<SILPhiArgument *> phis) {
+  if (!updateGuaranteedPhisFunction)
     return;
 
   llvm::SmallVector<BridgedValue, 8> bridgedPhis;
   for (SILPhiArgument *phi : phis) {
     bridgedPhis.push_back({phi});
   }
-  updateBorrowArgumentsFunction({pm->getSwiftPassInvocation()}, ArrayRef(bridgedPhis));
+  updateGuaranteedPhisFunction({pm->getSwiftPassInvocation()}, ArrayRef(bridgedPhis));
 }

Original file line number	Diff line number	Diff line change
`@@ -136,5 +136,5 @@ private func registerSwiftAnalyses() {`
`136`	`136`
`137`	`137`	`private func registerUtilities() {`
`138`	`138`	`registerVerifier()`
`139`		`- registerBorrowArgumentsUpdater()`
	`139`	`+ registerGuaranteedPhiUpdater()`
`140`	`140`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-//===--- BorrowArgumentsUpdater.swift -------------------------------------===//`
	`1`	`+//===--- GuaranteedPhiUpdater.swift ---------------------------------------===//`
`2`	`2`	`//`
`3`	`3`	`// This source file is part of the Swift.org open source project`
`4`	`4`	`//`
`@@ -14,13 +14,13 @@ import SIL`
`14`	`14`	`import OptimizerBridging`
`15`	`15`
`16`	`16`	/// Updates the reborrow flags and the borrowed-from instructions for all guaranteed phis in `function`.
`17`		`-func updateBorrowArguments(in function: Function, _ context: some MutatingContext) {`
	`17`	`+func updateGuaranteedPhis(in function: Function, _ context: some MutatingContext) {`
`18`	`18`	`updateReborrowFlags(in: function, context)`
`19`	`19`	`updateBorrowedFrom(in: function, context)`
`20`	`20`	`}`
`21`	`21`
`22`	`22`	/// Updates the reborrow flags and the borrowed-from instructions for all `phis`.
`23`		`-func updateBorrowArguments(for phis: some Sequence<Phi>, _ context: some MutatingContext) {`
	`23`	`+func updateGuaranteedPhis(phis: some Sequence<Phi>, _ context: some MutatingContext) {`
`24`	`24`	`updateReborrowFlags(for: phis, context)`
`25`	`25`	`updateBorrowedFrom(for: phis, context)`
`26`	`26`	`}`
`@@ -151,12 +151,12 @@ private func addEnclosingValues(`
`151`	`151`	`return true`
`152`	`152`	`}`
`153`	`153`
`154`		`-func registerBorrowArgumentsUpdater() {`
`155`		`- BridgedUtilities.registerBorrowArgumentsUpdater(`
	`154`	`+func registerGuaranteedPhiUpdater() {`
	`155`	`+ BridgedUtilities.registerGuaranteedPhiUpdater(`
`156`	`156`	`{ (bridgedCtxt: BridgedPassContext, bridgedFunction: BridgedFunction) in`
`157`	`157`	`let context = FunctionPassContext(_bridged: bridgedCtxt)`
`158`	`158`	`let function = bridgedFunction.function;`
`159`		`- updateBorrowArguments(in: function, context)`
	`159`	`+ updateGuaranteedPhis(in: function, context)`
`160`	`160`	`},`
`161`	`161`	`{ (bridgedCtxt: BridgedPassContext, bridgedPhiArray: BridgedArrayRef) in`
`162`	`162`	`let context = FunctionPassContext(_bridged: bridgedCtxt)`
`@@ -170,7 +170,7 @@ func registerBorrowArgumentsUpdater() {`
`170`	`170`	`}`
`171`	`171`	`}`
`172`	`172`	`}`
`173`		`- updateBorrowArguments(for: guaranteedPhis, context)`
	`173`	`+ updateGuaranteedPhis(phis: guaranteedPhis, context)`
`174`	`174`	`}`
`175`	`175`	`)`
`176`	`176`	`}`
Original file line number	Diff line number	Diff line change
`@@ -506,7 +506,7 @@ class LoopRotation : public SILFunctionTransform {`
`506`	`506`	`}`
`507`	`507`
`508`	`508`	`if (changed) {`
`509`		`- updateAllBorrowArguments(PM, f);`
	`509`	`+ updateAllGuaranteedPhis(PM, f);`
`510`	`510`	`// We preserve loop info and the dominator tree.`
`511`	`511`	`domAnalysis->lockInvalidation();`
`512`	`512`	`loopAnalysis->lockInvalidation();`
Original file line number	Diff line number	Diff line change
`@@ -620,7 +620,7 @@ class SILCombine : public SILFunctionTransform {`
`620`	`620`	`bool Changed = Combiner.runOnFunction(*getFunction());`
`621`	`621`
`622`	`622`	`if (Changed) {`
`623`		`- updateAllBorrowArguments(getPassManager(), getFunction());`
	`623`	`+ updateAllGuaranteedPhis(getPassManager(), getFunction());`
`624`	`624`	`// Invalidate everything.`
`625`	`625`	`invalidateAnalysis(SILAnalysis::InvalidationKind::FunctionBody);`
`626`	`626`	`}`
Original file line number	Diff line number	Diff line change
`@@ -268,7 +268,7 @@ bool swift::semanticarc::tryConvertOwnedPhisToGuaranteedPhis(Context &ctx) {`
`268`	`268`	`}`
`269`	`269`
`270`	`270`	`if (madeChange)`
`271`		`- updateAllBorrowArguments(ctx.pm, &ctx.fn);`
	`271`	`+ updateAllGuaranteedPhis(ctx.pm, &ctx.fn);`
`272`	`272`
`273`	`273`	`return madeChange;`
`274`	`274`	`}`