Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 1dc83febfb76d6a770bdf3ba16c4034a970c2320 / . / 24.05 / classarmnn_1_1_open_cl_timer.html
blob: acfe35490032e74d96412bf1bda59fbc509bd63c [file] [log] [blame]
Nikhil Raj1dc83fe2024-05-16 09:47:51 +0100[diff] [blame^]1<!-- 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: OpenClTimer Class Reference</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">
39 &#160;<span id="projectnumber">24.05</span>
40 </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('classarmnn_1_1_open_cl_timer.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="summary">
96<a href="#nested-classes">Classes</a> &#124;
97<a href="#pub-methods">Public Member Functions</a> &#124;
98<a href="classarmnn_1_1_open_cl_timer-members.html">List of all members</a> </div>
99 <div class="headertitle">
100<div class="title">OpenClTimer Class Reference</div> </div>
101</div><!--header-->
102<div class="contents">
103
104<p><a class="el" href="classarmnn_1_1_open_cl_timer.html" title="OpenClTimer instrument that times all OpenCl kernels executed between calls to Start() and Stop().">OpenClTimer</a> instrument that times all OpenCl kernels executed between calls to <a class="el" href="classarmnn_1_1_open_cl_timer.html#a156f3866ca69d98b4d9e6e1c1b3ec7da" title="Start the OpenCl timer.">Start()</a> and <a class="el" href="classarmnn_1_1_open_cl_timer.html#a634c58de2126b4a4e6a2a093e60e1290" title="Stop the OpenCl timer.">Stop()</a>.
105 <a href="classarmnn_1_1_open_cl_timer.html#details">More...</a></p>
106
107<p><code>#include &lt;<a class="el" href="_open_cl_timer_8hpp_source.html">OpenClTimer.hpp</a>&gt;</code></p>
108<div class="dynheader">
109Inheritance diagram for OpenClTimer:</div>
110<div class="dyncontent">
111<div class="center"><iframe scrolling="no" frameborder="0" src="classarmnn_1_1_open_cl_timer__inherit__graph.svg" width="118" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
112</div>
113<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
114<div class="dynheader">
115Collaboration diagram for OpenClTimer:</div>
116<div class="dyncontent">
117<div class="center"><iframe scrolling="no" frameborder="0" src="classarmnn_1_1_open_cl_timer__coll__graph.svg" width="118" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
118</div>
119<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
120<table class="memberdecls">
121<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
122Public Member Functions</h2></td></tr>
123<tr class="memitem:adcd19a0c31e8ffa4411fa05e905c0cf4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_open_cl_timer.html#adcd19a0c31e8ffa4411fa05e905c0cf4">OpenClTimer</a> ()</td></tr>
124<tr class="separator:adcd19a0c31e8ffa4411fa05e905c0cf4"><td class="memSeparator" colspan="2">&#160;</td></tr>
125<tr class="memitem:a596f6581a916e95f60c2f203b8bda367"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_open_cl_timer.html#a596f6581a916e95f60c2f203b8bda367">~OpenClTimer</a> ()=default</td></tr>
126<tr class="separator:a596f6581a916e95f60c2f203b8bda367"><td class="memSeparator" colspan="2">&#160;</td></tr>
127<tr class="memitem:a156f3866ca69d98b4d9e6e1c1b3ec7da"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_open_cl_timer.html#a156f3866ca69d98b4d9e6e1c1b3ec7da">Start</a> () override</td></tr>
128<tr class="memdesc:a156f3866ca69d98b4d9e6e1c1b3ec7da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start the OpenCl timer. <a href="classarmnn_1_1_open_cl_timer.html#a156f3866ca69d98b4d9e6e1c1b3ec7da">More...</a><br /></td></tr>
129<tr class="separator:a156f3866ca69d98b4d9e6e1c1b3ec7da"><td class="memSeparator" colspan="2">&#160;</td></tr>
130<tr class="memitem:a634c58de2126b4a4e6a2a093e60e1290"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_open_cl_timer.html#a634c58de2126b4a4e6a2a093e60e1290">Stop</a> () override</td></tr>
131<tr class="memdesc:a634c58de2126b4a4e6a2a093e60e1290"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop the OpenCl timer. <a href="classarmnn_1_1_open_cl_timer.html#a634c58de2126b4a4e6a2a093e60e1290">More...</a><br /></td></tr>
132<tr class="separator:a634c58de2126b4a4e6a2a093e60e1290"><td class="memSeparator" colspan="2">&#160;</td></tr>
133<tr class="memitem:ae9faa4ff4d8569776b5686e472c46bb0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_open_cl_timer.html#ae9faa4ff4d8569776b5686e472c46bb0">HasKernelMeasurements</a> () const override</td></tr>
134<tr class="memdesc:ae9faa4ff4d8569776b5686e472c46bb0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return true if this <a class="el" href="classarmnn_1_1_instrument.html">Instrument</a> has kernels for recording measurements. <a href="classarmnn_1_1_open_cl_timer.html#ae9faa4ff4d8569776b5686e472c46bb0">More...</a><br /></td></tr>
135<tr class="separator:ae9faa4ff4d8569776b5686e472c46bb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
136<tr class="memitem:a7ddf0cf6f620d59c10e63495ace795d0"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_open_cl_timer.html#a7ddf0cf6f620d59c10e63495ace795d0">GetName</a> () const override</td></tr>
137<tr class="memdesc:a7ddf0cf6f620d59c10e63495ace795d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the name of the timer. <a href="classarmnn_1_1_open_cl_timer.html#a7ddf0cf6f620d59c10e63495ace795d0">More...</a><br /></td></tr>
138<tr class="separator:a7ddf0cf6f620d59c10e63495ace795d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
139<tr class="memitem:a86ea36032637c02c045f2d433036a203"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="structarmnn_1_1_measurement.html">Measurement</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_open_cl_timer.html#a86ea36032637c02c045f2d433036a203">GetMeasurements</a> () const override</td></tr>
140<tr class="memdesc:a86ea36032637c02c045f2d433036a203"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the recorded measurements. <a href="classarmnn_1_1_open_cl_timer.html#a86ea36032637c02c045f2d433036a203">More...</a><br /></td></tr>
141<tr class="separator:a86ea36032637c02c045f2d433036a203"><td class="memSeparator" colspan="2">&#160;</td></tr>
142<tr class="inherit_header pub_methods_classarmnn_1_1_instrument"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarmnn_1_1_instrument')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarmnn_1_1_instrument.html">Instrument</a></td></tr>
143<tr class="memitem:a37a2de9b867820a7ab15b8dc8d62b153 inherit pub_methods_classarmnn_1_1_instrument"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_instrument.html#a37a2de9b867820a7ab15b8dc8d62b153">~Instrument</a> ()</td></tr>
144<tr class="separator:a37a2de9b867820a7ab15b8dc8d62b153 inherit pub_methods_classarmnn_1_1_instrument"><td class="memSeparator" colspan="2">&#160;</td></tr>
145</table>
146<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
147<div class="textblock"><p><a class="el" href="classarmnn_1_1_open_cl_timer.html" title="OpenClTimer instrument that times all OpenCl kernels executed between calls to Start() and Stop().">OpenClTimer</a> instrument that times all OpenCl kernels executed between calls to <a class="el" href="classarmnn_1_1_open_cl_timer.html#a156f3866ca69d98b4d9e6e1c1b3ec7da" title="Start the OpenCl timer.">Start()</a> and <a class="el" href="classarmnn_1_1_open_cl_timer.html#a634c58de2126b4a4e6a2a093e60e1290" title="Stop the OpenCl timer.">Stop()</a>. </p>
148
149<p class="definition">Definition at line <a class="el" href="_open_cl_timer_8hpp_source.html#l00020">20</a> of file <a class="el" href="_open_cl_timer_8hpp_source.html">OpenClTimer.hpp</a>.</p>
150</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
151<a id="adcd19a0c31e8ffa4411fa05e905c0cf4"></a>
152<h2 class="memtitle"><span class="permalink"><a href="#adcd19a0c31e8ffa4411fa05e905c0cf4">&#9670;&nbsp;</a></span>OpenClTimer()</h2>
153
154<div class="memitem">
155<div class="memproto">
156 <table class="memname">
157 <tr>
158 <td class="memname"><a class="el" href="classarmnn_1_1_open_cl_timer.html">OpenClTimer</a> </td>
159 <td>(</td>
160 <td class="paramname"></td><td>)</td>
161 <td></td>
162 </tr>
163 </table>
164</div><div class="memdoc">
165
166<p class="definition">Definition at line <a class="el" href="_open_cl_timer_8cpp_source.html#l00017">17</a> of file <a class="el" href="_open_cl_timer_8cpp_source.html">OpenClTimer.cpp</a>.</p>
167<div class="fragment"><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;{</div>
168<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;}</div>
169</div><!-- fragment -->
170</div>
171</div>
172<a id="a596f6581a916e95f60c2f203b8bda367"></a>
173<h2 class="memtitle"><span class="permalink"><a href="#a596f6581a916e95f60c2f203b8bda367">&#9670;&nbsp;</a></span>~OpenClTimer()</h2>
174
175<div class="memitem">
176<div class="memproto">
177<table class="mlabels">
178 <tr>
179 <td class="mlabels-left">
180 <table class="memname">
181 <tr>
182 <td class="memname">~<a class="el" href="classarmnn_1_1_open_cl_timer.html">OpenClTimer</a> </td>
183 <td>(</td>
184 <td class="paramname"></td><td>)</td>
185 <td></td>
186 </tr>
187 </table>
188 </td>
189 <td class="mlabels-right">
190<span class="mlabels"><span class="mlabel">default</span></span> </td>
191 </tr>
192</table>
193</div><div class="memdoc">
194
195</div>
196</div>
197<h2 class="groupheader">Member Function Documentation</h2>
198<a id="a86ea36032637c02c045f2d433036a203"></a>
199<h2 class="memtitle"><span class="permalink"><a href="#a86ea36032637c02c045f2d433036a203">&#9670;&nbsp;</a></span>GetMeasurements()</h2>
200
201<div class="memitem">
202<div class="memproto">
203<table class="mlabels">
204 <tr>
205 <td class="mlabels-left">
206 <table class="memname">
207 <tr>
208 <td class="memname">std::vector&lt; <a class="el" href="structarmnn_1_1_measurement.html">Measurement</a> &gt; GetMeasurements </td>
209 <td>(</td>
210 <td class="paramname"></td><td>)</td>
211 <td> const</td>
212 </tr>
213 </table>
214 </td>
215 <td class="mlabels-right">
216<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
217 </tr>
218</table>
219</div><div class="memdoc">
220
221<p>Get the recorded measurements. </p>
222<p>This will be a list of the execution durations for all the OpenCl kernels. </p><dl class="section return"><dt>Returns</dt><dd>Recorded measurements </dd></dl>
223
224<p>Implements <a class="el" href="classarmnn_1_1_instrument.html#a4055fcf05306a7478db7e192cf1e679d">Instrument</a>.</p>
225
226<p class="definition">Definition at line <a class="el" href="_open_cl_timer_8cpp_source.html#l00093">93</a> of file <a class="el" href="_open_cl_timer_8cpp_source.html">OpenClTimer.cpp</a>.</p>
227<div class="fragment"><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;{</div>
228<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; std::vector&lt;Measurement&gt; measurements;</div>
229<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; </div>
230<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; cl_command_queue_properties clQueueProperties = CLScheduler::get().queue().getInfo&lt;CL_QUEUE_PROPERTIES&gt;();</div>
231<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; </div>
232<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; <span class="keywordtype">int</span> idx = 0;</div>
233<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">auto</span>&amp; kernel : m_Kernels)</div>
234<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; {</div>
235<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; std::string name = std::string(this-&gt;<a class="code" href="classarmnn_1_1_open_cl_timer.html#a7ddf0cf6f620d59c10e63495ace795d0">GetName</a>()) + <span class="stringliteral">&quot;/&quot;</span> + std::to_string(idx++) + <span class="stringliteral">&quot;: &quot;</span> + kernel.m_Name;</div>
236<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; </div>
237<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; <span class="keywordtype">double</span> timeUs = 0.0;</div>
238<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; <span class="keywordflow">if</span>((clQueueProperties &amp; CL_QUEUE_PROFILING_ENABLE) != 0)</div>
239<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; {</div>
240<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; <span class="comment">// Wait for the event to finish before accessing profile results.</span></div>
241<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; kernel.m_Event.wait();</div>
242<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; </div>
243<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; cl_ulong start = kernel.m_Event.getProfilingInfo&lt;CL_PROFILING_COMMAND_START&gt;();</div>
244<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; cl_ulong end = kernel.m_Event.getProfilingInfo&lt;CL_PROFILING_COMMAND_END&gt;();</div>
245<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; timeUs = <span class="keyword">static_cast&lt;</span><span class="keywordtype">double</span><span class="keyword">&gt;</span>(end - start) / 1000.0;</div>
246<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; }</div>
247<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; </div>
248<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; measurements.emplace_back(name, timeUs, Measurement::Unit::TIME_US);</div>
249<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; }</div>
250<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; </div>
251<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; <span class="keywordflow">return</span> measurements;</div>
252<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160;}</div>
253</div><!-- fragment -->
254<p class="reference">References <a class="el" href="_open_cl_timer_8hpp_source.html#l00037">OpenClTimer::GetName()</a>.</p>
255
256</div>
257</div>
258<a id="a7ddf0cf6f620d59c10e63495ace795d0"></a>
259<h2 class="memtitle"><span class="permalink"><a href="#a7ddf0cf6f620d59c10e63495ace795d0">&#9670;&nbsp;</a></span>GetName()</h2>
260
261<div class="memitem">
262<div class="memproto">
263<table class="mlabels">
264 <tr>
265 <td class="mlabels-left">
266 <table class="memname">
267 <tr>
268 <td class="memname">const char* GetName </td>
269 <td>(</td>
270 <td class="paramname"></td><td>)</td>
271 <td> const</td>
272 </tr>
273 </table>
274 </td>
275 <td class="mlabels-right">
276<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
277 </tr>
278</table>
279</div><div class="memdoc">
280
281<p>Get the name of the timer. </p>
282<dl class="section return"><dt>Returns</dt><dd>Name of the timer </dd></dl>
283
284<p>Implements <a class="el" href="classarmnn_1_1_instrument.html#afcc1c3a20bd2860e0ddd21674389246f">Instrument</a>.</p>
285
286<p class="definition">Definition at line <a class="el" href="_open_cl_timer_8hpp_source.html#l00037">37</a> of file <a class="el" href="_open_cl_timer_8hpp_source.html">OpenClTimer.hpp</a>.</p>
287<div class="fragment"><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;{ <span class="keywordflow">return</span> <span class="stringliteral">&quot;OpenClKernelTimer&quot;</span>; }</div>
288</div><!-- fragment -->
289<p class="reference">Referenced by <a class="el" href="_open_cl_timer_8cpp_source.html#l00093">OpenClTimer::GetMeasurements()</a>.</p>
290
291</div>
292</div>
293<a id="ae9faa4ff4d8569776b5686e472c46bb0"></a>
294<h2 class="memtitle"><span class="permalink"><a href="#ae9faa4ff4d8569776b5686e472c46bb0">&#9670;&nbsp;</a></span>HasKernelMeasurements()</h2>
295
296<div class="memitem">
297<div class="memproto">
298<table class="mlabels">
299 <tr>
300 <td class="mlabels-left">
301 <table class="memname">
302 <tr>
303 <td class="memname">bool HasKernelMeasurements </td>
304 <td>(</td>
305 <td class="paramname"></td><td>)</td>
306 <td> const</td>
307 </tr>
308 </table>
309 </td>
310 <td class="mlabels-right">
311<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
312 </tr>
313</table>
314</div><div class="memdoc">
315
316<p>Return true if this <a class="el" href="classarmnn_1_1_instrument.html">Instrument</a> has kernels for recording measurements. </p>
317
318<p>Reimplemented from <a class="el" href="classarmnn_1_1_instrument.html#af86639ebdd7db055ee07c3d924d4c0ff">Instrument</a>.</p>
319
320<p class="definition">Definition at line <a class="el" href="_open_cl_timer_8cpp_source.html#l00088">88</a> of file <a class="el" href="_open_cl_timer_8cpp_source.html">OpenClTimer.cpp</a>.</p>
321<div class="fragment"><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;{</div>
322<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <span class="keywordflow">return</span> m_Kernels.size() &gt; 0;</div>
323<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;}</div>
324</div><!-- fragment -->
325</div>
326</div>
327<a id="a156f3866ca69d98b4d9e6e1c1b3ec7da"></a>
328<h2 class="memtitle"><span class="permalink"><a href="#a156f3866ca69d98b4d9e6e1c1b3ec7da">&#9670;&nbsp;</a></span>Start()</h2>
329
330<div class="memitem">
331<div class="memproto">
332<table class="mlabels">
333 <tr>
334 <td class="mlabels-left">
335 <table class="memname">
336 <tr>
337 <td class="memname">void Start </td>
338 <td>(</td>
339 <td class="paramname"></td><td>)</td>
340 <td></td>
341 </tr>
342 </table>
343 </td>
344 <td class="mlabels-right">
345<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
346 </tr>
347</table>
348</div><div class="memdoc">
349
350<p>Start the OpenCl timer. </p>
351
352<p>Implements <a class="el" href="classarmnn_1_1_instrument.html#a63ce9b9c6710c0dae98f88d6c602313a">Instrument</a>.</p>
353
354<p class="definition">Definition at line <a class="el" href="_open_cl_timer_8cpp_source.html#l00021">21</a> of file <a class="el" href="_open_cl_timer_8cpp_source.html">OpenClTimer.cpp</a>.</p>
355<div class="fragment"><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;{</div>
356<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; m_Kernels.clear();</div>
357<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
358<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keyword">auto</span> interceptor = [<span class="keyword">this</span>]( cl_command_queue command_queue,</div>
359<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; cl_kernel kernel,</div>
360<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; cl_uint work_dim,</div>
361<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keyword">const</span> <span class="keywordtype">size_t</span> *gwo,</div>
362<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keyword">const</span> <span class="keywordtype">size_t</span> *gws,</div>
363<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keyword">const</span> <span class="keywordtype">size_t</span> *lws,</div>
364<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; cl_uint num_events_in_wait_list,</div>
365<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keyword">const</span> cl_event * event_wait_list,</div>
366<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; cl_event * event)</div>
367<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; {</div>
368<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <a class="code" href="namespacearmnn.html#a44affeeb090c3c6a3062830562672e84">IgnoreUnused</a>(event);</div>
369<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; cl_int retVal = 0;</div>
370<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; </div>
371<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="comment">// Get the name of the kernel</span></div>
372<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; cl::Kernel retainedKernel(kernel, <span class="keyword">true</span>);</div>
373<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; std::stringstream ss;</div>
374<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; ss &lt;&lt; retainedKernel.getInfo&lt;CL_KERNEL_FUNCTION_NAME&gt;();</div>
375<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; </div>
376<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="comment">// Embed workgroup sizes into the name</span></div>
377<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordflow">if</span>(gws != <span class="keyword">nullptr</span>)</div>
378<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; {</div>
379<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; ss &lt;&lt; <span class="stringliteral">&quot; GWS[&quot;</span> &lt;&lt; gws[0] &lt;&lt; <span class="stringliteral">&quot;,&quot;</span> &lt;&lt; gws[1] &lt;&lt; <span class="stringliteral">&quot;,&quot;</span> &lt;&lt; gws[2] &lt;&lt; <span class="stringliteral">&quot;]&quot;</span>;</div>
380<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; }</div>
381<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordflow">if</span>(lws != <span class="keyword">nullptr</span>)</div>
382<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; {</div>
383<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; ss &lt;&lt; <span class="stringliteral">&quot; LWS[&quot;</span> &lt;&lt; lws[0] &lt;&lt; <span class="stringliteral">&quot;,&quot;</span> &lt;&lt; lws[1] &lt;&lt; <span class="stringliteral">&quot;,&quot;</span> &lt;&lt; lws[2] &lt;&lt; <span class="stringliteral">&quot;]&quot;</span>;</div>
384<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; }</div>
385<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; </div>
386<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; cl_event customEvent;</div>
387<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; </div>
388<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="comment">// Forward to original OpenCl function</span></div>
389<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; retVal = m_OriginalEnqueueFunction( command_queue,</div>
390<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; kernel,</div>
391<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; work_dim,</div>
392<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; gwo,</div>
393<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; gws,</div>
394<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; lws,</div>
395<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; num_events_in_wait_list,</div>
396<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; event_wait_list,</div>
397<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; &amp;customEvent);</div>
398<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; </div>
399<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="comment">// Store the Kernel info for later GetMeasurements() call</span></div>
400<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; m_Kernels.emplace_back(ss.str(), customEvent);</div>
401<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; </div>
402<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keywordflow">if</span>(event != <span class="keyword">nullptr</span>)</div>
403<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; {</div>
404<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="comment">//return cl_event from the intercepted call</span></div>
405<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; clRetainEvent(customEvent);</div>
406<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; *<span class="keyword">event</span> = customEvent;</div>
407<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; }</div>
408<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; </div>
409<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="keywordflow">return</span> retVal;</div>
410<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; };</div>
411<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; </div>
412<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; m_OriginalEnqueueFunction = CLSymbols::get().clEnqueueNDRangeKernel_ptr;</div>
413<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; CLSymbols::get().clEnqueueNDRangeKernel_ptr = interceptor;</div>
414<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;}</div>
415</div><!-- fragment -->
416<p class="reference">References <a class="el" href="_ignore_unused_8hpp_source.html#l00014">armnn::IgnoreUnused()</a>.</p>
417
418</div>
419</div>
420<a id="a634c58de2126b4a4e6a2a093e60e1290"></a>
421<h2 class="memtitle"><span class="permalink"><a href="#a634c58de2126b4a4e6a2a093e60e1290">&#9670;&nbsp;</a></span>Stop()</h2>
422
423<div class="memitem">
424<div class="memproto">
425<table class="mlabels">
426 <tr>
427 <td class="mlabels-left">
428 <table class="memname">
429 <tr>
430 <td class="memname">void Stop </td>
431 <td>(</td>
432 <td class="paramname"></td><td>)</td>
433 <td></td>
434 </tr>
435 </table>
436 </td>
437 <td class="mlabels-right">
438<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
439 </tr>
440</table>
441</div><div class="memdoc">
442
443<p>Stop the OpenCl timer. </p>
444
445<p>Implements <a class="el" href="classarmnn_1_1_instrument.html#a4d7bebcc22c1b09cf961b83bf84033b6">Instrument</a>.</p>
446
447<p class="definition">Definition at line <a class="el" href="_open_cl_timer_8cpp_source.html#l00083">83</a> of file <a class="el" href="_open_cl_timer_8cpp_source.html">OpenClTimer.cpp</a>.</p>
448<div class="fragment"><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;{</div>
449<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; CLSymbols::get().clEnqueueNDRangeKernel_ptr = m_OriginalEnqueueFunction;</div>
450<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;}</div>
451</div><!-- fragment -->
452</div>
453</div>
454<hr/>The documentation for this class was generated from the following files:<ul>
455<li>src/backends/cl/<a class="el" href="_open_cl_timer_8hpp_source.html">OpenClTimer.hpp</a></li>
456<li>src/backends/cl/<a class="el" href="_open_cl_timer_8cpp_source.html">OpenClTimer.cpp</a></li>
457</ul>
458</div><!-- contents -->
459</div><!-- doc-content -->
460<div class="ttc" id="aclassarmnn_1_1_open_cl_timer_html_a7ddf0cf6f620d59c10e63495ace795d0"><div class="ttname"><a href="classarmnn_1_1_open_cl_timer.html#a7ddf0cf6f620d59c10e63495ace795d0">armnn::OpenClTimer::GetName</a></div><div class="ttdeci">const char * GetName() const override</div><div class="ttdoc">Get the name of the timer.</div><div class="ttdef"><b>Definition:</b> <a href="_open_cl_timer_8hpp_source.html#l00037">OpenClTimer.hpp:37</a></div></div>
461<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 &amp;&amp;...)</div><div class="ttdef"><b>Definition:</b> <a href="_ignore_unused_8hpp_source.html#l00014">IgnoreUnused.hpp:14</a></div></div>
462<!-- start footer part -->
463<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
464 <ul>
465 <li class="navelem"><a class="el" href="namespacearmnn.html">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_open_cl_timer.html">OpenClTimer</a></li>
466 <li class="footer">Generated on Thu May 16 2024 09:31:58 for Arm NN by
467 <a href="http://www.doxygen.org/index.html">
468 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
469 </ul>
470</div>
471</body>
472</html>