Allow ccache to reuse results across build directories (#1522)

Author: eramongodb

.evergreen/legacy_config_generator/evergreen_config_lib/tasks.py

@@ -926,6 +926,12 @@ def do_is_valid_combination(self) -> bool:
             export distro_id='${distro_id}' # Required by find_cmake_latest.
             . .evergreen/scripts/find-cmake-latest.sh
             cmake_binary="$(find_cmake_latest)"
+
+            # Allow reuse of ccache compilation results between different build directories.
+            export CCACHE_BASEDIR CCACHE_NOHASHDIR
+            CCACHE_BASEDIR="$(pwd)"
+            CCACHE_NOHASHDIR=1
+
             # Compile test-awsauth. Disable unnecessary dependencies since test-awsauth is copied to a remote Ubuntu 20.04 ECS cluster for testing, which may not have all dependent libraries.
             export CC='${CC}'
             "$cmake_binary" -DENABLE_TRACING=ON -DENABLE_SASL=OFF -DENABLE_SNAPPY=OFF -DENABLE_ZSTD=OFF -DENABLE_CLIENT_SIDE_ENCRYPTION=OFF .

.evergreen/scripts/compile-openssl-static.sh

@@ -109,5 +109,10 @@ if [[ "${OSTYPE}" == darwin* ]]; then
   }
 fi
 
+# Allow reuse of ccache compilation results between different build directories.
+export CCACHE_BASEDIR CCACHE_NOHASHDIR
+CCACHE_BASEDIR="$(pwd)"
+CCACHE_NOHASHDIR=1
+
 "${CMAKE}" "${configure_flags[@]}" .
 "${CMAKE}" --build . -- -j "$(nproc)"

.evergreen/scripts/compile-scan-build.sh

@@ -148,6 +148,11 @@ for dir in "${scan_build_directories[@]}"; do
 done
 : "${scan_build_binary:?"could not find a scan-build binary!"}"
 
+# Allow reuse of ccache compilation results between different build directories.
+export CCACHE_BASEDIR CCACHE_NOHASHDIR
+CCACHE_BASEDIR="$(pwd)"
+CCACHE_NOHASHDIR=1
+
 "${scan_build_binary}" --use-cc="${CC}" --use-c++="${CXX}" "${cmake_binary}" "${configure_flags[@]}" .
 
 if [[ "${OSTYPE}" == darwin* ]]; then

.evergreen/scripts/compile-std.sh

@@ -134,5 +134,10 @@ echo "Installing libmongocrypt... done."
 echo "CFLAGS: ${CFLAGS}"
 echo "configure_flags: ${configure_flags[*]}"
 
+# Allow reuse of ccache compilation results between different build directories.
+export CCACHE_BASEDIR CCACHE_NOHASHDIR
+CCACHE_BASEDIR="$(pwd)"
+CCACHE_NOHASHDIR=1
+
 "${cmake_binary}" "${configure_flags[@]}" .
 "${cmake_binary}" --build .

.evergreen/scripts/compile-test-azurekms.sh

@@ -16,6 +16,11 @@ echo "Installing libmongocrypt ... begin"
 }
 echo "Installing libmongocrypt ... end"
 
+# Allow reuse of ccache compilation results between different build directories.
+export CCACHE_BASEDIR CCACHE_NOHASHDIR
+CCACHE_BASEDIR="$(pwd)"
+CCACHE_NOHASHDIR=1
+
 echo "Compile test-azurekms ... begin"
 # Disable unnecessary dependencies. test-azurekms is copied to a remote host for testing, which may not have all dependent libraries.
 "${cmake_binary}" \

.evergreen/scripts/compile-test-gcpkms.sh

@@ -16,6 +16,11 @@ echo "Installing libmongocrypt ... begin"
 }
 echo "Installing libmongocrypt ... end"
 
