blob: 129d29de7efd5be9d928028e0c3b7828fdcef60f [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/storage.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> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">storage.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="storage_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="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#ifndef MXNET_STORAGE_H_</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#define MXNET_STORAGE_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;memory&gt;</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#include &lt;vector&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="include_2mxnet_2base_8h.html">./base.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; </div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="storage_8h.html#ad57ab81de690e3650bd9a2b4a41ee200"> 34</a></span>&#160;<span class="preprocessor">#define MXNET_STORAGE_DEFAULT_PROFILER_SCOPE_CSTR &quot;&lt;unk&gt;:&quot;</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="storage_8h.html#add2379f3db79e75b126ec82866d6fbbd"> 35</a></span>&#160;<span class="preprocessor">#define MXNET_STORAGE_DEFAULT_NAME_CSTR &quot;unknown&quot;</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; </div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classmxnet_1_1Storage.html"> 40</a></span>&#160;<span class="keyword">class </span><a class="code" href="classmxnet_1_1Storage.html">Storage</a> {</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="structmxnet_1_1Storage_1_1SyncObj.html"> 45</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structmxnet_1_1Storage_1_1SyncObj.html">SyncObj</a> {</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="preprocessor">#if MXNET_USE_CUDA</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; </div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="structmxnet_1_1Storage_1_1SyncObj.html#a2552c2bc028c50cbb1f291a7b3820da3"> 50</a></span>&#160; std::vector&lt;std::weak_ptr&lt;cudaEvent_t&gt;&gt; <a class="code" href="structmxnet_1_1Storage_1_1SyncObj.html#a2552c2bc028c50cbb1f291a7b3820da3">events</a>;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; };</div>
<div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="structmxnet_1_1Storage_1_1Handle.html"> 56</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structmxnet_1_1Storage_1_1Handle.html">Handle</a> {</div>
<div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="structmxnet_1_1Storage_1_1Handle.html#a428e25a6317e50c8b55307c96f8ec595"> 60</a></span>&#160; <span class="keywordtype">void</span>* <a class="code" href="structmxnet_1_1Storage_1_1Handle.html#a428e25a6317e50c8b55307c96f8ec595">dptr</a>{<span class="keyword">nullptr</span>};</div>
<div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="structmxnet_1_1Storage_1_1Handle.html#ab93b9db0c83e4ef3803fb587377a74a0"> 64</a></span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="structmxnet_1_1Storage_1_1Handle.html#ab93b9db0c83e4ef3803fb587377a74a0">size</a>{0};</div>
<div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="structmxnet_1_1Storage_1_1Handle.html#ae0a4202582aa12a598f5c55ef51ad4c8"> 68</a></span>&#160; <a class="code" href="structmxnet_1_1Context.html">Context</a> <a class="code" href="structmxnet_1_1Storage_1_1Handle.html#ae0a4202582aa12a598f5c55ef51ad4c8">ctx</a>;</div>
<div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="structmxnet_1_1Storage_1_1Handle.html#ac92111bc6d73d7402331615506684b74"> 72</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="structmxnet_1_1Storage_1_1Handle.html#ac92111bc6d73d7402331615506684b74">shared_pid</a>{-1};</div>
<div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="structmxnet_1_1Storage_1_1Handle.html#ad938f8d0ddba567350ee7b3aae14b4c1"> 73</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="structmxnet_1_1Storage_1_1Handle.html#ad938f8d0ddba567350ee7b3aae14b4c1">shared_id</a>{-1};</div>
<div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="structmxnet_1_1Storage_1_1Handle.html#a774b62c70d76375a42f7ceb0ef77937b"> 77</a></span>&#160; std::string <a class="code" href="structmxnet_1_1Storage_1_1Handle.html#a774b62c70d76375a42f7ceb0ef77937b">profiler_scope</a>{<a class="code" href="storage_8h.html#ad57ab81de690e3650bd9a2b4a41ee200">MXNET_STORAGE_DEFAULT_PROFILER_SCOPE_CSTR</a>};</div>
<div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="structmxnet_1_1Storage_1_1Handle.html#a2d9f23103aa59934065b286c86b438c2"> 78</a></span>&#160; std::string <a class="code" href="structmxnet_1_1Storage_1_1Handle.html#a2d9f23103aa59934065b286c86b438c2">name</a>{<a class="code" href="storage_8h.html#add2379f3db79e75b126ec82866d6fbbd">MXNET_STORAGE_DEFAULT_NAME_CSTR</a>};</div>
<div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="structmxnet_1_1Storage_1_1Handle.html#a57a4d06daf1c3f4c7fd0acc4b00df7c6"> 83</a></span>&#160; <a class="code" href="structmxnet_1_1Storage_1_1SyncObj.html">SyncObj</a> <a class="code" href="structmxnet_1_1Storage_1_1Handle.html#a57a4d06daf1c3f4c7fd0acc4b00df7c6">sync_obj</a>;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; };</div>
<div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="classmxnet_1_1Storage.html#afc59309d033f5c09256e042d285eb00d"> 92</a></span>&#160; <a class="code" href="structmxnet_1_1Storage_1_1Handle.html">Handle</a> <a class="code" href="classmxnet_1_1Storage.html#afc59309d033f5c09256e042d285eb00d">Alloc</a>(<span class="keywordtype">size_t</span> size, <a class="code" href="structmxnet_1_1Context.html">Context</a> ctx, <span class="keywordtype">bool</span> failsafe = <span class="keyword">false</span>) {</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <a class="code" href="structmxnet_1_1Storage_1_1Handle.html">Handle</a> hd;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; hd.<a class="code" href="structmxnet_1_1Storage_1_1Handle.html#ab93b9db0c83e4ef3803fb587377a74a0">size</a> = size;</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; hd.<a class="code" href="structmxnet_1_1Storage_1_1Handle.html#ae0a4202582aa12a598f5c55ef51ad4c8">ctx</a> = ctx;</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; this-&gt;<a class="code" href="classmxnet_1_1Storage.html#afc59309d033f5c09256e042d285eb00d">Alloc</a>(&amp;hd, failsafe);</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="keywordflow">return</span> hd;</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; }</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1Storage.html#afc59309d033f5c09256e042d285eb00d">Alloc</a>(Handle* handle, <span class="keywordtype">bool</span> failsafe = <span class="keyword">false</span>) = 0;</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1Storage.html#a3e3f3e3e3e3d867e77d0c3efd0e958b7">SharedIncrementRefCount</a>(Handle handle) = 0;</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1Storage.html#a5bdbd7b3ab712cd9e087ab007bdc64dd">Free</a>(Handle handle) = 0;</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1Storage.html#a098f8ebacd25f5203b2dc4c1796aec64">DirectFree</a>(Handle handle) = 0;</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1Storage.html#a7d2ece2d122d0bcdddf19e49d191f301">ReleaseAll</a>(<a class="code" href="structmxnet_1_1Context.html">Context</a> ctx) = 0;</div>
<div class="line"><a name="l00135"></a><span class="lineno"><a class="line" href="classmxnet_1_1Storage.html#af1e1bfea9236ccfba64344226416b04a"> 135</a></span>&#160; <span class="keyword">virtual</span> <a class="code" href="classmxnet_1_1Storage.html#af1e1bfea9236ccfba64344226416b04a">~Storage</a>() {}</div>
<div class="line"><a name="l00139"></a><span class="lineno"><a class="line" href="classmxnet_1_1Storage.html#ac12e7740df4520d6267d250ca16404d4"> 139</a></span>&#160; std::mutex&amp; <a class="code" href="classmxnet_1_1Storage.html#ac12e7740df4520d6267d250ca16404d4">GetMutex</a>(<a class="code" href="structmxnet_1_1Context.html#a611c227b5e04a2777c3e4507bb76f60e">Context::DeviceType</a> dev) {</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; <span class="keywordflow">if</span> (dev == <a class="code" href="structmxnet_1_1Context.html#a611c227b5e04a2777c3e4507bb76f60ea1aced5778bb0d64d4ce6bd4c0a86d140">Context::kCPU</a>) {</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; <span class="keywordflow">return</span> cpu_mutex_;</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; <span class="keywordflow">return</span> gpu_mutex_;</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; }</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; <span class="keyword">static</span> <a class="code" href="classmxnet_1_1Storage.html">Storage</a>* <a class="code" href="classmxnet_1_1Storage.html#a96abc072908d72d3271360a7e3e4bbc2">Get</a>();</div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> std::shared_ptr&lt;Storage&gt;&amp; <a class="code" href="classmxnet_1_1Storage.html#a907a5a784cf3231cf9cf9bd777a3b36e">_GetSharedRef</a>();</div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160; </div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160; std::mutex cpu_mutex_;</div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160; std::mutex gpu_mutex_;</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160;}; <span class="comment">// class Storage</span></div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160;} <span class="comment">// namespace mxnet</span></div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160;<span class="preprocessor">#endif // MXNET_STORAGE_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="astorage_8h_html_ad57ab81de690e3650bd9a2b4a41ee200"><div class="ttname"><a href="storage_8h.html#ad57ab81de690e3650bd9a2b4a41ee200">MXNET_STORAGE_DEFAULT_PROFILER_SCOPE_CSTR</a></div><div class="ttdeci">#define MXNET_STORAGE_DEFAULT_PROFILER_SCOPE_CSTR</div><div class="ttdef"><b>Definition:</b> storage.h:34</div></div>
<div class="ttc" id="astructmxnet_1_1Context_html_a611c227b5e04a2777c3e4507bb76f60ea1aced5778bb0d64d4ce6bd4c0a86d140"><div class="ttname"><a href="structmxnet_1_1Context.html#a611c227b5e04a2777c3e4507bb76f60ea1aced5778bb0d64d4ce6bd4c0a86d140">mxnet::Context::kCPU</a></div><div class="ttdeci">@ kCPU</div><div class="ttdef"><b>Definition:</b> base.h:93</div></div>
<div class="ttc" id="astructmxnet_1_1Storage_1_1SyncObj_html_a2552c2bc028c50cbb1f291a7b3820da3"><div class="ttname"><a href="structmxnet_1_1Storage_1_1SyncObj.html#a2552c2bc028c50cbb1f291a7b3820da3">mxnet::Storage::SyncObj::events</a></div><div class="ttdeci">std::vector&lt; std::weak_ptr&lt; cudaEvent_t &gt; &gt; events</div><div class="ttdoc">All the events from the engine variable.</div><div class="ttdef"><b>Definition:</b> storage.h:50</div></div>
<div class="ttc" id="astructmxnet_1_1Storage_1_1Handle_html_a428e25a6317e50c8b55307c96f8ec595"><div class="ttname"><a href="structmxnet_1_1Storage_1_1Handle.html#a428e25a6317e50c8b55307c96f8ec595">mxnet::Storage::Handle::dptr</a></div><div class="ttdeci">void * dptr</div><div class="ttdoc">Pointer to the data.</div><div class="ttdef"><b>Definition:</b> storage.h:60</div></div>
<div class="ttc" id="aclassmxnet_1_1Storage_html_ac12e7740df4520d6267d250ca16404d4"><div class="ttname"><a href="classmxnet_1_1Storage.html#ac12e7740df4520d6267d250ca16404d4">mxnet::Storage::GetMutex</a></div><div class="ttdeci">std::mutex &amp; GetMutex(Context::DeviceType dev)</div><div class="ttdoc">Returns mutex used by storage manager.</div><div class="ttdef"><b>Definition:</b> storage.h:139</div></div>
<div class="ttc" id="aclassmxnet_1_1Storage_html_a96abc072908d72d3271360a7e3e4bbc2"><div class="ttname"><a href="classmxnet_1_1Storage.html#a96abc072908d72d3271360a7e3e4bbc2">mxnet::Storage::Get</a></div><div class="ttdeci">static Storage * Get()</div></div>
<div class="ttc" id="astorage_8h_html_add2379f3db79e75b126ec82866d6fbbd"><div class="ttname"><a href="storage_8h.html#add2379f3db79e75b126ec82866d6fbbd">MXNET_STORAGE_DEFAULT_NAME_CSTR</a></div><div class="ttdeci">#define MXNET_STORAGE_DEFAULT_NAME_CSTR</div><div class="ttdef"><b>Definition:</b> storage.h:35</div></div>
<div class="ttc" id="aclassmxnet_1_1Storage_html_a7d2ece2d122d0bcdddf19e49d191f301"><div class="ttname"><a href="classmxnet_1_1Storage.html#a7d2ece2d122d0bcdddf19e49d191f301">mxnet::Storage::ReleaseAll</a></div><div class="ttdeci">virtual void ReleaseAll(Context ctx)=0</div><div class="ttdoc">Release all memory from device if using a pooled storage manager.</div></div>
<div class="ttc" id="aclassmxnet_1_1Storage_html_af1e1bfea9236ccfba64344226416b04a"><div class="ttname"><a href="classmxnet_1_1Storage.html#af1e1bfea9236ccfba64344226416b04a">mxnet::Storage::~Storage</a></div><div class="ttdeci">virtual ~Storage()</div><div class="ttdoc">Destructor.</div><div class="ttdef"><b>Definition:</b> storage.h:135</div></div>
<div class="ttc" id="astructmxnet_1_1Storage_1_1Handle_html_ab93b9db0c83e4ef3803fb587377a74a0"><div class="ttname"><a href="structmxnet_1_1Storage_1_1Handle.html#ab93b9db0c83e4ef3803fb587377a74a0">mxnet::Storage::Handle::size</a></div><div class="ttdeci">size_t size</div><div class="ttdoc">Size of the storage.</div><div class="ttdef"><b>Definition:</b> storage.h:64</div></div>
<div class="ttc" id="aclassmxnet_1_1Storage_html_a907a5a784cf3231cf9cf9bd777a3b36e"><div class="ttname"><a href="classmxnet_1_1Storage.html#a907a5a784cf3231cf9cf9bd777a3b36e">mxnet::Storage::_GetSharedRef</a></div><div class="ttdeci">static const std::shared_ptr&lt; Storage &gt; &amp; _GetSharedRef()</div><div class="ttdoc">Get shared pointer reference to storage singleton. Most user should not call this function....</div></div>
<div class="ttc" id="astructmxnet_1_1Storage_1_1SyncObj_html"><div class="ttname"><a href="structmxnet_1_1Storage_1_1SyncObj.html">mxnet::Storage::SyncObj</a></div><div class="ttdoc">Storage sync object.</div><div class="ttdef"><b>Definition:</b> storage.h:45</div></div>
<div class="ttc" id="astructmxnet_1_1Storage_1_1Handle_html_a57a4d06daf1c3f4c7fd0acc4b00df7c6"><div class="ttname"><a href="structmxnet_1_1Storage_1_1Handle.html#a57a4d06daf1c3f4c7fd0acc4b00df7c6">mxnet::Storage::Handle::sync_obj</a></div><div class="ttdeci">SyncObj sync_obj</div><div class="ttdoc">Used to pass events back and forth between the engine Var and the storage manager.</div><div class="ttdef"><b>Definition:</b> storage.h:83</div></div>
<div class="ttc" id="astructmxnet_1_1Context_html_a611c227b5e04a2777c3e4507bb76f60e"><div class="ttname"><a href="structmxnet_1_1Context.html#a611c227b5e04a2777c3e4507bb76f60e">mxnet::Context::DeviceType</a></div><div class="ttdeci">DeviceType</div><div class="ttdoc">Type of device.</div><div class="ttdef"><b>Definition:</b> base.h:92</div></div>
<div class="ttc" id="astructmxnet_1_1Storage_1_1Handle_html"><div class="ttname"><a href="structmxnet_1_1Storage_1_1Handle.html">mxnet::Storage::Handle</a></div><div class="ttdoc">Storage handle.</div><div class="ttdef"><b>Definition:</b> storage.h:56</div></div>
<div class="ttc" id="aclassmxnet_1_1Storage_html_a3e3f3e3e3e3d867e77d0c3efd0e958b7"><div class="ttname"><a href="classmxnet_1_1Storage.html#a3e3f3e3e3e3d867e77d0c3efd0e958b7">mxnet::Storage::SharedIncrementRefCount</a></div><div class="ttdeci">virtual void SharedIncrementRefCount(Handle handle)=0</div><div class="ttdoc">Increase ref counter on shared memory.</div></div>
<div class="ttc" id="astructmxnet_1_1Storage_1_1Handle_html_ac92111bc6d73d7402331615506684b74"><div class="ttname"><a href="structmxnet_1_1Storage_1_1Handle.html#ac92111bc6d73d7402331615506684b74">mxnet::Storage::Handle::shared_pid</a></div><div class="ttdeci">int shared_pid</div><div class="ttdoc">Id for IPC shared memory.</div><div class="ttdef"><b>Definition:</b> storage.h:72</div></div>
<div class="ttc" id="astructmxnet_1_1Context_html"><div class="ttname"><a href="structmxnet_1_1Context.html">mxnet::Context</a></div><div class="ttdoc">Context information about the execution environment.</div><div class="ttdef"><b>Definition:</b> base.h:90</div></div>
<div class="ttc" id="astructmxnet_1_1Storage_1_1Handle_html_a2d9f23103aa59934065b286c86b438c2"><div class="ttname"><a href="structmxnet_1_1Storage_1_1Handle.html#a2d9f23103aa59934065b286c86b438c2">mxnet::Storage::Handle::name</a></div><div class="ttdeci">std::string name</div><div class="ttdef"><b>Definition:</b> storage.h:78</div></div>
<div class="ttc" id="aclassmxnet_1_1Storage_html_a5bdbd7b3ab712cd9e087ab007bdc64dd"><div class="ttname"><a href="classmxnet_1_1Storage.html#a5bdbd7b3ab712cd9e087ab007bdc64dd">mxnet::Storage::Free</a></div><div class="ttdeci">virtual void Free(Handle handle)=0</div><div class="ttdoc">Free storage.</div></div>
<div class="ttc" id="astructmxnet_1_1Storage_1_1Handle_html_a774b62c70d76375a42f7ceb0ef77937b"><div class="ttname"><a href="structmxnet_1_1Storage_1_1Handle.html#a774b62c70d76375a42f7ceb0ef77937b">mxnet::Storage::Handle::profiler_scope</a></div><div class="ttdeci">std::string profiler_scope</div><div class="ttdoc">Attributes for tracking storage allocations.</div><div class="ttdef"><b>Definition:</b> storage.h:77</div></div>
<div class="ttc" id="astructmxnet_1_1Storage_1_1Handle_html_ae0a4202582aa12a598f5c55ef51ad4c8"><div class="ttname"><a href="structmxnet_1_1Storage_1_1Handle.html#ae0a4202582aa12a598f5c55ef51ad4c8">mxnet::Storage::Handle::ctx</a></div><div class="ttdeci">Context ctx</div><div class="ttdoc">Context information about device and ID.</div><div class="ttdef"><b>Definition:</b> storage.h:68</div></div>
<div class="ttc" id="aclassmxnet_1_1Storage_html_afc59309d033f5c09256e042d285eb00d"><div class="ttname"><a href="classmxnet_1_1Storage.html#afc59309d033f5c09256e042d285eb00d">mxnet::Storage::Alloc</a></div><div class="ttdeci">Handle Alloc(size_t size, Context ctx, bool failsafe=false)</div><div class="ttdoc">Allocate a new contiguous memory for a given size.</div><div class="ttdef"><b>Definition:</b> storage.h:92</div></div>
<div class="ttc" id="astructmxnet_1_1Storage_1_1Handle_html_ad938f8d0ddba567350ee7b3aae14b4c1"><div class="ttname"><a href="structmxnet_1_1Storage_1_1Handle.html#ad938f8d0ddba567350ee7b3aae14b4c1">mxnet::Storage::Handle::shared_id</a></div><div class="ttdeci">int shared_id</div><div class="ttdef"><b>Definition:</b> storage.h:73</div></div>
<div class="ttc" id="aclassmxnet_1_1Storage_html"><div class="ttname"><a href="classmxnet_1_1Storage.html">mxnet::Storage</a></div><div class="ttdoc">Storage manager across multiple devices.</div><div class="ttdef"><b>Definition:</b> storage.h:40</div></div>
<div class="ttc" id="ainclude_2mxnet_2base_8h_html"><div class="ttname"><a href="include_2mxnet_2base_8h.html">base.h</a></div><div class="ttdoc">configuration of MXNet as well as basic data structure.</div></div>
<div class="ttc" id="aclassmxnet_1_1Storage_html_a098f8ebacd25f5203b2dc4c1796aec64"><div class="ttname"><a href="classmxnet_1_1Storage.html#a098f8ebacd25f5203b2dc4c1796aec64">mxnet::Storage::DirectFree</a></div><div class="ttdeci">virtual void DirectFree(Handle handle)=0</div><div class="ttdoc">Free storage directly, without putting it into memory pool. This can synchronization of all previous ...</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 5 2023 03:47:40 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>