[ownership] Add dumper/print methods for various OwnershipUtils.h helper structs.

Author: gottesmm

include/swift/SIL/OwnershipUtils.h

@@ -236,9 +236,12 @@ struct BorrowScopeOperandKind {
   }
 
   void print(llvm::raw_ostream &os) const;
-  SWIFT_DEBUG_DUMP;
+  SWIFT_DEBUG_DUMP { print(llvm::dbgs()); }
 };
 
+llvm::raw_ostream &operator<<(llvm::raw_ostream &os,
+                              BorrowScopeOperandKind kind);
+
 /// An operand whose user instruction introduces a new borrow scope for the
 /// operand's value. The value of the operand must be considered as implicitly
 /// borrowed until the user's corresponding end scope instruction.
@@ -278,6 +281,9 @@ struct BorrowScopeOperand {
     llvm_unreachable("Covered switch isn't covered");
   }
 
+  void print(llvm::raw_ostream &os) const;
+  SWIFT_DEBUG_DUMP { print(llvm::dbgs()); }
+
 private:
   /// Internal constructor for failable static constructor. Please do not expand
   /// its usage since it assumes the code passed in is well formed.
@@ -286,7 +292,7 @@ struct BorrowScopeOperand {
 };
 
 llvm::raw_ostream &operator<<(llvm::raw_ostream &os,
-                              BorrowScopeOperandKind kind);
+                              const BorrowScopeOperand &operand);
 
 struct BorrowScopeIntroducingValueKind {
   using UnderlyingKindTy = std::underlying_type<ValueKind>::type;
@@ -336,7 +342,7 @@ struct BorrowScopeIntroducingValueKind {
   }
 
   void print(llvm::raw_ostream &os) const;
-  SWIFT_DEBUG_DUMP;
+  SWIFT_DEBUG_DUMP { print(llvm::dbgs()); }
 };
 
 llvm::raw_ostream &operator<<(llvm::raw_ostream &os,
@@ -419,6 +425,9 @@ struct BorrowScopeIntroducingValue {
                              SmallPtrSetImpl<SILBasicBlock *> &visitedBlocks,
                              DeadEndBlocks &deadEndBlocks) const;
 
+  void print(llvm::raw_ostream &os) const;
+  SWIFT_DEBUG_DUMP { print(llvm::dbgs()); }
+
 private:
   /// Internal constructor for failable static constructor. Please do not expand
   /// its usage since it assumes the code passed in is well formed.
@@ -427,6 +436,9 @@ struct BorrowScopeIntroducingValue {
       : kind(kind), value(value) {}
 };
 
+llvm::raw_ostream &operator<<(llvm::raw_ostream &os,
+                              const BorrowScopeIntroducingValue &value);
+
 /// Look up through the def-use chain of \p inputValue, recording any "borrow"
 /// introducing values that we find into \p out. If at any point, we find a
 /// point in the chain we do not understand, we bail and return false. If we are

lib/SIL/OwnershipUtils.cpp

@@ -87,6 +87,41 @@ bool swift::isOwnershipForwardingInst(SILInstruction *i) {
   return isOwnershipForwardingValueKind(SILNodeKind(i->getKind()));
 }
 
+//===----------------------------------------------------------------------===//
+//                           Borrow Scope Operand
+//===----------------------------------------------------------------------===//
+
+void BorrowScopeOperandKind::print(llvm::raw_ostream &os) const {
+  switch (value) {
+  case Kind::BeginBorrow:
+    os << "BeginBorrow";
+    return;
+  case Kind::BeginApply:
+    os << "BeginApply";
+    return;
+  }
+  llvm_unreachable("Covered switch isn't covered?!");
+}
+
+llvm::raw_ostream &swift::operator<<(llvm::raw_ostream &os,
+                                     BorrowScopeOperandKind kind) {
+  kind.print(os);
+  return os;
+}
+
+void BorrowScopeOperand::print(llvm::raw_ostream &os) const {
+  os << "BorrowScopeOperand:\n"
+        "Kind: " << kind << "\n"
+        "Value: " << op->get()
+     << "User: " << op->getUser();
+}
+
+llvm::raw_ostream &swift::operator<<(llvm::raw_ostream &os,
+                                     const BorrowScopeOperand &operand) {
+  operand.print(os);
+  return os;
+}
+
 //===----------------------------------------------------------------------===//
 //                             Borrow Introducers
 //===----------------------------------------------------------------------===//
@@ -106,12 +141,6 @@ void BorrowScopeIntroducingValueKind::print(llvm::raw_ostream &os) const {
   llvm_unreachable("Covered switch isn't covered?!");
 }
 
-void BorrowScopeIntroducingValueKind::dump() const {
-#ifndef NDEBUG
-  print(llvm::dbgs());
-#endif
-}
-
 void BorrowScopeIntroducingValue::getLocalScopeEndingInstructions(
     SmallVectorImpl<SILInstruction *> &scopeEndingInsts) const {
   assert(isLocalScope() && "Should only call this given a local scope");
@@ -206,6 +235,12 @@ llvm::raw_ostream &swift::operator<<(llvm::raw_ostream &os,
   return os;
 }
 
+llvm::raw_ostream &swift::operator<<(llvm::raw_ostream &os,
+                                     const BorrowScopeIntroducingValue &value) {
+  value.print(os);
+  return os;
+}
+
 bool BorrowScopeIntroducingValue::areInstructionsWithinScope(
     ArrayRef<SILInstruction *> instructions,
     SmallVectorImpl<SILInstruction *> &scratchSpace,