Files
pytorch/cmake/Modules/FindARM.cmake
2025-06-17 19:25:43 +00:00

171 lines
6.8 KiB
CMake

# Check if the processor is an ARM and if Neon instruction are available on the machine where
# the project is compiled.
IF(CMAKE_SYSTEM_NAME MATCHES "Linux")
EXECUTE_PROCESS(COMMAND cat /proc/cpuinfo OUTPUT_VARIABLE CPUINFO)
#neon instruction can be found on the majority part of modern ARM processor
STRING(REGEX REPLACE "^.*(neon).*$" "\\1" NEON_THERE "${CPUINFO}")
STRING(COMPARE EQUAL "neon" "${NEON_THERE}" NEON_TRUE)
IF (NEON_TRUE)
set(NEON_FOUND true CACHE BOOL "NEON available on host")
ELSE (NEON_TRUE)
set(NEON_FOUND false CACHE BOOL "NEON available on host")
ENDIF (NEON_TRUE)
# on ARMv8, neon is inherit and instead listed as 'asimd' in /proc/cpuinfo
STRING(REGEX REPLACE "^.*(asimd).*$" "\\1" ASIMD_THERE "${CPUINFO}")
STRING(COMPARE EQUAL "asimd" "${ASIMD_THERE}" ASIMD_TRUE)
IF (ASIMD_TRUE)
set(ASIMD_FOUND true CACHE BOOL "ASIMD/NEON available on host")
ELSE (ASIMD_TRUE)
set(ASIMD_FOUND false CACHE BOOL "ASIMD/NEON available on host")
ENDIF (ASIMD_TRUE)
#sve instruction can be found on the majority part of modern ARM processor
STRING(REGEX REPLACE "^.*(sve).*$" "\\1" SVE_THERE ${CPUINFO})
STRING(COMPARE EQUAL "sve" "${SVE_THERE}" SVE_TRUE)
IF (SVE_TRUE)
set(SVE_FOUND true CACHE BOOL "SVE available on host")
ELSE (SVE_TRUE)
set(SVE_FOUND false CACHE BOOL "SVE available on host")
ENDIF (SVE_TRUE)
#Find the processor type (for now OMAP3 or OMAP4)
STRING(REGEX REPLACE "^.*(OMAP3).*$" "\\1" OMAP3_THERE "${CPUINFO}")
STRING(COMPARE EQUAL "OMAP3" "${OMAP3_THERE}" OMAP3_TRUE)
IF (OMAP3_TRUE)
set(CORTEXA8_FOUND true CACHE BOOL "OMAP3 available on host")
ELSE (OMAP3_TRUE)
set(CORTEXA8_FOUND false CACHE BOOL "OMAP3 available on host")
ENDIF (OMAP3_TRUE)
#Find the processor type (for now OMAP3 or OMAP4)
STRING(REGEX REPLACE "^.*(OMAP4).*$" "\\1" OMAP4_THERE "${CPUINFO}")
STRING(COMPARE EQUAL "OMAP4" "${OMAP4_THERE}" OMAP4_TRUE)
IF (OMAP4_TRUE)
set(CORTEXA9_FOUND true CACHE BOOL "OMAP4 available on host")
ELSE (OMAP4_TRUE)
set(CORTEXA9_FOUND false CACHE BOOL "OMAP4 available on host")
ENDIF (OMAP4_TRUE)
ELSEIF(CMAKE_SYSTEM_NAME MATCHES "Darwin")
IF(CMAKE_SYSTEM_PROCESSOR STREQUAL "arm64" AND NOT CMAKE_OSX_ARCHITECTURES STREQUAL "x86_64")
set(NEON_FOUND true CACHE BOOL "NEON available on ARM64")
ENDIF()
EXECUTE_PROCESS(COMMAND /usr/sbin/sysctl -n machdep.cpu.features OUTPUT_VARIABLE
CPUINFO)
IF(NOT CPUINFO STREQUAL "")
#neon instruction can be found on the majority part of modern ARM processor
STRING(REGEX REPLACE "^.*(neon).*$" "\\1" NEON_THERE "${CPUINFO}")
STRING(COMPARE EQUAL "neon" "${NEON_THERE}" NEON_TRUE)
IF (NEON_TRUE)
set(NEON_FOUND true CACHE BOOL "NEON available on host")
ELSE (NEON_TRUE)
set(NEON_FOUND false CACHE BOOL "NEON available on host")
ENDIF (NEON_TRUE)
ENDIF()
ELSEIF(CMAKE_SYSTEM_NAME MATCHES "Windows")
# TODO
set(CORTEXA8_FOUND false CACHE BOOL "OMAP3 not available on host")
set(CORTEXA9_FOUND false CACHE BOOL "OMAP4 not available on host")
set(NEON_FOUND false CACHE BOOL "NEON not available on host")
ELSE(CMAKE_SYSTEM_NAME MATCHES "Linux")
set(CORTEXA8_FOUND false CACHE BOOL "OMAP3 not available on host")
set(CORTEXA9_FOUND false CACHE BOOL "OMAP4 not available on host")
set(NEON_FOUND false CACHE BOOL "NEON not available on host")
ENDIF(CMAKE_SYSTEM_NAME MATCHES "Linux")
if(NOT NEON_FOUND)
MESSAGE(STATUS "Could not find hardware support for NEON on this machine.")
endif(NOT NEON_FOUND)
if(NOT CORTEXA8_FOUND)
MESSAGE(STATUS "No OMAP3 processor on this machine.")
endif(NOT CORTEXA8_FOUND)
if(NOT CORTEXA9_FOUND)
MESSAGE(STATUS "No OMAP4 processor on this machine.")
endif(NOT CORTEXA9_FOUND)
mark_as_advanced(NEON_FOUND)
#SVE support is available is only for Linux OS.
IF(CMAKE_SYSTEM_NAME MATCHES "Linux")
# Include necessary modules for checking C and C++ source compilations
INCLUDE(CheckCSourceCompiles)
INCLUDE(CheckCXXSourceCompiles)
# Test code for SVE support
SET(SVE_CODE "
#include <arm_sve.h>
int main()
{
svfloat64_t a;
a = svdup_n_f64(0);
return 0;
}
")
SET(ARM_BF16_CODE "
#include <arm_neon.h>
int main()
{
float32x4_t a = vdupq_n_f32(0);
bfloat16x8_t b = vreinterpretq_bf16_f32(a);
return 0;
}
")
# Macro to check for SVE instruction support
MACRO(CHECK_COMPILES lang type flags code)
# Save the current state of required flags
SET(CMAKE_REQUIRED_FLAGS_SAVE ${CMAKE_REQUIRED_FLAGS})
# Set the flags necessary for compiling the test code with SVE support
SET(CMAKE_REQUIRED_FLAGS "${CMAKE_${lang}_FLAGS_INIT} ${flags}")
# Check if the source code compiles with the given flags for the specified language (C or C++)
IF(lang STREQUAL "CXX")
CHECK_CXX_SOURCE_COMPILES("${code}" ${lang}_HAS_${type})
ELSE()
CHECK_C_SOURCE_COMPILES("${code}" ${lang}_HAS_${type})
ENDIF()
# If the compilation test is successful, set appropriate variables indicating support
IF(${lang}_HAS_${type})
set(${lang}_SVE_FOUND TRUE CACHE BOOL "SVE available on host")
SET(${lang}_${type}_FOUND TRUE CACHE BOOL "${lang} ${type} support")
SET(${lang}_${type}_FLAGS "${flags}" CACHE STRING "${lang} ${type} flags")
ENDIF()
# Restore the original state of required flags
SET(CMAKE_REQUIRED_FLAGS ${CMAKE_REQUIRED_FLAGS_SAVE})
# If the compilation test fails, indicate that the support is not found
IF(NOT ${lang}_${type}_FOUND)
SET(${lang}_${type}_FOUND FALSE CACHE BOOL "${lang} ${type} support")
SET(${lang}_${type}_FLAGS "" CACHE STRING "${lang} ${type} flags")
ENDIF()
# Mark the variables as advanced to hide them in the default CMake GUI
MARK_AS_ADVANCED(${lang}_${type}_FOUND ${lang}_${type}_FLAGS)
ENDMACRO()
# Check for SVE256 vector length
CHECK_COMPILES(CXX "SVE256" "-march=armv8.2-a+sve -msve-vector-bits=256" "${SVE_CODE}")
CHECK_COMPILES(CXX "ARM_BF16" "-march=armv8.2-a+sve+bf16 -msve-vector-bits=256" "${ARM_BF16_CODE}")
# If SVE256 support is not found, set CXX_SVE_FOUND to FALSE and notify the user
if(NOT CXX_SVE256_FOUND)
set(CXX_SVE_FOUND FALSE CACHE BOOL "SVE not available on host")
message(STATUS "No SVE processor on this machine.")
else()
# If SVE256 support is found, set CXX_SVE_FOUND to TRUE and notify the user
set(CXX_SVE_FOUND TRUE CACHE BOOL "SVE available on host")
message(STATUS "SVE support detected.")
endif()
# Mark the SVE support variable as advanced
mark_as_advanced(CXX_SVE_FOUND)
ENDIF(CMAKE_SYSTEM_NAME MATCHES "Linux")