From ef1c21ccf783c70e5268a261e42195563bda7863 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?M=C3=A1ty=C3=A1s=20Aradi?= <107684421+matyas-streamhpc@users.noreply.github.com> Date: Tue, 28 Nov 2023 17:40:25 +0100 Subject: [PATCH] Add CMake support (#2641) * Add CMake support * Update README and CHANGELOG * Update CHANGELOG Co-authored-by: Saad Rahim (AMD) <44449863+saadrahim@users.noreply.github.com> --------- Co-authored-by: Saad Rahim (AMD) <44449863+saadrahim@users.noreply.github.com> --- CMakeLists.txt | 40 +++++++ README.md | 8 ++ cmake/Modules/Dependencies.cmake | 101 ++++++++++++++++++ docs/CMakeLists.txt | 33 ++++++ tools/autotag/templates/rocm_changes/6.0.0.md | 8 ++ 5 files changed, 190 insertions(+) create mode 100644 CMakeLists.txt create mode 100644 cmake/Modules/Dependencies.cmake create mode 100644 docs/CMakeLists.txt create mode 100644 tools/autotag/templates/rocm_changes/6.0.0.md diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100644 index 000000000..470b6b146 --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,40 @@ +# MIT License +# +# Copyright (c) 2023 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.18.0) + +project(ROCm VERSION 5.7.1 LANGUAGES NONE) + +option(ROCM_BUILD_DOCS "Build ROCm documentation" ON) + +include(GNUInstallDirs) + +# Adding default path cmake modules +list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake/Modules") + +# Handle dependencies +include(Dependencies) + +# Build docs +if(ROCM_BUILD_DOCS) + add_subdirectory(docs) +endif() diff --git a/README.md b/README.md index 926fffc06..b6686e0ea 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,14 @@ pip3 install -r sphinx/requirements.txt python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html ``` +Alternatively, CMake build is supported. + +```bash +cmake -B build + +cmake --build build --target=doc +``` + ## Older ROCm releases For release information for older ROCm releases, refer to diff --git a/cmake/Modules/Dependencies.cmake b/cmake/Modules/Dependencies.cmake new file mode 100644 index 000000000..fd56550f5 --- /dev/null +++ b/cmake/Modules/Dependencies.cmake @@ -0,0 +1,101 @@ +# MIT License +# +# Copyright (c) 2023 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. + +# ########################### +# ROCm dependencies +# ########################### + +include(FetchContent) + +if(ROCM_BUILD_DOCS) + find_package(ROCM 0.11.0 CONFIG QUIET PATHS "${ROCM_PATH}") # First version with Sphinx doc gen improvement + if(NOT ROCM_FOUND) + message(STATUS "ROCm CMake not found. Fetching...") + set(rocm_cmake_tag + "c044bb52ba85058d28afe2313be98d9fed02e293" # develop@2023.09.12. (move to 6.0 tag when released) + CACHE STRING "rocm-cmake tag to download") + FetchContent_Declare( + rocm-cmake + GIT_REPOSITORY https://github.com/RadeonOpenCompute/rocm-cmake.git + GIT_TAG ${rocm_cmake_tag} + SOURCE_SUBDIR "DISABLE ADDING TO BUILD" # We don't really want to consume the build and test targets of ROCm CMake. + ) + FetchContent_MakeAvailable(rocm-cmake) + find_package(ROCM CONFIG REQUIRED NO_DEFAULT_PATH PATHS "${rocm-cmake_SOURCE_DIR}") + else() + find_package(ROCM 0.11.0 CONFIG REQUIRED PATHS "${ROCM_PATH}") + endif() + + if(Python_FIND_VIRTUALENV STREQUAL "ONLY" AND NOT DEFINED ENV{VIRTUAL_ENV}) + if(NOT EXISTS "${CMAKE_CURRENT_BINARY_DIR}/.venv") + message(STATUS "Python virtualenv use requested but not found. Fetching...") + find_program(BOOTSTRAP_PYTHON_EXE python3 REQUIRED) + execute_process( + COMMAND "${BOOTSTRAP_PYTHON_EXE}" -m pip install --user virtualenv + OUTPUT_QUIET + COMMAND_ERROR_IS_FATAL ANY + ) + execute_process( + COMMAND "${BOOTSTRAP_PYTHON_EXE}" -m virtualenv "${CMAKE_CURRENT_BINARY_DIR}/.venv" + OUTPUT_QUIET + COMMAND_ERROR_IS_FATAL ANY + ) + endif() + set(ENV{VIRTUAL_ENV} "${CMAKE_CURRENT_BINARY_DIR}/.venv") + + if(WIN32) + set(ENV{PATH} "${CMAKE_CURRENT_BINARY_DIR}/.venv/Scripts;$ENV{PATH}") + else() + set(ENV{PATH} "${CMAKE_CURRENT_BINARY_DIR}/.venv/bin:$ENV{PATH}") + endif() + + find_package(Python REQUIRED) + + # TODO: shortcircuit if installed + execute_process( + COMMAND "${Python_EXECUTABLE}" -m pip install pip-tools + OUTPUT_QUIET + COMMAND_ERROR_IS_FATAL ANY + ) + + list(APPEND CMAKE_CONFIGURE_DEPENDS "${PROJECT_SOURCE_DIR}/docs/sphinx/requirements.in") + file(MAKE_DIRECTORY "$ENV{VIRTUAL_ENV}/usr/share/${PROJECT_NAME}") + if("${PROJECT_SOURCE_DIR}/docs/sphinx/requirements.in" IS_NEWER_THAN "$ENV{VIRTUAL_ENV}/usr/share/${PROJECT_NAME}/requirements.txt") + execute_process( + COMMAND "${Python_EXECUTABLE}" -m piptools compile + "${PROJECT_SOURCE_DIR}/docs/sphinx/requirements.in" + --output-file + "$ENV{VIRTUAL_ENV}/usr/share/${PROJECT_NAME}/requirements.txt" + OUTPUT_QUIET + ERROR_QUIET + COMMAND_ERROR_IS_FATAL ANY + ) + execute_process( + COMMAND "${Python_EXECUTABLE}" -m piptools sync + "$ENV{VIRTUAL_ENV}/usr/share/${PROJECT_NAME}/requirements.txt" + OUTPUT_QUIET + ERROR_QUIET + COMMAND_ERROR_IS_FATAL ANY + ) + endif() + endif() +endif() diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt new file mode 100644 index 000000000..8f11d65af --- /dev/null +++ b/docs/CMakeLists.txt @@ -0,0 +1,33 @@ +# MIT License +# +# Copyright (c) 2023 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. + +include(ROCMSphinxDoc) + +rocm_add_sphinx_doc( + "${CMAKE_CURRENT_SOURCE_DIR}" + OUTPUT_DIR html + BUILDER html +) + +install( + DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/html" + DESTINATION "${CMAKE_INSTALL_DOCDIR}") diff --git a/tools/autotag/templates/rocm_changes/6.0.0.md b/tools/autotag/templates/rocm_changes/6.0.0.md new file mode 100644 index 000000000..76284b348 --- /dev/null +++ b/tools/autotag/templates/rocm_changes/6.0.0.md @@ -0,0 +1,8 @@ + + + +### What's new in this release + +#### Documentation + +CMake support is added for the documentation in the [ROCm repository](https://github.com/RadeonOpenCompute/ROCm).