event.hpp

Go to the documentation of this file.

//==---------------- event.hpp --- SYCL event ------------------------------==//
//
// 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/backend_types.hpp>             // for backend, backend_return_t
#include <sycl/detail/defines_elementary.hpp> // for __SYCL2020_DEPRECATED
#include <sycl/detail/export.hpp>             // for __SYCL_EXPORT
#include <sycl/detail/info_desc_helpers.hpp>  // for is_event_info_desc, is_...
#include <sycl/detail/owner_less_base.hpp>    // for OwnerLessBase
#include <sycl/detail/pi.h>                   // for pi_native_handle
 
#ifdef __SYCL_INTERNAL_API
#include <sycl/detail/cl.h>
#endif
 
#include <cstddef> // for size_t
#include <memory>  // for shared_ptr, hash
#include <variant> // for hash
#include <vector>  // for vector
 
namespace sycl {
inline namespace _V1 {
// Forward declaration
class context;
 
template <backend BackendName, class SyclObjectT>
auto get_native(const SyclObjectT &Obj)
    -> backend_return_t<BackendName, SyclObjectT>;
 
namespace detail {
class event_impl;
}
 
class __SYCL_EXPORT event : public detail::OwnerLessBase<event> {
public:
  event();
 
#ifdef __SYCL_INTERNAL_API
  event(cl_event ClEvent, const context &SyclContext);
#endif
 
  event(const event &rhs) = default;
 
  event(event &&rhs) = default;
 
  event &operator=(const event &rhs) = default;
 
  event &operator=(event &&rhs) = default;
 
  bool operator==(const event &rhs) const;
 
  bool operator!=(const event &rhs) const;
 
  __SYCL2020_DEPRECATED(
      "is_host() is deprecated as the host device is no longer supported.")
  bool is_host() const;
 
  std::vector<event> get_wait_list();
 
  void wait();
 
  static void wait(const std::vector<event> &EventList);
 
  void wait_and_throw();
 
  static void wait_and_throw(const std::vector<event> &EventList);
 
  template <typename Param>
  typename detail::is_event_info_desc<Param>::return_type get_info() const;
 
  template <typename Param>
  typename detail::is_backend_info_desc<Param>::return_type
  get_backend_info() const;
 
  template <typename Param>
  typename detail::is_event_profiling_info_desc<Param>::return_type
  get_profiling_info() const;
 
  backend get_backend() const noexcept;
 
private:
  event(std::shared_ptr<detail::event_impl> EventImpl);
 
  pi_native_handle getNative() const;
 
  std::vector<pi_native_handle> getNativeVector() const;
 
  std::shared_ptr<detail::event_impl> impl;
 
  template <class Obj>
  friend decltype(Obj::impl) detail::getSyclObjImpl(const Obj &SyclObject);
 
  template <class T>
  friend T detail::createSyclObjFromImpl(decltype(T::impl) ImplObj);
 
  template <backend BackendName, class SyclObjectT>
  friend auto get_native(const SyclObjectT &Obj)
      -> backend_return_t<BackendName, SyclObjectT>;
};
 
} // namespace _V1
} // namespace sycl
 
namespace std {
template <> struct hash<sycl::event> {
  size_t operator()(const sycl::event &e) const {
    return hash<std::shared_ptr<sycl::detail::event_impl>>()(
        sycl::detail::getSyclObjImpl(e));
  }
};
} // namespace std