blob: ffc58450192198c14daa5c795df2a42bd62949e5 [file] [log] [blame]
Benjamin Kramer054f4222013-08-09 10:31:14 +00001//===- llvm-readobj.cpp - Dump contents of an Object File -----------------===//
David Meyer2fc34c52012-03-01 01:36:50 +00002//
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//
Michael J. Spencerd7e70032013-02-05 20:27:22 +000010// 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.
David Meyerae11a782012-03-02 23:43:51 +000013//
Michael J. Spencerd7e70032013-02-05 20:27:22 +000014// 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.
David Meyerae11a782012-03-02 23:43:51 +000017//
Michael J. Spencerd7e70032013-02-05 20:27:22 +000018// Output should be specialized for each format where appropriate.
David Meyerae11a782012-03-02 23:43:51 +000019//
20//===----------------------------------------------------------------------===//
David Meyer2fc34c52012-03-01 01:36:50 +000021
Michael J. Spencer6a8746b2013-02-20 02:37:12 +000022#include "llvm-readobj.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000023#include "Error.h"
24#include "ObjDumper.h"
Marek Sokolowskic2189b82017-09-20 18:33:35 +000025#include "WindowsResourceDumper.h"
Zachary Turnerca6dbf12017-11-30 18:39:50 +000026#include "llvm/DebugInfo/CodeView/MergingTypeTableBuilder.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000027#include "llvm/Object/Archive.h"
Rui Ueyama71ba9bd2015-08-28 07:40:30 +000028#include "llvm/Object/COFFImportFile.h"
Rafael Espindola8448a242015-03-24 20:26:55 +000029#include "llvm/Object/MachOUniversal.h"
Chandler Carruth4d88a1c2012-12-04 10:44:52 +000030#include "llvm/Object/ObjectFile.h"
Marek Sokolowskic2189b82017-09-20 18:33:35 +000031#include "llvm/Object/WindowsResource.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000032#include "llvm/Support/Casting.h"
David Meyer2fc34c52012-03-01 01:36:50 +000033#include "llvm/Support/CommandLine.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000034#include "llvm/Support/DataTypes.h"
David Meyer2fc34c52012-03-01 01:36:50 +000035#include "llvm/Support/Debug.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000036#include "llvm/Support/FileSystem.h"
Sam Clegg88e9a152018-01-10 00:14:19 +000037#include "llvm/Support/FormatVariadic.h"
Rui Ueyama197194b2018-04-13 18:26:06 +000038#include "llvm/Support/InitLLVM.h"
Petr Hosekbf515502017-07-19 02:09:37 +000039#include "llvm/Support/Path.h"
Zachary Turner88bb1632016-05-03 00:28:04 +000040#include "llvm/Support/ScopedPrinter.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000041#include "llvm/Support/TargetRegistry.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000042
David Meyer2fc34c52012-03-01 01:36:50 +000043using namespace llvm;
44using namespace llvm::object;
45
Eric Christopher9cad53c2013-04-03 18:31:38 +000046namespace opts {
47 cl::list<std::string> InputFilenames(cl::Positional,
48 cl::desc("<input object files>"),
49 cl::ZeroOrMore);
David Meyer2fc34c52012-03-01 01:36:50 +000050
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +000051 // -all, -a
52 cl::opt<bool>
53 All("all",
54 cl::desc("Equivalent to setting: --file-headers, --program-headers, "
55 "--section-headers, --symbols, --relocations, "
56 "--dynamic-table, --notes, --version-info, --unwind, "
57 "--section-groups and --elf-hash-histogram."));
58 cl::alias AllShort("a", cl::desc("Alias for --all"), cl::aliasopt(All));
59
Sid Manning4afeaac2018-12-11 16:15:03 +000060 // --headers -e
61 cl::opt<bool>
62 Headers("headers",
63 cl::desc("Equivalent to setting: --file-headers, --program-headers, "
64 "--section-headers"));
65 cl::alias HeadersShort("e", cl::desc("Alias for --headers"),
66 cl::aliasopt(Headers));
67
Petr Hosekef54b492017-07-18 23:58:15 +000068 // -wide, -W
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +000069 cl::opt<bool>
70 WideOutput("wide", cl::desc("Ignored for compatibility with GNU readelf"),
71 cl::Hidden);
Petr Hosekef54b492017-07-18 23:58:15 +000072 cl::alias WideOutputShort("W",
73 cl::desc("Alias for --wide"),
74 cl::aliasopt(WideOutput));
75
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +000076 // -file-headers, -file-header, -h
Eric Christopher9cad53c2013-04-03 18:31:38 +000077 cl::opt<bool> FileHeaders("file-headers",
78 cl::desc("Display file headers "));
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +000079 cl::alias FileHeadersShort("h", cl::desc("Alias for --file-headers"),
80 cl::aliasopt(FileHeaders), cl::NotHidden);
81 cl::alias FileHeadersSingular("file-header",
82 cl::desc("Alias for --file-headers"),
83 cl::aliasopt(FileHeaders));
Eric Christopher9cad53c2013-04-03 18:31:38 +000084
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +000085 // -section-headers, -sections, -S
86 // Also -s in llvm-readobj mode.
87 cl::opt<bool> SectionHeaders("section-headers",
88 cl::desc("Display all section headers."));
89 cl::alias SectionsShortUpper("S", cl::desc("Alias for --section-headers"),
90 cl::aliasopt(SectionHeaders), cl::NotHidden);
91 cl::alias SectionHeadersAlias("sections",
92 cl::desc("Alias for --section-headers"),
93 cl::aliasopt(SectionHeaders), cl::NotHidden);
Eric Christopher9cad53c2013-04-03 18:31:38 +000094
95 // -section-relocations, -sr
96 cl::opt<bool> SectionRelocations("section-relocations",
97 cl::desc("Display relocations for each section shown."));
98 cl::alias SectionRelocationsShort("sr",
99 cl::desc("Alias for --section-relocations"),
100 cl::aliasopt(SectionRelocations));
101
102 // -section-symbols, -st
103 cl::opt<bool> SectionSymbols("section-symbols",
104 cl::desc("Display symbols for each section shown."));
105 cl::alias SectionSymbolsShort("st",
106 cl::desc("Alias for --section-symbols"),
107 cl::aliasopt(SectionSymbols));
108
109 // -section-data, -sd
110 cl::opt<bool> SectionData("section-data",
111 cl::desc("Display section data for each section shown."));
112 cl::alias SectionDataShort("sd",
113 cl::desc("Alias for --section-data"),
114 cl::aliasopt(SectionData));
115
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000116 // -relocations, -relocs, -r
Eric Christopher9cad53c2013-04-03 18:31:38 +0000117 cl::opt<bool> Relocations("relocations",
118 cl::desc("Display the relocation entries in the file"));
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000119 cl::alias RelocationsShort("r", cl::desc("Alias for --relocations"),
120 cl::aliasopt(Relocations), cl::NotHidden);
121 cl::alias RelocationsGNU("relocs", cl::desc("Alias for --relocations"),
122 cl::aliasopt(Relocations));
Eric Christopher9cad53c2013-04-03 18:31:38 +0000123
Saleem Abdulrasool6a405442016-08-30 18:52:02 +0000124 // -notes, -n
125 cl::opt<bool> Notes("notes", cl::desc("Display the ELF notes in the file"));
126 cl::alias NotesShort("n", cl::desc("Alias for --notes"), cl::aliasopt(Notes));
127
Michael J. Spencer594c0282015-06-25 21:47:32 +0000128 // -dyn-relocations
129 cl::opt<bool> DynRelocs("dyn-relocations",
130 cl::desc("Display the dynamic relocation entries in the file"));
131
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000132 // -symbols
133 // Also -s in llvm-readelf mode, or -t in llvm-readobj mode.
Eric Christopher9cad53c2013-04-03 18:31:38 +0000134 cl::opt<bool> Symbols("symbols",
135 cl::desc("Display the symbol table"));
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000136 cl::alias SymbolsGNU("syms", cl::desc("Alias for --symbols"),
137 cl::aliasopt(Symbols));
Eric Christopher9cad53c2013-04-03 18:31:38 +0000138
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000139 // -dyn-symbols, -dyn-syms, -dt
Eric Christopher9cad53c2013-04-03 18:31:38 +0000140 cl::opt<bool> DynamicSymbols("dyn-symbols",
141 cl::desc("Display the dynamic symbol table"));
142 cl::alias DynamicSymbolsShort("dt",
143 cl::desc("Alias for --dyn-symbols"),
144 cl::aliasopt(DynamicSymbols));
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000145 cl::alias DynSymsGNU("dyn-syms", cl::desc("Alias for --dyn-symbols"),
146 cl::aliasopt(DynamicSymbols));
Eric Christopher9cad53c2013-04-03 18:31:38 +0000147
148 // -unwind, -u
149 cl::opt<bool> UnwindInfo("unwind",
150 cl::desc("Display unwind information"));
151 cl::alias UnwindInfoShort("u",
152 cl::desc("Alias for --unwind"),
153 cl::aliasopt(UnwindInfo));
154
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000155 // -dynamic-table, -dynamic, -d
Eric Christopher9cad53c2013-04-03 18:31:38 +0000156 cl::opt<bool> DynamicTable("dynamic-table",
157 cl::desc("Display the ELF .dynamic section table"));
Saleem Abdulrasool6d9ca182016-07-20 01:16:28 +0000158 cl::alias DynamicTableShort("d", cl::desc("Alias for --dynamic-table"),
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000159 cl::aliasopt(DynamicTable), cl::NotHidden);
160 cl::alias DynamicTableAlias("dynamic", cl::desc("Alias for --dynamic-table"),
Saleem Abdulrasool6d9ca182016-07-20 01:16:28 +0000161 cl::aliasopt(DynamicTable));
Eric Christopher9cad53c2013-04-03 18:31:38 +0000162
163 // -needed-libs
164 cl::opt<bool> NeededLibraries("needed-libs",
165 cl::desc("Display the needed libraries"));
Nico Rieckf3f0b792013-04-12 04:01:52 +0000166
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000167 // -program-headers, -segments, -l
Nico Rieckd6df0542013-04-12 04:07:39 +0000168 cl::opt<bool> ProgramHeaders("program-headers",
169 cl::desc("Display ELF program headers"));
Saleem Abdulrasool6d9ca182016-07-20 01:16:28 +0000170 cl::alias ProgramHeadersShort("l", cl::desc("Alias for --program-headers"),
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000171 cl::aliasopt(ProgramHeaders), cl::NotHidden);
172 cl::alias SegmentsAlias("segments", cl::desc("Alias for --program-headers"),
173 cl::aliasopt(ProgramHeaders));
Nico Rieckd6df0542013-04-12 04:07:39 +0000174
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000175 // -string-dump, -p
Paul Semelfa5597b2018-06-15 14:15:02 +0000176 cl::list<std::string> StringDump("string-dump", cl::desc("<number|name>"),
177 cl::ZeroOrMore);
178 cl::alias StringDumpShort("p", cl::desc("Alias for --string-dump"),
179 cl::aliasopt(StringDump));
180
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000181 // -hex-dump, -x
Paul Semelb98f5042018-07-11 10:00:29 +0000182 cl::list<std::string> HexDump("hex-dump", cl::desc("<number|name>"),
183 cl::ZeroOrMore);
184 cl::alias HexDumpShort("x", cl::desc("Alias for --hex-dump"),
185 cl::aliasopt(HexDump));
186
Michael J. Spencer20546ff2015-07-09 22:32:24 +0000187 // -hash-table
188 cl::opt<bool> HashTable("hash-table",
189 cl::desc("Display ELF hash table"));
190
Igor Kudrin496fb2f2015-10-14 12:11:50 +0000191 // -gnu-hash-table
192 cl::opt<bool> GnuHashTable("gnu-hash-table",
193 cl::desc("Display ELF .gnu.hash section"));
194
Nico Rieckf3f0b792013-04-12 04:01:52 +0000195 // -expand-relocs
196 cl::opt<bool> ExpandRelocs("expand-relocs",
197 cl::desc("Expand each shown relocation to multiple lines"));
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000198
Jake Ehrlich0f440d82018-06-28 21:07:34 +0000199 // -raw-relr
200 cl::opt<bool> RawRelr("raw-relr",
201 cl::desc("Do not decode relocations in SHT_RELR section, display raw contents"));
202
Zachary Turner99f02152015-02-18 19:32:05 +0000203 // -codeview
204 cl::opt<bool> CodeView("codeview",
205 cl::desc("Display CodeView debug information"));
206
Reid Kleckner0b269742016-05-14 00:02:53 +0000207 // -codeview-merged-types
208 cl::opt<bool>
209 CodeViewMergedTypes("codeview-merged-types",
210 cl::desc("Display the merged CodeView type stream"));
211
Zachary Turner99f02152015-02-18 19:32:05 +0000212 // -codeview-subsection-bytes
213 cl::opt<bool> CodeViewSubsectionBytes(
214 "codeview-subsection-bytes",
215 cl::desc("Dump raw contents of codeview debug sections and records"));
Saleem Abdulrasool15d16d82014-01-30 04:46:33 +0000216
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000217 // -arm-attributes
Saleem Abdulrasool15d16d82014-01-30 04:46:33 +0000218 cl::opt<bool> ARMAttributes("arm-attributes",
219 cl::desc("Display the ARM attributes section"));
Simon Atanasyan80433902014-06-18 08:47:09 +0000220
221 // -mips-plt-got
222 cl::opt<bool>
223 MipsPLTGOT("mips-plt-got",
224 cl::desc("Display the MIPS GOT and PLT GOT sections"));
Rui Ueyama1e152d52014-10-02 17:02:18 +0000225
Simon Atanasyanc914de22015-05-07 15:40:35 +0000226 // -mips-abi-flags
227 cl::opt<bool> MipsABIFlags("mips-abi-flags",
228 cl::desc("Display the MIPS.abiflags section"));
229
Simon Atanasyan6e07e932015-06-16 21:47:43 +0000230 // -mips-reginfo
231 cl::opt<bool> MipsReginfo("mips-reginfo",
232 cl::desc("Display the MIPS .reginfo section"));
233
Simon Atanasyan8a71b532016-05-04 05:58:57 +0000234 // -mips-options
235 cl::opt<bool> MipsOptions("mips-options",
236 cl::desc("Display the MIPS .MIPS.options section"));
237
Rui Ueyama1e152d52014-10-02 17:02:18 +0000238 // -coff-imports
239 cl::opt<bool>
240 COFFImports("coff-imports", cl::desc("Display the PE/COFF import table"));
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +0000241
Saleem Abdulrasoolddd92642015-01-03 21:35:09 +0000242 // -coff-exports
243 cl::opt<bool>
244 COFFExports("coff-exports", cl::desc("Display the PE/COFF export table"));
245
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +0000246 // -coff-directives
247 cl::opt<bool>
248 COFFDirectives("coff-directives",
Rui Ueyama74e85132014-11-19 00:18:07 +0000249 cl::desc("Display the PE/COFF .drectve section"));
250
251 // -coff-basereloc
252 cl::opt<bool>
253 COFFBaseRelocs("coff-basereloc",
254 cl::desc("Display the PE/COFF .reloc section"));
Lang Hames0000afd2015-06-26 23:56:53 +0000255
Reid Kleckner2da433e2016-06-02 17:10:43 +0000256 // -coff-debug-directory
257 cl::opt<bool>
258 COFFDebugDirectory("coff-debug-directory",
259 cl::desc("Display the PE/COFF debug directory"));
260
Zachary Turner8d6396d2017-04-27 19:38:38 +0000261 // -coff-resources
262 cl::opt<bool> COFFResources("coff-resources",
263 cl::desc("Display the PE/COFF .rsrc section"));
264
Reid Klecknerb7d716c2017-06-22 01:10:29 +0000265 // -coff-load-config
266 cl::opt<bool>
267 COFFLoadConfig("coff-load-config",
268 cl::desc("Display the PE/COFF load config"));
269
Saleem Abdulrasoolb36fbbc2018-01-30 16:29:29 +0000270 // -elf-linker-options
271 cl::opt<bool>
272 ELFLinkerOptions("elf-linker-options",
273 cl::desc("Display the ELF .linker-options section"));
274
Davide Italiano07e7acb2015-08-21 20:28:30 +0000275 // -macho-data-in-code
276 cl::opt<bool>
277 MachODataInCode("macho-data-in-code",
278 cl::desc("Display MachO Data in Code command"));
279
Davide Italiano4410b222015-09-03 18:10:28 +0000280 // -macho-indirect-symbols
281 cl::opt<bool>
282 MachOIndirectSymbols("macho-indirect-symbols",
283 cl::desc("Display MachO indirect symbols"));
284
Davide Italiano9a429b72015-09-09 00:21:18 +0000285 // -macho-linker-options
286 cl::opt<bool>
287 MachOLinkerOptions("macho-linker-options",
288 cl::desc("Display MachO linker options"));
289
Davide Italianod1f09962015-09-02 16:24:24 +0000290 // -macho-segment
291 cl::opt<bool>
292 MachOSegment("macho-segment",
293 cl::desc("Display MachO Segment command"));
294
Davide Italiano976f4da2015-08-27 15:11:32 +0000295 // -macho-version-min
296 cl::opt<bool>
297 MachOVersionMin("macho-version-min",
298 cl::desc("Display MachO version min command"));
Davide Italiano35eebe12015-08-31 19:32:31 +0000299
300 // -macho-dysymtab
301 cl::opt<bool>
302 MachODysymtab("macho-dysymtab",
303 cl::desc("Display MachO Dysymtab command"));
304
Lang Hames0000afd2015-06-26 23:56:53 +0000305 // -stackmap
306 cl::opt<bool>
307 PrintStackMap("stackmap",
308 cl::desc("Display contents of stackmap section"));
309
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000310 // -version-info, -V
Davide Italiano4f05f322015-10-16 23:19:01 +0000311 cl::opt<bool>
312 VersionInfo("version-info",
313 cl::desc("Display ELF version sections (if present)"));
314 cl::alias VersionInfoShort("V", cl::desc("Alias for -version-info"),
315 cl::aliasopt(VersionInfo));
Hemant Kulkarniab4a46f2016-01-26 19:46:39 +0000316
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000317 // -elf-section-groups, -section-groups, -g
Hemant Kulkarniab4a46f2016-01-26 19:46:39 +0000318 cl::opt<bool> SectionGroups("elf-section-groups",
319 cl::desc("Display ELF section group contents"));
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000320 cl::alias SectionGroupsAlias("section-groups",
321 cl::desc("Alias for -elf-sections-groups"),
322 cl::aliasopt(SectionGroups));
Hemant Kulkarniab4a46f2016-01-26 19:46:39 +0000323 cl::alias SectionGroupsShort("g", cl::desc("Alias for -elf-sections-groups"),
324 cl::aliasopt(SectionGroups));
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000325
326 // -elf-hash-histogram, -histogram, -I
Hemant Kulkarni9b1b7f02016-04-11 17:15:30 +0000327 cl::opt<bool> HashHistogram(
328 "elf-hash-histogram",
329 cl::desc("Display bucket list histogram for hash sections"));
330 cl::alias HashHistogramShort("I", cl::desc("Alias for -elf-hash-histogram"),
331 cl::aliasopt(HashHistogram));
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000332 cl::alias HistogramAlias("histogram",
333 cl::desc("Alias for --elf-hash-histogram"),
334 cl::aliasopt(HashHistogram));
Hemant Kulkarniab4a46f2016-01-26 19:46:39 +0000335
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000336 // -elf-cg-profile
Michael J. Spencerae6eeae2018-06-02 16:33:01 +0000337 cl::opt<bool> CGProfile("elf-cg-profile", cl::desc("Display callgraph profile section"));
338
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000339 // -addrsig
Peter Collingbournebc3089f2018-08-22 23:58:16 +0000340 cl::opt<bool> Addrsig("addrsig",
Peter Collingbourne3e227332018-07-17 22:17:18 +0000341 cl::desc("Display address-significance table"));
342
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000343 // -elf-output-style
Tim Northoverd59b23a2016-03-01 21:45:22 +0000344 cl::opt<OutputStyleTy>
Hemant Kulkarnid8a985e2016-02-10 20:40:55 +0000345 Output("elf-output-style", cl::desc("Specify ELF dump style"),
346 cl::values(clEnumVal(LLVM, "LLVM default style"),
Mehdi Amini732afdd2016-10-08 19:41:06 +0000347 clEnumVal(GNU, "GNU readelf style")),
Hemant Kulkarnid8a985e2016-02-10 20:40:55 +0000348 cl::init(LLVM));
Eric Christopher9cad53c2013-04-03 18:31:38 +0000349} // namespace opts
350
Rafael Espindola00ddb142015-07-20 03:38:17 +0000351namespace llvm {
352
Davide Italiano1eb92342015-12-04 19:29:49 +0000353LLVM_ATTRIBUTE_NORETURN void reportError(Twine Msg) {
Davide Italiano0a07a822015-12-23 19:29:34 +0000354 errs() << "\nError reading file: " << Msg << ".\n";
355 errs().flush();
Rafael Espindolafb3acd62015-07-20 03:23:55 +0000356 exit(1);
Rafael Espindola724d4b42015-07-20 03:01:49 +0000357}
358
Zachary Turner5e3e4bb2016-08-05 21:45:34 +0000359void error(Error EC) {
Zachary Turner660230e2016-08-04 19:39:55 +0000360 if (!EC)
361 return;
Zachary Turner660230e2016-08-04 19:39:55 +0000362 handleAllErrors(std::move(EC),
Zachary Turner5e3e4bb2016-08-05 21:45:34 +0000363 [&](const ErrorInfoBase &EI) { reportError(EI.message()); });
Zachary Turner660230e2016-08-04 19:39:55 +0000364}
365
Rafael Espindolafb3acd62015-07-20 03:23:55 +0000366void error(std::error_code EC) {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000367 if (!EC)
Rafael Espindolafb3acd62015-07-20 03:23:55 +0000368 return;
Rafael Espindola8b3b09f2015-08-06 21:54:37 +0000369 reportError(EC.message());
Rafael Espindola144af2c2012-12-31 16:05:21 +0000370}
371
Eric Christopher9cad53c2013-04-03 18:31:38 +0000372bool relocAddressLess(RelocationRef a, RelocationRef b) {
Rafael Espindolac7689302015-07-06 15:53:43 +0000373 return a.getOffset() < b.getOffset();
Eric Christopher9cad53c2013-04-03 18:31:38 +0000374}
375
376} // namespace llvm
377
Rafael Espindola4453e42942014-06-13 03:07:50 +0000378static void reportError(StringRef Input, std::error_code EC) {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000379 if (Input == "-")
380 Input = "<stdin>";
381
Rafael Espindola724d4b42015-07-20 03:01:49 +0000382 reportError(Twine(Input) + ": " + EC.message());
Eric Christopher9cad53c2013-04-03 18:31:38 +0000383}
384
Lang Hamesfc209622016-07-14 02:24:01 +0000385static void reportError(StringRef Input, Error Err) {
386 if (Input == "-")
387 Input = "<stdin>";
388 std::string ErrMsg;
389 {
390 raw_string_ostream ErrStream(ErrMsg);
391 logAllUnhandledErrors(std::move(Err), ErrStream, Input + ": ");
392 }
393 reportError(ErrMsg);
394}
395
Simon Atanasyan80433902014-06-18 08:47:09 +0000396static bool isMipsArch(unsigned Arch) {
397 switch (Arch) {
398 case llvm::Triple::mips:
399 case llvm::Triple::mipsel:
400 case llvm::Triple::mips64:
401 case llvm::Triple::mips64el:
402 return true;
403 default:
404 return false;
405 }
406}
Zachary Turnerc6d54da2016-09-09 17:46:17 +0000407namespace {
Zachary Turner4efa0a42016-11-08 22:24:53 +0000408struct ReadObjTypeTableBuilder {
Reid Kleckner5d577522017-03-24 17:26:38 +0000409 ReadObjTypeTableBuilder()
410 : Allocator(), IDTable(Allocator), TypeTable(Allocator) {}
Simon Atanasyan80433902014-06-18 08:47:09 +0000411
Zachary Turnerc6d54da2016-09-09 17:46:17 +0000412 llvm::BumpPtrAllocator Allocator;
Zachary Turnerca6dbf12017-11-30 18:39:50 +0000413 llvm::codeview::MergingTypeTableBuilder IDTable;
414 llvm::codeview::MergingTypeTableBuilder TypeTable;
Zachary Turnerc6d54da2016-09-09 17:46:17 +0000415};
416}
Zachary Turner4efa0a42016-11-08 22:24:53 +0000417static ReadObjTypeTableBuilder CVTypes;
Reid Kleckner0b269742016-05-14 00:02:53 +0000418
Adrian Prantl4dfcc4a2018-05-01 16:10:38 +0000419/// Creates an format-specific object file dumper.
Zachary Turner88bb1632016-05-03 00:28:04 +0000420static std::error_code createDumper(const ObjectFile *Obj,
421 ScopedPrinter &Writer,
Rafael Espindola4453e42942014-06-13 03:07:50 +0000422 std::unique_ptr<ObjDumper> &Result) {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000423 if (!Obj)
424 return readobj_error::unsupported_file_format;
425
426 if (Obj->isCOFF())
427 return createCOFFDumper(Obj, Writer, Result);
428 if (Obj->isELF())
429 return createELFDumper(Obj, Writer, Result);
430 if (Obj->isMachO())
431 return createMachODumper(Obj, Writer, Result);
Derek Schuff6d76b7b2017-01-30 23:30:52 +0000432 if (Obj->isWasm())
433 return createWasmDumper(Obj, Writer, Result);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000434
435 return readobj_error::unsupported_obj_file_format;
436}
437
Adrian Prantl4dfcc4a2018-05-01 16:10:38 +0000438/// Dumps the specified object file.
Sam Clegg88e9a152018-01-10 00:14:19 +0000439static void dumpObject(const ObjectFile *Obj, ScopedPrinter &Writer) {
Ahmed Charles56440fd2014-03-06 05:51:42 +0000440 std::unique_ptr<ObjDumper> Dumper;
Davide Italianoe66b73f2015-12-05 23:36:52 +0000441 if (std::error_code EC = createDumper(Obj, Writer, Dumper))
Eric Christopher9cad53c2013-04-03 18:31:38 +0000442 reportError(Obj->getFileName(), EC);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000443
Hemant Kulkarnid8a985e2016-02-10 20:40:55 +0000444 if (opts::Output == opts::LLVM) {
Sam Clegg88e9a152018-01-10 00:14:19 +0000445 Writer.startLine() << "\n";
446 Writer.printString("File", Obj->getFileName());
447 Writer.printString("Format", Obj->getFileFormatName());
448 Writer.printString("Arch", Triple::getArchTypeName(
449 (llvm::Triple::ArchType)Obj->getArch()));
450 Writer.printString("AddressSize",
451 formatv("{0}bit", 8 * Obj->getBytesInAddress()));
Hemant Kulkarnid8a985e2016-02-10 20:40:55 +0000452 Dumper->printLoadName();
453 }
Eric Christopher9cad53c2013-04-03 18:31:38 +0000454
455 if (opts::FileHeaders)
456 Dumper->printFileHeaders();
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000457 if (opts::SectionHeaders)
458 Dumper->printSectionHeaders();
Eric Christopher9cad53c2013-04-03 18:31:38 +0000459 if (opts::Relocations)
460 Dumper->printRelocations();
Michael J. Spencer594c0282015-06-25 21:47:32 +0000461 if (opts::DynRelocs)
462 Dumper->printDynamicRelocations();
Eric Christopher9cad53c2013-04-03 18:31:38 +0000463 if (opts::Symbols)
464 Dumper->printSymbols();
465 if (opts::DynamicSymbols)
466 Dumper->printDynamicSymbols();
467 if (opts::UnwindInfo)
468 Dumper->printUnwindInfo();
469 if (opts::DynamicTable)
470 Dumper->printDynamicTable();
471 if (opts::NeededLibraries)
472 Dumper->printNeededLibraries();
Nico Rieckd6df0542013-04-12 04:07:39 +0000473 if (opts::ProgramHeaders)
474 Dumper->printProgramHeaders();
Paul Semelfa5597b2018-06-15 14:15:02 +0000475 if (!opts::StringDump.empty())
Paul Semel6e137902018-07-18 18:00:41 +0000476 llvm::for_each(opts::StringDump, [&Dumper, Obj](StringRef SectionName) {
477 Dumper->printSectionAsString(Obj, SectionName);
Paul Semelfa5597b2018-06-15 14:15:02 +0000478 });
Paul Semelb98f5042018-07-11 10:00:29 +0000479 if (!opts::HexDump.empty())
Paul Semel5ce8f152018-07-25 10:04:37 +0000480 llvm::for_each(opts::HexDump, [&Dumper, Obj](StringRef SectionName) {
481 Dumper->printSectionAsHex(Obj, SectionName);
Paul Semelb98f5042018-07-11 10:00:29 +0000482 });
Michael J. Spencer20546ff2015-07-09 22:32:24 +0000483 if (opts::HashTable)
484 Dumper->printHashTable();
Igor Kudrin496fb2f2015-10-14 12:11:50 +0000485 if (opts::GnuHashTable)
486 Dumper->printGnuHashTable();
Davide Italiano4f05f322015-10-16 23:19:01 +0000487 if (opts::VersionInfo)
488 Dumper->printVersionInfo();
Hemant Kulkarniab4a46f2016-01-26 19:46:39 +0000489 if (Obj->isELF()) {
Saleem Abdulrasoolb36fbbc2018-01-30 16:29:29 +0000490 if (opts::ELFLinkerOptions)
491 Dumper->printELFLinkerOptions();
Hemant Kulkarniab4a46f2016-01-26 19:46:39 +0000492 if (Obj->getArch() == llvm::Triple::arm)
493 if (opts::ARMAttributes)
494 Dumper->printAttributes();
495 if (isMipsArch(Obj->getArch())) {
496 if (opts::MipsPLTGOT)
497 Dumper->printMipsPLTGOT();
498 if (opts::MipsABIFlags)
499 Dumper->printMipsABIFlags();
500 if (opts::MipsReginfo)
501 Dumper->printMipsReginfo();
Simon Atanasyan8a71b532016-05-04 05:58:57 +0000502 if (opts::MipsOptions)
503 Dumper->printMipsOptions();
Hemant Kulkarniab4a46f2016-01-26 19:46:39 +0000504 }
505 if (opts::SectionGroups)
506 Dumper->printGroupSections();
Hemant Kulkarni9b1b7f02016-04-11 17:15:30 +0000507 if (opts::HashHistogram)
508 Dumper->printHashHistogram();
Michael J. Spencerae6eeae2018-06-02 16:33:01 +0000509 if (opts::CGProfile)
510 Dumper->printCGProfile();
Peter Collingbourne3e227332018-07-17 22:17:18 +0000511 if (opts::Addrsig)
512 Dumper->printAddrsig();
Saleem Abdulrasool6a405442016-08-30 18:52:02 +0000513 if (opts::Notes)
514 Dumper->printNotes();
Simon Atanasyanc914de22015-05-07 15:40:35 +0000515 }
Davide Italianocd1b6db2015-07-24 02:14:20 +0000516 if (Obj->isCOFF()) {
517 if (opts::COFFImports)
518 Dumper->printCOFFImports();
519 if (opts::COFFExports)
520 Dumper->printCOFFExports();
521 if (opts::COFFDirectives)
522 Dumper->printCOFFDirectives();
523 if (opts::COFFBaseRelocs)
524 Dumper->printCOFFBaseReloc();
Reid Kleckner2da433e2016-06-02 17:10:43 +0000525 if (opts::COFFDebugDirectory)
526 Dumper->printCOFFDebugDirectory();
Zachary Turner8d6396d2017-04-27 19:38:38 +0000527 if (opts::COFFResources)
528 Dumper->printCOFFResources();
Reid Klecknerb7d716c2017-06-22 01:10:29 +0000529 if (opts::COFFLoadConfig)
530 Dumper->printCOFFLoadConfig();
Peter Collingbournebc3089f2018-08-22 23:58:16 +0000531 if (opts::Addrsig)
532 Dumper->printAddrsig();
Reid Kleckner83ebad32015-12-16 18:28:12 +0000533 if (opts::CodeView)
534 Dumper->printCodeViewDebugInfo();
Reid Kleckner0b269742016-05-14 00:02:53 +0000535 if (opts::CodeViewMergedTypes)
Reid Kleckner5d577522017-03-24 17:26:38 +0000536 Dumper->mergeCodeViewTypes(CVTypes.IDTable, CVTypes.TypeTable);
Davide Italianocd1b6db2015-07-24 02:14:20 +0000537 }
Davide Italiano1e12fc42015-08-31 17:12:23 +0000538 if (Obj->isMachO()) {
Davide Italiano07e7acb2015-08-21 20:28:30 +0000539 if (opts::MachODataInCode)
540 Dumper->printMachODataInCode();
Davide Italiano4410b222015-09-03 18:10:28 +0000541 if (opts::MachOIndirectSymbols)
542 Dumper->printMachOIndirectSymbols();
Davide Italiano9a429b72015-09-09 00:21:18 +0000543 if (opts::MachOLinkerOptions)
544 Dumper->printMachOLinkerOptions();
Davide Italianod1f09962015-09-02 16:24:24 +0000545 if (opts::MachOSegment)
546 Dumper->printMachOSegment();
Davide Italiano976f4da2015-08-27 15:11:32 +0000547 if (opts::MachOVersionMin)
548 Dumper->printMachOVersionMin();
Davide Italiano35eebe12015-08-31 19:32:31 +0000549 if (opts::MachODysymtab)
550 Dumper->printMachODysymtab();
Davide Italiano1e12fc42015-08-31 17:12:23 +0000551 }
Lang Hames0000afd2015-06-26 23:56:53 +0000552 if (opts::PrintStackMap)
553 Dumper->printStackMap();
Rafael Espindola21bd8412012-12-31 16:29:44 +0000554}
555
Adrian Prantl4dfcc4a2018-05-01 16:10:38 +0000556/// Dumps each object file in \a Arc;
Sam Clegg88e9a152018-01-10 00:14:19 +0000557static void dumpArchive(const Archive *Arc, ScopedPrinter &Writer) {
Mehdi Amini41af4302016-11-11 04:28:40 +0000558 Error Err = Error::success();
Lang Hamesfc209622016-07-14 02:24:01 +0000559 for (auto &Child : Arc->children(Err)) {
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000560 Expected<std::unique_ptr<Binary>> ChildOrErr = Child.getAsBinary();
561 if (!ChildOrErr) {
562 if (auto E = isNotObjectErrorInvalidFileType(ChildOrErr.takeError())) {
Sam Cleggc0d76642017-05-10 14:18:11 +0000563 reportError(Arc->getFileName(), ChildOrErr.takeError());
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000564 }
Eric Christopher9cad53c2013-04-03 18:31:38 +0000565 continue;
David Meyer6c614bf2012-03-09 20:59:52 +0000566 }
Rafael Espindolaae460022014-06-16 16:08:36 +0000567 if (ObjectFile *Obj = dyn_cast<ObjectFile>(&*ChildOrErr.get()))
Sam Clegg88e9a152018-01-10 00:14:19 +0000568 dumpObject(Obj, Writer);
Saleem Abdulrasool3780b3a2016-08-18 14:32:11 +0000569 else if (COFFImportFile *Imp = dyn_cast<COFFImportFile>(&*ChildOrErr.get()))
Sam Clegg88e9a152018-01-10 00:14:19 +0000570 dumpCOFFImportFile(Imp, Writer);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000571 else
572 reportError(Arc->getFileName(), readobj_error::unrecognized_file_format);
573 }
Lang Hamesfc209622016-07-14 02:24:01 +0000574 if (Err)
575 reportError(Arc->getFileName(), std::move(Err));
Eric Christopher9cad53c2013-04-03 18:31:38 +0000576}
577
Adrian Prantl4dfcc4a2018-05-01 16:10:38 +0000578/// Dumps each object file in \a MachO Universal Binary;
Sam Clegg88e9a152018-01-10 00:14:19 +0000579static void dumpMachOUniversalBinary(const MachOUniversalBinary *UBinary,
580 ScopedPrinter &Writer) {
Rafael Espindola8448a242015-03-24 20:26:55 +0000581 for (const MachOUniversalBinary::ObjectForArch &Obj : UBinary->objects()) {
Kevin Enderby9acb1092016-05-31 20:35:34 +0000582 Expected<std::unique_ptr<MachOObjectFile>> ObjOrErr = Obj.getAsObjectFile();
David Blaikie29ac43c2015-04-13 16:05:49 +0000583 if (ObjOrErr)
Sam Clegg88e9a152018-01-10 00:14:19 +0000584 dumpObject(&*ObjOrErr.get(), Writer);
Kevin Enderby9acb1092016-05-31 20:35:34 +0000585 else if (auto E = isNotObjectErrorInvalidFileType(ObjOrErr.takeError())) {
Sam Cleggc0d76642017-05-10 14:18:11 +0000586 reportError(UBinary->getFileName(), ObjOrErr.takeError());
Kevin Enderby9acb1092016-05-31 20:35:34 +0000587 }
Kevin Enderby42398052016-06-28 23:16:13 +0000588 else if (Expected<std::unique_ptr<Archive>> AOrErr = Obj.getAsArchive())
Sam Clegg88e9a152018-01-10 00:14:19 +0000589 dumpArchive(&*AOrErr.get(), Writer);
Rafael Espindola8448a242015-03-24 20:26:55 +0000590 }
591}
Eric Christopher9cad53c2013-04-03 18:31:38 +0000592
Adrian Prantl4dfcc4a2018-05-01 16:10:38 +0000593/// Dumps \a WinRes, Windows Resource (.res) file;
Marek Sokolowskic2189b82017-09-20 18:33:35 +0000594static void dumpWindowsResourceFile(WindowsResource *WinRes) {
595 ScopedPrinter Printer{outs()};
596 WindowsRes::Dumper Dumper(WinRes, Printer);
597 if (auto Err = Dumper.printData())
598 reportError(WinRes->getFileName(), std::move(Err));
599}
600
601
Adrian Prantl4dfcc4a2018-05-01 16:10:38 +0000602/// Opens \a File and dumps it.
Eric Christopher9cad53c2013-04-03 18:31:38 +0000603static void dumpInput(StringRef File) {
Sam Clegg88e9a152018-01-10 00:14:19 +0000604 ScopedPrinter Writer(outs());
David Meyer2fc34c52012-03-01 01:36:50 +0000605
Eric Christopher9cad53c2013-04-03 18:31:38 +0000606 // Attempt to open the binary.
Kevin Enderby3fcdf6a2016-04-06 22:14:09 +0000607 Expected<OwningBinary<Binary>> BinaryOrErr = createBinary(File);
608 if (!BinaryOrErr)
Sam Cleggc0d76642017-05-10 14:18:11 +0000609 reportError(File, BinaryOrErr.takeError());
Rafael Espindola48af1c22014-08-19 18:44:46 +0000610 Binary &Binary = *BinaryOrErr.get().getBinary();
Eric Christopher9cad53c2013-04-03 18:31:38 +0000611
Rafael Espindola3f6481d2014-08-01 14:31:55 +0000612 if (Archive *Arc = dyn_cast<Archive>(&Binary))
Sam Clegg88e9a152018-01-10 00:14:19 +0000613 dumpArchive(Arc, Writer);
Rafael Espindola8448a242015-03-24 20:26:55 +0000614 else if (MachOUniversalBinary *UBinary =
615 dyn_cast<MachOUniversalBinary>(&Binary))
Sam Clegg88e9a152018-01-10 00:14:19 +0000616 dumpMachOUniversalBinary(UBinary, Writer);
Rafael Espindola3f6481d2014-08-01 14:31:55 +0000617 else if (ObjectFile *Obj = dyn_cast<ObjectFile>(&Binary))
Sam Clegg88e9a152018-01-10 00:14:19 +0000618 dumpObject(Obj, Writer);
Rui Ueyama71ba9bd2015-08-28 07:40:30 +0000619 else if (COFFImportFile *Import = dyn_cast<COFFImportFile>(&Binary))
Sam Clegg88e9a152018-01-10 00:14:19 +0000620 dumpCOFFImportFile(Import, Writer);
Marek Sokolowskic2189b82017-09-20 18:33:35 +0000621 else if (WindowsResource *WinRes = dyn_cast<WindowsResource>(&Binary))
622 dumpWindowsResourceFile(WinRes);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000623 else
624 reportError(File, readobj_error::unrecognized_file_format);
Rafael Espindola21bd8412012-12-31 16:29:44 +0000625}
626
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000627/// Registers aliases that should only be allowed by readobj.
628static void registerReadobjAliases() {
629 // -s has meant --sections for a very long time in llvm-readobj despite
630 // meaning --symbols in readelf.
631 static cl::alias SectionsShort("s", cl::desc("Alias for --section-headers"),
632 cl::aliasopt(opts::SectionHeaders),
633 cl::NotHidden);
634
635 // Only register -t in llvm-readobj, as readelf reserves it for
636 // --section-details (not implemented yet).
637 static cl::alias SymbolsShort("t", cl::desc("Alias for --symbols"),
638 cl::aliasopt(opts::Symbols), cl::NotHidden);
639}
640
641/// Registers aliases that should only be allowed by readelf.
642static void registerReadelfAliases() {
643 // -s is here because for readobj it means --sections.
644 static cl::alias SymbolsShort("s", cl::desc("Alias for --symbols"),
645 cl::aliasopt(opts::Symbols), cl::NotHidden);
646}
647
Eric Christopher9cad53c2013-04-03 18:31:38 +0000648int main(int argc, const char *argv[]) {
Rui Ueyama197194b2018-04-13 18:26:06 +0000649 InitLLVM X(argc, argv);
David Meyer2fc34c52012-03-01 01:36:50 +0000650
Eric Christopher9cad53c2013-04-03 18:31:38 +0000651 // Register the target printer for --version.
652 cl::AddExtraVersionPrinter(TargetRegistry::printRegisteredTargetsForVersion);
David Meyer2fc34c52012-03-01 01:36:50 +0000653
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000654 if (sys::path::stem(argv[0]).contains("readelf")) {
Petr Hosekbf515502017-07-19 02:09:37 +0000655 opts::Output = opts::GNU;
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000656 registerReadelfAliases();
657 } else {
658 registerReadobjAliases();
659 }
Petr Hosekbf515502017-07-19 02:09:37 +0000660
Eric Christopher9cad53c2013-04-03 18:31:38 +0000661 cl::ParseCommandLineOptions(argc, argv, "LLVM Object Reader\n");
David Meyer2fc34c52012-03-01 01:36:50 +0000662
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000663 if (opts::All) {
664 opts::FileHeaders = true;
665 opts::ProgramHeaders = true;
666 opts::SectionHeaders = true;
667 opts::Symbols = true;
668 opts::Relocations = true;
669 opts::DynamicTable = true;
670 opts::Notes = true;
671 opts::VersionInfo = true;
672 opts::UnwindInfo = true;
673 opts::SectionGroups = true;
674 opts::HashHistogram = true;
675 }
676
Sid Manning4afeaac2018-12-11 16:15:03 +0000677 if (opts::Headers) {
678 opts::FileHeaders = true;
679 opts::ProgramHeaders = true;
680 opts::SectionHeaders = true;
681 }
682
Eric Christopher9cad53c2013-04-03 18:31:38 +0000683 // Default to stdin if no filename is specified.
Zachary Turner123ef632017-11-30 18:33:34 +0000684 if (opts::InputFilenames.size() == 0)
685 opts::InputFilenames.push_back("-");
686
687 llvm::for_each(opts::InputFilenames, dumpInput);
688
689 if (opts::CodeViewMergedTypes) {
690 ScopedPrinter W(outs());
Reid Kleckner5d577522017-03-24 17:26:38 +0000691 dumpCodeViewMergedTypes(W, CVTypes.IDTable, CVTypes.TypeTable);
Reid Kleckner0b269742016-05-14 00:02:53 +0000692 }
693
Rafael Espindolafb3acd62015-07-20 03:23:55 +0000694 return 0;
David Meyer2fc34c52012-03-01 01:36:50 +0000695}