owner_less_base.hpp

Go to the documentation of this file.

//==-- 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/impl_utils.hpp>           // for getSyclObjImpl
#include <sycl/ext/oneapi/weak_object_base.hpp> // for getSyclWeakObjImpl
 
namespace sycl {
inline 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__
  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));
  }
 
  bool ext_oneapi_owner_before(const SyclObjT &Other) const noexcept {
    return getSyclObjImpl(*static_cast<const SyclObjT *>(this))
        .owner_before(getSyclObjImpl(Other));
  }
#else
  // On device calls to these functions are disallowed, so declare them but
  // don't define them to avoid compilation failures.
  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
} // namespace _V1
} // namespace sycl