288 lines
15 KiB
CMake
288 lines
15 KiB
CMake
# -----------------------------------------------------------------------------------------------------------
|
||
# Copyright (c) 2025 Huawei Technologies Co., Ltd.
|
||
# This program is free software, you can redistribute it and/or modify it under the terms and conditions of
|
||
# CANN Open Software License Agreement Version 2.0 (the "License").
|
||
# Please refer to the License for details. You may not use this file except in compliance with the License.
|
||
# THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED,
|
||
# INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
|
||
# See LICENSE in the root of the software repository for the full text of the License.
|
||
# -----------------------------------------------------------------------------------------------------------
|
||
|
||
########################################################################################################################
|
||
# 环境检查
|
||
########################################################################################################################
|
||
|
||
# Python3
|
||
find_package(Python3)
|
||
if ((NOT Python3_FOUND) OR (${Python3_EXECUTABLE} STREQUAL ""))
|
||
message(FATAL_ERROR "Can't find python3.")
|
||
endif ()
|
||
set(HI_PYTHON "${Python3_EXECUTABLE}" CACHE STRING "python executor")
|
||
|
||
# 获取基础 CANN 路径
|
||
if (CUSTOM_ASCEND_CANN_PACKAGE_PATH)
|
||
set(ASCEND_CANN_PACKAGE_PATH ${CUSTOM_ASCEND_CANN_PACKAGE_PATH})
|
||
elseif (DEFINED ENV{ASCEND_HOME_PATH})
|
||
set(ASCEND_CANN_PACKAGE_PATH $ENV{ASCEND_HOME_PATH})
|
||
elseif (DEFINED ENV{ASCEND_OPP_PATH})
|
||
get_filename_component(ASCEND_CANN_PACKAGE_PATH "$ENV{ASCEND_OPP_PATH}/.." ABSOLUTE)
|
||
else()
|
||
set(ASCEND_CANN_PACKAGE_PATH "/usr/local/Ascend/latest")
|
||
endif ()
|
||
message(STATUS "ASCEND_CANN_PACKAGE_PATH=${ASCEND_CANN_PACKAGE_PATH}")
|
||
|
||
########################################################################################################################
|
||
# 公共配置
|
||
########################################################################################################################
|
||
|
||
# 开关类
|
||
option(PREPARE_BUILD "Prepare build." OFF)
|
||
option(ENABLE_OPS_HOST "Build ops host." ON)
|
||
option(ENABLE_OPS_KERNEL "Build ops kernel." ON)
|
||
if (TESTS_EXAMPLE_OPS_TEST OR TESTS_UT_OPS_TEST)
|
||
set(ENABLE_OPS_KERNEL OFF)
|
||
endif ()
|
||
set(OP_DEBUG_CONFIG "false" CACHE STRING "op debug config")
|
||
|
||
# 路径配置
|
||
# 源码树相关路径
|
||
get_filename_component(OPS_ADV_DIR "${CMAKE_CURRENT_SOURCE_DIR}" REALPATH)
|
||
get_filename_component(OPS_ADV_CMAKE_DIR "${OPS_ADV_DIR}/cmake" REALPATH)
|
||
get_filename_component(OPS_ADV_UTILS_KERNEL_INC "${OPS_ADV_DIR}/common/include/kernel" REALPATH)
|
||
|
||
|
||
# 构建树相关路径
|
||
set(ASCEND_IMPL_OUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/impl CACHE STRING "ascend impl output directories")
|
||
set(ASCEND_BINARY_OUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/binary CACHE STRING "ascend binary output directories")
|
||
set(ASCEND_AUTOGEN_DIR ${CMAKE_CURRENT_BINARY_DIR}/autogen CACHE STRING "Auto generate file directories")
|
||
set(ASCEND_CUSTOM_OPTIONS ${ASCEND_AUTOGEN_DIR}/custom_compile_options.ini)
|
||
set(ASCEND_CUSTOM_TILING_KEYS ${ASCEND_AUTOGEN_DIR}/custom_tiling_keys.ini)
|
||
set(ASCEND_CUSTOM_OPC_OPTIONS ${ASCEND_AUTOGEN_DIR}/custom_opc_options.ini)
|
||
set(OP_BUILD_TOOL ${ASCEND_CANN_PACKAGE_PATH}/tools/opbuild/op_build CACHE STRING "op_build tool")
|
||
file(MAKE_DIRECTORY ${ASCEND_AUTOGEN_DIR})
|
||
file(REMOVE ${ASCEND_CUSTOM_OPTIONS})
|
||
file(TOUCH ${ASCEND_CUSTOM_OPTIONS})
|
||
file(REMOVE ${ASCEND_CUSTOM_TILING_KEYS})
|
||
file(TOUCH ${ASCEND_CUSTOM_TILING_KEYS})
|
||
file(REMOVE ${ASCEND_CUSTOM_OPC_OPTIONS})
|
||
file(TOUCH ${ASCEND_CUSTOM_OPC_OPTIONS})
|
||
if (BUILD_OPEN_PROJECT)
|
||
if(EXISTS ${ASCEND_CANN_PACKAGE_PATH}/${SYSTEM_PREFIX}/tikcpp/ascendc_kernel_cmake)
|
||
set(ASCEND_PROJECT_DIR ${ASCEND_CANN_PACKAGE_PATH}/${SYSTEM_PREFIX}/tikcpp/ascendc_kernel_cmake)
|
||
endif()
|
||
set(ASCEND_CMAKE_DIR ${ASCEND_PROJECT_DIR}/cmake CACHE STRING "ascend project cmake")
|
||
set(IMPL_INSTALL_DIR packages/vendors/${VENDOR_NAME}_transformer/op_impl/ai_core/tbe/${VENDOR_NAME}_transformer_impl)
|
||
set(IMPL_DYNAMIC_INSTALL_DIR packages/vendors/${VENDOR_NAME}_transformer/op_impl/ai_core/tbe/${VENDOR_NAME}_transformer_impl/dynamic)
|
||
set(ACLNN_INC_INSTALL_DIR packages/vendors/${VENDOR_NAME}_transformer/op_api/include/aclnnop)
|
||
set(ACLNN_INC_LEVEL2_INSTALL_DIR packages/vendors/${VENDOR_NAME}_transformer/op_api/include/aclnnop/level2)
|
||
else()
|
||
set(ASCEND_CMAKE_DIR ${TOP_DIR}/asl/ops/cann/ops/built-in/ascendc/samples/customize/cmake CACHE STRING "ascend project cmake")
|
||
set(IMPL_INSTALL_DIR lib/ascendc/impl)
|
||
set(IMPL_DYNAMIC_INSTALL_DIR lib/ascendc/impl/dynamic)
|
||
set(ACLNN_INC_INSTALL_DIR lib/include)
|
||
set(OPS_STATIC_TYPES infer train)
|
||
set(OPS_STATIC_SCRIPT ${TOP_DIR}/asl/ops/cann/ops/built-in/kernel/binary_script/build_opp_kernel_static.py)
|
||
endif ()
|
||
if (EXISTS ${OPS_ADV_CMAKE_DIR}/scripts/util)
|
||
set(ASCENDC_CMAKE_UTIL_DIR ${OPS_ADV_CMAKE_DIR}/scripts/util)
|
||
else()
|
||
set(ASCENDC_CMAKE_UTIL_DIR ${ASCEND_CMAKE_DIR}/util)
|
||
endif()
|
||
set(CUSTOM_DIR ${CMAKE_BINARY_DIR}/custom)
|
||
set(TILING_CUSTOM_DIR ${CUSTOM_DIR}/op_impl/ai_core/tbe/op_tiling)
|
||
set(TILING_CUSTOM_FILE ${TILING_CUSTOM_DIR}/liboptiling.so)
|
||
|
||
# 兼容ascendc变更临时适配，待切换新版本ascendc新版本后删除
|
||
if(EXISTS ${ASCENDC_CMAKE_UTIL_DIR}/ascendc_gen_options.py)
|
||
set(ADD_OPS_COMPILE_OPTION_V2 ON)
|
||
else()
|
||
set(ADD_OPS_COMPILE_OPTION_V2 OFF)
|
||
endif()
|
||
|
||
########################################################################################################################
|
||
# CMake 选项, 缺省参数设置
|
||
# 按 CMake 构建过程对 CMake 选项, CMake 缺省参数进行配置
|
||
# CMake 构建过程: 1) 配置阶段(Configure); 2) 构建阶段(Build); 3) 安装阶段(Install);
|
||
########################################################################################################################
|
||
if (BUILD_OPEN_PROJECT)
|
||
# 构建阶段(Build)
|
||
# 构建类型
|
||
# CMake中的Generator(生成器)是用于生成本地/本机构建系统的工具。一般分为两种:
|
||
# 1. 单配置生成器(Single-configuration generator):
|
||
# 在配置(Configuration)阶段，仅允许指定一种构建类型，通过变量 CMAKE_BUILD_TYPE 指定;
|
||
# 在构建阶段(Build)无法更改构建类型，仅允许使用配置(Configuration)阶段通过变量 CMAKE_BUILD_TYPE 指定的构建类型;
|
||
# 常见的此类型生成器有: Ninja, Unix Makefiles
|
||
# 2. 多配置生成器(Multi-configuration generator) :
|
||
# 在配置(Configuration)阶段，仅指定构建阶段(Build)可用的构建类型列表，通过变量 CMAKE_CONFIGURATION_TYPES 指定;
|
||
# 在构建阶段(Build)通过 ”--config“ 参数，指定构建阶段具体的构建类型;
|
||
# 常见的此类型生成器有: Xcode, Visual Studio
|
||
# 所以:
|
||
# 1. 单配置生成器(Single-configuration generator)场景下，如果构建类型(CMAKE_BUILD_TYPE)未指定，则默认为 Debug ;
|
||
# 2. 多配置生成器(Multi-configuration generator)场景下，如果构建阶段可选的构建类型(CMAKE_CONFIGURATION_TYPES)未指定，
|
||
# 则默认将其指定为CMake允许的构建类型全集 [Debug;Release;MinSizeRel;RelWithDebInfo]
|
||
if (NOT BUILD_OPS_RTY_KERNEL)
|
||
if (ENABLE_TEST)
|
||
set(DEFAULT_BUILD_TYPE "Debug")
|
||
else()
|
||
set(DEFAULT_BUILD_TYPE "Release")
|
||
endif()
|
||
if (NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
|
||
set(CMAKE_BUILD_TYPE "${DEFAULT_BUILD_TYPE}" CACHE STRING "Choose the build type: Release/Debug" FORCE)
|
||
endif()
|
||
endif()
|
||
get_property(GENERATOR_IS_MULTI_CONFIG GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG)
|
||
if (GENERATOR_IS_MULTI_CONFIG)
|
||
if (NOT CMAKE_CONFIGURATION_TYPES)
|
||
set(CMAKE_CONFIGURATION_TYPES "Debug;Release;MinSizeRel;RelWithDebInfo" CACHE STRING "Configuration Build type" FORCE)
|
||
endif ()
|
||
else ()
|
||
if (NOT CMAKE_BUILD_TYPE)
|
||
set(CMAKE_BUILD_TYPE "Debug" CACHE STRING "Build type(default Debug)" FORCE)
|
||
endif ()
|
||
endif ()
|
||
|
||
# 构建阶段(Build)
|
||
# 可执行文件运行时库文件搜索路径 RPATH
|
||
# 在 UTest 及 Example 场景不略去 RPATH
|
||
if (TESTS_UT_OPS_TEST OR TESTS_EXAMPLE_OPS_TEST)
|
||
set(CMAKE_SKIP_RPATH FALSE)
|
||
else ()
|
||
set(CMAKE_SKIP_RPATH TRUE)
|
||
endif ()
|
||
|
||
# 构建阶段(Build)
|
||
# CCACHE 配置
|
||
if (ENABLE_CCACHE)
|
||
if (CUSTOM_CCACHE)
|
||
set(CCACHE_PROGRAM ${CUSTOM_CCACHE})
|
||
else()
|
||
find_program(CCACHE_PROGRAM ccache)
|
||
endif ()
|
||
if (CCACHE_PROGRAM)
|
||
set(CMAKE_C_COMPILER_LAUNCHER ${CCACHE_PROGRAM} CACHE PATH "C cache Compiler")
|
||
set(CMAKE_CXX_COMPILER_LAUNCHER ${CCACHE_PROGRAM} CACHE PATH "CXX cache Compiler")
|
||
endif ()
|
||
endif ()
|
||
|
||
# 安装阶段(Install)
|
||
# 安装路径
|
||
# 未显示设置 CMAKE_INSTALL_PREFIX (即 CMAKE_INSTALL_PREFIX 取缺省值)时,
|
||
# 修正其取值与构建树根目录 CMAKE_CURRENT_BINARY_DIR 平级
|
||
if (CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
|
||
get_filename_component(_Install_Path_Prefix "${CMAKE_CURRENT_BINARY_DIR}/../output" REALPATH)
|
||
set(CMAKE_INSTALL_PREFIX "${_Install_Path_Prefix}" CACHE STRING "Install path" FORCE)
|
||
endif ()
|
||
endif ()
|
||
|
||
########################################################################################################################
|
||
# 公开编译参数
|
||
########################################################################################################################
|
||
list(TRANSFORM ASCEND_COMPUTE_UNIT TOLOWER)
|
||
if (BUILD_OPEN_PROJECT)
|
||
message(STATUS "ENABLE_CCACHE=${ENABLE_CCACHE}, CUSTOM_CCACHE=${CUSTOM_CCACHE}")
|
||
message(STATUS "CCACHE_PROGRAM=${CCACHE_PROGRAM}")
|
||
message(STATUS "ASCEND_COMPUTE_UNIT=${ASCEND_COMPUTE_UNIT}")
|
||
message(STATUS "ASCEND_OP_NAME=${ASCEND_OP_NAME}")
|
||
message(STATUS "TILING_KEY=${TILING_KEY}")
|
||
message(STATUS "TESTS_UT_OPS_TEST=${TESTS_UT_OPS_TEST}")
|
||
message(STATUS "TESTS_EXAMPLE_OPS_TEST=${TESTS_EXAMPLE_OPS_TEST}")
|
||
message(STATUS "CMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}")
|
||
message(STATUS "VERSION=${VERSION}")
|
||
endif ()
|
||
|
||
########################################################################################################################
|
||
# 预处理
|
||
########################################################################################################################
|
||
if (BUILD_OPEN_PROJECT)
|
||
# 与基础 CANN 配套关系检查
|
||
option(CHECK_COMPATIBLE "check compatibility" ON)
|
||
set(CHECK_COMPATIBLE OFF)
|
||
if (CHECK_COMPATIBLE)
|
||
set(_param
|
||
"--cann_path=${ASCEND_CANN_PACKAGE_PATH}"
|
||
"--cann_package_name=toolkit"
|
||
"check_code_compatible"
|
||
"--code_version_info_file=${CMAKE_CURRENT_SOURCE_DIR}/version.info"
|
||
)
|
||
execute_process(
|
||
COMMAND ${HI_PYTHON} ${CMAKE_CURRENT_SOURCE_DIR}/cmake/scripts/check_version_compatible.py ${_param}
|
||
RESULT_VARIABLE result
|
||
OUTPUT_STRIP_TRAILING_WHITESPACE
|
||
OUTPUT_VARIABLE CANN_VERSION
|
||
)
|
||
if (result)
|
||
message(FATAL_ERROR "Check version compatibility failed.")
|
||
else()
|
||
string(TOLOWER ${CANN_VERSION} CANN_VERSION)
|
||
endif ()
|
||
endif ()
|
||
|
||
string(REPLACE "," ";" ASCEND_OP_NAME "${ASCEND_OP_NAME}")
|
||
|
||
if (NOT PREPARE_BUILD AND ENABLE_OPS_KERNEL)
|
||
if (TILING_KEY)
|
||
string(REPLACE ";" "::" EP_TILING_KEY "${TILING_KEY}")
|
||
else()
|
||
set(EP_TILING_KEY FALSE)
|
||
endif ()
|
||
|
||
if (OPS_COMPILE_OPTIONS)
|
||
string(REPLACE ";" "::" EP_OPS_COMPILE_OPTIONS "${OPS_COMPILE_OPTIONS}")
|
||
else()
|
||
set(EP_OPS_COMPILE_OPTIONS FALSE)
|
||
endif ()
|
||
|
||
string(REPLACE ";" "::" EP_ASCEND_COMPUTE_UNIT "${ASCEND_COMPUTE_UNIT}")
|
||
|
||
string(REPLACE ";" "::" EP_ASCEND_OP_NAME "${ASCEND_OP_NAME}")
|
||
|
||
execute_process(COMMAND bash ${CMAKE_CURRENT_SOURCE_DIR}/cmake/scripts/prepare.sh
|
||
-s ${CMAKE_CURRENT_SOURCE_DIR}
|
||
-b ${CMAKE_CURRENT_BINARY_DIR}/prepare_build
|
||
-p ${ASCEND_CANN_PACKAGE_PATH}
|
||
--autogen-dir ${ASCEND_AUTOGEN_DIR}
|
||
--build-open-project ${BUILD_OPEN_PROJECT}
|
||
--binary-out-dir ${ASCEND_BINARY_OUT_DIR}
|
||
--impl-out-dir ${ASCEND_IMPL_OUT_DIR}
|
||
--op-build-tool ${OP_BUILD_TOOL}
|
||
--ascend-cmake-dir ${ASCEND_CMAKE_DIR}
|
||
--tiling-key ${EP_TILING_KEY}
|
||
--ops-compile-options ${EP_OPS_COMPILE_OPTIONS}
|
||
--check-compatible ${CHECK_COMPATIBLE}
|
||
--ascend-compute_unit ${EP_ASCEND_COMPUTE_UNIT}
|
||
--ascend-op_name ${EP_ASCEND_OP_NAME}
|
||
--op_debug_config ${OP_DEBUG_CONFIG}
|
||
--build_ops_rty_kernel ${BUILD_OPS_RTY_KERNEL}
|
||
--enable_built_in ${ENABLE_BUILT_IN}
|
||
--enable_static ${ENABLE_STATIC}
|
||
--enable_experimental ${ENABLE_EXPERIMENTAL}
|
||
--enable_ccache ${ENABLE_CCACHE}
|
||
--cann_3rd_lib_path ${CANN_3RD_LIB_PATH}
|
||
--build_type ${BUILD_TYPE}
|
||
--version ${VERSION}
|
||
--enable_oom ${ENABLE_OOM}
|
||
RESULT_VARIABLE result
|
||
OUTPUT_STRIP_TRAILING_WHITESPACE
|
||
OUTPUT_VARIABLE PREPARE_BUILD_OUTPUT_VARIABLE)
|
||
if (result)
|
||
message(FATAL_ERROR "Error: ops prepare build failed.")
|
||
endif ()
|
||
|
||
file(REMOVE ${ASCEND_CUSTOM_OPTIONS})
|
||
file(TOUCH ${ASCEND_CUSTOM_OPTIONS})
|
||
file(REMOVE ${ASCEND_CUSTOM_TILING_KEYS})
|
||
file(TOUCH ${ASCEND_CUSTOM_TILING_KEYS})
|
||
file(REMOVE ${ASCEND_CUSTOM_OPC_OPTIONS})
|
||
file(TOUCH ${ASCEND_CUSTOM_OPC_OPTIONS})
|
||
endif ()
|
||
endif ()
|
||
|
||
########################################################################################################################
|
||
# 其他配置
|
||
########################################################################################################################
|
||
if (BUILD_OPEN_PROJECT)
|
||
if (TESTS_UT_OPS_TEST)
|
||
include(${OPS_ADV_CMAKE_DIR}/config_utest.cmake)
|
||
endif ()
|
||
endif ()
|