a00187.html

uip-1.0,give everyone who want.

<a name="l00065"></a>00065 
<a name="l00066"></a>00066 <span class="preprocessor">#ifndef __MEMB_H__</span>
<a name="l00067"></a>00067 <span class="preprocessor"></span><span class="preprocessor">#define __MEMB_H__</span>
<a name="l00068"></a>00068 <span class="preprocessor"></span>
<a name="l00069"></a>00069 <span class="comment">/*</span>
<a name="l00070"></a>00070 <span class="comment"> * Here we define a C preprocessing macro for concatenating to</span>
<a name="l00071"></a>00071 <span class="comment"> * strings. We need use two macros in order to allow concatenation of</span>
<a name="l00072"></a>00072 <span class="comment"> * two #defined macros.</span>
<a name="l00073"></a>00073 <span class="comment"> */</span>
<a name="l00074"></a><a class="code" href="a00159.html#ga680bc3f3a1a8a6aec20fe729d138cb8">00074</a> <span class="preprocessor">#define MEMB_CONCAT2(s1, s2) s1##s2</span>
<a name="l00075"></a><a class="code" href="a00159.html#g720ac440c7b24bdd07c53ba146e36fb2">00075</a> <span class="preprocessor"></span><span class="preprocessor">#define MEMB_CONCAT(s1, s2) MEMB_CONCAT2(s1, s2)</span>
<a name="l00076"></a>00076 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00077"></a>00077 <span class="comment">/**</span>
<a name="l00078"></a>00078 <span class="comment"> * Declare a memory block.</span>
<a name="l00079"></a>00079 <span class="comment"> *</span>
<a name="l00080"></a>00080 <span class="comment"> * This macro is used to staticall declare a block of memory that can</span>
<a name="l00081"></a>00081 <span class="comment"> * be used by the block allocation functions. The macro statically</span>
<a name="l00082"></a>00082 <span class="comment"> * declares a C array with a size that matches the specified number of</span>
<a name="l00083"></a>00083 <span class="comment"> * blocks and their individual sizes.</span>
<a name="l00084"></a>00084 <span class="comment"> *</span>
<a name="l00085"></a>00085 <span class="comment"> * Example:</span>
<a name="l00086"></a>00086 <span class="comment"> \code</span>
<a name="l00087"></a>00087 <span class="comment">MEMB(connections, sizeof(struct connection), 16);</span>
<a name="l00088"></a>00088 <span class="comment"> \endcode</span>
<a name="l00089"></a>00089 <span class="comment"> *</span>
<a name="l00090"></a>00090 <span class="comment"> * \param name The name of the memory block (later used with</span>
<a name="l00091"></a>00091 <span class="comment"> * memb_init(), memb_alloc() and memb_free()).</span>
<a name="l00092"></a>00092 <span class="comment"> *</span>
<a name="l00093"></a>00093 <span class="comment"> * \param size The size of each memory chunk, in bytes.</span>
<a name="l00094"></a>00094 <span class="comment"> *</span>
<a name="l00095"></a>00095 <span class="comment"> * \param num The total number of memory chunks in the block.</span>
<a name="l00096"></a>00096 <span class="comment"> *</span>
<a name="l00097"></a>00097 <span class="comment"> */</span>
<a name="l00098"></a><a class="code" href="a00159.html#gf31774d02a69fd3f1c2b282454438cba">00098</a> <span class="preprocessor">#define MEMB(name, structure, num) \</span>
<a name="l00099"></a>00099 <span class="preprocessor">        static char MEMB_CONCAT(name,_memb_count)[num]; \</span>
<a name="l00100"></a>00100 <span class="preprocessor">        static structure MEMB_CONCAT(name,_memb_mem)[num]; \</span>
<a name="l00101"></a>00101 <span class="preprocessor">        static struct memb_blocks name = {sizeof(structure), num, \</span>
<a name="l00102"></a>00102 <span class="preprocessor">                                          MEMB_CONCAT(name,_memb_count), \</span>
<a name="l00103"></a>00103 <span class="preprocessor">                                          (void *)MEMB_CONCAT(name,_memb_mem)}</span>
<a name="l00104"></a>00104 <span class="preprocessor"></span>
<a name="l00105"></a><a class="code" href="a00081.html">00105</a> <span class="keyword">struct </span><a class="code" href="a00081.html">memb_blocks</a> {
<a name="l00106"></a><a class="code" href="a00081.html#b42c7af6114fde5d21206a2e18a7d3ee">00106</a>   <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> <a class="code" href="a00081.html#b42c7af6114fde5d21206a2e18a7d3ee">size</a>;
<a name="l00107"></a><a class="code" href="a00081.html#164124d48fe85bc98d9a300382a5245d">00107</a>   <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> <a class="code" href="a00081.html#164124d48fe85bc98d9a300382a5245d">num</a>;
<a name="l00108"></a><a class="code" href="a00081.html#5595902fd42d874e35a70206fad8f6d0">00108</a>   <span class="keywordtype">char</span> *<a class="code" href="a00081.html#5595902fd42d874e35a70206fad8f6d0">count</a>;
<a name="l00109"></a><a class="code" href="a00081.html#b5801722740492e69bcc73687476009f">00109</a>   <span class="keywordtype">void</span> *<a class="code" href="a00081.html#b5801722740492e69bcc73687476009f">mem</a>;
<a name="l00110"></a>00110 };
<a name="l00111"></a>00111 <span class="comment"></span>
<a name="l00112"></a>00112 <span class="comment">/**</span>
<a name="l00113"></a>00113 <span class="comment"> * Initialize a memory block that was declared with MEMB().</span>
<a name="l00114"></a>00114 <span class="comment"> *</span>
<a name="l00115"></a>00115 <span class="comment"> * \param m A memory block previosly declared with MEMB().</span>
<a name="l00116"></a>00116 <span class="comment"> */</span>
<a name="l00117"></a>00117 <span class="keywordtype">void</span>  <a class="code" href="a00159.html#gd58a6c7e62ae59bf7a016ded12ca2910">memb_init</a>(<span class="keyword">struct</span> <a class="code" href="a00081.html">memb_blocks</a> *m);
<a name="l00118"></a>00118 <span class="comment"></span>
<a name="l00119"></a>00119 <span class="comment">/**</span>
<a name="l00120"></a>00120 <span class="comment"> * Allocate a memory block from a block of memory declared with MEMB().</span>
<a name="l00121"></a>00121 <span class="comment"> *</span>
<a name="l00122"></a>00122 <span class="comment"> * \param m A memory block previosly declared with MEMB().</span>
<a name="l00123"></a>00123 <span class="comment"> */</span>
<a name="l00124"></a>00124 <span class="keywordtype">void</span> *<a class="code" href="a00159.html#gfe5e93119035e14cc485760a176249ba">memb_alloc</a>(<span class="keyword">struct</span> <a class="code" href="a00081.html">memb_blocks</a> *m);
<a name="l00125"></a>00125 <span class="comment"></span>
<a name="l00126"></a>00126 <span class="comment">/**</span>
<a name="l00127"></a>00127 <span class="comment"> * Deallocate a memory block from a memory block previously declared</span>
<a name="l00128"></a>00128 <span class="comment"> * with MEMB().</span>
<a name="l00129"></a>00129 <span class="comment"> *</span>
<a name="l00130"></a>00130 <span class="comment"> * \param m m A memory block previosly declared with MEMB().</span>
<a name="l00131"></a>00131 <span class="comment"> *</span>
<a name="l00132"></a>00132 <span class="comment"> * \param ptr A pointer to the memory block that is to be deallocated.</span>
<a name="l00133"></a>00133 <span class="comment"> *</span>
<a name="l00134"></a>00134 <span class="comment"> * \return The new reference count for the memory block (should be 0</span>
<a name="l00135"></a>00135 <span class="comment"> * if successfully deallocated) or -1 if the pointer "ptr" did not</span>
<a name="l00136"></a>00136 <span class="comment"> * point to a legal memory block.</span>
<a name="l00137"></a>00137 <span class="comment"> */</span>
<a name="l00138"></a>00138 <span class="keywordtype">char</span>  <a class="code" href="a00159.html#gceb952d27de8125d5146ac0bee325b8f">memb_free</a>(<span class="keyword">struct</span> <a class="code" href="a00081.html">memb_blocks</a> *m, <span class="keywordtype">void</span> *ptr);
<a name="l00139"></a>00139 <span class="comment"></span>
<a name="l00140"></a>00140 <span class="comment">/** @} */</span>
<a name="l00141"></a>00141 
<a name="l00142"></a>00142 <span class="preprocessor">#endif </span><span class="comment">/* __MEMB_H__ */</span>
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Mon Jun 12 10:23:01 2006 for uIP 1.0 by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
</body>
</html>