Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GH-66285: fix forking in asyncio #99769

Merged
merged 1 commit into from
Nov 27, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions Lib/asyncio/events.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@

import contextvars
import os
import signal
import socket
import subprocess
import sys
Expand Down Expand Up @@ -842,3 +843,13 @@ def set_child_watcher(watcher):
_c_get_running_loop = get_running_loop
_c_get_event_loop = get_event_loop
_c__get_event_loop = _get_event_loop


if hasattr(os, 'fork'):
def on_fork():
# Reset the loop and wakeupfd in the forked child process.
if _event_loop_policy is not None:
kumaraditya303 marked this conversation as resolved.
Show resolved Hide resolved
_event_loop_policy._local = BaseDefaultEventLoopPolicy._Local()
signal.set_wakeup_fd(-1)

os.register_at_fork(after_in_child=on_fork)
98 changes: 98 additions & 0 deletions Lib/test/test_asyncio/test_unix_events.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import contextlib
import errno
import io
import multiprocessing
import os
import pathlib
import signal
Expand All @@ -15,6 +16,8 @@
import warnings
from test.support import os_helper
from test.support import socket_helper
from test.support import wait_process
from test.support import hashlib_helper

if sys.platform == 'win32':
raise unittest.SkipTest('UNIX only')
Expand Down Expand Up @@ -1867,5 +1870,100 @@ async def runner():
wsock.close()


@unittest.skipUnless(hasattr(os, 'fork'), 'requires os.fork()')
class TestFork(unittest.IsolatedAsyncioTestCase):

async def test_fork_not_share_event_loop(self):
# The forked process should not share the event loop with the parent
loop = asyncio.get_running_loop()
r, w = os.pipe()
self.addCleanup(os.close, r)
self.addCleanup(os.close, w)
pid = os.fork()
if pid == 0:
# child
try:
loop = asyncio.get_event_loop_policy().get_event_loop()
os.write(w, str(id(loop)).encode())
finally:
os._exit(0)
else:
# parent
child_loop = int(os.read(r, 100).decode())
self.assertNotEqual(child_loop, id(loop))
wait_process(pid, exitcode=0)

@hashlib_helper.requires_hashdigest('md5')
def test_fork_signal_handling(self):
# Sending signal to the forked process should not affect the parent
# process
ctx = multiprocessing.get_context('fork')
manager = ctx.Manager()
self.addCleanup(manager.shutdown)
child_started = manager.Event()
child_handled = manager.Event()
parent_handled = manager.Event()

def child_main():
signal.signal(signal.SIGTERM, lambda *args: child_handled.set())
child_started.set()
time.sleep(1)

async def main():
loop = asyncio.get_running_loop()
loop.add_signal_handler(signal.SIGTERM, lambda *args: parent_handled.set())

process = ctx.Process(target=child_main)
process.start()
child_started.wait()
os.kill(process.pid, signal.SIGTERM)
process.join()

async def func():
await asyncio.sleep(0.1)
return 42

# Test parent's loop is still functional
self.assertEqual(await asyncio.create_task(func()), 42)

asyncio.run(main())

self.assertFalse(parent_handled.is_set())
self.assertTrue(child_handled.is_set())

@hashlib_helper.requires_hashdigest('md5')
def test_fork_asyncio_run(self):
ctx = multiprocessing.get_context('fork')
manager = ctx.Manager()
self.addCleanup(manager.shutdown)
result = manager.Value('i', 0)

async def child_main():
await asyncio.sleep(0.1)
result.value = 42

process = ctx.Process(target=lambda: asyncio.run(child_main()))
process.start()
process.join()

self.assertEqual(result.value, 42)

@hashlib_helper.requires_hashdigest('md5')
def test_fork_asyncio_subprocess(self):
ctx = multiprocessing.get_context('fork')
manager = ctx.Manager()
self.addCleanup(manager.shutdown)
result = manager.Value('i', 1)

async def child_main():
proc = await asyncio.create_subprocess_exec(sys.executable, '-c', 'pass')
result.value = await proc.wait()

process = ctx.Process(target=lambda: asyncio.run(child_main()))
process.start()
process.join()

self.assertEqual(result.value, 0)

if __name__ == '__main__':
unittest.main()
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix :mod:`asyncio` to not share event loop and signal wakeupfd in forked processes. Patch by Kumar Aditya.