[lldb][Module] Only log SDK search error once per debugger session #171820
+3 −1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Member
| @llvm/pr-subscribers-lldb Author: Michael Buch (Michael137) ChangesCurrently if we are debugging an app that was compiled against an SDK that we don't know about on the host, then every time we evaluate an expression we get following spam on the console (probably one error per LLDB module): It is not a fatal error but the way we spam it pretty much ruins the debugging experience. This patch tries to only log this error once per debugger session. The reason it looks a bit over-engineered is that I want to log it per SDK name. Having a single Not sure how to best test this yet. Full diff: https://github.com/llvm/llvm-project/pull/171820.diff 1 Files Affected:
diff --git a/lldb/source/Core/Module.cpp b/lldb/source/Core/Module.cpp index da2c188899f03..9672b89dc5b9d 100644 --- a/lldb/source/Core/Module.cpp +++ b/lldb/source/Core/Module.cpp @@ -1562,14 +1562,30 @@ std::optional<std::string> Module::RemapSourceFile(llvm::StringRef path) const { return {}; } +/// Logs the specified \c err to the console as an error. This function will +/// only log the error per \c sdk_name for a given debugger session. +static void ReportSDKSearchError(llvm::StringRef sdk_name, llvm::Error err) { + static std::mutex s_reported_sdks_mutex; + static llvm::DenseMap<llvm::StringRef, std::unique_ptr<std::once_flag>> + s_reported_sdks; + + std::scoped_lock lck(s_reported_sdks_mutex); + auto [it, _] = + s_reported_sdks.try_emplace(sdk_name, std::make_unique<std::once_flag>()); + + Debugger::ReportError("Error while searching for Xcode SDK: " + + toString(std::move(err)), + /*debugger_id=*/std::nullopt, + /*once=*/it->getSecond().get()); +} + void Module::RegisterXcodeSDK(llvm::StringRef sdk_name, llvm::StringRef sysroot) { auto sdk_path_or_err = HostInfo::GetSDKRoot(HostInfo::SDKOptions{sdk_name.str()}); if (!sdk_path_or_err) { - Debugger::ReportError("Error while searching for Xcode SDK: " + - toString(sdk_path_or_err.takeError())); + ReportSDKSearchError(sdk_name, sdk_path_or_err.takeError()); return; } |
🐧 Linux x64 Test Results
✅ The build succeeded and all tests passed. |
Michael137 force-pushed the lldb/sdk-search-error branch 2 times, most recently from fcbe4c4 to b31aa38 Compare 
Michael137 force-pushed the lldb/sdk-search-error branch from b31aa38 to 8591030 Compare 
adrian-prantl approved these changes Dec 11, 2025
Michael137 added a commit to swiftlang/llvm-project that referenced this pull request Dec 12, 2025
…lvm#171820) Currently if we are debugging an app that was compiled against an SDK that we don't know about on the host, then every time we evaluate an expression we get following spam on the console: ``` error: Error while searching for Xcode SDK: Unrecognized SDK type: <some SDK> error: Error while searching for Xcode SDK: Unrecognized SDK type: <some SDK> error: Error while searching for Xcode SDK: Unrecognized SDK type: <some SDK> error: Error while searching for Xcode SDK: Unrecognized SDK type: <some SDK> error: Error while searching for Xcode SDK: Unrecognized SDK type: <some SDK> error: Error while searching for Xcode SDK: Unrecognized SDK type: <some SDK> error: Error while searching for Xcode SDK: Unrecognized SDK type: <some SDK> error: Error while searching for Xcode SDK: Unrecognized SDK type: <some SDK> error: Error while searching for Xcode SDK: Unrecognized SDK type: <some SDK> error: Error while searching for Xcode SDK: Unrecognized SDK type: <some SDK> error: Error while searching for Xcode SDK: Unrecognized SDK type: <some SDK> error: Error while searching for Xcode SDK: Unrecognized SDK type: <some SDK> error: Error while searching for Xcode SDK: Unrecognized SDK type: <some SDK> ``` It is not a fatal error but the way we spam it pretty much ruins the debugging experience. This patch makes it so we only log this error once per debugger session. Not sure how to best test it since we'd need to build a program with a particular SDK and then make it unrecognized by LLDB. Confirmed manually that the error only gets reported once after this patch. (cherry picked from commit 1b7f272)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
Currently if we are debugging an app that was compiled against an SDK that we don't know about on the host, then every time we evaluate an expression we get following spam on the console:
It is not a fatal error but the way we spam it pretty much ruins the debugging experience.
This patch makes it so we only log this error once per debugger session.
Not sure how to best test it since we'd need to build a program with a particular SDK and then make it unrecognized by LLDB. Confirmed manually that the error only gets reported once after this patch.