Command group handler class. More...

#include <sycl/handler.hpp>

Classes
struct	ShouldEnableSetArg

Public Types
template<typename T >
using	remove_cv_ref_t = typename detail::remove_cv_t< detail::remove_reference_t< T > >

template<typename U , typename T >
using	is_same_type = std::is_same< remove_cv_ref_t< U >, remove_cv_ref_t< T > >

Public Member Functions
	handler (const handler &)=delete

	handler (handler &&)=delete

handler &	operator= (const handler &)=delete

handler &	operator= (handler &&)=delete

template<auto & SpecName>
void	set_specialization_constant (typename std::remove_reference_t< decltype(SpecName)>::value_type Value)

template<auto & SpecName>
std::remove_reference_t< decltype(SpecName)>::value_type	get_specialization_constant () const

void	use_kernel_bundle (const kernel_bundle< bundle_state::executable > &ExecBundle)

template<typename DataT , int Dims, access::mode AccMode, access::target AccTarget, access::placeholder isPlaceholder>
void	require (accessor< DataT, Dims, AccMode, AccTarget, isPlaceholder > Acc)
	Requires access to the memory object associated with the placeholder accessor. More...

void	depends_on (event Event)
	Registers event dependencies on this command group. More...

void	depends_on (const std::vector< event > &Events)
	Registers event dependencies on this command group. More...

template<typename T >
detail::enable_if_t< ShouldEnableSetArg< T >::value, void >	set_arg (int ArgIndex, T &&Arg)
	Sets argument for OpenCL interoperability kernels. More...

template<typename DataT , int Dims, access::mode AccessMode, access::target AccessTarget, access::placeholder IsPlaceholder>
void	set_arg (int ArgIndex, accessor< DataT, Dims, AccessMode, AccessTarget, IsPlaceholder > Arg)

template<typename DataT , int Dims>
void	set_arg (int ArgIndex, local_accessor< DataT, Dims > Arg)

template<typename... Ts>
void	set_args (Ts &&...Args)
	Sets arguments for OpenCL interoperability kernels. More...

template<typename KernelName = detail::auto_name, typename KernelType >
void	single_task (_KERNELFUNCPARAM(KernelFunc))
	Defines and invokes a SYCL kernel function as a function object type. More...

template<typename KernelName = detail::auto_name, typename KernelType >
void	parallel_for (range< 1 > NumWorkItems, _KERNELFUNCPARAM(KernelFunc))

template<typename KernelName = detail::auto_name, typename KernelType >
void	parallel_for (range< 2 > NumWorkItems, _KERNELFUNCPARAM(KernelFunc))

template<typename KernelName = detail::auto_name, typename KernelType >
void	parallel_for (range< 3 > NumWorkItems, _KERNELFUNCPARAM(KernelFunc))

template<typename FuncT >
	__SYCL_DEPRECATED ("run_on_host_intel() is deprecated, use host_task() instead") void run_on_host_intel(FuncT Func)
	Defines and invokes a SYCL kernel on host device. More...

template<typename FuncT >
detail::enable_if_t< detail::check_fn_signature< detail::remove_reference_t< FuncT >, void()>::value\|\|detail::check_fn_signature< detail::remove_reference_t< FuncT >, void(interop_handle)>::value >	host_task (FuncT &&Func)
	Enqueues a command to the SYCL runtime to invoke `Func` once. More...

template<typename KernelName = detail::auto_name, typename KernelType , int Dims>
void	parallel_for (range< Dims > NumWorkItems, id< Dims > WorkItemOffset, _KERNELFUNCPARAM(KernelFunc))
	Defines and invokes a SYCL kernel function for the specified range and offset. More...

template<typename KernelName = detail::auto_name, typename KernelType , int Dims>
void	parallel_for_work_group (range< Dims > NumWorkGroups, _KERNELFUNCPARAM(KernelFunc))
	Hierarchical kernel invocation method of a kernel defined as a lambda encoding the body of each work-group to launch. More...

template<typename KernelName = detail::auto_name, typename KernelType , int Dims>
void	parallel_for_work_group (range< Dims > NumWorkGroups, range< Dims > WorkGroupSize, _KERNELFUNCPARAM(KernelFunc))
	Hierarchical kernel invocation method of a kernel defined as a lambda encoding the body of each work-group to launch. More...

void	single_task (kernel Kernel)
	Invokes a SYCL kernel. More...

void	parallel_for (range< 1 > NumWorkItems, kernel Kernel)

void	parallel_for (range< 2 > NumWorkItems, kernel Kernel)

void	parallel_for (range< 3 > NumWorkItems, kernel Kernel)

template<int Dims>
void	parallel_for (range< Dims > NumWorkItems, id< Dims > WorkItemOffset, kernel Kernel)
	Defines and invokes a SYCL kernel function for the specified range and offsets. More...

template<int Dims>
void	parallel_for (nd_range< Dims > NDRange, kernel Kernel)
	Defines and invokes a SYCL kernel function for the specified range and offsets. More...

template<typename KernelName = detail::auto_name, typename KernelType >
void	single_task (kernel Kernel, _KERNELFUNCPARAM(KernelFunc))
	Defines and invokes a SYCL kernel function. More...

template<typename FuncT >
	__SYCL_DEPRECATED ("interop_task() is deprecated, use host_task() instead") void interop_task(FuncT Func)
	Invokes a lambda on the host. More...

template<typename KernelName = detail::auto_name, typename KernelType , int Dims>
void	parallel_for (kernel Kernel, range< Dims > NumWorkItems, _KERNELFUNCPARAM(KernelFunc))
	Defines and invokes a SYCL kernel function for the specified range. More...

template<typename KernelName = detail::auto_name, typename KernelType , int Dims>
void	parallel_for (kernel Kernel, range< Dims > NumWorkItems, id< Dims > WorkItemOffset, _KERNELFUNCPARAM(KernelFunc))
	Defines and invokes a SYCL kernel function for the specified range and offsets. More...

template<typename KernelName = detail::auto_name, typename KernelType , int Dims>
void	parallel_for (kernel Kernel, nd_range< Dims > NDRange, _KERNELFUNCPARAM(KernelFunc))
	Defines and invokes a SYCL kernel function for the specified range and offsets. More...

template<typename KernelName = detail::auto_name, typename KernelType , int Dims>
void	parallel_for_work_group (kernel Kernel, range< Dims > NumWorkGroups, _KERNELFUNCPARAM(KernelFunc))
	Hierarchical kernel invocation method of a kernel. More...

template<typename KernelName = detail::auto_name, typename KernelType , int Dims>
void	parallel_for_work_group (kernel Kernel, range< Dims > NumWorkGroups, range< Dims > WorkGroupSize, _KERNELFUNCPARAM(KernelFunc))
	Hierarchical kernel invocation method of a kernel. More...

template<typename KernelName = detail::auto_name, typename KernelType , typename PropertiesT >
std::enable_if_t< ext::oneapi::experimental::is_property_list< PropertiesT >::value >	single_task (PropertiesT, _KERNELFUNCPARAM(KernelFunc))

template<typename KernelName = detail::auto_name, typename KernelType , typename PropertiesT >
std::enable_if_t< ext::oneapi::experimental::is_property_list< PropertiesT >::value >	parallel_for (range< 1 > NumWorkItems, PropertiesT, _KERNELFUNCPARAM(KernelFunc))

template<typename KernelName = detail::auto_name, typename KernelType , typename PropertiesT >
std::enable_if_t< ext::oneapi::experimental::is_property_list< PropertiesT >::value >	parallel_for (range< 2 > NumWorkItems, PropertiesT, _KERNELFUNCPARAM(KernelFunc))

template<typename KernelName = detail::auto_name, typename KernelType , typename PropertiesT >
std::enable_if_t< ext::oneapi::experimental::is_property_list< PropertiesT >::value >	parallel_for (range< 3 > NumWorkItems, PropertiesT, _KERNELFUNCPARAM(KernelFunc))

