Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / refs/heads/gh-pages / . / 22.11 / classarmnn_1_1_cl_backend_1_1_cl_backend_custom_allocator_wrapper.xhtml
blob: 4d909a20ef197aa7e124153f2799501146a3e889 [file] [log] [blame]
Nikhil Rajcb063092022-11-23 11:05:29 +0000[diff] [blame]1<!-- Copyright (c) 2020 ARM Limited. -->
2<!-- -->
3<!-- SPDX-License-Identifier: MIT -->
4<!-- -->
5<!-- HTML header for doxygen 1.8.13-->
6<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
7<html xmlns="http://www.w3.org/1999/xhtml">
8<head>
9<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
10<meta http-equiv="X-UA-Compatible" content="IE=9"/>
11<meta name="generator" content="Doxygen 1.8.13"/>
12<meta name="robots" content="NOINDEX, NOFOLLOW" />
13<meta name="viewport" content="width=device-width, initial-scale=1"/>
14<title>ArmNN: ClBackend::ClBackendCustomAllocatorWrapper Class Reference</title>
15<link href="tabs.css" rel="stylesheet" type="text/css"/>
16<script type="text/javascript" src="jquery.js"></script>
17<script type="text/javascript" src="dynsections.js"></script>
18<link href="navtree.css" rel="stylesheet" type="text/css"/>
19<script type="text/javascript" src="resize.js"></script>
20<script type="text/javascript" src="navtreedata.js"></script>
21<script type="text/javascript" src="navtree.js"></script>
22<script type="text/javascript">
23 $(document).ready(initResizable);
24</script>
25<link href="search/search.css" rel="stylesheet" type="text/css"/>
26<script type="text/javascript" src="search/searchdata.js"></script>
27<script type="text/javascript" src="search/search.js"></script>
28<script type="text/x-mathjax-config">
29 MathJax.Hub.Config({
30 extensions: ["tex2jax.js"],
31 jax: ["input/TeX","output/HTML-CSS"],
32});
33</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
34<link href="doxygen.css" rel="stylesheet" type="text/css" />
35<link href="stylesheet.css" rel="stylesheet" type="text/css"/>
36</head>
37<body>
38<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
39<div id="titlearea">
40<table cellspacing="0" cellpadding="0">
41 <tbody>
42 <tr style="height: 56px;">
43 <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/>
44 <td style="padding-left: 0.5em;">
45 <div id="projectname">
46 &#160;<span id="projectnumber">22.11</span>
47 </div>
48 </td>
49 </tr>
50 </tbody>
51</table>
52</div>
53<!-- end header part -->
54<!-- Generated by Doxygen 1.8.13 -->
55<script type="text/javascript">
56var searchBox = new SearchBox("searchBox", "search",false,'Search');
57</script>
58<script type="text/javascript" src="menudata.js"></script>
59<script type="text/javascript" src="menu.js"></script>
60<script type="text/javascript">
61$(function() {
62 initMenu('',true,false,'search.php','Search');
63 $(document).ready(function() { init_search(); });
64});
65</script>
66<div id="main-nav"></div>
67</div><!-- top -->
68<div id="side-nav" class="ui-resizable side-nav-resizable">
69 <div id="nav-tree">
70 <div id="nav-tree-contents">
71 <div id="nav-sync" class="sync"></div>
72 </div>
73 </div>
74 <div id="splitbar" style="-moz-user-select:none;"
75 class="ui-resizable-handle">
76 </div>
77</div>
78<script type="text/javascript">
79$(document).ready(function(){initNavTree('classarmnn_1_1_cl_backend_1_1_cl_backend_custom_allocator_wrapper.xhtml','');});
80</script>
81<div id="doc-content">
82<!-- window showing the filter options -->
83<div id="MSearchSelectWindow"
84 onmouseover="return searchBox.OnSearchSelectShow()"
85 onmouseout="return searchBox.OnSearchSelectHide()"
86 onkeydown="return searchBox.OnSearchSelectKey(event)">
87</div>
88
89<!-- iframe showing the search results (closed by default) -->
90<div id="MSearchResultsWindow">
91<iframe src="javascript:void(0)" frameborder="0"
92 name="MSearchResults" id="MSearchResults">
93</iframe>
94</div>
95
96<div class="header">
97 <div class="summary">
98<a href="#pub-methods">Public Member Functions</a> &#124;
99<a href="classarmnn_1_1_cl_backend_1_1_cl_backend_custom_allocator_wrapper-members.xhtml">List of all members</a> </div>
100 <div class="headertitle">
101<div class="title">ClBackend::ClBackendCustomAllocatorWrapper Class Reference</div> </div>
102</div><!--header-->
103<div class="contents">
104
105<p><code>#include &lt;<a class="el" href="_cl_backend_8hpp_source.xhtml">ClBackend.hpp</a>&gt;</code></p>
106<div class="dynheader">
107Inheritance diagram for ClBackend::ClBackendCustomAllocatorWrapper:</div>
108<div class="dyncontent">
109 <div class="center">
110 <img src="classarmnn_1_1_cl_backend_1_1_cl_backend_custom_allocator_wrapper.png" usemap="#ClBackend::ClBackendCustomAllocatorWrapper_map" alt=""/>
111 <map id="ClBackend::ClBackendCustomAllocatorWrapper_map" name="ClBackend::ClBackendCustomAllocatorWrapper_map">
112</map>
113 </div></div>
114<table class="memberdecls">
115<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
116Public Member Functions</h2></td></tr>
117<tr class="memitem:acd00af9a7ba0a698230b82b675160c6b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_cl_backend_1_1_cl_backend_custom_allocator_wrapper.xhtml#acd00af9a7ba0a698230b82b675160c6b">ClBackendCustomAllocatorWrapper</a> (std::shared_ptr&lt; <a class="el" href="classarmnn_1_1_i_custom_allocator.xhtml">ICustomAllocator</a> &gt; alloc)</td></tr>
118<tr class="separator:acd00af9a7ba0a698230b82b675160c6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
119<tr class="memitem:aae0c9f2cf99b1724ec4a6d4e292327d2"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_cl_backend_1_1_cl_backend_custom_allocator_wrapper.xhtml#aae0c9f2cf99b1724ec4a6d4e292327d2">allocate</a> (size_t size, size_t alignment) override</td></tr>
120<tr class="separator:aae0c9f2cf99b1724ec4a6d4e292327d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
121<tr class="memitem:abbd17af5b3fbeff226e4051433c1b929"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_cl_backend_1_1_cl_backend_custom_allocator_wrapper.xhtml#abbd17af5b3fbeff226e4051433c1b929">free</a> (void *ptr) override</td></tr>
122<tr class="separator:abbd17af5b3fbeff226e4051433c1b929"><td class="memSeparator" colspan="2">&#160;</td></tr>
123<tr class="memitem:abf2dabeaea489183b26da69ab593165b"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; arm_compute::IMemoryRegion &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_cl_backend_1_1_cl_backend_custom_allocator_wrapper.xhtml#abf2dabeaea489183b26da69ab593165b">make_region</a> (size_t size, size_t alignment) override</td></tr>
124<tr class="separator:abf2dabeaea489183b26da69ab593165b"><td class="memSeparator" colspan="2">&#160;</td></tr>
125</table>
126<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
127<div class="textblock">
128<p class="definition">Definition at line <a class="el" href="_cl_backend_8hpp_source.xhtml#l00113">113</a> of file <a class="el" href="_cl_backend_8hpp_source.xhtml">ClBackend.hpp</a>.</p>
129</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
130<a id="acd00af9a7ba0a698230b82b675160c6b"></a>
131<h2 class="memtitle"><span class="permalink"><a href="#acd00af9a7ba0a698230b82b675160c6b">&#9670;&nbsp;</a></span>ClBackendCustomAllocatorWrapper()</h2>
132
133<div class="memitem">
134<div class="memproto">
135<table class="mlabels">
136 <tr>
137 <td class="mlabels-left">
138 <table class="memname">
139 <tr>
140 <td class="memname"><a class="el" href="classarmnn_1_1_cl_backend_1_1_cl_backend_custom_allocator_wrapper.xhtml">ClBackendCustomAllocatorWrapper</a> </td>
141 <td>(</td>
142 <td class="paramtype">std::shared_ptr&lt; <a class="el" href="classarmnn_1_1_i_custom_allocator.xhtml">ICustomAllocator</a> &gt;&#160;</td>
143 <td class="paramname"><em>alloc</em></td><td>)</td>
144 <td></td>
145 </tr>
146 </table>
147 </td>
148 <td class="mlabels-right">
149<span class="mlabels"><span class="mlabel">inline</span></span> </td>
150 </tr>
151</table>
152</div><div class="memdoc">
153
154<p class="definition">Definition at line <a class="el" href="_cl_backend_8hpp_source.xhtml#l00116">116</a> of file <a class="el" href="_cl_backend_8hpp_source.xhtml">ClBackend.hpp</a>.</p>
155<div class="fragment"><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; : m_CustomAllocator(alloc)</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; {}</div></div><!-- fragment -->
156</div>
157</div>
158<h2 class="groupheader">Member Function Documentation</h2>
159<a id="aae0c9f2cf99b1724ec4a6d4e292327d2"></a>
160<h2 class="memtitle"><span class="permalink"><a href="#aae0c9f2cf99b1724ec4a6d4e292327d2">&#9670;&nbsp;</a></span>allocate()</h2>
161
162<div class="memitem">
163<div class="memproto">
164<table class="mlabels">
165 <tr>
166 <td class="mlabels-left">
167 <table class="memname">
168 <tr>
169 <td class="memname">void* allocate </td>
170 <td>(</td>
171 <td class="paramtype">size_t&#160;</td>
172 <td class="paramname"><em>size</em>, </td>
173 </tr>
174 <tr>
175 <td class="paramkey"></td>
176 <td></td>
177 <td class="paramtype">size_t&#160;</td>
178 <td class="paramname"><em>alignment</em>&#160;</td>
179 </tr>
180 <tr>
181 <td></td>
182 <td>)</td>
183 <td></td><td></td>
184 </tr>
185 </table>
186 </td>
187 <td class="mlabels-right">
188<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span></span> </td>
189 </tr>
190</table>
191</div><div class="memdoc">
192
193<p class="definition">Definition at line <a class="el" href="_cl_backend_8hpp_source.xhtml#l00119">119</a> of file <a class="el" href="_cl_backend_8hpp_source.xhtml">ClBackend.hpp</a>.</p>
194<div class="fragment"><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; {</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; <span class="keyword">auto</span> alloc = m_CustomAllocator-&gt;allocate(size, alignment);</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; <span class="keywordflow">return</span> MapAllocatedMemory(alloc, size, m_CustomAllocator-&gt;GetMemorySourceType());</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; }</div></div><!-- fragment -->
195</div>
196</div>
197<a id="abbd17af5b3fbeff226e4051433c1b929"></a>
198<h2 class="memtitle"><span class="permalink"><a href="#abbd17af5b3fbeff226e4051433c1b929">&#9670;&nbsp;</a></span>free()</h2>
199
200<div class="memitem">
201<div class="memproto">
202<table class="mlabels">
203 <tr>
204 <td class="mlabels-left">
205 <table class="memname">
206 <tr>
207 <td class="memname">void free </td>
208 <td>(</td>
209 <td class="paramtype">void *&#160;</td>
210 <td class="paramname"><em>ptr</em></td><td>)</td>
211 <td></td>
212 </tr>
213 </table>
214 </td>
215 <td class="mlabels-right">
216<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span></span> </td>
217 </tr>
218</table>
219</div><div class="memdoc">
220
221<p class="definition">Definition at line <a class="el" href="_cl_backend_8hpp_source.xhtml#l00124">124</a> of file <a class="el" href="_cl_backend_8hpp_source.xhtml">ClBackend.hpp</a>.</p>
222<div class="fragment"><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; <span class="keyword">auto</span> hostMemPtr = m_AllocatedBufferMappings[ptr];</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; clReleaseMemObject(static_cast&lt;cl_mem&gt;(ptr));</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; m_CustomAllocator-&gt;free(hostMemPtr);</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; }</div></div><!-- fragment -->
223</div>
224</div>
225<a id="abf2dabeaea489183b26da69ab593165b"></a>
226<h2 class="memtitle"><span class="permalink"><a href="#abf2dabeaea489183b26da69ab593165b">&#9670;&nbsp;</a></span>make_region()</h2>
227
228<div class="memitem">
229<div class="memproto">
230<table class="mlabels">
231 <tr>
232 <td class="mlabels-left">
233 <table class="memname">
234 <tr>
235 <td class="memname">std::unique_ptr&lt;arm_compute::IMemoryRegion&gt; make_region </td>
236 <td>(</td>
237 <td class="paramtype">size_t&#160;</td>
238 <td class="paramname"><em>size</em>, </td>
239 </tr>
240 <tr>
241 <td class="paramkey"></td>
242 <td></td>
243 <td class="paramtype">size_t&#160;</td>
244 <td class="paramname"><em>alignment</em>&#160;</td>
245 </tr>
246 <tr>
247 <td></td>
248 <td>)</td>
249 <td></td><td></td>
250 </tr>
251 </table>
252 </td>
253 <td class="mlabels-right">
254<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span></span> </td>
255 </tr>
256</table>
257</div><div class="memdoc">
258
259<p class="definition">Definition at line <a class="el" href="_cl_backend_8hpp_source.xhtml#l00130">130</a> of file <a class="el" href="_cl_backend_8hpp_source.xhtml">ClBackend.hpp</a>.</p>
260
261<p class="reference">References <a class="el" href="namespacearmnn.xhtml#a14fcd7f88d11cea0a018269dca5f9277a966e13d8aabbff3966a5cd28d67b4846">armnn::DmaBuf</a>, <a class="el" href="namespacearmnn.xhtml#a14fcd7f88d11cea0a018269dca5f9277a7f9067c59dd34aca0ad09a7f283ed1f8">armnn::DmaBufProtected</a>, <a class="el" href="namespacearmnn.xhtml#a4dc0adc6737b5944e7671bee71788407acb5e100e5a9a3e7f6d1fd97512215282">armnn::error</a>, and <a class="el" href="namespacearmnn.xhtml#a14fcd7f88d11cea0a018269dca5f9277a1131a914388fac73e5f07b0ba0aad523">armnn::Malloc</a>.</p>
262<div class="fragment"><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; {</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; <span class="keyword">auto</span> hostMemPtr = m_CustomAllocator-&gt;allocate(size, alignment);</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; cl_mem buffer = MapAllocatedMemory(hostMemPtr, size, m_CustomAllocator-&gt;GetMemorySourceType());</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160;</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; <span class="keywordflow">return</span> std::make_unique&lt;ClBackendCustomAllocatorMemoryRegion&gt;(cl::Buffer(buffer),</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; hostMemPtr,</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; m_CustomAllocator-&gt;GetMemorySourceType());</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; }</div></div><!-- fragment -->
263</div>
264</div>
265<hr/>The documentation for this class was generated from the following file:<ul>
266<li>src/backends/cl/<a class="el" href="_cl_backend_8hpp_source.xhtml">ClBackend.hpp</a></li>
267</ul>
268</div><!-- contents -->
269</div><!-- doc-content -->
270<!-- start footer part -->
271<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
272 <ul>
273 <li class="navelem"><a class="el" href="namespacearmnn.xhtml">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_cl_backend.xhtml">ClBackend</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_cl_backend_1_1_cl_backend_custom_allocator_wrapper.xhtml">ClBackendCustomAllocatorWrapper</a></li>
274 <li class="footer">Generated on Wed Nov 23 2022 10:57:39 for ArmNN by
275 <a href="http://www.doxygen.org/index.html">
276 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
277 </ul>
278</div>
279</body>
280</html>