22
22
Media carry the bytes of the requests somehow (e.g. via TCP, wrapped in HTTP, or
23
23
over SSH), and pass them to and from the protocol logic. See the overview in
24
breezy/transport/smart/__init__.py.
24
bzrlib/transport/smart/__init__.py.
27
from __future__ import absolute_import
36
from ...lazy_import import lazy_import
31
from bzrlib.lazy_import import lazy_import
37
32
lazy_import(globals(), """
50
from breezy.i18n import gettext
51
from breezy.bzr.smart import client, protocol, request, signals, vfs
52
from breezy.transport import ssh
46
from bzrlib.smart import client, protocol, request, vfs
47
from bzrlib.transport import ssh
49
from bzrlib import osutils
59
51
# Throughout this module buffer size parameters are either limited to be at
60
52
# most _MAX_READ_SIZE, or are ignored and _MAX_READ_SIZE is used instead.
133
114
def __init__(self):
134
115
self._push_back_buffer = None
136
def _push_back(self, data):
117
def _push_back(self, bytes):
137
118
"""Return unused bytes to the medium, because they belong to the next
140
121
This sets the _push_back_buffer to the given bytes.
142
if not isinstance(data, bytes):
143
raise TypeError(data)
144
123
if self._push_back_buffer is not None:
145
124
raise AssertionError(
146
125
"_push_back called when self._push_back_buffer is %r"
147
126
% (self._push_back_buffer,))
150
self._push_back_buffer = data
129
self._push_back_buffer = bytes
152
131
def _get_push_back_buffer(self):
153
if self._push_back_buffer == b'':
132
if self._push_back_buffer == '':
154
133
raise AssertionError(
155
134
'%s._push_back_buffer should never be the empty string, '
156
135
'which can be confused with EOF' % (self,))
249
214
while not self.finished:
250
215
server_protocol = self._build_protocol()
251
216
self._serve_one_request(server_protocol)
252
except errors.ConnectionTimeout as e:
253
trace.note('%s' % (e,))
254
trace.log_exception_quietly()
255
self._disconnect_client()
256
# We reported it, no reason to make a big fuss.
258
except Exception as e:
259
218
stderr.write("%s terminating on exception %s\n" % (self, e))
261
self._disconnect_client()
263
def _stop_gracefully(self):
264
"""When we finish this message, stop looking for more."""
265
trace.mutter('Stopping %s' % (self,))
268
def _disconnect_client(self):
269
"""Close the current connection. We stopped due to a timeout/etc."""
270
# The default implementation is a no-op, because that is all we used to
271
# do when disconnecting from a client. I suppose we never had the
272
# *server* initiate a disconnect, before
274
def _wait_for_bytes_with_timeout(self, timeout_seconds):
275
"""Wait for more bytes to be read, but timeout if none available.
277
This allows us to detect idle connections, and stop trying to read from
278
them, without setting the socket itself to non-blocking. This also
279
allows us to specify when we watch for idle timeouts.
281
:return: Did we timeout? (True if we timed out, False if there is data
284
raise NotImplementedError(self._wait_for_bytes_with_timeout)
286
221
def _build_protocol(self):
287
222
"""Identifies the version of the incoming request, and returns an
303
234
protocol.accept_bytes(unused_bytes)
306
def _wait_on_descriptor(self, fd, timeout_seconds):
307
"""select() on a file descriptor, waiting for nonblocking read()
309
This will raise a ConnectionTimeout exception if we do not get a
310
readable handle before timeout_seconds.
313
t_end = self._timer() + timeout_seconds
314
poll_timeout = min(timeout_seconds, self._client_poll_timeout)
316
while not rs and not xs and self._timer() < t_end:
320
rs, _, xs = select.select([fd], [], [fd], poll_timeout)
321
except (select.error, socket.error) as e:
322
err = getattr(e, 'errno', None)
323
if err is None and getattr(e, 'args', None) is not None:
324
# select.error doesn't have 'errno', it just has args[0]
326
if err in _bad_file_descriptor:
327
return # Not a socket indicates read() will fail
328
elif err == errno.EINTR:
329
# Interrupted, keep looping.
333
return # Socket may already be closed
336
raise errors.ConnectionTimeout('disconnecting client after %.1f seconds'
337
% (timeout_seconds,))
339
237
def _serve_one_request(self, protocol):
340
238
"""Read one request from input, process, send back a response.
342
240
:param protocol: a SmartServerRequestProtocol.
347
243
self._serve_one_request_unguarded(protocol)
348
244
except KeyboardInterrupt:
350
except Exception as e:
351
247
self.terminate_due_to_error()
353
249
def terminate_due_to_error(self):
365
261
class SmartServerSocketStreamMedium(SmartServerStreamMedium):
367
def __init__(self, sock, backing_transport, root_client_path='/',
263
def __init__(self, sock, backing_transport, root_client_path='/'):
371
266
:param sock: the socket the server will read from. It will be put
372
267
into blocking mode.
374
269
SmartServerStreamMedium.__init__(
375
self, backing_transport, root_client_path=root_client_path,
270
self, backing_transport, root_client_path=root_client_path)
377
271
sock.setblocking(True)
378
272
self.socket = sock
379
# Get the getpeername now, as we might be closed later when we care.
381
self._client_info = sock.getpeername()
383
self._client_info = '<unknown>'
386
return '%s(client=%s)' % (self.__class__.__name__, self._client_info)
389
return '%s.%s(client=%s)' % (self.__module__, self.__class__.__name__,
392
274
def _serve_one_request_unguarded(self, protocol):
393
275
while protocol.next_read_size():
395
277
# than MAX_SOCKET_CHUNK ready, the socket will just return a
396
278
# short read immediately rather than block.
397
279
bytes = self.read_bytes(osutils.MAX_SOCKET_CHUNK)
399
281
self.finished = True
401
283
protocol.accept_bytes(bytes)
403
285
self._push_back(protocol.unused_data)
405
def _disconnect_client(self):
406
"""Close the current connection. We stopped due to a timeout/etc."""
409
def _wait_for_bytes_with_timeout(self, timeout_seconds):
410
"""Wait for more bytes to be read, but timeout if none available.
412
This allows us to detect idle connections, and stop trying to read from
413
them, without setting the socket itself to non-blocking. This also
414
allows us to specify when we watch for idle timeouts.
416
:return: None, this will raise ConnectionTimeout if we time out before
419
return self._wait_on_descriptor(self.socket, timeout_seconds)
421
287
def _read_bytes(self, desired_count):
422
288
return osutils.read_bytes_from_socket(
423
289
self.socket, self._report_activity)
441
307
class SmartServerPipeStreamMedium(SmartServerStreamMedium):
443
def __init__(self, in_file, out_file, backing_transport, timeout=None):
309
def __init__(self, in_file, out_file, backing_transport):
444
310
"""Construct new server.
446
312
:param in_file: Python file from which requests can be read.
447
313
:param out_file: Python file to write responses.
448
314
:param backing_transport: Transport for the directory served.
450
SmartServerStreamMedium.__init__(self, backing_transport,
316
SmartServerStreamMedium.__init__(self, backing_transport)
452
317
if sys.platform == 'win32':
453
318
# force binary mode for files
481
335
self._out.flush()
483
337
bytes = self.read_bytes(bytes_to_read)
485
339
# Connection has been closed.
486
340
self.finished = True
487
341
self._out.flush()
489
343
protocol.accept_bytes(bytes)
491
def _disconnect_client(self):
496
def _wait_for_bytes_with_timeout(self, timeout_seconds):
497
"""Wait for more bytes to be read, but timeout if none available.
499
This allows us to detect idle connections, and stop trying to read from
500
them, without setting the socket itself to non-blocking. This also
501
allows us to specify when we watch for idle timeouts.
503
:return: None, this will raise ConnectionTimeout if we time out before
506
if (getattr(self._in, 'fileno', None) is None
507
or sys.platform == 'win32'):
508
# You can't select() file descriptors on Windows.
511
return self._wait_on_descriptor(self._in, timeout_seconds)
512
except io.UnsupportedOperation:
515
345
def _read_bytes(self, desired_count):
516
346
return self._in.read(desired_count)
661
491
return self._medium._get_line()
664
class _VfsRefuser(object):
665
"""An object that refuses all VFS requests.
670
client._SmartClient.hooks.install_named_hook(
671
'call', self.check_vfs, 'vfs refuser')
673
def check_vfs(self, params):
675
request_method = request.request_handlers.get(params.method)
677
# A method we don't know about doesn't count as a VFS method.
679
if issubclass(request_method, vfs.VfsRequest):
680
raise HpssVfsRequestNotAllowed(params.method, params.args)
683
494
class _DebugCounter(object):
684
495
"""An object that counts the HPSS calls made to each client medium.
686
When a medium is garbage-collected, or failing that when
687
breezy.global_state exits, the total number of calls made on that medium
688
are reported via trace.note.
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
691
502
def __init__(self):
692
503
self.counts = weakref.WeakKeyDictionary()
693
504
client._SmartClient.hooks.install_named_hook(
694
505
'call', self.increment_call_count, 'hpss call counter')
695
breezy.get_global_state().cleanups.add_cleanup(self.flush_all)
506
atexit.register(self.flush_all)
697
508
def track(self, medium):
698
509
"""Start tracking calls made to a medium.
797
602
:seealso: _is_remote_before
799
604
if (self._remote_version_is_before is not None and
800
version_tuple > self._remote_version_is_before):
605
version_tuple > self._remote_version_is_before):
801
606
# We have been told that the remote side is older than some version
802
607
# which is newer than a previously supplied older-than version.
803
608
# This indicates that some smart verb call is not guarded
804
609
# appropriately (it should simply not have been tried).
806
611
"_remember_remote_is_before(%r) called, but "
807
"_remember_remote_is_before(%r) was called previously.", version_tuple, self._remote_version_is_before)
612
"_remember_remote_is_before(%r) was called previously."
613
, version_tuple, self._remote_version_is_before)
808
614
if 'hpss' in debug.debug_flags:
809
615
ui.ui_factory.show_warning(
810
616
"_remember_remote_is_before(%r) called, but "
822
628
medium_request = self.get_request()
823
629
# Send a 'hello' request in protocol version one, for maximum
824
630
# backwards compatibility.
825
client_protocol = protocol.SmartClientRequestProtocolOne(
631
client_protocol = protocol.SmartClientRequestProtocolOne(medium_request)
827
632
client_protocol.query_version()
828
633
self._done_hello = True
829
except errors.SmartProtocolError as e:
634
except errors.SmartProtocolError, e:
830
635
# Cache the error, just like we would cache a successful
832
637
self._protocol_version_error = e
906
711
return SmartClientStreamMediumRequest(self)
909
"""We have been disconnected, reset current state.
911
This resets things like _current_request and connected state.
914
self._current_request = None
917
714
class SmartSimplePipesClientMedium(SmartClientStreamMedium):
918
715
"""A client medium using simple pipes.
920
717
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.
923
724
def __init__(self, readable_pipe, writeable_pipe, base):
925
726
self._readable_pipe = readable_pipe
926
727
self._writeable_pipe = writeable_pipe
928
def _accept_bytes(self, data):
729
def _accept_bytes(self, bytes):
929
730
"""See SmartClientStreamMedium.accept_bytes."""
931
self._writeable_pipe.write(data)
933
if e.errno in (errno.EINVAL, errno.EPIPE):
934
raise errors.ConnectionReset(
935
"Error trying to write to subprocess", e)
937
self._report_activity(len(data), 'write')
731
self._writeable_pipe.write(bytes)
732
self._report_activity(len(bytes), 'write')
939
734
def _flush(self):
940
735
"""See SmartClientStreamMedium._flush()."""
941
# Note: If flush were to fail, we'd like to raise ConnectionReset, etc.
942
# However, testing shows that even when the child process is
943
# gone, this doesn't error.
944
736
self._writeable_pipe.flush()
946
738
def _read_bytes(self, count):
947
739
"""See SmartClientStreamMedium._read_bytes."""
948
bytes_to_read = min(count, _MAX_READ_SIZE)
949
data = self._readable_pipe.read(bytes_to_read)
950
self._report_activity(len(data), 'read')
954
class SSHParams(object):
955
"""A set of parameters for starting a remote bzr via SSH."""
740
bytes = osutils.until_no_eintr(self._readable_pipe.read, count)
741
self._report_activity(len(bytes), 'read')
745
class SmartSSHClientMedium(SmartClientStreamMedium):
746
"""A client medium using SSH."""
957
748
def __init__(self, host, port=None, username=None, password=None,
958
bzr_remote_path='bzr'):
961
self.username = username
962
self.password = password
963
self.bzr_remote_path = bzr_remote_path
966
class SmartSSHClientMedium(SmartClientStreamMedium):
967
"""A client medium using SSH.
969
It delegates IO to a SmartSimplePipesClientMedium or
970
SmartClientAlreadyConnectedSocketMedium (depending on platform).
973
def __init__(self, base, ssh_params, vendor=None):
749
base=None, vendor=None, bzr_remote_path=None):
974
750
"""Creates a client that will connect on the first use.
976
:param ssh_params: A SSHParams instance.
977
752
:param vendor: An optional override for the ssh vendor to use. See
978
breezy.transport.ssh for details on ssh vendors.
753
bzrlib.transport.ssh for details on ssh vendors.
980
self._real_medium = None
981
self._ssh_params = ssh_params
755
self._connected = False
757
self._password = password
759
self._username = username
982
760
# for the benefit of progress making a short description of this
984
762
self._scheme = 'bzr+ssh'
986
764
# _DebugCounter so we have to store all the values used in our repr
987
765
# method before calling the super init.
988
766
SmartClientStreamMedium.__init__(self, base)
767
self._read_from = None
768
self._ssh_connection = None
989
769
self._vendor = vendor
990
self._ssh_connection = None
770
self._write_to = None
771
self._bzr_remote_path = bzr_remote_path
992
773
def __repr__(self):
993
if self._ssh_params.port is None:
774
if self._port is None:
996
maybe_port = ':%s' % self._ssh_params.port
997
if self._ssh_params.username is None:
1000
maybe_user = '%s@' % self._ssh_params.username
1001
return "%s(%s://%s%s%s/)" % (
777
maybe_port = ':%s' % self._port
778
return "%s(%s://%s@%s%s/)" % (
1002
779
self.__class__.__name__,
1005
self._ssh_params.host,
1008
785
def _accept_bytes(self, bytes):
1009
786
"""See SmartClientStreamMedium.accept_bytes."""
1010
787
self._ensure_connection()
1011
self._real_medium.accept_bytes(bytes)
788
self._write_to.write(bytes)
789
self._report_activity(len(bytes), 'write')
1013
791
def disconnect(self):
1014
792
"""See SmartClientMedium.disconnect()."""
1015
if self._real_medium is not None:
1016
self._real_medium.disconnect()
1017
self._real_medium = None
1018
if self._ssh_connection is not None:
1019
self._ssh_connection.close()
1020
self._ssh_connection = None
793
if not self._connected:
795
self._read_from.close()
796
self._write_to.close()
797
self._ssh_connection.close()
798
self._connected = False
1022
800
def _ensure_connection(self):
1023
801
"""Connect this medium if not already connected."""
1024
if self._real_medium is not None:
1026
804
if self._vendor is None:
1027
805
vendor = ssh._get_ssh_vendor()
1029
807
vendor = self._vendor
1030
self._ssh_connection = vendor.connect_ssh(self._ssh_params.username,
1031
self._ssh_params.password, self._ssh_params.host,
1032
self._ssh_params.port,
1033
command=[self._ssh_params.bzr_remote_path, 'serve', '--inet',
1034
'--directory=/', '--allow-writes'])
1035
io_kind, io_object = self._ssh_connection.get_sock_or_pipes()
1036
if io_kind == 'socket':
1037
self._real_medium = SmartClientAlreadyConnectedSocketMedium(
1038
self.base, io_object)
1039
elif io_kind == 'pipes':
1040
read_from, write_to = io_object
1041
self._real_medium = SmartSimplePipesClientMedium(
1042
read_from, write_to, self.base)
1044
raise AssertionError(
1045
"Unexpected io_kind %r from %r"
1046
% (io_kind, self._ssh_connection))
1047
for hook in transport.Transport.hooks["post_connect"]:
808
self._ssh_connection = vendor.connect_ssh(self._username,
809
self._password, self._host, self._port,
810
command=[self._bzr_remote_path, 'serve', '--inet',
811
'--directory=/', '--allow-writes'])
812
self._read_from, self._write_to = \
813
self._ssh_connection.get_filelike_channels()
814
self._connected = True
1050
816
def _flush(self):
1051
817
"""See SmartClientStreamMedium._flush()."""
1052
self._real_medium._flush()
818
self._write_to.flush()
1054
820
def _read_bytes(self, count):
1055
821
"""See SmartClientStreamMedium.read_bytes."""
1056
if self._real_medium is None:
822
if not self._connected:
1057
823
raise errors.MediumNotConnected(self)
1058
return self._real_medium.read_bytes(count)
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')
1061
830
# Port 4155 is the default port for bzr://, registered with IANA.
1063
832
BZR_DEFAULT_PORT = 4155
1066
class SmartClientSocketMedium(SmartClientStreamMedium):
1067
"""A client medium using a socket.
1069
This class isn't usable directly. Use one of its subclasses instead.
1072
def __init__(self, base):
835
class SmartTCPClientMedium(SmartClientStreamMedium):
836
"""A client medium using TCP."""
838
def __init__(self, host, port, base):
839
"""Creates a client that will connect on the first use."""
1073
840
SmartClientStreamMedium.__init__(self, base)
841
self._connected = False
1074
844
self._socket = None
1075
self._connected = False
1077
846
def _accept_bytes(self, bytes):
1078
847
"""See SmartClientMedium.accept_bytes."""
1079
848
self._ensure_connection()
1080
849
osutils.send_all(self._socket, bytes, self._report_activity)
1082
def _ensure_connection(self):
1083
"""Connect this medium if not already connected."""
1084
raise NotImplementedError(self._ensure_connection)
1087
"""See SmartClientStreamMedium._flush().
1089
For sockets we do no flushing. For TCP sockets we may want to turn off
1090
TCP_NODELAY and add a means to do a flush, but that can be done in the
1094
def _read_bytes(self, count):
1095
"""See SmartClientMedium.read_bytes."""
1096
if not self._connected:
1097
raise errors.MediumNotConnected(self)
1098
return osutils.read_bytes_from_socket(
1099
self._socket, self._report_activity)
1101
851
def disconnect(self):
1102
852
"""See SmartClientMedium.disconnect()."""
1103
853
if not self._connected:
1126
866
port = int(self._port)
1128
868
sockaddrs = socket.getaddrinfo(self._host, port, socket.AF_UNSPEC,
1129
socket.SOCK_STREAM, 0, 0)
1130
except socket.gaierror as xxx_todo_changeme:
1131
(err_num, err_msg) = xxx_todo_changeme.args
869
socket.SOCK_STREAM, 0, 0)
870
except socket.gaierror, (err_num, err_msg):
1132
871
raise errors.ConnectionError("failed to lookup %s:%d: %s" %
1133
(self._host, port, err_msg))
872
(self._host, port, err_msg))
1134
873
# Initialize err in case there are no addresses returned:
1135
last_err = socket.error("no address found for %s" % self._host)
874
err = socket.error("no address found for %s" % self._host)
1136
875
for (family, socktype, proto, canonname, sockaddr) in sockaddrs:
1138
877
self._socket = socket.socket(family, socktype, proto)
1139
878
self._socket.setsockopt(socket.IPPROTO_TCP,
1140
879
socket.TCP_NODELAY, 1)
1141
880
self._socket.connect(sockaddr)
1142
except socket.error as err:
881
except socket.error, err:
1143
882
if self._socket is not None:
1144
883
self._socket.close()
1145
884
self._socket = None
1149
887
if self._socket is None:
1150
888
# socket errors either have a (string) or (errno, string) as their
1152
if isinstance(last_err.args, str):
1153
err_msg = last_err.args
890
if type(err.args) is str:
1155
err_msg = last_err.args[1]
893
err_msg = err.args[1]
1156
894
raise errors.ConnectionError("failed to connect to %s:%d: %s" %
1157
(self._host, port, err_msg))
1158
self._connected = True
1159
for hook in transport.Transport.hooks["post_connect"]:
1163
class SmartClientAlreadyConnectedSocketMedium(SmartClientSocketMedium):
1164
"""A client medium for an already connected socket.
1166
Note that this class will assume it "owns" the socket, so it will close it
1167
when its disconnect method is called.
1170
def __init__(self, base, sock):
1171
SmartClientSocketMedium.__init__(self, base)
1173
self._connected = True
1175
def _ensure_connection(self):
1176
# Already connected, by definition! So nothing to do.
895
(self._host, port, err_msg))
896
self._connected = True
899
"""See SmartClientStreamMedium._flush().
901
For TCP we do no flushing. We may want to turn off TCP_NODELAY and
902
add a means to do a flush, but that can be done in the future.
905
def _read_bytes(self, count):
906
"""See SmartClientMedium.read_bytes."""
907
if not self._connected:
908
raise errors.MediumNotConnected(self)
909
return osutils.read_bytes_from_socket(
910
self._socket, self._report_activity)
1180
913
class SmartClientStreamMediumRequest(SmartClientMediumRequest):