template<typename KernelName = detail::auto_name, typename KernelType , typename PropertiesT , int Dims>
std::enable_if_t< ext::oneapi::experimental::is_property_list< PropertiesT >::value >	parallel_for (nd_range< Dims > Range, PropertiesT Properties, _KERNELFUNCPARAM(KernelFunc))

class	detail::queue_impl

template<typename DataT , int Dims, access::mode AccMode, access::target AccTarget, access::placeholder isPlaceholder, typename PropertyListT >
class	accessor

template<typename DataT , int Dimensions, access::mode AccessMode, access::target AccessTarget, access::placeholder IsPlaceholder>
class	detail::image_accessor

class	stream

class	detail::stream_impl

template<typename T , class BinaryOperation , int Dims, size_t Extent, typename RedOutVar >
class	detail::reduction_impl_algo

class	::MockHandler

device	detail::getDeviceFromHandler (handler &)

void	detail::reduction::finalizeHandler (handler &CGH)

template<class FunctorTy >
void	detail::reduction::withAuxHandler (handler &CGH, FunctorTy Func)

template<typename KernelName , detail::reduction::strategy Strategy, int Dims, typename PropertiesT , typename... RestT>
void	detail::reduction_parallel_for (handler &CGH, range< Dims > NDRange, PropertiesT Properties, RestT... Rest)

template<typename KernelName , detail::reduction::strategy Strategy, int Dims, typename PropertiesT , typename... RestT>
void	detail::reduction_parallel_for (handler &CGH, nd_range< Dims > NDRange, PropertiesT Properties, RestT... Rest)

void	detail::associateWithHandler (handler &, detail::AccessorBaseHost *, access::target)

template<typename KernelName = detail::auto_name, int Dims, typename PropertiesT , typename... RestT>
std::enable_if_t<(sizeof...(RestT) > 1) &&detail::AreAllButLastReductions< RestT... >::value &&ext::oneapi::experimental::is_property_list< PropertiesT >::value >	parallel_for (range< Dims > Range, PropertiesT Properties, RestT &&...Rest)
	Reductions. More...

template<typename KernelName = detail::auto_name, int Dims, typename... RestT>
std::enable_if_t< detail::AreAllButLastReductions< RestT... >::value >	parallel_for (range< Dims > Range, RestT &&...Rest)

template<typename KernelName = detail::auto_name, int Dims, typename PropertiesT , typename... RestT>
std::enable_if_t<(sizeof...(RestT) > 1) &&detail::AreAllButLastReductions< RestT... >::value &&ext::oneapi::experimental::is_property_list< PropertiesT >::value >	parallel_for (nd_range< Dims > Range, PropertiesT Properties, RestT &&...Rest)

template<typename KernelName = detail::auto_name, int Dims, typename... RestT>
std::enable_if_t< detail::AreAllButLastReductions< RestT... >::value >	parallel_for (nd_range< Dims > Range, RestT &&...Rest)

template<typename KernelName = detail::auto_name, typename KernelType , int Dims, typename PropertiesT >
void	parallel_for_work_group (range< Dims > NumWorkGroups, PropertiesT, _KERNELFUNCPARAM(KernelFunc))
	}@ More...

template<typename KernelName = detail::auto_name, typename KernelType , int Dims, typename PropertiesT >
void	parallel_for_work_group (range< Dims > NumWorkGroups, range< Dims > WorkGroupSize, PropertiesT, _KERNELFUNCPARAM(KernelFunc))

template<typename T_Src , typename T_Dst , int Dims, access::mode AccessMode, access::target AccessTarget, access::placeholder IsPlaceholder = access::placeholder::false_t>
void	copy (accessor< T_Src, Dims, AccessMode, AccessTarget, IsPlaceholder > Src, std::shared_ptr< T_Dst > Dst)
	Copies the content of memory object accessed by Src into the memory pointed by Dst. More...

template<typename T_Src , typename T_Dst , int Dims, access::mode AccessMode, access::target AccessTarget, access::placeholder IsPlaceholder = access::placeholder::false_t>
void	copy (std::shared_ptr< T_Src > Src, accessor< T_Dst, Dims, AccessMode, AccessTarget, IsPlaceholder > Dst)
	Copies the content of memory pointed by Src into the memory object accessed by Dst. More...

template<typename T_Src , typename T_Dst , int Dims, access::mode AccessMode, access::target AccessTarget, access::placeholder IsPlaceholder = access::placeholder::false_t>
void	copy (accessor< T_Src, Dims, AccessMode, AccessTarget, IsPlaceholder > Src, T_Dst *Dst)
	Copies the content of memory object accessed by Src into the memory pointed by Dst. More...

template<typename T_Src , typename T_Dst , int Dims, access::mode AccessMode, access::target AccessTarget, access::placeholder IsPlaceholder = access::placeholder::false_t>
void	copy (const T_Src *Src, accessor< T_Dst, Dims, AccessMode, AccessTarget, IsPlaceholder > Dst)
	Copies the content of memory pointed by Src into the memory object accessed by Dst. More...

template<typename T_Src , int Dims_Src, access::mode AccessMode_Src, access::target AccessTarget_Src, typename T_Dst , int Dims_Dst, access::mode AccessMode_Dst, access::target AccessTarget_Dst, access::placeholder IsPlaceholder_Src = access::placeholder::false_t, access::placeholder IsPlaceholder_Dst = access::placeholder::false_t>
void	copy (accessor< T_Src, Dims_Src, AccessMode_Src, AccessTarget_Src, IsPlaceholder_Src > Src, accessor< T_Dst, Dims_Dst, AccessMode_Dst, AccessTarget_Dst, IsPlaceholder_Dst > Dst)
	Copies the content of memory object accessed by Src to the memory object accessed by Dst. More...

template<typename T , int Dims, access::mode AccessMode, access::target AccessTarget, access::placeholder IsPlaceholder = access::placeholder::false_t>
void	update_host (accessor< T, Dims, AccessMode, AccessTarget, IsPlaceholder > Acc)
	Provides guarantees that the memory object accessed via Acc is updated on the host after command group object execution is complete. More...

template<typename T , int Dims, access::mode AccessMode, access::target AccessTarget, access::placeholder IsPlaceholder = access::placeholder::false_t, typename PropertyListT = property_list>
void	fill (accessor< T, Dims, AccessMode, AccessTarget, IsPlaceholder, PropertyListT > Dst, const T &Pattern)
	Fills memory pointed by accessor with the pattern given. More...

template<typename T >
void	fill (void *Ptr, const T &Pattern, size_t Count)
	Fills the specified memory with the specified pattern. More...

void	ext_oneapi_barrier ()
	Prevents any commands submitted afterward to this queue from executing until all commands previously submitted to this queue have entered the complete state. More...

void	barrier ()
	Prevents any commands submitted afterward to this queue from executing until all commands previously submitted to this queue have entered the complete state. More...

void	ext_oneapi_barrier (const std::vector< event > &WaitList)
	Prevents any commands submitted afterward to this queue from executing until all events in WaitList have entered the complete state. More...

void	barrier (const std::vector< event > &WaitList)
	Prevents any commands submitted afterward to this queue from executing until all events in WaitList have entered the complete state. More...

void	memcpy (void Dest, const void Src, size_t Count)
	Copies data from one memory region to another, each is either a host pointer or a pointer within USM allocation accessible on this handler's device. More...

template<typename T >
void	copy (const T Src, T Dest, size_t Count)
	Copies data from one memory region to another, each is either a host pointer or a pointer within USM allocation accessible on this handler's device. More...

void	memset (void *Dest, int Value, size_t Count)
	Fills the memory pointed by a USM pointer with the value specified. More...

void	prefetch (const void *Ptr, size_t Count)
	Provides hints to the runtime library that data should be made available on a device earlier than Unified Shared Memory would normally require it to be available. More...

void	mem_advise (const void *Ptr, size_t Length, int Advice)
	Provides additional information to the underlying runtime about how different allocations are used. More...

template<typename T = unsigned char, typename = std::enable_if_t<std::is_same_v<T, unsigned char>>>
void	ext_oneapi_memcpy2d (void Dest, size_t DestPitch, const void Src, size_t SrcPitch, size_t Width, size_t Height)
	Copies data from one 2D memory region to another, both pointed by USM pointers. More...

