mirror of
https://github.com/Kitware/CMake.git
synced 2026-01-05 13:20:47 -06:00
The `native` architecture compiles for the host's GPUs, but our CI jobs
may may run on hosts with GPUs newer than supported by their version of
the CUDA toolkit. Add an undocumented environment variable to tell
CMake to clamp the native architecture to that supported by the toolkit.
Without this, we may try to compile for architectures not supported by
the CUDA Toolkit, which fails. Since commit d1b48bfabd (CUDA: Add
support for CUDA_ARCHITECTURES=native, 2022-03-04), our CUDA 9.2 CI job
fails when it runs on a CI host with a GPU architecture newer than that
CUDA 9.2 supports. Clamping the architecture level fixes that.
Do not document this clamp behavior publicly, at least for now.
Users can be responsible for building with a CUDA toolkit recent
enough to support their host's GPUs.
Issue: #22375
148 lines
6.0 KiB
CMake
148 lines
6.0 KiB
CMake
# Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
|
# file Copyright.txt or https://cmake.org/licensing for details.
|
|
|
|
if(CMAKE_CUDA_COMPILER_FORCED)
|
|
# The compiler configuration was forced by the user.
|
|
# Assume the user has configured all compiler information.
|
|
set(CMAKE_CUDA_COMPILER_WORKS TRUE)
|
|
return()
|
|
endif()
|
|
|
|
include(CMakeTestCompilerCommon)
|
|
|
|
# Remove any cached result from an older CMake version.
|
|
# We now store this in CMakeCUDACompiler.cmake.
|
|
unset(CMAKE_CUDA_COMPILER_WORKS CACHE)
|
|
|
|
# Try to identify the ABI and configure it into CMakeCUDACompiler.cmake
|
|
include(${CMAKE_ROOT}/Modules/CMakeDetermineCompilerABI.cmake)
|
|
CMAKE_DETERMINE_COMPILER_ABI(CUDA ${CMAKE_ROOT}/Modules/CMakeCUDACompilerABI.cu)
|
|
if(CMAKE_CUDA_ABI_COMPILED)
|
|
# The compiler worked so skip dedicated test below.
|
|
set(CMAKE_CUDA_COMPILER_WORKS TRUE)
|
|
message(STATUS "Check for working CUDA compiler: ${CMAKE_CUDA_COMPILER} - skipped")
|
|
|
|
# Run the test binary to detect the native architectures.
|
|
execute_process(COMMAND "${CMAKE_PLATFORM_INFO_DIR}/CMakeDetermineCompilerABI_CUDA.bin"
|
|
RESULT_VARIABLE _CUDA_ARCHS_RESULT
|
|
OUTPUT_VARIABLE _CUDA_ARCHS_OUTPUT
|
|
ERROR_VARIABLE _CUDA_ARCHS_OUTPUT
|
|
OUTPUT_STRIP_TRAILING_WHITESPACE
|
|
)
|
|
if(_CUDA_ARCHS_RESULT EQUAL 0)
|
|
if("$ENV{CMAKE_CUDA_ARCHITECTURES_NATIVE_CLAMP}")
|
|
# Undocumented hook used by CMake's CI.
|
|
# Clamp native architecture to version range supported by this CUDA.
|
|
list(GET CMAKE_CUDA_ARCHITECTURES_ALL 0 _CUDA_ARCH_MIN)
|
|
list(GET CMAKE_CUDA_ARCHITECTURES_ALL -1 _CUDA_ARCH_MAX)
|
|
set(CMAKE_CUDA_ARCHITECTURES_NATIVE "")
|
|
foreach(_CUDA_ARCH IN LISTS _CUDA_ARCHS_OUTPUT)
|
|
if(_CUDA_ARCH LESS _CUDA_ARCH_MIN)
|
|
set(_CUDA_ARCH "${_CUDA_ARCH_MIN}")
|
|
endif()
|
|
if(_CUDA_ARCH GREATER _CUDA_ARCH_MAX)
|
|
set(_CUDA_ARCH "${_CUDA_ARCH_MAX}")
|
|
endif()
|
|
list(APPEND CMAKE_CUDA_ARCHITECTURES_NATIVE ${_CUDA_ARCH})
|
|
endforeach()
|
|
unset(_CUDA_ARCH)
|
|
unset(_CUDA_ARCH_MIN)
|
|
unset(_CUDA_ARCH_MAX)
|
|
else()
|
|
set(CMAKE_CUDA_ARCHITECTURES_NATIVE "${_CUDA_ARCHS_OUTPUT}")
|
|
endif()
|
|
list(REMOVE_DUPLICATES CMAKE_CUDA_ARCHITECTURES_NATIVE)
|
|
else()
|
|
if(NOT _CUDA_ARCHS_RESULT MATCHES "[0-9]+")
|
|
set(_CUDA_ARCHS_STATUS " (${_CUDA_ARCHS_RESULT})")
|
|
else()
|
|
set(_CUDA_ARCHS_STATUS "")
|
|
endif()
|
|
string(REPLACE "\n" "\n " _CUDA_ARCHS_OUTPUT " ${_CUDA_ARCHS_OUTPUT}")
|
|
file(APPEND ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeError.log
|
|
"Detecting the CUDA native architecture(s) failed with "
|
|
"the following output:\n${_CUDA_ARCHS_OUTPUT}\n\n")
|
|
endif()
|
|
unset(_CUDA_ARCHS_EXE)
|
|
unset(_CUDA_ARCHS_RESULT)
|
|
unset(_CUDA_ARCHS_OUTPUT)
|
|
endif()
|
|
|
|
# This file is used by EnableLanguage in cmGlobalGenerator to
|
|
# determine that the selected cuda compiler can actually compile
|
|
# and link the most basic of programs. If not, a fatal error
|
|
# is set and cmake stops processing commands and will not generate
|
|
# any makefiles or projects.
|
|
if(NOT CMAKE_CUDA_COMPILER_WORKS)
|
|
PrintTestCompilerStatus("CUDA")
|
|
file(WRITE ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeTmp/main.cu
|
|
"#ifndef __CUDACC__\n"
|
|
"# error \"The CMAKE_CUDA_COMPILER is set to an invalid CUDA compiler\"\n"
|
|
"#endif\n"
|
|
"int main(){return 0;}\n")
|
|
|
|
# Clear result from normal variable.
|
|
unset(CMAKE_CUDA_COMPILER_WORKS)
|
|
|
|
# Puts test result in cache variable.
|
|
try_compile(CMAKE_CUDA_COMPILER_WORKS ${CMAKE_BINARY_DIR}
|
|
${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeTmp/main.cu
|
|
OUTPUT_VARIABLE __CMAKE_CUDA_COMPILER_OUTPUT)
|
|
|
|
# Move result from cache to normal variable.
|
|
set(CMAKE_CUDA_COMPILER_WORKS ${CMAKE_CUDA_COMPILER_WORKS})
|
|
unset(CMAKE_CUDA_COMPILER_WORKS CACHE)
|
|
if(NOT CMAKE_CUDA_COMPILER_WORKS)
|
|
PrintTestCompilerResult(CHECK_FAIL "broken")
|
|
file(APPEND ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeError.log
|
|
"Determining if the CUDA compiler works failed with "
|
|
"the following output:\n${__CMAKE_CUDA_COMPILER_OUTPUT}\n\n")
|
|
string(REPLACE "\n" "\n " _output "${__CMAKE_CUDA_COMPILER_OUTPUT}")
|
|
message(FATAL_ERROR "The CUDA compiler\n \"${CMAKE_CUDA_COMPILER}\"\n"
|
|
"is not able to compile a simple test program.\nIt fails "
|
|
"with the following output:\n ${_output}\n\n"
|
|
"CMake will not be able to correctly generate this project.")
|
|
endif()
|
|
PrintTestCompilerResult(CHECK_PASS "works")
|
|
file(APPEND ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeOutput.log
|
|
"Determining if the CUDA compiler works passed with "
|
|
"the following output:\n${__CMAKE_CUDA_COMPILER_OUTPUT}\n\n")
|
|
endif()
|
|
|
|
# Try to identify the compiler features
|
|
include(${CMAKE_ROOT}/Modules/CMakeDetermineCompileFeatures.cmake)
|
|
CMAKE_DETERMINE_COMPILE_FEATURES(CUDA)
|
|
|
|
if("x${CMAKE_CUDA_SIMULATE_ID}" STREQUAL "xMSVC")
|
|
set(CMAKE_CUDA_IMPLICIT_LINK_LIBRARIES "${CMAKE_CUDA_HOST_IMPLICIT_LINK_LIBRARIES}")
|
|
set(CMAKE_CUDA_IMPLICIT_LINK_DIRECTORIES "${CMAKE_CUDA_HOST_IMPLICIT_LINK_DIRECTORIES}")
|
|
endif()
|
|
|
|
# Filter out implicit link libraries that should not be passed unconditionally.
|
|
# See CMAKE_CUDA_IMPLICIT_LINK_LIBRARIES_EXCLUDE in CMakeDetermineCUDACompiler.
|
|
list(REMOVE_ITEM CMAKE_CUDA_IMPLICIT_LINK_LIBRARIES ${CMAKE_CUDA_IMPLICIT_LINK_LIBRARIES_EXCLUDE})
|
|
|
|
if(CMAKE_CUDA_COMPILER_ID STREQUAL "NVIDIA")
|
|
# Remove the CUDA Toolkit include directories from the set of
|
|
# implicit system include directories.
|
|
# This resolves the issue that NVCC doesn't specify these
|
|
# includes as SYSTEM includes when compiling device code, and sometimes
|
|
# they contain headers that generate warnings, so let users mark them
|
|
# as SYSTEM explicitly
|
|
if(CMAKE_CUDA_TOOLKIT_INCLUDE_DIRECTORIES)
|
|
list(REMOVE_ITEM CMAKE_CUDA_IMPLICIT_INCLUDE_DIRECTORIES
|
|
${CMAKE_CUDA_TOOLKIT_INCLUDE_DIRECTORIES}
|
|
)
|
|
endif()
|
|
endif()
|
|
|
|
# Re-configure to save learned information.
|
|
configure_file(
|
|
${CMAKE_ROOT}/Modules/CMakeCUDACompiler.cmake.in
|
|
${CMAKE_PLATFORM_INFO_DIR}/CMakeCUDACompiler.cmake
|
|
@ONLY
|
|
)
|
|
include(${CMAKE_PLATFORM_INFO_DIR}/CMakeCUDACompiler.cmake)
|
|
|
|
unset(__CMAKE_CUDA_COMPILER_OUTPUT)
|