1 /* 2 * Copyright (c) 2016-2019 Arm Limited. 3 * 4 * SPDX-License-Identifier: MIT 5 * 6 * Permission is hereby granted, free of charge, to any person obtaining a copy 7 * of this software and associated documentation files (the "Software"), to 8 * deal in the Software without restriction, including without limitation the 9 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or 10 * sell copies of the Software, and to permit persons to whom the Software is 11 * furnished to do so, subject to the following conditions: 12 * 13 * The above copyright notice and this permission notice shall be included in all 14 * copies or substantial portions of the Software. 15 * 16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 22 * SOFTWARE. 23 */ 24 #ifndef ARM_COMPUTE_ILUTALLOCATOR_H 25 #define ARM_COMPUTE_ILUTALLOCATOR_H 26 27 #include "arm_compute/core/Types.h" 28 29 #include <cstddef> 30 #include <cstdint> 31 32 namespace arm_compute 33 { 34 /** Basic interface to allocate LUTs' */ 35 class ILutAllocator 36 { 37 public: 38 /** Default constructor */ 39 ILutAllocator(); 40 /** Default virtual destructor */ 41 virtual ~ILutAllocator() = default; 42 /** Allow instances of this class to be move constructed */ 43 ILutAllocator(ILutAllocator &&) = default; 44 /** Allow instances of this class to be moved */ 45 ILutAllocator &operator=(ILutAllocator &&) = default; 46 /** Allocate an LUT of the requested number of elements and data_type. 47 * 48 * @param[in] num_elements Number of elements of the LUT. 49 * @param[in] data_type Data type of each element. 50 */ 51 void init(size_t num_elements, DataType data_type); 52 /** Returns the total number of elements in the LUT. 53 * 54 * @return Total number of elements. 55 */ 56 size_t num_elements() const; 57 /** Returns the type of the LUT. 58 * 59 * @return The type of the LUT. 60 */ 61 DataType type() const; 62 /** Returns the total size in bytes of the LUT. 63 * 64 * @return Total size of the LUT in bytes. 65 */ 66 size_t size() const; 67 68 protected: 69 /** Interface to be implemented by the child class to allocate the LUT. */ 70 virtual void allocate() = 0; 71 /** Interface to be implemented by the child class to lock the memory allocation for the CPU to access. 72 * 73 * @return Pointer to a CPU mapping of the memory 74 */ 75 virtual uint8_t *lock() = 0; 76 /** Interface to be implemented by the child class to unlock the memory allocation after the CPU is done accessing it. */ 77 virtual void unlock() = 0; 78 79 private: 80 size_t _num_elements; /**< Number of elements allocated */ 81 DataType _data_type; /**< Data type of LUT elements. */ 82 }; 83 } 84 #endif /* ARM_COMPUTE_ILUTALLOCATOR_H */ 85