13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
"""The 'medium' layer for the smart servers and clients.
24
24
bzrlib/transport/smart/__init__.py.
31
33
from bzrlib.lazy_import import lazy_import
32
34
lazy_import(globals(), """
38
37
from bzrlib import (
46
from bzrlib.smart import client, protocol, request, vfs
45
from bzrlib.smart import client, protocol
47
46
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
50
# We must not read any more than 64k at a time so we don't risk "no buffer
51
# space available" errors on some platforms. Windows in particular is likely
52
# to give error 10053 or 10055 if we read more than 64k from a socket.
53
_MAX_READ_SIZE = 64 * 1024
57
56
def _get_protocol_factory_for_bytes(bytes):
58
57
"""Determine the right protocol factory for 'bytes'.
89
88
def _get_line(read_bytes_func):
90
89
"""Read bytes using read_bytes_func until a newline byte.
92
91
This isn't particularly efficient, so should only be used when the
93
92
expected size of the line is quite short.
95
94
:returns: a tuple of two strs: (line, excess)
162
161
line, excess = _get_line(self.read_bytes)
163
162
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
166
class SmartServerStreamMedium(SmartMedium):
180
167
"""Handles smart commands coming over a stream.
185
172
One instance is created for each connected client; it can serve multiple
186
173
requests in the lifetime of the connection.
188
The server passes requests through to an underlying backing transport,
175
The server passes requests through to an underlying backing transport,
189
176
which will typically be a LocalTransport looking at the server's filesystem.
191
178
:ivar _push_back_buffer: a str of bytes that have been read from the stream
274
261
def _serve_one_request_unguarded(self, protocol):
275
262
while protocol.next_read_size():
276
263
# 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)
264
# than _MAX_READ_SIZE ready, the socket wil just return a short
265
# read immediately rather than block.
266
bytes = self.read_bytes(_MAX_READ_SIZE)
281
268
self.finished = True
283
270
protocol.accept_bytes(bytes)
285
272
self._push_back(protocol.unused_data)
287
274
def _read_bytes(self, desired_count):
288
return osutils.read_bytes_from_socket(
289
self.socket, self._report_activity)
275
# We ignore the desired_count because on sockets it's more efficient to
276
# read large chunks (of _MAX_READ_SIZE bytes) at a time.
277
return osutils.until_no_eintr(self.socket.recv, _MAX_READ_SIZE)
291
279
def terminate_due_to_error(self):
292
280
# TODO: This should log to a server log file, but no such thing
295
283
self.finished = True
297
285
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))
286
osutils.send_all(self.socket, bytes)
307
289
class SmartServerPipeStreamMedium(SmartServerStreamMedium):
368
350
request.finished_reading()
370
352
It is up to the individual SmartClientMedium whether multiple concurrent
371
requests can exist. See SmartClientMedium.get_request to obtain instances
372
of SmartClientMediumRequest, and the concrete Medium you are using for
353
requests can exist. See SmartClientMedium.get_request to obtain instances
354
of SmartClientMediumRequest, and the concrete Medium you are using for
373
355
details on concurrency and pipelining.
384
366
def accept_bytes(self, bytes):
385
367
"""Accept bytes for inclusion in this request.
387
This method may not be called after finished_writing() has been
369
This method may not be be called after finished_writing() has been
388
370
called. It depends upon the Medium whether or not the bytes will be
389
371
immediately transmitted. Message based Mediums will tend to buffer the
390
372
bytes until finished_writing() is called.
421
403
def _finished_reading(self):
422
404
"""Helper for finished_reading.
424
finished_reading checks the state of the request to determine if
406
finished_reading checks the state of the request to determine if
425
407
finished_reading is allowed, and if it is hands off to _finished_reading
426
408
to perform the action.
441
423
def _finished_writing(self):
442
424
"""Helper for finished_writing.
444
finished_writing checks the state of the request to determine if
426
finished_writing checks the state of the request to determine if
445
427
finished_writing is allowed, and if it is hands off to _finished_writing
446
428
to perform the action.
478
460
if not line.endswith('\n'):
479
461
# end of file encountered reading from server
480
462
raise errors.ConnectionReset(
481
"Unexpected end of message. Please check connectivity "
482
"and permissions, and report a bug if problems persist.")
463
"please check connectivity and permissions",
464
"(and try -Dhpss if further diagnosis is required)")
485
467
def _read_line(self):
486
468
"""Helper for SmartClientMediumRequest.read_line.
488
470
By default this forwards to self._medium._get_line because we are
489
471
operating on the medium's stream.
514
496
medium_repr = repr(medium)
515
497
# Add this medium to the WeakKeyDictionary
516
self.counts[medium] = dict(count=0, vfs_count=0,
517
medium_repr=medium_repr)
498
self.counts[medium] = [0, medium_repr]
518
499
# Weakref callbacks are fired in reverse order of their association
519
500
# with the referenced object. So we add a weakref *after* adding to
520
501
# the WeakKeyDict so that we can report the value from it before the
524
505
def increment_call_count(self, params):
525
506
# Increment the count in the WeakKeyDictionary
526
507
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
536
510
def done(self, ref):
537
511
value = self.counts[ref]
538
count, vfs_count, medium_repr = (
539
value['count'], value['vfs_count'], value['medium_repr'])
512
count, medium_repr = value
540
513
# In case this callback is invoked for the same ref twice (by the
541
514
# weakref callback and by the atexit function), set the call count back
542
515
# 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)
518
trace.note('HPSS calls: %d %s', count, medium_repr)
549
520
def flush_all(self):
550
521
for ref in list(self.counts.keys()):
553
524
_debug_counter = None
556
527
class SmartClientMedium(SmartMedium):
557
528
"""Smart client is a medium for sending smart protocol requests over."""
607
578
# which is newer than a previously supplied older-than version.
608
579
# This indicates that some smart verb call is not guarded
609
580
# appropriately (it should simply not have been tried).
581
raise AssertionError(
611
582
"_remember_remote_is_before(%r) called, but "
612
583
"_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))
584
% (version_tuple, self._remote_version_is_before))
620
585
self._remote_version_is_before = version_tuple
622
587
def protocol_version(self):
657
622
def disconnect(self):
658
623
"""If this medium maintains a persistent connection, close it.
660
625
The default implementation does nothing.
663
628
def remote_path_from_transport(self, transport):
664
629
"""Convert transport into a path suitable for using in a request.
666
631
Note that the resulting remote path doesn't encode the host name or
667
632
anything but path, so it is only safe to use it in requests sent over
668
633
the medium from the matching transport.
714
679
class SmartSimplePipesClientMedium(SmartClientStreamMedium):
715
680
"""A client medium using simple pipes.
717
682
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
685
def __init__(self, readable_pipe, writeable_pipe, base):
729
690
def _accept_bytes(self, bytes):
730
691
"""See SmartClientStreamMedium.accept_bytes."""
731
692
self._writeable_pipe.write(bytes)
732
self._report_activity(len(bytes), 'write')
734
694
def _flush(self):
735
695
"""See SmartClientStreamMedium._flush()."""
738
698
def _read_bytes(self, count):
739
699
"""See SmartClientStreamMedium._read_bytes."""
740
bytes = osutils.until_no_eintr(self._readable_pipe.read, count)
741
self._report_activity(len(bytes), 'read')
700
return self._readable_pipe.read(count)
745
703
class SmartSSHClientMedium(SmartClientStreamMedium):
746
704
"""A client medium using SSH."""
748
706
def __init__(self, host, port=None, username=None, password=None,
749
707
base=None, vendor=None, bzr_remote_path=None):
750
708
"""Creates a client that will connect on the first use.
752
710
:param vendor: An optional override for the ssh vendor to use. See
753
711
bzrlib.transport.ssh for details on ssh vendors.
713
SmartClientStreamMedium.__init__(self, base)
755
714
self._connected = False
756
715
self._host = host
757
716
self._password = password
758
717
self._port = port
759
718
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
719
self._read_from = None
768
720
self._ssh_connection = None
769
721
self._vendor = vendor
770
722
self._write_to = None
771
723
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__,
724
if self._bzr_remote_path is None:
725
symbol_versioning.warn(
726
'bzr_remote_path is required as of bzr 0.92',
727
DeprecationWarning, stacklevel=2)
728
self._bzr_remote_path = os.environ.get('BZR_REMOTE_PATH', 'bzr')
785
730
def _accept_bytes(self, bytes):
786
731
"""See SmartClientStreamMedium.accept_bytes."""
787
732
self._ensure_connection()
788
733
self._write_to.write(bytes)
789
self._report_activity(len(bytes), 'write')
791
735
def disconnect(self):
792
736
"""See SmartClientMedium.disconnect()."""
822
766
if not self._connected:
823
767
raise errors.MediumNotConnected(self)
824
768
bytes_to_read = min(count, _MAX_READ_SIZE)
825
bytes = self._read_from.read(bytes_to_read)
826
self._report_activity(len(bytes), 'read')
769
return self._read_from.read(bytes_to_read)
830
772
# Port 4155 is the default port for bzr://, registered with IANA.
835
777
class SmartTCPClientMedium(SmartClientStreamMedium):
836
778
"""A client medium using TCP."""
838
780
def __init__(self, host, port, base):
839
781
"""Creates a client that will connect on the first use."""
840
782
SmartClientStreamMedium.__init__(self, base)
846
788
def _accept_bytes(self, bytes):
847
789
"""See SmartClientMedium.accept_bytes."""
848
790
self._ensure_connection()
849
osutils.send_all(self._socket, bytes, self._report_activity)
791
osutils.send_all(self._socket, bytes)
851
793
def disconnect(self):
852
794
"""See SmartClientMedium.disconnect()."""
866
808
port = int(self._port)
868
sockaddrs = socket.getaddrinfo(self._host, port, socket.AF_UNSPEC,
810
sockaddrs = socket.getaddrinfo(self._host, port, socket.AF_UNSPEC,
869
811
socket.SOCK_STREAM, 0, 0)
870
812
except socket.gaierror, (err_num, err_msg):
871
813
raise errors.ConnectionError("failed to lookup %s:%d: %s" %
875
817
for (family, socktype, proto, canonname, sockaddr) in sockaddrs:
877
819
self._socket = socket.socket(family, socktype, proto)
878
self._socket.setsockopt(socket.IPPROTO_TCP,
820
self._socket.setsockopt(socket.IPPROTO_TCP,
879
821
socket.TCP_NODELAY, 1)
880
822
self._socket.connect(sockaddr)
881
823
except socket.error, err:
906
848
"""See SmartClientMedium.read_bytes."""
907
849
if not self._connected:
908
850
raise errors.MediumNotConnected(self)
909
return osutils.read_bytes_from_socket(
910
self._socket, self._report_activity)
851
# We ignore the desired_count because on sockets it's more efficient to
852
# read large chunks (of _MAX_READ_SIZE bytes) at a time.
854
return self._socket.recv(_MAX_READ_SIZE)
855
except socket.error, e:
856
if len(e.args) and e.args[0] == errno.ECONNRESET:
857
# Callers expect an empty string in that case
913
863
class SmartClientStreamMediumRequest(SmartClientMediumRequest):
935
885
def _finished_reading(self):
936
886
"""See SmartClientMediumRequest._finished_reading.
938
This clears the _current_request on self._medium to allow a new
888
This clears the _current_request on self._medium to allow a new
939
889
request to be created.
941
891
if self._medium._current_request is not self:
942
892
raise AssertionError()
943
893
self._medium._current_request = None
945
895
def _finished_writing(self):
946
896
"""See SmartClientMediumRequest._finished_writing.
added
removed
bzrlib/smart/medium.py
