Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / refs/heads/gh-pages / . / 24.02 / classarmnn_1_1_memory_manager.html
blob: 31c67295b50f8036ff20498091ad74f7ec7cf0e1 [file] [log] [blame]
Nikhil Raj38b600d2024-02-15 15:02:19 +0000[diff] [blame]1<!-- HTML header for doxygen 1.8.17-->
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml">
4<head>
5<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6<meta http-equiv="X-UA-Compatible" content="IE=9"/>
7<meta name="generator" content="Doxygen 1.8.17"/>
8<meta name="viewport" content="width=device-width, initial-scale=1"/>
9<title>Arm NN: MemoryManager Class Reference</title>
10<link href="tabs.css" rel="stylesheet" type="text/css"/>
11<script type="text/javascript" src="jquery.js"></script>
12<script type="text/javascript" src="dynsections.js"></script>
13<link href="navtree.css" rel="stylesheet" type="text/css"/>
14<script type="text/javascript" src="resize.js"></script>
15<script type="text/javascript" src="navtreedata.js"></script>
16<script type="text/javascript" src="navtree.js"></script>
17<link href="search/search.css" rel="stylesheet" type="text/css"/>
18<script type="text/javascript" src="search/searchdata.js"></script>
19<script type="text/javascript" src="search/search.js"></script>
20<script type="text/x-mathjax-config">
21 MathJax.Hub.Config({
22 extensions: ["tex2jax.js"],
23 jax: ["input/TeX","output/HTML-CSS"],
24});
25</script>
26<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
27<link href="doxygen.css" rel="stylesheet" type="text/css" />
28<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
29</head>
30<body>
31<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
32<div id="titlearea">
33<table cellspacing="0" cellpadding="0">
34 <tbody>
35 <tr style="height: 56px;">
36 <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 15rem; margin-top: .5rem; margin-left 13px"/>
37 <td id="projectalign" style="padding-left: 0.9em;">
38 <div id="projectname">
39 &#160;<span id="projectnumber">24.02</span>
40 </div>
41 </td>
42 </tr>
43 </tbody>
44</table>
45</div>
46<!-- end header part -->
47<!-- Generated by Doxygen 1.8.17 -->
48<script type="text/javascript">
49/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
50var searchBox = new SearchBox("searchBox", "search",false,'Search');
51/* @license-end */
52</script>
53<script type="text/javascript" src="menudata.js"></script>
54<script type="text/javascript" src="menu.js"></script>
55<script type="text/javascript">
56/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
57$(function() {
58 initMenu('',true,false,'search.php','Search');
59 $(document).ready(function() { init_search(); });
60});
61/* @license-end */</script>
62<div id="main-nav"></div>
63</div><!-- top -->
64<div id="side-nav" class="ui-resizable side-nav-resizable">
65 <div id="nav-tree">
66 <div id="nav-tree-contents">
67 <div id="nav-sync" class="sync"></div>
68 </div>
69 </div>
70 <div id="splitbar" style="-moz-user-select:none;"
71 class="ui-resizable-handle">
72 </div>
73</div>
74<script type="text/javascript">
75/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
76$(document).ready(function(){initNavTree('classarmnn_1_1_memory_manager.html',''); initResizable(); });
77/* @license-end */
78</script>
79<div id="doc-content">
80<!-- window showing the filter options -->
81<div id="MSearchSelectWindow"
82 onmouseover="return searchBox.OnSearchSelectShow()"
83 onmouseout="return searchBox.OnSearchSelectHide()"
84 onkeydown="return searchBox.OnSearchSelectKey(event)">
85</div>
86
87<!-- iframe showing the search results (closed by default) -->
88<div id="MSearchResultsWindow">
89<iframe src="javascript:void(0)" frameborder="0"
90 name="MSearchResults" id="MSearchResults">
91</iframe>
92</div>
93
94<div class="header">
95 <div class="summary">
96<a href="#pub-methods">Public Member Functions</a> &#124;
97<a href="classarmnn_1_1_memory_manager-members.html">List of all members</a> </div>
98 <div class="headertitle">
99<div class="title">MemoryManager Class Reference</div> </div>
100</div><!--header-->
101<div class="contents">
102
103<p><code>#include &lt;<a class="el" href="_memory_manager_8hpp_source.html">MemoryManager.hpp</a>&gt;</code></p>
104<table class="memberdecls">
105<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
106Public Member Functions</h2></td></tr>
107<tr class="memitem:a07bc28679b487cc58281a168c3a1c18b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_memory_manager.html#a07bc28679b487cc58281a168c3a1c18b">StoreMemToAllocate</a> (std::vector&lt; <a class="el" href="structarmnn_1_1_buffer_storage.html">BufferStorage</a> &gt; bufferStorageVector, std::shared_ptr&lt; <a class="el" href="classarmnn_1_1_i_custom_allocator.html">ICustomAllocator</a> &gt; customAllocator, size_t typeAlignment=0)</td></tr>
108<tr class="memdesc:a07bc28679b487cc58281a168c3a1c18b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialization method to store in m_AllocatorBufferStoragePairVector all information needed. <a href="classarmnn_1_1_memory_manager.html#a07bc28679b487cc58281a168c3a1c18b">More...</a><br /></td></tr>
109<tr class="separator:a07bc28679b487cc58281a168c3a1c18b"><td class="memSeparator" colspan="2">&#160;</td></tr>
110<tr class="memitem:a36571ba095c5f84e8dbaee44d9068af8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_memory_manager.html#a36571ba095c5f84e8dbaee44d9068af8">Allocate</a> ()</td></tr>
111<tr class="memdesc:a36571ba095c5f84e8dbaee44d9068af8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocate the amount of memory indicated by m_BufferSize, and point each m_Data to each correspondent <a class="el" href="classarmnn_1_1_tensor.html" title="A tensor defined by a TensorInfo (shape and data type) and a mutable backing store.">Tensor</a> so that they are m_Offset bytes separated. <a href="classarmnn_1_1_memory_manager.html#a36571ba095c5f84e8dbaee44d9068af8">More...</a><br /></td></tr>
112<tr class="separator:a36571ba095c5f84e8dbaee44d9068af8"><td class="memSeparator" colspan="2">&#160;</td></tr>
113<tr class="memitem:afaf63777ab6c7323a7b4eceecdfee3df"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_memory_manager.html#afaf63777ab6c7323a7b4eceecdfee3df">Deallocate</a> ()</td></tr>
114<tr class="memdesc:afaf63777ab6c7323a7b4eceecdfee3df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deallocate memory. <a href="classarmnn_1_1_memory_manager.html#afaf63777ab6c7323a7b4eceecdfee3df">More...</a><br /></td></tr>
115<tr class="separator:afaf63777ab6c7323a7b4eceecdfee3df"><td class="memSeparator" colspan="2">&#160;</td></tr>
116</table>
117<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
118<div class="textblock">
119<p class="definition">Definition at line <a class="el" href="_memory_manager_8hpp_source.html#l00039">39</a> of file <a class="el" href="_memory_manager_8hpp_source.html">MemoryManager.hpp</a>.</p>
120</div><h2 class="groupheader">Member Function Documentation</h2>
121<a id="a36571ba095c5f84e8dbaee44d9068af8"></a>
122<h2 class="memtitle"><span class="permalink"><a href="#a36571ba095c5f84e8dbaee44d9068af8">&#9670;&nbsp;</a></span>Allocate()</h2>
123
124<div class="memitem">
125<div class="memproto">
126 <table class="memname">
127 <tr>
128 <td class="memname">void Allocate </td>
129 <td>(</td>
130 <td class="paramname"></td><td>)</td>
131 <td></td>
132 </tr>
133 </table>
134</div><div class="memdoc">
135
136<p>Allocate the amount of memory indicated by m_BufferSize, and point each m_Data to each correspondent <a class="el" href="classarmnn_1_1_tensor.html" title="A tensor defined by a TensorInfo (shape and data type) and a mutable backing store.">Tensor</a> so that they are m_Offset bytes separated. </p>
137
138<p class="definition">Definition at line <a class="el" href="_memory_manager_8cpp_source.html#l00023">23</a> of file <a class="el" href="_memory_manager_8cpp_source.html">MemoryManager.cpp</a>.</p>
139<div class="fragment"><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;{</div>
140<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">auto</span>&amp; m_AllocatorBufferStoragePair : m_AllocatorBufferStoragePairVector)</div>
141<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; {</div>
142<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keyword">auto</span>&amp; allocator = m_AllocatorBufferStoragePair.first;</div>
143<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">auto</span>&amp;&amp; bufferStorage : m_AllocatorBufferStoragePair.second)</div>
144<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; {</div>
145<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; bufferStorage.m_Buffer = allocator.m_CustomAllocator-&gt;allocate(bufferStorage.m_BufferSize, 0);</div>
146<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div>
147<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">auto</span> tensorMemory : bufferStorage.m_TensorMemoryVector)</div>
148<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; {</div>
149<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; tensorMemory-&gt;m_Data = allocator.m_CustomAllocator-&gt;GetMemoryRegionAtOffset(bufferStorage.m_Buffer,</div>
150<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; tensorMemory-&gt;m_Offset);</div>
151<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; }</div>
152<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; }</div>
153<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; }</div>
154<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;}</div>
155</div><!-- fragment -->
156</div>
157</div>
158<a id="afaf63777ab6c7323a7b4eceecdfee3df"></a>
159<h2 class="memtitle"><span class="permalink"><a href="#afaf63777ab6c7323a7b4eceecdfee3df">&#9670;&nbsp;</a></span>Deallocate()</h2>
160
161<div class="memitem">
162<div class="memproto">
163 <table class="memname">
164 <tr>
165 <td class="memname">void Deallocate </td>
166 <td>(</td>
167 <td class="paramname"></td><td>)</td>
168 <td></td>
169 </tr>
170 </table>
171</div><div class="memdoc">
172
173<p>Deallocate memory. </p>
174
175<p class="definition">Definition at line <a class="el" href="_memory_manager_8cpp_source.html#l00041">41</a> of file <a class="el" href="_memory_manager_8cpp_source.html">MemoryManager.cpp</a>.</p>
176<div class="fragment"><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;{</div>
177<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">auto</span>&amp; m_AllocatorBufferStoragePair : m_AllocatorBufferStoragePairVector)</div>
178<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; {</div>
179<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keyword">auto</span>&amp; allocator = m_AllocatorBufferStoragePair.first;</div>
180<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">auto</span>&amp;&amp; bufferStorage : m_AllocatorBufferStoragePair.second)</div>
181<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; {</div>
182<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; allocator.m_CustomAllocator-&gt;free(bufferStorage.m_Buffer);</div>
183<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; }</div>
184<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; }</div>
185<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;}</div>
186</div><!-- fragment -->
187</div>
188</div>
189<a id="a07bc28679b487cc58281a168c3a1c18b"></a>
190<h2 class="memtitle"><span class="permalink"><a href="#a07bc28679b487cc58281a168c3a1c18b">&#9670;&nbsp;</a></span>StoreMemToAllocate()</h2>
191
192<div class="memitem">
193<div class="memproto">
194 <table class="memname">
195 <tr>
196 <td class="memname">void StoreMemToAllocate </td>
197 <td>(</td>
198 <td class="paramtype">std::vector&lt; <a class="el" href="structarmnn_1_1_buffer_storage.html">BufferStorage</a> &gt;&#160;</td>
199 <td class="paramname"><em>bufferStorageVector</em>, </td>
200 </tr>
201 <tr>
202 <td class="paramkey"></td>
203 <td></td>
204 <td class="paramtype">std::shared_ptr&lt; <a class="el" href="classarmnn_1_1_i_custom_allocator.html">ICustomAllocator</a> &gt;&#160;</td>
205 <td class="paramname"><em>customAllocator</em>, </td>
206 </tr>
207 <tr>
208 <td class="paramkey"></td>
209 <td></td>
210 <td class="paramtype">size_t&#160;</td>
211 <td class="paramname"><em>typeAlignment</em> = <code>0</code>&#160;</td>
212 </tr>
213 <tr>
214 <td></td>
215 <td>)</td>
216 <td></td><td></td>
217 </tr>
218 </table>
219</div><div class="memdoc">
220
221<p>Initialization method to store in m_AllocatorBufferStoragePairVector all information needed. </p>
222<dl class="params"><dt>Parameters</dt><dd>
223 <table class="params">
224 <tr><td class="paramdir">[in]</td><td class="paramname">bufferStorageVector</td><td>- Vector of <a class="el" href="structarmnn_1_1_buffer_storage.html">BufferStorage</a>. </td></tr>
225 <tr><td class="paramdir">[in]</td><td class="paramname">customAllocator</td><td>- Pointer to <a class="el" href="classarmnn_1_1_i_custom_allocator.html" title="Custom Allocator interface.">ICustomAllocator</a>. </td></tr>
226 <tr><td class="paramdir">[in]</td><td class="paramname">typeAlignment</td><td>- <a class="el" href="classarmnn_1_1_optional.html">Optional</a> parameter. Value of which the size of each value has to be multiple of. </td></tr>
227 </table>
228 </dd>
229</dl>
230
231<p class="definition">Definition at line <a class="el" href="_memory_manager_8cpp_source.html#l00013">13</a> of file <a class="el" href="_memory_manager_8cpp_source.html">MemoryManager.cpp</a>.</p>
232<div class="fragment"><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;{</div>
233<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; <a class="code" href="namespacearmnn.html#a44affeeb090c3c6a3062830562672e84">IgnoreUnused</a>(typeAlignment);</div>
234<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; m_AllocatorBufferStoragePairVector.emplace_back(std::make_pair&lt;Allocator, std::vector&lt;BufferStorage&gt;&gt;(</div>
235<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; Allocator{customAllocator},</div>
236<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; std::move(bufferStorageVector)));</div>
237<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;}</div>
238</div><!-- fragment -->
239<p class="reference">References <a class="el" href="_ignore_unused_8hpp_source.html#l00014">armnn::IgnoreUnused()</a>.</p>
240
241</div>
242</div>
243<hr/>The documentation for this class was generated from the following files:<ul>
244<li>src/backends/backendsCommon/<a class="el" href="_memory_manager_8hpp_source.html">MemoryManager.hpp</a></li>
245<li>src/backends/backendsCommon/<a class="el" href="_memory_manager_8cpp_source.html">MemoryManager.cpp</a></li>
246</ul>
247</div><!-- contents -->
248</div><!-- doc-content -->
249<div class="ttc" id="anamespacearmnn_html_a44affeeb090c3c6a3062830562672e84"><div class="ttname"><a href="namespacearmnn.html#a44affeeb090c3c6a3062830562672e84">armnn::IgnoreUnused</a></div><div class="ttdeci">void IgnoreUnused(Ts &amp;&amp;...)</div><div class="ttdef"><b>Definition:</b> <a href="_ignore_unused_8hpp_source.html#l00014">IgnoreUnused.hpp:14</a></div></div>
250<!-- start footer part -->
251<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
252 <ul>
253 <li class="navelem"><a class="el" href="namespacearmnn.html">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_memory_manager.html">MemoryManager</a></li>
254 <li class="footer">Generated on Wed Feb 14 2024 16:36:23 for Arm NN by
255 <a href="http://www.doxygen.org/index.html">
256 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
257 </ul>
258</div>
259</body>
260</html>