DPC++ Runtime
Runtime libraries for oneAPI DPC++
cl::sycl::detail::Command Class Referenceabstract

The Command class represents some action that needs to be performed on one or more memory objects. More...

#include <detail/scheduler/commands.hpp>

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

Classes

struct  Marks
 

Public Types

enum  CommandType {
  RUN_CG, COPY_MEMORY, ALLOCA, ALLOCA_SUB_BUF,
  RELEASE, MAP_MEM_OBJ, UNMAP_MEM_OBJ, UPDATE_REQUIREMENT,
  EMPTY_TASK, HOST_TASK
}
 
enum  BlockReason : int { BlockReason::HostAccessor = 0, BlockReason::HostTask }
 

Public Member Functions

 Command (CommandType Type, QueueImplPtr Queue)
 It is safe to bind MPreparedDepsEvents and MPreparedHostDepsEvents references to event_impl class members because Command should not outlive the event connected to it. More...
 
CommandaddDep (DepDesc NewDep, std::vector< Command * > &ToCleanUp)
 
CommandaddDep (EventImplPtr Event, std::vector< Command * > &ToCleanUp)
 
void addUser (Command *NewUser)
 
CommandType getType () const
 
virtual bool enqueue (EnqueueResultT &EnqueueResult, BlockingT Blocking, std::vector< Command * > &ToCleanUp)
 Checks if the command is enqueued, and calls enqueueImp. More...
 
bool isFinished ()
 
bool isSuccessfullyEnqueued () const
 
bool isEnqueueBlocked () const
 
const QueueImplPtrgetQueue () const
 
const QueueImplPtrgetSubmittedQueue () const
 
const EventImplPtrgetEvent () const
 
void emitInstrumentationDataProxy ()
 Proxy method which calls emitInstrumentationData. More...
 
virtual void emitInstrumentationData ()=0
 Instrumentation method which emits telemetry data. More...
 
void resolveReleaseDependencies (std::set< Command * > &list)
 Looks at all the dependencies for the release command and enables instrumentation to report these dependencies as edges. More...
 
void emitEdgeEventForCommandDependence (Command *Cmd, void *ObjAddr, bool IsCommand, std::optional< access::mode > AccMode=std::nullopt)
 Creates an edge event when the dependency is a command. More...
 
void emitEdgeEventForEventDependence (Command *Cmd, RT::PiEvent &EventAddr)
 Creates an edge event when the dependency is an event. More...
 
void emitEnqueuedEventSignal (RT::PiEvent &PiEventAddr)
 Creates a signal event with the enqueued kernel event handle. More...
 
uint64_t makeTraceEventProlog (void *MAddress)
 Create a trace event of node_create type; this must be guarded by a check for xptiTraceEnabled(). More...
 
void makeTraceEventEpilog ()
 If prolog has been run, run epilog; this must be guarded by a check for xptiTraceEnabled(). More...
 
void emitInstrumentation (uint16_t Type, const char *Txt=nullptr)
 Emits an event of Type. More...
 
virtual void printDot (std::ostream &Stream) const =0
 
virtual const RequirementgetRequirement () const
 
virtual ~Command ()
 
const chargetBlockReason () const
 
virtual const ContextImplPtrgetWorkerContext () const
 Get the context of the queue this command will be submitted to. More...
 
virtual const QueueImplPtrgetWorkerQueue () const
 Get the queue this command will be submitted to. More...
 
virtual bool producesPiEvent () const
 Returns true iff the command produces a PI event on non-host devices. More...
 
virtual bool supportsPostEnqueueCleanup () const
 Returns true iff this command can be freed by post enqueue cleanup. More...
 
const std::vector< EventImplPtr > & getPreparedHostDepsEvents () const
 

Public Attributes

std::vector< DepDescMDeps
 Contains list of dependencies(edges) More...
 
std::unordered_set< Command * > MUsers
 Contains list of commands that depend on the command. More...
 
bool MIsBlockable = false
 Indicates whether the command can be blocked from enqueueing. More...
 
unsigned MLeafCounter = 0
 Counts the number of memory objects this command is a leaf for. More...
 
Marks MMarks
 Used for marking the node during graph traversal. More...
 
