Separate raw metadata and generic metadata dump commands

Author: airspeedswift

tools/swift-inspect/Sources/swift-inspect/Metadata.swift

@@ -42,7 +42,23 @@ extension Allocation {
   }
 }
 
+extension BidirectionalCollection where Element == Allocation {
+  func findGenericMetadata(in context: SwiftReflectionContextRef) -> [Metadata] {
+    var metadatas = self.compactMap { $0.metadata(in: context) }
+    for i in metadatas.indices {
+      let metadata = metadatas[i]
+      if let allocation = self.last(where: { metadata.ptr >= $0.ptr }) {
+        metadatas[i].allocation = allocation
+      }
+    }
+    return metadatas
+  }
+}
+
 struct Metadata {
   let ptr: swift_reflection_ptr_t
+  var allocation: Allocation? = nil
   let name: String
+  
+  var offset: Int? { allocation.map { Int(self.ptr - $0.ptr) } }
 }

tools/swift-inspect/Sources/swift-inspect/main.swift

@@ -33,27 +33,29 @@ func dumpConformanceCache(context: SwiftReflectionContextRef) throws {
   }
 }
 
-func dumpMetadataAllocations(context: SwiftReflectionContextRef) throws {
-  var allocations = context.allocations
-  for allocation in allocations {
+func dumpRawMetadata(context: SwiftReflectionContextRef) throws {
+  for allocation in context.allocations {
     print("Metadata allocation at: \(hex: allocation.ptr) " +
           "size: \(allocation.size) tag: \(allocation.tag)")
   }
-  
-  allocations.sort()
-  let metadatas = allocations.compactMap { $0.metadata(in: context) }
+}
+
+func dumpGenericMetadata(context: SwiftReflectionContextRef) throws {
+  let allocations = context.allocations.sorted()
+  let metadatas = allocations.findGenericMetadata(in: context)
 
+  print("Address","Allocation","Size","Offset","Name", separator: "\t")
   for metadata in metadatas {
-    print("Metadata \(hex: metadata.ptr)")
-    print("    Name: \(metadata.name)")
+    print("\(hex: metadata.ptr)", terminator: "\t")
 
-    if let allocation = allocations.last(where: { metadata.ptr >= $0.ptr }) {
-      let offset = metadata.ptr - allocation.ptr
-      print("    In allocation \(hex: allocation.ptr) " +
-            "size \(allocation.size) at offset \(offset)")
+    if let allocation = metadata.allocation, let offset = metadata.offset {
+      print("\(hex: allocation.ptr)\t\(allocation.size)\t\(offset)",
+            terminator: "\t")
     } else {
-      print("    Not in any known metadata allocation. How strange.")
+      print("???\t???\t???", terminator: "\t")
+
     }
+    print(metadata.name)
   }
 }
 
@@ -99,7 +101,8 @@ struct SwiftInspect: ParsableCommand {
     abstract: "Swift runtime debug tool",
     subcommands: [
       DumpConformanceCache.self,
-      DumpMetadataAllocations.self,
+      DumpRawMetadata.self,
+      DumpGenericMetadata.self,
     ])
 }
 
@@ -117,7 +120,21 @@ struct DumpConformanceCache: ParsableCommand {
   }
 }
 
-struct DumpMetadataAllocations: ParsableCommand {
+struct DumpRawMetadata: ParsableCommand {
+  static let configuration = CommandConfiguration(
+    abstract: "Print the target's metadata allocations.")
+  @Argument(help: "The pid or partial name of the target process")
+
+  var nameOrPid: String
+
+  func run() throws {
+    try withReflectionContext(nameOrPid: nameOrPid) {
+      try dumpRawMetadata(context: $0)
+    }
+  }
+}
+
+struct DumpGenericMetadata: ParsableCommand {
   static let configuration = CommandConfiguration(
     abstract: "Print the target's metadata allocations.")
   @Argument(help: "The pid or partial name of the target process")
@@ -126,7 +143,7 @@ struct DumpMetadataAllocations: ParsableCommand {
 
   func run() throws {
     try withReflectionContext(nameOrPid: nameOrPid) {
-      try dumpMetadataAllocations(context: $0)
+      try dumpGenericMetadata(context: $0)
     }
   }
 }