docs/CommandGuide/llvm-objdump.rst

   1 llvm-objdump - LLVM's object file dumper
   2 ========================================
   3
   4 .. program:: llvm-objdump
   5
   6 SYNOPSIS
   7 --------
   8
   9 :program:`llvm-objdump` [*commands*] [*options*] [*filenames...*]
  10
  11 DESCRIPTION
  12 -----------
  13 The :program:`llvm-objdump` utility prints the contents of object files and
  14 final linked images named on the command line. If no file name is specified,
  15 :program:`llvm-objdump` will attempt to read from *a.out*. If *-* is used as a
  16 file name, :program:`llvm-objdump` will process a file on its standard input
  17 stream.
  18
  19 COMMANDS
  20 --------
  21 At least one of the following commands are required, and some commands can be
  22 combined with other commands:
  23
  24 .. option:: -a, --archive-headers
  25
  26   Display the information contained within an archive's headers.
  27
  28 .. option:: -d, --disassemble
  29
  30   Disassemble all text sections found in the input files.
  31
  32 .. option:: -D, --disassemble-all
  33
  34   Disassemble all sections found in the input files.
  35
  36 .. option:: --disassemble-functions=<symbol1[,symbol2,...]>
  37
  38   Disassemble only the specified symbols. Takes demangled symbol names when
  39   :option:`--demangle` is specified, otherwise takes mangled symbol names.
  40   Implies :option:`--disassemble`.
  41
  42 .. option:: --dwarf=<value>
  43
  44   Dump the specified DWARF debug sections. The supported values are:
  45
  46   `frames` - .debug_frame
  47
  48 .. option:: -f, --file-headers
  49
  50   Display the contents of the overall file header.
  51
  52 .. option:: --fault-map-section
  53
  54   Display the content of the fault map section.
  55
  56 .. option:: -h, --headers, --section-headers
  57
  58   Display summaries of the headers for each section.
  59
  60 .. option:: --help
  61
  62   Display usage information and exit. Does not stack with other commands.
  63
  64 .. option:: -p, --private-headers
  65
  66   Display format-specific file headers.
  67
  68 .. option:: -r, --reloc
  69
  70   Display the relocation entries in the file.
  71
  72 .. option:: -R, --dynamic-reloc
  73
  74   Display the dynamic relocation entries in the file.
  75
  76 .. option:: --raw-clang-ast
  77
  78   Dump the raw binary contents of the clang AST section.
  79
  80 .. option:: -s, --full-contents
  81
  82   Display the contents of each section.
  83
  84 .. option:: -t, --syms
  85
  86   Display the symbol table.
  87
  88 .. option:: -u, --unwind-info
  89
  90   Display the unwind info of the input(s).
  91
  92 .. option:: --version
  93
  94   Display the version of this program. Does not stack with other commands.
  95
  96 .. option:: -x, --all-headers
  97
  98   Display all available header information. Equivalent to specifying
  99   :option:`--archive-headers`, :option:`--file-headers`,
 100   :option:`--private-headers`, :option:`--reloc`, :option:`--section-headers`,
 101   and :option:`--syms`.
 102
 103 OPTIONS
 104 -------
 105 :program:`llvm-objdump` supports the following options:
 106
 107 .. option:: --adjust-vma=<offset>
 108
 109   Increase the displayed address in disassembly or section header printing by
 110   the specified offset.
 111
 112 .. option:: --arch-name=<string>
 113
 114   Specify the target architecture when disassembling. Use :option:`--version`
 115   for a list of available targets.
 116
 117 .. option:: -C, --demangle
 118
 119   Demangle symbol names in the output.
 120
 121 .. option:: -j, --section=<section1[,section2,...]>
 122
 123   Perform commands on the specified sections only. For Mach-O use
 124   `segment,section` to specify the section name.
 125
 126 .. option:: -l, --line-numbers
 127
 128   When disassembling, display source line numbers. Implies
 129   :option:`--disassemble`.
 130
 131 .. option:: -M, --disassembler-options=<opt1[,opt2,...]>
 132
 133   Pass target-specific disassembler options. Currently supported for ARM targets
 134   only. Available options are ``reg-names-std`` and ``reg-names-raw``.
 135
 136 .. option:: --mcpu=<cpu-name>
 137
 138   Target a specific CPU type for disassembly. Specify ``--mcpu=help`` to display
 139   available CPUs.
 140
 141 .. option:: --mattr=<a1,+a2,-a3,...>
 142
 143   Enable/disable target-specific attributes. Specify ``--mcpu=help`` to display
 144   the available attributes.
 145
 146 .. option:: --no-leading-addr
 147
 148   When disassembling, do not print leading addresses.
 149
 150 .. option:: --no-show-raw-insn
 151
 152   When disassembling, do not print the raw bytes of each instruction.
 153
 154 .. option:: --print-imm-hex
 155
 156   Use hex format when printing immediate values in disassembly output.
 157
 158 .. option:: -S, --source
 159
 160   When disassembling, display source interleaved with the disassembly. Implies
 161   :option:`--disassemble`.
 162
 163 .. option:: --show-lma
 164
 165   Display the LMA column when dumping ELF section headers. Defaults to off
 166   unless any section has different VMA and LMAs.
 167
 168 .. option:: --start-address=<address>
 169
 170   When disassembling, only disassemble from the specified address.
 171
 172   When printing relocations, only print the relocations patching offsets from at least ``address``.
 173
 174   When printing symbols, only print symbols with a value of at least ``address``.
 175
 176 .. option:: --stop-address=<address>
 177
 178   When disassembling, only disassemble up to, but not including the specified address.
 179
 180   When printing relocations, only print the relocations patching offsets up to ``address``.
 181
 182   When printing symbols, only print symbols with a value up to ``address``.
 183
 184 .. option:: --triple=<string>
 185
 186   Target triple to disassemble for, see ``--version`` for available targets.
 187
 188 .. option:: -w, --wide
 189
 190   Ignored for compatibility with GNU objdump.
 191
 192 .. option:: --x86-asm-syntax=<style>
 193
 194   When used with :option:`--disassemble`, choose style of code to emit from
 195   X86 backend. Supported values are:
 196
 197    .. option:: att
 198
 199     AT&T-style assembly
 200
 201    .. option:: intel
 202
 203     Intel-style assembly
 204
 205
 206   The default disassembly style is **att**.
 207
 208 .. option:: -z, --disassemble-zeroes
 209
 210   Do not skip blocks of zeroes when disassembling.
 211
 212 .. option:: @<FILE>
 213
 214   Read command-line options and commands from response file `<FILE>`.
 215
 216 MACH-O ONLY OPTIONS AND COMMANDS
 217 --------------------------------
 218
 219 .. option:: --arch=<architecture>
 220
 221   Specify the architecture to disassemble. see ``--version`` for available
 222   architectures.
 223
 224 .. option:: --archive-member-offsets
 225
 226   Print the offset to each archive member for Mach-O archives (requires
 227   :option:`--archive-headers`).
 228
 229 .. option:: --bind
 230
 231   Display binding info
 232
 233 .. option:: --cfg
 234
 235   Create a CFG for every symbol in the object file and write it to a graphviz
 236   file.
 237
 238 .. option:: --data-in-code
 239
 240   Display the data in code table.
 241
 242 .. option:: --dis-symname=<name>
 243
 244   Disassemble just the specified symbol's instructions.
 245
 246 .. option:: --dylibs-used
 247
 248   Display the shared libraries used for linked files.
 249
 250 .. option:: --dsym=<string>
 251
 252   Use .dSYM file for debug info.
 253
 254 .. option:: --dylib-id
 255
 256   Display the shared library's ID for dylib files.
 257
 258 .. option:: --exports-trie
 259
 260   Display exported symbols.
 261
 262 .. option:: -g
 263
 264   Print line information from debug info if available.
 265
 266 .. option:: --full-leading-addr
 267
 268   Print the full leading address when disassembling.
 269
 270 .. option:: --indirect-symbols
 271
 272   Display the indirect symbol table.
 273
 274 .. option:: --info-plist
 275
 276   Display the info plist section as strings.
 277
 278 .. option:: --lazy-bind
 279
 280   Display lazy binding info.
 281
 282 .. option:: --link-opt-hints
 283
 284   Display the linker optimization hints.
 285
 286 .. option:: -m, --macho
 287
 288   Use Mach-O specific object file parser. Commands and other options may behave
 289   differently when used with ``--macho``.
 290
 291 .. option:: --no-leading-headers
 292
 293   Do not print any leading headers.
 294
 295 .. option:: --no-symbolic-operands
 296
 297   Do not print symbolic operands when disassembling.
 298
 299 .. option:: --non-verbose
 300
 301   Display the information for Mach-O objects in non-verbose or numeric form.
 302
 303 .. option:: --objc-meta-data
 304
 305   Display the Objective-C runtime meta data.
 306
 307 .. option:: --private-header
 308
 309   Display only the first format specific file header.
 310
 311 .. option:: --rebase
 312
 313   Display rebasing information.
 314
 315 .. option:: --universal-headers
 316
 317   Display universal headers.
 318
 319 .. option:: --weak-bind
 320
 321   Display weak binding information.
 322
 323 BUGS
 324 ----
 325
 326 To report bugs, please visit <http://llvm.org/bugs/>.
 327
 328 SEE ALSO
 329 --------
 330
 331 :manpage:`llvm-nm(1)`, :manpage:`llvm-readelf(1)`, :manpage:`llvm-readobj(1)`