[SYCL][E2E] Add LIT feature for HIP (#17692)

We already have features for Level Zero and CUDA, add one for HIP.

---------

Signed-off-by: Sarnie, Nick <[email protected]>

Author: sarnex

sycl/test-e2e/CMakeLists.txt

@@ -78,6 +78,12 @@ if(NOT DEFINED CUDA_LIBS_DIR AND NOT DEFINED CUDA_INCLUDE)
   endif()
 endif()
 
+find_package(hip HINTS ENV ROCM_PATH "/opt/rocm")
+if(hip_FOUND)
+  set(HIP_LIBS_DIR "${hip_LIB_INSTALL_DIR}")
+  set(HIP_INCLUDE "${hip_INCLUDE_DIRS}")
+endif()
+
 if(SYCL_TEST_E2E_STANDALONE)
   configure_file("${CMAKE_CURRENT_SOURCE_DIR}/lit.site.cfg.py.in"
                  "${CMAKE_CURRENT_BINARY_DIR}/lit.site.cfg.py")

sycl/test-e2e/EnqueueNativeCommand/custom-command-hip.cpp

@@ -1,4 +1,4 @@
-// RUN: %{build} -Wno-error=deprecated-pragma -o %t.out -I%rocm_path/include -L%rocm_path/lib -lamdhip64
+// RUN: %{build} -Wno-error=deprecated-pragma -o %t.out %hip_options
 // RUN: %{run} %t.out
 // REQUIRES: target-amd
 

sycl/test-e2e/Graph/NativeCommand/hip_explicit_usm.cpp

@@ -1,10 +1,6 @@
-// FIXME: the rocm include path and link path are highly platform dependent,
-// we should set this with some variable instead.
-// https://github.com/intel/llvm/issues/17018
-
-// RUN: %{run-aux} %{build} -Wno-error=deprecated-pragma -o %t.out -I%rocm_path/include -L%rocm_path/lib -lamdhip64
+// RUN: %{run-aux} %{build} -Wno-error=deprecated-pragma -o %t.out %hip_options
 // RUN: %{run} %t.out
-// RUN: %if preview-breaking-changes-supported %{ %{run-aux} %{build} -Wno-error=deprecated-pragma -fpreview-breaking-changes -o %t2.out -I%rocm_path/include -L%rocm_path/lib -lamdhip64 %}
+// RUN: %if preview-breaking-changes-supported %{ %{run-aux} %{build} -Wno-error=deprecated-pragma -fpreview-breaking-changes -o %t2.out %hip_options %}
 // RUN: %if preview-breaking-changes-supported %{ %{run} %t2.out %}
 // REQUIRES: target-amd
 

sycl/test-e2e/Graph/NativeCommand/hip_record_buffer.cpp

@@ -1,10 +1,6 @@
-// FIXME: the rocm include path and link path are highly platform dependent,
-// we should set this with some variable instead.
-// https://github.com/intel/llvm/issues/17018
-
-// RUN: %{run-aux} %{build} -Wno-error=deprecated-pragma -o %t.out -I%rocm_path/include -L%rocm_path/lib -lamdhip64
+// RUN: %{run-aux} %{build} -Wno-error=deprecated-pragma -o %t.out %hip_options
 // RUN: %{run} %t.out
-// RUN: %if preview-breaking-changes-supported %{ %{run-aux} %{build} -Wno-error=deprecated-pragma -fpreview-breaking-changes -o %t2.out -I%rocm_path/include -L%rocm_path/lib -lamdhip64 %}
+// RUN: %if preview-breaking-changes-supported %{ %{run-aux} %{build} -Wno-error=deprecated-pragma -fpreview-breaking-changes -o %t2.out %hip_options %}
 // RUN: %if preview-breaking-changes-supported %{ %{run} %t2.out %}
 // REQUIRES: target-amd
 

sycl/test-e2e/Graph/NativeCommand/hip_record_usm.cpp

@@ -1,10 +1,6 @@
-// FIXME: the rocm include path and link path are highly platform dependent,
-// we should set this with some variable instead.
-// https://github.com/intel/llvm/issues/17018
-
-// RUN: %{run-aux} %{build} -Wno-error=deprecated-pragma -o %t.out -I%rocm_path/include -L%rocm_path/lib -lamdhip64
+// RUN: %{run-aux} %{build} -Wno-error=deprecated-pragma -o %t.out %hip_options
 // RUN: %{run} %t.out
-// RUN: %if preview-breaking-changes-supported %{ %{run-aux} %{build} -Wno-error=deprecated-pragma -fpreview-breaking-changes -o %t2.out -I%rocm_path/include -L%rocm_path/lib -lamdhip64 %}
+// RUN: %if preview-breaking-changes-supported %{ %{run-aux} %{build} -Wno-error=deprecated-pragma -fpreview-breaking-changes -o %t2.out %hip_options %}
 // RUN: %if preview-breaking-changes-supported %{ %{run} %t2.out %}
 // REQUIRES: target-amd
 

sycl/test-e2e/HostInteropTask/interop-task-hip.cpp

@@ -1,4 +1,4 @@
-// RUN: %{build} -Wno-error=deprecated-pragma -Wno-error=deprecated-declarations -o %t.out -I%rocm_path/include -L%rocm_path/lib -lamdhip64
+// RUN: %{build} -Wno-error=deprecated-pragma -Wno-error=deprecated-declarations -o %t.out %hip_options
 // RUN: %{run} %t.out
 // REQUIRES: target-amd
 

sycl/test-e2e/README.md

@@ -190,6 +190,10 @@ at the full path specified by this variable.
 
 ***CUDA_LIBS_DIR*** - path to CUDA libraries (autodetected).
 
+***HIP_INCLUDE*** - path to HIP headers (autodetected).
+
+***HIP_LIBS_DIR*** - path to HIP libraries (autodetected).
+
 ***AMD_ARCH*** - flag may be set for when using HIP AMD triple. For example it
 may be set to "gfx906". Otherwise must be provided via the ***amd_arch*** LIT
 parameter (e.g., ***--param amd_arch=gfx906***) at runtime via the command line
@@ -297,6 +301,10 @@ configure specific single test execution in the command line:
   CMake variable CUDA_INCLUDE (autodetected).
 * **cuda_libs_dir** - directory containing CUDA SDK libraries, can be also set
   by CMake variable CUDA_LIBS_DIR (autodetected).
+* **hip_include** - directory containing HIP SDK headers, can be also set by
+  CMake variable HIP_INCLUDE (autodetected).
+* **hip_libs_dir** - directory containing HIP SDK libraries, can be also set
+  by CMake variable HIP_LIBS_DIR (autodetected).
 * **run_launcher** - part of `%{run*}` expansion/substitution to alter execution
   of the test by, e.g., running it through Valgrind.
 

sycl/test-e2e/lit.cfg.py

@@ -441,6 +441,53 @@ def open_check_file(file_name):
     else:
         config.substitutions.append(("%cuda_options", ""))
 
+# Check for HIP SDK
+check_hip_file = "hip_include.cpp"
+with open_check_file(check_hip_file) as fp:
+    print(
+        textwrap.dedent(
+            """
+        #define __HIP_PLATFORM_AMD__ 1
+        #include <hip/hip_runtime.h>
+        int main() {  hipError_t r = hipInit(0); return r; }
+        """
+        ),
+        file=fp,
+    )
+config.hip_libs_dir = lit_config.params.get("hip_libs_dir", config.hip_libs_dir)
+config.hip_include = lit_config.params.get(
+    "hip_include",
+    (config.hip_include if config.hip_include else config.sycl_include),
+)
+
+hip_options = hip_options = (
+    (" -L" + config.hip_libs_dir if config.hip_libs_dir else "")
+    + " -lamdhip64 "
+    + " -I"
+    + config.hip_include
+)
+if cl_options:
+    hip_options = (
+        " "
+        + (
+            config.hip_libs_dir + "/amdhip64.lib "
+            if config.hip_libs_dir
+            else "amdhip64.lib"
+        )
+        + " /I"
+        + config.hip_include
+    )
+
+with test_env():
+    sp = subprocess.getstatusoutput(
+        config.dpcpp_compiler + " -fsycl  " + check_hip_file + hip_options
+    )
+    if sp[0] == 0:
+        config.available_features.add("hip_dev_kit")
+        config.substitutions.append(("%hip_options", hip_options))
+    else:
+        config.substitutions.append(("%hip_options", ""))
+
 # Check for OpenCL ICD
 if config.opencl_libs_dir:
     if cl_options:
@@ -585,13 +632,6 @@ def remove_level_zero_suffix(devices):
     if be not in available_devices or dev not in available_devices[be]:
         lit_config.error("Unsupported device {}".format(d))
 
-# Set ROCM_PATH to help clang find the HIP installation.
-if "target-amd" in config.sycl_build_targets:
-    llvm_config.with_system_environment("ROCM_PATH")
-    config.substitutions.append(
-        ("%rocm_path", os.environ.get("ROCM_PATH", "/opt/rocm"))
-    )
-
 if "cuda:gpu" in config.sycl_devices:
     if "CUDA_PATH" not in os.environ:
         if platform.system() == "Windows":

sycl/test-e2e/lit.site.cfg.py.in

@@ -23,6 +23,8 @@ config.level_zero_libs_dir = "@LEVEL_ZERO_LIBS_DIR@"
 config.level_zero_include = "@LEVEL_ZERO_INCLUDE@"
 config.cuda_libs_dir = "@CUDA_LIBS_DIR@"
 config.cuda_include = "@CUDA_INCLUDE@"
+config.hip_libs_dir = "@HIP_LIBS_DIR@"
+config.hip_include = "@HIP_INCLUDE@"
 
 config.opencl_include_dir = os.path.join(config.sycl_include, 'sycl')