[SYCL][Doc] Add Graph Scheduler design documentation

sycl/include/CL/sycl/detail/cg.hpp

@@ -35,11 +35,12 @@ class interop_handler {
   template <typename DataT, int Dims, access::mode AccMode,
             access::target AccTarget, access::placeholder isPlaceholder>
   friend class accessor;
+
 public:
-  using ReqToMem = std::pair<detail::Requirement*, pi_mem>;
+  using ReqToMem = std::pair<detail::Requirement *, pi_mem>;
 
-  interop_handler(std::vector<ReqToMem> MemObjs, cl_command_queue PiQueue) :
-    MQueue(PiQueue), MMemObjs(MemObjs) {}
+  interop_handler(std::vector<ReqToMem> MemObjs, cl_command_queue PiQueue)
+      : MQueue(PiQueue), MMemObjs(MemObjs) {}
 
   cl_command_queue get_queue() const noexcept { return MQueue; };
 
@@ -52,10 +53,11 @@ class interop_handler {
     detail::AccessorBaseHost *AccBase = (detail::AccessorBaseHost *)&Acc;
     return getMemImpl(detail::getSyclObjImpl(*AccBase).get());
   }
+
 private:
   cl_command_queue MQueue;
   std::vector<ReqToMem> MMemObjs;
-  cl_mem getMemImpl(detail::Requirement* Req) const;
+  cl_mem getMemImpl(detail::Requirement *Req) const;
 };
 
 namespace detail {
@@ -274,8 +276,7 @@ class HostKernel : public HostKernelBase {
   template <class ArgT = KernelArgType>
   typename std::enable_if<std::is_same<ArgT, nd_item<Dims>>::value>::type
   runOnHost(const NDRDescT &NDRDesc) {
-    sycl::range<Dims> GroupSize(
-        InitializedVal<Dims, range>::template get<0>());
+    sycl::range<Dims> GroupSize(InitializedVal<Dims, range>::template get<0>());
     for (int I = 0; I < Dims; ++I) {
       if (NDRDesc.LocalSize[I] == 0 ||
           NDRDesc.GlobalSize[I] % NDRDesc.LocalSize[I] != 0)
@@ -284,8 +285,7 @@ class HostKernel : public HostKernelBase {
       GroupSize[I] = NDRDesc.GlobalSize[I] / NDRDesc.LocalSize[I];
     }
 
-    sycl::range<Dims> LocalSize(
-        InitializedVal<Dims, range>::template get<0>());
+    sycl::range<Dims> LocalSize(InitializedVal<Dims, range>::template get<0>());
     sycl::range<Dims> GlobalSize(
         InitializedVal<Dims, range>::template get<0>());
     sycl::id<Dims> GlobalOffset;
@@ -326,10 +326,9 @@ class HostKernel : public HostKernelBase {
       NGroups[I] = NDRDesc.GlobalSize[I] / NDRDesc.LocalSize[I];
     }
 
-    sycl::range<Dims> LocalSize(
-      InitializedVal<Dims, range>::template get<0>());
+    sycl::range<Dims> LocalSize(InitializedVal<Dims, range>::template get<0>());
     sycl::range<Dims> GlobalSize(
-      InitializedVal<Dims, range>::template get<0>());
+        InitializedVal<Dims, range>::template get<0>());
     for (int I = 0; I < Dims; ++I) {
       LocalSize[I] = NDRDesc.LocalSize[I];
       GlobalSize[I] = NDRDesc.GlobalSize[I];
@@ -345,10 +344,10 @@ class HostKernel : public HostKernelBase {
 };
 
 class stream_impl;
-// The base class for all types of command groups.
+/// Base class for all types of command groups.
 class CG {
 public:
-  // Type of the command group.
+  /// Type of the command group.
   enum CGTYPE {
     NONE,
     KERNEL,
@@ -392,20 +391,20 @@ class CG {
 
 private:
   CGTYPE MType;
-  // The following storages needed to ensure that arguments won't die while
+  // The following storages are needed to ensure that arguments won't die while
   // we are using them.
-  // Storage for standard layout arguments.
+  /// Storage for standard layout arguments.
   vector_class<vector_class<char>> MArgsStorage;
-  // Storage for accessors.
+  /// Storage for accessors.
   vector_class<detail::AccessorImplPtr> MAccStorage;
-  // Storage for shared_ptrs.
+  /// Storage for shared_ptrs.
   vector_class<shared_ptr_class<const void>> MSharedPtrStorage;
 
 public:
-  // List of requirements that specify which memory is needed for the command
-  // group to be executed.
+  /// List of requirements that specify which memory is needed for the command
+  /// group to be executed.
   vector_class<Requirement *> MRequirements;
-  // List of events that order the execution of this CG
+  /// List of events that order the execution of this CG
   vector_class<detail::EventImplPtr> MEvents;
   // Member variables to capture the user code-location
   // information from Q.submit(), Q.parallel_for() etc
@@ -415,9 +414,10 @@ class CG {
   int32_t MLine, MColumn;
 };
 
-// The class which represents "execute kernel" command group.
+/// "Execute kernel" command group class.
 class CGExecKernel : public CG {
 public:
+  /// Stores ND-range description.
   NDRDescT MNDRDesc;
   unique_ptr_class<HostKernelBase> MHostKernel;
   shared_ptr_class<detail::kernel_impl> MSyclKernel;
@@ -455,7 +455,7 @@ class CGExecKernel : public CG {
   }
 };
 
-// The class which represents "copy" command group.
+/// "Copy memory" command group class.
 class CGCopy : public CG {
   void *MSrc;
   void *MDst;
@@ -476,7 +476,7 @@ class CGCopy : public CG {
   void *getDst() { return MDst; }
 };
 
-// The class which represents "fill" command group.
+/// "Fill memory" command group class.
 class CGFill : public CG {
 public:
   vector_class<char> MPattern;
@@ -496,7 +496,7 @@ class CGFill : public CG {
   Requirement *getReqToFill() { return MPtr; }
 };
 
-// The class which represents "update host" command group.
+/// "Update host" command group class.
 class CGUpdateHost : public CG {
   Requirement *MPtr;
 
@@ -515,7 +515,7 @@ class CGUpdateHost : public CG {
   Requirement *getReqToUpdate() { return MPtr; }
 };
 
-// The class which represents "copy" command group for USM pointers.
+/// "Copy USM" command group class.
 class CGCopyUSM : public CG {
   void *MSrc;
   void *MDst;
@@ -539,7 +539,7 @@ class CGCopyUSM : public CG {
   size_t getLength() { return MLength; }
 };
 
-// The class which represents "fill" command group for USM pointers.
+/// "Fill USM" command group class.
 class CGFillUSM : public CG {
   vector_class<char> MPattern;
   void *MDst;
@@ -562,7 +562,7 @@ class CGFillUSM : public CG {
   int getFill() { return MPattern[0]; }
 };
 
-// The class which represents "prefetch" command group for USM pointers.
+/// "Prefetch USM" command group class.
 class CGPrefetchUSM : public CG {
   void *MDst;
   size_t MLength;