Make common base class for owner-less methods

Signed-off-by: Larsen, Steffen <[email protected]>

Author: steffenlarsen

sycl/include/sycl/accessor.hpp

@@ -19,6 +19,7 @@
 #include <sycl/detail/handler_proxy.hpp>
 #include <sycl/detail/image_accessor_util.hpp>
 #include <sycl/detail/image_ocl_types.hpp>
+#include <sycl/detail/owner_less_base.hpp>
 #include <sycl/device.hpp>
 #include <sycl/exception.hpp>
 #include <sycl/ext/oneapi/accessor_property_list.hpp>
@@ -465,40 +466,6 @@ template <int Dims> class AccessorImplDevice {
   }
 };
 
-// CRTP class supplying a common definition of owner-before ordering for
-// accessors.
-template <class AccessorT> class AccessorOwnerLessBase {
-public:
-#ifndef __SYCL_DEVICE_ONLY__
-  /// Compares the accessor against a weak object using an owner-based
-  /// implementation-defined ordering.
-  ///
-  /// \param Other is the weak object to compare ordering against.
-  /// \return true if this object precedes \param Other and false otherwise.
-  bool ext_oneapi_owner_before(
-      const ext::oneapi::detail::weak_object_base<AccessorT> &Other)
-      const noexcept {
-    return static_cast<const AccessorT *>(this)->impl.owner_before(
-        ext::oneapi::detail::getSyclWeakObjImpl(Other));
-  }
-
-  /// Compares the accessor against another accessor using an owner-based
-  /// implementation-defined ordering.
-  ///
-  /// \param Other is the object to compare ordering against.
-  /// \return true if this object precedes \param Other and false otherwise.
-  bool ext_oneapi_owner_before(const AccessorT &Other) const noexcept {
-    return static_cast<const AccessorT *>(this)->impl.owner_before(Other.impl);
-  }
-#else
-  bool ext_oneapi_owner_before(
-      const ext::oneapi::detail::weak_object_base<AccessorT> &Other)
-      const noexcept;
-
-  bool ext_oneapi_owner_before(const AccessorT &Other) const noexcept;
-#endif
-};
-
 class AccessorImplHost;
 
 void __SYCL_EXPORT addHostAccessorAndWait(AccessorImplHost *Req);
@@ -577,8 +544,6 @@ class __SYCL_EXPORT LocalAccessorBaseHost {
   template <class Obj>
   friend Obj detail::createSyclObjFromImpl(decltype(Obj::impl) ImplObj);
 
-  template <class AccessorT> friend class AccessorOwnerLessBase;
-
   LocalAccessorImplPtr impl;
 };
 
@@ -1025,7 +990,7 @@ class __SYCL_SPECIAL_CLASS __SYCL_TYPE(accessor) accessor :
 #endif
     public detail::accessor_common<DataT, Dimensions, AccessMode, AccessTarget,
                                    IsPlaceholder, PropertyListT>,
