Initial HIP binding build support using headers from standard HIP install (#7867)

* Add upstream HIP as submodule to get header file definitions

* A simple vadd example for hip

* Added support for installing hip-dev -- which provides the official HIP header files -- from the Linux distribution

* Updated build infra to use HIP header files from HIP install area

* Add comment about defining __HIP_PLATFORM_AMD__

* Drop installation of hip.h file

* Minor code adjustments

Signed-off-by: Sonal Santan <[email protected]>

* DCO Remediation Commit for Sonal Santan <[email protected]>

I, Sonal Santan <[email protected]>, hereby add my Signed-off-by to this commit: a91d26b
I, Sonal Santan <[email protected]>, hereby add my Signed-off-by to this commit: d384c9f
I, Sonal Santan <[email protected]>, hereby add my Signed-off-by to this commit: 5076b02
I, Sonal Santan <[email protected]>, hereby add my Signed-off-by to this commit: a394207
I, Sonal Santan <[email protected]>, hereby add my Signed-off-by to this commit: ab75f5c
I, Sonal Santan <[email protected]>, hereby add my Signed-off-by to this commit: 18de09c

Signed-off-by: Sonal Santan <[email protected]>

* Improve the cmake handling of HIP for XRT to reduce warning messages

Enable building of HIP tests for XRT along with xrt and unit_test

* Remove redundant directory for vadd

* Code updates to address style issues

Add CMake based build of hip testcases

Signed-off-by: Sonal Santan <[email protected]>

* DCO Remediation Commit for Sonal Santan <[email protected]>

I, Sonal Santan <[email protected]>, hereby add my Signed-off-by to this commit: 747b2f3
I, Sonal Santan <[email protected]>, hereby add my Signed-off-by to this commit: dc9eabf

Signed-off-by: Sonal Santan <[email protected]>

* Drop usage of boost in hip testcases

Signed-off-by: Sonal Santan <[email protected]>

* Change the PASS/FAIL string to XRT standard

Signed-off-by: Sonal Santan <[email protected]>

---------

Signed-off-by: Sonal Santan <[email protected]>

Author: sonals

src/CMake/nativeLnx.cmake

@@ -123,10 +123,20 @@ set(XRT_BOOST_VERSION ${Boost_MAJOR_VERSION}.${Boost_MINOR_VERSION}.${Boost_SUBM
 include_directories(${Boost_INCLUDE_DIRS})
 add_compile_options("-DBOOST_LOCALE_HIDE_AUTO_PTR")
 
-# -- Cursers ---
+# --- Curses ---
 INCLUDE (FindCurses)
 find_package(Curses REQUIRED)
 
+# --- Optional HIP bindings ---
+if (XRT_ENABLE_HIP)
+  message("-- Looking for HIP include files...")
+  # We should find HIP cmake either in standard cmake locations or in the /opt/rocm location
+  set(CMAKE_MODULE_PATH "${CMAKE_MODULE_PATH};/opt/rocm/lib/cmake/hip")
+  set(CMAKE_PREFIX_PATH "${CMAKE_PREFIX_PATH};/opt/rocm/lib/cmake/amd_comgr;/opt/rocm/lib/cmake/hsa-runtime64")
+  include(hip-config)
+  message("-- Found at ${HIP_INCLUDE_DIR}")
+endif()
+
 # --- XRT Variables ---
 set (XRT_INSTALL_DIR           "xrt")
 set (XRT_INSTALL_BIN_DIR       "${XRT_INSTALL_DIR}/bin")

src/runtime_src/hip/CMakeLists.txt

@@ -37,7 +37,6 @@ install(TARGETS xrt_hip
 
 # Release headers
 install (FILES
-  hip.h
   config.h
   DESTINATION ${XRT_INSTALL_INCLUDE_DIR}/hip
   COMPONENT ${XRT_DEV_COMPONENT}

src/runtime_src/hip/api/CMakeLists.txt

@@ -7,5 +7,5 @@ add_library(hip_api_library_objects OBJECT
 target_include_directories(hip_api_library_objects
   PRIVATE
   ${XRT_SOURCE_DIR}/runtime_src
+  ${HIP_INCLUDE_DIRS}
   )
-

src/runtime_src/hip/api/hipDeviceGet.cpp

@@ -1,6 +1,8 @@
 // SPDX-License-Identifier: Apache-2.0
 // Copyright (C) 2023 Advanced Micro Device, Inc. All rights reserved.
-#include "hip/hip.h"
+
+#include "hip/config.h"
+#include "hip/hip_runtime_api.h"
 #include "hip/core/device.h"
 
 #include "core/common/error.h"
@@ -14,7 +16,7 @@ hipDeviceGet(hipDevice_t* device, int ordinal)
 {
   throw std::runtime_error("Not implemented");
 }
-  
+
 } // xrt::core::hip
 
 

src/runtime_src/hip/config.h

@@ -5,6 +5,14 @@
 
 //------------------Enable dynamic linking on windows-------------------------//
 
+// We need to define either __HIP_PLATFORM_AMD__ or __HIP_PLATFORM_NVIDIA for HIP header
+// files to stand; see hip/hip_runtime_api.h
+
+#define __HIP_PLATFORM_AMD__
+
+// Currently the following are not used since we are using HIP header files from standard
+// HIP install area
+
 #ifdef _WIN32
 # ifdef XRTHIP_SOURCE
 #  define XRTHIP_EXPORT __declspec(dllexport)

src/runtime_src/hip/core/CMakeLists.txt

@@ -7,5 +7,5 @@ add_library(hip_core_library_objects OBJECT
 target_include_directories(hip_core_library_objects
   PRIVATE
   ${XRT_SOURCE_DIR}/runtime_src
+  ${HIP_INCLUDE_DIRS}
   )
-

src/runtime_src/hip/core/device.cpp

@@ -1,9 +1,10 @@
 // SPDX-License-Identifier: Apache-2.0
 // Copyright (C) 2023 Advanced Micro Device, Inc. All rights reserved.
+
 #include "device.h"
 
 namespace xrt::core::hip {
 
-// Implementation  
-  
+// Implementation
+
 }

src/runtime_src/hip/hip.h

@@ -641,6 +641,57 @@ prep_alma()
     fi
 }
 
+install_pybind11()
+{
+    echo "Installing pybind11..."
+    if [ $FLAVOR == "mariner" ]; then
+        sudo dnf install -y pybind11-devel python3-pybind11
+    elif [ $FLAVOR == "ubuntu" ] && [ $MAJOR -ge 23 ]; then
+        apt-get install -y pybind11-dev
+    else
+        # Install/upgrade pybind11 for building the XRT python bindings
+        # We need 2.6.0 minimum version
+        pip3 install -U pybind11
+    fi
+}
+
+install_hip()
+{
+    # For building HIP bindings for XRT an install of ROCm HIP is required; install HIP if
+    # supported by the Linux distribution
+    if [ $FLAVOR == "ubuntu" ]; then
+        # Check if ROCm has already been manually installed by the user
+        dpkg-query -s hip-dev
+        if [ $? == 0 ]; then
+            echo "hip-dev already installed..."
+            dpkg-query -L hip-dev | grep hip/hip_runtime_api.h
+        elif [ $MAJOR -ge 23 ]; then
+            # From Ubuntu 23.04 (lunar) onwards, a version of HIP devel tools is bundled--
+            # https://packages.ubuntu.com/
+            apt-get install -y libamdhip64-dev
+        else
+            echo "Manual installation of HIP is required, please follow instructions on ROCm website--"
+            echo "https://rocm.docs.amd.com/projects/install-on-linux/en/latest/tutorial/install-overview.html"
+        fi
+    elif [ $FLAVOR == "fedora" ]; then
+        rpm -q hip-devel
+        if [ $? == 0 ]; then
+            echo "hip-devel already installed..."
+            rpm -q -l hip-devel | grep hip/hip_runtime_api.h
+        elif [ $MAJOR -ge 38 ]; then
+            # From version 38 onwards, a version of HIP devel tools is bundled--
+            # https://packages.fedoraproject.org/pkgs/rocclr/hip-devel/
+            yum install -y hip-devel
+        else
+            echo "Manual installation of HIP is required, please follow instructions on ROCm website--"
+            echo "https://rocm.docs.amd.com/projects/install-on-linux/en/latest/tutorial/install-overview.html"
+        fi
+    else
+            echo "Manual installation of HIP is required, please follow instructions on ROCm website--"
+            echo "https://rocm.docs.amd.com/projects/install-on-linux/en/latest/tutorial/install-overview.html"
+    fi
+}
+
 install()
 {
     if [ $FLAVOR == "ubuntu" ] || [ $FLAVOR == "debian" ]; then
@@ -703,14 +754,9 @@ install()
         dnf install -y "${MN_LIST[@]}"
     fi
 
-    if [ $FLAVOR == "mariner" ]; then
-        echo "Installing pybind..."
-        sudo dnf install -y pybind11-devel python3-pybind11
-    else
-        # Install/upgrade pybind11 for building the XRT python bindings
-        # We need 2.6.0 minimum version
-        pip3 install -U pybind11
-    fi
+    install_pybind11
+
+    install_hip
 }
 
 update_package_list

src/runtime_src/tools/scripts/xrtdeps.sh

@@ -0,0 +1,2 @@
+CompileFlags:
+  CompilationDatabase: build