1 //===- llvm-readobj.cpp - Dump contents of an Object File -----------------===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This is a tool similar to readelf, except it works on multiple object file
11 // formats. The main purpose of this tool is to provide detailed output suitable
12 // for FileCheck.
13 //
14 // Flags should be similar to readelf where supported, but the output format
15 // does not need to be identical. The point is to not make users learn yet
16 // another set of flags.
17 //
18 // Output should be specialized for each format where appropriate.
19 //
20 //===----------------------------------------------------------------------===//
21
22 #include "llvm-readobj.h"
23 #include "Error.h"
24 #include "ObjDumper.h"
25 #include "StreamWriter.h"
26 #include "llvm/Object/Archive.h"
27 #include "llvm/Object/COFFImportFile.h"
28 #include "llvm/Object/ELFObjectFile.h"
29 #include "llvm/Object/MachOUniversal.h"
30 #include "llvm/Object/ObjectFile.h"
31 #include "llvm/Support/Casting.h"
32 #include "llvm/Support/CommandLine.h"
33 #include "llvm/Support/DataTypes.h"
34 #include "llvm/Support/Debug.h"
35 #include "llvm/Support/FileSystem.h"
36 #include "llvm/Support/ManagedStatic.h"
37 #include "llvm/Support/PrettyStackTrace.h"
38 #include "llvm/Support/Signals.h"
39 #include "llvm/Support/TargetRegistry.h"
40 #include "llvm/Support/TargetSelect.h"
41 #include <string>
42 #include <system_error>
43
44 using namespace llvm;
45 using namespace llvm::object;
46
47 namespace opts {
48 cl::list<std::string> InputFilenames(cl::Positional,
49 cl::desc("<input object files>"),
50 cl::ZeroOrMore);
51
52 // -file-headers, -h
53 cl::opt<bool> FileHeaders("file-headers",
54 cl::desc("Display file headers "));
55 cl::alias FileHeadersShort("h",
56 cl::desc("Alias for --file-headers"),
57 cl::aliasopt(FileHeaders));
58
59 // -sections, -s
60 cl::opt<bool> Sections("sections",
61 cl::desc("Display all sections."));
62 cl::alias SectionsShort("s",
63 cl::desc("Alias for --sections"),
64 cl::aliasopt(Sections));
65
66 // -section-relocations, -sr
67 cl::opt<bool> SectionRelocations("section-relocations",
68 cl::desc("Display relocations for each section shown."));
69 cl::alias SectionRelocationsShort("sr",
70 cl::desc("Alias for --section-relocations"),
71 cl::aliasopt(SectionRelocations));
72
73 // -section-symbols, -st
74 cl::opt<bool> SectionSymbols("section-symbols",
75 cl::desc("Display symbols for each section shown."));
76 cl::alias SectionSymbolsShort("st",
77 cl::desc("Alias for --section-symbols"),
78 cl::aliasopt(SectionSymbols));
79
80 // -section-data, -sd
81 cl::opt<bool> SectionData("section-data",
82 cl::desc("Display section data for each section shown."));
83 cl::alias SectionDataShort("sd",
84 cl::desc("Alias for --section-data"),
85 cl::aliasopt(SectionData));
86
87 // -relocations, -r
88 cl::opt<bool> Relocations("relocations",
89 cl::desc("Display the relocation entries in the file"));
90 cl::alias RelocationsShort("r",
91 cl::desc("Alias for --relocations"),
92 cl::aliasopt(Relocations));
93
94 // -dyn-relocations
95 cl::opt<bool> DynRelocs("dyn-relocations",
96 cl::desc("Display the dynamic relocation entries in the file"));
97
98 // -symbols, -t
99 cl::opt<bool> Symbols("symbols",
100 cl::desc("Display the symbol table"));
101 cl::alias SymbolsShort("t",
102 cl::desc("Alias for --symbols"),
103 cl::aliasopt(Symbols));
104
105 // -dyn-symbols, -dt
106 cl::opt<bool> DynamicSymbols("dyn-symbols",
107 cl::desc("Display the dynamic symbol table"));
108 cl::alias DynamicSymbolsShort("dt",
109 cl::desc("Alias for --dyn-symbols"),
110 cl::aliasopt(DynamicSymbols));
111
112 // -unwind, -u
113 cl::opt<bool> UnwindInfo("unwind",
114 cl::desc("Display unwind information"));
115 cl::alias UnwindInfoShort("u",
116 cl::desc("Alias for --unwind"),
117 cl::aliasopt(UnwindInfo));
118
119 // -dynamic-table
120 cl::opt<bool> DynamicTable("dynamic-table",
121 cl::desc("Display the ELF .dynamic section table"));
122
123 // -needed-libs
124 cl::opt<bool> NeededLibraries("needed-libs",
125 cl::desc("Display the needed libraries"));
126
127 // -program-headers
128 cl::opt<bool> ProgramHeaders("program-headers",
129 cl::desc("Display ELF program headers"));
130
131 // -hash-table
132 cl::opt<bool> HashTable("hash-table",
133 cl::desc("Display ELF hash table"));
134
135 // -gnu-hash-table
136 cl::opt<bool> GnuHashTable("gnu-hash-table",
137 cl::desc("Display ELF .gnu.hash section"));
138
139 // -expand-relocs
140 cl::opt<bool> ExpandRelocs("expand-relocs",
141 cl::desc("Expand each shown relocation to multiple lines"));
142
143 // -codeview
144 cl::opt<bool> CodeView("codeview",
145 cl::desc("Display CodeView debug information"));
146
147 // -codeview-subsection-bytes
148 cl::opt<bool> CodeViewSubsectionBytes(
149 "codeview-subsection-bytes",
150 cl::desc("Dump raw contents of codeview debug sections and records"));
151
152 // -arm-attributes, -a
153 cl::opt<bool> ARMAttributes("arm-attributes",
154 cl::desc("Display the ARM attributes section"));
155 cl::alias ARMAttributesShort("-a", cl::desc("Alias for --arm-attributes"),
156 cl::aliasopt(ARMAttributes));
157
158 // -mips-plt-got
159 cl::opt<bool>
160 MipsPLTGOT("mips-plt-got",
161 cl::desc("Display the MIPS GOT and PLT GOT sections"));
162
163 // -mips-abi-flags
164 cl::opt<bool> MipsABIFlags("mips-abi-flags",
165 cl::desc("Display the MIPS.abiflags section"));
166
167 // -mips-reginfo
168 cl::opt<bool> MipsReginfo("mips-reginfo",
169 cl::desc("Display the MIPS .reginfo section"));
170
171 // -coff-imports
172 cl::opt<bool>
173 COFFImports("coff-imports", cl::desc("Display the PE/COFF import table"));
174
175 // -coff-exports
176 cl::opt<bool>
177 COFFExports("coff-exports", cl::desc("Display the PE/COFF export table"));
178
179 // -coff-directives
180 cl::opt<bool>
181 COFFDirectives("coff-directives",
182 cl::desc("Display the PE/COFF .drectve section"));
183
184 // -coff-basereloc
185 cl::opt<bool>
186 COFFBaseRelocs("coff-basereloc",
187 cl::desc("Display the PE/COFF .reloc section"));
188
189 // -macho-data-in-code
190 cl::opt<bool>
191 MachODataInCode("macho-data-in-code",
192 cl::desc("Display MachO Data in Code command"));
193
194 // -macho-indirect-symbols
195 cl::opt<bool>
196 MachOIndirectSymbols("macho-indirect-symbols",
197 cl::desc("Display MachO indirect symbols"));
198
199 // -macho-linker-options
200 cl::opt<bool>
201 MachOLinkerOptions("macho-linker-options",
202 cl::desc("Display MachO linker options"));
203
204 // -macho-segment
205 cl::opt<bool>
206 MachOSegment("macho-segment",
207 cl::desc("Display MachO Segment command"));
208
209 // -macho-version-min
210 cl::opt<bool>
211 MachOVersionMin("macho-version-min",
212 cl::desc("Display MachO version min command"));
213
214 // -macho-dysymtab
215 cl::opt<bool>
216 MachODysymtab("macho-dysymtab",
217 cl::desc("Display MachO Dysymtab command"));
218
219 // -stackmap
220 cl::opt<bool>
221 PrintStackMap("stackmap",
222 cl::desc("Display contents of stackmap section"));
223
224 // -version-info
225 cl::opt<bool>
226 VersionInfo("version-info",
227 cl::desc("Display ELF version sections (if present)"));
228 cl::alias VersionInfoShort("V", cl::desc("Alias for -version-info"),
229 cl::aliasopt(VersionInfo));
230 } // namespace opts
231
232 namespace llvm {
233
reportError(Twine Msg)234 LLVM_ATTRIBUTE_NORETURN void reportError(Twine Msg) {
235 outs() << "\nError reading file: " << Msg << ".\n";
236 outs().flush();
237 exit(1);
238 }
239
error(std::error_code EC)240 void error(std::error_code EC) {
241 if (!EC)
242 return;
243
244 reportError(EC.message());
245 }
246
relocAddressLess(RelocationRef a,RelocationRef b)247 bool relocAddressLess(RelocationRef a, RelocationRef b) {
248 return a.getOffset() < b.getOffset();
249 }
250
251 } // namespace llvm
252
reportError(StringRef Input,std::error_code EC)253 static void reportError(StringRef Input, std::error_code EC) {
254 if (Input == "-")
255 Input = "<stdin>";
256
257 reportError(Twine(Input) + ": " + EC.message());
258 }
259
reportError(StringRef Input,StringRef Message)260 static void reportError(StringRef Input, StringRef Message) {
261 if (Input == "-")
262 Input = "<stdin>";
263
264 reportError(Twine(Input) + ": " + Message);
265 }
266
isMipsArch(unsigned Arch)267 static bool isMipsArch(unsigned Arch) {
268 switch (Arch) {
269 case llvm::Triple::mips:
270 case llvm::Triple::mipsel:
271 case llvm::Triple::mips64:
272 case llvm::Triple::mips64el:
273 return true;
274 default:
275 return false;
276 }
277 }
278
279 /// @brief Creates an format-specific object file dumper.
createDumper(const ObjectFile * Obj,StreamWriter & Writer,std::unique_ptr<ObjDumper> & Result)280 static std::error_code createDumper(const ObjectFile *Obj, StreamWriter &Writer,
281 std::unique_ptr<ObjDumper> &Result) {
282 if (!Obj)
283 return readobj_error::unsupported_file_format;
284
285 if (Obj->isCOFF())
286 return createCOFFDumper(Obj, Writer, Result);
287 if (Obj->isELF())
288 return createELFDumper(Obj, Writer, Result);
289 if (Obj->isMachO())
290 return createMachODumper(Obj, Writer, Result);
291
292 return readobj_error::unsupported_obj_file_format;
293 }
294
295 /// @brief Dumps the specified object file.
dumpObject(const ObjectFile * Obj)296 static void dumpObject(const ObjectFile *Obj) {
297 StreamWriter Writer(outs());
298 std::unique_ptr<ObjDumper> Dumper;
299 if (std::error_code EC = createDumper(Obj, Writer, Dumper))
300 reportError(Obj->getFileName(), EC);
301
302 outs() << '\n';
303 outs() << "File: " << Obj->getFileName() << "\n";
304 outs() << "Format: " << Obj->getFileFormatName() << "\n";
305 outs() << "Arch: "
306 << Triple::getArchTypeName((llvm::Triple::ArchType)Obj->getArch())
307 << "\n";
308 outs() << "AddressSize: " << (8*Obj->getBytesInAddress()) << "bit\n";
309 Dumper->printLoadName();
310
311 if (opts::FileHeaders)
312 Dumper->printFileHeaders();
313 if (opts::Sections)
314 Dumper->printSections();
315 if (opts::Relocations)
316 Dumper->printRelocations();
317 if (opts::DynRelocs)
318 Dumper->printDynamicRelocations();
319 if (opts::Symbols)
320 Dumper->printSymbols();
321 if (opts::DynamicSymbols)
322 Dumper->printDynamicSymbols();
323 if (opts::UnwindInfo)
324 Dumper->printUnwindInfo();
325 if (opts::DynamicTable)
326 Dumper->printDynamicTable();
327 if (opts::NeededLibraries)
328 Dumper->printNeededLibraries();
329 if (opts::ProgramHeaders)
330 Dumper->printProgramHeaders();
331 if (opts::HashTable)
332 Dumper->printHashTable();
333 if (opts::GnuHashTable)
334 Dumper->printGnuHashTable();
335 if (opts::VersionInfo)
336 Dumper->printVersionInfo();
337 if (Obj->getArch() == llvm::Triple::arm && Obj->isELF())
338 if (opts::ARMAttributes)
339 Dumper->printAttributes();
340 if (isMipsArch(Obj->getArch()) && Obj->isELF()) {
341 if (opts::MipsPLTGOT)
342 Dumper->printMipsPLTGOT();
343 if (opts::MipsABIFlags)
344 Dumper->printMipsABIFlags();
345 if (opts::MipsReginfo)
346 Dumper->printMipsReginfo();
347 }
348 if (Obj->isCOFF()) {
349 if (opts::COFFImports)
350 Dumper->printCOFFImports();
351 if (opts::COFFExports)
352 Dumper->printCOFFExports();
353 if (opts::COFFDirectives)
354 Dumper->printCOFFDirectives();
355 if (opts::COFFBaseRelocs)
356 Dumper->printCOFFBaseReloc();
357 if (opts::CodeView)
358 Dumper->printCodeViewDebugInfo();
359 }
360 if (Obj->isMachO()) {
361 if (opts::MachODataInCode)
362 Dumper->printMachODataInCode();
363 if (opts::MachOIndirectSymbols)
364 Dumper->printMachOIndirectSymbols();
365 if (opts::MachOLinkerOptions)
366 Dumper->printMachOLinkerOptions();
367 if (opts::MachOSegment)
368 Dumper->printMachOSegment();
369 if (opts::MachOVersionMin)
370 Dumper->printMachOVersionMin();
371 if (opts::MachODysymtab)
372 Dumper->printMachODysymtab();
373 }
374 if (opts::PrintStackMap)
375 Dumper->printStackMap();
376 }
377
378 /// @brief Dumps each object file in \a Arc;
dumpArchive(const Archive * Arc)379 static void dumpArchive(const Archive *Arc) {
380 for (auto &ErrorOrChild : Arc->children()) {
381 if (std::error_code EC = ErrorOrChild.getError())
382 reportError(Arc->getFileName(), EC.message());
383 const auto &Child = *ErrorOrChild;
384 ErrorOr<std::unique_ptr<Binary>> ChildOrErr = Child.getAsBinary();
385 if (std::error_code EC = ChildOrErr.getError()) {
386 // Ignore non-object files.
387 if (EC != object_error::invalid_file_type)
388 reportError(Arc->getFileName(), EC.message());
389 continue;
390 }
391
392 if (ObjectFile *Obj = dyn_cast<ObjectFile>(&*ChildOrErr.get()))
393 dumpObject(Obj);
394 else
395 reportError(Arc->getFileName(), readobj_error::unrecognized_file_format);
396 }
397 }
398
399 /// @brief Dumps each object file in \a MachO Universal Binary;
dumpMachOUniversalBinary(const MachOUniversalBinary * UBinary)400 static void dumpMachOUniversalBinary(const MachOUniversalBinary *UBinary) {
401 for (const MachOUniversalBinary::ObjectForArch &Obj : UBinary->objects()) {
402 ErrorOr<std::unique_ptr<MachOObjectFile>> ObjOrErr = Obj.getAsObjectFile();
403 if (ObjOrErr)
404 dumpObject(&*ObjOrErr.get());
405 else if (ErrorOr<std::unique_ptr<Archive>> AOrErr = Obj.getAsArchive())
406 dumpArchive(&*AOrErr.get());
407 else
408 reportError(UBinary->getFileName(), ObjOrErr.getError().message());
409 }
410 }
411
412 /// @brief Opens \a File and dumps it.
dumpInput(StringRef File)413 static void dumpInput(StringRef File) {
414
415 // Attempt to open the binary.
416 ErrorOr<OwningBinary<Binary>> BinaryOrErr = createBinary(File);
417 if (std::error_code EC = BinaryOrErr.getError())
418 reportError(File, EC);
419 Binary &Binary = *BinaryOrErr.get().getBinary();
420
421 if (Archive *Arc = dyn_cast<Archive>(&Binary))
422 dumpArchive(Arc);
423 else if (MachOUniversalBinary *UBinary =
424 dyn_cast<MachOUniversalBinary>(&Binary))
425 dumpMachOUniversalBinary(UBinary);
426 else if (ObjectFile *Obj = dyn_cast<ObjectFile>(&Binary))
427 dumpObject(Obj);
428 else if (COFFImportFile *Import = dyn_cast<COFFImportFile>(&Binary))
429 dumpCOFFImportFile(Import);
430 else
431 reportError(File, readobj_error::unrecognized_file_format);
432 }
433
main(int argc,const char * argv[])434 int main(int argc, const char *argv[]) {
435 sys::PrintStackTraceOnErrorSignal();
436 PrettyStackTraceProgram X(argc, argv);
437 llvm_shutdown_obj Y;
438
439 // Register the target printer for --version.
440 cl::AddExtraVersionPrinter(TargetRegistry::printRegisteredTargetsForVersion);
441
442 cl::ParseCommandLineOptions(argc, argv, "LLVM Object Reader\n");
443
444 // Default to stdin if no filename is specified.
445 if (opts::InputFilenames.size() == 0)
446 opts::InputFilenames.push_back("-");
447
448 std::for_each(opts::InputFilenames.begin(), opts::InputFilenames.end(),
449 dumpInput);
450
451 return 0;
452 }
453