blob: f2eb69a2e8ce32d7ec3db50fd1f153cc01bb9024 [file] [log] [blame]
Michael J. Spencer2670c252011-01-20 06:39:06 +00001//===-- llvm-objdump.cpp - Object file dumping utility for llvm -----------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This program is a utility that works like binutils "objdump", that is, it
11// dumps out a plethora of information about an object file depending on the
12// flags.
13//
Michael J. Spencerd7e70032013-02-05 20:27:22 +000014// The flags and output of this program should be near identical to those of
15// binutils objdump.
16//
Michael J. Spencer2670c252011-01-20 06:39:06 +000017//===----------------------------------------------------------------------===//
18
Benjamin Kramer43a772e2011-09-19 17:56:04 +000019#include "llvm-objdump.h"
Sanjoy Das6f567a42015-06-22 18:03:02 +000020#include "llvm/ADT/Optional.h"
Chandler Carruth4d88a1c2012-12-04 10:44:52 +000021#include "llvm/ADT/STLExtras.h"
Michael J. Spencer4e25c022011-10-17 17:13:22 +000022#include "llvm/ADT/StringExtras.h"
Rafael Aulerb0e4b912018-03-09 19:13:44 +000023#include "llvm/ADT/StringSet.h"
Michael J. Spencer2670c252011-01-20 06:39:06 +000024#include "llvm/ADT/Triple.h"
Sanjoy Das3f1bc3b2015-06-23 20:09:03 +000025#include "llvm/CodeGen/FaultMaps.h"
Igor Laevsky03a670c2016-01-26 15:09:42 +000026#include "llvm/DebugInfo/DWARF/DWARFContext.h"
Hemant Kulkarni8dfc0b52016-08-15 19:49:24 +000027#include "llvm/DebugInfo/Symbolize/Symbolize.h"
Paul Semel007dedb2018-07-18 16:39:21 +000028#include "llvm/Demangle/Demangle.h"
Michael J. Spencer2670c252011-01-20 06:39:06 +000029#include "llvm/MC/MCAsmInfo.h"
Ahmed Bougachaad1084d2013-05-24 00:39:57 +000030#include "llvm/MC/MCContext.h"
Benjamin Kramerf57c1972016-01-26 16:44:37 +000031#include "llvm/MC/MCDisassembler/MCDisassembler.h"
32#include "llvm/MC/MCDisassembler/MCRelocationInfo.h"
Michael J. Spencer2670c252011-01-20 06:39:06 +000033#include "llvm/MC/MCInst.h"
34#include "llvm/MC/MCInstPrinter.h"
Ahmed Bougachaaa790682013-05-24 01:07:04 +000035#include "llvm/MC/MCInstrAnalysis.h"
Craig Topper54bfde72012-04-02 06:09:36 +000036#include "llvm/MC/MCInstrInfo.h"
Ahmed Bougachaad1084d2013-05-24 00:39:57 +000037#include "llvm/MC/MCObjectFileInfo.h"
Jim Grosbachfd93a592012-03-05 19:33:20 +000038#include "llvm/MC/MCRegisterInfo.h"
Ahmed Bougachaaa790682013-05-24 01:07:04 +000039#include "llvm/MC/MCSubtargetInfo.h"
Chandler Carruth4d88a1c2012-12-04 10:44:52 +000040#include "llvm/Object/Archive.h"
41#include "llvm/Object/COFF.h"
Saleem Abdulrasoolc6bf5472016-08-18 16:39:19 +000042#include "llvm/Object/COFFImportFile.h"
Benjamin Kramerf57c1972016-01-26 16:44:37 +000043#include "llvm/Object/ELFObjectFile.h"
Rafael Espindolaa9f810b2012-12-21 03:47:03 +000044#include "llvm/Object/MachO.h"
Dave Lee3fb120f2018-08-03 00:06:38 +000045#include "llvm/Object/MachOUniversal.h"
Chandler Carruth4d88a1c2012-12-04 10:44:52 +000046#include "llvm/Object/ObjectFile.h"
Sam Clegg4df5d762017-06-27 20:40:53 +000047#include "llvm/Object/Wasm.h"
Michael J. Spencerba4a3622011-10-08 00:18:30 +000048#include "llvm/Support/Casting.h"
Michael J. Spencer2670c252011-01-20 06:39:06 +000049#include "llvm/Support/CommandLine.h"
50#include "llvm/Support/Debug.h"
Alexey Samsonov50d0fbd2015-06-04 18:34:11 +000051#include "llvm/Support/Errc.h"
Michael J. Spencerba4a3622011-10-08 00:18:30 +000052#include "llvm/Support/FileSystem.h"
Michael J. Spencer2670c252011-01-20 06:39:06 +000053#include "llvm/Support/Format.h"
Benjamin Kramerbf115312011-07-25 23:04:36 +000054#include "llvm/Support/GraphWriter.h"
Michael J. Spencer2670c252011-01-20 06:39:06 +000055#include "llvm/Support/Host.h"
Rui Ueyama197194b2018-04-13 18:26:06 +000056#include "llvm/Support/InitLLVM.h"
Michael J. Spencer2670c252011-01-20 06:39:06 +000057#include "llvm/Support/MemoryBuffer.h"
Michael J. Spencer2670c252011-01-20 06:39:06 +000058#include "llvm/Support/SourceMgr.h"
Joel Galenson134cf472018-08-24 15:21:57 +000059#include "llvm/Support/StringSaver.h"
Evan Cheng2bb40352011-08-24 18:08:43 +000060#include "llvm/Support/TargetRegistry.h"
61#include "llvm/Support/TargetSelect.h"
Jonas Devliegheree787efd2018-11-11 22:12:04 +000062#include "llvm/Support/WithColor.h"
Michael J. Spencer2670c252011-01-20 06:39:06 +000063#include "llvm/Support/raw_ostream.h"
Michael J. Spencer2670c252011-01-20 06:39:06 +000064#include <algorithm>
Benjamin Kramera5177e62012-03-23 11:49:32 +000065#include <cctype>
Michael J. Spencer2670c252011-01-20 06:39:06 +000066#include <cstring>
Rafael Espindolaa6e9c3e2014-06-12 17:38:55 +000067#include <system_error>
Hemant Kulkarni8dfc0b52016-08-15 19:49:24 +000068#include <unordered_map>
Rafael Espindolac398e672017-07-19 22:27:28 +000069#include <utility>
Ahmed Bougacha17926472013-08-21 07:29:02 +000070
Michael J. Spencer2670c252011-01-20 06:39:06 +000071using namespace llvm;
72using namespace object;
73
Fangrui Song8513cd42018-06-27 20:45:11 +000074cl::opt<bool>
75 llvm::AllHeaders("all-headers",
76 cl::desc("Display all available header information"));
77static cl::alias AllHeadersShort("x", cl::desc("Alias for --all-headers"),
78 cl::aliasopt(AllHeaders));
79
Benjamin Kramer43a772e2011-09-19 17:56:04 +000080static cl::list<std::string>
81InputFilenames(cl::Positional, cl::desc("<input object files>"),cl::ZeroOrMore);
Michael J. Spencer2670c252011-01-20 06:39:06 +000082
Kevin Enderbye2297dd2015-01-07 21:02:18 +000083cl::opt<bool>
84llvm::Disassemble("disassemble",
Benjamin Kramer43a772e2011-09-19 17:56:04 +000085 cl::desc("Display assembler mnemonics for the machine instructions"));
86static cl::alias
87Disassembled("d", cl::desc("Alias for --disassemble"),
Colin LeMahieu77804be2015-07-29 15:45:39 +000088 cl::aliasopt(Disassemble));
89
90cl::opt<bool>
91llvm::DisassembleAll("disassemble-all",
92 cl::desc("Display assembler mnemonics for the machine instructions"));
93static cl::alias
94DisassembleAlld("D", cl::desc("Alias for --disassemble-all"),
Colin LeMahieuf34933e2015-07-23 20:58:49 +000095 cl::aliasopt(DisassembleAll));
Michael J. Spencer2670c252011-01-20 06:39:06 +000096
Zachary Turner030ad372018-08-20 22:18:21 +000097cl::opt<bool> llvm::Demangle("demangle", cl::desc("Demangle symbols names"),
98 cl::init(false));
Paul Semel007dedb2018-07-18 16:39:21 +000099
100static cl::alias DemangleShort("C", cl::desc("Alias for --demangle"),
Zachary Turner030ad372018-08-20 22:18:21 +0000101 cl::aliasopt(llvm::Demangle));
Paul Semel007dedb2018-07-18 16:39:21 +0000102
Rafael Aulerb0e4b912018-03-09 19:13:44 +0000103static cl::list<std::string>
104DisassembleFunctions("df",
105 cl::CommaSeparated,
106 cl::desc("List of functions to disassemble"));
107static StringSet<> DisasmFuncsSet;
108
Kevin Enderby98da6132015-01-20 21:47:46 +0000109cl::opt<bool>
Kristina Brooks31579e92018-10-31 09:34:08 +0000110llvm::Relocations("reloc",
111 cl::desc("Display the relocation entries in the file"));
112static cl::alias RelocationsShort("r", cl::desc("Alias for --reloc"),
113 cl::NotHidden,
114 cl::aliasopt(llvm::Relocations));
Michael J. Spencerba4a3622011-10-08 00:18:30 +0000115
Kevin Enderby98da6132015-01-20 21:47:46 +0000116cl::opt<bool>
Paul Semelcb0f0432018-06-07 13:30:55 +0000117llvm::DynamicRelocations("dynamic-reloc",
118 cl::desc("Display the dynamic relocation entries in the file"));
119static cl::alias
120DynamicRelocationsd("R", cl::desc("Alias for --dynamic-reloc"),
121 cl::aliasopt(DynamicRelocations));
122
123cl::opt<bool>
James Hendersonb55b6582018-10-29 10:05:39 +0000124 llvm::SectionContents("full-contents",
125 cl::desc("Display the content of each section"));
126static cl::alias SectionContentsShort("s",
127 cl::desc("Alias for --full-contents"),
128 cl::aliasopt(SectionContents));
Michael J. Spencer4e25c022011-10-17 17:13:22 +0000129
Kristina Brooks3baa5f72018-10-31 05:45:01 +0000130cl::opt<bool> llvm::SymbolTable("syms", cl::desc("Display the symbol table"));
131static cl::alias SymbolTableShort("t", cl::desc("Alias for --syms"),
Kristina Brooks889356e2018-10-31 09:35:25 +0000132 cl::NotHidden,
Kristina Brooks3baa5f72018-10-31 05:45:01 +0000133 cl::aliasopt(llvm::SymbolTable));
Michael J. Spencerbfa06782011-10-18 19:32:17 +0000134
Kevin Enderbye2297dd2015-01-07 21:02:18 +0000135cl::opt<bool>
136llvm::ExportsTrie("exports-trie", cl::desc("Display mach-o exported symbols"));
Nick Kledzikd04bc352014-08-30 00:20:14 +0000137
Kevin Enderbye2297dd2015-01-07 21:02:18 +0000138cl::opt<bool>
139llvm::Rebase("rebase", cl::desc("Display mach-o rebasing info"));
Nick Kledzikac431442014-09-12 21:34:15 +0000140
Kevin Enderbye2297dd2015-01-07 21:02:18 +0000141cl::opt<bool>
142llvm::Bind("bind", cl::desc("Display mach-o binding info"));
Nick Kledzik56ebef42014-09-16 01:41:51 +0000143
Kevin Enderbye2297dd2015-01-07 21:02:18 +0000144cl::opt<bool>
145llvm::LazyBind("lazy-bind", cl::desc("Display mach-o lazy binding info"));
Nick Kledzik56ebef42014-09-16 01:41:51 +0000146
Kevin Enderbye2297dd2015-01-07 21:02:18 +0000147cl::opt<bool>
148llvm::WeakBind("weak-bind", cl::desc("Display mach-o weak binding info"));
Nick Kledzik56ebef42014-09-16 01:41:51 +0000149
Adrian Prantl437105a2015-07-08 02:04:15 +0000150cl::opt<bool>
151llvm::RawClangAST("raw-clang-ast",
152 cl::desc("Dump the raw binary contents of the clang AST section"));
153
Nick Kledzik56ebef42014-09-16 01:41:51 +0000154static cl::opt<bool>
Rafael Espindolaa9f810b2012-12-21 03:47:03 +0000155MachOOpt("macho", cl::desc("Use MachO specific object file parser"));
Benjamin Kramer43a772e2011-09-19 17:56:04 +0000156static cl::alias
Rafael Espindolaa9f810b2012-12-21 03:47:03 +0000157MachOm("m", cl::desc("Alias for --macho"), cl::aliasopt(MachOOpt));
Benjamin Kramer87ee76c2011-07-20 19:37:35 +0000158
Benjamin Kramer43a772e2011-09-19 17:56:04 +0000159cl::opt<std::string>
160llvm::TripleName("triple", cl::desc("Target triple to disassemble for, "
161 "see -version for available targets"));
162
163cl::opt<std::string>
Kevin Enderbyc9595622014-08-06 23:24:41 +0000164llvm::MCPU("mcpu",
165 cl::desc("Target a specific cpu type (-mcpu=help for details)"),
166 cl::value_desc("cpu-name"),
167 cl::init(""));
168
169cl::opt<std::string>
Kevin Enderbyef3ad2f2014-12-04 23:56:27 +0000170llvm::ArchName("arch-name", cl::desc("Target arch to disassemble for, "
Michael J. Spencer2670c252011-01-20 06:39:06 +0000171 "see -version for available targets"));
172
Kevin Enderby98da6132015-01-20 21:47:46 +0000173cl::opt<bool>
174llvm::SectionHeaders("section-headers", cl::desc("Display summaries of the "
175 "headers for each section."));
Nick Lewyckyfcf84622011-10-10 21:21:34 +0000176static cl::alias
177SectionHeadersShort("headers", cl::desc("Alias for --section-headers"),
178 cl::aliasopt(SectionHeaders));
179static cl::alias
180SectionHeadersShorter("h", cl::desc("Alias for --section-headers"),
181 cl::aliasopt(SectionHeaders));
Colin LeMahieufcc32762015-07-29 19:08:10 +0000182
Colin LeMahieu77804be2015-07-29 15:45:39 +0000183cl::list<std::string>
Colin LeMahieufcc32762015-07-29 19:08:10 +0000184llvm::FilterSections("section", cl::desc("Operate on the specified sections only. "
185 "With -macho dump segment,section"));
186cl::alias
187static FilterSectionsj("j", cl::desc("Alias for --section"),
188 cl::aliasopt(llvm::FilterSections));
Nick Lewyckyfcf84622011-10-10 21:21:34 +0000189
Kevin Enderbyc9595622014-08-06 23:24:41 +0000190cl::list<std::string>
191llvm::MAttrs("mattr",
Jack Carter551efd72012-08-28 19:24:49 +0000192 cl::CommaSeparated,
193 cl::desc("Target specific attributes"),
194 cl::value_desc("a1,+a2,-a3,..."));
195
Kevin Enderbybf246f52014-09-24 23:08:22 +0000196cl::opt<bool>
197llvm::NoShowRawInsn("no-show-raw-insn", cl::desc("When disassembling "
198 "instructions, do not print "
199 "the instruction bytes."));
Saleem Abdulrasooldea14b22017-02-08 18:11:31 +0000200cl::opt<bool>
201llvm::NoLeadingAddr("no-leading-addr", cl::desc("Print no leading address"));
Eli Bendersky3a6808c2012-11-20 22:57:02 +0000202
Kevin Enderby98da6132015-01-20 21:47:46 +0000203cl::opt<bool>
204llvm::UnwindInfo("unwind-info", cl::desc("Display unwind information"));
Michael J. Spencer0c6ec482012-12-05 20:12:35 +0000205
206static cl::alias
207UnwindInfoShort("u", cl::desc("Alias for --unwind-info"),
208 cl::aliasopt(UnwindInfo));
209
Kevin Enderbye2297dd2015-01-07 21:02:18 +0000210cl::opt<bool>
211llvm::PrivateHeaders("private-headers",
212 cl::desc("Display format specific file headers"));
Michael J. Spencer209565db2013-01-06 03:56:49 +0000213
Kevin Enderby0ae163f2016-01-13 00:25:36 +0000214cl::opt<bool>
215llvm::FirstPrivateHeader("private-header",
216 cl::desc("Display only the first format specific file "
217 "header"));
218
Michael J. Spencer209565db2013-01-06 03:56:49 +0000219static cl::alias
220PrivateHeadersShort("p", cl::desc("Alias for --private-headers"),
221 cl::aliasopt(PrivateHeaders));
222
Paul Semeld2af4d62018-07-04 15:25:03 +0000223cl::opt<bool> llvm::FileHeaders(
224 "file-headers",
225 cl::desc("Display the contents of the overall file header"));
226
227static cl::alias FileHeadersShort("f", cl::desc("Alias for --file-headers"),
228 cl::aliasopt(FileHeaders));
229
Colin LeMahieu14ec76e2015-06-07 21:07:17 +0000230cl::opt<bool>
Paul Semel0dc92f62018-07-05 14:43:29 +0000231 llvm::ArchiveHeaders("archive-headers",
232 cl::desc("Display archive header information"));
233
234cl::alias
235ArchiveHeadersShort("a", cl::desc("Alias for --archive-headers"),
236 cl::aliasopt(ArchiveHeaders));
237
238cl::opt<bool>
Colin LeMahieu14ec76e2015-06-07 21:07:17 +0000239 llvm::PrintImmHex("print-imm-hex",
Colin LeMahieuefe37322016-04-08 18:15:37 +0000240 cl::desc("Use hex format for immediate values"));
Colin LeMahieu14ec76e2015-06-07 21:07:17 +0000241
Sanjoy Das6f567a42015-06-22 18:03:02 +0000242cl::opt<bool> PrintFaultMaps("fault-map-section",
243 cl::desc("Display contents of faultmap section"));
244
Igor Laevsky03a670c2016-01-26 15:09:42 +0000245cl::opt<DIDumpType> llvm::DwarfDumpType(
246 "dwarf", cl::init(DIDT_Null), cl::desc("Dump of dwarf debug sections:"),
Jonas Devliegherec0a758d2017-09-18 14:15:57 +0000247 cl::values(clEnumValN(DIDT_DebugFrame, "frames", ".debug_frame")));
Igor Laevsky03a670c2016-01-26 15:09:42 +0000248
Hemant Kulkarni8dfc0b52016-08-15 19:49:24 +0000249cl::opt<bool> PrintSource(
250 "source",
251 cl::desc(
Alex Denisova07169e2018-02-02 19:20:37 +0000252 "Display source inlined with disassembly. Implies disassemble object"));
Hemant Kulkarni8dfc0b52016-08-15 19:49:24 +0000253
254cl::alias PrintSourceShort("S", cl::desc("Alias for -source"),
255 cl::aliasopt(PrintSource));
256
257cl::opt<bool> PrintLines("line-numbers",
258 cl::desc("Display source line numbers with "
259 "disassembly. Implies disassemble object"));
260
261cl::alias PrintLinesShort("l", cl::desc("Alias for -line-numbers"),
262 cl::aliasopt(PrintLines));
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +0000263
264cl::opt<unsigned long long>
265 StartAddress("start-address", cl::desc("Disassemble beginning at address"),
266 cl::value_desc("address"), cl::init(0));
267cl::opt<unsigned long long>
268 StopAddress("stop-address", cl::desc("Stop disassembly at address"),
269 cl::value_desc("address"), cl::init(UINT64_MAX));
Benjamin Kramer43a772e2011-09-19 17:56:04 +0000270static StringRef ToolName;
Michael J. Spencer2670c252011-01-20 06:39:06 +0000271
Sam Parker5fba45a2017-02-08 09:44:18 +0000272typedef std::vector<std::tuple<uint64_t, StringRef, uint8_t>> SectionSymbolsTy;
273
Colin LeMahieu77804be2015-07-29 15:45:39 +0000274namespace {
Colin LeMahieufcc32762015-07-29 19:08:10 +0000275typedef std::function<bool(llvm::object::SectionRef const &)> FilterPredicate;
Colin LeMahieu77804be2015-07-29 15:45:39 +0000276
277class SectionFilterIterator {
278public:
279 SectionFilterIterator(FilterPredicate P,
280 llvm::object::section_iterator const &I,
281 llvm::object::section_iterator const &E)
Benjamin Kramer82de7d32016-05-27 14:27:24 +0000282 : Predicate(std::move(P)), Iterator(I), End(E) {
Colin LeMahieu77804be2015-07-29 15:45:39 +0000283 ScanPredicate();
284 }
Benjamin Kramerac9257b2015-09-24 14:52:52 +0000285 const llvm::object::SectionRef &operator*() const { return *Iterator; }
Colin LeMahieu77804be2015-07-29 15:45:39 +0000286 SectionFilterIterator &operator++() {
287 ++Iterator;
288 ScanPredicate();
289 return *this;
290 }
291 bool operator!=(SectionFilterIterator const &Other) const {
292 return Iterator != Other.Iterator;
293 }
294
295private:
296 void ScanPredicate() {
Colin LeMahieuda1723f2015-07-29 19:21:13 +0000297 while (Iterator != End && !Predicate(*Iterator)) {
Colin LeMahieu77804be2015-07-29 15:45:39 +0000298 ++Iterator;
299 }
300 }
301 FilterPredicate Predicate;
302 llvm::object::section_iterator Iterator;
303 llvm::object::section_iterator End;
304};
305
306class SectionFilter {
307public:
308 SectionFilter(FilterPredicate P, llvm::object::ObjectFile const &O)
Benjamin Kramer82de7d32016-05-27 14:27:24 +0000309 : Predicate(std::move(P)), Object(O) {}
Colin LeMahieu77804be2015-07-29 15:45:39 +0000310 SectionFilterIterator begin() {
311 return SectionFilterIterator(Predicate, Object.section_begin(),
312 Object.section_end());
313 }
314 SectionFilterIterator end() {
315 return SectionFilterIterator(Predicate, Object.section_end(),
316 Object.section_end());
317 }
318
319private:
320 FilterPredicate Predicate;
321 llvm::object::ObjectFile const &Object;
322};
323SectionFilter ToolSectionFilter(llvm::object::ObjectFile const &O) {
David Majnemer42531262016-08-12 03:55:06 +0000324 return SectionFilter(
325 [](llvm::object::SectionRef const &S) {
326 if (FilterSections.empty())
327 return true;
328 llvm::StringRef String;
329 std::error_code error = S.getName(String);
330 if (error)
331 return false;
332 return is_contained(FilterSections, String);
333 },
334 O);
Colin LeMahieu77804be2015-07-29 15:45:39 +0000335}
336}
337
Davide Italianoccd53fe2015-08-05 07:18:31 +0000338void llvm::error(std::error_code EC) {
Mark Seaborneb03ac52014-01-25 00:32:01 +0000339 if (!EC)
Davide Italianoccd53fe2015-08-05 07:18:31 +0000340 return;
Jonas Devliegheree787efd2018-11-11 22:12:04 +0000341 WithColor::error(errs(), ToolName)
342 << "reading file: " << EC.message() << ".\n";
Davide Italiano140af642015-12-25 18:16:45 +0000343 errs().flush();
Davide Italiano7f6c3012015-08-06 00:18:52 +0000344 exit(1);
Michael J. Spencer2670c252011-01-20 06:39:06 +0000345}
346
Kevin Enderby42398052016-06-28 23:16:13 +0000347LLVM_ATTRIBUTE_NORETURN void llvm::error(Twine Message) {
Jonas Devliegheree787efd2018-11-11 22:12:04 +0000348 WithColor::error(errs(), ToolName) << Message << ".\n";
Kevin Enderby42398052016-06-28 23:16:13 +0000349 errs().flush();
350 exit(1);
351}
352
Paul Semel007dedb2018-07-18 16:39:21 +0000353void llvm::warn(StringRef Message) {
Jonas Devliegheree787efd2018-11-11 22:12:04 +0000354 WithColor::warning(errs(), ToolName) << Message << ".\n";
Paul Semel007dedb2018-07-18 16:39:21 +0000355 errs().flush();
356}
357
Davide Italianoed9d95b2015-12-29 13:41:02 +0000358LLVM_ATTRIBUTE_NORETURN void llvm::report_error(StringRef File,
Kevin Enderby7fa40c92016-11-16 22:17:38 +0000359 Twine Message) {
Jonas Devliegheree787efd2018-11-11 22:12:04 +0000360 WithColor::error(errs(), ToolName)
361 << "'" << File << "': " << Message << ".\n";
Kevin Enderby7fa40c92016-11-16 22:17:38 +0000362 exit(1);
363}
364
365LLVM_ATTRIBUTE_NORETURN void llvm::report_error(StringRef File,
Davide Italianoed9d95b2015-12-29 13:41:02 +0000366 std::error_code EC) {
Alexey Samsonov50d0fbd2015-06-04 18:34:11 +0000367 assert(EC);
Jonas Devliegheree787efd2018-11-11 22:12:04 +0000368 WithColor::error(errs(), ToolName)
369 << "'" << File << "': " << EC.message() << ".\n";
Davide Italianoccd53fe2015-08-05 07:18:31 +0000370 exit(1);
Alexey Samsonov50d0fbd2015-06-04 18:34:11 +0000371}
372
Kevin Enderby3fcdf6a2016-04-06 22:14:09 +0000373LLVM_ATTRIBUTE_NORETURN void llvm::report_error(StringRef File,
374 llvm::Error E) {
375 assert(E);
376 std::string Buf;
377 raw_string_ostream OS(Buf);
Jonas Devlieghere45eb84f2018-11-11 01:46:03 +0000378 logAllUnhandledErrors(std::move(E), OS);
Kevin Enderby3fcdf6a2016-04-06 22:14:09 +0000379 OS.flush();
Jonas Devliegheree787efd2018-11-11 22:12:04 +0000380 WithColor::error(errs(), ToolName) << "'" << File << "': " << Buf;
Kevin Enderby3fcdf6a2016-04-06 22:14:09 +0000381 exit(1);
382}
383
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000384LLVM_ATTRIBUTE_NORETURN void llvm::report_error(StringRef ArchiveName,
385 StringRef FileName,
Kevin Enderby9acb1092016-05-31 20:35:34 +0000386 llvm::Error E,
387 StringRef ArchitectureName) {
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000388 assert(E);
Jonas Devliegheree787efd2018-11-11 22:12:04 +0000389 WithColor::error(errs(), ToolName);
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000390 if (ArchiveName != "")
391 errs() << ArchiveName << "(" << FileName << ")";
392 else
Justin Bogner31d8b7d2016-10-26 22:37:52 +0000393 errs() << "'" << FileName << "'";
Kevin Enderby9acb1092016-05-31 20:35:34 +0000394 if (!ArchitectureName.empty())
395 errs() << " (for architecture " << ArchitectureName << ")";
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000396 std::string Buf;
397 raw_string_ostream OS(Buf);
Jonas Devlieghere45eb84f2018-11-11 01:46:03 +0000398 logAllUnhandledErrors(std::move(E), OS);
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000399 OS.flush();
Justin Bogner31d8b7d2016-10-26 22:37:52 +0000400 errs() << ": " << Buf;
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000401 exit(1);
402}
403
404LLVM_ATTRIBUTE_NORETURN void llvm::report_error(StringRef ArchiveName,
405 const object::Archive::Child &C,
Kevin Enderby9acb1092016-05-31 20:35:34 +0000406 llvm::Error E,
407 StringRef ArchitectureName) {
Kevin Enderbyf4586032016-07-29 17:44:13 +0000408 Expected<StringRef> NameOrErr = C.getName();
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000409 // TODO: if we have a error getting the name then it would be nice to print
410 // the index of which archive member this is and or its offset in the
411 // archive instead of "???" as the name.
Kevin Enderbyf4586032016-07-29 17:44:13 +0000412 if (!NameOrErr) {
413 consumeError(NameOrErr.takeError());
Kevin Enderby9acb1092016-05-31 20:35:34 +0000414 llvm::report_error(ArchiveName, "???", std::move(E), ArchitectureName);
Kevin Enderbyf4586032016-07-29 17:44:13 +0000415 } else
Kevin Enderby9acb1092016-05-31 20:35:34 +0000416 llvm::report_error(ArchiveName, NameOrErr.get(), std::move(E),
417 ArchitectureName);
Kevin Enderbyac9e1552016-05-17 17:10:12 +0000418}
419
Craig Toppere6cb63e2014-04-25 04:24:47 +0000420static const Target *getTarget(const ObjectFile *Obj = nullptr) {
Michael J. Spencer2670c252011-01-20 06:39:06 +0000421 // Figure out the target triple.
Kevin Enderbyfe3d0052012-05-08 23:38:45 +0000422 llvm::Triple TheTriple("unknown-unknown-unknown");
Michael J. Spencer05350e6d2011-01-20 07:22:04 +0000423 if (TripleName.empty()) {
Ahmed Bougachaad1084d2013-05-24 00:39:57 +0000424 if (Obj) {
Vlad Tsyrklevichde620462017-09-19 02:22:48 +0000425 TheTriple = Obj->makeTriple();
Ahmed Bougachaad1084d2013-05-24 00:39:57 +0000426 }
Sam Parkerdf7c6ef2017-01-18 13:52:12 +0000427 } else {
Kevin Enderbyfe3d0052012-05-08 23:38:45 +0000428 TheTriple.setTriple(Triple::normalize(TripleName));
Vlad Tsyrklevichde620462017-09-19 02:22:48 +0000429
Sam Parkerdf7c6ef2017-01-18 13:52:12 +0000430 // Use the triple, but also try to combine with ARM build attributes.
431 if (Obj) {
432 auto Arch = Obj->getArch();
433 if (Arch == Triple::arm || Arch == Triple::armeb) {
434 Obj->setARMSubArch(TheTriple);
435 }
436 }
437 }
Michael J. Spencer2670c252011-01-20 06:39:06 +0000438
439 // Get the target specific parser.
440 std::string Error;
Kevin Enderbyfe3d0052012-05-08 23:38:45 +0000441 const Target *TheTarget = TargetRegistry::lookupTarget(ArchName, TheTriple,
442 Error);
Kevin Enderby7fa40c92016-11-16 22:17:38 +0000443 if (!TheTarget) {
444 if (Obj)
445 report_error(Obj->getFileName(), "can't find target: " + Error);
446 else
447 error("can't find target: " + Error);
448 }
Michael J. Spencer2670c252011-01-20 06:39:06 +0000449
Kevin Enderbyfe3d0052012-05-08 23:38:45 +0000450 // Update the triple name and return the found target.
451 TripleName = TheTriple.getTriple();
452 return TheTarget;
Michael J. Spencer2670c252011-01-20 06:39:06 +0000453}
454
Michael J. Spencer0c6ec482012-12-05 20:12:35 +0000455bool llvm::RelocAddressLess(RelocationRef a, RelocationRef b) {
Rafael Espindola704cd842015-07-06 15:47:43 +0000456 return a.getOffset() < b.getOffset();
Michael J. Spencer51862b32011-10-13 22:17:18 +0000457}
458
George Rimarff5948b2018-12-19 10:29:35 +0000459static std::string demangle(StringRef Name) {
460 char *Demangled = nullptr;
461 if (Name.startswith("_Z"))
462 Demangled = itaniumDemangle(Name.data(), Demangled, nullptr, nullptr);
463 else if (Name.startswith("?"))
464 Demangled = microsoftDemangle(Name.data(), Demangled, nullptr, nullptr);
465
466 if (!Demangled)
467 return Name;
468
469 std::string Ret = Demangled;
470 free(Demangled);
471 return Ret;
472}
473
Rafael Espindola37070a52015-06-03 04:48:06 +0000474template <class ELFT>
Rafael Espindola37070a52015-06-03 04:48:06 +0000475static std::error_code getRelocationValueString(const ELFObjectFile<ELFT> *Obj,
Rafael Espindolaa01ff222015-08-10 20:50:40 +0000476 const RelocationRef &RelRef,
Rafael Espindola37070a52015-06-03 04:48:06 +0000477 SmallVectorImpl<char> &Result) {
Rafael Espindolaa01ff222015-08-10 20:50:40 +0000478 DataRefImpl Rel = RelRef.getRawDataRefImpl();
479
Rafael Espindola37070a52015-06-03 04:48:06 +0000480 typedef typename ELFObjectFile<ELFT>::Elf_Sym Elf_Sym;
481 typedef typename ELFObjectFile<ELFT>::Elf_Shdr Elf_Shdr;
Rafael Espindola7f162ec2015-07-02 14:21:38 +0000482 typedef typename ELFObjectFile<ELFT>::Elf_Rela Elf_Rela;
483
Rafael Espindola37070a52015-06-03 04:48:06 +0000484 const ELFFile<ELFT> &EF = *Obj->getELFFile();
485
Davide Italiano6cf09262016-11-16 05:10:28 +0000486 auto SecOrErr = EF.getSection(Rel.d.a);
487 if (!SecOrErr)
488 return errorToErrorCode(SecOrErr.takeError());
Rafael Espindola6def3042015-07-01 12:56:27 +0000489 const Elf_Shdr *Sec = *SecOrErr;
Davide Italiano6cf09262016-11-16 05:10:28 +0000490 auto SymTabOrErr = EF.getSection(Sec->sh_link);
491 if (!SymTabOrErr)
492 return errorToErrorCode(SymTabOrErr.takeError());
Rafael Espindola6def3042015-07-01 12:56:27 +0000493 const Elf_Shdr *SymTab = *SymTabOrErr;
Rafael Espindola719dc7c2015-06-29 12:38:31 +0000494 assert(SymTab->sh_type == ELF::SHT_SYMTAB ||
495 SymTab->sh_type == ELF::SHT_DYNSYM);
Davide Italiano6cf09262016-11-16 05:10:28 +0000496 auto StrTabSec = EF.getSection(SymTab->sh_link);
497 if (!StrTabSec)
498 return errorToErrorCode(StrTabSec.takeError());
499 auto StrTabOrErr = EF.getStringTable(*StrTabSec);
500 if (!StrTabOrErr)
501 return errorToErrorCode(StrTabOrErr.takeError());
Rafael Espindola6a1bfb22015-06-29 14:39:25 +0000502 StringRef StrTab = *StrTabOrErr;
Rafael Espindola37070a52015-06-03 04:48:06 +0000503 int64_t addend = 0;
Paul Semelcb0f0432018-06-07 13:30:55 +0000504 // If there is no Symbol associated with the relocation, we set the undef
505 // boolean value to 'true'. This will prevent us from calling functions that
506 // requires the relocation to be associated with a symbol.
507 bool undef = false;
Rafael Espindola6def3042015-07-01 12:56:27 +0000508 switch (Sec->sh_type) {
Rafael Espindola37070a52015-06-03 04:48:06 +0000509 default:
510 return object_error::parse_failed;
511 case ELF::SHT_REL: {
Rafael Espindola37070a52015-06-03 04:48:06 +0000512 // TODO: Read implicit addend from section data.
513 break;
514 }
515 case ELF::SHT_RELA: {
Rafael Espindola7f162ec2015-07-02 14:21:38 +0000516 const Elf_Rela *ERela = Obj->getRela(Rel);
Rafael Espindola7f162ec2015-07-02 14:21:38 +0000517 addend = ERela->r_addend;
Paul Semelcb0f0432018-06-07 13:30:55 +0000518 undef = ERela->getSymbol(false) == 0;
Rafael Espindola37070a52015-06-03 04:48:06 +0000519 break;
520 }
521 }
George Rimar6622d412018-12-19 10:21:45 +0000522 std::string Target;
Paul Semelcb0f0432018-06-07 13:30:55 +0000523 if (!undef) {
524 symbol_iterator SI = RelRef.getSymbol();
525 const Elf_Sym *symb = Obj->getSymbol(SI->getRawDataRefImpl());
526 if (symb->getType() == ELF::STT_SECTION) {
527 Expected<section_iterator> SymSI = SI->getSection();
528 if (!SymSI)
529 return errorToErrorCode(SymSI.takeError());
530 const Elf_Shdr *SymSec = Obj->getSection((*SymSI)->getRawDataRefImpl());
531 auto SecName = EF.getSectionName(SymSec);
532 if (!SecName)
533 return errorToErrorCode(SecName.takeError());
534 Target = *SecName;
535 } else {
536 Expected<StringRef> SymName = symb->getName(StrTab);
537 if (!SymName)
538 return errorToErrorCode(SymName.takeError());
George Rimar7120fb92018-12-19 10:44:49 +0000539 if (Demangle)
540 Target = demangle(*SymName);
541 else
542 Target = *SymName;
Paul Semelcb0f0432018-06-07 13:30:55 +0000543 }
544 } else
545 Target = "*ABS*";
Daniel Cedermand72b9fd2018-06-01 05:31:58 +0000546
547 // Default scheme is to print Target, as well as "+ <addend>" for nonzero
548 // addend. Should be acceptable for all normal purposes.
549 std::string fmtbuf;
550 raw_string_ostream fmt(fmtbuf);
551 fmt << Target;
552 if (addend != 0)
553 fmt << (addend < 0 ? "" : "+") << addend;
554 fmt.flush();
555 Result.append(fmtbuf.begin(), fmtbuf.end());
Rui Ueyama7d099192015-06-09 15:20:42 +0000556 return std::error_code();
Rafael Espindola37070a52015-06-03 04:48:06 +0000557}
558
559static std::error_code getRelocationValueString(const ELFObjectFileBase *Obj,
Rafael Espindolaa01ff222015-08-10 20:50:40 +0000560 const RelocationRef &Rel,
Rafael Espindola37070a52015-06-03 04:48:06 +0000561 SmallVectorImpl<char> &Result) {
Rafael Espindola37070a52015-06-03 04:48:06 +0000562 if (auto *ELF32LE = dyn_cast<ELF32LEObjectFile>(Obj))
563 return getRelocationValueString(ELF32LE, Rel, Result);
564 if (auto *ELF64LE = dyn_cast<ELF64LEObjectFile>(Obj))
565 return getRelocationValueString(ELF64LE, Rel, Result);
566 if (auto *ELF32BE = dyn_cast<ELF32BEObjectFile>(Obj))
567 return getRelocationValueString(ELF32BE, Rel, Result);
568 auto *ELF64BE = cast<ELF64BEObjectFile>(Obj);
569 return getRelocationValueString(ELF64BE, Rel, Result);
570}
571
572static std::error_code getRelocationValueString(const COFFObjectFile *Obj,
573 const RelocationRef &Rel,
574 SmallVectorImpl<char> &Result) {
575 symbol_iterator SymI = Rel.getSymbol();
Kevin Enderby81e8b7d2016-04-20 21:24:34 +0000576 Expected<StringRef> SymNameOrErr = SymI->getName();
577 if (!SymNameOrErr)
578 return errorToErrorCode(SymNameOrErr.takeError());
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +0000579 StringRef SymName = *SymNameOrErr;
Rafael Espindola37070a52015-06-03 04:48:06 +0000580 Result.append(SymName.begin(), SymName.end());
Rui Ueyama7d099192015-06-09 15:20:42 +0000581 return std::error_code();
Rafael Espindola37070a52015-06-03 04:48:06 +0000582}
583
584static void printRelocationTargetName(const MachOObjectFile *O,
585 const MachO::any_relocation_info &RE,
586 raw_string_ostream &fmt) {
587 bool IsScattered = O->isRelocationScattered(RE);
588
589 // Target of a scattered relocation is an address. In the interest of
590 // generating pretty output, scan through the symbol table looking for a
591 // symbol that aligns with that address. If we find one, print it.
592 // Otherwise, we just print the hex address of the target.
593 if (IsScattered) {
594 uint32_t Val = O->getPlainRelocationSymbolNum(RE);
595
596 for (const SymbolRef &Symbol : O->symbols()) {
597 std::error_code ec;
Kevin Enderby931cb652016-06-24 18:24:42 +0000598 Expected<uint64_t> Addr = Symbol.getAddress();
Kevin Enderby7fa40c92016-11-16 22:17:38 +0000599 if (!Addr)
600 report_error(O->getFileName(), Addr.takeError());
Rafael Espindolaed067c42015-07-03 18:19:00 +0000601 if (*Addr != Val)
Rafael Espindola37070a52015-06-03 04:48:06 +0000602 continue;
Kevin Enderby81e8b7d2016-04-20 21:24:34 +0000603 Expected<StringRef> Name = Symbol.getName();
Kevin Enderby7fa40c92016-11-16 22:17:38 +0000604 if (!Name)
605 report_error(O->getFileName(), Name.takeError());
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +0000606 fmt << *Name;
Rafael Espindola37070a52015-06-03 04:48:06 +0000607 return;
608 }
609
610 // If we couldn't find a symbol that this relocation refers to, try
611 // to find a section beginning instead.
Colin LeMahieu77804be2015-07-29 15:45:39 +0000612 for (const SectionRef &Section : ToolSectionFilter(*O)) {
Rafael Espindola37070a52015-06-03 04:48:06 +0000613 std::error_code ec;
614
615 StringRef Name;
616 uint64_t Addr = Section.getAddress();
617 if (Addr != Val)
618 continue;
619 if ((ec = Section.getName(Name)))
Kevin Enderby7fa40c92016-11-16 22:17:38 +0000620 report_error(O->getFileName(), ec);
Rafael Espindola37070a52015-06-03 04:48:06 +0000621 fmt << Name;
622 return;
623 }
624
625 fmt << format("0x%x", Val);
626 return;
627 }
628
629 StringRef S;
630 bool isExtern = O->getPlainRelocationExternal(RE);
631 uint64_t Val = O->getPlainRelocationSymbolNum(RE);
632
Martin Storsjo8c0317d2017-07-13 17:03:02 +0000633 if (O->getAnyRelocationType(RE) == MachO::ARM64_RELOC_ADDEND) {
Simon Dardis38867052017-08-07 12:29:38 +0000634 fmt << format("0x%0" PRIx64, Val);
Martin Storsjo8c0317d2017-07-13 17:03:02 +0000635 return;
636 } else if (isExtern) {
Rafael Espindola37070a52015-06-03 04:48:06 +0000637 symbol_iterator SI = O->symbol_begin();
638 advance(SI, Val);
Kevin Enderby81e8b7d2016-04-20 21:24:34 +0000639 Expected<StringRef> SOrErr = SI->getName();
Kevin Enderby7fa40c92016-11-16 22:17:38 +0000640 if (!SOrErr)
641 report_error(O->getFileName(), SOrErr.takeError());
Davide Italianoccd53fe2015-08-05 07:18:31 +0000642 S = *SOrErr;
Rafael Espindola37070a52015-06-03 04:48:06 +0000643 } else {
644 section_iterator SI = O->section_begin();
645 // Adjust for the fact that sections are 1-indexed.
Kevin Enderby3fc91882017-11-03 21:32:44 +0000646 if (Val == 0) {
647 fmt << "0 (?,?)";
648 return;
649 }
650 uint32_t i = Val - 1;
651 while (i != 0 && SI != O->section_end()) {
652 i--;
653 advance(SI, 1);
654 }
655 if (SI == O->section_end())
656 fmt << Val << " (?,?)";
657 else
658 SI->getName(S);
Rafael Espindola37070a52015-06-03 04:48:06 +0000659 }
660
661 fmt << S;
662}
663
Sam Clegg4df5d762017-06-27 20:40:53 +0000664static std::error_code getRelocationValueString(const WasmObjectFile *Obj,
665 const RelocationRef &RelRef,
666 SmallVectorImpl<char> &Result) {
667 const wasm::WasmRelocation& Rel = Obj->getWasmRelocation(RelRef);
Sam Cleggf676cdd2018-04-26 16:41:51 +0000668 symbol_iterator SI = RelRef.getSymbol();
Sam Clegg4df5d762017-06-27 20:40:53 +0000669 std::string fmtbuf;
670 raw_string_ostream fmt(fmtbuf);
Sam Clegg8c4b0ce2018-04-26 17:05:04 +0000671 if (SI == Obj->symbol_end()) {
672 // Not all wasm relocations have symbols associated with them.
673 // In particular R_WEBASSEMBLY_TYPE_INDEX_LEB.
Sam Cleggf676cdd2018-04-26 16:41:51 +0000674 fmt << Rel.Index;
675 } else {
Sam Clegg8c4b0ce2018-04-26 17:05:04 +0000676 Expected<StringRef> SymNameOrErr = SI->getName();
677 if (!SymNameOrErr)
678 return errorToErrorCode(SymNameOrErr.takeError());
Sam Cleggf676cdd2018-04-26 16:41:51 +0000679 StringRef SymName = *SymNameOrErr;
680 Result.append(SymName.begin(), SymName.end());
681 }
682 fmt << (Rel.Addend < 0 ? "" : "+") << Rel.Addend;
Sam Clegg4df5d762017-06-27 20:40:53 +0000683 fmt.flush();
684 Result.append(fmtbuf.begin(), fmtbuf.end());
685 return std::error_code();
686}
687
Rafael Espindola37070a52015-06-03 04:48:06 +0000688static std::error_code getRelocationValueString(const MachOObjectFile *Obj,
689 const RelocationRef &RelRef,
690 SmallVectorImpl<char> &Result) {
691 DataRefImpl Rel = RelRef.getRawDataRefImpl();
692 MachO::any_relocation_info RE = Obj->getRelocation(Rel);
693
694 unsigned Arch = Obj->getArch();
695
696 std::string fmtbuf;
697 raw_string_ostream fmt(fmtbuf);
698 unsigned Type = Obj->getAnyRelocationType(RE);
699 bool IsPCRel = Obj->getAnyRelocationPCRel(RE);
700
701 // Determine any addends that should be displayed with the relocation.
702 // These require decoding the relocation type, which is triple-specific.
703
704 // X86_64 has entirely custom relocation types.
705 if (Arch == Triple::x86_64) {
706 bool isPCRel = Obj->getAnyRelocationPCRel(RE);
707
708 switch (Type) {
709 case MachO::X86_64_RELOC_GOT_LOAD:
710 case MachO::X86_64_RELOC_GOT: {
711 printRelocationTargetName(Obj, RE, fmt);
712 fmt << "@GOT";
713 if (isPCRel)
714 fmt << "PCREL";
715 break;
716 }
717 case MachO::X86_64_RELOC_SUBTRACTOR: {
718 DataRefImpl RelNext = Rel;
719 Obj->moveRelocationNext(RelNext);
720 MachO::any_relocation_info RENext = Obj->getRelocation(RelNext);
721
722 // X86_64_RELOC_SUBTRACTOR must be followed by a relocation of type
723 // X86_64_RELOC_UNSIGNED.
724 // NOTE: Scattered relocations don't exist on x86_64.
725 unsigned RType = Obj->getAnyRelocationType(RENext);
726 if (RType != MachO::X86_64_RELOC_UNSIGNED)
Kevin Enderby7fa40c92016-11-16 22:17:38 +0000727 report_error(Obj->getFileName(), "Expected X86_64_RELOC_UNSIGNED after "
728 "X86_64_RELOC_SUBTRACTOR.");
Rafael Espindola37070a52015-06-03 04:48:06 +0000729
730 // The X86_64_RELOC_UNSIGNED contains the minuend symbol;
731 // X86_64_RELOC_SUBTRACTOR contains the subtrahend.
732 printRelocationTargetName(Obj, RENext, fmt);
733 fmt << "-";
734 printRelocationTargetName(Obj, RE, fmt);
735 break;
736 }
737 case MachO::X86_64_RELOC_TLV:
738 printRelocationTargetName(Obj, RE, fmt);
739 fmt << "@TLV";
740 if (isPCRel)
741 fmt << "P";
742 break;
743 case MachO::X86_64_RELOC_SIGNED_1:
744 printRelocationTargetName(Obj, RE, fmt);
745 fmt << "-1";
746 break;
747 case MachO::X86_64_RELOC_SIGNED_2:
748 printRelocationTargetName(Obj, RE, fmt);
749 fmt << "-2";
750 break;
751 case MachO::X86_64_RELOC_SIGNED_4:
752 printRelocationTargetName(Obj, RE, fmt);
753 fmt << "-4";
754 break;
755 default:
756 printRelocationTargetName(Obj, RE, fmt);
757 break;
758 }
759 // X86 and ARM share some relocation types in common.
760 } else if (Arch == Triple::x86 || Arch == Triple::arm ||
761 Arch == Triple::ppc) {
762 // Generic relocation types...
763 switch (Type) {
764 case MachO::GENERIC_RELOC_PAIR: // prints no info
Rui Ueyama7d099192015-06-09 15:20:42 +0000765 return std::error_code();
Rafael Espindola37070a52015-06-03 04:48:06 +0000766 case MachO::GENERIC_RELOC_SECTDIFF: {
767 DataRefImpl RelNext = Rel;
768 Obj->moveRelocationNext(RelNext);
769 MachO::any_relocation_info RENext = Obj->getRelocation(RelNext);
770
771 // X86 sect diff's must be followed by a relocation of type
772 // GENERIC_RELOC_PAIR.
773 unsigned RType = Obj->getAnyRelocationType(RENext);
774
775 if (RType != MachO::GENERIC_RELOC_PAIR)
Kevin Enderby7fa40c92016-11-16 22:17:38 +0000776 report_error(Obj->getFileName(), "Expected GENERIC_RELOC_PAIR after "
777 "GENERIC_RELOC_SECTDIFF.");
Rafael Espindola37070a52015-06-03 04:48:06 +0000778
779 printRelocationTargetName(Obj, RE, fmt);
780 fmt << "-";
781 printRelocationTargetName(Obj, RENext, fmt);
782 break;
783 }
784 }
785
786 if (Arch == Triple::x86 || Arch == Triple::ppc) {
787 switch (Type) {
788 case MachO::GENERIC_RELOC_LOCAL_SECTDIFF: {
789 DataRefImpl RelNext = Rel;
790 Obj->moveRelocationNext(RelNext);
791 MachO::any_relocation_info RENext = Obj->getRelocation(RelNext);
792
793 // X86 sect diff's must be followed by a relocation of type
794 // GENERIC_RELOC_PAIR.
795 unsigned RType = Obj->getAnyRelocationType(RENext);
796 if (RType != MachO::GENERIC_RELOC_PAIR)
Kevin Enderby7fa40c92016-11-16 22:17:38 +0000797 report_error(Obj->getFileName(), "Expected GENERIC_RELOC_PAIR after "
798 "GENERIC_RELOC_LOCAL_SECTDIFF.");
Rafael Espindola37070a52015-06-03 04:48:06 +0000799
800 printRelocationTargetName(Obj, RE, fmt);
801 fmt << "-";
802 printRelocationTargetName(Obj, RENext, fmt);
803 break;
804 }
805 case MachO::GENERIC_RELOC_TLV: {
806 printRelocationTargetName(Obj, RE, fmt);
807 fmt << "@TLV";
808 if (IsPCRel)
809 fmt << "P";
810 break;
811 }
812 default:
813 printRelocationTargetName(Obj, RE, fmt);
814 }
815 } else { // ARM-specific relocations
816 switch (Type) {
817 case MachO::ARM_RELOC_HALF:
818 case MachO::ARM_RELOC_HALF_SECTDIFF: {
819 // Half relocations steal a bit from the length field to encode
820 // whether this is an upper16 or a lower16 relocation.
Martin Storsjofa5183b2017-07-13 05:54:08 +0000821 bool isUpper = (Obj->getAnyRelocationLength(RE) & 0x1) == 1;
Rafael Espindola37070a52015-06-03 04:48:06 +0000822
823 if (isUpper)
824 fmt << ":upper16:(";
825 else
826 fmt << ":lower16:(";
827 printRelocationTargetName(Obj, RE, fmt);
828
829 DataRefImpl RelNext = Rel;
830 Obj->moveRelocationNext(RelNext);
831 MachO::any_relocation_info RENext = Obj->getRelocation(RelNext);
832
833 // ARM half relocs must be followed by a relocation of type
834 // ARM_RELOC_PAIR.
835 unsigned RType = Obj->getAnyRelocationType(RENext);
836 if (RType != MachO::ARM_RELOC_PAIR)
Kevin Enderby7fa40c92016-11-16 22:17:38 +0000837 report_error(Obj->getFileName(), "Expected ARM_RELOC_PAIR after "
838 "ARM_RELOC_HALF");
Rafael Espindola37070a52015-06-03 04:48:06 +0000839
840 // NOTE: The half of the target virtual address is stashed in the
841 // address field of the secondary relocation, but we can't reverse
842 // engineer the constant offset from it without decoding the movw/movt
843 // instruction to find the other half in its immediate field.
844
845 // ARM_RELOC_HALF_SECTDIFF encodes the second section in the
846 // symbol/section pointer of the follow-on relocation.
847 if (Type == MachO::ARM_RELOC_HALF_SECTDIFF) {
848 fmt << "-";
849 printRelocationTargetName(Obj, RENext, fmt);
850 }
851
852 fmt << ")";
853 break;
854 }
855 default: { printRelocationTargetName(Obj, RE, fmt); }
856 }
857 }
858 } else
859 printRelocationTargetName(Obj, RE, fmt);
860
861 fmt.flush();
862 Result.append(fmtbuf.begin(), fmtbuf.end());
Rui Ueyama7d099192015-06-09 15:20:42 +0000863 return std::error_code();
Rafael Espindola37070a52015-06-03 04:48:06 +0000864}
865
866static std::error_code getRelocationValueString(const RelocationRef &Rel,
867 SmallVectorImpl<char> &Result) {
Rafael Espindola854038e2015-06-26 14:51:16 +0000868 const ObjectFile *Obj = Rel.getObject();
Rafael Espindola37070a52015-06-03 04:48:06 +0000869 if (auto *ELF = dyn_cast<ELFObjectFileBase>(Obj))
870 return getRelocationValueString(ELF, Rel, Result);
871 if (auto *COFF = dyn_cast<COFFObjectFile>(Obj))
872 return getRelocationValueString(COFF, Rel, Result);
Sam Clegg4df5d762017-06-27 20:40:53 +0000873 if (auto *Wasm = dyn_cast<WasmObjectFile>(Obj))
874 return getRelocationValueString(Wasm, Rel, Result);
875 if (auto *MachO = dyn_cast<MachOObjectFile>(Obj))
876 return getRelocationValueString(MachO, Rel, Result);
877 llvm_unreachable("unknown object file format");
Rafael Espindola37070a52015-06-03 04:48:06 +0000878}
879
Adrian Prantl4dfcc4a2018-05-01 16:10:38 +0000880/// Indicates whether this relocation should hidden when listing
Rafael Espindola0ad71d92015-06-30 03:41:26 +0000881/// relocations, usually because it is the trailing part of a multipart
882/// relocation that will be printed as part of the leading relocation.
883static bool getHidden(RelocationRef RelRef) {
884 const ObjectFile *Obj = RelRef.getObject();
885 auto *MachO = dyn_cast<MachOObjectFile>(Obj);
886 if (!MachO)
887 return false;
888
889 unsigned Arch = MachO->getArch();
890 DataRefImpl Rel = RelRef.getRawDataRefImpl();
891 uint64_t Type = MachO->getRelocationType(Rel);
892
893 // On arches that use the generic relocations, GENERIC_RELOC_PAIR
894 // is always hidden.
895 if (Arch == Triple::x86 || Arch == Triple::arm || Arch == Triple::ppc) {
896 if (Type == MachO::GENERIC_RELOC_PAIR)
897 return true;
898 } else if (Arch == Triple::x86_64) {
899 // On x86_64, X86_64_RELOC_UNSIGNED is hidden only when it follows
900 // an X86_64_RELOC_SUBTRACTOR.
901 if (Type == MachO::X86_64_RELOC_UNSIGNED && Rel.d.a > 0) {
902 DataRefImpl RelPrev = Rel;
903 RelPrev.d.a--;
904 uint64_t PrevType = MachO->getRelocationType(RelPrev);
905 if (PrevType == MachO::X86_64_RELOC_SUBTRACTOR)
906 return true;
907 }
908 }
909
910 return false;
911}
912
Sid Manningd9f28732018-05-14 19:46:08 +0000913namespace {
914class SourcePrinter {
915protected:
916 DILineInfo OldLineInfo;
917 const ObjectFile *Obj = nullptr;
918 std::unique_ptr<symbolize::LLVMSymbolizer> Symbolizer;
919 // File name to file contents of source
920 std::unordered_map<std::string, std::unique_ptr<MemoryBuffer>> SourceCache;
921 // Mark the line endings of the cached source
922 std::unordered_map<std::string, std::vector<StringRef>> LineCache;
923
924private:
925 bool cacheSource(const DILineInfo& LineInfoFile);
926
927public:
928 SourcePrinter() = default;
929 SourcePrinter(const ObjectFile *Obj, StringRef DefaultArch) : Obj(Obj) {
930 symbolize::LLVMSymbolizer::Options SymbolizerOpts(
931 DILineInfoSpecifier::FunctionNameKind::None, true, false, false,
932 DefaultArch);
933 Symbolizer.reset(new symbolize::LLVMSymbolizer(SymbolizerOpts));
934 }
935 virtual ~SourcePrinter() = default;
936 virtual void printSourceLine(raw_ostream &OS, uint64_t Address,
937 StringRef Delimiter = "; ");
938};
939
940bool SourcePrinter::cacheSource(const DILineInfo &LineInfo) {
941 std::unique_ptr<MemoryBuffer> Buffer;
942 if (LineInfo.Source) {
943 Buffer = MemoryBuffer::getMemBuffer(*LineInfo.Source);
944 } else {
945 auto BufferOrError = MemoryBuffer::getFile(LineInfo.FileName);
946 if (!BufferOrError)
947 return false;
948 Buffer = std::move(*BufferOrError);
949 }
950 // Chomp the file to get lines
951 size_t BufferSize = Buffer->getBufferSize();
952 const char *BufferStart = Buffer->getBufferStart();
953 for (const char *Start = BufferStart, *End = BufferStart;
954 End < BufferStart + BufferSize; End++)
955 if (*End == '\n' || End == BufferStart + BufferSize - 1 ||
956 (*End == '\r' && *(End + 1) == '\n')) {
957 LineCache[LineInfo.FileName].push_back(StringRef(Start, End - Start));
958 if (*End == '\r')
959 End++;
960 Start = End + 1;
961 }
962 SourceCache[LineInfo.FileName] = std::move(Buffer);
963 return true;
964}
965
966void SourcePrinter::printSourceLine(raw_ostream &OS, uint64_t Address,
967 StringRef Delimiter) {
968 if (!Symbolizer)
969 return;
970 DILineInfo LineInfo = DILineInfo();
971 auto ExpectecLineInfo =
972 Symbolizer->symbolizeCode(Obj->getFileName(), Address);
973 if (!ExpectecLineInfo)
974 consumeError(ExpectecLineInfo.takeError());
975 else
976 LineInfo = *ExpectecLineInfo;
977
978 if ((LineInfo.FileName == "<invalid>") || OldLineInfo.Line == LineInfo.Line ||
979 LineInfo.Line == 0)
980 return;
981
982 if (PrintLines)
983 OS << Delimiter << LineInfo.FileName << ":" << LineInfo.Line << "\n";
984 if (PrintSource) {
985 if (SourceCache.find(LineInfo.FileName) == SourceCache.end())
986 if (!cacheSource(LineInfo))
987 return;
988 auto FileBuffer = SourceCache.find(LineInfo.FileName);
989 if (FileBuffer != SourceCache.end()) {
990 auto LineBuffer = LineCache.find(LineInfo.FileName);
991 if (LineBuffer != LineCache.end()) {
992 if (LineInfo.Line > LineBuffer->second.size())
993 return;
994 // Vector begins at 0, line numbers are non-zero
995 OS << Delimiter << LineBuffer->second[LineInfo.Line - 1].ltrim()
996 << "\n";
997 }
998 }
999 }
1000 OldLineInfo = LineInfo;
1001}
1002
1003static bool isArmElf(const ObjectFile *Obj) {
1004 return (Obj->isELF() &&
1005 (Obj->getArch() == Triple::aarch64 ||
1006 Obj->getArch() == Triple::aarch64_be ||
1007 Obj->getArch() == Triple::arm || Obj->getArch() == Triple::armeb ||
1008 Obj->getArch() == Triple::thumb ||
1009 Obj->getArch() == Triple::thumbeb));
1010}
1011
1012class PrettyPrinter {
1013public:
1014 virtual ~PrettyPrinter() = default;
1015 virtual void printInst(MCInstPrinter &IP, const MCInst *MI,
1016 ArrayRef<uint8_t> Bytes, uint64_t Address,
1017 raw_ostream &OS, StringRef Annot,
1018 MCSubtargetInfo const &STI, SourcePrinter *SP,
1019 std::vector<RelocationRef> *Rels = nullptr) {
1020 if (SP && (PrintSource || PrintLines))
1021 SP->printSourceLine(OS, Address);
1022 if (!NoLeadingAddr)
1023 OS << format("%8" PRIx64 ":", Address);
1024 if (!NoShowRawInsn) {
1025 OS << "\t";
1026 dumpBytes(Bytes, OS);
1027 }
1028 if (MI)
1029 IP.printInst(MI, OS, "", STI);
1030 else
1031 OS << " <unknown>";
1032 }
1033};
1034PrettyPrinter PrettyPrinterInst;
1035class HexagonPrettyPrinter : public PrettyPrinter {
1036public:
1037 void printLead(ArrayRef<uint8_t> Bytes, uint64_t Address,
1038 raw_ostream &OS) {
1039 uint32_t opcode =
1040 (Bytes[3] << 24) | (Bytes[2] << 16) | (Bytes[1] << 8) | Bytes[0];
1041 if (!NoLeadingAddr)
1042 OS << format("%8" PRIx64 ":", Address);
1043 if (!NoShowRawInsn) {
1044 OS << "\t";
1045 dumpBytes(Bytes.slice(0, 4), OS);
1046 OS << format("%08" PRIx32, opcode);
1047 }
1048 }
1049 void printInst(MCInstPrinter &IP, const MCInst *MI, ArrayRef<uint8_t> Bytes,
1050 uint64_t Address, raw_ostream &OS, StringRef Annot,
1051 MCSubtargetInfo const &STI, SourcePrinter *SP,
1052 std::vector<RelocationRef> *Rels) override {
1053 if (SP && (PrintSource || PrintLines))
1054 SP->printSourceLine(OS, Address, "");
1055 if (!MI) {
1056 printLead(Bytes, Address, OS);
1057 OS << " <unknown>";
1058 return;
1059 }
1060 std::string Buffer;
1061 {
1062 raw_string_ostream TempStream(Buffer);
1063 IP.printInst(MI, TempStream, "", STI);
1064 }
1065 StringRef Contents(Buffer);
1066 // Split off bundle attributes
1067 auto PacketBundle = Contents.rsplit('\n');
1068 // Split off first instruction from the rest
1069 auto HeadTail = PacketBundle.first.split('\n');
1070 auto Preamble = " { ";
1071 auto Separator = "";
1072 StringRef Fmt = "\t\t\t%08" PRIx64 ": ";
1073 std::vector<RelocationRef>::const_iterator rel_cur = Rels->begin();
1074 std::vector<RelocationRef>::const_iterator rel_end = Rels->end();
1075
1076 // Hexagon's packets require relocations to be inline rather than
1077 // clustered at the end of the packet.
1078 auto PrintReloc = [&]() -> void {
1079 while ((rel_cur != rel_end) && (rel_cur->getOffset() <= Address)) {
1080 if (rel_cur->getOffset() == Address) {
1081 SmallString<16> name;
1082 SmallString<32> val;
1083 rel_cur->getTypeName(name);
1084 error(getRelocationValueString(*rel_cur, val));
1085 OS << Separator << format(Fmt.data(), Address) << name << "\t" << val
1086 << "\n";
1087 return;
1088 }
1089 rel_cur++;
1090 }
1091 };
1092
1093 while(!HeadTail.first.empty()) {
1094 OS << Separator;
1095 Separator = "\n";
1096 if (SP && (PrintSource || PrintLines))
1097 SP->printSourceLine(OS, Address, "");
1098 printLead(Bytes, Address, OS);
1099 OS << Preamble;
1100 Preamble = " ";
1101 StringRef Inst;
1102 auto Duplex = HeadTail.first.split('\v');
1103 if(!Duplex.second.empty()){
1104 OS << Duplex.first;
1105 OS << "; ";
1106 Inst = Duplex.second;
1107 }
1108 else
1109 Inst = HeadTail.first;
1110 OS << Inst;
1111 HeadTail = HeadTail.second.split('\n');
1112 if (HeadTail.first.empty())
1113 OS << " } " << PacketBundle.second;
1114 PrintReloc();
1115 Bytes = Bytes.slice(4);
1116 Address += 4;
1117 }
1118 }
1119};
1120HexagonPrettyPrinter HexagonPrettyPrinterInst;
1121
1122class AMDGCNPrettyPrinter : public PrettyPrinter {
1123public:
1124 void printInst(MCInstPrinter &IP, const MCInst *MI, ArrayRef<uint8_t> Bytes,
1125 uint64_t Address, raw_ostream &OS, StringRef Annot,
1126 MCSubtargetInfo const &STI, SourcePrinter *SP,
1127 std::vector<RelocationRef> *Rels) override {
1128 if (SP && (PrintSource || PrintLines))
1129 SP->printSourceLine(OS, Address);
1130
1131 typedef support::ulittle32_t U32;
1132
1133 if (MI) {
1134 SmallString<40> InstStr;
1135 raw_svector_ostream IS(InstStr);
1136
1137 IP.printInst(MI, IS, "", STI);
1138
1139 OS << left_justify(IS.str(), 60);
1140 } else {
1141 // an unrecognized encoding - this is probably data so represent it
1142 // using the .long directive, or .byte directive if fewer than 4 bytes
1143 // remaining
1144 if (Bytes.size() >= 4) {
1145 OS << format("\t.long 0x%08" PRIx32 " ",
1146 static_cast<uint32_t>(*reinterpret_cast<const U32*>(Bytes.data())));
1147 OS.indent(42);
1148 } else {
1149 OS << format("\t.byte 0x%02" PRIx8, Bytes[0]);
1150 for (unsigned int i = 1; i < Bytes.size(); i++)
1151 OS << format(", 0x%02" PRIx8, Bytes[i]);
1152 OS.indent(55 - (6 * Bytes.size()));
1153 }
1154 }
1155
1156 OS << format("// %012" PRIX64 ": ", Address);
1157 if (Bytes.size() >=4) {
1158 for (auto D : makeArrayRef(reinterpret_cast<const U32*>(Bytes.data()),
1159 Bytes.size() / sizeof(U32)))
1160 // D should be explicitly casted to uint32_t here as it is passed
1161 // by format to snprintf as vararg.
1162 OS << format("%08" PRIX32 " ", static_cast<uint32_t>(D));
1163 } else {
1164 for (unsigned int i = 0; i < Bytes.size(); i++)
1165 OS << format("%02" PRIX8 " ", Bytes[i]);
1166 }
1167
1168 if (!Annot.empty())
1169 OS << "// " << Annot;
1170 }
1171};
1172AMDGCNPrettyPrinter AMDGCNPrettyPrinterInst;
1173
1174class BPFPrettyPrinter : public PrettyPrinter {
1175public:
1176 void printInst(MCInstPrinter &IP, const MCInst *MI, ArrayRef<uint8_t> Bytes,
1177 uint64_t Address, raw_ostream &OS, StringRef Annot,
1178 MCSubtargetInfo const &STI, SourcePrinter *SP,
1179 std::vector<RelocationRef> *Rels) override {
1180 if (SP && (PrintSource || PrintLines))
1181 SP->printSourceLine(OS, Address);
1182 if (!NoLeadingAddr)
1183 OS << format("%8" PRId64 ":", Address / 8);
1184 if (!NoShowRawInsn) {
1185 OS << "\t";
1186 dumpBytes(Bytes, OS);
1187 }
1188 if (MI)
1189 IP.printInst(MI, OS, "", STI);
1190 else
1191 OS << " <unknown>";
1192 }
1193};
1194BPFPrettyPrinter BPFPrettyPrinterInst;
1195
1196PrettyPrinter &selectPrettyPrinter(Triple const &Triple) {
1197 switch(Triple.getArch()) {
1198 default:
1199 return PrettyPrinterInst;
1200 case Triple::hexagon:
1201 return HexagonPrettyPrinterInst;
1202 case Triple::amdgcn:
1203 return AMDGCNPrettyPrinterInst;
1204 case Triple::bpfel:
1205 case Triple::bpfeb:
1206 return BPFPrettyPrinterInst;
1207 }
1208}
1209}
1210
Sam Koltonc05d7782016-08-17 10:17:57 +00001211static uint8_t getElfSymbolType(const ObjectFile *Obj, const SymbolRef &Sym) {
1212 assert(Obj->isELF());
1213 if (auto *Elf32LEObj = dyn_cast<ELF32LEObjectFile>(Obj))
1214 return Elf32LEObj->getSymbol(Sym.getRawDataRefImpl())->getType();
1215 if (auto *Elf64LEObj = dyn_cast<ELF64LEObjectFile>(Obj))
1216 return Elf64LEObj->getSymbol(Sym.getRawDataRefImpl())->getType();
1217 if (auto *Elf32BEObj = dyn_cast<ELF32BEObjectFile>(Obj))
1218 return Elf32BEObj->getSymbol(Sym.getRawDataRefImpl())->getType();
1219 if (auto *Elf64BEObj = cast<ELF64BEObjectFile>(Obj))
1220 return Elf64BEObj->getSymbol(Sym.getRawDataRefImpl())->getType();
1221 llvm_unreachable("Unsupported binary format");
1222}
1223
Sam Parker5fba45a2017-02-08 09:44:18 +00001224template <class ELFT> static void
1225addDynamicElfSymbols(const ELFObjectFile<ELFT> *Obj,
1226 std::map<SectionRef, SectionSymbolsTy> &AllSymbols) {
1227 for (auto Symbol : Obj->getDynamicSymbolIterators()) {
1228 uint8_t SymbolType = Symbol.getELFType();
1229 if (SymbolType != ELF::STT_FUNC || Symbol.getSize() == 0)
1230 continue;
1231
1232 Expected<uint64_t> AddressOrErr = Symbol.getAddress();
1233 if (!AddressOrErr)
1234 report_error(Obj->getFileName(), AddressOrErr.takeError());
1235 uint64_t Address = *AddressOrErr;
1236
1237 Expected<StringRef> Name = Symbol.getName();
1238 if (!Name)
1239 report_error(Obj->getFileName(), Name.takeError());
1240 if (Name->empty())
1241 continue;
1242
1243 Expected<section_iterator> SectionOrErr = Symbol.getSection();
1244 if (!SectionOrErr)
1245 report_error(Obj->getFileName(), SectionOrErr.takeError());
1246 section_iterator SecI = *SectionOrErr;
1247 if (SecI == Obj->section_end())
1248 continue;
1249
1250 AllSymbols[*SecI].emplace_back(Address, *Name, SymbolType);
1251 }
1252}
1253
1254static void
1255addDynamicElfSymbols(const ObjectFile *Obj,
1256 std::map<SectionRef, SectionSymbolsTy> &AllSymbols) {
1257 assert(Obj->isELF());
1258 if (auto *Elf32LEObj = dyn_cast<ELF32LEObjectFile>(Obj))
1259 addDynamicElfSymbols(Elf32LEObj, AllSymbols);
1260 else if (auto *Elf64LEObj = dyn_cast<ELF64LEObjectFile>(Obj))
1261 addDynamicElfSymbols(Elf64LEObj, AllSymbols);
1262 else if (auto *Elf32BEObj = dyn_cast<ELF32BEObjectFile>(Obj))
1263 addDynamicElfSymbols(Elf32BEObj, AllSymbols);
1264 else if (auto *Elf64BEObj = cast<ELF64BEObjectFile>(Obj))
1265 addDynamicElfSymbols(Elf64BEObj, AllSymbols);
1266 else
1267 llvm_unreachable("Unsupported binary format");
1268}
1269
Joel Galenson134cf472018-08-24 15:21:57 +00001270static void addPltEntries(const ObjectFile *Obj,
1271 std::map<SectionRef, SectionSymbolsTy> &AllSymbols,
1272 StringSaver &Saver) {
1273 Optional<SectionRef> Plt = None;
1274 for (const SectionRef &Section : Obj->sections()) {
1275 StringRef Name;
1276 if (Section.getName(Name))
1277 continue;
1278 if (Name == ".plt")
1279 Plt = Section;
1280 }
1281 if (!Plt)
1282 return;
1283 if (auto *ElfObj = dyn_cast<ELFObjectFileBase>(Obj)) {
1284 for (auto PltEntry : ElfObj->getPltAddresses()) {
1285 SymbolRef Symbol(PltEntry.first, ElfObj);
1286
1287 uint8_t SymbolType = getElfSymbolType(Obj, Symbol);
1288
1289 Expected<StringRef> NameOrErr = Symbol.getName();
1290 if (!NameOrErr)
1291 report_error(Obj->getFileName(), NameOrErr.takeError());
1292 if (NameOrErr->empty())
1293 continue;
1294 StringRef Name = Saver.save((*NameOrErr + "@plt").str());
1295
1296 AllSymbols[*Plt].emplace_back(PltEntry.second, Name, SymbolType);
1297 }
1298 }
1299}
1300
Michael J. Spencer51862b32011-10-13 22:17:18 +00001301static void DisassembleObject(const ObjectFile *Obj, bool InlineRelocs) {
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001302 if (StartAddress > StopAddress)
1303 error("Start address should be less than stop address");
1304
Jim Grosbachaf9aec02012-08-07 17:53:14 +00001305 const Target *TheTarget = getTarget(Obj);
Michael J. Spencer2670c252011-01-20 06:39:06 +00001306
Jack Carter551efd72012-08-28 19:24:49 +00001307 // Package up features to be passed to target/subtarget
Daniel Sanders1d148642016-06-16 09:17:03 +00001308 SubtargetFeatures Features = Obj->getFeatures();
Jordan Rupprecht16a0de22018-12-20 00:57:06 +00001309 if (!MAttrs.empty()) {
Jack Carter551efd72012-08-28 19:24:49 +00001310 for (unsigned i = 0; i != MAttrs.size(); ++i)
1311 Features.AddFeature(MAttrs[i]);
Jack Carter551efd72012-08-28 19:24:49 +00001312 }
1313
Ahmed Charles56440fd2014-03-06 05:51:42 +00001314 std::unique_ptr<const MCRegisterInfo> MRI(
1315 TheTarget->createMCRegInfo(TripleName));
Davide Italiano711e4952015-12-17 01:59:50 +00001316 if (!MRI)
Kevin Enderby7fa40c92016-11-16 22:17:38 +00001317 report_error(Obj->getFileName(), "no register info for target " +
1318 TripleName);
Ahmed Bougacha0835ca12013-05-16 21:28:23 +00001319
1320 // Set up disassembler.
Ahmed Charles56440fd2014-03-06 05:51:42 +00001321 std::unique_ptr<const MCAsmInfo> AsmInfo(
1322 TheTarget->createMCAsmInfo(*MRI, TripleName));
Davide Italiano711e4952015-12-17 01:59:50 +00001323 if (!AsmInfo)
Kevin Enderby7fa40c92016-11-16 22:17:38 +00001324 report_error(Obj->getFileName(), "no assembly info for target " +
1325 TripleName);
Ahmed Charles56440fd2014-03-06 05:51:42 +00001326 std::unique_ptr<const MCSubtargetInfo> STI(
Daniel Sanders1d148642016-06-16 09:17:03 +00001327 TheTarget->createMCSubtargetInfo(TripleName, MCPU, Features.getString()));
Davide Italiano711e4952015-12-17 01:59:50 +00001328 if (!STI)
Kevin Enderby7fa40c92016-11-16 22:17:38 +00001329 report_error(Obj->getFileName(), "no subtarget info for target " +
1330 TripleName);
Ahmed Charles56440fd2014-03-06 05:51:42 +00001331 std::unique_ptr<const MCInstrInfo> MII(TheTarget->createMCInstrInfo());
Davide Italiano711e4952015-12-17 01:59:50 +00001332 if (!MII)
Kevin Enderby7fa40c92016-11-16 22:17:38 +00001333 report_error(Obj->getFileName(), "no instruction info for target " +
1334 TripleName);
Sam Kolton3381d7a2016-10-06 13:46:08 +00001335 MCObjectFileInfo MOFI;
1336 MCContext Ctx(AsmInfo.get(), MRI.get(), &MOFI);
1337 // FIXME: for now initialize MCObjectFileInfo with default values
Rafael Espindola9f929952017-08-02 20:32:26 +00001338 MOFI.InitMCObjectFileInfo(Triple(TripleName), false, Ctx);
Lang Hamesa1bc0f52014-04-15 04:40:56 +00001339
1340 std::unique_ptr<MCDisassembler> DisAsm(
1341 TheTarget->createMCDisassembler(*STI, Ctx));
Davide Italiano711e4952015-12-17 01:59:50 +00001342 if (!DisAsm)
Kevin Enderby7fa40c92016-11-16 22:17:38 +00001343 report_error(Obj->getFileName(), "no disassembler for target " +
1344 TripleName);
Ahmed Bougachaad1084d2013-05-24 00:39:57 +00001345
Ahmed Charles56440fd2014-03-06 05:51:42 +00001346 std::unique_ptr<const MCInstrAnalysis> MIA(
1347 TheTarget->createMCInstrAnalysis(MII.get()));
Ahmed Bougachaaa790682013-05-24 01:07:04 +00001348
Ahmed Bougacha0835ca12013-05-16 21:28:23 +00001349 int AsmPrinterVariant = AsmInfo->getAssemblerDialect();
Daniel Sanders50f17232015-09-15 16:17:27 +00001350 std::unique_ptr<MCInstPrinter> IP(TheTarget->createMCInstPrinter(
1351 Triple(TripleName), AsmPrinterVariant, *AsmInfo, *MII, *MRI));
Davide Italiano711e4952015-12-17 01:59:50 +00001352 if (!IP)
Kevin Enderby7fa40c92016-11-16 22:17:38 +00001353 report_error(Obj->getFileName(), "no instruction printer for target " +
1354 TripleName);
Colin LeMahieu14ec76e2015-06-07 21:07:17 +00001355 IP->setPrintImmHex(PrintImmHex);
Colin LeMahieu35436a22015-05-29 14:48:25 +00001356 PrettyPrinter &PIP = selectPrettyPrinter(Triple(TripleName));
Ahmed Bougacha0835ca12013-05-16 21:28:23 +00001357
Greg Fitzgerald18432272014-03-20 22:55:15 +00001358 StringRef Fmt = Obj->getBytesInAddress() > 4 ? "\t\t%016" PRIx64 ": " :
1359 "\t\t\t%08" PRIx64 ": ";
1360
Hemant Kulkarni8dfc0b52016-08-15 19:49:24 +00001361 SourcePrinter SP(Obj, TheTarget->getName());
1362
Mark Seaborn0929d3d2014-01-25 17:38:19 +00001363 // Create a mapping, RelocSecs = SectionRelocMap[S], where sections
1364 // in RelocSecs contain the relocations for section S.
Rafael Espindola4453e42942014-06-13 03:07:50 +00001365 std::error_code EC;
Alexey Samsonov48803e52014-03-13 14:37:36 +00001366 std::map<SectionRef, SmallVector<SectionRef, 1>> SectionRelocMap;
Colin LeMahieu77804be2015-07-29 15:45:39 +00001367 for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
Alexey Samsonov48803e52014-03-13 14:37:36 +00001368 section_iterator Sec2 = Section.getRelocatedSection();
Rafael Espindolab5155a52014-02-10 20:24:04 +00001369 if (Sec2 != Obj->section_end())
Alexey Samsonov48803e52014-03-13 14:37:36 +00001370 SectionRelocMap[*Sec2].push_back(Section);
Mark Seaborn0929d3d2014-01-25 17:38:19 +00001371 }
1372
David Majnemer81afca62015-07-07 22:06:59 +00001373 // Create a mapping from virtual address to symbol name. This is used to
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001374 // pretty print the symbols while disassembling.
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001375 std::map<SectionRef, SectionSymbolsTy> AllSymbols;
Sterling Augustinebc78b622018-06-28 18:57:13 +00001376 SectionSymbolsTy AbsoluteSymbols;
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001377 for (const SymbolRef &Symbol : Obj->symbols()) {
Kevin Enderby931cb652016-06-24 18:24:42 +00001378 Expected<uint64_t> AddressOrErr = Symbol.getAddress();
Kevin Enderby7fa40c92016-11-16 22:17:38 +00001379 if (!AddressOrErr)
1380 report_error(Obj->getFileName(), AddressOrErr.takeError());
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001381 uint64_t Address = *AddressOrErr;
David Majnemer2603a8fa2015-07-09 18:11:40 +00001382
Kevin Enderby81e8b7d2016-04-20 21:24:34 +00001383 Expected<StringRef> Name = Symbol.getName();
Kevin Enderby7fa40c92016-11-16 22:17:38 +00001384 if (!Name)
1385 report_error(Obj->getFileName(), Name.takeError());
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001386 if (Name->empty())
1387 continue;
David Majnemer81afca62015-07-07 22:06:59 +00001388
Kevin Enderby7bd8d992016-05-02 20:28:12 +00001389 Expected<section_iterator> SectionOrErr = Symbol.getSection();
Kevin Enderby7fa40c92016-11-16 22:17:38 +00001390 if (!SectionOrErr)
1391 report_error(Obj->getFileName(), SectionOrErr.takeError());
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001392
Sam Koltonc05d7782016-08-17 10:17:57 +00001393 uint8_t SymbolType = ELF::STT_NOTYPE;
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001394 if (Obj->isELF())
Sam Koltonc05d7782016-08-17 10:17:57 +00001395 SymbolType = getElfSymbolType(Obj, Symbol);
David Majnemer81afca62015-07-07 22:06:59 +00001396
Sterling Augustinebc78b622018-06-28 18:57:13 +00001397 section_iterator SecI = *SectionOrErr;
1398 if (SecI != Obj->section_end())
1399 AllSymbols[*SecI].emplace_back(Address, *Name, SymbolType);
1400 else
1401 AbsoluteSymbols.emplace_back(Address, *Name, SymbolType);
1402
Sam Koltonc05d7782016-08-17 10:17:57 +00001403
David Majnemer81afca62015-07-07 22:06:59 +00001404 }
Sam Parker5fba45a2017-02-08 09:44:18 +00001405 if (AllSymbols.empty() && Obj->isELF())
1406 addDynamicElfSymbols(Obj, AllSymbols);
David Majnemer81afca62015-07-07 22:06:59 +00001407
Joel Galenson134cf472018-08-24 15:21:57 +00001408 BumpPtrAllocator A;
1409 StringSaver Saver(A);
1410 addPltEntries(Obj, AllSymbols, Saver);
1411
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001412 // Create a mapping from virtual address to section.
1413 std::vector<std::pair<uint64_t, SectionRef>> SectionAddresses;
1414 for (SectionRef Sec : Obj->sections())
1415 SectionAddresses.emplace_back(Sec.getAddress(), Sec);
1416 array_pod_sort(SectionAddresses.begin(), SectionAddresses.end());
1417
1418 // Linked executables (.exe and .dll files) typically don't include a real
1419 // symbol table but they might contain an export table.
1420 if (const auto *COFFObj = dyn_cast<COFFObjectFile>(Obj)) {
1421 for (const auto &ExportEntry : COFFObj->export_directories()) {
1422 StringRef Name;
1423 error(ExportEntry.getSymbolName(Name));
1424 if (Name.empty())
1425 continue;
1426 uint32_t RVA;
1427 error(ExportEntry.getExportRVA(RVA));
1428
1429 uint64_t VA = COFFObj->getImageBase() + RVA;
1430 auto Sec = std::upper_bound(
1431 SectionAddresses.begin(), SectionAddresses.end(), VA,
1432 [](uint64_t LHS, const std::pair<uint64_t, SectionRef> &RHS) {
1433 return LHS < RHS.first;
1434 });
1435 if (Sec != SectionAddresses.begin())
1436 --Sec;
1437 else
1438 Sec = SectionAddresses.end();
1439
1440 if (Sec != SectionAddresses.end())
Sam Koltonc05d7782016-08-17 10:17:57 +00001441 AllSymbols[Sec->second].emplace_back(VA, Name, ELF::STT_NOTYPE);
Sterling Augustinebc78b622018-06-28 18:57:13 +00001442 else
1443 AbsoluteSymbols.emplace_back(VA, Name, ELF::STT_NOTYPE);
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001444 }
1445 }
1446
1447 // Sort all the symbols, this allows us to use a simple binary search to find
1448 // a symbol near an address.
1449 for (std::pair<const SectionRef, SectionSymbolsTy> &SecSyms : AllSymbols)
1450 array_pod_sort(SecSyms.second.begin(), SecSyms.second.end());
Sterling Augustinebc78b622018-06-28 18:57:13 +00001451 array_pod_sort(AbsoluteSymbols.begin(), AbsoluteSymbols.end());
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001452
Colin LeMahieu77804be2015-07-29 15:45:39 +00001453 for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
Colin LeMahieuf34933e2015-07-23 20:58:49 +00001454 if (!DisassembleAll && (!Section.isText() || Section.isVirtual()))
Mark Seaborneb03ac52014-01-25 00:32:01 +00001455 continue;
Michael J. Spencer1d6167f2011-06-25 17:55:23 +00001456
Rafael Espindola80291272014-10-08 15:28:58 +00001457 uint64_t SectionAddr = Section.getAddress();
1458 uint64_t SectSize = Section.getSize();
David Majnemer185b5b12014-11-11 09:58:25 +00001459 if (!SectSize)
1460 continue;
Simon Atanasyan2b614e12014-02-24 22:12:11 +00001461
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001462 // Get the list of all the symbols in this section.
1463 SectionSymbolsTy &Symbols = AllSymbols[Section];
Davide Italianof0706882015-10-01 21:57:09 +00001464 std::vector<uint64_t> DataMappingSymsAddr;
1465 std::vector<uint64_t> TextMappingSymsAddr;
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001466 if (isArmElf(Obj)) {
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001467 for (const auto &Symb : Symbols) {
Sam Koltonc05d7782016-08-17 10:17:57 +00001468 uint64_t Address = std::get<0>(Symb);
1469 StringRef Name = std::get<1>(Symb);
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001470 if (Name.startswith("$d"))
David Majnemer153722d2015-11-18 04:35:32 +00001471 DataMappingSymsAddr.push_back(Address - SectionAddr);
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001472 if (Name.startswith("$x"))
David Majnemer153722d2015-11-18 04:35:32 +00001473 TextMappingSymsAddr.push_back(Address - SectionAddr);
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001474 if (Name.startswith("$a"))
1475 TextMappingSymsAddr.push_back(Address - SectionAddr);
1476 if (Name.startswith("$t"))
1477 TextMappingSymsAddr.push_back(Address - SectionAddr);
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001478 }
1479 }
1480
Fangrui Song0cac7262018-09-27 02:13:45 +00001481 llvm::sort(DataMappingSymsAddr);
1482 llvm::sort(TextMappingSymsAddr);
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001483
Sam Kolton3381d7a2016-10-06 13:46:08 +00001484 if (Obj->isELF() && Obj->getArch() == Triple::amdgcn) {
1485 // AMDGPU disassembler uses symbolizer for printing labels
1486 std::unique_ptr<MCRelocationInfo> RelInfo(
1487 TheTarget->createMCRelocationInfo(TripleName, Ctx));
1488 if (RelInfo) {
1489 std::unique_ptr<MCSymbolizer> Symbolizer(
1490 TheTarget->createMCSymbolizer(
1491 TripleName, nullptr, nullptr, &Symbols, &Ctx, std::move(RelInfo)));
1492 DisAsm->setSymbolizer(std::move(Symbolizer));
1493 }
1494 }
1495
Michael J. Spencer51862b32011-10-13 22:17:18 +00001496 // Make a list of all the relocations for this section.
1497 std::vector<RelocationRef> Rels;
1498 if (InlineRelocs) {
Alexey Samsonovaa4d2952014-03-14 14:22:49 +00001499 for (const SectionRef &RelocSec : SectionRelocMap[Section]) {
1500 for (const RelocationRef &Reloc : RelocSec.relocations()) {
1501 Rels.push_back(Reloc);
1502 }
Michael J. Spencer51862b32011-10-13 22:17:18 +00001503 }
1504 }
1505
1506 // Sort relocations by address.
Fangrui Song0cac7262018-09-27 02:13:45 +00001507 llvm::sort(Rels, RelocAddressLess);
Michael J. Spencer51862b32011-10-13 22:17:18 +00001508
Rafael Espindolaa9f810b2012-12-21 03:47:03 +00001509 StringRef SegmentName = "";
Mark Seaborneb03ac52014-01-25 00:32:01 +00001510 if (const MachOObjectFile *MachO = dyn_cast<const MachOObjectFile>(Obj)) {
Alexey Samsonov48803e52014-03-13 14:37:36 +00001511 DataRefImpl DR = Section.getRawDataRefImpl();
Rafael Espindola56f976f2013-04-18 18:08:55 +00001512 SegmentName = MachO->getSectionFinalSegmentName(DR);
Rafael Espindolaa9f810b2012-12-21 03:47:03 +00001513 }
Rafael Aulerb0e4b912018-03-09 19:13:44 +00001514 StringRef SectionName;
1515 error(Section.getName(SectionName));
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001516
Rafael Espindola7884c952015-06-04 15:01:05 +00001517 // If the section has no symbol at the start, just insert a dummy one.
Sam Koltonc05d7782016-08-17 10:17:57 +00001518 if (Symbols.empty() || std::get<0>(Symbols[0]) != 0) {
Rafael Aulerb0e4b912018-03-09 19:13:44 +00001519 Symbols.insert(
1520 Symbols.begin(),
1521 std::make_tuple(SectionAddr, SectionName,
1522 Section.isText() ? ELF::STT_FUNC : ELF::STT_OBJECT));
Sam Koltonc05d7782016-08-17 10:17:57 +00001523 }
Alp Tokere69170a2014-06-26 22:52:05 +00001524
1525 SmallString<40> Comments;
1526 raw_svector_ostream CommentStream(Comments);
Ahmed Bougachaad1084d2013-05-24 00:39:57 +00001527
Rafael Espindola7fc5b872014-11-12 02:04:27 +00001528 StringRef BytesStr;
Davide Italianoccd53fe2015-08-05 07:18:31 +00001529 error(Section.getContents(BytesStr));
Aaron Ballman106fd7b2014-11-12 14:01:17 +00001530 ArrayRef<uint8_t> Bytes(reinterpret_cast<const uint8_t *>(BytesStr.data()),
1531 BytesStr.size());
Rafael Espindola7fc5b872014-11-12 02:04:27 +00001532
Michael J. Spencer2670c252011-01-20 06:39:06 +00001533 uint64_t Size;
1534 uint64_t Index;
Rafael Aulerb0e4b912018-03-09 19:13:44 +00001535 bool PrintedSection = false;
Michael J. Spencer2670c252011-01-20 06:39:06 +00001536
Michael J. Spencer51862b32011-10-13 22:17:18 +00001537 std::vector<RelocationRef>::const_iterator rel_cur = Rels.begin();
1538 std::vector<RelocationRef>::const_iterator rel_end = Rels.end();
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001539 // Disassemble symbol by symbol.
1540 for (unsigned si = 0, se = Symbols.size(); si != se; ++si) {
Sam Koltonc05d7782016-08-17 10:17:57 +00001541 uint64_t Start = std::get<0>(Symbols[si]) - SectionAddr;
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001542 // The end is either the section end or the beginning of the next
1543 // symbol.
1544 uint64_t End =
Sam Koltonc05d7782016-08-17 10:17:57 +00001545 (si == se - 1) ? SectSize : std::get<0>(Symbols[si + 1]) - SectionAddr;
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001546 // Don't try to disassemble beyond the end of section contents.
1547 if (End > SectSize)
1548 End = SectSize;
Rafael Espindolae45c7402014-08-17 16:31:39 +00001549 // If this symbol has the same address as the next symbol, then skip it.
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001550 if (Start >= End)
Michael J. Spenceree84f642011-10-13 20:37:08 +00001551 continue;
1552
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001553 // Check if we need to skip symbol
1554 // Skip if the symbol's data is not between StartAddress and StopAddress
1555 if (End + SectionAddr < StartAddress ||
1556 Start + SectionAddr > StopAddress) {
1557 continue;
1558 }
1559
Rafael Aulerb0e4b912018-03-09 19:13:44 +00001560 /// Skip if user requested specific symbols and this is not in the list
1561 if (!DisasmFuncsSet.empty() &&
1562 !DisasmFuncsSet.count(std::get<1>(Symbols[si])))
1563 continue;
1564
1565 if (!PrintedSection) {
1566 PrintedSection = true;
1567 outs() << "Disassembly of section ";
1568 if (!SegmentName.empty())
1569 outs() << SegmentName << ",";
1570 outs() << SectionName << ':';
1571 }
1572
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001573 // Stop disassembly at the stop address specified
1574 if (End + SectionAddr > StopAddress)
1575 End = StopAddress - SectionAddr;
1576
Valery Pykhtinde048052016-04-07 07:24:01 +00001577 if (Obj->isELF() && Obj->getArch() == Triple::amdgcn) {
Sam Koltonc05d7782016-08-17 10:17:57 +00001578 if (std::get<2>(Symbols[si]) == ELF::STT_AMDGPU_HSA_KERNEL) {
1579 // skip amd_kernel_code_t at the begining of kernel symbol (256 bytes)
1580 Start += 256;
1581 }
1582 if (si == se - 1 ||
1583 std::get<2>(Symbols[si + 1]) == ELF::STT_AMDGPU_HSA_KERNEL) {
1584 // cut trailing zeroes at the end of kernel
1585 // cut up to 256 bytes
1586 const uint64_t EndAlign = 256;
1587 const auto Limit = End - (std::min)(EndAlign, End - Start);
1588 while (End > Limit &&
1589 *reinterpret_cast<const support::ulittle32_t*>(&Bytes[End - 4]) == 0)
1590 End -= 4;
1591 }
Valery Pykhtinde048052016-04-07 07:24:01 +00001592 }
1593
George Rimar6622d412018-12-19 10:21:45 +00001594 outs() << '\n';
Paul Semel007dedb2018-07-18 16:39:21 +00001595 StringRef SymbolName = std::get<1>(Symbols[si]);
George Rimar6622d412018-12-19 10:21:45 +00001596 if (Demangle)
1597 outs() << demangle(SymbolName) << ":\n";
1598 else
1599 outs() << SymbolName << ":\n";
Michael J. Spencer2670c252011-01-20 06:39:06 +00001600
Francis Visoiu Mistrih18346822018-04-19 17:02:57 +00001601 // Don't print raw contents of a virtual section. A virtual section
1602 // doesn't have any contents in the file.
1603 if (Section.isVirtual()) {
1604 outs() << "...\n";
1605 continue;
1606 }
1607
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001608#ifndef NDEBUG
Mark Seaborneb03ac52014-01-25 00:32:01 +00001609 raw_ostream &DebugOut = DebugFlag ? dbgs() : nulls();
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001610#else
Mark Seaborneb03ac52014-01-25 00:32:01 +00001611 raw_ostream &DebugOut = nulls();
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001612#endif
1613
Benjamin Kramer43a772e2011-09-19 17:56:04 +00001614 for (Index = Start; Index < End; Index += Size) {
1615 MCInst Inst;
Owen Andersona0c3b972011-09-15 23:38:46 +00001616
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001617 if (Index + SectionAddr < StartAddress ||
1618 Index + SectionAddr > StopAddress) {
1619 // skip byte by byte till StartAddress is reached
1620 Size = 1;
1621 continue;
1622 }
Davide Italianof0706882015-10-01 21:57:09 +00001623 // AArch64 ELF binaries can interleave data and text in the
1624 // same section. We rely on the markers introduced to
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001625 // understand what we need to dump. If the data marker is within a
1626 // function, it is denoted as a word/short etc
1627 if (isArmElf(Obj) && std::get<2>(Symbols[si]) != ELF::STT_OBJECT &&
1628 !DisassembleAll) {
Davide Italianof0706882015-10-01 21:57:09 +00001629 uint64_t Stride = 0;
1630
1631 auto DAI = std::lower_bound(DataMappingSymsAddr.begin(),
1632 DataMappingSymsAddr.end(), Index);
1633 if (DAI != DataMappingSymsAddr.end() && *DAI == Index) {
1634 // Switch to data.
1635 while (Index < End) {
1636 outs() << format("%8" PRIx64 ":", SectionAddr + Index);
1637 outs() << "\t";
1638 if (Index + 4 <= End) {
1639 Stride = 4;
1640 dumpBytes(Bytes.slice(Index, 4), outs());
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001641 outs() << "\t.word\t";
1642 uint32_t Data = 0;
1643 if (Obj->isLittleEndian()) {
1644 const auto Word =
1645 reinterpret_cast<const support::ulittle32_t *>(
1646 Bytes.data() + Index);
1647 Data = *Word;
1648 } else {
1649 const auto Word = reinterpret_cast<const support::ubig32_t *>(
1650 Bytes.data() + Index);
1651 Data = *Word;
1652 }
1653 outs() << "0x" << format("%08" PRIx32, Data);
Davide Italianof0706882015-10-01 21:57:09 +00001654 } else if (Index + 2 <= End) {
1655 Stride = 2;
1656 dumpBytes(Bytes.slice(Index, 2), outs());
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001657 outs() << "\t\t.short\t";
1658 uint16_t Data = 0;
1659 if (Obj->isLittleEndian()) {
1660 const auto Short =
1661 reinterpret_cast<const support::ulittle16_t *>(
1662 Bytes.data() + Index);
1663 Data = *Short;
1664 } else {
1665 const auto Short =
1666 reinterpret_cast<const support::ubig16_t *>(Bytes.data() +
1667 Index);
1668 Data = *Short;
1669 }
1670 outs() << "0x" << format("%04" PRIx16, Data);
Davide Italianof0706882015-10-01 21:57:09 +00001671 } else {
1672 Stride = 1;
1673 dumpBytes(Bytes.slice(Index, 1), outs());
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001674 outs() << "\t\t.byte\t";
1675 outs() << "0x" << format("%02" PRIx8, Bytes.slice(Index, 1)[0]);
Davide Italianof0706882015-10-01 21:57:09 +00001676 }
1677 Index += Stride;
1678 outs() << "\n";
1679 auto TAI = std::lower_bound(TextMappingSymsAddr.begin(),
1680 TextMappingSymsAddr.end(), Index);
1681 if (TAI != TextMappingSymsAddr.end() && *TAI == Index)
1682 break;
1683 }
1684 }
1685 }
1686
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001687 // If there is a data symbol inside an ELF text section and we are only
1688 // disassembling text (applicable all architectures),
1689 // we are in a situation where we must print the data and not
1690 // disassemble it.
1691 if (Obj->isELF() && std::get<2>(Symbols[si]) == ELF::STT_OBJECT &&
1692 !DisassembleAll && Section.isText()) {
1693 // print out data up to 8 bytes at a time in hex and ascii
1694 uint8_t AsciiData[9] = {'\0'};
1695 uint8_t Byte;
1696 int NumBytes = 0;
1697
1698 for (Index = Start; Index < End; Index += 1) {
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001699 if (((SectionAddr + Index) < StartAddress) ||
1700 ((SectionAddr + Index) > StopAddress))
1701 continue;
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001702 if (NumBytes == 0) {
1703 outs() << format("%8" PRIx64 ":", SectionAddr + Index);
1704 outs() << "\t";
1705 }
1706 Byte = Bytes.slice(Index)[0];
1707 outs() << format(" %02x", Byte);
Michael Kruse6f1da6e2018-07-26 15:31:41 +00001708 AsciiData[NumBytes] = isPrint(Byte) ? Byte : '.';
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001709
1710 uint8_t IndentOffset = 0;
1711 NumBytes++;
1712 if (Index == End - 1 || NumBytes > 8) {
1713 // Indent the space for less than 8 bytes data.
1714 // 2 spaces for byte and one for space between bytes
1715 IndentOffset = 3 * (8 - NumBytes);
1716 for (int Excess = 8 - NumBytes; Excess < 8; Excess++)
1717 AsciiData[Excess] = '\0';
1718 NumBytes = 8;
1719 }
1720 if (NumBytes == 8) {
1721 AsciiData[8] = '\0';
1722 outs() << std::string(IndentOffset, ' ') << " ";
1723 outs() << reinterpret_cast<char *>(AsciiData);
1724 outs() << '\n';
1725 NumBytes = 0;
1726 }
1727 }
1728 }
Davide Italianof0706882015-10-01 21:57:09 +00001729 if (Index >= End)
1730 break;
1731
Hemant Kulkarni5b60f632016-08-25 19:41:08 +00001732 // Disassemble a real instruction or a data when disassemble all is
1733 // provided
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001734 bool Disassembled = DisAsm->getInstruction(Inst, Size, Bytes.slice(Index),
1735 SectionAddr + Index, DebugOut,
1736 CommentStream);
1737 if (Size == 0)
1738 Size = 1;
Hemant Kulkarni8dfc0b52016-08-15 19:49:24 +00001739
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001740 PIP.printInst(*IP, Disassembled ? &Inst : nullptr,
Hemant Kulkarni8dfc0b52016-08-15 19:49:24 +00001741 Bytes.slice(Index, Size), SectionAddr + Index, outs(), "",
Sid Manningd9f28732018-05-14 19:46:08 +00001742 *STI, &SP, &Rels);
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001743 outs() << CommentStream.str();
1744 Comments.clear();
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001745
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001746 // Try to resolve the target of a call, tail call, etc. to a specific
1747 // symbol.
1748 if (MIA && (MIA->isCall(Inst) || MIA->isUnconditionalBranch(Inst) ||
1749 MIA->isConditionalBranch(Inst))) {
1750 uint64_t Target;
1751 if (MIA->evaluateBranch(Inst, SectionAddr + Index, Size, Target)) {
1752 // In a relocatable object, the target's section must reside in
1753 // the same section as the call instruction or it is accessed
1754 // through a relocation.
1755 //
1756 // In a non-relocatable object, the target may be in any section.
1757 //
1758 // N.B. We don't walk the relocations in the relocatable case yet.
1759 auto *TargetSectionSymbols = &Symbols;
1760 if (!Obj->isRelocatableObject()) {
1761 auto SectionAddress = std::upper_bound(
1762 SectionAddresses.begin(), SectionAddresses.end(), Target,
1763 [](uint64_t LHS,
1764 const std::pair<uint64_t, SectionRef> &RHS) {
1765 return LHS < RHS.first;
1766 });
1767 if (SectionAddress != SectionAddresses.begin()) {
1768 --SectionAddress;
1769 TargetSectionSymbols = &AllSymbols[SectionAddress->second];
1770 } else {
Sterling Augustinebc78b622018-06-28 18:57:13 +00001771 TargetSectionSymbols = &AbsoluteSymbols;
David Majnemerfbb1c3a2015-11-18 02:49:19 +00001772 }
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001773 }
David Majnemer2603a8fa2015-07-09 18:11:40 +00001774
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001775 // Find the first symbol in the section whose offset is less than
Sterling Augustinebc78b622018-06-28 18:57:13 +00001776 // or equal to the target. If there isn't a section that contains
1777 // the target, find the nearest preceding absolute symbol.
1778 auto TargetSym = std::upper_bound(
1779 TargetSectionSymbols->begin(), TargetSectionSymbols->end(),
1780 Target, [](uint64_t LHS,
1781 const std::tuple<uint64_t, StringRef, uint8_t> &RHS) {
1782 return LHS < std::get<0>(RHS);
1783 });
1784 if (TargetSym == TargetSectionSymbols->begin()) {
1785 TargetSectionSymbols = &AbsoluteSymbols;
1786 TargetSym = std::upper_bound(
1787 AbsoluteSymbols.begin(), AbsoluteSymbols.end(),
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001788 Target, [](uint64_t LHS,
Sam Koltonc05d7782016-08-17 10:17:57 +00001789 const std::tuple<uint64_t, StringRef, uint8_t> &RHS) {
Sterling Augustinebc78b622018-06-28 18:57:13 +00001790 return LHS < std::get<0>(RHS);
1791 });
1792 }
1793 if (TargetSym != TargetSectionSymbols->begin()) {
1794 --TargetSym;
1795 uint64_t TargetAddress = std::get<0>(*TargetSym);
1796 StringRef TargetName = std::get<1>(*TargetSym);
1797 outs() << " <" << TargetName;
1798 uint64_t Disp = Target - TargetAddress;
1799 if (Disp)
1800 outs() << "+0x" << Twine::utohexstr(Disp);
1801 outs() << '>';
David Majnemer81afca62015-07-07 22:06:59 +00001802 }
1803 }
Benjamin Kramere0dda9c2011-07-15 18:39:24 +00001804 }
Colin LeMahieu307a83d2016-03-18 16:26:48 +00001805 outs() << "\n";
Michael J. Spencer51862b32011-10-13 22:17:18 +00001806
Sid Manningd9f28732018-05-14 19:46:08 +00001807 // Hexagon does this in pretty printer
1808 if (Obj->getArch() != Triple::hexagon)
1809 // Print relocation for instruction.
1810 while (rel_cur != rel_end) {
1811 bool hidden = getHidden(*rel_cur);
1812 uint64_t addr = rel_cur->getOffset();
1813 SmallString<16> name;
1814 SmallString<32> val;
Owen Andersonfa3e5202011-10-25 20:35:53 +00001815
Sid Manningd9f28732018-05-14 19:46:08 +00001816 // If this relocation is hidden, skip it.
1817 if (hidden || ((SectionAddr + addr) < StartAddress)) {
1818 ++rel_cur;
1819 continue;
1820 }
1821
1822 // Stop when rel_cur's address is past the current instruction.
1823 if (addr >= Index + Size) break;
1824 rel_cur->getTypeName(name);
1825 error(getRelocationValueString(*rel_cur, val));
1826 outs() << format(Fmt.data(), SectionAddr + addr) << name
1827 << "\t" << val << "\n";
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001828 ++rel_cur;
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001829 }
Benjamin Kramer87ee76c2011-07-20 19:37:35 +00001830 }
Michael J. Spencer2670c252011-01-20 06:39:06 +00001831 }
1832 }
1833}
1834
Kevin Enderby98da6132015-01-20 21:47:46 +00001835void llvm::PrintRelocations(const ObjectFile *Obj) {
Greg Fitzgerald18432272014-03-20 22:55:15 +00001836 StringRef Fmt = Obj->getBytesInAddress() > 4 ? "%016" PRIx64 :
1837 "%08" PRIx64;
Rafael Espindola9219fe72016-03-21 20:59:15 +00001838 // Regular objdump doesn't print relocations in non-relocatable object
1839 // files.
1840 if (!Obj->isRelocatableObject())
1841 return;
Rafael Espindolac66d7612014-08-17 19:09:37 +00001842
Colin LeMahieu77804be2015-07-29 15:45:39 +00001843 for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
Alexey Samsonov48803e52014-03-13 14:37:36 +00001844 if (Section.relocation_begin() == Section.relocation_end())
Michael J. Spencerba4a3622011-10-08 00:18:30 +00001845 continue;
1846 StringRef secname;
Davide Italianoccd53fe2015-08-05 07:18:31 +00001847 error(Section.getName(secname));
Michael J. Spencerba4a3622011-10-08 00:18:30 +00001848 outs() << "RELOCATION RECORDS FOR [" << secname << "]:\n";
Alexey Samsonovaa4d2952014-03-14 14:22:49 +00001849 for (const RelocationRef &Reloc : Section.relocations()) {
Rafael Espindola0ad71d92015-06-30 03:41:26 +00001850 bool hidden = getHidden(Reloc);
Rafael Espindola96d071c2015-06-29 23:29:12 +00001851 uint64_t address = Reloc.getOffset();
Michael J. Spencerba4a3622011-10-08 00:18:30 +00001852 SmallString<32> relocname;
1853 SmallString<32> valuestr;
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001854 if (address < StartAddress || address > StopAddress || hidden)
Alexey Samsonovaa4d2952014-03-14 14:22:49 +00001855 continue;
Rafael Espindola41bb4322015-06-30 04:08:37 +00001856 Reloc.getTypeName(relocname);
Davide Italianoccd53fe2015-08-05 07:18:31 +00001857 error(getRelocationValueString(Reloc, valuestr));
Greg Fitzgerald18432272014-03-20 22:55:15 +00001858 outs() << format(Fmt.data(), address) << " " << relocname << " "
1859 << valuestr << "\n";
Michael J. Spencerba4a3622011-10-08 00:18:30 +00001860 }
1861 outs() << "\n";
1862 }
1863}
1864
Paul Semelcb0f0432018-06-07 13:30:55 +00001865void llvm::PrintDynamicRelocations(const ObjectFile *Obj) {
1866
1867 // For the moment, this option is for ELF only
1868 if (!Obj->isELF())
1869 return;
1870
1871 const auto *Elf = dyn_cast<ELFObjectFileBase>(Obj);
1872
1873 if (!Elf || Elf->getEType() != ELF::ET_DYN) {
1874 error("not a dynamic object");
1875 return;
1876 }
1877
1878 StringRef Fmt = Obj->getBytesInAddress() > 4 ? "%016" PRIx64 : "%08" PRIx64;
1879
1880 std::vector<SectionRef> DynRelSec = Obj->dynamic_relocation_sections();
1881 if (DynRelSec.empty())
1882 return;
1883
1884 outs() << "DYNAMIC RELOCATION RECORDS\n";
1885 for (const SectionRef &Section : DynRelSec) {
1886 if (Section.relocation_begin() == Section.relocation_end())
1887 continue;
1888 for (const RelocationRef &Reloc : Section.relocations()) {
1889 uint64_t address = Reloc.getOffset();
1890 SmallString<32> relocname;
1891 SmallString<32> valuestr;
1892 Reloc.getTypeName(relocname);
1893 error(getRelocationValueString(Reloc, valuestr));
1894 outs() << format(Fmt.data(), address) << " " << relocname << " "
1895 << valuestr << "\n";
1896 }
1897 }
1898}
1899
Kevin Enderby98da6132015-01-20 21:47:46 +00001900void llvm::PrintSectionHeaders(const ObjectFile *Obj) {
Nick Lewyckyfcf84622011-10-10 21:21:34 +00001901 outs() << "Sections:\n"
1902 "Idx Name Size Address Type\n";
Colin LeMahieu77804be2015-07-29 15:45:39 +00001903 for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
Nick Lewyckyfcf84622011-10-10 21:21:34 +00001904 StringRef Name;
Davide Italianoccd53fe2015-08-05 07:18:31 +00001905 error(Section.getName(Name));
Rafael Espindola80291272014-10-08 15:28:58 +00001906 uint64_t Address = Section.getAddress();
1907 uint64_t Size = Section.getSize();
1908 bool Text = Section.isText();
1909 bool Data = Section.isData();
1910 bool BSS = Section.isBSS();
Nick Lewyckyfcf84622011-10-10 21:21:34 +00001911 std::string Type = (std::string(Text ? "TEXT " : "") +
Michael J. Spencer8f67d472011-10-13 20:37:20 +00001912 (Data ? "DATA " : "") + (BSS ? "BSS" : ""));
George Rimare35e6442018-07-18 08:34:35 +00001913 outs() << format("%3d %-13s %08" PRIx64 " %016" PRIx64 " %s\n",
George Rimarc1090da2018-07-18 09:25:36 +00001914 (unsigned)Section.getIndex(), Name.str().c_str(), Size,
1915 Address, Type.c_str());
Nick Lewyckyfcf84622011-10-10 21:21:34 +00001916 }
Xing GUO785edea2018-11-17 08:12:48 +00001917 outs() << "\n";
Nick Lewyckyfcf84622011-10-10 21:21:34 +00001918}
1919
Kevin Enderby98da6132015-01-20 21:47:46 +00001920void llvm::PrintSectionContents(const ObjectFile *Obj) {
Rafael Espindola4453e42942014-06-13 03:07:50 +00001921 std::error_code EC;
Colin LeMahieu77804be2015-07-29 15:45:39 +00001922 for (const SectionRef &Section : ToolSectionFilter(*Obj)) {
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001923 StringRef Name;
1924 StringRef Contents;
Davide Italianoccd53fe2015-08-05 07:18:31 +00001925 error(Section.getName(Name));
Rafael Espindola80291272014-10-08 15:28:58 +00001926 uint64_t BaseAddr = Section.getAddress();
David Majnemer185b5b12014-11-11 09:58:25 +00001927 uint64_t Size = Section.getSize();
1928 if (!Size)
1929 continue;
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001930
1931 outs() << "Contents of section " << Name << ":\n";
David Majnemer185b5b12014-11-11 09:58:25 +00001932 if (Section.isBSS()) {
Alexey Samsonov209095c2013-04-16 10:53:11 +00001933 outs() << format("<skipping contents of bss section at [%04" PRIx64
David Majnemer8f6b04c2014-07-14 16:20:14 +00001934 ", %04" PRIx64 ")>\n",
1935 BaseAddr, BaseAddr + Size);
Alexey Samsonov209095c2013-04-16 10:53:11 +00001936 continue;
1937 }
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001938
Davide Italianoccd53fe2015-08-05 07:18:31 +00001939 error(Section.getContents(Contents));
David Majnemer8f6b04c2014-07-14 16:20:14 +00001940
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001941 // Dump out the content as hex and printable ascii characters.
1942 for (std::size_t addr = 0, end = Contents.size(); addr < end; addr += 16) {
Benjamin Kramer82803112012-03-10 02:04:38 +00001943 outs() << format(" %04" PRIx64 " ", BaseAddr + addr);
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001944 // Dump line of hex.
1945 for (std::size_t i = 0; i < 16; ++i) {
1946 if (i != 0 && i % 4 == 0)
1947 outs() << ' ';
1948 if (addr + i < end)
1949 outs() << hexdigit((Contents[addr + i] >> 4) & 0xF, true)
1950 << hexdigit(Contents[addr + i] & 0xF, true);
1951 else
1952 outs() << " ";
1953 }
1954 // Print ascii.
1955 outs() << " ";
1956 for (std::size_t i = 0; i < 16 && addr + i < end; ++i) {
Michael Kruse6f1da6e2018-07-26 15:31:41 +00001957 if (isPrint(static_cast<unsigned char>(Contents[addr + i]) & 0xFF))
Michael J. Spencer4e25c022011-10-17 17:13:22 +00001958 outs() << Contents[addr + i];
1959 else
1960 outs() << ".";
1961 }
1962 outs() << "\n";
1963 }
1964 }
1965}
1966
Kevin Enderby9acb1092016-05-31 20:35:34 +00001967void llvm::PrintSymbolTable(const ObjectFile *o, StringRef ArchiveName,
1968 StringRef ArchitectureName) {
Michael J. Spencerbfa06782011-10-18 19:32:17 +00001969 outs() << "SYMBOL TABLE:\n";
1970
Rui Ueyama4e39f712014-03-18 18:58:51 +00001971 if (const COFFObjectFile *coff = dyn_cast<const COFFObjectFile>(o)) {
Davide Italianoe85abf72015-12-20 09:54:34 +00001972 printCOFFSymbolTable(coff);
Rui Ueyama4e39f712014-03-18 18:58:51 +00001973 return;
1974 }
1975 for (const SymbolRef &Symbol : o->symbols()) {
Kevin Enderby931cb652016-06-24 18:24:42 +00001976 Expected<uint64_t> AddressOrError = Symbol.getAddress();
1977 if (!AddressOrError)
Kevin Enderby7fa40c92016-11-16 22:17:38 +00001978 report_error(ArchiveName, o->getFileName(), AddressOrError.takeError(),
1979 ArchitectureName);
Rafael Espindolaed067c42015-07-03 18:19:00 +00001980 uint64_t Address = *AddressOrError;
Hemant Kulkarniaecf9d02016-09-12 17:08:22 +00001981 if ((Address < StartAddress) || (Address > StopAddress))
1982 continue;
Kevin Enderby7bd8d992016-05-02 20:28:12 +00001983 Expected<SymbolRef::Type> TypeOrError = Symbol.getType();
1984 if (!TypeOrError)
Kevin Enderby7fa40c92016-11-16 22:17:38 +00001985 report_error(ArchiveName, o->getFileName(), TypeOrError.takeError(),
1986 ArchitectureName);
Kevin Enderby5afbc1c2016-03-23 20:27:00 +00001987 SymbolRef::Type Type = *TypeOrError;
Rui Ueyama4e39f712014-03-18 18:58:51 +00001988 uint32_t Flags = Symbol.getFlags();
Kevin Enderby7bd8d992016-05-02 20:28:12 +00001989 Expected<section_iterator> SectionOrErr = Symbol.getSection();
Kevin Enderby7fa40c92016-11-16 22:17:38 +00001990 if (!SectionOrErr)
1991 report_error(ArchiveName, o->getFileName(), SectionOrErr.takeError(),
1992 ArchitectureName);
Rafael Espindola8bab8892015-08-07 23:27:14 +00001993 section_iterator Section = *SectionOrErr;
Rafael Espindola75d5b542015-06-03 05:14:22 +00001994 StringRef Name;
1995 if (Type == SymbolRef::ST_Debug && Section != o->section_end()) {
1996 Section->getName(Name);
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +00001997 } else {
Kevin Enderby81e8b7d2016-04-20 21:24:34 +00001998 Expected<StringRef> NameOrErr = Symbol.getName();
1999 if (!NameOrErr)
Kevin Enderby9acb1092016-05-31 20:35:34 +00002000 report_error(ArchiveName, o->getFileName(), NameOrErr.takeError(),
2001 ArchitectureName);
Rafael Espindola5d0c2ff2015-07-02 20:55:21 +00002002 Name = *NameOrErr;
Rafael Espindola75d5b542015-06-03 05:14:22 +00002003 }
Michael J. Spencerbfa06782011-10-18 19:32:17 +00002004
Rui Ueyama4e39f712014-03-18 18:58:51 +00002005 bool Global = Flags & SymbolRef::SF_Global;
2006 bool Weak = Flags & SymbolRef::SF_Weak;
2007 bool Absolute = Flags & SymbolRef::SF_Absolute;
Colin LeMahieubc2f47a2015-01-23 20:06:24 +00002008 bool Common = Flags & SymbolRef::SF_Common;
Davide Italianocd2514d2015-04-30 23:08:53 +00002009 bool Hidden = Flags & SymbolRef::SF_Hidden;
David Meyer1df4b842012-02-28 23:47:53 +00002010
Rui Ueyama4e39f712014-03-18 18:58:51 +00002011 char GlobLoc = ' ';
2012 if (Type != SymbolRef::ST_Unknown)
2013 GlobLoc = Global ? 'g' : 'l';
2014 char Debug = (Type == SymbolRef::ST_Debug || Type == SymbolRef::ST_File)
2015 ? 'd' : ' ';
2016 char FileFunc = ' ';
2017 if (Type == SymbolRef::ST_File)
2018 FileFunc = 'f';
2019 else if (Type == SymbolRef::ST_Function)
2020 FileFunc = 'F';
Kristina Brooks0674f9d2018-11-11 17:47:13 +00002021 else if (Type == SymbolRef::ST_Data)
2022 FileFunc = 'O';
Michael J. Spencerbfa06782011-10-18 19:32:17 +00002023
Rui Ueyama4e39f712014-03-18 18:58:51 +00002024 const char *Fmt = o->getBytesInAddress() > 4 ? "%016" PRIx64 :
2025 "%08" PRIx64;
Michael J. Spencerd857c1c2013-01-10 22:40:50 +00002026
Rui Ueyama4e39f712014-03-18 18:58:51 +00002027 outs() << format(Fmt, Address) << " "
2028 << GlobLoc // Local -> 'l', Global -> 'g', Neither -> ' '
2029 << (Weak ? 'w' : ' ') // Weak?
2030 << ' ' // Constructor. Not supported yet.
2031 << ' ' // Warning. Not supported yet.
2032 << ' ' // Indirect reference to another symbol.
2033 << Debug // Debugging (d) or dynamic (D) symbol.
2034 << FileFunc // Name of function (F), file (f) or object (O).
2035 << ' ';
2036 if (Absolute) {
2037 outs() << "*ABS*";
Colin LeMahieubc2f47a2015-01-23 20:06:24 +00002038 } else if (Common) {
2039 outs() << "*COM*";
Rui Ueyama4e39f712014-03-18 18:58:51 +00002040 } else if (Section == o->section_end()) {
2041 outs() << "*UND*";
2042 } else {
2043 if (const MachOObjectFile *MachO =
2044 dyn_cast<const MachOObjectFile>(o)) {
2045 DataRefImpl DR = Section->getRawDataRefImpl();
2046 StringRef SegmentName = MachO->getSectionFinalSegmentName(DR);
2047 outs() << SegmentName << ",";
Michael J. Spencerbfa06782011-10-18 19:32:17 +00002048 }
Rui Ueyama4e39f712014-03-18 18:58:51 +00002049 StringRef SectionName;
Davide Italianoccd53fe2015-08-05 07:18:31 +00002050 error(Section->getName(SectionName));
Rui Ueyama4e39f712014-03-18 18:58:51 +00002051 outs() << SectionName;
Michael J. Spencerbfa06782011-10-18 19:32:17 +00002052 }
Rafael Espindola5f7ade22015-06-23 15:45:38 +00002053
2054 outs() << '\t';
Rafael Espindolaae3ac082015-06-23 18:34:25 +00002055 if (Common || isa<ELFObjectFileBase>(o)) {
Rafael Espindoladbb6bd32015-06-25 22:10:04 +00002056 uint64_t Val =
2057 Common ? Symbol.getAlignment() : ELFSymbolRef(Symbol).getSize();
Rafael Espindolaae3ac082015-06-23 18:34:25 +00002058 outs() << format("\t %08" PRIx64 " ", Val);
2059 }
Rafael Espindola5f7ade22015-06-23 15:45:38 +00002060
Davide Italianocd2514d2015-04-30 23:08:53 +00002061 if (Hidden) {
2062 outs() << ".hidden ";
2063 }
George Rimar6622d412018-12-19 10:21:45 +00002064
2065 if (Demangle)
2066 outs() << demangle(Name) << '\n';
2067 else
2068 outs() << Name << '\n';
Michael J. Spencerbfa06782011-10-18 19:32:17 +00002069 }
2070}
2071
Michael J. Spencer0c6ec482012-12-05 20:12:35 +00002072static void PrintUnwindInfo(const ObjectFile *o) {
2073 outs() << "Unwind info:\n\n";
2074
2075 if (const COFFObjectFile *coff = dyn_cast<COFFObjectFile>(o)) {
2076 printCOFFUnwindInfo(coff);
Tim Northover4bd286a2014-08-01 13:07:19 +00002077 } else if (const MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
2078 printMachOUnwindInfo(MachO);
2079 else {
Michael J. Spencer0c6ec482012-12-05 20:12:35 +00002080 // TODO: Extract DWARF dump tool to objdump.
Jonas Devliegheree787efd2018-11-11 22:12:04 +00002081 WithColor::error(errs(), ToolName)
2082 << "This operation is only currently supported "
2083 "for COFF and MachO object files.\n";
Michael J. Spencer0c6ec482012-12-05 20:12:35 +00002084 return;
2085 }
2086}
2087
Kevin Enderbye2297dd2015-01-07 21:02:18 +00002088void llvm::printExportsTrie(const ObjectFile *o) {
Nick Kledzikd04bc352014-08-30 00:20:14 +00002089 outs() << "Exports trie:\n";
2090 if (const MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
2091 printMachOExportsTrie(MachO);
2092 else {
Jonas Devliegheree787efd2018-11-11 22:12:04 +00002093 WithColor::error(errs(), ToolName)
2094 << "This operation is only currently supported "
2095 "for Mach-O executable files.\n";
Nick Kledzikd04bc352014-08-30 00:20:14 +00002096 return;
2097 }
2098}
2099
Kevin Enderbya8d256c2017-03-20 19:46:55 +00002100void llvm::printRebaseTable(ObjectFile *o) {
Nick Kledzikac431442014-09-12 21:34:15 +00002101 outs() << "Rebase table:\n";
Kevin Enderbya8d256c2017-03-20 19:46:55 +00002102 if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
Nick Kledzikac431442014-09-12 21:34:15 +00002103 printMachORebaseTable(MachO);
2104 else {
Jonas Devliegheree787efd2018-11-11 22:12:04 +00002105 WithColor::error(errs(), ToolName)
2106 << "This operation is only currently supported "
2107 "for Mach-O executable files.\n";
Nick Kledzikac431442014-09-12 21:34:15 +00002108 return;
2109 }
2110}
2111
Kevin Enderbya8d256c2017-03-20 19:46:55 +00002112void llvm::printBindTable(ObjectFile *o) {
Nick Kledzik56ebef42014-09-16 01:41:51 +00002113 outs() << "Bind table:\n";
Kevin Enderbya8d256c2017-03-20 19:46:55 +00002114 if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
Nick Kledzik56ebef42014-09-16 01:41:51 +00002115 printMachOBindTable(MachO);
2116 else {
Jonas Devliegheree787efd2018-11-11 22:12:04 +00002117 WithColor::error(errs(), ToolName)
2118 << "This operation is only currently supported "
2119 "for Mach-O executable files.\n";
Nick Kledzik56ebef42014-09-16 01:41:51 +00002120 return;
2121 }
2122}
2123
Kevin Enderbya8d256c2017-03-20 19:46:55 +00002124void llvm::printLazyBindTable(ObjectFile *o) {
Nick Kledzik56ebef42014-09-16 01:41:51 +00002125 outs() << "Lazy bind table:\n";
Kevin Enderbya8d256c2017-03-20 19:46:55 +00002126 if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
Nick Kledzik56ebef42014-09-16 01:41:51 +00002127 printMachOLazyBindTable(MachO);
2128 else {
Jonas Devliegheree787efd2018-11-11 22:12:04 +00002129 WithColor::error(errs(), ToolName)
2130 << "This operation is only currently supported "
2131 "for Mach-O executable files.\n";
Nick Kledzik56ebef42014-09-16 01:41:51 +00002132 return;
2133 }
2134}
2135
Kevin Enderbya8d256c2017-03-20 19:46:55 +00002136void llvm::printWeakBindTable(ObjectFile *o) {
Nick Kledzik56ebef42014-09-16 01:41:51 +00002137 outs() << "Weak bind table:\n";
Kevin Enderbya8d256c2017-03-20 19:46:55 +00002138 if (MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
Nick Kledzik56ebef42014-09-16 01:41:51 +00002139 printMachOWeakBindTable(MachO);
2140 else {
Jonas Devliegheree787efd2018-11-11 22:12:04 +00002141 WithColor::error(errs(), ToolName)
2142 << "This operation is only currently supported "
2143 "for Mach-O executable files.\n";
Nick Kledzik56ebef42014-09-16 01:41:51 +00002144 return;
2145 }
2146}
Nick Kledzikac431442014-09-12 21:34:15 +00002147
Adrian Prantl437105a2015-07-08 02:04:15 +00002148/// Dump the raw contents of the __clangast section so the output can be piped
2149/// into llvm-bcanalyzer.
2150void llvm::printRawClangAST(const ObjectFile *Obj) {
2151 if (outs().is_displayed()) {
Jonas Devliegheree787efd2018-11-11 22:12:04 +00002152 WithColor::error(errs(), ToolName)
2153 << "The -raw-clang-ast option will dump the raw binary contents of "
2154 "the clang ast section.\n"
2155 "Please redirect the output to a file or another program such as "
2156 "llvm-bcanalyzer.\n";
Adrian Prantl437105a2015-07-08 02:04:15 +00002157 return;
2158 }
2159
2160 StringRef ClangASTSectionName("__clangast");
2161 if (isa<COFFObjectFile>(Obj)) {
2162 ClangASTSectionName = "clangast";
2163 }
2164
2165 Optional<object::SectionRef> ClangASTSection;
Colin LeMahieu77804be2015-07-29 15:45:39 +00002166 for (auto Sec : ToolSectionFilter(*Obj)) {
Adrian Prantl437105a2015-07-08 02:04:15 +00002167 StringRef Name;
2168 Sec.getName(Name);
2169 if (Name == ClangASTSectionName) {
2170 ClangASTSection = Sec;
2171 break;
2172 }
2173 }
2174 if (!ClangASTSection)
2175 return;
2176
2177 StringRef ClangASTContents;
Davide Italianoccd53fe2015-08-05 07:18:31 +00002178 error(ClangASTSection.getValue().getContents(ClangASTContents));
Adrian Prantl437105a2015-07-08 02:04:15 +00002179 outs().write(ClangASTContents.data(), ClangASTContents.size());
2180}
2181
Sanjoy Das6f567a42015-06-22 18:03:02 +00002182static void printFaultMaps(const ObjectFile *Obj) {
2183 const char *FaultMapSectionName = nullptr;
2184
2185 if (isa<ELFObjectFileBase>(Obj)) {
2186 FaultMapSectionName = ".llvm_faultmaps";
2187 } else if (isa<MachOObjectFile>(Obj)) {
2188 FaultMapSectionName = "__llvm_faultmaps";
2189 } else {
Jonas Devliegheree787efd2018-11-11 22:12:04 +00002190 WithColor::error(errs(), ToolName)
2191 << "This operation is only currently supported "
2192 "for ELF and Mach-O executable files.\n";
Sanjoy Das6f567a42015-06-22 18:03:02 +00002193 return;
2194 }
2195
2196 Optional<object::SectionRef> FaultMapSection;
2197
Colin LeMahieu77804be2015-07-29 15:45:39 +00002198 for (auto Sec : ToolSectionFilter(*Obj)) {
Sanjoy Das6f567a42015-06-22 18:03:02 +00002199 StringRef Name;
2200 Sec.getName(Name);
2201 if (Name == FaultMapSectionName) {
2202 FaultMapSection = Sec;
2203 break;
2204 }
2205 }
2206
2207 outs() << "FaultMap table:\n";
2208
2209 if (!FaultMapSection.hasValue()) {
2210 outs() << "<not found>\n";
2211 return;
2212 }
2213
2214 StringRef FaultMapContents;
Davide Italianoccd53fe2015-08-05 07:18:31 +00002215 error(FaultMapSection.getValue().getContents(FaultMapContents));
Sanjoy Das6f567a42015-06-22 18:03:02 +00002216
2217 FaultMapParser FMP(FaultMapContents.bytes_begin(),
2218 FaultMapContents.bytes_end());
2219
2220 outs() << FMP;
2221}
2222
Davide Italiano1bdaa202016-09-18 04:39:15 +00002223static void printPrivateFileHeaders(const ObjectFile *o, bool onlyFirst) {
Paul Semel0913dcd2018-07-25 11:09:20 +00002224 if (o->isELF()) {
2225 printELFFileHeader(o);
2226 return printELFDynamicSection(o);
2227 }
Davide Italiano1bdaa202016-09-18 04:39:15 +00002228 if (o->isCOFF())
2229 return printCOFFFileHeader(o);
Derek Schuff2c6f75d2016-11-30 16:49:11 +00002230 if (o->isWasm())
2231 return printWasmFileHeader(o);
Davide Italiano1bdaa202016-09-18 04:39:15 +00002232 if (o->isMachO()) {
Kevin Enderby0ae163f2016-01-13 00:25:36 +00002233 printMachOFileHeader(o);
Davide Italiano1bdaa202016-09-18 04:39:15 +00002234 if (!onlyFirst)
2235 printMachOLoadCommands(o);
2236 return;
2237 }
Kevin Enderby7fa40c92016-11-16 22:17:38 +00002238 report_error(o->getFileName(), "Invalid/Unsupported object file format");
Rui Ueyamac2bed422013-09-27 21:04:00 +00002239}
2240
Paul Semeld2af4d62018-07-04 15:25:03 +00002241static void printFileHeaders(const ObjectFile *o) {
2242 if (!o->isELF() && !o->isCOFF())
2243 report_error(o->getFileName(), "Invalid/Unsupported object file format");
2244
2245 Triple::ArchType AT = o->getArch();
2246 outs() << "architecture: " << Triple::getArchTypeName(AT) << "\n";
2247 Expected<uint64_t> StartAddrOrErr = o->getStartAddress();
2248 if (!StartAddrOrErr)
2249 report_error(o->getFileName(), StartAddrOrErr.takeError());
Petar Jovanovic8d947ba2018-10-19 22:16:49 +00002250
2251 StringRef Fmt = o->getBytesInAddress() > 4 ? "%016" PRIx64 : "%08" PRIx64;
2252 uint64_t Address = StartAddrOrErr.get();
Paul Semeld2af4d62018-07-04 15:25:03 +00002253 outs() << "start address: "
Petar Jovanovic8d947ba2018-10-19 22:16:49 +00002254 << "0x" << format(Fmt.data(), Address)
Paul Semeld2af4d62018-07-04 15:25:03 +00002255 << "\n";
2256}
2257
Paul Semel0dc92f62018-07-05 14:43:29 +00002258static void printArchiveChild(StringRef Filename, const Archive::Child &C) {
2259 Expected<sys::fs::perms> ModeOrErr = C.getAccessMode();
2260 if (!ModeOrErr) {
Jonas Devliegheree787efd2018-11-11 22:12:04 +00002261 WithColor::error(errs(), ToolName) << "ill-formed archive entry.\n";
Paul Semel0dc92f62018-07-05 14:43:29 +00002262 consumeError(ModeOrErr.takeError());
2263 return;
2264 }
2265 sys::fs::perms Mode = ModeOrErr.get();
2266 outs() << ((Mode & sys::fs::owner_read) ? "r" : "-");
2267 outs() << ((Mode & sys::fs::owner_write) ? "w" : "-");
2268 outs() << ((Mode & sys::fs::owner_exe) ? "x" : "-");
2269 outs() << ((Mode & sys::fs::group_read) ? "r" : "-");
2270 outs() << ((Mode & sys::fs::group_write) ? "w" : "-");
2271 outs() << ((Mode & sys::fs::group_exe) ? "x" : "-");
2272 outs() << ((Mode & sys::fs::others_read) ? "r" : "-");
2273 outs() << ((Mode & sys::fs::others_write) ? "w" : "-");
2274 outs() << ((Mode & sys::fs::others_exe) ? "x" : "-");
2275
2276 outs() << " ";
2277
2278 Expected<unsigned> UIDOrErr = C.getUID();
2279 if (!UIDOrErr)
2280 report_error(Filename, UIDOrErr.takeError());
2281 unsigned UID = UIDOrErr.get();
2282 outs() << format("%d/", UID);
2283
2284 Expected<unsigned> GIDOrErr = C.getGID();
2285 if (!GIDOrErr)
2286 report_error(Filename, GIDOrErr.takeError());
2287 unsigned GID = GIDOrErr.get();
2288 outs() << format("%-d ", GID);
2289
2290 Expected<uint64_t> Size = C.getRawSize();
2291 if (!Size)
2292 report_error(Filename, Size.takeError());
2293 outs() << format("%6" PRId64, Size.get()) << " ";
2294
2295 StringRef RawLastModified = C.getRawLastModified();
2296 unsigned Seconds;
2297 if (RawLastModified.getAsInteger(10, Seconds))
2298 outs() << "(date: \"" << RawLastModified
2299 << "\" contains non-decimal chars) ";
2300 else {
2301 // Since ctime(3) returns a 26 character string of the form:
2302 // "Sun Sep 16 01:03:52 1973\n\0"
2303 // just print 24 characters.
2304 time_t t = Seconds;
2305 outs() << format("%.24s ", ctime(&t));
2306 }
2307
2308 StringRef Name = "";
2309 Expected<StringRef> NameOrErr = C.getName();
2310 if (!NameOrErr) {
2311 consumeError(NameOrErr.takeError());
2312 Expected<StringRef> RawNameOrErr = C.getRawName();
2313 if (!RawNameOrErr)
2314 report_error(Filename, NameOrErr.takeError());
2315 Name = RawNameOrErr.get();
2316 } else {
2317 Name = NameOrErr.get();
2318 }
2319 outs() << Name << "\n";
2320}
2321
2322static void DumpObject(ObjectFile *o, const Archive *a = nullptr,
2323 const Archive::Child *c = nullptr) {
Kevin Enderbyac9e1552016-05-17 17:10:12 +00002324 StringRef ArchiveName = a != nullptr ? a->getFileName() : "";
Adrian Prantl437105a2015-07-08 02:04:15 +00002325 // Avoid other output when using a raw option.
2326 if (!RawClangAST) {
2327 outs() << '\n';
Kevin Enderbyac9e1552016-05-17 17:10:12 +00002328 if (a)
2329 outs() << a->getFileName() << "(" << o->getFileName() << ")";
2330 else
2331 outs() << o->getFileName();
2332 outs() << ":\tfile format " << o->getFileFormatName() << "\n\n";
Adrian Prantl437105a2015-07-08 02:04:15 +00002333 }
Michael J. Spencer4e25c022011-10-17 17:13:22 +00002334
James Hendersonc1608c92018-10-29 14:17:08 +00002335 if (ArchiveHeaders && !MachOOpt && c)
2336 printArchiveChild(ArchiveName, *c);
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002337 if (Disassemble)
Michael J. Spencer51862b32011-10-13 22:17:18 +00002338 DisassembleObject(o, Relocations);
2339 if (Relocations && !Disassemble)
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002340 PrintRelocations(o);
Paul Semelcb0f0432018-06-07 13:30:55 +00002341 if (DynamicRelocations)
2342 PrintDynamicRelocations(o);
Nick Lewyckyfcf84622011-10-10 21:21:34 +00002343 if (SectionHeaders)
2344 PrintSectionHeaders(o);
Michael J. Spencer4e25c022011-10-17 17:13:22 +00002345 if (SectionContents)
2346 PrintSectionContents(o);
Michael J. Spencerbfa06782011-10-18 19:32:17 +00002347 if (SymbolTable)
Kevin Enderbyac9e1552016-05-17 17:10:12 +00002348 PrintSymbolTable(o, ArchiveName);
Michael J. Spencer0c6ec482012-12-05 20:12:35 +00002349 if (UnwindInfo)
2350 PrintUnwindInfo(o);
Davide Italiano1bdaa202016-09-18 04:39:15 +00002351 if (PrivateHeaders || FirstPrivateHeader)
2352 printPrivateFileHeaders(o, FirstPrivateHeader);
Paul Semeld2af4d62018-07-04 15:25:03 +00002353 if (FileHeaders)
2354 printFileHeaders(o);
Nick Kledzikd04bc352014-08-30 00:20:14 +00002355 if (ExportsTrie)
2356 printExportsTrie(o);
Nick Kledzikac431442014-09-12 21:34:15 +00002357 if (Rebase)
2358 printRebaseTable(o);
Nick Kledzik56ebef42014-09-16 01:41:51 +00002359 if (Bind)
2360 printBindTable(o);
2361 if (LazyBind)
2362 printLazyBindTable(o);
2363 if (WeakBind)
2364 printWeakBindTable(o);
Adrian Prantl437105a2015-07-08 02:04:15 +00002365 if (RawClangAST)
2366 printRawClangAST(o);
Sanjoy Das6f567a42015-06-22 18:03:02 +00002367 if (PrintFaultMaps)
2368 printFaultMaps(o);
Igor Laevsky03a670c2016-01-26 15:09:42 +00002369 if (DwarfDumpType != DIDT_Null) {
Rafael Espindolac398e672017-07-19 22:27:28 +00002370 std::unique_ptr<DIContext> DICtx = DWARFContext::create(*o);
Igor Laevsky03a670c2016-01-26 15:09:42 +00002371 // Dump the complete DWARF structure.
Adrian Prantlf4bc1f72017-06-01 18:18:23 +00002372 DIDumpOptions DumpOpts;
2373 DumpOpts.DumpType = DwarfDumpType;
Adrian Prantlf4bc1f72017-06-01 18:18:23 +00002374 DICtx->dump(outs(), DumpOpts);
Igor Laevsky03a670c2016-01-26 15:09:42 +00002375 }
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002376}
2377
Paul Semel0dc92f62018-07-05 14:43:29 +00002378static void DumpObject(const COFFImportFile *I, const Archive *A,
2379 const Archive::Child *C = nullptr) {
Saleem Abdulrasoolc6bf5472016-08-18 16:39:19 +00002380 StringRef ArchiveName = A ? A->getFileName() : "";
2381
2382 // Avoid other output when using a raw option.
2383 if (!RawClangAST)
2384 outs() << '\n'
2385 << ArchiveName << "(" << I->getFileName() << ")"
2386 << ":\tfile format COFF-import-file"
2387 << "\n\n";
2388
James Hendersonc1608c92018-10-29 14:17:08 +00002389 if (ArchiveHeaders && !MachOOpt && C)
2390 printArchiveChild(ArchiveName, *C);
Saleem Abdulrasoolc6bf5472016-08-18 16:39:19 +00002391 if (SymbolTable)
2392 printCOFFSymbolTable(I);
2393}
2394
Adrian Prantl4dfcc4a2018-05-01 16:10:38 +00002395/// Dump each object file in \a a;
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002396static void DumpArchive(const Archive *a) {
Mehdi Amini41af4302016-11-11 04:28:40 +00002397 Error Err = Error::success();
Lang Hamesfc209622016-07-14 02:24:01 +00002398 for (auto &C : a->children(Err)) {
Kevin Enderbyac9e1552016-05-17 17:10:12 +00002399 Expected<std::unique_ptr<Binary>> ChildOrErr = C.getAsBinary();
2400 if (!ChildOrErr) {
2401 if (auto E = isNotObjectErrorInvalidFileType(ChildOrErr.takeError()))
2402 report_error(a->getFileName(), C, std::move(E));
2403 continue;
2404 }
Rafael Espindolaae460022014-06-16 16:08:36 +00002405 if (ObjectFile *o = dyn_cast<ObjectFile>(&*ChildOrErr.get()))
Paul Semel0dc92f62018-07-05 14:43:29 +00002406 DumpObject(o, a, &C);
Saleem Abdulrasoolc6bf5472016-08-18 16:39:19 +00002407 else if (COFFImportFile *I = dyn_cast<COFFImportFile>(&*ChildOrErr.get()))
Paul Semel0dc92f62018-07-05 14:43:29 +00002408 DumpObject(I, a, &C);
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002409 else
Alexey Samsonov50d0fbd2015-06-04 18:34:11 +00002410 report_error(a->getFileName(), object_error::invalid_file_type);
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002411 }
Lang Hamesfc209622016-07-14 02:24:01 +00002412 if (Err)
2413 report_error(a->getFileName(), std::move(Err));
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002414}
2415
Adrian Prantl4dfcc4a2018-05-01 16:10:38 +00002416/// Open file and figure out how to dump it.
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002417static void DumpInput(StringRef file) {
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002418
Kevin Enderbye2297dd2015-01-07 21:02:18 +00002419 // If we are using the Mach-O specific object file parser, then let it parse
2420 // the file and process the command line options. So the -arch flags can
2421 // be used to select specific slices, etc.
2422 if (MachOOpt) {
2423 ParseInputMachO(file);
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002424 return;
2425 }
2426
2427 // Attempt to open the binary.
Kevin Enderby3fcdf6a2016-04-06 22:14:09 +00002428 Expected<OwningBinary<Binary>> BinaryOrErr = createBinary(file);
2429 if (!BinaryOrErr)
Kevin Enderbyb34e3a12016-05-05 17:43:35 +00002430 report_error(file, BinaryOrErr.takeError());
Rafael Espindola48af1c22014-08-19 18:44:46 +00002431 Binary &Binary = *BinaryOrErr.get().getBinary();
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002432
Rafael Espindola3f6481d2014-08-01 14:31:55 +00002433 if (Archive *a = dyn_cast<Archive>(&Binary))
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002434 DumpArchive(a);
Rafael Espindola3f6481d2014-08-01 14:31:55 +00002435 else if (ObjectFile *o = dyn_cast<ObjectFile>(&Binary))
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002436 DumpObject(o);
Dave Lee3fb120f2018-08-03 00:06:38 +00002437 else if (MachOUniversalBinary *UB = dyn_cast<MachOUniversalBinary>(&Binary))
2438 ParseInputMachO(UB);
Jim Grosbachaf9aec02012-08-07 17:53:14 +00002439 else
Alexey Samsonov50d0fbd2015-06-04 18:34:11 +00002440 report_error(file, object_error::invalid_file_type);
Michael J. Spencerba4a3622011-10-08 00:18:30 +00002441}
2442
Michael J. Spencer2670c252011-01-20 06:39:06 +00002443int main(int argc, char **argv) {
Rui Ueyama197194b2018-04-13 18:26:06 +00002444 InitLLVM X(argc, argv);
Michael J. Spencer2670c252011-01-20 06:39:06 +00002445
2446 // Initialize targets and assembly printers/parsers.
2447 llvm::InitializeAllTargetInfos();
Evan Cheng8c886a42011-07-22 21:58:54 +00002448 llvm::InitializeAllTargetMCs();
Michael J. Spencer2670c252011-01-20 06:39:06 +00002449 llvm::InitializeAllDisassemblers();
2450
Pete Cooper28fb4fc2012-05-03 23:20:10 +00002451 // Register the target printer for --version.
2452 cl::AddExtraVersionPrinter(TargetRegistry::printRegisteredTargetsForVersion);
2453
Michael J. Spencer2670c252011-01-20 06:39:06 +00002454 cl::ParseCommandLineOptions(argc, argv, "llvm object file dumper\n");
Michael J. Spencer2670c252011-01-20 06:39:06 +00002455
2456 ToolName = argv[0];
2457
2458 // Defaults to a.out if no filenames specified.
Jordan Rupprecht16a0de22018-12-20 00:57:06 +00002459 if (InputFilenames.empty())
Michael J. Spencer2670c252011-01-20 06:39:06 +00002460 InputFilenames.push_back("a.out");
2461
Fangrui Song8513cd42018-06-27 20:45:11 +00002462 if (AllHeaders)
2463 PrivateHeaders = Relocations = SectionHeaders = SymbolTable = true;
2464
Hemant Kulkarni8dfc0b52016-08-15 19:49:24 +00002465 if (DisassembleAll || PrintSource || PrintLines)
Colin LeMahieuf34933e2015-07-23 20:58:49 +00002466 Disassemble = true;
Paul Semel007dedb2018-07-18 16:39:21 +00002467
Michael J. Spencerbfa06782011-10-18 19:32:17 +00002468 if (!Disassemble
2469 && !Relocations
Paul Semelcb0f0432018-06-07 13:30:55 +00002470 && !DynamicRelocations
Michael J. Spencerbfa06782011-10-18 19:32:17 +00002471 && !SectionHeaders
2472 && !SectionContents
Michael J. Spencer0c6ec482012-12-05 20:12:35 +00002473 && !SymbolTable
Michael J. Spencer209565db2013-01-06 03:56:49 +00002474 && !UnwindInfo
Nick Kledzikd04bc352014-08-30 00:20:14 +00002475 && !PrivateHeaders
Paul Semeld2af4d62018-07-04 15:25:03 +00002476 && !FileHeaders
Kevin Enderby0ae163f2016-01-13 00:25:36 +00002477 && !FirstPrivateHeader
Nick Kledzikac431442014-09-12 21:34:15 +00002478 && !ExportsTrie
Nick Kledzik56ebef42014-09-16 01:41:51 +00002479 && !Rebase
2480 && !Bind
2481 && !LazyBind
Kevin Enderby131d1772015-01-09 19:22:37 +00002482 && !WeakBind
Adrian Prantl437105a2015-07-08 02:04:15 +00002483 && !RawClangAST
Kevin Enderby13023a12015-01-15 23:19:11 +00002484 && !(UniversalHeaders && MachOOpt)
Paul Semel0dc92f62018-07-05 14:43:29 +00002485 && !ArchiveHeaders
Kevin Enderby69fe98d2015-01-23 18:52:17 +00002486 && !(IndirectSymbols && MachOOpt)
Kevin Enderby9a509442015-01-27 21:28:24 +00002487 && !(DataInCode && MachOOpt)
Kevin Enderbyf6d25852015-01-31 00:37:11 +00002488 && !(LinkOptHints && MachOOpt)
Kevin Enderbycd66be52015-03-11 22:06:32 +00002489 && !(InfoPlist && MachOOpt)
Kevin Enderbybc847fa2015-03-16 20:08:09 +00002490 && !(DylibsUsed && MachOOpt)
2491 && !(DylibId && MachOOpt)
Kevin Enderby0fc11822015-04-01 20:57:01 +00002492 && !(ObjcMetaData && MachOOpt)
Jordan Rupprecht16a0de22018-12-20 00:57:06 +00002493 && !(!FilterSections.empty() && MachOOpt)
Igor Laevsky03a670c2016-01-26 15:09:42 +00002494 && !PrintFaultMaps
2495 && DwarfDumpType == DIDT_Null) {
Michael J. Spencer2670c252011-01-20 06:39:06 +00002496 cl::PrintHelpMessage();
Dimitry Andrice4f5d012017-12-18 19:46:56 +00002497 return 2;
2498 }
2499
Rafael Aulerb0e4b912018-03-09 19:13:44 +00002500 DisasmFuncsSet.insert(DisassembleFunctions.begin(),
2501 DisassembleFunctions.end());
2502
Dimitry Andrice4f5d012017-12-18 19:46:56 +00002503 llvm::for_each(InputFilenames, DumpInput);
2504
2505 return EXIT_SUCCESS;
2506}