Compute Library
 22.05
OffsetMemoryPool.h
Go to the documentation of this file.
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_OFFSETMEMORYPOOL_H
25 #define ARM_COMPUTE_OFFSETMEMORYPOOL_H
26 
28 
31 
32 #include <cstddef>
33 #include <memory>
34 
35 namespace arm_compute
36 {
37 class IAllocator;
38 
39 /** Offset based memory pool */
41 {
42 public:
43  /** Default Constructor
44  *
45  * @note allocator should outlive the memory pool
46  *
47  * @param[in] allocator Backing memory allocator
48  * @param[in] blob_info Configuration information of the blob to be allocated
49  */
51  /** Default Destructor */
52  ~OffsetMemoryPool() = default;
53  /** Prevent instances of this class to be copy constructed */
54  OffsetMemoryPool(const OffsetMemoryPool &) = delete;
55  /** Prevent instances of this class to be copy assigned */
56  OffsetMemoryPool &operator=(const OffsetMemoryPool &) = delete;
57  /** Allow instances of this class to be move constructed */
58  OffsetMemoryPool(OffsetMemoryPool &&) = default;
59  /** Allow instances of this class to be move assigned */
61  /** Accessor to the pool internal configuration meta-data
62  *
63  * @return Pool internal configuration meta-data
64  */
65  const BlobInfo &info() const;
66 
67  // Inherited methods overridden:
68  void acquire(MemoryMappings &handles) override;
69  void release(MemoryMappings &handles) override;
70  MappingType mapping_type() const override;
71  std::unique_ptr<IMemoryPool> duplicate() override;
72 
73 private:
74  IAllocator *_allocator; /**< Allocator to use for internal allocation */
75  std::unique_ptr<IMemoryRegion> _blob; /**< Memory blob */
76  BlobInfo _blob_info; /**< Information for the blob to allocate */
77 };
78 } // namespace arm_compute
79 #endif /* ARM_COMPUTE_OFFSETMEMORYPOOL_H */
void acquire(MemoryMappings &handles) override
Sets occupant to the memory pool.
Meta-data information for each blob.
Definition: Types.h:51
std::unique_ptr< IMemoryPool > duplicate() override
Duplicates the existing memory pool.
Offset based memory pool.
const BlobInfo & info() const
Accessor to the pool internal configuration meta-data.
OffsetMemoryPool & operator=(const OffsetMemoryPool &)=delete
Prevent instances of this class to be copy assigned.
Memory Pool Inteface.
Definition: IMemoryPool.h:37
Copyright (c) 2017-2022 Arm Limited.
MappingType
Mapping type.
Definition: Types.h:34
input allocator() -> allocate()
void release(MemoryMappings &handles) override
Releases a memory block.
std::map< IMemory *, size_t > MemoryMappings
A map of (handle, index/offset), where handle is the memory handle of the object to provide the memor...
Definition: Types.h:45
Allocator interface.
Definition: IAllocator.h:35
MappingType mapping_type() const override
Returns the mapping types that this pool accepts.
~OffsetMemoryPool()=default
Default Destructor.
OffsetMemoryPool(IAllocator *allocator, BlobInfo blob_info)
Default Constructor.