nodemap: drop the 'exp-' prefix for internal opener option

The feature is now in a descent shape and we can consider having it "less"
experimental.

We won't be able to make it "totally" non-experimental, because its benefit
rely on rust, which is totally experimental.

Differential Revision: https://phab.mercurial-scm.org/D8418

mercurial/changelog.py

@@ -1,629 +1,627 b''
 # changelog.py - changelog class for mercurial
 #
 # Copyright 2005-2007 Matt Mackall <[e-mail]>
 #
 # 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
 
 from .i18n import _
 from .node import (
     bin,
     hex,
     nullid,
 )
 from .thirdparty import attr
 
 from . import (
     copies,
     encoding,
     error,
     pycompat,
     revlog,
 )
 from .utils import (
     dateutil,
     stringutil,
 )
 
 from .revlogutils import sidedata as sidedatamod
 
 _defaultextra = {b'branch': b'default'}
 
 
 def _string_escape(text):
     """
     >>> from .pycompat import bytechr as chr
     >>> d = {b'nl': chr(10), b'bs': chr(92), b'cr': chr(13), b'nul': chr(0)}
     >>> s = b"ab%(nl)scd%(bs)s%(bs)sn%(nul)s12ab%(cr)scd%(bs)s%(nl)s" % d
     >>> s
     'ab\\ncd\\\\\\\\n\\x0012ab\\rcd\\\\\\n'
     >>> res = _string_escape(s)
     >>> s == _string_unescape(res)
     True
     """
     # subset of the string_escape codec
     text = (
         text.replace(b'\\', b'\\\\')
         .replace(b'\n', b'\\n')
         .replace(b'\r', b'\\r')
     )
     return text.replace(b'\0', b'\\0')
 
 
 def _string_unescape(text):
     if b'\\0' in text:
         # fix up \0 without getting into trouble with \\0
         text = text.replace(b'\\\\', b'\\\\\n')
         text = text.replace(b'\\0', b'\0')
         text = text.replace(b'\n', b'')
     return stringutil.unescapestr(text)
 
 
 def decodeextra(text):
     """
     >>> from .pycompat import bytechr as chr
     >>> sorted(decodeextra(encodeextra({b'foo': b'bar', b'baz': chr(0) + b'2'})
     ...                    ).items())
     [('baz', '\\x002'), ('branch', 'default'), ('foo', 'bar')]
     >>> sorted(decodeextra(encodeextra({b'foo': b'bar',
     ...                                 b'baz': chr(92) + chr(0) + b'2'})
     ...                    ).items())
     [('baz', '\\\\\\x002'), ('branch', 'default'), ('foo', 'bar')]
     """
     extra = _defaultextra.copy()
     for l in text.split(b'\0'):
         if l:
             k, v = _string_unescape(l).split(b':', 1)
             extra[k] = v
     return extra
 
 
 def encodeextra(d):
     # keys must be sorted to produce a deterministic changelog entry
     items = [_string_escape(b'%s:%s' % (k, d[k])) for k in sorted(d)]
     return b"\0".join(items)
 
 
 def stripdesc(desc):
     """strip trailing whitespace and leading and trailing empty lines"""
     return b'\n'.join([l.rstrip() for l in desc.splitlines()]).strip(b'\n')
 
 
 class appender(object):
     '''the changelog index must be updated last on disk, so we use this class
     to delay writes to it'''
 
     def __init__(self, vfs, name, mode, buf):
         self.data = buf
         fp = vfs(name, mode)
         self.fp = fp
         self.offset = fp.tell()
         self.size = vfs.fstat(fp).st_size
         self._end = self.size
 
     def end(self):
         return self._end
 
     def tell(self):
         return self.offset
 
     def flush(self):
         pass
 
     @property
     def closed(self):
         return self.fp.closed
 
     def close(self):
         self.fp.close()
 
     def seek(self, offset, whence=0):
         '''virtual file offset spans real file and data'''
         if whence == 0:
             self.offset = offset
         elif whence == 1:
             self.offset += offset
         elif whence == 2:
             self.offset = self.end() + offset
         if self.offset < self.size:
             self.fp.seek(self.offset)
 
     def read(self, count=-1):
         '''only trick here is reads that span real file and data'''
         ret = b""
         if self.offset < self.size:
             s = self.fp.read(count)
             ret = s
             self.offset += len(s)
             if count > 0:
                 count -= len(s)
         if count != 0:
             doff = self.offset - self.size
             self.data.insert(0, b"".join(self.data))
             del self.data[1:]
             s = self.data[0][doff : doff + count]
             self.offset += len(s)
             ret += s
         return ret
 
     def write(self, s):
         self.data.append(bytes(s))
         self.offset += len(s)
         self._end += len(s)
 
     def __enter__(self):
         self.fp.__enter__()
         return self
 
     def __exit__(self, *args):
         return self.fp.__exit__(*args)
 
 
 class _divertopener(object):
     def __init__(self, opener, target):
         self._opener = opener
         self._target = target
 
     def __call__(self, name, mode=b'r', checkambig=False, **kwargs):
         if name != self._target:
             return self._opener(name, mode, **kwargs)
         return self._opener(name + b".a", mode, **kwargs)
 
     def __getattr__(self, attr):
         return getattr(self._opener, attr)
 
 
 def _delayopener(opener, target, buf):
     """build an opener that stores chunks in 'buf' instead of 'target'"""
 
     def _delay(name, mode=b'r', checkambig=False, **kwargs):
         if name != target:
             return opener(name, mode, **kwargs)
         assert not kwargs
         return appender(opener, name, mode, buf)
 
     return _delay
 
 
 @attr.s
 class _changelogrevision(object):
     # Extensions might modify _defaultextra, so let the constructor below pass
     # it in
     extra = attr.ib()
     manifest = attr.ib(default=nullid)
     user = attr.ib(default=b'')
     date = attr.ib(default=(0, 0))
     files = attr.ib(default=attr.Factory(list))
     filesadded = attr.ib(default=None)
     filesremoved = attr.ib(default=None)
     p1copies = attr.ib(default=None)
     p2copies = attr.ib(default=None)
     description = attr.ib(default=b'')
 
 
 class changelogrevision(object):
     """Holds results of a parsed changelog revision.
 
     Changelog revisions consist of multiple pieces of data, including
     the manifest node, user, and date. This object exposes a view into
     the parsed object.
     """
 
     __slots__ = (
         '_offsets',
         '_text',
         '_sidedata',
         '_cpsd',
     )
 
     def __new__(cls, text, sidedata, cpsd):
         if not text:
             return _changelogrevision(extra=_defaultextra)
 
         self = super(changelogrevision, cls).__new__(cls)
         # We could return here and implement the following as an __init__.
         # But doing it here is equivalent and saves an extra function call.
 
         # format used:
         # nodeid\n        : manifest node in ascii
         # user\n          : user, no \n or \r allowed
         # time tz extra\n : date (time is int or float, timezone is int)
         #                 : extra is metadata, encoded and separated by '\0'
         #                 : older versions ignore it
         # files\n\n       : files modified by the cset, no \n or \r allowed
         # (.*)            : comment (free text, ideally utf-8)
         #
         # changelog v0 doesn't use extra
 
         nl1 = text.index(b'\n')
         nl2 = text.index(b'\n', nl1 + 1)
         nl3 = text.index(b'\n', nl2 + 1)
 
         # The list of files may be empty. Which means nl3 is the first of the
         # double newline that precedes the description.
         if text[nl3 + 1 : nl3 + 2] == b'\n':
             doublenl = nl3
         else:
             doublenl = text.index(b'\n\n', nl3 + 1)
 
         self._offsets = (nl1, nl2, nl3, doublenl)
         self._text = text
         self._sidedata = sidedata
         self._cpsd = cpsd
 
         return self
 
     @property
     def manifest(self):
         return bin(self._text[0 : self._offsets[0]])
 
     @property
     def user(self):
         off = self._offsets
         return encoding.tolocal(self._text[off[0] + 1 : off[1]])
 
     @property
     def _rawdate(self):
         off = self._offsets
         dateextra = self._text[off[1] + 1 : off[2]]
         return dateextra.split(b' ', 2)[0:2]
 
     @property
     def _rawextra(self):
         off = self._offsets
         dateextra = self._text[off[1] + 1 : off[2]]
         fields = dateextra.split(b' ', 2)
         if len(fields) != 3:
             return None
 
         return fields[2]
 
     @property
     def date(self):
         raw = self._rawdate
         time = float(raw[0])
         # Various tools did silly things with the timezone.
         try:
             timezone = int(raw[1])
         except ValueError:
             timezone = 0
 
         return time, timezone
 
     @property
     def extra(self):
         raw = self._rawextra
         if raw is None:
             return _defaultextra
 
         return decodeextra(raw)
 
     @property
     def files(self):
         off = self._offsets
         if off[2] == off[3]:
             return []
 
         return self._text[off[2] + 1 : off[3]].split(b'\n')
 
     @property
     def filesadded(self):
         if self._cpsd:
             rawindices = self._sidedata.get(sidedatamod.SD_FILESADDED)
             if not rawindices:
                 return []
         else:
             rawindices = self.extra.get(b'filesadded')
         if rawindices is None:
             return None
         return copies.decodefileindices(self.files, rawindices)
 
     @property
     def filesremoved(self):
         if self._cpsd:
             rawindices = self._sidedata.get(sidedatamod.SD_FILESREMOVED)
             if not rawindices:
                 return []
         else:
             rawindices = self.extra.get(b'filesremoved')
         if rawindices is None:
             return None
         return copies.decodefileindices(self.files, rawindices)
 
     @property
     def p1copies(self):
         if self._cpsd:
             rawcopies = self._sidedata.get(sidedatamod.SD_P1COPIES)
             if not rawcopies:
                 return {}
         else:
             rawcopies = self.extra.get(b'p1copies')
         if rawcopies is None:
             return None
         return copies.decodecopies(self.files, rawcopies)
 
     @property
     def p2copies(self):
         if self._cpsd:
             rawcopies = self._sidedata.get(sidedatamod.SD_P2COPIES)
             if not rawcopies:
                 return {}
         else:
             rawcopies = self.extra.get(b'p2copies')
         if rawcopies is None:
             return None
         return copies.decodecopies(self.files, rawcopies)
 
     @property
     def description(self):
         return encoding.tolocal(self._text[self._offsets[3] + 2 :])
 
 
 class changelog(revlog.revlog):
     def __init__(self, opener, trypending=False):
         """Load a changelog revlog using an opener.
 
         If ``trypending`` is true, we attempt to load the index from a
         ``00changelog.i.a`` file instead of the default ``00changelog.i``.
         The ``00changelog.i.a`` file contains index (and possibly inline
         revision) data for a transaction that hasn't been finalized yet.
         It exists in a separate file to facilitate readers (such as
         hooks processes) accessing data before a transaction is finalized.
         """
         if trypending and opener.exists(b'00changelog.i.a'):
             indexfile = b'00changelog.i.a'
         else:
             indexfile = b'00changelog.i'
 
         datafile = b'00changelog.d'
         revlog.revlog.__init__(
             self,
             opener,
             indexfile,
             datafile=datafile,
             checkambig=True,
             mmaplargeindex=True,
-            persistentnodemap=opener.options.get(
-                b'exp-persistent-nodemap', False
-            ),
+            persistentnodemap=opener.options.get(b'persistent-nodemap', False),
         )
 
         if self._initempty and (self.version & 0xFFFF == revlog.REVLOGV1):
             # changelogs don't benefit from generaldelta.
 
             self.version &= ~revlog.FLAG_GENERALDELTA
             self._generaldelta = False
 
         # Delta chains for changelogs tend to be very small because entries
         # tend to be small and don't delta well with each. So disable delta
         # chains.
         self._storedeltachains = False
 
         self._realopener = opener
         self._delayed = False
         self._delaybuf = None
         self._divert = False
         self.filteredrevs = frozenset()
         self._copiesstorage = opener.options.get(b'copies-storage')
 
     def delayupdate(self, tr):
         """delay visibility of index updates to other readers"""
 
         if not self._delayed:
             if len(self) == 0:
                 self._divert = True
                 if self._realopener.exists(self.indexfile + b'.a'):
                     self._realopener.unlink(self.indexfile + b'.a')
                 self.opener = _divertopener(self._realopener, self.indexfile)
             else:
                 self._delaybuf = []
                 self.opener = _delayopener(
                     self._realopener, self.indexfile, self._delaybuf
                 )
         self._delayed = True
         tr.addpending(b'cl-%i' % id(self), self._writepending)
         tr.addfinalize(b'cl-%i' % id(self), self._finalize)
 
     def _finalize(self, tr):
         """finalize index updates"""
         self._delayed = False
         self.opener = self._realopener
         # move redirected index data back into place
         if self._divert:
             assert not self._delaybuf
             tmpname = self.indexfile + b".a"
             nfile = self.opener.open(tmpname)
             nfile.close()
             self.opener.rename(tmpname, self.indexfile, checkambig=True)
         elif self._delaybuf:
             fp = self.opener(self.indexfile, b'a', checkambig=True)
             fp.write(b"".join(self._delaybuf))
             fp.close()
             self._delaybuf = None
         self._divert = False
         # split when we're done
         self._enforceinlinesize(tr)
 
     def _writepending(self, tr):
         """create a file containing the unfinalized state for
         pretxnchangegroup"""
         if self._delaybuf:
             # make a temporary copy of the index
             fp1 = self._realopener(self.indexfile)
             pendingfilename = self.indexfile + b".a"
             # register as a temp file to ensure cleanup on failure
             tr.registertmp(pendingfilename)
             # write existing data
             fp2 = self._realopener(pendingfilename, b"w")
             fp2.write(fp1.read())
             # add pending data
             fp2.write(b"".join(self._delaybuf))
             fp2.close()
             # switch modes so finalize can simply rename
             self._delaybuf = None
             self._divert = True
             self.opener = _divertopener(self._realopener, self.indexfile)
 
         if self._divert:
             return True
 
         return False
 
     def _enforceinlinesize(self, tr, fp=None):
         if not self._delayed:
             revlog.revlog._enforceinlinesize(self, tr, fp)
 
     def read(self, node):
         """Obtain data from a parsed changelog revision.
 
         Returns a 6-tuple of:
 
            - manifest node in binary
            - author/user as a localstr
            - date as a 2-tuple of (time, timezone)
            - list of files
            - commit message as a localstr
            - dict of extra metadata
 
         Unless you need to access all fields, consider calling
         ``changelogrevision`` instead, as it is faster for partial object
         access.
         """
         d, s = self._revisiondata(node)
         c = changelogrevision(
             d, s, self._copiesstorage == b'changeset-sidedata'
         )
         return (c.manifest, c.user, c.date, c.files, c.description, c.extra)
 
     def changelogrevision(self, nodeorrev):
         """Obtain a ``changelogrevision`` for a node or revision."""
         text, sidedata = self._revisiondata(nodeorrev)
         return changelogrevision(
             text, sidedata, self._copiesstorage == b'changeset-sidedata'
         )
 
     def readfiles(self, node):
         """
         short version of read that only returns the files modified by the cset
         """
         text = self.revision(node)
         if not text:
             return []
         last = text.index(b"\n\n")
         l = text[:last].split(b'\n')
         return l[3:]
 
     def add(
         self,
         manifest,
         files,
         desc,
         transaction,
         p1,
         p2,
         user,
         date=None,
         extra=None,
         p1copies=None,
         p2copies=None,
         filesadded=None,
         filesremoved=None,
     ):
         # Convert to UTF-8 encoded bytestrings as the very first
         # thing: calling any method on a localstr object will turn it
         # into a str object and the cached UTF-8 string is thus lost.
         user, desc = encoding.fromlocal(user), encoding.fromlocal(desc)
 
         user = user.strip()
         # An empty username or a username with a "\n" will make the
         # revision text contain two "\n\n" sequences -> corrupt
         # repository since read cannot unpack the revision.
         if not user:
             raise error.StorageError(_(b"empty username"))
         if b"\n" in user:
             raise error.StorageError(
                 _(b"username %r contains a newline") % pycompat.bytestr(user)
             )
 
         desc = stripdesc(desc)
 
         if date:
             parseddate = b"%d %d" % dateutil.parsedate(date)
         else:
             parseddate = b"%d %d" % dateutil.makedate()
         if extra:
             branch = extra.get(b"branch")
             if branch in (b"default", b""):
                 del extra[b"branch"]
             elif branch in (b".", b"null", b"tip"):
                 raise error.StorageError(
                     _(b'the name \'%s\' is reserved') % branch
                 )
         sortedfiles = sorted(files)
         sidedata = None
         if extra is not None:
             for name in (
                 b'p1copies',
                 b'p2copies',
                 b'filesadded',
                 b'filesremoved',
             ):
                 extra.pop(name, None)
         if p1copies is not None:
             p1copies = copies.encodecopies(sortedfiles, p1copies)
         if p2copies is not None:
             p2copies = copies.encodecopies(sortedfiles, p2copies)
         if filesadded is not None:
             filesadded = copies.encodefileindices(sortedfiles, filesadded)
         if filesremoved is not None:
             filesremoved = copies.encodefileindices(sortedfiles, filesremoved)
         if self._copiesstorage == b'extra':
             extrasentries = p1copies, p2copies, filesadded, filesremoved
             if extra is None and any(x is not None for x in extrasentries):
                 extra = {}
             if p1copies is not None:
                 extra[b'p1copies'] = p1copies
             if p2copies is not None:
                 extra[b'p2copies'] = p2copies
             if filesadded is not None:
                 extra[b'filesadded'] = filesadded
             if filesremoved is not None:
                 extra[b'filesremoved'] = filesremoved
         elif self._copiesstorage == b'changeset-sidedata':
             sidedata = {}
             if p1copies:
                 sidedata[sidedatamod.SD_P1COPIES] = p1copies
             if p2copies:
                 sidedata[sidedatamod.SD_P2COPIES] = p2copies
             if filesadded:
                 sidedata[sidedatamod.SD_FILESADDED] = filesadded
             if filesremoved:
                 sidedata[sidedatamod.SD_FILESREMOVED] = filesremoved
             if not sidedata:
                 sidedata = None
 
         if extra:
             extra = encodeextra(extra)
             parseddate = b"%s %s" % (parseddate, extra)
         l = [hex(manifest), user, parseddate] + sortedfiles + [b"", desc]
         text = b"\n".join(l)
         return self.addrevision(
             text, transaction, len(self), p1, p2, sidedata=sidedata
         )
 
     def branchinfo(self, rev):
         """return the branch name and open/close state of a revision
 
         This function exists because creating a changectx object
         just to access this is costly."""
         extra = self.read(rev)[5]
         return encoding.tolocal(extra.get(b"branch")), b'close' in extra
 
     def _nodeduplicatecallback(self, transaction, node):
         # keep track of revisions that got "re-added", eg: unbunde of know rev.
         #
         # We track them in a list to preserve their order from the source bundle
         duplicates = transaction.changes.setdefault(b'revduplicates', [])
         duplicates.append(self.rev(node))

mercurial/localrepo.py

