ur.hpp

Go to the documentation of this file.

//==---------- ur.hpp - Unified Runtime integration helpers ----------------==//
//
// 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>
#include <sycl/detail/export.hpp>
#include <sycl/detail/os_util.hpp>
#include <ur_api.h>
 
#include <memory>
#include <type_traits>
#include <vector>
 
#define UR_DEVICE_INFO_EXTENSION_DEVICELIB_ASSERT "cl_intel_devicelib_assert"
 
typedef void (*pi_context_extended_deleter)(void *user_data);
 
struct _sycl_device_binary_property_struct;
using sycl_device_binary_property = _sycl_device_binary_property_struct*;
 
#ifdef XPTI_ENABLE_INSTRUMENTATION
// Forward declarations
namespace xpti {
struct trace_event_data_t;
}
#endif
 
namespace sycl {
inline namespace _V1 {
 
class context;
 
namespace detail {
 
enum class UrApiKind {
#define _UR_API(api) api,
#include <ur_api_funcs.def>
#undef _UR_API
};
 
struct UrFuncPtrMapT {
#define _UR_API(api) decltype(&::api) pfn_##api = nullptr;
#include <ur_api_funcs.def>
#undef _UR_API
};
 
template <UrApiKind UrApiOffset> struct UrFuncInfo {};
 
#ifdef _WIN32
void *GetWinProcAddress(void *module, const char *funcName);
inline void PopulateUrFuncPtrTable(UrFuncPtrMapT *funcs, void *module) {
#define _UR_API(api)                                                           \
  funcs->pfn_##api = (decltype(&::api))GetWinProcAddress(module, #api);
#include <ur_api_funcs.def>
#undef _UR_API
}
 
#define _UR_API(api)                                                           \
  template <> struct UrFuncInfo<UrApiKind::api> {                              \
    using FuncPtrT = decltype(&::api);                                         \
    inline const char *getFuncName() { return #api; }                          \
    inline FuncPtrT getFuncPtr(const UrFuncPtrMapT *funcs) {                   \
      return funcs->pfn_##api;                                                 \
    }                                                                          \
    inline FuncPtrT getFuncPtrFromModule(void *module) {                       \
      return (FuncPtrT)GetWinProcAddress(module, #api);                        \
    }                                                                          \
  };
#include <ur_api_funcs.def>
#undef _UR_API
#else
#define _UR_API(api)                                                           \
  template <> struct UrFuncInfo<UrApiKind::api> {                              \
    using FuncPtrT = decltype(&::api);                                         \
    inline const char *getFuncName() { return #api; }                          \
    constexpr inline FuncPtrT getFuncPtr(const void *) { return &api; }        \
    constexpr inline FuncPtrT getFuncPtrFromModule(void *) { return &api; }    \
  };
#include <ur_api_funcs.def>
#undef _UR_API
#endif
 
namespace pi {
// This function is deprecated and it should be removed in the next release
// cycle (along with the definition for pi_context_extended_deleter).
__SYCL_EXPORT void contextSetExtendedDeleter(const sycl::context &constext,
                                             pi_context_extended_deleter func,
                                             void *user_data);
}
 
class plugin;
using PluginPtr = std::shared_ptr<plugin>;
 
// TODO: To be removed as this was only introduced for esimd which was removed.
template <sycl::backend BE>
__SYCL_EXPORT void *getPluginOpaqueData(void *opaquedata_arg);
 
namespace ur {
// Function to load a shared library
// Implementation is OS dependent
void *loadOsLibrary(const std::string &Library);
 
// Function to unload a shared library
// Implementation is OS dependent (see posix-ur.cpp and windows-ur.cpp)
int unloadOsLibrary(void *Library);
 
// Function to get Address of a symbol defined in the shared
// library, implementation is OS dependent.
void *getOsLibraryFuncAddress(void *Library, const std::string &FunctionName);
 
void *getURLoaderLibrary();
 
// Performs UR one-time initialization.
std::vector<PluginPtr> &
initializeUr(ur_loader_config_handle_t LoaderConfig = nullptr);
 
// Get the plugin serving given backend.
template <backend BE> const PluginPtr &getPlugin();
 
// The SYCL_UR_TRACE sets what we will trace.
// This is a bit-mask of various things we'd want to trace.
enum TraceLevel { TRACE_BASIC = 0x1, TRACE_CALLS = 0x2, TRACE_ALL = -1 };
 
// Return true if we want to trace UR related activities.
bool trace(TraceLevel level);
 
// Want all the needed casts be explicit, do not define conversion operators.
template <class To, class From> To cast(From value);
 
// Want all the needed casts be explicit, do not define conversion
// operators.
template <class To, class From> inline To cast(From value) {
  // TODO: see if more sanity checks are possible.
  static_assert(sizeof(From) == sizeof(To), "assert: cast failed size check");
  return reinterpret_cast<To>(value);
}
 
// Helper traits for identifying std::vector with arbitrary element type.
template <typename T> struct IsStdVector : std::false_type {};
template <typename T> struct IsStdVector<std::vector<T>> : std::true_type {};
 
// Overload for vectors that applies the cast to all elements. This
// creates a new vector.
template <class To, class FromE> To cast(std::vector<FromE> Values) {
  static_assert(IsStdVector<To>::value, "Return type must be a vector.");
  To ResultVec;
  ResultVec.reserve(Values.size());
  for (FromE &Val : Values) {
    ResultVec.push_back(cast<typename To::value_type>(Val));
  }
  return ResultVec;
}
 
ur_program_metadata_t mapDeviceBinaryPropertyToProgramMetadata(
    const sycl_device_binary_property &DeviceBinaryProperty);
 
} // namespace ur
} // namespace detail
} // namespace _V1
} // namespace sycl