Skip to content

Commit a7714ed

Browse files
kastiglionekastiglione
authored
[lldb] Add summary formatter for Swift Task (llvm#10265)
This change vertically condenses how a `Task` is displayed, by hiding the boolean members (ex `isRunning`) and placing those flags in the summary string. The synthetic formatter continues to expose these (and only these) 4 children: * `address` * `id` * `enqueuePriority` * `children` The flags are pipe (`|`) delimited, matching the format used by `swift-inspect`. Here's an example of output when printing a `Task`: ``` (Task<(), Error>) task = id:2 flags:enqueued|future { address = 0x14b604490 id = 2 enqueuePriority = .medium children = {} } ``` This change also removes the `Task`'s `kind` field, which currently relevant only in special cases. See `JobKind` in `MetadataValues.h`.
1 parent 4772ab8 commit a7714ed

File tree

7 files changed

+186
-96
lines changed

7 files changed

+186
-96
lines changed

‎lldb/source/Plugins/Language/Swift/SwiftFormatters.cpp‎

Lines changed: 74 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@
3636
#include "swift/Demangling/ManglingMacros.h"
3737
#include "llvm/ADT/STLExtras.h"
3838
#include "llvm/ADT/StringRef.h"
39+
#include "llvm/ADT/iterator_range.h"
3940
#include "llvm/Support/Error.h"
4041
#include "llvm/Support/FormatAdapters.h"
4142
#include "llvm/Support/raw_ostream.h"
@@ -778,10 +779,13 @@ class TaskSyntheticFrontEnd : public SyntheticChildrenFrontEnd {
778779
}
779780

780781
constexpr static StringLiteral TaskChildren[] = {
782+
// clang-format off
781783
"address",
782784
"id",
783-
"kind",
784-
"enqueuPriority",
785+
"enqueuePriority",
786+
"children",
787+
788+
// Children below this point are hidden.
785789
"isChildTask",
786790
"isFuture",
787791
"isGroupChildTask",
@@ -790,13 +794,13 @@ class TaskSyntheticFrontEnd : public SyntheticChildrenFrontEnd {
790794
"isStatusRecordLocked",
791795
"isEscalated",
792796
"isEnqueued",
793-
"children",
794797
"isRunning",
798+
// clang-format on
795799
};
796800

797801
llvm::Expected<uint32_t> CalculateNumChildren() override {
798-
auto count = ArrayRef(TaskChildren).size();
799-
return m_task_info.hasIsRunning ? count : count - 1;
802+
// Show only the first four children address/id/enqueuePriority/children.
803+
return 4;
800804
}
801805

802806
lldb::ValueObjectSP GetChildAtIndex(uint32_t idx) override {
@@ -805,15 +809,6 @@ class TaskSyntheticFrontEnd : public SyntheticChildrenFrontEnd {
805809
// TypeMangling for "Swift.Bool"
806810
CompilerType bool_type =
807811
m_ts->GetTypeFromMangledTypename(ConstString("$sSbD"));
808-
// TypeMangling for "Swift.UInt32"
809-
CompilerType uint32_type =
810-
m_ts->GetTypeFromMangledTypename(ConstString("$ss6UInt32VD"));
811-
// TypeMangling for "Swift.UInt64"
812-
CompilerType uint64_type =
813-
m_ts->GetTypeFromMangledTypename(ConstString("$ss6UInt64VD"));
814-
// TypeMangling for "Swift.TaskPriority"
815-
CompilerType priority_type =
816-
m_ts->GetTypeFromMangledTypename(ConstString("$sScPD"));
817812

818813
#define RETURN_CHILD(FIELD, NAME, TYPE) \
819814
if (!FIELD) { \
@@ -841,12 +836,34 @@ class TaskSyntheticFrontEnd : public SyntheticChildrenFrontEnd {
841836
raw_pointer_type);
842837
}
843838
return m_address_sp;
844-
case 1:
839+
case 1: {
840+
// TypeMangling for "Swift.UInt64"
841+
CompilerType uint64_type =
842+
m_ts->GetTypeFromMangledTypename(ConstString("$ss6UInt64VD"));
845843
RETURN_CHILD(m_id_sp, id, uint64_type);
846-
case 2:
847-
RETURN_CHILD(m_kind_sp, kind, uint32_type);
848-
case 3:
844+
}
845+
case 2: {
846+
// TypeMangling for "Swift.TaskPriority"
847+
CompilerType priority_type =
848+
m_ts->GetTypeFromMangledTypename(ConstString("$sScPD"));
849849
RETURN_CHILD(m_enqueue_priority_sp, enqueuePriority, priority_type);
850+
}
851+
case 3: {
852+
if (!m_child_tasks_sp) {
853+
using task_type = decltype(m_task_info.childTasks)::value_type;
854+
const std::vector<task_type> &tasks = m_task_info.childTasks;
855+
std::string mangled_typename =
856+
mangledTypenameForTasksTuple(tasks.size());
857+
CompilerType tasks_tuple_type =
858+
m_ts->GetTypeFromMangledTypename(ConstString(mangled_typename));
859+
DataExtractor data{tasks.data(), tasks.size() * sizeof(task_type),
860+
endian::InlHostByteOrder(), sizeof(void *)};
861+
m_child_tasks_sp = ValueObject::CreateValueObjectFromData(
862+
"children", data, m_backend.GetExecutionContextRef(),
863+
tasks_tuple_type);
864+
}
865+
return m_child_tasks_sp;
866+
}
850867
case 4:
851868
RETURN_CHILD(m_is_child_task_sp, isChildTask, bool_type);
852869
case 5:
@@ -865,22 +882,10 @@ class TaskSyntheticFrontEnd : public SyntheticChildrenFrontEnd {
865882
case 11:
866883
RETURN_CHILD(m_is_enqueued_sp, isEnqueued, bool_type);
867884
case 12: {
868-
if (!m_child_tasks_sp) {
869-
const auto &tasks = m_task_info.childTasks;
870-
std::string mangled_typename =
871-
mangledTypenameForTasksTuple(tasks.size());
872-
CompilerType tasks_tuple_type =
873-
m_ts->GetTypeFromMangledTypename(ConstString(mangled_typename));
874-
DataExtractor data{tasks.data(), tasks.size() * sizeof(tasks[0]),
875-
endian::InlHostByteOrder(), sizeof(void *)};
876-
m_child_tasks_sp = ValueObject::CreateValueObjectFromData(
877-
"children", data, m_backend.GetExecutionContextRef(),
878-
tasks_tuple_type);
879-
}
880-
return m_child_tasks_sp;
885+
if (m_task_info.hasIsRunning)
886+
RETURN_CHILD(m_is_running_sp, isRunning, bool_type);
887+
return {};
881888
}
882-
case 13:
883-
RETURN_CHILD(m_is_running_sp, isRunning, bool_type);
884889
default:
885890
return {};
886891
}
@@ -1641,6 +1646,42 @@ bool lldb_private::formatters::swift::TaskPriority_SummaryProvider(
16411646
return true;
16421647
}
16431648

1649+
static const std::pair<StringRef, StringRef> TASK_FLAGS[] = {
1650+
{"isRunning", "running"},
1651+
{"isCancelled", "cancelled"},
1652+
{"isEscalated", "escalated"},
1653+
{"isEnqueued", "enqueued"},
1654+
{"isGroupChildTask", "groupChildTask"},
1655+
{"isAsyncLetTask", "asyncLetTask"},
1656+
{"isChildTask", "childTask"},
1657+
{"isFuture", "future"},
1658+
{"isStatusRecordLocked", "statusRecordLocked"},
1659+
};
1660+
1661+
bool lldb_private::formatters::swift::Task_SummaryProvider(
1662+
ValueObject &valobj, Stream &stream, const TypeSummaryOptions &options) {
1663+
auto get_member = [&valobj](StringRef name) -> uint64_t {
1664+
if (auto member_sp = valobj.GetChildMemberWithName(name))
1665+
if (auto synthetic_sp = member_sp->GetSyntheticValue())
1666+
return synthetic_sp->GetValueAsUnsigned(0);
1667+
return 0;
1668+
};
1669+
1670+
stream.Format("id:{0}", get_member("id"));
1671+
1672+
std::vector<StringRef> flags;
1673+
for (auto [member, flag] : TASK_FLAGS)
1674+
if (get_member(member))
1675+
flags.push_back(flag);
1676+
1677+
if (!flags.empty())
1678+
// Append the flags in an `|` separated list. This matches the format used
1679+
// by swift-inspect dump-concurrency.
1680+
stream.Format(" flags:{0:$[|]}", iterator_range(flags));
1681+
1682+
return true;
1683+
}
1684+
16441685
namespace {
16451686

16461687
/// Enumerate the kinds of SIMD elements.

‎lldb/source/Plugins/Language/Swift/SwiftFormatters.h‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,9 @@ bool TypePreservingNSNumber_SummaryProvider(ValueObject &valobj, Stream &stream,
117117
bool TaskPriority_SummaryProvider(ValueObject &valobj, Stream &stream,
118118
const TypeSummaryOptions &options);
119119

120+
bool Task_SummaryProvider(ValueObject &valobj, Stream &stream,
121+
const TypeSummaryOptions &options);
122+
120123
SyntheticChildrenFrontEnd *EnumSyntheticFrontEndCreator(CXXSyntheticChildren *,
121124
lldb::ValueObjectSP);
122125

‎lldb/source/Plugins/Language/Swift/SwiftLanguage.cpp‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -491,6 +491,19 @@ static void LoadSwiftFormatters(lldb::TypeCategoryImplSP swift_category_sp) {
491491
lldb_private::formatters::swift::TaskPriority_SummaryProvider,
492492
"Swift TaskPriority summary provider", "Swift.TaskPriority",
493493
summary_flags);
494+
{
495+
auto task_summary_flags = summary_flags;
496+
task_summary_flags.SetDontShowChildren(false);
497+
AddCXXSummary(swift_category_sp,
498+
lldb_private::formatters::swift::Task_SummaryProvider,
499+
"Swift Task summary provider", "^Swift\\.Task<.+,.+>",
500+
task_summary_flags, true);
501+
AddCXXSummary(swift_category_sp,
502+
lldb_private::formatters::swift::Task_SummaryProvider,
503+
"Swift UnsafeCurrentTask summary provider",
504+
"Swift.UnsafeCurrentTask", task_summary_flags);
505+
}
506+
494507
summary_flags.SetSkipPointers(false);
495508
// this is an ObjC dynamic type - as such it comes in pointer form
496509
// NSContiguousString* - do not skip pointers here

‎lldb/test/API/lang/swift/async/continuations/TestSwiftContinuationSynthetic.py‎

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
import textwrap
12
import lldb
23
from lldbsuite.test.decorators import *
34
from lldbsuite.test.lldbtest import *
@@ -15,12 +16,19 @@ def test_unsafe_continuation_printing(self):
1516
)
1617
self.expect(
1718
"v cont",
18-
substrs=[
19-
"(UnsafeContinuation<Void, Never>) cont = {",
20-
"task = {",
21-
"address = 0x",
22-
"id = ",
23-
"isFuture = true",
19+
patterns=[
20+
textwrap.dedent(
21+
r"""
22+
\(UnsafeContinuation<Void, Never>\) cont = \{
23+
task = id:(\d+) flags:(?:running\|)?future \{
24+
address = 0x[0-9a-f]+
25+
id = \1
26+
enqueuePriority = 0
27+
children = \{\}
28+
\}
29+
\}
30+
"""
31+
).strip()
2432
],
2533
)
2634

@@ -33,11 +41,18 @@ def test_checked_continuation_printing(self):
3341
)
3442
self.expect(
3543
"v cont",
36-
substrs=[
37-
"(CheckedContinuation<Int, Never>) cont = {",
38-
"task = {",
39-
"address = 0x",
40-
"id = ",
41-
"isFuture = true",
44+
patterns=[
45+
textwrap.dedent(
46+
r"""
47+
\(CheckedContinuation<Int, Never>\) cont = \{
48+
task = id:(\d+) flags:(?:running\|)?future \{
49+
address = 0x[0-9a-f]+
50+
id = \1
51+
enqueuePriority = 0
52+
children = \{\}
53+
\}
54+
\}
55+
"""
56+
).strip()
4257
],
4358
)

‎lldb/test/API/lang/swift/async/formatters/task/TestSwiftTaskSyntheticProvider.py‎

Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
import textwrap
12
import lldb
23
from lldbsuite.test.decorators import *
34
from lldbsuite.test.lldbtest import *
@@ -17,19 +18,17 @@ def test_top_level_task(self):
1718
# the test checks only that it has a value, not what the value is.
1819
self.expect(
1920
"frame var task",
20-
substrs=[
21-
"(Task<(), Error>) task = {",
22-
"address = 0x",
23-
"id = 2",
24-
"kind = 0",
25-
"enqueuePriority = .medium",
26-
"isChildTask = false",
27-
"isFuture = true",
28-
"isGroupChildTask = false",
29-
"isAsyncLetTask = false",
30-
"isCancelled = false",
31-
"isEnqueued = ",
32-
"children = {}",
21+
patterns=[
22+
textwrap.dedent(
23+
r"""
24+
\(Task<\(\), Error>\) task = id:(\d+) flags:(?:running\|)?enqueued\|future \{
25+
address = 0x[0-9a-f]+
26+
id = \1
27+
enqueuePriority = \.medium
28+
children = \{\}
29+
}
30+
"""
31+
).strip()
3332
],
3433
)
3534

@@ -43,16 +42,16 @@ def test_current_task(self):
4342
)
4443
self.expect(
4544
"frame var currentTask",
46-
substrs=[
47-
"(UnsafeCurrentTask) currentTask = {",
48-
"address = 0x",
49-
"id = ",
50-
"isChildTask = true",
51-
"isFuture = true",
52-
"isGroupChildTask = false",
53-
"isAsyncLetTask = true",
54-
"isCancelled = false",
55-
"isEnqueued = false",
56-
"children = {}",
45+
patterns=[
46+
textwrap.dedent(
47+
r"""
48+
\(UnsafeCurrentTask\) currentTask = id:(\d+) flags:(?:running\|)?asyncLetTask|childTask|future \{
49+
address = 0x[0-9a-f]+
50+
id = \1
51+
enqueuePriority = \.medium
52+
children = \{\}
53+
\}
54+
"""
55+
).strip()
5756
],
5857
)

‎lldb/test/API/lang/swift/async/formatters/task/children/TestSwiftSyntheticTaskChildren.py‎

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
import textwrap
12
import lldb
23
from lldbsuite.test.decorators import *
34
from lldbsuite.test.lldbtest import *
@@ -16,18 +17,23 @@ def test(self):
1617
)
1718
self.expect(
1819
"language swift task info",
19-
substrs=[
20-
"(UnsafeCurrentTask) current_task = {",
21-
"address = 0x",
22-
"id = 1",
23-
"isChildTask = false",
24-
"isAsyncLetTask = false",
25-
"children = {",
26-
"0 = {",
27-
"address = 0x",
28-
"id = 2",
29-
"isChildTask = true",
30-
"isAsyncLetTask = true",
31-
"children = {}",
20+
patterns=[
21+
textwrap.dedent(
22+
r"""
23+
\(UnsafeCurrentTask\) current_task = id:1 flags:(?:running\|)?future \{
24+
address = 0x[0-9a-f]+
25+
id = 1
26+
enqueuePriority = 0
27+
children = \{
28+
0 = id:2 flags:(?:running\|)?asyncLetTask\|childTask\|future {
29+
address = 0x[0-9a-f]+
30+
id = 2
31+
enqueuePriority = \.medium
32+
children = \{\}
33+
\}
34+
\}
35+
\}
36+
"""
37+
).strip()
3238
],
3339
)

0 commit comments

Comments
 (0)