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 ↗

(On Diff #248634)

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 (pointer_byte_size) {
           assert(pointer_byte_size == m_process_arch.GetAddressByteSize());
         }
         if (byte_order != eByteOrderInvalid) {
           assert(byte_order == m_process_arch.GetByteOrder());
         }
-        m_process_arch.GetTriple().setVendorName(llvm::StringRef(vendor_name));
-        m_process_arch.GetTriple().setOSName(llvm::StringRef(os_name));
-        m_process_arch.GetTriple().setEnvironmentName(llvm::StringRef(environment));
-        m_host_arch.GetTriple().setVendorName(llvm::StringRef(vendor_name));
-        m_host_arch.GetTriple().setOSName(llvm::StringRef(os_name));
-        m_host_arch.GetTriple().setEnvironmentName(llvm::StringRef(environment));
+        auto &process_triple = m_process_arch.GetTriple();
+        process_triple.setVendorName(llvm::StringRef(vendor_name));
+        process_triple.setOSName(llvm::StringRef(os_name));
+        process_triple.setEnvironmentName(llvm::StringRef(environment));
+
+        // Detect iOS simulators and set the environment
+        // accordingly. The remote server reads the process info out
+        // of the Mach-O load commands, which don't distinguish
+        // between simulator and the real hardware.
+        if (m_host_arch.GetTriple().getOS() == llvm::Triple::MacOSX) {
+          if (!process_triple.hasEnvironment()) {
+            auto process_os = process_triple.getOS();
+            if (process_os == llvm::Triple::IOS ||
+                process_os == llvm::Triple::TvOS ||
+                process_os == llvm::Triple::WatchOS)
+              process_triple.setEnvironment(llvm::Triple::Simulator);
+          }
+        }
       }
       return true;
     }
   } else {
     m_qProcessInfo_is_valid = eLazyBoolNo;
   }
 
   return false;

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):
+
+    @skipIfRemote
+    def test(self):
+        """
+        Test that an ios simulator process is recognized as such.
+        """
+        class MyResponder(MockGDBServerResponder):
+
+            def qHostInfo(self):
+                return "cputype:16777223;cpusubtype:8;ostype:macosx;watchpoint_exceptions_received:after;vendor:apple;os_version:10.15.4;maccatalyst_version:13.4;endian:little;ptrsize:8;"
+            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:ios;vendor:apple;endian:little;"
+            def vCont(self):
+                return "vCont;"
+
+        self.server.responder = MyResponder()
+        if self.TraceOn():
+            self.runCmd("log enable gdb-remote packets")
+            self.addTearDownHook(
+                    lambda: self.runCmd("log disable gdb-remote packets"))
+
+        #self.dbg.SetDefaultArchitecture("armv7em")
+        target = self.dbg.CreateTargetWithFileAndArch(None, None)
+        process = self.connect(target)
+        triple = target.GetTriple()
+        self.assertEqual(triple, "x86_64h-apple-ios-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()