Skip to content

[CMake] Configure ccache using command line options #134857

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 14, 2025
Merged

[CMake] Configure ccache using command line options #134857

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
773575f
[CMake] Configure ccache using command line options
mrkajetanp Apr 8, 2025
8e259f4
[CMake] Quote CCACHE_PROGRAM in case it has spaces
mrkajetanp Apr 8, 2025
7d7d282
[CMake] Keep ccache-related CACHE variables
mrkajetanp Apr 8, 2025
61d4754
[CMake] Include pre-4.8 ccache error on Windows
mrkajetanp Apr 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 37 additions & 16 deletions llvm/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,30 +271,51 @@ set(LLVM_CCACHE_BUILD OFF CACHE BOOL "Set to ON for a ccache enabled build")
if(LLVM_CCACHE_BUILD)
find_program(CCACHE_PROGRAM ccache)
if(CCACHE_PROGRAM)
# ccache --version example output: "ccache version 4.9.1\n(..)"
execute_process(COMMAND ${CCACHE_PROGRAM} --version OUTPUT_VARIABLE CCACHE_VERSION_STR)
string(REGEX MATCH "[0-9]+\.[0-9]+\.?[0-9]*" CCACHE_VERSION "${CCACHE_VERSION_STR}")

set(LLVM_CCACHE_MAXSIZE "" CACHE STRING "Size of ccache")
set(LLVM_CCACHE_DIR "" CACHE STRING "Directory to keep ccached data")
set(LLVM_CCACHE_PARAMS "CCACHE_CPP2=yes CCACHE_HASHDIR=yes"
CACHE STRING "Parameters to pass through to ccache")

if(NOT CMAKE_SYSTEM_NAME MATCHES "Windows")
set(CCACHE_PROGRAM "${LLVM_CCACHE_PARAMS} ${CCACHE_PROGRAM}")
# ccache only supports passing options on the command line from version 4.8.0
# use a workaround with ad-hoc environment variables for older versions
if (CCACHE_VERSION VERSION_LESS "4.8.0")
set(LLVM_CCACHE_PARAMS "CCACHE_CPP2=yes;CCACHE_HASHDIR=yes"
CACHE STRING "Parameters to pass through to ccache")

if(NOT CMAKE_SYSTEM_NAME MATCHES "Windows")
set(launcher_params ${LLVM_CCACHE_PARAMS})
if (LLVM_CCACHE_MAXSIZE)
set(launcher_params CCACHE_MAXSIZE=${LLVM_CCACHE_MAXSIZE} ${launcher_params})
endif()
if (LLVM_CCACHE_DIR)
set(launcher_params CCACHE_DIR=${LLVM_CCACHE_DIR} ${launcher_params})
endif()
set(launcher ${launcher_params} "${CCACHE_PROGRAM}")
else()
if(LLVM_CCACHE_MAXSIZE OR LLVM_CCACHE_DIR OR
NOT LLVM_CCACHE_PARAMS MATCHES "CCACHE_CPP2=yes;CCACHE_HASHDIR=yes")
message(FATAL_ERROR "Ccache configuration through CMake is not supported on Windows. Please use environment variables.")
endif()
set(launcher "${CCACHE_PROGRAM}")
endif()
else()
set(LLVM_CCACHE_PARAMS "run_second_cpp=true;hash_dir=true"
CACHE STRING "Parameters to pass through to ccache")

set(launcher_params ${LLVM_CCACHE_PARAMS})
if (LLVM_CCACHE_MAXSIZE)
set(CCACHE_PROGRAM "CCACHE_MAXSIZE=${LLVM_CCACHE_MAXSIZE} ${CCACHE_PROGRAM}")
set(launcher_params max_size=${LLVM_CCACHE_MAXSIZE} ${launcher_params})
endif()
if (LLVM_CCACHE_DIR)
set(CCACHE_PROGRAM "CCACHE_DIR=${LLVM_CCACHE_DIR} ${CCACHE_PROGRAM}")
set(launcher_params cache_dir=${LLVM_CCACHE_DIR} ${launcher_params})
endif()
set_property(GLOBAL PROPERTY RULE_LAUNCH_COMPILE ${CCACHE_PROGRAM})
else()
if(LLVM_CCACHE_MAXSIZE OR LLVM_CCACHE_DIR OR
NOT LLVM_CCACHE_PARAMS MATCHES "CCACHE_CPP2=yes CCACHE_HASHDIR=yes")
message(FATAL_ERROR "Ccache configuration through CMake is not supported on Windows. Please use environment variables.")
endif()
# RULE_LAUNCH_COMPILE should work with Ninja but currently has issues
# with cmd.exe and some MSVC tools other than cl.exe
set(CMAKE_C_COMPILER_LAUNCHER ${CCACHE_PROGRAM})
set(CMAKE_CXX_COMPILER_LAUNCHER ${CCACHE_PROGRAM})
set(launcher "${CCACHE_PROGRAM}" ${launcher_params})
endif()

set(CMAKE_C_COMPILER_LAUNCHER ${launcher})
set(CMAKE_CXX_COMPILER_LAUNCHER ${launcher})
else()
message(FATAL_ERROR "Unable to find the program ccache. Set LLVM_CCACHE_BUILD to OFF")
endif()
Expand Down