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