@@ -1,3828 +1,3828 b''
 # localrepo.py - read/write repository class for mercurial
 #
 # Copyright 2005-2007 Matt Mackall <[e-mail]>
 #
 # 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 errno
 import os
 import random
 import sys
 import time
 import weakref
 
 from .i18n import _
 from .node import (
     bin,
     hex,
     nullid,
     nullrev,
     short,
 )
 from .pycompat import (
     delattr,
     getattr,
 )
 from . import (
     bookmarks,
     branchmap,
     bundle2,
     changegroup,
     color,
     context,
     dirstate,
     dirstateguard,
     discovery,
     encoding,
     error,
     exchange,
     extensions,
     filelog,
     hook,
     lock as lockmod,
     match as matchmod,
     merge as mergemod,
     mergeutil,
     namespaces,
     narrowspec,
     obsolete,
     pathutil,
     phases,
     pushkey,
     pycompat,
     rcutil,
     repoview,
     revset,
     revsetlang,
     scmutil,
     sparse,
     store as storemod,
     subrepoutil,
     tags as tagsmod,
     transaction,
     txnutil,
     util,
     vfs as vfsmod,
 )
 
 from .interfaces import (
     repository,
     util as interfaceutil,
 )
 
 from .utils import (
     hashutil,
     procutil,
     stringutil,
 )
 
 from .revlogutils import constants as revlogconst
 
 release = lockmod.release
 urlerr = util.urlerr
 urlreq = util.urlreq
 
 # set of (path, vfs-location) tuples. vfs-location is:
 # - 'plain for vfs relative paths
 # - '' for svfs relative paths
 _cachedfiles = set()
 
 
 class _basefilecache(scmutil.filecache):
     """All filecache usage on repo are done for logic that should be unfiltered
     """
 
     def __get__(self, repo, type=None):
         if repo is None:
             return self
         # proxy to unfiltered __dict__ since filtered repo has no entry
         unfi = repo.unfiltered()
         try:
             return unfi.__dict__[self.sname]
         except KeyError:
             pass
         return super(_basefilecache, self).__get__(unfi, type)
 
     def set(self, repo, value):
         return super(_basefilecache, self).set(repo.unfiltered(), value)
 
 
 class repofilecache(_basefilecache):
     """filecache for files in .hg but outside of .hg/store"""
 
     def __init__(self, *paths):
         super(repofilecache, self).__init__(*paths)
         for path in paths:
             _cachedfiles.add((path, b'plain'))
 
     def join(self, obj, fname):
         return obj.vfs.join(fname)
 
 
 class storecache(_basefilecache):
     """filecache for files in the store"""
 
     def __init__(self, *paths):
         super(storecache, self).__init__(*paths)
         for path in paths:
             _cachedfiles.add((path, b''))
 
     def join(self, obj, fname):
         return obj.sjoin(fname)
 
 
 class mixedrepostorecache(_basefilecache):
     """filecache for a mix files in .hg/store and outside"""
 
     def __init__(self, *pathsandlocations):
         # scmutil.filecache only uses the path for passing back into our
         # join(), so we can safely pass a list of paths and locations
         super(mixedrepostorecache, self).__init__(*pathsandlocations)
         _cachedfiles.update(pathsandlocations)
 
     def join(self, obj, fnameandlocation):
         fname, location = fnameandlocation
         if location == b'plain':
             return obj.vfs.join(fname)
         else:
             if location != b'':
                 raise error.ProgrammingError(
                     b'unexpected location: %s' % location
                 )
             return obj.sjoin(fname)
 
 
 def isfilecached(repo, name):
     """check if a repo has already cached "name" filecache-ed property
 
     This returns (cachedobj-or-None, iscached) tuple.
     """
     cacheentry = repo.unfiltered()._filecache.get(name, None)
     if not cacheentry:
         return None, False
     return cacheentry.obj, True
 
 
 class unfilteredpropertycache(util.propertycache):
     """propertycache that apply to unfiltered repo only"""
 
     def __get__(self, repo, type=None):
         unfi = repo.unfiltered()
         if unfi is repo:
             return super(unfilteredpropertycache, self).__get__(unfi)
         return getattr(unfi, self.name)
 
 
 class filteredpropertycache(util.propertycache):
     """propertycache that must take filtering in account"""
 
     def cachevalue(self, obj, value):
         object.__setattr__(obj, self.name, value)
 
 
 def hasunfilteredcache(repo, name):
     """check if a repo has an unfilteredpropertycache value for <name>"""
     return name in vars(repo.unfiltered())
 
 
 def unfilteredmethod(orig):
     """decorate method that always need to be run on unfiltered version"""
 
     def wrapper(repo, *args, **kwargs):
         return orig(repo.unfiltered(), *args, **kwargs)
 
     return wrapper
 
 
 moderncaps = {
     b'lookup',
     b'branchmap',
     b'pushkey',
     b'known',
     b'getbundle',
     b'unbundle',
 }
 legacycaps = moderncaps.union({b'changegroupsubset'})
 
 
 @interfaceutil.implementer(repository.ipeercommandexecutor)
 class localcommandexecutor(object):
     def __init__(self, peer):
         self._peer = peer
         self._sent = False
         self._closed = False
 
     def __enter__(self):
         return self
 
     def __exit__(self, exctype, excvalue, exctb):
         self.close()
 
     def callcommand(self, command, args):
         if self._sent:
             raise error.ProgrammingError(
                 b'callcommand() cannot be used after sendcommands()'
             )
 
         if self._closed:
             raise error.ProgrammingError(
                 b'callcommand() cannot be used after close()'
             )
 
         # We don't need to support anything fancy. Just call the named
         # method on the peer and return a resolved future.
         fn = getattr(self._peer, pycompat.sysstr(command))
 
         f = pycompat.futures.Future()
 
         try:
             result = fn(**pycompat.strkwargs(args))
         except Exception:
             pycompat.future_set_exception_info(f, sys.exc_info()[1:])
         else:
             f.set_result(result)
 
         return f
 
     def sendcommands(self):
         self._sent = True
 
     def close(self):
         self._closed = True
 
 
 @interfaceutil.implementer(repository.ipeercommands)
 class localpeer(repository.peer):
     '''peer for a local repo; reflects only the most recent API'''
 
     def __init__(self, repo, caps=None):
         super(localpeer, self).__init__()
 
         if caps is None:
             caps = moderncaps.copy()
         self._repo = repo.filtered(b'served')
         self.ui = repo.ui
         self._caps = repo._restrictcapabilities(caps)
 
     # Begin of _basepeer interface.
 
     def url(self):
         return self._repo.url()
 
     def local(self):
         return self._repo
 
     def peer(self):
         return self
 
     def canpush(self):
         return True
 
     def close(self):
         self._repo.close()
 
     # End of _basepeer interface.
 
     # Begin of _basewirecommands interface.
 
     def branchmap(self):
         return self._repo.branchmap()
 
     def capabilities(self):
         return self._caps
 
     def clonebundles(self):
         return self._repo.tryread(b'clonebundles.manifest')
 
     def debugwireargs(self, one, two, three=None, four=None, five=None):
         """Used to test argument passing over the wire"""
         return b"%s %s %s %s %s" % (
             one,
             two,
             pycompat.bytestr(three),
             pycompat.bytestr(four),
             pycompat.bytestr(five),
         )
 
     def getbundle(
         self, source, heads=None, common=None, bundlecaps=None, **kwargs
     ):
         chunks = exchange.getbundlechunks(
             self._repo,
             source,
             heads=heads,
             common=common,
             bundlecaps=bundlecaps,
             **kwargs
         )[1]
         cb = util.chunkbuffer(chunks)
 
         if exchange.bundle2requested(bundlecaps):
             # When requesting a bundle2, getbundle returns a stream to make the
             # wire level function happier. We need to build a proper object
             # from it in local peer.
             return bundle2.getunbundler(self.ui, cb)
         else:
             return changegroup.getunbundler(b'01', cb, None)
 
     def heads(self):
         return self._repo.heads()
 
     def known(self, nodes):
         return self._repo.known(nodes)
 
     def listkeys(self, namespace):
         return self._repo.listkeys(namespace)
 
     def lookup(self, key):
         return self._repo.lookup(key)
 
     def pushkey(self, namespace, key, old, new):
         return self._repo.pushkey(namespace, key, old, new)
 
     def stream_out(self):
         raise error.Abort(_(b'cannot perform stream clone against local peer'))
 
     def unbundle(self, bundle, heads, url):
         """apply a bundle on a repo
 
         This function handles the repo locking itself."""
         try:
             try:
                 bundle = exchange.readbundle(self.ui, bundle, None)
                 ret = exchange.unbundle(self._repo, bundle, heads, b'push', url)
                 if util.safehasattr(ret, b'getchunks'):
                     # This is a bundle20 object, turn it into an unbundler.
                     # This little dance should be dropped eventually when the
                     # API is finally improved.
                     stream = util.chunkbuffer(ret.getchunks())
                     ret = bundle2.getunbundler(self.ui, stream)
                 return ret
             except Exception as exc:
                 # If the exception contains output salvaged from a bundle2
                 # reply, we need to make sure it is printed before continuing
                 # to fail. So we build a bundle2 with such output and consume
                 # it directly.
                 #
                 # This is not very elegant but allows a "simple" solution for
                 # issue4594
                 output = getattr(exc, '_bundle2salvagedoutput', ())
                 if output:
                     bundler = bundle2.bundle20(self._repo.ui)
                     for out in output:
                         bundler.addpart(out)
                     stream = util.chunkbuffer(bundler.getchunks())
                     b = bundle2.getunbundler(self.ui, stream)
                     bundle2.processbundle(self._repo, b)
                 raise
         except error.PushRaced as exc:
             raise error.ResponseError(
                 _(b'push failed:'), stringutil.forcebytestr(exc)
             )
 
     # End of _basewirecommands interface.
 
     # Begin of peer interface.
 
     def commandexecutor(self):
         return localcommandexecutor(self)
 
     # End of peer interface.
 
 
 @interfaceutil.implementer(repository.ipeerlegacycommands)
 class locallegacypeer(localpeer):
     '''peer extension which implements legacy methods too; used for tests with
     restricted capabilities'''
 
     def __init__(self, repo):
         super(locallegacypeer, self).__init__(repo, caps=legacycaps)
 
     # Begin of baselegacywirecommands interface.
 
     def between(self, pairs):
         return self._repo.between(pairs)
 
     def branches(self, nodes):
         return self._repo.branches(nodes)
 
     def changegroup(self, nodes, source):
         outgoing = discovery.outgoing(
             self._repo, missingroots=nodes, missingheads=self._repo.heads()
         )
         return changegroup.makechangegroup(self._repo, outgoing, b'01', source)
 
     def changegroupsubset(self, bases, heads, source):
         outgoing = discovery.outgoing(
             self._repo, missingroots=bases, missingheads=heads
         )
         return changegroup.makechangegroup(self._repo, outgoing, b'01', source)
 
     # End of baselegacywirecommands interface.
 
 
 # Increment the sub-version when the revlog v2 format changes to lock out old
 # clients.
 REVLOGV2_REQUIREMENT = b'exp-revlogv2.1'
 
 # A repository with the sparserevlog feature will have delta chains that
 # can spread over a larger span. Sparse reading cuts these large spans into
 # pieces, so that each piece isn't too big.
 # Without the sparserevlog capability, reading from the repository could use
 # huge amounts of memory, because the whole span would be read at once,
 # including all the intermediate revisions that aren't pertinent for the chain.
 # This is why once a repository has enabled sparse-read, it becomes required.
 SPARSEREVLOG_REQUIREMENT = b'sparserevlog'
 
 # A repository with the sidedataflag requirement will allow to store extra
 # information for revision without altering their original hashes.
 SIDEDATA_REQUIREMENT = b'exp-sidedata-flag'
 
 # A repository with the the copies-sidedata-changeset requirement will store
 # copies related information in changeset's sidedata.
 COPIESSDC_REQUIREMENT = b'exp-copies-sidedata-changeset'
 
 # The repository use persistent nodemap for the changelog and the manifest.
 NODEMAP_REQUIREMENT = b'persistent-nodemap'
 
 # Functions receiving (ui, features) that extensions can register to impact
 # the ability to load repositories with custom requirements. Only
 # functions defined in loaded extensions are called.
 #
 # The function receives a set of requirement strings that the repository
 # is capable of opening. Functions will typically add elements to the
 # set to reflect that the extension knows how to handle that requirements.
 featuresetupfuncs = set()
 
 
 def makelocalrepository(baseui, path, intents=None):
     """Create a local repository object.
 
     Given arguments needed to construct a local repository, this function
     performs various early repository loading functionality (such as
     reading the ``.hg/requires`` and ``.hg/hgrc`` files), validates that
     the repository can be opened, derives a type suitable for representing
     that repository, and returns an instance of it.
 
     The returned object conforms to the ``repository.completelocalrepository``
     interface.
 
     The repository type is derived by calling a series of factory functions
     for each aspect/interface of the final repository. These are defined by
     ``REPO_INTERFACES``.
 
     Each factory function is called to produce a type implementing a specific
     interface. The cumulative list of returned types will be combined into a
     new type and that type will be instantiated to represent the local
     repository.
 
     The factory functions each receive various state that may be consulted
     as part of deriving a type.
 
     Extensions should wrap these factory functions to customize repository type
     creation. Note that an extension's wrapped function may be called even if
     that extension is not loaded for the repo being constructed. Extensions
     should check if their ``__name__`` appears in the
     ``extensionmodulenames`` set passed to the factory function and no-op if
     not.
     """
     ui = baseui.copy()
     # Prevent copying repo configuration.
     ui.copy = baseui.copy
 
     # Working directory VFS rooted at repository root.
     wdirvfs = vfsmod.vfs(path, expandpath=True, realpath=True)
 
     # Main VFS for .hg/ directory.
     hgpath = wdirvfs.join(b'.hg')
     hgvfs = vfsmod.vfs(hgpath, cacheaudited=True)
 
     # The .hg/ path should exist and should be a directory. All other
     # cases are errors.
     if not hgvfs.isdir():
         try:
             hgvfs.stat()
         except OSError as e:
             if e.errno != errno.ENOENT:
                 raise
 
         raise error.RepoError(_(b'repository %s not found') % path)
 
     # .hg/requires file contains a newline-delimited list of
     # features/capabilities the opener (us) must have in order to use
     # the repository. This file was introduced in Mercurial 0.9.2,
     # which means very old repositories may not have one. We assume
     # a missing file translates to no requirements.
     try:
         requirements = set(hgvfs.read(b'requires').splitlines())
     except IOError as e:
         if e.errno != errno.ENOENT:
             raise
         requirements = set()
 
     # The .hg/hgrc file may load extensions or contain config options
     # that influence repository construction. Attempt to load it and
     # process any new extensions that it may have pulled in.
     if loadhgrc(ui, wdirvfs, hgvfs, requirements):
         afterhgrcload(ui, wdirvfs, hgvfs, requirements)
         extensions.loadall(ui)
         extensions.populateui(ui)
 
     # Set of module names of extensions loaded for this repository.
     extensionmodulenames = {m.__name__ for n, m in extensions.extensions(ui)}
 
     supportedrequirements = gathersupportedrequirements(ui)
 
     # We first validate the requirements are known.
     ensurerequirementsrecognized(requirements, supportedrequirements)
 
     # Then we validate that the known set is reasonable to use together.
     ensurerequirementscompatible(ui, requirements)
 
     # TODO there are unhandled edge cases related to opening repositories with
     # shared storage. If storage is shared, we should also test for requirements
     # compatibility in the pointed-to repo. This entails loading the .hg/hgrc in
     # that repo, as that repo may load extensions needed to open it. This is a
     # bit complicated because we don't want the other hgrc to overwrite settings
     # in this hgrc.
     #
     # This bug is somewhat mitigated by the fact that we copy the .hg/requires
     # file when sharing repos. But if a requirement is added after the share is
     # performed, thereby introducing a new requirement for the opener, we may
     # will not see that and could encounter a run-time error interacting with
     # that shared store since it has an unknown-to-us requirement.
 
     # At this point, we know we should be capable of opening the repository.
     # Now get on with doing that.
 
     features = set()
 
     # The "store" part of the repository holds versioned data. How it is
     # accessed is determined by various requirements. The ``shared`` or
     # ``relshared`` requirements indicate the store lives in the path contained
     # in the ``.hg/sharedpath`` file. This is an absolute path for
     # ``shared`` and relative to ``.hg/`` for ``relshared``.
     if b'shared' in requirements or b'relshared' in requirements:
         sharedpath = hgvfs.read(b'sharedpath').rstrip(b'\n')
         if b'relshared' in requirements:
             sharedpath = hgvfs.join(sharedpath)
 
         sharedvfs = vfsmod.vfs(sharedpath, realpath=True)
 
         if not sharedvfs.exists():
             raise error.RepoError(
                 _(b'.hg/sharedpath points to nonexistent directory %s')
                 % sharedvfs.base
             )
 
         features.add(repository.REPO_FEATURE_SHARED_STORAGE)
 
         storebasepath = sharedvfs.base
         cachepath = sharedvfs.join(b'cache')
     else:
         storebasepath = hgvfs.base
         cachepath = hgvfs.join(b'cache')
     wcachepath = hgvfs.join(b'wcache')
 
     # The store has changed over time and the exact layout is dictated by
     # requirements. The store interface abstracts differences across all
     # of them.
     store = makestore(
         requirements,
         storebasepath,
         lambda base: vfsmod.vfs(base, cacheaudited=True),
     )
     hgvfs.createmode = store.createmode
 
     storevfs = store.vfs
     storevfs.options = resolvestorevfsoptions(ui, requirements, features)
 
     # The cache vfs is used to manage cache files.
     cachevfs = vfsmod.vfs(cachepath, cacheaudited=True)
     cachevfs.createmode = store.createmode
     # The cache vfs is used to manage cache files related to the working copy
     wcachevfs = vfsmod.vfs(wcachepath, cacheaudited=True)
     wcachevfs.createmode = store.createmode
 
     # Now resolve the type for the repository object. We do this by repeatedly
     # calling a factory function to produces types for specific aspects of the
     # repo's operation. The aggregate returned types are used as base classes
     # for a dynamically-derived type, which will represent our new repository.
 
     bases = []
     extrastate = {}
 
     for iface, fn in REPO_INTERFACES:
         # We pass all potentially useful state to give extensions tons of
         # flexibility.
         typ = fn()(
             ui=ui,
             intents=intents,
             requirements=requirements,
             features=features,
             wdirvfs=wdirvfs,
             hgvfs=hgvfs,
             store=store,
             storevfs=storevfs,
             storeoptions=storevfs.options,
             cachevfs=cachevfs,
             wcachevfs=wcachevfs,
             extensionmodulenames=extensionmodulenames,
             extrastate=extrastate,
             baseclasses=bases,
         )
 
         if not isinstance(typ, type):
             raise error.ProgrammingError(
                 b'unable to construct type for %s' % iface
             )
 
         bases.append(typ)
 
     # type() allows you to use characters in type names that wouldn't be
     # recognized as Python symbols in source code. We abuse that to add
     # rich information about our constructed repo.
     name = pycompat.sysstr(
         b'derivedrepo:%s<%s>' % (wdirvfs.base, b','.join(sorted(requirements)))
     )
 
     cls = type(name, tuple(bases), {})
 
     return cls(
         baseui=baseui,
         ui=ui,
         origroot=path,
         wdirvfs=wdirvfs,
         hgvfs=hgvfs,
         requirements=requirements,
         supportedrequirements=supportedrequirements,
         sharedpath=storebasepath,
         store=store,
         cachevfs=cachevfs,
         wcachevfs=wcachevfs,
         features=features,
         intents=intents,
     )
 
 
 def loadhgrc(ui, wdirvfs, hgvfs, requirements):
     """Load hgrc files/content into a ui instance.
 
     This is called during repository opening to load any additional
     config files or settings relevant to the current repository.
 
     Returns a bool indicating whether any additional configs were loaded.
 
     Extensions should monkeypatch this function to modify how per-repo
     configs are loaded. For example, an extension may wish to pull in
     configs from alternate files or sources.
     """
     if not rcutil.use_repo_hgrc():
         return False
     try:
         ui.readconfig(hgvfs.join(b'hgrc'), root=wdirvfs.base)
         return True
     except IOError:
         return False
 
 
 def afterhgrcload(ui, wdirvfs, hgvfs, requirements):
     """Perform additional actions after .hg/hgrc is loaded.
 
     This function is called during repository loading immediately after
     the .hg/hgrc file is loaded and before per-repo extensions are loaded.
 
     The function can be used to validate configs, automatically add
     options (including extensions) based on requirements, etc.
     """
 
     # Map of requirements to list of extensions to load automatically when
     # requirement is present.
     autoextensions = {
         b'git': [b'git'],
         b'largefiles': [b'largefiles'],
         b'lfs': [b'lfs'],
     }
 
     for requirement, names in sorted(autoextensions.items()):
         if requirement not in requirements:
             continue
 
         for name in names:
             if not ui.hasconfig(b'extensions', name):
                 ui.setconfig(b'extensions', name, b'', source=b'autoload')
 
 
 def gathersupportedrequirements(ui):
     """Determine the complete set of recognized requirements."""
     # Start with all requirements supported by this file.
     supported = set(localrepository._basesupported)
 
     # Execute ``featuresetupfuncs`` entries if they belong to an extension
     # relevant to this ui instance.
     modules = {m.__name__ for n, m in extensions.extensions(ui)}
 
     for fn in featuresetupfuncs:
         if fn.__module__ in modules:
             fn(ui, supported)
 
     # Add derived requirements from registered compression engines.
     for name in util.compengines:
         engine = util.compengines[name]
         if engine.available() and engine.revlogheader():
             supported.add(b'exp-compression-%s' % name)
             if engine.name() == b'zstd':
                 supported.add(b'revlog-compression-zstd')
 
     return supported
 
 
 def ensurerequirementsrecognized(requirements, supported):
     """Validate that a set of local requirements is recognized.
 
     Receives a set of requirements. Raises an ``error.RepoError`` if there
     exists any requirement in that set that currently loaded code doesn't
     recognize.
 
     Returns a set of supported requirements.
     """
     missing = set()
 
     for requirement in requirements:
         if requirement in supported:
             continue
 
         if not requirement or not requirement[0:1].isalnum():
             raise error.RequirementError(_(b'.hg/requires file is corrupt'))
 
         missing.add(requirement)
 
     if missing:
         raise error.RequirementError(
             _(b'repository requires features unknown to this Mercurial: %s')
             % b' '.join(sorted(missing)),
             hint=_(
                 b'see https://mercurial-scm.org/wiki/MissingRequirement '
                 b'for more information'
             ),
         )
 
 
 def ensurerequirementscompatible(ui, requirements):
     """Validates that a set of recognized requirements is mutually compatible.
 
     Some requirements may not be compatible with others or require
     config options that aren't enabled. This function is called during
     repository opening to ensure that the set of requirements needed
     to open a repository is sane and compatible with config options.
 
     Extensions can monkeypatch this function to perform additional
     checking.
 
     ``error.RepoError`` should be raised on failure.
     """
     if b'exp-sparse' in requirements and not sparse.enabled:
         raise error.RepoError(
             _(
                 b'repository is using sparse feature but '
                 b'sparse is not enabled; enable the '
                 b'"sparse" extensions to access'
             )
         )
 
 
 def makestore(requirements, path, vfstype):
     """Construct a storage object for a repository."""
     if b'store' in requirements:
         if b'fncache' in requirements:
             return storemod.fncachestore(
                 path, vfstype, b'dotencode' in requirements
             )
 
         return storemod.encodedstore(path, vfstype)
 
     return storemod.basicstore(path, vfstype)
 
 
 def resolvestorevfsoptions(ui, requirements, features):
     """Resolve the options to pass to the store vfs opener.
 
     The returned dict is used to influence behavior of the storage layer.
     """
     options = {}
 
     if b'treemanifest' in requirements:
         options[b'treemanifest'] = True
 
     # experimental config: format.manifestcachesize
     manifestcachesize = ui.configint(b'format', b'manifestcachesize')
     if manifestcachesize is not None:
         options[b'manifestcachesize'] = manifestcachesize
 
     # In the absence of another requirement superseding a revlog-related
     # requirement, we have to assume the repo is using revlog version 0.
     # This revlog format is super old and we don't bother trying to parse
     # opener options for it because those options wouldn't do anything
     # meaningful on such old repos.
     if b'revlogv1' in requirements or REVLOGV2_REQUIREMENT in requirements:
         options.update(resolverevlogstorevfsoptions(ui, requirements, features))
     else:  # explicitly mark repo as using revlogv0
         options[b'revlogv0'] = True
 
     if COPIESSDC_REQUIREMENT in requirements:
         options[b'copies-storage'] = b'changeset-sidedata'
     else:
         writecopiesto = ui.config(b'experimental', b'copies.write-to')
         copiesextramode = (b'changeset-only', b'compatibility')
         if writecopiesto in copiesextramode:
             options[b'copies-storage'] = b'extra'
 
     return options
 
 
 def resolverevlogstorevfsoptions(ui, requirements, features):
     """Resolve opener options specific to revlogs."""
 
     options = {}
     options[b'flagprocessors'] = {}
 
     if b'revlogv1' in requirements:
         options[b'revlogv1'] = True
     if REVLOGV2_REQUIREMENT in requirements:
         options[b'revlogv2'] = True
 
     if b'generaldelta' in requirements:
         options[b'generaldelta'] = True
 
     # experimental config: format.chunkcachesize
     chunkcachesize = ui.configint(b'format', b'chunkcachesize')
     if chunkcachesize is not None:
         options[b'chunkcachesize'] = chunkcachesize
 
     deltabothparents = ui.configbool(
         b'storage', b'revlog.optimize-delta-parent-choice'
     )
     options[b'deltabothparents'] = deltabothparents
 
     lazydelta = ui.configbool(b'storage', b'revlog.reuse-external-delta')
     lazydeltabase = False
     if lazydelta:
         lazydeltabase = ui.configbool(
             b'storage', b'revlog.reuse-external-delta-parent'
         )
     if lazydeltabase is None:
         lazydeltabase = not scmutil.gddeltaconfig(ui)
     options[b'lazydelta'] = lazydelta
     options[b'lazydeltabase'] = lazydeltabase
 
     chainspan = ui.configbytes(b'experimental', b'maxdeltachainspan')
     if 0 <= chainspan:
         options[b'maxdeltachainspan'] = chainspan
 
     mmapindexthreshold = ui.configbytes(b'experimental', b'mmapindexthreshold')
     if mmapindexthreshold is not None:
         options[b'mmapindexthreshold'] = mmapindexthreshold
 
     withsparseread = ui.configbool(b'experimental', b'sparse-read')
     srdensitythres = float(
         ui.config(b'experimental', b'sparse-read.density-threshold')
     )
     srmingapsize = ui.configbytes(b'experimental', b'sparse-read.min-gap-size')
     options[b'with-sparse-read'] = withsparseread
     options[b'sparse-read-density-threshold'] = srdensitythres
     options[b'sparse-read-min-gap-size'] = srmingapsize
 
     sparserevlog = SPARSEREVLOG_REQUIREMENT in requirements
     options[b'sparse-revlog'] = sparserevlog
     if sparserevlog:
         options[b'generaldelta'] = True
 
     sidedata = SIDEDATA_REQUIREMENT in requirements
     options[b'side-data'] = sidedata
 
     maxchainlen = None
     if sparserevlog:
         maxchainlen = revlogconst.SPARSE_REVLOG_MAX_CHAIN_LENGTH
     # experimental config: format.maxchainlen
     maxchainlen = ui.configint(b'format', b'maxchainlen', maxchainlen)
     if maxchainlen is not None:
         options[b'maxchainlen'] = maxchainlen
 
     for r in requirements:
         # we allow multiple compression engine requirement to co-exist because
         # strickly speaking, revlog seems to support mixed compression style.
         #
         # The compression used for new entries will be "the last one"
         prefix = r.startswith
         if prefix(b'revlog-compression-') or prefix(b'exp-compression-'):
             options[b'compengine'] = r.split(b'-', 2)[2]
 
     options[b'zlib.level'] = ui.configint(b'storage', b'revlog.zlib.level')
     if options[b'zlib.level'] is not None:
         if not (0 <= options[b'zlib.level'] <= 9):
             msg = _(b'invalid value for `storage.revlog.zlib.level` config: %d')
             raise error.Abort(msg % options[b'zlib.level'])
     options[b'zstd.level'] = ui.configint(b'storage', b'revlog.zstd.level')
     if options[b'zstd.level'] is not None:
         if not (0 <= options[b'zstd.level'] <= 22):
             msg = _(b'invalid value for `storage.revlog.zstd.level` config: %d')
             raise error.Abort(msg % options[b'zstd.level'])
 
     if repository.NARROW_REQUIREMENT in requirements:
         options[b'enableellipsis'] = True
 
     if ui.configbool(b'experimental', b'rust.index'):
         options[b'rust.index'] = True
     if NODEMAP_REQUIREMENT in requirements:
-        options[b'exp-persistent-nodemap'] = True
+        options[b'persistent-nodemap'] = True
     if ui.configbool(b'experimental', b'exp-persistent-nodemap.mmap'):
-        options[b'exp-persistent-nodemap.mmap'] = True
+        options[b'persistent-nodemap.mmap'] = True
     epnm = ui.config(b'experimental', b'exp-persistent-nodemap.mode')
