Add TensorSampler to CKW

Partially Resolves: COMPMID-5791

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

4 files changed, 289 insertions, 0 deletions

diff --git a/compute_kernel_writer/CMakeLists.txt b/compute_kernel_writer/CMakeLists.txt
index eddae06f95..659c1058b1 100644
--- a/compute_kernel_writer/CMakeLists.txt
+++ b/compute_kernel_writer/CMakeLists.txt
@@ -123,6 +123,7 @@ target_sources(ckw PRIVATE
     src/Kernel.cpp
     src/KernelWriter.cpp
     src/TensorInfo.cpp
+    src/TensorSampler.cpp
     src/TensorUtils.cpp
     src/TileInfo.cpp
     src/TileOperand.cpp
diff --git a/compute_kernel_writer/include/ckw/TensorSampler.h b/compute_kernel_writer/include/ckw/TensorSampler.h
new file mode 100644
index 0000000000..1b51636edb
--- /dev/null
+++ b/compute_kernel_writer/include/ckw/TensorSampler.h
@@ -0,0 +1,103 @@
+/*
+ * 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_TENSORSAMPLER_H
+#define CKW_INCLUDE_CKW_TENSORSAMPLER_H
+
+#include "ckw/types/TensorStorageType.h"
+#include "ckw/types/TensorSamplerTypes.h"
+
+namespace ckw
+{
+
+/** Tensor sampler
+ *
+ * It contains information about how the tensor is sampled. It can be used to
+ * tell how a tile should be stored to tensor memory, and how a tensor should be
+ * sampled to get the values stored in a tile. Where to sample the tensor is
+ * defined with the coordinates respecting the addressing modes, storage type and
+ * the tensor format defined in this class.
+ */
+class TensorSampler
+{
+public:
+    /** Initialize a new instance of @ref TensorSampler class. */
+    TensorSampler();
+
+    /** Initialize a new instance of @ref TensorSampler class.
+     *
+     * @param[in] storage        Tensor storage to load/store the tensor from/to
+     * @param[in] format         The tensor data format.
+     * @param[in] address_mode_x The address mode of the x dimension.
+     * @param[in] address_mode_y The address mode of the y dimension.
+     * @param[in] address_mode_z The address mode of the z dimension.
+     */
+    TensorSampler(
+        TensorStorageType         storage,
+        TensorSamplerFormat       format,
+        TensorSamplerAddressModeX address_mode_x,
+        TensorSamplerAddressModeY address_mode_y,
+        TensorSamplerAddressModeZ address_mode_z);
+
+    /** Get the storage for the tensor */
+    TensorStorageType storage() const;
+
+    /** Set the storage for the tensor */
+    TensorSampler &storage(TensorStorageType storage);
+
+    /** Get the format of the tensor. */
+    TensorSamplerFormat format() const;
+
+    /** Set the format of the tensor. */
+    TensorSampler &format(TensorSamplerFormat format);
+
+    /** Get the address mode of the x dimension. */
+    TensorSamplerAddressModeX address_mode_x() const;
+
+    /** Set the address mode of the x dimension. */
+    TensorSampler &address_mode_x(TensorSamplerAddressModeX address_mode_x);
+
+    /** Get the address mode of the y dimension. */
+    TensorSamplerAddressModeY address_mode_y() const;
+
+    /** Set the address mode of the y dimension. */
+    TensorSampler &address_mode_y(TensorSamplerAddressModeY address_mode_y);
+
+    /** Get the address mode of the z dimension. */
+    TensorSamplerAddressModeZ address_mode_z() const;
+
+    /** Set the address mode of the z dimension. */
+    TensorSampler &address_mode_z(TensorSamplerAddressModeZ address_mode_z);
+
+private:
+    TensorStorageType                _storage { TensorStorageType::BufferUint8Ptr };
+    TensorSamplerFormat              _format  { TensorSamplerFormat::Unknown };
+    TensorSamplerAddressModeX _address_mode_x { TensorSamplerAddressModeX::Unknown };
+    TensorSamplerAddressModeY _address_mode_y { TensorSamplerAddressModeY::Unknown };
+    TensorSamplerAddressModeZ _address_mode_z { TensorSamplerAddressModeZ::Unknown };
+};
+
+} // namespace ckw
+
+#endif // CKW_PROTOTYPE_INCLUDE_CKW_TENSORSAMPLER_H
diff --git a/compute_kernel_writer/include/ckw/types/TensorSamplerTypes.h b/compute_kernel_writer/include/ckw/types/TensorSamplerTypes.h
new file mode 100644
index 0000000000..347536512e
--- /dev/null
+++ b/compute_kernel_writer/include/ckw/types/TensorSamplerTypes.h
@@ -0,0 +1,83 @@
+/*
+ * 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_TENSORSAMPLERTYPES_H
+#define CKW_INCLUDE_CKW_TENSORSAMPLERTYPES_H
+
+#include <cstdint>
+
+namespace ckw
+{
+
+// This enum class defines how the dimensions of a 3d tensor is mapped into x,y and z coordianates.
+enum class TensorSamplerFormat : int32_t
+{
+    Unknown    = 0,
+    D0_D1xD2_1 = 1, // Original dimensions 1 and 2 are collapsed onto y-axis
+    D0_D1_D2   = 2  // Original dimensions stays as they're defined. No collapsing.
+};
+
+/** Tensor sampler address mode enum class for X dimension
+ *
+ *  The following address modes are available in total:
+ *      Unknown
+ *      None                 : The user guarantees that the coordinate is always in-bound
+ *      OverlappingMin       : (FIXED shapes only) Reduce the load/store length when x == 0 (MIN). The load length will be width % original length
+ *                             Leftover elements can be handled using overlapping. This involves processing some of the elements in the array twice.
+ *      ClampToBorderMaxOnly : Clamp to max value allowed in the corresponding dimension, and construct an if/else guard to prevent out of bound access,
+ *                             e.g. if( y < size-of-dimension-y ){ <do the operation>  }
+ *
+ *  Individual dimensions choose which adddress mode to implement in their respective enum classes.
+ */
+enum class TensorSamplerAddressModeX : int32_t
+{
+    Unknown        = 0,
+    None           = 1, // The user guarantees that the coordinate is always in-bound
+    OverlappingMin = 2  // (FIXED shapes only) Reduce the load/store length when x == 0 (MIN). The load length will be width % original length
+                        // Leftover elements can be handled using overlapping. This involves processing some of the elements in the array twice.
+};
+
+/**
+ * Similar to @ref TensorSamplerAddressModeX
+ */
+enum class TensorSamplerAddressModeY : int32_t
+{
+    Unknown              = 0,
+    None                 = 1,
+    OverlappingMin       = 2,
+    ClampToBorderMaxOnly = 3
+};
+
+/**
+ * Similar to @ref TensorSamplerAddressModeX
+ */
+enum class TensorSamplerAddressModeZ : int32_t
+{
+    Unknown        = 0,
+    None           = 1,
+};
+
+} // namespace ckw
+
+#endif //CKW_INCLUDE_CKW_TENSORSAMPLERTYPES_H
diff --git a/compute_kernel_writer/src/TensorSampler.cpp b/compute_kernel_writer/src/TensorSampler.cpp
new file mode 100644
index 0000000000..2ee8df4bca
--- /dev/null
+++ b/compute_kernel_writer/src/TensorSampler.cpp
@@ -0,0 +1,102 @@
+/*
+ * 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.
+ */
+
+#include "ckw/TensorSampler.h"
+
+namespace ckw
+{
+
+TensorSampler::TensorSampler(TensorStorageType         storage,
+                             TensorSamplerFormat       format,
+                             TensorSamplerAddressModeX address_mode_x,
+                             TensorSamplerAddressModeY address_mode_y,
+                             TensorSamplerAddressModeZ address_mode_z)
+    : _storage(storage), _format(format), _address_mode_x(address_mode_x), _address_mode_y(address_mode_y), _address_mode_z(address_mode_z)
+{
+}
+
+TensorStorageType TensorSampler::storage() const
+{
+    return _storage;
+}
+
+TensorSampler &TensorSampler::storage(TensorStorageType storage)
+{
+    _storage = storage;
+    return *this;
+}
+
+/** Get the format of the tensor. */
+TensorSamplerFormat TensorSampler::format() const
+{
+    return _format;
+}
+
+/** Set the format of the tensor. */
+TensorSampler &TensorSampler::format(TensorSamplerFormat format)
+{
+    _format = format;
+    return *this;
+}
+
+/** Get the address mode of the x dimension. */
+TensorSamplerAddressModeX TensorSampler::address_mode_x() const
+{
+    return _address_mode_x;
+}
+
+/** Set the address mode of the x-dimension. */
+TensorSampler &TensorSampler::address_mode_x(TensorSamplerAddressModeX address_mode_x)
+{
+    _address_mode_x = address_mode_x;
+    return *this;
+}
+
+/** Get the address mode of the y dimension. */
+TensorSamplerAddressModeY TensorSampler::address_mode_y() const
+{
+    return _address_mode_y;
+}
+
+/** Set the address mode of the y dimension. */
+TensorSampler &TensorSampler::address_mode_y(TensorSamplerAddressModeY address_mode_y)
+{
+    _address_mode_y = address_mode_y;
+    return *this;
+}
+
+/** Get the address mode of the z dimension. */
+TensorSamplerAddressModeZ TensorSampler::address_mode_z() const
+{
+    return _address_mode_z;
+}
+
+/** Set the address mode of the z dimension. */
+TensorSampler &TensorSampler::address_mode_z(TensorSamplerAddressModeZ address_mode_z)
+{
+    _address_mode_z = address_mode_z;
+    return *this;
+}
+
+} // namespace ckw