BlockReason MBlockReason
 
std::atomic< EnqueueResultT::ResultTMEnqueueStatus
 Describes the status of the command. More...
 
void * MTraceEvent = nullptr
 The event for node_create and task_begin. More...
 
int32_t MStreamID = -1
 The stream under which the traces are emitted. More...
 
void * MAddress = nullptr
 Reserved for storing the object address such as SPIR-V or memory object address. More...
 
std::string MAddressString
 Buffer to build the address string. More...
 
std::string MCommandNodeType
 Buffer to build the command node type. More...
 
std::string MCommandName
 Buffer to build the command end-user understandable name. More...
 
bool MTraceEventPrologComplete = false
 Flag to indicate if makeTraceEventProlog() has been run. More...
 
bool MFirstInstance = false
 Flag to indicate if this is the first time we are seeing this payload. More...
 
uint64_t MInstanceID = 0
 Instance ID tracked for the command. More...
 
bool MShouldCompleteEventIfPossible = true
 
bool MPostEnqueueCleanup = false
 Indicates that the node will be freed by cleanup after enqueue. More...
 

Protected Member Functions

void waitForEvents (QueueImplPtr Queue, std::vector< EventImplPtr > &RawEvents, RT::PiEvent &Event)
 
void waitForPreparedHostEvents () const
 
CommandprocessDepEvent (EventImplPtr DepEvent, const DepDesc &Dep, std::vector< Command * > &ToCleanUp)
 Perform glueing of events from different contexts. More...
 
virtual pi_int32 enqueueImp ()=0
 Private interface. Derived classes should implement this method. More...
 

Protected Attributes

QueueImplPtr MQueue
 
QueueImplPtr MSubmittedQueue
 
EventImplPtr MEvent
 
std::vector< EventImplPtr > & MPreparedDepsEvents
 Dependency events prepared for waiting by backend. More...
 
std::vector< EventImplPtr > & MPreparedHostDepsEvents
 
CommandType MType
 The type of the command. More...
 
std::mutex MEnqueueMtx
 Mutex used to protect enqueueing from race conditions. More...
 

Friends

class DispatchHostTask
 

Detailed Description

The Command class represents some action that needs to be performed on one or more memory objects.

The Command has a vector of DepDesc objects that represent dependencies of the command. It has a vector of pointers to commands that depend on the command. It has a pointer to a queue object and an event that is associated with the command.

Definition at line 95 of file commands.hpp.

Member Enumeration Documentation

◆ BlockReason

Enumerator
HostAccessor 
HostTask 

Definition at line 273 of file commands.hpp.

◆ CommandType

Enumerator
RUN_CG 
COPY_MEMORY 
ALLOCA 
ALLOCA_SUB_BUF 
RELEASE 
MAP_MEM_OBJ 
UNMAP_MEM_OBJ 
UPDATE_REQUIREMENT 
EMPTY_TASK 
HOST_TASK 

Definition at line 97 of file commands.hpp.

Constructor & Destructor Documentation

◆ Command()

cl::sycl::detail::Command::Command ( CommandType  Type,
QueueImplPtr  Queue 
)

It is safe to bind MPreparedDepsEvents and MPreparedHostDepsEvents references to event_impl class members because Command should not outlive the event connected to it.

Definition at line 393 of file commands.cpp.

References MEnqueueStatus, MEvent, MQueue, MStreamID, MSubmittedQueue, cl::sycl::detail::SYCL_STREAM_NAME, and cl::sycl::detail::EnqueueResultT::SyclEnqueueReady.

◆ ~Command()

virtual cl::sycl::detail::Command::~Command ( )
inlinevirtual

Definition at line 192 of file commands.hpp.

Member Function Documentation

◆ addDep() [1/2]

◆ addDep() [2/2]

Command * cl::sycl::detail::Command::addDep ( EventImplPtr  Event,
std::vector< Command * > &  ToCleanUp 
)
Parameters
NewDepdependency to be added
ToCleanUpcontainer for commands that can be cleaned up.
Returns
an optional connection cmd to enqueue

Definition at line 657 of file commands.cpp.

References emitEdgeEventForEventDependence(), and processDepEvent().

◆ addUser()

