1
# Copyright (C) 2006-2010 Canonical Ltd
1
# Copyright (C) 2006 Canonical Ltd
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
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.
24
24
bzrlib/transport/smart/__init__.py.
31
33
from bzrlib.lazy_import import lazy_import
32
34
lazy_import(globals(), """
38
37
from bzrlib import (
46
from bzrlib.smart import client, protocol, request, vfs
45
from bzrlib.smart import client, protocol
47
46
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
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
57
56
def _get_protocol_factory_for_bytes(bytes):
58
57
"""Determine the right protocol factory for 'bytes'.
163
162
self._push_back(excess)
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
166
class SmartServerStreamMedium(SmartMedium):
180
167
"""Handles smart commands coming over a stream.
274
261
def _serve_one_request_unguarded(self, protocol):
275
262
while protocol.next_read_size():
276
263
# 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)
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)
281
268
self.finished = True
285
272
self._push_back(protocol.unused_data)
287
274
def _read_bytes(self, desired_count):
288
return osutils.read_bytes_from_socket(
289
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)
291
279
def terminate_due_to_error(self):
292
280
# TODO: This should log to a server log file, but no such thing
295
283
self.finished = True
297
285
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))
286
osutils.send_all(self.socket, bytes)
307
289
class SmartServerPipeStreamMedium(SmartServerStreamMedium):
384
366
def accept_bytes(self, bytes):
385
367
"""Accept bytes for inclusion in this request.
387
This method may not be called after finished_writing() has been
369
This method may not be be called after finished_writing() has been
388
370
called. It depends upon the Medium whether or not the bytes will be
389
371
immediately transmitted. Message based Mediums will tend to buffer the
390
372
bytes until finished_writing() is called.
478
460
if not line.endswith('\n'):
479
461
# end of file encountered reading from server
480
462
raise errors.ConnectionReset(
481
"Unexpected end of message. Please check connectivity "
482
"and permissions, and report a bug if problems persist.")
463
"please check connectivity and permissions")
485
466
def _read_line(self):
514
495
medium_repr = repr(medium)
515
496
# Add this medium to the WeakKeyDictionary
516
self.counts[medium] = dict(count=0, vfs_count=0,
517
medium_repr=medium_repr)
497
self.counts[medium] = [0, medium_repr]
518
498
# Weakref callbacks are fired in reverse order of their association
519
499
# with the referenced object. So we add a weakref *after* adding to
520
500
# the WeakKeyDict so that we can report the value from it before the
524
504
def increment_call_count(self, params):
525
505
# Increment the count in the WeakKeyDictionary
526
506
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
536
509
def done(self, ref):
537
510
value = self.counts[ref]
538
count, vfs_count, medium_repr = (
539
value['count'], value['vfs_count'], value['medium_repr'])
511
count, medium_repr = value
540
512
# In case this callback is invoked for the same ref twice (by the
541
513
# weakref callback and by the atexit function), set the call count back
542
514
# 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)
517
trace.note('HPSS calls: %d %s', count, medium_repr)
549
519
def flush_all(self):
550
520
for ref in list(self.counts.keys()):
607
577
# which is newer than a previously supplied older-than version.
608
578
# This indicates that some smart verb call is not guarded
609
579
# appropriately (it should simply not have been tried).
580
raise AssertionError(
611
581
"_remember_remote_is_before(%r) called, but "
612
582
"_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))
583
% (version_tuple, self._remote_version_is_before))
620
584
self._remote_version_is_before = version_tuple
622
586
def protocol_version(self):
715
679
"""A client medium using simple pipes.
717
681
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
684
def __init__(self, readable_pipe, writeable_pipe, base):
729
689
def _accept_bytes(self, bytes):
730
690
"""See SmartClientStreamMedium.accept_bytes."""
731
691
self._writeable_pipe.write(bytes)
732
self._report_activity(len(bytes), 'write')
734
693
def _flush(self):
735
694
"""See SmartClientStreamMedium._flush()."""
738
697
def _read_bytes(self, count):
739
698
"""See SmartClientStreamMedium._read_bytes."""
740
bytes = osutils.until_no_eintr(self._readable_pipe.read, count)
741
self._report_activity(len(bytes), 'read')
699
return self._readable_pipe.read(count)
745
702
class SmartSSHClientMedium(SmartClientStreamMedium):
752
709
:param vendor: An optional override for the ssh vendor to use. See
753
710
bzrlib.transport.ssh for details on ssh vendors.
712
SmartClientStreamMedium.__init__(self, base)
755
713
self._connected = False
756
714
self._host = host
757
715
self._password = password
758
716
self._port = port
759
717
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
718
self._read_from = None
768
719
self._ssh_connection = None
769
720
self._vendor = vendor
770
721
self._write_to = None
771
722
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__,
723
if self._bzr_remote_path is None:
724
symbol_versioning.warn(
725
'bzr_remote_path is required as of bzr 0.92',
726
DeprecationWarning, stacklevel=2)
727
self._bzr_remote_path = os.environ.get('BZR_REMOTE_PATH', 'bzr')
785
729
def _accept_bytes(self, bytes):
786
730
"""See SmartClientStreamMedium.accept_bytes."""
787
731
self._ensure_connection()
788
732
self._write_to.write(bytes)
789
self._report_activity(len(bytes), 'write')
791
734
def disconnect(self):
792
735
"""See SmartClientMedium.disconnect()."""
822
765
if not self._connected:
823
766
raise errors.MediumNotConnected(self)
824
767
bytes_to_read = min(count, _MAX_READ_SIZE)
825
bytes = self._read_from.read(bytes_to_read)
826
self._report_activity(len(bytes), 'read')
768
return self._read_from.read(bytes_to_read)
830
771
# Port 4155 is the default port for bzr://, registered with IANA.
846
787
def _accept_bytes(self, bytes):
847
788
"""See SmartClientMedium.accept_bytes."""
848
789
self._ensure_connection()
849
osutils.send_all(self._socket, bytes, self._report_activity)
790
osutils.send_all(self._socket, bytes)
851
792
def disconnect(self):
852
793
"""See SmartClientMedium.disconnect()."""
906
847
"""See SmartClientMedium.read_bytes."""
907
848
if not self._connected:
908
849
raise errors.MediumNotConnected(self)
909
return osutils.read_bytes_from_socket(
910
self._socket, self._report_activity)
850
# We ignore the desired_count because on sockets it's more efficient to
851
# read large chunks (of _MAX_READ_SIZE bytes) at a time.
853
return self._socket.recv(_MAX_READ_SIZE)
854
except socket.error, e:
855
if len(e.args) and e.args[0] == errno.ECONNRESET:
856
# Callers expect an empty string in that case
913
862
class SmartClientStreamMediumRequest(SmartClientMediumRequest):
added
removed
bzrlib/smart/medium.py
