context.hpp

Go to the documentation of this file.

//==---------------- context.hpp - SYCL context ----------------------------==//
//
// 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/async_handler.hpp>             // for async_handler
#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/helpers.hpp>            // for context_impl
#include <sycl/detail/info_desc_helpers.hpp>  // for is_context_info_desc
#include <sycl/detail/owner_less_base.hpp>    // for OwnerLessBase
#include <sycl/detail/pi.h>                   // for pi_native_handle
#include <sycl/platform.hpp>                  // for platform
#include <sycl/property_list.hpp>             // for property_list
 
#ifdef __SYCL_INTERNAL_API
#include <sycl/detail/cl.h>
#endif
 
#include <cstddef>     // for size_t
#include <memory>      // for shared_ptr, hash, opera...
#include <type_traits> // for add_pointer_t
#include <variant>     // for hash
#include <vector>      // for vector
 
// 4.6.2 Context class
 
namespace sycl {
inline namespace _V1 {
// Forward declarations
class device;
class platform;
 
namespace detail {
class context_impl;
}
template <backend Backend, class SyclT>
auto get_native(const SyclT &Obj) -> backend_return_t<Backend, SyclT>;
 
class __SYCL_EXPORT context : public detail::OwnerLessBase<context> {
public:
  explicit context(const property_list &PropList = {});
 
  explicit context(const async_handler &AsyncHandler,
                   const property_list &PropList = {});
 
  explicit context(const device &Device, const property_list &PropList = {});
 
  explicit context(const device &Device, async_handler AsyncHandler,
                   const property_list &PropList = {});
 
  explicit context(const platform &Platform,
                   const property_list &PropList = {});
 
  explicit context(const platform &Platform, async_handler AsyncHandler,
                   const property_list &PropList = {});
 
  explicit context(const std::vector<device> &DeviceList,
                   const property_list &PropList = {});
 
  explicit context(const std::vector<device> &DeviceList,
                   async_handler AsyncHandler,
                   const property_list &PropList = {});
 
#ifdef __SYCL_INTERNAL_API
  context(cl_context ClContext, async_handler AsyncHandler = {});
#endif
 
  template <typename Param>
  typename detail::is_context_info_desc<Param>::return_type get_info() const;
 
  template <typename Param>
  typename detail::is_backend_info_desc<Param>::return_type
  get_backend_info() const;
 
  context(const context &rhs) = default;
 
  context(context &&rhs) = default;
 
  context &operator=(const context &rhs) = default;
 
  context &operator=(context &&rhs) = default;
 
  bool operator==(const context &rhs) const { return impl == rhs.impl; }
 
  bool operator!=(const context &rhs) const { return !(*this == rhs); }
 
  template <typename propertyT> bool has_property() const noexcept {
    return getPropList().template has_property<propertyT>();
  }
 
  template <typename propertyT> propertyT get_property() const {
    return getPropList().template get_property<propertyT>();
  }
 
#ifdef __SYCL_INTERNAL_API
  cl_context get() const;
#endif
 
  backend get_backend() const noexcept;
 
  platform get_platform() const;
 
  std::vector<device> get_devices() const;
 
private:
  context(std::shared_ptr<detail::context_impl> Impl);
 
  pi_native_handle getNative() const;
 
  std::shared_ptr<detail::context_impl> impl;
 
  template <backend Backend, class SyclT>
  friend auto get_native(const SyclT &Obj) -> backend_return_t<Backend, SyclT>;
 
  template <class Obj>
  friend const decltype(Obj::impl) &
  detail::getSyclObjImpl(const Obj &SyclObject);
 
  template <class T>
  friend T detail::createSyclObjFromImpl(decltype(T::impl) ImplObj);
 
  const property_list &getPropList() const;
};
 
// context.hpp depends on exception.hpp but we can't define these ctors in
// exception.hpp while context is still an incomplete type.
inline exception::exception(context Ctx, std::error_code EC,
                            const std::string &WhatArg)
    : exception(EC, std::make_shared<context>(Ctx), WhatArg) {}
 
inline exception::exception(context Ctx, std::error_code EC,
                            const char *WhatArg)
    : exception(Ctx, EC, std::string(WhatArg)) {}
 
inline exception::exception(context Ctx, std::error_code EC)
    : exception(Ctx, EC, "") {}
 
inline exception::exception(context Ctx, int EV,
                            const std::error_category &ECat,
                            const char *WhatArg)
    : exception(Ctx, {EV, ECat}, std::string(WhatArg)) {}
 
inline exception::exception(context Ctx, int EV,
                            const std::error_category &ECat,
                            const std::string &WhatArg)
    : exception(Ctx, {EV, ECat}, WhatArg) {}
 
inline exception::exception(context Ctx, int EV,
                            const std::error_category &ECat)
    : exception(Ctx, EV, ECat, "") {}
 
} // namespace _V1
} // namespace sycl
 
namespace std {
template <> struct hash<sycl::context> {
  size_t operator()(const sycl::context &Context) const {
    return hash<std::shared_ptr<sycl::detail::context_impl>>()(
        sycl::detail::getSyclObjImpl(Context));
  }
};
} // namespace std