void cl::sycl::detail::Command::addUser ( Command NewUser)
inline

◆ emitEdgeEventForCommandDependence()

void cl::sycl::detail::Command::emitEdgeEventForCommandDependence ( Command Cmd,
void *  ObjAddr,
bool  IsCommand,
std::optional< access::mode AccMode = std::nullopt 
)

Creates an edge event when the dependency is a command.

Method takes in void * for the address as adding a template function to the command group object maybe undesirable.

Parameters
CmdThe command object of the source of the edge
ObjAddrThe address that defines the edge dependency; it is the event address when the edge is for an event and a memory object address if it is due to an accessor
PrefixContains "event" if the dependency is an edge and contains the access mode to the buffer if it is due to an accessor
IsCommandTrue if the dependency has a command object as the source, false otherwise

Definition at line 429 of file commands.cpp.

References cl::sycl::detail::accessModeToString(), MAddress, MStreamID, and MTraceEvent.

Referenced by addDep(), and emitEdgeEventForEventDependence().

◆ emitEdgeEventForEventDependence()

void cl::sycl::detail::Command::emitEdgeEventForEventDependence ( Command Cmd,
RT::PiEvent PiEventAddr 
)

Creates an edge event when the dependency is an event.

Creates an edge when the dependency is due to an event.

Parameters
CmdThe command object of the source of the edge
PiEventAddrThe address that defines the edge dependency, which in this case is an event

Definition at line 478 of file commands.cpp.

References emitEdgeEventForCommandDependence(), MAddress, MStreamID, and MTraceEvent.

Referenced by addDep().

◆ emitEnqueuedEventSignal()

void cl::sycl::detail::Command::emitEnqueuedEventSignal ( RT::PiEvent PiEventAddr)

Creates a signal event with the enqueued kernel event handle.

Definition at line 672 of file commands.cpp.

References MInstanceID, MStreamID, and MTraceEvent.

Referenced by enqueue().

◆ emitInstrumentation()

void cl::sycl::detail::Command::emitInstrumentation ( uint16_t  Type,
const char Txt = nullptr 
)

Emits an event of Type.

Definition at line 684 of file commands.cpp.

References MInstanceID, MStreamID, and MTraceEvent.

Referenced by enqueue().

◆ emitInstrumentationData()

◆ emitInstrumentationDataProxy()

◆ enqueue()

bool cl::sycl::detail::Command::enqueue ( EnqueueResultT EnqueueResult,
BlockingT  Blocking,
std::vector< Command * > &  ToCleanUp 
)
virtual

Checks if the command is enqueued, and calls enqueueImp.

Parameters
EnqueueResultis set to the specific status if enqueue failed.
Blockingif this argument is true, function will wait for the command to be unblocked before calling enqueueImp.
ToCleanUpcontainer for commands that can be cleaned up.
Returns
true if the command is enqueued.

Definition at line 695 of file commands.cpp.

References emitEnqueuedEventSignal(), emitInstrumentation(), enqueueImp(), getBlockReason(), MEnqueueMtx, MEnqueueStatus, MEvent, MIsBlockable, MLeafCounter, MPostEnqueueCleanup, MShouldCompleteEventIfPossible, supportsPostEnqueueCleanup(), cl::sycl::detail::EnqueueResultT::SyclEnqueueBlocked, cl::sycl::detail::EnqueueResultT::SyclEnqueueFailed, and cl::sycl::detail::EnqueueResultT::SyclEnqueueSuccess.

Referenced by cl::sycl::detail::Scheduler::GraphProcessor::enqueueCommand().

◆ enqueueImp()

virtual pi_int32 cl::sycl::detail::Command::enqueueImp ( )
protectedpure virtual

Private interface. Derived classes should implement this method.

Referenced by enqueue().

◆ getBlockReason()

const char * cl::sycl::detail::Command::getBlockReason ( ) const

Definition at line 823 of file commands.cpp.

References HostAccessor, HostTask, and MBlockReason.

Referenced by enqueue().

◆ getEvent()

◆ getPreparedHostDepsEvents()

const std::vector<EventImplPtr>& cl::sycl::detail::Command::getPreparedHostDepsEvents ( ) const
inline

