Build ccache from source (#91)

The change modifies the Debian, RHEL, and Ubuntu images to build from
source.

As suggested in
#90 (review), I
first explored using the GCC image as a base to build ccache, and then
copy it into the final GCC and Clang images. However, this resulted in
two issues:

1. The Clang images would need to build the GCC base image first, which
would result in additional work.
2. The Clang images would need to be provided with a GCC version to use.

I considered building a wholly separate image, e.g. a
`tools-rippled-ccache`, to use as base image in which GCC would be
installed and then ccache built from source, upon which it could be
copied into the distro images. However, this has its own drawbacks:

1. The CI pipeline currently runs all builds in parallel, so it is not
set up to handle dependencies between images. This would then result in
failures until the ccache image is built and pushed.
2. Future updates to the ccache image would lead to unexpected issues.
Namely, if you were to change the ccache version, the old image would
still used due to issue 1. above, so you'd need to first merge the
change, and then rerun the pipelines afterwards so the distro images
actually use the new ccache image.

(Note that we already have this issue with the GCC base image in the
`docker/gcc` directory, used by Debian, so I prefer to not add more such
cases.)

So, to keep things simple at the expense of duplication (of which there
already is a bit; unfortunately Docker doesn't support importing a bunch
of instructions from another Dockerfile), I build ccache from source in
both the GCC and Clang final images.

Note that the gold linker in RHEL 8 is so old that it doesn't support a
compiler flag used by ccache, so I've configured it to use the default
linker instead.

Author: bthomee

docker/debian/Dockerfile

@@ -79,27 +79,6 @@ RUN pip install --no-cache \
   gcovr==${GCOVR_VERSION} \
   cmake==${CMAKE_VERSION}
 
-# Install ccache. Note that the ccache version from the package manager is
-# installed for Debian Bullseye, as the latest version requires a newer GLIBC
-# version, and older compatible releases are x86-64 only.
-ARG CCACHE_VERSION
-
-RUN <<EOF
-if [[ "${DEBIAN_VERSION}" == "bullseye" ]]; then
-  apt-get update
-  apt-get install -y --no-install-recommends ccache
-  apt-get clean
-  rm -rf /var/lib/apt/lists/*
-else
-  ARCH=$(uname -m)
-  wget -O ccache.tar.xz https://github.com/ccache/ccache/releases/download/v${CCACHE_VERSION}/ccache-${CCACHE_VERSION}-linux-${ARCH}.tar.xz
-  tar -xf ccache.tar.xz
-  cp ccache-${CCACHE_VERSION}-linux-${ARCH}/ccache /usr/local/bin
-  rm -r ccache-${CCACHE_VERSION}-linux-${ARCH}
-  rm ccache.tar.xz
-fi
-EOF
-
 # Install mold.
 ARG MOLD_VERSION
 
@@ -119,7 +98,6 @@ ENV PATH="$CARGO_HOME/bin:$PATH"
 
 # Print versions.
 RUN <<EOF
-ccache --version
 cmake --version
 conan --version
 gcovr --version
@@ -192,6 +170,27 @@ if [[ "${CXX_VER}" != "${GCC_VERSION}" ]]; then
 fi
 EOF
 
+# Build ccache from source to avoid incompatible GLIBC versions.
+ARG CCACHE_VERSION
+
+RUN <<EOF
+wget -O ccache.tar.gz https://github.com/ccache/ccache/releases/download/v${CCACHE_VERSION}/ccache-${CCACHE_VERSION}.tar.gz
+tar -xzf ccache.tar.gz
+rm ccache.tar.gz
+cd ccache-${CCACHE_VERSION}
+
+# Build, install, and clean up.
+mkdir build
+cd build
+cmake -DCMAKE_BUILD_TYPE=Release -DENABLE_TESTING=OFF ..
+make -j install
+cd ../..
+rm -rf ccache-${CCACHE_VERSION}
+
+# Verify the installation.
+ccache --version
+EOF
+
 # Set the Conan home directory, so the users of this image can find the default
 # profile.
 ENV HOME=/root
@@ -285,6 +284,27 @@ if [[ "${CXX_VER}" != "${CLANG_VERSION}" ]]; then
 fi
 EOF
 
+# Build ccache from source to avoid incompatible GLIBC versions.
+ARG CCACHE_VERSION
+
+RUN <<EOF
+wget -O ccache.tar.gz https://github.com/ccache/ccache/releases/download/v${CCACHE_VERSION}/ccache-${CCACHE_VERSION}.tar.gz
+tar -xzf ccache.tar.gz
+rm ccache.tar.gz
+cd ccache-${CCACHE_VERSION}
+
+# Build, install, and clean up.
+mkdir build
+cd build
+cmake -DCMAKE_BUILD_TYPE=Release -DENABLE_TESTING=OFF ..
+make -j install
+cd ../..
+rm -rf ccache-${CCACHE_VERSION}
+
+# Verify the installation.
+ccache --version
+EOF
+
 # Set the Conan home directory, so the users of this image can find the default
 # profile.
 ENV HOME=/root

docker/debian/README.md

@@ -66,9 +66,12 @@ In order to build a GCC image for Bullseye, you also need to explicitly set
 `BASE_IMAGE` build argument, e.g.
 
 ```shell
+# The version of the distro to use.
 DEBIAN_VERSION=bullseye
+# The version of GCC to use, including corresponding base image.
 GCC_VERSION=12
 BASE_IMAGE=ghcr.io/xrplf/ci/gcc:${GCC_VERSION}-bullseye
+# The versions of the tools to use.
 CCACHE_VERSION=4.12.2
 CMAKE_VERSION=4.1.0
 CONAN_VERSION=2.22.2
@@ -100,8 +103,11 @@ In order to build an image for Clang, run the commands below from the root
 directory of the repository.
 
 ```shell
+# The version of the distro to use.
 DEBIAN_VERSION=bookworm
+# The version of Clang to use.
 CLANG_VERSION=17
+# The versions of the tools to use.
 CCACHE_VERSION=4.12.2
 CMAKE_VERSION=4.1.0
 CONAN_VERSION=2.22.2

docker/rhel/Dockerfile

@@ -90,27 +90,6 @@ RUN pip install --no-cache \
   gcovr==${GCOVR_VERSION} \
   cmake==${CMAKE_VERSION}
 
-# Install ccache. Note that the ccache version from the package manager is
-# installed for RHEL 8, as the latest version requires a newer GLIBC version,
-# and older compatible releases are x86-64 only.
-ARG CCACHE_VERSION
-
-RUN <<EOF
-if [[ "${RHEL_VERSION}" == "8" ]]; then
-  dnf update -y
-  dnf install -y --allowerasing --setopt=tsflags=nodocs ccache
-  dnf clean -y all
-  rm -rf /var/cache/dnf/*
-else
-  ARCH=$(uname -m)
-  wget -O ccache.tar.xz https://github.com/ccache/ccache/releases/download/v${CCACHE_VERSION}/ccache-${CCACHE_VERSION}-linux-${ARCH}.tar.xz
-  tar -xf ccache.tar.xz
-  cp ccache-${CCACHE_VERSION}-linux-${ARCH}/ccache /usr/local/bin
-  rm -r ccache-${CCACHE_VERSION}-linux-${ARCH}
-  rm ccache.tar.xz
-fi
-EOF
-
 # Install mold.
 ARG MOLD_VERSION
 
@@ -130,7 +109,6 @@ ENV PATH="$CARGO_HOME/bin:$PATH"
 
 # Print versions.
 RUN <<EOF
-ccache --version
 cmake --version
 conan --version
 gcovr --version
@@ -204,6 +182,30 @@ if [[ "${CXX_VER}" != "${GCC_VERSION}" ]]; then
 fi
 EOF
 
+# Build ccache from source to avoid incompatible GLIBC versions.
+ARG CCACHE_VERSION
+
+RUN <<EOF
+wget -O ccache.tar.gz https://github.com/ccache/ccache/releases/download/v${CCACHE_VERSION}/ccache-${CCACHE_VERSION}.tar.gz
+tar -xzf ccache.tar.gz
+rm ccache.tar.gz
+cd ccache-${CCACHE_VERSION}
+
+# Build, install, and clean up.
+mkdir build
+cd build
+if [[ "${RHEL_VERSION}" -eq "8" ]]; then
+  LINKER_OPTION='-D USE_FASTER_LINKER=OFF'
+fi
+cmake -DCMAKE_BUILD_TYPE=Release -DENABLE_TESTING=OFF ${LINKER_OPTION} ..
+make -j install
+cd ../..
+rm -rf ccache-${CCACHE_VERSION}
+
+# Verify the installation.
+ccache --version
+EOF
+
 # Set the Conan home directory, so the users of this image can find the default
 # profile.
 ENV HOME=/root
@@ -280,6 +282,30 @@ if [[ ${CXX_VER} -lt ${MINIMUM_CLANG_VERSION} ]]; then
 fi
 EOF
 
+# Build ccache from source to avoid incompatible GLIBC versions.
+ARG CCACHE_VERSION
+
+RUN <<EOF
+wget -O ccache.tar.gz https://github.com/ccache/ccache/releases/download/v${CCACHE_VERSION}/ccache-${CCACHE_VERSION}.tar.gz
+tar -xzf ccache.tar.gz
+rm ccache.tar.gz
+cd ccache-${CCACHE_VERSION}
+
+# Build, install, and clean up.
+mkdir build
+cd build
+if [[ "${RHEL_VERSION}" -eq "8" ]]; then
+  LINKER_OPTION='-D USE_FASTER_LINKER=OFF'
+fi
+cmake -DCMAKE_BUILD_TYPE=Release -DENABLE_TESTING=OFF ${LINKER_OPTION} ..
+make -j install
+cd ../..
+rm -rf ccache-${CCACHE_VERSION}
+
+# Verify the installation.
+ccache --version
+EOF
+
 # Set the Conan home directory, so the users of this image can find the default
 # profile.
 ENV HOME=/root

docker/rhel/README.md

@@ -23,8 +23,11 @@ In order to build the image for GCC, run the commands below from the root
 directory of the repository.
 
 ```shell
+# The version of the distro to use.
 RHEL_VERSION=9
+# The version of GCC to use.
 GCC_VERSION=12
+# The versions of the tools to use.
 CCACHE_VERSION=4.12.2
 CMAKE_VERSION=4.1.0
 CONAN_VERSION=2.22.2
@@ -55,7 +58,9 @@ In order to build the image for Clang, run the commands below from the root
 directory of the repository.
 
 ```shell
+# The version of the distro to use.
 RHEL_VERSION=10
+# The versions of the tools to use.
 CCACHE_VERSION=4.12.2
 CMAKE_VERSION=4.1.0
 CONAN_VERSION=2.22.2

docker/ubuntu/Dockerfile

@@ -62,18 +62,6 @@ RUN pip install --no-cache \
   gcovr==${GCOVR_VERSION} \
   cmake==${CMAKE_VERSION}
 
-# Install ccache.
-ARG CCACHE_VERSION
-
-RUN <<EOF
-ARCH=$(uname -m)
-wget -O ccache.tar.xz https://github.com/ccache/ccache/releases/download/v${CCACHE_VERSION}/ccache-${CCACHE_VERSION}-linux-${ARCH}.tar.xz
-tar -xf ccache.tar.xz
-cp ccache-${CCACHE_VERSION}-linux-${ARCH}/ccache /usr/local/bin
-rm -r ccache-${CCACHE_VERSION}-linux-${ARCH}
-rm ccache.tar.xz
-EOF
-
 # Install mold.
 ARG MOLD_VERSION
 
@@ -93,7 +81,6 @@ ENV PATH="$CARGO_HOME/bin:$PATH"
 
 # Print versions.
 RUN <<EOF
-ccache --version
 cmake --version
 conan --version
 gcovr --version
@@ -156,6 +143,27 @@ if [[ "${CXX_VER}" != "${GCC_VERSION}" ]]; then
 fi
 EOF
 
+# Build ccache from source to avoid incompatible GLIBC versions.
+ARG CCACHE_VERSION
+
+RUN <<EOF
+wget -O ccache.tar.gz https://github.com/ccache/ccache/releases/download/v${CCACHE_VERSION}/ccache-${CCACHE_VERSION}.tar.gz
+tar -xzf ccache.tar.gz
+rm ccache.tar.gz
+cd ccache-${CCACHE_VERSION}
+
+# Build, install, and clean up.
+mkdir build
+cd build
+cmake -DCMAKE_BUILD_TYPE=Release -DENABLE_TESTING=OFF ..
+make -j install
+cd ../..
+rm -rf ccache-${CCACHE_VERSION}
+
+# Verify the installation.
+ccache --version
+EOF
+
 # Set the Conan home directory, so the users of this image can find the default
 # profile.
 ENV HOME=/root
@@ -244,6 +252,27 @@ if [[ "${CXX_VER}" != "${CLANG_VERSION}" ]]; then
 fi
 EOF
 
+# Build ccache from source to avoid incompatible GLIBC versions.
+ARG CCACHE_VERSION
+
+RUN <<EOF
+wget -O ccache.tar.gz https://github.com/ccache/ccache/releases/download/v${CCACHE_VERSION}/ccache-${CCACHE_VERSION}.tar.gz
+tar -xzf ccache.tar.gz
+rm ccache.tar.gz
+cd ccache-${CCACHE_VERSION}
+
+# Build, install, and clean up.
+mkdir build
+cd build
+cmake -DCMAKE_BUILD_TYPE=Release -DENABLE_TESTING=OFF ..
+make -j install
+cd ../..
+rm -rf ccache-${CCACHE_VERSION}
+
+# Verify the installation.
+ccache --version
+EOF
+
 # Set the Conan home directory, so the users of this image can find the default
 # profile.
 ENV HOME=/root

docker/ubuntu/README.md

@@ -22,14 +22,18 @@ In order to build the image for GCC, run the commands below from the root
 directory of the repository.
 
 ```shell
+# The version of the distro to use.
 UBUNTU_VERSION=noble
+# The version of GCC to use.
 GCC_VERSION=14
+# The versions of the tools to use.
 CCACHE_VERSION=4.12.2
 CMAKE_VERSION=4.1.0
 CONAN_VERSION=2.22.2
 GCOVR_VERSION=8.3
 MOLD_VERSION=2.40.4
 RUST_VERSION=1.91.1
+# The name of the image to build.
 CONTAINER_IMAGE=ghcr.io/xrplf/ci/ubuntu-${UBUNTU_VERSION}:gcc-${GCC_VERSION}
 
 docker buildx build . \
@@ -54,14 +58,18 @@ In order to build the image for Clang, run the commands below from the root
 directory of the repository.
 
 ```shell
+# The version of the distro to use.
 UBUNTU_VERSION=noble
+# The version of Clang to use.
 CLANG_VERSION=18
+# The versions of the tools to use.
 CCACHE_VERSION=4.12.2
 CMAKE_VERSION=4.1.0
 CONAN_VERSION=2.22.2
 GCOVR_VERSION=8.3
 MOLD_VERSION=2.40.4
 RUST_VERSION=1.91.1
+# The name of the image to build.
 CONTAINER_IMAGE=ghcr.io/xrplf/ci/ubuntu-${UBUNTU_VERSION}:clang-${CLANG_VERSION}
 
 docker buildx build . \