如何让CMake在链接命令中避免传递重复的静态库？

问题描述 #

两个静态库LibA和LibB存在循环依赖，对应的CMake配置如下：

add_library(LibA STATIC a.c)
add_library(LibB STATIC b.c)

# 循环依赖: LibA <-> LibB
target_link_libraries(LibA PRIVATE LibB)
target_link_libraries(LibB PRIVATE LibA)

add_executable(Example main.c)
target_link_libraries(Example PRIVATE LibA LibB)

生成构建配置后，CMake为解决循环依赖会将LibA和LibB各传递两次给链接器，最终链接命令如下：

ilinkarm.exe --silent CMakeFiles\Example.dir\main.c.o  LibA.lib  LibB.lib  LibA.lib  LibB.lib -o Example.exe

由于IAR链接器本身会对库列表进行多遍处理，仅需列出每个库一次即可。重复链接虽能正常工作，但会触发以下警告：

[build] Warning[Li065]: duplicate file: "LibA.lib"
[build] Warning[Li065]: duplicate file: "LibB.lib"

尝试设置CMAKE_C_LINK_EXECUTABLE但无效，因为<LINK_LIBRARIES>变量已包含重复库条目。使用版本：CMake 3.26.3、Ninja 1.10.2、IAR 9.32.2。

可行解决方案 #

方法1：手动收集并去重库文件路径 #

通过自定义链接命令，手动收集目标库的实际文件路径并去重，替代默认的<LINK_LIBRARIES>变量：

add_library(LibA STATIC a.c)
add_library(LibB STATIC b.c)

# 保留依赖声明以确保编译阶段的头文件和选项正确传递
target_link_libraries(LibA PRIVATE LibB)
target_link_libraries(LibB PRIVATE LibA)

add_executable(Example main.c)

# 定义需要链接的库目标列表
set(EXAMPLE_LINK_TARGETS LibA LibB)
# 将目标转换为实际库文件路径
foreach(target IN LISTS EXAMPLE_LINK_TARGETS)
    list(APPEND EXAMPLE_LINK_FILES $<TARGET_FILE:${target}>)
endforeach()
# 移除重复的库文件路径
list(REMOVE_DUPLICATES EXAMPLE_LINK_FILES)

# 覆盖默认链接命令，使用去重后的库列表
set(CMAKE_C_LINK_EXECUTABLE "<CMAKE_LINKER> <OBJECTS> <LINK_FLAGS> ${EXAMPLE_LINK_FILES} -o <TARGET>")

方法2：创建聚合静态库 #

将循环依赖的LibA和LibB打包为一个新的聚合静态库，链接时仅需引用该聚合库：

add_library(LibA STATIC a.c)
add_library(LibB STATIC b.c)

# 保留循环依赖声明
target_link_libraries(LibA PRIVATE LibB)
target_link_libraries(LibB PRIVATE LibA)

# 创建聚合库，包含LibA和LibB的所有对象文件
add_library(LibAB STATIC)
target_sources(LibAB PRIVATE $<TARGET_OBJECTS:LibA> $<TARGET_OBJECTS:LibB>)
# 传递原库的编译选项和头文件依赖给聚合库的使用者
target_link_libraries(LibAB INTERFACE LibA LibB)

add_executable(Example main.c)
# 仅链接聚合库即可
target_link_libraries(Example PRIVATE LibAB)

方法3：使用CMake LINK_GROUP特性（CMake 3.12+） #

利用$<LINK_GROUP:>表达式将循环依赖的库分组，CMake会自动处理重复条目，同时确保链接器正确解析循环依赖：

add_library(LibA STATIC a.c)
add_library(LibB STATIC b.c)

target_link_libraries(LibA PRIVATE LibB)
target_link_libraries(LibB PRIVATE LibA)

add_executable(Example main.c)
# 将循环依赖的库放入链接组
target_link_libraries(Example PRIVATE $<LINK_GROUP:,$<TARGET_FILE:LibA>,$<TARGET_FILE:LibB>>)

方案对比 #

• 方法1：灵活可控，直接干预链接列表，适合依赖较少的场景；缺点是依赖库变动时需手动更新列表。
• 方法2：结构清晰，通过聚合库封装循环依赖，便于维护；缺点是需额外维护聚合库的配置。
• 方法3：CMake原生支持，代码简洁；缺点是依赖CMake版本≥3.12，需确认IAR链接器对该特性的兼容性。

内容的提问来源于stack exchange，提问作者JiaemTheCode