Merge pull request #64651 from nate-chandler/nfc/rename-destroy-addr-hoisting

nate-chandler · web-flow · commit 1aa84cb2372c · 2023-03-27T21:13:10.000-07:00
[NFC] Renamed DestroyAddrHoisting.
diff --git a/include/swift/AST/SILOptions.h b/include/swift/AST/SILOptions.h
@@ -59,10 +59,10 @@ enum class CopyPropagationOption : uint8_t {
 };
 
 enum class DestroyHoistingOption : uint8_t {
-  // Do not run SSADestroyHoisting.
+  // Do not run DestroyAddrHoisting.
   Off = 0,
 
-  // Run SSADestroyHoisting pass after AllocBoxToStack in the function passes.
+  // Run DestroyAddrHoisting pass after AllocBoxToStack in the function passes.
   On = 1
 };
 
@@ -98,7 +98,7 @@ class SILOptions {
   /// When this is 'On' the pipeline has default behavior.
   CopyPropagationOption CopyPropagation = CopyPropagationOption::On;
 
-  /// Whether to run the SSADestroyHoisting pass.
+  /// Whether to run the DestroyAddrHoisting pass.
   ///
   /// When this 'On' the pipeline has the default behavior.
   DestroyHoistingOption DestroyHoisting = DestroyHoistingOption::On;
diff --git a/include/swift/SILOptimizer/PassManager/Passes.def b/include/swift/SILOptimizer/PassManager/Passes.def
@@ -182,7 +182,7 @@ PASS(DefiniteInitialization, "definite-init",
      "Definite Initialization for Diagnostics")
 PASS(DestroyHoisting, "destroy-hoisting",
      "Hoisting of value destroys")
-PASS(SSADestroyHoisting, "ssa-destroy-hoisting",
+PASS(DestroyAddrHoisting, "destroy-addr-hoisting",
      "Hoist destroy_addr for uniquely identified values")
 PASS(Devirtualizer, "devirtualizer",
      "Indirect Call Devirtualization")
diff --git a/lib/SILOptimizer/PassManager/PassPipeline.cpp b/lib/SILOptimizer/PassManager/PassPipeline.cpp
@@ -382,7 +382,7 @@ void addFunctionPasses(SILPassPipelinePlan &P,
   P.addAllocBoxToStack();
 
   if (P.getOptions().DestroyHoisting == DestroyHoistingOption::On) {
-    P.addSSADestroyHoisting();
+    P.addDestroyAddrHoisting();
   }
 
   // Propagate copies through stack locations.  Should run after
diff --git a/lib/SILOptimizer/Transforms/CMakeLists.txt b/lib/SILOptimizer/Transforms/CMakeLists.txt
@@ -33,7 +33,7 @@ target_sources(swiftSILOptimizer PRIVATE
   SILLowerAggregateInstrs.cpp
   SILMem2Reg.cpp
   SILSROA.cpp
-  SSADestroyHoisting.cpp
+  DestroyAddrHoisting.cpp
   SimplifyCFG.cpp
   Sink.cpp
   SpeculativeDevirtualizer.cpp
diff --git a/lib/SILOptimizer/Transforms/DestroyAddrHoisting.cpp b/lib/SILOptimizer/Transforms/DestroyAddrHoisting.cpp
@@ -1,8 +1,8 @@
-//===--- SSADestroyHoisting.cpp - SSA-based destroy hoisting --------------===//
+//===--- DestroyAddrHoisting.cpp - SSA-based destroy_addr hoisting --------===//
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2014 - 2021 Apple Inc. and the Swift project authors
+// Copyright (c) 2014 - 2022 Apple Inc. and the Swift project authors
 // Licensed under Apache License v2.0 with Runtime Library Exception
 //
 // See https://swift.org/LICENSE.txt for license information
@@ -87,7 +87,7 @@
 ///
 /// ===--------------------------------------------------------------------===//
 
-#define DEBUG_TYPE "ssa-destroy-hoisting"
+#define DEBUG_TYPE "destroy-addr-hoisting"
 
 #include "swift/AST/Type.h"
 #include "swift/Basic/GraphNodeWorklist.h"
@@ -121,8 +121,8 @@ struct KnownStorageUses : UniqueStorageUseVisitor {
         preserveDebugInfo(function->preserveDebugInfo()) {}
 
   bool empty() const {
-    return storageUsers.empty() && originalDestroys.empty()
-           && debugInsts.empty();
+    return storageUsers.empty() && originalDestroys.empty() &&
+           debugInsts.empty();
   }
 
   SILFunction *getFunction() const { return function; }
@@ -449,8 +449,7 @@ class HoistDestroys {
   void insertDestroy(SILInstruction *barrier, SILInstruction *insertBefore,
                      const KnownStorageUses &knownUses);
 
-  void createDestroy(SILInstruction *insertBefore,
-                     const SILDebugScope *scope);
+  void createDestroy(SILInstruction *insertBefore, const SILDebugScope *scope);
 
   void createSuccessorDestroys(SILBasicBlock *barrierBlock);
 
@@ -810,16 +809,16 @@ void HoistDestroys::insertDestroy(SILInstruction *barrier,
     destroyMergeBlocks.insert(branch->getDestBB());
   }
   // Avoid mutating SIL for no reason. This could lead to infinite loops.
-  if (isa<DestroyAddrInst>(insertBefore)
-      || isa<DestroyValueInst>(insertBefore)) {
-    if (llvm::find(knownUses.originalDestroys, insertBefore)
-        != knownUses.originalDestroys.end()) {
+  if (isa<DestroyAddrInst>(insertBefore) ||
+      isa<DestroyValueInst>(insertBefore)) {
+    if (llvm::find(knownUses.originalDestroys, insertBefore) !=
+        knownUses.originalDestroys.end()) {
       reusedDestroys.insert(insertBefore);
       return;
     }
   }
-  const SILDebugScope *scope = barrier
-    ? barrier->getDebugScope() : getFunction()->getDebugScope();
+  const SILDebugScope *scope =
+      barrier ? barrier->getDebugScope() : getFunction()->getDebugScope();
   createDestroy(insertBefore, scope);
 }
 
@@ -829,10 +828,10 @@ void HoistDestroys::createDestroy(SILInstruction *insertBefore,
   SILInstruction *newDestroy;
   if (storageRoot->getType().isAddress()) {
     newDestroy =
-      SILBuilder(insertBefore, scope).createDestroyAddr(loc, storageRoot);
+        SILBuilder(insertBefore, scope).createDestroyAddr(loc, storageRoot);
   } else {
     newDestroy =
-      SILBuilder(insertBefore, scope).createDestroyValue(loc, storageRoot);
+        SILBuilder(insertBefore, scope).createDestroyValue(loc, storageRoot);
   }
   deleter.getCallbacks().createdNewInst(newDestroy);
 }
@@ -841,8 +840,8 @@ void HoistDestroys::mergeDestroys(SILBasicBlock *mergeBlock) {
   SmallVector<SILInstruction *, 4> deadDestroys;
   for (auto *predecessors : mergeBlock->getPredecessorBlocks()) {
     auto *tailDestroy = predecessors->getTerminator()->getPreviousInstruction();
-    if (!tailDestroy || (!isa<DestroyAddrInst>(tailDestroy)
-                         && !isa<DestroyValueInst>(tailDestroy))) {
+    if (!tailDestroy || (!isa<DestroyAddrInst>(tailDestroy) &&
+                         !isa<DestroyValueInst>(tailDestroy))) {
       return;
     }
     if (tailDestroy->getOperand(0) != storageRoot)
@@ -894,15 +893,15 @@ bool hoistDestroys(SILValue root, bool ignoreDeinitBarriers,
 // =============================================================================
 
 namespace {
-class SSADestroyHoisting : public swift::SILFunctionTransform {
+class DestroyAddrHoisting : public swift::SILFunctionTransform {
   void run() override;
 };
 } // end anonymous namespace
 
 // TODO: Handle alloc_box the same way, as long as the box doesn't escape.
 //
 // TODO: Handle address and boxes that are captured in no-escape closures.
-void SSADestroyHoisting::run() {
+void DestroyAddrHoisting::run() {
   if (!getFunction()->hasOwnership())
     return;
 
@@ -1067,6 +1066,6 @@ void SSADestroyHoisting::run() {
   }
 }
 
-SILTransform *swift::createSSADestroyHoisting() {
-  return new SSADestroyHoisting();
+SILTransform *swift::createDestroyAddrHoisting() {
+  return new DestroyAddrHoisting();
 }
diff --git a/test/SILOptimizer/disable-copy-propagation-frontend-flag.swift b/test/SILOptimizer/disable-copy-propagation-frontend-flag.swift
@@ -74,30 +74,30 @@
 // RUN: 2>&1 | %FileCheck -check-prefix CHECK-CPON-DHON %s
 
 // CHECK-CPUNSPEC-DHUNSPEC: copy-propagation
-// CHECK-CPUNSPEC-DHUNSPEC: ssa-destroy-hoisting
+// CHECK-CPUNSPEC-DHUNSPEC: destroy-addr-hoisting
 
 // CHECK-CPUNSPEC-DHOFF: copy-propagation
-// CHECK-CPUNSPEC-DHOFF-NOT: ssa-destroy-hoisting
+// CHECK-CPUNSPEC-DHOFF-NOT: destroy-addr-hoisting
 
 // CHECK-CPUNSPEC-DHON: copy-propagation
-// CHECK-CPUNSPEC-DHON: ssa-destroy-hoisting
+// CHECK-CPUNSPEC-DHON: destroy-addr-hoisting
 
 // CHECK-CPOFF-DHUNSPEC-NOT: copy-propagation
-// CHECK-CPOFF-DHUNSPEC-NOT: ssa-destroy-hoisting
+// CHECK-CPOFF-DHUNSPEC-NOT: destroy-addr-hoisting
 
 // CHECK-CPOFF-DHOFF-NOT: copy-propagation
-// CHECK-CPOFF-DHOFF-NOT: ssa-destroy-hoisting
+// CHECK-CPOFF-DHOFF-NOT: destroy-addr-hoisting
 
 // CHECK-CPOFF-DHON-NOT: copy-propagation
-// CHECK-CPOFF-DHON: ssa-destroy-hoisting
+// CHECK-CPOFF-DHON: destroy-addr-hoisting
 
 // CHECK-CPON-DHUNSPEC: copy-propagation
-// CHECK-CPON-DHUNSPEC: ssa-destroy-hoisting
+// CHECK-CPON-DHUNSPEC: destroy-addr-hoisting
 
 // CHECK-CPON-DHOFF: copy-propagation
-// CHECK-CPON-DHOFF-NOT: ssa-destroy-hoisting
+// CHECK-CPON-DHOFF-NOT: destroy-addr-hoisting
 
 // CHECK-CPON-DHON: copy-propagation
-// CHECK-CPON-DHON: ssa-destroy-hoisting
+// CHECK-CPON-DHON: destroy-addr-hoisting
 
 func foo() {}
diff --git a/test/SILOptimizer/hoist_destroy_addr.sil b/test/SILOptimizer/hoist_destroy_addr.sil
@@ -1,5 +1,5 @@
-// RUN: %target-sil-opt -opt-mode=none  -enable-sil-verify-all %s -compute-side-effects -ssa-destroy-hoisting | %FileCheck %s --check-prefix=CHECK --check-prefix=CHECKDEB --check-prefix=CHECK-DEB
-// RUN: %target-sil-opt -opt-mode=speed -enable-sil-verify-all %s -compute-side-effects -ssa-destroy-hoisting | %FileCheck %s --check-prefix=CHECK --check-prefix=CHECKOPT --check-prefix=CHECK-OPT
+// RUN: %target-sil-opt -opt-mode=none  -enable-sil-verify-all %s -compute-side-effects -destroy-addr-hoisting | %FileCheck %s --check-prefix=CHECK --check-prefix=CHECKDEB --check-prefix=CHECK-DEB
+// RUN: %target-sil-opt -opt-mode=speed -enable-sil-verify-all %s -compute-side-effects -destroy-addr-hoisting | %FileCheck %s --check-prefix=CHECK --check-prefix=CHECKOPT --check-prefix=CHECK-OPT
 //
 // TODO: migrate the remaining tests from destroy_hoisting.sil.
 
diff --git a/test/SILOptimizer/hoist_destroy_addr_loop.sil b/test/SILOptimizer/hoist_destroy_addr_loop.sil
@@ -1,5 +1,5 @@
-// RUN: %target-sil-opt -opt-mode=none  -enable-sil-verify-all %s -ssa-destroy-hoisting | %FileCheck %s --check-prefix=CHECK --check-prefix=CHECKDEB
-// RUN: %target-sil-opt -opt-mode=speed -enable-sil-verify-all %s -ssa-destroy-hoisting | %FileCheck %s --check-prefix=CHECK --check-prefix=CHECKOPT
+// RUN: %target-sil-opt -opt-mode=none  -enable-sil-verify-all %s -destroy-addr-hoisting | %FileCheck %s --check-prefix=CHECK --check-prefix=CHECKDEB
+// RUN: %target-sil-opt -opt-mode=speed -enable-sil-verify-all %s -destroy-addr-hoisting | %FileCheck %s --check-prefix=CHECK --check-prefix=CHECKOPT
 
 sil_stage canonical
 
diff --git a/test/SILOptimizer/hoist_destroy_addr_resilient.sil b/test/SILOptimizer/hoist_destroy_addr_resilient.sil
@@ -3,7 +3,7 @@
 // RUN:   -emit-module-path=%t/resilient_struct.swiftmodule \
 // RUN:   -module-name=resilient_struct %S/../Inputs/resilient_struct.swift
 
-// RUN: %target-sil-opt -I %t -opt-mode=speed -enable-sil-verify-all %s -ssa-destroy-hoisting | %FileCheck %s --check-prefix=CHECK
+// RUN: %target-sil-opt -I %t -opt-mode=speed -enable-sil-verify-all %s -destroy-addr-hoisting | %FileCheck %s --check-prefix=CHECK
 
 import resilient_struct
 
diff --git a/validation-test/SILOptimizer/hoist_destroy_addr.sil b/validation-test/SILOptimizer/hoist_destroy_addr.sil
@@ -1,5 +1,5 @@
-// RUN: %target-sil-opt -opt-mode=none  -enable-sil-verify-all %s -ssa-destroy-hoisting | %FileCheck %s --check-prefix=CHECK --check-prefix=CHECKDEB
-// RUN: %target-sil-opt -opt-mode=speed -enable-sil-verify-all %s -ssa-destroy-hoisting | %FileCheck %s --check-prefix=CHECK --check-prefix=CHECKOPT
+// RUN: %target-sil-opt -opt-mode=none  -enable-sil-verify-all %s -destroy-addr-hoisting | %FileCheck %s --check-prefix=CHECK --check-prefix=CHECKDEB
+// RUN: %target-sil-opt -opt-mode=speed -enable-sil-verify-all %s -destroy-addr-hoisting | %FileCheck %s --check-prefix=CHECK --check-prefix=CHECKOPT
 
 // REQUIRES: rdar98890125
 // REQUIRES: long_test

Original file line number	Diff line number	Diff line change
`@@ -382,7 +382,7 @@ void addFunctionPasses(SILPassPipelinePlan &P,`
`382`	`382`	`P.addAllocBoxToStack();`
`383`	`383`
`384`	`384`	`if (P.getOptions().DestroyHoisting == DestroyHoistingOption::On) {`
`385`		`- P.addSSADestroyHoisting();`
	`385`	`+ P.addDestroyAddrHoisting();`
`386`	`386`	`}`
`387`	`387`
`388`	`388`	`// Propagate copies through stack locations. Should run after`