-
Notifications
You must be signed in to change notification settings - Fork 15.3k
[lldb] Upgrade GetIndexOfChildWithName to use llvm::Expected
#136693
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Michael137
merged 17 commits into
llvm:main
from
charles-zablit:charles-zablit/lldb/upgrade-compilertype-GetIndexOfChildWithName
Apr 30, 2025
Merged
Changes from 5 commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
f7d5ef8
[lldb] Upgrade GetIndexOfChildWithName to use llvm::Expected
charles-zablit db12ff1
fixup! [lldb] Upgrade GetIndexOfChildWithName to use llvm::Expected
charles-zablit 4dda702
fix tests
charles-zablit 320301d
fixup! fix tests
charles-zablit 14b5250
use PRIu32 instead of %d
charles-zablit 86f52fa
address comments
charles-zablit a35fea8
Update lldb/source/Plugins/Language/CPlusPlus/LibCxxVector.cpp
charles-zablit 8d13ebb
Update lldb/source/ValueObject/ValueObjectSyntheticFilter.cpp
charles-zablit dcfe07b
Update lldb/source/Plugins/Language/CPlusPlus/LibCxxValarray.cpp
charles-zablit 443b930
Update lldb/source/Plugins/Language/CPlusPlus/LibCxxVector.cpp
charles-zablit 8d14f51
fix formatting
charles-zablit 8ce502e
fix formatting
charles-zablit ac7cf1f
fix tests
charles-zablit 3cf13ec
fixup! fix tests
charles-zablit 4699999
fixup! fixup! fix tests
charles-zablit 3db059d
switch to generic error message
charles-zablit 23545b8
fixup! switch to generic error message
charles-zablit File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
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
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -144,9 +144,12 @@ class BlockPointerSyntheticFrontEnd : public SyntheticChildrenFrontEnd { | |||||
| return lldb::ChildCacheState::eRefetch; | ||||||
| } | ||||||
|
|
||||||
| size_t GetIndexOfChildWithName(ConstString name) override { | ||||||
| llvm::Expected<size_t> GetIndexOfChildWithName(ConstString name) override { | ||||||
| if (!m_block_struct_type.IsValid()) | ||||||
| return UINT32_MAX; | ||||||
| return llvm::createStringError( | ||||||
| "'SyntheticChildrenFrontend::BlockPointerSyntheticFrontEnd' cannot " | ||||||
| "find index of child '%s'", | ||||||
| name.AsCString()); | ||||||
|
|
||||||
| const bool omit_empty_base_classes = false; | ||||||
| return m_block_struct_type.GetIndexOfChildWithName(name.AsCString(), | ||||||
|
|
@@ -172,8 +175,16 @@ bool lldb_private::formatters::BlockPointerSummaryProvider( | |||||
|
|
||||||
| static const ConstString s_FuncPtr_name("__FuncPtr"); | ||||||
|
|
||||||
| lldb::ValueObjectSP child_sp = synthetic_children->GetChildAtIndex( | ||||||
| synthetic_children->GetIndexOfChildWithName(s_FuncPtr_name)); | ||||||
| auto index_or_err = | ||||||
| synthetic_children->GetIndexOfChildWithName(s_FuncPtr_name); | ||||||
|
|
||||||
| if (!index_or_err) { | ||||||
| LLDB_LOG_ERROR(GetLog(LLDBLog::Types), index_or_err.takeError(), "{0}"); | ||||||
|
||||||
| LLDB_LOG_ERROR(GetLog(LLDBLog::Types), index_or_err.takeError(), "{0}"); | |
| LLDB_LOG_ERROR(GetLog(LLDBLog::DataFormatters), index_or_err.takeError(), "{0}"); |
Michael137 marked this conversation as resolved.
Show resolved
Hide resolved
Michael137 marked this conversation as resolved.
Show resolved
Hide resolved
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
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
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
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
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -309,13 +309,17 @@ lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEnd::Update() { | |||||
| return lldb::ChildCacheState::eRefetch; | ||||||
| } | ||||||
|
|
||||||
| size_t lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEnd:: | ||||||
| llvm::Expected<size_t> | ||||||
| lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEnd:: | ||||||
| GetIndexOfChildWithName(ConstString name) { | ||||||
| if (name == "__ptr_") | ||||||
| return 0; | ||||||
| if (name == "$$dereference$$") | ||||||
| return 1; | ||||||
| return UINT32_MAX; | ||||||
| return llvm::createStringError( | ||||||
| "'SyntheticChildrenFrontend::LibcxxSharedPtrSyntheticFrontEnd' cannot " | ||||||
|
||||||
| "'SyntheticChildrenFrontend::LibcxxSharedPtrSyntheticFrontEnd' cannot " | |
| "'LibcxxSharedPtrSyntheticFrontEnd' cannot " |
Outdated
Member
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggested change
| "'ScriptedSyntheticChildren::LibcxxUniquePtrSyntheticFrontEnd' cannot " | |
| "'LibcxxUniquePtrSyntheticFrontEnd' cannot " |
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would suggest leaving out the function name entirely.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I initially suggested it because that'd make it easier to identify where this was coming from if we ever decide to log it (or see it in user reports)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Michael137 My thinking is that these error messages are meant to be read by LLDB users, and the function name is a tool to aid in debugging LLDB itself. Users won't understand the meaning of the function name here, so we shouldn't have it in the user-facing error message. If this is useful information needed to debug LLDB, then we should log it instead.
Let me know if you think that's not a good idea!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm fair question. Adding logging to all these places feels a bit noisy. In my opinion its helpful to be as specific as possible, and if we wanted to present something more generic to the user eventually then we can change the error message at the point where we are about to present it. I'm not sure where these error messages will currently show up actually
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Currently the error is dropped silently. You wouldn't replace that with adding logging everywhere. My suggestion would be to:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The error messages in the Expected return results of CompilerType are surfaced when formatting ValueObjects, for example.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm my main concern is that we end up getting user reports with a very generic error and then have no way to really tell where we went wrong. Then adding logging after-the-fact is a pretty slow turnaround. I guess usually these types of issues require a reproducer to debug anyway, so maybe this isn't a valid concern? Wdyt? I don't have a strong opinion on this. But it would be easier/more convenient to go from non-generic error back to generic error than the other way around if we really need to