FindCUDA

版本 3.27 中已更改： 仅当策略 CMP0146 未设置为 NEW 时，此模块才可用。请将项目移植到 CMake 的一流 CUDA 语言支持。

版本 3.10 已弃用： 请勿在新代码中使用此模块。

现在无需使用此模块或调用 find_package(CUDA) 来编译 CUDA 代码。而是将 CUDA 列入顶层 project() 调用中命名的语言之一，或者使用 CUDA 调用 enable_language() 命令。然后，您可以像其他语言一样将 CUDA（.cu）源文件添加到目标。

版本 3.17 中已添加： 要手动查找和使用 CUDA 工具包库，请改用 FindCUDAToolkit 模块。无论是否启用了 CUDA 语言，它都可以正常工作。

已弃用用法的文档

用于构建 CUDA C 文件的工具：库和构建依赖项。

此脚本定位 NVIDIA CUDA C 工具。它应该能在 Linux、Windows 和 macOS 上运行，并且应与 CUDA C 版本保持相对最新。

版本 3.19 中已添加： QNX 支持。

此脚本利用了 <VERSION>、REQUIRED 和 QUIET 的标准 find_package() 参数。CUDA_FOUND 将报告是否找到了可接受的 CUDA 版本。

如果无法通过系统路径中的 nvcc 位置确定前缀，并且将 REQUIRED 指定给 find_package()，脚本将提示用户指定 CUDA_TOOLKIT_ROOT_DIR。要在运行 cmake 之前使用工具包的不同已安装版本，请设置环境变量 CUDA_BIN_PATH（例如，CUDA_BIN_PATH=/usr/local/cuda1.0 而不是默认的 /usr/local/cuda），或者在配置后设置 CUDA_TOOLKIT_ROOT_DIR。如果更改 CUDA_TOOLKIT_ROOT_DIR 的值，将重新定位依赖于该路径的各种组件。

在某些平台上，可能需要手动设置 CUDA_TOOLKIT_ROOT_DIR，或使用未安装在默认位置的 CUDA 运行时。在较新版本的工具包中，CUDA 库已包含在图形驱动程序中 — 请确保驱动程序版本与 CUDA 运行时版本所需的版本匹配。

输入变量

以下变量会影响脚本中宏的行为（按字母顺序排列）。请注意，在调用 cuda_add_executable()、cuda_add_library()、cuda_compile()、cuda_compile_ptx()、cuda_compile_fatbin()、cuda_compile_cubin() 或 cuda_wrap_srcs() 之前的同一个目录中，可以多次更改这些标志中的任何一个。

CUDA_64_BIT_DEVICE_CODE (默认：主机位数)

设置为 ON 以编译 64 位设备代码，设置为 OFF 以编译 32 位设备代码。请注意，当从 CUDA 代码生成对象文件或 C 文件时，如果此设置与主机代码不同，将会导致失败，因为 size_t 是由 nvcc 在生成的源文件中定义的。如果您编译到 PTX 然后自行加载该文件，则可以混合设备和主机的位数。

CUDA_ATTACH_VS_BUILD_RULE_TO_CUDA_FILE (默认：ON)

如果您希望将自定义构建规则附加到 Visual Studio 中的源文件，请将其设置为 ON。如果将同一 cuda 文件添加到多个目标，请将其设置为 OFF。

这允许用户从 CUDA 文件构建目标；但是，如果将 CUDA 源文件添加到多个目标，可能会出现问题。在执行并行构建时，自定义构建命令可能会运行多次或并行运行，从而导致难以理解的构建错误。VS 会为目标中的每个源文件运行规则，并且一个源文件无论添加到多少项目中，都只能有一个规则。当规则从多个目标运行时，可能会在生成的文件上发生竞态条件。最终所有内容都会被构建，但如果用户不了解此行为，可能会感到困惑。如果脚本能检测到跨多个目标重用源文件的行为并为用户关闭该选项，那将很好，但找不到好的解决方案。

CUDA_BUILD_CUBIN (默认：OFF)

设置为 ON 以在设备模式下启用额外的编译传递，并使用 -cubin 选项。输出会被解析，并在构建过程中打印寄存器和共享内存的使用情况。

