31
from bzrlib.lazy_import import lazy_import
32
lazy_import(globals(), """
38
31
from bzrlib import (
46
from bzrlib.smart import client, protocol, request, vfs
36
from bzrlib.smart.protocol import (
37
MESSAGE_VERSION_THREE,
39
SmartClientRequestProtocolOne,
40
SmartServerRequestProtocolOne,
41
SmartServerRequestProtocolTwo,
42
build_server_protocol_three
47
44
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
57
47
def _get_protocol_factory_for_bytes(bytes):
58
48
"""Determine the right protocol factory for 'bytes'.
75
65
root_client_path. unused_bytes are any bytes that were not part of a
76
66
protocol version marker.
78
if bytes.startswith(protocol.MESSAGE_VERSION_THREE):
79
protocol_factory = protocol.build_server_protocol_three
80
bytes = bytes[len(protocol.MESSAGE_VERSION_THREE):]
81
elif bytes.startswith(protocol.REQUEST_VERSION_TWO):
82
protocol_factory = protocol.SmartServerRequestProtocolTwo
83
bytes = bytes[len(protocol.REQUEST_VERSION_TWO):]
68
if bytes.startswith(MESSAGE_VERSION_THREE):
69
protocol_factory = build_server_protocol_three
70
bytes = bytes[len(MESSAGE_VERSION_THREE):]
71
elif bytes.startswith(REQUEST_VERSION_TWO):
72
protocol_factory = SmartServerRequestProtocolTwo
73
bytes = bytes[len(REQUEST_VERSION_TWO):]
85
protocol_factory = protocol.SmartServerRequestProtocolOne
75
protocol_factory = SmartServerRequestProtocolOne
86
76
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
class SmartMedium(object):
112
"""Base class for smart protocol media, both client- and server-side."""
115
self._push_back_buffer = None
117
def _push_back(self, bytes):
118
"""Return unused bytes to the medium, because they belong to the next
121
This sets the _push_back_buffer to the given bytes.
123
if self._push_back_buffer is not None:
124
raise AssertionError(
125
"_push_back called when self._push_back_buffer is %r"
126
% (self._push_back_buffer,))
129
self._push_back_buffer = bytes
131
def _get_push_back_buffer(self):
132
if self._push_back_buffer == '':
133
raise AssertionError(
134
'%s._push_back_buffer should never be the empty string, '
135
'which can be confused with EOF' % (self,))
136
bytes = self._push_back_buffer
137
self._push_back_buffer = None
140
def read_bytes(self, desired_count):
141
"""Read some bytes from this medium.
143
:returns: some bytes, possibly more or less than the number requested
144
in 'desired_count' depending on the medium.
146
if self._push_back_buffer is not None:
147
return self._get_push_back_buffer()
148
bytes_to_read = min(desired_count, _MAX_READ_SIZE)
149
return self._read_bytes(bytes_to_read)
151
def _read_bytes(self, count):
152
raise NotImplementedError(self._read_bytes)
155
"""Read bytes from this request's response until a newline byte.
157
This isn't particularly efficient, so should only be used when the
158
expected size of the line is quite short.
160
:returns: a string of bytes ending in a newline (byte 0x0A).
162
line, excess = _get_line(self.read_bytes)
163
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
class SmartServerStreamMedium(SmartMedium):
79
class SmartServerStreamMedium(object):
180
80
"""Handles smart commands coming over a stream.
182
82
The stream may be a pipe connected to sshd, or a tcp socket, or an
203
103
self.backing_transport = backing_transport
204
104
self.root_client_path = root_client_path
205
105
self.finished = False
206
SmartMedium.__init__(self)
106
self._push_back_buffer = None
108
def _push_back(self, bytes):
109
"""Return unused bytes to the medium, because they belong to the next
112
This sets the _push_back_buffer to the given bytes.
114
if self._push_back_buffer is not None:
115
raise AssertionError(
116
"_push_back called when self._push_back_buffer is %r"
117
% (self._push_back_buffer,))
120
self._push_back_buffer = bytes
122
def _get_push_back_buffer(self):
123
if self._push_back_buffer == '':
124
raise AssertionError(
125
'%s._push_back_buffer should never be the empty string, '
126
'which can be confused with EOF' % (self,))
127
bytes = self._push_back_buffer
128
self._push_back_buffer = None
209
132
"""Serve requests until the client disconnects."""
250
173
"""Called when an unhandled exception from the protocol occurs."""
251
174
raise NotImplementedError(self.terminate_due_to_error)
253
def _read_bytes(self, desired_count):
176
def _get_bytes(self, desired_count):
254
177
"""Get some bytes from the medium.
256
179
:param desired_count: number of bytes we want to read.
258
raise NotImplementedError(self._read_bytes)
181
raise NotImplementedError(self._get_bytes)
184
"""Read bytes from this request's response until a newline byte.
186
This isn't particularly efficient, so should only be used when the
187
expected size of the line is quite short.
189
:returns: a string of bytes ending in a newline (byte 0x0A).
193
while newline_pos == -1:
194
new_bytes = self._get_bytes(1)
197
# Ran out of bytes before receiving a complete line.
199
newline_pos = bytes.find('\n')
200
line = bytes[:newline_pos+1]
201
self._push_back(bytes[newline_pos+1:])
261
205
class SmartServerSocketStreamMedium(SmartServerStreamMedium):
274
218
def _serve_one_request_unguarded(self, protocol):
275
219
while protocol.next_read_size():
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)
220
bytes = self._get_bytes(4096)
281
222
self.finished = True
283
224
protocol.accept_bytes(bytes)
285
226
self._push_back(protocol.unused_data)
287
def _read_bytes(self, desired_count):
288
return osutils.read_bytes_from_socket(
289
self.socket, self._report_activity)
228
def _get_bytes(self, desired_count):
229
if self._push_back_buffer is not None:
230
return self._get_push_back_buffer()
231
# We ignore the desired_count because on sockets it's more efficient to
233
return self.socket.recv(4096)
291
235
def terminate_due_to_error(self):
292
236
# TODO: This should log to a server log file, but no such thing
293
237
# exists yet. Andrew Bennetts 2006-09-29.
295
239
self.finished = True
297
241
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))
242
osutils.send_all(self.socket, bytes)
307
245
class SmartServerPipeStreamMedium(SmartServerStreamMedium):
462
399
return self._read_bytes(count)
464
401
def _read_bytes(self, count):
465
"""Helper for SmartClientMediumRequest.read_bytes.
402
"""Helper for read_bytes.
467
404
read_bytes checks the state of the request to determing if bytes
468
405
should be read. After that it hands off to _read_bytes to do the
471
By default this forwards to self._medium.read_bytes because we are
472
operating on the medium's stream.
474
return self._medium.read_bytes(count)
408
raise NotImplementedError(self._read_bytes)
476
410
def read_line(self):
477
line = self._read_line()
478
if not line.endswith('\n'):
479
# end of file encountered reading from server
480
raise errors.ConnectionReset(
481
"Unexpected end of message. Please check connectivity "
482
"and permissions, and report a bug if problems persist.")
411
"""Read bytes from this request's response until a newline byte.
413
This isn't particularly efficient, so should only be used when the
414
expected size of the line is quite short.
416
:returns: a string of bytes ending in a newline (byte 0x0A).
418
# XXX: this duplicates SmartClientRequestProtocolOne._recv_tuple
420
while not line or line[-1] != '\n':
421
new_char = self.read_bytes(1)
424
# end of file encountered reading from server
425
raise errors.ConnectionReset(
426
"please check connectivity and permissions",
427
"(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
class SmartClientMedium(SmartMedium):
431
class SmartClientMedium(object):
557
432
"""Smart client is a medium for sending smart protocol requests over."""
559
434
def __init__(self, base):
562
437
self._protocol_version_error = None
563
438
self._protocol_version = None
564
439
self._done_hello = False
565
# Be optimistic: we assume the remote end can accept new remote
566
# requests until we get an error saying otherwise.
567
# _remote_version_is_before tracks the bzr version the remote side
568
# can be based on what we've seen so far.
569
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
def _is_remote_before(self, version_tuple):
578
"""Is it possible the remote side supports RPCs for a given version?
582
needed_version = (1, 2)
583
if medium._is_remote_before(needed_version):
584
fallback_to_pre_1_2_rpc()
588
except UnknownSmartMethod:
589
medium._remember_remote_is_before(needed_version)
590
fallback_to_pre_1_2_rpc()
592
:seealso: _remember_remote_is_before
594
if self._remote_version_is_before is None:
595
# So far, the remote side seems to support everything
597
return version_tuple >= self._remote_version_is_before
599
def _remember_remote_is_before(self, version_tuple):
600
"""Tell this medium that the remote side is older the given version.
602
:seealso: _is_remote_before
604
if (self._remote_version_is_before is not None and
605
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).
611
"_remember_remote_is_before(%r) called, but "
612
"_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))
620
self._remote_version_is_before = version_tuple
622
441
def protocol_version(self):
623
442
"""Find out if 'hello' smart request works."""
657
476
def disconnect(self):
658
477
"""If this medium maintains a persistent connection, close it.
660
479
The default implementation does nothing.
663
def remote_path_from_transport(self, transport):
664
"""Convert transport into a path suitable for using in a request.
666
Note that the resulting remote path doesn't encode the host name or
667
anything but path, so it is only safe to use it in requests sent over
668
the medium from the matching transport.
670
medium_base = urlutils.join(self.base, '/')
671
rel_url = urlutils.relative_url(medium_base, transport.base)
672
return urllib.unquote(rel_url)
675
483
class SmartClientStreamMedium(SmartClientMedium):
676
484
"""Stream based medium common class.
711
523
return SmartClientStreamMediumRequest(self)
525
def read_bytes(self, count):
526
return self._read_bytes(count)
714
529
class SmartSimplePipesClientMedium(SmartClientStreamMedium):
715
530
"""A client medium using simple pipes.
717
532
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
535
def __init__(self, readable_pipe, writeable_pipe, base):
738
548
def _read_bytes(self, count):
739
549
"""See SmartClientStreamMedium._read_bytes."""
740
bytes = osutils.until_no_eintr(self._readable_pipe.read, count)
741
self._report_activity(len(bytes), 'read')
550
return self._readable_pipe.read(count)
745
553
class SmartSSHClientMedium(SmartClientStreamMedium):
746
554
"""A client medium using SSH."""
748
556
def __init__(self, host, port=None, username=None, password=None,
749
557
base=None, vendor=None, bzr_remote_path=None):
750
558
"""Creates a client that will connect on the first use.
752
560
:param vendor: An optional override for the ssh vendor to use. See
753
561
bzrlib.transport.ssh for details on ssh vendors.
563
SmartClientStreamMedium.__init__(self, base)
755
564
self._connected = False
756
565
self._host = host
757
566
self._password = password
758
567
self._port = port
759
568
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
569
self._read_from = None
768
570
self._ssh_connection = None
769
571
self._vendor = vendor
770
572
self._write_to = None
771
573
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__,
574
if self._bzr_remote_path is None:
575
symbol_versioning.warn(
576
'bzr_remote_path is required as of bzr 0.92',
577
DeprecationWarning, stacklevel=2)
578
self._bzr_remote_path = os.environ.get('BZR_REMOTE_PATH', 'bzr')
785
580
def _accept_bytes(self, bytes):
786
581
"""See SmartClientStreamMedium.accept_bytes."""
787
582
self._ensure_connection()
788
583
self._write_to.write(bytes)
789
self._report_activity(len(bytes), 'write')
791
585
def disconnect(self):
792
586
"""See SmartClientMedium.disconnect()."""
821
615
"""See SmartClientStreamMedium.read_bytes."""
822
616
if not self._connected:
823
617
raise errors.MediumNotConnected(self)
824
bytes_to_read = min(count, _MAX_READ_SIZE)
825
bytes = self._read_from.read(bytes_to_read)
826
self._report_activity(len(bytes), 'read')
618
return self._read_from.read(count)
830
621
# Port 4155 is the default port for bzr://, registered with IANA.
831
BZR_DEFAULT_INTERFACE = None
622
BZR_DEFAULT_INTERFACE = '0.0.0.0'
832
623
BZR_DEFAULT_PORT = 4155
835
626
class SmartTCPClientMedium(SmartClientStreamMedium):
836
627
"""A client medium using TCP."""
838
629
def __init__(self, host, port, base):
839
630
"""Creates a client that will connect on the first use."""
840
631
SmartClientStreamMedium.__init__(self, base)
860
651
"""Connect this medium if not already connected."""
861
652
if self._connected:
654
self._socket = socket.socket()
655
self._socket.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
863
656
if self._port is None:
864
657
port = BZR_DEFAULT_PORT
866
659
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:
661
self._socket.connect((self._host, port))
662
except socket.error, err:
888
663
# socket errors either have a (string) or (errno, string) as their
890
665
if type(err.args) is str:
added
removed
bzrlib/smart/medium.py
