.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.4.
.TH HEAPTRACK_PRINT "1" "March 2017" "heaptrack_print 1.0.0" "User Commands"
.SH NAME
heaptrack_print \- heap memory profiler for linux, print utility
.SH DESCRIPTION
heaptrack_print \- analyze heaptrack data files.
.PP
heaptrack is a heap memory profiler which records information
about calls to heap allocation functions such as malloc, operator new etc. pp.
This print utility can then be used to analyze the generated data files.
.SH OPTIONS
.TP
\fB\-f\fR [ \fB\-\-file\fR ] arg
The heaptrack data file to print.
.TP
\fB\-d\fR [ \fB\-\-diff\fR ] arg
Find the differences to this file.
.TP
\fB\-t\fR [ \fB\-\-shorten\-templates\fR ] [=arg(=1)] (=1)
Shorten template identifiers.
.TP
\fB\-m\fR [ \fB\-\-merge\-backtraces\fR ] [=arg(=1)] (=1)
Merge backtraces.
NOTE: the merged peak consumption is not correct.
.TP
\fB\-p\fR [ \fB\-\-print\-peaks\fR ] [=arg(=1)] (=1)
Print backtraces to top allocators, sorted by peak consumption.
.TP
\fB\-a\fR [ \fB\-\-print\-allocators\fR ] [=arg(=1)] (=1)
Print backtraces to top allocators, sorted by number of calls to
allocation functions.
.TP
\fB\-T\fR [ \fB\-\-print\-temporary\fR ] [=arg(=1)] (=1)
Print backtraces to top allocators, sorted by number of temporary
allocations.
.TP
\fB\-l\fR [ \fB\-\-print\-leaks\fR ] [=arg(=1)] (=0)
Print backtraces to leaked memory allocations.
.HP
\fB\-o\fR [ \fB\-\-print\-overall\-allocated\fR ] [=arg(=1)] (=0) Print top overall allocators, ignoring memory frees.
.TP
\fB\-n\fR [ \fB\-\-peak\-limit\fR ] [=arg(=10)] (=10)
Limit the number of reported peaks.
.TP
\fB\-s\fR [ \fB\-\-sub\-peak\-limit\fR ] [=arg(=5)] (=5)
Limit the number of reported backtraces of merged peak locations.
.TP
\fB\-H\fR [ \fB\-\-print\-histogram\fR ] arg
Path to output file where an allocation size histogram will be
written to.
.TP
\fB\-F\fR [ \fB\-\-print\-flamegraph\fR ] arg
Path to output file where a flame\-graph compatible stack file will
be written to.
To visualize the resulting file, use flamegraph.pl from
https://github.com/brendangregg/FlameGraph:
.TP
heaptrack_print heaptrack.someapp.PID.gz \fB\-F\fR stacks.txt
# optionally pass \fB\-\-reverse\fR to flamegraph.pl
flamegraph.pl \fB\-\-title\fR "heaptrack: allocations" \fB\-\-colors\fR mem \e
.TP
\fB\-\-countname\fR allocations < stacks.txt > heaptrack.someapp.PID.svg
[firefox|chromium] heaptrack.someapp.PID.svg
.TP
\fB\-M\fR [ \fB\-\-print\-massif\fR ] arg
Path to output file where a massif compatible data file will be
written to.
.TP
\fB\-\-massif\-threshold\fR arg (=1)
Percentage of current memory usage, below which allocations are
aggregated into a 'below threshold' entry.
This is only used in the massif output file so far.
.TP
\fB\-\-massif\-detailed\-freq\fR arg (=2)
Frequency of detailed snapshots in the massif output file. Increase
this to reduce the file size.
You can set the value to zero to disable detailed snapshots.
.TP
\fB\-\-filter\-bt\-function\fR arg
Only print allocations where the backtrace contains the given
function.
.TP
\fB\-h\fR [ \fB\-\-help\fR ]
Show this help message.
.TP
\fB\-v\fR [ \fB\-\-version\fR ]
Displays version information.
.SH "SEE ALSO"
The full documentation for
.B heaptrack_print
is maintained as a Texinfo manual.  If the
.B info
and
.B heaptrack_print
programs are properly installed at your site, the command
.IP
.B info heaptrack_print
.PP
should give you access to the complete manual.