1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
|
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>llvm-locstats - calculate statistics on DWARF debug location — LLVM 13 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/llvm-theme.css" type="text/css" />
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="llvm-pdbutil - PDB File forensics and diagnostics" href="llvm-pdbutil.html" />
<link rel="prev" title="llvm-exegesis - LLVM Machine Instruction Benchmark" href="llvm-exegesis.html" />
<style type="text/css">
table.right { float: right; margin-left: 20px; }
table.right td { border: 1px solid #ccc; }
</style>
</head><body>
<div class="logo">
<a href="../index.html">
<img src="../_static/logo.png"
alt="LLVM Logo" width="250" height="88"/></a>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="llvm-pdbutil.html" title="llvm-pdbutil - PDB File forensics and diagnostics"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="llvm-exegesis.html" title="llvm-exegesis - LLVM Machine Instruction Benchmark"
accesskey="P">previous</a> |</li>
<li><a href="https://llvm.org/">LLVM Home</a> | </li>
<li><a href="../index.html">Documentation</a>»</li>
<li class="nav-item nav-item-1"><a href="../Reference.html" >Reference</a> »</li>
<li class="nav-item nav-item-2"><a href="index.html" accesskey="U">LLVM Command Guide</a> »</li>
<li class="nav-item nav-item-this"><a href="">llvm-locstats - calculate statistics on DWARF debug location</a></li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3>Documentation</h3>
<ul class="want-points">
<li><a href="https://llvm.org/docs/GettingStartedTutorials.html">Getting Started/Tutorials</a></li>
<li><a href="https://llvm.org/docs/UserGuides.html">User Guides</a></li>
<li><a href="https://llvm.org/docs/Reference.html">Reference</a></li>
</ul>
<h3>Getting Involved</h3>
<ul class="want-points">
<li><a href="https://llvm.org/docs/Contributing.html">Contributing to LLVM</a></li>
<li><a href="https://llvm.org/docs/HowToSubmitABug.html">Submitting Bug Reports</a></li>
<li><a href="https://llvm.org/docs/GettingInvolved.html#mailing-lists">Mailing Lists</a></li>
<li><a href="https://llvm.org/docs/GettingInvolved.html#irc">IRC</a></li>
<li><a href="https://llvm.org/docs/GettingInvolved.html#meetups-and-social-events">Meetups and Social Events</a></li>
</ul>
<h3>Additional Links</h3>
<ul class="want-points">
<li><a href="https://llvm.org/docs/FAQ.html">FAQ</a></li>
<li><a href="https://llvm.org/docs/Lexicon.html">Glossary</a></li>
<li><a href="https://llvm.org/pubs">Publications</a></li>
<li><a href="https://github.com/llvm/llvm-project//">Github Repository</a></li>
</ul>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/CommandGuide/llvm-locstats.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="llvm-locstats-calculate-statistics-on-dwarf-debug-location">
<h1>llvm-locstats - calculate statistics on DWARF debug location<a class="headerlink" href="#llvm-locstats-calculate-statistics-on-dwarf-debug-location" title="Permalink to this headline">¶</a></h1>
<div class="section" id="synopsis">
<h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
<p><strong class="program">llvm-locstats</strong> [<em>options</em>] [<em>filename</em>]</p>
</div>
<div class="section" id="description">
<h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
<p><strong class="program">llvm-locstats</strong> works like a wrapper around <strong class="program">llvm-dwarfdump</strong>.
It parses <strong class="program">llvm-dwarfdump</strong> statistics regarding debug location by
pretty printing it in a more human readable way.</p>
<p>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%,60%) shows the number and the percentage of DIEs
where the location information is between 50 and 60 percentage of its scope
covered.</p>
</div>
<div class="section" id="options">
<h2>OPTIONS<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
<dl class="std option">
<dt id="cmdoption-llvm-locstats-only-variables">
<code class="sig-name descname"><span class="pre">--only-variables</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-locstats-only-variables" title="Permalink to this definition">¶</a></dt>
<dd><p>calculate the location statistics only for local variables</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-locstats-only-formal-parameters">
<code class="sig-name descname"><span class="pre">--only-formal-parameters</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-locstats-only-formal-parameters" title="Permalink to this definition">¶</a></dt>
<dd><p>calculate the location statistics only for formal parameters</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-locstats-ignore-debug-entry-values">
<code class="sig-name descname"><span class="pre">--ignore-debug-entry-values</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-locstats-ignore-debug-entry-values" title="Permalink to this definition">¶</a></dt>
<dd><p>ignore the location statistics on locations containing the
debug entry values DWARF operation</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-locstats-draw-plot">
<code class="sig-name descname"><span class="pre">--draw-plot</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-locstats-draw-plot" title="Permalink to this definition">¶</a></dt>
<dd><p>make histogram of location buckets generated (requires
matplotlib)</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-locstats-compare">
<code class="sig-name descname"><span class="pre">--compare</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-locstats-compare" title="Permalink to this definition">¶</a></dt>
<dd><p>compare the debug location coverage on two files provided, and draw
a plot showing the difference (requires matplotlib)</p>
</dd></dl>
</div>
<div class="section" id="exit-status">
<h2>EXIT STATUS<a class="headerlink" href="#exit-status" title="Permalink to this headline">¶</a></h2>
<p><strong class="program">llvm-locstats</strong> returns 0 if the input file were parsed
successfully. Otherwise, it returns 1.</p>
</div>
<div class="section" id="example-1">
<h2>EXAMPLE 1<a class="headerlink" href="#example-1" title="Permalink to this headline">¶</a></h2>
<p>Pretty print the location coverage on the standard output.</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>llvm-locstats a.out
=================================================
Debug Location Statistics
=================================================
cov% samples percentage(~)
-------------------------------------------------
0% 1 16%
(0%,10%) 0 0%
[10%,20%) 0 0%
[20%,30%) 0 0%
[30%,40%) 0 0%
[40%,50%) 0 0%
[50%,60%) 1 16%
[60%,70%) 0 0%
[70%,80%) 0 0%
[80%,90%) 1 16%
[90%,100%) 0 0%
100% 3 50%
=================================================
-the number of debug variables processed: 6
-PC ranges covered: 81%
-------------------------------------------------
-total availability: 83%
=================================================
</pre></div>
</div>
</div>
<div class="section" id="example-2">
<h2>EXAMPLE 2<a class="headerlink" href="#example-2" title="Permalink to this headline">¶</a></h2>
<p>Generate a plot as an image file.</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>llvm-locstats --draw-plot file1.out
</pre></div>
</div>
<img alt="../_images/locstats-draw-plot.png" class="align-center" src="../_images/locstats-draw-plot.png" />
</div>
<div class="section" id="example-3">
<h2>EXAMPLE 3<a class="headerlink" href="#example-3" title="Permalink to this headline">¶</a></h2>
<p>Generate a plot as an image file showing the difference in the debug location
coverage.</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>llvm-locstats --compare file1.out file1.withentryvals.out
</pre></div>
</div>
<img alt="../_images/locstats-compare.png" class="align-center" src="../_images/locstats-compare.png" />
</div>
<div class="section" id="see-also">
<h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
<p><em class="manpage"><a class="manpage reference external" href="https://llvm.org/docs/CommandGuide/llvm-dwarfdump.html">llvm-dwarfdump(1)</a></em></p>
</div>
</div>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="llvm-pdbutil.html" title="llvm-pdbutil - PDB File forensics and diagnostics"
>next</a> |</li>
<li class="right" >
<a href="llvm-exegesis.html" title="llvm-exegesis - LLVM Machine Instruction Benchmark"
>previous</a> |</li>
<li><a href="https://llvm.org/">LLVM Home</a> | </li>
<li><a href="../index.html">Documentation</a>»</li>
<li class="nav-item nav-item-1"><a href="../Reference.html" >Reference</a> »</li>
<li class="nav-item nav-item-2"><a href="index.html" >LLVM Command Guide</a> »</li>
<li class="nav-item nav-item-this"><a href="">llvm-locstats - calculate statistics on DWARF debug location</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2003-2021, LLVM Project.
Last updated on 2021-09-18.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.5.4.
</div>
</body>
</html>
|
