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