Fix debugserver's qProcessInfo reporting of maccatalyst binaries

adrian-prantl · adrian-prantl · commit 7e9bab6ad51a · 2020-08-04T16:42:14.000-07:00
This patch is similar in spirit to https://reviews.llvm.org/D84480, but does the maccatalyst/macosx disambiguation. I also took the opportunity to factor out the gdb-remote packet log scanning used by several testcases into lldbutil functions. rdar://problem/66059257 Differential Revision: https://reviews.llvm.org/D84576
diff --git a/lldb/packages/Python/lldbsuite/test/lldbutil.py b/lldb/packages/Python/lldbsuite/test/lldbutil.py
@@ -1458,3 +1458,40 @@ def wait_for_file_on_target(testcase, file_path, max_attempts=6):
             (file_path, max_attempts))
 
     return read_file_on_target(testcase, file_path)
+
+def packetlog_get_process_info(log):
+    """parse a gdb-remote packet log file and extract the response to qProcessInfo"""
+    process_info = dict()
+    with open(log, "r") as logfile:
+        process_info_ostype = None
+        expect_process_info_response = False
+        for line in logfile:
+            if expect_process_info_response:
+                for pair in line.split(';'):
+                    keyval = pair.split(':')
+                    if len(keyval) == 2:
+                        process_info[keyval[0]] = keyval[1]
+                break
+            if 'send packet: $qProcessInfo#' in line:
+                expect_process_info_response = True
+    return process_info
+
+def packetlog_get_dylib_info(log):
+    """parse a gdb-remote packet log file and extract the *last* response to jGetLoadedDynamicLibrariesInfos"""
+    import json
+    dylib_info = None
+    with open(log, "r") as logfile:
+        dylib_info = None
+        expect_dylib_info_response = False
+        for line in logfile:
+            if expect_dylib_info_response:
+                while line[0] != '$':
+                    line = line[1:]
+                line = line[1:]
+                # Unescape '}'.
+                dylib_info = json.loads(line.replace('}]','}')[:-4])
+                expect_dylib_info_response = False
+            if 'send packet: $jGetLoadedDynamicLibrariesInfos:{' in line:
+                expect_dylib_info_response = True
+
+    return dylib_info
diff --git a/lldb/test/API/macosx/macCatalyst/Makefile b/lldb/test/API/macosx/macCatalyst/Makefile
@@ -0,0 +1,10 @@
+C_SOURCES := main.c
+
+TRIPLE := $(ARCH)-apple-ios13.0-macabi
+CFLAGS_EXTRAS := -target $(TRIPLE)
+
+# FIXME: rdar://problem/54986190
+# There is a Clang driver change missing on llvm.org.
+override CC=xcrun clang
+
+include Makefile.rules
diff --git a/lldb/test/API/macosx/macCatalyst/TestMacCatalyst.py b/lldb/test/API/macosx/macCatalyst/TestMacCatalyst.py
@@ -0,0 +1,43 @@
+import lldb
+from lldbsuite.test.lldbtest import *
+from lldbsuite.test.decorators import *
+import lldbsuite.test.lldbutil as lldbutil
+import os
+import unittest2
+
+
+class TestMacCatalyst(TestBase):
+
+    mydir = TestBase.compute_mydir(__file__)
+
+    @skipIf(macos_version=["<", "10.15"])
+    @skipUnlessDarwin
+    @skipIfDarwinEmbedded
+    @skipIfReproducer # This is hitting https://bugs.python.org/issue22393
+    def test_macabi(self):
+        """Test the x86_64-apple-ios-macabi target linked against a macos dylib"""
+        self.build()
+        log = self.getBuildArtifact('packets.log')
+        self.expect("log enable gdb-remote packets -f "+log)
+        lldbutil.run_to_source_breakpoint(self, "break here",
+                                          lldb.SBFileSpec('main.c'))
+        self.expect("image list -t -b",
+                    patterns=[self.getArchitecture() +
+                              r'.*-apple-ios.*-macabi a\.out'])
+        self.expect("fr v s", "Hello macCatalyst")
+        self.expect("p s", "Hello macCatalyst")
+        self.check_debugserver(log)
+
+    def check_debugserver(self, log):
+        """scan the debugserver packet log"""
+        process_info = lldbutil.packetlog_get_process_info(log)
+        self.assertTrue('ostype' in process_info)
+        self.assertEquals(process_info['ostype'], 'maccatalyst')
+
+        aout_info = None
+        dylib_info = lldbutil.packetlog_get_dylib_info(log)
+        for image in dylib_info['images']:
+            if image['pathname'].endswith('a.out'):
+                aout_info = image
+        self.assertTrue(aout_info)
+        self.assertEquals(aout_info['min_version_os_name'], 'maccatalyst')
diff --git a/lldb/test/API/macosx/macCatalyst/main.c b/lldb/test/API/macosx/macCatalyst/main.c
@@ -0,0 +1,4 @@
+int main() {
+  const char *s = "Hello macCatalyst!";
+  return 0; // break here
+}
diff --git a/lldb/test/API/macosx/macCatalystAppMacOSFramework/Makefile b/lldb/test/API/macosx/macCatalystAppMacOSFramework/Makefile
@@ -1,9 +1,12 @@
 C_SOURCES := main.c
 LD_EXTRAS := -L. -lfoo
 
