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
180
181
182
183
184
|
<!-- 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: src/backends/cl/OpenClTimer.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">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&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('_open_cl_timer_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">OpenClTimer.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="_open_cl_timer_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 © 2017 Arm Ltd. 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 <<a class="code" href="_instrument_8hpp.html">Instrument.hpp</a>></span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>  </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include <arm_compute/runtime/CL/CLScheduler.h></span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include <arm_compute/core/CL/OpenCL.h></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="preprocessor">#include <vector></span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <list></span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  </div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="keyword">namespace </span><a class="code" href="namespacearmnn.html">armnn</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="comment"></span> </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">/// OpenClTimer instrument that times all OpenCl kernels executed between calls to Start() and Stop().</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="classarmnn_1_1_open_cl_timer.html"> 20</a></span> <span class="comment"></span><span class="keyword">class </span><a class="code" href="classarmnn_1_1_open_cl_timer.html">OpenClTimer</a> : <span class="keyword">public</span> <a class="code" href="classarmnn_1_1_instrument.html">Instrument</a></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> {</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <a class="code" href="classarmnn_1_1_open_cl_timer.html#adcd19a0c31e8ffa4411fa05e905c0cf4">OpenClTimer</a>();</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <a class="code" href="classarmnn_1_1_open_cl_timer.html#a596f6581a916e95f60c2f203b8bda367">~OpenClTimer</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"></span> </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> /// Start the OpenCl timer</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1_open_cl_timer.html#a156f3866ca69d98b4d9e6e1c1b3ec7da">Start</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"></span> </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> /// Stop the OpenCl timer</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1_open_cl_timer.html#a634c58de2126b4a4e6a2a093e60e1290">Stop</a>() <span class="keyword">override</span>;</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"> /// Return true if this Instrument has kernels for recording measurements</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="classarmnn_1_1_open_cl_timer.html#ae9faa4ff4d8569776b5686e472c46bb0">HasKernelMeasurements</a>() <span class="keyword">const override</span>;</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"> /// Get the name of the timer</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> /// \return Name of the timer</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classarmnn_1_1_open_cl_timer.html#a7ddf0cf6f620d59c10e63495ace795d0"> 37</a></span> <span class="comment"></span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classarmnn_1_1_open_cl_timer.html#a7ddf0cf6f620d59c10e63495ace795d0">GetName</a>()<span class="keyword"> const override </span>{ <span class="keywordflow">return</span> <span class="stringliteral">"OpenClKernelTimer"</span>; }</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"></span> </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> /// Get the recorded measurements. This will be a list of the execution durations for all the OpenCl kernels.</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> /// \return Recorded measurements</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"></span> std::vector<Measurement> <a class="code" href="classarmnn_1_1_open_cl_timer.html#a86ea36032637c02c045f2d433036a203">GetMeasurements</a>() <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">using</span> CLScheduler = arm_compute::CLScheduler;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">using</span> CLSymbols = arm_compute::CLSymbols;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">using</span> ClEvent = cl::Event;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">using</span> ClEnqueueFunc = decltype(CLSymbols::clEnqueueNDRangeKernel_ptr);</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"></span> </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> /// Stores info about the OpenCl kernel</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"></span> <span class="keyword">struct </span>KernelInfo</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  {</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  KernelInfo(<span class="keyword">const</span> std::string& name, cl_event& event) : m_Name(name), m_Event(event) {}</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>  std::string m_Name;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  ClEvent m_Event;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  };</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  std::list<KernelInfo> m_Kernels; <span class="comment">///< List of all kernels executed</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"></span> ClEnqueueFunc m_OriginalEnqueueFunction; <span class="comment">///< Keep track of original OpenCl function</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"></span>};</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> } <span class="comment">//namespace armnn</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aclassarmnn_1_1_open_cl_timer_html_adcd19a0c31e8ffa4411fa05e905c0cf4"><div class="ttname"><a href="classarmnn_1_1_open_cl_timer.html#adcd19a0c31e8ffa4411fa05e905c0cf4">armnn::OpenClTimer::OpenClTimer</a></div><div class="ttdeci">OpenClTimer()</div><div class="ttdef"><b>Definition:</b> <a href="_open_cl_timer_8cpp_source.html#l00017">OpenClTimer.cpp:17</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_open_cl_timer_html_a634c58de2126b4a4e6a2a093e60e1290"><div class="ttname"><a href="classarmnn_1_1_open_cl_timer.html#a634c58de2126b4a4e6a2a093e60e1290">armnn::OpenClTimer::Stop</a></div><div class="ttdeci">void Stop() override</div><div class="ttdoc">Stop the OpenCl timer.</div><div class="ttdef"><b>Definition:</b> <a href="_open_cl_timer_8cpp_source.html#l00083">OpenClTimer.cpp:83</a></div></div>
<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>
<div class="ttc" id="aclassarmnn_1_1_open_cl_timer_html"><div class="ttname"><a href="classarmnn_1_1_open_cl_timer.html">armnn::OpenClTimer</a></div><div class="ttdoc">OpenClTimer instrument that times all OpenCl kernels executed between calls to Start() and Stop().</div><div class="ttdef"><b>Definition:</b> <a href="_open_cl_timer_8hpp_source.html#l00020">OpenClTimer.hpp:20</a></div></div>
<div class="ttc" id="a_instrument_8hpp_html"><div class="ttname"><a href="_instrument_8hpp.html">Instrument.hpp</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_open_cl_timer_html_a86ea36032637c02c045f2d433036a203"><div class="ttname"><a href="classarmnn_1_1_open_cl_timer.html#a86ea36032637c02c045f2d433036a203">armnn::OpenClTimer::GetMeasurements</a></div><div class="ttdeci">std::vector< Measurement > GetMeasurements() const override</div><div class="ttdoc">Get the recorded measurements.</div><div class="ttdef"><b>Definition:</b> <a href="_open_cl_timer_8cpp_source.html#l00093">OpenClTimer.cpp:93</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_open_cl_timer_html_ae9faa4ff4d8569776b5686e472c46bb0"><div class="ttname"><a href="classarmnn_1_1_open_cl_timer.html#ae9faa4ff4d8569776b5686e472c46bb0">armnn::OpenClTimer::HasKernelMeasurements</a></div><div class="ttdeci">bool HasKernelMeasurements() const override</div><div class="ttdoc">Return true if this Instrument has kernels for recording measurements.</div><div class="ttdef"><b>Definition:</b> <a href="_open_cl_timer_8cpp_source.html#l00088">OpenClTimer.cpp:88</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_instrument_html"><div class="ttname"><a href="classarmnn_1_1_instrument.html">armnn::Instrument</a></div><div class="ttdef"><b>Definition:</b> <a href="_instrument_8hpp_source.html#l00051">Instrument.hpp:51</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_open_cl_timer_html_a156f3866ca69d98b4d9e6e1c1b3ec7da"><div class="ttname"><a href="classarmnn_1_1_open_cl_timer.html#a156f3866ca69d98b4d9e6e1c1b3ec7da">armnn::OpenClTimer::Start</a></div><div class="ttdeci">void Start() override</div><div class="ttdoc">Start the OpenCl timer.</div><div class="ttdef"><b>Definition:</b> <a href="_open_cl_timer_8cpp_source.html#l00021">OpenClTimer.cpp:21</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_open_cl_timer_html_a596f6581a916e95f60c2f203b8bda367"><div class="ttname"><a href="classarmnn_1_1_open_cl_timer.html#a596f6581a916e95f60c2f203b8bda367">armnn::OpenClTimer::~OpenClTimer</a></div><div class="ttdeci">~OpenClTimer()=default</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_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="_open_cl_timer_8hpp.html">OpenClTimer.hpp</a></li>
<li class="footer">Generated on Wed Feb 14 2024 16:36:15 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>
|
