diff options
author | Nikhil Raj <nikhil.raj@arm.com> | 2022-03-08 20:01:38 +0000 |
---|---|---|
committer | Nikhil Raj <nikhil.raj@arm.com> | 2022-03-09 12:26:14 +0000 |
commit | f4019872c1134c6fcc1d6993e5746f55c1e79208 (patch) | |
tree | b07ea8bdd70d696adfa3814344e210ea67be1e8c /22.02/classarmnn_1_1experimental_1_1_threadpool.xhtml | |
parent | 0d75c02b21b919b81035205f3914ee273b93b30c (diff) | |
download | armnn-f4019872c1134c6fcc1d6993e5746f55c1e79208.tar.gz |
IVGCVSW-6819 Fix the directory structure and broken link to latest docu
Signed-off-by: Nikhil Raj <nikhil.raj@arm.com>
Change-Id: I05b559d15faf92c76ff536719693b361316be4f3
Diffstat (limited to '22.02/classarmnn_1_1experimental_1_1_threadpool.xhtml')
-rw-r--r-- | 22.02/classarmnn_1_1experimental_1_1_threadpool.xhtml | 349 |
1 files changed, 349 insertions, 0 deletions
diff --git a/22.02/classarmnn_1_1experimental_1_1_threadpool.xhtml b/22.02/classarmnn_1_1experimental_1_1_threadpool.xhtml new file mode 100644 index 0000000000..72a5f622d0 --- /dev/null +++ b/22.02/classarmnn_1_1experimental_1_1_threadpool.xhtml @@ -0,0 +1,349 @@ +<!-- Copyright (c) 2020 ARM Limited. --> +<!-- --> +<!-- SPDX-License-Identifier: MIT --> +<!-- --> +<!-- HTML header for doxygen 1.8.13--> +<!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="robots" content="NOINDEX, NOFOLLOW" /> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>ArmNN: Threadpool Class Reference</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> +<script type="text/x-mathjax-config"> + MathJax.Hub.Config({ + extensions: ["tex2jax.js"], + jax: ["input/TeX","output/HTML-CSS"], +}); +</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +<link href="stylesheet.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;"> + <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/> + <td style="padding-left: 0.5em;"> + <div id="projectname"> +  <span id="projectnumber">22.02</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('classarmnn_1_1experimental_1_1_threadpool.xhtml','');}); +</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="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="classarmnn_1_1experimental_1_1_threadpool-members.xhtml">List of all members</a> </div> + <div class="headertitle"> +<div class="title">Threadpool Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="_threadpool_8hpp_source.xhtml">Threadpool.hpp</a>></code></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:a22944b5254612236c06e24865262e1d5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1experimental_1_1_threadpool.xhtml#a22944b5254612236c06e24865262e1d5">Threadpool</a> (std::size_t numThreads, <a class="el" href="classarmnn_1_1_i_runtime.xhtml">IRuntime</a> *runtimePtr, std::vector< std::shared_ptr< <a class="el" href="classarmnn_1_1experimental_1_1_i_working_mem_handle.xhtml">IWorkingMemHandle</a> >> memHandles)</td></tr> +<tr class="separator:a22944b5254612236c06e24865262e1d5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a10680e8013c90b056416dd4643c4d9bd"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1experimental_1_1_threadpool.xhtml#a10680e8013c90b056416dd4643c4d9bd">~Threadpool</a> ()</td></tr> +<tr class="separator:a10680e8013c90b056416dd4643c4d9bd"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac54bebf6abec4a11e033d703f6441df8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1experimental_1_1_threadpool.xhtml#ac54bebf6abec4a11e033d703f6441df8">LoadMemHandles</a> (std::vector< std::shared_ptr< <a class="el" href="classarmnn_1_1experimental_1_1_i_working_mem_handle.xhtml">IWorkingMemHandle</a> >> memHandles)</td></tr> +<tr class="separator:ac54bebf6abec4a11e033d703f6441df8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a11f8027065067f9f77f54fe2400479d2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1experimental_1_1_threadpool.xhtml#a11f8027065067f9f77f54fe2400479d2">UnloadMemHandles</a> (<a class="el" href="namespacearmnn.xhtml#a0d8160388a127c1a23b37bc88dc6e2ec">NetworkId</a> networkId)</td></tr> +<tr class="separator:a11f8027065067f9f77f54fe2400479d2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab38a8efb11e2dfeeb5a3709644985748"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1experimental_1_1_threadpool.xhtml#ab38a8efb11e2dfeeb5a3709644985748">Schedule</a> (<a class="el" href="namespacearmnn.xhtml#a0d8160388a127c1a23b37bc88dc6e2ec">NetworkId</a> networkId, const <a class="el" href="namespacearmnn.xhtml#aa01bce88f89975a5a031db4cc8861527">InputTensors</a> &inputTensors, const <a class="el" href="namespacearmnn.xhtml#a8f091a512915d1cb29a4ebf13dfc53ea">OutputTensors</a> &outputTensors, const <a class="el" href="namespacearmnn.xhtml#a8e72227ebe5ac505cf44790f2e6eb488">QosExecPriority</a> priority, std::shared_ptr< <a class="el" href="classarmnn_1_1experimental_1_1_i_async_execution_callback.xhtml">IAsyncExecutionCallback</a> > cb)</td></tr> +<tr class="memdesc:ab38a8efb11e2dfeeb5a3709644985748"><td class="mdescLeft"> </td><td class="mdescRight">Schedule an asynchronous execution on the loaded network. <a href="#ab38a8efb11e2dfeeb5a3709644985748">More...</a><br /></td></tr> +<tr class="separator:ab38a8efb11e2dfeeb5a3709644985748"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3be6ab6132ee76b0b36149f70f842f61"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1experimental_1_1_threadpool.xhtml#a3be6ab6132ee76b0b36149f70f842f61">TerminateThreadPool</a> () noexcept</td></tr> +<tr class="separator:a3be6ab6132ee76b0b36149f70f842f61"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"> +<p class="definition">Definition at line <a class="el" href="_threadpool_8hpp_source.xhtml#l00024">24</a> of file <a class="el" href="_threadpool_8hpp_source.xhtml">Threadpool.hpp</a>.</p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="a22944b5254612236c06e24865262e1d5"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a22944b5254612236c06e24865262e1d5">◆ </a></span>Threadpool()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classarmnn_1_1experimental_1_1_threadpool.xhtml">Threadpool</a> </td> + <td>(</td> + <td class="paramtype">std::size_t </td> + <td class="paramname"><em>numThreads</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classarmnn_1_1_i_runtime.xhtml">IRuntime</a> * </td> + <td class="paramname"><em>runtimePtr</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">std::vector< std::shared_ptr< <a class="el" href="classarmnn_1_1experimental_1_1_i_working_mem_handle.xhtml">IWorkingMemHandle</a> >> </td> + <td class="paramname"><em>memHandles</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_threadpool_8cpp_source.xhtml#l00016">16</a> of file <a class="el" href="_threadpool_8cpp_source.xhtml">Threadpool.cpp</a>.</p> + +<p class="reference">References <a class="el" href="_threadpool_8cpp_source.xhtml#l00029">Threadpool::LoadMemHandles()</a>.</p> +<div class="fragment"><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  : m_RuntimePtr(runtimePtr)</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>  <span class="keywordflow">for</span> (<span class="keyword">auto</span> i = 0u; i < numThreads; ++i)</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>  m_Threads.emplace_back(std::make_unique<std::thread>(&Threadpool::ProcessExecPriorities, <span class="keyword">this</span>, i));</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  }</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <a class="code" href="classarmnn_1_1experimental_1_1_threadpool.xhtml#ac54bebf6abec4a11e033d703f6441df8">LoadMemHandles</a>(memHandles);</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> }</div><div class="ttc" id="classarmnn_1_1experimental_1_1_threadpool_xhtml_ac54bebf6abec4a11e033d703f6441df8"><div class="ttname"><a href="classarmnn_1_1experimental_1_1_threadpool.xhtml#ac54bebf6abec4a11e033d703f6441df8">armnn::experimental::Threadpool::LoadMemHandles</a></div><div class="ttdeci">void LoadMemHandles(std::vector< std::shared_ptr< IWorkingMemHandle >> memHandles)</div><div class="ttdef"><b>Definition:</b> <a href="_threadpool_8cpp_source.xhtml#l00029">Threadpool.cpp:29</a></div></div> +</div><!-- fragment --> +</div> +</div> +<a id="a10680e8013c90b056416dd4643c4d9bd"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a10680e8013c90b056416dd4643c4d9bd">◆ </a></span>~Threadpool()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">~<a class="el" href="classarmnn_1_1experimental_1_1_threadpool.xhtml">Threadpool</a> </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_threadpool_8hpp_source.xhtml#l00031">31</a> of file <a class="el" href="_threadpool_8hpp_source.xhtml">Threadpool.hpp</a>.</p> + +<p class="reference">References <a class="el" href="_threadpool_8cpp_source.xhtml#l00029">Threadpool::LoadMemHandles()</a>, <a class="el" href="_threadpool_8cpp_source.xhtml#l00069">Threadpool::Schedule()</a>, <a class="el" href="_threadpool_8cpp_source.xhtml#l00102">Threadpool::TerminateThreadPool()</a>, and <a class="el" href="_threadpool_8cpp_source.xhtml#l00057">Threadpool::UnloadMemHandles()</a>.</p> +<div class="fragment"><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <a class="code" href="classarmnn_1_1experimental_1_1_threadpool.xhtml#a3be6ab6132ee76b0b36149f70f842f61">TerminateThreadPool</a>();</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  }</div><div class="ttc" id="classarmnn_1_1experimental_1_1_threadpool_xhtml_a3be6ab6132ee76b0b36149f70f842f61"><div class="ttname"><a href="classarmnn_1_1experimental_1_1_threadpool.xhtml#a3be6ab6132ee76b0b36149f70f842f61">armnn::experimental::Threadpool::TerminateThreadPool</a></div><div class="ttdeci">void TerminateThreadPool() noexcept</div><div class="ttdef"><b>Definition:</b> <a href="_threadpool_8cpp_source.xhtml#l00102">Threadpool.cpp:102</a></div></div> +</div><!-- fragment --> +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="ac54bebf6abec4a11e033d703f6441df8"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ac54bebf6abec4a11e033d703f6441df8">◆ </a></span>LoadMemHandles()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void LoadMemHandles </td> + <td>(</td> + <td class="paramtype">std::vector< std::shared_ptr< <a class="el" href="classarmnn_1_1experimental_1_1_i_working_mem_handle.xhtml">IWorkingMemHandle</a> >> </td> + <td class="paramname"><em>memHandles</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_threadpool_8cpp_source.xhtml#l00029">29</a> of file <a class="el" href="_threadpool_8cpp_source.xhtml">Threadpool.cpp</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_threadpool_8cpp_source.xhtml#l00016">Threadpool::Threadpool()</a>, and <a class="el" href="_threadpool_8hpp_source.xhtml#l00031">Threadpool::~Threadpool()</a>.</p> +<div class="fragment"><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keywordflow">if</span> (memHandles.size() == 0)</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keywordflow">throw</span> <a class="code" href="classarmnn_1_1_runtime_exception.xhtml">armnn::RuntimeException</a>(<span class="stringliteral">"Threadpool::UnloadMemHandles: Size of memHandles vector must be greater than 0"</span>);</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</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>  <span class="keywordflow">if</span> (memHandles.size() != m_Threads.size())</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="keywordflow">throw</span> <a class="code" href="classarmnn_1_1_runtime_exception.xhtml">armnn::RuntimeException</a>(</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="stringliteral">"Threadpool::UnloadMemHandles: Size of memHandles vector must match the number of threads"</span>);</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  }</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <a class="code" href="namespacearmnn.xhtml#a0d8160388a127c1a23b37bc88dc6e2ec">NetworkId</a> networkId = memHandles[0]->GetNetworkId();</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordflow">for</span> (uint32_t i = 1; i < memHandles.size(); ++i)</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  {</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordflow">if</span> (networkId != memHandles[i]->GetNetworkId())</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="keywordflow">throw</span> <a class="code" href="classarmnn_1_1_runtime_exception.xhtml">armnn::RuntimeException</a>(</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="stringliteral">"Threadpool::UnloadMemHandles: All network ids must be identical in memHandles"</span>);</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>  }</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  std::pair<NetworkId, std::vector<std::shared_ptr<IWorkingMemHandle>>> pair {networkId, memHandles};</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  m_WorkingMemHandleMap.insert(pair);</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> }</div><div class="ttc" id="namespacearmnn_xhtml_a0d8160388a127c1a23b37bc88dc6e2ec"><div class="ttname"><a href="namespacearmnn.xhtml#a0d8160388a127c1a23b37bc88dc6e2ec">armnn::NetworkId</a></div><div class="ttdeci">int NetworkId</div><div class="ttdef"><b>Definition:</b> <a href="_i_runtime_8hpp_source.xhtml#l00025">IRuntime.hpp:25</a></div></div> +<div class="ttc" id="classarmnn_1_1_runtime_exception_xhtml"><div class="ttname"><a href="classarmnn_1_1_runtime_exception.xhtml">armnn::RuntimeException</a></div><div class="ttdef"><b>Definition:</b> <a href="_exceptions_8hpp_source.xhtml#l00120">Exceptions.hpp:120</a></div></div> +</div><!-- fragment --> +</div> +</div> +<a id="ab38a8efb11e2dfeeb5a3709644985748"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ab38a8efb11e2dfeeb5a3709644985748">◆ </a></span>Schedule()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void Schedule </td> + <td>(</td> + <td class="paramtype"><a class="el" href="namespacearmnn.xhtml#a0d8160388a127c1a23b37bc88dc6e2ec">NetworkId</a> </td> + <td class="paramname"><em>networkId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="namespacearmnn.xhtml#aa01bce88f89975a5a031db4cc8861527">InputTensors</a> & </td> + <td class="paramname"><em>inputTensors</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="namespacearmnn.xhtml#a8f091a512915d1cb29a4ebf13dfc53ea">OutputTensors</a> & </td> + <td class="paramname"><em>outputTensors</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="namespacearmnn.xhtml#a8e72227ebe5ac505cf44790f2e6eb488">QosExecPriority</a> </td> + <td class="paramname"><em>priority</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">std::shared_ptr< <a class="el" href="classarmnn_1_1experimental_1_1_i_async_execution_callback.xhtml">IAsyncExecutionCallback</a> > </td> + <td class="paramname"><em>cb</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Schedule an asynchronous execution on the loaded network. </p> + +<p class="definition">Definition at line <a class="el" href="_threadpool_8cpp_source.xhtml#l00069">69</a> of file <a class="el" href="_threadpool_8cpp_source.xhtml">Threadpool.cpp</a>.</p> + +<p class="reference">References <a class="el" href="namespacearmnn.xhtml#a8e72227ebe5ac505cf44790f2e6eb488a655d20c1ca69519ca647684edbb2db35">armnn::High</a>, <a class="el" href="namespacearmnn.xhtml#a8e72227ebe5ac505cf44790f2e6eb488a28d0edd045e05cf5af64e35ae0c4c6ef">armnn::Low</a>, and <a class="el" href="namespacearmnn.xhtml#a8e72227ebe5ac505cf44790f2e6eb488a87f8a6ab85c9ced3702b4ea641ad4bb5">armnn::Medium</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_threadpool_8hpp_source.xhtml#l00031">Threadpool::~Threadpool()</a>.</p> +<div class="fragment"><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> {</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordflow">if</span> (m_WorkingMemHandleMap.find(networkId) == m_WorkingMemHandleMap.end())</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  {</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordflow">throw</span> <a class="code" href="classarmnn_1_1_runtime_exception.xhtml">armnn::RuntimeException</a>(<span class="stringliteral">"Threadpool::UnloadMemHandles: Unknown NetworkId"</span>);</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  }</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="comment">// Group execution parameters so that they can be easily added to the queue</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  ExecutionTuple groupExecParams = std::make_tuple(networkId, inputTensors, outputTensors, cb);</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  std::shared_ptr<ExecutionTuple> operation = std::make_shared<ExecutionTuple>(groupExecParams);</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="comment">// Add a message to the queue and notify the request thread</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  std::unique_lock<std::mutex> lock(m_ThreadPoolMutex);</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordflow">switch</span> (priority)</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  {</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordflow">case</span> <a class="code" href="namespacearmnn.xhtml#a8e72227ebe5ac505cf44790f2e6eb488a655d20c1ca69519ca647684edbb2db35">QosExecPriority::High</a>:</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  m_HighPriorityQueue.push(operation);</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keywordflow">case</span> <a class="code" href="namespacearmnn.xhtml#a8e72227ebe5ac505cf44790f2e6eb488a28d0edd045e05cf5af64e35ae0c4c6ef">QosExecPriority::Low</a>:</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  m_LowPriorityQueue.push(operation);</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordflow">case</span> <a class="code" href="namespacearmnn.xhtml#a8e72227ebe5ac505cf44790f2e6eb488a87f8a6ab85c9ced3702b4ea641ad4bb5">QosExecPriority::Medium</a>:</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordflow">default</span>:</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  m_MediumPriorityQueue.push(operation);</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  }</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  m_ThreadPoolEvent.notify_one();</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> }</div><div class="ttc" id="classarmnn_1_1_runtime_exception_xhtml"><div class="ttname"><a href="classarmnn_1_1_runtime_exception.xhtml">armnn::RuntimeException</a></div><div class="ttdef"><b>Definition:</b> <a href="_exceptions_8hpp_source.xhtml#l00120">Exceptions.hpp:120</a></div></div> +<div class="ttc" id="namespacearmnn_xhtml_a8e72227ebe5ac505cf44790f2e6eb488a655d20c1ca69519ca647684edbb2db35"><div class="ttname"><a href="namespacearmnn.xhtml#a8e72227ebe5ac505cf44790f2e6eb488a655d20c1ca69519ca647684edbb2db35">armnn::QosExecPriority::High</a></div></div> +<div class="ttc" id="namespacearmnn_xhtml_a8e72227ebe5ac505cf44790f2e6eb488a28d0edd045e05cf5af64e35ae0c4c6ef"><div class="ttname"><a href="namespacearmnn.xhtml#a8e72227ebe5ac505cf44790f2e6eb488a28d0edd045e05cf5af64e35ae0c4c6ef">armnn::QosExecPriority::Low</a></div></div> +<div class="ttc" id="namespacearmnn_xhtml_a8e72227ebe5ac505cf44790f2e6eb488a87f8a6ab85c9ced3702b4ea641ad4bb5"><div class="ttname"><a href="namespacearmnn.xhtml#a8e72227ebe5ac505cf44790f2e6eb488a87f8a6ab85c9ced3702b4ea641ad4bb5">armnn::QosExecPriority::Medium</a></div></div> +</div><!-- fragment --> +</div> +</div> +<a id="a3be6ab6132ee76b0b36149f70f842f61"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a3be6ab6132ee76b0b36149f70f842f61">◆ </a></span>TerminateThreadPool()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">void TerminateThreadPool </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">noexcept</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_threadpool_8cpp_source.xhtml#l00102">102</a> of file <a class="el" href="_threadpool_8cpp_source.xhtml">Threadpool.cpp</a>.</p> + +<p class="reference">References <a class="el" href="_runtime_8cpp_source.xhtml#l00111">IRuntime::Execute()</a>, <a class="el" href="_types_8hpp_source.xhtml#l00024">armnn::EXPIRE_RATE</a>, <a class="el" href="namespacearmnn.xhtml#a67a0db04d321a74b7e7fcfd3f1a3f70bae139a585510a502bbf1841cf589f5086">armnn::Failure</a>, <a class="el" href="_timer_8hpp_source.xhtml#l00014">armnn::GetTimeNow()</a>, and <a class="el" href="namespacearmnn.xhtml#a67a0db04d321a74b7e7fcfd3f1a3f70ba505a83f220c02df2f85c3810cd9ceb38">armnn::Success</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_threadpool_8hpp_source.xhtml#l00031">Threadpool::~Threadpool()</a>.</p> +<div class="fragment"><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> {</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  {</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  std::unique_lock<std::mutex> threadPoolLock(m_ThreadPoolMutex);</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  m_TerminatePool = <span class="keyword">true</span>;</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  }</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> </div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  m_ThreadPoolEvent.notify_all();</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keywordflow">for</span> (<span class="keyword">auto</span> &thread : m_Threads)</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  {</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  thread->join();</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  }</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> }</div></div><!-- fragment --> +</div> +</div> +<a id="a11f8027065067f9f77f54fe2400479d2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a11f8027065067f9f77f54fe2400479d2">◆ </a></span>UnloadMemHandles()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void UnloadMemHandles </td> + <td>(</td> + <td class="paramtype"><a class="el" href="namespacearmnn.xhtml#a0d8160388a127c1a23b37bc88dc6e2ec">NetworkId</a> </td> + <td class="paramname"><em>networkId</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_threadpool_8cpp_source.xhtml#l00057">57</a> of file <a class="el" href="_threadpool_8cpp_source.xhtml">Threadpool.cpp</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_threadpool_8hpp_source.xhtml#l00031">Threadpool::~Threadpool()</a>.</p> +<div class="fragment"><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="keywordflow">if</span> (m_WorkingMemHandleMap.find(networkId) != m_WorkingMemHandleMap.end())</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>  m_WorkingMemHandleMap.erase(networkId);</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  }</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordflow">else</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  {</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordflow">throw</span> <a class="code" href="classarmnn_1_1_runtime_exception.xhtml">armnn::RuntimeException</a>(<span class="stringliteral">"Threadpool::UnloadMemHandles: Unknown NetworkId"</span>);</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> }</div><div class="ttc" id="classarmnn_1_1_runtime_exception_xhtml"><div class="ttname"><a href="classarmnn_1_1_runtime_exception.xhtml">armnn::RuntimeException</a></div><div class="ttdef"><b>Definition:</b> <a href="_exceptions_8hpp_source.xhtml#l00120">Exceptions.hpp:120</a></div></div> +</div><!-- fragment --> +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li>include/armnn/<a class="el" href="_threadpool_8hpp_source.xhtml">Threadpool.hpp</a></li> +<li>src/armnn/<a class="el" href="_threadpool_8cpp_source.xhtml">Threadpool.cpp</a></li> +</ul> +</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="namespacearmnn.xhtml">armnn</a></li><li class="navelem"><a class="el" href="namespacearmnn_1_1experimental.xhtml">experimental</a></li><li class="navelem"><a class="el" href="classarmnn_1_1experimental_1_1_threadpool.xhtml">Threadpool</a></li> + <li class="footer">Generated on Wed Mar 9 2022 12:01:24 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> |