diff options
author | Nikhil Raj <nikhil.raj@arm.com> | 2023-05-19 11:14:28 +0100 |
---|---|---|
committer | Nikhil Raj <nikhil.raj@arm.com> | 2023-05-19 11:14:28 +0100 |
commit | 8efb48a6847c5cd166c561127ae6611150963ce3 (patch) | |
tree | f4262b7e54d26021a54bbc310f46d16a291463e5 /23.05/_cl_context_serializer_8cpp_source.xhtml | |
parent | 023fe66a59414a0a7b337c7be5c3c341eb5b55d2 (diff) | |
download | armnn-8efb48a6847c5cd166c561127ae6611150963ce3.tar.gz |
Update Doxygen docu for 23.05
Signed-off-by: Nikhil Raj <nikhil.raj@arm.com>
Change-Id: I0a992286f14fa68fcc6e5eba31ac39fed003cbbe
Diffstat (limited to '23.05/_cl_context_serializer_8cpp_source.xhtml')
-rw-r--r-- | 23.05/_cl_context_serializer_8cpp_source.xhtml | 185 |
1 files changed, 185 insertions, 0 deletions
diff --git a/23.05/_cl_context_serializer_8cpp_source.xhtml b/23.05/_cl_context_serializer_8cpp_source.xhtml new file mode 100644 index 0000000000..5708101c1e --- /dev/null +++ b/23.05/_cl_context_serializer_8cpp_source.xhtml @@ -0,0 +1,185 @@ +<!-- 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.17"/> +<meta name="robots" content="NOINDEX, NOFOLLOW" /> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>ArmNN: src/backends/cl/ClContextSerializer.cpp 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> +<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" async="async" 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">23.05</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.17 --> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +/* @license-end */ +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +/* @license-end */</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"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(document).ready(function(){initNavTree('_cl_context_serializer_8cpp_source.xhtml',''); initResizable(); }); +/* @license-end */ +</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">ClContextSerializer.cpp</div> </div> +</div><!--header--> +<div class="contents"> +<a href="_cl_context_serializer_8cpp.xhtml">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 © 2020 Arm Ltd and Contributors. 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">#include "<a class="code" href="_cl_context_serializer_8hpp.xhtml">ClContextSerializer.hpp</a>"</span></div> +<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include "<a class="code" href="_cl_context_schema__generated_8h.xhtml">ClContextSchema_generated.h</a>"</span></div> +<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>  </div> +<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include <<a class="code" href="_exceptions_8hpp.xhtml">armnn/Exceptions.hpp</a>></span></div> +<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include <<a class="code" href="_logging_8hpp.xhtml">armnn/Logging.hpp</a>></span></div> +<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include <<a class="code" href="_numeric_cast_8hpp.xhtml">armnn/utility/NumericCast.hpp</a>></span></div> +<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  </div> +<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <fmt/format.h></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="preprocessor">#include <cstdlib></span></div> +<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <fstream></span></div> +<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <iostream></span></div> +<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include <vector></span></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> <span class="keyword">namespace </span><a class="code" href="namespacearmnn.xhtml">armnn</a></div> +<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> {</div> +<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div> +<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="classarmnn_1_1_cl_context_serializer.xhtml#a4a280cb5af0dc71c4dd665e2d12c4c94"> 23</a></span> <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1_cl_context_serializer.xhtml#a4a280cb5af0dc71c4dd665e2d12c4c94">ClContextSerializer::Serialize</a>(<span class="keyword">const</span> arm_compute::CLCompileContext& clCompileContext)</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>  <span class="comment">// Get map of built programs from clCompileContext</span></div> +<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  std::map<std::string, cl::Program> builtProgramsMap = clCompileContext.get_built_programs();</div> +<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keywordflow">if</span> (builtProgramsMap.empty())</div> +<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  {</div> +<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <a class="code" href="_logging_8hpp.xhtml#a7b6ad073975f437ec38ca7d20154727f">ARMNN_LOG</a>(<a class="code" href="namespacearmnn.xhtml#a4dc0adc6737b5944e7671bee71788407a7b83d3f08fa392b79e3f553b585971cd">warning</a>) << <span class="stringliteral">"There are no built programs to be serialised."</span>;</div> +<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keywordflow">return</span>;</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>  </div> +<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="comment">// Create Flatbuffer CL Programs</span></div> +<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  std::vector<flatbuffers::Offset<armnn::Program>> clPrograms;</div> +<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keywordflow">for</span>(<span class="keyword">const</span> <span class="keyword">auto</span>& program : builtProgramsMap)</div> +<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  {</div> +<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  std::vector<std::vector<uint8_t>> binaries = program.second.getInfo<CL_PROGRAM_BINARIES>();</div> +<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  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>  m_FlatBufferBuilder.CreateString(program.first),</div> +<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  m_FlatBufferBuilder.CreateVector(binaries[0])));</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>  </div> +<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="comment">// Create Flatbuffer CLContext</span></div> +<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <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>  </div> +<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  m_FlatBufferBuilder.Finish(clContext);</div> +<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> }</div> +<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  </div> +<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="classarmnn_1_1_cl_context_serializer.xhtml#a049d34980f9dd0a518f9781822a718c4"> 49</a></span> <span class="keywordtype">bool</span> <a class="code" href="classarmnn_1_1_cl_context_serializer.xhtml#a049d34980f9dd0a518f9781822a718c4">ClContextSerializer::SaveSerializedToStream</a>(std::ostream& stream)</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>  <span class="comment">// Write to a stream</span></div> +<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">auto</span> bytesToWrite = armnn::numeric_cast<std::streamsize>(m_FlatBufferBuilder.GetSize());</div> +<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  stream.write(<span class="keyword">reinterpret_cast<</span><span class="keyword">const </span><span class="keywordtype">char</span>*<span class="keyword">></span>(m_FlatBufferBuilder.GetBufferPointer()), bytesToWrite);</div> +<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordflow">return</span> !stream.bad();</div> +<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> }</div> +<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div> +<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> } <span class="comment">// namespace armnn</span></div> +</div><!-- fragment --></div><!-- contents --> +</div><!-- doc-content --> +<div class="ttc" id="anamespacearmnn_xhtml_a0f37510801ba4f2500e4e9558c81f93c"><div class="ttname"><a href="namespacearmnn.xhtml#a0f37510801ba4f2500e4e9558c81f93c">armnn::CreateProgram</a></div><div class="ttdeci">flatbuffers::Offset< Program > CreateProgram(flatbuffers::FlatBufferBuilder &_fbb, flatbuffers::Offset< flatbuffers::String > name=0, flatbuffers::Offset< flatbuffers::Vector< uint8_t >> 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> +<div class="ttc" id="anamespacearmnn_xhtml_ac845f99ae84c2fcf016b676769da7c51"><div class="ttname"><a href="namespacearmnn.xhtml#ac845f99ae84c2fcf016b676769da7c51">armnn::CreateClContext</a></div><div class="ttdeci">flatbuffers::Offset< ClContext > CreateClContext(flatbuffers::FlatBufferBuilder &_fbb, flatbuffers::Offset< flatbuffers::Vector< flatbuffers::Offset< armnn::Program >>> 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> +<div class="ttc" id="aclassarmnn_1_1_cl_context_serializer_xhtml_a4a280cb5af0dc71c4dd665e2d12c4c94"><div class="ttname"><a href="classarmnn_1_1_cl_context_serializer.xhtml#a4a280cb5af0dc71c4dd665e2d12c4c94">armnn::ClContextSerializer::Serialize</a></div><div class="ttdeci">void Serialize(const arm_compute::CLCompileContext &clCompileContext)</div><div class="ttdoc">Serializes the CLCompileContext built-in programs.</div><div class="ttdef"><b>Definition:</b> <a href="_cl_context_serializer_8cpp_source.xhtml#l00023">ClContextSerializer.cpp:23</a></div></div> +<div class="ttc" id="a_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> +<div class="ttc" id="a_cl_context_serializer_8hpp_xhtml"><div class="ttname"><a href="_cl_context_serializer_8hpp.xhtml">ClContextSerializer.hpp</a></div></div> +<div class="ttc" id="anamespacearmnn_xhtml"><div class="ttname"><a href="namespacearmnn.xhtml">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.xhtml#l00006">01_00_quick_start.dox:6</a></div></div> +<div class="ttc" id="anamespacearmnn_xhtml_a4dc0adc6737b5944e7671bee71788407a7b83d3f08fa392b79e3f553b585971cd"><div class="ttname"><a href="namespacearmnn.xhtml#a4dc0adc6737b5944e7671bee71788407a7b83d3f08fa392b79e3f553b585971cd">armnn::BoostLogSeverityMapping::warning</a></div><div class="ttdeci">@ warning</div></div> +<div class="ttc" id="aclassarmnn_1_1_cl_context_serializer_xhtml_a049d34980f9dd0a518f9781822a718c4"><div class="ttname"><a href="classarmnn_1_1_cl_context_serializer.xhtml#a049d34980f9dd0a518f9781822a718c4">armnn::ClContextSerializer::SaveSerializedToStream</a></div><div class="ttdeci">bool SaveSerializedToStream(std::ostream &stream)</div><div class="ttdoc">Serializes the ClContext to the stream.</div><div class="ttdef"><b>Definition:</b> <a href="_cl_context_serializer_8cpp_source.xhtml#l00049">ClContextSerializer.cpp:49</a></div></div> +<div class="ttc" id="a_exceptions_8hpp_xhtml"><div class="ttname"><a href="_exceptions_8hpp.xhtml">Exceptions.hpp</a></div></div> +<div class="ttc" id="a_logging_8hpp_xhtml"><div class="ttname"><a href="_logging_8hpp.xhtml">Logging.hpp</a></div></div> +<div class="ttc" id="a_numeric_cast_8hpp_xhtml"><div class="ttname"><a href="_numeric_cast_8hpp.xhtml">NumericCast.hpp</a></div></div> +<div class="ttc" id="a_cl_context_schema__generated_8h_xhtml"><div class="ttname"><a href="_cl_context_schema__generated_8h.xhtml">ClContextSchema_generated.h</a></div></div> +<!-- 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.xhtml">src</a></li><li class="navelem"><a class="el" href="dir_0f3cdec46afbc61a1ded8e1687c9c9a0.xhtml">backends</a></li><li class="navelem"><a class="el" href="dir_1ad86c6d39ab715a831555571b9e98a5.xhtml">cl</a></li><li class="navelem"><a class="el" href="_cl_context_serializer_8cpp.xhtml">ClContextSerializer.cpp</a></li> + <li class="footer">Generated on Thu May 18 2023 10:35:41 for ArmNN by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li> + </ul> +</div> +</body> +</html> |