copies: iterate over children directly (instead of parents)
Before this change we would gather all parent → child edges and iterate on
all parent, gathering copy information for children and aggregating them from
there.
They are not strict requirement for edges to be processed in that specific
order. We could also simply iterate over all "children" revision and aggregate
data from both parents at the same time. This patch does that.
It make various things simpler:
* since both parents are processed at the same time, we no longer need to
cache data for merge (see next changeset for details),
* we no longer need nested loop to process data,
* we no longer need to store partial merge data for a rev from distinct loop
interaction to another when processing merges,
* we no longer need to build a full parent -> children mapping (we only rely on
a simpler "parent -> number of children" map (for memory efficiency),
* the data access pattern is now simpler (from lower revisions to higher
revisions) and entirely predicable. That predictability open the way to
prefetching and parallel processing.
So that new iterations order requires simpler code and open the way to
interesting optimisation.
The effect on performance is quite good. In the worse case, we don't see any
significant negative impact. And in the best case, the reduction of roundtrip
to Python provide us with a significant speed. Some example below:
Repo Case Source-Rev Dest-Rev # of revisions old time new time Difference Factor time per rev
---------------------------------------------------------------------------------------------------------------------------------------------------------------
mozilla-try x00000_revs_x00000_added_0_copies
dc8a3ca7010e d16fde900c9c : 34414 revs, 0.962867 s, 0.502584 s, -0.460283 s, × 0.5220, 14 µs/rev
mozilla-try x0000_revs_xx000_added_x_copies
156f6e2674f2 4d0f2c178e66 : 8598 revs, 0.110717 s, 0.076323 s, -0.034394 s, × 0.6894, 8 µs/rev
# full comparison between the previous changeset and this one
Repo Case Source-Rev Dest-Rev # of revisions old time new time Difference Factor time per rev
---------------------------------------------------------------------------------------------------------------------------------------------------------------
mercurial x_revs_x_added_0_copies
ad6b123de1c7 39cfcef4f463 : 1 revs, 0.000048 s, 0.000041 s, -0.000007 s, × 0.8542, 41 µs/rev
mercurial x_revs_x_added_x_copies
2b1c78674230 0c1d10351869 : 6 revs, 0.000153 s, 0.000102 s, -0.000051 s, × 0.6667, 17 µs/rev
mercurial x000_revs_x000_added_x_copies
81f8ff2a9bf2 dd3267698d84 : 1032 revs, 0.004209 s, 0.004254 s, +0.000045 s, × 1.0107, 4 µs/rev
pypy x_revs_x_added_0_copies
aed021ee8ae8 099ed31b181b : 9 revs, 0.000203 s, 0.000282 s, +0.000079 s, × 1.3892, 31 µs/rev
pypy x_revs_x000_added_0_copies
4aa4e1f8e19a 359343b9ac0e : 1 revs, 0.000059 s, 0.000048 s, -0.000011 s, × 0.8136, 48 µs/rev
pypy x_revs_x_added_x_copies
ac52eb7bbbb0 72e022663155 : 7 revs, 0.000194 s, 0.000211 s, +0.000017 s, × 1.0876, 30 µs/rev
pypy x_revs_x00_added_x_copies
c3b14617fbd7 ace7255d9a26 : 1 revs, 0.000380 s, 0.000375 s, -0.000005 s, × 0.9868, 375 µs/rev
pypy x_revs_x000_added_x000_copies
df6f7a526b60 a83dc6a2d56f : 6 revs, 0.010588 s, 0.010574 s, -0.000014 s, × 0.9987, 1762 µs/rev
pypy x000_revs_xx00_added_0_copies
89a76aede314 2f22446ff07e : 4785 revs, 0.048961 s, 0.049974 s, +0.001013 s, × 1.0207, 10 µs/rev
pypy x000_revs_x000_added_x_copies
8a3b5bfd266e 2c68e87c3efe : 6780 revs, 0.083612 s, 0.084300 s, +0.000688 s, × 1.0082, 12 µs/rev
pypy x000_revs_x000_added_x000_copies
89a76aede314 7b3dda341c84 : 5441 revs, 0.058579 s, 0.060128 s, +0.001549 s, × 1.0264, 11 µs/rev
pypy x0000_revs_x_added_0_copies
d1defd0dc478 c9cb1334cc78 : 43645 revs, 0.736783 s, 0.686542 s, -0.050241 s, × 0.9318, 15 µs/rev
pypy x0000_revs_xx000_added_0_copies
bf2c629d0071 4ffed77c095c : 2 revs, 0.022050 s, 0.009277 s, -0.012773 s, × 0.4207, 4638 µs/rev
pypy x0000_revs_xx000_added_x000_copies
08ea3258278e d9fa043f30c0 : 11316 revs, 0.120800 s, 0.114733 s, -0.006067 s, × 0.9498, 10 µs/rev
netbeans x_revs_x_added_0_copies
fb0955ffcbcd a01e9239f9e7 : 2 revs, 0.000140 s, 0.000081 s, -0.000059 s, × 0.5786, 40 µs/rev
netbeans x_revs_x000_added_0_copies
6f360122949f 20eb231cc7d0 : 2 revs, 0.000114 s, 0.000107 s, -0.000007 s, × 0.9386, 53 µs/rev
netbeans x_revs_x_added_x_copies
1ada3faf6fb6 5a39d12eecf4 : 3 revs, 0.000224 s, 0.000173 s, -0.000051 s, × 0.7723, 57 µs/rev
netbeans x_revs_x00_added_x_copies
35be93ba1e2c 9eec5e90c05f : 9 revs, 0.000723 s, 0.000698 s, -0.000025 s, × 0.9654, 77 µs/rev
netbeans x000_revs_xx00_added_0_copies
eac3045b4fdd 51d4ae7f1290 : 1421 revs, 0.009665 s, 0.009248 s, -0.000417 s, × 0.9569, 6 µs/rev
netbeans x000_revs_x000_added_x_copies
e2063d266acd 6081d72689dc : 1533 revs, 0.014820 s, 0.015446 s, +0.000626 s, × 1.0422, 10 µs/rev
netbeans x000_revs_x000_added_x000_copies
ff453e9fee32 411350406ec2 : 5750 revs, 0.076049 s, 0.074373 s, -0.001676 s, × 0.9780, 12 µs/rev
netbeans x0000_revs_xx000_added_x000_copies
588c2d1ced70 1aad62e59ddd : 66949 revs, 0.683603 s, 0.639870 s, -0.043733 s, × 0.9360, 9 µs/rev
mozilla-central x_revs_x_added_0_copies
3697f962bb7b 7015fcdd43a2 : 2 revs, 0.000161 s, 0.000088 s, -0.000073 s, × 0.5466, 44 µs/rev
mozilla-central x_revs_x000_added_0_copies
dd390860c6c9 40d0c5bed75d : 8 revs, 0.000234 s, 0.000199 s, -0.000035 s, × 0.8504, 24 µs/rev
mozilla-central x_revs_x_added_x_copies
8d198483ae3b 14207ffc2b2f : 9 revs, 0.000247 s, 0.000171 s, -0.000076 s, × 0.6923, 19 µs/rev
mozilla-central x_revs_x00_added_x_copies
98cbc58cc6bc 446a150332c3 : 7 revs, 0.000630 s, 0.000592 s, -0.000038 s, × 0.9397, 84 µs/rev
mozilla-central x_revs_x000_added_x000_copies
3c684b4b8f68 0a5e72d1b479 : 3 revs, 0.003286 s, 0.003151 s, -0.000135 s, × 0.9589, 1050 µs/rev
mozilla-central x_revs_x0000_added_x0000_copies
effb563bb7e5 c07a39dc4e80 : 6 revs, 0.062441 s, 0.061612 s, -0.000829 s, × 0.9867, 10268 µs/rev
mozilla-central x000_revs_xx00_added_0_copies
6100d773079a 04a55431795e : 1593 revs, 0.005423 s, 0.005381 s, -0.000042 s, × 0.9923, 3 µs/rev
mozilla-central x000_revs_x000_added_x_copies
9f17a6fc04f9 2d37b966abed : 41 revs, 0.005919 s, 0.003742 s, -0.002177 s, × 0.6322, 91 µs/rev
mozilla-central x000_revs_x000_added_x000_copies
7c97034feb78 4407bd0c6330 : 7839 revs, 0.062597 s, 0.061983 s, -0.000614 s, × 0.9902, 7 µs/rev
mozilla-central x0000_revs_xx000_added_0_copies
9eec5917337d 67118cc6dcad : 615 revs, 0.043551 s, 0.019861 s, -0.023690 s, × 0.4560, 32 µs/rev
mozilla-central x0000_revs_xx000_added_x000_copies
f78c615a656c 96a38b690156 : 30263 revs, 0.192475 s, 0.188101 s, -0.004374 s, × 0.9773, 6 µs/rev
mozilla-central x00000_revs_x0000_added_x0000_copies
6832ae71433c 4c222a1d9a00 : 153721 revs, 1.955575 s, 1.806696 s, -0.148879 s, × 0.9239, 11 µs/rev
mozilla-central x00000_revs_x00000_added_x000_copies
76caed42cf7c 1daa622bbe42 : 204976 revs, 2.886501 s, 2.682987 s, -0.203514 s, × 0.9295, 13 µs/rev
mozilla-try x_revs_x_added_0_copies
aaf6dde0deb8 9790f499805a : 2 revs, 0.001181 s, 0.000852 s, -0.000329 s, × 0.7214, 426 µs/rev
mozilla-try x_revs_x000_added_0_copies
d8d0222927b4 5bb8ce8c7450 : 2 revs, 0.001189 s, 0.000859 s, -0.000330 s, × 0.7225, 429 µs/rev
mozilla-try x_revs_x_added_x_copies
092fcca11bdb 936255a0384a : 4 revs, 0.000563 s, 0.000150 s, -0.000413 s, × 0.2664, 37 µs/rev
mozilla-try x_revs_x00_added_x_copies
b53d2fadbdb5 017afae788ec : 2 revs, 0.001548 s, 0.001158 s, -0.000390 s, × 0.7481, 579 µs/rev
mozilla-try x_revs_x000_added_x000_copies
20408ad61ce5 6f0ee96e21ad : 1 revs, 0.027782 s, 0.027240 s, -0.000542 s, × 0.9805, 27240 µs/rev
mozilla-try x_revs_x0000_added_x0000_copies
effb563bb7e5 c07a39dc4e80 : 6 revs, 0.062781 s, 0.062824 s, +0.000043 s, × 1.0007, 10470 µs/rev
mozilla-try x000_revs_xx00_added_0_copies
6100d773079a 04a55431795e : 1593 revs, 0.005778 s, 0.005463 s, -0.000315 s, × 0.9455, 3 µs/rev
mozilla-try x000_revs_x000_added_x_copies
9f17a6fc04f9 2d37b966abed : 41 revs, 0.006192 s, 0.004238 s, -0.001954 s, × 0.6844, 103 µs/rev
mozilla-try x000_revs_x000_added_x000_copies
1346fd0130e4 4c65cbdabc1f : 6657 revs, 0.065391 s, 0.064113 s, -0.001278 s, × 0.9805, 9 µs/rev
mozilla-try x0000_revs_x_added_0_copies
63519bfd42ee a36a2a865d92 : 40314 revs, 0.317216 s, 0.294063 s, -0.023153 s, × 0.9270, 7 µs/rev
mozilla-try x0000_revs_x_added_x_copies
9fe69ff0762d bcabf2a78927 : 38690 revs, 0.303119 s, 0.281493 s, -0.021626 s, × 0.9287, 7 µs/rev
mozilla-try x0000_revs_xx000_added_x_copies
156f6e2674f2 4d0f2c178e66 : 8598 revs, 0.110717 s, 0.076323 s, -0.034394 s, × 0.6894, 8 µs/rev
mozilla-try x0000_revs_xx000_added_0_copies
9eec5917337d 67118cc6dcad : 615 revs, 0.045739 s, 0.020390 s, -0.025349 s, × 0.4458, 33 µs/rev
mozilla-try x0000_revs_xx000_added_x000_copies
89294cd501d9 7ccb2fc7ccb5 : 97052 revs, 3.098021 s, 3.023879 s, -0.074142 s, × 0.9761, 31 µs/rev
mozilla-try x0000_revs_x0000_added_x0000_copies
e928c65095ed e951f4ad123a : 52031 revs, 0.771480 s, 0.735549 s, -0.035931 s, × 0.9534, 14 µs/rev
mozilla-try x00000_revs_x_added_0_copies
6a320851d377 1ebb79acd503 : 363753 revs, 18.813422 s, 18.568900 s, -0.244522 s, × 0.9870, 51 µs/rev
mozilla-try x00000_revs_x00000_added_0_copies
dc8a3ca7010e d16fde900c9c : 34414 revs, 0.962867 s, 0.502584 s, -0.460283 s, × 0.5220, 14 µs/rev
mozilla-try x00000_revs_x_added_x_copies
5173c4b6f97c 95d83ee7242d : 362229 revs, 18.684923 s, 18.356645 s, -0.328278 s, × 0.9824, 50 µs/rev
mozilla-try x00000_revs_x000_added_x_copies
9126823d0e9c ca82787bb23c : 359344 revs, 18.296305 s, 18.250393 s, -0.045912 s, × 0.9975, 50 µs/rev
mozilla-try x00000_revs_x0000_added_x0000_copies
8d3fafa80d4b eb884023b810 : 192665 revs, 3.061887 s, 2.792459 s, -0.269428 s, × 0.9120, 14 µs/rev
mozilla-try x00000_revs_x00000_added_x0000_copies
1b661134e2ca 1ae03d022d6d : 228985 revs, 103.869641 s, 107.697264 s, +3.827623 s, × 1.0369, 470 µs/rev
mozilla-try x00000_revs_x00000_added_x000_copies
9b2a99adc05e 8e29777b48e6 : 382065 revs, 64.262957 s, 63.961040 s, -0.301917 s, × 0.9953, 167 µs/rev
Differential Revision: https://phab.mercurial-scm.org/D9422
# streamclone.py - producing and consuming streaming repository data
#
# Copyright 2015 Gregory Szorc <gregory.szorc@gmail.com>
#
# This software may be used and distributed according to the terms of the
# GNU General Public License version 2 or any later version.
from __future__ import absolute_import
import contextlib
import os
import struct
from .i18n import _
from .pycompat import open
from .interfaces import repository
from . import (
cacheutil,
error,
narrowspec,
phases,
pycompat,
scmutil,
store,
util,
)
def canperformstreamclone(pullop, bundle2=False):
"""Whether it is possible to perform a streaming clone as part of pull.
``bundle2`` will cause the function to consider stream clone through
bundle2 and only through bundle2.
Returns a tuple of (supported, requirements). ``supported`` is True if
streaming clone is supported and False otherwise. ``requirements`` is
a set of repo requirements from the remote, or ``None`` if stream clone
isn't supported.
"""
repo = pullop.repo
remote = pullop.remote
bundle2supported = False
if pullop.canusebundle2:
if b'v2' in pullop.remotebundle2caps.get(b'stream', []):
bundle2supported = True
# else
# Server doesn't support bundle2 stream clone or doesn't support
# the versions we support. Fall back and possibly allow legacy.
# Ensures legacy code path uses available bundle2.
if bundle2supported and not bundle2:
return False, None
# Ensures bundle2 doesn't try to do a stream clone if it isn't supported.
elif bundle2 and not bundle2supported:
return False, None
# Streaming clone only works on empty repositories.
if len(repo):
return False, None
# Streaming clone only works if all data is being requested.
if pullop.heads:
return False, None
streamrequested = pullop.streamclonerequested
# If we don't have a preference, let the server decide for us. This
# likely only comes into play in LANs.
if streamrequested is None:
# The server can advertise whether to prefer streaming clone.
streamrequested = remote.capable(b'stream-preferred')
if not streamrequested:
return False, None
# In order for stream clone to work, the client has to support all the
# requirements advertised by the server.
#
# The server advertises its requirements via the "stream" and "streamreqs"
# capability. "stream" (a value-less capability) is advertised if and only
# if the only requirement is "revlogv1." Else, the "streamreqs" capability
# is advertised and contains a comma-delimited list of requirements.
requirements = set()
if remote.capable(b'stream'):
requirements.add(b'revlogv1')
else:
streamreqs = remote.capable(b'streamreqs')
# This is weird and shouldn't happen with modern servers.
if not streamreqs:
pullop.repo.ui.warn(
_(
b'warning: stream clone requested but server has them '
b'disabled\n'
)
)
return False, None
streamreqs = set(streamreqs.split(b','))
# Server requires something we don't support. Bail.
missingreqs = streamreqs - repo.supportedformats
if missingreqs:
pullop.repo.ui.warn(
_(
b'warning: stream clone requested but client is missing '
b'requirements: %s\n'
)
% b', '.join(sorted(missingreqs))
)
pullop.repo.ui.warn(
_(
b'(see https://www.mercurial-scm.org/wiki/MissingRequirement '
b'for more information)\n'
)
)
return False, None
requirements = streamreqs
return True, requirements
def maybeperformlegacystreamclone(pullop):
"""Possibly perform a legacy stream clone operation.
Legacy stream clones are performed as part of pull but before all other
operations.
A legacy stream clone will not be performed if a bundle2 stream clone is
supported.
"""
from . import localrepo
supported, requirements = canperformstreamclone(pullop)
if not supported:
return
repo = pullop.repo
remote = pullop.remote
# Save remote branchmap. We will use it later to speed up branchcache
# creation.
rbranchmap = None
if remote.capable(b'branchmap'):
with remote.commandexecutor() as e:
rbranchmap = e.callcommand(b'branchmap', {}).result()
repo.ui.status(_(b'streaming all changes\n'))
with remote.commandexecutor() as e:
fp = e.callcommand(b'stream_out', {}).result()
# TODO strictly speaking, this code should all be inside the context
# manager because the context manager is supposed to ensure all wire state
# is flushed when exiting. But the legacy peers don't do this, so it
# doesn't matter.
l = fp.readline()
try:
resp = int(l)
except ValueError:
raise error.ResponseError(
_(b'unexpected response from remote server:'), l
)
if resp == 1:
raise error.Abort(_(b'operation forbidden by server'))
elif resp == 2:
raise error.Abort(_(b'locking the remote repository failed'))
elif resp != 0:
raise error.Abort(_(b'the server sent an unknown error code'))
l = fp.readline()
try:
filecount, bytecount = map(int, l.split(b' ', 1))
except (ValueError, TypeError):
raise error.ResponseError(
_(b'unexpected response from remote server:'), l
)
with repo.lock():
consumev1(repo, fp, filecount, bytecount)
# new requirements = old non-format requirements +
# new format-related remote requirements
# requirements from the streamed-in repository
repo.requirements = requirements | (
repo.requirements - repo.supportedformats
)
repo.svfs.options = localrepo.resolvestorevfsoptions(
repo.ui, repo.requirements, repo.features
)
scmutil.writereporequirements(repo)
if rbranchmap:
repo._branchcaches.replace(repo, rbranchmap)
repo.invalidate()
def allowservergeneration(repo):
"""Whether streaming clones are allowed from the server."""
if repository.REPO_FEATURE_STREAM_CLONE not in repo.features:
return False
if not repo.ui.configbool(b'server', b'uncompressed', untrusted=True):
return False
# The way stream clone works makes it impossible to hide secret changesets.
# So don't allow this by default.
secret = phases.hassecret(repo)
if secret:
return repo.ui.configbool(b'server', b'uncompressedallowsecret')
return True
# This is it's own function so extensions can override it.
def _walkstreamfiles(repo, matcher=None):
return repo.store.walk(matcher)
def generatev1(repo):
"""Emit content for version 1 of a streaming clone.
This returns a 3-tuple of (file count, byte size, data iterator).
The data iterator consists of N entries for each file being transferred.
Each file entry starts as a line with the file name and integer size
delimited by a null byte.
The raw file data follows. Following the raw file data is the next file
entry, or EOF.
When used on the wire protocol, an additional line indicating protocol
success will be prepended to the stream. This function is not responsible
for adding it.
This function will obtain a repository lock to ensure a consistent view of
the store is captured. It therefore may raise LockError.
"""
entries = []
total_bytes = 0
# Get consistent snapshot of repo, lock during scan.
with repo.lock():
repo.ui.debug(b'scanning\n')
for name, ename, size in _walkstreamfiles(repo):
if size:
entries.append((name, size))
total_bytes += size
repo.ui.debug(
b'%d files, %d bytes to transfer\n' % (len(entries), total_bytes)
)
svfs = repo.svfs
debugflag = repo.ui.debugflag
def emitrevlogdata():
for name, size in entries:
if debugflag:
repo.ui.debug(b'sending %s (%d bytes)\n' % (name, size))
# partially encode name over the wire for backwards compat
yield b'%s\0%d\n' % (store.encodedir(name), size)
# auditing at this stage is both pointless (paths are already
# trusted by the local repo) and expensive
with svfs(name, b'rb', auditpath=False) as fp:
if size <= 65536:
yield fp.read(size)
else:
for chunk in util.filechunkiter(fp, limit=size):
yield chunk
return len(entries), total_bytes, emitrevlogdata()
def generatev1wireproto(repo):
"""Emit content for version 1 of streaming clone suitable for the wire.
This is the data output from ``generatev1()`` with 2 header lines. The
first line indicates overall success. The 2nd contains the file count and
byte size of payload.
The success line contains "0" for success, "1" for stream generation not
allowed, and "2" for error locking the repository (possibly indicating
a permissions error for the server process).
"""
if not allowservergeneration(repo):
yield b'1\n'
return
try:
filecount, bytecount, it = generatev1(repo)
except error.LockError:
yield b'2\n'
return
# Indicates successful response.
yield b'0\n'
yield b'%d %d\n' % (filecount, bytecount)
for chunk in it:
yield chunk
def generatebundlev1(repo, compression=b'UN'):
"""Emit content for version 1 of a stream clone bundle.
The first 4 bytes of the output ("HGS1") denote this as stream clone
bundle version 1.
The next 2 bytes indicate the compression type. Only "UN" is currently
supported.
The next 16 bytes are two 64-bit big endian unsigned integers indicating
file count and byte count, respectively.
The next 2 bytes is a 16-bit big endian unsigned short declaring the length
of the requirements string, including a trailing \0. The following N bytes
are the requirements string, which is ASCII containing a comma-delimited
list of repo requirements that are needed to support the data.
The remaining content is the output of ``generatev1()`` (which may be
compressed in the future).
Returns a tuple of (requirements, data generator).
"""
if compression != b'UN':
raise ValueError(b'we do not support the compression argument yet')
requirements = repo.requirements & repo.supportedformats
requires = b','.join(sorted(requirements))
def gen():
yield b'HGS1'
yield compression
filecount, bytecount, it = generatev1(repo)
repo.ui.status(
_(b'writing %d bytes for %d files\n') % (bytecount, filecount)
)
yield struct.pack(b'>QQ', filecount, bytecount)
yield struct.pack(b'>H', len(requires) + 1)
yield requires + b'\0'
# This is where we'll add compression in the future.
assert compression == b'UN'
progress = repo.ui.makeprogress(
_(b'bundle'), total=bytecount, unit=_(b'bytes')
)
progress.update(0)
for chunk in it:
progress.increment(step=len(chunk))
yield chunk
progress.complete()
return requirements, gen()
def consumev1(repo, fp, filecount, bytecount):
"""Apply the contents from version 1 of a streaming clone file handle.
This takes the output from "stream_out" and applies it to the specified
repository.
Like "stream_out," the status line added by the wire protocol is not
handled by this function.
"""
with repo.lock():
repo.ui.status(
_(b'%d files to transfer, %s of data\n')
% (filecount, util.bytecount(bytecount))
)
progress = repo.ui.makeprogress(
_(b'clone'), total=bytecount, unit=_(b'bytes')
)
progress.update(0)
start = util.timer()
# TODO: get rid of (potential) inconsistency
#
# If transaction is started and any @filecache property is
# changed at this point, it causes inconsistency between
# in-memory cached property and streamclone-ed file on the
# disk. Nested transaction prevents transaction scope "clone"
# below from writing in-memory changes out at the end of it,
# even though in-memory changes are discarded at the end of it
# regardless of transaction nesting.
#
# But transaction nesting can't be simply prohibited, because
# nesting occurs also in ordinary case (e.g. enabling
# clonebundles).
with repo.transaction(b'clone'):
with repo.svfs.backgroundclosing(repo.ui, expectedcount=filecount):
for i in pycompat.xrange(filecount):
# XXX doesn't support '\n' or '\r' in filenames
l = fp.readline()
try:
name, size = l.split(b'\0', 1)
size = int(size)
except (ValueError, TypeError):
raise error.ResponseError(
_(b'unexpected response from remote server:'), l
)
if repo.ui.debugflag:
repo.ui.debug(
b'adding %s (%s)\n' % (name, util.bytecount(size))
)
# for backwards compat, name was partially encoded
path = store.decodedir(name)
with repo.svfs(path, b'w', backgroundclose=True) as ofp:
for chunk in util.filechunkiter(fp, limit=size):
progress.increment(step=len(chunk))
ofp.write(chunk)
# force @filecache properties to be reloaded from
# streamclone-ed file at next access
repo.invalidate(clearfilecache=True)
elapsed = util.timer() - start
if elapsed <= 0:
elapsed = 0.001
progress.complete()
repo.ui.status(
_(b'transferred %s in %.1f seconds (%s/sec)\n')
% (
util.bytecount(bytecount),
elapsed,
util.bytecount(bytecount / elapsed),
)
)
def readbundle1header(fp):
compression = fp.read(2)
if compression != b'UN':
raise error.Abort(
_(
b'only uncompressed stream clone bundles are '
b'supported; got %s'
)
% compression
)
filecount, bytecount = struct.unpack(b'>QQ', fp.read(16))
requireslen = struct.unpack(b'>H', fp.read(2))[0]
requires = fp.read(requireslen)
if not requires.endswith(b'\0'):
raise error.Abort(
_(
b'malformed stream clone bundle: '
b'requirements not properly encoded'
)
)
requirements = set(requires.rstrip(b'\0').split(b','))
return filecount, bytecount, requirements
def applybundlev1(repo, fp):
"""Apply the content from a stream clone bundle version 1.
We assume the 4 byte header has been read and validated and the file handle
is at the 2 byte compression identifier.
"""
if len(repo):
raise error.Abort(
_(b'cannot apply stream clone bundle on non-empty repo')
)
filecount, bytecount, requirements = readbundle1header(fp)
missingreqs = requirements - repo.supportedformats
if missingreqs:
raise error.Abort(
_(b'unable to apply stream clone: unsupported format: %s')
% b', '.join(sorted(missingreqs))
)
consumev1(repo, fp, filecount, bytecount)
class streamcloneapplier(object):
"""Class to manage applying streaming clone bundles.
We need to wrap ``applybundlev1()`` in a dedicated type to enable bundle
readers to perform bundle type-specific functionality.
"""
def __init__(self, fh):
self._fh = fh
def apply(self, repo):
return applybundlev1(repo, self._fh)
# type of file to stream
_fileappend = 0 # append only file
_filefull = 1 # full snapshot file
# Source of the file
_srcstore = b's' # store (svfs)
_srccache = b'c' # cache (cache)
# This is it's own function so extensions can override it.
def _walkstreamfullstorefiles(repo):
"""list snapshot file from the store"""
fnames = []
if not repo.publishing():
fnames.append(b'phaseroots')
return fnames
def _filterfull(entry, copy, vfsmap):
"""actually copy the snapshot files"""
src, name, ftype, data = entry
if ftype != _filefull:
return entry
return (src, name, ftype, copy(vfsmap[src].join(name)))
@contextlib.contextmanager
def maketempcopies():
"""return a function to temporary copy file"""
files = []
try:
def copy(src):
fd, dst = pycompat.mkstemp()
os.close(fd)
files.append(dst)
util.copyfiles(src, dst, hardlink=True)
return dst
yield copy
finally:
for tmp in files:
util.tryunlink(tmp)
def _makemap(repo):
"""make a (src -> vfs) map for the repo"""
vfsmap = {
_srcstore: repo.svfs,
_srccache: repo.cachevfs,
}
# we keep repo.vfs out of the on purpose, ther are too many danger there
# (eg: .hg/hgrc)
assert repo.vfs not in vfsmap.values()
return vfsmap
def _emit2(repo, entries, totalfilesize):
"""actually emit the stream bundle"""
vfsmap = _makemap(repo)
progress = repo.ui.makeprogress(
_(b'bundle'), total=totalfilesize, unit=_(b'bytes')
)
progress.update(0)
with maketempcopies() as copy, progress:
# copy is delayed until we are in the try
entries = [_filterfull(e, copy, vfsmap) for e in entries]
yield None # this release the lock on the repository
seen = 0
for src, name, ftype, data in entries:
vfs = vfsmap[src]
yield src
yield util.uvarintencode(len(name))
if ftype == _fileappend:
fp = vfs(name)
size = data
elif ftype == _filefull:
fp = open(data, b'rb')
size = util.fstat(fp).st_size
try:
yield util.uvarintencode(size)
yield name
if size <= 65536:
chunks = (fp.read(size),)
else:
chunks = util.filechunkiter(fp, limit=size)
for chunk in chunks:
seen += len(chunk)
progress.update(seen)
yield chunk
finally:
fp.close()
def generatev2(repo, includes, excludes, includeobsmarkers):
"""Emit content for version 2 of a streaming clone.
the data stream consists the following entries:
1) A char representing the file destination (eg: store or cache)
2) A varint containing the length of the filename
3) A varint containing the length of file data
4) N bytes containing the filename (the internal, store-agnostic form)
5) N bytes containing the file data
Returns a 3-tuple of (file count, file size, data iterator).
"""
with repo.lock():
entries = []
totalfilesize = 0
matcher = None
if includes or excludes:
matcher = narrowspec.match(repo.root, includes, excludes)
repo.ui.debug(b'scanning\n')
for name, ename, size in _walkstreamfiles(repo, matcher):
if size:
entries.append((_srcstore, name, _fileappend, size))
totalfilesize += size
for name in _walkstreamfullstorefiles(repo):
if repo.svfs.exists(name):
totalfilesize += repo.svfs.lstat(name).st_size
entries.append((_srcstore, name, _filefull, None))
if includeobsmarkers and repo.svfs.exists(b'obsstore'):
totalfilesize += repo.svfs.lstat(b'obsstore').st_size
entries.append((_srcstore, b'obsstore', _filefull, None))
for name in cacheutil.cachetocopy(repo):
if repo.cachevfs.exists(name):
totalfilesize += repo.cachevfs.lstat(name).st_size
entries.append((_srccache, name, _filefull, None))
chunks = _emit2(repo, entries, totalfilesize)
first = next(chunks)
assert first is None
return len(entries), totalfilesize, chunks
@contextlib.contextmanager
def nested(*ctxs):
this = ctxs[0]
rest = ctxs[1:]
with this:
if rest:
with nested(*rest):
yield
else:
yield
def consumev2(repo, fp, filecount, filesize):
"""Apply the contents from a version 2 streaming clone.
Data is read from an object that only needs to provide a ``read(size)``
method.
"""
with repo.lock():
repo.ui.status(
_(b'%d files to transfer, %s of data\n')
% (filecount, util.bytecount(filesize))
)
start = util.timer()
progress = repo.ui.makeprogress(
_(b'clone'), total=filesize, unit=_(b'bytes')
)
progress.update(0)
vfsmap = _makemap(repo)
with repo.transaction(b'clone'):
ctxs = (vfs.backgroundclosing(repo.ui) for vfs in vfsmap.values())
with nested(*ctxs):
for i in range(filecount):
src = util.readexactly(fp, 1)
vfs = vfsmap[src]
namelen = util.uvarintdecodestream(fp)
datalen = util.uvarintdecodestream(fp)
name = util.readexactly(fp, namelen)
if repo.ui.debugflag:
repo.ui.debug(
b'adding [%s] %s (%s)\n'
% (src, name, util.bytecount(datalen))
)
with vfs(name, b'w') as ofp:
for chunk in util.filechunkiter(fp, limit=datalen):
progress.increment(step=len(chunk))
ofp.write(chunk)
# force @filecache properties to be reloaded from
# streamclone-ed file at next access
repo.invalidate(clearfilecache=True)
elapsed = util.timer() - start
if elapsed <= 0:
elapsed = 0.001
repo.ui.status(
_(b'transferred %s in %.1f seconds (%s/sec)\n')
% (
util.bytecount(progress.pos),
elapsed,
util.bytecount(progress.pos / elapsed),
)
)
progress.complete()
def applybundlev2(repo, fp, filecount, filesize, requirements):
from . import localrepo
missingreqs = [r for r in requirements if r not in repo.supported]
if missingreqs:
raise error.Abort(
_(b'unable to apply stream clone: unsupported format: %s')
% b', '.join(sorted(missingreqs))
)
consumev2(repo, fp, filecount, filesize)
# new requirements = old non-format requirements +
# new format-related remote requirements
# requirements from the streamed-in repository
repo.requirements = set(requirements) | (
repo.requirements - repo.supportedformats
)
repo.svfs.options = localrepo.resolvestorevfsoptions(
repo.ui, repo.requirements, repo.features
)
scmutil.writereporequirements(repo)