Ryan OShea | de36e4a | 2020-03-13 16:26:19 +0000 | [diff] [blame] | 1 | <!-- Copyright (c) 2020 ARM Limited. --> |
| 2 | <!-- --> |
| 3 | <!-- SPDX-License-Identifier: MIT --> |
| 4 | <!-- --> |
| 5 | <!-- HTML header for doxygen 1.8.13--> |
| 6 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 7 | <html xmlns="http://www.w3.org/1999/xhtml"> |
| 8 | <head> |
| 9 | <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| 10 | <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| 11 | <meta name="generator" content="Doxygen 1.8.13"/> |
| 12 | <meta name="robots" content="NOINDEX, NOFOLLOW" /> |
| 13 | <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| 14 | <title>ArmNN: include/armnn/profiling/ISendTimelinePacket.hpp Source File</title> |
| 15 | <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| 16 | <script type="text/javascript" src="jquery.js"></script> |
| 17 | <script type="text/javascript" src="dynsections.js"></script> |
| 18 | <link href="navtree.css" rel="stylesheet" type="text/css"/> |
| 19 | <script type="text/javascript" src="resize.js"></script> |
| 20 | <script type="text/javascript" src="navtreedata.js"></script> |
| 21 | <script type="text/javascript" src="navtree.js"></script> |
| 22 | <script type="text/javascript"> |
| 23 | $(document).ready(initResizable); |
| 24 | </script> |
| 25 | <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| 26 | <script type="text/javascript" src="search/searchdata.js"></script> |
| 27 | <script type="text/javascript" src="search/search.js"></script> |
| 28 | <script type="text/x-mathjax-config"> |
| 29 | MathJax.Hub.Config({ |
| 30 | extensions: ["tex2jax.js"], |
| 31 | jax: ["input/TeX","output/HTML-CSS"], |
| 32 | }); |
| 33 | </script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script> |
| 34 | <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| 35 | <link href="stylesheet.css" rel="stylesheet" type="text/css"/> |
| 36 | </head> |
| 37 | <body> |
| 38 | <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| 39 | <div id="titlearea"> |
| 40 | <table cellspacing="0" cellpadding="0"> |
| 41 | <tbody> |
| 42 | <tr style="height: 56px;"> |
| 43 | <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/> |
| 44 | <td style="padding-left: 0.5em;"> |
| 45 | <div id="projectname"> |
| 46 |  <span id="projectnumber">20.02</span> |
| 47 | </div> |
| 48 | </td> |
| 49 | </tr> |
| 50 | </tbody> |
| 51 | </table> |
| 52 | </div> |
| 53 | <!-- end header part --> |
| 54 | <!-- Generated by Doxygen 1.8.13 --> |
| 55 | <script type="text/javascript"> |
| 56 | var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| 57 | </script> |
| 58 | <script type="text/javascript" src="menudata.js"></script> |
| 59 | <script type="text/javascript" src="menu.js"></script> |
| 60 | <script type="text/javascript"> |
| 61 | $(function() { |
| 62 | initMenu('',true,false,'search.php','Search'); |
| 63 | $(document).ready(function() { init_search(); }); |
| 64 | }); |
| 65 | </script> |
| 66 | <div id="main-nav"></div> |
| 67 | </div><!-- top --> |
| 68 | <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| 69 | <div id="nav-tree"> |
| 70 | <div id="nav-tree-contents"> |
| 71 | <div id="nav-sync" class="sync"></div> |
| 72 | </div> |
| 73 | </div> |
| 74 | <div id="splitbar" style="-moz-user-select:none;" |
| 75 | class="ui-resizable-handle"> |
| 76 | </div> |
| 77 | </div> |
| 78 | <script type="text/javascript"> |
| 79 | $(document).ready(function(){initNavTree('_i_send_timeline_packet_8hpp_source.xhtml','');}); |
| 80 | </script> |
| 81 | <div id="doc-content"> |
| 82 | <!-- window showing the filter options --> |
| 83 | <div id="MSearchSelectWindow" |
| 84 | onmouseover="return searchBox.OnSearchSelectShow()" |
| 85 | onmouseout="return searchBox.OnSearchSelectHide()" |
| 86 | onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| 87 | </div> |
| 88 | |
| 89 | <!-- iframe showing the search results (closed by default) --> |
| 90 | <div id="MSearchResultsWindow"> |
| 91 | <iframe src="javascript:void(0)" frameborder="0" |
| 92 | name="MSearchResults" id="MSearchResults"> |
| 93 | </iframe> |
| 94 | </div> |
| 95 | |
| 96 | <div class="header"> |
| 97 | <div class="headertitle"> |
| 98 | <div class="title">ISendTimelinePacket.hpp</div> </div> |
| 99 | </div><!--header--> |
| 100 | <div class="contents"> |
| 101 | <a href="_i_send_timeline_packet_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 © 2019 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 <algorithm></span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include <thread></span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include <vector></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="keyword">namespace </span><a class="code" href="namespacearmnn.xhtml">armnn</a></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> </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="keyword">namespace </span>profiling</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> </div><div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="namespacearmnn_1_1profiling.xhtml#ab805f5aa9f101e7f6d971daba044c3c2"> 19</a></span> <span class="keyword">enum class</span> <a class="code" href="namespacearmnn_1_1profiling.xhtml#ab805f5aa9f101e7f6d971daba044c3c2">ProfilingRelationshipType</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>  <a class="code" href="namespacearmnn_1_1profiling.xhtml#ab805f5aa9f101e7f6d971daba044c3c2afc04d023850b425f3b9c62b3a55dc110">RetentionLink</a>, <span class="comment">/// Head retains(parents) Tail</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"></span> <a class="code" href="namespacearmnn_1_1profiling.xhtml#ab805f5aa9f101e7f6d971daba044c3c2a5265db1a79410fbe447a3faa98e7b914">ExecutionLink</a>, <span class="comment">/// Head execution start depends on Tail execution completion</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"></span> <a class="code" href="namespacearmnn_1_1profiling.xhtml#ab805f5aa9f101e7f6d971daba044c3c2a77ac530ff577e3b84e0761fa02b2520b">DataLink</a>, <span class="comment">/// Head uses data of Tail</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"></span> <a class="code" href="namespacearmnn_1_1profiling.xhtml#ab805f5aa9f101e7f6d971daba044c3c2a47d6c060a0aa40c6fd018f12b7c96f1f">LabelLink</a> <span class="comment">/// Head uses label Tail (Tail MUST be a guid of a label).</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> </div><div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="classarmnn_1_1profiling_1_1_i_send_timeline_packet.xhtml"> 27</a></span> <span class="keyword">class </span><a class="code" href="classarmnn_1_1profiling_1_1_i_send_timeline_packet.xhtml">ISendTimelinePacket</a></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> {</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="classarmnn_1_1profiling_1_1_i_send_timeline_packet.xhtml#a86e61b430276d7fe2861e2b3ac30221c"> 30</a></span>  <span class="keyword">virtual</span> <a class="code" href="classarmnn_1_1profiling_1_1_i_send_timeline_packet.xhtml#a86e61b430276d7fe2861e2b3ac30221c">~ISendTimelinePacket</a>()</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  {}</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"></span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> /// Commits the current buffer and reset the member variables</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> Commit() = 0;</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"> /// Create and write a TimelineEntityBinaryPacket from the parameters to the buffer.</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> SendTimelineEntityBinaryPacket(uint64_t profilingGuid) = 0;</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"> /// Create and write a TimelineEventBinaryPacket from the parameters to the buffer.</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  SendTimelineEventBinaryPacket(uint64_t timestamp, std::thread::id threadId, uint64_t profilingGuid) = 0;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"></span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> /// Create and write a TimelineEventClassBinaryPacket from the parameters to the buffer.</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> SendTimelineEventClassBinaryPacket(uint64_t profilingGuid) = 0;</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"> /// Create and write a TimelineLabelBinaryPacket from the parameters to the buffer.</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> SendTimelineLabelBinaryPacket(uint64_t profilingGuid, <span class="keyword">const</span> std::string& label) = 0;</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"> /// Create and write a TimelineMessageDirectoryPackage in the buffer</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> SendTimelineMessageDirectoryPackage() = 0;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"></span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> /// Create and write a TimelineRelationshipBinaryPacket from the parameters to the buffer.</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> SendTimelineRelationshipBinaryPacket(<a class="code" href="namespacearmnn_1_1profiling.xhtml#ab805f5aa9f101e7f6d971daba044c3c2">ProfilingRelationshipType</a> relationshipType,</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  uint64_t relationshipGuid,</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  uint64_t headGuid,</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  uint64_t tailGuid) = 0;</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> </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> } <span class="comment">// namespace profiling</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> } <span class="comment">// namespace armnn</span></div><div class="ttc" id="namespacearmnn_1_1profiling_xhtml_ab805f5aa9f101e7f6d971daba044c3c2a5265db1a79410fbe447a3faa98e7b914"><div class="ttname"><a href="namespacearmnn_1_1profiling.xhtml#ab805f5aa9f101e7f6d971daba044c3c2a5265db1a79410fbe447a3faa98e7b914">armnn::profiling::ProfilingRelationshipType::ExecutionLink</a></div><div class="ttdoc">Head retains(parents) Tail. </div></div> |
| 102 | <div class="ttc" id="classarmnn_1_1profiling_1_1_i_send_timeline_packet_xhtml"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_i_send_timeline_packet.xhtml">armnn::profiling::ISendTimelinePacket</a></div><div class="ttdef"><b>Definition:</b> <a href="_i_send_timeline_packet_8hpp_source.xhtml#l00027">ISendTimelinePacket.hpp:27</a></div></div> |
| 103 | <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> |
| 104 | <div class="ttc" id="namespacearmnn_1_1profiling_xhtml_ab805f5aa9f101e7f6d971daba044c3c2a77ac530ff577e3b84e0761fa02b2520b"><div class="ttname"><a href="namespacearmnn_1_1profiling.xhtml#ab805f5aa9f101e7f6d971daba044c3c2a77ac530ff577e3b84e0761fa02b2520b">armnn::profiling::ProfilingRelationshipType::DataLink</a></div><div class="ttdoc">Head execution start depends on Tail execution completion. </div></div> |
| 105 | <div class="ttc" id="namespacearmnn_1_1profiling_xhtml_ab805f5aa9f101e7f6d971daba044c3c2a47d6c060a0aa40c6fd018f12b7c96f1f"><div class="ttname"><a href="namespacearmnn_1_1profiling.xhtml#ab805f5aa9f101e7f6d971daba044c3c2a47d6c060a0aa40c6fd018f12b7c96f1f">armnn::profiling::ProfilingRelationshipType::LabelLink</a></div><div class="ttdoc">Head uses data of Tail. </div></div> |
| 106 | <div class="ttc" id="namespacearmnn_1_1profiling_xhtml_ab805f5aa9f101e7f6d971daba044c3c2"><div class="ttname"><a href="namespacearmnn_1_1profiling.xhtml#ab805f5aa9f101e7f6d971daba044c3c2">armnn::profiling::ProfilingRelationshipType</a></div><div class="ttdeci">ProfilingRelationshipType</div><div class="ttdef"><b>Definition:</b> <a href="_i_send_timeline_packet_8hpp_source.xhtml#l00019">ISendTimelinePacket.hpp:19</a></div></div> |
| 107 | <div class="ttc" id="classarmnn_1_1profiling_1_1_i_send_timeline_packet_xhtml_a86e61b430276d7fe2861e2b3ac30221c"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_i_send_timeline_packet.xhtml#a86e61b430276d7fe2861e2b3ac30221c">armnn::profiling::ISendTimelinePacket::~ISendTimelinePacket</a></div><div class="ttdeci">virtual ~ISendTimelinePacket()</div><div class="ttdef"><b>Definition:</b> <a href="_i_send_timeline_packet_8hpp_source.xhtml#l00030">ISendTimelinePacket.hpp:30</a></div></div> |
| 108 | <div class="ttc" id="namespacearmnn_1_1profiling_xhtml_ab805f5aa9f101e7f6d971daba044c3c2afc04d023850b425f3b9c62b3a55dc110"><div class="ttname"><a href="namespacearmnn_1_1profiling.xhtml#ab805f5aa9f101e7f6d971daba044c3c2afc04d023850b425f3b9c62b3a55dc110">armnn::profiling::ProfilingRelationshipType::RetentionLink</a></div></div> |
| 109 | </div><!-- fragment --></div><!-- contents --> |
| 110 | </div><!-- doc-content --> |
| 111 | <!-- start footer part --> |
| 112 | <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| 113 | <ul> |
| 114 | <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="dir_c3e6814e1b6047b3d39c9e911c2f2a46.xhtml">profiling</a></li><li class="navelem"><a class="el" href="_i_send_timeline_packet_8hpp.xhtml">ISendTimelinePacket.hpp</a></li> |
| 115 | <li class="footer">Generated on Fri Mar 13 2020 16:09:08 for ArmNN by |
| 116 | <a href="http://www.doxygen.org/index.html"> |
| 117 | <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> |
| 118 | </ul> |
| 119 | </div> |
| 120 | </body> |
| 121 | </html> |