blob: 1d05c0cf82b1a5914e9c47e74d487fd2c6d7a51c [file] [log] [blame]
Djordje Todorovic2ef18fb2019-10-02 07:00:01 +00001llvm-locstats - calculate statistics on DWARF debug location
2============================================================
3
4.. program:: llvm-locstats
5
6SYNOPSIS
7--------
8
9:program:`llvm-locstats` [*options*] [*filename*]
10
11DESCRIPTION
12-----------
13
14:program:`llvm-locstats` works like a wrapper around :program:`llvm-dwarfdump`.
15It parses :program:`llvm-dwarfdump` statistics regarding debug location by
16pretty printing it in a more human readable way.
17
18The line 0% shows the number and the percentage of DIEs with no location
19information, but the line 100% shows the information for DIEs where there is
20location information in all code section bytes (where the variable or parameter
Kristina Bessonova1cc4b602019-12-11 20:52:49 +030021is in the scope). The line [50%,60%) shows the number and the percentage of DIEs
22where the location information is between 50 and 60 percentage of its scope
Djordje Todorovic2ef18fb2019-10-02 07:00:01 +000023covered.
24
25OPTIONS
26-------
27
28.. option:: -only-variables
29
30 Calculate the location statistics only for local variables.
31
32.. option:: -only-formal-parameters
33
34 Calculate the location statistics only for formal parameters.
35
36.. option:: -ignore-debug-entry-values
37
38 Ignore the location statistics on locations containing the
39 debug entry values DWARF operation.
40
41EXIT STATUS
42-----------
43
44:program:`llvm-locstats` returns 0 if the input file were parsed
45successfully. Otherwise, it returns 1.
46
47OUTPUT EXAMPLE
48--------------
49
50.. code-block:: none
51
52 =================================================
53 Debug Location Statistics
54 =================================================
55 cov% samples percentage(~)
56 -------------------------------------------------
57 0% 1 16%
Kristina Bessonovad5655c42019-12-05 16:45:57 +030058 (0%,10%) 0 0%
Kristina Bessonova1cc4b602019-12-11 20:52:49 +030059 [10%,20%) 0 0%
60 [20%,30%) 0 0%
61 [30%,40%) 0 0%
62 [40%,50%) 0 0%
63 [50%,60%) 1 16%
64 [60%,70%) 0 0%
65 [70%,80%) 0 0%
66 [80%,90%) 1 16%
67 [90%,100%) 0 0%
Djordje Todorovic2ef18fb2019-10-02 07:00:01 +000068 100% 3 50%
69 =================================================
70 -the number of debug variables processed: 6
71 -PC ranges covered: 81%
72 -------------------------------------------------
73 -total availability: 83%
74 =================================================
75
76SEE ALSO
77--------
78
79:manpage:`llvm-dwarfdump(1)`