24
24
bzrlib/transport/smart/__init__.py.
27
from __future__ import absolute_import
33
35
from bzrlib.lazy_import import lazy_import
34
36
lazy_import(globals(), """
37
42
from bzrlib import (
46
from bzrlib.smart import client, protocol
50
from bzrlib.i18n import gettext
51
from bzrlib.smart import client, protocol, request, signals, vfs
47
52
from bzrlib.transport import ssh
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
54
from bzrlib import osutils
56
# Throughout this module buffer size parameters are either limited to be at
57
# most _MAX_READ_SIZE, or are ignored and _MAX_READ_SIZE is used instead.
58
# For this module's purposes, MAX_SOCKET_CHUNK is a reasonable size for reads
59
# from non-sockets as well.
60
_MAX_READ_SIZE = osutils.MAX_SOCKET_CHUNK
57
62
def _get_protocol_factory_for_bytes(bytes):
58
63
"""Determine the right protocol factory for 'bytes'.
214
233
while not self.finished:
215
234
server_protocol = self._build_protocol()
216
235
self._serve_one_request(server_protocol)
236
except errors.ConnectionTimeout, e:
237
trace.note('%s' % (e,))
238
trace.log_exception_quietly()
239
self._disconnect_client()
240
# We reported it, no reason to make a big fuss.
217
242
except Exception, e:
218
243
stderr.write("%s terminating on exception %s\n" % (self, e))
245
self._disconnect_client()
247
def _stop_gracefully(self):
248
"""When we finish this message, stop looking for more."""
249
trace.mutter('Stopping %s' % (self,))
252
def _disconnect_client(self):
253
"""Close the current connection. We stopped due to a timeout/etc."""
254
# The default implementation is a no-op, because that is all we used to
255
# do when disconnecting from a client. I suppose we never had the
256
# *server* initiate a disconnect, before
258
def _wait_for_bytes_with_timeout(self, timeout_seconds):
259
"""Wait for more bytes to be read, but timeout if none available.
261
This allows us to detect idle connections, and stop trying to read from
262
them, without setting the socket itself to non-blocking. This also
263
allows us to specify when we watch for idle timeouts.
265
:return: Did we timeout? (True if we timed out, False if there is data
268
raise NotImplementedError(self._wait_for_bytes_with_timeout)
221
270
def _build_protocol(self):
222
271
"""Identifies the version of the incoming request, and returns an
234
287
protocol.accept_bytes(unused_bytes)
290
def _wait_on_descriptor(self, fd, timeout_seconds):
291
"""select() on a file descriptor, waiting for nonblocking read()
293
This will raise a ConnectionTimeout exception if we do not get a
294
readable handle before timeout_seconds.
297
t_end = self._timer() + timeout_seconds
298
poll_timeout = min(timeout_seconds, self._client_poll_timeout)
300
while not rs and not xs and self._timer() < t_end:
304
rs, _, xs = select.select([fd], [], [fd], poll_timeout)
305
except (select.error, socket.error) as e:
306
err = getattr(e, 'errno', None)
307
if err is None and getattr(e, 'args', None) is not None:
308
# select.error doesn't have 'errno', it just has args[0]
310
if err in _bad_file_descriptor:
311
return # Not a socket indicates read() will fail
312
elif err == errno.EINTR:
313
# Interrupted, keep looping.
318
raise errors.ConnectionTimeout('disconnecting client after %.1f seconds'
319
% (timeout_seconds,))
237
321
def _serve_one_request(self, protocol):
238
322
"""Read one request from input, process, send back a response.
240
324
:param protocol: a SmartServerRequestProtocol.
243
329
self._serve_one_request_unguarded(protocol)
244
330
except KeyboardInterrupt:
261
347
class SmartServerSocketStreamMedium(SmartServerStreamMedium):
263
def __init__(self, sock, backing_transport, root_client_path='/'):
349
def __init__(self, sock, backing_transport, root_client_path='/',
266
353
:param sock: the socket the server will read from. It will be put
267
354
into blocking mode.
269
356
SmartServerStreamMedium.__init__(
270
self, backing_transport, root_client_path=root_client_path)
357
self, backing_transport, root_client_path=root_client_path,
271
359
sock.setblocking(True)
272
360
self.socket = sock
361
# Get the getpeername now, as we might be closed later when we care.
363
self._client_info = sock.getpeername()
365
self._client_info = '<unknown>'
368
return '%s(client=%s)' % (self.__class__.__name__, self._client_info)
371
return '%s.%s(client=%s)' % (self.__module__, self.__class__.__name__,
274
374
def _serve_one_request_unguarded(self, protocol):
275
375
while protocol.next_read_size():
276
376
# 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)
377
# than MAX_SOCKET_CHUNK ready, the socket will just return a
378
# short read immediately rather than block.
379
bytes = self.read_bytes(osutils.MAX_SOCKET_CHUNK)
281
381
self.finished = True
285
385
self._push_back(protocol.unused_data)
387
def _disconnect_client(self):
388
"""Close the current connection. We stopped due to a timeout/etc."""
391
def _wait_for_bytes_with_timeout(self, timeout_seconds):
392
"""Wait for more bytes to be read, but timeout if none available.
394
This allows us to detect idle connections, and stop trying to read from
395
them, without setting the socket itself to non-blocking. This also
396
allows us to specify when we watch for idle timeouts.
398
:return: None, this will raise ConnectionTimeout if we time out before
401
return self._wait_on_descriptor(self.socket, timeout_seconds)
287
403
def _read_bytes(self, desired_count):
288
# We ignore the desired_count because on sockets it's more efficient to
289
# read large chunks (of _MAX_READ_SIZE bytes) at a time.
290
bytes = osutils.until_no_eintr(self.socket.recv, _MAX_READ_SIZE)
291
self._report_activity(len(bytes), 'read')
404
return osutils.read_bytes_from_socket(
405
self.socket, self._report_activity)
294
407
def terminate_due_to_error(self):
295
408
# TODO: This should log to a server log file, but no such thing
298
411
self.finished = True
300
413
def _write_out(self, bytes):
414
tstart = osutils.timer_func()
301
415
osutils.send_all(self.socket, bytes, self._report_activity)
416
if 'hpss' in debug.debug_flags:
417
thread_id = thread.get_ident()
418
trace.mutter('%12s: [%s] %d bytes to the socket in %.3fs'
419
% ('wrote', thread_id, len(bytes),
420
osutils.timer_func() - tstart))
304
423
class SmartServerPipeStreamMedium(SmartServerStreamMedium):
306
def __init__(self, in_file, out_file, backing_transport):
425
def __init__(self, in_file, out_file, backing_transport, timeout=None):
307
426
"""Construct new server.
309
428
:param in_file: Python file from which requests can be read.
310
429
:param out_file: Python file to write responses.
311
430
:param backing_transport: Transport for the directory served.
313
SmartServerStreamMedium.__init__(self, backing_transport)
432
SmartServerStreamMedium.__init__(self, backing_transport,
314
434
if sys.platform == 'win32':
315
435
# force binary mode for files
487
640
return self._medium._get_line()
643
class _VfsRefuser(object):
644
"""An object that refuses all VFS requests.
649
client._SmartClient.hooks.install_named_hook(
650
'call', self.check_vfs, 'vfs refuser')
652
def check_vfs(self, params):
654
request_method = request.request_handlers.get(params.method)
656
# A method we don't know about doesn't count as a VFS method.
658
if issubclass(request_method, vfs.VfsRequest):
659
raise errors.HpssVfsRequestNotAllowed(params.method, params.args)
490
662
class _DebugCounter(object):
491
663
"""An object that counts the HPSS calls made to each client medium.
493
When a medium is garbage-collected, or failing that when atexit functions
494
are run, the total number of calls made on that medium are reported via
665
When a medium is garbage-collected, or failing that when
666
bzrlib.global_state exits, the total number of calls made on that medium
667
are reported via trace.note.
498
670
def __init__(self):
499
671
self.counts = weakref.WeakKeyDictionary()
500
672
client._SmartClient.hooks.install_named_hook(
501
673
'call', self.increment_call_count, 'hpss call counter')
502
atexit.register(self.flush_all)
674
bzrlib.global_state.cleanups.add_cleanup(self.flush_all)
504
676
def track(self, medium):
505
677
"""Start tracking calls made to a medium.
519
692
def increment_call_count(self, params):
520
693
# Increment the count in the WeakKeyDictionary
521
694
value = self.counts[params.medium]
697
request_method = request.request_handlers.get(params.method)
699
# A method we don't know about doesn't count as a VFS method.
701
if issubclass(request_method, vfs.VfsRequest):
702
value['vfs_count'] += 1
524
704
def done(self, ref):
525
705
value = self.counts[ref]
526
count, medium_repr = value
706
count, vfs_count, medium_repr = (
707
value['count'], value['vfs_count'], value['medium_repr'])
527
708
# In case this callback is invoked for the same ref twice (by the
528
709
# weakref callback and by the atexit function), set the call count back
529
710
# to 0 so this item won't be reported twice.
712
value['vfs_count'] = 0
532
trace.note('HPSS calls: %d %s', count, medium_repr)
714
trace.note(gettext('HPSS calls: {0} ({1} vfs) {2}').format(
715
count, vfs_count, medium_repr))
534
717
def flush_all(self):
535
718
for ref in list(self.counts.keys()):
538
721
_debug_counter = None
541
725
class SmartClientMedium(SmartMedium):
704
906
def _accept_bytes(self, bytes):
705
907
"""See SmartClientStreamMedium.accept_bytes."""
706
self._writeable_pipe.write(bytes)
909
self._writeable_pipe.write(bytes)
911
if e.errno in (errno.EINVAL, errno.EPIPE):
912
raise errors.ConnectionReset(
913
"Error trying to write to subprocess", e)
707
915
self._report_activity(len(bytes), 'write')
709
917
def _flush(self):
710
918
"""See SmartClientStreamMedium._flush()."""
919
# Note: If flush were to fail, we'd like to raise ConnectionReset, etc.
920
# However, testing shows that even when the child process is
921
# gone, this doesn't error.
711
922
self._writeable_pipe.flush()
713
924
def _read_bytes(self, count):
714
925
"""See SmartClientStreamMedium._read_bytes."""
715
bytes = self._readable_pipe.read(count)
926
bytes_to_read = min(count, _MAX_READ_SIZE)
927
bytes = self._readable_pipe.read(bytes_to_read)
716
928
self._report_activity(len(bytes), 'read')
932
class SSHParams(object):
933
"""A set of parameters for starting a remote bzr via SSH."""
935
def __init__(self, host, port=None, username=None, password=None,
936
bzr_remote_path='bzr'):
939
self.username = username
940
self.password = password
941
self.bzr_remote_path = bzr_remote_path
720
944
class SmartSSHClientMedium(SmartClientStreamMedium):
721
"""A client medium using SSH."""
723
def __init__(self, host, port=None, username=None, password=None,
724
base=None, vendor=None, bzr_remote_path=None):
945
"""A client medium using SSH.
947
It delegates IO to a SmartSimplePipesClientMedium or
948
SmartClientAlreadyConnectedSocketMedium (depending on platform).
951
def __init__(self, base, ssh_params, vendor=None):
725
952
"""Creates a client that will connect on the first use.
954
:param ssh_params: A SSHParams instance.
727
955
:param vendor: An optional override for the ssh vendor to use. See
728
956
bzrlib.transport.ssh for details on ssh vendors.
730
self._connected = False
732
self._password = password
734
self._username = username
958
self._real_medium = None
959
self._ssh_params = ssh_params
960
# for the benefit of progress making a short description of this
962
self._scheme = 'bzr+ssh'
735
963
# SmartClientStreamMedium stores the repr of this object in its
736
964
# _DebugCounter so we have to store all the values used in our repr
737
965
# method before calling the super init.
738
966
SmartClientStreamMedium.__init__(self, base)
739
self._read_from = None
967
self._vendor = vendor
740
968
self._ssh_connection = None
741
self._vendor = vendor
742
self._write_to = None
743
self._bzr_remote_path = bzr_remote_path
744
# for the benefit of progress making a short description of this
746
self._scheme = 'bzr+ssh'
748
970
def __repr__(self):
749
return "%s(connected=%r, username=%r, host=%r, port=%r)" % (
971
if self._ssh_params.port is None:
974
maybe_port = ':%s' % self._ssh_params.port
975
if self._ssh_params.username is None:
978
maybe_user = '%s@' % self._ssh_params.username
979
return "%s(%s://%s%s%s/)" % (
750
980
self.__class__.__name__,
983
self._ssh_params.host,
756
986
def _accept_bytes(self, bytes):
757
987
"""See SmartClientStreamMedium.accept_bytes."""
758
988
self._ensure_connection()
759
self._write_to.write(bytes)
760
self._report_activity(len(bytes), 'write')
989
self._real_medium.accept_bytes(bytes)
762
991
def disconnect(self):
763
992
"""See SmartClientMedium.disconnect()."""
764
if not self._connected:
766
self._read_from.close()
767
self._write_to.close()
768
self._ssh_connection.close()
769
self._connected = False
993
if self._real_medium is not None:
994
self._real_medium.disconnect()
995
self._real_medium = None
996
if self._ssh_connection is not None:
997
self._ssh_connection.close()
998
self._ssh_connection = None
771
1000
def _ensure_connection(self):
772
1001
"""Connect this medium if not already connected."""
1002
if self._real_medium is not None:
775
1004
if self._vendor is None:
776
1005
vendor = ssh._get_ssh_vendor()
778
1007
vendor = self._vendor
779
self._ssh_connection = vendor.connect_ssh(self._username,
780
self._password, self._host, self._port,
781
command=[self._bzr_remote_path, 'serve', '--inet',
1008
self._ssh_connection = vendor.connect_ssh(self._ssh_params.username,
1009
self._ssh_params.password, self._ssh_params.host,
1010
self._ssh_params.port,
1011
command=[self._ssh_params.bzr_remote_path, 'serve', '--inet',
782
1012
'--directory=/', '--allow-writes'])
783
self._read_from, self._write_to = \
784
self._ssh_connection.get_filelike_channels()
785
self._connected = True
1013
io_kind, io_object = self._ssh_connection.get_sock_or_pipes()
1014
if io_kind == 'socket':
1015
self._real_medium = SmartClientAlreadyConnectedSocketMedium(
1016
self.base, io_object)
1017
elif io_kind == 'pipes':
1018
read_from, write_to = io_object
1019
self._real_medium = SmartSimplePipesClientMedium(
1020
read_from, write_to, self.base)
1022
raise AssertionError(
1023
"Unexpected io_kind %r from %r"
1024
% (io_kind, self._ssh_connection))
1025
for hook in transport.Transport.hooks["post_connect"]:
787
1028
def _flush(self):
788
1029
"""See SmartClientStreamMedium._flush()."""
789
self._write_to.flush()
1030
self._real_medium._flush()
791
1032
def _read_bytes(self, count):
792
1033
"""See SmartClientStreamMedium.read_bytes."""
793
if not self._connected:
1034
if self._real_medium is None:
794
1035
raise errors.MediumNotConnected(self)
795
bytes_to_read = min(count, _MAX_READ_SIZE)
796
bytes = self._read_from.read(bytes_to_read)
797
self._report_activity(len(bytes), 'read')
1036
return self._real_medium.read_bytes(count)
801
1039
# Port 4155 is the default port for bzr://, registered with IANA.
803
1041
BZR_DEFAULT_PORT = 4155
806
class SmartTCPClientMedium(SmartClientStreamMedium):
807
"""A client medium using TCP."""
809
def __init__(self, host, port, base):
810
"""Creates a client that will connect on the first use."""
1044
class SmartClientSocketMedium(SmartClientStreamMedium):
1045
"""A client medium using a socket.
1047
This class isn't usable directly. Use one of its subclasses instead.
1050
def __init__(self, base):
811
1051
SmartClientStreamMedium.__init__(self, base)
812
1053
self._connected = False
817
1055
def _accept_bytes(self, bytes):
818
1056
"""See SmartClientMedium.accept_bytes."""
819
1057
self._ensure_connection()
820
1058
osutils.send_all(self._socket, bytes, self._report_activity)
1060
def _ensure_connection(self):
1061
"""Connect this medium if not already connected."""
1062
raise NotImplementedError(self._ensure_connection)
1065
"""See SmartClientStreamMedium._flush().
1067
For sockets we do no flushing. For TCP sockets we may want to turn off
1068
TCP_NODELAY and add a means to do a flush, but that can be done in the
1072
def _read_bytes(self, count):
1073
"""See SmartClientMedium.read_bytes."""
1074
if not self._connected:
1075
raise errors.MediumNotConnected(self)
1076
return osutils.read_bytes_from_socket(
1077
self._socket, self._report_activity)
822
1079
def disconnect(self):
823
1080
"""See SmartClientMedium.disconnect()."""
824
1081
if not self._connected:
865
1132
raise errors.ConnectionError("failed to connect to %s:%d: %s" %
866
1133
(self._host, port, err_msg))
867
1134
self._connected = True
870
"""See SmartClientStreamMedium._flush().
872
For TCP we do no flushing. We may want to turn off TCP_NODELAY and
873
add a means to do a flush, but that can be done in the future.
876
def _read_bytes(self, count):
877
"""See SmartClientMedium.read_bytes."""
878
if not self._connected:
879
raise errors.MediumNotConnected(self)
880
# We ignore the desired_count because on sockets it's more efficient to
881
# read large chunks (of _MAX_READ_SIZE bytes) at a time.
883
bytes = osutils.until_no_eintr(self._socket.recv, _MAX_READ_SIZE)
884
except socket.error, e:
885
if len(e.args) and e.args[0] == errno.ECONNRESET:
886
# Callers expect an empty string in that case
891
self._report_activity(len(bytes), 'read')
1135
for hook in transport.Transport.hooks["post_connect"]:
1139
class SmartClientAlreadyConnectedSocketMedium(SmartClientSocketMedium):
1140
"""A client medium for an already connected socket.
1142
Note that this class will assume it "owns" the socket, so it will close it
1143
when its disconnect method is called.
1146
def __init__(self, base, sock):
1147
SmartClientSocketMedium.__init__(self, base)
1149
self._connected = True
1151
def _ensure_connection(self):
1152
# Already connected, by definition! So nothing to do.
895
1156
class SmartClientStreamMediumRequest(SmartClientMediumRequest):
added
removed
bzrlib/smart/medium.py