-TRIPLE := x86_64-apple-ios13.0-macabi
+TRIPLE := $(ARCH)-apple-ios13.0-macabi
 CFLAGS_EXTRAS := -target $(TRIPLE)
 
+# FIXME: rdar://problem/54986190
+override CC=xcrun clang
+
 all: libfoo.dylib a.out
 
 libfoo.dylib: foo.c
diff --git a/lldb/test/API/macosx/macCatalystAppMacOSFramework/TestMacCatalystAppWithMacOSFramework.py b/lldb/test/API/macosx/macCatalystAppMacOSFramework/TestMacCatalystAppWithMacOSFramework.py
@@ -0,0 +1,51 @@
+import lldb
+from lldbsuite.test.lldbtest import *
+from lldbsuite.test.decorators import *
+import lldbsuite.test.lldbutil as lldbutil
+import os
+import unittest2
+
+
+class TestMacCatalystAppWithMacOSFramework(TestBase):
+
+    mydir = TestBase.compute_mydir(__file__)
+
+    @skipIf(macos_version=["<", "10.15"])
+    @skipUnlessDarwin
+    @skipIfDarwinEmbedded
+    # There is a Clang driver change missing on llvm.org.
+    @expectedFailureAll(bugnumber="rdar://problem/54986190>")
+    @skipIfReproducer # This is hitting https://bugs.python.org/issue22393
+    def test(self):
+        """Test the x86_64-apple-ios-macabi target linked against a macos dylib"""
+        self.build()
+        log = self.getBuildArtifact('packets.log')
+        self.expect("log enable gdb-remote packets -f "+log)
+        lldbutil.run_to_source_breakpoint(self, "break here",
+                                          lldb.SBFileSpec('main.c'))
+        arch = self.getArchitecture()
+        self.expect("image list -t -b",
+                    patterns=[arch + r'.*-apple-ios.*-macabi a\.out',
+                              arch + r'.*-apple-macosx.* libfoo.dylib[^(]'])
+        self.expect("fr v s", "Hello macCatalyst")
+        self.expect("p s", "Hello macCatalyst")
+        self.check_debugserver(log)
+
+    def check_debugserver(self, log):
+        """scan the debugserver packet log"""
+        process_info = lldbutil.packetlog_get_process_info(log)
+        self.assertTrue('ostype' in process_info)
+        self.assertEquals(process_info['ostype'], 'maccatalyst')
+
+        aout_info = None
+        libfoo_info = None
+        dylib_info = lldbutil.packetlog_get_dylib_info(log)
+        for image in dylib_info['images']:
+            if image['pathname'].endswith('a.out'):
+                aout_info = image
+            if image['pathname'].endswith('libfoo.dylib'):
+                libfoo_info = image
+        self.assertTrue(aout_info)
+        self.assertTrue(libfoo_info)
+        self.assertEquals(aout_info['min_version_os_name'], 'maccatalyst')
+        self.assertEquals(libfoo_info['min_version_os_name'], 'macosx')
diff --git a/lldb/test/API/macosx/macCatalystAppMacOSFramework/foo.c b/lldb/test/API/macosx/macCatalystAppMacOSFramework/foo.c
diff --git a/lldb/test/API/macosx/macCatalystAppMacOSFramework/foo.h b/lldb/test/API/macosx/macCatalystAppMacOSFramework/foo.h
diff --git a/lldb/test/API/macosx/macCatalystAppMacOSFramework/main.c b/lldb/test/API/macosx/macCatalystAppMacOSFramework/main.c
@@ -1,5 +1,5 @@
 #include "foo.h"
 int main() {
-  const char *s = "Hello MacABI!";
+  const char *s = "Hello macCatalyst!";
   return foo(); // break here
 }
