Detect errors in fmt::format format strings at compile time

See also 4413d842e23c6fa52ec411951a4ab442f42227de.

Detect errors in fmt::print format strings at compile time

See also 4413d842e23c6fa52ec411951a4ab442f42227de.

Detect errors in log strings at compile time

fmtlib can detect format string errors at compile time if (1) applying
FMT_STRING to the format string literal and (2) compiling for C++14 or
higher.

Requirement 1 is implemented by introducing a LOG macro which applies
FMT_STRING to the first argument and calls Logging::log (if logging is
enabled). Also added are a companion LOG_RAW macro (since C++11 requires
at least one argument for the “...” part in variadic macros) and a
BULK_LOG macro which calls Logging::bulk_log (if logging is enabled).

Requirement 2 is implemented by setting CMAKE_CXX_STANDARD to 14 for one
CI build with a known C++14-capable compiler. We can’t set it to 14 by
default since we still want the code to be buildable with C++11
compilers.

This will catch errors such as the one fixed by PR #691.

Fail gracefully on ancient compilers (#702)

Fix order of commands in third_party CMakeLists.txt (#699)

Refer to the platform-compiler-language-support page in INSTALL.md

As mentioned in #695.

Require CLONE_NOOWNERCOPY to be defined for clone on mac (#694)

Fixes #688.

Use BLAKE3 machinery for detecting AVX2 support (#696)

* Use BLAKE3 machinery for detecting AVX2 support

Instead of relying on the sometimes broken __builtin_cpu_support. See
discussion in #689.

* Require GCC >= 5.0 to enable AVX2 support

On e.g. GCC 4.8.5 the build fails with:
error: ‘__m256i’ does not name a type

BLAKE3: Use C version on ancient Clang (#692)

Add missing parameters to log() call (#691)

Support ccache ccache gcc (#687)

Fix badly named man page filename (Ccache.1 instead of ccache.1)

Apparently a2x deduces the man page name from the name section and there
is no way to specify another name.

Regression in a684bb356c9f0d6154f19ecefcc348167b975e5c.

Partial fix of #684.

Use CMake A2X_EXE variable instead of hardcoded a2x

Prepare for v4.0

Update authors

Remove apparently unnecessary ::add-path command

Use $GITHUB_PATH to set PATH from install-cuda

The ::set-env command is deprecated according to
<https://github.blog/changelog/2020-10-01-github-actions-deprecating-set-env-and-add-path-commands/>.

Run cross-compiled 64-bit MinGW unit tests in Wine

Add codespell build job

Improve NEWS

Add “Compatibility with older versions” section to NEWS

Hash variables that may affect the compilation

As mentioned in #662.

Refactor logical expression in find_compiler

Fix expect_perm to work with SELinux (#681)

Test case CCACHE_UMASK fails when running it in an SELinux context because
/bin/ls adds a trailing dot to the output. Thus truncate the output to expected
length.

Update NEWS

Remove -lgcov from profiling tests (#679)

This fixes an issue when running the test suite with a Clang installation
without a GCC installation since libgcov then isn't found.

(cherry picked from commit 9e128bfeb9a5050231a41e357729645c5a99fc2e)

test: Verify masquerading when executed as an absolute path

As discussed in #664.

test: Remove now unnecessary setting of CCACHE_COMPILE

test: Improve masquerading suite probe

test: Publish and use COMPILER_BIN and COMPILER_ARGS

Upgrade to string-view-lite 1.6.0

Update authors

Add Erik Flodin (formerly Johansson) to .mailmap

Keep comments when using -M/-F/-o to set config values

Use capitalized “Ccache” at start of sentences consistently

Make CCACHE_COMPILER always the highest priority (#664)

Closes #432.

Support GCC 9+ .gcno files in combination with -fprofile-dir

See 7f55660f0c03b3edae809f2e6097f4be2a707329.

Closes #675.

Add comments for Result::FileType values

Simplify rewrite_dep_file_paths unit test

Use capitalized “Ccache” at start of sentences consistently

Add option for enabling interprocedural (link time, LTO) optimization

Don’t print failure to “git describe” to stderr

Fix broken dependency file when using base_dir

If a path in the dependency file matches base_dir, the dependency file
will be completely broken since newlines won’t be not retained by
use_relative_paths_in_depfile. Fix this by tokenizing lines instead of
the full file content once again.

Regression in aaadd43dbdf157ce20ab901fc9ce1c2e4924a73c (#555).

Avoid unnecessary stat calls in Util::make_relative_path

Improve consistency of terms in the manual

* configuration setting -> configuration option
* option -> command line option, configuration option, compiler option,
  value or sloppiness (unless it’s obvious from the context what
  “option” refers to)

Upgrade to string-view-lite 1.5.1

Allow running the test suite with a “+dirty” version

Only move cache file to another level when we know the actual file count

Const-ify parameter to to_cache

Fix bad sizeof() application

Found by Cppcheck.

Reduce variable scope in ResultRetriever::write_dependency_file

Suppress Cppcheck warnings for all third party source code

Remove redundant check related to parsing “-x”

Merge pull request #678 from AlexanderLanin/x

Add unit tests for parsing -x.

refactor: Simplify logic of -x handling

Add unit tests for parsing -x argument

Disable some new Clang-Tidy features (#677)

Update NEWS

Add CI build with GCC 4.8.5

This tests GCC 4.8.5 which is the default compiler in RHEL/CentOS 7.

There is no intention to keep the GCC 4.8.5 build free from warnings
since doing so will make things worse for modern compilers and tools.

Use STATUS instead of NOTICE for CMake messages

NOTICE is apparently new for CMake 3.15.

Fix build error for TemporaryFile with GCC 4.8

Handle interrupted waitpid call properly in hash_command_output

Don’t add -I${CMAKE_SOURCE_DIR}/third_party when compiling

Third party headers are supposed to be included by “#include
third_party/...”.

Add Paul Bunch to .mailmap

Mention how to configure location of the secondary config file

refactor: Improve naming/interface of compopt functions (#663)

Upgrade to BLAKE3 0.3.7

Update NEWS

(cherry picked from commit 11a582f5b31b53e6c223f28c46bcf2d66504cbad)

Handle missing .gcno file gracefully

GCC ≥9 has changed behavior for -ftest-coverage and --coverage in
combination with -fprofile-dir=dir:

- Without -fprofile-dir=dir the file is placed next to the object file
  but with a “.gcno” extension.
- With -fprofile-dir=dir the file is also place next to the object file
  (i.e. not in the specified profile directory) but the same style of
  name as used for “.gcda” files (full pathname with slashes replaced
  with hash characters).

Fix this by:

- Checking if the expected (GCC <9) .gcno file is present. If not, fall
  back to running the compiler and increment the “unsupported option”
  counter.
- Making sure to perform the above check before copying the object file
  to the cache so that a later ccache invocation won’t believe that
  there is a result in the cache.
- Improving the copy_file routine to not create the destination file
  until it knows that there is a source file to copy from.

Fixes #674.

(cherry picked from commit 6abd78b5ec7cdfeedff36454b07a8dbff312b554)

Simplify source package generation

Since it now works to build from “git archive” archives, use such an
archive as the official source code release archive instead of using
CPack with a custom install script for modifying the source code. We can
revisit this in the future when and if we want a source code release
archive that is not simply an export of the version-controlled source
code.

Make it possible to build from “git archive” source archives

The ccache CMake scripts currently support building from an official
release archive or in a Git repository but not from a source archive
created by “git archive”.

Improve this by adding directives so that “git archive” substitutes
needed information when exporting the source tree.

Closes #667.

Fix bad variable name by inlining it

Introduced in 68905effcff923769800f837b1516fcb1583d71b.

Fix typo in manual section “Compiling in different directories”

Add error detection to zstd download (#673)

Add unittest for find_compiler (#670)

Co-authored-by: Joel Rosdahl <joel@rosdahl.net>

Use ubuntu-18.04 instead of ubuntu-20.04 for Clang-Tidy

The ubuntu-20.04 VM has intermittent build errors that look like this:

  sudo apt-get install libzstd-dev clang-tidy
  [...]
  The following packages have unmet dependencies:
   clang-tidy : Depends: clang-tidy-10 (>= 10~) but it is not going to be installed
  E: Unable to correct problems, you have held broken packages.

Clang-Tidy 9 also found “function ... has a definition with different
parameter names” warnings that needed to be fixed as part of this.

As discussed in #670.

Don’t update stats file if all counter updates are zero

Handle short read when writing result files

Result::Write::write_embedded_file_entry assumes that read(2) never
performs a “short read” (fewer bytes than the supplied count) for files.
A short read can however happen if the process is interrupted by a
signal, for instance on NFS with the “intr” mount option.

Fix this by properly reducing the remaining bytes counter by the amount
of actually read bytes.

Improve base_dir documentation

Closes #668.

Improve CMake targets related to documentation

- Rename the documentation target to doc-html.
- Rename the manpage target to doc-man-page.
- Make the doc-html target not recreate documentation files each time it
  is run by using the OUTPUT form of add_custom_command.
- Similar for the doc-man-page target.
- Add doc target which builds both HTML documentation and man page.

Fix Clang-Tidy 9 warning about differing parameter name

Remove unnecessary Result::Writer destructor

The destructor may throw exceptions and since it’s superfluous we can
just remove it.

Encode hash digests as 4 base16 digits + 29 base32hex digits

Reducing file lengths should be beneficial since it reduces the number
of needed system calls when scanning many files in the cache. The effect
is very small but there is no real downside. See also
b16001a67f4389956ef6e7ccf7d8023684b57119.

Base32 is chosen since the encoding algorithm is very simple compared to
e.g. base36. Base64 cannot be used since the encoded digest string is
used in filenames and the cache directory may be located on a case
insensitive filesystem. The base32hex variant is chosen instead of the
other base32 variants since it feels more natural and there are no
visual ambiguity issues.

The first two bytes are encoded as base16 to maintain compatibility with
the cleanup algorithm in older ccache versions and to allow for up to
four uniform cache levels.

Rename Util::format_hex to format_base16

Optimize Util::format_hex

Not that it matters much, but not using fmt::format makes
Util::format_hex ≈20x faster.

Fix base32hex code

- Const-ified input parameter.
- Use non-reserved macro for the include guard.
- Use unsigned int buffer to avoid “left shift of 1236923897 by 8 places
  cannot be represented in type int” reported by Clang’s
  UndefinedBehaviorSanitizer.

Add base32hex implementation by Peter Conrad

Implementation copied verbatim from (a patch in)
<https://github.com/pmconrad/tinydnssec>.

Use no indentation for license entries in LICENSE.adoc consistently

Sort entries in LICENSE.adoc according to file names

Pass Args by const ref

It doesn’t matter in practice, but LGTM gets happier.

Use short type suffix for cache files

x.result -> xR
x.manifest -> xM
x_n.raw -> xnW

Reducing file lengths should be beneficial since it reduces the number
of needed system calls when scanning many files in the cache. The effect
is very small but there is no real downside.

A one letter suffix is kept to allow for making decisions based on file
type without having to open the file. The suffix is uppercase so that is
doesn’t clash with pre-4.0 *.stderr files stored in the cache.

Reduce duplication in third party CMakeLists.txt

Store cache statistics on level 2 and cache bookkeeping still on level 1

In a “mostly cache hits” scenario, many parallel ccache invocations may
want to update statistics at the same time. Spreading out counter
updates over 256 instead of 16 stats files reduces lock contention
significantly.

Keeping cache bookkeeping (i.e. cache size and files counters) on level
1 preserves backward compatibility with the cleanup algorithm in older
ccache versions.

Some counters displayed by “ccache -s” won’t be accurate when an older
ccache version is run on a cache directory that is also used by ccache
4.x, but that shouldn’t be much of a problem in practice. Also, the
cache statistics isn’t backward compatible anyway since new counters may
be introduced and they will be invisible to older versions.

Closes #168 (only statistics are moved to the second level, though).

Silence unwanted output in CCACHE_UMASK test

Implement support for automatic cache levels

This makes ccache choose an appropriate cache level structure
automatically based on a maximum number of files per directory,
currently hardcoded to 2000.

Fix capitalization of CMake, Cppcheck, Clang-Format and Clang-Tidy

Avoid -Wshadow warnings with older compilers

Add ASSERT and DEBUG_ASSERT macros

CMake always defines NDEBUG in release builds, so assertions are only
enabled in debug builds. Assertions were however always enabled before
switching to CMake. I prefer keeping assertions enabled in release
builds as well unless they are part of a tight loop.

Fix this by introducing two custom assertion macors:

- ASSERT(condition): Like assert(condition) but always enabled.
- DEBUG_ASSERT(condition): Like assert(condition), i.e. only enabled in
  debug builds.

All usage of assert(condition) is converted to ASSERT(condition) since
none of the assertions are made in performance-critical code.

Handle waitpid interruption and add missing string header (#669)

Add support for hip language (#666)