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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
|
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>llvm-symbolizer - convert addresses into source code locations — 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="opt - LLVM optimizer" href="opt.html" />
<link rel="prev" title="llvm-stress - generate random .ll files" href="llvm-stress.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="opt.html" title="opt - LLVM optimizer"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="llvm-stress.html" title="llvm-stress - generate random .ll files"
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-symbolizer - convert addresses into source code locations</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-symbolizer.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-symbolizer-convert-addresses-into-source-code-locations">
<h1>llvm-symbolizer - convert addresses into source code locations<a class="headerlink" href="#llvm-symbolizer-convert-addresses-into-source-code-locations" 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-symbolizer</strong> [<em>options</em>] [<em>addresses…</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-symbolizer</strong> reads object file names and addresses from the
command-line and prints corresponding source code locations to standard output.</p>
<p>If no address is specified on the command-line, it reads the addresses from
standard input. If no object file is specified on the command-line, but
addresses are, or if at any time an input value is not recognized, the input is
simply echoed to the output.</p>
<p>A positional argument or standard input value can be preceded by “DATA” or
“CODE” to indicate that the address should be symbolized as data or executable
code respectively. If neither is specified, “CODE” is assumed. DATA is
symbolized as address and symbol size rather than line number.</p>
<p>Object files can be specified together with the addresses either on standard
input or as positional arguments on the command-line, following any “DATA” or
“CODE” prefix.</p>
<p><strong class="program">llvm-symbolizer</strong> parses options from the environment variable
<code class="docutils literal notranslate"><span class="pre">LLVM_SYMBOLIZER_OPTS</span></code> after parsing options from the command line.
<code class="docutils literal notranslate"><span class="pre">LLVM_SYMBOLIZER_OPTS</span></code> is primarily useful for supplementing the command-line
options when <strong class="program">llvm-symbolizer</strong> is invoked by another program or
runtime.</p>
</div>
<div class="section" id="examples">
<h2>EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
<p>All of the following examples use the following two source files as input. They
use a mixture of C-style and C++-style linkage to illustrate how these names are
printed differently (see <a class="reference internal" href="#cmdoption-llvm-symbolizer-demangle"><code class="xref std std-option docutils literal notranslate"><span class="pre">--demangle</span></code></a>).</p>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="c1">// test.h</span>
<span class="k">extern</span> <span class="s">"C"</span> <span class="kr">inline</span> <span class="kt">int</span> <span class="n">foz</span><span class="p">()</span> <span class="p">{</span>
<span class="k">return</span> <span class="mi">1234</span><span class="p">;</span>
<span class="p">}</span>
</pre></div>
</div>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="c1">// test.cpp</span>
<span class="cp">#include</span> <span class="cpf">"test.h"</span><span class="cp"></span>
<span class="kt">int</span> <span class="n">bar</span><span class="o">=</span><span class="mi">42</span><span class="p">;</span>
<span class="kt">int</span> <span class="nf">foo</span><span class="p">()</span> <span class="p">{</span>
<span class="k">return</span> <span class="n">bar</span><span class="p">;</span>
<span class="p">}</span>
<span class="kt">int</span> <span class="nf">baz</span><span class="p">()</span> <span class="p">{</span>
<span class="k">volatile</span> <span class="kt">int</span> <span class="n">k</span> <span class="o">=</span> <span class="mi">42</span><span class="p">;</span>
<span class="k">return</span> <span class="n">foz</span><span class="p">()</span> <span class="o">+</span> <span class="n">k</span><span class="p">;</span>
<span class="p">}</span>
<span class="kt">int</span> <span class="nf">main</span><span class="p">()</span> <span class="p">{</span>
<span class="k">return</span> <span class="n">foo</span><span class="p">()</span> <span class="o">+</span> <span class="n">baz</span><span class="p">();</span>
<span class="p">}</span>
</pre></div>
</div>
<p>These files are built as follows:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$</span> clang -g test.cpp -o test.elf
<span class="gp">$</span> clang -g -O2 test.cpp -o inlined.elf
</pre></div>
</div>
<p>Example 1 - addresses and object on command-line:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$</span> llvm-symbolizer --obj<span class="o">=</span>test.elf 0x4004d0 0x400490
<span class="go">foz</span>
<span class="go">/tmp/test.h:1:0</span>
<span class="go">baz()</span>
<span class="go">/tmp/test.cpp:11:0</span>
</pre></div>
</div>
<p>Example 2 - addresses on standard input:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$</span> cat addr.txt
<span class="go">0x4004a0</span>
<span class="go">0x400490</span>
<span class="go">0x4004d0</span>
<span class="gp">$</span> llvm-symbolizer --obj<span class="o">=</span>test.elf < addr.txt
<span class="go">main</span>
<span class="go">/tmp/test.cpp:15:0</span>
<span class="go">baz()</span>
<span class="go">/tmp/test.cpp:11:0</span>
<span class="go">foz</span>
<span class="go">/tmp/./test.h:1:0</span>
</pre></div>
</div>
<p>Example 3 - object specified with address:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$</span> llvm-symbolizer <span class="s2">"test.elf 0x400490"</span> <span class="s2">"inlined.elf 0x400480"</span>
<span class="go">baz()</span>
<span class="go">/tmp/test.cpp:11:0</span>
<span class="go">foo()</span>
<span class="go">/tmp/test.cpp:8:10</span>
<span class="gp">$</span> cat addr2.txt
<span class="go">test.elf 0x4004a0</span>
<span class="go">inlined.elf 0x400480</span>
<span class="gp">$</span> llvm-symbolizer < addr2.txt
<span class="go">main</span>
<span class="go">/tmp/test.cpp:15:0</span>
<span class="go">foo()</span>
<span class="go">/tmp/test.cpp:8:10</span>
</pre></div>
</div>
<p>Example 4 - CODE and DATA prefixes:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$</span> llvm-symbolizer --obj<span class="o">=</span>test.elf <span class="s2">"CODE 0x400490"</span> <span class="s2">"DATA 0x601028"</span>
<span class="go">baz()</span>
<span class="go">/tmp/test.cpp:11:0</span>
<span class="go">bar</span>
<span class="go">6295592 4</span>
<span class="gp">$</span> cat addr3.txt
<span class="go">CODE test.elf 0x4004a0</span>
<span class="go">DATA inlined.elf 0x601028</span>
<span class="gp">$</span> llvm-symbolizer < addr3.txt
<span class="go">main</span>
<span class="go">/tmp/test.cpp:15:0</span>
<span class="go">bar</span>
<span class="go">6295592 4</span>
</pre></div>
</div>
<p>Example 5 - path-style options:</p>
<p>This example uses the same source file as above, but the source file’s
full path is /tmp/foo/test.cpp and is compiled as follows. The first case
shows the default absolute path, the second –basenames, and the third
shows –relativenames.</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$</span> <span class="nb">pwd</span>
<span class="go">/tmp</span>
<span class="gp">$</span> clang -g foo/test.cpp -o test.elf
<span class="gp">$</span> llvm-symbolizer --obj<span class="o">=</span>test.elf 0x4004a0
<span class="go">main</span>
<span class="go">/tmp/foo/test.cpp:15:0</span>
<span class="gp">$</span> llvm-symbolizer --obj<span class="o">=</span>test.elf 0x4004a0 --basenames
<span class="go">main</span>
<span class="go">test.cpp:15:0</span>
<span class="gp">$</span> llvm-symbolizer --obj<span class="o">=</span>test.elf 0x4004a0 --relativenames
<span class="go">main</span>
<span class="go">foo/test.cpp:15:0</span>
</pre></div>
</div>
</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-symbolizer-adjust-vma">
<code class="sig-name descname"><span class="pre">--adjust-vma</span></code><code class="sig-prename descclassname"> <span class="pre"><offset></span></code><a class="headerlink" href="#cmdoption-llvm-symbolizer-adjust-vma" title="Permalink to this definition">¶</a></dt>
<dd><p>Add the specified offset to object file addresses when performing lookups.
This can be used to perform lookups as if the object were relocated by the
offset.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-symbolizer-basenames">
<span id="cmdoption-llvm-symbolizer-s"></span><code class="sig-name descname"><span class="pre">--basenames</span></code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname"><span class="pre">,</span> </code><code class="sig-name descname"><span class="pre">-s</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-symbolizer-basenames" title="Permalink to this definition">¶</a></dt>
<dd><p>Print just the file’s name without any directories, instead of the
absolute path.</p>
</dd></dl>
<span class="target" id="llvm-symbolizer-opt-c"></span><dl class="std option">
<dt id="cmdoption-llvm-symbolizer-demangle">
<span id="cmdoption-llvm-symbolizer-C"></span><span id="cmdoption-llvm-symbolizer-c"></span><code class="sig-name descname"><span class="pre">--demangle</span></code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname"><span class="pre">,</span> </code><code class="sig-name descname"><span class="pre">-C</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-symbolizer-demangle" title="Permalink to this definition">¶</a></dt>
<dd><p>Print demangled function names, if the names are mangled (e.g. the mangled
name <cite>_Z3bazv</cite> becomes <cite>baz()</cite>, whilst the non-mangled name <cite>foz</cite> is printed
as is). Defaults to true.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-symbolizer-dwp">
<code class="sig-name descname"><span class="pre">--dwp</span></code><code class="sig-prename descclassname"> <span class="pre"><path></span></code><a class="headerlink" href="#cmdoption-llvm-symbolizer-dwp" title="Permalink to this definition">¶</a></dt>
<dd><p>Use the specified DWP file at <code class="docutils literal notranslate"><span class="pre"><path></span></code> for any CUs that have split DWARF
debug data.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-symbolizer-fallback-debug-path">
<code class="sig-name descname"><span class="pre">--fallback-debug-path</span></code><code class="sig-prename descclassname"> <span class="pre"><path></span></code><a class="headerlink" href="#cmdoption-llvm-symbolizer-fallback-debug-path" title="Permalink to this definition">¶</a></dt>
<dd><p>When a separate file contains debug data, and is referenced by a GNU debug
link section, use the specified path as a basis for locating the debug data if
it cannot be found relative to the object.</p>
</dd></dl>
<span class="target" id="llvm-symbolizer-opt-f"></span><dl class="std option">
<dt id="cmdoption-llvm-symbolizer-functions">
<span id="cmdoption-llvm-symbolizer-f"></span><code class="sig-name descname"><span class="pre">--functions</span></code><code class="sig-prename descclassname"> <span class="pre">[=<none|short|linkage>]</span></code><code class="sig-prename descclassname"><span class="pre">,</span> </code><code class="sig-name descname"><span class="pre">-f</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-symbolizer-functions" title="Permalink to this definition">¶</a></dt>
<dd><p>Specify the way function names are printed (omit function name, print short
function name, or print full linkage name, respectively). Defaults to
<code class="docutils literal notranslate"><span class="pre">linkage</span></code>.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-symbolizer-help">
<span id="cmdoption-llvm-symbolizer-h"></span><code class="sig-name descname"><span class="pre">--help</span></code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname"><span class="pre">,</span> </code><code class="sig-name descname"><span class="pre">-h</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-symbolizer-help" title="Permalink to this definition">¶</a></dt>
<dd><p>Show help and usage for this command.</p>
</dd></dl>
<span class="target" id="llvm-symbolizer-opt-i"></span><dl class="std option">
<dt id="cmdoption-llvm-symbolizer-inlining">
<span id="cmdoption-llvm-symbolizer-inlines"></span><span id="cmdoption-llvm-symbolizer-i"></span><code class="sig-name descname"><span class="pre">--inlining</span></code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname"><span class="pre">,</span> </code><code class="sig-name descname"><span class="pre">--inlines</span></code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname"><span class="pre">,</span> </code><code class="sig-name descname"><span class="pre">-i</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-symbolizer-inlining" title="Permalink to this definition">¶</a></dt>
<dd><p>If a source code location is in an inlined function, prints all the inlined
frames. This is the default.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-symbolizer-no-inlines">
<code class="sig-name descname"><span class="pre">--no-inlines</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-symbolizer-no-inlines" title="Permalink to this definition">¶</a></dt>
<dd><p>Don’t print inlined frames.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-symbolizer-no-demangle">
<code class="sig-name descname"><span class="pre">--no-demangle</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-symbolizer-no-demangle" title="Permalink to this definition">¶</a></dt>
<dd><p>Don’t print demangled function names.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-symbolizer-obj">
<span id="cmdoption-llvm-symbolizer-exe"></span><span id="cmdoption-llvm-symbolizer-e"></span><code class="sig-name descname"><span class="pre">--obj</span></code><code class="sig-prename descclassname"> <span class="pre"><path></span></code><code class="sig-prename descclassname"><span class="pre">,</span> </code><code class="sig-name descname"><span class="pre">--exe</span></code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname"><span class="pre">,</span> </code><code class="sig-name descname"><span class="pre">-e</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-symbolizer-obj" title="Permalink to this definition">¶</a></dt>
<dd><p>Path to object file to be symbolized. If <code class="docutils literal notranslate"><span class="pre">-</span></code> is specified, read the object
directly from the standard input stream.</p>
</dd></dl>
<span class="target" id="llvm-symbolizer-opt-output-style"></span><dl class="std option">
<dt id="cmdoption-llvm-symbolizer-output-style">
<code class="sig-name descname"><span class="pre">--output-style</span></code><code class="sig-prename descclassname"> <span class="pre"><LLVM|GNU|JSON></span></code><a class="headerlink" href="#cmdoption-llvm-symbolizer-output-style" title="Permalink to this definition">¶</a></dt>
<dd><p>Specify the preferred output style. Defaults to <code class="docutils literal notranslate"><span class="pre">LLVM</span></code>. When the output
style is set to <code class="docutils literal notranslate"><span class="pre">GNU</span></code>, the tool follows the style of GNU’s <strong>addr2line</strong>.
The differences from the <code class="docutils literal notranslate"><span class="pre">LLVM</span></code> style are:</p>
<ul class="simple">
<li><p>Does not print the column of a source code location.</p></li>
<li><p>Does not add an empty line after the report for an address.</p></li>
<li><p>Does not replace the name of an inlined function with the name of the
topmost caller when inlined frames are not shown.</p></li>
<li><p>Prints an address’s debug-data discriminator when it is non-zero. One way to
produce discriminators is to compile with clang’s -fdebug-info-for-profiling.</p></li>
</ul>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">JSON</span></code> style provides a machine readable output in JSON. If addresses are</dt><dd><p>supplied via stdin, the output JSON will be a series of individual objects.
Otherwise, all results will be contained in a single array.</p>
</dd>
</dl>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$</span> llvm-symbolizer --obj<span class="o">=</span>inlined.elf 0x4004be 0x400486 -p
<span class="go">baz() at /tmp/test.cpp:11:18</span>
<span class="go"> (inlined by) main at /tmp/test.cpp:15:0</span>
<span class="go">foo() at /tmp/test.cpp:6:3</span>
<span class="gp">$</span> llvm-symbolizer --output-style<span class="o">=</span>LLVM --obj<span class="o">=</span>inlined.elf 0x4004be 0x400486 -p --no-inlines
<span class="go">main at /tmp/test.cpp:11:18</span>
<span class="go">foo() at /tmp/test.cpp:6:3</span>
<span class="gp">$</span> llvm-symbolizer --output-style<span class="o">=</span>GNU --obj<span class="o">=</span>inlined.elf 0x4004be 0x400486 -p --no-inlines
<span class="go">baz() at /tmp/test.cpp:11</span>
<span class="go">foo() at /tmp/test.cpp:6</span>
<span class="gp">$</span> clang -g -fdebug-info-for-profiling test.cpp -o profiling.elf
<span class="gp">$</span> llvm-symbolizer --output-style<span class="o">=</span>GNU --obj<span class="o">=</span>profiling.elf 0x401167 -p --no-inlines
<span class="go">main at /tmp/test.cpp:15 (discriminator 2)</span>
<span class="gp">$</span> llvm-symbolizer --output-style<span class="o">=</span>JSON --obj<span class="o">=</span>inlined.elf 0x4004be 0x400486 -p
<span class="go">[</span>
<span class="go"> {</span>
<span class="go"> "Address": "0x4004be",</span>
<span class="go"> "ModuleName": "inlined.elf",</span>
<span class="go"> "Symbol": [</span>
<span class="go"> {</span>
<span class="go"> "Column": 18,</span>
<span class="go"> "Discriminator": 0,</span>
<span class="go"> "FileName": "/tmp/test.cpp",</span>
<span class="go"> "FunctionName": "baz()",</span>
<span class="go"> "Line": 11,</span>
<span class="go"> "Source": "",</span>
<span class="go"> "StartFileName": "/tmp/test.cpp",</span>
<span class="go"> "StartLine": 9</span>
<span class="go"> },</span>
<span class="go"> {</span>
<span class="go"> "Column": 0,</span>
<span class="go"> "Discriminator": 0,</span>
<span class="go"> "FileName": "/tmp/test.cpp",</span>
<span class="go"> "FunctionName": "main",</span>
<span class="go"> "Line": 15,</span>
<span class="go"> "Source": "",</span>
<span class="go"> "StartFileName": "/tmp/test.cpp",</span>
<span class="go"> "StartLine": 14</span>
<span class="go"> }</span>
<span class="go"> ]</span>
<span class="go"> },</span>
<span class="go"> {</span>
<span class="go"> "Address": "0x400486",</span>
<span class="go"> "ModuleName": "inlined.elf",</span>
<span class="go"> "Symbol": [</span>
<span class="go"> {</span>
<span class="go"> "Column": 3,</span>
<span class="go"> "Discriminator": 0,</span>
<span class="go"> "FileName": "/tmp/test.cpp",</span>
<span class="go"> "FunctionName": "foo()",</span>
<span class="go"> "Line": 6,</span>
<span class="go"> "Source": "",</span>
<span class="go"> "StartFileName": "/tmp/test.cpp",</span>
<span class="go"> "StartLine": 5</span>
<span class="go"> }</span>
<span class="go"> ]</span>
<span class="go"> }</span>
<span class="go">]</span>
</pre></div>
</div>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-symbolizer-pretty-print">
<span id="cmdoption-llvm-symbolizer-p"></span><code class="sig-name descname"><span class="pre">--pretty-print</span></code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname"><span class="pre">,</span> </code><code class="sig-name descname"><span class="pre">-p</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-symbolizer-pretty-print" title="Permalink to this definition">¶</a></dt>
<dd><p>Print human readable output. If <a class="reference internal" href="#cmdoption-llvm-symbolizer-inlining"><code class="xref std std-option docutils literal notranslate"><span class="pre">--inlining</span></code></a> is specified, the
enclosing scope is prefixed by (inlined by).
For JSON output, the option will cause JSON to be indented and split over
new lines. Otherwise, the JSON output will be printed in a compact form.</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$</span> llvm-symbolizer --obj<span class="o">=</span>inlined.elf 0x4004be --inlining --pretty-print
<span class="go">baz() at /tmp/test.cpp:11:18</span>
<span class="go"> (inlined by) main at /tmp/test.cpp:15:0</span>
</pre></div>
</div>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-symbolizer-print-address">
<span id="cmdoption-llvm-symbolizer-addresses"></span><span id="cmdoption-llvm-symbolizer-a"></span><code class="sig-name descname"><span class="pre">--print-address</span></code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname"><span class="pre">,</span> </code><code class="sig-name descname"><span class="pre">--addresses</span></code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname"><span class="pre">,</span> </code><code class="sig-name descname"><span class="pre">-a</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-symbolizer-print-address" title="Permalink to this definition">¶</a></dt>
<dd><p>Print address before the source code location. Defaults to false.</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$</span> llvm-symbolizer --obj<span class="o">=</span>inlined.elf --print-address 0x4004be
<span class="go">0x4004be</span>
<span class="go">baz()</span>
<span class="go">/tmp/test.cpp:11:18</span>
<span class="go">main</span>
<span class="go">/tmp/test.cpp:15:0</span>
<span class="gp">$</span> llvm-symbolizer --obj<span class="o">=</span>inlined.elf 0x4004be --pretty-print --print-address
<span class="go">0x4004be: baz() at /tmp/test.cpp:11:18</span>
<span class="go"> (inlined by) main at /tmp/test.cpp:15:0</span>
</pre></div>
</div>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-symbolizer-print-source-context-lines">
<code class="sig-name descname"><span class="pre">--print-source-context-lines</span></code><code class="sig-prename descclassname"> <span class="pre"><N></span></code><a class="headerlink" href="#cmdoption-llvm-symbolizer-print-source-context-lines" title="Permalink to this definition">¶</a></dt>
<dd><p>Print <code class="docutils literal notranslate"><span class="pre">N</span></code> lines of source context for each symbolized address.</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$</span> llvm-symbolizer --obj<span class="o">=</span>test.elf 0x400490 --print-source-context-lines<span class="o">=</span><span class="m">3</span>
<span class="go">baz()</span>
<span class="go">/tmp/test.cpp:11:0</span>
<span class="go">10 : volatile int k = 42;</span>
<span class="go">11 >: return foz() + k;</span>
<span class="go">12 : }</span>
</pre></div>
</div>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-symbolizer-relativenames">
<code class="sig-name descname"><span class="pre">--relativenames</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-symbolizer-relativenames" title="Permalink to this definition">¶</a></dt>
<dd><p>Print the file’s path relative to the compilation directory, instead
of the absolute path. If the command-line to the compiler included
the full path, this will be the same as the default.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-symbolizer-verbose">
<code class="sig-name descname"><span class="pre">--verbose</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-symbolizer-verbose" title="Permalink to this definition">¶</a></dt>
<dd><p>Print verbose address, line and column information.</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$</span> llvm-symbolizer --obj<span class="o">=</span>inlined.elf --verbose 0x4004be
<span class="go">baz()</span>
<span class="go"> Filename: /tmp/test.cpp</span>
<span class="go"> Function start filename: /tmp/test.cpp</span>
<span class="go"> Function start line: 9</span>
<span class="go"> Function start address: 0x4004b6</span>
<span class="go"> Line: 11</span>
<span class="go"> Column: 18</span>
<span class="go">main</span>
<span class="go"> Filename: /tmp/test.cpp</span>
<span class="go"> Function start filename: /tmp/test.cpp</span>
<span class="go"> Function start line: 14</span>
<span class="go"> Function start address: 0x4004b0</span>
<span class="go"> Line: 15</span>
<span class="go"> Column: 18</span>
</pre></div>
</div>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-symbolizer-version">
<span id="cmdoption-llvm-symbolizer-v"></span><code class="sig-name descname"><span class="pre">--version</span></code><code class="sig-prename descclassname"></code><code class="sig-prename descclassname"><span class="pre">,</span> </code><code class="sig-name descname"><span class="pre">-v</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-symbolizer-version" title="Permalink to this definition">¶</a></dt>
<dd><p>Print version information for the tool.</p>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-symbolizer-arg-FILE">
<span id="cmdoption-llvm-symbolizer-arg-file"></span><code class="sig-name descname"><span class="pre">@<FILE></span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-symbolizer-arg-FILE" title="Permalink to this definition">¶</a></dt>
<dd><p>Read command-line options from response file <cite><FILE></cite>.</p>
</dd></dl>
</div>
<div class="section" id="windows-pdb-specific-options">
<h2>WINDOWS/PDB SPECIFIC OPTIONS<a class="headerlink" href="#windows-pdb-specific-options" title="Permalink to this headline">¶</a></h2>
<dl class="std option">
<dt id="cmdoption-llvm-symbolizer-dia">
<code class="sig-name descname"><span class="pre">--dia</span></code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-llvm-symbolizer-dia" title="Permalink to this definition">¶</a></dt>
<dd><p>Use the Windows DIA SDK for symbolization. If the DIA SDK is not found,
llvm-symbolizer will fall back to the native implementation.</p>
</dd></dl>
</div>
<div class="section" id="mach-o-specific-options">
<h2>MACH-O SPECIFIC OPTIONS<a class="headerlink" href="#mach-o-specific-options" title="Permalink to this headline">¶</a></h2>
<dl class="std option">
<dt id="cmdoption-llvm-symbolizer-default-arch">
<code class="sig-name descname"><span class="pre">--default-arch</span></code><code class="sig-prename descclassname"> <span class="pre"><arch></span></code><a class="headerlink" href="#cmdoption-llvm-symbolizer-default-arch" title="Permalink to this definition">¶</a></dt>
<dd><p>If a binary contains object files for multiple architectures (e.g. it is a
Mach-O universal binary), symbolize the object file for a given architecture.
You can also specify the architecture by writing <code class="docutils literal notranslate"><span class="pre">binary_name:arch_name</span></code> in
the input (see example below). If the architecture is not specified in either
way, the address will not be symbolized. Defaults to empty string.</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$</span> cat addr.txt
<span class="go">/tmp/mach_universal_binary:i386 0x1f84</span>
<span class="go">/tmp/mach_universal_binary:x86_64 0x100000f24</span>
<span class="gp">$</span> llvm-symbolizer < addr.txt
<span class="go">_main</span>
<span class="go">/tmp/source_i386.cc:8</span>
<span class="go">_main</span>
<span class="go">/tmp/source_x86_64.cc:8</span>
</pre></div>
</div>
</dd></dl>
<dl class="std option">
<dt id="cmdoption-llvm-symbolizer-dsym-hint">
<code class="sig-name descname"><span class="pre">--dsym-hint</span></code><code class="sig-prename descclassname"> <span class="pre"><path/to/file.dSYM></span></code><a class="headerlink" href="#cmdoption-llvm-symbolizer-dsym-hint" title="Permalink to this definition">¶</a></dt>
<dd><p>If the debug info for a binary isn’t present in the default location, look for
the debug info at the .dSYM path provided via this option. This flag can be
used multiple times.</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-symbolizer</strong> returns 0. Other exit codes imply an internal program
error.</p>
</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-addr2line.html">llvm-addr2line(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="opt.html" title="opt - LLVM optimizer"
>next</a> |</li>
<li class="right" >
<a href="llvm-stress.html" title="llvm-stress - generate random .ll files"
>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-symbolizer - convert addresses into source code locations</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>
|
