summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorGuilherme Goncalves <guilherme.p.gonc@gmail.com>2014-12-08 21:12:41 (GMT)
committerJason Evans <jasone@canonware.com>2014-12-15 01:07:26 (GMT)
commit2c5cb613dfbdf58f88152321b63e60c58cd23972 (patch)
tree9c32a6519cb435203141d19a0c0f60fa111803e0 /doc
parentb74041fb6e279bd8bbc133250241249f90cd619f (diff)
downloadjemalloc-2c5cb613dfbdf58f88152321b63e60c58cd23972.zip
jemalloc-2c5cb613dfbdf58f88152321b63e60c58cd23972.tar.gz
jemalloc-2c5cb613dfbdf58f88152321b63e60c58cd23972.tar.bz2
Introduce two new modes of junk filling: "alloc" and "free".
In addition to true/false, opt.junk can now be either "alloc" or "free", giving applications the possibility of junking memory only on allocation or deallocation. This resolves #172.
Diffstat (limited to 'doc')
-rw-r--r--doc/jemalloc.xml.in20
1 files changed, 11 insertions, 9 deletions
diff --git a/doc/jemalloc.xml.in b/doc/jemalloc.xml.in
index 71b4cd1..0148f03 100644
--- a/doc/jemalloc.xml.in
+++ b/doc/jemalloc.xml.in
@@ -930,18 +930,20 @@ for (i = 0; i < nbins; i++) {
<varlistentry id="opt.junk">
<term>
<mallctl>opt.junk</mallctl>
- (<type>bool</type>)
+ (<type>const char *</type>)
<literal>r-</literal>
[<option>--enable-fill</option>]
</term>
- <listitem><para>Junk filling enabled/disabled. If enabled, each byte
- of uninitialized allocated memory will be initialized to
- <literal>0xa5</literal>. All deallocated memory will be initialized to
- <literal>0x5a</literal>. This is intended for debugging and will
- impact performance negatively. This option is disabled by default
- unless <option>--enable-debug</option> is specified during
- configuration, in which case it is enabled by default unless running
- inside <ulink
+ <listitem><para>Junk filling. If set to "alloc", each byte of
+ uninitialized allocated memory will be initialized to
+ <literal>0xa5</literal>. If set to "free", all deallocated memory will
+ be initialized to <literal>0x5a</literal>. If set to "true", both
+ allocated and deallocated memory will be initialized, and if set to
+ "false", junk filling be disabled entirely. This is intended for
+ debugging and will impact performance negatively. This option is
+ "false" by default unless <option>--enable-debug</option> is specified
+ during configuration, in which case it is "true" by default unless
+ running inside <ulink
url="http://valgrind.org/">Valgrind</ulink>.</para></listitem>
</varlistentry>