c5bccf979609448d2afc11f4648f69cfd0640056
[oota-llvm.git] / tools / llvm-readobj / llvm-readobj.cpp
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 "StreamWriter.h"
26 #include "llvm/Object/Archive.h"
27 #include "llvm/Object/ELFObjectFile.h"
28 #include "llvm/Object/MachOUniversal.h"
29 #include "llvm/Object/ObjectFile.h"
30 #include "llvm/Support/Casting.h"
31 #include "llvm/Support/CommandLine.h"
32 #include "llvm/Support/DataTypes.h"
33 #include "llvm/Support/Debug.h"
34 #include "llvm/Support/FileSystem.h"
35 #include "llvm/Support/ManagedStatic.h"
36 #include "llvm/Support/PrettyStackTrace.h"
37 #include "llvm/Support/Signals.h"
38 #include "llvm/Support/TargetRegistry.h"
39 #include "llvm/Support/TargetSelect.h"
40 #include <string>
41 #include <system_error>
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   // -file-headers, -h
52   cl::opt<bool> FileHeaders("file-headers",
53     cl::desc("Display file headers "));
54   cl::alias FileHeadersShort("h",
55     cl::desc("Alias for --file-headers"),
56     cl::aliasopt(FileHeaders));
57
58   // -sections, -s
59   cl::opt<bool> Sections("sections",
60     cl::desc("Display all sections."));
61   cl::alias SectionsShort("s",
62     cl::desc("Alias for --sections"),
63     cl::aliasopt(Sections));
64
65   // -section-relocations, -sr
66   cl::opt<bool> SectionRelocations("section-relocations",
67     cl::desc("Display relocations for each section shown."));
68   cl::alias SectionRelocationsShort("sr",
69     cl::desc("Alias for --section-relocations"),
70     cl::aliasopt(SectionRelocations));
71
72   // -section-symbols, -st
73   cl::opt<bool> SectionSymbols("section-symbols",
74     cl::desc("Display symbols for each section shown."));
75   cl::alias SectionSymbolsShort("st",
76     cl::desc("Alias for --section-symbols"),
77     cl::aliasopt(SectionSymbols));
78
79   // -section-data, -sd
80   cl::opt<bool> SectionData("section-data",
81     cl::desc("Display section data for each section shown."));
82   cl::alias SectionDataShort("sd",
83     cl::desc("Alias for --section-data"),
84     cl::aliasopt(SectionData));
85
86   // -relocations, -r
87   cl::opt<bool> Relocations("relocations",
88     cl::desc("Display the relocation entries in the file"));
89   cl::alias RelocationsShort("r",
90     cl::desc("Alias for --relocations"),
91     cl::aliasopt(Relocations));
92
93   // -dyn-relocations
94   cl::opt<bool> DynRelocs("dyn-relocations",
95     cl::desc("Display the dynamic relocation entries in the file"));
96
97   // -symbols, -t
98   cl::opt<bool> Symbols("symbols",
99     cl::desc("Display the symbol table"));
100   cl::alias SymbolsShort("t",
101     cl::desc("Alias for --symbols"),
102     cl::aliasopt(Symbols));
103
104   // -dyn-symbols, -dt
105   cl::opt<bool> DynamicSymbols("dyn-symbols",
106     cl::desc("Display the dynamic symbol table"));
107   cl::alias DynamicSymbolsShort("dt",
108     cl::desc("Alias for --dyn-symbols"),
109     cl::aliasopt(DynamicSymbols));
110
111   // -unwind, -u
112   cl::opt<bool> UnwindInfo("unwind",
113     cl::desc("Display unwind information"));
114   cl::alias UnwindInfoShort("u",
115     cl::desc("Alias for --unwind"),
116     cl::aliasopt(UnwindInfo));
117
118   // -dynamic-table
119   cl::opt<bool> DynamicTable("dynamic-table",
120     cl::desc("Display the ELF .dynamic section table"));
121
122   // -needed-libs
123   cl::opt<bool> NeededLibraries("needed-libs",
124     cl::desc("Display the needed libraries"));
125
126   // -program-headers
127   cl::opt<bool> ProgramHeaders("program-headers",
128     cl::desc("Display ELF program headers"));
129
130   // -expand-relocs
131   cl::opt<bool> ExpandRelocs("expand-relocs",
132     cl::desc("Expand each shown relocation to multiple lines"));
133
134   // -codeview
135   cl::opt<bool> CodeView("codeview",
136                          cl::desc("Display CodeView debug information"));
137
138   // -codeview-subsection-bytes
139   cl::opt<bool> CodeViewSubsectionBytes(
140       "codeview-subsection-bytes",
141       cl::desc("Dump raw contents of codeview debug sections and records"));
142
143   // -arm-attributes, -a
144   cl::opt<bool> ARMAttributes("arm-attributes",
145                               cl::desc("Display the ARM attributes section"));
146   cl::alias ARMAttributesShort("-a", cl::desc("Alias for --arm-attributes"),
147                                cl::aliasopt(ARMAttributes));
148
149   // -mips-plt-got
150   cl::opt<bool>
151   MipsPLTGOT("mips-plt-got",
152              cl::desc("Display the MIPS GOT and PLT GOT sections"));
153
154   // -mips-abi-flags
155   cl::opt<bool> MipsABIFlags("mips-abi-flags",
156                              cl::desc("Display the MIPS.abiflags section"));
157
158   // -mips-reginfo
159   cl::opt<bool> MipsReginfo("mips-reginfo",
160                             cl::desc("Display the MIPS .reginfo section"));
161
162   // -coff-imports
163   cl::opt<bool>
164   COFFImports("coff-imports", cl::desc("Display the PE/COFF import table"));
165
166   // -coff-exports
167   cl::opt<bool>
168   COFFExports("coff-exports", cl::desc("Display the PE/COFF export table"));
169
170   // -coff-directives
171   cl::opt<bool>
172   COFFDirectives("coff-directives",
173                  cl::desc("Display the PE/COFF .drectve section"));
174
175   // -coff-basereloc
176   cl::opt<bool>
177   COFFBaseRelocs("coff-basereloc",
178                  cl::desc("Display the PE/COFF .reloc section"));
179
180   // -stackmap
181   cl::opt<bool>
182   PrintStackMap("stackmap",
183                 cl::desc("Display contents of stackmap section"));
184
185 } // namespace opts
186
187 static int ReturnValue = EXIT_SUCCESS;
188
189 namespace llvm {
190
191 bool error(std::error_code EC) {
192   if (!EC)
193     return false;
194
195   ReturnValue = EXIT_FAILURE;
196   outs() << "\nError reading file: " << EC.message() << ".\n";
197   outs().flush();
198   return true;
199 }
200
201 bool relocAddressLess(RelocationRef a, RelocationRef b) {
202   uint64_t a_addr = a.getOffset();
203   uint64_t b_addr = b.getOffset();
204   return a_addr < b_addr;
205 }
206
207 } // namespace llvm
208
209 static void reportError(StringRef Input, std::error_code EC) {
210   if (Input == "-")
211     Input = "<stdin>";
212
213   errs() << Input << ": " << EC.message() << "\n";
214   errs().flush();
215   ReturnValue = EXIT_FAILURE;
216 }
217
218 static void reportError(StringRef Input, StringRef Message) {
219   if (Input == "-")
220     Input = "<stdin>";
221
222   errs() << Input << ": " << Message << "\n";
223   ReturnValue = EXIT_FAILURE;
224 }
225
226 static bool isMipsArch(unsigned Arch) {
227   switch (Arch) {
228   case llvm::Triple::mips:
229   case llvm::Triple::mipsel:
230   case llvm::Triple::mips64:
231   case llvm::Triple::mips64el:
232     return true;
233   default:
234     return false;
235   }
236 }
237
238 /// @brief Creates an format-specific object file dumper.
239 static std::error_code createDumper(const ObjectFile *Obj, StreamWriter &Writer,
240                                     std::unique_ptr<ObjDumper> &Result) {
241   if (!Obj)
242     return readobj_error::unsupported_file_format;
243
244   if (Obj->isCOFF())
245     return createCOFFDumper(Obj, Writer, Result);
246   if (Obj->isELF())
247     return createELFDumper(Obj, Writer, Result);
248   if (Obj->isMachO())
249     return createMachODumper(Obj, Writer, Result);
250
251   return readobj_error::unsupported_obj_file_format;
252 }
253
254 static StringRef getLoadName(const ObjectFile *Obj) {
255   if (auto *ELF = dyn_cast<ELF32LEObjectFile>(Obj))
256     return ELF->getLoadName();
257   if (auto *ELF = dyn_cast<ELF64LEObjectFile>(Obj))
258     return ELF->getLoadName();
259   if (auto *ELF = dyn_cast<ELF32BEObjectFile>(Obj))
260     return ELF->getLoadName();
261   if (auto *ELF = dyn_cast<ELF64BEObjectFile>(Obj))
262     return ELF->getLoadName();
263   llvm_unreachable("Not ELF");
264 }
265
266 /// @brief Dumps the specified object file.
267 static void dumpObject(const ObjectFile *Obj) {
268   StreamWriter Writer(outs());
269   std::unique_ptr<ObjDumper> Dumper;
270   if (std::error_code EC = createDumper(Obj, Writer, Dumper)) {
271     reportError(Obj->getFileName(), EC);
272     return;
273   }
274
275   outs() << '\n';
276   outs() << "File: " << Obj->getFileName() << "\n";
277   outs() << "Format: " << Obj->getFileFormatName() << "\n";
278   outs() << "Arch: "
279          << Triple::getArchTypeName((llvm::Triple::ArchType)Obj->getArch())
280          << "\n";
281   outs() << "AddressSize: " << (8*Obj->getBytesInAddress()) << "bit\n";
282   if (Obj->isELF())
283     outs() << "LoadName: " << getLoadName(Obj) << "\n";
284
285   if (opts::FileHeaders)
286     Dumper->printFileHeaders();
287   if (opts::Sections)
288     Dumper->printSections();
289   if (opts::Relocations)
290     Dumper->printRelocations();
291   if (opts::DynRelocs)
292     Dumper->printDynamicRelocations();
293   if (opts::Symbols)
294     Dumper->printSymbols();
295   if (opts::DynamicSymbols)
296     Dumper->printDynamicSymbols();
297   if (opts::UnwindInfo)
298     Dumper->printUnwindInfo();
299   if (opts::DynamicTable)
300     Dumper->printDynamicTable();
301   if (opts::NeededLibraries)
302     Dumper->printNeededLibraries();
303   if (opts::ProgramHeaders)
304     Dumper->printProgramHeaders();
305   if (Obj->getArch() == llvm::Triple::arm && Obj->isELF())
306     if (opts::ARMAttributes)
307       Dumper->printAttributes();
308   if (isMipsArch(Obj->getArch()) && Obj->isELF()) {
309     if (opts::MipsPLTGOT)
310       Dumper->printMipsPLTGOT();
311     if (opts::MipsABIFlags)
312       Dumper->printMipsABIFlags();
313     if (opts::MipsReginfo)
314       Dumper->printMipsReginfo();
315   }
316   if (opts::COFFImports)
317     Dumper->printCOFFImports();
318   if (opts::COFFExports)
319     Dumper->printCOFFExports();
320   if (opts::COFFDirectives)
321     Dumper->printCOFFDirectives();
322   if (opts::COFFBaseRelocs)
323     Dumper->printCOFFBaseReloc();
324
325   if (opts::PrintStackMap)
326     Dumper->printStackMap();
327 }
328
329 /// @brief Dumps each object file in \a Arc;
330 static void dumpArchive(const Archive *Arc) {
331   for (Archive::child_iterator ArcI = Arc->child_begin(),
332                                ArcE = Arc->child_end();
333                                ArcI != ArcE; ++ArcI) {
334     ErrorOr<std::unique_ptr<Binary>> ChildOrErr = ArcI->getAsBinary();
335     if (std::error_code EC = ChildOrErr.getError()) {
336       // Ignore non-object files.
337       if (EC != object_error::invalid_file_type)
338         reportError(Arc->getFileName(), EC.message());
339       continue;
340     }
341
342     if (ObjectFile *Obj = dyn_cast<ObjectFile>(&*ChildOrErr.get()))
343       dumpObject(Obj);
344     else
345       reportError(Arc->getFileName(), readobj_error::unrecognized_file_format);
346   }
347 }
348
349 /// @brief Dumps each object file in \a MachO Universal Binary;
350 static void dumpMachOUniversalBinary(const MachOUniversalBinary *UBinary) {
351   for (const MachOUniversalBinary::ObjectForArch &Obj : UBinary->objects()) {
352     ErrorOr<std::unique_ptr<MachOObjectFile>> ObjOrErr = Obj.getAsObjectFile();
353     if (ObjOrErr)
354       dumpObject(&*ObjOrErr.get());
355     else if (ErrorOr<std::unique_ptr<Archive>> AOrErr = Obj.getAsArchive())
356       dumpArchive(&*AOrErr.get());
357     else
358       reportError(UBinary->getFileName(), ObjOrErr.getError().message());
359   }
360 }
361
362 /// @brief Opens \a File and dumps it.
363 static void dumpInput(StringRef File) {
364   // If file isn't stdin, check that it exists.
365   if (File != "-" && !sys::fs::exists(File)) {
366     reportError(File, readobj_error::file_not_found);
367     return;
368   }
369
370   // Attempt to open the binary.
371   ErrorOr<OwningBinary<Binary>> BinaryOrErr = createBinary(File);
372   if (std::error_code EC = BinaryOrErr.getError()) {
373     reportError(File, EC);
374     return;
375   }
376   Binary &Binary = *BinaryOrErr.get().getBinary();
377
378   if (Archive *Arc = dyn_cast<Archive>(&Binary))
379     dumpArchive(Arc);
380   else if (MachOUniversalBinary *UBinary =
381                dyn_cast<MachOUniversalBinary>(&Binary))
382     dumpMachOUniversalBinary(UBinary);
383   else if (ObjectFile *Obj = dyn_cast<ObjectFile>(&Binary))
384     dumpObject(Obj);
385   else
386     reportError(File, readobj_error::unrecognized_file_format);
387 }
388
389 int main(int argc, const char *argv[]) {
390   sys::PrintStackTraceOnErrorSignal();
391   PrettyStackTraceProgram X(argc, argv);
392   llvm_shutdown_obj Y;
393
394   // Register the target printer for --version.
395   cl::AddExtraVersionPrinter(TargetRegistry::printRegisteredTargetsForVersion);
396
397   cl::ParseCommandLineOptions(argc, argv, "LLVM Object Reader\n");
398
399   // Default to stdin if no filename is specified.
400   if (opts::InputFilenames.size() == 0)
401     opts::InputFilenames.push_back("-");
402
403   std::for_each(opts::InputFilenames.begin(), opts::InputFilenames.end(),
404                 dumpInput);
405
406   return ReturnValue;
407 }