Skip to content

Commit ab5b8f8

Browse files
authored
gh-161502: Fix missing tasks in asyncio pstree with intermediate Futures (#161508)
Include intermediate Future nodes when the remote asyncio unwinder builds awaited-by graphs.
1 parent e0d0f2e commit ab5b8f8

6 files changed

Lines changed: 199 additions & 32 deletions

File tree

‎Lib/asyncio/tools.py‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,22 +157,31 @@ def get_all_awaited_by(pid):
157157
return unwinder.get_all_awaited_by()
158158

159159

160-
def build_async_tree(result, task_emoji="(T)", cor_emoji=""):
160+
def build_async_tree(result, task_emoji="(T)", cor_emoji="", fut_emoji="(F)"):
161161
"""
162162
Build a list of strings for pretty-print an async call tree.
163163
164164
The call tree is produced by `get_all_async_stacks()`, prefixing tasks
165-
with `task_emoji` and coroutine frames with `cor_emoji`.
165+
with `task_emoji`, futures with `fut_emoji`, and coroutine frames with
166+
`cor_emoji`.
166167
"""
167168
id2name, awaits, task_stacks = _index(result)
168169
g = _task_graph(awaits)
169170
cycles = _find_cycles(g)
170171
if cycles:
171172
raise CycleFoundException(cycles, id2name)
172173
labels, children = _build_tree(id2name, awaits, task_stacks)
174+
future_ids = {
175+
node.task_id
176+
for thread in result
177+
for node in thread.awaited_by
178+
if node.is_future
179+
}
173180

174181
def pretty(node):
175182
flag = task_emoji if node[0] == NodeType.TASK else cor_emoji
183+
if node[0] == NodeType.TASK and node[1] in future_ids:
184+
flag = fut_emoji
176185
return f"{flag} {labels[node]}"
177186

178187
def render(root):

‎Lib/test/test_external_inspection.py‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -608,6 +608,73 @@ async def main():
608608
stacks = self._extract_coroutine_funcnames(asyncio.run(main()))
609609
self.assertEqual(stacks["anext"], ["agen"])
610610

611+
@skip_if_not_supported
612+
def test_future_between_tasks(self):
613+
# gh-161502
614+
from asyncio.tools import build_async_tree
615+
616+
async def worker(method):
617+
return getattr(RemoteUnwinder(os.getpid()), method)()
618+
619+
async def main(method):
620+
parent = asyncio.current_task()
621+
parent.set_name("main")
622+
future = asyncio.Future()
623+
task = asyncio.create_task(worker(method), name="worker")
624+
asyncio.future_add_to_awaited_by(task, future)
625+
task.add_done_callback(future.set_result)
626+
try:
627+
await future
628+
return task.result(), {
629+
id(parent): [],
630+
id(future): [id(parent)],
631+
id(task): [id(future)],
632+
}
633+
finally:
634+
asyncio.future_discard_from_awaited_by(task, future)
635+
636+
for method in ("get_all_awaited_by", "get_async_stack_trace"):
637+
with self.subTest(method=method):
638+
snapshot, expected = asyncio.run(main(method))
639+
tree, = build_async_tree(snapshot)
640+
rendered = "\n".join(tree)
641+
self.assertIn("(T) main", rendered)
642+
self.assertIn("(F) Future-", rendered)
643+
self.assertIn("(T) worker", rendered)
644+
relationships = {
645+
node.task_id: [edge.task_name for edge in node.awaited_by]
646+
for thread in snapshot for node in thread.awaited_by
647+
}
648+
self.assertEqual(relationships, expected)
649+
650+
@skip_if_not_supported
651+
def test_shared_future_waiter(self):
652+
async def main():
653+
layers = [[asyncio.current_task()]]
654+
for _ in range(14):
655+
waiters = [asyncio.Future(), asyncio.Future()]
656+
for child in layers[-1]:
657+
for waiter in waiters:
658+
asyncio.future_add_to_awaited_by(child, waiter)
659+
self.addCleanup(asyncio.future_discard_from_awaited_by,
660+
child, waiter)
661+
layers.append(waiters)
662+
663+
leaf, root = layers[-1][0], layers[0][0]
664+
asyncio.future_add_to_awaited_by(leaf, root)
665+
self.addCleanup(asyncio.future_discard_from_awaited_by, leaf, root)
666+
667+
expected_ids = [id(node) for layer in layers for node in layer]
668+
unwinder = RemoteUnwinder(os.getpid())
669+
for method in (unwinder.get_all_awaited_by,
670+
unwinder.get_async_stack_trace):
671+
with self.subTest(method=method.__name__):
672+
ids = [node.task_id for thread in method()
673+
for node in thread.awaited_by]
674+
self.assertCountEqual(ids, expected_ids)
675+
676+
asyncio.run(main())
677+
611678
@skip_if_not_supported
612679
def test_async_generator_running_task_stack(self):
613680
# gh-159620
@@ -4783,6 +4850,37 @@ def _assert_unwinder_limit_error(self, unwind, expected_substring):
47834850
f"{last_error!r}"
47844851
)
47854852

