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