1 /* 2 * Copyright (c) 2017-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_IMEMORYPOOL_H 25 #define ARM_COMPUTE_IMEMORYPOOL_H 26 27 #include "arm_compute/runtime/Types.h" 28 29 #include <cstddef> 30 #include <cstdint> 31 #include <memory> 32 #include <vector> 33 34 namespace arm_compute 35 { 36 /** Memory Pool Inteface */ 37 class IMemoryPool 38 { 39 public: 40 /** Default Virtual Destructor */ 41 virtual ~IMemoryPool() = default; 42 /** Sets occupant to the memory pool 43 * 44 * @param[in] handles A vector of pairs (handle, index) 45 */ 46 virtual void acquire(MemoryMappings &handles) = 0; 47 /** Releases a memory block 48 * 49 * @param[in] handles A vector containing a pair of handles and indices 50 */ 51 virtual void release(MemoryMappings &handles) = 0; 52 /** Returns the mapping types that this pool accepts 53 * 54 * @return the mapping type of the memory 55 */ 56 virtual MappingType mapping_type() const = 0; 57 /** Duplicates the existing memory pool 58 * 59 * @return A duplicate of the existing pool 60 */ 61 virtual std::unique_ptr<IMemoryPool> duplicate() = 0; 62 }; 63 } // arm_compute 64 #endif /* ARM_COMPUTE_IMEMORYPOOL_H */ 65