#include <detail/context_impl.hpp>
Public Types | |
enum | PropertySupport { NotSupported = 0 , Supported = 1 , NotChecked = 2 } |
using | CachedLibProgramsT = std::map< std::pair< DeviceLibExt, sycl::detail::pi::PiDevice >, sycl::detail::pi::PiProgram > |
Public Member Functions | |
context_impl (const device &Device, async_handler AsyncHandler, const property_list &PropList) | |
Constructs a context_impl using a single SYCL devices. More... | |
context_impl (const std::vector< sycl::device > DeviceList, async_handler AsyncHandler, const property_list &PropList) | |
Constructs a context_impl using a list of SYCL devices. More... | |
context_impl (sycl::detail::pi::PiContext PiContext, async_handler AsyncHandler, const PluginPtr &Plugin, const std::vector< sycl::device > &DeviceList={}, bool OwnedByRuntime=true) | |
Construct a context_impl using plug-in interoperability handle. More... | |
~context_impl () | |
template<typename propertyT > | |
bool | has_property () const noexcept |
Checks if this context_impl has a property of type propertyT. More... | |
template<typename propertyT > | |
propertyT | get_property () const |
Gets the specified property of this context_impl. More... | |
cl_context | get () const |
Gets OpenCL interoperability context handle. More... | |
bool | is_host () const |
Checks if this context is a host context. More... | |
const async_handler & | get_async_handler () const |
Gets asynchronous exception handler. More... | |
const PluginPtr & | getPlugin () const |
PlatformImplPtr | getPlatformImpl () const |
template<typename Param > | |
Param::return_type | get_info () const |
Queries this context for information. More... | |
template<typename Param > | |
Param::return_type | get_backend_info () const |
Queries SYCL queue for SYCL backend-specific information. More... | |
sycl::detail::pi::PiContext & | getHandleRef () |
Gets the underlying context object (if any) without reference count modification. More... | |
const sycl::detail::pi::PiContext & | getHandleRef () const |
Gets the underlying context object (if any) without reference count modification. More... | |
const std::vector< device > & | getDevices () const |
Unlike ‘get_info<info::context::devices>’, this function returns a reference. More... | |
Locked< CachedLibProgramsT > | acquireCachedLibPrograms () |
In contrast to user programs, which are compiled from user code, library programs come from the SYCL runtime. More... | |
KernelProgramCache & | getKernelProgramCache () const |
bool | hasDevice (std::shared_ptr< detail::device_impl > Device) const |
Returns true if and only if context contains the given device. More... | |
bool | isDeviceValid (DeviceImplPtr Device) |
Returns true if and only if the device can be used within this context. More... | |
backend | getBackend () const |
DeviceImplPtr | findMatchingDeviceImpl (sycl::detail::pi::PiDevice &DevicePI) const |
Given a PiDevice, returns the matching shared_ptr<device_impl> within this context. More... | |
pi_native_handle | getNative () const |
Gets the native handle of the SYCL context. More... | |
bool | isBufferLocationSupported () const |
void | addAssociatedDeviceGlobal (const void *DeviceGlobalPtr) |
Adds an associated device global to the tracked associates. More... | |
void | addDeviceGlobalInitializer (sycl::detail::pi::PiProgram Program, const std::vector< device > &Devs, const RTDeviceBinaryImage *BinImage) |
Adds a device global initializer. More... | |
std::vector< sycl::detail::pi::PiEvent > | initializeDeviceGlobals (pi::PiProgram NativePrg, const std::shared_ptr< queue_impl > &QueueImpl) |
Initializes device globals for a program on the associated queue. More... | |
void | memcpyToHostOnlyDeviceGlobal (const std::shared_ptr< device_impl > &DeviceImpl, const void *DeviceGlobalPtr, const void *Src, size_t DeviceGlobalTSize, bool IsDeviceImageScoped, size_t NumBytes, size_t Offset) |
void | memcpyFromHostOnlyDeviceGlobal (const std::shared_ptr< device_impl > &DeviceImpl, void *Dest, const void *DeviceGlobalPtr, bool IsDeviceImageScoped, size_t NumBytes, size_t Offset) |
std::optional< sycl::detail::pi::PiProgram > | getProgramForDeviceGlobal (const device &Device, DeviceGlobalMapEntry *DeviceGlobalEntry) |
Gets a program associated with a device global from the cache. More... | |
std::optional< sycl::detail::pi::PiProgram > | getProgramForHostPipe (const device &Device, HostPipeMapEntry *HostPipeEntry) |
Gets a program associated with a HostPipe Entry from the cache. More... | |
std::optional< sycl::detail::pi::PiProgram > | getProgramForDevImgs (const device &Device, const std::set< std::uintptr_t > &ImgIdentifiers, const std::string &ObjectTypeName) |
Gets a program associated with Dev / Images pairs. More... | |
bool | isOwnedByRuntime () |
Definition at line 32 of file context_impl.hpp.
using sycl::_V1::detail::context_impl::CachedLibProgramsT = std::map<std::pair<DeviceLibExt, sycl::detail::pi::PiDevice>, sycl::detail::pi::PiProgram> |
Definition at line 151 of file context_impl.hpp.
Enumerator | |
---|---|
NotSupported | |
Supported | |
NotChecked |
Definition at line 266 of file context_impl.hpp.
sycl::_V1::detail::context_impl::context_impl | ( | const device & | Device, |
async_handler | AsyncHandler, | ||
const property_list & | PropList | ||
) |
Constructs a context_impl using a single SYCL devices.
The constructed context_impl will use the AsyncHandler parameter to handle exceptions. PropList carries the properties of the constructed context_impl.
Device | is an instance of SYCL device. |
AsyncHandler | is an instance of async_handler. |
PropList | is an instance of property_list. |
Definition at line 31 of file context_impl.cpp.
References sycl::_V1::detail::KernelProgramCache::setContextPtr().
sycl::_V1::detail::context_impl::context_impl | ( | const std::vector< sycl::device > | DeviceList, |
async_handler | AsyncHandler, | ||
const property_list & | PropList | ||
) |
Constructs a context_impl using a list of SYCL devices.
Newly created instance will save each SYCL device in the list. This requres that all devices in the list are associated with the same SYCL platform. The constructed context_impl will use the AsyncHandler parameter to handle exceptions. PropList carries the properties of the constructed context_impl.
DeviceList | is a list of SYCL device instances. |
AsyncHandler | is an instance of async_handler. |
PropList | is an instance of property_list. |
Definition at line 42 of file context_impl.cpp.
References __SYCL_PI_CONTEXT_PROPERTIES_CUDA_PRIMARY, sycl::_V1::ext_oneapi_cuda, getBackend(), getPlugin(), sycl::_V1::detail::getSyclObjImpl(), sycl::_V1::property_list::has_property(), piContextCreate(), and sycl::_V1::detail::KernelProgramCache::setContextPtr().
sycl::_V1::detail::context_impl::context_impl | ( | sycl::detail::pi::PiContext | PiContext, |
async_handler | AsyncHandler, | ||
const PluginPtr & | Plugin, | ||
const std::vector< sycl::device > & | DeviceList = {} , |
||
bool | OwnedByRuntime = true |
||
) |
Construct a context_impl using plug-in interoperability handle.
The constructed context_impl will use the AsyncHandler parameter to handle exceptions.
PiContext | is an instance of a valid plug-in context handle. |
AsyncHandler | is an instance of async_handler. |
Plugin | is the reference to the underlying Plugin that this |
OwnedByRuntime | is the flag if ownership is kept by user or transferred to runtime |
Definition at line 85 of file context_impl.cpp.
References getBackend(), sycl::_V1::detail::platform_impl::getPlatformFromPiDevice(), getPlugin(), sycl::_V1::detail::getSyclObjImpl(), PI_CONTEXT_INFO_DEVICES, PI_CONTEXT_INFO_NUM_DEVICES, piContextGetInfo(), piContextRetain(), and sycl::_V1::detail::KernelProgramCache::setContextPtr().
sycl::_V1::detail::context_impl::~context_impl | ( | ) |
|
inline |
In contrast to user programs, which are compiled from user code, library programs come from the SYCL runtime.
They are identified by the corresponding extension:
cl_intel_devicelib_assert -> #<pi_program with assert functions> cl_intel_devicelib_complex -> #<pi_program with complex functions> etc.
See ‘doc/design/DeviceLibExtensions.rst’ for more details.
Definition at line 168 of file context_impl.hpp.
void sycl::_V1::detail::context_impl::addAssociatedDeviceGlobal | ( | const void * | DeviceGlobalPtr | ) |
Adds an associated device global to the tracked associates.
Definition at line 351 of file context_impl.cpp.
void sycl::_V1::detail::context_impl::addDeviceGlobalInitializer | ( | sycl::detail::pi::PiProgram | Program, |
const std::vector< device > & | Devs, | ||
const RTDeviceBinaryImage * | BinImage | ||
) |
Adds a device global initializer.
Definition at line 356 of file context_impl.cpp.
References getHandleRef(), and sycl::_V1::detail::getSyclObjImpl().
DeviceImplPtr sycl::_V1::detail::context_impl::findMatchingDeviceImpl | ( | sycl::detail::pi::PiDevice & | DevicePI | ) | const |
Given a PiDevice, returns the matching shared_ptr<device_impl> within this context.
May return nullptr if no match discovered.
Definition at line 319 of file context_impl.cpp.
References getHandleRef(), and sycl::_V1::detail::getSyclObjImpl().
cl_context sycl::_V1::detail::context_impl::get | ( | ) | const |
Gets OpenCL interoperability context handle.
Definition at line 134 of file context_impl.cpp.
References getPlugin(), and piContextRetain().
const async_handler & sycl::_V1::detail::context_impl::get_async_handler | ( | ) | const |
Gets asynchronous exception handler.
Definition at line 168 of file context_impl.cpp.
Param::return_type sycl::_V1::detail::context_impl::get_backend_info | ( | ) | const |
Queries SYCL queue for SYCL backend-specific information.
The return type depends on information being queried.
Param::return_type sycl::_V1::detail::context_impl::get_info | ( | ) | const |
Queries this context for information.
The return type depends on information being queried.
|
inline |
Gets the specified property of this context_impl.
Throws invalid_object_error if this context_impl does not have a property of type propertyT.
Definition at line 91 of file context_impl.hpp.
References sycl::_V1::property_list::get_property().
|
inline |
Definition at line 208 of file context_impl.hpp.
Referenced by context_impl(), and getNative().
|
inline |
Unlike ‘get_info<info::context::devices>’, this function returns a reference.
Definition at line 149 of file context_impl.hpp.
Referenced by sycl::_V1::detail::DeviceGlobalMapEntry::removeAssociatedResources().
sycl::detail::pi::PiContext & sycl::_V1::detail::context_impl::getHandleRef | ( | ) |
Gets the underlying context object (if any) without reference count modification.
Caller must ensure the returned object lives on stack only. It can also be safely passed to the underlying native runtime API. Warning. Returned reference will be invalid if context_impl was destroyed.
Definition at line 302 of file context_impl.cpp.
Referenced by addDeviceGlobalInitializer(), sycl::_V1::detail::usm::alignedAllocInternal(), findMatchingDeviceImpl(), sycl::_V1::detail::usm::freeInternal(), and getNative().
const sycl::detail::pi::PiContext & sycl::_V1::detail::context_impl::getHandleRef | ( | ) | const |
Gets the underlying context object (if any) without reference count modification.
Caller must ensure the returned object lives on stack only. It can also be safely passed to the underlying native runtime API. Warning. Returned reference will be invalid if context_impl was destroyed.
Definition at line 303 of file context_impl.cpp.
KernelProgramCache & sycl::_V1::detail::context_impl::getKernelProgramCache | ( | ) | const |
Definition at line 307 of file context_impl.cpp.
pi_native_handle sycl::_V1::detail::context_impl::getNative | ( | ) | const |
Gets the native handle of the SYCL context.
Definition at line 328 of file context_impl.cpp.
References getBackend(), getHandleRef(), getPlugin(), sycl::_V1::opencl, piContextRetain(), and piextContextGetNativeHandle().
|
inline |
Definition at line 114 of file context_impl.hpp.
|
inline |
Definition at line 111 of file context_impl.hpp.
Referenced by sycl::_V1::detail::usm::alignedAllocInternal(), context_impl(), sycl::_V1::detail::usm::freeInternal(), get(), getNative(), initializeDeviceGlobals(), sycl::_V1::detail::DeviceGlobalMapEntry::removeAssociatedResources(), and ~context_impl().
std::optional< sycl::detail::pi::PiProgram > sycl::_V1::detail::context_impl::getProgramForDeviceGlobal | ( | const device & | Device, |
DeviceGlobalMapEntry * | DeviceGlobalEntry | ||
) |
Gets a program associated with a device global from the cache.
Definition at line 556 of file context_impl.cpp.
References getProgramForDevImgs(), and sycl::_V1::detail::DeviceGlobalMapEntry::MImageIdentifiers.
std::optional< sycl::detail::pi::PiProgram > sycl::_V1::detail::context_impl::getProgramForDevImgs | ( | const device & | Device, |
const std::set< std::uintptr_t > & | ImgIdentifiers, | ||
const std::string & | ObjectTypeName | ||
) |
Gets a program associated with Dev / Images pairs.
Definition at line 513 of file context_impl.cpp.
References sycl::_V1::detail::KernelProgramCache::acquireCachedPrograms(), sycl::_V1::detail::getSyclObjImpl(), sycl::_V1::invalid, and sycl::_V1::make_error_code().
Referenced by getProgramForDeviceGlobal(), and getProgramForHostPipe().
std::optional< sycl::detail::pi::PiProgram > sycl::_V1::detail::context_impl::getProgramForHostPipe | ( | const device & | Device, |
HostPipeMapEntry * | HostPipeEntry | ||
) |
Gets a program associated with a HostPipe Entry from the cache.
Definition at line 563 of file context_impl.cpp.
References sycl::_V1::detail::HostPipeMapEntry::getDevBinImage(), sycl::_V1::detail::RTDeviceBinaryImage::getImageID(), and getProgramForDevImgs().
|
inlinenoexcept |
Checks if this context_impl has a property of type propertyT.
Definition at line 81 of file context_impl.hpp.
References sycl::_V1::property_list::has_property().
bool sycl::_V1::detail::context_impl::hasDevice | ( | std::shared_ptr< detail::device_impl > | Device | ) | const |
Returns true if and only if context contains the given device.
Definition at line 311 of file context_impl.cpp.
References sycl::_V1::detail::getSyclObjImpl().
Referenced by isDeviceValid().
std::vector< sycl::detail::pi::PiEvent > sycl::_V1::detail::context_impl::initializeDeviceGlobals | ( | pi::PiProgram | NativePrg, |
const std::shared_ptr< queue_impl > & | QueueImpl | ||
) |
Initializes device globals for a program on the associated queue.
Definition at line 366 of file context_impl.cpp.
References sycl::_V1::detail::ProgramManager::getDeviceGlobalEntries(), sycl::_V1::detail::DeviceGlobalUSMMem::getInitEvent(), sycl::_V1::detail::ProgramManager::getInstance(), getPlugin(), sycl::_V1::detail::DeviceGlobalUSMMem::getPtr(), piEventRelease(), and piextEnqueueDeviceGlobalVariableWrite().
bool sycl::_V1::detail::context_impl::is_host | ( | ) | const |
Checks if this context is a host context.
Definition at line 145 of file context_impl.cpp.
Referenced by sycl::_V1::detail::usm::alignedAllocInternal(), sycl::_V1::detail::usm::freeInternal(), and isDeviceValid().
bool sycl::_V1::detail::context_impl::isBufferLocationSupported | ( | ) | const |
Definition at line 337 of file context_impl.cpp.
References NotChecked, NotSupported, and Supported.
|
inline |
Returns true if and only if the device can be used within this context.
For OpenCL this is currently equivalent to hasDevice, for other backends it returns true if the device is either a member of the context or a descendant of a member.
Definition at line 181 of file context_impl.hpp.
References sycl::_V1::detail::getSyclObjImpl(), hasDevice(), is_host(), and sycl::_V1::opencl.
|
inline |
Definition at line 264 of file context_impl.hpp.
void sycl::_V1::detail::context_impl::memcpyFromHostOnlyDeviceGlobal | ( | const std::shared_ptr< device_impl > & | DeviceImpl, |
void * | Dest, | ||
const void * | DeviceGlobalPtr, | ||
bool | IsDeviceImageScoped, | ||
size_t | NumBytes, | ||
size_t | Offset | ||
) |
Definition at line 489 of file context_impl.cpp.
References sycl::_V1::ext::oneapi::experimental::fill().
void sycl::_V1::detail::context_impl::memcpyToHostOnlyDeviceGlobal | ( | const std::shared_ptr< device_impl > & | DeviceImpl, |
const void * | DeviceGlobalPtr, | ||
const void * | Src, | ||
size_t | DeviceGlobalTSize, | ||
bool | IsDeviceImageScoped, | ||
size_t | NumBytes, | ||
size_t | Offset | ||
) |
Definition at line 467 of file context_impl.cpp.