From bc19ae71eb6e13d55012d10750f2de3af4dc50b7 Mon Sep 17 00:00:00 2001 From: Ranjith Ramakrishnan Date: Fri, 25 Feb 2022 15:29:30 -0800 Subject: [PATCH] File reorganization with backward compatibility Package installed /opt/rocm Soft links and wrapper header files installed /opt/rocm/roctracer for backward compatibility tracer_tool library renamed to roctracer_tool and installed in /opt/rocm/lib/roctracer Change-Id: Ica7518c5ef2e591715121cbc942b69dff29233d3 --- CMakeLists.txt | 34 ++------- DEBIAN/postinst.in | 2 +- RPM/post.in | 2 +- roctracer-backward-compat.cmake | 128 ++++++++++++++++++++++++++++++++ test/CMakeLists.txt | 4 +- 5 files changed, 139 insertions(+), 31 deletions(-) create mode 100644 roctracer-backward-compat.cmake diff --git a/CMakeLists.txt b/CMakeLists.txt index 3ca3570876..37f62fc90a 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -121,31 +121,21 @@ message ( "-----------Dest-name: ${DEST_NAME}" ) message ( "------Install-prefix: ${CMAKE_INSTALL_PREFIX}" ) message ( "-----------CPACK-dir: ${CPACK_PACKAGING_INSTALL_PREFIX}" ) -#add_custom_target ( inc-link ALL WORKING_DIRECTORY ${PROJECT_BINARY_DIR} -# COMMAND ${CMAKE_COMMAND} -E create_symlink ../${DEST_NAME}/include inc-link ) -add_custom_target ( so-link ALL WORKING_DIRECTORY ${PROJECT_BINARY_DIR} - COMMAND ${CMAKE_COMMAND} -E create_symlink ../${DEST_NAME}/lib/${ROCTRACER_LIBRARY}.so so-link ) -add_custom_target ( so-major-link ALL WORKING_DIRECTORY ${PROJECT_BINARY_DIR} - COMMAND ${CMAKE_COMMAND} -E create_symlink ../${DEST_NAME}/lib/${ROCTRACER_LIBRARY}.so.${LIB_VERSION_MAJOR} so-major-link ) -add_custom_target ( so-patch-link ALL WORKING_DIRECTORY ${PROJECT_BINARY_DIR} - COMMAND ${CMAKE_COMMAND} -E create_symlink ../${DEST_NAME}/lib/${ROCTRACER_LIBRARY}.so.${LIB_VERSION_STRING} so-patch-link ) - ## Install information -install ( TARGETS ${ROCTRACER_TARGET} LIBRARY DESTINATION ${DEST_NAME}/lib ) +install ( TARGETS ${ROCTRACER_TARGET} LIBRARY DESTINATION lib ) foreach ( header ${PUBLIC_HEADERS} ) get_filename_component ( header_subdir ${header} DIRECTORY ) - install ( FILES ${CMAKE_CURRENT_SOURCE_DIR}/inc/${header} DESTINATION ${DEST_NAME}/include/${header_subdir} ) install ( FILES ${CMAKE_CURRENT_SOURCE_DIR}/inc/${header} DESTINATION include/${DEST_NAME}/${header_subdir} ) endforeach () foreach ( header ${GEN_HEADERS} ) get_filename_component ( header_subdir ${header} DIRECTORY ) - install ( FILES ${PROJECT_BINARY_DIR}/inc/${header} DESTINATION ${DEST_NAME}/include/${header_subdir} ) install ( FILES ${PROJECT_BINARY_DIR}/inc/${header} DESTINATION include/${DEST_NAME}/${header_subdir} ) endforeach () -#install ( FILES ${PROJECT_BINARY_DIR}/inc-link DESTINATION include RENAME ${DEST_NAME} ) -install ( FILES ${PROJECT_BINARY_DIR}/so-link DESTINATION lib RENAME ${ROCTRACER_LIBRARY}.so ) -install ( FILES ${PROJECT_BINARY_DIR}/so-major-link DESTINATION lib RENAME ${ROCTRACER_LIBRARY}.so.${LIB_VERSION_MAJOR} ) -install ( FILES ${PROJECT_BINARY_DIR}/so-patch-link DESTINATION lib RENAME ${ROCTRACER_LIBRARY}.so.${LIB_VERSION_STRING} ) + +option(FILE_REORG_BACKWARD_COMPATIBILITY "Enable File Reorg with backward compatibility" ON) +if(FILE_REORG_BACKWARD_COMPATIBILITY) + include(roctracer-backward-compat.cmake) +endif() ## rocTX set ( ROCTX_TARGET "roctx64" ) @@ -155,17 +145,7 @@ set ( ROCTX_LIBRARY "lib${ROCTX_TARGET}" ) set_property ( TARGET ${ROCTX_TARGET} PROPERTY VERSION "${LIB_VERSION_STRING}" ) set_property ( TARGET ${ROCTX_TARGET} PROPERTY SOVERSION "${LIB_VERSION_MAJOR}" ) -add_custom_target ( so-roctx-link ALL WORKING_DIRECTORY ${PROJECT_BINARY_DIR} - COMMAND ${CMAKE_COMMAND} -E create_symlink ../${DEST_NAME}/lib/${ROCTX_LIBRARY}.so so-roctx-link ) -add_custom_target ( so-roctx-major-link ALL WORKING_DIRECTORY ${PROJECT_BINARY_DIR} - COMMAND ${CMAKE_COMMAND} -E create_symlink ../${DEST_NAME}/lib/${ROCTX_LIBRARY}.so.${LIB_VERSION_MAJOR} so-roctx-major-link ) -add_custom_target ( so-roctx-patch-link ALL WORKING_DIRECTORY ${PROJECT_BINARY_DIR} - COMMAND ${CMAKE_COMMAND} -E create_symlink ../${DEST_NAME}/lib/${ROCTX_LIBRARY}.so.${LIB_VERSION_STRING} so-roctx-patch-link ) - -install ( TARGETS "roctx64" LIBRARY DESTINATION ${DEST_NAME}/lib ) -install ( FILES ${PROJECT_BINARY_DIR}/so-roctx-link DESTINATION lib RENAME ${ROCTX_LIBRARY}.so ) -install ( FILES ${PROJECT_BINARY_DIR}/so-roctx-major-link DESTINATION lib RENAME ${ROCTX_LIBRARY}.so.${LIB_VERSION_MAJOR} ) -install ( FILES ${PROJECT_BINARY_DIR}/so-roctx-patch-link DESTINATION lib RENAME ${ROCTX_LIBRARY}.so.${LIB_VERSION_STRING} ) +install ( TARGETS ${ROCTX_TARGET} LIBRARY DESTINATION lib ) ## Packaging directives set ( CPACK_GENERATOR "DEB" "RPM" "TGZ" CACHE STRING "CPACK GENERATOR DEB;RPM") diff --git a/DEBIAN/postinst.in b/DEBIAN/postinst.in index 21607ffbc1..c0d1f6f271 100644 --- a/DEBIAN/postinst.in +++ b/DEBIAN/postinst.in @@ -5,7 +5,7 @@ set -e do_ldconfig() { # left-hand term originates from ENABLE_LDCONFIG = ON/OFF at package build if [ "@ENABLE_LDCONFIG@" == "ON" ]; then - echo @CPACK_PACKAGING_INSTALL_PREFIX@/roctracer/lib > /etc/ld.so.conf.d/libroctracer64.conf + echo @CPACK_PACKAGING_INSTALL_PREFIX@/lib > /etc/ld.so.conf.d/libroctracer64.conf ldconfig fi } diff --git a/RPM/post.in b/RPM/post.in index 29f3278e90..eea513f48a 100644 --- a/RPM/post.in +++ b/RPM/post.in @@ -1,5 +1,5 @@ # left-hand term originates from ENABLE_LDCONFIG = ON/OFF at package build if [ "@ENABLE_LDCONFIG@" == "ON" ]; then - echo @CPACK_PACKAGING_INSTALL_PREFIX@/roctracer/lib > /etc/ld.so.conf.d/libroctracer64.conf + echo @CPACK_PACKAGING_INSTALL_PREFIX@/lib > /etc/ld.so.conf.d/libroctracer64.conf ldconfig fi diff --git a/roctracer-backward-compat.cmake b/roctracer-backward-compat.cmake new file mode 100644 index 0000000000..ccea223e36 --- /dev/null +++ b/roctracer-backward-compat.cmake @@ -0,0 +1,128 @@ +# Copyright (c) 2022 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.16.8) + +set(ROCT_BUILD_DIR ${CMAKE_CURRENT_BINARY_DIR}) +set(ROCT_WRAPPER_DIR ${ROCT_BUILD_DIR}/wrapper_dir) +set(ROCT_WRAPPER_INC_DIR ${ROCT_WRAPPER_DIR}/include) +set(ROCT_WRAPPER_LIB_DIR ${ROCT_WRAPPER_DIR}/lib) +set(ROCT_WRAPPER_TOOL_DIR ${ROCT_WRAPPER_DIR}/tool) + +#Function to generate header template file +function(create_header_template) + file(WRITE ${ROCT_WRAPPER_DIR}/header.hpp.in "/* + Copyright (c) 2022 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. + */\n\n#ifndef @include_guard@\n#define @include_guard@ \n\n#pragma message(\"This file is deprecated. Use file from include path /opt/rocm-ver/include/ and prefix with roctracer\")\n@include_statements@ \n\n#endif") +endfunction() + +#use header template file and generate wrapper header files +function(generate_wrapper_header) + file(MAKE_DIRECTORY ${ROCT_WRAPPER_INC_DIR}/ext) + #Get the header files from PUBLIC_HEADERS variable + foreach(header_file ${PUBLIC_HEADERS}) + #set include guard + get_filename_component(INC_GAURD_NAME ${header_file} NAME_WE) + string(TOUPPER ${INC_GAURD_NAME} INC_GAURD_NAME) + set(include_guard "${include_guard}ROCTRACER_WRAPPER_INCLUDE_${INC_GAURD_NAME}_H") + #set include statements + get_filename_component(file_name ${header_file} NAME) + get_filename_component ( header_subdir ${header_file} DIRECTORY ) + if(header_subdir) + set(include_statements "${include_statements}#include \"../../../include/${ROCTRACER_NAME}/${header_subdir}/${file_name}\"\n") + configure_file(${ROCT_WRAPPER_DIR}/header.hpp.in ${ROCT_WRAPPER_INC_DIR}/${header_subdir}/${file_name}) + else() + set(include_statements "${include_statements}#include \"../../include/${ROCTRACER_NAME}/${file_name}\"\n") + configure_file(${ROCT_WRAPPER_DIR}/header.hpp.in ${ROCT_WRAPPER_INC_DIR}/${file_name}) + endif() + unset(include_guard) + unset(include_statements) + endforeach() + + foreach(header_file ${GEN_HEADERS}) + #set include guard + get_filename_component(INC_GAURD_NAME ${header_file} NAME_WE) + string(TOUPPER ${INC_GAURD_NAME} INC_GAURD_NAME) + set(include_guard "${include_guard}ROCTRACER_WRAPPER_INCLUDE_${INC_GAURD_NAME}_H") + #set include statements + get_filename_component(file_name ${header_file} NAME) + set(include_statements "${include_statements}#include \"../../include/${ROCTRACER_NAME}/${file_name}\"\n") + configure_file(${ROCT_WRAPPER_DIR}/header.hpp.in ${ROCT_WRAPPER_INC_DIR}/${file_name}) + + unset(include_guard) + unset(include_statements) + endforeach() + +endfunction() + +#function to create symlink to libraries +function(create_library_symlink) + file(MAKE_DIRECTORY ${ROCT_WRAPPER_LIB_DIR}) + set(LIB_ROCT "${ROCTRACER_LIBRARY}.so") + set(MAJ_VERSION "${LIB_VERSION_MAJOR}") + set(SO_VERSION "${LIB_VERSION_STRING}") + set(library_files "${LIB_ROCT}" "${LIB_ROCT}.${MAJ_VERSION}" "${LIB_ROCT}.${SO_VERSION}") + + set(LIB_ROCTX64 "libroctx64.so") + set(library_files "${library_files}" "${LIB_ROCTX64}" "${LIB_ROCTX64}.${MAJ_VERSION}" "${LIB_ROCTX64}.${SO_VERSION}" ) + + foreach(file_name ${library_files}) + add_custom_target(link_${file_name} ALL + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} + COMMAND ${CMAKE_COMMAND} -E create_symlink + ../../lib/${file_name} ${ROCT_WRAPPER_LIB_DIR}/${file_name}) + endforeach() + #set softlink for roctracer/tool/libtracer_tool.so + #The libray name is changed to libroctracer_tool.so with file reorg changes + file(MAKE_DIRECTORY ${ROCT_WRAPPER_TOOL_DIR}) + set(LIB_TRACERTOOL "libtracer_tool.so") + set(LIB_ROCTRACERTOOL "libroctracer_tool.so") + add_custom_target(link_${LIB_TRACERTOOL} ALL + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} + COMMAND ${CMAKE_COMMAND} -E create_symlink + ../../lib/${ROCTRACER_NAME}/${LIB_ROCTRACERTOOL} ${ROCT_WRAPPER_TOOL_DIR}/${LIB_TRACERTOOL}) +endfunction() + +#Creater a template for header file +create_header_template() +#Use template header file and generater wrapper header files +generate_wrapper_header() +install(DIRECTORY ${ROCT_WRAPPER_INC_DIR} DESTINATION ${ROCTRACER_NAME}) +create_library_symlink() +install(DIRECTORY ${ROCT_WRAPPER_LIB_DIR} DESTINATION ${ROCTRACER_NAME}) +#install soft link to tool +install(DIRECTORY ${ROCT_WRAPPER_TOOL_DIR} DESTINATION ${ROCTRACER_NAME}) diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt index a14ee2ac83..27ea1e4290 100644 --- a/test/CMakeLists.txt +++ b/test/CMakeLists.txt @@ -82,12 +82,12 @@ file( GLOB UTIL_SRC "${HSA_TEST_DIR}/util/*.cpp" ) if ( DEFINED ROCTRACER_TARGET ) ## Build test library - set ( TEST_LIB "tracer_tool" ) + set ( TEST_LIB "roctracer_tool" ) set ( TEST_LIB_SRC ${TEST_DIR}/tool/tracer_tool.cpp ${UTIL_SRC} ) add_library ( ${TEST_LIB} SHARED ${TEST_LIB_SRC} ) target_include_directories ( ${TEST_LIB} PRIVATE ${HSA_TEST_DIR} ${ROOT_DIR} ${ROOT_DIR}/inc ${HSA_RUNTIME_INC_PATH} ${ROCM_INC_PATH} ${HIP_INC_DIR} ${HSA_KMT_INC_PATH} ${GEN_INC_DIR} ) target_link_libraries ( ${TEST_LIB} ${ROCTRACER_TARGET} ${HSA_RUNTIME_LIB} c stdc++ dl pthread rt numa ) - install ( TARGETS ${TEST_LIB} LIBRARY DESTINATION ${DEST_NAME}/tool ) + install ( TARGETS ${TEST_LIB} LIBRARY DESTINATION lib/${DEST_NAME}) endif () ## Build hsaco_test.cpp referenc test