CUDA_BUILD_EMULATION (默认：设备模式为 OFF)

设置为 ON 以启用仿真模式。CUDA_BUILD_EMULATION 为 TRUE 时，为 CUDA C 文件定义了 -D_DEVICEEMU。

CUDA_LINK_LIBRARIES_KEYWORD (默认："")

版本 3.9 中添加。

用于内部 target_link_libraries() 调用的 <PRIVATE|PUBLIC|INTERFACE> 关键字。默认情况下不使用关键字，即使用 target_link_libraries() 的旧“纯”形式。请注意，这很重要，因为 FindCUDA 模块内部使用的内容也必须在外部使用 — target_link_libraries() 的这两种形式不能混合使用。

CUDA_GENERATED_OUTPUT_DIR (默认：CMAKE_CURRENT_BINARY_DIR)

设置为希望放置生成文件的路径。如果为空，输出文件将放置在 CMAKE_CURRENT_BINARY_DIR 中。中间文件将始终放置在 CMAKE_CURRENT_BINARY_DIR/CMakeFiles 中。

CUDA_HOST_COMPILATION_CPP (默认：ON)

对于主机代码的 C 编译，设置为 OFF。

CUDA_HOST_COMPILER (默认：CMAKE_C_COMPILER)

设置 nvcc 使用的主机编译器。如果 CUDA_NVCC_FLAGS 或 CUDA_NVCC_FLAGS_<CONFIG> 变量中已存在 -ccbin 或 --compiler-bindir，则忽略此设置。对于 Visual Studio 目标，主机编译器是通过一个或多个 visual studio 宏（例如 $(VCInstallDir)）构建的，该宏会在命令从 VS 中运行时展开为路径。

版本 3.13 中已添加： 如果设置了 CUDAHOSTCXX 环境变量，它将用作默认值。

CUDA_NVCC_FLAGS, CUDA_NVCC_FLAGS_<CONFIG>

其他 NVCC 命令行参数。注意：多个参数必须用分号分隔（例如 --compiler-options;-Wall）。

版本 3.6 中已添加： 这些变量的内容可能使用 生成器表达式。

CUDA_PROPAGATE_HOST_FLAGS (默认：ON)

设置为 ON 以通过 nvcc 的 -Xcompiler 标志自动将 CMAKE_{C,CXX}_FLAGS 及其配置相关计数器（例如 CMAKE_C_FLAGS_DEBUG）传播到主机编译器。这有助于使生成的宿主代码与系统其余部分更好地匹配。有时某些标志会导致 nvcc 出错，这将帮助您关闭标志传播。这不会影响通过 CUDA_NVCC_FLAGS 或通过 cuda_add_library()、cuda_add_executable() 或 cuda_wrap_srcs() 指定的 OPTION 标志直接传递给 nvcc 的标志。用于共享库编译的标志不受此标志影响。

CUDA_SEPARABLE_COMPILATION (默认：OFF)

如果设置，将为所有 CUDA 运行时对象文件启用可分离编译。如果用于 cuda_add_executable() 和 cuda_add_library() 之外（例如直接调用 cuda_wrap_srcs()），则应调用 cuda_compute_separable_compilation_object_file_name() 和 cuda_link_separable_compilation_objects()。

CUDA_SOURCE_PROPERTY_FORMAT

3.3 版本中新增。

如果设置了此源文件属性，它可以覆盖 cuda_wrap_srcs() 中指定的格式（OBJ、PTX、CUBIN 或 FATBIN）。如果输入源文件不是 .cu 文件，设置此文件将使其被视为 .cu 文件。有关如何设置此属性，请参阅 set_source_files_properties 的文档。

CUDA_USE_STATIC_CUDA_RUNTIME (默认：ON)

3.3 版本中新增。

启用时，将在 CUDA_LIBRARIES 中使用 CUDA 运行时的静态版本。如果配置的 CUDA 版本不支持此选项，则会将其静默禁用。

CUDA_VERBOSE_BUILD (默认：OFF)

设置为 ON 以查看构建 CUDA 文件时使用的所有命令。在使用 Makefile 生成器时，值默认为 VERBOSE（运行 make VERBOSE=1 查看输出），尽管将 CUDA_VERBOSE_BUILD 设置为 ON 将始终打印输出。

