Skip to content

[cherry-pick] [lldb] Support frame variable for generic types in embedded Swift #8445

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 3 commits into from
Mar 21, 2024
Merged

[cherry-pick] [lldb] Support frame variable for generic types in embedded Swift #8445

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
147dfb4
[lldb] Support frame variable for generic types in embedded Swift
augusto2112 Feb 23, 2024
1d1c20d
[lldb] Change embedded swift test to use "clean" doubles
augusto2112 Feb 28, 2024
711c01e
[NFC][lldb] Rewrite TestSwiftEmbeddedFrameVariable to use check_variable
augusto2112 Mar 20, 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
27 changes: 27 additions & 0 deletions lldb/source/Plugins/SymbolFile/DWARF/DWARFASTParserSwiftDescriptorFinder.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,29 @@ using namespace lldb_private;
using namespace lldb_private::dwarf;
using namespace lldb_private::plugin::dwarf;

/// Given a die to a substituted generic Swift type, return the analogous
/// unsubstituted version.
///
/// Given a generic type (for example, a generic Pair), the compiler will emit
/// full debug information for the unsubstituted type (Pair<T, U>), and opaque
/// debug information for each every specialization (for example, Pair<Int,
/// Double>), with a link back to the unsubstituted type. When looking up one of
/// the specialized generics, return the unsubstituted version instead.
static std::optional<std::pair<CompilerType, DWARFDIE>>
findUnsubstitutedGenericTypeAndDIE(TypeSystemSwiftTypeRef &ts,
const DWARFDIE &die) {
auto unsubstituted_die =
die.GetAttributeValueAsReferenceDIE(llvm::dwarf::DW_AT_specification);
if (!unsubstituted_die)
return {};

const auto *mangled_name = unsubstituted_die.GetAttributeValueAsString(
llvm::dwarf::DW_AT_linkage_name, nullptr);
assert(mangled_name);
auto unsubstituted_type =
ts.GetTypeFromMangledTypename(ConstString(mangled_name));
return {{unsubstituted_type, unsubstituted_die}};
}
/// Given a type system and a typeref, return the compiler type and die of the
/// type that matches that mangled name, looking up the in the type system's
/// module's debug information.
Expand Down Expand Up @@ -62,6 +85,10 @@ getTypeAndDie(TypeSystemSwiftTypeRef &ts,
return {};
}
auto die = dwarf->GetDIE(lldb_type->GetID());

if (auto unsubstituted_pair = findUnsubstitutedGenericTypeAndDIE(ts, die))
return unsubstituted_pair;

return {{type, die}};
}

Expand Down
260 changes: 150 additions & 110 deletions lldb/test/API/lang/swift/embedded/frame_variable/TestSwiftEmbeddedFrameVariable.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,121 +11,161 @@ class TestSwiftEmbeddedFrameVariable(TestBase):
def test(self):
self.build()

