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 executable sections found in the input files. On some
  31   architectures (AArch64, PowerPC, x86), all known instructions are disassembled by
  32   default. On the others, :option:`--mcpu` or :option:`--mattr` is needed to
  33   enable some instruction sets. Disabled instructions are displayed as
  34   ``<unknown>``.
  35
  36 .. option:: -D, --disassemble-all
  37
  38   Disassemble all sections found in the input files.
  39
  40 .. option:: --disassemble-symbols=<symbol1[,symbol2,...]>
  41
  42   Disassemble only the specified symbols. Takes demangled symbol names when
  43   :option:`--demangle` is specified, otherwise takes mangled symbol names.
  44   Implies :option:`--disassemble`.
  45
  46 .. option:: --dwarf=<value>
  47
  48   Dump the specified DWARF debug sections. The supported values are:
  49
  50   `frames` - .debug_frame
  51
  52 .. option:: -f, --file-headers
  53
  54   Display the contents of the overall file header.
  55
  56 .. option:: --fault-map-section
  57
  58   Display the content of the fault map section.
  59
  60 .. option:: -h, --headers, --section-headers
  61
  62   Display summaries of the headers for each section.
  63
  64 .. option:: --help
  65
  66   Display usage information and exit. Does not stack with other commands.
  67
  68 .. option:: -p, --private-headers
  69
  70   Display format-specific file headers.
  71
  72 .. option:: -r, --reloc
  73
  74   Display the relocation entries in the file.
  75
  76 .. option:: -R, --dynamic-reloc
  77
  78   Display the dynamic relocation entries in the file.
  79
  80 .. option:: --raw-clang-ast
  81
  82   Dump the raw binary contents of the clang AST section.
  83
  84 .. option:: -s, --full-contents
  85
  86   Display the contents of each section.
  87
  88 .. option:: -t, --syms
  89
  90   Display the symbol table.
  91
  92 .. option:: -T, --dynamic-syms
  93
  94   Display the contents of the dynamic symbol table.
  95
  96 .. option:: -u, --unwind-info
  97
  98   Display the unwind info of the input(s).
  99
 100   This operation is only currently supported for COFF and Mach-O object files.
 101
 102 .. option:: -v, --version
 103
 104   Display the version of the :program:`llvm-objdump` executable. Does not stack
 105   with other commands.
 106
 107 .. option:: -x, --all-headers
 108
 109   Display all available header information. Equivalent to specifying
 110   :option:`--archive-headers`, :option:`--file-headers`,
 111   :option:`--private-headers`, :option:`--reloc`, :option:`--section-headers`,
 112   and :option:`--syms`.
 113
 114 OPTIONS
 115 -------
 116 :program:`llvm-objdump` supports the following options:
 117
 118 .. option:: --adjust-vma=<offset>
 119
 120   Increase the displayed address in disassembly or section header printing by
 121   the specified offset.
 122
 123 .. option:: --arch-name=<string>
 124
 125   Specify the target architecture when disassembling. Use :option:`--version`
 126   for a list of available targets.
 127
 128 .. option:: --build-id=<string>
 129
 130   Look up the object using the given build ID, specified as a hexadecimal
 131   string. The found object is handled as if it were an input filename.
 132
 133 .. option:: -C, --demangle
 134
 135   Demangle symbol names in the output.
 136
 137 .. option:: --debug-file-directory <path>
 138
 139   Provide a path to a directory with a `.build-id` subdirectory to search for
 140   debug information for stripped binaries. Multiple instances of this argument
 141   are searched in the order given.
 142
 143 .. option:: --debuginfod, --no-debuginfod
 144
 145   Whether or not to try debuginfod lookups for debug binaries. Unless specified,
 146   debuginfod is only enabled if libcurl was compiled in (``LLVM_ENABLE_CURL``)
 147   and at least one server URL was provided by the environment variable
 148   ``DEBUGINFOD_URLS``.
 149
 150 .. option:: --debug-vars=<format>
 151
 152   Print the locations (in registers or memory) of source-level variables
 153   alongside disassembly. ``format`` may be ``unicode`` or ``ascii``, defaulting
 154   to ``unicode`` if omitted.
 155
 156 .. option:: --debug-vars-indent=<width>
 157
 158   Distance to indent the source-level variable display, relative to the start
 159   of the disassembly. Defaults to 52 characters.
 160
 161 .. option:: -j, --section=<section1[,section2,...]>
 162
 163   Perform commands on the specified sections only. For Mach-O use
 164   `segment,section` to specify the section name.
 165
 166 .. option:: -l, --line-numbers
 167
 168   When disassembling, display source line numbers. Implies
 169   :option:`--disassemble`.
 170
 171 .. option:: -M, --disassembler-options=<opt1[,opt2,...]>
 172
 173   Pass target-specific disassembler options. Available options:
 174
 175   * ``reg-names-std``: ARM only (default). Print in ARM 's instruction set documentation, with r13/r14/r15 replaced by sp/lr/pc.
 176   * ``reg-names-raw``: ARM only. Use r followed by the register number.
 177   * ``no-aliases``: AArch64 and RISC-V only. Print raw instruction mnemonic instead of pseudo instruction mnemonic.
 178   * ``numeric``: RISC-V only. Print raw register names instead of ABI mnemonic. (e.g. print x1 instead of ra)
 179   * ``att``: x86 only (default). Print in the AT&T syntax.
 180   * ``intel``: x86 only. Print in the intel syntax.
 181
 182
 183 .. option::  --disassembler-color=<mode>
 184
 185   Enable or disable disassembler color output.
 186
 187   * ``off``: Disable disassembler color output.
 188   * ``on``: Enable disassembler color output.
 189   * ``terminal``: Enable disassembler color output if the terminal supports it (default).
 190
 191 .. option:: --mcpu=<cpu-name>
 192
 193   Target a specific CPU type for disassembly. Specify ``--mcpu=help`` to display
 194   available CPUs.
 195
 196 .. option:: --mattr=<a1,+a2,-a3,...>
 197
 198   Enable/disable target-specific attributes. Specify ``--mattr=help`` to display
 199   the available attributes.
 200
 201 .. option:: -mllvm <arg>
 202
 203    Specify an argument to forward to LLVM's CommandLine library.
 204
 205 .. option:: --no-leading-addr, --no-addresses
 206
 207   When disassembling, do not print leading addresses for instructions or inline
 208   relocations.
 209
 210 .. option:: --no-print-imm-hex
 211
 212   Do not use hex format for immediate values in disassembly output.
 213
 214 .. option:: --no-show-raw-insn
 215
 216   When disassembling, do not print the raw bytes of each instruction.
 217
 218 .. option:: --offloading
 219
 220   Display the content of the LLVM offloading section.
 221
 222 .. option:: --prefix=<prefix>
 223
 224   When disassembling with the :option:`--source` option, prepend ``prefix`` to
 225   absolute paths.
 226
 227 .. option:: --prefix-strip=<level>
 228
 229   When disassembling with the :option:`--source` option, strip out ``level``
 230   initial directories from absolute paths. This option has no effect without
 231   :option:`--prefix`.
 232
 233 .. option:: --print-imm-hex
 234
 235   Use hex format when printing immediate values in disassembly output (default).
 236
 237 .. option:: -S, --source
 238
 239   When disassembling, display source interleaved with the disassembly. Implies
 240   :option:`--disassemble`.
 241
 242 .. option:: --show-all-symbols
 243
 244   Show all symbols during disassembly, even if multiple symbols are defined at
 245   the same location.
 246
 247 .. option:: --show-lma
 248
 249   Display the LMA column when dumping ELF section headers. Defaults to off
 250   unless any section has different VMA and LMAs.
 251
 252 .. option:: --start-address=<address>
 253
 254   When disassembling, only disassemble from the specified address.
 255
 256   When printing relocations, only print the relocations patching offsets from at least ``address``.
 257
 258   When printing symbols, only print symbols with a value of at least ``address``.
 259
 260 .. option:: --stop-address=<address>
 261
 262   When disassembling, only disassemble up to, but not including the specified address.
 263
 264   When printing relocations, only print the relocations patching offsets up to ``address``.
 265
 266   When printing symbols, only print symbols with a value up to ``address``.
 267
 268 .. option:: --symbolize-operands
 269
 270   When disassembling, symbolize a branch target operand to print a label instead of a real address.
 271
 272   When printing a PC-relative global symbol reference, print it as an offset from the leading symbol.
 273
 274   When a bb-address-map section is present (i.e., the object file is built with ``-fbasic-block-sections=labels``), labels are retrieved from that section instead.
 275
 276   Only works with PowerPC objects or X86 linked images.
 277
 278   Example:
 279     A non-symbolized branch instruction with a local target and pc-relative memory access like
 280
 281   .. code-block:: none
 282
 283       cmp eax, dword ptr [rip + 4112]
 284       jge 0x20117e <_start+0x25>
 285
 286   might become
 287
 288   .. code-block:: none
 289
 290      <L0>:
 291        cmp eax, dword ptr <g>
 292        jge      <L0>
 293
 294 .. option:: --triple=<string>
 295
 296   Target triple to disassemble for, see ``--version`` for available targets.
 297
 298 .. option:: -w, --wide
 299
 300   Ignored for compatibility with GNU objdump.
 301
 302 .. option:: --x86-asm-syntax=<style>
 303
 304   Deprecated.
 305   When used with :option:`--disassemble`, choose style of code to emit from
 306   X86 backend. Supported values are:
 307
 308    .. option:: att
 309
 310     AT&T-style assembly
 311
 312    .. option:: intel
 313
 314     Intel-style assembly
 315
 316
 317   The default disassembly style is **att**.
 318
 319 .. option:: -z, --disassemble-zeroes
 320
 321   Do not skip blocks of zeroes when disassembling.
 322
 323 .. option:: @<FILE>
 324
 325   Read command-line options and commands from response file `<FILE>`.
 326
 327 MACH-O ONLY OPTIONS AND COMMANDS
 328 --------------------------------
 329
 330 .. option:: --arch=<architecture>
 331
 332   Specify the architecture to disassemble. see ``--version`` for available
 333   architectures.
 334
 335 .. option:: --archive-member-offsets
 336
 337   Print the offset to each archive member for Mach-O archives (requires
 338   :option:`--archive-headers`).
 339
 340 .. option:: --bind
 341
 342   Display binding info
 343
 344 .. option:: --data-in-code
 345
 346   Display the data in code table.
 347
 348 .. option:: --dis-symname=<name>
 349
 350   Disassemble just the specified symbol's instructions.
 351
 352 .. option:: --chained-fixups
 353
 354   Print chained fixup information.
 355
 356 .. option:: --dyld-info
 357
 358   Print bind and rebase information used by dyld to resolve external
 359   references in a final linked binary.
 360
 361 .. option:: --dylibs-used
 362
 363   Display the shared libraries used for linked files.
 364
 365 .. option:: --dsym=<string>
 366
 367   Use .dSYM file for debug info.
 368
 369 .. option:: --dylib-id
 370
 371   Display the shared library's ID for dylib files.
 372
 373 .. option:: --exports-trie
 374
 375   Display exported symbols.
 376
 377 .. option:: --function-starts [=<addrs|names|both>]
 378
 379   Print the function starts table for Mach-O objects. Either ``addrs``
 380   (default) to print only the addresses of functions, ``names`` to print only
 381   the names of the functions (when available), or ``both`` to print the
 382   names beside the addresses.
 383
 384 .. option:: -g
 385
 386   Print line information from debug info if available.
 387
 388 .. option:: --full-leading-addr
 389
 390   Print the full leading address when disassembling.
 391
 392 .. option:: --indirect-symbols
 393
 394   Display the indirect symbol table.
 395
 396 .. option:: --info-plist
 397
 398   Display the info plist section as strings.
 399
 400 .. option:: --lazy-bind
 401
 402   Display lazy binding info.
 403
 404 .. option:: --link-opt-hints
 405
 406   Display the linker optimization hints.
 407
 408 .. option:: -m, --macho
 409
 410   Use Mach-O specific object file parser. Commands and other options may behave
 411   differently when used with ``--macho``.
 412
 413 .. option:: --no-leading-headers
 414
 415   Do not print any leading headers.
 416
 417 .. option:: --no-symbolic-operands
 418
 419   Do not print symbolic operands when disassembling.
 420
 421 .. option:: --non-verbose
 422
 423   Display the information for Mach-O objects in non-verbose or numeric form.
 424
 425 .. option:: --objc-meta-data
 426
 427   Display the Objective-C runtime meta data.
 428
 429 .. option:: --private-header
 430
 431   Display only the first format specific file header.
 432
 433 .. option:: --rebase
 434
 435   Display rebasing information.
 436
 437 .. option:: --rpaths
 438
 439   Display runtime search paths for the binary.
 440
 441 .. option:: --universal-headers
 442
 443   Display universal headers.
 444
 445 .. option:: --weak-bind
 446
 447   Display weak binding information.
 448
 449 XCOFF ONLY OPTIONS AND COMMANDS
 450 ---------------------------------
 451
 452 .. option:: --symbol-description
 453
 454   Add symbol description to disassembly output.
 455
 456 .. option:: --traceback-table
 457
 458   Decode traceback table in disassembly output. Implies :option:`--disassemble`.
 459
 460 BUGS
 461 ----
 462
 463 To report bugs, please visit <https://github.com/llvm/llvm-project/labels/tools:llvm-objdump/>.
 464
 465 SEE ALSO
 466 --------
 467
 468 :manpage:`llvm-nm(1)`, :manpage:`llvm-otool(1)`, :manpage:`llvm-readelf(1)`,
 469 :manpage:`llvm-readobj(1)`