xref: /llvm-project/llvm/tools/llvm-readobj/llvm-readobj.cpp (revision 41af43092ccc8030bb49cea324d85eecd5ae68a8) 
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   // -coff-imports
190   cl::opt<bool>
191   COFFImports("coff-imports", cl::desc("Display the PE/COFF import table"));
192 
193   // -coff-exports
194   cl::opt<bool>
195   COFFExports("coff-exports", cl::desc("Display the PE/COFF export table"));
196 
197   // -coff-directives
198   cl::opt<bool>
199   COFFDirectives("coff-directives",
200                  cl::desc("Display the PE/COFF .drectve section"));
201 
202   // -coff-basereloc
203   cl::opt<bool>
204   COFFBaseRelocs("coff-basereloc",
205                  cl::desc("Display the PE/COFF .reloc section"));
206 
207   // -coff-debug-directory
208   cl::opt<bool>
209   COFFDebugDirectory("coff-debug-directory",
210                      cl::desc("Display the PE/COFF debug directory"));
211 
212   // -macho-data-in-code
213   cl::opt<bool>
214   MachODataInCode("macho-data-in-code",
215                   cl::desc("Display MachO Data in Code command"));
216 
217   // -macho-indirect-symbols
218   cl::opt<bool>
219   MachOIndirectSymbols("macho-indirect-symbols",
220                   cl::desc("Display MachO indirect symbols"));
221 
222   // -macho-linker-options
223   cl::opt<bool>
224   MachOLinkerOptions("macho-linker-options",
225                   cl::desc("Display MachO linker options"));
226 
227   // -macho-segment
228   cl::opt<bool>
229   MachOSegment("macho-segment",
230                   cl::desc("Display MachO Segment command"));
231 
232   // -macho-version-min
233   cl::opt<bool>
234   MachOVersionMin("macho-version-min",
235                   cl::desc("Display MachO version min command"));
236 
237   // -macho-dysymtab
238   cl::opt<bool>
239   MachODysymtab("macho-dysymtab",
240                   cl::desc("Display MachO Dysymtab command"));
241 
242   // -stackmap
243   cl::opt<bool>
244   PrintStackMap("stackmap",
245                 cl::desc("Display contents of stackmap section"));
246 
247   // -version-info
248   cl::opt<bool>
249       VersionInfo("version-info",
250                   cl::desc("Display ELF version sections (if present)"));
251   cl::alias VersionInfoShort("V", cl::desc("Alias for -version-info"),
252                              cl::aliasopt(VersionInfo));
253 
254   cl::opt<bool> SectionGroups("elf-section-groups",
255                               cl::desc("Display ELF section group contents"));
256   cl::alias SectionGroupsShort("g", cl::desc("Alias for -elf-sections-groups"),
257                                cl::aliasopt(SectionGroups));
258   cl::opt<bool> HashHistogram(
259       "elf-hash-histogram",
260       cl::desc("Display bucket list histogram for hash sections"));
261   cl::alias HashHistogramShort("I", cl::desc("Alias for -elf-hash-histogram"),
262                                cl::aliasopt(HashHistogram));
263 
264   cl::opt<OutputStyleTy>
265       Output("elf-output-style", cl::desc("Specify ELF dump style"),
266              cl::values(clEnumVal(LLVM, "LLVM default style"),
267                         clEnumVal(GNU, "GNU readelf style")),
268              cl::init(LLVM));
269 } // namespace opts
270 
271 namespace llvm {
272 
273 LLVM_ATTRIBUTE_NORETURN void reportError(Twine Msg) {
274   errs() << "\nError reading file: " << Msg << ".\n";
275   errs().flush();
276   exit(1);
277 }
278 
279 void error(Error EC) {
280   if (!EC)
281     return;
282   handleAllErrors(std::move(EC),
283                   [&](const ErrorInfoBase &EI) { reportError(EI.message()); });
284 }
285 
286 void error(std::error_code EC) {
287   if (!EC)
288     return;
289   reportError(EC.message());
290 }
291 
292 bool relocAddressLess(RelocationRef a, RelocationRef b) {
293   return a.getOffset() < b.getOffset();
294 }
295 
296 } // namespace llvm
297 
298 static void reportError(StringRef Input, std::error_code EC) {
299   if (Input == "-")
300     Input = "<stdin>";
301 
302   reportError(Twine(Input) + ": " + EC.message());
303 }
304 
305 static void reportError(StringRef Input, StringRef Message) {
306   if (Input == "-")
307     Input = "<stdin>";
308 
309   reportError(Twine(Input) + ": " + Message);
310 }
311 
312 static void reportError(StringRef Input, Error Err) {
313   if (Input == "-")
314     Input = "<stdin>";
315   std::string ErrMsg;
316   {
317     raw_string_ostream ErrStream(ErrMsg);
318     logAllUnhandledErrors(std::move(Err), ErrStream, Input + ": ");
319   }
320   reportError(ErrMsg);
321 }
322 
323 static bool isMipsArch(unsigned Arch) {
324   switch (Arch) {
325   case llvm::Triple::mips:
326   case llvm::Triple::mipsel:
327   case llvm::Triple::mips64:
328   case llvm::Triple::mips64el:
329     return true;
330   default:
331     return false;
332   }
333 }
334 namespace {
335 struct ReadObjTypeTableBuilder {
336   ReadObjTypeTableBuilder() : Allocator(), Builder(Allocator) {}
337 
338   llvm::BumpPtrAllocator Allocator;
339   llvm::codeview::TypeTableBuilder Builder;
340 };
341 }
342 static ReadObjTypeTableBuilder CVTypes;
343 
344 /// @brief Creates an format-specific object file dumper.
345 static std::error_code createDumper(const ObjectFile *Obj,
346                                     ScopedPrinter &Writer,
347                                     std::unique_ptr<ObjDumper> &Result) {
348   if (!Obj)
349     return readobj_error::unsupported_file_format;
350 
351   if (Obj->isCOFF())
352     return createCOFFDumper(Obj, Writer, Result);
353   if (Obj->isELF())
354     return createELFDumper(Obj, Writer, Result);
355   if (Obj->isMachO())
356     return createMachODumper(Obj, Writer, Result);
357 
358   return readobj_error::unsupported_obj_file_format;
359 }
360 
361 /// @brief Dumps the specified object file.
362 static void dumpObject(const ObjectFile *Obj) {
363   ScopedPrinter Writer(outs());
364   std::unique_ptr<ObjDumper> Dumper;
365   if (std::error_code EC = createDumper(Obj, Writer, Dumper))
366     reportError(Obj->getFileName(), EC);
367 
368   if (opts::Output == opts::LLVM) {
369     outs() << '\n';
370     outs() << "File: " << Obj->getFileName() << "\n";
371     outs() << "Format: " << Obj->getFileFormatName() << "\n";
372     outs() << "Arch: " << Triple::getArchTypeName(
373                               (llvm::Triple::ArchType)Obj->getArch()) << "\n";
374     outs() << "AddressSize: " << (8 * Obj->getBytesInAddress()) << "bit\n";
375     Dumper->printLoadName();
376   }
377 
378   if (opts::FileHeaders)
379     Dumper->printFileHeaders();
380   if (opts::Sections)
381     Dumper->printSections();
382   if (opts::Relocations)
383     Dumper->printRelocations();
384   if (opts::DynRelocs)
385     Dumper->printDynamicRelocations();
386   if (opts::Symbols)
387     Dumper->printSymbols();
388   if (opts::DynamicSymbols)
389     Dumper->printDynamicSymbols();
390   if (opts::UnwindInfo)
391     Dumper->printUnwindInfo();
392   if (opts::DynamicTable)
393     Dumper->printDynamicTable();
394   if (opts::NeededLibraries)
395     Dumper->printNeededLibraries();
396   if (opts::ProgramHeaders)
397     Dumper->printProgramHeaders();
398   if (opts::HashTable)
399     Dumper->printHashTable();
400   if (opts::GnuHashTable)
401     Dumper->printGnuHashTable();
402   if (opts::VersionInfo)
403     Dumper->printVersionInfo();
404   if (Obj->isELF()) {
405     if (Obj->getArch() == llvm::Triple::arm)
406       if (opts::ARMAttributes)
407         Dumper->printAttributes();
408     if (isMipsArch(Obj->getArch())) {
409       if (opts::MipsPLTGOT)
410         Dumper->printMipsPLTGOT();
411       if (opts::MipsABIFlags)
412         Dumper->printMipsABIFlags();
413       if (opts::MipsReginfo)
414         Dumper->printMipsReginfo();
415       if (opts::MipsOptions)
416         Dumper->printMipsOptions();
417     }
418     if (opts::SectionGroups)
419       Dumper->printGroupSections();
420     if (opts::HashHistogram)
421       Dumper->printHashHistogram();
422     if (opts::Notes)
423       Dumper->printNotes();
424   }
425   if (Obj->isCOFF()) {
426     if (opts::COFFImports)
427       Dumper->printCOFFImports();
428     if (opts::COFFExports)
429       Dumper->printCOFFExports();
430     if (opts::COFFDirectives)
431       Dumper->printCOFFDirectives();
432     if (opts::COFFBaseRelocs)
433       Dumper->printCOFFBaseReloc();
434     if (opts::COFFDebugDirectory)
435       Dumper->printCOFFDebugDirectory();
436     if (opts::CodeView)
437       Dumper->printCodeViewDebugInfo();
438     if (opts::CodeViewMergedTypes)
439       Dumper->mergeCodeViewTypes(CVTypes.Builder);
440   }
441   if (Obj->isMachO()) {
442     if (opts::MachODataInCode)
443       Dumper->printMachODataInCode();
444     if (opts::MachOIndirectSymbols)
445       Dumper->printMachOIndirectSymbols();
446     if (opts::MachOLinkerOptions)
447       Dumper->printMachOLinkerOptions();
448     if (opts::MachOSegment)
449       Dumper->printMachOSegment();
450     if (opts::MachOVersionMin)
451       Dumper->printMachOVersionMin();
452     if (opts::MachODysymtab)
453       Dumper->printMachODysymtab();
454   }
455   if (opts::PrintStackMap)
456     Dumper->printStackMap();
457 }
458 
459 /// @brief Dumps each object file in \a Arc;
460 static void dumpArchive(const Archive *Arc) {
461   Error Err = Error::success();
462   for (auto &Child : Arc->children(Err)) {
463     Expected<std::unique_ptr<Binary>> ChildOrErr = Child.getAsBinary();
464     if (!ChildOrErr) {
465       if (auto E = isNotObjectErrorInvalidFileType(ChildOrErr.takeError())) {
466         std::string Buf;
467         raw_string_ostream OS(Buf);
468         logAllUnhandledErrors(ChildOrErr.takeError(), OS, "");
469         OS.flush();
470         reportError(Arc->getFileName(), Buf);
471       }
472       continue;
473     }
474     if (ObjectFile *Obj = dyn_cast<ObjectFile>(&*ChildOrErr.get()))
475       dumpObject(Obj);
476     else if (COFFImportFile *Imp = dyn_cast<COFFImportFile>(&*ChildOrErr.get()))
477       dumpCOFFImportFile(Imp);
478     else
479       reportError(Arc->getFileName(), readobj_error::unrecognized_file_format);
480   }
481   if (Err)
482     reportError(Arc->getFileName(), std::move(Err));
483 }
484 
485 /// @brief Dumps each object file in \a MachO Universal Binary;
486 static void dumpMachOUniversalBinary(const MachOUniversalBinary *UBinary) {
487   for (const MachOUniversalBinary::ObjectForArch &Obj : UBinary->objects()) {
488     Expected<std::unique_ptr<MachOObjectFile>> ObjOrErr = Obj.getAsObjectFile();
489     if (ObjOrErr)
490       dumpObject(&*ObjOrErr.get());
491     else if (auto E = isNotObjectErrorInvalidFileType(ObjOrErr.takeError())) {
492       std::string Buf;
493       raw_string_ostream OS(Buf);
494       logAllUnhandledErrors(ObjOrErr.takeError(), OS, "");
495       OS.flush();
496       reportError(UBinary->getFileName(), Buf);
497     }
498     else if (Expected<std::unique_ptr<Archive>> AOrErr = Obj.getAsArchive())
499       dumpArchive(&*AOrErr.get());
500   }
501 }
502 
503 /// @brief Opens \a File and dumps it.
504 static void dumpInput(StringRef File) {
505 
506   // Attempt to open the binary.
507   Expected<OwningBinary<Binary>> BinaryOrErr = createBinary(File);
508   if (!BinaryOrErr)
509     reportError(File, errorToErrorCode(BinaryOrErr.takeError()));
510   Binary &Binary = *BinaryOrErr.get().getBinary();
511 
512   if (Archive *Arc = dyn_cast<Archive>(&Binary))
513     dumpArchive(Arc);
514   else if (MachOUniversalBinary *UBinary =
515                dyn_cast<MachOUniversalBinary>(&Binary))
516     dumpMachOUniversalBinary(UBinary);
517   else if (ObjectFile *Obj = dyn_cast<ObjectFile>(&Binary))
518     dumpObject(Obj);
519   else if (COFFImportFile *Import = dyn_cast<COFFImportFile>(&Binary))
520     dumpCOFFImportFile(Import);
521   else
522     reportError(File, readobj_error::unrecognized_file_format);
523 }
524 
525 int main(int argc, const char *argv[]) {
526   sys::PrintStackTraceOnErrorSignal(argv[0]);
527   PrettyStackTraceProgram X(argc, argv);
528   llvm_shutdown_obj Y;
529 
530   // Register the target printer for --version.
531   cl::AddExtraVersionPrinter(TargetRegistry::printRegisteredTargetsForVersion);
532 
533   cl::ParseCommandLineOptions(argc, argv, "LLVM Object Reader\n");
534 
535   // Default to stdin if no filename is specified.
536   if (opts::InputFilenames.size() == 0)
537     opts::InputFilenames.push_back("-");
538 
539   std::for_each(opts::InputFilenames.begin(), opts::InputFilenames.end(),
540                 dumpInput);
541 
542   if (opts::CodeViewMergedTypes) {
543     ScopedPrinter W(outs());
544     dumpCodeViewMergedTypes(W, CVTypes.Builder);
545   }
546 
547   return 0;
548 }
549