Encapsulates a single SYCL queue which schedules kernels on a SYCL device. More...
#include <sycl/queue.hpp>
Public Member Functions | |
queue (const property_list &PropList={}) | |
Constructs a SYCL queue instance using the device returned by an instance of default_selector. More... | |
queue (const async_handler &AsyncHandler, const property_list &PropList={}) | |
Constructs a SYCL queue instance with an async_handler using the device returned by an instance of default_selector. More... | |
template<typename DeviceSelector , typename = detail::EnableIfSYCL2020DeviceSelectorInvocable<DeviceSelector>> | |
queue (const DeviceSelector &deviceSelector, const async_handler &AsyncHandler, const property_list &PropList={}) | |
Constructs a SYCL queue instance using the device identified by the device selector provided. More... | |
template<typename DeviceSelector , typename = detail::EnableIfSYCL2020DeviceSelectorInvocable<DeviceSelector>> | |
queue (const DeviceSelector &deviceSelector, const property_list &PropList={}) | |
Constructs a SYCL queue instance using the device identified by the device selector provided. More... | |
template<typename DeviceSelector , typename = detail::EnableIfSYCL2020DeviceSelectorInvocable<DeviceSelector>> | |
queue (const context &syclContext, const DeviceSelector &deviceSelector, const property_list &propList={}) | |
Constructs a SYCL queue instance using the device identified by the device selector provided. More... | |
template<typename DeviceSelector , typename = detail::EnableIfSYCL2020DeviceSelectorInvocable<DeviceSelector>> | |
queue (const context &syclContext, const DeviceSelector &deviceSelector, const async_handler &AsyncHandler, const property_list &propList={}) | |
Constructs a SYCL queue instance using the device identified by the device selector provided. More... | |
__SYCL2020_DEPRECATED ("SYCL 1.2.1 device selectors are deprecated. Please " "use SYCL 2020 device selectors instead.") queue(const device_selector &DeviceSelector | |
Constructs a SYCL queue instance using the device returned by the DeviceSelector provided. More... | |
__SYCL2020_DEPRECATED ("SYCL 1.2.1 device selectors are deprecated. Please " "use SYCL 2020 device selectors instead.") queue(const context &SyclContext | |
Constructs a SYCL queue instance that is associated with the context provided, using the device returned by the device selector. More... | |
__SYCL2020_DEPRECATED ("SYCL 1.2.1 device selectors are deprecated. Please " "use SYCL 2020 device selectors instead.") queue(const context &SyclContext | |
Constructs a SYCL queue instance with an async_handler that is associated with the context provided, using the device returned by the device selector. More... | |
queue (const context &SyclContext, const device &SyclDevice, const property_list &PropList={}) | |
Constructs a SYCL queue associated with the given context, device and optional properties list. More... | |
queue (const context &SyclContext, const device &SyclDevice, const async_handler &AsyncHandler, const property_list &PropList={}) | |
Constructs a SYCL queue associated with the given context, device, asynchronous exception handler and optional properties list. More... | |
queue (const queue &RHS)=default | |
Constructs a SYCL queue with an optional async_handler from an OpenCL cl_command_queue. More... | |
queue (queue &&RHS)=default | |
queue & | operator= (const queue &RHS)=default |
queue & | operator= (queue &&RHS)=default |
bool | operator== (const queue &RHS) const |
bool | operator!= (const queue &RHS) const |
context | get_context () const |
device | get_device () const |
__SYCL2020_DEPRECATED ("is_host() is deprecated as the host device is no longer supported.") bool is_host() const | |
template<typename Param > | |
detail::is_queue_info_desc< Param >::return_type | get_info () const |
Queries SYCL queue for information. More... | |
template<typename T > | |
event | submit (T CGF _CODELOCPARAM(&CodeLoc)) |
Submits a command group function object to the queue, in order to be scheduled for execution on the device. More... | |
template<typename T > | |
event | submit (T CGF, queue &SecondaryQueue _CODELOCPARAM(&CodeLoc)) |
Submits a command group function object to the queue, in order to be scheduled for execution on the device. More... | |
event | ext_oneapi_submit_barrier (_CODELOCONLYPARAM(&CodeLoc)) |
Prevents any commands submitted afterward to this queue from executing until all commands previously submitted to this queue have entered the complete state. More... | |
event | submit_barrier (_CODELOCONLYPARAM(&CodeLoc)) |
Prevents any commands submitted afterward to this queue from executing until all commands previously submitted to this queue have entered the complete state. More... | |
event | ext_oneapi_submit_barrier (const std::vector< event > &WaitList _CODELOCPARAM(&CodeLoc)) |
Prevents any commands submitted afterward to this queue from executing until all events in WaitList have entered the complete state. More... | |
event | submit_barrier (const std::vector< event > &WaitList _CODELOCPARAM(&CodeLoc)) |
Prevents any commands submitted afterward to this queue from executing until all events in WaitList have entered the complete state. More... | |
void | wait (_CODELOCONLYPARAM(&CodeLoc)) |
Performs a blocking wait for the completion of all enqueued tasks in the queue. More... | |
void | wait_and_throw (_CODELOCONLYPARAM(&CodeLoc)) |
Performs a blocking wait for the completion of all enqueued tasks in the queue. More... | |
void | wait_proxy (const detail::code_location &CodeLoc) |
Proxy method for wait to forward the code location information to the implementation. More... | |
void | wait_and_throw_proxy (const detail::code_location &CodeLoc) |
Proxy method for wait_and_throw to forward the code location information to the implementation. More... | |
void | throw_asynchronous () |
Checks if any asynchronous errors have been produced by the queue and if so reports them to the async_handler passed on the queue construction. More... | |
template<typename PropertyT > | |
bool | has_property () const noexcept |
template<typename PropertyT > | |
PropertyT | get_property () const |
template<typename T > | |
event | fill (void *Ptr, const T &Pattern, size_t Count) |
Fills the specified memory with the specified pattern. More... | |
template<typename T > | |
event | fill (void *Ptr, const T &Pattern, size_t Count, event DepEvent) |
Fills the specified memory with the specified pattern. More... | |
template<typename T > | |
event | fill (void *Ptr, const T &Pattern, size_t Count, const std::vector< event > &DepEvents) |
Fills the specified memory with the specified pattern. More... | |
event | memset (void *Ptr, int Value, size_t Count) |
Fills the memory pointed by a USM pointer with the value specified. More... | |
event | memset (void *Ptr, int Value, size_t Count, event DepEvent) |
Fills the memory pointed by a USM pointer with the value specified. More... | |
event | memset (void *Ptr, int Value, size_t Count, const std::vector< event > &DepEvents) |
Fills the memory pointed by a USM pointer with the value specified. More... | |
event | 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 the device associated with this queue. More... | |
event | memcpy (void *Dest, const void *Src, size_t Count, event DepEvent) |
Copies data from one memory region to another, each is either a host pointer or a pointer within USM allocation accessible on the device associated with this queue. More... | |
event | memcpy (void *Dest, const void *Src, size_t Count, const std::vector< event > &DepEvents) |
Copies data from one memory region to another, each is either a host pointer or a pointer within USM allocation accessible on the device associated with this queue. More... | |
template<typename T > | |
event | copy (const T *Src, T *Dest, size_t Count _CODELOCPARAM(&CodeLoc)) |
Copies data from one memory region to another, each is either a host pointer or a pointer within USM allocation accessible on the device associated with this queue. More... | |
template<typename T > | |
event | copy (const T *Src, T *Dest, size_t Count, event DepEvent _CODELOCPARAM(&CodeLoc)) |
Copies data from one memory region to another, each is either a host pointer or a pointer within USM allocation accessible on the device associated with this queue. More... | |
template<typename T > | |
event | copy (const T *Src, T *Dest, size_t Count, const std::vector< event > &DepEvents _CODELOCPARAM(&CodeLoc)) |
Copies data from one memory region to another, each is either a host pointer or a pointer within USM allocation accessible on the device associated with this queue. More... | |
event | mem_advise (const void *Ptr, size_t Length, pi_mem_advice Advice) |
Provides additional information to the underlying runtime about how different allocations are used. More... | |
event | mem_advise (const void *Ptr, size_t Length, int Advice) |
Provides additional information to the underlying runtime about how different allocations are used. More... | |
event | mem_advise (const void *Ptr, size_t Length, int Advice, event DepEvent) |
Provides additional information to the underlying runtime about how different allocations are used. More... | |
event | mem_advise (const void *Ptr, size_t Length, int Advice, const std::vector< event > &DepEvents) |
Provides additional information to the underlying runtime about how different allocations are used. More... | |
event | 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... | |
event | prefetch (const void *Ptr, size_t Count, event DepEvent) |
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... | |
event | prefetch (const void *Ptr, size_t Count, const std::vector< event > &DepEvents) |
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... | |
template<typename T = unsigned char, typename = std::enable_if_t<std::is_same_v<T, unsigned char>>> | |
event | ext_oneapi_memcpy2d (void *Dest, size_t DestPitch, const void *Src, size_t SrcPitch, size_t Width, size_t Height _CODELOCPARAM(&CodeLoc)) |
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>>> | |
event | ext_oneapi_memcpy2d (void *Dest, size_t DestPitch, const void *Src, size_t SrcPitch, size_t Width, size_t Height, event DepEvent _CODELOCPARAM(&CodeLoc)) |
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>>> | |
event | ext_oneapi_memcpy2d (void *Dest, size_t DestPitch, const void *Src, size_t SrcPitch, size_t Width, size_t Height, const std::vector< event > &DepEvents _CODELOCPARAM(&CodeLoc)) |
Copies data from one 2D memory region to another, both pointed by USM pointers. More... | |
template<typename T > | |
event | ext_oneapi_copy2d (const T *Src, size_t SrcPitch, T *Dest, size_t DestPitch, size_t Width, size_t Height _CODELOCPARAM(&CodeLoc)) |
Copies data from one 2D memory region to another, both pointed by USM pointers. More... | |
template<typename T > | |
event | ext_oneapi_copy2d (const T *Src, size_t SrcPitch, T *Dest, size_t DestPitch, size_t Width, size_t Height, event DepEvent _CODELOCPARAM(&CodeLoc)) |
Copies data from one 2D memory region to another, both pointed by USM pointers. More... | |
template<typename T > | |
event | ext_oneapi_copy2d (const T *Src, size_t SrcPitch, T *Dest, size_t DestPitch, size_t Width, size_t Height, const std::vector< event > &DepEvents _CODELOCPARAM(&CodeLoc)) |
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>>> | |
event | ext_oneapi_memset2d (void *Dest, size_t DestPitch, int Value, size_t Width, size_t Height _CODELOCPARAM(&CodeLoc)) |
Fills the memory pointed by a USM pointer with the value specified. More... | |
template<typename T = unsigned char, typename = std::enable_if_t<std::is_same_v<T, unsigned char>>> | |
event | ext_oneapi_memset2d (void *Dest, size_t DestPitch, int Value, size_t Width, size_t Height, event DepEvent _CODELOCPARAM(&CodeLoc)) |
Fills the memory pointed by a USM pointer with the value specified. More... | |
template<typename T = unsigned char, typename = std::enable_if_t<std::is_same_v<T, unsigned char>>> | |
event | ext_oneapi_memset2d (void *Dest, size_t DestPitch, int Value, size_t Width, size_t Height, const std::vector< event > &DepEvents _CODELOCPARAM(&CodeLoc)) |
Fills the memory pointed by a USM pointer with the value specified. More... | |
template<typename T > | |
event | ext_oneapi_fill2d (void *Dest, size_t DestPitch, const T &Pattern, size_t Width, size_t Height _CODELOCPARAM(&CodeLoc)) |
Fills the memory pointed by a USM pointer with the value specified. More... | |
template<typename T > | |
event | ext_oneapi_fill2d (void *Dest, size_t DestPitch, const T &Pattern, size_t Width, size_t Height, event DepEvent _CODELOCPARAM(&CodeLoc)) |
Fills the memory pointed by a USM pointer with the value specified. More... | |
template<typename T > | |
event | ext_oneapi_fill2d (void *Dest, size_t DestPitch, const T &Pattern, size_t Width, size_t Height, const std::vector< event > &DepEvents _CODELOCPARAM(&CodeLoc)) |
Fills the memory pointed by a USM pointer with the value specified. More... | |
template<typename KernelName = detail::auto_name, typename KernelType , typename PropertiesT > | |
std::enable_if_t< ext::oneapi::experimental::is_property_list< PropertiesT >::value, event > | single_task (PropertiesT Properties, _KERNELFUNCPARAM(KernelFunc) _CODELOCPARAM(&CodeLoc)) |
single_task version with a kernel represented as a lambda. More... | |
template<typename KernelName = detail::auto_name, typename KernelType > | |
event | single_task (_KERNELFUNCPARAM(KernelFunc) _CODELOCPARAM(&CodeLoc)) |
single_task version with a kernel represented as a lambda. More... | |
template<typename KernelName = detail::auto_name, typename KernelType , typename PropertiesT > | |
std::enable_if_t< ext::oneapi::experimental::is_property_list< PropertiesT >::value, event > | single_task (event DepEvent, PropertiesT Properties, _KERNELFUNCPARAM(KernelFunc) _CODELOCPARAM(&CodeLoc)) |
single_task version with a kernel represented as a lambda. More... | |
template<typename KernelName = detail::auto_name, typename KernelType > | |
event | single_task (event DepEvent, _KERNELFUNCPARAM(KernelFunc) _CODELOCPARAM(&CodeLoc)) |
single_task version with a kernel represented as a lambda. More... | |
template<typename KernelName = detail::auto_name, typename KernelType , typename PropertiesT > | |
std::enable_if_t< ext::oneapi::experimental::is_property_list< PropertiesT >::value, event > | single_task (const std::vector< event > &DepEvents, PropertiesT Properties, _KERNELFUNCPARAM(KernelFunc) _CODELOCPARAM(&CodeLoc)) |
single_task version with a kernel represented as a lambda. More... | |
template<typename KernelName = detail::auto_name, typename KernelType > | |
event | single_task (const std::vector< event > &DepEvents, _KERNELFUNCPARAM(KernelFunc) _CODELOCPARAM(&CodeLoc)) |
single_task version with a kernel represented as a lambda. More... | |
template<typename KernelName = detail::auto_name, typename... RestT> | |
event | parallel_for (range< 1 > Range, RestT &&...Rest) |
parallel_for version with a kernel represented as a lambda + range that specifies global size only. More... | |
template<typename KernelName = detail::auto_name, typename... RestT> | |
event | parallel_for (range< 2 > Range, RestT &&...Rest) |
parallel_for version with a kernel represented as a lambda + range that specifies global size only. More... | |
template<typename KernelName = detail::auto_name, typename... RestT> | |
event | parallel_for (range< 3 > Range, RestT &&...Rest) |
parallel_for version with a kernel represented as a lambda + range that specifies global size only. More... | |
template<typename KernelName = detail::auto_name, typename... RestT> | |
event | parallel_for (range< 1 > Range, event DepEvent, RestT &&...Rest) |
parallel_for version with a kernel represented as a lambda + range that specifies global size only. More... | |
template<typename KernelName = detail::auto_name, typename... RestT> | |
event | parallel_for (range< 2 > Range, event DepEvent, RestT &&...Rest) |
parallel_for version with a kernel represented as a lambda + range that specifies global size only. More... | |
template<typename KernelName = detail::auto_name, typename... RestT> | |
event | parallel_for (range< 3 > Range, event DepEvent, RestT &&...Rest) |
parallel_for version with a kernel represented as a lambda + range that specifies global size only. More... | |
template<typename KernelName = detail::auto_name, typename... RestT> | |
event | parallel_for (range< 1 > Range, const std::vector< event > &DepEvents, RestT &&...Rest) |
parallel_for version with a kernel represented as a lambda + range that specifies global size only. More... | |
template<typename KernelName = detail::auto_name, typename... RestT> | |
event | parallel_for (range< 2 > Range, const std::vector< event > &DepEvents, RestT &&...Rest) |
parallel_for version with a kernel represented as a lambda + range that specifies global size only. More... | |
template<typename KernelName = detail::auto_name, typename... RestT> | |
event | parallel_for (range< 3 > Range, const std::vector< event > &DepEvents, RestT &&...Rest) |
parallel_for version with a kernel represented as a lambda + range that specifies global size only. More... | |
template<typename KernelName = detail::auto_name, typename KernelType , int Dim> | |
event | parallel_for (range< Dim > Range, id< Dim > WorkItemOffset, const std::vector< event > &DepEvents, _KERNELFUNCPARAM(KernelFunc)) |
parallel_for version with a kernel represented as a lambda + range and offset that specify global size and global offset correspondingly. More... | |
template<typename KernelName = detail::auto_name, typename KernelType , int Dims> | |
event | parallel_for_impl (range< Dims > Range, id< Dims > WorkItemOffset, _KERNELFUNCPARAM(KernelFunc)) |
parallel_for version with a kernel represented as a lambda + range and offset that specify global size and global offset correspondingly. More... | |
template<typename KernelName = detail::auto_name, typename KernelType , int Dims> | |
event | parallel_for_impl (range< Dims > Range, id< Dims > WorkItemOffset, event DepEvent, _KERNELFUNCPARAM(KernelFunc)) |
parallel_for version with a kernel represented as a lambda + range and offset that specify global size and global offset correspondingly. More... | |
template<typename KernelName = detail::auto_name, typename KernelType , int Dims> | |
event | parallel_for_impl (range< Dims > Range, id< Dims > WorkItemOffset, const std::vector< event > &DepEvents, _KERNELFUNCPARAM(KernelFunc)) |
parallel_for version with a kernel represented as a lambda + range and offset that specify global size and global offset correspondingly. More... | |
template<typename KernelName = detail::auto_name, int Dims, typename PropertiesT , typename... RestT> | |
std::enable_if_t< detail::AreAllButLastReductions< RestT... >::value &&ext::oneapi::experimental::is_property_list< PropertiesT >::value, event > | parallel_for (nd_range< Dims > Range, PropertiesT Properties, RestT &&...Rest) |
parallel_for version with a kernel represented as a lambda + nd_range that specifies global, local sizes and offset. More... | |
template<typename KernelName = detail::auto_name, int Dims, typename... RestT> | |
std::enable_if_t< detail::AreAllButLastReductions< RestT... >::value, event > | parallel_for (nd_range< Dims > Range, RestT &&...Rest) |
parallel_for version with a kernel represented as a lambda + nd_range that specifies global, local sizes and offset. More... | |
template<typename KernelName = detail::auto_name, int Dims, typename... RestT> | |
event | parallel_for (nd_range< Dims > Range, event DepEvent, RestT &&...Rest) |
parallel_for version with a kernel represented as a lambda + nd_range that specifies global, local sizes and offset. More... | |
template<typename KernelName = detail::auto_name, int Dims, typename... RestT> | |
event | parallel_for (nd_range< Dims > Range, const std::vector< event > &DepEvents, RestT &&...Rest) |
parallel_for version with a kernel represented as a lambda + nd_range that specifies global, local sizes and offset. More... | |
template<typename SrcT , int SrcDims, access_mode SrcMode, target SrcTgt, access::placeholder IsPlaceholder, typename DestT > | |
event | copy (accessor< SrcT, SrcDims, SrcMode, SrcTgt, IsPlaceholder > Src, std::shared_ptr< DestT > Dest _CODELOCPARAM(&CodeLoc)) |
Copies data from a memory region pointed to by a placeholder accessor to another memory region pointed to by a shared_ptr. More... | |
template<typename SrcT , typename DestT , int DestDims, access_mode DestMode, target DestTgt, access::placeholder IsPlaceholder> | |
event | copy (std::shared_ptr< SrcT > Src, accessor< DestT, DestDims, DestMode, DestTgt, IsPlaceholder > Dest _CODELOCPARAM(&CodeLoc)) |
Copies data from a memory region pointed to by a shared_ptr to another memory region pointed to by a placeholder accessor. More... | |
template<typename SrcT , int SrcDims, access_mode SrcMode, target SrcTgt, access::placeholder IsPlaceholder, typename DestT > | |
event | copy (accessor< SrcT, SrcDims, SrcMode, SrcTgt, IsPlaceholder > Src, DestT *Dest _CODELOCPARAM(&CodeLoc)) |
Copies data from a memory region pointed to by a placeholder accessor to another memory region pointed to by a raw pointer. More... | |
template<typename SrcT , typename DestT , int DestDims, access_mode DestMode, target DestTgt, access::placeholder IsPlaceholder> | |
event | copy (const SrcT *Src, accessor< DestT, DestDims, DestMode, DestTgt, IsPlaceholder > Dest _CODELOCPARAM(&CodeLoc)) |
Copies data from a memory region pointed to by a raw pointer to another memory region pointed to by a placeholder accessor. More... | |
template<typename SrcT , int SrcDims, access_mode SrcMode, target SrcTgt, access::placeholder IsSrcPlaceholder, typename DestT , int DestDims, access_mode DestMode, target DestTgt, access::placeholder IsDestPlaceholder> | |
event | copy (accessor< SrcT, SrcDims, SrcMode, SrcTgt, IsSrcPlaceholder > Src, accessor< DestT, DestDims, DestMode, DestTgt, IsDestPlaceholder > Dest _CODELOCPARAM(&CodeLoc)) |
Copies data from one memory region to another, both pointed by placeholder accessors. More... | |
template<typename T , int Dims, access_mode Mode, target Tgt, access::placeholder IsPlaceholder> | |
event | update_host (accessor< T, Dims, Mode, Tgt, IsPlaceholder > Acc _CODELOCPARAM(&CodeLoc)) |
Provides guarantees that the memory object accessed via Acc is updated on the host after operation is complete. More... | |
template<typename T , int Dims, access_mode Mode, target Tgt, access::placeholder IsPlaceholder> | |
event | fill (accessor< T, Dims, Mode, Tgt, IsPlaceholder > Dest, const T &Src _CODELOCPARAM(&CodeLoc)) |
Fills the specified memory with the specified data. More... | |
bool | ext_codeplay_supports_fusion () const |
Returns true if the queue was created with the ext::codeplay::experimental::property::queue::enable_fusion property. More... | |
bool | is_in_order () const |
Returns whether the queue is in order or OoO. More... | |
backend | get_backend () const noexcept |
Returns the backend associated with this queue. More... | |
bool | ext_oneapi_empty () const |
Allows to check status of the queue (completed vs noncompleted). More... | |
![]() | |
bool | ext_oneapi_owner_before (const ext::oneapi::detail::weak_object_base< queue > &Other) const noexcept |
Compares the object against a weak object using an owner-based implementation-defined ordering. More... | |
bool | ext_oneapi_owner_before (const queue &Other) const noexcept |
Compares the object against another object using an owner-based implementation-defined ordering. More... | |
Public Attributes | |
const property_list & | PropList |
const device_selector & | DeviceSelector |
const device_selector const property_list & | PropList = {}) |
const device_selector const async_handler & | AsyncHandler |
const device_selector const async_handler const property_list & | PropList = {}) |
Friends | |
template<class T > | |
T | detail::createSyclObjFromImpl (decltype(T::impl) ImplObj) |
template<backend BackendName, class SyclObjectT > | |
auto | get_native (const SyclObjectT &Obj) -> backend_return_t< BackendName, SyclObjectT > |
Encapsulates a single SYCL queue which schedules kernels on a SYCL device.
A SYCL queue can be used to submit command groups to be executed by the SYCL runtime.
|
inlineexplicit |
|
inline |
|
inlineexplicit |
Constructs a SYCL queue instance using the device identified by the device selector provided.
DeviceSelector | is SYCL 2020 Device Selector, a simple callable that takes a device and returns an int |
AsyncHandler | is a SYCL asynchronous exception handler. |
PropList | is a list of properties for queue construction. |
|
inlineexplicit |
Constructs a SYCL queue instance using the device identified by the device selector provided.
DeviceSelector | is SYCL 2020 Device Selector, a simple callable that takes a device and returns an int |
PropList | is a list of properties for queue construction. |
|
inlineexplicit |
Constructs a SYCL queue instance using the device identified by the device selector provided.
SyclContext | is an instance of SYCL context. |
DeviceSelector | is SYCL 2020 Device Selector, a simple callable that takes a device and returns an int |
PropList | is a list of properties for queue construction. |
|
inlineexplicit |
Constructs a SYCL queue instance using the device identified by the device selector provided.
SyclContext | is an instance of SYCL context. |
DeviceSelector | is SYCL 2020 Device Selector, a simple callable that takes a device and returns an int |
AsyncHandler | is a SYCL asynchronous exception handler. |
PropList | is a list of properties for queue construction. |
sycl::_V1::queue::queue | ( | const context & | SyclContext, |
const device & | SyclDevice, | ||
const property_list & | PropList = {} |
||
) |
sycl::_V1::queue::queue | ( | const context & | SyclContext, |
const device & | SyclDevice, | ||
const async_handler & | AsyncHandler, | ||
const property_list & | PropList = {} |
||
) |
Constructs a SYCL queue associated with the given context, device, asynchronous exception handler and optional properties list.
SyclContext | is an instance of SYCL context. |
SyclDevice | is an instance of SYCL device. |
AsyncHandler | is a SYCL asynchronous exception handler. |
PropList | is a list of properties for queue construction. |
Definition at line 41 of file queue.cpp.
References sycl::_V1::detail::getSyclObjImpl().
|
default |
Constructs a SYCL queue with an optional async_handler from an OpenCL cl_command_queue.
The instance of cl_command_queue is retained on construction.
ClQueue | is a valid instance of OpenCL queue. |
SyclContext | is a valid SYCL context. |
AsyncHandler | is a SYCL asynchronous exception handler. |
|
default |
sycl::_V1::queue::__SYCL2020_DEPRECATED | ( | "is_host() is deprecated as the host device is no longer supported." | ) | const |
sycl::_V1::queue::__SYCL2020_DEPRECATED | ( | "SYCL 1.2.1 device selectors are deprecated. Please " "use SYCL 2020 device selectors instead." | ) | const & |
Constructs a SYCL queue instance that is associated with the context provided, using the device returned by the device selector.
SyclContext | is an instance of SYCL context. |
DeviceSelector | is an instance of SYCL device selector. |
PropList | is a list of properties for queue construction. |
sycl::_V1::queue::__SYCL2020_DEPRECATED | ( | "SYCL 1.2.1 device selectors are deprecated. Please " "use SYCL 2020 device selectors instead." | ) | const & |
Constructs a SYCL queue instance with an async_handler that is associated with the context provided, using the device returned by the device selector.
SyclContext | is an instance of SYCL context. |
DeviceSelector | is an instance of SYCL device selector. |
AsyncHandler | is a SYCL asynchronous exception handler. |
PropList | is a list of properties for queue construction. |
sycl::_V1::queue::__SYCL2020_DEPRECATED | ( | "SYCL 1.2.1 device selectors are deprecated. Please " "use SYCL 2020 device selectors instead." | ) | const & |
Constructs a SYCL queue instance using the device returned by the DeviceSelector provided.
DeviceSelector | is an instance of a SYCL 1.2.1 device_selector. |
PropList | is a list of properties for queue construction. |
|
inline |
Copies data from a memory region pointed to by a placeholder accessor to another memory region pointed to by a raw pointer.
Src | is a placeholder accessor to the source memory. |
Dest | is a raw pointer to the destination memory. |
Definition at line 1515 of file queue.hpp.
References _CODELOCFW, sycl::_V1::handler::copy(), and sycl::_V1::handler::require().
|
inline |
Copies data from a memory region pointed to by a placeholder accessor to another memory region pointed to by a shared_ptr.
Src | is a placeholder accessor to the source memory. |
Dest | is a shared_ptr to the destination memory. |
Definition at line 1482 of file queue.hpp.
References _CODELOCFW, sycl::_V1::handler::copy(), and sycl::_V1::handler::require().
|
inline |
Copies data from one memory region to another, both pointed by placeholder accessors.
Src | is a placeholder accessor to the source memory. |
Dest | is a placeholder accessor to the destination memory. |
Definition at line 1551 of file queue.hpp.
References _CODELOCFW, sycl::_V1::handler::copy(), and sycl::_V1::handler::require().
|
inline |
Copies data from a memory region pointed to by a raw pointer to another memory region pointed to by a placeholder accessor.
Src | is a raw pointer to the source memory. |
Dest | is a placeholder accessor to the destination memory. |
Definition at line 1531 of file queue.hpp.
References _CODELOCFW, sycl::_V1::handler::copy(), and sycl::_V1::handler::require().
|
inline |
Copies data from one memory region to another, each is either a host pointer or a pointer within USM allocation accessible on the device associated with this queue.
No operations is done if
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. |
CodeLoc | contains the code location of user code |
Definition at line 613 of file queue.hpp.
References _CODELOCARG, and sycl::_V1::detail::memcpy().
|
inline |
Copies data from one memory region to another, each is either a host pointer or a pointer within USM allocation accessible on the device associated with this queue.
No operations is done if
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. |
DepEvents | is a vector of events that specifies the kernel |
CodeLoc | contains the code location of user code |
Definition at line 654 of file queue.hpp.
References _CODELOCARG, and sycl::_V1::detail::memcpy().
|
inline |
Copies data from one memory region to another, each is either a host pointer or a pointer within USM allocation accessible on the device associated with this queue.
No operations is done if
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. |
DepEvent | is an event that specifies the kernel dependencies. |
CodeLoc | contains the code location of user code |
Definition at line 633 of file queue.hpp.
References _CODELOCARG, and sycl::_V1::detail::memcpy().
|
inline |
Copies data from a memory region pointed to by a shared_ptr to another memory region pointed to by a placeholder accessor.
Src | is a shared_ptr to the source memory. |
Dest | is a placeholder accessor to the destination memory. |
Definition at line 1498 of file queue.hpp.
References _CODELOCFW, sycl::_V1::handler::copy(), and sycl::_V1::handler::require().
bool sycl::_V1::queue::ext_codeplay_supports_fusion | ( | ) | const |
Returns true if the queue was created with the ext::codeplay::experimental::property::queue::enable_fusion property.
Equivalent to has_property<ext::codeplay::experimental::property::queue::enable_fusion>()
.
Definition at line 221 of file queue.cpp.
Referenced by sycl::_V1::ext::codeplay::experimental::fusion_wrapper::fusion_wrapper().
|
inline |
Copies data from one 2D memory region to another, both pointed by USM pointers.
No operations is done if
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 851 of file queue.hpp.
References _CODELOCFW, and sycl::_V1::handler::ext_oneapi_copy2d().
|
inline |
Copies data from one 2D memory region to another, both pointed by USM pointers.
No operations is done if
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. |
DepEvents | is a vector of events that specifies the kernel dependencies. |
Definition at line 903 of file queue.hpp.
References _CODELOCFW, sycl::_V1::handler::depends_on(), and sycl::_V1::handler::ext_oneapi_copy2d().
|
inline |
Copies data from one 2D memory region to another, both pointed by USM pointers.
No operations is done if
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. |
DepEvent | is an event that specifies the kernel dependencies. |
Definition at line 876 of file queue.hpp.
References _CODELOCFW, sycl::_V1::handler::depends_on(), and sycl::_V1::handler::ext_oneapi_copy2d().
bool sycl::_V1::queue::ext_oneapi_empty | ( | ) | const |
|
inline |
Fills the memory pointed by a USM pointer with the value specified.
No operations is done if
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 1010 of file queue.hpp.
References _CODELOCFW, and sycl::_V1::handler::ext_oneapi_fill2d().
|
inline |
Fills the memory pointed by a USM pointer with the value specified.
No operations is done if
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. |
DepEvents | is a vector of events that specifies the kernel dependencies. |
Definition at line 1057 of file queue.hpp.
References _CODELOCFW, sycl::_V1::handler::depends_on(), and sycl::_V1::handler::ext_oneapi_fill2d().
|
inline |
Fills the memory pointed by a USM pointer with the value specified.
No operations is done if
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. |
DepEvent | is an event that specifies the kernel dependencies. |
Definition at line 1032 of file queue.hpp.
References _CODELOCFW, sycl::_V1::handler::depends_on(), and sycl::_V1::handler::ext_oneapi_fill2d().
|
inline |
Copies data from one 2D memory region to another, both pointed by USM pointers.
No operations is done if
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.
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 rows of the 2D region to copy. |
Definition at line 765 of file queue.hpp.
References _CODELOCFW, and sycl::_V1::handler::ext_oneapi_memcpy2d().
|
inline |
Copies data from one 2D memory region to another, both pointed by USM pointers.
No operations is done if
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.
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 rows of the 2D region to copy. |
DepEvents | is a vector of events that specifies the kernel dependencies. |
Definition at line 825 of file queue.hpp.
References _CODELOCFW, sycl::_V1::handler::depends_on(), and sycl::_V1::handler::ext_oneapi_memcpy2d().
|
inline |
Copies data from one 2D memory region to another, both pointed by USM pointers.
No operations is done if
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.
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 rows of the 2D region to copy. |
DepEvent | is an event that specifies the kernel dependencies. |
Definition at line 794 of file queue.hpp.
References _CODELOCFW, sycl::_V1::handler::depends_on(), and sycl::_V1::handler::ext_oneapi_memcpy2d().
|
inline |
Fills the memory pointed by a USM pointer with the value specified.
No operations is done if
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.
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 931 of file queue.hpp.
References _CODELOCFW, and sycl::_V1::handler::ext_oneapi_memset2d().
|
inline |
Fills the memory pointed by a USM pointer with the value specified.
No operations is done if
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.
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. |
DepEvents | is a vector of events that specifies the kernel dependencies. |
Definition at line 987 of file queue.hpp.
References _CODELOCFW, sycl::_V1::handler::depends_on(), and sycl::_V1::handler::ext_oneapi_memset2d().
|
inline |
Fills the memory pointed by a USM pointer with the value specified.
No operations is done if
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.
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. |
DepEvent | is an event that specifies the kernel dependencies. |
Definition at line 958 of file queue.hpp.
References _CODELOCFW, sycl::_V1::handler::depends_on(), and sycl::_V1::handler::ext_oneapi_memset2d().
|
inline |
Prevents any commands submitted afterward to this queue from executing until all commands previously submitted to this queue have entered the complete state.
CodeLoc | is the code location of the submit call (default argument) |
Definition at line 377 of file queue.hpp.
References _CODELOCFW, and sycl::_V1::handler::ext_oneapi_barrier().
|
inline |
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 ext_oneapi_submit_barrier has no effect.
WaitList | is a vector of valid SYCL events that need to complete before barrier command can be executed. |
CodeLoc | is the code location of the submit call (default argument) |
Definition at line 404 of file queue.hpp.
References _CODELOCFW, and sycl::_V1::handler::ext_oneapi_barrier().
|
inline |
Fills the specified memory with the specified data.
Dest | is the placeholder accessor to the memory to fill. |
Src | is the data to fill the memory with. T should be trivially copyable. |
Definition at line 1584 of file queue.hpp.
References _CODELOCFW, sycl::_V1::handler::fill(), and sycl::_V1::handler::require().
|
inline |
Fills the specified memory with the specified pattern.
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 482 of file queue.hpp.
References sycl::_V1::handler::fill().
|
inline |
Fills the specified memory with the specified pattern.
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. |
DepEvents | is a vector of events that specifies the kernel dependencies. |
Definition at line 512 of file queue.hpp.
References sycl::_V1::handler::depends_on(), and sycl::_V1::handler::fill().
|
inline |
Fills the specified memory with the specified pattern.
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. |
DepEvent | is an event that specifies the kernel dependencies. |
Definition at line 495 of file queue.hpp.
References sycl::_V1::handler::depends_on(), and sycl::_V1::handler::fill().
|
noexcept |
Returns the backend associated with this queue.
Definition at line 206 of file queue.cpp.
References sycl::_V1::detail::getImplBackend().
context sycl::_V1::queue::get_context | ( | ) | const |
Definition at line 75 of file queue.cpp.
Referenced by sycl::_V1::aligned_alloc(), sycl::_V1::aligned_alloc_device(), sycl::_V1::aligned_alloc_host(), sycl::_V1::aligned_alloc_shared(), sycl::_V1::free(), sycl::_V1::malloc(), sycl::_V1::malloc_device(), sycl::_V1::malloc_host(), and sycl::_V1::malloc_shared().
device sycl::_V1::queue::get_device | ( | ) | const |
Definition at line 77 of file queue.cpp.
Referenced by sycl::_V1::aligned_alloc(), sycl::_V1::aligned_alloc_device(), sycl::_V1::aligned_alloc_shared(), sycl::_V1::detail::reduction_impl_algo< T, BinaryOperation, Dims, Extent, RedOutVar >::getGroupsCounterAccDiscrete(), sycl::_V1::malloc(), sycl::_V1::malloc_device(), and sycl::_V1::malloc_shared().
detail::is_queue_info_desc< Param >::return_type sycl::_V1::queue::get_info |
PropertyT sycl::_V1::queue::get_property |
|
noexcept |
bool sycl::_V1::queue::is_in_order | ( | ) | const |
Returns whether the queue is in order or OoO.
Equivalent to has_property<property::queue::in_order>()
event sycl::_V1::queue::mem_advise | ( | const void * | Ptr, |
size_t | Length, | ||
int | Advice | ||
) |
Provides additional information to the underlying runtime about how different allocations are used.
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. |
event sycl::_V1::queue::mem_advise | ( | const void * | Ptr, |
size_t | Length, | ||
int | Advice, | ||
const std::vector< event > & | DepEvents | ||
) |
Provides additional information to the underlying runtime about how different allocations are used.
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. |
DepEvents | is a vector of events that specifies the kernel dependencies. |
Provides additional information to the underlying runtime about how different allocations are used.
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. |
DepEvent | is an event that specifies the kernel dependencies. |
event sycl::_V1::queue::mem_advise | ( | const void * | Ptr, |
size_t | Length, | ||
pi_mem_advice | Advice | ||
) |
Provides additional information to the underlying runtime about how different allocations are used.
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. |
event sycl::_V1::queue::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 the device associated with this queue.
No operations is done if
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. |
event sycl::_V1::queue::memcpy | ( | void * | Dest, |
const void * | Src, | ||
size_t | Count, | ||
const std::vector< event > & | DepEvents | ||
) |
Copies data from one memory region to another, each is either a host pointer or a pointer within USM allocation accessible on the device associated with this queue.
No operations is done if
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. |
DepEvents | is a vector of events that specifies the kernel dependencies. |
Copies data from one memory region to another, each is either a host pointer or a pointer within USM allocation accessible on the device associated with this queue.
No operations is done if
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. |
DepEvent | is an event that specifies the kernel dependencies. |
event sycl::_V1::queue::memset | ( | void * | Ptr, |
int | Value, | ||
size_t | Count | ||
) |
Fills the memory pointed by a USM pointer with the value specified.
No operations is done if
Count | is zero. An exception is thrown if |
Ptr | is nullptr. The behavior is undefined if |
Ptr | is invalid. |
Ptr | 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 87 of file queue.cpp.
Referenced by sycl::_V1::detail::reduction_impl_algo< T, BinaryOperation, Dims, Extent, RedOutVar >::getGroupsCounterAccDiscrete().
event sycl::_V1::queue::memset | ( | void * | Ptr, |
int | Value, | ||
size_t | Count, | ||
const std::vector< event > & | DepEvents | ||
) |
Fills the memory pointed by a USM pointer with the value specified.
No operations is done if
Count | is zero. An exception is thrown if |
Ptr | is nullptr. The behavior is undefined if |
Ptr | is invalid. |
Ptr | 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. |
DepEvents | is a vector of events that specifies the kernel dependencies. |
Fills the memory pointed by a USM pointer with the value specified.
No operations is done if
Count | is zero. An exception is thrown if |
Ptr | is nullptr. The behavior is undefined if |
Ptr | is invalid. |
Ptr | 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. |
DepEvent | is an event that specifies the kernel dependencies. |
|
inline |
|
inline |
|
inline |
parallel_for version with a kernel represented as a lambda + nd_range that specifies global, local sizes and offset.
Range | specifies the global and local work spaces of the kernel |
DepEvents | is a vector of events that specifies the kernel dependencies |
Rest | acts as-if: "ReductionTypes&&... Reductions, const KernelType &KernelFunc". |
Definition at line 1462 of file queue.hpp.
References sycl::_V1::handler::depends_on().
|
inline |
parallel_for version with a kernel represented as a lambda + nd_range that specifies global, local sizes and offset.
Range | specifies the global and local work spaces of the kernel |
DepEvent | is an event that specifies the kernel dependencies |
Rest | acts as-if: "ReductionTypes&&... Reductions, const KernelType &KernelFunc". |
Definition at line 1441 of file queue.hpp.
References sycl::_V1::handler::depends_on().
|
inline |
parallel_for version with a kernel represented as a lambda + nd_range that specifies global, local sizes and offset.
Range | specifies the global and local work spaces of the kernel |
Properties | is the kernel properties. |
Rest | acts as-if: "ReductionTypes&&... Reductions, const KernelType &KernelFunc". |
|
inline |
parallel_for version with a kernel represented as a lambda + nd_range that specifies global, local sizes and offset.
Range | specifies the global and local work spaces of the kernel |
Rest | acts as-if: "ReductionTypes&&... Reductions, const KernelType &KernelFunc". |
|
inline |
parallel_for version with a kernel represented as a lambda + range that specifies global size only.
Range | specifies the global work space of the kernel |
DepEvents | is a vector of events that specifies the kernel dependencies |
Rest | acts as-if: "ReductionTypes&&... Reductions, const KernelType &KernelFunc". |
|
inline |
parallel_for version with a kernel represented as a lambda + range that specifies global size only.
Range | specifies the global work space of the kernel |
DepEvent | is an event that specifies the kernel dependencies |
Rest | acts as-if: "ReductionTypes&&... Reductions, const KernelType &KernelFunc". |
|
inline |
parallel_for version with a kernel represented as a lambda + range that specifies global size only.
Range | specifies the global work space of the kernel |
DepEvents | is a vector of events that specifies the kernel dependencies |
Rest | acts as-if: "ReductionTypes&&... Reductions, const KernelType &KernelFunc". |
|
inline |
parallel_for version with a kernel represented as a lambda + range that specifies global size only.
Range | specifies the global work space of the kernel |
DepEvent | is an event that specifies the kernel dependencies |
Rest | acts as-if: "ReductionTypes&&... Reductions, const KernelType &KernelFunc". |
|
inline |
parallel_for version with a kernel represented as a lambda + range that specifies global size only.
Range | specifies the global work space of the kernel |
DepEvents | is a vector of events that specifies the kernel dependencies |
Rest | acts as-if: "ReductionTypes&&... Reductions, const KernelType &KernelFunc". |
|
inline |
parallel_for version with a kernel represented as a lambda + range that specifies global size only.
Range | specifies the global work space of the kernel |
DepEvent | is an event that specifies the kernel dependencies |
Rest | acts as-if: "ReductionTypes&&... Reductions, const KernelType &KernelFunc". |
|
inline |
parallel_for version with a kernel represented as a lambda + range and offset that specify global size and global offset correspondingly.
Range | specifies the global work space of the kernel |
WorkItemOffset | specifies the offset for each work item id |
KernelFunc | is the Kernel functor or lambda |
CodeLoc | contains the code location of user code |
|
inline |
parallel_for version with a kernel represented as a lambda + range and offset that specify global size and global offset correspondingly.
Range | specifies the global work space of the kernel |
WorkItemOffset | specifies the offset for each work item id |
KernelFunc | is the Kernel functor or lambda |
CodeLoc | contains the code location of user code |
|
inline |
parallel_for version with a kernel represented as a lambda + range and offset that specify global size and global offset correspondingly.
Range | specifies the global work space of the kernel |
WorkItemOffset | specifies the offset for each work item id |
DepEvents | is a vector of events that specifies the kernel dependencies |
KernelFunc | is the Kernel functor or lambda |
CodeLoc | contains the code location of user code |
Definition at line 1380 of file queue.hpp.
References sycl::_V1::handler::depends_on().
|
inline |
parallel_for version with a kernel represented as a lambda + range and offset that specify global size and global offset correspondingly.
Range | specifies the global work space of the kernel |
WorkItemOffset | specifies the offset for each work item id |
DepEvent | is an event that specifies the kernel dependencies |
KernelFunc | is the Kernel functor or lambda |
CodeLoc | contains the code location of user code |
Definition at line 1355 of file queue.hpp.
References sycl::_V1::handler::depends_on().
|
inline |
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.
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 709 of file queue.hpp.
References sycl::_V1::handler::prefetch().
|
inline |
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.
Ptr | is a USM pointer to the memory to be prefetched to the device. |
Count | is a number of bytes to be prefetched. |
DepEvents | is a vector of events that specifies the kernel dependencies. |
Definition at line 737 of file queue.hpp.
References sycl::_V1::handler::depends_on(), and sycl::_V1::handler::prefetch().
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.
Ptr | is a USM pointer to the memory to be prefetched to the device. |
Count | is a number of bytes to be prefetched. |
DepEvent | is an event that specifies the kernel dependencies. |
Definition at line 721 of file queue.hpp.
References sycl::_V1::handler::depends_on(), and sycl::_V1::handler::prefetch().
|
inline |
single_task version with a kernel represented as a lambda.
KernelFunc | is the Kernel functor or lambda |
CodeLoc | contains the code location of user code |
Definition at line 1099 of file queue.hpp.
References _CODELOCFW.
|
inline |
single_task version with a kernel represented as a lambda.
DepEvents | is a vector of events that specifies the kernel dependencies |
KernelFunc | is the Kernel functor or lambda |
CodeLoc | contains the code location of user code |
Definition at line 1184 of file queue.hpp.
References _CODELOCFW.
|
inline |
single_task version with a kernel represented as a lambda.
DepEvents | is a vector of events that specifies the kernel dependencies |
Properties | is the kernel properties. |
KernelFunc | is the Kernel functor or lambda |
CodeLoc | contains the code location of user code |
Definition at line 1158 of file queue.hpp.
References _CODELOCARG, and sycl::_V1::handler::depends_on().
|
inline |
single_task version with a kernel represented as a lambda.
DepEvent | is an event that specifies the kernel dependencies |
KernelFunc | is the Kernel functor or lambda |
CodeLoc | contains the code location of user code |
Definition at line 1140 of file queue.hpp.
References _CODELOCFW.
|
inline |
single_task version with a kernel represented as a lambda.
DepEvent | is an event that specifies the kernel dependencies |
Properties | is the kernel properties. |
KernelFunc | is the Kernel functor or lambda |
CodeLoc | contains the code location of user code |
Definition at line 1115 of file queue.hpp.
References _CODELOCARG, and sycl::_V1::handler::depends_on().
|
inline |
single_task version with a kernel represented as a lambda.
Properties | is the kernel properties. |
KernelFunc | is the Kernel functor or lambda |
CodeLoc | contains the code location of user code |
Definition at line 1076 of file queue.hpp.
References _CODELOCARG.
|
inline |
Submits a command group function object to the queue, in order to be scheduled for execution on the device.
CGF | is a function object containing command group. |
CodeLoc | is the code location of the submit call (default argument) |
Definition at line 307 of file queue.hpp.
References _CODELOCARG, and sycl::_V1::ext::oneapi::experimental::device_has.
|
inline |
Submits a command group function object to the queue, in order to be scheduled for execution on the device.
On a kernel error, this command group function object is then scheduled for execution on a secondary queue.
CGF | is a function object containing command group. |
SecondaryQueue | is a fallback SYCL queue. |
CodeLoc | is the code location of the submit call (default argument) |
Definition at line 343 of file queue.hpp.
References _CODELOCARG, and sycl::_V1::ext::oneapi::experimental::device_has.
|
inline |
Prevents any commands submitted afterward to this queue from executing until all commands previously submitted to this queue have entered the complete state.
CodeLoc | is the code location of the submit call (default argument) |
Definition at line 390 of file queue.hpp.
References _CODELOCARG.
|
inline |
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 submit_barrier has no effect.
WaitList | is a vector of valid SYCL events that need to complete before barrier command can be executed. |
CodeLoc | is the code location of the submit call (default argument) |
Definition at line 422 of file queue.hpp.
References _CODELOCARG.
void sycl::_V1::queue::throw_asynchronous | ( | ) |
|
inline |
Provides guarantees that the memory object accessed via Acc is updated on the host after operation is complete.
Acc | is a SYCL accessor that needs to be updated on host. |
Definition at line 1568 of file queue.hpp.
References _CODELOCFW, sycl::_V1::handler::require(), and sycl::_V1::handler::update_host().
|
inline |
Performs a blocking wait for the completion of all enqueued tasks in the queue.
Synchronous errors will be reported through SYCL exceptions.
CodeLoc | is the code location of the submit call (default argument) |
Definition at line 432 of file queue.hpp.
References _CODELOCARG.
|
inline |
Performs a blocking wait for the completion of all enqueued tasks in the queue.
Synchronous errors will be reported through SYCL exceptions. Asynchronous errors will be passed to the async_handler passed to the queue on construction. If no async_handler was provided then asynchronous exceptions will be lost.
CodeLoc | is the code location of the submit call (default argument) |
Definition at line 446 of file queue.hpp.
References _CODELOCARG.
void sycl::_V1::queue::wait_and_throw_proxy | ( | const detail::code_location & | CodeLoc | ) |
void sycl::_V1::queue::wait_proxy | ( | const detail::code_location & | CodeLoc | ) |
|
friend |
|
friend |
Definition at line 123 of file backend.hpp.
const device_selector const async_handler& sycl::_V1::queue::AsyncHandler |
const device_selector & sycl::_V1::queue::DeviceSelector |
const property_list& sycl::_V1::queue::PropList |
const device_selector const property_list& sycl::_V1::queue::PropList = {}) |
const device_selector const async_handler const property_list& sycl::_V1::queue::PropList = {}) |