| <!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: mxnet::Storage Class Reference</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&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> |
| <!-- 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="namespacemxnet.html">mxnet</a></li><li class="navelem"><a class="el" href="classmxnet_1_1Storage.html">Storage</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="classmxnet_1_1Storage-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">mxnet::Storage Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><a class="el" href="classmxnet_1_1Storage.html" title="Storage manager across multiple devices.">Storage</a> manager across multiple devices. |
| <a href="classmxnet_1_1Storage.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="storage_8h_source.html">storage.h</a>></code></p> |
| <div class="dynheader"> |
| Collaboration diagram for mxnet::Storage:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classmxnet_1_1Storage__coll__graph.png" border="0" usemap="#mxnet_1_1Storage_coll__map" alt="Collaboration graph"/></div> |
| <!-- MAP 0 --> |
| </div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> |
| Classes</h2></td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Storage_1_1Handle.html">Handle</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classmxnet_1_1Storage.html" title="Storage manager across multiple devices.">Storage</a> handle. <a href="structmxnet_1_1Storage_1_1Handle.html#details">More...</a><br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Storage_1_1SyncObj.html">SyncObj</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classmxnet_1_1Storage.html" title="Storage manager across multiple devices.">Storage</a> sync object. <a href="structmxnet_1_1Storage_1_1SyncObj.html#details">More...</a><br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:afc59309d033f5c09256e042d285eb00d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmxnet_1_1Storage_1_1Handle.html">Handle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Storage.html#afc59309d033f5c09256e042d285eb00d">Alloc</a> (size_t size, <a class="el" href="structmxnet_1_1Context.html">Context</a> ctx, bool failsafe=false)</td></tr> |
| <tr class="memdesc:afc59309d033f5c09256e042d285eb00d"><td class="mdescLeft"> </td><td class="mdescRight">Allocate a new contiguous memory for a given size. <a href="classmxnet_1_1Storage.html#afc59309d033f5c09256e042d285eb00d">More...</a><br /></td></tr> |
| <tr class="separator:afc59309d033f5c09256e042d285eb00d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a051cfe0b4dd91ea93c21b36aba7a0417"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Storage.html#a051cfe0b4dd91ea93c21b36aba7a0417">Alloc</a> (<a class="el" href="structmxnet_1_1Storage_1_1Handle.html">Handle</a> *handle, bool failsafe=false)=0</td></tr> |
| <tr class="memdesc:a051cfe0b4dd91ea93c21b36aba7a0417"><td class="mdescLeft"> </td><td class="mdescRight">Allocate a new contiguous memory for a given size. <a href="classmxnet_1_1Storage.html#a051cfe0b4dd91ea93c21b36aba7a0417">More...</a><br /></td></tr> |
| <tr class="separator:a051cfe0b4dd91ea93c21b36aba7a0417"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3e3f3e3e3e3d867e77d0c3efd0e958b7"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Storage.html#a3e3f3e3e3e3d867e77d0c3efd0e958b7">SharedIncrementRefCount</a> (<a class="el" href="structmxnet_1_1Storage_1_1Handle.html">Handle</a> handle)=0</td></tr> |
| <tr class="memdesc:a3e3f3e3e3e3d867e77d0c3efd0e958b7"><td class="mdescLeft"> </td><td class="mdescRight">Increase ref counter on shared memory. <a href="classmxnet_1_1Storage.html#a3e3f3e3e3e3d867e77d0c3efd0e958b7">More...</a><br /></td></tr> |
| <tr class="separator:a3e3f3e3e3e3d867e77d0c3efd0e958b7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5bdbd7b3ab712cd9e087ab007bdc64dd"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Storage.html#a5bdbd7b3ab712cd9e087ab007bdc64dd">Free</a> (<a class="el" href="structmxnet_1_1Storage_1_1Handle.html">Handle</a> handle)=0</td></tr> |
| <tr class="memdesc:a5bdbd7b3ab712cd9e087ab007bdc64dd"><td class="mdescLeft"> </td><td class="mdescRight">Free storage. <a href="classmxnet_1_1Storage.html#a5bdbd7b3ab712cd9e087ab007bdc64dd">More...</a><br /></td></tr> |
| <tr class="separator:a5bdbd7b3ab712cd9e087ab007bdc64dd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a098f8ebacd25f5203b2dc4c1796aec64"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Storage.html#a098f8ebacd25f5203b2dc4c1796aec64">DirectFree</a> (<a class="el" href="structmxnet_1_1Storage_1_1Handle.html">Handle</a> handle)=0</td></tr> |
| <tr class="memdesc:a098f8ebacd25f5203b2dc4c1796aec64"><td class="mdescLeft"> </td><td class="mdescRight">Free storage directly, without putting it into memory pool. This can synchronization of all previous runned device functions. <a href="classmxnet_1_1Storage.html#a098f8ebacd25f5203b2dc4c1796aec64">More...</a><br /></td></tr> |
| <tr class="separator:a098f8ebacd25f5203b2dc4c1796aec64"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7d2ece2d122d0bcdddf19e49d191f301"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Storage.html#a7d2ece2d122d0bcdddf19e49d191f301">ReleaseAll</a> (<a class="el" href="structmxnet_1_1Context.html">Context</a> ctx)=0</td></tr> |
| <tr class="memdesc:a7d2ece2d122d0bcdddf19e49d191f301"><td class="mdescLeft"> </td><td class="mdescRight">Release all memory from device if using a pooled storage manager. <a href="classmxnet_1_1Storage.html#a7d2ece2d122d0bcdddf19e49d191f301">More...</a><br /></td></tr> |
| <tr class="separator:a7d2ece2d122d0bcdddf19e49d191f301"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af1e1bfea9236ccfba64344226416b04a"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Storage.html#af1e1bfea9236ccfba64344226416b04a">~Storage</a> ()</td></tr> |
| <tr class="memdesc:af1e1bfea9236ccfba64344226416b04a"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="classmxnet_1_1Storage.html#af1e1bfea9236ccfba64344226416b04a">More...</a><br /></td></tr> |
| <tr class="separator:af1e1bfea9236ccfba64344226416b04a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac12e7740df4520d6267d250ca16404d4"><td class="memItemLeft" align="right" valign="top">std::mutex & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Storage.html#ac12e7740df4520d6267d250ca16404d4">GetMutex</a> (<a class="el" href="structmxnet_1_1Context.html#a611c227b5e04a2777c3e4507bb76f60e">Context::DeviceType</a> dev)</td></tr> |
| <tr class="memdesc:ac12e7740df4520d6267d250ca16404d4"><td class="mdescLeft"> </td><td class="mdescRight">Returns mutex used by storage manager. <a href="classmxnet_1_1Storage.html#ac12e7740df4520d6267d250ca16404d4">More...</a><br /></td></tr> |
| <tr class="separator:ac12e7740df4520d6267d250ca16404d4"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:a96abc072908d72d3271360a7e3e4bbc2"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classmxnet_1_1Storage.html">Storage</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Storage.html#a96abc072908d72d3271360a7e3e4bbc2">Get</a> ()</td></tr> |
| <tr class="separator:a96abc072908d72d3271360a7e3e4bbc2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a907a5a784cf3231cf9cf9bd777a3b36e"><td class="memItemLeft" align="right" valign="top">static const std::shared_ptr< <a class="el" href="classmxnet_1_1Storage.html">Storage</a> > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Storage.html#a907a5a784cf3231cf9cf9bd777a3b36e">_GetSharedRef</a> ()</td></tr> |
| <tr class="memdesc:a907a5a784cf3231cf9cf9bd777a3b36e"><td class="mdescLeft"> </td><td class="mdescRight">Get shared pointer reference to storage singleton. Most user should not call this function. This function is called by another singleton X who requires <a class="el" href="classmxnet_1_1Storage.html" title="Storage manager across multiple devices.">Storage</a> to be destructed after X. <a href="classmxnet_1_1Storage.html#a907a5a784cf3231cf9cf9bd777a3b36e">More...</a><br /></td></tr> |
| <tr class="separator:a907a5a784cf3231cf9cf9bd777a3b36e"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p><a class="el" href="classmxnet_1_1Storage.html" title="Storage manager across multiple devices.">Storage</a> manager across multiple devices. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="af1e1bfea9236ccfba64344226416b04a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af1e1bfea9236ccfba64344226416b04a">◆ </a></span>~Storage()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual mxnet::Storage::~Storage </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Destructor. </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a907a5a784cf3231cf9cf9bd777a3b36e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a907a5a784cf3231cf9cf9bd777a3b36e">◆ </a></span>_GetSharedRef()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static const std::shared_ptr<<a class="el" href="classmxnet_1_1Storage.html">Storage</a>>& mxnet::Storage::_GetSharedRef </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get shared pointer reference to storage singleton. Most user should not call this function. This function is called by another singleton X who requires <a class="el" href="classmxnet_1_1Storage.html" title="Storage manager across multiple devices.">Storage</a> to be destructed after X. </p> |
| <dl class="section return"><dt>Returns</dt><dd>A shared pointer to <a class="el" href="classmxnet_1_1Storage.html" title="Storage manager across multiple devices.">Storage</a> singleton. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a051cfe0b4dd91ea93c21b36aba7a0417"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a051cfe0b4dd91ea93c21b36aba7a0417">◆ </a></span>Alloc() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void mxnet::Storage::Alloc </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structmxnet_1_1Storage_1_1Handle.html">Handle</a> * </td> |
| <td class="paramname"><em>handle</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>failsafe</em> = <code>false</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Allocate a new contiguous memory for a given size. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">handle</td><td>handle initialized with size and ctx </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="afc59309d033f5c09256e042d285eb00d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afc59309d033f5c09256e042d285eb00d">◆ </a></span>Alloc() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="structmxnet_1_1Storage_1_1Handle.html">Handle</a> mxnet::Storage::Alloc </td> |
| <td>(</td> |
| <td class="paramtype">size_t </td> |
| <td class="paramname"><em>size</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="structmxnet_1_1Context.html">Context</a> </td> |
| <td class="paramname"><em>ctx</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>failsafe</em> = <code>false</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Allocate a new contiguous memory for a given size. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">size</td><td>Total size of memory in bytes. </td></tr> |
| <tr><td class="paramname">ctx</td><td><a class="el" href="structmxnet_1_1Context.html" title="Context information about the execution environment.">Context</a> information about the device and ID. </td></tr> |
| <tr><td class="paramname">failsafe</td><td>Return a handle with a null dptr if out of memory, rather than exit. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="structmxnet_1_1Storage_1_1Handle.html" title="Storage handle.">Handle</a> struct. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a098f8ebacd25f5203b2dc4c1796aec64"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a098f8ebacd25f5203b2dc4c1796aec64">◆ </a></span>DirectFree()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void mxnet::Storage::DirectFree </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structmxnet_1_1Storage_1_1Handle.html">Handle</a> </td> |
| <td class="paramname"><em>handle</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Free storage directly, without putting it into memory pool. This can synchronization of all previous runned device functions. </p> |
| <p>This function is suitable for conatiner structure with requirement on upsizing in the beginning phase of the iteration.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">handle</td><td><a class="el" href="structmxnet_1_1Storage_1_1Handle.html" title="Storage handle.">Handle</a> struct. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a5bdbd7b3ab712cd9e087ab007bdc64dd"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5bdbd7b3ab712cd9e087ab007bdc64dd">◆ </a></span>Free()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void mxnet::Storage::Free </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structmxnet_1_1Storage_1_1Handle.html">Handle</a> </td> |
| <td class="paramname"><em>handle</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Free storage. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">handle</td><td><a class="el" href="structmxnet_1_1Storage_1_1Handle.html" title="Storage handle.">Handle</a> struct. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a96abc072908d72d3271360a7e3e4bbc2"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a96abc072908d72d3271360a7e3e4bbc2">◆ </a></span>Get()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="classmxnet_1_1Storage.html">Storage</a>* mxnet::Storage::Get </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="classmxnet_1_1Storage.html" title="Storage manager across multiple devices.">Storage</a> singleton. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ac12e7740df4520d6267d250ca16404d4"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac12e7740df4520d6267d250ca16404d4">◆ </a></span>GetMutex()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::mutex& mxnet::Storage::GetMutex </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structmxnet_1_1Context.html#a611c227b5e04a2777c3e4507bb76f60e">Context::DeviceType</a> </td> |
| <td class="paramname"><em>dev</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns mutex used by storage manager. </p> |
| |
| </div> |
| </div> |
| <a id="a7d2ece2d122d0bcdddf19e49d191f301"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7d2ece2d122d0bcdddf19e49d191f301">◆ </a></span>ReleaseAll()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void mxnet::Storage::ReleaseAll </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structmxnet_1_1Context.html">Context</a> </td> |
| <td class="paramname"><em>ctx</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Release all memory from device if using a pooled storage manager. </p> |
| <p>This release all memory from pool storage managers such as GPUPooledStorageManager and GPUPooledRoundedStorageManager. For non-pool memory managers this has no effect. </p> |
| |
| </div> |
| </div> |
| <a id="a3e3f3e3e3e3d867e77d0c3efd0e958b7"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3e3f3e3e3e3d867e77d0c3efd0e958b7">◆ </a></span>SharedIncrementRefCount()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void mxnet::Storage::SharedIncrementRefCount </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structmxnet_1_1Storage_1_1Handle.html">Handle</a> </td> |
| <td class="paramname"><em>handle</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Increase ref counter on shared memory. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">handle</td><td>handle to shared memory. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>/work/mxnet/include/mxnet/<a class="el" href="storage_8h_source.html">storage.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 5 2023 03:47:41 for mxnet by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.17 |
| </small></address> |
| </body> |
| </html> |