-    options[b'exp-persistent-nodemap.mode'] = epnm
+    options[b'persistent-nodemap.mode'] = epnm
     if ui.configbool(b'devel', b'persistent-nodemap'):
         options[b'devel-force-nodemap'] = True
 
     return options
 
 
 def makemain(**kwargs):
     """Produce a type conforming to ``ilocalrepositorymain``."""
     return localrepository
 
 
 @interfaceutil.implementer(repository.ilocalrepositoryfilestorage)
 class revlogfilestorage(object):
     """File storage when using revlogs."""
 
     def file(self, path):
         if path[0] == b'/':
             path = path[1:]
 
         return filelog.filelog(self.svfs, path)
 
 
 @interfaceutil.implementer(repository.ilocalrepositoryfilestorage)
 class revlognarrowfilestorage(object):
     """File storage when using revlogs and narrow files."""
 
     def file(self, path):
         if path[0] == b'/':
             path = path[1:]
 
         return filelog.narrowfilelog(self.svfs, path, self._storenarrowmatch)
 
 
 def makefilestorage(requirements, features, **kwargs):
     """Produce a type conforming to ``ilocalrepositoryfilestorage``."""
     features.add(repository.REPO_FEATURE_REVLOG_FILE_STORAGE)
     features.add(repository.REPO_FEATURE_STREAM_CLONE)
 
     if repository.NARROW_REQUIREMENT in requirements:
         return revlognarrowfilestorage
     else:
         return revlogfilestorage
 
 
 # List of repository interfaces and factory functions for them. Each
 # will be called in order during ``makelocalrepository()`` to iteratively
 # derive the final type for a local repository instance. We capture the
 # function as a lambda so we don't hold a reference and the module-level
 # functions can be wrapped.
 REPO_INTERFACES = [
     (repository.ilocalrepositorymain, lambda: makemain),
     (repository.ilocalrepositoryfilestorage, lambda: makefilestorage),
 ]
 
 
 @interfaceutil.implementer(repository.ilocalrepositorymain)
 class localrepository(object):
     """Main class for representing local repositories.
 
     All local repositories are instances of this class.
 
     Constructed on its own, instances of this class are not usable as
     repository objects. To obtain a usable repository object, call
     ``hg.repository()``, ``localrepo.instance()``, or
     ``localrepo.makelocalrepository()``. The latter is the lowest-level.
     ``instance()`` adds support for creating new repositories.
     ``hg.repository()`` adds more extension integration, including calling
     ``reposetup()``. Generally speaking, ``hg.repository()`` should be
     used.
     """
 
     # obsolete experimental requirements:
     #  - manifestv2: An experimental new manifest format that allowed
     #    for stem compression of long paths. Experiment ended up not
     #    being successful (repository sizes went up due to worse delta
     #    chains), and the code was deleted in 4.6.
     supportedformats = {
         b'revlogv1',
         b'generaldelta',
         b'treemanifest',
         COPIESSDC_REQUIREMENT,
         REVLOGV2_REQUIREMENT,
         SIDEDATA_REQUIREMENT,
         SPARSEREVLOG_REQUIREMENT,
         NODEMAP_REQUIREMENT,
         bookmarks.BOOKMARKS_IN_STORE_REQUIREMENT,
     }
     _basesupported = supportedformats | {
         b'store',
         b'fncache',
         b'shared',
         b'relshared',
         b'dotencode',
         b'exp-sparse',
         b'internal-phase',
     }
 
     # list of prefix for file which can be written without 'wlock'
     # Extensions should extend this list when needed
     _wlockfreeprefix = {
         # We migh consider requiring 'wlock' for the next
         # two, but pretty much all the existing code assume
         # wlock is not needed so we keep them excluded for
         # now.
         b'hgrc',
         b'requires',
         # XXX cache is a complicatged business someone
         # should investigate this in depth at some point
         b'cache/',
         # XXX shouldn't be dirstate covered by the wlock?
         b'dirstate',
         # XXX bisect was still a bit too messy at the time
         # this changeset was introduced. Someone should fix
         # the remainig bit and drop this line
         b'bisect.state',
     }
 
     def __init__(
         self,
         baseui,
         ui,
         origroot,
         wdirvfs,
         hgvfs,
         requirements,
         supportedrequirements,
         sharedpath,
         store,
         cachevfs,
         wcachevfs,
         features,
         intents=None,
     ):
         """Create a new local repository instance.
 
         Most callers should use ``hg.repository()``, ``localrepo.instance()``,
         or ``localrepo.makelocalrepository()`` for obtaining a new repository
         object.
 
         Arguments:
 
         baseui
            ``ui.ui`` instance that ``ui`` argument was based off of.
 
         ui
            ``ui.ui`` instance for use by the repository.
 
         origroot
            ``bytes`` path to working directory root of this repository.
 
         wdirvfs
            ``vfs.vfs`` rooted at the working directory.
 
         hgvfs
            ``vfs.vfs`` rooted at .hg/
 
         requirements
            ``set`` of bytestrings representing repository opening requirements.
 
         supportedrequirements
            ``set`` of bytestrings representing repository requirements that we
            know how to open. May be a supetset of ``requirements``.
 
         sharedpath
            ``bytes`` Defining path to storage base directory. Points to a
            ``.hg/`` directory somewhere.
 
         store
            ``store.basicstore`` (or derived) instance providing access to
            versioned storage.
 
         cachevfs
            ``vfs.vfs`` used for cache files.
 
         wcachevfs
            ``vfs.vfs`` used for cache files related to the working copy.
 
         features
            ``set`` of bytestrings defining features/capabilities of this
            instance.
 
         intents
            ``set`` of system strings indicating what this repo will be used
            for.
         """
         self.baseui = baseui
         self.ui = ui
         self.origroot = origroot
         # vfs rooted at working directory.
         self.wvfs = wdirvfs
         self.root = wdirvfs.base
         # vfs rooted at .hg/. Used to access most non-store paths.
         self.vfs = hgvfs
         self.path = hgvfs.base
         self.requirements = requirements
         self.supported = supportedrequirements
         self.sharedpath = sharedpath
         self.store = store
         self.cachevfs = cachevfs
         self.wcachevfs = wcachevfs
         self.features = features
 
         self.filtername = None
 
         if self.ui.configbool(b'devel', b'all-warnings') or self.ui.configbool(
             b'devel', b'check-locks'
         ):
             self.vfs.audit = self._getvfsward(self.vfs.audit)
         # A list of callback to shape the phase if no data were found.
         # Callback are in the form: func(repo, roots) --> processed root.
         # This list it to be filled by extension during repo setup
         self._phasedefaults = []
 
         color.setup(self.ui)
 
         self.spath = self.store.path
         self.svfs = self.store.vfs
         self.sjoin = self.store.join
         if self.ui.configbool(b'devel', b'all-warnings') or self.ui.configbool(
             b'devel', b'check-locks'
         ):
             if util.safehasattr(self.svfs, b'vfs'):  # this is filtervfs
                 self.svfs.vfs.audit = self._getsvfsward(self.svfs.vfs.audit)
             else:  # standard vfs
                 self.svfs.audit = self._getsvfsward(self.svfs.audit)
 
         self._dirstatevalidatewarned = False
 
         self._branchcaches = branchmap.BranchMapCache()
         self._revbranchcache = None
         self._filterpats = {}
         self._datafilters = {}
         self._transref = self._lockref = self._wlockref = None
 
         # A cache for various files under .hg/ that tracks file changes,
         # (used by the filecache decorator)
         #
         # Maps a property name to its util.filecacheentry
         self._filecache = {}
 
         # hold sets of revision to be filtered
         # should be cleared when something might have changed the filter value:
         # - new changesets,
         # - phase change,
         # - new obsolescence marker,
         # - working directory parent change,
         # - bookmark changes
         self.filteredrevcache = {}
 
         # post-dirstate-status hooks
         self._postdsstatus = []
 
         # generic mapping between names and nodes
         self.names = namespaces.namespaces()
 
         # Key to signature value.
         self._sparsesignaturecache = {}
         # Signature to cached matcher instance.
         self._sparsematchercache = {}
 
         self._extrafilterid = repoview.extrafilter(ui)
 
         self.filecopiesmode = None
         if COPIESSDC_REQUIREMENT in self.requirements:
             self.filecopiesmode = b'changeset-sidedata'
 
     def _getvfsward(self, origfunc):
         """build a ward for self.vfs"""
         rref = weakref.ref(self)
 
         def checkvfs(path, mode=None):
             ret = origfunc(path, mode=mode)
             repo = rref()
             if (
                 repo is None
                 or not util.safehasattr(repo, b'_wlockref')
                 or not util.safehasattr(repo, b'_lockref')
             ):
                 return
             if mode in (None, b'r', b'rb'):
                 return
             if path.startswith(repo.path):
                 # truncate name relative to the repository (.hg)
                 path = path[len(repo.path) + 1 :]
             if path.startswith(b'cache/'):
                 msg = b'accessing cache with vfs instead of cachevfs: "%s"'
                 repo.ui.develwarn(msg % path, stacklevel=3, config=b"cache-vfs")
             if path.startswith(b'journal.') or path.startswith(b'undo.'):
                 # journal is covered by 'lock'
                 if repo._currentlock(repo._lockref) is None:
                     repo.ui.develwarn(
                         b'write with no lock: "%s"' % path,
                         stacklevel=3,
                         config=b'check-locks',
                     )
             elif repo._currentlock(repo._wlockref) is None:
                 # rest of vfs files are covered by 'wlock'
                 #
                 # exclude special files
                 for prefix in self._wlockfreeprefix:
                     if path.startswith(prefix):
                         return
                 repo.ui.develwarn(
                     b'write with no wlock: "%s"' % path,
                     stacklevel=3,
                     config=b'check-locks',
                 )
             return ret
 
         return checkvfs
 
     def _getsvfsward(self, origfunc):
         """build a ward for self.svfs"""
         rref = weakref.ref(self)
 
         def checksvfs(path, mode=None):
             ret = origfunc(path, mode=mode)
             repo = rref()
             if repo is None or not util.safehasattr(repo, b'_lockref'):
                 return
             if mode in (None, b'r', b'rb'):
                 return
             if path.startswith(repo.sharedpath):
                 # truncate name relative to the repository (.hg)
                 path = path[len(repo.sharedpath) + 1 :]
             if repo._currentlock(repo._lockref) is None:
                 repo.ui.develwarn(
                     b'write with no lock: "%s"' % path, stacklevel=4
                 )
             return ret
 
         return checksvfs
 
     def close(self):
         self._writecaches()
 
     def _writecaches(self):
         if self._revbranchcache:
             self._revbranchcache.write()
 
     def _restrictcapabilities(self, caps):
         if self.ui.configbool(b'experimental', b'bundle2-advertise'):
             caps = set(caps)
             capsblob = bundle2.encodecaps(
                 bundle2.getrepocaps(self, role=b'client')
             )
             caps.add(b'bundle2=' + urlreq.quote(capsblob))
         return caps
 
     def _writerequirements(self):
         scmutil.writerequires(self.vfs, self.requirements)
 
     # Don't cache auditor/nofsauditor, or you'll end up with reference cycle:
     # self -> auditor -> self._checknested -> self
 
     @property
     def auditor(self):
         # This is only used by context.workingctx.match in order to
         # detect files in subrepos.
         return pathutil.pathauditor(self.root, callback=self._checknested)
 
     @property
     def nofsauditor(self):
         # This is only used by context.basectx.match in order to detect
         # files in subrepos.
         return pathutil.pathauditor(
             self.root, callback=self._checknested, realfs=False, cached=True
         )
 
     def _checknested(self, path):
         """Determine if path is a legal nested repository."""
         if not path.startswith(self.root):
             return False
         subpath = path[len(self.root) + 1 :]
         normsubpath = util.pconvert(subpath)
 
         # XXX: Checking against the current working copy is wrong in
         # the sense that it can reject things like
         #
         #   $ hg cat -r 10 sub/x.txt
         #
         # if sub/ is no longer a subrepository in the working copy
         # parent revision.
         #
         # However, it can of course also allow things that would have
         # been rejected before, such as the above cat command if sub/
         # is a subrepository now, but was a normal directory before.
         # The old path auditor would have rejected by mistake since it
         # panics when it sees sub/.hg/.
         #
         # All in all, checking against the working copy seems sensible
         # since we want to prevent access to nested repositories on
         # the filesystem *now*.
         ctx = self[None]
         parts = util.splitpath(subpath)
         while parts:
             prefix = b'/'.join(parts)
             if prefix in ctx.substate:
                 if prefix == normsubpath:
                     return True
                 else:
                     sub = ctx.sub(prefix)
                     return sub.checknested(subpath[len(prefix) + 1 :])
             else:
                 parts.pop()
         return False
 
     def peer(self):
         return localpeer(self)  # not cached to avoid reference cycle
 
     def unfiltered(self):
         """Return unfiltered version of the repository
 
         Intended to be overwritten by filtered repo."""
         return self
 
     def filtered(self, name, visibilityexceptions=None):
         """Return a filtered version of a repository
 
         The `name` parameter is the identifier of the requested view. This
         will return a repoview object set "exactly" to the specified view.
 
         This function does not apply recursive filtering to a repository. For
         example calling `repo.filtered("served")` will return a repoview using
         the "served" view, regardless of the initial view used by `repo`.
 
         In other word, there is always only one level of `repoview` "filtering".
         """
         if self._extrafilterid is not None and b'%' not in name:
             name = name + b'%' + self._extrafilterid
 
         cls = repoview.newtype(self.unfiltered().__class__)
         return cls(self, name, visibilityexceptions)
 
     @mixedrepostorecache(
         (b'bookmarks', b'plain'),
         (b'bookmarks.current', b'plain'),
         (b'bookmarks', b''),
         (b'00changelog.i', b''),
     )
     def _bookmarks(self):
         # Since the multiple files involved in the transaction cannot be
         # written atomically (with current repository format), there is a race
         # condition here.
         #
         # 1) changelog content A is read
         # 2) outside transaction update changelog to content B
         # 3) outside transaction update bookmark file referring to content B
         # 4) bookmarks file content is read and filtered against changelog-A
         #
         # When this happens, bookmarks against nodes missing from A are dropped.
         #
         # Having this happening during read is not great, but it become worse
         # when this happen during write because the bookmarks to the "unknown"
         # nodes will be dropped for good. However, writes happen within locks.
         # This locking makes it possible to have a race free consistent read.
         # For this purpose data read from disc before locking  are
         # "invalidated" right after the locks are taken. This invalidations are
         # "light", the `filecache` mechanism keep the data in memory and will
         # reuse them if the underlying files did not changed. Not parsing the
         # same data multiple times helps performances.
         #
         # Unfortunately in the case describe above, the files tracked by the
         # bookmarks file cache might not have changed, but the in-memory
         # content is still "wrong" because we used an older changelog content
         # to process the on-disk data. So after locking, the changelog would be
         # refreshed but `_bookmarks` would be preserved.
         # Adding `00changelog.i` to the list of tracked file is not
         # enough, because at the time we build the content for `_bookmarks` in
         # (4), the changelog file has already diverged from the content used
         # for loading `changelog` in (1)
         #
         # To prevent the issue, we force the changelog to be explicitly
         # reloaded while computing `_bookmarks`. The data race can still happen
         # without the lock (with a narrower window), but it would no longer go
         # undetected during the lock time refresh.
         #
         # The new schedule is as follow
         #
         # 1) filecache logic detect that `_bookmarks` needs to be computed
         # 2) cachestat for `bookmarks` and `changelog` are captured (for book)
         # 3) We force `changelog` filecache to be tested
         # 4) cachestat for `changelog` are captured (for changelog)
         # 5) `_bookmarks` is computed and cached
         #
         # The step in (3) ensure we have a changelog at least as recent as the
         # cache stat computed in (1). As a result at locking time:
         #  * if the changelog did not changed since (1) -> we can reuse the data
         #  * otherwise -> the bookmarks get refreshed.
         self._refreshchangelog()
         return bookmarks.bmstore(self)
 
     def _refreshchangelog(self):
         """make sure the in memory changelog match the on-disk one"""
         if 'changelog' in vars(self) and self.currenttransaction() is None:
             del self.changelog
 
     @property
     def _activebookmark(self):
         return self._bookmarks.active
 
     # _phasesets depend on changelog. what we need is to call
     # _phasecache.invalidate() if '00changelog.i' was changed, but it
     # can't be easily expressed in filecache mechanism.
     @storecache(b'phaseroots', b'00changelog.i')
     def _phasecache(self):
         return phases.phasecache(self, self._phasedefaults)
 
     @storecache(b'obsstore')
     def obsstore(self):
         return obsolete.makestore(self.ui, self)
 
     @storecache(b'00changelog.i')
     def changelog(self):
         return self.store.changelog(txnutil.mayhavepending(self.root))
 
     @storecache(b'00manifest.i')
     def manifestlog(self):
         return self.store.manifestlog(self, self._storenarrowmatch)
 
     @repofilecache(b'dirstate')
     def dirstate(self):
         return self._makedirstate()
 
     def _makedirstate(self):
         """Extension point for wrapping the dirstate per-repo."""
         sparsematchfn = lambda: sparse.matcher(self)
 
         return dirstate.dirstate(
             self.vfs, self.ui, self.root, self._dirstatevalidate, sparsematchfn
         )
 
     def _dirstatevalidate(self, node):
         try:
             self.changelog.rev(node)
             return node
         except error.LookupError:
             if not self._dirstatevalidatewarned:
                 self._dirstatevalidatewarned = True
                 self.ui.warn(
                     _(b"warning: ignoring unknown working parent %s!\n")
                     % short(node)
                 )
             return nullid
 
     @storecache(narrowspec.FILENAME)
     def narrowpats(self):
         """matcher patterns for this repository's narrowspec
 
         A tuple of (includes, excludes).
         """
         return narrowspec.load(self)
 
     @storecache(narrowspec.FILENAME)
     def _storenarrowmatch(self):
         if repository.NARROW_REQUIREMENT not in self.requirements:
             return matchmod.always()
         include, exclude = self.narrowpats
         return narrowspec.match(self.root, include=include, exclude=exclude)
 
     @storecache(narrowspec.FILENAME)
     def _narrowmatch(self):
         if repository.NARROW_REQUIREMENT not in self.requirements:
             return matchmod.always()
         narrowspec.checkworkingcopynarrowspec(self)
         include, exclude = self.narrowpats
         return narrowspec.match(self.root, include=include, exclude=exclude)
 
     def narrowmatch(self, match=None, includeexact=False):
         """matcher corresponding the the repo's narrowspec
 
         If `match` is given, then that will be intersected with the narrow
         matcher.
 
         If `includeexact` is True, then any exact matches from `match` will
         be included even if they're outside the narrowspec.
         """
         if match:
             if includeexact and not self._narrowmatch.always():
                 # do not exclude explicitly-specified paths so that they can
                 # be warned later on
                 em = matchmod.exact(match.files())
                 nm = matchmod.unionmatcher([self._narrowmatch, em])
                 return matchmod.intersectmatchers(match, nm)
             return matchmod.intersectmatchers(match, self._narrowmatch)
         return self._narrowmatch
 
     def setnarrowpats(self, newincludes, newexcludes):
         narrowspec.save(self, newincludes, newexcludes)
         self.invalidate(clearfilecache=True)
 
     @unfilteredpropertycache
     def _quick_access_changeid_null(self):
         return {
             b'null': (nullrev, nullid),
             nullrev: (nullrev, nullid),
             nullid: (nullrev, nullid),
         }
 
     @unfilteredpropertycache
     def _quick_access_changeid_wc(self):
         # also fast path access to the working copy parents
         # however, only do it for filter that ensure wc is visible.
         quick = {}
         cl = self.unfiltered().changelog
         for node in self.dirstate.parents():
             if node == nullid:
                 continue
             rev = cl.index.get_rev(node)
             if rev is None:
                 # unknown working copy parent case:
                 #
                 #   skip the fast path and let higher code deal with it
                 continue
             pair = (rev, node)
             quick[rev] = pair
             quick[node] = pair
             # also add the parents of the parents
             for r in cl.parentrevs(rev):
                 if r == nullrev:
                     continue
                 n = cl.node(r)
                 pair = (r, n)
                 quick[r] = pair
                 quick[n] = pair
         p1node = self.dirstate.p1()
         if p1node != nullid:
             quick[b'.'] = quick[p1node]
         return quick
 
     @unfilteredmethod
     def _quick_access_changeid_invalidate(self):
         if '_quick_access_changeid_wc' in vars(self):
             del self.__dict__['_quick_access_changeid_wc']
 
     @property
     def _quick_access_changeid(self):
         """an helper dictionnary for __getitem__ calls
 
         This contains a list of symbol we can recognise right away without
         further processing.
         """
         mapping = self._quick_access_changeid_null
         if self.filtername in repoview.filter_has_wc:
             mapping = mapping.copy()
             mapping.update(self._quick_access_changeid_wc)
         return mapping
 
     def __getitem__(self, changeid):
         # dealing with special cases
         if changeid is None:
             return context.workingctx(self)
         if isinstance(changeid, context.basectx):
             return changeid
 
         # dealing with multiple revisions
         if isinstance(changeid, slice):
             # wdirrev isn't contiguous so the slice shouldn't include it
             return [
                 self[i]
                 for i in pycompat.xrange(*changeid.indices(len(self)))
                 if i not in self.changelog.filteredrevs
             ]
 
         # dealing with some special values
         quick_access = self._quick_access_changeid.get(changeid)
         if quick_access is not None:
             rev, node = quick_access
             return context.changectx(self, rev, node, maybe_filtered=False)
         if changeid == b'tip':
             node = self.changelog.tip()
             rev = self.changelog.rev(node)
             return context.changectx(self, rev, node)
 
         # dealing with arbitrary values
         try:
             if isinstance(changeid, int):
                 node = self.changelog.node(changeid)
                 rev = changeid
             elif changeid == b'.':
                 # this is a hack to delay/avoid loading obsmarkers
                 # when we know that '.' won't be hidden
                 node = self.dirstate.p1()
                 rev = self.unfiltered().changelog.rev(node)
             elif len(changeid) == 20:
                 try:
                     node = changeid
                     rev = self.changelog.rev(changeid)
                 except error.FilteredLookupError:
                     changeid = hex(changeid)  # for the error message
                     raise
                 except LookupError:
                     # check if it might have come from damaged dirstate
                     #
                     # XXX we could avoid the unfiltered if we had a recognizable
                     # exception for filtered changeset access
                     if (
                         self.local()
                         and changeid in self.unfiltered().dirstate.parents()
                     ):
                         msg = _(b"working directory has unknown parent '%s'!")
                         raise error.Abort(msg % short(changeid))
                     changeid = hex(changeid)  # for the error message
                     raise
 
             elif len(changeid) == 40:
                 node = bin(changeid)
                 rev = self.changelog.rev(node)
             else:
                 raise error.ProgrammingError(
                     b"unsupported changeid '%s' of type %s"
                     % (changeid, pycompat.bytestr(type(changeid)))
                 )
 
             return context.changectx(self, rev, node)
 
         except (error.FilteredIndexError, error.FilteredLookupError):
             raise error.FilteredRepoLookupError(
                 _(b"filtered revision '%s'") % pycompat.bytestr(changeid)
             )
         except (IndexError, LookupError):
             raise error.RepoLookupError(
                 _(b"unknown revision '%s'") % pycompat.bytestr(changeid)
             )
         except error.WdirUnsupported:
             return context.workingctx(self)
 
     def __contains__(self, changeid):
         """True if the given changeid exists
 
         error.AmbiguousPrefixLookupError is raised if an ambiguous node
         specified.
         """
         try:
             self[changeid]
             return True
         except error.RepoLookupError:
             return False
 
     def __nonzero__(self):
         return True
 
     __bool__ = __nonzero__
 
     def __len__(self):
         # no need to pay the cost of repoview.changelog
         unfi = self.unfiltered()
         return len(unfi.changelog)
 
     def __iter__(self):
         return iter(self.changelog)
 
     def revs(self, expr, *args):
         '''Find revisions matching a revset.
 
         The revset is specified as a string ``expr`` that may contain
         %-formatting to escape certain types. See ``revsetlang.formatspec``.
 
         Revset aliases from the configuration are not expanded. To expand
         user aliases, consider calling ``scmutil.revrange()`` or
         ``repo.anyrevs([expr], user=True)``.
 
         Returns a smartset.abstractsmartset, which is a list-like interface
         that contains integer revisions.
         '''
         tree = revsetlang.spectree(expr, *args)
         return revset.makematcher(tree)(self)
 
     def set(self, expr, *args):
         '''Find revisions matching a revset and emit changectx instances.
 
         This is a convenience wrapper around ``revs()`` that iterates the
         result and is a generator of changectx instances.
 
         Revset aliases from the configuration are not expanded. To expand
         user aliases, consider calling ``scmutil.revrange()``.
         '''
         for r in self.revs(expr, *args):
             yield self[r]
 
     def anyrevs(self, specs, user=False, localalias=None):
         '''Find revisions matching one of the given revsets.
 
         Revset aliases from the configuration are not expanded by default. To
         expand user aliases, specify ``user=True``. To provide some local
         definitions overriding user aliases, set ``localalias`` to
         ``{name: definitionstring}``.
         '''
         if specs == [b'null']:
             return revset.baseset([nullrev])
         if specs == [b'.']:
             quick_data = self._quick_access_changeid.get(b'.')
             if quick_data is not None:
                 return revset.baseset([quick_data[0]])
         if user:
             m = revset.matchany(
                 self.ui,
                 specs,
                 lookup=revset.lookupfn(self),
                 localalias=localalias,
             )
         else:
             m = revset.matchany(None, specs, localalias=localalias)
         return m(self)
 
     def url(self):
         return b'file:' + self.root
 
     def hook(self, name, throw=False, **args):
         """Call a hook, passing this repo instance.
 
         This a convenience method to aid invoking hooks. Extensions likely
         won't call this unless they have registered a custom hook or are
         replacing code that is expected to call a hook.
         """
         return hook.hook(self.ui, self, name, throw, **args)
 
     @filteredpropertycache
     def _tagscache(self):
         '''Returns a tagscache object that contains various tags related
         caches.'''
 
         # This simplifies its cache management by having one decorated
         # function (this one) and the rest simply fetch things from it.
         class tagscache(object):
             def __init__(self):
                 # These two define the set of tags for this repository. tags
                 # maps tag name to node; tagtypes maps tag name to 'global' or
                 # 'local'. (Global tags are defined by .hgtags across all
                 # heads, and local tags are defined in .hg/localtags.)
                 # They constitute the in-memory cache of tags.
                 self.tags = self.tagtypes = None
 
                 self.nodetagscache = self.tagslist = None
 
         cache = tagscache()
         cache.tags, cache.tagtypes = self._findtags()
 
         return cache
 
     def tags(self):
         '''return a mapping of tag to node'''
         t = {}
         if self.changelog.filteredrevs:
             tags, tt = self._findtags()
         else:
             tags = self._tagscache.tags
         rev = self.changelog.rev
         for k, v in pycompat.iteritems(tags):
             try:
                 # ignore tags to unknown nodes
                 rev(v)
                 t[k] = v
             except (error.LookupError, ValueError):
                 pass
         return t
 
     def _findtags(self):
         '''Do the hard work of finding tags.  Return a pair of dicts
         (tags, tagtypes) where tags maps tag name to node, and tagtypes
         maps tag name to a string like \'global\' or \'local\'.
         Subclasses or extensions are free to add their own tags, but
         should be aware that the returned dicts will be retained for the
         duration of the localrepo object.'''
 
         # XXX what tagtype should subclasses/extensions use?  Currently
         # mq and bookmarks add tags, but do not set the tagtype at all.
         # Should each extension invent its own tag type?  Should there
         # be one tagtype for all such "virtual" tags?  Or is the status
         # quo fine?
 
         # map tag name to (node, hist)
         alltags = tagsmod.findglobaltags(self.ui, self)
         # map tag name to tag type
         tagtypes = {tag: b'global' for tag in alltags}
 
         tagsmod.readlocaltags(self.ui, self, alltags, tagtypes)
 
         # Build the return dicts.  Have to re-encode tag names because
         # the tags module always uses UTF-8 (in order not to lose info
         # writing to the cache), but the rest of Mercurial wants them in
         # local encoding.
         tags = {}
         for (name, (node, hist)) in pycompat.iteritems(alltags):
             if node != nullid:
                 tags[encoding.tolocal(name)] = node
         tags[b'tip'] = self.changelog.tip()
         tagtypes = {
             encoding.tolocal(name): value
             for (name, value) in pycompat.iteritems(tagtypes)
         }
         return (tags, tagtypes)
 
     def tagtype(self, tagname):
         '''
         return the type of the given tag. result can be:
 
         'local'  : a local tag
         'global' : a global tag
         None     : tag does not exist
         '''
 
         return self._tagscache.tagtypes.get(tagname)
 
     def tagslist(self):
         '''return a list of tags ordered by revision'''
         if not self._tagscache.tagslist:
             l = []
             for t, n in pycompat.iteritems(self.tags()):
                 l.append((self.changelog.rev(n), t, n))
             self._tagscache.tagslist = [(t, n) for r, t, n in sorted(l)]
 
         return self._tagscache.tagslist
 
     def nodetags(self, node):
         '''return the tags associated with a node'''
         if not self._tagscache.nodetagscache:
             nodetagscache = {}
             for t, n in pycompat.iteritems(self._tagscache.tags):
                 nodetagscache.setdefault(n, []).append(t)
             for tags in pycompat.itervalues(nodetagscache):
                 tags.sort()
             self._tagscache.nodetagscache = nodetagscache
         return self._tagscache.nodetagscache.get(node, [])
 
     def nodebookmarks(self, node):
         """return the list of bookmarks pointing to the specified node"""
         return self._bookmarks.names(node)
 
     def branchmap(self):
         '''returns a dictionary {branch: [branchheads]} with branchheads
         ordered by increasing revision number'''
         return self._branchcaches[self]
 
     @unfilteredmethod
     def revbranchcache(self):
         if not self._revbranchcache:
             self._revbranchcache = branchmap.revbranchcache(self.unfiltered())
         return self._revbranchcache
 
     def branchtip(self, branch, ignoremissing=False):
         '''return the tip node for a given branch
 
         If ignoremissing is True, then this method will not raise an error.
         This is helpful for callers that only expect None for a missing branch
         (e.g. namespace).
 
         '''
         try:
             return self.branchmap().branchtip(branch)
         except KeyError:
             if not ignoremissing:
                 raise error.RepoLookupError(_(b"unknown branch '%s'") % branch)
             else:
                 pass
 
     def lookup(self, key):
         node = scmutil.revsymbol(self, key).node()
         if node is None:
             raise error.RepoLookupError(_(b"unknown revision '%s'") % key)
         return node
 
     def lookupbranch(self, key):
         if self.branchmap().hasbranch(key):
             return key
 
         return scmutil.revsymbol(self, key).branch()
 
     def known(self, nodes):
         cl = self.changelog
         get_rev = cl.index.get_rev
         filtered = cl.filteredrevs
         result = []
         for n in nodes:
             r = get_rev(n)
             resp = not (r is None or r in filtered)
             result.append(resp)
         return result
 
     def local(self):
         return self
 
     def publishing(self):
         # it's safe (and desirable) to trust the publish flag unconditionally
         # so that we don't finalize changes shared between users via ssh or nfs
         return self.ui.configbool(b'phases', b'publish', untrusted=True)
 
     def cancopy(self):
         # so statichttprepo's override of local() works
         if not self.local():
             return False
         if not self.publishing():
             return True
         # if publishing we can't copy if there is filtered content
         return not self.filtered(b'visible').changelog.filteredrevs
 
     def shared(self):
         '''the type of shared repository (None if not shared)'''
         if self.sharedpath != self.path:
             return b'store'
         return None
 
     def wjoin(self, f, *insidef):
         return self.vfs.reljoin(self.root, f, *insidef)
 
     def setparents(self, p1, p2=nullid):
         self[None].setparents(p1, p2)
         self._quick_access_changeid_invalidate()
 
     def filectx(self, path, changeid=None, fileid=None, changectx=None):
         """changeid must be a changeset revision, if specified.
            fileid can be a file revision or node."""
         return context.filectx(
             self, path, changeid, fileid, changectx=changectx
         )
 
     def getcwd(self):
         return self.dirstate.getcwd()
 
     def pathto(self, f, cwd=None):
         return self.dirstate.pathto(f, cwd)
 
     def _loadfilter(self, filter):
         if filter not in self._filterpats:
             l = []
             for pat, cmd in self.ui.configitems(filter):
                 if cmd == b'!':
                     continue
                 mf = matchmod.match(self.root, b'', [pat])
                 fn = None
                 params = cmd
                 for name, filterfn in pycompat.iteritems(self._datafilters):
                     if cmd.startswith(name):
                         fn = filterfn
                         params = cmd[len(name) :].lstrip()
                         break
                 if not fn:
                     fn = lambda s, c, **kwargs: procutil.filter(s, c)
                     fn.__name__ = 'commandfilter'
                 # Wrap old filters not supporting keyword arguments
                 if not pycompat.getargspec(fn)[2]:
                     oldfn = fn
                     fn = lambda s, c, oldfn=oldfn, **kwargs: oldfn(s, c)
                     fn.__name__ = 'compat-' + oldfn.__name__
                 l.append((mf, fn, params))
             self._filterpats[filter] = l
         return self._filterpats[filter]
 
     def _filter(self, filterpats, filename, data):
         for mf, fn, cmd in filterpats:
             if mf(filename):
                 self.ui.debug(
                     b"filtering %s through %s\n"
                     % (filename, cmd or pycompat.sysbytes(fn.__name__))
                 )
                 data = fn(data, cmd, ui=self.ui, repo=self, filename=filename)
                 break
 
         return data
 
     @unfilteredpropertycache
     def _encodefilterpats(self):
         return self._loadfilter(b'encode')
 
     @unfilteredpropertycache
     def _decodefilterpats(self):
         return self._loadfilter(b'decode')
 
     def adddatafilter(self, name, filter):
         self._datafilters[name] = filter
 
     def wread(self, filename):
         if self.wvfs.islink(filename):
             data = self.wvfs.readlink(filename)
         else:
             data = self.wvfs.read(filename)
         return self._filter(self._encodefilterpats, filename, data)
 
     def wwrite(self, filename, data, flags, backgroundclose=False, **kwargs):
         """write ``data`` into ``filename`` in the working directory
 
         This returns length of written (maybe decoded) data.
         """
         data = self._filter(self._decodefilterpats, filename, data)
         if b'l' in flags:
             self.wvfs.symlink(data, filename)
         else:
             self.wvfs.write(
                 filename, data, backgroundclose=backgroundclose, **kwargs
             )
             if b'x' in flags:
                 self.wvfs.setflags(filename, False, True)
             else:
                 self.wvfs.setflags(filename, False, False)
         return len(data)
 
     def wwritedata(self, filename, data):
         return self._filter(self._decodefilterpats, filename, data)
 
     def currenttransaction(self):
         """return the current transaction or None if non exists"""
         if self._transref:
             tr = self._transref()
         else:
             tr = None
 
         if tr and tr.running():
             return tr
         return None
 
     def transaction(self, desc, report=None):
         if self.ui.configbool(b'devel', b'all-warnings') or self.ui.configbool(
             b'devel', b'check-locks'
         ):
             if self._currentlock(self._lockref) is None:
                 raise error.ProgrammingError(b'transaction requires locking')
         tr = self.currenttransaction()
         if tr is not None:
             return tr.nest(name=desc)
 
         # abort here if the journal already exists
         if self.svfs.exists(b"journal"):
             raise error.RepoError(
                 _(b"abandoned transaction found"),
                 hint=_(b"run 'hg recover' to clean up transaction"),
             )
 
         idbase = b"%.40f#%f" % (random.random(), time.time())
         ha = hex(hashutil.sha1(idbase).digest())
         txnid = b'TXN:' + ha
         self.hook(b'pretxnopen', throw=True, txnname=desc, txnid=txnid)
 
         self._writejournal(desc)
         renames = [(vfs, x, undoname(x)) for vfs, x in self._journalfiles()]
         if report:
             rp = report
         else:
             rp = self.ui.warn
         vfsmap = {b'plain': self.vfs, b'store': self.svfs}  # root of .hg/
         # we must avoid cyclic reference between repo and transaction.
         reporef = weakref.ref(self)
         # Code to track tag movement
         #
         # Since tags are all handled as file content, it is actually quite hard
         # to track these movement from a code perspective. So we fallback to a
         # tracking at the repository level. One could envision to track changes
         # to the '.hgtags' file through changegroup apply but that fails to
         # cope with case where transaction expose new heads without changegroup
         # being involved (eg: phase movement).
         #
         # For now, We gate the feature behind a flag since this likely comes
         # with performance impacts. The current code run more often than needed
         # and do not use caches as much as it could.  The current focus is on
         # the behavior of the feature so we disable it by default. The flag
         # will be removed when we are happy with the performance impact.
         #
         # Once this feature is no longer experimental move the following
         # documentation to the appropriate help section:
         #
         # The ``HG_TAG_MOVED`` variable will be set if the transaction touched
         # tags (new or changed or deleted tags). In addition the details of
         # these changes are made available in a file at:
         #     ``REPOROOT/.hg/changes/tags.changes``.
         # Make sure you check for HG_TAG_MOVED before reading that file as it
         # might exist from a previous transaction even if no tag were touched
         # in this one. Changes are recorded in a line base format::
         #
         #     <action> <hex-node> <tag-name>\n
         #
         # Actions are defined as follow:
         #   "-R": tag is removed,
         #   "+A": tag is added,
         #   "-M": tag is moved (old value),
         #   "+M": tag is moved (new value),
         tracktags = lambda x: None
         # experimental config: experimental.hook-track-tags
         shouldtracktags = self.ui.configbool(
             b'experimental', b'hook-track-tags'
         )
         if desc != b'strip' and shouldtracktags:
             oldheads = self.changelog.headrevs()
 
             def tracktags(tr2):
                 repo = reporef()
                 oldfnodes = tagsmod.fnoderevs(repo.ui, repo, oldheads)
                 newheads = repo.changelog.headrevs()
                 newfnodes = tagsmod.fnoderevs(repo.ui, repo, newheads)
                 # notes: we compare lists here.
                 # As we do it only once buiding set would not be cheaper
                 changes = tagsmod.difftags(repo.ui, repo, oldfnodes, newfnodes)
                 if changes:
                     tr2.hookargs[b'tag_moved'] = b'1'
                     with repo.vfs(
                         b'changes/tags.changes', b'w', atomictemp=True
                     ) as changesfile:
                         # note: we do not register the file to the transaction
                         # because we needs it to still exist on the transaction
                         # is close (for txnclose hooks)
                         tagsmod.writediff(changesfile, changes)
 
         def validate(tr2):
             """will run pre-closing hooks"""
             # XXX the transaction API is a bit lacking here so we take a hacky
             # path for now
             #
             # We cannot add this as a "pending" hooks since the 'tr.hookargs'
             # dict is copied before these run. In addition we needs the data
             # available to in memory hooks too.
             #
             # Moreover, we also need to make sure this runs before txnclose
             # hooks and there is no "pending" mechanism that would execute
             # logic only if hooks are about to run.
             #
             # Fixing this limitation of the transaction is also needed to track
             # other families of changes (bookmarks, phases, obsolescence).
             #
             # This will have to be fixed before we remove the experimental
             # gating.
             tracktags(tr2)
             repo = reporef()
 
             singleheadopt = (b'experimental', b'single-head-per-branch')
             singlehead = repo.ui.configbool(*singleheadopt)
             if singlehead:
                 singleheadsub = repo.ui.configsuboptions(*singleheadopt)[1]
                 accountclosed = singleheadsub.get(
                     b"account-closed-heads", False
                 )
                 scmutil.enforcesinglehead(repo, tr2, desc, accountclosed)
             if hook.hashook(repo.ui, b'pretxnclose-bookmark'):
                 for name, (old, new) in sorted(
                     tr.changes[b'bookmarks'].items()
                 ):
                     args = tr.hookargs.copy()
                     args.update(bookmarks.preparehookargs(name, old, new))
                     repo.hook(
                         b'pretxnclose-bookmark',
                         throw=True,
                         **pycompat.strkwargs(args)
                     )
             if hook.hashook(repo.ui, b'pretxnclose-phase'):
                 cl = repo.unfiltered().changelog
                 for revs, (old, new) in tr.changes[b'phases']:
                     for rev in revs:
                         args = tr.hookargs.copy()
                         node = hex(cl.node(rev))
                         args.update(phases.preparehookargs(node, old, new))
                         repo.hook(
                             b'pretxnclose-phase',
                             throw=True,
                             **pycompat.strkwargs(args)
                         )
 
             repo.hook(
                 b'pretxnclose', throw=True, **pycompat.strkwargs(tr.hookargs)
             )
 
         def releasefn(tr, success):
             repo = reporef()
             if repo is None:
                 # If the repo has been GC'd (and this release function is being
                 # called from transaction.__del__), there's not much we can do,
                 # so just leave the unfinished transaction there and let the
                 # user run `hg recover`.
                 return
             if success:
                 # this should be explicitly invoked here, because
                 # in-memory changes aren't written out at closing
                 # transaction, if tr.addfilegenerator (via
                 # dirstate.write or so) isn't invoked while
                 # transaction running
                 repo.dirstate.write(None)
             else:
                 # discard all changes (including ones already written
                 # out) in this transaction
                 narrowspec.restorebackup(self, b'journal.narrowspec')
                 narrowspec.restorewcbackup(self, b'journal.narrowspec.dirstate')
                 repo.dirstate.restorebackup(None, b'journal.dirstate')
 
                 repo.invalidate(clearfilecache=True)
 
         tr = transaction.transaction(
             rp,
             self.svfs,
             vfsmap,
             b"journal",
             b"undo",
             aftertrans(renames),
             self.store.createmode,
             validator=validate,
             releasefn=releasefn,
             checkambigfiles=_cachedfiles,
             name=desc,
         )
         tr.changes[b'origrepolen'] = len(self)
         tr.changes[b'obsmarkers'] = set()
         tr.changes[b'phases'] = []
         tr.changes[b'bookmarks'] = {}
 
         tr.hookargs[b'txnid'] = txnid
         tr.hookargs[b'txnname'] = desc
         # note: writing the fncache only during finalize mean that the file is
         # outdated when running hooks. As fncache is used for streaming clone,
         # this is not expected to break anything that happen during the hooks.
         tr.addfinalize(b'flush-fncache', self.store.write)
 
         def txnclosehook(tr2):
             """To be run if transaction is successful, will schedule a hook run
             """
             # Don't reference tr2 in hook() so we don't hold a reference.
             # This reduces memory consumption when there are multiple
             # transactions per lock. This can likely go away if issue5045
             # fixes the function accumulation.
             hookargs = tr2.hookargs
 
             def hookfunc(unused_success):
                 repo = reporef()
                 if hook.hashook(repo.ui, b'txnclose-bookmark'):
                     bmchanges = sorted(tr.changes[b'bookmarks'].items())
                     for name, (old, new) in bmchanges:
                         args = tr.hookargs.copy()
                         args.update(bookmarks.preparehookargs(name, old, new))
                         repo.hook(
                             b'txnclose-bookmark',
                             throw=False,
                             **pycompat.strkwargs(args)
                         )
 
                 if hook.hashook(repo.ui, b'txnclose-phase'):
                     cl = repo.unfiltered().changelog
                     phasemv = sorted(
                         tr.changes[b'phases'], key=lambda r: r[0][0]
                     )
                     for revs, (old, new) in phasemv:
                         for rev in revs:
                             args = tr.hookargs.copy()
                             node = hex(cl.node(rev))
                             args.update(phases.preparehookargs(node, old, new))
                             repo.hook(
                                 b'txnclose-phase',
                                 throw=False,
                                 **pycompat.strkwargs(args)
                             )
 
                 repo.hook(
                     b'txnclose', throw=False, **pycompat.strkwargs(hookargs)
                 )
 
             reporef()._afterlock(hookfunc)
 
         tr.addfinalize(b'txnclose-hook', txnclosehook)
         # Include a leading "-" to make it happen before the transaction summary
         # reports registered via scmutil.registersummarycallback() whose names
         # are 00-txnreport etc. That way, the caches will be warm when the
         # callbacks run.
         tr.addpostclose(b'-warm-cache', self._buildcacheupdater(tr))
 
         def txnaborthook(tr2):
             """To be run if transaction is aborted
             """
             reporef().hook(
                 b'txnabort', throw=False, **pycompat.strkwargs(tr2.hookargs)
             )
 
         tr.addabort(b'txnabort-hook', txnaborthook)
         # avoid eager cache invalidation. in-memory data should be identical
         # to stored data if transaction has no error.
         tr.addpostclose(b'refresh-filecachestats', self._refreshfilecachestats)
         self._transref = weakref.ref(tr)
         scmutil.registersummarycallback(self, tr, desc)
         return tr
 
     def _journalfiles(self):
         return (
             (self.svfs, b'journal'),
             (self.svfs, b'journal.narrowspec'),
             (self.vfs, b'journal.narrowspec.dirstate'),
             (self.vfs, b'journal.dirstate'),
             (self.vfs, b'journal.branch'),
             (self.vfs, b'journal.desc'),
             (bookmarks.bookmarksvfs(self), b'journal.bookmarks'),
             (self.svfs, b'journal.phaseroots'),
         )
 
     def undofiles(self):
         return [(vfs, undoname(x)) for vfs, x in self._journalfiles()]
 
     @unfilteredmethod
     def _writejournal(self, desc):
         self.dirstate.savebackup(None, b'journal.dirstate')
         narrowspec.savewcbackup(self, b'journal.narrowspec.dirstate')
         narrowspec.savebackup(self, b'journal.narrowspec')
         self.vfs.write(
             b"journal.branch", encoding.fromlocal(self.dirstate.branch())
         )
         self.vfs.write(b"journal.desc", b"%d\n%s\n" % (len(self), desc))
         bookmarksvfs = bookmarks.bookmarksvfs(self)
         bookmarksvfs.write(
             b"journal.bookmarks", bookmarksvfs.tryread(b"bookmarks")
         )
         self.svfs.write(b"journal.phaseroots", self.svfs.tryread(b"phaseroots"))
 
     def recover(self):
         with self.lock():
             if self.svfs.exists(b"journal"):
                 self.ui.status(_(b"rolling back interrupted transaction\n"))
                 vfsmap = {
                     b'': self.svfs,
                     b'plain': self.vfs,
                 }
                 transaction.rollback(
                     self.svfs,
                     vfsmap,
                     b"journal",
                     self.ui.warn,
                     checkambigfiles=_cachedfiles,
                 )
                 self.invalidate()
                 return True
             else:
                 self.ui.warn(_(b"no interrupted transaction available\n"))
                 return False
 
     def rollback(self, dryrun=False, force=False):
         wlock = lock = dsguard = None
         try:
             wlock = self.wlock()
             lock = self.lock()
             if self.svfs.exists(b"undo"):
                 dsguard = dirstateguard.dirstateguard(self, b'rollback')
 
                 return self._rollback(dryrun, force, dsguard)
             else:
                 self.ui.warn(_(b"no rollback information available\n"))
                 return 1
         finally:
             release(dsguard, lock, wlock)
 
     @unfilteredmethod  # Until we get smarter cache management
     def _rollback(self, dryrun, force, dsguard):
         ui = self.ui
         try:
             args = self.vfs.read(b'undo.desc').splitlines()
             (oldlen, desc, detail) = (int(args[0]), args[1], None)
             if len(args) >= 3:
                 detail = args[2]
             oldtip = oldlen - 1
 
             if detail and ui.verbose:
                 msg = _(
                     b'repository tip rolled back to revision %d'
                     b' (undo %s: %s)\n'
                 ) % (oldtip, desc, detail)
             else:
                 msg = _(
                     b'repository tip rolled back to revision %d (undo %s)\n'
                 ) % (oldtip, desc)
         except IOError:
             msg = _(b'rolling back unknown transaction\n')
             desc = None
 
         if not force and self[b'.'] != self[b'tip'] and desc == b'commit':
             raise error.Abort(
                 _(
                     b'rollback of last commit while not checked out '
                     b'may lose data'
                 ),
                 hint=_(b'use -f to force'),
             )
 
         ui.status(msg)
         if dryrun:
             return 0
 
         parents = self.dirstate.parents()
         self.destroying()
         vfsmap = {b'plain': self.vfs, b'': self.svfs}
         transaction.rollback(
             self.svfs, vfsmap, b'undo', ui.warn, checkambigfiles=_cachedfiles
         )
         bookmarksvfs = bookmarks.bookmarksvfs(self)
         if bookmarksvfs.exists(b'undo.bookmarks'):
             bookmarksvfs.rename(
                 b'undo.bookmarks', b'bookmarks', checkambig=True
             )
         if self.svfs.exists(b'undo.phaseroots'):
             self.svfs.rename(b'undo.phaseroots', b'phaseroots', checkambig=True)
         self.invalidate()
 
         has_node = self.changelog.index.has_node
         parentgone = any(not has_node(p) for p in parents)
         if parentgone:
             # prevent dirstateguard from overwriting already restored one
             dsguard.close()
 
             narrowspec.restorebackup(self, b'undo.narrowspec')
             narrowspec.restorewcbackup(self, b'undo.narrowspec.dirstate')
             self.dirstate.restorebackup(None, b'undo.dirstate')
             try:
                 branch = self.vfs.read(b'undo.branch')
                 self.dirstate.setbranch(encoding.tolocal(branch))
             except IOError:
                 ui.warn(
                     _(
                         b'named branch could not be reset: '
                         b'current branch is still \'%s\'\n'
                     )
                     % self.dirstate.branch()
                 )
 
             parents = tuple([p.rev() for p in self[None].parents()])
             if len(parents) > 1:
                 ui.status(
                     _(
                         b'working directory now based on '
                         b'revisions %d and %d\n'
                     )
                     % parents
                 )
             else:
                 ui.status(
                     _(b'working directory now based on revision %d\n') % parents
                 )
             mergemod.mergestate.clean(self, self[b'.'].node())
 
         # TODO: if we know which new heads may result from this rollback, pass
         # them to destroy(), which will prevent the branchhead cache from being
         # invalidated.
         self.destroyed()
         return 0
 
     def _buildcacheupdater(self, newtransaction):
         """called during transaction to build the callback updating cache
 
         Lives on the repository to help extension who might want to augment
         this logic. For this purpose, the created transaction is passed to the
         method.
         """
         # we must avoid cyclic reference between repo and transaction.
         reporef = weakref.ref(self)
 
         def updater(tr):
             repo = reporef()
             repo.updatecaches(tr)
 
         return updater
 
     @unfilteredmethod
     def updatecaches(self, tr=None, full=False):
         """warm appropriate caches
 
         If this function is called after a transaction closed. The transaction
         will be available in the 'tr' argument. This can be used to selectively
         update caches relevant to the changes in that transaction.
 
         If 'full' is set, make sure all caches the function knows about have
         up-to-date data. Even the ones usually loaded more lazily.
         """
         if tr is not None and tr.hookargs.get(b'source') == b'strip':
             # During strip, many caches are invalid but
             # later call to `destroyed` will refresh them.
             return
 
         if tr is None or tr.changes[b'origrepolen'] < len(self):
             # accessing the 'ser ved' branchmap should refresh all the others,
             self.ui.debug(b'updating the branch cache\n')
             self.filtered(b'served').branchmap()
             self.filtered(b'served.hidden').branchmap()
 
         if full:
             unfi = self.unfiltered()
 
             self.changelog.update_caches(transaction=tr)
             self.manifestlog.update_caches(transaction=tr)
 
             rbc = unfi.revbranchcache()
             for r in unfi.changelog:
                 rbc.branchinfo(r)
             rbc.write()
 
             # ensure the working copy parents are in the manifestfulltextcache
             for ctx in self[b'.'].parents():
                 ctx.manifest()  # accessing the manifest is enough
 
             # accessing fnode cache warms the cache
             tagsmod.fnoderevs(self.ui, unfi, unfi.changelog.revs())
             # accessing tags warm the cache
             self.tags()
             self.filtered(b'served').tags()
 
             # The `full` arg is documented as updating even the lazily-loaded
             # caches immediately, so we're forcing a write to cause these caches
             # to be warmed up even if they haven't explicitly been requested
             # yet (if they've never been used by hg, they won't ever have been
             # written, even if they're a subset of another kind of cache that
             # *has* been used).
             for filt in repoview.filtertable.keys():
                 filtered = self.filtered(filt)
                 filtered.branchmap().write(filtered)
 
     def invalidatecaches(self):
 
         if '_tagscache' in vars(self):
             # can't use delattr on proxy
             del self.__dict__['_tagscache']
 
         self._branchcaches.clear()
         self.invalidatevolatilesets()
         self._sparsesignaturecache.clear()
 
     def invalidatevolatilesets(self):
         self.filteredrevcache.clear()
         obsolete.clearobscaches(self)
         self._quick_access_changeid_invalidate()
 
     def invalidatedirstate(self):
         '''Invalidates the dirstate, causing the next call to dirstate
         to check if it was modified since the last time it was read,
         rereading it if it has.
 
         This is different to dirstate.invalidate() that it doesn't always
         rereads the dirstate. Use dirstate.invalidate() if you want to
         explicitly read the dirstate again (i.e. restoring it to a previous
         known good state).'''
         if hasunfilteredcache(self, 'dirstate'):
             for k in self.dirstate._filecache:
                 try:
                     delattr(self.dirstate, k)
                 except AttributeError:
                     pass
             delattr(self.unfiltered(), 'dirstate')
 
     def invalidate(self, clearfilecache=False):
         '''Invalidates both store and non-store parts other than dirstate
 
         If a transaction is running, invalidation of store is omitted,
         because discarding in-memory changes might cause inconsistency
         (e.g. incomplete fncache causes unintentional failure, but
         redundant one doesn't).
         '''
         unfiltered = self.unfiltered()  # all file caches are stored unfiltered
         for k in list(self._filecache.keys()):
             # dirstate is invalidated separately in invalidatedirstate()
             if k == b'dirstate':
                 continue
             if (
                 k == b'changelog'
                 and self.currenttransaction()
                 and self.changelog._delayed
             ):
                 # The changelog object may store unwritten revisions. We don't
                 # want to lose them.
                 # TODO: Solve the problem instead of working around it.
                 continue
 
             if clearfilecache:
                 del self._filecache[k]
             try:
                 delattr(unfiltered, k)
             except AttributeError:
                 pass
         self.invalidatecaches()
         if not self.currenttransaction():
             # TODO: Changing contents of store outside transaction
             # causes inconsistency. We should make in-memory store
             # changes detectable, and abort if changed.
             self.store.invalidatecaches()
 
     def invalidateall(self):
         '''Fully invalidates both store and non-store parts, causing the
         subsequent operation to reread any outside changes.'''
         # extension should hook this to invalidate its caches
         self.invalidate()
         self.invalidatedirstate()
 
     @unfilteredmethod
     def _refreshfilecachestats(self, tr):
         """Reload stats of cached files so that they are flagged as valid"""
         for k, ce in self._filecache.items():
             k = pycompat.sysstr(k)
             if k == 'dirstate' or k not in self.__dict__:
                 continue
             ce.refresh()
 
     def _lock(
         self,
         vfs,
         lockname,
         wait,
         releasefn,
         acquirefn,
         desc,
         inheritchecker=None,
         parentenvvar=None,
     ):
         parentlock = None
         # the contents of parentenvvar are used by the underlying lock to
         # determine whether it can be inherited
         if parentenvvar is not None:
             parentlock = encoding.environ.get(parentenvvar)
 
         timeout = 0
         warntimeout = 0
         if wait:
             timeout = self.ui.configint(b"ui", b"timeout")
             warntimeout = self.ui.configint(b"ui", b"timeout.warn")
         # internal config: ui.signal-safe-lock
         signalsafe = self.ui.configbool(b'ui', b'signal-safe-lock')
 
         l = lockmod.trylock(
             self.ui,
             vfs,
             lockname,
             timeout,
             warntimeout,
             releasefn=releasefn,
             acquirefn=acquirefn,
             desc=desc,
             inheritchecker=inheritchecker,
             parentlock=parentlock,
             signalsafe=signalsafe,
         )
         return l
 
     def _afterlock(self, callback):
         """add a callback to be run when the repository is fully unlocked
 
         The callback will be executed when the outermost lock is released
         (with wlock being higher level than 'lock')."""
         for ref in (self._wlockref, self._lockref):
             l = ref and ref()
             if l and l.held:
                 l.postrelease.append(callback)
                 break
         else:  # no lock have been found.
             callback(True)
 
     def lock(self, wait=True):
         '''Lock the repository store (.hg/store) and return a weak reference
         to the lock. Use this before modifying the store (e.g. committing or
         stripping). If you are opening a transaction, get a lock as well.)
 
         If both 'lock' and 'wlock' must be acquired, ensure you always acquires
         'wlock' first to avoid a dead-lock hazard.'''
         l = self._currentlock(self._lockref)
         if l is not None:
             l.lock()
             return l
 
         l = self._lock(
             vfs=self.svfs,
             lockname=b"lock",
             wait=wait,
             releasefn=None,
             acquirefn=self.invalidate,
             desc=_(b'repository %s') % self.origroot,
         )
         self._lockref = weakref.ref(l)
         return l
 
     def _wlockchecktransaction(self):
         if self.currenttransaction() is not None:
             raise error.LockInheritanceContractViolation(
                 b'wlock cannot be inherited in the middle of a transaction'
             )
 
     def wlock(self, wait=True):
         '''Lock the non-store parts of the repository (everything under
         .hg except .hg/store) and return a weak reference to the lock.
 
         Use this before modifying files in .hg.
 
         If both 'lock' and 'wlock' must be acquired, ensure you always acquires
         'wlock' first to avoid a dead-lock hazard.'''
         l = self._wlockref and self._wlockref()
         if l is not None and l.held:
             l.lock()
             return l
 
         # We do not need to check for non-waiting lock acquisition.  Such
         # acquisition would not cause dead-lock as they would just fail.
         if wait and (
             self.ui.configbool(b'devel', b'all-warnings')
             or self.ui.configbool(b'devel', b'check-locks')
         ):
             if self._currentlock(self._lockref) is not None:
                 self.ui.develwarn(b'"wlock" acquired after "lock"')
 
         def unlock():
             if self.dirstate.pendingparentchange():
                 self.dirstate.invalidate()
             else:
                 self.dirstate.write(None)
 
             self._filecache[b'dirstate'].refresh()
 
         l = self._lock(
             self.vfs,
             b"wlock",
             wait,
             unlock,
             self.invalidatedirstate,
             _(b'working directory of %s') % self.origroot,
             inheritchecker=self._wlockchecktransaction,
             parentenvvar=b'HG_WLOCK_LOCKER',
         )
         self._wlockref = weakref.ref(l)
         return l
 
     def _currentlock(self, lockref):
         """Returns the lock if it's held, or None if it's not."""
         if lockref is None:
             return None
         l = lockref()
         if l is None or not l.held:
             return None
         return l
 
     def currentwlock(self):
         """Returns the wlock if it's held, or None if it's not."""
         return self._currentlock(self._wlockref)
 
     def _filecommit(
         self,
         fctx,
         manifest1,
         manifest2,
         linkrev,
         tr,
         changelist,
         includecopymeta,
     ):
         """
         commit an individual file as part of a larger transaction
         """
 
         fname = fctx.path()
         fparent1 = manifest1.get(fname, nullid)
         fparent2 = manifest2.get(fname, nullid)
         if isinstance(fctx, context.filectx):
             node = fctx.filenode()
             if node in [fparent1, fparent2]:
                 self.ui.debug(b'reusing %s filelog entry\n' % fname)
                 if (
                     fparent1 != nullid
                     and manifest1.flags(fname) != fctx.flags()
                 ) or (
                     fparent2 != nullid
                     and manifest2.flags(fname) != fctx.flags()
                 ):
                     changelist.append(fname)
                 return node
 
         flog = self.file(fname)
         meta = {}
         cfname = fctx.copysource()
         if cfname and cfname != fname:
             # Mark the new revision of this file as a copy of another
             # file.  This copy data will effectively act as a parent
             # of this new revision.  If this is a merge, the first
             # parent will be the nullid (meaning "look up the copy data")
             # and the second one will be the other parent.  For example:
             #
             # 0 --- 1 --- 3   rev1 changes file foo
             #   \       /     rev2 renames foo to bar and changes it
             #    \- 2 -/      rev3 should have bar with all changes and
             #                      should record that bar descends from
             #                      bar in rev2 and foo in rev1
             #
             # this allows this merge to succeed:
             #
             # 0 --- 1 --- 3   rev4 reverts the content change from rev2
             #   \       /     merging rev3 and rev4 should use bar@rev2
             #    \- 2 --- 4        as the merge base
             #
 
             cnode = manifest1.get(cfname)
             newfparent = fparent2
 
             if manifest2:  # branch merge
                 if fparent2 == nullid or cnode is None:  # copied on remote side
                     if cfname in manifest2:
                         cnode = manifest2[cfname]
                         newfparent = fparent1
 
             # Here, we used to search backwards through history to try to find
             # where the file copy came from if the source of a copy was not in
             # the parent directory. However, this doesn't actually make sense to
             # do (what does a copy from something not in your working copy even
             # mean?) and it causes bugs (eg, issue4476). Instead, we will warn
             # the user that copy information was dropped, so if they didn't
             # expect this outcome it can be fixed, but this is the correct
             # behavior in this circumstance.
 
             if cnode:
                 self.ui.debug(
                     b" %s: copy %s:%s\n" % (fname, cfname, hex(cnode))
                 )
                 if includecopymeta:
                     meta[b"copy"] = cfname
                     meta[b"copyrev"] = hex(cnode)
                 fparent1, fparent2 = nullid, newfparent
             else:
                 self.ui.warn(
                     _(
                         b"warning: can't find ancestor for '%s' "
                         b"copied from '%s'!\n"
                     )
                     % (fname, cfname)
                 )
 
         elif fparent1 == nullid:
             fparent1, fparent2 = fparent2, nullid
         elif fparent2 != nullid:
             # is one parent an ancestor of the other?
             fparentancestors = flog.commonancestorsheads(fparent1, fparent2)
             if fparent1 in fparentancestors:
                 fparent1, fparent2 = fparent2, nullid
             elif fparent2 in fparentancestors:
                 fparent2 = nullid
             elif not fparentancestors:
                 # TODO: this whole if-else might be simplified much more
                 ms = mergemod.mergestate.read(self)
                 if (
                     fname in ms
                     and ms[fname] == mergemod.MERGE_RECORD_MERGED_OTHER
                 ):
                     fparent1, fparent2 = fparent2, nullid
 
         # is the file changed?
         text = fctx.data()
         if fparent2 != nullid or flog.cmp(fparent1, text) or meta:
             changelist.append(fname)
             return flog.add(text, meta, tr, linkrev, fparent1, fparent2)
         # are just the flags changed during merge?
         elif fname in manifest1 and manifest1.flags(fname) != fctx.flags():
             changelist.append(fname)
 
         return fparent1
 
     def checkcommitpatterns(self, wctx, match, status, fail):
         """check for commit arguments that aren't committable"""
         if match.isexact() or match.prefix():
             matched = set(status.modified + status.added + status.removed)
 
             for f in match.files():
                 f = self.dirstate.normalize(f)
                 if f == b'.' or f in matched or f in wctx.substate:
                     continue
                 if f in status.deleted:
                     fail(f, _(b'file not found!'))
                 # Is it a directory that exists or used to exist?
                 if self.wvfs.isdir(f) or wctx.p1().hasdir(f):
                     d = f + b'/'
                     for mf in matched:
                         if mf.startswith(d):
                             break
                     else:
                         fail(f, _(b"no match under directory!"))
                 elif f not in self.dirstate:
                     fail(f, _(b"file not tracked!"))
 
     @unfilteredmethod
     def commit(
         self,
         text=b"",
         user=None,
         date=None,
         match=None,
         force=False,
         editor=None,
         extra=None,
     ):
         """Add a new revision to current repository.
 
         Revision information is gathered from the working directory,
         match can be used to filter the committed files. If editor is
         supplied, it is called to get a commit message.
         """
         if extra is None:
             extra = {}
 
         def fail(f, msg):
             raise error.Abort(b'%s: %s' % (f, msg))
 
         if not match:
             match = matchmod.always()
 
         if not force:
             match.bad = fail
 
         # lock() for recent changelog (see issue4368)
         with self.wlock(), self.lock():
             wctx = self[None]
             merge = len(wctx.parents()) > 1
 
             if not force and merge and not match.always():
                 raise error.Abort(
                     _(
                         b'cannot partially commit a merge '
                         b'(do not specify files or patterns)'
                     )
                 )
 
             status = self.status(match=match, clean=force)
             if force:
                 status.modified.extend(
                     status.clean
                 )  # mq may commit clean files
 
             # check subrepos
             subs, commitsubs, newstate = subrepoutil.precommit(
                 self.ui, wctx, status, match, force=force
             )
 
             # make sure all explicit patterns are matched
             if not force:
                 self.checkcommitpatterns(wctx, match, status, fail)
 
             cctx = context.workingcommitctx(
                 self, status, text, user, date, extra
             )
 
             ms = mergemod.mergestate.read(self)
             mergeutil.checkunresolved(ms)
 
             # internal config: ui.allowemptycommit
             allowemptycommit = (
                 wctx.branch() != wctx.p1().branch()
                 or extra.get(b'close')
                 or merge
                 or cctx.files()
                 or self.ui.configbool(b'ui', b'allowemptycommit')
             )
             if not allowemptycommit:
                 self.ui.debug(b'nothing to commit, clearing merge state\n')
                 ms.reset()
                 return None
 
             if merge and cctx.deleted():
                 raise error.Abort(_(b"cannot commit merge with missing files"))
 
             if editor:
                 cctx._text = editor(self, cctx, subs)
             edited = text != cctx._text
 
             # Save commit message in case this transaction gets rolled back
             # (e.g. by a pretxncommit hook).  Leave the content alone on
             # the assumption that the user will use the same editor again.
             msgfn = self.savecommitmessage(cctx._text)
 
             # commit subs and write new state
             if subs:
                 uipathfn = scmutil.getuipathfn(self)
                 for s in sorted(commitsubs):
                     sub = wctx.sub(s)
                     self.ui.status(
                         _(b'committing subrepository %s\n')
                         % uipathfn(subrepoutil.subrelpath(sub))
                     )
                     sr = sub.commit(cctx._text, user, date)
                     newstate[s] = (newstate[s][0], sr)
                 subrepoutil.writestate(self, newstate)
 
             p1, p2 = self.dirstate.parents()
             hookp1, hookp2 = hex(p1), (p2 != nullid and hex(p2) or b'')
             try:
                 self.hook(
                     b"precommit", throw=True, parent1=hookp1, parent2=hookp2
                 )
                 with self.transaction(b'commit'):
                     ret = self.commitctx(cctx, True)
                     # update bookmarks, dirstate and mergestate
                     bookmarks.update(self, [p1, p2], ret)
                     cctx.markcommitted(ret)
                     ms.reset()
             except:  # re-raises
                 if edited:
                     self.ui.write(
                         _(b'note: commit message saved in %s\n') % msgfn
                     )
                     self.ui.write(
                         _(
                             b"note: use 'hg commit --logfile "
                             b".hg/last-message.txt --edit' to reuse it\n"
                         )
                     )
                 raise
 
         def commithook(unused_success):
             # hack for command that use a temporary commit (eg: histedit)
             # temporary commit got stripped before hook release
             if self.changelog.hasnode(ret):
                 self.hook(
                     b"commit", node=hex(ret), parent1=hookp1, parent2=hookp2
                 )
 
         self._afterlock(commithook)
         return ret
 
     @unfilteredmethod
     def commitctx(self, ctx, error=False, origctx=None):
         """Add a new revision to current repository.
         Revision information is passed via the context argument.
 
         ctx.files() should list all files involved in this commit, i.e.
         modified/added/removed files. On merge, it may be wider than the
         ctx.files() to be committed, since any file nodes derived directly
         from p1 or p2 are excluded from the committed ctx.files().
 
         origctx is for convert to work around the problem that bug
         fixes to the files list in changesets change hashes. For
         convert to be the identity, it can pass an origctx and this
         function will use the same files list when it makes sense to
         do so.
         """
 
         p1, p2 = ctx.p1(), ctx.p2()
         user = ctx.user()
 
         if self.filecopiesmode == b'changeset-sidedata':
             writechangesetcopy = True
             writefilecopymeta = True
             writecopiesto = None
         else:
             writecopiesto = self.ui.config(b'experimental', b'copies.write-to')
             writefilecopymeta = writecopiesto != b'changeset-only'
             writechangesetcopy = writecopiesto in (
                 b'changeset-only',
                 b'compatibility',
             )
         p1copies, p2copies = None, None
         if writechangesetcopy:
             p1copies = ctx.p1copies()
             p2copies = ctx.p2copies()
         filesadded, filesremoved = None, None
         with self.lock(), self.transaction(b"commit") as tr:
             trp = weakref.proxy(tr)
 
             if ctx.manifestnode():
                 # reuse an existing manifest revision
                 self.ui.debug(b'reusing known manifest\n')
                 mn = ctx.manifestnode()
                 files = ctx.files()
                 if writechangesetcopy:
                     filesadded = ctx.filesadded()
                     filesremoved = ctx.filesremoved()
             elif ctx.files():
                 m1ctx = p1.manifestctx()
                 m2ctx = p2.manifestctx()
                 mctx = m1ctx.copy()
 
                 m = mctx.read()
                 m1 = m1ctx.read()
                 m2 = m2ctx.read()
 
                 # check in files
                 added = []
                 changed = []
                 removed = list(ctx.removed())
                 linkrev = len(self)
                 self.ui.note(_(b"committing files:\n"))
                 uipathfn = scmutil.getuipathfn(self)
                 for f in sorted(ctx.modified() + ctx.added()):
                     self.ui.note(uipathfn(f) + b"\n")
                     try:
                         fctx = ctx[f]
                         if fctx is None:
                             removed.append(f)
                         else:
                             added.append(f)
                             m[f] = self._filecommit(
                                 fctx,
                                 m1,
                                 m2,
                                 linkrev,
                                 trp,
                                 changed,
                                 writefilecopymeta,
                             )
                             m.setflag(f, fctx.flags())
                     except OSError:
                         self.ui.warn(
                             _(b"trouble committing %s!\n") % uipathfn(f)
                         )
                         raise
                     except IOError as inst:
                         errcode = getattr(inst, 'errno', errno.ENOENT)
                         if error or errcode and errcode != errno.ENOENT:
                             self.ui.warn(
                                 _(b"trouble committing %s!\n") % uipathfn(f)
                             )
                         raise
 
                 # update manifest
                 removed = [f for f in removed if f in m1 or f in m2]
                 drop = sorted([f for f in removed if f in m])
                 for f in drop:
                     del m[f]
                 if p2.rev() != nullrev:
 
                     @util.cachefunc
                     def mas():
                         p1n = p1.node()
                         p2n = p2.node()
                         cahs = self.changelog.commonancestorsheads(p1n, p2n)
                         if not cahs:
                             cahs = [nullrev]
                         return [self[r].manifest() for r in cahs]
 
                     def deletionfromparent(f):
                         # When a file is removed relative to p1 in a merge, this
                         # function determines whether the absence is due to a
                         # deletion from a parent, or whether the merge commit
                         # itself deletes the file. We decide this by doing a
                         # simplified three way merge of the manifest entry for
                         # the file. There are two ways we decide the merge
                         # itself didn't delete a file:
                         # - neither parent (nor the merge) contain the file
                         # - exactly one parent contains the file, and that
                         #   parent has the same filelog entry as the merge
                         #   ancestor (or all of them if there two). In other
                         #   words, that parent left the file unchanged while the
                         #   other one deleted it.
                         # One way to think about this is that deleting a file is
                         # similar to emptying it, so the list of changed files
                         # should be similar either way. The computation
                         # described above is not done directly in _filecommit
                         # when creating the list of changed files, however
                         # it does something very similar by comparing filelog
                         # nodes.
                         if f in m1:
                             return f not in m2 and all(
                                 f in ma and ma.find(f) == m1.find(f)
                                 for ma in mas()
                             )
                         elif f in m2:
                             return all(
                                 f in ma and ma.find(f) == m2.find(f)
                                 for ma in mas()
                             )
                         else:
                             return True
 
                     removed = [f for f in removed if not deletionfromparent(f)]
 
                 files = changed + removed
                 md = None
                 if not files:
                     # if no "files" actually changed in terms of the changelog,
                     # try hard to detect unmodified manifest entry so that the
                     # exact same commit can be reproduced later on convert.
                     md = m1.diff(m, scmutil.matchfiles(self, ctx.files()))
                 if not files and md:
                     self.ui.debug(
                         b'not reusing manifest (no file change in '
                         b'changelog, but manifest differs)\n'
                     )
                 if files or md:
                     self.ui.note(_(b"committing manifest\n"))
                     # we're using narrowmatch here since it's already applied at
                     # other stages (such as dirstate.walk), so we're already
                     # ignoring things outside of narrowspec in most cases. The
                     # one case where we might have files outside the narrowspec
                     # at this point is merges, and we already error out in the
                     # case where the merge has files outside of the narrowspec,
                     # so this is safe.
                     mn = mctx.write(
                         trp,
                         linkrev,
                         p1.manifestnode(),
                         p2.manifestnode(),
                         added,
                         drop,
                         match=self.narrowmatch(),
                     )
 
                     if writechangesetcopy:
                         filesadded = [
                             f for f in changed if not (f in m1 or f in m2)
                         ]
                         filesremoved = removed
                 else:
                     self.ui.debug(
                         b'reusing manifest from p1 (listed files '
                         b'actually unchanged)\n'
                     )
                     mn = p1.manifestnode()
             else:
                 self.ui.debug(b'reusing manifest from p1 (no file change)\n')
                 mn = p1.manifestnode()
                 files = []
 
             if writecopiesto == b'changeset-only':
                 # If writing only to changeset extras, use None to indicate that
                 # no entry should be written. If writing to both, write an empty
                 # entry to prevent the reader from falling back to reading
                 # filelogs.
                 p1copies = p1copies or None
                 p2copies = p2copies or None
                 filesadded = filesadded or None
                 filesremoved = filesremoved or None
 
             if origctx and origctx.manifestnode() == mn:
                 files = origctx.files()
 
             # update changelog
             self.ui.note(_(b"committing changelog\n"))
             self.changelog.delayupdate(tr)
             n = self.changelog.add(
                 mn,
                 files,
                 ctx.description(),
                 trp,
                 p1.node(),
                 p2.node(),
                 user,
                 ctx.date(),
                 ctx.extra().copy(),
                 p1copies,
                 p2copies,
                 filesadded,
                 filesremoved,
             )
             xp1, xp2 = p1.hex(), p2 and p2.hex() or b''
             self.hook(
                 b'pretxncommit',
                 throw=True,
                 node=hex(n),
                 parent1=xp1,
                 parent2=xp2,
             )
             # set the new commit is proper phase
             targetphase = subrepoutil.newcommitphase(self.ui, ctx)
             if targetphase:
                 # retract boundary do not alter parent changeset.
                 # if a parent have higher the resulting phase will
                 # be compliant anyway
                 #
                 # if minimal phase was 0 we don't need to retract anything
                 phases.registernew(self, tr, targetphase, [n])
             return n
 
     @unfilteredmethod
     def destroying(self):
         '''Inform the repository that nodes are about to be destroyed.
         Intended for use by strip and rollback, so there's a common
         place for anything that has to be done before destroying history.
 
         This is mostly useful for saving state that is in memory and waiting
         to be flushed when the current lock is released. Because a call to
         destroyed is imminent, the repo will be invalidated causing those
         changes to stay in memory (waiting for the next unlock), or vanish
         completely.
         '''
         # When using the same lock to commit and strip, the phasecache is left
         # dirty after committing. Then when we strip, the repo is invalidated,
         # causing those changes to disappear.
         if '_phasecache' in vars(self):
             self._phasecache.write()
 
     @unfilteredmethod
     def destroyed(self):
         '''Inform the repository that nodes have been destroyed.
         Intended for use by strip and rollback, so there's a common
         place for anything that has to be done after destroying history.
         '''
         # When one tries to:
         # 1) destroy nodes thus calling this method (e.g. strip)
         # 2) use phasecache somewhere (e.g. commit)
         #
         # then 2) will fail because the phasecache contains nodes that were
         # removed. We can either remove phasecache from the filecache,
         # causing it to reload next time it is accessed, or simply filter
         # the removed nodes now and write the updated cache.
         self._phasecache.filterunknown(self)
         self._phasecache.write()
 
         # refresh all repository caches
         self.updatecaches()
 
         # Ensure the persistent tag cache is updated.  Doing it now
         # means that the tag cache only has to worry about destroyed
         # heads immediately after a strip/rollback.  That in turn
         # guarantees that "cachetip == currenttip" (comparing both rev
         # and node) always means no nodes have been added or destroyed.
 
         # XXX this is suboptimal when qrefresh'ing: we strip the current
         # head, refresh the tag cache, then immediately add a new head.
         # But I think doing it this way is necessary for the "instant
         # tag cache retrieval" case to work.
         self.invalidate()
 
     def status(
         self,
         node1=b'.',
         node2=None,
         match=None,
         ignored=False,
         clean=False,
         unknown=False,
         listsubrepos=False,
     ):
         '''a convenience method that calls node1.status(node2)'''
         return self[node1].status(
             node2, match, ignored, clean, unknown, listsubrepos
         )
 
     def addpostdsstatus(self, ps):
         """Add a callback to run within the wlock, at the point at which status
         fixups happen.
 
         On status completion, callback(wctx, status) will be called with the
         wlock held, unless the dirstate has changed from underneath or the wlock
         couldn't be grabbed.
 
         Callbacks should not capture and use a cached copy of the dirstate --
         it might change in the meanwhile. Instead, they should access the
         dirstate via wctx.repo().dirstate.
 
         This list is emptied out after each status run -- extensions should
         make sure it adds to this list each time dirstate.status is called.
         Extensions should also make sure they don't call this for statuses
         that don't involve the dirstate.
         """
 
         # The list is located here for uniqueness reasons -- it is actually
         # managed by the workingctx, but that isn't unique per-repo.
         self._postdsstatus.append(ps)
 
     def postdsstatus(self):
         """Used by workingctx to get the list of post-dirstate-status hooks."""
         return self._postdsstatus
 
     def clearpostdsstatus(self):
         """Used by workingctx to clear post-dirstate-status hooks."""
         del self._postdsstatus[:]
 
     def heads(self, start=None):
         if start is None:
             cl = self.changelog
             headrevs = reversed(cl.headrevs())
             return [cl.node(rev) for rev in headrevs]
 
         heads = self.changelog.heads(start)
         # sort the output in rev descending order
         return sorted(heads, key=self.changelog.rev, reverse=True)
 
     def branchheads(self, branch=None, start=None, closed=False):
         '''return a (possibly filtered) list of heads for the given branch
 
         Heads are returned in topological order, from newest to oldest.
         If branch is None, use the dirstate branch.
         If start is not None, return only heads reachable from start.
         If closed is True, return heads that are marked as closed as well.
         '''
         if branch is None:
             branch = self[None].branch()
         branches = self.branchmap()
         if not branches.hasbranch(branch):
             return []
         # the cache returns heads ordered lowest to highest
         bheads = list(reversed(branches.branchheads(branch, closed=closed)))
         if start is not None:
             # filter out the heads that cannot be reached from startrev
             fbheads = set(self.changelog.nodesbetween([start], bheads)[2])
             bheads = [h for h in bheads if h in fbheads]
         return bheads
 
     def branches(self, nodes):
         if not nodes:
             nodes = [self.changelog.tip()]
         b = []
         for n in nodes:
             t = n
             while True:
                 p = self.changelog.parents(n)
                 if p[1] != nullid or p[0] == nullid:
                     b.append((t, n, p[0], p[1]))
                     break
                 n = p[0]
         return b
 
     def between(self, pairs):
         r = []
 
         for top, bottom in pairs:
             n, l, i = top, [], 0
             f = 1
 
             while n != bottom and n != nullid:
                 p = self.changelog.parents(n)[0]
                 if i == f:
                     l.append(n)
                     f = f * 2
                 n = p
                 i += 1
 
             r.append(l)
 
         return r
 
     def checkpush(self, pushop):
         """Extensions can override this function if additional checks have
         to be performed before pushing, or call it if they override push
         command.
         """
 
     @unfilteredpropertycache
     def prepushoutgoinghooks(self):
         """Return util.hooks consists of a pushop with repo, remote, outgoing
         methods, which are called before pushing changesets.
         """
         return util.hooks()
 
     def pushkey(self, namespace, key, old, new):
         try:
             tr = self.currenttransaction()
             hookargs = {}
             if tr is not None:
                 hookargs.update(tr.hookargs)
             hookargs = pycompat.strkwargs(hookargs)
             hookargs['namespace'] = namespace
             hookargs['key'] = key
             hookargs['old'] = old
             hookargs['new'] = new
             self.hook(b'prepushkey', throw=True, **hookargs)
         except error.HookAbort as exc:
             self.ui.write_err(_(b"pushkey-abort: %s\n") % exc)
             if exc.hint:
                 self.ui.write_err(_(b"(%s)\n") % exc.hint)
             return False
         self.ui.debug(b'pushing key for "%s:%s"\n' % (namespace, key))
         ret = pushkey.push(self, namespace, key, old, new)
 
         def runhook(unused_success):
             self.hook(
                 b'pushkey',
                 namespace=namespace,
                 key=key,
                 old=old,
                 new=new,
                 ret=ret,
             )
 
         self._afterlock(runhook)
         return ret
 
     def listkeys(self, namespace):
         self.hook(b'prelistkeys', throw=True, namespace=namespace)
         self.ui.debug(b'listing keys for "%s"\n' % namespace)
         values = pushkey.list(self, namespace)
         self.hook(b'listkeys', namespace=namespace, values=values)
         return values
 
     def debugwireargs(self, one, two, three=None, four=None, five=None):
         '''used to test argument passing over the wire'''
         return b"%s %s %s %s %s" % (
             one,
             two,
             pycompat.bytestr(three),
             pycompat.bytestr(four),
             pycompat.bytestr(five),
         )
 
     def savecommitmessage(self, text):
         fp = self.vfs(b'last-message.txt', b'wb')
         try:
             fp.write(text)
         finally:
             fp.close()
         return self.pathto(fp.name[len(self.root) + 1 :])
 
 
 # used to avoid circular references so destructors work
 def aftertrans(files):
     renamefiles = [tuple(t) for t in files]
 
     def a():
         for vfs, src, dest in renamefiles:
             # if src and dest refer to a same file, vfs.rename is a no-op,
             # leaving both src and dest on disk. delete dest to make sure
             # the rename couldn't be such a no-op.
             vfs.tryunlink(dest)
             try:
                 vfs.rename(src, dest)
             except OSError:  # journal file does not yet exist
                 pass
 
     return a
 
 
 def undoname(fn):
     base, name = os.path.split(fn)
     assert name.startswith(b'journal')
     return os.path.join(base, name.replace(b'journal', b'undo', 1))
 
 
 def instance(ui, path, create, intents=None, createopts=None):
     localpath = util.urllocalpath(path)
     if create:
         createrepository(ui, localpath, createopts=createopts)
 
     return makelocalrepository(ui, localpath, intents=intents)
 
 
 def islocal(path):
     return True
 
 
 def defaultcreateopts(ui, createopts=None):
     """Populate the default creation options for a repository.
 
     A dictionary of explicitly requested creation options can be passed
     in. Missing keys will be populated.
     """
     createopts = dict(createopts or {})
 
     if b'backend' not in createopts:
         # experimental config: storage.new-repo-backend
         createopts[b'backend'] = ui.config(b'storage', b'new-repo-backend')
 
     return createopts
 
 
 def newreporequirements(ui, createopts):
     """Determine the set of requirements for a new local repository.
 
     Extensions can wrap this function to specify custom requirements for
     new repositories.
     """
     # If the repo is being created from a shared repository, we copy
     # its requirements.
     if b'sharedrepo' in createopts:
         requirements = set(createopts[b'sharedrepo'].requirements)
         if createopts.get(b'sharedrelative'):
             requirements.add(b'relshared')
         else:
             requirements.add(b'shared')
 
         return requirements
 
     if b'backend' not in createopts:
         raise error.ProgrammingError(
             b'backend key not present in createopts; '
             b'was defaultcreateopts() called?'
         )
 
     if createopts[b'backend'] != b'revlogv1':
         raise error.Abort(
             _(
                 b'unable to determine repository requirements for '
                 b'storage backend: %s'
             )
             % createopts[b'backend']
         )
 
     requirements = {b'revlogv1'}
     if ui.configbool(b'format', b'usestore'):
         requirements.add(b'store')
         if ui.configbool(b'format', b'usefncache'):
             requirements.add(b'fncache')
             if ui.configbool(b'format', b'dotencode'):
                 requirements.add(b'dotencode')
 
     compengines = ui.configlist(b'format', b'revlog-compression')
     for compengine in compengines:
         if compengine in util.compengines:
             break
     else:
         raise error.Abort(
             _(
                 b'compression engines %s defined by '
                 b'format.revlog-compression not available'
             )
             % b', '.join(b'"%s"' % e for e in compengines),
             hint=_(
                 b'run "hg debuginstall" to list available '
                 b'compression engines'
             ),
         )
 
     # zlib is the historical default and doesn't need an explicit requirement.
     if compengine == b'zstd':
         requirements.add(b'revlog-compression-zstd')
     elif compengine != b'zlib':
         requirements.add(b'exp-compression-%s' % compengine)
 
     if scmutil.gdinitconfig(ui):
         requirements.add(b'generaldelta')
         if ui.configbool(b'format', b'sparse-revlog'):
             requirements.add(SPARSEREVLOG_REQUIREMENT)
 
     # experimental config: format.exp-use-side-data
     if ui.configbool(b'format', b'exp-use-side-data'):
         requirements.add(SIDEDATA_REQUIREMENT)
     # experimental config: format.exp-use-copies-side-data-changeset
     if ui.configbool(b'format', b'exp-use-copies-side-data-changeset'):
         requirements.add(SIDEDATA_REQUIREMENT)
         requirements.add(COPIESSDC_REQUIREMENT)
     if ui.configbool(b'experimental', b'treemanifest'):
         requirements.add(b'treemanifest')
 
     revlogv2 = ui.config(b'experimental', b'revlogv2')
     if revlogv2 == b'enable-unstable-format-and-corrupt-my-data':
         requirements.remove(b'revlogv1')
         # generaldelta is implied by revlogv2.
         requirements.discard(b'generaldelta')
         requirements.add(REVLOGV2_REQUIREMENT)
     # experimental config: format.internal-phase
     if ui.configbool(b'format', b'internal-phase'):
         requirements.add(b'internal-phase')
 
     if createopts.get(b'narrowfiles'):
         requirements.add(repository.NARROW_REQUIREMENT)
 
     if createopts.get(b'lfs'):
         requirements.add(b'lfs')
 
     if ui.configbool(b'format', b'bookmarks-in-store'):
         requirements.add(bookmarks.BOOKMARKS_IN_STORE_REQUIREMENT)
 
     if ui.configbool(b'experimental', b'exp-persistent-nodemap'):
         requirements.add(NODEMAP_REQUIREMENT)
 
     return requirements
 
 
 def filterknowncreateopts(ui, createopts):
     """Filters a dict of repo creation options against options that are known.
 
     Receives a dict of repo creation options and returns a dict of those
     options that we don't know how to handle.
 
     This function is called as part of repository creation. If the
     returned dict contains any items, repository creation will not
     be allowed, as it means there was a request to create a repository
     with options not recognized by loaded code.
 
     Extensions can wrap this function to filter out creation options
     they know how to handle.
     """
     known = {
         b'backend',
         b'lfs',
         b'narrowfiles',
         b'sharedrepo',
         b'sharedrelative',
         b'shareditems',
         b'shallowfilestore',
     }
 
     return {k: v for k, v in createopts.items() if k not in known}
 
 
 def createrepository(ui, path, createopts=None):
     """Create a new repository in a vfs.
 
     ``path`` path to the new repo's working directory.
     ``createopts`` options for the new repository.
 
     The following keys for ``createopts`` are recognized:
 
     backend
        The storage backend to use.
     lfs
        Repository will be created with ``lfs`` requirement. The lfs extension
        will automatically be loaded when the repository is accessed.
     narrowfiles
        Set up repository to support narrow file storage.
     sharedrepo
        Repository object from which storage should be shared.
     sharedrelative
        Boolean indicating if the path to the shared repo should be
        stored as relative. By default, the pointer to the "parent" repo
        is stored as an absolute path.
     shareditems
        Set of items to share to the new repository (in addition to storage).
     shallowfilestore
        Indicates that storage for files should be shallow (not all ancestor
        revisions are known).
     """
     createopts = defaultcreateopts(ui, createopts=createopts)
 
     unknownopts = filterknowncreateopts(ui, createopts)
 
     if not isinstance(unknownopts, dict):
         raise error.ProgrammingError(
             b'filterknowncreateopts() did not return a dict'
         )
 
     if unknownopts:
         raise error.Abort(
             _(
                 b'unable to create repository because of unknown '
                 b'creation option: %s'
             )
             % b', '.join(sorted(unknownopts)),
             hint=_(b'is a required extension not loaded?'),
         )
 
     requirements = newreporequirements(ui, createopts=createopts)
 
     wdirvfs = vfsmod.vfs(path, expandpath=True, realpath=True)
 
     hgvfs = vfsmod.vfs(wdirvfs.join(b'.hg'))
     if hgvfs.exists():
         raise error.RepoError(_(b'repository %s already exists') % path)
 
     if b'sharedrepo' in createopts:
         sharedpath = createopts[b'sharedrepo'].sharedpath
 
         if createopts.get(b'sharedrelative'):
             try:
                 sharedpath = os.path.relpath(sharedpath, hgvfs.base)
             except (IOError, ValueError) as e:
                 # ValueError is raised on Windows if the drive letters differ
                 # on each path.
                 raise error.Abort(
                     _(b'cannot calculate relative path'),
                     hint=stringutil.forcebytestr(e),
                 )
 
     if not wdirvfs.exists():
         wdirvfs.makedirs()
 
     hgvfs.makedir(notindexed=True)
     if b'sharedrepo' not in createopts:
         hgvfs.mkdir(b'cache')
     hgvfs.mkdir(b'wcache')
 
     if b'store' in requirements and b'sharedrepo' not in createopts:
         hgvfs.mkdir(b'store')
 
         # We create an invalid changelog outside the store so very old
         # Mercurial versions (which didn't know about the requirements
         # file) encounter an error on reading the changelog. This
         # effectively locks out old clients and prevents them from
         # mucking with a repo in an unknown format.
         #
         # The revlog header has version 2, which won't be recognized by
         # such old clients.
         hgvfs.append(
             b'00changelog.i',
             b'\0\0\0\2 dummy changelog to prevent using the old repo '
             b'layout',
         )
 
     scmutil.writerequires(hgvfs, requirements)
 
     # Write out file telling readers where to find the shared store.
     if b'sharedrepo' in createopts:
         hgvfs.write(b'sharedpath', sharedpath)
 
     if createopts.get(b'shareditems'):
         shared = b'\n'.join(sorted(createopts[b'shareditems'])) + b'\n'
         hgvfs.write(b'shared', shared)
 
 
 def poisonrepository(repo):
     """Poison a repository instance so it can no longer be used."""
     # Perform any cleanup on the instance.
     repo.close()
 
     # Our strategy is to replace the type of the object with one that
     # has all attribute lookups result in error.
     #
     # But we have to allow the close() method because some constructors
     # of repos call close() on repo references.
     class poisonedrepository(object):
         def __getattribute__(self, item):
             if item == 'close':
                 return object.__getattribute__(self, item)
 
             raise error.ProgrammingError(
                 b'repo instances should not be used after unshare'
             )
 
         def close(self):
             pass
 
     # We may have a repoview, which intercepts __setattr__. So be sure
     # we operate at the lowest level possible.
     object.__setattr__(repo, '__class__', poisonedrepository)

