llvm.org GIT mirror llvm / f4e8e03
Add a manpage for llvm-dwarfdump. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@314863 91177308-0d34-0410-b5e6-96231b3b80d8 Adrian Prantl 1 year, 11 months ago
2 changed file(s) with 119 addition(s) and 11 deletion(s). Raw diff Collapse all Expand all
111111
112112 if (${SPHINX_OUTPUT_MAN})
113113 add_sphinx_target(man llvm)
114 add_sphinx_target(man llvm-dwarfdump)
114115 endif()
115116
116117 endif()
None llvm-dwarfdump - print contents of DWARF sections
1 =================================================
0 llvm-dwarfdump - dump and verify DWARF debug information
1 ========================================================
22
33 SYNOPSIS
44 --------
55
6 :program:`llvm-dwarfdump` [*options*] [*filenames...*]
6 :program:`llvm-dwarfdump` [*options*] [*filename ...*]
77
88 DESCRIPTION
99 -----------
1010
11 :program:`llvm-dwarfdump` parses DWARF sections in the object files
12 and prints their contents in human-readable form.
11 :program:`llvm-dwarfdump` parses DWARF sections in object files,
12 archives, and `.dSYM` bundles and prints their contents in
13 human-readable form. Only the .debug_info section is printed unless one of
14 the section-specific options or :option:`--all` is specified.
1315
1416 OPTIONS
1517 -------
1618
17 .. option:: -debug-dump=section
19 .. option:: -a, --all
1820
19 Specify the DWARF section to dump.
20 For example, use ``abbrev`` to dump the contents of ``.debug_abbrev`` section,
21 ``loc.dwo`` to dump the contents of ``.debug_loc.dwo`` etc.
22 See ``llvm-dwarfdump --help`` for the complete list of supported sections.
23 Use ``all`` to dump all DWARF sections. It is the default.
21 Disassemble all supported DWARF sections.
22
23 .. option:: --arch=
24
25 Dump DWARF debug information for the specified CPU architecture.
26 Architectures may be specified by name or by number. This
27 option can be specified multiple times, once for each desired
28 architecture. All CPU architectures will be printed by
29 default.
30
31 .. option:: -c, --show-children
32
33 Show a debug info entry's children when using
34 the :option:`--debug-info`, :option:`--find`,
35 and :option:`--name` options.
36
37 .. option:: -f , --find=
38
39 Search for the exact text in the accelerator tables
40 and print the matching debug information entries.
41 When there is no accelerator tables or the name of the DIE
42 you are looking for is not found in the accelerator tables,
43 try using the slower but more complete :option:`--name` option.
44
45 .. option:: -F, --show-form
46
47 Show DWARF form types after the DWARF attribute types.
48
49 .. option:: -h, --help
50
51 Show help and usage for this command.
52
53 .. option:: -i, --ignore-case
54
55 Ignore case distinctions in when searching entries by name
56 or by regular expression.
57
58 .. option:: -n , --name=
59
60 Find and print all debug info entries whose name
61 (`DW_AT_name` attribute) matches the exact text in
62 . Use the :option:`--regex` option to have
63 become a regular expression for more flexible
64 pattern matching.
65
66 .. option:: --lookup=
67
68 Lookup
in the debug information and print out the file,
69 function, block, and line table details.
70
71 .. option:: -o , --out-file=
72
73 Redirect output to a file specified by .
74
75 .. option:: -p, --show-parents
76
77 Show a debug info entry's parent objects when using the
78 :option:`--debug-info`, :option:`--find`, and
79 :option:`--name` options.
80
81 .. option:: -r , --recurse-depth=
82
83 Only recurse to a maximum depth of when dumping debug info
84 entries.
85
86 .. option:: -x, --regex
87
88 Treat any strings as regular expressions when searching
89 instead of just as an exact string match.
90
91 .. option:: -u, --uuid
92
93 Show the UUID for each architecture.
94
95 .. option:: --diff
96
97 Dump the output in a format that is more friendly for comparing
98 DWARF output from two different files.
99
100 .. option:: -v, --verbose
101
102 Display verbose information when dumping. This can help to debug
103 DWARF issues.
104
105 .. option:: --verify
106
107 Verify the structure of the DWARF information by verifying the
108 compile unit chains, DIE relationships graph, address
109 ranges, and more.
110
111 .. option:: --version
112
113 Display the version of the tool.
114
115 .. option:: --debug-abbrev, --debug-aranges, --debug-cu-index, --debug-frame [=], --debug-gnu-pubnames, --debug-gnu-pubtypes, --debug-info [=], --debug-line [=], --debug-loc [=], --debug-macro, --debug-pubnames, --debug-pubtypes, --debug-ranges, --debug-str, --debug-str-offsets, --debug-tu-index, --debug-types, --eh-frame, --gdb-index, --apple-names, --apple-types, --apple-namespaces, --apple-objc
116
117 Dump the specified DWARF section by name. Only the
118 `.debug_info` section is shown by default. Some entries
119 support adding an `=` as a way to provide an
120 optional offset of the exact entry to dump within the
121 respective section. When an offset is provided, only the
122 entry at that offset will be dumped, else the entire
123 section will be dumped. Children of items at a specific
124 offset can be dumped by also using the
125 :option:`--show-children` option where applicable.
24126
25127 EXIT STATUS
26128 -----------
27129
28130 :program:`llvm-dwarfdump` returns 0 if the input files were parsed and dumped
29131 successfully. Otherwise, it returns 1.
132
133 SEE ALSO
134 --------
135
136 :manpage:`dsymutil(1)`