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
57
45
def _get_protocol_factory_for_bytes(bytes):
58
46
"""Determine the right protocol factory for 'bytes'.
86
74
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):
77
class SmartServerStreamMedium(object):
180
78
"""Handles smart commands coming over a stream.
182
80
The stream may be a pipe connected to sshd, or a tcp socket, or an
203
101
self.backing_transport = backing_transport
204
102
self.root_client_path = root_client_path
205
103
self.finished = False
206
SmartMedium.__init__(self)
104
self._push_back_buffer = None
106
def _push_back(self, bytes):
107
"""Return unused bytes to the medium, because they belong to the next
110
This sets the _push_back_buffer to the given bytes.
112
if self._push_back_buffer is not None:
113
raise AssertionError(
114
"_push_back called when self._push_back_buffer is %r"
115
% (self._push_back_buffer,))
118
self._push_back_buffer = bytes
120
def _get_push_back_buffer(self):
121
if self._push_back_buffer == '':
122
raise AssertionError(
123
'%s._push_back_buffer should never be the empty string, '
124
'which can be confused with EOF' % (self,))
125
bytes = self._push_back_buffer
126
self._push_back_buffer = None
209
130
"""Serve requests until the client disconnects."""
250
171
"""Called when an unhandled exception from the protocol occurs."""
251
172
raise NotImplementedError(self.terminate_due_to_error)
253
def _read_bytes(self, desired_count):
174
def _get_bytes(self, desired_count):
254
175
"""Get some bytes from the medium.
256
177
:param desired_count: number of bytes we want to read.
258
raise NotImplementedError(self._read_bytes)
179
raise NotImplementedError(self._get_bytes)
182
"""Read bytes from this request's response until a newline byte.
184
This isn't particularly efficient, so should only be used when the
185
expected size of the line is quite short.
187
:returns: a string of bytes ending in a newline (byte 0x0A).
191
while newline_pos == -1:
192
new_bytes = self._get_bytes(1)
195
# Ran out of bytes before receiving a complete line.
197
newline_pos = bytes.find('\n')
198
line = bytes[:newline_pos+1]
199
self._push_back(bytes[newline_pos+1:])
261
203
class SmartServerSocketStreamMedium(SmartServerStreamMedium):
274
216
def _serve_one_request_unguarded(self, protocol):
275
217
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)
218
bytes = self._get_bytes(4096)
281
220
self.finished = True
283
222
protocol.accept_bytes(bytes)
285
224
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)
226
def _get_bytes(self, desired_count):
227
if self._push_back_buffer is not None:
228
return self._get_push_back_buffer()
229
# We ignore the desired_count because on sockets it's more efficient to
231
return self.socket.recv(4096)
291
233
def terminate_due_to_error(self):
292
234
# TODO: This should log to a server log file, but no such thing
293
235
# exists yet. Andrew Bennetts 2006-09-29.
295
237
self.finished = True
297
239
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))
240
osutils.send_all(self.socket, bytes)
307
243
class SmartServerPipeStreamMedium(SmartServerStreamMedium):
462
397
return self._read_bytes(count)
464
399
def _read_bytes(self, count):
465
"""Helper for SmartClientMediumRequest.read_bytes.
400
"""Helper for read_bytes.
467
402
read_bytes checks the state of the request to determing if bytes
468
403
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)
406
raise NotImplementedError(self._read_bytes)
476
408
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.")
409
"""Read bytes from this request's response until a newline byte.
411
This isn't particularly efficient, so should only be used when the
412
expected size of the line is quite short.
414
:returns: a string of bytes ending in a newline (byte 0x0A).
416
# XXX: this duplicates SmartClientRequestProtocolOne._recv_tuple
418
while not line or line[-1] != '\n':
419
new_char = self.read_bytes(1)
422
# end of file encountered reading from server
423
raise errors.ConnectionReset(
424
"please check connectivity and permissions",
425
"(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):
429
class SmartClientMedium(object):
557
430
"""Smart client is a medium for sending smart protocol requests over."""
559
432
def __init__(self, base):
604
471
if (self._remote_version_is_before is not None and
605
472
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).
473
raise AssertionError(
611
474
"_remember_remote_is_before(%r) called, but "
612
475
"_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))
476
% (version_tuple, self._remote_version_is_before))
620
477
self._remote_version_is_before = version_tuple
622
479
def protocol_version(self):
711
568
return SmartClientStreamMediumRequest(self)
570
def read_bytes(self, count):
571
return self._read_bytes(count)
714
574
class SmartSimplePipesClientMedium(SmartClientStreamMedium):
715
575
"""A client medium using simple pipes.
717
577
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
580
def __init__(self, readable_pipe, writeable_pipe, base):
738
593
def _read_bytes(self, count):
739
594
"""See SmartClientStreamMedium._read_bytes."""
740
bytes = osutils.until_no_eintr(self._readable_pipe.read, count)
741
self._report_activity(len(bytes), 'read')
595
return self._readable_pipe.read(count)
745
598
class SmartSSHClientMedium(SmartClientStreamMedium):
746
599
"""A client medium using SSH."""
748
601
def __init__(self, host, port=None, username=None, password=None,
749
602
base=None, vendor=None, bzr_remote_path=None):
750
603
"""Creates a client that will connect on the first use.
752
605
:param vendor: An optional override for the ssh vendor to use. See
753
606
bzrlib.transport.ssh for details on ssh vendors.
608
SmartClientStreamMedium.__init__(self, base)
755
609
self._connected = False
756
610
self._host = host
757
611
self._password = password
758
612
self._port = port
759
613
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
614
self._read_from = None
768
615
self._ssh_connection = None
769
616
self._vendor = vendor
770
617
self._write_to = None
771
618
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__,
619
if self._bzr_remote_path is None:
620
symbol_versioning.warn(
621
'bzr_remote_path is required as of bzr 0.92',
622
DeprecationWarning, stacklevel=2)
623
self._bzr_remote_path = os.environ.get('BZR_REMOTE_PATH', 'bzr')
785
625
def _accept_bytes(self, bytes):
786
626
"""See SmartClientStreamMedium.accept_bytes."""
787
627
self._ensure_connection()
788
628
self._write_to.write(bytes)
789
self._report_activity(len(bytes), 'write')
791
630
def disconnect(self):
792
631
"""See SmartClientMedium.disconnect()."""
821
660
"""See SmartClientStreamMedium.read_bytes."""
822
661
if not self._connected:
823
662
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')
663
return self._read_from.read(count)
830
666
# Port 4155 is the default port for bzr://, registered with IANA.
831
BZR_DEFAULT_INTERFACE = None
667
BZR_DEFAULT_INTERFACE = '0.0.0.0'
832
668
BZR_DEFAULT_PORT = 4155
835
671
class SmartTCPClientMedium(SmartClientStreamMedium):
836
672
"""A client medium using TCP."""
838
674
def __init__(self, host, port, base):
839
675
"""Creates a client that will connect on the first use."""
840
676
SmartClientStreamMedium.__init__(self, base)
860
696
"""Connect this medium if not already connected."""
861
697
if self._connected:
699
self._socket = socket.socket()
700
self._socket.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
863
701
if self._port is None:
864
702
port = BZR_DEFAULT_PORT
866
704
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:
706
self._socket.connect((self._host, port))
707
except socket.error, err:
888
708
# socket errors either have a (string) or (errno, string) as their
890
710
if type(err.args) is str:
added
removed
bzrlib/smart/medium.py
