Merge pull request #36183 from atrick/fix-dce-fixlifetime

Disable fix_lifetime DCE.

Author: atrick

lib/SILOptimizer/Transforms/DeadCodeElimination.cpp

@@ -41,6 +41,7 @@ namespace {
 
 // Without any complex analysis, does this instruction seem like
 // something that we need to keep?
+//
 // FIXME: Reconcile the similarities between this and
 //        isInstructionTriviallyDead.
 static bool seemsUseful(SILInstruction *I) {
@@ -243,9 +244,17 @@ void DCE::markLive() {
         }
         break;
       }
+      // The side-effects of fix_lifetime effect all references to the same
+      // object. It must be preserved to keep alive any potentially aliasing
+      // references. fix_lifetime can only be removed by proving that its
+      // operand is both a unique and a dead reference, but this makes more
+      // sense in DeadObjectElimination.
       case SILInstructionKind::FixLifetimeInst: {
+        // If the operand is a trivial scalar value, then it has no aliases or
+        // side-effects. Consider handling this as an instruction
+        // canonicalization instead.
         SILValue Op = I.getOperand(0);
-        if (!Op->getType().isAddress()) {
+        if (!Op->getType().isAddress() && Op->getType().isTrivial(*F)) {
           addReverseDependency(Op, &I);
         } else {
           markInstructionLive(&I);

test/SILOptimizer/dead_code_elimination_ossa.sil

@@ -5,6 +5,11 @@ sil_stage canonical
 import Builtin
 import Swift
 
+public struct S {
+  var o: AnyObject
+}
+sil @dummy : $@convention(thin) () -> ()
+
 // CHECK-LABEL: sil [ossa] @dead1 :
 // CHECK: bb0
 // CHECK-NEXT: return %0
@@ -289,3 +294,69 @@ bb0(%0 : @owned $(String, (Int, Int, String))):
   return %1 : $String
 }
 
+// Test fix_lifetime of a struct and tuple. It cannot be removed
+// without proving reference uniqueness first.
+// rdar://36038096 ([SR-6608] DeadCodeElimination removes fix_lifetime instructions.)
+//
+// CHECK-LABEL: @testFixLifetimeTuple : $@convention(thin) (@owned S, @owned AnyObject) -> () {
+// CHECK: bb0(%0 : $S, %1 : $AnyObject):
+// CHECK:   [[TUPLE:%.*]] = tuple (%0 : $S, %1 : $AnyObject)
+// CHECK:   apply
+// CHECK:   fix_lifetime [[TUPLE]] : $(S, AnyObject)
+// CHECK:   strong_release %1 : $AnyObject
+// CHECK:   strong_release %{{.*}} : $AnyObject
+// CHECK-LABEL: } // end sil function 'testFixLifetimeTuple'
+sil @testFixLifetimeTuple : $@convention(thin) (@owned S, @owned AnyObject) -> () {
+bb0(%0 : $S, %1 : $AnyObject):
+  %4 = struct_extract %0 : $S, #S.o
+  %7 = tuple (%0 : $S, %1 : $AnyObject)
+  %8 = function_ref @dummy : $@convention(thin) () -> ()
+  %9 = apply %8() : $@convention(thin) () -> ()
+  fix_lifetime %7 : $(S, AnyObject)
+  strong_release %1 : $AnyObject
+  strong_release %4 : $AnyObject
+  %15 = tuple ()
+  return %15 : $()
+}
+
+// Test fix_lifetime of a load_borrow. It cannot be removed without
+// proving reference uniqueness first.
+// rdar://74759728 (The compiler/optimizer seems to be shortening the lifetime too early)
+//
+// Test case derived from $defer #1 <A><A1>() in _ArrayBuffer.withUnsafeBufferPointer<A>(_:)
+//
+// Original source that exposed the issue with -Ounchecked -sanitize=address:
+//
+// public func makeRawData(name: String) -> UnsafeMutableRawPointer {
+//   var array: [UInt8] = []
+//   array.append(contentsOf: name.utf8)
+//   array.append(0)
+//
+//   let rawData = array.withUnsafeBytes { (buffer: UnsafeRawBufferPointer) -> UnsafeMutableRawPointer in
+//     let rawData = malloc(Int(buffer.count))!
+//     rawData.copyMemory(from: buffer.baseAddress!, byteCount: buffer.count)
+//     return rawData
+//   }
+//   return rawData
+// }
+//
+// CHECK-LABEL: sil [ossa] @testDCEFixLifetime : $@convention(thin) (@guaranteed S) -> () {
+// %0 "self"                                      // users: %3, %1
+// CHECK: bb0(%0 : @guaranteed $S):
+// CHECK:   [[LD:%.*]] = load_borrow
+// CHECK:   fix_lifetime [[LD]] : $S
+// CHECK:   end_borrow [[LD]] : $S
+// CHECK-LABEL: } // end sil function 'testDCEFixLifetime'
+sil [ossa] @testDCEFixLifetime : $@convention(thin) (@guaranteed S) -> () {
+// %0 "self"
+bb0(%0 : @guaranteed $S):
+  debug_value %0 : $S, let, name "self", argno 1
+  %2 = alloc_stack $S
+  %3 = store_borrow %0 to %2 : $*S
+  %4 = load_borrow %2 : $*S
+  fix_lifetime %4 : $S
+  end_borrow %4 : $S
+  dealloc_stack %2 : $*S
+  %8 = tuple ()
+  return %8 : $()
+}