diff options
Diffstat (limited to '20.02/_leak_checking_8hpp_source.xhtml')
| -rw-r--r-- | 20.02/_leak_checking_8hpp_source.xhtml | 114 |
1 files changed, 114 insertions, 0 deletions
diff --git a/20.02/_leak_checking_8hpp_source.xhtml b/20.02/_leak_checking_8hpp_source.xhtml new file mode 100644 index 0000000000..fc9d1e17fc --- /dev/null +++ b/20.02/_leak_checking_8hpp_source.xhtml @@ -0,0 +1,114 @@ +<!-- 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: src/armnnUtils/LeakChecking.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> +<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">20.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('_leak_checking_8hpp_source.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="headertitle"> +<div class="title">LeakChecking.hpp</div> </div> +</div><!--header--> +<div class="contents"> +<a href="_leak_checking_8hpp.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 © 2017 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> <span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> </div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#ifdef ARMNN_LEAK_CHECKING_ENABLED</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 <string></span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include <cstddef></span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include <memory></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="keyword">namespace </span><a class="code" href="namespacearmnn_utils.xhtml">armnnUtils</a></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> </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="keyword">class </span>ScopedLeakChecker final</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">public</span>:</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  ScopedLeakChecker(<span class="keyword">const</span> std::string & name);</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  ~ScopedLeakChecker();</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>  <span class="comment">// Forwarding these to Google Performance Tools.</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <span class="keyword">static</span> <span class="keywordtype">bool</span> IsActive();</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <span class="keywordtype">bool</span> NoLeaks();</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="comment">// Note that the following two functions only work after</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="comment">// NoLeaks() has been called. See explanations in</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="comment">// heap-checker.h</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  ssize_t BytesLeaked() <span class="keyword">const</span>;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  ssize_t ObjectsLeaked() <span class="keyword">const</span>;</div><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="keyword">private</span>:</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="comment">// Hides imlementation so we don't litter other's namespaces</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="comment">// with heap checker related stuff.</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keyword">struct </span>Impl;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  std::unique_ptr<Impl> m_Impl;</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>  <span class="comment">// No default construction and copying.</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  ScopedLeakChecker() = <span class="keyword">delete</span>;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  ScopedLeakChecker(<span class="keyword">const</span> ScopedLeakChecker &) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  ScopedLeakChecker & operator=(<span class="keyword">const</span> ScopedLeakChecker &) = <span class="keyword">delete</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> </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">class </span>ScopedDisableLeakChecking final</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="keyword">public</span>:</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  ScopedDisableLeakChecking();</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  ~ScopedDisableLeakChecking();</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="comment">// Hides imlementation so we don't litter other's namespaces</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="comment">// with heap checker related stuff.</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">struct </span>Impl;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  std::unique_ptr<Impl> m_Impl;</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">// No copying.</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  ScopedDisableLeakChecking(<span class="keyword">const</span> ScopedDisableLeakChecking &) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  ScopedDisableLeakChecking & operator=(<span class="keyword">const</span> ScopedDisableLeakChecking &) = <span class="keyword">delete</span>;</div><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> </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment">// disable global leak checks starting from 'main'</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="keywordtype">void</span> LocalLeakCheckingOnly();</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="comment">// namespace armnnUtils</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="preprocessor">#define ARMNN_SCOPED_LEAK_CHECKER(TAG) \</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="preprocessor"> armnnUtils::ScopedLeakChecker __scoped_armnn_leak_checker__(TAG)</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="preprocessor">#define ARMNN_LEAK_CHECKER_IS_ACTIVE() \</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor"> armnnUtils::ScopedLeakChecker::IsActive()</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="preprocessor">#define ARMNN_NO_LEAKS_IN_SCOPE() \</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="preprocessor"> __scoped_armnn_leak_checker__.NoLeaks()</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="preprocessor">#define ARMNN_BYTES_LEAKED_IN_SCOPE() \</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor"> __scoped_armnn_leak_checker__.BytesLeaked()</span></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="preprocessor">#define ARMNN_OBJECTS_LEAKED_IN_SCOPE() \</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="preprocessor"> __scoped_armnn_leak_checker__.ObjectsLeaked()</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="preprocessor">#define ARMNN_DISABLE_LEAK_CHECKING_IN_SCOPE() \</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="preprocessor"> armnnUtils::ScopedDisableLeakChecking __disable_leak_checking_in_scope__</span></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> <span class="preprocessor">#define ARMNN_LOCAL_LEAK_CHECKING_ONLY() \</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="preprocessor"> armnnUtils::LocalLeakCheckingOnly()</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="preprocessor">#else // ARMNN_LEAK_CHECKING_ENABLED</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div><div class="line"><a name="l00088"></a><span class="lineno"><a class="line" href="_leak_checking_8hpp.xhtml#a36be82c2b683b814469300800e05a20c"> 88</a></span> <span class="preprocessor">#define ARMNN_SCOPED_LEAK_CHECKER(TAG)</span></div><div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="_leak_checking_8hpp.xhtml#a5a5dabd7febb3bf4702e197cd460db31"> 89</a></span> <span class="preprocessor">#define ARMNN_LEAK_CHECKER_IS_ACTIVE() false</span></div><div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="_leak_checking_8hpp.xhtml#adaae3648a8a125ec0ffe5e9aefd2a17e"> 90</a></span> <span class="preprocessor">#define ARMNN_NO_LEAKS_IN_SCOPE() true</span></div><div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="_leak_checking_8hpp.xhtml#a469b092b942872fb939dbf2684d7e8e5"> 91</a></span> <span class="preprocessor">#define ARMNN_BYTES_LEAKED_IN_SCOPE() 0</span></div><div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="_leak_checking_8hpp.xhtml#ad47a18b9752f3dad8d4b15351913211c"> 92</a></span> <span class="preprocessor">#define ARMNN_OBJECTS_LEAKED_IN_SCOPE() 0</span></div><div class="line"><a name="l00093"></a><span class="lineno"><a class="line" href="_leak_checking_8hpp.xhtml#a9aaa2dcae10ed75233b511c29bccc086"> 93</a></span> <span class="preprocessor">#define ARMNN_DISABLE_LEAK_CHECKING_IN_SCOPE()</span></div><div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="_leak_checking_8hpp.xhtml#af8ba618202cf984cf165cbf2a36f3423"> 94</a></span> <span class="preprocessor">#define ARMNN_LOCAL_LEAK_CHECKING_ONLY()</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="preprocessor">#endif // ARMNN_LEAK_CHECKING_ENABLED</span></div><div class="ttc" id="namespacearmnn_utils_xhtml"><div class="ttname"><a href="namespacearmnn_utils.xhtml">armnnUtils</a></div><div class="ttdef"><b>Definition:</b> <a href="_data_layout_indexed_8hpp_source.xhtml#l00013">DataLayoutIndexed.hpp:13</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.xhtml">src</a></li><li class="navelem"><a class="el" href="dir_5d9c764a006d252ff232a5efbbd99a46.xhtml">armnnUtils</a></li><li class="navelem"><a class="el" href="_leak_checking_8hpp.xhtml">LeakChecking.hpp</a></li> + <li class="footer">Generated on Fri Mar 13 2020 16:09:10 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> |