Skip to content

[lldb] Fix embedded type summary regex handling #8121

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 7 commits into from
Feb 6, 2024
Merged

[lldb] Fix embedded type summary regex handling #8121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9b0474c
[lldb] Fix embedded type summary regex handling
kastiglione Feb 4, 2024
d796de5
Fix lawyer -> layer typo
kastiglione Feb 4, 2024
cd10b01
debug test
kastiglione Feb 5, 2024
65b1fbb
debug test with trace=True
kastiglione Feb 5, 2024
1606ff2
log lldb formatters in test
kastiglione Feb 5, 2024
b4a913d
Use 1-byte alignment for test summary records
kastiglione Feb 6, 2024
18850a0
Remove test debugging
kastiglione Feb 6, 2024
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
4 changes: 2 additions & 2 deletions lldb/source/Target/Target.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1452,7 +1452,7 @@ static void LoadTypeSummariesForModule(ModuleSP module_sp) {
return;

Log *log = GetLog(LLDBLog::DataFormatters);
const char *module_name = module_sp->GetObjectName().GetCString();
const char *module_name = module_sp->GetFileSpec().GetFilename().GetCString();
Copy link

Choose a reason for hiding this comment

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

Micro-optimization: since this is only used in LLDB_LOGF, we can save the C string conversion by using LLDB_LOG instead and use a StringRef.


TypeCategoryImplSP category;
DataVisualization::Categories::GetCategory(ConstString("default"), category);
Expand Down Expand Up @@ -1488,7 +1488,7 @@ static void LoadTypeSummariesForModule(ModuleSP module_sp) {
auto summary_sp =
std::make_shared<StringSummaryFormat>(flags, summary_string.data());
FormatterMatchType match_type = eFormatterMatchExact;
if (summary_string.front() == '^' && summary_string.back() == '$')
if (type_name.front() == '^')
Copy link

Choose a reason for hiding this comment

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

It just dawned on me that in Pascal, ^ is the equivalent of * in C and thus can be part of a type name. In the next revision we probably should include an isRegex bit in the header.

Copy link

Choose a reason for hiding this comment

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

and AFAIK there are downstream Pascal compilers that target LLDB.

match_type = eFormatterMatchRegex;
category->AddTypeSummary(type_name, match_type, summary_sp);
LLDB_LOGF(log, "Loaded embedded type summary for '%s' from %s.",
Expand Down
1 change: 1 addition & 0 deletions lldb/test/API/functionalities/data-formatter/embedded-summary/TestEmbeddedTypeSummary.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ def test(self):
self.build()
lldbutil.run_to_source_breakpoint(self, "break here", lldb.SBFileSpec("main.c"))
self.expect("v player", substrs=['"Dirk" (41)'])
self.expect("v layer", substrs=['"crust" (3)'])
21 changes: 20 additions & 1 deletion lldb/test/API/functionalities/data-formatter/embedded-summary/main.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,37 @@ struct Player {
int number;
};

__attribute__((used, section("__DATA_CONST,__lldbsummaries"))) unsigned char
__attribute__((aligned(1), used,
section("__DATA_CONST,__lldbsummaries"))) unsigned char
_Player_type_summary[] = "\x01" // version
"\x25" // record size
"\x07" // type name size
"Player\0" // type name
"\x1c" // summary string size
"${var.name} (${var.number})"; // summary string

struct Layer {
char *name;
int number;
};

// Near copy of the record for `Player`, using a regex type name (`^Layer`).
__attribute__((aligned(1), used,
section("__DATA_CONST,__lldbsummaries"))) unsigned char
_Layer_type_summary[] = "\x01" // version
"\x25" // record size
"\x07" // type name size
"^Layer\0" // type name
"\x1c" // summary string size
"${var.name} (${var.number})"; // summary string

int main() {
struct Player player;
player.name = "Dirk";
player.number = 41;
struct Layer layer;
layer.name = "crust";
layer.number = 3;
puts("break here");
return 0;
}