File: implement_memory.html

package info (click to toggle)
funnelweb-doc 3.2b-1
  • links: PTS
  • area: main
  • in suites: potato
  • size: 3,084 kB
  • ctags: 6
  • sloc: perl: 241; makefile: 41
file content (251 lines) | stat: -rw-r--r-- 9,562 bytes parent folder | download
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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"
            "http://www.w3.org/TR/REC-html40/loose.dtd">

<HTML>
<!--
***********************************************************************
FUNNELWEB MANUAL WEB PAGE
=========================
Copyright (c) Ross N. Williams 1995-1999. All rights reserved.

Permission is granted to make and distribute verbatim copies of this
FunnelWeb manual provided that all notices (including, without
limitation, the copyright notice, this permission notice, any record
of modification, and all legal notices) are preserved on all copies.
Modified versions of this manual, including translations to other
languages, may be distributed under the same terms, provided that each
modification made to the manual since its original release by Ross N.
Williams (www.ross.net) is identified on the page on which it occurs,
and the front page of the manual carries a notice notifying the reader
that changes have been made, and referring the reader to the official
FunnelWeb website at www.ross.net/funnelweb/.

To the extent permitted by law there is ABSOLUTELY NO WARRANTY.

***********************************************************************
-->

<HEAD>
<TITLE>3.4 Use of Memory</TITLE>
<STYLE TYPE="text/css"> <!-- A {text-decoration: none} // --> </STYLE>
</HEAD>
<BODY BACKGROUND="binary/background.gif"
      BGCOLOR="#FFFFFF"
      TEXT="#000000"
      VLINK="#660000"
      LINK="#FF0000"
      ALINK="#CC0000">

<TABLE WIDTH="490">
<TR>
<TD WIDTH="130" VALIGN="top">
<IMG SRC="binary/d_clear.gif" ALT="" WIDTH="130" HEIGHT="1"><BR>

<FONT SIZE="2">
<BR>

<A HREF="http://www.ross.net/"
 TARGET="rosshome"
 onClick="window.open('','rosshome','location,status,menubar,scrollbars,resizable',false).focus(); return true;"
>
 <IMG SRC="binary/rossnet_logo.gif"
  WIDTH="64" HEIGHT="32"
  BORDER="0" ALT="RossNet"
  HSPACE="0" VSPACE="1"></A><BR>
<BR>

<A HREF="../index.shtml"
 TARGET="funnelweb"
 onClick="window.open('','funnelweb','location,status,menubar,scrollbars,resizable',false).focus(); return true;"
>
 <IMG SRC="binary/linklogo.gif"
  WIDTH="64" HEIGHT="32"
  BORDER="0" ALT="FunnelWeb"
  HSPACE="0" VSPACE="1"></A><BR>
<BR>
<A HREF="../reference/index.html"
 TARGET="funnelwebreference"
 onClick="window.open('','funnelwebreference','location,status,menubar,scrollbars,resizable',false).focus(); return true;"
><FONT COLOR="#FFFFFF"><B>Reference</B></FONT></A><BR>
<BR>
<A HREF="../tutorial/index.html"
 TARGET="funnelwebtutorial"
 onClick="window.open('','funnelwebtutorial','location,status,menubar,scrollbars,resizable',false).focus(); return true;"
><FONT COLOR="#FFFFFF"><B>Tutorial</B></FONT></A><BR>
<BR>
<A HREF="index.html"><FONT COLOR="#FFFFFF"><B>Developer</B></FONT></A><BR>
<A HREF="compile.html"><FONT COLOR="#FFFFFF">1 Compile</FONT></A><BR>
<A HREF="design.html"><FONT COLOR="#FFFFFF">2 Design</FONT></A><BR>
<A HREF="implement.html"><FONT COLOR="#FFFFFF">3 Implement</FONT></A><BR>
<A HREF="modify.html"><FONT COLOR="#FFFFFF">4 Modify</FONT></A><BR>
<A HREF="misc.html"><FONT COLOR="#FFFFFF">5 Misc</FONT></A><BR>
<A HREF="gpl.html"><FONT COLOR="#FFFFFF">6 Licence</FONT></A><BR>

<BR>
<A HREF="search.html"><FONT COLOR="#FFFFFF"><B>SEARCH</B></FONT></A><BR>
</FONT>


</TD>
<TD WIDTH="360" VALIGN="top">
<FONT SIZE="3">


<A HREF="index.html"><IMG SRC="binary/title.gif"
 WIDTH="316" HEIGHT="24"
 BORDER="0" ALT="FunnelWeb Developer Manual"
 HSPACE="0" VSPACE="0"></A>
<P><FONT SIZE="5">3.4 Use of Memory</FONT><BR>



<P>FunnelWeb is not a memory-stressed program. However,
during its development, problems with the management of
memory seemed to crop up again and again. This section
documents some of these problems and the solutions
that were adopted.

<P>There are three places where memory can be obtained:
the heap, the stack, and from static variables. The
following three sections deal with each of these areas.

<P><BR><FONT SIZE="4"><STRONG>The Heap</STRONG></FONT><BR>


