[lldb] Check that qLaunchGDBServer packet does not return an error

[DavidSpickett]

Summary

While looking at https://github.com/llvm/llvm-project/issues/61955
I noticed that when we send qLaunchGDBServer we check that we got a response
but not what kind of response it was.

I think this was why the bug reporter saw:
(lldb) run
error: invalid host:port specification: '[192.168.64.2]'

The missing port is because we went down a path we only should have
chosen if the operation succeeded. Since we didn't check, we went ahead
with an empty port number.

To test this I've done the following:

• Make a temporary copy of lldb-server.
• Run that as a platform.
• Remove the copy.
• Attempt to create and run a target.

This fails because the running lldb-server will try to invoke itself
and it no longer exists.

[DavidSpickett]

I was about to say I don't have a way to test this but I think I might have now.

Starting a platform, then moving lldb-server causes it to fail on Linux. Perhaps I can do that in an isolated way in a shell test.

[DavidSpickett]

Added a test from Python, which avoids a bunch of lit and Linux shell specific issues.

[DavidSpickett]

In the bug report the user didn't have a debugserver on the remote, but the handling is the same for lldb-server or debugserver.

[DavidSpickett]

ping!

[jasonmolenda]

Ah, sorry for not getting back to this one! Nice job coming up with a test. LGTM.

lldb/source/Plugins/Process/gdb-remote/GDBRemoteCommunicationClient.cpp

if (HostInfo::GetHostname(hostname)) {
       stream.Printf("host:*;");
     }
   }
   // give the process a few seconds to startup
   ScopedTimeout timeout(*this, seconds(10));
 
   if (SendPacketAndWaitForResponse(stream.GetString(), response) ==
       PacketResult::Success) {
+    if (response.IsErrorResponse())
+      return false;
+
     llvm::StringRef name;
     llvm::StringRef value;
     while (response.GetNameColonValue(name, value)) {
       if (name.equals("port"))
         value.getAsInteger(0, port);
       else if (name.equals("pid"))
         value.getAsInteger(0, pid);
       else if (name.compare("socket_name") == 0) {

lldb/test/API/commands/platform/launchgdbserver/Makefile

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

lldb/test/API/commands/platform/launchgdbserver/TestPlatformLaunchGDBServer.py

+""" Check that errors while handling qLaunchGDBServer are reported to the user.
+    Though this isn't a platform command in itself, the best way to test it is
+    from Python because we can juggle multiple processes more easily.
+"""
+
+import os
+import socket
+import shutil
+import lldbgdbserverutils
+from lldbsuite.test.decorators import *
+from lldbsuite.test.lldbtest import *
+from lldbsuite.test import lldbutil
+
+
+class TestPlatformProcessLaunchGDBServer(TestBase):
+    NO_DEBUG_INFO_TESTCASE = True
+
+    @skipIfRemote
+    # Windows doesn't use lldb-server and on Darwin we may be using debugserver.
+    @skipUnlessPlatform(["linux"])
+    @add_test_categories(["lldb-server"])
+    def test_platform_process_launch_gdb_server(self):
+        self.build()
+
+        hostname = socket.getaddrinfo("localhost", 0, proto=socket.IPPROTO_TCP)[0][4][0]
+        listen_url = "[%s]:0" % hostname
+
+        port_file = self.getBuildArtifact("port")
+        commandline_args = [
+            "platform",
+            "--listen",
+            listen_url,
+            "--socket-file",
+            port_file,
+            "--",
+            self.getBuildArtifact("a.out"),
+            "foo",
+        ]
+
+        # Run lldb-server from a new location.
+        new_lldb_server = self.getBuildArtifact("lldb-server")
+        shutil.copy(lldbgdbserverutils.get_lldb_server_exe(), new_lldb_server)
+
+        self.spawnSubprocess(new_lldb_server, commandline_args)
+        socket_id = lldbutil.wait_for_file_on_target(self, port_file)
+
+        # Remove our new lldb-server so that when it tries to invoke itself as a
+        # gdbserver, it fails.
+        os.remove(new_lldb_server)
+
+        new_platform = lldb.SBPlatform("remote-" + self.getPlatform())
+        self.dbg.SetSelectedPlatform(new_platform)
+
+        connect_url = "connect://[%s]:%s" % (hostname, socket_id)
+        self.runCmd("platform connect %s" % connect_url)
+
+        self.runCmd("target create {}".format(self.getBuildArtifact("a.out")))
+        self.expect("run", substrs=["unable to launch a GDB server on"], error=True)

lldb/test/API/commands/platform/launchgdbserver/main.c

+int main() { return 0; }