TheRock/rocm-libraries/projects/hiptensor/CMakeLists.txt

###############################################################################
 #
 # MIT License
 #
 # Copyright (C) 2023-2026 Advanced Micro Devices, Inc. All rights reserved.
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
 # in the Software without restriction, including without limitation the rights
 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 # copies of the Software, and to permit persons to whom the Software is
 # furnished to do so, subject to the following conditions:
 #
 # The above copyright notice and this permission notice shall be included in
 # all copies or substantial portions of the Software.
 #
 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 #
 ###############################################################################

cmake_minimum_required(VERSION 3.14)
message(STATUS "CMake version: ${CMAKE_VERSION}")

# NOTE: This has to be initialized before the project() command appears
# Set the default of CMAKE_BUILD_TYPE to be release, unless user specifies with -D.  MSVC_IDE does not use CMAKE_BUILD_TYPE
if(NOT DEFINED CMAKE_CONFIGURATION_TYPES AND NOT DEFINED CMAKE_BUILD_TYPE)
    set(CMAKE_BUILD_TYPE Release CACHE STRING "Choose the type of build, options are: Debug Release RelWithDebInfo MinSizeRel.")
endif()
message(STATUS "CMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}")
set(CMAKE_EXPORT_COMPILE_COMMANDS ON CACHE BOOL "" FORCE)

if(NOT DEFINED CMAKE_INSTALL_PREFIX)
    if(NOT WIN32)
        set(CMAKE_INSTALL_PREFIX "/opt/rocm" CACHE PATH "Install path prefix, prepended onto install directories")
    else()
        set(CMAKE_INSTALL_PREFIX "C:/dist/TheRock" CACHE PATH "Install path prefix, prepended onto install directories")
    endif()
endif()
if(NOT DEFINED CPACK_PACKAGING_INSTALL_PREFIX)
    set(CPACK_PACKAGING_INSTALL_PREFIX "${CMAKE_INSTALL_PREFIX}" CACHE PATH "Install path prefix for packages.")
    set(CPACK_SET_DESTDIR OFF)
endif()

# This helps cmake properly find hip-config.cmake
list(APPEND CMAKE_PREFIX_PATH $ENV{ROCM_PATH} ${ROCM_PATH} /opt/rocm)
# Append our library helper cmake path and the cmake path for hip (for convenience).
# Users may override HIP path by specifying their own in CMAKE_MODULE_PATH
list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake)

# Build shared libs
set(BUILD_SHARED_LIBS ON)

project(hiptensor)

# Set ROCM_LIBRARIES_ROOT if not already set (for monorepo builds vs standalone)
if(NOT DEFINED ROCM_LIBRARIES_ROOT)
    set(ROCM_LIBRARIES_ROOT "${CMAKE_CURRENT_SOURCE_DIR}/../..")
endif()

set(CMAKE_CXX_STANDARD 20)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
set(CMAKE_CXX_EXTENSIONS OFF)

#Set clang - driver mode to g++
set(CLANG_DRIVER_MODE "--driver-mode=g++")
set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -g -O1 -ggdb")           # clang++ crashes with -O0
set(CMAKE_CXX_FLAGS_MINSIZEREL "${CMAKE_CXX_FLAGS_MINSIZEREL} -O2 -DNDEBUG") # clang++ failed to build the project with the default -Os

# Project options
if(CMAKE_PROJECT_NAME STREQUAL "hiptensor")
    option(HIPTENSOR_DISABLE_DEVICE "Build hipTensor without device backend." OFF)
    option(HIPTENSOR_BUILD_TESTS "Build hiptensor tests" ON)
    option(HIPTENSOR_BUILD_SAMPLES "Build hiptensor samples" ON)
    option(HIPTENSOR_BUILD_COMPRESSED_DBG "Enable compressed debug symbols" ON)
    option(HIPTENSOR_DEFAULT_STRIDES_COL_MAJOR "Set hiptensor default strides to column major" ON)
    option(BUILD_OFFLOAD_COMPRESS "Build hiptensor with offload compression" ON)
    option(HIPTENSOR_CODE_COVERAGE "Build with code coverage flags (clang only)" OFF)
    option(HIPTENSOR_INLINE_UNARY_OPS "Inline all unary ops for best runtime performance (slower compilation)" OFF)
    if(WIN32)
        option(CREATE_TEST_APP_LOCAL_DEPLOY "Copy ROCm runtime DLLs next to test binaries so they take precedence over System32 (Windows only)" OFF)
    endif()
endif()

# Setup output paths
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY  ${CMAKE_BINARY_DIR}/bin)
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY  ${CMAKE_BINARY_DIR}/lib)
set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY  ${CMAKE_BINARY_DIR}/lib)

# ROCm setup
find_package(ROCmCMakeBuildTools 0.8 CONFIG REQUIRED)
include(ROCMSetupVersion)
include(ROCMCreatePackage)
include(ROCMInstallTargets)
include(ROCMCheckTargetIds)
include(ROCMClients)

