Correctly detect iOS simulator processes.

[aprantl]

Summary

This patch detects when an ios process runs on a macOS host and
updates the target triple with the "simulator" environment.

This is part of https://bugs.swift.org/browse/SR-11971

rdar://problem/58438125

[aprantl]

Here is a more principled variant of the patch. I pushed the logic down to debugserver, so we don't need to guess or fixup anything in LLDB.

[friss]

lldb/tools/debugserver/source/MacOSX/MachProcess.mm

601–607

Why not use the TARGET_OS_OSX and make the selection below be compile time rather than run time?

[jasonmolenda]

Overall looks fine, Fred's comment is correct, nb you want to test it with #if TARGET_OS_OSX == 1, it's always defined either to 0 or 1.

lldb/test/API/functionalities/gdb_remote_client/TestWasm.py

35

TestWasm.pys response to qProcessInfo is different than the default response you added to gdbclientutils.py; it should override the qProcessInfo method to call its own version.

[aprantl]

lldb/test/API/functionalities/gdb_remote_client/TestWasm.py

35

Yes, but I added this line to MockGDBServerResponder.respond().

lldb/source/Plugins/Process/gdb-remote/GDBRemoteCommunicationClient.cpp

if (!response.IsNormalResponse())
     return false;
 
   if (response.GetChar() == 'Q' && response.GetChar() == 'C')
     tid = response.GetHexMaxU32(true, -1);
 
   return true;
 }
 