diff --git a/lldb/test/API/macosx/macabi/TestMacABImacOSFramework.py b/lldb/test/API/macosx/macabi/TestMacABImacOSFramework.py
diff --git a/lldb/test/API/macosx/simulator/TestSimulatorPlatform.py b/lldb/test/API/macosx/simulator/TestSimulatorPlatform.py
@@ -25,30 +25,10 @@ def check_load_commands(self, expected_load_command):
 
     def check_debugserver(self, log, expected_platform, expected_version):
         """scan the debugserver packet log"""
-        logfile = open(log, "r")
-        dylib_info = None
-        process_info_ostype = None
-        expect_dylib_info_response = False
-        expect_process_info_response = False
-        for line in logfile:
-            if expect_dylib_info_response:
-                while line[0] != '$':
-                    line = line[1:]
-                line = line[1:]
-                # Unescape '}'.
-                dylib_info = json.loads(line.replace('}]','}')[:-4])
-                expect_dylib_info_response = False
-            if 'send packet: $jGetLoadedDynamicLibrariesInfos:{' in line:
-                expect_dylib_info_response = True
-            if expect_process_info_response:
-                for pair in line.split(';'):
-                    keyval = pair.split(':')
-                    if len(keyval) == 2 and keyval[0] == 'ostype':
-                        process_info_ostype = keyval[1]
-            if 'send packet: $qProcessInfo#' in line:
-                expect_process_info_response = True
-
-        self.assertEquals(process_info_ostype, expected_platform)
+        process_info = lldbutil.packetlog_get_process_info(log)
+        self.assertTrue('ostype' in process_info)
+        self.assertEquals(process_info['ostype'], expected_platform)
+        dylib_info = lldbutil.packetlog_get_dylib_info(log)
         self.assertTrue(dylib_info)
         aout_info = None
         for image in dylib_info['images']:
diff --git a/lldb/tools/debugserver/source/DNB.cpp b/lldb/tools/debugserver/source/DNB.cpp
@@ -1418,19 +1418,20 @@ nub_bool_t DNBProcessSharedLibrariesUpdated(nub_process_t pid) {
   return false;
 }
 
