Author: philippe
Date: Sun Nov 20 11:41:25 2016
New Revision: 16146
Log:
xtree: some documentation and --help-debug fine tuning
Modified:
trunk/NEWS
trunk/coregrind/m_main.c
trunk/helgrind/docs/hg-manual.xml
trunk/massif/docs/ms-manual.xml
trunk/memcheck/docs/mc-manual.xml
trunk/none/tests/cmdline2.stdout.exp
Modified: trunk/NEWS
==============================================================================
--- trunk/NEWS (original)
+++ trunk/NEWS Sun Nov 20 11:41:25 2016
@@ -12,19 +12,19 @@
10.10 and AMD64/MacOSX 10.10. There is also preliminary support for
X86/MacOSX 10.11/12, AMD64/MacOSX 10.11/12 and TILEGX/Linux.
-A significant change in 3.13 is the addition of the 'xtree' concept:
-An xtree is a tree of stacktraces with data associated to the stacktraces.
-This xtree is used by various tools (memcheck, helgrind, massif) to
-report the heap consumption of your program. The xtree reporting
-is controlled by the new options --xtree-memory=none|allocs|full and
---xtree-memory-file=<file>.
-An heap xtree memory profiling can also be produced on demand using
-a gdbserver monitor command.
-The xtree can be output in 2 formats: 'callgrind format'
-and 'massif format. The existing visualisers for these formats (e.g.
-callgrind_annotate, kcachegrind, ms_print) can be used to visualise
-and analyse these reports.
-For more details, read the user manual.
+* The 'xtree concept' was added in 3.13:
+ An xtree is a tree of stacktraces with data associated to the stacktraces.
+ This xtree is used by various tools (memcheck, helgrind, massif) to
+ report the heap consumption of your program. The xtree reporting
+ is controlled by the new options --xtree-memory=none|allocs|full and
+ --xtree-memory-file=<file>.
+ An heap xtree memory profiling can also be produced on demand using
+ the gdbserver monitor command 'xtmemory [<filename>]>'.
+ The xtree can be output in 2 formats: 'callgrind format'
+ and 'massif format. The existing visualisers for these formats (e.g.
+ callgrind_annotate, kcachegrind, ms_print) can be used to visualise
+ and analyse these reports.
+ For more details, read the user manual.
* ================== PLATFORM CHANGES =================
@@ -32,28 +32,18 @@
* Memcheck:
- - Support for --xtree-memory profiling.
-
- - A new monitor command 'xtmemory [<filename>]>' produces a
- heap usage profile report.
+ - Support for --xtree-memory and 'xtmemory [<filename>]>'.
* Massif:
- - Support for --xtree-memory profiling.
-
- - A new monitor command 'xtmemory [<filename>]>' produces a
- heap usage profile report.
+ - Support for --xtree-memory and 'xtmemory [<filename>]>'.
- For some workloads (typically, for big applications), Massif
memory consumption and CPU consumption decreases significantly.
* Helgrind:
- - Support for --xtree-memory profiling.
-
- - A new monitor command 'xtmemory [<filename>]>' produces a
- heap usage profile report.
-
+ - Support for --xtree-memory and 'xtmemory [<filename>]>'.
* ==================== OTHER CHANGES ====================
@@ -62,6 +52,7 @@
will append the inner guest stacktrace to the inner host stacktrace.
This helps to investigate the errors reported by the outer, when they
are caused by the inner guest program (such as an inner regtest).
+ See README_DEVELOPERS for more info.
* ==================== FIXED BUGS ====================
Modified: trunk/coregrind/m_main.c
==============================================================================
--- trunk/coregrind/m_main.c (original)
+++ trunk/coregrind/m_main.c Sun Nov 20 11:41:25 2016
@@ -294,6 +294,7 @@
"\n"
" debugging options for Valgrind tools that replace malloc:\n"
" --trace-malloc=no|yes show client malloc details? [no]\n"
+" --xtree-compress-strings=no|yes compress strings in xtree callgrind format [yes]\n"
"\n";
const HChar usage3[] =
Modified: trunk/helgrind/docs/hg-manual.xml
==============================================================================
--- trunk/helgrind/docs/hg-manual.xml (original)
+++ trunk/helgrind/docs/hg-manual.xml Sun Nov 20 11:41:25 2016
@@ -64,6 +64,11 @@
<varname>ANNOTATE_*</varname> macros defined
in <varname>helgrind.h</varname>.</para>
+<para>Helgrind also provides <xref linkend="manual-core.xtree"/> memory
+ profiling using the command line
+ option <computeroutput>--xtree-memory</computeroutput> and the monitor command
+ <computeroutput>xtmemory</computeroutput>.</para>
+
<para>Following those is a section containing
Modified: trunk/massif/docs/ms-manual.xml
==============================================================================
--- trunk/massif/docs/ms-manual.xml (original)
+++ trunk/massif/docs/ms-manual.xml Sun Nov 20 11:41:25 2016
@@ -46,6 +46,11 @@
which parts of your program are responsible for allocating the heap memory.
</para>
+<para>Massif also provides <xref linkend="manual-core.xtree"/> memory
+ profiling using the command line
+ option <computeroutput>--xtree-memory</computeroutput> and the monitor command
+ <computeroutput>xtmemory</computeroutput>.</para>
+
</sect1>
Modified: trunk/memcheck/docs/mc-manual.xml
==============================================================================
--- trunk/memcheck/docs/mc-manual.xml (original)
+++ trunk/memcheck/docs/mc-manual.xml Sun Nov 20 11:41:25 2016
@@ -57,8 +57,12 @@
<para>Problems like these can be difficult to find by other means,
often remaining undetected for long periods, then causing occasional,
-difficult-to-diagnose crashes.</para>
+ difficult-to-diagnose crashes.</para>
+<para>Memcheck also provides <xref linkend="manual-core.xtree"/> memory
+ profiling using the command line
+ option <computeroutput>--xtree-memory</computeroutput> and the monitor command
+ <computeroutput>xtmemory</computeroutput>.</para>
</sect1>
@@ -1040,6 +1044,13 @@
and/or by using a smaller value for the
option <varname>--num-callers</varname>.
</para>
+
+ <para>If you want to use
+ <computeroutput>--xtree-memory=full</computeroutput> memory profiling
+ (see <xref linkend="manual-core.xtree"/> ), then you cannot
+ specify <varname>--keep-stacktraces=free</varname>
+ or <varname>--keep-stacktraces=none</varname>.</para>
+
</listitem>
</varlistentry>
Modified: trunk/none/tests/cmdline2.stdout.exp
==============================================================================
--- trunk/none/tests/cmdline2.stdout.exp (original)
+++ trunk/none/tests/cmdline2.stdout.exp Sun Nov 20 11:41:25 2016
@@ -205,6 +205,7 @@
debugging options for Valgrind tools that replace malloc:
--trace-malloc=no|yes show client malloc details? [no]
+ --xtree-compress-strings=no|yes compress strings in xtree callgrind format [yes]
debugging options for Nulgrind:
(none)
|