classification
Title: Resuming a 'yield from' stack is broken if a signal arrives in the middle
Type: Stage:
Components: Interpreter Core Versions: Python 3.7, Python 3.6, Python 3.5
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: yselivanov Nosy List: haypo, njs, yselivanov
Priority: normal Keywords:

Created on 2017-04-11 09:33 by njs, last changed 2017-05-17 23:23 by yselivanov.

Pull Requests
URL Status Linked Edit
PR 1081 merged njs, 2017-04-11 09:42
PR 1640 open yselivanov, 2017-05-17 23:23
Messages (4)
msg291469 - (view) Author: Nathaniel Smith (njs) * Date: 2017-04-11 09:33
If we have a chain of generators/coroutines that are 'yield from'ing each other, then resuming the stack works like:

- call send() on the outermost generator
- this enters _PyEval_EvalFrameDefault, which re-executes the YIELD_FROM opcode
- which calls send() on the next generator
- which enters _PyEval_EvalFrameDefault, which re-executes the YIELD_FROM opcode
- ...etc.

However, every time we enter _PyEval_EvalFrameDefault, the first thing we do is to check for pending signals, and if there are any then we run the signal handler. And if it raises an exception, then we immediately propagate that exception *instead* of starting to execute bytecode. This means that e.g. a SIGINT at the wrong moment can "break the chain" – it can be raised in the middle of our yield from chain, with the bottom part of the stack abandoned for the garbage collector.

The fix is pretty simple: there's already a special case in _PyEval_EvalFrameEx where it skips running signal handlers if the next opcode is SETUP_FINALLY. (I don't see how this accomplishes anything useful, but that's another story.) If we extend this check to also skip running signal handlers when the next opcode is YIELD_FROM, then that closes the hole – now the exception can only be raised at the innermost stack frame.

This shouldn't have any performance implications, because the opcode check happens inside the "slow path" after we've already determined that there's a pending signal or something similar for us to process; the vast majority of the time this isn't true.

I'll post a PR in a few minutes that has a test case that demonstrates the problem and fails on current master, plus the fix.
msg293887 - (view) Author: Yury Selivanov (yselivanov) * (Python committer) Date: 2017-05-17 20:33
New changeset ab4413a7e9bda95b6fcd517073e2a51dafaa1624 by Yury Selivanov (Nathaniel J. Smith) in branch 'master':
bpo-30039: Don't run signal handlers while resuming a yield from stack (#1081)
https://github.com/python/cpython/commit/ab4413a7e9bda95b6fcd517073e2a51dafaa1624
msg293902 - (view) Author: STINNER Victor (haypo) * (Python committer) Date: 2017-05-17 23:01
The change should be backported to 3.5 and 3.6, right? The change seems very short and safe. IMHO it's ok to backport.
msg293903 - (view) Author: Yury Selivanov (yselivanov) * (Python committer) Date: 2017-05-17 23:02
Yes, I'll do the backport.
History
Date User Action Args
2017-05-17 23:23:43yselivanovsetpull_requests: + pull_request1735
2017-05-17 23:02:13yselivanovsetmessages: + msg293903
2017-05-17 23:01:08hayposetnosy: + haypo
messages: + msg293902
2017-05-17 20:33:25yselivanovsetmessages: + msg293887
2017-04-24 17:58:13Mariattasetassignee: yselivanov
2017-04-11 09:42:21njssetpull_requests: + pull_request1224
2017-04-11 09:33:27njscreate