1LLVM-READOBJ(1)                      LLVM                      LLVM-READOBJ(1)
2
3
4

NAME

6       llvm-readobj - LLVM Object Reader
7

SYNOPSIS

9       llvm-readobj [options] [input...]
10

DESCRIPTION

12       The  llvm-readobj  tool  displays low-level format-specific information
13       about one or more object files.
14
15       If input is "-", llvm-readobj reads from standard input. Otherwise,  it
16       will read from the specified filenames.
17

DIFFERENCES TO LLVM-READELF

19       llvm-readelf is an alias for the llvm-readobj tool with a slightly dif‐
20       ferent command-line interface and output that is GNU compatible.   Fol‐
21       lowing is a list of differences between llvm-readelf and llvm-readobj:
22
23       • llvm-readelf  uses  GNU for the --elf-output-style option by default.
24         llvm-readobj uses LLVM.
25
26       • llvm-readelf allows single-letter grouped flags  (e.g.   llvm-readelf
27         -SW is the same as  llvm-readelf -S -W).  llvm-readobj does not allow
28         grouping.
29
30       • llvm-readelf provides -s as an alias for --symbols, for  GNU  readelf
31         compatibility,  whereas  it  is  an  alias  for  --section-headers in
32         llvm-readobj.
33
34       • llvm-readobj provides -t as an  alias  for  --symbols.   llvm-readelf
35         does not.
36
37       • llvm-readobj  provides  --sr,  --sd,  --st  and  --dt  as aliases for
38         --section-relocations,    --section-data,    --section-symbols    and
39         --dyn-symbols  respectively.   llvm-readelf  does  not  provide these
40         aliases, to avoid conflicting with grouped flags.
41

GENERAL AND MULTI-FORMAT OPTIONS

43       These options are applicable to more than one file format, or are unre‐
44       lated to file formats.
45
46       --all  Equivalent  to  specifying all the main display options relevant
47              to the file format.
48
49       --addrsig
50              Display the address-significance table.
51
52       --expand-relocs
53              When used with --relocs, display each relocation in an  expanded
54              multi-line format.
55
56       --file-header, -h
57              Display file headers.
58
59       --headers, -e
60              Equivalent  to  setting:  --file-header,  --program-headers, and
61              --sections.
62
63       --help Display a summary of command line options.
64
65       --hex-dump=<section[,section,...]>, -x
66              Display the specified section(s) as hexadecimal  bytes.  section
67              may be a section index or section name.
68
69       --needed-libs
70              Display the needed libraries.
71
72       --relocations, --relocs, -r
73              Display the relocation entries in the file.
74
75       --sections, --section-headers, -S
76              Display all sections.
77
78       --section-data, --sd
79              When used with --sections, display section data for each section
80              shown. This option has no effect for GNU style output.
81
82       --section-relocations, --sr
83              When used with --sections, display relocations for each  section
84              shown. This option has no effect for GNU style output.
85
86       --section-symbols, --st
87              When  used  with  --sections,  display  symbols for each section
88              shown.  This option has no effect for GNU style output.
89
90       --sort-symbols=<sort_key[,sort_key]>
91              Specify the keys  to  sort  symbols  before  displaying  symtab.
92              Valid values for sort_key are name and type.
93
94       --stackmap
95              Display contents of the stackmap section.
96
97       --string-dump=<section[,section,...]>, -p
98              Display  the  specified section(s) as a list of strings. section
99              may be a section index or section name.
100
101       --string-table
102              Display contents of the string table.
103
104       --symbols, --syms, -s
105              Display the symbol table.
106
107       --unwind, -u
108              Display unwind information.
109
110       --version
111              Display the version of the llvm-readobj executable.
112
113       @<FILE>
114              Read command-line options from response file <FILE>.
115

ELF SPECIFIC OPTIONS

