blob: 1bd5bb74bf290a01f5475265fb457d1a63fb3b66 [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//
Chandler Carruth2946cd72019-01-19 08:50:56 +00003// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
David Meyer2fc34c52012-03-01 01:36:50 +00006//
7//===----------------------------------------------------------------------===//
8//
Michael J. Spencerd7e70032013-02-05 20:27:22 +00009// This is a tool similar to readelf, except it works on multiple object file
10// formats. The main purpose of this tool is to provide detailed output suitable
11// for FileCheck.
David Meyerae11a782012-03-02 23:43:51 +000012//
Michael J. Spencerd7e70032013-02-05 20:27:22 +000013// Flags should be similar to readelf where supported, but the output format
14// does not need to be identical. The point is to not make users learn yet
15// another set of flags.
David Meyerae11a782012-03-02 23:43:51 +000016//
Michael J. Spencerd7e70032013-02-05 20:27:22 +000017// Output should be specialized for each format where appropriate.
David Meyerae11a782012-03-02 23:43:51 +000018//
19//===----------------------------------------------------------------------===//
David Meyer2fc34c52012-03-01 01:36:50 +000020
Michael J. Spencer6a8746b2013-02-20 02:37:12 +000021#include "llvm-readobj.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000022#include "Error.h"
23#include "ObjDumper.h"
Marek Sokolowskic2189b82017-09-20 18:33:35 +000024#include "WindowsResourceDumper.h"
Alexandre Ganea120366e2019-02-07 15:24:18 +000025#include "llvm/DebugInfo/CodeView/GlobalTypeTableBuilder.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"
Stephen Tozer19bb1d52019-04-15 11:17:48 +000042#include "llvm/Support/WithColor.h"
Eric Christopher9cad53c2013-04-03 18:31:38 +000043
David Meyer2fc34c52012-03-01 01:36:50 +000044using namespace llvm;
45using namespace llvm::object;
46
Eric Christopher9cad53c2013-04-03 18:31:38 +000047namespace opts {
48 cl::list<std::string> InputFilenames(cl::Positional,
49 cl::desc("<input object files>"),
50 cl::ZeroOrMore);
David Meyer2fc34c52012-03-01 01:36:50 +000051
Fangrui Songe29e30b2019-05-01 05:27:20 +000052 // --all, -a
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +000053 cl::opt<bool>
54 All("all",
55 cl::desc("Equivalent to setting: --file-headers, --program-headers, "
56 "--section-headers, --symbols, --relocations, "
57 "--dynamic-table, --notes, --version-info, --unwind, "
58 "--section-groups and --elf-hash-histogram."));
59 cl::alias AllShort("a", cl::desc("Alias for --all"), cl::aliasopt(All));
60
Sid Manning4afeaac2018-12-11 16:15:03 +000061 // --headers -e
62 cl::opt<bool>
63 Headers("headers",
64 cl::desc("Equivalent to setting: --file-headers, --program-headers, "
65 "--section-headers"));
66 cl::alias HeadersShort("e", cl::desc("Alias for --headers"),
67 cl::aliasopt(Headers));
68
Fangrui Songe29e30b2019-05-01 05:27:20 +000069 // --wide, -W
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +000070 cl::opt<bool>
71 WideOutput("wide", cl::desc("Ignored for compatibility with GNU readelf"),
72 cl::Hidden);
Petr Hosekef54b492017-07-18 23:58:15 +000073 cl::alias WideOutputShort("W",
74 cl::desc("Alias for --wide"),
75 cl::aliasopt(WideOutput));
76
Fangrui Songe29e30b2019-05-01 05:27:20 +000077 // --file-headers, --file-header, -h
Eric Christopher9cad53c2013-04-03 18:31:38 +000078 cl::opt<bool> FileHeaders("file-headers",
79 cl::desc("Display file headers "));
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +000080 cl::alias FileHeadersShort("h", cl::desc("Alias for --file-headers"),
81 cl::aliasopt(FileHeaders), cl::NotHidden);
82 cl::alias FileHeadersSingular("file-header",
83 cl::desc("Alias for --file-headers"),
84 cl::aliasopt(FileHeaders));
Eric Christopher9cad53c2013-04-03 18:31:38 +000085
Fangrui Songe29e30b2019-05-01 05:27:20 +000086 // --section-headers, --sections, -S
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +000087 // Also -s in llvm-readobj mode.
88 cl::opt<bool> SectionHeaders("section-headers",
89 cl::desc("Display all section headers."));
90 cl::alias SectionsShortUpper("S", cl::desc("Alias for --section-headers"),
91 cl::aliasopt(SectionHeaders), cl::NotHidden);
92 cl::alias SectionHeadersAlias("sections",
93 cl::desc("Alias for --section-headers"),
94 cl::aliasopt(SectionHeaders), cl::NotHidden);
Eric Christopher9cad53c2013-04-03 18:31:38 +000095
Fangrui Songe29e30b2019-05-01 05:27:20 +000096 // --section-relocations
97 // Also --sr in llvm-readobj mode.
Eric Christopher9cad53c2013-04-03 18:31:38 +000098 cl::opt<bool> SectionRelocations("section-relocations",
99 cl::desc("Display relocations for each section shown."));
Eric Christopher9cad53c2013-04-03 18:31:38 +0000100
Fangrui Songe29e30b2019-05-01 05:27:20 +0000101 // --section-symbols
102 // Also --st in llvm-readobj mode.
Eric Christopher9cad53c2013-04-03 18:31:38 +0000103 cl::opt<bool> SectionSymbols("section-symbols",
104 cl::desc("Display symbols for each section shown."));
Eric Christopher9cad53c2013-04-03 18:31:38 +0000105
Fangrui Songe29e30b2019-05-01 05:27:20 +0000106 // --section-data
107 // Also --sd in llvm-readobj mode.
Eric Christopher9cad53c2013-04-03 18:31:38 +0000108 cl::opt<bool> SectionData("section-data",
109 cl::desc("Display section data for each section shown."));
Eric Christopher9cad53c2013-04-03 18:31:38 +0000110
Fangrui Songe29e30b2019-05-01 05:27:20 +0000111 // --section-mapping
Matt Davis50ca8ed2019-02-01 18:51:10 +0000112 cl::opt<cl::boolOrDefault>
113 SectionMapping("section-mapping",
114 cl::desc("Display the section to segment mapping."));
115
Fangrui Songe29e30b2019-05-01 05:27:20 +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
Fangrui Songe29e30b2019-05-01 05:27:20 +0000124 // --notes, -n
Saleem Abdulrasool6a405442016-08-30 18:52:02 +0000125 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
Fangrui Songe29e30b2019-05-01 05:27:20 +0000128 // --dyn-relocations
Michael J. Spencer594c0282015-06-25 21:47:32 +0000129 cl::opt<bool> DynRelocs("dyn-relocations",
130 cl::desc("Display the dynamic relocation entries in the file"));
131
Fangrui Songe29e30b2019-05-01 05:27:20 +0000132 // --symbols
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000133 // Also -s in llvm-readelf mode, or -t in llvm-readobj mode.
James Henderson21ed8682019-01-23 16:15:39 +0000134 cl::opt<bool>
135 Symbols("symbols",
136 cl::desc("Display the symbol table. Also display the dynamic "
137 "symbol table when using GNU output style for ELF"));
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000138 cl::alias SymbolsGNU("syms", cl::desc("Alias for --symbols"),
139 cl::aliasopt(Symbols));
Eric Christopher9cad53c2013-04-03 18:31:38 +0000140
Fangrui Songe29e30b2019-05-01 05:27:20 +0000141 // --dyn-symbols, --dyn-syms
142 // Also --dt in llvm-readobj mode.
Eric Christopher9cad53c2013-04-03 18:31:38 +0000143 cl::opt<bool> DynamicSymbols("dyn-symbols",
144 cl::desc("Display the dynamic symbol table"));
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
Fangrui Songe29e30b2019-05-01 05:27:20 +0000148 // --hash-symbols
James Henderson5fc812f2019-01-22 09:35:35 +0000149 cl::opt<bool> HashSymbols(
150 "hash-symbols",
151 cl::desc("Display the dynamic symbols derived from the hash section"));
152
Fangrui Songe29e30b2019-05-01 05:27:20 +0000153 // --unwind, -u
Eric Christopher9cad53c2013-04-03 18:31:38 +0000154 cl::opt<bool> UnwindInfo("unwind",
155 cl::desc("Display unwind information"));
156 cl::alias UnwindInfoShort("u",
157 cl::desc("Alias for --unwind"),
158 cl::aliasopt(UnwindInfo));
159
Fangrui Songe29e30b2019-05-01 05:27:20 +0000160 // --dynamic-table, --dynamic, -d
Eric Christopher9cad53c2013-04-03 18:31:38 +0000161 cl::opt<bool> DynamicTable("dynamic-table",
162 cl::desc("Display the ELF .dynamic section table"));
Saleem Abdulrasool6d9ca182016-07-20 01:16:28 +0000163 cl::alias DynamicTableShort("d", cl::desc("Alias for --dynamic-table"),
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000164 cl::aliasopt(DynamicTable), cl::NotHidden);
165 cl::alias DynamicTableAlias("dynamic", cl::desc("Alias for --dynamic-table"),
Saleem Abdulrasool6d9ca182016-07-20 01:16:28 +0000166 cl::aliasopt(DynamicTable));
Eric Christopher9cad53c2013-04-03 18:31:38 +0000167
Fangrui Songe29e30b2019-05-01 05:27:20 +0000168 // --needed-libs
Eric Christopher9cad53c2013-04-03 18:31:38 +0000169 cl::opt<bool> NeededLibraries("needed-libs",
170 cl::desc("Display the needed libraries"));
Nico Rieckf3f0b792013-04-12 04:01:52 +0000171
Fangrui Songe29e30b2019-05-01 05:27:20 +0000172 // --program-headers, --segments, -l
Nico Rieckd6df0542013-04-12 04:07:39 +0000173 cl::opt<bool> ProgramHeaders("program-headers",
174 cl::desc("Display ELF program headers"));
Saleem Abdulrasool6d9ca182016-07-20 01:16:28 +0000175 cl::alias ProgramHeadersShort("l", cl::desc("Alias for --program-headers"),
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000176 cl::aliasopt(ProgramHeaders), cl::NotHidden);
177 cl::alias SegmentsAlias("segments", cl::desc("Alias for --program-headers"),
178 cl::aliasopt(ProgramHeaders));
Nico Rieckd6df0542013-04-12 04:07:39 +0000179
Fangrui Songe29e30b2019-05-01 05:27:20 +0000180 // --string-dump, -p
Paul Semelfa5597b2018-06-15 14:15:02 +0000181 cl::list<std::string> StringDump("string-dump", cl::desc("<number|name>"),
182 cl::ZeroOrMore);
183 cl::alias StringDumpShort("p", cl::desc("Alias for --string-dump"),
Jordan Rupprecht342aaa12019-03-29 16:43:13 +0000184 cl::aliasopt(StringDump), cl::Prefix);
Paul Semelfa5597b2018-06-15 14:15:02 +0000185
Fangrui Songe29e30b2019-05-01 05:27:20 +0000186 // --hex-dump, -x
Paul Semelb98f5042018-07-11 10:00:29 +0000187 cl::list<std::string> HexDump("hex-dump", cl::desc("<number|name>"),
188 cl::ZeroOrMore);
189 cl::alias HexDumpShort("x", cl::desc("Alias for --hex-dump"),
Jordan Rupprecht342aaa12019-03-29 16:43:13 +0000190 cl::aliasopt(HexDump), cl::Prefix);
Paul Semelb98f5042018-07-11 10:00:29 +0000191
Fangrui Songe29e30b2019-05-01 05:27:20 +0000192 // --demangle, -C
James Hendersone50d9cb2019-01-17 15:34:12 +0000193 cl::opt<bool> Demangle("demangle",
194 cl::desc("Demangle symbol names in output"));
195 cl::alias DemangleShort("C", cl::desc("Alias for --demangle"),
196 cl::aliasopt(Demangle), cl::NotHidden);
197
Fangrui Songe29e30b2019-05-01 05:27:20 +0000198 // --hash-table
Michael J. Spencer20546ff2015-07-09 22:32:24 +0000199 cl::opt<bool> HashTable("hash-table",
200 cl::desc("Display ELF hash table"));
201
Fangrui Songe29e30b2019-05-01 05:27:20 +0000202 // --gnu-hash-table
Igor Kudrin496fb2f2015-10-14 12:11:50 +0000203 cl::opt<bool> GnuHashTable("gnu-hash-table",
204 cl::desc("Display ELF .gnu.hash section"));
205
Fangrui Songe29e30b2019-05-01 05:27:20 +0000206 // --expand-relocs
Nico Rieckf3f0b792013-04-12 04:01:52 +0000207 cl::opt<bool> ExpandRelocs("expand-relocs",
208 cl::desc("Expand each shown relocation to multiple lines"));
Timur Iskhodzhanov48703be2013-12-19 11:37:14 +0000209
Fangrui Songe29e30b2019-05-01 05:27:20 +0000210 // --raw-relr
Jake Ehrlich0f440d82018-06-28 21:07:34 +0000211 cl::opt<bool> RawRelr("raw-relr",
212 cl::desc("Do not decode relocations in SHT_RELR section, display raw contents"));
213
Fangrui Songe29e30b2019-05-01 05:27:20 +0000214 // --codeview
Zachary Turner99f02152015-02-18 19:32:05 +0000215 cl::opt<bool> CodeView("codeview",
216 cl::desc("Display CodeView debug information"));
217
Fangrui Songe29e30b2019-05-01 05:27:20 +0000218 // --codeview-merged-types
Reid Kleckner0b269742016-05-14 00:02:53 +0000219 cl::opt<bool>
220 CodeViewMergedTypes("codeview-merged-types",
221 cl::desc("Display the merged CodeView type stream"));
222
Fangrui Songe29e30b2019-05-01 05:27:20 +0000223 // --codeview-ghash
Alexandre Ganea120366e2019-02-07 15:24:18 +0000224 cl::opt<bool> CodeViewEnableGHash(
225 "codeview-ghash",
226 cl::desc(
227 "Enable global hashing for CodeView type stream de-duplication"));
228
Fangrui Songe29e30b2019-05-01 05:27:20 +0000229 // --codeview-subsection-bytes
Zachary Turner99f02152015-02-18 19:32:05 +0000230 cl::opt<bool> CodeViewSubsectionBytes(
231 "codeview-subsection-bytes",
232 cl::desc("Dump raw contents of codeview debug sections and records"));
Saleem Abdulrasool15d16d82014-01-30 04:46:33 +0000233
Fangrui Songe29e30b2019-05-01 05:27:20 +0000234 // --arm-attributes
Saleem Abdulrasool15d16d82014-01-30 04:46:33 +0000235 cl::opt<bool> ARMAttributes("arm-attributes",
236 cl::desc("Display the ARM attributes section"));
Simon Atanasyan80433902014-06-18 08:47:09 +0000237
Fangrui Songe29e30b2019-05-01 05:27:20 +0000238 // --mips-plt-got
Simon Atanasyan80433902014-06-18 08:47:09 +0000239 cl::opt<bool>
240 MipsPLTGOT("mips-plt-got",
241 cl::desc("Display the MIPS GOT and PLT GOT sections"));
Rui Ueyama1e152d52014-10-02 17:02:18 +0000242
Fangrui Songe29e30b2019-05-01 05:27:20 +0000243 // --mips-abi-flags
Simon Atanasyanc914de22015-05-07 15:40:35 +0000244 cl::opt<bool> MipsABIFlags("mips-abi-flags",
245 cl::desc("Display the MIPS.abiflags section"));
246
Fangrui Songe29e30b2019-05-01 05:27:20 +0000247 // --mips-reginfo
Simon Atanasyan6e07e932015-06-16 21:47:43 +0000248 cl::opt<bool> MipsReginfo("mips-reginfo",
249 cl::desc("Display the MIPS .reginfo section"));
250
Fangrui Songe29e30b2019-05-01 05:27:20 +0000251 // --mips-options
Simon Atanasyan8a71b532016-05-04 05:58:57 +0000252 cl::opt<bool> MipsOptions("mips-options",
253 cl::desc("Display the MIPS .MIPS.options section"));
254
Fangrui Songe29e30b2019-05-01 05:27:20 +0000255 // --coff-imports
Rui Ueyama1e152d52014-10-02 17:02:18 +0000256 cl::opt<bool>
257 COFFImports("coff-imports", cl::desc("Display the PE/COFF import table"));
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +0000258
Fangrui Songe29e30b2019-05-01 05:27:20 +0000259 // --coff-exports
Saleem Abdulrasoolddd92642015-01-03 21:35:09 +0000260 cl::opt<bool>
261 COFFExports("coff-exports", cl::desc("Display the PE/COFF export table"));
262
Fangrui Songe29e30b2019-05-01 05:27:20 +0000263 // --coff-directives
Saleem Abdulrasoolf9578632014-10-07 19:37:52 +0000264 cl::opt<bool>
265 COFFDirectives("coff-directives",
Rui Ueyama74e85132014-11-19 00:18:07 +0000266 cl::desc("Display the PE/COFF .drectve section"));
267
Fangrui Songe29e30b2019-05-01 05:27:20 +0000268 // --coff-basereloc
Rui Ueyama74e85132014-11-19 00:18:07 +0000269 cl::opt<bool>
270 COFFBaseRelocs("coff-basereloc",
271 cl::desc("Display the PE/COFF .reloc section"));
Lang Hames0000afd2015-06-26 23:56:53 +0000272
Fangrui Songe29e30b2019-05-01 05:27:20 +0000273 // --coff-debug-directory
Reid Kleckner2da433e2016-06-02 17:10:43 +0000274 cl::opt<bool>
275 COFFDebugDirectory("coff-debug-directory",
276 cl::desc("Display the PE/COFF debug directory"));
277
Fangrui Songe29e30b2019-05-01 05:27:20 +0000278 // --coff-resources
Zachary Turner8d6396d2017-04-27 19:38:38 +0000279 cl::opt<bool> COFFResources("coff-resources",
280 cl::desc("Display the PE/COFF .rsrc section"));
281
Fangrui Songe29e30b2019-05-01 05:27:20 +0000282 // --coff-load-config
Reid Klecknerb7d716c2017-06-22 01:10:29 +0000283 cl::opt<bool>
284 COFFLoadConfig("coff-load-config",
285 cl::desc("Display the PE/COFF load config"));
286
Fangrui Songe29e30b2019-05-01 05:27:20 +0000287 // --elf-linker-options
Saleem Abdulrasoolb36fbbc2018-01-30 16:29:29 +0000288 cl::opt<bool>
289 ELFLinkerOptions("elf-linker-options",
290 cl::desc("Display the ELF .linker-options section"));
291
Fangrui Songe29e30b2019-05-01 05:27:20 +0000292 // --macho-data-in-code
Davide Italiano07e7acb2015-08-21 20:28:30 +0000293 cl::opt<bool>
294 MachODataInCode("macho-data-in-code",
295 cl::desc("Display MachO Data in Code command"));
296
Fangrui Songe29e30b2019-05-01 05:27:20 +0000297 // --macho-indirect-symbols
Davide Italiano4410b222015-09-03 18:10:28 +0000298 cl::opt<bool>
299 MachOIndirectSymbols("macho-indirect-symbols",
300 cl::desc("Display MachO indirect symbols"));
301
Fangrui Songe29e30b2019-05-01 05:27:20 +0000302 // --macho-linker-options
Davide Italiano9a429b72015-09-09 00:21:18 +0000303 cl::opt<bool>
304 MachOLinkerOptions("macho-linker-options",
305 cl::desc("Display MachO linker options"));
306
Fangrui Songe29e30b2019-05-01 05:27:20 +0000307 // --macho-segment
Davide Italianod1f09962015-09-02 16:24:24 +0000308 cl::opt<bool>
309 MachOSegment("macho-segment",
310 cl::desc("Display MachO Segment command"));
311
Fangrui Songe29e30b2019-05-01 05:27:20 +0000312 // --macho-version-min
Davide Italiano976f4da2015-08-27 15:11:32 +0000313 cl::opt<bool>
314 MachOVersionMin("macho-version-min",
315 cl::desc("Display MachO version min command"));
Davide Italiano35eebe12015-08-31 19:32:31 +0000316
Fangrui Songe29e30b2019-05-01 05:27:20 +0000317 // --macho-dysymtab
Davide Italiano35eebe12015-08-31 19:32:31 +0000318 cl::opt<bool>
319 MachODysymtab("macho-dysymtab",
320 cl::desc("Display MachO Dysymtab command"));
321
Fangrui Songe29e30b2019-05-01 05:27:20 +0000322 // --stackmap
Lang Hames0000afd2015-06-26 23:56:53 +0000323 cl::opt<bool>
324 PrintStackMap("stackmap",
325 cl::desc("Display contents of stackmap section"));
326
Fangrui Songe29e30b2019-05-01 05:27:20 +0000327 // --version-info, -V
Davide Italiano4f05f322015-10-16 23:19:01 +0000328 cl::opt<bool>
329 VersionInfo("version-info",
330 cl::desc("Display ELF version sections (if present)"));
331 cl::alias VersionInfoShort("V", cl::desc("Alias for -version-info"),
332 cl::aliasopt(VersionInfo));
Hemant Kulkarniab4a46f2016-01-26 19:46:39 +0000333
Fangrui Songe29e30b2019-05-01 05:27:20 +0000334 // --elf-section-groups, --section-groups, -g
Hemant Kulkarniab4a46f2016-01-26 19:46:39 +0000335 cl::opt<bool> SectionGroups("elf-section-groups",
336 cl::desc("Display ELF section group contents"));
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000337 cl::alias SectionGroupsAlias("section-groups",
338 cl::desc("Alias for -elf-sections-groups"),
339 cl::aliasopt(SectionGroups));
Hemant Kulkarniab4a46f2016-01-26 19:46:39 +0000340 cl::alias SectionGroupsShort("g", cl::desc("Alias for -elf-sections-groups"),
341 cl::aliasopt(SectionGroups));
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000342
Fangrui Songe29e30b2019-05-01 05:27:20 +0000343 // --elf-hash-histogram, --histogram, -I
Hemant Kulkarni9b1b7f02016-04-11 17:15:30 +0000344 cl::opt<bool> HashHistogram(
345 "elf-hash-histogram",
346 cl::desc("Display bucket list histogram for hash sections"));
347 cl::alias HashHistogramShort("I", cl::desc("Alias for -elf-hash-histogram"),
348 cl::aliasopt(HashHistogram));
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000349 cl::alias HistogramAlias("histogram",
350 cl::desc("Alias for --elf-hash-histogram"),
351 cl::aliasopt(HashHistogram));
Hemant Kulkarniab4a46f2016-01-26 19:46:39 +0000352
Fangrui Songe29e30b2019-05-01 05:27:20 +0000353 // --elf-cg-profile
Michael J. Spencerae6eeae2018-06-02 16:33:01 +0000354 cl::opt<bool> CGProfile("elf-cg-profile", cl::desc("Display callgraph profile section"));
355
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000356 // -addrsig
Peter Collingbournebc3089f2018-08-22 23:58:16 +0000357 cl::opt<bool> Addrsig("addrsig",
Peter Collingbourne3e227332018-07-17 22:17:18 +0000358 cl::desc("Display address-significance table"));
359
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000360 // -elf-output-style
Tim Northoverd59b23a2016-03-01 21:45:22 +0000361 cl::opt<OutputStyleTy>
Hemant Kulkarnid8a985e2016-02-10 20:40:55 +0000362 Output("elf-output-style", cl::desc("Specify ELF dump style"),
363 cl::values(clEnumVal(LLVM, "LLVM default style"),
Mehdi Amini732afdd2016-10-08 19:41:06 +0000364 clEnumVal(GNU, "GNU readelf style")),
Hemant Kulkarnid8a985e2016-02-10 20:40:55 +0000365 cl::init(LLVM));
James Henderson9485b262019-06-21 11:49:20 +0000366
367 cl::extrahelp
368 HelpResponse("\nPass @FILE as argument to read options from FILE.\n");
Eric Christopher9cad53c2013-04-03 18:31:38 +0000369} // namespace opts
370
Rafael Espindola00ddb142015-07-20 03:38:17 +0000371namespace llvm {
372
Davide Italiano1eb92342015-12-04 19:29:49 +0000373LLVM_ATTRIBUTE_NORETURN void reportError(Twine Msg) {
George Rimara1370872019-07-16 11:07:30 +0000374 fouts().flush();
Stephen Tozer19bb1d52019-04-15 11:17:48 +0000375 errs() << "\n";
376 WithColor::error(errs()) << Msg << "\n";
Rafael Espindolafb3acd62015-07-20 03:23:55 +0000377 exit(1);
Rafael Espindola724d4b42015-07-20 03:01:49 +0000378}
379
George Rimara1370872019-07-16 11:07:30 +0000380void reportError(StringRef Input, Error Err) {
381 if (Input == "-")
382 Input = "<stdin>";
383 error(createFileError(Input, std::move(Err)));
384}
385
George Rimar72f821d2019-05-20 15:41:48 +0000386void reportWarning(Twine Msg) {
George Rimarbadece02019-07-11 12:26:48 +0000387 fouts().flush();
George Rimar72f821d2019-05-20 15:41:48 +0000388 errs() << "\n";
389 WithColor::warning(errs()) << Msg << "\n";
390}
391
George Rimardd4f2532019-06-10 14:23:46 +0000392void warn(Error Err) {
393 handleAllErrors(std::move(Err), [&](const ErrorInfoBase &EI) {
394 reportWarning(EI.message());
395 });
396}
397
Zachary Turner5e3e4bb2016-08-05 21:45:34 +0000398void error(Error EC) {
Zachary Turner660230e2016-08-04 19:39:55 +0000399 if (!EC)
400 return;
Zachary Turner660230e2016-08-04 19:39:55 +0000401 handleAllErrors(std::move(EC),
Zachary Turner5e3e4bb2016-08-05 21:45:34 +0000402 [&](const ErrorInfoBase &EI) { reportError(EI.message()); });
Zachary Turner660230e2016-08-04 19:39:55 +0000403}
404
Rafael Espindolafb3acd62015-07-20 03:23:55 +0000405void error(std::error_code EC) {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000406 if (!EC)
Rafael Espindolafb3acd62015-07-20 03:23:55 +0000407 return;
Rafael Espindola8b3b09f2015-08-06 21:54:37 +0000408 reportError(EC.message());
Rafael Espindola144af2c2012-12-31 16:05:21 +0000409}
410
Eric Christopher9cad53c2013-04-03 18:31:38 +0000411} // namespace llvm
412
Stephen Tozer19bb1d52019-04-15 11:17:48 +0000413static void reportError(StringRef Input, std::error_code EC) {
414 reportError(Input, errorCodeToError(EC));
Lang Hamesfc209622016-07-14 02:24:01 +0000415}
416
Simon Atanasyan80433902014-06-18 08:47:09 +0000417static bool isMipsArch(unsigned Arch) {
418 switch (Arch) {
419 case llvm::Triple::mips:
420 case llvm::Triple::mipsel:
421 case llvm::Triple::mips64:
422 case llvm::Triple::mips64el:
423 return true;
424 default:
425 return false;
426 }
427}
Zachary Turnerc6d54da2016-09-09 17:46:17 +0000428namespace {
Zachary Turner4efa0a42016-11-08 22:24:53 +0000429struct ReadObjTypeTableBuilder {
Reid Kleckner5d577522017-03-24 17:26:38 +0000430 ReadObjTypeTableBuilder()
Alexandre Ganea120366e2019-02-07 15:24:18 +0000431 : Allocator(), IDTable(Allocator), TypeTable(Allocator),
432 GlobalIDTable(Allocator), GlobalTypeTable(Allocator) {}
Simon Atanasyan80433902014-06-18 08:47:09 +0000433
Zachary Turnerc6d54da2016-09-09 17:46:17 +0000434 llvm::BumpPtrAllocator Allocator;
Zachary Turnerca6dbf12017-11-30 18:39:50 +0000435 llvm::codeview::MergingTypeTableBuilder IDTable;
436 llvm::codeview::MergingTypeTableBuilder TypeTable;
Alexandre Ganea120366e2019-02-07 15:24:18 +0000437 llvm::codeview::GlobalTypeTableBuilder GlobalIDTable;
438 llvm::codeview::GlobalTypeTableBuilder GlobalTypeTable;
439 std::vector<OwningBinary<Binary>> Binaries;
Zachary Turnerc6d54da2016-09-09 17:46:17 +0000440};
Alexandre Ganea120366e2019-02-07 15:24:18 +0000441} // namespace
Zachary Turner4efa0a42016-11-08 22:24:53 +0000442static ReadObjTypeTableBuilder CVTypes;
Reid Kleckner0b269742016-05-14 00:02:53 +0000443
Adrian Prantl4dfcc4a2018-05-01 16:10:38 +0000444/// Creates an format-specific object file dumper.
Zachary Turner88bb1632016-05-03 00:28:04 +0000445static std::error_code createDumper(const ObjectFile *Obj,
446 ScopedPrinter &Writer,
Rafael Espindola4453e42942014-06-13 03:07:50 +0000447 std::unique_ptr<ObjDumper> &Result) {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000448 if (!Obj)
449 return readobj_error::unsupported_file_format;
450
451 if (Obj->isCOFF())
452 return createCOFFDumper(Obj, Writer, Result);
453 if (Obj->isELF())
454 return createELFDumper(Obj, Writer, Result);
455 if (Obj->isMachO())
456 return createMachODumper(Obj, Writer, Result);
Derek Schuff6d76b7b2017-01-30 23:30:52 +0000457 if (Obj->isWasm())
458 return createWasmDumper(Obj, Writer, Result);
Sean Fertilefd75ee92019-05-03 12:57:07 +0000459 if (Obj->isXCOFF())
460 return createXCOFFDumper(Obj, Writer, Result);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000461
462 return readobj_error::unsupported_obj_file_format;
463}
464
Adrian Prantl4dfcc4a2018-05-01 16:10:38 +0000465/// Dumps the specified object file.
Yuanfang Chena28dcf62019-07-15 22:52:01 +0000466static void dumpObject(const ObjectFile *Obj, ScopedPrinter &Writer,
467 const Archive *A = nullptr) {
468 std::string FileStr =
469 A ? Twine(A->getFileName() + "(" + Obj->getFileName() + ")").str()
470 : Obj->getFileName().str();
471
Ahmed Charles56440fd2014-03-06 05:51:42 +0000472 std::unique_ptr<ObjDumper> Dumper;
Davide Italianoe66b73f2015-12-05 23:36:52 +0000473 if (std::error_code EC = createDumper(Obj, Writer, Dumper))
Yuanfang Chena28dcf62019-07-15 22:52:01 +0000474 reportError(FileStr, EC);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000475
Yuanfang Chena28dcf62019-07-15 22:52:01 +0000476 Writer.startLine() << "\n";
Hemant Kulkarnid8a985e2016-02-10 20:40:55 +0000477 if (opts::Output == opts::LLVM) {
Yuanfang Chena28dcf62019-07-15 22:52:01 +0000478 Writer.printString("File", FileStr);
Sam Clegg88e9a152018-01-10 00:14:19 +0000479 Writer.printString("Format", Obj->getFileFormatName());
480 Writer.printString("Arch", Triple::getArchTypeName(
481 (llvm::Triple::ArchType)Obj->getArch()));
482 Writer.printString("AddressSize",
483 formatv("{0}bit", 8 * Obj->getBytesInAddress()));
Hemant Kulkarnid8a985e2016-02-10 20:40:55 +0000484 Dumper->printLoadName();
Yuanfang Chena28dcf62019-07-15 22:52:01 +0000485 } else if (opts::Output == opts::GNU && A) {
486 Writer.printString("File", FileStr);
Hemant Kulkarnid8a985e2016-02-10 20:40:55 +0000487 }
Eric Christopher9cad53c2013-04-03 18:31:38 +0000488
489 if (opts::FileHeaders)
490 Dumper->printFileHeaders();
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000491 if (opts::SectionHeaders)
492 Dumper->printSectionHeaders();
Eric Christopher9cad53c2013-04-03 18:31:38 +0000493 if (opts::Relocations)
494 Dumper->printRelocations();
Michael J. Spencer594c0282015-06-25 21:47:32 +0000495 if (opts::DynRelocs)
496 Dumper->printDynamicRelocations();
James Henderson21ed8682019-01-23 16:15:39 +0000497 if (opts::Symbols || opts::DynamicSymbols)
498 Dumper->printSymbols(opts::Symbols, opts::DynamicSymbols);
James Henderson5fc812f2019-01-22 09:35:35 +0000499 if (opts::HashSymbols)
500 Dumper->printHashSymbols();
Eric Christopher9cad53c2013-04-03 18:31:38 +0000501 if (opts::UnwindInfo)
502 Dumper->printUnwindInfo();
503 if (opts::DynamicTable)
504 Dumper->printDynamicTable();
505 if (opts::NeededLibraries)
506 Dumper->printNeededLibraries();
Matt Davis50ca8ed2019-02-01 18:51:10 +0000507 if (opts::ProgramHeaders || opts::SectionMapping == cl::BOU_TRUE)
508 Dumper->printProgramHeaders(opts::ProgramHeaders, opts::SectionMapping);
Paul Semelfa5597b2018-06-15 14:15:02 +0000509 if (!opts::StringDump.empty())
Fangrui Song67742392019-06-18 14:01:03 +0000510 Dumper->printSectionsAsString(Obj, opts::StringDump);
Paul Semelb98f5042018-07-11 10:00:29 +0000511 if (!opts::HexDump.empty())
Fangrui Song67742392019-06-18 14:01:03 +0000512 Dumper->printSectionsAsHex(Obj, opts::HexDump);
Michael J. Spencer20546ff2015-07-09 22:32:24 +0000513 if (opts::HashTable)
514 Dumper->printHashTable();
Igor Kudrin496fb2f2015-10-14 12:11:50 +0000515 if (opts::GnuHashTable)
516 Dumper->printGnuHashTable();
Davide Italiano4f05f322015-10-16 23:19:01 +0000517 if (opts::VersionInfo)
518 Dumper->printVersionInfo();
Hemant Kulkarniab4a46f2016-01-26 19:46:39 +0000519 if (Obj->isELF()) {
Saleem Abdulrasoolb36fbbc2018-01-30 16:29:29 +0000520 if (opts::ELFLinkerOptions)
521 Dumper->printELFLinkerOptions();
Hemant Kulkarniab4a46f2016-01-26 19:46:39 +0000522 if (Obj->getArch() == llvm::Triple::arm)
523 if (opts::ARMAttributes)
524 Dumper->printAttributes();
525 if (isMipsArch(Obj->getArch())) {
526 if (opts::MipsPLTGOT)
527 Dumper->printMipsPLTGOT();
528 if (opts::MipsABIFlags)
529 Dumper->printMipsABIFlags();
530 if (opts::MipsReginfo)
531 Dumper->printMipsReginfo();
Simon Atanasyan8a71b532016-05-04 05:58:57 +0000532 if (opts::MipsOptions)
533 Dumper->printMipsOptions();
Hemant Kulkarniab4a46f2016-01-26 19:46:39 +0000534 }
535 if (opts::SectionGroups)
536 Dumper->printGroupSections();
Hemant Kulkarni9b1b7f02016-04-11 17:15:30 +0000537 if (opts::HashHistogram)
538 Dumper->printHashHistogram();
Michael J. Spencerae6eeae2018-06-02 16:33:01 +0000539 if (opts::CGProfile)
540 Dumper->printCGProfile();
Peter Collingbourne3e227332018-07-17 22:17:18 +0000541 if (opts::Addrsig)
542 Dumper->printAddrsig();
Saleem Abdulrasool6a405442016-08-30 18:52:02 +0000543 if (opts::Notes)
544 Dumper->printNotes();
Simon Atanasyanc914de22015-05-07 15:40:35 +0000545 }
Davide Italianocd1b6db2015-07-24 02:14:20 +0000546 if (Obj->isCOFF()) {
547 if (opts::COFFImports)
548 Dumper->printCOFFImports();
549 if (opts::COFFExports)
550 Dumper->printCOFFExports();
551 if (opts::COFFDirectives)
552 Dumper->printCOFFDirectives();
553 if (opts::COFFBaseRelocs)
554 Dumper->printCOFFBaseReloc();
Reid Kleckner2da433e2016-06-02 17:10:43 +0000555 if (opts::COFFDebugDirectory)
556 Dumper->printCOFFDebugDirectory();
Zachary Turner8d6396d2017-04-27 19:38:38 +0000557 if (opts::COFFResources)
558 Dumper->printCOFFResources();
Reid Klecknerb7d716c2017-06-22 01:10:29 +0000559 if (opts::COFFLoadConfig)
560 Dumper->printCOFFLoadConfig();
Peter Collingbournebc3089f2018-08-22 23:58:16 +0000561 if (opts::Addrsig)
562 Dumper->printAddrsig();
Reid Kleckner83ebad32015-12-16 18:28:12 +0000563 if (opts::CodeView)
564 Dumper->printCodeViewDebugInfo();
Reid Kleckner0b269742016-05-14 00:02:53 +0000565 if (opts::CodeViewMergedTypes)
Alexandre Ganea120366e2019-02-07 15:24:18 +0000566 Dumper->mergeCodeViewTypes(CVTypes.IDTable, CVTypes.TypeTable,
567 CVTypes.GlobalIDTable, CVTypes.GlobalTypeTable,
568 opts::CodeViewEnableGHash);
Davide Italianocd1b6db2015-07-24 02:14:20 +0000569 }
Davide Italiano1e12fc42015-08-31 17:12:23 +0000570 if (Obj->isMachO()) {
Davide Italiano07e7acb2015-08-21 20:28:30 +0000571 if (opts::MachODataInCode)
572 Dumper->printMachODataInCode();
Davide Italiano4410b222015-09-03 18:10:28 +0000573 if (opts::MachOIndirectSymbols)
574 Dumper->printMachOIndirectSymbols();
Davide Italiano9a429b72015-09-09 00:21:18 +0000575 if (opts::MachOLinkerOptions)
576 Dumper->printMachOLinkerOptions();
Davide Italianod1f09962015-09-02 16:24:24 +0000577 if (opts::MachOSegment)
578 Dumper->printMachOSegment();
Davide Italiano976f4da2015-08-27 15:11:32 +0000579 if (opts::MachOVersionMin)
580 Dumper->printMachOVersionMin();
Davide Italiano35eebe12015-08-31 19:32:31 +0000581 if (opts::MachODysymtab)
582 Dumper->printMachODysymtab();
Davide Italiano1e12fc42015-08-31 17:12:23 +0000583 }
Lang Hames0000afd2015-06-26 23:56:53 +0000584 if (opts::PrintStackMap)
585 Dumper->printStackMap();
Rafael Espindola21bd8412012-12-31 16:29:44 +0000586}
587
Adrian Prantl4dfcc4a2018-05-01 16:10:38 +0000588/// Dumps each object file in \a Arc;
Sam Clegg88e9a152018-01-10 00:14:19 +0000589static void dumpArchive(const Archive *Arc, ScopedPrinter &Writer) {
Mehdi Amini41af4302016-11-11 04:28:40 +0000590 Error Err = Error::success();
Lang Hamesfc209622016-07-14 02:24:01 +0000591 for (auto &Child : Arc->children(Err)) {
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000592 Expected<std::unique_ptr<Binary>> ChildOrErr = Child.getAsBinary();
593 if (!ChildOrErr) {
594 if (auto E = isNotObjectErrorInvalidFileType(ChildOrErr.takeError())) {
James Henderson5b274022019-02-27 11:07:08 +0000595 reportError(Arc->getFileName(), std::move(E));
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000596 }
Eric Christopher9cad53c2013-04-03 18:31:38 +0000597 continue;
David Meyer6c614bf2012-03-09 20:59:52 +0000598 }
Rafael Espindolaae460022014-06-16 16:08:36 +0000599 if (ObjectFile *Obj = dyn_cast<ObjectFile>(&*ChildOrErr.get()))
Yuanfang Chena28dcf62019-07-15 22:52:01 +0000600 dumpObject(Obj, Writer, Arc);
Saleem Abdulrasool3780b3a2016-08-18 14:32:11 +0000601 else if (COFFImportFile *Imp = dyn_cast<COFFImportFile>(&*ChildOrErr.get()))
Sam Clegg88e9a152018-01-10 00:14:19 +0000602 dumpCOFFImportFile(Imp, Writer);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000603 else
604 reportError(Arc->getFileName(), readobj_error::unrecognized_file_format);
605 }
Lang Hamesfc209622016-07-14 02:24:01 +0000606 if (Err)
607 reportError(Arc->getFileName(), std::move(Err));
Eric Christopher9cad53c2013-04-03 18:31:38 +0000608}
609
Adrian Prantl4dfcc4a2018-05-01 16:10:38 +0000610/// Dumps each object file in \a MachO Universal Binary;
Sam Clegg88e9a152018-01-10 00:14:19 +0000611static void dumpMachOUniversalBinary(const MachOUniversalBinary *UBinary,
612 ScopedPrinter &Writer) {
Rafael Espindola8448a242015-03-24 20:26:55 +0000613 for (const MachOUniversalBinary::ObjectForArch &Obj : UBinary->objects()) {
Kevin Enderby9acb1092016-05-31 20:35:34 +0000614 Expected<std::unique_ptr<MachOObjectFile>> ObjOrErr = Obj.getAsObjectFile();
David Blaikie29ac43c2015-04-13 16:05:49 +0000615 if (ObjOrErr)
Sam Clegg88e9a152018-01-10 00:14:19 +0000616 dumpObject(&*ObjOrErr.get(), Writer);
Kevin Enderby9acb1092016-05-31 20:35:34 +0000617 else if (auto E = isNotObjectErrorInvalidFileType(ObjOrErr.takeError())) {
Sam Cleggc0d76642017-05-10 14:18:11 +0000618 reportError(UBinary->getFileName(), ObjOrErr.takeError());
Kevin Enderby9acb1092016-05-31 20:35:34 +0000619 }
Kevin Enderby42398052016-06-28 23:16:13 +0000620 else if (Expected<std::unique_ptr<Archive>> AOrErr = Obj.getAsArchive())
Sam Clegg88e9a152018-01-10 00:14:19 +0000621 dumpArchive(&*AOrErr.get(), Writer);
Rafael Espindola8448a242015-03-24 20:26:55 +0000622 }
623}
Eric Christopher9cad53c2013-04-03 18:31:38 +0000624
Adrian Prantl4dfcc4a2018-05-01 16:10:38 +0000625/// Dumps \a WinRes, Windows Resource (.res) file;
Jordan Rupprecht565f1e22019-06-12 20:16:22 +0000626static void dumpWindowsResourceFile(WindowsResource *WinRes,
627 ScopedPrinter &Printer) {
Marek Sokolowskic2189b82017-09-20 18:33:35 +0000628 WindowsRes::Dumper Dumper(WinRes, Printer);
629 if (auto Err = Dumper.printData())
630 reportError(WinRes->getFileName(), std::move(Err));
631}
632
633
Adrian Prantl4dfcc4a2018-05-01 16:10:38 +0000634/// Opens \a File and dumps it.
Jordan Rupprecht565f1e22019-06-12 20:16:22 +0000635static void dumpInput(StringRef File, ScopedPrinter &Writer) {
Eric Christopher9cad53c2013-04-03 18:31:38 +0000636 // Attempt to open the binary.
Kevin Enderby3fcdf6a2016-04-06 22:14:09 +0000637 Expected<OwningBinary<Binary>> BinaryOrErr = createBinary(File);
638 if (!BinaryOrErr)
Sam Cleggc0d76642017-05-10 14:18:11 +0000639 reportError(File, BinaryOrErr.takeError());
Rafael Espindola48af1c22014-08-19 18:44:46 +0000640 Binary &Binary = *BinaryOrErr.get().getBinary();
Eric Christopher9cad53c2013-04-03 18:31:38 +0000641
Rafael Espindola3f6481d2014-08-01 14:31:55 +0000642 if (Archive *Arc = dyn_cast<Archive>(&Binary))
Sam Clegg88e9a152018-01-10 00:14:19 +0000643 dumpArchive(Arc, Writer);
Rafael Espindola8448a242015-03-24 20:26:55 +0000644 else if (MachOUniversalBinary *UBinary =
645 dyn_cast<MachOUniversalBinary>(&Binary))
Sam Clegg88e9a152018-01-10 00:14:19 +0000646 dumpMachOUniversalBinary(UBinary, Writer);
Rafael Espindola3f6481d2014-08-01 14:31:55 +0000647 else if (ObjectFile *Obj = dyn_cast<ObjectFile>(&Binary))
Sam Clegg88e9a152018-01-10 00:14:19 +0000648 dumpObject(Obj, Writer);
Rui Ueyama71ba9bd2015-08-28 07:40:30 +0000649 else if (COFFImportFile *Import = dyn_cast<COFFImportFile>(&Binary))
Sam Clegg88e9a152018-01-10 00:14:19 +0000650 dumpCOFFImportFile(Import, Writer);
Marek Sokolowskic2189b82017-09-20 18:33:35 +0000651 else if (WindowsResource *WinRes = dyn_cast<WindowsResource>(&Binary))
Jordan Rupprecht565f1e22019-06-12 20:16:22 +0000652 dumpWindowsResourceFile(WinRes, Writer);
Eric Christopher9cad53c2013-04-03 18:31:38 +0000653 else
654 reportError(File, readobj_error::unrecognized_file_format);
Alexandre Ganea120366e2019-02-07 15:24:18 +0000655
656 CVTypes.Binaries.push_back(std::move(*BinaryOrErr));
Rafael Espindola21bd8412012-12-31 16:29:44 +0000657}
658
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000659/// Registers aliases that should only be allowed by readobj.
660static void registerReadobjAliases() {
661 // -s has meant --sections for a very long time in llvm-readobj despite
662 // meaning --symbols in readelf.
663 static cl::alias SectionsShort("s", cl::desc("Alias for --section-headers"),
664 cl::aliasopt(opts::SectionHeaders),
665 cl::NotHidden);
666
667 // Only register -t in llvm-readobj, as readelf reserves it for
668 // --section-details (not implemented yet).
669 static cl::alias SymbolsShort("t", cl::desc("Alias for --symbols"),
670 cl::aliasopt(opts::Symbols), cl::NotHidden);
Jordan Rupprecht58aac952019-01-15 17:04:40 +0000671
672 // The following two-letter aliases are only provided for readobj, as readelf
673 // allows single-letter args to be grouped together.
674 static cl::alias SectionRelocationsShort(
675 "sr", cl::desc("Alias for --section-relocations"),
676 cl::aliasopt(opts::SectionRelocations));
677 static cl::alias SectionDataShort("sd", cl::desc("Alias for --section-data"),
678 cl::aliasopt(opts::SectionData));
679 static cl::alias SectionSymbolsShort("st",
680 cl::desc("Alias for --section-symbols"),
681 cl::aliasopt(opts::SectionSymbols));
682 static cl::alias DynamicSymbolsShort("dt",
683 cl::desc("Alias for --dyn-symbols"),
684 cl::aliasopt(opts::DynamicSymbols));
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000685}
686
687/// Registers aliases that should only be allowed by readelf.
688static void registerReadelfAliases() {
689 // -s is here because for readobj it means --sections.
690 static cl::alias SymbolsShort("s", cl::desc("Alias for --symbols"),
Jordan Rupprecht58aac952019-01-15 17:04:40 +0000691 cl::aliasopt(opts::Symbols), cl::NotHidden,
692 cl::Grouping);
693
694 // Allow all single letter flags to be grouped together.
695 for (auto &OptEntry : cl::getRegisteredOptions()) {
696 StringRef ArgName = OptEntry.getKey();
697 cl::Option *Option = OptEntry.getValue();
698 if (ArgName.size() == 1)
Igor Kudrina38432c2019-03-01 09:22:42 +0000699 apply(Option, cl::Grouping);
Jordan Rupprecht58aac952019-01-15 17:04:40 +0000700 }
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000701}
702
Eric Christopher9cad53c2013-04-03 18:31:38 +0000703int main(int argc, const char *argv[]) {
Rui Ueyama197194b2018-04-13 18:26:06 +0000704 InitLLVM X(argc, argv);
David Meyer2fc34c52012-03-01 01:36:50 +0000705
Eric Christopher9cad53c2013-04-03 18:31:38 +0000706 // Register the target printer for --version.
707 cl::AddExtraVersionPrinter(TargetRegistry::printRegisteredTargetsForVersion);
David Meyer2fc34c52012-03-01 01:36:50 +0000708
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000709 if (sys::path::stem(argv[0]).contains("readelf")) {
Petr Hosekbf515502017-07-19 02:09:37 +0000710 opts::Output = opts::GNU;
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000711 registerReadelfAliases();
712 } else {
713 registerReadobjAliases();
714 }
Petr Hosekbf515502017-07-19 02:09:37 +0000715
Eric Christopher9cad53c2013-04-03 18:31:38 +0000716 cl::ParseCommandLineOptions(argc, argv, "LLVM Object Reader\n");
David Meyer2fc34c52012-03-01 01:36:50 +0000717
Jordan Rupprechtdbf552c2018-11-12 18:02:38 +0000718 if (opts::All) {
719 opts::FileHeaders = true;
720 opts::ProgramHeaders = true;
721 opts::SectionHeaders = true;
722 opts::Symbols = true;
723 opts::Relocations = true;
724 opts::DynamicTable = true;
725 opts::Notes = true;
726 opts::VersionInfo = true;
727 opts::UnwindInfo = true;
728 opts::SectionGroups = true;
729 opts::HashHistogram = true;
730 }
731
Sid Manning4afeaac2018-12-11 16:15:03 +0000732 if (opts::Headers) {
733 opts::FileHeaders = true;
734 opts::ProgramHeaders = true;
735 opts::SectionHeaders = true;
736 }
737
Eric Christopher9cad53c2013-04-03 18:31:38 +0000738 // Default to stdin if no filename is specified.
Jordan Rupprecht16a0de22018-12-20 00:57:06 +0000739 if (opts::InputFilenames.empty())
Zachary Turner123ef632017-11-30 18:33:34 +0000740 opts::InputFilenames.push_back("-");
741
Jordan Rupprecht565f1e22019-06-12 20:16:22 +0000742 ScopedPrinter Writer(fouts());
743 for (const std::string &I : opts::InputFilenames)
744 dumpInput(I, Writer);
Zachary Turner123ef632017-11-30 18:33:34 +0000745
746 if (opts::CodeViewMergedTypes) {
Alexandre Ganea120366e2019-02-07 15:24:18 +0000747 if (opts::CodeViewEnableGHash)
Jordan Rupprecht565f1e22019-06-12 20:16:22 +0000748 dumpCodeViewMergedTypes(Writer, CVTypes.GlobalIDTable.records(),
Alexandre Ganea120366e2019-02-07 15:24:18 +0000749 CVTypes.GlobalTypeTable.records());
750 else
Jordan Rupprecht565f1e22019-06-12 20:16:22 +0000751 dumpCodeViewMergedTypes(Writer, CVTypes.IDTable.records(),
Alexandre Ganea120366e2019-02-07 15:24:18 +0000752 CVTypes.TypeTable.records());
Reid Kleckner0b269742016-05-14 00:02:53 +0000753 }
754
Rafael Espindolafb3acd62015-07-20 03:23:55 +0000755 return 0;
David Meyer2fc34c52012-03-01 01:36:50 +0000756}