命令

该脚本创建以下函数和宏（按字母顺序排列）

cuda_add_cufft_to_target(<cuda_target>)

将 cufft 库添加到目标（可以是任何目标）。处理仿真模式。

cuda_add_cublas_to_target(<cuda_target>)

将 cublas 库添加到目标（可以是任何目标）。处理仿真模式。

cuda_add_executable(<cuda_target> <file>...
                    [WIN32] [MACOSX_BUNDLE] [EXCLUDE_FROM_ALL] [OPTIONS ...])

创建一个可执行文件 <cuda_target>，该文件由指定的文件组成。所有非 CUDA C 文件都使用 CMake 指定的标准构建规则进行编译，CUDA 文件使用 nvcc 和主机编译器编译为对象文件。此外，CUDA_INCLUDE_DIRS 会自动添加到 include_directories()。调用此宏后，可以使用一些标准的 CMake 目标调用（例如 set_target_properties() 和 target_link_libraries()），但调整编译标志的属性设置不会影响 nvcc 编译的代码。这些标志应在调用 cuda_add_executable()、cuda_add_library() 或 cuda_wrap_srcs() 之前进行修改。

cuda_add_library(<cuda_target> <file>...
                 [STATIC | SHARED | MODULE] [EXCLUDE_FROM_ALL] [OPTIONS ...])

与 cuda_add_executable() 相同，只是创建了一个库。

cuda_build_clean_target()

创建一个方便的目标，该目标删除所有生成的依赖文件。运行此目标后，您应该执行 make clean，以确保依赖文件被重新生成。

cuda_compile(<generated_files> <file>... [STATIC | SHARED | MODULE]
             [OPTIONS ...])

返回从输入源文件生成的文件的列表，用于与 add_library() 或 add_executable() 一起使用。

cuda_compile_ptx(<generated_files> <file>... [OPTIONS ...])

返回从输入源文件生成的 PTX 文件列表。

cuda_compile_fatbin(<generated_files> <file>... [OPTIONS ...])

版本 3.1 中新增。

返回从输入源文件生成的 FATBIN 文件列表。

cuda_compile_cubin(<generated_files> <file>... [OPTIONS ...])

版本 3.1 中新增。

返回从输入源文件生成的 CUBIN 文件列表。

cuda_compute_separable_compilation_object_file_name(<output_file_var>
                                                    <cuda_target>
                                                    <object_files>)

计算可分离编译所需的中间链接文件的名称。此文件名通常传递给 CUDA_LINK_SEPARABLE_COMPILATION_OBJECTS。output_file_var 是基于 cuda_target 和需要可分离编译的对象文件列表生成的，如 <object_files> 所指定。如果 <object_files> 列表为空，则 <output_file_var> 将为空。此函数会自动为 cuda_add_library() 和 cuda_add_executable() 调用。请注意，这是一个函数而不是宏。

cuda_include_directories(path0 path1 ...)

设置应传递给 nvcc 的目录（例如 nvcc -Ipath0 -Ipath1 ...）。这些路径通常包含其他 .cu 文件。

cuda_link_separable_compilation_objects(<output_file_var> <cuda_target>
                                        <nvcc_flags> <object_files>)

为给定的对象文件生成可分离编译所需的链接对象。这会自动为 cuda_add_executable() 和 cuda_add_library() 调用，但在直接使用 cuda_wrap_srcs() 时也可以手动调用。当从 cuda_add_library() 或 cuda_add_executable() 调用时，传入的 <nvcc_flags> 与通过 OPTIONS 参数传入的标志相同。唯一自动添加的 nvcc 标志是 CUDA_64_BIT_DEVICE_CODE 指定的位宽标志。请注意，这是一个函数而不是宏。

cuda_select_nvcc_arch_flags(<out_variable> [<target_CUDA_architecture> ...])

根据 target_CUDA_architecture 选择 nvcc 的 GPU 架构标志。

target_CUDA_architecture 的值

• Auto：在运行时检测本地机器 GPU 计算架构。

• Common 和 All：覆盖常用和整个架构子集。

• <name>：Fermi、Kepler、Maxwell、Kepler+Tegra、Kepler+Tesla、Maxwell+Tegra、Pascal 之一。