◆ getQueue()

◆ getRequirement()

◆ getSubmittedQueue()

const QueueImplPtr& cl::sycl::detail::Command::getSubmittedQueue ( ) const
inline

Definition at line 151 of file commands.hpp.

Referenced by cl::sycl::detail::event_impl::wait_and_throw().

◆ getType()

◆ getWorkerContext()

const ContextImplPtr & cl::sycl::detail::Command::getWorkerContext ( ) const
virtual

Get the context of the queue this command will be submitted to.

Could differ from the context of MQueue for memory copy commands.

Reimplemented in cl::sycl::detail::MemCpyCommandHost, and cl::sycl::detail::MemCpyCommand.

Definition at line 619 of file commands.cpp.

References MQueue.

Referenced by cl::sycl::detail::Scheduler::GraphBuilder::connectDepEvent().

◆ getWorkerQueue()

const QueueImplPtr & cl::sycl::detail::Command::getWorkerQueue ( ) const
virtual

Get the queue this command will be submitted to.

Could differ from MQueue for memory copy commands.

Reimplemented in cl::sycl::detail::MemCpyCommandHost, and cl::sycl::detail::MemCpyCommand.

Definition at line 623 of file commands.cpp.

References MQueue.

Referenced by processDepEvent().

◆ isEnqueueBlocked()

bool cl::sycl::detail::Command::isEnqueueBlocked ( ) const
inline

◆ isFinished()

bool cl::sycl::detail::Command::isFinished ( )

◆ isSuccessfullyEnqueued()

◆ makeTraceEventEpilog()

◆ makeTraceEventProlog()

◆ printDot()

◆ processDepEvent()

Command * cl::sycl::detail::Command::processDepEvent ( EventImplPtr  DepEvent,
const DepDesc Dep,
std::vector< Command * > &  ToCleanUp 
)
protected

Perform glueing of events from different contexts.

Parameters
DepEventevent this commands should depend on
Depoptional DepDesc to perform connection of events properly
ToCleanUpcontainer for commands that can be cleaned up.
Returns
returns an optional connection command to enqueue

Glueing (i.e. connecting) will be performed if and only if DepEvent is not from host context and its context doesn't match to context of this command. Context of this command is fetched via getWorkerContext().

Optionality of Dep is set by Dep.MDepCommand not equal to nullptr.

Definition at line 579 of file commands.cpp.

References cl::sycl::detail::Scheduler::GraphBuilder::connectDepEvent(), cl::sycl::detail::Scheduler::getInstance(), getType(), getWorkerQueue(), cl::sycl::detail::DepDesc::MDepCommand, cl::sycl::detail::Scheduler::MGraphBuilder, MPreparedDepsEvents, and MPreparedHostDepsEvents.

Referenced by addDep().

◆ producesPiEvent()

bool cl::sycl::detail::Command::producesPiEvent ( ) const
virtual

◆ resolveReleaseDependencies()

void cl::sycl::detail::Command::resolveReleaseDependencies ( std::set< Command * > &  list)

Looks at all the dependencies for the release command and enables instrumentation to report these dependencies as edges.

Definition at line 781 of file commands.cpp.

References MAddress, MStreamID, MTraceEvent, and MType.

Referenced by cl::sycl::detail::Scheduler::waitForRecordToFinish().

◆ supportsPostEnqueueCleanup()

bool cl::sycl::detail::Command::supportsPostEnqueueCleanup ( ) const
virtual

◆ waitForEvents()

void cl::sycl::detail::Command::waitForEvents ( QueueImplPtr  Queue,
std::vector< EventImplPtr > &  RawEvents,
RT::PiEvent Event 
)
protected

◆ waitForPreparedHostEvents()

void cl::sycl::detail::Command::waitForPreparedHostEvents ( ) const
protected

Definition at line 334 of file commands.cpp.

Friends And Related Function Documentation

◆ DispatchHostTask

friend class DispatchHostTask
friend

Definition at line 248 of file commands.hpp.

Member Data Documentation

◆ MAddress

◆ MAddressString

std::string cl::sycl::detail::Command::MAddressString

Buffer to build the address string.

Definition at line 296 of file commands.hpp.

