xref: /llvm-project/llvm/tools/llvm-readobj/llvm-readobj.cpp (revision b98f504850123e345d0470cb0bfec67eb6e7a679) 
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 "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"
42 
43 using namespace llvm;
44 using namespace llvm::object;
45 
46 namespace opts {
47   cl::list<std::string> InputFilenames(cl::Positional,
48     cl::desc("<input object files>"),
49     cl::ZeroOrMore);
50 
51   // -wide, -W
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));
57 
58   // -file-headers, -h
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));
64 
65   // -sections, -s, -S
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));
75 
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));
82 
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));
89 
90   // -section-data, -sd
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));
96 
97   // -relocations, -r
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));
103 
104   // -notes, -n
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));
107 
108   // -dyn-relocations
109   cl::opt<bool> DynRelocs("dyn-relocations",
110     cl::desc("Display the dynamic relocation entries in the file"));
111 
112   // -symbols, -t
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));
118 
119   // -dyn-symbols, -dt
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));
125 
126   // -unwind, -u
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));
132 
133   // -dynamic-table
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));
138 
139   // -needed-libs
140   cl::opt<bool> NeededLibraries("needed-libs",
141     cl::desc("Display the needed libraries"));
142 
143   // -program-headers
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));
148 
149   // -string-dump
150   cl::list<std::string> StringDump("string-dump", cl::desc("<number|name>"),
151                                    cl::ZeroOrMore);
152   cl::alias StringDumpShort("p", cl::desc("Alias for --string-dump"),
153                             cl::aliasopt(StringDump));
154 
155   // -hex-dump
156   cl::list<std::string> HexDump("hex-dump", cl::desc("<number|name>"),
157                                 cl::ZeroOrMore);
158   cl::alias HexDumpShort("x", cl::desc("Alias for --hex-dump"),
159                          cl::aliasopt(HexDump));
160 
161   // -hash-table
162   cl::opt<bool> HashTable("hash-table",
163     cl::desc("Display ELF hash table"));
164 
165   // -gnu-hash-table
166   cl::opt<bool> GnuHashTable("gnu-hash-table",
167     cl::desc("Display ELF .gnu.hash section"));
168 
169   // -expand-relocs
170   cl::opt<bool> ExpandRelocs("expand-relocs",
171     cl::desc("Expand each shown relocation to multiple lines"));
172 
173   // -raw-relr
174   cl::opt<bool> RawRelr("raw-relr",
175     cl::desc("Do not decode relocations in SHT_RELR section, display raw contents"));
176 
177   // -codeview
178   cl::opt<bool> CodeView("codeview",
179                          cl::desc("Display CodeView debug information"));
180 
181   // -codeview-merged-types
182   cl::opt<bool>
183       CodeViewMergedTypes("codeview-merged-types",
184                           cl::desc("Display the merged CodeView type stream"));
185 
186   // -codeview-subsection-bytes
187   cl::opt<bool> CodeViewSubsectionBytes(
188       "codeview-subsection-bytes",
189       cl::desc("Dump raw contents of codeview debug sections and records"));
190 
191   // -arm-attributes, -a
192   cl::opt<bool> ARMAttributes("arm-attributes",
193                               cl::desc("Display the ARM attributes section"));
194   cl::alias ARMAttributesShort("a", cl::desc("Alias for --arm-attributes"),
195                                cl::aliasopt(ARMAttributes));
196 
197   // -mips-plt-got
198   cl::opt<bool>
199   MipsPLTGOT("mips-plt-got",
200              cl::desc("Display the MIPS GOT and PLT GOT sections"));
201 
202   // -mips-abi-flags
203   cl::opt<bool> MipsABIFlags("mips-abi-flags",
204                              cl::desc("Display the MIPS.abiflags section"));
205 
206   // -mips-reginfo
207   cl::opt<bool> MipsReginfo("mips-reginfo",
208                             cl::desc("Display the MIPS .reginfo section"));
209 
210   // -mips-options
211   cl::opt<bool> MipsOptions("mips-options",
212                             cl::desc("Display the MIPS .MIPS.options section"));
213 
214   // -coff-imports
215   cl::opt<bool>
216   COFFImports("coff-imports", cl::desc("Display the PE/COFF import table"));
217 
218   // -coff-exports
219   cl::opt<bool>
220   COFFExports("coff-exports", cl::desc("Display the PE/COFF export table"));
221 
222   // -coff-directives
223   cl::opt<bool>
224   COFFDirectives("coff-directives",
225                  cl::desc("Display the PE/COFF .drectve section"));
226 
227   // -coff-basereloc
228   cl::opt<bool>
229   COFFBaseRelocs("coff-basereloc",
230                  cl::desc("Display the PE/COFF .reloc section"));
231 
232   // -coff-debug-directory
233   cl::opt<bool>
234   COFFDebugDirectory("coff-debug-directory",
235                      cl::desc("Display the PE/COFF debug directory"));
236 
237   // -coff-resources
238   cl::opt<bool> COFFResources("coff-resources",
239                               cl::desc("Display the PE/COFF .rsrc section"));
240 
241   // -coff-load-config
242   cl::opt<bool>
243   COFFLoadConfig("coff-load-config",
244                  cl::desc("Display the PE/COFF load config"));
245 
246   // -elf-linker-options
247   cl::opt<bool>
248   ELFLinkerOptions("elf-linker-options",
249                    cl::desc("Display the ELF .linker-options section"));
250 
251   // -macho-data-in-code
252   cl::opt<bool>
253   MachODataInCode("macho-data-in-code",
254                   cl::desc("Display MachO Data in Code command"));
255 
256   // -macho-indirect-symbols
257   cl::opt<bool>
258   MachOIndirectSymbols("macho-indirect-symbols",
259                   cl::desc("Display MachO indirect symbols"));
260 
261   // -macho-linker-options
262   cl::opt<bool>
263   MachOLinkerOptions("macho-linker-options",
264                   cl::desc("Display MachO linker options"));
265 
266   // -macho-segment
267   cl::opt<bool>
268   MachOSegment("macho-segment",
269                   cl::desc("Display MachO Segment command"));
270 
271   // -macho-version-min
272   cl::opt<bool>
273   MachOVersionMin("macho-version-min",
274                   cl::desc("Display MachO version min command"));
275 
276   // -macho-dysymtab
277   cl::opt<bool>
278   MachODysymtab("macho-dysymtab",
279                   cl::desc("Display MachO Dysymtab command"));
280 
281   // -stackmap
282   cl::opt<bool>
283   PrintStackMap("stackmap",
284                 cl::desc("Display contents of stackmap section"));
285 
286   // -version-info
287   cl::opt<bool>
288       VersionInfo("version-info",
289                   cl::desc("Display ELF version sections (if present)"));
290   cl::alias VersionInfoShort("V", cl::desc("Alias for -version-info"),
291                              cl::aliasopt(VersionInfo));
292 
293   cl::opt<bool> SectionGroups("elf-section-groups",
294                               cl::desc("Display ELF section group contents"));
295   cl::alias SectionGroupsShort("g", cl::desc("Alias for -elf-sections-groups"),
296                                cl::aliasopt(SectionGroups));
297   cl::opt<bool> HashHistogram(
298       "elf-hash-histogram",
299       cl::desc("Display bucket list histogram for hash sections"));
300   cl::alias HashHistogramShort("I", cl::desc("Alias for -elf-hash-histogram"),
301                                cl::aliasopt(HashHistogram));
302 
303   cl::opt<bool> CGProfile("elf-cg-profile", cl::desc("Display callgraph profile section"));
304 
305   cl::opt<OutputStyleTy>
306       Output("elf-output-style", cl::desc("Specify ELF dump style"),
307              cl::values(clEnumVal(LLVM, "LLVM default style"),
308                         clEnumVal(GNU, "GNU readelf style")),
309              cl::init(LLVM));
310 } // namespace opts
311 
312 namespace llvm {
313 
314 LLVM_ATTRIBUTE_NORETURN void reportError(Twine Msg) {
315   errs() << "\nError reading file: " << Msg << ".\n";
316   errs().flush();
317   exit(1);
318 }
319 
320 void error(Error EC) {
321   if (!EC)
322     return;
323   handleAllErrors(std::move(EC),
324                   [&](const ErrorInfoBase &EI) { reportError(EI.message()); });
325 }
326 
327 void error(std::error_code EC) {
328   if (!EC)
329     return;
330   reportError(EC.message());
331 }
332 
333 bool relocAddressLess(RelocationRef a, RelocationRef b) {
334   return a.getOffset() < b.getOffset();
335 }
336 
337 } // namespace llvm
338 
339 static void reportError(StringRef Input, std::error_code EC) {
340   if (Input == "-")
341     Input = "<stdin>";
342 
343   reportError(Twine(Input) + ": " + EC.message());
344 }
345 
346 static void reportError(StringRef Input, Error Err) {
347   if (Input == "-")
348     Input = "<stdin>";
349   std::string ErrMsg;
350   {
351     raw_string_ostream ErrStream(ErrMsg);
352     logAllUnhandledErrors(std::move(Err), ErrStream, Input + ": ");
353   }
354   reportError(ErrMsg);
355 }
356 
357 static bool isMipsArch(unsigned Arch) {
358   switch (Arch) {
359   case llvm::Triple::mips:
360   case llvm::Triple::mipsel:
361   case llvm::Triple::mips64:
362   case llvm::Triple::mips64el:
363     return true;
364   default:
365     return false;
366   }
367 }
368 namespace {
369 struct ReadObjTypeTableBuilder {
370   ReadObjTypeTableBuilder()
371       : Allocator(), IDTable(Allocator), TypeTable(Allocator) {}
372 
373   llvm::BumpPtrAllocator Allocator;
374   llvm::codeview::MergingTypeTableBuilder IDTable;
375   llvm::codeview::MergingTypeTableBuilder TypeTable;
376 };
377 }
378 static ReadObjTypeTableBuilder CVTypes;
379 
380 /// Creates an format-specific object file dumper.
381 static std::error_code createDumper(const ObjectFile *Obj,
382                                     ScopedPrinter &Writer,
383                                     std::unique_ptr<ObjDumper> &Result) {
384   if (!Obj)
385     return readobj_error::unsupported_file_format;
386 
387   if (Obj->isCOFF())
388     return createCOFFDumper(Obj, Writer, Result);
389   if (Obj->isELF())
390     return createELFDumper(Obj, Writer, Result);
391   if (Obj->isMachO())
392     return createMachODumper(Obj, Writer, Result);
393   if (Obj->isWasm())
394     return createWasmDumper(Obj, Writer, Result);
395 
396   return readobj_error::unsupported_obj_file_format;
397 }
398 
399 /// Dumps the specified object file.
400 static void dumpObject(const ObjectFile *Obj, ScopedPrinter &Writer) {
401   std::unique_ptr<ObjDumper> Dumper;
402   if (std::error_code EC = createDumper(Obj, Writer, Dumper))
403     reportError(Obj->getFileName(), EC);
404 
405   if (opts::Output == opts::LLVM) {
406     Writer.startLine() << "\n";
407     Writer.printString("File", Obj->getFileName());
408     Writer.printString("Format", Obj->getFileFormatName());
409     Writer.printString("Arch", Triple::getArchTypeName(
410                                    (llvm::Triple::ArchType)Obj->getArch()));
411     Writer.printString("AddressSize",
412                        formatv("{0}bit", 8 * Obj->getBytesInAddress()));
413     Dumper->printLoadName();
414   }
415 
416   if (opts::FileHeaders)
417     Dumper->printFileHeaders();
418   if (opts::Sections)
419     Dumper->printSections();
420   if (opts::Relocations)
421     Dumper->printRelocations();
422   if (opts::DynRelocs)
423     Dumper->printDynamicRelocations();
424   if (opts::Symbols)
425     Dumper->printSymbols();
426   if (opts::DynamicSymbols)
427     Dumper->printDynamicSymbols();
428   if (opts::UnwindInfo)
429     Dumper->printUnwindInfo();
430   if (opts::DynamicTable)
431     Dumper->printDynamicTable();
432   if (opts::NeededLibraries)
433     Dumper->printNeededLibraries();
434   if (opts::ProgramHeaders)
435     Dumper->printProgramHeaders();
436   if (!opts::StringDump.empty())
437     llvm::for_each(opts::StringDump, [&Dumper](StringRef SectionName) {
438       Dumper->printSectionAsString(SectionName);
439     });
440   if (!opts::HexDump.empty())
441     llvm::for_each(opts::HexDump, [&Dumper](StringRef SectionName) {
442       Dumper->printSectionAsHex(SectionName);
443     });
444   if (opts::HashTable)
445     Dumper->printHashTable();
446   if (opts::GnuHashTable)
447     Dumper->printGnuHashTable();
448   if (opts::VersionInfo)
449     Dumper->printVersionInfo();
450   if (Obj->isELF()) {
451     if (opts::ELFLinkerOptions)
452       Dumper->printELFLinkerOptions();
453     if (Obj->getArch() == llvm::Triple::arm)
454       if (opts::ARMAttributes)
455         Dumper->printAttributes();
456     if (isMipsArch(Obj->getArch())) {
457       if (opts::MipsPLTGOT)
458         Dumper->printMipsPLTGOT();
459       if (opts::MipsABIFlags)
460         Dumper->printMipsABIFlags();
461       if (opts::MipsReginfo)
462         Dumper->printMipsReginfo();
463       if (opts::MipsOptions)
464         Dumper->printMipsOptions();
465     }
466     if (opts::SectionGroups)
467       Dumper->printGroupSections();
468     if (opts::HashHistogram)
469       Dumper->printHashHistogram();
470     if (opts::CGProfile)
471       Dumper->printCGProfile();
472     if (opts::Notes)
473       Dumper->printNotes();
474   }
475   if (Obj->isCOFF()) {
476     if (opts::COFFImports)
477       Dumper->printCOFFImports();
478     if (opts::COFFExports)
479       Dumper->printCOFFExports();
480     if (opts::COFFDirectives)
481       Dumper->printCOFFDirectives();
482     if (opts::COFFBaseRelocs)
483       Dumper->printCOFFBaseReloc();
484     if (opts::COFFDebugDirectory)
485       Dumper->printCOFFDebugDirectory();
486     if (opts::COFFResources)
487       Dumper->printCOFFResources();
488     if (opts::COFFLoadConfig)
489       Dumper->printCOFFLoadConfig();
490     if (opts::CodeView)
491       Dumper->printCodeViewDebugInfo();
492     if (opts::CodeViewMergedTypes)
493       Dumper->mergeCodeViewTypes(CVTypes.IDTable, CVTypes.TypeTable);
494   }
495   if (Obj->isMachO()) {
496     if (opts::MachODataInCode)
497       Dumper->printMachODataInCode();
498     if (opts::MachOIndirectSymbols)
499       Dumper->printMachOIndirectSymbols();
500     if (opts::MachOLinkerOptions)
501       Dumper->printMachOLinkerOptions();
502     if (opts::MachOSegment)
503       Dumper->printMachOSegment();
504     if (opts::MachOVersionMin)
505       Dumper->printMachOVersionMin();
506     if (opts::MachODysymtab)
507       Dumper->printMachODysymtab();
508   }
509   if (opts::PrintStackMap)
510     Dumper->printStackMap();
511 }
512 
513 /// Dumps each object file in \a Arc;
514 static void dumpArchive(const Archive *Arc, ScopedPrinter &Writer) {
515   Error Err = Error::success();
516   for (auto &Child : Arc->children(Err)) {
517     Expected<std::unique_ptr<Binary>> ChildOrErr = Child.getAsBinary();
518     if (!ChildOrErr) {
519       if (auto E = isNotObjectErrorInvalidFileType(ChildOrErr.takeError())) {
520         reportError(Arc->getFileName(), ChildOrErr.takeError());
521       }
522       continue;
523     }
524     if (ObjectFile *Obj = dyn_cast<ObjectFile>(&*ChildOrErr.get()))
525       dumpObject(Obj, Writer);
526     else if (COFFImportFile *Imp = dyn_cast<COFFImportFile>(&*ChildOrErr.get()))
527       dumpCOFFImportFile(Imp, Writer);
528     else
529       reportError(Arc->getFileName(), readobj_error::unrecognized_file_format);
530   }
531   if (Err)
532     reportError(Arc->getFileName(), std::move(Err));
533 }
534 
535 /// Dumps each object file in \a MachO Universal Binary;
536 static void dumpMachOUniversalBinary(const MachOUniversalBinary *UBinary,
537                                      ScopedPrinter &Writer) {
538   for (const MachOUniversalBinary::ObjectForArch &Obj : UBinary->objects()) {
539     Expected<std::unique_ptr<MachOObjectFile>> ObjOrErr = Obj.getAsObjectFile();
540     if (ObjOrErr)
541       dumpObject(&*ObjOrErr.get(), Writer);
542     else if (auto E = isNotObjectErrorInvalidFileType(ObjOrErr.takeError())) {
543       reportError(UBinary->getFileName(), ObjOrErr.takeError());
544     }
545     else if (Expected<std::unique_ptr<Archive>> AOrErr = Obj.getAsArchive())
546       dumpArchive(&*AOrErr.get(), Writer);
547   }
548 }
549 
550 /// Dumps \a WinRes, Windows Resource (.res) file;
551 static void dumpWindowsResourceFile(WindowsResource *WinRes) {
552   ScopedPrinter Printer{outs()};
553   WindowsRes::Dumper Dumper(WinRes, Printer);
554   if (auto Err = Dumper.printData())
555     reportError(WinRes->getFileName(), std::move(Err));
556 }
557 
558 
559 /// Opens \a File and dumps it.
560 static void dumpInput(StringRef File) {
561   ScopedPrinter Writer(outs());
562 
563   // Attempt to open the binary.
564   Expected<OwningBinary<Binary>> BinaryOrErr = createBinary(File);
565   if (!BinaryOrErr)
566     reportError(File, BinaryOrErr.takeError());
567   Binary &Binary = *BinaryOrErr.get().getBinary();
568 
569   if (Archive *Arc = dyn_cast<Archive>(&Binary))
570     dumpArchive(Arc, Writer);
571   else if (MachOUniversalBinary *UBinary =
572                dyn_cast<MachOUniversalBinary>(&Binary))
573     dumpMachOUniversalBinary(UBinary, Writer);
574   else if (ObjectFile *Obj = dyn_cast<ObjectFile>(&Binary))
575     dumpObject(Obj, Writer);
576   else if (COFFImportFile *Import = dyn_cast<COFFImportFile>(&Binary))
577     dumpCOFFImportFile(Import, Writer);
578   else if (WindowsResource *WinRes = dyn_cast<WindowsResource>(&Binary))
579     dumpWindowsResourceFile(WinRes);
580   else
581     reportError(File, readobj_error::unrecognized_file_format);
582 }
583 
584 int main(int argc, const char *argv[]) {
585   InitLLVM X(argc, argv);
586 
587   // Register the target printer for --version.
588   cl::AddExtraVersionPrinter(TargetRegistry::printRegisteredTargetsForVersion);
589 
590   opts::WideOutput.setHiddenFlag(cl::Hidden);
591 
592   if (sys::path::stem(argv[0]).find("readelf") != StringRef::npos)
593     opts::Output = opts::GNU;
594 
595   cl::ParseCommandLineOptions(argc, argv, "LLVM Object Reader\n");
596 
597   // Default to stdin if no filename is specified.
598   if (opts::InputFilenames.size() == 0)
599     opts::InputFilenames.push_back("-");
600 
601   llvm::for_each(opts::InputFilenames, dumpInput);
602 
603   if (opts::CodeViewMergedTypes) {
604     ScopedPrinter W(outs());
605     dumpCodeViewMergedTypes(W, CVTypes.IDTable, CVTypes.TypeTable);
606   }
607 
608   return 0;
609 }
610