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

   1 .\" $FreeBSD$
   2 .\" Man page generated from reStructuredText.
   3 .
   4 .TH "LLVM-DWARFDUMP" "1" "2018-08-02" "7" "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 .SH OPTIONS
  44 .INDENT 0.0
  45 .TP
  46 .B \-a, \-\-all
  47 Disassemble all supported DWARF sections.
  48 .UNINDENT
  49 .INDENT 0.0
  50 .TP
  51 .B \-\-arch=<arch>
  52 Dump DWARF debug information for the specified CPU architecture.
  53 Architectures may be specified by name or by number.  This
  54 option can be specified multiple times, once for each desired
  55 architecture.  All CPU architectures will be printed by
  56 default.
  57 .UNINDENT
  58 .INDENT 0.0
  59 .TP
  60 .B \-c, \-\-show\-children
  61 Show a debug info entry\(aqs children when using
  62 the \fI\%\-\-debug\-info\fP, \fI\%\-\-find\fP,
  63 and \fI\%\-\-name\fP options.
  64 .UNINDENT
  65 .INDENT 0.0
  66 .TP
  67 .B \-f <name>, \-\-find=<name>
  68 Search for the exact text <name> in the accelerator tables
  69 and print the matching debug information entries.
  70 When there is no accelerator tables or the name of the DIE
  71 you are looking for is not found in the accelerator tables,
  72 try using the slower but more complete \fI\%\-\-name\fP option.
  73 .UNINDENT
  74 .INDENT 0.0
  75 .TP
  76 .B \-F, \-\-show\-form
  77 Show DWARF form types after the DWARF attribute types.
  78 .UNINDENT
  79 .INDENT 0.0
  80 .TP
  81 .B \-h, \-\-help
  82 Show help and usage for this command.
  83 .UNINDENT
  84 .INDENT 0.0
  85 .TP
  86 .B \-i, \-\-ignore\-case
  87 Ignore case distinctions in when searching entries by name
  88 or by regular expression.
  89 .UNINDENT
  90 .INDENT 0.0
  91 .TP
  92 .B \-n <pattern>, \-\-name=<pattern>
  93 Find and print all debug info entries whose name
  94 (\fIDW_AT_name\fP attribute) matches the exact text in
  95 <pattern>. Use the \fI\%\-\-regex\fP option to have
  96 <pattern> become a regular expression for more flexible
  97 pattern matching.
  98 .UNINDENT
  99 .INDENT 0.0
 100 .TP
 101 .B \-\-lookup=<address>
 102 Lookup <address> in the debug information and print out the file,
 103 function, block, and line table details.
 104 .UNINDENT
 105 .INDENT 0.0
 106 .TP
 107 .B \-o <path>, \-\-out\-file=<path>
 108 Redirect output to a file specified by <path>.
 109 .UNINDENT
 110 .INDENT 0.0
 111 .TP
 112 .B \-p, \-\-show\-parents
 113 Show a debug info entry\(aqs parent objects when using the
 114 \fI\%\-\-debug\-info\fP, \fI\%\-\-find\fP, and
 115 \fI\%\-\-name\fP options.
 116 .UNINDENT
 117 .INDENT 0.0
 118 .TP
 119 .B \-r <n>, \-\-recurse\-depth=<n>
 120 Only recurse to a maximum depth of <n> when dumping debug info
 121 entries.
 122 .UNINDENT
 123 .INDENT 0.0
 124 .TP
 125 .B \-\-statistics
 126 Collect debug info quality metrics and print the results
 127 as machine\-readable single\-line JSON output.
 128 .UNINDENT
 129 .INDENT 0.0
 130 .TP
 131 .B \-x, \-\-regex
 132 Treat any <pattern> strings as regular expressions when searching
 133 instead of just as an exact string match.
 134 .UNINDENT
 135 .INDENT 0.0
 136 .TP
 137 .B \-u, \-\-uuid
 138 Show the UUID for each architecture.
 139 .UNINDENT
 140 .INDENT 0.0
 141 .TP
 142 .B \-\-diff
 143 Dump the output in a format that is more friendly for comparing
 144 DWARF output from two different files.
 145 .UNINDENT
 146 .INDENT 0.0
 147 .TP
 148 .B \-v, \-\-verbose
 149 Display verbose information when dumping. This can help to debug
 150 DWARF issues.
 151 .UNINDENT
 152 .INDENT 0.0
 153 .TP
 154 .B \-\-verify
 155 Verify the structure of the DWARF information by verifying the
 156 compile unit chains, DIE relationships graph, address
 157 ranges, and more.
 158 .UNINDENT
 159 .INDENT 0.0
 160 .TP
 161 .B \-\-version
 162 Display the version of the tool.
 163 .UNINDENT
 164 .INDENT 0.0
 165 .TP
 166 .B \-\-debug\-abbrev, \-\-debug\-aranges, \-\-debug\-cu\-index, \-\-debug\-frame [=<offset>], \-\-debug\-gnu\-pubnames, \-\-debug\-gnu\-pubtypes, \-\-debug\-info [=<offset>], \-\-debug\-line [=<offset>], \-\-debug\-loc [=<offset>], \-\-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
 167 Dump the specified DWARF section by name. Only the
 168 \fI\&.debug_info\fP section is shown by default. Some entries
 169 support adding an \fI=<offset>\fP as a way to provide an
 170 optional offset of the exact entry to dump within the
 171 respective section. When an offset is provided, only the
 172 entry at that offset will be dumped, else the entire
 173 section will be dumped. Children of items at a specific
 174 offset can be dumped by also using the
 175 \fI\%\-\-show\-children\fP option where applicable.
 176 .UNINDENT
 177 .SH EXIT STATUS
 178 .sp
 179 \fBllvm\-dwarfdump\fP returns 0 if the input files were parsed and dumped
 180 successfully. Otherwise, it returns 1.
 181 .SH SEE ALSO
 182 .sp
 183 \fBdsymutil(1)\fP
 184 .SH AUTHOR
 185 Maintained by The LLVM Team (http://llvm.org/).
 186 .SH COPYRIGHT
 187 2003-2018, LLVM Project
 188 .\" Generated by docutils manpage writer.
 189 .