Integrate CLTensorArgument

- Add CLTensorArgument to query the components and storages as OpenCL
variables (or by values when possible)
- Add caching mechanism in CLTensorArgument to keep track of the components and storages used
- Add unit tests

Resolves COMPMID-5787

Signed-off-by: Gian Marco Iodice <gianmarco.iodice@arm.com>
Signed-off-by: Viet-Hoa Do <viet-hoa.do@arm.com>
Change-Id: Ib39e1f77b097e5b907a296fe6b0d41bb4bcd4ffc
Reviewed-on: https://review.mlplatform.org/c/ml/ComputeLibrary/+/9908
Comments-Addressed: Arm Jenkins <bsgcomp@arm.com>
Benchmark: Arm Jenkins <bsgcomp@arm.com>
Tested-by: Arm Jenkins <bsgcomp@arm.com>
Reviewed-by: Gunes Bayir <gunes.bayir@arm.com>
Reviewed-by: Jakub Sujak <jakub.sujak@arm.com>

5 files changed, 179 insertions, 73 deletions

diff --git a/compute_kernel_writer/include/ckw/Error.h b/compute_kernel_writer/include/ckw/Error.h
index 100bdc48fe..eaf3f10c05 100644
--- a/compute_kernel_writer/include/ckw/Error.h
+++ b/compute_kernel_writer/include/ckw/Error.h
@@ -87,7 +87,7 @@ inline void ignore_unused(T &&...)
 
 #ifdef COMPUTE_KERNEL_WRITER_ASSERTS_ENABLED
 
-/** If the condition is not met, throw an std::runtime_error with the specified message.
+/** If the condition is not met, throw an std::runtime_error with the specified message if assertion is enabled.
  *
  * @param[in] cond The condition that is expected to be true.
  * @param[in] msg  The error message when the condition is not met.
@@ -101,19 +101,24 @@ inline void ignore_unused(T &&...)
         }                         \
     } while(false)
 
-/** If the condition is not met, throw an std::runtime_error.
- *
- * @param[in] cond The condition that is expected to be true.
- */
-#define CKW_ASSERT(cond) CKW_ASSERT_MSG(cond, #cond)
-
 #else // COMPUTE_KERNEL_WRITER_ASSERTS_ENABLED
 
 #define CKW_ASSERT_MSG(cond, msg)
-#define CKW_ASSERT(cond)
 
 #endif // COMPUTE_KERNEL_WRITER_ASSERTS_ENABLED
 
+/** If the condition is not met, throw an std::runtime_error if assertion is enabled.
+ *
+ * @param[in] cond The condition that is expected to be true.
+ */
+#define CKW_ASSERT(cond) CKW_ASSERT_MSG(cond, #cond)
+
+/** Throw an std::runtime_error with the specified message if assertion is enabled.
+ *
+ * @param[in] msg  The error message when the condition is not met.
+ */
+#define CKW_ASSERT_FAILED_MSG(msg) CKW_ASSERT_MSG(false, msg)
+
 } // namespace ckw
 
 #endif // CKW_INCLUDE_CKW_ERROR_H
diff --git a/compute_kernel_writer/include/ckw/TensorInfo.h b/compute_kernel_writer/include/ckw/TensorInfo.h
index 63d9f412b6..87cf7c1426 100644
--- a/compute_kernel_writer/include/ckw/TensorInfo.h
+++ b/compute_kernel_writer/include/ckw/TensorInfo.h
@@ -26,85 +26,27 @@
 #define COMPUTE_KERNEL_WRITER_INCLUDE_CKW_TENSORINFO_H
 
 #include "ckw/types/DataType.h"