template<typename T >
void	ext_oneapi_copy2d (const T Src, size_t SrcPitch, T Dest, size_t DestPitch, size_t Width, size_t Height)
	Copies data from one 2D memory region to another, both pointed by USM pointers. More...

template<typename T = unsigned char, typename = std::enable_if_t<std::is_same_v<T, unsigned char>>>
void	ext_oneapi_memset2d (void *Dest, size_t DestPitch, int Value, size_t Width, size_t Height)
	Fills the memory pointed by a USM pointer with the value specified. More...

template<typename T >
void	ext_oneapi_fill2d (void *Dest, size_t DestPitch, const T &Pattern, size_t Width, size_t Height)
	Fills the memory pointed by a USM pointer with the value specified. More...

template<typename T , typename PropertyListT >
void	memcpy (ext::oneapi::experimental::device_global< T, PropertyListT > &Dest, const void *Src, size_t NumBytes=sizeof(T), size_t DestOffset=0)
	Copies data from a USM memory region to a device_global. More...

template<typename T , typename PropertyListT >
void	memcpy (void *Dest, const ext::oneapi::experimental::device_global< T, PropertyListT > &Src, size_t NumBytes=sizeof(T), size_t SrcOffset=0)
	Copies data from a device_global to USM memory. More...

template<typename T , typename PropertyListT >
void	copy (const std::remove_all_extents_t< T > *Src, ext::oneapi::experimental::device_global< T, PropertyListT > &Dest, size_t Count=sizeof(T)/sizeof(std::remove_all_extents_t< T >), size_t StartIndex=0)
	Copies elements of type `std::remove_all_extents_t<T>` from a USM memory region to a device_global. More...

template<typename T , typename PropertyListT >
void	copy (const ext::oneapi::experimental::device_global< T, PropertyListT > &Src, std::remove_all_extents_t< T > *Dest, size_t Count=sizeof(T)/sizeof(std::remove_all_extents_t< T >), size_t StartIndex=0)
	Copies elements of type `std::remove_all_extents_t<T>` from a device_global to a USM memory region. More...

Detailed Description

Command group handler class.

Objects of the handler class collect information about command group, such as kernel, requirements to the memory, arguments for the kernel.

sycl::queue::submit([](handler &CGH){
  CGH.require(Accessor1);   // Adds a requirement to the memory object.
  CGH.setArg(0, Accessor2); // Registers accessor given as an argument to
                            // the kernel + adds a requirement to the memory
                            // object.
  CGH.setArg(1, N);         // Registers value given as an argument to the
                            // kernel.
  // The following registers KernelFunctor to be a kernel that will be
  // executed in case of queue is bound to the host device, Kernel - for
  // an OpenCL device. This function clearly indicates that command group
  // represents kernel execution.
  CGH.parallel_for(KernelFunctor, Kernel);
 });

The command group can represent absolutely different operations. Depending on the operation we need to store different data. But, in most cases, it's impossible to say what kind of operation we need to perform until the very end. So, handler class contains all fields simultaneously, then during "finalization" it constructs CG object, that represents specific operation, passing fields that are required only.

See also: queue; program; kernel

Definition at line 313 of file handler.hpp.

Member Typedef Documentation

◆ is_same_type

template<typename U , typename T >

using sycl::_V1::handler::is_same_type = std::is_same<remove_cv_ref_t<U>, remove_cv_ref_t<T> >

Definition at line 1502 of file handler.hpp.

◆ remove_cv_ref_t

template<typename T >

using sycl::_V1::handler::remove_cv_ref_t = typename detail::remove_cv_t<detail::remove_reference_t<T> >

Definition at line 1499 of file handler.hpp.

Constructor & Destructor Documentation

◆ handler() [1/2]

sycl::_V1::handler::handler ( const handler & )

delete

◆ handler() [2/2]

sycl::_V1::handler::handler ( handler && )

delete

Member Function Documentation

◆ __SYCL_DEPRECATED() [1/2]

template<typename FuncT >

sycl::_V1::handler::__SYCL_DEPRECATED	(	"interop_task() is	deprecated,
		use host_task() instead"
	)

inline

Invokes a lambda on the host.

Dependencies are satisfied on the host.

Parameters

Func	is a lambda that is executed on the host

Definition at line 1784 of file handler.hpp.

◆ __SYCL_DEPRECATED() [2/2]

template<typename FuncT >

sycl::_V1::handler::__SYCL_DEPRECATED	(	"run_on_host_intel() is	deprecated,
		use host_task() instead"
	)

inline

Defines and invokes a SYCL kernel on host device.

Parameters

Func	is a SYCL kernel function defined by lambda function or a named function object type.

Definition at line 1582 of file handler.hpp.

◆ barrier() [1/2]

void sycl::_V1::handler::barrier ( )

inline

Prevents any commands submitted afterward to this queue from executing until all commands previously submitted to this queue have entered the complete state.

Definition at line 2371 of file handler.hpp.

◆ barrier() [2/2]

void sycl::_V1::handler::barrier ( const std::vector< event > & WaitList )

Prevents any commands submitted afterward to this queue from executing until all events in WaitList have entered the complete state.

If WaitList is empty, then the barrier has no effect.

Parameters

WaitList is a vector of valid SYCL events that need to complete before barrier command can be executed.

Definition at line 673 of file handler.cpp.

References ext_oneapi_barrier().

◆ copy() [1/8]

template<typename T_Src , typename T_Dst , int Dims, access::mode AccessMode, access::target AccessTarget, access::placeholder IsPlaceholder = access::placeholder::false_t>

void sycl::_V1::handler::copy	(	accessor< T_Src, Dims, AccessMode, AccessTarget, IsPlaceholder >	Src,
		std::shared_ptr< T_Dst >	Dst
	)

inline

Copies the content of memory object accessed by Src into the memory pointed by Dst.

Source must have at least as many bytes as the range accessed by Dst.

Parameters

Src	is a source SYCL accessor.
Dst	is a smart pointer to destination memory.

Definition at line 2107 of file handler.hpp.

References sycl::_V1::AccessMode.

Referenced by sycl::_V1::queue::copy(), and sycl::_V1::detail::reduction_impl_algo< T, BinaryOperation, Dims, Extent, RedOutVar >::withInitializedMem().

◆ copy() [2/8]

template<typename T_Src , typename T_Dst , int Dims, access::mode AccessMode, access::target AccessTarget, access::placeholder IsPlaceholder = access::placeholder::false_t>

void sycl::_V1::handler::copy	(	accessor< T_Src, Dims, AccessMode, AccessTarget, IsPlaceholder >	Src,
		T_Dst *	Dst
	)

inline

Copies the content of memory object accessed by Src into the memory pointed by Dst.

Source must have at least as many bytes as the range accessed by Dst.

Parameters

Src	is a source SYCL accessor.
Dst	is a pointer to destination memory.

Definition at line 2156 of file handler.hpp.

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

◆ copy() [3/8]

template<typename T_Src , int Dims_Src, access::mode AccessMode_Src, access::target AccessTarget_Src, typename T_Dst , int Dims_Dst, access::mode AccessMode_Dst, access::target AccessTarget_Dst, access::placeholder IsPlaceholder_Src = access::placeholder::false_t, access::placeholder IsPlaceholder_Dst = access::placeholder::false_t>

void sycl::_V1::handler::copy	(	accessor< T_Src, Dims_Src, AccessMode_Src, AccessTarget_Src, IsPlaceholder_Src >	Src,
		accessor< T_Dst, Dims_Dst, AccessMode_Dst, AccessTarget_Dst, IsPlaceholder_Dst >	Dst
	)

inline

Copies the content of memory object accessed by Src to the memory object accessed by Dst.

Dst must have at least as many bytes as the range accessed by Src.

Parameters

Src	is a source SYCL accessor.
Dst	is a destination SYCL accessor.

Definition at line 2236 of file handler.hpp.

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

◆ copy() [4/8]

template<typename T , typename PropertyListT >

