Skip to content

[lldb] Let languages see all SymbolContexts at once when filtering breakpoints #129937

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.

Sign up for GitHub

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
merged 1 commit into from
Mar 12, 2025
Merged

[lldb] Let languages see all SymbolContexts at once when filtering breakpoints #129937

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions lldb/include/lldb/Target/Language.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -354,14 +354,13 @@ class Language : public PluginInterface {

virtual llvm::StringRef GetInstanceVariableName() { return {}; }

/// Returns true if this SymbolContext should be ignored when setting
/// breakpoints by line (number or regex). Helpful for languages that create
/// artificial functions without meaningful user code associated with them
/// (e.g. code that gets expanded in late compilation stages, like by
/// CoroSplitter).
virtual bool IgnoreForLineBreakpoints(const SymbolContext &) const {
return false;
}
/// Given a symbol context list of matches which supposedly represent the
/// same file and line number in a CU, erases those that should be ignored
/// when setting breakpoints by line (number or regex). Helpful for languages
/// that create split a single source-line into many functions (e.g. call
/// sites transformed by CoroSplitter).
virtual void
FilterForLineBreakpoints(llvm::SmallVectorImpl<SymbolContext> &) const {}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this take a SymbolContextList instead?

Copy link
Contributor Author

@felipepiovezan felipepiovezan Mar 5, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The callsite doesn't use that, I suspect because it intends to manipulate the contents of the list heavily (like this method will)


/// Returns a boolean indicating whether two symbol contexts are equal for the
/// purposes of frame comparison. If the plugin has no opinion, it should
Expand Down
19 changes: 9 additions & 10 deletions lldb/source/Breakpoint/BreakpointResolver.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,16 +207,15 @@ bool operator<(const SourceLoc lhs, const SourceLoc rhs) {
void BreakpointResolver::SetSCMatchesByLine(
SearchFilter &filter, SymbolContextList &sc_list, bool skip_prologue,
llvm::StringRef log_ident, uint32_t line, std::optional<uint16_t> column) {
llvm::SmallVector<SymbolContext, 16> all_scs;

for (const auto &sc : sc_list) {
if (Language::GetGlobalLanguageProperties()
.GetEnableFilterForLineBreakpoints())
if (Language *lang = Language::FindPlugin(sc.GetLanguage());
lang && lang->IgnoreForLineBreakpoints(sc))
continue;
all_scs.push_back(sc);
}
llvm::SmallVector<SymbolContext, 16> all_scs(sc_list.begin(), sc_list.end());

// Let the language plugin filter `sc_list`. Because all symbol contexts in
// sc_list are assumed to belong to the same File, Line and CU, the code below
// assumes they have the same language.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The assumption above comes from the docstring for BreakpointResolver::SetSCMatchesByLine

if (!sc_list.IsEmpty() && Language::GetGlobalLanguageProperties()
.GetEnableFilterForLineBreakpoints())
if (Language *lang = Language::FindPlugin(sc_list[0].GetLanguage()))
lang->FilterForLineBreakpoints(all_scs);

while (all_scs.size()) {
uint32_t closest_line = UINT32_MAX;
Expand Down