| Djordje Todorovic | 2ef18fb | 2019-10-02 07:00:01 +0000 | [diff] [blame] | 1 | llvm-locstats - calculate statistics on DWARF debug location |
| 2 | ============================================================ |
| 3 | |
| 4 | .. program:: llvm-locstats |
| 5 | |
| 6 | SYNOPSIS |
| 7 | -------- |
| 8 | |
| 9 | :program:`llvm-locstats` [*options*] [*filename*] |
| 10 | |
| 11 | DESCRIPTION |
| 12 | ----------- |
| 13 | |
| 14 | :program:`llvm-locstats` works like a wrapper around :program:`llvm-dwarfdump`. |
| 15 | It parses :program:`llvm-dwarfdump` statistics regarding debug location by |
| 16 | pretty printing it in a more human readable way. |
| 17 | |
| 18 | The line 0% shows the number and the percentage of DIEs with no location |
| 19 | information, but the line 100% shows the information for DIEs where there is |
| 20 | location information in all code section bytes (where the variable or parameter |
| 21 | is in the scope). The line 50-59% shows the number and the percentage of DIEs |
| 22 | where the location information is between 50 and 59 percentage of its scope |
| 23 | covered. |
| 24 | |
| 25 | OPTIONS |
| 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 | |
| 41 | EXIT STATUS |
| 42 | ----------- |
| 43 | |
| 44 | :program:`llvm-locstats` returns 0 if the input file were parsed |
| 45 | successfully. Otherwise, it returns 1. |
| 46 | |
| 47 | OUTPUT EXAMPLE |
| 48 | -------------- |
| 49 | |
| 50 | .. code-block:: none |
| 51 | |
| 52 | ================================================= |
| 53 | Debug Location Statistics |
| 54 | ================================================= |
| 55 | cov% samples percentage(~) |
| 56 | ------------------------------------------------- |
| 57 | 0% 1 16% |
| 58 | 1-9% 0 0% |
| 59 | 10-19% 0 0% |
| 60 | 20-29% 0 0% |
| 61 | 30-39% 0 0% |
| 62 | 40-49% 0 0% |
| Djordje Todorovic | 0c56f42 | 2019-10-07 07:31:49 +0000 | [diff] [blame] | 63 | 50-59% 1 16% |
| Djordje Todorovic | 2ef18fb | 2019-10-02 07:00:01 +0000 | [diff] [blame] | 64 | 60-69% 0 0% |
| 65 | 70-79% 0 0% |
| 66 | 80-89% 1 16% |
| 67 | 90-99% 0 0% |
| 68 | 100% 3 50% |
| 69 | ================================================= |
| 70 | -the number of debug variables processed: 6 |
| 71 | -PC ranges covered: 81% |
| 72 | ------------------------------------------------- |
| 73 | -total availability: 83% |
| 74 | ================================================= |
| 75 | |
| 76 | SEE ALSO |
| 77 | -------- |
| 78 | |
| 79 | :manpage:`llvm-dwarfdump(1)` |