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.
31
32
from bzrlib.lazy_import import lazy_import
32
33
lazy_import(globals(), """
38
36
from bzrlib import (
46
from bzrlib.smart import client, protocol, request, vfs
44
from bzrlib.smart import client, protocol
47
45
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
49
# We must not read any more than 64k at a time so we don't risk "no buffer
50
# space available" errors on some platforms. Windows in particular is likely
51
# to give error 10053 or 10055 if we read more than 64k from a socket.
52
_MAX_READ_SIZE = 64 * 1024
57
55
def _get_protocol_factory_for_bytes(bytes):
58
56
"""Determine the right protocol factory for 'bytes'.
89
87
def _get_line(read_bytes_func):
90
88
"""Read bytes using read_bytes_func until a newline byte.
92
90
This isn't particularly efficient, so should only be used when the
93
91
expected size of the line is quite short.
95
93
:returns: a tuple of two strs: (line, excess)
162
160
line, excess = _get_line(self.read_bytes)
163
161
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
165
class SmartServerStreamMedium(SmartMedium):
180
166
"""Handles smart commands coming over a stream.
185
171
One instance is created for each connected client; it can serve multiple
186
172
requests in the lifetime of the connection.
188
The server passes requests through to an underlying backing transport,
174
The server passes requests through to an underlying backing transport,
189
175
which will typically be a LocalTransport looking at the server's filesystem.
191
177
:ivar _push_back_buffer: a str of bytes that have been read from the stream
274
260
def _serve_one_request_unguarded(self, protocol):
275
261
while protocol.next_read_size():
276
262
# 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)
263
# than _MAX_READ_SIZE ready, the socket wil just return a short
264
# read immediately rather than block.
265
bytes = self.read_bytes(_MAX_READ_SIZE)
281
267
self.finished = True
283
269
protocol.accept_bytes(bytes)
285
271
self._push_back(protocol.unused_data)
287
273
def _read_bytes(self, desired_count):
288
return osutils.read_bytes_from_socket(
289
self.socket, self._report_activity)
274
# We ignore the desired_count because on sockets it's more efficient to
275
# read large chunks (of _MAX_READ_SIZE bytes) at a time.
276
return self.socket.recv(_MAX_READ_SIZE)
291
278
def terminate_due_to_error(self):
292
279
# TODO: This should log to a server log file, but no such thing
295
282
self.finished = True
297
284
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))
285
osutils.send_all(self.socket, bytes)
307
288
class SmartServerPipeStreamMedium(SmartServerStreamMedium):
368
349
request.finished_reading()
370
351
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
352
requests can exist. See SmartClientMedium.get_request to obtain instances
353
of SmartClientMediumRequest, and the concrete Medium you are using for
373
354
details on concurrency and pipelining.
384
365
def accept_bytes(self, bytes):
385
366
"""Accept bytes for inclusion in this request.
387
This method may not be called after finished_writing() has been
368
This method may not be be called after finished_writing() has been
388
369
called. It depends upon the Medium whether or not the bytes will be
389
370
immediately transmitted. Message based Mediums will tend to buffer the
390
371
bytes until finished_writing() is called.
421
402
def _finished_reading(self):
422
403
"""Helper for finished_reading.
424
finished_reading checks the state of the request to determine if
405
finished_reading checks the state of the request to determine if
425
406
finished_reading is allowed, and if it is hands off to _finished_reading
426
407
to perform the action.
441
422
def _finished_writing(self):
442
423
"""Helper for finished_writing.
444
finished_writing checks the state of the request to determine if
425
finished_writing checks the state of the request to determine if
445
426
finished_writing is allowed, and if it is hands off to _finished_writing
446
427
to perform the action.
478
459
if not line.endswith('\n'):
479
460
# end of file encountered reading from server
480
461
raise errors.ConnectionReset(
481
"Unexpected end of message. Please check connectivity "
482
"and permissions, and report a bug if problems persist.")
462
"please check connectivity and permissions",
463
"(and try -Dhpss if further diagnosis is required)")
485
466
def _read_line(self):
486
467
"""Helper for SmartClientMediumRequest.read_line.
488
469
By default this forwards to self._medium._get_line because we are
489
470
operating on the medium's stream.
514
495
medium_repr = repr(medium)
515
496
# Add this medium to the WeakKeyDictionary
516
self.counts[medium] = dict(count=0, vfs_count=0,
517
medium_repr=medium_repr)
497
self.counts[medium] = [0, medium_repr]
518
498
# Weakref callbacks are fired in reverse order of their association
519
499
# with the referenced object. So we add a weakref *after* adding to
520
500
# the WeakKeyDict so that we can report the value from it before the
524
504
def increment_call_count(self, params):
525
505
# Increment the count in the WeakKeyDictionary
526
506
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
509
def done(self, ref):
537
510
value = self.counts[ref]
538
count, vfs_count, medium_repr = (
539
value['count'], value['vfs_count'], value['medium_repr'])
511
count, medium_repr = value
540
512
# In case this callback is invoked for the same ref twice (by the
541
513
# weakref callback and by the atexit function), set the call count back
542
514
# 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)
517
trace.note('HPSS calls: %d %s', count, medium_repr)
549
519
def flush_all(self):
550
520
for ref in list(self.counts.keys()):
553
523
_debug_counter = None
556
526
class SmartClientMedium(SmartMedium):
557
527
"""Smart client is a medium for sending smart protocol requests over."""
604
574
if (self._remote_version_is_before is not None and
605
575
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).
576
raise AssertionError(
611
577
"_remember_remote_is_before(%r) called, but "
612
578
"_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))
579
% (version_tuple, self._remote_version_is_before))
620
580
self._remote_version_is_before = version_tuple
622
582
def protocol_version(self):
657
617
def disconnect(self):
658
618
"""If this medium maintains a persistent connection, close it.
660
620
The default implementation does nothing.
663
623
def remote_path_from_transport(self, transport):
664
624
"""Convert transport into a path suitable for using in a request.
666
626
Note that the resulting remote path doesn't encode the host name or
667
627
anything but path, so it is only safe to use it in requests sent over
668
628
the medium from the matching transport.
714
674
class SmartSimplePipesClientMedium(SmartClientStreamMedium):
715
675
"""A client medium using simple pipes.
717
677
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
680
def __init__(self, readable_pipe, writeable_pipe, base):
729
685
def _accept_bytes(self, bytes):
730
686
"""See SmartClientStreamMedium.accept_bytes."""
731
687
self._writeable_pipe.write(bytes)
732
self._report_activity(len(bytes), 'write')
734
689
def _flush(self):
735
690
"""See SmartClientStreamMedium._flush()."""
738
693
def _read_bytes(self, count):
739
694
"""See SmartClientStreamMedium._read_bytes."""
740
bytes = osutils.until_no_eintr(self._readable_pipe.read, count)
741
self._report_activity(len(bytes), 'read')
695
return self._readable_pipe.read(count)
745
698
class SmartSSHClientMedium(SmartClientStreamMedium):
746
699
"""A client medium using SSH."""
748
701
def __init__(self, host, port=None, username=None, password=None,
749
702
base=None, vendor=None, bzr_remote_path=None):
750
703
"""Creates a client that will connect on the first use.
752
705
:param vendor: An optional override for the ssh vendor to use. See
753
706
bzrlib.transport.ssh for details on ssh vendors.
708
SmartClientStreamMedium.__init__(self, base)
755
709
self._connected = False
756
710
self._host = host
757
711
self._password = password
758
712
self._port = port
759
713
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
714
self._read_from = None
768
715
self._ssh_connection = None
769
716
self._vendor = vendor
770
717
self._write_to = None
771
718
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__,
719
if self._bzr_remote_path is None:
720
symbol_versioning.warn(
721
'bzr_remote_path is required as of bzr 0.92',
722
DeprecationWarning, stacklevel=2)
723
self._bzr_remote_path = os.environ.get('BZR_REMOTE_PATH', 'bzr')
785
725
def _accept_bytes(self, bytes):
786
726
"""See SmartClientStreamMedium.accept_bytes."""
787
727
self._ensure_connection()
788
728
self._write_to.write(bytes)
789
self._report_activity(len(bytes), 'write')
791
730
def disconnect(self):
792
731
"""See SmartClientMedium.disconnect()."""
822
761
if not self._connected:
823
762
raise errors.MediumNotConnected(self)
824
763
bytes_to_read = min(count, _MAX_READ_SIZE)
825
bytes = self._read_from.read(bytes_to_read)
826
self._report_activity(len(bytes), 'read')
764
return self._read_from.read(bytes_to_read)
830
767
# Port 4155 is the default port for bzr://, registered with IANA.
835
772
class SmartTCPClientMedium(SmartClientStreamMedium):
836
773
"""A client medium using TCP."""
838
775
def __init__(self, host, port, base):
839
776
"""Creates a client that will connect on the first use."""
840
777
SmartClientStreamMedium.__init__(self, base)
846
783
def _accept_bytes(self, bytes):
847
784
"""See SmartClientMedium.accept_bytes."""
848
785
self._ensure_connection()
849
osutils.send_all(self._socket, bytes, self._report_activity)
786
osutils.send_all(self._socket, bytes)
851
788
def disconnect(self):
852
789
"""See SmartClientMedium.disconnect()."""
866
803
port = int(self._port)
868
sockaddrs = socket.getaddrinfo(self._host, port, socket.AF_UNSPEC,
805
sockaddrs = socket.getaddrinfo(self._host, port, socket.AF_UNSPEC,
869
806
socket.SOCK_STREAM, 0, 0)
870
807
except socket.gaierror, (err_num, err_msg):
871
808
raise errors.ConnectionError("failed to lookup %s:%d: %s" %
875
812
for (family, socktype, proto, canonname, sockaddr) in sockaddrs:
877
814
self._socket = socket.socket(family, socktype, proto)
878
self._socket.setsockopt(socket.IPPROTO_TCP,
815
self._socket.setsockopt(socket.IPPROTO_TCP,
879
816
socket.TCP_NODELAY, 1)
880
817
self._socket.connect(sockaddr)
881
818
except socket.error, err:
906
843
"""See SmartClientMedium.read_bytes."""
907
844
if not self._connected:
908
845
raise errors.MediumNotConnected(self)
909
return osutils.read_bytes_from_socket(
910
self._socket, self._report_activity)
846
# We ignore the desired_count because on sockets it's more efficient to
847
# read large chunks (of _MAX_READ_SIZE bytes) at a time.
848
return self._socket.recv(_MAX_READ_SIZE)
913
851
class SmartClientStreamMediumRequest(SmartClientMediumRequest):
935
873
def _finished_reading(self):
936
874
"""See SmartClientMediumRequest._finished_reading.
938
This clears the _current_request on self._medium to allow a new
876
This clears the _current_request on self._medium to allow a new
939
877
request to be created.
941
879
if self._medium._current_request is not self:
942
880
raise AssertionError()
943
881
self._medium._current_request = None
945
883
def _finished_writing(self):
946
884
"""See SmartClientMediumRequest._finished_writing.
added
removed
bzrlib/smart/medium.py
