[SYCL] Introduce the Level Zero plugin

sycl/CMakeLists.txt

@@ -304,6 +304,7 @@ set( SYCL_TOOLCHAIN_DEPLOY_COMPONENTS
      sycl-headers-extras
      sycl
      pi_opencl
+     pi_level0
      libsycldevice
 )
 if(OpenCL_INSTALL_KHRONOS_ICD_LOADER AND TARGET ocl-icd)

sycl/doc/EnvironmentVariables.md

@@ -12,7 +12,7 @@ subject to change. Do not rely on these variables in production code.
 | Environment variable | Values | Description |
 | -------------------- | ------ | ----------- |
 | SYCL_PI_TRACE | Described [below](#sycl_pi_trace-options)  | Enable specified level of tracing for PI. |
-| SYCL_BE | PI_OPENCL, PI_CUDA | Force SYCL RT to consider only devices of the specified backend during the device selection. |
+| SYCL_BE | PI_OPENCL, PI_LEVEL0, PI_CUDA | Force SYCL RT to consider only devices of the specified backend during the device selection. |
 | SYCL_DEVICE_TYPE | One of: CPU, GPU, ACC, HOST | Force SYCL to use the specified device type. If unset, default selection rules are applied. If set to any unlisted value, this control has no effect. If the requested device type is not found, a `cl::sycl::runtime_error` exception is thrown. If a non-default device selector is used, a device must satisfy both the selector and this control to be chosen. This control only has effect on devices created with a selector. |
 | SYCL_PROGRAM_COMPILE_OPTIONS | String of valid OpenCL compile options | Override compile options for all programs. |
 | SYCL_PROGRAM_LINK_OPTIONS | String of valid OpenCL link options | Override link options for all programs. |

sycl/doc/GetStartedGuide.md

@@ -164,11 +164,15 @@ which contains all the symbols required.
 To run DPC++ applications on OpenCL devices, OpenCL implementation(s) must be
 present in the system.
 
+To run DPC++ applications on Level Zero devices, Level Zero implementation(s)
+must be present in the system.
+
 Please, refer to [the Release Notes](../ReleaseNotes.md) for recommended Intel
 runtime versions.
 
-The `GPU` runtime that is needed to run DPC++ application on Intel `GPU` devices
-can be downloaded from the following web pages:
+To run DPC++ application on Intel `GPU` devices the OpenCL `GPU` runtime or the
+Level Zero `GPU` runtime is needed. They can be downloaded from the following web
+pages:
 
 * Linux: [Intel® Graphics Compute Runtime for
    OpenCL™](https://github.com/intel/compute-runtime/releases)

sycl/include/CL/sycl/backend_types.hpp

@@ -13,7 +13,7 @@
 __SYCL_INLINE_NAMESPACE(cl) {
 namespace sycl {
 
-enum class backend { host, opencl, cuda };
+enum class backend { host, opencl, level0, cuda };
 
 template <backend name, typename SYCLObjectT> struct interop;
 

sycl/include/CL/sycl/detail/pi.h

@@ -699,7 +699,7 @@ struct pi_buffer_region_struct {
   size_t origin;
   size_t size;
 };
-using pi_buffer_region_struct *pi_buffer_region;
+using pi_buffer_region = pi_buffer_region_struct *;
 
 // Offload binaries descriptor version supported by this library.
 static const uint16_t PI_DEVICE_BINARIES_VERSION = 1;

sycl/include/CL/sycl/detail/pi.hpp

@@ -57,9 +57,11 @@ bool trace(TraceLevel level);
 
 #ifdef SYCL_RT_OS_WINDOWS
 #define OPENCL_PLUGIN_NAME "pi_opencl.dll"
+#define LEVEL0_PLUGIN_NAME "pi_level0.dll"
 #define CUDA_PLUGIN_NAME "pi_cuda.dll"
 #else
 #define OPENCL_PLUGIN_NAME "libpi_opencl.so"
+#define LEVEL0_PLUGIN_NAME "libpi_level0.so"
 #define CUDA_PLUGIN_NAME "libpi_cuda.so"
 #endif
 

sycl/plugins/CMakeLists.txt

@@ -5,3 +5,4 @@ if(SYCL_BUILD_PI_CUDA)
 endif()
 
 add_subdirectory(opencl)
+add_subdirectory(Intel_level0)

sycl/plugins/Intel_level0/CMakeLists.txt

@@ -0,0 +1,61 @@
+# PI Level0 plugin library
+
+message(STATUS "Download Level Zero loader and headers from github.com")
+if(MSVC)
+  set(L0_LIBRARY
+      "${LLVM_LIBRARY_OUTPUT_INTDIR}/${CMAKE_STATIC_LIBRARY_PREFIX}ze_loader${CMAKE_STATIC_LIBRARY_SUFFIX}")
+else()
+  set(L0_LIBRARY
+      "${LLVM_LIBRARY_OUTPUT_INTDIR}/${CMAKE_SHARED_LIBRARY_PREFIX}ze_loader${CMAKE_SHARED_LIBRARY_SUFFIX}")
+endif()
+if (CMAKE_C_COMPILER)
+    list(APPEND AUX_CMAKE_FLAGS -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER})
+endif()
+if (CMAKE_CXX_COMPILER)
+    list(APPEND AUX_CMAKE_FLAGS -DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER})
+endif()
+file(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/l0_loader_build)
+ExternalProject_Add(l0-loader
+  GIT_REPOSITORY    https://github.com/oneapi-src/level-zero.git
+  GIT_TAG           origin/master
+  SOURCE_DIR        "${CMAKE_CURRENT_BINARY_DIR}/Level0/l0_loader"
+  BINARY_DIR        "${CMAKE_CURRENT_BINARY_DIR}/l0_loader_build"
+  INSTALL_DIR       "${CMAKE_CURRENT_BINARY_DIR}/l0_loader_install"
+  CMAKE_ARGS -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}
+             -DCMAKE_MAKE_PROGRAM=${CMAKE_MAKE_PROGRAM}
+             -DOpenCL_INCLUDE_DIR=${OpenCL_INCLUDE_DIRS}
+             -DCMAKE_INSTALL_PREFIX=<INSTALL_DIR>
+             -DCMAKE_INSTALL_LIBDIR:PATH=lib${LLVM_LIBDIR_SUFFIX}
+             ${AUX_CMAKE_FLAGS}
+  STEP_TARGETS      configure,build,install
+  DEPENDS           ocl-headers
+  BUILD_BYPRODUCTS ${L0_LIBRARY}
+)
+ExternalProject_Add_Step(l0-loader llvminstall
+  COMMAND ${CMAKE_COMMAND} -E copy_directory <INSTALL_DIR>/ ${LLVM_BINARY_DIR}
+  COMMENT "Installing l0-loader into the LLVM binary directory"
+  DEPENDEES install
+)
+
+include_directories("${sycl_inc_dir}")
+include_directories(${OPENCL_INCLUDE})
+
+add_library(pi_level0 SHARED
+  "${sycl_inc_dir}/CL/sycl/detail/pi.h"
+  "${CMAKE_CURRENT_SOURCE_DIR}/pi_level0.cpp"
+  "${CMAKE_CURRENT_SOURCE_DIR}/pi_level0.hpp"
+)
+
+add_dependencies(pi_level0 l0-loader)
+add_dependencies(sycl-toolchain pi_level0)
+
+target_link_libraries(pi_level0 PRIVATE "${L0_LIBRARY}")
+if (UNIX)
+  target_link_libraries(pi_level0 PRIVATE pthread)
+endif()
+
+add_common_options(pi_level0)
+
+install(TARGETS pi_level0
+    LIBRARY DESTINATION "lib" COMPONENT pi_level0
+    RUNTIME DESTINATION "bin" COMPONENT pi_level0)