blob: 8f7fa5fdda09c8e5f94780c15266e63d1dbcd362 [file] [log] [blame]
<!-- HTML header for doxygen 1.8.15-->
<!-- Remember to use version doxygen 1.8.15 +-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
<title>Compute Library: arm_compute/runtime/MemoryGroup.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="stylesheet.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<img alt="Compute Library" src="https://raw.githubusercontent.com/ARM-software/ComputeLibrary/gh-pages/ACL_logo.png" style="max-width: 100%;margin-top: 15px;margin-left: 10px"/>
<td style="padding-left: 0.5em;">
<div id="projectname">
&#160;<span id="projectnumber">19.11.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_memory_group_8h_source.xhtml','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">MemoryGroup.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="_memory_group_8h.xhtml">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Copyright (c) 2017-2019 ARM Limited.</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * SPDX-License-Identifier: MIT</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a copy</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * of this software and associated documentation files (the &quot;Software&quot;), to</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * deal in the Software without restriction, including without limitation the</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * sell copies of the Software, and to permit persons to whom the Software is</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * furnished to do so, subject to the following conditions:</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * The above copyright notice and this permission notice shall be included in all</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * copies or substantial portions of the Software.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment"> * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment"> * SOFTWARE.</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#ifndef __ARM_COMPUTE_MEMORYGROUP_H__</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#define __ARM_COMPUTE_MEMORYGROUP_H__</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_i_memory_group_8h.xhtml">arm_compute/runtime/IMemoryGroup.h</a>&quot;</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_error_8h.xhtml">arm_compute/core/Error.h</a>&quot;</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="arm__compute_2core_2utils_2misc_2_macros_8h.xhtml">arm_compute/core/utils/misc/Macros.h</a>&quot;</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_i_memory_manager_8h.xhtml">arm_compute/runtime/IMemoryManager.h</a>&quot;</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_i_memory_pool_8h.xhtml">arm_compute/runtime/IMemoryPool.h</a>&quot;</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="preprocessor">#include &lt;cstddef&gt;</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacearm__compute.xhtml">arm_compute</a></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;{</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="comment">// Forward declarations</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="keyword">class </span>IMemory;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="comment">/** Memory group */</span></div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classarm__compute_1_1_memory_group.xhtml"> 43</a></span>&#160;<span class="keyword">class </span><a class="code" href="classarm__compute_1_1_memory_group.xhtml">MemoryGroup</a> final : <span class="keyword">public</span> <a class="code" href="classarm__compute_1_1_i_memory_group.xhtml">IMemoryGroup</a></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;{</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="keyword">public</span>:<span class="comment"></span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="comment"> /** Default Constructor */</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <a class="code" href="classarm__compute_1_1_memory_group.xhtml#aa33537f4c44c5f70da88344b7175a89c">MemoryGroup</a>(<a class="code" href="classarm__compute_1_1_i_memory_manager.xhtml">IMemoryManager</a> *memory_manager);<span class="comment"></span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="comment"> /** Default Constructor */</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <a class="code" href="classarm__compute_1_1_memory_group.xhtml#aa33537f4c44c5f70da88344b7175a89c">MemoryGroup</a>(std::shared_ptr&lt;IMemoryManager&gt; = <span class="keyword">nullptr</span>);<span class="comment"></span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="comment"> /** Default destructor */</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <a class="code" href="classarm__compute_1_1_memory_group.xhtml#a46056e6cb255203af6419491a52cd368">~MemoryGroup</a>() = <span class="keywordflow">default</span>;<span class="comment"></span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="comment"> /** Prevent instances of this class from being copied (As this class contains pointers) */</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <a class="code" href="classarm__compute_1_1_memory_group.xhtml#aa33537f4c44c5f70da88344b7175a89c">MemoryGroup</a>(<span class="keyword">const</span> <a class="code" href="classarm__compute_1_1_memory_group.xhtml">MemoryGroup</a> &amp;) = <span class="keyword">delete</span>;<span class="comment"></span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;<span class="comment"> /** Prevent instances of this class from being copy assigned (As this class contains pointers) */</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <a class="code" href="classarm__compute_1_1_memory_group.xhtml">MemoryGroup</a> &amp;<a class="code" href="classarm__compute_1_1_memory_group.xhtml#aa953e4c826b4c5047cb12d2eace72c40">operator=</a>(<span class="keyword">const</span> <a class="code" href="classarm__compute_1_1_memory_group.xhtml">MemoryGroup</a> &amp;) = <span class="keyword">delete</span>;<span class="comment"></span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="comment"> /** Allow instances of this class to be moved */</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <a class="code" href="classarm__compute_1_1_memory_group.xhtml#aa33537f4c44c5f70da88344b7175a89c">MemoryGroup</a>(<a class="code" href="classarm__compute_1_1_memory_group.xhtml">MemoryGroup</a> &amp;&amp;) = <span class="keywordflow">default</span>;<span class="comment"></span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<span class="comment"> /** Allow instances of this class to be moved */</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <a class="code" href="classarm__compute_1_1_memory_group.xhtml">MemoryGroup</a> &amp;<a class="code" href="classarm__compute_1_1_memory_group.xhtml#aa953e4c826b4c5047cb12d2eace72c40">operator=</a>(<a class="code" href="classarm__compute_1_1_memory_group.xhtml">MemoryGroup</a> &amp;&amp;) = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="comment">// Inherited methods overridden:</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1_memory_group.xhtml#a6fc0a49304c152c20a0f6df0634fb3cd">manage</a>(<a class="code" href="classarm__compute_1_1_i_memory_manageable.xhtml">IMemoryManageable</a> *obj) <span class="keyword">override</span>;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1_memory_group.xhtml#a8cc86941d134b495ca2011482720d00a">finalize_memory</a>(<a class="code" href="classarm__compute_1_1_i_memory_manageable.xhtml">IMemoryManageable</a> *obj, <a class="code" href="classarm__compute_1_1_i_memory.xhtml">IMemory</a> &amp;obj_memory, <span class="keywordtype">size_t</span> size, <span class="keywordtype">size_t</span> alignment) <span class="keyword">override</span>;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1_memory_group.xhtml#a8d16047fa6fdcf5f5453056cc0e1daba">acquire</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1_memory_group.xhtml#ad7ed3842c3160ae4b9f51acbf4564438">release</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <a class="code" href="namespacearm__compute.xhtml#a43b7da220a8ead83acff98f218f7eb6b">MemoryMappings</a> &amp;<a class="code" href="classarm__compute_1_1_memory_group.xhtml#a0a9171fb9c729a0a08b1d0ff3a5e3309">mappings</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; std::shared_ptr&lt;IMemoryManager&gt; _memory_manager; <span class="comment">/**&lt; Memory manager to be used by the group */</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <a class="code" href="classarm__compute_1_1_i_memory_pool.xhtml">IMemoryPool</a> *_pool; <span class="comment">/**&lt; Memory pool that the group is scheduled with */</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <a class="code" href="namespacearm__compute.xhtml#a43b7da220a8ead83acff98f218f7eb6b">MemoryMappings</a> _mappings; <span class="comment">/**&lt; Memory mappings of the group */</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;};</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;</div><div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="classarm__compute_1_1_memory_group.xhtml#a10f9813c4341eabb07918ff6d9cb38d0"> 74</a></span>&#160;<span class="keyword">inline</span> <a class="code" href="classarm__compute_1_1_memory_group.xhtml#aa33537f4c44c5f70da88344b7175a89c">MemoryGroup::MemoryGroup</a>(std::shared_ptr&lt;IMemoryManager&gt; memory_manager)</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; : _memory_manager(memory_manager), _pool(nullptr), _mappings()</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;{</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;}</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;</div><div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="classarm__compute_1_1_memory_group.xhtml#a6fc0a49304c152c20a0f6df0634fb3cd"> 79</a></span>&#160;<span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1_memory_group.xhtml#a6fc0a49304c152c20a0f6df0634fb3cd">MemoryGroup::manage</a>(<a class="code" href="classarm__compute_1_1_i_memory_manageable.xhtml">IMemoryManageable</a> *obj)</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;{</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keywordflow">if</span>(_memory_manager &amp;&amp; (obj != <span class="keyword">nullptr</span>))</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; {</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <a class="code" href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(!_memory_manager-&gt;lifetime_manager());</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="comment">// Defer registration to the first managed object</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; _memory_manager-&gt;lifetime_manager()-&gt;register_group(<span class="keyword">this</span>);</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="comment">// Associate this memory group with the tensor</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; obj-&gt;<a class="code" href="classarm__compute_1_1_i_memory_manageable.xhtml#ace3160d9bb6fdcf5e9973baaaa1fef08">associate_memory_group</a>(<span class="keyword">this</span>);</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="comment">// Start object lifetime</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; _memory_manager-&gt;lifetime_manager()-&gt;start_lifetime(obj);</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; }</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;}</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;</div><div class="line"><a name="l00096"></a><span class="lineno"><a class="line" href="classarm__compute_1_1_memory_group.xhtml#a8cc86941d134b495ca2011482720d00a"> 96</a></span>&#160;<span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1_memory_group.xhtml#a8cc86941d134b495ca2011482720d00a">MemoryGroup::finalize_memory</a>(<a class="code" href="classarm__compute_1_1_i_memory_manageable.xhtml">IMemoryManageable</a> *obj, <a class="code" href="classarm__compute_1_1_i_memory.xhtml">IMemory</a> &amp;obj_memory, <span class="keywordtype">size_t</span> size, <span class="keywordtype">size_t</span> alignment)</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;{</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; <span class="keywordflow">if</span>(_memory_manager)</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; {</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <a class="code" href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(!_memory_manager-&gt;lifetime_manager());</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; _memory_manager-&gt;lifetime_manager()-&gt;end_lifetime(obj, obj_memory, size, alignment);</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; }</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;}</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;</div><div class="line"><a name="l00105"></a><span class="lineno"><a class="line" href="classarm__compute_1_1_memory_group.xhtml#a8d16047fa6fdcf5f5453056cc0e1daba"> 105</a></span>&#160;<span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1_memory_group.xhtml#a8d16047fa6fdcf5f5453056cc0e1daba">MemoryGroup::acquire</a>()</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;{</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; <span class="keywordflow">if</span>(!_mappings.empty())</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; {</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <a class="code" href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(!_memory_manager-&gt;pool_manager());</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; _pool = _memory_manager-&gt;pool_manager()-&gt;lock_pool();</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; _pool-&gt;acquire(_mappings);</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; }</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;}</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;</div><div class="line"><a name="l00115"></a><span class="lineno"><a class="line" href="classarm__compute_1_1_memory_group.xhtml#ad7ed3842c3160ae4b9f51acbf4564438"> 115</a></span>&#160;<span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1_memory_group.xhtml#ad7ed3842c3160ae4b9f51acbf4564438">MemoryGroup::release</a>()</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160;{</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; <span class="keywordflow">if</span>(_pool != <span class="keyword">nullptr</span>)</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; {</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; <a class="code" href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(!_memory_manager-&gt;pool_manager());</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; <a class="code" href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(_mappings.empty());</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; _pool-&gt;<a class="code" href="classarm__compute_1_1_i_memory_pool.xhtml#ab9d340d42cc3ec933f5da369f1f808bb">release</a>(_mappings);</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; _memory_manager-&gt;pool_manager()-&gt;unlock_pool(_pool);</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; _pool = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; }</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160;}</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;</div><div class="line"><a name="l00127"></a><span class="lineno"><a class="line" href="classarm__compute_1_1_memory_group.xhtml#a0a9171fb9c729a0a08b1d0ff3a5e3309"> 127</a></span>&#160;<span class="keyword">inline</span> <a class="code" href="namespacearm__compute.xhtml#a43b7da220a8ead83acff98f218f7eb6b">MemoryMappings</a> &amp;<a class="code" href="classarm__compute_1_1_memory_group.xhtml#a0a9171fb9c729a0a08b1d0ff3a5e3309">MemoryGroup::mappings</a>()</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;{</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; <span class="keywordflow">return</span> _mappings;</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160;}</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;} <span class="comment">// arm_compute</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/*__ARM_COMPUTE_MEMORYGROUP_H__ */</span><span class="preprocessor"></span></div><div class="ttc" id="classarm__compute_1_1_i_memory_group_xhtml"><div class="ttname"><a href="classarm__compute_1_1_i_memory_group.xhtml">arm_compute::IMemoryGroup</a></div><div class="ttdoc">Memory group interface.</div><div class="ttdef"><b>Definition:</b> <a href="_i_memory_group_8h_source.xhtml#l00037">IMemoryGroup.h:37</a></div></div>
<div class="ttc" id="classarm__compute_1_1_memory_group_xhtml"><div class="ttname"><a href="classarm__compute_1_1_memory_group.xhtml">arm_compute::MemoryGroup</a></div><div class="ttdoc">Memory group.</div><div class="ttdef"><b>Definition:</b> <a href="_memory_group_8h_source.xhtml#l00043">MemoryGroup.h:43</a></div></div>
<div class="ttc" id="classarm__compute_1_1_i_memory_xhtml"><div class="ttname"><a href="classarm__compute_1_1_i_memory.xhtml">arm_compute::IMemory</a></div><div class="ttdoc">Memory interface.</div><div class="ttdef"><b>Definition:</b> <a href="_i_memory_8h_source.xhtml#l00032">IMemory.h:32</a></div></div>
<div class="ttc" id="classarm__compute_1_1_i_memory_manager_xhtml"><div class="ttname"><a href="classarm__compute_1_1_i_memory_manager.xhtml">arm_compute::IMemoryManager</a></div><div class="ttdoc">Memory manager interface to handle allocations of backing memory.</div><div class="ttdef"><b>Definition:</b> <a href="_i_memory_manager_8h_source.xhtml#l00039">IMemoryManager.h:39</a></div></div>
<div class="ttc" id="_i_memory_manager_8h_xhtml"><div class="ttname"><a href="_i_memory_manager_8h.xhtml">IMemoryManager.h</a></div></div>
<div class="ttc" id="_error_8h_xhtml_a54a6080c9f4df1f908e57a9bbb46f5da"><div class="ttname"><a href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a></div><div class="ttdeci">#define ARM_COMPUTE_ERROR_ON(cond)</div><div class="ttdoc">If the condition is true then an error message is printed and an exception thrown.</div><div class="ttdef"><b>Definition:</b> <a href="_error_8h_source.xhtml#l00466">Error.h:466</a></div></div>
<div class="ttc" id="_i_memory_pool_8h_xhtml"><div class="ttname"><a href="_i_memory_pool_8h.xhtml">IMemoryPool.h</a></div></div>
<div class="ttc" id="classarm__compute_1_1_i_memory_pool_xhtml"><div class="ttname"><a href="classarm__compute_1_1_i_memory_pool.xhtml">arm_compute::IMemoryPool</a></div><div class="ttdoc">Memory Pool Inteface.</div><div class="ttdef"><b>Definition:</b> <a href="_i_memory_pool_8h_source.xhtml#l00037">IMemoryPool.h:37</a></div></div>
<div class="ttc" id="namespacearm__compute_xhtml"><div class="ttname"><a href="namespacearm__compute.xhtml">arm_compute</a></div><div class="ttdoc">Copyright (c) 2017-2019 ARM Limited.</div><div class="ttdef"><b>Definition:</b> <a href="00__introduction_8dox_source.xhtml#l00024">00_introduction.dox:24</a></div></div>
<div class="ttc" id="classarm__compute_1_1_i_memory_manageable_xhtml_ace3160d9bb6fdcf5e9973baaaa1fef08"><div class="ttname"><a href="classarm__compute_1_1_i_memory_manageable.xhtml#ace3160d9bb6fdcf5e9973baaaa1fef08">arm_compute::IMemoryManageable::associate_memory_group</a></div><div class="ttdeci">virtual void associate_memory_group(IMemoryGroup *memory_group)=0</div><div class="ttdoc">Associates a memory managable object with the memory group that manages it.</div></div>
<div class="ttc" id="classarm__compute_1_1_memory_group_xhtml_a6fc0a49304c152c20a0f6df0634fb3cd"><div class="ttname"><a href="classarm__compute_1_1_memory_group.xhtml#a6fc0a49304c152c20a0f6df0634fb3cd">arm_compute::MemoryGroup::manage</a></div><div class="ttdeci">void manage(IMemoryManageable *obj) override</div><div class="ttdoc">Sets a object to be managed by the given memory group.</div><div class="ttdef"><b>Definition:</b> <a href="_memory_group_8h_source.xhtml#l00079">MemoryGroup.h:79</a></div></div>
<div class="ttc" id="classarm__compute_1_1_i_memory_pool_xhtml_ab9d340d42cc3ec933f5da369f1f808bb"><div class="ttname"><a href="classarm__compute_1_1_i_memory_pool.xhtml#ab9d340d42cc3ec933f5da369f1f808bb">arm_compute::IMemoryPool::release</a></div><div class="ttdeci">virtual void release(MemoryMappings &amp;handles)=0</div><div class="ttdoc">Releases a memory block.</div></div>
<div class="ttc" id="_i_memory_group_8h_xhtml"><div class="ttname"><a href="_i_memory_group_8h.xhtml">IMemoryGroup.h</a></div></div>
<div class="ttc" id="classarm__compute_1_1_memory_group_xhtml_ad7ed3842c3160ae4b9f51acbf4564438"><div class="ttname"><a href="classarm__compute_1_1_memory_group.xhtml#ad7ed3842c3160ae4b9f51acbf4564438">arm_compute::MemoryGroup::release</a></div><div class="ttdeci">void release() override</div><div class="ttdoc">Releases backing memory of the whole group.</div><div class="ttdef"><b>Definition:</b> <a href="_memory_group_8h_source.xhtml#l00115">MemoryGroup.h:115</a></div></div>
<div class="ttc" id="classarm__compute_1_1_memory_group_xhtml_a0a9171fb9c729a0a08b1d0ff3a5e3309"><div class="ttname"><a href="classarm__compute_1_1_memory_group.xhtml#a0a9171fb9c729a0a08b1d0ff3a5e3309">arm_compute::MemoryGroup::mappings</a></div><div class="ttdeci">MemoryMappings &amp; mappings() override</div><div class="ttdoc">Gets the memory mapping of the group.</div><div class="ttdef"><b>Definition:</b> <a href="_memory_group_8h_source.xhtml#l00127">MemoryGroup.h:127</a></div></div>
<div class="ttc" id="_error_8h_xhtml"><div class="ttname"><a href="_error_8h.xhtml">Error.h</a></div></div>
<div class="ttc" id="classarm__compute_1_1_memory_group_xhtml_aa33537f4c44c5f70da88344b7175a89c"><div class="ttname"><a href="classarm__compute_1_1_memory_group.xhtml#aa33537f4c44c5f70da88344b7175a89c">arm_compute::MemoryGroup::MemoryGroup</a></div><div class="ttdeci">MemoryGroup(IMemoryManager *memory_manager)</div><div class="ttdoc">Default Constructor.</div></div>
<div class="ttc" id="classarm__compute_1_1_memory_group_xhtml_a8d16047fa6fdcf5f5453056cc0e1daba"><div class="ttname"><a href="classarm__compute_1_1_memory_group.xhtml#a8d16047fa6fdcf5f5453056cc0e1daba">arm_compute::MemoryGroup::acquire</a></div><div class="ttdeci">void acquire() override</div><div class="ttdoc">Acquires backing memory for the whole group.</div><div class="ttdef"><b>Definition:</b> <a href="_memory_group_8h_source.xhtml#l00105">MemoryGroup.h:105</a></div></div>
<div class="ttc" id="classarm__compute_1_1_i_memory_manageable_xhtml"><div class="ttname"><a href="classarm__compute_1_1_i_memory_manageable.xhtml">arm_compute::IMemoryManageable</a></div><div class="ttdoc">Interface of an object than can be memory managed.</div><div class="ttdef"><b>Definition:</b> <a href="_i_memory_group_8h_source.xhtml#l00069">IMemoryGroup.h:69</a></div></div>
<div class="ttc" id="classarm__compute_1_1_memory_group_xhtml_aa953e4c826b4c5047cb12d2eace72c40"><div class="ttname"><a href="classarm__compute_1_1_memory_group.xhtml#aa953e4c826b4c5047cb12d2eace72c40">arm_compute::MemoryGroup::operator=</a></div><div class="ttdeci">MemoryGroup &amp; operator=(const MemoryGroup &amp;)=delete</div><div class="ttdoc">Prevent instances of this class from being copy assigned (As this class contains pointers)</div></div>
<div class="ttc" id="namespacearm__compute_xhtml_a43b7da220a8ead83acff98f218f7eb6b"><div class="ttname"><a href="namespacearm__compute.xhtml#a43b7da220a8ead83acff98f218f7eb6b">arm_compute::MemoryMappings</a></div><div class="ttdeci">std::map&lt; IMemory *, size_t &gt; MemoryMappings</div><div class="ttdoc">A map of (handle, index/offset), where handle is the memory handle of the object to provide the memor...</div><div class="ttdef"><b>Definition:</b> <a href="arm__compute_2runtime_2_types_8h_source.xhtml#l00045">Types.h:45</a></div></div>
<div class="ttc" id="classarm__compute_1_1_memory_group_xhtml_a8cc86941d134b495ca2011482720d00a"><div class="ttname"><a href="classarm__compute_1_1_memory_group.xhtml#a8cc86941d134b495ca2011482720d00a">arm_compute::MemoryGroup::finalize_memory</a></div><div class="ttdeci">void finalize_memory(IMemoryManageable *obj, IMemory &amp;obj_memory, size_t size, size_t alignment) override</div><div class="ttdoc">Finalizes memory for a given object.</div><div class="ttdef"><b>Definition:</b> <a href="_memory_group_8h_source.xhtml#l00096">MemoryGroup.h:96</a></div></div>
<div class="ttc" id="classarm__compute_1_1_memory_group_xhtml_a46056e6cb255203af6419491a52cd368"><div class="ttname"><a href="classarm__compute_1_1_memory_group.xhtml#a46056e6cb255203af6419491a52cd368">arm_compute::MemoryGroup::~MemoryGroup</a></div><div class="ttdeci">~MemoryGroup()=default</div><div class="ttdoc">Default destructor.</div></div>
<div class="ttc" id="arm__compute_2core_2utils_2misc_2_macros_8h_xhtml"><div class="ttname"><a href="arm__compute_2core_2utils_2misc_2_macros_8h.xhtml">Macros.h</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_214608ef36d61442cb2b0c1c4e9a7def.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="dir_8bc26130589aa16388b5a02f17abf2c2.xhtml">runtime</a></li><li class="navelem"><a class="el" href="_memory_group_8h.xhtml">MemoryGroup.h</a></li>
<li class="footer">Generated on Wed Jan 22 2020 18:07:37 for Compute Library by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
</ul>
</div>
</body>
</html>