multiprocessing needs option to eschew fork() under Linux

[brandon-rhodes]

BPO	8713
Nosy	@gpshead, @pitrou, @tiran, @ned-deily, @ezio-melotti, @dholth
Files	mp_fork_exec.patch mp_fork_exec.patch mp_split_tests.patch 8f08d83264a0.diff d9fe9757ba0c.diff b3620777f54c.diff c7aa0005f231.diff 4fc7c72b1c5d.diff

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2013-08-29.17:51:41.313>
created_at = <Date 2010-05-14.16:13:09.390>
labels = ['type-feature', 'library']
title = 'multiprocessing needs option to eschew fork() under Linux'
updated_at = <Date 2014-03-10.22:11:25.777>
user = 'https://bugs.python.org/brandon-rhodes'

bugs.python.org fields:

activity = <Date 2014-03-10.22:11:25.777>
actor = 'python-dev'
assignee = 'none'
closed = True
closed_date = <Date 2013-08-29.17:51:41.313>
closer = 'sbt'
components = ['Library (Lib)']
creation = <Date 2010-05-14.16:13:09.390>
creator = 'brandon-rhodes'
dependencies = []
files = ['23142', '24297', '24298', '28461', '31181', '31186', '31214', '31282']
hgrepos = ['157']
issue_num = 8713
keywords = ['patch']
message_count = 48.0
messages = ['105719', '105724', '105730', '105734', '105936', '126748', '142915', '142918', '143966', '143969', '149996', '149998', '150001', '150004', '150030', '150582', '151818', '151819', '151882', '173646', '173647', '173648', '173670', '173850', '175999', '178213', '178301', '178312', '178314', '178335', '178340', '193924', '194627', '194651', '194656', '194796', '195088', '195141', '195174', '195178', '195181', '195251', '195266', '196167', '196457', '196458', '196470', '213102']
nosy_count = 19.0
nosy_names = ['gregory.p.smith', 'pitrou', 'christian.heimes', 'ned.deily', 'jnoller', 'ezio.melotti', 'rcoyner', 'asksol', 'dholth', 'brandon-rhodes', 'neologix', 'catalin.iacob', 'python-dev', 'sbt', 'numbernine', 'vsekhar', 'piotr.dobrogost', 'mrmekon', 'Stan.Seibert']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue8713'
versions = ['Python 3.4']

[brandon-rhodes]

The "multiprocessing" module uses a bare fork() to create child processes under Linux, so the children get a copy of the entire state of the parent process. But under Windows, child processes are freshly spun-up Python interpreters with none of the data structures or open connections of the parent process available. This means that code that tests fine under Linux, because it is depending on residual parent state in a way that the programmer has not noticed, can fail spectacularly under Windows.

Therefore, the "multiprocessing" module should offer an option under Linux that ignores the advantage of being able to do a bare fork() and instead spins up a new interpreter instance just like Windows does. Some developers will just use this for testing under Linux, so their test results are valid for Windows too; and some developers might even use this in production, preferring to give up a bit of efficiency under Linux in return for an application that will show the same behavior on both platforms. Either way, an option that lets the developer subvert the simple "sys.platform != 'win32'" check in "forking.py" would go a long way towards helping us write platform-agnostic Python programs.

[jnoller]

This is on my wish list; but I have not had time to do it. Patch welcome.

[brandon-rhodes]

Jesse, it's great to learn it's on your wish list too!

Should I design the patch so that (a) there is some global in the module that needs tweaking to choose the child creation technique, or (b) that an argument to the Process() constructor forces a full interpreter exec to make all platforms match, or (c) that a process object once created has an attribute (like ".daemon") that you set before starting it off? Or (d) should there be a subclass of Process that, if specifically used, has the fork/exec behavior instead of just doing the fork?

My vote would probably be for (b), but you have a much better feel for the library and its style than I do.

[jnoller]

I pretty much agree with (b) an argument - your gut instinct is correct - there's a long standing thread in python-dev which pretty much solidified my thinking about whether or not we need this (we do).

Any patch has to be backwards compatible by the way, it can not alter the current default behavior, also, it has to target python3 as 2.7 is nearing final, and this is a behavioral change.

