proactor_events.py 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894
  1. """Event loop using a proactor and related classes.
  2. A proactor is a "notify-on-completion" multiplexer. Currently a
  3. proactor is only implemented on Windows with IOCP.
  4. """
  5. __all__ = 'BaseProactorEventLoop',
  6. import io
  7. import os
  8. import socket
  9. import warnings
  10. import signal
  11. import threading
  12. import collections
  13. from . import base_events
  14. from . import constants
  15. from . import futures
  16. from . import exceptions
  17. from . import protocols
  18. from . import sslproto
  19. from . import transports
  20. from . import trsock
  21. from .log import logger
  22. def _set_socket_extra(transport, sock):
  23. transport._extra['socket'] = trsock.TransportSocket(sock)
  24. try:
  25. transport._extra['sockname'] = sock.getsockname()
  26. except socket.error:
  27. if transport._loop.get_debug():
  28. logger.warning(
  29. "getsockname() failed on %r", sock, exc_info=True)
  30. if 'peername' not in transport._extra:
  31. try:
  32. transport._extra['peername'] = sock.getpeername()
  33. except socket.error:
  34. # UDP sockets may not have a peer name
  35. transport._extra['peername'] = None
  36. class _ProactorBasePipeTransport(transports._FlowControlMixin,
  37. transports.BaseTransport):
  38. """Base class for pipe and socket transports."""
  39. def __init__(self, loop, sock, protocol, waiter=None,
  40. extra=None, server=None):
  41. super().__init__(extra, loop)
  42. self._set_extra(sock)
  43. self._sock = sock
  44. self.set_protocol(protocol)
  45. self._server = server
  46. self._buffer = None # None or bytearray.
  47. self._read_fut = None
  48. self._write_fut = None
  49. self._pending_write = 0
  50. self._conn_lost = 0
  51. self._closing = False # Set when close() called.
  52. self._called_connection_lost = False
  53. self._eof_written = False
  54. if self._server is not None:
  55. self._server._attach()
  56. self._loop.call_soon(self._protocol.connection_made, self)
  57. if waiter is not None:
  58. # only wake up the waiter when connection_made() has been called
  59. self._loop.call_soon(futures._set_result_unless_cancelled,
  60. waiter, None)
  61. def __repr__(self):
  62. info = [self.__class__.__name__]
  63. if self._sock is None:
  64. info.append('closed')
  65. elif self._closing:
  66. info.append('closing')
  67. if self._sock is not None:
  68. info.append(f'fd={self._sock.fileno()}')
  69. if self._read_fut is not None:
  70. info.append(f'read={self._read_fut!r}')
  71. if self._write_fut is not None:
  72. info.append(f'write={self._write_fut!r}')
  73. if self._buffer:
  74. info.append(f'write_bufsize={len(self._buffer)}')
  75. if self._eof_written:
  76. info.append('EOF written')
  77. return '<{}>'.format(' '.join(info))
  78. def _set_extra(self, sock):
  79. self._extra['pipe'] = sock
  80. def set_protocol(self, protocol):
  81. self._protocol = protocol
  82. def get_protocol(self):
  83. return self._protocol
  84. def is_closing(self):
  85. return self._closing
  86. def close(self):
  87. if self._closing:
  88. return
  89. self._closing = True
  90. self._conn_lost += 1
  91. if not self._buffer and self._write_fut is None:
  92. self._loop.call_soon(self._call_connection_lost, None)
  93. if self._read_fut is not None:
  94. self._read_fut.cancel()
  95. self._read_fut = None
  96. def __del__(self, _warn=warnings.warn):
  97. if self._sock is not None:
  98. _warn(f"unclosed transport {self!r}", ResourceWarning, source=self)
  99. self._sock.close()
  100. def _fatal_error(self, exc, message='Fatal error on pipe transport'):
  101. try:
  102. if isinstance(exc, OSError):
  103. if self._loop.get_debug():
  104. logger.debug("%r: %s", self, message, exc_info=True)
  105. else:
  106. self._loop.call_exception_handler({
  107. 'message': message,
  108. 'exception': exc,
  109. 'transport': self,
  110. 'protocol': self._protocol,
  111. })
  112. finally:
  113. self._force_close(exc)
  114. def _force_close(self, exc):
  115. if self._empty_waiter is not None and not self._empty_waiter.done():
  116. if exc is None:
  117. self._empty_waiter.set_result(None)
  118. else:
  119. self._empty_waiter.set_exception(exc)
  120. if self._closing and self._called_connection_lost:
  121. return
  122. self._closing = True
  123. self._conn_lost += 1
  124. if self._write_fut:
  125. self._write_fut.cancel()
  126. self._write_fut = None
  127. if self._read_fut:
  128. self._read_fut.cancel()
  129. self._read_fut = None
  130. self._pending_write = 0
  131. self._buffer = None
  132. self._loop.call_soon(self._call_connection_lost, exc)
  133. def _call_connection_lost(self, exc):
  134. if self._called_connection_lost:
  135. return
  136. try:
  137. self._protocol.connection_lost(exc)
  138. finally:
  139. # XXX If there is a pending overlapped read on the other
  140. # end then it may fail with ERROR_NETNAME_DELETED if we
  141. # just close our end. First calling shutdown() seems to
  142. # cure it, but maybe using DisconnectEx() would be better.
  143. if hasattr(self._sock, 'shutdown') and self._sock.fileno() != -1:
  144. self._sock.shutdown(socket.SHUT_RDWR)
  145. self._sock.close()
  146. self._sock = None
  147. server = self._server
  148. if server is not None:
  149. server._detach()
  150. self._server = None
  151. self._called_connection_lost = True
  152. def get_write_buffer_size(self):
  153. size = self._pending_write
  154. if self._buffer is not None:
  155. size += len(self._buffer)
  156. return size
  157. class _ProactorReadPipeTransport(_ProactorBasePipeTransport,
  158. transports.ReadTransport):
  159. """Transport for read pipes."""
  160. def __init__(self, loop, sock, protocol, waiter=None,
  161. extra=None, server=None, buffer_size=65536):
  162. self._pending_data_length = -1
  163. self._paused = True
  164. super().__init__(loop, sock, protocol, waiter, extra, server)
  165. self._data = bytearray(buffer_size)
  166. self._loop.call_soon(self._loop_reading)
  167. self._paused = False
  168. def is_reading(self):
  169. return not self._paused and not self._closing
  170. def pause_reading(self):
  171. if self._closing or self._paused:
  172. return
  173. self._paused = True
  174. # bpo-33694: Don't cancel self._read_fut because cancelling an
  175. # overlapped WSASend() loss silently data with the current proactor
  176. # implementation.
  177. #
  178. # If CancelIoEx() fails with ERROR_NOT_FOUND, it means that WSASend()
  179. # completed (even if HasOverlappedIoCompleted() returns 0), but
  180. # Overlapped.cancel() currently silently ignores the ERROR_NOT_FOUND
  181. # error. Once the overlapped is ignored, the IOCP loop will ignores the
  182. # completion I/O event and so not read the result of the overlapped
  183. # WSARecv().
  184. if self._loop.get_debug():
  185. logger.debug("%r pauses reading", self)
  186. def resume_reading(self):
  187. if self._closing or not self._paused:
  188. return
  189. self._paused = False
  190. if self._read_fut is None:
  191. self._loop.call_soon(self._loop_reading, None)
  192. length = self._pending_data_length
  193. self._pending_data_length = -1
  194. if length > -1:
  195. # Call the protocol method after calling _loop_reading(),
  196. # since the protocol can decide to pause reading again.
  197. self._loop.call_soon(self._data_received, self._data[:length], length)
  198. if self._loop.get_debug():
  199. logger.debug("%r resumes reading", self)
  200. def _eof_received(self):
  201. if self._loop.get_debug():
  202. logger.debug("%r received EOF", self)
  203. try:
  204. keep_open = self._protocol.eof_received()
  205. except (SystemExit, KeyboardInterrupt):
  206. raise
  207. except BaseException as exc:
  208. self._fatal_error(
  209. exc, 'Fatal error: protocol.eof_received() call failed.')
  210. return
  211. if not keep_open:
  212. self.close()
  213. def _data_received(self, data, length):
  214. if self._paused:
  215. # Don't call any protocol method while reading is paused.
  216. # The protocol will be called on resume_reading().
  217. assert self._pending_data_length == -1
  218. self._pending_data_length = length
  219. return
  220. if length == 0:
  221. self._eof_received()
  222. return
  223. if isinstance(self._protocol, protocols.BufferedProtocol):
  224. try:
  225. protocols._feed_data_to_buffered_proto(self._protocol, data)
  226. except (SystemExit, KeyboardInterrupt):
  227. raise
  228. except BaseException as exc:
  229. self._fatal_error(exc,
  230. 'Fatal error: protocol.buffer_updated() '
  231. 'call failed.')
  232. return
  233. else:
  234. self._protocol.data_received(data)
  235. def _loop_reading(self, fut=None):
  236. length = -1
  237. data = None
  238. try:
  239. if fut is not None:
  240. assert self._read_fut is fut or (self._read_fut is None and
  241. self._closing)
  242. self._read_fut = None
  243. if fut.done():
  244. # deliver data later in "finally" clause
  245. length = fut.result()
  246. if length == 0:
  247. # we got end-of-file so no need to reschedule a new read
  248. return
  249. data = self._data[:length]
  250. else:
  251. # the future will be replaced by next proactor.recv call
  252. fut.cancel()
  253. if self._closing:
  254. # since close() has been called we ignore any read data
  255. return
  256. # bpo-33694: buffer_updated() has currently no fast path because of
  257. # a data loss issue caused by overlapped WSASend() cancellation.
  258. if not self._paused:
  259. # reschedule a new read
  260. self._read_fut = self._loop._proactor.recv_into(self._sock, self._data)
  261. except ConnectionAbortedError as exc:
  262. if not self._closing:
  263. self._fatal_error(exc, 'Fatal read error on pipe transport')
  264. elif self._loop.get_debug():
  265. logger.debug("Read error on pipe transport while closing",
  266. exc_info=True)
  267. except ConnectionResetError as exc:
  268. self._force_close(exc)
  269. except OSError as exc:
  270. self._fatal_error(exc, 'Fatal read error on pipe transport')
  271. except exceptions.CancelledError:
  272. if not self._closing:
  273. raise
  274. else:
  275. if not self._paused:
  276. self._read_fut.add_done_callback(self._loop_reading)
  277. finally:
  278. if length > -1:
  279. self._data_received(data, length)
  280. class _ProactorBaseWritePipeTransport(_ProactorBasePipeTransport,
  281. transports.WriteTransport):
  282. """Transport for write pipes."""
  283. _start_tls_compatible = True
  284. def __init__(self, *args, **kw):
  285. super().__init__(*args, **kw)
  286. self._empty_waiter = None
  287. def write(self, data):
  288. if not isinstance(data, (bytes, bytearray, memoryview)):
  289. raise TypeError(
  290. f"data argument must be a bytes-like object, "
  291. f"not {type(data).__name__}")
  292. if self._eof_written:
  293. raise RuntimeError('write_eof() already called')
  294. if self._empty_waiter is not None:
  295. raise RuntimeError('unable to write; sendfile is in progress')
  296. if not data:
  297. return
  298. if self._conn_lost:
  299. if self._conn_lost >= constants.LOG_THRESHOLD_FOR_CONNLOST_WRITES:
  300. logger.warning('socket.send() raised exception.')
  301. self._conn_lost += 1
  302. return
  303. # Observable states:
  304. # 1. IDLE: _write_fut and _buffer both None
  305. # 2. WRITING: _write_fut set; _buffer None
  306. # 3. BACKED UP: _write_fut set; _buffer a bytearray
  307. # We always copy the data, so the caller can't modify it
  308. # while we're still waiting for the I/O to happen.
  309. if self._write_fut is None: # IDLE -> WRITING
  310. assert self._buffer is None
  311. # Pass a copy, except if it's already immutable.
  312. self._loop_writing(data=bytes(data))
  313. elif not self._buffer: # WRITING -> BACKED UP
  314. # Make a mutable copy which we can extend.
  315. self._buffer = bytearray(data)
  316. self._maybe_pause_protocol()
  317. else: # BACKED UP
  318. # Append to buffer (also copies).
  319. self._buffer.extend(data)
  320. self._maybe_pause_protocol()
  321. def _loop_writing(self, f=None, data=None):
  322. try:
  323. if f is not None and self._write_fut is None and self._closing:
  324. # XXX most likely self._force_close() has been called, and
  325. # it has set self._write_fut to None.
  326. return
  327. assert f is self._write_fut
  328. self._write_fut = None
  329. self._pending_write = 0
  330. if f:
  331. f.result()
  332. if data is None:
  333. data = self._buffer
  334. self._buffer = None
  335. if not data:
  336. if self._closing:
  337. self._loop.call_soon(self._call_connection_lost, None)
  338. if self._eof_written:
  339. self._sock.shutdown(socket.SHUT_WR)
  340. # Now that we've reduced the buffer size, tell the
  341. # protocol to resume writing if it was paused. Note that
  342. # we do this last since the callback is called immediately
  343. # and it may add more data to the buffer (even causing the
  344. # protocol to be paused again).
  345. self._maybe_resume_protocol()
  346. else:
  347. self._write_fut = self._loop._proactor.send(self._sock, data)
  348. if not self._write_fut.done():
  349. assert self._pending_write == 0
  350. self._pending_write = len(data)
  351. self._write_fut.add_done_callback(self._loop_writing)
  352. self._maybe_pause_protocol()
  353. else:
  354. self._write_fut.add_done_callback(self._loop_writing)
  355. if self._empty_waiter is not None and self._write_fut is None:
  356. self._empty_waiter.set_result(None)
  357. except ConnectionResetError as exc:
  358. self._force_close(exc)
  359. except OSError as exc:
  360. self._fatal_error(exc, 'Fatal write error on pipe transport')
  361. def can_write_eof(self):
  362. return True
  363. def write_eof(self):
  364. self.close()
  365. def abort(self):
  366. self._force_close(None)
  367. def _make_empty_waiter(self):
  368. if self._empty_waiter is not None:
  369. raise RuntimeError("Empty waiter is already set")
  370. self._empty_waiter = self._loop.create_future()
  371. if self._write_fut is None:
  372. self._empty_waiter.set_result(None)
  373. return self._empty_waiter
  374. def _reset_empty_waiter(self):
  375. self._empty_waiter = None
  376. class _ProactorWritePipeTransport(_ProactorBaseWritePipeTransport):
  377. def __init__(self, *args, **kw):
  378. super().__init__(*args, **kw)
  379. self._read_fut = self._loop._proactor.recv(self._sock, 16)
  380. self._read_fut.add_done_callback(self._pipe_closed)
  381. def _pipe_closed(self, fut):
  382. if fut.cancelled():
  383. # the transport has been closed
  384. return
  385. assert fut.result() == b''
  386. if self._closing:
  387. assert self._read_fut is None
  388. return
  389. assert fut is self._read_fut, (fut, self._read_fut)
  390. self._read_fut = None
  391. if self._write_fut is not None:
  392. self._force_close(BrokenPipeError())
  393. else:
  394. self.close()
  395. class _ProactorDatagramTransport(_ProactorBasePipeTransport,
  396. transports.DatagramTransport):
  397. max_size = 256 * 1024
  398. def __init__(self, loop, sock, protocol, address=None,
  399. waiter=None, extra=None):
  400. self._address = address
  401. self._empty_waiter = None
  402. self._buffer_size = 0
  403. # We don't need to call _protocol.connection_made() since our base
  404. # constructor does it for us.
  405. super().__init__(loop, sock, protocol, waiter=waiter, extra=extra)
  406. # The base constructor sets _buffer = None, so we set it here
  407. self._buffer = collections.deque()
  408. self._loop.call_soon(self._loop_reading)
  409. def _set_extra(self, sock):
  410. _set_socket_extra(self, sock)
  411. def get_write_buffer_size(self):
  412. return self._buffer_size
  413. def abort(self):
  414. self._force_close(None)
  415. def sendto(self, data, addr=None):
  416. if not isinstance(data, (bytes, bytearray, memoryview)):
  417. raise TypeError('data argument must be bytes-like object (%r)',
  418. type(data))
  419. if not data:
  420. return
  421. if self._address is not None and addr not in (None, self._address):
  422. raise ValueError(
  423. f'Invalid address: must be None or {self._address}')
  424. if self._conn_lost and self._address:
  425. if self._conn_lost >= constants.LOG_THRESHOLD_FOR_CONNLOST_WRITES:
  426. logger.warning('socket.sendto() raised exception.')
  427. self._conn_lost += 1
  428. return
  429. # Ensure that what we buffer is immutable.
  430. self._buffer.append((bytes(data), addr))
  431. self._buffer_size += len(data)
  432. if self._write_fut is None:
  433. # No current write operations are active, kick one off
  434. self._loop_writing()
  435. # else: A write operation is already kicked off
  436. self._maybe_pause_protocol()
  437. def _loop_writing(self, fut=None):
  438. try:
  439. if self._conn_lost:
  440. return
  441. assert fut is self._write_fut
  442. self._write_fut = None
  443. if fut:
  444. # We are in a _loop_writing() done callback, get the result
  445. fut.result()
  446. if not self._buffer or (self._conn_lost and self._address):
  447. # The connection has been closed
  448. if self._closing:
  449. self._loop.call_soon(self._call_connection_lost, None)
  450. return
  451. data, addr = self._buffer.popleft()
  452. self._buffer_size -= len(data)
  453. if self._address is not None:
  454. self._write_fut = self._loop._proactor.send(self._sock,
  455. data)
  456. else:
  457. self._write_fut = self._loop._proactor.sendto(self._sock,
  458. data,
  459. addr=addr)
  460. except OSError as exc:
  461. self._protocol.error_received(exc)
  462. except Exception as exc:
  463. self._fatal_error(exc, 'Fatal write error on datagram transport')
  464. else:
  465. self._write_fut.add_done_callback(self._loop_writing)
  466. self._maybe_resume_protocol()
  467. def _loop_reading(self, fut=None):
  468. data = None
  469. try:
  470. if self._conn_lost:
  471. return
  472. assert self._read_fut is fut or (self._read_fut is None and
  473. self._closing)
  474. self._read_fut = None
  475. if fut is not None:
  476. res = fut.result()
  477. if self._closing:
  478. # since close() has been called we ignore any read data
  479. data = None
  480. return
  481. if self._address is not None:
  482. data, addr = res, self._address
  483. else:
  484. data, addr = res
  485. if self._conn_lost:
  486. return
  487. if self._address is not None:
  488. self._read_fut = self._loop._proactor.recv(self._sock,
  489. self.max_size)
  490. else:
  491. self._read_fut = self._loop._proactor.recvfrom(self._sock,
  492. self.max_size)
  493. except OSError as exc:
  494. self._protocol.error_received(exc)
  495. except exceptions.CancelledError:
  496. if not self._closing:
  497. raise
  498. else:
  499. if self._read_fut is not None:
  500. self._read_fut.add_done_callback(self._loop_reading)
  501. finally:
  502. if data:
  503. self._protocol.datagram_received(data, addr)
  504. class _ProactorDuplexPipeTransport(_ProactorReadPipeTransport,
  505. _ProactorBaseWritePipeTransport,
  506. transports.Transport):
  507. """Transport for duplex pipes."""
  508. def can_write_eof(self):
  509. return False
  510. def write_eof(self):
  511. raise NotImplementedError
  512. class _ProactorSocketTransport(_ProactorReadPipeTransport,
  513. _ProactorBaseWritePipeTransport,
  514. transports.Transport):
  515. """Transport for connected sockets."""
  516. _sendfile_compatible = constants._SendfileMode.TRY_NATIVE
  517. def __init__(self, loop, sock, protocol, waiter=None,
  518. extra=None, server=None):
  519. super().__init__(loop, sock, protocol, waiter, extra, server)
  520. base_events._set_nodelay(sock)
  521. def _set_extra(self, sock):
  522. _set_socket_extra(self, sock)
  523. def can_write_eof(self):
  524. return True
  525. def write_eof(self):
  526. if self._closing or self._eof_written:
  527. return
  528. self._eof_written = True
  529. if self._write_fut is None:
  530. self._sock.shutdown(socket.SHUT_WR)
  531. class BaseProactorEventLoop(base_events.BaseEventLoop):
  532. def __init__(self, proactor):
  533. super().__init__()
  534. logger.debug('Using proactor: %s', proactor.__class__.__name__)
  535. self._proactor = proactor
  536. self._selector = proactor # convenient alias
  537. self._self_reading_future = None
  538. self._accept_futures = {} # socket file descriptor => Future
  539. proactor.set_loop(self)
  540. self._make_self_pipe()
  541. if threading.current_thread() is threading.main_thread():
  542. # wakeup fd can only be installed to a file descriptor from the main thread
  543. signal.set_wakeup_fd(self._csock.fileno())
  544. def _make_socket_transport(self, sock, protocol, waiter=None,
  545. extra=None, server=None):
  546. return _ProactorSocketTransport(self, sock, protocol, waiter,
  547. extra, server)
  548. def _make_ssl_transport(
  549. self, rawsock, protocol, sslcontext, waiter=None,
  550. *, server_side=False, server_hostname=None,
  551. extra=None, server=None,
  552. ssl_handshake_timeout=None,
  553. ssl_shutdown_timeout=None):
  554. ssl_protocol = sslproto.SSLProtocol(
  555. self, protocol, sslcontext, waiter,
  556. server_side, server_hostname,
  557. ssl_handshake_timeout=ssl_handshake_timeout,
  558. ssl_shutdown_timeout=ssl_shutdown_timeout)
  559. _ProactorSocketTransport(self, rawsock, ssl_protocol,
  560. extra=extra, server=server)
  561. return ssl_protocol._app_transport
  562. def _make_datagram_transport(self, sock, protocol,
  563. address=None, waiter=None, extra=None):
  564. return _ProactorDatagramTransport(self, sock, protocol, address,
  565. waiter, extra)
  566. def _make_duplex_pipe_transport(self, sock, protocol, waiter=None,
  567. extra=None):
  568. return _ProactorDuplexPipeTransport(self,
  569. sock, protocol, waiter, extra)
  570. def _make_read_pipe_transport(self, sock, protocol, waiter=None,
  571. extra=None):
  572. return _ProactorReadPipeTransport(self, sock, protocol, waiter, extra)
  573. def _make_write_pipe_transport(self, sock, protocol, waiter=None,
  574. extra=None):
  575. # We want connection_lost() to be called when other end closes
  576. return _ProactorWritePipeTransport(self,
  577. sock, protocol, waiter, extra)
  578. def close(self):
  579. if self.is_running():
  580. raise RuntimeError("Cannot close a running event loop")
  581. if self.is_closed():
  582. return
  583. if threading.current_thread() is threading.main_thread():
  584. signal.set_wakeup_fd(-1)
  585. # Call these methods before closing the event loop (before calling
  586. # BaseEventLoop.close), because they can schedule callbacks with
  587. # call_soon(), which is forbidden when the event loop is closed.
  588. self._stop_accept_futures()
  589. self._close_self_pipe()
  590. self._proactor.close()
  591. self._proactor = None
  592. self._selector = None
  593. # Close the event loop
  594. super().close()
  595. async def sock_recv(self, sock, n):
  596. return await self._proactor.recv(sock, n)
  597. async def sock_recv_into(self, sock, buf):
  598. return await self._proactor.recv_into(sock, buf)
  599. async def sock_recvfrom(self, sock, bufsize):
  600. return await self._proactor.recvfrom(sock, bufsize)
  601. async def sock_recvfrom_into(self, sock, buf, nbytes=0):
  602. if not nbytes:
  603. nbytes = len(buf)
  604. return await self._proactor.recvfrom_into(sock, buf, nbytes)
  605. async def sock_sendall(self, sock, data):
  606. return await self._proactor.send(sock, data)
  607. async def sock_sendto(self, sock, data, address):
  608. return await self._proactor.sendto(sock, data, 0, address)
  609. async def sock_connect(self, sock, address):
  610. return await self._proactor.connect(sock, address)
  611. async def sock_accept(self, sock):
  612. return await self._proactor.accept(sock)
  613. async def _sock_sendfile_native(self, sock, file, offset, count):
  614. try:
  615. fileno = file.fileno()
  616. except (AttributeError, io.UnsupportedOperation) as err:
  617. raise exceptions.SendfileNotAvailableError("not a regular file")
  618. try:
  619. fsize = os.fstat(fileno).st_size
  620. except OSError:
  621. raise exceptions.SendfileNotAvailableError("not a regular file")
  622. blocksize = count if count else fsize
  623. if not blocksize:
  624. return 0 # empty file
  625. blocksize = min(blocksize, 0xffff_ffff)
  626. end_pos = min(offset + count, fsize) if count else fsize
  627. offset = min(offset, fsize)
  628. total_sent = 0
  629. try:
  630. while True:
  631. blocksize = min(end_pos - offset, blocksize)
  632. if blocksize <= 0:
  633. return total_sent
  634. await self._proactor.sendfile(sock, file, offset, blocksize)
  635. offset += blocksize
  636. total_sent += blocksize
  637. finally:
  638. if total_sent > 0:
  639. file.seek(offset)
  640. async def _sendfile_native(self, transp, file, offset, count):
  641. resume_reading = transp.is_reading()
  642. transp.pause_reading()
  643. await transp._make_empty_waiter()
  644. try:
  645. return await self.sock_sendfile(transp._sock, file, offset, count,
  646. fallback=False)
  647. finally:
  648. transp._reset_empty_waiter()
  649. if resume_reading:
  650. transp.resume_reading()
  651. def _close_self_pipe(self):
  652. if self._self_reading_future is not None:
  653. self._self_reading_future.cancel()
  654. self._self_reading_future = None
  655. self._ssock.close()
  656. self._ssock = None
  657. self._csock.close()
  658. self._csock = None
  659. self._internal_fds -= 1
  660. def _make_self_pipe(self):
  661. # A self-socket, really. :-)
  662. self._ssock, self._csock = socket.socketpair()
  663. self._ssock.setblocking(False)
  664. self._csock.setblocking(False)
  665. self._internal_fds += 1
  666. def _loop_self_reading(self, f=None):
  667. try:
  668. if f is not None:
  669. f.result() # may raise
  670. if self._self_reading_future is not f:
  671. # When we scheduled this Future, we assigned it to
  672. # _self_reading_future. If it's not there now, something has
  673. # tried to cancel the loop while this callback was still in the
  674. # queue (see windows_events.ProactorEventLoop.run_forever). In
  675. # that case stop here instead of continuing to schedule a new
  676. # iteration.
  677. return
  678. f = self._proactor.recv(self._ssock, 4096)
  679. except exceptions.CancelledError:
  680. # _close_self_pipe() has been called, stop waiting for data
  681. return
  682. except (SystemExit, KeyboardInterrupt):
  683. raise
  684. except BaseException as exc:
  685. self.call_exception_handler({
  686. 'message': 'Error on reading from the event loop self pipe',
  687. 'exception': exc,
  688. 'loop': self,
  689. })
  690. else:
  691. self._self_reading_future = f
  692. f.add_done_callback(self._loop_self_reading)
  693. def _write_to_self(self):
  694. # This may be called from a different thread, possibly after
  695. # _close_self_pipe() has been called or even while it is
  696. # running. Guard for self._csock being None or closed. When
  697. # a socket is closed, send() raises OSError (with errno set to
  698. # EBADF, but let's not rely on the exact error code).
  699. csock = self._csock
  700. if csock is None:
  701. return
  702. try:
  703. csock.send(b'\0')
  704. except OSError:
  705. if self._debug:
  706. logger.debug("Fail to write a null byte into the "
  707. "self-pipe socket",
  708. exc_info=True)
  709. def _start_serving(self, protocol_factory, sock,
  710. sslcontext=None, server=None, backlog=100,
  711. ssl_handshake_timeout=None,
  712. ssl_shutdown_timeout=None):
  713. def loop(f=None):
  714. try:
  715. if f is not None:
  716. conn, addr = f.result()
  717. if self._debug:
  718. logger.debug("%r got a new connection from %r: %r",
  719. server, addr, conn)
  720. protocol = protocol_factory()
  721. if sslcontext is not None:
  722. self._make_ssl_transport(
  723. conn, protocol, sslcontext, server_side=True,
  724. extra={'peername': addr}, server=server,
  725. ssl_handshake_timeout=ssl_handshake_timeout,
  726. ssl_shutdown_timeout=ssl_shutdown_timeout)
  727. else:
  728. self._make_socket_transport(
  729. conn, protocol,
  730. extra={'peername': addr}, server=server)
  731. if self.is_closed():
  732. return
  733. f = self._proactor.accept(sock)
  734. except OSError as exc:
  735. if sock.fileno() != -1:
  736. self.call_exception_handler({
  737. 'message': 'Accept failed on a socket',
  738. 'exception': exc,
  739. 'socket': trsock.TransportSocket(sock),
  740. })
  741. sock.close()
  742. elif self._debug:
  743. logger.debug("Accept failed on socket %r",
  744. sock, exc_info=True)
  745. except exceptions.CancelledError:
  746. sock.close()
  747. else:
  748. self._accept_futures[sock.fileno()] = f
  749. f.add_done_callback(loop)
  750. self.call_soon(loop)
  751. def _process_events(self, event_list):
  752. # Events are processed in the IocpProactor._poll() method
  753. pass
  754. def _stop_accept_futures(self):
  755. for future in self._accept_futures.values():
  756. future.cancel()
  757. self._accept_futures.clear()
  758. def _stop_serving(self, sock):
  759. future = self._accept_futures.pop(sock.fileno(), None)
  760. if future:
  761. future.cancel()
  762. self._proactor._stop_serving(sock)
  763. sock.close()