include(ROCMPackageConfigHelpers)
include(ROCMInstallSymlinks)
include(CheckCXXCompilerFlag)

# check if ROCm supports `__hip_fp8_e5m2` and `__hip_fp8_e4m3`
include(cmake/Macros/CheckF8.cmake)
check_f8(F8_EXISTS)
if(F8_EXISTS)
    message(STATUS "Performing Test `__hip_fp8_e5m2` and `__hip_fp8_e4m3` - Success")
else()
    # Inform but do not fail the build, as these data types are not required for the library to function.
    message(STATUS "The detected ROCm does not support data type `__hip_fp8_e5m2` or `__hip_fp8_e4m3`.")
endif()

# check if asan is enabled
if (NOT DEFINED ADDRESS_SANITIZER AND DEFINED ENV{ADDRESS_SANITIZER})
    set(ADDRESS_SANITIZER $ENV{ADDRESS_SANITIZER})
endif()
if (ADDRESS_SANITIZER OR CMAKE_CXX_FLAGS MATCHES "-fsanitize=address")
    set(ADDRESS_SANITIZER_ENABLED ON)
else()
    set(ADDRESS_SANITIZER_ENABLED OFF)
endif()

include(cmake/Functions/hiptensorSupportedArchitectures.cmake)
if (ADDRESS_SANITIZER_ENABLED)
    rocm_check_target_ids(DEFAULT_GPU_TARGETS
        TARGETS "gfx90a:xnack+;gfx942:xnack+;gfx950:xnack+")
else()
    hiptensor_get_default_architectures(DEFAULT_ARCHS)
    rocm_check_target_ids(DEFAULT_GPU_TARGETS
        TARGETS ${DEFAULT_ARCHS})
endif()

# Check if offload compression is supported
include(CheckCXXCompilerFlag)
if (BUILD_OFFLOAD_COMPRESS)
    check_cxx_compiler_flag("--offload-compress" CXX_COMPILER_SUPPORTS_OFFLOAD_COMPRESS)
    if (NOT CXX_COMPILER_SUPPORTS_OFFLOAD_COMPRESS)
        message(WARNING "BUILD_OFFLOAD_COMPRESS=ON but flag not supported by compiler. Ignoring option.")
        set(CMAKE_NO_BUILTIN_CHRPATH ON)
    else()
        set(CMAKE_NO_BUILTIN_CHRPATH OFF)
    endif()
endif()

# Variable GPU_TARGET must be a cached variable and must be specified before calling find_package(hip)
# This is because hip-config.cmake sets --offload-arch via GPU_TARGET cached variable __after__ setting
# default cached variable GPU_TARGET to "gfx900;gfx906;gfx908", where not all archs are compatible with MFMA instructions
#
# By rule, once cached variable is set, it cannot be overridden unless we use the FORCE option
#
# Three cases are distinguished here:
#   * GPU_TARGETS / AMDGPU_TARGETS unset      -> fall back to DEFAULT_GPU_TARGETS
#   * set to a non-empty list                 -> honor it
#   * explicitly set to an empty string       -> no supported architecture is available for this configuration;
#                                                build with stub implementation.
if(GPU_TARGETS)
    set(GPU_TARGETS "${GPU_TARGETS}" CACHE STRING "List of specific machine types for library to target")
elseif(AMDGPU_TARGETS)
    set(GPU_TARGETS "${AMDGPU_TARGETS}" CACHE STRING "List of specific machine types for library to target")
    message(DEPRECATION "AMDGPU_TARGETS use is deprecated. Use GPU_TARGETS.")
elseif(DEFINED GPU_TARGETS OR DEFINED AMDGPU_TARGETS)
    # When hipTensor is configured for an architecture set that resolves to no GPU
    # targets, the device libraries and their Composable Kernel dependency cannot
    # be built. This option is turned on automatically so the library is still built
    # with a stub implementation where HIPTENSOR_STATUS_NOT_SUPPORTED is returned
    # for any call to device operations.
    set(HIPTENSOR_DISABLE_DEVICE ON)
    message(WARNING "GPU_TARGETS is empty; hipTensor stub libraries will be built. No device operation supported.")
else()
    set(GPU_TARGETS "${DEFAULT_GPU_TARGETS}" CACHE STRING "List of specific machine types for library to target")
endif()
message(STATUS "GPU_TARGETS=${GPU_TARGETS}")
message(STATUS "HIPTENSOR_DISABLE_DEVICE=${HIPTENSOR_DISABLE_DEVICE}")

if(HIPTENSOR_DEFAULT_STRIDES_COL_MAJOR)
    add_compile_definitions(HIPTENSOR_DEFAULT_STRIDES_COL_MAJOR=1)
else()
    add_compile_definitions(HIPTENSOR_DEFAULT_STRIDES_COL_MAJOR=0)
