Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 8d2ca734165a068478df7cffa46185680b05cd20 / . / 23.02 / classarmnn_1_1_cl_context_serializer.xhtml
blob: 36c58553b70b20be5baac5061aa996133c5c151b [file] [log] [blame]
Nikhil Raj8d2ca732023-02-24 10:28: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: ClContextSerializer 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">23.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_1_cl_context_serializer.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_1_cl_context_serializer-members.xhtml">List of all members</a> </div>
100 <div class="headertitle">
101<div class="title">ClContextSerializer Class Reference</div> </div>
102</div><!--header-->
103<div class="contents">
104
105<p><code>#include &lt;<a class="el" href="_cl_context_serializer_8hpp_source.xhtml">ClContextSerializer.hpp</a>&gt;</code></p>
106<table class="memberdecls">
107<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
108Public Member Functions</h2></td></tr>
109<tr class="memitem:a76667bc7f0bed0097cd2f44c6b28b7ab"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_cl_context_serializer.xhtml#a76667bc7f0bed0097cd2f44c6b28b7ab">ClContextSerializer</a> ()=default</td></tr>
110<tr class="separator:a76667bc7f0bed0097cd2f44c6b28b7ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
111<tr class="memitem:a98565c90862c879b731128512377efb6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_cl_context_serializer.xhtml#a98565c90862c879b731128512377efb6">~ClContextSerializer</a> ()=default</td></tr>
112<tr class="separator:a98565c90862c879b731128512377efb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
113<tr class="memitem:a4a280cb5af0dc71c4dd665e2d12c4c94"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_cl_context_serializer.xhtml#a4a280cb5af0dc71c4dd665e2d12c4c94">Serialize</a> (const arm_compute::CLCompileContext &amp;clCompileContext)</td></tr>
114<tr class="memdesc:a4a280cb5af0dc71c4dd665e2d12c4c94"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serializes the CLCompileContext built-in programs. <a href="#a4a280cb5af0dc71c4dd665e2d12c4c94">More...</a><br /></td></tr>
115<tr class="separator:a4a280cb5af0dc71c4dd665e2d12c4c94"><td class="memSeparator" colspan="2">&#160;</td></tr>
116<tr class="memitem:a049d34980f9dd0a518f9781822a718c4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_cl_context_serializer.xhtml#a049d34980f9dd0a518f9781822a718c4">SaveSerializedToStream</a> (std::ostream &amp;stream)</td></tr>
117<tr class="memdesc:a049d34980f9dd0a518f9781822a718c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serializes the ClContext to the stream. <a href="#a049d34980f9dd0a518f9781822a718c4">More...</a><br /></td></tr>
118<tr class="separator:a049d34980f9dd0a518f9781822a718c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
119</table>
120<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
121<div class="textblock">
122<p class="definition">Definition at line <a class="el" href="_cl_context_serializer_8hpp_source.xhtml#l00015">15</a> of file <a class="el" href="_cl_context_serializer_8hpp_source.xhtml">ClContextSerializer.hpp</a>.</p>
123</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
124<a id="a76667bc7f0bed0097cd2f44c6b28b7ab"></a>
125<h2 class="memtitle"><span class="permalink"><a href="#a76667bc7f0bed0097cd2f44c6b28b7ab">&#9670;&nbsp;</a></span>ClContextSerializer()</h2>
126
127<div class="memitem">
128<div class="memproto">
129<table class="mlabels">
130 <tr>
131 <td class="mlabels-left">
132 <table class="memname">
133 <tr>
134 <td class="memname"><a class="el" href="classarmnn_1_1_cl_context_serializer.xhtml">ClContextSerializer</a> </td>
135 <td>(</td>
136 <td class="paramname"></td><td>)</td>
137 <td></td>
138 </tr>
139 </table>
140 </td>
141 <td class="mlabels-right">
142<span class="mlabels"><span class="mlabel">default</span></span> </td>
143 </tr>
144</table>
145</div><div class="memdoc">
146
147</div>
148</div>
149<a id="a98565c90862c879b731128512377efb6"></a>
150<h2 class="memtitle"><span class="permalink"><a href="#a98565c90862c879b731128512377efb6">&#9670;&nbsp;</a></span>~ClContextSerializer()</h2>
151
152<div class="memitem">
153<div class="memproto">
154<table class="mlabels">
155 <tr>
156 <td class="mlabels-left">
157 <table class="memname">
158 <tr>
159 <td class="memname">~<a class="el" href="classarmnn_1_1_cl_context_serializer.xhtml">ClContextSerializer</a> </td>
160 <td>(</td>
161 <td class="paramname"></td><td>)</td>
162 <td></td>
163 </tr>
164 </table>
165 </td>
166 <td class="mlabels-right">
167<span class="mlabels"><span class="mlabel">default</span></span> </td>
168 </tr>
169</table>
170</div><div class="memdoc">
171
172</div>
173</div>
174<h2 class="groupheader">Member Function Documentation</h2>
175<a id="a049d34980f9dd0a518f9781822a718c4"></a>
176<h2 class="memtitle"><span class="permalink"><a href="#a049d34980f9dd0a518f9781822a718c4">&#9670;&nbsp;</a></span>SaveSerializedToStream()</h2>
177
178<div class="memitem">
179<div class="memproto">
180 <table class="memname">
181 <tr>
182 <td class="memname">bool SaveSerializedToStream </td>
183 <td>(</td>
184 <td class="paramtype">std::ostream &amp;&#160;</td>
185 <td class="paramname"><em>stream</em></td><td>)</td>
186 <td></td>
187 </tr>
188 </table>
189</div><div class="memdoc">
190
191<p>Serializes the ClContext to the stream. </p>
192<dl class="params"><dt>Parameters</dt><dd>
193 <table class="params">
194 <tr><td class="paramname">[stream]</td><td>the stream to save to </td></tr>
195 </table>
196 </dd>
197</dl>
198<dl class="section return"><dt>Returns</dt><dd>true if ClContext is Serialized to the Stream, false otherwise </dd></dl>
199
200<p class="definition">Definition at line <a class="el" href="_cl_context_serializer_8cpp_source.xhtml#l00049">49</a> of file <a class="el" href="_cl_context_serializer_8cpp_source.xhtml">ClContextSerializer.cpp</a>.</p>
201
202<p class="reference">References <a class="el" href="_numeric_cast_8hpp_source.xhtml#l00035">armnn::numeric_cast()</a>.</p>
203
204<p class="reference">Referenced by <a class="el" href="_cl_workload_factory_8cpp_source.xhtml#l00066">ClWorkloadFactory::AfterWorkloadsCreated()</a>.</p>
205<div class="fragment"><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="comment">// Write to a stream</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keyword">auto</span> bytesToWrite = <a class="code" href="namespacearmnn.xhtml#a375ca3cff9f1b005d1412dc5f3cf5b6e">armnn::numeric_cast</a>&lt;std::streamsize&gt;(m_FlatBufferBuilder.GetSize());</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; stream.write(reinterpret_cast&lt;const char*&gt;(m_FlatBufferBuilder.GetBufferPointer()), bytesToWrite);</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keywordflow">return</span> !stream.bad();</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;}</div><div class="ttc" id="namespacearmnn_xhtml_a375ca3cff9f1b005d1412dc5f3cf5b6e"><div class="ttname"><a href="namespacearmnn.xhtml#a375ca3cff9f1b005d1412dc5f3cf5b6e">armnn::numeric_cast</a></div><div class="ttdeci">std::enable_if_t&lt; std::is_unsigned&lt; Source &gt;::value &amp;&amp;std::is_unsigned&lt; Dest &gt;::value, Dest &gt; numeric_cast(Source source)</div><div class="ttdef"><b>Definition:</b> <a href="_numeric_cast_8hpp_source.xhtml#l00035">NumericCast.hpp:35</a></div></div>
206</div><!-- fragment -->
207</div>
208</div>
209<a id="a4a280cb5af0dc71c4dd665e2d12c4c94"></a>
210<h2 class="memtitle"><span class="permalink"><a href="#a4a280cb5af0dc71c4dd665e2d12c4c94">&#9670;&nbsp;</a></span>Serialize()</h2>
211
212<div class="memitem">
213<div class="memproto">
214 <table class="memname">
215 <tr>
216 <td class="memname">void Serialize </td>
217 <td>(</td>
218 <td class="paramtype">const arm_compute::CLCompileContext &amp;&#160;</td>
219 <td class="paramname"><em>clCompileContext</em></td><td>)</td>
220 <td></td>
221 </tr>
222 </table>
223</div><div class="memdoc">
224
225<p>Serializes the CLCompileContext built-in programs. </p>
226<dl class="params"><dt>Parameters</dt><dd>
227 <table class="params">
228 <tr><td class="paramdir">[in]</td><td class="paramname">clCompileContext</td><td>The CLCompileContext to be serialized. </td></tr>
229 </table>
230 </dd>
231</dl>
232
233<p class="definition">Definition at line <a class="el" href="_cl_context_serializer_8cpp_source.xhtml#l00023">23</a> of file <a class="el" href="_cl_context_serializer_8cpp_source.xhtml">ClContextSerializer.cpp</a>.</p>
234
235<p class="reference">References <a class="el" href="_logging_8hpp_source.xhtml#l00212">ARMNN_LOG</a>, <a class="el" href="_cl_context_schema__generated_8h_source.xhtml#l00057">armnn::CreateClContext()</a>, <a class="el" href="_cl_context_schema__generated_8h_source.xhtml#l00118">armnn::CreateProgram()</a>, and <a class="el" href="namespacearmnn.xhtml#a4dc0adc6737b5944e7671bee71788407a7b83d3f08fa392b79e3f553b585971cd">armnn::warning</a>.</p>
236
237<p class="reference">Referenced by <a class="el" href="_cl_workload_factory_8cpp_source.xhtml#l00066">ClWorkloadFactory::AfterWorkloadsCreated()</a>.</p>
238<div class="fragment"><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;{</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="comment">// Get map of built programs from clCompileContext</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; std::map&lt;std::string, cl::Program&gt; builtProgramsMap = clCompileContext.get_built_programs();</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keywordflow">if</span> (builtProgramsMap.empty())</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; {</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <a class="code" href="_logging_8hpp.xhtml#a7b6ad073975f437ec38ca7d20154727f">ARMNN_LOG</a>(<a class="code" href="namespacearmnn.xhtml#a4dc0adc6737b5944e7671bee71788407a7b83d3f08fa392b79e3f553b585971cd">warning</a>) &lt;&lt; <span class="stringliteral">&quot;There are no built programs to be serialised.&quot;</span>;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keywordflow">return</span>;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; }</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="comment">// Create Flatbuffer CL Programs</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; std::vector&lt;flatbuffers::Offset&lt;armnn::Program&gt;&gt; clPrograms;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keywordflow">for</span>(<span class="keyword">const</span> <span class="keyword">auto</span>&amp; program : builtProgramsMap)</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; {</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; std::vector&lt;std::vector&lt;uint8_t&gt;&gt; binaries = program.second.getInfo&lt;CL_PROGRAM_BINARIES&gt;();</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; clPrograms.push_back(<a class="code" href="namespacearmnn.xhtml#a0f37510801ba4f2500e4e9558c81f93c">CreateProgram</a>(m_FlatBufferBuilder,</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; m_FlatBufferBuilder.CreateString(program.first),</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; m_FlatBufferBuilder.CreateVector(binaries[0])));</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; }</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="comment">// Create Flatbuffer CLContext</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keyword">auto</span> clContext = <a class="code" href="namespacearmnn.xhtml#ac845f99ae84c2fcf016b676769da7c51">CreateClContext</a>(m_FlatBufferBuilder, m_FlatBufferBuilder.CreateVector(clPrograms));</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; m_FlatBufferBuilder.Finish(clContext);</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;}</div><div class="ttc" id="namespacearmnn_xhtml_a0f37510801ba4f2500e4e9558c81f93c"><div class="ttname"><a href="namespacearmnn.xhtml#a0f37510801ba4f2500e4e9558c81f93c">armnn::CreateProgram</a></div><div class="ttdeci">flatbuffers::Offset&lt; Program &gt; CreateProgram(flatbuffers::FlatBufferBuilder &amp;_fbb, flatbuffers::Offset&lt; flatbuffers::String &gt; name=0, flatbuffers::Offset&lt; flatbuffers::Vector&lt; uint8_t &gt;&gt; binary=0)</div><div class="ttdef"><b>Definition:</b> <a href="_cl_context_schema__generated_8h_source.xhtml#l00118">ClContextSchema_generated.h:118</a></div></div>
239<div class="ttc" id="_logging_8hpp_xhtml_a7b6ad073975f437ec38ca7d20154727f"><div class="ttname"><a href="_logging_8hpp.xhtml#a7b6ad073975f437ec38ca7d20154727f">ARMNN_LOG</a></div><div class="ttdeci">#define ARMNN_LOG(severity)</div><div class="ttdef"><b>Definition:</b> <a href="_logging_8hpp_source.xhtml#l00212">Logging.hpp:212</a></div></div>
240<div class="ttc" id="namespacearmnn_xhtml_a4dc0adc6737b5944e7671bee71788407a7b83d3f08fa392b79e3f553b585971cd"><div class="ttname"><a href="namespacearmnn.xhtml#a4dc0adc6737b5944e7671bee71788407a7b83d3f08fa392b79e3f553b585971cd">armnn::BoostLogSeverityMapping::warning</a></div></div>
241<div class="ttc" id="namespacearmnn_xhtml_ac845f99ae84c2fcf016b676769da7c51"><div class="ttname"><a href="namespacearmnn.xhtml#ac845f99ae84c2fcf016b676769da7c51">armnn::CreateClContext</a></div><div class="ttdeci">flatbuffers::Offset&lt; ClContext &gt; CreateClContext(flatbuffers::FlatBufferBuilder &amp;_fbb, flatbuffers::Offset&lt; flatbuffers::Vector&lt; flatbuffers::Offset&lt; armnn::Program &gt;&gt;&gt; programs=0)</div><div class="ttdef"><b>Definition:</b> <a href="_cl_context_schema__generated_8h_source.xhtml#l00057">ClContextSchema_generated.h:57</a></div></div>
242</div><!-- fragment -->
243</div>
244</div>
245<hr/>The documentation for this class was generated from the following files:<ul>
246<li>src/backends/cl/<a class="el" href="_cl_context_serializer_8hpp_source.xhtml">ClContextSerializer.hpp</a></li>
247<li>src/backends/cl/<a class="el" href="_cl_context_serializer_8cpp_source.xhtml">ClContextSerializer.cpp</a></li>
248</ul>
249</div><!-- contents -->
250</div><!-- doc-content -->
251<!-- start footer part -->
252<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
253 <ul>
254 <li class="navelem"><a class="el" href="namespacearmnn.xhtml">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_cl_context_serializer.xhtml">ClContextSerializer</a></li>
255 <li class="footer">Generated on Fri Feb 24 2023 10:24:29 for ArmNN by
256 <a href="http://www.doxygen.org/index.html">
257 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
258 </ul>
259</div>
260</body>
261</html>