#include <detail/context_impl.hpp>

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

using	CachedLibProgramsT = std::map< std::pair< DeviceLibExt, ur_device_handle_t >, ur_program_handle_t >

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 (ur_context_handle_t UrContext, 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 ()

cl_context	get () const
	Gets OpenCL interoperability context handle. 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...

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

const ur_context_handle_t &	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 (ur_device_handle_t &DeviceUR) const
	Given a UR device, returns the matching shared_ptr<device_impl> within this context. More...

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

std::vector< ur_event_handle_t >	initializeDeviceGlobals (ur_program_handle_t 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< ur_program_handle_t >	getProgramForDeviceGlobal (const device &Device, DeviceGlobalMapEntry *DeviceGlobalEntry)
	Gets a program associated with a device global from the cache. More...

std::optional< ur_program_handle_t >	getProgramForHostPipe (const device &Device, HostPipeMapEntry *HostPipeEntry)
	Gets a program associated with a HostPipe Entry from the cache. More...

std::optional< ur_program_handle_t >	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 ()

const property_list &	getPropList () const

Detailed Description

Definition at line 32 of file context_impl.hpp.

Member Typedef Documentation

◆ CachedLibProgramsT

using sycl::_V1::detail::context_impl::CachedLibProgramsT = std::map<std::pair<DeviceLibExt, ur_device_handle_t>, ur_program_handle_t>

Definition at line 129 of file context_impl.hpp.

Member Enumeration Documentation

◆ PropertySupport

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

Enumerator
NotSupported
Supported
NotChecked

Definition at line 243 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 29 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 38 of file context_impl.cpp.

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

◆ context_impl() [3/3]

sycl::_V1::detail::context_impl::context_impl	(	ur_context_handle_t	UrContext,
		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.

Parameters

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

References getBackend(), sycl::_V1::detail::platform_impl::getPlatformFromUrDevice(), getPlugin(), sycl::_V1::detail::getSyclObjImpl(), sycl::_V1::invalid, sycl::_V1::make_error_code(), and sycl::_V1::detail::KernelProgramCache::setContextPtr().

◆ ~context_impl()

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

Definition at line 122 of file context_impl.cpp.

References __SYCL_REPORT_EXCEPTION_TO_STREAM, sycl::_V1::detail::ProgramManager::getDeviceGlobalEntry(), sycl::_V1::detail::ProgramManager::getInstance(), getPlugin(), 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 -> #<ur program with assert functions> cl_intel_devicelib_complex -> #<ur 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 146 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 315 of file context_impl.cpp.

◆ addDeviceGlobalInitializer()

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

Adds a device global initializer.

Definition at line 320 of file context_impl.cpp.

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

◆ findMatchingDeviceImpl()

DeviceImplPtr sycl::_V1::detail::context_impl::findMatchingDeviceImpl ( ur_device_handle_t & DeviceUR ) const

Given a UR device, returns the matching shared_ptr<device_impl> within this context.

May return nullptr if no match discovered.

Definition at line 284 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 114 of file context_impl.cpp.

References getPlugin().

◆ 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_backend_info()

template<typename Param >

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.

◆ 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.

◆ getBackend()

backend sycl::_V1::detail::context_impl::getBackend ( ) const

inline

Definition at line 186 of file context_impl.hpp.

Referenced by context_impl(), and getNative().

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

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

◆ getHandleRef() [1/2]

ur_context_handle_t & 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 266 of file context_impl.cpp.

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

◆ getHandleRef() [2/2]

const ur_context_handle_t & 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.

Definition at line 267 of file context_impl.cpp.

◆ getKernelProgramCache()

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

Definition at line 271 of file context_impl.cpp.

◆ getNative()

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

Gets the native handle of the SYCL context.

Returns: a native handle.

Definition at line 292 of file context_impl.cpp.

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

◆ getPlatformImpl()

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

inline

Returns: the PlatformImpl associated with this context.

Definition at line 92 of file context_impl.hpp.

◆ getPlugin()

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

inline

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

Definition at line 89 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< ur_program_handle_t > 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 522 of file context_impl.cpp.

References getProgramForDevImgs(), and sycl::_V1::detail::DeviceGlobalMapEntry::MImageIdentifiers.

◆ getProgramForDevImgs()

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

References sycl::_V1::detail::KernelProgramCache::acquireCachedPrograms(), sycl::_V1::build, sycl::_V1::detail::getSyclObjImpl(), sycl::_V1::invalid, sycl::_V1::make_error_code(), and sycl::_V1::detail::set_ur_error().

Referenced by getProgramForDeviceGlobal(), and getProgramForHostPipe().

◆ getProgramForHostPipe()

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

References sycl::_V1::detail::HostPipeMapEntry::getDevBinImage(), sycl::_V1::detail::RTDeviceBinaryImage::getImageID(), and getProgramForDevImgs().

◆ getPropList()

const property_list& sycl::_V1::detail::context_impl::getPropList ( ) const

inline

Definition at line 245 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 275 of file context_impl.cpp.

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

Referenced by isDeviceValid().

◆ initializeDeviceGlobals()

std::vector< ur_event_handle_t > sycl::_V1::detail::context_impl::initializeDeviceGlobals	(	ur_program_handle_t	NativePrg,
		const std::shared_ptr< queue_impl > &	QueueImpl
	)

Initializes device globals for a program on the associated queue.

Definition at line 330 of file context_impl.cpp.

References sycl::_V1::detail::ProgramManager::getDeviceGlobalEntries(), sycl::_V1::detail::DeviceGlobalUSMMem::getInitEvent(), sycl::_V1::detail::ProgramManager::getInstance(), getPlugin(), and sycl::_V1::detail::DeviceGlobalUSMMem::getPtr().

◆ isBufferLocationSupported()

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

Definition at line 301 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 159 of file context_impl.hpp.

References sycl::_V1::detail::getSyclObjImpl(), hasDevice(), and sycl::_V1::opencl.

◆ isOwnedByRuntime()

bool sycl::_V1::detail::context_impl::isOwnedByRuntime ( )

inline

Definition at line 241 of file context_impl.hpp.

◆ memcpyFromHostOnlyDeviceGlobal()

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

References sycl::_V1::ext::oneapi::experimental::fill().

◆ memcpyToHostOnlyDeviceGlobal()

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

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_backend_info()

◆ get_info()

◆ getBackend()

◆ getDevices()

◆ getHandleRef() [1/2]

◆ getHandleRef() [2/2]

◆ getKernelProgramCache()

◆ getNative()

◆ getPlatformImpl()

◆ getPlugin()

◆ getProgramForDeviceGlobal()

◆ getProgramForDevImgs()

◆ getProgramForHostPipe()

◆ getPropList()

◆ hasDevice()

◆ initializeDeviceGlobals()

◆ isBufferLocationSupported()

◆ isDeviceValid()

◆ isOwnedByRuntime()

◆ memcpyFromHostOnlyDeviceGlobal()

◆ memcpyToHostOnlyDeviceGlobal()