在 CMake 中使用编译器前缀命令（distcc、ccache）答案

【问题标题】：Using compiler prefix command(s) with CMake (distcc, ccache)在 CMake 中使用编译器前缀命令（distcc、ccache）
【发布时间】：2015-09-24 02:36:19
【问题描述】：

有些实用程序通过添加命令作为前缀来使用现有编译器（因此，您可以调用distcc cc -c file.c，而不是调用distcc cc -c file.c）。

使用 CMake 时，可以更改编译器命令，但是我在尝试使用 distcc 时遇到了问题，尽管这可能适用于编译器的任何命令前缀（ccache 也一样）。

CMake 期望编译器是绝对路径，
因此将 CMAKE_C_COMPILER 设置为 /usr/bin/distcc /usr/bin/cc，会产生错误：

/usr/bin/distcc /usr/bin/cc is not a full path to an existing compiler tool.
将编译器设置为/usr/bin/distcc 和
CMAKE_C_COMPILER_ARG1 或CMAKE_C_FLAGS 以/usr/bin/cc 开头在某些情况下有效，但在CHECK_C_SOURCE_COMPILES 时失败
（检查是否有支持这一点的方法，即使前缀 CMAKE_REQUIRED_FLAGS 也不起作用）。

我发现这样做的唯一方法是将命令包装在 shell 脚本中。

#!/bin/sh
exec /usr/bin/distcc /usr/bin/cc "$@"

虽然这可行，但如果能够在 CMake 中使用编译器帮助程序，而不必通过 shell 脚本（当构建系统可以只使用命令前缀时会产生一些小开销），那就太好了。

所以我的问题是：

CMake 是否可以直接使用编译器前缀命令（如 distcc）？无需 shell 脚本包装器？

【问题讨论】：

在调用 cmake 时设置CC/CXX 环境变量是否因某种原因不足（例如CC="distcc gcc" cmake ..）？
@Iskar Jarak，这行得通！（所以我想这可能是答案）。有趣的是，在内部它使用CMAKE_C_COMPILER 作为第一个命令，CMAKE_C_COMPILER_ARG1 作为第二个命令。我不确定发生了什么 - 因为我已经尝试在 cmake-gui 中设置这些，而 CMAKE_C_COMPILER_ARG1 被 CHECK_C_SOURCE_COMPILES 忽略。
很高兴它有效。设置环境变量可能还会设置其他一些东西，CHECK_C_SOURCE_COMPILES 使用的东西......虽然我不是 100% 什么......这就是为什么在 CMake 中弄乱单个变量是一件令人头疼的事情。

标签： c++ c build cmake

【解决方案1】：

从CMake 3.4.0 开始，就有了CMAKE_<LANG>_COMPILER_LAUNCHER 变量和对应的目标属性<LANG>_COMPILER_LAUNCHER。因此，如果您的项目是纯 C 语言，您可以执行以下操作：

cmake -DCMAKE_C_COMPILER_LAUNCHER=ccache /path/to/source
CCACHE_PREFIX=distcc make -j`distcc -j`

如果您有 C++ 项目，请使用 -DCMAKE_CXX_COMPILER_LAUNCHER=ccache。

或者，让您的CMakeLists.txt 智能并自动使用 ccache（如果可以找到）：

#-----------------------------------------------------------------------------
# Enable ccache if not already enabled by symlink masquerading and if no other
# CMake compiler launchers are already defined
#-----------------------------------------------------------------------------
find_program(CCACHE_EXECUTABLE ccache)
mark_as_advanced(CCACHE_EXECUTABLE)
if(CCACHE_EXECUTABLE)
  foreach(LANG C CXX)
    if(NOT DEFINED CMAKE_${LANG}_COMPILER_LAUNCHER AND NOT CMAKE_${LANG}_COMPILER MATCHES ".*/ccache")
      message(STATUS "Enabling ccache for ${LANG}")
      set(CMAKE_${LANG}_COMPILER_LAUNCHER ${CCACHE_EXECUTABLE} CACHE STRING "")
    endif()
  endforeach()
endif()

【讨论】：

根据 CMake 文档，<LANG>_COMPILER_LAUNCHER 目标属性只会被 Makefiles 和 Ninja 生成器支持。你必须做更多的工作才能让 Xcode 使用启动器。有关使用旧 RULE_LAUNCH_COMPILE 变量和 CMAKE_XCODE_ATTRIBUTE_... 的更通用方法，请参阅 this answer，但与您的方法有相似之处。
遗憾的是，CMAKE__COMPILER_LAUNCHER 在 CHECK__SOURCE_COMPILES 中被忽略，即使使用最新的 cmake (3.10.1)。这意味着如果测试结果取决于启动器，则仍然需要包装器。

【解决方案2】：

作为一个提示：永远不要使用<LANG>_COMPILER_LAUNCHER 来交叉编译。如果<LANG>_COMPILER_LAUNCHER 与 distcc 一起使用，则绝对编译器路径将发送到 distcc 并且主机未使用交叉编译工具链！

你应该使用老派的方法，只是覆盖编译器路径：

export PATH=/usr/lib/distcc:$PATH

我花了几个小时才发现...

【讨论】：

对于 distcc 是的，因为它不在同一台机器上运行。对于 ccache 它仍然可以正常工作。