[lldb] print errors when the debug server is not found

[MrCirdo]

Previously, when the debug server binary could not be located, LLDB emitted a vague error:
error: executable doesn't exist: '(empty)'

This patch adds a check just right after the debug server path resolution and produces a clearer message if it's is not found: error: could not find 'lldb-server'. Please ensure it is properly installed and available in your PATH.

[github-actions]

Thank you for submitting a Pull Request (PR) to the LLVM Project!

This PR will be automatically labeled and the relevant teams will be notified.

If you wish to, you can add reviewers by using the "Reviewers" section on this page.

If this is not working for you, it is probably because you do not have write permissions for the repository. In which case you can instead tag reviewers by name in a comment by using @ followed by their GitHub username.

If you have received no comments on your PR for a week, you can request a review by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate is once a week. Please remember that you are asking for valuable time from other developers.

If you have further questions, they may be answered by the LLVM GitHub User Guide.

You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums.

[llvmbot]

@llvm/pr-subscribers-lldb

Author: Odric Roux-Paris (MrCirdo)

Changes

Previously, when the debug server binary could not be located, LLDB emitted a vague error:
error: executable doesn't exist: '(empty)'

This patch adds a check just right after the debug server path resolution and produces a clearer message if it's is not found: error: Could not find 'lldb-server'. Please ensure it is properly installed and available in your PATH.

---

Full diff: https://github.com/llvm/llvm-project/pull/165157.diff

1 Files Affected:

• (modified) lldb/source/Plugins/Process/gdb-remote/ProcessGDBRemote.cpp (+6)

diff --git a/lldb/source/Plugins/Process/gdb-remote/ProcessGDBRemote.cpp b/lldb/source/Plugins/Process/gdb-remote/ProcessGDBRemote.cpp
index b4422a7d58077..324864a732882 100644
--- a/lldb/source/Plugins/Process/gdb-remote/ProcessGDBRemote.cpp
+++ b/lldb/source/Plugins/Process/gdb-remote/ProcessGDBRemote.cpp
@@ -3656,6 +3656,12 @@ Status ProcessGDBRemote::LaunchAndConnectToDebugserver(
 
   FileSpec debugserver_path = GetDebugserverPath(*GetTarget().GetPlatform());
 
+  if (!FileSystem::Instance().Exists(debugserver_path)) {
+    return Status::FromErrorString("Could not find '" DEBUGSERVER_BASENAME
+                                   "'. Please ensure it is properly installed "
+                                   "and available in your PATH.");
+  }
+
 #if defined(__APPLE__)
   // On macOS 11, we need to support x86_64 applications translated to
   // arm64. We check whether a binary is translated and spawn the correct

[MrCirdo]

Hello,

It's my first pull request on the llvm project 😄

I discovered this issue while exploring the project.
I hope I resolved the issue correctly.

[JDevlieghere]

Thanks for the PR! I left some comments & suggestions inline.

[MrCirdo]

Thanks for the PR! I left some comments & suggestions inline.

Thank you for your review! Normally, I fixed all your suggestions.

[github-actions]

@MrCirdo Congratulations on having your first Pull Request (PR) merged into the LLVM Project!

Your changes will be combined with recent changes from other authors, then tested by our build bots. If there is a problem with a build, you may receive a report in an email or a comment on this PR.

Please check whether problems have been caused by your change specifically, as the builds can include changes from many authors. It is not uncommon for your change to be included in a build that fails due to someone else's changes, or infrastructure issues.

How to do this, and the rest of the post-merge process, is covered in detail here.

If your change does cause a problem, it may be reverted, or you can revert it yourself. This is a normal part of LLVM development. You can fix your changes and open a new PR to merge them again.

If you don't get any reports, no action is required from you. Your changes are working as expected, well done!