xref: /freebsd/usr.bin/clang/llvm-dwarfdump/llvm-dwarfdump.1 (revision 29332c0dcee1e80c9fb871e06c3160bd5deb1b44)
$FreeBSD$
Man page generated from reStructuredText.
. . .nr rst2man-indent-level 0 . \\$1 \\n[an-margin] level \\n[rst2man-indent-level] level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] - \\n[rst2man-indent0] \\n[rst2man-indent1] \\n[rst2man-indent2] .. .rstReportMargin pre:
. RS \\$1 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] . nr rst2man-indent-level +1 .rstReportMargin post:
.. . RE indent \\n[an-margin]
old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1 new: \\n[rst2man-indent\\n[rst2man-indent-level]]
..
"LLVM-DWARFDUMP" "1" "2021-06-07" "12" "LLVM"
NAME
llvm-dwarfdump - dump and verify DWARF debug information
SYNOPSIS
llvm-dwarfdump [options] [filename ...]
DESCRIPTION
llvm-dwarfdump parses DWARF sections in object files, archives, and .dSYM bundles and prints their contents in human-readable form. Only the .debug_info section is printed unless one of the section-specific options or \%--all is specified. If no input file is specified, a.out is used instead. If - is used as the input file, llvm-dwarfdump reads the input from its standard input stream.
OPTIONS
NDENT 0.0

-a, --all Dump all supported DWARF sections. NINDENT NDENT 0.0

--arch=<arch> Dump DWARF debug information for the specified CPU architecture. Architectures may be specified by name or by number. This option can be specified multiple times, once for each desired architecture. All CPU architectures will be printed by default. NINDENT NDENT 0.0

-c, --show-children Show a debug info entry\(aqs children when selectively printing with the =<offset> argument of \%--debug-info, or options such as \%--find or \%--name. NINDENT NDENT 0.0

--color Use colors in output. NINDENT NDENT 0.0

-f <name>, --find=<name> Search for the exact text <name> in the accelerator tables and print the matching debug information entries. When there is no accelerator tables or the name of the DIE you are looking for is not found in the accelerator tables, try using the slower but more complete \%--name option. NINDENT NDENT 0.0

-F, --show-form Show DWARF form types after the DWARF attribute types. NINDENT NDENT 0.0

-h, --help Show help and usage for this command. NINDENT NDENT 0.0

--help-list Show help and usage for this command without grouping the options into categories. NINDENT NDENT 0.0

-i, --ignore-case Ignore case distinctions when using \%--name. NINDENT NDENT 0.0

-n <name>, --name=<name> Find and print all debug info entries whose name (DW_AT_name attribute) is <name>. NINDENT NDENT 0.0

--lookup=<address> Look up <address> in the debug information and print out the file, function, block, and line table details. NINDENT NDENT 0.0

-o <path> Redirect output to a file specified by <path>, where - is the standard output stream. NINDENT NDENT 0.0

-p, --show-parents Show a debug info entry\(aqs parents when selectively printing with the =<offset> argument of \%--debug-info, or options such as \%--find or \%--name. NINDENT NDENT 0.0

--parent-recurse-depth=<N> When displaying debug info entry parents, only show them to a maximum depth of <N>. NINDENT NDENT 0.0

--quiet Use with \%--verify to not emit to STDOUT. NINDENT NDENT 0.0

-r <N>, --recurse-depth=<N> When displaying debug info entries, only show children to a maximum depth of <N>. NINDENT NDENT 0.0

--show-section-sizes Show the sizes of all debug sections, expressed in bytes. NINDENT NDENT 0.0

--statistics Collect debug info quality metrics and print the results as machine-readable single-line JSON output. The output format is described in the section below (\%FORMAT OF STATISTICS OUTPUT). NINDENT NDENT 0.0

--summarize-types Abbreviate the description of type unit entries. NINDENT NDENT 0.0

-x, --regex Treat any <name> strings as regular expressions when searching with \%--name. If \%--ignore-case is also specified, the regular expression becomes case-insensitive. NINDENT NDENT 0.0

-u, --uuid Show the UUID for each architecture. NINDENT NDENT 0.0

--diff Dump the output in a format that is more friendly for comparing DWARF output from two different files. NINDENT NDENT 0.0

-v, --verbose Display verbose information when dumping. This can help to debug DWARF issues. NINDENT NDENT 0.0

--verify Verify the structure of the DWARF information by verifying the compile unit chains, DIE relationships graph, address ranges, and more. NINDENT NDENT 0.0

--version Display the version of the tool. NINDENT NDENT 0.0

--debug-abbrev, --debug-addr, --debug-aranges, --debug-cu-index, --debug-frame[=<offset>], --debug-gnu-pubnames, --debug-gnu-pubtypes, --debug-info [=<offset>], --debug-line [=<offset>], --debug-line-str, --debug-loc [=<offset>], --debug-loclists [=<offset>], --debug-macro, --debug-names, --debug-pubnames, --debug-pubtypes, --debug-ranges, --debug-rnglists, --debug-str, --debug-str-offsets, --debug-tu-index, --debug-types [=<offset>], --eh-frame [=<offset>], --gdb-index, --apple-names, --apple-types, --apple-namespaces, --apple-objc Dump the specified DWARF section by name. Only the .debug_info section is shown by default. Some entries support adding an =<offset> as a way to provide an optional offset of the exact entry to dump within the respective section. When an offset is provided, only the entry at that offset will be dumped, else the entire section will be dumped. NINDENT NDENT 0.0

@<FILE> Read command-line options from <FILE>. NINDENT

FORMAT OF STATISTICS OUTPUT
The :\%--statistics option generates single-line JSON output representing quality metrics of the processed debug info. These metrics are useful to compare changes between two compilers, particularly for judging the effect that a change to the compiler has on the debug info quality. The output is formatted as key-value pairs. The first pair contains a version number. The following naming scheme is used for the keys: NDENT 0.0 NDENT 3.5 NDENT 0.0
\(bu 2
variables ==> local variables and parameters
\(bu 2
local vars ==> local variables
\(bu 2
params ==> formal parameters NINDENT NINDENT NINDENT For aggregated values, the following keys are used: NDENT 0.0 NDENT 3.5 NDENT 0.0
\(bu 2
sum_of_all_variables(...) ==> the sum applied to all variables
\(bu 2
#bytes ==> the number of bytes
\(bu 2
#variables - entry values ... ==> the number of variables excluding the entry values etc. NINDENT NINDENT NINDENT
EXIT STATUS
llvm-dwarfdump returns 0 if the input files were parsed and dumped successfully. Otherwise, it returns 1.
SEE ALSO
dsymutil(1)
AUTHOR
Maintained by the LLVM Team (https://llvm.org/).
COPYRIGHT
2003-2021, LLVM Project Generated by docutils manpage writer.
.