-
+#include "ckw/types/TensorDataLayout.h"
 #include <array>
 #include <cstdint>
 
 namespace ckw
 {
-/** Compute Kernel Writer tensor data layout (or memory format) */
-enum class TensorDataLayout
-{
-    Unknown,
-    Nhwc,
-    Ndhwc
-};
-
-/** Compute Kernel Writer tensor data layout component */
-enum class TensorDataLayoutComponent
-{
-    Unknown,
-    N,
-    D,
-    H,
-    W,
-    C,
-};
-
-/** Compute Kernel Writer tensor component bitmask. The bitmask can be used to retrieve
- *  the info from @ref TensorComponent.
- */
-enum class TensorComponentBitmask : uint32_t
-{
-    OffsetFirstElement = 0x01000000, // For example, OffsetFirstElement in @ref TensorComponent
-    Stride             = 0x02000000, // For example, stride0 in @ref TensorComponent
-    Dimension          = 0x04000000, // For example, Dim0 in @ref TensorComponent
-    FoldedDimensions   = 0x08000000, // For example, Dim0xDim1 in @ref TensorComponent
-};
-
-/** Compute Kernel Writer tensor component. The tensor components are used to access specific backend-agnostic tensor arguments,
- *  such as the tensor dimensions and tensor strides.
- *  The data type is represented as an integer. The value of the integer value
- *  is assigned to retrieve the information through the @ref TensorComponentBitmask.
- */
-enum class TensorComponent : uint32_t
-{
-    Unknown            = 0x00000000,
-    OffsetFirstElement = 0x01000000,
-    Stride0            = 0x02000001,
-    Stride1            = 0x02000010,
-    Stride2            = 0x02000100,
-    Stride3            = 0x02001000,
-    Stride4            = 0x02010000,
-    Dim0               = 0x04000001,
-    Dim1               = 0x04000010,
-    Dim2               = 0x04000100,
-    Dim3               = 0x04001000,
-    Dim4               = 0x04010000,
-    Dim1xDim2          = 0x08000110,
-    Dim2xDim3          = 0x08001100,
-    Dim1xDim2xDim3     = 0x08001110
-};
-
-/** Compute Kernel Writer tensor storage. The tensor storage represents the type of tensor memory object.
- */
-enum class TensorStorage : uint32_t
-{
-    Unknown            = 0x00000000,
-    BufferUint8Ptr     = 0x01000000,
-    Texture2dReadOnly  = 0x02000001,
-    Texture2dWriteOnly = 0x02000010,
-};
 
 /** Compute Kernel Writer tensor shape
- *  Negative dimensions can be interpreted as dynamic dimensions by the Compute Kernel Writer
+ *  The value -1 for the tensor dimension is reserved to dynamic dimensions.
  */
 using TensorShape = std::array<int32_t, 5>;
 
+/** Tensor dimension value reserved to dynamic dimensions */
+constexpr int32_t kDynamicTensorDimensionValue = -1;
+
 /** Compute Kernel Writer tensor info */
 class TensorInfo
 {
 public:
+    /** Default constructor */
+    TensorInfo() = default;
     /** Constructor
      *
      * @param[in] dt    Tensor data type
diff --git a/compute_kernel_writer/include/ckw/types/TensorComponentType.h b/compute_kernel_writer/include/ckw/types/TensorComponentType.h
new file mode 100644
index 0000000000..7a5031d8c0
--- /dev/null
+++ b/compute_kernel_writer/include/ckw/types/TensorComponentType.h
@@ -0,0 +1,61 @@
+/*
+ * Copyright (c) 2023 Arm Limited.
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to
+ * deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+ * sell copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+#ifndef CKW_INCLUDE_CKW_TYPES_TENSORCOMPONENTTYPE_H
+#define CKW_INCLUDE_CKW_TYPES_TENSORCOMPONENTTYPE_H
+
+#include <cstdint>
+
+namespace ckw
+{
+
+/** Compute Kernel Writer tensor component.
+ *
+ * The tensor components are used to access specific backend-agnostic tensor arguments,
+ * such as the tensor dimensions and tensor strides.
+ * The tensor component is represented as an unsigned integer. The value of the integer value
+ * is assigned to retrieve the information through the @ref TensorComponentBitmask.
+ */
+enum class TensorComponentType : uint32_t
+{
+    Unknown            = 0x00000000,
+    OffsetFirstElement = 0x01000000,
+    Stride0            = 0x02000001,
+    Stride1            = 0x02000002,
+    Stride2            = 0x02000003,
+    Stride3            = 0x02000004,
+    Stride4            = 0x02000005,
+    Dim0               = 0x04000001,
+    Dim1               = 0x04000002,
+    Dim2               = 0x04000003,
+    Dim3               = 0x04000004,
+    Dim4               = 0x04000005,
+    Dim1xDim2          = 0x08000032,
+    Dim2xDim3          = 0x08000043,
+    Dim1xDim2xDim3     = 0x08000432
+};
+
+} // namespace ckw
+
+#endif // CKW_INCLUDE_CKW_TYPES_TENSORCOMPONENTTYPE_H
diff --git a/compute_kernel_writer/include/ckw/types/TensorDataLayout.h b/compute_kernel_writer/include/ckw/types/TensorDataLayout.h
new file mode 100644
index 0000000000..532b299910
--- /dev/null
+++ b/compute_kernel_writer/include/ckw/types/TensorDataLayout.h
@@ -0,0 +1,52 @@
+/*
+ * Copyright (c) 2023 Arm Limited.
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to
+ * deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+ * sell copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+#ifndef CKW_INCLUDE_CKW_TYPES_TENSORDATALAYOUT_H
+#define CKW_INCLUDE_CKW_TYPES_TENSORDATALAYOUT_H
+
+namespace ckw
+{
+
+/** Compute Kernel Writer tensor data layout (or memory format) */
+enum class TensorDataLayout
+{
+    Unknown,
+    Nhwc,
+    Ndhwc
+};
+
+/** Compute Kernel Writer tensor data layout component */
+enum class TensorDataLayoutComponent
+{
+    Unknown,
+    N,
+    D,
+    H,
+    W,
+    C,
+};
+
+} // namespace ckw
+
+#endif // CKW_INCLUDE_CKW_TYPES_TENSORDATALAYOUT_H
diff --git a/compute_kernel_writer/include/ckw/types/TensorStorageType.h b/compute_kernel_writer/include/ckw/types/TensorStorageType.h
new file mode 100644
index 0000000000..5a2f17d520
--- /dev/null
+++ b/compute_kernel_writer/include/ckw/types/TensorStorageType.h
@@ -0,0 +1,46 @@
+/*
+ * Copyright (c) 2023 Arm Limited.
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to
+ * deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+ * sell copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+#ifndef CKW_INCLUDE_CKW_TYPES_TENSORSTORAGETYPE_H
+#define CKW_INCLUDE_CKW_TYPES_TENSORSTORAGETYPE_H
+
+#include <cstdint>
+
+namespace ckw
+{
+
+/** Compute Kernel Writer tensor storage.
+ *  The tensor storage represents the type of tensor memory object.
+ */
+enum class TensorStorageType : uint32_t
+{
+    Unknown            = 0x00000000,
+    BufferUint8Ptr     = 0x01000000,
+    Texture2dReadOnly  = 0x02000001,
+    Texture2dWriteOnly = 0x02000010,
+};
+
+} // namespace ckw
+
+#endif // CKW_INCLUDE_CKW_TYPES_TENSORSTORAGETYPE_H