<!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"/>
<title>CVC3: memory_manager_chunks.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">CVC3 <span id="projectnumber">2.4.1</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<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 class="header">
<div class="headertitle">
<div class="title">memory_manager_chunks.h</div> </div>
</div>
<div class="contents">
<a href="memory__manager__chunks_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*****************************************************************************/</span><span class="comment"></span>
<a name="l00002"></a>00002 <span class="comment">/*!</span>
<a name="l00003"></a>00003 <span class="comment"> * \file memory_manager_chunks.h</span>
<a name="l00004"></a>00004 <span class="comment"> * </span>
<a name="l00005"></a>00005 <span class="comment"> * Author: Sergey Berezin</span>
<a name="l00006"></a>00006 <span class="comment"> * </span>
<a name="l00007"></a>00007 <span class="comment"> * Created: Tue Apr 19 14:30:36 2005</span>
<a name="l00008"></a>00008 <span class="comment"> *</span>
<a name="l00009"></a>00009 <span class="comment"> * <hr></span>
<a name="l00010"></a>00010 <span class="comment"> *</span>
<a name="l00011"></a>00011 <span class="comment"> * License to use, copy, modify, sell and/or distribute this software</span>
<a name="l00012"></a>00012 <span class="comment"> * and its documentation for any purpose is hereby granted without</span>
<a name="l00013"></a>00013 <span class="comment"> * royalty, subject to the terms and conditions defined in the \ref</span>
<a name="l00014"></a>00014 <span class="comment"> * LICENSE file provided with this distribution.</span>
<a name="l00015"></a>00015 <span class="comment"> * </span>
<a name="l00016"></a>00016 <span class="comment"> * <hr></span>
<a name="l00017"></a>00017 <span class="comment"> * </span>
<a name="l00018"></a>00018 <span class="comment"> * Class MemoryManager: allocates/deallocates memory for objects of a</span>
<a name="l00019"></a>00019 <span class="comment"> * fixed size (the size is a parameter to the constructor). The</span>
<a name="l00020"></a>00020 <span class="comment"> * actual memory is allocated in big chunks, which (at the moment) are</span>
<a name="l00021"></a>00021 <span class="comment"> * never released back. However, the deallocated blocks are later reused.</span>
<a name="l00022"></a>00022 <span class="comment"> * </span>
<a name="l00023"></a>00023 <span class="comment"> * Typical use of this class is to create </span>
<a name="l00024"></a>00024 <span class="comment"> * MemoryManager* mm = new MemoryManager(sizeof(YourClass)); </span>
<a name="l00025"></a>00025 <span class="comment"> * where YourClass has operators new and delete redefined:</span>
<a name="l00026"></a>00026 <span class="comment"> * void* YourClass::operator new(size_t, MemoryManager* mm)</span>
<a name="l00027"></a>00027 <span class="comment"> * { return mm->newData(); }</span>
<a name="l00028"></a>00028 <span class="comment"> * void YourClass::delete(void*) { } // do not deallocate memory here</span>
<a name="l00029"></a>00029 <span class="comment"> * Then, create objects with obj = new(mm) YourClass(), and destroy them with</span>
<a name="l00030"></a>00030 <span class="comment"> * delete obj; mm->deleteData(obj);</span>
<a name="l00031"></a>00031 <span class="comment"> */</span>
<a name="l00032"></a>00032 <span class="comment">/*****************************************************************************/</span>
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="preprocessor">#ifndef _cvc3__memory_manager_chunks_h</span>
<a name="l00035"></a>00035 <span class="preprocessor"></span><span class="preprocessor">#define _cvc3__memory_manager_chunks_h</span>
<a name="l00036"></a>00036 <span class="preprocessor"></span>
<a name="l00037"></a>00037 <span class="preprocessor">#include <vector></span>
<a name="l00038"></a>00038 <span class="preprocessor">#include "<a class="code" href="memory__manager_8h.html">memory_manager.h</a>"</span>
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="keyword">namespace </span>CVC3 {
<a name="l00041"></a>00041
<a name="l00042"></a><a class="code" href="classCVC3_1_1MemoryManagerChunks.html">00042</a> <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> {
<a name="l00043"></a>00043 <span class="keyword">private</span>:
<a name="l00044"></a><a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a1576d5378be3edbed3464c8dbfa2169c">00044</a> <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>
<a name="l00045"></a><a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a2756c4ba97d43711abf300077329c814">00045</a> <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>
<a name="l00046"></a><a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a4676880300199e5a97f2d2494bb945d0">00046</a> <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>
<a name="l00047"></a><a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a9c2ad8041ecc41a1a33b1e2062917f4a">00047</a> std::vector<char*> <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a9c2ad8041ecc41a1a33b1e2062917f4a">d_freeList</a>;
<a name="l00048"></a><a class="code" href="classCVC3_1_1MemoryManagerChunks.html#afee269f07695c909e4f91cba72737a0d">00048</a> 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>
<a name="l00049"></a>00049 <span class="comment">// Pointer to the next free block of memory in the current chunk</span>
<a name="l00050"></a><a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a5cb6149e8f9056b7759f27c70af3b3ce">00050</a> <span class="keywordtype">char</span>* <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a5cb6149e8f9056b7759f27c70af3b3ce">d_nextFree</a>;
<a name="l00051"></a>00051 <span class="comment">// End of current chunk (1 byte off the end)</span>
<a name="l00052"></a><a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a3f22a54091221b4267e52a6bb4490ee6">00052</a> <span class="keywordtype">char</span>* <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a3f22a54091221b4267e52a6bb4490ee6">d_endChunk</a>;
<a name="l00053"></a>00053
<a name="l00054"></a>00054 <span class="comment">// Private methods</span>
<a name="l00055"></a><a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a39e66a57f203c35e69dd13ffe046826c">00055</a> <span class="keywordtype">void</span> <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a39e66a57f203c35e69dd13ffe046826c">newChunk</a>() { <span class="comment">// Allocate new chunk</span>
<a name="l00056"></a>00056 <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>);
<a name="l00057"></a>00057 <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>);
<a name="l00058"></a>00058 <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>;
<a name="l00059"></a>00059 <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>);
<a name="l00060"></a>00060 }
<a name="l00061"></a>00061
<a name="l00062"></a>00062 <span class="keyword">public</span>:
<a name="l00063"></a>00063 <span class="comment">// Constructor</span>
<a name="l00064"></a><a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a5efded8dddcac26ffaa5d63b8706aa4f">00064</a> <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a5efded8dddcac26ffaa5d63b8706aa4f">MemoryManagerChunks</a>(<span class="keywordtype">unsigned</span> dataSize, <span class="keywordtype">unsigned</span> chunkSize = 1024)
<a name="l00065"></a>00065 : <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),
<a name="l00066"></a>00066 <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a4676880300199e5a97f2d2494bb945d0">d_chunkSizeBytes</a>(dataSize*chunkSize),
<a name="l00067"></a>00067 <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) { }
<a name="l00068"></a>00068 <span class="comment">// Destructor</span>
<a name="l00069"></a><a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a51e969558b4c5b4c2a3d662f955a904e">00069</a> <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a51e969558b4c5b4c2a3d662f955a904e">~MemoryManagerChunks</a>() {
<a name="l00070"></a>00070 <span class="keywordflow">while</span>(<a class="code" href="classCVC3_1_1MemoryManagerChunks.html#afee269f07695c909e4f91cba72737a0d">d_chunkList</a>.size() > 0) {
<a name="l00071"></a>00071 free(<a class="code" href="classCVC3_1_1MemoryManagerChunks.html#afee269f07695c909e4f91cba72737a0d">d_chunkList</a>.back());
<a name="l00072"></a>00072 <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#afee269f07695c909e4f91cba72737a0d">d_chunkList</a>.pop_back();
<a name="l00073"></a>00073 }
<a name="l00074"></a>00074 }
<a name="l00075"></a>00075
<a name="l00076"></a><a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a1bc51e773f7575f3258fcd751464903c">00076</a> <span class="keywordtype">void</span>* <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a1bc51e773f7575f3258fcd751464903c">newData</a>(<span class="keywordtype">size_t</span> size) {
<a name="l00077"></a>00077 <a class="code" href="debug_8h.html#a40dac3bdb2166ffc852ee8b1489d2b56">DebugAssert</a>(size == <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a1576d5378be3edbed3464c8dbfa2169c">d_dataSize</a>,
<a name="l00078"></a>00078 <span class="stringliteral">"MemoryManager::newData: the data size doesn't match"</span>);
<a name="l00079"></a>00079 <span class="keywordtype">void</span>* res;
<a name="l00080"></a>00080 <span class="comment">// Check the free list first</span>
<a name="l00081"></a>00081 <span class="keywordflow">if</span>(<a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a9c2ad8041ecc41a1a33b1e2062917f4a">d_freeList</a>.size() > 0) {
<a name="l00082"></a>00082 res = (<span class="keywordtype">void</span>*)<a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a9c2ad8041ecc41a1a33b1e2062917f4a">d_freeList</a>.back();
<a name="l00083"></a>00083 <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a9c2ad8041ecc41a1a33b1e2062917f4a">d_freeList</a>.pop_back();
<a name="l00084"></a>00084 <span class="keywordflow">return</span> res;
<a name="l00085"></a>00085 }
<a name="l00086"></a>00086 <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>)
<a name="l00087"></a>00087 <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a39e66a57f203c35e69dd13ffe046826c">newChunk</a>();
<a name="l00088"></a>00088 res = (<span class="keywordtype">void</span>*)<a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a5cb6149e8f9056b7759f27c70af3b3ce">d_nextFree</a>;
<a name="l00089"></a>00089 <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a5cb6149e8f9056b7759f27c70af3b3ce">d_nextFree</a> += <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a1576d5378be3edbed3464c8dbfa2169c">d_dataSize</a>;
<a name="l00090"></a>00090 <span class="keywordflow">return</span> res;
<a name="l00091"></a>00091 }
<a name="l00092"></a>00092
<a name="l00093"></a><a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a8096826bd9fdb83798f2124f9c6f6e07">00093</a> <span class="keywordtype">void</span> <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a8096826bd9fdb83798f2124f9c6f6e07">deleteData</a>(<span class="keywordtype">void</span>* d) {
<a name="l00094"></a>00094 <a class="code" href="classCVC3_1_1MemoryManagerChunks.html#a9c2ad8041ecc41a1a33b1e2062917f4a">d_freeList</a>.push_back((<span class="keywordtype">char</span>*)d);
<a name="l00095"></a>00095 }
<a name="l00096"></a>00096 }; <span class="comment">// end of class MemoryManager</span>
<a name="l00097"></a>00097
<a name="l00098"></a>00098 }
<a name="l00099"></a>00099
<a name="l00100"></a>00100 <span class="preprocessor">#endif</span>
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Sep 7 2011 for CVC3 by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
