#include <detail/context_impl.hpp>

Public Types
enum	PropertySupport { NotSupported = 0, Supported = 1, NotChecked = 2 }

using	CachedLibProgramsT = std::map< std::pair< DeviceLibExt, RT::PiDevice >, RT::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 (RT::PiContext PiContext, async_handler AsyncHandler, const plugin &Plugin)
	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 plugin &	getPlugin () const

PlatformImplPtr	getPlatformImpl () const

template<typename Param >
Param::return_type	get_info () const
	Queries this context for information. More...

RT::PiContext &	getHandleRef ()
	Gets the underlying context object (if any) without reference count modification. More...

const RT::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...

DeviceImplPtr	findMatchingDeviceImpl (RT::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 (RT::PiProgram Program, const std::vector< device > &Devs, const RTDeviceBinaryImage *BinImage)
	Adds a device global initializer. More...

std::vector< RT::PiEvent >	initializeDeviceGlobals (pi::PiProgram NativePrg, const std::shared_ptr< queue_impl > &QueueImpl)
	Initializes device globals for a program on the associated queue. More...

std::optional< RT::PiProgram >	getProgramForDeviceGlobal (const device &Device, DeviceGlobalMapEntry *DeviceGlobalEntry)
	Gets a program associated with a device global from the cache. More...

Detailed Description

Definition at line 33 of file context_impl.hpp.

Member Typedef Documentation

◆ CachedLibProgramsT

using sycl::_V1::detail::context_impl::CachedLibProgramsT = std::map<std::pair<DeviceLibExt, RT::PiDevice>, RT::PiProgram>

Definition at line 144 of file context_impl.hpp.

Member Enumeration Documentation

◆ PropertySupport

enum sycl::_V1::detail::context_impl::PropertySupport

Enumerator
NotSupported
Supported
NotChecked

Definition at line 219 of file context_impl.hpp.

Constructor & Destructor Documentation

◆ context_impl() [1/3]

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.

Parameters

Device	is an instance of SYCL device.
AsyncHandler	is an instance of async_handler.
PropList	is an instance of property_list.

Definition at line 32 of file context_impl.cpp.

References sycl::_V1::detail::KernelProgramCache::setContextPtr().

◆ context_impl() [2/3]

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.

Parameters

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 41 of file context_impl.cpp.

References __SYCL_PI_CONTEXT_PROPERTIES_CUDA_PRIMARY, sycl::_V1::detail::plugin::call(), sycl::_V1::ext_oneapi_cuda, sycl::_V1::detail::plugin::getBackend(), getHandleRef(), getPlugin(), sycl::_V1::detail::getSyclObjImpl(), sycl::_V1::property_list::has_property(), piContextCreate(), and sycl::_V1::detail::KernelProgramCache::setContextPtr().

◆ context_impl() [3/3]

sycl::_V1::detail::context_impl::context_impl	(	RT::PiContext	PiContext,
		async_handler	AsyncHandler,
		const plugin &	Plugin
	)

Construct a context_impl using plug-in interoperability handle.

The constructed context_impl will use the AsyncHandler parameter to handle exceptions.

Parameters

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 context is associated with.

Definition at line 73 of file context_impl.cpp.

References sycl::_V1::detail::plugin::call(), sycl::_V1::detail::platform_impl::getPlatformFromPiDevice(), getPlugin(), PI_CONTEXT_INFO_DEVICES, PI_CONTEXT_INFO_NUM_DEVICES, piContextGetInfo(), piContextRetain(), and sycl::_V1::detail::KernelProgramCache::setContextPtr().

◆ ~context_impl()

sycl::_V1::detail::context_impl::~context_impl ( )

Definition at line 124 of file context_impl.cpp.

References sycl::_V1::detail::plugin::call(), sycl::_V1::detail::plugin::call_nocheck(), sycl::_V1::detail::ProgramManager::getDeviceGlobalEntry(), sycl::_V1::detail::ProgramManager::getInstance(), getPlugin(), piContextRelease(), piProgramRelease(), and sycl::_V1::detail::DeviceGlobalMapEntry::removeAssociatedResources().

Member Function Documentation

◆ acquireCachedLibPrograms()

Locked<CachedLibProgramsT> sycl::_V1::detail::context_impl::acquireCachedLibPrograms ( )

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.

Returns: an instance of sycl::detail::Locked which wraps a map with device library programs and the corresponding lock for synchronized access.

Definition at line 159 of file context_impl.hpp.

◆ addAssociatedDeviceGlobal()

void sycl::_V1::detail::context_impl::addAssociatedDeviceGlobal ( const void * DeviceGlobalPtr )

Adds an associated device global to the tracked associates.

Definition at line 281 of file context_impl.cpp.

◆ addDeviceGlobalInitializer()

void sycl::_V1::detail::context_impl::addDeviceGlobalInitializer	(	RT::PiProgram	Program,
		const std::vector< device > &	Devs,
		const RTDeviceBinaryImage *	BinImage
	)

Adds a device global initializer.

Definition at line 286 of file context_impl.cpp.

References getHandleRef(), and sycl::_V1::detail::getSyclObjImpl().

◆ findMatchingDeviceImpl()

DeviceImplPtr sycl::_V1::detail::context_impl::findMatchingDeviceImpl ( RT::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 250 of file context_impl.cpp.

References getHandleRef(), and sycl::_V1::detail::getSyclObjImpl().

◆ get()

cl_context sycl::_V1::detail::context_impl::get ( ) const

Gets OpenCL interoperability context handle.

Returns: an instance of OpenCL cl_context.

Definition at line 111 of file context_impl.cpp.

References sycl::_V1::detail::plugin::call(), getPlugin(), and piContextRetain().

◆ get_async_handler()

const async_handler & sycl::_V1::detail::context_impl::get_async_handler ( ) const

Gets asynchronous exception handler.

Returns: an instance of SYCL async_handler.

Definition at line 145 of file context_impl.cpp.

◆ get_info()

template<typename Param >

Param::return_type sycl::_V1::detail::context_impl::get_info ( ) const

Queries this context for information.

The return type depends on information being queried.

◆ get_property()

template<typename propertyT >

propertyT sycl::_V1::detail::context_impl::get_property ( ) const

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.

Returns: a copy of the property of type propertyT.

Definition at line 89 of file context_impl.hpp.

◆ getDevices()

const std::vector<device>& sycl::_V1::detail::context_impl::getDevices ( ) const

inline

Unlike ‘get_info<info::context::devices>’, this function returns a reference.

Definition at line 141 of file context_impl.hpp.

Referenced by sycl::_V1::detail::DeviceGlobalMapEntry::removeAssociatedResources().

◆ getHandleRef() [1/2]

const RT::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.

Returns: an instance of raw plug-in context handle.

Definition at line 234 of file context_impl.cpp.

Referenced by addDeviceGlobalInitializer(), sycl::_V1::detail::usm::alignedAllocInternal(), context_impl(), findMatchingDeviceImpl(), sycl::_V1::detail::usm::freeInternal(), and getNative().

◆ getHandleRef() [2/2]

const RT::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.

Returns: an instance of raw plug-in context handle.

◆ getKernelProgramCache()

KernelProgramCache & sycl::_V1::detail::context_impl::getKernelProgramCache ( ) const

Definition at line 237 of file context_impl.cpp.

◆ getNative()

pi_native_handle sycl::_V1::detail::context_impl::getNative ( ) const

Gets the native handle of the SYCL context.

Returns: a native handle.

Definition at line 258 of file context_impl.cpp.

References getHandleRef(), getPlugin(), sycl::_V1::opencl, piContextRetain(), and piextContextGetNativeHandle().

◆ getPlatformImpl()

PlatformImplPtr sycl::_V1::detail::context_impl::getPlatformImpl ( ) const

inline

Returns: the PlatformImpl associated with this context.

Definition at line 112 of file context_impl.hpp.

◆ getPlugin()

const plugin& sycl::_V1::detail::context_impl::getPlugin ( ) const

inline

Returns: the Plugin associated with the platform of this context.

Definition at line 109 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().

◆ getProgramForDeviceGlobal()

std::optional< RT::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 397 of file context_impl.cpp.

References sycl::_V1::detail::KernelProgramCache::acquireCachedPrograms(), sycl::_V1::detail::getSyclObjImpl(), sycl::_V1::invalid, sycl::_V1::make_error_code(), sycl::_V1::detail::DeviceGlobalMapEntry::MImageIdentifiers, and sycl::_V1::detail::KernelProgramCache::waitUntilBuilt().

◆ has_property()

template<typename propertyT >

bool sycl::_V1::detail::context_impl::has_property ( ) const

inlinenoexcept

Checks if this context_impl has a property of type propertyT.

Returns: true if this context_impl has a property of type propertyT.

Definition at line 79 of file context_impl.hpp.

◆ hasDevice()

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 241 of file context_impl.cpp.

References sycl::_V1::detail::getSyclObjImpl().

◆ initializeDeviceGlobals()

std::vector< RT::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 296 of file context_impl.cpp.

References sycl::_V1::detail::plugin::call(), sycl::_V1::detail::ProgramManager::getDeviceGlobalEntries(), sycl::_V1::detail::ProgramManager::getInstance(), getPlugin(), sycl::_V1::detail::DeviceGlobalUSMMem::getPtr(), sycl::_V1::detail::DeviceGlobalUSMMem::getZeroInitEvent(), piEventRelease(), and piextEnqueueDeviceGlobalVariableWrite().

◆ is_host()

bool sycl::_V1::detail::context_impl::is_host ( ) const

Checks if this context is a host context.

Returns: true if this context is a host context.

Definition at line 122 of file context_impl.cpp.

Referenced by sycl::_V1::detail::usm::alignedAllocInternal(), and sycl::_V1::detail::usm::freeInternal().

◆ isBufferLocationSupported()

bool sycl::_V1::detail::context_impl::isBufferLocationSupported ( ) const

Definition at line 267 of file context_impl.cpp.

References NotChecked, NotSupported, and Supported.

◆ isDeviceValid()

bool sycl::_V1::detail::context_impl::isDeviceValid ( DeviceImplPtr Device )

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 172 of file context_impl.hpp.

References sycl::_V1::detail::pi::getPlugin(), and sycl::_V1::detail::getSyclObjImpl().

The documentation for this class was generated from the following files:

source/detail/context_impl.hpp
source/detail/context_impl.cpp

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ CachedLibProgramsT

Member Enumeration Documentation

◆ PropertySupport

Constructor & Destructor Documentation

◆ context_impl() [1/3]

◆ context_impl() [2/3]

◆ context_impl() [3/3]

◆ ~context_impl()

Member Function Documentation

◆ acquireCachedLibPrograms()

◆ addAssociatedDeviceGlobal()

◆ addDeviceGlobalInitializer()

◆ findMatchingDeviceImpl()

◆ get()

◆ get_async_handler()

◆ get_info()

◆ get_property()

◆ getDevices()

◆ getHandleRef() [1/2]

◆ getHandleRef() [2/2]

◆ getKernelProgramCache()

◆ getNative()

◆ getPlatformImpl()

◆ getPlugin()

◆ getProgramForDeviceGlobal()

◆ has_property()

◆ hasDevice()

◆ initializeDeviceGlobals()

◆ is_host()

◆ isBufferLocationSupported()

◆ isDeviceValid()