void sycl::_V1::handler::copy	(	const ext::oneapi::experimental::device_global< T, PropertyListT > &	Src,
		std::remove_all_extents_t< T > *	Dest,
		size_t	Count = `sizeof(T) / sizeof(std::remove_all_extents_t<T>)`,
		size_t	StartIndex = `0`
	)

inline

Copies elements of type std::remove_all_extents_t<T> from a device_global to a USM memory region.

Throws an exception if the copy operation intends to write outside the memory range

Parameters

Src,as	specified through
Count	and
StartIndex.
Src	is the source device_global.
Dest	is a USM pointer to copy to.
Count	is a number of elements to copy.
StartIndex	is the index of the first element in Src to copy from.

Definition at line 2657 of file handler.hpp.

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

◆ copy() [5/8]

template<typename T , typename PropertyListT >

void sycl::_V1::handler::copy	(	const std::remove_all_extents_t< T > *	Src,
		ext::oneapi::experimental::device_global< T, PropertyListT > &	Dest,
		size_t	Count = `sizeof(T) / sizeof(std::remove_all_extents_t<T>)`,
		size_t	StartIndex = `0`
	)

inline

Copies elements of type std::remove_all_extents_t<T> from a USM memory region to a device_global.

Throws an exception if the copy operation intends to write outside the memory range

Parameters

Dest,as	specified through
Count	and
StartIndex.
Src	is a USM pointer to the source memory.
Dest	is the destination device_glboal.
Count	is a number of elements to copy.
StartIndex	is the index of the first element in Dest to copy to.

Definition at line 2637 of file handler.hpp.

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

◆ copy() [6/8]

template<typename T >

void sycl::_V1::handler::copy	(	const T *	Src,
		T *	Dest,
		size_t	Count
	)

inline

Copies data from one memory region to another, each is either a host pointer or a pointer within USM allocation accessible on this handler's device.

No operations is done if

Parameters

Count	is zero. An exception is thrown if either
Dest	or
Src	is nullptr. The behavior is undefined if any of the pointer parameters is invalid.
Src	is a USM pointer to the source memory.
Dest	is a USM pointer to the destination memory.
Count	is a number of elements of type T to copy.

Definition at line 2412 of file handler.hpp.

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

◆ copy() [7/8]

template<typename T_Src , typename T_Dst , int Dims, access::mode AccessMode, access::target AccessTarget, access::placeholder IsPlaceholder = access::placeholder::false_t>

void sycl::_V1::handler::copy	(	const T_Src *	Src,
		accessor< T_Dst, Dims, AccessMode, AccessTarget, IsPlaceholder >	Dst
	)

inline

Copies the content of memory pointed by Src into the memory object accessed by Dst.

Source must have at least as many bytes as the range accessed by Dst.

Parameters

Src	is a pointer to source memory.
Dst	is a destination SYCL accessor.

Definition at line 2195 of file handler.hpp.

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

◆ copy() [8/8]

template<typename T_Src , typename T_Dst , int Dims, access::mode AccessMode, access::target AccessTarget, access::placeholder IsPlaceholder = access::placeholder::false_t>

void sycl::_V1::handler::copy	(	std::shared_ptr< T_Src >	Src,
		accessor< T_Dst, Dims, AccessMode, AccessTarget, IsPlaceholder >	Dst
	)

inline

Copies the content of memory pointed by Src into the memory object accessed by Dst.

Source must have at least as many bytes as the range accessed by Dst.

Parameters

Src	is a smart pointer to source memory.
Dst	is a destination SYCL accessor.

Definition at line 2132 of file handler.hpp.

References sycl::_V1::AccessMode.

◆ depends_on() [1/2]

void sycl::_V1::handler::depends_on ( const std::vector< event > & Events )

Registers event dependencies on this command group.

Parameters

Events is a vector of valid SYCL events to wait on.

Definition at line 793 of file handler.cpp.

References sycl::_V1::detail::getSyclObjImpl(), sycl::_V1::invalid, and sycl::_V1::make_error_code().

◆ depends_on() [2/2]

void sycl::_V1::handler::depends_on ( event Event )

Registers event dependencies on this command group.

Parameters

Event is a valid SYCL event to wait on.

Definition at line 784 of file handler.cpp.

References sycl::_V1::detail::getSyclObjImpl(), sycl::_V1::invalid, and sycl::_V1::make_error_code().

◆ ext_oneapi_barrier() [1/2]

void sycl::_V1::handler::ext_oneapi_barrier ( )

inline

Prevents any commands submitted afterward to this queue from executing until all commands previously submitted to this queue have entered the complete state.

Definition at line 2362 of file handler.hpp.

Referenced by barrier(), and sycl::_V1::queue::ext_oneapi_submit_barrier().

◆ ext_oneapi_barrier() [2/2]

void sycl::_V1::handler::ext_oneapi_barrier ( const std::vector< event > & WaitList )

Prevents any commands submitted afterward to this queue from executing until all events in WaitList have entered the complete state.

If WaitList is empty, then the barrier has no effect.

Parameters

WaitList is a vector of valid SYCL events that need to complete before barrier command can be executed.

Definition at line 663 of file handler.cpp.

References sycl::_V1::detail::CG::BarrierWaitlist.

◆ ext_oneapi_copy2d()

template<typename T >

void sycl::_V1::handler::ext_oneapi_copy2d	(	const T *	Src,
		size_t	SrcPitch,
		T *	Dest,
		size_t	DestPitch,
		size_t	Width,
		size_t	Height
	)

inline

Copies data from one 2D memory region to another, both pointed by USM pointers.

No operations is done if

Parameters

Width	or
Height	is zero. An exception is thrown if either
Dest	or
Src	is nullptr or if
Width	is strictly greater than either
DestPitch	or
SrcPitch.	The behavior is undefined if any of the pointer parameters is invalid.
Src	is a USM pointer to the source memory.
SrcPitch	is the pitch of the rows in
Src.
Dest	is a USM pointer to the destination memory.
DestPitch	is the pitch of the rows in
Dest.
Width	is the width in number of elements of the 2D region to copy.
Height	is the height in number of rows of the 2D region to copy.

Definition at line 2496 of file handler.hpp.

References sycl::_V1::make_error_code().

Referenced by sycl::_V1::queue::ext_oneapi_copy2d().

◆ ext_oneapi_fill2d()

template<typename T >

void sycl::_V1::handler::ext_oneapi_fill2d	(	void *	Dest,
		size_t	DestPitch,
		const T &	Pattern,
		size_t	Width,
		size_t	Height
	)

inline

Fills the memory pointed by a USM pointer with the value specified.

No operations is done if

Parameters

Width	or
Height	is zero. An exception is thrown if either
Dest	or
Src	is nullptr or if
Width	is strictly greater than
DestPitch.	The behavior is undefined if any of the pointer parameters is invalid.
Dest	is a USM pointer to the destination memory.
DestPitch	is the pitch of the rows in
Dest.
Pattern	is the pattern to fill into the memory. T should be trivially copyable.
Width	is the width in number of elements of the 2D region to fill.
Height	is the height in number of rows of the 2D region to fill.

Definition at line 2562 of file handler.hpp.

References sycl::_V1::make_error_code().

Referenced by sycl::_V1::queue::ext_oneapi_fill2d().

◆ ext_oneapi_memcpy2d()

template<typename T = unsigned char, typename = std::enable_if_t<std::is_same_v<T, unsigned char>>>

void sycl::_V1::handler::ext_oneapi_memcpy2d	(	void *	Dest,
		size_t	DestPitch,
		const void *	Src,
		size_t	SrcPitch,
		size_t	Width,
		size_t	Height
	)

inline

Copies data from one 2D memory region to another, both pointed by USM pointers.

No operations is done if

Parameters

Width	or
Height	is zero. An exception is thrown if either
Dest	or
Src	is nullptr or if
Width	is strictly greater than either
DestPitch	or
SrcPitch.	The behavior is undefined if any of the pointer parameters is invalid.

NOTE: Function is dependent to prevent the fallback kernels from materializing without the use of the function.

Parameters

