blob: b794f56246ff01098710f7d04015511a8ac382d6 [file] [log] [blame]
llvm-symbolizer - convert addresses into source code locations
:program:`llvm-symbolizer` [options]
:program:`llvm-symbolizer` reads object file names and addresses from standard
input and prints corresponding source code locations to standard output.
If object file is specified in command line, :program:`llvm-symbolizer`
processes only addresses from standard input, the rest is output verbatim.
This program uses debug info sections and symbol table in the object files.
.. code-block:: console
$ cat addr.txt
a.out 0x4004f4
/tmp/b.out 0x400528
/tmp/ 0x710
/tmp/mach_universal_binary:i386 0x1f84
/tmp/mach_universal_binary:x86_64 0x100000f24
$ llvm-symbolizer < addr.txt
f(int, int)
$ cat addr2.txt
$ llvm-symbolizer -obj=a.out < addr2.txt
$cat addr.txt
$llvm-symbolizer -inlining -print-address -pretty-print -obj=addr.exe < addr.txt
0x40054d: inc at /tmp/x.c:3:3
(inlined by) main at /tmp/x.c:9:0
$llvm-symbolizer -inlining -pretty-print -obj=addr.exe < addr.txt
inc at /tmp/x.c:3:3
(inlined by) main at /tmp/x.c:9:0
.. option:: -obj, -exe, -e
Path to object file to be symbolized.
.. option:: -functions[=<none|short|linkage>], -f
Specify the way function names are printed (omit function name,
print short function name, or print full linkage name, respectively).
Defaults to ``linkage``.
.. option:: -use-symbol-table
Prefer function names stored in symbol table to function names
in debug info sections. Defaults to true.
.. option:: -demangle, -C
Print demangled function names. Defaults to true.
.. option:: -no-demangle
Don't print demangled function names.
.. option:: -inlining, -inlines, -i
If a source code location is in an inlined function, prints all the
inlnied frames. Defaults to true.
.. option:: -default-arch
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 architecture by writing ``binary_name:arch_name`` in the
input (see example above). If architecture is not specified in either way,
address will not be symbolized. Defaults to empty string.
.. option:: -dsym-hint=<path/to/file.dSYM>
(Darwin-only flag). 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 the
``-dsym-hint`` flag. This flag can be used multiple times.
.. option:: -print-address, -addresses, -a
Print address before the source code location. Defaults to false.
.. option:: -pretty-print, -p
Print human readable output. If ``-inlining`` is specified, enclosing scope is
prefixed by (inlined by). Refer to listed examples.
.. option:: -basenames, -s
Strip directories when printing the file path.
.. option:: -adjust-vma=<offset>
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.
:program:`llvm-symbolizer` returns 0. Other exit codes imply internal program error.