Google Git
Sign in
apache / mxnet-site / d5c5a235eef72f64ccaf224b834a20ef3287469b / . / api / cpp / docs / api / include_2mxnet_2runtime_2memory_8h_source.html
blob: 322103cf914da3ec494209a25d4bf5e789fe3116 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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="viewport" content="width=device-width, initial-scale=1"/>
<title>mxnet: /work/mxnet/include/mxnet/runtime/memory.h 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="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>
<link href="doxygen.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;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">mxnet
</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&amp;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&amp;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>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_1143c7affb9ebd026cb6818dd282def7.html">mxnet</a></li><li class="navelem"><a class="el" href="dir_8e7a93613ef4c7e7d673effa691c1739.html">runtime</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">memory.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="include_2mxnet_2runtime_2memory_8h.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>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * distributed with this work for additional information</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * &quot;License&quot;); you may not use this file except in compliance</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * with the License. You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * software distributed under the License is distributed on an</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * KIND, either express or implied. See the License for the</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> * specific language governing permissions and limitations</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> * under the License.</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment">// Acknowledgement: This file originates from incubator-tvm</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#ifndef MXNET_RUNTIME_MEMORY_H_</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#define MXNET_RUNTIME_MEMORY_H_</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &lt;cstdlib&gt;</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#include &lt;utility&gt;</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#include &lt;type_traits&gt;</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="object_8h.html">object.h</a>&quot;</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;<span class="keyword">namespace </span><a class="code" href="namespacemxnet.html">mxnet</a> {</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="keyword">namespace </span>runtime {</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, <span class="keyword">typename</span>... Args&gt;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="keyword">inline</span> ObjectPtr&lt;T&gt; <a class="code" href="namespacemxnet_1_1runtime.html#ae494b840652fdcee82babd1e3c71e629">make_object</a>(Args&amp;&amp;... args);</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">// Detail implementations after this</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="comment">// The current design allows swapping the</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="comment">// allocator pattern when necessary.</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="comment">// Possible future allocator optimizations:</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="comment">// - Arena allocator that gives ownership of memory to arena (deleter_= nullptr)</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="comment">// - Thread-local object pools: one pool per size and alignment requirement.</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="comment">// - Can specialize by type of object to give the specific allocator to each object.</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> Derived&gt;</div>
<div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="classmxnet_1_1runtime_1_1ObjAllocatorBase.html"> 60</a></span>&#160;<span class="keyword">class </span><a class="code" href="classmxnet_1_1runtime_1_1ObjAllocatorBase.html">ObjAllocatorBase</a> {</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, <span class="keyword">typename</span>... Args&gt;</div>
<div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="classmxnet_1_1runtime_1_1ObjAllocatorBase.html#aa5513f69a466de425c500600350aa5e6"> 69</a></span>&#160; <span class="keyword">inline</span> <a class="code" href="classmxnet_1_1runtime_1_1ObjectPtr.html">ObjectPtr&lt;T&gt;</a> <a class="code" href="classmxnet_1_1runtime_1_1ObjAllocatorBase.html#aa5513f69a466de425c500600350aa5e6">make_object</a>(Args&amp;&amp;... args) {</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keyword">using</span> Handler = <span class="keyword">typename</span> Derived::template Handler&lt;T&gt;;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; static_assert(std::is_base_of&lt;Object, T&gt;::value, <span class="stringliteral">&quot;make can only be used to create Object&quot;</span>);</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; T* ptr = Handler::New(<span class="keyword">static_cast&lt;</span>Derived*<span class="keyword">&gt;</span>(<span class="keyword">this</span>), std::forward&lt;Args&gt;(args)...);</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; ptr-&gt;type_index_ = T::RuntimeTypeIndex();</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; ptr-&gt;deleter_ = Handler::Deleter();</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classmxnet_1_1runtime_1_1ObjectPtr.html">ObjectPtr&lt;T&gt;</a>(ptr);</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; }</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; </div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> ArrayType, <span class="keyword">typename</span> ElemType, <span class="keyword">typename</span>... Args&gt;</div>
<div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="classmxnet_1_1runtime_1_1ObjAllocatorBase.html#ae914a57fd55f72b586038c72f0005ba4"> 86</a></span>&#160; <span class="keyword">inline</span> <a class="code" href="classmxnet_1_1runtime_1_1ObjectPtr.html">ObjectPtr&lt;ArrayType&gt;</a> <a class="code" href="classmxnet_1_1runtime_1_1ObjAllocatorBase.html#ae914a57fd55f72b586038c72f0005ba4">make_inplace_array</a>(<span class="keywordtype">size_t</span> num_elems, Args&amp;&amp;... args) {</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keyword">using</span> Handler = <span class="keyword">typename</span> Derived::template ArrayHandler&lt;ArrayType, ElemType&gt;;</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; static_assert(std::is_base_of&lt;Object, ArrayType&gt;::value,</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <span class="stringliteral">&quot;make_inplace_array can only be used to create Object&quot;</span>);</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; ArrayType* ptr =</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; Handler::New(<span class="keyword">static_cast&lt;</span>Derived*<span class="keyword">&gt;</span>(<span class="keyword">this</span>), num_elems, std::forward&lt;Args&gt;(args)...);</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; ptr-&gt;type_index_ = ArrayType::RuntimeTypeIndex();</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; ptr-&gt;deleter_ = Handler::Deleter();</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classmxnet_1_1runtime_1_1ObjectPtr.html">ObjectPtr&lt;ArrayType&gt;</a>(ptr);</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; }</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;};</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; </div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;<span class="comment">// Simple allocator that uses new/delete.</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"><a class="line" href="classmxnet_1_1runtime_1_1SimpleObjAllocator.html"> 99</a></span>&#160;<span class="keyword">class </span><a class="code" href="classmxnet_1_1runtime_1_1SimpleObjAllocator.html">SimpleObjAllocator</a> : <span class="keyword">public</span> <a class="code" href="classmxnet_1_1runtime_1_1ObjAllocatorBase.html">ObjAllocatorBase</a>&lt;SimpleObjAllocator&gt; {</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00102"></a><span class="lineno"><a class="line" href="classmxnet_1_1runtime_1_1SimpleObjAllocator_1_1Handler.html"> 102</a></span>&#160; <span class="keyword">class </span><a class="code" href="classmxnet_1_1runtime_1_1SimpleObjAllocator_1_1Handler.html">Handler</a> {</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00104"></a><span class="lineno"><a class="line" href="classmxnet_1_1runtime_1_1SimpleObjAllocator_1_1Handler.html#a9675916e50521abebe2401fd65a85dbe"> 104</a></span>&#160; <span class="keyword">using</span> <a class="code" href="classmxnet_1_1runtime_1_1SimpleObjAllocator_1_1Handler.html#a9675916e50521abebe2401fd65a85dbe">StorageType</a> = <span class="keyword">typename</span> std::aligned_storage&lt;<span class="keyword">sizeof</span>(T), <span class="keyword">alignof</span>(T)&gt;::type;</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; </div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span>... Args&gt;</div>
<div class="line"><a name="l00107"></a><span class="lineno"><a class="line" href="classmxnet_1_1runtime_1_1SimpleObjAllocator_1_1Handler.html#a45f4b0ea67ea544999562cff33016f6e"> 107</a></span>&#160; <span class="keyword">static</span> T* <a class="code" href="classmxnet_1_1runtime_1_1SimpleObjAllocator_1_1Handler.html#a45f4b0ea67ea544999562cff33016f6e">New</a>(<a class="code" href="classmxnet_1_1runtime_1_1SimpleObjAllocator.html">SimpleObjAllocator</a>*, Args&amp;&amp;... args) {</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; <span class="comment">// NOTE: the first argument is not needed for SimpleObjAllocator</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <span class="comment">// It is reserved for special allocators that needs to recycle</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; <span class="comment">// the object to itself (e.g. in the case of object pool).</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; <span class="comment">// In the case of an object pool, an allocator needs to create</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; <span class="comment">// a special chunk memory that hides reference to the allocator</span></div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; <span class="comment">// and call allocator&#39;s release function in the deleter.</span></div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; </div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; <span class="comment">// NOTE2: Use inplace new to allocate</span></div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; <span class="comment">// This is used to get rid of warning when deleting a virtual</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; <span class="comment">// class with non-virtual destructor.</span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; <span class="comment">// We are fine here as we captured the right deleter during construction.</span></div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; <span class="comment">// This is also the right way to get storage type for an object pool.</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; <a class="code" href="classmxnet_1_1runtime_1_1SimpleObjAllocator_1_1Handler.html#a9675916e50521abebe2401fd65a85dbe">StorageType</a>* data = <span class="keyword">new</span> <a class="code" href="classmxnet_1_1runtime_1_1SimpleObjAllocator_1_1Handler.html#a9675916e50521abebe2401fd65a85dbe">StorageType</a>();</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; <span class="keyword">new</span> (data) T(std::forward&lt;Args&gt;(args)...);</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <span class="keywordflow">return</span> <span class="keyword">reinterpret_cast&lt;</span>T*<span class="keyword">&gt;</span>(data);</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; }</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; </div>
<div class="line"><a name="l00126"></a><span class="lineno"><a class="line" href="classmxnet_1_1runtime_1_1SimpleObjAllocator_1_1Handler.html#a11c9ea3f7d2de3049292b9353c72a99b"> 126</a></span>&#160; <span class="keyword">static</span> <a class="code" href="classmxnet_1_1runtime_1_1Object.html#a0fab6c32914322b17bca50b3abc29a4a">Object::FDeleter</a> <a class="code" href="classmxnet_1_1runtime_1_1SimpleObjAllocator_1_1Handler.html#a11c9ea3f7d2de3049292b9353c72a99b">Deleter</a>() {</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; <span class="keywordflow">return</span> Deleter_;</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; }</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; </div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> Deleter_(<a class="code" href="classmxnet_1_1runtime_1_1Object.html">Object</a>* objptr) {</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; <span class="comment">// NOTE: this is important to cast back to T*</span></div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; <span class="comment">// because objptr and tptr may not be the same</span></div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; <span class="comment">// depending on how sub-class allocates the space.</span></div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; T* tptr = <span class="keyword">static_cast&lt;</span>T*<span class="keyword">&gt;</span>(objptr);</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; <span class="comment">// It is important to do tptr-&gt;T::~T(),</span></div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; <span class="comment">// so that we explicitly call the specific destructor</span></div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; <span class="comment">// instead of tptr-&gt;~T(), which could mean the intention</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; <span class="comment">// call a virtual destructor(which may not be available and is not required).</span></div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; tptr-&gt;T::~T();</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; <span class="keyword">delete</span> <span class="keyword">reinterpret_cast&lt;</span><a class="code" href="classmxnet_1_1runtime_1_1SimpleObjAllocator_1_1Handler.html#a9675916e50521abebe2401fd65a85dbe">StorageType</a>*<span class="keyword">&gt;</span>(tptr);</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; }</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; };</div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; </div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; <span class="comment">// Array handler that uses new/delete.</span></div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> ArrayType, <span class="keyword">typename</span> ElemType&gt;</div>
<div class="line"><a name="l00147"></a><span class="lineno"><a class="line" href="classmxnet_1_1runtime_1_1SimpleObjAllocator_1_1ArrayHandler.html"> 147</a></span>&#160; <span class="keyword">class </span><a class="code" href="classmxnet_1_1runtime_1_1SimpleObjAllocator_1_1ArrayHandler.html">ArrayHandler</a> {</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00149"></a><span class="lineno"><a class="line" href="classmxnet_1_1runtime_1_1SimpleObjAllocator_1_1ArrayHandler.html#a6200c13f3e395e2920565e9d8e0897d5"> 149</a></span>&#160; <span class="keyword">using</span> <a class="code" href="classmxnet_1_1runtime_1_1SimpleObjAllocator_1_1ArrayHandler.html#a6200c13f3e395e2920565e9d8e0897d5">StorageType</a> = <span class="keyword">typename</span> std::aligned_storage&lt;<span class="keyword">sizeof</span>(ArrayType), <span class="keyword">alignof</span>(ArrayType)&gt;::type;</div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160; <span class="comment">// for now only support elements that aligns with array header.</span></div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160; static_assert(<span class="keyword">alignof</span>(ArrayType) % <span class="keyword">alignof</span>(ElemType) == 0 &amp;&amp;</div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160; <span class="keyword">sizeof</span>(ArrayType) % <span class="keyword">alignof</span>(ElemType) == 0,</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; <span class="stringliteral">&quot;element alignment constraint&quot;</span>);</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160; </div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span>... Args&gt;</div>
<div class="line"><a name="l00156"></a><span class="lineno"><a class="line" href="classmxnet_1_1runtime_1_1SimpleObjAllocator_1_1ArrayHandler.html#a02bac792a169693945175cb47e4dfac9"> 156</a></span>&#160; <span class="keyword">static</span> ArrayType* <a class="code" href="classmxnet_1_1runtime_1_1SimpleObjAllocator_1_1ArrayHandler.html#a02bac792a169693945175cb47e4dfac9">New</a>(<a class="code" href="classmxnet_1_1runtime_1_1SimpleObjAllocator.html">SimpleObjAllocator</a>*, <span class="keywordtype">size_t</span> num_elems, Args&amp;&amp;... args) {</div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160; <span class="comment">// NOTE: the first argument is not needed for ArrayObjAllocator</span></div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160; <span class="comment">// It is reserved for special allocators that needs to recycle</span></div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160; <span class="comment">// the object to itself (e.g. in the case of object pool).</span></div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160; <span class="comment">// In the case of an object pool, an allocator needs to create</span></div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160; <span class="comment">// a special chunk memory that hides reference to the allocator</span></div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160; <span class="comment">// and call allocator&#39;s release function in the deleter.</span></div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160; <span class="comment">// NOTE2: Use inplace new to allocate</span></div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160; <span class="comment">// This is used to get rid of warning when deleting a virtual</span></div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; <span class="comment">// class with non-virtual destructor.</span></div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160; <span class="comment">// We are fine here as we captured the right deleter during construction.</span></div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160; <span class="comment">// This is also the right way to get storage type for an object pool.</span></div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160; <span class="keywordtype">size_t</span> unit = <span class="keyword">sizeof</span>(<a class="code" href="classmxnet_1_1runtime_1_1SimpleObjAllocator_1_1ArrayHandler.html#a6200c13f3e395e2920565e9d8e0897d5">StorageType</a>);</div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160; <span class="keywordtype">size_t</span> requested_size = num_elems * <span class="keyword">sizeof</span>(ElemType) + <span class="keyword">sizeof</span>(ArrayType);</div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160; <span class="keywordtype">size_t</span> num_storage_slots = (requested_size + unit - 1) / unit;</div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160; <a class="code" href="classmxnet_1_1runtime_1_1SimpleObjAllocator_1_1ArrayHandler.html#a6200c13f3e395e2920565e9d8e0897d5">StorageType</a>* data = <span class="keyword">new</span> <a class="code" href="classmxnet_1_1runtime_1_1SimpleObjAllocator_1_1ArrayHandler.html#a6200c13f3e395e2920565e9d8e0897d5">StorageType</a>[num_storage_slots];</div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160; <span class="keyword">new</span> (data) ArrayType(std::forward&lt;Args&gt;(args)...);</div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160; <span class="keywordflow">return</span> <span class="keyword">reinterpret_cast&lt;</span>ArrayType*<span class="keyword">&gt;</span>(data);</div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160; }</div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160; </div>
<div class="line"><a name="l00177"></a><span class="lineno"><a class="line" href="classmxnet_1_1runtime_1_1SimpleObjAllocator_1_1ArrayHandler.html#a049b37ea66afe1ad1b5168e7bbe6f917"> 177</a></span>&#160; <span class="keyword">static</span> <a class="code" href="classmxnet_1_1runtime_1_1Object.html#a0fab6c32914322b17bca50b3abc29a4a">Object::FDeleter</a> <a class="code" href="classmxnet_1_1runtime_1_1SimpleObjAllocator_1_1ArrayHandler.html#a049b37ea66afe1ad1b5168e7bbe6f917">Deleter</a>() {</div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160; <span class="keywordflow">return</span> Deleter_;</div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160; }</div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160; </div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> Deleter_(<a class="code" href="classmxnet_1_1runtime_1_1Object.html">Object</a>* objptr) {</div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160; <span class="comment">// NOTE: this is important to cast back to ArrayType*</span></div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160; <span class="comment">// because objptr and tptr may not be the same</span></div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160; <span class="comment">// depending on how sub-class allocates the space.</span></div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160; ArrayType* tptr = <span class="keyword">static_cast&lt;</span>ArrayType*<span class="keyword">&gt;</span>(objptr);</div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>&#160; <span class="comment">// It is important to do tptr-&gt;ArrayType::~ArrayType(),</span></div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160; <span class="comment">// so that we explicitly call the specific destructor</span></div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160; <span class="comment">// instead of tptr-&gt;~ArrayType(), which could mean the intention</span></div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160; <span class="comment">// call a virtual destructor(which may not be available and is not required).</span></div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span>&#160; tptr-&gt;ArrayType::~ArrayType();</div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>&#160; <a class="code" href="classmxnet_1_1runtime_1_1SimpleObjAllocator_1_1ArrayHandler.html#a6200c13f3e395e2920565e9d8e0897d5">StorageType</a>* p = <span class="keyword">reinterpret_cast&lt;</span><a class="code" href="classmxnet_1_1runtime_1_1SimpleObjAllocator_1_1ArrayHandler.html#a6200c13f3e395e2920565e9d8e0897d5">StorageType</a>*<span class="keyword">&gt;</span>(tptr);</div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>&#160; <span class="keyword">delete</span>[] p;</div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>&#160; }</div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>&#160; };</div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>&#160;};</div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span>&#160; </div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, <span class="keyword">typename</span>... Args&gt;</div>
<div class="line"><a name="l00199"></a><span class="lineno"><a class="line" href="namespacemxnet_1_1runtime.html#ae494b840652fdcee82babd1e3c71e629"> 199</a></span>&#160;<span class="keyword">inline</span> <a class="code" href="classmxnet_1_1runtime_1_1ObjectPtr.html">ObjectPtr&lt;T&gt;</a> <a class="code" href="namespacemxnet_1_1runtime.html#ae494b840652fdcee82babd1e3c71e629">make_object</a>(Args&amp;&amp;... args) {</div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classmxnet_1_1runtime_1_1SimpleObjAllocator.html">SimpleObjAllocator</a>().<a class="code" href="classmxnet_1_1runtime_1_1ObjAllocatorBase.html#aa5513f69a466de425c500600350aa5e6">make_object</a>&lt;T&gt;(std::forward&lt;Args&gt;(args)...);</div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>&#160;}</div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>&#160; </div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> ArrayType, <span class="keyword">typename</span> ElemType, <span class="keyword">typename</span>... Args&gt;</div>
<div class="line"><a name="l00204"></a><span class="lineno"><a class="line" href="namespacemxnet_1_1runtime.html#ac46e925eac8fa378c6362a3f61ae32ec"> 204</a></span>&#160;<span class="keyword">inline</span> <a class="code" href="classmxnet_1_1runtime_1_1ObjectPtr.html">ObjectPtr&lt;ArrayType&gt;</a> <a class="code" href="namespacemxnet_1_1runtime.html#ac46e925eac8fa378c6362a3f61ae32ec">make_inplace_array_object</a>(<span class="keywordtype">size_t</span> num_elems, Args&amp;&amp;... args) {</div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classmxnet_1_1runtime_1_1SimpleObjAllocator.html">SimpleObjAllocator</a>().<a class="code" href="classmxnet_1_1runtime_1_1ObjAllocatorBase.html#ae914a57fd55f72b586038c72f0005ba4">make_inplace_array</a>&lt;ArrayType, ElemType&gt;(num_elems,</div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span>&#160; std::forward&lt;Args&gt;(args)...);</div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>&#160;}</div>
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span>&#160; </div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>&#160;} <span class="comment">// namespace runtime</span></div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span>&#160;} <span class="comment">// namespace mxnet</span></div>
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span>&#160;<span class="preprocessor">#endif // MXNET_RUNTIME_MEMORY_H_</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="anamespacemxnet_html"><div class="ttname"><a href="namespacemxnet.html">mxnet</a></div><div class="ttdoc">namespace of mxnet</div><div class="ttdef"><b>Definition:</b> api_registry.h:33</div></div>
<div class="ttc" id="aclassmxnet_1_1runtime_1_1Object_html"><div class="ttname"><a href="classmxnet_1_1runtime_1_1Object.html">mxnet::runtime::Object</a></div><div class="ttdoc">base class of all object containers.</div><div class="ttdef"><b>Definition:</b> object.h:151</div></div>
<div class="ttc" id="aclassmxnet_1_1runtime_1_1SimpleObjAllocator_1_1Handler_html"><div class="ttname"><a href="classmxnet_1_1runtime_1_1SimpleObjAllocator_1_1Handler.html">mxnet::runtime::SimpleObjAllocator::Handler</a></div><div class="ttdef"><b>Definition:</b> memory.h:102</div></div>
<div class="ttc" id="aclassmxnet_1_1runtime_1_1Object_html_a0fab6c32914322b17bca50b3abc29a4a"><div class="ttname"><a href="classmxnet_1_1runtime_1_1Object.html#a0fab6c32914322b17bca50b3abc29a4a">mxnet::runtime::Object::FDeleter</a></div><div class="ttdeci">void(* FDeleter)(Object *self)</div><div class="ttdoc">Object deleter.</div><div class="ttdef"><b>Definition:</b> object.h:157</div></div>
<div class="ttc" id="aclassmxnet_1_1runtime_1_1ObjectPtr_html"><div class="ttname"><a href="classmxnet_1_1runtime_1_1ObjectPtr.html">mxnet::runtime::ObjectPtr</a></div><div class="ttdoc">A custom smart pointer for Object.</div><div class="ttdef"><b>Definition:</b> object.h:346</div></div>
<div class="ttc" id="anamespacemxnet_1_1runtime_html_ae494b840652fdcee82babd1e3c71e629"><div class="ttname"><a href="namespacemxnet_1_1runtime.html#ae494b840652fdcee82babd1e3c71e629">mxnet::runtime::make_object</a></div><div class="ttdeci">ObjectPtr&lt; T &gt; make_object(Args &amp;&amp;... args)</div><div class="ttdoc">Allocate an object using default allocator.</div><div class="ttdef"><b>Definition:</b> memory.h:199</div></div>
<div class="ttc" id="aclassmxnet_1_1runtime_1_1SimpleObjAllocator_1_1ArrayHandler_html"><div class="ttname"><a href="classmxnet_1_1runtime_1_1SimpleObjAllocator_1_1ArrayHandler.html">mxnet::runtime::SimpleObjAllocator::ArrayHandler</a></div><div class="ttdef"><b>Definition:</b> memory.h:147</div></div>
<div class="ttc" id="aclassmxnet_1_1runtime_1_1ObjAllocatorBase_html_aa5513f69a466de425c500600350aa5e6"><div class="ttname"><a href="classmxnet_1_1runtime_1_1ObjAllocatorBase.html#aa5513f69a466de425c500600350aa5e6">mxnet::runtime::ObjAllocatorBase::make_object</a></div><div class="ttdeci">ObjectPtr&lt; T &gt; make_object(Args &amp;&amp;... args)</div><div class="ttdoc">Make a new object using the allocator.</div><div class="ttdef"><b>Definition:</b> memory.h:69</div></div>
<div class="ttc" id="aclassmxnet_1_1runtime_1_1SimpleObjAllocator_1_1ArrayHandler_html_a6200c13f3e395e2920565e9d8e0897d5"><div class="ttname"><a href="classmxnet_1_1runtime_1_1SimpleObjAllocator_1_1ArrayHandler.html#a6200c13f3e395e2920565e9d8e0897d5">mxnet::runtime::SimpleObjAllocator::ArrayHandler::StorageType</a></div><div class="ttdeci">typename std::aligned_storage&lt; sizeof(ArrayType), alignof(ArrayType)&gt;::type StorageType</div><div class="ttdef"><b>Definition:</b> memory.h:149</div></div>
<div class="ttc" id="aclassmxnet_1_1runtime_1_1SimpleObjAllocator_1_1Handler_html_a9675916e50521abebe2401fd65a85dbe"><div class="ttname"><a href="classmxnet_1_1runtime_1_1SimpleObjAllocator_1_1Handler.html#a9675916e50521abebe2401fd65a85dbe">mxnet::runtime::SimpleObjAllocator::Handler::StorageType</a></div><div class="ttdeci">typename std::aligned_storage&lt; sizeof(T), alignof(T)&gt;::type StorageType</div><div class="ttdef"><b>Definition:</b> memory.h:104</div></div>
<div class="ttc" id="aclassmxnet_1_1runtime_1_1SimpleObjAllocator_html"><div class="ttname"><a href="classmxnet_1_1runtime_1_1SimpleObjAllocator.html">mxnet::runtime::SimpleObjAllocator</a></div><div class="ttdef"><b>Definition:</b> memory.h:99</div></div>
<div class="ttc" id="aclassmxnet_1_1runtime_1_1SimpleObjAllocator_1_1Handler_html_a45f4b0ea67ea544999562cff33016f6e"><div class="ttname"><a href="classmxnet_1_1runtime_1_1SimpleObjAllocator_1_1Handler.html#a45f4b0ea67ea544999562cff33016f6e">mxnet::runtime::SimpleObjAllocator::Handler::New</a></div><div class="ttdeci">static T * New(SimpleObjAllocator *, Args &amp;&amp;... args)</div><div class="ttdef"><b>Definition:</b> memory.h:107</div></div>
<div class="ttc" id="aclassmxnet_1_1runtime_1_1ObjAllocatorBase_html_ae914a57fd55f72b586038c72f0005ba4"><div class="ttname"><a href="classmxnet_1_1runtime_1_1ObjAllocatorBase.html#ae914a57fd55f72b586038c72f0005ba4">mxnet::runtime::ObjAllocatorBase::make_inplace_array</a></div><div class="ttdeci">ObjectPtr&lt; ArrayType &gt; make_inplace_array(size_t num_elems, Args &amp;&amp;... args)</div><div class="ttdef"><b>Definition:</b> memory.h:86</div></div>
<div class="ttc" id="aclassmxnet_1_1runtime_1_1ObjAllocatorBase_html"><div class="ttname"><a href="classmxnet_1_1runtime_1_1ObjAllocatorBase.html">mxnet::runtime::ObjAllocatorBase</a></div><div class="ttdoc">Base class of object allocators that implements make. Use curiously recurring template pattern.</div><div class="ttdef"><b>Definition:</b> memory.h:60</div></div>
<div class="ttc" id="aclassmxnet_1_1runtime_1_1SimpleObjAllocator_1_1ArrayHandler_html_a049b37ea66afe1ad1b5168e7bbe6f917"><div class="ttname"><a href="classmxnet_1_1runtime_1_1SimpleObjAllocator_1_1ArrayHandler.html#a049b37ea66afe1ad1b5168e7bbe6f917">mxnet::runtime::SimpleObjAllocator::ArrayHandler::Deleter</a></div><div class="ttdeci">static Object::FDeleter Deleter()</div><div class="ttdef"><b>Definition:</b> memory.h:177</div></div>
<div class="ttc" id="aclassmxnet_1_1runtime_1_1SimpleObjAllocator_1_1ArrayHandler_html_a02bac792a169693945175cb47e4dfac9"><div class="ttname"><a href="classmxnet_1_1runtime_1_1SimpleObjAllocator_1_1ArrayHandler.html#a02bac792a169693945175cb47e4dfac9">mxnet::runtime::SimpleObjAllocator::ArrayHandler::New</a></div><div class="ttdeci">static ArrayType * New(SimpleObjAllocator *, size_t num_elems, Args &amp;&amp;... args)</div><div class="ttdef"><b>Definition:</b> memory.h:156</div></div>
<div class="ttc" id="aclassmxnet_1_1runtime_1_1SimpleObjAllocator_1_1Handler_html_a11c9ea3f7d2de3049292b9353c72a99b"><div class="ttname"><a href="classmxnet_1_1runtime_1_1SimpleObjAllocator_1_1Handler.html#a11c9ea3f7d2de3049292b9353c72a99b">mxnet::runtime::SimpleObjAllocator::Handler::Deleter</a></div><div class="ttdeci">static Object::FDeleter Deleter()</div><div class="ttdef"><b>Definition:</b> memory.h:126</div></div>
<div class="ttc" id="anamespacemxnet_1_1runtime_html_ac46e925eac8fa378c6362a3f61ae32ec"><div class="ttname"><a href="namespacemxnet_1_1runtime.html#ac46e925eac8fa378c6362a3f61ae32ec">mxnet::runtime::make_inplace_array_object</a></div><div class="ttdeci">ObjectPtr&lt; ArrayType &gt; make_inplace_array_object(size_t num_elems, Args &amp;&amp;... args)</div><div class="ttdef"><b>Definition:</b> memory.h:204</div></div>
<div class="ttc" id="aobject_8h_html"><div class="ttname"><a href="object_8h.html">object.h</a></div><div class="ttdoc">A managed object in MXNet runtime.</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 5 2023 03:47:39 for mxnet by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>