mercurial/manifest.py

@@ -1,2304 +1,2302 b''
 # manifest.py - manifest revision class for mercurial
 #
 # Copyright 2005-2007 Matt Mackall <[e-mail]>
 #
 # 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 heapq
 import itertools
 import struct
 import weakref
 
 from .i18n import _
 from .node import (
     bin,
     hex,
     nullid,
     nullrev,
 )
 from .pycompat import getattr
 from . import (
     encoding,
     error,
     match as matchmod,
     mdiff,
     pathutil,
     policy,
     pycompat,
     revlog,
     util,
 )
 from .interfaces import (
     repository,
     util as interfaceutil,
 )
 
 parsers = policy.importmod('parsers')
 propertycache = util.propertycache
 
 # Allow tests to more easily test the alternate path in manifestdict.fastdelta()
 FASTDELTA_TEXTDIFF_THRESHOLD = 1000
 
 
 def _parse(data):
     # This method does a little bit of excessive-looking
     # precondition checking. This is so that the behavior of this
     # class exactly matches its C counterpart to try and help
     # prevent surprise breakage for anyone that develops against
     # the pure version.
     if data and data[-1:] != b'\n':
         raise ValueError(b'Manifest did not end in a newline.')
     prev = None
     for l in data.splitlines():
         if prev is not None and prev > l:
             raise ValueError(b'Manifest lines not in sorted order.')
         prev = l
         f, n = l.split(b'\0')
         nl = len(n)
         if 64 < nl:
             # modern hash, full width
             yield f, bin(n[:64]), n[64:]
         elif 40 < nl < 45:
             # legacy hash, always sha1
             yield f, bin(n[:40]), n[40:]
         else:
             yield f, bin(n), b''
 
 
 def _text(it):
     files = []
     lines = []
     for f, n, fl in it:
         files.append(f)
         # if this is changed to support newlines in filenames,
         # be sure to check the templates/ dir again (especially *-raw.tmpl)
         lines.append(b"%s\0%s%s\n" % (f, hex(n), fl))
 
     _checkforbidden(files)
     return b''.join(lines)
 
 
 class lazymanifestiter(object):
     def __init__(self, lm):
         self.pos = 0
         self.lm = lm
 
     def __iter__(self):
         return self
 
     def next(self):
         try:
             data, pos = self.lm._get(self.pos)
         except IndexError:
             raise StopIteration
         if pos == -1:
             self.pos += 1
             return data[0]
         self.pos += 1
         zeropos = data.find(b'\x00', pos)
         return data[pos:zeropos]
 
     __next__ = next
 
 
 class lazymanifestiterentries(object):
     def __init__(self, lm):
         self.lm = lm
         self.pos = 0
 
     def __iter__(self):
         return self
 
     def next(self):
         try:
             data, pos = self.lm._get(self.pos)
         except IndexError:
             raise StopIteration
         if pos == -1:
             self.pos += 1
             return data
         zeropos = data.find(b'\x00', pos)
         hashval = unhexlify(data, self.lm.extrainfo[self.pos], zeropos + 1, 40)
         flags = self.lm._getflags(data, self.pos, zeropos)
         self.pos += 1
         return (data[pos:zeropos], hashval, flags)
 
     __next__ = next
 
 
 def unhexlify(data, extra, pos, length):
     s = bin(data[pos : pos + length])
     if extra:
         s += chr(extra & 0xFF)
     return s
 
 
 def _cmp(a, b):
     return (a > b) - (a < b)
 
 
 class _lazymanifest(object):
     """A pure python manifest backed by a byte string.  It is supplimented with
     internal lists as it is modified, until it is compacted back to a pure byte
     string.
 
     ``data`` is the initial manifest data.
 
     ``positions`` is a list of offsets, one per manifest entry.  Positive
     values are offsets into ``data``, negative values are offsets into the
     ``extradata`` list.  When an entry is removed, its entry is dropped from
     ``positions``.  The values are encoded such that when walking the list and
     indexing into ``data`` or ``extradata`` as appropriate, the entries are
     sorted by filename.
 
     ``extradata`` is a list of (key, hash, flags) for entries that were added or
     modified since the manifest was created or compacted.
     """
 
     def __init__(
         self,
         data,
         positions=None,
         extrainfo=None,
         extradata=None,
         hasremovals=False,
     ):
         if positions is None:
             self.positions = self.findlines(data)
             self.extrainfo = [0] * len(self.positions)
             self.data = data
             self.extradata = []
             self.hasremovals = False
         else:
             self.positions = positions[:]
             self.extrainfo = extrainfo[:]
             self.extradata = extradata[:]
             self.data = data
             self.hasremovals = hasremovals
 
     def findlines(self, data):
         if not data:
             return []
         pos = data.find(b"\n")
         if pos == -1 or data[-1:] != b'\n':
             raise ValueError(b"Manifest did not end in a newline.")
         positions = [0]
         prev = data[: data.find(b'\x00')]
         while pos < len(data) - 1 and pos != -1:
             positions.append(pos + 1)
             nexts = data[pos + 1 : data.find(b'\x00', pos + 1)]
             if nexts < prev:
                 raise ValueError(b"Manifest lines not in sorted order.")
             prev = nexts
             pos = data.find(b"\n", pos + 1)
         return positions
 
     def _get(self, index):
         # get the position encoded in pos:
         #   positive number is an index in 'data'
         #   negative number is in extrapieces
         pos = self.positions[index]
         if pos >= 0:
             return self.data, pos
         return self.extradata[-pos - 1], -1
 
     def _getkey(self, pos):
         if pos >= 0:
             return self.data[pos : self.data.find(b'\x00', pos + 1)]
         return self.extradata[-pos - 1][0]
 
     def bsearch(self, key):
         first = 0
         last = len(self.positions) - 1
 
         while first <= last:
             midpoint = (first + last) // 2
             nextpos = self.positions[midpoint]
             candidate = self._getkey(nextpos)
             r = _cmp(key, candidate)
             if r == 0:
                 return midpoint
             else:
                 if r < 0:
                     last = midpoint - 1
                 else:
                     first = midpoint + 1
         return -1
 
     def bsearch2(self, key):
         # same as the above, but will always return the position
         # done for performance reasons
         first = 0
         last = len(self.positions) - 1
 
         while first <= last:
             midpoint = (first + last) // 2
             nextpos = self.positions[midpoint]
             candidate = self._getkey(nextpos)
             r = _cmp(key, candidate)
             if r == 0:
                 return (midpoint, True)
             else:
                 if r < 0:
                     last = midpoint - 1
                 else:
                     first = midpoint + 1
         return (first, False)
 
     def __contains__(self, key):
         return self.bsearch(key) != -1
 
     def _getflags(self, data, needle, pos):
         start = pos + 41
         end = data.find(b"\n", start)
         if end == -1:
             end = len(data) - 1
         if start == end:
             return b''
         return self.data[start:end]
 
     def __getitem__(self, key):
         if not isinstance(key, bytes):
             raise TypeError(b"getitem: manifest keys must be a bytes.")
         needle = self.bsearch(key)
         if needle == -1:
             raise KeyError
         data, pos = self._get(needle)
         if pos == -1:
             return (data[1], data[2])
         zeropos = data.find(b'\x00', pos)
         nlpos = data.find(b'\n', zeropos)
         assert 0 <= needle <= len(self.positions)
         assert len(self.extrainfo) == len(self.positions)
         hlen = nlpos - zeropos - 1
         # Hashes sometimes have an extra byte tucked on the end, so
         # detect that.
         if hlen % 2:
             hlen -= 1
         hashval = unhexlify(data, self.extrainfo[needle], zeropos + 1, hlen)
         flags = self._getflags(data, needle, zeropos)
         return (hashval, flags)
 
     def __delitem__(self, key):
         needle, found = self.bsearch2(key)
         if not found:
             raise KeyError
         cur = self.positions[needle]
         self.positions = self.positions[:needle] + self.positions[needle + 1 :]
         self.extrainfo = self.extrainfo[:needle] + self.extrainfo[needle + 1 :]
         if cur >= 0:
             # This does NOT unsort the list as far as the search functions are
             # concerned, as they only examine lines mapped by self.positions.
             self.data = self.data[:cur] + b'\x00' + self.data[cur + 1 :]
             self.hasremovals = True
 
     def __setitem__(self, key, value):
         if not isinstance(key, bytes):
             raise TypeError(b"setitem: manifest keys must be a byte string.")
         if not isinstance(value, tuple) or len(value) != 2:
             raise TypeError(
                 b"Manifest values must be a tuple of (node, flags)."
             )
         hashval = value[0]
         # hashes are either 20 or 32 bytes (sha1 or its replacement),
         # and allow one extra byte taht won't be persisted to disk but
         # is sometimes used in memory.
         if not isinstance(hashval, bytes) or not (
             20 <= len(hashval) <= 22 or 32 <= len(hashval) <= 34
         ):
             raise TypeError(b"node must be a 20-byte or 32-byte byte string")
         flags = value[1]
         if len(hashval) == 22:
             hashval = hashval[:-1]
         if not isinstance(flags, bytes) or len(flags) > 1:
             raise TypeError(b"flags must a 0 or 1 byte string, got %r", flags)
         needle, found = self.bsearch2(key)
         if found:
             # put the item
             pos = self.positions[needle]
             if pos < 0:
                 self.extradata[-pos - 1] = (key, hashval, value[1])
             else:
                 # just don't bother
                 self.extradata.append((key, hashval, value[1]))
                 self.positions[needle] = -len(self.extradata)
         else:
             # not found, put it in with extra positions
             self.extradata.append((key, hashval, value[1]))
             self.positions = (
                 self.positions[:needle]
                 + [-len(self.extradata)]
                 + self.positions[needle:]
             )
             self.extrainfo = (
                 self.extrainfo[:needle] + [0] + self.extrainfo[needle:]
             )
 
     def copy(self):
         # XXX call _compact like in C?
         return _lazymanifest(
             self.data,
             self.positions,
             self.extrainfo,
             self.extradata,
             self.hasremovals,
         )
 
     def _compact(self):
         # hopefully not called TOO often
         if len(self.extradata) == 0 and not self.hasremovals:
             return
         l = []
         i = 0
         offset = 0
         self.extrainfo = [0] * len(self.positions)
         while i < len(self.positions):
             if self.positions[i] >= 0:
                 cur = self.positions[i]
                 last_cut = cur
 
                 # Collect all contiguous entries in the buffer at the current
                 # offset, breaking out only for added/modified items held in
                 # extradata, or a deleted line prior to the next position.
                 while True:
                     self.positions[i] = offset
                     i += 1
                     if i == len(self.positions) or self.positions[i] < 0:
                         break
 
                     # A removed file has no positions[] entry, but does have an
                     # overwritten first byte.  Break out and find the end of the
                     # current good entry/entries if there is a removed file
                     # before the next position.
                     if (
                         self.hasremovals
                         and self.data.find(b'\n\x00', cur, self.positions[i])
                         != -1
                     ):
                         break
 
                     offset += self.positions[i] - cur
                     cur = self.positions[i]
                 end_cut = self.data.find(b'\n', cur)
                 if end_cut != -1:
                     end_cut += 1
                 offset += end_cut - cur
                 l.append(self.data[last_cut:end_cut])
             else:
                 while i < len(self.positions) and self.positions[i] < 0:
                     cur = self.positions[i]
                     t = self.extradata[-cur - 1]
                     l.append(self._pack(t))
                     self.positions[i] = offset
                     # Hashes are either 20 bytes (old sha1s) or 32
                     # bytes (new non-sha1).
                     hlen = 20
                     if len(t[1]) > 25:
                         hlen = 32
                     if len(t[1]) > hlen:
                         self.extrainfo[i] = ord(t[1][hlen + 1])
                     offset += len(l[-1])
                     i += 1
         self.data = b''.join(l)
         self.hasremovals = False
         self.extradata = []
 
     def _pack(self, d):
         n = d[1]
         if len(n) == 21 or len(n) == 33:
             n = n[:-1]
         assert len(n) == 20 or len(n) == 32
         return d[0] + b'\x00' + hex(n) + d[2] + b'\n'
 
     def text(self):
         self._compact()
         return self.data
 
     def diff(self, m2, clean=False):
         '''Finds changes between the current manifest and m2.'''
         # XXX think whether efficiency matters here
         diff = {}
 
         for fn, e1, flags in self.iterentries():
             if fn not in m2:
                 diff[fn] = (e1, flags), (None, b'')
             else:
                 e2 = m2[fn]
                 if (e1, flags) != e2:
                     diff[fn] = (e1, flags), e2
                 elif clean:
                     diff[fn] = None
 
         for fn, e2, flags in m2.iterentries():
             if fn not in self:
                 diff[fn] = (None, b''), (e2, flags)
 
         return diff
 
     def iterentries(self):
         return lazymanifestiterentries(self)
 
     def iterkeys(self):
         return lazymanifestiter(self)
 
     def __iter__(self):
         return lazymanifestiter(self)
 
     def __len__(self):
         return len(self.positions)
 
     def filtercopy(self, filterfn):
         # XXX should be optimized
         c = _lazymanifest(b'')
         for f, n, fl in self.iterentries():
             if filterfn(f):
                 c[f] = n, fl
         return c
 
 
 try:
     _lazymanifest = parsers.lazymanifest
 except AttributeError:
     pass
 
 
 @interfaceutil.implementer(repository.imanifestdict)
 class manifestdict(object):
     def __init__(self, data=b''):
         self._lm = _lazymanifest(data)
 
     def __getitem__(self, key):
         return self._lm[key][0]
 
     def find(self, key):
         return self._lm[key]
 
     def __len__(self):
         return len(self._lm)
 
     def __nonzero__(self):
         # nonzero is covered by the __len__ function, but implementing it here
         # makes it easier for extensions to override.
         return len(self._lm) != 0
 
     __bool__ = __nonzero__
 
     def __setitem__(self, key, node):
         self._lm[key] = node, self.flags(key)
 
     def __contains__(self, key):
         if key is None:
             return False
         return key in self._lm
 
     def __delitem__(self, key):
         del self._lm[key]
 
     def __iter__(self):
         return self._lm.__iter__()
 
     def iterkeys(self):
         return self._lm.iterkeys()
 
     def keys(self):
         return list(self.iterkeys())
 
     def filesnotin(self, m2, match=None):
         '''Set of files in this manifest that are not in the other'''
         if match is not None:
             match = matchmod.badmatch(match, lambda path, msg: None)
             sm2 = set(m2.walk(match))
             return {f for f in self.walk(match) if f not in sm2}
         return {f for f in self if f not in m2}
 
     @propertycache
     def _dirs(self):
         return pathutil.dirs(self)
 
     def dirs(self):
         return self._dirs
 
     def hasdir(self, dir):
         return dir in self._dirs
 
     def _filesfastpath(self, match):
         '''Checks whether we can correctly and quickly iterate over matcher
         files instead of over manifest files.'''
         files = match.files()
         return len(files) < 100 and (
             match.isexact()
             or (match.prefix() and all(fn in self for fn in files))
         )
 
     def walk(self, match):
         '''Generates matching file names.
 
         Equivalent to manifest.matches(match).iterkeys(), but without creating
         an entirely new manifest.
 
         It also reports nonexistent files by marking them bad with match.bad().
         '''
         if match.always():
             for f in iter(self):
                 yield f
             return
 
         fset = set(match.files())
 
         # avoid the entire walk if we're only looking for specific files
         if self._filesfastpath(match):
             for fn in sorted(fset):
                 if fn in self:
                     yield fn
             return
 
         for fn in self:
             if fn in fset:
                 # specified pattern is the exact name
                 fset.remove(fn)
             if match(fn):
                 yield fn
 
         # for dirstate.walk, files=[''] means "walk the whole tree".
         # follow that here, too
         fset.discard(b'')
 
         for fn in sorted(fset):
             if not self.hasdir(fn):
                 match.bad(fn, None)
 
     def _matches(self, match):
         '''generate a new manifest filtered by the match argument'''
         if match.always():
             return self.copy()
 
         if self._filesfastpath(match):
             m = manifestdict()
             lm = self._lm
             for fn in match.files():
                 if fn in lm:
                     m._lm[fn] = lm[fn]
             return m
 
         m = manifestdict()
         m._lm = self._lm.filtercopy(match)
         return m
 
     def diff(self, m2, match=None, clean=False):
         '''Finds changes between the current manifest and m2.
 
         Args:
           m2: the manifest to which this manifest should be compared.
           clean: if true, include files unchanged between these manifests
                  with a None value in the returned dictionary.
 
         The result is returned as a dict with filename as key and
         values of the form ((n1,fl1),(n2,fl2)), where n1/n2 is the
         nodeid in the current/other manifest and fl1/fl2 is the flag
         in the current/other manifest. Where the file does not exist,
         the nodeid will be None and the flags will be the empty
         string.
         '''
         if match:
             m1 = self._matches(match)
             m2 = m2._matches(match)
             return m1.diff(m2, clean=clean)
         return self._lm.diff(m2._lm, clean)
 
     def setflag(self, key, flag):
         self._lm[key] = self[key], flag
 
     def get(self, key, default=None):
         try:
             return self._lm[key][0]
         except KeyError:
             return default
 
     def flags(self, key):
         try:
             return self._lm[key][1]
         except KeyError:
             return b''
 
     def copy(self):
         c = manifestdict()
         c._lm = self._lm.copy()
         return c
 
     def items(self):
         return (x[:2] for x in self._lm.iterentries())
 
     def iteritems(self):
         return (x[:2] for x in self._lm.iterentries())
 
     def iterentries(self):
         return self._lm.iterentries()
 
     def text(self):
         # most likely uses native version
         return self._lm.text()
 
     def fastdelta(self, base, changes):
         """Given a base manifest text as a bytearray and a list of changes
         relative to that text, compute a delta that can be used by revlog.
         """
         delta = []
         dstart = None
         dend = None
         dline = [b""]
         start = 0
         # zero copy representation of base as a buffer
         addbuf = util.buffer(base)
 
         changes = list(changes)
         if len(changes) < FASTDELTA_TEXTDIFF_THRESHOLD:
             # start with a readonly loop that finds the offset of
             # each line and creates the deltas
             for f, todelete in changes:
                 # bs will either be the index of the item or the insert point
                 start, end = _msearch(addbuf, f, start)
                 if not todelete:
                     h, fl = self._lm[f]
                     l = b"%s\0%s%s\n" % (f, hex(h), fl)
                 else:
                     if start == end:
                         # item we want to delete was not found, error out
                         raise AssertionError(
                             _(b"failed to remove %s from manifest") % f
                         )
                     l = b""
                 if dstart is not None and dstart <= start and dend >= start:
                     if dend < end:
                         dend = end
                     if l:
                         dline.append(l)
                 else:
                     if dstart is not None:
                         delta.append([dstart, dend, b"".join(dline)])
                     dstart = start
                     dend = end
                     dline = [l]
 
             if dstart is not None:
                 delta.append([dstart, dend, b"".join(dline)])
             # apply the delta to the base, and get a delta for addrevision
             deltatext, arraytext = _addlistdelta(base, delta)
         else:
             # For large changes, it's much cheaper to just build the text and
             # diff it.
             arraytext = bytearray(self.text())
             deltatext = mdiff.textdiff(
                 util.buffer(base), util.buffer(arraytext)
             )
 
         return arraytext, deltatext
 
 
 def _msearch(m, s, lo=0, hi=None):
     '''return a tuple (start, end) that says where to find s within m.
 
     If the string is found m[start:end] are the line containing
     that string.  If start == end the string was not found and
     they indicate the proper sorted insertion point.
 
     m should be a buffer, a memoryview or a byte string.
     s is a byte string'''
 
     def advance(i, c):
         while i < lenm and m[i : i + 1] != c:
             i += 1
         return i
 
     if not s:
         return (lo, lo)
     lenm = len(m)
     if not hi:
         hi = lenm
     while lo < hi:
         mid = (lo + hi) // 2
         start = mid
         while start > 0 and m[start - 1 : start] != b'\n':
             start -= 1
         end = advance(start, b'\0')
         if bytes(m[start:end]) < s:
             # we know that after the null there are 40 bytes of sha1
             # this translates to the bisect lo = mid + 1
             lo = advance(end + 40, b'\n') + 1
         else:
             # this translates to the bisect hi = mid
             hi = start
     end = advance(lo, b'\0')
     found = m[lo:end]
     if s == found:
         # we know that after the null there are 40 bytes of sha1
         end = advance(end + 40, b'\n')
         return (lo, end + 1)
     else:
         return (lo, lo)
 
 
 def _checkforbidden(l):
     """Check filenames for illegal characters."""
     for f in l:
         if b'\n' in f or b'\r' in f:
             raise error.StorageError(
                 _(b"'\\n' and '\\r' disallowed in filenames: %r")
                 % pycompat.bytestr(f)
             )
 
 
 # apply the changes collected during the bisect loop to our addlist
 # return a delta suitable for addrevision
 def _addlistdelta(addlist, x):
     # for large addlist arrays, building a new array is cheaper
     # than repeatedly modifying the existing one
     currentposition = 0
     newaddlist = bytearray()
 
     for start, end, content in x:
         newaddlist += addlist[currentposition:start]
         if content:
             newaddlist += bytearray(content)
 
         currentposition = end
 
     newaddlist += addlist[currentposition:]
 
     deltatext = b"".join(
         struct.pack(b">lll", start, end, len(content)) + content
         for start, end, content in x
     )
     return deltatext, newaddlist
 
 
 def _splittopdir(f):
     if b'/' in f:
         dir, subpath = f.split(b'/', 1)
         return dir + b'/', subpath
     else:
         return b'', f
 
 
 _noop = lambda s: None
 
 
 @interfaceutil.implementer(repository.imanifestdict)
 class treemanifest(object):
     def __init__(self, dir=b'', text=b''):
         self._dir = dir
         self._node = nullid
         self._loadfunc = _noop
         self._copyfunc = _noop
         self._dirty = False
         self._dirs = {}
         self._lazydirs = {}
         # Using _lazymanifest here is a little slower than plain old dicts
         self._files = {}
         self._flags = {}
         if text:
 
             def readsubtree(subdir, subm):
                 raise AssertionError(
                     b'treemanifest constructor only accepts flat manifests'
                 )
 
             self.parse(text, readsubtree)
             self._dirty = True  # Mark flat manifest dirty after parsing
 
     def _subpath(self, path):
         return self._dir + path
 
     def _loadalllazy(self):
         selfdirs = self._dirs
         for d, (path, node, readsubtree, docopy) in pycompat.iteritems(
             self._lazydirs
         ):
             if docopy:
                 selfdirs[d] = readsubtree(path, node).copy()
             else:
                 selfdirs[d] = readsubtree(path, node)
         self._lazydirs = {}
 
     def _loadlazy(self, d):
         v = self._lazydirs.get(d)
         if v:
             path, node, readsubtree, docopy = v
             if docopy:
                 self._dirs[d] = readsubtree(path, node).copy()
             else:
                 self._dirs[d] = readsubtree(path, node)
             del self._lazydirs[d]
 
     def _loadchildrensetlazy(self, visit):
         if not visit:
             return None
         if visit == b'all' or visit == b'this':
             self._loadalllazy()
             return None
 
         loadlazy = self._loadlazy
         for k in visit:
             loadlazy(k + b'/')
         return visit
 
     def _loaddifflazy(self, t1, t2):
         """load items in t1 and t2 if they're needed for diffing.
 
         The criteria currently is:
         - if it's not present in _lazydirs in either t1 or t2, load it in the
           other (it may already be loaded or it may not exist, doesn't matter)
         - if it's present in _lazydirs in both, compare the nodeid; if it
           differs, load it in both
         """
         toloadlazy = []
         for d, v1 in pycompat.iteritems(t1._lazydirs):
             v2 = t2._lazydirs.get(d)
             if not v2 or v2[1] != v1[1]:
                 toloadlazy.append(d)
         for d, v1 in pycompat.iteritems(t2._lazydirs):
             if d not in t1._lazydirs:
                 toloadlazy.append(d)
 
         for d in toloadlazy:
             t1._loadlazy(d)
             t2._loadlazy(d)
 
     def __len__(self):
         self._load()
         size = len(self._files)
         self._loadalllazy()
         for m in self._dirs.values():
             size += m.__len__()
         return size
 
     def __nonzero__(self):
         # Faster than "__len() != 0" since it avoids loading sub-manifests
         return not self._isempty()
 
     __bool__ = __nonzero__
 
     def _isempty(self):
         self._load()  # for consistency; already loaded by all callers
         # See if we can skip loading everything.
         if self._files or (
             self._dirs and any(not m._isempty() for m in self._dirs.values())
         ):
             return False
         self._loadalllazy()
         return not self._dirs or all(m._isempty() for m in self._dirs.values())
 
     @encoding.strmethod
     def __repr__(self):
         return (
             b'<treemanifest dir=%s, node=%s, loaded=%r, dirty=%r at 0x%x>'
             % (
                 self._dir,
                 hex(self._node),
                 bool(self._loadfunc is _noop),
                 self._dirty,
                 id(self),
             )
         )
 
     def dir(self):
         '''The directory that this tree manifest represents, including a
         trailing '/'. Empty string for the repo root directory.'''
         return self._dir
 
     def node(self):
         '''This node of this instance. nullid for unsaved instances. Should
         be updated when the instance is read or written from a revlog.
         '''
         assert not self._dirty
         return self._node
 
     def setnode(self, node):
         self._node = node
         self._dirty = False
 
     def iterentries(self):
         self._load()
         self._loadalllazy()
         for p, n in sorted(
             itertools.chain(self._dirs.items(), self._files.items())
         ):
             if p in self._files:
                 yield self._subpath(p), n, self._flags.get(p, b'')
             else:
                 for x in n.iterentries():
                     yield x
 
     def items(self):
         self._load()
         self._loadalllazy()
         for p, n in sorted(
             itertools.chain(self._dirs.items(), self._files.items())
         ):
             if p in self._files:
                 yield self._subpath(p), n
             else:
                 for f, sn in pycompat.iteritems(n):
                     yield f, sn
 
     iteritems = items
 
     def iterkeys(self):
         self._load()
         self._loadalllazy()
         for p in sorted(itertools.chain(self._dirs, self._files)):
             if p in self._files:
                 yield self._subpath(p)
             else:
                 for f in self._dirs[p]:
                     yield f
 
     def keys(self):
         return list(self.iterkeys())
 
     def __iter__(self):
         return self.iterkeys()
 
     def __contains__(self, f):
         if f is None:
             return False
         self._load()
         dir, subpath = _splittopdir(f)
         if dir:
             self._loadlazy(dir)
 
             if dir not in self._dirs:
                 return False
 
             return self._dirs[dir].__contains__(subpath)
         else:
             return f in self._files
 
     def get(self, f, default=None):
         self._load()
         dir, subpath = _splittopdir(f)
         if dir:
             self._loadlazy(dir)
 
             if dir not in self._dirs:
                 return default
             return self._dirs[dir].get(subpath, default)
         else:
             return self._files.get(f, default)
 
     def __getitem__(self, f):
         self._load()
         dir, subpath = _splittopdir(f)
         if dir:
             self._loadlazy(dir)
 
             return self._dirs[dir].__getitem__(subpath)
         else:
             return self._files[f]
 
     def flags(self, f):
         self._load()
         dir, subpath = _splittopdir(f)
         if dir:
             self._loadlazy(dir)
 
             if dir not in self._dirs:
                 return b''
             return self._dirs[dir].flags(subpath)
         else:
             if f in self._lazydirs or f in self._dirs:
                 return b''
             return self._flags.get(f, b'')
 
     def find(self, f):
         self._load()
         dir, subpath = _splittopdir(f)
         if dir:
             self._loadlazy(dir)
 
             return self._dirs[dir].find(subpath)
         else:
             return self._files[f], self._flags.get(f, b'')
 
     def __delitem__(self, f):
         self._load()
         dir, subpath = _splittopdir(f)
         if dir:
             self._loadlazy(dir)
 
             self._dirs[dir].__delitem__(subpath)
             # If the directory is now empty, remove it
             if self._dirs[dir]._isempty():
                 del self._dirs[dir]
         else:
             del self._files[f]
             if f in self._flags:
                 del self._flags[f]
         self._dirty = True
 
     def __setitem__(self, f, n):
         assert n is not None
         self._load()
         dir, subpath = _splittopdir(f)
         if dir:
             self._loadlazy(dir)
             if dir not in self._dirs:
                 self._dirs[dir] = treemanifest(self._subpath(dir))
             self._dirs[dir].__setitem__(subpath, n)
         else:
             # manifest nodes are either 20 bytes or 32 bytes,
             # depending on the hash in use. An extra byte is
             # occasionally used by hg, but won't ever be
             # persisted. Trim to 21 or 33 bytes as appropriate.
             trim = 21 if len(n) < 25 else 33
             self._files[f] = n[:trim]  # to match manifestdict's behavior
         self._dirty = True
 
     def _load(self):
         if self._loadfunc is not _noop:
             lf, self._loadfunc = self._loadfunc, _noop
             lf(self)
         elif self._copyfunc is not _noop:
             cf, self._copyfunc = self._copyfunc, _noop
             cf(self)
 
     def setflag(self, f, flags):
         """Set the flags (symlink, executable) for path f."""
         self._load()
         dir, subpath = _splittopdir(f)
         if dir:
             self._loadlazy(dir)
             if dir not in self._dirs:
                 self._dirs[dir] = treemanifest(self._subpath(dir))
             self._dirs[dir].setflag(subpath, flags)
         else:
             self._flags[f] = flags
         self._dirty = True
 
     def copy(self):
         copy = treemanifest(self._dir)
         copy._node = self._node
         copy._dirty = self._dirty
         if self._copyfunc is _noop:
 
             def _copyfunc(s):
                 self._load()
                 s._lazydirs = {
                     d: (p, n, r, True)
                     for d, (p, n, r, c) in pycompat.iteritems(self._lazydirs)
                 }
                 sdirs = s._dirs
                 for d, v in pycompat.iteritems(self._dirs):
                     sdirs[d] = v.copy()
                 s._files = dict.copy(self._files)
                 s._flags = dict.copy(self._flags)
 
             if self._loadfunc is _noop:
                 _copyfunc(copy)
             else:
                 copy._copyfunc = _copyfunc
         else:
             copy._copyfunc = self._copyfunc
         return copy
 
     def filesnotin(self, m2, match=None):
         '''Set of files in this manifest that are not in the other'''
         if match and not match.always():
             m1 = self._matches(match)
             m2 = m2._matches(match)
             return m1.filesnotin(m2)
 
         files = set()
 
         def _filesnotin(t1, t2):
             if t1._node == t2._node and not t1._dirty and not t2._dirty:
                 return
             t1._load()
             t2._load()
             self._loaddifflazy(t1, t2)
             for d, m1 in pycompat.iteritems(t1._dirs):
                 if d in t2._dirs:
                     m2 = t2._dirs[d]
                     _filesnotin(m1, m2)
                 else:
                     files.update(m1.iterkeys())
 
             for fn in t1._files:
                 if fn not in t2._files:
                     files.add(t1._subpath(fn))
 
         _filesnotin(self, m2)
         return files
 
     @propertycache
     def _alldirs(self):
         return pathutil.dirs(self)
 
     def dirs(self):
         return self._alldirs
 
     def hasdir(self, dir):
         self._load()
         topdir, subdir = _splittopdir(dir)
         if topdir:
             self._loadlazy(topdir)
             if topdir in self._dirs:
                 return self._dirs[topdir].hasdir(subdir)
             return False
         dirslash = dir + b'/'
         return dirslash in self._dirs or dirslash in self._lazydirs
 
     def walk(self, match):
         '''Generates matching file names.
 
         It also reports nonexistent files by marking them bad with match.bad().
         '''
         if match.always():
             for f in iter(self):
                 yield f
             return
 
         fset = set(match.files())
 
         for fn in self._walk(match):
             if fn in fset:
                 # specified pattern is the exact name
                 fset.remove(fn)
             yield fn
 
         # for dirstate.walk, files=[''] means "walk the whole tree".
         # follow that here, too
         fset.discard(b'')
 
         for fn in sorted(fset):
             if not self.hasdir(fn):
                 match.bad(fn, None)
 
     def _walk(self, match):
         '''Recursively generates matching file names for walk().'''
         visit = match.visitchildrenset(self._dir[:-1])
         if not visit:
             return
 
         # yield this dir's files and walk its submanifests
         self._load()
         visit = self._loadchildrensetlazy(visit)
         for p in sorted(list(self._dirs) + list(self._files)):
             if p in self._files:
                 fullp = self._subpath(p)
                 if match(fullp):
                     yield fullp
             else:
                 if not visit or p[:-1] in visit:
                     for f in self._dirs[p]._walk(match):
                         yield f
 
     def _matches(self, match):
         '''recursively generate a new manifest filtered by the match argument.
         '''
         if match.always():
             return self.copy()
         return self._matches_inner(match)
 
     def _matches_inner(self, match):
         if match.always():
             return self.copy()
 
         visit = match.visitchildrenset(self._dir[:-1])
         if visit == b'all':
             return self.copy()
         ret = treemanifest(self._dir)
         if not visit:
             return ret
 
         self._load()
         for fn in self._files:
             # While visitchildrenset *usually* lists only subdirs, this is
             # actually up to the matcher and may have some files in the set().
             # If visit == 'this', we should obviously look at the files in this
             # directory; if visit is a set, and fn is in it, we should inspect
             # fn (but no need to inspect things not in the set).
             if visit != b'this' and fn not in visit:
                 continue
             fullp = self._subpath(fn)
             # visitchildrenset isn't perfect, we still need to call the regular
             # matcher code to further filter results.
             if not match(fullp):
                 continue
             ret._files[fn] = self._files[fn]
             if fn in self._flags:
                 ret._flags[fn] = self._flags[fn]
 
         visit = self._loadchildrensetlazy(visit)
         for dir, subm in pycompat.iteritems(self._dirs):
             if visit and dir[:-1] not in visit:
                 continue
             m = subm._matches_inner(match)
             if not m._isempty():
                 ret._dirs[dir] = m
 
         if not ret._isempty():
             ret._dirty = True
         return ret
 
     def fastdelta(self, base, changes):
         raise FastdeltaUnavailable()
 
     def diff(self, m2, match=None, clean=False):
         '''Finds changes between the current manifest and m2.
 
         Args:
           m2: the manifest to which this manifest should be compared.
           clean: if true, include files unchanged between these manifests
                  with a None value in the returned dictionary.
 
         The result is returned as a dict with filename as key and
         values of the form ((n1,fl1),(n2,fl2)), where n1/n2 is the
         nodeid in the current/other manifest and fl1/fl2 is the flag
         in the current/other manifest. Where the file does not exist,
         the nodeid will be None and the flags will be the empty
         string.
         '''
         if match and not match.always():
             m1 = self._matches(match)
             m2 = m2._matches(match)
             return m1.diff(m2, clean=clean)
         result = {}
         emptytree = treemanifest()
 
         def _iterativediff(t1, t2, stack):
             """compares two tree manifests and append new tree-manifests which
             needs to be compared to stack"""
             if t1._node == t2._node and not t1._dirty and not t2._dirty:
                 return
             t1._load()
             t2._load()
             self._loaddifflazy(t1, t2)
 
             for d, m1 in pycompat.iteritems(t1._dirs):
                 m2 = t2._dirs.get(d, emptytree)
                 stack.append((m1, m2))
 
             for d, m2 in pycompat.iteritems(t2._dirs):
                 if d not in t1._dirs:
                     stack.append((emptytree, m2))
 
             for fn, n1 in pycompat.iteritems(t1._files):
                 fl1 = t1._flags.get(fn, b'')
                 n2 = t2._files.get(fn, None)
                 fl2 = t2._flags.get(fn, b'')
                 if n1 != n2 or fl1 != fl2:
                     result[t1._subpath(fn)] = ((n1, fl1), (n2, fl2))
                 elif clean:
                     result[t1._subpath(fn)] = None
 
             for fn, n2 in pycompat.iteritems(t2._files):
                 if fn not in t1._files:
                     fl2 = t2._flags.get(fn, b'')
                     result[t2._subpath(fn)] = ((None, b''), (n2, fl2))
 
         stackls = []
         _iterativediff(self, m2, stackls)
         while stackls:
             t1, t2 = stackls.pop()
             # stackls is populated in the function call
             _iterativediff(t1, t2, stackls)
         return result
 
     def unmodifiedsince(self, m2):
         return not self._dirty and not m2._dirty and self._node == m2._node
 
     def parse(self, text, readsubtree):
         selflazy = self._lazydirs
         subpath = self._subpath
         for f, n, fl in _parse(text):
             if fl == b't':
                 f = f + b'/'
                 # False below means "doesn't need to be copied" and can use the
                 # cached value from readsubtree directly.
                 selflazy[f] = (subpath(f), n, readsubtree, False)
             elif b'/' in f:
                 # This is a flat manifest, so use __setitem__ and setflag rather
                 # than assigning directly to _files and _flags, so we can
                 # assign a path in a subdirectory, and to mark dirty (compared
                 # to nullid).
                 self[f] = n
                 if fl:
                     self.setflag(f, fl)
             else:
                 # Assigning to _files and _flags avoids marking as dirty,
                 # and should be a little faster.
                 self._files[f] = n
                 if fl:
                     self._flags[f] = fl
 
     def text(self):
         """Get the full data of this manifest as a bytestring."""
         self._load()
         return _text(self.iterentries())
 
     def dirtext(self):
         """Get the full data of this directory as a bytestring. Make sure that
         any submanifests have been written first, so their nodeids are correct.
         """
         self._load()
         flags = self.flags
         lazydirs = [
             (d[:-1], v[1], b't') for d, v in pycompat.iteritems(self._lazydirs)
         ]
         dirs = [(d[:-1], self._dirs[d]._node, b't') for d in self._dirs]
         files = [(f, self._files[f], flags(f)) for f in self._files]
         return _text(sorted(dirs + files + lazydirs))
 
     def read(self, gettext, readsubtree):
         def _load_for_read(s):
             s.parse(gettext(), readsubtree)
             s._dirty = False
 
         self._loadfunc = _load_for_read
 
     def writesubtrees(self, m1, m2, writesubtree, match):
         self._load()  # for consistency; should never have any effect here
         m1._load()
         m2._load()
         emptytree = treemanifest()
 
         def getnode(m, d):
             ld = m._lazydirs.get(d)
             if ld:
                 return ld[1]
             return m._dirs.get(d, emptytree)._node
 
         # let's skip investigating things that `match` says we do not need.
         visit = match.visitchildrenset(self._dir[:-1])
         visit = self._loadchildrensetlazy(visit)
         if visit == b'this' or visit == b'all':
             visit = None
         for d, subm in pycompat.iteritems(self._dirs):
             if visit and d[:-1] not in visit:
                 continue
             subp1 = getnode(m1, d)
             subp2 = getnode(m2, d)
             if subp1 == nullid:
                 subp1, subp2 = subp2, subp1
             writesubtree(subm, subp1, subp2, match)
 
     def walksubtrees(self, matcher=None):
         """Returns an iterator of the subtrees of this manifest, including this
         manifest itself.
 
         If `matcher` is provided, it only returns subtrees that match.
         """
         if matcher and not matcher.visitdir(self._dir[:-1]):
             return
         if not matcher or matcher(self._dir[:-1]):
             yield self
 
         self._load()
         # OPT: use visitchildrenset to avoid loading everything.
         self._loadalllazy()
         for d, subm in pycompat.iteritems(self._dirs):
             for subtree in subm.walksubtrees(matcher=matcher):
                 yield subtree
 
 
 class manifestfulltextcache(util.lrucachedict):
     """File-backed LRU cache for the manifest cache
 
     File consists of entries, up to EOF:
 
     - 20 bytes node, 4 bytes length, <length> manifest data
 
     These are written in reverse cache order (oldest to newest).
 
     """
 
     _file = b'manifestfulltextcache'
 
     def __init__(self, max):
         super(manifestfulltextcache, self).__init__(max)
         self._dirty = False
         self._read = False
         self._opener = None
 
     def read(self):
         if self._read or self._opener is None:
             return
 
         try:
             with self._opener(self._file) as fp:
                 set = super(manifestfulltextcache, self).__setitem__
                 # ignore trailing data, this is a cache, corruption is skipped
                 while True:
                     # TODO do we need to do work here for sha1 portability?
                     node = fp.read(20)
                     if len(node) < 20:
                         break
                     try:
                         size = struct.unpack(b'>L', fp.read(4))[0]
                     except struct.error:
                         break
                     value = bytearray(fp.read(size))
                     if len(value) != size:
                         break
                     set(node, value)
         except IOError:
             # the file is allowed to be missing
             pass
 
         self._read = True
         self._dirty = False
 
     def write(self):
         if not self._dirty or self._opener is None:
             return
         # rotate backwards to the first used node
         with self._opener(
             self._file, b'w', atomictemp=True, checkambig=True
         ) as fp:
             node = self._head.prev
             while True:
                 if node.key in self._cache:
                     fp.write(node.key)
                     fp.write(struct.pack(b'>L', len(node.value)))
                     fp.write(node.value)
                 if node is self._head:
                     break
                 node = node.prev
 
     def __len__(self):
         if not self._read:
             self.read()
         return super(manifestfulltextcache, self).__len__()
 
     def __contains__(self, k):
         if not self._read:
             self.read()
         return super(manifestfulltextcache, self).__contains__(k)
 
     def __iter__(self):
         if not self._read:
             self.read()
         return super(manifestfulltextcache, self).__iter__()
 
     def __getitem__(self, k):
         if not self._read:
             self.read()
         # the cache lru order can change on read
         setdirty = self._cache.get(k) is not self._head
         value = super(manifestfulltextcache, self).__getitem__(k)
         if setdirty:
             self._dirty = True
         return value
 
     def __setitem__(self, k, v):
         if not self._read:
             self.read()
         super(manifestfulltextcache, self).__setitem__(k, v)
         self._dirty = True
 
     def __delitem__(self, k):
         if not self._read:
             self.read()
         super(manifestfulltextcache, self).__delitem__(k)
         self._dirty = True
 
     def get(self, k, default=None):
         if not self._read:
             self.read()
         return super(manifestfulltextcache, self).get(k, default=default)
 
     def clear(self, clear_persisted_data=False):
         super(manifestfulltextcache, self).clear()
         if clear_persisted_data:
             self._dirty = True
             self.write()
         self._read = False
 
 
 # and upper bound of what we expect from compression
 # (real live value seems to be "3")
 MAXCOMPRESSION = 3
 
 
 class FastdeltaUnavailable(Exception):
     """Exception raised when fastdelta isn't usable on a manifest."""
 
 
 @interfaceutil.implementer(repository.imanifeststorage)
 class manifestrevlog(object):
     '''A revlog that stores manifest texts. This is responsible for caching the
     full-text manifest contents.
     '''
 
     def __init__(
         self,
         opener,
         tree=b'',
         dirlogcache=None,
         indexfile=None,
         treemanifest=False,
     ):
         """Constructs a new manifest revlog
 
         `indexfile` - used by extensions to have two manifests at once, like
         when transitioning between flatmanifeset and treemanifests.
 
         `treemanifest` - used to indicate this is a tree manifest revlog. Opener
         options can also be used to make this a tree manifest revlog. The opener
         option takes precedence, so if it is set to True, we ignore whatever
         value is passed in to the constructor.
         """
         # During normal operations, we expect to deal with not more than four
         # revs at a time (such as during commit --amend). When rebasing large
         # stacks of commits, the number can go up, hence the config knob below.
         cachesize = 4
         optiontreemanifest = False
         opts = getattr(opener, 'options', None)
         if opts is not None:
             cachesize = opts.get(b'manifestcachesize', cachesize)
             optiontreemanifest = opts.get(b'treemanifest', False)
 
         self._treeondisk = optiontreemanifest or treemanifest
 
         self._fulltextcache = manifestfulltextcache(cachesize)
 
         if tree:
             assert self._treeondisk, b'opts is %r' % opts
 
         if indexfile is None:
             indexfile = b'00manifest.i'
             if tree:
                 indexfile = b"meta/" + tree + indexfile
 
         self.tree = tree
 
         # The dirlogcache is kept on the root manifest log
         if tree:
             self._dirlogcache = dirlogcache
         else:
             self._dirlogcache = {b'': self}
 
         self._revlog = revlog.revlog(
             opener,
             indexfile,
             # only root indexfile is cached
             checkambig=not bool(tree),
             mmaplargeindex=True,
             upperboundcomp=MAXCOMPRESSION,
-            persistentnodemap=opener.options.get(
-                b'exp-persistent-nodemap', False
-            ),
+            persistentnodemap=opener.options.get(b'persistent-nodemap', False),
         )
 
         self.index = self._revlog.index
         self.version = self._revlog.version
         self._generaldelta = self._revlog._generaldelta
 
     def _setupmanifestcachehooks(self, repo):
         """Persist the manifestfulltextcache on lock release"""
         if not util.safehasattr(repo, b'_wlockref'):
             return
 
         self._fulltextcache._opener = repo.wcachevfs
         if repo._currentlock(repo._wlockref) is None:
             return
 
         reporef = weakref.ref(repo)
         manifestrevlogref = weakref.ref(self)
 
         def persistmanifestcache(success):
             # Repo is in an unknown state, do not persist.
             if not success:
                 return
 
             repo = reporef()
             self = manifestrevlogref()
             if repo is None or self is None:
                 return
             if repo.manifestlog.getstorage(b'') is not self:
                 # there's a different manifest in play now, abort
                 return
             self._fulltextcache.write()
 
         repo._afterlock(persistmanifestcache)
 
     @property
     def fulltextcache(self):
         return self._fulltextcache
 
     def clearcaches(self, clear_persisted_data=False):
         self._revlog.clearcaches()
         self._fulltextcache.clear(clear_persisted_data=clear_persisted_data)
         self._dirlogcache = {self.tree: self}
 
     def dirlog(self, d):
         if d:
             assert self._treeondisk
         if d not in self._dirlogcache:
             mfrevlog = manifestrevlog(
                 self.opener, d, self._dirlogcache, treemanifest=self._treeondisk
             )
             self._dirlogcache[d] = mfrevlog
         return self._dirlogcache[d]
 
     def add(
         self,
         m,
         transaction,
         link,
         p1,
         p2,
         added,
         removed,
         readtree=None,
         match=None,
     ):
         try:
             if p1 not in self.fulltextcache:
                 raise FastdeltaUnavailable()
             # If our first parent is in the manifest cache, we can
             # compute a delta here using properties we know about the
             # manifest up-front, which may save time later for the
             # revlog layer.
 
             _checkforbidden(added)
             # combine the changed lists into one sorted iterator
             work = heapq.merge(
                 [(x, False) for x in sorted(added)],
                 [(x, True) for x in sorted(removed)],
             )
 
             arraytext, deltatext = m.fastdelta(self.fulltextcache[p1], work)
             cachedelta = self._revlog.rev(p1), deltatext
             text = util.buffer(arraytext)
             n = self._revlog.addrevision(
                 text, transaction, link, p1, p2, cachedelta
             )
         except FastdeltaUnavailable:
             # The first parent manifest isn't already loaded or the
             # manifest implementation doesn't support fastdelta, so
             # we'll just encode a fulltext of the manifest and pass
             # that through to the revlog layer, and let it handle the
             # delta process.
             if self._treeondisk:
                 assert readtree, b"readtree must be set for treemanifest writes"
                 assert match, b"match must be specified for treemanifest writes"
                 m1 = readtree(self.tree, p1)
                 m2 = readtree(self.tree, p2)
                 n = self._addtree(
                     m, transaction, link, m1, m2, readtree, match=match
                 )
                 arraytext = None
             else:
                 text = m.text()
                 n = self._revlog.addrevision(text, transaction, link, p1, p2)
                 arraytext = bytearray(text)
 
         if arraytext is not None:
             self.fulltextcache[n] = arraytext
 
         return n
 
     def _addtree(self, m, transaction, link, m1, m2, readtree, match):
         # If the manifest is unchanged compared to one parent,
         # don't write a new revision
         if self.tree != b'' and (
             m.unmodifiedsince(m1) or m.unmodifiedsince(m2)
         ):
             return m.node()
 
         def writesubtree(subm, subp1, subp2, match):
             sublog = self.dirlog(subm.dir())
             sublog.add(
                 subm,
                 transaction,
                 link,
                 subp1,
                 subp2,
                 None,
                 None,
                 readtree=readtree,
                 match=match,
             )
 
         m.writesubtrees(m1, m2, writesubtree, match)
         text = m.dirtext()
         n = None
         if self.tree != b'':
             # Double-check whether contents are unchanged to one parent
             if text == m1.dirtext():
                 n = m1.node()
             elif text == m2.dirtext():
                 n = m2.node()
 
         if not n:
             n = self._revlog.addrevision(
                 text, transaction, link, m1.node(), m2.node()
             )
 
         # Save nodeid so parent manifest can calculate its nodeid
         m.setnode(n)
         return n
 
     def __len__(self):
         return len(self._revlog)
 
     def __iter__(self):
         return self._revlog.__iter__()
 
     def rev(self, node):
         return self._revlog.rev(node)
 
     def node(self, rev):
         return self._revlog.node(rev)
 
     def lookup(self, value):
         return self._revlog.lookup(value)
 
     def parentrevs(self, rev):
         return self._revlog.parentrevs(rev)
 
     def parents(self, node):
         return self._revlog.parents(node)
 
     def linkrev(self, rev):
         return self._revlog.linkrev(rev)
 
     def checksize(self):
         return self._revlog.checksize()
 
     def revision(self, node, _df=None, raw=False):
         return self._revlog.revision(node, _df=_df, raw=raw)
 
     def rawdata(self, node, _df=None):
         return self._revlog.rawdata(node, _df=_df)
 
     def revdiff(self, rev1, rev2):
         return self._revlog.revdiff(rev1, rev2)
 
     def cmp(self, node, text):
         return self._revlog.cmp(node, text)
 
     def deltaparent(self, rev):
         return self._revlog.deltaparent(rev)
 
     def emitrevisions(
         self,
         nodes,
         nodesorder=None,
         revisiondata=False,
         assumehaveparentrevisions=False,
         deltamode=repository.CG_DELTAMODE_STD,
     ):
         return self._revlog.emitrevisions(
             nodes,
             nodesorder=nodesorder,
             revisiondata=revisiondata,
             assumehaveparentrevisions=assumehaveparentrevisions,
             deltamode=deltamode,
         )
 
     def addgroup(self, deltas, linkmapper, transaction, addrevisioncb=None):
         return self._revlog.addgroup(
             deltas, linkmapper, transaction, addrevisioncb=addrevisioncb
         )
 
     def rawsize(self, rev):
         return self._revlog.rawsize(rev)
 
     def getstrippoint(self, minlink):
         return self._revlog.getstrippoint(minlink)
 
     def strip(self, minlink, transaction):
         return self._revlog.strip(minlink, transaction)
 
     def files(self):
         return self._revlog.files()
 
     def clone(self, tr, destrevlog, **kwargs):
         if not isinstance(destrevlog, manifestrevlog):
             raise error.ProgrammingError(b'expected manifestrevlog to clone()')
 
         return self._revlog.clone(tr, destrevlog._revlog, **kwargs)
 
     def storageinfo(
         self,
         exclusivefiles=False,
         sharedfiles=False,
         revisionscount=False,
         trackedsize=False,
         storedsize=False,
     ):
         return self._revlog.storageinfo(
             exclusivefiles=exclusivefiles,
             sharedfiles=sharedfiles,
             revisionscount=revisionscount,
             trackedsize=trackedsize,
             storedsize=storedsize,
         )
 
     @property
     def indexfile(self):
         return self._revlog.indexfile
 
     @indexfile.setter
     def indexfile(self, value):
         self._revlog.indexfile = value
 
     @property
     def opener(self):
         return self._revlog.opener
 
     @opener.setter
     def opener(self, value):
         self._revlog.opener = value
 
 
 @interfaceutil.implementer(repository.imanifestlog)
 class manifestlog(object):
     """A collection class representing the collection of manifest snapshots
     referenced by commits in the repository.
 
     In this situation, 'manifest' refers to the abstract concept of a snapshot
     of the list of files in the given commit. Consumers of the output of this
     class do not care about the implementation details of the actual manifests
     they receive (i.e. tree or flat or lazily loaded, etc)."""
 
     def __init__(self, opener, repo, rootstore, narrowmatch):
         usetreemanifest = False
         cachesize = 4
 
         opts = getattr(opener, 'options', None)
         if opts is not None:
             usetreemanifest = opts.get(b'treemanifest', usetreemanifest)
             cachesize = opts.get(b'manifestcachesize', cachesize)
 
         self._treemanifests = usetreemanifest
 
         self._rootstore = rootstore
         self._rootstore._setupmanifestcachehooks(repo)
         self._narrowmatch = narrowmatch
 
         # A cache of the manifestctx or treemanifestctx for each directory
         self._dirmancache = {}
         self._dirmancache[b''] = util.lrucachedict(cachesize)
 
         self._cachesize = cachesize
 
     def __getitem__(self, node):
         """Retrieves the manifest instance for the given node. Throws a
         LookupError if not found.
         """
         return self.get(b'', node)
 
     def get(self, tree, node, verify=True):
         """Retrieves the manifest instance for the given node. Throws a
         LookupError if not found.
 
         `verify` - if True an exception will be thrown if the node is not in
                    the revlog
         """
         if node in self._dirmancache.get(tree, ()):
             return self._dirmancache[tree][node]
 
         if not self._narrowmatch.always():
             if not self._narrowmatch.visitdir(tree[:-1]):
                 return excludeddirmanifestctx(tree, node)
         if tree:
             if self._rootstore._treeondisk:
                 if verify:
                     # Side-effect is LookupError is raised if node doesn't
                     # exist.
                     self.getstorage(tree).rev(node)
 
                 m = treemanifestctx(self, tree, node)
             else:
                 raise error.Abort(
                     _(
                         b"cannot ask for manifest directory '%s' in a flat "
                         b"manifest"
                     )
                     % tree
                 )
         else:
             if verify:
                 # Side-effect is LookupError is raised if node doesn't exist.
                 self._rootstore.rev(node)
 
             if self._treemanifests:
                 m = treemanifestctx(self, b'', node)
             else:
                 m = manifestctx(self, node)
 
         if node != nullid:
             mancache = self._dirmancache.get(tree)
             if not mancache:
                 mancache = util.lrucachedict(self._cachesize)
                 self._dirmancache[tree] = mancache
             mancache[node] = m
         return m
 
     def getstorage(self, tree):
         return self._rootstore.dirlog(tree)
 
     def clearcaches(self, clear_persisted_data=False):
         self._dirmancache.clear()
         self._rootstore.clearcaches(clear_persisted_data=clear_persisted_data)
 
     def rev(self, node):
         return self._rootstore.rev(node)
 
     def update_caches(self, transaction):
         return self._rootstore._revlog.update_caches(transaction=transaction)
 
 
 @interfaceutil.implementer(repository.imanifestrevisionwritable)
 class memmanifestctx(object):
     def __init__(self, manifestlog):
         self._manifestlog = manifestlog
         self._manifestdict = manifestdict()
 
     def _storage(self):
         return self._manifestlog.getstorage(b'')
 
     def copy(self):
         memmf = memmanifestctx(self._manifestlog)
         memmf._manifestdict = self.read().copy()
         return memmf
 
     def read(self):
         return self._manifestdict
 
     def write(self, transaction, link, p1, p2, added, removed, match=None):
         return self._storage().add(
             self._manifestdict,
             transaction,
             link,
             p1,
             p2,
             added,
             removed,
             match=match,
         )
 
 
 @interfaceutil.implementer(repository.imanifestrevisionstored)
 class manifestctx(object):
     """A class representing a single revision of a manifest, including its
     contents, its parent revs, and its linkrev.
     """
 
     def __init__(self, manifestlog, node):
         self._manifestlog = manifestlog
         self._data = None
 
         self._node = node
 
         # TODO: We eventually want p1, p2, and linkrev exposed on this class,
         # but let's add it later when something needs it and we can load it
         # lazily.
         # self.p1, self.p2 = store.parents(node)
         # rev = store.rev(node)
         # self.linkrev = store.linkrev(rev)
 
     def _storage(self):
         return self._manifestlog.getstorage(b'')
 
     def node(self):
         return self._node
 
     def copy(self):
         memmf = memmanifestctx(self._manifestlog)
         memmf._manifestdict = self.read().copy()
         return memmf
 
     @propertycache
     def parents(self):
         return self._storage().parents(self._node)
 
     def read(self):
         if self._data is None:
             if self._node == nullid:
                 self._data = manifestdict()
             else:
                 store = self._storage()
                 if self._node in store.fulltextcache:
                     text = pycompat.bytestr(store.fulltextcache[self._node])
                 else:
                     text = store.revision(self._node)
                     arraytext = bytearray(text)
                     store.fulltextcache[self._node] = arraytext
                 self._data = manifestdict(text)
         return self._data
 
     def readfast(self, shallow=False):
         '''Calls either readdelta or read, based on which would be less work.
         readdelta is called if the delta is against the p1, and therefore can be
         read quickly.
 
         If `shallow` is True, nothing changes since this is a flat manifest.
         '''
         store = self._storage()
         r = store.rev(self._node)
         deltaparent = store.deltaparent(r)
         if deltaparent != nullrev and deltaparent in store.parentrevs(r):
             return self.readdelta()
         return self.read()
 
     def readdelta(self, shallow=False):
         '''Returns a manifest containing just the entries that are present
         in this manifest, but not in its p1 manifest. This is efficient to read
         if the revlog delta is already p1.
 
         Changing the value of `shallow` has no effect on flat manifests.
         '''
         store = self._storage()
         r = store.rev(self._node)
         d = mdiff.patchtext(store.revdiff(store.deltaparent(r), r))
         return manifestdict(d)
 
     def find(self, key):
         return self.read().find(key)
 
 
 @interfaceutil.implementer(repository.imanifestrevisionwritable)
 class memtreemanifestctx(object):
     def __init__(self, manifestlog, dir=b''):
         self._manifestlog = manifestlog
         self._dir = dir
         self._treemanifest = treemanifest()
 
     def _storage(self):
         return self._manifestlog.getstorage(b'')
 
     def copy(self):
         memmf = memtreemanifestctx(self._manifestlog, dir=self._dir)
         memmf._treemanifest = self._treemanifest.copy()
         return memmf
 
     def read(self):
         return self._treemanifest
 
     def write(self, transaction, link, p1, p2, added, removed, match=None):
         def readtree(dir, node):
             return self._manifestlog.get(dir, node).read()
 
         return self._storage().add(
             self._treemanifest,
             transaction,
             link,
             p1,
             p2,
             added,
             removed,
             readtree=readtree,
             match=match,
         )
 
 
 @interfaceutil.implementer(repository.imanifestrevisionstored)
 class treemanifestctx(object):
     def __init__(self, manifestlog, dir, node):
         self._manifestlog = manifestlog
         self._dir = dir
         self._data = None
 
         self._node = node
 
         # TODO: Load p1/p2/linkrev lazily. They need to be lazily loaded so that
         # we can instantiate treemanifestctx objects for directories we don't
         # have on disk.
         # self.p1, self.p2 = store.parents(node)
         # rev = store.rev(node)
         # self.linkrev = store.linkrev(rev)
 
     def _storage(self):
         narrowmatch = self._manifestlog._narrowmatch
         if not narrowmatch.always():
             if not narrowmatch.visitdir(self._dir[:-1]):
                 return excludedmanifestrevlog(self._dir)
         return self._manifestlog.getstorage(self._dir)
 
     def read(self):
         if self._data is None:
             store = self._storage()
             if self._node == nullid:
                 self._data = treemanifest()
             # TODO accessing non-public API
             elif store._treeondisk:
                 m = treemanifest(dir=self._dir)
 
                 def gettext():
                     return store.revision(self._node)
 
                 def readsubtree(dir, subm):
                     # Set verify to False since we need to be able to create
                     # subtrees for trees that don't exist on disk.
                     return self._manifestlog.get(dir, subm, verify=False).read()
 
                 m.read(gettext, readsubtree)
                 m.setnode(self._node)
                 self._data = m
             else:
                 if self._node in store.fulltextcache:
                     text = pycompat.bytestr(store.fulltextcache[self._node])
                 else:
                     text = store.revision(self._node)
                     arraytext = bytearray(text)
                     store.fulltextcache[self._node] = arraytext
                 self._data = treemanifest(dir=self._dir, text=text)
 
         return self._data
 
     def node(self):
         return self._node
 
     def copy(self):
         memmf = memtreemanifestctx(self._manifestlog, dir=self._dir)
         memmf._treemanifest = self.read().copy()
         return memmf
 
     @propertycache
     def parents(self):
         return self._storage().parents(self._node)
 
     def readdelta(self, shallow=False):
         '''Returns a manifest containing just the entries that are present
         in this manifest, but not in its p1 manifest. This is efficient to read
         if the revlog delta is already p1.
 
         If `shallow` is True, this will read the delta for this directory,
         without recursively reading subdirectory manifests. Instead, any
         subdirectory entry will be reported as it appears in the manifest, i.e.
         the subdirectory will be reported among files and distinguished only by
         its 't' flag.
         '''
         store = self._storage()
         if shallow:
             r = store.rev(self._node)
             d = mdiff.patchtext(store.revdiff(store.deltaparent(r), r))
             return manifestdict(d)
         else:
             # Need to perform a slow delta
             r0 = store.deltaparent(store.rev(self._node))
             m0 = self._manifestlog.get(self._dir, store.node(r0)).read()
             m1 = self.read()
             md = treemanifest(dir=self._dir)
             for f, ((n0, fl0), (n1, fl1)) in pycompat.iteritems(m0.diff(m1)):
                 if n1:
                     md[f] = n1
                     if fl1:
                         md.setflag(f, fl1)
             return md
 
     def readfast(self, shallow=False):
         '''Calls either readdelta or read, based on which would be less work.
         readdelta is called if the delta is against the p1, and therefore can be
         read quickly.
 
         If `shallow` is True, it only returns the entries from this manifest,
         and not any submanifests.
         '''
         store = self._storage()
         r = store.rev(self._node)
         deltaparent = store.deltaparent(r)
         if deltaparent != nullrev and deltaparent in store.parentrevs(r):
             return self.readdelta(shallow=shallow)
 
         if shallow:
             return manifestdict(store.revision(self._node))
         else:
             return self.read()
 
     def find(self, key):
         return self.read().find(key)
 
 
 class excludeddir(treemanifest):
     """Stand-in for a directory that is excluded from the repository.
 
     With narrowing active on a repository that uses treemanifests,
     some of the directory revlogs will be excluded from the resulting
     clone. This is a huge storage win for clients, but means we need
     some sort of pseudo-manifest to surface to internals so we can
     detect a merge conflict outside the narrowspec. That's what this
     class is: it stands in for a directory whose node is known, but
     whose contents are unknown.
     """
 
     def __init__(self, dir, node):
         super(excludeddir, self).__init__(dir)
         self._node = node
         # Add an empty file, which will be included by iterators and such,
         # appearing as the directory itself (i.e. something like "dir/")
         self._files[b''] = node
         self._flags[b''] = b't'
 
     # Manifests outside the narrowspec should never be modified, so avoid
     # copying. This makes a noticeable difference when there are very many
     # directories outside the narrowspec. Also, it makes sense for the copy to
     # be of the same type as the original, which would not happen with the
     # super type's copy().
     def copy(self):
         return self
 
 
 class excludeddirmanifestctx(treemanifestctx):
     """context wrapper for excludeddir - see that docstring for rationale"""
 
     def __init__(self, dir, node):
         self._dir = dir
         self._node = node
 
     def read(self):
         return excludeddir(self._dir, self._node)
 
     def write(self, *args):
         raise error.ProgrammingError(
             b'attempt to write manifest from excluded dir %s' % self._dir
         )
 
 
 class excludedmanifestrevlog(manifestrevlog):
     """Stand-in for excluded treemanifest revlogs.
 
     When narrowing is active on a treemanifest repository, we'll have
     references to directories we can't see due to the revlog being
     skipped. This class exists to conform to the manifestrevlog
     interface for those directories and proactively prevent writes to
     outside the narrowspec.
     """
 
     def __init__(self, dir):
         self._dir = dir
 
     def __len__(self):
         raise error.ProgrammingError(
             b'attempt to get length of excluded dir %s' % self._dir
         )
 
     def rev(self, node):
         raise error.ProgrammingError(
             b'attempt to get rev from excluded dir %s' % self._dir
         )
 
     def linkrev(self, node):
         raise error.ProgrammingError(
             b'attempt to get linkrev from excluded dir %s' % self._dir
         )
 
     def node(self, rev):
         raise error.ProgrammingError(
             b'attempt to get node from excluded dir %s' % self._dir
         )
 
     def add(self, *args, **kwargs):
         # We should never write entries in dirlogs outside the narrow clone.
         # However, the method still gets called from writesubtree() in
         # _addtree(), so we need to handle it. We should possibly make that
         # avoid calling add() with a clean manifest (_dirty is always False
         # in excludeddir instances).
         pass