Dest	is a USM pointer to the destination memory.
DestPitch	is the pitch of the rows in
Dest.
Src	is a USM pointer to the source memory.
SrcPitch	is the pitch of the rows in
Src.
Width	is the width in bytes of the 2D region to copy.
Height	is the height in number of row of the 2D region to copy.

Definition at line 2461 of file handler.hpp.

References sycl::_V1::make_error_code().

Referenced by sycl::_V1::queue::ext_oneapi_memcpy2d().

◆ ext_oneapi_memset2d()

template<typename T = unsigned char, typename = std::enable_if_t<std::is_same_v<T, unsigned char>>>

void sycl::_V1::handler::ext_oneapi_memset2d	(	void *	Dest,
		size_t	DestPitch,
		int	Value,
		size_t	Width,
		size_t	Height
	)

inline

Fills the memory pointed by a USM pointer with the value specified.

No operations is done if

Parameters

Width	or
Height	is zero. An exception is thrown if either
Dest	or
Src	is nullptr or if
Width	is strictly greater than
DestPitch.	The behavior is undefined if any of the pointer parameters is invalid.

NOTE: Function is dependent to prevent the fallback kernels from materializing without the use of the function.

Parameters

Dest	is a USM pointer to the destination memory.
DestPitch	is the pitch of the rows in
Dest.
Value	is the value to fill into the region in
Dest.	Value is cast as an unsigned char.
Width	is the width in number of elements of the 2D region to fill.
Height	is the height in number of rows of the 2D region to fill.

Definition at line 2533 of file handler.hpp.

References sycl::_V1::make_error_code().

Referenced by sycl::_V1::queue::ext_oneapi_memset2d().

◆ fill() [1/2]

template<typename T , int Dims, access::mode AccessMode, access::target AccessTarget, access::placeholder IsPlaceholder = access::placeholder::false_t, typename PropertyListT = property_list>

void sycl::_V1::handler::fill	(	accessor< T, Dims, AccessMode, AccessTarget, IsPlaceholder, PropertyListT >	Dst,
		const T &	Pattern
	)

inline

Fills memory pointed by accessor with the pattern given.

If the operation is submitted to queue associated with OpenCL device and accessor points to one dimensional memory object then use special type for filling. Otherwise fill using regular kernel.

Parameters

Dst	is a destination SYCL accessor.
Pattern	is a value to be used to fill the memory.

Definition at line 2311 of file handler.hpp.

References sycl::_V1::AccessMode, sycl::_V1::detail::getSyclObjImpl(), and sycl::_V1::IsPlaceholder.

Referenced by sycl::_V1::queue::fill().

◆ fill() [2/2]

template<typename T >

void sycl::_V1::handler::fill	(	void *	Ptr,
		const T &	Pattern,
		size_t	Count
	)

inline

Fills the specified memory with the specified pattern.

Parameters

Ptr	is the pointer to the memory to fill
Pattern	is the pattern to fill into the memory. T should be trivially copyable.
Count	is the number of times to fill Pattern into Ptr.

Definition at line 2349 of file handler.hpp.

◆ get_specialization_constant()

template<auto & SpecName>

std::remove_reference_t<decltype(SpecName)>::value_type sycl::_V1::handler::get_specialization_constant ( ) const

inline

Definition at line 1454 of file handler.hpp.

References sycl::_V1::make_error_code().

◆ host_task()

template<typename FuncT >

detail::enable_if_t< detail::check_fn_signature<detail::remove_reference_t<FuncT>, void()>::value || detail::check_fn_signature<detail::remove_reference_t<FuncT>, void(interop_handle)>::value> sycl::_V1::handler::host_task ( FuncT && Func )

inline

Enqueues a command to the SYCL runtime to invoke Func once.

Definition at line 1602 of file handler.hpp.

◆ mem_advise()

void sycl::_V1::handler::mem_advise	(	const void *	Ptr,
		size_t	Length,
		int	Advice
	)

Provides additional information to the underlying runtime about how different allocations are used.

Parameters

Ptr	is a USM pointer to the allocation.
Length	is a number of bytes in the allocation.
Advice	is a device-defined advice for the specified allocation.

Definition at line 715 of file handler.cpp.

References sycl::_V1::detail::CG::AdviseUSM.

◆ memcpy() [1/3]

template<typename T , typename PropertyListT >

void sycl::_V1::handler::memcpy	(	ext::oneapi::experimental::device_global< T, PropertyListT > &	Dest,
		const void *	Src,
		size_t	NumBytes = `sizeof(T)`,
		size_t	DestOffset = `0`
	)

inline

Copies data from a USM memory region to a device_global.

Throws an exception if the copy operation intends to write outside the memory range

Parameters

Dest,as	specified through
NumBytes	and
DestOffset.
Dest	is the destination device_glboal.
Src	is a USM pointer to the source memory.
NumBytes	is a number of bytes to copy.
DestOffset	is the offset into
Dest	to copy to.

Definition at line 2590 of file handler.hpp.

References sycl::_V1::ext::oneapi::experimental::has_property(), and sycl::_V1::make_error_code().

◆ memcpy() [2/3]

template<typename T , typename PropertyListT >

void sycl::_V1::handler::memcpy	(	void *	Dest,
		const ext::oneapi::experimental::device_global< T, PropertyListT > &	Src,
		size_t	NumBytes = `sizeof(T)`,
		size_t	SrcOffset = `0`
	)

inline

Copies data from a device_global to USM memory.

Throws an exception if the copy operation intends to read outside the memory range

Parameters

Src,as	specified through
NumBytes	and
SrcOffset.
Dest	is a USM pointer to copy to.
Src	is the source device_global.
NumBytes	is a number of bytes to copy.
SrcOffset	is the offset into
Src	to copy from.

Definition at line 2613 of file handler.hpp.

References sycl::_V1::ext::oneapi::experimental::has_property(), and sycl::_V1::make_error_code().

◆ memcpy() [3/3]

void sycl::_V1::handler::memcpy	(	void *	Dest,
		const void *	Src,
		size_t	Count
	)

Copies data from one memory region to another, each is either a host pointer or a pointer within USM allocation accessible on this handler's device.

No operations is done if

Parameters

Count	is zero. An exception is thrown if either
Dest	or
Src	is nullptr. The behavior is undefined if any of the pointer parameters is invalid.
Dest	is a USM pointer to the destination memory.
Src	is a USM pointer to the source memory.
Count	is a number of bytes to copy.

Definition at line 692 of file handler.cpp.

References sycl::_V1::detail::CG::CopyUSM.

◆ memset()

void sycl::_V1::handler::memset	(	void *	Dest,
		int	Value,
		size_t	Count
	)

Fills the memory pointed by a USM pointer with the value specified.

No operations is done if

Parameters

Count	is zero. An exception is thrown if
Dest	is nullptr. The behavior is undefined if
Dest	is invalid.
Dest	is a USM pointer to the memory to fill.
Value	is a value to be set. Value is cast as an unsigned char.
Count	is a number of bytes to fill.

Definition at line 700 of file handler.cpp.

References sycl::_V1::detail::CG::FillUSM.

◆ operator=() [1/2]

handler& sycl::_V1::handler::operator= ( const handler & )

delete

◆ operator=() [2/2]

handler& sycl::_V1::handler::operator= ( handler && )

delete

◆ parallel_for() [1/20]

template<typename KernelName = detail::auto_name, typename KernelType , int Dims>

void sycl::_V1::handler::parallel_for	(	kernel	Kernel,
		nd_range< Dims >	NDRange,
		_KERNELFUNCPARAM(KernelFunc)
	)

inline

Defines and invokes a SYCL kernel function for the specified range and offsets.

Parameters

Kernel	is a SYCL kernel that is executed on a SYCL device (except for the host device).
NDRange	is a ND-range defining global and local sizes as well as offset.
KernelFunc	is a lambda that is used if device, queue is bound to, is a host device.

Definition at line 1876 of file handler.hpp.

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

◆ parallel_for() [2/20]

template<typename KernelName = detail::auto_name, typename KernelType , int Dims>

void sycl::_V1::handler::parallel_for	(	kernel	Kernel,
		range< Dims >	NumWorkItems,
		_KERNELFUNCPARAM(KernelFunc)
	)

