DPC++ Runtime
Runtime libraries for oneAPI DPC++
cl::sycl::detail::CG Class Reference

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

#include <CL/sycl/detail/cg.hpp>

Inheritance diagram for cl::sycl::detail::CG:
Collaboration diagram for cl::sycl::detail::CG:

Public Types

enum  CG_VERSION : unsigned char { CG_VERSION::V0 = 0, CG_VERSION::V1 = 1 }
 
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
}
 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< Requirement * > Requirements, std::vector< detail::EventImplPtr > Events, detail::code_location loc={})
 
 CG (CG &&CommandGroup)=default
 
CGTYPE getType ()
 
CG_VERSION getVersion ()
 
std::shared_ptr< std::vector< ExtendedMemberT > > getExtendedMembers ()
 
virtual ~CG ()=default
 

Public Attributes

std::vector< Requirement * > MRequirements
 List of requirements that specify which memory is needed for the command group to be executed. More...
 
std::vector< detail::EventImplPtrMEvents
 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 144 of file cg.hpp.

Member Enumeration Documentation

◆ CG_VERSION

enum cl::sycl::detail::CG::CG_VERSION : unsigned char
strong
Enumerator
V0 
V1 

Definition at line 150 of file cg.hpp.

◆ CGTYPE

enum cl::sycl::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 

Definition at line 156 of file cg.hpp.

Constructor & Destructor Documentation

◆ CG() [1/2]

cl::sycl::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< Requirement * >  Requirements,
std::vector< detail::EventImplPtr Events,
detail::code_location  loc = {} 
)
inline

Definition at line 175 of file cg.hpp.

◆ CG() [2/2]

cl::sycl::detail::CG::CG ( CG &&  CommandGroup)
default

◆ ~CG()

virtual cl::sycl::detail::CG::~CG ( )
virtualdefault

Member Function Documentation

◆ getExtendedMembers()

std::shared_ptr<std::vector<ExtendedMemberT> > cl::sycl::detail::CG::getExtendedMembers ( )
inline

◆ getType()

CGTYPE cl::sycl::detail::CG::getType ( )
inline

◆ getVersion()

CG_VERSION cl::sycl::detail::CG::getVersion ( )
inline

Definition at line 199 of file cg.hpp.

References cl::sycl::detail::getCGTypeVersion().

Member Data Documentation

◆ MColumn

int32_t cl::sycl::detail::CG::MColumn

Definition at line 237 of file cg.hpp.

◆ MEvents

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

List of events that order the execution of this CG.

Definition at line 231 of file cg.hpp.

◆ MFileName

std::string cl::sycl::detail::CG::MFileName

Definition at line 235 of file cg.hpp.

◆ MFunctionName

std::string cl::sycl::detail::CG::MFunctionName

Definition at line 235 of file cg.hpp.

◆ MLine

int32_t cl::sycl::detail::CG::MLine

Definition at line 237 of file cg.hpp.

◆ MRequirements

std::vector<Requirement *> cl::sycl::detail::CG::MRequirements

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

Definition at line 229 of file cg.hpp.


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