[cool-RR]

+1 for this issue; I've also wished for this feature in the past.

[dholth]

+1

[asksol]

I have suspected that this may be necessary, not just merely useful, for some time, and bpo-6721 seems to verify that. In addition to adding the keyword arg to Process, it should also be added to Pool and Manager.

Is anyone working on a patch? If not I will work on a patch asap.

[jnoller]

No one is currently working on a patch AFAIK

[sbt]

Here is a patch which adds the following functions:

  forking_disable()
  forking_enable()
  forking_is_enabled()
  set_semaphore_prefix()
  get_semaphore_prefix()

To create child processes using fork+exec on Unix, call
forking_disable() at the beginning of the program.

I have tested the patch on Linux (by adding forking_disable() to
test_multiprocessing), and it seems to work. However, the patch does
not modify test_multiprocessing, and I am not sure of the best way to
do so. (See below.)

There are some issues with named semaphores. When forking is
disabled, the name of the semaphore must be left unlinked so that
child processes can use sem_open() on the name. The patch therefore
delays unlinking the name (only when forking is disabled) until the
original SemLock object is garbage collected or the process which
created it exits.

But if a process is killed without exiting cleanly then the name may
be left unlinked. This happens, for instance, if I run
test_multiprocessing and then keep hitting ^C until all the processes
exit. On Linux this leaves files with names like

/dev/shm/sem.mp-fa012c80-4019-2

which represent leaked semaphores. These won't be destroyed until the
computer reboots or the semaphores are manually removed (by using
sem_unlink() or by unlinking the entry from the file system).

If some form of this patch is accepted, then the problem of leaked
semaphores needs to be addressed, otherwise the buildbots are likely
run out of named semaphores. But I am not sure how best to do this in
a platform agnostic way. (Maybe a forked process could collect names
of all semaphores created, via a pipe. Then it could try to
sem_unlink() all those names when all write-ends of the pipe are
closed.)

[sbt]

Small fix to patch.

[neologix]

Thanks for the patch sbt.
I think this is indeed useful, but I'm tempted to go further and say we should make this the default - and only - behavior. This will probably break existing code that accidentaly relied the fact that the implementation uses a bare fork(), but i'd say it's worth it:

• it's cleaner
• it will make it possible to remove all the ad-hoc handlers called after fork()
• it will remove the only place in the whole stdlib where fork() isn't followed by exec(): people who get bitten by issue bpo-6721 will thus only be people calling explicitely fork(), in which case they're the sole responsibles for their misery ;-)

Another - although less common - advantage over the current implementation is that now one can run out of memory pretty easily if the operating system doesn't do overcommitting if you work with a large dataset. If fork() is followed by an exec, no problem.

Thoughts?

[pitrou]

Thanks for the patch sbt.
I think this is indeed useful, but I'm tempted to go further and say
we should make this the default - and only - behavior. This will
probably break existing code that accidentaly relied the fact that the
implementation uses a bare fork(),

There is probably lots of such code:

• code that passes non-pickleable function object / function args to
  execute in the child process
• code that executes code with side effects at module top level
• code that relies (willingly or not) on other stuff such as fds being
  inherited

[sbt]

I think this is indeed useful, but I'm tempted to go further and say we
should make this the default - and only - behavior. This will probably
break existing code that accidentaly relied the fact that the
implementation uses a bare fork(), but i'd say it's worth it:

I'm not convinced about making it the default behaviour, and certainly not the only one.

I have a working patch which ensures that leaked semaphores get cleaned up on exit. However, I think to add proper tests for the patch, test_multiprocessing needs to be refactored. Maybe we could end up with

multiprocessing_common.py
test_multiprocessing_processes_fork.py
test_multiprocessing_processes_nofork.py
test_multiprocessing_manager_fork.py
test_multiprocessing_manager_nofork.py
test_multiprocessing_threads.py
test_multiprocessing_others.py

The actual unittests would be in multiprocessing_common.py and test_multiprocessing_others.py. The other files would run the unittests in multiprocessing_common.py using different configurations.

Thoughts?