inline

Defines and invokes a SYCL kernel function for the specified range.

Parameters

Kernel	is a SYCL kernel that is executed on a SYCL device (except for the host device).
NumWorkItems	is a range defining indexing space.
KernelFunc	is a lambda that is used if device, queue is bound to, is a host device.

Definition at line 1800 of file handler.hpp.

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

◆ parallel_for() [3/20]

template<typename KernelName = detail::auto_name, typename KernelType , int Dims>

void sycl::_V1::handler::parallel_for	(	kernel	Kernel,
		range< Dims >	NumWorkItems,
		id< Dims >	WorkItemOffset,
		_KERNELFUNCPARAM(KernelFunc)
	)

inline

Defines and invokes a SYCL kernel function for the specified range and offsets.

Parameters

Kernel	is a SYCL kernel that is executed on a SYCL device (except for the host device).
NumWorkItems	is a range defining indexing space.
WorkItemOffset	is an offset to be applied to each work item index.
KernelFunc	is a lambda that is used if device, queue is bound to, is a host device.

Definition at line 1838 of file handler.hpp.

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

◆ parallel_for() [4/20]

template<int Dims>

void sycl::_V1::handler::parallel_for	(	nd_range< Dims >	NDRange,
		kernel	Kernel
	)

inline

Defines and invokes a SYCL kernel function for the specified range and offsets.

The SYCL kernel function is defined as SYCL kernel object.

Parameters

NDRange	is a ND-range defining global and local sizes as well as offset.
Kernel	is a SYCL kernel function.

Definition at line 1738 of file handler.hpp.

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

◆ parallel_for() [5/20]

template<typename KernelName = detail::auto_name, typename KernelType , typename PropertiesT , int Dims>

std::enable_if_t< ext::oneapi::experimental::is_property_list<PropertiesT>::value> sycl::_V1::handler::parallel_for	(	nd_range< Dims >	Range,
		PropertiesT	Properties,
		_KERNELFUNCPARAM(KernelFunc)
	)

inline

Definition at line 2025 of file handler.hpp.

◆ parallel_for() [6/20]

template<typename KernelName = detail::auto_name, int Dims, typename PropertiesT , typename... RestT>

std::enable_if_t< (sizeof...(RestT) > 1) && detail::AreAllButLastReductions<RestT...>::value && ext::oneapi::experimental::is_property_list<PropertiesT>::value> sycl::_V1::handler::parallel_for	(	nd_range< Dims >	Range,
		PropertiesT	Properties,
		RestT &&...	Rest
	)

inline

Definition at line 2058 of file handler.hpp.

◆ parallel_for() [7/20]

template<typename KernelName = detail::auto_name, int Dims, typename... RestT>

std::enable_if_t<detail::AreAllButLastReductions<RestT...>::value> sycl::_V1::handler::parallel_for	(	nd_range< Dims >	Range,
		RestT &&...	Rest
	)

inline

Definition at line 2066 of file handler.hpp.

◆ parallel_for() [8/20]

template<typename KernelName = detail::auto_name, typename KernelType >

void sycl::_V1::handler::parallel_for	(	range< 1 >	NumWorkItems,
		_KERNELFUNCPARAM(KernelFunc)
	)

inline

Definition at line 1563 of file handler.hpp.

Referenced by sycl::_V1::detail::reduAuxCGFunc(), sycl::_V1::detail::reduCGFuncMulti(), sycl::_V1::detail::NDRangeReduction< reduction::strategy::local_atomic_and_atomic_cross_wg >::run(), sycl::_V1::detail::NDRangeReduction< reduction::strategy::group_reduce_and_last_wg_detection >::run(), sycl::_V1::detail::NDRangeReduction< reduction::strategy::range_basic >::run(), sycl::_V1::detail::NDRangeReduction< reduction::strategy::group_reduce_and_atomic_cross_wg >::run(), sycl::_V1::detail::NDRangeReduction< reduction::strategy::local_mem_tree_and_atomic_cross_wg >::run(), sycl::_V1::detail::NDRangeReduction< reduction::strategy::group_reduce_and_multiple_kernels >::run(), and sycl::_V1::detail::NDRangeReduction< reduction::strategy::basic >::run().

◆ parallel_for() [9/20]

void sycl::_V1::handler::parallel_for	(	range< 1 >	NumWorkItems,
		kernel	Kernel
	)

inline

Definition at line 1697 of file handler.hpp.

◆ parallel_for() [10/20]

template<typename KernelName = detail::auto_name, typename KernelType , typename PropertiesT >

std::enable_if_t< ext::oneapi::experimental::is_property_list<PropertiesT>::value> sycl::_V1::handler::parallel_for	(	range< 1 >	NumWorkItems,
		PropertiesT	,
		_KERNELFUNCPARAM(KernelFunc)
	)

inline

Definition at line 1995 of file handler.hpp.

◆ parallel_for() [11/20]

template<typename KernelName = detail::auto_name, typename KernelType >

void sycl::_V1::handler::parallel_for	(	range< 2 >	NumWorkItems,
		_KERNELFUNCPARAM(KernelFunc)
	)

inline

Definition at line 1568 of file handler.hpp.

◆ parallel_for() [12/20]

void sycl::_V1::handler::parallel_for	(	range< 2 >	NumWorkItems,
		kernel	Kernel
	)

inline

Definition at line 1701 of file handler.hpp.

◆ parallel_for() [13/20]

template<typename KernelName = detail::auto_name, typename KernelType , typename PropertiesT >

std::enable_if_t< ext::oneapi::experimental::is_property_list<PropertiesT>::value> sycl::_V1::handler::parallel_for	(	range< 2 >	NumWorkItems,
		PropertiesT	,
		_KERNELFUNCPARAM(KernelFunc)
	)

inline

Definition at line 2005 of file handler.hpp.

◆ parallel_for() [14/20]

template<typename KernelName = detail::auto_name, typename KernelType >

void sycl::_V1::handler::parallel_for	(	range< 3 >	NumWorkItems,
		_KERNELFUNCPARAM(KernelFunc)
	)

inline

Definition at line 1573 of file handler.hpp.

◆ parallel_for() [15/20]

void sycl::_V1::handler::parallel_for	(	range< 3 >	NumWorkItems,
		kernel	Kernel
	)

inline

Definition at line 1705 of file handler.hpp.

◆ parallel_for() [16/20]

template<typename KernelName = detail::auto_name, typename KernelType , typename PropertiesT >

std::enable_if_t< ext::oneapi::experimental::is_property_list<PropertiesT>::value> sycl::_V1::handler::parallel_for	(	range< 3 >	NumWorkItems,
		PropertiesT	,
		_KERNELFUNCPARAM(KernelFunc)
	)

inline

Definition at line 2015 of file handler.hpp.

◆ parallel_for() [17/20]

template<typename KernelName = detail::auto_name, typename KernelType , int Dims>

void sycl::_V1::handler::parallel_for	(	range< Dims >	NumWorkItems,
		id< Dims >	WorkItemOffset,
		_KERNELFUNCPARAM(KernelFunc)
	)

inline

Defines and invokes a SYCL kernel function for the specified range and offset.

The SYCL kernel function is defined as a lambda function or a named function object type and given an id or item for indexing in the indexing space defined by range. If it is a named function object and the function object type is globally visible, there is no need for the developer to provide a kernel name for it.

Parameters

NumWorkItems	is a range defining indexing space.
WorkItemOffset	is an offset to be applied to each work item index.
KernelFunc	is a SYCL kernel function.

Definition at line 1622 of file handler.hpp.

◆ parallel_for() [18/20]

template<int Dims>

void sycl::_V1::handler::parallel_for	(	range< Dims >	NumWorkItems,
		id< Dims >	WorkItemOffset,
		kernel	Kernel
	)

inline

Defines and invokes a SYCL kernel function for the specified range and offsets.

The SYCL kernel function is defined as SYCL kernel object.

Parameters

NumWorkItems	is a range defining indexing space.
WorkItemOffset	is an offset to be applied to each work item index.
Kernel	is a SYCL kernel function.