4853+
@skip_if_not_supported
4854+
def test_get_all_awaited_by_at_waiter_limit(self):
4855+
# gh-161502
4856+
async def main():
4857+
task = asyncio.current_task()
4858+
limit = self.TASK_WAITER_WALK_TASKS - 1
4859+
for _ in range(limit):
4860+
future = asyncio.Future()
4861+
asyncio.future_add_to_awaited_by(task, future)
4862+
self.addCleanup(asyncio.future_discard_from_awaited_by, task, future)
4863+
4864+
release = asyncio.Event()
4865+
child = asyncio.create_task(release.wait())
4866+
waiter = asyncio.create_task(asyncio.wait([child]), eager_start=True)
4867+
unwinder = RemoteUnwinder(os.getpid())
4868+
snapshot = unwinder.get_all_awaited_by()
4869+
count = sum(node.is_future for thread in snapshot
4870+
for node in thread.awaited_by)
4871+
self.assertEqual(count, limit)
4872+
4873+
extra = asyncio.Future()
4874+
asyncio.future_add_to_awaited_by(task, extra)
4875+
self.addCleanup(asyncio.future_discard_from_awaited_by, task, extra)
4876+
with self.assertRaisesRegex(RuntimeError, "Too many task waiters"):
4877+
unwinder.get_all_awaited_by()
4878+
4879+
release.set()
4880+
await waiter
4881+
4882+
asyncio.run(main())
4883+
47864884
@skip_if_not_supported
47874885
@unittest.skipIf(
47884886
sys.platform == "linux" and not PROCESS_VM_READV_SUPPORTED,
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Fix missing tasks in ``python -m asyncio pstree`` output when tasks are
2+
connected through an intermediate :class:`asyncio.Future`. Patch by Timofei
3+
Ivankov

‎Modules/_remote_debugging/asyncio.c‎

Lines changed: 58 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -534,10 +534,11 @@ parse_task_awaited_by(
534534
uintptr_t task_address,
535535
PyObject *awaited_by
536536
) {
537-
// Read the entire TaskObj at once
538537
char task_obj[SIZEOF_TASK_OBJ];
538+
size_t size = unwinder->async_debug_offsets.asyncio_task_object.task_awaited_by_is_set
539+
+ sizeof(char);
539540
if (_Py_RemoteDebug_PagedReadRemoteMemory(&unwinder->handle, task_address,
540-
(size_t)unwinder->async_debug_offsets.asyncio_task_object.size,
541+
size,
541542
task_obj) < 0) {
542543
set_exception_cause(unwinder, PyExc_RuntimeError, "Failed to read task object");
543544
return -1;
@@ -571,7 +572,16 @@ process_single_task_node(
571572
PyObject *result_item = NULL;
572573
PyObject *coroutine_stack = NULL;
573574

574-
tn = parse_task_name(unwinder, task_addr);
575+
char is_task;
576+
// task_is_task = 1 => task
577+
// task_is_task = 0 => future
578+
if (read_char(unwinder,
579+
task_addr + unwinder->async_debug_offsets.asyncio_task_object.task_is_task,
580+
&is_task) < 0) {
581+
goto error;
582+
}
583+
tn = is_task ? parse_task_name(unwinder, task_addr)
584+
: PyUnicode_FromFormat("Future-%p", (void *)task_addr);
575585
if (tn == NULL) {
576586
set_exception_cause(unwinder, PyExc_RuntimeError, "Failed to parse task name in single task node");
577587
goto error;
@@ -612,6 +622,7 @@ process_single_task_node(
612622
PyStructSequence_SetItem(result_item, 1, tn); // steals ref
613623
PyStructSequence_SetItem(result_item, 2, coroutine_stack); // steals ref
614624
PyStructSequence_SetItem(result_item, 3, current_awaited_by); // steals ref
625+
PyStructSequence_SetItem(result_item, 4, PyBool_FromLong(!is_task));
615626

616627
// References transferred to tuple
617628
task_id = NULL;
@@ -652,37 +663,68 @@ process_single_task_node(
652663
static int
653664
process_task_waiters(
654665
RemoteUnwinderObject *unwinder,
655-
PyObject *result
666+
PyObject *result,
667+
bool futures_only
656668
) {
669+
Py_ssize_t initial_count = futures_only ? PyList_GET_SIZE(result) : 0;
670+
PyObject *visited = PySet_New(NULL);
671+
if (visited == NULL) {
672+
return -1;
673+
}
657674
for (Py_ssize_t i = 0; i < PyList_GET_SIZE(result); i++) {
658675
PyObject *task_info = PyList_GET_ITEM(result, i);
676+
if (PySet_Add(visited, PyStructSequence_GET_ITEM(task_info, 0)) < 0) {
677+
goto error;
678+
}
659679
PyObject *waiters = PyStructSequence_GET_ITEM(task_info, 3);
660680
for (Py_ssize_t j = 0; j < PyList_GET_SIZE(waiters); j++) {
661-
if (PyList_GET_SIZE(result) >= MAX_TASK_WAITER_WALK_TASKS) {
662-
PyErr_SetString(PyExc_RuntimeError,
663-
"Too many task waiters (possible infinite loop)");
664-
set_exception_cause(unwinder, PyExc_RuntimeError,
665-
"Task waiter walk size limit exceeded");
666-
return -1;
667-
}
668681
PyObject *waiter = PyList_GET_ITEM(waiters, j);
669-
// CoroInfo item 1 holds the waiter task address stored by parse_task().
670682
PyObject *task_id = PyStructSequence_GET_ITEM(waiter, 1);
683+
int seen = PySet_Contains(visited, task_id);
684+
if (seen > 0) {
685+
continue;
686+
}
687+
if (seen < 0 || PySet_Add(visited, task_id) < 0) {
688+
goto error;
689+
}
671690
void *task_ptr = PyLong_AsVoidPtr(task_id);
672691
if (task_ptr == NULL && PyErr_Occurred()) {
673692
set_exception_cause(unwinder, PyExc_RuntimeError,
674693
"Failed to parse waiter task ID");
675-
return -1;
694+
goto error;
695+
}
696+
if (futures_only) {
697+
char is_task;
698+
if (read_char(unwinder,
699+
(uintptr_t)task_ptr + unwinder->async_debug_offsets.asyncio_task_object.task_is_task,
700+
&is_task) < 0) {
701+
goto error;
702+
}
703+
if (is_task) {
704+
continue;
705+
}
706+
}
707+
if (PyList_GET_SIZE(result) - initial_count >= MAX_TASK_WAITER_WALK_TASKS) {
708+
PyErr_SetString(PyExc_RuntimeError,
709+
"Too many task waiters (possible infinite loop)");
710+
set_exception_cause(unwinder, PyExc_RuntimeError,
711+
"Task waiter walk size limit exceeded");
712+
goto error;
676713
}
677714
if (process_single_task_node(
678715
unwinder, (uintptr_t)task_ptr, NULL, result) < 0)
679716
{
680-
return -1;
717+
goto error;
681718
}
682719
}
683720
}
684721

722+
Py_DECREF(visited);
685723
return 0;
724+
725+
error:
726+
Py_DECREF(visited);
727+
return -1;
686728
}
687729

688730
/* ============================================================================
@@ -927,7 +969,7 @@ append_awaited_by(
927969
return -1;
928970
}
929971

930-
return 0;
972+
return process_task_waiters(unwinder, task_list, true);
931973
}
932974

933975
/* ============================================================================
@@ -991,7 +1033,7 @@ process_running_task_chain(
9911033
}
9921034

9931035
// Now find all tasks that are waiting for this task and process them
994-
if (process_task_waiters(unwinder, result) < 0) {
1036+
if (process_task_waiters(unwinder, result, false) < 0) {
9951037
return -1;
9961038
}
9971039

‎Modules/_remote_debugging/clinic/module.c.h‎

Lines changed: 13 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)