blob: 483561a9600203a127c5b52a33b8d742683406e3 [file] [log] [blame]
Nikhil Raj03c7ff32023-08-22 12:00:04 +01001<!-- HTML header for doxygen 1.8.17-->
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml">
4<head>
5<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6<meta http-equiv="X-UA-Compatible" content="IE=9"/>
7<meta name="generator" content="Doxygen 1.8.17"/>
8<meta name="viewport" content="width=device-width, initial-scale=1"/>
9<title>Arm NN: src/backends/cl/ClBackendContext.hpp Source File</title>
10<link href="tabs.css" rel="stylesheet" type="text/css"/>
11<script type="text/javascript" src="jquery.js"></script>
12<script type="text/javascript" src="dynsections.js"></script>
13<link href="navtree.css" rel="stylesheet" type="text/css"/>
14<script type="text/javascript" src="resize.js"></script>
15<script type="text/javascript" src="navtreedata.js"></script>
16<script type="text/javascript" src="navtree.js"></script>
17<link href="search/search.css" rel="stylesheet" type="text/css"/>
18<script type="text/javascript" src="search/searchdata.js"></script>
19<script type="text/javascript" src="search/search.js"></script>
20<script type="text/x-mathjax-config">
21 MathJax.Hub.Config({
22 extensions: ["tex2jax.js"],
23 jax: ["input/TeX","output/HTML-CSS"],
24});
25</script>
26<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
27<link href="doxygen.css" rel="stylesheet" type="text/css" />
28<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
29</head>
30<body>
31<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
32<div id="titlearea">
33<table cellspacing="0" cellpadding="0">
34 <tbody>
35 <tr style="height: 56px;">
36 <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 15rem; margin-top: .5rem; margin-left 13px"/>
37 <td id="projectalign" style="padding-left: 0.9em;">
38 <div id="projectname">
Nikhil Raj1dc83fe2024-05-16 09:47:51 +010039 &#160;<span id="projectnumber">24.05</span>
Nikhil Raj03c7ff32023-08-22 12:00:04 +010040 </div>
41 </td>
42 </tr>
43 </tbody>
44</table>
45</div>
46<!-- end header part -->
47<!-- Generated by Doxygen 1.8.17 -->
48<script type="text/javascript">
49/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
50var searchBox = new SearchBox("searchBox", "search",false,'Search');
51/* @license-end */
52</script>
53<script type="text/javascript" src="menudata.js"></script>
54<script type="text/javascript" src="menu.js"></script>
55<script type="text/javascript">
56/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
57$(function() {
58 initMenu('',true,false,'search.php','Search');
59 $(document).ready(function() { init_search(); });
60});
61/* @license-end */</script>
62<div id="main-nav"></div>
63</div><!-- top -->
64<div id="side-nav" class="ui-resizable side-nav-resizable">
65 <div id="nav-tree">
66 <div id="nav-tree-contents">
67 <div id="nav-sync" class="sync"></div>
68 </div>
69 </div>
70 <div id="splitbar" style="-moz-user-select:none;"
71 class="ui-resizable-handle">
72 </div>
73</div>
74<script type="text/javascript">
75/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
76$(document).ready(function(){initNavTree('_cl_backend_context_8hpp_source.html',''); initResizable(); });
77/* @license-end */
78</script>
79<div id="doc-content">
80<!-- window showing the filter options -->
81<div id="MSearchSelectWindow"
82 onmouseover="return searchBox.OnSearchSelectShow()"
83 onmouseout="return searchBox.OnSearchSelectHide()"
84 onkeydown="return searchBox.OnSearchSelectKey(event)">
85</div>
86
87<!-- iframe showing the search results (closed by default) -->
88<div id="MSearchResultsWindow">
89<iframe src="javascript:void(0)" frameborder="0"
90 name="MSearchResults" id="MSearchResults">
91</iframe>
92</div>
93
94<div class="header">
95 <div class="headertitle">
96<div class="title">ClBackendContext.hpp</div> </div>
97</div><!--header-->
98<div class="contents">
99<a href="_cl_backend_context_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>
100<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// Copyright © 2017 Arm Ltd. All rights reserved.</span></div>
101<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// SPDX-License-Identifier: MIT</span></div>
102<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">//</span></div>
103<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#pragma once</span></div>
104<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160; </div>
105<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="_i_backend_context_8hpp.html">armnn/backends/IBackendContext.hpp</a>&gt;</span></div>
106<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &lt;unordered_set&gt;</span></div>
107<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &lt;mutex&gt;</span></div>
108<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; </div>
109<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &lt;arm_compute/runtime/CL/CLTuner.h&gt;</span></div>
110<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#include &lt;arm_compute/runtime/CL/CLGEMMHeuristicsHandle.h&gt;</span></div>
111<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; </div>
112<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacearmnn.html">armnn</a></div>
113<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;{</div>
114<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; </div>
115<div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="classarmnn_1_1_cl_backend_context.html"> 17</a></span>&#160;<span class="keyword">class </span><a class="code" href="classarmnn_1_1_cl_backend_context.html">ClBackendContext</a> : <span class="keyword">public</span> <a class="code" href="classarmnn_1_1_i_backend_context.html">IBackendContext</a></div>
116<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;{</div>
117<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="keyword">public</span>:</div>
118<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <a class="code" href="classarmnn_1_1_cl_backend_context.html#a46628231c197cb066ddf3fe676b44038">ClBackendContext</a>(<span class="keyword">const</span> <a class="code" href="structarmnn_1_1_i_runtime_1_1_creation_options.html">IRuntime::CreationOptions</a>&amp; options);</div>
119<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
120<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classarmnn_1_1_cl_backend_context.html#ae8b132bb727f3594b8613a66096fbd99">BeforeLoadNetwork</a>(<a class="code" href="namespacearmnn.html#a0d8160388a127c1a23b37bc88dc6e2ec">NetworkId</a> networkId) <span class="keyword">override</span>;</div>
121<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classarmnn_1_1_cl_backend_context.html#a8285e428113914dee00fb06ac0f3af1e">AfterLoadNetwork</a>(<a class="code" href="namespacearmnn.html#a0d8160388a127c1a23b37bc88dc6e2ec">NetworkId</a> networkId) <span class="keyword">override</span>;</div>
122<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
123<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classarmnn_1_1_cl_backend_context.html#acb272e49e9da9835827451184feee061">BeforeUnloadNetwork</a>(<a class="code" href="namespacearmnn.html#a0d8160388a127c1a23b37bc88dc6e2ec">NetworkId</a> networkId) <span class="keyword">override</span>;</div>
124<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classarmnn_1_1_cl_backend_context.html#a16900a3d8c0121a45ceb870f1815bc4d">AfterUnloadNetwork</a>(<a class="code" href="namespacearmnn.html#a0d8160388a127c1a23b37bc88dc6e2ec">NetworkId</a> networkId) <span class="keyword">override</span>;</div>
125<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; </div>
126<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classarmnn_1_1_cl_backend_context.html#ad895de5df365dc112b9a796603bf7a27">AfterEnqueueWorkload</a>(<a class="code" href="namespacearmnn.html#a0d8160388a127c1a23b37bc88dc6e2ec">NetworkId</a> networkId) <span class="keyword">override</span>;</div>
127<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; </div>
128<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <a class="code" href="classarmnn_1_1_cl_backend_context.html#a9cd81257364a0a85008f1d4109016264">~ClBackendContext</a>() <span class="keyword">override</span>;</div>
129<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div>
130<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="keyword">private</span>:</div>
131<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; std::mutex m_Mutex;</div>
132<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keyword">struct </span>ClContextControlWrapper;</div>
133<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; std::unique_ptr&lt;ClContextControlWrapper&gt; m_ClContextControlWrapper;</div>
134<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; </div>
135<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; std::unordered_set&lt;NetworkId&gt; m_NetworkIds;</div>
136<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; </div>
137<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; std::unique_ptr&lt;arm_compute::CLTuner&gt; m_Tuner;</div>
138<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; std::string m_TuningFile;</div>
139<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; </div>
140<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="keyword">protected</span>:</div>
141<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classarmnn_1_1_cl_backend_context.html#ae8e5298350dd502b4d47da1eb91c4eeb"> 43</a></span>&#160; arm_compute::CLGEMMHeuristicsHandle <a class="code" href="classarmnn_1_1_cl_backend_context.html#ae8e5298350dd502b4d47da1eb91c4eeb">m_MLGOTuner</a>;</div>
142<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classarmnn_1_1_cl_backend_context.html#afdd26db2e2aa79da77addaa93e9ce2e4"> 44</a></span>&#160; std::string <a class="code" href="classarmnn_1_1_cl_backend_context.html#afdd26db2e2aa79da77addaa93e9ce2e4">m_MLGOTuningFile</a>;</div>
143<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;};</div>
144<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; </div>
145<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;} <span class="comment">// namespace armnn</span></div>
146</div><!-- fragment --></div><!-- contents -->
147</div><!-- doc-content -->
Nikhil Raj1dc83fe2024-05-16 09:47:51 +0100148<div class="ttc" id="aclassarmnn_1_1_cl_backend_context_html_a16900a3d8c0121a45ceb870f1815bc4d"><div class="ttname"><a href="classarmnn_1_1_cl_backend_context.html#a16900a3d8c0121a45ceb870f1815bc4d">armnn::ClBackendContext::AfterUnloadNetwork</a></div><div class="ttdeci">bool AfterUnloadNetwork(NetworkId networkId) override</div><div class="ttdef"><b>Definition:</b> <a href="_cl_backend_context_8cpp_source.html#l00195">ClBackendContext.cpp:195</a></div></div>
149<div class="ttc" id="aclassarmnn_1_1_cl_backend_context_html_ad895de5df365dc112b9a796603bf7a27"><div class="ttname"><a href="classarmnn_1_1_cl_backend_context.html#ad895de5df365dc112b9a796603bf7a27">armnn::ClBackendContext::AfterEnqueueWorkload</a></div><div class="ttdeci">bool AfterEnqueueWorkload(NetworkId networkId) override</div><div class="ttdef"><b>Definition:</b> <a href="_cl_backend_context_8cpp_source.html#l00212">ClBackendContext.cpp:212</a></div></div>
150<div class="ttc" id="aclassarmnn_1_1_cl_backend_context_html_a9cd81257364a0a85008f1d4109016264"><div class="ttname"><a href="classarmnn_1_1_cl_backend_context.html#a9cd81257364a0a85008f1d4109016264">armnn::ClBackendContext::~ClBackendContext</a></div><div class="ttdeci">~ClBackendContext() override</div><div class="ttdef"><b>Definition:</b> <a href="_cl_backend_context_8cpp_source.html#l00217">ClBackendContext.cpp:217</a></div></div>
Nikhil Raj03c7ff32023-08-22 12:00:04 +0100151<div class="ttc" id="aclassarmnn_1_1_cl_backend_context_html_afdd26db2e2aa79da77addaa93e9ce2e4"><div class="ttname"><a href="classarmnn_1_1_cl_backend_context.html#afdd26db2e2aa79da77addaa93e9ce2e4">armnn::ClBackendContext::m_MLGOTuningFile</a></div><div class="ttdeci">std::string m_MLGOTuningFile</div><div class="ttdef"><b>Definition:</b> <a href="_cl_backend_context_8hpp_source.html#l00044">ClBackendContext.hpp:44</a></div></div>
152<div class="ttc" id="anamespacearmnn_html_a0d8160388a127c1a23b37bc88dc6e2ec"><div class="ttname"><a href="namespacearmnn.html#a0d8160388a127c1a23b37bc88dc6e2ec">armnn::NetworkId</a></div><div class="ttdeci">int NetworkId</div><div class="ttdef"><b>Definition:</b> <a href="_i_runtime_8hpp_source.html#l00035">IRuntime.hpp:35</a></div></div>
153<div class="ttc" id="a_i_backend_context_8hpp_html"><div class="ttname"><a href="_i_backend_context_8hpp.html">IBackendContext.hpp</a></div></div>
154<div class="ttc" id="aclassarmnn_1_1_i_backend_context_html"><div class="ttname"><a href="classarmnn_1_1_i_backend_context.html">armnn::IBackendContext</a></div><div class="ttdef"><b>Definition:</b> <a href="_i_backend_context_8hpp_source.html#l00014">IBackendContext.hpp:14</a></div></div>
Nikhil Raj1dc83fe2024-05-16 09:47:51 +0100155<div class="ttc" id="aclassarmnn_1_1_cl_backend_context_html_acb272e49e9da9835827451184feee061"><div class="ttname"><a href="classarmnn_1_1_cl_backend_context.html#acb272e49e9da9835827451184feee061">armnn::ClBackendContext::BeforeUnloadNetwork</a></div><div class="ttdeci">bool BeforeUnloadNetwork(NetworkId networkId) override</div><div class="ttdoc">Before and after Unload network events.</div><div class="ttdef"><b>Definition:</b> <a href="_cl_backend_context_8cpp_source.html#l00190">ClBackendContext.cpp:190</a></div></div>
Nikhil Raj03c7ff32023-08-22 12:00:04 +0100156<div class="ttc" id="aclassarmnn_1_1_cl_backend_context_html_ae8e5298350dd502b4d47da1eb91c4eeb"><div class="ttname"><a href="classarmnn_1_1_cl_backend_context.html#ae8e5298350dd502b4d47da1eb91c4eeb">armnn::ClBackendContext::m_MLGOTuner</a></div><div class="ttdeci">arm_compute::CLGEMMHeuristicsHandle m_MLGOTuner</div><div class="ttdef"><b>Definition:</b> <a href="_cl_backend_context_8hpp_source.html#l00043">ClBackendContext.hpp:43</a></div></div>
157<div class="ttc" id="astructarmnn_1_1_i_runtime_1_1_creation_options_html"><div class="ttname"><a href="structarmnn_1_1_i_runtime_1_1_creation_options.html">armnn::IRuntime::CreationOptions</a></div><div class="ttdef"><b>Definition:</b> <a href="_i_runtime_8hpp_source.html#l00078">IRuntime.hpp:78</a></div></div>
158<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>
Nikhil Raj1dc83fe2024-05-16 09:47:51 +0100159<div class="ttc" id="aclassarmnn_1_1_cl_backend_context_html_a46628231c197cb066ddf3fe676b44038"><div class="ttname"><a href="classarmnn_1_1_cl_backend_context.html#a46628231c197cb066ddf3fe676b44038">armnn::ClBackendContext::ClBackendContext</a></div><div class="ttdeci">ClBackendContext(const IRuntime::CreationOptions &amp;options)</div><div class="ttdef"><b>Definition:</b> <a href="_cl_backend_context_8cpp_source.html#l00061">ClBackendContext.cpp:61</a></div></div>
160<div class="ttc" id="aclassarmnn_1_1_cl_backend_context_html_a8285e428113914dee00fb06ac0f3af1e"><div class="ttname"><a href="classarmnn_1_1_cl_backend_context.html#a8285e428113914dee00fb06ac0f3af1e">armnn::ClBackendContext::AfterLoadNetwork</a></div><div class="ttdeci">bool AfterLoadNetwork(NetworkId networkId) override</div><div class="ttdef"><b>Definition:</b> <a href="_cl_backend_context_8cpp_source.html#l00181">ClBackendContext.cpp:181</a></div></div>
Nikhil Raj03c7ff32023-08-22 12:00:04 +0100161<div class="ttc" id="aclassarmnn_1_1_cl_backend_context_html"><div class="ttname"><a href="classarmnn_1_1_cl_backend_context.html">armnn::ClBackendContext</a></div><div class="ttdef"><b>Definition:</b> <a href="_cl_backend_context_8hpp_source.html#l00017">ClBackendContext.hpp:17</a></div></div>
Nikhil Raj1dc83fe2024-05-16 09:47:51 +0100162<div class="ttc" id="aclassarmnn_1_1_cl_backend_context_html_ae8b132bb727f3594b8613a66096fbd99"><div class="ttname"><a href="classarmnn_1_1_cl_backend_context.html#ae8b132bb727f3594b8613a66096fbd99">armnn::ClBackendContext::BeforeLoadNetwork</a></div><div class="ttdeci">bool BeforeLoadNetwork(NetworkId networkId) override</div><div class="ttdoc">Before and after Load network events.</div><div class="ttdef"><b>Definition:</b> <a href="_cl_backend_context_8cpp_source.html#l00176">ClBackendContext.cpp:176</a></div></div>
Nikhil Raj03c7ff32023-08-22 12:00:04 +0100163<!-- start footer part -->
164<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
165 <ul>
166 <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_0f3cdec46afbc61a1ded8e1687c9c9a0.html">backends</a></li><li class="navelem"><a class="el" href="dir_1ad86c6d39ab715a831555571b9e98a5.html">cl</a></li><li class="navelem"><a class="el" href="_cl_backend_context_8hpp.html">ClBackendContext.hpp</a></li>
Nikhil Raj1dc83fe2024-05-16 09:47:51 +0100167 <li class="footer">Generated on Thu May 16 2024 09:31:46 for Arm NN by
Nikhil Raj03c7ff32023-08-22 12:00:04 +0100168 <a href="http://www.doxygen.org/index.html">
169 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
170 </ul>
171</div>
172</body>
173</html>