Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / refs/heads/gh-pages / . / 24.02 / _dynamic_backend_8hpp_source.html
blob: e1f6a4dff62f873200b11aa572db66a97b3b7383 [file] [log] [blame]
<!-- 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/DynamicBackend.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">
&#160;<span id="projectnumber">24.02</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&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('_dynamic_backend_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">DynamicBackend.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="_dynamic_backend_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>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// Copyright © 2017,2022 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; </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160; </div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_i_backend_internal_8hpp.html">IBackendInternal.hpp</a>&quot;</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="_backend_registry_8hpp.html">armnn/BackendRegistry.hpp</a>&gt;</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="_backend_id_8hpp.html">armnn/BackendId.hpp</a>&gt;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; </div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#include &lt;stdint.h&gt;</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#include &lt;functional&gt;</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; </div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacearmnn.html">armnn</a></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"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="classarmnn_1_1_dynamic_backend.html"> 20</a></span>&#160;<span class="keyword">class </span><a class="code" href="classarmnn_1_1_dynamic_backend.html">DynamicBackend</a> final</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;{</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="classarmnn_1_1_dynamic_backend.html#afc391d6dc3d75baff0e86b70ae710a50"> 23</a></span>&#160; <span class="keyword">using</span> <a class="code" href="classarmnn_1_1_dynamic_backend.html#afc391d6dc3d75baff0e86b70ae710a50">HandleCloser</a> = std::function&lt;void(<span class="keyword">const</span> <span class="keywordtype">void</span>*)&gt;;</div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="classarmnn_1_1_dynamic_backend.html#a8bdc460894ec6fe25c7754d0d5d10866"> 24</a></span>&#160; <span class="keyword">using</span> <a class="code" href="classarmnn_1_1_dynamic_backend.html#a8bdc460894ec6fe25c7754d0d5d10866">HandlePtr</a> = std::unique_ptr&lt;void, HandleCloser&gt;;</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keyword">explicit</span> <a class="code" href="classarmnn_1_1_dynamic_backend.html#a1c1454fae6258415712b5e720023fbd1">DynamicBackend</a>(<span class="keyword">const</span> <span class="keywordtype">void</span>* sharedObjectHandle);</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="comment"> /// Public dynamic backend functions</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="comment"></span> <a class="code" href="classarmnn_1_1_backend_id.html">BackendId</a> <a class="code" href="classarmnn_1_1_dynamic_backend.html#a6deb5373920ee59a800eca6b01085654">GetBackendId</a>();</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <a class="code" href="structarmnn_1_1_backend_version.html">BackendVersion</a> <a class="code" href="classarmnn_1_1_dynamic_backend.html#a74db049ad0000a58b9a58a6cd6d88feb">GetBackendVersion</a>();</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <a class="code" href="namespacearmnn.html#ade0af9dacaa52cafdd701bef2e901c77">IBackendInternalUniquePtr</a> <a class="code" href="classarmnn_1_1_dynamic_backend.html#a9d10388a851fc1a748c3e385f484b52a">GetBackend</a>();</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <a class="code" href="classarmnn_1_1_backend_registry.html#aa33ac375677ee8436456a585dd6f68d9">BackendRegistry::FactoryFunction</a> <a class="code" href="classarmnn_1_1_dynamic_backend.html#a4c24f07cb0b4bff43655dfdbd5eac539">GetFactoryFunction</a>();</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="keyword">private</span>:<span class="comment"></span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="comment"> /// Private utility functions</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="comment"></span> <span class="keyword">template</span>&lt;<span class="keyword">typename</span> BackendFunctionType&gt;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; BackendFunctionType SetFunctionPointer(<span class="keyword">const</span> std::string&amp; backendFunctionName);</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <a class="code" href="namespacearmnn.html#ade0af9dacaa52cafdd701bef2e901c77">IBackendInternalUniquePtr</a> CreateBackend();</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="comment"> /// Backend function pointer types</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="comment"></span> <span class="keyword">using</span> IdFunctionType = <span class="keyword">const</span> <span class="keywordtype">char</span>*(*)();</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keyword">using</span> VersionFunctionType = void(*)(uint32_t*, uint32_t*);</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keyword">using</span> FactoryFunctionType = <span class="keywordtype">void</span>*(*)();</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="comment"> /// Backend function pointers</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="comment"></span> IdFunctionType m_BackendIdFunction;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; VersionFunctionType m_BackendVersionFunction;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; FactoryFunctionType m_BackendFactoryFunction;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="comment"> /// Shared object handle</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="comment"></span> <a class="code" href="classarmnn_1_1_dynamic_backend.html#a8bdc460894ec6fe25c7754d0d5d10866">HandlePtr</a> m_Handle;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;};</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; </div>
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="namespacearmnn.html#a754d43dc24a0fe36ecb3044d8f13a413"> 54</a></span>&#160;<span class="keyword">using</span> <a class="code" href="namespacearmnn.html#a754d43dc24a0fe36ecb3044d8f13a413">DynamicBackendPtr</a> = std::unique_ptr&lt;DynamicBackend&gt;;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;} <span class="comment">// namespace armnn</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="anamespacearmnn_html_a754d43dc24a0fe36ecb3044d8f13a413"><div class="ttname"><a href="namespacearmnn.html#a754d43dc24a0fe36ecb3044d8f13a413">armnn::DynamicBackendPtr</a></div><div class="ttdeci">std::unique_ptr&lt; DynamicBackend &gt; DynamicBackendPtr</div><div class="ttdef"><b>Definition:</b> <a href="_dynamic_backend_8hpp_source.html#l00054">DynamicBackend.hpp:54</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_dynamic_backend_html_afc391d6dc3d75baff0e86b70ae710a50"><div class="ttname"><a href="classarmnn_1_1_dynamic_backend.html#afc391d6dc3d75baff0e86b70ae710a50">armnn::DynamicBackend::HandleCloser</a></div><div class="ttdeci">std::function&lt; void(const void *)&gt; HandleCloser</div><div class="ttdef"><b>Definition:</b> <a href="_dynamic_backend_8hpp_source.html#l00023">DynamicBackend.hpp:23</a></div></div>
<div class="ttc" id="a_backend_id_8hpp_html"><div class="ttname"><a href="_backend_id_8hpp.html">BackendId.hpp</a></div></div>
<div class="ttc" id="a_backend_registry_8hpp_html"><div class="ttname"><a href="_backend_registry_8hpp.html">BackendRegistry.hpp</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_backend_registry_html_aa33ac375677ee8436456a585dd6f68d9"><div class="ttname"><a href="classarmnn_1_1_backend_registry.html#aa33ac375677ee8436456a585dd6f68d9">armnn::BackendRegistry::FactoryFunction</a></div><div class="ttdeci">std::function&lt; PointerType()&gt; FactoryFunction</div><div class="ttdef"><b>Definition:</b> <a href="_backend_registry_8hpp_source.html#l00039">BackendRegistry.hpp:39</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_dynamic_backend_html"><div class="ttname"><a href="classarmnn_1_1_dynamic_backend.html">armnn::DynamicBackend</a></div><div class="ttdef"><b>Definition:</b> <a href="_dynamic_backend_8hpp_source.html#l00020">DynamicBackend.hpp:20</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_dynamic_backend_html_a74db049ad0000a58b9a58a6cd6d88feb"><div class="ttname"><a href="classarmnn_1_1_dynamic_backend.html#a74db049ad0000a58b9a58a6cd6d88feb">armnn::DynamicBackend::GetBackendVersion</a></div><div class="ttdeci">BackendVersion GetBackendVersion()</div><div class="ttdef"><b>Definition:</b> <a href="_dynamic_backend_8cpp_source.html#l00058">DynamicBackend.cpp:58</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_dynamic_backend_html_a1c1454fae6258415712b5e720023fbd1"><div class="ttname"><a href="classarmnn_1_1_dynamic_backend.html#a1c1454fae6258415712b5e720023fbd1">armnn::DynamicBackend::DynamicBackend</a></div><div class="ttdeci">DynamicBackend(const void *sharedObjectHandle)</div><div class="ttdef"><b>Definition:</b> <a href="_dynamic_backend_8cpp_source.html#l00012">DynamicBackend.cpp:12</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_dynamic_backend_html_a6deb5373920ee59a800eca6b01085654"><div class="ttname"><a href="classarmnn_1_1_dynamic_backend.html#a6deb5373920ee59a800eca6b01085654">armnn::DynamicBackend::GetBackendId</a></div><div class="ttdeci">BackendId GetBackendId()</div><div class="ttdoc">Public dynamic backend functions.</div><div class="ttdef"><b>Definition:</b> <a href="_dynamic_backend_8cpp_source.html#l00042">DynamicBackend.cpp:42</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_dynamic_backend_html_a4c24f07cb0b4bff43655dfdbd5eac539"><div class="ttname"><a href="classarmnn_1_1_dynamic_backend.html#a4c24f07cb0b4bff43655dfdbd5eac539">armnn::DynamicBackend::GetFactoryFunction</a></div><div class="ttdeci">BackendRegistry::FactoryFunction GetFactoryFunction()</div><div class="ttdef"><b>Definition:</b> <a href="_dynamic_backend_8cpp_source.html#l00078">DynamicBackend.cpp:78</a></div></div>
<div class="ttc" id="a_i_backend_internal_8hpp_html"><div class="ttname"><a href="_i_backend_internal_8hpp.html">IBackendInternal.hpp</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_dynamic_backend_html_a8bdc460894ec6fe25c7754d0d5d10866"><div class="ttname"><a href="classarmnn_1_1_dynamic_backend.html#a8bdc460894ec6fe25c7754d0d5d10866">armnn::DynamicBackend::HandlePtr</a></div><div class="ttdeci">std::unique_ptr&lt; void, HandleCloser &gt; HandlePtr</div><div class="ttdef"><b>Definition:</b> <a href="_dynamic_backend_8hpp_source.html#l00024">DynamicBackend.hpp:24</a></div></div>
<div class="ttc" id="astructarmnn_1_1_backend_version_html"><div class="ttname"><a href="structarmnn_1_1_backend_version.html">armnn::BackendVersion</a></div><div class="ttdef"><b>Definition:</b> <a href="_i_backend_internal_8hpp_source.html#l00034">IBackendInternal.hpp:34</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_backend_id_html"><div class="ttname"><a href="classarmnn_1_1_backend_id.html">armnn::BackendId</a></div><div class="ttdef"><b>Definition:</b> <a href="_backend_id_8hpp_source.html#l00075">BackendId.hpp:75</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="anamespacearmnn_html_ade0af9dacaa52cafdd701bef2e901c77"><div class="ttname"><a href="namespacearmnn.html#ade0af9dacaa52cafdd701bef2e901c77">armnn::IBackendInternalUniquePtr</a></div><div class="ttdeci">std::unique_ptr&lt; IBackendInternal &gt; IBackendInternalUniquePtr</div><div class="ttdef"><b>Definition:</b> <a href="_backend_registry_8hpp_source.html#l00032">BackendRegistry.hpp:32</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_dynamic_backend_html_a9d10388a851fc1a748c3e385f484b52a"><div class="ttname"><a href="classarmnn_1_1_dynamic_backend.html#a9d10388a851fc1a748c3e385f484b52a">armnn::DynamicBackend::GetBackend</a></div><div class="ttdeci">IBackendInternalUniquePtr GetBackend()</div><div class="ttdef"><b>Definition:</b> <a href="_dynamic_backend_8cpp_source.html#l00072">DynamicBackend.cpp:72</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="_dynamic_backend_8hpp.html">DynamicBackend.hpp</a></li>
<li class="footer">Generated on Wed Feb 14 2024 16:36:13 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>