From e4211675bf3241064e839282018a62044ad9b90d Mon Sep 17 00:00:00 2001 From: Gunes Bayir Date: Tue, 25 Jul 2023 10:37:13 +0100 Subject: Add TensorSampler to CKW Partially Resolves: COMPMID-5791 Signed-off-by: Gunes Bayir Change-Id: Ib9af89d218c8b69ac683ef202401786a807c51b3 Reviewed-on: https://review.mlplatform.org/c/ml/ComputeLibrary/+/9969 Reviewed-by: Viet-Hoa Do Reviewed-by: Anitha Raj Reviewed-by: Gian Marco Iodice Tested-by: Arm Jenkins Comments-Addressed: Arm Jenkins Benchmark: Arm Jenkins --- compute_kernel_writer/include/ckw/TensorSampler.h | 103 ++++++++++++++++++++++ 1 file changed, 103 insertions(+) create mode 100644 compute_kernel_writer/include/ckw/TensorSampler.h (limited to 'compute_kernel_writer/include/ckw/TensorSampler.h') 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 -- cgit v1.2.1