Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / refs/heads/gh-pages / . / 20.05 / _i_buffer_manager_8hpp_source.xhtml
blob: 4613fe53ad99f73f7a63dc787bb433660ab9eeea [file] [log] [blame]
Colm Donelana983e462020-05-20 16:12:19 +0100[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: src/profiling/IBufferManager.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 &#160;<span id="projectnumber">20.05</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">
56var 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_buffer_manager_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">IBufferManager.hpp</div> </div>
99</div><!--header-->
100<div class="contents">
101<a href="_i_buffer_manager_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 © 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">#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_consumer_8hpp.xhtml">IConsumer.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="_i_packet_buffer_8hpp.xhtml">IPacketBuffer.hpp</a>&quot;</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</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"><a class="line" href="_i_buffer_manager_8hpp.xhtml#aa710a41e4e10ec3243e29e74dacae3c0"> 13</a></span>&#160;<span class="preprocessor">#define MAX_METADATA_PACKET_LENGTH 4096</span></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><a class="code" href="namespacearmnn.xhtml">armnn</a></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"> 18</span>&#160;<span class="keyword">namespace </span>profiling</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;{</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"><a class="line" href="classarmnn_1_1profiling_1_1_i_buffer_manager.xhtml"> 21</a></span>&#160;<span class="keyword">class </span><a class="code" href="classarmnn_1_1profiling_1_1_i_buffer_manager.xhtml">IBufferManager</a></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"> 23</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="classarmnn_1_1profiling_1_1_i_buffer_manager.xhtml#a18c16b4ff70efb2663a4c4c1144babee"> 24</a></span>&#160; <span class="keyword">virtual</span> <a class="code" href="classarmnn_1_1profiling_1_1_i_buffer_manager.xhtml#a18c16b4ff70efb2663a4c4c1144babee">~IBufferManager</a>() {}</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keyword">virtual</span> <a class="code" href="namespacearmnn_1_1profiling.xhtml#a14328d977cec3abadcfd5935f04f3409">IPacketBufferPtr</a> <a class="code" href="classarmnn_1_1profiling_1_1_i_buffer_manager.xhtml#a49c88b0e052621f30462c3bdbf3e4a7a">Reserve</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> requestedSize, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>&amp; reservedSize) = 0;</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; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1profiling_1_1_i_buffer_manager.xhtml#ad0faa8a317506b2e72252f087c7f3c46">Commit</a>(<a class="code" href="namespacearmnn_1_1profiling.xhtml#a14328d977cec3abadcfd5935f04f3409">IPacketBufferPtr</a>&amp; packetBuffer, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size, <span class="keywordtype">bool</span> notifyConsumer = <span class="keyword">true</span>) = 0;</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="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1profiling_1_1_i_buffer_manager.xhtml#a3712fbb9506d016ac2ed7d56b8788a16">Release</a>(<a class="code" href="namespacearmnn_1_1profiling.xhtml#a14328d977cec3abadcfd5935f04f3409">IPacketBufferPtr</a>&amp; packetBuffer) = 0;</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; <span class="keyword">virtual</span> <a class="code" href="namespacearmnn_1_1profiling.xhtml#a14328d977cec3abadcfd5935f04f3409">IPacketBufferPtr</a> <a class="code" href="classarmnn_1_1profiling_1_1_i_buffer_manager.xhtml#acc2e97eddda6324261ba202634cc8ef8">GetReadableBuffer</a>() = 0;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1profiling_1_1_i_buffer_manager.xhtml#a033cae4e6d00fc1958f79f09216a3437">MarkRead</a>(<a class="code" href="namespacearmnn_1_1profiling.xhtml#a14328d977cec3abadcfd5935f04f3409">IPacketBufferPtr</a>&amp; packetBuffer) = 0;</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; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1profiling_1_1_i_buffer_manager.xhtml#a2d5f60e55b59ae8667ff593b5bfc5deb">SetConsumer</a>(<a class="code" href="classarmnn_1_1profiling_1_1_i_consumer.xhtml">IConsumer</a>* consumer) = 0;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1profiling_1_1_i_buffer_manager.xhtml#abb12c72b032fda64ab5a596f5e49fc56">FlushReadList</a>() = 0;</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;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;} <span class="comment">// namespace profiling</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;} <span class="comment">// namespace armnn</span></div><div class="ttc" id="classarmnn_1_1profiling_1_1_i_buffer_manager_xhtml_a49c88b0e052621f30462c3bdbf3e4a7a"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_i_buffer_manager.xhtml#a49c88b0e052621f30462c3bdbf3e4a7a">armnn::profiling::IBufferManager::Reserve</a></div><div class="ttdeci">virtual IPacketBufferPtr Reserve(unsigned int requestedSize, unsigned int &amp;reservedSize)=0</div></div>
102<div class="ttc" id="classarmnn_1_1profiling_1_1_i_buffer_manager_xhtml_acc2e97eddda6324261ba202634cc8ef8"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_i_buffer_manager.xhtml#acc2e97eddda6324261ba202634cc8ef8">armnn::profiling::IBufferManager::GetReadableBuffer</a></div><div class="ttdeci">virtual IPacketBufferPtr GetReadableBuffer()=0</div></div>
103<div class="ttc" id="classarmnn_1_1profiling_1_1_i_consumer_xhtml"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_i_consumer.xhtml">armnn::profiling::IConsumer</a></div><div class="ttdef"><b>Definition:</b> <a href="_i_consumer_8hpp_source.xhtml#l00014">IConsumer.hpp:14</a></div></div>
104<div class="ttc" id="classarmnn_1_1profiling_1_1_i_buffer_manager_xhtml_ad0faa8a317506b2e72252f087c7f3c46"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_i_buffer_manager.xhtml#ad0faa8a317506b2e72252f087c7f3c46">armnn::profiling::IBufferManager::Commit</a></div><div class="ttdeci">virtual void Commit(IPacketBufferPtr &amp;packetBuffer, unsigned int size, bool notifyConsumer=true)=0</div></div>
105<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>
106<div class="ttc" id="_i_consumer_8hpp_xhtml"><div class="ttname"><a href="_i_consumer_8hpp.xhtml">IConsumer.hpp</a></div></div>
107<div class="ttc" id="classarmnn_1_1profiling_1_1_i_buffer_manager_xhtml_a033cae4e6d00fc1958f79f09216a3437"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_i_buffer_manager.xhtml#a033cae4e6d00fc1958f79f09216a3437">armnn::profiling::IBufferManager::MarkRead</a></div><div class="ttdeci">virtual void MarkRead(IPacketBufferPtr &amp;packetBuffer)=0</div></div>
108<div class="ttc" id="_i_packet_buffer_8hpp_xhtml"><div class="ttname"><a href="_i_packet_buffer_8hpp.xhtml">IPacketBuffer.hpp</a></div></div>
109<div class="ttc" id="classarmnn_1_1profiling_1_1_i_buffer_manager_xhtml_a3712fbb9506d016ac2ed7d56b8788a16"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_i_buffer_manager.xhtml#a3712fbb9506d016ac2ed7d56b8788a16">armnn::profiling::IBufferManager::Release</a></div><div class="ttdeci">virtual void Release(IPacketBufferPtr &amp;packetBuffer)=0</div></div>
110<div class="ttc" id="classarmnn_1_1profiling_1_1_i_buffer_manager_xhtml_a18c16b4ff70efb2663a4c4c1144babee"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_i_buffer_manager.xhtml#a18c16b4ff70efb2663a4c4c1144babee">armnn::profiling::IBufferManager::~IBufferManager</a></div><div class="ttdeci">virtual ~IBufferManager()</div><div class="ttdef"><b>Definition:</b> <a href="_i_buffer_manager_8hpp_source.xhtml#l00024">IBufferManager.hpp:24</a></div></div>
111<div class="ttc" id="classarmnn_1_1profiling_1_1_i_buffer_manager_xhtml_abb12c72b032fda64ab5a596f5e49fc56"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_i_buffer_manager.xhtml#abb12c72b032fda64ab5a596f5e49fc56">armnn::profiling::IBufferManager::FlushReadList</a></div><div class="ttdeci">virtual void FlushReadList()=0</div></div>
112<div class="ttc" id="classarmnn_1_1profiling_1_1_i_buffer_manager_xhtml"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_i_buffer_manager.xhtml">armnn::profiling::IBufferManager</a></div><div class="ttdef"><b>Definition:</b> <a href="_i_buffer_manager_8hpp_source.xhtml#l00021">IBufferManager.hpp:21</a></div></div>
113<div class="ttc" id="classarmnn_1_1profiling_1_1_i_buffer_manager_xhtml_a2d5f60e55b59ae8667ff593b5bfc5deb"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_i_buffer_manager.xhtml#a2d5f60e55b59ae8667ff593b5bfc5deb">armnn::profiling::IBufferManager::SetConsumer</a></div><div class="ttdeci">virtual void SetConsumer(IConsumer *consumer)=0</div></div>
114<div class="ttc" id="namespacearmnn_1_1profiling_xhtml_a14328d977cec3abadcfd5935f04f3409"><div class="ttname"><a href="namespacearmnn_1_1profiling.xhtml#a14328d977cec3abadcfd5935f04f3409">armnn::profiling::IPacketBufferPtr</a></div><div class="ttdeci">std::unique_ptr&lt; IPacketBuffer &gt; IPacketBufferPtr</div><div class="ttdef"><b>Definition:</b> <a href="_i_packet_buffer_8hpp_source.xhtml#l00040">IPacketBuffer.hpp:40</a></div></div>
115</div><!-- fragment --></div><!-- contents -->
116</div><!-- doc-content -->
117<!-- start footer part -->
118<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
119 <ul>
120 <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="_i_buffer_manager_8hpp.xhtml">IBufferManager.hpp</a></li>
121 <li class="footer">Generated on Fri May 29 2020 10:20:46 for ArmNN by
122 <a href="http://www.doxygen.org/index.html">
123 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
124 </ul>
125</div>
126</body>
127</html>