From 82ee341fe03e2bdb3c3d14cda0953469b80750e7 Mon Sep 17 00:00:00 2001 From: Matt Martz Date: Wed, 16 Oct 2019 15:30:50 -0500 Subject: [PATCH] Explicitly use multiprocessing fork start method (#63581) * Explicitly use multiprocessing fork start method * Remove unused import * Remove unused import * Fallback to just multiprocessing on py2 --- changelogs/fragments/python38-macos.yaml | 2 ++ lib/ansible/executor/process/worker.py | 4 ++-- lib/ansible/executor/task_queue_manager.py | 4 ++-- lib/ansible/utils/multiprocessing.py | 21 +++++++++++++++++++++ 4 files changed, 27 insertions(+), 4 deletions(-) create mode 100644 changelogs/fragments/python38-macos.yaml create mode 100644 lib/ansible/utils/multiprocessing.py diff --git a/changelogs/fragments/python38-macos.yaml b/changelogs/fragments/python38-macos.yaml new file mode 100644 index 00000000000..e418dbedbd1 --- /dev/null +++ b/changelogs/fragments/python38-macos.yaml @@ -0,0 +1,2 @@ +bugfixes: +- TaskQueueManager - Explicitly set the mutliprocessing start method to ``fork`` to avoid issues with the default on macOS now being ``spawn``. diff --git a/lib/ansible/executor/process/worker.py b/lib/ansible/executor/process/worker.py index 5d3e1ed4990..d01ff7f5cc5 100644 --- a/lib/ansible/executor/process/worker.py +++ b/lib/ansible/executor/process/worker.py @@ -19,7 +19,6 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type -import multiprocessing import os import sys import traceback @@ -41,13 +40,14 @@ from ansible.executor.task_executor import TaskExecutor from ansible.executor.task_result import TaskResult from ansible.module_utils._text import to_text from ansible.utils.display import Display +from ansible.utils.multiprocessing import context as multiprocessing_context __all__ = ['WorkerProcess'] display = Display() -class WorkerProcess(multiprocessing.Process): +class WorkerProcess(multiprocessing_context.Process): ''' The worker thread class, which uses TaskExecutor to run tasks read from a job queue and pushes results into a results queue diff --git a/lib/ansible/executor/task_queue_manager.py b/lib/ansible/executor/task_queue_manager.py index cee75710084..475e71d1923 100644 --- a/lib/ansible/executor/task_queue_manager.py +++ b/lib/ansible/executor/task_queue_manager.py @@ -19,7 +19,6 @@ from __future__ import (absolute_import, division, print_function) __metaclass__ = type -import multiprocessing import os import tempfile @@ -41,6 +40,7 @@ from ansible.utils.helpers import pct_to_int from ansible.vars.hostvars import HostVars from ansible.vars.reserved import warn_if_reserved from ansible.utils.display import Display +from ansible.utils.multiprocessing import context as multiprocessing_context __all__ = ['TaskQueueManager'] @@ -97,7 +97,7 @@ class TaskQueueManager: self._unreachable_hosts = dict() try: - self._final_q = multiprocessing.Queue() + self._final_q = multiprocessing_context.Queue() except OSError as e: raise AnsibleError("Unable to use multiprocessing, this is normally caused by lack of access to /dev/shm: %s" % to_native(e)) diff --git a/lib/ansible/utils/multiprocessing.py b/lib/ansible/utils/multiprocessing.py new file mode 100644 index 00000000000..dcc186597aa --- /dev/null +++ b/lib/ansible/utils/multiprocessing.py @@ -0,0 +1,21 @@ +# Copyright (c) 2019 Matt Martz +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +# Make coding more python3-ish +from __future__ import (absolute_import, division, print_function) +__metaclass__ = type + +import multiprocessing + +# Explicit multiprocessing context using the fork start method +# This exists as a compat layer now that Python3.8 has changed the default +# start method for macOS to ``spawn`` which is incompatible with our +# code base currently +# +# This exists in utils to allow it to be easily imported into various places +# without causing circular import or dependency problems +try: + context = multiprocessing.get_context('fork') +except AttributeError: + # Py2 has no context functionality, and only supports fork + context = multiprocessing