Codebase list cppad / upstream/2015.00.00.7 doc / memory_leak.xml
upstream/2015.00.00.7

Tree @upstream/2015.00.00.7 (Download .tar.gz)

memory_leak.xml @upstream/2015.00.00.7 — raw · history · blame 

  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
252
253
254
255
256
257
<?xml version='1.0'?>
<html xmlns='http://www.w3.org/1999/xhtml'
      xmlns:math='http://www.w3.org/1998/Math/MathML'
>
<head>
<title>Memory Leak Detection</title>
<meta http-equiv='Content-Type' content='text/html' charset='utf-8'/>
<meta name="description" id="description" content="Memory Leak Detection"/>
<meta name="keywords" id="keywords" content=" memory leak detection memory_leak check static deprecated syntax purpose thread add_static flag inuse available track_count error message "/>
<style type='text/css'>
body { color : black }
body { background-color : white }
A:link { color : blue }
A:visited { color : purple }
A:active { color : purple }
</style>
<script type='text/javascript' language='JavaScript' src='_memory_leak_xml.js'>
</script>
</head>
<body>
<table><tr>
<td>
<a href="http://www.coin-or.org/CppAD/" target="_top"><img border="0" src="_image.gif"/></a>
</td>
<td><a href="omp_alloc.cpp.xml" target="_top">Prev</a>
</td><td><a href="epsilon.xml" target="_top">Next</a>
</td><td>
<select onchange='choose_across0(this)'>
<option>Index-&gt;</option>
<option>contents</option>
<option>reference</option>
<option>index</option>
<option>search</option>
<option>external</option>
</select>
</td>
<td>
<select onchange='choose_up0(this)'>
<option>Up-&gt;</option>
<option>CppAD</option>
<option>Appendix</option>
<option>deprecated</option>
<option>memory_leak</option>
</select>
</td>
<td>
<select onchange='choose_down3(this)'>
<option>CppAD-&gt;</option>
<option>Install</option>
<option>Introduction</option>
<option>AD</option>
<option>ADFun</option>
<option>preprocessor</option>
<option>multi_thread</option>
<option>library</option>
<option>ipopt_solve</option>
<option>Example</option>
<option>speed</option>
<option>Appendix</option>
</select>
</td>
<td>
<select onchange='choose_down2(this)'>
<option>Appendix-&gt;</option>
<option>Faq</option>
<option>Theory</option>
<option>glossary</option>
<option>Bib</option>
<option>Bugs</option>
<option>WishList</option>
<option>whats_new</option>
<option>deprecated</option>
<option>compare_c</option>
<option>License</option>
</select>
</td>
<td>
<select onchange='choose_down1(this)'>
<option>deprecated-&gt;</option>
<option>include_deprecated</option>
<option>FunDeprecated</option>
<option>omp_max_thread</option>
<option>TrackNewDel</option>
<option>omp_alloc</option>
<option>memory_leak</option>
<option>epsilon</option>
<option>test_vector</option>
<option>cppad_ipopt_nlp</option>
<option>old_atomic</option>
</select>
</td>
<td>memory_leak</td>
<td>
<select onchange='choose_current0(this)'>
<option>Headings-&gt;</option>
<option>Deprecated</option>
<option>Syntax</option>
<option>Purpose</option>
<option>thread</option>
<option>add_static</option>
<option>flag</option>
<option>inuse</option>
<option>available</option>
<option>TRACK_COUNT</option>
<option>Error Message</option>
</select>
</td>
</tr></table><br/>



<center><b><big><big>Memory Leak Detection</big></big></b></center>
<br/>
<b><big><a name="Deprecated" id="Deprecated">Deprecated</a></big></b>

<br/>
This routine has been deprecated.
You should instead use the routine <a href="ta_free_all.xml" target="_top"><span style='white-space: nowrap'>ta_free_all</span></a>
.

<br/>
<br/>
<b><big><a name="Syntax" id="Syntax">Syntax</a></big></b>

<br/>

<code><i><font color="black"><span style='white-space: nowrap'>flag</span></font></i><font color="blue"><span style='white-space: nowrap'>&#xA0;=&#xA0;</span></font><i><font color="black"><span style='white-space: nowrap'>memory_leak()<br/>
</span></font></i></code>

<code><i><font color="black"><span style='white-space: nowrap'>flag</span></font></i><font color="blue"><span style='white-space: nowrap'>&#xA0;=&#xA0;</span></font><i><font color="black"><span style='white-space: nowrap'>memory_leak(</span></font></i><font color="blue"><span style='white-space: nowrap'>add_static</span></font><i><font color="black"><span style='white-space: nowrap'>)</span></font></i></code>


<br/>
<br/>
<b><big><a name="Purpose" id="Purpose">Purpose</a></big></b>
<br/>
This routine checks that the are no memory leaks 
caused by improper use of <a href="thread_alloc.xml" target="_top"><span style='white-space: nowrap'>thread_alloc</span></a>
 memory allocator.
The deprecated memory allocator <a href="tracknewdel.xml" target="_top"><span style='white-space: nowrap'>TrackNewDel</span></a>
 is also checked.
