[NFC] OSSACompleteLifetime: Renamed.

Author: nate-chandler

docs/SIL/Instructions.md

@@ -1032,7 +1032,7 @@ extend_lifetime %0 : $X
 ```
 
 Indicates that a value's linear lifetime extends to this point.
-Inserted by OSSALifetimeCompletion(AvailabilityBoundary) in order to
+Inserted by OSSACompleteLifetime(AvailabilityBoundary) in order to
 provide the invariant that a value is either consumed OR has an
 `extend_lifetime` user on all paths and furthermore that all
 uses are within the boundary defined by that set of instructions (the

include/swift/SIL/OSSALifetimeCompletion.h renamed to include/swift/SIL/OSSACompleteLifetime.h

@@ -38,7 +38,7 @@ class DeadEndBlocks;
 
 enum class LifetimeCompletion { NoLifetime, AlreadyComplete, WasCompleted };
 
-class OSSALifetimeCompletion {
+class OSSACompleteLifetime {
 public:
   enum HandleTrivialVariable_t { IgnoreTrivialVariable, ExtendTrivialVariable };
 
@@ -63,7 +63,7 @@ class OSSALifetimeCompletion {
   bool ForceLivenessVerification;
 
 public:
-  OSSALifetimeCompletion(
+  OSSACompleteLifetime(
       SILFunction *function, const DominanceInfo *domInfo,
       DeadEndBlocks &deadEndBlocks,
       HandleTrivialVariable_t handleTrivialVariable = IgnoreTrivialVariable,
@@ -113,8 +113,8 @@ class OSSALifetimeCompletion {
         break;
       }
       // During SILGenCleanup, extend move_value [var_decl].
-      if (handleTrivialVariable == ExtendTrivialVariable
-          && value->isFromVarDecl()) {
+      if (handleTrivialVariable == ExtendTrivialVariable &&
+          value->isFromVarDecl()) {
         break;
       }
       return LifetimeCompletion::NoLifetime;
@@ -203,13 +203,13 @@ class UnreachableLifetimeCompletion {
   bool completeLifetimes();
 };
 
-inline llvm::raw_ostream &
-operator<<(llvm::raw_ostream &OS, OSSALifetimeCompletion::Boundary boundary) {
+inline llvm::raw_ostream &operator<<(llvm::raw_ostream &OS,
+                                     OSSACompleteLifetime::Boundary boundary) {
   switch (boundary) {
-  case OSSALifetimeCompletion::Boundary::Liveness:
+  case OSSACompleteLifetime::Boundary::Liveness:
     OS << "liveness";
     break;
-  case OSSALifetimeCompletion::Boundary::Availability:
+  case OSSACompleteLifetime::Boundary::Availability:
     OS << "availability";
     break;
   }

include/swift/SILOptimizer/Utils/CanonicalizeOSSALifetime.h

@@ -470,7 +470,7 @@ class CanonicalizeOSSALifetime final {
   }
 
   bool respectsDeadEnds() const {
-    // TODO: OSSALifetimeCompletion: Once lifetimes are always complete, delete
+    // TODO: OSSACompleteLifetime: Once lifetimes are always complete, delete
     //                               this method.
     return !endingLifetimeAtExplicitEnds();
   }

lib/SIL/Utils/CMakeLists.txt

@@ -13,7 +13,7 @@ target_sources(swiftSIL PRIVATE
   MemAccessUtils.cpp
   MemoryLocations.cpp
   OptimizationRemark.cpp
-  OSSALifetimeCompletion.cpp
+  OSSACompleteLifetime.cpp
   OwnershipLiveness.cpp
   OwnershipUtils.cpp
   PrettyStackTrace.cpp

lib/SIL/Utils/OSSALifetimeCompletion.cpp renamed to lib/SIL/Utils/OSSACompleteLifetime.cpp

@@ -1,4 +1,4 @@
-//===--- OSSALifetimeCompletion.cpp ---------------------------------------===//
+//===--- OSSACompleteLifetime.cpp ---------------------------------------===//
 //
 // This source file is part of the Swift.org open source project
 //
@@ -49,7 +49,7 @@
 ///
 //===----------------------------------------------------------------------===//
 
-#include "swift/SIL/OSSALifetimeCompletion.h"
+#include "swift/SIL/OSSACompleteLifetime.h"
 #include "swift/Basic/Assertions.h"
 #include "swift/SIL/AddressWalker.h"
 #include "swift/SIL/BasicBlockUtils.h"
@@ -64,17 +64,17 @@ using namespace swift;
 // FIXME: remove this option after fixing:
 // rdar://145994924 (Mem2Reg calls lifetime completion without checking for
 // pointer escapes)
-llvm::cl::opt<bool> VerifyLifetimeCompletion(
-    "verify-lifetime-completion", llvm::cl::init(false),
-    llvm::cl::desc("."));
+llvm::cl::opt<bool> VerifyLifetimeCompletion("verify-lifetime-completion",
+                                             llvm::cl::init(false),
+                                             llvm::cl::desc("."));
 
 static SILInstruction *endOSSALifetime(SILValue value,
-                                       OSSALifetimeCompletion::LifetimeEnd end,
+                                       OSSACompleteLifetime::LifetimeEnd end,
                                        SILBuilder &builder,
                                        DeadEndBlocks &deb) {
   auto loc =
-    RegularLocation::getAutoGeneratedLocation(builder.getInsertionPointLoc());
-  if (end == OSSALifetimeCompletion::LifetimeEnd::Loop) {
+      RegularLocation::getAutoGeneratedLocation(builder.getInsertionPointLoc());
+  if (end == OSSACompleteLifetime::LifetimeEnd::Loop) {
     return builder.createExtendLifetime(loc, value);
   }
   auto isDeadEnd = IsDeadEnd_t(deb.isDeadEnd(builder.getInsertionBB()));
@@ -101,21 +101,21 @@ static bool endLifetimeAtLivenessBoundary(SILValue value,
 
   bool changed = false;
   for (SILInstruction *lastUser : boundary.lastUsers) {
-    if (liveness.isInterestingUser(lastUser)
-        != PrunedLiveness::LifetimeEndingUse) {
+    if (liveness.isInterestingUser(lastUser) !=
+        PrunedLiveness::LifetimeEndingUse) {
       changed = true;
-      SILBuilderWithScope::insertAfter(lastUser, [value,
-                                                  &deb](SILBuilder &builder) {
-        endOSSALifetime(value, OSSALifetimeCompletion::LifetimeEnd::Boundary,
-                        builder, deb);
-      });
+      SILBuilderWithScope::insertAfter(
+          lastUser, [value, &deb](SILBuilder &builder) {
+            endOSSALifetime(value, OSSACompleteLifetime::LifetimeEnd::Boundary,
+                            builder, deb);
+          });
     }
   }
   for (SILBasicBlock *edge : boundary.boundaryEdges) {
     changed = true;
     SILBuilderWithScope builder(edge->begin());
-    endOSSALifetime(value, OSSALifetimeCompletion::LifetimeEnd::Boundary,
-                    builder, deb);
+    endOSSALifetime(value, OSSACompleteLifetime::LifetimeEnd::Boundary, builder,
+                    deb);
   }
   for (SILNode *deadDef : boundary.deadDefs) {
     SILInstruction *next = nullptr;
@@ -126,8 +126,8 @@ static bool endLifetimeAtLivenessBoundary(SILValue value,
     }
     changed = true;
     SILBuilderWithScope builder(next);
-    endOSSALifetime(value, OSSALifetimeCompletion::LifetimeEnd::Boundary,
-                    builder, deb);
+    endOSSALifetime(value, OSSACompleteLifetime::LifetimeEnd::Boundary, builder,
+                    deb);
   }
   return changed;
 }
@@ -174,7 +174,7 @@ namespace {
 /// Visits the latest instructions at which `value` is available.
 ///
 /// Together with visitUsersOutsideLinearLivenessBoundary, implements
-/// OSSALifetimeCompletion::visitAvailabilityBoundary.
+/// OSSACompleteLifetime::visitAvailabilityBoundary.
 ///
 /// Finding these positions is a three step process:
 /// 1) computeRegion: Forward CFG walk from non-lifetime-ending boundary to find
@@ -200,7 +200,7 @@ class AvailabilityBoundaryVisitor {
         region(value->getFunction()) {}
 
   using Visit = llvm::function_ref<void(SILInstruction *,
-                                        OSSALifetimeCompletion::LifetimeEnd)>;
+                                        OSSACompleteLifetime::LifetimeEnd)>;
 
   struct Result;
 
@@ -311,8 +311,8 @@ void AvailabilityBoundaryVisitor::computeRegion(
   // ScopedAddresses) are available only up to their last extend_lifetime on
   // non-dead-end paths. They cannot be consumed, but are only "available" up to
   // the end of their scope.
-  if (value->getOwnershipKind() != OwnershipKind::None
-      || ScopedAddressValue(value)) {
+  if (value->getOwnershipKind() != OwnershipKind::None ||
+      ScopedAddressValue(value)) {
     for (auto *endBlock : boundary.endBlocks) {
       if (!consumingBlocks.contains(endBlock)) {
         collect(endBlock);
@@ -338,8 +338,8 @@ void AvailabilityBoundaryVisitor::computeRegion(
               ->getModule()
               .getASTContext()
               .SILOpts.VerifySILOwnership) {
-        llvm::errs() << "Invalid SIL provided to OSSALifetimeCompletion?! {{\n";
-        llvm::errs() << "OSSALifetimeCompletion is visiting the availability "
+        llvm::errs() << "Invalid SIL provided to OSSACompleteLifetime?! {{\n";
+        llvm::errs() << "OSSACompleteLifetime is visiting the availability "
                         "boundary of ";
         value->print(llvm::errs());
         llvm::errs()
@@ -353,8 +353,8 @@ void AvailabilityBoundaryVisitor::computeRegion(
                "value was leaked.  The function with the leak is as follows:\n";
         block->getFunction()->print(llvm::errs());
         llvm::errs()
-            << "Invalid SIL provided to OSSALifetimeCompletion?! }}\n"
-            << "Something that ran before OSSALifetimeCompletion (the current "
+            << "Invalid SIL provided to OSSACompleteLifetime?! }}\n"
+            << "Something that ran before OSSACompleteLifetime (the current "
                "pass, an earlier pass, SILGen) has introduced a leak of this "
                "value.\n"
             << "Please rerun the crashing swift-frontend command with the "
@@ -419,7 +419,7 @@ void AvailabilityBoundaryVisitor::propagateAvailablity(Result &result) {
 void AvailabilityBoundaryVisitor::visitAvailabilityBoundary(
     Result const &result,
     llvm::function_ref<void(SILInstruction *,
-                            OSSALifetimeCompletion::LifetimeEnd end)>
+                            OSSACompleteLifetime::LifetimeEnd end)>
         visit) {
   for (auto *block : region) {
     auto available = result.getState(block) == State::Available;
@@ -441,13 +441,12 @@ void AvailabilityBoundaryVisitor::visitAvailabilityBoundary(
                 ->getModule()
                 .getASTContext()
                 .SILOpts.VerifySILOwnership);
-    visit(block->getTerminator(),
-          OSSALifetimeCompletion::LifetimeEnd::Boundary);
+    visit(block->getTerminator(), OSSACompleteLifetime::LifetimeEnd::Boundary);
   }
 }
 } // end anonymous namespace
 
-void OSSALifetimeCompletion::visitAvailabilityBoundary(
+void OSSACompleteLifetime::visitAvailabilityBoundary(
     SILValue value, const SSAPrunedLiveness &liveness,
     llvm::function_ref<void(SILInstruction *, LifetimeEnd end)> visit) {
 
@@ -468,7 +467,7 @@ static bool endLifetimeAtAvailabilityBoundary(SILValue value,
                                               const SSAPrunedLiveness &liveness,
                                               DeadEndBlocks &deb) {
   bool changed = false;
-  OSSALifetimeCompletion::visitAvailabilityBoundary(
+  OSSACompleteLifetime::visitAvailabilityBoundary(
       value, liveness, [&](auto *unreachable, auto end) {
         SILBuilderWithScope builder(unreachable);
         endOSSALifetime(value, end, builder, deb);
@@ -479,33 +478,33 @@ static bool endLifetimeAtAvailabilityBoundary(SILValue value,
 
 static bool endLifetimeAtBoundary(SILValue value,
                                   SSAPrunedLiveness const &liveness,
-                                  OSSALifetimeCompletion::Boundary boundary,
+                                  OSSACompleteLifetime::Boundary boundary,
                                   DeadEndBlocks &deadEndBlocks) {
   bool changed = false;
   switch (boundary) {
-  case OSSALifetimeCompletion::Boundary::Liveness:
+  case OSSACompleteLifetime::Boundary::Liveness:
     changed |= endLifetimeAtLivenessBoundary(value, liveness, deadEndBlocks);
     break;
-  case OSSALifetimeCompletion::Boundary::Availability:
+  case OSSACompleteLifetime::Boundary::Availability:
     changed |=
         endLifetimeAtAvailabilityBoundary(value, liveness, deadEndBlocks);
     break;
   }
   return changed;
 }
 
-bool OSSALifetimeCompletion::analyzeAndUpdateLifetime(
+bool OSSACompleteLifetime::analyzeAndUpdateLifetime(
     ScopedAddressValue scopedAddress, Boundary boundary) {
   SmallVector<SILBasicBlock *, 8> discoveredBlocks;
   SSAPrunedLiveness liveness(scopedAddress->getFunction(), &discoveredBlocks);
   liveness.initializeDef(scopedAddress.value);
 
   struct Walker : TransitiveAddressWalker<Walker> {
-    OSSALifetimeCompletion &completion;
+    OSSACompleteLifetime &completion;
     ScopedAddressValue scopedAddress;
     Boundary boundary;
     SSAPrunedLiveness &liveness;
-    Walker(OSSALifetimeCompletion &completion, ScopedAddressValue scopedAddress,
+    Walker(OSSACompleteLifetime &completion, ScopedAddressValue scopedAddress,
            Boundary boundary, SSAPrunedLiveness &liveness)
         : completion(completion), scopedAddress(scopedAddress),
           boundary(boundary), liveness(liveness) {}
@@ -555,8 +554,8 @@ bool OSSALifetimeCompletion::analyzeAndUpdateLifetime(
 /// End the lifetime of \p value at unreachable instructions.
 ///
 /// Returns true if any new instructions were created to complete the lifetime.
-bool OSSALifetimeCompletion::analyzeAndUpdateLifetime(SILValue value,
-                                                      Boundary boundary) {
+bool OSSACompleteLifetime::analyzeAndUpdateLifetime(SILValue value,
+                                                    Boundary boundary) {
   if (auto scopedAddress = ScopedAddressValue(value)) {
     return analyzeAndUpdateLifetime(scopedAddress, boundary);
   }
@@ -577,8 +576,8 @@ bool OSSALifetimeCompletion::analyzeAndUpdateLifetime(SILValue value,
   }
   InteriorLiveness liveness(value);
   liveness.compute(domInfo, handleInnerScope);
-  if (VerifyLifetimeCompletion && boundary != Boundary::Availability
-      && liveness.getAddressUseKind() != AddressUseKind::NonEscaping) {
+  if (VerifyLifetimeCompletion && boundary != Boundary::Availability &&
+      liveness.getAddressUseKind() != AddressUseKind::NonEscaping) {
     llvm::errs() << "Incomplete liveness for: " << value;
     if (auto *escapingUse = liveness.escapingUse) {
       llvm::errs() << "  escapes at:\n";
@@ -596,20 +595,19 @@ namespace swift::test {
 // - string: either "liveness" or "availability"
 // Dumps:
 // - function
-static FunctionTest OSSALifetimeCompletionTest(
-    "ossa_lifetime_completion",
-    [](auto &function, auto &arguments, auto &test) {
+static FunctionTest OSSACompleteLifetimeTest(
+    "ossa_complete_lifetime", [](auto &function, auto &arguments, auto &test) {
       SILValue value = arguments.takeValue();
-      OSSALifetimeCompletion::Boundary kind =
-          llvm::StringSwitch<OSSALifetimeCompletion::Boundary>(
+      OSSACompleteLifetime::Boundary kind =
+          llvm::StringSwitch<OSSACompleteLifetime::Boundary>(
               arguments.takeString())
-              .Case("liveness", OSSALifetimeCompletion::Boundary::Liveness)
+              .Case("liveness", OSSACompleteLifetime::Boundary::Liveness)
               .Case("availability",
-                    OSSALifetimeCompletion::Boundary::Availability);
+                    OSSACompleteLifetime::Boundary::Availability);
       auto *deb = test.getDeadEndBlocks();
       llvm::outs() << "OSSA lifetime completion on " << kind
                    << " boundary: " << value;
-      OSSALifetimeCompletion completion(&function, /*domInfo*/ nullptr, *deb);
+      OSSACompleteLifetime completion(&function, /*domInfo*/ nullptr, *deb);
       completion.completeOSSALifetime(value, kind);
       function.print(llvm::outs());
     });
@@ -686,12 +684,12 @@ bool UnreachableLifetimeCompletion::completeLifetimes() {
     }
   }
 
-  OSSALifetimeCompletion completion(function, domInfo, deadEndBlocks);
+  OSSACompleteLifetime completion(function, domInfo, deadEndBlocks);
 
   bool changed = false;
   for (auto value : incompleteValues) {
     if (completion.completeOSSALifetime(
-            value, OSSALifetimeCompletion::Boundary::Availability) ==
+            value, OSSACompleteLifetime::Boundary::Availability) ==
         LifetimeCompletion::WasCompleted) {
       changed = true;
     }

lib/SILOptimizer/Mandatory/MoveOnlyAddressCheckerUtils.cpp

@@ -243,7 +243,7 @@
 #include "swift/SIL/FieldSensitivePrunedLiveness.h"
 #include "swift/SIL/InstructionUtils.h"
 #include "swift/SIL/MemAccessUtils.h"
-#include "swift/SIL/OSSALifetimeCompletion.h"
+#include "swift/SIL/OSSACompleteLifetime.h"
 #include "swift/SIL/OwnershipUtils.h"
 #include "swift/SIL/PrunedLiveness.h"
 #include "swift/SIL/SILArgument.h"
@@ -4071,13 +4071,12 @@ bool MoveOnlyAddressChecker::check(
   return pimpl.changed;
 }
 bool MoveOnlyAddressChecker::completeLifetimes() {
-  // TODO: Delete once OSSALifetimeCompletion is run as part of SILGenCleanup
+  // TODO: Delete once OSSACompleteLifetime is run as part of SILGenCleanup
   bool changed = false;
 
   // Lifetimes must be completed inside out (bottom-up in the CFG).
   PostOrderFunctionInfo *postOrder = poa->get(fn);
-  OSSALifetimeCompletion completion(fn, domTree,
-                                    *deadEndBlocksAnalysis->get(fn));
+  OSSACompleteLifetime completion(fn, domTree, *deadEndBlocksAnalysis->get(fn));
   for (auto *block : postOrder->getPostOrder()) {
     for (SILInstruction &inst : reverse(*block)) {
       for (auto result : inst.getResults()) {
@@ -4086,7 +4085,7 @@ bool MoveOnlyAddressChecker::completeLifetimes() {
           continue;
         }
         if (completion.completeOSSALifetime(
-                result, OSSALifetimeCompletion::Boundary::Availability) ==
+                result, OSSACompleteLifetime::Boundary::Availability) ==
             LifetimeCompletion::WasCompleted) {
           changed = true;
         }
@@ -4097,7 +4096,7 @@ bool MoveOnlyAddressChecker::completeLifetimes() {
         continue;
       }
       if (completion.completeOSSALifetime(
-              arg, OSSALifetimeCompletion::Boundary::Availability) ==
+              arg, OSSACompleteLifetime::Boundary::Availability) ==
           LifetimeCompletion::WasCompleted) {
         changed = true;
       }