<!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"/>
<title>CVC3: memory_manager_chunks.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="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 style="padding-left: 0.5em;">
<div id="projectname">CVC3
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.2 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_b0856f6b0d80ccb263b2f415c91f9e17.html">include</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">memory_manager_chunks.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="memory__manager__chunks_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> <span class="comment">/*****************************************************************************/</span><span class="comment"></span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*!</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * \file memory_manager_chunks.h</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * </span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Author: Sergey Berezin</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * </span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * Created: Tue Apr 19 14:30:36 2005</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * <hr></span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * License to use, copy, modify, sell and/or distribute this software</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * and its documentation for any purpose is hereby granted without</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * royalty, subject to the terms and conditions defined in the \ref</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * LICENSE file provided with this distribution.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * </span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * <hr></span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * </span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * Class MemoryManager: allocates/deallocates memory for objects of a</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * fixed size (the size is a parameter to the constructor). The</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * actual memory is allocated in big chunks, which (at the moment) are</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * never released back. However, the deallocated blocks are later reused.</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * </span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * Typical use of this class is to create </span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * MemoryManager* mm = new MemoryManager(sizeof(YourClass)); </span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * where YourClass has operators new and delete redefined:</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * void* YourClass::operator new(size_t, MemoryManager* mm)</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * { return mm->newData(); }</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * void YourClass::delete(void*) { } // do not deallocate memory here</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * Then, create objects with obj = new(mm) YourClass(), and destroy them with</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * delete obj; mm->deleteData(obj);</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">/*****************************************************************************/</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#ifndef _cvc3__memory_manager_chunks_h</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor"></span><span class="preprocessor">#define _cvc3__memory_manager_chunks_h</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#include <vector></span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#include "<a class="code" href="memory__manager_8h.html">memory_manager.h</a>"</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">namespace </span>CVC3 {</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="code" href="classCVC3_1_1MemoryManagerChunks.html"> 42</a></span> <span class="keyword">class </span><a class="code" href="classCVC3_1_1MemoryManagerChunks.html">MemoryManagerChunks</a>: <span class="keyword">public</span> <a class="code" href="classCVC3_1_1MemoryManager.html">MemoryManager</a> {</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">private</span>:</div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a1576d5378be3edbed3464c8dbfa2169c"> 44</a></span>  <span class="keywordtype">unsigned</span> <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a1576d5378be3edbed3464c8dbfa2169c">d_dataSize</a>; <span class="comment">// #bytes in each data element</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a2756c4ba97d43711abf300077329c814"> 45</a></span>  <span class="keywordtype">unsigned</span> <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a2756c4ba97d43711abf300077329c814">d_chunkSize</a>; <span class="comment">// number of data elements</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a4676880300199e5a97f2d2494bb945d0"> 46</a></span>  <span class="keywordtype">unsigned</span> <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a4676880300199e5a97f2d2494bb945d0">d_chunkSizeBytes</a>; <span class="comment">// #bytes in each chunk</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a9c2ad8041ecc41a1a33b1e2062917f4a"> 47</a></span>  std::vector<char*> <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a9c2ad8041ecc41a1a33b1e2062917f4a">d_freeList</a>;</div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="code" href="classCVC3_1_1MemoryManagerChunks.html#afee269f07695c909e4f91cba72737a0d"> 48</a></span>  std::vector<char*> <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#afee269f07695c909e4f91cba72737a0d">d_chunkList</a>; <span class="comment">// Pointers to the beginning of each chunk</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="comment">// Pointer to the next free block of memory in the current chunk</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a5cb6149e8f9056b7759f27c70af3b3ce"> 50</a></span>  <span class="keywordtype">char</span>* <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a5cb6149e8f9056b7759f27c70af3b3ce">d_nextFree</a>;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="comment">// End of current chunk (1 byte off the end)</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"><a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a3f22a54091221b4267e52a6bb4490ee6"> 52</a></span>  <span class="keywordtype">char</span>* <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a3f22a54091221b4267e52a6bb4490ee6">d_endChunk</a>;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="comment">// Private methods</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"><a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a39e66a57f203c35e69dd13ffe046826c"> 55</a></span>  <span class="keywordtype">void</span> <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a39e66a57f203c35e69dd13ffe046826c">newChunk</a>() { <span class="comment">// Allocate new chunk</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a5cb6149e8f9056b7759f27c70af3b3ce">d_nextFree</a> = (<span class="keywordtype">char</span>*)malloc(<a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a4676880300199e5a97f2d2494bb945d0">d_chunkSizeBytes</a>);</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <a class="code" href="debug_8h.html#a2637b2fffa22e3c9fad40cda8fcc3bce" title="If something goes horribly wrong, print a message and abort immediately with exit(1).">FatalAssert</a>(<a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a5cb6149e8f9056b7759f27c70af3b3ce">d_nextFree</a> != NULL, <span class="stringliteral">"Out of memory"</span>);</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a3f22a54091221b4267e52a6bb4490ee6">d_endChunk</a> = <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a5cb6149e8f9056b7759f27c70af3b3ce">d_nextFree</a> + <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a4676880300199e5a97f2d2494bb945d0">d_chunkSizeBytes</a>;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#afee269f07695c909e4f91cba72737a0d">d_chunkList</a>.push_back(<a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a5cb6149e8f9056b7759f27c70af3b3ce">d_nextFree</a>);</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  }</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="comment">// Constructor</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"><a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a5efded8dddcac26ffaa5d63b8706aa4f"> 64</a></span>  <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a5efded8dddcac26ffaa5d63b8706aa4f">MemoryManagerChunks</a>(<span class="keywordtype">unsigned</span> dataSize, <span class="keywordtype">unsigned</span> chunkSize = 1024)</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  : <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a1576d5378be3edbed3464c8dbfa2169c">d_dataSize</a>(dataSize), <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a2756c4ba97d43711abf300077329c814">d_chunkSize</a>(chunkSize),</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a4676880300199e5a97f2d2494bb945d0">d_chunkSizeBytes</a>(dataSize*chunkSize),</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a5cb6149e8f9056b7759f27c70af3b3ce">d_nextFree</a>(NULL), <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a3f22a54091221b4267e52a6bb4490ee6">d_endChunk</a>(NULL) { }</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="comment">// Destructor</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"><a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a51e969558b4c5b4c2a3d662f955a904e"> 69</a></span>  <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a51e969558b4c5b4c2a3d662f955a904e">~MemoryManagerChunks</a>() {</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordflow">while</span>(<a class="code" href="classCVC3_1_1MemoryManagerChunks.html#afee269f07695c909e4f91cba72737a0d">d_chunkList</a>.size() > 0) {</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  free(<a class="code" href="classCVC3_1_1MemoryManagerChunks.html#afee269f07695c909e4f91cba72737a0d">d_chunkList</a>.back());</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#afee269f07695c909e4f91cba72737a0d">d_chunkList</a>.pop_back();</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  }</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  }</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div>
<div class="line"><a name="l00076"></a><span class="lineno"><a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a1bc51e773f7575f3258fcd751464903c"> 76</a></span>  <span class="keywordtype">void</span>* <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a1bc51e773f7575f3258fcd751464903c">newData</a>(<span class="keywordtype">size_t</span> size) {</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <a class="code" href="debug_8h.html#a40dac3bdb2166ffc852ee8b1489d2b56">DebugAssert</a>(size == <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a1576d5378be3edbed3464c8dbfa2169c">d_dataSize</a>,</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="stringliteral">"MemoryManager::newData: the data size doesn't match"</span>);</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordtype">void</span>* res;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="comment">// Check the free list first</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordflow">if</span>(<a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a9c2ad8041ecc41a1a33b1e2062917f4a">d_freeList</a>.size() > 0) {</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  res = (<span class="keywordtype">void</span>*)<a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a9c2ad8041ecc41a1a33b1e2062917f4a">d_freeList</a>.back();</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a9c2ad8041ecc41a1a33b1e2062917f4a">d_freeList</a>.pop_back();</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordflow">return</span> res;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  }</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordflow">if</span>(<a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a5cb6149e8f9056b7759f27c70af3b3ce">d_nextFree</a> == NULL || <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a5cb6149e8f9056b7759f27c70af3b3ce">d_nextFree</a> == <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a3f22a54091221b4267e52a6bb4490ee6">d_endChunk</a>)</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a39e66a57f203c35e69dd13ffe046826c">newChunk</a>();</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  res = (<span class="keywordtype">void</span>*)<a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a5cb6149e8f9056b7759f27c70af3b3ce">d_nextFree</a>;</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a5cb6149e8f9056b7759f27c70af3b3ce">d_nextFree</a> += <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a1576d5378be3edbed3464c8dbfa2169c">d_dataSize</a>;</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordflow">return</span> res;</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  }</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div>
<div class="line"><a name="l00093"></a><span class="lineno"><a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a8096826bd9fdb83798f2124f9c6f6e07"> 93</a></span>  <span class="keywordtype">void</span> <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a8096826bd9fdb83798f2124f9c6f6e07">deleteData</a>(<span class="keywordtype">void</span>* d) {</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a9c2ad8041ecc41a1a33b1e2062917f4a">d_freeList</a>.push_back((<span class="keywordtype">char</span>*)d);</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  }</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> }; <span class="comment">// end of class MemoryManager</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> }</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu May 16 2013 13:25:14 for CVC3 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.2
</small></address>
</body>
</html>