Definition at line 1719 of file handler.hpp.

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

◆ parallel_for() [19/20]

template<typename KernelName = detail::auto_name, int Dims, typename PropertiesT , typename... RestT>

std::enable_if_t< (sizeof...(RestT) > 1) && detail::AreAllButLastReductions<RestT...>::value && ext::oneapi::experimental::is_property_list<PropertiesT>::value> sycl::_V1::handler::parallel_for	(	range< Dims >	Range,
		PropertiesT	Properties,
		RestT &&...	Rest
	)

inline

Reductions.

Definition at line 2038 of file handler.hpp.

◆ parallel_for() [20/20]

template<typename KernelName = detail::auto_name, int Dims, typename... RestT>

std::enable_if_t<detail::AreAllButLastReductions<RestT...>::value> sycl::_V1::handler::parallel_for	(	range< Dims >	Range,
		RestT &&...	Rest
	)

inline

Definition at line 2046 of file handler.hpp.

◆ parallel_for_work_group() [1/6]

template<typename KernelName = detail::auto_name, typename KernelType , int Dims>

void sycl::_V1::handler::parallel_for_work_group	(	kernel	Kernel,
		range< Dims >	NumWorkGroups,
		_KERNELFUNCPARAM(KernelFunc)
	)

inline

Hierarchical kernel invocation method of a kernel.

This version of parallel_for_work_group takes two parameters representing the same kernel. The first one - Kernel - is a compiled form of the second one - kernelFunc, which is the source form of the kernel. The same source kernel can be compiled multiple times yielding multiple kernel class objects accessible via the program class interface.

Parameters

Kernel	is a compiled SYCL kernel.
NumWorkGroups	is a range describing the number of work-groups in each dimension.
KernelFunc	is a lambda representing kernel.

Definition at line 1918 of file handler.hpp.

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

◆ parallel_for_work_group() [2/6]

template<typename KernelName = detail::auto_name, typename KernelType , int Dims>

void sycl::_V1::handler::parallel_for_work_group	(	kernel	Kernel,
		range< Dims >	NumWorkGroups,
		range< Dims >	WorkGroupSize,
		_KERNELFUNCPARAM(KernelFunc)
	)

inline

Hierarchical kernel invocation method of a kernel.

This version of parallel_for_work_group takes two parameters representing the same kernel. The first one - Kernel - is a compiled form of the second one - kernelFunc, which is the source form of the kernel. The same source kernel can be compiled multiple times yielding multiple kernel class objects accessible via the program class interface.

Parameters

Kernel	is a compiled SYCL kernel.
NumWorkGroups	is a range describing the number of work-groups in each dimension.
WorkGroupSize	is a range describing the size of work-groups in each dimension.
KernelFunc	is a lambda representing kernel.

Definition at line 1957 of file handler.hpp.

References sycl::_V1::detail::getSyclObjImpl(), and sycl::_V1::ext::oneapi::experimental::detail::WorkGroupSize.

◆ parallel_for_work_group() [3/6]

template<typename KernelName = detail::auto_name, typename KernelType , int Dims>

void sycl::_V1::handler::parallel_for_work_group	(	range< Dims >	NumWorkGroups,
		_KERNELFUNCPARAM(KernelFunc)
	)

inline

Hierarchical kernel invocation method of a kernel defined as a lambda encoding the body of each work-group to launch.

Lambda may contain multiple calls to parallel_for_work_item(...) methods representing the execution on each work-item. Launches NumWorkGroups work-groups of runtime-defined size.

Parameters

NumWorkGroups	is a range describing the number of work-groups in each dimension.
KernelFunc	is a lambda representing kernel.

Definition at line 1652 of file handler.hpp.

◆ parallel_for_work_group() [4/6]

template<typename KernelName = detail::auto_name, typename KernelType , int Dims, typename PropertiesT >

void sycl::_V1::handler::parallel_for_work_group	(	range< Dims >	NumWorkGroups,
		PropertiesT	,
		_KERNELFUNCPARAM(KernelFunc)
	)

inline

}@

Definition at line 2076 of file handler.hpp.

◆ parallel_for_work_group() [5/6]

template<typename KernelName = detail::auto_name, typename KernelType , int Dims>

void sycl::_V1::handler::parallel_for_work_group	(	range< Dims >	NumWorkGroups,
		range< Dims >	WorkGroupSize,
		_KERNELFUNCPARAM(KernelFunc)
	)

inline

Hierarchical kernel invocation method of a kernel defined as a lambda encoding the body of each work-group to launch.

Lambda may contain multiple calls to parallel_for_work_item(...) methods representing the execution on each work-item. Launches NumWorkGroups work-groups of WorkGroupSize size.

Parameters

NumWorkGroups	is a range describing the number of work-groups in each dimension.
WorkGroupSize	is a range describing the size of work-groups in each dimension.
KernelFunc	is a lambda representing kernel.

Definition at line 1671 of file handler.hpp.

References sycl::_V1::ext::oneapi::experimental::detail::WorkGroupSize.

◆ parallel_for_work_group() [6/6]

template<typename KernelName = detail::auto_name, typename KernelType , int Dims, typename PropertiesT >

void sycl::_V1::handler::parallel_for_work_group	(	range< Dims >	NumWorkGroups,
		range< Dims >	WorkGroupSize,
		PropertiesT	,
		_KERNELFUNCPARAM(KernelFunc)
	)

inline

Definition at line 2084 of file handler.hpp.

References sycl::_V1::ext::oneapi::experimental::detail::WorkGroupSize.

◆ prefetch()

void sycl::_V1::handler::prefetch	(	const void *	Ptr,
		size_t	Count
	)

Provides hints to the runtime library that data should be made available on a device earlier than Unified Shared Memory would normally require it to be available.

Parameters

Ptr	is a USM pointer to the memory to be prefetched to the device.
Count	is a number of bytes to be prefetched.

Definition at line 708 of file handler.cpp.

References sycl::_V1::detail::CG::PrefetchUSM.

Referenced by sycl::_V1::queue::prefetch().

◆ require()

template<typename DataT , int Dims, access::mode AccMode, access::target AccTarget, access::placeholder isPlaceholder>

void sycl::_V1::handler::require ( accessor< DataT, Dims, AccMode, AccTarget, isPlaceholder > Acc )

inline

Requires access to the memory object associated with the placeholder accessor.

Calling this function with a non-placeholder accessor has no effect.

The command group has a requirement to gain access to the given memory object before executing.

Parameters

Acc	is a SYCL accessor describing required memory region.

Definition at line 1482 of file handler.hpp.

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

Referenced by sycl::_V1::queue::copy(), sycl::_V1::queue::fill(), and sycl::_V1::queue::update_host().

◆ set_arg() [1/3]

template<typename DataT , int Dims, access::mode AccessMode, access::target AccessTarget, access::placeholder IsPlaceholder>

void sycl::_V1::handler::set_arg	(	int	ArgIndex,
		accessor< DataT, Dims, AccessMode, AccessTarget, IsPlaceholder >	Arg
	)

inline

Definition at line 1531 of file handler.hpp.

◆ set_arg() [2/3]

template<typename DataT , int Dims>

void sycl::_V1::handler::set_arg	(	int	ArgIndex,
		local_accessor< DataT, Dims >	Arg
	)

inline

Definition at line 1537 of file handler.hpp.

◆ set_arg() [3/3]

template<typename T >

detail::enable_if_t<ShouldEnableSetArg<T>::value, void> sycl::_V1::handler::set_arg	(	int	ArgIndex,
		T &&	Arg
	)

inline

Sets argument for OpenCL interoperability kernels.

Registers Arg passed as argument # ArgIndex.

Parameters

ArgIndex	is a positional number of argument to be set.
Arg	is an argument value to be set.

Definition at line 1524 of file handler.hpp.

◆ set_args()

template<typename... Ts>

void sycl::_V1::handler::set_args ( Ts &&... Args )

inline

Sets arguments for OpenCL interoperability kernels.

Registers pack of arguments(Args) with indexes starting from 0.

Parameters

Args	are argument values to be set.

Definition at line 1546 of file handler.hpp.

