[SYCL][ABI-Break] Remove deprecated OptionalDevice input type of make_queue and remove deprecated make_queue ABIs (#6628)

We introduced a tentative OptionalDevice input type of make_queue API to support the SYCL 2020 API as well as the legacy API which did not require Device to be passed as a parameter.
This PR intends to remove this tentative input type.
Extended: Now this PR also removed deprecated make_queue ABIs and make the make_queue to take a pointer to pi_device, which becomes back to optional.

Signed-off-by: Byoungro So <[email protected]>

Author: bso-intel

sycl/CMakeLists.txt

@@ -30,7 +30,7 @@ set(SYCL_MINOR_VERSION 7)
 set(SYCL_PATCH_VERSION 0)
 # Don't forget to re-enable sycl_symbols_windows.dump once we leave ABI-breaking
 # window!
-set(SYCL_DEV_ABI_VERSION 14)
+set(SYCL_DEV_ABI_VERSION 15)
 if (SYCL_ADD_DEV_VERSION_POSTFIX)
   set(SYCL_VERSION_POSTFIX "-${SYCL_DEV_ABI_VERSION}")
 endif()

sycl/include/sycl/backend.hpp

@@ -208,14 +208,7 @@ __SYCL_EXPORT context make_context(pi_native_handle NativeHandle,
                                    backend Backend);
 __SYCL_EXPORT queue make_queue(pi_native_handle NativeHandle,
                                const context &TargetContext,
-                               const device &TargetDevice, bool KeepOwnership,
-                               const async_handler &Handler, backend Backend);
-// TODO: Unused. Remove when allowed.
-__SYCL_EXPORT queue make_queue(pi_native_handle NativeHandle,
-                               const context &TargetContext, bool KeepOwnership,
-                               const async_handler &Handler, backend Backend);
-__SYCL_EXPORT queue make_queue(pi_native_handle NativeHandle,
-                               const context &TargetContext,
+                               const device *TargetDevice, bool KeepOwnership,
                                const async_handler &Handler, backend Backend);
 __SYCL_EXPORT event make_event(pi_native_handle NativeHandle,
                                const context &TargetContext, backend Backend);
@@ -270,27 +263,14 @@ make_context(
                               Handler, Backend);
 }
 
-template <backend Backend>
-__SYCL_DEPRECATED("Use SYCL 2020 sycl::make_queue free function")
-typename std::enable_if<
-    detail::InteropFeatureSupportMap<Backend>::MakeQueue == true, queue>::type
-    make_queue(
-        const typename backend_traits<Backend>::template input_type<queue>
-            &BackendObject,
-        const context &TargetContext, bool KeepOwnership,
-        const async_handler Handler = {}) {
-  return detail::make_queue(detail::pi::cast<pi_native_handle>(BackendObject),
-                            TargetContext, KeepOwnership, Handler, Backend);
-}
-
 template <backend Backend>
 typename std::enable_if<
     detail::InteropFeatureSupportMap<Backend>::MakeQueue == true, queue>::type
 make_queue(const typename backend_traits<Backend>::template input_type<queue>
                &BackendObject,
            const context &TargetContext, const async_handler Handler = {}) {
   return detail::make_queue(detail::pi::cast<pi_native_handle>(BackendObject),
-                            TargetContext, false, Handler, Backend);
+                            TargetContext, nullptr, false, Handler, Backend);
 }
 
 template <backend Backend>

sycl/include/sycl/detail/backend_traits_level_zero.hpp

@@ -128,45 +128,12 @@ template <> struct BackendReturn<backend::ext_oneapi_level_zero, event> {
   using type = ze_event_handle_t;
 };
 
