transaction: remove the `branch` backup for transaction

We can now back it up at the end of the transaction as we do for the rest of
the dirstate.

mercurial/dirstate.py

@@ -1,1806 +1,1802 b''
 # dirstate.py - working directory tracking for mercurial
 #
 # Copyright 2005-2007 Olivia 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.
 
 
 import collections
 import contextlib
 import os
 import stat
 import uuid
 
 from .i18n import _
 from .pycompat import delattr
 
 from hgdemandimport import tracing
 
 from . import (
     dirstatemap,
     encoding,
     error,
     match as matchmod,
     node,
     pathutil,
     policy,
     pycompat,
     scmutil,
     txnutil,
     util,
 )
 
 from .dirstateutils import (
     timestamp,
 )
 
 from .interfaces import (
     dirstate as intdirstate,
     util as interfaceutil,
 )
 
 parsers = policy.importmod('parsers')
 rustmod = policy.importrust('dirstate')
 
 # use to detect lack of a parameter
 SENTINEL = object()
 
 HAS_FAST_DIRSTATE_V2 = rustmod is not None
 
 propertycache = util.propertycache
 filecache = scmutil.filecache
 _rangemask = dirstatemap.rangemask
 
 DirstateItem = dirstatemap.DirstateItem
 
 
 class repocache(filecache):
     """filecache for files in .hg/"""
 
     def join(self, obj, fname):
         return obj._opener.join(fname)
 
 
 class rootcache(filecache):
     """filecache for files in the repository root"""
 
     def join(self, obj, fname):
         return obj._join(fname)
 
 
 def check_invalidated(func):
     """check that the func is called with a non-invalidated dirstate
 
     The dirstate is in an "invalidated state" after an error occured during its
     modification and remains so until we exited the top level scope that framed
     such change.
     """
 
     def wrap(self, *args, **kwargs):
         if self._invalidated_context:
             msg = 'calling `%s` after the dirstate was invalidated'
             msg %= func.__name__
             raise error.ProgrammingError(msg)
         return func(self, *args, **kwargs)
 
     return wrap
 
 
 def requires_changing_parents(func):
     def wrap(self, *args, **kwargs):
         if not self.is_changing_parents:
             msg = 'calling `%s` outside of a changing_parents context'
             msg %= func.__name__
             raise error.ProgrammingError(msg)
         return func(self, *args, **kwargs)
 
     return check_invalidated(wrap)
 
 
 def requires_changing_files(func):
     def wrap(self, *args, **kwargs):
         if not self.is_changing_files:
             msg = 'calling `%s` outside of a `changing_files`'
             msg %= func.__name__
             raise error.ProgrammingError(msg)
         return func(self, *args, **kwargs)
 
     return check_invalidated(wrap)
 
 
 def requires_changing_any(func):
     def wrap(self, *args, **kwargs):
         if not self.is_changing_any:
             msg = 'calling `%s` outside of a changing context'
             msg %= func.__name__
             raise error.ProgrammingError(msg)
         return func(self, *args, **kwargs)
 
     return check_invalidated(wrap)
 
 
 def requires_changing_files_or_status(func):
     def wrap(self, *args, **kwargs):
         if not (self.is_changing_files or self._running_status > 0):
             msg = (
                 'calling `%s` outside of a changing_files '
                 'or running_status context'
             )
             msg %= func.__name__
             raise error.ProgrammingError(msg)
         return func(self, *args, **kwargs)
 
     return check_invalidated(wrap)
 
 
 CHANGE_TYPE_PARENTS = "parents"
 CHANGE_TYPE_FILES = "files"
 
 
 @interfaceutil.implementer(intdirstate.idirstate)
 class dirstate:
 
     # used by largefile to avoid overwritting transaction callback
     _tr_key_suffix = b''
 
     def __init__(
         self,
         opener,
         ui,
         root,
         validate,
         sparsematchfn,
         nodeconstants,
         use_dirstate_v2,
         use_tracked_hint=False,
     ):
         """Create a new dirstate object.
 
         opener is an open()-like callable that can be used to open the
         dirstate file; root is the root of the directory tracked by
         the dirstate.
         """
         self._use_dirstate_v2 = use_dirstate_v2
         self._use_tracked_hint = use_tracked_hint
         self._nodeconstants = nodeconstants
         self._opener = opener
         self._validate = validate
         self._root = root
         # Either build a sparse-matcher or None if sparse is disabled
         self._sparsematchfn = sparsematchfn
         # ntpath.join(root, '') of Python 2.7.9 does not add sep if root is
         # UNC path pointing to root share (issue4557)
         self._rootdir = pathutil.normasprefix(root)
         # True is any internal state may be different
         self._dirty = False
         # True if the set of tracked file may be different
         self._dirty_tracked_set = False
         self._ui = ui
         self._filecache = {}
         # nesting level of `changing_parents` context
         self._changing_level = 0
         # the change currently underway
         self._change_type = None
         # number of open _running_status context
         self._running_status = 0
         # True if the current dirstate changing operations have been
         # invalidated (used to make sure all nested contexts have been exited)
         self._invalidated_context = False
         self._attached_to_a_transaction = False
         self._filename = b'dirstate'
         self._filename_th = b'dirstate-tracked-hint'
         self._pendingfilename = b'%s.pending' % self._filename
         self._plchangecallbacks = {}
         self._origpl = None
         self._mapcls = dirstatemap.dirstatemap
         # Access and cache cwd early, so we don't access it for the first time
         # after a working-copy update caused it to not exist (accessing it then
         # raises an exception).
         self._cwd
 
     def refresh(self):
         if '_branch' in vars(self):
             del self._branch
         if '_map' in vars(self) and self._map.may_need_refresh():
             self.invalidate()
 
     def prefetch_parents(self):
         """make sure the parents are loaded
 
         Used to avoid a race condition.
         """
         self._pl
 
     @contextlib.contextmanager
     @check_invalidated
     def running_status(self, repo):
         """Wrap a status operation
 
         This context is not mutally exclusive with the `changing_*` context. It
         also do not warrant for the `wlock` to be taken.
 
         If the wlock is taken, this context will behave in a simple way, and
         ensure the data are scheduled for write when leaving the top level
         context.
 
         If the lock is not taken, it will only warrant that the data are either
         committed (written) and rolled back (invalidated) when exiting the top
         level context. The write/invalidate action must be performed by the
         wrapped code.
 
 
         The expected  logic is:
 
         A: read the dirstate
         B: run status
            This might make the dirstate dirty by updating cache,
            especially in Rust.
         C: do more "post status fixup if relevant
         D: try to take the w-lock (this will invalidate the changes if they were raced)
         E0: if dirstate changed on disk → discard change (done by dirstate internal)
         E1: elif lock was acquired → write the changes
         E2: else → discard the changes
         """
         has_lock = repo.currentwlock() is not None
         is_changing = self.is_changing_any
         tr = repo.currenttransaction()
         has_tr = tr is not None
         nested = bool(self._running_status)
 
         first_and_alone = not (is_changing or has_tr or nested)
 
         # enforce no change happened outside of a proper context.
         if first_and_alone and self._dirty:
             has_tr = repo.currenttransaction() is not None
             if not has_tr and self._changing_level == 0 and self._dirty:
                 msg = "entering a status context, but dirstate is already dirty"
                 raise error.ProgrammingError(msg)
 
         should_write = has_lock and not (nested or is_changing)
 
         self._running_status += 1
         try:
             yield
         except Exception:
             self.invalidate()
             raise
         finally:
             self._running_status -= 1
             if self._invalidated_context:
                 should_write = False
                 self.invalidate()
 
         if should_write:
             assert repo.currenttransaction() is tr
             self.write(tr)
         elif not has_lock:
             if self._dirty:
                 msg = b'dirstate dirty while exiting an isolated status context'
                 repo.ui.develwarn(msg)
                 self.invalidate()
 
     @contextlib.contextmanager
     @check_invalidated
     def _changing(self, repo, change_type):
         if repo.currentwlock() is None:
             msg = b"trying to change the dirstate without holding the wlock"
             raise error.ProgrammingError(msg)
 
         has_tr = repo.currenttransaction() is not None
         if not has_tr and self._changing_level == 0 and self._dirty:
             msg = b"entering a changing context, but dirstate is already dirty"
             repo.ui.develwarn(msg)
 
         assert self._changing_level >= 0
         # different type of change are mutually exclusive
         if self._change_type is None:
             assert self._changing_level == 0
             self._change_type = change_type
         elif self._change_type != change_type:
             msg = (
                 'trying to open "%s" dirstate-changing context while a "%s" is'
                 ' already open'
             )
             msg %= (change_type, self._change_type)
             raise error.ProgrammingError(msg)
         should_write = False
         self._changing_level += 1
         try:
             yield
         except:  # re-raises
             self.invalidate()  # this will set `_invalidated_context`
             raise
         finally:
             assert self._changing_level > 0
             self._changing_level -= 1
             # If the dirstate is being invalidated, call invalidate again.
             # This will throw away anything added by a upper context and
             # reset the `_invalidated_context` flag when relevant
             if self._changing_level <= 0:
                 self._change_type = None
                 assert self._changing_level == 0
             if self._invalidated_context:
                 # make sure we invalidate anything an upper context might
                 # have changed.
                 self.invalidate()
             else:
                 should_write = self._changing_level <= 0
         tr = repo.currenttransaction()
         if has_tr != (tr is not None):
             if has_tr:
                 m = "transaction vanished while changing dirstate"
             else:
                 m = "transaction appeared while changing dirstate"
             raise error.ProgrammingError(m)
         if should_write:
             self.write(tr)
 
     @contextlib.contextmanager
     def changing_parents(self, repo):
         with self._changing(repo, CHANGE_TYPE_PARENTS) as c:
             yield c
 
     @contextlib.contextmanager
     def changing_files(self, repo):
         with self._changing(repo, CHANGE_TYPE_FILES) as c:
             yield c
 
     # here to help migration to the new code
     def parentchange(self):
         msg = (
             "Mercurial 6.4 and later requires call to "
             "`dirstate.changing_parents(repo)`"
         )
         raise error.ProgrammingError(msg)
 
     @property
     def is_changing_any(self):
         """Returns true if the dirstate is in the middle of a set of changes.
 
         This returns True for any kind of change.
         """
         return self._changing_level > 0
 
     def pendingparentchange(self):
         return self.is_changing_parent()
 
     def is_changing_parent(self):
         """Returns true if the dirstate is in the middle of a set of changes
         that modify the dirstate parent.
         """
         self._ui.deprecwarn(b"dirstate.is_changing_parents", b"6.5")
         return self.is_changing_parents
 
     @property
     def is_changing_parents(self):
         """Returns true if the dirstate is in the middle of a set of changes
         that modify the dirstate parent.
         """
         if self._changing_level <= 0:
             return False
         return self._change_type == CHANGE_TYPE_PARENTS
 
     @property
     def is_changing_files(self):
         """Returns true if the dirstate is in the middle of a set of changes
         that modify the files tracked or their sources.
         """
         if self._changing_level <= 0:
             return False
         return self._change_type == CHANGE_TYPE_FILES
 
     @propertycache
     def _map(self):
         """Return the dirstate contents (see documentation for dirstatemap)."""
         return self._mapcls(
             self._ui,
             self._opener,
             self._root,
             self._nodeconstants,
             self._use_dirstate_v2,
         )
 
     @property
     def _sparsematcher(self):
         """The matcher for the sparse checkout.
 
         The working directory may not include every file from a manifest. The
         matcher obtained by this property will match a path if it is to be
         included in the working directory.
 
         When sparse if disabled, return None.
         """
         if self._sparsematchfn is None:
             return None
         # TODO there is potential to cache this property. For now, the matcher
         # is resolved on every access. (But the called function does use a
         # cache to keep the lookup fast.)
         return self._sparsematchfn()
 
     @repocache(b'branch')
     def _branch(self):
         f = None
         data = b''
         try:
             f, mode = txnutil.trypending(self._root, self._opener, b'branch')
             data = f.read().strip()
         except FileNotFoundError:
             pass
         finally:
             if f is not None:
                 f.close()
         if not data:
             return b"default"
         return data
 
     @property
     def _pl(self):
         return self._map.parents()
 
     def hasdir(self, d):
         return self._map.hastrackeddir(d)
 
     @rootcache(b'.hgignore')
     def _ignore(self):
         files = self._ignorefiles()
         if not files:
             return matchmod.never()
 
         pats = [b'include:%s' % f for f in files]
         return matchmod.match(self._root, b'', [], pats, warn=self._ui.warn)
 
     @propertycache
     def _slash(self):
         return self._ui.configbool(b'ui', b'slash') and pycompat.ossep != b'/'
 
     @propertycache
     def _checklink(self):
         return util.checklink(self._root)
 
     @propertycache
     def _checkexec(self):
         return bool(util.checkexec(self._root))
 
     @propertycache
     def _checkcase(self):
         return not util.fscasesensitive(self._join(b'.hg'))
 
     def _join(self, f):
         # much faster than os.path.join()
         # it's safe because f is always a relative path
         return self._rootdir + f
 
     def flagfunc(self, buildfallback):
         """build a callable that returns flags associated with a filename
 
         The information is extracted from three possible layers:
         1. the file system if it supports the information
         2. the "fallback" information stored in the dirstate if any
         3. a more expensive mechanism inferring the flags from the parents.
         """
 
         # small hack to cache the result of buildfallback()
         fallback_func = []
 
         def get_flags(x):
             entry = None
             fallback_value = None
             try:
                 st = os.lstat(self._join(x))
             except OSError:
                 return b''
 
             if self._checklink:
                 if util.statislink(st):
                     return b'l'
             else:
                 entry = self.get_entry(x)
                 if entry.has_fallback_symlink:
                     if entry.fallback_symlink:
                         return b'l'
                 else:
                     if not fallback_func:
                         fallback_func.append(buildfallback())
                     fallback_value = fallback_func[0](x)
                     if b'l' in fallback_value:
                         return b'l'
 
             if self._checkexec:
                 if util.statisexec(st):
                     return b'x'
             else:
                 if entry is None:
                     entry = self.get_entry(x)
                 if entry.has_fallback_exec:
                     if entry.fallback_exec:
                         return b'x'
                 else:
                     if fallback_value is None:
                         if not fallback_func:
                             fallback_func.append(buildfallback())
                         fallback_value = fallback_func[0](x)
                     if b'x' in fallback_value:
                         return b'x'
             return b''
 
         return get_flags
 
     @propertycache
     def _cwd(self):
         # internal config: ui.forcecwd
         forcecwd = self._ui.config(b'ui', b'forcecwd')
         if forcecwd:
             return forcecwd
         return encoding.getcwd()
 
     def getcwd(self):
         """Return the path from which a canonical path is calculated.
 
         This path should be used to resolve file patterns or to convert
         canonical paths back to file paths for display. It shouldn't be
         used to get real file paths. Use vfs functions instead.
         """
         cwd = self._cwd
         if cwd == self._root:
             return b''
         # self._root ends with a path separator if self._root is '/' or 'C:\'
         rootsep = self._root
         if not util.endswithsep(rootsep):
             rootsep += pycompat.ossep
         if cwd.startswith(rootsep):
             return cwd[len(rootsep) :]
         else:
             # we're outside the repo. return an absolute path.
             return cwd
 
     def pathto(self, f, cwd=None):
         if cwd is None:
             cwd = self.getcwd()
         path = util.pathto(self._root, cwd, f)
         if self._slash:
             return util.pconvert(path)
         return path
 
     def get_entry(self, path):
         """return a DirstateItem for the associated path"""
         entry = self._map.get(path)
         if entry is None:
             return DirstateItem()
         return entry
 
     def __contains__(self, key):
         return key in self._map
 
     def __iter__(self):
         return iter(sorted(self._map))
 
     def items(self):
         return self._map.items()
 
     iteritems = items
 
     def parents(self):
         return [self._validate(p) for p in self._pl]
 
     def p1(self):
         return self._validate(self._pl[0])
 
     def p2(self):
         return self._validate(self._pl[1])
 
     @property
     def in_merge(self):
         """True if a merge is in progress"""
         return self._pl[1] != self._nodeconstants.nullid
 
     def branch(self):
         return encoding.tolocal(self._branch)
 
     @requires_changing_parents
     def setparents(self, p1, p2=None):
         """Set dirstate parents to p1 and p2.
 
         When moving from two parents to one, "merged" entries a
         adjusted to normal and previous copy records discarded and
         returned by the call.
 
         See localrepo.setparents()
         """
         if p2 is None:
             p2 = self._nodeconstants.nullid
         if self._changing_level == 0:
             raise ValueError(
                 b"cannot set dirstate parent outside of "
                 b"dirstate.changing_parents context manager"
             )
 
         self._dirty = True
         oldp2 = self._pl[1]
         if self._origpl is None:
             self._origpl = self._pl
         nullid = self._nodeconstants.nullid
         # True if we need to fold p2 related state back to a linear case
         fold_p2 = oldp2 != nullid and p2 == nullid
         return self._map.setparents(p1, p2, fold_p2=fold_p2)
 
     def setbranch(self, branch, transaction=SENTINEL):
         self.__class__._branch.set(self, encoding.fromlocal(branch))
         if transaction is SENTINEL:
             msg = b"setbranch needs a `transaction` argument"
             self._ui.deprecwarn(msg, b'6.5')
             transaction = None
         if transaction is not None:
             self._setup_tr_abort(transaction)
             transaction.addfilegenerator(
                 b'dirstate-3-branch%s' % self._tr_key_suffix,
                 (b'branch',),
                 self._write_branch,
                 location=b'plain',
                 post_finalize=True,
             )
             return
 
         vfs = self._opener
         with vfs(b'branch', b'w', atomictemp=True, checkambig=True) as f:
             self._write_branch(f)
             # make sure filecache has the correct stat info for _branch after
             # replacing the underlying file
             #
             # XXX do we actually need this,
             # refreshing the attribute is quite cheap
             ce = self._filecache[b'_branch']
             if ce:
                 ce.refresh()
 
     def _write_branch(self, file_obj):
         file_obj.write(self._branch + b'\n')
 
     def invalidate(self):
         """Causes the next access to reread the dirstate.
 
         This is different from localrepo.invalidatedirstate() because it always
         rereads the dirstate. Use localrepo.invalidatedirstate() if you want to
         check whether the dirstate has changed before rereading it."""
 
         for a in ("_map", "_branch", "_ignore"):
             if a in self.__dict__:
                 delattr(self, a)
         self._dirty = False
         self._dirty_tracked_set = False
         self._invalidated_context = bool(
             self._changing_level > 0
             or self._attached_to_a_transaction
             or self._running_status
         )
         self._origpl = None
 
     @requires_changing_any
     def copy(self, source, dest):
         """Mark dest as a copy of source. Unmark dest if source is None."""
         if source == dest:
             return
         self._dirty = True
         if source is not None:
             self._check_sparse(source)
             self._map.copymap[dest] = source
         else:
             self._map.copymap.pop(dest, None)
 
     def copied(self, file):
         return self._map.copymap.get(file, None)
 
     def copies(self):
         return self._map.copymap
 
     @requires_changing_files
     def set_tracked(self, filename, reset_copy=False):
         """a "public" method for generic code to mark a file as tracked
 
         This function is to be called outside of "update/merge" case. For
         example by a command like `hg add X`.
 
         if reset_copy is set, any existing copy information will be dropped.
 
         return True the file was previously untracked, False otherwise.
         """
         self._dirty = True
         entry = self._map.get(filename)
         if entry is None or not entry.tracked:
             self._check_new_tracked_filename(filename)
         pre_tracked = self._map.set_tracked(filename)
         if reset_copy:
             self._map.copymap.pop(filename, None)
         if pre_tracked:
             self._dirty_tracked_set = True
         return pre_tracked
 
     @requires_changing_files
     def set_untracked(self, filename):
         """a "public" method for generic code to mark a file as untracked
 
         This function is to be called outside of "update/merge" case. For
         example by a command like `hg remove X`.
 
         return True the file was previously tracked, False otherwise.
         """
         ret = self._map.set_untracked(filename)
         if ret:
             self._dirty = True
             self._dirty_tracked_set = True
         return ret
 
     @requires_changing_files_or_status
     def set_clean(self, filename, parentfiledata):
         """record that the current state of the file on disk is known to be clean"""
         self._dirty = True
         if not self._map[filename].tracked:
             self._check_new_tracked_filename(filename)
         (mode, size, mtime) = parentfiledata
         self._map.set_clean(filename, mode, size, mtime)
 
     @requires_changing_files_or_status
     def set_possibly_dirty(self, filename):
         """record that the current state of the file on disk is unknown"""
         self._dirty = True
         self._map.set_possibly_dirty(filename)
 
     @requires_changing_parents
     def update_file_p1(
         self,
         filename,
         p1_tracked,
     ):
         """Set a file as tracked in the parent (or not)
 
         This is to be called when adjust the dirstate to a new parent after an history
         rewriting operation.
 
         It should not be called during a merge (p2 != nullid) and only within
         a `with dirstate.changing_parents(repo):` context.
         """
         if self.in_merge:
             msg = b'update_file_reference should not be called when merging'
             raise error.ProgrammingError(msg)
         entry = self._map.get(filename)
         if entry is None:
             wc_tracked = False
         else:
             wc_tracked = entry.tracked
         if not (p1_tracked or wc_tracked):
             # the file is no longer relevant to anyone
             if self._map.get(filename) is not None:
                 self._map.reset_state(filename)
                 self._dirty = True
         elif (not p1_tracked) and wc_tracked:
             if entry is not None and entry.added:
                 return  # avoid dropping copy information (maybe?)
 
         self._map.reset_state(
             filename,
             wc_tracked,
             p1_tracked,
             # the underlying reference might have changed, we will have to
             # check it.
             has_meaningful_mtime=False,
         )
 
     @requires_changing_parents
     def update_file(
         self,
         filename,
         wc_tracked,
         p1_tracked,
         p2_info=False,
         possibly_dirty=False,
         parentfiledata=None,
     ):
         """update the information about a file in the dirstate
 
         This is to be called when the direstates parent changes to keep track
         of what is the file situation in regards to the working copy and its parent.
 
         This function must be called within a `dirstate.changing_parents` context.
 
         note: the API is at an early stage and we might need to adjust it
         depending of what information ends up being relevant and useful to
         other processing.
         """
         self._update_file(
             filename=filename,
             wc_tracked=wc_tracked,
             p1_tracked=p1_tracked,
             p2_info=p2_info,
             possibly_dirty=possibly_dirty,
             parentfiledata=parentfiledata,
         )
 
     def hacky_extension_update_file(self, *args, **kwargs):
         """NEVER USE THIS, YOU DO NOT NEED IT
 
         This function is a variant of "update_file" to be called by a small set
         of extensions, it also adjust the internal state of file, but can be
         called outside an `changing_parents` context.
 
         A very small number of extension meddle with the working copy content
         in a way that requires to adjust the dirstate accordingly. At the time
         this command is written they are :
         - keyword,
         - largefile,
         PLEASE DO NOT GROW THIS LIST ANY FURTHER.
 
         This function could probably be replaced by more semantic one (like
         "adjust expected size" or "always revalidate file content", etc)
         however at the time where this is writen, this is too much of a detour
         to be considered.
         """
         if not (self._changing_level > 0 or self._running_status > 0):
             msg = "requires a changes context"
             raise error.ProgrammingError(msg)
         self._update_file(
             *args,
             **kwargs,
         )
 
     def _update_file(
         self,
         filename,
         wc_tracked,
         p1_tracked,
         p2_info=False,
         possibly_dirty=False,
         parentfiledata=None,
     ):
 
         # note: I do not think we need to double check name clash here since we
         # are in a update/merge case that should already have taken care of
         # this. The test agrees
 
         self._dirty = True
         old_entry = self._map.get(filename)
         if old_entry is None:
             prev_tracked = False
         else:
             prev_tracked = old_entry.tracked
         if prev_tracked != wc_tracked:
             self._dirty_tracked_set = True
 
         self._map.reset_state(
             filename,
             wc_tracked,
             p1_tracked,
             p2_info=p2_info,
             has_meaningful_mtime=not possibly_dirty,
             parentfiledata=parentfiledata,
         )
 
     def _check_new_tracked_filename(self, filename):
         scmutil.checkfilename(filename)
         if self._map.hastrackeddir(filename):
             msg = _(b'directory %r already in dirstate')
             msg %= pycompat.bytestr(filename)
             raise error.Abort(msg)
         # shadows
         for d in pathutil.finddirs(filename):
             if self._map.hastrackeddir(d):
                 break
             entry = self._map.get(d)
             if entry is not None and not entry.removed:
                 msg = _(b'file %r in dirstate clashes with %r')
                 msg %= (pycompat.bytestr(d), pycompat.bytestr(filename))
                 raise error.Abort(msg)
         self._check_sparse(filename)
 
     def _check_sparse(self, filename):
         """Check that a filename is inside the sparse profile"""
         sparsematch = self._sparsematcher
         if sparsematch is not None and not sparsematch.always():
             if not sparsematch(filename):
                 msg = _(b"cannot add '%s' - it is outside the sparse checkout")
                 hint = _(
                     b'include file with `hg debugsparse --include <pattern>` or use '
                     b'`hg add -s <file>` to include file directory while adding'
                 )
                 raise error.Abort(msg % filename, hint=hint)
 
     def _discoverpath(self, path, normed, ignoremissing, exists, storemap):
         if exists is None:
             exists = os.path.lexists(os.path.join(self._root, path))
         if not exists:
             # Maybe a path component exists
             if not ignoremissing and b'/' in path:
                 d, f = path.rsplit(b'/', 1)
                 d = self._normalize(d, False, ignoremissing, None)
                 folded = d + b"/" + f
             else:
                 # No path components, preserve original case
                 folded = path
         else:
             # recursively normalize leading directory components
             # against dirstate
             if b'/' in normed:
                 d, f = normed.rsplit(b'/', 1)
                 d = self._normalize(d, False, ignoremissing, True)
                 r = self._root + b"/" + d
                 folded = d + b"/" + util.fspath(f, r)
             else:
                 folded = util.fspath(normed, self._root)
             storemap[normed] = folded
 
         return folded
 
     def _normalizefile(self, path, isknown, ignoremissing=False, exists=None):
         normed = util.normcase(path)
         folded = self._map.filefoldmap.get(normed, None)
         if folded is None:
             if isknown:
                 folded = path
             else:
                 folded = self._discoverpath(
                     path, normed, ignoremissing, exists, self._map.filefoldmap
                 )
         return folded
 
     def _normalize(self, path, isknown, ignoremissing=False, exists=None):
         normed = util.normcase(path)
         folded = self._map.filefoldmap.get(normed, None)
         if folded is None:
             folded = self._map.dirfoldmap.get(normed, None)
         if folded is None:
             if isknown:
                 folded = path
             else:
                 # store discovered result in dirfoldmap so that future
                 # normalizefile calls don't start matching directories
                 folded = self._discoverpath(
                     path, normed, ignoremissing, exists, self._map.dirfoldmap
                 )
         return folded
 
     def normalize(self, path, isknown=False, ignoremissing=False):
         """
         normalize the case of a pathname when on a casefolding filesystem
 
         isknown specifies whether the filename came from walking the
         disk, to avoid extra filesystem access.
 
         If ignoremissing is True, missing path are returned
         unchanged. Otherwise, we try harder to normalize possibly
         existing path components.
 
         The normalized case is determined based on the following precedence:
 
         - version of name already stored in the dirstate
         - version of name stored on disk
         - version provided via command arguments
         """
 
         if self._checkcase:
             return self._normalize(path, isknown, ignoremissing)
         return path
 
     # XXX this method is barely used, as a result:
     # - its semantic is unclear
     # - do we really needs it ?
     @requires_changing_parents
     def clear(self):
         self._map.clear()
         self._dirty = True
 
     @requires_changing_parents
     def rebuild(self, parent, allfiles, changedfiles=None):
         matcher = self._sparsematcher
         if matcher is not None and not matcher.always():
             # should not add non-matching files
             allfiles = [f for f in allfiles if matcher(f)]
             if changedfiles:
                 changedfiles = [f for f in changedfiles if matcher(f)]
 
             if changedfiles is not None:
                 # these files will be deleted from the dirstate when they are
                 # not found to be in allfiles
                 dirstatefilestoremove = {f for f in self if not matcher(f)}
                 changedfiles = dirstatefilestoremove.union(changedfiles)
 
         if changedfiles is None:
             # Rebuild entire dirstate
             to_lookup = allfiles
             to_drop = []
             self.clear()
         elif len(changedfiles) < 10:
             # Avoid turning allfiles into a set, which can be expensive if it's
             # large.
             to_lookup = []
             to_drop = []
             for f in changedfiles:
                 if f in allfiles:
                     to_lookup.append(f)
                 else:
                     to_drop.append(f)
         else:
             changedfilesset = set(changedfiles)
             to_lookup = changedfilesset & set(allfiles)
             to_drop = changedfilesset - to_lookup
 
         if self._origpl is None:
             self._origpl = self._pl
         self._map.setparents(parent, self._nodeconstants.nullid)
 
         for f in to_lookup:
             if self.in_merge:
                 self.set_tracked(f)
             else:
                 self._map.reset_state(
                     f,
                     wc_tracked=True,
                     p1_tracked=True,
                 )
         for f in to_drop:
             self._map.reset_state(f)
 
         self._dirty = True
 
     def _setup_tr_abort(self, tr):
         """make sure we invalidate the current change on abort"""
         if tr is None:
             return
 
         def on_abort(tr):
             self._attached_to_a_transaction = False
             self.invalidate()
 
         tr.addabort(
             b'dirstate-invalidate%s' % self._tr_key_suffix,
             on_abort,
         )
 
     def write(self, tr):
         if not self._dirty:
             return
         # make sure we don't request a write of invalidated content
         # XXX move before the dirty check once `unlock` stop calling `write`
         assert not self._invalidated_context
 
         write_key = self._use_tracked_hint and self._dirty_tracked_set
         if tr:
 
             self._setup_tr_abort(tr)
             self._attached_to_a_transaction = True
 
             def on_success(f):
                 self._attached_to_a_transaction = False
                 self._writedirstate(tr, f),
 
             # delay writing in-memory changes out
             tr.addfilegenerator(
                 b'dirstate-1-main%s' % self._tr_key_suffix,
                 (self._filename,),
                 on_success,
                 location=b'plain',
                 post_finalize=True,
             )
             if write_key:
                 tr.addfilegenerator(
                     b'dirstate-2-key-post%s' % self._tr_key_suffix,
                     (self._filename_th,),
                     lambda f: self._write_tracked_hint(tr, f),
                     location=b'plain',
                     post_finalize=True,
                 )
             return
 
         file = lambda f: self._opener(f, b"w", atomictemp=True, checkambig=True)
         with file(self._filename) as f:
             self._writedirstate(tr, f)
         if write_key:
             # we update the key-file after writing to make sure reader have a
             # key that match the newly written content
             with file(self._filename_th) as f:
                 self._write_tracked_hint(tr, f)
 
     def delete_tracked_hint(self):
         """remove the tracked_hint file
 
         To be used by format downgrades operation"""
         self._opener.unlink(self._filename_th)
         self._use_tracked_hint = False
 
     def addparentchangecallback(self, category, callback):
         """add a callback to be called when the wd parents are changed
 
         Callback will be called with the following arguments:
             dirstate, (oldp1, oldp2), (newp1, newp2)
 
         Category is a unique identifier to allow overwriting an old callback
         with a newer callback.
         """
         self._plchangecallbacks[category] = callback
 
     def _writedirstate(self, tr, st):
         # make sure we don't write invalidated content
         assert not self._invalidated_context
         # notify callbacks about parents change
         if self._origpl is not None and self._origpl != self._pl:
             for c, callback in sorted(self._plchangecallbacks.items()):
                 callback(self, self._origpl, self._pl)
             self._origpl = None
         self._map.write(tr, st)
         self._dirty = False
         self._dirty_tracked_set = False
 
     def _write_tracked_hint(self, tr, f):
         key = node.hex(uuid.uuid4().bytes)
         f.write(b"1\n%s\n" % key)  # 1 is the format version
 
     def _dirignore(self, f):
         if self._ignore(f):
             return True
         for p in pathutil.finddirs(f):
             if self._ignore(p):
                 return True
         return False
 
     def _ignorefiles(self):
         files = []
         if os.path.exists(self._join(b'.hgignore')):
             files.append(self._join(b'.hgignore'))
         for name, path in self._ui.configitems(b"ui"):
             if name == b'ignore' or name.startswith(b'ignore.'):
                 # we need to use os.path.join here rather than self._join
                 # because path is arbitrary and user-specified
                 files.append(os.path.join(self._rootdir, util.expandpath(path)))
         return files
 
     def _ignorefileandline(self, f):
         files = collections.deque(self._ignorefiles())
         visited = set()
         while files:
             i = files.popleft()
             patterns = matchmod.readpatternfile(
                 i, self._ui.warn, sourceinfo=True
             )
             for pattern, lineno, line in patterns:
                 kind, p = matchmod._patsplit(pattern, b'glob')
                 if kind == b"subinclude":
                     if p not in visited:
                         files.append(p)
                     continue
                 m = matchmod.match(
                     self._root, b'', [], [pattern], warn=self._ui.warn
                 )
                 if m(f):
                     return (i, lineno, line)
             visited.add(i)
         return (None, -1, b"")
 
     def _walkexplicit(self, match, subrepos):
         """Get stat data about the files explicitly specified by match.
 
         Return a triple (results, dirsfound, dirsnotfound).
         - results is a mapping from filename to stat result. It also contains
           listings mapping subrepos and .hg to None.
         - dirsfound is a list of files found to be directories.
         - dirsnotfound is a list of files that the dirstate thinks are
           directories and that were not found."""
 
         def badtype(mode):
             kind = _(b'unknown')
             if stat.S_ISCHR(mode):
                 kind = _(b'character device')
             elif stat.S_ISBLK(mode):
                 kind = _(b'block device')
             elif stat.S_ISFIFO(mode):
                 kind = _(b'fifo')
             elif stat.S_ISSOCK(mode):
                 kind = _(b'socket')
             elif stat.S_ISDIR(mode):
                 kind = _(b'directory')
             return _(b'unsupported file type (type is %s)') % kind
 
         badfn = match.bad
         dmap = self._map
         lstat = os.lstat
         getkind = stat.S_IFMT
         dirkind = stat.S_IFDIR
         regkind = stat.S_IFREG
         lnkkind = stat.S_IFLNK
         join = self._join
         dirsfound = []
         foundadd = dirsfound.append
         dirsnotfound = []
         notfoundadd = dirsnotfound.append
 
         if not match.isexact() and self._checkcase:
             normalize = self._normalize
         else:
             normalize = None
 
         files = sorted(match.files())
         subrepos.sort()
         i, j = 0, 0
         while i < len(files) and j < len(subrepos):
             subpath = subrepos[j] + b"/"
             if files[i] < subpath:
                 i += 1
                 continue
             while i < len(files) and files[i].startswith(subpath):
                 del files[i]
             j += 1
 
         if not files or b'' in files:
             files = [b'']
             # constructing the foldmap is expensive, so don't do it for the
             # common case where files is ['']
             normalize = None
         results = dict.fromkeys(subrepos)
         results[b'.hg'] = None
 
         for ff in files:
             if normalize:
                 nf = normalize(ff, False, True)
             else:
                 nf = ff
             if nf in results:
                 continue
 
             try:
                 st = lstat(join(nf))
                 kind = getkind(st.st_mode)
                 if kind == dirkind:
                     if nf in dmap:
                         # file replaced by dir on disk but still in dirstate
                         results[nf] = None
                     foundadd((nf, ff))
                 elif kind == regkind or kind == lnkkind:
                     results[nf] = st
                 else:
                     badfn(ff, badtype(kind))
                     if nf in dmap:
                         results[nf] = None
             except (OSError) as inst:
                 # nf not found on disk - it is dirstate only
                 if nf in dmap:  # does it exactly match a missing file?
                     results[nf] = None
                 else:  # does it match a missing directory?
                     if self._map.hasdir(nf):
                         notfoundadd(nf)
                     else:
                         badfn(ff, encoding.strtolocal(inst.strerror))
 
         # match.files() may contain explicitly-specified paths that shouldn't
         # be taken; drop them from the list of files found. dirsfound/notfound
         # aren't filtered here because they will be tested later.
         if match.anypats():
             for f in list(results):
                 if f == b'.hg' or f in subrepos:
                     # keep sentinel to disable further out-of-repo walks
                     continue
                 if not match(f):
                     del results[f]
 
         # Case insensitive filesystems cannot rely on lstat() failing to detect
         # a case-only rename.  Prune the stat object for any file that does not
         # match the case in the filesystem, if there are multiple files that
         # normalize to the same path.
         if match.isexact() and self._checkcase:
             normed = {}
 
             for f, st in results.items():
                 if st is None:
                     continue
 
                 nc = util.normcase(f)
                 paths = normed.get(nc)
 
                 if paths is None:
                     paths = set()
                     normed[nc] = paths
 
                 paths.add(f)
 
             for norm, paths in normed.items():
                 if len(paths) > 1:
                     for path in paths:
                         folded = self._discoverpath(
                             path, norm, True, None, self._map.dirfoldmap
                         )
                         if path != folded:
                             results[path] = None
 
         return results, dirsfound, dirsnotfound
 
     def walk(self, match, subrepos, unknown, ignored, full=True):
         """
         Walk recursively through the directory tree, finding all files
         matched by match.
 
         If full is False, maybe skip some known-clean files.
 
         Return a dict mapping filename to stat-like object (either
         mercurial.osutil.stat instance or return value of os.stat()).
 
         """
         # full is a flag that extensions that hook into walk can use -- this
         # implementation doesn't use it at all. This satisfies the contract
         # because we only guarantee a "maybe".
 
         if ignored:
             ignore = util.never
             dirignore = util.never
         elif unknown:
             ignore = self._ignore
             dirignore = self._dirignore
         else:
             # if not unknown and not ignored, drop dir recursion and step 2
             ignore = util.always
             dirignore = util.always
 
         if self._sparsematchfn is not None:
             em = matchmod.exact(match.files())
             sm = matchmod.unionmatcher([self._sparsematcher, em])
             match = matchmod.intersectmatchers(match, sm)
 
         matchfn = match.matchfn
         matchalways = match.always()
         matchtdir = match.traversedir
         dmap = self._map
         listdir = util.listdir
         lstat = os.lstat
         dirkind = stat.S_IFDIR
         regkind = stat.S_IFREG
         lnkkind = stat.S_IFLNK
         join = self._join
 
         exact = skipstep3 = False
         if match.isexact():  # match.exact
             exact = True
             dirignore = util.always  # skip step 2
         elif match.prefix():  # match.match, no patterns
             skipstep3 = True
 
         if not exact and self._checkcase:
             normalize = self._normalize
             normalizefile = self._normalizefile
             skipstep3 = False
         else:
             normalize = self._normalize
             normalizefile = None
 
         # step 1: find all explicit files
         results, work, dirsnotfound = self._walkexplicit(match, subrepos)
         if matchtdir:
             for d in work:
                 matchtdir(d[0])
             for d in dirsnotfound:
                 matchtdir(d)
 
         skipstep3 = skipstep3 and not (work or dirsnotfound)
         work = [d for d in work if not dirignore(d[0])]
 
         # step 2: visit subdirectories
         def traverse(work, alreadynormed):
             wadd = work.append
             while work:
                 tracing.counter('dirstate.walk work', len(work))
                 nd = work.pop()
                 visitentries = match.visitchildrenset(nd)
                 if not visitentries:
                     continue
                 if visitentries == b'this' or visitentries == b'all':
                     visitentries = None
                 skip = None
                 if nd != b'':
                     skip = b'.hg'
                 try:
                     with tracing.log('dirstate.walk.traverse listdir %s', nd):
                         entries = listdir(join(nd), stat=True, skip=skip)
                 except (PermissionError, FileNotFoundError) as inst:
                     match.bad(
                         self.pathto(nd), encoding.strtolocal(inst.strerror)
                     )
                     continue
                 for f, kind, st in entries:
                     # Some matchers may return files in the visitentries set,
                     # instead of 'this', if the matcher explicitly mentions them
                     # and is not an exactmatcher. This is acceptable; we do not
                     # make any hard assumptions about file-or-directory below
                     # based on the presence of `f` in visitentries. If
                     # visitchildrenset returned a set, we can always skip the
                     # entries *not* in the set it provided regardless of whether
                     # they're actually a file or a directory.
                     if visitentries and f not in visitentries:
                         continue
                     if normalizefile:
                         # even though f might be a directory, we're only
                         # interested in comparing it to files currently in the
                         # dmap -- therefore normalizefile is enough
                         nf = normalizefile(
                             nd and (nd + b"/" + f) or f, True, True
                         )
                     else:
                         nf = nd and (nd + b"/" + f) or f
                     if nf not in results:
                         if kind == dirkind:
                             if not ignore(nf):
                                 if matchtdir:
                                     matchtdir(nf)
                                 wadd(nf)
                             if nf in dmap and (matchalways or matchfn(nf)):
                                 results[nf] = None
                         elif kind == regkind or kind == lnkkind:
                             if nf in dmap:
                                 if matchalways or matchfn(nf):
                                     results[nf] = st
                             elif (matchalways or matchfn(nf)) and not ignore(
                                 nf
                             ):
                                 # unknown file -- normalize if necessary
                                 if not alreadynormed:
                                     nf = normalize(nf, False, True)
                                 results[nf] = st
                         elif nf in dmap and (matchalways or matchfn(nf)):
                             results[nf] = None
 
         for nd, d in work:
             # alreadynormed means that processwork doesn't have to do any
             # expensive directory normalization
             alreadynormed = not normalize or nd == d
             traverse([d], alreadynormed)
 
         for s in subrepos:
             del results[s]
         del results[b'.hg']
 
         # step 3: visit remaining files from dmap
         if not skipstep3 and not exact:
             # If a dmap file is not in results yet, it was either
             # a) not matching matchfn b) ignored, c) missing, or d) under a
             # symlink directory.
             if not results and matchalways:
                 visit = [f for f in dmap]
             else:
                 visit = [f for f in dmap if f not in results and matchfn(f)]
             visit.sort()
 
             if unknown:
                 # unknown == True means we walked all dirs under the roots
                 # that wasn't ignored, and everything that matched was stat'ed
                 # and is already in results.
                 # The rest must thus be ignored or under a symlink.
                 audit_path = pathutil.pathauditor(self._root, cached=True)
 
                 for nf in iter(visit):
                     # If a stat for the same file was already added with a
                     # different case, don't add one for this, since that would
                     # make it appear as if the file exists under both names
                     # on disk.
                     if (
                         normalizefile
                         and normalizefile(nf, True, True) in results
                     ):
                         results[nf] = None
                     # Report ignored items in the dmap as long as they are not
                     # under a symlink directory.
                     elif audit_path.check(nf):
                         try:
                             results[nf] = lstat(join(nf))
                             # file was just ignored, no links, and exists
                         except OSError:
                             # file doesn't exist
                             results[nf] = None
                     else:
                         # It's either missing or under a symlink directory
                         # which we in this case report as missing
                         results[nf] = None
             else:
                 # We may not have walked the full directory tree above,
                 # so stat and check everything we missed.
                 iv = iter(visit)
                 for st in util.statfiles([join(i) for i in visit]):
                     results[next(iv)] = st
         return results
 
     def _rust_status(self, matcher, list_clean, list_ignored, list_unknown):
         if self._sparsematchfn is not None:
             em = matchmod.exact(matcher.files())
             sm = matchmod.unionmatcher([self._sparsematcher, em])
             matcher = matchmod.intersectmatchers(matcher, sm)
         # Force Rayon (Rust parallelism library) to respect the number of
         # workers. This is a temporary workaround until Rust code knows
         # how to read the config file.
         numcpus = self._ui.configint(b"worker", b"numcpus")
         if numcpus is not None:
             encoding.environ.setdefault(b'RAYON_NUM_THREADS', b'%d' % numcpus)
 
         workers_enabled = self._ui.configbool(b"worker", b"enabled", True)
         if not workers_enabled:
             encoding.environ[b"RAYON_NUM_THREADS"] = b"1"
 
         (
             lookup,
             modified,
             added,
             removed,
             deleted,
             clean,
             ignored,
             unknown,
             warnings,
             bad,
             traversed,
             dirty,
         ) = rustmod.status(
             self._map._map,
             matcher,
             self._rootdir,
             self._ignorefiles(),
             self._checkexec,
             bool(list_clean),
             bool(list_ignored),
             bool(list_unknown),
             bool(matcher.traversedir),
         )
 
         self._dirty |= dirty
 
         if matcher.traversedir:
             for dir in traversed:
                 matcher.traversedir(dir)
 
         if self._ui.warn:
             for item in warnings:
                 if isinstance(item, tuple):
                     file_path, syntax = item
                     msg = _(b"%s: ignoring invalid syntax '%s'\n") % (
                         file_path,
                         syntax,
                     )
                     self._ui.warn(msg)
                 else:
                     msg = _(b"skipping unreadable pattern file '%s': %s\n")
                     self._ui.warn(
                         msg
                         % (
                             pathutil.canonpath(
                                 self._rootdir, self._rootdir, item
                             ),
                             b"No such file or directory",
                         )
                     )
 
         for fn, message in bad:
             matcher.bad(fn, encoding.strtolocal(message))
 
         status = scmutil.status(
             modified=modified,
             added=added,
             removed=removed,
             deleted=deleted,
             unknown=unknown,
             ignored=ignored,
             clean=clean,
         )
         return (lookup, status)
 
     def status(self, match, subrepos, ignored, clean, unknown):
         """Determine the status of the working copy relative to the
         dirstate and return a pair of (unsure, status), where status is of type
         scmutil.status and:
 
           unsure:
             files that might have been modified since the dirstate was
             written, but need to be read to be sure (size is the same
             but mtime differs)
           status.modified:
             files that have definitely been modified since the dirstate
             was written (different size or mode)
           status.clean:
             files that have definitely not been modified since the
             dirstate was written
         """
         if not self._running_status:
             msg = "Calling `status` outside a `running_status` context"
             raise error.ProgrammingError(msg)
         listignored, listclean, listunknown = ignored, clean, unknown
         lookup, modified, added, unknown, ignored = [], [], [], [], []
         removed, deleted, clean = [], [], []
 
         dmap = self._map
         dmap.preload()
 
         use_rust = True
 
         allowed_matchers = (
             matchmod.alwaysmatcher,
             matchmod.differencematcher,
             matchmod.exactmatcher,
             matchmod.includematcher,
             matchmod.intersectionmatcher,
             matchmod.nevermatcher,
             matchmod.unionmatcher,
         )
 
         if rustmod is None:
             use_rust = False
         elif self._checkcase:
             # Case-insensitive filesystems are not handled yet
             use_rust = False
         elif subrepos:
             use_rust = False
         elif not isinstance(match, allowed_matchers):
             # Some matchers have yet to be implemented
             use_rust = False
 
         # Get the time from the filesystem so we can disambiguate files that
         # appear modified in the present or future.
         try:
             mtime_boundary = timestamp.get_fs_now(self._opener)
         except OSError:
             # In largefiles or readonly context
             mtime_boundary = None
 
         if use_rust:
             try:
                 res = self._rust_status(
                     match, listclean, listignored, listunknown
                 )
                 return res + (mtime_boundary,)
             except rustmod.FallbackError:
                 pass
 
         def noop(f):
             pass
 
         dcontains = dmap.__contains__
         dget = dmap.__getitem__
         ladd = lookup.append  # aka "unsure"
         madd = modified.append
         aadd = added.append
         uadd = unknown.append if listunknown else noop
         iadd = ignored.append if listignored else noop
         radd = removed.append
         dadd = deleted.append
         cadd = clean.append if listclean else noop
         mexact = match.exact
         dirignore = self._dirignore
         checkexec = self._checkexec
         checklink = self._checklink
         copymap = self._map.copymap
 
         # We need to do full walks when either
         # - we're listing all clean files, or
         # - match.traversedir does something, because match.traversedir should
         #   be called for every dir in the working dir
         full = listclean or match.traversedir is not None
         for fn, st in self.walk(
             match, subrepos, listunknown, listignored, full=full
         ).items():
             if not dcontains(fn):
                 if (listignored or mexact(fn)) and dirignore(fn):
                     if listignored:
                         iadd(fn)
                 else:
                     uadd(fn)
                 continue
 
             t = dget(fn)
             mode = t.mode
             size = t.size
 
             if not st and t.tracked:
                 dadd(fn)
             elif t.p2_info:
                 madd(fn)
             elif t.added:
                 aadd(fn)
             elif t.removed:
                 radd(fn)
             elif t.tracked:
                 if not checklink and t.has_fallback_symlink:
                     # If the file system does not support symlink, the mode
                     # might not be correctly stored in the dirstate, so do not
                     # trust it.
                     ladd(fn)
                 elif not checkexec and t.has_fallback_exec:
                     # If the file system does not support exec bits, the mode
                     # might not be correctly stored in the dirstate, so do not
                     # trust it.
                     ladd(fn)
                 elif (
                     size >= 0
                     and (
                         (size != st.st_size and size != st.st_size & _rangemask)
                         or ((mode ^ st.st_mode) & 0o100 and checkexec)
                     )
                     or fn in copymap
                 ):
                     if stat.S_ISLNK(st.st_mode) and size != st.st_size:
                         # issue6456: Size returned may be longer due to
                         # encryption on EXT-4 fscrypt, undecided.
                         ladd(fn)
                     else:
                         madd(fn)
                 elif not t.mtime_likely_equal_to(timestamp.mtime_of(st)):
                     # There might be a change in the future if for example the
                     # internal clock is off, but this is a case where the issues
                     # the user would face would be a lot worse and there is
                     # nothing we can really do.
                     ladd(fn)
                 elif listclean:
                     cadd(fn)
         status = scmutil.status(
             modified, added, removed, deleted, unknown, ignored, clean
         )
         return (lookup, status, mtime_boundary)
 
     def matches(self, match):
         """
         return files in the dirstate (in whatever state) filtered by match
         """
         dmap = self._map
         if rustmod is not None:
             dmap = self._map._map
 
         if match.always():
             return dmap.keys()
         files = match.files()
         if match.isexact():
             # fast path -- filter the other way around, since typically files is
             # much smaller than dmap
             return [f for f in files if f in dmap]
         if match.prefix() and all(fn in dmap for fn in files):
             # fast path -- all the values are known to be files, so just return
             # that
             return list(files)
         return [f for f in dmap if match(f)]
 
     def _actualfilename(self, tr):
         if tr:
             return self._pendingfilename
         else:
             return self._filename
 
     def all_file_names(self):
         """list all filename currently used by this dirstate
 
         This is only used to do `hg rollback` related backup in the transaction
         """
