[SYCL] Fix get_native() and add get_backend() accordingly to the specification (#3236)

Signed-off-by: mdimakov <[email protected]>

Author: maximdimakov

sycl/include/CL/sycl/backend.hpp

@@ -10,13 +10,17 @@
 
 #include <CL/sycl/accessor.hpp>
 #include <CL/sycl/backend_types.hpp>
+#include <CL/sycl/exception.hpp>
 
 __SYCL_INLINE_NAMESPACE(cl) {
 namespace sycl {
 
 template <backend BackendName, class SyclObjectT>
 auto get_native(const SyclObjectT &Obj) ->
     typename interop<BackendName, SyclObjectT>::type {
+  // TODO use SYCL 2020 exception when implemented
+  if (Obj.get_backend() != BackendName)
+    throw runtime_error("Backends mismatch", PI_INVALID_OPERATION);
   return Obj.template get_native<BackendName>();
 }
 

sycl/include/CL/sycl/backend/opencl.hpp

@@ -36,6 +36,8 @@ template <> struct interop<backend::opencl, program> {
   using type = cl_program;
 };
 
+template <> struct interop<backend::opencl, event> { using type = cl_event; };
+
 template <typename DataT, int Dimensions, access::mode AccessMode>
 struct interop<backend::opencl, accessor<DataT, Dimensions, AccessMode,
                                          access::target::global_buffer,

sycl/include/CL/sycl/context.hpp

@@ -194,6 +194,11 @@ class __SYCL_EXPORT context {
   /// \return true if this context is a SYCL host context.
   bool is_host() const;
 
+  /// Returns the backend associated with this context.
+  ///
+  /// \return the backend associated with this context.
+  backend get_backend() const noexcept;
+
   /// Gets platform associated with this SYCL context.
   ///
   /// \return a valid instance of SYCL platform.

sycl/include/CL/sycl/device.hpp

@@ -172,6 +172,11 @@ class __SYCL_EXPORT device {
   static vector_class<device>
   get_devices(info::device_type deviceType = info::device_type::all);
 
+  /// Returns the backend associated with this device.
+  ///
+  /// \return the backend associated with this device.
+  backend get_backend() const noexcept;
+
   /// Gets the native handle of the SYCL device.
   ///
   /// \return a native handle, the type of which defined by the backend.

sycl/include/CL/sycl/event.hpp

@@ -118,12 +118,18 @@ class __SYCL_EXPORT event {
   typename info::param_traits<info::event_profiling, param>::return_type
   get_profiling_info() const;
 
+  /// Returns the backend associated with this platform.
+  ///
+  /// \return the backend associated with this platform
+  backend get_backend() const noexcept;
+
   /// Gets the native handle of the SYCL event.
   ///
   /// \return a native handle, the type of which defined by the backend.
   template <backend BackendName>
   auto get_native() const -> typename interop<BackendName, event>::type {
-    return static_cast<typename interop<BackendName, event>::type>(getNative());
+    return reinterpret_cast<typename interop<BackendName, event>::type>(
+        getNative());
   }
 
 private:

sycl/include/CL/sycl/program.hpp

@@ -356,6 +356,11 @@ class __SYCL_EXPORT program {
 #endif // __SYCL_DEVICE_ONLY__
   }
 
+  /// Returns the backend associated with this program.
+  ///
+  /// \return the backend associated with this program.
+  backend get_backend() const noexcept;
+
   /// Gets the native handle of the SYCL platform.
   ///
   /// \return a native handle, the type of which defined by the backend.

sycl/include/CL/sycl/queue.hpp

@@ -750,6 +750,11 @@ class __SYCL_EXPORT queue {
   /// Equivalent to has_property<property::queue::in_order>()
   bool is_in_order() const;
 
+  /// Returns the backend associated with this queue.
+  ///
+  /// \return the backend associated with this queue.
+  backend get_backend() const noexcept;
+
   /// Gets the native handle of the SYCL queue.
   ///
   /// \return a native handle, the type of which defined by the backend.

sycl/source/context.cpp

@@ -15,6 +15,7 @@
 #include <CL/sycl/platform.hpp>
 #include <CL/sycl/properties/all_properties.hpp>
 #include <CL/sycl/stl.hpp>
+#include <detail/backend_impl.hpp>
 #include <detail/context_impl.hpp>
 
 #include <algorithm>
@@ -117,6 +118,8 @@ cl_context context::get() const { return impl->get(); }
 
 bool context::is_host() const { return impl->is_host(); }
 
+backend context::get_backend() const noexcept { return getImplBackend(impl); }
+
 platform context::get_platform() const {
   return impl->get_info<info::context::platform>();
 }

sycl/source/detail/backend_impl.hpp

@@ -0,0 +1,29 @@
+//==------------------ backend_impl.hpp - get impls backend
+//-------------------------==//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#pragma once
+#include <CL/sycl/backend_types.hpp>
+
+__SYCL_INLINE_NAMESPACE(cl) {
+namespace sycl {
+namespace detail {
+
+template <class T> backend getImplBackend(const T &Impl) {
+  backend Result;
+  if (Impl->is_host())
+    Result = backend::host;
+  else
+    Result = Impl->getPlugin().getBackend();
+
+  return Result;
+}
+
+} // namespace detail
+} // namespace sycl
+} // __SYCL_INLINE_NAMESPACE(cl)

sycl/source/detail/context_impl.cpp

@@ -169,6 +169,8 @@ bool context_impl::hasDevice(
 
 pi_native_handle context_impl::getNative() const {
   auto Plugin = getPlugin();
+  if (Plugin.getBackend() == backend::opencl)
+    Plugin.call<PiApiKind::piContextRetain>(getHandleRef());
   pi_native_handle Handle;
   Plugin.call<PiApiKind::piextContextGetNativeHandle>(getHandleRef(), &Handle);
   return Handle;

sycl/source/detail/device_impl.cpp

@@ -209,6 +209,8 @@ vector_class<device> device_impl::create_sub_devices(
 
 pi_native_handle device_impl::getNative() const {
   auto Plugin = getPlugin();
+  if (Plugin.getBackend() == backend::opencl)
+    Plugin.call<PiApiKind::piDeviceRetain>(getHandleRef());
   pi_native_handle Handle;
   Plugin.call<PiApiKind::piextDeviceGetNativeHandle>(getHandleRef(), &Handle);
   return Handle;

sycl/source/detail/event_impl.cpp

@@ -292,6 +292,8 @@ void HostProfilingInfo::end() { EndTime = getTimestamp(); }
 
 pi_native_handle event_impl::getNative() const {
   auto Plugin = getPlugin();
+  if (Plugin.getBackend() == backend::opencl)
+    Plugin.call<PiApiKind::piEventRetain>(getHandleRef());
   pi_native_handle Handle;
   Plugin.call<PiApiKind::piextEventGetNativeHandle>(getHandleRef(), &Handle);
   return Handle;

sycl/source/detail/event_impl.hpp

@@ -13,6 +13,7 @@
 #include <CL/sycl/detail/pi.hpp>
 #include <CL/sycl/info/info_desc.hpp>
 #include <CL/sycl/stl.hpp>
+#include <detail/plugin.hpp>
 
 #include <atomic>
 #include <cassert>

sycl/source/detail/platform_impl.hpp

@@ -108,18 +108,6 @@ class platform_impl {
   /// \return a vector of all available SYCL platforms.
   static vector_class<platform> get_platforms();
 
-  // \return the Backend associated with this platform.
-  backend get_backend() const noexcept {
-    backend Result;
-    if (is_host())
-      Result = backend::host;
-    else {
-      Result = getPlugin().getBackend();
-    }
-
-    return Result;
-  }
-
   // \return the Plugin associated with this platform.
   const plugin &getPlugin() const {
     assert(!MHostPlatform && "Plugin is not available for Host.");

sycl/source/detail/program_impl.cpp

@@ -583,6 +583,8 @@ void program_impl::flush_spec_constants(const RTDeviceBinaryImage &Img,
 
 pi_native_handle program_impl::getNative() const {
   const auto &Plugin = getPlugin();
+  if (Plugin.getBackend() == backend::opencl)
+    Plugin.call<PiApiKind::piProgramRetain>(MProgram);
   pi_native_handle Handle;
   Plugin.call<PiApiKind::piextProgramGetNativeHandle>(MProgram, &Handle);
   return Handle;

sycl/source/detail/queue_impl.cpp

@@ -273,6 +273,8 @@ void queue_impl::initHostTaskAndEventCallbackThreadPool() {
 
 pi_native_handle queue_impl::getNative() const {
   const detail::plugin &Plugin = getPlugin();
+  if (Plugin.getBackend() == backend::opencl)
+    Plugin.call<PiApiKind::piQueueRetain>(MQueues[0]);
   pi_native_handle Handle{};
   Plugin.call<PiApiKind::piextQueueGetNativeHandle>(MQueues[0], &Handle);
   return Handle;

sycl/source/device.cpp

@@ -10,6 +10,7 @@
 #include <CL/sycl/device.hpp>
 #include <CL/sycl/device_selector.hpp>
 #include <CL/sycl/info/info_desc.hpp>
+#include <detail/backend_impl.hpp>
 #include <detail/config.hpp>
 #include <detail/device_impl.hpp>
 #include <detail/force_device.hpp>
@@ -136,6 +137,8 @@ device::get_info() const {
 
 #undef __SYCL_PARAM_TRAITS_SPEC
 
+backend device::get_backend() const noexcept { return getImplBackend(impl); }
+
 pi_native_handle device::getNative() const { return impl->getNative(); }
 
 bool device::has(aspect Aspect) const { return impl->has(Aspect); }

sycl/source/event.cpp

@@ -12,6 +12,7 @@
 #include <CL/sycl/event.hpp>
 #include <CL/sycl/info/info_desc.hpp>
 #include <CL/sycl/stl.hpp>
+#include <detail/backend_impl.hpp>
 #include <detail/event_impl.hpp>
 #include <detail/scheduler/scheduler.hpp>
 
@@ -85,6 +86,8 @@ event::event(shared_ptr_class<detail::event_impl> event_impl)
 
 #undef __SYCL_PARAM_TRAITS_SPEC
 
+backend event::get_backend() const noexcept { return getImplBackend(impl); }
+
 pi_native_handle event::getNative() const { return impl->getNative(); }
 
 } // namespace sycl

sycl/source/platform.cpp

@@ -10,6 +10,7 @@
 #include <CL/sycl/device_selector.hpp>
 #include <CL/sycl/info/info_desc.hpp>
 #include <CL/sycl/platform.hpp>
+#include <detail/backend_impl.hpp>
 #include <detail/force_device.hpp>
 #include <detail/platform_impl.hpp>
 
@@ -43,7 +44,7 @@ vector_class<platform> platform::get_platforms() {
   return detail::platform_impl::get_platforms();
 }
 
-backend platform::get_backend() const noexcept { return impl->get_backend(); }
+backend platform::get_backend() const noexcept { return getImplBackend(impl); }
 
 template <info::platform param>
 typename info::param_traits<info::platform, param>::return_type

sycl/source/program.cpp

@@ -9,6 +9,7 @@
 #include <CL/sycl/program.hpp>
 #include <CL/sycl/properties/all_properties.hpp>
 #include <CL/sycl/property_list.hpp>
+#include <detail/backend_impl.hpp>
 #include <detail/program_impl.hpp>
 
 #include <vector>
@@ -47,6 +48,8 @@ program::program(const context &context, cl_program clProgram)
   clRetainProgram(clProgram);
 }
 
+backend program::get_backend() const noexcept { return getImplBackend(impl); }
+
 pi_native_handle program::getNative() const { return impl->getNative(); }
 
 program::program(std::shared_ptr<detail::program_impl> impl) : impl(impl) {}

sycl/source/queue.cpp

@@ -11,6 +11,7 @@
 #include <CL/sycl/handler.hpp>
 #include <CL/sycl/queue.hpp>
 #include <CL/sycl/stl.hpp>
+#include <detail/backend_impl.hpp>
 #include <detail/queue_impl.hpp>
 
 #include <algorithm>
@@ -138,6 +139,8 @@ bool queue::is_in_order() const {
   return impl->has_property<property::queue::in_order>();
 }
 
+backend queue::get_backend() const noexcept { return getImplBackend(impl); }
+
 pi_native_handle queue::getNative() const { return impl->getNative(); }
 
 } // namespace sycl

sycl/test/abi/sycl_symbols_linux.dump

@@ -3897,6 +3897,7 @@ _ZNK2cl4sycl15interop_handler12GetNativeMemEPNS0_6detail16AccessorImplHostE
 _ZNK2cl4sycl15interop_handler14GetNativeQueueEv
 _ZNK2cl4sycl16default_selectorclERKNS0_6deviceE
 _ZNK2cl4sycl20accelerator_selectorclERKNS0_6deviceE
+_ZNK2cl4sycl5event11get_backendEv
 _ZNK2cl4sycl5event18get_profiling_infoILNS0_4info15event_profilingE4737EEENS3_12param_traitsIS4_XT_EE11return_typeEv
 _ZNK2cl4sycl5event18get_profiling_infoILNS0_4info15event_profilingE4738EEENS3_12param_traitsIS4_XT_EE11return_typeEv
 _ZNK2cl4sycl5event18get_profiling_infoILNS0_4info15event_profilingE4739EEENS3_12param_traitsIS4_XT_EE11return_typeEv
@@ -3908,6 +3909,7 @@ _ZNK2cl4sycl5event9getNativeEv
 _ZNK2cl4sycl5eventeqERKS1_
 _ZNK2cl4sycl5eventneERKS1_
 _ZNK2cl4sycl5queue10get_deviceEv
+_ZNK2cl4sycl5queue11get_backendEv
 _ZNK2cl4sycl5queue11get_contextEv
 _ZNK2cl4sycl5queue11is_in_orderEv
 _ZNK2cl4sycl5queue12get_propertyINS0_8property5queue16enable_profilingEEET_v
@@ -3968,6 +3970,7 @@ _ZNK2cl4sycl6detail19kernel_bundle_plain37get_specialization_constant_raw_valueE
 _ZNK2cl4sycl6detail19kernel_bundle_plain3endEv
 _ZNK2cl4sycl6detail19kernel_bundle_plain5beginEv
 _ZNK2cl4sycl6detail19kernel_bundle_plain5emptyEv
+_ZNK2cl4sycl6device11get_backendEv
 _ZNK2cl4sycl6device12get_platformEv
 _ZNK2cl4sycl6device13has_extensionERKNSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE
 _ZNK2cl4sycl6device14is_acceleratorEv
@@ -4103,6 +4106,7 @@ _ZNK2cl4sycl6stream22get_max_statement_sizeEv
 _ZNK2cl4sycl6stream8get_sizeEv
 _ZNK2cl4sycl6streameqERKS1_
 _ZNK2cl4sycl6streamneERKS1_
+_ZNK2cl4sycl7context11get_backendEv
 _ZNK2cl4sycl7context11get_devicesEv
 _ZNK2cl4sycl7context12get_platformEv
 _ZNK2cl4sycl7context12get_propertyINS0_3ext6oneapi8property6buffer22use_pinned_host_memoryEEET_v
@@ -4137,6 +4141,7 @@ _ZNK2cl4sycl7program10get_kernelENSt7__cxx1112basic_stringIcSt11char_traitsIcESa
 _ZNK2cl4sycl7program10get_kernelENSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEEb
 _ZNK2cl4sycl7program10has_kernelENSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEE
 _ZNK2cl4sycl7program10has_kernelENSt7__cxx1112basic_stringIcSt11char_traitsIcESaIcEEEb
+_ZNK2cl4sycl7program11get_backendEv
 _ZNK2cl4sycl7program11get_contextEv
 _ZNK2cl4sycl7program11get_devicesEv
 _ZNK2cl4sycl7program12get_binariesEv

sycl/unittests/CMakeLists.txt

@@ -9,6 +9,7 @@ endforeach()
 
 include(AddSYCLUnitTest)
 
+add_subdirectory(get_native_interop)
 add_subdirectory(misc)
 add_subdirectory(pi)
 add_subdirectory(kernel-and-program)

sycl/unittests/get_native_interop/CMakeLists.txt

@@ -0,0 +1,3 @@
+add_sycl_unittest_with_device(GetNativeTests OBJECT
+  test_get_native.cpp
+)