aboutsummaryrefslogtreecommitdiff
path: root/21.11/_cl_backend_default_allocator_8hpp_source.xhtml
blob: 17b9a903e8619095d5fb7776f7821160490e43e4 (plain)
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
<!-- Copyright (c) 2020 ARM Limited. -->
<!--                                 -->
<!-- SPDX-License-Identifier: MIT    -->
<!--                                 -->
<!-- HTML header for doxygen 1.8.13-->
<!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.13"/>
<meta name="robots" content="NOINDEX, NOFOLLOW" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ArmNN: src/backends/cl/ClBackendDefaultAllocator.hpp 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">
  $(document).ready(initResizable);
</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" 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="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/>
  <td style="padding-left: 0.5em;">
   <div id="projectname">
   &#160;<span id="projectnumber">21.11</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</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">
$(document).ready(function(){initNavTree('_cl_backend_default_allocator_8hpp_source.xhtml','');});
</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">ClBackendDefaultAllocator.hpp</div>  </div>
</div><!--header-->
<div class="contents">
<a href="_cl_backend_default_allocator_8hpp.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 © 2021 Arm Ltd and Contributors. All rights reserved.</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">// SPDX-License-Identifier: MIT</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="preprocessor">#include &lt;cstddef&gt;</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="_memory_sources_8hpp.xhtml">armnn/MemorySources.hpp</a>&gt;</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="_ignore_unused_8hpp.xhtml">armnn/utility/IgnoreUnused.hpp</a>&gt;</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;</div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacearmnn.xhtml">armnn</a></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">/** Default Memory Allocator class returned from IBackendInternal::GetDefaultAllocator(MemorySource) */</span></div><div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="classarmnn_1_1_cl_backend_default_allocator.xhtml">   14</a></span>&#160;<span class="keyword">class </span><a class="code" href="classarmnn_1_1_cl_backend_default_allocator.xhtml">ClBackendDefaultAllocator</a> : <span class="keyword">public</span> <a class="code" href="classarmnn_1_1_i_custom_allocator.xhtml">armnn::ICustomAllocator</a></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;{</div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;    <a class="code" href="classarmnn_1_1_cl_backend_default_allocator.xhtml#abfc962c683abad5e8da9de3b6fc6445e">ClBackendDefaultAllocator</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="classarmnn_1_1_cl_backend_default_allocator.xhtml#ac1e67a1d72b9220446e80f16350ff12b">   19</a></span>&#160;    <span class="keywordtype">void</span>* <a class="code" href="classarmnn_1_1_cl_backend_default_allocator.xhtml#ac1e67a1d72b9220446e80f16350ff12b">allocate</a>(<span class="keywordtype">size_t</span> size, <span class="keywordtype">size_t</span> alignment = 0)<span class="keyword"> override</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="keyword">    </span>{</div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;        <a class="code" href="namespacearmnn.xhtml#a44affeeb090c3c6a3062830562672e84">IgnoreUnused</a>(alignment);</div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;        cl_mem buf{ clCreateBuffer(arm_compute::CLScheduler::get().context().<span class="keyword">get</span>(),</div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;                                   CL_MEM_ALLOC_HOST_PTR | CL_MEM_READ_WRITE,</div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;                                   size,</div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;                                   <span class="keyword">nullptr</span>,</div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;                                   <span class="keyword">nullptr</span>)};</div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;        <span class="keywordflow">return</span> <span class="keyword">static_cast&lt;</span><span class="keywordtype">void</span> *<span class="keyword">&gt;</span>(buf);</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;</div><div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="classarmnn_1_1_cl_backend_default_allocator.xhtml#abbd17af5b3fbeff226e4051433c1b929">   30</a></span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1_cl_backend_default_allocator.xhtml#abbd17af5b3fbeff226e4051433c1b929">free</a>(<span class="keywordtype">void</span>* ptr)<span class="keyword"> override</span></div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="keyword">    </span>{</div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;        ARM_COMPUTE_ERROR_ON(ptr == <span class="keyword">nullptr</span>);</div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;        clReleaseMemObject(static_cast&lt;cl_mem&gt;(ptr));</div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;    }</div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;</div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classarmnn_1_1_cl_backend_default_allocator.xhtml#a6b2cd9a186746b493f029fb93bb13226">   36</a></span>&#160;    <a class="code" href="namespacearmnn.xhtml#a14fcd7f88d11cea0a018269dca5f9277">armnn::MemorySource</a> <a class="code" href="classarmnn_1_1_cl_backend_default_allocator.xhtml#a6b2cd9a186746b493f029fb93bb13226">GetMemorySourceType</a>()<span class="keyword"> override</span></div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="keyword">    </span>{</div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;        <span class="keywordflow">return</span> <a class="code" href="namespacearmnn.xhtml#a14fcd7f88d11cea0a018269dca5f9277a4bafe7f8ad22a8eca972a7ac5eb6702e">armnn::MemorySource::Gralloc</a>;</div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;    }</div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;</div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classarmnn_1_1_cl_backend_default_allocator.xhtml#a70ba99b0598f9e19b1c81e55e3b3ec8a">   41</a></span>&#160;    <span class="keywordtype">void</span>* <a class="code" href="classarmnn_1_1_cl_backend_default_allocator.xhtml#a70ba99b0598f9e19b1c81e55e3b3ec8a">GetMemoryRegionAtOffset</a>(<span class="keywordtype">void</span>* buffer, <span class="keywordtype">size_t</span> offset, <span class="keywordtype">size_t</span> alignment = 0)<span class="keyword"> override</span></div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="keyword">    </span>{</div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;        <a class="code" href="namespacearmnn.xhtml#a44affeeb090c3c6a3062830562672e84">IgnoreUnused</a>(alignment);</div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;        <span class="keywordflow">return</span> <span class="keyword">static_cast&lt;</span><span class="keywordtype">char</span>*<span class="keyword">&gt;</span>(buffer) + offset;</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;    }</div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;};</div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;} <span class="comment">// namespace armnn</span></div><div class="ttc" id="classarmnn_1_1_i_custom_allocator_xhtml"><div class="ttname"><a href="classarmnn_1_1_i_custom_allocator.xhtml">armnn::ICustomAllocator</a></div><div class="ttdoc">Custom Allocator interface. </div><div class="ttdef"><b>Definition:</b> <a href="_i_custom_allocator_8hpp_source.xhtml#l00016">ICustomAllocator.hpp:16</a></div></div>
<div class="ttc" id="_ignore_unused_8hpp_xhtml"><div class="ttname"><a href="_ignore_unused_8hpp.xhtml">IgnoreUnused.hpp</a></div></div>
<div class="ttc" id="classarmnn_1_1_cl_backend_default_allocator_xhtml"><div class="ttname"><a href="classarmnn_1_1_cl_backend_default_allocator.xhtml">armnn::ClBackendDefaultAllocator</a></div><div class="ttdoc">Default Memory Allocator class returned from IBackendInternal::GetDefaultAllocator(MemorySource) ...</div><div class="ttdef"><b>Definition:</b> <a href="_cl_backend_default_allocator_8hpp_source.xhtml#l00014">ClBackendDefaultAllocator.hpp:14</a></div></div>
<div class="ttc" id="classarmnn_1_1_cl_backend_default_allocator_xhtml_abbd17af5b3fbeff226e4051433c1b929"><div class="ttname"><a href="classarmnn_1_1_cl_backend_default_allocator.xhtml#abbd17af5b3fbeff226e4051433c1b929">armnn::ClBackendDefaultAllocator::free</a></div><div class="ttdeci">void free(void *ptr) override</div><div class="ttdoc">Interface to be implemented by the child class to free the allocated bytes. </div><div class="ttdef"><b>Definition:</b> <a href="_cl_backend_default_allocator_8hpp_source.xhtml#l00030">ClBackendDefaultAllocator.hpp:30</a></div></div>
<div class="ttc" id="classarmnn_1_1_cl_backend_default_allocator_xhtml_a6b2cd9a186746b493f029fb93bb13226"><div class="ttname"><a href="classarmnn_1_1_cl_backend_default_allocator.xhtml#a6b2cd9a186746b493f029fb93bb13226">armnn::ClBackendDefaultAllocator::GetMemorySourceType</a></div><div class="ttdeci">armnn::MemorySource GetMemorySourceType() override</div><div class="ttdoc">Used to specify what type of memory is being allocated by this allocator. </div><div class="ttdef"><b>Definition:</b> <a href="_cl_backend_default_allocator_8hpp_source.xhtml#l00036">ClBackendDefaultAllocator.hpp:36</a></div></div>
<div class="ttc" id="classarmnn_1_1_cl_backend_default_allocator_xhtml_ac1e67a1d72b9220446e80f16350ff12b"><div class="ttname"><a href="classarmnn_1_1_cl_backend_default_allocator.xhtml#ac1e67a1d72b9220446e80f16350ff12b">armnn::ClBackendDefaultAllocator::allocate</a></div><div class="ttdeci">void * allocate(size_t size, size_t alignment=0) override</div><div class="ttdoc">Interface to be implemented by the child class to allocate bytes. </div><div class="ttdef"><b>Definition:</b> <a href="_cl_backend_default_allocator_8hpp_source.xhtml#l00019">ClBackendDefaultAllocator.hpp:19</a></div></div>
<div class="ttc" id="namespacearmnn_xhtml"><div class="ttname"><a href="namespacearmnn.xhtml">armnn</a></div><div class="ttdoc">Copyright (c) 2021 ARM Limited and Contributors. </div><div class="ttdef"><b>Definition:</b> <a href="01__00__quick__start_8dox_source.xhtml#l00006">01_00_quick_start.dox:6</a></div></div>
<div class="ttc" id="namespacearmnn_xhtml_a44affeeb090c3c6a3062830562672e84"><div class="ttname"><a href="namespacearmnn.xhtml#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.xhtml#l00014">IgnoreUnused.hpp:14</a></div></div>
<div class="ttc" id="classarmnn_1_1_cl_backend_default_allocator_xhtml_a70ba99b0598f9e19b1c81e55e3b3ec8a"><div class="ttname"><a href="classarmnn_1_1_cl_backend_default_allocator.xhtml#a70ba99b0598f9e19b1c81e55e3b3ec8a">armnn::ClBackendDefaultAllocator::GetMemoryRegionAtOffset</a></div><div class="ttdeci">void * GetMemoryRegionAtOffset(void *buffer, size_t offset, size_t alignment=0) override</div><div class="ttdoc">Interface that may be implemented to allow retrieval of Memory Region from allocated buffer at a cert...</div><div class="ttdef"><b>Definition:</b> <a href="_cl_backend_default_allocator_8hpp_source.xhtml#l00041">ClBackendDefaultAllocator.hpp:41</a></div></div>
<div class="ttc" id="_memory_sources_8hpp_xhtml"><div class="ttname"><a href="_memory_sources_8hpp.xhtml">MemorySources.hpp</a></div></div>
<div class="ttc" id="namespacearmnn_xhtml_a14fcd7f88d11cea0a018269dca5f9277a4bafe7f8ad22a8eca972a7ac5eb6702e"><div class="ttname"><a href="namespacearmnn.xhtml#a14fcd7f88d11cea0a018269dca5f9277a4bafe7f8ad22a8eca972a7ac5eb6702e">armnn::MemorySource::Gralloc</a></div></div>
<div class="ttc" id="classarmnn_1_1_cl_backend_default_allocator_xhtml_abfc962c683abad5e8da9de3b6fc6445e"><div class="ttname"><a href="classarmnn_1_1_cl_backend_default_allocator.xhtml#abfc962c683abad5e8da9de3b6fc6445e">armnn::ClBackendDefaultAllocator::ClBackendDefaultAllocator</a></div><div class="ttdeci">ClBackendDefaultAllocator()=default</div></div>
<div class="ttc" id="namespacearmnn_xhtml_a14fcd7f88d11cea0a018269dca5f9277"><div class="ttname"><a href="namespacearmnn.xhtml#a14fcd7f88d11cea0a018269dca5f9277">armnn::MemorySource</a></div><div class="ttdeci">MemorySource</div><div class="ttdoc">Define the Memory Source to reduce copies. </div><div class="ttdef"><b>Definition:</b> <a href="_types_8hpp_source.xhtml#l00217">Types.hpp:217</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_68267d1309a1af8e8297ef4c3efbcdba.xhtml">src</a></li><li class="navelem"><a class="el" href="dir_0f3cdec46afbc61a1ded8e1687c9c9a0.xhtml">backends</a></li><li class="navelem"><a class="el" href="dir_1ad86c6d39ab715a831555571b9e98a5.xhtml">cl</a></li><li class="navelem"><a class="el" href="_cl_backend_default_allocator_8hpp.xhtml">ClBackendDefaultAllocator.hpp</a></li>
    <li class="footer">Generated on Wed Nov 17 2021 12:59:35 for ArmNN by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>