mercurial/revlogutils/nodemap.py

@@ -1,644 +1,644 b''
 # nodemap.py - nodemap related code and utilities
 #
 # Copyright 2019 Pierre-Yves David <[e-mail]>
 # Copyright 2019 George Racinet <[e-mail]>
 #
 # 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 errno
 import os
 import re
 import struct
 
 from ..i18n import _
 
 from .. import (
     error,
     node as nodemod,
     util,
 )
 
 
 class NodeMap(dict):
     def __missing__(self, x):
         raise error.RevlogError(b'unknown node: %s' % x)
 
 
 def persisted_data(revlog):
     """read the nodemap for a revlog from disk"""
     if revlog.nodemap_file is None:
         return None
     pdata = revlog.opener.tryread(revlog.nodemap_file)
     if not pdata:
         return None
     offset = 0
     (version,) = S_VERSION.unpack(pdata[offset : offset + S_VERSION.size])
     if version != ONDISK_VERSION:
         return None
     offset += S_VERSION.size
     headers = S_HEADER.unpack(pdata[offset : offset + S_HEADER.size])
     uid_size, tip_rev, data_length, data_unused, tip_node_size = headers
     offset += S_HEADER.size
     docket = NodeMapDocket(pdata[offset : offset + uid_size])
     offset += uid_size
     docket.tip_rev = tip_rev
     docket.tip_node = pdata[offset : offset + tip_node_size]
     docket.data_length = data_length
     docket.data_unused = data_unused
 
     filename = _rawdata_filepath(revlog, docket)
