usr.bin/clang/llvm-dwarfdump/llvm-dwarfdump.1

   1 .\" $FreeBSD$
   2 .\" Man page generated from reStructuredText.
   3 .
   4 .TH "LLVM-DWARFDUMP" "1" "2020-06-26" "10" "LLVM"
   5 .SH NAME
   6 llvm-dwarfdump \- dump and verify DWARF debug information
   7 .
   8 .nr rst2man-indent-level 0
   9 .
  10 .de1 rstReportMargin
  11 \\$1 \\n[an-margin]
  12 level \\n[rst2man-indent-level]
  13 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  14 -
  15 \\n[rst2man-indent0]
  16 \\n[rst2man-indent1]
  17 \\n[rst2man-indent2]
  18 ..
  19 .de1 INDENT
  20 .\" .rstReportMargin pre:
  21 . RS \\$1
  22 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  23 . nr rst2man-indent-level +1
  24 .\" .rstReportMargin post:
  25 ..
  26 .de UNINDENT
  27 . RE
  28 .\" indent \\n[an-margin]
  29 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  30 .nr rst2man-indent-level -1
  31 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  32 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  33 ..
  34 .SH SYNOPSIS
  35 .sp
  36 \fBllvm\-dwarfdump\fP [\fIoptions\fP] [\fIfilename ...\fP]
  37 .SH DESCRIPTION
  38 .sp
  39 \fBllvm\-dwarfdump\fP parses DWARF sections in object files,
  40 archives, and \fI\&.dSYM\fP bundles and prints their contents in
  41 human\-readable form. Only the .debug_info section is printed unless one of
  42 the section\-specific options or \fI\%\-\-all\fP is specified.
  43 .sp
  44 If no input file is specified, \fIa.out\fP is used instead. If \fI\-\fP is used as the
  45 input file, \fBllvm\-dwarfdump\fP reads the input from its standard input
  46 stream.
  47 .SH OPTIONS
  48 .INDENT 0.0
  49 .TP
  50 .B \-a, \-\-all
  51 Dump all supported DWARF sections.
  52 .UNINDENT
  53 .INDENT 0.0
  54 .TP
  55 .B \-\-arch=<arch>
  56 Dump DWARF debug information for the specified CPU architecture.
  57 Architectures may be specified by name or by number.  This
  58 option can be specified multiple times, once for each desired
  59 architecture.  All CPU architectures will be printed by
  60 default.
  61 .UNINDENT
  62 .INDENT 0.0
  63 .TP
  64 .B \-c, \-\-show\-children
  65 Show a debug info entry\(aqs children when selectively printing with
  66 the \fI=<offset>\fP argument of \fI\%\-\-debug\-info\fP, or options such
  67 as \fI\%\-\-find\fP or \fI\%\-\-name\fP\&.
  68 .UNINDENT
  69 .INDENT 0.0
  70 .TP
  71 .B \-\-color
  72 Use colors in output.
  73 .UNINDENT
  74 .INDENT 0.0
  75 .TP
  76 .B \-f <name>, \-\-find=<name>
  77 Search for the exact text <name> in the accelerator tables
  78 and print the matching debug information entries.
  79 When there is no accelerator tables or the name of the DIE
  80 you are looking for is not found in the accelerator tables,
  81 try using the slower but more complete \fI\%\-\-name\fP option.
  82 .UNINDENT
  83 .INDENT 0.0
  84 .TP
  85 .B \-F, \-\-show\-form
  86 Show DWARF form types after the DWARF attribute types.
  87 .UNINDENT
  88 .INDENT 0.0
  89 .TP
  90 .B \-h, \-\-help
  91 Show help and usage for this command.
  92 .UNINDENT
  93 .INDENT 0.0
  94 .TP
  95 .B \-\-help\-list
  96 Show help and usage for this command without grouping the options
  97 into categories.
  98 .UNINDENT
  99 .INDENT 0.0
 100 .TP
 101 .B \-i, \-\-ignore\-case
 102 Ignore case distinctions when using \fI\%\-\-name\fP\&.
 103 .UNINDENT
 104 .INDENT 0.0
 105 .TP
 106 .B \-n <name>, \-\-name=<name>
 107 Find and print all debug info entries whose name
 108 (\fIDW_AT_name\fP attribute) is <name>.
 109 .UNINDENT
 110 .INDENT 0.0
 111 .TP
 112 .B \-\-lookup=<address>
 113 Look up <address> in the debug information and print out the file,
 114 function, block, and line table details.
 115 .UNINDENT
 116 .INDENT 0.0
 117 .TP
 118 .B \-o <path>
 119 Redirect output to a file specified by <path>, where \fI\-\fP is the
 120 standard output stream.
 121 .UNINDENT
 122 .INDENT 0.0
 123 .TP
 124 .B \-p, \-\-show\-parents
 125 Show a debug info entry\(aqs parents when selectively printing with
 126 the \fI=<offset>\fP argument of \fI\%\-\-debug\-info\fP, or options such
 127 as \fI\%\-\-find\fP or \fI\%\-\-name\fP\&.
 128 .UNINDENT
 129 .INDENT 0.0
 130 .TP
 131 .B \-\-parent\-recurse\-depth=<N>
 132 When displaying debug info entry parents, only show them to a
 133 maximum depth of <N>.
 134 .UNINDENT
 135 .INDENT 0.0
 136 .TP
 137 .B \-\-quiet
 138 Use with \fI\%\-\-verify\fP to not emit to \fISTDOUT\fP\&.
 139 .UNINDENT
 140 .INDENT 0.0
 141 .TP
 142 .B \-r <N>, \-\-recurse\-depth=<N>
 143 When displaying debug info entries, only show children to a maximum
 144 depth of <N>.
 145 .UNINDENT
 146 .INDENT 0.0
 147 .TP
 148 .B \-\-statistics
 149 Collect debug info quality metrics and print the results
 150 as machine\-readable single\-line JSON output.
 151 .UNINDENT
 152 .INDENT 0.0
 153 .TP
 154 .B \-\-summarize\-types
 155 Abbreviate the description of type unit entries.
 156 .UNINDENT
 157 .INDENT 0.0
 158 .TP
 159 .B \-x, \-\-regex
 160 Treat any <name> strings as regular expressions when searching
 161 with \fI\%\-\-name\fP\&. If \fI\%\-\-ignore\-case\fP is also specified,
 162 the regular expression becomes case\-insensitive.
 163 .UNINDENT
 164 .INDENT 0.0
 165 .TP
 166 .B \-u, \-\-uuid
 167 Show the UUID for each architecture.
 168 .UNINDENT
 169 .INDENT 0.0
 170 .TP
 171 .B \-\-diff
 172 Dump the output in a format that is more friendly for comparing
 173 DWARF output from two different files.
 174 .UNINDENT
 175 .INDENT 0.0
 176 .TP
 177 .B \-v, \-\-verbose
 178 Display verbose information when dumping. This can help to debug
 179 DWARF issues.
 180 .UNINDENT
 181 .INDENT 0.0
 182 .TP
 183 .B \-\-verify
 184 Verify the structure of the DWARF information by verifying the
 185 compile unit chains, DIE relationships graph, address
 186 ranges, and more.
 187 .UNINDENT
 188 .INDENT 0.0
 189 .TP
 190 .B \-\-version
 191 Display the version of the tool.
 192 .UNINDENT
 193 .INDENT 0.0
 194 .TP
 195 .B \-\-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, \-\-eh\-frame [=<offset>], \-\-gdb\-index, \-\-apple\-names, \-\-apple\-types, \-\-apple\-namespaces, \-\-apple\-objc
 196 Dump the specified DWARF section by name. Only the
 197 \fI\&.debug_info\fP section is shown by default. Some entries
 198 support adding an \fI=<offset>\fP as a way to provide an
 199 optional offset of the exact entry to dump within the
 200 respective section. When an offset is provided, only the
 201 entry at that offset will be dumped, else the entire
 202 section will be dumped.
 203 .UNINDENT
 204 .INDENT 0.0
 205 .TP
 206 .B @<FILE>
 207 Read command\-line options from \fI<FILE>\fP\&.
 208 .UNINDENT
 209 .SH EXIT STATUS
 210 .sp
 211 \fBllvm\-dwarfdump\fP returns 0 if the input files were parsed and dumped
 212 successfully. Otherwise, it returns 1.
 213 .SH SEE ALSO
 214 .sp
 215 \fBdsymutil(1)\fP
 216 .SH AUTHOR
 217 Maintained by the LLVM Team (https://llvm.org/).
 218 .SH COPYRIGHT
 219 2003-2020, LLVM Project
 220 .\" Generated by docutils manpage writer.
 221 .