More comments, renaming.

Author: romanovvlad

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

@@ -39,32 +39,50 @@ class queue;
 
 namespace detail {
 
+// Used to represent a type of an extended member
 enum class ExtendedMembersType: unsigned int {
   HANDLER_KERNEL_BUNDLE = 0,
 };
 
-struct ExtendedMember {
+// Holds a pointer to an object of an arbitrary type and an ID value which
+// should be used to understand what type pointer points to.
+// Used as to extend handler class without introducing new class members which
+// would change handler layout.
+struct ExtendedMemberT {
   ExtendedMembersType MType;
   std::shared_ptr<void> MData;
 };
 
-static std::shared_ptr<std::vector<ExtendedMember>>
+static std::shared_ptr<std::vector<ExtendedMemberT>>
 convertToExtendedMembers(const std::shared_ptr<const void> &SPtr) {
-  return std::const_pointer_cast<std::vector<ExtendedMember>>(
-      std::static_pointer_cast<const std::vector<ExtendedMember>>(SPtr));
+  return std::const_pointer_cast<std::vector<ExtendedMemberT>>(
+      std::static_pointer_cast<const std::vector<ExtendedMemberT>>(SPtr));
 }
 
 class stream_impl;
 class queue_impl;
 class kernel_bundle_impl;
 
+// The version of CG type is encoded in the higher byte of the value:
+//
+// 0x00000001 - CG type KERNEL version 0
+// 0x01000001 - CG type KERNEL version 1
+//   /\
+//   ||
+// The byte describes the version
+//
+// The constant is used to shift left CG type value to access it's version
+constexpr unsigned int ShiftBitsForVersion = 24;
+
+// Constructs versioned type
 constexpr static unsigned int getVersionedCGType(unsigned int Type,
                                                  unsigned char Version) {
-  return Type | ((unsigned int)Version << 24);
+  return Type | ((unsigned int)Version << ShiftBitsForVersion);
 }
 
+// Returns the version encoded to the type
 constexpr static unsigned char getCGTypeVersion(unsigned int Type) {
-  return Type >> 24;
+  return Type >> ShiftBitsForVersion;
 }
 
 /// Base class for all types of command groups.
@@ -120,7 +138,7 @@ class CG {
 
   CGTYPE getType() { return MType; }
 
-  std::shared_ptr<std::vector<ExtendedMember>> getExtendedMembers() {
+  std::shared_ptr<std::vector<ExtendedMemberT>> getExtendedMembers() {
     if (getCGTypeVersion(MType) == CG_VERSION::V0 || MSharedPtrStorage.empty())
       return nullptr;
 
@@ -195,11 +213,11 @@ class CGExecKernel : public CG {
   }
 
   std::shared_ptr<detail::kernel_bundle_impl> getKernelBundle() {
-    const std::shared_ptr<std::vector<ExtendedMember>> &ExtendedMembers =
+    const std::shared_ptr<std::vector<ExtendedMemberT>> &ExtendedMembers =
         getExtendedMembers();
     if (!ExtendedMembers)
       return nullptr;
-    for (const ExtendedMember &EMember : *ExtendedMembers)
+    for (const ExtendedMemberT &EMember : *ExtendedMembers)
       if (ExtendedMembersType::HANDLER_KERNEL_BUNDLE == EMember.MType)
         return std::static_pointer_cast<detail::kernel_bundle_impl>(
             EMember.MData);

sycl/include/CL/sycl/handler.hpp

@@ -317,7 +317,7 @@ class __SYCL_EXPORT handler {
   handler(shared_ptr_class<detail::queue_impl> Queue, bool IsHost)
       : MQueue(std::move(Queue)), MIsHost(IsHost) {
     MSharedPtrStorage.emplace_back(
-        std::make_shared<std::vector<detail::ExtendedMember>>());
+        std::make_shared<std::vector<detail::ExtendedMemberT>>());
   }
 
   /// Stores copy of Arg passed to the MArgsStorage.

sycl/source/handler.cpp

@@ -29,11 +29,11 @@ handler::getOrInsertHandlerKernelBundle(bool Insert) {
   assert(!MSharedPtrStorage.empty());
 
   // TODO: Add mutex
-  std::shared_ptr<std::vector<detail::ExtendedMember>> ExendedMembersVec =
+  std::shared_ptr<std::vector<detail::ExtendedMemberT>> ExendedMembersVec =
       detail::convertToExtendedMembers(MSharedPtrStorage[0]);
 
   std::shared_ptr<detail::kernel_bundle_impl> KernelBundleImpPtr;
-  for (const detail::ExtendedMember &EMember : *ExendedMembersVec)
+  for (const detail::ExtendedMemberT &EMember : *ExendedMembersVec)
     if (detail::ExtendedMembersType::HANDLER_KERNEL_BUNDLE == EMember.MType) {
       KernelBundleImpPtr =
           std::static_pointer_cast<detail::kernel_bundle_impl>(EMember.MData);
@@ -45,7 +45,7 @@ handler::getOrInsertHandlerKernelBundle(bool Insert) {
     KernelBundleImpPtr = detail::getSyclObjImpl(
         get_kernel_bundle<bundle_state::input>(getContext()));
 
-    detail::ExtendedMember EMember = {
+    detail::ExtendedMemberT EMember = {
         detail::ExtendedMembersType::HANDLER_KERNEL_BUNDLE, KernelBundleImpPtr};
 
     ExendedMembersVec->push_back(EMember);
@@ -60,16 +60,16 @@ void handler::setHandlerKernelBundle(
 
   // TODO: Add mutex
 
-  std::shared_ptr<std::vector<detail::ExtendedMember>> ExendedMembersVec =
+  std::shared_ptr<std::vector<detail::ExtendedMemberT>> ExendedMembersVec =
       detail::convertToExtendedMembers(MSharedPtrStorage[0]);
 
-  for (detail::ExtendedMember &EMember : *ExendedMembersVec)
+  for (detail::ExtendedMemberT &EMember : *ExendedMembersVec)
     if (detail::ExtendedMembersType::HANDLER_KERNEL_BUNDLE == EMember.MType) {
       EMember.MData = NewKernelBundleImpPtr;
       return;
     }
 
-  detail::ExtendedMember EMember = {
+  detail::ExtendedMemberT EMember = {
       detail::ExtendedMembersType::HANDLER_KERNEL_BUNDLE,
       NewKernelBundleImpPtr};
 

sycl/test/on-device/basic_tests/kernel_bundle/kernel_bundle_api.cpp

@@ -5,7 +5,6 @@
 // UNSUPPORTED: cuda
 
 #include <CL/sycl.hpp>
-#include <detail/device_image_impl.hpp>
 
 #include <vector>