Merge pull request ROCm#512 from raramakr/file-reorg

[HIPIFY][build] File Reorganization with backward compatibility

CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.8.0)
+cmake_minimum_required(VERSION 3.16.8)
 
 project(hipify-clang)
 
@@ -115,8 +115,25 @@ install(
     PATTERN "ppc_wrappers" EXCLUDE
     PATTERN "openmp_wrappers" EXCLUDE)
 
+option(FILE_REORG_BACKWARD_COMPATIBILITY "Enable File Reorg with backward compatibility" ON)
 if(UNIX)
-    set(CPACK_PACKAGING_INSTALL_PREFIX "/opt/rocm/hip" CACHE PATH "HIP Package Installation Path")
+    if(FILE_REORG_BACKWARD_COMPATIBILITY)
+        include(hipify-backward-compat.cmake)
+    endif()
+    set(CPACK_PACKAGING_INSTALL_PREFIX "/opt/rocm" CACHE PATH "HIP Package Installation Path")
+    #TODO: To be removed
+    #In jenkins and docker build , hipify need to be installed in /opt/rocm.
+    #Currently build script passes /opt/rocm/hip as install path
+    #Workaround for removing same, till prototype changes are merged
+    if(CPACK_PACKAGING_INSTALL_PREFIX)
+        string(FIND ${CPACK_PACKAGING_INSTALL_PREFIX} "/opt/rocm" ROCMDIR_FOUND)
+        if(NOT ${ROCMDIR_FOUND} MATCHES "-1")
+            get_filename_component(DEST_DIR ${CPACK_PACKAGING_INSTALL_PREFIX} NAME)
+            if(DEST_DIR STREQUAL "hip")
+                get_filename_component(CPACK_PACKAGING_INSTALL_PREFIX ${CPACK_PACKAGING_INSTALL_PREFIX} DIRECTORY)
+            endif()#end  of DEST_DIR check
+        endif()#end of rocm dir check
+    endif()
     set(HIPBINDIR ${CPACK_PACKAGING_INSTALL_PREFIX}/bin)
     set(ROCMBINDIR ${CPACK_PACKAGING_INSTALL_PREFIX}/../bin)
     set(BUILD_DIR ${CMAKE_CURRENT_BINARY_DIR}/packages/hipify-clang)

hipify-backward-compat.cmake

@@ -0,0 +1,53 @@
+# 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(HIPIFY_BUILD_DIR ${CMAKE_CURRENT_BINARY_DIR})
+set(HIPIFY_WRAPPER_DIR ${HIPIFY_BUILD_DIR}/wrapper_dir)
+set(HIPIFY_WRAPPER_BIN_DIR ${HIPIFY_WRAPPER_DIR}/bin)
+
+#With File Reorganization , hipify(and hip)  will be installed in /opt/rocm-ver
+#instead of  /opt/rocm-ver/hip/. For maintaining backward  compatibility
+# the previous location(/opt/rocm-ver/hip/) will have soft link.
+#This file is for creating  soft link to binary files and install it in the  previous location
+#Note: soft link added for binary files.
+
+#function to create symlink to binaries
+function(create_binary_symlink)
+  file(MAKE_DIRECTORY ${HIPIFY_WRAPPER_BIN_DIR})
+  file(GLOB binary_files ${CMAKE_SOURCE_DIR}/bin/*)
+  foreach(binary_file ${binary_files})
+    get_filename_component(file_name ${binary_file} NAME)
+    add_custom_target(link_${file_name} ALL
+                  WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+                  COMMAND ${CMAKE_COMMAND} -E create_symlink
+                  ../../bin/${file_name} ${HIPIFY_WRAPPER_BIN_DIR}/${file_name})
+  endforeach()
+  #symlink for hipify-clang
+  set(file_name "hipify-clang")
+  add_custom_target(link_${file_name} ALL
+                  WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+                  COMMAND ${CMAKE_COMMAND} -E create_symlink
+                  ../../bin/${file_name} ${HIPIFY_WRAPPER_BIN_DIR}/${file_name})
+endfunction()
+# Create symlink to binaries
+create_binary_symlink()
+#install symlink in hip folder
+install(DIRECTORY ${HIPIFY_WRAPPER_BIN_DIR}  DESTINATION hip)

packaging/hipify-clang.txt

@@ -10,7 +10,10 @@ install(PROGRAMS @HIPIFY_INSTALL_PATH@/hipconvertinplace-perl.sh DESTINATION bin
 install(PROGRAMS @HIPIFY_INSTALL_PATH@/hipconvertinplace.sh DESTINATION bin)
 install(PROGRAMS @HIPIFY_INSTALL_PATH@/hipexamine-perl.sh DESTINATION bin)
 install(PROGRAMS @HIPIFY_INSTALL_PATH@/hipexamine.sh DESTINATION bin)
-
+set (FILE_REORG_BACKWARD_COMPATIBILITY "@FILE_REORG_BACKWARD_COMPATIBILITY@")
+if(FILE_REORG_BACKWARD_COMPATIBILITY)
+  install(DIRECTORY @PROJECT_BINARY_DIR@/wrapper_dir/bin DESTINATION hip)
+endif()
 # hipify-clang.txt is processed to produce CMakeList.txt,
 # pass down value from parent
 set (ROCM_DEP_ROCMCORE "@ROCM_DEP_ROCMCORE@")