.\" Man page generated from reStructuredText.
.
.TH "LLVM-LOCSTATS" "1" "2019-10-19" "10" "LLVM"
.SH NAME
llvm-locstats \- calculate statistics on DWARF debug location
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
\fBllvm\-locstats\fP [\fIoptions\fP] [\fIfilename\fP]
.SH DESCRIPTION
.sp
\fBllvm\-locstats\fP works like a wrapper around \fBllvm\-dwarfdump\fP\&.
It parses \fBllvm\-dwarfdump\fP statistics regarding debug location by
pretty printing it in a more human readable way.
.sp
The line 0% shows the number and the percentage of DIEs with no location
information, but the line 100% shows the information for DIEs where there is
location information in all code section bytes (where the variable or parameter
is in the scope). The line 50\-59% shows the number and the percentage of DIEs
where the location information is between 50 and 59 percentage of its scope
covered.
.SH OPTIONS
.INDENT 0.0
.TP
.B \-only\-variables
Calculate the location statistics only for local variables.
.UNINDENT
.INDENT 0.0
.TP
.B \-only\-formal\-parameters
Calculate the location statistics only for formal parameters.
.UNINDENT
.INDENT 0.0
.TP
.B \-ignore\-debug\-entry\-values
Ignore the location statistics on locations containing the
debug entry values DWARF operation.
.UNINDENT
.SH EXIT STATUS
.sp
\fBllvm\-locstats\fP returns 0 if the input file were parsed
successfully. Otherwise, it returns 1.
.SH OUTPUT EXAMPLE
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
=================================================
          Debug Location Statistics
=================================================
      cov%          samples       percentage(~)
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
   0%                    1              16%
   1\-9%                  0               0%
   10\-19%                0               0%
   20\-29%                0               0%
   30\-39%                0               0%
   40\-49%                0               0%
   50\-59%                1              16%
   60\-69%                0               0%
   70\-79%                0               0%
   80\-89%                1              16%
   90\-99%                0               0%
   100%                  3              50%
=================================================
\-the number of debug variables processed: 6
\-PC ranges covered: 81%
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\-total availability: 83%
=================================================
.ft P
.fi
.UNINDENT
.UNINDENT
.SH SEE ALSO
.sp
\fBllvm\-dwarfdump(1)\fP
.SH AUTHOR
Maintained by the LLVM Team (https://llvm.org/).
.SH COPYRIGHT
2003-2019, LLVM Project
.\" Generated by docutils manpage writer.
.