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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
/*
* Copyright (c) 2017-2018 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 __ARM_COMPUTE_MEMORYGROUPBASE_H__
#define __ARM_COMPUTE_MEMORYGROUPBASE_H__
#include "arm_compute/runtime/IMemoryGroup.h"
#include "arm_compute/core/Error.h"
#include "arm_compute/runtime/IMemoryManager.h"
#include "arm_compute/runtime/IMemoryPool.h"
#include <cstddef>
#include <memory>
namespace arm_compute
{
// Forward declarations
class IMemory;
/** Memory group */
template <typename TensorType>
class MemoryGroupBase : public IMemoryGroup
{
public:
/** Default Constructor */
MemoryGroupBase(std::shared_ptr<IMemoryManager> memory_manager = nullptr);
/** Default destructor */
~MemoryGroupBase() = default;
/** Prevent instances of this class from being copied (As this class contains pointers) */
MemoryGroupBase(const MemoryGroupBase &) = delete;
/** Prevent instances of this class from being copy assigned (As this class contains pointers) */
MemoryGroupBase &operator=(const MemoryGroupBase &) = delete;
/** Allow instances of this class to be moved */
MemoryGroupBase(MemoryGroupBase &&) = default;
/** Allow instances of this class to be moved */
MemoryGroupBase &operator=(MemoryGroupBase &&) = default;
/** Sets a object to be managed by the given memory group
*
* @note Manager must not be finalized
*
* @param[in] obj Object to be managed
*/
void manage(TensorType *obj);
/** Finalizes memory for a given object
*
* @note Manager must not be finalized
*
* @param[in, out] obj Object to request memory for
* @param[in, out] obj_memory Object's memory handling interface which can be used to alter the underlying memory
* that is used by the object.
* @param[in] size Size of memory to allocate
* @param[in] alignment (Optional) Alignment to use
*/
void finalize_memory(TensorType *obj, IMemory &obj_memory, size_t size, size_t alignment = 0);
// Inherited methods overridden:
void acquire() override;
void release() override;
MemoryMappings &mappings() override;
private:
void associate_memory_group(TensorType *obj);
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 */
};
template <typename TensorType>
inline MemoryGroupBase<TensorType>::MemoryGroupBase(std::shared_ptr<IMemoryManager> memory_manager)
: _memory_manager(std::move(memory_manager)), _pool(nullptr), _mappings()
{
if(_memory_manager)
{
ARM_COMPUTE_ERROR_ON(!_memory_manager->lifetime_manager());
}
}
template <typename TensorType>
inline void MemoryGroupBase<TensorType>::manage(TensorType *obj)
{
if(_memory_manager && _mappings.empty())
{
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
associate_memory_group(obj);
// Start object lifetime
_memory_manager->lifetime_manager()->start_lifetime(obj);
}
}
template <typename TensorType>
inline void MemoryGroupBase<TensorType>::finalize_memory(TensorType *obj, IMemory &obj_memory, size_t size, size_t alignment)
{
// TODO (geopin01) : Check size (track size in MemoryMappings)
// Check if existing mapping is valid
ARM_COMPUTE_ERROR_ON(!_mappings.empty() && (_mappings.find(&obj_memory) == std::end(_mappings)));
if(_memory_manager && _mappings.empty())
{
ARM_COMPUTE_ERROR_ON(!_memory_manager->lifetime_manager());
_memory_manager->lifetime_manager()->end_lifetime(obj, obj_memory, size, alignment);
}
}
template <typename TensorType>
inline void MemoryGroupBase<TensorType>::acquire()
{
if(!_mappings.empty())
{
ARM_COMPUTE_ERROR_ON(!_memory_manager->pool_manager());
_pool = _memory_manager->pool_manager()->lock_pool();
_pool->acquire(_mappings);
}
}
template <typename TensorType>
inline void MemoryGroupBase<TensorType>::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;
}
}
template <typename TensorType>
inline MemoryMappings &MemoryGroupBase<TensorType>::mappings()
{
return _mappings;
}
template <typename TensorType>
inline void MemoryGroupBase<TensorType>::associate_memory_group(TensorType *)
{
ARM_COMPUTE_ERROR("Must be implemented by child class");
}
} // arm_compute
#endif /*__ARM_COMPUTE_MEMORYGROUPBASE_H__ */
|
