Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / refs/heads/gh-pages / . / 24.02 / _execution_frame_8hpp_source.html
blob: fb4c45ecab7f72a87deb24733da24c80fbd3beb0 [file] [log] [blame]
Nikhil Raj38b600d2024-02-15 15:02:19 +0000[diff] [blame]1<!-- HTML header for doxygen 1.8.17-->
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml">
4<head>
5<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6<meta http-equiv="X-UA-Compatible" content="IE=9"/>
7<meta name="generator" content="Doxygen 1.8.17"/>
8<meta name="viewport" content="width=device-width, initial-scale=1"/>
9<title>Arm NN: src/armnn/ExecutionFrame.hpp Source File</title>
10<link href="tabs.css" rel="stylesheet" type="text/css"/>
11<script type="text/javascript" src="jquery.js"></script>
12<script type="text/javascript" src="dynsections.js"></script>
13<link href="navtree.css" rel="stylesheet" type="text/css"/>
14<script type="text/javascript" src="resize.js"></script>
15<script type="text/javascript" src="navtreedata.js"></script>
16<script type="text/javascript" src="navtree.js"></script>
17<link href="search/search.css" rel="stylesheet" type="text/css"/>
18<script type="text/javascript" src="search/searchdata.js"></script>
19<script type="text/javascript" src="search/search.js"></script>
20<script type="text/x-mathjax-config">
21 MathJax.Hub.Config({
22 extensions: ["tex2jax.js"],
23 jax: ["input/TeX","output/HTML-CSS"],
24});
25</script>
26<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
27<link href="doxygen.css" rel="stylesheet" type="text/css" />
28<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
29</head>
30<body>
31<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
32<div id="titlearea">
33<table cellspacing="0" cellpadding="0">
34 <tbody>
35 <tr style="height: 56px;">
36 <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 15rem; margin-top: .5rem; margin-left 13px"/>
37 <td id="projectalign" style="padding-left: 0.9em;">
38 <div id="projectname">
39 &#160;<span id="projectnumber">24.02</span>
40 </div>
41 </td>
42 </tr>
43 </tbody>
44</table>
45</div>
46<!-- end header part -->
47<!-- Generated by Doxygen 1.8.17 -->
48<script type="text/javascript">
49/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
50var searchBox = new SearchBox("searchBox", "search",false,'Search');
51/* @license-end */
52</script>
53<script type="text/javascript" src="menudata.js"></script>
54<script type="text/javascript" src="menu.js"></script>
55<script type="text/javascript">
56/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
57$(function() {
58 initMenu('',true,false,'search.php','Search');
59 $(document).ready(function() { init_search(); });
60});
61/* @license-end */</script>
62<div id="main-nav"></div>
63</div><!-- top -->
64<div id="side-nav" class="ui-resizable side-nav-resizable">
65 <div id="nav-tree">
66 <div id="nav-tree-contents">
67 <div id="nav-sync" class="sync"></div>
68 </div>
69 </div>
70 <div id="splitbar" style="-moz-user-select:none;"
71 class="ui-resizable-handle">
72 </div>
73</div>
74<script type="text/javascript">
75/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
76$(document).ready(function(){initNavTree('_execution_frame_8hpp_source.html',''); initResizable(); });
77/* @license-end */
78</script>
79<div id="doc-content">
80<!-- window showing the filter options -->
81<div id="MSearchSelectWindow"
82 onmouseover="return searchBox.OnSearchSelectShow()"
83 onmouseout="return searchBox.OnSearchSelectHide()"
84 onkeydown="return searchBox.OnSearchSelectKey(event)">
85</div>
86
87<!-- iframe showing the search results (closed by default) -->
88<div id="MSearchResultsWindow">
89<iframe src="javascript:void(0)" frameborder="0"
90 name="MSearchResults" id="MSearchResults">
91</iframe>
92</div>
93
94<div class="header">
95 <div class="headertitle">
96<div class="title">ExecutionFrame.hpp</div> </div>
97</div><!--header-->
98<div class="contents">
99<a href="_execution_frame_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>&#160;<span class="comment">//</span></div>
100<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// Copyright © 2019-2021,2023 Arm Ltd and Contributors. All rights reserved.</span></div>
101<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// SPDX-License-Identifier: MIT</span></div>
102<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">//</span></div>
103<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160; </div>
104<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#pragma once</span></div>
105<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160; </div>
106<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="_workload_8hpp.html">armnn/backends/Workload.hpp</a>&gt;</span></div>
107<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; </div>
108<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacearmnn.html">armnn</a></div>
109<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;{</div>
110<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; </div>
111<div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="namespacearmnn.html#a15f53f26b8495b51d0bba3d1bc4efc80"> 13</a></span>&#160;<span class="keyword">using</span> <a class="code" href="namespacearmnn.html#a15f53f26b8495b51d0bba3d1bc4efc80">WorkloadQueue</a> = std::vector&lt; std::unique_ptr&lt;IWorkload&gt; &gt;;</div>
112<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"></span> </div>
113<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">/// ExecutionFrame interface to enqueue a workload computation.</span></div>
114<div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="classarmnn_1_1_i_execution_frame.html"> 16</a></span>&#160;<span class="comment"></span><span class="keyword">class </span><a class="code" href="classarmnn_1_1_i_execution_frame.html">IExecutionFrame</a></div>
115<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;{</div>
116<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
117<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="keyword">public</span>:</div>
118<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="classarmnn_1_1_i_execution_frame.html#a1ca0125ac3082676dae03050a52e6068"> 20</a></span>&#160; <span class="keyword">virtual</span> <a class="code" href="classarmnn_1_1_i_execution_frame.html#a1ca0125ac3082676dae03050a52e6068">~IExecutionFrame</a>() {}</div>
119<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
120<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="keyword">virtual</span> <a class="code" href="classarmnn_1_1_i_execution_frame.html">IExecutionFrame</a>* <a class="code" href="classarmnn_1_1_i_execution_frame.html#a62a4e8e95f13a5b8fd62008423160362">ExecuteWorkloads</a>(<a class="code" href="classarmnn_1_1_i_execution_frame.html">IExecutionFrame</a>* previousFrame) = 0;</div>
121<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="classarmnn_1_1_i_execution_frame.html#ae8ab22492f0a5f78d5a2ab7e76486b5d"> 23</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1_i_execution_frame.html#ae8ab22492f0a5f78d5a2ab7e76486b5d">PostAllocationConfigure</a>() {};</div>
122<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="classarmnn_1_1_i_execution_frame.html#ab81312bd5e64cbae2803de9f243bdb32"> 24</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1_i_execution_frame.html#ab81312bd5e64cbae2803de9f243bdb32">RegisterDebugCallback</a>(<span class="keyword">const</span> <a class="code" href="namespacearmnn.html#a15f3ad9b5e4e3d46b0a6dda246a7bc28">DebugCallbackFunction</a>&amp;) {};</div>
123<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;};</div>
124<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
125<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="classarmnn_1_1_execution_frame.html"> 27</a></span>&#160;<span class="keyword">class </span><a class="code" href="classarmnn_1_1_execution_frame.html">ExecutionFrame</a>: <span class="keyword">public</span> <a class="code" href="classarmnn_1_1_i_execution_frame.html">IExecutionFrame</a></div>
126<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;{</div>
127<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">public</span>:</div>
128<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <a class="code" href="classarmnn_1_1_execution_frame.html#ad93148c735945f614be3a5e57c3c1dad">ExecutionFrame</a>();</div>
129<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div>
130<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <a class="code" href="classarmnn_1_1_i_execution_frame.html">IExecutionFrame</a>* <a class="code" href="classarmnn_1_1_execution_frame.html#a53bc9f544fe292cbbc2d258595bc3af7">ExecuteWorkloads</a>(<a class="code" href="classarmnn_1_1_i_execution_frame.html">IExecutionFrame</a>* previousFrame) <span class="keyword">override</span> ;</div>
131<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1_execution_frame.html#a81627f96ba06d76e147f7d392a8117ed">PostAllocationConfigure</a>() <span class="keyword">override</span>;</div>
132<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1_execution_frame.html#ab27ebaf88cafddc4a6ee001ec7316e73">RegisterDebugCallback</a>(<span class="keyword">const</span> <a class="code" href="namespacearmnn.html#a15f3ad9b5e4e3d46b0a6dda246a7bc28">DebugCallbackFunction</a>&amp; func) <span class="keyword">override</span> ;</div>
133<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1_execution_frame.html#a66a0f659f0630312604b65cb8f144c0e">AddWorkloadToQueue</a>(std::unique_ptr&lt;IWorkload&gt; workload);</div>
134<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1_execution_frame.html#a695550617960685f2626ef23c30e2c9d">SetNextExecutionFrame</a>(<a class="code" href="classarmnn_1_1_i_execution_frame.html">IExecutionFrame</a>* nextExecutionFrame);</div>
135<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="keyword">private</span>:</div>
136<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <a class="code" href="namespacearmnn.html#a15f53f26b8495b51d0bba3d1bc4efc80">WorkloadQueue</a> m_WorkloadQueue;</div>
137<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <a class="code" href="classarmnn_1_1_i_execution_frame.html">IExecutionFrame</a>* m_NextExecutionFrame = <span class="keyword">nullptr</span>;</div>
138<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;};</div>
139<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; </div>
140<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;}</div>
141</div><!-- fragment --></div><!-- contents -->
142</div><!-- doc-content -->
143<div class="ttc" id="aclassarmnn_1_1_i_execution_frame_html_ae8ab22492f0a5f78d5a2ab7e76486b5d"><div class="ttname"><a href="classarmnn_1_1_i_execution_frame.html#ae8ab22492f0a5f78d5a2ab7e76486b5d">armnn::IExecutionFrame::PostAllocationConfigure</a></div><div class="ttdeci">virtual void PostAllocationConfigure()</div><div class="ttdef"><b>Definition:</b> <a href="_execution_frame_8hpp_source.html#l00023">ExecutionFrame.hpp:23</a></div></div>
144<div class="ttc" id="aclassarmnn_1_1_i_execution_frame_html_a62a4e8e95f13a5b8fd62008423160362"><div class="ttname"><a href="classarmnn_1_1_i_execution_frame.html#a62a4e8e95f13a5b8fd62008423160362">armnn::IExecutionFrame::ExecuteWorkloads</a></div><div class="ttdeci">virtual IExecutionFrame * ExecuteWorkloads(IExecutionFrame *previousFrame)=0</div></div>
145<div class="ttc" id="aclassarmnn_1_1_execution_frame_html_ab27ebaf88cafddc4a6ee001ec7316e73"><div class="ttname"><a href="classarmnn_1_1_execution_frame.html#ab27ebaf88cafddc4a6ee001ec7316e73">armnn::ExecutionFrame::RegisterDebugCallback</a></div><div class="ttdeci">void RegisterDebugCallback(const DebugCallbackFunction &amp;func) override</div><div class="ttdef"><b>Definition:</b> <a href="_execution_frame_8cpp_source.html#l00032">ExecutionFrame.cpp:32</a></div></div>
146<div class="ttc" id="anamespacearmnn_html_a15f53f26b8495b51d0bba3d1bc4efc80"><div class="ttname"><a href="namespacearmnn.html#a15f53f26b8495b51d0bba3d1bc4efc80">armnn::WorkloadQueue</a></div><div class="ttdeci">std::vector&lt; std::unique_ptr&lt; IWorkload &gt; &gt; WorkloadQueue</div><div class="ttdef"><b>Definition:</b> <a href="_execution_frame_8hpp_source.html#l00013">ExecutionFrame.hpp:13</a></div></div>
147<div class="ttc" id="aclassarmnn_1_1_execution_frame_html_a81627f96ba06d76e147f7d392a8117ed"><div class="ttname"><a href="classarmnn_1_1_execution_frame.html#a81627f96ba06d76e147f7d392a8117ed">armnn::ExecutionFrame::PostAllocationConfigure</a></div><div class="ttdeci">void PostAllocationConfigure() override</div><div class="ttdef"><b>Definition:</b> <a href="_execution_frame_8cpp_source.html#l00024">ExecutionFrame.cpp:24</a></div></div>
148<div class="ttc" id="aclassarmnn_1_1_execution_frame_html_a695550617960685f2626ef23c30e2c9d"><div class="ttname"><a href="classarmnn_1_1_execution_frame.html#a695550617960685f2626ef23c30e2c9d">armnn::ExecutionFrame::SetNextExecutionFrame</a></div><div class="ttdeci">void SetNextExecutionFrame(IExecutionFrame *nextExecutionFrame)</div><div class="ttdef"><b>Definition:</b> <a href="_execution_frame_8cpp_source.html#l00045">ExecutionFrame.cpp:45</a></div></div>
149<div class="ttc" id="a_workload_8hpp_html"><div class="ttname"><a href="_workload_8hpp.html">Workload.hpp</a></div></div>
150<div class="ttc" id="aclassarmnn_1_1_execution_frame_html"><div class="ttname"><a href="classarmnn_1_1_execution_frame.html">armnn::ExecutionFrame</a></div><div class="ttdef"><b>Definition:</b> <a href="_execution_frame_8hpp_source.html#l00027">ExecutionFrame.hpp:27</a></div></div>
151<div class="ttc" id="anamespacearmnn_html_a15f3ad9b5e4e3d46b0a6dda246a7bc28"><div class="ttname"><a href="namespacearmnn.html#a15f3ad9b5e4e3d46b0a6dda246a7bc28">armnn::DebugCallbackFunction</a></div><div class="ttdeci">std::function&lt; void(LayerGuid guid, unsigned int slotIndex, ITensorHandle *tensorHandle)&gt; DebugCallbackFunction</div><div class="ttdoc">Define the type of callback for the Debug layer to call.</div><div class="ttdef"><b>Definition:</b> <a href="_types_8hpp_source.html#l00398">Types.hpp:398</a></div></div>
152<div class="ttc" id="aclassarmnn_1_1_execution_frame_html_a66a0f659f0630312604b65cb8f144c0e"><div class="ttname"><a href="classarmnn_1_1_execution_frame.html#a66a0f659f0630312604b65cb8f144c0e">armnn::ExecutionFrame::AddWorkloadToQueue</a></div><div class="ttdeci">void AddWorkloadToQueue(std::unique_ptr&lt; IWorkload &gt; workload)</div><div class="ttdef"><b>Definition:</b> <a href="_execution_frame_8cpp_source.html#l00040">ExecutionFrame.cpp:40</a></div></div>
153<div class="ttc" id="anamespacearmnn_html"><div class="ttname"><a href="namespacearmnn.html">armnn</a></div><div class="ttdoc">Copyright (c) 2021 ARM Limited and Contributors.</div><div class="ttdef"><b>Definition:</b> <a href="01__00__quick__start_8dox_source.html#l00006">01_00_quick_start.dox:6</a></div></div>
154<div class="ttc" id="aclassarmnn_1_1_execution_frame_html_ad93148c735945f614be3a5e57c3c1dad"><div class="ttname"><a href="classarmnn_1_1_execution_frame.html#ad93148c735945f614be3a5e57c3c1dad">armnn::ExecutionFrame::ExecutionFrame</a></div><div class="ttdeci">ExecutionFrame()</div><div class="ttdef"><b>Definition:</b> <a href="_execution_frame_8cpp_source.html#l00012">ExecutionFrame.cpp:12</a></div></div>
155<div class="ttc" id="aclassarmnn_1_1_i_execution_frame_html_ab81312bd5e64cbae2803de9f243bdb32"><div class="ttname"><a href="classarmnn_1_1_i_execution_frame.html#ab81312bd5e64cbae2803de9f243bdb32">armnn::IExecutionFrame::RegisterDebugCallback</a></div><div class="ttdeci">virtual void RegisterDebugCallback(const DebugCallbackFunction &amp;)</div><div class="ttdef"><b>Definition:</b> <a href="_execution_frame_8hpp_source.html#l00024">ExecutionFrame.hpp:24</a></div></div>
156<div class="ttc" id="aclassarmnn_1_1_execution_frame_html_a53bc9f544fe292cbbc2d258595bc3af7"><div class="ttname"><a href="classarmnn_1_1_execution_frame.html#a53bc9f544fe292cbbc2d258595bc3af7">armnn::ExecutionFrame::ExecuteWorkloads</a></div><div class="ttdeci">IExecutionFrame * ExecuteWorkloads(IExecutionFrame *previousFrame) override</div><div class="ttdef"><b>Definition:</b> <a href="_execution_frame_8cpp_source.html#l00014">ExecutionFrame.cpp:14</a></div></div>
157<div class="ttc" id="aclassarmnn_1_1_i_execution_frame_html"><div class="ttname"><a href="classarmnn_1_1_i_execution_frame.html">armnn::IExecutionFrame</a></div><div class="ttdoc">ExecutionFrame interface to enqueue a workload computation.</div><div class="ttdef"><b>Definition:</b> <a href="_execution_frame_8hpp_source.html#l00016">ExecutionFrame.hpp:16</a></div></div>
158<div class="ttc" id="aclassarmnn_1_1_i_execution_frame_html_a1ca0125ac3082676dae03050a52e6068"><div class="ttname"><a href="classarmnn_1_1_i_execution_frame.html#a1ca0125ac3082676dae03050a52e6068">armnn::IExecutionFrame::~IExecutionFrame</a></div><div class="ttdeci">virtual ~IExecutionFrame()</div><div class="ttdef"><b>Definition:</b> <a href="_execution_frame_8hpp_source.html#l00020">ExecutionFrame.hpp:20</a></div></div>
159<!-- start footer part -->
160<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
161 <ul>
162 <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_e0a84d05c80a2ef4231141dcbbeac5c8.html">armnn</a></li><li class="navelem"><a class="el" href="_execution_frame_8hpp.html">ExecutionFrame.hpp</a></li>
163 <li class="footer">Generated on Wed Feb 14 2024 16:36:14 for Arm NN by
164 <a href="http://www.doxygen.org/index.html">
165 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
166 </ul>
167</div>
168</body>
169</html>