• <ver>、<ver>(<ver>)、<ver>+PTX，其中 <ver> 是 2.0、2.1、3.0、3.2、3.5、3.7、5.0、5.2、5.3、6.0、6.2 之一。

在 <out_variable> 中返回要添加到 CUDA_NVCC_FLAGS 的标志列表。此外，将 <out_variable>_readable 设置为生成的数字列表。

示例

cuda_select_nvcc_arch_flags(ARCH_FLAGS "3.0" "3.5+PTX" "5.2(5.0)" "Maxwell")
list(APPEND CUDA_NVCC_FLAGS ${ARCH_FLAGS})

关于 CUDA 架构的更多信息：https://en.wikipedia.org/wiki/CUDA。请注意，这是一个函数而不是宏。

cuda_wrap_srcs(<cuda_target> <format> <generated_files> <file>...
               [STATIC | SHARED | MODULE] [OPTIONS ...])

这就是所有魔法发生的地方。cuda_add_executable()、cuda_add_library()、cuda_compile() 和 cuda_compile_ptx() 都在底层调用此函数。

给定文件列表 <file>...，此宏生成自定义命令，这些命令生成 PTX 或可链接对象（使用 <format> 参数的 PTX 或 OBJ 进行切换）。不以 .cu 结尾或具有 HEADER_FILE_ONLY 属性的文件将被忽略。

OPTIONS 之后传递的参数是传递给 nvcc 的额外命令行选项。您还可以通过指定配置名称后跟选项来指定每个配置的选项。通用选项必须先于特定于配置的选项。并非所有配置都需要指定，只有提供的配置才会被使用。例如：

cuda_add_executable(...
  OPTIONS -DFLAG=2 "-DFLAG_OTHER=space in flag"
  DEBUG -g
  RELEASE --use_fast_math
  RELWITHDEBINFO --use_fast_math;-g
  MINSIZEREL --use_fast_math)

对于某些配置（特别是使用 CUDA_ATTACH_VS_BUILD_RULE_TO_CUDA_FILE 设置为 ON 生成具有 ON 的对象文件的 VS），对于给定的 cuda 文件将不会生成任何文件。这是因为当您将 cuda 文件添加到 Visual Studio 时，它知道该文件会生成一个对象文件，并会自动链接生成的对象文件。

此脚本还将生成一个单独的 cmake 脚本，该脚本在构建时用于调用 nvcc。这是出于几个原因：

• nvcc 可以返回负数作为返回值，这会导致 Visual Studio 误认为命令成功。脚本现在会检查错误代码并在出现问题时生成错误。

• 众所周知，nvcc 在遇到问题时不会删除不完整的结果。这会导致构建系统误认为目标已生成，但实际上存在无法使用的文件。脚本现在会在出现错误时删除输出文件。

• 通过将影响构建的所有选项放入一个文件，然后使构建规则依赖于该文件，可以在选项更改时重新生成输出文件。

此脚本还检查可选参数 STATIC、SHARED 或 MODULE 以确定何时将对象编译作为共享库的目标。cuda_wrap_srcs() 中忽略了 BUILD_SHARED_LIBS，但在 cuda_add_library() 中会考虑它。在某些系统上，会为用于构建共享库对象的对象添加特殊标志。当检测到共享库编译时，会定义一个预处理器宏 <target_name>_EXPORTS。

使用 -D 或 /D 通过 add_definitions 传入的标志会传递给 nvcc。

结果变量

该脚本定义了以下变量

CUDA_VERSION_MAJOR

nvcc 报告的 CUDA 的主版本号。

CUDA_VERSION_MINOR

次版本号。

CUDA_VERSION, CUDA_VERSION_STRING

完整版本，格式为 X.Y。

CUDA_HAS_FP16

版本 3.6 中已添加： 是否支持短浮点数（float16, fp16）。

CUDA_TOOLKIT_ROOT_DIR

CUDA 工具包的路径（如果未设置，则定义）。

CUDA_SDK_ROOT_DIR

CUDA SDK 的路径。使用此路径查找 SDK 中的文件。此脚本不直接支持查找特定库或头文件，因为 NVIDIA 不支持这一点。如果您想在路径更改时更改库，请参阅 FindCUDA.cmake 脚本以获取如何清除这些变量的示例。还有如何使用 CUDA_SDK_ROOT_DIR 来定位头文件或库的示例（风险自负）。