Memory errors in the deprecated <a href="omp_alloc.xml" target="_top"><span style='white-space: nowrap'>omp_alloc</span></a>
 allocator are
reported as being in <code><font color="blue">thread_alloc</font></code>.

<br/>
<br/>
<b><big><a name="thread" id="thread">thread</a></big></b>
<br/>
It is assumed that <a href="ta_in_parallel.xml" target="_top"><span style='white-space: nowrap'>in_parallel()</span></a>
 is false
and <a href="ta_thread_num.xml" target="_top"><span style='white-space: nowrap'>thread_num</span></a>
 is zero when
<code><font color="blue">memory_leak</font></code> is called.

<br/>
<br/>
<b><big><a name="add_static" id="add_static">add_static</a></big></b>
<br/>
This argument has prototype

<code><font color="blue"><span style='white-space: nowrap'><br/>
&#xA0;&#xA0;&#xA0;&#xA0;&#xA0;size_t&#xA0;</span></font><i><font color="black"><span style='white-space: nowrap'>add_static</span></font></i><font color="blue"><span style='white-space: nowrap'><br/>
</span></font></code>
and its default value is zero.
Static variables hold onto memory forever.
If the argument 
<code><i><font color="black"><span style='white-space: nowrap'>add_static</span></font></i></code>
 is present (and non-zero),
<code><font color="blue">memory_leak</font></code> adds this amount of memory to the
<a href="ta_inuse.xml" target="_top"><span style='white-space: nowrap'>inuse</span></a>
 sum that corresponds to 
static variables in the program.
A call with 
<code><i><font color="black"><span style='white-space: nowrap'>add_static</span></font></i></code>
 should be make after
a routine that has static variables which
use <a href="ta_get_memory.xml" target="_top"><span style='white-space: nowrap'>get_memory</span></a>
 to allocate memory.
The value of 
<code><i><font color="black"><span style='white-space: nowrap'>add_static</span></font></i></code>
 should be the difference of

<code><font color="blue"><span style='white-space: nowrap'><br/>
&#xA0;&#xA0;&#xA0;&#xA0;&#xA0;thread_alloc::inuse(0)<br/>
</span></font></code>
before and after the call.
Since multiple statics may be allocated in different places in the program,
it is expected that there will be multiple calls
that use this option.

<br/>
<br/>
<b><big><a name="flag" id="flag">flag</a></big></b>
<br/>
The return value 
<code><i><font color="black"><span style='white-space: nowrap'>flag</span></font></i></code>
 has prototype

<code><font color="blue"><span style='white-space: nowrap'><br/>
&#xA0;&#xA0;&#xA0;&#xA0;&#xA0;bool&#xA0;</span></font><i><font color="black"><span style='white-space: nowrap'>flag</span></font></i><font color="blue"><span style='white-space: nowrap'><br/>
</span></font></code>
If 
<code><i><font color="black"><span style='white-space: nowrap'>add_static</span></font></i></code>
 is non-zero,
the return value for <code><font color="blue">memory_leak</font></code> is false.
Otherwise, the return value for <code><font color="blue">memory_leak</font></code> should be false
(indicating that the only allocated memory corresponds to static variables).

<br/>
<br/>
<b><big><a name="inuse" id="inuse">inuse</a></big></b>
<br/>
It is assumed that, when <code><font color="blue">memory_leak</font></code> is called,
there should not be any memory
<a href="ta_inuse.xml" target="_top"><span style='white-space: nowrap'>inuse</span></a>
 or <a href="omp_inuse.xml" target="_top"><span style='white-space: nowrap'>omp_inuse</span></a>
 for any thread
(except for inuse memory corresponding to static variables).
If there is, a message is printed and <code><font color="blue">memory_leak</font></code> returns false.

<br/>
<br/>
<b><big><a name="available" id="available">available</a></big></b>
<br/>
It is assumed that, when <code><font color="blue">memory_leak</font></code> is called,
there should not be any memory
<a href="ta_available.xml" target="_top"><span style='white-space: nowrap'>available</span></a>
 or <a href="omp_available.xml" target="_top"><span style='white-space: nowrap'>omp_available</span></a>
 for any thread;
i.e., it all has been returned to the system.
If there is memory still available for any thread,
<code><font color="blue">memory_leak</font></code> returns false. 

<br/>
<br/>
<b><big><a name="TRACK_COUNT" id="TRACK_COUNT">TRACK_COUNT</a></big></b>
<br/>
It is assumed that, when <code><font color="blue">memory_leak</font></code> is called,
<a href="tracknewdel.xml#TrackCount" target="_top"><span style='white-space: nowrap'>TrackCount</span></a>
 will return a zero value.
If it returns a non-zero value, 
<code><font color="blue">memory_leak</font></code> returns false.

<br/>
<br/>
<b><big><a name="Error Message" id="Error Message">Error Message</a></big></b>
<br/>
If this is the first call to <code><font color="blue">memory_leak</font></code>, no message is printed.
Otherwise, if it returns true, an error message is printed
to standard output describing the memory leak that was detected.


<hr/>Input File: cppad/memory_leak.hpp

</body>
</html>