Files
rocm-systems/projects/amdsmi/cmake_modules/utils.cmake
T
arvindcheru 0f76bb45c7 Enable Lintian configuration/Files for AMDSMI (#2140)
* Enable Lintian configuration/Files for AMDSMI
2025-12-04 22:01:57 -05:00

386 строки
14 KiB
CMake

################################################################################
## Copyright (C) Advanced Micro Devices. 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.
################################################################################
## Parses the VERSION_STRING variable and places
## the first, second and third number values in
## the major, minor and patch variables.
function(parse_version VERSION_STRING)
string(FIND ${VERSION_STRING} "-" STRING_INDEX)
if(${STRING_INDEX} GREATER -1)
math(EXPR STRING_INDEX "${STRING_INDEX} + 1")
string(SUBSTRING ${VERSION_STRING} ${STRING_INDEX} -1 VERSION_BUILD)
endif()
string(REGEX MATCHALL "[0-9]+" VERSIONS ${VERSION_STRING})
list(LENGTH VERSIONS VERSION_COUNT)
if(${VERSION_COUNT} GREATER 0)
list(GET VERSIONS 0 MAJOR)
set(VERSION_MAJOR ${MAJOR} PARENT_SCOPE)
set(TEMP_VERSION_STRING "${MAJOR}")
endif()
if(${VERSION_COUNT} GREATER 1)
list(GET VERSIONS 1 MINOR)
set(VERSION_MINOR ${MINOR} PARENT_SCOPE)
set(TEMP_VERSION_STRING "${TEMP_VERSION_STRING}.${MINOR}")
endif()
if(${VERSION_COUNT} GREATER 2)
list(GET VERSIONS 2 PATCH)
set(VERSION_PATCH ${PATCH} PARENT_SCOPE)
set(TEMP_VERSION_STRING "${TEMP_VERSION_STRING}.${PATCH}")
endif()
set(VERSION_STRING "${TEMP_VERSION_STRING}" PARENT_SCOPE)
endfunction()
function(get_version_from_file REL_FILE_PATH ITEM)
set(FILE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/${REL_FILE_PATH}")
set(OUTPUT_ITEM "0")
if(EXISTS "${FILE_PATH}")
file(READ ${FILE_PATH} file_contents)
string(REGEX MATCHALL "AMDSMI_LIB_VERSION_${ITEM} *[0-9]+" OUTPUT_STR "${file_contents}")
list(LENGTH OUTPUT_STR OUTPUT_STR_LENGTH)
if(${OUTPUT_STR_LENGTH} GREATER 0)
string(REGEX MATCH "[0-9]+" OUTPUT_ITEM "${OUTPUT_STR}")
endif()
endif()
set(${ITEM} "${OUTPUT_ITEM}" PARENT_SCOPE)
endfunction()
# Parses file for a pattern and replaces the value
# associated with that pattern with a specified value
# Replaces VERSION(MAJOR.MINOR.RELEASE) with updated values
function(update_version_in_file REL_FILE_PATH DEFAULT_VERSION PAT1 PAT2 PAT3)
get_version_from_file(${REL_FILE_PATH} "MAJOR")
get_version_from_file(${REL_FILE_PATH} "MINOR")
get_version_from_file(${REL_FILE_PATH} "RELEASE")
set(FILE_VERSION "${MAJOR}.${MINOR}.${RELEASE}")
if(DEFAULT_VERSION VERSION_GREATER FILE_VERSION)
set(FILE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/${REL_FILE_PATH}")
if(EXISTS "${FILE_PATH}")
parse_version(${DEFAULT_VERSION})
file(READ ${FILE_PATH} file_contents_new)
string(REGEX REPLACE "${PAT1}MAJOR${PAT2} *[0-9]*" "${PAT1}MAJOR${PAT3}${VERSION_MAJOR}" file_contents
"${file_contents_new}")
string(REGEX REPLACE "${PAT1}MINOR${PAT2} *[0-9]*" "${PAT1}MINOR${PAT3}${VERSION_MINOR}" file_contents_new
"${file_contents}")
string(REGEX REPLACE "${PAT1}RELEASE${PAT2} *[0-9]*" "${PAT1}RELEASE${PAT3}${VERSION_PATCH}" file_contents
"${file_contents_new}")
file(WRITE ${FILE_PATH} "${file_contents}")
endif()
set(VERSION_STRING "${DEFAULT_VERSION}" PARENT_SCOPE)
else()
set(VERSION_STRING "${FILE_VERSION}" PARENT_SCOPE)
endif()
endfunction()
## Gets the current version of the repository
## using versioning tags and git describe.
## Passes back a packaging version string
## and a library version string.
function(get_version_from_tag DEFAULT_VERSION_STRING VERSION_PREFIX GIT)
parse_version(${DEFAULT_VERSION_STRING})
set(DEFAULT_VERSION_MAJOR "${VERSION_MAJOR}")
set(DEFAULT_VERSION_MINOR "${VERSION_MINOR}")
set(DEFAULT_VERSION_PATCH "${VERSION_PATCH}")
if(GIT)
execute_process(
COMMAND git tag --list --sort=-version:refname "${VERSION_PREFIX}*"
COMMAND head -n 1
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
OUTPUT_VARIABLE GIT_TAG_STRING
OUTPUT_STRIP_TRAILING_WHITESPACE RESULTS_VARIABLE RESULTS)
if(GIT_TAG_STRING)
parse_version(${GIT_TAG_STRING})
endif()
endif()
if(VERSION_STRING VERSION_GREATER DEFAULT_VERSION_STRING)
set(VERSION_STRING "${VERSION_STRING}" PARENT_SCOPE)
set(VERSION_MAJOR "${VERSION_MAJOR}" PARENT_SCOPE)
set(VERSION_MINOR "${VERSION_MINOR}" PARENT_SCOPE)
set(VERSION_PATCH "${VERSION_PATCH}" PARENT_SCOPE)
else()
set(VERSION_STRING "${DEFAULT_VERSION_STRING}" PARENT_SCOPE)
set(VERSION_MAJOR "${DEFAULT_VERSION_MAJOR}" PARENT_SCOPE)
set(VERSION_MINOR "${DEFAULT_VERSION_MINOR}" PARENT_SCOPE)
set(VERSION_PATCH "${DEFAULT_VERSION_PATCH}" PARENT_SCOPE)
endif()
endfunction()
function(num_change_since_prev_pkg VERSION_PREFIX)
find_program(get_commits NAMES version_util.sh PATHS ${CMAKE_CURRENT_SOURCE_DIR}/cmake_modules)
if(get_commits)
execute_process(
COMMAND ${get_commits} -c ${VERSION_PREFIX}
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
OUTPUT_VARIABLE NUM_COMMITS
OUTPUT_STRIP_TRAILING_WHITESPACE
RESULT_VARIABLE RESULT)
set(NUM_COMMITS "${NUM_COMMITS}" PARENT_SCOPE)
if(${RESULT} EQUAL 0)
message("${NUM_COMMITS} were found since previous release")
else()
message("Unable to determine number of commits since previous release")
endif()
else()
message("WARNING: Didn't find version_util.sh")
set(NUM_COMMITS "unknown" PARENT_SCOPE)
endif()
endfunction()
function(get_package_version_number DEFAULT_VERSION_STRING VERSION_PREFIX GIT)
parse_version(${DEFAULT_VERSION_STRING})
num_change_since_prev_pkg(${VERSION_PREFIX})
set(PKG_VERSION_STR "${VERSION_STRING}.${NUM_COMMITS}")
if(DEFINED ENV{ROCM_BUILD_ID})
set(VERSION_ID $ENV{ROCM_BUILD_ID})
else()
set(VERSION_ID "local-build-0")
endif()
set(PKG_VERSION_STR "${PKG_VERSION_STR}-${VERSION_ID}")
if(GIT)
execute_process(
COMMAND git rev-parse --short HEAD
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
OUTPUT_VARIABLE VERSION_HASH
OUTPUT_STRIP_TRAILING_WHITESPACE
RESULT_VARIABLE RESULT)
if(${RESULT} EQUAL 0)
# Check for dirty workspace.
execute_process(COMMAND git diff --quiet WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
RESULT_VARIABLE RESULT)
if(${RESULT} EQUAL 1)
set(VERSION_HASH "${VERSION_HASH}-dirty")
endif()
else()
set(VERSION_HASH "unknown")
endif()
else()
set(VERSION_HASH "unknown")
endif()
set(PKG_VERSION_STR "${PKG_VERSION_STR}-${VERSION_HASH}")
set(PKG_VERSION_STR ${PKG_VERSION_STR} PARENT_SCOPE)
set(PKG_VERSION_HASH ${VERSION_HASH} PARENT_SCOPE)
set(CPACK_PACKAGE_VERSION_MAJOR ${VERSION_MAJOR} PARENT_SCOPE)
set(CPACK_PACKAGE_VERSION_MINOR ${VERSION_MINOR} PARENT_SCOPE)
set(CPACK_PACKAGE_VERSION_PATCH ${VERSION_PATCH} PARENT_SCOPE)
endfunction()
# function to append content of IN_FILE to OUT_FILE
function(append_file IN_FILE OUT_FILE)
file(READ "${IN_FILE}" CONTENTS)
file(APPEND "${OUT_FILE}" "${CONTENTS}")
endfunction()
## Configure Lintian Specific install Files for Debian Package
function(
configure_pkg
PACKAGE_NAME_T
COMPONENT_NAME_T
PACKAGE_VERSION_T
MAINTAINER_NM_T
MAINTAINER_EMAIL_T
)
# Check If Debian Platform
find_file(DEBIAN debian_version debconf.conf PATHS /etc)
if(DEBIAN)
set(BUILD_ENABLE_LINTIAN_OVERRIDES
ON
CACHE BOOL
"Enable/Disable Lintian Overrides"
FORCE
)
set(BUILD_DEBIAN_PKGING_FLAG
ON
CACHE BOOL
"Internal Status Flag to indicate Debian Packaging Build"
FORCE
)
set_debian_pkg_cmake_flags(${PACKAGE_NAME_T} ${PACKAGE_VERSION_T}
${MAINTAINER_NM_T} ${MAINTAINER_EMAIL_T}
)
# Create debian directory in build tree
file(MAKE_DIRECTORY "${CMAKE_BINARY_DIR}/DEBIAN")
# Configure the changelog file
set(CHANGELOG_DATA_FILES
"${CMAKE_SOURCE_DIR}/DEBIAN/changelog.in"
"${CMAKE_SOURCE_DIR}/CHANGELOG.md"
)
set(CHANGELOG_DATA_APPENDED "${CMAKE_BINARY_DIR}/DEBIAN/changelog.in")
file(WRITE "${CHANGELOG_DATA_APPENDED}" "")
foreach(changelog_data ${CHANGELOG_DATA_FILES})
append_file("${changelog_data}" "${CHANGELOG_DATA_APPENDED}")
endforeach()
configure_file(
"${CHANGELOG_DATA_APPENDED}"
"${CMAKE_BINARY_DIR}/DEBIAN/changelog.Debian"
@ONLY
)
# Install Change Log
find_program(DEB_GZIP_EXEC gzip)
if(NOT DEB_GZIP_EXEC)
message(
FATAL_ERROR
"gzip command not found: Failed to compress the changelog"
)
endif()
if(EXISTS "${CMAKE_BINARY_DIR}/DEBIAN/changelog.Debian")
execute_process(
COMMAND
${DEB_GZIP_EXEC} -f -n -9
"${CMAKE_BINARY_DIR}/DEBIAN/changelog.Debian"
WORKING_DIRECTORY "${CMAKE_BINARY_DIR}/DEBIAN"
RESULT_VARIABLE result
OUTPUT_VARIABLE output
ERROR_VARIABLE error
)
if(NOT ${result} EQUAL 0)
message(FATAL_ERROR "Failed to compress: ${error}")
endif()
install(
FILES
"${CMAKE_BINARY_DIR}/DEBIAN/${DEB_CHANGELOG_INSTALL_FILENM}"
DESTINATION ${CMAKE_INSTALL_DATADIR}/doc/${PACKAGE_NAME_T}
COMPONENT ${COMPONENT_NAME_T}
)
endif()
if(BUILD_ENABLE_LINTIAN_OVERRIDES)
if(ENABLE_ASAN_PACKAGING)
string(FIND ${DEB_OVERRIDES_INSTALL_FILENM} "asan" OUT_VAR2)
if(OUT_VAR2 EQUAL -1)
set(DEB_OVERRIDES_INSTALL_FILENM
"${DEB_OVERRIDES_INSTALL_FILENM}-asan"
CACHE STRING
"Debian Package Lintian Override File Name"
FORCE
)
endif()
endif()
# Configure the Lintian Overrides file
configure_file(
"${CMAKE_SOURCE_DIR}/DEBIAN/overrides.in"
"${CMAKE_BINARY_DIR}/DEBIAN/${DEB_OVERRIDES_INSTALL_FILENM}"
FILE_PERMISSIONS OWNER_READ OWNER_WRITE GROUP_READ WORLD_READ
@ONLY
)
endif()
endif()
endfunction()
# Set variables for changelog and copyright
# For Debian specific Packages
function(
set_debian_pkg_cmake_flags
DEB_PACKAGE_NAME_T
DEB_PACKAGE_VERSION_T
DEB_MAINTAINER_NM_T
DEB_MAINTAINER_EMAIL_T
)
# Setting configure flags
set(DEB_PACKAGE_NAME
"${DEB_PACKAGE_NAME_T}"
CACHE STRING
"Debian Package Name"
)
set(DEB_PACKAGE_VERSION
"${DEB_PACKAGE_VERSION_T}"
CACHE STRING
"Debian Package Version String"
)
set(DEB_MAINTAINER_NAME
"${DEB_MAINTAINER_NM_T}"
CACHE STRING
"Debian Package Maintainer Name"
)
set(DEB_MAINTAINER_EMAIL
"${DEB_MAINTAINER_EMAIL_T}"
CACHE STRING
"Debian Package Maintainer Email"
)
set(DEB_CHANGELOG_INSTALL_FILENM
"changelog.Debian.gz"
CACHE STRING
"Debian Package ChangeLog File Name"
)
if(BUILD_ENABLE_LINTIAN_OVERRIDES)
set(DEB_OVERRIDES_INSTALL_FILENM
"${DEB_PACKAGE_NAME}"
CACHE STRING
"Debian Package Lintian Override File Name"
)
set(DEB_OVERRIDES_INSTALL_PATH
"/usr/share/lintian/overrides/"
CACHE STRING
"Deb Pkg Lintian Override Install Location"
)
endif()
# Get TimeStamp
find_program(DEB_DATE_TIMESTAMP_EXEC date)
if(NOT DEB_DATE_TIMESTAMP_EXEC)
message(
FATAL_ERROR
"date command not found: Failed to Configure the timestamp for Copyright/Changelog."
)
endif()
set(DEB_TIMESTAMP_FORMAT_OPTION "-R")
execute_process(
COMMAND ${DEB_DATE_TIMESTAMP_EXEC} ${DEB_TIMESTAMP_FORMAT_OPTION}
OUTPUT_VARIABLE TIMESTAMP_T
OUTPUT_STRIP_TRAILING_WHITESPACE
)
set(DEB_TIMESTAMP
"${TIMESTAMP_T}"
CACHE STRING
"Current Time Stamp for Copyright/Changelog"
)
message(STATUS "DEB_PACKAGE_NAME : ${DEB_PACKAGE_NAME}")
message(STATUS "DEB_PACKAGE_VERSION : ${DEB_PACKAGE_VERSION}")
message(STATUS "DEB_MAINTAINER_NAME : ${DEB_MAINTAINER_NAME}")
message(STATUS "DEB_MAINTAINER_EMAIL : ${DEB_MAINTAINER_EMAIL}")
message(STATUS "DEB_TIMESTAMP : ${DEB_TIMESTAMP}")
message(
STATUS
"DEB_CHANGELOG_INSTALL_FILENM : ${DEB_CHANGELOG_INSTALL_FILENM}"
)
endfunction()