117       The following options are implemented only for the ELF file format.
118
119       --arch-specific, -A
120              Display architecture-specific  information,  e.g.  the  ARM  at‐
121              tributes section on ARM.
122
123       --bb-addr-map
124              Display  the contents of the basic block address map section(s),
125              which contain the address of each function, along with the rela‐
126              tive offset of each basic block.
127
128       --demangle, -C
129              Display demangled symbol names in the output.
130
131       --dependent-libraries
132              Display the dependent libraries section.
133
134       --dyn-relocations
135              Display the dynamic relocation entries.
136
137       --dyn-symbols, --dyn-syms, --dt
138              Display the dynamic symbol table.
139
140       --dynamic-table, --dynamic, -d
141              Display the dynamic table.
142
143       --cg-profile
144              Display the callgraph profile section.
145
146       --histogram, -I
147              Display a bucket list histogram for dynamic symbol hash tables.
148
149       --elf-linker-options
150              Display the linker options section.
151
152       --elf-output-style=<value>
153              Format ELF information in the specified style. Valid options are
154              LLVM, GNU, and JSON. LLVM output (the default)  is  an  expanded
155              and  structured  format.  GNU  output  mimics the equivalent GNU
156              readelf output. JSON is JSON formatted output intended  for  ma‐
157              chine consumption.
158
159       --section-groups, -g
160              Display section groups.
161
162       --gnu-hash-table
163              Display the GNU hash table for dynamic symbols.
164
165       --hash-symbols
166              Display the expanded hash table with dynamic symbol data.
167
168       --hash-table
169              Display the hash table for dynamic symbols.
170
171       --notes, -n
172              Display all notes.
173
174       --pretty-print
175              When used with --elf-output-style, JSON output will be formatted
176              in a more readable format.
177
178       --program-headers, --segments, -l
179              Display the program headers.
180
181       --raw-relr
182              Do not decode relocations in RELR relocation sections when  dis‐
183              playing them.
184
185       --section-mapping
186              Display the section to segment mapping.
187
188       --stack-sizes
189              Display  the  contents of the stack sizes section(s), i.e. pairs
190              of function names and the size of their stack frames.  Currently
191              only implemented for GNU style output.
192
193       --version-info, -V
194              Display version sections.
195

MACH-O SPECIFIC OPTIONS

197       The following options are implemented only for the Mach-O file format.
198
199       --macho-data-in-code
200              Display the Data in Code command.
201
202       --macho-dsymtab
203              Display the Dsymtab command.
204
205       --macho-indirect-symbols
206              Display indirect symbols.
207
208       --macho-linker-options
209              Display the Mach-O-specific linker options.
210
211       --macho-segment
212              Display the Segment command.
213
214       --macho-version-min
215              Display the version min command.
216

PE/COFF SPECIFIC OPTIONS

218       The following options are implemented only for the PE/COFF file format.
219
220       --codeview
221              Display CodeView debug information.
222
223       --codeview-ghash
224              Enable global hashing for CodeView type stream de-duplication.
225
226       --codeview-merged-types
227              Display the merged CodeView type stream.
228
229       --codeview-subsection-bytes
230              Dump raw contents of CodeView debug sections and records.
231
232       --coff-basereloc
233              Display the .reloc section.
234
235       --coff-debug-directory
236              Display the debug directory.
237
238       --coff-tls-directory
239              Display the TLS directory.
240
241       --coff-directives
242              Display the .drectve section.
243
244       --coff-exports
245              Display the export table.
246
247       --coff-imports
248              Display the import table.
249
250       --coff-load-config
251              Display the load config.
252
253       --coff-resources
254              Display the .rsrc section.
255

XCOFF SPECIFIC OPTIONS

257       The following options are implemented only for the XCOFF file format.
258
259       --auxiliary-header
260              Display XCOFF Auxiliary header.
261
262       --exception-section
263              Display XCOFF exception section entries.
264
265       --loader-section-header
266              Display XCOFF loader section header.
267
268       --loader-section-symbols
269              Display symbol table of loader section.
270
271       --loader-section-relocations
272              Display relocation entries of loader section.
273

EXIT STATUS

275       llvm-readobj  returns  0  under normal operation. It returns a non-zero
276       exit code if there were any errors.
277

SEE ALSO

279       llvm-nm(1), llvm-objdump(1), llvm-readelf(1)
280

AUTHOR

282       Maintained by the LLVM Team (https://llvm.org/).
283

COPYRIGHT

285       2003-2023, LLVM Project
286
287
288
289
29016                                2023-07-20                   LLVM-READOBJ(1)