| <!-- Copyright (c) 2020 ARM Limited. --> |
| <!-- --> |
| <!-- SPDX-License-Identifier: MIT --> |
| <!-- --> |
| <!-- HTML header for doxygen 1.8.13--> |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/> |
| <meta name="robots" content="NOINDEX, NOFOLLOW" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>ArmNN: 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> |
| <script type="text/javascript"> |
| $(document).ready(initResizable); |
| </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" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| <link href="stylesheet.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: 10rem; margin-top: .5rem; margin-left 10px"/> |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname"> |
|  <span id="projectnumber">20.02</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.13 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| </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"> |
| $(document).ready(function(){initNavTree('_open_cl_timer_8hpp_source.xhtml','');}); |
| </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.xhtml">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.xhtml">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.xhtml">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.xhtml"> 20</a></span> <span class="comment"></span><span class="keyword">class </span><a class="code" href="classarmnn_1_1_open_cl_timer.xhtml">OpenClTimer</a> : <span class="keyword">public</span> <a class="code" href="classarmnn_1_1_instrument.xhtml">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.xhtml#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.xhtml#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.xhtml#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.xhtml#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"> /// Get the name of the timer</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> /// \return Name of the timer</span></div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classarmnn_1_1_open_cl_timer.xhtml#a7ddf0cf6f620d59c10e63495ace795d0"> 34</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.xhtml#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="l00035"></a><span class="lineno"> 35</span> <span class="comment"></span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</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="l00037"></a><span class="lineno"> 37</span> <span class="comment"> /// \return Recorded measurements</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"></span> std::vector<Measurement> <a class="code" href="classarmnn_1_1_open_cl_timer.xhtml#a86ea36032637c02c045f2d433036a203">GetMeasurements</a>() <span class="keyword">const override</span>;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">using</span> CLScheduler = arm_compute::CLScheduler;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">using</span> CLSymbols = arm_compute::CLSymbols;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">using</span> ClEvent = <a class="code" href="namespacearmnn.xhtml#a4e2dd387ba6f0dc5164b4cdf8de3262aaa4ecfc70574394990cf17bd83df499f7">cl::Event</a>;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">using</span> ClEnqueueFunc = decltype(CLSymbols::clEnqueueNDRangeKernel_ptr);</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"></span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> /// Stores info about the OpenCl kernel</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"></span> <span class="keyword">struct </span>KernelInfo</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  {</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</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="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  std::string m_Name;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  ClEvent m_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> </div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  std::list<KernelInfo> m_Kernels; <span class="comment">///< List of all kernels executed</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"></span> ClEnqueueFunc m_OriginalEnqueueFunction; <span class="comment">///< Keep track of original OpenCl function</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"></span>};</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> } <span class="comment">//namespace armnn</span></div><div class="ttc" id="classarmnn_1_1_open_cl_timer_xhtml_a156f3866ca69d98b4d9e6e1c1b3ec7da"><div class="ttname"><a href="classarmnn_1_1_open_cl_timer.xhtml#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.xhtml#l00021">OpenClTimer.cpp:21</a></div></div> |
| <div class="ttc" id="classarmnn_1_1_open_cl_timer_xhtml_a634c58de2126b4a4e6a2a093e60e1290"><div class="ttname"><a href="classarmnn_1_1_open_cl_timer.xhtml#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.xhtml#l00076">OpenClTimer.cpp:76</a></div></div> |
| <div class="ttc" id="namespacearmnn_xhtml"><div class="ttname"><a href="namespacearmnn.xhtml">armnn</a></div><div class="ttdoc">Copyright (c) 2020 ARM Limited. </div><div class="ttdef"><b>Definition:</b> <a href="00__introduction_8dox_source.xhtml#l00025">00_introduction.dox:25</a></div></div> |
| <div class="ttc" id="classarmnn_1_1_open_cl_timer_xhtml_a596f6581a916e95f60c2f203b8bda367"><div class="ttname"><a href="classarmnn_1_1_open_cl_timer.xhtml#a596f6581a916e95f60c2f203b8bda367">armnn::OpenClTimer::~OpenClTimer</a></div><div class="ttdeci">~OpenClTimer()=default</div></div> |
| <div class="ttc" id="classarmnn_1_1_open_cl_timer_xhtml_a86ea36032637c02c045f2d433036a203"><div class="ttname"><a href="classarmnn_1_1_open_cl_timer.xhtml#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.xhtml#l00081">OpenClTimer.cpp:81</a></div></div> |
| <div class="ttc" id="classarmnn_1_1_open_cl_timer_xhtml"><div class="ttname"><a href="classarmnn_1_1_open_cl_timer.xhtml">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.xhtml#l00020">OpenClTimer.hpp:20</a></div></div> |
| <div class="ttc" id="classarmnn_1_1_open_cl_timer_xhtml_a7ddf0cf6f620d59c10e63495ace795d0"><div class="ttname"><a href="classarmnn_1_1_open_cl_timer.xhtml#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.xhtml#l00034">OpenClTimer.hpp:34</a></div></div> |
| <div class="ttc" id="classarmnn_1_1_open_cl_timer_xhtml_adcd19a0c31e8ffa4411fa05e905c0cf4"><div class="ttname"><a href="classarmnn_1_1_open_cl_timer.xhtml#adcd19a0c31e8ffa4411fa05e905c0cf4">armnn::OpenClTimer::OpenClTimer</a></div><div class="ttdeci">OpenClTimer()</div><div class="ttdef"><b>Definition:</b> <a href="_open_cl_timer_8cpp_source.xhtml#l00017">OpenClTimer.cpp:17</a></div></div> |
| <div class="ttc" id="namespacearmnn_xhtml_a4e2dd387ba6f0dc5164b4cdf8de3262aaa4ecfc70574394990cf17bd83df499f7"><div class="ttname"><a href="namespacearmnn.xhtml#a4e2dd387ba6f0dc5164b4cdf8de3262aaa4ecfc70574394990cf17bd83df499f7">armnn::JsonObjectType::Event</a></div></div> |
| <div class="ttc" id="_instrument_8hpp_xhtml"><div class="ttname"><a href="_instrument_8hpp.xhtml">Instrument.hpp</a></div></div> |
| <div class="ttc" id="classarmnn_1_1_instrument_xhtml"><div class="ttname"><a href="classarmnn_1_1_instrument.xhtml">armnn::Instrument</a></div><div class="ttdef"><b>Definition:</b> <a href="_instrument_8hpp_source.xhtml#l00051">Instrument.hpp:51</a></div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| </div><!-- doc-content --> |
| <!-- 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.xhtml">src</a></li><li class="navelem"><a class="el" href="dir_0f3cdec46afbc61a1ded8e1687c9c9a0.xhtml">backends</a></li><li class="navelem"><a class="el" href="dir_1ad86c6d39ab715a831555571b9e98a5.xhtml">cl</a></li><li class="navelem"><a class="el" href="_open_cl_timer_8hpp.xhtml">OpenClTimer.hpp</a></li> |
| <li class="footer">Generated on Fri Mar 13 2020 16:09:11 for ArmNN by |
| <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |
