1llvm-readelf - GNU-style LLVM Object Reader
2===========================================
3
4.. program:: llvm-readelf
5
6SYNOPSIS
7--------
8
9:program:`llvm-readelf` [*options*] [*input...*]
10
11DESCRIPTION
12-----------
13
14The :program:`llvm-readelf` tool displays low-level format-specific information
15about one or more object files.
16
17If ``input`` is "``-``", :program:`llvm-readelf` reads from standard
18input. Otherwise, it will read from the specified ``filenames``.
19
20OPTIONS
21-------
22
23.. option:: --all, -a
24
25 Equivalent to specifying all the main display options relevant to the file
26 format.
27
28.. option:: --addrsig
29
30 Display the address-significance table.
31
32.. option:: --arch-specific, -A
33
34 Display architecture-specific information, e.g. the ARM attributes section on ARM.
35
36.. option:: --bb-addr-map
37
38 Display the contents of the basic block address map section(s), which contain the
39 address of each function, along with the relative offset of each basic block.
40
41.. option:: --demangle, -C
42
43 Display demangled symbol names in the output.
44
45.. option:: --dependent-libraries
46
47 Display the dependent libraries section.
48
49.. option:: --dyn-relocations
50
51 Display the dynamic relocation entries.
52
53.. option:: --dyn-symbols, --dyn-syms
54
55 Display the dynamic symbol table.
56
57.. option:: --dynamic-table, --dynamic, -d
58
59 Display the dynamic table.
60
61.. option:: --cg-profile
62
63 Display the callgraph profile section.
64
65.. option:: --histogram, -I
66
67 Display a bucket list histogram for dynamic symbol hash tables.
68
69.. option:: --elf-linker-options
70
71 Display the linker options section.
72
73.. option:: --elf-output-style=<value>
74
75 Format ELF information in the specified style. Valid options are ``LLVM``,
76 ``GNU``, and ``JSON``. ``LLVM`` output is an expanded and structured format.
77 ``GNU`` (the default) output mimics the equivalent GNU :program:`readelf`
78 output. ``JSON`` is JSON formatted output intended for machine consumption.
79
80.. option:: --section-groups, -g
81
82 Display section groups.
83
84.. option:: --expand-relocs
85
86 When used with :option:`--relocations`, display each relocation in an expanded
87 multi-line format.
88
89.. option:: --file-header, -h
90
91 Display file headers.
92
93.. option:: --gnu-hash-table
94
95 Display the GNU hash table for dynamic symbols.
96
97.. option:: --hash-symbols
98
99 Display the expanded hash table with dynamic symbol data.
100
101.. option:: --hash-table
102
103 Display the hash table for dynamic symbols.
104
105.. option:: --headers, -e
106
107 Equivalent to setting: :option:`--file-header`, :option:`--program-headers`,
108 and :option:`--sections`.
109
110.. option:: --help
111
112 Display a summary of command line options.
113
114.. option:: --hex-dump=<section[,section,...]>, -x
115
116 Display the specified section(s) as hexadecimal bytes. ``section`` may be a
117 section index or section name.
118
119.. option:: --needed-libs
120
121 Display the needed libraries.
122
123.. option:: --no-demangle
124
125 Do not display demangled symbol names in the output. On by default.
126
127.. option:: --notes, -n
128
129 Display all notes.
130
131.. option:: --pretty-print
132
133 When used with :option:`--elf-output-style`, JSON output will be formatted in
134 a more readable format.
135
136.. option:: --program-headers, --segments, -l
137
138 Display the program headers.
139
140.. option:: --raw-relr
141
142 Do not decode relocations in RELR relocation sections when displaying them.
143
144.. option:: --relocations, --relocs, -r
145
146 Display the relocation entries in the file.
147
148.. option:: --sections, --section-headers, -S
149
150 Display all sections.
151
152.. option:: --section-data
153
154 When used with :option:`--sections`, display section data for each section
155 shown. This option has no effect for GNU style output.
156
157.. option:: --section-details, -t
158
159 Display all section details. Used as an alternative to :option:`--sections`.
160
161.. option:: --section-mapping
162
163 Display the section to segment mapping.
164
165.. option:: --section-relocations
166
167 When used with :option:`--sections`, display relocations for each section
168 shown. This option has no effect for GNU style output.
169
170.. option:: --section-symbols
171
172 When used with :option:`--sections`, display symbols for each section shown.
173 This option has no effect for GNU style output.
174
175.. option:: --stackmap
176
177 Display contents of the stackmap section.
178
179.. option:: --stack-sizes
180
181 Display the contents of the stack sizes section(s), i.e. pairs of function
182 names and the size of their stack frames. Currently only implemented for GNU
183 style output.
184
185.. option:: --string-dump=<section[,section,...]>, -p
186
187 Display the specified section(s) as a list of strings. ``section`` may be a
188 section index or section name.
189
190.. option:: --symbols, --syms, -s
191
192 Display the symbol table. Also display the dynamic symbol table when using GNU output style for ELF.
193
194.. option:: --unwind, -u
195
196 Display unwind information.
197
198.. option:: --version
199
200 Display the version of the :program:`llvm-readelf` executable.
201
202.. option:: --version-info, -V
203
204 Display version sections.
205
206.. option:: --wide, -W
207
208 Ignored for GNU readelf compatibility. The output is already similar to when using -W with GNU readelf.
209
210.. option:: @<FILE>
211
212 Read command-line options from response file `<FILE>`.
213
214EXIT STATUS
215-----------
216
217:program:`llvm-readelf` returns 0 under normal operation. It returns a non-zero
218exit code if there were any errors.
219
220SEE ALSO
221--------
222
223:manpage:`llvm-nm(1)`, :manpage:`llvm-objdump(1)`, :manpage:`llvm-readobj(1)`
224