endif()
message(STATUS "HIPTENSOR_DEFAULT_STRIDES_COL_MAJOR=${HIPTENSOR_DEFAULT_STRIDES_COL_MAJOR}")

if(HIPTENSOR_INLINE_UNARY_OPS)
  add_compile_definitions(HIPTENSOR_INLINE_UNARY_OPS=1)
else()
  add_compile_definitions(HIPTENSOR_INLINE_UNARY_OPS=0)
endif()
message(STATUS "HIPTENSOR_INLINE_UNARY_OPS=${HIPTENSOR_INLINE_UNARY_OPS}")

# Setup HIP
find_package(hip REQUIRED)
math(EXPR hip_VERSION_FLAT "(${hip_VERSION_MAJOR} * 1000 + ${hip_VERSION_MINOR}) * 100000 + ${hip_VERSION_PATCH}")
message(STATUS "hip_version_flat=${hip_VERSION_FLAT}")

# No assumption that HIP kernels are launched with uniform block size for backward compatibility
# SWDEV-413293 and https://reviews.llvm.org/D155213
if(NOT WIN32 AND ${hip_VERSION_FLAT} GREATER 500723302)
    message(STATUS "Adding the fno-offload-uniform-block compiler flag")
    add_compile_options(-fno-offload-uniform-block)
endif()
# Add optimization flags needed by backend
if(NOT WIN32 AND ${hip_VERSION_FLAT} GREATER 600140090)
    message(STATUS "Adding the enable-post-misched=0 compiler flag")
    add_compile_options("SHELL: -mllvm -enable-post-misched=0")
endif()
if(NOT WIN32 AND ${hip_VERSION_FLAT} GREATER 600241132)
    message(STATUS "Adding -amdgpu-early-inline-all=true and -amdgpu-function-calls=false")
    add_compile_options("SHELL: -mllvm -amdgpu-early-inline-all=true")
    add_compile_options("SHELL: -mllvm -amdgpu-function-calls=false")
endif()

if(HIPTENSOR_CODE_COVERAGE)
    add_compile_options(-fprofile-instr-generate -fcoverage-mapping)
    add_link_options(-fprofile-instr-generate)
endif()

# disable warning about 'amdgpu-waves-per-eu'
add_compile_options(-Wno-pass-failed)

# Define the stub helpers
add_subdirectory(library/stub)

if(NOT HIPTENSOR_DISABLE_DEVICE)
    find_package(composable_kernel 1.0.0 REQUIRED COMPONENTS device_contraction_operations device_reduction_operations device_other_operations)
    rocm_package_add_dependencies("composable_kernel >= 1.0.0" COMPONENT tests)

    # Configure library build
    add_subdirectory(library/src)

    # Configure testing setup
    if(HIPTENSOR_BUILD_TESTS OR HIPTENSOR_BUILD_SAMPLES)
        enable_testing()
        rocm_package_setup_component(clients)
    endif()

    # Configure tests build
    if(HIPTENSOR_BUILD_TESTS)
        rocm_package_setup_client_component(tests)
        add_subdirectory(test)
    endif()

    # Configure clients build
    if(HIPTENSOR_BUILD_SAMPLES)
        rocm_package_setup_client_component(samples)
        add_subdirectory(samples)
    endif()
else()
    # No supported GPU target is available for this configuration, so the device
    # library (and its Composable Kernel dependency) cannot be built. Build a
    # host-only stub library that implements the full public API but reports
    # HIPTENSOR_STATUS_NOT_SUPPORTED for every entry point. This keeps the
    # package and its headers available so downstream find_package(hiptensor)
    # and linking keep working, while giving callers a well-defined runtime error.
    create_hiptensor_stub_library()
endif()

# Guarantee, at build time, that the stub implements the entire public API.
hiptensor_add_stub_api_coverage_check()

# Versioning via rocm-cmake
set (VERSION_STRING "2.4.0")
rocm_setup_version(VERSION ${VERSION_STRING})

# Configure a header file to pass the CMake version settings to the source
configure_file("${CMAKE_CURRENT_SOURCE_DIR}/library/include/hiptensor/internal/hiptensor-version.h.in"
               "${CMAKE_CURRENT_SOURCE_DIR}/library/include/hiptensor/internal/hiptensor-version.h")

# Define package dependencies for export
set(PACKAGE_DEPENDS
    PACKAGE hip
)

set(PACKAGE_STATIC_DEPENDS
    PACKAGE Threads
)

# Export targets using ROCm automation
rocm_export_targets(
    TARGETS hiptensor
    DEPENDS
        ${PACKAGE_DEPENDS}
    STATIC_DEPENDS
        ${PACKAGE_STATIC_DEPENDS}
)

set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/LICENSE")

rocm_create_package(
    NAME hiptensor
    DESCRIPTION "AMD high-performance HIP library for tensor primitives"
    MAINTAINER "hiptensor Maintainer <hiptensor-maintainer@amd.com>"
    LDCONFIG
)