target, process, _, _ = lldbutil.run_to_source_breakpoint(
target, process, thread, _ = lldbutil.run_to_source_breakpoint(
self, "break here", lldb.SBFileSpec("main.swift")
)
frame = thread.frames[0]
self.assertTrue(frame, "Frame 0 is valid.")

self.expect(
"frame variable varB",
substrs=["varB = ", "a = (field = 4.2000000000000002)", "b = 123456"],
)
self.expect(
"frame variable tuple",
substrs=[
"(a.A, a.B) tuple = {",
"0 = (field = 4.2000000000000002)",
"1 = {",
"a = (field = 4.2000000000000002)",
"b = 123456",
],
)
varB = frame.FindVariable("varB")
field = varB.GetChildMemberWithName("a").GetChildMemberWithName("field")
lldbutil.check_variable(self, field, False, value='4.5')
b = varB.GetChildMemberWithName("b")
lldbutil.check_variable(self, b, False, value='123456')

self.expect(
"frame variable nonPayload1", substrs=["NonPayloadEnum) nonPayload1 = one"]
)
self.expect(
"frame variable nonPayload2", substrs=["NonPayloadEnum) nonPayload2 = two"]
)
self.expect(
"frame variable singlePayload",
substrs=[
"SinglePayloadEnum) singlePayload = ",
"payload {",
"a = (field = 4.2000000000000002)",
"b = 123456",
],
)
self.expect(
"frame variable emptySinglePayload",
substrs=["SinglePayloadEnum) emptySinglePayload = nonPayloadTwo"],
)
tuple = frame.FindVariable("tuple")
first = tuple.GetChildAtIndex(0)
field = first.GetChildMemberWithName("field")
lldbutil.check_variable(self, field, False, value='4.5')
second = tuple.GetChildAtIndex(1)
a = second.GetChildMemberWithName("a")
field = a.GetChildMemberWithName("field")
lldbutil.check_variable(self, field, False, value='4.5')
b = second.GetChildMemberWithName("b")
lldbutil.check_variable(self, b, False, value='123456')

self.expect(
"frame variable smallMultipayloadEnum1",
substrs=[
"SmallMultipayloadEnum) smallMultipayloadEnum1 = one {",
"one = two",
],
)
self.expect(
"frame variable smallMultipayloadEnum2",
substrs=[
"SmallMultipayloadEnum) smallMultipayloadEnum2 = two {",
"two = one",
],
)
self.expect(
"frame variable bigMultipayloadEnum1",
substrs=[
"BigMultipayloadEnum) bigMultipayloadEnum1 = one {",
"0 = ",
"(supField = 42)",
"1 = ",
"(supField = 43)",
"2 = ",
"(supField = 44)",
],
)
nonPayload1 = frame.FindVariable("nonPayload1")
lldbutil.check_variable(self, nonPayload1, False, value='one')

self.expect(
"frame variable fullMultipayloadEnum1",
substrs=["FullMultipayloadEnum) fullMultipayloadEnum1 = ", "(one = 120)"],
)
self.expect(
"frame variable fullMultipayloadEnum2",
substrs=[
"FullMultipayloadEnum) fullMultipayloadEnum2 = ",
"(two = 9.2100000000000008)",
],
)
nonPayload2 = frame.FindVariable("nonPayload2")
lldbutil.check_variable(self, nonPayload2, False, value='two')

self.expect(
"frame variable bigFullMultipayloadEnum1",
substrs=[
"a.BigFullMultipayloadEnum) bigFullMultipayloadEnum1 = one {",
"one = (0 = 209, 1 = 315)",
],
)
self.expect(
"frame variable bigFullMultipayloadEnum2",
substrs=[
"a.BigFullMultipayloadEnum) bigFullMultipayloadEnum2 = two {",
"two = (0 = 452.19999999999999, 1 = 753.89999999999998)",
],
)
singlePayload = frame.FindVariable("singlePayload")
payload = singlePayload.GetChildMemberWithName('payload')
field = payload.GetChildMemberWithName('a').GetChildMemberWithName('field')
lldbutil.check_variable(self, field, False, value='4.5')
b = payload.GetChildMemberWithName('b')
lldbutil.check_variable(self, b, False, value='123456')

self.expect("frame variable sup", substrs=["Sup) sup = ", "supField = 42"])
self.expect(
"frame variable sub",
substrs=[
"Sub) sub = ",
"Sup = {",
"supField = 42",
"subField = {",
"a = (field = 4.2000000000000002",
"b = 123456",
],
)
self.expect(
"frame variable subSub",
substrs=[
"SubSub) subSub =",
"a.Sub = {",
"a.Sup = {",
"supField = 42",
"subField = {",
"a = (field = 4.2000000000000002",
"b = 123456",
"subSubField = (field = 4.2000000000000002)",
],
)
emptySinglePayload = frame.FindVariable("emptySinglePayload")
lldbutil.check_variable(self, emptySinglePayload, False, value='nonPayloadTwo')

smallMultipayloadEnum1 = frame.FindVariable("smallMultipayloadEnum1")
one = smallMultipayloadEnum1.GetChildMemberWithName("one")
lldbutil.check_variable(self, one, False, value='two')

smallMultipayloadEnum2 = frame.FindVariable("smallMultipayloadEnum2")
two = smallMultipayloadEnum2.GetChildMemberWithName("two")
lldbutil.check_variable(self, two, False, value='one')


bigMultipayloadEnum1 = frame.FindVariable("bigMultipayloadEnum1")
one = bigMultipayloadEnum1.GetChildMemberWithName("one")
first = one.GetChildAtIndex(0).GetChildMemberWithName("supField")
second = one.GetChildAtIndex(1).GetChildMemberWithName("supField")
third = one.GetChildAtIndex(2).GetChildMemberWithName("supField")
lldbutil.check_variable(self, first, False, value='42')
lldbutil.check_variable(self, second, False, value='43')
lldbutil.check_variable(self, third, False, value='44')


fullMultipayloadEnum1 = frame.FindVariable("fullMultipayloadEnum1")
one = fullMultipayloadEnum1.GetChildMemberWithName("one")
lldbutil.check_variable(self, one, False, value='120')

fullMultipayloadEnum2 = frame.FindVariable("fullMultipayloadEnum2")
two = fullMultipayloadEnum2.GetChildMemberWithName("two")
lldbutil.check_variable(self, two, False, value='9.5')

bigFullMultipayloadEnum1 = frame.FindVariable("bigFullMultipayloadEnum1")
one = bigFullMultipayloadEnum1.GetChildMemberWithName("one")
first = one.GetChildAtIndex(0)
second = one.GetChildAtIndex(1)
lldbutil.check_variable(self, first, False, value='209')
lldbutil.check_variable(self, second, False, value='315')

bigFullMultipayloadEnum2 = frame.FindVariable("bigFullMultipayloadEnum2")
two = bigFullMultipayloadEnum2.GetChildMemberWithName("two")
first = two.GetChildAtIndex(0)
second = two.GetChildAtIndex(1)
lldbutil.check_variable(self, first, False, value='452.5')
lldbutil.check_variable(self, second, False, value='753.5')


sup = frame.FindVariable("sup")
supField = sup.GetChildMemberWithName("supField")
lldbutil.check_variable(self, supField, False, value='42')

sub = frame.FindVariable("sub")
supField = sub.GetChildMemberWithName("supField")
lldbutil.check_variable(self, supField, False, value='42')
subField = sub.GetChildMemberWithName("subField")
a = subField.GetChildMemberWithName("a")
field = a.GetChildMemberWithName("field")
lldbutil.check_variable(self, field, False, value='4.5')
b = subField.GetChildMemberWithName("b")
lldbutil.check_variable(self, b, False, value='123456')

subSub = frame.FindVariable("subSub")
supField = subSub.GetChildMemberWithName("supField")
lldbutil.check_variable(self, supField, False, value='42')
subField = subSub.GetChildMemberWithName("subField")
a = subField.GetChildMemberWithName("a")
field = a.GetChildMemberWithName("field")
lldbutil.check_variable(self, field, False, value='4.5')
b = subField.GetChildMemberWithName("b")
lldbutil.check_variable(self, b, False, value='123456')

subSubField = subSub.GetChildMemberWithName("subSubField").GetChildMemberWithName("field")
lldbutil.check_variable(self, subSubField, False, value='4.5')

gsp = frame.FindVariable("gsp")
t = gsp.GetChildMemberWithName("t")
lldbutil.check_variable(self, t, False, value='42')
u = gsp.GetChildMemberWithName("u")
lldbutil.check_variable(self, u, False, value='94.5')

gsp2 = frame.FindVariable("gsp2")
t = gsp2.GetChildMemberWithName("t")
supField = t.GetChildMemberWithName("supField")
lldbutil.check_variable(self, supField, False, value='42')
u = gsp2.GetChildMemberWithName("u")
a = u.GetChildMemberWithName("a")
field = a.GetChildMemberWithName("field")
lldbutil.check_variable(self, field, False, value='4.5')
b = u.GetChildMemberWithName("b")
lldbutil.check_variable(self, b, False, value='123456')

gsp3 = frame.FindVariable("gsp3")
t = gsp3.GetChildMemberWithName("t")
one = t.GetChildMemberWithName("one")
first = one.GetChildAtIndex(0)
second = one.GetChildAtIndex(1)
lldbutil.check_variable(self, first, False, value='209')
lldbutil.check_variable(self, second, False, value='315')
u = gsp3.GetChildMemberWithName("u")
two = u.GetChildMemberWithName("two")
lldbutil.check_variable(self, two, False, value='one')

gcp = frame.FindVariable("gcp")
t = gcp.GetChildMemberWithName("t")
lldbutil.check_variable(self, t, False, value='55.5')
u = gcp.GetChildMemberWithName("u")
lldbutil.check_variable(self, u, False, value='9348')


either = frame.FindVariable("either")
left = either.GetChildMemberWithName("left")
lldbutil.check_variable(self, left, False, value='1234')

either2 = frame.FindVariable("either2")
right = either2.GetChildMemberWithName("right")
t = right.GetChildMemberWithName("t")
one = t.GetChildMemberWithName("one")
first = one.GetChildAtIndex(0)
second = one.GetChildAtIndex(1)
lldbutil.check_variable(self, first, False, value='209')
lldbutil.check_variable(self, second, False, value='315')
u = right.GetChildMemberWithName("u")
two = u.GetChildMemberWithName("two")
lldbutil.check_variable(self, two, False, value='one')
Loading