24
24
bzrlib/transport/smart/__init__.py.
27
from __future__ import absolute_import
35
32
from bzrlib.lazy_import import lazy_import
36
33
lazy_import(globals(), """
50
from bzrlib.i18n import gettext
51
from bzrlib.smart import client, protocol, request, signals, vfs
45
from bzrlib.smart import client, protocol, request, vfs
52
46
from bzrlib.transport import ssh
54
48
from bzrlib import osutils
181
175
ui.ui_factory.report_transport_activity(self, bytes, direction)
184
_bad_file_descriptor = (errno.EBADF,)
185
if sys.platform == 'win32':
186
# Given on Windows if you pass a closed socket to select.select. Probably
187
# also given if you pass a file handle to select.
189
_bad_file_descriptor += (WSAENOTSOCK,)
192
178
class SmartServerStreamMedium(SmartMedium):
193
179
"""Handles smart commands coming over a stream.
207
193
the stream. See also the _push_back method.
212
def __init__(self, backing_transport, root_client_path='/', timeout=None):
196
def __init__(self, backing_transport, root_client_path='/'):
213
197
"""Construct new server.
215
199
:param backing_transport: Transport for the directory served.
218
202
self.backing_transport = backing_transport
219
203
self.root_client_path = root_client_path
220
204
self.finished = False
222
raise AssertionError('You must supply a timeout.')
223
self._client_timeout = timeout
224
self._client_poll_timeout = min(timeout / 10.0, 1.0)
225
205
SmartMedium.__init__(self)
233
213
while not self.finished:
234
214
server_protocol = self._build_protocol()
235
215
self._serve_one_request(server_protocol)
236
except errors.ConnectionTimeout, e:
237
trace.note('%s' % (e,))
238
trace.log_exception_quietly()
239
self._disconnect_client()
240
# We reported it, no reason to make a big fuss.
242
216
except Exception, e:
243
217
stderr.write("%s terminating on exception %s\n" % (self, e))
245
self._disconnect_client()
247
def _stop_gracefully(self):
248
"""When we finish this message, stop looking for more."""
249
trace.mutter('Stopping %s' % (self,))
252
def _disconnect_client(self):
253
"""Close the current connection. We stopped due to a timeout/etc."""
254
# The default implementation is a no-op, because that is all we used to
255
# do when disconnecting from a client. I suppose we never had the
256
# *server* initiate a disconnect, before
258
def _wait_for_bytes_with_timeout(self, timeout_seconds):
259
"""Wait for more bytes to be read, but timeout if none available.
261
This allows us to detect idle connections, and stop trying to read from
262
them, without setting the socket itself to non-blocking. This also
263
allows us to specify when we watch for idle timeouts.
265
:return: Did we timeout? (True if we timed out, False if there is data
268
raise NotImplementedError(self._wait_for_bytes_with_timeout)
270
220
def _build_protocol(self):
271
221
"""Identifies the version of the incoming request, and returns an
277
227
:returns: a SmartServerRequestProtocol.
279
self._wait_for_bytes_with_timeout(self._client_timeout)
281
# We're stopping, so don't try to do any more work
283
229
bytes = self._get_line()
284
230
protocol_factory, unused_bytes = _get_protocol_factory_for_bytes(bytes)
285
231
protocol = protocol_factory(
287
233
protocol.accept_bytes(unused_bytes)
290
def _wait_on_descriptor(self, fd, timeout_seconds):
291
"""select() on a file descriptor, waiting for nonblocking read()
293
This will raise a ConnectionTimeout exception if we do not get a
294
readable handle before timeout_seconds.
297
t_end = self._timer() + timeout_seconds
298
poll_timeout = min(timeout_seconds, self._client_poll_timeout)
300
while not rs and not xs and self._timer() < t_end:
304
rs, _, xs = select.select([fd], [], [fd], poll_timeout)
305
except (select.error, socket.error) as e:
306
err = getattr(e, 'errno', None)
307
if err is None and getattr(e, 'args', None) is not None:
308
# select.error doesn't have 'errno', it just has args[0]
310
if err in _bad_file_descriptor:
311
return # Not a socket indicates read() will fail
312
elif err == errno.EINTR:
313
# Interrupted, keep looping.
318
raise errors.ConnectionTimeout('disconnecting client after %.1f seconds'
319
% (timeout_seconds,))
321
236
def _serve_one_request(self, protocol):
322
237
"""Read one request from input, process, send back a response.
324
239
:param protocol: a SmartServerRequestProtocol.
329
242
self._serve_one_request_unguarded(protocol)
330
243
except KeyboardInterrupt:
347
260
class SmartServerSocketStreamMedium(SmartServerStreamMedium):
349
def __init__(self, sock, backing_transport, root_client_path='/',
262
def __init__(self, sock, backing_transport, root_client_path='/'):
353
265
:param sock: the socket the server will read from. It will be put
354
266
into blocking mode.
356
268
SmartServerStreamMedium.__init__(
357
self, backing_transport, root_client_path=root_client_path,
269
self, backing_transport, root_client_path=root_client_path)
359
270
sock.setblocking(True)
360
271
self.socket = sock
361
# Get the getpeername now, as we might be closed later when we care.
363
self._client_info = sock.getpeername()
365
self._client_info = '<unknown>'
368
return '%s(client=%s)' % (self.__class__.__name__, self._client_info)
371
return '%s.%s(client=%s)' % (self.__module__, self.__class__.__name__,
374
273
def _serve_one_request_unguarded(self, protocol):
375
274
while protocol.next_read_size():
385
284
self._push_back(protocol.unused_data)
387
def _disconnect_client(self):
388
"""Close the current connection. We stopped due to a timeout/etc."""
391
def _wait_for_bytes_with_timeout(self, timeout_seconds):
392
"""Wait for more bytes to be read, but timeout if none available.
394
This allows us to detect idle connections, and stop trying to read from
395
them, without setting the socket itself to non-blocking. This also
396
allows us to specify when we watch for idle timeouts.
398
:return: None, this will raise ConnectionTimeout if we time out before
401
return self._wait_on_descriptor(self.socket, timeout_seconds)
403
286
def _read_bytes(self, desired_count):
404
287
return osutils.read_bytes_from_socket(
405
288
self.socket, self._report_activity)
423
306
class SmartServerPipeStreamMedium(SmartServerStreamMedium):
425
def __init__(self, in_file, out_file, backing_transport, timeout=None):
308
def __init__(self, in_file, out_file, backing_transport):
426
309
"""Construct new server.
428
311
:param in_file: Python file from which requests can be read.
429
312
:param out_file: Python file to write responses.
430
313
:param backing_transport: Transport for the directory served.
432
SmartServerStreamMedium.__init__(self, backing_transport,
315
SmartServerStreamMedium.__init__(self, backing_transport)
434
316
if sys.platform == 'win32':
435
317
# force binary mode for files
441
323
self._in = in_file
442
324
self._out = out_file
445
"""See SmartServerStreamMedium.serve"""
446
# This is the regular serve, except it adds signal trapping for soft
448
stop_gracefully = self._stop_gracefully
449
signals.register_on_hangup(id(self), stop_gracefully)
451
return super(SmartServerPipeStreamMedium, self).serve()
453
signals.unregister_on_hangup(id(self))
455
326
def _serve_one_request_unguarded(self, protocol):
457
328
# We need to be careful not to read past the end of the current
471
342
protocol.accept_bytes(bytes)
473
def _disconnect_client(self):
478
def _wait_for_bytes_with_timeout(self, timeout_seconds):
479
"""Wait for more bytes to be read, but timeout if none available.
481
This allows us to detect idle connections, and stop trying to read from
482
them, without setting the socket itself to non-blocking. This also
483
allows us to specify when we watch for idle timeouts.
485
:return: None, this will raise ConnectionTimeout if we time out before
488
if (getattr(self._in, 'fileno', None) is None
489
or sys.platform == 'win32'):
490
# You can't select() file descriptors on Windows.
492
return self._wait_on_descriptor(self._in, timeout_seconds)
494
344
def _read_bytes(self, desired_count):
495
345
return self._in.read(desired_count)
640
490
return self._medium._get_line()
643
class _VfsRefuser(object):
644
"""An object that refuses all VFS requests.
649
client._SmartClient.hooks.install_named_hook(
650
'call', self.check_vfs, 'vfs refuser')
652
def check_vfs(self, params):
654
request_method = request.request_handlers.get(params.method)
656
# A method we don't know about doesn't count as a VFS method.
658
if issubclass(request_method, vfs.VfsRequest):
659
raise errors.HpssVfsRequestNotAllowed(params.method, params.args)
662
493
class _DebugCounter(object):
663
494
"""An object that counts the HPSS calls made to each client medium.
711
542
value['count'] = 0
712
543
value['vfs_count'] = 0
714
trace.note(gettext('HPSS calls: {0} ({1} vfs) {2}').format(
715
count, vfs_count, medium_repr))
545
trace.note('HPSS calls: %d (%d vfs) %s',
546
count, vfs_count, medium_repr)
717
548
def flush_all(self):
718
549
for ref in list(self.counts.keys()):
721
552
_debug_counter = None
725
555
class SmartClientMedium(SmartMedium):
742
572
if _debug_counter is None:
743
573
_debug_counter = _DebugCounter()
744
574
_debug_counter.track(self)
745
if 'hpss_client_no_vfs' in debug.debug_flags:
747
if _vfs_refuser is None:
748
_vfs_refuser = _VfsRefuser()
750
576
def _is_remote_before(self, version_tuple):
751
577
"""Is it possible the remote side supports RPCs for a given version?
843
669
medium_base = urlutils.join(self.base, '/')
844
670
rel_url = urlutils.relative_url(medium_base, transport.base)
845
return urlutils.unquote(rel_url)
671
return urllib.unquote(rel_url)
848
674
class SmartClientStreamMedium(SmartClientMedium):
884
710
return SmartClientStreamMediumRequest(self)
887
"""We have been disconnected, reset current state.
889
This resets things like _current_request and connected state.
892
self._current_request = None
895
713
class SmartSimplePipesClientMedium(SmartClientStreamMedium):
896
714
"""A client medium using simple pipes.
906
724
def _accept_bytes(self, bytes):
907
725
"""See SmartClientStreamMedium.accept_bytes."""
909
self._writeable_pipe.write(bytes)
911
if e.errno in (errno.EINVAL, errno.EPIPE):
912
raise errors.ConnectionReset(
913
"Error trying to write to subprocess:\n%s" % (e,))
726
self._writeable_pipe.write(bytes)
915
727
self._report_activity(len(bytes), 'write')
917
729
def _flush(self):
918
730
"""See SmartClientStreamMedium._flush()."""
919
# Note: If flush were to fail, we'd like to raise ConnectionReset, etc.
920
# However, testing shows that even when the child process is
921
# gone, this doesn't error.
922
731
self._writeable_pipe.flush()
924
733
def _read_bytes(self, count):
944
753
class SmartSSHClientMedium(SmartClientStreamMedium):
945
754
"""A client medium using SSH.
947
It delegates IO to a SmartSimplePipesClientMedium or
756
It delegates IO to a SmartClientSocketMedium or
948
757
SmartClientAlreadyConnectedSocketMedium (depending on platform).
974
783
maybe_port = ':%s' % self._ssh_params.port
975
if self._ssh_params.username is None:
978
maybe_user = '%s@' % self._ssh_params.username
979
return "%s(%s://%s%s%s/)" % (
784
return "%s(%s://%s@%s%s/)" % (
980
785
self.__class__.__name__,
787
self._ssh_params.username,
983
788
self._ssh_params.host,
1022
827
raise AssertionError(
1023
828
"Unexpected io_kind %r from %r"
1024
829
% (io_kind, self._ssh_connection))
1025
for hook in transport.Transport.hooks["post_connect"]:
1028
831
def _flush(self):
1029
832
"""See SmartClientStreamMedium._flush()."""
1132
935
raise errors.ConnectionError("failed to connect to %s:%d: %s" %
1133
936
(self._host, port, err_msg))
1134
937
self._connected = True
1135
for hook in transport.Transport.hooks["post_connect"]:
1139
940
class SmartClientAlreadyConnectedSocketMedium(SmartClientSocketMedium):
added
removed
bzrlib/smart/medium.py