+static void ParseOSType(llvm::StringRef value, std::string &os_name,
+                        std::string &environment) {
+  if (value.equals("iossimulator") || value.equals("tvossimulator") ||
+      value.equals("watchossimulator")) {
+    environment = "simulator";
+    os_name = value.drop_back(environment.size()).str();
+  } else if (value.equals("maccatalyst")) {
+    os_name = "ios";
+    environment = "macabi";
+  } else {
+    os_name = value.str();
+  }
+}
+
 bool GDBRemoteCommunicationClient::GetHostInfo(bool force) {
   Log *log(ProcessGDBRemoteLog::GetLogIfAnyCategoryIsSet(GDBR_LOG_PROCESS));
 
   if (force || m_qHostInfo_is_valid == eLazyBoolCalculate) {
     // host info computation can require DNS traffic and shelling out to external processes.
     // Increase the timeout to account for that.
     ScopedTimeout timeout(*this, seconds(10));
     m_qHostInfo_is_valid = eLazyBoolNo;
if (SendPacketAndWaitForResponse("qHostInfo", response, false) ==
             StringExtractor extractor(value);
             extractor.GetHexByteString(m_hostname);
             ++num_keys_decoded;
           } else if (name.equals("os_kernel")) {
             StringExtractor extractor(value);
             extractor.GetHexByteString(m_os_kernel);
             ++num_keys_decoded;
           } else if (name.equals("ostype")) {
-            if (value.equals("maccatalyst")) {
-              os_name = "ios";
-              environment = "macabi";
-            } else
-              os_name = std::string(value);
+            ParseOSType(value, os_name, environment);
             ++num_keys_decoded;
           } else if (name.equals("vendor")) {
             vendor_name = std::string(value);
             ++num_keys_decoded;
           } else if (name.equals("endian")) {
             byte_order = llvm::StringSwitch<lldb::ByteOrder>(value)
                              .Case("little", eByteOrderLittle)
                              .Case("big", eByteOrderBig)
if (response.IsNormalResponse()) {
         } else if (name.equals("cpusubtype")) {
           if (!value.getAsInteger(16, sub))
             ++num_keys_decoded;
         } else if (name.equals("triple")) {
           StringExtractor extractor(value);
           extractor.GetHexByteString(triple);
           ++num_keys_decoded;
         } else if (name.equals("ostype")) {
-          if (value.equals("maccatalyst")) {
-            os_name = "ios";
-            environment = "macabi";
-          } else
-            os_name = std::string(value);
+          ParseOSType(value, os_name, environment);
           ++num_keys_decoded;
         } else if (name.equals("vendor")) {
           vendor_name = std::string(value);
           ++num_keys_decoded;
         } else if (name.equals("endian")) {
           byte_order = llvm::StringSwitch<lldb::ByteOrder>(value)
                            .Case("little", eByteOrderLittle)
                            .Case("big", eByteOrderBig)

lldb/test/API/functionalities/gdb_remote_client/TestIOSSimulator.py

+import lldb
+from lldbsuite.test.lldbtest import *
+from lldbsuite.test.decorators import *
+from gdbclientutils import *
+
+class TestIOSSimulator(GDBRemoteTestBase):
+    """
+    Test that an ios simulator process is recognized as such.
+    """
+
+    class MyResponder(MockGDBServerResponder):
+        def __init__(self, host, process):
+            self.host_ostype = host
+            self.process_ostype = process
+            MockGDBServerResponder.__init__(self)
+
+        def qHostInfo(self):
+            return "cputype:16777223;cpusubtype:8;ostype:%s;vendor:apple;os_version:10.15.4;maccatalyst_version:13.4;endian:little;ptrsize:8;"%self.host_ostype
+        def qProcessInfo(self):
+            return "pid:a860;parent-pid:d2a0;real-uid:1f5;real-gid:14;effective-uid:1f5;effective-gid:14;cputype:1000007;cpusubtype:8;ptrsize:8;ostype:%s;vendor:apple;endian:little;"%self.process_ostype
+        def vCont(self):
+            return "vCont;"
+    
+    def platform_test(self, host, process, expected_triple):
+        self.server.responder = self.MyResponder(host, process)
+        if self.TraceOn():
+            self.runCmd("log enable gdb-remote packets")
+            self.addTearDownHook(lambda: self.runCmd("log disable gdb-remote packets"))
+
+        target = self.dbg.CreateTargetWithFileAndArch(None, None)
+        process = self.connect(target)
+        triple = target.GetTriple()
+        self.assertEqual(triple, expected_triple)
+
+    @skipIfRemote
+    def test_macos(self):
+        self.platform_test(host="macosx", process="macosx",
+                           expected_triple="x86_64h-apple-macosx-")
+
+    @skipIfRemote
+    def test_ios_sim(self):
+        self.platform_test(host="macosx", process="iossimulator",
+                           expected_triple="x86_64h-apple-ios-simulator")
+
+    @skipIfRemote
+    def test_catalyst(self):
+        self.platform_test(host="macosx", process="maccatalyst",
+                           expected_triple="x86_64h-apple-ios-macabi")
+
+    @skipIfRemote
+    def test_tvos_sim(self):
+        self.platform_test(host="macosx", process="tvossimulator",
+                           expected_triple="x86_64h-apple-tvos-simulator")
+
+    @skipIfRemote
+    def test_tvos_sim(self):
+        self.platform_test(host="macosx", process="watchossimulator",
+                           expected_triple="x86_64h-apple-watchos-simulator")

lldb/test/API/functionalities/gdb_remote_client/TestWasm.py

class MyResponder(MockGDBServerResponder):
     current_pc = load_address + 0x0a
 
     def __init__(self, obj_path, module_name = ""):
         self._obj_path = obj_path
         self._module_name = module_name or obj_path
         MockGDBServerResponder.__init__(self)
 
     def respond(self, packet):
-        if packet == "qProcessInfo":
-            return self.qProcessInfo()
         if packet[0:13] == "qRegisterInfo":
             return self.qRegisterInfo(packet[13:])
         return MockGDBServerResponder.respond(self, packet)
 
     def qSupported(self, client_supported):
         return "qXfer:libraries:read+;PacketSize=1000;vContSupported-"
 
     def qHostInfo(self):

lldb/test/API/functionalities/gdb_remote_client/gdbclientutils.py

def respond(self, packet):
         if packet == "QListThreadsInStopReply":
             return self.QListThreadsInStopReply()
         if packet.startswith("qMemoryRegionInfo:"):
             return self.qMemoryRegionInfo()
         if packet == "qQueryGDBServer":
             return self.qQueryGDBServer()
         if packet == "qHostInfo":
             return self.qHostInfo()
+        if packet == "qProcessInfo":
+            return self.qProcessInfo()
         if packet == "qGetWorkingDir":
             return self.qGetWorkingDir()
         if packet == "qOffsets":
             return self.qOffsets();
         if packet == "qsProcessInfo":
             return self.qsProcessInfo()
         if packet.startswith("qfProcessInfo"):
             return self.qfProcessInfo(packet)
def qGetWorkingDir(self):
         return "2f"
 
     def qOffsets(self):
         return ""
 
     def qHostInfo(self):
         return "ptrsize:8;endian:little;"
 
+    def qProcessInfo(self):
+        return "pid:1;ptrsize:8;endian:little;"
+    
     def qQueryGDBServer(self):
         return "E04"
 
     def interrupt(self):
         raise self.UnexpectedPacketException()
 
     def cont(self):
         raise self.UnexpectedPacketException()

lldb/tools/debugserver/source/MacOSX/MachProcess.mm

 nub_addr_t MachProcess::GetTSDAddressForThread(
     nub_thread_t tid, uint64_t plo_pthread_tsd_base_address_offset,
     uint64_t plo_pthread_tsd_base_offset, uint64_t plo_pthread_tsd_entry_size) {
   return m_thread_list.GetTSDAddressForThread(
       tid, plo_pthread_tsd_base_address_offset, plo_pthread_tsd_base_offset,
       plo_pthread_tsd_entry_size);
 }
 
+/// Determine whether this is running on macOS.
+/// Since debugserver runs on the same machine as the process, we can
+/// just look at the compilation target.
+static bool IsMacOSHost() {
+#if TARGET_OS_OSX == 1
+  return true;
+#else
+  return false;
+#endif
+}
 
 const char *MachProcess::GetDeploymentInfo(const struct load_command& lc,
                                            uint64_t load_command_address,
                                            uint32_t& major_version,
                                            uint32_t& minor_version,
                                            uint32_t& patch_version) {
   uint32_t cmd = lc.cmd & ~LC_REQ_DYLD;
   bool lc_cmd_known =
     cmd == LC_VERSION_MIN_IPHONEOS || cmd == LC_VERSION_MIN_MACOSX ||
     cmd == LC_VERSION_MIN_TVOS || cmd == LC_VERSION_MIN_WATCHOS;
 
   if (lc_cmd_known) {
     struct version_min_command vers_cmd;
     if (ReadMemory(load_command_address, sizeof(struct version_min_command),
                    &vers_cmd) != sizeof(struct version_min_command)) {
       return nullptr;
     }
     major_version = vers_cmd.sdk >> 16;
     minor_version = (vers_cmd.sdk >> 8) & 0xffu;
     patch_version = vers_cmd.sdk & 0xffu;
 
+    // Handle the older LC_VERSION load commands, which don't
+    // distinguish between simulator and real hardware.
     switch (cmd) {
     case LC_VERSION_MIN_IPHONEOS:
-      return "ios";
+      return IsMacOSHost() ? "iossimulator": "ios";
     case LC_VERSION_MIN_MACOSX:
       return "macosx";
     case LC_VERSION_MIN_TVOS:
-      return "tvos";
+      return IsMacOSHost() ? "tvossimulator": "tvos";
     case LC_VERSION_MIN_WATCHOS:
-      return "watchos";
+      return IsMacOSHost() ? "watchossimulator" : "watchos";
     default:
       return nullptr;
     }
   }
 #if defined (LC_BUILD_VERSION)
   if (cmd == LC_BUILD_VERSION) {
     struct build_version_command build_vers;
     if (ReadMemory(load_command_address, sizeof(struct build_version_command),
                    &build_vers) != sizeof(struct build_version_command)) {
       return nullptr;
     }
     major_version = build_vers.sdk >> 16;;
     minor_version = (build_vers.sdk >> 8) & 0xffu;
     patch_version = build_vers.sdk & 0xffu;
 
     switch (build_vers.platform) {
     case PLATFORM_MACOS:
       return "macosx";
     case PLATFORM_MACCATALYST:
       return "maccatalyst";
     case PLATFORM_IOS:
-    case PLATFORM_IOSSIMULATOR:
       return "ios";
+    case PLATFORM_IOSSIMULATOR:
+      return "iossimulator";
     case PLATFORM_TVOS:
-    case PLATFORM_TVOSSIMULATOR:
       return "tvos";
+    case PLATFORM_TVOSSIMULATOR:
+      return "tvossimulator";
     case PLATFORM_WATCHOS:
-    case PLATFORM_WATCHOSSIMULATOR:
       return "watchos";
+    case PLATFORM_WATCHOSSIMULATOR:
+      return "watchossimulator";
     case PLATFORM_BRIDGEOS:
       return "bridgeos";
     case PLATFORM_DRIVERKIT:
       return "driverkit";
     }
   }
 #endif
   return nullptr;