Merge pull request #244 from forresti/fix-comment
[platform/upstream/armcl.git] / src / runtime / BlobLifetimeManager.cpp
1 /*
2  * Copyright (c) 2017 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 #include "arm_compute/runtime/BlobLifetimeManager.h"
25
26 #include "arm_compute/core/Error.h"
27 #include "arm_compute/runtime/BlobMemoryPool.h"
28 #include "arm_compute/runtime/IAllocator.h"
29 #include "arm_compute/runtime/IMemoryGroup.h"
30 #include "support/ToolchainSupport.h"
31
32 #include <algorithm>
33 #include <cmath>
34 #include <map>
35 #include <vector>
36
37 using namespace arm_compute;
38
39 BlobLifetimeManager::BlobLifetimeManager()
40     : _active_group(nullptr), _active_elements(), _finalized_groups(), _blobs()
41 {
42 }
43
44 void BlobLifetimeManager::register_group(IMemoryGroup *group)
45 {
46     if(_active_group == nullptr)
47     {
48         ARM_COMPUTE_ERROR_ON(group == nullptr);
49         _active_group = group;
50     }
51 }
52
53 void BlobLifetimeManager::start_lifetime(void *obj)
54 {
55     ARM_COMPUTE_ERROR_ON(obj == nullptr);
56     ARM_COMPUTE_ERROR_ON_MSG(std::find_if(std::begin(_active_elements), std::end(_active_elements), [&obj](const Element & e)
57     {
58         return obj == e.id;
59     }) != std::end(_active_elements),
60     "Memory object is already registered!");
61
62     // Insert object in groups and mark its finalized state to false
63     _active_elements.emplace_back(obj);
64 }
65
66 void BlobLifetimeManager::end_lifetime(void *obj, void **handle, size_t size)
67 {
68     ARM_COMPUTE_ERROR_ON(obj == nullptr);
69
70     // Find object
71     auto it = std::find_if(std::begin(_active_elements), std::end(_active_elements), [&obj](const Element & e)
72     {
73         return obj == e.id;
74     });
75     ARM_COMPUTE_ERROR_ON(it == std::end(_active_elements));
76
77     // Update object fields and mark object as complete
78     it->handle = handle;
79     it->size   = size;
80     it->status = true;
81
82     // Check if all object are finalized and reset active group
83     if(are_all_finalized())
84     {
85         // Update finalized groups
86         _finalized_groups[_active_group].insert(std::end(_finalized_groups[_active_group]), std::begin(_active_elements), std::end(_active_elements));
87
88         // Update blobs and group mappings
89         update_blobs_and_mappings();
90
91         // Reset state
92         _active_elements.clear();
93         _active_group = nullptr;
94     }
95 }
96
97 std::unique_ptr<IMemoryPool> BlobLifetimeManager::create_pool(IAllocator *allocator)
98 {
99     ARM_COMPUTE_ERROR_ON(allocator == nullptr);
100     return support::cpp14::make_unique<BlobMemoryPool>(allocator, _blobs);
101 }
102
103 bool BlobLifetimeManager::are_all_finalized() const
104 {
105     return !std::any_of(std::begin(_active_elements), std::end(_active_elements), [](const Element e)
106     {
107         return !e.status;
108     });
109 }
110
111 MappingType BlobLifetimeManager::mapping_type() const
112 {
113     return MappingType::BLOBS;
114 }
115
116 void BlobLifetimeManager::update_blobs_and_mappings()
117 {
118     ARM_COMPUTE_ERROR_ON(!are_all_finalized());
119     ARM_COMPUTE_ERROR_ON(_active_group == nullptr);
120
121     // Sort active group requirements in descending order
122     std::sort(std::begin(_active_elements), std::end(_active_elements), [](const Element & a, const Element & b)
123     {
124         return a.size > b.size;
125     });
126     std::vector<size_t> group_sizes;
127     std::transform(std::begin(_active_elements), std::end(_active_elements), std::back_inserter(group_sizes), [](const Element & e)
128     {
129         return e.size;
130     });
131
132     // Update blob sizes
133     size_t max_size = std::max(_blobs.size(), group_sizes.size());
134     _blobs.resize(max_size, 0);
135     group_sizes.resize(max_size, 0);
136     std::transform(std::begin(_blobs), std::end(_blobs), std::begin(group_sizes), std::begin(_blobs), [](size_t lhs, size_t rhs)
137     {
138         return std::max(lhs, rhs);
139     });
140
141     // Calculate group mappings
142     auto &group_mappings = _active_group->mappings();
143     int   blob_idx       = 0;
144     for(auto &e : _active_elements)
145     {
146         group_mappings[e.handle] = blob_idx++;
147     }
148 }