Use ccache with more packages

Author: ekilmer

Dockerfile

@@ -44,6 +44,7 @@ RUN ./pkgman.py \
   --c_compiler=/usr/bin/clang \
   --cxx_compiler=/usr/bin/clang++ \
   --verbose \
+  --use_ccache \
   --repository_path="${BOOTSTRAP}" \
   --packages=cmake
 
@@ -68,6 +69,7 @@ RUN mkdir -p /cache && ./pkgman.py \
   --cxx_compiler="${LIBRARIES}/llvm/bin/clang++" \
   --c_compiler="${LIBRARIES}/llvm/bin/clang" \
   --verbose \
+  --use_ccache \
   "--additional_paths=${BOOTSTRAP}/cmake/bin:${LIBRARIES}/llvm/bin" \
   "--repository_path=${LIBRARIES}" \
   "--packages=cmake,google,xed"

pkgman/installers/common.py

@@ -100,6 +100,9 @@ def google_installer_glog(properties):
       print(" x Failed to create the build folder")
       return False
 
+  if properties["ccache"]:
+      set_ccache_compiler()
+
   cmake_command = ["cmake"] + get_env_compiler_settings() + get_cmake_build_type(debug) + get_cmake_generator()
   cmake_command += ["-DCMAKE_CXX_STANDARD=11",
                     "-DBUILD_TESTING=OFF",
@@ -141,6 +144,9 @@ def common_installer_capstone(properties):
       print(" x Failed to create the build folder")
       return False
 
+  if properties["ccache"]:
+      set_ccache_compiler()
+
   cmake_command = ["cmake"] + get_env_compiler_settings() + get_cmake_build_type(debug) + get_cmake_generator()
   cmake_command += ["-DCMAKE_EXE_LINKER_FLAGS=-g",
                     "-DCMAKE_C_FLAGS=-g",
@@ -247,6 +253,8 @@ def google_installer_gflags(properties):
       print(" x Failed to create the build folder")
       return False
 
+  if properties["ccache"]:
+      set_ccache_compiler()
 
   cmake_command = ["cmake"] + get_env_compiler_settings() + get_cmake_build_type(debug) + get_cmake_generator()
   cmake_command += ["-DCMAKE_INSTALL_PREFIX=" + os.path.join(repository_path, "gflags"),
@@ -289,6 +297,9 @@ def google_installer_googletest(properties):
       print(" x Failed to create the build folder")
       return False
 
+  if properties["ccache"]:
+      set_ccache_compiler()
+
   cmake_command = ["cmake"] + get_env_compiler_settings() + get_cmake_build_type(debug) + get_cmake_generator(False)
   cmake_command += ["-DCMAKE_CXX_STANDARD=11",
                     "-DCMAKE_POSITION_INDEPENDENT_CODE=ON",
@@ -363,6 +374,9 @@ def google_installer_protobuf(properties):
       print(" x Failed to create the build folder")
       return False
 
+  if properties["ccache"]:
+      set_ccache_compiler()
+
   cmake_command = ["cmake"] + get_env_compiler_settings() + get_cmake_build_type(debug) + get_cmake_generator(False)
   cmake_command += ["-DPROTOBUF_ROOT=" + source_folder,
                     "-DBUILD_SHARED_LIBS=OFF",
@@ -433,6 +447,9 @@ def common_installer_capnproto(properties):
       print(" x Failed to create the build folder")
       return False
 
+  if properties["ccache"]:
+      set_ccache_compiler()
+
   cmake_command = ["cmake"] + get_env_compiler_settings() + get_cmake_build_type(debug) + get_cmake_generator()
   cmake_command += ["-DCMAKE_CXX_STANDARD=11",
                     "-DCMAKE_CXX_EXTENSIONS=ON",
@@ -590,6 +607,13 @@ def common_installer_llvm(properties):
     arch_list += ";AArch64;Sparc;NVPTX;ARM"
   arch_list += "'"
 
+  if properties["ccache"]:
+    # Remove this so we don't clash with LLVM's built-in ccache config
+    if "CMAKE_CXX_COMPILER_LAUNCHER" in os.environ:
+      del(os.environ["CMAKE_CXX_COMPILER_LAUNCHER"])
+    if "CMAKE_C_COMPILER_LAUNCHER" in os.environ:
+      del(os.environ["CMAKE_C_COMPILER_LAUNCHER"])
+
   cppstd = "11"
   if int(properties["llvm_version"]) > 900:
     cppstd = "14"
@@ -662,6 +686,9 @@ def common_installer_z3(properties):
       print(" x Failed to create the build folder")
       return False
 
+  if properties["ccache"]:
+      set_ccache_compiler()
+
   cmake_command = ["cmake"] + get_env_compiler_settings() + get_cmake_build_type(debug) + get_cmake_generator()
   cmake_command += ["-DZ3_BUILD_LIBZ3_SHARED=False",
                     "-DZ3_ENABLE_EXAMPLE_TARGETS=False",

pkgman/installers/unix.py

@@ -53,6 +53,11 @@ def unix_installer_boost(properties, default_toolset):
   if "CMAKE_CXX_COMPILER" in os.environ:
     os.environ["CXX"] = os.environ["CMAKE_CXX_COMPILER"]
 
+  if properties["ccache"]:
+    set_ccache_compiler()
+    os.environ["CXX"] = f"ccache {os.environ['CXX']}"
+    os.environ["CC"] = f"ccache {os.environ['CC']}"
+
   configure_command = [source_folder + "/bootstrap.sh", "--prefix=" + os.path.join(repository_path, "boost"), "--with-toolset=" + toolset_name]
   if not run_program("Running the bootstrap script...", configure_command, source_folder, verbose=verbose_output):
     return False
@@ -118,7 +123,12 @@ def unix_installer_cmake(properties):
   if os.environ.get("CMAKE_CXX_COMPILER") is not None:
     os.environ["CXX"] = os.environ["CMAKE_CXX_COMPILER"]
 
-  if not run_program("Running the bootstrap script...", ["./bootstrap", "--verbose", "--parallel=" + str(multiprocessing.cpu_count()), "--prefix=" + destination_path], source_folder, verbose=verbose_output):
+  enable_ccache = ""
+  if properties["ccache"]:
+    set_ccache_compiler()
+    enable_ccache = "--enable-ccache"
+
+  if not run_program("Running the bootstrap script...", ["./bootstrap", "--verbose", enable_ccache, "--parallel=" + str(multiprocessing.cpu_count()), "--prefix=" + destination_path], source_folder, verbose=verbose_output):
     return False
 
   if not run_program("Building the source code...", ["make", "-j" + str(multiprocessing.cpu_count())], source_folder, verbose=verbose_output):

pkgman/installers/utils.py

@@ -32,8 +32,26 @@ def get_env_compiler_settings():
   if os.environ.get("CMAKE_C_COMPILER") is not None:
     cmake_compiler_settings.append("-DCMAKE_C_COMPILER=" + os.environ["CMAKE_C_COMPILER"])
 
+  if os.environ.get("CMAKE_CXX_COMPILER_LAUNCHER") is not None:
+    cmake_compiler_settings.append("-DCMAKE_CXX_COMPILER_LAUNCHER=" + os.environ["CMAKE_CXX_COMPILER_LAUNCHER"])
+
+  if os.environ.get("CMAKE_C_COMPILER_LAUNCHER") is not None:
+    cmake_compiler_settings.append("-DCMAKE_C_COMPILER_LAUNCHER=" + os.environ["CMAKE_C_COMPILER_LAUNCHER"])
+
   return cmake_compiler_settings
 
+
+def set_ccache_compiler():
+    """
+    Set the compiler environment variables to use ccache.
+
+    NOTE: LLVM uses its own ccache settings. Make sure these are synchronized
+    """
+    os.environ["CMAKE_CXX_COMPILER_LAUNCHER"] = "ccache"
+    os.environ["CMAKE_C_COMPILER_LAUNCHER"] = "ccache"
+    os.environ["CCACHE_DIR"] = "/cache/ccache"
+
+
 def get_parallel_build_options():
   processor_count = str(multiprocessing.cpu_count())