Moving executable module symbols parsing to target creation method.

Summary:
In our project we are using remote client-server LLDB configuration.
We want to parse as much debugging symbols as we can before debugger starts attachment to the remote process.
To do that we are passing the path of the local executable module to CreateTarget method at the client.
But, it seems that this method are not parsing the executable module symbols.
To fix this I added PreloadSymbols call for executable module to target creation method.

This patch also fixes a problem where the DynamicLoader would reset a
module when launching the target. We fix it by making sure
Platform::ResolveExecutable returns the module object obtained from the
remote platform.

Reviewed By: labath

Differential Revision: https://reviews.llvm.org/D78654

lldb/source/Target/RemoteAwarePlatform.cpp

@@ -71,24 +71,24 @@ Status RemoteAwarePlatform::ResolveExecutable(
     }
   } else {
     if (m_remote_platform_sp) {
-      error =
-          GetCachedExecutable(resolved_module_spec, exe_module_sp,
-                              module_search_paths_ptr, *m_remote_platform_sp);
-    } else {
-      // We may connect to a process and use the provided executable (Don't use
-      // local $PATH).
+      return GetCachedExecutable(resolved_module_spec, exe_module_sp,
+                                 module_search_paths_ptr,
+                                 *m_remote_platform_sp);
+    }
 
-      // Resolve any executable within a bundle on MacOSX
-      Host::ResolveExecutableInBundle(resolved_module_spec.GetFileSpec());
+    // We may connect to a process and use the provided executable (Don't use
+    // local $PATH).
 
-      if (FileSystem::Instance().Exists(resolved_module_spec.GetFileSpec()))
-        error.Clear();
-      else
-        error.SetErrorStringWithFormat("the platform is not currently "
-                                       "connected, and '%s' doesn't exist in "
-                                       "the system root.",
-                                       exe_path);
-    }
+    // Resolve any executable within a bundle on MacOSX
+    Host::ResolveExecutableInBundle(resolved_module_spec.GetFileSpec());
+
+    if (FileSystem::Instance().Exists(resolved_module_spec.GetFileSpec()))
+      error.Clear();
+    else
+      error.SetErrorStringWithFormat("the platform is not currently "
+                                     "connected, and '%s' doesn't exist in "
+                                     "the system root.",
+                                     exe_path);
   }
 
   if (error.Success()) {

lldb/source/Target/TargetList.cpp

@@ -398,6 +398,8 @@ Status TargetList::CreateTargetInternal(Debugger &debugger,
       if (user_exe_path_is_bundle)
         exe_module_sp->GetFileSpec().GetPath(resolved_bundle_exe_path,
                                              sizeof(resolved_bundle_exe_path));
+      if (target_sp->GetPreloadSymbols())
+        exe_module_sp->PreloadSymbols();
     }
   } else {
     // No file was specified, just create an empty target with any arch if a

lldb/unittests/Target/CMakeLists.txt

@@ -4,6 +4,7 @@ add_lldb_unittest(TargetTests
   MemoryRegionInfoTest.cpp
   ModuleCacheTest.cpp
   PathMappingListTest.cpp
+  RemoteAwarePlatformTest.cpp
   StackFrameRecognizerTest.cpp
 
   LINK_LIBS

lldb/unittests/Target/RemoteAwarePlatformTest.cpp

@@ -0,0 +1,94 @@
+//===-- RemoteAwarePlatformTest.cpp ---------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#include "lldb/Target/RemoteAwarePlatform.h"
+#include "lldb/Core/Debugger.h"
+#include "lldb/Core/Module.h"
+#include "lldb/Core/ModuleSpec.h"
+#include "lldb/Host/FileSystem.h"
+#include "lldb/Target/Platform.h"
+#include "lldb/Target/Process.h"
+#include "gmock/gmock.h"
+#include "gtest/gtest.h"
+
+using namespace lldb_private;
+using namespace lldb;
+using namespace testing;
+
+class RemoteAwarePlatformTester : public RemoteAwarePlatform {
+public:
+  using RemoteAwarePlatform::RemoteAwarePlatform;
+
+  MOCK_METHOD0(GetDescription, const char *());
+  MOCK_METHOD0(GetPluginVersion, uint32_t());
+  MOCK_METHOD0(GetPluginName, ConstString());
+  MOCK_METHOD2(GetSupportedArchitectureAtIndex, bool(uint32_t, ArchSpec &));
+  MOCK_METHOD4(Attach,
+               ProcessSP(ProcessAttachInfo &, Debugger &, Target *, Status &));
+  MOCK_METHOD0(CalculateTrapHandlerSymbolNames, void());
+
+  void SetRemotePlatform(lldb::PlatformSP platform) {
+    m_remote_platform_sp = platform;
+  }
+};
+
+class TargetPlatformTester : public Platform {
+public:
+  using Platform::Platform;
+
+  MOCK_METHOD0(GetDescription, const char *());
+  MOCK_METHOD0(GetPluginVersion, uint32_t());
+  MOCK_METHOD0(GetPluginName, ConstString());
+  MOCK_METHOD2(GetSupportedArchitectureAtIndex, bool(uint32_t, ArchSpec &));
+  MOCK_METHOD4(Attach,
+               ProcessSP(ProcessAttachInfo &, Debugger &, Target *, Status &));
+  MOCK_METHOD0(CalculateTrapHandlerSymbolNames, void());
+  MOCK_METHOD0(GetUserIDResolver, UserIDResolver &());
+
+  MOCK_METHOD2(ResolveExecutable,
+               std::pair<Status, ModuleSP>(const ModuleSpec &,
+                                           const FileSpecList *));
+  Status
+  ResolveExecutable(const ModuleSpec &module_spec,
+                    lldb::ModuleSP &exe_module_sp,
+                    const FileSpecList *module_search_paths_ptr) /*override*/ {
+    auto pair = ResolveExecutable(module_spec, module_search_paths_ptr);
+    exe_module_sp = pair.second;
+    return pair.first;
+  }
+};
+
+namespace {
+class RemoteAwarePlatformTest : public testing::Test {
+public:
+  static void SetUpTestCase() { FileSystem::Initialize(); }
+  static void TearDownTestCase() { FileSystem::Terminate(); }
+};
+} // namespace
+
+TEST_F(RemoteAwarePlatformTest, TestResolveExecutabelOnClientByPlatform) {
+  ModuleSpec executable_spec;
+  ModuleSP expected_executable(new Module(executable_spec));
+
+  auto platform_sp = std::make_shared<TargetPlatformTester>(false);
+  EXPECT_CALL(*platform_sp, ResolveExecutable(_, _))
+      .WillRepeatedly(Return(std::make_pair(Status(), expected_executable)));
+
+  RemoteAwarePlatformTester platform(false);
+  EXPECT_CALL(platform, GetSupportedArchitectureAtIndex(_, _))
+      .WillRepeatedly(Return(false));
+
+  platform.SetRemotePlatform(platform_sp);
+
+  ModuleSP resolved_sp;
+  lldb_private::Status status =
+      platform.ResolveExecutable(executable_spec, resolved_sp, nullptr);
+
+  ASSERT_TRUE(status.Success());
+  EXPECT_EQ(expected_executable.get(), resolved_sp.get());
+}