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 (
38
SmartClientRequestProtocolOne,
39
SmartServerRequestProtocolOne,
40
SmartServerRequestProtocolTwo,
47
42
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
def _get_protocol_factory_for_bytes(bytes):
58
"""Determine the right protocol factory for 'bytes'.
60
This will return an appropriate protocol factory depending on the version
61
of the protocol being used, as determined by inspecting the given bytes.
62
The bytes should have at least one newline byte (i.e. be a whole line),
63
otherwise it's possible that a request will be incorrectly identified as
66
Typical use would be::
68
factory, unused_bytes = _get_protocol_factory_for_bytes(bytes)
69
server_protocol = factory(transport, write_func, root_client_path)
70
server_protocol.accept_bytes(unused_bytes)
72
:param bytes: a str of bytes of the start of the request.
73
:returns: 2-tuple of (protocol_factory, unused_bytes). protocol_factory is
74
a callable that takes three args: transport, write_func,
75
root_client_path. unused_bytes are any bytes that were not part of a
76
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):]
85
protocol_factory = protocol.SmartServerRequestProtocolOne
86
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):
45
class SmartServerStreamMedium(object):
180
46
"""Handles smart commands coming over a stream.
182
48
The stream may be a pipe connected to sshd, or a tcp socket, or an
250
121
"""Called when an unhandled exception from the protocol occurs."""
251
122
raise NotImplementedError(self.terminate_due_to_error)
253
def _read_bytes(self, desired_count):
124
def _get_bytes(self, desired_count):
254
125
"""Get some bytes from the medium.
256
127
:param desired_count: number of bytes we want to read.
258
raise NotImplementedError(self._read_bytes)
129
raise NotImplementedError(self._get_bytes)
132
"""Read bytes from this request's response until a newline byte.
134
This isn't particularly efficient, so should only be used when the
135
expected size of the line is quite short.
137
:returns: a string of bytes ending in a newline (byte 0x0A).
141
while newline_pos == -1:
142
new_bytes = self._get_bytes(1)
145
# Ran out of bytes before receiving a complete line.
147
newline_pos = bytes.find('\n')
148
line = bytes[:newline_pos+1]
149
self._push_back(bytes[newline_pos+1:])
261
153
class SmartServerSocketStreamMedium(SmartServerStreamMedium):
263
def __init__(self, sock, backing_transport, root_client_path='/'):
155
def __init__(self, sock, backing_transport):
266
158
:param sock: the socket the server will read from. It will be put
267
159
into blocking mode.
269
SmartServerStreamMedium.__init__(
270
self, backing_transport, root_client_path=root_client_path)
161
SmartServerStreamMedium.__init__(self, backing_transport)
271
162
sock.setblocking(True)
272
163
self.socket = sock
274
165
def _serve_one_request_unguarded(self, protocol):
275
166
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)
283
protocol.accept_bytes(bytes)
285
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)
168
protocol.accept_bytes(self.push_back)
169
self.push_back = None
171
bytes = self._get_bytes(4096)
175
protocol.accept_bytes(bytes)
177
self._push_back(protocol.excess_buffer)
179
def _get_bytes(self, desired_count):
180
# We ignore the desired_count because on sockets it's more efficient to
182
if self.push_back is not None:
183
assert self.push_back != '', (
184
'self.push_back should never be the empty string, which can be '
186
bytes = self.push_back
187
self.push_back = None
189
return self.socket.recv(4096)
291
191
def terminate_due_to_error(self):
192
"""Called when an unhandled exception from the protocol occurs."""
292
193
# TODO: This should log to a server log file, but no such thing
293
194
# exists yet. Andrew Bennetts 2006-09-29.
294
195
self.socket.close()
295
196
self.finished = True
297
198
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))
199
osutils.send_all(self.socket, bytes)
307
202
class SmartServerPipeStreamMedium(SmartServerStreamMedium):
462
361
return self._read_bytes(count)
464
363
def _read_bytes(self, count):
465
"""Helper for SmartClientMediumRequest.read_bytes.
364
"""Helper for read_bytes.
467
366
read_bytes checks the state of the request to determing if bytes
468
367
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)
370
raise NotImplementedError(self._read_bytes)
476
372
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.")
373
"""Read bytes from this request's response until a newline byte.
375
This isn't particularly efficient, so should only be used when the
376
expected size of the line is quite short.
378
:returns: a string of bytes ending in a newline (byte 0x0A).
380
# XXX: this duplicates SmartClientRequestProtocolOne._recv_tuple
382
while not line or line[-1] != '\n':
383
new_char = self.read_bytes(1)
386
# end of file encountered reading from server
387
raise errors.ConnectionReset(
388
"please check connectivity and permissions",
389
"(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):
393
class SmartClientMedium(object):
557
394
"""Smart client is a medium for sending smart protocol requests over."""
559
def __init__(self, base):
560
397
super(SmartClientMedium, self).__init__()
562
398
self._protocol_version_error = None
563
399
self._protocol_version = None
564
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
401
def protocol_version(self):
623
"""Find out if 'hello' smart request works."""
402
"""Find out the best protocol version to use."""
624
403
if self._protocol_version_error is not None:
625
404
raise self._protocol_version_error
626
if not self._done_hello:
405
if self._protocol_version is None:
628
407
medium_request = self.get_request()
629
408
# Send a 'hello' request in protocol version one, for maximum
630
409
# backwards compatibility.
631
client_protocol = protocol.SmartClientRequestProtocolOne(medium_request)
632
client_protocol.query_version()
633
self._done_hello = True
410
client_protocol = SmartClientRequestProtocolOne(medium_request)
411
self._protocol_version = client_protocol.query_version()
634
412
except errors.SmartProtocolError, e:
635
413
# Cache the error, just like we would cache a successful
637
415
self._protocol_version_error = e
641
def should_probe(self):
642
"""Should RemoteBzrDirFormat.probe_transport send a smart request on
645
Some transports are unambiguously smart-only; there's no need to check
646
if the transport is able to carry smart requests, because that's all
647
it is for. In those cases, this method should return False.
649
But some HTTP transports can sometimes fail to carry smart requests,
650
but still be usuable for accessing remote bzrdirs via plain file
651
accesses. So for those transports, their media should return True here
652
so that RemoteBzrDirFormat can determine if it is appropriate for that
417
return self._protocol_version
657
419
def disconnect(self):
658
420
"""If this medium maintains a persistent connection, close it.
660
422
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
426
class SmartClientStreamMedium(SmartClientMedium):
676
427
"""Stream based medium common class.
738
491
def _read_bytes(self, count):
739
492
"""See SmartClientStreamMedium._read_bytes."""
740
bytes = osutils.until_no_eintr(self._readable_pipe.read, count)
741
self._report_activity(len(bytes), 'read')
493
return self._readable_pipe.read(count)
745
496
class SmartSSHClientMedium(SmartClientStreamMedium):
746
497
"""A client medium using SSH."""
748
499
def __init__(self, host, port=None, username=None, password=None,
749
base=None, vendor=None, bzr_remote_path=None):
500
vendor=None, bzr_remote_path=None):
750
501
"""Creates a client that will connect on the first use.
752
503
:param vendor: An optional override for the ssh vendor to use. See
753
504
bzrlib.transport.ssh for details on ssh vendors.
506
SmartClientStreamMedium.__init__(self)
755
507
self._connected = False
756
508
self._host = host
757
509
self._password = password
758
510
self._port = port
759
511
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
512
self._read_from = None
768
513
self._ssh_connection = None
769
514
self._vendor = vendor
770
515
self._write_to = None
771
516
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__,
517
if self._bzr_remote_path is None:
518
symbol_versioning.warn(
519
'bzr_remote_path is required as of bzr 0.92',
520
DeprecationWarning, stacklevel=2)
521
self._bzr_remote_path = os.environ.get('BZR_REMOTE_PATH', 'bzr')
785
523
def _accept_bytes(self, bytes):
786
524
"""See SmartClientStreamMedium.accept_bytes."""
787
525
self._ensure_connection()
788
526
self._write_to.write(bytes)
789
self._report_activity(len(bytes), 'write')
791
528
def disconnect(self):
792
529
"""See SmartClientMedium.disconnect()."""
added
removed
bzrlib/smart/medium.py