CUDA_INCLUDE_DIRS

CUDA 头文件的包含目录。会自动为 cuda_add_executable() 和 cuda_add_library() 添加。

CUDA_LIBRARIES

Cuda RT 库。

CUDA_CUFFT_LIBRARIES

Cuda FFT 实现的设备或仿真库（cuda_add_cufft_to_target() 宏的替代项）。

CUDA_CUBLAS_LIBRARIES

Cuda BLAS 实现的设备或仿真库（cuda_add_cublas_to_target() 宏的替代项）。

CUDA_cudart_static_LIBRARY

可静态链接的 CUDA 运行时库。仅适用于 CUDA 版本 5.5+。

CUDA_cudadevrt_LIBRARY

版本 3.7 中已添加： 设备运行时库。可分离编译必需。

CUDA_cupti_LIBRARY

CUDA 性能分析工具接口库。仅适用于 CUDA 版本 4.0+。

CUDA_curand_LIBRARY

CUDA 随机数生成库。仅适用于 CUDA 版本 3.2+。

CUDA_cusolver_LIBRARY

版本 3.2 中已添加： CUDA Direct Solver 库。仅适用于 CUDA 版本 7.0+。

CUDA_cusparse_LIBRARY

CUDA 稀疏矩阵库。仅适用于 CUDA 版本 3.2+。

CUDA_npp_LIBRARY

NVIDIA Performance Primitives 库。仅适用于 CUDA 版本 4.0+。

CUDA_nppc_LIBRARY

NVIDIA Performance Primitives 库（核心）。仅适用于 CUDA 版本 5.5+。

CUDA_nppi_LIBRARY

NVIDIA Performance Primitives 库（图像处理）。仅适用于 CUDA 版本 5.5 - 8.0。

CUDA_nppial_LIBRARY

NVIDIA Performance Primitives 库（图像处理）。仅适用于 CUDA 版本 9.0。

CUDA_nppicc_LIBRARY

NVIDIA Performance Primitives 库（图像处理）。仅适用于 CUDA 版本 9.0。

CUDA_nppicom_LIBRARY

NVIDIA Performance Primitives 库（图像处理）。仅适用于 CUDA 版本 9.0 - 10.2。已被 nvjpeg 替换。

CUDA_nppidei_LIBRARY

NVIDIA Performance Primitives 库（图像处理）。仅适用于 CUDA 版本 9.0。

CUDA_nppif_LIBRARY

NVIDIA Performance Primitives 库（图像处理）。仅适用于 CUDA 版本 9.0。

CUDA_nppig_LIBRARY

NVIDIA Performance Primitives 库（图像处理）。仅适用于 CUDA 版本 9.0。

CUDA_nppim_LIBRARY

NVIDIA Performance Primitives 库（图像处理）。仅适用于 CUDA 版本 9.0。

CUDA_nppist_LIBRARY

NVIDIA Performance Primitives 库（图像处理）。仅适用于 CUDA 版本 9.0。

CUDA_nppisu_LIBRARY

NVIDIA Performance Primitives 库（图像处理）。仅适用于 CUDA 版本 9.0。

CUDA_nppitc_LIBRARY

NVIDIA Performance Primitives 库（图像处理）。仅适用于 CUDA 版本 9.0。

CUDA_npps_LIBRARY

NVIDIA Performance Primitives 库（信号处理）。仅适用于 CUDA 版本 5.5+。

CUDA_nvcuvenc_LIBRARY

CUDA 视频编码器库。仅适用于 CUDA 版本 3.2+。仅限 Windows。

CUDA_nvcuvid_LIBRARY

CUDA 视频解码器库。仅适用于 CUDA 版本 3.2+。仅限 Windows。

CUDA_nvToolsExt_LIBRARY

版本 3.16 中已添加： NVIDA CUDA Tools Extension 库。适用于 CUDA 版本 5+。

CUDA_OpenCL_LIBRARY

版本 3.16 中已添加： NVIDA CUDA OpenCL 库。适用于 CUDA 版本 5+。