1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>uIP 1.0: lib/memb.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.6 -->
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="classes.html"><span>Data Structures</span></a></li>
<li id="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul></div>
<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>
<a name="l00002"></a>00002 <span class="comment"> * Copyright (c) 2004, Swedish Institute of Computer Science.</span>
<a name="l00003"></a>00003 <span class="comment"> * All rights reserved.</span>
<a name="l00004"></a>00004 <span class="comment"> *</span>
<a name="l00005"></a>00005 <span class="comment"> * Redistribution and use in source and binary forms, with or without</span>
<a name="l00006"></a>00006 <span class="comment"> * modification, are permitted provided that the following conditions</span>
<a name="l00007"></a>00007 <span class="comment"> * are met:</span>
<a name="l00008"></a>00008 <span class="comment"> * 1. Redistributions of source code must retain the above copyright</span>
<a name="l00009"></a>00009 <span class="comment"> * notice, this list of conditions and the following disclaimer.</span>
<a name="l00010"></a>00010 <span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright</span>
<a name="l00011"></a>00011 <span class="comment"> * notice, this list of conditions and the following disclaimer in the</span>
<a name="l00012"></a>00012 <span class="comment"> * documentation and/or other materials provided with the distribution.</span>
<a name="l00013"></a>00013 <span class="comment"> * 3. Neither the name of the Institute nor the names of its contributors</span>
<a name="l00014"></a>00014 <span class="comment"> * may be used to endorse or promote products derived from this software</span>
<a name="l00015"></a>00015 <span class="comment"> * without specific prior written permission.</span>
<a name="l00016"></a>00016 <span class="comment"> *</span>
<a name="l00017"></a>00017 <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND</span>
<a name="l00018"></a>00018 <span class="comment"> * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span>
<a name="l00019"></a>00019 <span class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span>
<a name="l00020"></a>00020 <span class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE</span>
<a name="l00021"></a>00021 <span class="comment"> * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL</span>
<a name="l00022"></a>00022 <span class="comment"> * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS</span>
<a name="l00023"></a>00023 <span class="comment"> * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)</span>
<a name="l00024"></a>00024 <span class="comment"> * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT</span>
<a name="l00025"></a>00025 <span class="comment"> * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY</span>
<a name="l00026"></a>00026 <span class="comment"> * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF</span>
<a name="l00027"></a>00027 <span class="comment"> * SUCH DAMAGE.</span>
<a name="l00028"></a>00028 <span class="comment"> *</span>
<a name="l00029"></a>00029 <span class="comment"> * This file is part of the uIP TCP/IP stack</span>
<a name="l00030"></a>00030 <span class="comment"> *</span>
<a name="l00031"></a>00031 <span class="comment"> * Author: Adam Dunkels <adam@sics.se></span>
<a name="l00032"></a>00032 <span class="comment"> *</span>
<a name="l00033"></a>00033 <span class="comment"> * $Id: memb.h,v 1.1 2006/06/12 08:21:43 adam Exp $</span>
<a name="l00034"></a>00034 <span class="comment"> */</span>
<a name="l00035"></a>00035 <span class="comment"></span>
<a name="l00036"></a>00036 <span class="comment">/**</span>
<a name="l00037"></a>00037 <span class="comment"> * \defgroup memb Memory block management functions</span>
<a name="l00038"></a>00038 <span class="comment"> *</span>
<a name="l00039"></a>00039 <span class="comment"> * The memory block allocation routines provide a simple yet powerful</span>
<a name="l00040"></a>00040 <span class="comment"> * set of functions for managing a set of memory blocks of fixed</span>
<a name="l00041"></a>00041 <span class="comment"> * size. A set of memory blocks is statically declared with the</span>
<a name="l00042"></a>00042 <span class="comment"> * MEMB() macro. Memory blocks are allocated from the declared</span>
<a name="l00043"></a>00043 <span class="comment"> * memory by the memb_alloc() function, and are deallocated with the</span>
<a name="l00044"></a>00044 <span class="comment"> * memb_free() function.</span>
<a name="l00045"></a>00045 <span class="comment"> *</span>
<a name="l00046"></a>00046 <span class="comment"> * \note Because of namespace clashes only one MEMB() can be</span>
<a name="l00047"></a>00047 <span class="comment"> * declared per C module, and the name scope of a MEMB() memory</span>
<a name="l00048"></a>00048 <span class="comment"> * block is local to each C module.</span>
<a name="l00049"></a>00049 <span class="comment"> *</span>
<a name="l00050"></a>00050 <span class="comment"> * The following example shows how to declare and use a memory block</span>
<a name="l00051"></a>00051 <span class="comment"> * called "cmem" which has 8 chunks of memory with each memory chunk</span>
<a name="l00052"></a>00052 <span class="comment"> * being 20 bytes large.</span>
<a name="l00053"></a>00053 <span class="comment"> *</span>
<a name="l00054"></a>00054 <span class="comment"> * @{</span>
<a name="l00055"></a>00055 <span class="comment"> */</span>
<a name="l00056"></a>00056
<a name="l00057"></a>00057 <span class="comment"></span>
<a name="l00058"></a>00058 <span class="comment">/**</span>
<a name="l00059"></a>00059 <span class="comment"> * \file</span>
<a name="l00060"></a>00060 <span class="comment"> * Memory block allocation routines.</span>
<a name="l00061"></a>00061 <span class="comment"> * \author</span>
<a name="l00062"></a>00062 <span class="comment"> * Adam Dunkels <adam@sics.se></span>
<a name="l00063"></a>00063 <span class="comment"> *</span>
<a name="l00064"></a>00064 <span class="comment"> */</span>
<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
<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>
|
