sycl::_V1::detail::CG Class Reference

Base class for all types of command groups. More...

#include <sycl/detail/cg.hpp>

Inheritance diagram for sycl::_V1::detail::CG:

Collaboration diagram for sycl::_V1::detail::CG:

Public Types
enum	CGTYPE : unsigned int {   None = 0, Kernel = 1, CopyAccToPtr = 2, CopyPtrToAcc = 3,   CopyAccToAcc = 4, Barrier = 5, BarrierWaitlist = 6, Fill = 7,   UpdateHost = 8, RunOnHostIntel = 9, CopyUSM = 10, FillUSM = 11,   PrefetchUSM = 12, CodeplayInteropTask = 13, CodeplayHostTask = 14, AdviseUSM = 15,   Copy2DUSM = 16, Fill2DUSM = 17, Memset2DUSM = 18, CopyToDeviceGlobal = 19,   CopyFromDeviceGlobal = 20 }
	Type of the command group. More...

Public Member Functions
	CG (CGTYPE Type, std::vector< std::vector< char >> ArgsStorage, std::vector< detail::AccessorImplPtr > AccStorage, std::vector< std::shared_ptr< const void >> SharedPtrStorage, std::vector< AccessorImplHost * > Requirements, std::vector< detail::EventImplPtr > Events, detail::code_location loc={})
	CG (CG &&CommandGroup)=default
CGTYPE	getType ()
std::vector< std::vector< char > > &	getArgsStorage ()
std::vector< detail::AccessorImplPtr > &	getAccStorage ()
virtual	~CG ()=default

Public Attributes
std::vector< AccessorImplHost * >	MRequirements
	List of requirements that specify which memory is needed for the command group to be executed. More...
std::vector< detail::EventImplPtr >	MEvents
	List of events that order the execution of this CG. More...
std::string	MFunctionName
std::string	MFileName
int32_t	MLine
int32_t	MColumn

Detailed Description

Base class for all types of command groups.

Definition at line 52 of file cg.hpp.

Member Enumeration Documentation

CGTYPE

enum sycl::_V1::detail::CG::CGTYPE : unsigned int

Type of the command group.

Enumerator
None
Kernel
CopyAccToPtr
CopyPtrToAcc
CopyAccToAcc
Barrier
BarrierWaitlist
Fill
UpdateHost
RunOnHostIntel
CopyUSM
FillUSM
PrefetchUSM
CodeplayInteropTask
CodeplayHostTask
AdviseUSM
Copy2DUSM
Fill2DUSM
Memset2DUSM
CopyToDeviceGlobal
CopyFromDeviceGlobal

Definition at line 55 of file cg.hpp.

Constructor & Destructor Documentation

CG() [1/2]

sycl::_V1::detail::CG::CG ( CGTYPE  Type, std::vector< std::vector< char >>  ArgsStorage, std::vector< detail::AccessorImplPtr >  AccStorage, std::vector< std::shared_ptr< const void >>  SharedPtrStorage, std::vector< AccessorImplHost * >  Requirements, std::vector< detail::EventImplPtr >  Events, detail::code_location  loc = {}  )

inline

Definition at line 79 of file cg.hpp.

CG() [2/2]

sycl::_V1::detail::CG::CG ( CG &&  CommandGroup )

default

~CG()

virtual sycl::_V1::detail::CG::~CG ( )

virtualdefault

Member Function Documentation

getAccStorage()

std::vector<detail::AccessorImplPtr>& sycl::_V1::detail::CG::getAccStorage ( )

inline

Definition at line 105 of file cg.hpp.

getArgsStorage()

std::vector<std::vector<char> >& sycl::_V1::detail::CG::getArgsStorage ( )

inline

Definition at line 103 of file cg.hpp.

getType()

CGTYPE sycl::_V1::detail::CG::getType ( )

inline

Definition at line 101 of file cg.hpp.

Referenced by sycl::_V1::detail::isInteropHostTask(), and sycl::_V1::detail::DispatchHostTask::operator()().

Member Data Documentation

MColumn

int32_t sycl::_V1::detail::CG::MColumn

Definition at line 131 of file cg.hpp.

MEvents

std::vector<detail::EventImplPtr> sycl::_V1::detail::CG::MEvents

List of events that order the execution of this CG.

Definition at line 125 of file cg.hpp.

MFileName

std::string sycl::_V1::detail::CG::MFileName

Definition at line 129 of file cg.hpp.

MFunctionName

std::string sycl::_V1::detail::CG::MFunctionName

Definition at line 129 of file cg.hpp.

MLine

int32_t sycl::_V1::detail::CG::MLine

Definition at line 131 of file cg.hpp.

MRequirements

std::vector<AccessorImplHost *> sycl::_V1::detail::CG::MRequirements

List of requirements that specify which memory is needed for the command group to be executed.

Definition at line 123 of file cg.hpp.

---

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

• include/sycl/detail/cg.hpp