← 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-16 07:42:21 UTC
  • mfrom: (4466.1.4 spurious-stacking-warning)
  • Revision ID: pqm@pqm.ubuntu.com-20090716074221-a8ydf0c5tg54k35c
(andrew) Fix spurious 'does not support stacking' warning when
        pushing.

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.
525
519
        # Increment the count in the WeakKeyDictionary
526
520
        value = self.counts[params.medium]
527
521
        value['count'] += 1
528
 
        try:
529
 
            request_method = request.request_handlers.get(params.method)
530
 
        except KeyError:
531
 
            # A method we don't know about doesn't count as a VFS method.
532
 
            return
 
522
        request_method = request.request_handlers.get(params.method)
533
523
        if issubclass(request_method, vfs.VfsRequest):
534
524
            value['vfs_count'] += 1
535
525
 
607
597
            # which is newer than a previously supplied older-than version.
608
598
            # This indicates that some smart verb call is not guarded
609
599
            # appropriately (it should simply not have been tried).
610
 
            trace.mutter(
 
600
            raise AssertionError(
611
601
                "_remember_remote_is_before(%r) called, but "
612
602
                "_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
 
603
                % (version_tuple, self._remote_version_is_before))
620
604
        self._remote_version_is_before = version_tuple
621
605
 
622
606
    def protocol_version(self):
733
717
 
734
718
    def _read_bytes(self, count):
735
719
        """See SmartClientStreamMedium._read_bytes."""
736
 
        bytes_to_read = min(count, _MAX_READ_SIZE)
737
 
        bytes = self._readable_pipe.read(bytes_to_read)
 
720
        bytes = self._readable_pipe.read(count)
738
721
        self._report_activity(len(bytes), 'read')
739
722
        return bytes
740
723
 
741
724
 
742
 
class SSHParams(object):
743
 
    """A set of parameters for starting a remote bzr via SSH."""
 
725
class SmartSSHClientMedium(SmartClientStreamMedium):
 
726
    """A client medium using SSH."""
744
727
 
745
728
    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):
 
729
            base=None, vendor=None, bzr_remote_path=None):
762
730
        """Creates a client that will connect on the first use.
763
731
 
764
 
        :param ssh_params: A SSHParams instance.
765
732
        :param vendor: An optional override for the ssh vendor to use. See
766
733
            bzrlib.transport.ssh for details on ssh vendors.
767
734
        """
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'
 
735
        self._connected = False
 
736
        self._host = host
 
737
        self._password = password
 
738
        self._port = port
 
739
        self._username = username
773
740
        # SmartClientStreamMedium stores the repr of this object in its
774
741
        # _DebugCounter so we have to store all the values used in our repr
775
742
        # method before calling the super init.
776
743
        SmartClientStreamMedium.__init__(self, base)
 
744
        self._read_from = None
 
745
        self._ssh_connection = None
777
746
        self._vendor = vendor
778
 
        self._ssh_connection = None
 
747
        self._write_to = None
 
748
        self._bzr_remote_path = bzr_remote_path
 
749
        # for the benefit of progress making a short description of this
 
750
        # transport
 
751
        self._scheme = 'bzr+ssh'
779
752
 
780
753
    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/)" % (
 
754
        return "%s(connected=%r, username=%r, host=%r, port=%r)" % (
786
755
            self.__class__.__name__,
787
 
            self._scheme,
788
 
            self._ssh_params.username,
789
 
            self._ssh_params.host,
790
 
            maybe_port)
 
756
            self._connected,
 
757
            self._username,
 
758
            self._host,
 
759
            self._port)
791
760
 
792
761
    def _accept_bytes(self, bytes):
793
762
        """See SmartClientStreamMedium.accept_bytes."""
794
763
        self._ensure_connection()
795
 
        self._real_medium.accept_bytes(bytes)
 
764
        self._write_to.write(bytes)
 
765
        self._report_activity(len(bytes), 'write')
796
766
 
797
767
    def disconnect(self):
