13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
"""The 'medium' layer for the smart servers and clients.
31
32
from bzrlib.lazy_import import lazy_import
32
33
lazy_import(globals(), """
38
34
from bzrlib import (
46
from bzrlib.smart import client, protocol, request, vfs
40
from bzrlib.smart import protocol
47
41
from bzrlib.transport import ssh
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
45
# We must not read any more than 64k at a time so we don't risk "no buffer
46
# space available" errors on some platforms. Windows in particular is likely
47
# to give error 10053 or 10055 if we read more than 64k from a socket.
48
_MAX_READ_SIZE = 64 * 1024
57
51
def _get_protocol_factory_for_bytes(bytes):
58
52
"""Determine the right protocol factory for 'bytes'.
86
80
return protocol_factory, bytes
89
def _get_line(read_bytes_func):
90
"""Read bytes using read_bytes_func until a newline byte.
92
This isn't particularly efficient, so should only be used when the
93
expected size of the line is quite short.
95
:returns: a tuple of two strs: (line, excess)
99
while newline_pos == -1:
100
new_bytes = read_bytes_func(1)
103
# Ran out of bytes before receiving a complete line.
105
newline_pos = bytes.find('\n')
106
line = bytes[:newline_pos+1]
107
excess = bytes[newline_pos+1:]
111
83
class SmartMedium(object):
112
84
"""Base class for smart protocol media, both client- and server-side."""
114
86
def __init__(self):
115
87
self._push_back_buffer = None
117
89
def _push_back(self, bytes):
118
90
"""Return unused bytes to the medium, because they belong to the next
154
126
def _get_line(self):
155
127
"""Read bytes from this request's response until a newline byte.
157
129
This isn't particularly efficient, so should only be used when the
158
130
expected size of the line is quite short.
160
132
:returns: a string of bytes ending in a newline (byte 0x0A).
162
line, excess = _get_line(self.read_bytes)
163
self._push_back(excess)
136
while newline_pos == -1:
137
new_bytes = self.read_bytes(1)
140
# Ran out of bytes before receiving a complete line.
142
newline_pos = bytes.find('\n')
143
line = bytes[:newline_pos+1]
144
self._push_back(bytes[newline_pos+1:])
166
def _report_activity(self, bytes, direction):
167
"""Notify that this medium has activity.
169
Implementations should call this from all methods that actually do IO.
170
Be careful that it's not called twice, if one method is implemented on
173
:param bytes: Number of bytes read or written.
174
:param direction: 'read' or 'write' or None.
176
ui.ui_factory.report_transport_activity(self, bytes, direction)
179
148
class SmartServerStreamMedium(SmartMedium):
180
149
"""Handles smart commands coming over a stream.
274
243
def _serve_one_request_unguarded(self, protocol):
275
244
while protocol.next_read_size():
276
245
# 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)
246
# than _MAX_READ_SIZE ready, the socket wil just return a short
247
# read immediately rather than block.
248
bytes = self.read_bytes(_MAX_READ_SIZE)
281
250
self.finished = True
283
252
protocol.accept_bytes(bytes)
285
254
self._push_back(protocol.unused_data)
287
256
def _read_bytes(self, desired_count):
288
return osutils.read_bytes_from_socket(
289
self.socket, self._report_activity)
257
# We ignore the desired_count because on sockets it's more efficient to
258
# read large chunks (of _MAX_READ_SIZE bytes) at a time.
259
return self.socket.recv(_MAX_READ_SIZE)
291
261
def terminate_due_to_error(self):
292
262
# TODO: This should log to a server log file, but no such thing
295
265
self.finished = True
297
267
def _write_out(self, bytes):
298
tstart = osutils.timer_func()
299
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))
268
osutils.send_all(self.socket, bytes)
307
271
class SmartServerPipeStreamMedium(SmartServerStreamMedium):
467
431
read_bytes checks the state of the request to determing if bytes
468
432
should be read. After that it hands off to _read_bytes to do the
471
435
By default this forwards to self._medium.read_bytes because we are
472
436
operating on the medium's stream.
474
438
return self._medium.read_bytes(count)
476
440
def read_line(self):
477
line = self._read_line()
441
line = self._medium._get_line()
478
442
if not line.endswith('\n'):
479
443
# end of file encountered reading from server
480
444
raise errors.ConnectionReset(
481
"Unexpected end of message. Please check connectivity "
482
"and permissions, and report a bug if problems persist.")
445
"please check connectivity and permissions",
446
"(and try -Dhpss if further diagnosis is required)")
485
def _read_line(self):
486
"""Helper for SmartClientMediumRequest.read_line.
488
By default this forwards to self._medium._get_line because we are
489
operating on the medium's stream.
491
return self._medium._get_line()
494
class _DebugCounter(object):
495
"""An object that counts the HPSS calls made to each client medium.
497
When a medium is garbage-collected, or failing that when atexit functions
498
are run, the total number of calls made on that medium are reported via
503
self.counts = weakref.WeakKeyDictionary()
504
client._SmartClient.hooks.install_named_hook(
505
'call', self.increment_call_count, 'hpss call counter')
506
atexit.register(self.flush_all)
508
def track(self, medium):
509
"""Start tracking calls made to a medium.
511
This only keeps a weakref to the medium, so shouldn't affect the
514
medium_repr = repr(medium)
515
# Add this medium to the WeakKeyDictionary
516
self.counts[medium] = dict(count=0, vfs_count=0,
517
medium_repr=medium_repr)
518
# Weakref callbacks are fired in reverse order of their association
519
# with the referenced object. So we add a weakref *after* adding to
520
# the WeakKeyDict so that we can report the value from it before the
521
# entry is removed by the WeakKeyDict's own callback.
522
ref = weakref.ref(medium, self.done)
524
def increment_call_count(self, params):
525
# Increment the count in the WeakKeyDictionary
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
537
value = self.counts[ref]
538
count, vfs_count, medium_repr = (
539
value['count'], value['vfs_count'], value['medium_repr'])
540
# In case this callback is invoked for the same ref twice (by the
541
# weakref callback and by the atexit function), set the call count back
542
# to 0 so this item won't be reported twice.
544
value['vfs_count'] = 0
546
trace.note('HPSS calls: %d (%d vfs) %s',
547
count, vfs_count, medium_repr)
550
for ref in list(self.counts.keys()):
553
_debug_counter = None
556
450
class SmartClientMedium(SmartMedium):
557
451
"""Smart client is a medium for sending smart protocol requests over."""
567
461
# _remote_version_is_before tracks the bzr version the remote side
568
462
# can be based on what we've seen so far.
569
463
self._remote_version_is_before = None
570
# Install debug hook function if debug flag is set.
571
if 'hpss' in debug.debug_flags:
572
global _debug_counter
573
if _debug_counter is None:
574
_debug_counter = _DebugCounter()
575
_debug_counter.track(self)
577
465
def _is_remote_before(self, version_tuple):
578
466
"""Is it possible the remote side supports RPCs for a given version?
604
492
if (self._remote_version_is_before is not None and
605
493
version_tuple > self._remote_version_is_before):
606
# We have been told that the remote side is older than some version
607
# which is newer than a previously supplied older-than version.
608
# This indicates that some smart verb call is not guarded
609
# appropriately (it should simply not have been tried).
494
raise AssertionError(
611
495
"_remember_remote_is_before(%r) called, but "
612
496
"_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))
497
% (version_tuple, self._remote_version_is_before))
620
498
self._remote_version_is_before = version_tuple
622
500
def protocol_version(self):
714
592
class SmartSimplePipesClientMedium(SmartClientStreamMedium):
715
593
"""A client medium using simple pipes.
717
595
This client does not manage the pipes: it assumes they will always be open.
719
Note that if readable_pipe.read might raise IOError or OSError with errno
720
of EINTR, it must be safe to retry the read. Plain CPython fileobjects
721
(such as used for sys.stdin) are safe.
724
598
def __init__(self, readable_pipe, writeable_pipe, base):
738
611
def _read_bytes(self, count):
739
612
"""See SmartClientStreamMedium._read_bytes."""
740
bytes = osutils.until_no_eintr(self._readable_pipe.read, count)
741
self._report_activity(len(bytes), 'read')
613
return self._readable_pipe.read(count)
745
616
class SmartSSHClientMedium(SmartClientStreamMedium):
746
617
"""A client medium using SSH."""
748
619
def __init__(self, host, port=None, username=None, password=None,
749
620
base=None, vendor=None, bzr_remote_path=None):
750
621
"""Creates a client that will connect on the first use.
752
623
:param vendor: An optional override for the ssh vendor to use. See
753
624
bzrlib.transport.ssh for details on ssh vendors.
626
SmartClientStreamMedium.__init__(self, base)
755
627
self._connected = False
756
628
self._host = host
757
629
self._password = password
758
630
self._port = port
759
631
self._username = username
760
# for the benefit of progress making a short description of this
762
self._scheme = 'bzr+ssh'
763
# SmartClientStreamMedium stores the repr of this object in its
764
# _DebugCounter so we have to store all the values used in our repr
765
# method before calling the super init.
766
SmartClientStreamMedium.__init__(self, base)
767
632
self._read_from = None
768
633
self._ssh_connection = None
769
634
self._vendor = vendor
770
635
self._write_to = None
771
636
self._bzr_remote_path = bzr_remote_path
774
if self._port is None:
777
maybe_port = ':%s' % self._port
778
return "%s(%s://%s@%s%s/)" % (
779
self.__class__.__name__,
637
if self._bzr_remote_path is None:
638
symbol_versioning.warn(
639
'bzr_remote_path is required as of bzr 0.92',
640
DeprecationWarning, stacklevel=2)
641
self._bzr_remote_path = os.environ.get('BZR_REMOTE_PATH', 'bzr')
785
643
def _accept_bytes(self, bytes):
786
644
"""See SmartClientStreamMedium.accept_bytes."""
787
645
self._ensure_connection()
788
646
self._write_to.write(bytes)
789
self._report_activity(len(bytes), 'write')
791
648
def disconnect(self):
792
649
"""See SmartClientMedium.disconnect()."""
822
679
if not self._connected:
823
680
raise errors.MediumNotConnected(self)
824
681
bytes_to_read = min(count, _MAX_READ_SIZE)
825
bytes = self._read_from.read(bytes_to_read)
826
self._report_activity(len(bytes), 'read')
682
return self._read_from.read(bytes_to_read)
830
685
# Port 4155 is the default port for bzr://, registered with IANA.
831
BZR_DEFAULT_INTERFACE = None
686
BZR_DEFAULT_INTERFACE = '0.0.0.0'
832
687
BZR_DEFAULT_PORT = 4155
835
690
class SmartTCPClientMedium(SmartClientStreamMedium):
836
691
"""A client medium using TCP."""
838
693
def __init__(self, host, port, base):
839
694
"""Creates a client that will connect on the first use."""
840
695
SmartClientStreamMedium.__init__(self, base)
860
715
"""Connect this medium if not already connected."""
861
716
if self._connected:
718
self._socket = socket.socket()
719
self._socket.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
863
720
if self._port is None:
864
721
port = BZR_DEFAULT_PORT
866
723
port = int(self._port)
868
sockaddrs = socket.getaddrinfo(self._host, port, socket.AF_UNSPEC,
869
socket.SOCK_STREAM, 0, 0)
870
except socket.gaierror, (err_num, err_msg):
871
raise errors.ConnectionError("failed to lookup %s:%d: %s" %
872
(self._host, port, err_msg))
873
# Initialize err in case there are no addresses returned:
874
err = socket.error("no address found for %s" % self._host)
875
for (family, socktype, proto, canonname, sockaddr) in sockaddrs:
877
self._socket = socket.socket(family, socktype, proto)
878
self._socket.setsockopt(socket.IPPROTO_TCP,
879
socket.TCP_NODELAY, 1)
880
self._socket.connect(sockaddr)
881
except socket.error, err:
882
if self._socket is not None:
887
if self._socket is None:
725
self._socket.connect((self._host, port))
726
except socket.error, err:
888
727
# socket errors either have a (string) or (errno, string) as their
890
729
if type(err.args) is str:
added
removed
bzrlib/smart/medium.py
