[LLDB] Fix the use of "platform process launch" with no extra arguments

[DavidSpickett]

Summary

This fixes #62068.

After 8d1de7b34af46a089eb5433c700419ad9b2923ee the following issue appeared:

$ ./bin/lldb /tmp/test.o
(lldb) target create "/tmp/test.o"
Current executable set to '/tmp/test.o' (aarch64).
(lldb) platform process launch -s
error: Cannot launch '': Nothing to launch

Previously would call target->GetRunArguments when there were no extra
arguments, so we could find out what target.run-args might be.

Once that change started relying on the first arg being the exe,
the fact that that call clears the existing argument list caused the bug.

Instead, have it set a local arg list and append that to the existing
one. Which in this case will just contain the exe name.

Since there's no existing tests for this command I've added a new file
that covers enough to check this issue.

[DavidSpickett]

https://github.com/llvm/llvm-project/issues/62068

[labath]

Thanks for fixing this.

[fdeazeve]

I think this may have caused an LLDB test to fail:
https://green.lab.llvm.org/green/view/LLDB/job/lldb-cmake/56977/execution/node/74/log/

runCmd: platform process launch --stdout /Users/buildslave/jenkins/workspace/lldb-cmake/lldb-build/lldb-test-build.noindex/commands/platform/process/launch/TestPlatformProcessLaunch.test_process_launch_no_args/stdio.log -s
runCmd failed!
error: process launch failed

Looking at the list of eight commits between the last good run and the bad run, this seems to be related.

[DavidSpickett]

Do you or anyone else have a Mac they can reproduce this on? I don't. I know it works on Linux so far, unfortunately our Windows bot is down temporarily. I looked around similar tests and didn't see any skips for Mac.

Sometimes the packet log will tell us more, I could reland with that enabled for tracing and revert as soon as the build is done.

[kastiglione]

I will try to reproduce.

[kastiglione]

lldb/test/API/commands/platform/process/launch/TestPlatformProcessLaunch.py

51

@DavidSpickett did you mean for this command to use the -s flag too?

[kastiglione]

Thanks to @jingham's help in identifying this issue, I have opened https://reviews.llvm.org/D153922 as a potential fix for the issue on macOS.

[kastiglione]

lldb/test/API/commands/platform/process/launch/TestPlatformProcessLaunch.py

51

I have merged D153922, which fails with this test as-is. Before re-committing, this test will need to use -s like the other invocations, or remove the "continue" command on the next line.

[DavidSpickett]

lldb/test/API/commands/platform/process/launch/TestPlatformProcessLaunch.py

51

Will do. The missing -s was a mistake, in fact some of them failed on Linux without it. Perhaps a timing issue and I just got lucky on my local machine.

[DavidSpickett]

Relanded as https://github.com/llvm/llvm-project/commit/728101f97286c1665814e74686c083a4d5ff208c.

lldb/source/Commands/CommandObjectPlatform.cpp

 //===-- CommandObjectPlatform.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
 //
 //===----------------------------------------------------------------------===//
 
if (platform_sp) {
           const bool first_arg_is_executable = true;
           m_options.launch_info.SetArguments(args, first_arg_is_executable);
         }
       }
 
       if (m_options.launch_info.GetExecutableFile()) {
         Debugger &debugger = GetDebugger();
 
-        if (argc == 0)
-          target->GetRunArguments(m_options.launch_info.GetArguments());
+        if (argc == 0) {
+          // If no arguments were given to the command, use target.run-args.
+          Args target_run_args;
+          target->GetRunArguments(target_run_args);
+          m_options.launch_info.GetArguments().AppendArguments(target_run_args);
+        }
 
         ProcessSP process_sp(platform_sp->DebugProcess(
             m_options.launch_info, debugger, *target, error));
         if (process_sp && process_sp->IsAlive()) {
           result.SetStatus(eReturnStatusSuccessFinishNoResult);
           return true;
         }
 

lldb/test/API/commands/platform/process/launch/Makefile

+C_SOURCES := main.c
+
+include Makefile.rules

lldb/test/API/commands/platform/process/launch/TestPlatformProcessLaunch.py

+"""
+Test platform process launch.
+"""
+
+from textwrap import dedent
+from lldbsuite.test.lldbtest import TestBase
+
+
+class ProcessLaunchTestCase(TestBase):
+    NO_DEBUG_INFO_TESTCASE = True
+
+    def setup(self):
+        self.build()
+        exe = self.getBuildArtifact("a.out")
+        self.runCmd("file " + exe)
+        return (exe, self.getBuildArtifact("stdio.log"))
+
+    def test_process_launch_no_args(self):
+        # When there are no extra arguments we just have 0, the program name.
+        exe, outfile = self.setup()
+        self.runCmd("platform process launch --stdout {} -s".format(outfile))
+        self.runCmd("continue")
+
+        with open(outfile) as f:
+           self.assertEqual(dedent("""\
+                Got 1 argument(s).
+                [0]: {}
+                """.format(exe)), f.read())
+
+    def test_process_launch_command_args(self):
+        exe, outfile = self.setup()
+        # Arguments given via the command override those in the settings.
+        self.runCmd("settings set target.run-args D E")
+        self.runCmd("platform process launch --stdout {} -s -- A B C".format(outfile))
+        self.runCmd("continue")
+
+        with open(outfile) as f:
+           self.assertEqual(dedent("""\
+                Got 4 argument(s).
+                [0]: {}
+                [1]: A
+                [2]: B
+                [3]: C
+                """.format(exe)), f.read())
+
+    def test_process_launch_target_args(self):
+        exe, outfile = self.setup()
+        # When no arguments are passed via the command, use the setting.
+        self.runCmd("settings set target.run-args D E")
+        self.runCmd("platform process launch --stdout {}".format(outfile))
+        self.runCmd("continue")
+
+        with open(outfile) as f:
+           self.assertEqual(dedent("""\
+                Got 3 argument(s).
+                [0]: {}
+                [1]: D
+                [2]: E
+                """.format(exe)), f.read())
 No newline at end of file

lldb/test/API/commands/platform/process/launch/main.c

+#include <stdio.h>
+
+int main(int argc, char const *argv[]) {
+  printf("Got %d argument(s).\n", argc);
+  for (int i = 0; i < argc; ++i)
+    printf("[%d]: %s\n", i, argv[i]);
+  return 0;
+}