-        if not self._opener.exists(self._filename):
-            # no data every written to disk yet
-            return ()
-        elif self._use_dirstate_v2:
-            return (
-                self._filename,
-                self._map.docket.data_filename(),
-            )
-        else:
-            return (self._filename,)
+        files = [b'branch']
+        if self._opener.exists(self._filename):
+            files.append(self._filename)
+            if self._use_dirstate_v2:
+                files.append(self._map.docket.data_filename())
+        return tuple(files)
 
     def verify(self, m1, m2, p1, narrow_matcher=None):
         """
         check the dirstate contents against the parent manifest and yield errors
         """
         missing_from_p1 = _(
             b"%s marked as tracked in p1 (%s) but not in manifest1\n"
         )
         unexpected_in_p1 = _(b"%s marked as added, but also in manifest1\n")
         missing_from_ps = _(
             b"%s marked as modified, but not in either manifest\n"
         )
         missing_from_ds = _(
             b"%s in manifest1, but not marked as tracked in p1 (%s)\n"
         )
         for f, entry in self.items():
             if entry.p1_tracked:
                 if entry.modified and f not in m1 and f not in m2:
                     yield missing_from_ps % f
                 elif f not in m1:
                     yield missing_from_p1 % (f, node.short(p1))
             if entry.added and f in m1:
                 yield unexpected_in_p1 % f
         for f in m1:
             if narrow_matcher is not None and not narrow_matcher(f):
                 continue
             entry = self.get_entry(f)
             if not entry.p1_tracked:
                 yield missing_from_ds % (f, node.short(p1))

