[ownership] Change OwnershipDumper to also dump ownership kind map pe…

include/swift/SILOptimizer/PassManager/Passes.def

@@ -289,8 +289,8 @@ PASS(UnsafeGuaranteedPeephole, "unsafe-guaranteed-peephole",
      "SIL retain/release Peephole Removal for Builtin.unsafeGuaranteed")
 PASS(UsePrespecialized, "use-prespecialized",
      "Use Pre-Specialized Functions")
-PASS(ValueOwnershipKindDumper, "value-ownership-kind-dumper",
-     "Print Value Ownership Kind for Testing")
+PASS(OwnershipDumper, "ownership-dumper",
+     "Print Ownership information for Testing")
 PASS(SemanticARCOpts, "semantic-arc-opts",
      "Semantic ARC Optimization")
 PASS(MarkUninitializedFixup, "mark-uninitialized-fixup",

lib/SILOptimizer/UtilityPasses/CMakeLists.txt

@@ -27,5 +27,5 @@ silopt_register_sources(
   SideEffectsDumper.cpp
   SimplifyUnreachableContainingBlocks.cpp
   StripDebugInfo.cpp
-  ValueOwnershipKindDumper.cpp
+  OwnershipDumper.cpp
 )

lib/SILOptimizer/UtilityPasses/OwnershipDumper.cpp

@@ -0,0 +1,77 @@
+//===--- OwnershipDumper.cpp ----------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2018 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
+//
+//===----------------------------------------------------------------------===//
+///
+/// \file
+///
+/// This is a simple utility pass that dumps the ValueOwnershipKind of all
+/// SILValue in a module. It is meant to trigger assertions and verification of
+/// these values.
+///
+//===----------------------------------------------------------------------===//
+
+#include "swift/SIL/SILFunction.h"
+#include "swift/SIL/SILInstruction.h"
+#include "swift/SILOptimizer/PassManager/Passes.h"
+#include "swift/SILOptimizer/PassManager/Transforms.h"
+
+using namespace swift;
+
+//===----------------------------------------------------------------------===//
+//                               Implementation
+//===----------------------------------------------------------------------===//
+
+static void dumpInstruction(SILInstruction &ii) {
+  llvm::outs() << "Visiting: " << ii;
+
+  auto ops = ii.getAllOperands();
+  if (!ops.empty()) {
+    llvm::outs() << "Operand Ownership Map:\n";
+    for (const auto &op : ops) {
+      llvm::outs() << "Op #: " << op.getOperandNumber() << "\n"
+                   << "Ownership Map: " << op.getOwnershipKindMap();
+    }
+  }
+
+  // If the instruction doesn't have any results, bail.
+  auto results = ii.getResults();
+  if (!results.empty()) {
+    llvm::outs() << "Results Ownership Kinds:\n";
+    for (auto v : results) {
+      auto kind = v.getOwnershipKind();
+      llvm::outs() << "Result: " << v;
+      llvm::outs() << "Kind: " << kind << "\n";
+    }
+  }
+}
+
+//===----------------------------------------------------------------------===//
+//                            Top Level Entrypoint
+//===----------------------------------------------------------------------===//
+
+namespace {
+
+class OwnershipDumper : public SILFunctionTransform {
+  void run() override {
+    SILFunction *f = getFunction();
+    llvm::outs() << "*** Dumping Function: '" << f->getName() << "'\n";
+    for (auto &bb : *f) {
+      // We only dump instructions right now.
+      for (auto &ii : bb) {
+        dumpInstruction(ii);
+      }
+    }
+  }
+};
+
+} // end anonymous namespace
+
+SILTransform *swift::createOwnershipDumper() { return new OwnershipDumper(); }

test/SILOptimizer/ownership-kind-dumper.sil

@@ -0,0 +1,35 @@
+// RUN: %target-sil-opt -ownership-dumper %s -o /dev/null | %FileCheck %s
+
+sil_stage canonical
+
+import Builtin
+
+class Klass {}
+
+// CHECK-LABEL: Dumping Function: 'foo'
+// CHECK: Visiting:   %1 = unchecked_ref_cast %0 : $Builtin.NativeObject to $Klass
+// CHECK: Operand Ownership Map:
+// CHECK: Op #: 0
+// CHECK: Ownership Map: -- OperandOwnershipKindMap --
+// CHECK: unowned:  No.
+// CHECK: owned: Yes. Liveness: MustBeInvalidated
+// CHECK: guaranteed:  No.
+// CHECK: any: Yes. Liveness: MustBeLive
+// CHECK: Results Ownership Kinds:
+// CHECK: Result:   %1 = unchecked_ref_cast %0 : $Builtin.NativeObject to $Klass
+// CHECK: Kind: owned
+// CHECK: Visiting:   return %1 : $Klass
+// CHECK: Operand Ownership Map:
+// CHECK: Op #: 0
+// CHECK: Ownership Map: -- OperandOwnershipKindMap --
+// CHECK: unowned:  No.
+// CHECK: owned: Yes. Liveness: MustBeInvalidated
+// CHECK: guaranteed:  No.
+// CHECK: any: Yes. Liveness: MustBeLive
+sil [ossa] @foo : $@convention(thin) (@owned Builtin.NativeObject) -> @owned Klass {
+bb0(%0 : @owned $Builtin.NativeObject):
+  %1 = unchecked_ref_cast %0 : $Builtin.NativeObject to $Klass
+  return %1 : $Klass
+}
+
+