◆ set_specialization_constant()

template<auto & SpecName>

void sycl::_V1::handler::set_specialization_constant ( typename std::remove_reference_t< decltype(SpecName)>::value_type Value )

inline

Definition at line 1439 of file handler.hpp.

◆ single_task() [1/4]

template<typename KernelName = detail::auto_name, typename KernelType >

void sycl::_V1::handler::single_task ( _KERNELFUNCPARAM(KernelFunc) )

inline

Defines and invokes a SYCL kernel function as a function object type.

If it is a named function object and the function object type is globally visible, there is no need for the developer to provide a kernel name for it.

Parameters

KernelFunc is a SYCL kernel function.

Definition at line 1558 of file handler.hpp.

Referenced by sycl::_V1::detail::reduSaveFinalResultToUserMem(), and sycl::_V1::detail::reduction_impl_algo< T, BinaryOperation, Dims, Extent, RedOutVar >::withInitializedMem().

◆ single_task() [2/4]

void sycl::_V1::handler::single_task ( kernel Kernel )

inline

Invokes a SYCL kernel.

Executes exactly once. The kernel invocation method has no functors and cannot be called on host.

Parameters

Kernel is a SYCL kernel object.

Definition at line 1684 of file handler.hpp.

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

◆ single_task() [3/4]

template<typename KernelName = detail::auto_name, typename KernelType >

void sycl::_V1::handler::single_task	(	kernel	Kernel,
		_KERNELFUNCPARAM(KernelFunc)
	)

inline

Defines and invokes a SYCL kernel function.

Parameters

Kernel	is a SYCL kernel that is executed on a SYCL device (except for the host device).
KernelFunc	is a lambda that is used if device, queue is bound to, is a host device.

Definition at line 1755 of file handler.hpp.

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

◆ single_task() [4/4]

template<typename KernelName = detail::auto_name, typename KernelType , typename PropertiesT >

std::enable_if_t< ext::oneapi::experimental::is_property_list<PropertiesT>::value> sycl::_V1::handler::single_task	(	PropertiesT	,
		_KERNELFUNCPARAM(KernelFunc)
	)

inline

Definition at line 1987 of file handler.hpp.

◆ update_host()

template<typename T , int Dims, access::mode AccessMode, access::target AccessTarget, access::placeholder IsPlaceholder = access::placeholder::false_t>

void sycl::_V1::handler::update_host ( accessor< T, Dims, AccessMode, AccessTarget, IsPlaceholder > Acc )

inline

Provides guarantees that the memory object accessed via Acc is updated on the host after command group object execution is complete.

Parameters

Acc	is a SYCL accessor that needs to be updated on host.

Definition at line 2284 of file handler.hpp.

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

Referenced by sycl::_V1::queue::update_host().

◆ use_kernel_bundle()

void sycl::_V1::handler::use_kernel_bundle ( const kernel_bundle< bundle_state::executable > & ExecBundle )

Definition at line 760 of file handler.cpp.

References sycl::_V1::kernel_bundle< State >::get_context(), sycl::_V1::detail::getSyclObjImpl(), sycl::_V1::invalid, and sycl::_V1::make_error_code().

Friends And Related Function Documentation

◆ ::MockHandler

friend class ::MockHandler

friend

Definition at line 2764 of file handler.hpp.

◆ accessor

template<typename DataT , int Dims, access::mode AccMode, access::target AccTarget, access::placeholder isPlaceholder, typename PropertyListT >

friend class accessor

friend

Definition at line 2727 of file handler.hpp.

◆ detail::associateWithHandler

void detail::associateWithHandler	(	handler &	,
		detail::AccessorBaseHost *	,
		access::target
	)

friend

◆ detail::getDeviceFromHandler

device detail::getDeviceFromHandler ( handler & )

friend

◆ detail::image_accessor

template<typename DataT , int Dimensions, access::mode AccessMode, access::target AccessTarget, access::placeholder IsPlaceholder>

friend class detail::image_accessor

friend

Definition at line 2732 of file handler.hpp.

◆ detail::queue_impl

detail::queue_impl

friend

Definition at line 2722 of file handler.hpp.

◆ detail::reduction::finalizeHandler

void detail::reduction::finalizeHandler ( handler & CGH )

friend

◆ detail::reduction::withAuxHandler

template<class FunctorTy >

void detail::reduction::withAuxHandler	(	handler &	CGH,
		FunctorTy	Func
	)

friend

◆ detail::reduction_impl_algo

template<typename T , class BinaryOperation , int Dims, size_t Extent, typename RedOutVar >

friend class detail::reduction_impl_algo

friend

Definition at line 2740 of file handler.hpp.

◆ detail::reduction_parallel_for [1/2]

template<typename KernelName , detail::reduction::strategy Strategy, int Dims, typename PropertiesT , typename... RestT>

void detail::reduction_parallel_for	(	handler &	CGH,
		nd_range< Dims >	NDRange,
		PropertiesT	Properties,
		RestT...	Rest
	)

friend

◆ detail::reduction_parallel_for [2/2]

template<typename KernelName , detail::reduction::strategy Strategy, int Dims, typename PropertiesT , typename... RestT>

void detail::reduction_parallel_for	(	handler &	CGH,
		range< Dims >	NDRange,
		PropertiesT	Properties,
		RestT...	Rest
	)

friend

◆ detail::stream_impl

friend class detail::stream_impl

friend

Definition at line 2735 of file handler.hpp.

◆ stream

friend class stream

friend

Definition at line 2734 of file handler.hpp.

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

include/sycl/handler.hpp
source/handler.cpp

Classes

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ is_same_type

◆ remove_cv_ref_t

Constructor & Destructor Documentation

◆ handler() [1/2]

◆ handler() [2/2]

Member Function Documentation

◆ __SYCL_DEPRECATED() [1/2]

◆ __SYCL_DEPRECATED() [2/2]

◆ barrier() [1/2]

◆ barrier() [2/2]

◆ copy() [1/8]

◆ copy() [2/8]

◆ copy() [3/8]

◆ copy() [4/8]

◆ copy() [5/8]

◆ copy() [6/8]

◆ copy() [7/8]

◆ copy() [8/8]

◆ depends_on() [1/2]

◆ depends_on() [2/2]

◆ ext_oneapi_barrier() [1/2]

◆ ext_oneapi_barrier() [2/2]

◆ ext_oneapi_copy2d()

◆ ext_oneapi_fill2d()

◆ ext_oneapi_memcpy2d()

◆ ext_oneapi_memset2d()

◆ fill() [1/2]

◆ fill() [2/2]

◆ get_specialization_constant()

◆ host_task()

◆ mem_advise()

◆ memcpy() [1/3]

◆ memcpy() [2/3]

◆ memcpy() [3/3]

◆ memset()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ parallel_for() [1/20]

◆ parallel_for() [2/20]

◆ parallel_for() [3/20]

◆ parallel_for() [4/20]

◆ parallel_for() [5/20]

◆ parallel_for() [6/20]

◆ parallel_for() [7/20]

◆ parallel_for() [8/20]

◆ parallel_for() [9/20]

◆ parallel_for() [10/20]

◆ parallel_for() [11/20]

◆ parallel_for() [12/20]

◆ parallel_for() [13/20]

◆ parallel_for() [14/20]

◆ parallel_for() [15/20]

◆ parallel_for() [16/20]

◆ parallel_for() [17/20]

◆ parallel_for() [18/20]

◆ parallel_for() [19/20]

◆ parallel_for() [20/20]

◆ parallel_for_work_group() [1/6]

◆ parallel_for_work_group() [2/6]

◆ parallel_for_work_group() [3/6]

◆ parallel_for_work_group() [4/6]

◆ parallel_for_work_group() [5/6]

◆ parallel_for_work_group() [6/6]

◆ prefetch()

◆ require()

◆ set_arg() [1/3]

◆ set_arg() [2/3]

◆ set_arg() [3/3]

◆ set_args()

◆ set_specialization_constant()

◆ single_task() [1/4]

◆ single_task() [2/4]

◆ single_task() [3/4]

◆ single_task() [4/4]

◆ update_host()