CheckLinkerFlag¶
在 3.18 版本中新增。
该模块提供了一个用于检查编译器是否支持指定链接器标志的命令。
在 CMake 项目中加载此模块，使用
include(CheckLinkerFlag)
命令¶
此模块提供以下命令
- check_linker_flag¶
一次性检查编译器是否支持给定的链接器标志
check_linker_flag(<lang> <flag> <variable>)
此命令用于检查
<lang>编译器是否接受链接器标志<flag>且不产生诊断消息。参数为
<lang>用于检查的编译器语言。支持的语言包括
C、CXX、CUDA、Fortran、HIP、OBJC、OBJCXX和Swift。3.19 版本新增：支持
CUDA语言。版本 3.21 新增：支持
HIP语言。版本 3.26 新增：支持
Swift语言。<flag>要检查的链接器标志。可以使用分号分隔列表在单个参数中指定多个标志。
底层实现使用
LINK_OPTIONS目标属性来测试指定的标志。可以使用LINKER:(和SHELL:) 前缀，具体如处理编译器驱动程序差异一节所述。<variable>用于存储检查结果的变量名。该变量将作为一个内部缓存变量创建。
该命令会临时设置
CMAKE_REQUIRED_LINK_OPTIONS变量，并调用check_source_compiles()命令（来自CheckSourceCompiles模块）。成功的结果仅表明编译器在获得该链接器标志时未报告错误。该标志是否具有预期的效果超出了本模块的范围。
注意
由于底层的
try_compile()命令也使用CMAKE_<LANG>_FLAGS等变量中的标志，这些变量中未知或不支持的标志可能导致此检查出现误报（假阴性）。影响检查的变量
在调用此命令之前，可以设置以下变量来修改检查的运行方式
CMAKE_REQUIRED_FLAGS传递给编译器的额外标志的空格分隔字符串。分号分隔列表在此处无效。
CMAKE_<LANG>_FLAGS及其关联的特定于配置的CMAKE_<LANG>_FLAGS_<CONFIG>变量的内容会自动置于该变量内容之前，并添加到编译器命令中。
CMAKE_REQUIRED_DEFINITIONS分号分隔的编译器定义列表，每个定义的形式为
-DFOO或-DFOO=bar。还将自动添加对检查命令的 result variable 参数指定的名称的定义。
CMAKE_REQUIRED_INCLUDES要传递给编译器的头文件搜索路径的分号分隔列表。这些将是唯一使用的头文件搜索路径；将忽略
INCLUDE_DIRECTORIES目录属性的内容。
CMAKE_REQUIRED_LIBRARIES要添加到链接命令的库的分号分隔列表。这些可以是系统库的名称，也可以是 导入的目标（有关更多详细信息，请参阅
try_compile()）。
CMAKE_REQUIRED_LINK_DIRECTORIES在版本 3.31 中添加。
要传递给链接器的库搜索路径的分号分隔列表（有关更多详细信息，请参阅
try_compile()）。
CMAKE_REQUIRED_QUIET版本 3.1 中新增。
如果此变量评估为布尔真值，则与检查关联的所有状态消息都将被抑制。
处理编译器驱动器差异¶
为了将选项传递给链接器工具，每个编译器驱动程序都有其特定的语法。可以使用 LINKER: 前缀和 , 分隔符以可移植的方式指定传递给链接器工具的选项。LINKER: 将被替换为相应的驱动程序选项，, 将被替换为相应的驱动程序分隔符。驱动程序前缀和分隔符由 CMAKE_<LANG>_LINKER_WRAPPER_FLAG 和 CMAKE_<LANG>_LINKER_WRAPPER_FLAG_SEP 变量的值给定。
例如，对于 Clang，"LINKER:-z,defs" 会变成 -Xlinker -z -Xlinker defs；对于 GNU GCC，则会变成 -Wl,-z,defs。
LINKER: 前缀可以作为 SHELL: 前缀表达式的一部分指定。
LINKER: 前缀支持使用 SHELL: 前缀和空格作为分隔符来指定参数，作为一种替代语法。前面的示例将变为 "LINKER:SHELL:-z defs"。
注意
不支持在 LINKER: 前缀的开头以外的任何位置指定 SHELL: 前缀。
示例¶
示例：检查链接器标志¶
以下示例演示了如何使用此模块检查 -z relro 链接器标志，该标志在许多类 Unix 系统上受支持，用于启用只读重定位以提高二进制安全性。如果链接器支持该标志，则使用 target_link_options() 将其有条件地添加到可执行目标中。LINKER: 前缀用于以可移植且独立于编译器的方式将标志传递给链接器。
include(CheckLinkerFlag)
check_linker_flag(C "LINKER:-z,relro" HAVE_Z_RELRO)
add_executable(example main.c)
if(HAVE_Z_RELRO)
target_link_options(example PRIVATE "LINKER:-z,relro")
endif()
示例：检查多个标志¶
在下面的示例中，同时检查多个链接器标志
include(CheckLinkerFlag)
check_linker_flag(C "LINKER:-z,relro;LINKER:-z,now" HAVE_FLAGS)
add_executable(example main.c)
if(HAVE_FLAGS)
target_link_options(example PRIVATE LINKER:-z,relro LINKER:-z,now)
endif()
另请参阅¶
使用
CMAKE_LINKER_TYPE变量指定链接器，该链接器也将被此模块使用。CheckCompilerFlag模块用于检查编译器标志是否受支持。