使用CMake configure_file生成子项目CMakeLists.txt，如何处理跨工具链反向依赖？

问题背景 #

顶层项目包含多个子项目，每个子项目使用独立的编译器工具链（对应各自的toolchain文件），部分子项目构建主机可执行文件，部分生成其他平台的目标文件。当前通过configure_file()生成子项目的CMakeLists.txt，并通过自定义build_subA target触发子项目构建，但顶层项目无法直接导入子项目产物作为依赖，只能通过自定义target硬编码路径调用。

解决方案 #

方法1：通过自定义命令生成依赖并导入产物 #

核心是让CMake追踪子项目产物的生成过程，将产物标记为生成文件后导入为IMPORTED target，确保顶层项目能正确识别依赖关系。

1. 定义子项目产物的路径变量：

set(SUB_A_OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/subA/build/subA_target_file.exe)

2. 创建自定义命令关联生成规则，绑定到build_subA target：

add_custom_command(
  OUTPUT ${SUB_A_OUTPUT}
  COMMAND ${CMAKE_COMMAND} --build ${CMAKE_CURRENT_BINARY_DIR}/subA/build --target subA
  DEPENDS build_subA
  COMMENT "构建subA目标产物..."
)

3. 将产物导入为IMPORTED target，让CMake识别该目标：

add_executable(subA IMPORTED)
set_target_properties(subA PROPERTIES
  IMPORTED_LOCATION ${SUB_A_OUTPUT}
)
# 标记产物为生成文件，避免CMake在配置阶段检查文件是否存在
set_property(TARGET subA PROPERTY IMPORTED_NO_SONAME TRUE)

4. 顶层项目的目标可直接依赖该IMPORTED target：

add_custom_target(top_foo
  DEPENDS subA
  COMMAND foo --elf=$<TARGET_FILE:subA> ...
)

方法2：子项目导出目标，顶层项目导入 #

如果能通过模板修改子项目的CMakeLists.txt，可以让子项目构建时导出自身的target信息，顶层项目再导入这些信息，实现更规范的依赖管理。

1. 在子项目模板subproject_template.cmake中添加导出逻辑：

# 子项目构建完成后导出target配置
install(
  TARGETS subA
  EXPORT subA-targets
  DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/export
)
export(
  EXPORT subA-targets
  FILE ${CMAKE_CURRENT_BINARY_DIR}/export/subA-targets.cmake
)

2. 修改顶层项目的build_subA target，确保执行导出步骤：

add_custom_target(build_subA
  DEPENDS ...
  COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_CURRENT_BINARY_DIR}/subA/build
  COMMAND ${CMAKE_COMMAND}
    -DCMAKE_TOOLCHAIN_FILE="${CMAKE_SOURCE_DIR}/cmake/toolchain_subA.cmake"
    -G${CMAKE_GENERATOR}
    -S${CMAKE_CURRENT_BINARY_DIR}/subA
    -B${CMAKE_CURRENT_BINARY_DIR}/subA/build
  COMMAND ${CMAKE_COMMAND} --build ${CMAKE_CURRENT_BINARY_DIR}/subA/build --target subA
  COMMAND ${CMAKE_COMMAND} --install ${CMAKE_CURRENT_BINARY_DIR}/subA/build --prefix ${CMAKE_CURRENT_BINARY_DIR}/subA/export
)

3. 顶层项目中导入子项目的target：

# 导入子项目导出的target配置文件
include(${CMAKE_CURRENT_BINARY_DIR}/subA/export/subA-targets.cmake)

# 直接依赖subA target
add_custom_target(top_foo
  DEPENDS subA
  COMMAND foo --elf=$<TARGET_FILE:subA> ...
)

方法3：使用ExternalProject模块（官方推荐方案） #

CMake的ExternalProject模块专门用于管理独立工具链的外部项目，能自动处理依赖关系、构建流程和产物追踪，简化手动配置。

include(ExternalProject)

ExternalProject_Add(
  subA
  SOURCE_DIR ${CMAKE_CURRENT_BINARY_DIR}/subA
  BINARY_DIR ${CMAKE_CURRENT_BINARY_DIR}/subA/build
  CMAKE_ARGS
    -DCMAKE_TOOLCHAIN_FILE=${CMAKE_SOURCE_DIR}/cmake/toolchain_subA.cmake
    -G${CMAKE_GENERATOR}
  BUILD_COMMAND ${CMAKE_COMMAND} --build . --target subA
  INSTALL_COMMAND ""  # 无需安装则留空
)

# 获取子项目构建目录，拼接产物路径
ExternalProject_Get_Property(subA BINARY_DIR)
set(SUB_A_OUTPUT ${BINARY_DIR}/subA_target_file.exe)

# 导入为IMPORTED target
add_executable(subA_imported IMPORTED)
set_target_properties(subA_imported PROPERTIES
  IMPORTED_LOCATION ${SUB_A_OUTPUT}
)
add_dependencies(subA_imported subA)

# 顶层目标依赖导入的target
add_custom_target(top_foo
  DEPENDS subA_imported
  COMMAND foo --elf=$<TARGET_FILE:subA_imported> ...
)

关键注意事项 #

• 优先使用CMake生成器表达式（如$<TARGET_FILE:subA>）代替硬编码路径，避免平台或构建目录变化导致的路径错误。
• 对于非主机平台的产物，CMake在配置阶段不会检查文件存在性，只需确保构建阶段的依赖关系正确即可。
• ExternalProject是官方推荐的跨工具链子项目管理方案，能大幅减少手动维护的构建逻辑，提升配置的可维护性。

内容的提问来源于stack exchange，提问作者Lance E.T. Compte