Referenced by makeTraceEventProlog().

◆ MBlockReason

BlockReason cl::sycl::detail::Command::MBlockReason

Definition at line 276 of file commands.hpp.

Referenced by getBlockReason(), and cl::sycl::detail::isHostAccessorCmd().

◆ MCommandName

std::string cl::sycl::detail::Command::MCommandName

Buffer to build the command end-user understandable name.

Definition at line 300 of file commands.hpp.

Referenced by makeTraceEventProlog().

◆ MCommandNodeType

std::string cl::sycl::detail::Command::MCommandNodeType

Buffer to build the command node type.

Definition at line 298 of file commands.hpp.

Referenced by makeTraceEventEpilog(), and makeTraceEventProlog().

◆ MDeps

◆ MEnqueueMtx

std::mutex cl::sycl::detail::Command::MEnqueueMtx
protected

Mutex used to protect enqueueing from race conditions.

Definition at line 246 of file commands.hpp.

Referenced by enqueue().

◆ MEnqueueStatus

std::atomic<EnqueueResultT::ResultT> cl::sycl::detail::Command::MEnqueueStatus

Describes the status of the command.

Definition at line 279 of file commands.hpp.

Referenced by Command(), enqueue(), cl::sycl::detail::DispatchHostTask::operator()(), and cl::sycl::detail::Scheduler::releaseHostAccessor().

◆ MEvent

◆ MFirstInstance

◆ MInstanceID

uint64_t cl::sycl::detail::Command::MInstanceID = 0

◆ MIsBlockable

bool cl::sycl::detail::Command::MIsBlockable = false

Indicates whether the command can be blocked from enqueueing.

Definition at line 260 of file commands.hpp.

Referenced by enqueue().

◆ MLeafCounter

◆ MMarks

Marks cl::sycl::detail::Command::MMarks

◆ MPostEnqueueCleanup

bool cl::sycl::detail::Command::MPostEnqueueCleanup = false

Indicates that the node will be freed by cleanup after enqueue.

Such nodes should be ignored by other cleanup mechanisms.

Definition at line 318 of file commands.hpp.

Referenced by cl::sycl::detail::Scheduler::GraphBuilder::cleanupFinishedCommands(), and enqueue().

◆ MPreparedDepsEvents

std::vector<EventImplPtr>& cl::sycl::detail::Command::MPreparedDepsEvents
protected

Dependency events prepared for waiting by backend.

See processDepEvent for details.

Definition at line 217 of file commands.hpp.

Referenced by processDepEvent().

◆ MPreparedHostDepsEvents

std::vector<EventImplPtr>& cl::sycl::detail::Command::MPreparedHostDepsEvents
protected

Definition at line 218 of file commands.hpp.

Referenced by processDepEvent().

◆ MQueue

◆ MShouldCompleteEventIfPossible

bool cl::sycl::detail::Command::MShouldCompleteEventIfPossible = true

Definition at line 314 of file commands.hpp.

Referenced by enqueue().

◆ MStreamID

int32_t cl::sycl::detail::Command::MStreamID = -1

The stream under which the traces are emitted.

Stream ids are positive integers and we set it to an invalid value.

Definition at line 291 of file commands.hpp.

Referenced by Command(), emitEdgeEventForCommandDependence(), emitEdgeEventForEventDependence(), emitEnqueuedEventSignal(), emitInstrumentation(), cl::sycl::detail::ExecCGCommand::emitInstrumentationData(), makeTraceEventEpilog(), and resolveReleaseDependencies().

◆ MSubmittedQueue

QueueImplPtr cl::sycl::detail::Command::MSubmittedQueue
protected

Definition at line 212 of file commands.hpp.

Referenced by Command(), and cl::sycl::detail::ExecCGCommand::ExecCGCommand().

◆ MTraceEvent

◆ MTraceEventPrologComplete

bool cl::sycl::detail::Command::MTraceEventPrologComplete = false

Flag to indicate if makeTraceEventProlog() has been run.

Definition at line 302 of file commands.hpp.

Referenced by makeTraceEventEpilog(), and makeTraceEventProlog().

◆ MType

CommandType cl::sycl::detail::Command::MType
protected

◆ MUsers


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