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)

Avoid mentioning __TIME__ and friends literally in header file

Having them in the header files disables direct mode when compiling
ccache itself.

Add Util::clamp function

test: Retrieve test suite list from CMakeLists.txt

Make “-fstack-usage” test work when $COMPILER is a masquerading ccache

Fix and simplify calculation of cache size change

Use appropriate type for size delta

Include thread ID in addition to process ID in symlink content

This fixes a race condition when doing recompression with multiple
threads.

recompress: Don’t defer updating statistics counter

As of dd8f65aa558, the Context destructor no longer flushes statistics.

Refactor create_cachedir_tag

Remove unnecessary suffix parameter from Util::get_path_in_cache

Remove cache_dir_levels (CCACHE_NLEVELS) setting

This is in preparation for two things:

1. Storing cache statistics (except size/files bookkeeping) on level 2
   instead of level 1, thus making “cache_dir_levels = 1” invalid.
2. Implementing automatic choice of cache levels based on the number of
   files in the cache.

refactor: Convert Util::strip_whitespace to use string_view (#661)

Refactor remaining stats_* functions into Statistics

Remove knowledge about legacy top-level stats file

The top-level stats file was removed in ccache 3.1 ten years ago so it
seems reasonable to remove knowledge about it now.

Refactor Statistics::{write,increment} into Statistics::update

Refactor away stats_{add_cleanup,set_sizes}

Remove upgrade code for populating config with legacy cache size values

Version 3.2, which introduced the configuration file, was released over
six years ago so it seems reasonable to remove upgrade code for older
versions now.

Refactor flushing of stats and logs at ccache exit

Perform flushing of statistics counters (potentially triggering cache
cleanup) and log files in a finalizer inside cache_compilation instead
of in Conxtext’s destructor. This moves somewhat complex logic from
Context into the main ccache code.

As a side effect of this, stats_flush and stats_flush_to_file are
superfluous.

Add and use Statistics::increment function

Extract stats_{read,write} and Statistic enum to Statistics namespace

Add unit tests of Counters class

Add and use Counters::increment(const Counters&)

Introduce Counters::{get,set}_raw

Casting an integer to an enum class value is undefined behavior so let’s
strive not to do that.

Introduce Counters::get/set/increment methods, replacing operator[]

The primary motivation for this is that it’s now possible to detect and
block underflow when incrementing a value in the unlikely but possible
event that a, say, cache_size_kibibyte is decremented below zero.

Replace stats_update_size with incrementing counters directly

Replace stats_update with incrementing counters directly

Tweak AsciiDoc section divider format

test: Introduce unit test for -Xclang handling (#659)

refactor: Compare Args::to_string in tests, not internal state (#658)

Switch from XXH64 to XXH3 for checksums (#657)

The latter promises better performance and supports automatic use of vector
instructions where appropriate.

Don’t create <objectfile>.ccache-log when there is no object file

Fixes #656.

Don’t log stat error in Util::read_file

An error is signalled via an exception so let’s make it up to the caller
whether to log or not.

Simplify TemporaryFile

Add Util::ensure_dir_exists

Add noexcept to move constructors and assignment operators

Move File method definitions outside the class for tidiness

Move manifest functions into a Manifest namespace

Add missing newline in --hash-file output

doc: Correct default compression level

Use “using nonstd::*” consistently

Introduce Util::parse_{unsigned,signed} functions

parse_unsigned replaces parse_uint32 while parse_signed replaces
parse_int. For simplicity, both return 64-bit values; I see no need to
be able to return narrower types since they are used for parsing
configuration values where a valid range is more important. Therefore
the functions optionally verify minimum and maximum allowed values.

Tweak some integer types

Allow for 64-bit values in statistics counters

This is primaily done to avoid overflowing timestamp values in 2038.

Improve name of ArgumentProcessingState::input_charset

It holds the full option argument, not the value.

Convert fromcache_call_mode enum to enum class

Clean up ProcessArgsResult

Remove redundant static keyword for namespace-level constants

Namespace-level constant objects have static storage duration by
default.

Clean up .gitignore

Simplify definition of the stats_info array

Improve variable names related to statistics counters

refactoring: Use return syntax for process_args (#652)

refactoring: Convert stats to enum class (#651)

Clarify naming conventions for enum and enum class values

Fix test errors with GCC 4.4

Add Visual Studio build directory to .gitignore (#650)

Set _FILE_OFFSET_BITS to 64

This allows for operating on large files when compiled in 32-bit mode.

Fixes #649.

Add clang-format off/on for SIZEOF_INT

Improve test cases that use objdump

- Added expect_objdump_contains and expect_objdump_not_contains utility
  functions to the main test framework, making objdump_cmd and grep_cmd
  (renamed to objdump_grep_cmd) internal utility functions.
- Removed strange support for the $HOST_OS_WINDOWS || $HOST_OS_CYGWIN
  case in objdump_grep_cmd. Let’s re-add it later if and when it becomes
  a problem.
- objdump_grep_cmd now greps for literal strings, thus no longer
  interpreting $PWD as a regex.
- Made test cases use expect_objdump_(not_)contains instead of
  “objdump_grep_cmd | grep_cmd”.

Improve error message from expect_(not_)contains

Fix debug_prefix_map failure with old objdump versions

“objdump -g” does not list debug info like the “Multiple
-fdebug-prefix-map” test expects when using objdump 2.20, e.g. on CentOS
6. “objdump -W” does however work, and it seems to work for object files
with compressed .debug_str section as well.

Related to issue #639.

(cherry picked from commit 3a7257ee23ad7985d18e459b6dbb6990b038df17)

Clean up inode_cache suite probe code

Skip inode_cache tests if temporary_dir is on NFS (#648)

Merge address and UB sanitizer (#647)

Improve handling of ccache version in the source release archive

The version.cpp file is currently generated in the source directory.
This is a bit unclean since generated files are supposed to be put in
the build directory.

Also, when building from a source release archive outside a Git
repository the CMake scripts still try to get the version from Git and
then emit an ugly warning message:

    fatal: not a git repository (or any of the parent directories): .git
    fatal: not a git repository (or any of the parent directories): .git
    CMake Warning at cmake/GenerateVersionFile.cmake:42 (message):
      Running git failed
    Call Stack (most recent call first):
      cmake/GenerateVersionFile.cmake:50 (get_version_from_git)
      CMakeLists.txt:32 (include)

Fix this by including a VERSION file in the source release archive. If
the VERSION file exists, GenerateVersionFile.cmake just uses the version
from the file and doesn’t try to get a version from Git. If the file
doesn’t exist, the version is looked up from Git like before, but it’s a
fatal error if the version cannot be determined.

Use GCC for building packages

It’s the standard compiler and still generates the fastest code.

Use Ninja when building source and binary packages

Ninja builds with relative paths so that ccache can be used to cache the
build without resorting to setting base_dir.

Use proper names for source and binary packages

Source package: ccache-$VERSION.tar.xz (and .tar.gz)
Binary package: ccache-$VERSION-$OS-$PROCESSOR.tar.xz (or .zip)

Generate tar.xz binary packages for non-Windows

Generate both tar.gz and tar.xz source packages

Remove superfluous setting of CPACK_CMAKE_GENERATOR

Set CMAKE_GENERATOR if a non-default generator is wanted.

Remove superfluous setting of CMAKE_DEBUG_POSTFIX

Reset environment variables before running test suite probe

This makes it possible to use $CCACHE in a stable way in probe
functions.

Refactor Config::default_temporary_dir

Comment out unused parameter name instead of using [[maybe_unused]]

I think that it makes the code look cleaner if the parameter is
definitely unused.

Treat Clang-Format discrepancies as errors

If it becomes too tedious for drive-by contributors we’ll disable it
again.

Fix code formatting

Support building on MSVC (#632)

With these changes, the project builds with Visual Studio 2019, unit
tests pass and it works correctly with mingw gcc.

NOTE: The very latest version of Visual Studio 2019 is required, because
there was just a necessary fix for template arguments.

Tested building and running unit tests on Windows+MSVC, Windows+MinGW,
Linux and macOS.

- Enable `ZSTD_FROM_INTERNET` by default for MSVC when not using vcpkg
  or conan.

- Add include tests for some standard UNIX headers not available on
  MSVC.

- Add necessary MSVC compiler flags.

- In `Args::from_gcc_atfile()` iterate over the string via `c_str()`
  instead of `cbegin()`, the MSVC string character iterator does not
  include the ending null byte.

- Misc. minor cmake fix-ups.

- Add some headers that are not implicitly included from other headers
  like `<algorithm>`, `<ios>`, `<cstdint>` and `<cstdarg>` in some
  places, gcc does this but MSVC does not.

- Add `std::filesystem` version of `Util::traverse()` when dirent.h is
  not available, which is preferred for performance reasons.

- Add implementations of the following functions that are not available
  in MSVC in Win32Util.cpp: `gettimeofday()`, `localtime_r()`,
  `asprintf()`.

- Add Windows implementation of `getopt_long()` from
  https://www.codeproject.com/Articles/157001/Full-getopt-Port-for-Unicode-and-Multibyte-Microso
  to third_party/win32.

- Add some compatibility typedefs, constants and macros to the `_WIN32`
  section of system.hpp, as well as the prototypes for the functions
  added to Win32Util.cpp.

- Fix up unit tests expecting '/' separated paths to expect paths
  delimited by `DIR_DELIM_CH`.

- Invoke test/run with bash from cmake, necessary on msys2+mingw64, many
  fail, there is more work to do here.

- Set the warning level to `/W4` and silence all the uninteresting
  warning types. Compiles with no warnings now.

- Switch to using standard C++ attributes `[[nodiscard]]` and
  `[[maybe_unused]]` and define macros for gcc for their equivalents.

- `#define DOCTEST_CONFIG_USE_STD_HEADERS` for MSVC only, because it
  requires explicitly including `<ostream>`.

- Add vim files to .gitignore.

Signed-off-by: Rafael Kitover <rkitover@gmail.com>

Support passing level 0 to “ccache -X” to use default level

Let “ccache -X” print before/after statistics

Improve layout of “ccache -x” statistics

Make Util::format_human_readable_size format kB

Fix asm compiler detection (#644)

CMake requires ASM to be the last parameter so it can try whether the C compiler can compile asm.
See https://gitlab.kitware.com/cmake/cmake/-/merge_requests/1560/diffs

Fix override usage (#640)

Update comments, remove references to old global variables (#637)

Util::unlink_tmp: Log with correct errno (#636)

build.yaml: Improve naming of build jobs

build.yaml: Collect testdir from either build or .

Also fix the name attribute sent to actions/upload-artifact.

build.yaml: Use build type CI by default

I think that it makes sense to use a ccache binary built in release mode
in CI tests by default since that is what the end user will actually
run. At the same time we want to test assertions in CI, so use the CI
build type which is RelWithDebInfo but without -DNDEBUG. I here assume
that the difference between -O3 (from build type Release) and -O2 (from
build type RelWithDebInfo) is small.

Changed OS to Ubuntu 20.04 for “Linux MinGW 64-bit” since the cross
compiler in Ubuntu 18.04 is buggy.

Add CMake build type “CI” like “RelWithDebInfo” but without -DNDEBUG

Remove Travis build and related scripts

build.yaml: Consistently use extra indentation level for lists

build.yaml: Add Clang-Format step

build.yaml: Pass EXTRA_CMAKE_BUILD_FLAGS to “Build and test” step

This will make the “Build documentation” and “Build manpage” step do
what’s intended.

Rename BUILDEXTRAFLAGS to EXTRA_CMAKE_BUILD_FLAGS

build.yaml: Sort environment variable lists

test: Apply missing renaming of expect_* functions

These were missed in 733f98804a4e but the error messages were hidden
then run via CTest.

build.yaml: Don’t use flow style YAML