windows_events.py 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913
  1. """Selector and proactor event loops for Windows."""
  2. import sys
  3. if sys.platform != 'win32': # pragma: no cover
  4. raise ImportError('win32 only')
  5. import _overlapped
  6. import _winapi
  7. import errno
  8. import math
  9. import msvcrt
  10. import socket
  11. import struct
  12. import time
  13. import weakref
  14. from . import events
  15. from . import base_subprocess
  16. from . import futures
  17. from . import exceptions
  18. from . import proactor_events
  19. from . import selector_events
  20. from . import tasks
  21. from . import windows_utils
  22. from .log import logger
  23. __all__ = (
  24. 'SelectorEventLoop', 'ProactorEventLoop', 'IocpProactor',
  25. 'DefaultEventLoopPolicy', 'WindowsSelectorEventLoopPolicy',
  26. 'WindowsProactorEventLoopPolicy',
  27. )
  28. NULL = 0
  29. INFINITE = 0xffffffff
  30. ERROR_CONNECTION_REFUSED = 1225
  31. ERROR_CONNECTION_ABORTED = 1236
  32. # Initial delay in seconds for connect_pipe() before retrying to connect
  33. CONNECT_PIPE_INIT_DELAY = 0.001
  34. # Maximum delay in seconds for connect_pipe() before retrying to connect
  35. CONNECT_PIPE_MAX_DELAY = 0.100
  36. class _OverlappedFuture(futures.Future):
  37. """Subclass of Future which represents an overlapped operation.
  38. Cancelling it will immediately cancel the overlapped operation.
  39. """
  40. def __init__(self, ov, *, loop=None):
  41. super().__init__(loop=loop)
  42. if self._source_traceback:
  43. del self._source_traceback[-1]
  44. self._ov = ov
  45. def _repr_info(self):
  46. info = super()._repr_info()
  47. if self._ov is not None:
  48. state = 'pending' if self._ov.pending else 'completed'
  49. info.insert(1, f'overlapped=<{state}, {self._ov.address:#x}>')
  50. return info
  51. def _cancel_overlapped(self):
  52. if self._ov is None:
  53. return
  54. try:
  55. self._ov.cancel()
  56. except OSError as exc:
  57. context = {
  58. 'message': 'Cancelling an overlapped future failed',
  59. 'exception': exc,
  60. 'future': self,
  61. }
  62. if self._source_traceback:
  63. context['source_traceback'] = self._source_traceback
  64. self._loop.call_exception_handler(context)
  65. self._ov = None
  66. def cancel(self, msg=None):
  67. self._cancel_overlapped()
  68. return super().cancel(msg=msg)
  69. def set_exception(self, exception):
  70. super().set_exception(exception)
  71. self._cancel_overlapped()
  72. def set_result(self, result):
  73. super().set_result(result)
  74. self._ov = None
  75. class _BaseWaitHandleFuture(futures.Future):
  76. """Subclass of Future which represents a wait handle."""
  77. def __init__(self, ov, handle, wait_handle, *, loop=None):
  78. super().__init__(loop=loop)
  79. if self._source_traceback:
  80. del self._source_traceback[-1]
  81. # Keep a reference to the Overlapped object to keep it alive until the
  82. # wait is unregistered
  83. self._ov = ov
  84. self._handle = handle
  85. self._wait_handle = wait_handle
  86. # Should we call UnregisterWaitEx() if the wait completes
  87. # or is cancelled?
  88. self._registered = True
  89. def _poll(self):
  90. # non-blocking wait: use a timeout of 0 millisecond
  91. return (_winapi.WaitForSingleObject(self._handle, 0) ==
  92. _winapi.WAIT_OBJECT_0)
  93. def _repr_info(self):
  94. info = super()._repr_info()
  95. info.append(f'handle={self._handle:#x}')
  96. if self._handle is not None:
  97. state = 'signaled' if self._poll() else 'waiting'
  98. info.append(state)
  99. if self._wait_handle is not None:
  100. info.append(f'wait_handle={self._wait_handle:#x}')
  101. return info
  102. def _unregister_wait_cb(self, fut):
  103. # The wait was unregistered: it's not safe to destroy the Overlapped
  104. # object
  105. self._ov = None
  106. def _unregister_wait(self):
  107. if not self._registered:
  108. return
  109. self._registered = False
  110. wait_handle = self._wait_handle
  111. self._wait_handle = None
  112. try:
  113. _overlapped.UnregisterWait(wait_handle)
  114. except OSError as exc:
  115. if exc.winerror != _overlapped.ERROR_IO_PENDING:
  116. context = {
  117. 'message': 'Failed to unregister the wait handle',
  118. 'exception': exc,
  119. 'future': self,
  120. }
  121. if self._source_traceback:
  122. context['source_traceback'] = self._source_traceback
  123. self._loop.call_exception_handler(context)
  124. return
  125. # ERROR_IO_PENDING means that the unregister is pending
  126. self._unregister_wait_cb(None)
  127. def cancel(self, msg=None):
  128. self._unregister_wait()
  129. return super().cancel(msg=msg)
  130. def set_exception(self, exception):
  131. self._unregister_wait()
  132. super().set_exception(exception)
  133. def set_result(self, result):
  134. self._unregister_wait()
  135. super().set_result(result)
  136. class _WaitCancelFuture(_BaseWaitHandleFuture):
  137. """Subclass of Future which represents a wait for the cancellation of a
  138. _WaitHandleFuture using an event.
  139. """
  140. def __init__(self, ov, event, wait_handle, *, loop=None):
  141. super().__init__(ov, event, wait_handle, loop=loop)
  142. self._done_callback = None
  143. def cancel(self):
  144. raise RuntimeError("_WaitCancelFuture must not be cancelled")
  145. def set_result(self, result):
  146. super().set_result(result)
  147. if self._done_callback is not None:
  148. self._done_callback(self)
  149. def set_exception(self, exception):
  150. super().set_exception(exception)
  151. if self._done_callback is not None:
  152. self._done_callback(self)
  153. class _WaitHandleFuture(_BaseWaitHandleFuture):
  154. def __init__(self, ov, handle, wait_handle, proactor, *, loop=None):
  155. super().__init__(ov, handle, wait_handle, loop=loop)
  156. self._proactor = proactor
  157. self._unregister_proactor = True
  158. self._event = _overlapped.CreateEvent(None, True, False, None)
  159. self._event_fut = None
  160. def _unregister_wait_cb(self, fut):
  161. if self._event is not None:
  162. _winapi.CloseHandle(self._event)
  163. self._event = None
  164. self._event_fut = None
  165. # If the wait was cancelled, the wait may never be signalled, so
  166. # it's required to unregister it. Otherwise, IocpProactor.close() will
  167. # wait forever for an event which will never come.
  168. #
  169. # If the IocpProactor already received the event, it's safe to call
  170. # _unregister() because we kept a reference to the Overlapped object
  171. # which is used as a unique key.
  172. self._proactor._unregister(self._ov)
  173. self._proactor = None
  174. super()._unregister_wait_cb(fut)
  175. def _unregister_wait(self):
  176. if not self._registered:
  177. return
  178. self._registered = False
  179. wait_handle = self._wait_handle
  180. self._wait_handle = None
  181. try:
  182. _overlapped.UnregisterWaitEx(wait_handle, self._event)
  183. except OSError as exc:
  184. if exc.winerror != _overlapped.ERROR_IO_PENDING:
  185. context = {
  186. 'message': 'Failed to unregister the wait handle',
  187. 'exception': exc,
  188. 'future': self,
  189. }
  190. if self._source_traceback:
  191. context['source_traceback'] = self._source_traceback
  192. self._loop.call_exception_handler(context)
  193. return
  194. # ERROR_IO_PENDING is not an error, the wait was unregistered
  195. self._event_fut = self._proactor._wait_cancel(self._event,
  196. self._unregister_wait_cb)
  197. class PipeServer(object):
  198. """Class representing a pipe server.
  199. This is much like a bound, listening socket.
  200. """
  201. def __init__(self, address):
  202. self._address = address
  203. self._free_instances = weakref.WeakSet()
  204. # initialize the pipe attribute before calling _server_pipe_handle()
  205. # because this function can raise an exception and the destructor calls
  206. # the close() method
  207. self._pipe = None
  208. self._accept_pipe_future = None
  209. self._pipe = self._server_pipe_handle(True)
  210. def _get_unconnected_pipe(self):
  211. # Create new instance and return previous one. This ensures
  212. # that (until the server is closed) there is always at least
  213. # one pipe handle for address. Therefore if a client attempt
  214. # to connect it will not fail with FileNotFoundError.
  215. tmp, self._pipe = self._pipe, self._server_pipe_handle(False)
  216. return tmp
  217. def _server_pipe_handle(self, first):
  218. # Return a wrapper for a new pipe handle.
  219. if self.closed():
  220. return None
  221. flags = _winapi.PIPE_ACCESS_DUPLEX | _winapi.FILE_FLAG_OVERLAPPED
  222. if first:
  223. flags |= _winapi.FILE_FLAG_FIRST_PIPE_INSTANCE
  224. h = _winapi.CreateNamedPipe(
  225. self._address, flags,
  226. _winapi.PIPE_TYPE_MESSAGE | _winapi.PIPE_READMODE_MESSAGE |
  227. _winapi.PIPE_WAIT,
  228. _winapi.PIPE_UNLIMITED_INSTANCES,
  229. windows_utils.BUFSIZE, windows_utils.BUFSIZE,
  230. _winapi.NMPWAIT_WAIT_FOREVER, _winapi.NULL)
  231. pipe = windows_utils.PipeHandle(h)
  232. self._free_instances.add(pipe)
  233. return pipe
  234. def closed(self):
  235. return (self._address is None)
  236. def close(self):
  237. if self._accept_pipe_future is not None:
  238. self._accept_pipe_future.cancel()
  239. self._accept_pipe_future = None
  240. # Close all instances which have not been connected to by a client.
  241. if self._address is not None:
  242. for pipe in self._free_instances:
  243. pipe.close()
  244. self._pipe = None
  245. self._address = None
  246. self._free_instances.clear()
  247. __del__ = close
  248. class _WindowsSelectorEventLoop(selector_events.BaseSelectorEventLoop):
  249. """Windows version of selector event loop."""
  250. class ProactorEventLoop(proactor_events.BaseProactorEventLoop):
  251. """Windows version of proactor event loop using IOCP."""
  252. def __init__(self, proactor=None):
  253. if proactor is None:
  254. proactor = IocpProactor()
  255. super().__init__(proactor)
  256. def run_forever(self):
  257. try:
  258. assert self._self_reading_future is None
  259. self.call_soon(self._loop_self_reading)
  260. super().run_forever()
  261. finally:
  262. if self._self_reading_future is not None:
  263. ov = self._self_reading_future._ov
  264. self._self_reading_future.cancel()
  265. # self_reading_future was just cancelled so if it hasn't been
  266. # finished yet, it never will be (it's possible that it has
  267. # already finished and its callback is waiting in the queue,
  268. # where it could still happen if the event loop is restarted).
  269. # Unregister it otherwise IocpProactor.close will wait for it
  270. # forever
  271. if ov is not None:
  272. self._proactor._unregister(ov)
  273. self._self_reading_future = None
  274. async def create_pipe_connection(self, protocol_factory, address):
  275. f = self._proactor.connect_pipe(address)
  276. pipe = await f
  277. protocol = protocol_factory()
  278. trans = self._make_duplex_pipe_transport(pipe, protocol,
  279. extra={'addr': address})
  280. return trans, protocol
  281. async def start_serving_pipe(self, protocol_factory, address):
  282. server = PipeServer(address)
  283. def loop_accept_pipe(f=None):
  284. pipe = None
  285. try:
  286. if f:
  287. pipe = f.result()
  288. server._free_instances.discard(pipe)
  289. if server.closed():
  290. # A client connected before the server was closed:
  291. # drop the client (close the pipe) and exit
  292. pipe.close()
  293. return
  294. protocol = protocol_factory()
  295. self._make_duplex_pipe_transport(
  296. pipe, protocol, extra={'addr': address})
  297. pipe = server._get_unconnected_pipe()
  298. if pipe is None:
  299. return
  300. f = self._proactor.accept_pipe(pipe)
  301. except OSError as exc:
  302. if pipe and pipe.fileno() != -1:
  303. self.call_exception_handler({
  304. 'message': 'Pipe accept failed',
  305. 'exception': exc,
  306. 'pipe': pipe,
  307. })
  308. pipe.close()
  309. elif self._debug:
  310. logger.warning("Accept pipe failed on pipe %r",
  311. pipe, exc_info=True)
  312. except exceptions.CancelledError:
  313. if pipe:
  314. pipe.close()
  315. else:
  316. server._accept_pipe_future = f
  317. f.add_done_callback(loop_accept_pipe)
  318. self.call_soon(loop_accept_pipe)
  319. return [server]
  320. async def _make_subprocess_transport(self, protocol, args, shell,
  321. stdin, stdout, stderr, bufsize,
  322. extra=None, **kwargs):
  323. waiter = self.create_future()
  324. transp = _WindowsSubprocessTransport(self, protocol, args, shell,
  325. stdin, stdout, stderr, bufsize,
  326. waiter=waiter, extra=extra,
  327. **kwargs)
  328. try:
  329. await waiter
  330. except (SystemExit, KeyboardInterrupt):
  331. raise
  332. except BaseException:
  333. transp.close()
  334. await transp._wait()
  335. raise
  336. return transp
  337. class IocpProactor:
  338. """Proactor implementation using IOCP."""
  339. def __init__(self, concurrency=0xffffffff):
  340. self._loop = None
  341. self._results = []
  342. self._iocp = _overlapped.CreateIoCompletionPort(
  343. _overlapped.INVALID_HANDLE_VALUE, NULL, 0, concurrency)
  344. self._cache = {}
  345. self._registered = weakref.WeakSet()
  346. self._unregistered = []
  347. self._stopped_serving = weakref.WeakSet()
  348. def _check_closed(self):
  349. if self._iocp is None:
  350. raise RuntimeError('IocpProactor is closed')
  351. def __repr__(self):
  352. info = ['overlapped#=%s' % len(self._cache),
  353. 'result#=%s' % len(self._results)]
  354. if self._iocp is None:
  355. info.append('closed')
  356. return '<%s %s>' % (self.__class__.__name__, " ".join(info))
  357. def set_loop(self, loop):
  358. self._loop = loop
  359. def select(self, timeout=None):
  360. if not self._results:
  361. self._poll(timeout)
  362. tmp = self._results
  363. self._results = []
  364. return tmp
  365. def _result(self, value):
  366. fut = self._loop.create_future()
  367. fut.set_result(value)
  368. return fut
  369. def recv(self, conn, nbytes, flags=0):
  370. self._register_with_iocp(conn)
  371. ov = _overlapped.Overlapped(NULL)
  372. try:
  373. if isinstance(conn, socket.socket):
  374. ov.WSARecv(conn.fileno(), nbytes, flags)
  375. else:
  376. ov.ReadFile(conn.fileno(), nbytes)
  377. except BrokenPipeError:
  378. return self._result(b'')
  379. def finish_recv(trans, key, ov):
  380. try:
  381. return ov.getresult()
  382. except OSError as exc:
  383. if exc.winerror in (_overlapped.ERROR_NETNAME_DELETED,
  384. _overlapped.ERROR_OPERATION_ABORTED):
  385. raise ConnectionResetError(*exc.args)
  386. else:
  387. raise
  388. return self._register(ov, conn, finish_recv)
  389. def recv_into(self, conn, buf, flags=0):
  390. self._register_with_iocp(conn)
  391. ov = _overlapped.Overlapped(NULL)
  392. try:
  393. if isinstance(conn, socket.socket):
  394. ov.WSARecvInto(conn.fileno(), buf, flags)
  395. else:
  396. ov.ReadFileInto(conn.fileno(), buf)
  397. except BrokenPipeError:
  398. return self._result(0)
  399. def finish_recv(trans, key, ov):
  400. try:
  401. return ov.getresult()
  402. except OSError as exc:
  403. if exc.winerror in (_overlapped.ERROR_NETNAME_DELETED,
  404. _overlapped.ERROR_OPERATION_ABORTED):
  405. raise ConnectionResetError(*exc.args)
  406. else:
  407. raise
  408. return self._register(ov, conn, finish_recv)
  409. def recvfrom(self, conn, nbytes, flags=0):
  410. self._register_with_iocp(conn)
  411. ov = _overlapped.Overlapped(NULL)
  412. try:
  413. ov.WSARecvFrom(conn.fileno(), nbytes, flags)
  414. except BrokenPipeError:
  415. return self._result((b'', None))
  416. def finish_recv(trans, key, ov):
  417. try:
  418. return ov.getresult()
  419. except OSError as exc:
  420. if exc.winerror in (_overlapped.ERROR_NETNAME_DELETED,
  421. _overlapped.ERROR_OPERATION_ABORTED):
  422. raise ConnectionResetError(*exc.args)
  423. else:
  424. raise
  425. return self._register(ov, conn, finish_recv)
  426. def sendto(self, conn, buf, flags=0, addr=None):
  427. self._register_with_iocp(conn)
  428. ov = _overlapped.Overlapped(NULL)
  429. ov.WSASendTo(conn.fileno(), buf, flags, addr)
  430. def finish_send(trans, key, ov):
  431. try:
  432. return ov.getresult()
  433. except OSError as exc:
  434. if exc.winerror in (_overlapped.ERROR_NETNAME_DELETED,
  435. _overlapped.ERROR_OPERATION_ABORTED):
  436. raise ConnectionResetError(*exc.args)
  437. else:
  438. raise
  439. return self._register(ov, conn, finish_send)
  440. def send(self, conn, buf, flags=0):
  441. self._register_with_iocp(conn)
  442. ov = _overlapped.Overlapped(NULL)
  443. if isinstance(conn, socket.socket):
  444. ov.WSASend(conn.fileno(), buf, flags)
  445. else:
  446. ov.WriteFile(conn.fileno(), buf)
  447. def finish_send(trans, key, ov):
  448. try:
  449. return ov.getresult()
  450. except OSError as exc:
  451. if exc.winerror in (_overlapped.ERROR_NETNAME_DELETED,
  452. _overlapped.ERROR_OPERATION_ABORTED):
  453. raise ConnectionResetError(*exc.args)
  454. else:
  455. raise
  456. return self._register(ov, conn, finish_send)
  457. def accept(self, listener):
  458. self._register_with_iocp(listener)
  459. conn = self._get_accept_socket(listener.family)
  460. ov = _overlapped.Overlapped(NULL)
  461. ov.AcceptEx(listener.fileno(), conn.fileno())
  462. def finish_accept(trans, key, ov):
  463. ov.getresult()
  464. # Use SO_UPDATE_ACCEPT_CONTEXT so getsockname() etc work.
  465. buf = struct.pack('@P', listener.fileno())
  466. conn.setsockopt(socket.SOL_SOCKET,
  467. _overlapped.SO_UPDATE_ACCEPT_CONTEXT, buf)
  468. conn.settimeout(listener.gettimeout())
  469. return conn, conn.getpeername()
  470. async def accept_coro(future, conn):
  471. # Coroutine closing the accept socket if the future is cancelled
  472. try:
  473. await future
  474. except exceptions.CancelledError:
  475. conn.close()
  476. raise
  477. future = self._register(ov, listener, finish_accept)
  478. coro = accept_coro(future, conn)
  479. tasks.ensure_future(coro, loop=self._loop)
  480. return future
  481. def connect(self, conn, address):
  482. if conn.type == socket.SOCK_DGRAM:
  483. # WSAConnect will complete immediately for UDP sockets so we don't
  484. # need to register any IOCP operation
  485. _overlapped.WSAConnect(conn.fileno(), address)
  486. fut = self._loop.create_future()
  487. fut.set_result(None)
  488. return fut
  489. self._register_with_iocp(conn)
  490. # The socket needs to be locally bound before we call ConnectEx().
  491. try:
  492. _overlapped.BindLocal(conn.fileno(), conn.family)
  493. except OSError as e:
  494. if e.winerror != errno.WSAEINVAL:
  495. raise
  496. # Probably already locally bound; check using getsockname().
  497. if conn.getsockname()[1] == 0:
  498. raise
  499. ov = _overlapped.Overlapped(NULL)
  500. ov.ConnectEx(conn.fileno(), address)
  501. def finish_connect(trans, key, ov):
  502. ov.getresult()
  503. # Use SO_UPDATE_CONNECT_CONTEXT so getsockname() etc work.
  504. conn.setsockopt(socket.SOL_SOCKET,
  505. _overlapped.SO_UPDATE_CONNECT_CONTEXT, 0)
  506. return conn
  507. return self._register(ov, conn, finish_connect)
  508. def sendfile(self, sock, file, offset, count):
  509. self._register_with_iocp(sock)
  510. ov = _overlapped.Overlapped(NULL)
  511. offset_low = offset & 0xffff_ffff
  512. offset_high = (offset >> 32) & 0xffff_ffff
  513. ov.TransmitFile(sock.fileno(),
  514. msvcrt.get_osfhandle(file.fileno()),
  515. offset_low, offset_high,
  516. count, 0, 0)
  517. def finish_sendfile(trans, key, ov):
  518. try:
  519. return ov.getresult()
  520. except OSError as exc:
  521. if exc.winerror in (_overlapped.ERROR_NETNAME_DELETED,
  522. _overlapped.ERROR_OPERATION_ABORTED):
  523. raise ConnectionResetError(*exc.args)
  524. else:
  525. raise
  526. return self._register(ov, sock, finish_sendfile)
  527. def accept_pipe(self, pipe):
  528. self._register_with_iocp(pipe)
  529. ov = _overlapped.Overlapped(NULL)
  530. connected = ov.ConnectNamedPipe(pipe.fileno())
  531. if connected:
  532. # ConnectNamePipe() failed with ERROR_PIPE_CONNECTED which means
  533. # that the pipe is connected. There is no need to wait for the
  534. # completion of the connection.
  535. return self._result(pipe)
  536. def finish_accept_pipe(trans, key, ov):
  537. ov.getresult()
  538. return pipe
  539. return self._register(ov, pipe, finish_accept_pipe)
  540. async def connect_pipe(self, address):
  541. delay = CONNECT_PIPE_INIT_DELAY
  542. while True:
  543. # Unfortunately there is no way to do an overlapped connect to
  544. # a pipe. Call CreateFile() in a loop until it doesn't fail with
  545. # ERROR_PIPE_BUSY.
  546. try:
  547. handle = _overlapped.ConnectPipe(address)
  548. break
  549. except OSError as exc:
  550. if exc.winerror != _overlapped.ERROR_PIPE_BUSY:
  551. raise
  552. # ConnectPipe() failed with ERROR_PIPE_BUSY: retry later
  553. delay = min(delay * 2, CONNECT_PIPE_MAX_DELAY)
  554. await tasks.sleep(delay)
  555. return windows_utils.PipeHandle(handle)
  556. def wait_for_handle(self, handle, timeout=None):
  557. """Wait for a handle.
  558. Return a Future object. The result of the future is True if the wait
  559. completed, or False if the wait did not complete (on timeout).
  560. """
  561. return self._wait_for_handle(handle, timeout, False)
  562. def _wait_cancel(self, event, done_callback):
  563. fut = self._wait_for_handle(event, None, True)
  564. # add_done_callback() cannot be used because the wait may only complete
  565. # in IocpProactor.close(), while the event loop is not running.
  566. fut._done_callback = done_callback
  567. return fut
  568. def _wait_for_handle(self, handle, timeout, _is_cancel):
  569. self._check_closed()
  570. if timeout is None:
  571. ms = _winapi.INFINITE
  572. else:
  573. # RegisterWaitForSingleObject() has a resolution of 1 millisecond,
  574. # round away from zero to wait *at least* timeout seconds.
  575. ms = math.ceil(timeout * 1e3)
  576. # We only create ov so we can use ov.address as a key for the cache.
  577. ov = _overlapped.Overlapped(NULL)
  578. wait_handle = _overlapped.RegisterWaitWithQueue(
  579. handle, self._iocp, ov.address, ms)
  580. if _is_cancel:
  581. f = _WaitCancelFuture(ov, handle, wait_handle, loop=self._loop)
  582. else:
  583. f = _WaitHandleFuture(ov, handle, wait_handle, self,
  584. loop=self._loop)
  585. if f._source_traceback:
  586. del f._source_traceback[-1]
  587. def finish_wait_for_handle(trans, key, ov):
  588. # Note that this second wait means that we should only use
  589. # this with handles types where a successful wait has no
  590. # effect. So events or processes are all right, but locks
  591. # or semaphores are not. Also note if the handle is
  592. # signalled and then quickly reset, then we may return
  593. # False even though we have not timed out.
  594. return f._poll()
  595. self._cache[ov.address] = (f, ov, 0, finish_wait_for_handle)
  596. return f
  597. def _register_with_iocp(self, obj):
  598. # To get notifications of finished ops on this objects sent to the
  599. # completion port, were must register the handle.
  600. if obj not in self._registered:
  601. self._registered.add(obj)
  602. _overlapped.CreateIoCompletionPort(obj.fileno(), self._iocp, 0, 0)
  603. # XXX We could also use SetFileCompletionNotificationModes()
  604. # to avoid sending notifications to completion port of ops
  605. # that succeed immediately.
  606. def _register(self, ov, obj, callback):
  607. self._check_closed()
  608. # Return a future which will be set with the result of the
  609. # operation when it completes. The future's value is actually
  610. # the value returned by callback().
  611. f = _OverlappedFuture(ov, loop=self._loop)
  612. if f._source_traceback:
  613. del f._source_traceback[-1]
  614. if not ov.pending:
  615. # The operation has completed, so no need to postpone the
  616. # work. We cannot take this short cut if we need the
  617. # NumberOfBytes, CompletionKey values returned by
  618. # PostQueuedCompletionStatus().
  619. try:
  620. value = callback(None, None, ov)
  621. except OSError as e:
  622. f.set_exception(e)
  623. else:
  624. f.set_result(value)
  625. # Even if GetOverlappedResult() was called, we have to wait for the
  626. # notification of the completion in GetQueuedCompletionStatus().
  627. # Register the overlapped operation to keep a reference to the
  628. # OVERLAPPED object, otherwise the memory is freed and Windows may
  629. # read uninitialized memory.
  630. # Register the overlapped operation for later. Note that
  631. # we only store obj to prevent it from being garbage
  632. # collected too early.
  633. self._cache[ov.address] = (f, ov, obj, callback)
  634. return f
  635. def _unregister(self, ov):
  636. """Unregister an overlapped object.
  637. Call this method when its future has been cancelled. The event can
  638. already be signalled (pending in the proactor event queue). It is also
  639. safe if the event is never signalled (because it was cancelled).
  640. """
  641. self._check_closed()
  642. self._unregistered.append(ov)
  643. def _get_accept_socket(self, family):
  644. s = socket.socket(family)
  645. s.settimeout(0)
  646. return s
  647. def _poll(self, timeout=None):
  648. if timeout is None:
  649. ms = INFINITE
  650. elif timeout < 0:
  651. raise ValueError("negative timeout")
  652. else:
  653. # GetQueuedCompletionStatus() has a resolution of 1 millisecond,
  654. # round away from zero to wait *at least* timeout seconds.
  655. ms = math.ceil(timeout * 1e3)
  656. if ms >= INFINITE:
  657. raise ValueError("timeout too big")
  658. while True:
  659. status = _overlapped.GetQueuedCompletionStatus(self._iocp, ms)
  660. if status is None:
  661. break
  662. ms = 0
  663. err, transferred, key, address = status
  664. try:
  665. f, ov, obj, callback = self._cache.pop(address)
  666. except KeyError:
  667. if self._loop.get_debug():
  668. self._loop.call_exception_handler({
  669. 'message': ('GetQueuedCompletionStatus() returned an '
  670. 'unexpected event'),
  671. 'status': ('err=%s transferred=%s key=%#x address=%#x'
  672. % (err, transferred, key, address)),
  673. })
  674. # key is either zero, or it is used to return a pipe
  675. # handle which should be closed to avoid a leak.
  676. if key not in (0, _overlapped.INVALID_HANDLE_VALUE):
  677. _winapi.CloseHandle(key)
  678. continue
  679. if obj in self._stopped_serving:
  680. f.cancel()
  681. # Don't call the callback if _register() already read the result or
  682. # if the overlapped has been cancelled
  683. elif not f.done():
  684. try:
  685. value = callback(transferred, key, ov)
  686. except OSError as e:
  687. f.set_exception(e)
  688. self._results.append(f)
  689. else:
  690. f.set_result(value)
  691. self._results.append(f)
  692. # Remove unregistered futures
  693. for ov in self._unregistered:
  694. self._cache.pop(ov.address, None)
  695. self._unregistered.clear()
  696. def _stop_serving(self, obj):
  697. # obj is a socket or pipe handle. It will be closed in
  698. # BaseProactorEventLoop._stop_serving() which will make any
  699. # pending operations fail quickly.
  700. self._stopped_serving.add(obj)
  701. def close(self):
  702. if self._iocp is None:
  703. # already closed
  704. return
  705. # Cancel remaining registered operations.
  706. for address, (fut, ov, obj, callback) in list(self._cache.items()):
  707. if fut.cancelled():
  708. # Nothing to do with cancelled futures
  709. pass
  710. elif isinstance(fut, _WaitCancelFuture):
  711. # _WaitCancelFuture must not be cancelled
  712. pass
  713. else:
  714. try:
  715. fut.cancel()
  716. except OSError as exc:
  717. if self._loop is not None:
  718. context = {
  719. 'message': 'Cancelling a future failed',
  720. 'exception': exc,
  721. 'future': fut,
  722. }
  723. if fut._source_traceback:
  724. context['source_traceback'] = fut._source_traceback
  725. self._loop.call_exception_handler(context)
  726. # Wait until all cancelled overlapped complete: don't exit with running
  727. # overlapped to prevent a crash. Display progress every second if the
  728. # loop is still running.
  729. msg_update = 1.0
  730. start_time = time.monotonic()
  731. next_msg = start_time + msg_update
  732. while self._cache:
  733. if next_msg <= time.monotonic():
  734. logger.debug('%r is running after closing for %.1f seconds',
  735. self, time.monotonic() - start_time)
  736. next_msg = time.monotonic() + msg_update
  737. # handle a few events, or timeout
  738. self._poll(msg_update)
  739. self._results = []
  740. _winapi.CloseHandle(self._iocp)
  741. self._iocp = None
  742. def __del__(self):
  743. self.close()
  744. class _WindowsSubprocessTransport(base_subprocess.BaseSubprocessTransport):
  745. def _start(self, args, shell, stdin, stdout, stderr, bufsize, **kwargs):
  746. self._proc = windows_utils.Popen(
  747. args, shell=shell, stdin=stdin, stdout=stdout, stderr=stderr,
  748. bufsize=bufsize, **kwargs)
  749. def callback(f):
  750. returncode = self._proc.poll()
  751. self._process_exited(returncode)
  752. f = self._loop._proactor.wait_for_handle(int(self._proc._handle))
  753. f.add_done_callback(callback)
  754. SelectorEventLoop = _WindowsSelectorEventLoop
  755. class WindowsSelectorEventLoopPolicy(events.BaseDefaultEventLoopPolicy):
  756. _loop_factory = SelectorEventLoop
  757. class WindowsProactorEventLoopPolicy(events.BaseDefaultEventLoopPolicy):
  758. _loop_factory = ProactorEventLoop
  759. DefaultEventLoopPolicy = WindowsProactorEventLoopPolicy