← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/smart/medium.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-07-23 20:28:46 UTC
  • mfrom: (4562.1.2 bzr.dev)
  • Revision ID: pqm@pqm.ubuntu.com-20090723202846-qpxxgq1j5805yrf6
(Jelmer) Support exporting symlinks when exporting from a working
        tree.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/smart/medium.py
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
24
24
bzrlib/transport/smart/__init__.py.
25
25
"""
26
26
 
 
27
import errno
27
28
import os
 
29
import socket
28
30
import sys
29
31
import urllib
30
32
 
31
 
import bzrlib
32
33
from bzrlib.lazy_import import lazy_import
33
34
lazy_import(globals(), """
34
 
import socket
35
 
import thread
 
35
import atexit
36
36
import weakref
37
 
 
38
37
from bzrlib import (
39
38
    debug,
40
39
    errors,
 
40
    osutils,
41
41
    symbol_versioning,
42
42
    trace,
43
43
    ui,
46
46
from bzrlib.smart import client, protocol, request, vfs
47
47
from bzrlib.transport import ssh
48
48
""")
49
 
from bzrlib import osutils
50
 
 
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
 
49
 
 
50
 
 
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
 
55
 
56
56
 
57
57
def _get_protocol_factory_for_bytes(bytes):
58
58
    """Determine the right protocol factory for 'bytes'.
274
274
    def _serve_one_request_unguarded(self, protocol):
275
275
        while protocol.next_read_size():
276
276
            # We can safely try to read large chunks.  If there is less data
277
 
            # than MAX_SOCKET_CHUNK ready, the socket will just return a
278
 
            # short read immediately rather than block.
279
 
            bytes = self.read_bytes(osutils.MAX_SOCKET_CHUNK)
 
277
            # than _MAX_READ_SIZE ready, the socket wil just return a short
 
278
            # read immediately rather than block.
 
279
            bytes = self.read_bytes(_MAX_READ_SIZE)
280
280
            if bytes == '':
281
281
                self.finished = True
282
282
                return
285
285
        self._push_back(protocol.unused_data)
286
286
 
287
287
    def _read_bytes(self, desired_count):
288
 
        return osutils.read_bytes_from_socket(
289
 
            self.socket, self._report_activity)
 
288
        return _read_bytes_from_socket(
 
289
            self.socket.recv, desired_count, self._report_activity)
290
290
 
291
291
    def terminate_due_to_error(self):
292
292
        # TODO: This should log to a server log file, but no such thing
295
295
        self.finished = True
296
296
 
297
297
    def _write_out(self, bytes):
298
 
        tstart = osutils.timer_func()
299
298
        osutils.send_all(self.socket, bytes, self._report_activity)
300
 
        if 'hpss' in debug.debug_flags:
301
 
            thread_id = thread.get_ident()
302
 
            trace.mutter('%12s: [%s] %d bytes to the socket in %.3fs'
303
 
                         % ('wrote', thread_id, len(bytes),
304
 
                            osutils.timer_func() - tstart))
305
299
 
306
300
 
307
301
class SmartServerPipeStreamMedium(SmartServerStreamMedium):
494
488
class _DebugCounter(object):
495
489
    """An object that counts the HPSS calls made to each client medium.
496
490
 
497
 
    When a medium is garbage-collected, or failing that when
498
 
    bzrlib.global_state exits, the total number of calls made on that medium
499
 
    are reported via trace.note.
 
491
    When a medium is garbage-collected, or failing that when atexit functions
 
492
    are run, the total number of calls made on that medium are reported via
 
493
    trace.note.
500
494
    """
501
495
 
502
496
    def __init__(self):
503
497
        self.counts = weakref.WeakKeyDictionary()
504
498
        client._SmartClient.hooks.install_named_hook(
505
499
            'call', self.increment_call_count, 'hpss call counter')
506
 
        bzrlib.global_state.cleanups.add_cleanup(self.flush_all)
 
500
        atexit.register(self.flush_all)
507
501
 
508
502
    def track(self, medium):
509
503
        """Start tracking calls made to a medium.
607
601
            # which is newer than a previously supplied older-than version.
608
602
            # This indicates that some smart verb call is not guarded
609
603
            # appropriately (it should simply not have been tried).
610
 
            trace.mutter(
 
604
            raise AssertionError(
611
605
                "_remember_remote_is_before(%r) called, but "
612
606
                "_remember_remote_is_before(%r) was called previously."
613
 
                , version_tuple, self._remote_version_is_before)
614
 
            if 'hpss' in debug.debug_flags:
615
 
                ui.ui_factory.show_warning(
616
 
                    "_remember_remote_is_before(%r) called, but "
617
 
                    "_remember_remote_is_before(%r) was called previously."
618
 
                    % (version_tuple, self._remote_version_is_before))
619
 
            return
 
607
                % (version_tuple, self._remote_version_is_before))
620
608
        self._remote_version_is_before = version_tuple
621
609
 
622
610
    def protocol_version(self):
733
721
 
734
722
    def _read_bytes(self, count):
735
723
        """See SmartClientStreamMedium._read_bytes."""
736
 
        bytes_to_read = min(count, _MAX_READ_SIZE)
737
 
        bytes = self._readable_pipe.read(bytes_to_read)
 
724
        bytes = self._readable_pipe.read(count)
738
725
        self._report_activity(len(bytes), 'read')
739
726
        return bytes
740
727
 
741
728
 
742
 
class SSHParams(object):
743
 
    """A set of parameters for starting a remote bzr via SSH."""
 
729
class SmartSSHClientMedium(SmartClientStreamMedium):
 
730
    """A client medium using SSH."""
744
731
 
745
732
    def __init__(self, host, port=None, username=None, password=None,
746
 
            bzr_remote_path='bzr'):
747
 
        self.host = host
748
 
        self.port = port
749
 
        self.username = username
750
 
        self.password = password
751
 
        self.bzr_remote_path = bzr_remote_path
752
 
 
753
 
 
754
 
class SmartSSHClientMedium(SmartClientStreamMedium):
755
 
    """A client medium using SSH.
756
 
    
757
 
    It delegates IO to a SmartClientSocketMedium or
758
 
    SmartClientAlreadyConnectedSocketMedium (depending on platform).
759
 
    """
760
 
 
761
 
    def __init__(self, base, ssh_params, vendor=None):
 
733
            base=None, vendor=None, bzr_remote_path=None):
762
734
        """Creates a client that will connect on the first use.
763
735
 
764
 
        :param ssh_params: A SSHParams instance.
765
736
        :param vendor: An optional override for the ssh vendor to use. See
766
737
            bzrlib.transport.ssh for details on ssh vendors.
767
738
        """
768
 
        self._real_medium = None
769
 
        self._ssh_params = ssh_params
770
 
        # for the benefit of progress making a short description of this
771
 
        # transport
772
 
        self._scheme = 'bzr+ssh'
 
739
        self._connected = False
 
740
        self._host = host
 
741
        self._password = password
 
742
        self._port = port
 
743
        self._username = username
773
744
        # SmartClientStreamMedium stores the repr of this object in its
774
745
        # _DebugCounter so we have to store all the values used in our repr
775
746
        # method before calling the super init.
776
747
        SmartClientStreamMedium.__init__(self, base)
 
748
        self._read_from = None
 
749
        self._ssh_connection = None
777
750
        self._vendor = vendor
778
 
        self._ssh_connection = None
 
751
        self._write_to = None
 
752
        self._bzr_remote_path = bzr_remote_path
 
753
        # for the benefit of progress making a short description of this
 
754
        # transport
 
755
        self._scheme = 'bzr+ssh'
779
756
 
780
757
    def __repr__(self):
781
 
        if self._ssh_params.port is None:
782
 
            maybe_port = ''
783
 
        else:
784
 
            maybe_port = ':%s' % self._ssh_params.port
785
 
        return "%s(%s://%s@%s%s/)" % (
 
758
        return "%s(connected=%r, username=%r, host=%r, port=%r)" % (
786
759
            self.__class__.__name__,
787
 
            self._scheme,
788
 
            self._ssh_params.username,
789
 
            self._ssh_params.host,
790
 
            maybe_port)
 
760
            self._connected,
 
761
            self._username,
 
762
            self._host,
 
763
            self._port)
791
764
 
792
765
    def _accept_bytes(self, bytes):
793
766
        """See SmartClientStreamMedium.accept_bytes."""
794
767
        self._ensure_connection()
795
 
        self._real_medium.accept_bytes(bytes)
 
768
        self._write_to.write(bytes)
 
769
        self._report_activity(len(bytes), 'write')
796
770
 
797
771
    def disconnect(self):
798
772
        """See SmartClientMedium.disconnect()."""
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
 
773
        if not self._connected:
 
774
            return
 
775
        self._read_from.close()
 
776
        self._write_to.close()
 
777
        self._ssh_connection.close()
 
778
        self._connected = False
805
779
 
806
780
    def _ensure_connection(self):
807
781
        """Connect this medium if not already connected."""
808
 
        if self._real_medium is not None:
 
782
        if self._connected:
809
783
            return
810
784
        if self._vendor is None:
811
785
            vendor = ssh._get_ssh_vendor()
812
786
        else:
813
787
            vendor = self._vendor
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',
 
788
        self._ssh_connection = vendor.connect_ssh(self._username,
 
789
                self._password, self._host, self._port,
 
790
                command=[self._bzr_remote_path, 'serve', '--inet',
818
791
                         '--directory=/', '--allow-writes'])
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)
827
 
        else:
828
 
            raise AssertionError(
829
 
                "Unexpected io_kind %r from %r"
830
 
                % (io_kind, self._ssh_connection))
 
792
        self._read_from, self._write_to = \
 
793
            self._ssh_connection.get_filelike_channels()
 
794
        self._connected = True
831
795
 
832
796
    def _flush(self):
833
797
        """See SmartClientStreamMedium._flush()."""
834
 
        self._real_medium._flush()
 
798
        self._write_to.flush()
835
799
 
836
800
    def _read_bytes(self, count):
837
801
        """See SmartClientStreamMedium.read_bytes."""
838
 
        if self._real_medium is None:
 
802
        if not self._connected:
839
803
            raise errors.MediumNotConnected(self)
840
 
        return self._real_medium.read_bytes(count)
 
804
        bytes_to_read = min(count, _MAX_READ_SIZE)
 
805
        bytes = self._read_from.read(bytes_to_read)
 
806
        self._report_activity(len(bytes), 'read')
 
807
        return bytes
841
808
 
842
809
 
843
810
# Port 4155 is the default port for bzr://, registered with IANA.
845
812
BZR_DEFAULT_PORT = 4155
846
813
 
847
814
 
848
 
class SmartClientSocketMedium(SmartClientStreamMedium):
849
 
    """A client medium using a socket.
850
 
    
851
 
    This class isn't usable directly.  Use one of its subclasses instead.
852
 
    """
 
815
class SmartTCPClientMedium(SmartClientStreamMedium):
 
816
    """A client medium using TCP."""
853
817
 
854
 
    def __init__(self, base):
 
818
    def __init__(self, host, port, base):
 
819
        """Creates a client that will connect on the first use."""
855
820
        SmartClientStreamMedium.__init__(self, base)
 
821
        self._connected = False
 
822
        self._host = host
 
823
        self._port = port
856
824
        self._socket = None
857
 
        self._connected = False
858
825
 
859
826
    def _accept_bytes(self, bytes):
860
827
        """See SmartClientMedium.accept_bytes."""
861
828
        self._ensure_connection()
862
829
        osutils.send_all(self._socket, bytes, self._report_activity)
863
830
 
864
 
    def _ensure_connection(self):
865
 
        """Connect this medium if not already connected."""
866
 
        raise NotImplementedError(self._ensure_connection)
867
 
 
868
 
    def _flush(self):
869
 
        """See SmartClientStreamMedium._flush().
870
 
 
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
873
 
        future.
874
 
        """
875
 
 
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)
882
 
 
883
831
    def disconnect(self):
884
832
        """See SmartClientMedium.disconnect()."""
885
833
        if not self._connected:
888
836
        self._socket = None
889
837
        self._connected = False
890
838
 
891
 
 
892
 
class SmartTCPClientMedium(SmartClientSocketMedium):
893
 
    """A client medium that creates a TCP connection."""
894
 
 
895
 
    def __init__(self, host, port, base):
896
 
        """Creates a client that will connect on the first use."""
897
 
        SmartClientSocketMedium.__init__(self, base)
898
 
        self._host = host
899
 
        self._port = port
900
 
 
901
839
    def _ensure_connection(self):
902
840
        """Connect this medium if not already connected."""
903
841
        if self._connected:
937
875
                    (self._host, port, err_msg))
938
876
        self._connected = True
939
877
 
940
 
 
941
 
class SmartClientAlreadyConnectedSocketMedium(SmartClientSocketMedium):
942
 
    """A client medium for an already connected socket.
943
 
    
944
 
    Note that this class will assume it "owns" the socket, so it will close it
945
 
    when its disconnect method is called.
946
 
    """
947
 
 
948
 
    def __init__(self, base, sock):
949
 
        SmartClientSocketMedium.__init__(self, base)
950
 
        self._socket = sock
951
 
        self._connected = True
952
 
 
953
 
    def _ensure_connection(self):
954
 
        # Already connected, by definition!  So nothing to do.
955
 
        pass
 
878
    def _flush(self):
 
879
        """See SmartClientStreamMedium._flush().
 
880
 
 
881
        For TCP we do no flushing. We may want to turn off TCP_NODELAY and
 
882
        add a means to do a flush, but that can be done in the future.
 
883
        """
 
884
 
 
885
    def _read_bytes(self, count):
 
886
        """See SmartClientMedium.read_bytes."""
 
887
        if not self._connected:
 
888
            raise errors.MediumNotConnected(self)
 
889
        return _read_bytes_from_socket(
 
890
            self._socket.recv, count, self._report_activity)
956
891
 
957
892
 
958
893
class SmartClientStreamMediumRequest(SmartClientMediumRequest):
995
930
        self._medium._flush()
996
931
 
997
932
 
 
933
def _read_bytes_from_socket(sock, desired_count, report_activity):
 
934
    # We ignore the desired_count because on sockets it's more efficient to
 
935
    # read large chunks (of _MAX_READ_SIZE bytes) at a time.
 
936
    try:
 
937
        bytes = osutils.until_no_eintr(sock, _MAX_READ_SIZE)
 
938
    except socket.error, e:
 
939
        if len(e.args) and e.args[0] in (errno.ECONNRESET, 10054):
 
940
            # The connection was closed by the other side.  Callers expect an
 
941
            # empty string to signal end-of-stream.
 
942
            bytes = ''
 
943
        else:
 
944
            raise
 
945
    else:
 
946
        report_activity(len(bytes), 'read')
 
947
    return bytes
 
948