24
24
bzrlib/transport/smart/__init__.py.
27
from __future__ import absolute_import
35
33
from bzrlib.lazy_import import lazy_import
36
34
lazy_import(globals(), """
42
37
from bzrlib import (
50
from bzrlib.i18n import gettext
51
from bzrlib.smart import client, protocol, request, signals, vfs
45
from bzrlib.smart import client, protocol
52
46
from bzrlib.transport import ssh
54
from bzrlib import osutils
56
# Throughout this module buffer size parameters are either limited to be at
57
# most _MAX_READ_SIZE, or are ignored and _MAX_READ_SIZE is used instead.
58
# For this module's purposes, MAX_SOCKET_CHUNK is a reasonable size for reads
59
# from non-sockets as well.
60
_MAX_READ_SIZE = osutils.MAX_SOCKET_CHUNK
50
# We must not read any more than 64k at a time so we don't risk "no buffer
51
# space available" errors on some platforms. Windows in particular is likely
52
# to give error 10053 or 10055 if we read more than 64k from a socket.
53
_MAX_READ_SIZE = 64 * 1024
62
56
def _get_protocol_factory_for_bytes(bytes):
63
57
"""Determine the right protocol factory for 'bytes'.
233
201
while not self.finished:
234
202
server_protocol = self._build_protocol()
235
203
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
204
except Exception, e:
243
205
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
208
def _build_protocol(self):
271
209
"""Identifies the version of the incoming request, and returns an
287
221
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
224
def _serve_one_request(self, protocol):
322
225
"""Read one request from input, process, send back a response.
324
227
:param protocol: a SmartServerRequestProtocol.
329
230
self._serve_one_request_unguarded(protocol)
330
231
except KeyboardInterrupt:
347
248
class SmartServerSocketStreamMedium(SmartServerStreamMedium):
349
def __init__(self, sock, backing_transport, root_client_path='/',
250
def __init__(self, sock, backing_transport, root_client_path='/'):
353
253
:param sock: the socket the server will read from. It will be put
354
254
into blocking mode.
356
256
SmartServerStreamMedium.__init__(
357
self, backing_transport, root_client_path=root_client_path,
257
self, backing_transport, root_client_path=root_client_path)
359
258
sock.setblocking(True)
360
259
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
261
def _serve_one_request_unguarded(self, protocol):
375
262
while protocol.next_read_size():
376
263
# We can safely try to read large chunks. If there is less data
377
# than MAX_SOCKET_CHUNK ready, the socket will just return a
378
# short read immediately rather than block.
379
bytes = self.read_bytes(osutils.MAX_SOCKET_CHUNK)
264
# than _MAX_READ_SIZE ready, the socket wil just return a short
265
# read immediately rather than block.
266
bytes = self.read_bytes(_MAX_READ_SIZE)
381
268
self.finished = True
383
270
protocol.accept_bytes(bytes)
385
272
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
274
def _read_bytes(self, desired_count):
404
return osutils.read_bytes_from_socket(
405
self.socket, self._report_activity)
275
# We ignore the desired_count because on sockets it's more efficient to
276
# read large chunks (of _MAX_READ_SIZE bytes) at a time.
277
return osutils.until_no_eintr(self.socket.recv, _MAX_READ_SIZE)
407
279
def terminate_due_to_error(self):
408
280
# TODO: This should log to a server log file, but no such thing
411
283
self.finished = True
413
285
def _write_out(self, bytes):
414
tstart = osutils.timer_func()
415
osutils.send_all(self.socket, bytes, self._report_activity)
416
if 'hpss' in debug.debug_flags:
417
thread_id = thread.get_ident()
418
trace.mutter('%12s: [%s] %d bytes to the socket in %.3fs'
419
% ('wrote', thread_id, len(bytes),
420
osutils.timer_func() - tstart))
286
osutils.send_all(self.socket, bytes)
423
289
class SmartServerPipeStreamMedium(SmartServerStreamMedium):
425
def __init__(self, in_file, out_file, backing_transport, timeout=None):
291
def __init__(self, in_file, out_file, backing_transport):
426
292
"""Construct new server.
428
294
:param in_file: Python file from which requests can be read.
429
295
:param out_file: Python file to write responses.
430
296
:param backing_transport: Transport for the directory served.
432
SmartServerStreamMedium.__init__(self, backing_transport,
298
SmartServerStreamMedium.__init__(self, backing_transport)
434
299
if sys.platform == 'win32':
435
300
# force binary mode for files
627
460
if not line.endswith('\n'):
628
461
# end of file encountered reading from server
629
462
raise errors.ConnectionReset(
630
"Unexpected end of message. Please check connectivity "
631
"and permissions, and report a bug if problems persist.")
463
"please check connectivity and permissions",
464
"(and try -Dhpss if further diagnosis is required)")
634
467
def _read_line(self):
635
468
"""Helper for SmartClientMediumRequest.read_line.
637
470
By default this forwards to self._medium._get_line because we are
638
471
operating on the medium's stream.
640
473
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
476
class _DebugCounter(object):
663
477
"""An object that counts the HPSS calls made to each client medium.
665
When a medium is garbage-collected, or failing that when
666
bzrlib.global_state exits, the total number of calls made on that medium
667
are reported via trace.note.
479
When a medium is garbage-collected, or failing that when atexit functions
480
are run, the total number of calls made on that medium are reported via
670
484
def __init__(self):
671
485
self.counts = weakref.WeakKeyDictionary()
672
486
client._SmartClient.hooks.install_named_hook(
673
487
'call', self.increment_call_count, 'hpss call counter')
674
bzrlib.global_state.cleanups.add_cleanup(self.flush_all)
488
atexit.register(self.flush_all)
676
490
def track(self, medium):
677
491
"""Start tracking calls made to a medium.
692
505
def increment_call_count(self, params):
693
506
# Increment the count in the WeakKeyDictionary
694
507
value = self.counts[params.medium]
697
request_method = request.request_handlers.get(params.method)
699
# A method we don't know about doesn't count as a VFS method.
701
if issubclass(request_method, vfs.VfsRequest):
702
value['vfs_count'] += 1
704
510
def done(self, ref):
705
511
value = self.counts[ref]
706
count, vfs_count, medium_repr = (
707
value['count'], value['vfs_count'], value['medium_repr'])
512
count, medium_repr = value
708
513
# In case this callback is invoked for the same ref twice (by the
709
514
# weakref callback and by the atexit function), set the call count back
710
515
# to 0 so this item won't be reported twice.
712
value['vfs_count'] = 0
714
trace.note(gettext('HPSS calls: {0} ({1} vfs) {2}').format(
715
count, vfs_count, medium_repr))
518
trace.note('HPSS calls: %d %s', count, medium_repr)
717
520
def flush_all(self):
718
521
for ref in list(self.counts.keys()):
721
524
_debug_counter = None
725
527
class SmartClientMedium(SmartMedium):
726
528
"""Smart client is a medium for sending smart protocol requests over."""
906
686
def _accept_bytes(self, bytes):
907
687
"""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", e)
915
self._report_activity(len(bytes), 'write')
688
self._writeable_pipe.write(bytes)
917
690
def _flush(self):
918
691
"""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
692
self._writeable_pipe.flush()
924
694
def _read_bytes(self, count):
925
695
"""See SmartClientStreamMedium._read_bytes."""
926
bytes_to_read = min(count, _MAX_READ_SIZE)
927
bytes = self._readable_pipe.read(bytes_to_read)
928
self._report_activity(len(bytes), 'read')
932
class SSHParams(object):
933
"""A set of parameters for starting a remote bzr via SSH."""
696
return self._readable_pipe.read(count)
699
class SmartSSHClientMedium(SmartClientStreamMedium):
700
"""A client medium using SSH."""
935
702
def __init__(self, host, port=None, username=None, password=None,
936
bzr_remote_path='bzr'):
939
self.username = username
940
self.password = password
941
self.bzr_remote_path = bzr_remote_path
944
class SmartSSHClientMedium(SmartClientStreamMedium):
945
"""A client medium using SSH.
947
It delegates IO to a SmartSimplePipesClientMedium or
948
SmartClientAlreadyConnectedSocketMedium (depending on platform).
951
def __init__(self, base, ssh_params, vendor=None):
703
base=None, vendor=None, bzr_remote_path=None):
952
704
"""Creates a client that will connect on the first use.
954
:param ssh_params: A SSHParams instance.
955
706
:param vendor: An optional override for the ssh vendor to use. See
956
707
bzrlib.transport.ssh for details on ssh vendors.
958
self._real_medium = None
959
self._ssh_params = ssh_params
960
# for the benefit of progress making a short description of this
962
self._scheme = 'bzr+ssh'
963
# SmartClientStreamMedium stores the repr of this object in its
964
# _DebugCounter so we have to store all the values used in our repr
965
# method before calling the super init.
966
709
SmartClientStreamMedium.__init__(self, base)
710
self._connected = False
712
self._password = password
714
self._username = username
715
self._read_from = None
716
self._ssh_connection = None
967
717
self._vendor = vendor
968
self._ssh_connection = None
971
if self._ssh_params.port is None:
974
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/)" % (
980
self.__class__.__name__,
983
self._ssh_params.host,
718
self._write_to = None
719
self._bzr_remote_path = bzr_remote_path
720
if self._bzr_remote_path is None:
721
symbol_versioning.warn(
722
'bzr_remote_path is required as of bzr 0.92',
723
DeprecationWarning, stacklevel=2)
724
self._bzr_remote_path = os.environ.get('BZR_REMOTE_PATH', 'bzr')
986
726
def _accept_bytes(self, bytes):
987
727
"""See SmartClientStreamMedium.accept_bytes."""
988
728
self._ensure_connection()
989
self._real_medium.accept_bytes(bytes)
729
self._write_to.write(bytes)
991
731
def disconnect(self):
992
732
"""See SmartClientMedium.disconnect()."""
993
if self._real_medium is not None:
994
self._real_medium.disconnect()
995
self._real_medium = None
996
if self._ssh_connection is not None:
997
self._ssh_connection.close()
998
self._ssh_connection = None
733
if not self._connected:
735
self._read_from.close()
736
self._write_to.close()
737
self._ssh_connection.close()
738
self._connected = False
1000
740
def _ensure_connection(self):
1001
741
"""Connect this medium if not already connected."""
1002
if self._real_medium is not None:
1004
744
if self._vendor is None:
1005
745
vendor = ssh._get_ssh_vendor()
1007
747
vendor = self._vendor
1008
self._ssh_connection = vendor.connect_ssh(self._ssh_params.username,
1009
self._ssh_params.password, self._ssh_params.host,
1010
self._ssh_params.port,
1011
command=[self._ssh_params.bzr_remote_path, 'serve', '--inet',
748
self._ssh_connection = vendor.connect_ssh(self._username,
749
self._password, self._host, self._port,
750
command=[self._bzr_remote_path, 'serve', '--inet',
1012
751
'--directory=/', '--allow-writes'])
1013
io_kind, io_object = self._ssh_connection.get_sock_or_pipes()
1014
if io_kind == 'socket':
1015
self._real_medium = SmartClientAlreadyConnectedSocketMedium(
1016
self.base, io_object)
1017
elif io_kind == 'pipes':
1018
read_from, write_to = io_object
1019
self._real_medium = SmartSimplePipesClientMedium(
1020
read_from, write_to, self.base)
1022
raise AssertionError(
1023
"Unexpected io_kind %r from %r"
1024
% (io_kind, self._ssh_connection))
1025
for hook in transport.Transport.hooks["post_connect"]:
752
self._read_from, self._write_to = \
753
self._ssh_connection.get_filelike_channels()
754
self._connected = True
1028
756
def _flush(self):
1029
757
"""See SmartClientStreamMedium._flush()."""
1030
self._real_medium._flush()
758
self._write_to.flush()
1032
760
def _read_bytes(self, count):
1033
761
"""See SmartClientStreamMedium.read_bytes."""
1034
if self._real_medium is None:
762
if not self._connected:
1035
763
raise errors.MediumNotConnected(self)
1036
return self._real_medium.read_bytes(count)
764
bytes_to_read = min(count, _MAX_READ_SIZE)
765
return self._read_from.read(bytes_to_read)
1039
768
# Port 4155 is the default port for bzr://, registered with IANA.
1041
770
BZR_DEFAULT_PORT = 4155
1044
class SmartClientSocketMedium(SmartClientStreamMedium):
1045
"""A client medium using a socket.
1047
This class isn't usable directly. Use one of its subclasses instead.
1050
def __init__(self, base):
773
class SmartTCPClientMedium(SmartClientStreamMedium):
774
"""A client medium using TCP."""
776
def __init__(self, host, port, base):
777
"""Creates a client that will connect on the first use."""
1051
778
SmartClientStreamMedium.__init__(self, base)
779
self._connected = False
1052
782
self._socket = None
1053
self._connected = False
1055
784
def _accept_bytes(self, bytes):
1056
785
"""See SmartClientMedium.accept_bytes."""
1057
786
self._ensure_connection()
1058
osutils.send_all(self._socket, bytes, self._report_activity)
1060
def _ensure_connection(self):
1061
"""Connect this medium if not already connected."""
1062
raise NotImplementedError(self._ensure_connection)
1065
"""See SmartClientStreamMedium._flush().
1067
For sockets we do no flushing. For TCP sockets we may want to turn off
1068
TCP_NODELAY and add a means to do a flush, but that can be done in the
1072
def _read_bytes(self, count):
1073
"""See SmartClientMedium.read_bytes."""
1074
if not self._connected:
1075
raise errors.MediumNotConnected(self)
1076
return osutils.read_bytes_from_socket(
1077
self._socket, self._report_activity)
787
osutils.send_all(self._socket, bytes)
1079
789
def disconnect(self):
1080
790
"""See SmartClientMedium.disconnect()."""
1132
832
raise errors.ConnectionError("failed to connect to %s:%d: %s" %
1133
833
(self._host, port, err_msg))
1134
834
self._connected = True
1135
for hook in transport.Transport.hooks["post_connect"]:
1139
class SmartClientAlreadyConnectedSocketMedium(SmartClientSocketMedium):
1140
"""A client medium for an already connected socket.
1142
Note that this class will assume it "owns" the socket, so it will close it
1143
when its disconnect method is called.
1146
def __init__(self, base, sock):
1147
SmartClientSocketMedium.__init__(self, base)
1149
self._connected = True
1151
def _ensure_connection(self):
1152
# Already connected, by definition! So nothing to do.
837
"""See SmartClientStreamMedium._flush().
839
For TCP we do no flushing. We may want to turn off TCP_NODELAY and
840
add a means to do a flush, but that can be done in the future.
843
def _read_bytes(self, count):
844
"""See SmartClientMedium.read_bytes."""
845
if not self._connected:
846
raise errors.MediumNotConnected(self)
847
# We ignore the desired_count because on sockets it's more efficient to
848
# read large chunks (of _MAX_READ_SIZE bytes) at a time.
850
return self._socket.recv(_MAX_READ_SIZE)
851
except socket.error, e:
852
if len(e.args) and e.args[0] == errno.ECONNRESET:
853
# Callers expect an empty string in that case
1156
859
class SmartClientStreamMediumRequest(SmartClientMediumRequest):
added
removed
bzrlib/smart/medium.py