mercurial/localrepo.py

@@ -1,3999 +1,3995 b''
 # localrepo.py - read/write repository class for mercurial
 # coding: utf-8
 #
 # Copyright 2005-2007 Olivia 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.
 
 
 import functools
 import os
 import random
 import re
 import sys
 import time
 import weakref
 
 from concurrent import futures
 from typing import (
     Optional,
 )
 
 from .i18n import _
 from .node import (
     bin,
     hex,
     nullrev,
     sha1nodeconstants,
     short,
 )
 from .pycompat import (
     delattr,
     getattr,
 )
 from . import (
     bookmarks,
     branchmap,
     bundle2,
     bundlecaches,
     changegroup,
     color,
     commit,
     context,
     dirstate,
     discovery,
     encoding,
     error,
     exchange,
     extensions,
     filelog,
     hook,
     lock as lockmod,
     match as matchmod,
     mergestate as mergestatemod,
     mergeutil,
     namespaces,
     narrowspec,
     obsolete,
     pathutil,
     phases,
     pushkey,
     pycompat,
     rcutil,
     repoview,
     requirements as requirementsmod,
     revlog,
     revset,
     revsetlang,
     scmutil,
     sparse,
     store as storemod,
     subrepoutil,
     tags as tagsmod,
     transaction,
     txnutil,
     util,
     vfs as vfsmod,
     wireprototypes,
 )
 
 from .interfaces import (
     repository,
     util as interfaceutil,
 )
 
 from .utils import (
     hashutil,
     procutil,
     stringutil,
     urlutil,
 )
 
 from .revlogutils import (
     concurrency_checker as revlogchecker,
     constants as revlogconst,
     sidedata as sidedatamod,
 )
 
 release = lockmod.release
 urlerr = util.urlerr
 urlreq = util.urlreq
 
 RE_SKIP_DIRSTATE_ROLLBACK = re.compile(
     b"^((dirstate|narrowspec.dirstate).*|branch$)"
 )
 
 # 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 changelogcache(storecache):
     """filecache for the changelog"""
 
     def __init__(self):
         super(changelogcache, self).__init__()
         _cachedfiles.add((b'00changelog.i', b''))
         _cachedfiles.add((b'00changelog.n', b''))
 
     def tracked_paths(self, obj):
         paths = [self.join(obj, b'00changelog.i')]
         if obj.store.opener.options.get(b'persistent-nodemap', False):
             paths.append(self.join(obj, b'00changelog.n'))
         return paths
 
 
 class manifestlogcache(storecache):
     """filecache for the manifestlog"""
 
     def __init__(self):
         super(manifestlogcache, self).__init__()
         _cachedfiles.add((b'00manifest.i', b''))
         _cachedfiles.add((b'00manifest.n', b''))
 
     def tracked_paths(self, obj):
         paths = [self.join(obj, b'00manifest.i')]
         if obj.store.opener.options.get(b'persistent-nodemap', False):
             paths.append(self.join(obj, b'00manifest.n'))
         return paths
 
 
 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"""
 
     @functools.wraps(orig)
     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:
     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 = 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, path=None):
         super(localpeer, self).__init__(repo.ui, path=path)
 
         if caps is None:
             caps = moderncaps.copy()
         self._repo = repo.filtered(b'served')
 
         if repo._wanted_sidedata:
             formatted = bundle2.format_remote_wanted_sidedata(repo)
             caps.add(b'exp-wanted-sidedata=' + formatted)
 
         self._caps = repo._restrictcapabilities(caps)
 
     # Begin of _basepeer interface.
 
     def url(self):
         return self._repo.url()
 
     def local(self):
         return self._repo
 
     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(bundlecaches.CB_MANIFEST_FILE)
 
     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,
         remote_sidedata=None,
         **kwargs
     ):
         chunks = exchange.getbundlechunks(
             self._repo,
             source,
             heads=heads,
             common=common,
             bundlecaps=bundlecaps,
             remote_sidedata=remote_sidedata,
             **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, path=None):
         super(locallegacypeer, self).__init__(repo, caps=legacycaps, path=path)
 
     # 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, ancestorsof=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, ancestorsof=heads
         )
         return changegroup.makechangegroup(self._repo, outgoing, b'01', source)
 
     # End of baselegacywirecommands interface.
 
 
 # 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 _getsharedvfs(hgvfs, requirements):
     """returns the vfs object pointing to root of shared source
     repo for a shared repository
 
     hgvfs is vfs pointing at .hg/ of current repo (shared one)
     requirements is a set of requirements of current repo (shared one)
     """
     # 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``.
     sharedpath = hgvfs.read(b'sharedpath').rstrip(b'\n')
     if requirementsmod.RELATIVE_SHARED_REQUIREMENT in requirements:
         sharedpath = util.normpath(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
         )
     return sharedvfs
 
 
 def _readrequires(vfs, allowmissing):
     """reads the require file present at root of this vfs
     and return a set of requirements
 
     If allowmissing is True, we suppress FileNotFoundError if raised"""
     # 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.
     read = vfs.tryread if allowmissing else vfs.read
     return set(read(b'requires').splitlines())
 
 
 def makelocalrepository(baseui, path: bytes, 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)
     # Whether this repository is shared one or not
     shared = False
     # If this repository is shared, vfs pointing to shared repo
     sharedvfs = None
 
     # The .hg/ path should exist and should be a directory. All other
     # cases are errors.
     if not hgvfs.isdir():
         try:
             hgvfs.stat()
         except FileNotFoundError:
             pass
         except ValueError as e:
             # Can be raised on Python 3.8 when path is invalid.
             raise error.Abort(
                 _(b'invalid path %s: %s') % (path, stringutil.forcebytestr(e))
             )
 
         raise error.RepoError(_(b'repository %s not found') % path)
 
     requirements = _readrequires(hgvfs, True)
     shared = (
         requirementsmod.SHARED_REQUIREMENT in requirements
         or requirementsmod.RELATIVE_SHARED_REQUIREMENT in requirements
     )
     storevfs = None
     if shared:
         # This is a shared repo
         sharedvfs = _getsharedvfs(hgvfs, requirements)
         storevfs = vfsmod.vfs(sharedvfs.join(b'store'))
     else:
         storevfs = vfsmod.vfs(hgvfs.join(b'store'))
 
     # if .hg/requires contains the sharesafe requirement, it means
     # there exists a `.hg/store/requires` too and we should read it
     # NOTE: presence of SHARESAFE_REQUIREMENT imply that store requirement
     # is present. We never write SHARESAFE_REQUIREMENT for a repo if store
     # is not present, refer checkrequirementscompat() for that
     #
     # However, if SHARESAFE_REQUIREMENT is not present, it means that the
     # repository was shared the old way. We check the share source .hg/requires
     # for SHARESAFE_REQUIREMENT to detect whether the current repository needs
     # to be reshared
     hint = _(b"see `hg help config.format.use-share-safe` for more information")
     if requirementsmod.SHARESAFE_REQUIREMENT in requirements:
         if (
             shared
             and requirementsmod.SHARESAFE_REQUIREMENT
             not in _readrequires(sharedvfs, True)
         ):
             mismatch_warn = ui.configbool(
                 b'share', b'safe-mismatch.source-not-safe.warn'
             )
             mismatch_config = ui.config(
                 b'share', b'safe-mismatch.source-not-safe'
             )
             mismatch_verbose_upgrade = ui.configbool(
                 b'share', b'safe-mismatch.source-not-safe:verbose-upgrade'
             )
             if mismatch_config in (
                 b'downgrade-allow',
                 b'allow',
                 b'downgrade-abort',
             ):
                 # prevent cyclic import localrepo -> upgrade -> localrepo
                 from . import upgrade
 
                 upgrade.downgrade_share_to_non_safe(
                     ui,
                     hgvfs,
                     sharedvfs,
                     requirements,
                     mismatch_config,
                     mismatch_warn,
                     mismatch_verbose_upgrade,
                 )
             elif mismatch_config == b'abort':
                 raise error.Abort(
                     _(b"share source does not support share-safe requirement"),
                     hint=hint,
                 )
             else:
                 raise error.Abort(
                     _(
                         b"share-safe mismatch with source.\nUnrecognized"
                         b" value '%s' of `share.safe-mismatch.source-not-safe`"
                         b" set."
                     )
                     % mismatch_config,
                     hint=hint,
                 )
         else:
             requirements |= _readrequires(storevfs, False)
     elif shared:
         sourcerequires = _readrequires(sharedvfs, False)
         if requirementsmod.SHARESAFE_REQUIREMENT in sourcerequires:
             mismatch_config = ui.config(b'share', b'safe-mismatch.source-safe')
             mismatch_warn = ui.configbool(
                 b'share', b'safe-mismatch.source-safe.warn'
             )
             mismatch_verbose_upgrade = ui.configbool(
                 b'share', b'safe-mismatch.source-safe:verbose-upgrade'
             )
             if mismatch_config in (
                 b'upgrade-allow',
                 b'allow',
                 b'upgrade-abort',
             ):
                 # prevent cyclic import localrepo -> upgrade -> localrepo
                 from . import upgrade
 
                 upgrade.upgrade_share_to_safe(
                     ui,
                     hgvfs,
                     storevfs,
                     requirements,
                     mismatch_config,
                     mismatch_warn,
                     mismatch_verbose_upgrade,
                 )
             elif mismatch_config == b'abort':
                 raise error.Abort(
                     _(
                         b'version mismatch: source uses share-safe'
                         b' functionality while the current share does not'
                     ),
                     hint=hint,
                 )
             else:
                 raise error.Abort(
                     _(
                         b"share-safe mismatch with source.\nUnrecognized"
                         b" value '%s' of `share.safe-mismatch.source-safe` set."
                     )
                     % mismatch_config,
                     hint=hint,
                 )
 
     # 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, sharedvfs):
         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. If `shared` or
     # `relshared` requirements are present, this indicates current repository
     # is a share and store exists in path mentioned in `.hg/sharedpath`
     if shared:
         storebasepath = sharedvfs.base
         cachepath = sharedvfs.join(b'cache')
         features.add(repository.REPO_FEATURE_SHARED_STORAGE)
     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)
 
     if (
         requirementsmod.REVLOGV2_REQUIREMENT in requirements
         or requirementsmod.CHANGELOGV2_REQUIREMENT in requirements
     ):
         features.add(repository.REPO_FEATURE_SIDE_DATA)
         # the revlogv2 docket introduced race condition that we need to fix
         features.discard(repository.REPO_FEATURE_STREAM_CLONE)
 
     # 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: vfsmod.vfs,
     hgvfs: vfsmod.vfs,
     requirements,
     sharedvfs: Optional[vfsmod.vfs] = None,
 ):
     """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.
 
     sharedvfs is vfs object pointing to source repo if the current one is a
     shared one
     """
     if not rcutil.use_repo_hgrc():
         return False
 
     ret = False
     # first load config from shared source if we has to
     if requirementsmod.SHARESAFE_REQUIREMENT in requirements and sharedvfs:
         try:
             ui.readconfig(sharedvfs.join(b'hgrc'), root=sharedvfs.base)
             ret = True
         except IOError:
             pass
 
     try:
         ui.readconfig(hgvfs.join(b'hgrc'), root=wdirvfs.base)
         ret = True
     except IOError:
         pass
 
     try:
         ui.readconfig(hgvfs.join(b'hgrc-not-shared'), root=wdirvfs.base)
         ret = True
     except IOError:
         pass
 
     return ret
 
 
 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(requirementsmod.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 (
         requirementsmod.SPARSE_REQUIREMENT 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 requirementsmod.STORE_REQUIREMENT in requirements:
         if requirementsmod.FNCACHE_REQUIREMENT in requirements:
             dotencode = requirementsmod.DOTENCODE_REQUIREMENT in requirements
             return storemod.fncachestore(path, vfstype, dotencode)
 
         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 requirementsmod.TREEMANIFEST_REQUIREMENT 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 (
         requirementsmod.REVLOGV1_REQUIREMENT in requirements
         or requirementsmod.REVLOGV2_REQUIREMENT in requirements
     ):
         options.update(resolverevlogstorevfsoptions(ui, requirements, features))
     else:  # explicitly mark repo as using revlogv0
         options[b'revlogv0'] = True
 
     if requirementsmod.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 requirementsmod.REVLOGV1_REQUIREMENT in requirements:
         options[b'revlogv1'] = True
     if requirementsmod.REVLOGV2_REQUIREMENT in requirements:
         options[b'revlogv2'] = True
     if requirementsmod.CHANGELOGV2_REQUIREMENT in requirements:
         options[b'changelogv2'] = True
         cmp_rank = ui.configbool(b'experimental', b'changelog-v2.compute-rank')
         options[b'changelogv2.compute-rank'] = cmp_rank
 
     if requirementsmod.GENERALDELTA_REQUIREMENT 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
     dps_cgds = ui.configint(
         b'storage',
         b'revlog.delta-parent-search.candidate-group-chunk-size',
     )
     options[b'delta-parent-search.candidate-group-chunk-size'] = dps_cgds
     options[b'debug-delta'] = ui.configbool(b'debug', b'revlog.debug-delta')
 
     issue6528 = ui.configbool(b'storage', b'revlog.issue6528.fix-incoming')
     options[b'issue6528.fix-incoming'] = issue6528
 
     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 = requirementsmod.SPARSEREVLOG_REQUIREMENT in requirements
     options[b'sparse-revlog'] = sparserevlog
     if sparserevlog:
         options[b'generaldelta'] = True
 
     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 requirementsmod.NARROW_REQUIREMENT in requirements:
         options[b'enableellipsis'] = True
 
     if ui.configbool(b'experimental', b'rust.index'):
         options[b'rust.index'] = True
     if requirementsmod.NODEMAP_REQUIREMENT in requirements:
         slow_path = ui.config(
             b'storage', b'revlog.persistent-nodemap.slow-path'
         )
         if slow_path not in (b'allow', b'warn', b'abort'):
             default = ui.config_default(
                 b'storage', b'revlog.persistent-nodemap.slow-path'
             )
             msg = _(
                 b'unknown value for config '
                 b'"storage.revlog.persistent-nodemap.slow-path": "%s"\n'
             )
             ui.warn(msg % slow_path)
             if not ui.quiet:
                 ui.warn(_(b'falling back to default value: %s\n') % default)
             slow_path = default
 
         msg = _(
             b"accessing `persistent-nodemap` repository without associated "
             b"fast implementation."
         )
         hint = _(
             b"check `hg help config.format.use-persistent-nodemap` "
             b"for details"
         )
         if not revlog.HAS_FAST_PERSISTENT_NODEMAP:
             if slow_path == b'warn':
                 msg = b"warning: " + msg + b'\n'
                 ui.warn(msg)
                 if not ui.quiet:
                     hint = b'(' + hint + b')\n'
                     ui.warn(hint)
             if slow_path == b'abort':
                 raise error.Abort(msg, hint=hint)
         options[b'persistent-nodemap'] = True
     if requirementsmod.DIRSTATE_V2_REQUIREMENT in requirements:
         slow_path = ui.config(b'storage', b'dirstate-v2.slow-path')
         if slow_path not in (b'allow', b'warn', b'abort'):
             default = ui.config_default(b'storage', b'dirstate-v2.slow-path')
             msg = _(b'unknown value for config "dirstate-v2.slow-path": "%s"\n')
             ui.warn(msg % slow_path)
             if not ui.quiet:
                 ui.warn(_(b'falling back to default value: %s\n') % default)
             slow_path = default
 
         msg = _(
             b"accessing `dirstate-v2` repository without associated "
             b"fast implementation."
         )
         hint = _(
             b"check `hg help config.format.use-dirstate-v2` " b"for details"
         )
         if not dirstate.HAS_FAST_DIRSTATE_V2:
             if slow_path == b'warn':
                 msg = b"warning: " + msg + b'\n'
                 ui.warn(msg)
                 if not ui.quiet:
                     hint = b'(' + hint + b')\n'
                     ui.warn(hint)
             if slow_path == b'abort':
                 raise error.Abort(msg, hint=hint)
     if ui.configbool(b'storage', b'revlog.persistent-nodemap.mmap'):
         options[b'persistent-nodemap.mmap'] = True
     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:
     """File storage when using revlogs."""
 
     def file(self, path):
         if path.startswith(b'/'):
             path = path[1:]
 
         return filelog.filelog(self.svfs, path)
 
 
 @interfaceutil.implementer(repository.ilocalrepositoryfilestorage)
 class revlognarrowfilestorage:
     """File storage when using revlogs and narrow files."""
 
     def file(self, path):
         if path.startswith(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 requirementsmod.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:
     """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.
     """
 
     _basesupported = {
         requirementsmod.ARCHIVED_PHASE_REQUIREMENT,
         requirementsmod.BOOKMARKS_IN_STORE_REQUIREMENT,
         requirementsmod.CHANGELOGV2_REQUIREMENT,
         requirementsmod.COPIESSDC_REQUIREMENT,
         requirementsmod.DIRSTATE_TRACKED_HINT_V1,
         requirementsmod.DIRSTATE_V2_REQUIREMENT,
         requirementsmod.DOTENCODE_REQUIREMENT,
         requirementsmod.FNCACHE_REQUIREMENT,
         requirementsmod.GENERALDELTA_REQUIREMENT,
         requirementsmod.INTERNAL_PHASE_REQUIREMENT,
         requirementsmod.NODEMAP_REQUIREMENT,
         requirementsmod.RELATIVE_SHARED_REQUIREMENT,
         requirementsmod.REVLOGV1_REQUIREMENT,
         requirementsmod.REVLOGV2_REQUIREMENT,
         requirementsmod.SHARED_REQUIREMENT,
         requirementsmod.SHARESAFE_REQUIREMENT,
         requirementsmod.SPARSE_REQUIREMENT,
         requirementsmod.SPARSEREVLOG_REQUIREMENT,
         requirementsmod.STORE_REQUIREMENT,
         requirementsmod.TREEMANIFEST_REQUIREMENT,
     }
 
     # 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 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: bytes,
         wdirvfs: vfsmod.vfs,
         hgvfs: vfsmod.vfs,
         requirements,
         supportedrequirements,
         sharedpath: bytes,
         store,
         cachevfs: vfsmod.vfs,
         wcachevfs: vfsmod.vfs,
         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.nodeconstants = sha1nodeconstants
         self.nullid = self.nodeconstants.nullid
         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 = {}
 
         self._dirstate = None
         # post-dirstate-status hooks
         self._postdsstatus = []
 
         self._pending_narrow_pats = None
         self._pending_narrow_pats_dirstate = None
 
         # 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 requirementsmod.COPIESSDC_REQUIREMENT in self.requirements:
             self.filecopiesmode = b'changeset-sidedata'
 
         self._wanted_sidedata = set()
         self._sidedata_computers = {}
         sidedatamod.set_sidedata_spec_for_repo(self)
 
     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")
             # path prefixes covered by 'lock'
             vfs_path_prefixes = (
                 b'journal.',
                 b'undo.',
                 b'strip-backup/',
                 b'cache/',
             )
             if any(path.startswith(prefix) for prefix in vfs_path_prefixes):
                 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))
         if self.ui.configbool(b'experimental', b'narrow'):
             caps.add(wireprototypes.NARROWCAP)
         return caps
 
     # 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, path=None):
         return localpeer(self, path=path)  # 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)
 
     @changelogcache()
     def changelog(repo):
         # load dirstate before changelog to avoid race see issue6303
         repo.dirstate.prefetch_parents()
         return repo.store.changelog(
             txnutil.mayhavepending(repo.root),
             concurrencychecker=revlogchecker.get_checker(repo.ui, b'changelog'),
         )
 
     @manifestlogcache()
     def manifestlog(self):
         return self.store.manifestlog(self, self._storenarrowmatch)
 
     @unfilteredpropertycache
     def dirstate(self):
         if self._dirstate is None:
             self._dirstate = self._makedirstate()
         else:
             self._dirstate.refresh()
         return self._dirstate
 
     def _makedirstate(self):
         """Extension point for wrapping the dirstate per-repo."""
         sparsematchfn = None
         if sparse.use_sparse(self):
             sparsematchfn = lambda: sparse.matcher(self)
         v2_req = requirementsmod.DIRSTATE_V2_REQUIREMENT
         th = requirementsmod.DIRSTATE_TRACKED_HINT_V1
         use_dirstate_v2 = v2_req in self.requirements
         use_tracked_hint = th in self.requirements
 
         return dirstate.dirstate(
             self.vfs,
             self.ui,
             self.root,
             self._dirstatevalidate,
             sparsematchfn,
             self.nodeconstants,
             use_dirstate_v2,
             use_tracked_hint=use_tracked_hint,
         )
 
     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 self.nullid
 
     @storecache(narrowspec.FILENAME)
     def narrowpats(self):
         """matcher patterns for this repository's narrowspec
 
         A tuple of (includes, excludes).
         """
         # the narrow management should probably move into its own object
         val = self._pending_narrow_pats
         if val is None:
             val = narrowspec.load(self)
         return val
 
     @storecache(narrowspec.FILENAME)
     def _storenarrowmatch(self):
         if requirementsmod.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 requirementsmod.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, self.nodeconstants.nullid),
             nullrev: (nullrev, self.nodeconstants.nullid),
             self.nullid: (nullrev, self.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 = self._quick_access_changeid_null.copy()
         cl = self.unfiltered().changelog
         for node in self.dirstate.parents():
             if node == self.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 != self.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.
         """
         if self.filtername in repoview.filter_has_wc:
             return self._quick_access_changeid_wc
         return self._quick_access_changeid_null
 
     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 range(*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) == self.nodeconstants.nodelen:
                 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) == 2 * self.nodeconstants.nodelen:
                 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"""
         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: bytes, *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: bytes, *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: bytes, 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) -> bytes:
         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:
             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 tags.items():
             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 alltags.items():
             if node != self.nullid:
                 tags[encoding.tolocal(name)] = node
         tags[b'tip'] = self.changelog.tip()
         tagtypes = {
             encoding.tolocal(name): value for (name, value) in tagtypes.items()
         }
         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 self.tags().items():
                 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 self._tagscache.tags.items():
                 nodetagscache.setdefault(n, []).append(t)
             for tags in nodetagscache.values():
                 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 register_changeset(self, rev, changelogrevision):
         self.revbranchcache().setdata(rev, changelogrevision)
 
     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: bytes, *insidef: bytes) -> bytes:
         return self.vfs.reljoin(self.root, f, *insidef)
 
     def setparents(self, p1, p2=None):
         if p2 is None:
             p2 = self.nullid
         self[None].setparents(p1, p2)
         self._quick_access_changeid_invalidate()
 
     def filectx(self, path: bytes, 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) -> bytes:
         return self.dirstate.getcwd()
 
     def pathto(self, f: bytes, cwd: Optional[bytes] = None) -> bytes:
         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 self._datafilters.items():
                     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: bytes) -> bytes:
         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: bytes,
         data: bytes,
         flags: bytes,
         backgroundclose=False,
         **kwargs
     ) -> int:
         """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: bytes, data: bytes) -> bytes:
         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"),
             )
 
         # At that point your dirstate should be clean:
         #
         # - If you don't have the wlock, why would you still have a dirty
         #   dirstate ?
         #
         # - If you hold the wlock, you should not be opening a transaction in
         #   the middle of a `distate.changing_*` block. The transaction needs to
         #   be open before that and wrap the change-context.
         #
         # - If you are not within a `dirstate.changing_*` context, why is our
         #   dirstate dirty?
         if self.dirstate._dirty:
             m = "cannot open a transaction with a dirty dirstate"
             raise error.ProgrammingError(m)
 
         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()
                 assert repo is not None  # help pytype
                 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()
             assert repo is not None  # help pytype
 
             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
                 )
                 if singleheadsub.get(b"public-changes-only", False):
                     filtername = b"immutable"
                 else:
                     filtername = b"visible"
                 scmutil.enforcesinglehead(
                     repo, tr2, desc, accountclosed, filtername
                 )
             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
                 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
         tr.hookargs[b'changes'] = tr.changes
         # 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()
                 assert repo is not None  # help pytype
 
                 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)
                 )
 
             repo = reporef()
             assert repo is not None  # help pytype
             repo._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"""
             repo = reporef()
             assert repo is not None  # help pytype
             repo.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)
         # This only exist to deal with the need of rollback to have viable
         # parents at the end of the operation. So backup viable parents at the
         # time of this operation.
         #
         # We only do it when the `wlock` is taken, otherwise other might be
         # altering the dirstate under us.
         #
         # This is really not a great way to do this (first, because we cannot
         # always do it). There are more viable alternative that exists
         #
         # - backing only the working copy parent in a dedicated files and doing
         #   a clean "keep-update" to them on `hg rollback`.
         #
         # - slightly changing the behavior an applying a logic similar to "hg
         # strip" to pick a working copy destination on `hg rollback`
         if self.currentwlock() is not None:
             ds = self.dirstate
-            if ds.branch() == b'default':
+            if not self.vfs.exists(b'branch'):
                 # force a file to be written if None exist
                 ds.setbranch(b'default', None)
-            # we cannot simply add "branch" to `all_file_names` because branch
-            # is written outside of the transaction control. So we need to
-            # backup early.
-            tr.addbackup(b"branch", hardlink=True, location=b'plain')
 
             def backup_dirstate(tr):
                 for f in ds.all_file_names():
                     # hardlink backup is okay because `dirstate` is always
                     # atomically written and possible data file are append only
                     # and resistant to trailing data.
                     tr.addbackup(f, hardlink=True, location=b'plain')
 
             tr.addvalidator(b'dirstate-backup', backup_dirstate)
         return tr
 
     def _journalfiles(self):
         return (
             (self.svfs, b'journal'),
             (self.vfs, b'journal.desc'),
         )
 
     def undofiles(self):
         return [(vfs, undoname(x)) for vfs, x in self._journalfiles()]
 
     @unfilteredmethod
     def _writejournal(self, desc):
         self.vfs.write(b"journal.desc", b"%d\n%s\n" % (len(self), desc))
 
     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 = None
         try:
             wlock = self.wlock()
             lock = self.lock()
             if self.svfs.exists(b"undo"):
                 return self._rollback(dryrun, force)
             else:
                 self.ui.warn(_(b"no rollback information available\n"))
                 return 1
         finally:
             release(lock, wlock)
 
     @unfilteredmethod  # Until we get smarter cache management
     def _rollback(self, dryrun, force):
         ui = self.ui
 
         parents = self.dirstate.parents()
         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)
             parentgone = any(self[p].rev() > oldtip for p in parents)
         except IOError:
             msg = _(b'rolling back unknown transaction\n')
             desc = None
             parentgone = True
 
         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
 
         self.destroying()
         vfsmap = {b'plain': self.vfs, b'': self.svfs}
         skip_journal_pattern = None
         if not parentgone:
             skip_journal_pattern = RE_SKIP_DIRSTATE_ROLLBACK
         transaction.rollback(
             self.svfs,
             vfsmap,
             b'undo',
             ui.warn,
             checkambigfiles=_cachedfiles,
             skip_journal_pattern=skip_journal_pattern,
         )
         self.invalidate()
         self.dirstate.invalidate()
 
         if parentgone:
             # replace this with some explicit parent update in the future.
             has_node = self.changelog.index.has_node
             if not all(has_node(p) for p in self.dirstate._pl):
                 # There was no dirstate to backup initially, we need to drop
                 # the existing one.
                 with self.dirstate.changing_parents(self):
                     self.dirstate.setparents(self.nullid)
                     self.dirstate.clear()
 
             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
                 )
             mergestatemod.mergestate.clean(self)
 
         # 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()
             assert repo is not None  # help pytype
             repo.updatecaches(tr)
 
         return updater
 
     @unfilteredmethod
     def updatecaches(self, tr=None, full=False, caches=None):
         """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.
 
         The `full` argument can take a special "post-clone" value. In this case
         the cache warming is made after a clone and of the slower cache might
         be skipped, namely the `.fnodetags` one. This argument is 5.8 specific
         as we plan for a cleaner way to deal with this for 5.9.
         """
         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
 
         unfi = self.unfiltered()
 
         if full:
             msg = (
                 "`full` argument for `repo.updatecaches` is deprecated\n"
                 "(use `caches=repository.CACHE_ALL` instead)"
             )
             self.ui.deprecwarn(msg, b"5.9")
             caches = repository.CACHES_ALL
             if full == b"post-clone":
                 caches = repository.CACHES_POST_CLONE
             caches = repository.CACHES_ALL
         elif caches is None:
             caches = repository.CACHES_DEFAULT
 
         if repository.CACHE_BRANCHMAP_SERVED in caches:
             if tr is None or tr.changes[b'origrepolen'] < len(self):
                 # accessing the 'served' 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()
                 # flush all possibly delayed write.
                 self._branchcaches.write_delayed(self)
 
         if repository.CACHE_CHANGELOG_CACHE in caches:
             self.changelog.update_caches(transaction=tr)
 
         if repository.CACHE_MANIFESTLOG_CACHE in caches:
             self.manifestlog.update_caches(transaction=tr)
 
         if repository.CACHE_REV_BRANCH in caches:
             rbc = unfi.revbranchcache()
             for r in unfi.changelog:
                 rbc.branchinfo(r)
             rbc.write()
 
         if repository.CACHE_FULL_MANIFEST in caches:
             # ensure the working copy parents are in the manifestfulltextcache
             for ctx in self[b'.'].parents():
                 ctx.manifest()  # accessing the manifest is enough
 
         if repository.CACHE_FILE_NODE_TAGS in caches:
             # accessing fnode cache warms the cache
             tagsmod.fnoderevs(self.ui, unfi, unfi.changelog.revs())
 
         if repository.CACHE_TAGS_DEFAULT in caches:
             # accessing tags warm the cache
             self.tags()
         if repository.CACHE_TAGS_SERVED in caches:
             self.filtered(b'served').tags()
 
         if repository.CACHE_BRANCHMAP_ALL in caches:
             # The CACHE_BRANCHMAP_ALL updates 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)."""
         unfi = self.unfiltered()
         if 'dirstate' in unfi.__dict__:
             del unfi.__dict__['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()):
             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,
     ):
         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,
             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 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() if self._wlockref else None
         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.is_changing_any:
                 msg = b"wlock release in the middle of a changing parents"
                 self.ui.develwarn(msg)
                 self.dirstate.invalidate()
             else:
                 if self.dirstate._dirty:
                     msg = b"dirty dirstate on wlock release"
                     self.ui.develwarn(msg)
                 self.dirstate.write(None)
 
             unfi = self.unfiltered()
             if 'dirstate' in unfi.__dict__:
                 del unfi.__dict__['dirstate']
 
         l = self._lock(
             self.vfs,
             b"wlock",
             wait,
             unlock,
             self.invalidatedirstate,
             _(b'working directory of %s') % self.origroot,
         )
         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 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.InputError(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 = mergestatemod.mergestate.read(self)
             mergeutil.checkunresolved(ms)
 
             # internal config: ui.allowemptycommit
             if cctx.isempty() and not self.ui.configbool(
                 b'ui', b'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.
             msg_path = 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 != self.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') % msg_path
                     )
                     self.ui.write(
                         _(
                             b"note: use 'hg commit --logfile "
                             b"%s --edit' to reuse it\n"
                         )
                         % msg_path
                     )
                 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):
         return commit.commitctx(self, ctx, error=error, origctx=origctx)
 
     @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] != self.nullid or p[0] == self.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 != self.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 :])
 
     def register_wanted_sidedata(self, category):
         if repository.REPO_FEATURE_SIDE_DATA not in self.features:
             # Only revlogv2 repos can want sidedata.
             return
         self._wanted_sidedata.add(pycompat.bytestr(category))
 
     def register_sidedata_computer(
         self, kind, category, keys, computer, flags, replace=False
     ):
         if kind not in revlogconst.ALL_KINDS:
             msg = _(b"unexpected revlog kind '%s'.")
             raise error.ProgrammingError(msg % kind)
         category = pycompat.bytestr(category)
         already_registered = category in self._sidedata_computers.get(kind, [])
         if already_registered and not replace:
             msg = _(
                 b"cannot register a sidedata computer twice for category '%s'."
             )
             raise error.ProgrammingError(msg % category)
         if replace and not already_registered:
             msg = _(
                 b"cannot replace a sidedata computer that isn't registered "
                 b"for category '%s'."
             )
             raise error.ProgrammingError(msg % category)
         self._sidedata_computers.setdefault(kind, {})
         self._sidedata_computers[kind][category] = (keys, computer, flags)
 
 
 # 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 FileNotFoundError:  # journal file does not yet exist
                 pass
 
     return a
 
 
 def undoname(fn: bytes) -> bytes:
     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: bytes, create, intents=None, createopts=None):
     # prevent cyclic import localrepo -> upgrade -> localrepo
     from . import upgrade
 
     localpath = urlutil.urllocalpath(path)
     if create:
         createrepository(ui, localpath, createopts=createopts)
 
     def repo_maker():
         return makelocalrepository(ui, localpath, intents=intents)
 
     repo = repo_maker()
     repo = upgrade.may_auto_upgrade(repo, repo_maker)
     return repo
 
 
 def islocal(path: bytes) -> bool:
     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 clone_requirements(ui, createopts, srcrepo):
     """clone the requirements of a local repo for a local clone
 
     The store requirements are unchanged while the working copy requirements
     depends on the configuration
     """
     target_requirements = set()
     if not srcrepo.requirements:
         # this is a legacy revlog "v0" repository, we cannot do anything fancy
         # with it.
         return target_requirements
     createopts = defaultcreateopts(ui, createopts=createopts)
     for r in newreporequirements(ui, createopts):
         if r in requirementsmod.WORKING_DIR_REQUIREMENTS:
             target_requirements.add(r)
 
     for r in srcrepo.requirements:
         if r not in requirementsmod.WORKING_DIR_REQUIREMENTS:
             target_requirements.add(r)
     return target_requirements
 
 
 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 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 = {requirementsmod.REVLOGV1_REQUIREMENT}
     if ui.configbool(b'format', b'usestore'):
         requirements.add(requirementsmod.STORE_REQUIREMENT)
         if ui.configbool(b'format', b'usefncache'):
             requirements.add(requirementsmod.FNCACHE_REQUIREMENT)
             if ui.configbool(b'format', b'dotencode'):
                 requirements.add(requirementsmod.DOTENCODE_REQUIREMENT)
 
     compengines = ui.configlist(b'format', b'revlog-compression')
     for compengine in compengines:
         if compengine in util.compengines:
             engine = util.compengines[compengine]
             if engine.available() and engine.revlogheader():
                 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(requirementsmod.GENERALDELTA_REQUIREMENT)
         if ui.configbool(b'format', b'sparse-revlog'):
             requirements.add(requirementsmod.SPARSEREVLOG_REQUIREMENT)
 
     # experimental config: format.use-dirstate-v2
     # Keep this logic in sync with `has_dirstate_v2()` in `tests/hghave.py`
     if ui.configbool(b'format', b'use-dirstate-v2'):
         requirements.add(requirementsmod.DIRSTATE_V2_REQUIREMENT)
 
     # experimental config: format.exp-use-copies-side-data-changeset
     if ui.configbool(b'format', b'exp-use-copies-side-data-changeset'):
         requirements.add(requirementsmod.CHANGELOGV2_REQUIREMENT)
         requirements.add(requirementsmod.COPIESSDC_REQUIREMENT)
     if ui.configbool(b'experimental', b'treemanifest'):
         requirements.add(requirementsmod.TREEMANIFEST_REQUIREMENT)
 
     changelogv2 = ui.config(b'format', b'exp-use-changelog-v2')
     if changelogv2 == b'enable-unstable-format-and-corrupt-my-data':
         requirements.add(requirementsmod.CHANGELOGV2_REQUIREMENT)
 
     revlogv2 = ui.config(b'experimental', b'revlogv2')
     if revlogv2 == b'enable-unstable-format-and-corrupt-my-data':
         requirements.discard(requirementsmod.REVLOGV1_REQUIREMENT)
         requirements.add(requirementsmod.REVLOGV2_REQUIREMENT)
     # experimental config: format.internal-phase
     if ui.configbool(b'format', b'use-internal-phase'):
         requirements.add(requirementsmod.INTERNAL_PHASE_REQUIREMENT)
 
     # experimental config: format.exp-archived-phase
     if ui.configbool(b'format', b'exp-archived-phase'):
         requirements.add(requirementsmod.ARCHIVED_PHASE_REQUIREMENT)
 
     if createopts.get(b'narrowfiles'):
         requirements.add(requirementsmod.NARROW_REQUIREMENT)
 
     if createopts.get(b'lfs'):
         requirements.add(b'lfs')
 
     if ui.configbool(b'format', b'bookmarks-in-store'):
         requirements.add(requirementsmod.BOOKMARKS_IN_STORE_REQUIREMENT)
 
     if ui.configbool(b'format', b'use-persistent-nodemap'):
         requirements.add(requirementsmod.NODEMAP_REQUIREMENT)
 
     # if share-safe is enabled, let's create the new repository with the new
     # requirement
     if ui.configbool(b'format', b'use-share-safe'):
         requirements.add(requirementsmod.SHARESAFE_REQUIREMENT)
 
     # if we are creating a share-repo¹  we have to handle requirement
     # differently.
     #
     # [1] (i.e. reusing the store from another repository, just having a
     # working copy)
     if b'sharedrepo' in createopts:
         source_requirements = set(createopts[b'sharedrepo'].requirements)
 
         if requirementsmod.SHARESAFE_REQUIREMENT not in source_requirements:
             # share to an old school repository, we have to copy the
             # requirements and hope for the best.
             requirements = source_requirements
         else:
             # We have control on the working copy only, so "copy" the non
             # working copy part over, ignoring previous logic.
             to_drop = set()
             for req in requirements:
                 if req in requirementsmod.WORKING_DIR_REQUIREMENTS:
                     continue
                 if req in source_requirements:
                     continue
                 to_drop.add(req)
             requirements -= to_drop
             requirements |= source_requirements
 
         if createopts.get(b'sharedrelative'):
             requirements.add(requirementsmod.RELATIVE_SHARED_REQUIREMENT)
         else:
             requirements.add(requirementsmod.SHARED_REQUIREMENT)
 
     if ui.configbool(b'format', b'use-dirstate-tracked-hint'):
         version = ui.configint(b'format', b'use-dirstate-tracked-hint.version')
         msg = _(b"ignoring unknown tracked key version: %d\n")
         hint = _(
             b"see `hg help config.format.use-dirstate-tracked-hint-version"
         )
         if version != 1:
             ui.warn(msg % version, hint=hint)
         else:
             requirements.add(requirementsmod.DIRSTATE_TRACKED_HINT_V1)
 
     return requirements
 
 
 def checkrequirementscompat(ui, requirements):
     """Checks compatibility of repository requirements enabled and disabled.
 
     Returns a set of requirements which needs to be dropped because dependend
     requirements are not enabled. Also warns users about it"""
 
     dropped = set()
 
     if requirementsmod.STORE_REQUIREMENT not in requirements:
         if requirementsmod.BOOKMARKS_IN_STORE_REQUIREMENT in requirements:
             ui.warn(
                 _(
                     b'ignoring enabled \'format.bookmarks-in-store\' config '
                     b'beacuse it is incompatible with disabled '
                     b'\'format.usestore\' config\n'
                 )
             )
             dropped.add(requirementsmod.BOOKMARKS_IN_STORE_REQUIREMENT)
 
         if (
             requirementsmod.SHARED_REQUIREMENT in requirements
             or requirementsmod.RELATIVE_SHARED_REQUIREMENT in requirements
         ):
             raise error.Abort(
                 _(
                     b"cannot create shared repository as source was created"
                     b" with 'format.usestore' config disabled"
                 )
             )
 
         if requirementsmod.SHARESAFE_REQUIREMENT in requirements:
             if ui.hasconfig(b'format', b'use-share-safe'):
                 msg = _(
                     b"ignoring enabled 'format.use-share-safe' config because "
                     b"it is incompatible with disabled 'format.usestore'"
                     b" config\n"
                 )
                 ui.warn(msg)
             dropped.add(requirementsmod.SHARESAFE_REQUIREMENT)
 
     return dropped
 
 
 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: bytes, createopts=None, requirements=None):
     """Create a new repository in a vfs.
 
     ``path`` path to the new repo's working directory.
     ``createopts`` options for the new repository.
     ``requirement`` predefined set of requirements.
                     (incompatible with ``createopts``)
 
     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).
     """
 
     if requirements is not None:
         if createopts is not None:
             msg = b'cannot specify both createopts and requirements'
             raise error.ProgrammingError(msg)
         createopts = {}
     else:
         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)
         requirements -= checkrequirementscompat(ui, requirements)
 
     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)
                 sharedpath = util.pconvert(sharedpath)
             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')
 
     has_store = requirementsmod.STORE_REQUIREMENT in requirements
     if has_store 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 65535, which won't be recognized by
         # such old clients.
         hgvfs.append(
             b'00changelog.i',
             b'\0\0\xFF\xFF dummy changelog to prevent using the old repo '
             b'layout',
         )
 
     # Filter the requirements into working copy and store ones
     wcreq, storereq = scmutil.filterrequirements(requirements)
     # write working copy ones
     scmutil.writerequires(hgvfs, wcreq)
     # If there are store requirements and the current repository
     # is not a shared one, write stored requirements
     # For new shared repository, we don't need to write the store
     # requirements as they are already present in store requires
     if storereq and b'sharedrepo' not in createopts:
         storevfs = vfsmod.vfs(hgvfs.join(b'store'), cacheaudited=True)
         scmutil.writerequires(storevfs, storereq)
 
     # 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:
         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)