Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 78229c4e6472b6e30627d549c97e9cbe678ec4d3 / . / Documentation / classarmnn_1_1profiling_1_1_buffer_manager.xhtml
blob: 549449def802f4677405d3434174ec8d79059bc3 [file] [log] [blame]
Ryan OSheade36e4a2020-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: BufferManager Class Reference</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.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">
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('classarmnn_1_1profiling_1_1_buffer_manager.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="summary">
98<a href="#pub-methods">Public Member Functions</a> &#124;
99<a href="classarmnn_1_1profiling_1_1_buffer_manager-members.xhtml">List of all members</a> </div>
100 <div class="headertitle">
101<div class="title">BufferManager Class Reference</div> </div>
102</div><!--header-->
103<div class="contents">
104
105<p><code>#include &lt;<a class="el" href="_buffer_manager_8hpp_source.xhtml">BufferManager.hpp</a>&gt;</code></p>
106<div class="dynheader">
107Inheritance diagram for BufferManager:</div>
108<div class="dyncontent">
109 <div class="center">
110 <img src="classarmnn_1_1profiling_1_1_buffer_manager.png" usemap="#BufferManager_map" alt=""/>
111 <map id="BufferManager_map" name="BufferManager_map">
112<area href="classarmnn_1_1profiling_1_1_i_buffer_manager.xhtml" alt="IBufferManager" shape="rect" coords="0,0,101,24"/>
113</map>
114 </div></div>
115<table class="memberdecls">
116<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
117Public Member Functions</h2></td></tr>
118<tr class="memitem:a0aee89a45e5c21933b2f16b46bec25e3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_buffer_manager.xhtml#a0aee89a45e5c21933b2f16b46bec25e3">BufferManager</a> (unsigned int numberOfBuffers=5, unsigned int maxPacketSize=4096)</td></tr>
119<tr class="separator:a0aee89a45e5c21933b2f16b46bec25e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
120<tr class="memitem:a8224229b6953f986d6fb2d4d00fe6ee2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_buffer_manager.xhtml#a8224229b6953f986d6fb2d4d00fe6ee2">~BufferManager</a> ()</td></tr>
121<tr class="separator:a8224229b6953f986d6fb2d4d00fe6ee2"><td class="memSeparator" colspan="2">&#160;</td></tr>
122<tr class="memitem:ac3f43b4dd3fafd6b13342acc2263bbb4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearmnn_1_1profiling.xhtml#a14328d977cec3abadcfd5935f04f3409">IPacketBufferPtr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_buffer_manager.xhtml#ac3f43b4dd3fafd6b13342acc2263bbb4">Reserve</a> (unsigned int requestedSize, unsigned int &amp;reservedSize) override</td></tr>
123<tr class="separator:ac3f43b4dd3fafd6b13342acc2263bbb4"><td class="memSeparator" colspan="2">&#160;</td></tr>
124<tr class="memitem:a372de693ad40b3f42839c8ec6ac845f4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_buffer_manager.xhtml#a372de693ad40b3f42839c8ec6ac845f4">Reset</a> ()</td></tr>
125<tr class="separator:a372de693ad40b3f42839c8ec6ac845f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
126<tr class="memitem:a183eaa37ccd326bd82179bed901c7122"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_buffer_manager.xhtml#a183eaa37ccd326bd82179bed901c7122">Commit</a> (<a class="el" href="namespacearmnn_1_1profiling.xhtml#a14328d977cec3abadcfd5935f04f3409">IPacketBufferPtr</a> &amp;packetBuffer, unsigned int size, bool notifyConsumer=<a class="el" href="_ref_layer_tests_8cpp.xhtml#a37f1c3ccc9fc906be85185350dd83d48">true</a>) override</td></tr>
127<tr class="separator:a183eaa37ccd326bd82179bed901c7122"><td class="memSeparator" colspan="2">&#160;</td></tr>
128<tr class="memitem:a226108649851aa1b1a8168560c5228b5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_buffer_manager.xhtml#a226108649851aa1b1a8168560c5228b5">Release</a> (<a class="el" href="namespacearmnn_1_1profiling.xhtml#a14328d977cec3abadcfd5935f04f3409">IPacketBufferPtr</a> &amp;packetBuffer) override</td></tr>
129<tr class="separator:a226108649851aa1b1a8168560c5228b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
130<tr class="memitem:abce8709dc1b666a26f427ba7ff08b737"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearmnn_1_1profiling.xhtml#a14328d977cec3abadcfd5935f04f3409">IPacketBufferPtr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_buffer_manager.xhtml#abce8709dc1b666a26f427ba7ff08b737">GetReadableBuffer</a> () override</td></tr>
131<tr class="separator:abce8709dc1b666a26f427ba7ff08b737"><td class="memSeparator" colspan="2">&#160;</td></tr>
132<tr class="memitem:ae717263b3243e9f88f4caea6d31b0652"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_buffer_manager.xhtml#ae717263b3243e9f88f4caea6d31b0652">MarkRead</a> (<a class="el" href="namespacearmnn_1_1profiling.xhtml#a14328d977cec3abadcfd5935f04f3409">IPacketBufferPtr</a> &amp;packetBuffer) override</td></tr>
133<tr class="separator:ae717263b3243e9f88f4caea6d31b0652"><td class="memSeparator" colspan="2">&#160;</td></tr>
134<tr class="memitem:ad675ff4e9053375bd41d0aad6b3bbb63"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_buffer_manager.xhtml#ad675ff4e9053375bd41d0aad6b3bbb63">SetConsumer</a> (<a class="el" href="classarmnn_1_1profiling_1_1_i_consumer.xhtml">IConsumer</a> *consumer) override</td></tr>
135<tr class="memdesc:ad675ff4e9053375bd41d0aad6b3bbb63"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set Consumer on the buffer manager to be notified when there is a Commit Can only be one consumer. <a href="#ad675ff4e9053375bd41d0aad6b3bbb63">More...</a><br /></td></tr>
136<tr class="separator:ad675ff4e9053375bd41d0aad6b3bbb63"><td class="memSeparator" colspan="2">&#160;</td></tr>
137<tr class="memitem:af22fdc7450c285c4d7449425c8fe994f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_buffer_manager.xhtml#af22fdc7450c285c4d7449425c8fe994f">FlushReadList</a> () override</td></tr>
138<tr class="memdesc:af22fdc7450c285c4d7449425c8fe994f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Notify the Consumer buffer can be read. <a href="#af22fdc7450c285c4d7449425c8fe994f">More...</a><br /></td></tr>
139<tr class="separator:af22fdc7450c285c4d7449425c8fe994f"><td class="memSeparator" colspan="2">&#160;</td></tr>
140<tr class="inherit_header pub_methods_classarmnn_1_1profiling_1_1_i_buffer_manager"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarmnn_1_1profiling_1_1_i_buffer_manager')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarmnn_1_1profiling_1_1_i_buffer_manager.xhtml">IBufferManager</a></td></tr>
141<tr class="memitem:a18c16b4ff70efb2663a4c4c1144babee inherit pub_methods_classarmnn_1_1profiling_1_1_i_buffer_manager"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_buffer_manager.xhtml#a18c16b4ff70efb2663a4c4c1144babee">~IBufferManager</a> ()</td></tr>
142<tr class="separator:a18c16b4ff70efb2663a4c4c1144babee inherit pub_methods_classarmnn_1_1profiling_1_1_i_buffer_manager"><td class="memSeparator" colspan="2">&#160;</td></tr>
143</table>
144<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
145<div class="textblock">
146<p class="definition">Definition at line <a class="el" href="_buffer_manager_8hpp_source.xhtml#l00021">21</a> of file <a class="el" href="_buffer_manager_8hpp_source.xhtml">BufferManager.hpp</a>.</p>
147</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
148<a id="a0aee89a45e5c21933b2f16b46bec25e3"></a>
149<h2 class="memtitle"><span class="permalink"><a href="#a0aee89a45e5c21933b2f16b46bec25e3">&#9670;&nbsp;</a></span>BufferManager()</h2>
150
151<div class="memitem">
152<div class="memproto">
153 <table class="memname">
154 <tr>
155 <td class="memname"><a class="el" href="classarmnn_1_1profiling_1_1_buffer_manager.xhtml">BufferManager</a> </td>
156 <td>(</td>
157 <td class="paramtype">unsigned int&#160;</td>
158 <td class="paramname"><em>numberOfBuffers</em> = <code>5</code>, </td>
159 </tr>
160 <tr>
161 <td class="paramkey"></td>
162 <td></td>
163 <td class="paramtype">unsigned int&#160;</td>
164 <td class="paramname"><em>maxPacketSize</em> = <code>4096</code>&#160;</td>
165 </tr>
166 <tr>
167 <td></td>
168 <td>)</td>
169 <td></td><td></td>
170 </tr>
171 </table>
172</div><div class="memdoc">
173
174<p class="definition">Definition at line <a class="el" href="_buffer_manager_8cpp_source.xhtml#l00015">15</a> of file <a class="el" href="_buffer_manager_8cpp_source.xhtml">BufferManager.cpp</a>.</p>
175<div class="fragment"><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; : m_MaxBufferSize(maxPacketSize),</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; m_NumberOfBuffers(numberOfBuffers)</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"> 19</span>&#160; <a class="code" href="namespacearmnn_utils_1_1_sockets.xhtml#a248c764067ee60c03ee370784c49f353">Initialize</a>();</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;}</div><div class="ttc" id="namespacearmnn_utils_1_1_sockets_xhtml_a248c764067ee60c03ee370784c49f353"><div class="ttname"><a href="namespacearmnn_utils_1_1_sockets.xhtml#a248c764067ee60c03ee370784c49f353">armnnUtils::Sockets::Initialize</a></div><div class="ttdeci">bool Initialize()</div><div class="ttdoc">Performs any required one-time setup. </div><div class="ttdef"><b>Definition:</b> <a href="_network_sockets_8cpp_source.xhtml#l00018">NetworkSockets.cpp:18</a></div></div>
176</div><!-- fragment -->
177</div>
178</div>
179<a id="a8224229b6953f986d6fb2d4d00fe6ee2"></a>
180<h2 class="memtitle"><span class="permalink"><a href="#a8224229b6953f986d6fb2d4d00fe6ee2">&#9670;&nbsp;</a></span>~BufferManager()</h2>
181
182<div class="memitem">
183<div class="memproto">
184<table class="mlabels">
185 <tr>
186 <td class="mlabels-left">
187 <table class="memname">
188 <tr>
189 <td class="memname">~<a class="el" href="classarmnn_1_1profiling_1_1_buffer_manager.xhtml">BufferManager</a> </td>
190 <td>(</td>
191 <td class="paramname"></td><td>)</td>
192 <td></td>
193 </tr>
194 </table>
195 </td>
196 <td class="mlabels-right">
197<span class="mlabels"><span class="mlabel">inline</span></span> </td>
198 </tr>
199</table>
200</div><div class="memdoc">
201
202<p class="definition">Definition at line <a class="el" href="_buffer_manager_8hpp_source.xhtml#l00026">26</a> of file <a class="el" href="_buffer_manager_8hpp_source.xhtml">BufferManager.hpp</a>.</p>
203
204<p class="reference">References <a class="el" href="_buffer_manager_8cpp_source.xhtml#l00043">BufferManager::Commit()</a>, <a class="el" href="_buffer_manager_8cpp_source.xhtml#l00116">BufferManager::FlushReadList()</a>, <a class="el" href="_buffer_manager_8cpp_source.xhtml#l00089">BufferManager::GetReadableBuffer()</a>, <a class="el" href="_buffer_manager_8cpp_source.xhtml#l00102">BufferManager::MarkRead()</a>, <a class="el" href="_buffer_manager_8cpp_source.xhtml#l00068">BufferManager::Release()</a>, <a class="el" href="_buffer_manager_8cpp_source.xhtml#l00022">BufferManager::Reserve()</a>, <a class="el" href="_buffer_manager_8cpp_source.xhtml#l00077">BufferManager::Reset()</a>, and <a class="el" href="_buffer_manager_8cpp_source.xhtml#l00111">BufferManager::SetConsumer()</a>.</p>
205<div class="fragment"><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;{}</div></div><!-- fragment -->
206</div>
207</div>
208<h2 class="groupheader">Member Function Documentation</h2>
209<a id="a183eaa37ccd326bd82179bed901c7122"></a>
210<h2 class="memtitle"><span class="permalink"><a href="#a183eaa37ccd326bd82179bed901c7122">&#9670;&nbsp;</a></span>Commit()</h2>
211
212<div class="memitem">
213<div class="memproto">
214<table class="mlabels">
215 <tr>
216 <td class="mlabels-left">
217 <table class="memname">
218 <tr>
219 <td class="memname">void Commit </td>
220 <td>(</td>
221 <td class="paramtype"><a class="el" href="namespacearmnn_1_1profiling.xhtml#a14328d977cec3abadcfd5935f04f3409">IPacketBufferPtr</a> &amp;&#160;</td>
222 <td class="paramname"><em>packetBuffer</em>, </td>
223 </tr>
224 <tr>
225 <td class="paramkey"></td>
226 <td></td>
227 <td class="paramtype">unsigned int&#160;</td>
228 <td class="paramname"><em>size</em>, </td>
229 </tr>
230 <tr>
231 <td class="paramkey"></td>
232 <td></td>
233 <td class="paramtype">bool&#160;</td>
234 <td class="paramname"><em>notifyConsumer</em> = <code><a class="el" href="_ref_layer_tests_8cpp.xhtml#a37f1c3ccc9fc906be85185350dd83d48">true</a></code>&#160;</td>
235 </tr>
236 <tr>
237 <td></td>
238 <td>)</td>
239 <td></td><td></td>
240 </tr>
241 </table>
242 </td>
243 <td class="mlabels-right">
244<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
245 </tr>
246</table>
247</div><div class="memdoc">
248
249<p>Implements <a class="el" href="classarmnn_1_1profiling_1_1_i_buffer_manager.xhtml#ad0faa8a317506b2e72252f087c7f3c46">IBufferManager</a>.</p>
250
251<p class="definition">Definition at line <a class="el" href="_buffer_manager_8cpp_source.xhtml#l00043">43</a> of file <a class="el" href="_buffer_manager_8cpp_source.xhtml">BufferManager.cpp</a>.</p>
252
253<p class="reference">References <a class="el" href="_buffer_manager_8cpp_source.xhtml#l00116">BufferManager::FlushReadList()</a>.</p>
254
255<p class="reference">Referenced by <a class="el" href="_buffer_tests_8cpp_source.xhtml#l00217">BOOST_AUTO_TEST_CASE()</a>, and <a class="el" href="_buffer_manager_8hpp_source.xhtml#l00026">BufferManager::~BufferManager()</a>.</p>
256<div class="fragment"><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; std::unique_lock&lt;std::mutex&gt; readableListLock(m_ReadableMutex, std::defer_lock);</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; packetBuffer-&gt;Commit(size);</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; readableListLock.lock();</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; m_ReadableList.push_back(std::move(packetBuffer));</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; readableListLock.unlock();</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordflow">if</span> (notifyConsumer)</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; {</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <a class="code" href="classarmnn_1_1profiling_1_1_buffer_manager.xhtml#af22fdc7450c285c4d7449425c8fe994f">FlushReadList</a>();</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; }</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;}</div><div class="ttc" id="classarmnn_1_1profiling_1_1_buffer_manager_xhtml_af22fdc7450c285c4d7449425c8fe994f"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_buffer_manager.xhtml#af22fdc7450c285c4d7449425c8fe994f">armnn::profiling::BufferManager::FlushReadList</a></div><div class="ttdeci">void FlushReadList() override</div><div class="ttdoc">Notify the Consumer buffer can be read. </div><div class="ttdef"><b>Definition:</b> <a href="_buffer_manager_8cpp_source.xhtml#l00116">BufferManager.cpp:116</a></div></div>
257</div><!-- fragment -->
258</div>
259</div>
260<a id="af22fdc7450c285c4d7449425c8fe994f"></a>
261<h2 class="memtitle"><span class="permalink"><a href="#af22fdc7450c285c4d7449425c8fe994f">&#9670;&nbsp;</a></span>FlushReadList()</h2>
262
263<div class="memitem">
264<div class="memproto">
265<table class="mlabels">
266 <tr>
267 <td class="mlabels-left">
268 <table class="memname">
269 <tr>
270 <td class="memname">void FlushReadList </td>
271 <td>(</td>
272 <td class="paramname"></td><td>)</td>
273 <td></td>
274 </tr>
275 </table>
276 </td>
277 <td class="mlabels-right">
278<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
279 </tr>
280</table>
281</div><div class="memdoc">
282
283<p>Notify the Consumer buffer can be read. </p>
284
285<p>Implements <a class="el" href="classarmnn_1_1profiling_1_1_i_buffer_manager.xhtml#abb12c72b032fda64ab5a596f5e49fc56">IBufferManager</a>.</p>
286
287<p class="definition">Definition at line <a class="el" href="_buffer_manager_8cpp_source.xhtml#l00116">116</a> of file <a class="el" href="_buffer_manager_8cpp_source.xhtml">BufferManager.cpp</a>.</p>
288
289<p class="reference">References <a class="el" href="classarmnn_1_1profiling_1_1_i_consumer.xhtml#a4b4fe1cfea0198d9defd88178f073365">IConsumer::SetReadyToRead()</a>.</p>
290
291<p class="reference">Referenced by <a class="el" href="_buffer_manager_8cpp_source.xhtml#l00043">BufferManager::Commit()</a>, and <a class="el" href="_buffer_manager_8hpp_source.xhtml#l00026">BufferManager::~BufferManager()</a>.</p>
292<div class="fragment"><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160;{</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; <span class="comment">// notify consumer that packet is ready to read</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; <span class="keywordflow">if</span> (m_Consumer != <span class="keyword">nullptr</span>)</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; {</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; m_Consumer-&gt;<a class="code" href="classarmnn_1_1profiling_1_1_i_consumer.xhtml#a4b4fe1cfea0198d9defd88178f073365">SetReadyToRead</a>();</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; }</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160;}</div><div class="ttc" id="classarmnn_1_1profiling_1_1_i_consumer_xhtml_a4b4fe1cfea0198d9defd88178f073365"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_i_consumer.xhtml#a4b4fe1cfea0198d9defd88178f073365">armnn::profiling::IConsumer::SetReadyToRead</a></div><div class="ttdeci">virtual void SetReadyToRead()=0</div><div class="ttdoc">Set a &quot;ready to read&quot; flag in the buffer to notify the reading thread to start reading it...</div></div>
293</div><!-- fragment -->
294</div>
295</div>
296<a id="abce8709dc1b666a26f427ba7ff08b737"></a>
297<h2 class="memtitle"><span class="permalink"><a href="#abce8709dc1b666a26f427ba7ff08b737">&#9670;&nbsp;</a></span>GetReadableBuffer()</h2>
298
299<div class="memitem">
300<div class="memproto">
301<table class="mlabels">
302 <tr>
303 <td class="mlabels-left">
304 <table class="memname">
305 <tr>
306 <td class="memname"><a class="el" href="namespacearmnn_1_1profiling.xhtml#a14328d977cec3abadcfd5935f04f3409">IPacketBufferPtr</a> GetReadableBuffer </td>
307 <td>(</td>
308 <td class="paramname"></td><td>)</td>
309 <td></td>
310 </tr>
311 </table>
312 </td>
313 <td class="mlabels-right">
314<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
315 </tr>
316</table>
317</div><div class="memdoc">
318
319<p>Implements <a class="el" href="classarmnn_1_1profiling_1_1_i_buffer_manager.xhtml#acc2e97eddda6324261ba202634cc8ef8">IBufferManager</a>.</p>
320
321<p class="definition">Definition at line <a class="el" href="_buffer_manager_8cpp_source.xhtml#l00089">89</a> of file <a class="el" href="_buffer_manager_8cpp_source.xhtml">BufferManager.cpp</a>.</p>
322
323<p class="reference">Referenced by <a class="el" href="_runtime_tests_8cpp_source.xhtml#l00324">BOOST_AUTO_TEST_CASE()</a>, <a class="el" href="_profiling_test_utils_8cpp_source.xhtml#l00290">VerifyPostOptimisationStructureTestImpl()</a>, and <a class="el" href="_buffer_manager_8hpp_source.xhtml#l00026">BufferManager::~BufferManager()</a>.</p>
324<div class="fragment"><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;{</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; std::unique_lock&lt;std::mutex&gt; readableListLock(m_ReadableMutex);</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="keywordflow">if</span> (!m_ReadableList.empty())</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; {</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <a class="code" href="namespacearmnn_1_1profiling.xhtml#a14328d977cec3abadcfd5935f04f3409">IPacketBufferPtr</a> buffer = std::move(m_ReadableList.back());</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; m_ReadableList.pop_back();</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; readableListLock.unlock();</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="keywordflow">return</span> buffer;</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; }</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; <span class="keywordflow">return</span> <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;}</div><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>
325</div><!-- fragment -->
326</div>
327</div>
328<a id="ae717263b3243e9f88f4caea6d31b0652"></a>
329<h2 class="memtitle"><span class="permalink"><a href="#ae717263b3243e9f88f4caea6d31b0652">&#9670;&nbsp;</a></span>MarkRead()</h2>
330
331<div class="memitem">
332<div class="memproto">
333<table class="mlabels">
334 <tr>
335 <td class="mlabels-left">
336 <table class="memname">
337 <tr>
338 <td class="memname">void MarkRead </td>
339 <td>(</td>
340 <td class="paramtype"><a class="el" href="namespacearmnn_1_1profiling.xhtml#a14328d977cec3abadcfd5935f04f3409">IPacketBufferPtr</a> &amp;&#160;</td>
341 <td class="paramname"><em>packetBuffer</em></td><td>)</td>
342 <td></td>
343 </tr>
344 </table>
345 </td>
346 <td class="mlabels-right">
347<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
348 </tr>
349</table>
350</div><div class="memdoc">
351
352<p>Implements <a class="el" href="classarmnn_1_1profiling_1_1_i_buffer_manager.xhtml#a033cae4e6d00fc1958f79f09216a3437">IBufferManager</a>.</p>
353
354<p class="definition">Definition at line <a class="el" href="_buffer_manager_8cpp_source.xhtml#l00102">102</a> of file <a class="el" href="_buffer_manager_8cpp_source.xhtml">BufferManager.cpp</a>.</p>
355
356<p class="reference">Referenced by <a class="el" href="_runtime_tests_8cpp_source.xhtml#l00365">BOOST_AUTO_TEST_CASE()</a>, <a class="el" href="_profiling_test_utils_8cpp_source.xhtml#l00290">VerifyPostOptimisationStructureTestImpl()</a>, and <a class="el" href="_buffer_manager_8hpp_source.xhtml#l00026">BufferManager::~BufferManager()</a>.</p>
357<div class="fragment"><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;{</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; std::unique_lock&lt;std::mutex&gt; availableListLock(m_AvailableMutex, std::defer_lock);</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; packetBuffer-&gt;MarkRead();</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; availableListLock.lock();</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; m_AvailableList.push_back(std::move(packetBuffer));</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; availableListLock.unlock();</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;}</div></div><!-- fragment -->
358</div>
359</div>
360<a id="a226108649851aa1b1a8168560c5228b5"></a>
361<h2 class="memtitle"><span class="permalink"><a href="#a226108649851aa1b1a8168560c5228b5">&#9670;&nbsp;</a></span>Release()</h2>
362
363<div class="memitem">
364<div class="memproto">
365<table class="mlabels">
366 <tr>
367 <td class="mlabels-left">
368 <table class="memname">
369 <tr>
370 <td class="memname">void Release </td>
371 <td>(</td>
372 <td class="paramtype"><a class="el" href="namespacearmnn_1_1profiling.xhtml#a14328d977cec3abadcfd5935f04f3409">IPacketBufferPtr</a> &amp;&#160;</td>
373 <td class="paramname"><em>packetBuffer</em></td><td>)</td>
374 <td></td>
375 </tr>
376 </table>
377 </td>
378 <td class="mlabels-right">
379<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
380 </tr>
381</table>
382</div><div class="memdoc">
383
384<p>Implements <a class="el" href="classarmnn_1_1profiling_1_1_i_buffer_manager.xhtml#a3712fbb9506d016ac2ed7d56b8788a16">IBufferManager</a>.</p>
385
386<p class="definition">Definition at line <a class="el" href="_buffer_manager_8cpp_source.xhtml#l00068">68</a> of file <a class="el" href="_buffer_manager_8cpp_source.xhtml">BufferManager.cpp</a>.</p>
387
388<p class="reference">Referenced by <a class="el" href="_buffer_tests_8cpp_source.xhtml#l00185">BOOST_AUTO_TEST_CASE()</a>, and <a class="el" href="_buffer_manager_8hpp_source.xhtml#l00026">BufferManager::~BufferManager()</a>.</p>
389<div class="fragment"><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;{</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; std::unique_lock&lt;std::mutex&gt; availableListLock(m_AvailableMutex, std::defer_lock);</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; packetBuffer-&gt;Release();</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; availableListLock.lock();</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; m_AvailableList.push_back(std::move(packetBuffer));</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; availableListLock.unlock();</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;}</div></div><!-- fragment -->
390</div>
391</div>
392<a id="ac3f43b4dd3fafd6b13342acc2263bbb4"></a>
393<h2 class="memtitle"><span class="permalink"><a href="#ac3f43b4dd3fafd6b13342acc2263bbb4">&#9670;&nbsp;</a></span>Reserve()</h2>
394
395<div class="memitem">
396<div class="memproto">
397<table class="mlabels">
398 <tr>
399 <td class="mlabels-left">
400 <table class="memname">
401 <tr>
402 <td class="memname"><a class="el" href="namespacearmnn_1_1profiling.xhtml#a14328d977cec3abadcfd5935f04f3409">IPacketBufferPtr</a> Reserve </td>
403 <td>(</td>
404 <td class="paramtype">unsigned int&#160;</td>
405 <td class="paramname"><em>requestedSize</em>, </td>
406 </tr>
407 <tr>
408 <td class="paramkey"></td>
409 <td></td>
410 <td class="paramtype">unsigned int &amp;&#160;</td>
411 <td class="paramname"><em>reservedSize</em>&#160;</td>
412 </tr>
413 <tr>
414 <td></td>
415 <td>)</td>
416 <td></td><td></td>
417 </tr>
418 </table>
419 </td>
420 <td class="mlabels-right">
421<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
422 </tr>
423</table>
424</div><div class="memdoc">
425
426<p>Implements <a class="el" href="classarmnn_1_1profiling_1_1_i_buffer_manager.xhtml#a49c88b0e052621f30462c3bdbf3e4a7a">IBufferManager</a>.</p>
427
428<p class="definition">Definition at line <a class="el" href="_buffer_manager_8cpp_source.xhtml#l00022">22</a> of file <a class="el" href="_buffer_manager_8cpp_source.xhtml">BufferManager.cpp</a>.</p>
429
430<p class="reference">Referenced by <a class="el" href="_buffer_tests_8cpp_source.xhtml#l00116">BOOST_AUTO_TEST_CASE()</a>, and <a class="el" href="_buffer_manager_8hpp_source.xhtml#l00026">BufferManager::~BufferManager()</a>.</p>
431<div class="fragment"><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;{</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; reservedSize = 0;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; std::unique_lock&lt;std::mutex&gt; availableListLock(m_AvailableMutex, std::defer_lock);</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keywordflow">if</span> (requestedSize &gt; m_MaxBufferSize)</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="keywordflow">return</span> <span class="keyword">nullptr</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; availableListLock.lock();</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keywordflow">if</span> (m_AvailableList.empty())</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; availableListLock.unlock();</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keywordflow">return</span> <span class="keyword">nullptr</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; <a class="code" href="namespacearmnn_1_1profiling.xhtml#a14328d977cec3abadcfd5935f04f3409">IPacketBufferPtr</a> buffer = std::move(m_AvailableList.back());</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; m_AvailableList.pop_back();</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; availableListLock.unlock();</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; reservedSize = requestedSize;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keywordflow">return</span> buffer;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;}</div><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>
432</div><!-- fragment -->
433</div>
434</div>
435<a id="a372de693ad40b3f42839c8ec6ac845f4"></a>
436<h2 class="memtitle"><span class="permalink"><a href="#a372de693ad40b3f42839c8ec6ac845f4">&#9670;&nbsp;</a></span>Reset()</h2>
437
438<div class="memitem">
439<div class="memproto">
440 <table class="memname">
441 <tr>
442 <td class="memname">void Reset </td>
443 <td>(</td>
444 <td class="paramname"></td><td>)</td>
445 <td></td>
446 </tr>
447 </table>
448</div><div class="memdoc">
449
450<p class="definition">Definition at line <a class="el" href="_buffer_manager_8cpp_source.xhtml#l00077">77</a> of file <a class="el" href="_buffer_manager_8cpp_source.xhtml">BufferManager.cpp</a>.</p>
451
452<p class="reference">Referenced by <a class="el" href="_profiling_service_8cpp_source.xhtml#l00296">ProfilingService::GetSendTimelinePacket()</a>, and <a class="el" href="_buffer_manager_8hpp_source.xhtml#l00026">BufferManager::~BufferManager()</a>.</p>
453<div class="fragment"><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;{</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="comment">//This method should only be called once all threads have been joined</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; std::lock_guard&lt;std::mutex&gt; readableListLock(m_ReadableMutex);</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; std::lock_guard&lt;std::mutex&gt; availableListLock(m_AvailableMutex);</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; m_AvailableList.clear();</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; m_ReadableList.clear();</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <a class="code" href="namespacearmnn_utils_1_1_sockets.xhtml#a248c764067ee60c03ee370784c49f353">Initialize</a>();</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;}</div><div class="ttc" id="namespacearmnn_utils_1_1_sockets_xhtml_a248c764067ee60c03ee370784c49f353"><div class="ttname"><a href="namespacearmnn_utils_1_1_sockets.xhtml#a248c764067ee60c03ee370784c49f353">armnnUtils::Sockets::Initialize</a></div><div class="ttdeci">bool Initialize()</div><div class="ttdoc">Performs any required one-time setup. </div><div class="ttdef"><b>Definition:</b> <a href="_network_sockets_8cpp_source.xhtml#l00018">NetworkSockets.cpp:18</a></div></div>
454</div><!-- fragment -->
455</div>
456</div>
457<a id="ad675ff4e9053375bd41d0aad6b3bbb63"></a>
458<h2 class="memtitle"><span class="permalink"><a href="#ad675ff4e9053375bd41d0aad6b3bbb63">&#9670;&nbsp;</a></span>SetConsumer()</h2>
459
460<div class="memitem">
461<div class="memproto">
462<table class="mlabels">
463 <tr>
464 <td class="mlabels-left">
465 <table class="memname">
466 <tr>
467 <td class="memname">void SetConsumer </td>
468 <td>(</td>
469 <td class="paramtype"><a class="el" href="classarmnn_1_1profiling_1_1_i_consumer.xhtml">IConsumer</a> *&#160;</td>
470 <td class="paramname"><em>consumer</em></td><td>)</td>
471 <td></td>
472 </tr>
473 </table>
474 </td>
475 <td class="mlabels-right">
476<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
477 </tr>
478</table>
479</div><div class="memdoc">
480
481<p>Set Consumer on the buffer manager to be notified when there is a Commit Can only be one consumer. </p>
482
483<p>Implements <a class="el" href="classarmnn_1_1profiling_1_1_i_buffer_manager.xhtml#a2d5f60e55b59ae8667ff593b5bfc5deb">IBufferManager</a>.</p>
484
485<p class="definition">Definition at line <a class="el" href="_buffer_manager_8cpp_source.xhtml#l00111">111</a> of file <a class="el" href="_buffer_manager_8cpp_source.xhtml">BufferManager.cpp</a>.</p>
486
487<p class="reference">Referenced by <a class="el" href="_buffer_manager_8hpp_source.xhtml#l00026">BufferManager::~BufferManager()</a>.</p>
488<div class="fragment"><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;{</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; m_Consumer = consumer;</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;}</div></div><!-- fragment -->
489</div>
490</div>
491<hr/>The documentation for this class was generated from the following files:<ul>
492<li>src/profiling/<a class="el" href="_buffer_manager_8hpp_source.xhtml">BufferManager.hpp</a></li>
493<li>src/profiling/<a class="el" href="_buffer_manager_8cpp_source.xhtml">BufferManager.cpp</a></li>
494</ul>
495</div><!-- contents -->
496</div><!-- doc-content -->
497<!-- start footer part -->
498<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
499 <ul>
500 <li class="navelem"><a class="el" href="namespacearmnn.xhtml">armnn</a></li><li class="navelem"><a class="el" href="namespacearmnn_1_1profiling.xhtml">profiling</a></li><li class="navelem"><a class="el" href="classarmnn_1_1profiling_1_1_buffer_manager.xhtml">BufferManager</a></li>
501 <li class="footer">Generated on Fri Mar 13 2020 16:09:20 for ArmNN by
502 <a href="http://www.doxygen.org/index.html">
503 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
504 </ul>
505</div>
506</body>
507</html>