commit: ca763549507d995e91a49753b13bcca8748fae6c Author: Zac Medico <zmedico <AT> gentoo <DOT> org> AuthorDate: Tue Jun 16 03:14:36 2020 +0000 Commit: Zac Medico <zmedico <AT> gentoo <DOT> org> CommitDate: Tue Jun 16 03:14:49 2020 +0000 URL: https://gitweb.gentoo.org/proj/portage.git/commit/?id=ca763549
Revert "PipeLogger: non-blocking write to pipe (bug 709746)" This reverts commit 3e46825a047067a96ed997fe394f85e042e542a8. We've had reports of emerge hangs, so reverting this for now. Bug: https://bugs.gentoo.org/709746 Signed-off-by: Zac Medico <zmedico <AT> gentoo.org> lib/portage/tests/process/test_PipeLogger.py | 54 -------------------- lib/portage/util/_async/PipeLogger.py | 73 +++++----------------------- 2 files changed, 13 insertions(+), 114 deletions(-) diff --git a/lib/portage/tests/process/test_PipeLogger.py b/lib/portage/tests/process/test_PipeLogger.py deleted file mode 100644 index 2b9f10eeb..000000000 --- a/lib/portage/tests/process/test_PipeLogger.py +++ /dev/null @@ -1,54 +0,0 @@ -# Copyright 2020 Gentoo Authors -# Distributed under the terms of the GNU General Public License v2 - -from portage import os -from portage.tests import TestCase -from portage.util._async.PipeLogger import PipeLogger -from portage.util.futures import asyncio -from portage.util.futures._asyncio.streams import _reader, _writer -from portage.util.futures.compat_coroutine import coroutine, coroutine_return - - -class PipeLoggerTestCase(TestCase): - - @coroutine - def _testPipeLoggerToPipe(self, test_string, loop=None): - """ - Test PipeLogger writing to a pipe connected to a PipeReader. - This verifies that PipeLogger does not deadlock when writing - to a pipe that's drained by a PipeReader running in the same - process (requires non-blocking write). - """ - - pr1, pw1 = os.pipe() - writer = asyncio.ensure_future(_writer(pw1, test_string.encode('ascii')), loop=loop) - - pr, pw = os.pipe() - - consumer = PipeLogger(background=True, - input_fd=pr1, - log_file_path=os.fdopen(pw, 'wb', 0), - scheduler=loop) - consumer.start() - - # Before starting the reader, wait here for a moment, in order - # to exercise PipeLogger's handling of EAGAIN during write. - yield asyncio.wait([writer], timeout=0.01) - - reader = _reader(pr, loop=loop) - yield writer - content = yield reader - yield consumer.async_wait() - - self.assertEqual(consumer.returncode, os.EX_OK) - - coroutine_return(content.decode('ascii', 'replace')) - - def testPipeLogger(self): - loop = asyncio._wrap_loop() - - for x in (1, 2, 5, 6, 7, 8, 2**5, 2**10, 2**12, 2**13, 2**14, 2**17, 2**17 + 1): - test_string = x * "a" - output = loop.run_until_complete(self._testPipeLoggerToPipe(test_string, loop=loop)) - self.assertEqual(test_string, output, - "x = %s, len(output) = %s" % (x, len(output))) diff --git a/lib/portage/util/_async/PipeLogger.py b/lib/portage/util/_async/PipeLogger.py index 1776cc860..a4258f350 100644 --- a/lib/portage/util/_async/PipeLogger.py +++ b/lib/portage/util/_async/PipeLogger.py @@ -8,9 +8,6 @@ import sys import portage from portage import os, _encodings, _unicode_encode -from portage.util.futures import asyncio -from portage.util.futures.compat_coroutine import coroutine -from portage.util.futures.unix_events import _set_nonblocking from _emerge.AbstractPollTask import AbstractPollTask class PipeLogger(AbstractPollTask): @@ -24,15 +21,13 @@ class PipeLogger(AbstractPollTask): """ __slots__ = ("input_fd", "log_file_path", "stdout_fd") + \ - ("_io_loop_task", "_log_file", "_log_file_real") + ("_log_file", "_log_file_real") def _start(self): log_file_path = self.log_file_path - if hasattr(log_file_path, 'write'): - self._log_file = log_file_path - _set_nonblocking(self._log_file.fileno()) - elif log_file_path is not None: + if log_file_path is not None: + self._log_file = open(_unicode_encode(log_file_path, encoding=_encodings['fs'], errors='strict'), mode='ab') if log_file_path.endswith('.gz'): @@ -62,8 +57,7 @@ class PipeLogger(AbstractPollTask): fcntl.fcntl(fd, fcntl.F_SETFD, fcntl.fcntl(fd, fcntl.F_GETFD) | fcntl.FD_CLOEXEC) - self._io_loop_task = asyncio.ensure_future(self._io_loop(fd), loop=self.scheduler) - self._io_loop_task.add_done_callback(self._io_loop_done) + self.scheduler.add_reader(fd, self._output_handler, fd) self._registered = True def _cancel(self): @@ -71,8 +65,8 @@ class PipeLogger(AbstractPollTask): if self.returncode is None: self.returncode = self._cancelled_returncode - @coroutine - def _io_loop(self, fd): + def _output_handler(self, fd): + background = self.background stdout_fd = self.stdout_fd log_file = self._log_file @@ -82,19 +76,14 @@ class PipeLogger(AbstractPollTask): if buf is None: # not a POLLIN event, EAGAIN, etc... - future = self.scheduler.create_future() - self.scheduler.add_reader(fd, future.set_result, None) - try: - yield future - finally: - if not self.scheduler.is_closed(): - self.scheduler.remove_reader(fd) - future.done() or future.cancel() - continue + break if not buf: # EOF - return + self._unregister() + self.returncode = self.returncode or os.EX_OK + self._async_wait() + break else: if not background and stdout_fd is not None: @@ -131,39 +120,8 @@ class PipeLogger(AbstractPollTask): fcntl.F_GETFL) ^ os.O_NONBLOCK) if log_file is not None: - if isinstance(log_file, gzip.GzipFile): - # Use log_file.write since data written directly - # to the file descriptor bypasses compression. - log_file.write(buf) - log_file.flush() - continue - - write_buf = buf - while write_buf: - try: - # Use os.write, since the log_file.write method - # looses data when an EAGAIN occurs. - write_buf = write_buf[os.write(log_file.fileno(), write_buf):] - except EnvironmentError as e: - if e.errno != errno.EAGAIN: - raise - future = self.scheduler.create_future() - self.scheduler.add_writer(self._log_file.fileno(), future.set_result, None) - try: - yield future - finally: - if not self.scheduler.is_closed(): - self.scheduler.remove_writer(self._log_file.fileno()) - future.done() or future.cancel() - - def _io_loop_done(self, future): - try: - future.result() - except asyncio.CancelledError: - self.cancel() - self._was_cancelled() - self.returncode = self.returncode or os.EX_OK - self._async_wait() + log_file.write(buf) + log_file.flush() def _unregister(self): if self.input_fd is not None: @@ -175,16 +133,11 @@ class PipeLogger(AbstractPollTask): self.input_fd.close() self.input_fd = None - if self._io_loop_task is not None: - self._io_loop_task.done() or self._io_loop_task.cancel() - self._io_loop_task = None - if self.stdout_fd is not None: os.close(self.stdout_fd) self.stdout_fd = None if self._log_file is not None: - self.scheduler.remove_writer(self._log_file.fileno()) self._log_file.close() self._log_file = None
