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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
<!-- HTML header for doxygen 1.8.17-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Arm NN: include/armnn/backends/ICustomAllocator.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>
<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="customdoxygen.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: 15rem; margin-top: .5rem; margin-left 13px"/>
<td id="projectalign" style="padding-left: 0.9em;">
<div id="projectname">
 <span id="projectnumber">23.11</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&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&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&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_i_custom_allocator_8hpp_source.html',''); initResizable(); });
/* @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">ICustomAllocator.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="_i_custom_allocator_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <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> <span class="comment">// SPDX-License-Identifier: MIT</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">//</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>  </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>  </div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include <cstddef></span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include <memory></span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include <<a class="code" href="_memory_sources_8hpp.html">armnn/MemorySources.hpp</a>></span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include <<a class="code" href="_ignore_unused_8hpp.html">armnn/utility/IgnoreUnused.hpp</a>></span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  </div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="keyword">namespace </span><a class="code" href="namespacearmnn.html">armnn</a></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> {<span class="comment"></span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">/** Custom Allocator interface */</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="classarmnn_1_1_i_custom_allocator.html"> 16</a></span> <span class="keyword">class </span><a class="code" href="classarmnn_1_1_i_custom_allocator.html">ICustomAllocator</a></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> {</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">public</span>:<span class="comment"></span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> /** Default virtual destructor. */</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  <span class="keyword">virtual</span> <a class="code" href="classarmnn_1_1_i_custom_allocator.html#a572445a15a03cbf4cf219e0ef33e6829">~ICustomAllocator</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"></span> </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> /** Interface to be implemented by the child class to allocate bytes</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * @param[in] size Size to allocate</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * @param[in] alignment Alignment that the returned pointer should comply with</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * @return A pointer to the allocated memory</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * The returned pointer must be host write accessible</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span>* <a class="code" href="classarmnn_1_1_i_custom_allocator.html#a6ce9dda753afa9abb498f3d6b673e595">allocate</a>(<span class="keywordtype">size_t</span> size, <span class="keywordtype">size_t</span> alignment) = 0;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"></span> </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> /** Interface to be implemented by the child class to free the allocated bytes */</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1_i_custom_allocator.html#a7dbeba9295a3f52ea54698c31e555dff">free</a>(<span class="keywordtype">void</span>* ptr) = 0;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"></span> </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> /** Used to specify what type of memory is being allocated by this allocator.</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> * Supported types are:</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> * MemorySource::Malloc</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * MemorySource::DmaBuf</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> * MemorySource::DmaBufProtected</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">virtual</span> <a class="code" href="namespacearmnn.html#a14fcd7f88d11cea0a018269dca5f9277">armnn::MemorySource</a> <a class="code" href="classarmnn_1_1_i_custom_allocator.html#abf02353c52af045a9af48bb40f857ad2">GetMemorySourceType</a>() = 0;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"></span> </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> /** Interface that may be implemented to allow retrieval of Memory Region</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> * from allocated buffer at a certain offset</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="classarmnn_1_1_i_custom_allocator.html#a08c6c321801ee51077a5af1fc17b5d6f"> 46</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span>* <a class="code" href="classarmnn_1_1_i_custom_allocator.html#a08c6c321801ee51077a5af1fc17b5d6f">GetMemoryRegionAtOffset</a>(<span class="keywordtype">void</span>* buffer, <span class="keywordtype">size_t</span> offset, <span class="keywordtype">size_t</span> alignment = 0)</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  {</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <a class="code" href="namespacearmnn.html#a44affeeb090c3c6a3062830562672e84">IgnoreUnused</a>(offset);</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="namespacearmnn.html#a44affeeb090c3c6a3062830562672e84">IgnoreUnused</a>(alignment);</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <a class="code" href="namespacearmnn.html#a44affeeb090c3c6a3062830562672e84">IgnoreUnused</a>(buffer);</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordflow">throw</span> <a class="code" href="classarmnn_1_1_exception.html">armnn::Exception</a>(</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="stringliteral">"ICustomerAllocator::GetMemoryRegionAtOffset(): This function should be overridden in subclass."</span>);</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  }</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> };</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> } <span class="comment">// namespace armnn</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aclassarmnn_1_1_i_custom_allocator_html_a08c6c321801ee51077a5af1fc17b5d6f"><div class="ttname"><a href="classarmnn_1_1_i_custom_allocator.html#a08c6c321801ee51077a5af1fc17b5d6f">armnn::ICustomAllocator::GetMemoryRegionAtOffset</a></div><div class="ttdeci">virtual void * GetMemoryRegionAtOffset(void *buffer, size_t offset, size_t alignment=0)</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="_i_custom_allocator_8hpp_source.html#l00046">ICustomAllocator.hpp:46</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_i_custom_allocator_html_a7dbeba9295a3f52ea54698c31e555dff"><div class="ttname"><a href="classarmnn_1_1_i_custom_allocator.html#a7dbeba9295a3f52ea54698c31e555dff">armnn::ICustomAllocator::free</a></div><div class="ttdeci">virtual void free(void *ptr)=0</div><div class="ttdoc">Interface to be implemented by the child class to free the allocated bytes.</div></div>
<div class="ttc" id="aclassarmnn_1_1_i_custom_allocator_html"><div class="ttname"><a href="classarmnn_1_1_i_custom_allocator.html">armnn::ICustomAllocator</a></div><div class="ttdoc">Custom Allocator interface.</div><div class="ttdef"><b>Definition:</b> <a href="_i_custom_allocator_8hpp_source.html#l00016">ICustomAllocator.hpp:16</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_i_custom_allocator_html_a6ce9dda753afa9abb498f3d6b673e595"><div class="ttname"><a href="classarmnn_1_1_i_custom_allocator.html#a6ce9dda753afa9abb498f3d6b673e595">armnn::ICustomAllocator::allocate</a></div><div class="ttdeci">virtual void * allocate(size_t size, size_t alignment)=0</div><div class="ttdoc">Interface to be implemented by the child class to allocate bytes.</div></div>
<div class="ttc" id="a_ignore_unused_8hpp_html"><div class="ttname"><a href="_ignore_unused_8hpp.html">IgnoreUnused.hpp</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_i_custom_allocator_html_a572445a15a03cbf4cf219e0ef33e6829"><div class="ttname"><a href="classarmnn_1_1_i_custom_allocator.html#a572445a15a03cbf4cf219e0ef33e6829">armnn::ICustomAllocator::~ICustomAllocator</a></div><div class="ttdeci">virtual ~ICustomAllocator()=default</div><div class="ttdoc">Default virtual destructor.</div></div>
<div class="ttc" id="aclassarmnn_1_1_exception_html"><div class="ttname"><a href="classarmnn_1_1_exception.html">armnn::Exception</a></div><div class="ttdoc">Base class for all ArmNN exceptions so that users can filter to just those.</div><div class="ttdef"><b>Definition:</b> <a href="_exceptions_8hpp_source.html#l00046">Exceptions.hpp:46</a></div></div>
<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 &&...)</div><div class="ttdef"><b>Definition:</b> <a href="_ignore_unused_8hpp_source.html#l00014">IgnoreUnused.hpp:14</a></div></div>
<div class="ttc" id="anamespacearmnn_html_a14fcd7f88d11cea0a018269dca5f9277"><div class="ttname"><a href="namespacearmnn.html#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.html#l00244">Types.hpp:244</a></div></div>
<div class="ttc" id="anamespacearmnn_html"><div class="ttname"><a href="namespacearmnn.html">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.html#l00006">01_00_quick_start.dox:6</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_i_custom_allocator_html_abf02353c52af045a9af48bb40f857ad2"><div class="ttname"><a href="classarmnn_1_1_i_custom_allocator.html#abf02353c52af045a9af48bb40f857ad2">armnn::ICustomAllocator::GetMemorySourceType</a></div><div class="ttdeci">virtual armnn::MemorySource GetMemorySourceType()=0</div><div class="ttdoc">Used to specify what type of memory is being allocated by this allocator.</div></div>
<div class="ttc" id="a_memory_sources_8hpp_html"><div class="ttname"><a href="_memory_sources_8hpp.html">MemorySources.hpp</a></div></div>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_2b72cc348e06937955e62ebdd8a13436.html">armnn</a></li><li class="navelem"><a class="el" href="dir_8946eb9d8f826e973720979438627a91.html">backends</a></li><li class="navelem"><a class="el" href="_i_custom_allocator_8hpp.html">ICustomAllocator.hpp</a></li>
<li class="footer">Generated on Wed Nov 22 2023 10:57:04 for Arm NN by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
</ul>
</div>
</body>
</html>
|