-struct OptionalDevice {
-  OptionalDevice() : DeviceImpl(nullptr) {}
-  OptionalDevice(device dev) : DeviceImpl(getSyclObjImpl(dev)) {}
-
-  operator device() const {
-    if (!DeviceImpl)
-      throw runtime_error("No device has been set.", PI_ERROR_INVALID_DEVICE);
-    return createSyclObjFromImpl<device>(DeviceImpl);
-  }
-
-  OptionalDevice &operator=(OptionalDevice &Other) {
-    DeviceImpl = Other.DeviceImpl;
-    return *this;
-  }
-  OptionalDevice &operator=(device &Other) {
-    DeviceImpl = getSyclObjImpl(Other);
-    return *this;
-  }
-
-private:
-  std::shared_ptr<device_impl> DeviceImpl;
-
-  friend bool OptionalDeviceHasDevice(const OptionalDevice &Dev);
-};
-
-// Inspector function in the detail namespace to avoid exposing
-// OptionalDevice::hasDevice to user-space.
-inline bool OptionalDeviceHasDevice(const OptionalDevice &Dev) {
-  return Dev.DeviceImpl != nullptr;
-}
-
 template <> struct BackendInput<backend::ext_oneapi_level_zero, queue> {
   struct type {
     interop<backend::ext_oneapi_level_zero, queue>::type NativeHandle;
     ext::oneapi::level_zero::ownership Ownership;
 
-    // TODO: Change this to be device when the deprecated constructor is
-    // removed.
-    OptionalDevice Device;
+    device Device;
 
     type()
         : Ownership(ext::oneapi::level_zero::ownership::transfer), Device() {}

sycl/include/sycl/ext/oneapi/backend/level_zero.hpp

@@ -123,9 +123,7 @@ inline queue make_queue<backend::ext_oneapi_level_zero>(
     const backend_input_t<backend::ext_oneapi_level_zero, queue> &BackendObject,
     const context &TargetContext, const async_handler Handler) {
   (void)Handler;
-  const device Device = detail::OptionalDeviceHasDevice(BackendObject.Device)
-                            ? device{BackendObject.Device}
-                            : TargetContext.get_devices()[0];
+  const device Device = device{BackendObject.Device};
   return ext::oneapi::level_zero::make_queue(
       TargetContext, Device,
       detail::pi::cast<pi_native_handle>(BackendObject.NativeHandle),

sycl/include/sycl/ext/oneapi/experimental/backend/cuda.hpp

@@ -89,7 +89,7 @@ inline queue make_queue<backend::ext_oneapi_cuda>(
     const backend_input_t<backend::ext_oneapi_cuda, queue> &BackendObject,
     const context &TargetContext, const async_handler Handler) {
   return detail::make_queue(detail::pi::cast<pi_native_handle>(BackendObject),
-                            TargetContext, true, Handler,
+                            TargetContext, nullptr, true, Handler,
                             /*Backend*/ backend::ext_oneapi_cuda);
 }
 

sycl/plugins/level_zero/pi_level_zero.cpp

@@ -3811,16 +3811,12 @@ pi_result piextQueueCreateWithNativeHandle(pi_native_handle NativeHandle,
   PI_ASSERT(Context, PI_ERROR_INVALID_CONTEXT);
   PI_ASSERT(NativeHandle, PI_ERROR_INVALID_VALUE);
   PI_ASSERT(Queue, PI_ERROR_INVALID_QUEUE);
+  PI_ASSERT(Device, PI_ERROR_INVALID_DEVICE);
 
   auto ZeQueue = pi_cast<ze_command_queue_handle_t>(NativeHandle);
   // Assume this is the "0" index queue in the compute command-group.
   std::vector<ze_command_queue_handle_t> ZeQueues{ZeQueue};
 
-  // For compatibility with older implementations we allow the device to be
-  // optional for now. Once the deprecated interop API is removed this can be
-  // changed to an assert(Device).
-  if (!Device)
-    Device = Context->Devices[0];
   // TODO: see what we can do to correctly initialize PI queue for
   // compute vs. copy Level-Zero queue. Currently we will send
   // all commands to the "ZeQueue".

sycl/source/backend.cpp

@@ -96,26 +96,17 @@ queue make_queue_impl(pi_native_handle NativeHandle, const context &Context,
 }
 
 __SYCL_EXPORT queue make_queue(pi_native_handle NativeHandle,
-                               const context &Context,
-                               const async_handler &Handler, backend Backend) {
-  return make_queue_impl(NativeHandle, Context, nullptr, false, Handler,
-                         Backend);
-}
-
-__SYCL_EXPORT queue make_queue(pi_native_handle NativeHandle,
-                               const context &Context, bool KeepOwnership,
-                               const async_handler &Handler, backend Backend) {
-  return make_queue_impl(NativeHandle, Context, nullptr, KeepOwnership, Handler,
-                         Backend);
-}
-
-__SYCL_EXPORT queue make_queue(pi_native_handle NativeHandle,
-                               const context &Context, const device &Device,
+                               const context &Context, const device *Device,
                                bool KeepOwnership, const async_handler &Handler,
                                backend Backend) {
-  const auto &DeviceImpl = getSyclObjImpl(Device);
-  return make_queue_impl(NativeHandle, Context, DeviceImpl->getHandleRef(),
-                         KeepOwnership, Handler, Backend);
+  if (Device) {
+    const auto &DeviceImpl = getSyclObjImpl(*Device);
+    return make_queue_impl(NativeHandle, Context, DeviceImpl->getHandleRef(),
+                           KeepOwnership, Handler, Backend);
+  } else {
+    return make_queue_impl(NativeHandle, Context, nullptr, KeepOwnership,
+                           Handler, Backend);
+  }
 }
 
 __SYCL_EXPORT event make_event(pi_native_handle NativeHandle,

sycl/source/backend/level_zero.cpp

@@ -67,7 +67,7 @@ __SYCL_EXPORT queue make_queue(const context &Context,
                                pi_native_handle NativeHandle,
                                bool KeepOwnership) {
   const auto &ContextImpl = getSyclObjImpl(Context);
-  return detail::make_queue(NativeHandle, Context, KeepOwnership,
+  return detail::make_queue(NativeHandle, Context, nullptr, KeepOwnership,
                             ContextImpl->get_async_handler(),
                             backend::ext_oneapi_level_zero);
 }
@@ -76,7 +76,7 @@ __SYCL_EXPORT queue make_queue(const context &Context, const device &Device,
                                pi_native_handle NativeHandle,
                                bool KeepOwnership) {
   const auto &ContextImpl = getSyclObjImpl(Context);
-  return detail::make_queue(NativeHandle, Context, Device, KeepOwnership,
+  return detail::make_queue(NativeHandle, Context, &Device, KeepOwnership,
                             ContextImpl->get_async_handler(),
                             backend::ext_oneapi_level_zero);
 }

sycl/source/backend/opencl.cpp

@@ -41,7 +41,7 @@ __SYCL_EXPORT context make_context(pi_native_handle NativeHandle) {
 __SYCL_EXPORT queue make_queue(const context &Context,
                                pi_native_handle NativeHandle) {
   const auto &ContextImpl = getSyclObjImpl(Context);
-  return detail::make_queue(NativeHandle, Context, false,
+  return detail::make_queue(NativeHandle, Context, nullptr, false,
                             ContextImpl->get_async_handler(), backend::opencl);
 }
 } // namespace opencl

sycl/test/abi/sycl_symbols_linux.dump

@@ -3716,9 +3716,7 @@ _ZN4sycl3_V16detail10image_implC1EP7_cl_memRKNS0_7contextENS0_5eventESt10unique_
 _ZN4sycl3_V16detail10image_implC2EP7_cl_memRKNS0_7contextENS0_5eventESt10unique_ptrINS1_19SYCLMemObjAllocatorESt14default_deleteISA_EEh
 _ZN4sycl3_V16detail10make_eventEmRKNS0_7contextENS0_7backendE
 _ZN4sycl3_V16detail10make_eventEmRKNS0_7contextEbNS0_7backendE
-_ZN4sycl3_V16detail10make_queueEmRKNS0_7contextERKNS0_6deviceEbRKSt8functionIFvNS0_14exception_listEEENS0_7backendE
-_ZN4sycl3_V16detail10make_queueEmRKNS0_7contextERKSt8functionIFvNS0_14exception_listEEENS0_7backendE
-_ZN4sycl3_V16detail10make_queueEmRKNS0_7contextEbRKSt8functionIFvNS0_14exception_listEEENS0_7backendE
+_ZN4sycl3_V16detail10make_queueEmRKNS0_7contextEPKNS0_6deviceEbRKSt8functionIFvNS0_14exception_listEEENS0_7backendE
 _ZN4sycl3_V16detail10waitEventsESt6vectorINS0_5eventESaIS3_EE
 _ZN4sycl3_V16detail11SYCLMemObjT10releaseMemESt10shared_ptrINS1_12context_implEEPv
 _ZN4sycl3_V16detail11SYCLMemObjT16determineHostPtrERKSt10shared_ptrINS1_12context_implEEbRPvRb