[docs] Add LICENSE.txt to the root of the mono-repo
[llvm-project.git] / llvm / docs / llvm-objdump.1
blob42dcc736765975faaafa5a74aec82215e6093154
1 .\" Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
2 .\" See https://llvm.org/LICENSE.txt for license information.
3 .\" SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
4 .\"
5 .Dd December 19, 2018
6 .Dt LLVM-OBJDUMP 1
7 .Os
8 .Sh NAME
9 .Nm llvm-objdump
10 .Nd LLVM object file dumper
11 .Sh SYNOPSIS
12 .Nm llvm-objdump
13 .Op Ar options
14 .Ar objfile ...
15 .Sh DESCRIPTION
16 .Nm
17 prints the contents of object files and final linked images named on the
18 command line.
19 If no file name is specified,
20 .Nm
21 will attempt to read from
22 .Pa a.out .
24 .Pa -
25 is used as a file name,
26 .Nm
27 will process a file on its standard input stream.
28 .Nm
29 accepts many of the same command line arguments as GNU objdump.
30 .Sh OPTIONS
31 .Ss General Options
32 .Bl -tag -width indent
33 .It Fl -aarch64-neon-syntax Ns = Ns Ar value
34 Choose style of NEON code to emit from AArch64 backend.
35 .Ar value
36 may be one of:
37 .Bl -tag -width indent
38 .It generic
39 Generic NEON assembly
40 .It apple
41 Apple-style NEON assembly
42 .El
43 .It Fl -arch Ns = Ns Ar value
44 Choose architecture(s) from a Mach-O file to dump
45 .It Fl -arch-name Ns = Ns ar arch
46 Target arch to disassemble for.
47 See
48 .Fl -version
49 for available targets.
50 .It Fl -bind
51 Display mach-o binding info.
52 .It Fl -color
53 Use colored syntax highlighting.
54 Default autodetect.
55 .It Fl -disassemble
56 Display assembler mnemonics for machine instructions.
57 .It Fl -disassemble-all
58 Display assembler mnemonics for the machine instruction in all sections.
59 .It Fl -dsym Ns = Ns Ar file
60 Use
61 .Ar file
62 for debug info.
63 .It Fl -dwarf Ns = Ns Ar sections
64 Dump of dwarf debug sections.
65 .Bl -tag -width indent
66 .It frames
67 .Dv .debug_frame
68 .El
69 .It Fl -exports-trie
70 Display mach-o exported symbols.
71 .It Fl -fault-map-section
72 Display contents of faultmap section.
73 .It Fl -filter-print-funcs Ns = Ns Ar functions
74 Only print IR for functions whose name match
75 .Ar functions
76 for all print-[before|after][-all] options.
77 .It Fl -full-leading-addr
78 Print full leading address.
79 .It Fl g
80 Print line information from debug info if available.
81 .It Fl h , -headers , -section-headers
82 Display summaries of the headers for each section.
83 .It Fl -help
84 Display available options.
85 Use
86 .Fl -help-hidden
87 for more.
88 .It Fl -lazy-bind
89 Display mach-o lazy binding info.
90 .It Fl -line-numbers
91 Display source line numbers with disassembly.
92 Implies disassemble object.
93 .It Fl -macho
94 Use MachO specific object file parser.
95 .It Fl -mattr Ns = Ns Ar attribute ...
96 Target specific attributes.
97 .It Fl -mcpu Ns = Ns Ar CPU
98 Target a specific cpu type.
99 Use
100 .Fl mcpu Ns = Ns help
101 for details.
102 .It Fl -no-leading-addr
103 Print no leading address.
104 .It Fl -no-leading-headers
105 Print no leading headers.
106 .It Fl -no-show-raw-insn
107 When disassembling instructions, do not print the instruction bytes.
108 .It Fl -offloading
109 Display the content of the LLVM offloading section.
110 .It Fl -prefix Ns = Ns Ar PREFIX
111 When disassembling, add
112 .Ar PREFIX
113 to absolute paths.
114 .It Fl -prefix-strip Ns = Ns Ar LEVEL
115 When disassembling, strip out
116 .Ar LEVEL
117 initial directories from absolute paths. This option has no effect without
118 .Fl -prefix Ns = Ns PREFIX .
119 .It Fl -print-imm-hex
120 Use hex format for immediate values.
121 .It Fl -private-header
122 Display only the first format specific file header.
123 .It Fl -private-headers
124 Display format specific file headers.
125 .It Fl r
126 Display the relocation entries in the file.
127 .It Fl -raw-clang-ast
128 Dump the raw binary contents of the clang AST section.
129 .It Fl -rebase
130 Display mach-o rebasing info.
131 .It Fl -reverse-iterate
132 Reverse iterate.
133 .It Fl s
134 Display the content of each section.
135 .It Fl -section Ns = Ns Ar section
136 Operate on the specified sections only.
137 With
138 .Fl -macho
139 dump segment,section.
140 .It Fl -source
141 Display source inline with disassembly.
142 Implies disassemble object.
143 .It Fl -start-address Ns = Ns Ar address
144 Disassemble beginning at
145 .Ar address .
146 .It Fl -stop-address Ns = Ns Ar address
147 Stop disassembly at
148 .Ar address .
149 .It Fl t
150 Display the symbol table.
151 .It Fl -triple Ns = Ns Ar triple
152 Target triple to disassemble for.
154 .Fl -version
155 for available targets.
156 .It Fl -unwind-info
157 Display unwind information.
158 .It Fl -version
159 Display the version of this program.
160 .It Fl -weak-bind
161 Display mach-o weak binding info.
162 .It Fl -x86-asm-syntax Ns = Ns Ar syntax
163 Choose style of code to emit from X86 backend.
164 .Bl -tag -width indent
165 .It att
166 Emit AT&T-style assembly.
167 .It intel
168 Emit Intel-style assembly.
171 .Ss Mach-O Options
172 There are a number of options specific to the Mach-O format.
173 These are used in combination with the
174 .Fl -macho
175 option.
176 .Bl -tag -width indent
177 .It Fl -archive-headers
178 Print archive headers for Mach-O archives.
179 .It Fl -archive-member-offsets
180 Print the offset to each archive member for Mach-O archives.
181 Requires
182 .Fl -macho
184 .Fl -archive-headers .
185 .It Fl -data-in-code
186 Print the data in code table for Mach-O objects.
187 .It Fl -dis-symname Ns = Ns Ar symbol
188 Disassemble just
189 .Ar symbol 's
190 instructions.
191 .It Fl -dylib-id
192 Print the shared library's id for the dylib Mach-O file.
193 .It Fl -dylibs-used
194 Print the shared libraries used for linked Mach-O files.
195 .It Fl -indirect-symbols
196 Print indirect symbol table for Mach-O objects.
197 .It Fl -info-plist
198 Print the info plist section as strings for Mach-O objects.
199 .It Fl -link-opt-hints
200 Print the linker optimization hints for Mach-O objects.
201 .It Fl -no-symbolic-operands
202 do not symbolic operands when disassembling.
203 .It Fl -non-verbose
204 Print the info for Mach-O objects in non-verbose or numeric form.
205 .It Fl -objc-meta-data
206 Print the Objective-C runtime meta data for Mach-O files.
207 .It Fl -universal-headers
208 Print Mach-O universal headers.