Merge remote-tracking branch 'origin/main' into next

Author: swift-ci

SwiftCompilerSources/Sources/Optimizer/PassManager/PassRegistration.swift

@@ -92,6 +92,7 @@ private func registerSwiftPasses() {
   registerPass(addressEscapeInfoDumper, { addressEscapeInfoDumper.run($0) })
   registerPass(accessDumper, { accessDumper.run($0) })
   registerPass(deadEndBlockDumper, { deadEndBlockDumper.run($0) })
+  registerPass(memBehaviorDumper, { memBehaviorDumper.run($0) })
   registerPass(rangeDumper, { rangeDumper.run($0) })
   registerPass(runUnitTests, { runUnitTests.run($0) })
   registerPass(testInstructionIteration, { testInstructionIteration.run($0) })

SwiftCompilerSources/Sources/Optimizer/TestPasses/CMakeLists.txt

@@ -11,6 +11,7 @@ swift_compiler_sources(Optimizer
   AccessDumper.swift
   DeadEndBlockDumper.swift
   EscapeInfoDumper.swift
+  MemBehaviorDumper.swift
   SILPrinter.swift
   RangeDumper.swift
   RunUnitTests.swift

SwiftCompilerSources/Sources/Optimizer/TestPasses/MemBehaviorDumper.swift

@@ -0,0 +1,80 @@
+//===--- MemBehaviorDumper.swift ------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2023 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
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+import SIL
+
+/// Prints the memory behavior of relevant instructions in relation to address values of the function.
+let memBehaviorDumper = FunctionPass(name: "dump-mem-behavior") {
+  (function: Function, context: FunctionPassContext) in
+
+  let aliasAnalysis = context.aliasAnalysis
+
+  print("@\(function.name)")
+
+  let values = function.allValues
+
+  var currentPair = 0
+  for inst in function.instructions where inst.shouldTest {
+
+    for value in values where value.definingInstruction != inst {
+
+      if value.type.isAddress || value is AddressToPointerInst {
+        let read = aliasAnalysis.mayRead(inst, fromAddress: value)
+        let write = aliasAnalysis.mayWrite(inst, toAddress: value)
+        print("PAIR #\(currentPair).")
+        print("  \(inst)")
+        print("  \(value)")
+        print("  r=\(read ? 1 : 0),w=\(write ? 1 : 0)")
+        currentPair += 1
+      }
+    }
+  }
+  print()
+}
+
+private extension Function {
+  var allValues: [Value] {
+    var values: [Value] = []
+    for block in blocks {
+      values.append(contentsOf: block.arguments.map { $0 })
+      for inst in block.instructions {
+        values.append(contentsOf: inst.results)
+      }
+    }
+    return values
+  }
+}
+
+private extension Instruction {
+  var shouldTest: Bool {
+    switch self {
+    case is ApplyInst,
+         is TryApplyInst,
+         is EndApplyInst,
+         is BeginApplyInst,
+         is AbortApplyInst,
+         is BeginAccessInst,
+         is EndAccessInst,
+         is EndCOWMutationInst,
+         is CopyValueInst,
+         is DestroyValueInst,
+         is EndBorrowInst,
+         is LoadInst,
+         is StoreInst,
+         is CopyAddrInst,
+         is BuiltinInst:
+      return true
+    default:
+      return false
+    }
+  }
+}

include/swift/SILOptimizer/PassManager/Passes.def

@@ -301,7 +301,7 @@ PASS(MandatoryInlining, "mandatory-inlining",
      "Mandatory Inlining of Transparent Functions")
 PASS(Mem2Reg, "mem2reg",
      "Memory to SSA Value Conversion to Remove Stack Allocation")
-PASS(MemBehaviorDumper, "mem-behavior-dump",
+SWIFT_FUNCTION_PASS(MemBehaviorDumper, "dump-mem-behavior",
      "Print SIL Instruction MemBehavior from Alias Analysis over all Pairs")
 PASS(LSLocationPrinter, "lslocation-dump",
      "Print Load-Store Location Results Covering all Accesses")

lib/SILOptimizer/UtilityPasses/CMakeLists.txt

@@ -23,7 +23,6 @@ target_sources(swiftSILOptimizer PRIVATE
   LoopCanonicalizer.cpp
   LoopInfoPrinter.cpp
   LoopRegionPrinter.cpp
-  MemBehaviorDumper.cpp
   ModulePrinter.cpp
   RCIdentityDumper.cpp
   SerializeSILPass.cpp

lib/SILOptimizer/UtilityPasses/MemBehaviorDumper.cpp

@@ -815,11 +815,16 @@ void swift::swift_deallocClassInstance(HeapObject *object,
                                        size_t allocatedSize,
                                        size_t allocatedAlignMask) {
   size_t retainCount = swift_retainCount(object);
-  if (SWIFT_UNLIKELY(retainCount > 1))
+  if (SWIFT_UNLIKELY(retainCount > 1)) {
+    auto descriptor = object->metadata->getTypeContextDescriptor();
+
     swift::fatalError(0,
-                      "Object %p deallocated with retain count %zd, reference "
-                      "may have escaped from deinit.\n",
-                      object, retainCount);
+                      "Object %p of class %s deallocated with retain count %zd, "
+                      "reference may have escaped from deinit.\n",
+                      object,
+                      descriptor ? descriptor->Name.get() : "<unknown>",
+                      retainCount);
+  }
 
 #if SWIFT_OBJC_INTEROP
   // We need to let the ObjC runtime clean up any associated objects or weak

stdlib/public/runtime/HeapObject.cpp

@@ -1,4 +1,4 @@
-// RUN: %target-sil-opt %s -aa-kind=basic-aa -mem-behavior-dump -o /dev/null | %FileCheck %s
+// RUN: %target-sil-opt %s -aa-kind=basic-aa -dump-mem-behavior -o /dev/null | %FileCheck %s
 
 // REQUIRES: asserts
 // REQUIRES: swift_in_compiler