blob: fb12e750fc6b8413ea09bdc567b98b6ff8ef71b9 [file] [log] [blame]
Michael J. Spencer2670c252011-01-20 06:39:06 +00001//===-- llvm-objdump.cpp - Object file dumping utility for llvm -----------===//
2//
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
Michael J. Spencer2670c252011-01-20 06:39:06 +00006//
7//===----------------------------------------------------------------------===//
8//
9// This program is a utility that works like binutils "objdump", that is, it
10// dumps out a plethora of information about an object file depending on the
11// flags.
12//
Michael J. Spencerd7e70032013-02-05 20:27:22 +000013// The flags and output of this program should be near identical to those of
14// binutils objdump.
15//
Michael J. Spencer2670c252011-01-20 06:39:06 +000016//===----------------------------------------------------------------------===//
17
Benjamin Kramer43a772e2011-09-19 17:56:04 +000018#include "llvm-objdump.h"
Sanjoy Das6f567a42015-06-22 18:03:02 +000019#include "llvm/ADT/Optional.h"
Chandler Carruth4d88a1c2012-12-04 10:44:52 +000020#include "llvm/ADT/STLExtras.h"
Michael J. Spencer4e25c022011-10-17 17:13:22 +000021#include "llvm/ADT/StringExtras.h"
Rafael Aulerb0e4b912018-03-09 19:13:44 +000022#include "llvm/ADT/StringSet.h"
Michael J. Spencer2670c252011-01-20 06:39:06 +000023#include "llvm/ADT/Triple.h"
Sanjoy Das3f1bc3b2015-06-23 20:09:03 +000024#include "llvm/CodeGen/FaultMaps.h"
Igor Laevsky03a670c2016-01-26 15:09:42 +000025#include "llvm/DebugInfo/DWARF/DWARFContext.h"
Hemant Kulkarni8dfc0b52016-08-15 19:49:24 +000026#include "llvm/DebugInfo/Symbolize/Symbolize.h"
Paul Semel007dedb2018-07-18 16:39:21 +000027#include "llvm/Demangle/Demangle.h"
Michael J. Spencer2670c252011-01-20 06:39:06 +000028#include "llvm/MC/MCAsmInfo.h"
Ahmed Bougachaad1084d2013-05-24 00:39:57 +000029#include "llvm/MC/MCContext.h"
Benjamin Kramerf57c1972016-01-26 16:44:37 +000030#include "llvm/MC/MCDisassembler/MCDisassembler.h"
31#include "llvm/MC/MCDisassembler/MCRelocationInfo.h"
Michael J. Spencer2670c252011-01-20 06:39:06 +000032#include "llvm/MC/MCInst.h"
33#include "llvm/MC/MCInstPrinter.h"
Ahmed Bougachaaa790682013-05-24 01:07:04 +000034#include "llvm/MC/MCInstrAnalysis.h"
Craig Topper54bfde72012-04-02 06:09:36 +000035#include "llvm/MC/MCInstrInfo.h"
Ahmed Bougachaad1084d2013-05-24 00:39:57 +000036#include "llvm/MC/MCObjectFileInfo.h"
Jim Grosbachfd93a592012-03-05 19:33:20 +000037#include "llvm/MC/MCRegisterInfo.h"
Ahmed Bougachaaa790682013-05-24 01:07:04 +000038#include "llvm/MC/MCSubtargetInfo.h"
Chandler Carruth4d88a1c2012-12-04 10:44:52 +000039#include "llvm/Object/Archive.h"
40#include "llvm/Object/COFF.h"
Saleem Abdulrasoolc6bf5472016-08-18 16:39:19 +000041#include "llvm/Object/COFFImportFile.h"
Benjamin Kramerf57c1972016-01-26 16:44:37 +000042#include "llvm/Object/ELFObjectFile.h"
Rafael Espindolaa9f810b2012-12-21 03:47:03 +000043#include "llvm/Object/MachO.h"
Dave Lee3fb120f2018-08-03 00:06:38 +000044#include "llvm/Object/MachOUniversal.h"
Chandler Carruth4d88a1c2012-12-04 10:44:52 +000045#include "llvm/Object/ObjectFile.h"
Sam Clegg4df5d762017-06-27 20:40:53 +000046#include "llvm/Object/Wasm.h"
Michael J. Spencerba4a3622011-10-08 00:18:30 +000047#include "llvm/Support/Casting.h"
Michael J. Spencer2670c252011-01-20 06:39:06 +000048#include "llvm/Support/CommandLine.h"
49#include "llvm/Support/Debug.h"
Alexey Samsonov50d0fbd2015-06-04 18:34:11 +000050#include "llvm/Support/Errc.h"
Michael J. Spencerba4a3622011-10-08 00:18:30 +000051#include "llvm/Support/FileSystem.h"
Michael J. Spencer2670c252011-01-20 06:39:06 +000052#include "llvm/Support/Format.h"
Benjamin Kramerbf115312011-07-25 23:04:36 +000053#include "llvm/Support/GraphWriter.h"
Michael J. Spencer2670c252011-01-20 06:39:06 +000054#include "llvm/Support/Host.h"
Rui Ueyama197194b2018-04-13 18:26:06 +000055#include "llvm/Support/InitLLVM.h"
Michael J. Spencer2670c252011-01-20 06:39:06 +000056#include "llvm/Support/MemoryBuffer.h"
Michael J. Spencer2670c252011-01-20 06:39:06 +000057#include "llvm/Support/SourceMgr.h"
Joel Galenson134cf472018-08-24 15:21:57 +000058#include "llvm/Support/StringSaver.h"
Evan Cheng2bb40352011-08-24 18:08:43 +000059#include "llvm/Support/TargetRegistry.h"
60#include "llvm/Support/TargetSelect.h"
Jonas Devliegheree787efd2018-11-11 22:12:04 +000061#include "llvm/Support/WithColor.h"
Michael J. Spencer2670c252011-01-20 06:39:06 +000062#include "llvm/Support/raw_ostream.h"
Michael J. Spencer2670c252011-01-20 06:39:06 +000063#include <algorithm>
Benjamin Kramera5177e62012-03-23 11:49:32 +000064#include <cctype>
Michael J. Spencer2670c252011-01-20 06:39:06 +000065#include <cstring>
Rafael Espindolaa6e9c3e2014-06-12 17:38:55 +000066#include <system_error>
Hemant Kulkarni8dfc0b52016-08-15 19:49:24 +000067#include <unordered_map>
Rafael Espindolac398e672017-07-19 22:27:28 +000068#include <utility>
Ahmed Bougacha17926472013-08-21 07:29:02 +000069
Fangrui Song523758e2019-04-15 15:31:42 +000070using namespace llvm::object;
Michael J. Spencer2670c252011-01-20 06:39:06 +000071
Fangrui Song9d812f42019-04-15 15:00:10 +000072namespace llvm {
73
74// MachO specific
75extern cl::opt<bool> Bind;
76extern cl::opt<bool> DataInCode;
77extern cl::opt<bool> DylibsUsed;
78extern cl::opt<bool> DylibId;
79extern cl::opt<bool> ExportsTrie;
80extern cl::opt<bool> FirstPrivateHeader;
81extern cl::opt<bool> IndirectSymbols;
82extern cl::opt<bool> InfoPlist;
83extern cl::opt<bool> LazyBind;
84extern cl::opt<bool> LinkOptHints;
85extern cl::opt<bool> ObjcMetaData;
86extern cl::opt<bool> Rebase;
87extern cl::opt<bool> UniversalHeaders;
88extern cl::opt<bool> WeakBind;
89
90static cl::opt<unsigned long long> AdjustVMA(
George Rimar4c3b2972019-01-28 10:44:01 +000091 "adjust-vma",
92 cl::desc("Increase the displayed address by the specified offset"),
93 cl::value_desc("offset"), cl::init(0));
94
Fangrui Song9d812f42019-04-15 15:00:10 +000095static cl::opt<bool>
96 AllHeaders("all-headers",
97 cl::desc("Display all available header information"));
Fangrui Song8513cd42018-06-27 20:45:11 +000098static cl::alias AllHeadersShort("x", cl::desc("Alias for --all-headers"),
Matthew Voss0f436772019-02-19 19:46:08 +000099 cl::NotHidden, cl::Grouping,
100 cl::aliasopt(AllHeaders));
Fangrui Song8513cd42018-06-27 20:45:11 +0000101
Fangrui Song9d812f42019-04-15 15:00:10 +0000102static cl::opt<std::string>
103 ArchName("arch-name", cl::desc("Target arch to disassemble for, "
104 "see -version for available targets"));
Michael J. Spencer2670c252011-01-20 06:39:06 +0000105
Fangrui Song9d812f42019-04-15 15:00:10 +0000106cl::opt<bool> ArchiveHeaders("archive-headers",
107 cl::desc("Display archive header information"));
108static cl::alias ArchiveHeadersShort("a",
109 cl::desc("Alias for --archive-headers"),
110 cl::NotHidden, cl::Grouping,
111 cl::aliasopt(ArchiveHeaders));
Colin LeMahieu77804be2015-07-29 15:45:39 +0000112
Fangrui Song9d812f42019-04-15 15:00:10 +0000113cl::opt<bool> Demangle("demangle", cl::desc("Demangle symbols names"),
114 cl::init(false));
Paul Semel007dedb2018-07-18 16:39:21 +0000115static cl::alias DemangleShort("C", cl::desc("Alias for --demangle"),
Matthew Voss0f436772019-02-19 19:46:08 +0000116 cl::NotHidden, cl::Grouping,
Fangrui Song9d812f42019-04-15 15:00:10 +0000117 cl::aliasopt(Demangle));
118
119cl::opt<bool> Disassemble(
120 "disassemble",
121 cl::desc("Display assembler mnemonics for the machine instructions"));
122static cl::alias DisassembleShort("d", cl::desc("Alias for --disassemble"),
123 cl::NotHidden, cl::Grouping,
124 cl::aliasopt(Disassemble));
125
126cl::opt<bool> DisassembleAll(
127 "disassemble-all",
128 cl::desc("Display assembler mnemonics for the machine instructions"));
129static cl::alias DisassembleAllShort("D",
130 cl::desc("Alias for --disassemble-all"),
131 cl::NotHidden, cl::Grouping,
132 cl::aliasopt(DisassembleAll));
Paul Semel007dedb2018-07-18 16:39:21 +0000133
Rafael Aulerb0e4b912018-03-09 19:13:44 +0000134static cl::list<std::string>
Matthew Voss0f436772019-02-19 19:46:08 +0000135DisassembleFunctions("disassemble-functions",
Rafael Aulerb0e4b912018-03-09 19:13:44 +0000136 cl::CommaSeparated,
137 cl::desc("List of functions to disassemble"));
Rafael Aulerb0e4b912018-03-09 19:13:44 +0000138
Fangrui Song9d812f42019-04-15 15:00:10 +0000139static cl::opt<bool> DisassembleZeroes(
140 "disassemble-zeroes",
141 cl::desc("Do not skip blocks of zeroes when disassembling"));
142static cl::alias
143 DisassembleZeroesShort("z", cl::desc("Alias for --disassemble-zeroes"),
144 cl::NotHidden, cl::Grouping,
145 cl::aliasopt(DisassembleZeroes));
146
147static cl::list<std::string>
148 DisassemblerOptions("disassembler-options",
149 cl::desc("Pass target specific disassembler options"),
150 cl::value_desc("options"), cl::CommaSeparated);
151static cl::alias
152 DisassemblerOptionsShort("M", cl::desc("Alias for --disassembler-options"),
153 cl::NotHidden, cl::Grouping, cl::Prefix,
154 cl::CommaSeparated,
155 cl::aliasopt(DisassemblerOptions));
156
157cl::opt<DIDumpType> DwarfDumpType(
158 "dwarf", cl::init(DIDT_Null), cl::desc("Dump of dwarf debug sections:"),
159 cl::values(clEnumValN(DIDT_DebugFrame, "frames", ".debug_frame")));
160
161static cl::opt<bool> DynamicRelocations(
162 "dynamic-reloc",
163 cl::desc("Display the dynamic relocation entries in the file"));
164static cl::alias DynamicRelocationShort("R",
165 cl::desc("Alias for --dynamic-reloc"),
166 cl::NotHidden, cl::Grouping,
167 cl::aliasopt(DynamicRelocations));
168
169static cl::opt<bool>
170 FaultMapSection("fault-map-section",
171 cl::desc("Display contents of faultmap section"));
172
173static cl::opt<bool>
174 FileHeaders("file-headers",
175 cl::desc("Display the contents of the overall file header"));
176static cl::alias FileHeadersShort("f", cl::desc("Alias for --file-headers"),
Matthew Voss0f436772019-02-19 19:46:08 +0000177 cl::NotHidden, cl::Grouping,
Fangrui Song9d812f42019-04-15 15:00:10 +0000178 cl::aliasopt(FileHeaders));
Michael J. Spencerba4a3622011-10-08 00:18:30 +0000179
Fangrui Song9d812f42019-04-15 15:00:10 +0000180cl::opt<bool> SectionContents("full-contents",
181 cl::desc("Display the content of each section"));
James Hendersonb55b6582018-10-29 10:05:39 +0000182static cl::alias SectionContentsShort("s",
183 cl::desc("Alias for --full-contents"),
Matthew Voss0f436772019-02-19 19:46:08 +0000184 cl::NotHidden, cl::Grouping,
James Hendersonb55b6582018-10-29 10:05:39 +0000185 cl::aliasopt(SectionContents));
Michael J. Spencer4e25c022011-10-17 17:13:22 +0000186
Fangrui Song9d812f42019-04-15 15:00:10 +0000187static cl::list<std::string>
188InputFilenames(cl::Positional, cl::desc("<input object files>"),cl::ZeroOrMore);
Michael J. Spencerbfa06782011-10-18 19:32:17 +0000189
Fangrui Song9d812f42019-04-15 15:00:10 +0000190static cl::opt<bool>
191 PrintLines("line-numbers",
192 cl::desc("Display source line numbers with "
193 "disassembly. Implies disassemble object"));
194static cl::alias PrintLinesShort("l", cl::desc("Alias for --line-numbers"),
195 cl::NotHidden, cl::Grouping,
196 cl::aliasopt(PrintLines));
Adrian Prantl437105a2015-07-08 02:04:15 +0000197
Nick Kledzik56ebef42014-09-16 01:41:51 +0000198static cl::opt<bool>
Rafael Espindolaa9f810b2012-12-21 03:47:03 +0000199MachOOpt("macho", cl::desc("Use MachO specific object file parser"));
George Rimar845d3292019-01-18 10:41:26 +0000200static cl::alias MachOm("m", cl::desc("Alias for --macho"), cl::NotHidden,
Matthew Voss0f436772019-02-19 19:46:08 +0000201 cl::Grouping, cl::aliasopt(MachOOpt));
Benjamin Kramer87ee76c2011-07-20 19:37:35 +0000202
Benjamin Kramer43a772e2011-09-19 17:56:04 +0000203cl::opt<std::string>
Fangrui Song9d812f42019-04-15 15:00:10 +0000204 MCPU("mcpu",
205 cl::desc("Target a specific cpu type (-mcpu=help for details)"),
206 cl::value_desc("cpu-name"), cl::init(""));
Benjamin Kramer43a772e2011-09-19 17:56:04 +0000207
Fangrui Song9d812f42019-04-15 15:00:10 +0000208cl::list<std::string> MAttrs("mattr", cl::CommaSeparated,
209 cl::desc("Target specific attributes"),
210 cl::value_desc("a1,+a2,-a3,..."));
Kevin Enderbyc9595622014-08-06 23:24:41 +0000211
Fangrui Song9d812f42019-04-15 15:00:10 +0000212cl::opt<bool> NoShowRawInsn("no-show-raw-insn",
213 cl::desc("When disassembling "
214 "instructions, do not print "
215 "the instruction bytes."));
216cl::opt<bool> NoLeadingAddr("no-leading-addr",
217 cl::desc("Print no leading address"));
218
219static cl::opt<bool> RawClangAST(
220 "raw-clang-ast",
221 cl::desc("Dump the raw binary contents of the clang AST section"));
Michael J. Spencer2670c252011-01-20 06:39:06 +0000222
Kevin Enderby98da6132015-01-20 21:47:46 +0000223cl::opt<bool>
Fangrui Song9d812f42019-04-15 15:00:10 +0000224 Relocations("reloc",
225 cl::desc("Display the relocation entries in the file"));
226static cl::alias RelocationsShort("r", cl::desc("Alias for --reloc"),
227 cl::NotHidden, cl::Grouping,
228 cl::aliasopt(Relocations));
229
230cl::opt<bool>
231 PrintImmHex("print-imm-hex",
232 cl::desc("Use hex format for immediate values"));
233
234cl::opt<bool>
235 PrivateHeaders("private-headers",
236 cl::desc("Display format specific file headers"));
237static cl::alias PrivateHeadersShort("p",
238 cl::desc("Alias for --private-headers"),
239 cl::NotHidden, cl::Grouping,
240 cl::aliasopt(PrivateHeaders));
241
242cl::list<std::string>
243 FilterSections("section",
244 cl::desc("Operate on the specified sections only. "
245 "With -macho dump segment,section"));
246static cl::alias FilterSectionsj("j", cl::desc("Alias for --section"),
247 cl::NotHidden, cl::Grouping, cl::Prefix,
248 cl::aliasopt(FilterSections));
249
250cl::opt<bool> SectionHeaders("section-headers",
251 cl::desc("Display summaries of the "
252 "headers for each section."));
George Rimar845d3292019-01-18 10:41:26 +0000253static cl::alias SectionHeadersShort("headers",
254 cl::desc("Alias for --section-headers"),
255 cl::NotHidden,
256 cl::aliasopt(SectionHeaders));
257static cl::alias SectionHeadersShorter("h",
258 cl::desc("Alias for --section-headers"),
Matthew Voss0f436772019-02-19 19:46:08 +0000259 cl::NotHidden, cl::Grouping,
George Rimar845d3292019-01-18 10:41:26 +0000260 cl::aliasopt(SectionHeaders));
Colin LeMahieufcc32762015-07-29 19:08:10 +0000261
George Rimar87fa2e62019-01-28 14:11:35 +0000262static cl::opt<bool>
263 ShowLMA("show-lma",
264 cl::desc("Display LMA column when dumping ELF section headers"));
265
Fangrui Song9d812f42019-04-15 15:00:10 +0000266static cl::opt<bool> PrintSource(
267 "source",
268 cl::desc(
269 "Display source inlined with disassembly. Implies disassemble object"));
270static cl::alias PrintSourceShort("S", cl::desc("Alias for -source"),
271 cl::NotHidden, cl::Grouping,
272 cl::aliasopt(PrintSource));
Nick Lewyckyfcf84622011-10-10 21:21:34 +0000273
Fangrui Song9d812f42019-04-15 15:00:10 +0000274static cl::opt<unsigned long long>
275 StartAddress("start-address", cl::desc("Disassemble beginning at address"),
276 cl::value_desc("address"), cl::init(0));
277static cl::opt<unsigned long long>
278 StopAddress("stop-address", cl::desc("Stop disassembly at address"),
279 cl::value_desc("address"), cl::init(UINT64_MAX));
Jack Carter551efd72012-08-28 19:24:49 +0000280
Fangrui Song9d812f42019-04-15 15:00:10 +0000281cl::opt<bool> SymbolTable("syms", cl::desc("Display the symbol table"));
282static cl::alias SymbolTableShort("t", cl::desc("Alias for --syms"),
283 cl::NotHidden, cl::Grouping,
284 cl::aliasopt(SymbolTable));
Eli Bendersky3a6808c2012-11-20 22:57:02 +0000285
Fangrui Song9d812f42019-04-15 15:00:10 +0000286cl::opt<std::string> TripleName("triple",
287 cl::desc("Target triple to disassemble for, "
288 "see -version for available targets"));
Michael J. Spencer0c6ec482012-12-05 20:12:35 +0000289
Fangrui Song9d812f42019-04-15 15:00:10 +0000290cl::opt<bool> UnwindInfo("unwind-info",
291 cl::desc("Display unwind information"));
George Rimar845d3292019-01-18 10:41:26 +0000292static cl::alias UnwindInfoShort("u", cl::desc("Alias for --unwind-info"),
Matthew Voss0f436772019-02-19 19:46:08 +0000293 cl::NotHidden, cl::Grouping,
294 cl::aliasopt(UnwindInfo));
Michael J. Spencer0c6ec482012-12-05 20:12:35 +0000295
Igor Kudrin2d3faad2019-02-26 12:15:14 +0000296
Fangrui Song5f2b5cd2019-04-10 04:46:01 +0000297static cl::opt<bool>
298 Wide("wide", cl::desc("Ignored for compatibility with GNU objdump"));
299static cl::alias WideShort("w", cl::Grouping, cl::aliasopt(Wide));
300
Fangrui Song9d812f42019-04-15 15:00:10 +0000301static StringSet<> DisasmFuncsSet;
Benjamin Kramer43a772e2011-09-19 17:56:04 +0000302static StringRef ToolName;
Michael J. Spencer2670c252011-01-20 06:39:06 +0000303
Clement Courbetd1a3bd42019-01-18 15:26:14 +0000304typedef std::vector<std::tuple<uint64_t, StringRef, uint8_t>> SectionSymbolsTy;
Clement Courbet2d7d4a32019-01-18 09:40:19 +0000305
Fangrui Song523758e2019-04-15 15:31:42 +0000306SectionFilter ToolSectionFilter(object::ObjectFile const &O) {
David Majnemer42531262016-08-12 03:55:06 +0000307 return SectionFilter(
Fangrui Song523758e2019-04-15 15:31:42 +0000308 [](object::SectionRef const &S) {
David Majnemer42531262016-08-12 03:55:06 +0000309 if (FilterSections.empty())
310 return true;
Fangrui Song523758e2019-04-15 15:31:42 +0000311 StringRef String;
David Majnemer42531262016-08-12 03:55:06 +0000312 std::error_code error = S.getName(String);
313 if (error)
314 return false;
315 return is_contained(FilterSections, String);
316 },
317 O);
Colin LeMahieu77804be2015-07-29 15:45:39 +0000318}
Colin LeMahieu77804be2015-07-29 15:45:39 +0000319
Fangrui Song523758e2019-04-15 15:31:42 +0000320void error(std::error_code EC) {
Mark Seaborneb03ac52014-01-25 00:32:01 +0000321 if (!EC)
Davide Italianoccd53fe2015-08-05 07:18:31 +0000322 return;
Jonas Devliegheree787efd2018-11-11 22:12:04 +0000323 WithColor::error(errs(), ToolName)
324 << "reading file: " << EC.message() << ".\n";
Davide Italiano140af642015-12-25 18:16:45 +0000325 errs().flush();
Davide Italiano7f6c3012015-08-06 00:18:52 +0000326 exit(1);
Michael J. Spencer2670c252011-01-20 06:39:06 +0000327}
328
Fangrui Song523758e2019-04-15 15:31:42 +0000329void error(Error E) {
Fangrui Songf67de6c2019-04-08 16:24:08 +0000330 if (!E)
331 return;
332 WithColor::error(errs(), ToolName) << toString(std::move(E));
333 exit(1);
334}
335
Fangrui Song523758e2019-04-15 15:31:42 +0000336LLVM_ATTRIBUTE_NORETURN void error(Twine Message) {
Jonas Devliegheree787efd2018-11-11 22:12:04 +0000337 WithColor::error(errs(), ToolName) << Message << ".\n";
Kevin Enderby42398052016-06-28 23:16:13 +0000338 errs().flush();
339 exit(1);
340}
341
Fangrui Song523758e2019-04-15 15:31:42 +0000342void warn(StringRef Message) {
Jonas Devliegheree787efd2018-11-11 22:12:04 +0000343 WithColor::warning(errs(), ToolName) << Message << ".\n";
Paul Semel007dedb2018-07-18 16:39:21 +0000344 errs().flush();
345}
346
Fangrui Song523758e2019-04-15 15:31:42 +0000347LLVM_ATTRIBUTE_NORETURN void report_error(StringRef File, Twine Message) {
Jonas Devliegheree787efd2018-11-11 22:12:04 +0000348 WithColor::error(errs(), ToolName)
349 << "'" << File << "': " << Message << ".\n";
Kevin Enderby7fa40c92016-11-16 22:17:38 +0000350 exit(1);
351}
352
Fangrui Song523758e2019-04-15 15:31:42 +0000353LLVM_ATTRIBUTE_NORETURN void report_error(Error E, StringRef File) {
Kevin Enderby3fcdf6a2016-04-06 22:14:09 +0000354 assert(E);
355 std::string Buf;
356 raw_string_ostream OS(Buf);
Jonas Devlieghere45eb84f2018-11-11 01:46:03 +0000357 logAllUnhandledErrors(std::move(E), OS);
Kevin Enderby3fcdf6a2016-04-06 22:14:09 +0000358 OS.flush();
Jonas Devliegheree787efd2018-11-11 22:12:04 +0000359 WithColor::error(errs(), ToolName) << "'" << File << "': " << Buf;
Kevin Enderby3fcdf6a2016-04-06 22:14:09 +0000360 exit(1);
361}
362
Fangrui Song523758e2019-04-15 15:31:42 +0000363LLVM_ATTRIBUTE_NORETURN void report_error(Error E, StringRef ArchiveName,
364 StringRef FileName,
365 StringRef ArchitectureName) {
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000366 assert(E);
Jonas Devliegheree787efd2018-11-11 22:12:04 +0000367 WithColor::error(errs(), ToolName);
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000368 if (ArchiveName != "")
369 errs() << ArchiveName << "(" << FileName << ")";
370 else
Justin Bogner31d8b7d2016-10-26 22:37:52 +0000371 errs() << "'" << FileName << "'";
Kevin Enderby9acb1092016-05-31 20:35:34 +0000372 if (!ArchitectureName.empty())
373 errs() << " (for architecture " << ArchitectureName << ")";
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000374 std::string Buf;
375 raw_string_ostream OS(Buf);
Jonas Devlieghere45eb84f2018-11-11 01:46:03 +0000376 logAllUnhandledErrors(std::move(E), OS);
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000377 OS.flush();
Justin Bogner31d8b7d2016-10-26 22:37:52 +0000378 errs() << ": " << Buf;
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000379 exit(1);
380}
381
Fangrui Song523758e2019-04-15 15:31:42 +0000382LLVM_ATTRIBUTE_NORETURN void report_error(Error E, StringRef ArchiveName,
383 const object::Archive::Child &C,
384 StringRef ArchitectureName) {
Kevin Enderbyf4586032016-07-29 17:44:13 +0000385 Expected<StringRef> NameOrErr = C.getName();
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000386 // TODO: if we have a error getting the name then it would be nice to print
387 // the index of which archive member this is and or its offset in the
388 // archive instead of "???" as the name.
Kevin Enderbyf4586032016-07-29 17:44:13 +0000389 if (!NameOrErr) {
390 consumeError(NameOrErr.takeError());
Fangrui Song523758e2019-04-15 15:31:42 +0000391 report_error(std::move(E), ArchiveName, "???", ArchitectureName);
Kevin Enderbyf4586032016-07-29 17:44:13 +0000392 } else
Fangrui Song523758e2019-04-15 15:31:42 +0000393 report_error(std::move(E), ArchiveName, NameOrErr.get(), ArchitectureName);
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000394}
395
Craig Toppere6cb63e2014-04-25 04:24:47 +0000396static const Target *getTarget(const ObjectFile *Obj = nullptr) {
Michael J. Spencer2670c252011-01-20 06:39:06 +0000397 // Figure out the target triple.
Fangrui Song523758e2019-04-15 15:31:42 +0000398 Triple TheTriple("unknown-unknown-unknown");
Michael J. Spencer05350e6d2011-01-20 07:22:04 +0000399 if (TripleName.empty()) {
George Rimar73a27232019-01-15 09:19:18 +0000400 if (Obj)
Vlad Tsyrklevichde620462017-09-19 02:22:48 +0000401 TheTriple = Obj->makeTriple();
Sam Parkerdf7c6ef2017-01-18 13:52:12 +0000402 } else {
Kevin Enderbyfe3d0052012-05-08 23:38:45 +0000403 TheTriple.setTriple(Triple::normalize(TripleName));
Vlad Tsyrklevichde620462017-09-19 02:22:48 +0000404
Sam Parkerdf7c6ef2017-01-18 13:52:12 +0000405 // Use the triple, but also try to combine with ARM build attributes.
406 if (Obj) {
407 auto Arch = Obj->getArch();
George Rimar73a27232019-01-15 09:19:18 +0000408 if (Arch == Triple::arm || Arch == Triple::armeb)
Sam Parkerdf7c6ef2017-01-18 13:52:12 +0000409 Obj->setARMSubArch(TheTriple);
Sam Parkerdf7c6ef2017-01-18 13:52:12 +0000410 }
411 }
Michael J. Spencer2670c252011-01-20 06:39:06 +0000412
413 // Get the target specific parser.
414 std::string Error;
Kevin Enderbyfe3d0052012-05-08 23:38:45 +0000415 const Target *TheTarget = TargetRegistry::lookupTarget(ArchName, TheTriple,
416 Error);
Kevin Enderby7fa40c92016-11-16 22:17:38 +0000417 if (!TheTarget) {
418 if (Obj)
419 report_error(Obj->getFileName(), "can't find target: " + Error);
420 else
421 error("can't find target: " + Error);
422 }
Michael J. Spencer2670c252011-01-20 06:39:06 +0000423
Kevin Enderbyfe3d0052012-05-08 23:38:45 +0000424 // Update the triple name and return the found target.
425 TripleName = TheTriple.getTriple();
426 return TheTarget;
Michael J. Spencer2670c252011-01-20 06:39:06 +0000427}
428
Fangrui Song523758e2019-04-15 15:31:42 +0000429bool isRelocAddressLess(RelocationRef A, RelocationRef B) {
George Rimar73a27232019-01-15 09:19:18 +0000430 return A.getOffset() < B.getOffset();
Michael J. Spencer51862b32011-10-13 22:17:18 +0000431}
432
Fangrui Songf67de6c2019-04-08 16:24:08 +0000433static Error getRelocationValueString(const RelocationRef &Rel,
434 SmallVectorImpl<char> &Result) {
Rafael Espindola854038e2015-06-26 14:51:16 +0000435 const ObjectFile *Obj = Rel.getObject();
Rafael Espindola37070a52015-06-03 04:48:06 +0000436 if (auto *ELF = dyn_cast<ELFObjectFileBase>(Obj))
George Rimarc1964882019-01-18 11:33:26 +0000437 return getELFRelocationValueString(ELF, Rel, Result);
Rafael Espindola37070a52015-06-03 04:48:06 +0000438 if (auto *COFF = dyn_cast<COFFObjectFile>(Obj))
George Rimarc1964882019-01-18 11:33:26 +0000439 return getCOFFRelocationValueString(COFF, Rel, Result);
Sam Clegg4df5d762017-06-27 20:40:53 +0000440 if (auto *Wasm = dyn_cast<WasmObjectFile>(Obj))
George Rimarc1964882019-01-18 11:33:26 +0000441 return getWasmRelocationValueString(Wasm, Rel, Result);
Sam Clegg4df5d762017-06-27 20:40:53 +0000442 if (auto *MachO = dyn_cast<MachOObjectFile>(Obj))
George Rimarc1964882019-01-18 11:33:26 +0000443 return getMachORelocationValueString(MachO, Rel, Result);
Sam Clegg4df5d762017-06-27 20:40:53 +0000444 llvm_unreachable("unknown object file format");
Rafael Espindola37070a52015-06-03 04:48:06 +0000445}
446
Adrian Prantl4dfcc4a2018-05-01 16:10:38 +0000447/// Indicates whether this relocation should hidden when listing
Rafael Espindola0ad71d92015-06-30 03:41:26 +0000448/// relocations, usually because it is the trailing part of a multipart
449/// relocation that will be printed as part of the leading relocation.
450static bool getHidden(RelocationRef RelRef) {
George Rimar73a27232019-01-15 09:19:18 +0000451 auto *MachO = dyn_cast<MachOObjectFile>(RelRef.getObject());
Rafael Espindola0ad71d92015-06-30 03:41:26 +0000452 if (!MachO)
453 return false;
454
455 unsigned Arch = MachO->getArch();
456 DataRefImpl Rel = RelRef.getRawDataRefImpl();
457 uint64_t Type = MachO->getRelocationType(Rel);
458
459 // On arches that use the generic relocations, GENERIC_RELOC_PAIR
460 // is always hidden.
George Rimar73a27232019-01-15 09:19:18 +0000461 if (Arch == Triple::x86 || Arch == Triple::arm || Arch == Triple::ppc)
462 return Type == MachO::GENERIC_RELOC_PAIR;
463
464 if (Arch == Triple::x86_64) {
Rafael Espindola0ad71d92015-06-30 03:41:26 +0000465 // On x86_64, X86_64_RELOC_UNSIGNED is hidden only when it follows
466 // an X86_64_RELOC_SUBTRACTOR.
467 if (Type == MachO::X86_64_RELOC_UNSIGNED && Rel.d.a > 0) {
468 DataRefImpl RelPrev = Rel;
469 RelPrev.d.a--;
470 uint64_t PrevType = MachO->getRelocationType(RelPrev);
471 if (PrevType == MachO::X86_64_RELOC_SUBTRACTOR)
472 return true;
473 }
474 }
475
476 return false;
477}
478
Sid Manningd9f28732018-05-14 19:46:08 +0000479namespace {
480class SourcePrinter {
481protected:
482 DILineInfo OldLineInfo;
483 const ObjectFile *Obj = nullptr;
484 std::unique_ptr<symbolize::LLVMSymbolizer> Symbolizer;
485 // File name to file contents of source
486 std::unordered_map<std::string, std::unique_ptr<MemoryBuffer>> SourceCache;
487 // Mark the line endings of the cached source
488 std::unordered_map<std::string, std::vector<StringRef>> LineCache;
489
490private:
491 bool cacheSource(const DILineInfo& LineInfoFile);
492
493public:
494 SourcePrinter() = default;
495 SourcePrinter(const ObjectFile *Obj, StringRef DefaultArch) : Obj(Obj) {
496 symbolize::LLVMSymbolizer::Options SymbolizerOpts(
497 DILineInfoSpecifier::FunctionNameKind::None, true, false, false,
498 DefaultArch);
499 Symbolizer.reset(new symbolize::LLVMSymbolizer(SymbolizerOpts));
500 }
501 virtual ~SourcePrinter() = default;
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000502 virtual void printSourceLine(raw_ostream &OS,
503 object::SectionedAddress Address,
Sid Manningd9f28732018-05-14 19:46:08 +0000504 StringRef Delimiter = "; ");
505};
506
507bool SourcePrinter::cacheSource(const DILineInfo &LineInfo) {
508 std::unique_ptr<MemoryBuffer> Buffer;
509 if (LineInfo.Source) {
510 Buffer = MemoryBuffer::getMemBuffer(*LineInfo.Source);
511 } else {
512 auto BufferOrError = MemoryBuffer::getFile(LineInfo.FileName);
513 if (!BufferOrError)
514 return false;
515 Buffer = std::move(*BufferOrError);
516 }
517 // Chomp the file to get lines
Fangrui Song47a76622019-04-07 10:16:46 +0000518 const char *BufferStart = Buffer->getBufferStart(),
519 *BufferEnd = Buffer->getBufferEnd();
520 std::vector<StringRef> &Lines = LineCache[LineInfo.FileName];
521 const char *Start = BufferStart;
522 for (const char *I = BufferStart; I != BufferEnd; ++I)
523 if (*I == '\n') {
524 Lines.emplace_back(Start, I - Start - (BufferStart < I && I[-1] == '\r'));
525 Start = I + 1;
Sid Manningd9f28732018-05-14 19:46:08 +0000526 }
Fangrui Song47a76622019-04-07 10:16:46 +0000527 if (Start < BufferEnd)
528 Lines.emplace_back(Start, BufferEnd - Start);
Sid Manningd9f28732018-05-14 19:46:08 +0000529 SourceCache[LineInfo.FileName] = std::move(Buffer);
530 return true;
531}
532
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000533void SourcePrinter::printSourceLine(raw_ostream &OS,
534 object::SectionedAddress Address,
Sid Manningd9f28732018-05-14 19:46:08 +0000535 StringRef Delimiter) {
536 if (!Symbolizer)
537 return;
538 DILineInfo LineInfo = DILineInfo();
Eric Christopher1857edb2019-03-28 01:12:13 +0000539 auto ExpectedLineInfo =
Sid Manningd9f28732018-05-14 19:46:08 +0000540 Symbolizer->symbolizeCode(Obj->getFileName(), Address);
Eric Christopher1857edb2019-03-28 01:12:13 +0000541 if (!ExpectedLineInfo)
542 consumeError(ExpectedLineInfo.takeError());
Sid Manningd9f28732018-05-14 19:46:08 +0000543 else
Eric Christopher1857edb2019-03-28 01:12:13 +0000544 LineInfo = *ExpectedLineInfo;
Sid Manningd9f28732018-05-14 19:46:08 +0000545
546 if ((LineInfo.FileName == "<invalid>") || OldLineInfo.Line == LineInfo.Line ||
547 LineInfo.Line == 0)
548 return;
549
550 if (PrintLines)
551 OS << Delimiter << LineInfo.FileName << ":" << LineInfo.Line << "\n";
552 if (PrintSource) {
553 if (SourceCache.find(LineInfo.FileName) == SourceCache.end())
554 if (!cacheSource(LineInfo))
555 return;
Fangrui Song47a76622019-04-07 10:16:46 +0000556 auto LineBuffer = LineCache.find(LineInfo.FileName);
557 if (LineBuffer != LineCache.end()) {
558 if (LineInfo.Line > LineBuffer->second.size())
559 return;
560 // Vector begins at 0, line numbers are non-zero
561 OS << Delimiter << LineBuffer->second[LineInfo.Line - 1] << '\n';
Sid Manningd9f28732018-05-14 19:46:08 +0000562 }
563 }
564 OldLineInfo = LineInfo;
565}
566
567static bool isArmElf(const ObjectFile *Obj) {
568 return (Obj->isELF() &&
569 (Obj->getArch() == Triple::aarch64 ||
570 Obj->getArch() == Triple::aarch64_be ||
571 Obj->getArch() == Triple::arm || Obj->getArch() == Triple::armeb ||
572 Obj->getArch() == Triple::thumb ||
573 Obj->getArch() == Triple::thumbeb));
574}
575
George Rimar617adef2019-01-23 13:39:12 +0000576static void printRelocation(const RelocationRef &Rel, uint64_t Address,
577 uint8_t AddrSize) {
578 StringRef Fmt =
579 AddrSize > 4 ? "\t\t%016" PRIx64 ": " : "\t\t\t%08" PRIx64 ": ";
580 SmallString<16> Name;
581 SmallString<32> Val;
582 Rel.getTypeName(Name);
583 error(getRelocationValueString(Rel, Val));
584 outs() << format(Fmt.data(), Address) << Name << "\t" << Val << "\n";
585}
586
Sid Manningd9f28732018-05-14 19:46:08 +0000587class PrettyPrinter {
588public:
589 virtual ~PrettyPrinter() = default;
590 virtual void printInst(MCInstPrinter &IP, const MCInst *MI,
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000591 ArrayRef<uint8_t> Bytes,
592 object::SectionedAddress Address, raw_ostream &OS,
593 StringRef Annot, MCSubtargetInfo const &STI,
594 SourcePrinter *SP,
Sid Manningd9f28732018-05-14 19:46:08 +0000595 std::vector<RelocationRef> *Rels = nullptr) {
596 if (SP && (PrintSource || PrintLines))
597 SP->printSourceLine(OS, Address);
Fangrui Songfa860ff2019-04-16 03:56:55 +0000598
599 {
600 formatted_raw_ostream FOS(OS);
601 if (!NoLeadingAddr)
602 FOS << format("%8" PRIx64 ":", Address.Address);
603 if (!NoShowRawInsn) {
604 FOS << ' ';
605 dumpBytes(Bytes, FOS);
606 }
607 FOS.flush();
608 // The output of printInst starts with a tab. Print some spaces so that
609 // the tab has 1 column and advances to the target tab stop.
610 unsigned TabStop = NoShowRawInsn ? 16 : 40;
611 unsigned Column = FOS.getColumn();
612 FOS.indent(Column < TabStop - 1 ? TabStop - 1 - Column : 7 - Column % 8);
613
614 // The dtor calls flush() to ensure the indent comes before printInst().
Sid Manningd9f28732018-05-14 19:46:08 +0000615 }
Fangrui Songfa860ff2019-04-16 03:56:55 +0000616
Sid Manningd9f28732018-05-14 19:46:08 +0000617 if (MI)
618 IP.printInst(MI, OS, "", STI);
619 else
Fangrui Song7d4ad142019-04-10 05:31:21 +0000620 OS << "\t<unknown>";
Sid Manningd9f28732018-05-14 19:46:08 +0000621 }
622};
623PrettyPrinter PrettyPrinterInst;
624class HexagonPrettyPrinter : public PrettyPrinter {
625public:
626 void printLead(ArrayRef<uint8_t> Bytes, uint64_t Address,
627 raw_ostream &OS) {
628 uint32_t opcode =
629 (Bytes[3] << 24) | (Bytes[2] << 16) | (Bytes[1] << 8) | Bytes[0];
630 if (!NoLeadingAddr)
631 OS << format("%8" PRIx64 ":", Address);
632 if (!NoShowRawInsn) {
633 OS << "\t";
634 dumpBytes(Bytes.slice(0, 4), OS);
Fangrui Song7d4ad142019-04-10 05:31:21 +0000635 OS << format("\t%08" PRIx32, opcode);
Sid Manningd9f28732018-05-14 19:46:08 +0000636 }
637 }
638 void printInst(MCInstPrinter &IP, const MCInst *MI, ArrayRef<uint8_t> Bytes,
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000639 object::SectionedAddress Address, raw_ostream &OS,
640 StringRef Annot, MCSubtargetInfo const &STI, SourcePrinter *SP,
Sid Manningd9f28732018-05-14 19:46:08 +0000641 std::vector<RelocationRef> *Rels) override {
642 if (SP && (PrintSource || PrintLines))
643 SP->printSourceLine(OS, Address, "");
644 if (!MI) {
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000645 printLead(Bytes, Address.Address, OS);
Sid Manningd9f28732018-05-14 19:46:08 +0000646 OS << " <unknown>";
647 return;
648 }
649 std::string Buffer;
650 {
651 raw_string_ostream TempStream(Buffer);
652 IP.printInst(MI, TempStream, "", STI);
653 }
654 StringRef Contents(Buffer);
655 // Split off bundle attributes
656 auto PacketBundle = Contents.rsplit('\n');
657 // Split off first instruction from the rest
658 auto HeadTail = PacketBundle.first.split('\n');
659 auto Preamble = " { ";
660 auto Separator = "";
Sid Manningd9f28732018-05-14 19:46:08 +0000661
662 // Hexagon's packets require relocations to be inline rather than
663 // clustered at the end of the packet.
George Rimar617adef2019-01-23 13:39:12 +0000664 std::vector<RelocationRef>::const_iterator RelCur = Rels->begin();
665 std::vector<RelocationRef>::const_iterator RelEnd = Rels->end();
Sid Manningd9f28732018-05-14 19:46:08 +0000666 auto PrintReloc = [&]() -> void {
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000667 while ((RelCur != RelEnd) && (RelCur->getOffset() <= Address.Address)) {
668 if (RelCur->getOffset() == Address.Address) {
669 printRelocation(*RelCur, Address.Address, 4);
Sid Manningd9f28732018-05-14 19:46:08 +0000670 return;
671 }
George Rimar73a27232019-01-15 09:19:18 +0000672 ++RelCur;
Sid Manningd9f28732018-05-14 19:46:08 +0000673 }
674 };
675
George Rimar73a27232019-01-15 09:19:18 +0000676 while (!HeadTail.first.empty()) {
Sid Manningd9f28732018-05-14 19:46:08 +0000677 OS << Separator;
678 Separator = "\n";
679 if (SP && (PrintSource || PrintLines))
680 SP->printSourceLine(OS, Address, "");
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000681 printLead(Bytes, Address.Address, OS);
Sid Manningd9f28732018-05-14 19:46:08 +0000682 OS << Preamble;
683 Preamble = " ";
684 StringRef Inst;
685 auto Duplex = HeadTail.first.split('\v');
George Rimar73a27232019-01-15 09:19:18 +0000686 if (!Duplex.second.empty()) {
Sid Manningd9f28732018-05-14 19:46:08 +0000687 OS << Duplex.first;
688 OS << "; ";
689 Inst = Duplex.second;
690 }
691 else
692 Inst = HeadTail.first;
693 OS << Inst;
694 HeadTail = HeadTail.second.split('\n');
695 if (HeadTail.first.empty())
696 OS << " } " << PacketBundle.second;
697 PrintReloc();
698 Bytes = Bytes.slice(4);
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000699 Address.Address += 4;
Sid Manningd9f28732018-05-14 19:46:08 +0000700 }
701 }
702};
703HexagonPrettyPrinter HexagonPrettyPrinterInst;
704
705class AMDGCNPrettyPrinter : public PrettyPrinter {
706public:
707 void printInst(MCInstPrinter &IP, const MCInst *MI, ArrayRef<uint8_t> Bytes,
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000708 object::SectionedAddress Address, raw_ostream &OS,
709 StringRef Annot, MCSubtargetInfo const &STI, SourcePrinter *SP,
Sid Manningd9f28732018-05-14 19:46:08 +0000710 std::vector<RelocationRef> *Rels) override {
711 if (SP && (PrintSource || PrintLines))
712 SP->printSourceLine(OS, Address);
713
714 typedef support::ulittle32_t U32;
715
716 if (MI) {
717 SmallString<40> InstStr;
718 raw_svector_ostream IS(InstStr);
719
720 IP.printInst(MI, IS, "", STI);
721
722 OS << left_justify(IS.str(), 60);
723 } else {
724 // an unrecognized encoding - this is probably data so represent it
725 // using the .long directive, or .byte directive if fewer than 4 bytes
726 // remaining
727 if (Bytes.size() >= 4) {
728 OS << format("\t.long 0x%08" PRIx32 " ",
729 static_cast<uint32_t>(*reinterpret_cast<const U32*>(Bytes.data())));
730 OS.indent(42);
731 } else {
732 OS << format("\t.byte 0x%02" PRIx8, Bytes[0]);
733 for (unsigned int i = 1; i < Bytes.size(); i++)
734 OS << format(", 0x%02" PRIx8, Bytes[i]);
735 OS.indent(55 - (6 * Bytes.size()));
736 }
737 }
738
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000739 OS << format("// %012" PRIX64 ": ", Address.Address);
Sid Manningd9f28732018-05-14 19:46:08 +0000740 if (Bytes.size() >=4) {
741 for (auto D : makeArrayRef(reinterpret_cast<const U32*>(Bytes.data()),
742 Bytes.size() / sizeof(U32)))
743 // D should be explicitly casted to uint32_t here as it is passed
744 // by format to snprintf as vararg.
745 OS << format("%08" PRIX32 " ", static_cast<uint32_t>(D));
746 } else {
747 for (unsigned int i = 0; i < Bytes.size(); i++)
748 OS << format("%02" PRIX8 " ", Bytes[i]);
749 }
750
751 if (!Annot.empty())
752 OS << "// " << Annot;
753 }
754};
755AMDGCNPrettyPrinter AMDGCNPrettyPrinterInst;
756
757class BPFPrettyPrinter : public PrettyPrinter {
758public:
759 void printInst(MCInstPrinter &IP, const MCInst *MI, ArrayRef<uint8_t> Bytes,
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000760 object::SectionedAddress Address, raw_ostream &OS,
761 StringRef Annot, MCSubtargetInfo const &STI, SourcePrinter *SP,
Sid Manningd9f28732018-05-14 19:46:08 +0000762 std::vector<RelocationRef> *Rels) override {
763 if (SP && (PrintSource || PrintLines))
764 SP->printSourceLine(OS, Address);
765 if (!NoLeadingAddr)
Alexey Lapshin77fc1f62019-02-27 13:17:36 +0000766 OS << format("%8" PRId64 ":", Address.Address / 8);
Sid Manningd9f28732018-05-14 19:46:08 +0000767 if (!NoShowRawInsn) {
768 OS << "\t";
769 dumpBytes(Bytes, OS);
770 }
771 if (MI)
772 IP.printInst(MI, OS, "", STI);
773 else
Fangrui Song7d4ad142019-04-10 05:31:21 +0000774 OS << "\t<unknown>";
Sid Manningd9f28732018-05-14 19:46:08 +0000775 }
776};
777BPFPrettyPrinter BPFPrettyPrinterInst;
778
779PrettyPrinter &selectPrettyPrinter(Triple const &Triple) {
780 switch(Triple.getArch()) {
781 default:
782 return PrettyPrinterInst;
783 case Triple::hexagon:
784 return HexagonPrettyPrinterInst;
785 case Triple::amdgcn:
786 return AMDGCNPrettyPrinterInst;
787 case Triple::bpfel:
788 case Triple::bpfeb:
789 return BPFPrettyPrinterInst;
790 }
791}
792}
793
Sam Koltonc05d7782016-08-17 10:17:57 +0000794static uint8_t getElfSymbolType(const ObjectFile *Obj, const SymbolRef &Sym) {
795 assert(Obj->isELF());
796 if (auto *Elf32LEObj = dyn_cast<ELF32LEObjectFile>(Obj))
797 return Elf32LEObj->getSymbol(Sym.getRawDataRefImpl())->getType();
798 if (auto *Elf64LEObj = dyn_cast<ELF64LEObjectFile>(Obj))
799 return Elf64LEObj->getSymbol(Sym.getRawDataRefImpl())->getType();
800 if (auto *Elf32BEObj = dyn_cast<ELF32BEObjectFile>(Obj))
801 return Elf32BEObj->getSymbol(Sym.getRawDataRefImpl())->getType();
802 if (auto *Elf64BEObj = cast<ELF64BEObjectFile>(Obj))
803 return Elf64BEObj->getSymbol(Sym.getRawDataRefImpl())->getType();
804 llvm_unreachable("Unsupported binary format");
805}
806
Sam Parker5fba45a2017-02-08 09:44:18 +0000807template <class ELFT> static void
808addDynamicElfSymbols(const ELFObjectFile<ELFT> *Obj,
809 std::map<SectionRef, SectionSymbolsTy> &AllSymbols) {
810 for (auto Symbol : Obj->getDynamicSymbolIterators()) {
811 uint8_t SymbolType = Symbol.getELFType();
812 if (SymbolType != ELF::STT_FUNC || Symbol.getSize() == 0)
813 continue;
814
Fangrui Songe7834bd2019-04-07 08:19:55 +0000815 uint64_t Address = unwrapOrError(Symbol.getAddress(), Obj->getFileName());
816 StringRef Name = unwrapOrError(Symbol.getName(), Obj->getFileName());
817 if (Name.empty())
Sam Parker5fba45a2017-02-08 09:44:18 +0000818 continue;
819
Fangrui Songe7834bd2019-04-07 08:19:55 +0000820 section_iterator SecI =
821 unwrapOrError(Symbol.getSection(), Obj->getFileName());
Sam Parker5fba45a2017-02-08 09:44:18 +0000822 if (SecI == Obj->section_end())
823 continue;
824
Fangrui Songe7834bd2019-04-07 08:19:55 +0000825 AllSymbols[*SecI].emplace_back(Address, Name, SymbolType);
Sam Parker5fba45a2017-02-08 09:44:18 +0000826 }
827}
828
829static void
830addDynamicElfSymbols(const ObjectFile *Obj,
831 std::map<SectionRef, SectionSymbolsTy> &AllSymbols) {
832 assert(Obj->isELF());
833 if (auto *Elf32LEObj = dyn_cast<ELF32LEObjectFile>(Obj))
834 addDynamicElfSymbols(Elf32LEObj, AllSymbols);
835 else if (auto *Elf64LEObj = dyn_cast<ELF64LEObjectFile>(Obj))
836 addDynamicElfSymbols(Elf64LEObj, AllSymbols);
837 else if (auto *Elf32BEObj = dyn_cast<ELF32BEObjectFile>(Obj))
838 addDynamicElfSymbols(Elf32BEObj, AllSymbols);
839 else if (auto *Elf64BEObj = cast<ELF64BEObjectFile>(Obj))
840 addDynamicElfSymbols(Elf64BEObj, AllSymbols);
841 else
842 llvm_unreachable("Unsupported binary format");
843}
844
Joel Galenson134cf472018-08-24 15:21:57 +0000845static void addPltEntries(const ObjectFile *Obj,
846 std::map<SectionRef, SectionSymbolsTy> &AllSymbols,
847 StringSaver &Saver) {
848 Optional<SectionRef> Plt = None;
849 for (const SectionRef &Section : Obj->sections()) {
850 StringRef Name;
851 if (Section.getName(Name))
852 continue;
853 if (Name == ".plt")
854 Plt = Section;
855 }
856 if (!Plt)
857 return;
858 if (auto *ElfObj = dyn_cast<ELFObjectFileBase>(Obj)) {
859 for (auto PltEntry : ElfObj->getPltAddresses()) {
860 SymbolRef Symbol(PltEntry.first, ElfObj);
Joel Galenson134cf472018-08-24 15:21:57 +0000861 uint8_t SymbolType = getElfSymbolType(Obj, Symbol);
862
Fangrui Songe7834bd2019-04-07 08:19:55 +0000863 StringRef Name = unwrapOrError(Symbol.getName(), Obj->getFileName());
864 if (!Name.empty())
865 AllSymbols[*Plt].emplace_back(
866 PltEntry.second, Saver.save((Name + "@plt").str()), SymbolType);
Joel Galenson134cf472018-08-24 15:21:57 +0000867 }
868 }
869}
870
George Rimar70d197d2019-01-10 14:55:26 +0000871// Normally the disassembly output will skip blocks of zeroes. This function
872// returns the number of zero bytes that can be skipped when dumping the
873// disassembly of the instructions in Buf.
874static size_t countSkippableZeroBytes(ArrayRef<uint8_t> Buf) {
George Rimar70d197d2019-01-10 14:55:26 +0000875 // Find the number of leading zeroes.
876 size_t N = 0;
877 while (N < Buf.size() && !Buf[N])
878 ++N;
879
880 // We may want to skip blocks of zero bytes, but unless we see
881 // at least 8 of them in a row.
882 if (N < 8)
883 return 0;
884
885 // We skip zeroes in multiples of 4 because do not want to truncate an
886 // instruction if it starts with a zero byte.
887 return N & ~0x3;
888}
889
George Rimar121fcd72019-01-22 14:09:37 +0000890// Returns a map from sections to their relocations.
891static std::map<SectionRef, std::vector<RelocationRef>>
Fangrui Song523758e2019-04-15 15:31:42 +0000892getRelocsMap(object::ObjectFile const &Obj) {
George Rimar121fcd72019-01-22 14:09:37 +0000893 std::map<SectionRef, std::vector<RelocationRef>> Ret;
894 for (const SectionRef &Section : ToolSectionFilter(Obj)) {
895 section_iterator RelSec = Section.getRelocatedSection();
896 if (RelSec == Obj.section_end())
897 continue;
898 std::vector<RelocationRef> &V = Ret[*RelSec];
899 for (const RelocationRef &R : Section.relocations())
900 V.push_back(R);
901 // Sort relocations by address.
902 llvm::sort(V, isRelocAddressLess);
903 }
904 return Ret;
905}
906
George Rimar4c3b2972019-01-28 10:44:01 +0000907// Used for --adjust-vma to check if address should be adjusted by the
908// specified value for a given section.
909// For ELF we do not adjust non-allocatable sections like debug ones,
910// because they are not loadable.
911// TODO: implement for other file formats.
912static bool shouldAdjustVA(const SectionRef &Section) {
913 const ObjectFile *Obj = Section.getObject();
914 if (isa<object::ELFObjectFileBase>(Obj))
915 return ELFSectionRef(Section).getFlags() & ELF::SHF_ALLOC;
916 return false;
917}
918
Fangrui Song32087b62019-04-07 16:33:24 +0000919static uint64_t
920dumpARMELFData(uint64_t SectionAddr, uint64_t Index, uint64_t End,
921 const ObjectFile *Obj, ArrayRef<uint8_t> Bytes,
922 const std::vector<uint64_t> &TextMappingSymsAddr) {
923 support::endianness Endian =
924 Obj->isLittleEndian() ? support::little : support::big;
925 while (Index < End) {
926 outs() << format("%8" PRIx64 ":", SectionAddr + Index);
927 outs() << "\t";
928 if (Index + 4 <= End) {
929 dumpBytes(Bytes.slice(Index, 4), outs());
930 outs() << "\t.word\t"
931 << format_hex(
932 support::endian::read32(Bytes.data() + Index, Endian), 10);
933 Index += 4;
934 } else if (Index + 2 <= End) {
935 dumpBytes(Bytes.slice(Index, 2), outs());
936 outs() << "\t\t.short\t"
937 << format_hex(
938 support::endian::read16(Bytes.data() + Index, Endian), 6);
939 Index += 2;
940 } else {
941 dumpBytes(Bytes.slice(Index, 1), outs());
942 outs() << "\t\t.byte\t" << format_hex(Bytes[0], 4);
943 ++Index;
944 }
945 outs() << "\n";
946 if (std::binary_search(TextMappingSymsAddr.begin(),
947 TextMappingSymsAddr.end(), Index))
948 break;
949 }
950 return Index;
951}
952
953static void dumpELFData(uint64_t SectionAddr, uint64_t Index, uint64_t End,
954 ArrayRef<uint8_t> Bytes) {
955 // print out data up to 8 bytes at a time in hex and ascii
956 uint8_t AsciiData[9] = {'\0'};
957 uint8_t Byte;
958 int NumBytes = 0;
959
960 for (; Index < End; ++Index) {
961 if (NumBytes == 0) {
962 outs() << format("%8" PRIx64 ":", SectionAddr + Index);
963 outs() << "\t";
964 }
965 Byte = Bytes.slice(Index)[0];
966 outs() << format(" %02x", Byte);
967 AsciiData[NumBytes] = isPrint(Byte) ? Byte : '.';
968
969 uint8_t IndentOffset = 0;
970 NumBytes++;
971 if (Index == End - 1 || NumBytes > 8) {
972 // Indent the space for less than 8 bytes data.
973 // 2 spaces for byte and one for space between bytes
974 IndentOffset = 3 * (8 - NumBytes);
975 for (int Excess = NumBytes; Excess < 8; Excess++)
976 AsciiData[Excess] = '\0';
977 NumBytes = 8;
978 }
979 if (NumBytes == 8) {
980 AsciiData[8] = '\0';
981 outs() << std::string(IndentOffset, ' ') << " ";
982 outs() << reinterpret_cast<char *>(AsciiData);
983 outs() << '\n';
984 NumBytes = 0;
985 }
986 }
987}
988
George Rimarbcbe98b2019-01-23 10:33:26 +0000989static void disassembleObject(const Target *TheTarget, const ObjectFile *Obj,
990 MCContext &Ctx, MCDisassembler *DisAsm,
991 const MCInstrAnalysis *MIA, MCInstPrinter *IP,
992 const MCSubtargetInfo *STI, PrettyPrinter &PIP,
993 SourcePrinter &SP, bool InlineRelocs) {
George Rimar121fcd72019-01-22 14:09:37 +0000994 std::map<SectionRef, std::vector<RelocationRef>> RelocMap;
995 if (InlineRelocs)
996 RelocMap = getRelocsMap(*Obj);
Mark Seaborn0929d3d2014-01-25 17:38:19 +0000997
David Majnemer81afca62015-07-07 22:06:59 +0000998 // Create a mapping from virtual address to symbol name. This is used to
David Majnemerfbb1c3a2015-11-18 02:49:19 +0000999 // pretty print the symbols while disassembling.
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001000 std::map<SectionRef, SectionSymbolsTy> AllSymbols;
Sterling Augustinebc78b622018-06-28 18:57:13 +00001001 SectionSymbolsTy AbsoluteSymbols;
Fangrui Songe7834bd2019-04-07 08:19:55 +00001002 const StringRef FileName = Obj->getFileName();
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001003 for (const SymbolRef &Symbol : Obj->symbols()) {
Fangrui Songe7834bd2019-04-07 08:19:55 +00001004 uint64_t Address = unwrapOrError(Symbol.getAddress(), FileName);
David Majnemer2603a8fa2015-07-09 18:11:40 +00001005
Fangrui Songe7834bd2019-04-07 08:19:55 +00001006 StringRef Name = unwrapOrError(Symbol.getName(), FileName);
1007 if (Name.empty())
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001008 continue;
David Majnemer81afca62015-07-07 22:06:59 +00001009
Sam Koltonc05d7782016-08-17 10:17:57 +00001010 uint8_t SymbolType = ELF::STT_NOTYPE;
Matt Davis82937e42019-01-31 19:42:21 +00001011 if (Obj->isELF()) {
Sam Koltonc05d7782016-08-17 10:17:57 +00001012 SymbolType = getElfSymbolType(Obj, Symbol);
Matt Davis82937e42019-01-31 19:42:21 +00001013 if (SymbolType == ELF::STT_SECTION)
1014 continue;
1015 }
David Majnemer81afca62015-07-07 22:06:59 +00001016
Fangrui Songe7834bd2019-04-07 08:19:55 +00001017 section_iterator SecI = unwrapOrError(Symbol.getSection(), FileName);
Sterling Augustinebc78b622018-06-28 18:57:13 +00001018 if (SecI != Obj->section_end())
Fangrui Songe7834bd2019-04-07 08:19:55 +00001019 AllSymbols[*SecI].emplace_back(Address, Name, SymbolType);
Sterling Augustinebc78b622018-06-28 18:57:13 +00001020 else
Fangrui Songe7834bd2019-04-07 08:19:55 +00001021 AbsoluteSymbols.emplace_back(Address, Name, SymbolType);
David Majnemer81afca62015-07-07 22:06:59 +00001022 }
Sam Parker5fba45a2017-02-08 09:44:18 +00001023 if (AllSymbols.empty() && Obj->isELF())
1024 addDynamicElfSymbols(Obj, AllSymbols);
David Majnemer81afca62015-07-07 22:06:59 +00001025
Joel Galenson134cf472018-08-24 15:21:57 +00001026 BumpPtrAllocator A;
1027 StringSaver Saver(A);
1028 addPltEntries(Obj, AllSymbols, Saver);
1029
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001030 // Create a mapping from virtual address to section.
1031 std::vector<std::pair<uint64_t, SectionRef>> SectionAddresses;
1032 for (SectionRef Sec : Obj->sections())
1033 SectionAddresses.emplace_back(Sec.getAddress(), Sec);
1034 array_pod_sort(SectionAddresses.begin(), SectionAddresses.end());
1035
1036 // Linked executables (.exe and .dll files) typically don't include a real
1037 // symbol table but they might contain an export table.
1038 if (const auto *COFFObj = dyn_cast<COFFObjectFile>(Obj)) {
1039 for (const auto &ExportEntry : COFFObj->export_directories()) {
1040 StringRef Name;
1041 error(ExportEntry.getSymbolName(Name));
1042 if (Name.empty())
1043 continue;
1044 uint32_t RVA;
1045 error(ExportEntry.getExportRVA(RVA));
1046
1047 uint64_t VA = COFFObj->getImageBase() + RVA;
Fangrui Songc82e92b2019-04-17 07:58:05 +00001048 auto Sec = llvm::bsearch(
1049 SectionAddresses, [VA](const std::pair<uint64_t, SectionRef> &RHS) {
1050 return VA < RHS.first;
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001051 });
Fangrui Song545ed222019-04-07 05:32:16 +00001052 if (Sec != SectionAddresses.begin()) {
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001053 --Sec;
Sam Koltonc05d7782016-08-17 10:17:57 +00001054 AllSymbols[Sec->second].emplace_back(VA, Name, ELF::STT_NOTYPE);
Fangrui Song545ed222019-04-07 05:32:16 +00001055 } else
Sterling Augustinebc78b622018-06-28 18:57:13 +00001056 AbsoluteSymbols.emplace_back(VA, Name, ELF::STT_NOTYPE);
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001057 }
1058 }
1059
1060 // Sort all the symbols, this allows us to use a simple binary search to find
1061 // a symbol near an address.
1062 for (std::pair<const SectionRef, SectionSymbolsTy> &SecSyms : AllSymbols)
1063 array_pod_sort(SecSyms.second.begin(), SecSyms.second.end());
Sterling Augustinebc78b622018-06-28 18:57:13 +00001064 array_pod_sort(AbsoluteSymbols.begin(), AbsoluteSymbols.end());
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001065
Colin LeMahieu77804be2015-07-29 15:45:39 +00001066 for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
Colin LeMahieuf34933e2015-07-23 20:58:49 +00001067 if (!DisassembleAll && (!Section.isText() || Section.isVirtual()))
Mark Seaborneb03ac52014-01-25 00:32:01 +00001068 continue;
Michael J. Spencer1d6167f2011-06-25 17:55:23 +00001069
Rafael Espindola80291272014-10-08 15:28:58 +00001070 uint64_t SectionAddr = Section.getAddress();
1071 uint64_t SectSize = Section.getSize();
David Majnemer185b5b12014-11-11 09:58:25 +00001072 if (!SectSize)
1073 continue;
Simon Atanasyan2b614e12014-02-24 22:12:11 +00001074
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001075 // Get the list of all the symbols in this section.
1076 SectionSymbolsTy &Symbols = AllSymbols[Section];
Davide Italianof0706882015-10-01 21:57:09 +00001077 std::vector<uint64_t> DataMappingSymsAddr;
1078 std::vector<uint64_t> TextMappingSymsAddr;
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001079 if (isArmElf(Obj)) {
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001080 for (const auto &Symb : Symbols) {
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001081 uint64_t Address = std::get<0>(Symb);
1082 StringRef Name = std::get<1>(Symb);
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001083 if (Name.startswith("$d"))
David Majnemer153722d2015-11-18 04:35:32 +00001084 DataMappingSymsAddr.push_back(Address - SectionAddr);
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001085 if (Name.startswith("$x"))
David Majnemer153722d2015-11-18 04:35:32 +00001086 TextMappingSymsAddr.push_back(Address - SectionAddr);
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001087 if (Name.startswith("$a"))
1088 TextMappingSymsAddr.push_back(Address - SectionAddr);
1089 if (Name.startswith("$t"))
1090 TextMappingSymsAddr.push_back(Address - SectionAddr);
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001091 }
1092 }
1093
Fangrui Song0cac7262018-09-27 02:13:45 +00001094 llvm::sort(DataMappingSymsAddr);
1095 llvm::sort(TextMappingSymsAddr);
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001096
Sam Kolton3381d7a2016-10-06 13:46:08 +00001097 if (Obj->isELF() && Obj->getArch() == Triple::amdgcn) {
1098 // AMDGPU disassembler uses symbolizer for printing labels
1099 std::unique_ptr<MCRelocationInfo> RelInfo(
1100 TheTarget->createMCRelocationInfo(TripleName, Ctx));
1101 if (RelInfo) {
1102 std::unique_ptr<MCSymbolizer> Symbolizer(
1103 TheTarget->createMCSymbolizer(
1104 TripleName, nullptr, nullptr, &Symbols, &Ctx, std::move(RelInfo)));
1105 DisAsm->setSymbolizer(std::move(Symbolizer));
1106 }
1107 }
1108
Rafael Espindolaa9f810b2012-12-21 03:47:03 +00001109 StringRef SegmentName = "";
Mark Seaborneb03ac52014-01-25 00:32:01 +00001110 if (const MachOObjectFile *MachO = dyn_cast<const MachOObjectFile>(Obj)) {
Alexey Samsonov48803e52014-03-13 14:37:36 +00001111 DataRefImpl DR = Section.getRawDataRefImpl();
Rafael Espindola56f976f2013-04-18 18:08:55 +00001112 SegmentName = MachO->getSectionFinalSegmentName(DR);
Rafael Espindolaa9f810b2012-12-21 03:47:03 +00001113 }
Rafael Aulerb0e4b912018-03-09 19:13:44 +00001114 StringRef SectionName;
1115 error(Section.getName(SectionName));
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001116
Rafael Espindola7884c952015-06-04 15:01:05 +00001117 // If the section has no symbol at the start, just insert a dummy one.
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001118 if (Symbols.empty() || std::get<0>(Symbols[0]) != 0) {
Rafael Aulerb0e4b912018-03-09 19:13:44 +00001119 Symbols.insert(
1120 Symbols.begin(),
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001121 std::make_tuple(SectionAddr, SectionName,
1122 Section.isText() ? ELF::STT_FUNC : ELF::STT_OBJECT));
Sam Koltonc05d7782016-08-17 10:17:57 +00001123 }
Alp Tokere69170a2014-06-26 22:52:05 +00001124
1125 SmallString<40> Comments;
1126 raw_svector_ostream CommentStream(Comments);
Ahmed Bougachaad1084d2013-05-24 00:39:57 +00001127
Rafael Espindola7fc5b872014-11-12 02:04:27 +00001128 StringRef BytesStr;
Davide Italianoccd53fe2015-08-05 07:18:31 +00001129 error(Section.getContents(BytesStr));
Fangrui Song6a0746a2019-04-07 03:58:42 +00001130 ArrayRef<uint8_t> Bytes = arrayRefFromStringRef(BytesStr);
Rafael Espindola7fc5b872014-11-12 02:04:27 +00001131
George Rimar4c3b2972019-01-28 10:44:01 +00001132 uint64_t VMAAdjustment = 0;
1133 if (shouldAdjustVA(Section))
1134 VMAAdjustment = AdjustVMA;
1135
Michael J. Spencer2670c252011-01-20 06:39:06 +00001136 uint64_t Size;
1137 uint64_t Index;
Rafael Aulerb0e4b912018-03-09 19:13:44 +00001138 bool PrintedSection = false;
George Rimar121fcd72019-01-22 14:09:37 +00001139 std::vector<RelocationRef> Rels = RelocMap[Section];
George Rimar73a27232019-01-15 09:19:18 +00001140 std::vector<RelocationRef>::const_iterator RelCur = Rels.begin();
1141 std::vector<RelocationRef>::const_iterator RelEnd = Rels.end();
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001142 // Disassemble symbol by symbol.
George Rimar73a27232019-01-15 09:19:18 +00001143 for (unsigned SI = 0, SE = Symbols.size(); SI != SE; ++SI) {
Fangrui Song8f28f7a2019-04-20 02:10:48 +00001144 // Skip if --disassemble-functions is not empty and the symbol is not in
1145 // the list.
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001146 if (!DisasmFuncsSet.empty() &&
1147 !DisasmFuncsSet.count(std::get<1>(Symbols[SI])))
Rafael Aulerb0e4b912018-03-09 19:13:44 +00001148 continue;
1149
Fangrui Song8f28f7a2019-04-20 02:10:48 +00001150 uint64_t Start = std::get<0>(Symbols[SI]);
1151
1152 // The end is the section end, the beginning of the next symbol, or
1153 // --stop-address.
1154 uint64_t End = std::min<uint64_t>(SectionAddr + SectSize, StopAddress);
1155 if (SI + 1 < SE)
1156 End = std::min(End, std::get<0>(Symbols[SI + 1]));
1157 if (Start >= End || Start >= StopAddress || End <= StartAddress)
1158 continue;
1159 Start -= SectionAddr;
1160 End -= SectionAddr;
1161
Rafael Aulerb0e4b912018-03-09 19:13:44 +00001162 if (!PrintedSection) {
1163 PrintedSection = true;
1164 outs() << "Disassembly of section ";
1165 if (!SegmentName.empty())
1166 outs() << SegmentName << ",";
1167 outs() << SectionName << ':';
1168 }
1169
Valery Pykhtinde048052016-04-07 07:24:01 +00001170 if (Obj->isELF() && Obj->getArch() == Triple::amdgcn) {
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001171 if (std::get<2>(Symbols[SI]) == ELF::STT_AMDGPU_HSA_KERNEL) {
Sam Koltonc05d7782016-08-17 10:17:57 +00001172 // skip amd_kernel_code_t at the begining of kernel symbol (256 bytes)
1173 Start += 256;
1174 }
George Rimar73a27232019-01-15 09:19:18 +00001175 if (SI == SE - 1 ||
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001176 std::get<2>(Symbols[SI + 1]) == ELF::STT_AMDGPU_HSA_KERNEL) {
Sam Koltonc05d7782016-08-17 10:17:57 +00001177 // cut trailing zeroes at the end of kernel
1178 // cut up to 256 bytes
1179 const uint64_t EndAlign = 256;
1180 const auto Limit = End - (std::min)(EndAlign, End - Start);
1181 while (End > Limit &&
1182 *reinterpret_cast<const support::ulittle32_t*>(&Bytes[End - 4]) == 0)
1183 End -= 4;
1184 }
Valery Pykhtinde048052016-04-07 07:24:01 +00001185 }
1186
George Rimar6622d412018-12-19 10:21:45 +00001187 outs() << '\n';
George Rimar3ba0f3c02019-01-09 14:43:33 +00001188 if (!NoLeadingAddr)
George Rimar4c3b2972019-01-28 10:44:01 +00001189 outs() << format("%016" PRIx64 " ",
1190 SectionAddr + Start + VMAAdjustment);
George Rimar3ba0f3c02019-01-09 14:43:33 +00001191
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001192 StringRef SymbolName = std::get<1>(Symbols[SI]);
George Rimar6622d412018-12-19 10:21:45 +00001193 if (Demangle)
1194 outs() << demangle(SymbolName) << ":\n";
1195 else
1196 outs() << SymbolName << ":\n";
Michael J. Spencer2670c252011-01-20 06:39:06 +00001197
Francis Visoiu Mistrih18346822018-04-19 17:02:57 +00001198 // Don't print raw contents of a virtual section. A virtual section
1199 // doesn't have any contents in the file.
1200 if (Section.isVirtual()) {
1201 outs() << "...\n";
1202 continue;
1203 }
1204
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001205#ifndef NDEBUG
Mark Seaborneb03ac52014-01-25 00:32:01 +00001206 raw_ostream &DebugOut = DebugFlag ? dbgs() : nulls();
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001207#else
Mark Seaborneb03ac52014-01-25 00:32:01 +00001208 raw_ostream &DebugOut = nulls();
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001209#endif
1210
Wouter van Oortmerssenf3b762a2019-01-17 18:14:09 +00001211 // Some targets (like WebAssembly) have a special prelude at the start
1212 // of each symbol.
1213 DisAsm->onSymbolStart(SymbolName, Size, Bytes.slice(Start, End - Start),
1214 SectionAddr + Start, DebugOut, CommentStream);
1215 Start += Size;
1216
Fangrui Song32087b62019-04-07 16:33:24 +00001217 Index = Start;
1218 if (SectionAddr < StartAddress)
1219 Index = std::max<uint64_t>(Index, StartAddress - SectionAddr);
Owen Andersona0c3b972011-09-15 23:38:46 +00001220
Fangrui Song32087b62019-04-07 16:33:24 +00001221 // If there is a data symbol inside an ELF text section and we are
1222 // only disassembling text (applicable all architectures), we are in a
1223 // situation where we must print the data and not disassemble it.
1224 if (Obj->isELF() && std::get<2>(Symbols[SI]) == ELF::STT_OBJECT &&
1225 !DisassembleAll && Section.isText()) {
1226 dumpELFData(SectionAddr, Index, End, Bytes);
1227 Index = End;
1228 }
1229
1230 bool CheckARMELFData = isArmElf(Obj) &&
1231 std::get<2>(Symbols[SI]) != ELF::STT_OBJECT &&
1232 !DisassembleAll;
Fangrui Song32087b62019-04-07 16:33:24 +00001233 while (Index < End) {
1234 // AArch64 ELF binaries can interleave data and text in the same
1235 // section. We rely on the markers introduced to understand what we
1236 // need to dump. If the data marker is within a function, it is
1237 // denoted as a word/short etc.
1238 if (CheckARMELFData &&
Fangrui Song545ed222019-04-07 05:32:16 +00001239 std::binary_search(DataMappingSymsAddr.begin(),
1240 DataMappingSymsAddr.end(), Index)) {
Fangrui Song32087b62019-04-07 16:33:24 +00001241 Index = dumpARMELFData(SectionAddr, Index, End, Obj, Bytes,
1242 TextMappingSymsAddr);
1243 continue;
Davide Italianof0706882015-10-01 21:57:09 +00001244 }
1245
Fangrui Song32087b62019-04-07 16:33:24 +00001246 // When -z or --disassemble-zeroes are given we always dissasemble
1247 // them. Otherwise we might want to skip zero bytes we see.
George Rimarc5f29202019-02-19 12:38:36 +00001248 if (!DisassembleZeroes) {
1249 uint64_t MaxOffset = End - Index;
1250 // For -reloc: print zero blocks patched by relocations, so that
1251 // relocations can be shown in the dump.
1252 if (RelCur != RelEnd)
1253 MaxOffset = RelCur->getOffset() - Index;
1254
1255 if (size_t N =
1256 countSkippableZeroBytes(Bytes.slice(Index, MaxOffset))) {
1257 outs() << "\t\t..." << '\n';
1258 Index += N;
Fangrui Song32087b62019-04-07 16:33:24 +00001259 continue;
George Rimarc5f29202019-02-19 12:38:36 +00001260 }
George Rimar70d197d2019-01-10 14:55:26 +00001261 }
1262
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001263 // Disassemble a real instruction or a data when disassemble all is
1264 // provided
Fangrui Song996b9092019-04-08 01:22:38 +00001265 MCInst Inst;
Fangrui Song32087b62019-04-07 16:33:24 +00001266 bool Disassembled = DisAsm->getInstruction(
1267 Inst, Size, Bytes.slice(Index), SectionAddr + Index, DebugOut,
1268 CommentStream);
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001269 if (Size == 0)
1270 Size = 1;
Hemant Kulkarni8dfc0b52016-08-15 19:49:24 +00001271
Fangrui Song32087b62019-04-07 16:33:24 +00001272 PIP.printInst(
1273 *IP, Disassembled ? &Inst : nullptr, Bytes.slice(Index, Size),
1274 {SectionAddr + Index + VMAAdjustment, Section.getIndex()}, outs(),
1275 "", *STI, &SP, &Rels);
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001276 outs() << CommentStream.str();
1277 Comments.clear();
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001278
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001279 // Try to resolve the target of a call, tail call, etc. to a specific
1280 // symbol.
1281 if (MIA && (MIA->isCall(Inst) || MIA->isUnconditionalBranch(Inst) ||
1282 MIA->isConditionalBranch(Inst))) {
1283 uint64_t Target;
1284 if (MIA->evaluateBranch(Inst, SectionAddr + Index, Size, Target)) {
1285 // In a relocatable object, the target's section must reside in
1286 // the same section as the call instruction or it is accessed
1287 // through a relocation.
1288 //
1289 // In a non-relocatable object, the target may be in any section.
1290 //
1291 // N.B. We don't walk the relocations in the relocatable case yet.
1292 auto *TargetSectionSymbols = &Symbols;
1293 if (!Obj->isRelocatableObject()) {
Fangrui Songc82e92b2019-04-17 07:58:05 +00001294 auto It = llvm::bsearch(
1295 SectionAddresses,
1296 [=](const std::pair<uint64_t, SectionRef> &RHS) {
1297 return Target < RHS.first;
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001298 });
Fangrui Songc82e92b2019-04-17 07:58:05 +00001299 if (It != SectionAddresses.begin()) {
1300 --It;
1301 TargetSectionSymbols = &AllSymbols[It->second];
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001302 } else {
Sterling Augustinebc78b622018-06-28 18:57:13 +00001303 TargetSectionSymbols = &AbsoluteSymbols;
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001304 }
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001305 }
David Majnemer2603a8fa2015-07-09 18:11:40 +00001306
Fangrui Songc82e92b2019-04-17 07:58:05 +00001307 // Find the last symbol in the section whose offset is less than
Sterling Augustinebc78b622018-06-28 18:57:13 +00001308 // or equal to the target. If there isn't a section that contains
1309 // the target, find the nearest preceding absolute symbol.
Fangrui Songc82e92b2019-04-17 07:58:05 +00001310 auto TargetSym = llvm::bsearch(
1311 *TargetSectionSymbols,
1312 [=](const std::tuple<uint64_t, StringRef, uint8_t> &RHS) {
1313 return Target < std::get<0>(RHS);
Sterling Augustinebc78b622018-06-28 18:57:13 +00001314 });
1315 if (TargetSym == TargetSectionSymbols->begin()) {
1316 TargetSectionSymbols = &AbsoluteSymbols;
Fangrui Songc82e92b2019-04-17 07:58:05 +00001317 TargetSym = llvm::bsearch(
1318 AbsoluteSymbols,
1319 [=](const std::tuple<uint64_t, StringRef, uint8_t> &RHS) {
1320 return Target < std::get<0>(RHS);
Fangrui Song545ed222019-04-07 05:32:16 +00001321 });
Sterling Augustinebc78b622018-06-28 18:57:13 +00001322 }
1323 if (TargetSym != TargetSectionSymbols->begin()) {
1324 --TargetSym;
Clement Courbetd1a3bd42019-01-18 15:26:14 +00001325 uint64_t TargetAddress = std::get<0>(*TargetSym);
1326 StringRef TargetName = std::get<1>(*TargetSym);
1327 outs() << " <" << TargetName;
1328 uint64_t Disp = Target - TargetAddress;
Sterling Augustinebc78b622018-06-28 18:57:13 +00001329 if (Disp)
1330 outs() << "+0x" << Twine::utohexstr(Disp);
1331 outs() << '>';
David Majnemer81afca62015-07-07 22:06:59 +00001332 }
1333 }
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001334 }
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001335 outs() << "\n";
Michael J. Spencer51862b32011-10-13 22:17:18 +00001336
Sid Manningd9f28732018-05-14 19:46:08 +00001337 // Hexagon does this in pretty printer
George Rimarfd383e72019-01-23 10:52:38 +00001338 if (Obj->getArch() != Triple::hexagon) {
Sid Manningd9f28732018-05-14 19:46:08 +00001339 // Print relocation for instruction.
George Rimar73a27232019-01-15 09:19:18 +00001340 while (RelCur != RelEnd) {
George Rimar617adef2019-01-23 13:39:12 +00001341 uint64_t Offset = RelCur->getOffset();
Sid Manningd9f28732018-05-14 19:46:08 +00001342 // If this relocation is hidden, skip it.
Fangrui Song32087b62019-04-07 16:33:24 +00001343 if (getHidden(*RelCur) || SectionAddr + Offset < StartAddress) {
George Rimar73a27232019-01-15 09:19:18 +00001344 ++RelCur;
Sid Manningd9f28732018-05-14 19:46:08 +00001345 continue;
1346 }
1347
George Rimar740974d2019-01-28 10:48:54 +00001348 // Stop when RelCur's offset is past the current instruction.
George Rimar617adef2019-01-23 13:39:12 +00001349 if (Offset >= Index + Size)
George Rimar73a27232019-01-15 09:19:18 +00001350 break;
George Rimar617adef2019-01-23 13:39:12 +00001351
George Rimar4c3b2972019-01-28 10:44:01 +00001352 // When --adjust-vma is used, update the address printed.
1353 if (RelCur->getSymbol() != Obj->symbol_end()) {
1354 Expected<section_iterator> SymSI =
1355 RelCur->getSymbol()->getSection();
1356 if (SymSI && *SymSI != Obj->section_end() &&
Fangrui Song32087b62019-04-07 16:33:24 +00001357 shouldAdjustVA(**SymSI))
George Rimar4c3b2972019-01-28 10:44:01 +00001358 Offset += AdjustVMA;
1359 }
1360
George Rimar617adef2019-01-23 13:39:12 +00001361 printRelocation(*RelCur, SectionAddr + Offset,
1362 Obj->getBytesInAddress());
George Rimar73a27232019-01-15 09:19:18 +00001363 ++RelCur;
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001364 }
George Rimarfd383e72019-01-23 10:52:38 +00001365 }
Fangrui Song32087b62019-04-07 16:33:24 +00001366
1367 Index += Size;
Benjamin Kramer87ee76c2011-07-20 19:37:35 +00001368 }
Michael J. Spencer2670c252011-01-20 06:39:06 +00001369 }
1370 }
1371}
1372
George Rimarbcbe98b2019-01-23 10:33:26 +00001373static void disassembleObject(const ObjectFile *Obj, bool InlineRelocs) {
1374 if (StartAddress > StopAddress)
1375 error("Start address should be less than stop address");
1376
1377 const Target *TheTarget = getTarget(Obj);
1378
1379 // Package up features to be passed to target/subtarget
1380 SubtargetFeatures Features = Obj->getFeatures();
1381 if (!MAttrs.empty())
1382 for (unsigned I = 0; I != MAttrs.size(); ++I)
1383 Features.AddFeature(MAttrs[I]);
1384
1385 std::unique_ptr<const MCRegisterInfo> MRI(
1386 TheTarget->createMCRegInfo(TripleName));
1387 if (!MRI)
1388 report_error(Obj->getFileName(),
1389 "no register info for target " + TripleName);
1390
1391 // Set up disassembler.
1392 std::unique_ptr<const MCAsmInfo> AsmInfo(
1393 TheTarget->createMCAsmInfo(*MRI, TripleName));
1394 if (!AsmInfo)
1395 report_error(Obj->getFileName(),
1396 "no assembly info for target " + TripleName);
1397 std::unique_ptr<const MCSubtargetInfo> STI(
1398 TheTarget->createMCSubtargetInfo(TripleName, MCPU, Features.getString()));
1399 if (!STI)
1400 report_error(Obj->getFileName(),
1401 "no subtarget info for target " + TripleName);
1402 std::unique_ptr<const MCInstrInfo> MII(TheTarget->createMCInstrInfo());
1403 if (!MII)
1404 report_error(Obj->getFileName(),
1405 "no instruction info for target " + TripleName);
1406 MCObjectFileInfo MOFI;
1407 MCContext Ctx(AsmInfo.get(), MRI.get(), &MOFI);
1408 // FIXME: for now initialize MCObjectFileInfo with default values
1409 MOFI.InitMCObjectFileInfo(Triple(TripleName), false, Ctx);
1410
1411 std::unique_ptr<MCDisassembler> DisAsm(
1412 TheTarget->createMCDisassembler(*STI, Ctx));
1413 if (!DisAsm)
1414 report_error(Obj->getFileName(),
1415 "no disassembler for target " + TripleName);
1416
1417 std::unique_ptr<const MCInstrAnalysis> MIA(
1418 TheTarget->createMCInstrAnalysis(MII.get()));
1419
1420 int AsmPrinterVariant = AsmInfo->getAssemblerDialect();
1421 std::unique_ptr<MCInstPrinter> IP(TheTarget->createMCInstPrinter(
1422 Triple(TripleName), AsmPrinterVariant, *AsmInfo, *MII, *MRI));
1423 if (!IP)
1424 report_error(Obj->getFileName(),
1425 "no instruction printer for target " + TripleName);
1426 IP->setPrintImmHex(PrintImmHex);
1427
1428 PrettyPrinter &PIP = selectPrettyPrinter(Triple(TripleName));
1429 SourcePrinter SP(Obj, TheTarget->getName());
1430
Igor Kudrin2d3faad2019-02-26 12:15:14 +00001431 for (StringRef Opt : DisassemblerOptions)
1432 if (!IP->applyTargetSpecificCLOption(Opt))
1433 error("Unrecognized disassembler option: " + Opt);
1434
George Rimarbcbe98b2019-01-23 10:33:26 +00001435 disassembleObject(TheTarget, Obj, Ctx, DisAsm.get(), MIA.get(), IP.get(),
1436 STI.get(), PIP, SP, InlineRelocs);
1437}
1438
Fangrui Song523758e2019-04-15 15:31:42 +00001439void printRelocations(const ObjectFile *Obj) {
Greg Fitzgerald18432272014-03-20 22:55:15 +00001440 StringRef Fmt = Obj->getBytesInAddress() > 4 ? "%016" PRIx64 :
1441 "%08" PRIx64;
Rafael Espindola9219fe72016-03-21 20:59:15 +00001442 // Regular objdump doesn't print relocations in non-relocatable object
1443 // files.
1444 if (!Obj->isRelocatableObject())
1445 return;
Rafael Espindolac66d7612014-08-17 19:09:37 +00001446
Colin LeMahieu77804be2015-07-29 15:45:39 +00001447 for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
Alexey Samsonov48803e52014-03-13 14:37:36 +00001448 if (Section.relocation_begin() == Section.relocation_end())
Michael J. Spencerba4a3622011-10-08 00:18:30 +00001449 continue;
George Rimar73a27232019-01-15 09:19:18 +00001450 StringRef SecName;
1451 error(Section.getName(SecName));
1452 outs() << "RELOCATION RECORDS FOR [" << SecName << "]:\n";
Alexey Samsonovaa4d2952014-03-14 14:22:49 +00001453 for (const RelocationRef &Reloc : Section.relocations()) {
George Rimar73a27232019-01-15 09:19:18 +00001454 uint64_t Address = Reloc.getOffset();
1455 SmallString<32> RelocName;
1456 SmallString<32> ValueStr;
1457 if (Address < StartAddress || Address > StopAddress || getHidden(Reloc))
Alexey Samsonovaa4d2952014-03-14 14:22:49 +00001458 continue;
George Rimar73a27232019-01-15 09:19:18 +00001459 Reloc.getTypeName(RelocName);
1460 error(getRelocationValueString(Reloc, ValueStr));
1461 outs() << format(Fmt.data(), Address) << " " << RelocName << " "
1462 << ValueStr << "\n";
Michael J. Spencerba4a3622011-10-08 00:18:30 +00001463 }
1464 outs() << "\n";
1465 }
1466}
1467
Fangrui Song523758e2019-04-15 15:31:42 +00001468void printDynamicRelocations(const ObjectFile *Obj) {
Paul Semelcb0f0432018-06-07 13:30:55 +00001469 // For the moment, this option is for ELF only
1470 if (!Obj->isELF())
1471 return;
1472
1473 const auto *Elf = dyn_cast<ELFObjectFileBase>(Obj);
Paul Semelcb0f0432018-06-07 13:30:55 +00001474 if (!Elf || Elf->getEType() != ELF::ET_DYN) {
1475 error("not a dynamic object");
1476 return;
1477 }
1478
Paul Semelcb0f0432018-06-07 13:30:55 +00001479 std::vector<SectionRef> DynRelSec = Obj->dynamic_relocation_sections();
1480 if (DynRelSec.empty())
1481 return;
1482
1483 outs() << "DYNAMIC RELOCATION RECORDS\n";
George Rimar73a27232019-01-15 09:19:18 +00001484 StringRef Fmt = Obj->getBytesInAddress() > 4 ? "%016" PRIx64 : "%08" PRIx64;
Paul Semelcb0f0432018-06-07 13:30:55 +00001485 for (const SectionRef &Section : DynRelSec) {
1486 if (Section.relocation_begin() == Section.relocation_end())
1487 continue;
1488 for (const RelocationRef &Reloc : Section.relocations()) {
George Rimar73a27232019-01-15 09:19:18 +00001489 uint64_t Address = Reloc.getOffset();
1490 SmallString<32> RelocName;
1491 SmallString<32> ValueStr;
1492 Reloc.getTypeName(RelocName);
1493 error(getRelocationValueString(Reloc, ValueStr));
1494 outs() << format(Fmt.data(), Address) << " " << RelocName << " "
1495 << ValueStr << "\n";
Paul Semelcb0f0432018-06-07 13:30:55 +00001496 }
1497 }
1498}
1499
George Rimar87fa2e62019-01-28 14:11:35 +00001500// Returns true if we need to show LMA column when dumping section headers. We
1501// show it only when the platform is ELF and either we have at least one section
1502// whose VMA and LMA are different and/or when --show-lma flag is used.
1503static bool shouldDisplayLMA(const ObjectFile *Obj) {
1504 if (!Obj->isELF())
1505 return false;
1506 for (const SectionRef &S : ToolSectionFilter(*Obj))
1507 if (S.getAddress() != getELFSectionLMA(S))
1508 return true;
1509 return ShowLMA;
1510}
1511
Fangrui Song523758e2019-04-15 15:31:42 +00001512void printSectionHeaders(const ObjectFile *Obj) {
George Rimar87fa2e62019-01-28 14:11:35 +00001513 bool HasLMAColumn = shouldDisplayLMA(Obj);
1514 if (HasLMAColumn)
1515 outs() << "Sections:\n"
1516 "Idx Name Size VMA LMA "
1517 "Type\n";
1518 else
1519 outs() << "Sections:\n"
1520 "Idx Name Size VMA Type\n";
1521
Colin LeMahieu77804be2015-07-29 15:45:39 +00001522 for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
Nick Lewyckyfcf84622011-10-10 21:21:34 +00001523 StringRef Name;
Davide Italianoccd53fe2015-08-05 07:18:31 +00001524 error(Section.getName(Name));
George Rimar87fa2e62019-01-28 14:11:35 +00001525 uint64_t VMA = Section.getAddress();
George Rimar4463ebe2019-01-28 16:36:12 +00001526 if (shouldAdjustVA(Section))
1527 VMA += AdjustVMA;
1528
Rafael Espindola80291272014-10-08 15:28:58 +00001529 uint64_t Size = Section.getSize();
1530 bool Text = Section.isText();
1531 bool Data = Section.isData();
1532 bool BSS = Section.isBSS();
Nick Lewyckyfcf84622011-10-10 21:21:34 +00001533 std::string Type = (std::string(Text ? "TEXT " : "") +
Michael J. Spencer8f67d472011-10-13 20:37:20 +00001534 (Data ? "DATA " : "") + (BSS ? "BSS" : ""));
George Rimar87fa2e62019-01-28 14:11:35 +00001535
1536 if (HasLMAColumn)
1537 outs() << format("%3d %-13s %08" PRIx64 " %016" PRIx64 " %016" PRIx64
1538 " %s\n",
1539 (unsigned)Section.getIndex(), Name.str().c_str(), Size,
1540 VMA, getELFSectionLMA(Section), Type.c_str());
1541 else
1542 outs() << format("%3d %-13s %08" PRIx64 " %016" PRIx64 " %s\n",
1543 (unsigned)Section.getIndex(), Name.str().c_str(), Size,
1544 VMA, Type.c_str());
Nick Lewyckyfcf84622011-10-10 21:21:34 +00001545 }
Xing GUO785edea2018-11-17 08:12:48 +00001546 outs() << "\n";
Nick Lewyckyfcf84622011-10-10 21:21:34 +00001547}
1548
Fangrui Song523758e2019-04-15 15:31:42 +00001549void printSectionContents(const ObjectFile *Obj) {
Colin LeMahieu77804be2015-07-29 15:45:39 +00001550 for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001551 StringRef Name;
1552 StringRef Contents;
Davide Italianoccd53fe2015-08-05 07:18:31 +00001553 error(Section.getName(Name));
Rafael Espindola80291272014-10-08 15:28:58 +00001554 uint64_t BaseAddr = Section.getAddress();
David Majnemer185b5b12014-11-11 09:58:25 +00001555 uint64_t Size = Section.getSize();
1556 if (!Size)
1557 continue;
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001558
1559 outs() << "Contents of section " << Name << ":\n";
David Majnemer185b5b12014-11-11 09:58:25 +00001560 if (Section.isBSS()) {
Alexey Samsonov209095c2013-04-16 10:53:11 +00001561 outs() << format("<skipping contents of bss section at [%04" PRIx64
David Majnemer8f6b04c2014-07-14 16:20:14 +00001562 ", %04" PRIx64 ")>\n",
1563 BaseAddr, BaseAddr + Size);
Alexey Samsonov209095c2013-04-16 10:53:11 +00001564 continue;
1565 }
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001566
Davide Italianoccd53fe2015-08-05 07:18:31 +00001567 error(Section.getContents(Contents));
David Majnemer8f6b04c2014-07-14 16:20:14 +00001568
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001569 // Dump out the content as hex and printable ascii characters.
George Rimar73a27232019-01-15 09:19:18 +00001570 for (std::size_t Addr = 0, End = Contents.size(); Addr < End; Addr += 16) {
1571 outs() << format(" %04" PRIx64 " ", BaseAddr + Addr);
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001572 // Dump line of hex.
George Rimar73a27232019-01-15 09:19:18 +00001573 for (std::size_t I = 0; I < 16; ++I) {
1574 if (I != 0 && I % 4 == 0)
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001575 outs() << ' ';
George Rimar73a27232019-01-15 09:19:18 +00001576 if (Addr + I < End)
1577 outs() << hexdigit((Contents[Addr + I] >> 4) & 0xF, true)
1578 << hexdigit(Contents[Addr + I] & 0xF, true);
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001579 else
1580 outs() << " ";
1581 }
1582 // Print ascii.
1583 outs() << " ";
George Rimar73a27232019-01-15 09:19:18 +00001584 for (std::size_t I = 0; I < 16 && Addr + I < End; ++I) {
1585 if (isPrint(static_cast<unsigned char>(Contents[Addr + I]) & 0xFF))
1586 outs() << Contents[Addr + I];
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001587 else
1588 outs() << ".";
1589 }
1590 outs() << "\n";
1591 }
1592 }
1593}
1594
Fangrui Song523758e2019-04-15 15:31:42 +00001595void printSymbolTable(const ObjectFile *O, StringRef ArchiveName,
1596 StringRef ArchitectureName) {
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001597 outs() << "SYMBOL TABLE:\n";
1598
George Rimar73a27232019-01-15 09:19:18 +00001599 if (const COFFObjectFile *Coff = dyn_cast<const COFFObjectFile>(O)) {
1600 printCOFFSymbolTable(Coff);
Rui Ueyama4e39f712014-03-18 18:58:51 +00001601 return;
1602 }
George Rimar8e0a70b2019-01-10 16:24:10 +00001603
Fangrui Songe7834bd2019-04-07 08:19:55 +00001604 const StringRef FileName = O->getFileName();
George Rimar73a27232019-01-15 09:19:18 +00001605 for (auto I = O->symbol_begin(), E = O->symbol_end(); I != E; ++I) {
George Rimar8e0a70b2019-01-10 16:24:10 +00001606 // Skip printing the special zero symbol when dumping an ELF file.
1607 // This makes the output consistent with the GNU objdump.
George Rimar73a27232019-01-15 09:19:18 +00001608 if (I == O->symbol_begin() && isa<ELFObjectFileBase>(O))
George Rimar8e0a70b2019-01-10 16:24:10 +00001609 continue;
1610
1611 const SymbolRef &Symbol = *I;
Fangrui Songe7834bd2019-04-07 08:19:55 +00001612 uint64_t Address = unwrapOrError(Symbol.getAddress(), ArchiveName, FileName,
1613 ArchitectureName);
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001614 if ((Address < StartAddress) || (Address > StopAddress))
1615 continue;
Fangrui Songe7834bd2019-04-07 08:19:55 +00001616 SymbolRef::Type Type = unwrapOrError(Symbol.getType(), ArchiveName,
1617 FileName, ArchitectureName);
Rui Ueyama4e39f712014-03-18 18:58:51 +00001618 uint32_t Flags = Symbol.getFlags();
Fangrui Songe7834bd2019-04-07 08:19:55 +00001619 section_iterator Section = unwrapOrError(Symbol.getSection(), ArchiveName,
1620 FileName, ArchitectureName);
Rafael Espindola75d5b542015-06-03 05:14:22 +00001621 StringRef Name;
Fangrui Songe7834bd2019-04-07 08:19:55 +00001622 if (Type == SymbolRef::ST_Debug && Section != O->section_end())
Rafael Espindola75d5b542015-06-03 05:14:22 +00001623 Section->getName(Name);
Fangrui Songe7834bd2019-04-07 08:19:55 +00001624 else
1625 Name = unwrapOrError(Symbol.getName(), ArchiveName, FileName,
1626 ArchitectureName);
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001627
Rui Ueyama4e39f712014-03-18 18:58:51 +00001628 bool Global = Flags & SymbolRef::SF_Global;
1629 bool Weak = Flags & SymbolRef::SF_Weak;
1630 bool Absolute = Flags & SymbolRef::SF_Absolute;
Colin LeMahieubc2f47a2015-01-23 20:06:24 +00001631 bool Common = Flags & SymbolRef::SF_Common;
Davide Italianocd2514d2015-04-30 23:08:53 +00001632 bool Hidden = Flags & SymbolRef::SF_Hidden;
David Meyer1df4b842012-02-28 23:47:53 +00001633
Rui Ueyama4e39f712014-03-18 18:58:51 +00001634 char GlobLoc = ' ';
1635 if (Type != SymbolRef::ST_Unknown)
1636 GlobLoc = Global ? 'g' : 'l';
1637 char Debug = (Type == SymbolRef::ST_Debug || Type == SymbolRef::ST_File)
1638 ? 'd' : ' ';
1639 char FileFunc = ' ';
1640 if (Type == SymbolRef::ST_File)
1641 FileFunc = 'f';
1642 else if (Type == SymbolRef::ST_Function)
1643 FileFunc = 'F';
Kristina Brooks0674f9d2018-11-11 17:47:13 +00001644 else if (Type == SymbolRef::ST_Data)
1645 FileFunc = 'O';
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001646
George Rimar73a27232019-01-15 09:19:18 +00001647 const char *Fmt = O->getBytesInAddress() > 4 ? "%016" PRIx64 :
Rui Ueyama4e39f712014-03-18 18:58:51 +00001648 "%08" PRIx64;
Michael J. Spencerd857c1c2013-01-10 22:40:50 +00001649
Rui Ueyama4e39f712014-03-18 18:58:51 +00001650 outs() << format(Fmt, Address) << " "
1651 << GlobLoc // Local -> 'l', Global -> 'g', Neither -> ' '
1652 << (Weak ? 'w' : ' ') // Weak?
1653 << ' ' // Constructor. Not supported yet.
1654 << ' ' // Warning. Not supported yet.
1655 << ' ' // Indirect reference to another symbol.
1656 << Debug // Debugging (d) or dynamic (D) symbol.
1657 << FileFunc // Name of function (F), file (f) or object (O).
1658 << ' ';
1659 if (Absolute) {
1660 outs() << "*ABS*";
Colin LeMahieubc2f47a2015-01-23 20:06:24 +00001661 } else if (Common) {
1662 outs() << "*COM*";
George Rimar73a27232019-01-15 09:19:18 +00001663 } else if (Section == O->section_end()) {
Rui Ueyama4e39f712014-03-18 18:58:51 +00001664 outs() << "*UND*";
1665 } else {
1666 if (const MachOObjectFile *MachO =
George Rimar73a27232019-01-15 09:19:18 +00001667 dyn_cast<const MachOObjectFile>(O)) {
Rui Ueyama4e39f712014-03-18 18:58:51 +00001668 DataRefImpl DR = Section->getRawDataRefImpl();
1669 StringRef SegmentName = MachO->getSectionFinalSegmentName(DR);
1670 outs() << SegmentName << ",";
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001671 }
Rui Ueyama4e39f712014-03-18 18:58:51 +00001672 StringRef SectionName;
Davide Italianoccd53fe2015-08-05 07:18:31 +00001673 error(Section->getName(SectionName));
Rui Ueyama4e39f712014-03-18 18:58:51 +00001674 outs() << SectionName;
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001675 }
Rafael Espindola5f7ade22015-06-23 15:45:38 +00001676
1677 outs() << '\t';
George Rimar73a27232019-01-15 09:19:18 +00001678 if (Common || isa<ELFObjectFileBase>(O)) {
Rafael Espindoladbb6bd32015-06-25 22:10:04 +00001679 uint64_t Val =
1680 Common ? Symbol.getAlignment() : ELFSymbolRef(Symbol).getSize();
Rafael Espindolaae3ac082015-06-23 18:34:25 +00001681 outs() << format("\t %08" PRIx64 " ", Val);
1682 }
Rafael Espindola5f7ade22015-06-23 15:45:38 +00001683
George Rimar73a27232019-01-15 09:19:18 +00001684 if (Hidden)
Davide Italianocd2514d2015-04-30 23:08:53 +00001685 outs() << ".hidden ";
George Rimar6622d412018-12-19 10:21:45 +00001686
1687 if (Demangle)
1688 outs() << demangle(Name) << '\n';
1689 else
1690 outs() << Name << '\n';
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001691 }
1692}
1693
George Rimar73a27232019-01-15 09:19:18 +00001694static void printUnwindInfo(const ObjectFile *O) {
Michael J. Spencer0c6ec482012-12-05 20:12:35 +00001695 outs() << "Unwind info:\n\n";
1696
George Rimar73a27232019-01-15 09:19:18 +00001697 if (const COFFObjectFile *Coff = dyn_cast<COFFObjectFile>(O))
1698 printCOFFUnwindInfo(Coff);
1699 else if (const MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(O))
Tim Northover4bd286a2014-08-01 13:07:19 +00001700 printMachOUnwindInfo(MachO);
George Rimar73a27232019-01-15 09:19:18 +00001701 else
Michael J. Spencer0c6ec482012-12-05 20:12:35 +00001702 // TODO: Extract DWARF dump tool to objdump.
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001703 WithColor::error(errs(), ToolName)
1704 << "This operation is only currently supported "
1705 "for COFF and MachO object files.\n";
Michael J. Spencer0c6ec482012-12-05 20:12:35 +00001706}
1707
Adrian Prantl437105a2015-07-08 02:04:15 +00001708/// Dump the raw contents of the __clangast section so the output can be piped
1709/// into llvm-bcanalyzer.
Fangrui Song523758e2019-04-15 15:31:42 +00001710void printRawClangAST(const ObjectFile *Obj) {
Adrian Prantl437105a2015-07-08 02:04:15 +00001711 if (outs().is_displayed()) {
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001712 WithColor::error(errs(), ToolName)
1713 << "The -raw-clang-ast option will dump the raw binary contents of "
1714 "the clang ast section.\n"
1715 "Please redirect the output to a file or another program such as "
1716 "llvm-bcanalyzer.\n";
Adrian Prantl437105a2015-07-08 02:04:15 +00001717 return;
1718 }
1719
1720 StringRef ClangASTSectionName("__clangast");
1721 if (isa<COFFObjectFile>(Obj)) {
1722 ClangASTSectionName = "clangast";
1723 }
1724
1725 Optional<object::SectionRef> ClangASTSection;
Colin LeMahieu77804be2015-07-29 15:45:39 +00001726 for (auto Sec : ToolSectionFilter(*Obj)) {
Adrian Prantl437105a2015-07-08 02:04:15 +00001727 StringRef Name;
1728 Sec.getName(Name);
1729 if (Name == ClangASTSectionName) {
1730 ClangASTSection = Sec;
1731 break;
1732 }
1733 }
1734 if (!ClangASTSection)
1735 return;
1736
1737 StringRef ClangASTContents;
Davide Italianoccd53fe2015-08-05 07:18:31 +00001738 error(ClangASTSection.getValue().getContents(ClangASTContents));
Adrian Prantl437105a2015-07-08 02:04:15 +00001739 outs().write(ClangASTContents.data(), ClangASTContents.size());
1740}
1741
Sanjoy Das6f567a42015-06-22 18:03:02 +00001742static void printFaultMaps(const ObjectFile *Obj) {
George Rimar73a27232019-01-15 09:19:18 +00001743 StringRef FaultMapSectionName;
Sanjoy Das6f567a42015-06-22 18:03:02 +00001744
1745 if (isa<ELFObjectFileBase>(Obj)) {
1746 FaultMapSectionName = ".llvm_faultmaps";
1747 } else if (isa<MachOObjectFile>(Obj)) {
1748 FaultMapSectionName = "__llvm_faultmaps";
1749 } else {
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001750 WithColor::error(errs(), ToolName)
1751 << "This operation is only currently supported "
1752 "for ELF and Mach-O executable files.\n";
Sanjoy Das6f567a42015-06-22 18:03:02 +00001753 return;
1754 }
1755
1756 Optional<object::SectionRef> FaultMapSection;
1757
Colin LeMahieu77804be2015-07-29 15:45:39 +00001758 for (auto Sec : ToolSectionFilter(*Obj)) {
Sanjoy Das6f567a42015-06-22 18:03:02 +00001759 StringRef Name;
1760 Sec.getName(Name);
1761 if (Name == FaultMapSectionName) {
1762 FaultMapSection = Sec;
1763 break;
1764 }
1765 }
1766
1767 outs() << "FaultMap table:\n";
1768
1769 if (!FaultMapSection.hasValue()) {
1770 outs() << "<not found>\n";
1771 return;
1772 }
1773
1774 StringRef FaultMapContents;
Davide Italianoccd53fe2015-08-05 07:18:31 +00001775 error(FaultMapSection.getValue().getContents(FaultMapContents));
Sanjoy Das6f567a42015-06-22 18:03:02 +00001776
1777 FaultMapParser FMP(FaultMapContents.bytes_begin(),
1778 FaultMapContents.bytes_end());
1779
1780 outs() << FMP;
1781}
1782
George Rimar73a27232019-01-15 09:19:18 +00001783static void printPrivateFileHeaders(const ObjectFile *O, bool OnlyFirst) {
1784 if (O->isELF()) {
1785 printELFFileHeader(O);
Xing GUO56d651d2019-02-25 13:13:19 +00001786 printELFDynamicSection(O);
1787 printELFSymbolVersionInfo(O);
1788 return;
Paul Semel0913dcd2018-07-25 11:09:20 +00001789 }
George Rimar73a27232019-01-15 09:19:18 +00001790 if (O->isCOFF())
1791 return printCOFFFileHeader(O);
1792 if (O->isWasm())
1793 return printWasmFileHeader(O);
1794 if (O->isMachO()) {
1795 printMachOFileHeader(O);
1796 if (!OnlyFirst)
1797 printMachOLoadCommands(O);
Davide Italiano1bdaa202016-09-18 04:39:15 +00001798 return;
1799 }
George Rimar73a27232019-01-15 09:19:18 +00001800 report_error(O->getFileName(), "Invalid/Unsupported object file format");
Rui Ueyamac2bed422013-09-27 21:04:00 +00001801}
1802
George Rimar73a27232019-01-15 09:19:18 +00001803static void printFileHeaders(const ObjectFile *O) {
1804 if (!O->isELF() && !O->isCOFF())
1805 report_error(O->getFileName(), "Invalid/Unsupported object file format");
Paul Semeld2af4d62018-07-04 15:25:03 +00001806
George Rimar73a27232019-01-15 09:19:18 +00001807 Triple::ArchType AT = O->getArch();
Paul Semeld2af4d62018-07-04 15:25:03 +00001808 outs() << "architecture: " << Triple::getArchTypeName(AT) << "\n";
Fangrui Songe7834bd2019-04-07 08:19:55 +00001809 uint64_t Address = unwrapOrError(O->getStartAddress(), O->getFileName());
Petar Jovanovic8d947ba2018-10-19 22:16:49 +00001810
George Rimar73a27232019-01-15 09:19:18 +00001811 StringRef Fmt = O->getBytesInAddress() > 4 ? "%016" PRIx64 : "%08" PRIx64;
Paul Semeld2af4d62018-07-04 15:25:03 +00001812 outs() << "start address: "
George Rimar9b6fe7e2019-01-12 12:17:24 +00001813 << "0x" << format(Fmt.data(), Address) << "\n\n";
Paul Semeld2af4d62018-07-04 15:25:03 +00001814}
1815
Paul Semel0dc92f62018-07-05 14:43:29 +00001816static void printArchiveChild(StringRef Filename, const Archive::Child &C) {
1817 Expected<sys::fs::perms> ModeOrErr = C.getAccessMode();
1818 if (!ModeOrErr) {
Jonas Devliegheree787efd2018-11-11 22:12:04 +00001819 WithColor::error(errs(), ToolName) << "ill-formed archive entry.\n";
Paul Semel0dc92f62018-07-05 14:43:29 +00001820 consumeError(ModeOrErr.takeError());
1821 return;
1822 }
1823 sys::fs::perms Mode = ModeOrErr.get();
1824 outs() << ((Mode & sys::fs::owner_read) ? "r" : "-");
1825 outs() << ((Mode & sys::fs::owner_write) ? "w" : "-");
1826 outs() << ((Mode & sys::fs::owner_exe) ? "x" : "-");
1827 outs() << ((Mode & sys::fs::group_read) ? "r" : "-");
1828 outs() << ((Mode & sys::fs::group_write) ? "w" : "-");
1829 outs() << ((Mode & sys::fs::group_exe) ? "x" : "-");
1830 outs() << ((Mode & sys::fs::others_read) ? "r" : "-");
1831 outs() << ((Mode & sys::fs::others_write) ? "w" : "-");
1832 outs() << ((Mode & sys::fs::others_exe) ? "x" : "-");
1833
1834 outs() << " ";
1835
Fangrui Songe7834bd2019-04-07 08:19:55 +00001836 outs() << format("%d/%d %6" PRId64 " ", unwrapOrError(C.getUID(), Filename),
1837 unwrapOrError(C.getGID(), Filename),
1838 unwrapOrError(C.getRawSize(), Filename));
Paul Semel0dc92f62018-07-05 14:43:29 +00001839
1840 StringRef RawLastModified = C.getRawLastModified();
1841 unsigned Seconds;
1842 if (RawLastModified.getAsInteger(10, Seconds))
1843 outs() << "(date: \"" << RawLastModified
1844 << "\" contains non-decimal chars) ";
1845 else {
1846 // Since ctime(3) returns a 26 character string of the form:
1847 // "Sun Sep 16 01:03:52 1973\n\0"
1848 // just print 24 characters.
1849 time_t t = Seconds;
1850 outs() << format("%.24s ", ctime(&t));
1851 }
1852
1853 StringRef Name = "";
1854 Expected<StringRef> NameOrErr = C.getName();
1855 if (!NameOrErr) {
1856 consumeError(NameOrErr.takeError());
Fangrui Songe7834bd2019-04-07 08:19:55 +00001857 Name = unwrapOrError(C.getRawName(), Filename);
Paul Semel0dc92f62018-07-05 14:43:29 +00001858 } else {
1859 Name = NameOrErr.get();
1860 }
1861 outs() << Name << "\n";
1862}
1863
George Rimar73a27232019-01-15 09:19:18 +00001864static void dumpObject(ObjectFile *O, const Archive *A = nullptr,
1865 const Archive::Child *C = nullptr) {
Adrian Prantl437105a2015-07-08 02:04:15 +00001866 // Avoid other output when using a raw option.
1867 if (!RawClangAST) {
1868 outs() << '\n';
George Rimar73a27232019-01-15 09:19:18 +00001869 if (A)
1870 outs() << A->getFileName() << "(" << O->getFileName() << ")";
Kevin Enderbyac9e1552016-05-17 17:10:12 +00001871 else
George Rimar73a27232019-01-15 09:19:18 +00001872 outs() << O->getFileName();
1873 outs() << ":\tfile format " << O->getFileFormatName() << "\n\n";
Adrian Prantl437105a2015-07-08 02:04:15 +00001874 }
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001875
George Rimar73a27232019-01-15 09:19:18 +00001876 StringRef ArchiveName = A ? A->getFileName() : "";
George Rimar9b6fe7e2019-01-12 12:17:24 +00001877 if (FileHeaders)
George Rimar73a27232019-01-15 09:19:18 +00001878 printFileHeaders(O);
1879 if (ArchiveHeaders && !MachOOpt && C)
1880 printArchiveChild(ArchiveName, *C);
Michael J. Spencerba4a3622011-10-08 00:18:30 +00001881 if (Disassemble)
George Rimar73a27232019-01-15 09:19:18 +00001882 disassembleObject(O, Relocations);
Michael J. Spencer51862b32011-10-13 22:17:18 +00001883 if (Relocations && !Disassemble)
George Rimar73a27232019-01-15 09:19:18 +00001884 printRelocations(O);
Paul Semelcb0f0432018-06-07 13:30:55 +00001885 if (DynamicRelocations)
George Rimar73a27232019-01-15 09:19:18 +00001886 printDynamicRelocations(O);
Nick Lewyckyfcf84622011-10-10 21:21:34 +00001887 if (SectionHeaders)
George Rimar73a27232019-01-15 09:19:18 +00001888 printSectionHeaders(O);
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001889 if (SectionContents)
George Rimar73a27232019-01-15 09:19:18 +00001890 printSectionContents(O);
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001891 if (SymbolTable)
George Rimar73a27232019-01-15 09:19:18 +00001892 printSymbolTable(O, ArchiveName);
Michael J. Spencer0c6ec482012-12-05 20:12:35 +00001893 if (UnwindInfo)
George Rimar73a27232019-01-15 09:19:18 +00001894 printUnwindInfo(O);
Davide Italiano1bdaa202016-09-18 04:39:15 +00001895 if (PrivateHeaders || FirstPrivateHeader)
George Rimar73a27232019-01-15 09:19:18 +00001896 printPrivateFileHeaders(O, FirstPrivateHeader);
Nick Kledzikd04bc352014-08-30 00:20:14 +00001897 if (ExportsTrie)
George Rimar73a27232019-01-15 09:19:18 +00001898 printExportsTrie(O);
Nick Kledzikac431442014-09-12 21:34:15 +00001899 if (Rebase)
George Rimar73a27232019-01-15 09:19:18 +00001900 printRebaseTable(O);
Nick Kledzik56ebef42014-09-16 01:41:51 +00001901 if (Bind)
George Rimar73a27232019-01-15 09:19:18 +00001902 printBindTable(O);
Nick Kledzik56ebef42014-09-16 01:41:51 +00001903 if (LazyBind)
George Rimar73a27232019-01-15 09:19:18 +00001904 printLazyBindTable(O);
Nick Kledzik56ebef42014-09-16 01:41:51 +00001905 if (WeakBind)
George Rimar73a27232019-01-15 09:19:18 +00001906 printWeakBindTable(O);
Adrian Prantl437105a2015-07-08 02:04:15 +00001907 if (RawClangAST)
George Rimar73a27232019-01-15 09:19:18 +00001908 printRawClangAST(O);
Fangrui Song9d812f42019-04-15 15:00:10 +00001909 if (FaultMapSection)
George Rimar73a27232019-01-15 09:19:18 +00001910 printFaultMaps(O);
Igor Laevsky03a670c2016-01-26 15:09:42 +00001911 if (DwarfDumpType != DIDT_Null) {
George Rimar73a27232019-01-15 09:19:18 +00001912 std::unique_ptr<DIContext> DICtx = DWARFContext::create(*O);
Igor Laevsky03a670c2016-01-26 15:09:42 +00001913 // Dump the complete DWARF structure.
Adrian Prantlf4bc1f72017-06-01 18:18:23 +00001914 DIDumpOptions DumpOpts;
1915 DumpOpts.DumpType = DwarfDumpType;
Adrian Prantlf4bc1f72017-06-01 18:18:23 +00001916 DICtx->dump(outs(), DumpOpts);
Igor Laevsky03a670c2016-01-26 15:09:42 +00001917 }
Michael J. Spencerba4a3622011-10-08 00:18:30 +00001918}
1919
George Rimar73a27232019-01-15 09:19:18 +00001920static void dumpObject(const COFFImportFile *I, const Archive *A,
Paul Semel0dc92f62018-07-05 14:43:29 +00001921 const Archive::Child *C = nullptr) {
Saleem Abdulrasoolc6bf5472016-08-18 16:39:19 +00001922 StringRef ArchiveName = A ? A->getFileName() : "";
1923
1924 // Avoid other output when using a raw option.
1925 if (!RawClangAST)
1926 outs() << '\n'
1927 << ArchiveName << "(" << I->getFileName() << ")"
1928 << ":\tfile format COFF-import-file"
1929 << "\n\n";
1930
James Hendersonc1608c92018-10-29 14:17:08 +00001931 if (ArchiveHeaders && !MachOOpt && C)
1932 printArchiveChild(ArchiveName, *C);
Saleem Abdulrasoolc6bf5472016-08-18 16:39:19 +00001933 if (SymbolTable)
1934 printCOFFSymbolTable(I);
1935}
1936
Adrian Prantl4dfcc4a2018-05-01 16:10:38 +00001937/// Dump each object file in \a a;
George Rimar73a27232019-01-15 09:19:18 +00001938static void dumpArchive(const Archive *A) {
Mehdi Amini41af4302016-11-11 04:28:40 +00001939 Error Err = Error::success();
George Rimar73a27232019-01-15 09:19:18 +00001940 for (auto &C : A->children(Err)) {
Kevin Enderbyac9e1552016-05-17 17:10:12 +00001941 Expected<std::unique_ptr<Binary>> ChildOrErr = C.getAsBinary();
1942 if (!ChildOrErr) {
1943 if (auto E = isNotObjectErrorInvalidFileType(ChildOrErr.takeError()))
Fangrui Songe7834bd2019-04-07 08:19:55 +00001944 report_error(std::move(E), A->getFileName(), C);
Kevin Enderbyac9e1552016-05-17 17:10:12 +00001945 continue;
1946 }
George Rimar73a27232019-01-15 09:19:18 +00001947 if (ObjectFile *O = dyn_cast<ObjectFile>(&*ChildOrErr.get()))
1948 dumpObject(O, A, &C);
Saleem Abdulrasoolc6bf5472016-08-18 16:39:19 +00001949 else if (COFFImportFile *I = dyn_cast<COFFImportFile>(&*ChildOrErr.get()))
George Rimar73a27232019-01-15 09:19:18 +00001950 dumpObject(I, A, &C);
Michael J. Spencerba4a3622011-10-08 00:18:30 +00001951 else
Fangrui Song3f209682019-04-09 05:41:24 +00001952 report_error(errorCodeToError(object_error::invalid_file_type),
1953 A->getFileName());
Michael J. Spencerba4a3622011-10-08 00:18:30 +00001954 }
Lang Hamesfc209622016-07-14 02:24:01 +00001955 if (Err)
Fangrui Songe7834bd2019-04-07 08:19:55 +00001956 report_error(std::move(Err), A->getFileName());
Michael J. Spencerba4a3622011-10-08 00:18:30 +00001957}
1958
Adrian Prantl4dfcc4a2018-05-01 16:10:38 +00001959/// Open file and figure out how to dump it.
George Rimar73a27232019-01-15 09:19:18 +00001960static void dumpInput(StringRef file) {
Kevin Enderbye2297dd2015-01-07 21:02:18 +00001961 // If we are using the Mach-O specific object file parser, then let it parse
1962 // the file and process the command line options. So the -arch flags can
1963 // be used to select specific slices, etc.
1964 if (MachOOpt) {
George Rimar73a27232019-01-15 09:19:18 +00001965 parseInputMachO(file);
Michael J. Spencerba4a3622011-10-08 00:18:30 +00001966 return;
1967 }
1968
1969 // Attempt to open the binary.
Fangrui Songe7834bd2019-04-07 08:19:55 +00001970 OwningBinary<Binary> OBinary = unwrapOrError(createBinary(file), file);
1971 Binary &Binary = *OBinary.getBinary();
Michael J. Spencerba4a3622011-10-08 00:18:30 +00001972
George Rimar73a27232019-01-15 09:19:18 +00001973 if (Archive *A = dyn_cast<Archive>(&Binary))
1974 dumpArchive(A);
1975 else if (ObjectFile *O = dyn_cast<ObjectFile>(&Binary))
1976 dumpObject(O);
Dave Lee3fb120f2018-08-03 00:06:38 +00001977 else if (MachOUniversalBinary *UB = dyn_cast<MachOUniversalBinary>(&Binary))
George Rimar73a27232019-01-15 09:19:18 +00001978 parseInputMachO(UB);
Jim Grosbachaf9aec02012-08-07 17:53:14 +00001979 else
Fangrui Song3f209682019-04-09 05:41:24 +00001980 report_error(errorCodeToError(object_error::invalid_file_type), file);
Michael J. Spencerba4a3622011-10-08 00:18:30 +00001981}
Fangrui Song523758e2019-04-15 15:31:42 +00001982} // namespace llvm
Michael J. Spencerba4a3622011-10-08 00:18:30 +00001983
Michael J. Spencer2670c252011-01-20 06:39:06 +00001984int main(int argc, char **argv) {
Fangrui Song523758e2019-04-15 15:31:42 +00001985 using namespace llvm;
Rui Ueyama197194b2018-04-13 18:26:06 +00001986 InitLLVM X(argc, argv);
Michael J. Spencer2670c252011-01-20 06:39:06 +00001987
1988 // Initialize targets and assembly printers/parsers.
Fangrui Song523758e2019-04-15 15:31:42 +00001989 InitializeAllTargetInfos();
1990 InitializeAllTargetMCs();
1991 InitializeAllDisassemblers();
Michael J. Spencer2670c252011-01-20 06:39:06 +00001992
Pete Cooper28fb4fc2012-05-03 23:20:10 +00001993 // Register the target printer for --version.
1994 cl::AddExtraVersionPrinter(TargetRegistry::printRegisteredTargetsForVersion);
1995
Michael J. Spencer2670c252011-01-20 06:39:06 +00001996 cl::ParseCommandLineOptions(argc, argv, "llvm object file dumper\n");
Michael J. Spencer2670c252011-01-20 06:39:06 +00001997
1998 ToolName = argv[0];
1999
2000 // Defaults to a.out if no filenames specified.
Jordan Rupprecht16a0de22018-12-20 00:57:06 +00002001 if (InputFilenames.empty())
Michael J. Spencer2670c252011-01-20 06:39:06 +00002002 InputFilenames.push_back("a.out");
2003
Fangrui Song8513cd42018-06-27 20:45:11 +00002004 if (AllHeaders)
George Rimar5e364332019-01-18 12:01:59 +00002005 ArchiveHeaders = FileHeaders = PrivateHeaders = Relocations =
2006 SectionHeaders = SymbolTable = true;
Fangrui Song8513cd42018-06-27 20:45:11 +00002007
Hemant Kulkarni8dfc0b52016-08-15 19:49:24 +00002008 if (DisassembleAll || PrintSource || PrintLines)
Colin LeMahieuf34933e2015-07-23 20:58:49 +00002009 Disassemble = true;
Paul Semel007dedb2018-07-18 16:39:21 +00002010
Fangrui Song051a6992019-04-16 02:37:29 +00002011 if (!ArchiveHeaders && !Disassemble && DwarfDumpType == DIDT_Null &&
2012 !DynamicRelocations && !FileHeaders && !PrivateHeaders && !RawClangAST &&
2013 !Relocations && !SectionHeaders && !SectionContents && !SymbolTable &&
2014 !UnwindInfo && !FaultMapSection &&
2015 !(MachOOpt &&
2016 (Bind || DataInCode || DylibId || DylibsUsed || ExportsTrie ||
2017 FirstPrivateHeader || IndirectSymbols || InfoPlist || LazyBind ||
2018 LinkOptHints || ObjcMetaData || Rebase || UniversalHeaders ||
2019 WeakBind || !FilterSections.empty()))) {
Michael J. Spencer2670c252011-01-20 06:39:06 +00002020 cl::PrintHelpMessage();
Dimitry Andrice4f5d012017-12-18 19:46:56 +00002021 return 2;
2022 }
2023
Rafael Aulerb0e4b912018-03-09 19:13:44 +00002024 DisasmFuncsSet.insert(DisassembleFunctions.begin(),
2025 DisassembleFunctions.end());
2026
George Rimar73a27232019-01-15 09:19:18 +00002027 llvm::for_each(InputFilenames, dumpInput);
Dimitry Andrice4f5d012017-12-18 19:46:56 +00002028
2029 return EXIT_SUCCESS;
2030}