llvm/docs/CommandGuide/llvm-locstats.rst

llvm-locstats - calculate statistics on DWARF debug location
============================================================

.. program:: llvm-locstats

SYNOPSIS
--------

:program:`llvm-locstats` [*options*] [*filename*]

DESCRIPTION
-----------

:program:`llvm-locstats` works like a wrapper around :program:`llvm-dwarfdump`.
It parses :program:`llvm-dwarfdump` statistics regarding debug location by
pretty printing it in a more human readable way.

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.

OPTIONS
-------

.. option:: -only-variables

            Calculate the location statistics only for local variables.

.. option:: -only-formal-parameters

            Calculate the location statistics only for formal parameters.

.. option:: -ignore-debug-entry-values

            Ignore the location statistics on locations containing the
            debug entry values DWARF operation.

EXIT STATUS
-----------

:program:`llvm-locstats` returns 0 if the input file were parsed
successfully. Otherwise, it returns 1.

OUTPUT EXAMPLE
--------------

.. code-block:: none

  =================================================
            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%
  =================================================

SEE ALSO
--------

:manpage:`llvm-dwarfdump(1)`