Swift Optimizer: add the ComputeSideEffects pass.

eeckstein · eeckstein · commit 741c6c38df22 · 2022-10-05T07:38:11.000+02:00
Computes the side effects for a function, which consists of argument- and global effects.
This is similar to the ComputeEscapeEffects pass, just for side-effects.
diff --git a/SwiftCompilerSources/Sources/Optimizer/FunctionPasses/CMakeLists.txt b/SwiftCompilerSources/Sources/Optimizer/FunctionPasses/CMakeLists.txt
@@ -9,6 +9,7 @@
 swift_compiler_sources(Optimizer
   AssumeSingleThreaded.swift
   ComputeEscapeEffects.swift
+  ComputeSideEffects.swift
   ObjCBridgingOptimization.swift
   MergeCondFails.swift
   ReleaseDevirtualizer.swift
diff --git a/SwiftCompilerSources/Sources/Optimizer/FunctionPasses/ComputeSideEffects.swift b/SwiftCompilerSources/Sources/Optimizer/FunctionPasses/ComputeSideEffects.swift
diff --git a/SwiftCompilerSources/Sources/Optimizer/PassManager/PassRegistration.swift b/SwiftCompilerSources/Sources/Optimizer/PassManager/PassRegistration.swift
@@ -52,6 +52,7 @@ private func registerSwiftPasses() {
   // Function passes
   registerPass(mergeCondFailsPass, { mergeCondFailsPass.run($0) })
   registerPass(computeEscapeEffects, { computeEscapeEffects.run($0) })
+  registerPass(computeSideEffects, { computeSideEffects.run($0) })
   registerPass(objCBridgingOptimization, { objCBridgingOptimization.run($0) })
   registerPass(stackPromotion, { stackPromotion.run($0) })
   registerPass(functionStackProtection, { functionStackProtection.run($0) })
diff --git a/include/swift/SILOptimizer/PassManager/Passes.def b/include/swift/SILOptimizer/PassManager/Passes.def
@@ -245,6 +245,8 @@ SWIFT_FUNCTION_PASS(AccessDumper, "dump-access",
      "Dump access information")
 SWIFT_FUNCTION_PASS(ComputeEscapeEffects, "compute-escape-effects",
      "Computes function escape effects")
+SWIFT_FUNCTION_PASS(ComputeSideEffects, "compute-side-effects",
+     "Computes function side effects")
 PASS(FlowIsolation, "flow-isolation",
      "Enforces flow-sensitive actor isolation rules")
 PASS(FunctionOrderPrinter, "function-order-printer",
diff --git a/lib/SILOptimizer/PassManager/PassPipeline.cpp b/lib/SILOptimizer/PassManager/PassPipeline.cpp
@@ -639,6 +639,7 @@ static void addHighLevelFunctionPipeline(SILPassPipelinePlan &P) {
   
   P.addStringOptimization();
   P.addComputeEscapeEffects();
+  P.addComputeSideEffects();
 }
 
 // After "high-level" function passes have processed the entire call tree, run
@@ -654,6 +655,7 @@ static void addHighLevelModulePipeline(SILPassPipelinePlan &P) {
   //
   // FIXME: why does StackPromotion need to run in the module pipeline?
   P.addComputeEscapeEffects();
+  P.addComputeSideEffects();
   P.addStackPromotion();
 
   P.addGlobalOpt();
@@ -695,6 +697,7 @@ static void addClosureSpecializePassPipeline(SILPassPipelinePlan &P) {
   // ComputeEffects should be done at the end of a function-pipeline. The next
   // pass (GlobalOpt) is a module pass, so this is the end of a function-pipeline.
   P.addComputeEscapeEffects();
+  P.addComputeSideEffects();
 
   // Hoist globals out of loops.
   // Global-init functions should not be inlined GlobalOpt is done.
@@ -726,6 +729,7 @@ static void addClosureSpecializePassPipeline(SILPassPipelinePlan &P) {
   addSimplifyCFGSILCombinePasses(P);
 
   P.addComputeEscapeEffects();
+  P.addComputeSideEffects();
 
   // We do this late since it is a pass like the inline caches that we only want
   // to run once very late. Make sure to run at least one round of the ARC
@@ -747,6 +751,7 @@ static void addLowLevelPassPipeline(SILPassPipelinePlan &P) {
   // We've done a lot of optimizations on this function, attempt to FSO.
   P.addFunctionSignatureOpts();
   P.addComputeEscapeEffects();
+  P.addComputeSideEffects();
 }
 
 static void addLateLoopOptPassPipeline(SILPassPipelinePlan &P) {
@@ -776,6 +781,7 @@ static void addLateLoopOptPassPipeline(SILPassPipelinePlan &P) {
   // Sometimes stack promotion can catch cases only at this late stage of the
   // pipeline, after FunctionSignatureOpts.
   P.addComputeEscapeEffects();
+  P.addComputeSideEffects();
   P.addStackPromotion();
 
   // Optimize overflow checks.
diff --git a/test/SILOptimizer/cross-module-effects.swift b/test/SILOptimizer/cross-module-effects.swift
@@ -25,15 +25,17 @@ public final class X {
 }
 
 // CHECK-FR-MODULE-LABEL: sil [canonical] @$s6Module17noInlineNoEffectsySiAA1XCF :
-// CHECK-FR-MODULE-NEXT:  [%0: noescape **]
+// CHECK-FR-MODULE-NEXT:  [%0: noescape **, read c0.v**]
+// CHECK-FR-MODULE-NEXT:  [global: ]
 // CHECK-FR-MODULE-NEXT:  {{^[^[]}}
 // CHECK-LE-MODULE-NOT: @$s6Module17noInlineNoEffectsySiAA1XCF
 public func noInlineNoEffects(_ x: X) -> Int {
   return x.i
 }
 
 // CHECK-FR-MODULE-LABEL: sil [serialized] [noinline] [canonical] @$s6Module15inlineNoEffectsySiAA1XCF : $@convention(thin) (@guaranteed X) -> Int {
-// CHECK-FR-MODULE-NEXT:  [%0: noescape **]
+// CHECK-FR-MODULE-NEXT:  [%0: noescape **, read c0.v**]
+// CHECK-FR-MODULE-NEXT:  [global: ]
 // CHECK-FR-MODULE-NEXT:  {{^[^[]}}
 // CHECK-LE-MODULE-LABEL: sil [serialized] [noinline] [canonical] @$s6Module15inlineNoEffectsySiAA1XCF : $@convention(thin) (@guaranteed X) -> Int {
 // CHECK-LE-MODULE-NEXT:  {{^[^[]}}
@@ -44,7 +46,8 @@ public func inlineNoEffects(_ x: X) -> Int {
 }
 
 // CHECK-FR-MODULE-LABEL: sil [canonical] @$s6Module14internalCalleeySiAA1XCF : $@convention(thin) (@guaranteed X) -> Int {
-// CHECK-FR-MODULE-NEXT:  [%0: noescape **]
+// CHECK-FR-MODULE-NEXT:  [%0: noescape **, read c0.v**]
+// CHECK-FR-MODULE-NEXT:  [global: ]
 // CHECK-FR-MODULE-NEXT:  {{^[^[]}}
 // CHECK-LE-MODULE-LABEL: sil [canonical] @$s6Module14internalCalleeySiAA1XCF : $@convention(thin) (@guaranteed X) -> Int{{$}}
 @usableFromInline
@@ -53,7 +56,8 @@ func internalCallee(_ x: X) -> Int {
 }
 
 // CHECK-FR-MODULE-LABEL: sil [canonical] @$s6Module19noInlineWithEffectsySiAA1XCF :
-// CHECK-FR-MODULE-NEXT:  [%0: noescape! **]
+// CHECK-FR-MODULE-NEXT:  [%0: noescape! **, read c0.v**]
+// CHECK-FR-MODULE-NEXT:  [global: ]
 // CHECK-FR-MODULE-NEXT:  {{^[^[]}}
 // CHECK-LE-MODULE-NOT: @$s6Module19noInlineWithEffectsySiAA1XCF
 @_effects(notEscaping x.**)
@@ -62,7 +66,8 @@ public func noInlineWithEffects(_ x: X) -> Int {
 }
 
 // CHECK-FR-MODULE-LABEL: sil [serialized] [noinline] [canonical] @$s6Module17inlineWithEffectsySiAA1XCF :
-// CHECK-FR-MODULE-NEXT:  [%0: noescape! **]
+// CHECK-FR-MODULE-NEXT:  [%0: noescape! **, read c0.v**]
+// CHECK-FR-MODULE-NEXT:  [global: ]
 // CHECK-FR-MODULE-NEXT:  {{^[^[]}}
 // CHECK-LE-MODULE-LABEL: sil [serialized] [noinline] [canonical] @$s6Module17inlineWithEffectsySiAA1XCF :
 // CHECK-LE-MODULE-NEXT:  [%0: noescape! **]
@@ -75,7 +80,8 @@ public func inlineWithEffects(_ x: X) -> Int {
 }
 
 // CHECK-FR-MODULE-LABEL: sil [serialized] [noinline] [canonical] @$s6Module12simpleInlineySiAA1XCF : $@convention(thin) (@guaranteed X) -> Int {
-// CHECK-FR-MODULE-NEXT:  [%0: noescape **]
+// CHECK-FR-MODULE-NEXT:  [%0: noescape **, read c0.v**]
+// CHECK-FR-MODULE-NEXT:  [global: ]
 // CHECK-FR-MODULE-NEXT:  {{^[^[]}}
 // CHECK-LE-MODULE-LABEL: sil [serialized] [noinline] [canonical] @$s6Module12simpleInlineySiAA1XCF : $@convention(thin) (@guaranteed X) -> Int {
 // CHECK-LE-MODULE-NEXT:  {{^[^[]}}
@@ -100,7 +106,8 @@ public func callit1() -> Int {
 }
 
 // CHECK-FR-MAIN-LABEL: sil @$s6Module17noInlineNoEffectsySiAA1XCF : $@convention(thin) (@guaranteed X) -> Int
-// CHECK-FR-MAIN-NEXT:  [%0: noescape **]
+// CHECK-FR-MAIN-NEXT:  [%0: noescape **, read c0.v**]
+// CHECK-FR-MAIN-NEXT:  [global: ]
 // CHECK-FR-MAIN-NEXT:  {{^[^[]}}
 // CHECK-LE-MAIN-LABEL: sil @$s6Module17noInlineNoEffectsySiAA1XCF : $@convention(thin) (@guaranteed X) -> Int{{$}}
 
@@ -115,7 +122,8 @@ public func callit2() -> Int {
 }
 
 // CHECK-FR-MAIN-LABEL: sil public_external [noinline] @$s6Module15inlineNoEffectsySiAA1XCF : $@convention(thin) (@guaranteed X) -> Int {
-// CHECK-FR-MAIN-NEXT:  [%0: noescape **]
+// CHECK-FR-MAIN-NEXT:  [%0: noescape **, read c0.v**]
+// CHECK-FR-MAIN-NEXT:  [global: ]
 // CHECK-FR-MAIN-NEXT:  {{^[^[]}}
 // CHECK-LE-MAIN-LABEL: sil public_external [noinline] @$s6Module15inlineNoEffectsySiAA1XCF : $@convention(thin) (@guaranteed X) -> Int {
 // CHECK-LE-MAIN-NEXT:  {{^[^[]}}
@@ -162,13 +170,15 @@ public func callit5() -> Int {
 }
 
 // CHECK-FR-MAIN-LABEL: sil public_external [noinline] @$s6Module12simpleInlineySiAA1XCF : $@convention(thin) (@guaranteed X) -> Int {
-// CHECK-FR-MAIN-NEXT:  [%0: noescape **]
+// CHECK-FR-MAIN-NEXT:  [%0: noescape **, read c0.v**]
+// CHECK-FR-MAIN-NEXT:  [global: ]
 // CHECK-FR-MAIN-NEXT:  {{^[^[]}}
 // CHECK-LE-MAIN-LABEL: sil public_external [noinline] @$s6Module12simpleInlineySiAA1XCF : $@convention(thin) (@guaranteed X) -> Int {
 // CHECK-LE-MAIN-NEXT:  {{^[^[]}}
 
 // CHECK-FR-MAIN-LABEL: sil @$s6Module14internalCalleeySiAA1XCF : $@convention(thin) (@guaranteed X) -> Int {
-// CHECK-FR-MAIN-NEXT:  [%0: noescape **]
+// CHECK-FR-MAIN-NEXT:  [%0: noescape **, read c0.v**]
+// CHECK-FR-MAIN-NEXT:  [global: ]
 // CHECK-FR-MAIN-NEXT:  {{^[^[]}}
 // CHECK-LE-MAIN-LABEL: sil @$s6Module14internalCalleeySiAA1XCF : $@convention(thin) (@guaranteed X) -> Int{{$}}
 
diff --git a/test/SILOptimizer/existential_metatype.swift b/test/SILOptimizer/existential_metatype.swift
@@ -4,7 +4,7 @@ protocol SomeP {}
 public enum SpecialEnum : SomeP {}
 
 // CHECK-LABEL: sil shared [noinline] @$s20existential_metatype17checkProtocolType0aE0Sbxm_tAA5SomePRzlFAA11SpecialEnumO_Tg5Tf4d_n : $@convention(thin) () -> Bool {
-// CHECK-NEXT: bb0:
+// CHECK:       bb0:
 // CHECK-NEXT:   %0 = integer_literal $Builtin.Int1, -1
 // CHECK-NEXT:   %1 = struct $Bool (%0 : $Builtin.Int1)
 // CHECK-NEXT:   return %1 : $Bool
diff --git a/test/SILOptimizer/existential_specializer_indirect_class.sil b/test/SILOptimizer/existential_specializer_indirect_class.sil
@@ -21,13 +21,13 @@ bb0(%0 : $*ClassProtocol):
 
 // Check that all the opened types are optimized away in the specialization of test_indirect_class_protocol_guaranteed
 // CHECK-LABEL: sil shared @$s39test_indirect_class_protocol_guaranteedTf4e_n : $@convention(thin) <τ_0_0 where τ_0_0 : ClassProtocol> (@in_guaranteed τ_0_0) -> ()
-// CHECK-NEXT: //
-// CHECK-NEXT: bb0(%0 : $*τ_0_0):
+// CHECK:        bb0(%0 : $*τ_0_0):
   // CHECK-NEXT: [[INPUT:%1]] = load %0
   // CHECK-NEXT: [[ARG:%.*]] = unchecked_ref_cast [[INPUT]]
   // CHECK-NEXT: [[METHOD:%.*]] = witness_method $C, #ClassProtocol.method
   // CHECK-NEXT: apply [[METHOD]]<C>([[ARG]])
   // CHECK-NEXT: return undef
+  // CHECK:      } // end sil function '$s39test_indirect_class_protocol_guaranteedTf4e_n'
   
 sil @test_indirect_class_protocol_guaranteed : $@convention(thin) (@in_guaranteed ClassProtocol) -> () {
 bb0(%0 : $*ClassProtocol):
@@ -48,8 +48,9 @@ bb0(%0 : $*ClassProtocol):
 // Check the generated specialization of test_indirect_class_protocol
 // CHECK-LABEL: sil shared @$s28test_indirect_class_protocolTf4e_n4main1CC_Tg5Tf4d_n : $@convention(thin) () -> ()
 // Make sure *everything* was inlined / optimized away
-// CHECK-NEXT: bb0:
+// CHECK:      bb0:
 // CHECK-NEXT: return undef
+// CHECK:      } // end sil function '$s28test_indirect_class_protocolTf4e_n4main1CC_Tg5Tf4d_n'
 
 sil @invoke_indirect_class_protocol : $@convention(thin) (@guaranteed C) -> () {
 bb0(%0 : $C):
diff --git a/test/SILOptimizer/functionsigopts_crash.swift b/test/SILOptimizer/functionsigopts_crash.swift
@@ -25,7 +25,8 @@ public struct S : P {
 //   * FSO: argument explosion 
 
 // CHECK-LABEL: sil shared [noinline] @$s4main6testityyAA1P_pFTf4e_nAA1SV_Tg5Tf4x_n : $@convention(thin) (Int) -> () { 
-// CHECK-NEXT: // %0 "p"
+// CHECK:       // %0 "p"
+// CHECK:       } // end sil function '$s4main6testityyAA1P_pFTf4e_nAA1SV_Tg5Tf4x_n'
 @inline(never)
 func testit(_ p: P) {
   p.foo()
diff --git a/test/SILOptimizer/optionset.swift b/test/SILOptimizer/optionset.swift
@@ -18,24 +18,26 @@ public struct TestOptions: OptionSet {
 // CHECK:   %initval = struct $TestOptions ([[INT]] : $Int)
 let globalTestOptions: TestOptions = [.first, .second, .third, .fourth]
 
-// CHECK-LABEL: sil @{{.*}}returnTestOptions{{.*}}
-// CHECK-NEXT: bb0:
+// CHECK-LABEL: sil @$s4test17returnTestOptionsAA0cD0VyF
+// CHECK:      bb0:
 // CHECK-NEXT:   builtin
 // CHECK-NEXT:   integer_literal {{.*}}, 15
 // CHECK-NEXT:   struct $Int
 // CHECK:        struct $TestOptions
 // CHECK-NEXT:   return
+// CHECK:      } // end sil function '$s4test17returnTestOptionsAA0cD0VyF'
 public func returnTestOptions() -> TestOptions {
     return [.first, .second, .third, .fourth]
 }
 
-// CHECK-LABEL: sil @{{.*}}returnEmptyTestOptions{{.*}}
-// CHECK-NEXT: bb0:
+// CHECK-LABEL: sil @$s4test22returnEmptyTestOptionsAA0dE0VyF
+// CHECK:      bb0:
 // CHECK-NEXT:   integer_literal {{.*}}, 0
 // CHECK-NEXT:   struct $Int
 // CHECK:        builtin "onFastPath"() : $()
 // CHECK-NEXT:   struct $TestOptions
 // CHECK-NEXT:   return
+// CHECK:      } // end sil function '$s4test22returnEmptyTestOptionsAA0dE0VyF'
 public func returnEmptyTestOptions() -> TestOptions {
     return []
 }
diff --git a/test/SILOptimizer/side_effects.sil b/test/SILOptimizer/side_effects.sil