-    use_mmap = revlog.opener.options.get(b"exp-persistent-nodemap.mmap")
+    use_mmap = revlog.opener.options.get(b"persistent-nodemap.mmap")
     try:
         with revlog.opener(filename) as fd:
             if use_mmap:
                 data = util.buffer(util.mmapread(fd, data_length))
             else:
                 data = fd.read(data_length)
     except OSError as e:
         if e.errno != errno.ENOENT:
             raise
     if len(data) < data_length:
         return None
     return docket, data
 
 
 def setup_persistent_nodemap(tr, revlog):
     """Install whatever is needed transaction side to persist a nodemap on disk
 
     (only actually persist the nodemap if this is relevant for this revlog)
     """
     if revlog._inline:
         return  # inlined revlog are too small for this to be relevant
     if revlog.nodemap_file is None:
         return  # we do not use persistent_nodemap on this revlog
 
     # we need to happen after the changelog finalization, in that use "cl-"
     callback_id = b"nm-revlog-persistent-nodemap-%s" % revlog.nodemap_file
     if tr.hasfinalize(callback_id):
         return  # no need to register again
     tr.addpending(
         callback_id, lambda tr: _persist_nodemap(tr, revlog, pending=True)
     )
     tr.addfinalize(callback_id, lambda tr: _persist_nodemap(tr, revlog))
 
 
 class _NoTransaction(object):
     """transaction like object to update the nodemap outside a transaction
     """
 
     def __init__(self):
         self._postclose = {}
 
     def addpostclose(self, callback_id, callback_func):
         self._postclose[callback_id] = callback_func
 
     def registertmp(self, *args, **kwargs):
         pass
 
     def addbackup(self, *args, **kwargs):
         pass
 
     def add(self, *args, **kwargs):
         pass
 
     def addabort(self, *args, **kwargs):
         pass
 
     def _report(self, *args):
         pass
 
 
 def update_persistent_nodemap(revlog):
     """update the persistent nodemap right now
 
     To be used for updating the nodemap on disk outside of a normal transaction
     setup (eg, `debugupdatecache`).
     """
     if revlog._inline:
         return  # inlined revlog are too small for this to be relevant
     if revlog.nodemap_file is None:
         return  # we do not use persistent_nodemap on this revlog
 
     notr = _NoTransaction()
     _persist_nodemap(notr, revlog)
     for k in sorted(notr._postclose):
         notr._postclose[k](None)
 
 
 def _persist_nodemap(tr, revlog, pending=False):
     """Write nodemap data on disk for a given revlog
     """
     if getattr(revlog, 'filteredrevs', ()):
         raise error.ProgrammingError(
             "cannot persist nodemap of a filtered changelog"
         )
     if revlog.nodemap_file is None:
         msg = "calling persist nodemap on a revlog without the feature enableb"
         raise error.ProgrammingError(msg)
 
     can_incremental = util.safehasattr(revlog.index, "nodemap_data_incremental")
     ondisk_docket = revlog._nodemap_docket
     feed_data = util.safehasattr(revlog.index, "update_nodemap_data")
