xref: /nrf52832-nimble/rt-thread/components/net/uip/doc/html/a00187.html (revision 042d53a763ad75cb1465103098bb88c245d95138) 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3<title>uIP 1.0: lib/memb.h Source File</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.4.6 -->
8<div class="tabs">
9  <ul>
10    <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
11    <li><a href="modules.html"><span>Modules</span></a></li>
12    <li><a href="classes.html"><span>Data&nbsp;Structures</span></a></li>
13    <li id="current"><a href="files.html"><span>Files</span></a></li>
14    <li><a href="examples.html"><span>Examples</span></a></li>
15  </ul></div>
16<div class="tabs">
17  <ul>
18    <li><a href="files.html"><span>File&nbsp;List</span></a></li>
19    <li><a href="globals.html"><span>Globals</span></a></li>
20  </ul></div>
21<h1>lib/memb.h</h1><a href="a00121.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
22<a name="l00002"></a>00002 <span class="comment"> * Copyright (c) 2004, Swedish Institute of Computer Science.</span>
23<a name="l00003"></a>00003 <span class="comment"> * All rights reserved.</span>
24<a name="l00004"></a>00004 <span class="comment"> *</span>
25<a name="l00005"></a>00005 <span class="comment"> * Redistribution and use in source and binary forms, with or without</span>
26<a name="l00006"></a>00006 <span class="comment"> * modification, are permitted provided that the following conditions</span>
27<a name="l00007"></a>00007 <span class="comment"> * are met:</span>
28<a name="l00008"></a>00008 <span class="comment"> * 1. Redistributions of source code must retain the above copyright</span>
29<a name="l00009"></a>00009 <span class="comment"> *    notice, this list of conditions and the following disclaimer.</span>
30<a name="l00010"></a>00010 <span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright</span>
31<a name="l00011"></a>00011 <span class="comment"> *    notice, this list of conditions and the following disclaimer in the</span>
32<a name="l00012"></a>00012 <span class="comment"> *    documentation and/or other materials provided with the distribution.</span>
33<a name="l00013"></a>00013 <span class="comment"> * 3. Neither the name of the Institute nor the names of its contributors</span>
34<a name="l00014"></a>00014 <span class="comment"> *    may be used to endorse or promote products derived from this software</span>
35<a name="l00015"></a>00015 <span class="comment"> *    without specific prior written permission.</span>
36<a name="l00016"></a>00016 <span class="comment"> *</span>
37<a name="l00017"></a>00017 <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND</span>
38<a name="l00018"></a>00018 <span class="comment"> * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span>
39<a name="l00019"></a>00019 <span class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span>
40<a name="l00020"></a>00020 <span class="comment"> * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE</span>
41<a name="l00021"></a>00021 <span class="comment"> * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL</span>
42<a name="l00022"></a>00022 <span class="comment"> * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS</span>
43<a name="l00023"></a>00023 <span class="comment"> * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)</span>
44<a name="l00024"></a>00024 <span class="comment"> * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT</span>
45<a name="l00025"></a>00025 <span class="comment"> * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY</span>
46<a name="l00026"></a>00026 <span class="comment"> * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF</span>
47<a name="l00027"></a>00027 <span class="comment"> * SUCH DAMAGE.</span>
48<a name="l00028"></a>00028 <span class="comment"> *</span>
49<a name="l00029"></a>00029 <span class="comment"> * This file is part of the uIP TCP/IP stack</span>
50<a name="l00030"></a>00030 <span class="comment"> *</span>
51<a name="l00031"></a>00031 <span class="comment"> * Author: Adam Dunkels &lt;[email protected]&gt;</span>
52<a name="l00032"></a>00032 <span class="comment"> *</span>
53<a name="l00033"></a>00033 <span class="comment"> * $Id: memb.h,v 1.1 2006/06/12 08:21:43 adam Exp $</span>
54<a name="l00034"></a>00034 <span class="comment"> */</span>
55<a name="l00035"></a>00035 <span class="comment"></span>
56<a name="l00036"></a>00036 <span class="comment">/**</span>
57<a name="l00037"></a>00037 <span class="comment"> * \defgroup memb Memory block management functions</span>
58<a name="l00038"></a>00038 <span class="comment"> *</span>
59<a name="l00039"></a>00039 <span class="comment"> * The memory block allocation routines provide a simple yet powerful</span>
60<a name="l00040"></a>00040 <span class="comment"> * set of functions for managing a set of memory blocks of fixed</span>
61<a name="l00041"></a>00041 <span class="comment"> * size. A set of memory blocks is statically declared with the</span>
62<a name="l00042"></a>00042 <span class="comment"> * MEMB() macro. Memory blocks are allocated from the declared</span>
63<a name="l00043"></a>00043 <span class="comment"> * memory by the memb_alloc() function, and are deallocated with the</span>
64<a name="l00044"></a>00044 <span class="comment"> * memb_free() function.</span>
65<a name="l00045"></a>00045 <span class="comment"> *</span>
66<a name="l00046"></a>00046 <span class="comment"> * \note Because of namespace clashes only one MEMB() can be</span>
67<a name="l00047"></a>00047 <span class="comment"> * declared per C module, and the name scope of a MEMB() memory</span>
68<a name="l00048"></a>00048 <span class="comment"> * block is local to each C module.</span>
69<a name="l00049"></a>00049 <span class="comment"> *</span>
70<a name="l00050"></a>00050 <span class="comment"> * The following example shows how to declare and use a memory block</span>
71<a name="l00051"></a>00051 <span class="comment"> * called "cmem" which has 8 chunks of memory with each memory chunk</span>
72<a name="l00052"></a>00052 <span class="comment"> * being 20 bytes large.</span>
73<a name="l00053"></a>00053 <span class="comment"> *</span>
74<a name="l00054"></a>00054 <span class="comment"> * @{</span>
75<a name="l00055"></a>00055 <span class="comment"> */</span>
76<a name="l00056"></a>00056
77<a name="l00057"></a>00057 <span class="comment"></span>
78<a name="l00058"></a>00058 <span class="comment">/**</span>
79<a name="l00059"></a>00059 <span class="comment"> * \file</span>
80<a name="l00060"></a>00060 <span class="comment"> *         Memory block allocation routines.</span>
81<a name="l00061"></a>00061 <span class="comment"> * \author</span>
82<a name="l00062"></a>00062 <span class="comment"> *         Adam Dunkels &lt;[email protected]&gt;</span>
83<a name="l00063"></a>00063 <span class="comment"> *</span>
84<a name="l00064"></a>00064 <span class="comment"> */</span>
85<a name="l00065"></a>00065
86<a name="l00066"></a>00066 <span class="preprocessor">#ifndef __MEMB_H__</span>
87<a name="l00067"></a>00067 <span class="preprocessor"></span><span class="preprocessor">#define __MEMB_H__</span>
88<a name="l00068"></a>00068 <span class="preprocessor"></span>
89<a name="l00069"></a>00069 <span class="comment">/*</span>
90<a name="l00070"></a>00070 <span class="comment"> * Here we define a C preprocessing macro for concatenating to</span>
91<a name="l00071"></a>00071 <span class="comment"> * strings. We need use two macros in order to allow concatenation of</span>
92<a name="l00072"></a>00072 <span class="comment"> * two #defined macros.</span>
93<a name="l00073"></a>00073 <span class="comment"> */</span>
94<a name="l00074"></a><a class="code" href="a00159.html#ga680bc3f3a1a8a6aec20fe729d138cb8">00074</a> <span class="preprocessor">#define MEMB_CONCAT2(s1, s2) s1##s2</span>
95<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>
96<a name="l00076"></a>00076 <span class="preprocessor"></span><span class="comment"></span>
97<a name="l00077"></a>00077 <span class="comment">/**</span>
98<a name="l00078"></a>00078 <span class="comment"> * Declare a memory block.</span>
99<a name="l00079"></a>00079 <span class="comment"> *</span>
100<a name="l00080"></a>00080 <span class="comment"> * This macro is used to staticall declare a block of memory that can</span>
101<a name="l00081"></a>00081 <span class="comment"> * be used by the block allocation functions. The macro statically</span>
102<a name="l00082"></a>00082 <span class="comment"> * declares a C array with a size that matches the specified number of</span>
103<a name="l00083"></a>00083 <span class="comment"> * blocks and their individual sizes.</span>
104<a name="l00084"></a>00084 <span class="comment"> *</span>
105<a name="l00085"></a>00085 <span class="comment"> * Example:</span>
106<a name="l00086"></a>00086 <span class="comment"> \code</span>
107<a name="l00087"></a>00087 <span class="comment">MEMB(connections, sizeof(struct connection), 16);</span>
108<a name="l00088"></a>00088 <span class="comment"> \endcode</span>
109<a name="l00089"></a>00089 <span class="comment"> *</span>
110<a name="l00090"></a>00090 <span class="comment"> * \param name The name of the memory block (later used with</span>
111<a name="l00091"></a>00091 <span class="comment"> * memb_init(), memb_alloc() and memb_free()).</span>
112<a name="l00092"></a>00092 <span class="comment"> *</span>
113<a name="l00093"></a>00093 <span class="comment"> * \param size The size of each memory chunk, in bytes.</span>
114<a name="l00094"></a>00094 <span class="comment"> *</span>
115<a name="l00095"></a>00095 <span class="comment"> * \param num The total number of memory chunks in the block.</span>
116<a name="l00096"></a>00096 <span class="comment"> *</span>
117<a name="l00097"></a>00097 <span class="comment"> */</span>
118<a name="l00098"></a><a class="code" href="a00159.html#gf31774d02a69fd3f1c2b282454438cba">00098</a> <span class="preprocessor">#define MEMB(name, structure, num) \</span>
119<a name="l00099"></a>00099 <span class="preprocessor">        static char MEMB_CONCAT(name,_memb_count)[num]; \</span>
120<a name="l00100"></a>00100 <span class="preprocessor">        static structure MEMB_CONCAT(name,_memb_mem)[num]; \</span>
121<a name="l00101"></a>00101 <span class="preprocessor">        static struct memb_blocks name = {sizeof(structure), num, \</span>
122<a name="l00102"></a>00102 <span class="preprocessor">                                          MEMB_CONCAT(name,_memb_count), \</span>
123<a name="l00103"></a>00103 <span class="preprocessor">                                          (void *)MEMB_CONCAT(name,_memb_mem)}</span>
124<a name="l00104"></a>00104 <span class="preprocessor"></span>
125<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> {
126<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>;
127<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>;
128<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>;
129<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>;
130<a name="l00110"></a>00110 };
131<a name="l00111"></a>00111 <span class="comment"></span>
132<a name="l00112"></a>00112 <span class="comment">/**</span>
133<a name="l00113"></a>00113 <span class="comment"> * Initialize a memory block that was declared with MEMB().</span>
134<a name="l00114"></a>00114 <span class="comment"> *</span>
135<a name="l00115"></a>00115 <span class="comment"> * \param m A memory block previosly declared with MEMB().</span>
136<a name="l00116"></a>00116 <span class="comment"> */</span>
137<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);
138<a name="l00118"></a>00118 <span class="comment"></span>
139<a name="l00119"></a>00119 <span class="comment">/**</span>
140<a name="l00120"></a>00120 <span class="comment"> * Allocate a memory block from a block of memory declared with MEMB().</span>
141<a name="l00121"></a>00121 <span class="comment"> *</span>
142<a name="l00122"></a>00122 <span class="comment"> * \param m A memory block previosly declared with MEMB().</span>
143<a name="l00123"></a>00123 <span class="comment"> */</span>
144<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);
145<a name="l00125"></a>00125 <span class="comment"></span>
146<a name="l00126"></a>00126 <span class="comment">/**</span>
147<a name="l00127"></a>00127 <span class="comment"> * Deallocate a memory block from a memory block previously declared</span>
148<a name="l00128"></a>00128 <span class="comment"> * with MEMB().</span>
149<a name="l00129"></a>00129 <span class="comment"> *</span>
150<a name="l00130"></a>00130 <span class="comment"> * \param m m A memory block previosly declared with MEMB().</span>
151<a name="l00131"></a>00131 <span class="comment"> *</span>
152<a name="l00132"></a>00132 <span class="comment"> * \param ptr A pointer to the memory block that is to be deallocated.</span>
153<a name="l00133"></a>00133 <span class="comment"> *</span>
154<a name="l00134"></a>00134 <span class="comment"> * \return The new reference count for the memory block (should be 0</span>
155<a name="l00135"></a>00135 <span class="comment"> * if successfully deallocated) or -1 if the pointer "ptr" did not</span>
156<a name="l00136"></a>00136 <span class="comment"> * point to a legal memory block.</span>
157<a name="l00137"></a>00137 <span class="comment"> */</span>
158<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);
159<a name="l00139"></a>00139 <span class="comment"></span>
160<a name="l00140"></a>00140 <span class="comment">/** @} */</span>
161<a name="l00141"></a>00141
162<a name="l00142"></a>00142 <span class="preprocessor">#endif </span><span class="comment">/* __MEMB_H__ */</span>
163</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;
164<a href="http://www.doxygen.org/index.html">
165<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
166</body>
167</html>
168