sapling/eden/scm/edenscm/vfs.py

850 lines
29 KiB
Python
Raw Normal View History

# Portions Copyright (c) Meta Platforms, Inc. and affiliates.
#
# This software may be used and distributed according to the terms of the
# GNU General Public License version 2.
# vfs.py - Mercurial 'vfs' classes
#
# Copyright Olivia Mackall <olivia@selenic.com>
#
# This software may be used and distributed according to the terms of the
# GNU General Public License version 2 or any later version.
from __future__ import absolute_import
import abc
import contextlib
import errno
import os
import re
import shutil
import stat
import tempfile
import threading
import typing
from typing import (
Any,
BinaryIO,
Callable,
ContextManager,
IO,
Iterable,
List,
Optional,
Tuple,
Union,
)
from . import encoding, error, pathutil, pycompat, util
from .i18n import _
from .pycompat import decodeutf8, encodeutf8
def _avoidambig(path, oldstat):
"""Avoid file stat ambiguity forcibly
This function causes copying ``path`` file, if it is owned by
another (see issue5418 and issue5584 for detail).
"""
def checkandavoid():
newstat = util.filestat.frompath(path)
# return whether file stat ambiguity is (already) avoided
return not newstat.isambig(oldstat) or newstat.avoidambig(path, oldstat)
if not checkandavoid():
# simply copy to change owner of path to get privilege to
# advance mtime (see issue5418)
util.rename(util.mktempcopy(path), path)
checkandavoid()
class abstractvfs(pycompat.ABC):
"""Abstract base class; cannot be instantiated"""
_backgroundfilecloser: "Optional[backgroundfilecloser]" = None
def __init__(self, *args, **kwargs):
"""Prevent instantiation; don't call this from subclasses."""
raise NotImplementedError("attempted instantiating " + str(type(self)))
@abc.abstractmethod
def __call__(
self,
path: str,
mode: str = "r",
text: bool = False,
atomictemp: bool = False,
notindexed: bool = False,
backgroundclose: bool = False,
checkambig: bool = False,
auditpath: bool = True,
) -> "BinaryIO":
raise NotImplementedError("must be implemented by subclasses")
@abc.abstractmethod
def join(self, path: "Optional[str]", *insidef: str) -> str:
raise NotImplementedError("must be implemented by subclasses")
def tryread(self, path):
"""gracefully return an empty string for missing files"""
try:
return self.read(path)
except IOError as inst:
if inst.errno != errno.ENOENT:
raise
return b""
def tryreadutf8(self, path):
return decodeutf8(self.tryread(path))
def tryreadlines(self, path, mode="rb"):
"""gracefully return an empty array for missing files"""
try:
return self.readlines(path, mode=mode)
except IOError as inst:
if inst.errno != errno.ENOENT:
raise
return []
@util.propertycache
def open(
self,
) -> "Callable[[str, str, bool, bool, bool, bool, bool, bool], BinaryIO]":
"""Open ``path`` file, which is relative to vfs root.
Newly created directories are marked as "not to be indexed by
the content indexing service", if ``notindexed`` is specified
for "write" mode access.
"""
return self.__call__
def read(self, path: str) -> bytes:
with self(path, "rb") as fp:
return fp.read()
def readutf8(self, path: str) -> str:
return decodeutf8(self.read(path))
def readlines(self, path: str, mode: str = "rb") -> "List[bytes]":
with self(path, mode=mode) as fp:
return fp.readlines()
def write(self, path: str, data: bytes, backgroundclose: bool = False) -> int:
with self(path, "wb", backgroundclose=backgroundclose) as fp:
return fp.write(data)
def writeutf8(self, path: str, data: str) -> None:
self.write(path, encodeutf8(data))
def writelines(
self, path: str, data: "List[bytes]", mode: str = "wb", notindexed: bool = False
) -> None:
with self(path, mode=mode, notindexed=notindexed) as fp:
return fp.writelines(data)
def append(self, path: str, data: bytes) -> int:
with self(path, "ab") as fp:
return fp.write(data)
def basename(self, path: str) -> str:
"""return base element of a path (as os.path.basename would do)
This exists to allow handling of strange encoding if needed."""
return os.path.basename(path)
def chmod(self, path: str, mode: int) -> None:
return os.chmod(self.join(path), mode)
def dirname(self, path: str) -> str:
"""return dirname element of a path (as os.path.dirname would do)
This exists to allow handling of strange encoding if needed."""
return os.path.dirname(path)
def exists(self, path: "Optional[str]" = None) -> bool:
return os.path.exists(self.join(path))
def fstat(self, fp: "IO") -> "util.wrapped_stat_result":
return util.fstat(fp)
def isdir(self, path: "Optional[str]" = None) -> bool:
return os.path.isdir(self.join(path))
def isfile(self, path: "Optional[str]" = None) -> bool:
return os.path.isfile(self.join(path))
def islink(self, path: "Optional[str]" = None) -> bool:
return os.path.islink(self.join(path))
def isexec(self, path: "Optional[str]" = None) -> bool:
return util.isexec(self.join(path))
def isfileorlink(self, path: "Optional[str]" = None) -> bool:
"""return whether path is a regular file or a symlink
Unlike isfile, this doesn't follow symlinks."""
try:
st = self.lstat(path)
except OSError:
return False
mode = st.st_mode
return stat.S_ISREG(mode) or stat.S_ISLNK(mode)
def reljoin(self, *paths: str) -> str:
"""join various elements of a path together (as os.path.join would do)
The vfs base is not injected so that path stay relative. This exists
to allow handling of strange encoding if needed."""
return os.path.join(*paths)
def split(self, path: str) -> "Tuple[str, str]":
"""split top-most element of a path (as os.path.split would do)
This exists to allow handling of strange encoding if needed."""
return os.path.split(path)
def lexists(self, path: "Optional[str]" = None) -> bool:
return os.path.lexists(self.join(path))
def lstat(self, path: "Optional[str]" = None) -> "util.wrapped_stat_result":
return util.lstat(self.join(path))
def listdir(self, path: "Optional[str]" = None) -> "List[str]":
return os.listdir(self.join(path))
def makedir(self, path: "Optional[str]" = None, notindexed: bool = True) -> None:
return util.makedir(self.join(path), notindexed)
def makedirs(
self, path: "Optional[str]" = None, mode: "Optional[int]" = None
) -> None:
return util.makedirs(self.join(path), mode)
def makelock(
self, info: str, path: str, checkdeadlock: bool = True
) -> "Optional[int]":
return util.makelock(info, self.join(path), checkdeadlock=checkdeadlock)
def mkdir(self, path: "Optional[str]" = None) -> None:
return os.mkdir(self.join(path))
def mkstemp(
self,
suffix: str = "",
prefix: str = "tmp",
dir: "Optional[str]" = None,
text: bool = False,
) -> "Tuple[int, str]":
fd, name = tempfile.mkstemp(
suffix=suffix, prefix=prefix, dir=self.join(dir), text=text
)
dname, fname = util.split(name)
if dir:
return fd, os.path.join(dir, fname)
else:
return fd, fname
def readdir(
self,
path: "Optional[str]" = None,
stat: "Optional[bool]" = None,
skip: "Optional[str]" = None,
) -> "List[str]":
# pyre-fixme[7]: Expected `List[str]` but got `Union[List[Tuple[str, int]],
# List[Tuple[str, int, stat]]]`.
return util.listdir(self.join(path), stat, skip)
def readlock(self, path: "Optional[str]") -> str:
return util.readlock(self.join(path))
def rename(self, src: str, dst: str, checkambig: bool = False) -> None:
"""Rename from src to dst
checkambig argument is used with util.filestat, and is useful
only if destination file is guarded by any lock
(e.g. repo.lock or repo.wlock).
To avoid file stat ambiguity forcibly, checkambig=True involves
copying ``src`` file, if it is owned by another. Therefore, use
checkambig=True only in limited cases (see also issue5418 and
issue5584 for detail).
"""
vfs: create copy at renaming to avoid file stat ambiguity if needed In order to fix issue5418, 0d920bcb0fd1 made vfs.rename(checkambig=True) omit advancing mtime of renamed file, if renamed file is owned by another (EPERM is raised in this case). But this omission causes rewinding mtime at restoration in such situation, and makes avoiding file stat ambiguity difficult, because ExactCacheValidationPlan assumes that mtime should be advanced, if a file is changed in same ctime. https://www.mercurial-scm.org/wiki/ExactCacheValidationPlan Ambiguity of file stat also requires issue5584 to be fixed with other than file stat, but "hash of file", "generation ID" and so on were already rejected ideas (please see original RFC linked from "Outline of issue" in ExactCacheValidationPlan page). This omission occurs: - only for non append-only files (dirstate, bookmarks, and phaseroots), and - only if previous transaction is rollbacked by another user The latter means "sharing a repository clone via group permission". This is reasonable usecase, but not ordinary for many users, IMHO. "hg rollback" itself has been deprecated since Mercurial 2.7, too. Therefore, increasing the cost at rollbacking previous transaction executed by another a little seems reasonable, for avoidance of file stat ambiguity. This patch does: - create copy of (already renamed) source file, if advancing mtime fails for EPERM - rename from copied file to destination file, and - advance mtime of renamed file, which is now owned by current user This patch also factors "self.join(src)" out to reduce redundancy.
2017-06-09 06:58:18 +03:00
srcpath = self.join(src)
dstpath = self.join(dst)
oldstat = checkambig and util.filestat.frompath(dstpath)
if oldstat and oldstat.stat:
ret = util.rename(srcpath, dstpath)
_avoidambig(dstpath, oldstat)
return ret
vfs: create copy at renaming to avoid file stat ambiguity if needed In order to fix issue5418, 0d920bcb0fd1 made vfs.rename(checkambig=True) omit advancing mtime of renamed file, if renamed file is owned by another (EPERM is raised in this case). But this omission causes rewinding mtime at restoration in such situation, and makes avoiding file stat ambiguity difficult, because ExactCacheValidationPlan assumes that mtime should be advanced, if a file is changed in same ctime. https://www.mercurial-scm.org/wiki/ExactCacheValidationPlan Ambiguity of file stat also requires issue5584 to be fixed with other than file stat, but "hash of file", "generation ID" and so on were already rejected ideas (please see original RFC linked from "Outline of issue" in ExactCacheValidationPlan page). This omission occurs: - only for non append-only files (dirstate, bookmarks, and phaseroots), and - only if previous transaction is rollbacked by another user The latter means "sharing a repository clone via group permission". This is reasonable usecase, but not ordinary for many users, IMHO. "hg rollback" itself has been deprecated since Mercurial 2.7, too. Therefore, increasing the cost at rollbacking previous transaction executed by another a little seems reasonable, for avoidance of file stat ambiguity. This patch does: - create copy of (already renamed) source file, if advancing mtime fails for EPERM - rename from copied file to destination file, and - advance mtime of renamed file, which is now owned by current user This patch also factors "self.join(src)" out to reduce redundancy.
2017-06-09 06:58:18 +03:00
return util.rename(srcpath, dstpath)
def readlink(self, path: str) -> str:
return os.readlink(self.join(path))
def removedirs(self, path: "Optional[str]" = None) -> None:
"""Remove a leaf directory and all empty intermediate ones"""
return util.removedirs(self.join(path))
def rmtree(
self,
path: "Optional[str]" = None,
ignore_errors: bool = False,
forcibly: bool = False,
) -> None:
"""Remove a directory tree recursively
If ``forcibly``, this tries to remove READ-ONLY files, too.
"""
if forcibly:
def onerror(function, path, excinfo):
if function is not os.remove:
raise
# read-only files cannot be unlinked under Windows
s = os.stat(path)
if (s.st_mode & stat.S_IWRITE) != 0:
raise
os.chmod(path, stat.S_IMODE(s.st_mode) | stat.S_IWRITE)
os.remove(path)
else:
onerror = None
return shutil.rmtree(
self.join(path), ignore_errors=ignore_errors, onerror=onerror
)
def setflags(self, path: str, l: bool, x: bool) -> None:
return util.setflags(self.join(path), l, x)
def stat(self, path: "Optional[str]" = None) -> "util.wrapped_stat_result":
return util.stat(self.join(path))
def unlink(self, path: "Optional[str]" = None) -> None:
return util.unlink(self.join(path))
def tryunlink(self, path: "Optional[str]" = None) -> None:
"""Attempt to remove a file, ignoring missing file errors."""
util.tryunlink(self.join(path))
def unlinkpath(
self, path: "Optional[str]" = None, ignoremissing: bool = False
) -> None:
2015-01-14 03:15:26 +03:00
return util.unlinkpath(self.join(path), ignoremissing=ignoremissing)
def utime(self, path=None, t=None):
return os.utime(self.join(path), t)
def walk(
self,
path: "Optional[str]" = None,
onerror: "Optional[Callable[[OSError], None]]" = None,
) -> "Iterable[Tuple[str, List[str], List[str]]]":
"""Yield (dirpath, dirs, files) tuple for each directories under path
``dirpath`` is relative one from the root of this vfs. This
uses ``os.sep`` as path separator, even you specify POSIX
style ``path``.
"The root of this vfs" is represented as empty ``dirpath``.
"""
root = os.path.normpath(self.join(None))
# when dirpath == root, dirpath[prefixlen:] becomes empty
# because len(dirpath) < prefixlen.
prefixlen = len(pathutil.normasprefix(root))
for dirpath, dirs, files in os.walk(self.join(path), onerror=onerror):
yield (dirpath[prefixlen:], dirs, files)
@contextlib.contextmanager
def backgroundclosing(
self, ui: "Any", expectedcount: int = -1
) -> "ContextManager[backgroundfilecloser]":
"""Allow files to be closed asynchronously.
When this context manager is active, ``backgroundclose`` can be passed
to ``__call__``/``open`` to result in the file possibly being closed
asynchronously, on a background thread.
"""
# Sharing backgroundfilecloser between threads is complex and using
# multiple instances puts us at risk of running out of file descriptors
# only allow to use backgroundfilecloser when in main thread.
if not isinstance(
# pyre isn't aware of threading._MainThread
# Once we are Python 3 only we should switch to threading.main_thread()
threading.currentThread(),
threading._MainThread, # pyre-fixme
):
# pyre-fixme[7]: Expected `ContextManager[backgroundfilecloser]` but got
# `Generator[None, None, None]`.
yield
# pyre-fixme[7]: Expected `ContextManager[backgroundfilecloser]` but got
# `Generator[typing.Any, typing.Any, None]`.
return
vfs = getattr(self, "vfs", self)
if vfs._backgroundfilecloser is not None:
raise error.Abort(_("can only have 1 active background file closer"))
with backgroundfilecloser(ui, expectedcount=expectedcount) as bfc:
try:
vfs._backgroundfilecloser = bfc
# pyre-fixme[7]: Expected `ContextManager[backgroundfilecloser]` but
# got `Generator[typing.Any, None, None]`.
yield bfc
finally:
vfs._backgroundfilecloser = None
class vfs(abstractvfs):
"""Operate files relative to a base directory
This class is used to hide the details of COW semantics and
remote file access from higher level code.
pathauditor: disable cache of audited paths by default (issue5628) The initial attempt was to discard cache when appropriate, but it appears to be error prone. We had to carefully inspect all places where audit() is called e.g. without actually updating filesystem, before removing files and directories, etc. So, this patch disables the cache of audited paths by default, and enables it only for the following cases: - short-lived auditor objects - repo.vfs, repo.svfs, and repo.cachevfs, which are managed directories and considered sort of append-only (a file/directory would never be replaced with a symlink) There would be more cacheable vfs objects (e.g. mq.queue.opener), but I decided not to inspect all of them in this patch. We can make them cached later. Benchmark result: - using old clone of http://selenic.com/repo/linux-2.6/ (38319 files) - on tmpfs - run HGRCPATH=/dev/null hg up -q --time tip && hg up -q null - try 4 times and take the last three results original: real 7.480 secs (user 1.140+22.760 sys 0.150+1.690) real 8.010 secs (user 1.070+22.280 sys 0.170+2.120) real 7.470 secs (user 1.120+22.390 sys 0.120+1.910) clearcache (the other series): real 7.680 secs (user 1.120+23.420 sys 0.140+1.970) real 7.670 secs (user 1.110+23.620 sys 0.130+1.810) real 7.740 secs (user 1.090+23.510 sys 0.160+1.940) enable cache only for vfs and svfs (this series): real 8.730 secs (user 1.500+25.190 sys 0.260+2.260) real 8.750 secs (user 1.490+25.170 sys 0.250+2.340) real 9.010 secs (user 1.680+25.340 sys 0.280+2.540) remove cache function at all (for reference): real 9.620 secs (user 1.440+27.120 sys 0.250+2.980) real 9.420 secs (user 1.400+26.940 sys 0.320+3.130) real 9.760 secs (user 1.530+27.270 sys 0.250+2.970)
2017-07-26 16:10:15 +03:00
'cacheaudited' should be enabled only if (a) vfs object is short-lived, or
(b) the base directory is managed by hg and considered sort-of append-only.
See pathutil.pathauditor() for details.
"""
def __init__(
self,
base: str,
audit: bool = True,
cacheaudited: bool = False,
expandpath: bool = False,
realpath: bool = False,
) -> None:
if expandpath:
base = util.expandpath(base)
if realpath:
base = os.path.realpath(base)
self.base = base
self._audit = audit
if audit:
pathauditor: disable cache of audited paths by default (issue5628) The initial attempt was to discard cache when appropriate, but it appears to be error prone. We had to carefully inspect all places where audit() is called e.g. without actually updating filesystem, before removing files and directories, etc. So, this patch disables the cache of audited paths by default, and enables it only for the following cases: - short-lived auditor objects - repo.vfs, repo.svfs, and repo.cachevfs, which are managed directories and considered sort of append-only (a file/directory would never be replaced with a symlink) There would be more cacheable vfs objects (e.g. mq.queue.opener), but I decided not to inspect all of them in this patch. We can make them cached later. Benchmark result: - using old clone of http://selenic.com/repo/linux-2.6/ (38319 files) - on tmpfs - run HGRCPATH=/dev/null hg up -q --time tip && hg up -q null - try 4 times and take the last three results original: real 7.480 secs (user 1.140+22.760 sys 0.150+1.690) real 8.010 secs (user 1.070+22.280 sys 0.170+2.120) real 7.470 secs (user 1.120+22.390 sys 0.120+1.910) clearcache (the other series): real 7.680 secs (user 1.120+23.420 sys 0.140+1.970) real 7.670 secs (user 1.110+23.620 sys 0.130+1.810) real 7.740 secs (user 1.090+23.510 sys 0.160+1.940) enable cache only for vfs and svfs (this series): real 8.730 secs (user 1.500+25.190 sys 0.260+2.260) real 8.750 secs (user 1.490+25.170 sys 0.250+2.340) real 9.010 secs (user 1.680+25.340 sys 0.280+2.540) remove cache function at all (for reference): real 9.620 secs (user 1.440+27.120 sys 0.250+2.980) real 9.420 secs (user 1.400+26.940 sys 0.320+3.130) real 9.760 secs (user 1.530+27.270 sys 0.250+2.970)
2017-07-26 16:10:15 +03:00
self.audit = pathutil.pathauditor(self.base, cached=cacheaudited)
else:
self.audit = lambda path, mode=None: True
self.createmode = None
self._trustnlink = None
@util.propertycache
def _cansymlink(self) -> bool:
return util.checklink(self.base)
@util.propertycache
def _chmod(self) -> bool:
return util.checkexec(self.base)
def _fixfilemode(self, name: str) -> None:
if self.createmode is None or not self._chmod:
return
os.chmod(name, typing.cast(int, self.createmode) & 0o666)
def __call__(
self,
path: str,
mode: str = "r",
text: bool = False,
atomictemp: bool = False,
notindexed: bool = False,
backgroundclose: bool = False,
checkambig: bool = False,
auditpath: bool = True,
) -> "BinaryIO":
"""Open ``path`` file, which is relative to vfs root.
Newly created directories are marked as "not to be indexed by
the content indexing service", if ``notindexed`` is specified
for "write" mode access.
If ``backgroundclose`` is passed, the file may be closed asynchronously.
It can only be used if the ``self.backgroundclosing()`` context manager
is active. This should only be specified if the following criteria hold:
1. There is a potential for writing thousands of files. Unless you
are writing thousands of files, the performance benefits of
asynchronously closing files is not realized.
2. Files are opened exactly once for the ``backgroundclosing``
active duration and are therefore free of race conditions between
closing a file on a background thread and reopening it. (If the
file were opened multiple times, there could be unflushed data
because the original file handle hasn't been flushed/closed yet.)
``checkambig`` argument is passed to atomictemplfile (valid
only for writing), and is useful only if target file is
guarded by any lock (e.g. repo.lock or repo.wlock).
To avoid file stat ambiguity forcibly, checkambig=True involves
copying ``path`` file opened in "append" mode (e.g. for
truncation), if it is owned by another. Therefore, use
combination of append mode and checkambig=True only in limited
cases (see also issue5418 and issue5584 for detail).
"""
assert isinstance(path, str)
assert isinstance(mode, str)
if auditpath:
if self._audit:
r = util.checkosfilename(path)
if r:
raise error.Abort("%s: %r" % (r, path))
self.audit(path, mode=mode)
f = self.join(path)
if not text and "b" not in mode:
mode += "b" # for that other OS
nlink = -1
if mode not in ("r", "rb"):
dirname, basename = util.split(f)
# If basename is empty, then the path is malformed because it points
# to a directory. Let the posixfile() call below raise IOError.
if basename:
if atomictemp:
util.makedirs(dirname, self.createmode, notindexed)
return util.atomictempfile(
f, mode, self.createmode, checkambig=checkambig
)
try:
if "w" in mode:
util.unlink(f)
nlink = 0
else:
# nlinks() may behave differently for files on Windows
# shares if the file is open.
with util.posixfile(f):
nlink = util.nlinks(f)
if nlink < 1:
nlink = 2 # force mktempcopy (issue1922)
except (OSError, IOError) as e:
if e.errno != errno.ENOENT:
raise
nlink = 0
util.makedirs(dirname, self.createmode, notindexed)
if nlink > 0:
if self._trustnlink is None:
self._trustnlink = nlink > 1 or util.checknlink(f)
if nlink > 1 or not self._trustnlink:
util.rename(util.mktempcopy(f), f)
fp = util.posixfile(f, mode)
if nlink == 0:
self._fixfilemode(f)
if checkambig:
if mode in ("r", "rb"):
raise error.Abort(
_(
"implementation error: mode %s is not"
" valid for checkambig=True"
)
% mode
)
fp = checkambigatclosing(fp)
if backgroundclose and isinstance(
threading.currentThread(), threading._MainThread # pyre-fixme
):
if not self._backgroundfilecloser:
raise error.Abort(
_(
"backgroundclose can only be used when a "
"backgroundclosing context manager is active"
)
)
fp = delayclosedfile(fp, self._backgroundfilecloser)
# pyre-fixme[7]: Expected `BinaryIO` but got `Union[IO[typing.Any],
# checkambigatclosing, delayclosedfile]`.
return fp
def symlink(self, src: "Union[bytes, str]", dst: str) -> None:
self.audit(dst)
linkname = self.join(dst)
2017-03-21 16:50:28 +03:00
util.tryunlink(linkname)
util.makedirs(os.path.dirname(linkname), self.createmode)
if self._cansymlink:
try:
os.symlink(src, linkname)
except OSError as err:
raise OSError(
err.errno,
_("could not symlink to %r: %s")
% (src, encoding.strtolocal(err.strerror)),
linkname,
)
else:
if isinstance(src, str):
self.writeutf8(dst, src)
else:
self.write(dst, src)
def join(self, path: "Optional[str]", *insidef: str) -> str:
if path:
return os.path.join(self.base, path, *insidef)
else:
return self.base
opener = vfs
class proxyvfs(object):
def __init__(self, vfs: "abstractvfs") -> None:
self.vfs = vfs
@property
def options(self):
return self.vfs.options
@options.setter
def options(self, value):
self.vfs.options = value
class filtervfs(abstractvfs, proxyvfs):
"""Wrapper vfs for filtering filenames with a function."""
def __init__(self, vfs: "abstractvfs", filter: "Callable[[str], str]") -> None:
proxyvfs.__init__(self, vfs)
self._filter = filter
def __call__(self, path, *args, **kwargs):
return self.vfs(self._filter(path), *args, **kwargs)
def join(self, path: "Optional[str]", *insidef: str) -> str:
if path:
return self.vfs.join(self._filter(self.vfs.reljoin(path, *insidef)))
else:
return self.vfs.join(path)
filteropener = filtervfs
class readonlyvfs(abstractvfs, proxyvfs):
"""Wrapper vfs preventing any writing."""
def __init__(self, vfs):
proxyvfs.__init__(self, vfs)
def __call__(
self, path: str, mode: str = "r", *args: bool, **kw: bool
) -> "BinaryIO":
if mode not in ("r", "rb"):
raise error.Abort(_("this vfs is read only"))
return self.vfs(path, mode, *args, **kw)
def join(self, path: "Optional[str]", *insidef: str) -> str:
return self.vfs.join(path, *insidef)
class closewrapbase(object):
"""Base class of wrapper, which hooks closing
Do not instantiate outside of the vfs layer.
"""
def __init__(self, fh):
object.__setattr__(self, r"_origfh", fh)
def __getattr__(self, attr):
return getattr(self._origfh, attr)
def __setattr__(self, attr, value):
return setattr(self._origfh, attr, value)
def __delattr__(self, attr):
return delattr(self._origfh, attr)
def __enter__(self):
return self._origfh.__enter__()
def __exit__(self, exc_type, exc_value, exc_tb):
raise NotImplementedError("attempted instantiating " + str(type(self)))
def close(self):
raise NotImplementedError("attempted instantiating " + str(type(self)))
class delayclosedfile(closewrapbase):
"""Proxy for a file object whose close is delayed.
Do not instantiate outside of the vfs layer.
"""
def __init__(self, fh, closer):
super(delayclosedfile, self).__init__(fh)
object.__setattr__(self, r"_closer", closer)
def __exit__(self, exc_type, exc_value, exc_tb):
self._closer.close(self._origfh)
def close(self):
self._closer.close(self._origfh)
class backgroundfilecloser(object):
"""Coordinates background closing of file handles on multiple threads."""
def __init__(self, ui, expectedcount=-1):
self._running = False
self._entered = False
self._threads = []
self._threadexception = None
# Only Windows/NTFS has slow file closing. So only enable by default
# on that platform. But allow to be enabled elsewhere for testing.
defaultenabled = pycompat.iswindows
enabled = ui.configbool("worker", "backgroundclose", defaultenabled)
if not enabled:
return
# There is overhead to starting and stopping the background threads.
# Don't do background processing unless the file count is large enough
# to justify it.
minfilecount = ui.configint("worker", "backgroundcloseminfilecount")
# FUTURE dynamically start background threads after minfilecount closes.
# (We don't currently have any callers that don't know their file count)
if expectedcount > 0 and expectedcount < minfilecount:
return
maxqueue = ui.configint("worker", "backgroundclosemaxqueue")
threadcount = ui.configint("worker", "backgroundclosethreadcount")
self._queue = util.queue(maxsize=maxqueue)
self._running = True
for i in range(threadcount):
t = threading.Thread(target=self._worker, name="backgroundcloser")
self._threads.append(t)
t.start()
def __enter__(self):
self._entered = True
return self
def __exit__(self, exc_type, exc_value, exc_tb):
self._running = False
# Wait for threads to finish closing so open files don't linger for
# longer than lifetime of context manager.
for t in self._threads:
t.join()
def _worker(self):
"""Main routine for worker thread."""
while True:
try:
fh = self._queue.get(block=True, timeout=0.100)
# Need to catch or the thread will terminate and
# we could orphan file descriptors.
try:
fh.close()
except Exception as e:
# Stash so can re-raise from main thread later.
self._threadexception = e
except util.empty:
if not self._running:
break
def close(self, fh):
"""Schedule a file for closing."""
if not self._entered:
raise error.Abort(_("can only call close() when context manager " "active"))
# If a background thread encountered an exception, raise now so we fail
# fast. Otherwise we may potentially go on for minutes until the error
# is acted on.
if self._threadexception:
e = self._threadexception
self._threadexception = None
raise e
# If we're not actively running, close synchronously.
if not self._running:
fh.close()
return
self._queue.put(fh, block=True, timeout=None)
class checkambigatclosing(closewrapbase):
"""Proxy for a file object, to avoid ambiguity of file stat
See also util.filestat for detail about "ambiguity of file stat".
This proxy is useful only if the target file is guarded by any
lock (e.g. repo.lock or repo.wlock)
Do not instantiate outside of the vfs layer.
"""
def __init__(self, fh):
super(checkambigatclosing, self).__init__(fh)
object.__setattr__(self, r"_oldstat", util.filestat.frompath(fh.name))
def _checkambig(self):
oldstat = self._oldstat
if oldstat.stat:
_avoidambig(self._origfh.name, oldstat)
def __exit__(self, exc_type, exc_value, exc_tb):
self._origfh.__exit__(exc_type, exc_value, exc_tb)
self._checkambig()
def close(self):
self._origfh.close()
self._checkambig()
# 64 bytes for SHA256
_blobvfsre = re.compile(r"\A[a-f0-9]{64}\Z")
class blobvfs(vfs):
def join(self, path: "Optional[str]", *insidef: str) -> str:
"""split the path at first two characters, like: XX/XXXXX..."""
if path is None or not _blobvfsre.match(path):
raise error.ProgrammingError("unexpected blob vfs path: %r" % (path,))
if insidef:
raise error.ProgrammingError(
"unexpected blob vfs path: %r, %r" % (path, insidef)
)
return super(blobvfs, self).join(path[0:2], path[2:])
def walk(
self,
path: "Optional[str]" = None,
onerror: "Optional[Callable[[OSError], None]]" = None,
) -> "Iterable[Tuple[str, List[str], List[str]]]":
"""Yield (dirpath, [], oids) tuple for blobs under path
Oids only exist in the root of this vfs, so dirpath is always ''.
"""
root = os.path.normpath(self.base)
# when dirpath == root, dirpath[prefixlen:] becomes empty
# because len(dirpath) < prefixlen.
prefixlen = len(pathutil.normasprefix(root))
oids = []
for dirpath, dirs, files in os.walk(
self.reljoin(self.base, path or ""), onerror=onerror
):
dirpath = dirpath[prefixlen:]
# Silently skip unexpected files and directories
if len(dirpath) == 2:
oids.extend(
[dirpath + f for f in files if _blobvfsre.match(dirpath + f)]
)
yield ("", [], oids)
def linktovfs(self, oid, vfs):
"""Hardlink a file to another blob vfs"""
src = self.join(oid)
dst = vfs.join(oid)
util.makedirs(os.path.dirname(dst))
util.copyfile(src, dst, hardlink=True)