<P>One of the great frustrations of being a user is to
find that a computer program is complaining about lack of
memory when one knows full well that one has allocated at
least ten times as much memory to the program as it would
ever need to do its job. The reason for such error messages
usually has to do with the programmer setting a fixed
"reasonable" limit to a particular data structure
and then locking it up into an array whose bound is
specified by a constant. This malody is particularly common in
old Pascal programs. While the use of arrays can
increase the speed of a program, it also means that the user
cannot increase the capacity of the program without
obtaining the source code and recompiling it.

<P>The alternative is to use the heap for all data
structures that can grow in proportion to the size of the
user's input. This rule has been followed rigorously in
FunnelWeb. This means that as memory spaces increase, users
will be able to hand their version of FunnelWeb more memory
without having to recompile it.

<P><HR WIDTH=30%>

<P>Some problems arose early on the
Macintosh in the use of the heap.
For some obscure reason, many of the heap application
<SAMP>malloc</SAMP> calls were failing. Whatever
it was, it went away when I replaced direct calls to
<SAMP>malloc</SAMP> with calls to a mini package
I wrote (called <SAMP>memory</SAMP>) that allocated large
chunks of memory and then doled out small pieces as required
by the rest of the program.

<P>Having a package to manage all the memory allocation
had two other benefits.

<P>First, only one check was required in the entire
program to see if memory had run out (in the memory
package), and if that failed, the program could be brought
to a screaming halt. This organization was far preferable to
having each piece of code that needed to allocate memory
having to check to see if <SAMP>malloc</SAMP> had failed.

<P>Second, the decision to construct a mini-shell within
FunnelWeb to support regression testing meant that FunnelWeb
proper (the FunnelWeb <SAMP>fw</SAMP> shell command)
could be run many times in any given invocation of
FunnelWeb. As a consequence it was necessary to make sure
that there was no memory leakage
between invocations of FunnelWeb proper. This was
accomplished by reworking the memory package to operate a
watermark system. The user of the package, when requesting
memory, could request "temporary" or
"permanent". If permanent, the memory package forgot
that it had allocated the memory. If temporary, the memory
package places the allocated block on a list. There was then
a function in the memory package that could be called to
deallocate all the temporary memory. All this meant that
so long as all
requests for memory within FunnelWeb proper were for
temporary memory, and that memory was freed at the end of
every run, one could be sure that there was no memory
leakage.

<P><BR><FONT SIZE="4"><STRONG>The Stack</STRONG></FONT><BR>


<P>For a while during the development of FunnelWeb a
particularly nasty bug proved extremely hard to find. The
symptom was that FunnelWeb would crash, sometimes at random,
but more often upon entering a particular function. In the
end, about a day of specific debugging was required before
the problem was tracked down to a stack problem. It turned
out that somehow (either the fault of the Macintosh or the
THINK&nbsp;C language system), the compiler was allocating
just 6K for stack space!!!!!!!

<P>This experience led me immediately to go through the
entire program and eliminate (or remove to the heap) any
automatic variable declarations that used more than one
hundred or so bytes.

<P>The lesson is clearly that C&nbsp;programs that use more
than a few thousand bytes of stack space are risking their
portability. All large data structures should be placed in
the heap.

<P><BR><FONT SIZE="4"><STRONG>Static Variables</STRONG></FONT><BR>


<P>Static variables also proved a problem on the
Macintosh. It turned out that the Macintosh
THINK&nbsp;C compiler did not allow
more than 32K of statics <I>in the entire program</I>&nbsp;. For
a while this restriction was a serious threat to the program
as it was discovered that constant strings were included in
this total! However, some searching revealed a compiler
option that removed the strings from the static category.

<P>Nevertheless, the 32K limit is rather severe. Again, it
seems that for portability reasons, C&nbsp;programs that use a
lot of static variables are risking their portability. As a
result, the FunnelWeb code avoids static variables where
possible in favour of the heap.


<P>
<TABLE WIDTH="100%">
<TR>
<TD ALIGN="left"   VALIGN="bottom"><A HREF="implement_style.html"><IMG SRC="binary/fw_left.gif" HEIGHT="32" WIDTH="32" BORDER="0" ALT="Prev"></A></TD>
<TD ALIGN="center" VALIGN="bottom"><A HREF="implement.html"><IMG SRC="binary/fw_up.gif" HEIGHT="32" WIDTH="32" BORDER="0" ALT="Up"></A></TD>
<TD ALIGN="right"  VALIGN="bottom"><A HREF="implement_indentation.html"><IMG SRC="binary/fw_right.gif" HEIGHT="32" WIDTH="32" BORDER="0" ALT="Next"></A></TD>
</TR>
</TABLE>



<P>
<HR>
<FONT SIZE="2">
<A HREF="mailto:webmaster@ross.net">Webmaster</A>&nbsp;&nbsp;&nbsp;
<A HREF="copyright.html">Copyright &copy; Ross N. Williams 1992,1999. All rights reserved.</A><BR>
</FONT>

</FONT>
</TD>
</TR>
</TABLE>


</BODY>

<!-- *********************************************************************** -->
<!--      End Of A FunnelWeb Manual Web Page (www.ross.net/funnelweb/)       -->
<!-- *********************************************************************** -->

</HTML>