798
768
        """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
 
769
        if not self._connected:
 
770
            return
 
771
        self._read_from.close()
 
772
        self._write_to.close()
 
773
        self._ssh_connection.close()
 
774
        self._connected = False
805
775
 
806
776
    def _ensure_connection(self):
807
777
        """Connect this medium if not already connected."""
808
 
        if self._real_medium is not None:
 
778
        if self._connected:
809
779
            return
810
780
        if self._vendor is None:
811
781
            vendor = ssh._get_ssh_vendor()
812
782
        else:
813
783
            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',
 
784
        self._ssh_connection = vendor.connect_ssh(self._username,
 
785
                self._password, self._host, self._port,
 
786
                command=[self._bzr_remote_path, 'serve', '--inet',
818
787
                         '--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))
 
788
        self._read_from, self._write_to = \
 
789
            self._ssh_connection.get_filelike_channels()
 
790
        self._connected = True
831
791
 
832
792
    def _flush(self):
833
793
        """See SmartClientStreamMedium._flush()."""
834
 
        self._real_medium._flush()
 
794
        self._write_to.flush()
835
795
 
836
796
    def _read_bytes(self, count):
837
797
        """See SmartClientStreamMedium.read_bytes."""
838
 
        if self._real_medium is None:
 
798
        if not self._connected:
839
799
            raise errors.MediumNotConnected(self)
840
 
        return self._real_medium.read_bytes(count)
 
800
        bytes_to_read = min(count, _MAX_READ_SIZE)
 
801
        bytes = self._read_from.read(bytes_to_read)
 
802
        self._report_activity(len(bytes), 'read')
 
803
        return bytes
841
804
 
842
805
 
843
806
# Port 4155 is the default port for bzr://, registered with IANA.
845
808
BZR_DEFAULT_PORT = 4155
846
809
 
847
810
 
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
 
    """
 
811
class SmartTCPClientMedium(SmartClientStreamMedium):
 
812
    """A client medium using TCP."""
853
813
 
854
 
    def __init__(self, base):
 
814
    def __init__(self, host, port, base):
 
815
        """Creates a client that will connect on the first use."""
855
816
        SmartClientStreamMedium.__init__(self, base)
 
817
        self._connected = False
 
818
        self._host = host
 
819
        self._port = port
856
820
        self._socket = None
857
 
        self._connected = False
858
821
 
859
822
    def _accept_bytes(self, bytes):
860
823
        """See SmartClientMedium.accept_bytes."""
861
824
        self._ensure_connection()
862
825
        osutils.send_all(self._socket, bytes, self._report_activity)
863
826
 
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
827
    def disconnect(self):
884
828
        """See SmartClientMedium.disconnect()."""
885
829
        if not self._connected:
888
832
        self._socket = None
889
833
        self._connected = False
890
834
 
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
835
    def _ensure_connection(self):
902
836
        """Connect this medium if not already connected."""
903
837
        if self._connected:
937
871
                    (self._host, port, err_msg))
938
872
        self._connected = True
939
873
 
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
 
874
    def _flush(self):
 
875
        """See SmartClientStreamMedium._flush().
 
876
 
 
877
        For TCP we do no flushing. We may want to turn off TCP_NODELAY and
 
878
        add a means to do a flush, but that can be done in the future.
 
879
        """
 
880
 
 
881
    def _read_bytes(self, count):
 
882
        """See SmartClientMedium.read_bytes."""
 
883
        if not self._connected:
 
884
            raise errors.MediumNotConnected(self)
 
885
        return _read_bytes_from_socket(
 
886
            self._socket.recv, count, self._report_activity)
956
887
 
957
888
 
958
889
class SmartClientStreamMediumRequest(SmartClientMediumRequest):
995
926
        self._medium._flush()
996
927
 
997
928
 
 
929
def _read_bytes_from_socket(sock, desired_count, report_activity):
 
930
    # We ignore the desired_count because on sockets it's more efficient to
 
931
    # read large chunks (of _MAX_READ_SIZE bytes) at a time.
 
932
    try:
 
933
        bytes = osutils.until_no_eintr(sock, _MAX_READ_SIZE)
 
934
    except socket.error, e:
 
935
        if len(e.args) and e.args[0] in (errno.ECONNRESET, 10054):
 
936
            # The connection was closed by the other side.  Callers expect an
 
937
            # empty string to signal end-of-stream.
 
938
            bytes = ''
 
939
        else:
 
940
            raise
 
941
    else:
 
942
        report_activity(len(bytes), 'read')
 
943
    return bytes
 
944