Merge pull request #10980 from swiftlang/dl/lldb-Include-suspended-flag-for-Tasks

[lldb] Include "suspended" flag for Tasks

Author: adrian-prantl

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

@@ -828,6 +828,7 @@ class TaskSyntheticFrontEnd : public SyntheticChildrenFrontEnd {
       "isEscalated",
       "isEnqueued",
       "isComplete",
+      "isSuspended",
       "isRunning",
       // clang-format on
   };
@@ -964,7 +965,9 @@ class TaskSyntheticFrontEnd : public SyntheticChildrenFrontEnd {
       RETURN_CHILD(m_is_enqueued_sp, isEnqueued, bool_type);
     case 13:
       RETURN_CHILD(m_is_complete_sp, isComplete, bool_type);
-    case 14: {
+    case 14:
+      RETURN_CHILD(m_is_suspended_sp, isSuspended, bool_type);
+    case 15: {
       if (m_task_info.hasIsRunning)
         RETURN_CHILD(m_is_running_sp, isRunning, bool_type);
       return {};
@@ -996,8 +999,8 @@ class TaskSyntheticFrontEnd : public SyntheticChildrenFrontEnd {
                 m_is_child_task_sp, m_is_future_sp, m_is_group_child_task_sp,
                 m_is_async_let_task_sp, m_is_cancelled_sp,
                 m_is_status_record_locked_sp, m_is_escalated_sp,
-                m_is_enqueued_sp, m_is_complete_sp, m_parent_task_sp,
-                m_child_tasks_sp, m_is_running_sp})
+                m_is_enqueued_sp, m_is_complete_sp, m_is_suspended_sp,
+                m_parent_task_sp, m_child_tasks_sp, m_is_running_sp})
             child.reset();
         }
       }
@@ -1038,6 +1041,7 @@ class TaskSyntheticFrontEnd : public SyntheticChildrenFrontEnd {
   ValueObjectSP m_is_escalated_sp;
   ValueObjectSP m_is_enqueued_sp;
   ValueObjectSP m_is_complete_sp;
+  ValueObjectSP m_is_suspended_sp;
   ValueObjectSP m_parent_task_sp;
   ValueObjectSP m_child_tasks_sp;
   ValueObjectSP m_is_running_sp;
@@ -1928,6 +1932,7 @@ bool lldb_private::formatters::swift::TaskPriority_SummaryProvider(
 
 static const std::pair<StringRef, StringRef> TASK_FLAGS[] = {
     {"isComplete", "complete"},
+    {"isSuspended", "suspended"},
     {"isRunning", "running"},
     {"isCancelled", "cancelled"},
     {"isEscalated", "escalated"},

lldb/source/Plugins/LanguageRuntime/Swift/ReflectionContext.cpp

@@ -428,6 +428,7 @@ class TargetReflectionContext : public ReflectionContextInterface {
     result.isRunning = task_info.IsRunning;
     result.isEnqueued = task_info.IsEnqueued;
     result.isComplete = task_info.IsComplete;
+    result.isSuspended = task_info.IsSuspended;
     result.id = task_info.Id;
     result.kind = task_info.Kind;
     result.enqueuePriority = task_info.EnqueuePriority;

lldb/source/Plugins/LanguageRuntime/Swift/ReflectionContextInterface.h

@@ -169,6 +169,7 @@ class ReflectionContextInterface {
     bool isRunning = false;
     bool isEnqueued = false;
     bool isComplete = false;
+    bool isSuspended = false;
     uint64_t id = 0;
     uint32_t kind = 0;
     uint32_t enqueuePriority = 0;

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

@@ -21,7 +21,7 @@ def test_top_level_task(self):
             patterns=[
                 textwrap.dedent(
                     r"""
-                    \(Task<\(\), Error>\) task = id:([1-9]\d*) flags:(?:running|enqueued) \{
+                    \(Task<\(\), Error>\) task = id:([1-9]\d*) flags:(?:suspended\|)?(?:running|enqueued) \{
                       address = 0x[0-9a-f]+
                       id = \1
                       enqueuePriority = \.medium

lldb/test/API/lang/swift/async/formatters/task/suspended/Makefile

@@ -0,0 +1,3 @@
+SWIFT_SOURCES := main.swift
+SWIFTFLAGS_EXTRAS := -parse-as-library
+include Makefile.rules

lldb/test/API/lang/swift/async/formatters/task/suspended/TestSwiftTaskSuspended.py

@@ -0,0 +1,16 @@
+import textwrap
+import lldb
+from lldbsuite.test.decorators import *
+from lldbsuite.test.lldbtest import *
+from lldbsuite.test import lldbutil
+
+
+class TestCase(TestBase):
+
+    @swiftTest
+    def test(self):
+        self.build()
+        lldbutil.run_to_source_breakpoint(
+            self, "break here", lldb.SBFileSpec("main.swift")
+        )
+        self.expect("v task", substrs=["flags:suspended"])

lldb/test/API/lang/swift/async/formatters/task/suspended/main.swift

@@ -0,0 +1,9 @@
+@main struct Main {
+    static func main() async {
+        let task = Task {
+            try? await Task.sleep(for: .seconds(100))
+        }
+        try? await Task.sleep(for: .seconds(0.5))
+        print("break here")
+    }
+}

lldb/test/API/lang/swift/async/taskgroups/TestSwiftTaskGroupSynthetic.py

@@ -32,21 +32,21 @@ def do_test_print(self):
                 textwrap.dedent(
                     r"""
                     \((?:Throwing)?TaskGroup<\(\)\??(?:, Error)?>\) group = \{
-                      \[0\] = id:([1-9]\d*) flags:(?:running\|)?(?:enqueued\|)?groupChildTask \{
+                      \[0\] = id:([1-9]\d*) flags:(?:suspended\|)?(?:running\|)?(?:enqueued\|)?groupChildTask \{
                         address = 0x[0-9a-f]+
                         id = \1
                         enqueuePriority = \.medium
                         parent = (.+)
                         children = \{\}
                       \}
-                      \[1\] = id:([1-9]\d*) flags:(?:running\|)?(?:enqueued\|)?groupChildTask \{
+                      \[1\] = id:([1-9]\d*) flags:(?:suspended\|)?(?:running\|)?(?:enqueued\|)?groupChildTask \{
                         address = 0x[0-9a-f]+
                         id = \3
                         enqueuePriority = \.medium
                         parent = \2
                         children = \{\}
                       \}
-                      \[2\] = id:([1-9]\d*) flags:(?:running\|)?(?:enqueued\|)?groupChildTask \{
+                      \[2\] = id:([1-9]\d*) flags:(?:suspended\|)?(?:running\|)?(?:enqueued\|)?groupChildTask \{
                         address = 0x[0-9a-f]+
                         id = \4
                         enqueuePriority = \.medium