Skip to content

Latest commit

 

History

History
148 lines (107 loc) · 5.17 KB

README.rst

File metadata and controls

148 lines (107 loc) · 5.17 KB
Raw

GeventMP - Gevent Multiprocessing Extension

Gitter Build Status Coverage Status

GeventMP Version GeventMP Python Versions GeventMP Downloads Per Day GeventMP Downloads Per Week GeventMP Downloads Per Month

Warning

HIC SUNT DRACONES!!!

This code is experimental (beta). There is some testing, but a lots of things are in flux, and some platforms don't work at all.

You MAY try to use this in production with the understanding that this is a beta-quality software.

That said, this code may crash your server, bankrupt your company, burn your house down and be mean to your puppy.

You've been warned.

Problem

Due to internal implementation, multiprocessing (MP) is unsafe to use with Gevent even when monkey-patched. Namely, the use of OS semaphore primitives and inter-process IO in MP will cause the main loop to stall/deadlock/block (specific issue depends on the version of CPython).

Solution

GeventMP (Gee-vent Em-Pee) is a gevent multiprocessing extension plugin for the monkey-patching subsystem. As with the rest of the monkey patch subsystem the process is fairly clear:

  1. Identify all places where blocking occurs and where it may stall the loop.
  2. If blocking occurs on a file descriptor (FD), try to convert the file descriptor from blocking to non-blocking (sockets/pipes/fifos, sometimes even files where, rarely, appropriate) and replace blocking IO functions with their gevent non-blocking equivalents.
  3. If blocking occurs in a Python/OS primitive that does not support non-blocking access and thus cannot be geventized, wrap all blocking access to that primitive with native thread-pool-based wrappers and call it a day (while fully understanding that primitive access latency will increase and raw performance may suffer as a result).
  4. If you are really brave and have lots of free time on your hands, completely replace a standard blocking Python non-FD-based primitive with implementation based on an FD-based OS primitive (e.g. POSIX semaphore => Linux eventfd-based semaphore for kernels > 2.6.30).
  5. Due to launching of separate processes in MP, figure out how, when, and whether to monkey-patch spawned/forked children and grandchildren.

Installation

The package is hosted on PyPi.

For stable version:

pip install geventmp

For unstable version:

pip install --pre geventmp

Once installed, GeventMP will activate by default in the below stanza.

from gevent.monkey import patch_all
patch_all()

If you would like GeventMP to not activate by default, either do not install it or explicitly disable it:

from gevent.monkey import patch_all
patch_all(geventmp=False)

That's it - there are no other flags, settings, properties or config values so far.

Supported Platforms

Note

All claims of support may not be real at all. You're welcome to experiment. See warnings on top.

  • Linux and Darwin.
  • CPython 3.9, 3.10, 3.11, 3.12, 3.13
  • PyPy 3.9, 3.10

Known Issues

  • Multiprocessing forkserver works in GeventMP, but the spawned child isn't green.

TODO

  1. Monkey patch Windows to the extent possible.
  2. Lots of applications use Billiard for multiprocessing instead of stock Python package. Consider monkey patching Billiard if detected.

Contact Us

Post feedback and issues on the Bug Tracker, Gitter, and Twitter (@karelleninc).