-const char *DNBGetDeploymentInfo(nub_process_t pid,
-                                 const struct load_command& lc,
+const char *DNBGetDeploymentInfo(nub_process_t pid, bool is_executable,
+                                 const struct load_command &lc,
                                  uint64_t load_command_address,
-                                 uint32_t& major_version,
-                                 uint32_t& minor_version,
-                                 uint32_t& patch_version) {
+                                 uint32_t &major_version,
+                                 uint32_t &minor_version,
+                                 uint32_t &patch_version) {
   MachProcessSP procSP;
   if (GetProcessSP(pid, procSP)) {
     // FIXME: This doesn't return the correct result when xctest (a
     // macOS binary) is loaded with the macCatalyst dyld platform
     // override. The image info corrects for this, but qProcessInfo
     // will return what is in the binary.
-    auto info = procSP->GetDeploymentInfo(lc, load_command_address);
+    auto info =
+        procSP->GetDeploymentInfo(lc, load_command_address, is_executable);
     major_version = info.major_version;
     minor_version = info.minor_version;
     patch_version = info.patch_version;
@@ -1439,7 +1440,6 @@ const char *DNBGetDeploymentInfo(nub_process_t pid,
   return nullptr;
 }
 
-
 // Get the current shared library information for a process. Only return
 // the shared libraries that have changed since the last shared library
 // state changed event if only_changed is non-zero.
diff --git a/lldb/tools/debugserver/source/DNB.h b/lldb/tools/debugserver/source/DNB.h
@@ -128,12 +128,12 @@ nub_bool_t DNBProcessSharedLibrariesUpdated(nub_process_t pid) DNB_EXPORT;
 nub_size_t
 DNBProcessGetSharedLibraryInfo(nub_process_t pid, nub_bool_t only_changed,
                                DNBExecutableImageInfo **image_infos) DNB_EXPORT;
-const char *DNBGetDeploymentInfo(nub_process_t pid,
-                                 const struct load_command& lc,
+const char *DNBGetDeploymentInfo(nub_process_t pid, bool is_executable,
+                                 const struct load_command &lc,
                                  uint64_t load_command_address,
-                                 uint32_t& major_version,
-                                 uint32_t& minor_version,
-                                 uint32_t& patch_version);
+                                 uint32_t &major_version,
+                                 uint32_t &minor_version,
+                                 uint32_t &patch_version);
 nub_bool_t DNBProcessSetNameToAddressCallback(nub_process_t pid,
                                               DNBCallbackNameToAddress callback,
                                               void *baton) DNB_EXPORT;
diff --git a/lldb/tools/debugserver/source/MacOSX/MachProcess.h b/lldb/tools/debugserver/source/MacOSX/MachProcess.h
@@ -241,15 +241,24 @@ class MachProcess {
     uint32_t patch_version = 0;
   };
   DeploymentInfo GetDeploymentInfo(const struct load_command &,
-                                   uint64_t load_command_address);
+                                   uint64_t load_command_address,
+                                   bool is_executable);
   static const char *GetPlatformString(unsigned char platform);
   bool GetMachOInformationFromMemory(uint32_t platform,
                                      nub_addr_t mach_o_header_addr,
                                      int wordsize,
                                      struct mach_o_information &inf);
   JSONGenerator::ObjectSP FormatDynamicLibrariesIntoJSON(
       const std::vector<struct binary_image_information> &image_infos);
-  uint32_t GetAllLoadedBinariesViaDYLDSPI(
+  /// Get the runtime platform from DYLD via SPI.
+  uint32_t GetProcessPlatformViaDYLDSPI();
+  /// Use the dyld SPI present in macOS 10.12, iOS 10, tvOS 10,
+  /// watchOS 3 and newer to get the load address, uuid, and filenames
+  /// of all the libraries.  This only fills in those three fields in
+  /// the 'struct binary_image_information' - call
+  /// GetMachOInformationFromMemory to fill in the mach-o header/load
+  /// command details.
+  void GetAllLoadedBinariesViaDYLDSPI(
       std::vector<struct binary_image_information> &image_infos);
   JSONGenerator::ObjectSP GetLoadedDynamicLibrariesInfos(
       nub_process_t pid, nub_addr_t image_list_address, nub_addr_t image_count);
diff --git a/lldb/tools/debugserver/source/MacOSX/MachProcess.mm b/lldb/tools/debugserver/source/MacOSX/MachProcess.mm
diff --git a/lldb/tools/debugserver/source/RNBRemote.cpp b/lldb/tools/debugserver/source/RNBRemote.cpp

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`#include "foo.h"`
`2`	`2`	`int main() {`
`3`		`- const char *s = "Hello MacABI!";`
	`3`	`+ const char *s = "Hello macCatalyst!";`
`4`	`4`	`return foo(); // break here`
`5`	`5`	`}`