24
24
bzrlib/transport/smart/__init__.py.
33
32
from bzrlib.lazy_import import lazy_import
34
33
lazy_import(globals(), """
37
38
from bzrlib import (
46
from bzrlib.smart import client, protocol
46
from bzrlib.smart import client, protocol, request, vfs
47
47
from bzrlib.transport import ssh
51
# We must not read any more than 64k at a time so we don't risk "no buffer
52
# space available" errors on some platforms. Windows in particular is likely
53
# to give error 10053 or 10055 if we read more than 64k from a socket.
54
_MAX_READ_SIZE = 64 * 1024
49
from bzrlib import osutils
51
# Throughout this module buffer size parameters are either limited to be at
52
# most _MAX_READ_SIZE, or are ignored and _MAX_READ_SIZE is used instead.
53
# For this module's purposes, MAX_SOCKET_CHUNK is a reasonable size for reads
54
# from non-sockets as well.
55
_MAX_READ_SIZE = osutils.MAX_SOCKET_CHUNK
57
57
def _get_protocol_factory_for_bytes(bytes):
58
58
"""Determine the right protocol factory for 'bytes'.
519
524
def increment_call_count(self, params):
520
525
# Increment the count in the WeakKeyDictionary
521
526
value = self.counts[params.medium]
529
request_method = request.request_handlers.get(params.method)
531
# A method we don't know about doesn't count as a VFS method.
533
if issubclass(request_method, vfs.VfsRequest):
534
value['vfs_count'] += 1
524
536
def done(self, ref):
525
537
value = self.counts[ref]
526
count, medium_repr = value
538
count, vfs_count, medium_repr = (
539
value['count'], value['vfs_count'], value['medium_repr'])
527
540
# In case this callback is invoked for the same ref twice (by the
528
541
# weakref callback and by the atexit function), set the call count back
529
542
# to 0 so this item won't be reported twice.
544
value['vfs_count'] = 0
532
trace.note('HPSS calls: %d %s', count, medium_repr)
546
trace.note('HPSS calls: %d (%d vfs) %s',
547
count, vfs_count, medium_repr)
534
549
def flush_all(self):
535
550
for ref in list(self.counts.keys()):
713
734
def _read_bytes(self, count):
714
735
"""See SmartClientStreamMedium._read_bytes."""
715
bytes = self._readable_pipe.read(count)
736
bytes_to_read = min(count, _MAX_READ_SIZE)
737
bytes = self._readable_pipe.read(bytes_to_read)
716
738
self._report_activity(len(bytes), 'read')
742
class SSHParams(object):
743
"""A set of parameters for starting a remote bzr via SSH."""
745
def __init__(self, host, port=None, username=None, password=None,
746
bzr_remote_path='bzr'):
749
self.username = username
750
self.password = password
751
self.bzr_remote_path = bzr_remote_path
720
754
class SmartSSHClientMedium(SmartClientStreamMedium):
721
"""A client medium using SSH."""
755
"""A client medium using SSH.
757
It delegates IO to a SmartClientSocketMedium or
758
SmartClientAlreadyConnectedSocketMedium (depending on platform).
723
def __init__(self, host, port=None, username=None, password=None,
724
base=None, vendor=None, bzr_remote_path=None):
761
def __init__(self, base, ssh_params, vendor=None):
725
762
"""Creates a client that will connect on the first use.
764
:param ssh_params: A SSHParams instance.
727
765
:param vendor: An optional override for the ssh vendor to use. See
728
766
bzrlib.transport.ssh for details on ssh vendors.
730
self._connected = False
732
self._password = password
734
self._username = username
768
self._real_medium = None
769
self._ssh_params = ssh_params
770
# for the benefit of progress making a short description of this
772
self._scheme = 'bzr+ssh'
735
773
# SmartClientStreamMedium stores the repr of this object in its
736
774
# _DebugCounter so we have to store all the values used in our repr
737
775
# method before calling the super init.
738
776
SmartClientStreamMedium.__init__(self, base)
739
self._read_from = None
777
self._vendor = vendor
740
778
self._ssh_connection = None
741
self._vendor = vendor
742
self._write_to = None
743
self._bzr_remote_path = bzr_remote_path
744
# for the benefit of progress making a short description of this
746
self._scheme = 'bzr+ssh'
748
780
def __repr__(self):
749
return "%s(connected=%r, username=%r, host=%r, port=%r)" % (
781
if self._ssh_params.port is None:
784
maybe_port = ':%s' % self._ssh_params.port
785
return "%s(%s://%s@%s%s/)" % (
750
786
self.__class__.__name__,
788
self._ssh_params.username,
789
self._ssh_params.host,
756
792
def _accept_bytes(self, bytes):
757
793
"""See SmartClientStreamMedium.accept_bytes."""
758
794
self._ensure_connection()
759
self._write_to.write(bytes)
760
self._report_activity(len(bytes), 'write')
795
self._real_medium.accept_bytes(bytes)
762
797
def disconnect(self):
763
798
"""See SmartClientMedium.disconnect()."""
764
if not self._connected:
766
self._read_from.close()
767
self._write_to.close()
768
self._ssh_connection.close()
769
self._connected = False
799
if self._real_medium is not None:
800
self._real_medium.disconnect()
801
self._real_medium = None
802
if self._ssh_connection is not None:
803
self._ssh_connection.close()
804
self._ssh_connection = None
771
806
def _ensure_connection(self):
772
807
"""Connect this medium if not already connected."""
808
if self._real_medium is not None:
775
810
if self._vendor is None:
776
811
vendor = ssh._get_ssh_vendor()
778
813
vendor = self._vendor
779
self._ssh_connection = vendor.connect_ssh(self._username,
780
self._password, self._host, self._port,
781
command=[self._bzr_remote_path, 'serve', '--inet',
814
self._ssh_connection = vendor.connect_ssh(self._ssh_params.username,
815
self._ssh_params.password, self._ssh_params.host,
816
self._ssh_params.port,
817
command=[self._ssh_params.bzr_remote_path, 'serve', '--inet',
782
818
'--directory=/', '--allow-writes'])
783
self._read_from, self._write_to = \
784
self._ssh_connection.get_filelike_channels()
785
self._connected = True
819
io_kind, io_object = self._ssh_connection.get_sock_or_pipes()
820
if io_kind == 'socket':
821
self._real_medium = SmartClientAlreadyConnectedSocketMedium(
822
self.base, io_object)
823
elif io_kind == 'pipes':
824
read_from, write_to = io_object
825
self._real_medium = SmartSimplePipesClientMedium(
826
read_from, write_to, self.base)
828
raise AssertionError(
829
"Unexpected io_kind %r from %r"
830
% (io_kind, self._ssh_connection))
787
832
def _flush(self):
788
833
"""See SmartClientStreamMedium._flush()."""
789
self._write_to.flush()
834
self._real_medium._flush()
791
836
def _read_bytes(self, count):
792
837
"""See SmartClientStreamMedium.read_bytes."""
793
if not self._connected:
838
if self._real_medium is None:
794
839
raise errors.MediumNotConnected(self)
795
bytes_to_read = min(count, _MAX_READ_SIZE)
796
bytes = self._read_from.read(bytes_to_read)
797
self._report_activity(len(bytes), 'read')
840
return self._real_medium.read_bytes(count)
801
843
# Port 4155 is the default port for bzr://, registered with IANA.
803
845
BZR_DEFAULT_PORT = 4155
806
class SmartTCPClientMedium(SmartClientStreamMedium):
807
"""A client medium using TCP."""
848
class SmartClientSocketMedium(SmartClientStreamMedium):
849
"""A client medium using a socket.
851
This class isn't usable directly. Use one of its subclasses instead.
809
def __init__(self, host, port, base):
810
"""Creates a client that will connect on the first use."""
854
def __init__(self, base):
811
855
SmartClientStreamMedium.__init__(self, base)
812
857
self._connected = False
817
859
def _accept_bytes(self, bytes):
818
860
"""See SmartClientMedium.accept_bytes."""
819
861
self._ensure_connection()
820
862
osutils.send_all(self._socket, bytes, self._report_activity)
864
def _ensure_connection(self):
865
"""Connect this medium if not already connected."""
866
raise NotImplementedError(self._ensure_connection)
869
"""See SmartClientStreamMedium._flush().
871
For sockets we do no flushing. For TCP sockets we may want to turn off
872
TCP_NODELAY and add a means to do a flush, but that can be done in the
876
def _read_bytes(self, count):
877
"""See SmartClientMedium.read_bytes."""
878
if not self._connected:
879
raise errors.MediumNotConnected(self)
880
return osutils.read_bytes_from_socket(
881
self._socket, self._report_activity)
822
883
def disconnect(self):
823
884
"""See SmartClientMedium.disconnect()."""
824
885
if not self._connected:
866
937
(self._host, port, err_msg))
867
938
self._connected = True
870
"""See SmartClientStreamMedium._flush().
872
For TCP we do no flushing. We may want to turn off TCP_NODELAY and
873
add a means to do a flush, but that can be done in the future.
876
def _read_bytes(self, count):
877
"""See SmartClientMedium.read_bytes."""
878
if not self._connected:
879
raise errors.MediumNotConnected(self)
880
# We ignore the desired_count because on sockets it's more efficient to
881
# read large chunks (of _MAX_READ_SIZE bytes) at a time.
883
bytes = osutils.until_no_eintr(self._socket.recv, _MAX_READ_SIZE)
884
except socket.error, e:
885
if len(e.args) and e.args[0] == errno.ECONNRESET:
886
# Callers expect an empty string in that case
891
self._report_activity(len(bytes), 'read')
941
class SmartClientAlreadyConnectedSocketMedium(SmartClientSocketMedium):
942
"""A client medium for an already connected socket.
944
Note that this class will assume it "owns" the socket, so it will close it
945
when its disconnect method is called.
948
def __init__(self, base, sock):
949
SmartClientSocketMedium.__init__(self, base)
951
self._connected = True
953
def _ensure_connection(self):
954
# Already connected, by definition! So nothing to do.
895
958
class SmartClientStreamMediumRequest(SmartClientMediumRequest):
added
removed
bzrlib/smart/medium.py
