xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/runtime/OffsetMemoryPool.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
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 
27 #include "arm_compute/runtime/IMemoryPool.h"
28 
29 #include "arm_compute/runtime/IMemoryRegion.h"
30 #include "arm_compute/runtime/Types.h"
31 
32 #include <cstddef>
33 #include <memory>
34 
35 namespace arm_compute
36 {
37 class IAllocator;
38 
39 /** Offset based memory pool */
40 class OffsetMemoryPool : public IMemoryPool
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      */
50     OffsetMemoryPool(IAllocator *allocator, BlobInfo blob_info);
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 */
60     OffsetMemoryPool &operator=(OffsetMemoryPool &&) = default;
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 */
80