+# Allow reuse of ccache compilation results between different build directories.
+export CCACHE_BASEDIR CCACHE_NOHASHDIR
+CCACHE_BASEDIR="$(pwd)"
+CCACHE_NOHASHDIR=1
+
 echo "Compile test-gcpkms ... begin"
 # Disable unnecessary dependencies. test-gcpkms is copied to a remote host for testing, which may not have all dependent libraries.
 "${cmake_binary}" \

.evergreen/scripts/compile-unix.sh

@@ -202,6 +202,11 @@ else
   configure_flags_append "-DENABLE_CLIENT_SIDE_ENCRYPTION=OFF"
 fi
 
+# Allow reuse of ccache compilation results between different build directories.
+export CCACHE_BASEDIR CCACHE_NOHASHDIR
+CCACHE_BASEDIR="$(pwd)"
+CCACHE_NOHASHDIR=1
+
 "${cmake_binary}" "${configure_flags[@]}" ${extra_configure_flags[@]+"${extra_configure_flags[@]}"} .
 "${cmake_binary}" --build . -- -j "$(nproc)"
 "${cmake_binary}" --build . --target install

.evergreen/scripts/install-uninstall-check.sh

@@ -47,6 +47,10 @@ else
   BSON_ONLY_OPTION="-DENABLE_MONGOC=ON"
 fi
 
+# Allow reuse of ccache compilation results between different build directories.
+export CCACHE_BASEDIR CCACHE_NOHASHDIR
+CCACHE_BASEDIR="$SCRATCH_DIR"
+CCACHE_NOHASHDIR=1
 
 $CMAKE -DCMAKE_INSTALL_PREFIX=$INSTALL_PREFIX -DCMAKE_PREFIX_PATH=$INSTALL_DIR/lib/cmake $BSON_ONLY_OPTION "$SCRATCH_DIR"
 $CMAKE --build .
@@ -201,4 +205,3 @@ if test -d $INSTALL_DIR/share/mongo-c-driver; then
 else
   echo "$INSTALL_DIR/share/mongo-c-driver check ok"
 fi
-

.evergreen/scripts/link-sample-program-bson.sh

@@ -44,6 +44,11 @@ mkdir -p $INSTALL_DIR
 
 cd $BUILD_DIR
 
+# Allow reuse of ccache compilation results between different build directories.
+export CCACHE_BASEDIR CCACHE_NOHASHDIR
+CCACHE_BASEDIR="$SCRATCH_DIR"
+CCACHE_NOHASHDIR=1
+
 if [ "$LINK_STATIC" ]; then
   # Our CMake system builds shared and static by default.
   $CMAKE -DCMAKE_INSTALL_PREFIX=$INSTALL_DIR -DENABLE_TESTS=OFF "$SCRATCH_DIR"
@@ -71,6 +76,9 @@ else
 
 fi
 
+# Revert ccache options, they no longer apply.
+unset CCACHE_BASEDIR CCACHE_NOHASHDIR
+
 ls -l $INSTALL_DIR/lib
 
 set +o xtrace

.evergreen/scripts/link-sample-program.sh

@@ -72,10 +72,18 @@ fi
 
 ZSTD="AUTO"
 
+# Allow reuse of ccache compilation results between different build directories.
+export CCACHE_BASEDIR CCACHE_NOHASHDIR
+CCACHE_BASEDIR="$SCRATCH_DIR"
+CCACHE_NOHASHDIR=1
+
 $CMAKE -DCMAKE_INSTALL_PREFIX=$INSTALL_DIR -DCMAKE_PREFIX_PATH=$INSTALL_DIR/lib/cmake $SSL_CMAKE_OPTION $SNAPPY_CMAKE_OPTION $STATIC_CMAKE_OPTION -DENABLE_ZSTD=$ZSTD "$SCRATCH_DIR"
 $CMAKE --build . --parallel
 $CMAKE --build . --parallel --target install
 
+# Revert ccache options, they no longer apply.
+unset CCACHE_BASEDIR CCACHE_NOHASHDIR
+
 ls -l $INSTALL_DIR/lib
 
 set +o xtrace