1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
/*
* Copyright (c) 2017-2020, 2024 Arm Limited.
*
* SPDX-License-Identifier: MIT
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to
* deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
* sell copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
#ifndef ACL_ARM_COMPUTE_RUNTIME_MEMORYGROUP_H
#define ACL_ARM_COMPUTE_RUNTIME_MEMORYGROUP_H
#include "arm_compute/core/Error.h"
#include "arm_compute/core/utils/misc/Macros.h"
#include "arm_compute/runtime/Allocator.h"
#include "arm_compute/runtime/IMemoryGroup.h"
#include "arm_compute/runtime/IMemoryManager.h"
#include "arm_compute/runtime/IMemoryPool.h"
#include "arm_compute/runtime/MemoryManagerOnDemand.h"
#include <cstddef>
#include <memory>
namespace arm_compute
{
// Forward declarations
class IMemory;
/** Memory group */
class MemoryGroup final : public IMemoryGroup
{
public:
/** Default Constructor */
MemoryGroup(std::shared_ptr<IMemoryManager> = nullptr) noexcept;
/** Default destructor */
~MemoryGroup() = default;
/** Prevent instances of this class from being copied (As this class contains pointers) */
MemoryGroup(const MemoryGroup &) = delete;
/** Prevent instances of this class from being copy assigned (As this class contains pointers) */
MemoryGroup &operator=(const MemoryGroup &) = delete;
/** Allow instances of this class to be moved */
MemoryGroup(MemoryGroup &&) = default;
/** Allow instances of this class to be moved */
MemoryGroup &operator=(MemoryGroup &&) = default;
// Inherited methods overridden:
void manage(IMemoryManageable *obj) override;
void finalize_memory(IMemoryManageable *obj, IMemory &obj_memory, size_t size, size_t alignment) override;
void acquire() override;
void release() override;
MemoryMappings &mappings() override;
private:
std::shared_ptr<IMemoryManager> _memory_manager; /**< Memory manager to be used by the group */
IMemoryPool *_pool; /**< Memory pool that the group is scheduled with */
MemoryMappings _mappings; /**< Memory mappings of the group */
bool _auto_clear; /**< Whether the memory manager will be auto-cleared on release */
};
inline MemoryGroup::MemoryGroup(std::shared_ptr<IMemoryManager> memory_manager) noexcept
: _memory_manager(memory_manager), _pool(nullptr), _mappings(), _auto_clear(false)
{
}
inline void MemoryGroup::manage(IMemoryManageable *obj)
{
if (_memory_manager && (obj != nullptr))
{
ARM_COMPUTE_ERROR_ON(!_memory_manager->lifetime_manager());
// Defer registration to the first managed object
_memory_manager->lifetime_manager()->register_group(this);
// Associate this memory group with the tensor
obj->associate_memory_group(this);
// Start object lifetime
_memory_manager->lifetime_manager()->start_lifetime(obj);
}
}
inline void MemoryGroup::finalize_memory(IMemoryManageable *obj, IMemory &obj_memory, size_t size, size_t alignment)
{
if (_memory_manager)
{
ARM_COMPUTE_ERROR_ON(!_memory_manager->lifetime_manager());
_memory_manager->lifetime_manager()->end_lifetime(obj, obj_memory, size, alignment);
}
}
inline void MemoryGroup::acquire()
{
if (!_mappings.empty())
{
ARM_COMPUTE_ERROR_ON(!_memory_manager->pool_manager());
// If the caller has not populated the underlying memory manager,
// do it here. Also set flag to auto-clear the memory manager on release.
// This is needed when using default memory managers that were not set up
// by the user.
if (_memory_manager->pool_manager()->num_pools() == 0)
{
Allocator alloc{};
_memory_manager->populate(alloc, 1);
_auto_clear = true;
}
_pool = _memory_manager->pool_manager()->lock_pool();
_pool->acquire(_mappings);
}
}
inline void MemoryGroup::release()
{
if (_pool != nullptr)
{
ARM_COMPUTE_ERROR_ON(!_memory_manager->pool_manager());
ARM_COMPUTE_ERROR_ON(_mappings.empty());
_pool->release(_mappings);
_memory_manager->pool_manager()->unlock_pool(_pool);
_pool = nullptr;
if (_auto_clear)
{
_memory_manager->clear();
_auto_clear = false;
}
}
}
inline MemoryMappings &MemoryGroup::mappings()
{
return _mappings;
}
} // namespace arm_compute
#endif // ACL_ARM_COMPUTE_RUNTIME_MEMORYGROUP_H
|
