arm_compute/runtime/OffsetMemoryPool.h

   1 /*
   2  * Copyright (c) 2017 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_OFFSETMEMORYPOOL_H__
  25 #define __ARM_COMPUTE_OFFSETMEMORYPOOL_H__
  26
  27 #include "arm_compute/runtime/IMemoryPool.h"
  28
  29 #include "arm_compute/runtime/Types.h"
  30
  31 #include <cstddef>
  32
  33 namespace arm_compute
  34 {
  35 class IAllocator;
  36
  37 /** Offset based memory pool */
  38 class OffsetMemoryPool : public IMemoryPool
  39 {
  40 public:
  41     /** Default Constructor
  42      *
  43      * @note allocator should outlive the memory pool
  44      *
  45      * @param[in] allocator Backing memory allocator
  46      * @param[in] blob_size Size of the memory be allocated
  47      */
  48     OffsetMemoryPool(IAllocator *allocator, size_t blob_size);
  49     /** Default Destructor */
  50     ~OffsetMemoryPool();
  51     /** Prevent instances of this class to be copy constructed */
  52     OffsetMemoryPool(const OffsetMemoryPool &) = delete;
  53     /** Prevent instances of this class to be copy assigned */
  54     OffsetMemoryPool &operator=(const OffsetMemoryPool &) = delete;
  55     /** Allow instances of this class to be move constructed */
  56     OffsetMemoryPool(OffsetMemoryPool &&) = default;
  57     /** Allow instances of this class to be move assigned */
  58     OffsetMemoryPool &operator=(OffsetMemoryPool &&) = default;
  59
  60     // Inherited methods overridden:
  61     void acquire(MemoryMappings &handles) override;
  62     void release(MemoryMappings &handles) override;
  63     MappingType                  mapping_type() const override;
  64     std::unique_ptr<IMemoryPool> duplicate() override;
  65
  66 private:
  67     IAllocator *_allocator; /**< Allocator to use for internal allocation */
  68     void       *_blob;      /**< Memory blob */
  69     size_t      _blob_size; /**< Sizes of the allocated memory blob */
  70 };
  71 } // namespace arm_compute
  72 #endif /* __ARM_COMPUTE_OFFSETMEMORYPOOL_H__ */