Merge pull request #41620 from mikeash/fix-swift-inspect-darwin

[swift-inspect] Fix the swift-inspect build on Darwin.

Author: mikeash

tools/swift-inspect/Sources/swift-inspect/DarwinRemoteProcess.swift

@@ -13,7 +13,7 @@
 #if os(iOS) || os(macOS) || os(tvOS) || os(watchOS)
 
 import SwiftRemoteMirror
-@_implementationOnly import SymbolicationShims
+import SymbolicationShims
 
 internal final class DarwinRemoteProcess: RemoteProcess {
   public typealias ProcessIdentifier = pid_t
@@ -23,8 +23,10 @@ internal final class DarwinRemoteProcess: RemoteProcess {
 
   public var process: ProcessHandle { task }
   public private(set) var context: SwiftReflectionContextRef!
+  private var symbolicator: CSSymbolicatorRef
 
   private var swiftCore: CSTypeRef
+  private let swiftConcurrency: CSTypeRef
 
   static var QueryDataLayout: QueryDataLayoutFunction {
     return { (context, type, _, output) in
@@ -38,7 +40,7 @@ internal final class DarwinRemoteProcess: RemoteProcess {
 
       case DLQ_GetPtrAuthMask:
         let mask = GetPtrauthMask()
-        output.storeBytes(of: mask, toByteOffset: 0, as: UInt.size)
+        output.storeBytes(of: mask, toByteOffset: 0, as: UInt.self)
         return 1
 
       case DLQ_GetObjCReservedLowBits:
@@ -65,10 +67,25 @@ internal final class DarwinRemoteProcess: RemoteProcess {
     }
   }
 
+  func read(address: swift_addr_t, size: Int) -> UnsafeRawPointer? {
+    return task_peek(task, address, mach_vm_size_t(size))
+  }
+
+  func getAddr(symbolName: String) -> swift_addr_t {
+    // FIXME: use `__USER_LABEL_PREFIX__` instead of the hardcoded `_`.
+    let fullName = "_\(symbolName)"
+    let symbol = CSSymbolOwnerGetSymbolWithMangledName(swiftCore, fullName)
+    if CSIsNull(symbol) {
+      symbol = CSSymbolOwnerGetSymbolWithMangledName(swiftConcurrency, fullName)
+    }
+    let range = CSSymbolGetRange(symbol)
+    return swift_addr_t(range.location)
+  }
+
   static var ReadBytes: ReadBytesFunction {
     return { (context, address, size, _) in
       let process: DarwinRemoteProcess = DarwinRemoteProcess.fromOpaque(context!)
-      return task_peek(process.task, address, size)
+      return process.read(address: address, size: Int(size))
     }
   }
 
@@ -90,11 +107,7 @@ internal final class DarwinRemoteProcess: RemoteProcess {
         let buffer = UnsafeBufferPointer(start: $0, count: Int(length))
         return String(decoding: buffer, as: UTF8.self)
       }
-
-      let symbol =
-          CSSymbolOwnerGetSymbolWithMangledName(process.swiftCore, "_\(name)")
-      // FIXME: use `__USER_LABEL_PREFIX__` instead of the hardcoded `_`.
-      return swift_addr_t(CSSymbolGetRange(symbol).location)
+      return process.getAddr(symbolName: name)
     }
   }
 
@@ -107,6 +120,14 @@ internal final class DarwinRemoteProcess: RemoteProcess {
     }
     self.task = task
 
+    self.symbolicator = CSSymbolicatorCreateWithTask(self.task)
+    self.swiftCore =
+        CSSymbolicatorGetSymbolOwnerWithNameAtTime(self.symbolicator,
+                                                   "libswiftCore.dylib", kCSNow)
+    self.swiftConcurrency = CSSymbolicatorGetSymbolOwnerWithNameAtTime(
+      symbolicator, "libswift_Concurrency.dylib", kCSNow)
+    _ = task_start_peeking(self.task)
+
     guard let context =
         swift_reflection_createReflectionContextWithDataLayout(self.toOpaqueRef(),
                                                                Self.QueryDataLayout,
@@ -116,12 +137,7 @@ internal final class DarwinRemoteProcess: RemoteProcess {
                                                                Self.GetSymbolAddress) else {
       return nil
     }
-
-    self.symbolicator = CSSymbolicatorCreateWithTask(self.task)
-    self.swiftCore =
-        CSSymbolicatorGetSymbolOwnerWithNameAtTime(self.symbolicator,
-                                                   "libswiftCore.dylib", kCSNow)
-    _ = task_start_peeking(self.task)
+    self.context = context
 
     _ = CSSymbolicatorForeachSymbolOwnerAtTime(self.symbolicator, kCSNow, { owner in
       let address = CSSymbolOwnerGetBaseAddress(owner)
@@ -136,7 +152,7 @@ internal final class DarwinRemoteProcess: RemoteProcess {
 
   func symbolicate(_ address: swift_addr_t) -> (module: String?, symbol: String?) {
     let symbol =
-        CSSymbolicatorGetSymbolWithAddressAtTime(sself.symbolicator, address, kCSNow)
+        CSSymbolicatorGetSymbolWithAddressAtTime(self.symbolicator, address, kCSNow)
 
     let module = CSSymbolGetSymbolOwner(symbol)
     return (CSSymbolOwnerGetName(module), CSSymbolGetName(symbol))
@@ -151,8 +167,9 @@ internal final class DarwinRemoteProcess: RemoteProcess {
                                      { (task, context, type, ranges, count) in
           let callback: (swift_addr_t, UInt64) -> Void =
               context!.assumingMemoryBound(to: ((swift_addr_t, UInt64) -> Void).self).pointee
-          ranges.forEach {
-            callback(swift_addr_t($0.address), UInt64($0.size))
+          for i in 0..<Int(count) {
+            let range = ranges[i]
+            callback(swift_addr_t(range.address), UInt64(range.size))
           }
         })
       }
@@ -196,24 +213,24 @@ extension DarwinRemoteProcess {
           let result =
               thread_info(threadList![i], thread_flavor_t(THREAD_IDENTIFIER_INFO),
                           $0, &infoCount)
-          guard result == ERROR_SUCCESS else {
+          guard result == KERN_SUCCESS else {
             print("unable to get info for thread \(i): \(String(cString: mach_error_string(result))) (0x\(String(result, radix: 16)))")
             return
           }
+        }
+      }
 
-          let tlsStart = info.thread_handle
-          if tlsStart == 0 { return }
+      let tlsStart = info.thread_handle
+      if tlsStart == 0 { continue }
 
-          let SWIFT_CONCURRENCY_TASK_KEY = 103
-          let currentTaskPointer = tlsStart + UInt64(SWIFT_CONCURRENCY_TASK_KEY * MemoryLayout<UnsafeRawPointer>.size)
-          if let pointer = ReadBytes(currentTaskPointer, size: MemoryLayout<UnsafeRawPointer>.size) {
-            let currentTask = pointer.load(as: UInt.self)
-            results.append((threadID: info.thread_id, currentTask: swift_addr_t(currentTask)))
-          }
-        }
+      let SWIFT_CONCURRENCY_TASK_KEY = 103
+      let currentTaskPointer = tlsStart + UInt64(SWIFT_CONCURRENCY_TASK_KEY * MemoryLayout<UnsafeRawPointer>.size)
+      if let pointer = read(address: currentTaskPointer, size: MemoryLayout<UnsafeRawPointer>.size) {
+        let currentTask = pointer.load(as: UInt.self)
+        results.append((threadID: info.thread_id, currentTask: swift_addr_t(currentTask)))
       }
     }
-    return result
+    return results
   }
 }
 

tools/swift-inspect/Sources/swift-inspect/Operations/DumpConcurrency.swift

@@ -12,6 +12,7 @@
 
 #if os(iOS) || os(macOS) || os(tvOS) || os(watchOS)
 
+import ArgumentParser
 import SwiftRemoteMirror
 
 struct DumpConcurrency: ParsableCommand {
@@ -60,7 +61,7 @@ fileprivate class ConcurrencyDumper {
 
   lazy var heapInfo: HeapInfo = gatherHeapInfo()
 
-  lazy var threadCurrentTasks = process.threadCurrentTasks().filter{ $0.currentTask != 0 }
+  lazy var threadCurrentTasks = process.currentTasks.filter{ $0.currentTask != 0 }
 
   lazy var tasks: [swift_reflection_ptr_t: TaskInfo] = gatherTasks()
 
@@ -76,8 +77,8 @@ fileprivate class ConcurrencyDumper {
     self.process = process
 
     func getMetadata(symbolName: String) -> swift_reflection_ptr_t? {
-      let addr = process.GetSymbolAddress(symbolName)
-      if let ptr = process.ReadBytes(addr, MemoryLayout<UInt>.size) {
+      let addr = process.getAddr(symbolName: symbolName)
+      if let ptr = process.read(address: addr, size: MemoryLayout<UInt>.size) {
         return swift_reflection_ptr_t(ptr.load(as: UInt.self))
       }
       return nil
@@ -148,7 +149,7 @@ fileprivate class ConcurrencyDumper {
       return cached
     }
 
-    let name = context.name(metadata: metadata)
+    let name = context.name(type: metadata)
     metadataNameCache[metadata] = name
     return name
   }

tools/swift-inspect/Sources/swift-inspect/Symbolication+Extensions.swift

@@ -231,4 +231,10 @@ func task_enumerate_malloc_blocks(
   Sym.task_enumerate_malloc_blocks(task, context, type_mask, recorder)
 }
 
+func machErrStr(_ kr: kern_return_t) -> String {
+  let errStr = String(cString: mach_error_string(kr))
+  let errHex = String(kr, radix: 16)
+  return "\(errStr) (0x\(errHex))"
+}
+
 #endif