Merge pull request #25705 from mikeash/more-dump-methods

[Runtime] Add dump() methods to TypeContextDescriptor and EnumDescriptor.

Author: mikeash

include/swift/ABI/Metadata.h

@@ -3637,6 +3637,11 @@ class TargetTypeContextDescriptor
     return cd->getKind() >= ContextDescriptorKind::Type_First
         && cd->getKind() <= ContextDescriptorKind::Type_Last;
   }
+
+#ifndef NDEBUG
+  LLVM_ATTRIBUTE_DEPRECATED(void dump() const,
+                            "Only meant for use in the debugger");
+#endif
 };
 
 using TypeContextDescriptor = TargetTypeContextDescriptor<InProcess>;
@@ -4238,6 +4243,11 @@ class TargetEnumDescriptor final
   static bool classof(const TargetContextDescriptor<Runtime> *cd) {
     return cd->getKind() == ContextDescriptorKind::Enum;
   }
+
+#ifndef NDEBUG
+  LLVM_ATTRIBUTE_DEPRECATED(void dump() const,
+                            "Only meant for use in the debugger");
+#endif
 };
 
 using EnumDescriptor = TargetEnumDescriptor<InProcess>;

stdlib/public/runtime/Metadata.cpp

@@ -3934,6 +3934,10 @@ StringRef swift::getStringForMetadataKind(MetadataKind kind) {
   }
 }
 
+/***************************************************************************/
+/*** Debugging dump methods ************************************************/
+/***************************************************************************/
+
 #ifndef NDEBUG
 template <>
 LLVM_ATTRIBUTE_USED
@@ -3945,6 +3949,33 @@ void Metadata::dump() const {
   printf("Type Context Description: %p.\n", getTypeContextDescriptor());
   printf("Generic Args: %p.\n", getGenericArgs());
 }
+
+template <>
+LLVM_ATTRIBUTE_USED
+void TypeContextDescriptor::dump() const {
+  printf("TargetTypeContextDescriptor.\n");
+  printf("Flags: 0x%x.\n", this->Flags);
+  printf("Parent: %p.\n", this->Parent.get());
+  printf("Name: %s.\n", Name.get());
+  printf("Access function: %p.\n", getAccessFunction());
+  printf("Fields: %p.\n", Fields.get());
+}
+
+template<>
+LLVM_ATTRIBUTE_USED
+void EnumDescriptor::dump() const {
+  printf("TargetEnumDescriptor.\n");
+  printf("Flags: 0x%x.\n", this->Flags);
+  printf("Parent: %p.\n", this->Parent.get());
+  printf("Name: %s.\n", Name.get());
+  printf("Access function: %p.\n", getAccessFunction());
+  printf("Fields: %p.\n", Fields.get());
+  printf("NumPayloadCasesAndPayloadSizeOffset: 0x%08x "
+         "(payload cases: %u - payload size offset: %u).\n",
+         NumPayloadCasesAndPayloadSizeOffset,
+         getNumPayloadCases(), getPayloadSizeOffset());
+  printf("NumEmptyCases: %u\n", NumEmptyCases);
+}
 #endif
 
 /***************************************************************************/