blob: 29750f18d80c46e4ac84a800c63320b9605f52ad [file] [log] [blame]
Yury Selivanovb0b0e622014-02-18 22:27:48 -05001"""Selector and proactor event loops for Windows."""
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07002
Victor Stinner4271dfd2017-11-28 15:19:56 +01003import _overlapped
Victor Stinnerf2e17682014-01-31 16:25:24 +01004import _winapi
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07005import errno
Victor Stinnerf2e17682014-01-31 16:25:24 +01006import math
Andrew Svetlova19fb3c2018-02-25 19:32:14 +03007import msvcrt
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07008import socket
Victor Stinnerf2e17682014-01-31 16:25:24 +01009import struct
Victor Stinnerb1e45732019-01-15 11:48:00 +010010import time
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070011import weakref
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070012
Guido van Rossum0eaa5ac2013-11-04 15:50:46 -080013from . import events
Guido van Rossum59691282013-10-30 14:52:03 -070014from . import base_subprocess
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070015from . import futures
Andrew Svetlov0baa72f2018-09-11 10:13:04 -070016from . import exceptions
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070017from . import proactor_events
18from . import selector_events
19from . import tasks
20from . import windows_utils
Victor Stinnerf951d282014-06-29 00:46:45 +020021from .log import logger
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070022
23
Yury Selivanov6370f342017-12-10 18:36:12 -050024__all__ = (
25 'SelectorEventLoop', 'ProactorEventLoop', 'IocpProactor',
Yury Selivanov8f404292018-06-07 20:44:57 -040026 'DefaultEventLoopPolicy', 'WindowsSelectorEventLoopPolicy',
27 'WindowsProactorEventLoopPolicy',
Yury Selivanov6370f342017-12-10 18:36:12 -050028)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070029
30
31NULL = 0
32INFINITE = 0xffffffff
33ERROR_CONNECTION_REFUSED = 1225
34ERROR_CONNECTION_ABORTED = 1236
35
Victor Stinner7ffa2c52015-01-22 22:55:08 +010036# Initial delay in seconds for connect_pipe() before retrying to connect
37CONNECT_PIPE_INIT_DELAY = 0.001
38
39# Maximum delay in seconds for connect_pipe() before retrying to connect
40CONNECT_PIPE_MAX_DELAY = 0.100
41
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070042
43class _OverlappedFuture(futures.Future):
44 """Subclass of Future which represents an overlapped operation.
45
46 Cancelling it will immediately cancel the overlapped operation.
47 """
48
49 def __init__(self, ov, *, loop=None):
50 super().__init__(loop=loop)
Victor Stinnerfea6a102014-07-25 00:54:53 +020051 if self._source_traceback:
52 del self._source_traceback[-1]
Victor Stinner18a28dc2014-07-25 13:05:20 +020053 self._ov = ov
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070054
Victor Stinner313a9802014-07-29 12:58:23 +020055 def _repr_info(self):
56 info = super()._repr_info()
Victor Stinner18a28dc2014-07-25 13:05:20 +020057 if self._ov is not None:
58 state = 'pending' if self._ov.pending else 'completed'
Yury Selivanov6370f342017-12-10 18:36:12 -050059 info.insert(1, f'overlapped=<{state}, {self._ov.address:#x}>')
Victor Stinner313a9802014-07-29 12:58:23 +020060 return info
Victor Stinnere912e652014-07-12 03:11:53 +020061
Victor Stinner18a28dc2014-07-25 13:05:20 +020062 def _cancel_overlapped(self):
63 if self._ov is None:
64 return
65 try:
66 self._ov.cancel()
67 except OSError as exc:
68 context = {
69 'message': 'Cancelling an overlapped future failed',
70 'exception': exc,
71 'future': self,
72 }
73 if self._source_traceback:
74 context['source_traceback'] = self._source_traceback
75 self._loop.call_exception_handler(context)
76 self._ov = None
77
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070078 def cancel(self):
Victor Stinner18a28dc2014-07-25 13:05:20 +020079 self._cancel_overlapped()
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070080 return super().cancel()
81
Victor Stinner18a28dc2014-07-25 13:05:20 +020082 def set_exception(self, exception):
83 super().set_exception(exception)
84 self._cancel_overlapped()
85
Victor Stinner51e44ea2014-07-26 00:58:34 +020086 def set_result(self, result):
87 super().set_result(result)
88 self._ov = None
89
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070090
Victor Stinnerd0a28de2015-01-21 23:39:51 +010091class _BaseWaitHandleFuture(futures.Future):
Guido van Rossum90fb9142013-10-30 14:44:05 -070092 """Subclass of Future which represents a wait handle."""
93
Victor Stinnerd0a28de2015-01-21 23:39:51 +010094 def __init__(self, ov, handle, wait_handle, *, loop=None):
Guido van Rossum90fb9142013-10-30 14:44:05 -070095 super().__init__(loop=loop)
Victor Stinner313a9802014-07-29 12:58:23 +020096 if self._source_traceback:
97 del self._source_traceback[-1]
Victor Stinnerd0a28de2015-01-21 23:39:51 +010098 # Keep a reference to the Overlapped object to keep it alive until the
99 # wait is unregistered
Victor Stinner313a9802014-07-29 12:58:23 +0200100 self._ov = ov
Victor Stinner18a28dc2014-07-25 13:05:20 +0200101 self._handle = handle
Guido van Rossum90fb9142013-10-30 14:44:05 -0700102 self._wait_handle = wait_handle
103
Victor Stinnerd0a28de2015-01-21 23:39:51 +0100104 # Should we call UnregisterWaitEx() if the wait completes
105 # or is cancelled?
106 self._registered = True
107
Victor Stinner18a28dc2014-07-25 13:05:20 +0200108 def _poll(self):
109 # non-blocking wait: use a timeout of 0 millisecond
110 return (_winapi.WaitForSingleObject(self._handle, 0) ==
111 _winapi.WAIT_OBJECT_0)
112
Victor Stinner313a9802014-07-29 12:58:23 +0200113 def _repr_info(self):
114 info = super()._repr_info()
Yury Selivanov6370f342017-12-10 18:36:12 -0500115 info.append(f'handle={self._handle:#x}')
Victor Stinnerd0a28de2015-01-21 23:39:51 +0100116 if self._handle is not None:
Victor Stinner313a9802014-07-29 12:58:23 +0200117 state = 'signaled' if self._poll() else 'waiting'
Victor Stinnerd0a28de2015-01-21 23:39:51 +0100118 info.append(state)
119 if self._wait_handle is not None:
Yury Selivanov6370f342017-12-10 18:36:12 -0500120 info.append(f'wait_handle={self._wait_handle:#x}')
Victor Stinner313a9802014-07-29 12:58:23 +0200121 return info
Victor Stinner18a28dc2014-07-25 13:05:20 +0200122
Victor Stinnerd0a28de2015-01-21 23:39:51 +0100123 def _unregister_wait_cb(self, fut):
124 # The wait was unregistered: it's not safe to destroy the Overlapped
125 # object
126 self._ov = None
127
Victor Stinner313a9802014-07-29 12:58:23 +0200128 def _unregister_wait(self):
Victor Stinnerd0a28de2015-01-21 23:39:51 +0100129 if not self._registered:
Victor Stinnerfea6a102014-07-25 00:54:53 +0200130 return
Victor Stinnerd0a28de2015-01-21 23:39:51 +0100131 self._registered = False
132
Victor Stinner24dfa3c2015-01-26 22:30:28 +0100133 wait_handle = self._wait_handle
134 self._wait_handle = None
Guido van Rossum90fb9142013-10-30 14:44:05 -0700135 try:
Victor Stinner24dfa3c2015-01-26 22:30:28 +0100136 _overlapped.UnregisterWait(wait_handle)
Victor Stinnerb2614752014-08-25 23:20:52 +0200137 except OSError as exc:
Victor Stinner24dfa3c2015-01-26 22:30:28 +0100138 if exc.winerror != _overlapped.ERROR_IO_PENDING:
Victor Stinnerb2614752014-08-25 23:20:52 +0200139 context = {
140 'message': 'Failed to unregister the wait handle',
141 'exception': exc,
142 'future': self,
143 }
144 if self._source_traceback:
145 context['source_traceback'] = self._source_traceback
146 self._loop.call_exception_handler(context)
Victor Stinner24dfa3c2015-01-26 22:30:28 +0100147 return
148 # ERROR_IO_PENDING means that the unregister is pending
149
150 self._unregister_wait_cb(None)
Victor Stinnerfea6a102014-07-25 00:54:53 +0200151
152 def cancel(self):
Victor Stinner313a9802014-07-29 12:58:23 +0200153 self._unregister_wait()
Victor Stinnerd0a28de2015-01-21 23:39:51 +0100154 return super().cancel()
Victor Stinner313a9802014-07-29 12:58:23 +0200155
156 def set_exception(self, exception):
Victor Stinner313a9802014-07-29 12:58:23 +0200157 self._unregister_wait()
Victor Stinnerd0a28de2015-01-21 23:39:51 +0100158 super().set_exception(exception)
Victor Stinner313a9802014-07-29 12:58:23 +0200159
160 def set_result(self, result):
Victor Stinner313a9802014-07-29 12:58:23 +0200161 self._unregister_wait()
Victor Stinnerd0a28de2015-01-21 23:39:51 +0100162 super().set_result(result)
163
164
165class _WaitCancelFuture(_BaseWaitHandleFuture):
166 """Subclass of Future which represents a wait for the cancellation of a
167 _WaitHandleFuture using an event.
168 """
169
170 def __init__(self, ov, event, wait_handle, *, loop=None):
171 super().__init__(ov, event, wait_handle, loop=loop)
172
173 self._done_callback = None
174
Victor Stinner1ca93922015-01-22 00:17:54 +0100175 def cancel(self):
176 raise RuntimeError("_WaitCancelFuture must not be cancelled")
177
INADA Naokia8363622016-10-21 12:30:15 +0900178 def set_result(self, result):
179 super().set_result(result)
180 if self._done_callback is not None:
181 self._done_callback(self)
182
183 def set_exception(self, exception):
184 super().set_exception(exception)
Victor Stinnerd0a28de2015-01-21 23:39:51 +0100185 if self._done_callback is not None:
186 self._done_callback(self)
187
188
189class _WaitHandleFuture(_BaseWaitHandleFuture):
190 def __init__(self, ov, handle, wait_handle, proactor, *, loop=None):
191 super().__init__(ov, handle, wait_handle, loop=loop)
192 self._proactor = proactor
193 self._unregister_proactor = True
194 self._event = _overlapped.CreateEvent(None, True, False, None)
195 self._event_fut = None
196
197 def _unregister_wait_cb(self, fut):
198 if self._event is not None:
199 _winapi.CloseHandle(self._event)
200 self._event = None
201 self._event_fut = None
202
203 # If the wait was cancelled, the wait may never be signalled, so
204 # it's required to unregister it. Otherwise, IocpProactor.close() will
205 # wait forever for an event which will never come.
206 #
207 # If the IocpProactor already received the event, it's safe to call
208 # _unregister() because we kept a reference to the Overlapped object
Martin Panter6245cb32016-04-15 02:14:19 +0000209 # which is used as a unique key.
Victor Stinnerd0a28de2015-01-21 23:39:51 +0100210 self._proactor._unregister(self._ov)
211 self._proactor = None
212
213 super()._unregister_wait_cb(fut)
214
215 def _unregister_wait(self):
216 if not self._registered:
217 return
218 self._registered = False
219
Victor Stinner24dfa3c2015-01-26 22:30:28 +0100220 wait_handle = self._wait_handle
221 self._wait_handle = None
Victor Stinnerd0a28de2015-01-21 23:39:51 +0100222 try:
Victor Stinner24dfa3c2015-01-26 22:30:28 +0100223 _overlapped.UnregisterWaitEx(wait_handle, self._event)
Victor Stinnerd0a28de2015-01-21 23:39:51 +0100224 except OSError as exc:
Victor Stinner24dfa3c2015-01-26 22:30:28 +0100225 if exc.winerror != _overlapped.ERROR_IO_PENDING:
Victor Stinnerd0a28de2015-01-21 23:39:51 +0100226 context = {
227 'message': 'Failed to unregister the wait handle',
228 'exception': exc,
229 'future': self,
230 }
231 if self._source_traceback:
232 context['source_traceback'] = self._source_traceback
233 self._loop.call_exception_handler(context)
Victor Stinner24dfa3c2015-01-26 22:30:28 +0100234 return
235 # ERROR_IO_PENDING is not an error, the wait was unregistered
236
237 self._event_fut = self._proactor._wait_cancel(self._event,
238 self._unregister_wait_cb)
Guido van Rossum90fb9142013-10-30 14:44:05 -0700239
240
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700241class PipeServer(object):
242 """Class representing a pipe server.
243
244 This is much like a bound, listening socket.
245 """
246 def __init__(self, address):
247 self._address = address
248 self._free_instances = weakref.WeakSet()
Victor Stinnerb2614752014-08-25 23:20:52 +0200249 # initialize the pipe attribute before calling _server_pipe_handle()
250 # because this function can raise an exception and the destructor calls
251 # the close() method
252 self._pipe = None
253 self._accept_pipe_future = None
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700254 self._pipe = self._server_pipe_handle(True)
255
256 def _get_unconnected_pipe(self):
257 # Create new instance and return previous one. This ensures
258 # that (until the server is closed) there is always at least
259 # one pipe handle for address. Therefore if a client attempt
260 # to connect it will not fail with FileNotFoundError.
261 tmp, self._pipe = self._pipe, self._server_pipe_handle(False)
262 return tmp
263
264 def _server_pipe_handle(self, first):
265 # Return a wrapper for a new pipe handle.
Victor Stinnera19b7b32015-01-26 15:03:20 +0100266 if self.closed():
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700267 return None
268 flags = _winapi.PIPE_ACCESS_DUPLEX | _winapi.FILE_FLAG_OVERLAPPED
269 if first:
270 flags |= _winapi.FILE_FLAG_FIRST_PIPE_INSTANCE
271 h = _winapi.CreateNamedPipe(
272 self._address, flags,
273 _winapi.PIPE_TYPE_MESSAGE | _winapi.PIPE_READMODE_MESSAGE |
274 _winapi.PIPE_WAIT,
275 _winapi.PIPE_UNLIMITED_INSTANCES,
276 windows_utils.BUFSIZE, windows_utils.BUFSIZE,
277 _winapi.NMPWAIT_WAIT_FOREVER, _winapi.NULL)
278 pipe = windows_utils.PipeHandle(h)
279 self._free_instances.add(pipe)
280 return pipe
281
Victor Stinnera19b7b32015-01-26 15:03:20 +0100282 def closed(self):
283 return (self._address is None)
284
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700285 def close(self):
Victor Stinnerb2614752014-08-25 23:20:52 +0200286 if self._accept_pipe_future is not None:
287 self._accept_pipe_future.cancel()
288 self._accept_pipe_future = None
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700289 # Close all instances which have not been connected to by a client.
290 if self._address is not None:
291 for pipe in self._free_instances:
292 pipe.close()
293 self._pipe = None
294 self._address = None
295 self._free_instances.clear()
296
297 __del__ = close
298
299
Guido van Rossum0eaa5ac2013-11-04 15:50:46 -0800300class _WindowsSelectorEventLoop(selector_events.BaseSelectorEventLoop):
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700301 """Windows version of selector event loop."""
302
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700303
304class ProactorEventLoop(proactor_events.BaseProactorEventLoop):
305 """Windows version of proactor event loop using IOCP."""
306
307 def __init__(self, proactor=None):
308 if proactor is None:
309 proactor = IocpProactor()
310 super().__init__(proactor)
311
Vladimir Matveevb5c8cfa2018-12-18 13:56:17 -0800312 def run_forever(self):
313 try:
314 assert self._self_reading_future is None
315 self.call_soon(self._loop_self_reading)
316 super().run_forever()
317 finally:
318 if self._self_reading_future is not None:
Vladimir Matveev67ba5472019-01-05 12:44:59 -0800319 ov = self._self_reading_future._ov
Vladimir Matveevb5c8cfa2018-12-18 13:56:17 -0800320 self._self_reading_future.cancel()
Vladimir Matveev67ba5472019-01-05 12:44:59 -0800321 # self_reading_future was just cancelled so it will never be signalled
322 # Unregister it otherwise IocpProactor.close will wait for it forever
323 if ov is not None:
324 self._proactor._unregister(ov)
Vladimir Matveevb5c8cfa2018-12-18 13:56:17 -0800325 self._self_reading_future = None
326
Andrew Svetlov5f841b52017-12-09 00:23:48 +0200327 async def create_pipe_connection(self, protocol_factory, address):
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700328 f = self._proactor.connect_pipe(address)
Andrew Svetlov5f841b52017-12-09 00:23:48 +0200329 pipe = await f
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700330 protocol = protocol_factory()
331 trans = self._make_duplex_pipe_transport(pipe, protocol,
332 extra={'addr': address})
333 return trans, protocol
334
Andrew Svetlov5f841b52017-12-09 00:23:48 +0200335 async def start_serving_pipe(self, protocol_factory, address):
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700336 server = PipeServer(address)
Guido van Rossuma8d630a2013-11-01 14:20:55 -0700337
Victor Stinnerb2614752014-08-25 23:20:52 +0200338 def loop_accept_pipe(f=None):
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700339 pipe = None
340 try:
341 if f:
342 pipe = f.result()
343 server._free_instances.discard(pipe)
Victor Stinnera19b7b32015-01-26 15:03:20 +0100344
345 if server.closed():
346 # A client connected before the server was closed:
347 # drop the client (close the pipe) and exit
348 pipe.close()
349 return
350
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700351 protocol = protocol_factory()
352 self._make_duplex_pipe_transport(
353 pipe, protocol, extra={'addr': address})
Victor Stinnera19b7b32015-01-26 15:03:20 +0100354
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700355 pipe = server._get_unconnected_pipe()
356 if pipe is None:
357 return
Victor Stinnera19b7b32015-01-26 15:03:20 +0100358
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700359 f = self._proactor.accept_pipe(pipe)
Yury Selivanovff827f02014-02-18 18:02:19 -0500360 except OSError as exc:
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700361 if pipe and pipe.fileno() != -1:
Yury Selivanovff827f02014-02-18 18:02:19 -0500362 self.call_exception_handler({
363 'message': 'Pipe accept failed',
364 'exception': exc,
365 'pipe': pipe,
366 })
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700367 pipe.close()
Victor Stinnerb2614752014-08-25 23:20:52 +0200368 elif self._debug:
369 logger.warning("Accept pipe failed on pipe %r",
370 pipe, exc_info=True)
Andrew Svetlov0baa72f2018-09-11 10:13:04 -0700371 except exceptions.CancelledError:
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700372 if pipe:
373 pipe.close()
374 else:
Victor Stinnerb2614752014-08-25 23:20:52 +0200375 server._accept_pipe_future = f
376 f.add_done_callback(loop_accept_pipe)
Guido van Rossuma8d630a2013-11-01 14:20:55 -0700377
Victor Stinnerb2614752014-08-25 23:20:52 +0200378 self.call_soon(loop_accept_pipe)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700379 return [server]
380
Andrew Svetlov5f841b52017-12-09 00:23:48 +0200381 async def _make_subprocess_transport(self, protocol, args, shell,
382 stdin, stdout, stderr, bufsize,
383 extra=None, **kwargs):
Yury Selivanov7661db62016-05-16 15:38:39 -0400384 waiter = self.create_future()
Guido van Rossum59691282013-10-30 14:52:03 -0700385 transp = _WindowsSubprocessTransport(self, protocol, args, shell,
386 stdin, stdout, stderr, bufsize,
Victor Stinner47cd10d2015-01-30 00:05:19 +0100387 waiter=waiter, extra=extra,
388 **kwargs)
Victor Stinner4bf22e02015-01-15 14:24:22 +0100389 try:
Andrew Svetlov5f841b52017-12-09 00:23:48 +0200390 await waiter
391 except Exception:
Victor Stinner4bf22e02015-01-15 14:24:22 +0100392 transp.close()
Andrew Svetlov5f841b52017-12-09 00:23:48 +0200393 await transp._wait()
394 raise
Victor Stinner4bf22e02015-01-15 14:24:22 +0100395
Guido van Rossum59691282013-10-30 14:52:03 -0700396 return transp
397
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700398
399class IocpProactor:
400 """Proactor implementation using IOCP."""
401
402 def __init__(self, concurrency=0xffffffff):
403 self._loop = None
404 self._results = []
405 self._iocp = _overlapped.CreateIoCompletionPort(
406 _overlapped.INVALID_HANDLE_VALUE, NULL, 0, concurrency)
407 self._cache = {}
408 self._registered = weakref.WeakSet()
Victor Stinnerd0a28de2015-01-21 23:39:51 +0100409 self._unregistered = []
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700410 self._stopped_serving = weakref.WeakSet()
411
Victor Stinner9b076812019-01-10 11:23:26 +0100412 def _check_closed(self):
413 if self._iocp is None:
414 raise RuntimeError('IocpProactor is closed')
415
Victor Stinnerfea6a102014-07-25 00:54:53 +0200416 def __repr__(self):
Victor Stinner9b076812019-01-10 11:23:26 +0100417 info = ['overlapped#=%s' % len(self._cache),
418 'result#=%s' % len(self._results)]
419 if self._iocp is None:
420 info.append('closed')
421 return '<%s %s>' % (self.__class__.__name__, " ".join(info))
Victor Stinnerfea6a102014-07-25 00:54:53 +0200422
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700423 def set_loop(self, loop):
424 self._loop = loop
425
426 def select(self, timeout=None):
427 if not self._results:
428 self._poll(timeout)
429 tmp = self._results
430 self._results = []
431 return tmp
432
Victor Stinner41063d22015-01-26 22:30:49 +0100433 def _result(self, value):
Yury Selivanov7661db62016-05-16 15:38:39 -0400434 fut = self._loop.create_future()
Victor Stinner41063d22015-01-26 22:30:49 +0100435 fut.set_result(value)
436 return fut
437
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700438 def recv(self, conn, nbytes, flags=0):
439 self._register_with_iocp(conn)
440 ov = _overlapped.Overlapped(NULL)
Victor Stinner41063d22015-01-26 22:30:49 +0100441 try:
442 if isinstance(conn, socket.socket):
443 ov.WSARecv(conn.fileno(), nbytes, flags)
444 else:
445 ov.ReadFile(conn.fileno(), nbytes)
446 except BrokenPipeError:
447 return self._result(b'')
Guido van Rossuma8d630a2013-11-01 14:20:55 -0700448
Victor Stinnerc89c8a72014-02-26 17:35:30 +0100449 def finish_recv(trans, key, ov):
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700450 try:
451 return ov.getresult()
452 except OSError as exc:
Andrew Svetlov7c684072018-01-27 21:22:47 +0200453 if exc.winerror in (_overlapped.ERROR_NETNAME_DELETED,
454 _overlapped.ERROR_OPERATION_ABORTED):
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700455 raise ConnectionResetError(*exc.args)
456 else:
457 raise
Guido van Rossuma8d630a2013-11-01 14:20:55 -0700458
Victor Stinnerc89c8a72014-02-26 17:35:30 +0100459 return self._register(ov, conn, finish_recv)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700460
Antoine Pitrou525f40d2017-10-19 21:46:40 +0200461 def recv_into(self, conn, buf, flags=0):
462 self._register_with_iocp(conn)
463 ov = _overlapped.Overlapped(NULL)
464 try:
465 if isinstance(conn, socket.socket):
466 ov.WSARecvInto(conn.fileno(), buf, flags)
467 else:
468 ov.ReadFileInto(conn.fileno(), buf)
469 except BrokenPipeError:
470 return self._result(b'')
471
472 def finish_recv(trans, key, ov):
473 try:
474 return ov.getresult()
475 except OSError as exc:
Andrew Svetlov7c684072018-01-27 21:22:47 +0200476 if exc.winerror in (_overlapped.ERROR_NETNAME_DELETED,
477 _overlapped.ERROR_OPERATION_ABORTED):
Antoine Pitrou525f40d2017-10-19 21:46:40 +0200478 raise ConnectionResetError(*exc.args)
479 else:
480 raise
481
482 return self._register(ov, conn, finish_recv)
483
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700484 def send(self, conn, buf, flags=0):
485 self._register_with_iocp(conn)
486 ov = _overlapped.Overlapped(NULL)
487 if isinstance(conn, socket.socket):
488 ov.WSASend(conn.fileno(), buf, flags)
489 else:
490 ov.WriteFile(conn.fileno(), buf)
Guido van Rossuma8d630a2013-11-01 14:20:55 -0700491
Victor Stinnerc89c8a72014-02-26 17:35:30 +0100492 def finish_send(trans, key, ov):
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700493 try:
494 return ov.getresult()
495 except OSError as exc:
Andrew Svetlov7c684072018-01-27 21:22:47 +0200496 if exc.winerror in (_overlapped.ERROR_NETNAME_DELETED,
497 _overlapped.ERROR_OPERATION_ABORTED):
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700498 raise ConnectionResetError(*exc.args)
499 else:
500 raise
Guido van Rossuma8d630a2013-11-01 14:20:55 -0700501
Victor Stinnerc89c8a72014-02-26 17:35:30 +0100502 return self._register(ov, conn, finish_send)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700503
504 def accept(self, listener):
505 self._register_with_iocp(listener)
506 conn = self._get_accept_socket(listener.family)
507 ov = _overlapped.Overlapped(NULL)
508 ov.AcceptEx(listener.fileno(), conn.fileno())
Guido van Rossuma8d630a2013-11-01 14:20:55 -0700509
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700510 def finish_accept(trans, key, ov):
511 ov.getresult()
512 # Use SO_UPDATE_ACCEPT_CONTEXT so getsockname() etc work.
513 buf = struct.pack('@P', listener.fileno())
514 conn.setsockopt(socket.SOL_SOCKET,
515 _overlapped.SO_UPDATE_ACCEPT_CONTEXT, buf)
516 conn.settimeout(listener.gettimeout())
517 return conn, conn.getpeername()
Guido van Rossuma8d630a2013-11-01 14:20:55 -0700518
Andrew Svetlov5f841b52017-12-09 00:23:48 +0200519 async def accept_coro(future, conn):
Victor Stinner7de26462014-01-11 00:03:21 +0100520 # Coroutine closing the accept socket if the future is cancelled
521 try:
Andrew Svetlov5f841b52017-12-09 00:23:48 +0200522 await future
Andrew Svetlov0baa72f2018-09-11 10:13:04 -0700523 except exceptions.CancelledError:
Victor Stinner7de26462014-01-11 00:03:21 +0100524 conn.close()
525 raise
526
527 future = self._register(ov, listener, finish_accept)
528 coro = accept_coro(future, conn)
Yury Selivanov59eb9a42015-05-11 14:48:38 -0400529 tasks.ensure_future(coro, loop=self._loop)
Victor Stinner7de26462014-01-11 00:03:21 +0100530 return future
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700531
532 def connect(self, conn, address):
533 self._register_with_iocp(conn)
534 # The socket needs to be locally bound before we call ConnectEx().
535 try:
536 _overlapped.BindLocal(conn.fileno(), conn.family)
537 except OSError as e:
538 if e.winerror != errno.WSAEINVAL:
539 raise
540 # Probably already locally bound; check using getsockname().
541 if conn.getsockname()[1] == 0:
542 raise
543 ov = _overlapped.Overlapped(NULL)
544 ov.ConnectEx(conn.fileno(), address)
Guido van Rossuma8d630a2013-11-01 14:20:55 -0700545
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700546 def finish_connect(trans, key, ov):
547 ov.getresult()
548 # Use SO_UPDATE_CONNECT_CONTEXT so getsockname() etc work.
549 conn.setsockopt(socket.SOL_SOCKET,
550 _overlapped.SO_UPDATE_CONNECT_CONTEXT, 0)
551 return conn
Guido van Rossuma8d630a2013-11-01 14:20:55 -0700552
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700553 return self._register(ov, conn, finish_connect)
554
Andrew Svetlova19fb3c2018-02-25 19:32:14 +0300555 def sendfile(self, sock, file, offset, count):
556 self._register_with_iocp(sock)
557 ov = _overlapped.Overlapped(NULL)
558 offset_low = offset & 0xffff_ffff
559 offset_high = (offset >> 32) & 0xffff_ffff
560 ov.TransmitFile(sock.fileno(),
561 msvcrt.get_osfhandle(file.fileno()),
562 offset_low, offset_high,
563 count, 0, 0)
564
565 def finish_sendfile(trans, key, ov):
566 try:
567 return ov.getresult()
568 except OSError as exc:
569 if exc.winerror in (_overlapped.ERROR_NETNAME_DELETED,
570 _overlapped.ERROR_OPERATION_ABORTED):
571 raise ConnectionResetError(*exc.args)
572 else:
573 raise
574 return self._register(ov, sock, finish_sendfile)
575
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700576 def accept_pipe(self, pipe):
577 self._register_with_iocp(pipe)
578 ov = _overlapped.Overlapped(NULL)
Victor Stinner2b77c542015-01-22 23:50:03 +0100579 connected = ov.ConnectNamedPipe(pipe.fileno())
580
581 if connected:
582 # ConnectNamePipe() failed with ERROR_PIPE_CONNECTED which means
583 # that the pipe is connected. There is no need to wait for the
584 # completion of the connection.
Victor Stinner41063d22015-01-26 22:30:49 +0100585 return self._result(pipe)
Guido van Rossuma8d630a2013-11-01 14:20:55 -0700586
Victor Stinnerc89c8a72014-02-26 17:35:30 +0100587 def finish_accept_pipe(trans, key, ov):
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700588 ov.getresult()
589 return pipe
Guido van Rossuma8d630a2013-11-01 14:20:55 -0700590
Victor Stinner2b77c542015-01-22 23:50:03 +0100591 return self._register(ov, pipe, finish_accept_pipe)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700592
Andrew Svetlov5f841b52017-12-09 00:23:48 +0200593 async def connect_pipe(self, address):
Victor Stinnere0fd1572015-01-26 15:04:03 +0100594 delay = CONNECT_PIPE_INIT_DELAY
595 while True:
Yury Selivanov6370f342017-12-10 18:36:12 -0500596 # Unfortunately there is no way to do an overlapped connect to
597 # a pipe. Call CreateFile() in a loop until it doesn't fail with
598 # ERROR_PIPE_BUSY.
Victor Stinnere0fd1572015-01-26 15:04:03 +0100599 try:
600 handle = _overlapped.ConnectPipe(address)
601 break
602 except OSError as exc:
603 if exc.winerror != _overlapped.ERROR_PIPE_BUSY:
604 raise
605
606 # ConnectPipe() failed with ERROR_PIPE_BUSY: retry later
607 delay = min(delay * 2, CONNECT_PIPE_MAX_DELAY)
Andrew Svetlov5f841b52017-12-09 00:23:48 +0200608 await tasks.sleep(delay, loop=self._loop)
Victor Stinnere0fd1572015-01-26 15:04:03 +0100609
610 return windows_utils.PipeHandle(handle)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700611
Guido van Rossum90fb9142013-10-30 14:44:05 -0700612 def wait_for_handle(self, handle, timeout=None):
Victor Stinner4d825b42014-12-19 17:10:44 +0100613 """Wait for a handle.
614
615 Return a Future object. The result of the future is True if the wait
616 completed, or False if the wait did not complete (on timeout).
617 """
Victor Stinnerd0a28de2015-01-21 23:39:51 +0100618 return self._wait_for_handle(handle, timeout, False)
619
620 def _wait_cancel(self, event, done_callback):
621 fut = self._wait_for_handle(event, None, True)
622 # add_done_callback() cannot be used because the wait may only complete
623 # in IocpProactor.close(), while the event loop is not running.
624 fut._done_callback = done_callback
625 return fut
626
627 def _wait_for_handle(self, handle, timeout, _is_cancel):
Victor Stinner9b076812019-01-10 11:23:26 +0100628 self._check_closed()
629
Guido van Rossum90fb9142013-10-30 14:44:05 -0700630 if timeout is None:
631 ms = _winapi.INFINITE
632 else:
Victor Stinnerf2e17682014-01-31 16:25:24 +0100633 # RegisterWaitForSingleObject() has a resolution of 1 millisecond,
634 # round away from zero to wait *at least* timeout seconds.
635 ms = math.ceil(timeout * 1e3)
Guido van Rossum90fb9142013-10-30 14:44:05 -0700636
637 # We only create ov so we can use ov.address as a key for the cache.
638 ov = _overlapped.Overlapped(NULL)
Victor Stinnerd0a28de2015-01-21 23:39:51 +0100639 wait_handle = _overlapped.RegisterWaitWithQueue(
Guido van Rossum90fb9142013-10-30 14:44:05 -0700640 handle, self._iocp, ov.address, ms)
Victor Stinnerd0a28de2015-01-21 23:39:51 +0100641 if _is_cancel:
642 f = _WaitCancelFuture(ov, handle, wait_handle, loop=self._loop)
643 else:
644 f = _WaitHandleFuture(ov, handle, wait_handle, self,
645 loop=self._loop)
Victor Stinner313a9802014-07-29 12:58:23 +0200646 if f._source_traceback:
647 del f._source_traceback[-1]
Guido van Rossum90fb9142013-10-30 14:44:05 -0700648
Victor Stinnerc89c8a72014-02-26 17:35:30 +0100649 def finish_wait_for_handle(trans, key, ov):
Richard Oudkerk71196e72013-11-24 17:50:40 +0000650 # Note that this second wait means that we should only use
651 # this with handles types where a successful wait has no
652 # effect. So events or processes are all right, but locks
653 # or semaphores are not. Also note if the handle is
654 # signalled and then quickly reset, then we may return
655 # False even though we have not timed out.
Victor Stinner313a9802014-07-29 12:58:23 +0200656 return f._poll()
Guido van Rossum90fb9142013-10-30 14:44:05 -0700657
Victor Stinner313a9802014-07-29 12:58:23 +0200658 self._cache[ov.address] = (f, ov, 0, finish_wait_for_handle)
Guido van Rossum90fb9142013-10-30 14:44:05 -0700659 return f
660
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700661 def _register_with_iocp(self, obj):
662 # To get notifications of finished ops on this objects sent to the
663 # completion port, were must register the handle.
664 if obj not in self._registered:
665 self._registered.add(obj)
666 _overlapped.CreateIoCompletionPort(obj.fileno(), self._iocp, 0, 0)
667 # XXX We could also use SetFileCompletionNotificationModes()
668 # to avoid sending notifications to completion port of ops
669 # that succeed immediately.
670
Victor Stinner2b77c542015-01-22 23:50:03 +0100671 def _register(self, ov, obj, callback):
Victor Stinner9b076812019-01-10 11:23:26 +0100672 self._check_closed()
673
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700674 # Return a future which will be set with the result of the
675 # operation when it completes. The future's value is actually
676 # the value returned by callback().
677 f = _OverlappedFuture(ov, loop=self._loop)
Victor Stinner313a9802014-07-29 12:58:23 +0200678 if f._source_traceback:
679 del f._source_traceback[-1]
Victor Stinner2b77c542015-01-22 23:50:03 +0100680 if not ov.pending:
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700681 # The operation has completed, so no need to postpone the
682 # work. We cannot take this short cut if we need the
683 # NumberOfBytes, CompletionKey values returned by
684 # PostQueuedCompletionStatus().
685 try:
686 value = callback(None, None, ov)
687 except OSError as e:
688 f.set_exception(e)
689 else:
690 f.set_result(value)
Victor Stinner42d3bde2014-07-28 00:18:43 +0200691 # Even if GetOverlappedResult() was called, we have to wait for the
692 # notification of the completion in GetQueuedCompletionStatus().
693 # Register the overlapped operation to keep a reference to the
694 # OVERLAPPED object, otherwise the memory is freed and Windows may
695 # read uninitialized memory.
Victor Stinner2b77c542015-01-22 23:50:03 +0100696
697 # Register the overlapped operation for later. Note that
698 # we only store obj to prevent it from being garbage
699 # collected too early.
700 self._cache[ov.address] = (f, ov, obj, callback)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700701 return f
702
Victor Stinnerd0a28de2015-01-21 23:39:51 +0100703 def _unregister(self, ov):
704 """Unregister an overlapped object.
705
706 Call this method when its future has been cancelled. The event can
707 already be signalled (pending in the proactor event queue). It is also
708 safe if the event is never signalled (because it was cancelled).
709 """
Victor Stinner9b076812019-01-10 11:23:26 +0100710 self._check_closed()
Victor Stinnerd0a28de2015-01-21 23:39:51 +0100711 self._unregistered.append(ov)
712
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700713 def _get_accept_socket(self, family):
714 s = socket.socket(family)
715 s.settimeout(0)
716 return s
717
718 def _poll(self, timeout=None):
719 if timeout is None:
720 ms = INFINITE
721 elif timeout < 0:
722 raise ValueError("negative timeout")
723 else:
Victor Stinnerf2e17682014-01-31 16:25:24 +0100724 # GetQueuedCompletionStatus() has a resolution of 1 millisecond,
725 # round away from zero to wait *at least* timeout seconds.
726 ms = math.ceil(timeout * 1e3)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700727 if ms >= INFINITE:
728 raise ValueError("timeout too big")
Victor Stinner313a9802014-07-29 12:58:23 +0200729
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700730 while True:
731 status = _overlapped.GetQueuedCompletionStatus(self._iocp, ms)
732 if status is None:
Victor Stinnerd0a28de2015-01-21 23:39:51 +0100733 break
Victor Stinner313a9802014-07-29 12:58:23 +0200734 ms = 0
735
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700736 err, transferred, key, address = status
737 try:
738 f, ov, obj, callback = self._cache.pop(address)
739 except KeyError:
Victor Stinner42d3bde2014-07-28 00:18:43 +0200740 if self._loop.get_debug():
741 self._loop.call_exception_handler({
742 'message': ('GetQueuedCompletionStatus() returned an '
743 'unexpected event'),
744 'status': ('err=%s transferred=%s key=%#x address=%#x'
745 % (err, transferred, key, address)),
746 })
747
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700748 # key is either zero, or it is used to return a pipe
749 # handle which should be closed to avoid a leak.
750 if key not in (0, _overlapped.INVALID_HANDLE_VALUE):
751 _winapi.CloseHandle(key)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700752 continue
Victor Stinner51e44ea2014-07-26 00:58:34 +0200753
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700754 if obj in self._stopped_serving:
755 f.cancel()
Victor Stinner42d3bde2014-07-28 00:18:43 +0200756 # Don't call the callback if _register() already read the result or
757 # if the overlapped has been cancelled
758 elif not f.done():
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700759 try:
760 value = callback(transferred, key, ov)
761 except OSError as e:
762 f.set_exception(e)
763 self._results.append(f)
764 else:
765 f.set_result(value)
766 self._results.append(f)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700767
Andrew Svetlov7a6706b2017-12-13 17:50:16 +0200768 # Remove unregistered futures
Victor Stinnerd0a28de2015-01-21 23:39:51 +0100769 for ov in self._unregistered:
770 self._cache.pop(ov.address, None)
771 self._unregistered.clear()
772
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700773 def _stop_serving(self, obj):
774 # obj is a socket or pipe handle. It will be closed in
775 # BaseProactorEventLoop._stop_serving() which will make any
776 # pending operations fail quickly.
777 self._stopped_serving.add(obj)
778
779 def close(self):
Victor Stinner9b076812019-01-10 11:23:26 +0100780 if self._iocp is None:
781 # already closed
782 return
783
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700784 # Cancel remaining registered operations.
Victor Stinnerfea6a102014-07-25 00:54:53 +0200785 for address, (fut, ov, obj, callback) in list(self._cache.items()):
Victor Stinner3d2256f2015-01-26 11:02:59 +0100786 if fut.cancelled():
Victor Stinner752aba72015-01-22 22:47:13 +0100787 # Nothing to do with cancelled futures
788 pass
Victor Stinner1ca93922015-01-22 00:17:54 +0100789 elif isinstance(fut, _WaitCancelFuture):
790 # _WaitCancelFuture must not be cancelled
791 pass
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700792 else:
793 try:
Victor Stinnerfea6a102014-07-25 00:54:53 +0200794 fut.cancel()
795 except OSError as exc:
796 if self._loop is not None:
797 context = {
798 'message': 'Cancelling a future failed',
799 'exception': exc,
800 'future': fut,
801 }
802 if fut._source_traceback:
803 context['source_traceback'] = fut._source_traceback
804 self._loop.call_exception_handler(context)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700805
Victor Stinnerb1e45732019-01-15 11:48:00 +0100806 # Wait until all cancelled overlapped complete: don't exit with running
807 # overlapped to prevent a crash. Display progress every second if the
808 # loop is still running.
809 msg_update = 1.0
810 start_time = time.monotonic()
811 next_msg = start_time + msg_update
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700812 while self._cache:
Victor Stinnerb1e45732019-01-15 11:48:00 +0100813 if next_msg <= time.monotonic():
Victor Stinnerb91140f2019-01-15 12:13:48 +0100814 logger.debug('%r is running after closing for %.1f seconds',
815 self, time.monotonic() - start_time)
Victor Stinnerb1e45732019-01-15 11:48:00 +0100816 next_msg = time.monotonic() + msg_update
817
818 # handle a few events, or timeout
819 self._poll(msg_update)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700820
821 self._results = []
Victor Stinner9b076812019-01-10 11:23:26 +0100822
823 _winapi.CloseHandle(self._iocp)
824 self._iocp = None
Guido van Rossum59691282013-10-30 14:52:03 -0700825
Victor Stinnerfea6a102014-07-25 00:54:53 +0200826 def __del__(self):
827 self.close()
828
Guido van Rossum59691282013-10-30 14:52:03 -0700829
830class _WindowsSubprocessTransport(base_subprocess.BaseSubprocessTransport):
831
832 def _start(self, args, shell, stdin, stdout, stderr, bufsize, **kwargs):
833 self._proc = windows_utils.Popen(
834 args, shell=shell, stdin=stdin, stdout=stdout, stderr=stderr,
835 bufsize=bufsize, **kwargs)
Guido van Rossuma8d630a2013-11-01 14:20:55 -0700836
Guido van Rossum59691282013-10-30 14:52:03 -0700837 def callback(f):
838 returncode = self._proc.poll()
839 self._process_exited(returncode)
Guido van Rossuma8d630a2013-11-01 14:20:55 -0700840
Guido van Rossum59691282013-10-30 14:52:03 -0700841 f = self._loop._proactor.wait_for_handle(int(self._proc._handle))
842 f.add_done_callback(callback)
Guido van Rossum0eaa5ac2013-11-04 15:50:46 -0800843
844
845SelectorEventLoop = _WindowsSelectorEventLoop
846
847
Yury Selivanov8f404292018-06-07 20:44:57 -0400848class WindowsSelectorEventLoopPolicy(events.BaseDefaultEventLoopPolicy):
Guido van Rossum0eaa5ac2013-11-04 15:50:46 -0800849 _loop_factory = SelectorEventLoop
850
851
Yury Selivanov8f404292018-06-07 20:44:57 -0400852class WindowsProactorEventLoopPolicy(events.BaseDefaultEventLoopPolicy):
853 _loop_factory = ProactorEventLoop
854
855
Victor Stinner6ea29c52018-09-25 08:27:08 -0700856DefaultEventLoopPolicy = WindowsProactorEventLoopPolicy