[SYCL] Add Unified Runtime Plugin (#7521)

Add new pi_unified_plugin that implements only piPlatformsGet (via Unified Runtime zerPlatformGet)
The next step is to add a new backend to SYCL and actually start calling to pi_unified_plugin

Signed-off-by: Sergey V Maslov <[email protected]>
Co-authored-by: Pavel V Chupin <[email protected]>
Co-authored-by: Steffen Larsen <[email protected]>

Author: 3 people

sycl/plugins/level_zero/CMakeLists.txt

@@ -1,143 +1,106 @@
 # PI Level Zero plugin library
 
-if(MSVC)
-  set(LEVEL_ZERO_LOADER
-      "${LLVM_LIBRARY_OUTPUT_INTDIR}/${CMAKE_STATIC_LIBRARY_PREFIX}ze_loader${CMAKE_STATIC_LIBRARY_SUFFIX}")
-else()
-  set(LEVEL_ZERO_LOADER
-      "${LLVM_LIBRARY_OUTPUT_INTDIR}/${CMAKE_SHARED_LIBRARY_PREFIX}ze_loader${CMAKE_SHARED_LIBRARY_SUFFIX}")
-endif()
-
 if (NOT DEFINED LEVEL_ZERO_LIBRARY OR NOT DEFINED LEVEL_ZERO_INCLUDE_DIR)
   message(STATUS "Download Level Zero loader and headers from github.com")
-  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}/level_zero_loader_build)
-  set(LEVEL_ZERO_LOADER_SOURCE_DIR "${CMAKE_CURRENT_BINARY_DIR}/level_zero/level_zero_loader")
-  if (NOT DEFINED SYCL_EP_LEVEL_ZERO_LOADER_SKIP_AUTO_UPDATE)
-    set(SYCL_EP_LEVEL_ZERO_LOADER_SKIP_AUTO_UPDATE ${SYCL_EXTERNAL_PROJECTS_SKIP_AUTO_UPDATE})
-  endif()
-  set(LEVEL_ZERO_LOADER_SOURCE_VERSION v1.8.8)
-
-  #TODO: Replace ExternalProject with FetchContent for better maintainance and
-  #      cmake files simplification
-  include(ExternalProject)
-  ExternalProject_Add(level-zero-loader
-    GIT_REPOSITORY    https://github.com/oneapi-src/level-zero.git
-    GIT_TAG           ${LEVEL_ZERO_LOADER_SOURCE_VERSION}
-    UPDATE_DISCONNECTED ${SYCL_EP_LEVEL_ZERO_LOADER_SKIP_AUTO_UPDATE}
-    SOURCE_DIR        ${LEVEL_ZERO_LOADER_SOURCE_DIR}
-    BINARY_DIR        "${CMAKE_CURRENT_BINARY_DIR}/level_zero_loader_build"
-    INSTALL_DIR       "${CMAKE_CURRENT_BINARY_DIR}/level_zero_loader_install"
-    CMAKE_ARGS -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}
-               -DCMAKE_MAKE_PROGRAM=${CMAKE_MAKE_PROGRAM}
-               -DCMAKE_INSTALL_PREFIX=<INSTALL_DIR>
-               -DCMAKE_INSTALL_LIBDIR:PATH=lib${LLVM_LIBDIR_SUFFIX}
-               ${AUX_CMAKE_FLAGS}
-               LOG_DOWNLOAD 1
-               LOG_UPDATE 1
-               LOG_CONFIGURE 1
-               LOG_BUILD 1
-               LOG_INSTALL 1
-    STEP_TARGETS      configure,build,install
-    DEPENDS           OpenCL-Headers
-    BUILD_BYPRODUCTS ${LEVEL_ZERO_LOADER}
-  )
-  ExternalProject_Add_Step(level-zero-loader llvminstall
-    COMMAND ${CMAKE_COMMAND} -E copy_directory <INSTALL_DIR>/lib/ ${LLVM_BINARY_DIR}/lib
-    COMMAND ${CMAKE_COMMAND} -E copy_directory <INSTALL_DIR>/include/ ${LLVM_BINARY_DIR}/include/sycl
-    COMMENT "Installing level-zero-loader into the LLVM binary directory"
-    DEPENDEES install
-  )
 
