blob: 07d19de7e3365846a078890d14ce1500ba0638d3 [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 """
Serhiy Storchakab757c832014-12-05 22:25:22 +0200223 Receive bytes data into a writeable bytes-like object.
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200224 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:
Charles-François Natali6e6c59b2015-02-07 13:27:50 +0000368 n = write(self._handle, buf)
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200369 remaining -= n
370 if remaining == 0:
371 break
372 buf = buf[n:]
373
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100374 def _recv(self, size, read=_read):
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200375 buf = io.BytesIO()
Antoine Pitroudd696492011-06-08 17:21:55 +0200376 handle = self._handle
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200377 remaining = size
378 while remaining > 0:
Charles-François Natali6e6c59b2015-02-07 13:27:50 +0000379 chunk = read(handle, remaining)
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200380 n = len(chunk)
381 if n == 0:
382 if remaining == size:
383 raise EOFError
384 else:
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200385 raise OSError("got end of file during message")
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200386 buf.write(chunk)
387 remaining -= n
388 return buf
389
390 def _send_bytes(self, buf):
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200391 n = len(buf)
Antoine Pitroub7d6d2a2014-02-08 23:03:56 +0100392 # For wire compatibility with 3.2 and lower
393 header = struct.pack("!i", n)
394 if n > 16384:
395 # The payload is large so Nagle's algorithm won't be triggered
396 # and we'd better avoid the cost of concatenation.
Antoine Pitrou0b878312014-07-31 18:41:57 -0400397 self._send(header)
398 self._send(buf)
399 else:
Antoine Pitroub7d6d2a2014-02-08 23:03:56 +0100400 # Issue # 20540: concatenate before sending, to avoid delays due
401 # to Nagle's algorithm on a TCP socket.
Antoine Pitrou0b878312014-07-31 18:41:57 -0400402 # Also note we want to avoid sending a 0-length buffer separately,
403 # to avoid "broken pipe" errors if the other end closed the pipe.
404 self._send(header + buf)
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200405
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100406 def _recv_bytes(self, maxsize=None):
407 buf = self._recv(4)
Charles-François Natali225aa4f2011-09-20 19:27:39 +0200408 size, = struct.unpack("!i", buf.getvalue())
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200409 if maxsize is not None and size > maxsize:
410 return None
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100411 return self._recv(size)
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200412
413 def _poll(self, timeout):
Richard Oudkerked9e06c2013-01-13 22:46:48 +0000414 r = wait([self], timeout)
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200415 return bool(r)
416
417
418#
Benjamin Petersone711caf2008-06-11 16:44:04 +0000419# Public functions
420#
421
422class Listener(object):
423 '''
424 Returns a listener object.
425
426 This is a wrapper for a bound socket which is 'listening' for
427 connections, or for a Windows named pipe.
428 '''
429 def __init__(self, address=None, family=None, backlog=1, authkey=None):
430 family = family or (address and address_type(address)) \
431 or default_family
432 address = address or arbitrary_address(family)
433
Antoine Pitrou709176f2012-04-01 17:19:09 +0200434 _validate_family(family)
Benjamin Petersone711caf2008-06-11 16:44:04 +0000435 if family == 'AF_PIPE':
436 self._listener = PipeListener(address, backlog)
437 else:
438 self._listener = SocketListener(address, family, backlog)
439
440 if authkey is not None and not isinstance(authkey, bytes):
441 raise TypeError('authkey should be a byte string')
442
443 self._authkey = authkey
444
445 def accept(self):
446 '''
447 Accept a connection on the bound socket or named pipe of `self`.
448
449 Returns a `Connection` object.
450 '''
Richard Oudkerkd69cfe82012-06-18 17:47:52 +0100451 if self._listener is None:
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200452 raise OSError('listener is closed')
Benjamin Petersone711caf2008-06-11 16:44:04 +0000453 c = self._listener.accept()
454 if self._authkey:
455 deliver_challenge(c, self._authkey)
456 answer_challenge(c, self._authkey)
457 return c
458
459 def close(self):
460 '''
461 Close the bound socket or named pipe of `self`.
462 '''
Richard Oudkerkd69cfe82012-06-18 17:47:52 +0100463 if self._listener is not None:
464 self._listener.close()
465 self._listener = None
Benjamin Petersone711caf2008-06-11 16:44:04 +0000466
467 address = property(lambda self: self._listener._address)
468 last_accepted = property(lambda self: self._listener._last_accepted)
469
Richard Oudkerkd69cfe82012-06-18 17:47:52 +0100470 def __enter__(self):
471 return self
472
473 def __exit__(self, exc_type, exc_value, exc_tb):
474 self.close()
475
Benjamin Petersone711caf2008-06-11 16:44:04 +0000476
477def Client(address, family=None, authkey=None):
478 '''
479 Returns a connection to the address of a `Listener`
480 '''
481 family = family or address_type(address)
Antoine Pitrou709176f2012-04-01 17:19:09 +0200482 _validate_family(family)
Benjamin Petersone711caf2008-06-11 16:44:04 +0000483 if family == 'AF_PIPE':
484 c = PipeClient(address)
485 else:
486 c = SocketClient(address)
487
488 if authkey is not None and not isinstance(authkey, bytes):
489 raise TypeError('authkey should be a byte string')
490
491 if authkey is not None:
492 answer_challenge(c, authkey)
493 deliver_challenge(c, authkey)
494
495 return c
496
497
498if sys.platform != 'win32':
499
500 def Pipe(duplex=True):
501 '''
502 Returns pair of connection objects at either end of a pipe
503 '''
504 if duplex:
505 s1, s2 = socket.socketpair()
Richard Oudkerkb15e6222012-07-27 14:19:00 +0100506 s1.setblocking(True)
507 s2.setblocking(True)
Antoine Pitrou5aa878c2011-05-09 21:00:28 +0200508 c1 = Connection(s1.detach())
509 c2 = Connection(s2.detach())
Benjamin Petersone711caf2008-06-11 16:44:04 +0000510 else:
Victor Stinnerdaf45552013-08-28 00:53:59 +0200511 fd1, fd2 = os.pipe()
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200512 c1 = Connection(fd1, writable=False)
513 c2 = Connection(fd2, readable=False)
Benjamin Petersone711caf2008-06-11 16:44:04 +0000514
515 return c1, c2
516
517else:
518
Benjamin Petersone711caf2008-06-11 16:44:04 +0000519 def Pipe(duplex=True):
520 '''
521 Returns pair of connection objects at either end of a pipe
522 '''
523 address = arbitrary_address('AF_PIPE')
524 if duplex:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200525 openmode = _winapi.PIPE_ACCESS_DUPLEX
526 access = _winapi.GENERIC_READ | _winapi.GENERIC_WRITE
Benjamin Petersone711caf2008-06-11 16:44:04 +0000527 obsize, ibsize = BUFSIZE, BUFSIZE
528 else:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200529 openmode = _winapi.PIPE_ACCESS_INBOUND
530 access = _winapi.GENERIC_WRITE
Benjamin Petersone711caf2008-06-11 16:44:04 +0000531 obsize, ibsize = 0, BUFSIZE
532
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200533 h1 = _winapi.CreateNamedPipe(
534 address, openmode | _winapi.FILE_FLAG_OVERLAPPED |
535 _winapi.FILE_FLAG_FIRST_PIPE_INSTANCE,
536 _winapi.PIPE_TYPE_MESSAGE | _winapi.PIPE_READMODE_MESSAGE |
537 _winapi.PIPE_WAIT,
Victor Stinnerdaf45552013-08-28 00:53:59 +0200538 1, obsize, ibsize, _winapi.NMPWAIT_WAIT_FOREVER,
539 # default security descriptor: the handle cannot be inherited
540 _winapi.NULL
Benjamin Petersone711caf2008-06-11 16:44:04 +0000541 )
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200542 h2 = _winapi.CreateFile(
543 address, access, 0, _winapi.NULL, _winapi.OPEN_EXISTING,
544 _winapi.FILE_FLAG_OVERLAPPED, _winapi.NULL
Benjamin Petersone711caf2008-06-11 16:44:04 +0000545 )
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200546 _winapi.SetNamedPipeHandleState(
547 h2, _winapi.PIPE_READMODE_MESSAGE, None, None
Benjamin Petersone711caf2008-06-11 16:44:04 +0000548 )
549
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200550 overlapped = _winapi.ConnectNamedPipe(h1, overlapped=True)
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100551 _, err = overlapped.GetOverlappedResult(True)
552 assert err == 0
Benjamin Petersone711caf2008-06-11 16:44:04 +0000553
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200554 c1 = PipeConnection(h1, writable=duplex)
555 c2 = PipeConnection(h2, readable=duplex)
Benjamin Petersone711caf2008-06-11 16:44:04 +0000556
557 return c1, c2
558
559#
560# Definitions for connections based on sockets
561#
562
563class SocketListener(object):
564 '''
Georg Brandl734e2682008-08-12 08:18:18 +0000565 Representation of a socket which is bound to an address and listening
Benjamin Petersone711caf2008-06-11 16:44:04 +0000566 '''
567 def __init__(self, address, family, backlog=1):
568 self._socket = socket.socket(getattr(socket, family))
Charles-François Nataliedc67fe2012-02-04 15:12:08 +0100569 try:
Charles-François Natalied4a8fc2012-02-08 21:15:58 +0100570 # SO_REUSEADDR has different semantics on Windows (issue #2550).
571 if os.name == 'posix':
572 self._socket.setsockopt(socket.SOL_SOCKET,
573 socket.SO_REUSEADDR, 1)
Richard Oudkerkb15e6222012-07-27 14:19:00 +0100574 self._socket.setblocking(True)
Charles-François Nataliedc67fe2012-02-04 15:12:08 +0100575 self._socket.bind(address)
576 self._socket.listen(backlog)
577 self._address = self._socket.getsockname()
578 except OSError:
579 self._socket.close()
580 raise
Benjamin Petersone711caf2008-06-11 16:44:04 +0000581 self._family = family
582 self._last_accepted = None
583
Benjamin Petersone711caf2008-06-11 16:44:04 +0000584 if family == 'AF_UNIX':
Richard Oudkerk84ed9a62013-08-14 15:35:41 +0100585 self._unlink = util.Finalize(
Georg Brandl2ee470f2008-07-16 12:55:28 +0000586 self, os.unlink, args=(address,), exitpriority=0
Benjamin Petersone711caf2008-06-11 16:44:04 +0000587 )
588 else:
589 self._unlink = None
590
591 def accept(self):
Charles-François Natali6e6c59b2015-02-07 13:27:50 +0000592 s, self._last_accepted = self._socket.accept()
Richard Oudkerkb15e6222012-07-27 14:19:00 +0100593 s.setblocking(True)
Antoine Pitroudf97cbe2012-04-07 22:38:52 +0200594 return Connection(s.detach())
Benjamin Petersone711caf2008-06-11 16:44:04 +0000595
596 def close(self):
597 self._socket.close()
598 if self._unlink is not None:
599 self._unlink()
600
601
602def SocketClient(address):
603 '''
604 Return a connection object connected to the socket given by `address`
605 '''
606 family = address_type(address)
Victor Stinner2b695062011-01-03 15:47:59 +0000607 with socket.socket( getattr(socket, family) ) as s:
Richard Oudkerkb15e6222012-07-27 14:19:00 +0100608 s.setblocking(True)
Charles-François Natalie6eabd42011-11-19 09:59:43 +0100609 s.connect(address)
Antoine Pitroudf97cbe2012-04-07 22:38:52 +0200610 return Connection(s.detach())
Benjamin Petersone711caf2008-06-11 16:44:04 +0000611
612#
613# Definitions for connections based on named pipes
614#
615
616if sys.platform == 'win32':
617
618 class PipeListener(object):
619 '''
620 Representation of a named pipe
621 '''
622 def __init__(self, address, backlog=None):
623 self._address = address
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100624 self._handle_queue = [self._new_handle(first=True)]
625
Benjamin Petersone711caf2008-06-11 16:44:04 +0000626 self._last_accepted = None
Richard Oudkerk84ed9a62013-08-14 15:35:41 +0100627 util.sub_debug('listener created with address=%r', self._address)
628 self.close = util.Finalize(
Benjamin Petersone711caf2008-06-11 16:44:04 +0000629 self, PipeListener._finalize_pipe_listener,
630 args=(self._handle_queue, self._address), exitpriority=0
631 )
632
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100633 def _new_handle(self, first=False):
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200634 flags = _winapi.PIPE_ACCESS_DUPLEX | _winapi.FILE_FLAG_OVERLAPPED
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100635 if first:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200636 flags |= _winapi.FILE_FLAG_FIRST_PIPE_INSTANCE
637 return _winapi.CreateNamedPipe(
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100638 self._address, flags,
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200639 _winapi.PIPE_TYPE_MESSAGE | _winapi.PIPE_READMODE_MESSAGE |
640 _winapi.PIPE_WAIT,
641 _winapi.PIPE_UNLIMITED_INSTANCES, BUFSIZE, BUFSIZE,
642 _winapi.NMPWAIT_WAIT_FOREVER, _winapi.NULL
Benjamin Petersone711caf2008-06-11 16:44:04 +0000643 )
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100644
645 def accept(self):
646 self._handle_queue.append(self._new_handle())
Benjamin Petersone711caf2008-06-11 16:44:04 +0000647 handle = self._handle_queue.pop(0)
648 try:
Richard Oudkerkfdb8dcf2012-05-05 19:45:37 +0100649 ov = _winapi.ConnectNamedPipe(handle, overlapped=True)
650 except OSError as e:
651 if e.winerror != _winapi.ERROR_NO_DATA:
652 raise
653 # ERROR_NO_DATA can occur if a client has already connected,
654 # written data and then disconnected -- see Issue 14725.
655 else:
656 try:
657 res = _winapi.WaitForMultipleObjects(
658 [ov.event], False, INFINITE)
659 except:
660 ov.cancel()
661 _winapi.CloseHandle(handle)
662 raise
663 finally:
664 _, err = ov.GetOverlappedResult(True)
665 assert err == 0
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200666 return PipeConnection(handle)
Benjamin Petersone711caf2008-06-11 16:44:04 +0000667
668 @staticmethod
669 def _finalize_pipe_listener(queue, address):
Richard Oudkerk84ed9a62013-08-14 15:35:41 +0100670 util.sub_debug('closing listener with address=%r', address)
Benjamin Petersone711caf2008-06-11 16:44:04 +0000671 for handle in queue:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200672 _winapi.CloseHandle(handle)
Benjamin Petersone711caf2008-06-11 16:44:04 +0000673
674 def PipeClient(address):
675 '''
676 Return a connection object connected to the pipe given by `address`
677 '''
Antoine Pitrou45d61a32009-11-13 22:35:18 +0000678 t = _init_timeout()
Benjamin Petersone711caf2008-06-11 16:44:04 +0000679 while 1:
680 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200681 _winapi.WaitNamedPipe(address, 1000)
682 h = _winapi.CreateFile(
683 address, _winapi.GENERIC_READ | _winapi.GENERIC_WRITE,
684 0, _winapi.NULL, _winapi.OPEN_EXISTING,
685 _winapi.FILE_FLAG_OVERLAPPED, _winapi.NULL
Benjamin Petersone711caf2008-06-11 16:44:04 +0000686 )
Andrew Svetlov2606a6f2012-12-19 14:33:35 +0200687 except OSError as e:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200688 if e.winerror not in (_winapi.ERROR_SEM_TIMEOUT,
689 _winapi.ERROR_PIPE_BUSY) or _check_timeout(t):
Benjamin Petersone711caf2008-06-11 16:44:04 +0000690 raise
691 else:
692 break
693 else:
694 raise
695
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200696 _winapi.SetNamedPipeHandleState(
697 h, _winapi.PIPE_READMODE_MESSAGE, None, None
Benjamin Petersone711caf2008-06-11 16:44:04 +0000698 )
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200699 return PipeConnection(h)
Benjamin Petersone711caf2008-06-11 16:44:04 +0000700
701#
702# Authentication stuff
703#
704
705MESSAGE_LENGTH = 20
706
Benjamin Peterson1fcfe212008-06-25 12:54:22 +0000707CHALLENGE = b'#CHALLENGE#'
708WELCOME = b'#WELCOME#'
709FAILURE = b'#FAILURE#'
Benjamin Petersone711caf2008-06-11 16:44:04 +0000710
711def deliver_challenge(connection, authkey):
712 import hmac
713 assert isinstance(authkey, bytes)
714 message = os.urandom(MESSAGE_LENGTH)
715 connection.send_bytes(CHALLENGE + message)
Christian Heimes634919a2013-11-20 17:23:06 +0100716 digest = hmac.new(authkey, message, 'md5').digest()
Benjamin Petersone711caf2008-06-11 16:44:04 +0000717 response = connection.recv_bytes(256) # reject large message
718 if response == digest:
719 connection.send_bytes(WELCOME)
720 else:
721 connection.send_bytes(FAILURE)
722 raise AuthenticationError('digest received was wrong')
723
724def answer_challenge(connection, authkey):
725 import hmac
726 assert isinstance(authkey, bytes)
727 message = connection.recv_bytes(256) # reject large message
728 assert message[:len(CHALLENGE)] == CHALLENGE, 'message = %r' % message
729 message = message[len(CHALLENGE):]
Christian Heimes634919a2013-11-20 17:23:06 +0100730 digest = hmac.new(authkey, message, 'md5').digest()
Benjamin Petersone711caf2008-06-11 16:44:04 +0000731 connection.send_bytes(digest)
732 response = connection.recv_bytes(256) # reject large message
733 if response != WELCOME:
734 raise AuthenticationError('digest sent was rejected')
735
736#
737# Support for using xmlrpclib for serialization
738#
739
740class ConnectionWrapper(object):
741 def __init__(self, conn, dumps, loads):
742 self._conn = conn
743 self._dumps = dumps
744 self._loads = loads
745 for attr in ('fileno', 'close', 'poll', 'recv_bytes', 'send_bytes'):
746 obj = getattr(conn, attr)
747 setattr(self, attr, obj)
748 def send(self, obj):
749 s = self._dumps(obj)
750 self._conn.send_bytes(s)
751 def recv(self):
752 s = self._conn.recv_bytes()
753 return self._loads(s)
754
755def _xml_dumps(obj):
Marc-André Lemburg8f36af72011-02-25 15:42:01 +0000756 return xmlrpclib.dumps((obj,), None, None, None, 1).encode('utf-8')
Benjamin Petersone711caf2008-06-11 16:44:04 +0000757
758def _xml_loads(s):
Marc-André Lemburg8f36af72011-02-25 15:42:01 +0000759 (obj,), method = xmlrpclib.loads(s.decode('utf-8'))
Benjamin Petersone711caf2008-06-11 16:44:04 +0000760 return obj
761
762class XmlListener(Listener):
763 def accept(self):
764 global xmlrpclib
765 import xmlrpc.client as xmlrpclib
766 obj = Listener.accept(self)
767 return ConnectionWrapper(obj, _xml_dumps, _xml_loads)
768
769def XmlClient(*args, **kwds):
770 global xmlrpclib
771 import xmlrpc.client as xmlrpclib
772 return ConnectionWrapper(Client(*args, **kwds), _xml_dumps, _xml_loads)
Antoine Pitrou87cf2202011-05-09 17:04:27 +0200773
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100774#
775# Wait
776#
777
778if sys.platform == 'win32':
779
780 def _exhaustive_wait(handles, timeout):
781 # Return ALL handles which are currently signalled. (Only
782 # returning the first signalled might create starvation issues.)
783 L = list(handles)
784 ready = []
785 while L:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200786 res = _winapi.WaitForMultipleObjects(L, False, timeout)
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100787 if res == WAIT_TIMEOUT:
788 break
789 elif WAIT_OBJECT_0 <= res < WAIT_OBJECT_0 + len(L):
790 res -= WAIT_OBJECT_0
791 elif WAIT_ABANDONED_0 <= res < WAIT_ABANDONED_0 + len(L):
792 res -= WAIT_ABANDONED_0
793 else:
794 raise RuntimeError('Should not get here')
795 ready.append(L[res])
796 L = L[res+1:]
797 timeout = 0
798 return ready
799
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200800 _ready_errors = {_winapi.ERROR_BROKEN_PIPE, _winapi.ERROR_NETNAME_DELETED}
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100801
802 def wait(object_list, timeout=None):
803 '''
804 Wait till an object in object_list is ready/readable.
805
806 Returns list of those objects in object_list which are ready/readable.
807 '''
808 if timeout is None:
809 timeout = INFINITE
810 elif timeout < 0:
811 timeout = 0
812 else:
813 timeout = int(timeout * 1000 + 0.5)
814
815 object_list = list(object_list)
816 waithandle_to_obj = {}
817 ov_list = []
818 ready_objects = set()
819 ready_handles = set()
820
821 try:
822 for o in object_list:
823 try:
824 fileno = getattr(o, 'fileno')
825 except AttributeError:
826 waithandle_to_obj[o.__index__()] = o
827 else:
828 # start an overlapped read of length zero
829 try:
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200830 ov, err = _winapi.ReadFile(fileno(), 0, True)
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100831 except OSError as e:
Steve Dower3f9e3812015-03-02 08:05:27 -0800832 ov, err = None, e.winerror
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100833 if err not in _ready_errors:
834 raise
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200835 if err == _winapi.ERROR_IO_PENDING:
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100836 ov_list.append(ov)
837 waithandle_to_obj[ov.event] = o
838 else:
839 # If o.fileno() is an overlapped pipe handle and
840 # err == 0 then there is a zero length message
Steve Dower3f9e3812015-03-02 08:05:27 -0800841 # in the pipe, but it HAS NOT been consumed...
842 if ov and sys.getwindowsversion()[:2] >= (6, 2):
843 # ... except on Windows 8 and later, where
844 # the message HAS been consumed.
845 try:
846 _, err = ov.GetOverlappedResult(False)
847 except OSError as e:
848 err = e.winerror
849 if not err and hasattr(o, '_got_empty_message'):
850 o._got_empty_message = True
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100851 ready_objects.add(o)
852 timeout = 0
853
854 ready_handles = _exhaustive_wait(waithandle_to_obj.keys(), timeout)
855 finally:
856 # request that overlapped reads stop
857 for ov in ov_list:
858 ov.cancel()
859
860 # wait for all overlapped reads to stop
861 for ov in ov_list:
862 try:
863 _, err = ov.GetOverlappedResult(True)
864 except OSError as e:
865 err = e.winerror
866 if err not in _ready_errors:
867 raise
Antoine Pitrou23bba4c2012-04-18 20:51:15 +0200868 if err != _winapi.ERROR_OPERATION_ABORTED:
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100869 o = waithandle_to_obj[ov.event]
870 ready_objects.add(o)
871 if err == 0:
872 # If o.fileno() is an overlapped pipe handle then
873 # a zero length message HAS been consumed.
874 if hasattr(o, '_got_empty_message'):
875 o._got_empty_message = True
876
877 ready_objects.update(waithandle_to_obj[h] for h in ready_handles)
878 return [o for o in object_list if o in ready_objects]
879
880else:
881
Charles-François Natalie241ac92013-09-05 20:46:49 +0200882 import selectors
Giampaolo Rodola'0c8ad612013-01-14 02:24:05 +0100883
Charles-François Natali45e25512013-09-08 11:30:53 +0200884 # poll/select have the advantage of not requiring any extra file
885 # descriptor, contrarily to epoll/kqueue (also, they require a single
886 # syscall).
887 if hasattr(selectors, 'PollSelector'):
888 _WaitSelector = selectors.PollSelector
889 else:
890 _WaitSelector = selectors.SelectSelector
891
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100892 def wait(object_list, timeout=None):
893 '''
894 Wait till an object in object_list is ready/readable.
895
896 Returns list of those objects in object_list which are ready/readable.
897 '''
Charles-François Natali45e25512013-09-08 11:30:53 +0200898 with _WaitSelector() as selector:
Charles-François Natalie241ac92013-09-05 20:46:49 +0200899 for obj in object_list:
900 selector.register(obj, selectors.EVENT_READ)
901
Antoine Pitroubdb1cf12012-03-05 19:28:37 +0100902 if timeout is not None:
Charles-François Natalie241ac92013-09-05 20:46:49 +0200903 deadline = time.time() + timeout
904
905 while True:
906 ready = selector.select(timeout)
907 if ready:
908 return [key.fileobj for (key, events) in ready]
909 else:
910 if timeout is not None:
911 timeout = deadline - time.time()
912 if timeout < 0:
913 return ready
Antoine Pitrou5438ed12012-04-24 22:56:57 +0200914
915#
916# Make connection and socket objects sharable if possible
917#
918
919if sys.platform == 'win32':
Richard Oudkerk84ed9a62013-08-14 15:35:41 +0100920 def reduce_connection(conn):
921 handle = conn.fileno()
922 with socket.fromfd(handle, socket.AF_INET, socket.SOCK_STREAM) as s:
923 from . import resource_sharer
924 ds = resource_sharer.DupSocket(s)
925 return rebuild_connection, (ds, conn.readable, conn.writable)
926 def rebuild_connection(ds, readable, writable):
927 sock = ds.detach()
928 return Connection(sock.detach(), readable, writable)
929 reduction.register(Connection, reduce_connection)
930
931 def reduce_pipe_connection(conn):
932 access = ((_winapi.FILE_GENERIC_READ if conn.readable else 0) |
933 (_winapi.FILE_GENERIC_WRITE if conn.writable else 0))
934 dh = reduction.DupHandle(conn.fileno(), access)
935 return rebuild_pipe_connection, (dh, conn.readable, conn.writable)
936 def rebuild_pipe_connection(dh, readable, writable):
937 handle = dh.detach()
938 return PipeConnection(handle, readable, writable)
939 reduction.register(PipeConnection, reduce_pipe_connection)
940
Antoine Pitrou5438ed12012-04-24 22:56:57 +0200941else:
Richard Oudkerk84ed9a62013-08-14 15:35:41 +0100942 def reduce_connection(conn):
943 df = reduction.DupFd(conn.fileno())
944 return rebuild_connection, (df, conn.readable, conn.writable)
945 def rebuild_connection(df, readable, writable):
946 fd = df.detach()
947 return Connection(fd, readable, writable)
948 reduction.register(Connection, reduce_connection)