selector_events.py 38 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070
  1. """Event loop using a selector and related classes.
  2. A selector is a "notify-when-ready" multiplexer. For a subclass which
  3. also includes support for signal handling, see the unix_events sub-module.
  4. """
  5. __all__ = ['BaseSelectorEventLoop']
  6. import collections
  7. import errno
  8. import functools
  9. import socket
  10. import sys
  11. import warnings
  12. try:
  13. import ssl
  14. except ImportError: # pragma: no cover
  15. ssl = None
  16. from . import base_events
  17. from . import constants
  18. from . import events
  19. from . import futures
  20. from . import selectors
  21. from . import transports
  22. from . import sslproto
  23. from .coroutines import coroutine
  24. from .log import logger
  25. def _test_selector_event(selector, fd, event):
  26. # Test if the selector is monitoring 'event' events
  27. # for the file descriptor 'fd'.
  28. try:
  29. key = selector.get_key(fd)
  30. except KeyError:
  31. return False
  32. else:
  33. return bool(key.events & event)
  34. class BaseSelectorEventLoop(base_events.BaseEventLoop):
  35. """Selector event loop.
  36. See events.EventLoop for API specification.
  37. """
  38. def __init__(self, selector=None):
  39. super().__init__()
  40. if selector is None:
  41. selector = selectors.DefaultSelector()
  42. logger.debug('Using selector: %s', selector.__class__.__name__)
  43. self._selector = selector
  44. self._make_self_pipe()
  45. def _make_socket_transport(self, sock, protocol, waiter=None, *,
  46. extra=None, server=None):
  47. return _SelectorSocketTransport(self, sock, protocol, waiter,
  48. extra, server)
  49. def _make_ssl_transport(self, rawsock, protocol, sslcontext, waiter=None,
  50. *, server_side=False, server_hostname=None,
  51. extra=None, server=None):
  52. if not sslproto._is_sslproto_available():
  53. return self._make_legacy_ssl_transport(
  54. rawsock, protocol, sslcontext, waiter,
  55. server_side=server_side, server_hostname=server_hostname,
  56. extra=extra, server=server)
  57. ssl_protocol = sslproto.SSLProtocol(self, protocol, sslcontext, waiter,
  58. server_side, server_hostname)
  59. _SelectorSocketTransport(self, rawsock, ssl_protocol,
  60. extra=extra, server=server)
  61. return ssl_protocol._app_transport
  62. def _make_legacy_ssl_transport(self, rawsock, protocol, sslcontext,
  63. waiter, *,
  64. server_side=False, server_hostname=None,
  65. extra=None, server=None):
  66. # Use the legacy API: SSL_write, SSL_read, etc. The legacy API is used
  67. # on Python 3.4 and older, when ssl.MemoryBIO is not available.
  68. return _SelectorSslTransport(
  69. self, rawsock, protocol, sslcontext, waiter,
  70. server_side, server_hostname, extra, server)
  71. def _make_datagram_transport(self, sock, protocol,
  72. address=None, waiter=None, extra=None):
  73. return _SelectorDatagramTransport(self, sock, protocol,
  74. address, waiter, extra)
  75. def close(self):
  76. if self.is_running():
  77. raise RuntimeError("Cannot close a running event loop")
  78. if self.is_closed():
  79. return
  80. self._close_self_pipe()
  81. super().close()
  82. if self._selector is not None:
  83. self._selector.close()
  84. self._selector = None
  85. def _socketpair(self):
  86. raise NotImplementedError
  87. def _close_self_pipe(self):
  88. self.remove_reader(self._ssock.fileno())
  89. self._ssock.close()
  90. self._ssock = None
  91. self._csock.close()
  92. self._csock = None
  93. self._internal_fds -= 1
  94. def _make_self_pipe(self):
  95. # A self-socket, really. :-)
  96. self._ssock, self._csock = self._socketpair()
  97. self._ssock.setblocking(False)
  98. self._csock.setblocking(False)
  99. self._internal_fds += 1
  100. self.add_reader(self._ssock.fileno(), self._read_from_self)
  101. def _process_self_data(self, data):
  102. pass
  103. def _read_from_self(self):
  104. while True:
  105. try:
  106. data = self._ssock.recv(4096)
  107. if not data:
  108. break
  109. self._process_self_data(data)
  110. except InterruptedError:
  111. continue
  112. except BlockingIOError:
  113. break
  114. def _write_to_self(self):
  115. # This may be called from a different thread, possibly after
  116. # _close_self_pipe() has been called or even while it is
  117. # running. Guard for self._csock being None or closed. When
  118. # a socket is closed, send() raises OSError (with errno set to
  119. # EBADF, but let's not rely on the exact error code).
  120. csock = self._csock
  121. if csock is not None:
  122. try:
  123. csock.send(b'\0')
  124. except OSError:
  125. if self._debug:
  126. logger.debug("Fail to write a null byte into the "
  127. "self-pipe socket",
  128. exc_info=True)
  129. def _start_serving(self, protocol_factory, sock,
  130. sslcontext=None, server=None):
  131. self.add_reader(sock.fileno(), self._accept_connection,
  132. protocol_factory, sock, sslcontext, server)
  133. def _accept_connection(self, protocol_factory, sock,
  134. sslcontext=None, server=None):
  135. try:
  136. conn, addr = sock.accept()
  137. if self._debug:
  138. logger.debug("%r got a new connection from %r: %r",
  139. server, addr, conn)
  140. conn.setblocking(False)
  141. except (BlockingIOError, InterruptedError, ConnectionAbortedError):
  142. pass # False alarm.
  143. except OSError as exc:
  144. # There's nowhere to send the error, so just log it.
  145. if exc.errno in (errno.EMFILE, errno.ENFILE,
  146. errno.ENOBUFS, errno.ENOMEM):
  147. # Some platforms (e.g. Linux keep reporting the FD as
  148. # ready, so we remove the read handler temporarily.
  149. # We'll try again in a while.
  150. self.call_exception_handler({
  151. 'message': 'socket.accept() out of system resource',
  152. 'exception': exc,
  153. 'socket': sock,
  154. })
  155. self.remove_reader(sock.fileno())
  156. self.call_later(constants.ACCEPT_RETRY_DELAY,
  157. self._start_serving,
  158. protocol_factory, sock, sslcontext, server)
  159. else:
  160. raise # The event loop will catch, log and ignore it.
  161. else:
  162. extra = {'peername': addr}
  163. accept = self._accept_connection2(protocol_factory, conn, extra,
  164. sslcontext, server)
  165. self.create_task(accept)
  166. @coroutine
  167. def _accept_connection2(self, protocol_factory, conn, extra,
  168. sslcontext=None, server=None):
  169. protocol = None
  170. transport = None
  171. try:
  172. protocol = protocol_factory()
  173. waiter = futures.Future(loop=self)
  174. if sslcontext:
  175. transport = self._make_ssl_transport(
  176. conn, protocol, sslcontext, waiter=waiter,
  177. server_side=True, extra=extra, server=server)
  178. else:
  179. transport = self._make_socket_transport(
  180. conn, protocol, waiter=waiter, extra=extra,
  181. server=server)
  182. try:
  183. yield from waiter
  184. except:
  185. transport.close()
  186. raise
  187. # It's now up to the protocol to handle the connection.
  188. except Exception as exc:
  189. if self._debug:
  190. context = {
  191. 'message': ('Error on transport creation '
  192. 'for incoming connection'),
  193. 'exception': exc,
  194. }
  195. if protocol is not None:
  196. context['protocol'] = protocol
  197. if transport is not None:
  198. context['transport'] = transport
  199. self.call_exception_handler(context)
  200. def add_reader(self, fd, callback, *args):
  201. """Add a reader callback."""
  202. self._check_closed()
  203. handle = events.Handle(callback, args, self)
  204. try:
  205. key = self._selector.get_key(fd)
  206. except KeyError:
  207. self._selector.register(fd, selectors.EVENT_READ,
  208. (handle, None))
  209. else:
  210. mask, (reader, writer) = key.events, key.data
  211. self._selector.modify(fd, mask | selectors.EVENT_READ,
  212. (handle, writer))
  213. if reader is not None:
  214. reader.cancel()
  215. def remove_reader(self, fd):
  216. """Remove a reader callback."""
  217. if self.is_closed():
  218. return False
  219. try:
  220. key = self._selector.get_key(fd)
  221. except KeyError:
  222. return False
  223. else:
  224. mask, (reader, writer) = key.events, key.data
  225. mask &= ~selectors.EVENT_READ
  226. if not mask:
  227. self._selector.unregister(fd)
  228. else:
  229. self._selector.modify(fd, mask, (None, writer))
  230. if reader is not None:
  231. reader.cancel()
  232. return True
  233. else:
  234. return False
  235. def add_writer(self, fd, callback, *args):
  236. """Add a writer callback.."""
  237. self._check_closed()
  238. handle = events.Handle(callback, args, self)
  239. try:
  240. key = self._selector.get_key(fd)
  241. except KeyError:
  242. self._selector.register(fd, selectors.EVENT_WRITE,
  243. (None, handle))
  244. else:
  245. mask, (reader, writer) = key.events, key.data
  246. self._selector.modify(fd, mask | selectors.EVENT_WRITE,
  247. (reader, handle))
  248. if writer is not None:
  249. writer.cancel()
  250. def remove_writer(self, fd):
  251. """Remove a writer callback."""
  252. if self.is_closed():
  253. return False
  254. try:
  255. key = self._selector.get_key(fd)
  256. except KeyError:
  257. return False
  258. else:
  259. mask, (reader, writer) = key.events, key.data
  260. # Remove both writer and connector.
  261. mask &= ~selectors.EVENT_WRITE
  262. if not mask:
  263. self._selector.unregister(fd)
  264. else:
  265. self._selector.modify(fd, mask, (reader, None))
  266. if writer is not None:
  267. writer.cancel()
  268. return True
  269. else:
  270. return False
  271. def sock_recv(self, sock, n):
  272. """Receive data from the socket.
  273. The return value is a bytes object representing the data received.
  274. The maximum amount of data to be received at once is specified by
  275. nbytes.
  276. This method is a coroutine.
  277. """
  278. if self._debug and sock.gettimeout() != 0:
  279. raise ValueError("the socket must be non-blocking")
  280. fut = futures.Future(loop=self)
  281. self._sock_recv(fut, False, sock, n)
  282. return fut
  283. def _sock_recv(self, fut, registered, sock, n):
  284. # _sock_recv() can add itself as an I/O callback if the operation can't
  285. # be done immediately. Don't use it directly, call sock_recv().
  286. fd = sock.fileno()
  287. if registered:
  288. # Remove the callback early. It should be rare that the
  289. # selector says the fd is ready but the call still returns
  290. # EAGAIN, and I am willing to take a hit in that case in
  291. # order to simplify the common case.
  292. self.remove_reader(fd)
  293. if fut.cancelled():
  294. return
  295. try:
  296. data = sock.recv(n)
  297. except (BlockingIOError, InterruptedError):
  298. self.add_reader(fd, self._sock_recv, fut, True, sock, n)
  299. except Exception as exc:
  300. fut.set_exception(exc)
  301. else:
  302. fut.set_result(data)
  303. def sock_sendall(self, sock, data):
  304. """Send data to the socket.
  305. The socket must be connected to a remote socket. This method continues
  306. to send data from data until either all data has been sent or an
  307. error occurs. None is returned on success. On error, an exception is
  308. raised, and there is no way to determine how much data, if any, was
  309. successfully processed by the receiving end of the connection.
  310. This method is a coroutine.
  311. """
  312. if self._debug and sock.gettimeout() != 0:
  313. raise ValueError("the socket must be non-blocking")
  314. fut = futures.Future(loop=self)
  315. if data:
  316. self._sock_sendall(fut, False, sock, data)
  317. else:
  318. fut.set_result(None)
  319. return fut
  320. def _sock_sendall(self, fut, registered, sock, data):
  321. fd = sock.fileno()
  322. if registered:
  323. self.remove_writer(fd)
  324. if fut.cancelled():
  325. return
  326. try:
  327. n = sock.send(data)
  328. except (BlockingIOError, InterruptedError):
  329. n = 0
  330. except Exception as exc:
  331. fut.set_exception(exc)
  332. return
  333. if n == len(data):
  334. fut.set_result(None)
  335. else:
  336. if n:
  337. data = data[n:]
  338. self.add_writer(fd, self._sock_sendall, fut, True, sock, data)
  339. def sock_connect(self, sock, address):
  340. """Connect to a remote socket at address.
  341. The address must be already resolved to avoid the trap of hanging the
  342. entire event loop when the address requires doing a DNS lookup. For
  343. example, it must be an IP address, not an hostname, for AF_INET and
  344. AF_INET6 address families. Use getaddrinfo() to resolve the hostname
  345. asynchronously.
  346. This method is a coroutine.
  347. """
  348. if self._debug and sock.gettimeout() != 0:
  349. raise ValueError("the socket must be non-blocking")
  350. fut = futures.Future(loop=self)
  351. try:
  352. if self._debug:
  353. base_events._check_resolved_address(sock, address)
  354. except ValueError as err:
  355. fut.set_exception(err)
  356. else:
  357. self._sock_connect(fut, sock, address)
  358. return fut
  359. def _sock_connect(self, fut, sock, address):
  360. fd = sock.fileno()
  361. try:
  362. while True:
  363. try:
  364. sock.connect(address)
  365. except InterruptedError:
  366. continue
  367. else:
  368. break
  369. except BlockingIOError:
  370. fut.add_done_callback(functools.partial(self._sock_connect_done,
  371. fd))
  372. self.add_writer(fd, self._sock_connect_cb, fut, sock, address)
  373. except Exception as exc:
  374. fut.set_exception(exc)
  375. else:
  376. fut.set_result(None)
  377. def _sock_connect_done(self, fd, fut):
  378. self.remove_writer(fd)
  379. def _sock_connect_cb(self, fut, sock, address):
  380. if fut.cancelled():
  381. return
  382. try:
  383. err = sock.getsockopt(socket.SOL_SOCKET, socket.SO_ERROR)
  384. if err != 0:
  385. # Jump to any except clause below.
  386. raise OSError(err, 'Connect call failed %s' % (address,))
  387. except (BlockingIOError, InterruptedError):
  388. # socket is still registered, the callback will be retried later
  389. pass
  390. except Exception as exc:
  391. fut.set_exception(exc)
  392. else:
  393. fut.set_result(None)
  394. def sock_accept(self, sock):
  395. """Accept a connection.
  396. The socket must be bound to an address and listening for connections.
  397. The return value is a pair (conn, address) where conn is a new socket
  398. object usable to send and receive data on the connection, and address
  399. is the address bound to the socket on the other end of the connection.
  400. This method is a coroutine.
  401. """
  402. if self._debug and sock.gettimeout() != 0:
  403. raise ValueError("the socket must be non-blocking")
  404. fut = futures.Future(loop=self)
  405. self._sock_accept(fut, False, sock)
  406. return fut
  407. def _sock_accept(self, fut, registered, sock):
  408. fd = sock.fileno()
  409. if registered:
  410. self.remove_reader(fd)
  411. if fut.cancelled():
  412. return
  413. try:
  414. conn, address = sock.accept()
  415. conn.setblocking(False)
  416. except (BlockingIOError, InterruptedError):
  417. self.add_reader(fd, self._sock_accept, fut, True, sock)
  418. except Exception as exc:
  419. fut.set_exception(exc)
  420. else:
  421. fut.set_result((conn, address))
  422. def _process_events(self, event_list):
  423. for key, mask in event_list:
  424. fileobj, (reader, writer) = key.fileobj, key.data
  425. if mask & selectors.EVENT_READ and reader is not None:
  426. if reader._cancelled:
  427. self.remove_reader(fileobj)
  428. else:
  429. self._add_callback(reader)
  430. if mask & selectors.EVENT_WRITE and writer is not None:
  431. if writer._cancelled:
  432. self.remove_writer(fileobj)
  433. else:
  434. self._add_callback(writer)
  435. def _stop_serving(self, sock):
  436. self.remove_reader(sock.fileno())
  437. sock.close()
  438. class _SelectorTransport(transports._FlowControlMixin,
  439. transports.Transport):
  440. max_size = 256 * 1024 # Buffer size passed to recv().
  441. _buffer_factory = bytearray # Constructs initial value for self._buffer.
  442. # Attribute used in the destructor: it must be set even if the constructor
  443. # is not called (see _SelectorSslTransport which may start by raising an
  444. # exception)
  445. _sock = None
  446. def __init__(self, loop, sock, protocol, extra=None, server=None):
  447. super().__init__(extra, loop)
  448. self._extra['socket'] = sock
  449. self._extra['sockname'] = sock.getsockname()
  450. if 'peername' not in self._extra:
  451. try:
  452. self._extra['peername'] = sock.getpeername()
  453. except socket.error:
  454. self._extra['peername'] = None
  455. self._sock = sock
  456. self._sock_fd = sock.fileno()
  457. self._protocol = protocol
  458. self._protocol_connected = True
  459. self._server = server
  460. self._buffer = self._buffer_factory()
  461. self._conn_lost = 0 # Set when call to connection_lost scheduled.
  462. self._closing = False # Set when close() called.
  463. if self._server is not None:
  464. self._server._attach()
  465. def __repr__(self):
  466. info = [self.__class__.__name__]
  467. if self._sock is None:
  468. info.append('closed')
  469. elif self._closing:
  470. info.append('closing')
  471. info.append('fd=%s' % self._sock_fd)
  472. # test if the transport was closed
  473. if self._loop is not None:
  474. polling = _test_selector_event(self._loop._selector,
  475. self._sock_fd, selectors.EVENT_READ)
  476. if polling:
  477. info.append('read=polling')
  478. else:
  479. info.append('read=idle')
  480. polling = _test_selector_event(self._loop._selector,
  481. self._sock_fd,
  482. selectors.EVENT_WRITE)
  483. if polling:
  484. state = 'polling'
  485. else:
  486. state = 'idle'
  487. bufsize = self.get_write_buffer_size()
  488. info.append('write=<%s, bufsize=%s>' % (state, bufsize))
  489. return '<%s>' % ' '.join(info)
  490. def abort(self):
  491. self._force_close(None)
  492. def close(self):
  493. if self._closing:
  494. return
  495. self._closing = True
  496. self._loop.remove_reader(self._sock_fd)
  497. if not self._buffer:
  498. self._conn_lost += 1
  499. self._loop.call_soon(self._call_connection_lost, None)
  500. # On Python 3.3 and older, objects with a destructor part of a reference
  501. # cycle are never destroyed. It's not more the case on Python 3.4 thanks
  502. # to the PEP 442.
  503. if sys.version_info >= (3, 4):
  504. def __del__(self):
  505. if self._sock is not None:
  506. warnings.warn("unclosed transport %r" % self, ResourceWarning)
  507. self._sock.close()
  508. def _fatal_error(self, exc, message='Fatal error on transport'):
  509. # Should be called from exception handler only.
  510. if isinstance(exc, (BrokenPipeError,
  511. ConnectionResetError, ConnectionAbortedError)):
  512. if self._loop.get_debug():
  513. logger.debug("%r: %s", self, message, exc_info=True)
  514. else:
  515. self._loop.call_exception_handler({
  516. 'message': message,
  517. 'exception': exc,
  518. 'transport': self,
  519. 'protocol': self._protocol,
  520. })
  521. self._force_close(exc)
  522. def _force_close(self, exc):
  523. if self._conn_lost:
  524. return
  525. if self._buffer:
  526. self._buffer.clear()
  527. self._loop.remove_writer(self._sock_fd)
  528. if not self._closing:
  529. self._closing = True
  530. self._loop.remove_reader(self._sock_fd)
  531. self._conn_lost += 1
  532. self._loop.call_soon(self._call_connection_lost, exc)
  533. def _call_connection_lost(self, exc):
  534. try:
  535. if self._protocol_connected:
  536. self._protocol.connection_lost(exc)
  537. finally:
  538. self._sock.close()
  539. self._sock = None
  540. self._protocol = None
  541. self._loop = None
  542. server = self._server
  543. if server is not None:
  544. server._detach()
  545. self._server = None
  546. def get_write_buffer_size(self):
  547. return len(self._buffer)
  548. class _SelectorSocketTransport(_SelectorTransport):
  549. def __init__(self, loop, sock, protocol, waiter=None,
  550. extra=None, server=None):
  551. super().__init__(loop, sock, protocol, extra, server)
  552. self._eof = False
  553. self._paused = False
  554. self._loop.call_soon(self._protocol.connection_made, self)
  555. # only start reading when connection_made() has been called
  556. self._loop.call_soon(self._loop.add_reader,
  557. self._sock_fd, self._read_ready)
  558. if waiter is not None:
  559. # only wake up the waiter when connection_made() has been called
  560. self._loop.call_soon(waiter._set_result_unless_cancelled, None)
  561. def pause_reading(self):
  562. if self._closing:
  563. raise RuntimeError('Cannot pause_reading() when closing')
  564. if self._paused:
  565. raise RuntimeError('Already paused')
  566. self._paused = True
  567. self._loop.remove_reader(self._sock_fd)
  568. if self._loop.get_debug():
  569. logger.debug("%r pauses reading", self)
  570. def resume_reading(self):
  571. if not self._paused:
  572. raise RuntimeError('Not paused')
  573. self._paused = False
  574. if self._closing:
  575. return
  576. self._loop.add_reader(self._sock_fd, self._read_ready)
  577. if self._loop.get_debug():
  578. logger.debug("%r resumes reading", self)
  579. def _read_ready(self):
  580. try:
  581. data = self._sock.recv(self.max_size)
  582. except (BlockingIOError, InterruptedError):
  583. pass
  584. except Exception as exc:
  585. self._fatal_error(exc, 'Fatal read error on socket transport')
  586. else:
  587. if data:
  588. self._protocol.data_received(data)
  589. else:
  590. if self._loop.get_debug():
  591. logger.debug("%r received EOF", self)
  592. keep_open = self._protocol.eof_received()
  593. if keep_open:
  594. # We're keeping the connection open so the
  595. # protocol can write more, but we still can't
  596. # receive more, so remove the reader callback.
  597. self._loop.remove_reader(self._sock_fd)
  598. else:
  599. self.close()
  600. def write(self, data):
  601. if not isinstance(data, (bytes, bytearray, memoryview)):
  602. raise TypeError('data argument must be byte-ish (%r)',
  603. type(data))
  604. if self._eof:
  605. raise RuntimeError('Cannot call write() after write_eof()')
  606. if not data:
  607. return
  608. if self._conn_lost:
  609. if self._conn_lost >= constants.LOG_THRESHOLD_FOR_CONNLOST_WRITES:
  610. logger.warning('socket.send() raised exception.')
  611. self._conn_lost += 1
  612. return
  613. if not self._buffer:
  614. # Optimization: try to send now.
  615. try:
  616. n = self._sock.send(data)
  617. except (BlockingIOError, InterruptedError):
  618. pass
  619. except Exception as exc:
  620. self._fatal_error(exc, 'Fatal write error on socket transport')
  621. return
  622. else:
  623. data = data[n:]
  624. if not data:
  625. return
  626. # Not all was written; register write handler.
  627. self._loop.add_writer(self._sock_fd, self._write_ready)
  628. # Add it to the buffer.
  629. self._buffer.extend(data)
  630. self._maybe_pause_protocol()
  631. def _write_ready(self):
  632. assert self._buffer, 'Data should not be empty'
  633. try:
  634. n = self._sock.send(self._buffer)
  635. except (BlockingIOError, InterruptedError):
  636. pass
  637. except Exception as exc:
  638. self._loop.remove_writer(self._sock_fd)
  639. self._buffer.clear()
  640. self._fatal_error(exc, 'Fatal write error on socket transport')
  641. else:
  642. if n:
  643. del self._buffer[:n]
  644. self._maybe_resume_protocol() # May append to buffer.
  645. if not self._buffer:
  646. self._loop.remove_writer(self._sock_fd)
  647. if self._closing:
  648. self._call_connection_lost(None)
  649. elif self._eof:
  650. self._sock.shutdown(socket.SHUT_WR)
  651. def write_eof(self):
  652. if self._eof:
  653. return
  654. self._eof = True
  655. if not self._buffer:
  656. self._sock.shutdown(socket.SHUT_WR)
  657. def can_write_eof(self):
  658. return True
  659. class _SelectorSslTransport(_SelectorTransport):
  660. _buffer_factory = bytearray
  661. def __init__(self, loop, rawsock, protocol, sslcontext, waiter=None,
  662. server_side=False, server_hostname=None,
  663. extra=None, server=None):
  664. if ssl is None:
  665. raise RuntimeError('stdlib ssl module not available')
  666. if not sslcontext:
  667. sslcontext = sslproto._create_transport_context(server_side, server_hostname)
  668. wrap_kwargs = {
  669. 'server_side': server_side,
  670. 'do_handshake_on_connect': False,
  671. }
  672. if server_hostname and not server_side:
  673. wrap_kwargs['server_hostname'] = server_hostname
  674. sslsock = sslcontext.wrap_socket(rawsock, **wrap_kwargs)
  675. super().__init__(loop, sslsock, protocol, extra, server)
  676. # the protocol connection is only made after the SSL handshake
  677. self._protocol_connected = False
  678. self._server_hostname = server_hostname
  679. self._waiter = waiter
  680. self._sslcontext = sslcontext
  681. self._paused = False
  682. # SSL-specific extra info. (peercert is set later)
  683. self._extra.update(sslcontext=sslcontext)
  684. if self._loop.get_debug():
  685. logger.debug("%r starts SSL handshake", self)
  686. start_time = self._loop.time()
  687. else:
  688. start_time = None
  689. self._on_handshake(start_time)
  690. def _wakeup_waiter(self, exc=None):
  691. if self._waiter is None:
  692. return
  693. if not self._waiter.cancelled():
  694. if exc is not None:
  695. self._waiter.set_exception(exc)
  696. else:
  697. self._waiter.set_result(None)
  698. self._waiter = None
  699. def _on_handshake(self, start_time):
  700. try:
  701. self._sock.do_handshake()
  702. except ssl.SSLWantReadError:
  703. self._loop.add_reader(self._sock_fd,
  704. self._on_handshake, start_time)
  705. return
  706. except ssl.SSLWantWriteError:
  707. self._loop.add_writer(self._sock_fd,
  708. self._on_handshake, start_time)
  709. return
  710. except BaseException as exc:
  711. if self._loop.get_debug():
  712. logger.warning("%r: SSL handshake failed",
  713. self, exc_info=True)
  714. self._loop.remove_reader(self._sock_fd)
  715. self._loop.remove_writer(self._sock_fd)
  716. self._sock.close()
  717. self._wakeup_waiter(exc)
  718. if isinstance(exc, Exception):
  719. return
  720. else:
  721. raise
  722. self._loop.remove_reader(self._sock_fd)
  723. self._loop.remove_writer(self._sock_fd)
  724. peercert = self._sock.getpeercert()
  725. if not hasattr(self._sslcontext, 'check_hostname'):
  726. # Verify hostname if requested, Python 3.4+ uses check_hostname
  727. # and checks the hostname in do_handshake()
  728. if (self._server_hostname and
  729. self._sslcontext.verify_mode != ssl.CERT_NONE):
  730. try:
  731. ssl.match_hostname(peercert, self._server_hostname)
  732. except Exception as exc:
  733. if self._loop.get_debug():
  734. logger.warning("%r: SSL handshake failed "
  735. "on matching the hostname",
  736. self, exc_info=True)
  737. self._sock.close()
  738. self._wakeup_waiter(exc)
  739. return
  740. # Add extra info that becomes available after handshake.
  741. self._extra.update(peercert=peercert,
  742. cipher=self._sock.cipher(),
  743. compression=self._sock.compression(),
  744. )
  745. self._read_wants_write = False
  746. self._write_wants_read = False
  747. self._loop.add_reader(self._sock_fd, self._read_ready)
  748. self._protocol_connected = True
  749. self._loop.call_soon(self._protocol.connection_made, self)
  750. # only wake up the waiter when connection_made() has been called
  751. self._loop.call_soon(self._wakeup_waiter)
  752. if self._loop.get_debug():
  753. dt = self._loop.time() - start_time
  754. logger.debug("%r: SSL handshake took %.1f ms", self, dt * 1e3)
  755. def pause_reading(self):
  756. # XXX This is a bit icky, given the comment at the top of
  757. # _read_ready(). Is it possible to evoke a deadlock? I don't
  758. # know, although it doesn't look like it; write() will still
  759. # accept more data for the buffer and eventually the app will
  760. # call resume_reading() again, and things will flow again.
  761. if self._closing:
  762. raise RuntimeError('Cannot pause_reading() when closing')
  763. if self._paused:
  764. raise RuntimeError('Already paused')
  765. self._paused = True
  766. self._loop.remove_reader(self._sock_fd)
  767. if self._loop.get_debug():
  768. logger.debug("%r pauses reading", self)
  769. def resume_reading(self):
  770. if not self._paused:
  771. raise RuntimeError('Not paused')
  772. self._paused = False
  773. if self._closing:
  774. return
  775. self._loop.add_reader(self._sock_fd, self._read_ready)
  776. if self._loop.get_debug():
  777. logger.debug("%r resumes reading", self)
  778. def _read_ready(self):
  779. if self._write_wants_read:
  780. self._write_wants_read = False
  781. self._write_ready()
  782. if self._buffer:
  783. self._loop.add_writer(self._sock_fd, self._write_ready)
  784. try:
  785. data = self._sock.recv(self.max_size)
  786. except (BlockingIOError, InterruptedError, ssl.SSLWantReadError):
  787. pass
  788. except ssl.SSLWantWriteError:
  789. self._read_wants_write = True
  790. self._loop.remove_reader(self._sock_fd)
  791. self._loop.add_writer(self._sock_fd, self._write_ready)
  792. except Exception as exc:
  793. self._fatal_error(exc, 'Fatal read error on SSL transport')
  794. else:
  795. if data:
  796. self._protocol.data_received(data)
  797. else:
  798. try:
  799. if self._loop.get_debug():
  800. logger.debug("%r received EOF", self)
  801. keep_open = self._protocol.eof_received()
  802. if keep_open:
  803. logger.warning('returning true from eof_received() '
  804. 'has no effect when using ssl')
  805. finally:
  806. self.close()
  807. def _write_ready(self):
  808. if self._read_wants_write:
  809. self._read_wants_write = False
  810. self._read_ready()
  811. if not (self._paused or self._closing):
  812. self._loop.add_reader(self._sock_fd, self._read_ready)
  813. if self._buffer:
  814. try:
  815. n = self._sock.send(self._buffer)
  816. except (BlockingIOError, InterruptedError, ssl.SSLWantWriteError):
  817. n = 0
  818. except ssl.SSLWantReadError:
  819. n = 0
  820. self._loop.remove_writer(self._sock_fd)
  821. self._write_wants_read = True
  822. except Exception as exc:
  823. self._loop.remove_writer(self._sock_fd)
  824. self._buffer.clear()
  825. self._fatal_error(exc, 'Fatal write error on SSL transport')
  826. return
  827. if n:
  828. del self._buffer[:n]
  829. self._maybe_resume_protocol() # May append to buffer.
  830. if not self._buffer:
  831. self._loop.remove_writer(self._sock_fd)
  832. if self._closing:
  833. self._call_connection_lost(None)
  834. def write(self, data):
  835. if not isinstance(data, (bytes, bytearray, memoryview)):
  836. raise TypeError('data argument must be byte-ish (%r)',
  837. type(data))
  838. if not data:
  839. return
  840. if self._conn_lost:
  841. if self._conn_lost >= constants.LOG_THRESHOLD_FOR_CONNLOST_WRITES:
  842. logger.warning('socket.send() raised exception.')
  843. self._conn_lost += 1
  844. return
  845. if not self._buffer:
  846. self._loop.add_writer(self._sock_fd, self._write_ready)
  847. # Add it to the buffer.
  848. self._buffer.extend(data)
  849. self._maybe_pause_protocol()
  850. def can_write_eof(self):
  851. return False
  852. class _SelectorDatagramTransport(_SelectorTransport):
  853. _buffer_factory = collections.deque
  854. def __init__(self, loop, sock, protocol, address=None,
  855. waiter=None, extra=None):
  856. super().__init__(loop, sock, protocol, extra)
  857. self._address = address
  858. self._loop.call_soon(self._protocol.connection_made, self)
  859. # only start reading when connection_made() has been called
  860. self._loop.call_soon(self._loop.add_reader,
  861. self._sock_fd, self._read_ready)
  862. if waiter is not None:
  863. # only wake up the waiter when connection_made() has been called
  864. self._loop.call_soon(waiter._set_result_unless_cancelled, None)
  865. def get_write_buffer_size(self):
  866. return sum(len(data) for data, _ in self._buffer)
  867. def _read_ready(self):
  868. try:
  869. data, addr = self._sock.recvfrom(self.max_size)
  870. except (BlockingIOError, InterruptedError):
  871. pass
  872. except OSError as exc:
  873. self._protocol.error_received(exc)
  874. except Exception as exc:
  875. self._fatal_error(exc, 'Fatal read error on datagram transport')
  876. else:
  877. self._protocol.datagram_received(data, addr)
  878. def sendto(self, data, addr=None):
  879. if not isinstance(data, (bytes, bytearray, memoryview)):
  880. raise TypeError('data argument must be byte-ish (%r)',
  881. type(data))
  882. if not data:
  883. return
  884. if self._address and addr not in (None, self._address):
  885. raise ValueError('Invalid address: must be None or %s' %
  886. (self._address,))
  887. if self._conn_lost and self._address:
  888. if self._conn_lost >= constants.LOG_THRESHOLD_FOR_CONNLOST_WRITES:
  889. logger.warning('socket.send() raised exception.')
  890. self._conn_lost += 1
  891. return
  892. if not self._buffer:
  893. # Attempt to send it right away first.
  894. try:
  895. if self._address:
  896. self._sock.send(data)
  897. else:
  898. self._sock.sendto(data, addr)
  899. return
  900. except (BlockingIOError, InterruptedError):
  901. self._loop.add_writer(self._sock_fd, self._sendto_ready)
  902. except OSError as exc:
  903. self._protocol.error_received(exc)
  904. return
  905. except Exception as exc:
  906. self._fatal_error(exc,
  907. 'Fatal write error on datagram transport')
  908. return
  909. # Ensure that what we buffer is immutable.
  910. self._buffer.append((bytes(data), addr))
  911. self._maybe_pause_protocol()
  912. def _sendto_ready(self):
  913. while self._buffer:
  914. data, addr = self._buffer.popleft()
  915. try:
  916. if self._address:
  917. self._sock.send(data)
  918. else:
  919. self._sock.sendto(data, addr)
  920. except (BlockingIOError, InterruptedError):
  921. self._buffer.appendleft((data, addr)) # Try again later.
  922. break
  923. except OSError as exc:
  924. self._protocol.error_received(exc)
  925. return
  926. except Exception as exc:
  927. self._fatal_error(exc,
  928. 'Fatal write error on datagram transport')
  929. return
  930. self._maybe_resume_protocol() # May append to buffer.
  931. if not self._buffer:
  932. self._loop.remove_writer(self._sock_fd)
  933. if self._closing:
  934. self._call_connection_lost(None)