-  install(DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/level_zero_loader_install/"
-    DESTINATION "."
-    COMPONENT level-zero-loader
-  )
+  set(LEVEL_ZERO_LOADER_REPO "https://github.com/oneapi-src/level-zero.git")
+  set(LEVEL_ZERO_LOADER_TAG v1.8.8)
 
-  set(LEVEL_ZERO_INCLUDE_DIR ${CMAKE_CURRENT_BINARY_DIR}/level_zero_loader_install/include/
-	  CACHE INTERNAL "Path containing Level_Zero header files.")
-else()
-  file(GLOB LEVEL_ZERO_LIBRARY_SRC "${LEVEL_ZERO_LIBRARY}*")
-  get_filename_component(LEVEL_ZERO_LIB_NAME ${LEVEL_ZERO_LIBRARY} NAME)
-  add_custom_target(level-zero-loader
-      DEPENDS
-	  ${LLVM_LIBRARY_OUTPUT_INTDIR}/${LEVEL_ZERO_LIB_NAME}
-	  ${LLVM_BINARY_DIR}/include/sycl/level_zero
-  )
-  add_custom_command(
-      OUTPUT
-	  ${LLVM_LIBRARY_OUTPUT_INTDIR}/${LEVEL_ZERO_LIB_NAME}
-	  ${LLVM_BINARY_DIR}/include/sycl/level_zero
-      COMMENT
-	  "Copying Level Zero loader and headers"
-      COMMAND
-	  ${CMAKE_COMMAND} -E copy ${LEVEL_ZERO_LIBRARY_SRC} ${LLVM_LIBRARY_OUTPUT_INTDIR}
-      COMMAND
-	  ${CMAKE_COMMAND} -E copy_directory ${LEVEL_ZERO_INCLUDE_DIR} ${LLVM_BINARY_DIR}/include/sycl
-      DEPENDS
-	  ${LEVEL_ZERO_LIBRARY}
-          ${LEVEL_ZERO_INCLUDE_DIR}
+  # Disable due to a bug https://github.com/oneapi-src/level-zero/issues/104
+  set(CMAKE_INCLUDE_CURRENT_DIR OFF)
+
+  message(STATUS "Will fetch Level Zero Loader from ${LEVEL_ZERO_LOADER_REPO}")
+  include(FetchContent)
+  FetchContent_Declare(level-zero-loader
+    GIT_REPOSITORY    ${LEVEL_ZERO_LOADER_REPO}
+    GIT_TAG           ${LEVEL_ZERO_LOADER_TAG}
   )
-endif()
 
-list(APPEND SYCL_TOOLCHAIN_DEPLOY_COMPONENTS level-zero-loader level-zero-headers)
+  # Suppress some pedantic warnings for Level Zero build
+  set(CMAKE_CXX_FLAGS_BAK "${CMAKE_CXX_FLAGS}")
+  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-unused-but-set-variable")
+  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-pedantic")
+  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-stringop-truncation")
+  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-unknown-warning-option")
 
-include_directories("${LEVEL_ZERO_INCLUDE_DIR}")
+  FetchContent_MakeAvailable(level-zero-loader)
+  FetchContent_GetProperties(level-zero-loader)
+
+  # Restore original flags
+  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS_BAK}")
+
+  set(LEVEL_ZERO_LIBRARY ze_loader)
+  set(LEVEL_ZERO_INCLUDE_DIR
+    ${level-zero-loader_SOURCE_DIR}/include CACHE PATH "Path to Level Zero Headers")
+endif()
+
+add_library (LevelZeroLoader INTERFACE)
+target_link_libraries(LevelZeroLoader
+  INTERFACE "${LEVEL_ZERO_LIBRARY}"
+)
 
 add_library (LevelZeroLoader-Headers INTERFACE)
-add_library (LevelZeroLoader::Headers ALIAS LevelZeroLoader-Headers)
 target_include_directories(LevelZeroLoader-Headers
   INTERFACE "${LEVEL_ZERO_INCLUDE_DIR}"
 )
 
 if (SYCL_ENABLE_XPTI_TRACING)
   set(XPTI_PROXY_SRC "${CMAKE_SOURCE_DIR}/../xpti/src/xpti_proxy.cpp")
