blob: a8e6f50676a8fc2be1069211fb3d53c2c59e44cf [file] [log] [blame]
<!-- 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/profiling/RegisterBackendCounters.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">
&#160;<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('_register_backend_counters_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">RegisterBackendCounters.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="_register_backend_counters_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>&#160;<span class="comment">//</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// Copyright © 2020 Arm Ltd. All rights reserved.</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// SPDX-License-Identifier: MIT</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;</div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_i_backend_profiling_8hpp.xhtml">armnn/backends/profiling/IBackendProfiling.hpp</a>&quot;</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_counter_id_map_8hpp.xhtml">CounterIdMap.hpp</a>&quot;</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="src_2profiling_2_counter_directory_8hpp.xhtml">CounterDirectory.hpp</a>&quot;</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_profiling_service_8hpp.xhtml">ProfilingService.hpp</a>&quot;</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacearmnn.xhtml">armnn</a></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;{</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="keyword">namespace </span>profiling</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;{</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="classarmnn_1_1profiling_1_1_register_backend_counters.xhtml"> 19</a></span>&#160;<span class="keyword">class </span><a class="code" href="classarmnn_1_1profiling_1_1_register_backend_counters.xhtml">RegisterBackendCounters</a> : <span class="keyword">public</span> <a class="code" href="classarmnn_1_1profiling_1_1_i_register_backend_counters.xhtml">IRegisterBackendCounters</a></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;{</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="classarmnn_1_1profiling_1_1_register_backend_counters.xhtml#ab042ed57eb321c54a12485f15563aae4"> 23</a></span>&#160; <a class="code" href="classarmnn_1_1profiling_1_1_register_backend_counters.xhtml#ab042ed57eb321c54a12485f15563aae4">RegisterBackendCounters</a>(uint16_t currentMaxGlobalCounterID, <span class="keyword">const</span> <a class="code" href="classarmnn_1_1_backend_id.xhtml">BackendId</a>&amp; backendId)</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; : m_CurrentMaxGlobalCounterID(currentMaxGlobalCounterID),</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; m_CounterDirectory(<a class="code" href="classarmnn_1_1profiling_1_1_profiling_service.xhtml">ProfilingService</a>::Instance().GetCounterRegistry()),</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; m_BackendId(backendId) {}</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <a class="code" href="classarmnn_1_1profiling_1_1_register_backend_counters.xhtml#ac388ab1e8ba5bf4b0b9abddac2f0a0dc">~RegisterBackendCounters</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1profiling_1_1_register_backend_counters.xhtml#a547f56db3e9e8c6f5b6ac7b7d3194bfe">RegisterCategory</a>(<span class="keyword">const</span> std::string&amp; categoryName) <span class="keyword">override</span>;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; uint16_t <a class="code" href="classarmnn_1_1profiling_1_1_register_backend_counters.xhtml#aa59f702553e07454e57b7d75294ded25">RegisterDevice</a>(<span class="keyword">const</span> std::string&amp; deviceName,</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; uint16_t cores = 0,</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keyword">const</span> <a class="code" href="classarmnn_1_1_optional.xhtml">Optional&lt;std::string&gt;</a>&amp; parentCategoryName = <a class="code" href="structarmnn_1_1_empty_optional.xhtml">EmptyOptional</a>()) <span class="keyword">override</span>;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; uint16_t <a class="code" href="classarmnn_1_1profiling_1_1_register_backend_counters.xhtml#a3760d7378ebc54c779f5032662890154">RegisterCounterSet</a>(<span class="keyword">const</span> std::string&amp; counterSetName,</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; uint16_t count = 0,</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keyword">const</span> <a class="code" href="classarmnn_1_1_optional.xhtml">Optional&lt;std::string&gt;</a>&amp; parentCategoryName = <a class="code" href="structarmnn_1_1_empty_optional.xhtml">EmptyOptional</a>()) <span class="keyword">override</span>;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; uint16_t <a class="code" href="classarmnn_1_1profiling_1_1_register_backend_counters.xhtml#a380988b279ec147ed405cc86d4436975">RegisterCounter</a>(<span class="keyword">const</span> uint16_t uid,</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keyword">const</span> std::string&amp; parentCategoryName,</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; uint16_t counterClass,</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; uint16_t interpolation,</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordtype">double</span> multiplier,</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keyword">const</span> std::string&amp; name,</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keyword">const</span> std::string&amp; description,</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keyword">const</span> <a class="code" href="classarmnn_1_1_optional.xhtml">Optional&lt;std::string&gt;</a>&amp; units = <a class="code" href="structarmnn_1_1_empty_optional.xhtml">EmptyOptional</a>(),</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keyword">const</span> <a class="code" href="classarmnn_1_1_optional.xhtml">Optional&lt;uint16_t&gt;</a>&amp; numberOfCores = <a class="code" href="structarmnn_1_1_empty_optional.xhtml">EmptyOptional</a>(),</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keyword">const</span> <a class="code" href="classarmnn_1_1_optional.xhtml">Optional&lt;uint16_t&gt;</a>&amp; deviceUid = <a class="code" href="structarmnn_1_1_empty_optional.xhtml">EmptyOptional</a>(),</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keyword">const</span> <a class="code" href="classarmnn_1_1_optional.xhtml">Optional&lt;uint16_t&gt;</a>&amp; counterSetUid = <a class="code" href="structarmnn_1_1_empty_optional.xhtml">EmptyOptional</a>()) <span class="keyword">override</span>;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; uint16_t m_CurrentMaxGlobalCounterID;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <a class="code" href="classarmnn_1_1profiling_1_1_i_counter_registry.xhtml">ICounterRegistry</a>&amp; m_CounterDirectory;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keyword">const</span> <a class="code" href="classarmnn_1_1_backend_id.xhtml">BackendId</a>&amp; m_BackendId;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;};</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;} <span class="comment">// namespace profiling</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;} <span class="comment">// namespace armnn</span></div><div class="ttc" id="classarmnn_1_1_optional_xhtml"><div class="ttname"><a href="classarmnn_1_1_optional.xhtml">armnn::Optional</a></div><div class="ttdef"><b>Definition:</b> <a href="_optional_8hpp_source.xhtml#l00270">Optional.hpp:270</a></div></div>
<div class="ttc" id="classarmnn_1_1profiling_1_1_i_register_backend_counters_xhtml"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_i_register_backend_counters.xhtml">armnn::profiling::IRegisterBackendCounters</a></div><div class="ttdef"><b>Definition:</b> <a href="_i_backend_profiling_8hpp_source.xhtml#l00049">IBackendProfiling.hpp:49</a></div></div>
<div class="ttc" id="classarmnn_1_1profiling_1_1_register_backend_counters_xhtml_aa59f702553e07454e57b7d75294ded25"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_register_backend_counters.xhtml#aa59f702553e07454e57b7d75294ded25">armnn::profiling::RegisterBackendCounters::RegisterDevice</a></div><div class="ttdeci">uint16_t RegisterDevice(const std::string &amp;deviceName, uint16_t cores=0, const Optional&lt; std::string &gt; &amp;parentCategoryName=EmptyOptional()) override</div><div class="ttdef"><b>Definition:</b> <a href="_register_backend_counters_8cpp_source.xhtml#l00019">RegisterBackendCounters.cpp:19</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_1profiling_1_1_register_backend_counters_xhtml_ac388ab1e8ba5bf4b0b9abddac2f0a0dc"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_register_backend_counters.xhtml#ac388ab1e8ba5bf4b0b9abddac2f0a0dc">armnn::profiling::RegisterBackendCounters::~RegisterBackendCounters</a></div><div class="ttdeci">~RegisterBackendCounters()=default</div></div>
<div class="ttc" id="src_2profiling_2_counter_directory_8hpp_xhtml"><div class="ttname"><a href="src_2profiling_2_counter_directory_8hpp.xhtml">CounterDirectory.hpp</a></div></div>
<div class="ttc" id="classarmnn_1_1profiling_1_1_register_backend_counters_xhtml_a3760d7378ebc54c779f5032662890154"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_register_backend_counters.xhtml#a3760d7378ebc54c779f5032662890154">armnn::profiling::RegisterBackendCounters::RegisterCounterSet</a></div><div class="ttdeci">uint16_t RegisterCounterSet(const std::string &amp;counterSetName, uint16_t count=0, const Optional&lt; std::string &gt; &amp;parentCategoryName=EmptyOptional()) override</div><div class="ttdef"><b>Definition:</b> <a href="_register_backend_counters_8cpp_source.xhtml#l00027">RegisterBackendCounters.cpp:27</a></div></div>
<div class="ttc" id="_counter_id_map_8hpp_xhtml"><div class="ttname"><a href="_counter_id_map_8hpp.xhtml">CounterIdMap.hpp</a></div></div>
<div class="ttc" id="classarmnn_1_1profiling_1_1_register_backend_counters_xhtml_ab042ed57eb321c54a12485f15563aae4"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_register_backend_counters.xhtml#ab042ed57eb321c54a12485f15563aae4">armnn::profiling::RegisterBackendCounters::RegisterBackendCounters</a></div><div class="ttdeci">RegisterBackendCounters(uint16_t currentMaxGlobalCounterID, const BackendId &amp;backendId)</div><div class="ttdef"><b>Definition:</b> <a href="_register_backend_counters_8hpp_source.xhtml#l00023">RegisterBackendCounters.hpp:23</a></div></div>
<div class="ttc" id="classarmnn_1_1profiling_1_1_register_backend_counters_xhtml_a380988b279ec147ed405cc86d4436975"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_register_backend_counters.xhtml#a380988b279ec147ed405cc86d4436975">armnn::profiling::RegisterBackendCounters::RegisterCounter</a></div><div class="ttdeci">uint16_t RegisterCounter(const uint16_t uid, const std::string &amp;parentCategoryName, uint16_t counterClass, uint16_t interpolation, double multiplier, const std::string &amp;name, const std::string &amp;description, const Optional&lt; std::string &gt; &amp;units=EmptyOptional(), const Optional&lt; uint16_t &gt; &amp;numberOfCores=EmptyOptional(), const Optional&lt; uint16_t &gt; &amp;deviceUid=EmptyOptional(), const Optional&lt; uint16_t &gt; &amp;counterSetUid=EmptyOptional()) override</div><div class="ttdef"><b>Definition:</b> <a href="_register_backend_counters_8cpp_source.xhtml#l00035">RegisterBackendCounters.cpp:35</a></div></div>
<div class="ttc" id="classarmnn_1_1profiling_1_1_register_backend_counters_xhtml"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_register_backend_counters.xhtml">armnn::profiling::RegisterBackendCounters</a></div><div class="ttdef"><b>Definition:</b> <a href="_register_backend_counters_8hpp_source.xhtml#l00019">RegisterBackendCounters.hpp:19</a></div></div>
<div class="ttc" id="classarmnn_1_1profiling_1_1_profiling_service_xhtml"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_profiling_service.xhtml">armnn::profiling::ProfilingService</a></div><div class="ttdef"><b>Definition:</b> <a href="_profiling_service_8hpp_source.xhtml#l00042">ProfilingService.hpp:42</a></div></div>
<div class="ttc" id="classarmnn_1_1profiling_1_1_register_backend_counters_xhtml_a547f56db3e9e8c6f5b6ac7b7d3194bfe"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_register_backend_counters.xhtml#a547f56db3e9e8c6f5b6ac7b7d3194bfe">armnn::profiling::RegisterBackendCounters::RegisterCategory</a></div><div class="ttdeci">void RegisterCategory(const std::string &amp;categoryName) override</div><div class="ttdef"><b>Definition:</b> <a href="_register_backend_counters_8cpp_source.xhtml#l00014">RegisterBackendCounters.cpp:14</a></div></div>
<div class="ttc" id="structarmnn_1_1_empty_optional_xhtml"><div class="ttname"><a href="structarmnn_1_1_empty_optional.xhtml">armnn::EmptyOptional</a></div><div class="ttdoc">EmptyOptional is used to initialize the Optional class in case we want to have default value for an O...</div><div class="ttdef"><b>Definition:</b> <a href="_optional_8hpp_source.xhtml#l00032">Optional.hpp:32</a></div></div>
<div class="ttc" id="_i_backend_profiling_8hpp_xhtml"><div class="ttname"><a href="_i_backend_profiling_8hpp.xhtml">IBackendProfiling.hpp</a></div></div>
<div class="ttc" id="classarmnn_1_1profiling_1_1_i_counter_registry_xhtml"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_i_counter_registry.xhtml">armnn::profiling::ICounterRegistry</a></div><div class="ttdef"><b>Definition:</b> <a href="_i_counter_registry_8hpp_source.xhtml#l00017">ICounterRegistry.hpp:17</a></div></div>
<div class="ttc" id="_profiling_service_8hpp_xhtml"><div class="ttname"><a href="_profiling_service_8hpp.xhtml">ProfilingService.hpp</a></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_68267d1309a1af8e8297ef4c3efbcdba.xhtml">src</a></li><li class="navelem"><a class="el" href="dir_637c692f14729569dd2eac0c18e2a54a.xhtml">profiling</a></li><li class="navelem"><a class="el" href="_register_backend_counters_8hpp.xhtml">RegisterBackendCounters.hpp</a></li>
<li class="footer">Generated on Fri Mar 13 2020 16:09:13 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>