Skip to content

bpo-40007: Make asyncio.transport.writelines on selector use sendmsg #19062

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

Closed
wants to merge 1 commit into from
Closed
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
102 changes: 99 additions & 3 deletions Lib/asyncio/selector_events.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@
from .log import logger


sendmsg = getattr(socket.socket, "sendmsg", False)


def _test_selector_event(selector, fd, event):
# Test if the selector is monitoring 'event' events
# for the file descriptor 'fd'.
Expand Down Expand Up @@ -746,6 +749,7 @@ def _add_reader(self, fd, callback, *args):

class _SelectorSocketTransport(_SelectorTransport):

_buffer_factory = list
_start_tls_compatible = True
_sendfile_compatible = constants._SendfileMode.TRY_NATIVE

Expand Down Expand Up @@ -921,16 +925,76 @@ def write(self, data):
self._loop._add_writer(self._sock_fd, self._write_ready)

# Add it to the buffer.
self._buffer.extend(data)
self._buffer.append(data)
self._maybe_pause_protocol()

@staticmethod
def _calculate_leftovers(n, items):
leftovers = []
whole = False
for item in items:
if whole:
leftovers.append(item)
continue
n -= len(item)
if n >= 0:
continue
leftovers.append(memoryview(item)[n:])
whole = True
return leftovers

def writelines(self, lines):
if not sendmsg:
return self.write(b''.join(lines))
if self._eof:
raise RuntimeError('Cannot call write() after write_eof()')
if self._empty_waiter is not None:
raise RuntimeError('unable to write; sendfile is in progress')
if not lines:
return

if self._conn_lost:
if self._conn_lost >= constants.LOG_THRESHOLD_FOR_CONNLOST_WRITES:
logger.warning('socket.send() raised exception.')
self._conn_lost += 1
return

if not self._buffer:
# Optimization: try to send now.
try:
n = self._sock.sendmsg(lines)
except OSError:
return self.write(b''.join(lines))
except (BlockingIOError, InterruptedError):
pass
except (SystemExit, KeyboardInterrupt):
raise
except BaseException as exc:
self._fatal_error(exc, 'Fatal write error on socket transport')
return
else:
lines = self._calculate_leftovers(n, lines)
if not lines:
return
# Not all was written; register write handler.
self._loop._add_writer(self._sock_fd, self._write_ready)

# Add it to the buffer.
self._buffer.extend(lines)
self._maybe_pause_protocol()

def _write_ready(self):
assert self._buffer, 'Data should not be empty'

if self._conn_lost:
return

if sendmsg:
return self._write_vectored_self()

try:
n = self._sock.send(self._buffer)
tmp = b''.join(self._buffer)
n = self._sock.send(tmp)
except (BlockingIOError, InterruptedError):
pass
except (SystemExit, KeyboardInterrupt):
Expand All @@ -943,7 +1007,36 @@ def _write_ready(self):
self._empty_waiter.set_exception(exc)
else:
if n:
del self._buffer[:n]
self._buffer = [tmp[:n]]
self._maybe_resume_protocol() # May append to buffer.
if not self._buffer:
self._loop._remove_writer(self._sock_fd)
if self._empty_waiter is not None:
self._empty_waiter.set_result(None)
if self._closing:
self._call_connection_lost(None)
elif self._eof:
self._sock.shutdown(socket.SHUT_WR)

def _write_vectored_self(self):
try:
try:
n = self._sock.sendmsg(self._buffer)
except OSError:
self._buffer = [b''.join(self._buffer)]
n = self._sock.sendmsg(self._buffer)
except (BlockingIOError, InterruptedError):
pass
except (SystemExit, KeyboardInterrupt):
raise
except BaseException as exc:
self._loop._remove_writer(self._sock_fd)
self._buffer.clear()
self._fatal_error(exc, 'Fatal write error on socket transport')
if self._empty_waiter is not None:
self._empty_waiter.set_exception(exc)
else:
self._buffer = self._calculate_leftovers(n, self._buffer)
self._maybe_resume_protocol() # May append to buffer.
if not self._buffer:
self._loop._remove_writer(self._sock_fd)
Expand All @@ -954,6 +1047,9 @@ def _write_ready(self):
elif self._eof:
self._sock.shutdown(socket.SHUT_WR)

def get_write_buffer_size(self):
return sum(len(data) for data in self._buffer)

def write_eof(self):
if self._closing or self._eof:
return
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Make asyncio.transport.writelines on selector use sendmsg