+  set(XPTI_INCLUDE "${CMAKE_SOURCE_DIR}/../xpti/include")
+  set(XPTI_LIBS "${CMAKE_DL_LIBS}")
 endif()
 
+find_package(Python3 REQUIRED)
+
+add_custom_target(ze-api
+  COMMAND ${Python3_EXECUTABLE}
+  ${CMAKE_CURRENT_SOURCE_DIR}/ze_api_generator.py
+  ${LEVEL_ZERO_INCLUDE_DIR}/ze_api.h
+  BYPRODUCTS
+    ${CMAKE_CURRENT_BINARY_DIR}/ze_api.def
+  )
+
 find_package(Threads REQUIRED)
 
 add_sycl_plugin(level_zero
   SOURCES
-    "${sycl_inc_dir}/sycl/detail/pi.h"
-    "${CMAKE_CURRENT_SOURCE_DIR}/pi_level_zero.cpp"
-    "${CMAKE_CURRENT_SOURCE_DIR}/pi_level_zero.hpp"
-    "${CMAKE_CURRENT_SOURCE_DIR}/usm_allocator.cpp"
-    "${CMAKE_CURRENT_SOURCE_DIR}/usm_allocator.hpp"
-    "${CMAKE_CURRENT_SOURCE_DIR}/tracing.cpp"
+    # These are short-term shared with Unified Runtime
+    # The two plugins define a few things differrently so must
+    # be built separately. This difference is spelled in
+    # their "ur_bindings.hpp" files.
+    #
+    "ur_bindings.hpp"
+    "../unified_runtime/pi2ur.hpp"
+    "../unified_runtime/pi2ur.cpp"
+    "../unified_runtime/ur/ur.hpp"
+    "../unified_runtime/ur/ur.cpp"
+    "../unified_runtime/ur/adapters/level_zero/ur_level_zero.hpp"
+    "../unified_runtime/ur/adapters/level_zero/ur_level_zero.cpp"
+    # Following are the PI Level-Zero Plugin only codes.
+    "pi_level_zero.cpp"
+    "pi_level_zero.hpp"
+    "usm_allocator.cpp"
+    "usm_allocator.hpp"
+    "tracing.cpp"
     ${XPTI_PROXY_SRC}
+  INCLUDE_DIRS
+    ${CMAKE_CURRENT_BINARY_DIR} # for ze_api.def
+    ${CMAKE_CURRENT_SOURCE_DIR} # for Level-Zero Plugin "ur_bindings.hpp"
+    ${CMAKE_CURRENT_SOURCE_DIR}/../unified_runtime # for Unified Runtime
+    ${XPTI_INCLUDE}
   LIBRARIES
-    "${LEVEL_ZERO_LOADER}"
+    LevelZeroLoader-Headers
+    UnifiedRuntime-Headers
+    LevelZeroLoader
     Threads::Threads
-    unified_runtime
+    ${XPTI_LIBS}
 )
 
-find_package(Python3 REQUIRED)
-
-add_custom_target(ze-api
-  COMMAND ${Python3_EXECUTABLE}
-  ${CMAKE_CURRENT_SOURCE_DIR}/ze_api_generator.py
-  ${LEVEL_ZERO_INCLUDE_DIR}/level_zero/ze_api.h
-  BYPRODUCTS
-    ${CMAKE_CURRENT_BINARY_DIR}/ze_api.def
-  )
-target_include_directories(pi_level_zero PRIVATE ${CMAKE_CURRENT_BINARY_DIR})
 add_dependencies(pi_level_zero ze-api)
 
 if (SYCL_ENABLE_XPTI_TRACING)
   target_compile_definitions(pi_level_zero PRIVATE
     XPTI_ENABLE_INSTRUMENTATION
     XPTI_STATIC_LIBRARY
   )
-  target_include_directories(pi_level_zero PRIVATE "${CMAKE_SOURCE_DIR}/../xpti/include")
-  target_link_libraries(pi_level_zero PRIVATE ${CMAKE_DL_LIBS})
-endif()
-
-if (TARGET level-zero-loader)
-  add_dependencies(ze-api level-zero-loader)
-  add_dependencies(pi_level_zero level-zero-loader)
 endif()