-    use_mmap = revlog.opener.options.get(b"exp-persistent-nodemap.mmap")
-    mode = revlog.opener.options.get(b"exp-persistent-nodemap.mode")
+    use_mmap = revlog.opener.options.get(b"persistent-nodemap.mmap")
+    mode = revlog.opener.options.get(b"persistent-nodemap.mode")
     if not can_incremental:
         msg = _(b"persistent nodemap in strict mode without efficient method")
         if mode == b'warn':
             tr._report(b"%s\n" % msg)
         elif mode == b'strict':
             raise error.Abort(msg)
 
     data = None
     # first attemp an incremental update of the data
     if can_incremental and ondisk_docket is not None:
         target_docket = revlog._nodemap_docket.copy()
         (
             src_docket,
             data_changed_count,
             data,
         ) = revlog.index.nodemap_data_incremental()
         new_length = target_docket.data_length + len(data)
         new_unused = target_docket.data_unused + data_changed_count
         if src_docket != target_docket:
             data = None
         elif new_length <= (new_unused * 10):  # under 10% of unused data
             data = None
         else:
             datafile = _rawdata_filepath(revlog, target_docket)
             # EXP-TODO: if this is a cache, this should use a cache vfs, not a
             # store vfs
             tr.add(datafile, target_docket.data_length)
             with revlog.opener(datafile, b'r+') as fd:
                 fd.seek(target_docket.data_length)
                 fd.write(data)
                 if feed_data:
                     if use_mmap:
                         fd.seek(0)
                         new_data = fd.read(new_length)
                     else:
                         fd.flush()
                         new_data = util.buffer(util.mmapread(fd, new_length))
             target_docket.data_length = new_length
             target_docket.data_unused = new_unused
 
     if data is None:
         # otherwise fallback to a full new export
         target_docket = NodeMapDocket()
         datafile = _rawdata_filepath(revlog, target_docket)
         if util.safehasattr(revlog.index, "nodemap_data_all"):
             data = revlog.index.nodemap_data_all()
         else:
             data = persistent_data(revlog.index)
         # EXP-TODO: if this is a cache, this should use a cache vfs, not a
         # store vfs
 
         tryunlink = revlog.opener.tryunlink
 
         def abortck(tr):
             tryunlink(datafile)
 
         callback_id = b"delete-%s" % datafile
 
         # some flavor of the transaction abort does not cleanup new file, it
         # simply empty them.
         tr.addabort(callback_id, abortck)
         with revlog.opener(datafile, b'w+') as fd:
             fd.write(data)
             if feed_data:
                 if use_mmap:
                     new_data = data
                 else:
                     fd.flush()
                     new_data = util.buffer(util.mmapread(fd, len(data)))
         target_docket.data_length = len(data)
     target_docket.tip_rev = revlog.tiprev()
     target_docket.tip_node = revlog.node(target_docket.tip_rev)
     # EXP-TODO: if this is a cache, this should use a cache vfs, not a
     # store vfs
     file_path = revlog.nodemap_file
     if pending:
         file_path += b'.a'
         tr.registertmp(file_path)
     else:
         tr.addbackup(file_path)
 
     with revlog.opener(file_path, b'w', atomictemp=True) as fp:
         fp.write(target_docket.serialize())
     revlog._nodemap_docket = target_docket
     if feed_data:
         revlog.index.update_nodemap_data(target_docket, new_data)
 
     # search for old index file in all cases, some older process might have
     # left one behind.
     olds = _other_rawdata_filepath(revlog, target_docket)
     if olds:
         realvfs = getattr(revlog, '_realopener', revlog.opener)
 
         def cleanup(tr):
             for oldfile in olds:
                 realvfs.tryunlink(oldfile)
 
         callback_id = b"revlog-cleanup-nodemap-%s" % revlog.nodemap_file
         tr.addpostclose(callback_id, cleanup)
 
 
 ### Nodemap docket file
 #
 # The nodemap data are stored on disk using 2 files:
 #
 # * a raw data files containing a persistent nodemap
 #   (see `Nodemap Trie` section)
 #
 # * a small "docket" file containing medatadata
 #
 # While the nodemap data can be multiple tens of megabytes, the "docket" is
 # small, it is easy to update it automatically or to duplicated its content
 # during a transaction.
 #
 # Multiple raw data can exist at the same time (The currently valid one and a
 # new one beind used by an in progress transaction). To accomodate this, the
 # filename hosting the raw data has a variable parts. The exact filename is
 # specified inside the "docket" file.
 #
 # The docket file contains information to find, qualify and validate the raw
 # data. Its content is currently very light, but it will expand as the on disk
 # nodemap gains the necessary features to be used in production.
 
 ONDISK_VERSION = 1
 S_VERSION = struct.Struct(">B")
 S_HEADER = struct.Struct(">BQQQQ")
 
 ID_SIZE = 8
 
 
 def _make_uid():
     """return a new unique identifier.
 
     The identifier is random and composed of ascii characters."""
     return nodemod.hex(os.urandom(ID_SIZE))
 
 
 class NodeMapDocket(object):
     """metadata associated with persistent nodemap data
 
     The persistent data may come from disk or be on their way to disk.
     """
 
     def __init__(self, uid=None):
         if uid is None:
             uid = _make_uid()
         # a unique identifier for the data file:
         #   - When new data are appended, it is preserved.
         #   - When a new data file is created, a new identifier is generated.
         self.uid = uid
         # the tipmost revision stored in the data file. This revision and all
         # revision before it are expected to be encoded in the data file.
         self.tip_rev = None
         # the node of that tipmost revision, if it mismatch the current index
         # data the docket is not valid for the current index and should be
         # discarded.
         #
         # note: this method is not perfect as some destructive operation could
         # preserve the same tip_rev + tip_node while altering lower revision.
         # However this multiple other caches have the same vulnerability (eg:
         # brancmap cache).
         self.tip_node = None
         # the size (in bytes) of the persisted data to encode the nodemap valid
         # for `tip_rev`.
         #   - data file shorter than this are corrupted,
         #   - any extra data should be ignored.
         self.data_length = None
         # the amount (in bytes) of "dead" data, still in the data file but no
         # longer used for the nodemap.
         self.data_unused = 0
 
     def copy(self):
         new = NodeMapDocket(uid=self.uid)
         new.tip_rev = self.tip_rev
         new.tip_node = self.tip_node
         new.data_length = self.data_length
         new.data_unused = self.data_unused
         return new
 
     def __cmp__(self, other):
         if self.uid < other.uid:
             return -1
         if self.uid > other.uid:
             return 1
         elif self.data_length < other.data_length:
             return -1
         elif self.data_length > other.data_length:
             return 1
         return 0
 
     def __eq__(self, other):
         return self.uid == other.uid and self.data_length == other.data_length
 
     def serialize(self):
         """return serialized bytes for a docket using the passed uid"""
         data = []
         data.append(S_VERSION.pack(ONDISK_VERSION))
         headers = (
             len(self.uid),
             self.tip_rev,
             self.data_length,
             self.data_unused,
             len(self.tip_node),
         )
         data.append(S_HEADER.pack(*headers))
         data.append(self.uid)
         data.append(self.tip_node)
         return b''.join(data)
 
 
 def _rawdata_filepath(revlog, docket):
     """The (vfs relative) nodemap's rawdata file for a given uid"""
     if revlog.nodemap_file.endswith(b'.n.a'):
         prefix = revlog.nodemap_file[:-4]
     else:
         prefix = revlog.nodemap_file[:-2]
     return b"%s-%s.nd" % (prefix, docket.uid)
 
 
 def _other_rawdata_filepath(revlog, docket):
     prefix = revlog.nodemap_file[:-2]
     pattern = re.compile(br"(^|/)%s-[0-9a-f]+\.nd$" % prefix)
     new_file_path = _rawdata_filepath(revlog, docket)
     new_file_name = revlog.opener.basename(new_file_path)
     dirpath = revlog.opener.dirname(new_file_path)
     others = []
     for f in revlog.opener.listdir(dirpath):
         if pattern.match(f) and f != new_file_name:
             others.append(f)
     return others
 
 
 ### Nodemap Trie
 #
 # This is a simple reference implementation to compute and persist a nodemap
 # trie. This reference implementation is write only. The python version of this
 # is not expected to be actually used, since it wont provide performance
 # improvement over existing non-persistent C implementation.
 #
 # The nodemap is persisted as Trie using 4bits-address/16-entries block. each
 # revision can be adressed using its node shortest prefix.
 #
 # The trie is stored as a sequence of block. Each block contains 16 entries
 # (signed 64bit integer, big endian). Each entry can be one of the following:
 #
 #  * value >=  0 -> index of sub-block
 #  * value == -1 -> no value
 #  * value <  -1 -> a revision value: rev = -(value+10)
 #
 # The implementation focus on simplicity, not on performance. A Rust
 # implementation should provide a efficient version of the same binary
 # persistence. This reference python implementation is never meant to be
 # extensively use in production.
 
 
 def persistent_data(index):
     """return the persistent binary form for a nodemap for a given index
     """
     trie = _build_trie(index)
     return _persist_trie(trie)
 
 
 def update_persistent_data(index, root, max_idx, last_rev):
     """return the incremental update for persistent nodemap from a given index
     """
     changed_block, trie = _update_trie(index, root, last_rev)
     return (
         changed_block * S_BLOCK.size,
         _persist_trie(trie, existing_idx=max_idx),
     )
 
 
 S_BLOCK = struct.Struct(">" + ("l" * 16))
 
 NO_ENTRY = -1
 # rev 0 need to be -2 because 0 is used by block, -1 is a special value.
 REV_OFFSET = 2
 
 
 def _transform_rev(rev):
     """Return the number used to represent the rev in the tree.
 
     (or retrieve a rev number from such representation)
 
     Note that this is an involution, a function equal to its inverse (i.e.
     which gives the identity when applied to itself).
     """
     return -(rev + REV_OFFSET)
 
 
 def _to_int(hex_digit):
     """turn an hexadecimal digit into a proper integer"""
     return int(hex_digit, 16)
 
 
 class Block(dict):
     """represent a block of the Trie
 
     contains up to 16 entry indexed from 0 to 15"""
 
     def __init__(self):
         super(Block, self).__init__()
         # If this block exist on disk, here is its ID
         self.ondisk_id = None
 
     def __iter__(self):
         return iter(self.get(i) for i in range(16))
 
 
 def _build_trie(index):
     """build a nodemap trie
 
     The nodemap stores revision number for each unique prefix.
 
     Each block is a dictionary with keys in `[0, 15]`. Values are either
     another block or a revision number.
     """
     root = Block()
     for rev in range(len(index)):
         hex = nodemod.hex(index[rev][7])
         _insert_into_block(index, 0, root, rev, hex)
     return root
 
 
 def _update_trie(index, root, last_rev):
     """consume"""
     changed = 0
     for rev in range(last_rev + 1, len(index)):
         hex = nodemod.hex(index[rev][7])
         changed += _insert_into_block(index, 0, root, rev, hex)
     return changed, root
 
 
 def _insert_into_block(index, level, block, current_rev, current_hex):
     """insert a new revision in a block
 
     index: the index we are adding revision for
     level: the depth of the current block in the trie
     block: the block currently being considered
     current_rev: the revision number we are adding
     current_hex: the hexadecimal representation of the of that revision
     """
     changed = 1
     if block.ondisk_id is not None:
         block.ondisk_id = None
     hex_digit = _to_int(current_hex[level : level + 1])
     entry = block.get(hex_digit)
     if entry is None:
         # no entry, simply store the revision number
         block[hex_digit] = current_rev
     elif isinstance(entry, dict):
         # need to recurse to an underlying block
         changed += _insert_into_block(
             index, level + 1, entry, current_rev, current_hex
         )
     else:
         # collision with a previously unique prefix, inserting new
         # vertices to fit both entry.
         other_hex = nodemod.hex(index[entry][7])
         other_rev = entry
         new = Block()
         block[hex_digit] = new
         _insert_into_block(index, level + 1, new, other_rev, other_hex)
         _insert_into_block(index, level + 1, new, current_rev, current_hex)
     return changed
 
 
 def _persist_trie(root, existing_idx=None):
     """turn a nodemap trie into persistent binary data
 
     See `_build_trie` for nodemap trie structure"""
     block_map = {}
     if existing_idx is not None:
         base_idx = existing_idx + 1
     else:
         base_idx = 0
     chunks = []
     for tn in _walk_trie(root):
         if tn.ondisk_id is not None:
             block_map[id(tn)] = tn.ondisk_id
         else:
             block_map[id(tn)] = len(chunks) + base_idx
             chunks.append(_persist_block(tn, block_map))
     return b''.join(chunks)
 
 
 def _walk_trie(block):
     """yield all the block in a trie
 
     Children blocks are always yield before their parent block.
     """
     for (__, item) in sorted(block.items()):
         if isinstance(item, dict):
             for sub_block in _walk_trie(item):
                 yield sub_block
     yield block
 
 
 def _persist_block(block_node, block_map):
     """produce persistent binary data for a single block
 
     Children block are assumed to be already persisted and present in
     block_map.
     """
     data = tuple(_to_value(v, block_map) for v in block_node)
     return S_BLOCK.pack(*data)
 
 
 def _to_value(item, block_map):
     """persist any value as an integer"""
     if item is None:
         return NO_ENTRY
     elif isinstance(item, dict):
         return block_map[id(item)]
     else:
         return _transform_rev(item)
 
 
 def parse_data(data):
     """parse parse nodemap data into a nodemap Trie"""
     if (len(data) % S_BLOCK.size) != 0:
         msg = "nodemap data size is not a multiple of block size (%d): %d"
         raise error.Abort(msg % (S_BLOCK.size, len(data)))
     if not data:
         return Block(), None
     block_map = {}
     new_blocks = []
     for i in range(0, len(data), S_BLOCK.size):
         block = Block()
         block.ondisk_id = len(block_map)
         block_map[block.ondisk_id] = block
         block_data = data[i : i + S_BLOCK.size]
         values = S_BLOCK.unpack(block_data)
         new_blocks.append((block, values))
     for b, values in new_blocks:
         for idx, v in enumerate(values):
             if v == NO_ENTRY:
                 continue
             elif v >= 0:
                 b[idx] = block_map[v]
             else:
                 b[idx] = _transform_rev(v)
     return block, i // S_BLOCK.size
 
 
 # debug utility
 
 
 def check_data(ui, index, data):
     """verify that the provided nodemap data are valid for the given idex"""
     ret = 0
     ui.status((b"revision in index:   %d\n") % len(index))
     root, __ = parse_data(data)
     all_revs = set(_all_revisions(root))
     ui.status((b"revision in nodemap: %d\n") % len(all_revs))
     for r in range(len(index)):
         if r not in all_revs:
             msg = b"  revision missing from nodemap: %d\n" % r
             ui.write_err(msg)
             ret = 1
         else:
             all_revs.remove(r)
         nm_rev = _find_node(root, nodemod.hex(index[r][7]))
         if nm_rev is None:
             msg = b"  revision node does not match any entries: %d\n" % r
             ui.write_err(msg)
             ret = 1
         elif nm_rev != r:
             msg = (
                 b"  revision node does not match the expected revision: "
                 b"%d != %d\n" % (r, nm_rev)
             )
             ui.write_err(msg)
             ret = 1
 
     if all_revs:
         for r in sorted(all_revs):
             msg = b"  extra revision in  nodemap: %d\n" % r
             ui.write_err(msg)
         ret = 1
     return ret
 
 
 def _all_revisions(root):
     """return all revisions stored in a Trie"""
     for block in _walk_trie(root):
         for v in block:
             if v is None or isinstance(v, Block):
                 continue
             yield v
 
 
 def _find_node(block, node):
     """find the revision associated with a given node"""
     entry = block.get(_to_int(node[0:1]))
     if isinstance(entry, dict):
         return _find_node(entry, node[1:])
     return entry