1 //===- llvm-readobj.cpp - Dump contents of an Object File -----------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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
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.
18 // Output should be specialized for each format where appropriate.
20 //===----------------------------------------------------------------------===//
22 #include "llvm-readobj.h"
24 #include "ObjDumper.h"
25 #include "WindowsResourceDumper.h"
26 #include "llvm/DebugInfo/CodeView/MergingTypeTableBuilder.h"
27 #include "llvm/Object/Archive.h"
28 #include "llvm/Object/COFFImportFile.h"
29 #include "llvm/Object/MachOUniversal.h"
30 #include "llvm/Object/ObjectFile.h"
31 #include "llvm/Object/WindowsResource.h"
32 #include "llvm/Support/Casting.h"
33 #include "llvm/Support/CommandLine.h"
34 #include "llvm/Support/DataTypes.h"
35 #include "llvm/Support/Debug.h"
36 #include "llvm/Support/FileSystem.h"
37 #include "llvm/Support/FormatVariadic.h"
38 #include "llvm/Support/InitLLVM.h"
39 #include "llvm/Support/Path.h"
40 #include "llvm/Support/ScopedPrinter.h"
41 #include "llvm/Support/TargetRegistry.h"
44 using namespace llvm::object;
47 cl::list<std::string> InputFilenames(cl::Positional,
48 cl::desc("<input object files>"),
52 cl::opt<bool> WideOutput("wide",
53 cl::desc("Ignored for compatibility with GNU readelf"));
54 cl::alias WideOutputShort("W",
55 cl::desc("Alias for --wide"),
56 cl::aliasopt(WideOutput));
59 cl::opt<bool> FileHeaders("file-headers",
60 cl::desc("Display file headers "));
61 cl::alias FileHeadersShort("h",
62 cl::desc("Alias for --file-headers"),
63 cl::aliasopt(FileHeaders));
66 // Note: In GNU readelf, -s means --symbols!
67 cl::opt<bool> Sections("sections",
68 cl::desc("Display all sections."));
69 cl::alias SectionsShort("s",
70 cl::desc("Alias for --sections"),
71 cl::aliasopt(Sections));
72 cl::alias SectionsShortUpper("S",
73 cl::desc("Alias for --sections"),
74 cl::aliasopt(Sections));
76 // -section-relocations, -sr
77 cl::opt<bool> SectionRelocations("section-relocations",
78 cl::desc("Display relocations for each section shown."));
79 cl::alias SectionRelocationsShort("sr",
80 cl::desc("Alias for --section-relocations"),
81 cl::aliasopt(SectionRelocations));
83 // -section-symbols, -st
84 cl::opt<bool> SectionSymbols("section-symbols",
85 cl::desc("Display symbols for each section shown."));
86 cl::alias SectionSymbolsShort("st",
87 cl::desc("Alias for --section-symbols"),
88 cl::aliasopt(SectionSymbols));
91 cl::opt<bool> SectionData("section-data",
92 cl::desc("Display section data for each section shown."));
93 cl::alias SectionDataShort("sd",
94 cl::desc("Alias for --section-data"),
95 cl::aliasopt(SectionData));
98 cl::opt<bool> Relocations("relocations",
99 cl::desc("Display the relocation entries in the file"));
100 cl::alias RelocationsShort("r",
101 cl::desc("Alias for --relocations"),
102 cl::aliasopt(Relocations));
105 cl::opt<bool> Notes("notes", cl::desc("Display the ELF notes in the file"));
106 cl::alias NotesShort("n", cl::desc("Alias for --notes"), cl::aliasopt(Notes));
109 cl::opt<bool> DynRelocs("dyn-relocations",
110 cl::desc("Display the dynamic relocation entries in the file"));
113 cl::opt<bool> Symbols("symbols",
114 cl::desc("Display the symbol table"));
115 cl::alias SymbolsShort("t",
116 cl::desc("Alias for --symbols"),
117 cl::aliasopt(Symbols));
120 cl::opt<bool> DynamicSymbols("dyn-symbols",
121 cl::desc("Display the dynamic symbol table"));
122 cl::alias DynamicSymbolsShort("dt",
123 cl::desc("Alias for --dyn-symbols"),
124 cl::aliasopt(DynamicSymbols));
127 cl::opt<bool> UnwindInfo("unwind",
128 cl::desc("Display unwind information"));
129 cl::alias UnwindInfoShort("u",
130 cl::desc("Alias for --unwind"),
131 cl::aliasopt(UnwindInfo));
134 cl::opt<bool> DynamicTable("dynamic-table",
135 cl::desc("Display the ELF .dynamic section table"));
136 cl::alias DynamicTableShort("d", cl::desc("Alias for --dynamic-table"),
137 cl::aliasopt(DynamicTable));
140 cl::opt<bool> NeededLibraries("needed-libs",
141 cl::desc("Display the needed libraries"));
144 cl::opt<bool> ProgramHeaders("program-headers",
145 cl::desc("Display ELF program headers"));
146 cl::alias ProgramHeadersShort("l", cl::desc("Alias for --program-headers"),
147 cl::aliasopt(ProgramHeaders));
150 cl::opt<bool> HashTable("hash-table",
151 cl::desc("Display ELF hash table"));
154 cl::opt<bool> GnuHashTable("gnu-hash-table",
155 cl::desc("Display ELF .gnu.hash section"));
158 cl::opt<bool> ExpandRelocs("expand-relocs",
159 cl::desc("Expand each shown relocation to multiple lines"));
162 cl::opt<bool> CodeView("codeview",
163 cl::desc("Display CodeView debug information"));
165 // -codeview-merged-types
167 CodeViewMergedTypes("codeview-merged-types",
168 cl::desc("Display the merged CodeView type stream"));
170 // -codeview-subsection-bytes
171 cl::opt<bool> CodeViewSubsectionBytes(
172 "codeview-subsection-bytes",
173 cl::desc("Dump raw contents of codeview debug sections and records"));
175 // -arm-attributes, -a
176 cl::opt<bool> ARMAttributes("arm-attributes",
177 cl::desc("Display the ARM attributes section"));
178 cl::alias ARMAttributesShort("a", cl::desc("Alias for --arm-attributes"),
179 cl::aliasopt(ARMAttributes));
183 MipsPLTGOT("mips-plt-got",
184 cl::desc("Display the MIPS GOT and PLT GOT sections"));
187 cl::opt<bool> MipsABIFlags("mips-abi-flags",
188 cl::desc("Display the MIPS.abiflags section"));
191 cl::opt<bool> MipsReginfo("mips-reginfo",
192 cl::desc("Display the MIPS .reginfo section"));
195 cl::opt<bool> MipsOptions("mips-options",
196 cl::desc("Display the MIPS .MIPS.options section"));
200 COFFImports("coff-imports", cl::desc("Display the PE/COFF import table"));
204 COFFExports("coff-exports", cl::desc("Display the PE/COFF export table"));
208 COFFDirectives("coff-directives",
209 cl::desc("Display the PE/COFF .drectve section"));
213 COFFBaseRelocs("coff-basereloc",
214 cl::desc("Display the PE/COFF .reloc section"));
216 // -coff-debug-directory
218 COFFDebugDirectory("coff-debug-directory",
219 cl::desc("Display the PE/COFF debug directory"));
222 cl::opt<bool> COFFResources("coff-resources",
223 cl::desc("Display the PE/COFF .rsrc section"));
227 COFFLoadConfig("coff-load-config",
228 cl::desc("Display the PE/COFF load config"));
230 // -elf-linker-options
232 ELFLinkerOptions("elf-linker-options",
233 cl::desc("Display the ELF .linker-options section"));
235 // -macho-data-in-code
237 MachODataInCode("macho-data-in-code",
238 cl::desc("Display MachO Data in Code command"));
240 // -macho-indirect-symbols
242 MachOIndirectSymbols("macho-indirect-symbols",
243 cl::desc("Display MachO indirect symbols"));
245 // -macho-linker-options
247 MachOLinkerOptions("macho-linker-options",
248 cl::desc("Display MachO linker options"));
252 MachOSegment("macho-segment",
253 cl::desc("Display MachO Segment command"));
255 // -macho-version-min
257 MachOVersionMin("macho-version-min",
258 cl::desc("Display MachO version min command"));
262 MachODysymtab("macho-dysymtab",
263 cl::desc("Display MachO Dysymtab command"));
267 PrintStackMap("stackmap",
268 cl::desc("Display contents of stackmap section"));
272 VersionInfo("version-info",
273 cl::desc("Display ELF version sections (if present)"));
274 cl::alias VersionInfoShort("V", cl::desc("Alias for -version-info"),
275 cl::aliasopt(VersionInfo));
277 cl::opt<bool> SectionGroups("elf-section-groups",
278 cl::desc("Display ELF section group contents"));
279 cl::alias SectionGroupsShort("g", cl::desc("Alias for -elf-sections-groups"),
280 cl::aliasopt(SectionGroups));
281 cl::opt<bool> HashHistogram(
282 "elf-hash-histogram",
283 cl::desc("Display bucket list histogram for hash sections"));
284 cl::alias HashHistogramShort("I", cl::desc("Alias for -elf-hash-histogram"),
285 cl::aliasopt(HashHistogram));
287 cl::opt<bool> CGProfile("elf-cg-profile", cl::desc("Display callgraph profile section"));
289 cl::opt<OutputStyleTy>
290 Output("elf-output-style", cl::desc("Specify ELF dump style"),
291 cl::values(clEnumVal(LLVM, "LLVM default style"),
292 clEnumVal(GNU, "GNU readelf style")),
298 LLVM_ATTRIBUTE_NORETURN void reportError(Twine Msg) {
299 errs() << "\nError reading file: " << Msg << ".\n";
304 void error(Error EC) {
307 handleAllErrors(std::move(EC),
308 [&](const ErrorInfoBase &EI) { reportError(EI.message()); });
311 void error(std::error_code EC) {
314 reportError(EC.message());
317 bool relocAddressLess(RelocationRef a, RelocationRef b) {
318 return a.getOffset() < b.getOffset();
323 static void reportError(StringRef Input, std::error_code EC) {
327 reportError(Twine(Input) + ": " + EC.message());
330 static void reportError(StringRef Input, Error Err) {
335 raw_string_ostream ErrStream(ErrMsg);
336 logAllUnhandledErrors(std::move(Err), ErrStream, Input + ": ");
341 static bool isMipsArch(unsigned Arch) {
343 case llvm::Triple::mips:
344 case llvm::Triple::mipsel:
345 case llvm::Triple::mips64:
346 case llvm::Triple::mips64el:
353 struct ReadObjTypeTableBuilder {
354 ReadObjTypeTableBuilder()
355 : Allocator(), IDTable(Allocator), TypeTable(Allocator) {}
357 llvm::BumpPtrAllocator Allocator;
358 llvm::codeview::MergingTypeTableBuilder IDTable;
359 llvm::codeview::MergingTypeTableBuilder TypeTable;
362 static ReadObjTypeTableBuilder CVTypes;
364 /// Creates an format-specific object file dumper.
365 static std::error_code createDumper(const ObjectFile *Obj,
366 ScopedPrinter &Writer,
367 std::unique_ptr<ObjDumper> &Result) {
369 return readobj_error::unsupported_file_format;
372 return createCOFFDumper(Obj, Writer, Result);
374 return createELFDumper(Obj, Writer, Result);
376 return createMachODumper(Obj, Writer, Result);
378 return createWasmDumper(Obj, Writer, Result);
380 return readobj_error::unsupported_obj_file_format;
383 /// Dumps the specified object file.
384 static void dumpObject(const ObjectFile *Obj, ScopedPrinter &Writer) {
385 std::unique_ptr<ObjDumper> Dumper;
386 if (std::error_code EC = createDumper(Obj, Writer, Dumper))
387 reportError(Obj->getFileName(), EC);
389 if (opts::Output == opts::LLVM) {
390 Writer.startLine() << "\n";
391 Writer.printString("File", Obj->getFileName());
392 Writer.printString("Format", Obj->getFileFormatName());
393 Writer.printString("Arch", Triple::getArchTypeName(
394 (llvm::Triple::ArchType)Obj->getArch()));
395 Writer.printString("AddressSize",
396 formatv("{0}bit", 8 * Obj->getBytesInAddress()));
397 Dumper->printLoadName();
400 if (opts::FileHeaders)
401 Dumper->printFileHeaders();
403 Dumper->printSections();
404 if (opts::Relocations)
405 Dumper->printRelocations();
407 Dumper->printDynamicRelocations();
409 Dumper->printSymbols();
410 if (opts::DynamicSymbols)
411 Dumper->printDynamicSymbols();
412 if (opts::UnwindInfo)
413 Dumper->printUnwindInfo();
414 if (opts::DynamicTable)
415 Dumper->printDynamicTable();
416 if (opts::NeededLibraries)
417 Dumper->printNeededLibraries();
418 if (opts::ProgramHeaders)
419 Dumper->printProgramHeaders();
421 Dumper->printHashTable();
422 if (opts::GnuHashTable)
423 Dumper->printGnuHashTable();
424 if (opts::VersionInfo)
425 Dumper->printVersionInfo();
427 if (opts::ELFLinkerOptions)
428 Dumper->printELFLinkerOptions();
429 if (Obj->getArch() == llvm::Triple::arm)
430 if (opts::ARMAttributes)
431 Dumper->printAttributes();
432 if (isMipsArch(Obj->getArch())) {
433 if (opts::MipsPLTGOT)
434 Dumper->printMipsPLTGOT();
435 if (opts::MipsABIFlags)
436 Dumper->printMipsABIFlags();
437 if (opts::MipsReginfo)
438 Dumper->printMipsReginfo();
439 if (opts::MipsOptions)
440 Dumper->printMipsOptions();
442 if (opts::SectionGroups)
443 Dumper->printGroupSections();
444 if (opts::HashHistogram)
445 Dumper->printHashHistogram();
447 Dumper->printCGProfile();
449 Dumper->printNotes();
452 if (opts::COFFImports)
453 Dumper->printCOFFImports();
454 if (opts::COFFExports)
455 Dumper->printCOFFExports();
456 if (opts::COFFDirectives)
457 Dumper->printCOFFDirectives();
458 if (opts::COFFBaseRelocs)
459 Dumper->printCOFFBaseReloc();
460 if (opts::COFFDebugDirectory)
461 Dumper->printCOFFDebugDirectory();
462 if (opts::COFFResources)
463 Dumper->printCOFFResources();
464 if (opts::COFFLoadConfig)
465 Dumper->printCOFFLoadConfig();
467 Dumper->printCodeViewDebugInfo();
468 if (opts::CodeViewMergedTypes)
469 Dumper->mergeCodeViewTypes(CVTypes.IDTable, CVTypes.TypeTable);
471 if (Obj->isMachO()) {
472 if (opts::MachODataInCode)
473 Dumper->printMachODataInCode();
474 if (opts::MachOIndirectSymbols)
475 Dumper->printMachOIndirectSymbols();
476 if (opts::MachOLinkerOptions)
477 Dumper->printMachOLinkerOptions();
478 if (opts::MachOSegment)
479 Dumper->printMachOSegment();
480 if (opts::MachOVersionMin)
481 Dumper->printMachOVersionMin();
482 if (opts::MachODysymtab)
483 Dumper->printMachODysymtab();
485 if (opts::PrintStackMap)
486 Dumper->printStackMap();
489 /// Dumps each object file in \a Arc;
490 static void dumpArchive(const Archive *Arc, ScopedPrinter &Writer) {
491 Error Err = Error::success();
492 for (auto &Child : Arc->children(Err)) {
493 Expected<std::unique_ptr<Binary>> ChildOrErr = Child.getAsBinary();
495 if (auto E = isNotObjectErrorInvalidFileType(ChildOrErr.takeError())) {
496 reportError(Arc->getFileName(), ChildOrErr.takeError());
500 if (ObjectFile *Obj = dyn_cast<ObjectFile>(&*ChildOrErr.get()))
501 dumpObject(Obj, Writer);
502 else if (COFFImportFile *Imp = dyn_cast<COFFImportFile>(&*ChildOrErr.get()))
503 dumpCOFFImportFile(Imp, Writer);
505 reportError(Arc->getFileName(), readobj_error::unrecognized_file_format);
508 reportError(Arc->getFileName(), std::move(Err));
511 /// Dumps each object file in \a MachO Universal Binary;
512 static void dumpMachOUniversalBinary(const MachOUniversalBinary *UBinary,
513 ScopedPrinter &Writer) {
514 for (const MachOUniversalBinary::ObjectForArch &Obj : UBinary->objects()) {
515 Expected<std::unique_ptr<MachOObjectFile>> ObjOrErr = Obj.getAsObjectFile();
517 dumpObject(&*ObjOrErr.get(), Writer);
518 else if (auto E = isNotObjectErrorInvalidFileType(ObjOrErr.takeError())) {
519 reportError(UBinary->getFileName(), ObjOrErr.takeError());
521 else if (Expected<std::unique_ptr<Archive>> AOrErr = Obj.getAsArchive())
522 dumpArchive(&*AOrErr.get(), Writer);
526 /// Dumps \a WinRes, Windows Resource (.res) file;
527 static void dumpWindowsResourceFile(WindowsResource *WinRes) {
528 ScopedPrinter Printer{outs()};
529 WindowsRes::Dumper Dumper(WinRes, Printer);
530 if (auto Err = Dumper.printData())
531 reportError(WinRes->getFileName(), std::move(Err));
535 /// Opens \a File and dumps it.
536 static void dumpInput(StringRef File) {
537 ScopedPrinter Writer(outs());
539 // Attempt to open the binary.
540 Expected<OwningBinary<Binary>> BinaryOrErr = createBinary(File);
542 reportError(File, BinaryOrErr.takeError());
543 Binary &Binary = *BinaryOrErr.get().getBinary();
545 if (Archive *Arc = dyn_cast<Archive>(&Binary))
546 dumpArchive(Arc, Writer);
547 else if (MachOUniversalBinary *UBinary =
548 dyn_cast<MachOUniversalBinary>(&Binary))
549 dumpMachOUniversalBinary(UBinary, Writer);
550 else if (ObjectFile *Obj = dyn_cast<ObjectFile>(&Binary))
551 dumpObject(Obj, Writer);
552 else if (COFFImportFile *Import = dyn_cast<COFFImportFile>(&Binary))
553 dumpCOFFImportFile(Import, Writer);
554 else if (WindowsResource *WinRes = dyn_cast<WindowsResource>(&Binary))
555 dumpWindowsResourceFile(WinRes);
557 reportError(File, readobj_error::unrecognized_file_format);
560 int main(int argc, const char *argv[]) {
561 InitLLVM X(argc, argv);
563 // Register the target printer for --version.
564 cl::AddExtraVersionPrinter(TargetRegistry::printRegisteredTargetsForVersion);
566 opts::WideOutput.setHiddenFlag(cl::Hidden);
568 if (sys::path::stem(argv[0]).find("readelf") != StringRef::npos)
569 opts::Output = opts::GNU;
571 cl::ParseCommandLineOptions(argc, argv, "LLVM Object Reader\n");
573 // Default to stdin if no filename is specified.
574 if (opts::InputFilenames.size() == 0)
575 opts::InputFilenames.push_back("-");
577 llvm::for_each(opts::InputFilenames, dumpInput);
579 if (opts::CodeViewMergedTypes) {
580 ScopedPrinter W(outs());
581 dumpCodeViewMergedTypes(W, CVTypes.IDTable, CVTypes.TypeTable);