-    public detail::AccessorOwnerLessBase<
+    public detail::OwnerLessBase<
         accessor<DataT, Dimensions, AccessMode, AccessTarget, IsPlaceholder,
                  PropertyListT>> {
 protected:
@@ -2690,7 +2655,7 @@ template <typename DataT, int Dimensions, access::mode AccessMode,
 class __SYCL_SPECIAL_CLASS accessor<DataT, Dimensions, AccessMode,
                                     access::target::local, IsPlaceholder>
     : public local_accessor_base<DataT, Dimensions, AccessMode, IsPlaceholder>,
-      public detail::AccessorOwnerLessBase<
+      public detail::OwnerLessBase<
           accessor<DataT, Dimensions, AccessMode, access::target::local,
                    IsPlaceholder>> {
 
@@ -2728,7 +2693,7 @@ template <typename DataT, int Dimensions = 1>
 class __SYCL_SPECIAL_CLASS __SYCL_TYPE(local_accessor) local_accessor
     : public local_accessor_base<DataT, Dimensions, access::mode::read_write,
                                  access::placeholder::false_t>,
-      public detail::AccessorOwnerLessBase<local_accessor<DataT, Dimensions>> {
+      public detail::OwnerLessBase<local_accessor<DataT, Dimensions>> {
 
   using local_acc =
       local_accessor_base<DataT, Dimensions, access::mode::read_write,
@@ -2825,7 +2790,7 @@ __SYCL_TYPE(accessor) accessor<DataT, Dimensions, AccessMode,
                                access::target::image, IsPlaceholder>
     : public detail::image_accessor<DataT, Dimensions, AccessMode,
                                     access::target::image, IsPlaceholder>,
-      public detail::AccessorOwnerLessBase<
+      public detail::OwnerLessBase<
           accessor<DataT, Dimensions, AccessMode, access::target::image,
                    IsPlaceholder>> {
 private:
@@ -2890,7 +2855,7 @@ class accessor<DataT, Dimensions, AccessMode, access::target::host_image,
                IsPlaceholder>
     : public detail::image_accessor<DataT, Dimensions, AccessMode,
                                     access::target::host_image, IsPlaceholder>,
-      public detail::AccessorOwnerLessBase<
+      public detail::OwnerLessBase<
           accessor<DataT, Dimensions, AccessMode, access::target::host_image,
                    IsPlaceholder>> {
 public:
@@ -2925,7 +2890,7 @@ __SYCL_TYPE(accessor) accessor<DataT, Dimensions, AccessMode,
                                access::target::image_array, IsPlaceholder>
     : public detail::image_accessor<DataT, Dimensions + 1, AccessMode,
                                     access::target::image, IsPlaceholder>,
-      public detail::AccessorOwnerLessBase<
+      public detail::OwnerLessBase<
           accessor<DataT, Dimensions, AccessMode, access::target::image_array,
                    IsPlaceholder>> {
 #ifdef __SYCL_DEVICE_ONLY__
@@ -2983,7 +2948,7 @@ template <typename DataT, int Dimensions = 1,
 class host_accessor
     : public accessor<DataT, Dimensions, AccessMode, target::host_buffer,
                       access::placeholder::false_t>,
-      public detail::AccessorOwnerLessBase<
+      public detail::OwnerLessBase<
           host_accessor<DataT, Dimensions, AccessMode>> {
 protected:
   using AccessorT = accessor<DataT, Dimensions, AccessMode, target::host_buffer,

sycl/include/sycl/buffer.hpp

@@ -9,6 +9,7 @@
 #pragma once
 
 #include <sycl/detail/common.hpp>
+#include <sycl/detail/owner_less_base.hpp>
 #include <sycl/detail/stl_type_traits.hpp>
 #include <sycl/detail/sycl_mem_obj_allocator.hpp>
 #include <sycl/event.hpp>
@@ -141,7 +142,8 @@ template <typename T, int dimensions = 1,
           typename AllocatorT = buffer_allocator<std::remove_const_t<T>>,
           typename __Enabled = typename detail::enable_if_t<(dimensions > 0) &&
                                                             (dimensions <= 3)>>
-class buffer : public detail::buffer_plain {
+class buffer : public detail::buffer_plain,
+               public detail::OwnerLessBase<buffer<T, dimensions, AllocatorT>> {
   // TODO check is_device_copyable<T>::value after converting sycl::vec into a
   // trivially copyable class.
   static_assert(!std::is_same<T, std::string>::value,
@@ -687,16 +689,6 @@ class buffer : public detail::buffer_plain {
     return buffer_plain::template get_property<propertyT>();
   }
 
-  bool ext_oneapi_owner_before(
-      const ext::oneapi::detail::weak_object_base<buffer> &Other)
-      const noexcept {
-    return impl.owner_before(ext::oneapi::detail::getSyclWeakObjImpl(Other));
-  }
-
-  bool ext_oneapi_owner_before(const buffer &Other) const noexcept {
-    return impl.owner_before(Other.impl);
-  }
-
 protected:
   bool isOutOfBounds(const id<dimensions> &offset,
                      const range<dimensions> &newRange,

sycl/include/sycl/context.hpp

@@ -13,6 +13,7 @@
 #include <sycl/detail/common.hpp>
 #include <sycl/detail/export.hpp>
 #include <sycl/detail/info_desc_helpers.hpp>
+#include <sycl/detail/owner_less_base.hpp>
 #include <sycl/detail/stl_type_traits.hpp>
 #include <sycl/exception_list.hpp>
 #include <sycl/ext/oneapi/weak_object_base.hpp>
@@ -37,7 +38,7 @@ auto get_native(const SyclT &Obj) -> backend_return_t<Backend, SyclT>;
 /// be executed.
 ///
 /// \ingroup sycl_api
-class __SYCL_EXPORT context {
+class __SYCL_EXPORT context : public detail::OwnerLessBase<context> {
 public:
   /// Constructs a SYCL context instance using an instance of default_selector.
   ///
@@ -220,26 +221,6 @@ class __SYCL_EXPORT context {
   /// \return a vector of valid SYCL device instances.
   std::vector<device> get_devices() const;
 
-  /// Compares the context against a weak object using an owner-based
-  /// implementation-defined ordering.
-  ///
-  /// \param Other is the weak object to compare ordering against.
-  /// \return true if this object precedes \param Other and false otherwise.
-  bool ext_oneapi_owner_before(
-      const ext::oneapi::detail::weak_object_base<context> &Other)
-      const noexcept {
-    return impl.owner_before(ext::oneapi::detail::getSyclWeakObjImpl(Other));
-  }
-
-  /// Compares the context against another context using an owner-based
-  /// implementation-defined ordering.
-  ///
-  /// \param Other is the object to compare ordering against.
-  /// \return true if this object precedes \param Other and false otherwise.
-  bool ext_oneapi_owner_before(const context &Other) const noexcept {
-    return impl.owner_before(Other.impl);
-  }
-
 private:
   /// Constructs a SYCL context object from a valid context_impl instance.
   context(std::shared_ptr<detail::context_impl> Impl);

sycl/include/sycl/detail/owner_less_base.hpp

@@ -0,0 +1,56 @@
+//==-- owner_less_base.hpp --- Common base class for owner-based ordering --==//
+//
+// 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 <sycl/detail/common.hpp>
+#include <sycl/detail/defines_elementary.hpp>
+#include <sycl/ext/oneapi/weak_object_base.hpp>
+
+namespace sycl {
+__SYCL_INLINE_VER_NAMESPACE(_V1) {
+namespace detail {
+
+// Common CRTP base class supplying a common definition of owner-before ordering
+// for SYCL objects.
+template <class SyclObjT> class OwnerLessBase {
+public:
+#ifndef __SYCL_DEVICE_ONLY__
+  /// Compares the object against a weak object using an owner-based
+  /// implementation-defined ordering.
+  ///
+  /// \param Other is the weak object to compare ordering against.
+  /// \return true if this object precedes \param Other and false otherwise.
+  bool ext_oneapi_owner_before(
+      const ext::oneapi::detail::weak_object_base<SyclObjT> &Other)
+      const noexcept {
+    return getSyclObjImpl(*static_cast<const SyclObjT *>(this))
+        .owner_before(ext::oneapi::detail::getSyclWeakObjImpl(Other));
+  }
+
+  /// Compares the object against another object using an owner-based
+  /// implementation-defined ordering.
+  ///
+  /// \param Other is the object to compare ordering against.
+  /// \return true if this object precedes \param Other and false otherwise.
+  bool ext_oneapi_owner_before(const SyclObjT &Other) const noexcept {
+    return getSyclObjImpl(*static_cast<const SyclObjT *>(this))
+        .owner_before(Other.impl);
+  }
+#else
+  bool ext_oneapi_owner_before(
+      const ext::oneapi::detail::weak_object_base<SyclObjT> &Other)
+      const noexcept;
+
+  bool ext_oneapi_owner_before(const SyclObjT &Other) const noexcept;
+#endif
+};
+
+} // namespace detail
+} // __SYCL_INLINE_VER_NAMESPACE(_V1)
+} // namespace sycl

sycl/include/sycl/device.hpp

@@ -14,6 +14,7 @@
 #include <sycl/detail/common.hpp>
 #include <sycl/detail/export.hpp>
 #include <sycl/detail/info_desc_helpers.hpp>
+#include <sycl/detail/owner_less_base.hpp>
 #include <sycl/ext/oneapi/weak_object_base.hpp>
 #include <sycl/info/info_desc.hpp>
 #include <sycl/platform.hpp>
@@ -45,7 +46,7 @@ class filter_selector;
 /// may be executed.
 ///
 /// \ingroup sycl_api
-class __SYCL_EXPORT device {
+class __SYCL_EXPORT device : public detail::OwnerLessBase<device> {
 public:
   /// Constructs a SYCL device instance using the default device.
   device();
@@ -219,26 +220,6 @@ class __SYCL_EXPORT device {
   /// \return true if the SYCL device has the given feature.
   bool has(aspect Aspect) const;
 
-  /// Compares the device against a weak object using an owner-based
-  /// implementation-defined ordering.
-  ///
-  /// \param Other is the weak object to compare ordering against.
-  /// \return true if this object precedes \param Other and false otherwise.
-  bool ext_oneapi_owner_before(
-      const ext::oneapi::detail::weak_object_base<device> &Other)
-      const noexcept {
-    return impl.owner_before(ext::oneapi::detail::getSyclWeakObjImpl(Other));
-  }
-
-  /// Compares the device against another device using an owner-based
-  /// implementation-defined ordering.
-  ///
-  /// \param Other is the object to compare ordering against.
-  /// \return true if this object precedes \param Other and false otherwise.
-  bool ext_oneapi_owner_before(const device &Other) const noexcept {
-    return impl.owner_before(Other.impl);
-  }
-
 private:
   std::shared_ptr<detail::device_impl> impl;
   device(std::shared_ptr<detail::device_impl> impl) : impl(impl) {}

sycl/include/sycl/event.hpp

@@ -13,6 +13,7 @@
 #include <sycl/detail/common.hpp>
 #include <sycl/detail/export.hpp>
 #include <sycl/detail/info_desc_helpers.hpp>
+#include <sycl/detail/owner_less_base.hpp>
 #include <sycl/ext/oneapi/weak_object_base.hpp>
 #include <sycl/info/info_desc.hpp>
 #include <sycl/stl.hpp>
@@ -36,7 +37,7 @@ class event_impl;
 /// kernels and signaling barriers.
 ///
 /// \ingroup sycl_api
-class __SYCL_EXPORT event {
+class __SYCL_EXPORT event : public detail::OwnerLessBase<event> {
 public:
   /// Constructs a ready SYCL event.
   ///
@@ -130,26 +131,6 @@ class __SYCL_EXPORT event {
   /// \return the backend associated with this platform
   backend get_backend() const noexcept;
 
-  /// Compares the event against a weak object using an owner-based
-  /// implementation-defined ordering.
-  ///
-  /// \param Other is the weak object to compare ordering against.
-  /// \return true if this object precedes \param Other and false otherwise.
-  bool ext_oneapi_owner_before(
-      const ext::oneapi::detail::weak_object_base<event> &Other)
-      const noexcept {
-    return impl.owner_before(ext::oneapi::detail::getSyclWeakObjImpl(Other));
-  }
-
-  /// Compares the event against another event using an owner-based
-  /// implementation-defined ordering.
-  ///
-  /// \param Other is the object to compare ordering against.
-  /// \return true if this object precedes \param Other and false otherwise.
-  bool ext_oneapi_owner_before(const event &Other) const noexcept {
-    return impl.owner_before(Other.impl);
-  }
-
 private:
   event(std::shared_ptr<detail::event_impl> EventImpl);
 

sycl/include/sycl/kernel.hpp

@@ -12,6 +12,7 @@
 #include <sycl/detail/common.hpp>
 #include <sycl/detail/export.hpp>
 #include <sycl/detail/info_desc_helpers.hpp>
+#include <sycl/detail/owner_less_base.hpp>
 #include <sycl/detail/pi.h>
 #include <sycl/ext/oneapi/weak_object_base.hpp>
 #include <sycl/info/info_desc.hpp>
@@ -67,7 +68,7 @@ template <typename Type> struct get_kernel_name_t<detail::auto_name, Type> {
 /// \sa queue
 ///
 /// \ingroup sycl_api
-class __SYCL_EXPORT kernel {
+class __SYCL_EXPORT kernel : public detail::OwnerLessBase<kernel> {
 public:
   /// Constructs a SYCL kernel instance from an OpenCL cl_kernel
   ///
@@ -156,26 +157,6 @@ class __SYCL_EXPORT kernel {
   typename detail::is_kernel_device_specific_info_desc<Param>::return_type
       get_info(const device &Device, const range<3> &WGSize) const;
 
-  /// Compares the kernel against a weak object using an owner-based
-  /// implementation-defined ordering.
-  ///
-  /// \param Other is the weak object to compare ordering against.
-  /// \return true if this object precedes \param Other and false otherwise.
-  bool ext_oneapi_owner_before(
-      const ext::oneapi::detail::weak_object_base<kernel> &Other)
-      const noexcept {
-    return impl.owner_before(ext::oneapi::detail::getSyclWeakObjImpl(Other));
-  }
-
-  /// Compares the kernel against another kernel using an owner-based
-  /// implementation-defined ordering.
-  ///
-  /// \param Other is the object to compare ordering against.
-  /// \return true if this object precedes \param Other and false otherwise.
-  bool ext_oneapi_owner_before(const kernel &Other) const noexcept {
-    return impl.owner_before(Other.impl);
-  }
-
 private:
   /// Constructs a SYCL kernel object from a valid kernel_impl instance.
   kernel(std::shared_ptr<detail::kernel_impl> Impl);