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
|
<!-- 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: include/armnn/IProfiler.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">21.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('_i_profiler_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">IProfiler.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="_i_profiler_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 <iostream></span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> </div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="keyword">namespace </span><a class="code" href="namespacearmnn.xhtml">armnn</a></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> {</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="keyword">class </span>ProfilerImpl;</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="keyword">class </span>BackendId;</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">class </span>Instrument;</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">class </span><a class="code" href="namespacearmnn.xhtml#a4e2dd387ba6f0dc5164b4cdf8de3262aaa4ecfc70574394990cf17bd83df499f7">Event</a>;</div><div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="classarmnn_1_1_i_profiler.xhtml"> 19</a></span> <span class="keyword">class </span><a class="code" href="classarmnn_1_1_i_profiler.xhtml">IProfiler</a></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> {</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">public</span>:<span class="comment"></span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> /// Enables/disables profiling for this profiler.</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> /// @param [in] enableProfiling A flag that indicates whether profiling should be enabled or not.</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1_i_profiler.xhtml#af556ae358458c476f8594b3bbb28d712">EnableProfiling</a>(<span class="keywordtype">bool</span> enableProfiling);</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"> /// Checks whether profiling is enabled.</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> /// Profiling is disabled by default.</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> /// @return true if profiling is enabled, false otherwise.</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="classarmnn_1_1_i_profiler.xhtml#aa5a25e3cf143724a9460c4aa9c47841b">IsProfilingEnabled</a>();</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"></span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> /// Analyzes the tracked events and writes the results to the given output stream.</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> /// Please refer to the configuration variables in Profiling.cpp to customize the information written.</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> /// @param [out] outStream The stream where to write the profiling results to.</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1_i_profiler.xhtml#ac9f22844fb2e329ffd193f2d9a8ce336">AnalyzeEventsAndWriteResults</a>(std::ostream& outStream) <span class="keyword">const</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"> /// Print stats for events in JSON Format to the given output stream.</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> /// @param [out] outStream The stream where to write the profiling results to.</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1_i_profiler.xhtml#a038bb767bbc6abc0ee0d9b509616b896">Print</a>(std::ostream& outStream) <span class="keyword">const</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>  <a class="code" href="classarmnn_1_1_i_profiler.xhtml#a3e96ca374a63bd8547fe68a5d9809df7">~IProfiler</a>();</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <a class="code" href="classarmnn_1_1_i_profiler.xhtml#ac1f916bbd576830b5c35c9987581f301">IProfiler</a>();</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> InstrumentPtr = std::unique_ptr<Instrument>;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <a class="code" href="classarmnn_1_1_event.xhtml">Event</a>* BeginEvent(<span class="keyword">const</span> <a class="code" href="classarmnn_1_1_backend_id.xhtml">BackendId</a>& backendId,</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">const</span> std::string& label,</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  std::vector<InstrumentPtr>&& instruments);</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  std::unique_ptr<ProfilerImpl> pProfilerImpl;</div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="classarmnn_1_1_i_profiler.xhtml#a07324741b1a460634a1d58935d77de4c"> 49</a></span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classarmnn_1_1_scoped_profiling_event.xhtml">ScopedProfilingEvent</a>;</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>  <span class="comment">// Friend functions for unit testing, see ProfilerTests.cpp.</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">friend</span> <span class="keywordtype">size_t</span> <a class="code" href="classarmnn_1_1_i_profiler.xhtml#a64f137d035aca340f3b5624acd5bdc9a">GetProfilerEventSequenceSize</a>(<a class="code" href="classarmnn_1_1_i_profiler.xhtml">armnn::IProfiler</a>* profiler);</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> } <span class="comment">// namespace armnn</span></div><div class="ttc" id="classarmnn_1_1_event_xhtml"><div class="ttname"><a href="classarmnn_1_1_event.xhtml">armnn::Event</a></div><div class="ttdoc">Event class records measurements reported by BeginEvent()/EndEvent() and returns measurements when Ev...</div><div class="ttdef"><b>Definition:</b> <a href="_profiling_event_8hpp_source.xhtml#l00023">ProfilingEvent.hpp:23</a></div></div>
<div class="ttc" id="classarmnn_1_1_i_profiler_xhtml_ac1f916bbd576830b5c35c9987581f301"><div class="ttname"><a href="classarmnn_1_1_i_profiler.xhtml#ac1f916bbd576830b5c35c9987581f301">armnn::IProfiler::IProfiler</a></div><div class="ttdeci">IProfiler()</div><div class="ttdef"><b>Definition:</b> <a href="_profiling_8cpp_source.xhtml#l00535">Profiling.cpp:535</a></div></div>
<div class="ttc" id="classarmnn_1_1_i_profiler_xhtml_a64f137d035aca340f3b5624acd5bdc9a"><div class="ttname"><a href="classarmnn_1_1_i_profiler.xhtml#a64f137d035aca340f3b5624acd5bdc9a">armnn::IProfiler::GetProfilerEventSequenceSize</a></div><div class="ttdeci">friend size_t GetProfilerEventSequenceSize(armnn::IProfiler *profiler)</div><div class="ttdef"><b>Definition:</b> <a href="_profiler_tests_8cpp_source.xhtml#l00022">ProfilerTests.cpp:22</a></div></div>
<div class="ttc" id="classarmnn_1_1_i_profiler_xhtml_a038bb767bbc6abc0ee0d9b509616b896"><div class="ttname"><a href="classarmnn_1_1_i_profiler.xhtml#a038bb767bbc6abc0ee0d9b509616b896">armnn::IProfiler::Print</a></div><div class="ttdeci">void Print(std::ostream &outStream) const</div><div class="ttdoc">Print stats for events in JSON Format to the given output stream. </div><div class="ttdef"><b>Definition:</b> <a href="_profiling_8cpp_source.xhtml#l00522">Profiling.cpp:522</a></div></div>
<div class="ttc" id="classarmnn_1_1_i_profiler_xhtml_ac9f22844fb2e329ffd193f2d9a8ce336"><div class="ttname"><a href="classarmnn_1_1_i_profiler.xhtml#ac9f22844fb2e329ffd193f2d9a8ce336">armnn::IProfiler::AnalyzeEventsAndWriteResults</a></div><div class="ttdeci">void AnalyzeEventsAndWriteResults(std::ostream &outStream) const</div><div class="ttdoc">Analyzes the tracked events and writes the results to the given output stream. </div><div class="ttdef"><b>Definition:</b> <a href="_profiling_8cpp_source.xhtml#l00517">Profiling.cpp:517</a></div></div>
<div class="ttc" id="namespacearmnn_xhtml"><div class="ttname"><a href="namespacearmnn.xhtml">armnn</a></div><div class="ttdoc">Copyright (c) 2021 ARM Limited and Contributors. </div><div class="ttdef"><b>Definition:</b> <a href="01__00__software__tools_8dox_source.xhtml#l00006">01_00_software_tools.dox:6</a></div></div>
<div class="ttc" id="classarmnn_1_1_i_profiler_xhtml_af556ae358458c476f8594b3bbb28d712"><div class="ttname"><a href="classarmnn_1_1_i_profiler.xhtml#af556ae358458c476f8594b3bbb28d712">armnn::IProfiler::EnableProfiling</a></div><div class="ttdeci">void EnableProfiling(bool enableProfiling)</div><div class="ttdoc">Enables/disables profiling for this profiler. </div><div class="ttdef"><b>Definition:</b> <a href="_profiling_8cpp_source.xhtml#l00507">Profiling.cpp:507</a></div></div>
<div class="ttc" id="classarmnn_1_1_i_profiler_xhtml_aa5a25e3cf143724a9460c4aa9c47841b"><div class="ttname"><a href="classarmnn_1_1_i_profiler.xhtml#aa5a25e3cf143724a9460c4aa9c47841b">armnn::IProfiler::IsProfilingEnabled</a></div><div class="ttdeci">bool IsProfilingEnabled()</div><div class="ttdoc">Checks whether profiling is enabled. </div><div class="ttdef"><b>Definition:</b> <a href="_profiling_8cpp_source.xhtml#l00512">Profiling.cpp:512</a></div></div>
<div class="ttc" id="classarmnn_1_1_scoped_profiling_event_xhtml"><div class="ttname"><a href="classarmnn_1_1_scoped_profiling_event.xhtml">armnn::ScopedProfilingEvent</a></div><div class="ttdef"><b>Definition:</b> <a href="_profiling_8hpp_source.xhtml#l00110">Profiling.hpp:110</a></div></div>
<div class="ttc" id="classarmnn_1_1_i_profiler_xhtml"><div class="ttname"><a href="classarmnn_1_1_i_profiler.xhtml">armnn::IProfiler</a></div><div class="ttdef"><b>Definition:</b> <a href="_i_profiler_8hpp_source.xhtml#l00019">IProfiler.hpp:19</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="classarmnn_1_1_i_profiler_xhtml_a3e96ca374a63bd8547fe68a5d9809df7"><div class="ttname"><a href="classarmnn_1_1_i_profiler.xhtml#a3e96ca374a63bd8547fe68a5d9809df7">armnn::IProfiler::~IProfiler</a></div><div class="ttdeci">~IProfiler()</div></div>
<div class="ttc" id="classarmnn_1_1_backend_id_xhtml"><div class="ttname"><a href="classarmnn_1_1_backend_id.xhtml">armnn::BackendId</a></div><div class="ttdef"><b>Definition:</b> <a href="_backend_id_8hpp_source.xhtml#l00075">BackendId.hpp:75</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_d44c64559bbebec7f509842c48db8b23.xhtml">include</a></li><li class="navelem"><a class="el" href="dir_2b72cc348e06937955e62ebdd8a13436.xhtml">armnn</a></li><li class="navelem"><a class="el" href="_i_profiler_8hpp.xhtml">IProfiler.hpp</a></li>
<li class="footer">Generated on Fri Mar 19 2021 15:25:36 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>
|
