[NFC] OSSACanonicalizeGuaranteed: Renamed.

Author: nate-chandler

include/swift/SILOptimizer/Utils/CanonicalizeBorrowScope.h renamed to include/swift/SILOptimizer/Utils/OSSACanonicalizeGuaranteed.h

@@ -1,4 +1,4 @@
-//===--- CanonicalizeBorrowScope.h - Canonicalize OSSA borrows --*- C++ -*-===//
+//===- OSSACanonicalizeGuaranteed.h - Canonicalize OSSA borrows -*- C++ -*-===//
 //
 // This source file is part of the Swift.org open source project
 //
@@ -40,10 +40,10 @@ namespace swift {
 class BasicCalleeAnalysis;
 
 //===----------------------------------------------------------------------===//
-//                       MARK: CanonicalizeBorrowScope
+//                       MARK: OSSACanonicalizeGuaranteed
 //===----------------------------------------------------------------------===//
 
-class CanonicalizeBorrowScope {
+class OSSACanonicalizeGuaranteed {
 public:
   /// Return true if \p inst is an instructions that forwards ownership is its
   /// first operand and can be trivially duplicated, sunk to its uses, hoisted
@@ -88,7 +88,7 @@ class CanonicalizeBorrowScope {
   llvm::SmallDenseMap<SILBasicBlock *, CopyValueInst *, 4> persistentCopies;
 
 public:
-  CanonicalizeBorrowScope(SILFunction *function, InstructionDeleter &deleter)
+  OSSACanonicalizeGuaranteed(SILFunction *function, InstructionDeleter &deleter)
       : function(function), deleter(deleter) {}
 
   BorrowedValue getBorrowedValue() const { return borrowedValue; }

include/swift/SILOptimizer/Utils/OSSACanonicalizeOwned.h

@@ -210,7 +210,7 @@ class OSSACanonicalizeOwned final {
   /// If the source of a copy is guaranteed, then the copy itself is the root of
   /// an owned extended lifetime. Note that it will also be part of a borrowed
   /// extended lifetime, which will be canonicalized separately by
-  /// CanonicalizeBorrowScope.
+  /// OSSACanonicalizeGuaranteed.
   ///
   /// This use-def walk must be consistent with the def-use walks performed
   /// within the canonicalizeValueLifetime() and canonicalizeBorrowScopes()

include/swift/SILOptimizer/Utils/OwnershipOptUtils.h

@@ -61,7 +61,7 @@ void extendOwnedLifetime(SILValue ownedValue,
 ///
 /// Precondition: guaranteedBoundary is a superset of beginBorrow's current
 /// scope (therefore, none of the safety checks done during
-/// CanonicalizeBorrowScope are needed here).
+/// OSSACanonicalizeGuaranteed are needed here).
 void extendLocalBorrow(BeginBorrowInst *beginBorrow,
                        PrunedLivenessBoundary &guaranteedBoundary,
                        InstructionDeleter &deleter);

lib/SILOptimizer/SILCombiner/SILCombine.cpp

@@ -33,10 +33,10 @@
 #include "swift/SILOptimizer/Analysis/SimplifyInstruction.h"
 #include "swift/SILOptimizer/PassManager/PassManager.h"
 #include "swift/SILOptimizer/PassManager/Transforms.h"
-#include "swift/SILOptimizer/Utils/CanonicalizeBorrowScope.h"
 #include "swift/SILOptimizer/Utils/CanonicalizeInstruction.h"
 #include "swift/SILOptimizer/Utils/DebugOptUtils.h"
 #include "swift/SILOptimizer/Utils/InstOptUtils.h"
+#include "swift/SILOptimizer/Utils/OSSACanonicalizeGuaranteed.h"
 #include "swift/SILOptimizer/Utils/OSSACanonicalizeOwned.h"
 #include "swift/SILOptimizer/Utils/SILOptFunctionBuilder.h"
 #include "swift/SILOptimizer/Utils/StackNesting.h"
@@ -325,8 +325,9 @@ void SILCombiner::canonicalizeOSSALifetimes(SILInstruction *currentInst) {
     // fast convergence, rewriting borrow scopes should not be combined with
     // other unrelated transformations.
     if (auto *copyDef = dyn_cast<CopyValueInst>(def)) {
-      if (SILValue borrowDef = CanonicalizeBorrowScope::getCanonicalBorrowedDef(
-              copyDef->getOperand())) {
+      if (SILValue borrowDef =
+              OSSACanonicalizeGuaranteed::getCanonicalBorrowedDef(
+                  copyDef->getOperand())) {
         if (isa<SILFunctionArgument>(borrowDef)) {
           def = borrowDef;
         }
@@ -362,8 +363,8 @@ void SILCombiner::canonicalizeOSSALifetimes(SILInstruction *currentInst) {
       DontPruneDebugInsts,
       MaximizeLifetime_t(!parentTransform->getFunction()->shouldOptimize()),
       parentTransform->getFunction(), NLABA, DEBA, domTree, CA, deleter);
-  CanonicalizeBorrowScope borrowCanonicalizer(parentTransform->getFunction(),
-                                              deleter);
+  OSSACanonicalizeGuaranteed borrowCanonicalizer(parentTransform->getFunction(),
+                                                 deleter);
 
   while (!defsToCanonicalize.empty()) {
     SILValue def = defsToCanonicalize.pop_back_val();

lib/SILOptimizer/Transforms/CopyPropagation.cpp

@@ -21,7 +21,7 @@
 /// an OSSA reference after propagating that reference through all copies. For
 /// owned references, this is a simple process of canonicalization that can be
 /// invoked separately via the OSSACanonicalizeOwned utility. The
-/// CanonicalizeBorrowScope utility handles borrowed references, but this is
+/// OSSACanonicalizeGuaranteed utility handles borrowed references, but this is
 /// much more involved. It requires coordination to cleanup owned lifetimes
 /// outside the borrow scope after canonicalizing the scope itself.
 ///
@@ -59,8 +59,8 @@
 #include "swift/SILOptimizer/Analysis/DeadEndBlocksAnalysis.h"
 #include "swift/SILOptimizer/PassManager/Passes.h"
 #include "swift/SILOptimizer/PassManager/Transforms.h"
-#include "swift/SILOptimizer/Utils/CanonicalizeBorrowScope.h"
 #include "swift/SILOptimizer/Utils/InstOptUtils.h"
+#include "swift/SILOptimizer/Utils/OSSACanonicalizeGuaranteed.h"
 #include "swift/SILOptimizer/Utils/OSSACanonicalizeOwned.h"
 #include "swift/SILOptimizer/Utils/OwnershipOptUtils.h"
 #include "llvm/ADT/SetVector.h"
@@ -108,7 +108,7 @@ struct CanonicalDefWorklist {
       // extended lifetime.
       if (auto *copy = dyn_cast<CopyValueInst>(def)) {
         if (SILValue borrowDef =
-                CanonicalizeBorrowScope::getCanonicalBorrowedDef(
+                OSSACanonicalizeGuaranteed::getCanonicalBorrowedDef(
                     copy->getOperand())) {
           if (canonicalizeBorrows || isa<SILFunctionArgument>(borrowDef)) {
             borrowedValues.insert(borrowDef);
@@ -123,7 +123,7 @@ struct CanonicalDefWorklist {
       // Look through hoistable owned forwarding instructions on the
       // use-def chain.
       if (SILInstruction *defInst = def->getDefiningInstruction()) {
-        if (CanonicalizeBorrowScope::isRewritableOSSAForward(defInst)) {
+        if (OSSACanonicalizeGuaranteed::isRewritableOSSAForward(defInst)) {
           SILValue forwardedDef = defInst->getOperand(0);
           if (forwardedDef->getOwnershipKind() == OwnershipKind::Owned) {
             def = forwardedDef;
@@ -151,7 +151,7 @@ struct CanonicalDefWorklist {
         useWorklist.append(copy->getUses().begin(), copy->getUses().end());
         continue;
       }
-      if (!CanonicalizeBorrowScope::isRewritableOSSAForward(user))
+      if (!OSSACanonicalizeGuaranteed::isRewritableOSSAForward(user))
         continue;
 
       if (!ownedForwards.insert(user))
@@ -210,7 +210,7 @@ struct CanonicalDefWorklist {
 /// This allows the ownership of '%src' to be forwarded to its member.
 ///
 /// This utility runs during copy propagation as a prerequisite to
-/// CanonicalizeBorrowScopes.
+/// OSSACanonicalizeGuaranteeds.
 ///
 /// TODO: generalize this to handle multiple nondebug uses of the
 /// struct_extract.
@@ -562,7 +562,7 @@ void CopyPropagation::propagateCopies(
   }
   // borrowCanonicalizer performs all modifications through deleter's
   // callbacks, so we don't need to explicitly check for changes.
-  CanonicalizeBorrowScope borrowCanonicalizer(f, deleter);
+  OSSACanonicalizeGuaranteed borrowCanonicalizer(f, deleter);
   // The utilities in this loop cannot delete borrows before they are popped
   // from the worklist.
   while (true) {
@@ -581,7 +581,7 @@ void CopyPropagation::propagateCopies(
       // Canonicalize a forwarded owned value before sinking the forwarding
       // instruction, and sink the instruction before canonicalizing the owned
       // value being forwarded. Process 'ownedForwards' in reverse since
-      // they may be chained, and CanonicalizeBorrowScopes pushes them
+      // they may be chained, and OSSACanonicalizeGuaranteeds pushes them
       // top-down.
       for (auto result : ownedForward->getResults()) {
         if (!continueWithNextSubpassRun(result))
@@ -599,7 +599,7 @@ void CopyPropagation::propagateCopies(
                 OSSACanonicalizeOwned::getCanonicalCopiedDef(
                     ownedForward->getOperand(0))
                     ->getDefiningInstruction()) {
-          if (CanonicalizeBorrowScope::isRewritableOSSAForward(forwardDef)) {
+          if (OSSACanonicalizeGuaranteed::isRewritableOSSAForward(forwardDef)) {
             defWorklist.ownedForwards.insert(forwardDef);
           }
         }

lib/SILOptimizer/Transforms/SILMem2Reg.cpp

@@ -40,8 +40,8 @@
 #include "swift/SILOptimizer/PassManager/Passes.h"
 #include "swift/SILOptimizer/PassManager/Transforms.h"
 #include "swift/SILOptimizer/Utils/CFGOptUtils.h"
-#include "swift/SILOptimizer/Utils/CanonicalizeBorrowScope.h"
 #include "swift/SILOptimizer/Utils/InstOptUtils.h"
+#include "swift/SILOptimizer/Utils/OSSACanonicalizeGuaranteed.h"
 #include "swift/SILOptimizer/Utils/OSSACanonicalizeOwned.h"
 #include "swift/SILOptimizer/Utils/OwnershipOptUtils.h"
 #include "swift/SILOptimizer/Utils/ScopeOptUtils.h"
@@ -2158,19 +2158,20 @@ void MemoryToRegisters::canonicalizeValueLifetimes(
       continue;
     auto root = OSSACanonicalizeOwned::getCanonicalCopiedDef(value);
     if (auto *copy = dyn_cast<CopyValueInst>(root)) {
-      if (SILValue borrowDef = CanonicalizeBorrowScope::getCanonicalBorrowedDef(
-              copy->getOperand())) {
+      if (SILValue borrowDef =
+              OSSACanonicalizeGuaranteed::getCanonicalBorrowedDef(
+                  copy->getOperand())) {
         guaranteed.push_back(copy);
         continue;
       }
     }
     canonicalizer.canonicalizeValueLifetime(root);
   }
-  CanonicalizeBorrowScope borrowCanonicalizer(&f, deleter);
+  OSSACanonicalizeGuaranteed borrowCanonicalizer(&f, deleter);
   for (auto value : guaranteed) {
     if (isa<SILUndef>(value) || value->isMarkedAsDeleted())
       continue;
-    auto borrowee = CanonicalizeBorrowScope::getCanonicalBorrowedDef(value);
+    auto borrowee = OSSACanonicalizeGuaranteed::getCanonicalBorrowedDef(value);
     if (!borrowee)
       continue;
     BorrowedValue borrow(borrowee);

lib/SILOptimizer/Utils/CMakeLists.txt

@@ -3,7 +3,7 @@ target_sources(swiftSILOptimizer PRIVATE
   CFGOptUtils.cpp
   CanonicalizeInstruction.cpp
   OSSACanonicalizeOwned.cpp
-  CanonicalizeBorrowScope.cpp
+  OSSACanonicalizeGuaranteed.cpp
   CastOptimizer.cpp
   CheckedCastBrJumpThreading.cpp
   CompileTimeInterpolationUtils.cpp

lib/SILOptimizer/Utils/LexicalDestroyFolding.cpp

@@ -89,8 +89,8 @@
 #include "swift/SIL/Test.h"
 #include "swift/SILOptimizer/Analysis/Reachability.h"
 #include "swift/SILOptimizer/PassManager/Transforms.h"
-#include "swift/SILOptimizer/Utils/CanonicalizeBorrowScope.h"
 #include "swift/SILOptimizer/Utils/InstructionDeleter.h"
+#include "swift/SILOptimizer/Utils/OSSACanonicalizeGuaranteed.h"
 #include "swift/SILOptimizer/Utils/OSSACanonicalizeOwned.h"
 #include "swift/SILOptimizer/Utils/SILSSAUpdater.h"
 #include "llvm/ADT/SmallVector.h"