llvm/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-symbols=<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:: -T, --dynamic-syms
  89
  90   Display the contents of the dynamic symbol table.
  91
  92 .. option:: -u, --unwind-info
  93
  94   Display the unwind info of the input(s).
  95
  96 .. option:: -v, --version
  97
  98   Display the version of the :program:`llvm-objdump` executable. Does not stack
  99   with other commands.
 100
 101 .. option:: -x, --all-headers
 102
 103   Display all available header information. Equivalent to specifying
 104   :option:`--archive-headers`, :option:`--file-headers`,
 105   :option:`--private-headers`, :option:`--reloc`, :option:`--section-headers`,
 106   and :option:`--syms`.
 107
 108 OPTIONS
 109 -------
 110 :program:`llvm-objdump` supports the following options:
 111
 112 .. option:: --adjust-vma=<offset>
 113
 114   Increase the displayed address in disassembly or section header printing by
 115   the specified offset.
 116
 117 .. option:: --arch-name=<string>
 118
 119   Specify the target architecture when disassembling. Use :option:`--version`
 120   for a list of available targets.
 121
 122 .. option:: -C, --demangle
 123
 124   Demangle symbol names in the output.
 125
 126 .. option:: --debug-vars=<format>
 127
 128   Print the locations (in registers or memory) of source-level variables
 129   alongside disassembly. ``format`` may be ``unicode`` or ``ascii``, defaulting
 130   to ``unicode`` if omitted.
 131
 132 .. option:: --debug-vars-indent=<width>
 133
 134   Distance to indent the source-level variable display, relative to the start
 135   of the disassembly. Defaults to 52 characters.
 136
 137 .. option:: -j, --section=<section1[,section2,...]>
 138
 139   Perform commands on the specified sections only. For Mach-O use
 140   `segment,section` to specify the section name.
 141
 142 .. option:: -l, --line-numbers
 143
 144   When disassembling, display source line numbers. Implies
 145   :option:`--disassemble`.
 146
 147 .. option:: -M, --disassembler-options=<opt1[,opt2,...]>
 148
 149   Pass target-specific disassembler options. Available options:
 150
 151   * ``reg-names-std``: ARM only (default). Print in ARM 's instruction set documentation, with r13/r14/r15 replaced by sp/lr/pc.
 152   * ``reg-names-raw``: ARM only. Use r followed by the register number.
 153   * ``no-aliases``: AArch64 and RISC-V only. Print raw instruction mnemonic instead of pesudo instruction mnemonic.
 154   * ``numeric``: RISC-V only. Print raw register names instead of ABI mnemonic. (e.g. print x1 instead of ra)
 155   * ``att``: x86 only (default). Print in the AT&T syntax.
 156   * ``intel``: x86 only. Print in the intel syntax.
 157
 158 .. option:: --mcpu=<cpu-name>
 159
 160   Target a specific CPU type for disassembly. Specify ``--mcpu=help`` to display
 161   available CPUs.
 162
 163 .. option:: --mattr=<a1,+a2,-a3,...>
 164
 165   Enable/disable target-specific attributes. Specify ``--mattr=help`` to display
 166   the available attributes.
 167
 168 .. option:: --no-leading-addr
 169
 170   When disassembling, do not print leading addresses.
 171
 172 .. option:: --no-print-imm-hex
 173
 174   Do not use hex format for immediate values in disassembly output (default).
 175
 176 .. option:: --no-show-raw-insn
 177
 178   When disassembling, do not print the raw bytes of each instruction.
 179
 180 .. option:: --prefix=<prefix>
 181
 182   When disassembling with the :option:`--source` option, prepend ``prefix`` to
 183   absolute paths.
 184
 185 .. option:: --prefix-strip=<level>
 186
 187   When disassembling with the :option:`--source` option, strip out ``level``
 188   initial directories from absolute paths. This option has no effect without
 189   :option:`--prefix`.
 190
 191 .. option:: --print-imm-hex
 192
 193   Use hex format when printing immediate values in disassembly output.
 194
 195 .. option:: -S, --source
 196
 197   When disassembling, display source interleaved with the disassembly. Implies
 198   :option:`--disassemble`.
 199
 200 .. option:: --show-lma
 201
 202   Display the LMA column when dumping ELF section headers. Defaults to off
 203   unless any section has different VMA and LMAs.
 204
 205 .. option:: --start-address=<address>
 206
 207   When disassembling, only disassemble from the specified address.
 208
 209   When printing relocations, only print the relocations patching offsets from at least ``address``.
 210
 211   When printing symbols, only print symbols with a value of at least ``address``.
 212
 213 .. option:: --stop-address=<address>
 214
 215   When disassembling, only disassemble up to, but not including the specified address.
 216
 217   When printing relocations, only print the relocations patching offsets up to ``address``.
 218
 219   When printing symbols, only print symbols with a value up to ``address``.
 220
 221 .. option:: --symbolize-operands
 222
 223   When disassembling, symbolize a branch target operand to print a label instead of a real address.
 224
 225   When printing a PC-relative global symbol reference, print it as an offset from the leading symbol.
 226
 227   Only works with an X86 linked image.
 228
 229   Example:
 230     A non-symbolized branch instruction with a local target and pc-relative memory access like
 231
 232   .. code-block:: none
 233
 234       cmp eax, dword ptr [rip + 4112]
 235       jge 0x20117e <_start+0x25>
 236
 237   might become
 238
 239   .. code-block:: none
 240
 241      <L0>:
 242        cmp eax, dword ptr <g>
 243        jge      <L0>
 244
 245 .. option:: --triple=<string>
 246
 247   Target triple to disassemble for, see ``--version`` for available targets.
 248
 249 .. option:: -w, --wide
 250
 251   Ignored for compatibility with GNU objdump.
 252
 253 .. option:: --x86-asm-syntax=<style>
 254
 255   Deprecated.
 256   When used with :option:`--disassemble`, choose style of code to emit from
 257   X86 backend. Supported values are:
 258
 259    .. option:: att
 260
 261     AT&T-style assembly
 262
 263    .. option:: intel
 264
 265     Intel-style assembly
 266
 267
 268   The default disassembly style is **att**.
 269
 270 .. option:: -z, --disassemble-zeroes
 271
 272   Do not skip blocks of zeroes when disassembling.
 273
 274 .. option:: @<FILE>
 275
 276   Read command-line options and commands from response file `<FILE>`.
 277
 278 MACH-O ONLY OPTIONS AND COMMANDS
 279 --------------------------------
 280
 281 .. option:: --arch=<architecture>
 282
 283   Specify the architecture to disassemble. see ``--version`` for available
 284   architectures.
 285
 286 .. option:: --archive-member-offsets
 287
 288   Print the offset to each archive member for Mach-O archives (requires
 289   :option:`--archive-headers`).
 290
 291 .. option:: --bind
 292
 293   Display binding info
 294
 295 .. option:: --data-in-code
 296
 297   Display the data in code table.
 298
 299 .. option:: --dis-symname=<name>
 300
 301   Disassemble just the specified symbol's instructions.
 302
 303 .. option:: --dylibs-used
 304
 305   Display the shared libraries used for linked files.
 306
 307 .. option:: --dsym=<string>
 308
 309   Use .dSYM file for debug info.
 310
 311 .. option:: --dylib-id
 312
 313   Display the shared library's ID for dylib files.
 314
 315 .. option:: --exports-trie
 316
 317   Display exported symbols.
 318
 319 .. option:: --function-starts
 320
 321   Print the function starts table for Mach-O objects.
 322
 323 .. option:: -g
 324
 325   Print line information from debug info if available.
 326
 327 .. option:: --full-leading-addr
 328
 329   Print the full leading address when disassembling.
 330
 331 .. option:: --indirect-symbols
 332
 333   Display the indirect symbol table.
 334
 335 .. option:: --info-plist
 336
 337   Display the info plist section as strings.
 338
 339 .. option:: --lazy-bind
 340
 341   Display lazy binding info.
 342
 343 .. option:: --link-opt-hints
 344
 345   Display the linker optimization hints.
 346
 347 .. option:: -m, --macho
 348
 349   Use Mach-O specific object file parser. Commands and other options may behave
 350   differently when used with ``--macho``.
 351
 352 .. option:: --no-leading-headers
 353
 354   Do not print any leading headers.
 355
 356 .. option:: --no-symbolic-operands
 357
 358   Do not print symbolic operands when disassembling.
 359
 360 .. option:: --non-verbose
 361
 362   Display the information for Mach-O objects in non-verbose or numeric form.
 363
 364 .. option:: --objc-meta-data
 365
 366   Display the Objective-C runtime meta data.
 367
 368 .. option:: --private-header
 369
 370   Display only the first format specific file header.
 371
 372 .. option:: --rebase
 373
 374   Display rebasing information.
 375
 376 .. option:: --rpaths
 377
 378   Display runtime search paths for the binary.
 379
 380 .. option:: --universal-headers
 381
 382   Display universal headers.
 383
 384 .. option:: --weak-bind
 385
 386   Display weak binding information.
 387
 388 XCOFF ONLY OPTIONS AND COMMANDS
 389 ---------------------------------
 390
 391 .. option:: --symbol-description
 392
 393   Add symbol description to disassembly output.
 394
 395 BUGS
 396 ----
 397
 398 To report bugs, please visit <https://bugs.llvm.org/>.
 399
 400 SEE ALSO
 401 --------
 402
 403 :manpage:`llvm-nm(1)`, :manpage:`llvm-otool(1)`, :manpage:`llvm-readelf(1)`,
 404 :manpage:`llvm-readobj(1)`