Skip to content

Commit f8b9f01

Browse files
Fixed asyncio lock waiter deadlocks after cancellation (#1145)
--------- Co-authored-by: Alex Grönholm <[email protected]>
1 parent d517ee1 commit f8b9f01

3 files changed

Lines changed: 58 additions & 17 deletions

File tree

‎docs/versionhistory.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,10 @@ This library adheres to `Semantic Versioning 2.0 <http://semver.org/>`_.
8383
``anyio.run()``; the options are now passed as keyword arguments to ``trio.run()``
8484
again, as documented (a regression from AnyIO 3)
8585
(`#1161 <https://github.com/agronholm/anyio/pull/1161>`_; PR by @Zac-HD)
86+
- Fixed asyncio ``Lock`` and ``Semaphore`` deadlocks caused by cancelled waiters
87+
left queued during release
88+
(`#1145 <https://github.com/agronholm/anyio/pull/1145>`_; PR by @rasmusfaber,
89+
@x42005e1f and @agronholm)
8690

8791
**4.13.0**
8892

‎src/anyio/_backends/_asyncio.py‎

Lines changed: 30 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1880,14 +1880,16 @@ async def acquire(self) -> None:
18801880
try:
18811881
await fut
18821882
except CancelledError:
1883-
self._waiters.remove(item)
1884-
if self._owner_task is task:
1883+
if fut.cancelled():
1884+
try:
1885+
self._waiters.remove(item)
1886+
except ValueError:
1887+
pass
1888+
else:
18851889
self.release()
18861890

18871891
raise
18881892

1889-
self._waiters.remove(item)
1890-
18911893
def acquire_nowait(self) -> None:
18921894
task = cast(asyncio.Task, current_task())
18931895
if self._owner_task is None and not self._waiters:
@@ -1906,11 +1908,17 @@ def release(self) -> None:
19061908
if self._owner_task != current_task():
19071909
raise RuntimeError("The current task is not holding this lock")
19081910

1909-
for task, fut in self._waiters:
1910-
if not fut.cancelled():
1911-
self._owner_task = task
1912-
fut.set_result(None)
1913-
return
1911+
# A cancelled waiter that already received ownership removes itself from
1912+
# _waiters before calling release(); any cancelled waiter still queued here
1913+
# was cancelled before being woken, so drop it.
1914+
while self._waiters:
1915+
task, fut = self._waiters.popleft()
1916+
if fut.cancelled():
1917+
continue
1918+
1919+
self._owner_task = task
1920+
fut.set_result(None)
1921+
return
19141922

19151923
self._owner_task = None
19161924

@@ -1965,9 +1973,12 @@ async def acquire(self) -> None:
19651973
try:
19661974
await fut
19671975
except CancelledError:
1968-
try:
1969-
self._waiters.remove(fut)
1970-
except ValueError:
1976+
if fut.cancelled():
1977+
try:
1978+
self._waiters.remove(fut)
1979+
except ValueError:
1980+
pass
1981+
else:
19711982
self.release()
19721983

19731984
raise
@@ -1982,11 +1993,13 @@ def release(self) -> None:
19821993
if self._max_value is not None and self._value == self._max_value:
19831994
raise ValueError("semaphore released too many times")
19841995

1985-
for fut in self._waiters:
1986-
if not fut.cancelled():
1987-
fut.set_result(None)
1988-
self._waiters.remove(fut)
1989-
return
1996+
while self._waiters:
1997+
fut = self._waiters.popleft()
1998+
if fut.cancelled():
1999+
continue
2000+
2001+
fut.set_result(None)
2002+
return
19902003

19912004
self._value += 1
19922005

‎tests/test_synchronization.py‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,18 @@ async def test_cancel_after_release(self) -> None:
214214
assert statistics.tasks_waiting == 0
215215
lock.acquire_nowait()
216216

217+
async def test_cancelled_after_acquire(self) -> None:
218+
lock = Lock()
219+
lock.acquire_nowait()
220+
async with create_task_group() as tg:
221+
task1 = tg.create_task(lock.acquire())
222+
await wait_all_tasks_blocked()
223+
task1.cancel()
224+
lock.release()
225+
assert lock.statistics().tasks_waiting == 0
226+
with fail_after(3):
227+
await lock.acquire()
228+
217229
def test_instantiate_outside_event_loop(
218230
self, anyio_backend_name: str, anyio_backend_options: dict[str, Any]
219231
) -> None:
@@ -661,6 +673,18 @@ async def test_cancel_after_release(self) -> None:
661673
assert semaphore.statistics().tasks_waiting == 0
662674
semaphore.acquire_nowait()
663675

676+
async def test_cancelled_after_acquire(self) -> None:
677+
semaphore = Semaphore(1, max_value=1)
678+
semaphore.acquire_nowait()
679+
async with create_task_group() as tg:
680+
task1 = tg.create_task(semaphore.acquire())
681+
await wait_all_tasks_blocked()
682+
task1.cancel()
683+
semaphore.release()
684+
assert semaphore.statistics().tasks_waiting == 0
685+
with fail_after(3):
686+
await semaphore.acquire()
687+
664688
def test_instantiate_outside_event_loop(
665689
self, anyio_backend_name: str, anyio_backend_options: dict[str, Any]
666690
) -> None:

0 commit comments

Comments
 (0)