Make SBDebugger::CreateTargetWithFileAndArch accept lldb.LLDB_DEFAULT_ARCH

[jingham]

Summary

The header docs in SBDebugger.i suggest:

target = debugger.CreateTargetWithFileAndArch (exe, lldb.LLDB_ARCH_DEFAULT)

but that call doesn't actually produce a valid target. The equivalent API - FindTargetWithFileAndArch does work, because it uses the current platform to translate LLDB_ARCH_DEFAULT. This patch just adds that same step to CreateTargetWithFileAndArch, and adds a test.

This API was untested so I also added a test for this one and the similar CreateTargetWithFileAndTargetTriple.

I don't see anywhere where we say what the difference between an "Arch" and a "TargetTriple" is. If anybody has some good verbiage for that, I'll add it to the docs for the API.

[clayborg]

I think the only difference is the triple is supposed to be a complete triple and the arch can be just "arm64" and like you added, we let the currently selected platform help fill it out? I don't remember why this was added. Nothing in the source history?

[jingham]

In D95164#2513644, @clayborg wrote:

I think the only difference is the triple is supposed to be a complete triple and the arch can be just "arm64" and like you added, we let the currently selected platform help fill it out? I don't remember why this was added. Nothing in the source history?

The TargetTriple doesn't seem to need to be a full triple:

>>> target = lldb.debugger.CreateTargetWithFileAndTargetTriple("/tmp/foo", "x86_64")
>>> target.GetTriple()
'x86_64-apple-macosx11.0.0'

Looking at the FindTargetWithFileAndArch, it looks like the only difference is we call the Platform::GetAugmentedArchSpec in the Arch case, and that translates some symbolic constants (systemArch, systemArch32, systemArch64).

This code was from way before the dread reformatting and I don't feel like spelunking past that today...

[rsmith]

I reverted this and the follow-up fix in rG8b1171488575bd0b5ccb23bc1a3d22e2aaccb244, because it's introduced several test failures. Example: http://lab.llvm.org:8011/#/builders/96/builds/3777

It appears that these tests use CreateTargetWithFileAndArch(None, None), which worked before these changes and not afterwards.

lldb/source/API/SBDebugger.cpp

SBTarget SBDebugger::CreateTargetWithFileAndArch(const char *filename,
 
   Log *log(GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
 
   SBTarget sb_target;
   TargetSP target_sp;
   if (m_opaque_sp) {
     Status error;
     const bool add_dependent_modules = true;
-
+    PlatformSP platform_sp = m_opaque_sp->GetPlatformList().GetSelectedPlatform();
+    ArchSpec arch = Platform::GetAugmentedArchSpec(
+        platform_sp.get(), arch_cstr);
     error = m_opaque_sp->GetTargetList().CreateTarget(
-        *m_opaque_sp, filename, arch_cstr,
-        add_dependent_modules ? eLoadDependentsYes : eLoadDependentsNo, nullptr,
-        target_sp);
+        *m_opaque_sp, filename, arch,
+        add_dependent_modules ? eLoadDependentsYes : eLoadDependentsNo, 
+        platform_sp, target_sp);
 
     if (error.Success())
       sb_target.SetSP(target_sp);
   }
 
   LLDB_LOGF(log,
             "SBDebugger(%p)::CreateTargetWithFileAndArch (filename=\"%s\", "
             "arch=%s) => SBTarget(%p)",

lldb/test/API/python_api/target/TestTargetAPI.py

def resolve_symbol_context_with_address(self):
         self.trace("symbol1:", symbol1)
         self.trace("symbol2:", symbol2)
 
         from lldbsuite.test.lldbutil import get_description
         desc1 = get_description(symbol1)
         desc2 = get_description(symbol2)
         self.assertTrue(desc1 and desc2 and desc1 == desc2,
                         "The two addresses should resolve to the same symbol")
+    def test_default_arch(self):
+        """ Test the other two target create methods using LLDB_ARCH_DEFAULT. """
+        self.build()
+        exe = self.getBuildArtifact("a.out")
+        target = self.dbg.CreateTargetWithFileAndArch(exe, lldb.LLDB_ARCH_DEFAULT)
+        self.assertTrue(target.IsValid(), "Default arch made a valid target.")
+        # This should also work with the target's triple:
+        target2 = self.dbg.CreateTargetWithFileAndArch(exe, target.GetTriple())
+        self.assertTrue(target2.IsValid(), "Round trip with triple works")
+        # And this triple should work for the FileAndTriple API:
+        target3 = self.dbg.CreateTargetWithFileAndTargetTriple(exe, target.GetTriple())
+        self.assertTrue(target3.IsValid())