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 the :program:`llvm-objdump` executable. Does not stack
  95   with other commands.
  96
  97 .. option:: -x, --all-headers
  98
  99   Display all available header information. Equivalent to specifying
 100   :option:`--archive-headers`, :option:`--file-headers`,
 101   :option:`--private-headers`, :option:`--reloc`, :option:`--section-headers`,
 102   and :option:`--syms`.
 103
 104 OPTIONS
 105 -------
 106 :program:`llvm-objdump` supports the following options:
 107
 108 .. option:: --adjust-vma=<offset>
 109
 110   Increase the displayed address in disassembly or section header printing by
 111   the specified offset.
 112
 113 .. option:: --arch-name=<string>
 114
 115   Specify the target architecture when disassembling. Use :option:`--version`
 116   for a list of available targets.
 117
 118 .. option:: -C, --demangle
 119
 120   Demangle symbol names in the output.
 121
 122 .. option:: -j, --section=<section1[,section2,...]>
 123
 124   Perform commands on the specified sections only. For Mach-O use
 125   `segment,section` to specify the section name.
 126
 127 .. option:: -l, --line-numbers
 128
 129   When disassembling, display source line numbers. Implies
 130   :option:`--disassemble`.
 131
 132 .. option:: -M, --disassembler-options=<opt1[,opt2,...]>
 133
 134   Pass target-specific disassembler options. Currently supported for ARM targets
 135   only. Available options are ``reg-names-std`` and ``reg-names-raw``.
 136
 137 .. option:: --mcpu=<cpu-name>
 138
 139   Target a specific CPU type for disassembly. Specify ``--mcpu=help`` to display
 140   available CPUs.
 141
 142 .. option:: --mattr=<a1,+a2,-a3,...>
 143
 144   Enable/disable target-specific attributes. Specify ``--mcpu=help`` to display
 145   the available attributes.
 146
 147 .. option:: --no-leading-addr
 148
 149   When disassembling, do not print leading addresses.
 150
 151 .. option:: --no-show-raw-insn
 152
 153   When disassembling, do not print the raw bytes of each instruction.
 154
 155 .. option:: --print-imm-hex
 156
 157   Use hex format when printing immediate values in disassembly output.
 158
 159 .. option:: -S, --source
 160
 161   When disassembling, display source interleaved with the disassembly. Implies
 162   :option:`--disassemble`.
 163
 164 .. option:: --show-lma
 165
 166   Display the LMA column when dumping ELF section headers. Defaults to off
 167   unless any section has different VMA and LMAs.
 168
 169 .. option:: --start-address=<address>
 170
 171   When disassembling, only disassemble from the specified address.
 172
 173   When printing relocations, only print the relocations patching offsets from at least ``address``.
 174
 175   When printing symbols, only print symbols with a value of at least ``address``.
 176
 177 .. option:: --stop-address=<address>
 178
 179   When disassembling, only disassemble up to, but not including the specified address.
 180
 181   When printing relocations, only print the relocations patching offsets up to ``address``.
 182
 183   When printing symbols, only print symbols with a value up to ``address``.
 184
 185 .. option:: --triple=<string>
 186
 187   Target triple to disassemble for, see ``--version`` for available targets.
 188
 189 .. option:: -w, --wide
 190
 191   Ignored for compatibility with GNU objdump.
 192
 193 .. option:: --x86-asm-syntax=<style>
 194
 195   When used with :option:`--disassemble`, choose style of code to emit from
 196   X86 backend. Supported values are:
 197
 198    .. option:: att
 199
 200     AT&T-style assembly
 201
 202    .. option:: intel
 203
 204     Intel-style assembly
 205
 206
 207   The default disassembly style is **att**.
 208
 209 .. option:: -z, --disassemble-zeroes
 210
 211   Do not skip blocks of zeroes when disassembling.
 212
 213 .. option:: @<FILE>
 214
 215   Read command-line options and commands from response file `<FILE>`.
 216
 217 MACH-O ONLY OPTIONS AND COMMANDS
 218 --------------------------------
 219
 220 .. option:: --arch=<architecture>
 221
 222   Specify the architecture to disassemble. see ``--version`` for available
 223   architectures.
 224
 225 .. option:: --archive-member-offsets
 226
 227   Print the offset to each archive member for Mach-O archives (requires
 228   :option:`--archive-headers`).
 229
 230 .. option:: --bind
 231
 232   Display binding info
 233
 234 .. option:: --cfg
 235
 236   Create a CFG for every symbol in the object file and write it to a graphviz
 237   file.
 238
 239 .. option:: --data-in-code
 240
 241   Display the data in code table.
 242
 243 .. option:: --dis-symname=<name>
 244
 245   Disassemble just the specified symbol's instructions.
 246
 247 .. option:: --dylibs-used
 248
 249   Display the shared libraries used for linked files.
 250
 251 .. option:: --dsym=<string>
 252
 253   Use .dSYM file for debug info.
 254
 255 .. option:: --dylib-id
 256
 257   Display the shared library's ID for dylib files.
 258
 259 .. option:: --exports-trie
 260
 261   Display exported symbols.
 262
 263 .. option:: -g
 264
 265   Print line information from debug info if available.
 266
 267 .. option:: --full-leading-addr
 268
 269   Print the full leading address when disassembling.
 270
 271 .. option:: --indirect-symbols
 272
 273   Display the indirect symbol table.
 274
 275 .. option:: --info-plist
 276
 277   Display the info plist section as strings.
 278
 279 .. option:: --lazy-bind
 280
 281   Display lazy binding info.
 282
 283 .. option:: --link-opt-hints
 284
 285   Display the linker optimization hints.
 286
 287 .. option:: -m, --macho
 288
 289   Use Mach-O specific object file parser. Commands and other options may behave
 290   differently when used with ``--macho``.
 291
 292 .. option:: --no-leading-headers
 293
 294   Do not print any leading headers.
 295
 296 .. option:: --no-symbolic-operands
 297
 298   Do not print symbolic operands when disassembling.
 299
 300 .. option:: --non-verbose
 301
 302   Display the information for Mach-O objects in non-verbose or numeric form.
 303
 304 .. option:: --objc-meta-data
 305
 306   Display the Objective-C runtime meta data.
 307
 308 .. option:: --private-header
 309
 310   Display only the first format specific file header.
 311
 312 .. option:: --rebase
 313
 314   Display rebasing information.
 315
 316 .. option:: --universal-headers
 317
 318   Display universal headers.
 319
 320 .. option:: --weak-bind
 321
 322   Display weak binding information.
 323
 324 BUGS
 325 ----
 326
 327 To report bugs, please visit <http://llvm.org/bugs/>.
 328
 329 SEE ALSO
 330 --------
 331
 332 :manpage:`llvm-nm(1)`, :manpage:`llvm-readelf(1)`, :manpage:`llvm-readobj(1)`