blob: 1601f7a64bd9944fb0b600bf174c2ca368e1625a [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Apache Singa: /home/moaz/incubator-singa/include/singa/core/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">Apache Singa
</div>
<div id="projectbrief">A General Distributed Deep Learning Library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- 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_14a988756d30161f7e1f48b05d03905d.html">singa</a></li><li class="navelem"><a class="el" href="dir_0c57f5a0b2589d9cd025f1d3faf7a1ee.html">core</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">memory.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#ifndef SINGA_CORE_MEMORY_H_</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#define SINGA_CORE_MEMORY_H_</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &lt;mutex&gt;</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &lt;atomic&gt;</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &quot;singa/proto/core.pb.h&quot;</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &quot;singa/singa_config.h&quot;</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">#ifdef USE_CUDA</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#include &quot;cnmem.h&quot;</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</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="namespacesinga.html">singa</a> {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classsinga_1_1VirtualMemory.html"> 35</a></span>&#160;<span class="keyword">class </span><a class="code" href="classsinga_1_1VirtualMemory.html">VirtualMemory</a> {};</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classsinga_1_1DeviceMemPool.html"> 37</a></span>&#160;<span class="keyword">class </span><a class="code" href="classsinga_1_1DeviceMemPool.html">DeviceMemPool</a> {</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> Malloc(<span class="keywordtype">void</span>** ptr, <span class="keyword">const</span> <span class="keywordtype">size_t</span> size) = 0;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> Free(<span class="keywordtype">void</span>* ptr) = 0;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classsinga_1_1DeviceMemPool.html#a24963bb78608bd2d69df9d247f26ced0"> 43</a></span>&#160; <span class="keyword">virtual</span> std::pair&lt;size_t, size_t&gt; <a class="code" href="classsinga_1_1DeviceMemPool.html#a24963bb78608bd2d69df9d247f26ced0">GetMemUsage</a>() {</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordflow">return</span> std::make_pair(0u, 0u);</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; }</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keyword">virtual</span> ~<a class="code" href="classsinga_1_1DeviceMemPool.html">DeviceMemPool</a>(){};</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keyword">protected</span>:</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordtype">size_t</span> usage_;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="comment">// size_t init_size_ = 0, max_size_ = 0;</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;};</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="preprocessor">#ifdef USE_CUDA</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;<span class="keyword">class </span>CnMemPool : <span class="keyword">public</span> <a class="code" href="classsinga_1_1DeviceMemPool.html">DeviceMemPool</a> {</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="comment">// Create the mem pool by setting the devices [0, numDevices), and</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="comment">// initial pool size (MB), and max pool size (no effect currently).</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; CnMemPool(<span class="keywordtype">int</span> numDevices = 1, <span class="keywordtype">size_t</span> init_size = 256, <span class="keywordtype">size_t</span> max_size = 0);</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; CnMemPool(<span class="keyword">const</span> MemPoolConf&amp; conf);</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keywordtype">void</span> Malloc(<span class="keywordtype">void</span>** ptr, <span class="keyword">const</span> <span class="keywordtype">size_t</span> size);</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keywordtype">void</span> Free(<span class="keywordtype">void</span>* ptr);</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; std::pair&lt;size_t, size_t&gt; GetMemUsage() <span class="keyword">override</span>;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="comment">// release all memory and set cnmem manager to unintialized</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; ~CnMemPool();</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keyword">protected</span>:</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keywordtype">void</span> Init();</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; MemPoolConf conf_;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="comment">// whether the (global) memory pool has been initialized</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="keywordtype">bool</span> initialized_ = <span class="keyword">false</span>;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="comment">// lock on the initialized variable</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; std::mutex mtx_;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keyword">static</span> std::atomic&lt;int&gt; pool_count;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;};</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;<span class="keyword">class </span>CudaMemPool : <span class="keyword">public</span> <a class="code" href="classsinga_1_1DeviceMemPool.html">DeviceMemPool</a> {</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="keywordtype">void</span> Malloc(<span class="keywordtype">void</span>** ptr, <span class="keyword">const</span> <span class="keywordtype">size_t</span> size) <span class="keyword">override</span>;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keywordtype">void</span> Free(<span class="keywordtype">void</span>* ptr) <span class="keyword">override</span>;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;};</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;} <span class="comment">// namespace singa</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;<span class="preprocessor">#endif // SINGA_CORE_MEMORY_H_</span></div><div class="ttc" id="classsinga_1_1VirtualMemory_html"><div class="ttname"><a href="classsinga_1_1VirtualMemory.html">singa::VirtualMemory</a></div><div class="ttdoc">Manage device memory pool including garbage collection, memory opt. </div><div class="ttdef"><b>Definition:</b> memory.h:35</div></div>
<div class="ttc" id="classsinga_1_1DeviceMemPool_html_a24963bb78608bd2d69df9d247f26ced0"><div class="ttname"><a href="classsinga_1_1DeviceMemPool.html#a24963bb78608bd2d69df9d247f26ced0">singa::DeviceMemPool::GetMemUsage</a></div><div class="ttdeci">virtual std::pair&lt; size_t, size_t &gt; GetMemUsage()</div><div class="ttdoc">Return a pair for free and total memory managed by this pool. </div><div class="ttdef"><b>Definition:</b> memory.h:43</div></div>
<div class="ttc" id="namespacesinga_html"><div class="ttname"><a href="namespacesinga.html">singa</a></div><div class="ttdoc">Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements...</div><div class="ttdef"><b>Definition:</b> common.h:48</div></div>
<div class="ttc" id="classsinga_1_1DeviceMemPool_html"><div class="ttname"><a href="classsinga_1_1DeviceMemPool.html">singa::DeviceMemPool</a></div><div class="ttdef"><b>Definition:</b> memory.h:37</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Apr 22 2019 12:27:05 for Apache Singa by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>