blob: 161751668e5271f610020884c4c4651d1b4b58d3 [file] [log] [blame]
Ryan OSheade36e4a2020-03-13 16:26:19 +00001<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6<meta name="generator" content="Doxygen 1.8.13"/>
7<meta name="viewport" content="width=device-width, initial-scale=1"/>
8<title>ArmNN: src/profiling/ProfilingConnectionFactory.cpp Source File</title>
9<link href="tabs.css" rel="stylesheet" type="text/css"/>
10<script type="text/javascript" src="jquery.js"></script>
11<script type="text/javascript" src="dynsections.js"></script>
12<link href="navtree.css" rel="stylesheet" type="text/css"/>
13<script type="text/javascript" src="resize.js"></script>
14<script type="text/javascript" src="navtreedata.js"></script>
15<script type="text/javascript" src="navtree.js"></script>
16<script type="text/javascript">
17 $(document).ready(initResizable);
18</script>
19<link href="search/search.css" rel="stylesheet" type="text/css"/>
20<script type="text/javascript" src="search/searchdata.js"></script>
21<script type="text/javascript" src="search/search.js"></script>
22<link href="doxygen.css" rel="stylesheet" type="text/css" />
23</head>
24<body>
25<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
26<div id="titlearea">
27<table cellspacing="0" cellpadding="0">
28 <tbody>
29 <tr style="height: 56px;">
30 <td id="projectalign" style="padding-left: 0.5em;">
31 <div id="projectname">ArmNN
32 &#160;<span id="projectnumber">NotReleased</span>
33 </div>
34 </td>
35 </tr>
36 </tbody>
37</table>
38</div>
39<!-- end header part -->
40<!-- Generated by Doxygen 1.8.13 -->
41<script type="text/javascript">
42var searchBox = new SearchBox("searchBox", "search",false,'Search');
43</script>
44<script type="text/javascript" src="menudata.js"></script>
45<script type="text/javascript" src="menu.js"></script>
46<script type="text/javascript">
47$(function() {
48 initMenu('',true,false,'search.php','Search');
49 $(document).ready(function() { init_search(); });
50});
51</script>
52<div id="main-nav"></div>
53</div><!-- top -->
54<div id="side-nav" class="ui-resizable side-nav-resizable">
55 <div id="nav-tree">
56 <div id="nav-tree-contents">
57 <div id="nav-sync" class="sync"></div>
58 </div>
59 </div>
60 <div id="splitbar" style="-moz-user-select:none;"
61 class="ui-resizable-handle">
62 </div>
63</div>
64<script type="text/javascript">
65$(document).ready(function(){initNavTree('_profiling_connection_factory_8cpp_source.html','');});
66</script>
67<div id="doc-content">
68<!-- window showing the filter options -->
69<div id="MSearchSelectWindow"
70 onmouseover="return searchBox.OnSearchSelectShow()"
71 onmouseout="return searchBox.OnSearchSelectHide()"
72 onkeydown="return searchBox.OnSearchSelectKey(event)">
73</div>
74
75<!-- iframe showing the search results (closed by default) -->
76<div id="MSearchResultsWindow">
77<iframe src="javascript:void(0)" frameborder="0"
78 name="MSearchResults" id="MSearchResults">
79</iframe>
80</div>
81
82<div class="header">
83 <div class="headertitle">
84<div class="title">ProfilingConnectionFactory.cpp</div> </div>
85</div><!--header-->
86<div class="contents">
87<a href="_profiling_connection_factory_8cpp.html">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 © 2019 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">#include &quot;<a class="code" href="_profiling_connection_factory_8hpp.html">ProfilingConnectionFactory.hpp</a>&quot;</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="_file_only_profiling_connection_8hpp.html">FileOnlyProfilingConnection.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="_profiling_connection_dump_to_file_decorator_8hpp.html">ProfilingConnectionDumpToFileDecorator.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="_socket_profiling_connection_8hpp.html">SocketProfilingConnection.hpp</a>&quot;</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacearmnn.html">armnn</a></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;{</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;<span class="keyword">namespace </span>profiling</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;{</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"><a class="line" href="classarmnn_1_1profiling_1_1_profiling_connection_factory.html#a627a4a9df4ecd888a1cf3380c5563d50"> 18</a></span>&#160;std::unique_ptr&lt;IProfilingConnection&gt; <a class="code" href="classarmnn_1_1profiling_1_1_profiling_connection_factory.html#a627a4a9df4ecd888a1cf3380c5563d50">ProfilingConnectionFactory::GetProfilingConnection</a>(</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; <span class="keyword">const</span> Runtime::CreationOptions::ExternalProfilingOptions&amp; <a class="code" href="_file_only_profiling_decorator_tests_8cpp.html#a6560146509197f3e197d8d36f76c1347">options</a>)<span class="keyword"> const</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="keyword"></span>{</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; <span class="comment">// We can create 3 different types of IProfilingConnection.</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="comment">// 1: If no relevant options are specified then a SocketProfilingConnection is returned.</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="comment">// 2: If both incoming and outgoing capture files are specified then a SocketProfilingConnection decorated by a</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="comment">// ProfilingConnectionDumpToFileDecorator is returned.</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="comment">// 3: If both incoming and outgoing capture files are specified and &quot;file only&quot; then a FileOnlyProfilingConnection</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="comment">// decorated by a ProfilingConnectionDumpToFileDecorator is returned.</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keywordflow">if</span> ((!options.m_IncomingCaptureFile.empty() || !options.m_OutgoingCaptureFile.empty()) &amp;&amp; !options.m_FileOnly)</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; {</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="comment">// This is type 2.</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keywordflow">return</span> std::make_unique&lt;ProfilingConnectionDumpToFileDecorator&gt;(std::make_unique&lt;SocketProfilingConnection&gt;(),</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; options);</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; }</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keywordflow">else</span> <span class="keywordflow">if</span> ((!options.m_IncomingCaptureFile.empty() || !options.m_OutgoingCaptureFile.empty()) &amp;&amp; options.m_FileOnly)</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="comment">// This is type 3.</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keywordflow">return</span> std::make_unique&lt;ProfilingConnectionDumpToFileDecorator&gt;(</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; std::make_unique&lt;FileOnlyProfilingConnection&gt;(<a class="code" href="_file_only_profiling_decorator_tests_8cpp.html#a6560146509197f3e197d8d36f76c1347">options</a>), options);</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; }</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keywordflow">else</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; {</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="comment">// This is type 1.</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordflow">return</span> std::make_unique&lt;SocketProfilingConnection&gt;();</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; }</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;}</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;} <span class="comment">// namespace profiling</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;} <span class="comment">// namespace armnn</span></div><div class="ttc" id="_profiling_connection_factory_8hpp_html"><div class="ttname"><a href="_profiling_connection_factory_8hpp.html">ProfilingConnectionFactory.hpp</a></div></div>
88<div class="ttc" id="_file_only_profiling_connection_8hpp_html"><div class="ttname"><a href="_file_only_profiling_connection_8hpp.html">FileOnlyProfilingConnection.hpp</a></div></div>
89<div class="ttc" id="namespacearmnn_html"><div class="ttname"><a href="namespacearmnn.html">armnn</a></div><div class="ttdef"><b>Definition:</b> <a href="_backend_helper_8hpp_source.html#l00011">BackendHelper.hpp:11</a></div></div>
90<div class="ttc" id="_profiling_connection_dump_to_file_decorator_8hpp_html"><div class="ttname"><a href="_profiling_connection_dump_to_file_decorator_8hpp.html">ProfilingConnectionDumpToFileDecorator.hpp</a></div></div>
91<div class="ttc" id="_socket_profiling_connection_8hpp_html"><div class="ttname"><a href="_socket_profiling_connection_8hpp.html">SocketProfilingConnection.hpp</a></div></div>
92<div class="ttc" id="classarmnn_1_1profiling_1_1_profiling_connection_factory_html_a627a4a9df4ecd888a1cf3380c5563d50"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_profiling_connection_factory.html#a627a4a9df4ecd888a1cf3380c5563d50">armnn::profiling::ProfilingConnectionFactory::GetProfilingConnection</a></div><div class="ttdeci">IProfilingConnectionPtr GetProfilingConnection(const ExternalProfilingOptions &amp;options) const override</div><div class="ttdef"><b>Definition:</b> <a href="_profiling_connection_factory_8cpp_source.html#l00018">ProfilingConnectionFactory.cpp:18</a></div></div>
93<div class="ttc" id="_file_only_profiling_decorator_tests_8cpp_html_a6560146509197f3e197d8d36f76c1347"><div class="ttname"><a href="_file_only_profiling_decorator_tests_8cpp.html#a6560146509197f3e197d8d36f76c1347">options</a></div><div class="ttdeci">armnn::Runtime::CreationOptions::ExternalProfilingOptions options</div><div class="ttdef"><b>Definition:</b> <a href="_file_only_profiling_decorator_tests_8cpp_source.html#l00045">FileOnlyProfilingDecoratorTests.cpp:45</a></div></div>
94</div><!-- fragment --></div><!-- contents -->
95</div><!-- doc-content -->
96<!-- start footer part -->
97<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
98 <ul>
99 <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_637c692f14729569dd2eac0c18e2a54a.html">profiling</a></li><li class="navelem"><a class="el" href="_profiling_connection_factory_8cpp.html">ProfilingConnectionFactory.cpp</a></li>
100 <li class="footer">Generated on Fri Mar 13 2020 16:06:58 for ArmNN by
101 <a href="http://www.doxygen.org/index.html">
102 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
103 </ul>
104</div>
105</body>
106</html>