Add a cancel scope around child debugger requests
This is needed in order to avoid the deadlock condition where a child actor is waiting on the root actor's tty lock but it's parent (possibly the root) is waiting on it to terminate after sending a cancel request. The solution is simple: create a cancel scope around the request in the child and always cancel it when a cancel request from the parent arrives.debug_tests
Tyler Goodlet
parent
363498b882
commit
25e93925b0
|
|
@ -27,7 +27,7 @@ from ._exceptions import (
|
|||
unpack_error,
|
||||
ModuleNotExposed
|
||||
)
|
||||
from ._debug import _maybe_enter_pm
|
||||
from . import _debug
|
||||
from ._discovery import get_arbiter
|
||||
from ._portal import Portal
|
||||
from . import _state
|
||||
|
|
@ -129,7 +129,7 @@ async def _invoke(
|
|||
except (Exception, trio.MultiError) as err:
|
||||
# NOTE: don't enter debug mode recursively after quitting pdb
|
||||
log.exception("Actor crashed:")
|
||||
await _maybe_enter_pm(err)
|
||||
await _debug._maybe_enter_pm(err)
|
||||
|
||||
# always ship errors back to caller
|
||||
err_msg = pack_error(err)
|
||||
|
|
@ -832,6 +832,14 @@ class Actor:
|
|||
|
||||
# cancel all ongoing rpc tasks
|
||||
with trio.CancelScope(shield=True):
|
||||
|
||||
# kill any debugger request task to avoid deadlock
|
||||
# with the root actor in this tree
|
||||
dbcs = _debug._debugger_request_cs
|
||||
if dbcs is not None:
|
||||
log.debug("Cancelling active debugger request")
|
||||
dbcs.cancel()
|
||||
|
||||
# kill all ongoing tasks
|
||||
await self.cancel_rpc_tasks()
|
||||
|
||||
|
|
@ -1051,7 +1059,7 @@ async def _start_actor(
|
|||
result = await main()
|
||||
except (Exception, trio.MultiError) as err:
|
||||
log.exception("Actor crashed:")
|
||||
await _maybe_enter_pm(err)
|
||||
await _debug._maybe_enter_pm(err)
|
||||
raise
|
||||
|
||||
# XXX: the actor is cancelled when this context is complete
|
||||
|
|
|
|||
|
|
@ -11,6 +11,7 @@ import signal
|
|||
from async_generator import aclosing
|
||||
import tractor
|
||||
import trio
|
||||
# from trio.testing import wait_all_tasks_blocked
|
||||
|
||||
from .log import get_logger
|
||||
from . import _state
|
||||
|
|
@ -39,6 +40,11 @@ _in_debug = False
|
|||
# lock in root actor preventing multi-access to local tty
|
||||
_debug_lock = trio.StrictFIFOLock()
|
||||
|
||||
# XXX: set by the current task waiting on the root tty lock
|
||||
# and must be cancelled if this actor is cancelled via message
|
||||
# otherwise deadlocks with the parent actor may ensure
|
||||
_debugger_request_cs: trio.CancelScope = None
|
||||
|
||||
|
||||
class TractorConfig(pdbpp.DefaultConfig):
|
||||
"""Custom ``pdbpp`` goodness.
|
||||
|
|
@ -119,7 +125,6 @@ async def _acquire_debug_lock():
|
|||
log.error("TTY lock acquired")
|
||||
yield
|
||||
finally:
|
||||
if _debug_lock.locked():
|
||||
_debug_lock.release()
|
||||
log.error("TTY lock released")
|
||||
|
||||
|
|
@ -151,16 +156,6 @@ def _disable_sigint():
|
|||
async def _hijack_stdin_relay_to_child(
|
||||
subactor_uid: Tuple[str, str]
|
||||
) -> None:
|
||||
actor = tractor.current_actor()
|
||||
nursery = actor._actoruid2nursery[subactor_uid]
|
||||
print(f'NURSERY: {nursery}')
|
||||
print(f'nursery is cancelled {nursery.cancelled}')
|
||||
if actor._is_cancelled or nursery.cancelled:
|
||||
raise RuntimeError(
|
||||
"Can not engage debugger actor is already cancelled")
|
||||
|
||||
await trio.sleep(0)
|
||||
|
||||
# TODO: when we get to true remote debugging
|
||||
# this will deliver stdin data
|
||||
log.warning(f"Actor {subactor_uid} is WAITING on stdin hijack lock")
|
||||
|
|
@ -172,6 +167,7 @@ async def _hijack_stdin_relay_to_child(
|
|||
yield 'Locked'
|
||||
|
||||
# wait for cancellation of stream by child
|
||||
# indicating debugger is dis-engaged
|
||||
await trio.sleep_forever()
|
||||
|
||||
log.debug(f"Actor {subactor_uid} RELEASED stdin hijack lock")
|
||||
|
|
@ -190,6 +186,9 @@ def _breakpoint(debug_func) -> Awaitable[None]:
|
|||
async def wait_for_parent_stdin_hijack(
|
||||
task_status=trio.TASK_STATUS_IGNORED
|
||||
):
|
||||
global _debugger_request_cs
|
||||
with trio.CancelScope() as cs:
|
||||
_debugger_request_cs = cs
|
||||
try:
|
||||
async with tractor._portal.open_portal(
|
||||
actor._parent_chan,
|
||||
|
|
@ -237,7 +236,6 @@ def _breakpoint(debug_func) -> Awaitable[None]:
|
|||
f"Actor {actor.uid} already has a debug lock, waiting...")
|
||||
await do_unlock.wait()
|
||||
await trio.sleep(0.1)
|
||||
# return
|
||||
|
||||
# assign unlock callback for debugger teardown hooks
|
||||
global _pdb_release_hook
|
||||
|
|
@ -253,9 +251,6 @@ def _breakpoint(debug_func) -> Awaitable[None]:
|
|||
# being restricted by the scope of a new task nursery.
|
||||
await actor._service_n.start(wait_for_parent_stdin_hijack)
|
||||
|
||||
# block here one (at the appropriate frame *up* where
|
||||
# ``breakpoint()`` was awaited and begin handling stdio
|
||||
# debug_func(actor)
|
||||
else:
|
||||
# we also wait in the root-parent for any child that
|
||||
# may have the tty locked prior
|
||||
|
|
@ -270,6 +265,7 @@ def _breakpoint(debug_func) -> Awaitable[None]:
|
|||
|
||||
# block here one (at the appropriate frame *up* where
|
||||
# ``breakpoint()`` was awaited and begin handling stdio
|
||||
log.debug("Entering the synchronous world of the debugger")
|
||||
debug_func(actor)
|
||||
|
||||
# user code **must** await this!
|
||||
|
|
|
|||
Loading…
Reference in New Issue