xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/runtime/IAllocator.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2017-2021 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_IALLOCATOR_H
25 #define ARM_COMPUTE_IALLOCATOR_H
26 
27 #include "arm_compute/runtime/IMemoryRegion.h"
28 
29 #include <cstddef>
30 #include <memory>
31 
32 namespace arm_compute
33 {
34 /** Allocator interface */
35 class IAllocator
36 {
37 public:
38     /** Default virtual destructor. */
39     virtual ~IAllocator() = default;
40     /** Interface to be implemented by the child class to allocate bytes
41      *
42      * @param[in] size      Size to allocate
43      * @param[in] alignment Alignment that the returned pointer should comply with
44      *
45      * @return A pointer to the allocated memory
46      */
47     virtual void *allocate(size_t size, size_t alignment) = 0;
48     /** Interface to be implemented by the child class to free the allocated tensor */
49     virtual void free(void *ptr) = 0;
50     /** Create self-managed memory region
51      *
52      * @param[in] size      Size of the memory region
53      * @param[in] alignment Alignment of the memory region
54      *
55      * @return The memory region object
56      */
57     virtual std::unique_ptr<IMemoryRegion> make_region(size_t size, size_t alignment) = 0;
58 };
59 } // arm_compute
60 #endif /*ARM_COMPUTE_IALLOCATOR_H */
61