blob: 2bf443531b64d3704eb7c7b7ec075d10e10880f6 [file] [log] [blame]
Benjamin Petersone711caf2008-06-11 16:44:04 +00001#
2# A higher level module for using sockets (or Windows named pipes)
3#
4# multiprocessing/connection.py
5#
R. David Murray3fc969a2010-12-14 01:38:16 +00006# Copyright (c) 2006-2008, R Oudkerk
Richard Oudkerk3e268aa2012-04-30 12:13:55 +01007# Licensed to PSF under a Contributor Agreement.
Benjamin Petersone711caf2008-06-11 16:44:04 +00008#
9
Antoine Pitroubdb1cf12012-03-05 19:28:37 +010010__all__ = [ 'Client', 'Listener', 'Pipe', 'wait' ]
Benjamin Petersone711caf2008-06-11 16:44:04 +000011
Antoine Pitrou87cf2202011-05-09 17:04:27 +020012import io
Benjamin Petersone711caf2008-06-11 16:44:04 +000013import os
14import sys
15import socket
Antoine Pitrou87cf2202011-05-09 17:04:27 +020016import struct
Benjamin Petersone711caf2008-06-11 16:44:04 +000017import time
18import tempfile
19import itertools
20
21import _multiprocessing
Richard Oudkerk84ed9a62013-08-14 15:35:41 +010022
23from . import reduction
24from . import util
25
26from . import AuthenticationError, BufferTooShort
27from .reduction import ForkingPickler
28
Antoine Pitrou87cf2202011-05-09 17:04:27 +020029try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +020030 import _winapi
Victor Stinner69b1e262014-03-20 08:50:52 +010031 from _winapi import WAIT_OBJECT_0, WAIT_ABANDONED_0, WAIT_TIMEOUT, INFINITE
Brett Cannoncd171c82013-07-04 17:43:24 -040032except ImportError:
Antoine Pitrou87cf2202011-05-09 17:04:27 +020033 if sys.platform == 'win32':
34 raise
Antoine Pitrou23bba4c2012-04-18 20:51:15 +020035 _winapi = None
Benjamin Petersone711caf2008-06-11 16:44:04 +000036
37#
38#
39#
40
41BUFSIZE = 8192
Antoine Pitrou45d61a32009-11-13 22:35:18 +000042# A very generous timeout when it comes to local connections...
43CONNECTION_TIMEOUT = 20.
Benjamin Petersone711caf2008-06-11 16:44:04 +000044
45_mmap_counter = itertools.count()
46
47default_family = 'AF_INET'
48families = ['AF_INET']
49
50if hasattr(socket, 'AF_UNIX'):
51 default_family = 'AF_UNIX'
52 families += ['AF_UNIX']
53
54if sys.platform == 'win32':
55 default_family = 'AF_PIPE'
56 families += ['AF_PIPE']
57
Antoine Pitrou45d61a32009-11-13 22:35:18 +000058
59def _init_timeout(timeout=CONNECTION_TIMEOUT):
60 return time.time() + timeout
61
62def _check_timeout(t):
63 return time.time() > t
64
Benjamin Petersone711caf2008-06-11 16:44:04 +000065#
66#
67#
68
69def arbitrary_address(family):
70 '''
71 Return an arbitrary free address for the given family
72 '''
73 if family == 'AF_INET':
74 return ('localhost', 0)
75 elif family == 'AF_UNIX':
Richard Oudkerk84ed9a62013-08-14 15:35:41 +010076 return tempfile.mktemp(prefix='listener-', dir=util.get_temp_dir())
Benjamin Petersone711caf2008-06-11 16:44:04 +000077 elif family == 'AF_PIPE':
78 return tempfile.mktemp(prefix=r'\\.\pipe\pyc-%d-%d-' %
Benjamin Peterson40470e02014-04-14 12:24:37 -040079 (os.getpid(), next(_mmap_counter)), dir="")
Benjamin Petersone711caf2008-06-11 16:44:04 +000080 else:
81 raise ValueError('unrecognized family')
82
Antoine Pitrou709176f2012-04-01 17:19:09 +020083def _validate_family(family):
84 '''
85 Checks if the family is valid for the current environment.
86 '''
87 if sys.platform != 'win32' and family == 'AF_PIPE':
88 raise ValueError('Family %s is not recognized.' % family)
89
Antoine Pitrou6d20cba2012-04-03 20:12:23 +020090 if sys.platform == 'win32' and family == 'AF_UNIX':
91 # double check
92 if not hasattr(socket, family):
93 raise ValueError('Family %s is not recognized.' % family)
Benjamin Petersone711caf2008-06-11 16:44:04 +000094
95def address_type(address):
96 '''
97 Return the types of the address
98
99 This can be 'AF_INET', 'AF_UNIX', or 'AF_PIPE'
100 '''
101 if type(address) == tuple:
102 return 'AF_INET'
103 elif type(address) is str and address.startswith('\\\\'):
104 return 'AF_PIPE'
105 elif type(address) is str:
106 return 'AF_UNIX'
107 else:
108 raise ValueError('address type of %r unrecognized' % address)
109
110#
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200111# Connection classes
112#
113
114class _ConnectionBase:
115 _handle = None
116
117 def __init__(self, handle, readable=True, writable=True):
118 handle = handle.__index__()
119 if handle < 0:
120 raise ValueError("invalid handle")
121 if not readable and not writable:
122 raise ValueError(
123 "at least one of `readable` and `writable` must be True")
124 self._handle = handle
125 self._readable = readable
126 self._writable = writable
127
Antoine Pitrou60001202011-07-09 01:03:46 +0200128 # XXX should we use util.Finalize instead of a __del__?
129
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200130 def __del__(self):
131 if self._handle is not None:
132 self._close()
133
134 def _check_closed(self):
135 if self._handle is None:
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200136 raise OSError("handle is closed")
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200137
138 def _check_readable(self):
139 if not self._readable:
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200140 raise OSError("connection is write-only")
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200141
142 def _check_writable(self):
143 if not self._writable:
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200144 raise OSError("connection is read-only")
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200145
146 def _bad_message_length(self):
147 if self._writable:
148 self._readable = False
149 else:
150 self.close()
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200151 raise OSError("bad message length")
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200152
153 @property
154 def closed(self):
155 """True if the connection is closed"""
156 return self._handle is None
157
158 @property
159 def readable(self):
160 """True if the connection is readable"""
161 return self._readable
162
163 @property
164 def writable(self):
165 """True if the connection is writable"""
166 return self._writable
167
168 def fileno(self):
169 """File descriptor or handle of the connection"""
170 self._check_closed()
171 return self._handle
172
173 def close(self):
174 """Close the connection"""
175 if self._handle is not None:
176 try:
177 self._close()
178 finally:
179 self._handle = None
180
181 def send_bytes(self, buf, offset=0, size=None):
182 """Send the bytes data from a bytes-like object"""
183 self._check_closed()
184 self._check_writable()
185 m = memoryview(buf)
186 # HACK for byte-indexing of non-bytewise buffers (e.g. array.array)
187 if m.itemsize > 1:
188 m = memoryview(bytes(m))
189 n = len(m)
190 if offset < 0:
191 raise ValueError("offset is negative")
192 if n < offset:
193 raise ValueError("buffer length < offset")
194 if size is None:
195 size = n - offset
196 elif size < 0:
197 raise ValueError("size is negative")
198 elif offset + size > n:
199 raise ValueError("buffer length < offset + size")
200 self._send_bytes(m[offset:offset + size])
201
202 def send(self, obj):
203 """Send a (picklable) object"""
204 self._check_closed()
205 self._check_writable()
Charles-François Natalia6550752013-03-24 15:21:49 +0100206 self._send_bytes(ForkingPickler.dumps(obj))
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200207
208 def recv_bytes(self, maxlength=None):
209 """
210 Receive bytes data as a bytes object.
211 """
212 self._check_closed()
213 self._check_readable()
214 if maxlength is not None and maxlength < 0:
215 raise ValueError("negative maxlength")
216 buf = self._recv_bytes(maxlength)
217 if buf is None:
218 self._bad_message_length()
219 return buf.getvalue()
220
221 def recv_bytes_into(self, buf, offset=0):
222 """
223 Receive bytes data into a writeable buffer-like object.
224 Return the number of bytes read.
225 """
226 self._check_closed()
227 self._check_readable()
228 with memoryview(buf) as m:
229 # Get bytesize of arbitrary buffer
230 itemsize = m.itemsize
231 bytesize = itemsize * len(m)
232 if offset < 0:
233 raise ValueError("negative offset")
234 elif offset > bytesize:
235 raise ValueError("offset too large")
236 result = self._recv_bytes()
237 size = result.tell()
238 if bytesize < offset + size:
239 raise BufferTooShort(result.getvalue())
240 # Message can fit in dest
241 result.seek(0)
242 result.readinto(m[offset // itemsize :
243 (offset + size) // itemsize])
244 return size
245
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100246 def recv(self):
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200247 """Receive a (picklable) object"""
248 self._check_closed()
249 self._check_readable()
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100250 buf = self._recv_bytes()
Charles-François Natalia6550752013-03-24 15:21:49 +0100251 return ForkingPickler.loads(buf.getbuffer())
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200252
253 def poll(self, timeout=0.0):
254 """Whether there is any input available to be read"""
255 self._check_closed()
256 self._check_readable()
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200257 return self._poll(timeout)
258
Richard Oudkerkd69cfe82012-06-18 17:47:52 +0100259 def __enter__(self):
260 return self
261
262 def __exit__(self, exc_type, exc_value, exc_tb):
263 self.close()
264
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200265
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200266if _winapi:
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200267
268 class PipeConnection(_ConnectionBase):
269 """
270 Connection class based on a Windows named pipe.
Antoine Pitroudd696492011-06-08 17:21:55 +0200271 Overlapped I/O is used, so the handles must have been created
272 with FILE_FLAG_OVERLAPPED.
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200273 """
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100274 _got_empty_message = False
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200275
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200276 def _close(self, _CloseHandle=_winapi.CloseHandle):
Antoine Pitrou71a28a92011-07-09 01:03:00 +0200277 _CloseHandle(self._handle)
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200278
279 def _send_bytes(self, buf):
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200280 ov, err = _winapi.WriteFile(self._handle, buf, overlapped=True)
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100281 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200282 if err == _winapi.ERROR_IO_PENDING:
283 waitres = _winapi.WaitForMultipleObjects(
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100284 [ov.event], False, INFINITE)
285 assert waitres == WAIT_OBJECT_0
286 except:
287 ov.cancel()
288 raise
289 finally:
290 nwritten, err = ov.GetOverlappedResult(True)
291 assert err == 0
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200292 assert nwritten == len(buf)
293
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100294 def _recv_bytes(self, maxsize=None):
295 if self._got_empty_message:
296 self._got_empty_message = False
297 return io.BytesIO()
Antoine Pitroudd696492011-06-08 17:21:55 +0200298 else:
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100299 bsize = 128 if maxsize is None else min(maxsize, 128)
Antoine Pitroudd696492011-06-08 17:21:55 +0200300 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200301 ov, err = _winapi.ReadFile(self._handle, bsize,
302 overlapped=True)
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100303 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200304 if err == _winapi.ERROR_IO_PENDING:
305 waitres = _winapi.WaitForMultipleObjects(
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100306 [ov.event], False, INFINITE)
307 assert waitres == WAIT_OBJECT_0
308 except:
309 ov.cancel()
310 raise
311 finally:
312 nread, err = ov.GetOverlappedResult(True)
313 if err == 0:
314 f = io.BytesIO()
315 f.write(ov.getbuffer())
316 return f
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200317 elif err == _winapi.ERROR_MORE_DATA:
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100318 return self._get_more_data(ov, maxsize)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200319 except OSError as e:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200320 if e.winerror == _winapi.ERROR_BROKEN_PIPE:
Antoine Pitroudd696492011-06-08 17:21:55 +0200321 raise EOFError
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100322 else:
323 raise
324 raise RuntimeError("shouldn't get here; expected KeyboardInterrupt")
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200325
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100326 def _poll(self, timeout):
327 if (self._got_empty_message or
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200328 _winapi.PeekNamedPipe(self._handle)[0] != 0):
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200329 return True
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100330 return bool(wait([self], timeout))
331
332 def _get_more_data(self, ov, maxsize):
333 buf = ov.getbuffer()
334 f = io.BytesIO()
335 f.write(buf)
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200336 left = _winapi.PeekNamedPipe(self._handle)[1]
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100337 assert left > 0
338 if maxsize is not None and len(buf) + left > maxsize:
339 self._bad_message_length()
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200340 ov, err = _winapi.ReadFile(self._handle, left, overlapped=True)
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100341 rbytes, err = ov.GetOverlappedResult(True)
342 assert err == 0
343 assert rbytes == left
344 f.write(ov.getbuffer())
345 return f
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200346
347
348class Connection(_ConnectionBase):
349 """
350 Connection class based on an arbitrary file descriptor (Unix only), or
351 a socket handle (Windows).
352 """
353
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200354 if _winapi:
355 def _close(self, _close=_multiprocessing.closesocket):
Antoine Pitrou71a28a92011-07-09 01:03:00 +0200356 _close(self._handle)
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200357 _write = _multiprocessing.send
358 _read = _multiprocessing.recv
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200359 else:
Antoine Pitrou71a28a92011-07-09 01:03:00 +0200360 def _close(self, _close=os.close):
361 _close(self._handle)
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200362 _write = os.write
363 _read = os.read
364
365 def _send(self, buf, write=_write):
366 remaining = len(buf)
367 while True:
Richard Oudkerkcca8c532013-07-01 18:59:26 +0100368 try:
369 n = write(self._handle, buf)
370 except InterruptedError:
371 continue
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200372 remaining -= n
373 if remaining == 0:
374 break
375 buf = buf[n:]
376
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100377 def _recv(self, size, read=_read):
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200378 buf = io.BytesIO()
Antoine Pitroudd696492011-06-08 17:21:55 +0200379 handle = self._handle
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200380 remaining = size
381 while remaining > 0:
Richard Oudkerkcca8c532013-07-01 18:59:26 +0100382 try:
383 chunk = read(handle, remaining)
384 except InterruptedError:
385 continue
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200386 n = len(chunk)
387 if n == 0:
388 if remaining == size:
389 raise EOFError
390 else:
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200391 raise OSError("got end of file during message")
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200392 buf.write(chunk)
393 remaining -= n
394 return buf
395
396 def _send_bytes(self, buf):
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200397 n = len(buf)
Antoine Pitroub7d6d2a2014-02-08 23:03:56 +0100398 # For wire compatibility with 3.2 and lower
399 header = struct.pack("!i", n)
400 if n > 16384:
401 # The payload is large so Nagle's algorithm won't be triggered
402 # and we'd better avoid the cost of concatenation.
Antoine Pitrou0b878312014-07-31 18:41:57 -0400403 self._send(header)
404 self._send(buf)
405 else:
Antoine Pitroub7d6d2a2014-02-08 23:03:56 +0100406 # Issue # 20540: concatenate before sending, to avoid delays due
407 # to Nagle's algorithm on a TCP socket.
Antoine Pitrou0b878312014-07-31 18:41:57 -0400408 # Also note we want to avoid sending a 0-length buffer separately,
409 # to avoid "broken pipe" errors if the other end closed the pipe.
410 self._send(header + buf)
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200411
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100412 def _recv_bytes(self, maxsize=None):
413 buf = self._recv(4)
Charles-François Natali225aa4f2011-09-20 19:27:39 +0200414 size, = struct.unpack("!i", buf.getvalue())
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200415 if maxsize is not None and size > maxsize:
416 return None
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100417 return self._recv(size)
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200418
419 def _poll(self, timeout):
Richard Oudkerked9e06c2013-01-13 22:46:48 +0000420 r = wait([self], timeout)
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200421 return bool(r)
422
423
424#
Benjamin Petersone711caf2008-06-11 16:44:04 +0000425# Public functions
426#
427
428class Listener(object):
429 '''
430 Returns a listener object.
431
432 This is a wrapper for a bound socket which is 'listening' for
433 connections, or for a Windows named pipe.
434 '''
435 def __init__(self, address=None, family=None, backlog=1, authkey=None):
436 family = family or (address and address_type(address)) \
437 or default_family
438 address = address or arbitrary_address(family)
439
Antoine Pitrou709176f2012-04-01 17:19:09 +0200440 _validate_family(family)
Benjamin Petersone711caf2008-06-11 16:44:04 +0000441 if family == 'AF_PIPE':
442 self._listener = PipeListener(address, backlog)
443 else:
444 self._listener = SocketListener(address, family, backlog)
445
446 if authkey is not None and not isinstance(authkey, bytes):
447 raise TypeError('authkey should be a byte string')
448
449 self._authkey = authkey
450
451 def accept(self):
452 '''
453 Accept a connection on the bound socket or named pipe of `self`.
454
455 Returns a `Connection` object.
456 '''
Richard Oudkerkd69cfe82012-06-18 17:47:52 +0100457 if self._listener is None:
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200458 raise OSError('listener is closed')
Benjamin Petersone711caf2008-06-11 16:44:04 +0000459 c = self._listener.accept()
460 if self._authkey:
461 deliver_challenge(c, self._authkey)
462 answer_challenge(c, self._authkey)
463 return c
464
465 def close(self):
466 '''
467 Close the bound socket or named pipe of `self`.
468 '''
Richard Oudkerkd69cfe82012-06-18 17:47:52 +0100469 if self._listener is not None:
470 self._listener.close()
471 self._listener = None
Benjamin Petersone711caf2008-06-11 16:44:04 +0000472
473 address = property(lambda self: self._listener._address)
474 last_accepted = property(lambda self: self._listener._last_accepted)
475
Richard Oudkerkd69cfe82012-06-18 17:47:52 +0100476 def __enter__(self):
477 return self
478
479 def __exit__(self, exc_type, exc_value, exc_tb):
480 self.close()
481
Benjamin Petersone711caf2008-06-11 16:44:04 +0000482
483def Client(address, family=None, authkey=None):
484 '''
485 Returns a connection to the address of a `Listener`
486 '''
487 family = family or address_type(address)
Antoine Pitrou709176f2012-04-01 17:19:09 +0200488 _validate_family(family)
Benjamin Petersone711caf2008-06-11 16:44:04 +0000489 if family == 'AF_PIPE':
490 c = PipeClient(address)
491 else:
492 c = SocketClient(address)
493
494 if authkey is not None and not isinstance(authkey, bytes):
495 raise TypeError('authkey should be a byte string')
496
497 if authkey is not None:
498 answer_challenge(c, authkey)
499 deliver_challenge(c, authkey)
500
501 return c
502
503
504if sys.platform != 'win32':
505
506 def Pipe(duplex=True):
507 '''
508 Returns pair of connection objects at either end of a pipe
509 '''
510 if duplex:
511 s1, s2 = socket.socketpair()
Richard Oudkerkb15e6222012-07-27 14:19:00 +0100512 s1.setblocking(True)
513 s2.setblocking(True)
Antoine Pitrou5aa878c2011-05-09 21:00:28 +0200514 c1 = Connection(s1.detach())
515 c2 = Connection(s2.detach())
Benjamin Petersone711caf2008-06-11 16:44:04 +0000516 else:
Victor Stinnerdaf45552013-08-28 00:53:59 +0200517 fd1, fd2 = os.pipe()
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200518 c1 = Connection(fd1, writable=False)
519 c2 = Connection(fd2, readable=False)
Benjamin Petersone711caf2008-06-11 16:44:04 +0000520
521 return c1, c2
522
523else:
524
Benjamin Petersone711caf2008-06-11 16:44:04 +0000525 def Pipe(duplex=True):
526 '''
527 Returns pair of connection objects at either end of a pipe
528 '''
529 address = arbitrary_address('AF_PIPE')
530 if duplex:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200531 openmode = _winapi.PIPE_ACCESS_DUPLEX
532 access = _winapi.GENERIC_READ | _winapi.GENERIC_WRITE
Benjamin Petersone711caf2008-06-11 16:44:04 +0000533 obsize, ibsize = BUFSIZE, BUFSIZE
534 else:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200535 openmode = _winapi.PIPE_ACCESS_INBOUND
536 access = _winapi.GENERIC_WRITE
Benjamin Petersone711caf2008-06-11 16:44:04 +0000537 obsize, ibsize = 0, BUFSIZE
538
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200539 h1 = _winapi.CreateNamedPipe(
540 address, openmode | _winapi.FILE_FLAG_OVERLAPPED |
541 _winapi.FILE_FLAG_FIRST_PIPE_INSTANCE,
542 _winapi.PIPE_TYPE_MESSAGE | _winapi.PIPE_READMODE_MESSAGE |
543 _winapi.PIPE_WAIT,
Victor Stinnerdaf45552013-08-28 00:53:59 +0200544 1, obsize, ibsize, _winapi.NMPWAIT_WAIT_FOREVER,
545 # default security descriptor: the handle cannot be inherited
546 _winapi.NULL
Benjamin Petersone711caf2008-06-11 16:44:04 +0000547 )
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200548 h2 = _winapi.CreateFile(
549 address, access, 0, _winapi.NULL, _winapi.OPEN_EXISTING,
550 _winapi.FILE_FLAG_OVERLAPPED, _winapi.NULL
Benjamin Petersone711caf2008-06-11 16:44:04 +0000551 )
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200552 _winapi.SetNamedPipeHandleState(
553 h2, _winapi.PIPE_READMODE_MESSAGE, None, None
Benjamin Petersone711caf2008-06-11 16:44:04 +0000554 )
555
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200556 overlapped = _winapi.ConnectNamedPipe(h1, overlapped=True)
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100557 _, err = overlapped.GetOverlappedResult(True)
558 assert err == 0
Benjamin Petersone711caf2008-06-11 16:44:04 +0000559
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200560 c1 = PipeConnection(h1, writable=duplex)
561 c2 = PipeConnection(h2, readable=duplex)
Benjamin Petersone711caf2008-06-11 16:44:04 +0000562
563 return c1, c2
564
565#
566# Definitions for connections based on sockets
567#
568
569class SocketListener(object):
570 '''
Georg Brandl734e2682008-08-12 08:18:18 +0000571 Representation of a socket which is bound to an address and listening
Benjamin Petersone711caf2008-06-11 16:44:04 +0000572 '''
573 def __init__(self, address, family, backlog=1):
574 self._socket = socket.socket(getattr(socket, family))
Charles-François Nataliedc67fe2012-02-04 15:12:08 +0100575 try:
Charles-François Natalied4a8fc2012-02-08 21:15:58 +0100576 # SO_REUSEADDR has different semantics on Windows (issue #2550).
577 if os.name == 'posix':
578 self._socket.setsockopt(socket.SOL_SOCKET,
579 socket.SO_REUSEADDR, 1)
Richard Oudkerkb15e6222012-07-27 14:19:00 +0100580 self._socket.setblocking(True)
Charles-François Nataliedc67fe2012-02-04 15:12:08 +0100581 self._socket.bind(address)
582 self._socket.listen(backlog)
583 self._address = self._socket.getsockname()
584 except OSError:
585 self._socket.close()
586 raise
Benjamin Petersone711caf2008-06-11 16:44:04 +0000587 self._family = family
588 self._last_accepted = None
589
Benjamin Petersone711caf2008-06-11 16:44:04 +0000590 if family == 'AF_UNIX':
Richard Oudkerk84ed9a62013-08-14 15:35:41 +0100591 self._unlink = util.Finalize(
Georg Brandl2ee470f2008-07-16 12:55:28 +0000592 self, os.unlink, args=(address,), exitpriority=0
Benjamin Petersone711caf2008-06-11 16:44:04 +0000593 )
594 else:
595 self._unlink = None
596
597 def accept(self):
Richard Oudkerkcca8c532013-07-01 18:59:26 +0100598 while True:
599 try:
600 s, self._last_accepted = self._socket.accept()
601 except InterruptedError:
602 pass
603 else:
604 break
Richard Oudkerkb15e6222012-07-27 14:19:00 +0100605 s.setblocking(True)
Antoine Pitroudf97cbe2012-04-07 22:38:52 +0200606 return Connection(s.detach())
Benjamin Petersone711caf2008-06-11 16:44:04 +0000607
608 def close(self):
609 self._socket.close()
610 if self._unlink is not None:
611 self._unlink()
612
613
614def SocketClient(address):
615 '''
616 Return a connection object connected to the socket given by `address`
617 '''
618 family = address_type(address)
Victor Stinner2b695062011-01-03 15:47:59 +0000619 with socket.socket( getattr(socket, family) ) as s:
Richard Oudkerkb15e6222012-07-27 14:19:00 +0100620 s.setblocking(True)
Charles-François Natalie6eabd42011-11-19 09:59:43 +0100621 s.connect(address)
Antoine Pitroudf97cbe2012-04-07 22:38:52 +0200622 return Connection(s.detach())
Benjamin Petersone711caf2008-06-11 16:44:04 +0000623
624#
625# Definitions for connections based on named pipes
626#
627
628if sys.platform == 'win32':
629
630 class PipeListener(object):
631 '''
632 Representation of a named pipe
633 '''
634 def __init__(self, address, backlog=None):
635 self._address = address
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100636 self._handle_queue = [self._new_handle(first=True)]
637
Benjamin Petersone711caf2008-06-11 16:44:04 +0000638 self._last_accepted = None
Richard Oudkerk84ed9a62013-08-14 15:35:41 +0100639 util.sub_debug('listener created with address=%r', self._address)
640 self.close = util.Finalize(
Benjamin Petersone711caf2008-06-11 16:44:04 +0000641 self, PipeListener._finalize_pipe_listener,
642 args=(self._handle_queue, self._address), exitpriority=0
643 )
644
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100645 def _new_handle(self, first=False):
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200646 flags = _winapi.PIPE_ACCESS_DUPLEX | _winapi.FILE_FLAG_OVERLAPPED
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100647 if first:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200648 flags |= _winapi.FILE_FLAG_FIRST_PIPE_INSTANCE
649 return _winapi.CreateNamedPipe(
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100650 self._address, flags,
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200651 _winapi.PIPE_TYPE_MESSAGE | _winapi.PIPE_READMODE_MESSAGE |
652 _winapi.PIPE_WAIT,
653 _winapi.PIPE_UNLIMITED_INSTANCES, BUFSIZE, BUFSIZE,
654 _winapi.NMPWAIT_WAIT_FOREVER, _winapi.NULL
Benjamin Petersone711caf2008-06-11 16:44:04 +0000655 )
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100656
657 def accept(self):
658 self._handle_queue.append(self._new_handle())
Benjamin Petersone711caf2008-06-11 16:44:04 +0000659 handle = self._handle_queue.pop(0)
660 try:
Richard Oudkerkfdb8dcf2012-05-05 19:45:37 +0100661 ov = _winapi.ConnectNamedPipe(handle, overlapped=True)
662 except OSError as e:
663 if e.winerror != _winapi.ERROR_NO_DATA:
664 raise
665 # ERROR_NO_DATA can occur if a client has already connected,
666 # written data and then disconnected -- see Issue 14725.
667 else:
668 try:
669 res = _winapi.WaitForMultipleObjects(
670 [ov.event], False, INFINITE)
671 except:
672 ov.cancel()
673 _winapi.CloseHandle(handle)
674 raise
675 finally:
676 _, err = ov.GetOverlappedResult(True)
677 assert err == 0
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200678 return PipeConnection(handle)
Benjamin Petersone711caf2008-06-11 16:44:04 +0000679
680 @staticmethod
681 def _finalize_pipe_listener(queue, address):
Richard Oudkerk84ed9a62013-08-14 15:35:41 +0100682 util.sub_debug('closing listener with address=%r', address)
Benjamin Petersone711caf2008-06-11 16:44:04 +0000683 for handle in queue:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200684 _winapi.CloseHandle(handle)
Benjamin Petersone711caf2008-06-11 16:44:04 +0000685
686 def PipeClient(address):
687 '''
688 Return a connection object connected to the pipe given by `address`
689 '''
Antoine Pitrou45d61a32009-11-13 22:35:18 +0000690 t = _init_timeout()
Benjamin Petersone711caf2008-06-11 16:44:04 +0000691 while 1:
692 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200693 _winapi.WaitNamedPipe(address, 1000)
694 h = _winapi.CreateFile(
695 address, _winapi.GENERIC_READ | _winapi.GENERIC_WRITE,
696 0, _winapi.NULL, _winapi.OPEN_EXISTING,
697 _winapi.FILE_FLAG_OVERLAPPED, _winapi.NULL
Benjamin Petersone711caf2008-06-11 16:44:04 +0000698 )
Andrew Svetlov2606a6f2012-12-19 14:33:35 +0200699 except OSError as e:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200700 if e.winerror not in (_winapi.ERROR_SEM_TIMEOUT,
701 _winapi.ERROR_PIPE_BUSY) or _check_timeout(t):
Benjamin Petersone711caf2008-06-11 16:44:04 +0000702 raise
703 else:
704 break
705 else:
706 raise
707
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200708 _winapi.SetNamedPipeHandleState(
709 h, _winapi.PIPE_READMODE_MESSAGE, None, None
Benjamin Petersone711caf2008-06-11 16:44:04 +0000710 )
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200711 return PipeConnection(h)
Benjamin Petersone711caf2008-06-11 16:44:04 +0000712
713#
714# Authentication stuff
715#
716
717MESSAGE_LENGTH = 20
718
Benjamin Peterson1fcfe212008-06-25 12:54:22 +0000719CHALLENGE = b'#CHALLENGE#'
720WELCOME = b'#WELCOME#'
721FAILURE = b'#FAILURE#'
Benjamin Petersone711caf2008-06-11 16:44:04 +0000722
723def deliver_challenge(connection, authkey):
724 import hmac
725 assert isinstance(authkey, bytes)
726 message = os.urandom(MESSAGE_LENGTH)
727 connection.send_bytes(CHALLENGE + message)
Christian Heimes634919a2013-11-20 17:23:06 +0100728 digest = hmac.new(authkey, message, 'md5').digest()
Benjamin Petersone711caf2008-06-11 16:44:04 +0000729 response = connection.recv_bytes(256) # reject large message
730 if response == digest:
731 connection.send_bytes(WELCOME)
732 else:
733 connection.send_bytes(FAILURE)
734 raise AuthenticationError('digest received was wrong')
735
736def answer_challenge(connection, authkey):
737 import hmac
738 assert isinstance(authkey, bytes)
739 message = connection.recv_bytes(256) # reject large message
740 assert message[:len(CHALLENGE)] == CHALLENGE, 'message = %r' % message
741 message = message[len(CHALLENGE):]
Christian Heimes634919a2013-11-20 17:23:06 +0100742 digest = hmac.new(authkey, message, 'md5').digest()
Benjamin Petersone711caf2008-06-11 16:44:04 +0000743 connection.send_bytes(digest)
744 response = connection.recv_bytes(256) # reject large message
745 if response != WELCOME:
746 raise AuthenticationError('digest sent was rejected')
747
748#
749# Support for using xmlrpclib for serialization
750#
751
752class ConnectionWrapper(object):
753 def __init__(self, conn, dumps, loads):
754 self._conn = conn
755 self._dumps = dumps
756 self._loads = loads
757 for attr in ('fileno', 'close', 'poll', 'recv_bytes', 'send_bytes'):
758 obj = getattr(conn, attr)
759 setattr(self, attr, obj)
760 def send(self, obj):
761 s = self._dumps(obj)
762 self._conn.send_bytes(s)
763 def recv(self):
764 s = self._conn.recv_bytes()
765 return self._loads(s)
766
767def _xml_dumps(obj):
Marc-André Lemburg8f36af72011-02-25 15:42:01 +0000768 return xmlrpclib.dumps((obj,), None, None, None, 1).encode('utf-8')
Benjamin Petersone711caf2008-06-11 16:44:04 +0000769
770def _xml_loads(s):
Marc-André Lemburg8f36af72011-02-25 15:42:01 +0000771 (obj,), method = xmlrpclib.loads(s.decode('utf-8'))
Benjamin Petersone711caf2008-06-11 16:44:04 +0000772 return obj
773
774class XmlListener(Listener):
775 def accept(self):
776 global xmlrpclib
777 import xmlrpc.client as xmlrpclib
778 obj = Listener.accept(self)
779 return ConnectionWrapper(obj, _xml_dumps, _xml_loads)
780
781def XmlClient(*args, **kwds):
782 global xmlrpclib
783 import xmlrpc.client as xmlrpclib
784 return ConnectionWrapper(Client(*args, **kwds), _xml_dumps, _xml_loads)
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200785
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100786#
787# Wait
788#
789
790if sys.platform == 'win32':
791
792 def _exhaustive_wait(handles, timeout):
793 # Return ALL handles which are currently signalled. (Only
794 # returning the first signalled might create starvation issues.)
795 L = list(handles)
796 ready = []
797 while L:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200798 res = _winapi.WaitForMultipleObjects(L, False, timeout)
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100799 if res == WAIT_TIMEOUT:
800 break
801 elif WAIT_OBJECT_0 <= res < WAIT_OBJECT_0 + len(L):
802 res -= WAIT_OBJECT_0
803 elif WAIT_ABANDONED_0 <= res < WAIT_ABANDONED_0 + len(L):
804 res -= WAIT_ABANDONED_0
805 else:
806 raise RuntimeError('Should not get here')
807 ready.append(L[res])
808 L = L[res+1:]
809 timeout = 0
810 return ready
811
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200812 _ready_errors = {_winapi.ERROR_BROKEN_PIPE, _winapi.ERROR_NETNAME_DELETED}
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100813
814 def wait(object_list, timeout=None):
815 '''
816 Wait till an object in object_list is ready/readable.
817
818 Returns list of those objects in object_list which are ready/readable.
819 '''
820 if timeout is None:
821 timeout = INFINITE
822 elif timeout < 0:
823 timeout = 0
824 else:
825 timeout = int(timeout * 1000 + 0.5)
826
827 object_list = list(object_list)
828 waithandle_to_obj = {}
829 ov_list = []
830 ready_objects = set()
831 ready_handles = set()
832
833 try:
834 for o in object_list:
835 try:
836 fileno = getattr(o, 'fileno')
837 except AttributeError:
838 waithandle_to_obj[o.__index__()] = o
839 else:
840 # start an overlapped read of length zero
841 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200842 ov, err = _winapi.ReadFile(fileno(), 0, True)
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100843 except OSError as e:
844 err = e.winerror
845 if err not in _ready_errors:
846 raise
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200847 if err == _winapi.ERROR_IO_PENDING:
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100848 ov_list.append(ov)
849 waithandle_to_obj[ov.event] = o
850 else:
851 # If o.fileno() is an overlapped pipe handle and
852 # err == 0 then there is a zero length message
853 # in the pipe, but it HAS NOT been consumed.
854 ready_objects.add(o)
855 timeout = 0
856
857 ready_handles = _exhaustive_wait(waithandle_to_obj.keys(), timeout)
858 finally:
859 # request that overlapped reads stop
860 for ov in ov_list:
861 ov.cancel()
862
863 # wait for all overlapped reads to stop
864 for ov in ov_list:
865 try:
866 _, err = ov.GetOverlappedResult(True)
867 except OSError as e:
868 err = e.winerror
869 if err not in _ready_errors:
870 raise
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200871 if err != _winapi.ERROR_OPERATION_ABORTED:
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100872 o = waithandle_to_obj[ov.event]
873 ready_objects.add(o)
874 if err == 0:
875 # If o.fileno() is an overlapped pipe handle then
876 # a zero length message HAS been consumed.
877 if hasattr(o, '_got_empty_message'):
878 o._got_empty_message = True
879
880 ready_objects.update(waithandle_to_obj[h] for h in ready_handles)
881 return [o for o in object_list if o in ready_objects]
882
883else:
884
Charles-François Natalie241ac92013-09-05 20:46:49 +0200885 import selectors
Giampaolo Rodola'0c8ad612013-01-14 02:24:05 +0100886
Charles-François Natali45e25512013-09-08 11:30:53 +0200887 # poll/select have the advantage of not requiring any extra file
888 # descriptor, contrarily to epoll/kqueue (also, they require a single
889 # syscall).
890 if hasattr(selectors, 'PollSelector'):
891 _WaitSelector = selectors.PollSelector
892 else:
893 _WaitSelector = selectors.SelectSelector
894
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100895 def wait(object_list, timeout=None):
896 '''
897 Wait till an object in object_list is ready/readable.
898
899 Returns list of those objects in object_list which are ready/readable.
900 '''
Charles-François Natali45e25512013-09-08 11:30:53 +0200901 with _WaitSelector() as selector:
Charles-François Natalie241ac92013-09-05 20:46:49 +0200902 for obj in object_list:
903 selector.register(obj, selectors.EVENT_READ)
904
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100905 if timeout is not None:
Charles-François Natalie241ac92013-09-05 20:46:49 +0200906 deadline = time.time() + timeout
907
908 while True:
909 ready = selector.select(timeout)
910 if ready:
911 return [key.fileobj for (key, events) in ready]
912 else:
913 if timeout is not None:
914 timeout = deadline - time.time()
915 if timeout < 0:
916 return ready
Antoine Pitrou5438ed12012-04-24 22:56:57 +0200917
918#
919# Make connection and socket objects sharable if possible
920#
921
922if sys.platform == 'win32':
Richard Oudkerk84ed9a62013-08-14 15:35:41 +0100923 def reduce_connection(conn):
924 handle = conn.fileno()
925 with socket.fromfd(handle, socket.AF_INET, socket.SOCK_STREAM) as s:
926 from . import resource_sharer
927 ds = resource_sharer.DupSocket(s)
928 return rebuild_connection, (ds, conn.readable, conn.writable)
929 def rebuild_connection(ds, readable, writable):
930 sock = ds.detach()
931 return Connection(sock.detach(), readable, writable)
932 reduction.register(Connection, reduce_connection)
933
934 def reduce_pipe_connection(conn):
935 access = ((_winapi.FILE_GENERIC_READ if conn.readable else 0) |
936 (_winapi.FILE_GENERIC_WRITE if conn.writable else 0))
937 dh = reduction.DupHandle(conn.fileno(), access)
938 return rebuild_pipe_connection, (dh, conn.readable, conn.writable)
939 def rebuild_pipe_connection(dh, readable, writable):
940 handle = dh.detach()
941 return PipeConnection(handle, readable, writable)
942 reduction.register(PipeConnection, reduce_pipe_connection)
943
Antoine Pitrou5438ed12012-04-24 22:56:57 +0200944else:
Richard Oudkerk84ed9a62013-08-14 15:35:41 +0100945 def reduce_connection(conn):
946 df = reduction.DupFd(conn.fileno())
947 return rebuild_connection, (df, conn.readable, conn.writable)
948 def rebuild_connection(df, readable, writable):
949 fd = df.detach()
950 return Connection(fd, readable, writable)
951 reduction.register(Connection, reduce_connection)