platform.hpp

Go to the documentation of this file.

//==---------------- platform.hpp - SYCL platform --------------------------==//
//
// 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/aspects.hpp>
#include <sycl/backend_types.hpp>
#include <sycl/context.hpp>
#include <sycl/detail/defines_elementary.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/detail/string.hpp>
#include <sycl/detail/string_view.hpp>
#include <sycl/detail/util.hpp>
#include <sycl/device_selector.hpp>
#include <sycl/info/info_desc.hpp>
 
#ifdef __SYCL_INTERNAL_API
#include <sycl/detail/cl.h>
#endif
 
#include <cstddef>
#include <memory>
#include <string>
#include <variant>
#include <vector>
 
namespace sycl {
inline namespace _V1 {
// TODO: make code thread-safe
 
// Forward declaration
class device;
class context;
 
template <backend BackendName, class SyclObjectT>
auto get_native(const SyclObjectT &Obj)
    -> backend_return_t<BackendName, SyclObjectT>;
namespace detail {
class platform_impl;
 
void __SYCL_EXPORT enable_ext_oneapi_default_context(bool Val);
 
template <typename ParamT> auto convert_to_abi_neutral(ParamT &&Info) {
  using ParamNoRef = std::remove_reference_t<ParamT>;
  if constexpr (std::is_same_v<ParamNoRef, std::string>) {
    return detail::string{Info};
  } else if constexpr (std::is_same_v<ParamNoRef, std::vector<std::string>>) {
    std::vector<detail::string> Res;
    Res.reserve(Info.size());
    for (std::string &Str : Info) {
      Res.push_back(detail::string{Str});
    }
    return Res;
  } else {
    return std::forward<ParamT>(Info);
  }
}
 
template <typename ParamT> auto convert_from_abi_neutral(ParamT &&Info) {
  using ParamNoRef = std::remove_reference_t<ParamT>;
  if constexpr (std::is_same_v<ParamNoRef, detail::string>) {
    return Info.c_str();
  } else if constexpr (std::is_same_v<ParamNoRef,
                                      std::vector<detail::string>>) {
    std::vector<std::string> Res;
    Res.reserve(Info.size());
    for (detail::string &Str : Info) {
      Res.push_back(Str.c_str());
    }
    return Res;
  } else {
    return std::forward<ParamT>(Info);
  }
}
} // namespace detail
namespace ext::oneapi {
// Forward declaration
class filter_selector;
} // namespace ext::oneapi
 
class __SYCL_EXPORT platform : public detail::OwnerLessBase<platform> {
public:
  platform();
 
#ifdef __SYCL_INTERNAL_API
  explicit platform(cl_platform_id PlatformId);
#endif
 
  __SYCL2020_DEPRECATED("SYCL 1.2.1 device selectors are deprecated. Please "
                        "use SYCL 2020 device selectors instead.")
  explicit platform(const device_selector &DeviceSelector);
 
  template <typename DeviceSelector,
            typename =
                detail::EnableIfSYCL2020DeviceSelectorInvocable<DeviceSelector>>
  explicit platform(const DeviceSelector &deviceSelector)
      : platform(detail::select_device(deviceSelector)) {}
 
  platform(const platform &rhs) = default;
 
  platform(platform &&rhs) = default;
 
  platform &operator=(const platform &rhs) = default;
 
  platform &operator=(platform &&rhs) = default;
 
  bool operator==(const platform &rhs) const { return impl == rhs.impl; }
 
  bool operator!=(const platform &rhs) const { return !(*this == rhs); }
 
#ifdef __SYCL_INTERNAL_API
  cl_platform_id get() const;
#endif
 
  __SYCL2020_DEPRECATED(
      "use platform::has() function with aspects APIs instead")
  bool has_extension(const std::string &ExtensionName) const;
 
  __SYCL2020_DEPRECATED(
      "is_host() is deprecated as the host device is no longer supported.")
  bool is_host() const;
 
  std::vector<device>
  get_devices(info::device_type DeviceType = info::device_type::all) const;
 
  template <typename Param>
  typename detail::is_platform_info_desc<Param>::return_type get_info() const {
    return detail::convert_from_abi_neutral(get_info_impl<Param>());
  }
 
  template <typename Param>
  typename detail::is_backend_info_desc<Param>::return_type
  get_backend_info() const;
 
  static std::vector<platform> get_platforms();
 
  backend get_backend() const noexcept;
 
// Clang may warn about the use of diagnose_if in __SYCL_WARN_IMAGE_ASPECT, so
// we disable that warning as we make appropriate checks to ensure its
// existence.
// TODO: Remove this diagnostics when __SYCL_WARN_IMAGE_ASPECT is removed.
#if defined(__clang__)
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wgcc-compat"
#endif // defined(__clang__)
 
  bool has(aspect Aspect) const __SYCL_WARN_IMAGE_ASPECT(Aspect);
 
// TODO: Remove this diagnostics when __SYCL_WARN_IMAGE_ASPECT is removed.
#if defined(__clang__)
#pragma clang diagnostic pop
#endif // defined(__clang__)
 
  context ext_oneapi_get_default_context() const;
 
  std::vector<device> ext_oneapi_get_composite_devices() const;
 
private:
  pi_native_handle getNative() const;
 
  std::shared_ptr<detail::platform_impl> impl;
  platform(std::shared_ptr<detail::platform_impl> impl) : impl(impl) {}
 
  platform(const device &Device);
 
  template <class T>
  friend T detail::createSyclObjFromImpl(decltype(T::impl) ImplObj);
  template <class Obj>
  friend decltype(Obj::impl) detail::getSyclObjImpl(const Obj &SyclObject);
 
  template <backend BackendName, class SyclObjectT>
  friend auto get_native(const SyclObjectT &Obj)
      -> backend_return_t<BackendName, SyclObjectT>;
 
  template <typename Param>
  typename detail::ABINeutralT_t<
      typename detail::is_platform_info_desc<Param>::return_type>
  get_info_impl() const;
}; // class platform
} // namespace _V1
} // namespace sycl
 
namespace std {
template <> struct hash<sycl::platform> {
  size_t operator()(const sycl::platform &p) const {
    return hash<std::shared_ptr<sycl::detail::platform_impl>>()(
        sycl::detail::getSyclObjImpl(p));
  }
};
} // namespace std