Joel Rosdahl [Tue, 5 Jul 2022 18:04:25 +0000 (20:04 +0200)]
enhance: Improve lock file implementation
This commit improves brings two improvements to the lock file
implementation:
1. Support for long-lived locks.
2. Support for non-blocking lock acquisition.
There are now two types of lock file classes: ShortLivedLockFile and
LongLivedLockFile. On Windows the implementations are identical. On
other systems, LongLivedLockFile creates a separate "alive file" whose
mtime will be updated regularly by a helper thread until the lock is
released. This makes it possible for another process to wait for the
lock indefinitely but also to know then a lock is stale and can be
broken. The ShortLivedLockFile class works like the lock file class used
to work before: it considers a lock stale after waiting for two seconds
and noticing that the symlink target has not changed during that time.
ShortLivedLockFile is to be used when the lock is expected to be held
for a very short time so that it's a waste of resources to start a
helper thread to keep the lock alive.
On some systems it would be possible to update mtime of the symlink
itself instead of a separate file, but that does not seem to be portable
enough.
Also worth mentioning is that the reason to not use proper fcntl/flock
locks on non-Windows systems is to continue supporting a cache directory
on NFS since file locks on NFS don't have a good track record.
Joel Rosdahl [Sat, 18 Jun 2022 18:08:10 +0000 (20:08 +0200)]
fix: Use a cleanup stamp instead of directory timestamp for cleanup
In order to know when to clean up the temporary directory, ccache checks
mtime of $CCACHE_DIR and updates it to "now" on cleanup. This doesn't
work well when the configuration file is modified often since that also
updates the same mtime.
Fix this by using a separate cleanup stamp file instead.
Joel Rosdahl [Sat, 18 Jun 2022 17:55:02 +0000 (19:55 +0200)]
fix: Clean up temporary dir if it's left the default
Cleanup of the temporary directory is done if it is $CCACHE_DIR/tmp,
which used to be the default until [1] where the default was changed to
/run/user/$UID/ccache-tmp. Improve this so that cleanup happens if the
temporary directory is equal to the default regardless of the default.
Joel Rosdahl [Sat, 11 Jun 2022 12:13:02 +0000 (14:13 +0200)]
feat: Include timestamp in per-object debug filenames
Including a timestamp in the filenames makes it easier to compare two
builds without having to save previous debug files before the second
build. It also makes sure debug files won't be overwritten if an object
file is compiled several times during one build.
Joel Rosdahl [Fri, 10 Jun 2022 14:17:03 +0000 (16:17 +0200)]
feat: Support masquerading as a compiler via copy or hard link
Setting up ccache to masquerade as a compiler has always meant using
symbolic links, but there is no technical reason why that has to be the
case. This commit adds support for masquerading via a copy or hard link
of the ccache executable as well. This is mostly useful on platforms or
file systems where symbolic links are not supported.
Joel Rosdahl [Fri, 10 Jun 2022 14:12:27 +0000 (16:12 +0200)]
feat: Set CCACHE_DISABLE when calling compiler
If ccache for some reason executes a compiler that in turn calls ccache
then ccache will be run twice (and will potentially store two different
result in the cache since the compiler identications differ), which is
not very useful. This could for instance happen if the compiler is a
wrapper script that in turn calls "ccache $compiler ...".
Improve this by setting CCACHE_DISABLE when executing the compiler. Any
subsequent ccache invocations will then fall back to running the real
compiler.
Joel Rosdahl [Tue, 7 Jun 2022 14:53:44 +0000 (16:53 +0200)]
fix: Use correct umask when populating primary cache from secondary
Util::get_umask retrieves the process's umask and caches it to avoid
some system calls. This doesn't interact well now when using UmaskScope
to change umask temporarily since Util::get_umask then only sometimes
returns the correct value. This leads to the incorrect umask being used
when writing cache entries to the primary storage for secondary storage
hits.
Joel Rosdahl [Tue, 7 Jun 2022 13:12:03 +0000 (15:12 +0200)]
fix: Create temporary file with cpp extension instead of hard linking
[1] added a suitable file extension to the temporary file used for
capturing the preprocessed output by creating a hard link. This fails
when the temporary directory is on a file system that doesn't support
hard links.
Fix this by making it possible to pass a suffix to TemporaryFile and
passing the proper cpp suffix for the tmp stdout file instead of
creating a hard link as an alias.
The hard link in question is used in get_result_key_from_cpp to create
an alias of file that captures stdout from the preprocessor, where the
alias has the correct cpp extension. It can't just be a copy since
do_execute writes to the original name. See #1079.
Joel Rosdahl [Mon, 6 Jun 2022 18:46:09 +0000 (20:46 +0200)]
fix: Work around problem with GCC in util::ends_with
The util::ends_with implementation is taken directly from the
implementation suggestion in the C++20 standard, but it produces a
stringop-overread warning with GCC 11.2. There's either some subtle
aspect to this that I don't understand or a compiler bug, but let's work
around it by tweaking the implementation.
Joel Rosdahl [Wed, 11 May 2022 17:57:50 +0000 (19:57 +0200)]
feat: Improve --show-stats
- Added percentage for most values.
- All indented values now have their total count equal to the parent
value.
- Moved presentation of {direct,preprocessed}_cache_{hit,miss}
counters to a separate "Successful lookups" section.
- Removed "Use the -v/--verbose option for more details." from
--show-stats output since it's a bit wordy.
Joel Rosdahl [Thu, 26 May 2022 08:25:11 +0000 (10:25 +0200)]
fix: Fall back to copying temporary preprocessed output file
[1] added a suitable file extension to the temporary file used for
capturing the preprocessed output by creating a hard link. This fails
when the temporary directory is on a file system that doesn't support
hard links.
Fix this by falling back to copying when hard-linking fails.