IVGCVSW-3726 Upload ArmNN Doxygen files
* Upload current ArmNN Doxygen files
Signed-off-by: Ryan OShea <Ryan.OShea2@arm.com>
Change-Id: I8989ed16ee40a99a4495b100bd009cf3e24a7285
diff --git a/Documentation/_buffer_manager_8hpp_source.html b/Documentation/_buffer_manager_8hpp_source.html
new file mode 100644
index 0000000..36c3e5d
--- /dev/null
+++ b/Documentation/_buffer_manager_8hpp_source.html
@@ -0,0 +1,116 @@
+<!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="viewport" content="width=device-width, initial-scale=1"/>
+<title>ArmNN: src/profiling/BufferManager.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>
+<link href="doxygen.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;">
+ <td id="projectalign" style="padding-left: 0.5em;">
+ <div id="projectname">ArmNN
+  <span id="projectnumber">NotReleased</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('_buffer_manager_8hpp_source.html','');});
+</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">BufferManager.hpp</div> </div>
+</div><!--header-->
+<div class="contents">
+<a href="_buffer_manager_8hpp.html">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 "<a class="code" href="_i_buffer_manager_8hpp.html">IBufferManager.hpp</a>"</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include "<a class="code" href="_i_consumer_8hpp.html">IConsumer.hpp</a>"</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include <condition_variable></span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include <mutex></span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <vector></span></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> <span class="keyword">namespace </span><a class="code" href="namespacearmnn.html">armnn</a></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> {</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> <span class="keyword">namespace </span>profiling</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> {</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="classarmnn_1_1profiling_1_1_buffer_manager.html"> 21</a></span> <span class="keyword">class </span><a class="code" href="classarmnn_1_1profiling_1_1_buffer_manager.html">BufferManager</a> : <span class="keyword">public</span> <a class="code" href="classarmnn_1_1profiling_1_1_i_buffer_manager.html">IBufferManager</a></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> {</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <a class="code" href="classarmnn_1_1profiling_1_1_buffer_manager.html#a0aee89a45e5c21933b2f16b46bec25e3">BufferManager</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> numberOfBuffers = 5, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> maxPacketSize = 4096);</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="classarmnn_1_1profiling_1_1_buffer_manager.html#a8224229b6953f986d6fb2d4d00fe6ee2"> 26</a></span>  <a class="code" href="classarmnn_1_1profiling_1_1_buffer_manager.html#a8224229b6953f986d6fb2d4d00fe6ee2">~BufferManager</a>() {}</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <a class="code" href="namespacearmnn_1_1profiling.html#a14328d977cec3abadcfd5935f04f3409">IPacketBufferPtr</a> <a class="code" href="classarmnn_1_1profiling_1_1_buffer_manager.html#ac3f43b4dd3fafd6b13342acc2263bbb4">Reserve</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> requestedSize, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>& reservedSize) <span class="keyword">override</span>;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1profiling_1_1_buffer_manager.html#a372de693ad40b3f42839c8ec6ac845f4">Reset</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="keywordtype">void</span> <a class="code" href="classarmnn_1_1profiling_1_1_buffer_manager.html#a183eaa37ccd326bd82179bed901c7122">Commit</a>(<a class="code" href="namespacearmnn_1_1profiling.html#a14328d977cec3abadcfd5935f04f3409">IPacketBufferPtr</a>& packetBuffer, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size, <span class="keywordtype">bool</span> notifyConsumer = <span class="keyword">true</span>) <span class="keyword">override</span>;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1profiling_1_1_buffer_manager.html#a226108649851aa1b1a8168560c5228b5">Release</a>(<a class="code" href="namespacearmnn_1_1profiling.html#a14328d977cec3abadcfd5935f04f3409">IPacketBufferPtr</a>& packetBuffer) <span class="keyword">override</span>;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <a class="code" href="namespacearmnn_1_1profiling.html#a14328d977cec3abadcfd5935f04f3409">IPacketBufferPtr</a> <a class="code" href="classarmnn_1_1profiling_1_1_buffer_manager.html#abce8709dc1b666a26f427ba7ff08b737">GetReadableBuffer</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1profiling_1_1_buffer_manager.html#ae717263b3243e9f88f4caea6d31b0652">MarkRead</a>(<a class="code" href="namespacearmnn_1_1profiling.html#a14328d977cec3abadcfd5935f04f3409">IPacketBufferPtr</a>& packetBuffer) <span class="keyword">override</span>;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1profiling_1_1_buffer_manager.html#ad675ff4e9053375bd41d0aad6b3bbb63">SetConsumer</a>(<a class="code" href="classarmnn_1_1profiling_1_1_i_consumer.html">IConsumer</a>* consumer) <span class="keyword">override</span>;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1profiling_1_1_buffer_manager.html#af22fdc7450c285c4d7449425c8fe994f">FlushReadList</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordtype">void</span> Initialize();</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="comment">// Maximum buffer size</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> m_MaxBufferSize;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="comment">// Number of buffers</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> m_NumberOfBuffers;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="comment">// List of available packet buffers</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  std::vector<IPacketBufferPtr> m_AvailableList;</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>  <span class="comment">// List of readable packet buffers</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  std::vector<IPacketBufferPtr> m_ReadableList;</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">// Mutex for available packet buffer list</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  std::mutex m_AvailableMutex;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="comment">// Mutex for readable packet buffer list</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  std::mutex m_ReadableMutex;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="comment">// Consumer thread to notify packet is ready to read</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <a class="code" href="classarmnn_1_1profiling_1_1_i_consumer.html">IConsumer</a>* m_Consumer = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> };</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> } <span class="comment">// namespace profiling</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> } <span class="comment">// namespace armnn</span></div><div class="ttc" id="classarmnn_1_1profiling_1_1_buffer_manager_html_ac3f43b4dd3fafd6b13342acc2263bbb4"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_buffer_manager.html#ac3f43b4dd3fafd6b13342acc2263bbb4">armnn::profiling::BufferManager::Reserve</a></div><div class="ttdeci">IPacketBufferPtr Reserve(unsigned int requestedSize, unsigned int &reservedSize) override</div><div class="ttdef"><b>Definition:</b> <a href="_buffer_manager_8cpp_source.html#l00022">BufferManager.cpp:22</a></div></div>
+<div class="ttc" id="namespacearmnn_1_1profiling_html_a14328d977cec3abadcfd5935f04f3409"><div class="ttname"><a href="namespacearmnn_1_1profiling.html#a14328d977cec3abadcfd5935f04f3409">armnn::profiling::IPacketBufferPtr</a></div><div class="ttdeci">std::unique_ptr< IPacketBuffer > IPacketBufferPtr</div><div class="ttdef"><b>Definition:</b> <a href="_i_packet_buffer_8hpp_source.html#l00040">IPacketBuffer.hpp:40</a></div></div>
+<div class="ttc" id="classarmnn_1_1profiling_1_1_buffer_manager_html_a183eaa37ccd326bd82179bed901c7122"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_buffer_manager.html#a183eaa37ccd326bd82179bed901c7122">armnn::profiling::BufferManager::Commit</a></div><div class="ttdeci">void Commit(IPacketBufferPtr &packetBuffer, unsigned int size, bool notifyConsumer=true) override</div><div class="ttdef"><b>Definition:</b> <a href="_buffer_manager_8cpp_source.html#l00043">BufferManager.cpp:43</a></div></div>
+<div class="ttc" id="classarmnn_1_1profiling_1_1_buffer_manager_html_a8224229b6953f986d6fb2d4d00fe6ee2"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_buffer_manager.html#a8224229b6953f986d6fb2d4d00fe6ee2">armnn::profiling::BufferManager::~BufferManager</a></div><div class="ttdeci">~BufferManager()</div><div class="ttdef"><b>Definition:</b> <a href="_buffer_manager_8hpp_source.html#l00026">BufferManager.hpp:26</a></div></div>
+<div class="ttc" id="_i_buffer_manager_8hpp_html"><div class="ttname"><a href="_i_buffer_manager_8hpp.html">IBufferManager.hpp</a></div></div>
+<div class="ttc" id="classarmnn_1_1profiling_1_1_buffer_manager_html_ad675ff4e9053375bd41d0aad6b3bbb63"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_buffer_manager.html#ad675ff4e9053375bd41d0aad6b3bbb63">armnn::profiling::BufferManager::SetConsumer</a></div><div class="ttdeci">void SetConsumer(IConsumer *consumer) override</div><div class="ttdef"><b>Definition:</b> <a href="_buffer_manager_8cpp_source.html#l00111">BufferManager.cpp:111</a></div></div>
+<div class="ttc" id="classarmnn_1_1profiling_1_1_buffer_manager_html_abce8709dc1b666a26f427ba7ff08b737"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_buffer_manager.html#abce8709dc1b666a26f427ba7ff08b737">armnn::profiling::BufferManager::GetReadableBuffer</a></div><div class="ttdeci">IPacketBufferPtr GetReadableBuffer() override</div><div class="ttdef"><b>Definition:</b> <a href="_buffer_manager_8cpp_source.html#l00089">BufferManager.cpp:89</a></div></div>
+<div class="ttc" id="classarmnn_1_1profiling_1_1_buffer_manager_html_a0aee89a45e5c21933b2f16b46bec25e3"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_buffer_manager.html#a0aee89a45e5c21933b2f16b46bec25e3">armnn::profiling::BufferManager::BufferManager</a></div><div class="ttdeci">BufferManager(unsigned int numberOfBuffers=5, unsigned int maxPacketSize=4096)</div><div class="ttdef"><b>Definition:</b> <a href="_buffer_manager_8cpp_source.html#l00015">BufferManager.cpp:15</a></div></div>
+<div class="ttc" id="_i_consumer_8hpp_html"><div class="ttname"><a href="_i_consumer_8hpp.html">IConsumer.hpp</a></div></div>
+<div class="ttc" id="classarmnn_1_1profiling_1_1_buffer_manager_html_af22fdc7450c285c4d7449425c8fe994f"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_buffer_manager.html#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.html#l00116">BufferManager.cpp:116</a></div></div>
+<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>
+<div class="ttc" id="classarmnn_1_1profiling_1_1_buffer_manager_html_ae717263b3243e9f88f4caea6d31b0652"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_buffer_manager.html#ae717263b3243e9f88f4caea6d31b0652">armnn::profiling::BufferManager::MarkRead</a></div><div class="ttdeci">void MarkRead(IPacketBufferPtr &packetBuffer) override</div><div class="ttdef"><b>Definition:</b> <a href="_buffer_manager_8cpp_source.html#l00102">BufferManager.cpp:102</a></div></div>
+<div class="ttc" id="classarmnn_1_1profiling_1_1_buffer_manager_html"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_buffer_manager.html">armnn::profiling::BufferManager</a></div><div class="ttdef"><b>Definition:</b> <a href="_buffer_manager_8hpp_source.html#l00021">BufferManager.hpp:21</a></div></div>
+<div class="ttc" id="classarmnn_1_1profiling_1_1_i_buffer_manager_html"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_i_buffer_manager.html">armnn::profiling::IBufferManager</a></div><div class="ttdef"><b>Definition:</b> <a href="_i_buffer_manager_8hpp_source.html#l00021">IBufferManager.hpp:21</a></div></div>
+<div class="ttc" id="classarmnn_1_1profiling_1_1_buffer_manager_html_a226108649851aa1b1a8168560c5228b5"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_buffer_manager.html#a226108649851aa1b1a8168560c5228b5">armnn::profiling::BufferManager::Release</a></div><div class="ttdeci">void Release(IPacketBufferPtr &packetBuffer) override</div><div class="ttdef"><b>Definition:</b> <a href="_buffer_manager_8cpp_source.html#l00068">BufferManager.cpp:68</a></div></div>
+<div class="ttc" id="classarmnn_1_1profiling_1_1_buffer_manager_html_a372de693ad40b3f42839c8ec6ac845f4"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_buffer_manager.html#a372de693ad40b3f42839c8ec6ac845f4">armnn::profiling::BufferManager::Reset</a></div><div class="ttdeci">void Reset()</div><div class="ttdef"><b>Definition:</b> <a href="_buffer_manager_8cpp_source.html#l00077">BufferManager.cpp:77</a></div></div>
+<div class="ttc" id="classarmnn_1_1profiling_1_1_i_consumer_html"><div class="ttname"><a href="classarmnn_1_1profiling_1_1_i_consumer.html">armnn::profiling::IConsumer</a></div><div class="ttdef"><b>Definition:</b> <a href="_i_consumer_8hpp_source.html#l00014">IConsumer.hpp:14</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.html">src</a></li><li class="navelem"><a class="el" href="dir_637c692f14729569dd2eac0c18e2a54a.html">profiling</a></li><li class="navelem"><a class="el" href="_buffer_manager_8hpp.html">BufferManager.hpp</a></li>
+ <li class="footer">Generated on Fri Mar 13 2020 16:06:58 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>