33
32
from bzrlib.lazy_import import lazy_import
34
33
lazy_import(globals(), """
37
34
from bzrlib import (
45
from bzrlib.smart import client, protocol, request, vfs
40
from bzrlib.smart import protocol
46
41
from bzrlib.transport import ssh
48
#usually already imported, and getting IllegalScoperReplacer on it here.
49
from bzrlib import osutils
51
# We must not read any more than 64k at a time so we don't risk "no buffer
52
# space available" errors on some platforms. Windows in particular is likely
53
# to give error 10053 or 10055 if we read more than 64k from a socket.
54
_MAX_READ_SIZE = 64 * 1024
57
45
def _get_protocol_factory_for_bytes(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_READ_SIZE ready, the socket wil just return a short
278
# read immediately rather than block.
279
bytes = self.read_bytes(_MAX_READ_SIZE)
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 _read_bytes_from_socket(
289
self.socket.recv, desired_count, 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.
456
397
return self._read_bytes(count)
458
399
def _read_bytes(self, count):
459
"""Helper for SmartClientMediumRequest.read_bytes.
400
"""Helper for read_bytes.
461
402
read_bytes checks the state of the request to determing if bytes
462
403
should be read. After that it hands off to _read_bytes to do the
465
By default this forwards to self._medium.read_bytes because we are
466
operating on the medium's stream.
468
return self._medium.read_bytes(count)
406
raise NotImplementedError(self._read_bytes)
470
408
def read_line(self):
471
line = self._read_line()
472
if not line.endswith('\n'):
473
# end of file encountered reading from server
474
raise errors.ConnectionReset(
475
"Unexpected end of message. Please check connectivity "
476
"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)")
479
def _read_line(self):
480
"""Helper for SmartClientMediumRequest.read_line.
482
By default this forwards to self._medium._get_line because we are
483
operating on the medium's stream.
485
return self._medium._get_line()
488
class _DebugCounter(object):
489
"""An object that counts the HPSS calls made to each client medium.
491
When a medium is garbage-collected, or failing that when atexit functions
492
are run, the total number of calls made on that medium are reported via
497
self.counts = weakref.WeakKeyDictionary()
498
client._SmartClient.hooks.install_named_hook(
499
'call', self.increment_call_count, 'hpss call counter')
500
atexit.register(self.flush_all)
502
def track(self, medium):
503
"""Start tracking calls made to a medium.
505
This only keeps a weakref to the medium, so shouldn't affect the
508
medium_repr = repr(medium)
509
# Add this medium to the WeakKeyDictionary
510
self.counts[medium] = dict(count=0, vfs_count=0,
511
medium_repr=medium_repr)
512
# Weakref callbacks are fired in reverse order of their association
513
# with the referenced object. So we add a weakref *after* adding to
514
# the WeakKeyDict so that we can report the value from it before the
515
# entry is removed by the WeakKeyDict's own callback.
516
ref = weakref.ref(medium, self.done)
518
def increment_call_count(self, params):
519
# Increment the count in the WeakKeyDictionary
520
value = self.counts[params.medium]
523
request_method = request.request_handlers.get(params.method)
525
# A method we don't know about doesn't count as a VFS method.
527
if issubclass(request_method, vfs.VfsRequest):
528
value['vfs_count'] += 1
531
value = self.counts[ref]
532
count, vfs_count, medium_repr = (
533
value['count'], value['vfs_count'], value['medium_repr'])
534
# In case this callback is invoked for the same ref twice (by the
535
# weakref callback and by the atexit function), set the call count back
536
# to 0 so this item won't be reported twice.
538
value['vfs_count'] = 0
540
trace.note('HPSS calls: %d (%d vfs) %s',
541
count, vfs_count, medium_repr)
544
for ref in list(self.counts.keys()):
547
_debug_counter = None
550
class SmartClientMedium(SmartMedium):
429
class SmartClientMedium(object):
551
430
"""Smart client is a medium for sending smart protocol requests over."""
553
432
def __init__(self, base):
722
593
def _read_bytes(self, count):
723
594
"""See SmartClientStreamMedium._read_bytes."""
724
bytes = self._readable_pipe.read(count)
725
self._report_activity(len(bytes), 'read')
595
return self._readable_pipe.read(count)
729
598
class SmartSSHClientMedium(SmartClientStreamMedium):
730
599
"""A client medium using SSH."""
732
601
def __init__(self, host, port=None, username=None, password=None,
733
602
base=None, vendor=None, bzr_remote_path=None):
734
603
"""Creates a client that will connect on the first use.
736
605
:param vendor: An optional override for the ssh vendor to use. See
737
606
bzrlib.transport.ssh for details on ssh vendors.
608
SmartClientStreamMedium.__init__(self, base)
739
609
self._connected = False
740
610
self._host = host
741
611
self._password = password
742
612
self._port = port
743
613
self._username = username
744
# SmartClientStreamMedium stores the repr of this object in its
745
# _DebugCounter so we have to store all the values used in our repr
746
# method before calling the super init.
747
SmartClientStreamMedium.__init__(self, base)
748
614
self._read_from = None
749
615
self._ssh_connection = None
750
616
self._vendor = vendor
751
617
self._write_to = None
752
618
self._bzr_remote_path = bzr_remote_path
753
# for the benefit of progress making a short description of this
755
self._scheme = 'bzr+ssh'
758
return "%s(connected=%r, username=%r, host=%r, port=%r)" % (
759
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')
765
625
def _accept_bytes(self, bytes):
766
626
"""See SmartClientStreamMedium.accept_bytes."""
767
627
self._ensure_connection()
768
628
self._write_to.write(bytes)
769
self._report_activity(len(bytes), 'write')
771
630
def disconnect(self):
772
631
"""See SmartClientMedium.disconnect()."""
801
660
"""See SmartClientStreamMedium.read_bytes."""
802
661
if not self._connected:
803
662
raise errors.MediumNotConnected(self)
804
bytes_to_read = min(count, _MAX_READ_SIZE)
805
bytes = self._read_from.read(bytes_to_read)
806
self._report_activity(len(bytes), 'read')
663
return self._read_from.read(count)
810
666
# Port 4155 is the default port for bzr://, registered with IANA.
811
BZR_DEFAULT_INTERFACE = None
667
BZR_DEFAULT_INTERFACE = '0.0.0.0'
812
668
BZR_DEFAULT_PORT = 4155
815
671
class SmartTCPClientMedium(SmartClientStreamMedium):
816
672
"""A client medium using TCP."""
818
674
def __init__(self, host, port, base):
819
675
"""Creates a client that will connect on the first use."""
820
676
SmartClientStreamMedium.__init__(self, base)
840
696
"""Connect this medium if not already connected."""
841
697
if self._connected:
699
self._socket = socket.socket()
700
self._socket.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
843
701
if self._port is None:
844
702
port = BZR_DEFAULT_PORT
846
704
port = int(self._port)
848
sockaddrs = socket.getaddrinfo(self._host, port, socket.AF_UNSPEC,
849
socket.SOCK_STREAM, 0, 0)
850
except socket.gaierror, (err_num, err_msg):
851
raise errors.ConnectionError("failed to lookup %s:%d: %s" %
852
(self._host, port, err_msg))
853
# Initialize err in case there are no addresses returned:
854
err = socket.error("no address found for %s" % self._host)
855
for (family, socktype, proto, canonname, sockaddr) in sockaddrs:
857
self._socket = socket.socket(family, socktype, proto)
858
self._socket.setsockopt(socket.IPPROTO_TCP,
859
socket.TCP_NODELAY, 1)
860
self._socket.connect(sockaddr)
861
except socket.error, err:
862
if self._socket is not None:
867
if self._socket is None:
706
self._socket.connect((self._host, port))
707
except socket.error, err:
868
708
# socket errors either have a (string) or (errno, string) as their
870
710
if type(err.args) is str:
930
769
self._medium._flush()
933
def _read_bytes_from_socket(sock, desired_count, report_activity):
934
# We ignore the desired_count because on sockets it's more efficient to
935
# read large chunks (of _MAX_READ_SIZE bytes) at a time.
937
bytes = osutils.until_no_eintr(sock, _MAX_READ_SIZE)
938
except socket.error, e:
939
if len(e.args) and e.args[0] in (errno.ECONNRESET, 10054):
940
# The connection was closed by the other side. Callers expect an
941
# empty string to signal end-of-stream.
946
report_activity(len(bytes), 'read')
771
def _read_bytes(self, count):
772
"""See SmartClientMediumRequest._read_bytes.
774
This forwards to self._medium._read_bytes because we are operating
775
on the mediums stream.
777
return self._medium._read_bytes(count)
added
removed
bzrlib/smart/medium.py
